3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 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_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUVX(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 are approximately
67 1K chunks of memory parcelled up into N heads or bodies. The first slot
68 in each arena is reserved, and is used to hold a link to the next arena.
69 In the case of heads, the unused first slot also contains some flags and
70 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
75 The following global variables are associated with arenas:
77 PL_sv_arenaroot pointer to list of SV arenas
78 PL_sv_root pointer to list of free SV structures
80 PL_foo_arenaroot pointer to list of foo arenas,
81 PL_foo_root pointer to list of free foo bodies
82 ... for foo in xiv, xnv, xrv, xpv etc.
84 Note that some of the larger and more rarely used body types (eg xpvio)
85 are not allocated using arenas, but are instead just malloc()/free()ed as
86 required. Also, if PURIFY is defined, arenas are abandoned altogether,
87 with all items individually malloc()ed. In addition, a few SV heads are
88 not allocated from an arena, but are instead directly created as static
89 or auto variables, eg PL_sv_undef.
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..."
168 #define plant_SV(p) \
170 SvANY(p) = (void *)PL_sv_root; \
171 SvFLAGS(p) = SVTYPEMASK; \
176 /* sv_mutex must be held while calling uproot_SV() */
177 #define uproot_SV(p) \
180 PL_sv_root = (SV*)SvANY(p); \
185 /* new_SV(): return a new, empty SV head */
187 #ifdef DEBUG_LEAKING_SCALARS
188 /* provide a real function for a debugger to play with */
205 # define new_SV(p) (p)=S_new_SV(aTHX)
223 /* del_SV(): return an empty SV head to the free list */
238 S_del_sv(pTHX_ SV *p)
245 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
247 svend = &sva[SvREFCNT(sva)];
248 if (p >= sv && p < svend)
252 if (ckWARN_d(WARN_INTERNAL))
253 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
254 "Attempt to free non-arena SV: 0x%"UVxf
255 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
262 #else /* ! DEBUGGING */
264 #define del_SV(p) plant_SV(p)
266 #endif /* DEBUGGING */
270 =head1 SV Manipulation Functions
272 =for apidoc sv_add_arena
274 Given a chunk of memory, link it to the head of the list of arenas,
275 and split it into a list of free SVs.
281 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
287 /* The first SV in an arena isn't an SV. */
288 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
289 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
290 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
292 PL_sv_arenaroot = sva;
293 PL_sv_root = sva + 1;
295 svend = &sva[SvREFCNT(sva) - 1];
298 SvANY(sv) = (void *)(SV*)(sv + 1);
300 SvFLAGS(sv) = SVTYPEMASK;
304 SvFLAGS(sv) = SVTYPEMASK;
307 /* make some more SVs by adding another arena */
309 /* sv_mutex must be held while calling more_sv() */
316 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
317 PL_nice_chunk = Nullch;
318 PL_nice_chunk_size = 0;
321 char *chunk; /* must use New here to match call to */
322 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
323 sv_add_arena(chunk, 1008, 0);
329 /* visit(): call the named function for each non-free SV in the arenas
330 * whose flags field matches the flags/mask args. */
333 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
340 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
341 svend = &sva[SvREFCNT(sva)];
342 for (sv = sva + 1; sv < svend; ++sv) {
343 if (SvTYPE(sv) != SVTYPEMASK
344 && (sv->sv_flags & mask) == flags
357 /* called by sv_report_used() for each live SV */
360 do_report_used(pTHX_ SV *sv)
362 if (SvTYPE(sv) != SVTYPEMASK) {
363 PerlIO_printf(Perl_debug_log, "****\n");
370 =for apidoc sv_report_used
372 Dump the contents of all SVs not yet freed. (Debugging aid).
378 Perl_sv_report_used(pTHX)
381 visit(do_report_used, 0, 0);
385 /* called by sv_clean_objs() for each live SV */
388 do_clean_objs(pTHX_ SV *sv)
392 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
393 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
405 /* XXX Might want to check arrays, etc. */
408 /* called by sv_clean_objs() for each live SV */
410 #ifndef DISABLE_DESTRUCTOR_KLUDGE
412 do_clean_named_objs(pTHX_ SV *sv)
414 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
415 if ( SvOBJECT(GvSV(sv)) ||
416 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
417 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
418 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
419 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
421 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
422 SvFLAGS(sv) |= SVf_BREAK;
430 =for apidoc sv_clean_objs
432 Attempt to destroy all objects not yet freed
438 Perl_sv_clean_objs(pTHX)
440 PL_in_clean_objs = TRUE;
441 visit(do_clean_objs, SVf_ROK, SVf_ROK);
442 #ifndef DISABLE_DESTRUCTOR_KLUDGE
443 /* some barnacles may yet remain, clinging to typeglobs */
444 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
446 PL_in_clean_objs = FALSE;
449 /* called by sv_clean_all() for each live SV */
452 do_clean_all(pTHX_ SV *sv)
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
455 SvFLAGS(sv) |= SVf_BREAK;
456 if (PL_comppad == (AV*)sv) {
458 PL_curpad = Null(SV**);
464 =for apidoc sv_clean_all
466 Decrement the refcnt of each remaining SV, possibly triggering a
467 cleanup. This function may have to be called multiple times to free
468 SVs which are in complex self-referential hierarchies.
474 Perl_sv_clean_all(pTHX)
477 PL_in_clean_all = TRUE;
478 cleaned = visit(do_clean_all, 0,0);
479 PL_in_clean_all = FALSE;
484 =for apidoc sv_free_arenas
486 Deallocate the memory used by all arenas. Note that all the individual SV
487 heads and bodies within the arenas must already have been freed.
493 Perl_sv_free_arenas(pTHX)
497 XPV *arena, *arenanext;
499 /* Free arenas here, but be careful about fake ones. (We assume
500 contiguity of the fake ones with the corresponding real ones.) */
502 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
503 svanext = (SV*) SvANY(sva);
504 while (svanext && SvFAKE(svanext))
505 svanext = (SV*) SvANY(svanext);
508 Safefree((void *)sva);
511 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
515 PL_xiv_arenaroot = 0;
518 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
522 PL_xnv_arenaroot = 0;
525 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
526 arenanext = (XPV*)arena->xpv_pv;
529 PL_xrv_arenaroot = 0;
532 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
536 PL_xpv_arenaroot = 0;
539 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
543 PL_xpviv_arenaroot = 0;
546 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
547 arenanext = (XPV*)arena->xpv_pv;
550 PL_xpvnv_arenaroot = 0;
553 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
554 arenanext = (XPV*)arena->xpv_pv;
557 PL_xpvcv_arenaroot = 0;
560 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
561 arenanext = (XPV*)arena->xpv_pv;
564 PL_xpvav_arenaroot = 0;
567 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
568 arenanext = (XPV*)arena->xpv_pv;
571 PL_xpvhv_arenaroot = 0;
574 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
575 arenanext = (XPV*)arena->xpv_pv;
578 PL_xpvmg_arenaroot = 0;
581 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
582 arenanext = (XPV*)arena->xpv_pv;
585 PL_xpvlv_arenaroot = 0;
588 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
589 arenanext = (XPV*)arena->xpv_pv;
592 PL_xpvbm_arenaroot = 0;
595 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
596 arenanext = (XPV*)arena->xpv_pv;
603 Safefree(PL_nice_chunk);
604 PL_nice_chunk = Nullch;
605 PL_nice_chunk_size = 0;
610 /* ---------------------------------------------------------------------
612 * support functions for report_uninit()
615 /* the maxiumum size of array or hash where we will scan looking
616 * for the undefined element that triggered the warning */
618 #define FUV_MAX_SEARCH_SIZE 1000
620 /* Look for an entry in the hash whose value has the same SV as val;
621 * If so, return a mortal copy of the key. */
624 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
630 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
631 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
636 for (i=HvMAX(hv); i>0; i--) {
637 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
638 if (HeVAL(entry) != val)
640 if ( HeVAL(entry) == &PL_sv_undef ||
641 HeVAL(entry) == &PL_sv_placeholder)
645 if (HeKLEN(entry) == HEf_SVKEY)
646 return sv_mortalcopy(HeKEY_sv(entry));
647 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
653 /* Look for an entry in the array whose value has the same SV as val;
654 * If so, return the index, otherwise return -1. */
657 S_find_array_subscript(pTHX_ AV *av, SV* val)
661 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
662 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
666 for (i=AvFILLp(av); i>=0; i--) {
667 if (svp[i] == val && svp[i] != &PL_sv_undef)
673 /* S_varname(): return the name of a variable, optionally with a subscript.
674 * If gv is non-zero, use the name of that global, along with gvtype (one
675 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
676 * targ. Depending on the value of the subscript_type flag, return:
679 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
680 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
681 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
682 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
685 S_varname(pTHX_ GV *gv, char *gvtype, PADOFFSET targ,
686 SV* keyname, I32 aindex, int subscript_type)
692 name = sv_newmortal();
695 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
696 * XXX get rid of all this if gv_fullnameX() ever supports this
700 HV *hv = GvSTASH(gv);
701 sv_setpv(name, gvtype);
704 else if (!HvNAME(hv))
708 if (strNE(p, "main")) {
710 sv_catpvn(name,"::", 2);
712 if (GvNAMELEN(gv)>= 1 &&
713 ((unsigned int)*GvNAME(gv)) <= 26)
715 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
716 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
719 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
723 CV *cv = find_runcv(&u);
724 if (!cv || !CvPADLIST(cv))
726 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
727 sv = *av_fetch(av, targ, FALSE);
728 /* SvLEN in a pad name is not to be trusted */
729 sv_setpv(name, SvPV_nolen(sv));
732 if (subscript_type == FUV_SUBSCRIPT_HASH) {
735 Perl_sv_catpvf(aTHX_ name, "{%s}",
736 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
739 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
741 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
743 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
744 sv_insert(name, 0, 0, "within ", 7);
751 =for apidoc find_uninit_var
753 Find the name of the undefined variable (if any) that caused the operator o
754 to issue a "Use of uninitialized value" warning.
755 If match is true, only return a name if it's value matches uninit_sv.
756 So roughly speaking, if a unary operator (such as OP_COS) generates a
757 warning, then following the direct child of the op may yield an
758 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
759 other hand, with OP_ADD there are two branches to follow, so we only print
760 the variable name if we get an exact match.
762 The name is returned as a mortal SV.
764 Assumes that PL_op is the op that originally triggered the error, and that
765 PL_comppad/PL_curpad points to the currently executing pad.
771 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
779 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
780 uninit_sv == &PL_sv_placeholder)))
783 switch (obase->op_type) {
790 bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
791 bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
794 int subscript_type = FUV_SUBSCRIPT_WITHIN;
796 if (pad) { /* @lex, %lex */
797 sv = PAD_SVl(obase->op_targ);
801 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
802 /* @global, %global */
803 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
806 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
808 else /* @{expr}, %{expr} */
809 return find_uninit_var(cUNOPx(obase)->op_first,
813 /* attempt to find a match within the aggregate */
815 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
817 subscript_type = FUV_SUBSCRIPT_HASH;
820 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
822 subscript_type = FUV_SUBSCRIPT_ARRAY;
825 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
828 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
829 keysv, index, subscript_type);
833 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
835 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
836 Nullsv, 0, FUV_SUBSCRIPT_NONE);
839 gv = cGVOPx_gv(obase);
840 if (!gv || (match && GvSV(gv) != uninit_sv))
842 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
845 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
847 av = (AV*)PAD_SV(obase->op_targ);
848 if (!av || SvRMAGICAL(av))
850 svp = av_fetch(av, (I32)obase->op_private, FALSE);
851 if (!svp || *svp != uninit_sv)
854 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
855 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
858 gv = cGVOPx_gv(obase);
863 if (!av || SvRMAGICAL(av))
865 svp = av_fetch(av, (I32)obase->op_private, FALSE);
866 if (!svp || *svp != uninit_sv)
869 return S_varname(aTHX_ gv, "$", 0,
870 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
875 o = cUNOPx(obase)->op_first;
876 if (!o || o->op_type != OP_NULL ||
877 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
879 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
884 /* $a[uninit_expr] or $h{uninit_expr} */
885 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
888 o = cBINOPx(obase)->op_first;
889 kid = cBINOPx(obase)->op_last;
891 /* get the av or hv, and optionally the gv */
893 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
894 sv = PAD_SV(o->op_targ);
896 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
897 && cUNOPo->op_first->op_type == OP_GV)
899 gv = cGVOPx_gv(cUNOPo->op_first);
902 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
907 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
908 /* index is constant */
912 if (obase->op_type == OP_HELEM) {
913 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
914 if (!he || HeVAL(he) != uninit_sv)
918 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
919 if (!svp || *svp != uninit_sv)
923 if (obase->op_type == OP_HELEM)
924 return S_varname(aTHX_ gv, "%", o->op_targ,
925 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
927 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
928 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
932 /* index is an expression;
933 * attempt to find a match within the aggregate */
934 if (obase->op_type == OP_HELEM) {
935 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
937 return S_varname(aTHX_ gv, "%", o->op_targ,
938 keysv, 0, FUV_SUBSCRIPT_HASH);
941 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
943 return S_varname(aTHX_ gv, "@", o->op_targ,
944 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
948 return S_varname(aTHX_ gv,
949 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
951 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
957 /* only examine RHS */
958 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
961 o = cUNOPx(obase)->op_first;
962 if (o->op_type == OP_PUSHMARK)
965 if (!o->op_sibling) {
966 /* one-arg version of open is highly magical */
968 if (o->op_type == OP_GV) { /* open FOO; */
970 if (match && GvSV(gv) != uninit_sv)
972 return S_varname(aTHX_ gv, "$", 0,
973 Nullsv, 0, FUV_SUBSCRIPT_NONE);
975 /* other possibilities not handled are:
976 * open $x; or open my $x; should return '${*$x}'
977 * open expr; should return '$'.expr ideally
983 /* ops where $_ may be an implicit arg */
987 if ( !(obase->op_flags & OPf_STACKED)) {
988 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
989 ? PAD_SVl(obase->op_targ)
1001 /* skip filehandle as it can't produce 'undef' warning */
1002 o = cUNOPx(obase)->op_first;
1003 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1004 o = o->op_sibling->op_sibling;
1011 match = 1; /* XS or custom code could trigger random warnings */
1016 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1017 return sv_2mortal(newSVpv("${$/}", 0));
1022 if (!(obase->op_flags & OPf_KIDS))
1024 o = cUNOPx(obase)->op_first;
1030 /* if all except one arg are constant, or have no side-effects,
1031 * or are optimized away, then it's unambiguous */
1033 for (kid=o; kid; kid = kid->op_sibling) {
1035 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1036 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1037 || (kid->op_type == OP_PUSHMARK)
1041 if (o2) { /* more than one found */
1048 return find_uninit_var(o2, uninit_sv, match);
1052 sv = find_uninit_var(o, uninit_sv, 1);
1064 =for apidoc report_uninit
1066 Print appropriate "Use of uninitialized variable" warning
1072 Perl_report_uninit(pTHX_ SV* uninit_sv)
1077 varname = find_uninit_var(PL_op, uninit_sv,0);
1079 sv_insert(varname, 0, 0, " ", 1);
1081 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1082 varname ? SvPV_nolen(varname) : "",
1083 " in ", OP_DESC(PL_op));
1086 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1090 /* grab a new IV body from the free list, allocating more if necessary */
1101 * See comment in more_xiv() -- RAM.
1103 PL_xiv_root = *(IV**)xiv;
1105 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
1108 /* return an IV body to the free list */
1111 S_del_xiv(pTHX_ XPVIV *p)
1113 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
1115 *(IV**)xiv = PL_xiv_root;
1120 /* allocate another arena's worth of IV bodies */
1126 register IV* xivend;
1128 New(705, ptr, 1008/sizeof(XPV), XPV);
1129 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
1130 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
1133 xivend = &xiv[1008 / sizeof(IV) - 1];
1134 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
1136 while (xiv < xivend) {
1137 *(IV**)xiv = (IV *)(xiv + 1);
1143 /* grab a new NV body from the free list, allocating more if necessary */
1153 PL_xnv_root = *(NV**)xnv;
1155 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1158 /* return an NV body to the free list */
1161 S_del_xnv(pTHX_ XPVNV *p)
1163 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1165 *(NV**)xnv = PL_xnv_root;
1170 /* allocate another arena's worth of NV bodies */
1176 register NV* xnvend;
1178 New(711, ptr, 1008/sizeof(XPV), XPV);
1179 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1180 PL_xnv_arenaroot = ptr;
1183 xnvend = &xnv[1008 / sizeof(NV) - 1];
1184 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1186 while (xnv < xnvend) {
1187 *(NV**)xnv = (NV*)(xnv + 1);
1193 /* grab a new struct xrv from the free list, allocating more if necessary */
1203 PL_xrv_root = (XRV*)xrv->xrv_rv;
1208 /* return a struct xrv to the free list */
1211 S_del_xrv(pTHX_ XRV *p)
1214 p->xrv_rv = (SV*)PL_xrv_root;
1219 /* allocate another arena's worth of struct xrv */
1225 register XRV* xrvend;
1227 New(712, ptr, 1008/sizeof(XPV), XPV);
1228 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1229 PL_xrv_arenaroot = ptr;
1232 xrvend = &xrv[1008 / sizeof(XRV) - 1];
1233 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1235 while (xrv < xrvend) {
1236 xrv->xrv_rv = (SV*)(xrv + 1);
1242 /* grab a new struct xpv from the free list, allocating more if necessary */
1252 PL_xpv_root = (XPV*)xpv->xpv_pv;
1257 /* return a struct xpv to the free list */
1260 S_del_xpv(pTHX_ XPV *p)
1263 p->xpv_pv = (char*)PL_xpv_root;
1268 /* allocate another arena's worth of struct xpv */
1274 register XPV* xpvend;
1275 New(713, xpv, 1008/sizeof(XPV), XPV);
1276 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1277 PL_xpv_arenaroot = xpv;
1279 xpvend = &xpv[1008 / sizeof(XPV) - 1];
1280 PL_xpv_root = ++xpv;
1281 while (xpv < xpvend) {
1282 xpv->xpv_pv = (char*)(xpv + 1);
1288 /* grab a new struct xpviv from the free list, allocating more if necessary */
1297 xpviv = PL_xpviv_root;
1298 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1303 /* return a struct xpviv to the free list */
1306 S_del_xpviv(pTHX_ XPVIV *p)
1309 p->xpv_pv = (char*)PL_xpviv_root;
1314 /* allocate another arena's worth of struct xpviv */
1319 register XPVIV* xpviv;
1320 register XPVIV* xpvivend;
1321 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
1322 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1323 PL_xpviv_arenaroot = xpviv;
1325 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
1326 PL_xpviv_root = ++xpviv;
1327 while (xpviv < xpvivend) {
1328 xpviv->xpv_pv = (char*)(xpviv + 1);
1334 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1343 xpvnv = PL_xpvnv_root;
1344 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1349 /* return a struct xpvnv to the free list */
1352 S_del_xpvnv(pTHX_ XPVNV *p)
1355 p->xpv_pv = (char*)PL_xpvnv_root;
1360 /* allocate another arena's worth of struct xpvnv */
1365 register XPVNV* xpvnv;
1366 register XPVNV* xpvnvend;
1367 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
1368 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1369 PL_xpvnv_arenaroot = xpvnv;
1371 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
1372 PL_xpvnv_root = ++xpvnv;
1373 while (xpvnv < xpvnvend) {
1374 xpvnv->xpv_pv = (char*)(xpvnv + 1);
1380 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1389 xpvcv = PL_xpvcv_root;
1390 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1395 /* return a struct xpvcv to the free list */
1398 S_del_xpvcv(pTHX_ XPVCV *p)
1401 p->xpv_pv = (char*)PL_xpvcv_root;
1406 /* allocate another arena's worth of struct xpvcv */
1411 register XPVCV* xpvcv;
1412 register XPVCV* xpvcvend;
1413 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
1414 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1415 PL_xpvcv_arenaroot = xpvcv;
1417 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
1418 PL_xpvcv_root = ++xpvcv;
1419 while (xpvcv < xpvcvend) {
1420 xpvcv->xpv_pv = (char*)(xpvcv + 1);
1426 /* grab a new struct xpvav from the free list, allocating more if necessary */
1435 xpvav = PL_xpvav_root;
1436 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1441 /* return a struct xpvav to the free list */
1444 S_del_xpvav(pTHX_ XPVAV *p)
1447 p->xav_array = (char*)PL_xpvav_root;
1452 /* allocate another arena's worth of struct xpvav */
1457 register XPVAV* xpvav;
1458 register XPVAV* xpvavend;
1459 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
1460 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1461 PL_xpvav_arenaroot = xpvav;
1463 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
1464 PL_xpvav_root = ++xpvav;
1465 while (xpvav < xpvavend) {
1466 xpvav->xav_array = (char*)(xpvav + 1);
1469 xpvav->xav_array = 0;
1472 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1481 xpvhv = PL_xpvhv_root;
1482 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1487 /* return a struct xpvhv to the free list */
1490 S_del_xpvhv(pTHX_ XPVHV *p)
1493 p->xhv_array = (char*)PL_xpvhv_root;
1498 /* allocate another arena's worth of struct xpvhv */
1503 register XPVHV* xpvhv;
1504 register XPVHV* xpvhvend;
1505 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1506 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1507 PL_xpvhv_arenaroot = xpvhv;
1509 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1510 PL_xpvhv_root = ++xpvhv;
1511 while (xpvhv < xpvhvend) {
1512 xpvhv->xhv_array = (char*)(xpvhv + 1);
1515 xpvhv->xhv_array = 0;
1518 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1527 xpvmg = PL_xpvmg_root;
1528 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1533 /* return a struct xpvmg to the free list */
1536 S_del_xpvmg(pTHX_ XPVMG *p)
1539 p->xpv_pv = (char*)PL_xpvmg_root;
1544 /* allocate another arena's worth of struct xpvmg */
1549 register XPVMG* xpvmg;
1550 register XPVMG* xpvmgend;
1551 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1552 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1553 PL_xpvmg_arenaroot = xpvmg;
1555 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1556 PL_xpvmg_root = ++xpvmg;
1557 while (xpvmg < xpvmgend) {
1558 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1564 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1573 xpvlv = PL_xpvlv_root;
1574 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1579 /* return a struct xpvlv to the free list */
1582 S_del_xpvlv(pTHX_ XPVLV *p)
1585 p->xpv_pv = (char*)PL_xpvlv_root;
1590 /* allocate another arena's worth of struct xpvlv */
1595 register XPVLV* xpvlv;
1596 register XPVLV* xpvlvend;
1597 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1598 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1599 PL_xpvlv_arenaroot = xpvlv;
1601 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1602 PL_xpvlv_root = ++xpvlv;
1603 while (xpvlv < xpvlvend) {
1604 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1610 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1619 xpvbm = PL_xpvbm_root;
1620 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1625 /* return a struct xpvbm to the free list */
1628 S_del_xpvbm(pTHX_ XPVBM *p)
1631 p->xpv_pv = (char*)PL_xpvbm_root;
1636 /* allocate another arena's worth of struct xpvbm */
1641 register XPVBM* xpvbm;
1642 register XPVBM* xpvbmend;
1643 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1644 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1645 PL_xpvbm_arenaroot = xpvbm;
1647 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1648 PL_xpvbm_root = ++xpvbm;
1649 while (xpvbm < xpvbmend) {
1650 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1656 #define my_safemalloc(s) (void*)safemalloc(s)
1657 #define my_safefree(p) safefree((char*)p)
1661 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1662 #define del_XIV(p) my_safefree(p)
1664 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1665 #define del_XNV(p) my_safefree(p)
1667 #define new_XRV() my_safemalloc(sizeof(XRV))
1668 #define del_XRV(p) my_safefree(p)
1670 #define new_XPV() my_safemalloc(sizeof(XPV))
1671 #define del_XPV(p) my_safefree(p)
1673 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1674 #define del_XPVIV(p) my_safefree(p)
1676 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1677 #define del_XPVNV(p) my_safefree(p)
1679 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1680 #define del_XPVCV(p) my_safefree(p)
1682 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1683 #define del_XPVAV(p) my_safefree(p)
1685 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1686 #define del_XPVHV(p) my_safefree(p)
1688 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1689 #define del_XPVMG(p) my_safefree(p)
1691 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1692 #define del_XPVLV(p) my_safefree(p)
1694 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1695 #define del_XPVBM(p) my_safefree(p)
1699 #define new_XIV() (void*)new_xiv()
1700 #define del_XIV(p) del_xiv((XPVIV*) p)
1702 #define new_XNV() (void*)new_xnv()
1703 #define del_XNV(p) del_xnv((XPVNV*) p)
1705 #define new_XRV() (void*)new_xrv()
1706 #define del_XRV(p) del_xrv((XRV*) p)
1708 #define new_XPV() (void*)new_xpv()
1709 #define del_XPV(p) del_xpv((XPV *)p)
1711 #define new_XPVIV() (void*)new_xpviv()
1712 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1714 #define new_XPVNV() (void*)new_xpvnv()
1715 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1717 #define new_XPVCV() (void*)new_xpvcv()
1718 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1720 #define new_XPVAV() (void*)new_xpvav()
1721 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1723 #define new_XPVHV() (void*)new_xpvhv()
1724 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1726 #define new_XPVMG() (void*)new_xpvmg()
1727 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1729 #define new_XPVLV() (void*)new_xpvlv()
1730 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1732 #define new_XPVBM() (void*)new_xpvbm()
1733 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1737 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1738 #define del_XPVGV(p) my_safefree(p)
1740 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1741 #define del_XPVFM(p) my_safefree(p)
1743 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1744 #define del_XPVIO(p) my_safefree(p)
1747 =for apidoc sv_upgrade
1749 Upgrade an SV to a more complex form. Generally adds a new body type to the
1750 SV, then copies across as much information as possible from the old body.
1751 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1757 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1764 MAGIC* magic = NULL;
1767 if (mt != SVt_PV && SvIsCOW(sv)) {
1768 sv_force_normal_flags(sv, 0);
1771 if (SvTYPE(sv) == mt)
1775 (void)SvOOK_off(sv);
1777 switch (SvTYPE(sv)) {
1798 else if (mt < SVt_PVIV)
1815 pv = (char*)SvRV(sv);
1835 else if (mt == SVt_NV)
1846 del_XPVIV(SvANY(sv));
1856 del_XPVNV(SvANY(sv));
1864 magic = SvMAGIC(sv);
1865 stash = SvSTASH(sv);
1866 del_XPVMG(SvANY(sv));
1869 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1872 SvFLAGS(sv) &= ~SVTYPEMASK;
1877 Perl_croak(aTHX_ "Can't upgrade to undef");
1879 SvANY(sv) = new_XIV();
1883 SvANY(sv) = new_XNV();
1887 SvANY(sv) = new_XRV();
1891 SvANY(sv) = new_XPV();
1897 SvANY(sv) = new_XPVIV();
1907 SvANY(sv) = new_XPVNV();
1915 SvANY(sv) = new_XPVMG();
1921 SvMAGIC(sv) = magic;
1922 SvSTASH(sv) = stash;
1925 SvANY(sv) = new_XPVLV();
1931 SvMAGIC(sv) = magic;
1932 SvSTASH(sv) = stash;
1944 SvANY(sv) = new_XPVAV();
1952 SvMAGIC(sv) = magic;
1953 SvSTASH(sv) = stash;
1959 SvANY(sv) = new_XPVHV();
1965 HvTOTALKEYS(sv) = 0;
1966 HvPLACEHOLDERS(sv) = 0;
1967 SvMAGIC(sv) = magic;
1968 SvSTASH(sv) = stash;
1975 SvANY(sv) = new_XPVCV();
1976 Zero(SvANY(sv), 1, XPVCV);
1982 SvMAGIC(sv) = magic;
1983 SvSTASH(sv) = stash;
1986 SvANY(sv) = new_XPVGV();
1992 SvMAGIC(sv) = magic;
1993 SvSTASH(sv) = stash;
2001 SvANY(sv) = new_XPVBM();
2007 SvMAGIC(sv) = magic;
2008 SvSTASH(sv) = stash;
2014 SvANY(sv) = new_XPVFM();
2015 Zero(SvANY(sv), 1, XPVFM);
2021 SvMAGIC(sv) = magic;
2022 SvSTASH(sv) = stash;
2025 SvANY(sv) = new_XPVIO();
2026 Zero(SvANY(sv), 1, XPVIO);
2032 SvMAGIC(sv) = magic;
2033 SvSTASH(sv) = stash;
2034 IoPAGE_LEN(sv) = 60;
2041 =for apidoc sv_backoff
2043 Remove any string offset. You should normally use the C<SvOOK_off> macro
2050 Perl_sv_backoff(pTHX_ register SV *sv)
2054 char *s = SvPVX(sv);
2055 SvLEN(sv) += SvIVX(sv);
2056 SvPVX(sv) -= SvIVX(sv);
2058 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2060 SvFLAGS(sv) &= ~SVf_OOK;
2067 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2068 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2069 Use the C<SvGROW> wrapper instead.
2075 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2079 #ifdef HAS_64K_LIMIT
2080 if (newlen >= 0x10000) {
2081 PerlIO_printf(Perl_debug_log,
2082 "Allocation too large: %"UVxf"\n", (UV)newlen);
2085 #endif /* HAS_64K_LIMIT */
2088 if (SvTYPE(sv) < SVt_PV) {
2089 sv_upgrade(sv, SVt_PV);
2092 else if (SvOOK(sv)) { /* pv is offset? */
2095 if (newlen > SvLEN(sv))
2096 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2097 #ifdef HAS_64K_LIMIT
2098 if (newlen >= 0x10000)
2105 if (newlen > SvLEN(sv)) { /* need more room? */
2106 if (SvLEN(sv) && s) {
2108 STRLEN l = malloced_size((void*)SvPVX(sv));
2114 Renew(s,newlen,char);
2117 New(703, s, newlen, char);
2118 if (SvPVX(sv) && SvCUR(sv)) {
2119 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2123 SvLEN_set(sv, newlen);
2129 =for apidoc sv_setiv
2131 Copies an integer into the given SV, upgrading first if necessary.
2132 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2138 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2140 SV_CHECK_THINKFIRST_COW_DROP(sv);
2141 switch (SvTYPE(sv)) {
2143 sv_upgrade(sv, SVt_IV);
2146 sv_upgrade(sv, SVt_PVNV);
2150 sv_upgrade(sv, SVt_PVIV);
2159 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2162 (void)SvIOK_only(sv); /* validate number */
2168 =for apidoc sv_setiv_mg
2170 Like C<sv_setiv>, but also handles 'set' magic.
2176 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2183 =for apidoc sv_setuv
2185 Copies an unsigned integer into the given SV, upgrading first if necessary.
2186 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2192 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2194 /* With these two if statements:
2195 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2198 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2200 If you wish to remove them, please benchmark to see what the effect is
2202 if (u <= (UV)IV_MAX) {
2203 sv_setiv(sv, (IV)u);
2212 =for apidoc sv_setuv_mg
2214 Like C<sv_setuv>, but also handles 'set' magic.
2220 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2222 /* With these two if statements:
2223 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2226 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2228 If you wish to remove them, please benchmark to see what the effect is
2230 if (u <= (UV)IV_MAX) {
2231 sv_setiv(sv, (IV)u);
2241 =for apidoc sv_setnv
2243 Copies a double into the given SV, upgrading first if necessary.
2244 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2250 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2252 SV_CHECK_THINKFIRST_COW_DROP(sv);
2253 switch (SvTYPE(sv)) {
2256 sv_upgrade(sv, SVt_NV);
2261 sv_upgrade(sv, SVt_PVNV);
2270 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2274 (void)SvNOK_only(sv); /* validate number */
2279 =for apidoc sv_setnv_mg
2281 Like C<sv_setnv>, but also handles 'set' magic.
2287 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2293 /* Print an "isn't numeric" warning, using a cleaned-up,
2294 * printable version of the offending string
2298 S_not_a_number(pTHX_ SV *sv)
2305 dsv = sv_2mortal(newSVpv("", 0));
2306 pv = sv_uni_display(dsv, sv, 10, 0);
2309 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2310 /* each *s can expand to 4 chars + "...\0",
2311 i.e. need room for 8 chars */
2314 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2316 if (ch & 128 && !isPRINT_LC(ch)) {
2325 else if (ch == '\r') {
2329 else if (ch == '\f') {
2333 else if (ch == '\\') {
2337 else if (ch == '\0') {
2341 else if (isPRINT_LC(ch))
2358 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2359 "Argument \"%s\" isn't numeric in %s", pv,
2362 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2363 "Argument \"%s\" isn't numeric", pv);
2367 =for apidoc looks_like_number
2369 Test if the content of an SV looks like a number (or is a number).
2370 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2371 non-numeric warning), even if your atof() doesn't grok them.
2377 Perl_looks_like_number(pTHX_ SV *sv)
2379 register char *sbegin;
2386 else if (SvPOKp(sv))
2387 sbegin = SvPV(sv, len);
2389 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2390 return grok_number(sbegin, len, NULL);
2393 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2394 until proven guilty, assume that things are not that bad... */
2399 As 64 bit platforms often have an NV that doesn't preserve all bits of
2400 an IV (an assumption perl has been based on to date) it becomes necessary
2401 to remove the assumption that the NV always carries enough precision to
2402 recreate the IV whenever needed, and that the NV is the canonical form.
2403 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2404 precision as a side effect of conversion (which would lead to insanity
2405 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2406 1) to distinguish between IV/UV/NV slots that have cached a valid
2407 conversion where precision was lost and IV/UV/NV slots that have a
2408 valid conversion which has lost no precision
2409 2) to ensure that if a numeric conversion to one form is requested that
2410 would lose precision, the precise conversion (or differently
2411 imprecise conversion) is also performed and cached, to prevent
2412 requests for different numeric formats on the same SV causing
2413 lossy conversion chains. (lossless conversion chains are perfectly
2418 SvIOKp is true if the IV slot contains a valid value
2419 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2420 SvNOKp is true if the NV slot contains a valid value
2421 SvNOK is true only if the NV value is accurate
2424 while converting from PV to NV, check to see if converting that NV to an
2425 IV(or UV) would lose accuracy over a direct conversion from PV to
2426 IV(or UV). If it would, cache both conversions, return NV, but mark
2427 SV as IOK NOKp (ie not NOK).
2429 While converting from PV to IV, check to see if converting that IV to an
2430 NV would lose accuracy over a direct conversion from PV to NV. If it
2431 would, cache both conversions, flag similarly.
2433 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2434 correctly because if IV & NV were set NV *always* overruled.
2435 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2436 changes - now IV and NV together means that the two are interchangeable:
2437 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2439 The benefit of this is that operations such as pp_add know that if
2440 SvIOK is true for both left and right operands, then integer addition
2441 can be used instead of floating point (for cases where the result won't
2442 overflow). Before, floating point was always used, which could lead to
2443 loss of precision compared with integer addition.
2445 * making IV and NV equal status should make maths accurate on 64 bit
2447 * may speed up maths somewhat if pp_add and friends start to use
2448 integers when possible instead of fp. (Hopefully the overhead in
2449 looking for SvIOK and checking for overflow will not outweigh the
2450 fp to integer speedup)
2451 * will slow down integer operations (callers of SvIV) on "inaccurate"
2452 values, as the change from SvIOK to SvIOKp will cause a call into
2453 sv_2iv each time rather than a macro access direct to the IV slot
2454 * should speed up number->string conversion on integers as IV is
2455 favoured when IV and NV are equally accurate
2457 ####################################################################
2458 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2459 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2460 On the other hand, SvUOK is true iff UV.
2461 ####################################################################
2463 Your mileage will vary depending your CPU's relative fp to integer
2467 #ifndef NV_PRESERVES_UV
2468 # define IS_NUMBER_UNDERFLOW_IV 1
2469 # define IS_NUMBER_UNDERFLOW_UV 2
2470 # define IS_NUMBER_IV_AND_UV 2
2471 # define IS_NUMBER_OVERFLOW_IV 4
2472 # define IS_NUMBER_OVERFLOW_UV 5
2474 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2476 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2478 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2480 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2481 if (SvNVX(sv) < (NV)IV_MIN) {
2482 (void)SvIOKp_on(sv);
2485 return IS_NUMBER_UNDERFLOW_IV;
2487 if (SvNVX(sv) > (NV)UV_MAX) {
2488 (void)SvIOKp_on(sv);
2492 return IS_NUMBER_OVERFLOW_UV;
2494 (void)SvIOKp_on(sv);
2496 /* Can't use strtol etc to convert this string. (See truth table in
2498 if (SvNVX(sv) <= (UV)IV_MAX) {
2499 SvIVX(sv) = I_V(SvNVX(sv));
2500 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2501 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2503 /* Integer is imprecise. NOK, IOKp */
2505 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2508 SvUVX(sv) = U_V(SvNVX(sv));
2509 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2510 if (SvUVX(sv) == UV_MAX) {
2511 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2512 possibly be preserved by NV. Hence, it must be overflow.
2514 return IS_NUMBER_OVERFLOW_UV;
2516 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2518 /* Integer is imprecise. NOK, IOKp */
2520 return IS_NUMBER_OVERFLOW_IV;
2522 #endif /* !NV_PRESERVES_UV*/
2524 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2525 * this function provided for binary compatibility only
2529 Perl_sv_2iv(pTHX_ register SV *sv)
2531 return sv_2iv_flags(sv, SV_GMAGIC);
2535 =for apidoc sv_2iv_flags
2537 Return the integer value of an SV, doing any necessary string
2538 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2539 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2545 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2549 if (SvGMAGICAL(sv)) {
2550 if (flags & SV_GMAGIC)
2555 return I_V(SvNVX(sv));
2557 if (SvPOKp(sv) && SvLEN(sv))
2560 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2561 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2567 if (SvTHINKFIRST(sv)) {
2570 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2571 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2572 return SvIV(tmpstr);
2573 return PTR2IV(SvRV(sv));
2576 sv_force_normal_flags(sv, 0);
2578 if (SvREADONLY(sv) && !SvOK(sv)) {
2579 if (ckWARN(WARN_UNINITIALIZED))
2586 return (IV)(SvUVX(sv));
2593 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2594 * without also getting a cached IV/UV from it at the same time
2595 * (ie PV->NV conversion should detect loss of accuracy and cache
2596 * IV or UV at same time to avoid this. NWC */
2598 if (SvTYPE(sv) == SVt_NV)
2599 sv_upgrade(sv, SVt_PVNV);
2601 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2602 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2603 certainly cast into the IV range at IV_MAX, whereas the correct
2604 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2606 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2607 SvIVX(sv) = I_V(SvNVX(sv));
2608 if (SvNVX(sv) == (NV) SvIVX(sv)
2609 #ifndef NV_PRESERVES_UV
2610 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2611 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2612 /* Don't flag it as "accurately an integer" if the number
2613 came from a (by definition imprecise) NV operation, and
2614 we're outside the range of NV integer precision */
2617 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2618 DEBUG_c(PerlIO_printf(Perl_debug_log,
2619 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2625 /* IV not precise. No need to convert from PV, as NV
2626 conversion would already have cached IV if it detected
2627 that PV->IV would be better than PV->NV->IV
2628 flags already correct - don't set public IOK. */
2629 DEBUG_c(PerlIO_printf(Perl_debug_log,
2630 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2635 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2636 but the cast (NV)IV_MIN rounds to a the value less (more
2637 negative) than IV_MIN which happens to be equal to SvNVX ??
2638 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2639 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2640 (NV)UVX == NVX are both true, but the values differ. :-(
2641 Hopefully for 2s complement IV_MIN is something like
2642 0x8000000000000000 which will be exact. NWC */
2645 SvUVX(sv) = U_V(SvNVX(sv));
2647 (SvNVX(sv) == (NV) SvUVX(sv))
2648 #ifndef NV_PRESERVES_UV
2649 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2650 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2651 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2652 /* Don't flag it as "accurately an integer" if the number
2653 came from a (by definition imprecise) NV operation, and
2654 we're outside the range of NV integer precision */
2660 DEBUG_c(PerlIO_printf(Perl_debug_log,
2661 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2665 return (IV)SvUVX(sv);
2668 else if (SvPOKp(sv) && SvLEN(sv)) {
2670 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2671 /* We want to avoid a possible problem when we cache an IV which
2672 may be later translated to an NV, and the resulting NV is not
2673 the same as the direct translation of the initial string
2674 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2675 be careful to ensure that the value with the .456 is around if the
2676 NV value is requested in the future).
2678 This means that if we cache such an IV, we need to cache the
2679 NV as well. Moreover, we trade speed for space, and do not
2680 cache the NV if we are sure it's not needed.
2683 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2684 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2685 == IS_NUMBER_IN_UV) {
2686 /* It's definitely an integer, only upgrade to PVIV */
2687 if (SvTYPE(sv) < SVt_PVIV)
2688 sv_upgrade(sv, SVt_PVIV);
2690 } else if (SvTYPE(sv) < SVt_PVNV)
2691 sv_upgrade(sv, SVt_PVNV);
2693 /* If NV preserves UV then we only use the UV value if we know that
2694 we aren't going to call atof() below. If NVs don't preserve UVs
2695 then the value returned may have more precision than atof() will
2696 return, even though value isn't perfectly accurate. */
2697 if ((numtype & (IS_NUMBER_IN_UV
2698 #ifdef NV_PRESERVES_UV
2701 )) == IS_NUMBER_IN_UV) {
2702 /* This won't turn off the public IOK flag if it was set above */
2703 (void)SvIOKp_on(sv);
2705 if (!(numtype & IS_NUMBER_NEG)) {
2707 if (value <= (UV)IV_MAX) {
2708 SvIVX(sv) = (IV)value;
2714 /* 2s complement assumption */
2715 if (value <= (UV)IV_MIN) {
2716 SvIVX(sv) = -(IV)value;
2718 /* Too negative for an IV. This is a double upgrade, but
2719 I'm assuming it will be rare. */
2720 if (SvTYPE(sv) < SVt_PVNV)
2721 sv_upgrade(sv, SVt_PVNV);
2725 SvNVX(sv) = -(NV)value;
2730 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2731 will be in the previous block to set the IV slot, and the next
2732 block to set the NV slot. So no else here. */
2734 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2735 != IS_NUMBER_IN_UV) {
2736 /* It wasn't an (integer that doesn't overflow the UV). */
2737 SvNVX(sv) = Atof(SvPVX(sv));
2739 if (! numtype && ckWARN(WARN_NUMERIC))
2742 #if defined(USE_LONG_DOUBLE)
2743 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2744 PTR2UV(sv), SvNVX(sv)));
2746 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2747 PTR2UV(sv), SvNVX(sv)));
2751 #ifdef NV_PRESERVES_UV
2752 (void)SvIOKp_on(sv);
2754 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2755 SvIVX(sv) = I_V(SvNVX(sv));
2756 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2759 /* Integer is imprecise. NOK, IOKp */
2761 /* UV will not work better than IV */
2763 if (SvNVX(sv) > (NV)UV_MAX) {
2765 /* Integer is inaccurate. NOK, IOKp, is UV */
2769 SvUVX(sv) = U_V(SvNVX(sv));
2770 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2771 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2775 /* Integer is imprecise. NOK, IOKp, is UV */
2781 #else /* NV_PRESERVES_UV */
2782 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2783 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2784 /* The IV slot will have been set from value returned by
2785 grok_number above. The NV slot has just been set using
2788 assert (SvIOKp(sv));
2790 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2791 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2792 /* Small enough to preserve all bits. */
2793 (void)SvIOKp_on(sv);
2795 SvIVX(sv) = I_V(SvNVX(sv));
2796 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2798 /* Assumption: first non-preserved integer is < IV_MAX,
2799 this NV is in the preserved range, therefore: */
2800 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2802 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);
2806 0 0 already failed to read UV.
2807 0 1 already failed to read UV.
2808 1 0 you won't get here in this case. IV/UV
2809 slot set, public IOK, Atof() unneeded.
2810 1 1 already read UV.
2811 so there's no point in sv_2iuv_non_preserve() attempting
2812 to use atol, strtol, strtoul etc. */
2813 if (sv_2iuv_non_preserve (sv, numtype)
2814 >= IS_NUMBER_OVERFLOW_IV)
2818 #endif /* NV_PRESERVES_UV */
2821 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2823 if (SvTYPE(sv) < SVt_IV)
2824 /* Typically the caller expects that sv_any is not NULL now. */
2825 sv_upgrade(sv, SVt_IV);
2828 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2829 PTR2UV(sv),SvIVX(sv)));
2830 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2833 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2834 * this function provided for binary compatibility only
2838 Perl_sv_2uv(pTHX_ register SV *sv)
2840 return sv_2uv_flags(sv, SV_GMAGIC);
2844 =for apidoc sv_2uv_flags
2846 Return the unsigned integer value of an SV, doing any necessary string
2847 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2848 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2854 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2858 if (SvGMAGICAL(sv)) {
2859 if (flags & SV_GMAGIC)
2864 return U_V(SvNVX(sv));
2865 if (SvPOKp(sv) && SvLEN(sv))
2868 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2869 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2875 if (SvTHINKFIRST(sv)) {
2878 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2879 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2880 return SvUV(tmpstr);
2881 return PTR2UV(SvRV(sv));
2884 sv_force_normal_flags(sv, 0);
2886 if (SvREADONLY(sv) && !SvOK(sv)) {
2887 if (ckWARN(WARN_UNINITIALIZED))
2897 return (UV)SvIVX(sv);
2901 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2902 * without also getting a cached IV/UV from it at the same time
2903 * (ie PV->NV conversion should detect loss of accuracy and cache
2904 * IV or UV at same time to avoid this. */
2905 /* IV-over-UV optimisation - choose to cache IV if possible */
2907 if (SvTYPE(sv) == SVt_NV)
2908 sv_upgrade(sv, SVt_PVNV);
2910 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2911 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2912 SvIVX(sv) = I_V(SvNVX(sv));
2913 if (SvNVX(sv) == (NV) SvIVX(sv)
2914 #ifndef NV_PRESERVES_UV
2915 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2916 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2917 /* Don't flag it as "accurately an integer" if the number
2918 came from a (by definition imprecise) NV operation, and
2919 we're outside the range of NV integer precision */
2922 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2923 DEBUG_c(PerlIO_printf(Perl_debug_log,
2924 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2930 /* IV not precise. No need to convert from PV, as NV
2931 conversion would already have cached IV if it detected
2932 that PV->IV would be better than PV->NV->IV
2933 flags already correct - don't set public IOK. */
2934 DEBUG_c(PerlIO_printf(Perl_debug_log,
2935 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2940 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2941 but the cast (NV)IV_MIN rounds to a the value less (more
2942 negative) than IV_MIN which happens to be equal to SvNVX ??
2943 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2944 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2945 (NV)UVX == NVX are both true, but the values differ. :-(
2946 Hopefully for 2s complement IV_MIN is something like
2947 0x8000000000000000 which will be exact. NWC */
2950 SvUVX(sv) = U_V(SvNVX(sv));
2952 (SvNVX(sv) == (NV) SvUVX(sv))
2953 #ifndef NV_PRESERVES_UV
2954 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2955 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2956 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2957 /* Don't flag it as "accurately an integer" if the number
2958 came from a (by definition imprecise) NV operation, and
2959 we're outside the range of NV integer precision */
2964 DEBUG_c(PerlIO_printf(Perl_debug_log,
2965 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2971 else if (SvPOKp(sv) && SvLEN(sv)) {
2973 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2975 /* We want to avoid a possible problem when we cache a UV which
2976 may be later translated to an NV, and the resulting NV is not
2977 the translation of the initial data.
2979 This means that if we cache such a UV, we need to cache the
2980 NV as well. Moreover, we trade speed for space, and do not
2981 cache the NV if not needed.
2984 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2985 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2986 == IS_NUMBER_IN_UV) {
2987 /* It's definitely an integer, only upgrade to PVIV */
2988 if (SvTYPE(sv) < SVt_PVIV)
2989 sv_upgrade(sv, SVt_PVIV);
2991 } else if (SvTYPE(sv) < SVt_PVNV)
2992 sv_upgrade(sv, SVt_PVNV);
2994 /* If NV preserves UV then we only use the UV value if we know that
2995 we aren't going to call atof() below. If NVs don't preserve UVs
2996 then the value returned may have more precision than atof() will
2997 return, even though it isn't accurate. */
2998 if ((numtype & (IS_NUMBER_IN_UV
2999 #ifdef NV_PRESERVES_UV
3002 )) == IS_NUMBER_IN_UV) {
3003 /* This won't turn off the public IOK flag if it was set above */
3004 (void)SvIOKp_on(sv);
3006 if (!(numtype & IS_NUMBER_NEG)) {
3008 if (value <= (UV)IV_MAX) {
3009 SvIVX(sv) = (IV)value;
3011 /* it didn't overflow, and it was positive. */
3016 /* 2s complement assumption */
3017 if (value <= (UV)IV_MIN) {
3018 SvIVX(sv) = -(IV)value;
3020 /* Too negative for an IV. This is a double upgrade, but
3021 I'm assuming it will be rare. */
3022 if (SvTYPE(sv) < SVt_PVNV)
3023 sv_upgrade(sv, SVt_PVNV);
3027 SvNVX(sv) = -(NV)value;
3033 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3034 != IS_NUMBER_IN_UV) {
3035 /* It wasn't an integer, or it overflowed the UV. */
3036 SvNVX(sv) = Atof(SvPVX(sv));
3038 if (! numtype && ckWARN(WARN_NUMERIC))
3041 #if defined(USE_LONG_DOUBLE)
3042 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3043 PTR2UV(sv), SvNVX(sv)));
3045 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3046 PTR2UV(sv), SvNVX(sv)));
3049 #ifdef NV_PRESERVES_UV
3050 (void)SvIOKp_on(sv);
3052 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3053 SvIVX(sv) = I_V(SvNVX(sv));
3054 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3057 /* Integer is imprecise. NOK, IOKp */
3059 /* UV will not work better than IV */
3061 if (SvNVX(sv) > (NV)UV_MAX) {
3063 /* Integer is inaccurate. NOK, IOKp, is UV */
3067 SvUVX(sv) = U_V(SvNVX(sv));
3068 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3069 NV preservse UV so can do correct comparison. */
3070 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3074 /* Integer is imprecise. NOK, IOKp, is UV */
3079 #else /* NV_PRESERVES_UV */
3080 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3081 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3082 /* The UV slot will have been set from value returned by
3083 grok_number above. The NV slot has just been set using
3086 assert (SvIOKp(sv));
3088 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3089 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3090 /* Small enough to preserve all bits. */
3091 (void)SvIOKp_on(sv);
3093 SvIVX(sv) = I_V(SvNVX(sv));
3094 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3096 /* Assumption: first non-preserved integer is < IV_MAX,
3097 this NV is in the preserved range, therefore: */
3098 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3100 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);
3103 sv_2iuv_non_preserve (sv, numtype);
3105 #endif /* NV_PRESERVES_UV */
3109 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3110 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3113 if (SvTYPE(sv) < SVt_IV)
3114 /* Typically the caller expects that sv_any is not NULL now. */
3115 sv_upgrade(sv, SVt_IV);
3119 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3120 PTR2UV(sv),SvUVX(sv)));
3121 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3127 Return the num value of an SV, doing any necessary string or integer
3128 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3135 Perl_sv_2nv(pTHX_ register SV *sv)
3139 if (SvGMAGICAL(sv)) {
3143 if (SvPOKp(sv) && SvLEN(sv)) {
3144 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3145 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3147 return Atof(SvPVX(sv));
3151 return (NV)SvUVX(sv);
3153 return (NV)SvIVX(sv);
3156 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3157 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3163 if (SvTHINKFIRST(sv)) {
3166 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3167 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3168 return SvNV(tmpstr);
3169 return PTR2NV(SvRV(sv));
3172 sv_force_normal_flags(sv, 0);
3174 if (SvREADONLY(sv) && !SvOK(sv)) {
3175 if (ckWARN(WARN_UNINITIALIZED))
3180 if (SvTYPE(sv) < SVt_NV) {
3181 if (SvTYPE(sv) == SVt_IV)
3182 sv_upgrade(sv, SVt_PVNV);
3184 sv_upgrade(sv, SVt_NV);
3185 #ifdef USE_LONG_DOUBLE
3187 STORE_NUMERIC_LOCAL_SET_STANDARD();
3188 PerlIO_printf(Perl_debug_log,
3189 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3190 PTR2UV(sv), SvNVX(sv));
3191 RESTORE_NUMERIC_LOCAL();
3195 STORE_NUMERIC_LOCAL_SET_STANDARD();
3196 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3197 PTR2UV(sv), SvNVX(sv));
3198 RESTORE_NUMERIC_LOCAL();
3202 else if (SvTYPE(sv) < SVt_PVNV)
3203 sv_upgrade(sv, SVt_PVNV);
3208 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
3209 #ifdef NV_PRESERVES_UV
3212 /* Only set the public NV OK flag if this NV preserves the IV */
3213 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3214 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3215 : (SvIVX(sv) == I_V(SvNVX(sv))))
3221 else if (SvPOKp(sv) && SvLEN(sv)) {
3223 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3224 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3226 #ifdef NV_PRESERVES_UV
3227 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3228 == IS_NUMBER_IN_UV) {
3229 /* It's definitely an integer */
3230 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3232 SvNVX(sv) = Atof(SvPVX(sv));
3235 SvNVX(sv) = Atof(SvPVX(sv));
3236 /* Only set the public NV OK flag if this NV preserves the value in
3237 the PV at least as well as an IV/UV would.
3238 Not sure how to do this 100% reliably. */
3239 /* if that shift count is out of range then Configure's test is
3240 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3242 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3243 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3244 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3245 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3246 /* Can't use strtol etc to convert this string, so don't try.
3247 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3250 /* value has been set. It may not be precise. */
3251 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3252 /* 2s complement assumption for (UV)IV_MIN */
3253 SvNOK_on(sv); /* Integer is too negative. */
3258 if (numtype & IS_NUMBER_NEG) {
3259 SvIVX(sv) = -(IV)value;
3260 } else if (value <= (UV)IV_MAX) {
3261 SvIVX(sv) = (IV)value;
3267 if (numtype & IS_NUMBER_NOT_INT) {
3268 /* I believe that even if the original PV had decimals,
3269 they are lost beyond the limit of the FP precision.
3270 However, neither is canonical, so both only get p
3271 flags. NWC, 2000/11/25 */
3272 /* Both already have p flags, so do nothing */
3275 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3276 if (SvIVX(sv) == I_V(nv)) {
3281 /* It had no "." so it must be integer. */
3284 /* between IV_MAX and NV(UV_MAX).
3285 Could be slightly > UV_MAX */
3287 if (numtype & IS_NUMBER_NOT_INT) {
3288 /* UV and NV both imprecise. */
3290 UV nv_as_uv = U_V(nv);
3292 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3303 #endif /* NV_PRESERVES_UV */
3306 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3308 if (SvTYPE(sv) < SVt_NV)
3309 /* Typically the caller expects that sv_any is not NULL now. */
3310 /* XXX Ilya implies that this is a bug in callers that assume this
3311 and ideally should be fixed. */
3312 sv_upgrade(sv, SVt_NV);
3315 #if defined(USE_LONG_DOUBLE)
3317 STORE_NUMERIC_LOCAL_SET_STANDARD();
3318 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3319 PTR2UV(sv), SvNVX(sv));
3320 RESTORE_NUMERIC_LOCAL();
3324 STORE_NUMERIC_LOCAL_SET_STANDARD();
3325 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3326 PTR2UV(sv), SvNVX(sv));
3327 RESTORE_NUMERIC_LOCAL();
3333 /* asIV(): extract an integer from the string value of an SV.
3334 * Caller must validate PVX */
3337 S_asIV(pTHX_ SV *sv)
3340 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3342 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3343 == IS_NUMBER_IN_UV) {
3344 /* It's definitely an integer */
3345 if (numtype & IS_NUMBER_NEG) {
3346 if (value < (UV)IV_MIN)
3349 if (value < (UV)IV_MAX)
3354 if (ckWARN(WARN_NUMERIC))
3357 return I_V(Atof(SvPVX(sv)));
3360 /* asUV(): extract an unsigned integer from the string value of an SV
3361 * Caller must validate PVX */
3364 S_asUV(pTHX_ SV *sv)
3367 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3369 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3370 == IS_NUMBER_IN_UV) {
3371 /* It's definitely an integer */
3372 if (!(numtype & IS_NUMBER_NEG))
3376 if (ckWARN(WARN_NUMERIC))
3379 return U_V(Atof(SvPVX(sv)));
3383 =for apidoc sv_2pv_nolen
3385 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3386 use the macro wrapper C<SvPV_nolen(sv)> instead.
3391 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3394 return sv_2pv(sv, &n_a);
3397 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3398 * UV as a string towards the end of buf, and return pointers to start and
3401 * We assume that buf is at least TYPE_CHARS(UV) long.
3405 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3407 char *ptr = buf + TYPE_CHARS(UV);
3421 *--ptr = '0' + (char)(uv % 10);
3429 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3430 * this function provided for binary compatibility only
3434 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3436 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3440 =for apidoc sv_2pv_flags
3442 Returns a pointer to the string value of an SV, and sets *lp to its length.
3443 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3445 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3446 usually end up here too.
3452 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3457 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3458 char *tmpbuf = tbuf;
3464 if (SvGMAGICAL(sv)) {
3465 if (flags & SV_GMAGIC)
3473 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3475 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3480 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3485 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3486 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3493 if (SvTHINKFIRST(sv)) {
3496 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3497 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3498 char *pv = SvPV(tmpstr, *lp);
3512 switch (SvTYPE(sv)) {
3514 if ( ((SvFLAGS(sv) &
3515 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3516 == (SVs_OBJECT|SVs_SMG))
3517 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3518 regexp *re = (regexp *)mg->mg_obj;
3521 char *fptr = "msix";
3526 char need_newline = 0;
3527 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3529 while((ch = *fptr++)) {
3531 reflags[left++] = ch;
3534 reflags[right--] = ch;
3539 reflags[left] = '-';
3543 mg->mg_len = re->prelen + 4 + left;
3545 * If /x was used, we have to worry about a regex
3546 * ending with a comment later being embedded
3547 * within another regex. If so, we don't want this
3548 * regex's "commentization" to leak out to the
3549 * right part of the enclosing regex, we must cap
3550 * it with a newline.
3552 * So, if /x was used, we scan backwards from the
3553 * end of the regex. If we find a '#' before we
3554 * find a newline, we need to add a newline
3555 * ourself. If we find a '\n' first (or if we
3556 * don't find '#' or '\n'), we don't need to add
3557 * anything. -jfriedl
3559 if (PMf_EXTENDED & re->reganch)
3561 char *endptr = re->precomp + re->prelen;
3562 while (endptr >= re->precomp)
3564 char c = *(endptr--);
3566 break; /* don't need another */
3568 /* we end while in a comment, so we
3570 mg->mg_len++; /* save space for it */
3571 need_newline = 1; /* note to add it */
3577 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3578 Copy("(?", mg->mg_ptr, 2, char);
3579 Copy(reflags, mg->mg_ptr+2, left, char);
3580 Copy(":", mg->mg_ptr+left+2, 1, char);
3581 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3583 mg->mg_ptr[mg->mg_len - 2] = '\n';
3584 mg->mg_ptr[mg->mg_len - 1] = ')';
3585 mg->mg_ptr[mg->mg_len] = 0;
3587 PL_reginterp_cnt += re->program[0].next_off;
3589 if (re->reganch & ROPT_UTF8)
3604 case SVt_PVBM: if (SvROK(sv))
3607 s = "SCALAR"; break;
3608 case SVt_PVLV: s = SvROK(sv) ? "REF"
3609 /* tied lvalues should appear to be
3610 * scalars for backwards compatitbility */
3611 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3612 ? "SCALAR" : "LVALUE"; break;
3613 case SVt_PVAV: s = "ARRAY"; break;
3614 case SVt_PVHV: s = "HASH"; break;
3615 case SVt_PVCV: s = "CODE"; break;
3616 case SVt_PVGV: s = "GLOB"; break;
3617 case SVt_PVFM: s = "FORMAT"; break;
3618 case SVt_PVIO: s = "IO"; break;
3619 default: s = "UNKNOWN"; break;
3623 if (HvNAME(SvSTASH(sv)))
3624 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3626 Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3629 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3635 if (SvREADONLY(sv) && !SvOK(sv)) {
3636 if (ckWARN(WARN_UNINITIALIZED))
3642 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3643 /* I'm assuming that if both IV and NV are equally valid then
3644 converting the IV is going to be more efficient */
3645 U32 isIOK = SvIOK(sv);
3646 U32 isUIOK = SvIsUV(sv);
3647 char buf[TYPE_CHARS(UV)];
3650 if (SvTYPE(sv) < SVt_PVIV)
3651 sv_upgrade(sv, SVt_PVIV);
3653 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3655 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3656 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3657 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3658 SvCUR_set(sv, ebuf - ptr);
3668 else if (SvNOKp(sv)) {
3669 if (SvTYPE(sv) < SVt_PVNV)
3670 sv_upgrade(sv, SVt_PVNV);
3671 /* The +20 is pure guesswork. Configure test needed. --jhi */
3672 SvGROW(sv, NV_DIG + 20);
3674 olderrno = errno; /* some Xenix systems wipe out errno here */
3676 if (SvNVX(sv) == 0.0)
3677 (void)strcpy(s,"0");
3681 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3684 #ifdef FIXNEGATIVEZERO
3685 if (*s == '-' && s[1] == '0' && !s[2])
3695 if (ckWARN(WARN_UNINITIALIZED)
3696 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3699 if (SvTYPE(sv) < SVt_PV)
3700 /* Typically the caller expects that sv_any is not NULL now. */
3701 sv_upgrade(sv, SVt_PV);
3704 *lp = s - SvPVX(sv);
3707 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3708 PTR2UV(sv),SvPVX(sv)));
3712 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3713 /* Sneaky stuff here */
3717 tsv = newSVpv(tmpbuf, 0);
3733 len = strlen(tmpbuf);
3735 #ifdef FIXNEGATIVEZERO
3736 if (len == 2 && t[0] == '-' && t[1] == '0') {
3741 (void)SvUPGRADE(sv, SVt_PV);
3743 s = SvGROW(sv, len + 1);
3752 =for apidoc sv_copypv
3754 Copies a stringified representation of the source SV into the
3755 destination SV. Automatically performs any necessary mg_get and
3756 coercion of numeric values into strings. Guaranteed to preserve
3757 UTF-8 flag even from overloaded objects. Similar in nature to
3758 sv_2pv[_flags] but operates directly on an SV instead of just the
3759 string. Mostly uses sv_2pv_flags to do its work, except when that
3760 would lose the UTF-8'ness of the PV.
3766 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3771 sv_setpvn(dsv,s,len);
3779 =for apidoc sv_2pvbyte_nolen
3781 Return a pointer to the byte-encoded representation of the SV.
3782 May cause the SV to be downgraded from UTF-8 as a side-effect.
3784 Usually accessed via the C<SvPVbyte_nolen> macro.
3790 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3793 return sv_2pvbyte(sv, &n_a);
3797 =for apidoc sv_2pvbyte
3799 Return a pointer to the byte-encoded representation of the SV, and set *lp
3800 to its length. May cause the SV to be downgraded from UTF-8 as a
3803 Usually accessed via the C<SvPVbyte> macro.
3809 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3811 sv_utf8_downgrade(sv,0);
3812 return SvPV(sv,*lp);
3816 =for apidoc sv_2pvutf8_nolen
3818 Return a pointer to the UTF-8-encoded representation of the SV.
3819 May cause the SV to be upgraded to UTF-8 as a side-effect.
3821 Usually accessed via the C<SvPVutf8_nolen> macro.
3827 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3830 return sv_2pvutf8(sv, &n_a);
3834 =for apidoc sv_2pvutf8
3836 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3837 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3839 Usually accessed via the C<SvPVutf8> macro.
3845 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3847 sv_utf8_upgrade(sv);
3848 return SvPV(sv,*lp);
3852 =for apidoc sv_2bool
3854 This function is only called on magical items, and is only used by
3855 sv_true() or its macro equivalent.
3861 Perl_sv_2bool(pTHX_ register SV *sv)
3870 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3871 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3872 return (bool)SvTRUE(tmpsv);
3873 return SvRV(sv) != 0;
3876 register XPV* Xpvtmp;
3877 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3878 (*Xpvtmp->xpv_pv > '0' ||
3879 Xpvtmp->xpv_cur > 1 ||
3880 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3887 return SvIVX(sv) != 0;
3890 return SvNVX(sv) != 0.0;
3897 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3898 * this function provided for binary compatibility only
3903 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3905 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3909 =for apidoc sv_utf8_upgrade
3911 Converts the PV of an SV to its UTF-8-encoded form.
3912 Forces the SV to string form if it is not already.
3913 Always sets the SvUTF8 flag to avoid future validity checks even
3914 if all the bytes have hibit clear.
3916 This is not as a general purpose byte encoding to Unicode interface:
3917 use the Encode extension for that.
3919 =for apidoc sv_utf8_upgrade_flags
3921 Converts the PV of an SV to its UTF-8-encoded form.
3922 Forces the SV to string form if it is not already.
3923 Always sets the SvUTF8 flag to avoid future validity checks even
3924 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3925 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3926 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3928 This is not as a general purpose byte encoding to Unicode interface:
3929 use the Encode extension for that.
3935 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3940 if (sv == &PL_sv_undef)
3944 (void) SvPV_force(sv,len);
3953 sv_force_normal_flags(sv, 0);
3956 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3957 sv_recode_to_utf8(sv, PL_encoding);
3958 else { /* Assume Latin-1/EBCDIC */
3959 /* This function could be much more efficient if we
3960 * had a FLAG in SVs to signal if there are any hibit
3961 * chars in the PV. Given that there isn't such a flag
3962 * make the loop as fast as possible. */
3963 s = (U8 *) SvPVX(sv);
3964 e = (U8 *) SvEND(sv);
3968 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3973 (void)SvOOK_off(sv);
3975 len = SvCUR(sv) + 1; /* Plus the \0 */
3976 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3977 SvCUR(sv) = len - 1;
3979 Safefree(s); /* No longer using what was there before. */
3980 SvLEN(sv) = len; /* No longer know the real size. */
3982 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3990 =for apidoc sv_utf8_downgrade
3992 Attempts to convert the PV of an SV from characters to bytes.
3993 If the PV contains a character beyond byte, this conversion will fail;
3994 in this case, either returns false or, if C<fail_ok> is not
3997 This is not as a general purpose Unicode to byte encoding interface:
3998 use the Encode extension for that.
4004 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4006 if (SvPOKp(sv) && SvUTF8(sv)) {
4012 sv_force_normal_flags(sv, 0);
4014 s = (U8 *) SvPV(sv, len);
4015 if (!utf8_to_bytes(s, &len)) {
4020 Perl_croak(aTHX_ "Wide character in %s",
4023 Perl_croak(aTHX_ "Wide character");
4034 =for apidoc sv_utf8_encode
4036 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4037 flag off so that it looks like octets again.
4043 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4045 (void) sv_utf8_upgrade(sv);
4047 sv_force_normal_flags(sv, 0);
4049 if (SvREADONLY(sv)) {
4050 Perl_croak(aTHX_ PL_no_modify);
4056 =for apidoc sv_utf8_decode
4058 If the PV of the SV is an octet sequence in UTF-8
4059 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4060 so that it looks like a character. If the PV contains only single-byte
4061 characters, the C<SvUTF8> flag stays being off.
4062 Scans PV for validity and returns false if the PV is invalid UTF-8.
4068 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4074 /* The octets may have got themselves encoded - get them back as
4077 if (!sv_utf8_downgrade(sv, TRUE))
4080 /* it is actually just a matter of turning the utf8 flag on, but
4081 * we want to make sure everything inside is valid utf8 first.
4083 c = (U8 *) SvPVX(sv);
4084 if (!is_utf8_string(c, SvCUR(sv)+1))
4086 e = (U8 *) SvEND(sv);
4089 if (!UTF8_IS_INVARIANT(ch)) {
4098 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4099 * this function provided for binary compatibility only
4103 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4105 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4109 =for apidoc sv_setsv
4111 Copies the contents of the source SV C<ssv> into the destination SV
4112 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4113 function if the source SV needs to be reused. Does not handle 'set' magic.
4114 Loosely speaking, it performs a copy-by-value, obliterating any previous
4115 content of the destination.
4117 You probably want to use one of the assortment of wrappers, such as
4118 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4119 C<SvSetMagicSV_nosteal>.
4121 =for apidoc sv_setsv_flags
4123 Copies the contents of the source SV C<ssv> into the destination SV
4124 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4125 function if the source SV needs to be reused. Does not handle 'set' magic.
4126 Loosely speaking, it performs a copy-by-value, obliterating any previous
4127 content of the destination.
4128 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4129 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4130 implemented in terms of this function.
4132 You probably want to use one of the assortment of wrappers, such as
4133 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4134 C<SvSetMagicSV_nosteal>.
4136 This is the primary function for copying scalars, and most other
4137 copy-ish functions and macros use this underneath.
4143 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4145 register U32 sflags;
4151 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4153 sstr = &PL_sv_undef;
4154 stype = SvTYPE(sstr);
4155 dtype = SvTYPE(dstr);
4160 /* need to nuke the magic */
4162 SvRMAGICAL_off(dstr);
4165 /* There's a lot of redundancy below but we're going for speed here */
4170 if (dtype != SVt_PVGV) {
4171 (void)SvOK_off(dstr);
4179 sv_upgrade(dstr, SVt_IV);
4182 sv_upgrade(dstr, SVt_PVNV);
4186 sv_upgrade(dstr, SVt_PVIV);
4189 (void)SvIOK_only(dstr);
4190 SvIVX(dstr) = SvIVX(sstr);
4193 if (SvTAINTED(sstr))
4204 sv_upgrade(dstr, SVt_NV);
4209 sv_upgrade(dstr, SVt_PVNV);
4212 SvNVX(dstr) = SvNVX(sstr);
4213 (void)SvNOK_only(dstr);
4214 if (SvTAINTED(sstr))
4222 sv_upgrade(dstr, SVt_RV);
4223 else if (dtype == SVt_PVGV &&
4224 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4227 if (GvIMPORTED(dstr) != GVf_IMPORTED
4228 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4230 GvIMPORTED_on(dstr);
4239 #ifdef PERL_COPY_ON_WRITE
4240 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4241 if (dtype < SVt_PVIV)
4242 sv_upgrade(dstr, SVt_PVIV);
4249 sv_upgrade(dstr, SVt_PV);
4252 if (dtype < SVt_PVIV)
4253 sv_upgrade(dstr, SVt_PVIV);
4256 if (dtype < SVt_PVNV)
4257 sv_upgrade(dstr, SVt_PVNV);
4264 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4267 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4271 if (dtype <= SVt_PVGV) {
4273 if (dtype != SVt_PVGV) {
4274 char *name = GvNAME(sstr);
4275 STRLEN len = GvNAMELEN(sstr);
4276 /* don't upgrade SVt_PVLV: it can hold a glob */
4277 if (dtype != SVt_PVLV)
4278 sv_upgrade(dstr, SVt_PVGV);
4279 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4280 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4281 GvNAME(dstr) = savepvn(name, len);
4282 GvNAMELEN(dstr) = len;
4283 SvFAKE_on(dstr); /* can coerce to non-glob */
4285 /* ahem, death to those who redefine active sort subs */
4286 else if (PL_curstackinfo->si_type == PERLSI_SORT
4287 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4288 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4291 #ifdef GV_UNIQUE_CHECK
4292 if (GvUNIQUE((GV*)dstr)) {
4293 Perl_croak(aTHX_ PL_no_modify);
4297 (void)SvOK_off(dstr);
4298 GvINTRO_off(dstr); /* one-shot flag */
4300 GvGP(dstr) = gp_ref(GvGP(sstr));
4301 if (SvTAINTED(sstr))
4303 if (GvIMPORTED(dstr) != GVf_IMPORTED
4304 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4306 GvIMPORTED_on(dstr);
4314 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4316 if ((int)SvTYPE(sstr) != stype) {
4317 stype = SvTYPE(sstr);
4318 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4322 if (stype == SVt_PVLV)
4323 (void)SvUPGRADE(dstr, SVt_PVNV);
4325 (void)SvUPGRADE(dstr, (U32)stype);
4328 sflags = SvFLAGS(sstr);
4330 if (sflags & SVf_ROK) {
4331 if (dtype >= SVt_PV) {
4332 if (dtype == SVt_PVGV) {
4333 SV *sref = SvREFCNT_inc(SvRV(sstr));
4335 int intro = GvINTRO(dstr);
4337 #ifdef GV_UNIQUE_CHECK
4338 if (GvUNIQUE((GV*)dstr)) {
4339 Perl_croak(aTHX_ PL_no_modify);
4344 GvINTRO_off(dstr); /* one-shot flag */
4345 GvLINE(dstr) = CopLINE(PL_curcop);
4346 GvEGV(dstr) = (GV*)dstr;
4349 switch (SvTYPE(sref)) {
4352 SAVEGENERICSV(GvAV(dstr));
4354 dref = (SV*)GvAV(dstr);
4355 GvAV(dstr) = (AV*)sref;
4356 if (!GvIMPORTED_AV(dstr)
4357 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4359 GvIMPORTED_AV_on(dstr);
4364 SAVEGENERICSV(GvHV(dstr));
4366 dref = (SV*)GvHV(dstr);
4367 GvHV(dstr) = (HV*)sref;
4368 if (!GvIMPORTED_HV(dstr)
4369 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4371 GvIMPORTED_HV_on(dstr);
4376 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4377 SvREFCNT_dec(GvCV(dstr));
4378 GvCV(dstr) = Nullcv;
4379 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4380 PL_sub_generation++;
4382 SAVEGENERICSV(GvCV(dstr));
4385 dref = (SV*)GvCV(dstr);
4386 if (GvCV(dstr) != (CV*)sref) {
4387 CV* cv = GvCV(dstr);
4389 if (!GvCVGEN((GV*)dstr) &&
4390 (CvROOT(cv) || CvXSUB(cv)))
4392 /* ahem, death to those who redefine
4393 * active sort subs */
4394 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4395 PL_sortcop == CvSTART(cv))
4397 "Can't redefine active sort subroutine %s",
4398 GvENAME((GV*)dstr));
4399 /* Redefining a sub - warning is mandatory if
4400 it was a const and its value changed. */
4401 if (ckWARN(WARN_REDEFINE)
4403 && (!CvCONST((CV*)sref)
4404 || sv_cmp(cv_const_sv(cv),
4405 cv_const_sv((CV*)sref)))))
4407 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4409 ? "Constant subroutine %s::%s redefined"
4410 : "Subroutine %s::%s redefined",
4411 HvNAME(GvSTASH((GV*)dstr)),
4412 GvENAME((GV*)dstr));
4416 cv_ckproto(cv, (GV*)dstr,
4417 SvPOK(sref) ? SvPVX(sref) : Nullch);
4419 GvCV(dstr) = (CV*)sref;
4420 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4421 GvASSUMECV_on(dstr);
4422 PL_sub_generation++;
4424 if (!GvIMPORTED_CV(dstr)
4425 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4427 GvIMPORTED_CV_on(dstr);
4432 SAVEGENERICSV(GvIOp(dstr));
4434 dref = (SV*)GvIOp(dstr);
4435 GvIOp(dstr) = (IO*)sref;
4439 SAVEGENERICSV(GvFORM(dstr));
4441 dref = (SV*)GvFORM(dstr);
4442 GvFORM(dstr) = (CV*)sref;
4446 SAVEGENERICSV(GvSV(dstr));
4448 dref = (SV*)GvSV(dstr);
4450 if (!GvIMPORTED_SV(dstr)
4451 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4453 GvIMPORTED_SV_on(dstr);
4459 if (SvTAINTED(sstr))
4464 (void)SvOOK_off(dstr); /* backoff */
4466 Safefree(SvPVX(dstr));
4467 SvLEN(dstr)=SvCUR(dstr)=0;
4470 (void)SvOK_off(dstr);
4471 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4473 if (sflags & SVp_NOK) {
4475 /* Only set the public OK flag if the source has public OK. */
4476 if (sflags & SVf_NOK)
4477 SvFLAGS(dstr) |= SVf_NOK;
4478 SvNVX(dstr) = SvNVX(sstr);
4480 if (sflags & SVp_IOK) {
4481 (void)SvIOKp_on(dstr);
4482 if (sflags & SVf_IOK)
4483 SvFLAGS(dstr) |= SVf_IOK;
4484 if (sflags & SVf_IVisUV)
4486 SvIVX(dstr) = SvIVX(sstr);
4488 if (SvAMAGIC(sstr)) {
4492 else if (sflags & SVp_POK) {
4496 * Check to see if we can just swipe the string. If so, it's a
4497 * possible small lose on short strings, but a big win on long ones.
4498 * It might even be a win on short strings if SvPVX(dstr)
4499 * has to be allocated and SvPVX(sstr) has to be freed.
4502 /* Whichever path we take through the next code, we want this true,
4503 and doing it now facilitates the COW check. */
4504 (void)SvPOK_only(dstr);
4507 #ifdef PERL_COPY_ON_WRITE
4508 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4512 (sflags & SVs_TEMP) && /* slated for free anyway? */
4513 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4514 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4515 SvLEN(sstr) && /* and really is a string */
4516 /* and won't be needed again, potentially */
4517 !(PL_op && PL_op->op_type == OP_AASSIGN))
4518 #ifdef PERL_COPY_ON_WRITE
4519 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4520 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4521 && SvTYPE(sstr) >= SVt_PVIV)
4524 /* Failed the swipe test, and it's not a shared hash key either.
4525 Have to copy the string. */
4526 STRLEN len = SvCUR(sstr);
4527 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4528 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4529 SvCUR_set(dstr, len);
4530 *SvEND(dstr) = '\0';
4532 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4534 #ifdef PERL_COPY_ON_WRITE
4535 /* Either it's a shared hash key, or it's suitable for
4536 copy-on-write or we can swipe the string. */
4538 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4543 /* I believe I should acquire a global SV mutex if
4544 it's a COW sv (not a shared hash key) to stop
4545 it going un copy-on-write.
4546 If the source SV has gone un copy on write between up there
4547 and down here, then (assert() that) it is of the correct
4548 form to make it copy on write again */
4549 if ((sflags & (SVf_FAKE | SVf_READONLY))
4550 != (SVf_FAKE | SVf_READONLY)) {
4551 SvREADONLY_on(sstr);
4553 /* Make the source SV into a loop of 1.
4554 (about to become 2) */
4555 SV_COW_NEXT_SV_SET(sstr, sstr);
4559 /* Initial code is common. */
4560 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4562 SvFLAGS(dstr) &= ~SVf_OOK;
4563 Safefree(SvPVX(dstr) - SvIVX(dstr));
4565 else if (SvLEN(dstr))
4566 Safefree(SvPVX(dstr));
4569 #ifdef PERL_COPY_ON_WRITE
4571 /* making another shared SV. */
4572 STRLEN cur = SvCUR(sstr);
4573 STRLEN len = SvLEN(sstr);
4574 assert (SvTYPE(dstr) >= SVt_PVIV);
4576 /* SvIsCOW_normal */
4577 /* splice us in between source and next-after-source. */
4578 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4579 SV_COW_NEXT_SV_SET(sstr, dstr);
4580 SvPV_set(dstr, SvPVX(sstr));
4582 /* SvIsCOW_shared_hash */
4583 UV hash = SvUVX(sstr);
4584 DEBUG_C(PerlIO_printf(Perl_debug_log,
4585 "Copy on write: Sharing hash\n"));
4587 sharepvn(SvPVX(sstr),
4588 (sflags & SVf_UTF8?-cur:cur), hash));
4593 SvREADONLY_on(dstr);
4595 /* Relesase a global SV mutex. */
4599 { /* Passes the swipe test. */
4600 SvPV_set(dstr, SvPVX(sstr));
4601 SvLEN_set(dstr, SvLEN(sstr));
4602 SvCUR_set(dstr, SvCUR(sstr));
4605 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4606 SvPV_set(sstr, Nullch);
4612 if (sflags & SVf_UTF8)
4615 if (sflags & SVp_NOK) {
4617 if (sflags & SVf_NOK)
4618 SvFLAGS(dstr) |= SVf_NOK;
4619 SvNVX(dstr) = SvNVX(sstr);
4621 if (sflags & SVp_IOK) {
4622 (void)SvIOKp_on(dstr);
4623 if (sflags & SVf_IOK)
4624 SvFLAGS(dstr) |= SVf_IOK;
4625 if (sflags & SVf_IVisUV)
4627 SvIVX(dstr) = SvIVX(sstr);
4630 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4631 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4632 smg->mg_ptr, smg->mg_len);
4633 SvRMAGICAL_on(dstr);
4636 else if (sflags & SVp_IOK) {
4637 if (sflags & SVf_IOK)
4638 (void)SvIOK_only(dstr);
4640 (void)SvOK_off(dstr);
4641 (void)SvIOKp_on(dstr);
4643 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4644 if (sflags & SVf_IVisUV)
4646 SvIVX(dstr) = SvIVX(sstr);
4647 if (sflags & SVp_NOK) {
4648 if (sflags & SVf_NOK)
4649 (void)SvNOK_on(dstr);
4651 (void)SvNOKp_on(dstr);
4652 SvNVX(dstr) = SvNVX(sstr);
4655 else if (sflags & SVp_NOK) {
4656 if (sflags & SVf_NOK)
4657 (void)SvNOK_only(dstr);
4659 (void)SvOK_off(dstr);
4662 SvNVX(dstr) = SvNVX(sstr);
4665 if (dtype == SVt_PVGV) {
4666 if (ckWARN(WARN_MISC))
4667 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4670 (void)SvOK_off(dstr);
4672 if (SvTAINTED(sstr))
4677 =for apidoc sv_setsv_mg
4679 Like C<sv_setsv>, but also handles 'set' magic.
4685 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4687 sv_setsv(dstr,sstr);
4691 #ifdef PERL_COPY_ON_WRITE
4693 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4695 STRLEN cur = SvCUR(sstr);
4696 STRLEN len = SvLEN(sstr);
4697 register char *new_pv;
4700 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4708 if (SvTHINKFIRST(dstr))
4709 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4710 else if (SvPVX(dstr))
4711 Safefree(SvPVX(dstr));
4715 (void)SvUPGRADE (dstr, SVt_PVIV);
4717 assert (SvPOK(sstr));
4718 assert (SvPOKp(sstr));
4719 assert (!SvIOK(sstr));
4720 assert (!SvIOKp(sstr));
4721 assert (!SvNOK(sstr));
4722 assert (!SvNOKp(sstr));
4724 if (SvIsCOW(sstr)) {
4726 if (SvLEN(sstr) == 0) {
4727 /* source is a COW shared hash key. */
4728 UV hash = SvUVX(sstr);
4729 DEBUG_C(PerlIO_printf(Perl_debug_log,
4730 "Fast copy on write: Sharing hash\n"));
4732 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4735 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4737 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4738 (void)SvUPGRADE (sstr, SVt_PVIV);
4739 SvREADONLY_on(sstr);
4741 DEBUG_C(PerlIO_printf(Perl_debug_log,
4742 "Fast copy on write: Converting sstr to COW\n"));
4743 SV_COW_NEXT_SV_SET(dstr, sstr);
4745 SV_COW_NEXT_SV_SET(sstr, dstr);
4746 new_pv = SvPVX(sstr);
4749 SvPV_set(dstr, new_pv);
4750 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4763 =for apidoc sv_setpvn
4765 Copies a string into an SV. The C<len> parameter indicates the number of
4766 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4767 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4773 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4775 register char *dptr;
4777 SV_CHECK_THINKFIRST_COW_DROP(sv);
4783 /* len is STRLEN which is unsigned, need to copy to signed */
4786 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4788 (void)SvUPGRADE(sv, SVt_PV);
4790 SvGROW(sv, len + 1);
4792 Move(ptr,dptr,len,char);
4795 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4800 =for apidoc sv_setpvn_mg
4802 Like C<sv_setpvn>, but also handles 'set' magic.
4808 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4810 sv_setpvn(sv,ptr,len);
4815 =for apidoc sv_setpv
4817 Copies a string into an SV. The string must be null-terminated. Does not
4818 handle 'set' magic. See C<sv_setpv_mg>.
4824 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4826 register STRLEN len;
4828 SV_CHECK_THINKFIRST_COW_DROP(sv);
4834 (void)SvUPGRADE(sv, SVt_PV);
4836 SvGROW(sv, len + 1);
4837 Move(ptr,SvPVX(sv),len+1,char);
4839 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4844 =for apidoc sv_setpv_mg
4846 Like C<sv_setpv>, but also handles 'set' magic.
4852 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4859 =for apidoc sv_usepvn
4861 Tells an SV to use C<ptr> to find its string value. Normally the string is
4862 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4863 The C<ptr> should point to memory that was allocated by C<malloc>. The
4864 string length, C<len>, must be supplied. This function will realloc the
4865 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4866 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4867 See C<sv_usepvn_mg>.
4873 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4875 SV_CHECK_THINKFIRST_COW_DROP(sv);
4876 (void)SvUPGRADE(sv, SVt_PV);
4881 (void)SvOOK_off(sv);
4882 if (SvPVX(sv) && SvLEN(sv))
4883 Safefree(SvPVX(sv));
4884 Renew(ptr, len+1, char);
4887 SvLEN_set(sv, len+1);
4889 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4894 =for apidoc sv_usepvn_mg
4896 Like C<sv_usepvn>, but also handles 'set' magic.
4902 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4904 sv_usepvn(sv,ptr,len);
4908 #ifdef PERL_COPY_ON_WRITE
4909 /* Need to do this *after* making the SV normal, as we need the buffer
4910 pointer to remain valid until after we've copied it. If we let go too early,
4911 another thread could invalidate it by unsharing last of the same hash key
4912 (which it can do by means other than releasing copy-on-write Svs)
4913 or by changing the other copy-on-write SVs in the loop. */
4915 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4916 U32 hash, SV *after)
4918 if (len) { /* this SV was SvIsCOW_normal(sv) */
4919 /* we need to find the SV pointing to us. */
4920 SV *current = SV_COW_NEXT_SV(after);
4922 if (current == sv) {
4923 /* The SV we point to points back to us (there were only two of us
4925 Hence other SV is no longer copy on write either. */
4927 SvREADONLY_off(after);
4929 /* We need to follow the pointers around the loop. */
4931 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4934 /* don't loop forever if the structure is bust, and we have
4935 a pointer into a closed loop. */
4936 assert (current != after);
4937 assert (SvPVX(current) == pvx);
4939 /* Make the SV before us point to the SV after us. */
4940 SV_COW_NEXT_SV_SET(current, after);
4943 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4948 Perl_sv_release_IVX(pTHX_ register SV *sv)
4951 sv_force_normal_flags(sv, 0);
4952 return SvOOK_off(sv);
4956 =for apidoc sv_force_normal_flags
4958 Undo various types of fakery on an SV: if the PV is a shared string, make
4959 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4960 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4961 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4962 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4963 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4964 set to some other value.) In addition, the C<flags> parameter gets passed to
4965 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4966 with flags set to 0.
4972 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4974 #ifdef PERL_COPY_ON_WRITE
4975 if (SvREADONLY(sv)) {
4976 /* At this point I believe I should acquire a global SV mutex. */
4978 char *pvx = SvPVX(sv);
4979 STRLEN len = SvLEN(sv);
4980 STRLEN cur = SvCUR(sv);
4981 U32 hash = SvUVX(sv);
4982 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4984 PerlIO_printf(Perl_debug_log,
4985 "Copy on write: Force normal %ld\n",
4991 /* This SV doesn't own the buffer, so need to New() a new one: */
4994 if (flags & SV_COW_DROP_PV) {
4995 /* OK, so we don't need to copy our buffer. */
4998 SvGROW(sv, cur + 1);
4999 Move(pvx,SvPVX(sv),cur,char);
5003 sv_release_COW(sv, pvx, cur, len, hash, next);
5008 else if (IN_PERL_RUNTIME)
5009 Perl_croak(aTHX_ PL_no_modify);
5010 /* At this point I believe that I can drop the global SV mutex. */
5013 if (SvREADONLY(sv)) {
5015 char *pvx = SvPVX(sv);
5016 int is_utf8 = SvUTF8(sv);
5017 STRLEN len = SvCUR(sv);
5018 U32 hash = SvUVX(sv);
5023 SvGROW(sv, len + 1);
5024 Move(pvx,SvPVX(sv),len,char);
5026 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5028 else if (IN_PERL_RUNTIME)
5029 Perl_croak(aTHX_ PL_no_modify);
5033 sv_unref_flags(sv, flags);
5034 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5039 =for apidoc sv_force_normal
5041 Undo various types of fakery on an SV: if the PV is a shared string, make
5042 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5043 an xpvmg. See also C<sv_force_normal_flags>.
5049 Perl_sv_force_normal(pTHX_ register SV *sv)
5051 sv_force_normal_flags(sv, 0);
5057 Efficient removal of characters from the beginning of the string buffer.
5058 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5059 the string buffer. The C<ptr> becomes the first character of the adjusted
5060 string. Uses the "OOK hack".
5061 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5062 refer to the same chunk of data.
5068 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5070 register STRLEN delta;
5071 if (!ptr || !SvPOKp(sv))
5073 delta = ptr - SvPVX(sv);
5074 SV_CHECK_THINKFIRST(sv);
5075 if (SvTYPE(sv) < SVt_PVIV)
5076 sv_upgrade(sv,SVt_PVIV);
5079 if (!SvLEN(sv)) { /* make copy of shared string */
5080 char *pvx = SvPVX(sv);
5081 STRLEN len = SvCUR(sv);
5082 SvGROW(sv, len + 1);
5083 Move(pvx,SvPVX(sv),len,char);
5087 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5088 and we do that anyway inside the SvNIOK_off
5090 SvFLAGS(sv) |= SVf_OOK;
5099 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5100 * this function provided for binary compatibility only
5104 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5106 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5110 =for apidoc sv_catpvn
5112 Concatenates the string onto the end of the string which is in the SV. The
5113 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5114 status set, then the bytes appended should be valid UTF-8.
5115 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5117 =for apidoc sv_catpvn_flags
5119 Concatenates the string onto the end of the string which is in the SV. The
5120 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5121 status set, then the bytes appended should be valid UTF-8.
5122 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5123 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5124 in terms of this function.
5130 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5135 dstr = SvPV_force_flags(dsv, dlen, flags);
5136 SvGROW(dsv, dlen + slen + 1);
5139 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5142 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5147 =for apidoc sv_catpvn_mg
5149 Like C<sv_catpvn>, but also handles 'set' magic.
5155 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5157 sv_catpvn(sv,ptr,len);
5161 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5162 * this function provided for binary compatibility only
5166 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5168 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5172 =for apidoc sv_catsv
5174 Concatenates the string from SV C<ssv> onto the end of the string in
5175 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5176 not 'set' magic. See C<sv_catsv_mg>.
5178 =for apidoc sv_catsv_flags
5180 Concatenates the string from SV C<ssv> onto the end of the string in
5181 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5182 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5183 and C<sv_catsv_nomg> are implemented in terms of this function.
5188 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5194 if ((spv = SvPV(ssv, slen))) {
5195 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5196 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5197 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5198 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5199 dsv->sv_flags doesn't have that bit set.
5200 Andy Dougherty 12 Oct 2001
5202 I32 sutf8 = DO_UTF8(ssv);
5205 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5207 dutf8 = DO_UTF8(dsv);
5209 if (dutf8 != sutf8) {
5211 /* Not modifying source SV, so taking a temporary copy. */
5212 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5214 sv_utf8_upgrade(csv);
5215 spv = SvPV(csv, slen);
5218 sv_utf8_upgrade_nomg(dsv);
5220 sv_catpvn_nomg(dsv, spv, slen);
5225 =for apidoc sv_catsv_mg
5227 Like C<sv_catsv>, but also handles 'set' magic.
5233 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5240 =for apidoc sv_catpv
5242 Concatenates the string onto the end of the string which is in the SV.
5243 If the SV has the UTF-8 status set, then the bytes appended should be
5244 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5249 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5251 register STRLEN len;
5257 junk = SvPV_force(sv, tlen);
5259 SvGROW(sv, tlen + len + 1);
5262 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5264 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5269 =for apidoc sv_catpv_mg
5271 Like C<sv_catpv>, but also handles 'set' magic.
5277 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5286 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5287 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5294 Perl_newSV(pTHX_ STRLEN len)
5300 sv_upgrade(sv, SVt_PV);
5301 SvGROW(sv, len + 1);
5306 =for apidoc sv_magicext
5308 Adds magic to an SV, upgrading it if necessary. Applies the
5309 supplied vtable and returns pointer to the magic added.
5311 Note that sv_magicext will allow things that sv_magic will not.
5312 In particular you can add magic to SvREADONLY SVs and and more than
5313 one instance of the same 'how'
5315 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
5316 if C<namelen> is zero then C<name> is stored as-is and - as another special
5317 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
5318 an C<SV*> and has its REFCNT incremented
5320 (This is now used as a subroutine by sv_magic.)
5325 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5326 const char* name, I32 namlen)
5330 if (SvTYPE(sv) < SVt_PVMG) {
5331 (void)SvUPGRADE(sv, SVt_PVMG);
5333 Newz(702,mg, 1, MAGIC);
5334 mg->mg_moremagic = SvMAGIC(sv);
5337 /* Some magic sontains a reference loop, where the sv and object refer to
5338 each other. To prevent a reference loop that would prevent such
5339 objects being freed, we look for such loops and if we find one we
5340 avoid incrementing the object refcount.
5342 Note we cannot do this to avoid self-tie loops as intervening RV must
5343 have its REFCNT incremented to keep it in existence.
5346 if (!obj || obj == sv ||
5347 how == PERL_MAGIC_arylen ||
5348 how == PERL_MAGIC_qr ||
5349 (SvTYPE(obj) == SVt_PVGV &&
5350 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5351 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5352 GvFORM(obj) == (CV*)sv)))
5357 mg->mg_obj = SvREFCNT_inc(obj);
5358 mg->mg_flags |= MGf_REFCOUNTED;
5361 /* Normal self-ties simply pass a null object, and instead of
5362 using mg_obj directly, use the SvTIED_obj macro to produce a
5363 new RV as needed. For glob "self-ties", we are tieing the PVIO
5364 with an RV obj pointing to the glob containing the PVIO. In
5365 this case, to avoid a reference loop, we need to weaken the
5369 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5370 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5376 mg->mg_len = namlen;
5379 mg->mg_ptr = savepvn(name, namlen);
5380 else if (namlen == HEf_SVKEY)
5381 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5383 mg->mg_ptr = (char *) name;
5385 mg->mg_virtual = vtable;
5389 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5394 =for apidoc sv_magic
5396 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5397 then adds a new magic item of type C<how> to the head of the magic list.
5403 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5408 #ifdef PERL_COPY_ON_WRITE
5410 sv_force_normal_flags(sv, 0);
5412 if (SvREADONLY(sv)) {
5414 && how != PERL_MAGIC_regex_global
5415 && how != PERL_MAGIC_bm
5416 && how != PERL_MAGIC_fm
5417 && how != PERL_MAGIC_sv
5418 && how != PERL_MAGIC_backref
5421 Perl_croak(aTHX_ PL_no_modify);
5424 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5425 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5426 /* sv_magic() refuses to add a magic of the same 'how' as an
5429 if (how == PERL_MAGIC_taint)
5437 vtable = &PL_vtbl_sv;
5439 case PERL_MAGIC_overload:
5440 vtable = &PL_vtbl_amagic;
5442 case PERL_MAGIC_overload_elem:
5443 vtable = &PL_vtbl_amagicelem;
5445 case PERL_MAGIC_overload_table:
5446 vtable = &PL_vtbl_ovrld;
5449 vtable = &PL_vtbl_bm;
5451 case PERL_MAGIC_regdata:
5452 vtable = &PL_vtbl_regdata;
5454 case PERL_MAGIC_regdatum:
5455 vtable = &PL_vtbl_regdatum;
5457 case PERL_MAGIC_env:
5458 vtable = &PL_vtbl_env;
5461 vtable = &PL_vtbl_fm;
5463 case PERL_MAGIC_envelem:
5464 vtable = &PL_vtbl_envelem;
5466 case PERL_MAGIC_regex_global:
5467 vtable = &PL_vtbl_mglob;
5469 case PERL_MAGIC_isa:
5470 vtable = &PL_vtbl_isa;
5472 case PERL_MAGIC_isaelem:
5473 vtable = &PL_vtbl_isaelem;
5475 case PERL_MAGIC_nkeys:
5476 vtable = &PL_vtbl_nkeys;
5478 case PERL_MAGIC_dbfile:
5481 case PERL_MAGIC_dbline:
5482 vtable = &PL_vtbl_dbline;
5484 #ifdef USE_LOCALE_COLLATE
5485 case PERL_MAGIC_collxfrm:
5486 vtable = &PL_vtbl_collxfrm;
5488 #endif /* USE_LOCALE_COLLATE */
5489 case PERL_MAGIC_tied:
5490 vtable = &PL_vtbl_pack;
5492 case PERL_MAGIC_tiedelem:
5493 case PERL_MAGIC_tiedscalar:
5494 vtable = &PL_vtbl_packelem;
5497 vtable = &PL_vtbl_regexp;
5499 case PERL_MAGIC_sig:
5500 vtable = &PL_vtbl_sig;
5502 case PERL_MAGIC_sigelem:
5503 vtable = &PL_vtbl_sigelem;
5505 case PERL_MAGIC_taint:
5506 vtable = &PL_vtbl_taint;
5508 case PERL_MAGIC_uvar:
5509 vtable = &PL_vtbl_uvar;
5511 case PERL_MAGIC_vec:
5512 vtable = &PL_vtbl_vec;
5514 case PERL_MAGIC_vstring:
5517 case PERL_MAGIC_utf8:
5518 vtable = &PL_vtbl_utf8;
5520 case PERL_MAGIC_substr:
5521 vtable = &PL_vtbl_substr;
5523 case PERL_MAGIC_defelem:
5524 vtable = &PL_vtbl_defelem;
5526 case PERL_MAGIC_glob:
5527 vtable = &PL_vtbl_glob;
5529 case PERL_MAGIC_arylen:
5530 vtable = &PL_vtbl_arylen;
5532 case PERL_MAGIC_pos:
5533 vtable = &PL_vtbl_pos;
5535 case PERL_MAGIC_backref:
5536 vtable = &PL_vtbl_backref;
5538 case PERL_MAGIC_ext:
5539 /* Reserved for use by extensions not perl internals. */
5540 /* Useful for attaching extension internal data to perl vars. */
5541 /* Note that multiple extensions may clash if magical scalars */
5542 /* etc holding private data from one are passed to another. */
5545 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5548 /* Rest of work is done else where */
5549 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5552 case PERL_MAGIC_taint:
5555 case PERL_MAGIC_ext:
5556 case PERL_MAGIC_dbfile:
5563 =for apidoc sv_unmagic
5565 Removes all magic of type C<type> from an SV.
5571 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5575 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5578 for (mg = *mgp; mg; mg = *mgp) {
5579 if (mg->mg_type == type) {
5580 MGVTBL* vtbl = mg->mg_virtual;
5581 *mgp = mg->mg_moremagic;
5582 if (vtbl && vtbl->svt_free)
5583 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5584 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5586 Safefree(mg->mg_ptr);
5587 else if (mg->mg_len == HEf_SVKEY)
5588 SvREFCNT_dec((SV*)mg->mg_ptr);
5589 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5590 Safefree(mg->mg_ptr);
5592 if (mg->mg_flags & MGf_REFCOUNTED)
5593 SvREFCNT_dec(mg->mg_obj);
5597 mgp = &mg->mg_moremagic;
5601 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5608 =for apidoc sv_rvweaken
5610 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5611 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5612 push a back-reference to this RV onto the array of backreferences
5613 associated with that magic.
5619 Perl_sv_rvweaken(pTHX_ SV *sv)
5622 if (!SvOK(sv)) /* let undefs pass */
5625 Perl_croak(aTHX_ "Can't weaken a nonreference");
5626 else if (SvWEAKREF(sv)) {
5627 if (ckWARN(WARN_MISC))
5628 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5632 sv_add_backref(tsv, sv);
5638 /* Give tsv backref magic if it hasn't already got it, then push a
5639 * back-reference to sv onto the array associated with the backref magic.
5643 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5647 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5648 av = (AV*)mg->mg_obj;
5651 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5652 /* av now has a refcnt of 2, which avoids it getting freed
5653 * before us during global cleanup. The extra ref is removed
5654 * by magic_killbackrefs() when tsv is being freed */
5656 if (AvFILLp(av) >= AvMAX(av)) {
5658 SV **svp = AvARRAY(av);
5659 for (i = AvFILLp(av); i >= 0; i--)
5661 svp[i] = sv; /* reuse the slot */
5664 av_extend(av, AvFILLp(av)+1);
5666 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5669 /* delete a back-reference to ourselves from the backref magic associated
5670 * with the SV we point to.
5674 S_sv_del_backref(pTHX_ SV *sv)
5681 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5682 Perl_croak(aTHX_ "panic: del_backref");
5683 av = (AV *)mg->mg_obj;
5685 for (i = AvFILLp(av); i >= 0; i--)
5686 if (svp[i] == sv) svp[i] = Nullsv;
5690 =for apidoc sv_insert
5692 Inserts a string at the specified offset/length within the SV. Similar to
5693 the Perl substr() function.
5699 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5703 register char *midend;
5704 register char *bigend;
5710 Perl_croak(aTHX_ "Can't modify non-existent substring");
5711 SvPV_force(bigstr, curlen);
5712 (void)SvPOK_only_UTF8(bigstr);
5713 if (offset + len > curlen) {
5714 SvGROW(bigstr, offset+len+1);
5715 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5716 SvCUR_set(bigstr, offset+len);
5720 i = littlelen - len;
5721 if (i > 0) { /* string might grow */
5722 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5723 mid = big + offset + len;
5724 midend = bigend = big + SvCUR(bigstr);
5727 while (midend > mid) /* shove everything down */
5728 *--bigend = *--midend;
5729 Move(little,big+offset,littlelen,char);
5735 Move(little,SvPVX(bigstr)+offset,len,char);
5740 big = SvPVX(bigstr);
5743 bigend = big + SvCUR(bigstr);
5745 if (midend > bigend)
5746 Perl_croak(aTHX_ "panic: sv_insert");
5748 if (mid - big > bigend - midend) { /* faster to shorten from end */
5750 Move(little, mid, littlelen,char);
5753 i = bigend - midend;
5755 Move(midend, mid, i,char);
5759 SvCUR_set(bigstr, mid - big);
5762 else if ((i = mid - big)) { /* faster from front */
5763 midend -= littlelen;
5765 sv_chop(bigstr,midend-i);
5770 Move(little, mid, littlelen,char);
5772 else if (littlelen) {
5773 midend -= littlelen;
5774 sv_chop(bigstr,midend);
5775 Move(little,midend,littlelen,char);
5778 sv_chop(bigstr,midend);
5784 =for apidoc sv_replace
5786 Make the first argument a copy of the second, then delete the original.
5787 The target SV physically takes over ownership of the body of the source SV
5788 and inherits its flags; however, the target keeps any magic it owns,
5789 and any magic in the source is discarded.
5790 Note that this is a rather specialist SV copying operation; most of the
5791 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5797 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5799 U32 refcnt = SvREFCNT(sv);
5800 SV_CHECK_THINKFIRST_COW_DROP(sv);
5801 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5802 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5803 if (SvMAGICAL(sv)) {
5807 sv_upgrade(nsv, SVt_PVMG);
5808 SvMAGIC(nsv) = SvMAGIC(sv);
5809 SvFLAGS(nsv) |= SvMAGICAL(sv);
5815 assert(!SvREFCNT(sv));
5816 StructCopy(nsv,sv,SV);
5817 #ifdef PERL_COPY_ON_WRITE
5818 if (SvIsCOW_normal(nsv)) {
5819 /* We need to follow the pointers around the loop to make the
5820 previous SV point to sv, rather than nsv. */
5823 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5826 assert(SvPVX(current) == SvPVX(nsv));
5828 /* Make the SV before us point to the SV after us. */
5830 PerlIO_printf(Perl_debug_log, "previous is\n");
5832 PerlIO_printf(Perl_debug_log,
5833 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5834 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5836 SV_COW_NEXT_SV_SET(current, sv);
5839 SvREFCNT(sv) = refcnt;
5840 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5846 =for apidoc sv_clear
5848 Clear an SV: call any destructors, free up any memory used by the body,
5849 and free the body itself. The SV's head is I<not> freed, although
5850 its type is set to all 1's so that it won't inadvertently be assumed
5851 to be live during global destruction etc.
5852 This function should only be called when REFCNT is zero. Most of the time
5853 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5860 Perl_sv_clear(pTHX_ register SV *sv)
5864 assert(SvREFCNT(sv) == 0);
5867 if (PL_defstash) { /* Still have a symbol table? */
5874 stash = SvSTASH(sv);
5875 destructor = StashHANDLER(stash,DESTROY);
5877 SV* tmpref = newRV(sv);
5878 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5880 PUSHSTACKi(PERLSI_DESTROY);
5885 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5891 if(SvREFCNT(tmpref) < 2) {
5892 /* tmpref is not kept alive! */
5897 SvREFCNT_dec(tmpref);
5899 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5903 if (PL_in_clean_objs)
5904 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5906 /* DESTROY gave object new lease on life */
5912 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5913 SvOBJECT_off(sv); /* Curse the object. */
5914 if (SvTYPE(sv) != SVt_PVIO)
5915 --PL_sv_objcount; /* XXX Might want something more general */
5918 if (SvTYPE(sv) >= SVt_PVMG) {
5921 if (SvFLAGS(sv) & SVpad_TYPED)
5922 SvREFCNT_dec(SvSTASH(sv));
5925 switch (SvTYPE(sv)) {
5928 IoIFP(sv) != PerlIO_stdin() &&
5929 IoIFP(sv) != PerlIO_stdout() &&
5930 IoIFP(sv) != PerlIO_stderr())
5932 io_close((IO*)sv, FALSE);
5934 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5935 PerlDir_close(IoDIRP(sv));
5936 IoDIRP(sv) = (DIR*)NULL;
5937 Safefree(IoTOP_NAME(sv));
5938 Safefree(IoFMT_NAME(sv));
5939 Safefree(IoBOTTOM_NAME(sv));
5954 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5955 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5956 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5957 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5959 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5960 SvREFCNT_dec(LvTARG(sv));
5964 Safefree(GvNAME(sv));
5965 /* cannot decrease stash refcount yet, as we might recursively delete
5966 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5967 of stash until current sv is completely gone.
5968 -- JohnPC, 27 Mar 1998 */
5969 stash = GvSTASH(sv);
5975 (void)SvOOK_off(sv);
5983 SvREFCNT_dec(SvRV(sv));
5985 #ifdef PERL_COPY_ON_WRITE
5986 else if (SvPVX(sv)) {
5988 /* I believe I need to grab the global SV mutex here and
5989 then recheck the COW status. */
5991 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5994 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5995 SvUVX(sv), SV_COW_NEXT_SV(sv));
5996 /* And drop it here. */
5998 } else if (SvLEN(sv)) {
5999 Safefree(SvPVX(sv));
6003 else if (SvPVX(sv) && SvLEN(sv))
6004 Safefree(SvPVX(sv));
6005 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6006 unsharepvn(SvPVX(sv),
6007 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6021 switch (SvTYPE(sv)) {
6037 del_XPVIV(SvANY(sv));
6040 del_XPVNV(SvANY(sv));
6043 del_XPVMG(SvANY(sv));
6046 del_XPVLV(SvANY(sv));
6049 del_XPVAV(SvANY(sv));
6052 del_XPVHV(SvANY(sv));
6055 del_XPVCV(SvANY(sv));
6058 del_XPVGV(SvANY(sv));
6059 /* code duplication for increased performance. */
6060 SvFLAGS(sv) &= SVf_BREAK;
6061 SvFLAGS(sv) |= SVTYPEMASK;
6062 /* decrease refcount of the stash that owns this GV, if any */
6064 SvREFCNT_dec(stash);
6065 return; /* not break, SvFLAGS reset already happened */
6067 del_XPVBM(SvANY(sv));
6070 del_XPVFM(SvANY(sv));
6073 del_XPVIO(SvANY(sv));
6076 SvFLAGS(sv) &= SVf_BREAK;
6077 SvFLAGS(sv) |= SVTYPEMASK;
6081 =for apidoc sv_newref
6083 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6090 Perl_sv_newref(pTHX_ SV *sv)
6100 Decrement an SV's reference count, and if it drops to zero, call
6101 C<sv_clear> to invoke destructors and free up any memory used by
6102 the body; finally, deallocate the SV's head itself.
6103 Normally called via a wrapper macro C<SvREFCNT_dec>.
6109 Perl_sv_free(pTHX_ SV *sv)
6113 if (SvREFCNT(sv) == 0) {
6114 if (SvFLAGS(sv) & SVf_BREAK)
6115 /* this SV's refcnt has been artificially decremented to
6116 * trigger cleanup */
6118 if (PL_in_clean_all) /* All is fair */
6120 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6121 /* make sure SvREFCNT(sv)==0 happens very seldom */
6122 SvREFCNT(sv) = (~(U32)0)/2;
6125 if (ckWARN_d(WARN_INTERNAL))
6126 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6127 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6128 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6131 if (--(SvREFCNT(sv)) > 0)
6133 Perl_sv_free2(aTHX_ sv);
6137 Perl_sv_free2(pTHX_ SV *sv)
6141 if (ckWARN_d(WARN_DEBUGGING))
6142 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6143 "Attempt to free temp prematurely: SV 0x%"UVxf
6144 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6148 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6149 /* make sure SvREFCNT(sv)==0 happens very seldom */
6150 SvREFCNT(sv) = (~(U32)0)/2;
6161 Returns the length of the string in the SV. Handles magic and type
6162 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6168 Perl_sv_len(pTHX_ register SV *sv)
6176 len = mg_length(sv);
6178 (void)SvPV(sv, len);
6183 =for apidoc sv_len_utf8
6185 Returns the number of characters in the string in an SV, counting wide
6186 UTF-8 bytes as a single character. Handles magic and type coercion.
6192 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6193 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6194 * (Note that the mg_len is not the length of the mg_ptr field.)
6199 Perl_sv_len_utf8(pTHX_ register SV *sv)
6205 return mg_length(sv);
6209 U8 *s = (U8*)SvPV(sv, len);
6210 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6212 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6214 #ifdef PERL_UTF8_CACHE_ASSERT
6215 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6219 ulen = Perl_utf8_length(aTHX_ s, s + len);
6220 if (!mg && !SvREADONLY(sv)) {
6221 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6222 mg = mg_find(sv, PERL_MAGIC_utf8);
6232 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6233 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6234 * between UTF-8 and byte offsets. There are two (substr offset and substr
6235 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6236 * and byte offset) cache positions.
6238 * The mg_len field is used by sv_len_utf8(), see its comments.
6239 * Note that the mg_len is not the length of the mg_ptr field.
6243 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6247 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6249 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6253 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6255 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6256 (*mgp)->mg_ptr = (char *) *cachep;
6260 (*cachep)[i] = *offsetp;
6261 (*cachep)[i+1] = s - start;
6269 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6270 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6271 * between UTF-8 and byte offsets. See also the comments of
6272 * S_utf8_mg_pos_init().
6276 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6280 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6282 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6283 if (*mgp && (*mgp)->mg_ptr) {
6284 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6285 ASSERT_UTF8_CACHE(*cachep);
6286 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6288 else { /* We will skip to the right spot. */
6293 /* The assumption is that going backward is half
6294 * the speed of going forward (that's where the
6295 * 2 * backw in the below comes from). (The real
6296 * figure of course depends on the UTF-8 data.) */
6298 if ((*cachep)[i] > (STRLEN)uoff) {
6300 backw = (*cachep)[i] - (STRLEN)uoff;
6302 if (forw < 2 * backw)
6305 p = start + (*cachep)[i+1];
6307 /* Try this only for the substr offset (i == 0),
6308 * not for the substr length (i == 2). */
6309 else if (i == 0) { /* (*cachep)[i] < uoff */
6310 STRLEN ulen = sv_len_utf8(sv);
6312 if ((STRLEN)uoff < ulen) {
6313 forw = (STRLEN)uoff - (*cachep)[i];
6314 backw = ulen - (STRLEN)uoff;
6316 if (forw < 2 * backw)
6317 p = start + (*cachep)[i+1];
6322 /* If the string is not long enough for uoff,
6323 * we could extend it, but not at this low a level. */
6327 if (forw < 2 * backw) {
6334 while (UTF8_IS_CONTINUATION(*p))
6339 /* Update the cache. */
6340 (*cachep)[i] = (STRLEN)uoff;
6341 (*cachep)[i+1] = p - start;
6343 /* Drop the stale "length" cache */
6352 if (found) { /* Setup the return values. */
6353 *offsetp = (*cachep)[i+1];
6354 *sp = start + *offsetp;
6357 *offsetp = send - start;
6359 else if (*sp < start) {
6365 #ifdef PERL_UTF8_CACHE_ASSERT
6370 while (n-- && s < send)
6374 assert(*offsetp == s - start);
6375 assert((*cachep)[0] == (STRLEN)uoff);
6376 assert((*cachep)[1] == *offsetp);
6378 ASSERT_UTF8_CACHE(*cachep);
6387 =for apidoc sv_pos_u2b
6389 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6390 the start of the string, to a count of the equivalent number of bytes; if
6391 lenp is non-zero, it does the same to lenp, but this time starting from
6392 the offset, rather than from the start of the string. Handles magic and
6399 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6400 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6401 * byte offsets. See also the comments of S_utf8_mg_pos().
6406 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6417 start = s = (U8*)SvPV(sv, len);
6419 I32 uoffset = *offsetp;
6424 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6426 if (!found && uoffset > 0) {
6427 while (s < send && uoffset--)
6431 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6433 *offsetp = s - start;
6438 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6442 if (!found && *lenp > 0) {
6445 while (s < send && ulen--)
6449 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6453 ASSERT_UTF8_CACHE(cache);
6465 =for apidoc sv_pos_b2u
6467 Converts the value pointed to by offsetp from a count of bytes from the
6468 start of the string, to a count of the equivalent number of UTF-8 chars.
6469 Handles magic and type coercion.
6475 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6476 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6477 * byte offsets. See also the comments of S_utf8_mg_pos().
6482 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6490 s = (U8*)SvPV(sv, len);
6491 if ((I32)len < *offsetp)
6492 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6494 U8* send = s + *offsetp;
6496 STRLEN *cache = NULL;
6500 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6501 mg = mg_find(sv, PERL_MAGIC_utf8);
6502 if (mg && mg->mg_ptr) {
6503 cache = (STRLEN *) mg->mg_ptr;
6504 if (cache[1] == (STRLEN)*offsetp) {
6505 /* An exact match. */
6506 *offsetp = cache[0];
6510 else if (cache[1] < (STRLEN)*offsetp) {
6511 /* We already know part of the way. */
6514 /* Let the below loop do the rest. */
6516 else { /* cache[1] > *offsetp */
6517 /* We already know all of the way, now we may
6518 * be able to walk back. The same assumption
6519 * is made as in S_utf8_mg_pos(), namely that
6520 * walking backward is twice slower than
6521 * walking forward. */
6522 STRLEN forw = *offsetp;
6523 STRLEN backw = cache[1] - *offsetp;
6525 if (!(forw < 2 * backw)) {
6526 U8 *p = s + cache[1];
6533 while (UTF8_IS_CONTINUATION(*p)) {
6541 *offsetp = cache[0];
6543 /* Drop the stale "length" cache */
6551 ASSERT_UTF8_CACHE(cache);
6557 /* Call utf8n_to_uvchr() to validate the sequence
6558 * (unless a simple non-UTF character) */
6559 if (!UTF8_IS_INVARIANT(*s))
6560 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6569 if (!SvREADONLY(sv)) {
6571 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6572 mg = mg_find(sv, PERL_MAGIC_utf8);
6577 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6578 mg->mg_ptr = (char *) cache;
6583 cache[1] = *offsetp;
6584 /* Drop the stale "length" cache */
6597 Returns a boolean indicating whether the strings in the two SVs are
6598 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6599 coerce its args to strings if necessary.
6605 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6613 SV* svrecode = Nullsv;
6620 pv1 = SvPV(sv1, cur1);
6627 pv2 = SvPV(sv2, cur2);
6629 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6630 /* Differing utf8ness.
6631 * Do not UTF8size the comparands as a side-effect. */
6634 svrecode = newSVpvn(pv2, cur2);
6635 sv_recode_to_utf8(svrecode, PL_encoding);
6636 pv2 = SvPV(svrecode, cur2);
6639 svrecode = newSVpvn(pv1, cur1);
6640 sv_recode_to_utf8(svrecode, PL_encoding);
6641 pv1 = SvPV(svrecode, cur1);
6643 /* Now both are in UTF-8. */
6645 SvREFCNT_dec(svrecode);
6650 bool is_utf8 = TRUE;
6653 /* sv1 is the UTF-8 one,
6654 * if is equal it must be downgrade-able */
6655 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6661 /* sv2 is the UTF-8 one,
6662 * if is equal it must be downgrade-able */
6663 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6669 /* Downgrade not possible - cannot be eq */
6677 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6680 SvREFCNT_dec(svrecode);
6691 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6692 string in C<sv1> is less than, equal to, or greater than the string in
6693 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6694 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6700 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6703 char *pv1, *pv2, *tpv = Nullch;
6705 SV *svrecode = Nullsv;
6712 pv1 = SvPV(sv1, cur1);
6719 pv2 = SvPV(sv2, cur2);
6721 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6722 /* Differing utf8ness.
6723 * Do not UTF8size the comparands as a side-effect. */
6726 svrecode = newSVpvn(pv2, cur2);
6727 sv_recode_to_utf8(svrecode, PL_encoding);
6728 pv2 = SvPV(svrecode, cur2);
6731 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6736 svrecode = newSVpvn(pv1, cur1);
6737 sv_recode_to_utf8(svrecode, PL_encoding);
6738 pv1 = SvPV(svrecode, cur1);
6741 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6747 cmp = cur2 ? -1 : 0;
6751 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6754 cmp = retval < 0 ? -1 : 1;
6755 } else if (cur1 == cur2) {
6758 cmp = cur1 < cur2 ? -1 : 1;
6763 SvREFCNT_dec(svrecode);
6772 =for apidoc sv_cmp_locale
6774 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6775 'use bytes' aware, handles get magic, and will coerce its args to strings
6776 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6782 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6784 #ifdef USE_LOCALE_COLLATE
6790 if (PL_collation_standard)
6794 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6796 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6798 if (!pv1 || !len1) {
6809 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6812 return retval < 0 ? -1 : 1;
6815 * When the result of collation is equality, that doesn't mean
6816 * that there are no differences -- some locales exclude some
6817 * characters from consideration. So to avoid false equalities,
6818 * we use the raw string as a tiebreaker.
6824 #endif /* USE_LOCALE_COLLATE */
6826 return sv_cmp(sv1, sv2);
6830 #ifdef USE_LOCALE_COLLATE
6833 =for apidoc sv_collxfrm
6835 Add Collate Transform magic to an SV if it doesn't already have it.
6837 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6838 scalar data of the variable, but transformed to such a format that a normal
6839 memory comparison can be used to compare the data according to the locale
6846 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6850 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6851 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6856 Safefree(mg->mg_ptr);
6858 if ((xf = mem_collxfrm(s, len, &xlen))) {
6859 if (SvREADONLY(sv)) {
6862 return xf + sizeof(PL_collation_ix);
6865 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6866 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6879 if (mg && mg->mg_ptr) {
6881 return mg->mg_ptr + sizeof(PL_collation_ix);
6889 #endif /* USE_LOCALE_COLLATE */
6894 Get a line from the filehandle and store it into the SV, optionally
6895 appending to the currently-stored string.
6901 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6905 register STDCHAR rslast;
6906 register STDCHAR *bp;
6912 if (SvTHINKFIRST(sv))
6913 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6914 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6916 However, perlbench says it's slower, because the existing swipe code
6917 is faster than copy on write.
6918 Swings and roundabouts. */
6919 (void)SvUPGRADE(sv, SVt_PV);
6924 if (PerlIO_isutf8(fp)) {
6926 sv_utf8_upgrade_nomg(sv);
6927 sv_pos_u2b(sv,&append,0);
6929 } else if (SvUTF8(sv)) {
6930 SV *tsv = NEWSV(0,0);
6931 sv_gets(tsv, fp, 0);
6932 sv_utf8_upgrade_nomg(tsv);
6933 SvCUR_set(sv,append);
6936 goto return_string_or_null;
6941 if (PerlIO_isutf8(fp))
6944 if (IN_PERL_COMPILETIME) {
6945 /* we always read code in line mode */
6949 else if (RsSNARF(PL_rs)) {
6950 /* If it is a regular disk file use size from stat() as estimate
6951 of amount we are going to read - may result in malloc-ing
6952 more memory than we realy need if layers bellow reduce
6953 size we read (e.g. CRLF or a gzip layer)
6956 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6957 Off_t offset = PerlIO_tell(fp);
6958 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6959 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6965 else if (RsRECORD(PL_rs)) {
6969 /* Grab the size of the record we're getting */
6970 recsize = SvIV(SvRV(PL_rs));
6971 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6974 /* VMS wants read instead of fread, because fread doesn't respect */
6975 /* RMS record boundaries. This is not necessarily a good thing to be */
6976 /* doing, but we've got no other real choice - except avoid stdio
6977 as implementation - perhaps write a :vms layer ?
6979 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6981 bytesread = PerlIO_read(fp, buffer, recsize);
6985 SvCUR_set(sv, bytesread += append);
6986 buffer[bytesread] = '\0';
6987 goto return_string_or_null;
6989 else if (RsPARA(PL_rs)) {
6995 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6996 if (PerlIO_isutf8(fp)) {
6997 rsptr = SvPVutf8(PL_rs, rslen);
7000 if (SvUTF8(PL_rs)) {
7001 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7002 Perl_croak(aTHX_ "Wide character in $/");
7005 rsptr = SvPV(PL_rs, rslen);
7009 rslast = rslen ? rsptr[rslen - 1] : '\0';
7011 if (rspara) { /* have to do this both before and after */
7012 do { /* to make sure file boundaries work right */
7015 i = PerlIO_getc(fp);
7019 PerlIO_ungetc(fp,i);
7025 /* See if we know enough about I/O mechanism to cheat it ! */
7027 /* This used to be #ifdef test - it is made run-time test for ease
7028 of abstracting out stdio interface. One call should be cheap
7029 enough here - and may even be a macro allowing compile
7033 if (PerlIO_fast_gets(fp)) {
7036 * We're going to steal some values from the stdio struct
7037 * and put EVERYTHING in the innermost loop into registers.
7039 register STDCHAR *ptr;
7043 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7044 /* An ungetc()d char is handled separately from the regular
7045 * buffer, so we getc() it back out and stuff it in the buffer.
7047 i = PerlIO_getc(fp);
7048 if (i == EOF) return 0;
7049 *(--((*fp)->_ptr)) = (unsigned char) i;
7053 /* Here is some breathtakingly efficient cheating */
7055 cnt = PerlIO_get_cnt(fp); /* get count into register */
7056 /* make sure we have the room */
7057 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7058 /* Not room for all of it
7059 if we are looking for a separator and room for some
7061 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7062 /* just process what we have room for */
7063 shortbuffered = cnt - SvLEN(sv) + append + 1;
7064 cnt -= shortbuffered;
7068 /* remember that cnt can be negative */
7069 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7074 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7075 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7076 DEBUG_P(PerlIO_printf(Perl_debug_log,
7077 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7078 DEBUG_P(PerlIO_printf(Perl_debug_log,
7079 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7080 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7081 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7086 while (cnt > 0) { /* this | eat */
7088 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7089 goto thats_all_folks; /* screams | sed :-) */
7093 Copy(ptr, bp, cnt, char); /* this | eat */
7094 bp += cnt; /* screams | dust */
7095 ptr += cnt; /* louder | sed :-) */
7100 if (shortbuffered) { /* oh well, must extend */
7101 cnt = shortbuffered;
7103 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7105 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7106 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7110 DEBUG_P(PerlIO_printf(Perl_debug_log,
7111 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7112 PTR2UV(ptr),(long)cnt));
7113 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7115 DEBUG_P(PerlIO_printf(Perl_debug_log,
7116 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7117 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7118 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7120 /* This used to call 'filbuf' in stdio form, but as that behaves like
7121 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7122 another abstraction. */
7123 i = PerlIO_getc(fp); /* get more characters */
7125 DEBUG_P(PerlIO_printf(Perl_debug_log,
7126 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7127 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7128 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7130 cnt = PerlIO_get_cnt(fp);
7131 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7132 DEBUG_P(PerlIO_printf(Perl_debug_log,
7133 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7135 if (i == EOF) /* all done for ever? */
7136 goto thats_really_all_folks;
7138 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7140 SvGROW(sv, bpx + cnt + 2);
7141 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7143 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7145 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7146 goto thats_all_folks;
7150 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7151 memNE((char*)bp - rslen, rsptr, rslen))
7152 goto screamer; /* go back to the fray */
7153 thats_really_all_folks:
7155 cnt += shortbuffered;
7156 DEBUG_P(PerlIO_printf(Perl_debug_log,
7157 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7158 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7159 DEBUG_P(PerlIO_printf(Perl_debug_log,
7160 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7161 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7162 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7164 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7165 DEBUG_P(PerlIO_printf(Perl_debug_log,
7166 "Screamer: done, len=%ld, string=|%.*s|\n",
7167 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7171 /*The big, slow, and stupid way. */
7173 /* Any stack-challenged places. */
7175 /* EPOC: need to work around SDK features. *
7176 * On WINS: MS VC5 generates calls to _chkstk, *
7177 * if a "large" stack frame is allocated. *
7178 * gcc on MARM does not generate calls like these. */
7179 # define USEHEAPINSTEADOFSTACK
7182 #ifdef USEHEAPINSTEADOFSTACK
7184 New(0, buf, 8192, STDCHAR);
7192 register STDCHAR *bpe = buf + sizeof(buf);
7194 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7195 ; /* keep reading */
7199 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7200 /* Accomodate broken VAXC compiler, which applies U8 cast to
7201 * both args of ?: operator, causing EOF to change into 255
7204 i = (U8)buf[cnt - 1];
7210 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7212 sv_catpvn(sv, (char *) buf, cnt);
7214 sv_setpvn(sv, (char *) buf, cnt);
7216 if (i != EOF && /* joy */
7218 SvCUR(sv) < rslen ||
7219 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7223 * If we're reading from a TTY and we get a short read,
7224 * indicating that the user hit his EOF character, we need
7225 * to notice it now, because if we try to read from the TTY
7226 * again, the EOF condition will disappear.
7228 * The comparison of cnt to sizeof(buf) is an optimization
7229 * that prevents unnecessary calls to feof().
7233 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7237 #ifdef USEHEAPINSTEADOFSTACK
7242 if (rspara) { /* have to do this both before and after */
7243 while (i != EOF) { /* to make sure file boundaries work right */
7244 i = PerlIO_getc(fp);
7246 PerlIO_ungetc(fp,i);
7252 return_string_or_null:
7253 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7259 Auto-increment of the value in the SV, doing string to numeric conversion
7260 if necessary. Handles 'get' magic.
7266 Perl_sv_inc(pTHX_ register SV *sv)
7275 if (SvTHINKFIRST(sv)) {
7277 sv_force_normal_flags(sv, 0);
7278 if (SvREADONLY(sv)) {
7279 if (IN_PERL_RUNTIME)
7280 Perl_croak(aTHX_ PL_no_modify);
7284 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7286 i = PTR2IV(SvRV(sv));
7291 flags = SvFLAGS(sv);
7292 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7293 /* It's (privately or publicly) a float, but not tested as an
7294 integer, so test it to see. */
7296 flags = SvFLAGS(sv);
7298 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7299 /* It's publicly an integer, or privately an integer-not-float */
7300 #ifdef PERL_PRESERVE_IVUV
7304 if (SvUVX(sv) == UV_MAX)
7305 sv_setnv(sv, UV_MAX_P1);
7307 (void)SvIOK_only_UV(sv);
7310 if (SvIVX(sv) == IV_MAX)
7311 sv_setuv(sv, (UV)IV_MAX + 1);
7313 (void)SvIOK_only(sv);
7319 if (flags & SVp_NOK) {
7320 (void)SvNOK_only(sv);
7325 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7326 if ((flags & SVTYPEMASK) < SVt_PVIV)
7327 sv_upgrade(sv, SVt_IV);
7328 (void)SvIOK_only(sv);
7333 while (isALPHA(*d)) d++;
7334 while (isDIGIT(*d)) d++;
7336 #ifdef PERL_PRESERVE_IVUV
7337 /* Got to punt this as an integer if needs be, but we don't issue
7338 warnings. Probably ought to make the sv_iv_please() that does
7339 the conversion if possible, and silently. */
7340 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7341 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7342 /* Need to try really hard to see if it's an integer.
7343 9.22337203685478e+18 is an integer.
7344 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7345 so $a="9.22337203685478e+18"; $a+0; $a++
7346 needs to be the same as $a="9.22337203685478e+18"; $a++
7353 /* sv_2iv *should* have made this an NV */
7354 if (flags & SVp_NOK) {
7355 (void)SvNOK_only(sv);
7359 /* I don't think we can get here. Maybe I should assert this
7360 And if we do get here I suspect that sv_setnv will croak. NWC
7362 #if defined(USE_LONG_DOUBLE)
7363 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",
7364 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7366 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7367 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7370 #endif /* PERL_PRESERVE_IVUV */
7371 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7375 while (d >= SvPVX(sv)) {
7383 /* MKS: The original code here died if letters weren't consecutive.
7384 * at least it didn't have to worry about non-C locales. The
7385 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7386 * arranged in order (although not consecutively) and that only
7387 * [A-Za-z] are accepted by isALPHA in the C locale.
7389 if (*d != 'z' && *d != 'Z') {
7390 do { ++*d; } while (!isALPHA(*d));
7393 *(d--) -= 'z' - 'a';
7398 *(d--) -= 'z' - 'a' + 1;
7402 /* oh,oh, the number grew */
7403 SvGROW(sv, SvCUR(sv) + 2);
7405 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7416 Auto-decrement of the value in the SV, doing string to numeric conversion
7417 if necessary. Handles 'get' magic.
7423 Perl_sv_dec(pTHX_ register SV *sv)
7431 if (SvTHINKFIRST(sv)) {
7433 sv_force_normal_flags(sv, 0);
7434 if (SvREADONLY(sv)) {
7435 if (IN_PERL_RUNTIME)
7436 Perl_croak(aTHX_ PL_no_modify);
7440 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7442 i = PTR2IV(SvRV(sv));
7447 /* Unlike sv_inc we don't have to worry about string-never-numbers
7448 and keeping them magic. But we mustn't warn on punting */
7449 flags = SvFLAGS(sv);
7450 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7451 /* It's publicly an integer, or privately an integer-not-float */
7452 #ifdef PERL_PRESERVE_IVUV
7456 if (SvUVX(sv) == 0) {
7457 (void)SvIOK_only(sv);
7461 (void)SvIOK_only_UV(sv);
7465 if (SvIVX(sv) == IV_MIN)
7466 sv_setnv(sv, (NV)IV_MIN - 1.0);
7468 (void)SvIOK_only(sv);
7474 if (flags & SVp_NOK) {
7476 (void)SvNOK_only(sv);
7479 if (!(flags & SVp_POK)) {
7480 if ((flags & SVTYPEMASK) < SVt_PVNV)
7481 sv_upgrade(sv, SVt_NV);
7483 (void)SvNOK_only(sv);
7486 #ifdef PERL_PRESERVE_IVUV
7488 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7489 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7490 /* Need to try really hard to see if it's an integer.
7491 9.22337203685478e+18 is an integer.
7492 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7493 so $a="9.22337203685478e+18"; $a+0; $a--
7494 needs to be the same as $a="9.22337203685478e+18"; $a--
7501 /* sv_2iv *should* have made this an NV */
7502 if (flags & SVp_NOK) {
7503 (void)SvNOK_only(sv);
7507 /* I don't think we can get here. Maybe I should assert this
7508 And if we do get here I suspect that sv_setnv will croak. NWC
7510 #if defined(USE_LONG_DOUBLE)
7511 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",
7512 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7514 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7515 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7519 #endif /* PERL_PRESERVE_IVUV */
7520 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7524 =for apidoc sv_mortalcopy
7526 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7527 The new SV is marked as mortal. It will be destroyed "soon", either by an
7528 explicit call to FREETMPS, or by an implicit call at places such as
7529 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7534 /* Make a string that will exist for the duration of the expression
7535 * evaluation. Actually, it may have to last longer than that, but
7536 * hopefully we won't free it until it has been assigned to a
7537 * permanent location. */
7540 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7545 sv_setsv(sv,oldstr);
7547 PL_tmps_stack[++PL_tmps_ix] = sv;
7553 =for apidoc sv_newmortal
7555 Creates a new null SV which is mortal. The reference count of the SV is
7556 set to 1. It will be destroyed "soon", either by an explicit call to
7557 FREETMPS, or by an implicit call at places such as statement boundaries.
7558 See also C<sv_mortalcopy> and C<sv_2mortal>.
7564 Perl_sv_newmortal(pTHX)
7569 SvFLAGS(sv) = SVs_TEMP;
7571 PL_tmps_stack[++PL_tmps_ix] = sv;
7576 =for apidoc sv_2mortal
7578 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7579 by an explicit call to FREETMPS, or by an implicit call at places such as
7580 statement boundaries. SvTEMP() is turned on which means that the SV's
7581 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7582 and C<sv_mortalcopy>.
7588 Perl_sv_2mortal(pTHX_ register SV *sv)
7592 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7595 PL_tmps_stack[++PL_tmps_ix] = sv;
7603 Creates a new SV and copies a string into it. The reference count for the
7604 SV is set to 1. If C<len> is zero, Perl will compute the length using
7605 strlen(). For efficiency, consider using C<newSVpvn> instead.
7611 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7618 sv_setpvn(sv,s,len);
7623 =for apidoc newSVpvn
7625 Creates a new SV and copies a string into it. The reference count for the
7626 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7627 string. You are responsible for ensuring that the source string is at least
7628 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7634 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7639 sv_setpvn(sv,s,len);
7644 =for apidoc newSVpvn_share
7646 Creates a new SV with its SvPVX pointing to a shared string in the string
7647 table. If the string does not already exist in the table, it is created
7648 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7649 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7650 otherwise the hash is computed. The idea here is that as the string table
7651 is used for shared hash keys these strings will have SvPVX == HeKEY and
7652 hash lookup will avoid string compare.
7658 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7661 bool is_utf8 = FALSE;
7663 STRLEN tmplen = -len;
7665 /* See the note in hv.c:hv_fetch() --jhi */
7666 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7670 PERL_HASH(hash, src, len);
7672 sv_upgrade(sv, SVt_PVIV);
7673 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7686 #if defined(PERL_IMPLICIT_CONTEXT)
7688 /* pTHX_ magic can't cope with varargs, so this is a no-context
7689 * version of the main function, (which may itself be aliased to us).
7690 * Don't access this version directly.
7694 Perl_newSVpvf_nocontext(const char* pat, ...)
7699 va_start(args, pat);
7700 sv = vnewSVpvf(pat, &args);
7707 =for apidoc newSVpvf
7709 Creates a new SV and initializes it with the string formatted like
7716 Perl_newSVpvf(pTHX_ const char* pat, ...)
7720 va_start(args, pat);
7721 sv = vnewSVpvf(pat, &args);
7726 /* backend for newSVpvf() and newSVpvf_nocontext() */
7729 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7733 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7740 Creates a new SV and copies a floating point value into it.
7741 The reference count for the SV is set to 1.
7747 Perl_newSVnv(pTHX_ NV n)
7759 Creates a new SV and copies an integer into it. The reference count for the
7766 Perl_newSViv(pTHX_ IV i)
7778 Creates a new SV and copies an unsigned integer into it.
7779 The reference count for the SV is set to 1.
7785 Perl_newSVuv(pTHX_ UV u)
7795 =for apidoc newRV_noinc
7797 Creates an RV wrapper for an SV. The reference count for the original
7798 SV is B<not> incremented.
7804 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7809 sv_upgrade(sv, SVt_RV);
7816 /* newRV_inc is the official function name to use now.
7817 * newRV_inc is in fact #defined to newRV in sv.h
7821 Perl_newRV(pTHX_ SV *tmpRef)
7823 return newRV_noinc(SvREFCNT_inc(tmpRef));
7829 Creates a new SV which is an exact duplicate of the original SV.
7836 Perl_newSVsv(pTHX_ register SV *old)
7842 if (SvTYPE(old) == SVTYPEMASK) {
7843 if (ckWARN_d(WARN_INTERNAL))
7844 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7859 =for apidoc sv_reset
7861 Underlying implementation for the C<reset> Perl function.
7862 Note that the perl-level function is vaguely deprecated.
7868 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7876 char todo[PERL_UCHAR_MAX+1];
7881 if (!*s) { /* reset ?? searches */
7882 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7883 pm->op_pmdynflags &= ~PMdf_USED;
7888 /* reset variables */
7890 if (!HvARRAY(stash))
7893 Zero(todo, 256, char);
7895 i = (unsigned char)*s;
7899 max = (unsigned char)*s++;
7900 for ( ; i <= max; i++) {
7903 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7904 for (entry = HvARRAY(stash)[i];
7906 entry = HeNEXT(entry))
7908 if (!todo[(U8)*HeKEY(entry)])
7910 gv = (GV*)HeVAL(entry);
7912 if (SvTHINKFIRST(sv)) {
7913 if (!SvREADONLY(sv) && SvROK(sv))
7918 if (SvTYPE(sv) >= SVt_PV) {
7920 if (SvPVX(sv) != Nullch)
7927 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7930 #ifdef USE_ENVIRON_ARRAY
7932 # ifdef USE_ITHREADS
7933 && PL_curinterp == aTHX
7937 environ[0] = Nullch;
7940 #endif /* !PERL_MICRO */
7950 Using various gambits, try to get an IO from an SV: the IO slot if its a
7951 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7952 named after the PV if we're a string.
7958 Perl_sv_2io(pTHX_ SV *sv)
7964 switch (SvTYPE(sv)) {
7972 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7976 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7978 return sv_2io(SvRV(sv));
7979 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7985 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7994 Using various gambits, try to get a CV from an SV; in addition, try if
7995 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8001 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8008 return *gvp = Nullgv, Nullcv;
8009 switch (SvTYPE(sv)) {
8028 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8029 tryAMAGICunDEREF(to_cv);
8032 if (SvTYPE(sv) == SVt_PVCV) {
8041 Perl_croak(aTHX_ "Not a subroutine reference");
8046 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
8052 if (lref && !GvCVu(gv)) {
8055 tmpsv = NEWSV(704,0);
8056 gv_efullname3(tmpsv, gv, Nullch);
8057 /* XXX this is probably not what they think they're getting.
8058 * It has the same effect as "sub name;", i.e. just a forward
8060 newSUB(start_subparse(FALSE, 0),
8061 newSVOP(OP_CONST, 0, tmpsv),
8066 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8076 Returns true if the SV has a true value by Perl's rules.
8077 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8078 instead use an in-line version.
8084 Perl_sv_true(pTHX_ register SV *sv)
8090 if ((tXpv = (XPV*)SvANY(sv)) &&
8091 (tXpv->xpv_cur > 1 ||
8092 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8099 return SvIVX(sv) != 0;
8102 return SvNVX(sv) != 0.0;
8104 return sv_2bool(sv);
8112 A private implementation of the C<SvIVx> macro for compilers which can't
8113 cope with complex macro expressions. Always use the macro instead.
8119 Perl_sv_iv(pTHX_ register SV *sv)
8123 return (IV)SvUVX(sv);
8132 A private implementation of the C<SvUVx> macro for compilers which can't
8133 cope with complex macro expressions. Always use the macro instead.
8139 Perl_sv_uv(pTHX_ register SV *sv)
8144 return (UV)SvIVX(sv);
8152 A private implementation of the C<SvNVx> macro for compilers which can't
8153 cope with complex macro expressions. Always use the macro instead.
8159 Perl_sv_nv(pTHX_ register SV *sv)
8166 /* sv_pv() is now a macro using SvPV_nolen();
8167 * this function provided for binary compatibility only
8171 Perl_sv_pv(pTHX_ SV *sv)
8178 return sv_2pv(sv, &n_a);
8184 Use the C<SvPV_nolen> macro instead
8188 A private implementation of the C<SvPV> macro for compilers which can't
8189 cope with complex macro expressions. Always use the macro instead.
8195 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8201 return sv_2pv(sv, lp);
8206 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8212 return sv_2pv_flags(sv, lp, 0);
8215 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8216 * this function provided for binary compatibility only
8220 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8222 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8226 =for apidoc sv_pvn_force
8228 Get a sensible string out of the SV somehow.
8229 A private implementation of the C<SvPV_force> macro for compilers which
8230 can't cope with complex macro expressions. Always use the macro instead.
8232 =for apidoc sv_pvn_force_flags
8234 Get a sensible string out of the SV somehow.
8235 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8236 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8237 implemented in terms of this function.
8238 You normally want to use the various wrapper macros instead: see
8239 C<SvPV_force> and C<SvPV_force_nomg>
8245 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8249 if (SvTHINKFIRST(sv) && !SvROK(sv))
8250 sv_force_normal_flags(sv, 0);
8256 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8257 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8261 s = sv_2pv_flags(sv, lp, flags);
8262 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8267 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8268 SvGROW(sv, len + 1);
8269 Move(s,SvPVX(sv),len,char);
8274 SvPOK_on(sv); /* validate pointer */
8276 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8277 PTR2UV(sv),SvPVX(sv)));
8283 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8284 * this function provided for binary compatibility only
8288 Perl_sv_pvbyte(pTHX_ SV *sv)
8290 sv_utf8_downgrade(sv,0);
8295 =for apidoc sv_pvbyte
8297 Use C<SvPVbyte_nolen> instead.
8299 =for apidoc sv_pvbyten
8301 A private implementation of the C<SvPVbyte> macro for compilers
8302 which can't cope with complex macro expressions. Always use the macro
8309 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8311 sv_utf8_downgrade(sv,0);
8312 return sv_pvn(sv,lp);
8316 =for apidoc sv_pvbyten_force
8318 A private implementation of the C<SvPVbytex_force> macro for compilers
8319 which can't cope with complex macro expressions. Always use the macro
8326 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8328 sv_pvn_force(sv,lp);
8329 sv_utf8_downgrade(sv,0);
8334 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8335 * this function provided for binary compatibility only
8339 Perl_sv_pvutf8(pTHX_ SV *sv)
8341 sv_utf8_upgrade(sv);
8346 =for apidoc sv_pvutf8
8348 Use the C<SvPVutf8_nolen> macro instead
8350 =for apidoc sv_pvutf8n
8352 A private implementation of the C<SvPVutf8> macro for compilers
8353 which can't cope with complex macro expressions. Always use the macro
8360 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8362 sv_utf8_upgrade(sv);
8363 return sv_pvn(sv,lp);
8367 =for apidoc sv_pvutf8n_force
8369 A private implementation of the C<SvPVutf8_force> macro for compilers
8370 which can't cope with complex macro expressions. Always use the macro
8377 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8379 sv_pvn_force(sv,lp);
8380 sv_utf8_upgrade(sv);
8386 =for apidoc sv_reftype
8388 Returns a string describing what the SV is a reference to.
8394 Perl_sv_reftype(pTHX_ SV *sv, int ob)
8396 if (ob && SvOBJECT(sv)) {
8397 if (HvNAME(SvSTASH(sv)))
8398 return HvNAME(SvSTASH(sv));
8403 switch (SvTYPE(sv)) {
8420 case SVt_PVLV: return SvROK(sv) ? "REF"
8421 /* tied lvalues should appear to be
8422 * scalars for backwards compatitbility */
8423 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8424 ? "SCALAR" : "LVALUE";
8425 case SVt_PVAV: return "ARRAY";
8426 case SVt_PVHV: return "HASH";
8427 case SVt_PVCV: return "CODE";
8428 case SVt_PVGV: return "GLOB";
8429 case SVt_PVFM: return "FORMAT";
8430 case SVt_PVIO: return "IO";
8431 default: return "UNKNOWN";
8437 =for apidoc sv_isobject
8439 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8440 object. If the SV is not an RV, or if the object is not blessed, then this
8447 Perl_sv_isobject(pTHX_ SV *sv)
8464 Returns a boolean indicating whether the SV is blessed into the specified
8465 class. This does not check for subtypes; use C<sv_derived_from> to verify
8466 an inheritance relationship.
8472 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8483 if (!HvNAME(SvSTASH(sv)))
8486 return strEQ(HvNAME(SvSTASH(sv)), name);
8492 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8493 it will be upgraded to one. If C<classname> is non-null then the new SV will
8494 be blessed in the specified package. The new SV is returned and its
8495 reference count is 1.
8501 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8507 SV_CHECK_THINKFIRST_COW_DROP(rv);
8510 if (SvTYPE(rv) >= SVt_PVMG) {
8511 U32 refcnt = SvREFCNT(rv);
8515 SvREFCNT(rv) = refcnt;
8518 if (SvTYPE(rv) < SVt_RV)
8519 sv_upgrade(rv, SVt_RV);
8520 else if (SvTYPE(rv) > SVt_RV) {
8521 (void)SvOOK_off(rv);
8522 if (SvPVX(rv) && SvLEN(rv))
8523 Safefree(SvPVX(rv));
8533 HV* stash = gv_stashpv(classname, TRUE);
8534 (void)sv_bless(rv, stash);
8540 =for apidoc sv_setref_pv
8542 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8543 argument will be upgraded to an RV. That RV will be modified to point to
8544 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8545 into the SV. The C<classname> argument indicates the package for the
8546 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8547 will have a reference count of 1, and the RV will be returned.
8549 Do not use with other Perl types such as HV, AV, SV, CV, because those
8550 objects will become corrupted by the pointer copy process.
8552 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8558 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8561 sv_setsv(rv, &PL_sv_undef);
8565 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8570 =for apidoc sv_setref_iv
8572 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8573 argument will be upgraded to an RV. That RV will be modified to point to
8574 the new SV. The C<classname> argument indicates the package for the
8575 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8576 will have a reference count of 1, and the RV will be returned.
8582 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8584 sv_setiv(newSVrv(rv,classname), iv);
8589 =for apidoc sv_setref_uv
8591 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8592 argument will be upgraded to an RV. That RV will be modified to point to
8593 the new SV. The C<classname> argument indicates the package for the
8594 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8595 will have a reference count of 1, and the RV will be returned.
8601 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8603 sv_setuv(newSVrv(rv,classname), uv);
8608 =for apidoc sv_setref_nv
8610 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8611 argument will be upgraded to an RV. That RV will be modified to point to
8612 the new SV. The C<classname> argument indicates the package for the
8613 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8614 will have a reference count of 1, and the RV will be returned.
8620 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8622 sv_setnv(newSVrv(rv,classname), nv);
8627 =for apidoc sv_setref_pvn
8629 Copies a string into a new SV, optionally blessing the SV. The length of the
8630 string must be specified with C<n>. The C<rv> argument will be upgraded to
8631 an RV. That RV will be modified to point to the new SV. The C<classname>
8632 argument indicates the package for the blessing. Set C<classname> to
8633 C<Nullch> to avoid the blessing. The new SV will have a reference count
8634 of 1, and the RV will be returned.
8636 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8642 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8644 sv_setpvn(newSVrv(rv,classname), pv, n);
8649 =for apidoc sv_bless
8651 Blesses an SV into a specified package. The SV must be an RV. The package
8652 must be designated by its stash (see C<gv_stashpv()>). The reference count
8653 of the SV is unaffected.
8659 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8663 Perl_croak(aTHX_ "Can't bless non-reference value");
8665 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8666 if (SvREADONLY(tmpRef))
8667 Perl_croak(aTHX_ PL_no_modify);
8668 if (SvOBJECT(tmpRef)) {
8669 if (SvTYPE(tmpRef) != SVt_PVIO)
8671 SvREFCNT_dec(SvSTASH(tmpRef));
8674 SvOBJECT_on(tmpRef);
8675 if (SvTYPE(tmpRef) != SVt_PVIO)
8677 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8678 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8685 if(SvSMAGICAL(tmpRef))
8686 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8694 /* Downgrades a PVGV to a PVMG.
8698 S_sv_unglob(pTHX_ SV *sv)
8702 assert(SvTYPE(sv) == SVt_PVGV);
8707 SvREFCNT_dec(GvSTASH(sv));
8708 GvSTASH(sv) = Nullhv;
8710 sv_unmagic(sv, PERL_MAGIC_glob);
8711 Safefree(GvNAME(sv));
8714 /* need to keep SvANY(sv) in the right arena */
8715 xpvmg = new_XPVMG();
8716 StructCopy(SvANY(sv), xpvmg, XPVMG);
8717 del_XPVGV(SvANY(sv));
8720 SvFLAGS(sv) &= ~SVTYPEMASK;
8721 SvFLAGS(sv) |= SVt_PVMG;
8725 =for apidoc sv_unref_flags
8727 Unsets the RV status of the SV, and decrements the reference count of
8728 whatever was being referenced by the RV. This can almost be thought of
8729 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8730 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8731 (otherwise the decrementing is conditional on the reference count being
8732 different from one or the reference being a readonly SV).
8739 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8743 if (SvWEAKREF(sv)) {
8751 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8752 assigned to as BEGIN {$a = \"Foo"} will fail. */
8753 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8755 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8756 sv_2mortal(rv); /* Schedule for freeing later */
8760 =for apidoc sv_unref
8762 Unsets the RV status of the SV, and decrements the reference count of
8763 whatever was being referenced by the RV. This can almost be thought of
8764 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8765 being zero. See C<SvROK_off>.
8771 Perl_sv_unref(pTHX_ SV *sv)
8773 sv_unref_flags(sv, 0);
8777 =for apidoc sv_taint
8779 Taint an SV. Use C<SvTAINTED_on> instead.
8784 Perl_sv_taint(pTHX_ SV *sv)
8786 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8790 =for apidoc sv_untaint
8792 Untaint an SV. Use C<SvTAINTED_off> instead.
8797 Perl_sv_untaint(pTHX_ SV *sv)
8799 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8800 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8807 =for apidoc sv_tainted
8809 Test an SV for taintedness. Use C<SvTAINTED> instead.
8814 Perl_sv_tainted(pTHX_ SV *sv)
8816 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8817 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8818 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8825 =for apidoc sv_setpviv
8827 Copies an integer into the given SV, also updating its string value.
8828 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8834 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8836 char buf[TYPE_CHARS(UV)];
8838 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8840 sv_setpvn(sv, ptr, ebuf - ptr);
8844 =for apidoc sv_setpviv_mg
8846 Like C<sv_setpviv>, but also handles 'set' magic.
8852 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8854 char buf[TYPE_CHARS(UV)];
8856 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8858 sv_setpvn(sv, ptr, ebuf - ptr);
8862 #if defined(PERL_IMPLICIT_CONTEXT)
8864 /* pTHX_ magic can't cope with varargs, so this is a no-context
8865 * version of the main function, (which may itself be aliased to us).
8866 * Don't access this version directly.
8870 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8874 va_start(args, pat);
8875 sv_vsetpvf(sv, pat, &args);
8879 /* pTHX_ magic can't cope with varargs, so this is a no-context
8880 * version of the main function, (which may itself be aliased to us).
8881 * Don't access this version directly.
8885 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8889 va_start(args, pat);
8890 sv_vsetpvf_mg(sv, pat, &args);
8896 =for apidoc sv_setpvf
8898 Processes its arguments like C<sprintf> and sets an SV to the formatted
8899 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8905 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8908 va_start(args, pat);
8909 sv_vsetpvf(sv, pat, &args);
8913 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8916 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8918 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8922 =for apidoc sv_setpvf_mg
8924 Like C<sv_setpvf>, but also handles 'set' magic.
8930 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8933 va_start(args, pat);
8934 sv_vsetpvf_mg(sv, pat, &args);
8938 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8941 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8943 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8947 #if defined(PERL_IMPLICIT_CONTEXT)
8949 /* pTHX_ magic can't cope with varargs, so this is a no-context
8950 * version of the main function, (which may itself be aliased to us).
8951 * Don't access this version directly.
8955 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8959 va_start(args, pat);
8960 sv_vcatpvf(sv, pat, &args);
8964 /* pTHX_ magic can't cope with varargs, so this is a no-context
8965 * version of the main function, (which may itself be aliased to us).
8966 * Don't access this version directly.
8970 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8974 va_start(args, pat);
8975 sv_vcatpvf_mg(sv, pat, &args);
8981 =for apidoc sv_catpvf
8983 Processes its arguments like C<sprintf> and appends the formatted
8984 output to an SV. If the appended data contains "wide" characters
8985 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8986 and characters >255 formatted with %c), the original SV might get
8987 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8988 C<SvSETMAGIC()> must typically be called after calling this function
8989 to handle 'set' magic.
8994 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8997 va_start(args, pat);
8998 sv_vcatpvf(sv, pat, &args);
9002 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
9005 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9007 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9011 =for apidoc sv_catpvf_mg
9013 Like C<sv_catpvf>, but also handles 'set' magic.
9019 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9022 va_start(args, pat);
9023 sv_vcatpvf_mg(sv, pat, &args);
9027 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
9030 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9032 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9037 =for apidoc sv_vsetpvfn
9039 Works like C<vcatpvfn> but copies the text into the SV instead of
9042 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
9048 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9050 sv_setpvn(sv, "", 0);
9051 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9054 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9057 S_expect_number(pTHX_ char** pattern)
9060 switch (**pattern) {
9061 case '1': case '2': case '3':
9062 case '4': case '5': case '6':
9063 case '7': case '8': case '9':
9064 while (isDIGIT(**pattern))
9065 var = var * 10 + (*(*pattern)++ - '0');
9069 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9072 F0convert(NV nv, char *endbuf, STRLEN *len)
9083 if (uv & 1 && uv == nv)
9084 uv--; /* Round to even */
9086 unsigned dig = uv % 10;
9099 =for apidoc sv_vcatpvfn
9101 Processes its arguments like C<vsprintf> and appends the formatted output
9102 to an SV. Uses an array of SVs if the C style variable argument list is
9103 missing (NULL). When running with taint checks enabled, indicates via
9104 C<maybe_tainted> if results are untrustworthy (often due to the use of
9107 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
9113 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9120 static char nullstr[] = "(null)";
9122 bool has_utf8; /* has the result utf8? */
9123 bool pat_utf8; /* the pattern is in utf8? */
9125 /* Times 4: a decimal digit takes more than 3 binary digits.
9126 * NV_DIG: mantissa takes than many decimal digits.
9127 * Plus 32: Playing safe. */
9128 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9129 /* large enough for "%#.#f" --chip */
9130 /* what about long double NVs? --jhi */
9132 has_utf8 = pat_utf8 = DO_UTF8(sv);
9134 /* no matter what, this is a string now */
9135 (void)SvPV_force(sv, origlen);
9137 /* special-case "", "%s", and "%_" */
9140 if (patlen == 2 && pat[0] == '%') {
9144 char *s = va_arg(*args, char*);
9145 sv_catpv(sv, s ? s : nullstr);
9147 else if (svix < svmax) {
9148 sv_catsv(sv, *svargs);
9149 if (DO_UTF8(*svargs))
9155 argsv = va_arg(*args, SV*);
9156 sv_catsv(sv, argsv);
9161 /* See comment on '_' below */
9166 #ifndef USE_LONG_DOUBLE
9167 /* special-case "%.<number>[gf]" */
9168 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9169 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9170 unsigned digits = 0;
9174 while (*pp >= '0' && *pp <= '9')
9175 digits = 10 * digits + (*pp++ - '0');
9176 if (pp - pat == (int)patlen - 1) {
9180 nv = (NV)va_arg(*args, double);
9181 else if (svix < svmax)
9186 /* Add check for digits != 0 because it seems that some
9187 gconverts are buggy in this case, and we don't yet have
9188 a Configure test for this. */
9189 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9190 /* 0, point, slack */
9191 Gconvert(nv, (int)digits, 0, ebuf);
9193 if (*ebuf) /* May return an empty string for digits==0 */
9196 } else if (!digits) {
9199 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9200 sv_catpvn(sv, p, l);
9206 #endif /* !USE_LONG_DOUBLE */
9208 if (!args && svix < svmax && DO_UTF8(*svargs))
9211 patend = (char*)pat + patlen;
9212 for (p = (char*)pat; p < patend; p = q) {
9215 bool vectorize = FALSE;
9216 bool vectorarg = FALSE;
9217 bool vec_utf8 = FALSE;
9223 bool has_precis = FALSE;
9226 bool is_utf8 = FALSE; /* is this item utf8? */
9227 #ifdef HAS_LDBL_SPRINTF_BUG
9228 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9229 with sfio - Allen <allens@cpan.org> */
9230 bool fix_ldbl_sprintf_bug = FALSE;
9234 U8 utf8buf[UTF8_MAXLEN+1];
9235 STRLEN esignlen = 0;
9237 char *eptr = Nullch;
9240 U8 *vecstr = Null(U8*);
9247 /* we need a long double target in case HAS_LONG_DOUBLE but
9250 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9259 STRLEN dotstrlen = 1;
9260 I32 efix = 0; /* explicit format parameter index */
9261 I32 ewix = 0; /* explicit width index */
9262 I32 epix = 0; /* explicit precision index */
9263 I32 evix = 0; /* explicit vector index */
9264 bool asterisk = FALSE;
9266 /* echo everything up to the next format specification */
9267 for (q = p; q < patend && *q != '%'; ++q) ;
9269 if (has_utf8 && !pat_utf8)
9270 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9272 sv_catpvn(sv, p, q - p);
9279 We allow format specification elements in this order:
9280 \d+\$ explicit format parameter index
9282 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9283 0 flag (as above): repeated to allow "v02"
9284 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9285 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9287 [%bcdefginopsux_DFOUX] format (mandatory)
9289 if (EXPECT_NUMBER(q, width)) {
9330 if (EXPECT_NUMBER(q, ewix))
9339 if ((vectorarg = asterisk)) {
9351 EXPECT_NUMBER(q, width);
9356 vecsv = va_arg(*args, SV*);
9358 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9359 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9360 dotstr = SvPVx(vecsv, dotstrlen);
9365 vecsv = va_arg(*args, SV*);
9366 vecstr = (U8*)SvPVx(vecsv,veclen);
9367 vec_utf8 = DO_UTF8(vecsv);
9369 else if (efix ? efix <= svmax : svix < svmax) {
9370 vecsv = svargs[efix ? efix-1 : svix++];
9371 vecstr = (U8*)SvPVx(vecsv,veclen);
9372 vec_utf8 = DO_UTF8(vecsv);
9382 i = va_arg(*args, int);
9384 i = (ewix ? ewix <= svmax : svix < svmax) ?
9385 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9387 width = (i < 0) ? -i : i;
9397 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9399 /* XXX: todo, support specified precision parameter */
9403 i = va_arg(*args, int);
9405 i = (ewix ? ewix <= svmax : svix < svmax)
9406 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9407 precis = (i < 0) ? 0 : i;
9412 precis = precis * 10 + (*q++ - '0');
9421 case 'I': /* Ix, I32x, and I64x */
9423 if (q[1] == '6' && q[2] == '4') {
9429 if (q[1] == '3' && q[2] == '2') {
9439 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9450 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9451 if (*(q + 1) == 'l') { /* lld, llf */
9476 argsv = (efix ? efix <= svmax : svix < svmax) ?
9477 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9484 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9486 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9488 eptr = (char*)utf8buf;
9489 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9500 if (args && !vectorize) {
9501 eptr = va_arg(*args, char*);
9503 #ifdef MACOS_TRADITIONAL
9504 /* On MacOS, %#s format is used for Pascal strings */
9509 elen = strlen(eptr);
9512 elen = sizeof nullstr - 1;
9516 eptr = SvPVx(argsv, elen);
9517 if (DO_UTF8(argsv)) {
9518 if (has_precis && precis < elen) {
9520 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9523 if (width) { /* fudge width (can't fudge elen) */
9524 width += elen - sv_len_utf8(argsv);
9533 * The "%_" hack might have to be changed someday,
9534 * if ISO or ANSI decide to use '_' for something.
9535 * So we keep it hidden from users' code.
9537 if (!args || vectorize)
9539 argsv = va_arg(*args, SV*);
9540 eptr = SvPVx(argsv, elen);
9546 if (has_precis && elen > precis)
9553 if (alt || vectorize)
9555 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9573 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9582 esignbuf[esignlen++] = plus;
9586 case 'h': iv = (short)va_arg(*args, int); break;
9587 case 'l': iv = va_arg(*args, long); break;
9588 case 'V': iv = va_arg(*args, IV); break;
9589 default: iv = va_arg(*args, int); break;
9591 case 'q': iv = va_arg(*args, Quad_t); break;
9596 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9598 case 'h': iv = (short)tiv; break;
9599 case 'l': iv = (long)tiv; break;
9601 default: iv = tiv; break;
9603 case 'q': iv = (Quad_t)tiv; break;
9607 if ( !vectorize ) /* we already set uv above */
9612 esignbuf[esignlen++] = plus;
9616 esignbuf[esignlen++] = '-';
9659 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9670 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9671 case 'l': uv = va_arg(*args, unsigned long); break;
9672 case 'V': uv = va_arg(*args, UV); break;
9673 default: uv = va_arg(*args, unsigned); break;
9675 case 'q': uv = va_arg(*args, Uquad_t); break;
9680 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9682 case 'h': uv = (unsigned short)tuv; break;
9683 case 'l': uv = (unsigned long)tuv; break;
9685 default: uv = tuv; break;
9687 case 'q': uv = (Uquad_t)tuv; break;
9693 eptr = ebuf + sizeof ebuf;
9699 p = (char*)((c == 'X')
9700 ? "0123456789ABCDEF" : "0123456789abcdef");
9706 esignbuf[esignlen++] = '0';
9707 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9713 *--eptr = '0' + dig;
9715 if (alt && *eptr != '0')
9721 *--eptr = '0' + dig;
9724 esignbuf[esignlen++] = '0';
9725 esignbuf[esignlen++] = 'b';
9728 default: /* it had better be ten or less */
9729 #if defined(PERL_Y2KWARN)
9730 if (ckWARN(WARN_Y2K)) {
9732 char *s = SvPV(sv,n);
9733 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9734 && (n == 2 || !isDIGIT(s[n-3])))
9736 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9737 "Possible Y2K bug: %%%c %s",
9738 c, "format string following '19'");
9744 *--eptr = '0' + dig;
9745 } while (uv /= base);
9748 elen = (ebuf + sizeof ebuf) - eptr;
9751 zeros = precis - elen;
9752 else if (precis == 0 && elen == 1 && *eptr == '0')
9757 /* FLOATING POINT */
9760 c = 'f'; /* maybe %F isn't supported here */
9766 /* This is evil, but floating point is even more evil */
9768 /* for SV-style calling, we can only get NV
9769 for C-style calling, we assume %f is double;
9770 for simplicity we allow any of %Lf, %llf, %qf for long double
9774 #if defined(USE_LONG_DOUBLE)
9778 /* [perl #20339] - we should accept and ignore %lf rather than die */
9782 #if defined(USE_LONG_DOUBLE)
9783 intsize = args ? 0 : 'q';
9787 #if defined(HAS_LONG_DOUBLE)
9796 /* now we need (long double) if intsize == 'q', else (double) */
9797 nv = (args && !vectorize) ?
9798 #if LONG_DOUBLESIZE > DOUBLESIZE
9800 va_arg(*args, long double) :
9801 va_arg(*args, double)
9803 va_arg(*args, double)
9809 if (c != 'e' && c != 'E') {
9811 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9812 will cast our (long double) to (double) */
9813 (void)Perl_frexp(nv, &i);
9814 if (i == PERL_INT_MIN)
9815 Perl_die(aTHX_ "panic: frexp");
9817 need = BIT_DIGITS(i);
9819 need += has_precis ? precis : 6; /* known default */
9824 #ifdef HAS_LDBL_SPRINTF_BUG
9825 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9826 with sfio - Allen <allens@cpan.org> */
9829 # define MY_DBL_MAX DBL_MAX
9830 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9831 # if DOUBLESIZE >= 8
9832 # define MY_DBL_MAX 1.7976931348623157E+308L
9834 # define MY_DBL_MAX 3.40282347E+38L
9838 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9839 # define MY_DBL_MAX_BUG 1L
9841 # define MY_DBL_MAX_BUG MY_DBL_MAX
9845 # define MY_DBL_MIN DBL_MIN
9846 # else /* XXX guessing! -Allen */
9847 # if DOUBLESIZE >= 8
9848 # define MY_DBL_MIN 2.2250738585072014E-308L
9850 # define MY_DBL_MIN 1.17549435E-38L
9854 if ((intsize == 'q') && (c == 'f') &&
9855 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9857 /* it's going to be short enough that
9858 * long double precision is not needed */
9860 if ((nv <= 0L) && (nv >= -0L))
9861 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9863 /* would use Perl_fp_class as a double-check but not
9864 * functional on IRIX - see perl.h comments */
9866 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9867 /* It's within the range that a double can represent */
9868 #if defined(DBL_MAX) && !defined(DBL_MIN)
9869 if ((nv >= ((long double)1/DBL_MAX)) ||
9870 (nv <= (-(long double)1/DBL_MAX)))
9872 fix_ldbl_sprintf_bug = TRUE;
9875 if (fix_ldbl_sprintf_bug == TRUE) {
9885 # undef MY_DBL_MAX_BUG
9888 #endif /* HAS_LDBL_SPRINTF_BUG */
9890 need += 20; /* fudge factor */
9891 if (PL_efloatsize < need) {
9892 Safefree(PL_efloatbuf);
9893 PL_efloatsize = need + 20; /* more fudge */
9894 New(906, PL_efloatbuf, PL_efloatsize, char);
9895 PL_efloatbuf[0] = '\0';
9898 if ( !(width || left || plus || alt) && fill != '0'
9899 && has_precis && intsize != 'q' ) { /* Shortcuts */
9900 /* See earlier comment about buggy Gconvert when digits,
9902 if ( c == 'g' && precis) {
9903 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9904 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9905 goto float_converted;
9906 } else if ( c == 'f' && !precis) {
9907 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9911 eptr = ebuf + sizeof ebuf;
9914 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9915 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9916 if (intsize == 'q') {
9917 /* Copy the one or more characters in a long double
9918 * format before the 'base' ([efgEFG]) character to
9919 * the format string. */
9920 static char const prifldbl[] = PERL_PRIfldbl;
9921 char const *p = prifldbl + sizeof(prifldbl) - 3;
9922 while (p >= prifldbl) { *--eptr = *p--; }
9927 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9932 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9944 /* No taint. Otherwise we are in the strange situation
9945 * where printf() taints but print($float) doesn't.
9947 #if defined(HAS_LONG_DOUBLE)
9949 (void)sprintf(PL_efloatbuf, eptr, nv);
9951 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9953 (void)sprintf(PL_efloatbuf, eptr, nv);
9956 eptr = PL_efloatbuf;
9957 elen = strlen(PL_efloatbuf);
9963 i = SvCUR(sv) - origlen;
9964 if (args && !vectorize) {
9966 case 'h': *(va_arg(*args, short*)) = i; break;
9967 default: *(va_arg(*args, int*)) = i; break;
9968 case 'l': *(va_arg(*args, long*)) = i; break;
9969 case 'V': *(va_arg(*args, IV*)) = i; break;
9971 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9976 sv_setuv_mg(argsv, (UV)i);
9978 continue; /* not "break" */
9984 if (!args && ckWARN(WARN_PRINTF) &&
9985 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9986 SV *msg = sv_newmortal();
9987 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9988 (PL_op->op_type == OP_PRTF) ? "" : "s");
9991 Perl_sv_catpvf(aTHX_ msg,
9992 "\"%%%c\"", c & 0xFF);
9994 Perl_sv_catpvf(aTHX_ msg,
9995 "\"%%\\%03"UVof"\"",
9998 sv_catpv(msg, "end of string");
9999 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10002 /* output mangled stuff ... */
10008 /* ... right here, because formatting flags should not apply */
10009 SvGROW(sv, SvCUR(sv) + elen + 1);
10011 Copy(eptr, p, elen, char);
10014 SvCUR(sv) = p - SvPVX(sv);
10016 continue; /* not "break" */
10019 /* calculate width before utf8_upgrade changes it */
10020 have = esignlen + zeros + elen;
10022 if (is_utf8 != has_utf8) {
10025 sv_utf8_upgrade(sv);
10028 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10029 sv_utf8_upgrade(nsv);
10033 SvGROW(sv, SvCUR(sv) + elen + 1);
10037 /* Use memchr() instead of strchr(), as eptr is not guaranteed */
10038 /* to point to a null-terminated string. */
10039 if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
10040 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
10041 Perl_warner(aTHX_ packWARN(WARN_PRINTF),
10042 "Newline in left-justified string for %sprintf",
10043 (PL_op->op_type == OP_PRTF) ? "" : "s");
10045 need = (have > width ? have : width);
10048 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10050 if (esignlen && fill == '0') {
10051 for (i = 0; i < (int)esignlen; i++)
10052 *p++ = esignbuf[i];
10054 if (gap && !left) {
10055 memset(p, fill, gap);
10058 if (esignlen && fill != '0') {
10059 for (i = 0; i < (int)esignlen; i++)
10060 *p++ = esignbuf[i];
10063 for (i = zeros; i; i--)
10067 Copy(eptr, p, elen, char);
10071 memset(p, ' ', gap);
10076 Copy(dotstr, p, dotstrlen, char);
10080 vectorize = FALSE; /* done iterating over vecstr */
10087 SvCUR(sv) = p - SvPVX(sv);
10095 /* =========================================================================
10097 =head1 Cloning an interpreter
10099 All the macros and functions in this section are for the private use of
10100 the main function, perl_clone().
10102 The foo_dup() functions make an exact copy of an existing foo thinngy.
10103 During the course of a cloning, a hash table is used to map old addresses
10104 to new addresses. The table is created and manipulated with the
10105 ptr_table_* functions.
10109 ============================================================================*/
10112 #if defined(USE_ITHREADS)
10114 #ifndef GpREFCNT_inc
10115 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10119 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10120 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10121 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10122 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10123 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10124 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10125 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10126 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10127 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10128 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10129 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10130 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10131 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10134 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10135 regcomp.c. AMS 20010712 */
10138 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10142 struct reg_substr_datum *s;
10145 return (REGEXP *)NULL;
10147 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10150 len = r->offsets[0];
10151 npar = r->nparens+1;
10153 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10154 Copy(r->program, ret->program, len+1, regnode);
10156 New(0, ret->startp, npar, I32);
10157 Copy(r->startp, ret->startp, npar, I32);
10158 New(0, ret->endp, npar, I32);
10159 Copy(r->startp, ret->startp, npar, I32);
10161 New(0, ret->substrs, 1, struct reg_substr_data);
10162 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10163 s->min_offset = r->substrs->data[i].min_offset;
10164 s->max_offset = r->substrs->data[i].max_offset;
10165 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10166 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10169 ret->regstclass = NULL;
10171 struct reg_data *d;
10172 int count = r->data->count;
10174 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10175 char, struct reg_data);
10176 New(0, d->what, count, U8);
10179 for (i = 0; i < count; i++) {
10180 d->what[i] = r->data->what[i];
10181 switch (d->what[i]) {
10183 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10186 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10189 /* This is cheating. */
10190 New(0, d->data[i], 1, struct regnode_charclass_class);
10191 StructCopy(r->data->data[i], d->data[i],
10192 struct regnode_charclass_class);
10193 ret->regstclass = (regnode*)d->data[i];
10196 /* Compiled op trees are readonly, and can thus be
10197 shared without duplication. */
10198 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10201 d->data[i] = r->data->data[i];
10211 New(0, ret->offsets, 2*len+1, U32);
10212 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10214 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10215 ret->refcnt = r->refcnt;
10216 ret->minlen = r->minlen;
10217 ret->prelen = r->prelen;
10218 ret->nparens = r->nparens;
10219 ret->lastparen = r->lastparen;
10220 ret->lastcloseparen = r->lastcloseparen;
10221 ret->reganch = r->reganch;
10223 ret->sublen = r->sublen;
10225 if (RX_MATCH_COPIED(ret))
10226 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10228 ret->subbeg = Nullch;
10229 #ifdef PERL_COPY_ON_WRITE
10230 ret->saved_copy = Nullsv;
10233 ptr_table_store(PL_ptr_table, r, ret);
10237 /* duplicate a file handle */
10240 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10244 return (PerlIO*)NULL;
10246 /* look for it in the table first */
10247 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10251 /* create anew and remember what it is */
10252 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10253 ptr_table_store(PL_ptr_table, fp, ret);
10257 /* duplicate a directory handle */
10260 Perl_dirp_dup(pTHX_ DIR *dp)
10268 /* duplicate a typeglob */
10271 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10276 /* look for it in the table first */
10277 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10281 /* create anew and remember what it is */
10282 Newz(0, ret, 1, GP);
10283 ptr_table_store(PL_ptr_table, gp, ret);
10286 ret->gp_refcnt = 0; /* must be before any other dups! */
10287 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10288 ret->gp_io = io_dup_inc(gp->gp_io, param);
10289 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10290 ret->gp_av = av_dup_inc(gp->gp_av, param);
10291 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10292 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10293 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10294 ret->gp_cvgen = gp->gp_cvgen;
10295 ret->gp_flags = gp->gp_flags;
10296 ret->gp_line = gp->gp_line;
10297 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10301 /* duplicate a chain of magic */
10304 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10306 MAGIC *mgprev = (MAGIC*)NULL;
10309 return (MAGIC*)NULL;
10310 /* look for it in the table first */
10311 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10315 for (; mg; mg = mg->mg_moremagic) {
10317 Newz(0, nmg, 1, MAGIC);
10319 mgprev->mg_moremagic = nmg;
10322 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10323 nmg->mg_private = mg->mg_private;
10324 nmg->mg_type = mg->mg_type;
10325 nmg->mg_flags = mg->mg_flags;
10326 if (mg->mg_type == PERL_MAGIC_qr) {
10327 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10329 else if(mg->mg_type == PERL_MAGIC_backref) {
10330 AV *av = (AV*) mg->mg_obj;
10333 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10335 for (i = AvFILLp(av); i >= 0; i--) {
10336 if (!svp[i]) continue;
10337 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10341 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10342 ? sv_dup_inc(mg->mg_obj, param)
10343 : sv_dup(mg->mg_obj, param);
10345 nmg->mg_len = mg->mg_len;
10346 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10347 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10348 if (mg->mg_len > 0) {
10349 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10350 if (mg->mg_type == PERL_MAGIC_overload_table &&
10351 AMT_AMAGIC((AMT*)mg->mg_ptr))
10353 AMT *amtp = (AMT*)mg->mg_ptr;
10354 AMT *namtp = (AMT*)nmg->mg_ptr;
10356 for (i = 1; i < NofAMmeth; i++) {
10357 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10361 else if (mg->mg_len == HEf_SVKEY)
10362 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10364 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10365 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10372 /* create a new pointer-mapping table */
10375 Perl_ptr_table_new(pTHX)
10378 Newz(0, tbl, 1, PTR_TBL_t);
10379 tbl->tbl_max = 511;
10380 tbl->tbl_items = 0;
10381 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10386 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10388 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10391 /* map an existing pointer using a table */
10394 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10396 PTR_TBL_ENT_t *tblent;
10397 UV hash = PTR_TABLE_HASH(sv);
10399 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10400 for (; tblent; tblent = tblent->next) {
10401 if (tblent->oldval == sv)
10402 return tblent->newval;
10404 return (void*)NULL;
10407 /* add a new entry to a pointer-mapping table */
10410 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10412 PTR_TBL_ENT_t *tblent, **otblent;
10413 /* XXX this may be pessimal on platforms where pointers aren't good
10414 * hash values e.g. if they grow faster in the most significant
10416 UV hash = PTR_TABLE_HASH(oldv);
10420 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10421 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10422 if (tblent->oldval == oldv) {
10423 tblent->newval = newv;
10427 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10428 tblent->oldval = oldv;
10429 tblent->newval = newv;
10430 tblent->next = *otblent;
10433 if (!empty && tbl->tbl_items > tbl->tbl_max)
10434 ptr_table_split(tbl);
10437 /* double the hash bucket size of an existing ptr table */
10440 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10442 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10443 UV oldsize = tbl->tbl_max + 1;
10444 UV newsize = oldsize * 2;
10447 Renew(ary, newsize, PTR_TBL_ENT_t*);
10448 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10449 tbl->tbl_max = --newsize;
10450 tbl->tbl_ary = ary;
10451 for (i=0; i < oldsize; i++, ary++) {
10452 PTR_TBL_ENT_t **curentp, **entp, *ent;
10455 curentp = ary + oldsize;
10456 for (entp = ary, ent = *ary; ent; ent = *entp) {
10457 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10459 ent->next = *curentp;
10469 /* remove all the entries from a ptr table */
10472 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10474 register PTR_TBL_ENT_t **array;
10475 register PTR_TBL_ENT_t *entry;
10476 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10480 if (!tbl || !tbl->tbl_items) {
10484 array = tbl->tbl_ary;
10486 max = tbl->tbl_max;
10491 entry = entry->next;
10495 if (++riter > max) {
10498 entry = array[riter];
10502 tbl->tbl_items = 0;
10505 /* clear and free a ptr table */
10508 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10513 ptr_table_clear(tbl);
10514 Safefree(tbl->tbl_ary);
10519 char *PL_watch_pvx;
10522 /* attempt to make everything in the typeglob readonly */
10525 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10527 GV *gv = (GV*)sstr;
10528 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10530 if (GvIO(gv) || GvFORM(gv)) {
10531 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10533 else if (!GvCV(gv)) {
10534 GvCV(gv) = (CV*)sv;
10537 /* CvPADLISTs cannot be shared */
10538 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10543 if (!GvUNIQUE(gv)) {
10545 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10546 HvNAME(GvSTASH(gv)), GvNAME(gv));
10552 * write attempts will die with
10553 * "Modification of a read-only value attempted"
10559 SvREADONLY_on(GvSV(gv));
10563 GvAV(gv) = (AV*)sv;
10566 SvREADONLY_on(GvAV(gv));
10570 GvHV(gv) = (HV*)sv;
10573 SvREADONLY_on(GvHV(gv));
10576 return sstr; /* he_dup() will SvREFCNT_inc() */
10579 /* duplicate an SV of any type (including AV, HV etc) */
10582 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10585 SvRV(dstr) = SvWEAKREF(sstr)
10586 ? sv_dup(SvRV(sstr), param)
10587 : sv_dup_inc(SvRV(sstr), param);
10589 else if (SvPVX(sstr)) {
10590 /* Has something there */
10592 /* Normal PV - clone whole allocated space */
10593 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10594 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10595 /* Not that normal - actually sstr is copy on write.
10596 But we are a true, independant SV, so: */
10597 SvREADONLY_off(dstr);
10602 /* Special case - not normally malloced for some reason */
10603 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10604 /* A "shared" PV - clone it as unshared string */
10605 if(SvPADTMP(sstr)) {
10606 /* However, some of them live in the pad
10607 and they should not have these flags
10610 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10612 SvUVX(dstr) = SvUVX(sstr);
10615 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10617 SvREADONLY_off(dstr);
10621 /* Some other special case - random pointer */
10622 SvPVX(dstr) = SvPVX(sstr);
10627 /* Copy the Null */
10628 SvPVX(dstr) = SvPVX(sstr);
10633 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10637 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10639 /* look for it in the table first */
10640 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10644 if(param->flags & CLONEf_JOIN_IN) {
10645 /** We are joining here so we don't want do clone
10646 something that is bad **/
10648 if(SvTYPE(sstr) == SVt_PVHV &&
10650 /** don't clone stashes if they already exist **/
10651 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10652 return (SV*) old_stash;
10656 /* create anew and remember what it is */
10658 ptr_table_store(PL_ptr_table, sstr, dstr);
10661 SvFLAGS(dstr) = SvFLAGS(sstr);
10662 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10663 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10666 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10667 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10668 PL_watch_pvx, SvPVX(sstr));
10671 switch (SvTYPE(sstr)) {
10673 SvANY(dstr) = NULL;
10676 SvANY(dstr) = new_XIV();
10677 SvIVX(dstr) = SvIVX(sstr);
10680 SvANY(dstr) = new_XNV();
10681 SvNVX(dstr) = SvNVX(sstr);
10684 SvANY(dstr) = new_XRV();
10685 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10688 SvANY(dstr) = new_XPV();
10689 SvCUR(dstr) = SvCUR(sstr);
10690 SvLEN(dstr) = SvLEN(sstr);
10691 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10694 SvANY(dstr) = new_XPVIV();
10695 SvCUR(dstr) = SvCUR(sstr);
10696 SvLEN(dstr) = SvLEN(sstr);
10697 SvIVX(dstr) = SvIVX(sstr);
10698 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10701 SvANY(dstr) = new_XPVNV();
10702 SvCUR(dstr) = SvCUR(sstr);
10703 SvLEN(dstr) = SvLEN(sstr);
10704 SvIVX(dstr) = SvIVX(sstr);
10705 SvNVX(dstr) = SvNVX(sstr);
10706 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10709 SvANY(dstr) = new_XPVMG();
10710 SvCUR(dstr) = SvCUR(sstr);
10711 SvLEN(dstr) = SvLEN(sstr);
10712 SvIVX(dstr) = SvIVX(sstr);
10713 SvNVX(dstr) = SvNVX(sstr);
10714 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10715 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10716 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10719 SvANY(dstr) = new_XPVBM();
10720 SvCUR(dstr) = SvCUR(sstr);
10721 SvLEN(dstr) = SvLEN(sstr);
10722 SvIVX(dstr) = SvIVX(sstr);
10723 SvNVX(dstr) = SvNVX(sstr);
10724 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10725 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10726 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10727 BmRARE(dstr) = BmRARE(sstr);
10728 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10729 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10732 SvANY(dstr) = new_XPVLV();
10733 SvCUR(dstr) = SvCUR(sstr);
10734 SvLEN(dstr) = SvLEN(sstr);
10735 SvIVX(dstr) = SvIVX(sstr);
10736 SvNVX(dstr) = SvNVX(sstr);
10737 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10738 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10739 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10740 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10741 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10742 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10743 LvTARG(dstr) = dstr;
10744 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10745 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10747 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10748 LvTYPE(dstr) = LvTYPE(sstr);
10751 if (GvUNIQUE((GV*)sstr)) {
10753 if ((share = gv_share(sstr, param))) {
10756 ptr_table_store(PL_ptr_table, sstr, dstr);
10758 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10759 HvNAME(GvSTASH(share)), GvNAME(share));
10764 SvANY(dstr) = new_XPVGV();
10765 SvCUR(dstr) = SvCUR(sstr);
10766 SvLEN(dstr) = SvLEN(sstr);
10767 SvIVX(dstr) = SvIVX(sstr);
10768 SvNVX(dstr) = SvNVX(sstr);
10769 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10770 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10771 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10772 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10773 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10774 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10775 GvFLAGS(dstr) = GvFLAGS(sstr);
10776 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10777 (void)GpREFCNT_inc(GvGP(dstr));
10780 SvANY(dstr) = new_XPVIO();
10781 SvCUR(dstr) = SvCUR(sstr);
10782 SvLEN(dstr) = SvLEN(sstr);
10783 SvIVX(dstr) = SvIVX(sstr);
10784 SvNVX(dstr) = SvNVX(sstr);
10785 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10786 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10787 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10788 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10789 if (IoOFP(sstr) == IoIFP(sstr))
10790 IoOFP(dstr) = IoIFP(dstr);
10792 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10793 /* PL_rsfp_filters entries have fake IoDIRP() */
10794 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10795 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10797 IoDIRP(dstr) = IoDIRP(sstr);
10798 IoLINES(dstr) = IoLINES(sstr);
10799 IoPAGE(dstr) = IoPAGE(sstr);
10800 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10801 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10802 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10803 /* I have no idea why fake dirp (rsfps)
10804 should be treaded differently but otherwise
10805 we end up with leaks -- sky*/
10806 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10807 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10808 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10810 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10811 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10812 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10814 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10815 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10816 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10817 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10818 IoTYPE(dstr) = IoTYPE(sstr);
10819 IoFLAGS(dstr) = IoFLAGS(sstr);
10822 SvANY(dstr) = new_XPVAV();
10823 SvCUR(dstr) = SvCUR(sstr);
10824 SvLEN(dstr) = SvLEN(sstr);
10825 SvIVX(dstr) = SvIVX(sstr);
10826 SvNVX(dstr) = SvNVX(sstr);
10827 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10828 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10829 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10830 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10831 if (AvARRAY((AV*)sstr)) {
10832 SV **dst_ary, **src_ary;
10833 SSize_t items = AvFILLp((AV*)sstr) + 1;
10835 src_ary = AvARRAY((AV*)sstr);
10836 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10837 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10838 SvPVX(dstr) = (char*)dst_ary;
10839 AvALLOC((AV*)dstr) = dst_ary;
10840 if (AvREAL((AV*)sstr)) {
10841 while (items-- > 0)
10842 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10845 while (items-- > 0)
10846 *dst_ary++ = sv_dup(*src_ary++, param);
10848 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10849 while (items-- > 0) {
10850 *dst_ary++ = &PL_sv_undef;
10854 SvPVX(dstr) = Nullch;
10855 AvALLOC((AV*)dstr) = (SV**)NULL;
10859 SvANY(dstr) = new_XPVHV();
10860 SvCUR(dstr) = SvCUR(sstr);
10861 SvLEN(dstr) = SvLEN(sstr);
10862 SvIVX(dstr) = SvIVX(sstr);
10863 SvNVX(dstr) = SvNVX(sstr);
10864 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10865 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10866 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10867 if (HvARRAY((HV*)sstr)) {
10869 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10870 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10871 Newz(0, dxhv->xhv_array,
10872 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10873 while (i <= sxhv->xhv_max) {
10874 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10875 (bool)!!HvSHAREKEYS(sstr),
10879 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10880 (bool)!!HvSHAREKEYS(sstr), param);
10883 SvPVX(dstr) = Nullch;
10884 HvEITER((HV*)dstr) = (HE*)NULL;
10886 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10887 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10888 /* Record stashes for possible cloning in Perl_clone(). */
10889 if(HvNAME((HV*)dstr))
10890 av_push(param->stashes, dstr);
10893 SvANY(dstr) = new_XPVFM();
10894 FmLINES(dstr) = FmLINES(sstr);
10898 SvANY(dstr) = new_XPVCV();
10900 SvCUR(dstr) = SvCUR(sstr);
10901 SvLEN(dstr) = SvLEN(sstr);
10902 SvIVX(dstr) = SvIVX(sstr);
10903 SvNVX(dstr) = SvNVX(sstr);
10904 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10905 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10906 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10907 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10908 CvSTART(dstr) = CvSTART(sstr);
10909 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10910 CvXSUB(dstr) = CvXSUB(sstr);
10911 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10912 if (CvCONST(sstr)) {
10913 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10914 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10915 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10917 /* don't dup if copying back - CvGV isn't refcounted, so the
10918 * duped GV may never be freed. A bit of a hack! DAPM */
10919 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10920 Nullgv : gv_dup(CvGV(sstr), param) ;
10921 if (param->flags & CLONEf_COPY_STACKS) {
10922 CvDEPTH(dstr) = CvDEPTH(sstr);
10926 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10927 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10929 CvWEAKOUTSIDE(sstr)
10930 ? cv_dup( CvOUTSIDE(sstr), param)
10931 : cv_dup_inc(CvOUTSIDE(sstr), param);
10932 CvFLAGS(dstr) = CvFLAGS(sstr);
10933 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10936 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10940 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10946 /* duplicate a context */
10949 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10951 PERL_CONTEXT *ncxs;
10954 return (PERL_CONTEXT*)NULL;
10956 /* look for it in the table first */
10957 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10961 /* create anew and remember what it is */
10962 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10963 ptr_table_store(PL_ptr_table, cxs, ncxs);
10966 PERL_CONTEXT *cx = &cxs[ix];
10967 PERL_CONTEXT *ncx = &ncxs[ix];
10968 ncx->cx_type = cx->cx_type;
10969 if (CxTYPE(cx) == CXt_SUBST) {
10970 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10973 ncx->blk_oldsp = cx->blk_oldsp;
10974 ncx->blk_oldcop = cx->blk_oldcop;
10975 ncx->blk_oldretsp = cx->blk_oldretsp;
10976 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10977 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10978 ncx->blk_oldpm = cx->blk_oldpm;
10979 ncx->blk_gimme = cx->blk_gimme;
10980 switch (CxTYPE(cx)) {
10982 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10983 ? cv_dup_inc(cx->blk_sub.cv, param)
10984 : cv_dup(cx->blk_sub.cv,param));
10985 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10986 ? av_dup_inc(cx->blk_sub.argarray, param)
10988 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10989 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10990 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10991 ncx->blk_sub.lval = cx->blk_sub.lval;
10994 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10995 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10996 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10997 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10998 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11001 ncx->blk_loop.label = cx->blk_loop.label;
11002 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11003 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11004 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11005 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11006 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11007 ? cx->blk_loop.iterdata
11008 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11009 ncx->blk_loop.oldcomppad
11010 = (PAD*)ptr_table_fetch(PL_ptr_table,
11011 cx->blk_loop.oldcomppad);
11012 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11013 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11014 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11015 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11016 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11019 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11020 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11021 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11022 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11034 /* duplicate a stack info structure */
11037 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11042 return (PERL_SI*)NULL;
11044 /* look for it in the table first */
11045 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11049 /* create anew and remember what it is */
11050 Newz(56, nsi, 1, PERL_SI);
11051 ptr_table_store(PL_ptr_table, si, nsi);
11053 nsi->si_stack = av_dup_inc(si->si_stack, param);
11054 nsi->si_cxix = si->si_cxix;
11055 nsi->si_cxmax = si->si_cxmax;
11056 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11057 nsi->si_type = si->si_type;
11058 nsi->si_prev = si_dup(si->si_prev, param);
11059 nsi->si_next = si_dup(si->si_next, param);
11060 nsi->si_markoff = si->si_markoff;
11065 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11066 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11067 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11068 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11069 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11070 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11071 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11072 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11073 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11074 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11075 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11076 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11077 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11078 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11081 #define pv_dup_inc(p) SAVEPV(p)
11082 #define pv_dup(p) SAVEPV(p)
11083 #define svp_dup_inc(p,pp) any_dup(p,pp)
11085 /* map any object to the new equivent - either something in the
11086 * ptr table, or something in the interpreter structure
11090 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11095 return (void*)NULL;
11097 /* look for it in the table first */
11098 ret = ptr_table_fetch(PL_ptr_table, v);
11102 /* see if it is part of the interpreter structure */
11103 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11104 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11112 /* duplicate the save stack */
11115 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11117 ANY *ss = proto_perl->Tsavestack;
11118 I32 ix = proto_perl->Tsavestack_ix;
11119 I32 max = proto_perl->Tsavestack_max;
11132 void (*dptr) (void*);
11133 void (*dxptr) (pTHX_ void*);
11136 Newz(54, nss, max, ANY);
11140 TOPINT(nss,ix) = i;
11142 case SAVEt_ITEM: /* normal string */
11143 sv = (SV*)POPPTR(ss,ix);
11144 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11145 sv = (SV*)POPPTR(ss,ix);
11146 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11148 case SAVEt_SV: /* scalar reference */
11149 sv = (SV*)POPPTR(ss,ix);
11150 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11151 gv = (GV*)POPPTR(ss,ix);
11152 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11154 case SAVEt_GENERIC_PVREF: /* generic char* */
11155 c = (char*)POPPTR(ss,ix);
11156 TOPPTR(nss,ix) = pv_dup(c);
11157 ptr = POPPTR(ss,ix);
11158 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11160 case SAVEt_SHARED_PVREF: /* char* in shared space */
11161 c = (char*)POPPTR(ss,ix);
11162 TOPPTR(nss,ix) = savesharedpv(c);
11163 ptr = POPPTR(ss,ix);
11164 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11166 case SAVEt_GENERIC_SVREF: /* generic sv */
11167 case SAVEt_SVREF: /* scalar reference */
11168 sv = (SV*)POPPTR(ss,ix);
11169 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11170 ptr = POPPTR(ss,ix);
11171 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11173 case SAVEt_AV: /* array reference */
11174 av = (AV*)POPPTR(ss,ix);
11175 TOPPTR(nss,ix) = av_dup_inc(av, param);
11176 gv = (GV*)POPPTR(ss,ix);
11177 TOPPTR(nss,ix) = gv_dup(gv, param);
11179 case SAVEt_HV: /* hash reference */
11180 hv = (HV*)POPPTR(ss,ix);
11181 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11182 gv = (GV*)POPPTR(ss,ix);
11183 TOPPTR(nss,ix) = gv_dup(gv, param);
11185 case SAVEt_INT: /* int reference */
11186 ptr = POPPTR(ss,ix);
11187 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11188 intval = (int)POPINT(ss,ix);
11189 TOPINT(nss,ix) = intval;
11191 case SAVEt_LONG: /* long reference */
11192 ptr = POPPTR(ss,ix);
11193 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11194 longval = (long)POPLONG(ss,ix);
11195 TOPLONG(nss,ix) = longval;
11197 case SAVEt_I32: /* I32 reference */
11198 case SAVEt_I16: /* I16 reference */
11199 case SAVEt_I8: /* I8 reference */
11200 ptr = POPPTR(ss,ix);
11201 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11203 TOPINT(nss,ix) = i;
11205 case SAVEt_IV: /* IV reference */
11206 ptr = POPPTR(ss,ix);
11207 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11209 TOPIV(nss,ix) = iv;
11211 case SAVEt_SPTR: /* SV* reference */
11212 ptr = POPPTR(ss,ix);
11213 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11214 sv = (SV*)POPPTR(ss,ix);
11215 TOPPTR(nss,ix) = sv_dup(sv, param);
11217 case SAVEt_VPTR: /* random* reference */
11218 ptr = POPPTR(ss,ix);
11219 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11220 ptr = POPPTR(ss,ix);
11221 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11223 case SAVEt_PPTR: /* char* reference */
11224 ptr = POPPTR(ss,ix);
11225 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11226 c = (char*)POPPTR(ss,ix);
11227 TOPPTR(nss,ix) = pv_dup(c);
11229 case SAVEt_HPTR: /* HV* reference */
11230 ptr = POPPTR(ss,ix);
11231 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11232 hv = (HV*)POPPTR(ss,ix);
11233 TOPPTR(nss,ix) = hv_dup(hv, param);
11235 case SAVEt_APTR: /* AV* reference */
11236 ptr = POPPTR(ss,ix);
11237 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11238 av = (AV*)POPPTR(ss,ix);
11239 TOPPTR(nss,ix) = av_dup(av, param);
11242 gv = (GV*)POPPTR(ss,ix);
11243 TOPPTR(nss,ix) = gv_dup(gv, param);
11245 case SAVEt_GP: /* scalar reference */
11246 gp = (GP*)POPPTR(ss,ix);
11247 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11248 (void)GpREFCNT_inc(gp);
11249 gv = (GV*)POPPTR(ss,ix);
11250 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11251 c = (char*)POPPTR(ss,ix);
11252 TOPPTR(nss,ix) = pv_dup(c);
11254 TOPIV(nss,ix) = iv;
11256 TOPIV(nss,ix) = iv;
11259 case SAVEt_MORTALIZESV:
11260 sv = (SV*)POPPTR(ss,ix);
11261 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11264 ptr = POPPTR(ss,ix);
11265 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11266 /* these are assumed to be refcounted properly */
11267 switch (((OP*)ptr)->op_type) {
11269 case OP_LEAVESUBLV:
11273 case OP_LEAVEWRITE:
11274 TOPPTR(nss,ix) = ptr;
11279 TOPPTR(nss,ix) = Nullop;
11284 TOPPTR(nss,ix) = Nullop;
11287 c = (char*)POPPTR(ss,ix);
11288 TOPPTR(nss,ix) = pv_dup_inc(c);
11290 case SAVEt_CLEARSV:
11291 longval = POPLONG(ss,ix);
11292 TOPLONG(nss,ix) = longval;
11295 hv = (HV*)POPPTR(ss,ix);
11296 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11297 c = (char*)POPPTR(ss,ix);
11298 TOPPTR(nss,ix) = pv_dup_inc(c);
11300 TOPINT(nss,ix) = i;
11302 case SAVEt_DESTRUCTOR:
11303 ptr = POPPTR(ss,ix);
11304 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11305 dptr = POPDPTR(ss,ix);
11306 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11308 case SAVEt_DESTRUCTOR_X:
11309 ptr = POPPTR(ss,ix);
11310 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11311 dxptr = POPDXPTR(ss,ix);
11312 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11314 case SAVEt_REGCONTEXT:
11317 TOPINT(nss,ix) = i;
11320 case SAVEt_STACK_POS: /* Position on Perl stack */
11322 TOPINT(nss,ix) = i;
11324 case SAVEt_AELEM: /* array element */
11325 sv = (SV*)POPPTR(ss,ix);
11326 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11328 TOPINT(nss,ix) = i;
11329 av = (AV*)POPPTR(ss,ix);
11330 TOPPTR(nss,ix) = av_dup_inc(av, param);
11332 case SAVEt_HELEM: /* hash element */
11333 sv = (SV*)POPPTR(ss,ix);
11334 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11335 sv = (SV*)POPPTR(ss,ix);
11336 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11337 hv = (HV*)POPPTR(ss,ix);
11338 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11341 ptr = POPPTR(ss,ix);
11342 TOPPTR(nss,ix) = ptr;
11346 TOPINT(nss,ix) = i;
11348 case SAVEt_COMPPAD:
11349 av = (AV*)POPPTR(ss,ix);
11350 TOPPTR(nss,ix) = av_dup(av, param);
11353 longval = (long)POPLONG(ss,ix);
11354 TOPLONG(nss,ix) = longval;
11355 ptr = POPPTR(ss,ix);
11356 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11357 sv = (SV*)POPPTR(ss,ix);
11358 TOPPTR(nss,ix) = sv_dup(sv, param);
11361 ptr = POPPTR(ss,ix);
11362 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11363 longval = (long)POPBOOL(ss,ix);
11364 TOPBOOL(nss,ix) = (bool)longval;
11366 case SAVEt_SET_SVFLAGS:
11368 TOPINT(nss,ix) = i;
11370 TOPINT(nss,ix) = i;
11371 sv = (SV*)POPPTR(ss,ix);
11372 TOPPTR(nss,ix) = sv_dup(sv, param);
11375 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11383 =for apidoc perl_clone
11385 Create and return a new interpreter by cloning the current one.
11387 perl_clone takes these flags as parameters:
11389 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11390 without it we only clone the data and zero the stacks,
11391 with it we copy the stacks and the new perl interpreter is
11392 ready to run at the exact same point as the previous one.
11393 The pseudo-fork code uses COPY_STACKS while the
11394 threads->new doesn't.
11396 CLONEf_KEEP_PTR_TABLE
11397 perl_clone keeps a ptr_table with the pointer of the old
11398 variable as a key and the new variable as a value,
11399 this allows it to check if something has been cloned and not
11400 clone it again but rather just use the value and increase the
11401 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11402 the ptr_table using the function
11403 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11404 reason to keep it around is if you want to dup some of your own
11405 variable who are outside the graph perl scans, example of this
11406 code is in threads.xs create
11409 This is a win32 thing, it is ignored on unix, it tells perls
11410 win32host code (which is c++) to clone itself, this is needed on
11411 win32 if you want to run two threads at the same time,
11412 if you just want to do some stuff in a separate perl interpreter
11413 and then throw it away and return to the original one,
11414 you don't need to do anything.
11419 /* XXX the above needs expanding by someone who actually understands it ! */
11420 EXTERN_C PerlInterpreter *
11421 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11424 perl_clone(PerlInterpreter *proto_perl, UV flags)
11426 #ifdef PERL_IMPLICIT_SYS
11428 /* perlhost.h so we need to call into it
11429 to clone the host, CPerlHost should have a c interface, sky */
11431 if (flags & CLONEf_CLONE_HOST) {
11432 return perl_clone_host(proto_perl,flags);
11434 return perl_clone_using(proto_perl, flags,
11436 proto_perl->IMemShared,
11437 proto_perl->IMemParse,
11439 proto_perl->IStdIO,
11443 proto_perl->IProc);
11447 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11448 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11449 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11450 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11451 struct IPerlDir* ipD, struct IPerlSock* ipS,
11452 struct IPerlProc* ipP)
11454 /* XXX many of the string copies here can be optimized if they're
11455 * constants; they need to be allocated as common memory and just
11456 * their pointers copied. */
11459 CLONE_PARAMS clone_params;
11460 CLONE_PARAMS* param = &clone_params;
11462 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11463 PERL_SET_THX(my_perl);
11466 Poison(my_perl, 1, PerlInterpreter);
11470 PL_savestack_ix = 0;
11471 PL_savestack_max = -1;
11473 PL_sig_pending = 0;
11474 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11475 # else /* !DEBUGGING */
11476 Zero(my_perl, 1, PerlInterpreter);
11477 # endif /* DEBUGGING */
11479 /* host pointers */
11481 PL_MemShared = ipMS;
11482 PL_MemParse = ipMP;
11489 #else /* !PERL_IMPLICIT_SYS */
11491 CLONE_PARAMS clone_params;
11492 CLONE_PARAMS* param = &clone_params;
11493 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11494 PERL_SET_THX(my_perl);
11499 Poison(my_perl, 1, PerlInterpreter);
11503 PL_savestack_ix = 0;
11504 PL_savestack_max = -1;
11506 PL_sig_pending = 0;
11507 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11508 # else /* !DEBUGGING */
11509 Zero(my_perl, 1, PerlInterpreter);
11510 # endif /* DEBUGGING */
11511 #endif /* PERL_IMPLICIT_SYS */
11512 param->flags = flags;
11513 param->proto_perl = proto_perl;
11516 PL_xiv_arenaroot = NULL;
11517 PL_xiv_root = NULL;
11518 PL_xnv_arenaroot = NULL;
11519 PL_xnv_root = NULL;
11520 PL_xrv_arenaroot = NULL;
11521 PL_xrv_root = NULL;
11522 PL_xpv_arenaroot = NULL;
11523 PL_xpv_root = NULL;
11524 PL_xpviv_arenaroot = NULL;
11525 PL_xpviv_root = NULL;
11526 PL_xpvnv_arenaroot = NULL;
11527 PL_xpvnv_root = NULL;
11528 PL_xpvcv_arenaroot = NULL;
11529 PL_xpvcv_root = NULL;
11530 PL_xpvav_arenaroot = NULL;
11531 PL_xpvav_root = NULL;
11532 PL_xpvhv_arenaroot = NULL;
11533 PL_xpvhv_root = NULL;
11534 PL_xpvmg_arenaroot = NULL;
11535 PL_xpvmg_root = NULL;
11536 PL_xpvlv_arenaroot = NULL;
11537 PL_xpvlv_root = NULL;
11538 PL_xpvbm_arenaroot = NULL;
11539 PL_xpvbm_root = NULL;
11540 PL_he_arenaroot = NULL;
11542 PL_nice_chunk = NULL;
11543 PL_nice_chunk_size = 0;
11545 PL_sv_objcount = 0;
11546 PL_sv_root = Nullsv;
11547 PL_sv_arenaroot = Nullsv;
11549 PL_debug = proto_perl->Idebug;
11551 #ifdef USE_REENTRANT_API
11552 /* XXX: things like -Dm will segfault here in perlio, but doing
11553 * PERL_SET_CONTEXT(proto_perl);
11554 * breaks too many other things
11556 Perl_reentrant_init(aTHX);
11559 /* create SV map for pointer relocation */
11560 PL_ptr_table = ptr_table_new();
11562 /* initialize these special pointers as early as possible */
11563 SvANY(&PL_sv_undef) = NULL;
11564 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11565 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11566 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11568 SvANY(&PL_sv_no) = new_XPVNV();
11569 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11570 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11571 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11572 SvCUR(&PL_sv_no) = 0;
11573 SvLEN(&PL_sv_no) = 1;
11574 SvNVX(&PL_sv_no) = 0;
11575 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11577 SvANY(&PL_sv_yes) = new_XPVNV();
11578 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11579 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11580 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11581 SvCUR(&PL_sv_yes) = 1;
11582 SvLEN(&PL_sv_yes) = 2;
11583 SvNVX(&PL_sv_yes) = 1;
11584 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11586 /* create (a non-shared!) shared string table */
11587 PL_strtab = newHV();
11588 HvSHAREKEYS_off(PL_strtab);
11589 hv_ksplit(PL_strtab, 512);
11590 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11592 PL_compiling = proto_perl->Icompiling;
11594 /* These two PVs will be free'd special way so must set them same way op.c does */
11595 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11596 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11598 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11599 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11601 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11602 if (!specialWARN(PL_compiling.cop_warnings))
11603 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11604 if (!specialCopIO(PL_compiling.cop_io))
11605 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11606 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11608 /* pseudo environmental stuff */
11609 PL_origargc = proto_perl->Iorigargc;
11610 PL_origargv = proto_perl->Iorigargv;
11612 param->stashes = newAV(); /* Setup array of objects to call clone on */
11614 #ifdef PERLIO_LAYERS
11615 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11616 PerlIO_clone(aTHX_ proto_perl, param);
11619 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11620 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11621 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11622 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11623 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11624 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11627 PL_minus_c = proto_perl->Iminus_c;
11628 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11629 PL_localpatches = proto_perl->Ilocalpatches;
11630 PL_splitstr = proto_perl->Isplitstr;
11631 PL_preprocess = proto_perl->Ipreprocess;
11632 PL_minus_n = proto_perl->Iminus_n;
11633 PL_minus_p = proto_perl->Iminus_p;
11634 PL_minus_l = proto_perl->Iminus_l;
11635 PL_minus_a = proto_perl->Iminus_a;
11636 PL_minus_F = proto_perl->Iminus_F;
11637 PL_doswitches = proto_perl->Idoswitches;
11638 PL_dowarn = proto_perl->Idowarn;
11639 PL_doextract = proto_perl->Idoextract;
11640 PL_sawampersand = proto_perl->Isawampersand;
11641 PL_unsafe = proto_perl->Iunsafe;
11642 PL_inplace = SAVEPV(proto_perl->Iinplace);
11643 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11644 PL_perldb = proto_perl->Iperldb;
11645 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11646 PL_exit_flags = proto_perl->Iexit_flags;
11648 /* magical thingies */
11649 /* XXX time(&PL_basetime) when asked for? */
11650 PL_basetime = proto_perl->Ibasetime;
11651 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11653 PL_maxsysfd = proto_perl->Imaxsysfd;
11654 PL_multiline = proto_perl->Imultiline;
11655 PL_statusvalue = proto_perl->Istatusvalue;
11657 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11659 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11661 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11662 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11663 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11665 /* Clone the regex array */
11666 PL_regex_padav = newAV();
11668 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11669 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11670 av_push(PL_regex_padav,
11671 sv_dup_inc(regexen[0],param));
11672 for(i = 1; i <= len; i++) {
11673 if(SvREPADTMP(regexen[i])) {
11674 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11676 av_push(PL_regex_padav,
11678 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11679 SvIVX(regexen[i])), param)))
11684 PL_regex_pad = AvARRAY(PL_regex_padav);
11686 /* shortcuts to various I/O objects */
11687 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11688 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11689 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11690 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11691 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11692 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11694 /* shortcuts to regexp stuff */
11695 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11697 /* shortcuts to misc objects */
11698 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11700 /* shortcuts to debugging objects */
11701 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11702 PL_DBline = gv_dup(proto_perl->IDBline, param);
11703 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11704 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11705 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11706 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11707 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11708 PL_lineary = av_dup(proto_perl->Ilineary, param);
11709 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11711 /* symbol tables */
11712 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11713 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11714 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11715 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11716 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11718 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11719 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11720 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11721 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11722 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11723 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11725 PL_sub_generation = proto_perl->Isub_generation;
11727 /* funky return mechanisms */
11728 PL_forkprocess = proto_perl->Iforkprocess;
11730 /* subprocess state */
11731 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11733 /* internal state */
11734 PL_tainting = proto_perl->Itainting;
11735 PL_taint_warn = proto_perl->Itaint_warn;
11736 PL_maxo = proto_perl->Imaxo;
11737 if (proto_perl->Iop_mask)
11738 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11740 PL_op_mask = Nullch;
11741 /* PL_asserting = proto_perl->Iasserting; */
11743 /* current interpreter roots */
11744 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11745 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11746 PL_main_start = proto_perl->Imain_start;
11747 PL_eval_root = proto_perl->Ieval_root;
11748 PL_eval_start = proto_perl->Ieval_start;
11750 /* runtime control stuff */
11751 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11752 PL_copline = proto_perl->Icopline;
11754 PL_filemode = proto_perl->Ifilemode;
11755 PL_lastfd = proto_perl->Ilastfd;
11756 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11759 PL_gensym = proto_perl->Igensym;
11760 PL_preambled = proto_perl->Ipreambled;
11761 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11762 PL_laststatval = proto_perl->Ilaststatval;
11763 PL_laststype = proto_perl->Ilaststype;
11764 PL_mess_sv = Nullsv;
11766 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11767 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11769 /* interpreter atexit processing */
11770 PL_exitlistlen = proto_perl->Iexitlistlen;
11771 if (PL_exitlistlen) {
11772 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11773 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11776 PL_exitlist = (PerlExitListEntry*)NULL;
11777 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11778 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11779 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11781 PL_profiledata = NULL;
11782 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11783 /* PL_rsfp_filters entries have fake IoDIRP() */
11784 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11786 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11788 PAD_CLONE_VARS(proto_perl, param);
11790 #ifdef HAVE_INTERP_INTERN
11791 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11794 /* more statics moved here */
11795 PL_generation = proto_perl->Igeneration;
11796 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11798 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11799 PL_in_clean_all = proto_perl->Iin_clean_all;
11801 PL_uid = proto_perl->Iuid;
11802 PL_euid = proto_perl->Ieuid;
11803 PL_gid = proto_perl->Igid;
11804 PL_egid = proto_perl->Iegid;
11805 PL_nomemok = proto_perl->Inomemok;
11806 PL_an = proto_perl->Ian;
11807 PL_evalseq = proto_perl->Ievalseq;
11808 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11809 PL_origalen = proto_perl->Iorigalen;
11810 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11811 PL_osname = SAVEPV(proto_perl->Iosname);
11812 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11813 PL_sighandlerp = proto_perl->Isighandlerp;
11816 PL_runops = proto_perl->Irunops;
11818 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11821 PL_cshlen = proto_perl->Icshlen;
11822 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11825 PL_lex_state = proto_perl->Ilex_state;
11826 PL_lex_defer = proto_perl->Ilex_defer;
11827 PL_lex_expect = proto_perl->Ilex_expect;
11828 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11829 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11830 PL_lex_starts = proto_perl->Ilex_starts;
11831 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11832 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11833 PL_lex_op = proto_perl->Ilex_op;
11834 PL_lex_inpat = proto_perl->Ilex_inpat;
11835 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11836 PL_lex_brackets = proto_perl->Ilex_brackets;
11837 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11838 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11839 PL_lex_casemods = proto_perl->Ilex_casemods;
11840 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11841 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11843 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11844 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11845 PL_nexttoke = proto_perl->Inexttoke;
11847 /* XXX This is probably masking the deeper issue of why
11848 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11849 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11850 * (A little debugging with a watchpoint on it may help.)
11852 if (SvANY(proto_perl->Ilinestr)) {
11853 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11854 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11855 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11856 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11857 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11858 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11859 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11860 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11861 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11864 PL_linestr = NEWSV(65,79);
11865 sv_upgrade(PL_linestr,SVt_PVIV);
11866 sv_setpvn(PL_linestr,"",0);
11867 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11869 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11870 PL_pending_ident = proto_perl->Ipending_ident;
11871 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11873 PL_expect = proto_perl->Iexpect;
11875 PL_multi_start = proto_perl->Imulti_start;
11876 PL_multi_end = proto_perl->Imulti_end;
11877 PL_multi_open = proto_perl->Imulti_open;
11878 PL_multi_close = proto_perl->Imulti_close;
11880 PL_error_count = proto_perl->Ierror_count;
11881 PL_subline = proto_perl->Isubline;
11882 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11884 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11885 if (SvANY(proto_perl->Ilinestr)) {
11886 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11887 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11888 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11889 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11890 PL_last_lop_op = proto_perl->Ilast_lop_op;
11893 PL_last_uni = SvPVX(PL_linestr);
11894 PL_last_lop = SvPVX(PL_linestr);
11895 PL_last_lop_op = 0;
11897 PL_in_my = proto_perl->Iin_my;
11898 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11900 PL_cryptseen = proto_perl->Icryptseen;
11903 PL_hints = proto_perl->Ihints;
11905 PL_amagic_generation = proto_perl->Iamagic_generation;
11907 #ifdef USE_LOCALE_COLLATE
11908 PL_collation_ix = proto_perl->Icollation_ix;
11909 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11910 PL_collation_standard = proto_perl->Icollation_standard;
11911 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11912 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11913 #endif /* USE_LOCALE_COLLATE */
11915 #ifdef USE_LOCALE_NUMERIC
11916 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11917 PL_numeric_standard = proto_perl->Inumeric_standard;
11918 PL_numeric_local = proto_perl->Inumeric_local;
11919 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11920 #endif /* !USE_LOCALE_NUMERIC */
11922 /* utf8 character classes */
11923 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11924 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11925 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11926 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11927 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11928 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11929 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11930 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11931 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11932 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11933 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11934 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11935 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11936 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11937 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11938 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11939 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11940 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11941 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11942 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11944 /* Did the locale setup indicate UTF-8? */
11945 PL_utf8locale = proto_perl->Iutf8locale;
11946 /* Unicode features (see perlrun/-C) */
11947 PL_unicode = proto_perl->Iunicode;
11949 /* Pre-5.8 signals control */
11950 PL_signals = proto_perl->Isignals;
11952 /* times() ticks per second */
11953 PL_clocktick = proto_perl->Iclocktick;
11955 /* Recursion stopper for PerlIO_find_layer */
11956 PL_in_load_module = proto_perl->Iin_load_module;
11958 /* sort() routine */
11959 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11961 /* Not really needed/useful since the reenrant_retint is "volatile",
11962 * but do it for consistency's sake. */
11963 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11965 /* Hooks to shared SVs and locks. */
11966 PL_sharehook = proto_perl->Isharehook;
11967 PL_lockhook = proto_perl->Ilockhook;
11968 PL_unlockhook = proto_perl->Iunlockhook;
11969 PL_threadhook = proto_perl->Ithreadhook;
11971 PL_runops_std = proto_perl->Irunops_std;
11972 PL_runops_dbg = proto_perl->Irunops_dbg;
11974 #ifdef THREADS_HAVE_PIDS
11975 PL_ppid = proto_perl->Ippid;
11979 PL_last_swash_hv = Nullhv; /* reinits on demand */
11980 PL_last_swash_klen = 0;
11981 PL_last_swash_key[0]= '\0';
11982 PL_last_swash_tmps = (U8*)NULL;
11983 PL_last_swash_slen = 0;
11985 PL_glob_index = proto_perl->Iglob_index;
11986 PL_srand_called = proto_perl->Isrand_called;
11987 PL_hash_seed = proto_perl->Ihash_seed;
11988 PL_rehash_seed = proto_perl->Irehash_seed;
11989 PL_uudmap['M'] = 0; /* reinits on demand */
11990 PL_bitcount = Nullch; /* reinits on demand */
11992 if (proto_perl->Ipsig_pend) {
11993 Newz(0, PL_psig_pend, SIG_SIZE, int);
11996 PL_psig_pend = (int*)NULL;
11999 if (proto_perl->Ipsig_ptr) {
12000 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12001 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12002 for (i = 1; i < SIG_SIZE; i++) {
12003 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12004 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12008 PL_psig_ptr = (SV**)NULL;
12009 PL_psig_name = (SV**)NULL;
12012 /* thrdvar.h stuff */
12014 if (flags & CLONEf_COPY_STACKS) {
12015 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12016 PL_tmps_ix = proto_perl->Ttmps_ix;
12017 PL_tmps_max = proto_perl->Ttmps_max;
12018 PL_tmps_floor = proto_perl->Ttmps_floor;
12019 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12021 while (i <= PL_tmps_ix) {
12022 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12026 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12027 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12028 Newz(54, PL_markstack, i, I32);
12029 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12030 - proto_perl->Tmarkstack);
12031 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12032 - proto_perl->Tmarkstack);
12033 Copy(proto_perl->Tmarkstack, PL_markstack,
12034 PL_markstack_ptr - PL_markstack + 1, I32);
12036 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12037 * NOTE: unlike the others! */
12038 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12039 PL_scopestack_max = proto_perl->Tscopestack_max;
12040 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12041 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12043 /* next push_return() sets PL_retstack[PL_retstack_ix]
12044 * NOTE: unlike the others! */
12045 PL_retstack_ix = proto_perl->Tretstack_ix;
12046 PL_retstack_max = proto_perl->Tretstack_max;
12047 Newz(54, PL_retstack, PL_retstack_max, OP*);
12048 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
12050 /* NOTE: si_dup() looks at PL_markstack */
12051 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12053 /* PL_curstack = PL_curstackinfo->si_stack; */
12054 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12055 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12057 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12058 PL_stack_base = AvARRAY(PL_curstack);
12059 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12060 - proto_perl->Tstack_base);
12061 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12063 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12064 * NOTE: unlike the others! */
12065 PL_savestack_ix = proto_perl->Tsavestack_ix;
12066 PL_savestack_max = proto_perl->Tsavestack_max;
12067 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12068 PL_savestack = ss_dup(proto_perl, param);
12072 ENTER; /* perl_destruct() wants to LEAVE; */
12075 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12076 PL_top_env = &PL_start_env;
12078 PL_op = proto_perl->Top;
12081 PL_Xpv = (XPV*)NULL;
12082 PL_na = proto_perl->Tna;
12084 PL_statbuf = proto_perl->Tstatbuf;
12085 PL_statcache = proto_perl->Tstatcache;
12086 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12087 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12089 PL_timesbuf = proto_perl->Ttimesbuf;
12092 PL_tainted = proto_perl->Ttainted;
12093 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12094 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12095 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12096 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12097 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12098 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12099 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12100 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12101 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12103 PL_restartop = proto_perl->Trestartop;
12104 PL_in_eval = proto_perl->Tin_eval;
12105 PL_delaymagic = proto_perl->Tdelaymagic;
12106 PL_dirty = proto_perl->Tdirty;
12107 PL_localizing = proto_perl->Tlocalizing;
12109 #ifdef PERL_FLEXIBLE_EXCEPTIONS
12110 PL_protect = proto_perl->Tprotect;
12112 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12113 PL_hv_fetch_ent_mh = Nullhe;
12114 PL_modcount = proto_perl->Tmodcount;
12115 PL_lastgotoprobe = Nullop;
12116 PL_dumpindent = proto_perl->Tdumpindent;
12118 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12119 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12120 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12121 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12122 PL_sortcxix = proto_perl->Tsortcxix;
12123 PL_efloatbuf = Nullch; /* reinits on demand */
12124 PL_efloatsize = 0; /* reinits on demand */
12128 PL_screamfirst = NULL;
12129 PL_screamnext = NULL;
12130 PL_maxscream = -1; /* reinits on demand */
12131 PL_lastscream = Nullsv;
12133 PL_watchaddr = NULL;
12134 PL_watchok = Nullch;
12136 PL_regdummy = proto_perl->Tregdummy;
12137 PL_regprecomp = Nullch;
12140 PL_colorset = 0; /* reinits PL_colors[] */
12141 /*PL_colors[6] = {0,0,0,0,0,0};*/
12142 PL_reginput = Nullch;
12143 PL_regbol = Nullch;
12144 PL_regeol = Nullch;
12145 PL_regstartp = (I32*)NULL;
12146 PL_regendp = (I32*)NULL;
12147 PL_reglastparen = (U32*)NULL;
12148 PL_reglastcloseparen = (U32*)NULL;
12149 PL_regtill = Nullch;
12150 PL_reg_start_tmp = (char**)NULL;
12151 PL_reg_start_tmpl = 0;
12152 PL_regdata = (struct reg_data*)NULL;
12155 PL_reg_eval_set = 0;
12157 PL_regprogram = (regnode*)NULL;
12159 PL_regcc = (CURCUR*)NULL;
12160 PL_reg_call_cc = (struct re_cc_state*)NULL;
12161 PL_reg_re = (regexp*)NULL;
12162 PL_reg_ganch = Nullch;
12163 PL_reg_sv = Nullsv;
12164 PL_reg_match_utf8 = FALSE;
12165 PL_reg_magic = (MAGIC*)NULL;
12167 PL_reg_oldcurpm = (PMOP*)NULL;
12168 PL_reg_curpm = (PMOP*)NULL;
12169 PL_reg_oldsaved = Nullch;
12170 PL_reg_oldsavedlen = 0;
12171 #ifdef PERL_COPY_ON_WRITE
12174 PL_reg_maxiter = 0;
12175 PL_reg_leftiter = 0;
12176 PL_reg_poscache = Nullch;
12177 PL_reg_poscache_size= 0;
12179 /* RE engine - function pointers */
12180 PL_regcompp = proto_perl->Tregcompp;
12181 PL_regexecp = proto_perl->Tregexecp;
12182 PL_regint_start = proto_perl->Tregint_start;
12183 PL_regint_string = proto_perl->Tregint_string;
12184 PL_regfree = proto_perl->Tregfree;
12186 PL_reginterp_cnt = 0;
12187 PL_reg_starttry = 0;
12189 /* Pluggable optimizer */
12190 PL_peepp = proto_perl->Tpeepp;
12192 PL_stashcache = newHV();
12194 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12195 ptr_table_free(PL_ptr_table);
12196 PL_ptr_table = NULL;
12199 /* Call the ->CLONE method, if it exists, for each of the stashes
12200 identified by sv_dup() above.
12202 while(av_len(param->stashes) != -1) {
12203 HV* stash = (HV*) av_shift(param->stashes);
12204 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12205 if (cloner && GvCV(cloner)) {
12210 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12212 call_sv((SV*)GvCV(cloner), G_DISCARD);
12218 SvREFCNT_dec(param->stashes);
12223 #endif /* USE_ITHREADS */
12226 =head1 Unicode Support
12228 =for apidoc sv_recode_to_utf8
12230 The encoding is assumed to be an Encode object, on entry the PV
12231 of the sv is assumed to be octets in that encoding, and the sv
12232 will be converted into Unicode (and UTF-8).
12234 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12235 is not a reference, nothing is done to the sv. If the encoding is not
12236 an C<Encode::XS> Encoding object, bad things will happen.
12237 (See F<lib/encoding.pm> and L<Encode>).
12239 The PV of the sv is returned.
12244 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12246 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12260 Passing sv_yes is wrong - it needs to be or'ed set of constants
12261 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12262 remove converted chars from source.
12264 Both will default the value - let them.
12266 XPUSHs(&PL_sv_yes);
12269 call_method("decode", G_SCALAR);
12273 s = SvPV(uni, len);
12274 if (s != SvPVX(sv)) {
12275 SvGROW(sv, len + 1);
12276 Move(s, SvPVX(sv), len, char);
12277 SvCUR_set(sv, len);
12278 SvPVX(sv)[len] = 0;
12288 =for apidoc sv_cat_decode
12290 The encoding is assumed to be an Encode object, the PV of the ssv is
12291 assumed to be octets in that encoding and decoding the input starts
12292 from the position which (PV + *offset) pointed to. The dsv will be
12293 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12294 when the string tstr appears in decoding output or the input ends on
12295 the PV of the ssv. The value which the offset points will be modified
12296 to the last input position on the ssv.
12298 Returns TRUE if the terminator was found, else returns FALSE.
12303 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12304 SV *ssv, int *offset, char *tstr, int tlen)
12307 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12318 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12319 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12321 call_method("cat_decode", G_SCALAR);
12323 ret = SvTRUE(TOPs);
12324 *offset = SvIV(offsv);
12330 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");