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)
286 Zero(ptr, size, char);
288 /* The first SV in an arena isn't an SV. */
289 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
290 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
291 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
293 PL_sv_arenaroot = sva;
294 PL_sv_root = sva + 1;
296 svend = &sva[SvREFCNT(sva) - 1];
299 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");
1874 Perl_croak(aTHX_ "Can't upgrade to undef");
1876 SvANY(sv) = new_XIV();
1880 SvANY(sv) = new_XNV();
1884 SvANY(sv) = new_XRV();
1888 SvANY(sv) = new_XPV();
1894 SvANY(sv) = new_XPVIV();
1904 SvANY(sv) = new_XPVNV();
1912 SvANY(sv) = new_XPVMG();
1918 SvMAGIC(sv) = magic;
1919 SvSTASH(sv) = stash;
1922 SvANY(sv) = new_XPVLV();
1928 SvMAGIC(sv) = magic;
1929 SvSTASH(sv) = stash;
1941 SvANY(sv) = new_XPVAV();
1949 SvMAGIC(sv) = magic;
1950 SvSTASH(sv) = stash;
1956 SvANY(sv) = new_XPVHV();
1962 HvTOTALKEYS(sv) = 0;
1963 HvPLACEHOLDERS(sv) = 0;
1964 SvMAGIC(sv) = magic;
1965 SvSTASH(sv) = stash;
1972 SvANY(sv) = new_XPVCV();
1973 Zero(SvANY(sv), 1, XPVCV);
1979 SvMAGIC(sv) = magic;
1980 SvSTASH(sv) = stash;
1983 SvANY(sv) = new_XPVGV();
1989 SvMAGIC(sv) = magic;
1990 SvSTASH(sv) = stash;
1998 SvANY(sv) = new_XPVBM();
2004 SvMAGIC(sv) = magic;
2005 SvSTASH(sv) = stash;
2011 SvANY(sv) = new_XPVFM();
2012 Zero(SvANY(sv), 1, XPVFM);
2018 SvMAGIC(sv) = magic;
2019 SvSTASH(sv) = stash;
2022 SvANY(sv) = new_XPVIO();
2023 Zero(SvANY(sv), 1, XPVIO);
2029 SvMAGIC(sv) = magic;
2030 SvSTASH(sv) = stash;
2031 IoPAGE_LEN(sv) = 60;
2034 SvFLAGS(sv) &= ~SVTYPEMASK;
2040 =for apidoc sv_backoff
2042 Remove any string offset. You should normally use the C<SvOOK_off> macro
2049 Perl_sv_backoff(pTHX_ register SV *sv)
2053 char *s = SvPVX(sv);
2054 SvLEN(sv) += SvIVX(sv);
2055 SvPVX(sv) -= SvIVX(sv);
2057 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2059 SvFLAGS(sv) &= ~SVf_OOK;
2066 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2067 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2068 Use the C<SvGROW> wrapper instead.
2074 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2078 #ifdef HAS_64K_LIMIT
2079 if (newlen >= 0x10000) {
2080 PerlIO_printf(Perl_debug_log,
2081 "Allocation too large: %"UVxf"\n", (UV)newlen);
2084 #endif /* HAS_64K_LIMIT */
2087 if (SvTYPE(sv) < SVt_PV) {
2088 sv_upgrade(sv, SVt_PV);
2091 else if (SvOOK(sv)) { /* pv is offset? */
2094 if (newlen > SvLEN(sv))
2095 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2096 #ifdef HAS_64K_LIMIT
2097 if (newlen >= 0x10000)
2104 if (newlen > SvLEN(sv)) { /* need more room? */
2105 if (SvLEN(sv) && s) {
2107 STRLEN l = malloced_size((void*)SvPVX(sv));
2113 Renew(s,newlen,char);
2116 New(703, s, newlen, char);
2117 if (SvPVX(sv) && SvCUR(sv)) {
2118 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2122 SvLEN_set(sv, newlen);
2128 =for apidoc sv_setiv
2130 Copies an integer into the given SV, upgrading first if necessary.
2131 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2137 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2139 SV_CHECK_THINKFIRST_COW_DROP(sv);
2140 switch (SvTYPE(sv)) {
2142 sv_upgrade(sv, SVt_IV);
2145 sv_upgrade(sv, SVt_PVNV);
2149 sv_upgrade(sv, SVt_PVIV);
2158 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2161 (void)SvIOK_only(sv); /* validate number */
2167 =for apidoc sv_setiv_mg
2169 Like C<sv_setiv>, but also handles 'set' magic.
2175 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2182 =for apidoc sv_setuv
2184 Copies an unsigned integer into the given SV, upgrading first if necessary.
2185 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2191 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2193 /* With these two if statements:
2194 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2197 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2199 If you wish to remove them, please benchmark to see what the effect is
2201 if (u <= (UV)IV_MAX) {
2202 sv_setiv(sv, (IV)u);
2211 =for apidoc sv_setuv_mg
2213 Like C<sv_setuv>, but also handles 'set' magic.
2219 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2221 /* With these two if statements:
2222 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2225 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2227 If you wish to remove them, please benchmark to see what the effect is
2229 if (u <= (UV)IV_MAX) {
2230 sv_setiv(sv, (IV)u);
2240 =for apidoc sv_setnv
2242 Copies a double into the given SV, upgrading first if necessary.
2243 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2249 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2251 SV_CHECK_THINKFIRST_COW_DROP(sv);
2252 switch (SvTYPE(sv)) {
2255 sv_upgrade(sv, SVt_NV);
2260 sv_upgrade(sv, SVt_PVNV);
2269 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2273 (void)SvNOK_only(sv); /* validate number */
2278 =for apidoc sv_setnv_mg
2280 Like C<sv_setnv>, but also handles 'set' magic.
2286 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2292 /* Print an "isn't numeric" warning, using a cleaned-up,
2293 * printable version of the offending string
2297 S_not_a_number(pTHX_ SV *sv)
2304 dsv = sv_2mortal(newSVpv("", 0));
2305 pv = sv_uni_display(dsv, sv, 10, 0);
2308 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2309 /* each *s can expand to 4 chars + "...\0",
2310 i.e. need room for 8 chars */
2313 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2315 if (ch & 128 && !isPRINT_LC(ch)) {
2324 else if (ch == '\r') {
2328 else if (ch == '\f') {
2332 else if (ch == '\\') {
2336 else if (ch == '\0') {
2340 else if (isPRINT_LC(ch))
2357 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2358 "Argument \"%s\" isn't numeric in %s", pv,
2361 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2362 "Argument \"%s\" isn't numeric", pv);
2366 =for apidoc looks_like_number
2368 Test if the content of an SV looks like a number (or is a number).
2369 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2370 non-numeric warning), even if your atof() doesn't grok them.
2376 Perl_looks_like_number(pTHX_ SV *sv)
2378 register char *sbegin;
2385 else if (SvPOKp(sv))
2386 sbegin = SvPV(sv, len);
2388 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2389 return grok_number(sbegin, len, NULL);
2392 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2393 until proven guilty, assume that things are not that bad... */
2398 As 64 bit platforms often have an NV that doesn't preserve all bits of
2399 an IV (an assumption perl has been based on to date) it becomes necessary
2400 to remove the assumption that the NV always carries enough precision to
2401 recreate the IV whenever needed, and that the NV is the canonical form.
2402 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2403 precision as a side effect of conversion (which would lead to insanity
2404 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2405 1) to distinguish between IV/UV/NV slots that have cached a valid
2406 conversion where precision was lost and IV/UV/NV slots that have a
2407 valid conversion which has lost no precision
2408 2) to ensure that if a numeric conversion to one form is requested that
2409 would lose precision, the precise conversion (or differently
2410 imprecise conversion) is also performed and cached, to prevent
2411 requests for different numeric formats on the same SV causing
2412 lossy conversion chains. (lossless conversion chains are perfectly
2417 SvIOKp is true if the IV slot contains a valid value
2418 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2419 SvNOKp is true if the NV slot contains a valid value
2420 SvNOK is true only if the NV value is accurate
2423 while converting from PV to NV, check to see if converting that NV to an
2424 IV(or UV) would lose accuracy over a direct conversion from PV to
2425 IV(or UV). If it would, cache both conversions, return NV, but mark
2426 SV as IOK NOKp (ie not NOK).
2428 While converting from PV to IV, check to see if converting that IV to an
2429 NV would lose accuracy over a direct conversion from PV to NV. If it
2430 would, cache both conversions, flag similarly.
2432 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2433 correctly because if IV & NV were set NV *always* overruled.
2434 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2435 changes - now IV and NV together means that the two are interchangeable:
2436 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2438 The benefit of this is that operations such as pp_add know that if
2439 SvIOK is true for both left and right operands, then integer addition
2440 can be used instead of floating point (for cases where the result won't
2441 overflow). Before, floating point was always used, which could lead to
2442 loss of precision compared with integer addition.
2444 * making IV and NV equal status should make maths accurate on 64 bit
2446 * may speed up maths somewhat if pp_add and friends start to use
2447 integers when possible instead of fp. (Hopefully the overhead in
2448 looking for SvIOK and checking for overflow will not outweigh the
2449 fp to integer speedup)
2450 * will slow down integer operations (callers of SvIV) on "inaccurate"
2451 values, as the change from SvIOK to SvIOKp will cause a call into
2452 sv_2iv each time rather than a macro access direct to the IV slot
2453 * should speed up number->string conversion on integers as IV is
2454 favoured when IV and NV are equally accurate
2456 ####################################################################
2457 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2458 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2459 On the other hand, SvUOK is true iff UV.
2460 ####################################################################
2462 Your mileage will vary depending your CPU's relative fp to integer
2466 #ifndef NV_PRESERVES_UV
2467 # define IS_NUMBER_UNDERFLOW_IV 1
2468 # define IS_NUMBER_UNDERFLOW_UV 2
2469 # define IS_NUMBER_IV_AND_UV 2
2470 # define IS_NUMBER_OVERFLOW_IV 4
2471 # define IS_NUMBER_OVERFLOW_UV 5
2473 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2475 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2477 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2479 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));
2480 if (SvNVX(sv) < (NV)IV_MIN) {
2481 (void)SvIOKp_on(sv);
2484 return IS_NUMBER_UNDERFLOW_IV;
2486 if (SvNVX(sv) > (NV)UV_MAX) {
2487 (void)SvIOKp_on(sv);
2491 return IS_NUMBER_OVERFLOW_UV;
2493 (void)SvIOKp_on(sv);
2495 /* Can't use strtol etc to convert this string. (See truth table in
2497 if (SvNVX(sv) <= (UV)IV_MAX) {
2498 SvIVX(sv) = I_V(SvNVX(sv));
2499 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2500 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2502 /* Integer is imprecise. NOK, IOKp */
2504 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2507 SvUVX(sv) = U_V(SvNVX(sv));
2508 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2509 if (SvUVX(sv) == UV_MAX) {
2510 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2511 possibly be preserved by NV. Hence, it must be overflow.
2513 return IS_NUMBER_OVERFLOW_UV;
2515 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2517 /* Integer is imprecise. NOK, IOKp */
2519 return IS_NUMBER_OVERFLOW_IV;
2521 #endif /* !NV_PRESERVES_UV*/
2523 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2524 * this function provided for binary compatibility only
2528 Perl_sv_2iv(pTHX_ register SV *sv)
2530 return sv_2iv_flags(sv, SV_GMAGIC);
2534 =for apidoc sv_2iv_flags
2536 Return the integer value of an SV, doing any necessary string
2537 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2538 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2544 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2548 if (SvGMAGICAL(sv)) {
2549 if (flags & SV_GMAGIC)
2554 return I_V(SvNVX(sv));
2556 if (SvPOKp(sv) && SvLEN(sv))
2559 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2560 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2566 if (SvTHINKFIRST(sv)) {
2569 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2570 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2571 return SvIV(tmpstr);
2572 return PTR2IV(SvRV(sv));
2575 sv_force_normal_flags(sv, 0);
2577 if (SvREADONLY(sv) && !SvOK(sv)) {
2578 if (ckWARN(WARN_UNINITIALIZED))
2585 return (IV)(SvUVX(sv));
2592 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2593 * without also getting a cached IV/UV from it at the same time
2594 * (ie PV->NV conversion should detect loss of accuracy and cache
2595 * IV or UV at same time to avoid this. NWC */
2597 if (SvTYPE(sv) == SVt_NV)
2598 sv_upgrade(sv, SVt_PVNV);
2600 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2601 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2602 certainly cast into the IV range at IV_MAX, whereas the correct
2603 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2605 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2606 SvIVX(sv) = I_V(SvNVX(sv));
2607 if (SvNVX(sv) == (NV) SvIVX(sv)
2608 #ifndef NV_PRESERVES_UV
2609 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2610 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2611 /* Don't flag it as "accurately an integer" if the number
2612 came from a (by definition imprecise) NV operation, and
2613 we're outside the range of NV integer precision */
2616 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2617 DEBUG_c(PerlIO_printf(Perl_debug_log,
2618 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2624 /* IV not precise. No need to convert from PV, as NV
2625 conversion would already have cached IV if it detected
2626 that PV->IV would be better than PV->NV->IV
2627 flags already correct - don't set public IOK. */
2628 DEBUG_c(PerlIO_printf(Perl_debug_log,
2629 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2634 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2635 but the cast (NV)IV_MIN rounds to a the value less (more
2636 negative) than IV_MIN which happens to be equal to SvNVX ??
2637 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2638 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2639 (NV)UVX == NVX are both true, but the values differ. :-(
2640 Hopefully for 2s complement IV_MIN is something like
2641 0x8000000000000000 which will be exact. NWC */
2644 SvUVX(sv) = U_V(SvNVX(sv));
2646 (SvNVX(sv) == (NV) SvUVX(sv))
2647 #ifndef NV_PRESERVES_UV
2648 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2649 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2650 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2651 /* Don't flag it as "accurately an integer" if the number
2652 came from a (by definition imprecise) NV operation, and
2653 we're outside the range of NV integer precision */
2659 DEBUG_c(PerlIO_printf(Perl_debug_log,
2660 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2664 return (IV)SvUVX(sv);
2667 else if (SvPOKp(sv) && SvLEN(sv)) {
2669 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2670 /* We want to avoid a possible problem when we cache an IV which
2671 may be later translated to an NV, and the resulting NV is not
2672 the same as the direct translation of the initial string
2673 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2674 be careful to ensure that the value with the .456 is around if the
2675 NV value is requested in the future).
2677 This means that if we cache such an IV, we need to cache the
2678 NV as well. Moreover, we trade speed for space, and do not
2679 cache the NV if we are sure it's not needed.
2682 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2683 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2684 == IS_NUMBER_IN_UV) {
2685 /* It's definitely an integer, only upgrade to PVIV */
2686 if (SvTYPE(sv) < SVt_PVIV)
2687 sv_upgrade(sv, SVt_PVIV);
2689 } else if (SvTYPE(sv) < SVt_PVNV)
2690 sv_upgrade(sv, SVt_PVNV);
2692 /* If NV preserves UV then we only use the UV value if we know that
2693 we aren't going to call atof() below. If NVs don't preserve UVs
2694 then the value returned may have more precision than atof() will
2695 return, even though value isn't perfectly accurate. */
2696 if ((numtype & (IS_NUMBER_IN_UV
2697 #ifdef NV_PRESERVES_UV
2700 )) == IS_NUMBER_IN_UV) {
2701 /* This won't turn off the public IOK flag if it was set above */
2702 (void)SvIOKp_on(sv);
2704 if (!(numtype & IS_NUMBER_NEG)) {
2706 if (value <= (UV)IV_MAX) {
2707 SvIVX(sv) = (IV)value;
2713 /* 2s complement assumption */
2714 if (value <= (UV)IV_MIN) {
2715 SvIVX(sv) = -(IV)value;
2717 /* Too negative for an IV. This is a double upgrade, but
2718 I'm assuming it will be rare. */
2719 if (SvTYPE(sv) < SVt_PVNV)
2720 sv_upgrade(sv, SVt_PVNV);
2724 SvNVX(sv) = -(NV)value;
2729 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2730 will be in the previous block to set the IV slot, and the next
2731 block to set the NV slot. So no else here. */
2733 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2734 != IS_NUMBER_IN_UV) {
2735 /* It wasn't an (integer that doesn't overflow the UV). */
2736 SvNVX(sv) = Atof(SvPVX(sv));
2738 if (! numtype && ckWARN(WARN_NUMERIC))
2741 #if defined(USE_LONG_DOUBLE)
2742 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2743 PTR2UV(sv), SvNVX(sv)));
2745 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2746 PTR2UV(sv), SvNVX(sv)));
2750 #ifdef NV_PRESERVES_UV
2751 (void)SvIOKp_on(sv);
2753 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2754 SvIVX(sv) = I_V(SvNVX(sv));
2755 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2758 /* Integer is imprecise. NOK, IOKp */
2760 /* UV will not work better than IV */
2762 if (SvNVX(sv) > (NV)UV_MAX) {
2764 /* Integer is inaccurate. NOK, IOKp, is UV */
2768 SvUVX(sv) = U_V(SvNVX(sv));
2769 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2770 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2774 /* Integer is imprecise. NOK, IOKp, is UV */
2780 #else /* NV_PRESERVES_UV */
2781 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2782 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2783 /* The IV slot will have been set from value returned by
2784 grok_number above. The NV slot has just been set using
2787 assert (SvIOKp(sv));
2789 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2790 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2791 /* Small enough to preserve all bits. */
2792 (void)SvIOKp_on(sv);
2794 SvIVX(sv) = I_V(SvNVX(sv));
2795 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2797 /* Assumption: first non-preserved integer is < IV_MAX,
2798 this NV is in the preserved range, therefore: */
2799 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2801 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);
2805 0 0 already failed to read UV.
2806 0 1 already failed to read UV.
2807 1 0 you won't get here in this case. IV/UV
2808 slot set, public IOK, Atof() unneeded.
2809 1 1 already read UV.
2810 so there's no point in sv_2iuv_non_preserve() attempting
2811 to use atol, strtol, strtoul etc. */
2812 if (sv_2iuv_non_preserve (sv, numtype)
2813 >= IS_NUMBER_OVERFLOW_IV)
2817 #endif /* NV_PRESERVES_UV */
2820 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2822 if (SvTYPE(sv) < SVt_IV)
2823 /* Typically the caller expects that sv_any is not NULL now. */
2824 sv_upgrade(sv, SVt_IV);
2827 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2828 PTR2UV(sv),SvIVX(sv)));
2829 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2832 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2833 * this function provided for binary compatibility only
2837 Perl_sv_2uv(pTHX_ register SV *sv)
2839 return sv_2uv_flags(sv, SV_GMAGIC);
2843 =for apidoc sv_2uv_flags
2845 Return the unsigned integer value of an SV, doing any necessary string
2846 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2847 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2853 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2857 if (SvGMAGICAL(sv)) {
2858 if (flags & SV_GMAGIC)
2863 return U_V(SvNVX(sv));
2864 if (SvPOKp(sv) && SvLEN(sv))
2867 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2868 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2874 if (SvTHINKFIRST(sv)) {
2877 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2878 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2879 return SvUV(tmpstr);
2880 return PTR2UV(SvRV(sv));
2883 sv_force_normal_flags(sv, 0);
2885 if (SvREADONLY(sv) && !SvOK(sv)) {
2886 if (ckWARN(WARN_UNINITIALIZED))
2896 return (UV)SvIVX(sv);
2900 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2901 * without also getting a cached IV/UV from it at the same time
2902 * (ie PV->NV conversion should detect loss of accuracy and cache
2903 * IV or UV at same time to avoid this. */
2904 /* IV-over-UV optimisation - choose to cache IV if possible */
2906 if (SvTYPE(sv) == SVt_NV)
2907 sv_upgrade(sv, SVt_PVNV);
2909 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2910 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2911 SvIVX(sv) = I_V(SvNVX(sv));
2912 if (SvNVX(sv) == (NV) SvIVX(sv)
2913 #ifndef NV_PRESERVES_UV
2914 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2915 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2916 /* Don't flag it as "accurately an integer" if the number
2917 came from a (by definition imprecise) NV operation, and
2918 we're outside the range of NV integer precision */
2921 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2922 DEBUG_c(PerlIO_printf(Perl_debug_log,
2923 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2929 /* IV not precise. No need to convert from PV, as NV
2930 conversion would already have cached IV if it detected
2931 that PV->IV would be better than PV->NV->IV
2932 flags already correct - don't set public IOK. */
2933 DEBUG_c(PerlIO_printf(Perl_debug_log,
2934 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2939 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2940 but the cast (NV)IV_MIN rounds to a the value less (more
2941 negative) than IV_MIN which happens to be equal to SvNVX ??
2942 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2943 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2944 (NV)UVX == NVX are both true, but the values differ. :-(
2945 Hopefully for 2s complement IV_MIN is something like
2946 0x8000000000000000 which will be exact. NWC */
2949 SvUVX(sv) = U_V(SvNVX(sv));
2951 (SvNVX(sv) == (NV) SvUVX(sv))
2952 #ifndef NV_PRESERVES_UV
2953 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2954 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2955 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2956 /* Don't flag it as "accurately an integer" if the number
2957 came from a (by definition imprecise) NV operation, and
2958 we're outside the range of NV integer precision */
2963 DEBUG_c(PerlIO_printf(Perl_debug_log,
2964 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2970 else if (SvPOKp(sv) && SvLEN(sv)) {
2972 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2974 /* We want to avoid a possible problem when we cache a UV which
2975 may be later translated to an NV, and the resulting NV is not
2976 the translation of the initial data.
2978 This means that if we cache such a UV, we need to cache the
2979 NV as well. Moreover, we trade speed for space, and do not
2980 cache the NV if not needed.
2983 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2984 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2985 == IS_NUMBER_IN_UV) {
2986 /* It's definitely an integer, only upgrade to PVIV */
2987 if (SvTYPE(sv) < SVt_PVIV)
2988 sv_upgrade(sv, SVt_PVIV);
2990 } else if (SvTYPE(sv) < SVt_PVNV)
2991 sv_upgrade(sv, SVt_PVNV);
2993 /* If NV preserves UV then we only use the UV value if we know that
2994 we aren't going to call atof() below. If NVs don't preserve UVs
2995 then the value returned may have more precision than atof() will
2996 return, even though it isn't accurate. */
2997 if ((numtype & (IS_NUMBER_IN_UV
2998 #ifdef NV_PRESERVES_UV
3001 )) == IS_NUMBER_IN_UV) {
3002 /* This won't turn off the public IOK flag if it was set above */
3003 (void)SvIOKp_on(sv);
3005 if (!(numtype & IS_NUMBER_NEG)) {
3007 if (value <= (UV)IV_MAX) {
3008 SvIVX(sv) = (IV)value;
3010 /* it didn't overflow, and it was positive. */
3015 /* 2s complement assumption */
3016 if (value <= (UV)IV_MIN) {
3017 SvIVX(sv) = -(IV)value;
3019 /* Too negative for an IV. This is a double upgrade, but
3020 I'm assuming it will be rare. */
3021 if (SvTYPE(sv) < SVt_PVNV)
3022 sv_upgrade(sv, SVt_PVNV);
3026 SvNVX(sv) = -(NV)value;
3032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3033 != IS_NUMBER_IN_UV) {
3034 /* It wasn't an integer, or it overflowed the UV. */
3035 SvNVX(sv) = Atof(SvPVX(sv));
3037 if (! numtype && ckWARN(WARN_NUMERIC))
3040 #if defined(USE_LONG_DOUBLE)
3041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3042 PTR2UV(sv), SvNVX(sv)));
3044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3045 PTR2UV(sv), SvNVX(sv)));
3048 #ifdef NV_PRESERVES_UV
3049 (void)SvIOKp_on(sv);
3051 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3052 SvIVX(sv) = I_V(SvNVX(sv));
3053 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3056 /* Integer is imprecise. NOK, IOKp */
3058 /* UV will not work better than IV */
3060 if (SvNVX(sv) > (NV)UV_MAX) {
3062 /* Integer is inaccurate. NOK, IOKp, is UV */
3066 SvUVX(sv) = U_V(SvNVX(sv));
3067 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3068 NV preservse UV so can do correct comparison. */
3069 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3073 /* Integer is imprecise. NOK, IOKp, is UV */
3078 #else /* NV_PRESERVES_UV */
3079 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3080 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3081 /* The UV slot will have been set from value returned by
3082 grok_number above. The NV slot has just been set using
3085 assert (SvIOKp(sv));
3087 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3088 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3089 /* Small enough to preserve all bits. */
3090 (void)SvIOKp_on(sv);
3092 SvIVX(sv) = I_V(SvNVX(sv));
3093 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3095 /* Assumption: first non-preserved integer is < IV_MAX,
3096 this NV is in the preserved range, therefore: */
3097 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3099 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);
3102 sv_2iuv_non_preserve (sv, numtype);
3104 #endif /* NV_PRESERVES_UV */
3108 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3109 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3112 if (SvTYPE(sv) < SVt_IV)
3113 /* Typically the caller expects that sv_any is not NULL now. */
3114 sv_upgrade(sv, SVt_IV);
3118 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3119 PTR2UV(sv),SvUVX(sv)));
3120 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3126 Return the num value of an SV, doing any necessary string or integer
3127 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3134 Perl_sv_2nv(pTHX_ register SV *sv)
3138 if (SvGMAGICAL(sv)) {
3142 if (SvPOKp(sv) && SvLEN(sv)) {
3143 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3144 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3146 return Atof(SvPVX(sv));
3150 return (NV)SvUVX(sv);
3152 return (NV)SvIVX(sv);
3155 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3156 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3162 if (SvTHINKFIRST(sv)) {
3165 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3166 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3167 return SvNV(tmpstr);
3168 return PTR2NV(SvRV(sv));
3171 sv_force_normal_flags(sv, 0);
3173 if (SvREADONLY(sv) && !SvOK(sv)) {
3174 if (ckWARN(WARN_UNINITIALIZED))
3179 if (SvTYPE(sv) < SVt_NV) {
3180 if (SvTYPE(sv) == SVt_IV)
3181 sv_upgrade(sv, SVt_PVNV);
3183 sv_upgrade(sv, SVt_NV);
3184 #ifdef USE_LONG_DOUBLE
3186 STORE_NUMERIC_LOCAL_SET_STANDARD();
3187 PerlIO_printf(Perl_debug_log,
3188 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3189 PTR2UV(sv), SvNVX(sv));
3190 RESTORE_NUMERIC_LOCAL();
3194 STORE_NUMERIC_LOCAL_SET_STANDARD();
3195 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3196 PTR2UV(sv), SvNVX(sv));
3197 RESTORE_NUMERIC_LOCAL();
3201 else if (SvTYPE(sv) < SVt_PVNV)
3202 sv_upgrade(sv, SVt_PVNV);
3207 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
3208 #ifdef NV_PRESERVES_UV
3211 /* Only set the public NV OK flag if this NV preserves the IV */
3212 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3213 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3214 : (SvIVX(sv) == I_V(SvNVX(sv))))
3220 else if (SvPOKp(sv) && SvLEN(sv)) {
3222 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3223 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3225 #ifdef NV_PRESERVES_UV
3226 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3227 == IS_NUMBER_IN_UV) {
3228 /* It's definitely an integer */
3229 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3231 SvNVX(sv) = Atof(SvPVX(sv));
3234 SvNVX(sv) = Atof(SvPVX(sv));
3235 /* Only set the public NV OK flag if this NV preserves the value in
3236 the PV at least as well as an IV/UV would.
3237 Not sure how to do this 100% reliably. */
3238 /* if that shift count is out of range then Configure's test is
3239 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3241 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3242 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3243 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3244 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3245 /* Can't use strtol etc to convert this string, so don't try.
3246 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3249 /* value has been set. It may not be precise. */
3250 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3251 /* 2s complement assumption for (UV)IV_MIN */
3252 SvNOK_on(sv); /* Integer is too negative. */
3257 if (numtype & IS_NUMBER_NEG) {
3258 SvIVX(sv) = -(IV)value;
3259 } else if (value <= (UV)IV_MAX) {
3260 SvIVX(sv) = (IV)value;
3266 if (numtype & IS_NUMBER_NOT_INT) {
3267 /* I believe that even if the original PV had decimals,
3268 they are lost beyond the limit of the FP precision.
3269 However, neither is canonical, so both only get p
3270 flags. NWC, 2000/11/25 */
3271 /* Both already have p flags, so do nothing */
3274 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3275 if (SvIVX(sv) == I_V(nv)) {
3280 /* It had no "." so it must be integer. */
3283 /* between IV_MAX and NV(UV_MAX).
3284 Could be slightly > UV_MAX */
3286 if (numtype & IS_NUMBER_NOT_INT) {
3287 /* UV and NV both imprecise. */
3289 UV nv_as_uv = U_V(nv);
3291 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3302 #endif /* NV_PRESERVES_UV */
3305 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3307 if (SvTYPE(sv) < SVt_NV)
3308 /* Typically the caller expects that sv_any is not NULL now. */
3309 /* XXX Ilya implies that this is a bug in callers that assume this
3310 and ideally should be fixed. */
3311 sv_upgrade(sv, SVt_NV);
3314 #if defined(USE_LONG_DOUBLE)
3316 STORE_NUMERIC_LOCAL_SET_STANDARD();
3317 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3318 PTR2UV(sv), SvNVX(sv));
3319 RESTORE_NUMERIC_LOCAL();
3323 STORE_NUMERIC_LOCAL_SET_STANDARD();
3324 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3325 PTR2UV(sv), SvNVX(sv));
3326 RESTORE_NUMERIC_LOCAL();
3332 /* asIV(): extract an integer from the string value of an SV.
3333 * Caller must validate PVX */
3336 S_asIV(pTHX_ SV *sv)
3339 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3341 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3342 == IS_NUMBER_IN_UV) {
3343 /* It's definitely an integer */
3344 if (numtype & IS_NUMBER_NEG) {
3345 if (value < (UV)IV_MIN)
3348 if (value < (UV)IV_MAX)
3353 if (ckWARN(WARN_NUMERIC))
3356 return I_V(Atof(SvPVX(sv)));
3359 /* asUV(): extract an unsigned integer from the string value of an SV
3360 * Caller must validate PVX */
3363 S_asUV(pTHX_ SV *sv)
3366 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3368 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3369 == IS_NUMBER_IN_UV) {
3370 /* It's definitely an integer */
3371 if (!(numtype & IS_NUMBER_NEG))
3375 if (ckWARN(WARN_NUMERIC))
3378 return U_V(Atof(SvPVX(sv)));
3382 =for apidoc sv_2pv_nolen
3384 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3385 use the macro wrapper C<SvPV_nolen(sv)> instead.
3390 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3393 return sv_2pv(sv, &n_a);
3396 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3397 * UV as a string towards the end of buf, and return pointers to start and
3400 * We assume that buf is at least TYPE_CHARS(UV) long.
3404 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3406 char *ptr = buf + TYPE_CHARS(UV);
3420 *--ptr = '0' + (char)(uv % 10);
3428 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3429 * this function provided for binary compatibility only
3433 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3435 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3439 =for apidoc sv_2pv_flags
3441 Returns a pointer to the string value of an SV, and sets *lp to its length.
3442 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3444 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3445 usually end up here too.
3451 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3456 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3457 char *tmpbuf = tbuf;
3463 if (SvGMAGICAL(sv)) {
3464 if (flags & SV_GMAGIC)
3472 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3474 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3479 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3484 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3485 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3492 if (SvTHINKFIRST(sv)) {
3495 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3496 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3497 char *pv = SvPV(tmpstr, *lp);
3511 switch (SvTYPE(sv)) {
3513 if ( ((SvFLAGS(sv) &
3514 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3515 == (SVs_OBJECT|SVs_SMG))
3516 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3517 regexp *re = (regexp *)mg->mg_obj;
3520 char *fptr = "msix";
3525 char need_newline = 0;
3526 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3528 while((ch = *fptr++)) {
3530 reflags[left++] = ch;
3533 reflags[right--] = ch;
3538 reflags[left] = '-';
3542 mg->mg_len = re->prelen + 4 + left;
3544 * If /x was used, we have to worry about a regex
3545 * ending with a comment later being embedded
3546 * within another regex. If so, we don't want this
3547 * regex's "commentization" to leak out to the
3548 * right part of the enclosing regex, we must cap
3549 * it with a newline.
3551 * So, if /x was used, we scan backwards from the
3552 * end of the regex. If we find a '#' before we
3553 * find a newline, we need to add a newline
3554 * ourself. If we find a '\n' first (or if we
3555 * don't find '#' or '\n'), we don't need to add
3556 * anything. -jfriedl
3558 if (PMf_EXTENDED & re->reganch)
3560 char *endptr = re->precomp + re->prelen;
3561 while (endptr >= re->precomp)
3563 char c = *(endptr--);
3565 break; /* don't need another */
3567 /* we end while in a comment, so we
3569 mg->mg_len++; /* save space for it */
3570 need_newline = 1; /* note to add it */
3576 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3577 Copy("(?", mg->mg_ptr, 2, char);
3578 Copy(reflags, mg->mg_ptr+2, left, char);
3579 Copy(":", mg->mg_ptr+left+2, 1, char);
3580 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3582 mg->mg_ptr[mg->mg_len - 2] = '\n';
3583 mg->mg_ptr[mg->mg_len - 1] = ')';
3584 mg->mg_ptr[mg->mg_len] = 0;
3586 PL_reginterp_cnt += re->program[0].next_off;
3588 if (re->reganch & ROPT_UTF8)
3603 case SVt_PVBM: if (SvROK(sv))
3606 s = "SCALAR"; break;
3607 case SVt_PVLV: s = SvROK(sv) ? "REF"
3608 /* tied lvalues should appear to be
3609 * scalars for backwards compatitbility */
3610 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3611 ? "SCALAR" : "LVALUE"; break;
3612 case SVt_PVAV: s = "ARRAY"; break;
3613 case SVt_PVHV: s = "HASH"; break;
3614 case SVt_PVCV: s = "CODE"; break;
3615 case SVt_PVGV: s = "GLOB"; break;
3616 case SVt_PVFM: s = "FORMAT"; break;
3617 case SVt_PVIO: s = "IO"; break;
3618 default: s = "UNKNOWN"; break;
3622 if (HvNAME(SvSTASH(sv)))
3623 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3625 Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3628 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3634 if (SvREADONLY(sv) && !SvOK(sv)) {
3635 if (ckWARN(WARN_UNINITIALIZED))
3641 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3642 /* I'm assuming that if both IV and NV are equally valid then
3643 converting the IV is going to be more efficient */
3644 U32 isIOK = SvIOK(sv);
3645 U32 isUIOK = SvIsUV(sv);
3646 char buf[TYPE_CHARS(UV)];
3649 if (SvTYPE(sv) < SVt_PVIV)
3650 sv_upgrade(sv, SVt_PVIV);
3652 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3654 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3655 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3656 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3657 SvCUR_set(sv, ebuf - ptr);
3667 else if (SvNOKp(sv)) {
3668 if (SvTYPE(sv) < SVt_PVNV)
3669 sv_upgrade(sv, SVt_PVNV);
3670 /* The +20 is pure guesswork. Configure test needed. --jhi */
3671 SvGROW(sv, NV_DIG + 20);
3673 olderrno = errno; /* some Xenix systems wipe out errno here */
3675 if (SvNVX(sv) == 0.0)
3676 (void)strcpy(s,"0");
3680 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3683 #ifdef FIXNEGATIVEZERO
3684 if (*s == '-' && s[1] == '0' && !s[2])
3694 if (ckWARN(WARN_UNINITIALIZED)
3695 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3698 if (SvTYPE(sv) < SVt_PV)
3699 /* Typically the caller expects that sv_any is not NULL now. */
3700 sv_upgrade(sv, SVt_PV);
3703 *lp = s - SvPVX(sv);
3706 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3707 PTR2UV(sv),SvPVX(sv)));
3711 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3712 /* Sneaky stuff here */
3716 tsv = newSVpv(tmpbuf, 0);
3732 len = strlen(tmpbuf);
3734 #ifdef FIXNEGATIVEZERO
3735 if (len == 2 && t[0] == '-' && t[1] == '0') {
3740 (void)SvUPGRADE(sv, SVt_PV);
3742 s = SvGROW(sv, len + 1);
3751 =for apidoc sv_copypv
3753 Copies a stringified representation of the source SV into the
3754 destination SV. Automatically performs any necessary mg_get and
3755 coercion of numeric values into strings. Guaranteed to preserve
3756 UTF-8 flag even from overloaded objects. Similar in nature to
3757 sv_2pv[_flags] but operates directly on an SV instead of just the
3758 string. Mostly uses sv_2pv_flags to do its work, except when that
3759 would lose the UTF-8'ness of the PV.
3765 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3770 sv_setpvn(dsv,s,len);
3778 =for apidoc sv_2pvbyte_nolen
3780 Return a pointer to the byte-encoded representation of the SV.
3781 May cause the SV to be downgraded from UTF-8 as a side-effect.
3783 Usually accessed via the C<SvPVbyte_nolen> macro.
3789 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3792 return sv_2pvbyte(sv, &n_a);
3796 =for apidoc sv_2pvbyte
3798 Return a pointer to the byte-encoded representation of the SV, and set *lp
3799 to its length. May cause the SV to be downgraded from UTF-8 as a
3802 Usually accessed via the C<SvPVbyte> macro.
3808 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3810 sv_utf8_downgrade(sv,0);
3811 return SvPV(sv,*lp);
3815 =for apidoc sv_2pvutf8_nolen
3817 Return a pointer to the UTF-8-encoded representation of the SV.
3818 May cause the SV to be upgraded to UTF-8 as a side-effect.
3820 Usually accessed via the C<SvPVutf8_nolen> macro.
3826 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3829 return sv_2pvutf8(sv, &n_a);
3833 =for apidoc sv_2pvutf8
3835 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3836 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3838 Usually accessed via the C<SvPVutf8> macro.
3844 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3846 sv_utf8_upgrade(sv);
3847 return SvPV(sv,*lp);
3851 =for apidoc sv_2bool
3853 This function is only called on magical items, and is only used by
3854 sv_true() or its macro equivalent.
3860 Perl_sv_2bool(pTHX_ register SV *sv)
3869 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3870 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3871 return (bool)SvTRUE(tmpsv);
3872 return SvRV(sv) != 0;
3875 register XPV* Xpvtmp;
3876 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3877 (*Xpvtmp->xpv_pv > '0' ||
3878 Xpvtmp->xpv_cur > 1 ||
3879 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3886 return SvIVX(sv) != 0;
3889 return SvNVX(sv) != 0.0;
3896 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3897 * this function provided for binary compatibility only
3902 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3904 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3908 =for apidoc sv_utf8_upgrade
3910 Converts the PV of an SV to its UTF-8-encoded form.
3911 Forces the SV to string form if it is not already.
3912 Always sets the SvUTF8 flag to avoid future validity checks even
3913 if all the bytes have hibit clear.
3915 This is not as a general purpose byte encoding to Unicode interface:
3916 use the Encode extension for that.
3918 =for apidoc sv_utf8_upgrade_flags
3920 Converts the PV of an SV to its UTF-8-encoded form.
3921 Forces the SV to string form if it is not already.
3922 Always sets the SvUTF8 flag to avoid future validity checks even
3923 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3924 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3925 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3927 This is not as a general purpose byte encoding to Unicode interface:
3928 use the Encode extension for that.
3934 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3941 (void) SvPV_force(sv,len);
3950 sv_force_normal_flags(sv, 0);
3953 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3954 sv_recode_to_utf8(sv, PL_encoding);
3955 else { /* Assume Latin-1/EBCDIC */
3956 /* This function could be much more efficient if we
3957 * had a FLAG in SVs to signal if there are any hibit
3958 * chars in the PV. Given that there isn't such a flag
3959 * make the loop as fast as possible. */
3960 s = (U8 *) SvPVX(sv);
3961 e = (U8 *) SvEND(sv);
3965 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3970 (void)SvOOK_off(sv);
3972 len = SvCUR(sv) + 1; /* Plus the \0 */
3973 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3974 SvCUR(sv) = len - 1;
3976 Safefree(s); /* No longer using what was there before. */
3977 SvLEN(sv) = len; /* No longer know the real size. */
3979 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3987 =for apidoc sv_utf8_downgrade
3989 Attempts to convert the PV of an SV from characters to bytes.
3990 If the PV contains a character beyond byte, this conversion will fail;
3991 in this case, either returns false or, if C<fail_ok> is not
3994 This is not as a general purpose Unicode to byte encoding interface:
3995 use the Encode extension for that.
4001 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4003 if (SvPOKp(sv) && SvUTF8(sv)) {
4009 sv_force_normal_flags(sv, 0);
4011 s = (U8 *) SvPV(sv, len);
4012 if (!utf8_to_bytes(s, &len)) {
4017 Perl_croak(aTHX_ "Wide character in %s",
4020 Perl_croak(aTHX_ "Wide character");
4031 =for apidoc sv_utf8_encode
4033 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4034 flag off so that it looks like octets again.
4040 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4042 (void) sv_utf8_upgrade(sv);
4044 sv_force_normal_flags(sv, 0);
4046 if (SvREADONLY(sv)) {
4047 Perl_croak(aTHX_ PL_no_modify);
4053 =for apidoc sv_utf8_decode
4055 If the PV of the SV is an octet sequence in UTF-8
4056 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4057 so that it looks like a character. If the PV contains only single-byte
4058 characters, the C<SvUTF8> flag stays being off.
4059 Scans PV for validity and returns false if the PV is invalid UTF-8.
4065 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4071 /* The octets may have got themselves encoded - get them back as
4074 if (!sv_utf8_downgrade(sv, TRUE))
4077 /* it is actually just a matter of turning the utf8 flag on, but
4078 * we want to make sure everything inside is valid utf8 first.
4080 c = (U8 *) SvPVX(sv);
4081 if (!is_utf8_string(c, SvCUR(sv)+1))
4083 e = (U8 *) SvEND(sv);
4086 if (!UTF8_IS_INVARIANT(ch)) {
4095 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4096 * this function provided for binary compatibility only
4100 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4102 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4106 =for apidoc sv_setsv
4108 Copies the contents of the source SV C<ssv> into the destination SV
4109 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4110 function if the source SV needs to be reused. Does not handle 'set' magic.
4111 Loosely speaking, it performs a copy-by-value, obliterating any previous
4112 content of the destination.
4114 You probably want to use one of the assortment of wrappers, such as
4115 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4116 C<SvSetMagicSV_nosteal>.
4118 =for apidoc sv_setsv_flags
4120 Copies the contents of the source SV C<ssv> into the destination SV
4121 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4122 function if the source SV needs to be reused. Does not handle 'set' magic.
4123 Loosely speaking, it performs a copy-by-value, obliterating any previous
4124 content of the destination.
4125 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4126 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4127 implemented in terms of this function.
4129 You probably want to use one of the assortment of wrappers, such as
4130 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4131 C<SvSetMagicSV_nosteal>.
4133 This is the primary function for copying scalars, and most other
4134 copy-ish functions and macros use this underneath.
4140 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4142 register U32 sflags;
4148 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4150 sstr = &PL_sv_undef;
4151 stype = SvTYPE(sstr);
4152 dtype = SvTYPE(dstr);
4157 /* need to nuke the magic */
4159 SvRMAGICAL_off(dstr);
4162 /* There's a lot of redundancy below but we're going for speed here */
4167 if (dtype != SVt_PVGV) {
4168 (void)SvOK_off(dstr);
4176 sv_upgrade(dstr, SVt_IV);
4179 sv_upgrade(dstr, SVt_PVNV);
4183 sv_upgrade(dstr, SVt_PVIV);
4186 (void)SvIOK_only(dstr);
4187 SvIVX(dstr) = SvIVX(sstr);
4190 if (SvTAINTED(sstr))
4201 sv_upgrade(dstr, SVt_NV);
4206 sv_upgrade(dstr, SVt_PVNV);
4209 SvNVX(dstr) = SvNVX(sstr);
4210 (void)SvNOK_only(dstr);
4211 if (SvTAINTED(sstr))
4219 sv_upgrade(dstr, SVt_RV);
4220 else if (dtype == SVt_PVGV &&
4221 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4224 if (GvIMPORTED(dstr) != GVf_IMPORTED
4225 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4227 GvIMPORTED_on(dstr);
4236 #ifdef PERL_COPY_ON_WRITE
4237 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4238 if (dtype < SVt_PVIV)
4239 sv_upgrade(dstr, SVt_PVIV);
4246 sv_upgrade(dstr, SVt_PV);
4249 if (dtype < SVt_PVIV)
4250 sv_upgrade(dstr, SVt_PVIV);
4253 if (dtype < SVt_PVNV)
4254 sv_upgrade(dstr, SVt_PVNV);
4261 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4264 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4268 if (dtype <= SVt_PVGV) {
4270 if (dtype != SVt_PVGV) {
4271 char *name = GvNAME(sstr);
4272 STRLEN len = GvNAMELEN(sstr);
4273 /* don't upgrade SVt_PVLV: it can hold a glob */
4274 if (dtype != SVt_PVLV)
4275 sv_upgrade(dstr, SVt_PVGV);
4276 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4277 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4278 GvNAME(dstr) = savepvn(name, len);
4279 GvNAMELEN(dstr) = len;
4280 SvFAKE_on(dstr); /* can coerce to non-glob */
4282 /* ahem, death to those who redefine active sort subs */
4283 else if (PL_curstackinfo->si_type == PERLSI_SORT
4284 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4285 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4288 #ifdef GV_UNIQUE_CHECK
4289 if (GvUNIQUE((GV*)dstr)) {
4290 Perl_croak(aTHX_ PL_no_modify);
4294 (void)SvOK_off(dstr);
4295 GvINTRO_off(dstr); /* one-shot flag */
4297 GvGP(dstr) = gp_ref(GvGP(sstr));
4298 if (SvTAINTED(sstr))
4300 if (GvIMPORTED(dstr) != GVf_IMPORTED
4301 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4303 GvIMPORTED_on(dstr);
4311 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4313 if ((int)SvTYPE(sstr) != stype) {
4314 stype = SvTYPE(sstr);
4315 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4319 if (stype == SVt_PVLV)
4320 (void)SvUPGRADE(dstr, SVt_PVNV);
4322 (void)SvUPGRADE(dstr, (U32)stype);
4325 sflags = SvFLAGS(sstr);
4327 if (sflags & SVf_ROK) {
4328 if (dtype >= SVt_PV) {
4329 if (dtype == SVt_PVGV) {
4330 SV *sref = SvREFCNT_inc(SvRV(sstr));
4332 int intro = GvINTRO(dstr);
4334 #ifdef GV_UNIQUE_CHECK
4335 if (GvUNIQUE((GV*)dstr)) {
4336 Perl_croak(aTHX_ PL_no_modify);
4341 GvINTRO_off(dstr); /* one-shot flag */
4342 GvLINE(dstr) = CopLINE(PL_curcop);
4343 GvEGV(dstr) = (GV*)dstr;
4346 switch (SvTYPE(sref)) {
4349 SAVEGENERICSV(GvAV(dstr));
4351 dref = (SV*)GvAV(dstr);
4352 GvAV(dstr) = (AV*)sref;
4353 if (!GvIMPORTED_AV(dstr)
4354 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4356 GvIMPORTED_AV_on(dstr);
4361 SAVEGENERICSV(GvHV(dstr));
4363 dref = (SV*)GvHV(dstr);
4364 GvHV(dstr) = (HV*)sref;
4365 if (!GvIMPORTED_HV(dstr)
4366 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4368 GvIMPORTED_HV_on(dstr);
4373 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4374 SvREFCNT_dec(GvCV(dstr));
4375 GvCV(dstr) = Nullcv;
4376 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4377 PL_sub_generation++;
4379 SAVEGENERICSV(GvCV(dstr));
4382 dref = (SV*)GvCV(dstr);
4383 if (GvCV(dstr) != (CV*)sref) {
4384 CV* cv = GvCV(dstr);
4386 if (!GvCVGEN((GV*)dstr) &&
4387 (CvROOT(cv) || CvXSUB(cv)))
4389 /* ahem, death to those who redefine
4390 * active sort subs */
4391 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4392 PL_sortcop == CvSTART(cv))
4394 "Can't redefine active sort subroutine %s",
4395 GvENAME((GV*)dstr));
4396 /* Redefining a sub - warning is mandatory if
4397 it was a const and its value changed. */
4398 if (ckWARN(WARN_REDEFINE)
4400 && (!CvCONST((CV*)sref)
4401 || sv_cmp(cv_const_sv(cv),
4402 cv_const_sv((CV*)sref)))))
4404 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4406 ? "Constant subroutine %s::%s redefined"
4407 : "Subroutine %s::%s redefined",
4408 HvNAME(GvSTASH((GV*)dstr)),
4409 GvENAME((GV*)dstr));
4413 cv_ckproto(cv, (GV*)dstr,
4414 SvPOK(sref) ? SvPVX(sref) : Nullch);
4416 GvCV(dstr) = (CV*)sref;
4417 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4418 GvASSUMECV_on(dstr);
4419 PL_sub_generation++;
4421 if (!GvIMPORTED_CV(dstr)
4422 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4424 GvIMPORTED_CV_on(dstr);
4429 SAVEGENERICSV(GvIOp(dstr));
4431 dref = (SV*)GvIOp(dstr);
4432 GvIOp(dstr) = (IO*)sref;
4436 SAVEGENERICSV(GvFORM(dstr));
4438 dref = (SV*)GvFORM(dstr);
4439 GvFORM(dstr) = (CV*)sref;
4443 SAVEGENERICSV(GvSV(dstr));
4445 dref = (SV*)GvSV(dstr);
4447 if (!GvIMPORTED_SV(dstr)
4448 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4450 GvIMPORTED_SV_on(dstr);
4456 if (SvTAINTED(sstr))
4461 (void)SvOOK_off(dstr); /* backoff */
4463 Safefree(SvPVX(dstr));
4464 SvLEN(dstr)=SvCUR(dstr)=0;
4467 (void)SvOK_off(dstr);
4468 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4470 if (sflags & SVp_NOK) {
4472 /* Only set the public OK flag if the source has public OK. */
4473 if (sflags & SVf_NOK)
4474 SvFLAGS(dstr) |= SVf_NOK;
4475 SvNVX(dstr) = SvNVX(sstr);
4477 if (sflags & SVp_IOK) {
4478 (void)SvIOKp_on(dstr);
4479 if (sflags & SVf_IOK)
4480 SvFLAGS(dstr) |= SVf_IOK;
4481 if (sflags & SVf_IVisUV)
4483 SvIVX(dstr) = SvIVX(sstr);
4485 if (SvAMAGIC(sstr)) {
4489 else if (sflags & SVp_POK) {
4493 * Check to see if we can just swipe the string. If so, it's a
4494 * possible small lose on short strings, but a big win on long ones.
4495 * It might even be a win on short strings if SvPVX(dstr)
4496 * has to be allocated and SvPVX(sstr) has to be freed.
4499 /* Whichever path we take through the next code, we want this true,
4500 and doing it now facilitates the COW check. */
4501 (void)SvPOK_only(dstr);
4504 #ifdef PERL_COPY_ON_WRITE
4505 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4509 (sflags & SVs_TEMP) && /* slated for free anyway? */
4510 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4511 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4512 SvLEN(sstr) && /* and really is a string */
4513 /* and won't be needed again, potentially */
4514 !(PL_op && PL_op->op_type == OP_AASSIGN))
4515 #ifdef PERL_COPY_ON_WRITE
4516 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4517 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4518 && SvTYPE(sstr) >= SVt_PVIV)
4521 /* Failed the swipe test, and it's not a shared hash key either.
4522 Have to copy the string. */
4523 STRLEN len = SvCUR(sstr);
4524 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4525 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4526 SvCUR_set(dstr, len);
4527 *SvEND(dstr) = '\0';
4529 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4531 #ifdef PERL_COPY_ON_WRITE
4532 /* Either it's a shared hash key, or it's suitable for
4533 copy-on-write or we can swipe the string. */
4535 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4540 /* I believe I should acquire a global SV mutex if
4541 it's a COW sv (not a shared hash key) to stop
4542 it going un copy-on-write.
4543 If the source SV has gone un copy on write between up there
4544 and down here, then (assert() that) it is of the correct
4545 form to make it copy on write again */
4546 if ((sflags & (SVf_FAKE | SVf_READONLY))
4547 != (SVf_FAKE | SVf_READONLY)) {
4548 SvREADONLY_on(sstr);
4550 /* Make the source SV into a loop of 1.
4551 (about to become 2) */
4552 SV_COW_NEXT_SV_SET(sstr, sstr);
4556 /* Initial code is common. */
4557 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4559 SvFLAGS(dstr) &= ~SVf_OOK;
4560 Safefree(SvPVX(dstr) - SvIVX(dstr));
4562 else if (SvLEN(dstr))
4563 Safefree(SvPVX(dstr));
4566 #ifdef PERL_COPY_ON_WRITE
4568 /* making another shared SV. */
4569 STRLEN cur = SvCUR(sstr);
4570 STRLEN len = SvLEN(sstr);
4571 assert (SvTYPE(dstr) >= SVt_PVIV);
4573 /* SvIsCOW_normal */
4574 /* splice us in between source and next-after-source. */
4575 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4576 SV_COW_NEXT_SV_SET(sstr, dstr);
4577 SvPV_set(dstr, SvPVX(sstr));
4579 /* SvIsCOW_shared_hash */
4580 UV hash = SvUVX(sstr);
4581 DEBUG_C(PerlIO_printf(Perl_debug_log,
4582 "Copy on write: Sharing hash\n"));
4584 sharepvn(SvPVX(sstr),
4585 (sflags & SVf_UTF8?-cur:cur), hash));
4590 SvREADONLY_on(dstr);
4592 /* Relesase a global SV mutex. */
4596 { /* Passes the swipe test. */
4597 SvPV_set(dstr, SvPVX(sstr));
4598 SvLEN_set(dstr, SvLEN(sstr));
4599 SvCUR_set(dstr, SvCUR(sstr));
4602 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4603 SvPV_set(sstr, Nullch);
4609 if (sflags & SVf_UTF8)
4612 if (sflags & SVp_NOK) {
4614 if (sflags & SVf_NOK)
4615 SvFLAGS(dstr) |= SVf_NOK;
4616 SvNVX(dstr) = SvNVX(sstr);
4618 if (sflags & SVp_IOK) {
4619 (void)SvIOKp_on(dstr);
4620 if (sflags & SVf_IOK)
4621 SvFLAGS(dstr) |= SVf_IOK;
4622 if (sflags & SVf_IVisUV)
4624 SvIVX(dstr) = SvIVX(sstr);
4627 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4628 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4629 smg->mg_ptr, smg->mg_len);
4630 SvRMAGICAL_on(dstr);
4633 else if (sflags & SVp_IOK) {
4634 if (sflags & SVf_IOK)
4635 (void)SvIOK_only(dstr);
4637 (void)SvOK_off(dstr);
4638 (void)SvIOKp_on(dstr);
4640 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4641 if (sflags & SVf_IVisUV)
4643 SvIVX(dstr) = SvIVX(sstr);
4644 if (sflags & SVp_NOK) {
4645 if (sflags & SVf_NOK)
4646 (void)SvNOK_on(dstr);
4648 (void)SvNOKp_on(dstr);
4649 SvNVX(dstr) = SvNVX(sstr);
4652 else if (sflags & SVp_NOK) {
4653 if (sflags & SVf_NOK)
4654 (void)SvNOK_only(dstr);
4656 (void)SvOK_off(dstr);
4659 SvNVX(dstr) = SvNVX(sstr);
4662 if (dtype == SVt_PVGV) {
4663 if (ckWARN(WARN_MISC))
4664 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4667 (void)SvOK_off(dstr);
4669 if (SvTAINTED(sstr))
4674 =for apidoc sv_setsv_mg
4676 Like C<sv_setsv>, but also handles 'set' magic.
4682 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4684 sv_setsv(dstr,sstr);
4688 #ifdef PERL_COPY_ON_WRITE
4690 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4692 STRLEN cur = SvCUR(sstr);
4693 STRLEN len = SvLEN(sstr);
4694 register char *new_pv;
4697 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4705 if (SvTHINKFIRST(dstr))
4706 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4707 else if (SvPVX(dstr))
4708 Safefree(SvPVX(dstr));
4712 (void)SvUPGRADE (dstr, SVt_PVIV);
4714 assert (SvPOK(sstr));
4715 assert (SvPOKp(sstr));
4716 assert (!SvIOK(sstr));
4717 assert (!SvIOKp(sstr));
4718 assert (!SvNOK(sstr));
4719 assert (!SvNOKp(sstr));
4721 if (SvIsCOW(sstr)) {
4723 if (SvLEN(sstr) == 0) {
4724 /* source is a COW shared hash key. */
4725 UV hash = SvUVX(sstr);
4726 DEBUG_C(PerlIO_printf(Perl_debug_log,
4727 "Fast copy on write: Sharing hash\n"));
4729 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4732 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4734 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4735 (void)SvUPGRADE (sstr, SVt_PVIV);
4736 SvREADONLY_on(sstr);
4738 DEBUG_C(PerlIO_printf(Perl_debug_log,
4739 "Fast copy on write: Converting sstr to COW\n"));
4740 SV_COW_NEXT_SV_SET(dstr, sstr);
4742 SV_COW_NEXT_SV_SET(sstr, dstr);
4743 new_pv = SvPVX(sstr);
4746 SvPV_set(dstr, new_pv);
4747 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4760 =for apidoc sv_setpvn
4762 Copies a string into an SV. The C<len> parameter indicates the number of
4763 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4769 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4771 register char *dptr;
4773 SV_CHECK_THINKFIRST_COW_DROP(sv);
4779 /* len is STRLEN which is unsigned, need to copy to signed */
4782 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4784 (void)SvUPGRADE(sv, SVt_PV);
4786 SvGROW(sv, len + 1);
4788 Move(ptr,dptr,len,char);
4791 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4796 =for apidoc sv_setpvn_mg
4798 Like C<sv_setpvn>, but also handles 'set' magic.
4804 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4806 sv_setpvn(sv,ptr,len);
4811 =for apidoc sv_setpv
4813 Copies a string into an SV. The string must be null-terminated. Does not
4814 handle 'set' magic. See C<sv_setpv_mg>.
4820 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4822 register STRLEN len;
4824 SV_CHECK_THINKFIRST_COW_DROP(sv);
4830 (void)SvUPGRADE(sv, SVt_PV);
4832 SvGROW(sv, len + 1);
4833 Move(ptr,SvPVX(sv),len+1,char);
4835 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4840 =for apidoc sv_setpv_mg
4842 Like C<sv_setpv>, but also handles 'set' magic.
4848 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4855 =for apidoc sv_usepvn
4857 Tells an SV to use C<ptr> to find its string value. Normally the string is
4858 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4859 The C<ptr> should point to memory that was allocated by C<malloc>. The
4860 string length, C<len>, must be supplied. This function will realloc the
4861 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4862 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4863 See C<sv_usepvn_mg>.
4869 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4871 SV_CHECK_THINKFIRST_COW_DROP(sv);
4872 (void)SvUPGRADE(sv, SVt_PV);
4877 (void)SvOOK_off(sv);
4878 if (SvPVX(sv) && SvLEN(sv))
4879 Safefree(SvPVX(sv));
4880 Renew(ptr, len+1, char);
4883 SvLEN_set(sv, len+1);
4885 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4890 =for apidoc sv_usepvn_mg
4892 Like C<sv_usepvn>, but also handles 'set' magic.
4898 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4900 sv_usepvn(sv,ptr,len);
4904 #ifdef PERL_COPY_ON_WRITE
4905 /* Need to do this *after* making the SV normal, as we need the buffer
4906 pointer to remain valid until after we've copied it. If we let go too early,
4907 another thread could invalidate it by unsharing last of the same hash key
4908 (which it can do by means other than releasing copy-on-write Svs)
4909 or by changing the other copy-on-write SVs in the loop. */
4911 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4912 U32 hash, SV *after)
4914 if (len) { /* this SV was SvIsCOW_normal(sv) */
4915 /* we need to find the SV pointing to us. */
4916 SV *current = SV_COW_NEXT_SV(after);
4918 if (current == sv) {
4919 /* The SV we point to points back to us (there were only two of us
4921 Hence other SV is no longer copy on write either. */
4923 SvREADONLY_off(after);
4925 /* We need to follow the pointers around the loop. */
4927 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4930 /* don't loop forever if the structure is bust, and we have
4931 a pointer into a closed loop. */
4932 assert (current != after);
4933 assert (SvPVX(current) == pvx);
4935 /* Make the SV before us point to the SV after us. */
4936 SV_COW_NEXT_SV_SET(current, after);
4939 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4944 Perl_sv_release_IVX(pTHX_ register SV *sv)
4947 sv_force_normal_flags(sv, 0);
4948 return SvOOK_off(sv);
4952 =for apidoc sv_force_normal_flags
4954 Undo various types of fakery on an SV: if the PV is a shared string, make
4955 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4956 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4957 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4958 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4959 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4960 set to some other value.) In addition, the C<flags> parameter gets passed to
4961 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4962 with flags set to 0.
4968 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4970 #ifdef PERL_COPY_ON_WRITE
4971 if (SvREADONLY(sv)) {
4972 /* At this point I believe I should acquire a global SV mutex. */
4974 char *pvx = SvPVX(sv);
4975 STRLEN len = SvLEN(sv);
4976 STRLEN cur = SvCUR(sv);
4977 U32 hash = SvUVX(sv);
4978 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4980 PerlIO_printf(Perl_debug_log,
4981 "Copy on write: Force normal %ld\n",
4987 /* This SV doesn't own the buffer, so need to New() a new one: */
4990 if (flags & SV_COW_DROP_PV) {
4991 /* OK, so we don't need to copy our buffer. */
4994 SvGROW(sv, cur + 1);
4995 Move(pvx,SvPVX(sv),cur,char);
4999 sv_release_COW(sv, pvx, cur, len, hash, next);
5004 else if (IN_PERL_RUNTIME)
5005 Perl_croak(aTHX_ PL_no_modify);
5006 /* At this point I believe that I can drop the global SV mutex. */
5009 if (SvREADONLY(sv)) {
5011 char *pvx = SvPVX(sv);
5012 int is_utf8 = SvUTF8(sv);
5013 STRLEN len = SvCUR(sv);
5014 U32 hash = SvUVX(sv);
5019 SvGROW(sv, len + 1);
5020 Move(pvx,SvPVX(sv),len,char);
5022 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5024 else if (IN_PERL_RUNTIME)
5025 Perl_croak(aTHX_ PL_no_modify);
5029 sv_unref_flags(sv, flags);
5030 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5035 =for apidoc sv_force_normal
5037 Undo various types of fakery on an SV: if the PV is a shared string, make
5038 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5039 an xpvmg. See also C<sv_force_normal_flags>.
5045 Perl_sv_force_normal(pTHX_ register SV *sv)
5047 sv_force_normal_flags(sv, 0);
5053 Efficient removal of characters from the beginning of the string buffer.
5054 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5055 the string buffer. The C<ptr> becomes the first character of the adjusted
5056 string. Uses the "OOK hack".
5057 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5058 refer to the same chunk of data.
5064 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5066 register STRLEN delta;
5067 if (!ptr || !SvPOKp(sv))
5069 delta = ptr - SvPVX(sv);
5070 SV_CHECK_THINKFIRST(sv);
5071 if (SvTYPE(sv) < SVt_PVIV)
5072 sv_upgrade(sv,SVt_PVIV);
5075 if (!SvLEN(sv)) { /* make copy of shared string */
5076 char *pvx = SvPVX(sv);
5077 STRLEN len = SvCUR(sv);
5078 SvGROW(sv, len + 1);
5079 Move(pvx,SvPVX(sv),len,char);
5083 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5084 and we do that anyway inside the SvNIOK_off
5086 SvFLAGS(sv) |= SVf_OOK;
5095 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5096 * this function provided for binary compatibility only
5100 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5102 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5106 =for apidoc sv_catpvn
5108 Concatenates the string onto the end of the string which is in the SV. The
5109 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5110 status set, then the bytes appended should be valid UTF-8.
5111 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5113 =for apidoc sv_catpvn_flags
5115 Concatenates the string onto the end of the string which is in the SV. The
5116 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5117 status set, then the bytes appended should be valid UTF-8.
5118 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5119 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5120 in terms of this function.
5126 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5131 dstr = SvPV_force_flags(dsv, dlen, flags);
5132 SvGROW(dsv, dlen + slen + 1);
5135 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5138 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5143 =for apidoc sv_catpvn_mg
5145 Like C<sv_catpvn>, but also handles 'set' magic.
5151 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5153 sv_catpvn(sv,ptr,len);
5157 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5158 * this function provided for binary compatibility only
5162 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5164 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5168 =for apidoc sv_catsv
5170 Concatenates the string from SV C<ssv> onto the end of the string in
5171 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5172 not 'set' magic. See C<sv_catsv_mg>.
5174 =for apidoc sv_catsv_flags
5176 Concatenates the string from SV C<ssv> onto the end of the string in
5177 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5178 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5179 and C<sv_catsv_nomg> are implemented in terms of this function.
5184 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5190 if ((spv = SvPV(ssv, slen))) {
5191 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5192 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5193 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5194 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5195 dsv->sv_flags doesn't have that bit set.
5196 Andy Dougherty 12 Oct 2001
5198 I32 sutf8 = DO_UTF8(ssv);
5201 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5203 dutf8 = DO_UTF8(dsv);
5205 if (dutf8 != sutf8) {
5207 /* Not modifying source SV, so taking a temporary copy. */
5208 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5210 sv_utf8_upgrade(csv);
5211 spv = SvPV(csv, slen);
5214 sv_utf8_upgrade_nomg(dsv);
5216 sv_catpvn_nomg(dsv, spv, slen);
5221 =for apidoc sv_catsv_mg
5223 Like C<sv_catsv>, but also handles 'set' magic.
5229 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5236 =for apidoc sv_catpv
5238 Concatenates the string onto the end of the string which is in the SV.
5239 If the SV has the UTF-8 status set, then the bytes appended should be
5240 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5245 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5247 register STRLEN len;
5253 junk = SvPV_force(sv, tlen);
5255 SvGROW(sv, tlen + len + 1);
5258 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5260 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5265 =for apidoc sv_catpv_mg
5267 Like C<sv_catpv>, but also handles 'set' magic.
5273 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5282 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5283 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5290 Perl_newSV(pTHX_ STRLEN len)
5296 sv_upgrade(sv, SVt_PV);
5297 SvGROW(sv, len + 1);
5302 =for apidoc sv_magicext
5304 Adds magic to an SV, upgrading it if necessary. Applies the
5305 supplied vtable and returns pointer to the magic added.
5307 Note that sv_magicext will allow things that sv_magic will not.
5308 In particular you can add magic to SvREADONLY SVs and and more than
5309 one instance of the same 'how'
5311 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
5312 if C<namelen> is zero then C<name> is stored as-is and - as another special
5313 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
5314 an C<SV*> and has its REFCNT incremented
5316 (This is now used as a subroutine by sv_magic.)
5321 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5322 const char* name, I32 namlen)
5326 if (SvTYPE(sv) < SVt_PVMG) {
5327 (void)SvUPGRADE(sv, SVt_PVMG);
5329 Newz(702,mg, 1, MAGIC);
5330 mg->mg_moremagic = SvMAGIC(sv);
5333 /* Some magic sontains a reference loop, where the sv and object refer to
5334 each other. To prevent a reference loop that would prevent such
5335 objects being freed, we look for such loops and if we find one we
5336 avoid incrementing the object refcount.
5338 Note we cannot do this to avoid self-tie loops as intervening RV must
5339 have its REFCNT incremented to keep it in existence.
5342 if (!obj || obj == sv ||
5343 how == PERL_MAGIC_arylen ||
5344 how == PERL_MAGIC_qr ||
5345 (SvTYPE(obj) == SVt_PVGV &&
5346 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5347 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5348 GvFORM(obj) == (CV*)sv)))
5353 mg->mg_obj = SvREFCNT_inc(obj);
5354 mg->mg_flags |= MGf_REFCOUNTED;
5357 /* Normal self-ties simply pass a null object, and instead of
5358 using mg_obj directly, use the SvTIED_obj macro to produce a
5359 new RV as needed. For glob "self-ties", we are tieing the PVIO
5360 with an RV obj pointing to the glob containing the PVIO. In
5361 this case, to avoid a reference loop, we need to weaken the
5365 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5366 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5372 mg->mg_len = namlen;
5375 mg->mg_ptr = savepvn(name, namlen);
5376 else if (namlen == HEf_SVKEY)
5377 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5379 mg->mg_ptr = (char *) name;
5381 mg->mg_virtual = vtable;
5385 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5390 =for apidoc sv_magic
5392 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5393 then adds a new magic item of type C<how> to the head of the magic list.
5399 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5404 #ifdef PERL_COPY_ON_WRITE
5406 sv_force_normal_flags(sv, 0);
5408 if (SvREADONLY(sv)) {
5410 && how != PERL_MAGIC_regex_global
5411 && how != PERL_MAGIC_bm
5412 && how != PERL_MAGIC_fm
5413 && how != PERL_MAGIC_sv
5414 && how != PERL_MAGIC_backref
5417 Perl_croak(aTHX_ PL_no_modify);
5420 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5421 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5422 /* sv_magic() refuses to add a magic of the same 'how' as an
5425 if (how == PERL_MAGIC_taint)
5433 vtable = &PL_vtbl_sv;
5435 case PERL_MAGIC_overload:
5436 vtable = &PL_vtbl_amagic;
5438 case PERL_MAGIC_overload_elem:
5439 vtable = &PL_vtbl_amagicelem;
5441 case PERL_MAGIC_overload_table:
5442 vtable = &PL_vtbl_ovrld;
5445 vtable = &PL_vtbl_bm;
5447 case PERL_MAGIC_regdata:
5448 vtable = &PL_vtbl_regdata;
5450 case PERL_MAGIC_regdatum:
5451 vtable = &PL_vtbl_regdatum;
5453 case PERL_MAGIC_env:
5454 vtable = &PL_vtbl_env;
5457 vtable = &PL_vtbl_fm;
5459 case PERL_MAGIC_envelem:
5460 vtable = &PL_vtbl_envelem;
5462 case PERL_MAGIC_regex_global:
5463 vtable = &PL_vtbl_mglob;
5465 case PERL_MAGIC_isa:
5466 vtable = &PL_vtbl_isa;
5468 case PERL_MAGIC_isaelem:
5469 vtable = &PL_vtbl_isaelem;
5471 case PERL_MAGIC_nkeys:
5472 vtable = &PL_vtbl_nkeys;
5474 case PERL_MAGIC_dbfile:
5477 case PERL_MAGIC_dbline:
5478 vtable = &PL_vtbl_dbline;
5480 #ifdef USE_LOCALE_COLLATE
5481 case PERL_MAGIC_collxfrm:
5482 vtable = &PL_vtbl_collxfrm;
5484 #endif /* USE_LOCALE_COLLATE */
5485 case PERL_MAGIC_tied:
5486 vtable = &PL_vtbl_pack;
5488 case PERL_MAGIC_tiedelem:
5489 case PERL_MAGIC_tiedscalar:
5490 vtable = &PL_vtbl_packelem;
5493 vtable = &PL_vtbl_regexp;
5495 case PERL_MAGIC_sig:
5496 vtable = &PL_vtbl_sig;
5498 case PERL_MAGIC_sigelem:
5499 vtable = &PL_vtbl_sigelem;
5501 case PERL_MAGIC_taint:
5502 vtable = &PL_vtbl_taint;
5504 case PERL_MAGIC_uvar:
5505 vtable = &PL_vtbl_uvar;
5507 case PERL_MAGIC_vec:
5508 vtable = &PL_vtbl_vec;
5510 case PERL_MAGIC_vstring:
5513 case PERL_MAGIC_utf8:
5514 vtable = &PL_vtbl_utf8;
5516 case PERL_MAGIC_substr:
5517 vtable = &PL_vtbl_substr;
5519 case PERL_MAGIC_defelem:
5520 vtable = &PL_vtbl_defelem;
5522 case PERL_MAGIC_glob:
5523 vtable = &PL_vtbl_glob;
5525 case PERL_MAGIC_arylen:
5526 vtable = &PL_vtbl_arylen;
5528 case PERL_MAGIC_pos:
5529 vtable = &PL_vtbl_pos;
5531 case PERL_MAGIC_backref:
5532 vtable = &PL_vtbl_backref;
5534 case PERL_MAGIC_ext:
5535 /* Reserved for use by extensions not perl internals. */
5536 /* Useful for attaching extension internal data to perl vars. */
5537 /* Note that multiple extensions may clash if magical scalars */
5538 /* etc holding private data from one are passed to another. */
5541 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5544 /* Rest of work is done else where */
5545 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5548 case PERL_MAGIC_taint:
5551 case PERL_MAGIC_ext:
5552 case PERL_MAGIC_dbfile:
5559 =for apidoc sv_unmagic
5561 Removes all magic of type C<type> from an SV.
5567 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5571 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5574 for (mg = *mgp; mg; mg = *mgp) {
5575 if (mg->mg_type == type) {
5576 MGVTBL* vtbl = mg->mg_virtual;
5577 *mgp = mg->mg_moremagic;
5578 if (vtbl && vtbl->svt_free)
5579 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5580 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5582 Safefree(mg->mg_ptr);
5583 else if (mg->mg_len == HEf_SVKEY)
5584 SvREFCNT_dec((SV*)mg->mg_ptr);
5585 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5586 Safefree(mg->mg_ptr);
5588 if (mg->mg_flags & MGf_REFCOUNTED)
5589 SvREFCNT_dec(mg->mg_obj);
5593 mgp = &mg->mg_moremagic;
5597 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5604 =for apidoc sv_rvweaken
5606 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5607 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5608 push a back-reference to this RV onto the array of backreferences
5609 associated with that magic.
5615 Perl_sv_rvweaken(pTHX_ SV *sv)
5618 if (!SvOK(sv)) /* let undefs pass */
5621 Perl_croak(aTHX_ "Can't weaken a nonreference");
5622 else if (SvWEAKREF(sv)) {
5623 if (ckWARN(WARN_MISC))
5624 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5628 sv_add_backref(tsv, sv);
5634 /* Give tsv backref magic if it hasn't already got it, then push a
5635 * back-reference to sv onto the array associated with the backref magic.
5639 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5643 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5644 av = (AV*)mg->mg_obj;
5647 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5648 /* av now has a refcnt of 2, which avoids it getting freed
5649 * before us during global cleanup. The extra ref is removed
5650 * by magic_killbackrefs() when tsv is being freed */
5652 if (AvFILLp(av) >= AvMAX(av)) {
5654 SV **svp = AvARRAY(av);
5655 for (i = AvFILLp(av); i >= 0; i--)
5657 svp[i] = sv; /* reuse the slot */
5660 av_extend(av, AvFILLp(av)+1);
5662 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5665 /* delete a back-reference to ourselves from the backref magic associated
5666 * with the SV we point to.
5670 S_sv_del_backref(pTHX_ SV *sv)
5677 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5678 Perl_croak(aTHX_ "panic: del_backref");
5679 av = (AV *)mg->mg_obj;
5681 for (i = AvFILLp(av); i >= 0; i--)
5682 if (svp[i] == sv) svp[i] = Nullsv;
5686 =for apidoc sv_insert
5688 Inserts a string at the specified offset/length within the SV. Similar to
5689 the Perl substr() function.
5695 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5699 register char *midend;
5700 register char *bigend;
5706 Perl_croak(aTHX_ "Can't modify non-existent substring");
5707 SvPV_force(bigstr, curlen);
5708 (void)SvPOK_only_UTF8(bigstr);
5709 if (offset + len > curlen) {
5710 SvGROW(bigstr, offset+len+1);
5711 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5712 SvCUR_set(bigstr, offset+len);
5716 i = littlelen - len;
5717 if (i > 0) { /* string might grow */
5718 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5719 mid = big + offset + len;
5720 midend = bigend = big + SvCUR(bigstr);
5723 while (midend > mid) /* shove everything down */
5724 *--bigend = *--midend;
5725 Move(little,big+offset,littlelen,char);
5731 Move(little,SvPVX(bigstr)+offset,len,char);
5736 big = SvPVX(bigstr);
5739 bigend = big + SvCUR(bigstr);
5741 if (midend > bigend)
5742 Perl_croak(aTHX_ "panic: sv_insert");
5744 if (mid - big > bigend - midend) { /* faster to shorten from end */
5746 Move(little, mid, littlelen,char);
5749 i = bigend - midend;
5751 Move(midend, mid, i,char);
5755 SvCUR_set(bigstr, mid - big);
5758 else if ((i = mid - big)) { /* faster from front */
5759 midend -= littlelen;
5761 sv_chop(bigstr,midend-i);
5766 Move(little, mid, littlelen,char);
5768 else if (littlelen) {
5769 midend -= littlelen;
5770 sv_chop(bigstr,midend);
5771 Move(little,midend,littlelen,char);
5774 sv_chop(bigstr,midend);
5780 =for apidoc sv_replace
5782 Make the first argument a copy of the second, then delete the original.
5783 The target SV physically takes over ownership of the body of the source SV
5784 and inherits its flags; however, the target keeps any magic it owns,
5785 and any magic in the source is discarded.
5786 Note that this is a rather specialist SV copying operation; most of the
5787 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5793 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5795 U32 refcnt = SvREFCNT(sv);
5796 SV_CHECK_THINKFIRST_COW_DROP(sv);
5797 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5798 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5799 if (SvMAGICAL(sv)) {
5803 sv_upgrade(nsv, SVt_PVMG);
5804 SvMAGIC(nsv) = SvMAGIC(sv);
5805 SvFLAGS(nsv) |= SvMAGICAL(sv);
5811 assert(!SvREFCNT(sv));
5812 StructCopy(nsv,sv,SV);
5813 #ifdef PERL_COPY_ON_WRITE
5814 if (SvIsCOW_normal(nsv)) {
5815 /* We need to follow the pointers around the loop to make the
5816 previous SV point to sv, rather than nsv. */
5819 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5822 assert(SvPVX(current) == SvPVX(nsv));
5824 /* Make the SV before us point to the SV after us. */
5826 PerlIO_printf(Perl_debug_log, "previous is\n");
5828 PerlIO_printf(Perl_debug_log,
5829 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5830 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5832 SV_COW_NEXT_SV_SET(current, sv);
5835 SvREFCNT(sv) = refcnt;
5836 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5842 =for apidoc sv_clear
5844 Clear an SV: call any destructors, free up any memory used by the body,
5845 and free the body itself. The SV's head is I<not> freed, although
5846 its type is set to all 1's so that it won't inadvertently be assumed
5847 to be live during global destruction etc.
5848 This function should only be called when REFCNT is zero. Most of the time
5849 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5856 Perl_sv_clear(pTHX_ register SV *sv)
5860 assert(SvREFCNT(sv) == 0);
5863 if (PL_defstash) { /* Still have a symbol table? */
5870 stash = SvSTASH(sv);
5871 destructor = StashHANDLER(stash,DESTROY);
5873 SV* tmpref = newRV(sv);
5874 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5876 PUSHSTACKi(PERLSI_DESTROY);
5881 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5887 if(SvREFCNT(tmpref) < 2) {
5888 /* tmpref is not kept alive! */
5893 SvREFCNT_dec(tmpref);
5895 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5899 if (PL_in_clean_objs)
5900 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5902 /* DESTROY gave object new lease on life */
5908 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5909 SvOBJECT_off(sv); /* Curse the object. */
5910 if (SvTYPE(sv) != SVt_PVIO)
5911 --PL_sv_objcount; /* XXX Might want something more general */
5914 if (SvTYPE(sv) >= SVt_PVMG) {
5917 if (SvFLAGS(sv) & SVpad_TYPED)
5918 SvREFCNT_dec(SvSTASH(sv));
5921 switch (SvTYPE(sv)) {
5924 IoIFP(sv) != PerlIO_stdin() &&
5925 IoIFP(sv) != PerlIO_stdout() &&
5926 IoIFP(sv) != PerlIO_stderr())
5928 io_close((IO*)sv, FALSE);
5930 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5931 PerlDir_close(IoDIRP(sv));
5932 IoDIRP(sv) = (DIR*)NULL;
5933 Safefree(IoTOP_NAME(sv));
5934 Safefree(IoFMT_NAME(sv));
5935 Safefree(IoBOTTOM_NAME(sv));
5950 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5951 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5952 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5953 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5955 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5956 SvREFCNT_dec(LvTARG(sv));
5960 Safefree(GvNAME(sv));
5961 /* cannot decrease stash refcount yet, as we might recursively delete
5962 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5963 of stash until current sv is completely gone.
5964 -- JohnPC, 27 Mar 1998 */
5965 stash = GvSTASH(sv);
5971 (void)SvOOK_off(sv);
5979 SvREFCNT_dec(SvRV(sv));
5981 #ifdef PERL_COPY_ON_WRITE
5982 else if (SvPVX(sv)) {
5984 /* I believe I need to grab the global SV mutex here and
5985 then recheck the COW status. */
5987 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5990 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5991 SvUVX(sv), SV_COW_NEXT_SV(sv));
5992 /* And drop it here. */
5994 } else if (SvLEN(sv)) {
5995 Safefree(SvPVX(sv));
5999 else if (SvPVX(sv) && SvLEN(sv))
6000 Safefree(SvPVX(sv));
6001 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6002 unsharepvn(SvPVX(sv),
6003 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6017 switch (SvTYPE(sv)) {
6033 del_XPVIV(SvANY(sv));
6036 del_XPVNV(SvANY(sv));
6039 del_XPVMG(SvANY(sv));
6042 del_XPVLV(SvANY(sv));
6045 del_XPVAV(SvANY(sv));
6048 del_XPVHV(SvANY(sv));
6051 del_XPVCV(SvANY(sv));
6054 del_XPVGV(SvANY(sv));
6055 /* code duplication for increased performance. */
6056 SvFLAGS(sv) &= SVf_BREAK;
6057 SvFLAGS(sv) |= SVTYPEMASK;
6058 /* decrease refcount of the stash that owns this GV, if any */
6060 SvREFCNT_dec(stash);
6061 return; /* not break, SvFLAGS reset already happened */
6063 del_XPVBM(SvANY(sv));
6066 del_XPVFM(SvANY(sv));
6069 del_XPVIO(SvANY(sv));
6072 SvFLAGS(sv) &= SVf_BREAK;
6073 SvFLAGS(sv) |= SVTYPEMASK;
6077 =for apidoc sv_newref
6079 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6086 Perl_sv_newref(pTHX_ SV *sv)
6096 Decrement an SV's reference count, and if it drops to zero, call
6097 C<sv_clear> to invoke destructors and free up any memory used by
6098 the body; finally, deallocate the SV's head itself.
6099 Normally called via a wrapper macro C<SvREFCNT_dec>.
6105 Perl_sv_free(pTHX_ SV *sv)
6109 if (SvREFCNT(sv) == 0) {
6110 if (SvFLAGS(sv) & SVf_BREAK)
6111 /* this SV's refcnt has been artificially decremented to
6112 * trigger cleanup */
6114 if (PL_in_clean_all) /* All is fair */
6116 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6117 /* make sure SvREFCNT(sv)==0 happens very seldom */
6118 SvREFCNT(sv) = (~(U32)0)/2;
6121 if (ckWARN_d(WARN_INTERNAL))
6122 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6123 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6124 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6127 if (--(SvREFCNT(sv)) > 0)
6129 Perl_sv_free2(aTHX_ sv);
6133 Perl_sv_free2(pTHX_ SV *sv)
6137 if (ckWARN_d(WARN_DEBUGGING))
6138 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6139 "Attempt to free temp prematurely: SV 0x%"UVxf
6140 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6144 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6145 /* make sure SvREFCNT(sv)==0 happens very seldom */
6146 SvREFCNT(sv) = (~(U32)0)/2;
6157 Returns the length of the string in the SV. Handles magic and type
6158 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6164 Perl_sv_len(pTHX_ register SV *sv)
6172 len = mg_length(sv);
6174 (void)SvPV(sv, len);
6179 =for apidoc sv_len_utf8
6181 Returns the number of characters in the string in an SV, counting wide
6182 UTF-8 bytes as a single character. Handles magic and type coercion.
6188 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6189 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6190 * (Note that the mg_len is not the length of the mg_ptr field.)
6195 Perl_sv_len_utf8(pTHX_ register SV *sv)
6201 return mg_length(sv);
6205 U8 *s = (U8*)SvPV(sv, len);
6206 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6208 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6210 #ifdef PERL_UTF8_CACHE_ASSERT
6211 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6215 ulen = Perl_utf8_length(aTHX_ s, s + len);
6216 if (!mg && !SvREADONLY(sv)) {
6217 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6218 mg = mg_find(sv, PERL_MAGIC_utf8);
6228 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6229 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6230 * between UTF-8 and byte offsets. There are two (substr offset and substr
6231 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6232 * and byte offset) cache positions.
6234 * The mg_len field is used by sv_len_utf8(), see its comments.
6235 * Note that the mg_len is not the length of the mg_ptr field.
6239 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6243 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6245 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6249 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6251 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6252 (*mgp)->mg_ptr = (char *) *cachep;
6256 (*cachep)[i] = *offsetp;
6257 (*cachep)[i+1] = s - start;
6265 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6266 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6267 * between UTF-8 and byte offsets. See also the comments of
6268 * S_utf8_mg_pos_init().
6272 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6276 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6278 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6279 if (*mgp && (*mgp)->mg_ptr) {
6280 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6281 ASSERT_UTF8_CACHE(*cachep);
6282 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6284 else { /* We will skip to the right spot. */
6289 /* The assumption is that going backward is half
6290 * the speed of going forward (that's where the
6291 * 2 * backw in the below comes from). (The real
6292 * figure of course depends on the UTF-8 data.) */
6294 if ((*cachep)[i] > (STRLEN)uoff) {
6296 backw = (*cachep)[i] - (STRLEN)uoff;
6298 if (forw < 2 * backw)
6301 p = start + (*cachep)[i+1];
6303 /* Try this only for the substr offset (i == 0),
6304 * not for the substr length (i == 2). */
6305 else if (i == 0) { /* (*cachep)[i] < uoff */
6306 STRLEN ulen = sv_len_utf8(sv);
6308 if ((STRLEN)uoff < ulen) {
6309 forw = (STRLEN)uoff - (*cachep)[i];
6310 backw = ulen - (STRLEN)uoff;
6312 if (forw < 2 * backw)
6313 p = start + (*cachep)[i+1];
6318 /* If the string is not long enough for uoff,
6319 * we could extend it, but not at this low a level. */
6323 if (forw < 2 * backw) {
6330 while (UTF8_IS_CONTINUATION(*p))
6335 /* Update the cache. */
6336 (*cachep)[i] = (STRLEN)uoff;
6337 (*cachep)[i+1] = p - start;
6339 /* Drop the stale "length" cache */
6348 if (found) { /* Setup the return values. */
6349 *offsetp = (*cachep)[i+1];
6350 *sp = start + *offsetp;
6353 *offsetp = send - start;
6355 else if (*sp < start) {
6361 #ifdef PERL_UTF8_CACHE_ASSERT
6366 while (n-- && s < send)
6370 assert(*offsetp == s - start);
6371 assert((*cachep)[0] == (STRLEN)uoff);
6372 assert((*cachep)[1] == *offsetp);
6374 ASSERT_UTF8_CACHE(*cachep);
6383 =for apidoc sv_pos_u2b
6385 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6386 the start of the string, to a count of the equivalent number of bytes; if
6387 lenp is non-zero, it does the same to lenp, but this time starting from
6388 the offset, rather than from the start of the string. Handles magic and
6395 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6396 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6397 * byte offsets. See also the comments of S_utf8_mg_pos().
6402 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6413 start = s = (U8*)SvPV(sv, len);
6415 I32 uoffset = *offsetp;
6420 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6422 if (!found && uoffset > 0) {
6423 while (s < send && uoffset--)
6427 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6429 *offsetp = s - start;
6434 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6438 if (!found && *lenp > 0) {
6441 while (s < send && ulen--)
6445 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6449 ASSERT_UTF8_CACHE(cache);
6461 =for apidoc sv_pos_b2u
6463 Converts the value pointed to by offsetp from a count of bytes from the
6464 start of the string, to a count of the equivalent number of UTF-8 chars.
6465 Handles magic and type coercion.
6471 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6472 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6473 * byte offsets. See also the comments of S_utf8_mg_pos().
6478 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6486 s = (U8*)SvPV(sv, len);
6487 if ((I32)len < *offsetp)
6488 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6490 U8* send = s + *offsetp;
6492 STRLEN *cache = NULL;
6496 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6497 mg = mg_find(sv, PERL_MAGIC_utf8);
6498 if (mg && mg->mg_ptr) {
6499 cache = (STRLEN *) mg->mg_ptr;
6500 if (cache[1] == (STRLEN)*offsetp) {
6501 /* An exact match. */
6502 *offsetp = cache[0];
6506 else if (cache[1] < (STRLEN)*offsetp) {
6507 /* We already know part of the way. */
6510 /* Let the below loop do the rest. */
6512 else { /* cache[1] > *offsetp */
6513 /* We already know all of the way, now we may
6514 * be able to walk back. The same assumption
6515 * is made as in S_utf8_mg_pos(), namely that
6516 * walking backward is twice slower than
6517 * walking forward. */
6518 STRLEN forw = *offsetp;
6519 STRLEN backw = cache[1] - *offsetp;
6521 if (!(forw < 2 * backw)) {
6522 U8 *p = s + cache[1];
6529 while (UTF8_IS_CONTINUATION(*p)) {
6537 *offsetp = cache[0];
6539 /* Drop the stale "length" cache */
6547 ASSERT_UTF8_CACHE(cache);
6553 /* Call utf8n_to_uvchr() to validate the sequence
6554 * (unless a simple non-UTF character) */
6555 if (!UTF8_IS_INVARIANT(*s))
6556 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6565 if (!SvREADONLY(sv)) {
6567 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6568 mg = mg_find(sv, PERL_MAGIC_utf8);
6573 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6574 mg->mg_ptr = (char *) cache;
6579 cache[1] = *offsetp;
6580 /* Drop the stale "length" cache */
6593 Returns a boolean indicating whether the strings in the two SVs are
6594 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6595 coerce its args to strings if necessary.
6601 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6609 SV* svrecode = Nullsv;
6616 pv1 = SvPV(sv1, cur1);
6623 pv2 = SvPV(sv2, cur2);
6625 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6626 /* Differing utf8ness.
6627 * Do not UTF8size the comparands as a side-effect. */
6630 svrecode = newSVpvn(pv2, cur2);
6631 sv_recode_to_utf8(svrecode, PL_encoding);
6632 pv2 = SvPV(svrecode, cur2);
6635 svrecode = newSVpvn(pv1, cur1);
6636 sv_recode_to_utf8(svrecode, PL_encoding);
6637 pv1 = SvPV(svrecode, cur1);
6639 /* Now both are in UTF-8. */
6644 bool is_utf8 = TRUE;
6647 /* sv1 is the UTF-8 one,
6648 * if is equal it must be downgrade-able */
6649 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6655 /* sv2 is the UTF-8 one,
6656 * if is equal it must be downgrade-able */
6657 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6663 /* Downgrade not possible - cannot be eq */
6670 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6673 SvREFCNT_dec(svrecode);
6684 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6685 string in C<sv1> is less than, equal to, or greater than the string in
6686 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6687 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6693 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6696 char *pv1, *pv2, *tpv = Nullch;
6698 SV *svrecode = Nullsv;
6705 pv1 = SvPV(sv1, cur1);
6712 pv2 = SvPV(sv2, cur2);
6714 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6715 /* Differing utf8ness.
6716 * Do not UTF8size the comparands as a side-effect. */
6719 svrecode = newSVpvn(pv2, cur2);
6720 sv_recode_to_utf8(svrecode, PL_encoding);
6721 pv2 = SvPV(svrecode, cur2);
6724 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6729 svrecode = newSVpvn(pv1, cur1);
6730 sv_recode_to_utf8(svrecode, PL_encoding);
6731 pv1 = SvPV(svrecode, cur1);
6734 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6740 cmp = cur2 ? -1 : 0;
6744 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6747 cmp = retval < 0 ? -1 : 1;
6748 } else if (cur1 == cur2) {
6751 cmp = cur1 < cur2 ? -1 : 1;
6756 SvREFCNT_dec(svrecode);
6765 =for apidoc sv_cmp_locale
6767 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6768 'use bytes' aware, handles get magic, and will coerce its args to strings
6769 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6775 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6777 #ifdef USE_LOCALE_COLLATE
6783 if (PL_collation_standard)
6787 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6789 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6791 if (!pv1 || !len1) {
6802 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6805 return retval < 0 ? -1 : 1;
6808 * When the result of collation is equality, that doesn't mean
6809 * that there are no differences -- some locales exclude some
6810 * characters from consideration. So to avoid false equalities,
6811 * we use the raw string as a tiebreaker.
6817 #endif /* USE_LOCALE_COLLATE */
6819 return sv_cmp(sv1, sv2);
6823 #ifdef USE_LOCALE_COLLATE
6826 =for apidoc sv_collxfrm
6828 Add Collate Transform magic to an SV if it doesn't already have it.
6830 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6831 scalar data of the variable, but transformed to such a format that a normal
6832 memory comparison can be used to compare the data according to the locale
6839 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6843 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6844 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6849 Safefree(mg->mg_ptr);
6851 if ((xf = mem_collxfrm(s, len, &xlen))) {
6852 if (SvREADONLY(sv)) {
6855 return xf + sizeof(PL_collation_ix);
6858 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6859 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6872 if (mg && mg->mg_ptr) {
6874 return mg->mg_ptr + sizeof(PL_collation_ix);
6882 #endif /* USE_LOCALE_COLLATE */
6887 Get a line from the filehandle and store it into the SV, optionally
6888 appending to the currently-stored string.
6894 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6898 register STDCHAR rslast;
6899 register STDCHAR *bp;
6905 if (SvTHINKFIRST(sv))
6906 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6907 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6909 However, perlbench says it's slower, because the existing swipe code
6910 is faster than copy on write.
6911 Swings and roundabouts. */
6912 (void)SvUPGRADE(sv, SVt_PV);
6917 if (PerlIO_isutf8(fp)) {
6919 sv_utf8_upgrade_nomg(sv);
6920 sv_pos_u2b(sv,&append,0);
6922 } else if (SvUTF8(sv)) {
6923 SV *tsv = NEWSV(0,0);
6924 sv_gets(tsv, fp, 0);
6925 sv_utf8_upgrade_nomg(tsv);
6926 SvCUR_set(sv,append);
6929 goto return_string_or_null;
6934 if (PerlIO_isutf8(fp))
6937 if (IN_PERL_COMPILETIME) {
6938 /* we always read code in line mode */
6942 else if (RsSNARF(PL_rs)) {
6943 /* If it is a regular disk file use size from stat() as estimate
6944 of amount we are going to read - may result in malloc-ing
6945 more memory than we realy need if layers bellow reduce
6946 size we read (e.g. CRLF or a gzip layer)
6949 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6950 Off_t offset = PerlIO_tell(fp);
6951 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6952 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6958 else if (RsRECORD(PL_rs)) {
6962 /* Grab the size of the record we're getting */
6963 recsize = SvIV(SvRV(PL_rs));
6964 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6967 /* VMS wants read instead of fread, because fread doesn't respect */
6968 /* RMS record boundaries. This is not necessarily a good thing to be */
6969 /* doing, but we've got no other real choice - except avoid stdio
6970 as implementation - perhaps write a :vms layer ?
6972 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6974 bytesread = PerlIO_read(fp, buffer, recsize);
6978 SvCUR_set(sv, bytesread += append);
6979 buffer[bytesread] = '\0';
6980 goto return_string_or_null;
6982 else if (RsPARA(PL_rs)) {
6988 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6989 if (PerlIO_isutf8(fp)) {
6990 rsptr = SvPVutf8(PL_rs, rslen);
6993 if (SvUTF8(PL_rs)) {
6994 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6995 Perl_croak(aTHX_ "Wide character in $/");
6998 rsptr = SvPV(PL_rs, rslen);
7002 rslast = rslen ? rsptr[rslen - 1] : '\0';
7004 if (rspara) { /* have to do this both before and after */
7005 do { /* to make sure file boundaries work right */
7008 i = PerlIO_getc(fp);
7012 PerlIO_ungetc(fp,i);
7018 /* See if we know enough about I/O mechanism to cheat it ! */
7020 /* This used to be #ifdef test - it is made run-time test for ease
7021 of abstracting out stdio interface. One call should be cheap
7022 enough here - and may even be a macro allowing compile
7026 if (PerlIO_fast_gets(fp)) {
7029 * We're going to steal some values from the stdio struct
7030 * and put EVERYTHING in the innermost loop into registers.
7032 register STDCHAR *ptr;
7036 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7037 /* An ungetc()d char is handled separately from the regular
7038 * buffer, so we getc() it back out and stuff it in the buffer.
7040 i = PerlIO_getc(fp);
7041 if (i == EOF) return 0;
7042 *(--((*fp)->_ptr)) = (unsigned char) i;
7046 /* Here is some breathtakingly efficient cheating */
7048 cnt = PerlIO_get_cnt(fp); /* get count into register */
7049 /* make sure we have the room */
7050 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7051 /* Not room for all of it
7052 if we are looking for a separator and room for some
7054 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7055 /* just process what we have room for */
7056 shortbuffered = cnt - SvLEN(sv) + append + 1;
7057 cnt -= shortbuffered;
7061 /* remember that cnt can be negative */
7062 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7067 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7068 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7069 DEBUG_P(PerlIO_printf(Perl_debug_log,
7070 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7071 DEBUG_P(PerlIO_printf(Perl_debug_log,
7072 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7073 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7074 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7079 while (cnt > 0) { /* this | eat */
7081 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7082 goto thats_all_folks; /* screams | sed :-) */
7086 Copy(ptr, bp, cnt, char); /* this | eat */
7087 bp += cnt; /* screams | dust */
7088 ptr += cnt; /* louder | sed :-) */
7093 if (shortbuffered) { /* oh well, must extend */
7094 cnt = shortbuffered;
7096 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7098 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7099 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7103 DEBUG_P(PerlIO_printf(Perl_debug_log,
7104 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7105 PTR2UV(ptr),(long)cnt));
7106 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7108 DEBUG_P(PerlIO_printf(Perl_debug_log,
7109 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7110 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7111 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7113 /* This used to call 'filbuf' in stdio form, but as that behaves like
7114 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7115 another abstraction. */
7116 i = PerlIO_getc(fp); /* get more characters */
7118 DEBUG_P(PerlIO_printf(Perl_debug_log,
7119 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7120 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7121 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7123 cnt = PerlIO_get_cnt(fp);
7124 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7125 DEBUG_P(PerlIO_printf(Perl_debug_log,
7126 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7128 if (i == EOF) /* all done for ever? */
7129 goto thats_really_all_folks;
7131 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7133 SvGROW(sv, bpx + cnt + 2);
7134 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7136 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7138 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7139 goto thats_all_folks;
7143 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7144 memNE((char*)bp - rslen, rsptr, rslen))
7145 goto screamer; /* go back to the fray */
7146 thats_really_all_folks:
7148 cnt += shortbuffered;
7149 DEBUG_P(PerlIO_printf(Perl_debug_log,
7150 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7151 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7152 DEBUG_P(PerlIO_printf(Perl_debug_log,
7153 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7154 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7155 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7157 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7158 DEBUG_P(PerlIO_printf(Perl_debug_log,
7159 "Screamer: done, len=%ld, string=|%.*s|\n",
7160 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7164 /*The big, slow, and stupid way. */
7166 /* Any stack-challenged places. */
7168 /* EPOC: need to work around SDK features. *
7169 * On WINS: MS VC5 generates calls to _chkstk, *
7170 * if a "large" stack frame is allocated. *
7171 * gcc on MARM does not generate calls like these. */
7172 # define USEHEAPINSTEADOFSTACK
7175 #ifdef USEHEAPINSTEADOFSTACK
7177 New(0, buf, 8192, STDCHAR);
7185 register STDCHAR *bpe = buf + sizeof(buf);
7187 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7188 ; /* keep reading */
7192 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7193 /* Accomodate broken VAXC compiler, which applies U8 cast to
7194 * both args of ?: operator, causing EOF to change into 255
7197 i = (U8)buf[cnt - 1];
7203 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7205 sv_catpvn(sv, (char *) buf, cnt);
7207 sv_setpvn(sv, (char *) buf, cnt);
7209 if (i != EOF && /* joy */
7211 SvCUR(sv) < rslen ||
7212 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7216 * If we're reading from a TTY and we get a short read,
7217 * indicating that the user hit his EOF character, we need
7218 * to notice it now, because if we try to read from the TTY
7219 * again, the EOF condition will disappear.
7221 * The comparison of cnt to sizeof(buf) is an optimization
7222 * that prevents unnecessary calls to feof().
7226 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7230 #ifdef USEHEAPINSTEADOFSTACK
7235 if (rspara) { /* have to do this both before and after */
7236 while (i != EOF) { /* to make sure file boundaries work right */
7237 i = PerlIO_getc(fp);
7239 PerlIO_ungetc(fp,i);
7245 return_string_or_null:
7246 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7252 Auto-increment of the value in the SV, doing string to numeric conversion
7253 if necessary. Handles 'get' magic.
7259 Perl_sv_inc(pTHX_ register SV *sv)
7268 if (SvTHINKFIRST(sv)) {
7270 sv_force_normal_flags(sv, 0);
7271 if (SvREADONLY(sv)) {
7272 if (IN_PERL_RUNTIME)
7273 Perl_croak(aTHX_ PL_no_modify);
7277 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7279 i = PTR2IV(SvRV(sv));
7284 flags = SvFLAGS(sv);
7285 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7286 /* It's (privately or publicly) a float, but not tested as an
7287 integer, so test it to see. */
7289 flags = SvFLAGS(sv);
7291 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7292 /* It's publicly an integer, or privately an integer-not-float */
7293 #ifdef PERL_PRESERVE_IVUV
7297 if (SvUVX(sv) == UV_MAX)
7298 sv_setnv(sv, UV_MAX_P1);
7300 (void)SvIOK_only_UV(sv);
7303 if (SvIVX(sv) == IV_MAX)
7304 sv_setuv(sv, (UV)IV_MAX + 1);
7306 (void)SvIOK_only(sv);
7312 if (flags & SVp_NOK) {
7313 (void)SvNOK_only(sv);
7318 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7319 if ((flags & SVTYPEMASK) < SVt_PVIV)
7320 sv_upgrade(sv, SVt_IV);
7321 (void)SvIOK_only(sv);
7326 while (isALPHA(*d)) d++;
7327 while (isDIGIT(*d)) d++;
7329 #ifdef PERL_PRESERVE_IVUV
7330 /* Got to punt this as an integer if needs be, but we don't issue
7331 warnings. Probably ought to make the sv_iv_please() that does
7332 the conversion if possible, and silently. */
7333 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7334 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7335 /* Need to try really hard to see if it's an integer.
7336 9.22337203685478e+18 is an integer.
7337 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7338 so $a="9.22337203685478e+18"; $a+0; $a++
7339 needs to be the same as $a="9.22337203685478e+18"; $a++
7346 /* sv_2iv *should* have made this an NV */
7347 if (flags & SVp_NOK) {
7348 (void)SvNOK_only(sv);
7352 /* I don't think we can get here. Maybe I should assert this
7353 And if we do get here I suspect that sv_setnv will croak. NWC
7355 #if defined(USE_LONG_DOUBLE)
7356 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",
7357 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7359 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7360 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7363 #endif /* PERL_PRESERVE_IVUV */
7364 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7368 while (d >= SvPVX(sv)) {
7376 /* MKS: The original code here died if letters weren't consecutive.
7377 * at least it didn't have to worry about non-C locales. The
7378 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7379 * arranged in order (although not consecutively) and that only
7380 * [A-Za-z] are accepted by isALPHA in the C locale.
7382 if (*d != 'z' && *d != 'Z') {
7383 do { ++*d; } while (!isALPHA(*d));
7386 *(d--) -= 'z' - 'a';
7391 *(d--) -= 'z' - 'a' + 1;
7395 /* oh,oh, the number grew */
7396 SvGROW(sv, SvCUR(sv) + 2);
7398 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7409 Auto-decrement of the value in the SV, doing string to numeric conversion
7410 if necessary. Handles 'get' magic.
7416 Perl_sv_dec(pTHX_ register SV *sv)
7424 if (SvTHINKFIRST(sv)) {
7426 sv_force_normal_flags(sv, 0);
7427 if (SvREADONLY(sv)) {
7428 if (IN_PERL_RUNTIME)
7429 Perl_croak(aTHX_ PL_no_modify);
7433 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7435 i = PTR2IV(SvRV(sv));
7440 /* Unlike sv_inc we don't have to worry about string-never-numbers
7441 and keeping them magic. But we mustn't warn on punting */
7442 flags = SvFLAGS(sv);
7443 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7444 /* It's publicly an integer, or privately an integer-not-float */
7445 #ifdef PERL_PRESERVE_IVUV
7449 if (SvUVX(sv) == 0) {
7450 (void)SvIOK_only(sv);
7454 (void)SvIOK_only_UV(sv);
7458 if (SvIVX(sv) == IV_MIN)
7459 sv_setnv(sv, (NV)IV_MIN - 1.0);
7461 (void)SvIOK_only(sv);
7467 if (flags & SVp_NOK) {
7469 (void)SvNOK_only(sv);
7472 if (!(flags & SVp_POK)) {
7473 if ((flags & SVTYPEMASK) < SVt_PVNV)
7474 sv_upgrade(sv, SVt_NV);
7476 (void)SvNOK_only(sv);
7479 #ifdef PERL_PRESERVE_IVUV
7481 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7482 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7483 /* Need to try really hard to see if it's an integer.
7484 9.22337203685478e+18 is an integer.
7485 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7486 so $a="9.22337203685478e+18"; $a+0; $a--
7487 needs to be the same as $a="9.22337203685478e+18"; $a--
7494 /* sv_2iv *should* have made this an NV */
7495 if (flags & SVp_NOK) {
7496 (void)SvNOK_only(sv);
7500 /* I don't think we can get here. Maybe I should assert this
7501 And if we do get here I suspect that sv_setnv will croak. NWC
7503 #if defined(USE_LONG_DOUBLE)
7504 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",
7505 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7507 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7508 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7512 #endif /* PERL_PRESERVE_IVUV */
7513 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7517 =for apidoc sv_mortalcopy
7519 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7520 The new SV is marked as mortal. It will be destroyed "soon", either by an
7521 explicit call to FREETMPS, or by an implicit call at places such as
7522 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7527 /* Make a string that will exist for the duration of the expression
7528 * evaluation. Actually, it may have to last longer than that, but
7529 * hopefully we won't free it until it has been assigned to a
7530 * permanent location. */
7533 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7538 sv_setsv(sv,oldstr);
7540 PL_tmps_stack[++PL_tmps_ix] = sv;
7546 =for apidoc sv_newmortal
7548 Creates a new null SV which is mortal. The reference count of the SV is
7549 set to 1. It will be destroyed "soon", either by an explicit call to
7550 FREETMPS, or by an implicit call at places such as statement boundaries.
7551 See also C<sv_mortalcopy> and C<sv_2mortal>.
7557 Perl_sv_newmortal(pTHX)
7562 SvFLAGS(sv) = SVs_TEMP;
7564 PL_tmps_stack[++PL_tmps_ix] = sv;
7569 =for apidoc sv_2mortal
7571 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7572 by an explicit call to FREETMPS, or by an implicit call at places such as
7573 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
7579 Perl_sv_2mortal(pTHX_ register SV *sv)
7583 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7586 PL_tmps_stack[++PL_tmps_ix] = sv;
7594 Creates a new SV and copies a string into it. The reference count for the
7595 SV is set to 1. If C<len> is zero, Perl will compute the length using
7596 strlen(). For efficiency, consider using C<newSVpvn> instead.
7602 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7609 sv_setpvn(sv,s,len);
7614 =for apidoc newSVpvn
7616 Creates a new SV and copies a string into it. The reference count for the
7617 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7618 string. You are responsible for ensuring that the source string is at least
7625 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7630 sv_setpvn(sv,s,len);
7635 =for apidoc newSVpvn_share
7637 Creates a new SV with its SvPVX pointing to a shared string in the string
7638 table. If the string does not already exist in the table, it is created
7639 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7640 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7641 otherwise the hash is computed. The idea here is that as the string table
7642 is used for shared hash keys these strings will have SvPVX == HeKEY and
7643 hash lookup will avoid string compare.
7649 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7652 bool is_utf8 = FALSE;
7654 STRLEN tmplen = -len;
7656 /* See the note in hv.c:hv_fetch() --jhi */
7657 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7661 PERL_HASH(hash, src, len);
7663 sv_upgrade(sv, SVt_PVIV);
7664 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7677 #if defined(PERL_IMPLICIT_CONTEXT)
7679 /* pTHX_ magic can't cope with varargs, so this is a no-context
7680 * version of the main function, (which may itself be aliased to us).
7681 * Don't access this version directly.
7685 Perl_newSVpvf_nocontext(const char* pat, ...)
7690 va_start(args, pat);
7691 sv = vnewSVpvf(pat, &args);
7698 =for apidoc newSVpvf
7700 Creates a new SV and initializes it with the string formatted like
7707 Perl_newSVpvf(pTHX_ const char* pat, ...)
7711 va_start(args, pat);
7712 sv = vnewSVpvf(pat, &args);
7717 /* backend for newSVpvf() and newSVpvf_nocontext() */
7720 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7724 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7731 Creates a new SV and copies a floating point value into it.
7732 The reference count for the SV is set to 1.
7738 Perl_newSVnv(pTHX_ NV n)
7750 Creates a new SV and copies an integer into it. The reference count for the
7757 Perl_newSViv(pTHX_ IV i)
7769 Creates a new SV and copies an unsigned integer into it.
7770 The reference count for the SV is set to 1.
7776 Perl_newSVuv(pTHX_ UV u)
7786 =for apidoc newRV_noinc
7788 Creates an RV wrapper for an SV. The reference count for the original
7789 SV is B<not> incremented.
7795 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7800 sv_upgrade(sv, SVt_RV);
7807 /* newRV_inc is the official function name to use now.
7808 * newRV_inc is in fact #defined to newRV in sv.h
7812 Perl_newRV(pTHX_ SV *tmpRef)
7814 return newRV_noinc(SvREFCNT_inc(tmpRef));
7820 Creates a new SV which is an exact duplicate of the original SV.
7827 Perl_newSVsv(pTHX_ register SV *old)
7833 if (SvTYPE(old) == SVTYPEMASK) {
7834 if (ckWARN_d(WARN_INTERNAL))
7835 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7850 =for apidoc sv_reset
7852 Underlying implementation for the C<reset> Perl function.
7853 Note that the perl-level function is vaguely deprecated.
7859 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7867 char todo[PERL_UCHAR_MAX+1];
7872 if (!*s) { /* reset ?? searches */
7873 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7874 pm->op_pmdynflags &= ~PMdf_USED;
7879 /* reset variables */
7881 if (!HvARRAY(stash))
7884 Zero(todo, 256, char);
7886 i = (unsigned char)*s;
7890 max = (unsigned char)*s++;
7891 for ( ; i <= max; i++) {
7894 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7895 for (entry = HvARRAY(stash)[i];
7897 entry = HeNEXT(entry))
7899 if (!todo[(U8)*HeKEY(entry)])
7901 gv = (GV*)HeVAL(entry);
7903 if (SvTHINKFIRST(sv)) {
7904 if (!SvREADONLY(sv) && SvROK(sv))
7909 if (SvTYPE(sv) >= SVt_PV) {
7911 if (SvPVX(sv) != Nullch)
7918 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7921 #ifdef USE_ENVIRON_ARRAY
7923 # ifdef USE_ITHREADS
7924 && PL_curinterp == aTHX
7928 environ[0] = Nullch;
7931 #endif /* !PERL_MICRO */
7941 Using various gambits, try to get an IO from an SV: the IO slot if its a
7942 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7943 named after the PV if we're a string.
7949 Perl_sv_2io(pTHX_ SV *sv)
7955 switch (SvTYPE(sv)) {
7963 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7967 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7969 return sv_2io(SvRV(sv));
7970 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7976 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7985 Using various gambits, try to get a CV from an SV; in addition, try if
7986 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7992 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7999 return *gvp = Nullgv, Nullcv;
8000 switch (SvTYPE(sv)) {
8019 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8020 tryAMAGICunDEREF(to_cv);
8023 if (SvTYPE(sv) == SVt_PVCV) {
8032 Perl_croak(aTHX_ "Not a subroutine reference");
8037 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
8043 if (lref && !GvCVu(gv)) {
8046 tmpsv = NEWSV(704,0);
8047 gv_efullname3(tmpsv, gv, Nullch);
8048 /* XXX this is probably not what they think they're getting.
8049 * It has the same effect as "sub name;", i.e. just a forward
8051 newSUB(start_subparse(FALSE, 0),
8052 newSVOP(OP_CONST, 0, tmpsv),
8057 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8067 Returns true if the SV has a true value by Perl's rules.
8068 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8069 instead use an in-line version.
8075 Perl_sv_true(pTHX_ register SV *sv)
8081 if ((tXpv = (XPV*)SvANY(sv)) &&
8082 (tXpv->xpv_cur > 1 ||
8083 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8090 return SvIVX(sv) != 0;
8093 return SvNVX(sv) != 0.0;
8095 return sv_2bool(sv);
8103 A private implementation of the C<SvIVx> macro for compilers which can't
8104 cope with complex macro expressions. Always use the macro instead.
8110 Perl_sv_iv(pTHX_ register SV *sv)
8114 return (IV)SvUVX(sv);
8123 A private implementation of the C<SvUVx> macro for compilers which can't
8124 cope with complex macro expressions. Always use the macro instead.
8130 Perl_sv_uv(pTHX_ register SV *sv)
8135 return (UV)SvIVX(sv);
8143 A private implementation of the C<SvNVx> macro for compilers which can't
8144 cope with complex macro expressions. Always use the macro instead.
8150 Perl_sv_nv(pTHX_ register SV *sv)
8157 /* sv_pv() is now a macro using SvPV_nolen();
8158 * this function provided for binary compatibility only
8162 Perl_sv_pv(pTHX_ SV *sv)
8169 return sv_2pv(sv, &n_a);
8175 Use the C<SvPV_nolen> macro instead
8179 A private implementation of the C<SvPV> macro for compilers which can't
8180 cope with complex macro expressions. Always use the macro instead.
8186 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8192 return sv_2pv(sv, lp);
8197 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8203 return sv_2pv_flags(sv, lp, 0);
8206 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8207 * this function provided for binary compatibility only
8211 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8213 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8217 =for apidoc sv_pvn_force
8219 Get a sensible string out of the SV somehow.
8220 A private implementation of the C<SvPV_force> macro for compilers which
8221 can't cope with complex macro expressions. Always use the macro instead.
8223 =for apidoc sv_pvn_force_flags
8225 Get a sensible string out of the SV somehow.
8226 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8227 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8228 implemented in terms of this function.
8229 You normally want to use the various wrapper macros instead: see
8230 C<SvPV_force> and C<SvPV_force_nomg>
8236 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8240 if (SvTHINKFIRST(sv) && !SvROK(sv))
8241 sv_force_normal_flags(sv, 0);
8247 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8248 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8252 s = sv_2pv_flags(sv, lp, flags);
8253 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8258 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8259 SvGROW(sv, len + 1);
8260 Move(s,SvPVX(sv),len,char);
8265 SvPOK_on(sv); /* validate pointer */
8267 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8268 PTR2UV(sv),SvPVX(sv)));
8274 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8275 * this function provided for binary compatibility only
8279 Perl_sv_pvbyte(pTHX_ SV *sv)
8281 sv_utf8_downgrade(sv,0);
8286 =for apidoc sv_pvbyte
8288 Use C<SvPVbyte_nolen> instead.
8290 =for apidoc sv_pvbyten
8292 A private implementation of the C<SvPVbyte> macro for compilers
8293 which can't cope with complex macro expressions. Always use the macro
8300 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8302 sv_utf8_downgrade(sv,0);
8303 return sv_pvn(sv,lp);
8307 =for apidoc sv_pvbyten_force
8309 A private implementation of the C<SvPVbytex_force> macro for compilers
8310 which can't cope with complex macro expressions. Always use the macro
8317 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8319 sv_pvn_force(sv,lp);
8320 sv_utf8_downgrade(sv,0);
8325 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8326 * this function provided for binary compatibility only
8330 Perl_sv_pvutf8(pTHX_ SV *sv)
8332 sv_utf8_upgrade(sv);
8337 =for apidoc sv_pvutf8
8339 Use the C<SvPVutf8_nolen> macro instead
8341 =for apidoc sv_pvutf8n
8343 A private implementation of the C<SvPVutf8> macro for compilers
8344 which can't cope with complex macro expressions. Always use the macro
8351 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8353 sv_utf8_upgrade(sv);
8354 return sv_pvn(sv,lp);
8358 =for apidoc sv_pvutf8n_force
8360 A private implementation of the C<SvPVutf8_force> macro for compilers
8361 which can't cope with complex macro expressions. Always use the macro
8368 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8370 sv_pvn_force(sv,lp);
8371 sv_utf8_upgrade(sv);
8377 =for apidoc sv_reftype
8379 Returns a string describing what the SV is a reference to.
8385 Perl_sv_reftype(pTHX_ SV *sv, int ob)
8387 if (ob && SvOBJECT(sv)) {
8388 if (HvNAME(SvSTASH(sv)))
8389 return HvNAME(SvSTASH(sv));
8394 switch (SvTYPE(sv)) {
8411 case SVt_PVLV: return SvROK(sv) ? "REF"
8412 /* tied lvalues should appear to be
8413 * scalars for backwards compatitbility */
8414 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8415 ? "SCALAR" : "LVALUE";
8416 case SVt_PVAV: return "ARRAY";
8417 case SVt_PVHV: return "HASH";
8418 case SVt_PVCV: return "CODE";
8419 case SVt_PVGV: return "GLOB";
8420 case SVt_PVFM: return "FORMAT";
8421 case SVt_PVIO: return "IO";
8422 default: return "UNKNOWN";
8428 =for apidoc sv_isobject
8430 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8431 object. If the SV is not an RV, or if the object is not blessed, then this
8438 Perl_sv_isobject(pTHX_ SV *sv)
8455 Returns a boolean indicating whether the SV is blessed into the specified
8456 class. This does not check for subtypes; use C<sv_derived_from> to verify
8457 an inheritance relationship.
8463 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8474 if (!HvNAME(SvSTASH(sv)))
8477 return strEQ(HvNAME(SvSTASH(sv)), name);
8483 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8484 it will be upgraded to one. If C<classname> is non-null then the new SV will
8485 be blessed in the specified package. The new SV is returned and its
8486 reference count is 1.
8492 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8498 SV_CHECK_THINKFIRST_COW_DROP(rv);
8501 if (SvTYPE(rv) >= SVt_PVMG) {
8502 U32 refcnt = SvREFCNT(rv);
8506 SvREFCNT(rv) = refcnt;
8509 if (SvTYPE(rv) < SVt_RV)
8510 sv_upgrade(rv, SVt_RV);
8511 else if (SvTYPE(rv) > SVt_RV) {
8512 (void)SvOOK_off(rv);
8513 if (SvPVX(rv) && SvLEN(rv))
8514 Safefree(SvPVX(rv));
8524 HV* stash = gv_stashpv(classname, TRUE);
8525 (void)sv_bless(rv, stash);
8531 =for apidoc sv_setref_pv
8533 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8534 argument will be upgraded to an RV. That RV will be modified to point to
8535 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8536 into the SV. The C<classname> argument indicates the package for the
8537 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8538 will have a reference count of 1, and the RV will be returned.
8540 Do not use with other Perl types such as HV, AV, SV, CV, because those
8541 objects will become corrupted by the pointer copy process.
8543 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8549 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8552 sv_setsv(rv, &PL_sv_undef);
8556 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8561 =for apidoc sv_setref_iv
8563 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8564 argument will be upgraded to an RV. That RV will be modified to point to
8565 the new SV. The C<classname> argument indicates the package for the
8566 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8567 will have a reference count of 1, and the RV will be returned.
8573 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8575 sv_setiv(newSVrv(rv,classname), iv);
8580 =for apidoc sv_setref_uv
8582 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8583 argument will be upgraded to an RV. That RV will be modified to point to
8584 the new SV. The C<classname> argument indicates the package for the
8585 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8586 will have a reference count of 1, and the RV will be returned.
8592 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8594 sv_setuv(newSVrv(rv,classname), uv);
8599 =for apidoc sv_setref_nv
8601 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8602 argument will be upgraded to an RV. That RV will be modified to point to
8603 the new SV. The C<classname> argument indicates the package for the
8604 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8605 will have a reference count of 1, and the RV will be returned.
8611 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8613 sv_setnv(newSVrv(rv,classname), nv);
8618 =for apidoc sv_setref_pvn
8620 Copies a string into a new SV, optionally blessing the SV. The length of the
8621 string must be specified with C<n>. The C<rv> argument will be upgraded to
8622 an RV. That RV will be modified to point to the new SV. The C<classname>
8623 argument indicates the package for the blessing. Set C<classname> to
8624 C<Nullch> to avoid the blessing. The new SV will have a reference count
8625 of 1, and the RV will be returned.
8627 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8633 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8635 sv_setpvn(newSVrv(rv,classname), pv, n);
8640 =for apidoc sv_bless
8642 Blesses an SV into a specified package. The SV must be an RV. The package
8643 must be designated by its stash (see C<gv_stashpv()>). The reference count
8644 of the SV is unaffected.
8650 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8654 Perl_croak(aTHX_ "Can't bless non-reference value");
8656 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8657 if (SvREADONLY(tmpRef))
8658 Perl_croak(aTHX_ PL_no_modify);
8659 if (SvOBJECT(tmpRef)) {
8660 if (SvTYPE(tmpRef) != SVt_PVIO)
8662 SvREFCNT_dec(SvSTASH(tmpRef));
8665 SvOBJECT_on(tmpRef);
8666 if (SvTYPE(tmpRef) != SVt_PVIO)
8668 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8669 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8676 if(SvSMAGICAL(tmpRef))
8677 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8685 /* Downgrades a PVGV to a PVMG.
8689 S_sv_unglob(pTHX_ SV *sv)
8693 assert(SvTYPE(sv) == SVt_PVGV);
8698 SvREFCNT_dec(GvSTASH(sv));
8699 GvSTASH(sv) = Nullhv;
8701 sv_unmagic(sv, PERL_MAGIC_glob);
8702 Safefree(GvNAME(sv));
8705 /* need to keep SvANY(sv) in the right arena */
8706 xpvmg = new_XPVMG();
8707 StructCopy(SvANY(sv), xpvmg, XPVMG);
8708 del_XPVGV(SvANY(sv));
8711 SvFLAGS(sv) &= ~SVTYPEMASK;
8712 SvFLAGS(sv) |= SVt_PVMG;
8716 =for apidoc sv_unref_flags
8718 Unsets the RV status of the SV, and decrements the reference count of
8719 whatever was being referenced by the RV. This can almost be thought of
8720 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8721 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8722 (otherwise the decrementing is conditional on the reference count being
8723 different from one or the reference being a readonly SV).
8730 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8734 if (SvWEAKREF(sv)) {
8742 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8743 assigned to as BEGIN {$a = \"Foo"} will fail. */
8744 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8746 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8747 sv_2mortal(rv); /* Schedule for freeing later */
8751 =for apidoc sv_unref
8753 Unsets the RV status of the SV, and decrements the reference count of
8754 whatever was being referenced by the RV. This can almost be thought of
8755 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8756 being zero. See C<SvROK_off>.
8762 Perl_sv_unref(pTHX_ SV *sv)
8764 sv_unref_flags(sv, 0);
8768 =for apidoc sv_taint
8770 Taint an SV. Use C<SvTAINTED_on> instead.
8775 Perl_sv_taint(pTHX_ SV *sv)
8777 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8781 =for apidoc sv_untaint
8783 Untaint an SV. Use C<SvTAINTED_off> instead.
8788 Perl_sv_untaint(pTHX_ SV *sv)
8790 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8791 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8798 =for apidoc sv_tainted
8800 Test an SV for taintedness. Use C<SvTAINTED> instead.
8805 Perl_sv_tainted(pTHX_ SV *sv)
8807 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8808 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8809 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8816 =for apidoc sv_setpviv
8818 Copies an integer into the given SV, also updating its string value.
8819 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8825 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8827 char buf[TYPE_CHARS(UV)];
8829 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8831 sv_setpvn(sv, ptr, ebuf - ptr);
8835 =for apidoc sv_setpviv_mg
8837 Like C<sv_setpviv>, but also handles 'set' magic.
8843 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8845 char buf[TYPE_CHARS(UV)];
8847 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8849 sv_setpvn(sv, ptr, ebuf - ptr);
8853 #if defined(PERL_IMPLICIT_CONTEXT)
8855 /* pTHX_ magic can't cope with varargs, so this is a no-context
8856 * version of the main function, (which may itself be aliased to us).
8857 * Don't access this version directly.
8861 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8865 va_start(args, pat);
8866 sv_vsetpvf(sv, pat, &args);
8870 /* pTHX_ magic can't cope with varargs, so this is a no-context
8871 * version of the main function, (which may itself be aliased to us).
8872 * Don't access this version directly.
8876 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8880 va_start(args, pat);
8881 sv_vsetpvf_mg(sv, pat, &args);
8887 =for apidoc sv_setpvf
8889 Processes its arguments like C<sprintf> and sets an SV to the formatted
8890 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8896 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8899 va_start(args, pat);
8900 sv_vsetpvf(sv, pat, &args);
8904 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8907 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8909 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8913 =for apidoc sv_setpvf_mg
8915 Like C<sv_setpvf>, but also handles 'set' magic.
8921 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8924 va_start(args, pat);
8925 sv_vsetpvf_mg(sv, pat, &args);
8929 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8932 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8934 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8938 #if defined(PERL_IMPLICIT_CONTEXT)
8940 /* pTHX_ magic can't cope with varargs, so this is a no-context
8941 * version of the main function, (which may itself be aliased to us).
8942 * Don't access this version directly.
8946 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8950 va_start(args, pat);
8951 sv_vcatpvf(sv, pat, &args);
8955 /* pTHX_ magic can't cope with varargs, so this is a no-context
8956 * version of the main function, (which may itself be aliased to us).
8957 * Don't access this version directly.
8961 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8965 va_start(args, pat);
8966 sv_vcatpvf_mg(sv, pat, &args);
8972 =for apidoc sv_catpvf
8974 Processes its arguments like C<sprintf> and appends the formatted
8975 output to an SV. If the appended data contains "wide" characters
8976 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8977 and characters >255 formatted with %c), the original SV might get
8978 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8979 C<SvSETMAGIC()> must typically be called after calling this function
8980 to handle 'set' magic.
8985 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8988 va_start(args, pat);
8989 sv_vcatpvf(sv, pat, &args);
8993 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8996 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8998 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9002 =for apidoc sv_catpvf_mg
9004 Like C<sv_catpvf>, but also handles 'set' magic.
9010 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9013 va_start(args, pat);
9014 sv_vcatpvf_mg(sv, pat, &args);
9018 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
9021 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9023 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9028 =for apidoc sv_vsetpvfn
9030 Works like C<vcatpvfn> but copies the text into the SV instead of
9033 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
9039 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9041 sv_setpvn(sv, "", 0);
9042 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9045 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9048 S_expect_number(pTHX_ char** pattern)
9051 switch (**pattern) {
9052 case '1': case '2': case '3':
9053 case '4': case '5': case '6':
9054 case '7': case '8': case '9':
9055 while (isDIGIT(**pattern))
9056 var = var * 10 + (*(*pattern)++ - '0');
9060 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9063 F0convert(NV nv, char *endbuf, STRLEN *len)
9074 if (uv & 1 && uv == nv)
9075 uv--; /* Round to even */
9077 unsigned dig = uv % 10;
9090 =for apidoc sv_vcatpvfn
9092 Processes its arguments like C<vsprintf> and appends the formatted output
9093 to an SV. Uses an array of SVs if the C style variable argument list is
9094 missing (NULL). When running with taint checks enabled, indicates via
9095 C<maybe_tainted> if results are untrustworthy (often due to the use of
9098 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
9104 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9111 static char nullstr[] = "(null)";
9113 bool has_utf8; /* has the result utf8? */
9114 bool pat_utf8; /* the pattern is in utf8? */
9116 /* Times 4: a decimal digit takes more than 3 binary digits.
9117 * NV_DIG: mantissa takes than many decimal digits.
9118 * Plus 32: Playing safe. */
9119 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9120 /* large enough for "%#.#f" --chip */
9121 /* what about long double NVs? --jhi */
9123 has_utf8 = pat_utf8 = DO_UTF8(sv);
9125 /* no matter what, this is a string now */
9126 (void)SvPV_force(sv, origlen);
9128 /* special-case "", "%s", and "%_" */
9131 if (patlen == 2 && pat[0] == '%') {
9135 char *s = va_arg(*args, char*);
9136 sv_catpv(sv, s ? s : nullstr);
9138 else if (svix < svmax) {
9139 sv_catsv(sv, *svargs);
9140 if (DO_UTF8(*svargs))
9146 argsv = va_arg(*args, SV*);
9147 sv_catsv(sv, argsv);
9152 /* See comment on '_' below */
9157 #ifndef USE_LONG_DOUBLE
9158 /* special-case "%.<number>[gf]" */
9159 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9160 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9161 unsigned digits = 0;
9165 while (*pp >= '0' && *pp <= '9')
9166 digits = 10 * digits + (*pp++ - '0');
9167 if (pp - pat == (int)patlen - 1) {
9171 nv = (NV)va_arg(*args, double);
9172 else if (svix < svmax)
9177 /* Add check for digits != 0 because it seems that some
9178 gconverts are buggy in this case, and we don't yet have
9179 a Configure test for this. */
9180 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9181 /* 0, point, slack */
9182 Gconvert(nv, (int)digits, 0, ebuf);
9184 if (*ebuf) /* May return an empty string for digits==0 */
9187 } else if (!digits) {
9190 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9191 sv_catpvn(sv, p, l);
9197 #endif /* !USE_LONG_DOUBLE */
9199 if (!args && svix < svmax && DO_UTF8(*svargs))
9202 patend = (char*)pat + patlen;
9203 for (p = (char*)pat; p < patend; p = q) {
9206 bool vectorize = FALSE;
9207 bool vectorarg = FALSE;
9208 bool vec_utf8 = FALSE;
9214 bool has_precis = FALSE;
9217 bool is_utf8 = FALSE; /* is this item utf8? */
9218 #ifdef HAS_LDBL_SPRINTF_BUG
9219 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9220 with sfio - Allen <allens@cpan.org> */
9221 bool fix_ldbl_sprintf_bug = FALSE;
9225 U8 utf8buf[UTF8_MAXLEN+1];
9226 STRLEN esignlen = 0;
9228 char *eptr = Nullch;
9231 U8 *vecstr = Null(U8*);
9238 /* we need a long double target in case HAS_LONG_DOUBLE but
9241 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9250 STRLEN dotstrlen = 1;
9251 I32 efix = 0; /* explicit format parameter index */
9252 I32 ewix = 0; /* explicit width index */
9253 I32 epix = 0; /* explicit precision index */
9254 I32 evix = 0; /* explicit vector index */
9255 bool asterisk = FALSE;
9257 /* echo everything up to the next format specification */
9258 for (q = p; q < patend && *q != '%'; ++q) ;
9260 if (has_utf8 && !pat_utf8)
9261 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9263 sv_catpvn(sv, p, q - p);
9270 We allow format specification elements in this order:
9271 \d+\$ explicit format parameter index
9273 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9274 0 flag (as above): repeated to allow "v02"
9275 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9276 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9278 [%bcdefginopsux_DFOUX] format (mandatory)
9280 if (EXPECT_NUMBER(q, width)) {
9321 if (EXPECT_NUMBER(q, ewix))
9330 if ((vectorarg = asterisk)) {
9342 EXPECT_NUMBER(q, width);
9347 vecsv = va_arg(*args, SV*);
9349 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9350 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9351 dotstr = SvPVx(vecsv, dotstrlen);
9356 vecsv = va_arg(*args, SV*);
9357 vecstr = (U8*)SvPVx(vecsv,veclen);
9358 vec_utf8 = DO_UTF8(vecsv);
9360 else if (efix ? efix <= svmax : svix < svmax) {
9361 vecsv = svargs[efix ? efix-1 : svix++];
9362 vecstr = (U8*)SvPVx(vecsv,veclen);
9363 vec_utf8 = DO_UTF8(vecsv);
9373 i = va_arg(*args, int);
9375 i = (ewix ? ewix <= svmax : svix < svmax) ?
9376 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9378 width = (i < 0) ? -i : i;
9388 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9390 /* XXX: todo, support specified precision parameter */
9394 i = va_arg(*args, int);
9396 i = (ewix ? ewix <= svmax : svix < svmax)
9397 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9398 precis = (i < 0) ? 0 : i;
9403 precis = precis * 10 + (*q++ - '0');
9412 case 'I': /* Ix, I32x, and I64x */
9414 if (q[1] == '6' && q[2] == '4') {
9420 if (q[1] == '3' && q[2] == '2') {
9430 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9441 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9442 if (*(q + 1) == 'l') { /* lld, llf */
9467 argsv = (efix ? efix <= svmax : svix < svmax) ?
9468 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9475 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9477 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9479 eptr = (char*)utf8buf;
9480 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9491 if (args && !vectorize) {
9492 eptr = va_arg(*args, char*);
9494 #ifdef MACOS_TRADITIONAL
9495 /* On MacOS, %#s format is used for Pascal strings */
9500 elen = strlen(eptr);
9503 elen = sizeof nullstr - 1;
9507 eptr = SvPVx(argsv, elen);
9508 if (DO_UTF8(argsv)) {
9509 if (has_precis && precis < elen) {
9511 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9514 if (width) { /* fudge width (can't fudge elen) */
9515 width += elen - sv_len_utf8(argsv);
9524 * The "%_" hack might have to be changed someday,
9525 * if ISO or ANSI decide to use '_' for something.
9526 * So we keep it hidden from users' code.
9528 if (!args || vectorize)
9530 argsv = va_arg(*args, SV*);
9531 eptr = SvPVx(argsv, elen);
9537 if (has_precis && elen > precis)
9544 if (alt || vectorize)
9546 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9564 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9573 esignbuf[esignlen++] = plus;
9577 case 'h': iv = (short)va_arg(*args, int); break;
9578 case 'l': iv = va_arg(*args, long); break;
9579 case 'V': iv = va_arg(*args, IV); break;
9580 default: iv = va_arg(*args, int); break;
9582 case 'q': iv = va_arg(*args, Quad_t); break;
9587 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9589 case 'h': iv = (short)tiv; break;
9590 case 'l': iv = (long)tiv; break;
9592 default: iv = tiv; break;
9594 case 'q': iv = (Quad_t)tiv; break;
9598 if ( !vectorize ) /* we already set uv above */
9603 esignbuf[esignlen++] = plus;
9607 esignbuf[esignlen++] = '-';
9650 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9661 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9662 case 'l': uv = va_arg(*args, unsigned long); break;
9663 case 'V': uv = va_arg(*args, UV); break;
9664 default: uv = va_arg(*args, unsigned); break;
9666 case 'q': uv = va_arg(*args, Uquad_t); break;
9671 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9673 case 'h': uv = (unsigned short)tuv; break;
9674 case 'l': uv = (unsigned long)tuv; break;
9676 default: uv = tuv; break;
9678 case 'q': uv = (Uquad_t)tuv; break;
9684 eptr = ebuf + sizeof ebuf;
9690 p = (char*)((c == 'X')
9691 ? "0123456789ABCDEF" : "0123456789abcdef");
9697 esignbuf[esignlen++] = '0';
9698 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9704 *--eptr = '0' + dig;
9706 if (alt && *eptr != '0')
9712 *--eptr = '0' + dig;
9715 esignbuf[esignlen++] = '0';
9716 esignbuf[esignlen++] = 'b';
9719 default: /* it had better be ten or less */
9720 #if defined(PERL_Y2KWARN)
9721 if (ckWARN(WARN_Y2K)) {
9723 char *s = SvPV(sv,n);
9724 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9725 && (n == 2 || !isDIGIT(s[n-3])))
9727 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9728 "Possible Y2K bug: %%%c %s",
9729 c, "format string following '19'");
9735 *--eptr = '0' + dig;
9736 } while (uv /= base);
9739 elen = (ebuf + sizeof ebuf) - eptr;
9742 zeros = precis - elen;
9743 else if (precis == 0 && elen == 1 && *eptr == '0')
9748 /* FLOATING POINT */
9751 c = 'f'; /* maybe %F isn't supported here */
9757 /* This is evil, but floating point is even more evil */
9759 /* for SV-style calling, we can only get NV
9760 for C-style calling, we assume %f is double;
9761 for simplicity we allow any of %Lf, %llf, %qf for long double
9765 #if defined(USE_LONG_DOUBLE)
9769 /* [perl #20339] - we should accept and ignore %lf rather than die */
9773 #if defined(USE_LONG_DOUBLE)
9774 intsize = args ? 0 : 'q';
9778 #if defined(HAS_LONG_DOUBLE)
9787 /* now we need (long double) if intsize == 'q', else (double) */
9788 nv = (args && !vectorize) ?
9789 #if LONG_DOUBLESIZE > DOUBLESIZE
9791 va_arg(*args, long double) :
9792 va_arg(*args, double)
9794 va_arg(*args, double)
9800 if (c != 'e' && c != 'E') {
9802 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9803 will cast our (long double) to (double) */
9804 (void)Perl_frexp(nv, &i);
9805 if (i == PERL_INT_MIN)
9806 Perl_die(aTHX_ "panic: frexp");
9808 need = BIT_DIGITS(i);
9810 need += has_precis ? precis : 6; /* known default */
9815 #ifdef HAS_LDBL_SPRINTF_BUG
9816 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9817 with sfio - Allen <allens@cpan.org> */
9820 # define MY_DBL_MAX DBL_MAX
9821 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9822 # if DOUBLESIZE >= 8
9823 # define MY_DBL_MAX 1.7976931348623157E+308L
9825 # define MY_DBL_MAX 3.40282347E+38L
9829 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9830 # define MY_DBL_MAX_BUG 1L
9832 # define MY_DBL_MAX_BUG MY_DBL_MAX
9836 # define MY_DBL_MIN DBL_MIN
9837 # else /* XXX guessing! -Allen */
9838 # if DOUBLESIZE >= 8
9839 # define MY_DBL_MIN 2.2250738585072014E-308L
9841 # define MY_DBL_MIN 1.17549435E-38L
9845 if ((intsize == 'q') && (c == 'f') &&
9846 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9848 /* it's going to be short enough that
9849 * long double precision is not needed */
9851 if ((nv <= 0L) && (nv >= -0L))
9852 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9854 /* would use Perl_fp_class as a double-check but not
9855 * functional on IRIX - see perl.h comments */
9857 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9858 /* It's within the range that a double can represent */
9859 #if defined(DBL_MAX) && !defined(DBL_MIN)
9860 if ((nv >= ((long double)1/DBL_MAX)) ||
9861 (nv <= (-(long double)1/DBL_MAX)))
9863 fix_ldbl_sprintf_bug = TRUE;
9866 if (fix_ldbl_sprintf_bug == TRUE) {
9876 # undef MY_DBL_MAX_BUG
9879 #endif /* HAS_LDBL_SPRINTF_BUG */
9881 need += 20; /* fudge factor */
9882 if (PL_efloatsize < need) {
9883 Safefree(PL_efloatbuf);
9884 PL_efloatsize = need + 20; /* more fudge */
9885 New(906, PL_efloatbuf, PL_efloatsize, char);
9886 PL_efloatbuf[0] = '\0';
9889 if ( !(width || left || plus || alt) && fill != '0'
9890 && has_precis && intsize != 'q' ) { /* Shortcuts */
9891 /* See earlier comment about buggy Gconvert when digits,
9893 if ( c == 'g' && precis) {
9894 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9895 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9896 goto float_converted;
9897 } else if ( c == 'f' && !precis) {
9898 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9902 eptr = ebuf + sizeof ebuf;
9905 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9906 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9907 if (intsize == 'q') {
9908 /* Copy the one or more characters in a long double
9909 * format before the 'base' ([efgEFG]) character to
9910 * the format string. */
9911 static char const prifldbl[] = PERL_PRIfldbl;
9912 char const *p = prifldbl + sizeof(prifldbl) - 3;
9913 while (p >= prifldbl) { *--eptr = *p--; }
9918 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9923 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9935 /* No taint. Otherwise we are in the strange situation
9936 * where printf() taints but print($float) doesn't.
9938 #if defined(HAS_LONG_DOUBLE)
9940 (void)sprintf(PL_efloatbuf, eptr, nv);
9942 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9944 (void)sprintf(PL_efloatbuf, eptr, nv);
9947 eptr = PL_efloatbuf;
9948 elen = strlen(PL_efloatbuf);
9954 i = SvCUR(sv) - origlen;
9955 if (args && !vectorize) {
9957 case 'h': *(va_arg(*args, short*)) = i; break;
9958 default: *(va_arg(*args, int*)) = i; break;
9959 case 'l': *(va_arg(*args, long*)) = i; break;
9960 case 'V': *(va_arg(*args, IV*)) = i; break;
9962 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9967 sv_setuv_mg(argsv, (UV)i);
9969 continue; /* not "break" */
9975 if (!args && ckWARN(WARN_PRINTF) &&
9976 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9977 SV *msg = sv_newmortal();
9978 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9979 (PL_op->op_type == OP_PRTF) ? "" : "s");
9982 Perl_sv_catpvf(aTHX_ msg,
9983 "\"%%%c\"", c & 0xFF);
9985 Perl_sv_catpvf(aTHX_ msg,
9986 "\"%%\\%03"UVof"\"",
9989 sv_catpv(msg, "end of string");
9990 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9993 /* output mangled stuff ... */
9999 /* ... right here, because formatting flags should not apply */
10000 SvGROW(sv, SvCUR(sv) + elen + 1);
10002 Copy(eptr, p, elen, char);
10005 SvCUR(sv) = p - SvPVX(sv);
10007 continue; /* not "break" */
10010 /* calculate width before utf8_upgrade changes it */
10011 have = esignlen + zeros + elen;
10013 if (is_utf8 != has_utf8) {
10016 sv_utf8_upgrade(sv);
10019 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10020 sv_utf8_upgrade(nsv);
10024 SvGROW(sv, SvCUR(sv) + elen + 1);
10028 /* Use memchr() instead of strchr(), as eptr is not guaranteed */
10029 /* to point to a null-terminated string. */
10030 if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
10031 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
10032 Perl_warner(aTHX_ packWARN(WARN_PRINTF),
10033 "Newline in left-justified string for %sprintf",
10034 (PL_op->op_type == OP_PRTF) ? "" : "s");
10036 need = (have > width ? have : width);
10039 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10041 if (esignlen && fill == '0') {
10042 for (i = 0; i < (int)esignlen; i++)
10043 *p++ = esignbuf[i];
10045 if (gap && !left) {
10046 memset(p, fill, gap);
10049 if (esignlen && fill != '0') {
10050 for (i = 0; i < (int)esignlen; i++)
10051 *p++ = esignbuf[i];
10054 for (i = zeros; i; i--)
10058 Copy(eptr, p, elen, char);
10062 memset(p, ' ', gap);
10067 Copy(dotstr, p, dotstrlen, char);
10071 vectorize = FALSE; /* done iterating over vecstr */
10078 SvCUR(sv) = p - SvPVX(sv);
10086 /* =========================================================================
10088 =head1 Cloning an interpreter
10090 All the macros and functions in this section are for the private use of
10091 the main function, perl_clone().
10093 The foo_dup() functions make an exact copy of an existing foo thinngy.
10094 During the course of a cloning, a hash table is used to map old addresses
10095 to new addresses. The table is created and manipulated with the
10096 ptr_table_* functions.
10100 ============================================================================*/
10103 #if defined(USE_ITHREADS)
10105 #ifndef GpREFCNT_inc
10106 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10110 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10111 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10112 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10113 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10114 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10115 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10116 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10117 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10118 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10119 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10120 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10121 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10122 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10125 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10126 regcomp.c. AMS 20010712 */
10129 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10133 struct reg_substr_datum *s;
10136 return (REGEXP *)NULL;
10138 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10141 len = r->offsets[0];
10142 npar = r->nparens+1;
10144 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10145 Copy(r->program, ret->program, len+1, regnode);
10147 New(0, ret->startp, npar, I32);
10148 Copy(r->startp, ret->startp, npar, I32);
10149 New(0, ret->endp, npar, I32);
10150 Copy(r->startp, ret->startp, npar, I32);
10152 New(0, ret->substrs, 1, struct reg_substr_data);
10153 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10154 s->min_offset = r->substrs->data[i].min_offset;
10155 s->max_offset = r->substrs->data[i].max_offset;
10156 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10157 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10160 ret->regstclass = NULL;
10162 struct reg_data *d;
10163 int count = r->data->count;
10165 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10166 char, struct reg_data);
10167 New(0, d->what, count, U8);
10170 for (i = 0; i < count; i++) {
10171 d->what[i] = r->data->what[i];
10172 switch (d->what[i]) {
10174 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10177 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10180 /* This is cheating. */
10181 New(0, d->data[i], 1, struct regnode_charclass_class);
10182 StructCopy(r->data->data[i], d->data[i],
10183 struct regnode_charclass_class);
10184 ret->regstclass = (regnode*)d->data[i];
10187 /* Compiled op trees are readonly, and can thus be
10188 shared without duplication. */
10189 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10192 d->data[i] = r->data->data[i];
10202 New(0, ret->offsets, 2*len+1, U32);
10203 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10205 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10206 ret->refcnt = r->refcnt;
10207 ret->minlen = r->minlen;
10208 ret->prelen = r->prelen;
10209 ret->nparens = r->nparens;
10210 ret->lastparen = r->lastparen;
10211 ret->lastcloseparen = r->lastcloseparen;
10212 ret->reganch = r->reganch;
10214 ret->sublen = r->sublen;
10216 if (RX_MATCH_COPIED(ret))
10217 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10219 ret->subbeg = Nullch;
10220 #ifdef PERL_COPY_ON_WRITE
10221 ret->saved_copy = Nullsv;
10224 ptr_table_store(PL_ptr_table, r, ret);
10228 /* duplicate a file handle */
10231 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10235 return (PerlIO*)NULL;
10237 /* look for it in the table first */
10238 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10242 /* create anew and remember what it is */
10243 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10244 ptr_table_store(PL_ptr_table, fp, ret);
10248 /* duplicate a directory handle */
10251 Perl_dirp_dup(pTHX_ DIR *dp)
10259 /* duplicate a typeglob */
10262 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10267 /* look for it in the table first */
10268 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10272 /* create anew and remember what it is */
10273 Newz(0, ret, 1, GP);
10274 ptr_table_store(PL_ptr_table, gp, ret);
10277 ret->gp_refcnt = 0; /* must be before any other dups! */
10278 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10279 ret->gp_io = io_dup_inc(gp->gp_io, param);
10280 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10281 ret->gp_av = av_dup_inc(gp->gp_av, param);
10282 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10283 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10284 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10285 ret->gp_cvgen = gp->gp_cvgen;
10286 ret->gp_flags = gp->gp_flags;
10287 ret->gp_line = gp->gp_line;
10288 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10292 /* duplicate a chain of magic */
10295 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10297 MAGIC *mgprev = (MAGIC*)NULL;
10300 return (MAGIC*)NULL;
10301 /* look for it in the table first */
10302 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10306 for (; mg; mg = mg->mg_moremagic) {
10308 Newz(0, nmg, 1, MAGIC);
10310 mgprev->mg_moremagic = nmg;
10313 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10314 nmg->mg_private = mg->mg_private;
10315 nmg->mg_type = mg->mg_type;
10316 nmg->mg_flags = mg->mg_flags;
10317 if (mg->mg_type == PERL_MAGIC_qr) {
10318 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10320 else if(mg->mg_type == PERL_MAGIC_backref) {
10321 AV *av = (AV*) mg->mg_obj;
10324 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10326 for (i = AvFILLp(av); i >= 0; i--) {
10327 if (!svp[i]) continue;
10328 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10332 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10333 ? sv_dup_inc(mg->mg_obj, param)
10334 : sv_dup(mg->mg_obj, param);
10336 nmg->mg_len = mg->mg_len;
10337 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10338 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10339 if (mg->mg_len > 0) {
10340 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10341 if (mg->mg_type == PERL_MAGIC_overload_table &&
10342 AMT_AMAGIC((AMT*)mg->mg_ptr))
10344 AMT *amtp = (AMT*)mg->mg_ptr;
10345 AMT *namtp = (AMT*)nmg->mg_ptr;
10347 for (i = 1; i < NofAMmeth; i++) {
10348 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10352 else if (mg->mg_len == HEf_SVKEY)
10353 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10355 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10356 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10363 /* create a new pointer-mapping table */
10366 Perl_ptr_table_new(pTHX)
10369 Newz(0, tbl, 1, PTR_TBL_t);
10370 tbl->tbl_max = 511;
10371 tbl->tbl_items = 0;
10372 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10377 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10379 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10382 /* map an existing pointer using a table */
10385 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10387 PTR_TBL_ENT_t *tblent;
10388 UV hash = PTR_TABLE_HASH(sv);
10390 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10391 for (; tblent; tblent = tblent->next) {
10392 if (tblent->oldval == sv)
10393 return tblent->newval;
10395 return (void*)NULL;
10398 /* add a new entry to a pointer-mapping table */
10401 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10403 PTR_TBL_ENT_t *tblent, **otblent;
10404 /* XXX this may be pessimal on platforms where pointers aren't good
10405 * hash values e.g. if they grow faster in the most significant
10407 UV hash = PTR_TABLE_HASH(oldv);
10411 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10412 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10413 if (tblent->oldval == oldv) {
10414 tblent->newval = newv;
10418 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10419 tblent->oldval = oldv;
10420 tblent->newval = newv;
10421 tblent->next = *otblent;
10424 if (!empty && tbl->tbl_items > tbl->tbl_max)
10425 ptr_table_split(tbl);
10428 /* double the hash bucket size of an existing ptr table */
10431 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10433 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10434 UV oldsize = tbl->tbl_max + 1;
10435 UV newsize = oldsize * 2;
10438 Renew(ary, newsize, PTR_TBL_ENT_t*);
10439 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10440 tbl->tbl_max = --newsize;
10441 tbl->tbl_ary = ary;
10442 for (i=0; i < oldsize; i++, ary++) {
10443 PTR_TBL_ENT_t **curentp, **entp, *ent;
10446 curentp = ary + oldsize;
10447 for (entp = ary, ent = *ary; ent; ent = *entp) {
10448 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10450 ent->next = *curentp;
10460 /* remove all the entries from a ptr table */
10463 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10465 register PTR_TBL_ENT_t **array;
10466 register PTR_TBL_ENT_t *entry;
10467 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10471 if (!tbl || !tbl->tbl_items) {
10475 array = tbl->tbl_ary;
10477 max = tbl->tbl_max;
10482 entry = entry->next;
10486 if (++riter > max) {
10489 entry = array[riter];
10493 tbl->tbl_items = 0;
10496 /* clear and free a ptr table */
10499 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10504 ptr_table_clear(tbl);
10505 Safefree(tbl->tbl_ary);
10510 char *PL_watch_pvx;
10513 /* attempt to make everything in the typeglob readonly */
10516 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10518 GV *gv = (GV*)sstr;
10519 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10521 if (GvIO(gv) || GvFORM(gv)) {
10522 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10524 else if (!GvCV(gv)) {
10525 GvCV(gv) = (CV*)sv;
10528 /* CvPADLISTs cannot be shared */
10529 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10534 if (!GvUNIQUE(gv)) {
10536 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10537 HvNAME(GvSTASH(gv)), GvNAME(gv));
10543 * write attempts will die with
10544 * "Modification of a read-only value attempted"
10550 SvREADONLY_on(GvSV(gv));
10554 GvAV(gv) = (AV*)sv;
10557 SvREADONLY_on(GvAV(gv));
10561 GvHV(gv) = (HV*)sv;
10564 SvREADONLY_on(GvHV(gv));
10567 return sstr; /* he_dup() will SvREFCNT_inc() */
10570 /* duplicate an SV of any type (including AV, HV etc) */
10573 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10576 SvRV(dstr) = SvWEAKREF(sstr)
10577 ? sv_dup(SvRV(sstr), param)
10578 : sv_dup_inc(SvRV(sstr), param);
10580 else if (SvPVX(sstr)) {
10581 /* Has something there */
10583 /* Normal PV - clone whole allocated space */
10584 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10585 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10586 /* Not that normal - actually sstr is copy on write.
10587 But we are a true, independant SV, so: */
10588 SvREADONLY_off(dstr);
10593 /* Special case - not normally malloced for some reason */
10594 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10595 /* A "shared" PV - clone it as unshared string */
10596 if(SvPADTMP(sstr)) {
10597 /* However, some of them live in the pad
10598 and they should not have these flags
10601 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10603 SvUVX(dstr) = SvUVX(sstr);
10606 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10608 SvREADONLY_off(dstr);
10612 /* Some other special case - random pointer */
10613 SvPVX(dstr) = SvPVX(sstr);
10618 /* Copy the Null */
10619 SvPVX(dstr) = SvPVX(sstr);
10624 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10628 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10630 /* look for it in the table first */
10631 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10635 if(param->flags & CLONEf_JOIN_IN) {
10636 /** We are joining here so we don't want do clone
10637 something that is bad **/
10639 if(SvTYPE(sstr) == SVt_PVHV &&
10641 /** don't clone stashes if they already exist **/
10642 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10643 return (SV*) old_stash;
10647 /* create anew and remember what it is */
10649 ptr_table_store(PL_ptr_table, sstr, dstr);
10652 SvFLAGS(dstr) = SvFLAGS(sstr);
10653 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10654 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10657 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10658 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10659 PL_watch_pvx, SvPVX(sstr));
10662 switch (SvTYPE(sstr)) {
10664 SvANY(dstr) = NULL;
10667 SvANY(dstr) = new_XIV();
10668 SvIVX(dstr) = SvIVX(sstr);
10671 SvANY(dstr) = new_XNV();
10672 SvNVX(dstr) = SvNVX(sstr);
10675 SvANY(dstr) = new_XRV();
10676 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10679 SvANY(dstr) = new_XPV();
10680 SvCUR(dstr) = SvCUR(sstr);
10681 SvLEN(dstr) = SvLEN(sstr);
10682 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10685 SvANY(dstr) = new_XPVIV();
10686 SvCUR(dstr) = SvCUR(sstr);
10687 SvLEN(dstr) = SvLEN(sstr);
10688 SvIVX(dstr) = SvIVX(sstr);
10689 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10692 SvANY(dstr) = new_XPVNV();
10693 SvCUR(dstr) = SvCUR(sstr);
10694 SvLEN(dstr) = SvLEN(sstr);
10695 SvIVX(dstr) = SvIVX(sstr);
10696 SvNVX(dstr) = SvNVX(sstr);
10697 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10700 SvANY(dstr) = new_XPVMG();
10701 SvCUR(dstr) = SvCUR(sstr);
10702 SvLEN(dstr) = SvLEN(sstr);
10703 SvIVX(dstr) = SvIVX(sstr);
10704 SvNVX(dstr) = SvNVX(sstr);
10705 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10706 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10707 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10710 SvANY(dstr) = new_XPVBM();
10711 SvCUR(dstr) = SvCUR(sstr);
10712 SvLEN(dstr) = SvLEN(sstr);
10713 SvIVX(dstr) = SvIVX(sstr);
10714 SvNVX(dstr) = SvNVX(sstr);
10715 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10716 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10717 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10718 BmRARE(dstr) = BmRARE(sstr);
10719 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10720 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10723 SvANY(dstr) = new_XPVLV();
10724 SvCUR(dstr) = SvCUR(sstr);
10725 SvLEN(dstr) = SvLEN(sstr);
10726 SvIVX(dstr) = SvIVX(sstr);
10727 SvNVX(dstr) = SvNVX(sstr);
10728 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10729 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10730 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10731 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10732 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10733 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10734 LvTARG(dstr) = dstr;
10735 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10736 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10738 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10739 LvTYPE(dstr) = LvTYPE(sstr);
10742 if (GvUNIQUE((GV*)sstr)) {
10744 if ((share = gv_share(sstr, param))) {
10747 ptr_table_store(PL_ptr_table, sstr, dstr);
10749 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10750 HvNAME(GvSTASH(share)), GvNAME(share));
10755 SvANY(dstr) = new_XPVGV();
10756 SvCUR(dstr) = SvCUR(sstr);
10757 SvLEN(dstr) = SvLEN(sstr);
10758 SvIVX(dstr) = SvIVX(sstr);
10759 SvNVX(dstr) = SvNVX(sstr);
10760 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10761 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10762 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10763 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10764 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10765 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10766 GvFLAGS(dstr) = GvFLAGS(sstr);
10767 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10768 (void)GpREFCNT_inc(GvGP(dstr));
10771 SvANY(dstr) = new_XPVIO();
10772 SvCUR(dstr) = SvCUR(sstr);
10773 SvLEN(dstr) = SvLEN(sstr);
10774 SvIVX(dstr) = SvIVX(sstr);
10775 SvNVX(dstr) = SvNVX(sstr);
10776 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10777 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10778 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10779 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10780 if (IoOFP(sstr) == IoIFP(sstr))
10781 IoOFP(dstr) = IoIFP(dstr);
10783 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10784 /* PL_rsfp_filters entries have fake IoDIRP() */
10785 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10786 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10788 IoDIRP(dstr) = IoDIRP(sstr);
10789 IoLINES(dstr) = IoLINES(sstr);
10790 IoPAGE(dstr) = IoPAGE(sstr);
10791 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10792 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10793 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10794 /* I have no idea why fake dirp (rsfps)
10795 should be treaded differently but otherwise
10796 we end up with leaks -- sky*/
10797 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10798 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10799 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10801 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10802 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10803 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10805 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10806 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10807 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10808 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10809 IoTYPE(dstr) = IoTYPE(sstr);
10810 IoFLAGS(dstr) = IoFLAGS(sstr);
10813 SvANY(dstr) = new_XPVAV();
10814 SvCUR(dstr) = SvCUR(sstr);
10815 SvLEN(dstr) = SvLEN(sstr);
10816 SvIVX(dstr) = SvIVX(sstr);
10817 SvNVX(dstr) = SvNVX(sstr);
10818 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10819 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10820 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10821 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10822 if (AvARRAY((AV*)sstr)) {
10823 SV **dst_ary, **src_ary;
10824 SSize_t items = AvFILLp((AV*)sstr) + 1;
10826 src_ary = AvARRAY((AV*)sstr);
10827 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10828 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10829 SvPVX(dstr) = (char*)dst_ary;
10830 AvALLOC((AV*)dstr) = dst_ary;
10831 if (AvREAL((AV*)sstr)) {
10832 while (items-- > 0)
10833 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10836 while (items-- > 0)
10837 *dst_ary++ = sv_dup(*src_ary++, param);
10839 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10840 while (items-- > 0) {
10841 *dst_ary++ = &PL_sv_undef;
10845 SvPVX(dstr) = Nullch;
10846 AvALLOC((AV*)dstr) = (SV**)NULL;
10850 SvANY(dstr) = new_XPVHV();
10851 SvCUR(dstr) = SvCUR(sstr);
10852 SvLEN(dstr) = SvLEN(sstr);
10853 SvIVX(dstr) = SvIVX(sstr);
10854 SvNVX(dstr) = SvNVX(sstr);
10855 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10856 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10857 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10858 if (HvARRAY((HV*)sstr)) {
10860 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10861 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10862 Newz(0, dxhv->xhv_array,
10863 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10864 while (i <= sxhv->xhv_max) {
10865 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10866 (bool)!!HvSHAREKEYS(sstr),
10870 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10871 (bool)!!HvSHAREKEYS(sstr), param);
10874 SvPVX(dstr) = Nullch;
10875 HvEITER((HV*)dstr) = (HE*)NULL;
10877 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10878 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10879 /* Record stashes for possible cloning in Perl_clone(). */
10880 if(HvNAME((HV*)dstr))
10881 av_push(param->stashes, dstr);
10884 SvANY(dstr) = new_XPVFM();
10885 FmLINES(dstr) = FmLINES(sstr);
10889 SvANY(dstr) = new_XPVCV();
10891 SvCUR(dstr) = SvCUR(sstr);
10892 SvLEN(dstr) = SvLEN(sstr);
10893 SvIVX(dstr) = SvIVX(sstr);
10894 SvNVX(dstr) = SvNVX(sstr);
10895 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10896 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10897 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10898 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10899 CvSTART(dstr) = CvSTART(sstr);
10900 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10901 CvXSUB(dstr) = CvXSUB(sstr);
10902 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10903 if (CvCONST(sstr)) {
10904 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10905 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10906 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10908 /* don't dup if copying back - CvGV isn't refcounted, so the
10909 * duped GV may never be freed. A bit of a hack! DAPM */
10910 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10911 Nullgv : gv_dup(CvGV(sstr), param) ;
10912 if (param->flags & CLONEf_COPY_STACKS) {
10913 CvDEPTH(dstr) = CvDEPTH(sstr);
10917 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10918 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10920 CvWEAKOUTSIDE(sstr)
10921 ? cv_dup( CvOUTSIDE(sstr), param)
10922 : cv_dup_inc(CvOUTSIDE(sstr), param);
10923 CvFLAGS(dstr) = CvFLAGS(sstr);
10924 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10927 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10931 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10937 /* duplicate a context */
10940 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10942 PERL_CONTEXT *ncxs;
10945 return (PERL_CONTEXT*)NULL;
10947 /* look for it in the table first */
10948 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10952 /* create anew and remember what it is */
10953 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10954 ptr_table_store(PL_ptr_table, cxs, ncxs);
10957 PERL_CONTEXT *cx = &cxs[ix];
10958 PERL_CONTEXT *ncx = &ncxs[ix];
10959 ncx->cx_type = cx->cx_type;
10960 if (CxTYPE(cx) == CXt_SUBST) {
10961 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10964 ncx->blk_oldsp = cx->blk_oldsp;
10965 ncx->blk_oldcop = cx->blk_oldcop;
10966 ncx->blk_oldretsp = cx->blk_oldretsp;
10967 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10968 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10969 ncx->blk_oldpm = cx->blk_oldpm;
10970 ncx->blk_gimme = cx->blk_gimme;
10971 switch (CxTYPE(cx)) {
10973 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10974 ? cv_dup_inc(cx->blk_sub.cv, param)
10975 : cv_dup(cx->blk_sub.cv,param));
10976 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10977 ? av_dup_inc(cx->blk_sub.argarray, param)
10979 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10980 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10981 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10982 ncx->blk_sub.lval = cx->blk_sub.lval;
10985 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10986 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10987 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10988 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10989 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10992 ncx->blk_loop.label = cx->blk_loop.label;
10993 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10994 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10995 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10996 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10997 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10998 ? cx->blk_loop.iterdata
10999 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11000 ncx->blk_loop.oldcomppad
11001 = (PAD*)ptr_table_fetch(PL_ptr_table,
11002 cx->blk_loop.oldcomppad);
11003 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11004 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11005 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11006 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11007 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11010 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11011 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11012 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11013 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11025 /* duplicate a stack info structure */
11028 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11033 return (PERL_SI*)NULL;
11035 /* look for it in the table first */
11036 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11040 /* create anew and remember what it is */
11041 Newz(56, nsi, 1, PERL_SI);
11042 ptr_table_store(PL_ptr_table, si, nsi);
11044 nsi->si_stack = av_dup_inc(si->si_stack, param);
11045 nsi->si_cxix = si->si_cxix;
11046 nsi->si_cxmax = si->si_cxmax;
11047 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11048 nsi->si_type = si->si_type;
11049 nsi->si_prev = si_dup(si->si_prev, param);
11050 nsi->si_next = si_dup(si->si_next, param);
11051 nsi->si_markoff = si->si_markoff;
11056 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11057 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11058 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11059 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11060 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11061 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11062 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11063 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11064 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11065 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11066 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11067 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11068 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11069 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11072 #define pv_dup_inc(p) SAVEPV(p)
11073 #define pv_dup(p) SAVEPV(p)
11074 #define svp_dup_inc(p,pp) any_dup(p,pp)
11076 /* map any object to the new equivent - either something in the
11077 * ptr table, or something in the interpreter structure
11081 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11086 return (void*)NULL;
11088 /* look for it in the table first */
11089 ret = ptr_table_fetch(PL_ptr_table, v);
11093 /* see if it is part of the interpreter structure */
11094 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11095 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11103 /* duplicate the save stack */
11106 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11108 ANY *ss = proto_perl->Tsavestack;
11109 I32 ix = proto_perl->Tsavestack_ix;
11110 I32 max = proto_perl->Tsavestack_max;
11123 void (*dptr) (void*);
11124 void (*dxptr) (pTHX_ void*);
11127 Newz(54, nss, max, ANY);
11131 TOPINT(nss,ix) = i;
11133 case SAVEt_ITEM: /* normal string */
11134 sv = (SV*)POPPTR(ss,ix);
11135 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11136 sv = (SV*)POPPTR(ss,ix);
11137 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11139 case SAVEt_SV: /* scalar reference */
11140 sv = (SV*)POPPTR(ss,ix);
11141 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11142 gv = (GV*)POPPTR(ss,ix);
11143 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11145 case SAVEt_GENERIC_PVREF: /* generic char* */
11146 c = (char*)POPPTR(ss,ix);
11147 TOPPTR(nss,ix) = pv_dup(c);
11148 ptr = POPPTR(ss,ix);
11149 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11151 case SAVEt_SHARED_PVREF: /* char* in shared space */
11152 c = (char*)POPPTR(ss,ix);
11153 TOPPTR(nss,ix) = savesharedpv(c);
11154 ptr = POPPTR(ss,ix);
11155 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11157 case SAVEt_GENERIC_SVREF: /* generic sv */
11158 case SAVEt_SVREF: /* scalar reference */
11159 sv = (SV*)POPPTR(ss,ix);
11160 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11161 ptr = POPPTR(ss,ix);
11162 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11164 case SAVEt_AV: /* array reference */
11165 av = (AV*)POPPTR(ss,ix);
11166 TOPPTR(nss,ix) = av_dup_inc(av, param);
11167 gv = (GV*)POPPTR(ss,ix);
11168 TOPPTR(nss,ix) = gv_dup(gv, param);
11170 case SAVEt_HV: /* hash reference */
11171 hv = (HV*)POPPTR(ss,ix);
11172 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11173 gv = (GV*)POPPTR(ss,ix);
11174 TOPPTR(nss,ix) = gv_dup(gv, param);
11176 case SAVEt_INT: /* int reference */
11177 ptr = POPPTR(ss,ix);
11178 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11179 intval = (int)POPINT(ss,ix);
11180 TOPINT(nss,ix) = intval;
11182 case SAVEt_LONG: /* long reference */
11183 ptr = POPPTR(ss,ix);
11184 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11185 longval = (long)POPLONG(ss,ix);
11186 TOPLONG(nss,ix) = longval;
11188 case SAVEt_I32: /* I32 reference */
11189 case SAVEt_I16: /* I16 reference */
11190 case SAVEt_I8: /* I8 reference */
11191 ptr = POPPTR(ss,ix);
11192 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11194 TOPINT(nss,ix) = i;
11196 case SAVEt_IV: /* IV reference */
11197 ptr = POPPTR(ss,ix);
11198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11200 TOPIV(nss,ix) = iv;
11202 case SAVEt_SPTR: /* SV* reference */
11203 ptr = POPPTR(ss,ix);
11204 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11205 sv = (SV*)POPPTR(ss,ix);
11206 TOPPTR(nss,ix) = sv_dup(sv, param);
11208 case SAVEt_VPTR: /* random* reference */
11209 ptr = POPPTR(ss,ix);
11210 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11211 ptr = POPPTR(ss,ix);
11212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11214 case SAVEt_PPTR: /* char* reference */
11215 ptr = POPPTR(ss,ix);
11216 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11217 c = (char*)POPPTR(ss,ix);
11218 TOPPTR(nss,ix) = pv_dup(c);
11220 case SAVEt_HPTR: /* HV* reference */
11221 ptr = POPPTR(ss,ix);
11222 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11223 hv = (HV*)POPPTR(ss,ix);
11224 TOPPTR(nss,ix) = hv_dup(hv, param);
11226 case SAVEt_APTR: /* AV* reference */
11227 ptr = POPPTR(ss,ix);
11228 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11229 av = (AV*)POPPTR(ss,ix);
11230 TOPPTR(nss,ix) = av_dup(av, param);
11233 gv = (GV*)POPPTR(ss,ix);
11234 TOPPTR(nss,ix) = gv_dup(gv, param);
11236 case SAVEt_GP: /* scalar reference */
11237 gp = (GP*)POPPTR(ss,ix);
11238 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11239 (void)GpREFCNT_inc(gp);
11240 gv = (GV*)POPPTR(ss,ix);
11241 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11242 c = (char*)POPPTR(ss,ix);
11243 TOPPTR(nss,ix) = pv_dup(c);
11245 TOPIV(nss,ix) = iv;
11247 TOPIV(nss,ix) = iv;
11250 case SAVEt_MORTALIZESV:
11251 sv = (SV*)POPPTR(ss,ix);
11252 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11255 ptr = POPPTR(ss,ix);
11256 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11257 /* these are assumed to be refcounted properly */
11258 switch (((OP*)ptr)->op_type) {
11260 case OP_LEAVESUBLV:
11264 case OP_LEAVEWRITE:
11265 TOPPTR(nss,ix) = ptr;
11270 TOPPTR(nss,ix) = Nullop;
11275 TOPPTR(nss,ix) = Nullop;
11278 c = (char*)POPPTR(ss,ix);
11279 TOPPTR(nss,ix) = pv_dup_inc(c);
11281 case SAVEt_CLEARSV:
11282 longval = POPLONG(ss,ix);
11283 TOPLONG(nss,ix) = longval;
11286 hv = (HV*)POPPTR(ss,ix);
11287 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11288 c = (char*)POPPTR(ss,ix);
11289 TOPPTR(nss,ix) = pv_dup_inc(c);
11291 TOPINT(nss,ix) = i;
11293 case SAVEt_DESTRUCTOR:
11294 ptr = POPPTR(ss,ix);
11295 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11296 dptr = POPDPTR(ss,ix);
11297 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11299 case SAVEt_DESTRUCTOR_X:
11300 ptr = POPPTR(ss,ix);
11301 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11302 dxptr = POPDXPTR(ss,ix);
11303 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11305 case SAVEt_REGCONTEXT:
11308 TOPINT(nss,ix) = i;
11311 case SAVEt_STACK_POS: /* Position on Perl stack */
11313 TOPINT(nss,ix) = i;
11315 case SAVEt_AELEM: /* array element */
11316 sv = (SV*)POPPTR(ss,ix);
11317 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11319 TOPINT(nss,ix) = i;
11320 av = (AV*)POPPTR(ss,ix);
11321 TOPPTR(nss,ix) = av_dup_inc(av, param);
11323 case SAVEt_HELEM: /* hash element */
11324 sv = (SV*)POPPTR(ss,ix);
11325 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11326 sv = (SV*)POPPTR(ss,ix);
11327 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11328 hv = (HV*)POPPTR(ss,ix);
11329 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11332 ptr = POPPTR(ss,ix);
11333 TOPPTR(nss,ix) = ptr;
11337 TOPINT(nss,ix) = i;
11339 case SAVEt_COMPPAD:
11340 av = (AV*)POPPTR(ss,ix);
11341 TOPPTR(nss,ix) = av_dup(av, param);
11344 longval = (long)POPLONG(ss,ix);
11345 TOPLONG(nss,ix) = longval;
11346 ptr = POPPTR(ss,ix);
11347 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11348 sv = (SV*)POPPTR(ss,ix);
11349 TOPPTR(nss,ix) = sv_dup(sv, param);
11352 ptr = POPPTR(ss,ix);
11353 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11354 longval = (long)POPBOOL(ss,ix);
11355 TOPBOOL(nss,ix) = (bool)longval;
11357 case SAVEt_SET_SVFLAGS:
11359 TOPINT(nss,ix) = i;
11361 TOPINT(nss,ix) = i;
11362 sv = (SV*)POPPTR(ss,ix);
11363 TOPPTR(nss,ix) = sv_dup(sv, param);
11366 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11374 =for apidoc perl_clone
11376 Create and return a new interpreter by cloning the current one.
11378 perl_clone takes these flags as parameters:
11380 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11381 without it we only clone the data and zero the stacks,
11382 with it we copy the stacks and the new perl interpreter is
11383 ready to run at the exact same point as the previous one.
11384 The pseudo-fork code uses COPY_STACKS while the
11385 threads->new doesn't.
11387 CLONEf_KEEP_PTR_TABLE
11388 perl_clone keeps a ptr_table with the pointer of the old
11389 variable as a key and the new variable as a value,
11390 this allows it to check if something has been cloned and not
11391 clone it again but rather just use the value and increase the
11392 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11393 the ptr_table using the function
11394 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11395 reason to keep it around is if you want to dup some of your own
11396 variable who are outside the graph perl scans, example of this
11397 code is in threads.xs create
11400 This is a win32 thing, it is ignored on unix, it tells perls
11401 win32host code (which is c++) to clone itself, this is needed on
11402 win32 if you want to run two threads at the same time,
11403 if you just want to do some stuff in a separate perl interpreter
11404 and then throw it away and return to the original one,
11405 you don't need to do anything.
11410 /* XXX the above needs expanding by someone who actually understands it ! */
11411 EXTERN_C PerlInterpreter *
11412 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11415 perl_clone(PerlInterpreter *proto_perl, UV flags)
11417 #ifdef PERL_IMPLICIT_SYS
11419 /* perlhost.h so we need to call into it
11420 to clone the host, CPerlHost should have a c interface, sky */
11422 if (flags & CLONEf_CLONE_HOST) {
11423 return perl_clone_host(proto_perl,flags);
11425 return perl_clone_using(proto_perl, flags,
11427 proto_perl->IMemShared,
11428 proto_perl->IMemParse,
11430 proto_perl->IStdIO,
11434 proto_perl->IProc);
11438 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11439 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11440 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11441 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11442 struct IPerlDir* ipD, struct IPerlSock* ipS,
11443 struct IPerlProc* ipP)
11445 /* XXX many of the string copies here can be optimized if they're
11446 * constants; they need to be allocated as common memory and just
11447 * their pointers copied. */
11450 CLONE_PARAMS clone_params;
11451 CLONE_PARAMS* param = &clone_params;
11453 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11454 PERL_SET_THX(my_perl);
11457 Poison(my_perl, 1, PerlInterpreter);
11461 PL_savestack_ix = 0;
11462 PL_savestack_max = -1;
11464 PL_sig_pending = 0;
11465 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11466 # else /* !DEBUGGING */
11467 Zero(my_perl, 1, PerlInterpreter);
11468 # endif /* DEBUGGING */
11470 /* host pointers */
11472 PL_MemShared = ipMS;
11473 PL_MemParse = ipMP;
11480 #else /* !PERL_IMPLICIT_SYS */
11482 CLONE_PARAMS clone_params;
11483 CLONE_PARAMS* param = &clone_params;
11484 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11485 PERL_SET_THX(my_perl);
11490 Poison(my_perl, 1, PerlInterpreter);
11494 PL_savestack_ix = 0;
11495 PL_savestack_max = -1;
11497 PL_sig_pending = 0;
11498 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11499 # else /* !DEBUGGING */
11500 Zero(my_perl, 1, PerlInterpreter);
11501 # endif /* DEBUGGING */
11502 #endif /* PERL_IMPLICIT_SYS */
11503 param->flags = flags;
11504 param->proto_perl = proto_perl;
11507 PL_xiv_arenaroot = NULL;
11508 PL_xiv_root = NULL;
11509 PL_xnv_arenaroot = NULL;
11510 PL_xnv_root = NULL;
11511 PL_xrv_arenaroot = NULL;
11512 PL_xrv_root = NULL;
11513 PL_xpv_arenaroot = NULL;
11514 PL_xpv_root = NULL;
11515 PL_xpviv_arenaroot = NULL;
11516 PL_xpviv_root = NULL;
11517 PL_xpvnv_arenaroot = NULL;
11518 PL_xpvnv_root = NULL;
11519 PL_xpvcv_arenaroot = NULL;
11520 PL_xpvcv_root = NULL;
11521 PL_xpvav_arenaroot = NULL;
11522 PL_xpvav_root = NULL;
11523 PL_xpvhv_arenaroot = NULL;
11524 PL_xpvhv_root = NULL;
11525 PL_xpvmg_arenaroot = NULL;
11526 PL_xpvmg_root = NULL;
11527 PL_xpvlv_arenaroot = NULL;
11528 PL_xpvlv_root = NULL;
11529 PL_xpvbm_arenaroot = NULL;
11530 PL_xpvbm_root = NULL;
11531 PL_he_arenaroot = NULL;
11533 PL_nice_chunk = NULL;
11534 PL_nice_chunk_size = 0;
11536 PL_sv_objcount = 0;
11537 PL_sv_root = Nullsv;
11538 PL_sv_arenaroot = Nullsv;
11540 PL_debug = proto_perl->Idebug;
11542 #ifdef USE_REENTRANT_API
11543 /* XXX: things like -Dm will segfault here in perlio, but doing
11544 * PERL_SET_CONTEXT(proto_perl);
11545 * breaks too many other things
11547 Perl_reentrant_init(aTHX);
11550 /* create SV map for pointer relocation */
11551 PL_ptr_table = ptr_table_new();
11553 /* initialize these special pointers as early as possible */
11554 SvANY(&PL_sv_undef) = NULL;
11555 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11556 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11557 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11559 SvANY(&PL_sv_no) = new_XPVNV();
11560 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11561 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11562 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11563 SvCUR(&PL_sv_no) = 0;
11564 SvLEN(&PL_sv_no) = 1;
11565 SvNVX(&PL_sv_no) = 0;
11566 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11568 SvANY(&PL_sv_yes) = new_XPVNV();
11569 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11570 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11571 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11572 SvCUR(&PL_sv_yes) = 1;
11573 SvLEN(&PL_sv_yes) = 2;
11574 SvNVX(&PL_sv_yes) = 1;
11575 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11577 /* create (a non-shared!) shared string table */
11578 PL_strtab = newHV();
11579 HvSHAREKEYS_off(PL_strtab);
11580 hv_ksplit(PL_strtab, 512);
11581 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11583 PL_compiling = proto_perl->Icompiling;
11585 /* These two PVs will be free'd special way so must set them same way op.c does */
11586 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11587 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11589 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11590 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11592 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11593 if (!specialWARN(PL_compiling.cop_warnings))
11594 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11595 if (!specialCopIO(PL_compiling.cop_io))
11596 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11597 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11599 /* pseudo environmental stuff */
11600 PL_origargc = proto_perl->Iorigargc;
11601 PL_origargv = proto_perl->Iorigargv;
11603 param->stashes = newAV(); /* Setup array of objects to call clone on */
11605 #ifdef PERLIO_LAYERS
11606 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11607 PerlIO_clone(aTHX_ proto_perl, param);
11610 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11611 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11612 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11613 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11614 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11615 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11618 PL_minus_c = proto_perl->Iminus_c;
11619 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11620 PL_localpatches = proto_perl->Ilocalpatches;
11621 PL_splitstr = proto_perl->Isplitstr;
11622 PL_preprocess = proto_perl->Ipreprocess;
11623 PL_minus_n = proto_perl->Iminus_n;
11624 PL_minus_p = proto_perl->Iminus_p;
11625 PL_minus_l = proto_perl->Iminus_l;
11626 PL_minus_a = proto_perl->Iminus_a;
11627 PL_minus_F = proto_perl->Iminus_F;
11628 PL_doswitches = proto_perl->Idoswitches;
11629 PL_dowarn = proto_perl->Idowarn;
11630 PL_doextract = proto_perl->Idoextract;
11631 PL_sawampersand = proto_perl->Isawampersand;
11632 PL_unsafe = proto_perl->Iunsafe;
11633 PL_inplace = SAVEPV(proto_perl->Iinplace);
11634 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11635 PL_perldb = proto_perl->Iperldb;
11636 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11637 PL_exit_flags = proto_perl->Iexit_flags;
11639 /* magical thingies */
11640 /* XXX time(&PL_basetime) when asked for? */
11641 PL_basetime = proto_perl->Ibasetime;
11642 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11644 PL_maxsysfd = proto_perl->Imaxsysfd;
11645 PL_multiline = proto_perl->Imultiline;
11646 PL_statusvalue = proto_perl->Istatusvalue;
11648 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11650 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11652 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11653 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11654 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11656 /* Clone the regex array */
11657 PL_regex_padav = newAV();
11659 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11660 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11661 av_push(PL_regex_padav,
11662 sv_dup_inc(regexen[0],param));
11663 for(i = 1; i <= len; i++) {
11664 if(SvREPADTMP(regexen[i])) {
11665 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11667 av_push(PL_regex_padav,
11669 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11670 SvIVX(regexen[i])), param)))
11675 PL_regex_pad = AvARRAY(PL_regex_padav);
11677 /* shortcuts to various I/O objects */
11678 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11679 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11680 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11681 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11682 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11683 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11685 /* shortcuts to regexp stuff */
11686 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11688 /* shortcuts to misc objects */
11689 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11691 /* shortcuts to debugging objects */
11692 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11693 PL_DBline = gv_dup(proto_perl->IDBline, param);
11694 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11695 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11696 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11697 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11698 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11699 PL_lineary = av_dup(proto_perl->Ilineary, param);
11700 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11702 /* symbol tables */
11703 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11704 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11705 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11706 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11707 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11709 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11710 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11711 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11712 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11713 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11714 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11716 PL_sub_generation = proto_perl->Isub_generation;
11718 /* funky return mechanisms */
11719 PL_forkprocess = proto_perl->Iforkprocess;
11721 /* subprocess state */
11722 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11724 /* internal state */
11725 PL_tainting = proto_perl->Itainting;
11726 PL_taint_warn = proto_perl->Itaint_warn;
11727 PL_maxo = proto_perl->Imaxo;
11728 if (proto_perl->Iop_mask)
11729 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11731 PL_op_mask = Nullch;
11732 /* PL_asserting = proto_perl->Iasserting; */
11734 /* current interpreter roots */
11735 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11736 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11737 PL_main_start = proto_perl->Imain_start;
11738 PL_eval_root = proto_perl->Ieval_root;
11739 PL_eval_start = proto_perl->Ieval_start;
11741 /* runtime control stuff */
11742 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11743 PL_copline = proto_perl->Icopline;
11745 PL_filemode = proto_perl->Ifilemode;
11746 PL_lastfd = proto_perl->Ilastfd;
11747 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11750 PL_gensym = proto_perl->Igensym;
11751 PL_preambled = proto_perl->Ipreambled;
11752 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11753 PL_laststatval = proto_perl->Ilaststatval;
11754 PL_laststype = proto_perl->Ilaststype;
11755 PL_mess_sv = Nullsv;
11757 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11758 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11760 /* interpreter atexit processing */
11761 PL_exitlistlen = proto_perl->Iexitlistlen;
11762 if (PL_exitlistlen) {
11763 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11764 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11767 PL_exitlist = (PerlExitListEntry*)NULL;
11768 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11769 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11770 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11772 PL_profiledata = NULL;
11773 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11774 /* PL_rsfp_filters entries have fake IoDIRP() */
11775 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11777 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11779 PAD_CLONE_VARS(proto_perl, param);
11781 #ifdef HAVE_INTERP_INTERN
11782 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11785 /* more statics moved here */
11786 PL_generation = proto_perl->Igeneration;
11787 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11789 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11790 PL_in_clean_all = proto_perl->Iin_clean_all;
11792 PL_uid = proto_perl->Iuid;
11793 PL_euid = proto_perl->Ieuid;
11794 PL_gid = proto_perl->Igid;
11795 PL_egid = proto_perl->Iegid;
11796 PL_nomemok = proto_perl->Inomemok;
11797 PL_an = proto_perl->Ian;
11798 PL_evalseq = proto_perl->Ievalseq;
11799 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11800 PL_origalen = proto_perl->Iorigalen;
11801 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11802 PL_osname = SAVEPV(proto_perl->Iosname);
11803 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11804 PL_sighandlerp = proto_perl->Isighandlerp;
11807 PL_runops = proto_perl->Irunops;
11809 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11812 PL_cshlen = proto_perl->Icshlen;
11813 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11816 PL_lex_state = proto_perl->Ilex_state;
11817 PL_lex_defer = proto_perl->Ilex_defer;
11818 PL_lex_expect = proto_perl->Ilex_expect;
11819 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11820 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11821 PL_lex_starts = proto_perl->Ilex_starts;
11822 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11823 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11824 PL_lex_op = proto_perl->Ilex_op;
11825 PL_lex_inpat = proto_perl->Ilex_inpat;
11826 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11827 PL_lex_brackets = proto_perl->Ilex_brackets;
11828 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11829 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11830 PL_lex_casemods = proto_perl->Ilex_casemods;
11831 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11832 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11834 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11835 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11836 PL_nexttoke = proto_perl->Inexttoke;
11838 /* XXX This is probably masking the deeper issue of why
11839 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11840 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11841 * (A little debugging with a watchpoint on it may help.)
11843 if (SvANY(proto_perl->Ilinestr)) {
11844 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11845 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11846 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11847 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11848 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11849 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11850 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11851 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11852 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11855 PL_linestr = NEWSV(65,79);
11856 sv_upgrade(PL_linestr,SVt_PVIV);
11857 sv_setpvn(PL_linestr,"",0);
11858 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11860 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11861 PL_pending_ident = proto_perl->Ipending_ident;
11862 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11864 PL_expect = proto_perl->Iexpect;
11866 PL_multi_start = proto_perl->Imulti_start;
11867 PL_multi_end = proto_perl->Imulti_end;
11868 PL_multi_open = proto_perl->Imulti_open;
11869 PL_multi_close = proto_perl->Imulti_close;
11871 PL_error_count = proto_perl->Ierror_count;
11872 PL_subline = proto_perl->Isubline;
11873 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11875 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11876 if (SvANY(proto_perl->Ilinestr)) {
11877 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11878 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11879 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11880 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11881 PL_last_lop_op = proto_perl->Ilast_lop_op;
11884 PL_last_uni = SvPVX(PL_linestr);
11885 PL_last_lop = SvPVX(PL_linestr);
11886 PL_last_lop_op = 0;
11888 PL_in_my = proto_perl->Iin_my;
11889 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11891 PL_cryptseen = proto_perl->Icryptseen;
11894 PL_hints = proto_perl->Ihints;
11896 PL_amagic_generation = proto_perl->Iamagic_generation;
11898 #ifdef USE_LOCALE_COLLATE
11899 PL_collation_ix = proto_perl->Icollation_ix;
11900 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11901 PL_collation_standard = proto_perl->Icollation_standard;
11902 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11903 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11904 #endif /* USE_LOCALE_COLLATE */
11906 #ifdef USE_LOCALE_NUMERIC
11907 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11908 PL_numeric_standard = proto_perl->Inumeric_standard;
11909 PL_numeric_local = proto_perl->Inumeric_local;
11910 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11911 #endif /* !USE_LOCALE_NUMERIC */
11913 /* utf8 character classes */
11914 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11915 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11916 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11917 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11918 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11919 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11920 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11921 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11922 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11923 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11924 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11925 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11926 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11927 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11928 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11929 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11930 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11931 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11932 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11933 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11935 /* Did the locale setup indicate UTF-8? */
11936 PL_utf8locale = proto_perl->Iutf8locale;
11937 /* Unicode features (see perlrun/-C) */
11938 PL_unicode = proto_perl->Iunicode;
11940 /* Pre-5.8 signals control */
11941 PL_signals = proto_perl->Isignals;
11943 /* times() ticks per second */
11944 PL_clocktick = proto_perl->Iclocktick;
11946 /* Recursion stopper for PerlIO_find_layer */
11947 PL_in_load_module = proto_perl->Iin_load_module;
11949 /* sort() routine */
11950 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11952 /* Not really needed/useful since the reenrant_retint is "volatile",
11953 * but do it for consistency's sake. */
11954 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11956 /* Hooks to shared SVs and locks. */
11957 PL_sharehook = proto_perl->Isharehook;
11958 PL_lockhook = proto_perl->Ilockhook;
11959 PL_unlockhook = proto_perl->Iunlockhook;
11960 PL_threadhook = proto_perl->Ithreadhook;
11962 PL_runops_std = proto_perl->Irunops_std;
11963 PL_runops_dbg = proto_perl->Irunops_dbg;
11965 #ifdef THREADS_HAVE_PIDS
11966 PL_ppid = proto_perl->Ippid;
11970 PL_last_swash_hv = Nullhv; /* reinits on demand */
11971 PL_last_swash_klen = 0;
11972 PL_last_swash_key[0]= '\0';
11973 PL_last_swash_tmps = (U8*)NULL;
11974 PL_last_swash_slen = 0;
11976 PL_glob_index = proto_perl->Iglob_index;
11977 PL_srand_called = proto_perl->Isrand_called;
11978 PL_hash_seed = proto_perl->Ihash_seed;
11979 PL_rehash_seed = proto_perl->Irehash_seed;
11980 PL_uudmap['M'] = 0; /* reinits on demand */
11981 PL_bitcount = Nullch; /* reinits on demand */
11983 if (proto_perl->Ipsig_pend) {
11984 Newz(0, PL_psig_pend, SIG_SIZE, int);
11987 PL_psig_pend = (int*)NULL;
11990 if (proto_perl->Ipsig_ptr) {
11991 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11992 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11993 for (i = 1; i < SIG_SIZE; i++) {
11994 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11995 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11999 PL_psig_ptr = (SV**)NULL;
12000 PL_psig_name = (SV**)NULL;
12003 /* thrdvar.h stuff */
12005 if (flags & CLONEf_COPY_STACKS) {
12006 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12007 PL_tmps_ix = proto_perl->Ttmps_ix;
12008 PL_tmps_max = proto_perl->Ttmps_max;
12009 PL_tmps_floor = proto_perl->Ttmps_floor;
12010 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12012 while (i <= PL_tmps_ix) {
12013 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12017 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12018 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12019 Newz(54, PL_markstack, i, I32);
12020 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12021 - proto_perl->Tmarkstack);
12022 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12023 - proto_perl->Tmarkstack);
12024 Copy(proto_perl->Tmarkstack, PL_markstack,
12025 PL_markstack_ptr - PL_markstack + 1, I32);
12027 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12028 * NOTE: unlike the others! */
12029 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12030 PL_scopestack_max = proto_perl->Tscopestack_max;
12031 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12032 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12034 /* next push_return() sets PL_retstack[PL_retstack_ix]
12035 * NOTE: unlike the others! */
12036 PL_retstack_ix = proto_perl->Tretstack_ix;
12037 PL_retstack_max = proto_perl->Tretstack_max;
12038 Newz(54, PL_retstack, PL_retstack_max, OP*);
12039 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
12041 /* NOTE: si_dup() looks at PL_markstack */
12042 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12044 /* PL_curstack = PL_curstackinfo->si_stack; */
12045 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12046 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12048 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12049 PL_stack_base = AvARRAY(PL_curstack);
12050 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12051 - proto_perl->Tstack_base);
12052 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12054 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12055 * NOTE: unlike the others! */
12056 PL_savestack_ix = proto_perl->Tsavestack_ix;
12057 PL_savestack_max = proto_perl->Tsavestack_max;
12058 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12059 PL_savestack = ss_dup(proto_perl, param);
12063 ENTER; /* perl_destruct() wants to LEAVE; */
12066 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12067 PL_top_env = &PL_start_env;
12069 PL_op = proto_perl->Top;
12072 PL_Xpv = (XPV*)NULL;
12073 PL_na = proto_perl->Tna;
12075 PL_statbuf = proto_perl->Tstatbuf;
12076 PL_statcache = proto_perl->Tstatcache;
12077 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12078 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12080 PL_timesbuf = proto_perl->Ttimesbuf;
12083 PL_tainted = proto_perl->Ttainted;
12084 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12085 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12086 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12087 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12088 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12089 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12090 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12091 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12092 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12094 PL_restartop = proto_perl->Trestartop;
12095 PL_in_eval = proto_perl->Tin_eval;
12096 PL_delaymagic = proto_perl->Tdelaymagic;
12097 PL_dirty = proto_perl->Tdirty;
12098 PL_localizing = proto_perl->Tlocalizing;
12100 #ifdef PERL_FLEXIBLE_EXCEPTIONS
12101 PL_protect = proto_perl->Tprotect;
12103 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12104 PL_hv_fetch_ent_mh = Nullhe;
12105 PL_modcount = proto_perl->Tmodcount;
12106 PL_lastgotoprobe = Nullop;
12107 PL_dumpindent = proto_perl->Tdumpindent;
12109 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12110 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12111 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12112 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12113 PL_sortcxix = proto_perl->Tsortcxix;
12114 PL_efloatbuf = Nullch; /* reinits on demand */
12115 PL_efloatsize = 0; /* reinits on demand */
12119 PL_screamfirst = NULL;
12120 PL_screamnext = NULL;
12121 PL_maxscream = -1; /* reinits on demand */
12122 PL_lastscream = Nullsv;
12124 PL_watchaddr = NULL;
12125 PL_watchok = Nullch;
12127 PL_regdummy = proto_perl->Tregdummy;
12128 PL_regprecomp = Nullch;
12131 PL_colorset = 0; /* reinits PL_colors[] */
12132 /*PL_colors[6] = {0,0,0,0,0,0};*/
12133 PL_reginput = Nullch;
12134 PL_regbol = Nullch;
12135 PL_regeol = Nullch;
12136 PL_regstartp = (I32*)NULL;
12137 PL_regendp = (I32*)NULL;
12138 PL_reglastparen = (U32*)NULL;
12139 PL_reglastcloseparen = (U32*)NULL;
12140 PL_regtill = Nullch;
12141 PL_reg_start_tmp = (char**)NULL;
12142 PL_reg_start_tmpl = 0;
12143 PL_regdata = (struct reg_data*)NULL;
12146 PL_reg_eval_set = 0;
12148 PL_regprogram = (regnode*)NULL;
12150 PL_regcc = (CURCUR*)NULL;
12151 PL_reg_call_cc = (struct re_cc_state*)NULL;
12152 PL_reg_re = (regexp*)NULL;
12153 PL_reg_ganch = Nullch;
12154 PL_reg_sv = Nullsv;
12155 PL_reg_match_utf8 = FALSE;
12156 PL_reg_magic = (MAGIC*)NULL;
12158 PL_reg_oldcurpm = (PMOP*)NULL;
12159 PL_reg_curpm = (PMOP*)NULL;
12160 PL_reg_oldsaved = Nullch;
12161 PL_reg_oldsavedlen = 0;
12162 #ifdef PERL_COPY_ON_WRITE
12165 PL_reg_maxiter = 0;
12166 PL_reg_leftiter = 0;
12167 PL_reg_poscache = Nullch;
12168 PL_reg_poscache_size= 0;
12170 /* RE engine - function pointers */
12171 PL_regcompp = proto_perl->Tregcompp;
12172 PL_regexecp = proto_perl->Tregexecp;
12173 PL_regint_start = proto_perl->Tregint_start;
12174 PL_regint_string = proto_perl->Tregint_string;
12175 PL_regfree = proto_perl->Tregfree;
12177 PL_reginterp_cnt = 0;
12178 PL_reg_starttry = 0;
12180 /* Pluggable optimizer */
12181 PL_peepp = proto_perl->Tpeepp;
12183 PL_stashcache = newHV();
12185 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12186 ptr_table_free(PL_ptr_table);
12187 PL_ptr_table = NULL;
12190 /* Call the ->CLONE method, if it exists, for each of the stashes
12191 identified by sv_dup() above.
12193 while(av_len(param->stashes) != -1) {
12194 HV* stash = (HV*) av_shift(param->stashes);
12195 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12196 if (cloner && GvCV(cloner)) {
12201 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12203 call_sv((SV*)GvCV(cloner), G_DISCARD);
12209 SvREFCNT_dec(param->stashes);
12214 #endif /* USE_ITHREADS */
12217 =head1 Unicode Support
12219 =for apidoc sv_recode_to_utf8
12221 The encoding is assumed to be an Encode object, on entry the PV
12222 of the sv is assumed to be octets in that encoding, and the sv
12223 will be converted into Unicode (and UTF-8).
12225 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12226 is not a reference, nothing is done to the sv. If the encoding is not
12227 an C<Encode::XS> Encoding object, bad things will happen.
12228 (See F<lib/encoding.pm> and L<Encode>).
12230 The PV of the sv is returned.
12235 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12237 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12251 Passing sv_yes is wrong - it needs to be or'ed set of constants
12252 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12253 remove converted chars from source.
12255 Both will default the value - let them.
12257 XPUSHs(&PL_sv_yes);
12260 call_method("decode", G_SCALAR);
12264 s = SvPV(uni, len);
12265 if (s != SvPVX(sv)) {
12266 SvGROW(sv, len + 1);
12267 Move(s, SvPVX(sv), len, char);
12268 SvCUR_set(sv, len);
12269 SvPVX(sv)[len] = 0;
12279 =for apidoc sv_cat_decode
12281 The encoding is assumed to be an Encode object, the PV of the ssv is
12282 assumed to be octets in that encoding and decoding the input starts
12283 from the position which (PV + *offset) pointed to. The dsv will be
12284 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12285 when the string tstr appears in decoding output or the input ends on
12286 the PV of the ssv. The value which the offset points will be modified
12287 to the last input position on the ssv.
12289 Returns TRUE if the terminator was found, else returns FALSE.
12294 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12295 SV *ssv, int *offset, char *tstr, int tlen)
12298 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12309 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12310 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12312 call_method("cat_decode", G_SCALAR);
12314 ret = SvTRUE(TOPs);
12315 *offset = SvIV(offsv);
12321 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");