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 Convert 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 Convert 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)
3944 (void) sv_2pv_flags(sv,&len, flags);
3953 sv_force_normal_flags(sv, 0);
3956 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3957 sv_recode_to_utf8(sv, PL_encoding);
3958 else { /* Assume Latin-1/EBCDIC */
3959 /* This function could be much more efficient if we
3960 * had a FLAG in SVs to signal if there are any hibit
3961 * chars in the PV. Given that there isn't such a flag
3962 * make the loop as fast as possible. */
3963 s = (U8 *) SvPVX(sv);
3964 e = (U8 *) SvEND(sv);
3968 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3973 (void)SvOOK_off(sv);
3975 len = SvCUR(sv) + 1; /* Plus the \0 */
3976 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3977 SvCUR(sv) = len - 1;
3979 Safefree(s); /* No longer using what was there before. */
3980 SvLEN(sv) = len; /* No longer know the real size. */
3982 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3989 =for apidoc sv_utf8_downgrade
3991 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
3992 This may not be possible if the PV contains non-byte encoding characters;
3993 if this is the case, either returns false or, if C<fail_ok> is not
3996 This is not as a general purpose Unicode to byte encoding interface:
3997 use the Encode extension for that.
4003 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4005 if (SvPOK(sv) && SvUTF8(sv)) {
4011 sv_force_normal_flags(sv, 0);
4013 s = (U8 *) SvPV(sv, len);
4014 if (!utf8_to_bytes(s, &len)) {
4019 Perl_croak(aTHX_ "Wide character in %s",
4022 Perl_croak(aTHX_ "Wide character");
4033 =for apidoc sv_utf8_encode
4035 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
4036 flag so that it looks like octets again. Used as a building block
4037 for encode_utf8 in Encode.xs
4043 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4045 (void) sv_utf8_upgrade(sv);
4047 sv_force_normal_flags(sv, 0);
4049 if (SvREADONLY(sv)) {
4050 Perl_croak(aTHX_ PL_no_modify);
4056 =for apidoc sv_utf8_decode
4058 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4059 turn off SvUTF8 if needed so that we see characters. Used as a building block
4060 for decode_utf8 in Encode.xs
4066 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4072 /* The octets may have got themselves encoded - get them back as
4075 if (!sv_utf8_downgrade(sv, TRUE))
4078 /* it is actually just a matter of turning the utf8 flag on, but
4079 * we want to make sure everything inside is valid utf8 first.
4081 c = (U8 *) SvPVX(sv);
4082 if (!is_utf8_string(c, SvCUR(sv)+1))
4084 e = (U8 *) SvEND(sv);
4087 if (!UTF8_IS_INVARIANT(ch)) {
4096 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4097 * this function provided for binary compatibility only
4101 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4103 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4107 =for apidoc sv_setsv
4109 Copies the contents of the source SV C<ssv> into the destination SV
4110 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4111 function if the source SV needs to be reused. Does not handle 'set' magic.
4112 Loosely speaking, it performs a copy-by-value, obliterating any previous
4113 content of the destination.
4115 You probably want to use one of the assortment of wrappers, such as
4116 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4117 C<SvSetMagicSV_nosteal>.
4119 =for apidoc sv_setsv_flags
4121 Copies the contents of the source SV C<ssv> into the destination SV
4122 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4123 function if the source SV needs to be reused. Does not handle 'set' magic.
4124 Loosely speaking, it performs a copy-by-value, obliterating any previous
4125 content of the destination.
4126 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4127 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4128 implemented in terms of this function.
4130 You probably want to use one of the assortment of wrappers, such as
4131 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4132 C<SvSetMagicSV_nosteal>.
4134 This is the primary function for copying scalars, and most other
4135 copy-ish functions and macros use this underneath.
4141 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4143 register U32 sflags;
4149 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4151 sstr = &PL_sv_undef;
4152 stype = SvTYPE(sstr);
4153 dtype = SvTYPE(dstr);
4158 /* need to nuke the magic */
4160 SvRMAGICAL_off(dstr);
4163 /* There's a lot of redundancy below but we're going for speed here */
4168 if (dtype != SVt_PVGV) {
4169 (void)SvOK_off(dstr);
4177 sv_upgrade(dstr, SVt_IV);
4180 sv_upgrade(dstr, SVt_PVNV);
4184 sv_upgrade(dstr, SVt_PVIV);
4187 (void)SvIOK_only(dstr);
4188 SvIVX(dstr) = SvIVX(sstr);
4191 if (SvTAINTED(sstr))
4202 sv_upgrade(dstr, SVt_NV);
4207 sv_upgrade(dstr, SVt_PVNV);
4210 SvNVX(dstr) = SvNVX(sstr);
4211 (void)SvNOK_only(dstr);
4212 if (SvTAINTED(sstr))
4220 sv_upgrade(dstr, SVt_RV);
4221 else if (dtype == SVt_PVGV &&
4222 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4225 if (GvIMPORTED(dstr) != GVf_IMPORTED
4226 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4228 GvIMPORTED_on(dstr);
4237 #ifdef PERL_COPY_ON_WRITE
4238 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4239 if (dtype < SVt_PVIV)
4240 sv_upgrade(dstr, SVt_PVIV);
4247 sv_upgrade(dstr, SVt_PV);
4250 if (dtype < SVt_PVIV)
4251 sv_upgrade(dstr, SVt_PVIV);
4254 if (dtype < SVt_PVNV)
4255 sv_upgrade(dstr, SVt_PVNV);
4262 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4265 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4269 if (dtype <= SVt_PVGV) {
4271 if (dtype != SVt_PVGV) {
4272 char *name = GvNAME(sstr);
4273 STRLEN len = GvNAMELEN(sstr);
4274 /* don't upgrade SVt_PVLV: it can hold a glob */
4275 if (dtype != SVt_PVLV)
4276 sv_upgrade(dstr, SVt_PVGV);
4277 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4278 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4279 GvNAME(dstr) = savepvn(name, len);
4280 GvNAMELEN(dstr) = len;
4281 SvFAKE_on(dstr); /* can coerce to non-glob */
4283 /* ahem, death to those who redefine active sort subs */
4284 else if (PL_curstackinfo->si_type == PERLSI_SORT
4285 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4286 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4289 #ifdef GV_UNIQUE_CHECK
4290 if (GvUNIQUE((GV*)dstr)) {
4291 Perl_croak(aTHX_ PL_no_modify);
4295 (void)SvOK_off(dstr);
4296 GvINTRO_off(dstr); /* one-shot flag */
4298 GvGP(dstr) = gp_ref(GvGP(sstr));
4299 if (SvTAINTED(sstr))
4301 if (GvIMPORTED(dstr) != GVf_IMPORTED
4302 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4304 GvIMPORTED_on(dstr);
4312 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4314 if ((int)SvTYPE(sstr) != stype) {
4315 stype = SvTYPE(sstr);
4316 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4320 if (stype == SVt_PVLV)
4321 (void)SvUPGRADE(dstr, SVt_PVNV);
4323 (void)SvUPGRADE(dstr, (U32)stype);
4326 sflags = SvFLAGS(sstr);
4328 if (sflags & SVf_ROK) {
4329 if (dtype >= SVt_PV) {
4330 if (dtype == SVt_PVGV) {
4331 SV *sref = SvREFCNT_inc(SvRV(sstr));
4333 int intro = GvINTRO(dstr);
4335 #ifdef GV_UNIQUE_CHECK
4336 if (GvUNIQUE((GV*)dstr)) {
4337 Perl_croak(aTHX_ PL_no_modify);
4342 GvINTRO_off(dstr); /* one-shot flag */
4343 GvLINE(dstr) = CopLINE(PL_curcop);
4344 GvEGV(dstr) = (GV*)dstr;
4347 switch (SvTYPE(sref)) {
4350 SAVEGENERICSV(GvAV(dstr));
4352 dref = (SV*)GvAV(dstr);
4353 GvAV(dstr) = (AV*)sref;
4354 if (!GvIMPORTED_AV(dstr)
4355 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4357 GvIMPORTED_AV_on(dstr);
4362 SAVEGENERICSV(GvHV(dstr));
4364 dref = (SV*)GvHV(dstr);
4365 GvHV(dstr) = (HV*)sref;
4366 if (!GvIMPORTED_HV(dstr)
4367 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4369 GvIMPORTED_HV_on(dstr);
4374 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4375 SvREFCNT_dec(GvCV(dstr));
4376 GvCV(dstr) = Nullcv;
4377 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4378 PL_sub_generation++;
4380 SAVEGENERICSV(GvCV(dstr));
4383 dref = (SV*)GvCV(dstr);
4384 if (GvCV(dstr) != (CV*)sref) {
4385 CV* cv = GvCV(dstr);
4387 if (!GvCVGEN((GV*)dstr) &&
4388 (CvROOT(cv) || CvXSUB(cv)))
4390 /* ahem, death to those who redefine
4391 * active sort subs */
4392 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4393 PL_sortcop == CvSTART(cv))
4395 "Can't redefine active sort subroutine %s",
4396 GvENAME((GV*)dstr));
4397 /* Redefining a sub - warning is mandatory if
4398 it was a const and its value changed. */
4399 if (ckWARN(WARN_REDEFINE)
4401 && (!CvCONST((CV*)sref)
4402 || sv_cmp(cv_const_sv(cv),
4403 cv_const_sv((CV*)sref)))))
4405 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4407 ? "Constant subroutine %s::%s redefined"
4408 : "Subroutine %s::%s redefined",
4409 HvNAME(GvSTASH((GV*)dstr)),
4410 GvENAME((GV*)dstr));
4414 cv_ckproto(cv, (GV*)dstr,
4415 SvPOK(sref) ? SvPVX(sref) : Nullch);
4417 GvCV(dstr) = (CV*)sref;
4418 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4419 GvASSUMECV_on(dstr);
4420 PL_sub_generation++;
4422 if (!GvIMPORTED_CV(dstr)
4423 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4425 GvIMPORTED_CV_on(dstr);
4430 SAVEGENERICSV(GvIOp(dstr));
4432 dref = (SV*)GvIOp(dstr);
4433 GvIOp(dstr) = (IO*)sref;
4437 SAVEGENERICSV(GvFORM(dstr));
4439 dref = (SV*)GvFORM(dstr);
4440 GvFORM(dstr) = (CV*)sref;
4444 SAVEGENERICSV(GvSV(dstr));
4446 dref = (SV*)GvSV(dstr);
4448 if (!GvIMPORTED_SV(dstr)
4449 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4451 GvIMPORTED_SV_on(dstr);
4457 if (SvTAINTED(sstr))
4462 (void)SvOOK_off(dstr); /* backoff */
4464 Safefree(SvPVX(dstr));
4465 SvLEN(dstr)=SvCUR(dstr)=0;
4468 (void)SvOK_off(dstr);
4469 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4471 if (sflags & SVp_NOK) {
4473 /* Only set the public OK flag if the source has public OK. */
4474 if (sflags & SVf_NOK)
4475 SvFLAGS(dstr) |= SVf_NOK;
4476 SvNVX(dstr) = SvNVX(sstr);
4478 if (sflags & SVp_IOK) {
4479 (void)SvIOKp_on(dstr);
4480 if (sflags & SVf_IOK)
4481 SvFLAGS(dstr) |= SVf_IOK;
4482 if (sflags & SVf_IVisUV)
4484 SvIVX(dstr) = SvIVX(sstr);
4486 if (SvAMAGIC(sstr)) {
4490 else if (sflags & SVp_POK) {
4494 * Check to see if we can just swipe the string. If so, it's a
4495 * possible small lose on short strings, but a big win on long ones.
4496 * It might even be a win on short strings if SvPVX(dstr)
4497 * has to be allocated and SvPVX(sstr) has to be freed.
4500 /* Whichever path we take through the next code, we want this true,
4501 and doing it now facilitates the COW check. */
4502 (void)SvPOK_only(dstr);
4505 #ifdef PERL_COPY_ON_WRITE
4506 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4510 (sflags & SVs_TEMP) && /* slated for free anyway? */
4511 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4512 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4513 SvLEN(sstr) && /* and really is a string */
4514 /* and won't be needed again, potentially */
4515 !(PL_op && PL_op->op_type == OP_AASSIGN))
4516 #ifdef PERL_COPY_ON_WRITE
4517 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4518 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4519 && SvTYPE(sstr) >= SVt_PVIV)
4522 /* Failed the swipe test, and it's not a shared hash key either.
4523 Have to copy the string. */
4524 STRLEN len = SvCUR(sstr);
4525 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4526 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4527 SvCUR_set(dstr, len);
4528 *SvEND(dstr) = '\0';
4530 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4532 #ifdef PERL_COPY_ON_WRITE
4533 /* Either it's a shared hash key, or it's suitable for
4534 copy-on-write or we can swipe the string. */
4536 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4541 /* I believe I should acquire a global SV mutex if
4542 it's a COW sv (not a shared hash key) to stop
4543 it going un copy-on-write.
4544 If the source SV has gone un copy on write between up there
4545 and down here, then (assert() that) it is of the correct
4546 form to make it copy on write again */
4547 if ((sflags & (SVf_FAKE | SVf_READONLY))
4548 != (SVf_FAKE | SVf_READONLY)) {
4549 SvREADONLY_on(sstr);
4551 /* Make the source SV into a loop of 1.
4552 (about to become 2) */
4553 SV_COW_NEXT_SV_SET(sstr, sstr);
4557 /* Initial code is common. */
4558 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4560 SvFLAGS(dstr) &= ~SVf_OOK;
4561 Safefree(SvPVX(dstr) - SvIVX(dstr));
4563 else if (SvLEN(dstr))
4564 Safefree(SvPVX(dstr));
4567 #ifdef PERL_COPY_ON_WRITE
4569 /* making another shared SV. */
4570 STRLEN cur = SvCUR(sstr);
4571 STRLEN len = SvLEN(sstr);
4572 assert (SvTYPE(dstr) >= SVt_PVIV);
4574 /* SvIsCOW_normal */
4575 /* splice us in between source and next-after-source. */
4576 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4577 SV_COW_NEXT_SV_SET(sstr, dstr);
4578 SvPV_set(dstr, SvPVX(sstr));
4580 /* SvIsCOW_shared_hash */
4581 UV hash = SvUVX(sstr);
4582 DEBUG_C(PerlIO_printf(Perl_debug_log,
4583 "Copy on write: Sharing hash\n"));
4585 sharepvn(SvPVX(sstr),
4586 (sflags & SVf_UTF8?-cur:cur), hash));
4591 SvREADONLY_on(dstr);
4593 /* Relesase a global SV mutex. */
4597 { /* Passes the swipe test. */
4598 SvPV_set(dstr, SvPVX(sstr));
4599 SvLEN_set(dstr, SvLEN(sstr));
4600 SvCUR_set(dstr, SvCUR(sstr));
4603 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4604 SvPV_set(sstr, Nullch);
4610 if (sflags & SVf_UTF8)
4613 if (sflags & SVp_NOK) {
4615 if (sflags & SVf_NOK)
4616 SvFLAGS(dstr) |= SVf_NOK;
4617 SvNVX(dstr) = SvNVX(sstr);
4619 if (sflags & SVp_IOK) {
4620 (void)SvIOKp_on(dstr);
4621 if (sflags & SVf_IOK)
4622 SvFLAGS(dstr) |= SVf_IOK;
4623 if (sflags & SVf_IVisUV)
4625 SvIVX(dstr) = SvIVX(sstr);
4628 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4629 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4630 smg->mg_ptr, smg->mg_len);
4631 SvRMAGICAL_on(dstr);
4634 else if (sflags & SVp_IOK) {
4635 if (sflags & SVf_IOK)
4636 (void)SvIOK_only(dstr);
4638 (void)SvOK_off(dstr);
4639 (void)SvIOKp_on(dstr);
4641 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4642 if (sflags & SVf_IVisUV)
4644 SvIVX(dstr) = SvIVX(sstr);
4645 if (sflags & SVp_NOK) {
4646 if (sflags & SVf_NOK)
4647 (void)SvNOK_on(dstr);
4649 (void)SvNOKp_on(dstr);
4650 SvNVX(dstr) = SvNVX(sstr);
4653 else if (sflags & SVp_NOK) {
4654 if (sflags & SVf_NOK)
4655 (void)SvNOK_only(dstr);
4657 (void)SvOK_off(dstr);
4660 SvNVX(dstr) = SvNVX(sstr);
4663 if (dtype == SVt_PVGV) {
4664 if (ckWARN(WARN_MISC))
4665 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4668 (void)SvOK_off(dstr);
4670 if (SvTAINTED(sstr))
4675 =for apidoc sv_setsv_mg
4677 Like C<sv_setsv>, but also handles 'set' magic.
4683 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4685 sv_setsv(dstr,sstr);
4689 #ifdef PERL_COPY_ON_WRITE
4691 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4693 STRLEN cur = SvCUR(sstr);
4694 STRLEN len = SvLEN(sstr);
4695 register char *new_pv;
4698 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4706 if (SvTHINKFIRST(dstr))
4707 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4708 else if (SvPVX(dstr))
4709 Safefree(SvPVX(dstr));
4713 (void)SvUPGRADE (dstr, SVt_PVIV);
4715 assert (SvPOK(sstr));
4716 assert (SvPOKp(sstr));
4717 assert (!SvIOK(sstr));
4718 assert (!SvIOKp(sstr));
4719 assert (!SvNOK(sstr));
4720 assert (!SvNOKp(sstr));
4722 if (SvIsCOW(sstr)) {
4724 if (SvLEN(sstr) == 0) {
4725 /* source is a COW shared hash key. */
4726 UV hash = SvUVX(sstr);
4727 DEBUG_C(PerlIO_printf(Perl_debug_log,
4728 "Fast copy on write: Sharing hash\n"));
4730 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4733 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4735 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4736 (void)SvUPGRADE (sstr, SVt_PVIV);
4737 SvREADONLY_on(sstr);
4739 DEBUG_C(PerlIO_printf(Perl_debug_log,
4740 "Fast copy on write: Converting sstr to COW\n"));
4741 SV_COW_NEXT_SV_SET(dstr, sstr);
4743 SV_COW_NEXT_SV_SET(sstr, dstr);
4744 new_pv = SvPVX(sstr);
4747 SvPV_set(dstr, new_pv);
4748 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4761 =for apidoc sv_setpvn
4763 Copies a string into an SV. The C<len> parameter indicates the number of
4764 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4770 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4772 register char *dptr;
4774 SV_CHECK_THINKFIRST_COW_DROP(sv);
4780 /* len is STRLEN which is unsigned, need to copy to signed */
4783 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4785 (void)SvUPGRADE(sv, SVt_PV);
4787 SvGROW(sv, len + 1);
4789 Move(ptr,dptr,len,char);
4792 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4797 =for apidoc sv_setpvn_mg
4799 Like C<sv_setpvn>, but also handles 'set' magic.
4805 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4807 sv_setpvn(sv,ptr,len);
4812 =for apidoc sv_setpv
4814 Copies a string into an SV. The string must be null-terminated. Does not
4815 handle 'set' magic. See C<sv_setpv_mg>.
4821 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4823 register STRLEN len;
4825 SV_CHECK_THINKFIRST_COW_DROP(sv);
4831 (void)SvUPGRADE(sv, SVt_PV);
4833 SvGROW(sv, len + 1);
4834 Move(ptr,SvPVX(sv),len+1,char);
4836 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4841 =for apidoc sv_setpv_mg
4843 Like C<sv_setpv>, but also handles 'set' magic.
4849 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4856 =for apidoc sv_usepvn
4858 Tells an SV to use C<ptr> to find its string value. Normally the string is
4859 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4860 The C<ptr> should point to memory that was allocated by C<malloc>. The
4861 string length, C<len>, must be supplied. This function will realloc the
4862 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4863 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4864 See C<sv_usepvn_mg>.
4870 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4872 SV_CHECK_THINKFIRST_COW_DROP(sv);
4873 (void)SvUPGRADE(sv, SVt_PV);
4878 (void)SvOOK_off(sv);
4879 if (SvPVX(sv) && SvLEN(sv))
4880 Safefree(SvPVX(sv));
4881 Renew(ptr, len+1, char);
4884 SvLEN_set(sv, len+1);
4886 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4891 =for apidoc sv_usepvn_mg
4893 Like C<sv_usepvn>, but also handles 'set' magic.
4899 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4901 sv_usepvn(sv,ptr,len);
4905 #ifdef PERL_COPY_ON_WRITE
4906 /* Need to do this *after* making the SV normal, as we need the buffer
4907 pointer to remain valid until after we've copied it. If we let go too early,
4908 another thread could invalidate it by unsharing last of the same hash key
4909 (which it can do by means other than releasing copy-on-write Svs)
4910 or by changing the other copy-on-write SVs in the loop. */
4912 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4913 U32 hash, SV *after)
4915 if (len) { /* this SV was SvIsCOW_normal(sv) */
4916 /* we need to find the SV pointing to us. */
4917 SV *current = SV_COW_NEXT_SV(after);
4919 if (current == sv) {
4920 /* The SV we point to points back to us (there were only two of us
4922 Hence other SV is no longer copy on write either. */
4924 SvREADONLY_off(after);
4926 /* We need to follow the pointers around the loop. */
4928 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4931 /* don't loop forever if the structure is bust, and we have
4932 a pointer into a closed loop. */
4933 assert (current != after);
4934 assert (SvPVX(current) == pvx);
4936 /* Make the SV before us point to the SV after us. */
4937 SV_COW_NEXT_SV_SET(current, after);
4940 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4945 Perl_sv_release_IVX(pTHX_ register SV *sv)
4948 sv_force_normal_flags(sv, 0);
4949 return SvOOK_off(sv);
4953 =for apidoc sv_force_normal_flags
4955 Undo various types of fakery on an SV: if the PV is a shared string, make
4956 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4957 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4958 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4959 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4960 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4961 set to some other value.) In addition, the C<flags> parameter gets passed to
4962 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4963 with flags set to 0.
4969 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4971 #ifdef PERL_COPY_ON_WRITE
4972 if (SvREADONLY(sv)) {
4973 /* At this point I believe I should acquire a global SV mutex. */
4975 char *pvx = SvPVX(sv);
4976 STRLEN len = SvLEN(sv);
4977 STRLEN cur = SvCUR(sv);
4978 U32 hash = SvUVX(sv);
4979 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4981 PerlIO_printf(Perl_debug_log,
4982 "Copy on write: Force normal %ld\n",
4988 /* This SV doesn't own the buffer, so need to New() a new one: */
4991 if (flags & SV_COW_DROP_PV) {
4992 /* OK, so we don't need to copy our buffer. */
4995 SvGROW(sv, cur + 1);
4996 Move(pvx,SvPVX(sv),cur,char);
5000 sv_release_COW(sv, pvx, cur, len, hash, next);
5005 else if (IN_PERL_RUNTIME)
5006 Perl_croak(aTHX_ PL_no_modify);
5007 /* At this point I believe that I can drop the global SV mutex. */
5010 if (SvREADONLY(sv)) {
5012 char *pvx = SvPVX(sv);
5013 int is_utf8 = SvUTF8(sv);
5014 STRLEN len = SvCUR(sv);
5015 U32 hash = SvUVX(sv);
5020 SvGROW(sv, len + 1);
5021 Move(pvx,SvPVX(sv),len,char);
5023 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5025 else if (IN_PERL_RUNTIME)
5026 Perl_croak(aTHX_ PL_no_modify);
5030 sv_unref_flags(sv, flags);
5031 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5036 =for apidoc sv_force_normal
5038 Undo various types of fakery on an SV: if the PV is a shared string, make
5039 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5040 an xpvmg. See also C<sv_force_normal_flags>.
5046 Perl_sv_force_normal(pTHX_ register SV *sv)
5048 sv_force_normal_flags(sv, 0);
5054 Efficient removal of characters from the beginning of the string buffer.
5055 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5056 the string buffer. The C<ptr> becomes the first character of the adjusted
5057 string. Uses the "OOK hack".
5058 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5059 refer to the same chunk of data.
5065 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5067 register STRLEN delta;
5068 if (!ptr || !SvPOKp(sv))
5070 delta = ptr - SvPVX(sv);
5071 SV_CHECK_THINKFIRST(sv);
5072 if (SvTYPE(sv) < SVt_PVIV)
5073 sv_upgrade(sv,SVt_PVIV);
5076 if (!SvLEN(sv)) { /* make copy of shared string */
5077 char *pvx = SvPVX(sv);
5078 STRLEN len = SvCUR(sv);
5079 SvGROW(sv, len + 1);
5080 Move(pvx,SvPVX(sv),len,char);
5084 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5085 and we do that anyway inside the SvNIOK_off
5087 SvFLAGS(sv) |= SVf_OOK;
5096 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5097 * this function provided for binary compatibility only
5101 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5103 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5107 =for apidoc sv_catpvn
5109 Concatenates the string onto the end of the string which is in the SV. The
5110 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5111 status set, then the bytes appended should be valid UTF-8.
5112 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5114 =for apidoc sv_catpvn_flags
5116 Concatenates the string onto the end of the string which is in the SV. The
5117 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5118 status set, then the bytes appended should be valid UTF-8.
5119 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5120 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5121 in terms of this function.
5127 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5132 dstr = SvPV_force_flags(dsv, dlen, flags);
5133 SvGROW(dsv, dlen + slen + 1);
5136 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5139 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5144 =for apidoc sv_catpvn_mg
5146 Like C<sv_catpvn>, but also handles 'set' magic.
5152 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5154 sv_catpvn(sv,ptr,len);
5158 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5159 * this function provided for binary compatibility only
5163 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5165 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5169 =for apidoc sv_catsv
5171 Concatenates the string from SV C<ssv> onto the end of the string in
5172 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5173 not 'set' magic. See C<sv_catsv_mg>.
5175 =for apidoc sv_catsv_flags
5177 Concatenates the string from SV C<ssv> onto the end of the string in
5178 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5179 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5180 and C<sv_catsv_nomg> are implemented in terms of this function.
5185 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5191 if ((spv = SvPV(ssv, slen))) {
5192 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5193 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5194 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5195 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5196 dsv->sv_flags doesn't have that bit set.
5197 Andy Dougherty 12 Oct 2001
5199 I32 sutf8 = DO_UTF8(ssv);
5202 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5204 dutf8 = DO_UTF8(dsv);
5206 if (dutf8 != sutf8) {
5208 /* Not modifying source SV, so taking a temporary copy. */
5209 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5211 sv_utf8_upgrade(csv);
5212 spv = SvPV(csv, slen);
5215 sv_utf8_upgrade_nomg(dsv);
5217 sv_catpvn_nomg(dsv, spv, slen);
5222 =for apidoc sv_catsv_mg
5224 Like C<sv_catsv>, but also handles 'set' magic.
5230 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5237 =for apidoc sv_catpv
5239 Concatenates the string onto the end of the string which is in the SV.
5240 If the SV has the UTF-8 status set, then the bytes appended should be
5241 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5246 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5248 register STRLEN len;
5254 junk = SvPV_force(sv, tlen);
5256 SvGROW(sv, tlen + len + 1);
5259 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5261 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5266 =for apidoc sv_catpv_mg
5268 Like C<sv_catpv>, but also handles 'set' magic.
5274 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5283 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5284 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5291 Perl_newSV(pTHX_ STRLEN len)
5297 sv_upgrade(sv, SVt_PV);
5298 SvGROW(sv, len + 1);
5303 =for apidoc sv_magicext
5305 Adds magic to an SV, upgrading it if necessary. Applies the
5306 supplied vtable and returns pointer to the magic added.
5308 Note that sv_magicext will allow things that sv_magic will not.
5309 In particular you can add magic to SvREADONLY SVs and and more than
5310 one instance of the same 'how'
5312 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
5313 if C<namelen> is zero then C<name> is stored as-is and - as another special
5314 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
5315 an C<SV*> and has its REFCNT incremented
5317 (This is now used as a subroutine by sv_magic.)
5322 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5323 const char* name, I32 namlen)
5327 if (SvTYPE(sv) < SVt_PVMG) {
5328 (void)SvUPGRADE(sv, SVt_PVMG);
5330 Newz(702,mg, 1, MAGIC);
5331 mg->mg_moremagic = SvMAGIC(sv);
5334 /* Some magic sontains a reference loop, where the sv and object refer to
5335 each other. To prevent a reference loop that would prevent such
5336 objects being freed, we look for such loops and if we find one we
5337 avoid incrementing the object refcount.
5339 Note we cannot do this to avoid self-tie loops as intervening RV must
5340 have its REFCNT incremented to keep it in existence.
5343 if (!obj || obj == sv ||
5344 how == PERL_MAGIC_arylen ||
5345 how == PERL_MAGIC_qr ||
5346 (SvTYPE(obj) == SVt_PVGV &&
5347 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5348 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5349 GvFORM(obj) == (CV*)sv)))
5354 mg->mg_obj = SvREFCNT_inc(obj);
5355 mg->mg_flags |= MGf_REFCOUNTED;
5358 /* Normal self-ties simply pass a null object, and instead of
5359 using mg_obj directly, use the SvTIED_obj macro to produce a
5360 new RV as needed. For glob "self-ties", we are tieing the PVIO
5361 with an RV obj pointing to the glob containing the PVIO. In
5362 this case, to avoid a reference loop, we need to weaken the
5366 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5367 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5373 mg->mg_len = namlen;
5376 mg->mg_ptr = savepvn(name, namlen);
5377 else if (namlen == HEf_SVKEY)
5378 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5380 mg->mg_ptr = (char *) name;
5382 mg->mg_virtual = vtable;
5386 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5391 =for apidoc sv_magic
5393 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5394 then adds a new magic item of type C<how> to the head of the magic list.
5400 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5405 #ifdef PERL_COPY_ON_WRITE
5407 sv_force_normal_flags(sv, 0);
5409 if (SvREADONLY(sv)) {
5411 && how != PERL_MAGIC_regex_global
5412 && how != PERL_MAGIC_bm
5413 && how != PERL_MAGIC_fm
5414 && how != PERL_MAGIC_sv
5415 && how != PERL_MAGIC_backref
5418 Perl_croak(aTHX_ PL_no_modify);
5421 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5422 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5423 /* sv_magic() refuses to add a magic of the same 'how' as an
5426 if (how == PERL_MAGIC_taint)
5434 vtable = &PL_vtbl_sv;
5436 case PERL_MAGIC_overload:
5437 vtable = &PL_vtbl_amagic;
5439 case PERL_MAGIC_overload_elem:
5440 vtable = &PL_vtbl_amagicelem;
5442 case PERL_MAGIC_overload_table:
5443 vtable = &PL_vtbl_ovrld;
5446 vtable = &PL_vtbl_bm;
5448 case PERL_MAGIC_regdata:
5449 vtable = &PL_vtbl_regdata;
5451 case PERL_MAGIC_regdatum:
5452 vtable = &PL_vtbl_regdatum;
5454 case PERL_MAGIC_env:
5455 vtable = &PL_vtbl_env;
5458 vtable = &PL_vtbl_fm;
5460 case PERL_MAGIC_envelem:
5461 vtable = &PL_vtbl_envelem;
5463 case PERL_MAGIC_regex_global:
5464 vtable = &PL_vtbl_mglob;
5466 case PERL_MAGIC_isa:
5467 vtable = &PL_vtbl_isa;
5469 case PERL_MAGIC_isaelem:
5470 vtable = &PL_vtbl_isaelem;
5472 case PERL_MAGIC_nkeys:
5473 vtable = &PL_vtbl_nkeys;
5475 case PERL_MAGIC_dbfile:
5478 case PERL_MAGIC_dbline:
5479 vtable = &PL_vtbl_dbline;
5481 #ifdef USE_LOCALE_COLLATE
5482 case PERL_MAGIC_collxfrm:
5483 vtable = &PL_vtbl_collxfrm;
5485 #endif /* USE_LOCALE_COLLATE */
5486 case PERL_MAGIC_tied:
5487 vtable = &PL_vtbl_pack;
5489 case PERL_MAGIC_tiedelem:
5490 case PERL_MAGIC_tiedscalar:
5491 vtable = &PL_vtbl_packelem;
5494 vtable = &PL_vtbl_regexp;
5496 case PERL_MAGIC_sig:
5497 vtable = &PL_vtbl_sig;
5499 case PERL_MAGIC_sigelem:
5500 vtable = &PL_vtbl_sigelem;
5502 case PERL_MAGIC_taint:
5503 vtable = &PL_vtbl_taint;
5505 case PERL_MAGIC_uvar:
5506 vtable = &PL_vtbl_uvar;
5508 case PERL_MAGIC_vec:
5509 vtable = &PL_vtbl_vec;
5511 case PERL_MAGIC_vstring:
5514 case PERL_MAGIC_utf8:
5515 vtable = &PL_vtbl_utf8;
5517 case PERL_MAGIC_substr:
5518 vtable = &PL_vtbl_substr;
5520 case PERL_MAGIC_defelem:
5521 vtable = &PL_vtbl_defelem;
5523 case PERL_MAGIC_glob:
5524 vtable = &PL_vtbl_glob;
5526 case PERL_MAGIC_arylen:
5527 vtable = &PL_vtbl_arylen;
5529 case PERL_MAGIC_pos:
5530 vtable = &PL_vtbl_pos;
5532 case PERL_MAGIC_backref:
5533 vtable = &PL_vtbl_backref;
5535 case PERL_MAGIC_ext:
5536 /* Reserved for use by extensions not perl internals. */
5537 /* Useful for attaching extension internal data to perl vars. */
5538 /* Note that multiple extensions may clash if magical scalars */
5539 /* etc holding private data from one are passed to another. */
5542 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5545 /* Rest of work is done else where */
5546 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5549 case PERL_MAGIC_taint:
5552 case PERL_MAGIC_ext:
5553 case PERL_MAGIC_dbfile:
5560 =for apidoc sv_unmagic
5562 Removes all magic of type C<type> from an SV.
5568 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5572 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5575 for (mg = *mgp; mg; mg = *mgp) {
5576 if (mg->mg_type == type) {
5577 MGVTBL* vtbl = mg->mg_virtual;
5578 *mgp = mg->mg_moremagic;
5579 if (vtbl && vtbl->svt_free)
5580 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5581 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5583 Safefree(mg->mg_ptr);
5584 else if (mg->mg_len == HEf_SVKEY)
5585 SvREFCNT_dec((SV*)mg->mg_ptr);
5586 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5587 Safefree(mg->mg_ptr);
5589 if (mg->mg_flags & MGf_REFCOUNTED)
5590 SvREFCNT_dec(mg->mg_obj);
5594 mgp = &mg->mg_moremagic;
5598 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5605 =for apidoc sv_rvweaken
5607 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5608 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5609 push a back-reference to this RV onto the array of backreferences
5610 associated with that magic.
5616 Perl_sv_rvweaken(pTHX_ SV *sv)
5619 if (!SvOK(sv)) /* let undefs pass */
5622 Perl_croak(aTHX_ "Can't weaken a nonreference");
5623 else if (SvWEAKREF(sv)) {
5624 if (ckWARN(WARN_MISC))
5625 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5629 sv_add_backref(tsv, sv);
5635 /* Give tsv backref magic if it hasn't already got it, then push a
5636 * back-reference to sv onto the array associated with the backref magic.
5640 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5644 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5645 av = (AV*)mg->mg_obj;
5648 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5649 /* av now has a refcnt of 2, which avoids it getting freed
5650 * before us during global cleanup. The extra ref is removed
5651 * by magic_killbackrefs() when tsv is being freed */
5653 if (AvFILLp(av) >= AvMAX(av)) {
5655 SV **svp = AvARRAY(av);
5656 for (i = AvFILLp(av); i >= 0; i--)
5658 svp[i] = sv; /* reuse the slot */
5661 av_extend(av, AvFILLp(av)+1);
5663 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5666 /* delete a back-reference to ourselves from the backref magic associated
5667 * with the SV we point to.
5671 S_sv_del_backref(pTHX_ SV *sv)
5678 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5679 Perl_croak(aTHX_ "panic: del_backref");
5680 av = (AV *)mg->mg_obj;
5682 for (i = AvFILLp(av); i >= 0; i--)
5683 if (svp[i] == sv) svp[i] = Nullsv;
5687 =for apidoc sv_insert
5689 Inserts a string at the specified offset/length within the SV. Similar to
5690 the Perl substr() function.
5696 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5700 register char *midend;
5701 register char *bigend;
5707 Perl_croak(aTHX_ "Can't modify non-existent substring");
5708 SvPV_force(bigstr, curlen);
5709 (void)SvPOK_only_UTF8(bigstr);
5710 if (offset + len > curlen) {
5711 SvGROW(bigstr, offset+len+1);
5712 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5713 SvCUR_set(bigstr, offset+len);
5717 i = littlelen - len;
5718 if (i > 0) { /* string might grow */
5719 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5720 mid = big + offset + len;
5721 midend = bigend = big + SvCUR(bigstr);
5724 while (midend > mid) /* shove everything down */
5725 *--bigend = *--midend;
5726 Move(little,big+offset,littlelen,char);
5732 Move(little,SvPVX(bigstr)+offset,len,char);
5737 big = SvPVX(bigstr);
5740 bigend = big + SvCUR(bigstr);
5742 if (midend > bigend)
5743 Perl_croak(aTHX_ "panic: sv_insert");
5745 if (mid - big > bigend - midend) { /* faster to shorten from end */
5747 Move(little, mid, littlelen,char);
5750 i = bigend - midend;
5752 Move(midend, mid, i,char);
5756 SvCUR_set(bigstr, mid - big);
5759 else if ((i = mid - big)) { /* faster from front */
5760 midend -= littlelen;
5762 sv_chop(bigstr,midend-i);
5767 Move(little, mid, littlelen,char);
5769 else if (littlelen) {
5770 midend -= littlelen;
5771 sv_chop(bigstr,midend);
5772 Move(little,midend,littlelen,char);
5775 sv_chop(bigstr,midend);
5781 =for apidoc sv_replace
5783 Make the first argument a copy of the second, then delete the original.
5784 The target SV physically takes over ownership of the body of the source SV
5785 and inherits its flags; however, the target keeps any magic it owns,
5786 and any magic in the source is discarded.
5787 Note that this is a rather specialist SV copying operation; most of the
5788 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5794 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5796 U32 refcnt = SvREFCNT(sv);
5797 SV_CHECK_THINKFIRST_COW_DROP(sv);
5798 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5799 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5800 if (SvMAGICAL(sv)) {
5804 sv_upgrade(nsv, SVt_PVMG);
5805 SvMAGIC(nsv) = SvMAGIC(sv);
5806 SvFLAGS(nsv) |= SvMAGICAL(sv);
5812 assert(!SvREFCNT(sv));
5813 StructCopy(nsv,sv,SV);
5814 #ifdef PERL_COPY_ON_WRITE
5815 if (SvIsCOW_normal(nsv)) {
5816 /* We need to follow the pointers around the loop to make the
5817 previous SV point to sv, rather than nsv. */
5820 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5823 assert(SvPVX(current) == SvPVX(nsv));
5825 /* Make the SV before us point to the SV after us. */
5827 PerlIO_printf(Perl_debug_log, "previous is\n");
5829 PerlIO_printf(Perl_debug_log,
5830 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5831 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5833 SV_COW_NEXT_SV_SET(current, sv);
5836 SvREFCNT(sv) = refcnt;
5837 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5843 =for apidoc sv_clear
5845 Clear an SV: call any destructors, free up any memory used by the body,
5846 and free the body itself. The SV's head is I<not> freed, although
5847 its type is set to all 1's so that it won't inadvertently be assumed
5848 to be live during global destruction etc.
5849 This function should only be called when REFCNT is zero. Most of the time
5850 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5857 Perl_sv_clear(pTHX_ register SV *sv)
5861 assert(SvREFCNT(sv) == 0);
5864 if (PL_defstash) { /* Still have a symbol table? */
5871 stash = SvSTASH(sv);
5872 destructor = StashHANDLER(stash,DESTROY);
5874 SV* tmpref = newRV(sv);
5875 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5877 PUSHSTACKi(PERLSI_DESTROY);
5882 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5888 if(SvREFCNT(tmpref) < 2) {
5889 /* tmpref is not kept alive! */
5894 SvREFCNT_dec(tmpref);
5896 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5900 if (PL_in_clean_objs)
5901 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5903 /* DESTROY gave object new lease on life */
5909 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5910 SvOBJECT_off(sv); /* Curse the object. */
5911 if (SvTYPE(sv) != SVt_PVIO)
5912 --PL_sv_objcount; /* XXX Might want something more general */
5915 if (SvTYPE(sv) >= SVt_PVMG) {
5918 if (SvFLAGS(sv) & SVpad_TYPED)
5919 SvREFCNT_dec(SvSTASH(sv));
5922 switch (SvTYPE(sv)) {
5925 IoIFP(sv) != PerlIO_stdin() &&
5926 IoIFP(sv) != PerlIO_stdout() &&
5927 IoIFP(sv) != PerlIO_stderr())
5929 io_close((IO*)sv, FALSE);
5931 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5932 PerlDir_close(IoDIRP(sv));
5933 IoDIRP(sv) = (DIR*)NULL;
5934 Safefree(IoTOP_NAME(sv));
5935 Safefree(IoFMT_NAME(sv));
5936 Safefree(IoBOTTOM_NAME(sv));
5951 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5952 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5953 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5954 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5956 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5957 SvREFCNT_dec(LvTARG(sv));
5961 Safefree(GvNAME(sv));
5962 /* cannot decrease stash refcount yet, as we might recursively delete
5963 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5964 of stash until current sv is completely gone.
5965 -- JohnPC, 27 Mar 1998 */
5966 stash = GvSTASH(sv);
5972 (void)SvOOK_off(sv);
5980 SvREFCNT_dec(SvRV(sv));
5982 #ifdef PERL_COPY_ON_WRITE
5983 else if (SvPVX(sv)) {
5985 /* I believe I need to grab the global SV mutex here and
5986 then recheck the COW status. */
5988 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5991 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5992 SvUVX(sv), SV_COW_NEXT_SV(sv));
5993 /* And drop it here. */
5995 } else if (SvLEN(sv)) {
5996 Safefree(SvPVX(sv));
6000 else if (SvPVX(sv) && SvLEN(sv))
6001 Safefree(SvPVX(sv));
6002 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6003 unsharepvn(SvPVX(sv),
6004 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6018 switch (SvTYPE(sv)) {
6034 del_XPVIV(SvANY(sv));
6037 del_XPVNV(SvANY(sv));
6040 del_XPVMG(SvANY(sv));
6043 del_XPVLV(SvANY(sv));
6046 del_XPVAV(SvANY(sv));
6049 del_XPVHV(SvANY(sv));
6052 del_XPVCV(SvANY(sv));
6055 del_XPVGV(SvANY(sv));
6056 /* code duplication for increased performance. */
6057 SvFLAGS(sv) &= SVf_BREAK;
6058 SvFLAGS(sv) |= SVTYPEMASK;
6059 /* decrease refcount of the stash that owns this GV, if any */
6061 SvREFCNT_dec(stash);
6062 return; /* not break, SvFLAGS reset already happened */
6064 del_XPVBM(SvANY(sv));
6067 del_XPVFM(SvANY(sv));
6070 del_XPVIO(SvANY(sv));
6073 SvFLAGS(sv) &= SVf_BREAK;
6074 SvFLAGS(sv) |= SVTYPEMASK;
6078 =for apidoc sv_newref
6080 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6087 Perl_sv_newref(pTHX_ SV *sv)
6097 Decrement an SV's reference count, and if it drops to zero, call
6098 C<sv_clear> to invoke destructors and free up any memory used by
6099 the body; finally, deallocate the SV's head itself.
6100 Normally called via a wrapper macro C<SvREFCNT_dec>.
6106 Perl_sv_free(pTHX_ SV *sv)
6110 if (SvREFCNT(sv) == 0) {
6111 if (SvFLAGS(sv) & SVf_BREAK)
6112 /* this SV's refcnt has been artificially decremented to
6113 * trigger cleanup */
6115 if (PL_in_clean_all) /* All is fair */
6117 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6118 /* make sure SvREFCNT(sv)==0 happens very seldom */
6119 SvREFCNT(sv) = (~(U32)0)/2;
6122 if (ckWARN_d(WARN_INTERNAL))
6123 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6124 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6125 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6128 if (--(SvREFCNT(sv)) > 0)
6130 Perl_sv_free2(aTHX_ sv);
6134 Perl_sv_free2(pTHX_ SV *sv)
6138 if (ckWARN_d(WARN_DEBUGGING))
6139 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6140 "Attempt to free temp prematurely: SV 0x%"UVxf
6141 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6145 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6146 /* make sure SvREFCNT(sv)==0 happens very seldom */
6147 SvREFCNT(sv) = (~(U32)0)/2;
6158 Returns the length of the string in the SV. Handles magic and type
6159 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6165 Perl_sv_len(pTHX_ register SV *sv)
6173 len = mg_length(sv);
6175 (void)SvPV(sv, len);
6180 =for apidoc sv_len_utf8
6182 Returns the number of characters in the string in an SV, counting wide
6183 UTF-8 bytes as a single character. Handles magic and type coercion.
6189 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6190 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6191 * (Note that the mg_len is not the length of the mg_ptr field.)
6196 Perl_sv_len_utf8(pTHX_ register SV *sv)
6202 return mg_length(sv);
6206 U8 *s = (U8*)SvPV(sv, len);
6207 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6209 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6211 #ifdef PERL_UTF8_CACHE_ASSERT
6212 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6216 ulen = Perl_utf8_length(aTHX_ s, s + len);
6217 if (!mg && !SvREADONLY(sv)) {
6218 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6219 mg = mg_find(sv, PERL_MAGIC_utf8);
6229 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6230 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6231 * between UTF-8 and byte offsets. There are two (substr offset and substr
6232 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6233 * and byte offset) cache positions.
6235 * The mg_len field is used by sv_len_utf8(), see its comments.
6236 * Note that the mg_len is not the length of the mg_ptr field.
6240 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6244 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6246 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6250 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6252 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6253 (*mgp)->mg_ptr = (char *) *cachep;
6257 (*cachep)[i] = *offsetp;
6258 (*cachep)[i+1] = s - start;
6266 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6267 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6268 * between UTF-8 and byte offsets. See also the comments of
6269 * S_utf8_mg_pos_init().
6273 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6277 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6279 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6280 if (*mgp && (*mgp)->mg_ptr) {
6281 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6282 ASSERT_UTF8_CACHE(*cachep);
6283 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6285 else { /* We will skip to the right spot. */
6290 /* The assumption is that going backward is half
6291 * the speed of going forward (that's where the
6292 * 2 * backw in the below comes from). (The real
6293 * figure of course depends on the UTF-8 data.) */
6295 if ((*cachep)[i] > (STRLEN)uoff) {
6297 backw = (*cachep)[i] - (STRLEN)uoff;
6299 if (forw < 2 * backw)
6302 p = start + (*cachep)[i+1];
6304 /* Try this only for the substr offset (i == 0),
6305 * not for the substr length (i == 2). */
6306 else if (i == 0) { /* (*cachep)[i] < uoff */
6307 STRLEN ulen = sv_len_utf8(sv);
6309 if ((STRLEN)uoff < ulen) {
6310 forw = (STRLEN)uoff - (*cachep)[i];
6311 backw = ulen - (STRLEN)uoff;
6313 if (forw < 2 * backw)
6314 p = start + (*cachep)[i+1];
6319 /* If the string is not long enough for uoff,
6320 * we could extend it, but not at this low a level. */
6324 if (forw < 2 * backw) {
6331 while (UTF8_IS_CONTINUATION(*p))
6336 /* Update the cache. */
6337 (*cachep)[i] = (STRLEN)uoff;
6338 (*cachep)[i+1] = p - start;
6340 /* Drop the stale "length" cache */
6349 if (found) { /* Setup the return values. */
6350 *offsetp = (*cachep)[i+1];
6351 *sp = start + *offsetp;
6354 *offsetp = send - start;
6356 else if (*sp < start) {
6362 #ifdef PERL_UTF8_CACHE_ASSERT
6367 while (n-- && s < send)
6371 assert(*offsetp == s - start);
6372 assert((*cachep)[0] == (STRLEN)uoff);
6373 assert((*cachep)[1] == *offsetp);
6375 ASSERT_UTF8_CACHE(*cachep);
6384 =for apidoc sv_pos_u2b
6386 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6387 the start of the string, to a count of the equivalent number of bytes; if
6388 lenp is non-zero, it does the same to lenp, but this time starting from
6389 the offset, rather than from the start of the string. Handles magic and
6396 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6397 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6398 * byte offsets. See also the comments of S_utf8_mg_pos().
6403 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6414 start = s = (U8*)SvPV(sv, len);
6416 I32 uoffset = *offsetp;
6421 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6423 if (!found && uoffset > 0) {
6424 while (s < send && uoffset--)
6428 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6430 *offsetp = s - start;
6435 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6439 if (!found && *lenp > 0) {
6442 while (s < send && ulen--)
6446 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6450 ASSERT_UTF8_CACHE(cache);
6462 =for apidoc sv_pos_b2u
6464 Converts the value pointed to by offsetp from a count of bytes from the
6465 start of the string, to a count of the equivalent number of UTF-8 chars.
6466 Handles magic and type coercion.
6472 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6473 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6474 * byte offsets. See also the comments of S_utf8_mg_pos().
6479 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6487 s = (U8*)SvPV(sv, len);
6488 if ((I32)len < *offsetp)
6489 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6491 U8* send = s + *offsetp;
6493 STRLEN *cache = NULL;
6497 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6498 mg = mg_find(sv, PERL_MAGIC_utf8);
6499 if (mg && mg->mg_ptr) {
6500 cache = (STRLEN *) mg->mg_ptr;
6501 if (cache[1] == (STRLEN)*offsetp) {
6502 /* An exact match. */
6503 *offsetp = cache[0];
6507 else if (cache[1] < (STRLEN)*offsetp) {
6508 /* We already know part of the way. */
6511 /* Let the below loop do the rest. */
6513 else { /* cache[1] > *offsetp */
6514 /* We already know all of the way, now we may
6515 * be able to walk back. The same assumption
6516 * is made as in S_utf8_mg_pos(), namely that
6517 * walking backward is twice slower than
6518 * walking forward. */
6519 STRLEN forw = *offsetp;
6520 STRLEN backw = cache[1] - *offsetp;
6522 if (!(forw < 2 * backw)) {
6523 U8 *p = s + cache[1];
6530 while (UTF8_IS_CONTINUATION(*p)) {
6538 *offsetp = cache[0];
6540 /* Drop the stale "length" cache */
6548 ASSERT_UTF8_CACHE(cache);
6554 /* Call utf8n_to_uvchr() to validate the sequence
6555 * (unless a simple non-UTF character) */
6556 if (!UTF8_IS_INVARIANT(*s))
6557 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6566 if (!SvREADONLY(sv)) {
6568 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6569 mg = mg_find(sv, PERL_MAGIC_utf8);
6574 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6575 mg->mg_ptr = (char *) cache;
6580 cache[1] = *offsetp;
6581 /* Drop the stale "length" cache */
6594 Returns a boolean indicating whether the strings in the two SVs are
6595 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6596 coerce its args to strings if necessary.
6602 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6610 SV* svrecode = Nullsv;
6617 pv1 = SvPV(sv1, cur1);
6624 pv2 = SvPV(sv2, cur2);
6626 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6627 /* Differing utf8ness.
6628 * Do not UTF8size the comparands as a side-effect. */
6631 svrecode = newSVpvn(pv2, cur2);
6632 sv_recode_to_utf8(svrecode, PL_encoding);
6633 pv2 = SvPV(svrecode, cur2);
6636 svrecode = newSVpvn(pv1, cur1);
6637 sv_recode_to_utf8(svrecode, PL_encoding);
6638 pv1 = SvPV(svrecode, cur1);
6640 /* Now both are in UTF-8. */
6645 bool is_utf8 = TRUE;
6648 /* sv1 is the UTF-8 one,
6649 * if is equal it must be downgrade-able */
6650 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6656 /* sv2 is the UTF-8 one,
6657 * if is equal it must be downgrade-able */
6658 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6664 /* Downgrade not possible - cannot be eq */
6671 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6674 SvREFCNT_dec(svrecode);
6685 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6686 string in C<sv1> is less than, equal to, or greater than the string in
6687 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6688 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6694 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6697 char *pv1, *pv2, *tpv = Nullch;
6699 SV *svrecode = Nullsv;
6706 pv1 = SvPV(sv1, cur1);
6713 pv2 = SvPV(sv2, cur2);
6715 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6716 /* Differing utf8ness.
6717 * Do not UTF8size the comparands as a side-effect. */
6720 svrecode = newSVpvn(pv2, cur2);
6721 sv_recode_to_utf8(svrecode, PL_encoding);
6722 pv2 = SvPV(svrecode, cur2);
6725 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6730 svrecode = newSVpvn(pv1, cur1);
6731 sv_recode_to_utf8(svrecode, PL_encoding);
6732 pv1 = SvPV(svrecode, cur1);
6735 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6741 cmp = cur2 ? -1 : 0;
6745 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6748 cmp = retval < 0 ? -1 : 1;
6749 } else if (cur1 == cur2) {
6752 cmp = cur1 < cur2 ? -1 : 1;
6757 SvREFCNT_dec(svrecode);
6766 =for apidoc sv_cmp_locale
6768 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6769 'use bytes' aware, handles get magic, and will coerce its args to strings
6770 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6776 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6778 #ifdef USE_LOCALE_COLLATE
6784 if (PL_collation_standard)
6788 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6790 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6792 if (!pv1 || !len1) {
6803 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6806 return retval < 0 ? -1 : 1;
6809 * When the result of collation is equality, that doesn't mean
6810 * that there are no differences -- some locales exclude some
6811 * characters from consideration. So to avoid false equalities,
6812 * we use the raw string as a tiebreaker.
6818 #endif /* USE_LOCALE_COLLATE */
6820 return sv_cmp(sv1, sv2);
6824 #ifdef USE_LOCALE_COLLATE
6827 =for apidoc sv_collxfrm
6829 Add Collate Transform magic to an SV if it doesn't already have it.
6831 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6832 scalar data of the variable, but transformed to such a format that a normal
6833 memory comparison can be used to compare the data according to the locale
6840 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6844 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6845 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6850 Safefree(mg->mg_ptr);
6852 if ((xf = mem_collxfrm(s, len, &xlen))) {
6853 if (SvREADONLY(sv)) {
6856 return xf + sizeof(PL_collation_ix);
6859 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6860 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6873 if (mg && mg->mg_ptr) {
6875 return mg->mg_ptr + sizeof(PL_collation_ix);
6883 #endif /* USE_LOCALE_COLLATE */
6888 Get a line from the filehandle and store it into the SV, optionally
6889 appending to the currently-stored string.
6895 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6899 register STDCHAR rslast;
6900 register STDCHAR *bp;
6906 if (SvTHINKFIRST(sv))
6907 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6908 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6910 However, perlbench says it's slower, because the existing swipe code
6911 is faster than copy on write.
6912 Swings and roundabouts. */
6913 (void)SvUPGRADE(sv, SVt_PV);
6918 if (PerlIO_isutf8(fp)) {
6920 sv_utf8_upgrade_nomg(sv);
6921 sv_pos_u2b(sv,&append,0);
6923 } else if (SvUTF8(sv)) {
6924 SV *tsv = NEWSV(0,0);
6925 sv_gets(tsv, fp, 0);
6926 sv_utf8_upgrade_nomg(tsv);
6927 SvCUR_set(sv,append);
6930 goto return_string_or_null;
6935 if (PerlIO_isutf8(fp))
6938 if (IN_PERL_COMPILETIME) {
6939 /* we always read code in line mode */
6943 else if (RsSNARF(PL_rs)) {
6944 /* If it is a regular disk file use size from stat() as estimate
6945 of amount we are going to read - may result in malloc-ing
6946 more memory than we realy need if layers bellow reduce
6947 size we read (e.g. CRLF or a gzip layer)
6950 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6951 Off_t offset = PerlIO_tell(fp);
6952 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6953 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6959 else if (RsRECORD(PL_rs)) {
6963 /* Grab the size of the record we're getting */
6964 recsize = SvIV(SvRV(PL_rs));
6965 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6968 /* VMS wants read instead of fread, because fread doesn't respect */
6969 /* RMS record boundaries. This is not necessarily a good thing to be */
6970 /* doing, but we've got no other real choice - except avoid stdio
6971 as implementation - perhaps write a :vms layer ?
6973 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6975 bytesread = PerlIO_read(fp, buffer, recsize);
6979 SvCUR_set(sv, bytesread += append);
6980 buffer[bytesread] = '\0';
6981 goto return_string_or_null;
6983 else if (RsPARA(PL_rs)) {
6989 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6990 if (PerlIO_isutf8(fp)) {
6991 rsptr = SvPVutf8(PL_rs, rslen);
6994 if (SvUTF8(PL_rs)) {
6995 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6996 Perl_croak(aTHX_ "Wide character in $/");
6999 rsptr = SvPV(PL_rs, rslen);
7003 rslast = rslen ? rsptr[rslen - 1] : '\0';
7005 if (rspara) { /* have to do this both before and after */
7006 do { /* to make sure file boundaries work right */
7009 i = PerlIO_getc(fp);
7013 PerlIO_ungetc(fp,i);
7019 /* See if we know enough about I/O mechanism to cheat it ! */
7021 /* This used to be #ifdef test - it is made run-time test for ease
7022 of abstracting out stdio interface. One call should be cheap
7023 enough here - and may even be a macro allowing compile
7027 if (PerlIO_fast_gets(fp)) {
7030 * We're going to steal some values from the stdio struct
7031 * and put EVERYTHING in the innermost loop into registers.
7033 register STDCHAR *ptr;
7037 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7038 /* An ungetc()d char is handled separately from the regular
7039 * buffer, so we getc() it back out and stuff it in the buffer.
7041 i = PerlIO_getc(fp);
7042 if (i == EOF) return 0;
7043 *(--((*fp)->_ptr)) = (unsigned char) i;
7047 /* Here is some breathtakingly efficient cheating */
7049 cnt = PerlIO_get_cnt(fp); /* get count into register */
7050 /* make sure we have the room */
7051 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7052 /* Not room for all of it
7053 if we are looking for a separator and room for some
7055 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7056 /* just process what we have room for */
7057 shortbuffered = cnt - SvLEN(sv) + append + 1;
7058 cnt -= shortbuffered;
7062 /* remember that cnt can be negative */
7063 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7068 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7069 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7070 DEBUG_P(PerlIO_printf(Perl_debug_log,
7071 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7072 DEBUG_P(PerlIO_printf(Perl_debug_log,
7073 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7074 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7075 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7080 while (cnt > 0) { /* this | eat */
7082 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7083 goto thats_all_folks; /* screams | sed :-) */
7087 Copy(ptr, bp, cnt, char); /* this | eat */
7088 bp += cnt; /* screams | dust */
7089 ptr += cnt; /* louder | sed :-) */
7094 if (shortbuffered) { /* oh well, must extend */
7095 cnt = shortbuffered;
7097 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7099 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7100 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7104 DEBUG_P(PerlIO_printf(Perl_debug_log,
7105 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7106 PTR2UV(ptr),(long)cnt));
7107 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7109 DEBUG_P(PerlIO_printf(Perl_debug_log,
7110 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7111 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7112 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7114 /* This used to call 'filbuf' in stdio form, but as that behaves like
7115 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7116 another abstraction. */
7117 i = PerlIO_getc(fp); /* get more characters */
7119 DEBUG_P(PerlIO_printf(Perl_debug_log,
7120 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7121 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7122 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7124 cnt = PerlIO_get_cnt(fp);
7125 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7126 DEBUG_P(PerlIO_printf(Perl_debug_log,
7127 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7129 if (i == EOF) /* all done for ever? */
7130 goto thats_really_all_folks;
7132 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7134 SvGROW(sv, bpx + cnt + 2);
7135 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7137 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7139 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7140 goto thats_all_folks;
7144 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7145 memNE((char*)bp - rslen, rsptr, rslen))
7146 goto screamer; /* go back to the fray */
7147 thats_really_all_folks:
7149 cnt += shortbuffered;
7150 DEBUG_P(PerlIO_printf(Perl_debug_log,
7151 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7152 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7153 DEBUG_P(PerlIO_printf(Perl_debug_log,
7154 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7155 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7156 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7158 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7159 DEBUG_P(PerlIO_printf(Perl_debug_log,
7160 "Screamer: done, len=%ld, string=|%.*s|\n",
7161 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7165 /*The big, slow, and stupid way. */
7167 /* Any stack-challenged places. */
7169 /* EPOC: need to work around SDK features. *
7170 * On WINS: MS VC5 generates calls to _chkstk, *
7171 * if a "large" stack frame is allocated. *
7172 * gcc on MARM does not generate calls like these. */
7173 # define USEHEAPINSTEADOFSTACK
7176 #ifdef USEHEAPINSTEADOFSTACK
7178 New(0, buf, 8192, STDCHAR);
7186 register STDCHAR *bpe = buf + sizeof(buf);
7188 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7189 ; /* keep reading */
7193 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7194 /* Accomodate broken VAXC compiler, which applies U8 cast to
7195 * both args of ?: operator, causing EOF to change into 255
7198 i = (U8)buf[cnt - 1];
7204 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7206 sv_catpvn(sv, (char *) buf, cnt);
7208 sv_setpvn(sv, (char *) buf, cnt);
7210 if (i != EOF && /* joy */
7212 SvCUR(sv) < rslen ||
7213 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7217 * If we're reading from a TTY and we get a short read,
7218 * indicating that the user hit his EOF character, we need
7219 * to notice it now, because if we try to read from the TTY
7220 * again, the EOF condition will disappear.
7222 * The comparison of cnt to sizeof(buf) is an optimization
7223 * that prevents unnecessary calls to feof().
7227 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7231 #ifdef USEHEAPINSTEADOFSTACK
7236 if (rspara) { /* have to do this both before and after */
7237 while (i != EOF) { /* to make sure file boundaries work right */
7238 i = PerlIO_getc(fp);
7240 PerlIO_ungetc(fp,i);
7246 return_string_or_null:
7247 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7253 Auto-increment of the value in the SV, doing string to numeric conversion
7254 if necessary. Handles 'get' magic.
7260 Perl_sv_inc(pTHX_ register SV *sv)
7269 if (SvTHINKFIRST(sv)) {
7271 sv_force_normal_flags(sv, 0);
7272 if (SvREADONLY(sv)) {
7273 if (IN_PERL_RUNTIME)
7274 Perl_croak(aTHX_ PL_no_modify);
7278 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7280 i = PTR2IV(SvRV(sv));
7285 flags = SvFLAGS(sv);
7286 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7287 /* It's (privately or publicly) a float, but not tested as an
7288 integer, so test it to see. */
7290 flags = SvFLAGS(sv);
7292 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7293 /* It's publicly an integer, or privately an integer-not-float */
7294 #ifdef PERL_PRESERVE_IVUV
7298 if (SvUVX(sv) == UV_MAX)
7299 sv_setnv(sv, UV_MAX_P1);
7301 (void)SvIOK_only_UV(sv);
7304 if (SvIVX(sv) == IV_MAX)
7305 sv_setuv(sv, (UV)IV_MAX + 1);
7307 (void)SvIOK_only(sv);
7313 if (flags & SVp_NOK) {
7314 (void)SvNOK_only(sv);
7319 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7320 if ((flags & SVTYPEMASK) < SVt_PVIV)
7321 sv_upgrade(sv, SVt_IV);
7322 (void)SvIOK_only(sv);
7327 while (isALPHA(*d)) d++;
7328 while (isDIGIT(*d)) d++;
7330 #ifdef PERL_PRESERVE_IVUV
7331 /* Got to punt this as an integer if needs be, but we don't issue
7332 warnings. Probably ought to make the sv_iv_please() that does
7333 the conversion if possible, and silently. */
7334 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7335 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7336 /* Need to try really hard to see if it's an integer.
7337 9.22337203685478e+18 is an integer.
7338 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7339 so $a="9.22337203685478e+18"; $a+0; $a++
7340 needs to be the same as $a="9.22337203685478e+18"; $a++
7347 /* sv_2iv *should* have made this an NV */
7348 if (flags & SVp_NOK) {
7349 (void)SvNOK_only(sv);
7353 /* I don't think we can get here. Maybe I should assert this
7354 And if we do get here I suspect that sv_setnv will croak. NWC
7356 #if defined(USE_LONG_DOUBLE)
7357 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",
7358 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7360 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7361 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7364 #endif /* PERL_PRESERVE_IVUV */
7365 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7369 while (d >= SvPVX(sv)) {
7377 /* MKS: The original code here died if letters weren't consecutive.
7378 * at least it didn't have to worry about non-C locales. The
7379 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7380 * arranged in order (although not consecutively) and that only
7381 * [A-Za-z] are accepted by isALPHA in the C locale.
7383 if (*d != 'z' && *d != 'Z') {
7384 do { ++*d; } while (!isALPHA(*d));
7387 *(d--) -= 'z' - 'a';
7392 *(d--) -= 'z' - 'a' + 1;
7396 /* oh,oh, the number grew */
7397 SvGROW(sv, SvCUR(sv) + 2);
7399 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7410 Auto-decrement of the value in the SV, doing string to numeric conversion
7411 if necessary. Handles 'get' magic.
7417 Perl_sv_dec(pTHX_ register SV *sv)
7425 if (SvTHINKFIRST(sv)) {
7427 sv_force_normal_flags(sv, 0);
7428 if (SvREADONLY(sv)) {
7429 if (IN_PERL_RUNTIME)
7430 Perl_croak(aTHX_ PL_no_modify);
7434 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7436 i = PTR2IV(SvRV(sv));
7441 /* Unlike sv_inc we don't have to worry about string-never-numbers
7442 and keeping them magic. But we mustn't warn on punting */
7443 flags = SvFLAGS(sv);
7444 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7445 /* It's publicly an integer, or privately an integer-not-float */
7446 #ifdef PERL_PRESERVE_IVUV
7450 if (SvUVX(sv) == 0) {
7451 (void)SvIOK_only(sv);
7455 (void)SvIOK_only_UV(sv);
7459 if (SvIVX(sv) == IV_MIN)
7460 sv_setnv(sv, (NV)IV_MIN - 1.0);
7462 (void)SvIOK_only(sv);
7468 if (flags & SVp_NOK) {
7470 (void)SvNOK_only(sv);
7473 if (!(flags & SVp_POK)) {
7474 if ((flags & SVTYPEMASK) < SVt_PVNV)
7475 sv_upgrade(sv, SVt_NV);
7477 (void)SvNOK_only(sv);
7480 #ifdef PERL_PRESERVE_IVUV
7482 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7483 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7484 /* Need to try really hard to see if it's an integer.
7485 9.22337203685478e+18 is an integer.
7486 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7487 so $a="9.22337203685478e+18"; $a+0; $a--
7488 needs to be the same as $a="9.22337203685478e+18"; $a--
7495 /* sv_2iv *should* have made this an NV */
7496 if (flags & SVp_NOK) {
7497 (void)SvNOK_only(sv);
7501 /* I don't think we can get here. Maybe I should assert this
7502 And if we do get here I suspect that sv_setnv will croak. NWC
7504 #if defined(USE_LONG_DOUBLE)
7505 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",
7506 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7508 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7509 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7513 #endif /* PERL_PRESERVE_IVUV */
7514 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7518 =for apidoc sv_mortalcopy
7520 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7521 The new SV is marked as mortal. It will be destroyed "soon", either by an
7522 explicit call to FREETMPS, or by an implicit call at places such as
7523 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7528 /* Make a string that will exist for the duration of the expression
7529 * evaluation. Actually, it may have to last longer than that, but
7530 * hopefully we won't free it until it has been assigned to a
7531 * permanent location. */
7534 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7539 sv_setsv(sv,oldstr);
7541 PL_tmps_stack[++PL_tmps_ix] = sv;
7547 =for apidoc sv_newmortal
7549 Creates a new null SV which is mortal. The reference count of the SV is
7550 set to 1. It will be destroyed "soon", either by an explicit call to
7551 FREETMPS, or by an implicit call at places such as statement boundaries.
7552 See also C<sv_mortalcopy> and C<sv_2mortal>.
7558 Perl_sv_newmortal(pTHX)
7563 SvFLAGS(sv) = SVs_TEMP;
7565 PL_tmps_stack[++PL_tmps_ix] = sv;
7570 =for apidoc sv_2mortal
7572 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7573 by an explicit call to FREETMPS, or by an implicit call at places such as
7574 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
7580 Perl_sv_2mortal(pTHX_ register SV *sv)
7584 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7587 PL_tmps_stack[++PL_tmps_ix] = sv;
7595 Creates a new SV and copies a string into it. The reference count for the
7596 SV is set to 1. If C<len> is zero, Perl will compute the length using
7597 strlen(). For efficiency, consider using C<newSVpvn> instead.
7603 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7610 sv_setpvn(sv,s,len);
7615 =for apidoc newSVpvn
7617 Creates a new SV and copies a string into it. The reference count for the
7618 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7619 string. You are responsible for ensuring that the source string is at least
7626 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7631 sv_setpvn(sv,s,len);
7636 =for apidoc newSVpvn_share
7638 Creates a new SV with its SvPVX pointing to a shared string in the string
7639 table. If the string does not already exist in the table, it is created
7640 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7641 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7642 otherwise the hash is computed. The idea here is that as the string table
7643 is used for shared hash keys these strings will have SvPVX == HeKEY and
7644 hash lookup will avoid string compare.
7650 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7653 bool is_utf8 = FALSE;
7655 STRLEN tmplen = -len;
7657 /* See the note in hv.c:hv_fetch() --jhi */
7658 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7662 PERL_HASH(hash, src, len);
7664 sv_upgrade(sv, SVt_PVIV);
7665 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7678 #if defined(PERL_IMPLICIT_CONTEXT)
7680 /* pTHX_ magic can't cope with varargs, so this is a no-context
7681 * version of the main function, (which may itself be aliased to us).
7682 * Don't access this version directly.
7686 Perl_newSVpvf_nocontext(const char* pat, ...)
7691 va_start(args, pat);
7692 sv = vnewSVpvf(pat, &args);
7699 =for apidoc newSVpvf
7701 Creates a new SV and initializes it with the string formatted like
7708 Perl_newSVpvf(pTHX_ const char* pat, ...)
7712 va_start(args, pat);
7713 sv = vnewSVpvf(pat, &args);
7718 /* backend for newSVpvf() and newSVpvf_nocontext() */
7721 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7725 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7732 Creates a new SV and copies a floating point value into it.
7733 The reference count for the SV is set to 1.
7739 Perl_newSVnv(pTHX_ NV n)
7751 Creates a new SV and copies an integer into it. The reference count for the
7758 Perl_newSViv(pTHX_ IV i)
7770 Creates a new SV and copies an unsigned integer into it.
7771 The reference count for the SV is set to 1.
7777 Perl_newSVuv(pTHX_ UV u)
7787 =for apidoc newRV_noinc
7789 Creates an RV wrapper for an SV. The reference count for the original
7790 SV is B<not> incremented.
7796 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7801 sv_upgrade(sv, SVt_RV);
7808 /* newRV_inc is the official function name to use now.
7809 * newRV_inc is in fact #defined to newRV in sv.h
7813 Perl_newRV(pTHX_ SV *tmpRef)
7815 return newRV_noinc(SvREFCNT_inc(tmpRef));
7821 Creates a new SV which is an exact duplicate of the original SV.
7828 Perl_newSVsv(pTHX_ register SV *old)
7834 if (SvTYPE(old) == SVTYPEMASK) {
7835 if (ckWARN_d(WARN_INTERNAL))
7836 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7851 =for apidoc sv_reset
7853 Underlying implementation for the C<reset> Perl function.
7854 Note that the perl-level function is vaguely deprecated.
7860 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7868 char todo[PERL_UCHAR_MAX+1];
7873 if (!*s) { /* reset ?? searches */
7874 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7875 pm->op_pmdynflags &= ~PMdf_USED;
7880 /* reset variables */
7882 if (!HvARRAY(stash))
7885 Zero(todo, 256, char);
7887 i = (unsigned char)*s;
7891 max = (unsigned char)*s++;
7892 for ( ; i <= max; i++) {
7895 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7896 for (entry = HvARRAY(stash)[i];
7898 entry = HeNEXT(entry))
7900 if (!todo[(U8)*HeKEY(entry)])
7902 gv = (GV*)HeVAL(entry);
7904 if (SvTHINKFIRST(sv)) {
7905 if (!SvREADONLY(sv) && SvROK(sv))
7910 if (SvTYPE(sv) >= SVt_PV) {
7912 if (SvPVX(sv) != Nullch)
7919 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7922 #ifdef USE_ENVIRON_ARRAY
7924 # ifdef USE_ITHREADS
7925 && PL_curinterp == aTHX
7929 environ[0] = Nullch;
7932 #endif /* !PERL_MICRO */
7942 Using various gambits, try to get an IO from an SV: the IO slot if its a
7943 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7944 named after the PV if we're a string.
7950 Perl_sv_2io(pTHX_ SV *sv)
7956 switch (SvTYPE(sv)) {
7964 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7968 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7970 return sv_2io(SvRV(sv));
7971 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7977 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7986 Using various gambits, try to get a CV from an SV; in addition, try if
7987 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7993 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8000 return *gvp = Nullgv, Nullcv;
8001 switch (SvTYPE(sv)) {
8020 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8021 tryAMAGICunDEREF(to_cv);
8024 if (SvTYPE(sv) == SVt_PVCV) {
8033 Perl_croak(aTHX_ "Not a subroutine reference");
8038 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
8044 if (lref && !GvCVu(gv)) {
8047 tmpsv = NEWSV(704,0);
8048 gv_efullname3(tmpsv, gv, Nullch);
8049 /* XXX this is probably not what they think they're getting.
8050 * It has the same effect as "sub name;", i.e. just a forward
8052 newSUB(start_subparse(FALSE, 0),
8053 newSVOP(OP_CONST, 0, tmpsv),
8058 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8068 Returns true if the SV has a true value by Perl's rules.
8069 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8070 instead use an in-line version.
8076 Perl_sv_true(pTHX_ register SV *sv)
8082 if ((tXpv = (XPV*)SvANY(sv)) &&
8083 (tXpv->xpv_cur > 1 ||
8084 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8091 return SvIVX(sv) != 0;
8094 return SvNVX(sv) != 0.0;
8096 return sv_2bool(sv);
8104 A private implementation of the C<SvIVx> macro for compilers which can't
8105 cope with complex macro expressions. Always use the macro instead.
8111 Perl_sv_iv(pTHX_ register SV *sv)
8115 return (IV)SvUVX(sv);
8124 A private implementation of the C<SvUVx> macro for compilers which can't
8125 cope with complex macro expressions. Always use the macro instead.
8131 Perl_sv_uv(pTHX_ register SV *sv)
8136 return (UV)SvIVX(sv);
8144 A private implementation of the C<SvNVx> macro for compilers which can't
8145 cope with complex macro expressions. Always use the macro instead.
8151 Perl_sv_nv(pTHX_ register SV *sv)
8158 /* sv_pv() is now a macro using SvPV_nolen();
8159 * this function provided for binary compatibility only
8163 Perl_sv_pv(pTHX_ SV *sv)
8170 return sv_2pv(sv, &n_a);
8176 Use the C<SvPV_nolen> macro instead
8180 A private implementation of the C<SvPV> macro for compilers which can't
8181 cope with complex macro expressions. Always use the macro instead.
8187 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8193 return sv_2pv(sv, lp);
8198 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8204 return sv_2pv_flags(sv, lp, 0);
8207 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8208 * this function provided for binary compatibility only
8212 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8214 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8218 =for apidoc sv_pvn_force
8220 Get a sensible string out of the SV somehow.
8221 A private implementation of the C<SvPV_force> macro for compilers which
8222 can't cope with complex macro expressions. Always use the macro instead.
8224 =for apidoc sv_pvn_force_flags
8226 Get a sensible string out of the SV somehow.
8227 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8228 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8229 implemented in terms of this function.
8230 You normally want to use the various wrapper macros instead: see
8231 C<SvPV_force> and C<SvPV_force_nomg>
8237 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8241 if (SvTHINKFIRST(sv) && !SvROK(sv))
8242 sv_force_normal_flags(sv, 0);
8248 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8249 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8253 s = sv_2pv_flags(sv, lp, flags);
8254 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8259 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8260 SvGROW(sv, len + 1);
8261 Move(s,SvPVX(sv),len,char);
8266 SvPOK_on(sv); /* validate pointer */
8268 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8269 PTR2UV(sv),SvPVX(sv)));
8275 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8276 * this function provided for binary compatibility only
8280 Perl_sv_pvbyte(pTHX_ SV *sv)
8282 sv_utf8_downgrade(sv,0);
8287 =for apidoc sv_pvbyte
8289 Use C<SvPVbyte_nolen> instead.
8291 =for apidoc sv_pvbyten
8293 A private implementation of the C<SvPVbyte> macro for compilers
8294 which can't cope with complex macro expressions. Always use the macro
8301 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8303 sv_utf8_downgrade(sv,0);
8304 return sv_pvn(sv,lp);
8308 =for apidoc sv_pvbyten_force
8310 A private implementation of the C<SvPVbytex_force> macro for compilers
8311 which can't cope with complex macro expressions. Always use the macro
8318 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8320 sv_pvn_force(sv,lp);
8321 sv_utf8_downgrade(sv,0);
8326 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8327 * this function provided for binary compatibility only
8331 Perl_sv_pvutf8(pTHX_ SV *sv)
8333 sv_utf8_upgrade(sv);
8338 =for apidoc sv_pvutf8
8340 Use the C<SvPVutf8_nolen> macro instead
8342 =for apidoc sv_pvutf8n
8344 A private implementation of the C<SvPVutf8> macro for compilers
8345 which can't cope with complex macro expressions. Always use the macro
8352 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8354 sv_utf8_upgrade(sv);
8355 return sv_pvn(sv,lp);
8359 =for apidoc sv_pvutf8n_force
8361 A private implementation of the C<SvPVutf8_force> macro for compilers
8362 which can't cope with complex macro expressions. Always use the macro
8369 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8371 sv_pvn_force(sv,lp);
8372 sv_utf8_upgrade(sv);
8378 =for apidoc sv_reftype
8380 Returns a string describing what the SV is a reference to.
8386 Perl_sv_reftype(pTHX_ SV *sv, int ob)
8388 if (ob && SvOBJECT(sv)) {
8389 if (HvNAME(SvSTASH(sv)))
8390 return HvNAME(SvSTASH(sv));
8395 switch (SvTYPE(sv)) {
8412 case SVt_PVLV: return SvROK(sv) ? "REF"
8413 /* tied lvalues should appear to be
8414 * scalars for backwards compatitbility */
8415 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8416 ? "SCALAR" : "LVALUE";
8417 case SVt_PVAV: return "ARRAY";
8418 case SVt_PVHV: return "HASH";
8419 case SVt_PVCV: return "CODE";
8420 case SVt_PVGV: return "GLOB";
8421 case SVt_PVFM: return "FORMAT";
8422 case SVt_PVIO: return "IO";
8423 default: return "UNKNOWN";
8429 =for apidoc sv_isobject
8431 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8432 object. If the SV is not an RV, or if the object is not blessed, then this
8439 Perl_sv_isobject(pTHX_ SV *sv)
8456 Returns a boolean indicating whether the SV is blessed into the specified
8457 class. This does not check for subtypes; use C<sv_derived_from> to verify
8458 an inheritance relationship.
8464 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8475 if (!HvNAME(SvSTASH(sv)))
8478 return strEQ(HvNAME(SvSTASH(sv)), name);
8484 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8485 it will be upgraded to one. If C<classname> is non-null then the new SV will
8486 be blessed in the specified package. The new SV is returned and its
8487 reference count is 1.
8493 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8499 SV_CHECK_THINKFIRST_COW_DROP(rv);
8502 if (SvTYPE(rv) >= SVt_PVMG) {
8503 U32 refcnt = SvREFCNT(rv);
8507 SvREFCNT(rv) = refcnt;
8510 if (SvTYPE(rv) < SVt_RV)
8511 sv_upgrade(rv, SVt_RV);
8512 else if (SvTYPE(rv) > SVt_RV) {
8513 (void)SvOOK_off(rv);
8514 if (SvPVX(rv) && SvLEN(rv))
8515 Safefree(SvPVX(rv));
8525 HV* stash = gv_stashpv(classname, TRUE);
8526 (void)sv_bless(rv, stash);
8532 =for apidoc sv_setref_pv
8534 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8535 argument will be upgraded to an RV. That RV will be modified to point to
8536 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8537 into the SV. The C<classname> argument indicates the package for the
8538 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8539 will have a reference count of 1, and the RV will be returned.
8541 Do not use with other Perl types such as HV, AV, SV, CV, because those
8542 objects will become corrupted by the pointer copy process.
8544 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8550 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8553 sv_setsv(rv, &PL_sv_undef);
8557 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8562 =for apidoc sv_setref_iv
8564 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8565 argument will be upgraded to an RV. That RV will be modified to point to
8566 the new SV. The C<classname> argument indicates the package for the
8567 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8568 will have a reference count of 1, and the RV will be returned.
8574 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8576 sv_setiv(newSVrv(rv,classname), iv);
8581 =for apidoc sv_setref_uv
8583 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8584 argument will be upgraded to an RV. That RV will be modified to point to
8585 the new SV. The C<classname> argument indicates the package for the
8586 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8587 will have a reference count of 1, and the RV will be returned.
8593 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8595 sv_setuv(newSVrv(rv,classname), uv);
8600 =for apidoc sv_setref_nv
8602 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8603 argument will be upgraded to an RV. That RV will be modified to point to
8604 the new SV. The C<classname> argument indicates the package for the
8605 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8606 will have a reference count of 1, and the RV will be returned.
8612 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8614 sv_setnv(newSVrv(rv,classname), nv);
8619 =for apidoc sv_setref_pvn
8621 Copies a string into a new SV, optionally blessing the SV. The length of the
8622 string must be specified with C<n>. The C<rv> argument will be upgraded to
8623 an RV. That RV will be modified to point to the new SV. The C<classname>
8624 argument indicates the package for the blessing. Set C<classname> to
8625 C<Nullch> to avoid the blessing. The new SV will have a reference count
8626 of 1, and the RV will be returned.
8628 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8634 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8636 sv_setpvn(newSVrv(rv,classname), pv, n);
8641 =for apidoc sv_bless
8643 Blesses an SV into a specified package. The SV must be an RV. The package
8644 must be designated by its stash (see C<gv_stashpv()>). The reference count
8645 of the SV is unaffected.
8651 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8655 Perl_croak(aTHX_ "Can't bless non-reference value");
8657 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8658 if (SvREADONLY(tmpRef))
8659 Perl_croak(aTHX_ PL_no_modify);
8660 if (SvOBJECT(tmpRef)) {
8661 if (SvTYPE(tmpRef) != SVt_PVIO)
8663 SvREFCNT_dec(SvSTASH(tmpRef));
8666 SvOBJECT_on(tmpRef);
8667 if (SvTYPE(tmpRef) != SVt_PVIO)
8669 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8670 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8677 if(SvSMAGICAL(tmpRef))
8678 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8686 /* Downgrades a PVGV to a PVMG.
8690 S_sv_unglob(pTHX_ SV *sv)
8694 assert(SvTYPE(sv) == SVt_PVGV);
8699 SvREFCNT_dec(GvSTASH(sv));
8700 GvSTASH(sv) = Nullhv;
8702 sv_unmagic(sv, PERL_MAGIC_glob);
8703 Safefree(GvNAME(sv));
8706 /* need to keep SvANY(sv) in the right arena */
8707 xpvmg = new_XPVMG();
8708 StructCopy(SvANY(sv), xpvmg, XPVMG);
8709 del_XPVGV(SvANY(sv));
8712 SvFLAGS(sv) &= ~SVTYPEMASK;
8713 SvFLAGS(sv) |= SVt_PVMG;
8717 =for apidoc sv_unref_flags
8719 Unsets the RV status of the SV, and decrements the reference count of
8720 whatever was being referenced by the RV. This can almost be thought of
8721 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8722 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8723 (otherwise the decrementing is conditional on the reference count being
8724 different from one or the reference being a readonly SV).
8731 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8735 if (SvWEAKREF(sv)) {
8743 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8744 assigned to as BEGIN {$a = \"Foo"} will fail. */
8745 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8747 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8748 sv_2mortal(rv); /* Schedule for freeing later */
8752 =for apidoc sv_unref
8754 Unsets the RV status of the SV, and decrements the reference count of
8755 whatever was being referenced by the RV. This can almost be thought of
8756 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8757 being zero. See C<SvROK_off>.
8763 Perl_sv_unref(pTHX_ SV *sv)
8765 sv_unref_flags(sv, 0);
8769 =for apidoc sv_taint
8771 Taint an SV. Use C<SvTAINTED_on> instead.
8776 Perl_sv_taint(pTHX_ SV *sv)
8778 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8782 =for apidoc sv_untaint
8784 Untaint an SV. Use C<SvTAINTED_off> instead.
8789 Perl_sv_untaint(pTHX_ SV *sv)
8791 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8792 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8799 =for apidoc sv_tainted
8801 Test an SV for taintedness. Use C<SvTAINTED> instead.
8806 Perl_sv_tainted(pTHX_ SV *sv)
8808 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8809 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8810 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8817 =for apidoc sv_setpviv
8819 Copies an integer into the given SV, also updating its string value.
8820 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8826 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8828 char buf[TYPE_CHARS(UV)];
8830 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8832 sv_setpvn(sv, ptr, ebuf - ptr);
8836 =for apidoc sv_setpviv_mg
8838 Like C<sv_setpviv>, but also handles 'set' magic.
8844 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8846 char buf[TYPE_CHARS(UV)];
8848 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8850 sv_setpvn(sv, ptr, ebuf - ptr);
8854 #if defined(PERL_IMPLICIT_CONTEXT)
8856 /* pTHX_ magic can't cope with varargs, so this is a no-context
8857 * version of the main function, (which may itself be aliased to us).
8858 * Don't access this version directly.
8862 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8866 va_start(args, pat);
8867 sv_vsetpvf(sv, pat, &args);
8871 /* pTHX_ magic can't cope with varargs, so this is a no-context
8872 * version of the main function, (which may itself be aliased to us).
8873 * Don't access this version directly.
8877 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8881 va_start(args, pat);
8882 sv_vsetpvf_mg(sv, pat, &args);
8888 =for apidoc sv_setpvf
8890 Processes its arguments like C<sprintf> and sets an SV to the formatted
8891 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8897 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8900 va_start(args, pat);
8901 sv_vsetpvf(sv, pat, &args);
8905 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8908 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8910 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8914 =for apidoc sv_setpvf_mg
8916 Like C<sv_setpvf>, but also handles 'set' magic.
8922 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8925 va_start(args, pat);
8926 sv_vsetpvf_mg(sv, pat, &args);
8930 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8933 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8935 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8939 #if defined(PERL_IMPLICIT_CONTEXT)
8941 /* pTHX_ magic can't cope with varargs, so this is a no-context
8942 * version of the main function, (which may itself be aliased to us).
8943 * Don't access this version directly.
8947 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8951 va_start(args, pat);
8952 sv_vcatpvf(sv, pat, &args);
8956 /* pTHX_ magic can't cope with varargs, so this is a no-context
8957 * version of the main function, (which may itself be aliased to us).
8958 * Don't access this version directly.
8962 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8966 va_start(args, pat);
8967 sv_vcatpvf_mg(sv, pat, &args);
8973 =for apidoc sv_catpvf
8975 Processes its arguments like C<sprintf> and appends the formatted
8976 output to an SV. If the appended data contains "wide" characters
8977 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8978 and characters >255 formatted with %c), the original SV might get
8979 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8980 C<SvSETMAGIC()> must typically be called after calling this function
8981 to handle 'set' magic.
8986 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8989 va_start(args, pat);
8990 sv_vcatpvf(sv, pat, &args);
8994 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8997 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8999 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9003 =for apidoc sv_catpvf_mg
9005 Like C<sv_catpvf>, but also handles 'set' magic.
9011 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9014 va_start(args, pat);
9015 sv_vcatpvf_mg(sv, pat, &args);
9019 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
9022 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9024 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9029 =for apidoc sv_vsetpvfn
9031 Works like C<vcatpvfn> but copies the text into the SV instead of
9034 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
9040 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9042 sv_setpvn(sv, "", 0);
9043 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9046 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9049 S_expect_number(pTHX_ char** pattern)
9052 switch (**pattern) {
9053 case '1': case '2': case '3':
9054 case '4': case '5': case '6':
9055 case '7': case '8': case '9':
9056 while (isDIGIT(**pattern))
9057 var = var * 10 + (*(*pattern)++ - '0');
9061 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9064 F0convert(NV nv, char *endbuf, STRLEN *len)
9075 if (uv & 1 && uv == nv)
9076 uv--; /* Round to even */
9078 unsigned dig = uv % 10;
9091 =for apidoc sv_vcatpvfn
9093 Processes its arguments like C<vsprintf> and appends the formatted output
9094 to an SV. Uses an array of SVs if the C style variable argument list is
9095 missing (NULL). When running with taint checks enabled, indicates via
9096 C<maybe_tainted> if results are untrustworthy (often due to the use of
9099 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
9105 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9112 static char nullstr[] = "(null)";
9114 bool has_utf8; /* has the result utf8? */
9115 bool pat_utf8; /* the pattern is in utf8? */
9117 /* Times 4: a decimal digit takes more than 3 binary digits.
9118 * NV_DIG: mantissa takes than many decimal digits.
9119 * Plus 32: Playing safe. */
9120 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9121 /* large enough for "%#.#f" --chip */
9122 /* what about long double NVs? --jhi */
9124 has_utf8 = pat_utf8 = DO_UTF8(sv);
9126 /* no matter what, this is a string now */
9127 (void)SvPV_force(sv, origlen);
9129 /* special-case "", "%s", and "%_" */
9132 if (patlen == 2 && pat[0] == '%') {
9136 char *s = va_arg(*args, char*);
9137 sv_catpv(sv, s ? s : nullstr);
9139 else if (svix < svmax) {
9140 sv_catsv(sv, *svargs);
9141 if (DO_UTF8(*svargs))
9147 argsv = va_arg(*args, SV*);
9148 sv_catsv(sv, argsv);
9153 /* See comment on '_' below */
9158 #ifndef USE_LONG_DOUBLE
9159 /* special-case "%.<number>[gf]" */
9160 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9161 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9162 unsigned digits = 0;
9166 while (*pp >= '0' && *pp <= '9')
9167 digits = 10 * digits + (*pp++ - '0');
9168 if (pp - pat == (int)patlen - 1) {
9172 nv = (NV)va_arg(*args, double);
9173 else if (svix < svmax)
9178 /* Add check for digits != 0 because it seems that some
9179 gconverts are buggy in this case, and we don't yet have
9180 a Configure test for this. */
9181 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9182 /* 0, point, slack */
9183 Gconvert(nv, (int)digits, 0, ebuf);
9185 if (*ebuf) /* May return an empty string for digits==0 */
9188 } else if (!digits) {
9191 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9192 sv_catpvn(sv, p, l);
9198 #endif /* !USE_LONG_DOUBLE */
9200 if (!args && svix < svmax && DO_UTF8(*svargs))
9203 patend = (char*)pat + patlen;
9204 for (p = (char*)pat; p < patend; p = q) {
9207 bool vectorize = FALSE;
9208 bool vectorarg = FALSE;
9209 bool vec_utf8 = FALSE;
9215 bool has_precis = FALSE;
9218 bool is_utf8 = FALSE; /* is this item utf8? */
9219 #ifdef HAS_LDBL_SPRINTF_BUG
9220 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9221 with sfio - Allen <allens@cpan.org> */
9222 bool fix_ldbl_sprintf_bug = FALSE;
9226 U8 utf8buf[UTF8_MAXLEN+1];
9227 STRLEN esignlen = 0;
9229 char *eptr = Nullch;
9232 U8 *vecstr = Null(U8*);
9239 /* we need a long double target in case HAS_LONG_DOUBLE but
9242 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9251 STRLEN dotstrlen = 1;
9252 I32 efix = 0; /* explicit format parameter index */
9253 I32 ewix = 0; /* explicit width index */
9254 I32 epix = 0; /* explicit precision index */
9255 I32 evix = 0; /* explicit vector index */
9256 bool asterisk = FALSE;
9258 /* echo everything up to the next format specification */
9259 for (q = p; q < patend && *q != '%'; ++q) ;
9261 if (has_utf8 && !pat_utf8)
9262 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9264 sv_catpvn(sv, p, q - p);
9271 We allow format specification elements in this order:
9272 \d+\$ explicit format parameter index
9274 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9275 0 flag (as above): repeated to allow "v02"
9276 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9277 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9279 [%bcdefginopsux_DFOUX] format (mandatory)
9281 if (EXPECT_NUMBER(q, width)) {
9322 if (EXPECT_NUMBER(q, ewix))
9331 if ((vectorarg = asterisk)) {
9343 EXPECT_NUMBER(q, width);
9348 vecsv = va_arg(*args, SV*);
9350 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9351 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9352 dotstr = SvPVx(vecsv, dotstrlen);
9357 vecsv = va_arg(*args, SV*);
9358 vecstr = (U8*)SvPVx(vecsv,veclen);
9359 vec_utf8 = DO_UTF8(vecsv);
9361 else if (efix ? efix <= svmax : svix < svmax) {
9362 vecsv = svargs[efix ? efix-1 : svix++];
9363 vecstr = (U8*)SvPVx(vecsv,veclen);
9364 vec_utf8 = DO_UTF8(vecsv);
9374 i = va_arg(*args, int);
9376 i = (ewix ? ewix <= svmax : svix < svmax) ?
9377 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9379 width = (i < 0) ? -i : i;
9389 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9391 /* XXX: todo, support specified precision parameter */
9395 i = va_arg(*args, int);
9397 i = (ewix ? ewix <= svmax : svix < svmax)
9398 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9399 precis = (i < 0) ? 0 : i;
9404 precis = precis * 10 + (*q++ - '0');
9413 case 'I': /* Ix, I32x, and I64x */
9415 if (q[1] == '6' && q[2] == '4') {
9421 if (q[1] == '3' && q[2] == '2') {
9431 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9442 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9443 if (*(q + 1) == 'l') { /* lld, llf */
9468 argsv = (efix ? efix <= svmax : svix < svmax) ?
9469 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9476 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9478 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9480 eptr = (char*)utf8buf;
9481 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9492 if (args && !vectorize) {
9493 eptr = va_arg(*args, char*);
9495 #ifdef MACOS_TRADITIONAL
9496 /* On MacOS, %#s format is used for Pascal strings */
9501 elen = strlen(eptr);
9504 elen = sizeof nullstr - 1;
9508 eptr = SvPVx(argsv, elen);
9509 if (DO_UTF8(argsv)) {
9510 if (has_precis && precis < elen) {
9512 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9515 if (width) { /* fudge width (can't fudge elen) */
9516 width += elen - sv_len_utf8(argsv);
9525 * The "%_" hack might have to be changed someday,
9526 * if ISO or ANSI decide to use '_' for something.
9527 * So we keep it hidden from users' code.
9529 if (!args || vectorize)
9531 argsv = va_arg(*args, SV*);
9532 eptr = SvPVx(argsv, elen);
9538 if (has_precis && elen > precis)
9545 if (alt || vectorize)
9547 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9565 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9574 esignbuf[esignlen++] = plus;
9578 case 'h': iv = (short)va_arg(*args, int); break;
9579 case 'l': iv = va_arg(*args, long); break;
9580 case 'V': iv = va_arg(*args, IV); break;
9581 default: iv = va_arg(*args, int); break;
9583 case 'q': iv = va_arg(*args, Quad_t); break;
9588 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9590 case 'h': iv = (short)tiv; break;
9591 case 'l': iv = (long)tiv; break;
9593 default: iv = tiv; break;
9595 case 'q': iv = (Quad_t)tiv; break;
9599 if ( !vectorize ) /* we already set uv above */
9604 esignbuf[esignlen++] = plus;
9608 esignbuf[esignlen++] = '-';
9651 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9662 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9663 case 'l': uv = va_arg(*args, unsigned long); break;
9664 case 'V': uv = va_arg(*args, UV); break;
9665 default: uv = va_arg(*args, unsigned); break;
9667 case 'q': uv = va_arg(*args, Uquad_t); break;
9672 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9674 case 'h': uv = (unsigned short)tuv; break;
9675 case 'l': uv = (unsigned long)tuv; break;
9677 default: uv = tuv; break;
9679 case 'q': uv = (Uquad_t)tuv; break;
9685 eptr = ebuf + sizeof ebuf;
9691 p = (char*)((c == 'X')
9692 ? "0123456789ABCDEF" : "0123456789abcdef");
9698 esignbuf[esignlen++] = '0';
9699 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9705 *--eptr = '0' + dig;
9707 if (alt && *eptr != '0')
9713 *--eptr = '0' + dig;
9716 esignbuf[esignlen++] = '0';
9717 esignbuf[esignlen++] = 'b';
9720 default: /* it had better be ten or less */
9721 #if defined(PERL_Y2KWARN)
9722 if (ckWARN(WARN_Y2K)) {
9724 char *s = SvPV(sv,n);
9725 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9726 && (n == 2 || !isDIGIT(s[n-3])))
9728 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9729 "Possible Y2K bug: %%%c %s",
9730 c, "format string following '19'");
9736 *--eptr = '0' + dig;
9737 } while (uv /= base);
9740 elen = (ebuf + sizeof ebuf) - eptr;
9743 zeros = precis - elen;
9744 else if (precis == 0 && elen == 1 && *eptr == '0')
9749 /* FLOATING POINT */
9752 c = 'f'; /* maybe %F isn't supported here */
9758 /* This is evil, but floating point is even more evil */
9760 /* for SV-style calling, we can only get NV
9761 for C-style calling, we assume %f is double;
9762 for simplicity we allow any of %Lf, %llf, %qf for long double
9766 #if defined(USE_LONG_DOUBLE)
9770 /* [perl #20339] - we should accept and ignore %lf rather than die */
9774 #if defined(USE_LONG_DOUBLE)
9775 intsize = args ? 0 : 'q';
9779 #if defined(HAS_LONG_DOUBLE)
9788 /* now we need (long double) if intsize == 'q', else (double) */
9789 nv = (args && !vectorize) ?
9790 #if LONG_DOUBLESIZE > DOUBLESIZE
9792 va_arg(*args, long double) :
9793 va_arg(*args, double)
9795 va_arg(*args, double)
9801 if (c != 'e' && c != 'E') {
9803 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9804 will cast our (long double) to (double) */
9805 (void)Perl_frexp(nv, &i);
9806 if (i == PERL_INT_MIN)
9807 Perl_die(aTHX_ "panic: frexp");
9809 need = BIT_DIGITS(i);
9811 need += has_precis ? precis : 6; /* known default */
9816 #ifdef HAS_LDBL_SPRINTF_BUG
9817 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9818 with sfio - Allen <allens@cpan.org> */
9821 # define MY_DBL_MAX DBL_MAX
9822 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9823 # if DOUBLESIZE >= 8
9824 # define MY_DBL_MAX 1.7976931348623157E+308L
9826 # define MY_DBL_MAX 3.40282347E+38L
9830 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9831 # define MY_DBL_MAX_BUG 1L
9833 # define MY_DBL_MAX_BUG MY_DBL_MAX
9837 # define MY_DBL_MIN DBL_MIN
9838 # else /* XXX guessing! -Allen */
9839 # if DOUBLESIZE >= 8
9840 # define MY_DBL_MIN 2.2250738585072014E-308L
9842 # define MY_DBL_MIN 1.17549435E-38L
9846 if ((intsize == 'q') && (c == 'f') &&
9847 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9849 /* it's going to be short enough that
9850 * long double precision is not needed */
9852 if ((nv <= 0L) && (nv >= -0L))
9853 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9855 /* would use Perl_fp_class as a double-check but not
9856 * functional on IRIX - see perl.h comments */
9858 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9859 /* It's within the range that a double can represent */
9860 #if defined(DBL_MAX) && !defined(DBL_MIN)
9861 if ((nv >= ((long double)1/DBL_MAX)) ||
9862 (nv <= (-(long double)1/DBL_MAX)))
9864 fix_ldbl_sprintf_bug = TRUE;
9867 if (fix_ldbl_sprintf_bug == TRUE) {
9877 # undef MY_DBL_MAX_BUG
9880 #endif /* HAS_LDBL_SPRINTF_BUG */
9882 need += 20; /* fudge factor */
9883 if (PL_efloatsize < need) {
9884 Safefree(PL_efloatbuf);
9885 PL_efloatsize = need + 20; /* more fudge */
9886 New(906, PL_efloatbuf, PL_efloatsize, char);
9887 PL_efloatbuf[0] = '\0';
9890 if ( !(width || left || plus || alt) && fill != '0'
9891 && has_precis && intsize != 'q' ) { /* Shortcuts */
9892 /* See earlier comment about buggy Gconvert when digits,
9894 if ( c == 'g' && precis) {
9895 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9896 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9897 goto float_converted;
9898 } else if ( c == 'f' && !precis) {
9899 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9903 eptr = ebuf + sizeof ebuf;
9906 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9907 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9908 if (intsize == 'q') {
9909 /* Copy the one or more characters in a long double
9910 * format before the 'base' ([efgEFG]) character to
9911 * the format string. */
9912 static char const prifldbl[] = PERL_PRIfldbl;
9913 char const *p = prifldbl + sizeof(prifldbl) - 3;
9914 while (p >= prifldbl) { *--eptr = *p--; }
9919 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9924 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9936 /* No taint. Otherwise we are in the strange situation
9937 * where printf() taints but print($float) doesn't.
9939 #if defined(HAS_LONG_DOUBLE)
9941 (void)sprintf(PL_efloatbuf, eptr, nv);
9943 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9945 (void)sprintf(PL_efloatbuf, eptr, nv);
9948 eptr = PL_efloatbuf;
9949 elen = strlen(PL_efloatbuf);
9955 i = SvCUR(sv) - origlen;
9956 if (args && !vectorize) {
9958 case 'h': *(va_arg(*args, short*)) = i; break;
9959 default: *(va_arg(*args, int*)) = i; break;
9960 case 'l': *(va_arg(*args, long*)) = i; break;
9961 case 'V': *(va_arg(*args, IV*)) = i; break;
9963 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9968 sv_setuv_mg(argsv, (UV)i);
9970 continue; /* not "break" */
9976 if (!args && ckWARN(WARN_PRINTF) &&
9977 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9978 SV *msg = sv_newmortal();
9979 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9980 (PL_op->op_type == OP_PRTF) ? "" : "s");
9983 Perl_sv_catpvf(aTHX_ msg,
9984 "\"%%%c\"", c & 0xFF);
9986 Perl_sv_catpvf(aTHX_ msg,
9987 "\"%%\\%03"UVof"\"",
9990 sv_catpv(msg, "end of string");
9991 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9994 /* output mangled stuff ... */
10000 /* ... right here, because formatting flags should not apply */
10001 SvGROW(sv, SvCUR(sv) + elen + 1);
10003 Copy(eptr, p, elen, char);
10006 SvCUR(sv) = p - SvPVX(sv);
10008 continue; /* not "break" */
10011 /* calculate width before utf8_upgrade changes it */
10012 have = esignlen + zeros + elen;
10014 if (is_utf8 != has_utf8) {
10017 sv_utf8_upgrade(sv);
10020 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10021 sv_utf8_upgrade(nsv);
10025 SvGROW(sv, SvCUR(sv) + elen + 1);
10029 /* Use memchr() instead of strchr(), as eptr is not guaranteed */
10030 /* to point to a null-terminated string. */
10031 if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
10032 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
10033 Perl_warner(aTHX_ packWARN(WARN_PRINTF),
10034 "Newline in left-justified string for %sprintf",
10035 (PL_op->op_type == OP_PRTF) ? "" : "s");
10037 need = (have > width ? have : width);
10040 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10042 if (esignlen && fill == '0') {
10043 for (i = 0; i < (int)esignlen; i++)
10044 *p++ = esignbuf[i];
10046 if (gap && !left) {
10047 memset(p, fill, gap);
10050 if (esignlen && fill != '0') {
10051 for (i = 0; i < (int)esignlen; i++)
10052 *p++ = esignbuf[i];
10055 for (i = zeros; i; i--)
10059 Copy(eptr, p, elen, char);
10063 memset(p, ' ', gap);
10068 Copy(dotstr, p, dotstrlen, char);
10072 vectorize = FALSE; /* done iterating over vecstr */
10079 SvCUR(sv) = p - SvPVX(sv);
10087 /* =========================================================================
10089 =head1 Cloning an interpreter
10091 All the macros and functions in this section are for the private use of
10092 the main function, perl_clone().
10094 The foo_dup() functions make an exact copy of an existing foo thinngy.
10095 During the course of a cloning, a hash table is used to map old addresses
10096 to new addresses. The table is created and manipulated with the
10097 ptr_table_* functions.
10101 ============================================================================*/
10104 #if defined(USE_ITHREADS)
10106 #ifndef GpREFCNT_inc
10107 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10111 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10112 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10113 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10114 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10115 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10116 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10117 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10118 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10119 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10120 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10121 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10122 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10123 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10126 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10127 regcomp.c. AMS 20010712 */
10130 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10134 struct reg_substr_datum *s;
10137 return (REGEXP *)NULL;
10139 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10142 len = r->offsets[0];
10143 npar = r->nparens+1;
10145 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10146 Copy(r->program, ret->program, len+1, regnode);
10148 New(0, ret->startp, npar, I32);
10149 Copy(r->startp, ret->startp, npar, I32);
10150 New(0, ret->endp, npar, I32);
10151 Copy(r->startp, ret->startp, npar, I32);
10153 New(0, ret->substrs, 1, struct reg_substr_data);
10154 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10155 s->min_offset = r->substrs->data[i].min_offset;
10156 s->max_offset = r->substrs->data[i].max_offset;
10157 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10158 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10161 ret->regstclass = NULL;
10163 struct reg_data *d;
10164 int count = r->data->count;
10166 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10167 char, struct reg_data);
10168 New(0, d->what, count, U8);
10171 for (i = 0; i < count; i++) {
10172 d->what[i] = r->data->what[i];
10173 switch (d->what[i]) {
10175 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10178 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10181 /* This is cheating. */
10182 New(0, d->data[i], 1, struct regnode_charclass_class);
10183 StructCopy(r->data->data[i], d->data[i],
10184 struct regnode_charclass_class);
10185 ret->regstclass = (regnode*)d->data[i];
10188 /* Compiled op trees are readonly, and can thus be
10189 shared without duplication. */
10190 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10193 d->data[i] = r->data->data[i];
10203 New(0, ret->offsets, 2*len+1, U32);
10204 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10206 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10207 ret->refcnt = r->refcnt;
10208 ret->minlen = r->minlen;
10209 ret->prelen = r->prelen;
10210 ret->nparens = r->nparens;
10211 ret->lastparen = r->lastparen;
10212 ret->lastcloseparen = r->lastcloseparen;
10213 ret->reganch = r->reganch;
10215 ret->sublen = r->sublen;
10217 if (RX_MATCH_COPIED(ret))
10218 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10220 ret->subbeg = Nullch;
10221 #ifdef PERL_COPY_ON_WRITE
10222 ret->saved_copy = Nullsv;
10225 ptr_table_store(PL_ptr_table, r, ret);
10229 /* duplicate a file handle */
10232 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10236 return (PerlIO*)NULL;
10238 /* look for it in the table first */
10239 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10243 /* create anew and remember what it is */
10244 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10245 ptr_table_store(PL_ptr_table, fp, ret);
10249 /* duplicate a directory handle */
10252 Perl_dirp_dup(pTHX_ DIR *dp)
10260 /* duplicate a typeglob */
10263 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10268 /* look for it in the table first */
10269 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10273 /* create anew and remember what it is */
10274 Newz(0, ret, 1, GP);
10275 ptr_table_store(PL_ptr_table, gp, ret);
10278 ret->gp_refcnt = 0; /* must be before any other dups! */
10279 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10280 ret->gp_io = io_dup_inc(gp->gp_io, param);
10281 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10282 ret->gp_av = av_dup_inc(gp->gp_av, param);
10283 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10284 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10285 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10286 ret->gp_cvgen = gp->gp_cvgen;
10287 ret->gp_flags = gp->gp_flags;
10288 ret->gp_line = gp->gp_line;
10289 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10293 /* duplicate a chain of magic */
10296 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10298 MAGIC *mgprev = (MAGIC*)NULL;
10301 return (MAGIC*)NULL;
10302 /* look for it in the table first */
10303 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10307 for (; mg; mg = mg->mg_moremagic) {
10309 Newz(0, nmg, 1, MAGIC);
10311 mgprev->mg_moremagic = nmg;
10314 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10315 nmg->mg_private = mg->mg_private;
10316 nmg->mg_type = mg->mg_type;
10317 nmg->mg_flags = mg->mg_flags;
10318 if (mg->mg_type == PERL_MAGIC_qr) {
10319 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10321 else if(mg->mg_type == PERL_MAGIC_backref) {
10322 AV *av = (AV*) mg->mg_obj;
10325 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10327 for (i = AvFILLp(av); i >= 0; i--) {
10328 if (!svp[i]) continue;
10329 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10333 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10334 ? sv_dup_inc(mg->mg_obj, param)
10335 : sv_dup(mg->mg_obj, param);
10337 nmg->mg_len = mg->mg_len;
10338 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10339 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10340 if (mg->mg_len > 0) {
10341 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10342 if (mg->mg_type == PERL_MAGIC_overload_table &&
10343 AMT_AMAGIC((AMT*)mg->mg_ptr))
10345 AMT *amtp = (AMT*)mg->mg_ptr;
10346 AMT *namtp = (AMT*)nmg->mg_ptr;
10348 for (i = 1; i < NofAMmeth; i++) {
10349 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10353 else if (mg->mg_len == HEf_SVKEY)
10354 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10356 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10357 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10364 /* create a new pointer-mapping table */
10367 Perl_ptr_table_new(pTHX)
10370 Newz(0, tbl, 1, PTR_TBL_t);
10371 tbl->tbl_max = 511;
10372 tbl->tbl_items = 0;
10373 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10377 /* map an existing pointer using a table */
10380 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10382 PTR_TBL_ENT_t *tblent;
10383 UV hash = PTR2UV(sv);
10385 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10386 for (; tblent; tblent = tblent->next) {
10387 if (tblent->oldval == sv)
10388 return tblent->newval;
10390 return (void*)NULL;
10393 /* add a new entry to a pointer-mapping table */
10396 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10398 PTR_TBL_ENT_t *tblent, **otblent;
10399 /* XXX this may be pessimal on platforms where pointers aren't good
10400 * hash values e.g. if they grow faster in the most significant
10402 UV hash = PTR2UV(oldv);
10406 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10407 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
10408 if (tblent->oldval == oldv) {
10409 tblent->newval = newv;
10413 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10414 tblent->oldval = oldv;
10415 tblent->newval = newv;
10416 tblent->next = *otblent;
10419 if (i && tbl->tbl_items > tbl->tbl_max)
10420 ptr_table_split(tbl);
10423 /* double the hash bucket size of an existing ptr table */
10426 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10428 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10429 UV oldsize = tbl->tbl_max + 1;
10430 UV newsize = oldsize * 2;
10433 Renew(ary, newsize, PTR_TBL_ENT_t*);
10434 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10435 tbl->tbl_max = --newsize;
10436 tbl->tbl_ary = ary;
10437 for (i=0; i < oldsize; i++, ary++) {
10438 PTR_TBL_ENT_t **curentp, **entp, *ent;
10441 curentp = ary + oldsize;
10442 for (entp = ary, ent = *ary; ent; ent = *entp) {
10443 if ((newsize & PTR2UV(ent->oldval)) != i) {
10445 ent->next = *curentp;
10455 /* remove all the entries from a ptr table */
10458 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10460 register PTR_TBL_ENT_t **array;
10461 register PTR_TBL_ENT_t *entry;
10462 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10466 if (!tbl || !tbl->tbl_items) {
10470 array = tbl->tbl_ary;
10472 max = tbl->tbl_max;
10477 entry = entry->next;
10481 if (++riter > max) {
10484 entry = array[riter];
10488 tbl->tbl_items = 0;
10491 /* clear and free a ptr table */
10494 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10499 ptr_table_clear(tbl);
10500 Safefree(tbl->tbl_ary);
10505 char *PL_watch_pvx;
10508 /* attempt to make everything in the typeglob readonly */
10511 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10513 GV *gv = (GV*)sstr;
10514 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10516 if (GvIO(gv) || GvFORM(gv)) {
10517 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10519 else if (!GvCV(gv)) {
10520 GvCV(gv) = (CV*)sv;
10523 /* CvPADLISTs cannot be shared */
10524 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10529 if (!GvUNIQUE(gv)) {
10531 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10532 HvNAME(GvSTASH(gv)), GvNAME(gv));
10538 * write attempts will die with
10539 * "Modification of a read-only value attempted"
10545 SvREADONLY_on(GvSV(gv));
10549 GvAV(gv) = (AV*)sv;
10552 SvREADONLY_on(GvAV(gv));
10556 GvHV(gv) = (HV*)sv;
10559 SvREADONLY_on(GvHV(gv));
10562 return sstr; /* he_dup() will SvREFCNT_inc() */
10565 /* duplicate an SV of any type (including AV, HV etc) */
10568 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10571 SvRV(dstr) = SvWEAKREF(sstr)
10572 ? sv_dup(SvRV(sstr), param)
10573 : sv_dup_inc(SvRV(sstr), param);
10575 else if (SvPVX(sstr)) {
10576 /* Has something there */
10578 /* Normal PV - clone whole allocated space */
10579 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10580 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10581 /* Not that normal - actually sstr is copy on write.
10582 But we are a true, independant SV, so: */
10583 SvREADONLY_off(dstr);
10588 /* Special case - not normally malloced for some reason */
10589 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10590 /* A "shared" PV - clone it as unshared string */
10591 if(SvPADTMP(sstr)) {
10592 /* However, some of them live in the pad
10593 and they should not have these flags
10596 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10598 SvUVX(dstr) = SvUVX(sstr);
10601 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10603 SvREADONLY_off(dstr);
10607 /* Some other special case - random pointer */
10608 SvPVX(dstr) = SvPVX(sstr);
10613 /* Copy the Null */
10614 SvPVX(dstr) = SvPVX(sstr);
10619 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10623 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10625 /* look for it in the table first */
10626 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10630 if(param->flags & CLONEf_JOIN_IN) {
10631 /** We are joining here so we don't want do clone
10632 something that is bad **/
10634 if(SvTYPE(sstr) == SVt_PVHV &&
10636 /** don't clone stashes if they already exist **/
10637 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10638 return (SV*) old_stash;
10642 /* create anew and remember what it is */
10644 ptr_table_store(PL_ptr_table, sstr, dstr);
10647 SvFLAGS(dstr) = SvFLAGS(sstr);
10648 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10649 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10652 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10653 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10654 PL_watch_pvx, SvPVX(sstr));
10657 switch (SvTYPE(sstr)) {
10659 SvANY(dstr) = NULL;
10662 SvANY(dstr) = new_XIV();
10663 SvIVX(dstr) = SvIVX(sstr);
10666 SvANY(dstr) = new_XNV();
10667 SvNVX(dstr) = SvNVX(sstr);
10670 SvANY(dstr) = new_XRV();
10671 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10674 SvANY(dstr) = new_XPV();
10675 SvCUR(dstr) = SvCUR(sstr);
10676 SvLEN(dstr) = SvLEN(sstr);
10677 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10680 SvANY(dstr) = new_XPVIV();
10681 SvCUR(dstr) = SvCUR(sstr);
10682 SvLEN(dstr) = SvLEN(sstr);
10683 SvIVX(dstr) = SvIVX(sstr);
10684 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10687 SvANY(dstr) = new_XPVNV();
10688 SvCUR(dstr) = SvCUR(sstr);
10689 SvLEN(dstr) = SvLEN(sstr);
10690 SvIVX(dstr) = SvIVX(sstr);
10691 SvNVX(dstr) = SvNVX(sstr);
10692 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10695 SvANY(dstr) = new_XPVMG();
10696 SvCUR(dstr) = SvCUR(sstr);
10697 SvLEN(dstr) = SvLEN(sstr);
10698 SvIVX(dstr) = SvIVX(sstr);
10699 SvNVX(dstr) = SvNVX(sstr);
10700 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10701 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10702 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10705 SvANY(dstr) = new_XPVBM();
10706 SvCUR(dstr) = SvCUR(sstr);
10707 SvLEN(dstr) = SvLEN(sstr);
10708 SvIVX(dstr) = SvIVX(sstr);
10709 SvNVX(dstr) = SvNVX(sstr);
10710 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10711 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10712 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10713 BmRARE(dstr) = BmRARE(sstr);
10714 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10715 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10718 SvANY(dstr) = new_XPVLV();
10719 SvCUR(dstr) = SvCUR(sstr);
10720 SvLEN(dstr) = SvLEN(sstr);
10721 SvIVX(dstr) = SvIVX(sstr);
10722 SvNVX(dstr) = SvNVX(sstr);
10723 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10724 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10725 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10726 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10727 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10728 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10729 LvTARG(dstr) = dstr;
10730 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10731 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10733 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10734 LvTYPE(dstr) = LvTYPE(sstr);
10737 if (GvUNIQUE((GV*)sstr)) {
10739 if ((share = gv_share(sstr, param))) {
10742 ptr_table_store(PL_ptr_table, sstr, dstr);
10744 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10745 HvNAME(GvSTASH(share)), GvNAME(share));
10750 SvANY(dstr) = new_XPVGV();
10751 SvCUR(dstr) = SvCUR(sstr);
10752 SvLEN(dstr) = SvLEN(sstr);
10753 SvIVX(dstr) = SvIVX(sstr);
10754 SvNVX(dstr) = SvNVX(sstr);
10755 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10756 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10757 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10758 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10759 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10760 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10761 GvFLAGS(dstr) = GvFLAGS(sstr);
10762 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10763 (void)GpREFCNT_inc(GvGP(dstr));
10766 SvANY(dstr) = new_XPVIO();
10767 SvCUR(dstr) = SvCUR(sstr);
10768 SvLEN(dstr) = SvLEN(sstr);
10769 SvIVX(dstr) = SvIVX(sstr);
10770 SvNVX(dstr) = SvNVX(sstr);
10771 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10772 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10773 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10774 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10775 if (IoOFP(sstr) == IoIFP(sstr))
10776 IoOFP(dstr) = IoIFP(dstr);
10778 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10779 /* PL_rsfp_filters entries have fake IoDIRP() */
10780 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10781 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10783 IoDIRP(dstr) = IoDIRP(sstr);
10784 IoLINES(dstr) = IoLINES(sstr);
10785 IoPAGE(dstr) = IoPAGE(sstr);
10786 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10787 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10788 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10789 /* I have no idea why fake dirp (rsfps)
10790 should be treaded differently but otherwise
10791 we end up with leaks -- sky*/
10792 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10793 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10794 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10796 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10797 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10798 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10800 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10801 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10802 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10803 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10804 IoTYPE(dstr) = IoTYPE(sstr);
10805 IoFLAGS(dstr) = IoFLAGS(sstr);
10808 SvANY(dstr) = new_XPVAV();
10809 SvCUR(dstr) = SvCUR(sstr);
10810 SvLEN(dstr) = SvLEN(sstr);
10811 SvIVX(dstr) = SvIVX(sstr);
10812 SvNVX(dstr) = SvNVX(sstr);
10813 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10814 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10815 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10816 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10817 if (AvARRAY((AV*)sstr)) {
10818 SV **dst_ary, **src_ary;
10819 SSize_t items = AvFILLp((AV*)sstr) + 1;
10821 src_ary = AvARRAY((AV*)sstr);
10822 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10823 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10824 SvPVX(dstr) = (char*)dst_ary;
10825 AvALLOC((AV*)dstr) = dst_ary;
10826 if (AvREAL((AV*)sstr)) {
10827 while (items-- > 0)
10828 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10831 while (items-- > 0)
10832 *dst_ary++ = sv_dup(*src_ary++, param);
10834 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10835 while (items-- > 0) {
10836 *dst_ary++ = &PL_sv_undef;
10840 SvPVX(dstr) = Nullch;
10841 AvALLOC((AV*)dstr) = (SV**)NULL;
10845 SvANY(dstr) = new_XPVHV();
10846 SvCUR(dstr) = SvCUR(sstr);
10847 SvLEN(dstr) = SvLEN(sstr);
10848 SvIVX(dstr) = SvIVX(sstr);
10849 SvNVX(dstr) = SvNVX(sstr);
10850 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10851 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10852 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10853 if (HvARRAY((HV*)sstr)) {
10855 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10856 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10857 Newz(0, dxhv->xhv_array,
10858 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10859 while (i <= sxhv->xhv_max) {
10860 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10861 (bool)!!HvSHAREKEYS(sstr),
10865 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10866 (bool)!!HvSHAREKEYS(sstr), param);
10869 SvPVX(dstr) = Nullch;
10870 HvEITER((HV*)dstr) = (HE*)NULL;
10872 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10873 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10874 /* Record stashes for possible cloning in Perl_clone(). */
10875 if(HvNAME((HV*)dstr))
10876 av_push(param->stashes, dstr);
10879 SvANY(dstr) = new_XPVFM();
10880 FmLINES(dstr) = FmLINES(sstr);
10884 SvANY(dstr) = new_XPVCV();
10886 SvCUR(dstr) = SvCUR(sstr);
10887 SvLEN(dstr) = SvLEN(sstr);
10888 SvIVX(dstr) = SvIVX(sstr);
10889 SvNVX(dstr) = SvNVX(sstr);
10890 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10891 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10892 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10893 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10894 CvSTART(dstr) = CvSTART(sstr);
10895 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10896 CvXSUB(dstr) = CvXSUB(sstr);
10897 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10898 if (CvCONST(sstr)) {
10899 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10900 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10901 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10903 /* don't dup if copying back - CvGV isn't refcounted, so the
10904 * duped GV may never be freed. A bit of a hack! DAPM */
10905 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10906 Nullgv : gv_dup(CvGV(sstr), param) ;
10907 if (param->flags & CLONEf_COPY_STACKS) {
10908 CvDEPTH(dstr) = CvDEPTH(sstr);
10912 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10913 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10915 CvWEAKOUTSIDE(sstr)
10916 ? cv_dup( CvOUTSIDE(sstr), param)
10917 : cv_dup_inc(CvOUTSIDE(sstr), param);
10918 CvFLAGS(dstr) = CvFLAGS(sstr);
10919 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10922 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10926 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10932 /* duplicate a context */
10935 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10937 PERL_CONTEXT *ncxs;
10940 return (PERL_CONTEXT*)NULL;
10942 /* look for it in the table first */
10943 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10947 /* create anew and remember what it is */
10948 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10949 ptr_table_store(PL_ptr_table, cxs, ncxs);
10952 PERL_CONTEXT *cx = &cxs[ix];
10953 PERL_CONTEXT *ncx = &ncxs[ix];
10954 ncx->cx_type = cx->cx_type;
10955 if (CxTYPE(cx) == CXt_SUBST) {
10956 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10959 ncx->blk_oldsp = cx->blk_oldsp;
10960 ncx->blk_oldcop = cx->blk_oldcop;
10961 ncx->blk_oldretsp = cx->blk_oldretsp;
10962 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10963 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10964 ncx->blk_oldpm = cx->blk_oldpm;
10965 ncx->blk_gimme = cx->blk_gimme;
10966 switch (CxTYPE(cx)) {
10968 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10969 ? cv_dup_inc(cx->blk_sub.cv, param)
10970 : cv_dup(cx->blk_sub.cv,param));
10971 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10972 ? av_dup_inc(cx->blk_sub.argarray, param)
10974 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10975 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10976 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10977 ncx->blk_sub.lval = cx->blk_sub.lval;
10980 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10981 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10982 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10983 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10984 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10987 ncx->blk_loop.label = cx->blk_loop.label;
10988 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10989 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10990 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10991 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10992 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10993 ? cx->blk_loop.iterdata
10994 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10995 ncx->blk_loop.oldcomppad
10996 = (PAD*)ptr_table_fetch(PL_ptr_table,
10997 cx->blk_loop.oldcomppad);
10998 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10999 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11000 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11001 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11002 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11005 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11006 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11007 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11008 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11020 /* duplicate a stack info structure */
11023 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11028 return (PERL_SI*)NULL;
11030 /* look for it in the table first */
11031 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11035 /* create anew and remember what it is */
11036 Newz(56, nsi, 1, PERL_SI);
11037 ptr_table_store(PL_ptr_table, si, nsi);
11039 nsi->si_stack = av_dup_inc(si->si_stack, param);
11040 nsi->si_cxix = si->si_cxix;
11041 nsi->si_cxmax = si->si_cxmax;
11042 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11043 nsi->si_type = si->si_type;
11044 nsi->si_prev = si_dup(si->si_prev, param);
11045 nsi->si_next = si_dup(si->si_next, param);
11046 nsi->si_markoff = si->si_markoff;
11051 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11052 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11053 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11054 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11055 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11056 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11057 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11058 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11059 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11060 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11061 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11062 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11063 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11064 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11067 #define pv_dup_inc(p) SAVEPV(p)
11068 #define pv_dup(p) SAVEPV(p)
11069 #define svp_dup_inc(p,pp) any_dup(p,pp)
11071 /* map any object to the new equivent - either something in the
11072 * ptr table, or something in the interpreter structure
11076 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11081 return (void*)NULL;
11083 /* look for it in the table first */
11084 ret = ptr_table_fetch(PL_ptr_table, v);
11088 /* see if it is part of the interpreter structure */
11089 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11090 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11098 /* duplicate the save stack */
11101 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11103 ANY *ss = proto_perl->Tsavestack;
11104 I32 ix = proto_perl->Tsavestack_ix;
11105 I32 max = proto_perl->Tsavestack_max;
11118 void (*dptr) (void*);
11119 void (*dxptr) (pTHX_ void*);
11122 Newz(54, nss, max, ANY);
11126 TOPINT(nss,ix) = i;
11128 case SAVEt_ITEM: /* normal string */
11129 sv = (SV*)POPPTR(ss,ix);
11130 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11131 sv = (SV*)POPPTR(ss,ix);
11132 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11134 case SAVEt_SV: /* scalar reference */
11135 sv = (SV*)POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11137 gv = (GV*)POPPTR(ss,ix);
11138 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11140 case SAVEt_GENERIC_PVREF: /* generic char* */
11141 c = (char*)POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = pv_dup(c);
11143 ptr = POPPTR(ss,ix);
11144 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11146 case SAVEt_SHARED_PVREF: /* char* in shared space */
11147 c = (char*)POPPTR(ss,ix);
11148 TOPPTR(nss,ix) = savesharedpv(c);
11149 ptr = POPPTR(ss,ix);
11150 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11152 case SAVEt_GENERIC_SVREF: /* generic sv */
11153 case SAVEt_SVREF: /* scalar reference */
11154 sv = (SV*)POPPTR(ss,ix);
11155 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11156 ptr = POPPTR(ss,ix);
11157 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11159 case SAVEt_AV: /* array reference */
11160 av = (AV*)POPPTR(ss,ix);
11161 TOPPTR(nss,ix) = av_dup_inc(av, param);
11162 gv = (GV*)POPPTR(ss,ix);
11163 TOPPTR(nss,ix) = gv_dup(gv, param);
11165 case SAVEt_HV: /* hash reference */
11166 hv = (HV*)POPPTR(ss,ix);
11167 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11168 gv = (GV*)POPPTR(ss,ix);
11169 TOPPTR(nss,ix) = gv_dup(gv, param);
11171 case SAVEt_INT: /* int reference */
11172 ptr = POPPTR(ss,ix);
11173 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11174 intval = (int)POPINT(ss,ix);
11175 TOPINT(nss,ix) = intval;
11177 case SAVEt_LONG: /* long reference */
11178 ptr = POPPTR(ss,ix);
11179 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11180 longval = (long)POPLONG(ss,ix);
11181 TOPLONG(nss,ix) = longval;
11183 case SAVEt_I32: /* I32 reference */
11184 case SAVEt_I16: /* I16 reference */
11185 case SAVEt_I8: /* I8 reference */
11186 ptr = POPPTR(ss,ix);
11187 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11189 TOPINT(nss,ix) = i;
11191 case SAVEt_IV: /* IV reference */
11192 ptr = POPPTR(ss,ix);
11193 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11195 TOPIV(nss,ix) = iv;
11197 case SAVEt_SPTR: /* SV* reference */
11198 ptr = POPPTR(ss,ix);
11199 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11200 sv = (SV*)POPPTR(ss,ix);
11201 TOPPTR(nss,ix) = sv_dup(sv, param);
11203 case SAVEt_VPTR: /* random* reference */
11204 ptr = POPPTR(ss,ix);
11205 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11206 ptr = POPPTR(ss,ix);
11207 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11209 case SAVEt_PPTR: /* char* reference */
11210 ptr = POPPTR(ss,ix);
11211 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11212 c = (char*)POPPTR(ss,ix);
11213 TOPPTR(nss,ix) = pv_dup(c);
11215 case SAVEt_HPTR: /* HV* reference */
11216 ptr = POPPTR(ss,ix);
11217 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11218 hv = (HV*)POPPTR(ss,ix);
11219 TOPPTR(nss,ix) = hv_dup(hv, param);
11221 case SAVEt_APTR: /* AV* reference */
11222 ptr = POPPTR(ss,ix);
11223 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11224 av = (AV*)POPPTR(ss,ix);
11225 TOPPTR(nss,ix) = av_dup(av, param);
11228 gv = (GV*)POPPTR(ss,ix);
11229 TOPPTR(nss,ix) = gv_dup(gv, param);
11231 case SAVEt_GP: /* scalar reference */
11232 gp = (GP*)POPPTR(ss,ix);
11233 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11234 (void)GpREFCNT_inc(gp);
11235 gv = (GV*)POPPTR(ss,ix);
11236 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11237 c = (char*)POPPTR(ss,ix);
11238 TOPPTR(nss,ix) = pv_dup(c);
11240 TOPIV(nss,ix) = iv;
11242 TOPIV(nss,ix) = iv;
11245 case SAVEt_MORTALIZESV:
11246 sv = (SV*)POPPTR(ss,ix);
11247 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11250 ptr = POPPTR(ss,ix);
11251 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11252 /* these are assumed to be refcounted properly */
11253 switch (((OP*)ptr)->op_type) {
11255 case OP_LEAVESUBLV:
11259 case OP_LEAVEWRITE:
11260 TOPPTR(nss,ix) = ptr;
11265 TOPPTR(nss,ix) = Nullop;
11270 TOPPTR(nss,ix) = Nullop;
11273 c = (char*)POPPTR(ss,ix);
11274 TOPPTR(nss,ix) = pv_dup_inc(c);
11276 case SAVEt_CLEARSV:
11277 longval = POPLONG(ss,ix);
11278 TOPLONG(nss,ix) = longval;
11281 hv = (HV*)POPPTR(ss,ix);
11282 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11283 c = (char*)POPPTR(ss,ix);
11284 TOPPTR(nss,ix) = pv_dup_inc(c);
11286 TOPINT(nss,ix) = i;
11288 case SAVEt_DESTRUCTOR:
11289 ptr = POPPTR(ss,ix);
11290 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11291 dptr = POPDPTR(ss,ix);
11292 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11294 case SAVEt_DESTRUCTOR_X:
11295 ptr = POPPTR(ss,ix);
11296 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11297 dxptr = POPDXPTR(ss,ix);
11298 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11300 case SAVEt_REGCONTEXT:
11303 TOPINT(nss,ix) = i;
11306 case SAVEt_STACK_POS: /* Position on Perl stack */
11308 TOPINT(nss,ix) = i;
11310 case SAVEt_AELEM: /* array element */
11311 sv = (SV*)POPPTR(ss,ix);
11312 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11314 TOPINT(nss,ix) = i;
11315 av = (AV*)POPPTR(ss,ix);
11316 TOPPTR(nss,ix) = av_dup_inc(av, param);
11318 case SAVEt_HELEM: /* hash element */
11319 sv = (SV*)POPPTR(ss,ix);
11320 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11321 sv = (SV*)POPPTR(ss,ix);
11322 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11323 hv = (HV*)POPPTR(ss,ix);
11324 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11327 ptr = POPPTR(ss,ix);
11328 TOPPTR(nss,ix) = ptr;
11332 TOPINT(nss,ix) = i;
11334 case SAVEt_COMPPAD:
11335 av = (AV*)POPPTR(ss,ix);
11336 TOPPTR(nss,ix) = av_dup(av, param);
11339 longval = (long)POPLONG(ss,ix);
11340 TOPLONG(nss,ix) = longval;
11341 ptr = POPPTR(ss,ix);
11342 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11343 sv = (SV*)POPPTR(ss,ix);
11344 TOPPTR(nss,ix) = sv_dup(sv, param);
11347 ptr = POPPTR(ss,ix);
11348 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11349 longval = (long)POPBOOL(ss,ix);
11350 TOPBOOL(nss,ix) = (bool)longval;
11352 case SAVEt_SET_SVFLAGS:
11354 TOPINT(nss,ix) = i;
11356 TOPINT(nss,ix) = i;
11357 sv = (SV*)POPPTR(ss,ix);
11358 TOPPTR(nss,ix) = sv_dup(sv, param);
11361 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11369 =for apidoc perl_clone
11371 Create and return a new interpreter by cloning the current one.
11373 perl_clone takes these flags as parameters:
11375 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11376 without it we only clone the data and zero the stacks,
11377 with it we copy the stacks and the new perl interpreter is
11378 ready to run at the exact same point as the previous one.
11379 The pseudo-fork code uses COPY_STACKS while the
11380 threads->new doesn't.
11382 CLONEf_KEEP_PTR_TABLE
11383 perl_clone keeps a ptr_table with the pointer of the old
11384 variable as a key and the new variable as a value,
11385 this allows it to check if something has been cloned and not
11386 clone it again but rather just use the value and increase the
11387 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11388 the ptr_table using the function
11389 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11390 reason to keep it around is if you want to dup some of your own
11391 variable who are outside the graph perl scans, example of this
11392 code is in threads.xs create
11395 This is a win32 thing, it is ignored on unix, it tells perls
11396 win32host code (which is c++) to clone itself, this is needed on
11397 win32 if you want to run two threads at the same time,
11398 if you just want to do some stuff in a separate perl interpreter
11399 and then throw it away and return to the original one,
11400 you don't need to do anything.
11405 /* XXX the above needs expanding by someone who actually understands it ! */
11406 EXTERN_C PerlInterpreter *
11407 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11410 perl_clone(PerlInterpreter *proto_perl, UV flags)
11412 #ifdef PERL_IMPLICIT_SYS
11414 /* perlhost.h so we need to call into it
11415 to clone the host, CPerlHost should have a c interface, sky */
11417 if (flags & CLONEf_CLONE_HOST) {
11418 return perl_clone_host(proto_perl,flags);
11420 return perl_clone_using(proto_perl, flags,
11422 proto_perl->IMemShared,
11423 proto_perl->IMemParse,
11425 proto_perl->IStdIO,
11429 proto_perl->IProc);
11433 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11434 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11435 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11436 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11437 struct IPerlDir* ipD, struct IPerlSock* ipS,
11438 struct IPerlProc* ipP)
11440 /* XXX many of the string copies here can be optimized if they're
11441 * constants; they need to be allocated as common memory and just
11442 * their pointers copied. */
11445 CLONE_PARAMS clone_params;
11446 CLONE_PARAMS* param = &clone_params;
11448 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11449 PERL_SET_THX(my_perl);
11452 Poison(my_perl, 1, PerlInterpreter);
11456 PL_savestack_ix = 0;
11457 PL_savestack_max = -1;
11459 PL_sig_pending = 0;
11460 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11461 # else /* !DEBUGGING */
11462 Zero(my_perl, 1, PerlInterpreter);
11463 # endif /* DEBUGGING */
11465 /* host pointers */
11467 PL_MemShared = ipMS;
11468 PL_MemParse = ipMP;
11475 #else /* !PERL_IMPLICIT_SYS */
11477 CLONE_PARAMS clone_params;
11478 CLONE_PARAMS* param = &clone_params;
11479 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11480 PERL_SET_THX(my_perl);
11485 Poison(my_perl, 1, PerlInterpreter);
11489 PL_savestack_ix = 0;
11490 PL_savestack_max = -1;
11492 PL_sig_pending = 0;
11493 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11494 # else /* !DEBUGGING */
11495 Zero(my_perl, 1, PerlInterpreter);
11496 # endif /* DEBUGGING */
11497 #endif /* PERL_IMPLICIT_SYS */
11498 param->flags = flags;
11499 param->proto_perl = proto_perl;
11502 PL_xiv_arenaroot = NULL;
11503 PL_xiv_root = NULL;
11504 PL_xnv_arenaroot = NULL;
11505 PL_xnv_root = NULL;
11506 PL_xrv_arenaroot = NULL;
11507 PL_xrv_root = NULL;
11508 PL_xpv_arenaroot = NULL;
11509 PL_xpv_root = NULL;
11510 PL_xpviv_arenaroot = NULL;
11511 PL_xpviv_root = NULL;
11512 PL_xpvnv_arenaroot = NULL;
11513 PL_xpvnv_root = NULL;
11514 PL_xpvcv_arenaroot = NULL;
11515 PL_xpvcv_root = NULL;
11516 PL_xpvav_arenaroot = NULL;
11517 PL_xpvav_root = NULL;
11518 PL_xpvhv_arenaroot = NULL;
11519 PL_xpvhv_root = NULL;
11520 PL_xpvmg_arenaroot = NULL;
11521 PL_xpvmg_root = NULL;
11522 PL_xpvlv_arenaroot = NULL;
11523 PL_xpvlv_root = NULL;
11524 PL_xpvbm_arenaroot = NULL;
11525 PL_xpvbm_root = NULL;
11526 PL_he_arenaroot = NULL;
11528 PL_nice_chunk = NULL;
11529 PL_nice_chunk_size = 0;
11531 PL_sv_objcount = 0;
11532 PL_sv_root = Nullsv;
11533 PL_sv_arenaroot = Nullsv;
11535 PL_debug = proto_perl->Idebug;
11537 #ifdef USE_REENTRANT_API
11538 /* XXX: things like -Dm will segfault here in perlio, but doing
11539 * PERL_SET_CONTEXT(proto_perl);
11540 * breaks too many other things
11542 Perl_reentrant_init(aTHX);
11545 /* create SV map for pointer relocation */
11546 PL_ptr_table = ptr_table_new();
11548 /* initialize these special pointers as early as possible */
11549 SvANY(&PL_sv_undef) = NULL;
11550 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11551 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11552 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11554 SvANY(&PL_sv_no) = new_XPVNV();
11555 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11556 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11557 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11558 SvCUR(&PL_sv_no) = 0;
11559 SvLEN(&PL_sv_no) = 1;
11560 SvNVX(&PL_sv_no) = 0;
11561 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11563 SvANY(&PL_sv_yes) = new_XPVNV();
11564 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11565 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11566 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11567 SvCUR(&PL_sv_yes) = 1;
11568 SvLEN(&PL_sv_yes) = 2;
11569 SvNVX(&PL_sv_yes) = 1;
11570 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11572 /* create (a non-shared!) shared string table */
11573 PL_strtab = newHV();
11574 HvSHAREKEYS_off(PL_strtab);
11575 hv_ksplit(PL_strtab, 512);
11576 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11578 PL_compiling = proto_perl->Icompiling;
11580 /* These two PVs will be free'd special way so must set them same way op.c does */
11581 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11582 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11584 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11585 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11587 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11588 if (!specialWARN(PL_compiling.cop_warnings))
11589 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11590 if (!specialCopIO(PL_compiling.cop_io))
11591 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11592 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11594 /* pseudo environmental stuff */
11595 PL_origargc = proto_perl->Iorigargc;
11596 PL_origargv = proto_perl->Iorigargv;
11598 param->stashes = newAV(); /* Setup array of objects to call clone on */
11600 #ifdef PERLIO_LAYERS
11601 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11602 PerlIO_clone(aTHX_ proto_perl, param);
11605 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11606 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11607 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11608 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11609 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11610 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11613 PL_minus_c = proto_perl->Iminus_c;
11614 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11615 PL_localpatches = proto_perl->Ilocalpatches;
11616 PL_splitstr = proto_perl->Isplitstr;
11617 PL_preprocess = proto_perl->Ipreprocess;
11618 PL_minus_n = proto_perl->Iminus_n;
11619 PL_minus_p = proto_perl->Iminus_p;
11620 PL_minus_l = proto_perl->Iminus_l;
11621 PL_minus_a = proto_perl->Iminus_a;
11622 PL_minus_F = proto_perl->Iminus_F;
11623 PL_doswitches = proto_perl->Idoswitches;
11624 PL_dowarn = proto_perl->Idowarn;
11625 PL_doextract = proto_perl->Idoextract;
11626 PL_sawampersand = proto_perl->Isawampersand;
11627 PL_unsafe = proto_perl->Iunsafe;
11628 PL_inplace = SAVEPV(proto_perl->Iinplace);
11629 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11630 PL_perldb = proto_perl->Iperldb;
11631 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11632 PL_exit_flags = proto_perl->Iexit_flags;
11634 /* magical thingies */
11635 /* XXX time(&PL_basetime) when asked for? */
11636 PL_basetime = proto_perl->Ibasetime;
11637 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11639 PL_maxsysfd = proto_perl->Imaxsysfd;
11640 PL_multiline = proto_perl->Imultiline;
11641 PL_statusvalue = proto_perl->Istatusvalue;
11643 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11645 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11647 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11648 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11649 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11651 /* Clone the regex array */
11652 PL_regex_padav = newAV();
11654 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11655 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11656 av_push(PL_regex_padav,
11657 sv_dup_inc(regexen[0],param));
11658 for(i = 1; i <= len; i++) {
11659 if(SvREPADTMP(regexen[i])) {
11660 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11662 av_push(PL_regex_padav,
11664 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11665 SvIVX(regexen[i])), param)))
11670 PL_regex_pad = AvARRAY(PL_regex_padav);
11672 /* shortcuts to various I/O objects */
11673 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11674 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11675 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11676 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11677 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11678 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11680 /* shortcuts to regexp stuff */
11681 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11683 /* shortcuts to misc objects */
11684 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11686 /* shortcuts to debugging objects */
11687 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11688 PL_DBline = gv_dup(proto_perl->IDBline, param);
11689 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11690 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11691 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11692 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11693 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11694 PL_lineary = av_dup(proto_perl->Ilineary, param);
11695 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11697 /* symbol tables */
11698 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11699 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11700 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11701 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11702 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11704 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11705 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11706 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11707 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11708 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11709 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11711 PL_sub_generation = proto_perl->Isub_generation;
11713 /* funky return mechanisms */
11714 PL_forkprocess = proto_perl->Iforkprocess;
11716 /* subprocess state */
11717 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11719 /* internal state */
11720 PL_tainting = proto_perl->Itainting;
11721 PL_taint_warn = proto_perl->Itaint_warn;
11722 PL_maxo = proto_perl->Imaxo;
11723 if (proto_perl->Iop_mask)
11724 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11726 PL_op_mask = Nullch;
11727 /* PL_asserting = proto_perl->Iasserting; */
11729 /* current interpreter roots */
11730 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11731 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11732 PL_main_start = proto_perl->Imain_start;
11733 PL_eval_root = proto_perl->Ieval_root;
11734 PL_eval_start = proto_perl->Ieval_start;
11736 /* runtime control stuff */
11737 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11738 PL_copline = proto_perl->Icopline;
11740 PL_filemode = proto_perl->Ifilemode;
11741 PL_lastfd = proto_perl->Ilastfd;
11742 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11745 PL_gensym = proto_perl->Igensym;
11746 PL_preambled = proto_perl->Ipreambled;
11747 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11748 PL_laststatval = proto_perl->Ilaststatval;
11749 PL_laststype = proto_perl->Ilaststype;
11750 PL_mess_sv = Nullsv;
11752 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11753 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11755 /* interpreter atexit processing */
11756 PL_exitlistlen = proto_perl->Iexitlistlen;
11757 if (PL_exitlistlen) {
11758 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11759 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11762 PL_exitlist = (PerlExitListEntry*)NULL;
11763 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11764 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11765 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11767 PL_profiledata = NULL;
11768 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11769 /* PL_rsfp_filters entries have fake IoDIRP() */
11770 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11772 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11774 PAD_CLONE_VARS(proto_perl, param);
11776 #ifdef HAVE_INTERP_INTERN
11777 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11780 /* more statics moved here */
11781 PL_generation = proto_perl->Igeneration;
11782 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11784 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11785 PL_in_clean_all = proto_perl->Iin_clean_all;
11787 PL_uid = proto_perl->Iuid;
11788 PL_euid = proto_perl->Ieuid;
11789 PL_gid = proto_perl->Igid;
11790 PL_egid = proto_perl->Iegid;
11791 PL_nomemok = proto_perl->Inomemok;
11792 PL_an = proto_perl->Ian;
11793 PL_evalseq = proto_perl->Ievalseq;
11794 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11795 PL_origalen = proto_perl->Iorigalen;
11796 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11797 PL_osname = SAVEPV(proto_perl->Iosname);
11798 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11799 PL_sighandlerp = proto_perl->Isighandlerp;
11802 PL_runops = proto_perl->Irunops;
11804 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11807 PL_cshlen = proto_perl->Icshlen;
11808 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11811 PL_lex_state = proto_perl->Ilex_state;
11812 PL_lex_defer = proto_perl->Ilex_defer;
11813 PL_lex_expect = proto_perl->Ilex_expect;
11814 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11815 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11816 PL_lex_starts = proto_perl->Ilex_starts;
11817 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11818 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11819 PL_lex_op = proto_perl->Ilex_op;
11820 PL_lex_inpat = proto_perl->Ilex_inpat;
11821 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11822 PL_lex_brackets = proto_perl->Ilex_brackets;
11823 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11824 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11825 PL_lex_casemods = proto_perl->Ilex_casemods;
11826 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11827 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11829 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11830 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11831 PL_nexttoke = proto_perl->Inexttoke;
11833 /* XXX This is probably masking the deeper issue of why
11834 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11835 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11836 * (A little debugging with a watchpoint on it may help.)
11838 if (SvANY(proto_perl->Ilinestr)) {
11839 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11840 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11841 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11842 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11843 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11844 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11845 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11846 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11847 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11850 PL_linestr = NEWSV(65,79);
11851 sv_upgrade(PL_linestr,SVt_PVIV);
11852 sv_setpvn(PL_linestr,"",0);
11853 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11855 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11856 PL_pending_ident = proto_perl->Ipending_ident;
11857 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11859 PL_expect = proto_perl->Iexpect;
11861 PL_multi_start = proto_perl->Imulti_start;
11862 PL_multi_end = proto_perl->Imulti_end;
11863 PL_multi_open = proto_perl->Imulti_open;
11864 PL_multi_close = proto_perl->Imulti_close;
11866 PL_error_count = proto_perl->Ierror_count;
11867 PL_subline = proto_perl->Isubline;
11868 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11870 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11871 if (SvANY(proto_perl->Ilinestr)) {
11872 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11873 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11874 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11875 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11876 PL_last_lop_op = proto_perl->Ilast_lop_op;
11879 PL_last_uni = SvPVX(PL_linestr);
11880 PL_last_lop = SvPVX(PL_linestr);
11881 PL_last_lop_op = 0;
11883 PL_in_my = proto_perl->Iin_my;
11884 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11886 PL_cryptseen = proto_perl->Icryptseen;
11889 PL_hints = proto_perl->Ihints;
11891 PL_amagic_generation = proto_perl->Iamagic_generation;
11893 #ifdef USE_LOCALE_COLLATE
11894 PL_collation_ix = proto_perl->Icollation_ix;
11895 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11896 PL_collation_standard = proto_perl->Icollation_standard;
11897 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11898 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11899 #endif /* USE_LOCALE_COLLATE */
11901 #ifdef USE_LOCALE_NUMERIC
11902 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11903 PL_numeric_standard = proto_perl->Inumeric_standard;
11904 PL_numeric_local = proto_perl->Inumeric_local;
11905 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11906 #endif /* !USE_LOCALE_NUMERIC */
11908 /* utf8 character classes */
11909 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11910 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11911 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11912 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11913 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11914 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11915 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11916 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11917 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11918 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11919 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11920 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11921 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11922 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11923 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11924 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11925 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11926 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11927 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11928 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11930 /* Did the locale setup indicate UTF-8? */
11931 PL_utf8locale = proto_perl->Iutf8locale;
11932 /* Unicode features (see perlrun/-C) */
11933 PL_unicode = proto_perl->Iunicode;
11935 /* Pre-5.8 signals control */
11936 PL_signals = proto_perl->Isignals;
11938 /* times() ticks per second */
11939 PL_clocktick = proto_perl->Iclocktick;
11941 /* Recursion stopper for PerlIO_find_layer */
11942 PL_in_load_module = proto_perl->Iin_load_module;
11944 /* sort() routine */
11945 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11947 /* Not really needed/useful since the reenrant_retint is "volatile",
11948 * but do it for consistency's sake. */
11949 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11951 /* Hooks to shared SVs and locks. */
11952 PL_sharehook = proto_perl->Isharehook;
11953 PL_lockhook = proto_perl->Ilockhook;
11954 PL_unlockhook = proto_perl->Iunlockhook;
11955 PL_threadhook = proto_perl->Ithreadhook;
11957 PL_runops_std = proto_perl->Irunops_std;
11958 PL_runops_dbg = proto_perl->Irunops_dbg;
11960 #ifdef THREADS_HAVE_PIDS
11961 PL_ppid = proto_perl->Ippid;
11965 PL_last_swash_hv = Nullhv; /* reinits on demand */
11966 PL_last_swash_klen = 0;
11967 PL_last_swash_key[0]= '\0';
11968 PL_last_swash_tmps = (U8*)NULL;
11969 PL_last_swash_slen = 0;
11971 PL_glob_index = proto_perl->Iglob_index;
11972 PL_srand_called = proto_perl->Isrand_called;
11973 PL_hash_seed = proto_perl->Ihash_seed;
11974 PL_rehash_seed = proto_perl->Irehash_seed;
11975 PL_uudmap['M'] = 0; /* reinits on demand */
11976 PL_bitcount = Nullch; /* reinits on demand */
11978 if (proto_perl->Ipsig_pend) {
11979 Newz(0, PL_psig_pend, SIG_SIZE, int);
11982 PL_psig_pend = (int*)NULL;
11985 if (proto_perl->Ipsig_ptr) {
11986 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11987 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11988 for (i = 1; i < SIG_SIZE; i++) {
11989 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11990 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11994 PL_psig_ptr = (SV**)NULL;
11995 PL_psig_name = (SV**)NULL;
11998 /* thrdvar.h stuff */
12000 if (flags & CLONEf_COPY_STACKS) {
12001 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12002 PL_tmps_ix = proto_perl->Ttmps_ix;
12003 PL_tmps_max = proto_perl->Ttmps_max;
12004 PL_tmps_floor = proto_perl->Ttmps_floor;
12005 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12007 while (i <= PL_tmps_ix) {
12008 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12012 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12013 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12014 Newz(54, PL_markstack, i, I32);
12015 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12016 - proto_perl->Tmarkstack);
12017 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12018 - proto_perl->Tmarkstack);
12019 Copy(proto_perl->Tmarkstack, PL_markstack,
12020 PL_markstack_ptr - PL_markstack + 1, I32);
12022 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12023 * NOTE: unlike the others! */
12024 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12025 PL_scopestack_max = proto_perl->Tscopestack_max;
12026 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12027 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12029 /* next push_return() sets PL_retstack[PL_retstack_ix]
12030 * NOTE: unlike the others! */
12031 PL_retstack_ix = proto_perl->Tretstack_ix;
12032 PL_retstack_max = proto_perl->Tretstack_max;
12033 Newz(54, PL_retstack, PL_retstack_max, OP*);
12034 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
12036 /* NOTE: si_dup() looks at PL_markstack */
12037 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12039 /* PL_curstack = PL_curstackinfo->si_stack; */
12040 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12041 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12043 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12044 PL_stack_base = AvARRAY(PL_curstack);
12045 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12046 - proto_perl->Tstack_base);
12047 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12049 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12050 * NOTE: unlike the others! */
12051 PL_savestack_ix = proto_perl->Tsavestack_ix;
12052 PL_savestack_max = proto_perl->Tsavestack_max;
12053 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12054 PL_savestack = ss_dup(proto_perl, param);
12058 ENTER; /* perl_destruct() wants to LEAVE; */
12061 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12062 PL_top_env = &PL_start_env;
12064 PL_op = proto_perl->Top;
12067 PL_Xpv = (XPV*)NULL;
12068 PL_na = proto_perl->Tna;
12070 PL_statbuf = proto_perl->Tstatbuf;
12071 PL_statcache = proto_perl->Tstatcache;
12072 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12073 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12075 PL_timesbuf = proto_perl->Ttimesbuf;
12078 PL_tainted = proto_perl->Ttainted;
12079 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12080 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12081 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12082 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12083 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12084 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12085 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12086 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12087 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12089 PL_restartop = proto_perl->Trestartop;
12090 PL_in_eval = proto_perl->Tin_eval;
12091 PL_delaymagic = proto_perl->Tdelaymagic;
12092 PL_dirty = proto_perl->Tdirty;
12093 PL_localizing = proto_perl->Tlocalizing;
12095 #ifdef PERL_FLEXIBLE_EXCEPTIONS
12096 PL_protect = proto_perl->Tprotect;
12098 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12099 PL_hv_fetch_ent_mh = Nullhe;
12100 PL_modcount = proto_perl->Tmodcount;
12101 PL_lastgotoprobe = Nullop;
12102 PL_dumpindent = proto_perl->Tdumpindent;
12104 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12105 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12106 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12107 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12108 PL_sortcxix = proto_perl->Tsortcxix;
12109 PL_efloatbuf = Nullch; /* reinits on demand */
12110 PL_efloatsize = 0; /* reinits on demand */
12114 PL_screamfirst = NULL;
12115 PL_screamnext = NULL;
12116 PL_maxscream = -1; /* reinits on demand */
12117 PL_lastscream = Nullsv;
12119 PL_watchaddr = NULL;
12120 PL_watchok = Nullch;
12122 PL_regdummy = proto_perl->Tregdummy;
12123 PL_regprecomp = Nullch;
12126 PL_colorset = 0; /* reinits PL_colors[] */
12127 /*PL_colors[6] = {0,0,0,0,0,0};*/
12128 PL_reginput = Nullch;
12129 PL_regbol = Nullch;
12130 PL_regeol = Nullch;
12131 PL_regstartp = (I32*)NULL;
12132 PL_regendp = (I32*)NULL;
12133 PL_reglastparen = (U32*)NULL;
12134 PL_reglastcloseparen = (U32*)NULL;
12135 PL_regtill = Nullch;
12136 PL_reg_start_tmp = (char**)NULL;
12137 PL_reg_start_tmpl = 0;
12138 PL_regdata = (struct reg_data*)NULL;
12141 PL_reg_eval_set = 0;
12143 PL_regprogram = (regnode*)NULL;
12145 PL_regcc = (CURCUR*)NULL;
12146 PL_reg_call_cc = (struct re_cc_state*)NULL;
12147 PL_reg_re = (regexp*)NULL;
12148 PL_reg_ganch = Nullch;
12149 PL_reg_sv = Nullsv;
12150 PL_reg_match_utf8 = FALSE;
12151 PL_reg_magic = (MAGIC*)NULL;
12153 PL_reg_oldcurpm = (PMOP*)NULL;
12154 PL_reg_curpm = (PMOP*)NULL;
12155 PL_reg_oldsaved = Nullch;
12156 PL_reg_oldsavedlen = 0;
12157 #ifdef PERL_COPY_ON_WRITE
12160 PL_reg_maxiter = 0;
12161 PL_reg_leftiter = 0;
12162 PL_reg_poscache = Nullch;
12163 PL_reg_poscache_size= 0;
12165 /* RE engine - function pointers */
12166 PL_regcompp = proto_perl->Tregcompp;
12167 PL_regexecp = proto_perl->Tregexecp;
12168 PL_regint_start = proto_perl->Tregint_start;
12169 PL_regint_string = proto_perl->Tregint_string;
12170 PL_regfree = proto_perl->Tregfree;
12172 PL_reginterp_cnt = 0;
12173 PL_reg_starttry = 0;
12175 /* Pluggable optimizer */
12176 PL_peepp = proto_perl->Tpeepp;
12178 PL_stashcache = newHV();
12180 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12181 ptr_table_free(PL_ptr_table);
12182 PL_ptr_table = NULL;
12185 /* Call the ->CLONE method, if it exists, for each of the stashes
12186 identified by sv_dup() above.
12188 while(av_len(param->stashes) != -1) {
12189 HV* stash = (HV*) av_shift(param->stashes);
12190 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12191 if (cloner && GvCV(cloner)) {
12196 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12198 call_sv((SV*)GvCV(cloner), G_DISCARD);
12204 SvREFCNT_dec(param->stashes);
12209 #endif /* USE_ITHREADS */
12212 =head1 Unicode Support
12214 =for apidoc sv_recode_to_utf8
12216 The encoding is assumed to be an Encode object, on entry the PV
12217 of the sv is assumed to be octets in that encoding, and the sv
12218 will be converted into Unicode (and UTF-8).
12220 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12221 is not a reference, nothing is done to the sv. If the encoding is not
12222 an C<Encode::XS> Encoding object, bad things will happen.
12223 (See F<lib/encoding.pm> and L<Encode>).
12225 The PV of the sv is returned.
12230 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12232 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12246 Passing sv_yes is wrong - it needs to be or'ed set of constants
12247 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12248 remove converted chars from source.
12250 Both will default the value - let them.
12252 XPUSHs(&PL_sv_yes);
12255 call_method("decode", G_SCALAR);
12259 s = SvPV(uni, len);
12260 if (s != SvPVX(sv)) {
12261 SvGROW(sv, len + 1);
12262 Move(s, SvPVX(sv), len, char);
12263 SvCUR_set(sv, len);
12264 SvPVX(sv)[len] = 0;
12274 =for apidoc sv_cat_decode
12276 The encoding is assumed to be an Encode object, the PV of the ssv is
12277 assumed to be octets in that encoding and decoding the input starts
12278 from the position which (PV + *offset) pointed to. The dsv will be
12279 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12280 when the string tstr appears in decoding output or the input ends on
12281 the PV of the ssv. The value which the offset points will be modified
12282 to the last input position on the ssv.
12284 Returns TRUE if the terminator was found, else returns FALSE.
12289 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12290 SV *ssv, int *offset, char *tstr, int tlen)
12293 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12304 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12305 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12307 call_method("cat_decode", G_SCALAR);
12309 ret = SvTRUE(TOPs);
12310 *offset = SvIV(offsv);
12316 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");