3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which are approximately
67 1K chunks of memory parcelled up into N heads or bodies. The first slot
68 in each arena is reserved, and is used to hold a link to the next arena.
69 In the case of heads, the unused first slot also contains some flags and
70 a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free
75 The following global variables are associated with arenas:
77 PL_sv_arenaroot pointer to list of SV arenas
78 PL_sv_root pointer to list of free SV structures
80 PL_foo_arenaroot pointer to list of foo arenas,
81 PL_foo_root pointer to list of free foo bodies
82 ... for foo in xiv, xnv, xrv, xpv etc.
84 Note that some of the larger and more rarely used body types (eg xpvio)
85 are not allocated using arenas, but are instead just malloc()/free()ed as
86 required. Also, if PURIFY is defined, arenas are abandoned altogether,
87 with all items individually malloc()ed. In addition, a few SV heads are
88 not allocated from an arena, but are instead directly created as static
89 or auto variables, eg PL_sv_undef.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
168 #define plant_SV(p) \
170 SvANY(p) = (void *)PL_sv_root; \
171 SvFLAGS(p) = SVTYPEMASK; \
176 /* sv_mutex must be held while calling uproot_SV() */
177 #define uproot_SV(p) \
180 PL_sv_root = (SV*)SvANY(p); \
185 /* new_SV(): return a new, empty SV head */
187 #ifdef DEBUG_LEAKING_SCALARS
188 /* provide a real function for a debugger to play with */
205 # define new_SV(p) (p)=S_new_SV(aTHX)
223 /* del_SV(): return an empty SV head to the free list */
238 S_del_sv(pTHX_ SV *p)
245 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
247 svend = &sva[SvREFCNT(sva)];
248 if (p >= sv && p < svend)
252 if (ckWARN_d(WARN_INTERNAL))
253 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
254 "Attempt to free non-arena SV: 0x%"UVxf
255 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
262 #else /* ! DEBUGGING */
264 #define del_SV(p) plant_SV(p)
266 #endif /* DEBUGGING */
270 =head1 SV Manipulation Functions
272 =for apidoc sv_add_arena
274 Given a chunk of memory, link it to the head of the list of arenas,
275 and split it into a list of free SVs.
281 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
287 /* The first SV in an arena isn't an SV. */
288 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
289 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
290 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
292 PL_sv_arenaroot = sva;
293 PL_sv_root = sva + 1;
295 svend = &sva[SvREFCNT(sva) - 1];
298 SvANY(sv) = (void *)(SV*)(sv + 1);
300 SvFLAGS(sv) = SVTYPEMASK;
304 SvFLAGS(sv) = SVTYPEMASK;
307 /* make some more SVs by adding another arena */
309 /* sv_mutex must be held while calling more_sv() */
316 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
317 PL_nice_chunk = Nullch;
318 PL_nice_chunk_size = 0;
321 char *chunk; /* must use New here to match call to */
322 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
323 sv_add_arena(chunk, 1008, 0);
329 /* visit(): call the named function for each non-free SV in the arenas
330 * whose flags field matches the flags/mask args. */
333 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
340 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
341 svend = &sva[SvREFCNT(sva)];
342 for (sv = sva + 1; sv < svend; ++sv) {
343 if (SvTYPE(sv) != SVTYPEMASK
344 && (sv->sv_flags & mask) == flags
357 /* called by sv_report_used() for each live SV */
360 do_report_used(pTHX_ SV *sv)
362 if (SvTYPE(sv) != SVTYPEMASK) {
363 PerlIO_printf(Perl_debug_log, "****\n");
370 =for apidoc sv_report_used
372 Dump the contents of all SVs not yet freed. (Debugging aid).
378 Perl_sv_report_used(pTHX)
381 visit(do_report_used, 0, 0);
385 /* called by sv_clean_objs() for each live SV */
388 do_clean_objs(pTHX_ SV *sv)
392 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
393 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
405 /* XXX Might want to check arrays, etc. */
408 /* called by sv_clean_objs() for each live SV */
410 #ifndef DISABLE_DESTRUCTOR_KLUDGE
412 do_clean_named_objs(pTHX_ SV *sv)
414 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
415 if ( SvOBJECT(GvSV(sv)) ||
416 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
417 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
418 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
419 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
421 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
422 SvFLAGS(sv) |= SVf_BREAK;
430 =for apidoc sv_clean_objs
432 Attempt to destroy all objects not yet freed
438 Perl_sv_clean_objs(pTHX)
440 PL_in_clean_objs = TRUE;
441 visit(do_clean_objs, SVf_ROK, SVf_ROK);
442 #ifndef DISABLE_DESTRUCTOR_KLUDGE
443 /* some barnacles may yet remain, clinging to typeglobs */
444 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
446 PL_in_clean_objs = FALSE;
449 /* called by sv_clean_all() for each live SV */
452 do_clean_all(pTHX_ SV *sv)
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
455 SvFLAGS(sv) |= SVf_BREAK;
456 if (PL_comppad == (AV*)sv) {
458 PL_curpad = Null(SV**);
464 =for apidoc sv_clean_all
466 Decrement the refcnt of each remaining SV, possibly triggering a
467 cleanup. This function may have to be called multiple times to free
468 SVs which are in complex self-referential hierarchies.
474 Perl_sv_clean_all(pTHX)
477 PL_in_clean_all = TRUE;
478 cleaned = visit(do_clean_all, 0,0);
479 PL_in_clean_all = FALSE;
484 =for apidoc sv_free_arenas
486 Deallocate the memory used by all arenas. Note that all the individual SV
487 heads and bodies within the arenas must already have been freed.
493 Perl_sv_free_arenas(pTHX)
497 XPV *arena, *arenanext;
499 /* Free arenas here, but be careful about fake ones. (We assume
500 contiguity of the fake ones with the corresponding real ones.) */
502 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
503 svanext = (SV*) SvANY(sva);
504 while (svanext && SvFAKE(svanext))
505 svanext = (SV*) SvANY(svanext);
508 Safefree((void *)sva);
511 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
515 PL_xiv_arenaroot = 0;
518 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
522 PL_xnv_arenaroot = 0;
525 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
526 arenanext = (XPV*)arena->xpv_pv;
529 PL_xrv_arenaroot = 0;
532 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
536 PL_xpv_arenaroot = 0;
539 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
543 PL_xpviv_arenaroot = 0;
546 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
547 arenanext = (XPV*)arena->xpv_pv;
550 PL_xpvnv_arenaroot = 0;
553 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
554 arenanext = (XPV*)arena->xpv_pv;
557 PL_xpvcv_arenaroot = 0;
560 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
561 arenanext = (XPV*)arena->xpv_pv;
564 PL_xpvav_arenaroot = 0;
567 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
568 arenanext = (XPV*)arena->xpv_pv;
571 PL_xpvhv_arenaroot = 0;
574 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
575 arenanext = (XPV*)arena->xpv_pv;
578 PL_xpvmg_arenaroot = 0;
581 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
582 arenanext = (XPV*)arena->xpv_pv;
585 PL_xpvlv_arenaroot = 0;
588 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
589 arenanext = (XPV*)arena->xpv_pv;
592 PL_xpvbm_arenaroot = 0;
595 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
596 arenanext = (XPV*)arena->xpv_pv;
603 Safefree(PL_nice_chunk);
604 PL_nice_chunk = Nullch;
605 PL_nice_chunk_size = 0;
610 /* ---------------------------------------------------------------------
612 * support functions for report_uninit()
615 /* the maxiumum size of array or hash where we will scan looking
616 * for the undefined element that triggered the warning */
618 #define FUV_MAX_SEARCH_SIZE 1000
620 /* Look for an entry in the hash whose value has the same SV as val;
621 * If so, return a mortal copy of the key. */
624 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
630 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
631 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
636 for (i=HvMAX(hv); i>0; i--) {
637 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
638 if (HeVAL(entry) != val)
640 if ( HeVAL(entry) == &PL_sv_undef ||
641 HeVAL(entry) == &PL_sv_placeholder)
645 if (HeKLEN(entry) == HEf_SVKEY)
646 return sv_mortalcopy(HeKEY_sv(entry));
647 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
653 /* Look for an entry in the array whose value has the same SV as val;
654 * If so, return the index, otherwise return -1. */
657 S_find_array_subscript(pTHX_ AV *av, SV* val)
661 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
662 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
666 for (i=AvFILLp(av); i>=0; i--) {
667 if (svp[i] == val && svp[i] != &PL_sv_undef)
673 /* S_varname(): return the name of a variable, optionally with a subscript.
674 * If gv is non-zero, use the name of that global, along with gvtype (one
675 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
676 * targ. Depending on the value of the subscript_type flag, return:
679 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
680 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
681 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
682 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
685 S_varname(pTHX_ GV *gv, char *gvtype, PADOFFSET targ,
686 SV* keyname, I32 aindex, int subscript_type)
692 name = sv_newmortal();
695 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
696 * XXX get rid of all this if gv_fullnameX() ever supports this
700 HV *hv = GvSTASH(gv);
701 sv_setpv(name, gvtype);
704 else if (!HvNAME(hv))
708 if (strNE(p, "main")) {
710 sv_catpvn(name,"::", 2);
712 if (GvNAMELEN(gv)>= 1 &&
713 ((unsigned int)*GvNAME(gv)) <= 26)
715 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
716 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
719 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
723 CV *cv = find_runcv(&u);
724 if (!cv || !CvPADLIST(cv))
726 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
727 sv = *av_fetch(av, targ, FALSE);
728 /* SvLEN in a pad name is not to be trusted */
729 sv_setpv(name, SvPV_nolen(sv));
732 if (subscript_type == FUV_SUBSCRIPT_HASH) {
735 Perl_sv_catpvf(aTHX_ name, "{%s}",
736 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
739 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
741 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
743 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
744 sv_insert(name, 0, 0, "within ", 7);
751 =for apidoc find_uninit_var
753 Find the name of the undefined variable (if any) that caused the operator o
754 to issue a "Use of uninitialized value" warning.
755 If match is true, only return a name if it's value matches uninit_sv.
756 So roughly speaking, if a unary operator (such as OP_COS) generates a
757 warning, then following the direct child of the op may yield an
758 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
759 other hand, with OP_ADD there are two branches to follow, so we only print
760 the variable name if we get an exact match.
762 The name is returned as a mortal SV.
764 Assumes that PL_op is the op that originally triggered the error, and that
765 PL_comppad/PL_curpad points to the currently executing pad.
771 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
779 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
780 uninit_sv == &PL_sv_placeholder)))
783 switch (obase->op_type) {
790 bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
791 bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
794 int subscript_type = FUV_SUBSCRIPT_WITHIN;
796 if (pad) { /* @lex, %lex */
797 sv = PAD_SVl(obase->op_targ);
801 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
802 /* @global, %global */
803 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
806 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
808 else /* @{expr}, %{expr} */
809 return find_uninit_var(cUNOPx(obase)->op_first,
813 /* attempt to find a match within the aggregate */
815 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
817 subscript_type = FUV_SUBSCRIPT_HASH;
820 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
822 subscript_type = FUV_SUBSCRIPT_ARRAY;
825 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
828 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
829 keysv, index, subscript_type);
833 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
835 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
836 Nullsv, 0, FUV_SUBSCRIPT_NONE);
839 gv = cGVOPx_gv(obase);
840 if (!gv || (match && GvSV(gv) != uninit_sv))
842 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
845 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
847 av = (AV*)PAD_SV(obase->op_targ);
848 if (!av || SvRMAGICAL(av))
850 svp = av_fetch(av, (I32)obase->op_private, FALSE);
851 if (!svp || *svp != uninit_sv)
854 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
855 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
858 gv = cGVOPx_gv(obase);
863 if (!av || SvRMAGICAL(av))
865 svp = av_fetch(av, (I32)obase->op_private, FALSE);
866 if (!svp || *svp != uninit_sv)
869 return S_varname(aTHX_ gv, "$", 0,
870 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
875 o = cUNOPx(obase)->op_first;
876 if (!o || o->op_type != OP_NULL ||
877 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
879 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
884 /* $a[uninit_expr] or $h{uninit_expr} */
885 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
888 o = cBINOPx(obase)->op_first;
889 kid = cBINOPx(obase)->op_last;
891 /* get the av or hv, and optionally the gv */
893 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
894 sv = PAD_SV(o->op_targ);
896 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
897 && cUNOPo->op_first->op_type == OP_GV)
899 gv = cGVOPx_gv(cUNOPo->op_first);
902 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
907 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
908 /* index is constant */
912 if (obase->op_type == OP_HELEM) {
913 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
914 if (!he || HeVAL(he) != uninit_sv)
918 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
919 if (!svp || *svp != uninit_sv)
923 if (obase->op_type == OP_HELEM)
924 return S_varname(aTHX_ gv, "%", o->op_targ,
925 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
927 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
928 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
932 /* index is an expression;
933 * attempt to find a match within the aggregate */
934 if (obase->op_type == OP_HELEM) {
935 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
937 return S_varname(aTHX_ gv, "%", o->op_targ,
938 keysv, 0, FUV_SUBSCRIPT_HASH);
941 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
943 return S_varname(aTHX_ gv, "@", o->op_targ,
944 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
948 return S_varname(aTHX_ gv,
949 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
951 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
957 /* only examine RHS */
958 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
961 o = cUNOPx(obase)->op_first;
962 if (o->op_type == OP_PUSHMARK)
965 if (!o->op_sibling) {
966 /* one-arg version of open is highly magical */
968 if (o->op_type == OP_GV) { /* open FOO; */
970 if (match && GvSV(gv) != uninit_sv)
972 return S_varname(aTHX_ gv, "$", 0,
973 Nullsv, 0, FUV_SUBSCRIPT_NONE);
975 /* other possibilities not handled are:
976 * open $x; or open my $x; should return '${*$x}'
977 * open expr; should return '$'.expr ideally
983 /* ops where $_ may be an implicit arg */
987 if ( !(obase->op_flags & OPf_STACKED)) {
988 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
989 ? PAD_SVl(obase->op_targ)
1001 /* skip filehandle as it can't produce 'undef' warning */
1002 o = cUNOPx(obase)->op_first;
1003 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1004 o = o->op_sibling->op_sibling;
1011 match = 1; /* XS or custom code could trigger random warnings */
1016 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1017 return sv_2mortal(newSVpv("${$/}", 0));
1022 if (!(obase->op_flags & OPf_KIDS))
1024 o = cUNOPx(obase)->op_first;
1030 /* if all except one arg are constant, or have no side-effects,
1031 * or are optimized away, then it's unambiguous */
1033 for (kid=o; kid; kid = kid->op_sibling) {
1035 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1036 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1037 || (kid->op_type == OP_PUSHMARK)
1041 if (o2) { /* more than one found */
1048 return find_uninit_var(o2, uninit_sv, match);
1052 sv = find_uninit_var(o, uninit_sv, 1);
1064 =for apidoc report_uninit
1066 Print appropriate "Use of uninitialized variable" warning
1072 Perl_report_uninit(pTHX_ SV* uninit_sv)
1075 SV* varname = Nullsv;
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)
1765 MAGIC* magic = NULL;
1768 if (mt != SVt_PV && SvIsCOW(sv)) {
1769 sv_force_normal_flags(sv, 0);
1772 if (SvTYPE(sv) == mt)
1776 (void)SvOOK_off(sv);
1778 switch (SvTYPE(sv)) {
1799 else if (mt < SVt_PVIV)
1816 pv = (char*)SvRV(sv);
1836 else if (mt == SVt_NV)
1847 del_XPVIV(SvANY(sv));
1857 del_XPVNV(SvANY(sv));
1865 magic = SvMAGIC(sv);
1866 stash = SvSTASH(sv);
1867 del_XPVMG(SvANY(sv));
1870 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1873 SvFLAGS(sv) &= ~SVTYPEMASK;
1878 Perl_croak(aTHX_ "Can't upgrade to undef");
1880 SvANY(sv) = new_XIV();
1884 SvANY(sv) = new_XNV();
1888 SvANY(sv) = new_XRV();
1892 SvANY(sv) = new_XPV();
1898 SvANY(sv) = new_XPVIV();
1908 SvANY(sv) = new_XPVNV();
1916 SvANY(sv) = new_XPVMG();
1922 SvMAGIC(sv) = magic;
1923 SvSTASH(sv) = stash;
1926 SvANY(sv) = new_XPVLV();
1932 SvMAGIC(sv) = magic;
1933 SvSTASH(sv) = stash;
1945 SvANY(sv) = new_XPVAV();
1953 SvMAGIC(sv) = magic;
1954 SvSTASH(sv) = stash;
1957 AvFLAGS(sv) = AVf_REAL;
1960 SvANY(sv) = new_XPVHV();
1966 HvTOTALKEYS(sv) = 0;
1967 HvPLACEHOLDERS(sv) = 0;
1968 SvMAGIC(sv) = magic;
1969 SvSTASH(sv) = stash;
1976 SvANY(sv) = new_XPVCV();
1977 Zero(SvANY(sv), 1, XPVCV);
1983 SvMAGIC(sv) = magic;
1984 SvSTASH(sv) = stash;
1987 SvANY(sv) = new_XPVGV();
1993 SvMAGIC(sv) = magic;
1994 SvSTASH(sv) = stash;
2002 SvANY(sv) = new_XPVBM();
2008 SvMAGIC(sv) = magic;
2009 SvSTASH(sv) = stash;
2015 SvANY(sv) = new_XPVFM();
2016 Zero(SvANY(sv), 1, XPVFM);
2022 SvMAGIC(sv) = magic;
2023 SvSTASH(sv) = stash;
2026 SvANY(sv) = new_XPVIO();
2027 Zero(SvANY(sv), 1, XPVIO);
2033 SvMAGIC(sv) = magic;
2034 SvSTASH(sv) = stash;
2035 IoPAGE_LEN(sv) = 60;
2042 =for apidoc sv_backoff
2044 Remove any string offset. You should normally use the C<SvOOK_off> macro
2051 Perl_sv_backoff(pTHX_ register SV *sv)
2055 char *s = SvPVX(sv);
2056 SvLEN(sv) += SvIVX(sv);
2057 SvPVX(sv) -= SvIVX(sv);
2059 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2061 SvFLAGS(sv) &= ~SVf_OOK;
2068 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2069 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2070 Use the C<SvGROW> wrapper instead.
2076 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2080 #ifdef HAS_64K_LIMIT
2081 if (newlen >= 0x10000) {
2082 PerlIO_printf(Perl_debug_log,
2083 "Allocation too large: %"UVxf"\n", (UV)newlen);
2086 #endif /* HAS_64K_LIMIT */
2089 if (SvTYPE(sv) < SVt_PV) {
2090 sv_upgrade(sv, SVt_PV);
2093 else if (SvOOK(sv)) { /* pv is offset? */
2096 if (newlen > SvLEN(sv))
2097 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2098 #ifdef HAS_64K_LIMIT
2099 if (newlen >= 0x10000)
2106 if (newlen > SvLEN(sv)) { /* need more room? */
2107 if (SvLEN(sv) && s) {
2109 STRLEN l = malloced_size((void*)SvPVX(sv));
2115 Renew(s,newlen,char);
2118 New(703, s, newlen, char);
2119 if (SvPVX(sv) && SvCUR(sv)) {
2120 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2124 SvLEN_set(sv, newlen);
2130 =for apidoc sv_setiv
2132 Copies an integer into the given SV, upgrading first if necessary.
2133 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2139 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2141 SV_CHECK_THINKFIRST_COW_DROP(sv);
2142 switch (SvTYPE(sv)) {
2144 sv_upgrade(sv, SVt_IV);
2147 sv_upgrade(sv, SVt_PVNV);
2151 sv_upgrade(sv, SVt_PVIV);
2160 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2163 (void)SvIOK_only(sv); /* validate number */
2169 =for apidoc sv_setiv_mg
2171 Like C<sv_setiv>, but also handles 'set' magic.
2177 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2184 =for apidoc sv_setuv
2186 Copies an unsigned integer into the given SV, upgrading first if necessary.
2187 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2193 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2195 /* With these two if statements:
2196 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2199 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2201 If you wish to remove them, please benchmark to see what the effect is
2203 if (u <= (UV)IV_MAX) {
2204 sv_setiv(sv, (IV)u);
2213 =for apidoc sv_setuv_mg
2215 Like C<sv_setuv>, but also handles 'set' magic.
2221 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2223 /* With these two if statements:
2224 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2227 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2229 If you wish to remove them, please benchmark to see what the effect is
2231 if (u <= (UV)IV_MAX) {
2232 sv_setiv(sv, (IV)u);
2242 =for apidoc sv_setnv
2244 Copies a double into the given SV, upgrading first if necessary.
2245 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2251 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2253 SV_CHECK_THINKFIRST_COW_DROP(sv);
2254 switch (SvTYPE(sv)) {
2257 sv_upgrade(sv, SVt_NV);
2262 sv_upgrade(sv, SVt_PVNV);
2271 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2275 (void)SvNOK_only(sv); /* validate number */
2280 =for apidoc sv_setnv_mg
2282 Like C<sv_setnv>, but also handles 'set' magic.
2288 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2294 /* Print an "isn't numeric" warning, using a cleaned-up,
2295 * printable version of the offending string
2299 S_not_a_number(pTHX_ SV *sv)
2306 dsv = sv_2mortal(newSVpv("", 0));
2307 pv = sv_uni_display(dsv, sv, 10, 0);
2310 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2311 /* each *s can expand to 4 chars + "...\0",
2312 i.e. need room for 8 chars */
2315 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2317 if (ch & 128 && !isPRINT_LC(ch)) {
2326 else if (ch == '\r') {
2330 else if (ch == '\f') {
2334 else if (ch == '\\') {
2338 else if (ch == '\0') {
2342 else if (isPRINT_LC(ch))
2359 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2360 "Argument \"%s\" isn't numeric in %s", pv,
2363 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2364 "Argument \"%s\" isn't numeric", pv);
2368 =for apidoc looks_like_number
2370 Test if the content of an SV looks like a number (or is a number).
2371 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2372 non-numeric warning), even if your atof() doesn't grok them.
2378 Perl_looks_like_number(pTHX_ SV *sv)
2380 register char *sbegin;
2387 else if (SvPOKp(sv))
2388 sbegin = SvPV(sv, len);
2390 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2391 return grok_number(sbegin, len, NULL);
2394 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2395 until proven guilty, assume that things are not that bad... */
2400 As 64 bit platforms often have an NV that doesn't preserve all bits of
2401 an IV (an assumption perl has been based on to date) it becomes necessary
2402 to remove the assumption that the NV always carries enough precision to
2403 recreate the IV whenever needed, and that the NV is the canonical form.
2404 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2405 precision as a side effect of conversion (which would lead to insanity
2406 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2407 1) to distinguish between IV/UV/NV slots that have cached a valid
2408 conversion where precision was lost and IV/UV/NV slots that have a
2409 valid conversion which has lost no precision
2410 2) to ensure that if a numeric conversion to one form is requested that
2411 would lose precision, the precise conversion (or differently
2412 imprecise conversion) is also performed and cached, to prevent
2413 requests for different numeric formats on the same SV causing
2414 lossy conversion chains. (lossless conversion chains are perfectly
2419 SvIOKp is true if the IV slot contains a valid value
2420 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2421 SvNOKp is true if the NV slot contains a valid value
2422 SvNOK is true only if the NV value is accurate
2425 while converting from PV to NV, check to see if converting that NV to an
2426 IV(or UV) would lose accuracy over a direct conversion from PV to
2427 IV(or UV). If it would, cache both conversions, return NV, but mark
2428 SV as IOK NOKp (ie not NOK).
2430 While converting from PV to IV, check to see if converting that IV to an
2431 NV would lose accuracy over a direct conversion from PV to NV. If it
2432 would, cache both conversions, flag similarly.
2434 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2435 correctly because if IV & NV were set NV *always* overruled.
2436 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2437 changes - now IV and NV together means that the two are interchangeable:
2438 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2440 The benefit of this is that operations such as pp_add know that if
2441 SvIOK is true for both left and right operands, then integer addition
2442 can be used instead of floating point (for cases where the result won't
2443 overflow). Before, floating point was always used, which could lead to
2444 loss of precision compared with integer addition.
2446 * making IV and NV equal status should make maths accurate on 64 bit
2448 * may speed up maths somewhat if pp_add and friends start to use
2449 integers when possible instead of fp. (Hopefully the overhead in
2450 looking for SvIOK and checking for overflow will not outweigh the
2451 fp to integer speedup)
2452 * will slow down integer operations (callers of SvIV) on "inaccurate"
2453 values, as the change from SvIOK to SvIOKp will cause a call into
2454 sv_2iv each time rather than a macro access direct to the IV slot
2455 * should speed up number->string conversion on integers as IV is
2456 favoured when IV and NV are equally accurate
2458 ####################################################################
2459 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2460 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2461 On the other hand, SvUOK is true iff UV.
2462 ####################################################################
2464 Your mileage will vary depending your CPU's relative fp to integer
2468 #ifndef NV_PRESERVES_UV
2469 # define IS_NUMBER_UNDERFLOW_IV 1
2470 # define IS_NUMBER_UNDERFLOW_UV 2
2471 # define IS_NUMBER_IV_AND_UV 2
2472 # define IS_NUMBER_OVERFLOW_IV 4
2473 # define IS_NUMBER_OVERFLOW_UV 5
2475 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2477 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2479 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2481 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));
2482 if (SvNVX(sv) < (NV)IV_MIN) {
2483 (void)SvIOKp_on(sv);
2486 return IS_NUMBER_UNDERFLOW_IV;
2488 if (SvNVX(sv) > (NV)UV_MAX) {
2489 (void)SvIOKp_on(sv);
2493 return IS_NUMBER_OVERFLOW_UV;
2495 (void)SvIOKp_on(sv);
2497 /* Can't use strtol etc to convert this string. (See truth table in
2499 if (SvNVX(sv) <= (UV)IV_MAX) {
2500 SvIVX(sv) = I_V(SvNVX(sv));
2501 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2502 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2504 /* Integer is imprecise. NOK, IOKp */
2506 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2509 SvUVX(sv) = U_V(SvNVX(sv));
2510 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2511 if (SvUVX(sv) == UV_MAX) {
2512 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2513 possibly be preserved by NV. Hence, it must be overflow.
2515 return IS_NUMBER_OVERFLOW_UV;
2517 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2519 /* Integer is imprecise. NOK, IOKp */
2521 return IS_NUMBER_OVERFLOW_IV;
2523 #endif /* !NV_PRESERVES_UV*/
2525 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2526 * this function provided for binary compatibility only
2530 Perl_sv_2iv(pTHX_ register SV *sv)
2532 return sv_2iv_flags(sv, SV_GMAGIC);
2536 =for apidoc sv_2iv_flags
2538 Return the integer value of an SV, doing any necessary string
2539 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2540 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2546 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2550 if (SvGMAGICAL(sv)) {
2551 if (flags & SV_GMAGIC)
2556 return I_V(SvNVX(sv));
2558 if (SvPOKp(sv) && SvLEN(sv))
2561 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2562 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2568 if (SvTHINKFIRST(sv)) {
2571 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2572 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2573 return SvIV(tmpstr);
2574 return PTR2IV(SvRV(sv));
2577 sv_force_normal_flags(sv, 0);
2579 if (SvREADONLY(sv) && !SvOK(sv)) {
2580 if (ckWARN(WARN_UNINITIALIZED))
2587 return (IV)(SvUVX(sv));
2594 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2595 * without also getting a cached IV/UV from it at the same time
2596 * (ie PV->NV conversion should detect loss of accuracy and cache
2597 * IV or UV at same time to avoid this. NWC */
2599 if (SvTYPE(sv) == SVt_NV)
2600 sv_upgrade(sv, SVt_PVNV);
2602 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2603 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2604 certainly cast into the IV range at IV_MAX, whereas the correct
2605 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2607 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2608 SvIVX(sv) = I_V(SvNVX(sv));
2609 if (SvNVX(sv) == (NV) SvIVX(sv)
2610 #ifndef NV_PRESERVES_UV
2611 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2612 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2613 /* Don't flag it as "accurately an integer" if the number
2614 came from a (by definition imprecise) NV operation, and
2615 we're outside the range of NV integer precision */
2618 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2619 DEBUG_c(PerlIO_printf(Perl_debug_log,
2620 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2626 /* IV not precise. No need to convert from PV, as NV
2627 conversion would already have cached IV if it detected
2628 that PV->IV would be better than PV->NV->IV
2629 flags already correct - don't set public IOK. */
2630 DEBUG_c(PerlIO_printf(Perl_debug_log,
2631 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2636 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2637 but the cast (NV)IV_MIN rounds to a the value less (more
2638 negative) than IV_MIN which happens to be equal to SvNVX ??
2639 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2640 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2641 (NV)UVX == NVX are both true, but the values differ. :-(
2642 Hopefully for 2s complement IV_MIN is something like
2643 0x8000000000000000 which will be exact. NWC */
2646 SvUVX(sv) = U_V(SvNVX(sv));
2648 (SvNVX(sv) == (NV) SvUVX(sv))
2649 #ifndef NV_PRESERVES_UV
2650 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2651 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2652 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2653 /* Don't flag it as "accurately an integer" if the number
2654 came from a (by definition imprecise) NV operation, and
2655 we're outside the range of NV integer precision */
2661 DEBUG_c(PerlIO_printf(Perl_debug_log,
2662 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2666 return (IV)SvUVX(sv);
2669 else if (SvPOKp(sv) && SvLEN(sv)) {
2671 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2672 /* We want to avoid a possible problem when we cache an IV which
2673 may be later translated to an NV, and the resulting NV is not
2674 the same as the direct translation of the initial string
2675 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2676 be careful to ensure that the value with the .456 is around if the
2677 NV value is requested in the future).
2679 This means that if we cache such an IV, we need to cache the
2680 NV as well. Moreover, we trade speed for space, and do not
2681 cache the NV if we are sure it's not needed.
2684 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2685 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2686 == IS_NUMBER_IN_UV) {
2687 /* It's definitely an integer, only upgrade to PVIV */
2688 if (SvTYPE(sv) < SVt_PVIV)
2689 sv_upgrade(sv, SVt_PVIV);
2691 } else if (SvTYPE(sv) < SVt_PVNV)
2692 sv_upgrade(sv, SVt_PVNV);
2694 /* If NV preserves UV then we only use the UV value if we know that
2695 we aren't going to call atof() below. If NVs don't preserve UVs
2696 then the value returned may have more precision than atof() will
2697 return, even though value isn't perfectly accurate. */
2698 if ((numtype & (IS_NUMBER_IN_UV
2699 #ifdef NV_PRESERVES_UV
2702 )) == IS_NUMBER_IN_UV) {
2703 /* This won't turn off the public IOK flag if it was set above */
2704 (void)SvIOKp_on(sv);
2706 if (!(numtype & IS_NUMBER_NEG)) {
2708 if (value <= (UV)IV_MAX) {
2709 SvIVX(sv) = (IV)value;
2715 /* 2s complement assumption */
2716 if (value <= (UV)IV_MIN) {
2717 SvIVX(sv) = -(IV)value;
2719 /* Too negative for an IV. This is a double upgrade, but
2720 I'm assuming it will be rare. */
2721 if (SvTYPE(sv) < SVt_PVNV)
2722 sv_upgrade(sv, SVt_PVNV);
2726 SvNVX(sv) = -(NV)value;
2731 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2732 will be in the previous block to set the IV slot, and the next
2733 block to set the NV slot. So no else here. */
2735 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2736 != IS_NUMBER_IN_UV) {
2737 /* It wasn't an (integer that doesn't overflow the UV). */
2738 SvNVX(sv) = Atof(SvPVX(sv));
2740 if (! numtype && ckWARN(WARN_NUMERIC))
2743 #if defined(USE_LONG_DOUBLE)
2744 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2745 PTR2UV(sv), SvNVX(sv)));
2747 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2748 PTR2UV(sv), SvNVX(sv)));
2752 #ifdef NV_PRESERVES_UV
2753 (void)SvIOKp_on(sv);
2755 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2756 SvIVX(sv) = I_V(SvNVX(sv));
2757 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2760 /* Integer is imprecise. NOK, IOKp */
2762 /* UV will not work better than IV */
2764 if (SvNVX(sv) > (NV)UV_MAX) {
2766 /* Integer is inaccurate. NOK, IOKp, is UV */
2770 SvUVX(sv) = U_V(SvNVX(sv));
2771 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2772 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2776 /* Integer is imprecise. NOK, IOKp, is UV */
2782 #else /* NV_PRESERVES_UV */
2783 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2784 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2785 /* The IV slot will have been set from value returned by
2786 grok_number above. The NV slot has just been set using
2789 assert (SvIOKp(sv));
2791 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2792 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2793 /* Small enough to preserve all bits. */
2794 (void)SvIOKp_on(sv);
2796 SvIVX(sv) = I_V(SvNVX(sv));
2797 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2799 /* Assumption: first non-preserved integer is < IV_MAX,
2800 this NV is in the preserved range, therefore: */
2801 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2803 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);
2807 0 0 already failed to read UV.
2808 0 1 already failed to read UV.
2809 1 0 you won't get here in this case. IV/UV
2810 slot set, public IOK, Atof() unneeded.
2811 1 1 already read UV.
2812 so there's no point in sv_2iuv_non_preserve() attempting
2813 to use atol, strtol, strtoul etc. */
2814 if (sv_2iuv_non_preserve (sv, numtype)
2815 >= IS_NUMBER_OVERFLOW_IV)
2819 #endif /* NV_PRESERVES_UV */
2822 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2824 if (SvTYPE(sv) < SVt_IV)
2825 /* Typically the caller expects that sv_any is not NULL now. */
2826 sv_upgrade(sv, SVt_IV);
2829 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2830 PTR2UV(sv),SvIVX(sv)));
2831 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2834 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2835 * this function provided for binary compatibility only
2839 Perl_sv_2uv(pTHX_ register SV *sv)
2841 return sv_2uv_flags(sv, SV_GMAGIC);
2845 =for apidoc sv_2uv_flags
2847 Return the unsigned integer value of an SV, doing any necessary string
2848 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2849 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2855 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2859 if (SvGMAGICAL(sv)) {
2860 if (flags & SV_GMAGIC)
2865 return U_V(SvNVX(sv));
2866 if (SvPOKp(sv) && SvLEN(sv))
2869 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2870 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2876 if (SvTHINKFIRST(sv)) {
2879 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2880 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2881 return SvUV(tmpstr);
2882 return PTR2UV(SvRV(sv));
2885 sv_force_normal_flags(sv, 0);
2887 if (SvREADONLY(sv) && !SvOK(sv)) {
2888 if (ckWARN(WARN_UNINITIALIZED))
2898 return (UV)SvIVX(sv);
2902 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2903 * without also getting a cached IV/UV from it at the same time
2904 * (ie PV->NV conversion should detect loss of accuracy and cache
2905 * IV or UV at same time to avoid this. */
2906 /* IV-over-UV optimisation - choose to cache IV if possible */
2908 if (SvTYPE(sv) == SVt_NV)
2909 sv_upgrade(sv, SVt_PVNV);
2911 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2912 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2913 SvIVX(sv) = I_V(SvNVX(sv));
2914 if (SvNVX(sv) == (NV) SvIVX(sv)
2915 #ifndef NV_PRESERVES_UV
2916 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2917 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2918 /* Don't flag it as "accurately an integer" if the number
2919 came from a (by definition imprecise) NV operation, and
2920 we're outside the range of NV integer precision */
2923 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2924 DEBUG_c(PerlIO_printf(Perl_debug_log,
2925 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2931 /* IV not precise. No need to convert from PV, as NV
2932 conversion would already have cached IV if it detected
2933 that PV->IV would be better than PV->NV->IV
2934 flags already correct - don't set public IOK. */
2935 DEBUG_c(PerlIO_printf(Perl_debug_log,
2936 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2941 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2942 but the cast (NV)IV_MIN rounds to a the value less (more
2943 negative) than IV_MIN which happens to be equal to SvNVX ??
2944 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2945 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2946 (NV)UVX == NVX are both true, but the values differ. :-(
2947 Hopefully for 2s complement IV_MIN is something like
2948 0x8000000000000000 which will be exact. NWC */
2951 SvUVX(sv) = U_V(SvNVX(sv));
2953 (SvNVX(sv) == (NV) SvUVX(sv))
2954 #ifndef NV_PRESERVES_UV
2955 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2956 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2957 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2958 /* Don't flag it as "accurately an integer" if the number
2959 came from a (by definition imprecise) NV operation, and
2960 we're outside the range of NV integer precision */
2965 DEBUG_c(PerlIO_printf(Perl_debug_log,
2966 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2972 else if (SvPOKp(sv) && SvLEN(sv)) {
2974 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2976 /* We want to avoid a possible problem when we cache a UV which
2977 may be later translated to an NV, and the resulting NV is not
2978 the translation of the initial data.
2980 This means that if we cache such a UV, we need to cache the
2981 NV as well. Moreover, we trade speed for space, and do not
2982 cache the NV if not needed.
2985 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2986 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2987 == IS_NUMBER_IN_UV) {
2988 /* It's definitely an integer, only upgrade to PVIV */
2989 if (SvTYPE(sv) < SVt_PVIV)
2990 sv_upgrade(sv, SVt_PVIV);
2992 } else if (SvTYPE(sv) < SVt_PVNV)
2993 sv_upgrade(sv, SVt_PVNV);
2995 /* If NV preserves UV then we only use the UV value if we know that
2996 we aren't going to call atof() below. If NVs don't preserve UVs
2997 then the value returned may have more precision than atof() will
2998 return, even though it isn't accurate. */
2999 if ((numtype & (IS_NUMBER_IN_UV
3000 #ifdef NV_PRESERVES_UV
3003 )) == IS_NUMBER_IN_UV) {
3004 /* This won't turn off the public IOK flag if it was set above */
3005 (void)SvIOKp_on(sv);
3007 if (!(numtype & IS_NUMBER_NEG)) {
3009 if (value <= (UV)IV_MAX) {
3010 SvIVX(sv) = (IV)value;
3012 /* it didn't overflow, and it was positive. */
3017 /* 2s complement assumption */
3018 if (value <= (UV)IV_MIN) {
3019 SvIVX(sv) = -(IV)value;
3021 /* Too negative for an IV. This is a double upgrade, but
3022 I'm assuming it will be rare. */
3023 if (SvTYPE(sv) < SVt_PVNV)
3024 sv_upgrade(sv, SVt_PVNV);
3028 SvNVX(sv) = -(NV)value;
3034 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3035 != IS_NUMBER_IN_UV) {
3036 /* It wasn't an integer, or it overflowed the UV. */
3037 SvNVX(sv) = Atof(SvPVX(sv));
3039 if (! numtype && ckWARN(WARN_NUMERIC))
3042 #if defined(USE_LONG_DOUBLE)
3043 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3044 PTR2UV(sv), SvNVX(sv)));
3046 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3047 PTR2UV(sv), SvNVX(sv)));
3050 #ifdef NV_PRESERVES_UV
3051 (void)SvIOKp_on(sv);
3053 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3054 SvIVX(sv) = I_V(SvNVX(sv));
3055 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3058 /* Integer is imprecise. NOK, IOKp */
3060 /* UV will not work better than IV */
3062 if (SvNVX(sv) > (NV)UV_MAX) {
3064 /* Integer is inaccurate. NOK, IOKp, is UV */
3068 SvUVX(sv) = U_V(SvNVX(sv));
3069 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3070 NV preservse UV so can do correct comparison. */
3071 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3075 /* Integer is imprecise. NOK, IOKp, is UV */
3080 #else /* NV_PRESERVES_UV */
3081 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3082 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3083 /* The UV slot will have been set from value returned by
3084 grok_number above. The NV slot has just been set using
3087 assert (SvIOKp(sv));
3089 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3090 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3091 /* Small enough to preserve all bits. */
3092 (void)SvIOKp_on(sv);
3094 SvIVX(sv) = I_V(SvNVX(sv));
3095 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3097 /* Assumption: first non-preserved integer is < IV_MAX,
3098 this NV is in the preserved range, therefore: */
3099 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3101 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);
3104 sv_2iuv_non_preserve (sv, numtype);
3106 #endif /* NV_PRESERVES_UV */
3110 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3111 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3114 if (SvTYPE(sv) < SVt_IV)
3115 /* Typically the caller expects that sv_any is not NULL now. */
3116 sv_upgrade(sv, SVt_IV);
3120 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3121 PTR2UV(sv),SvUVX(sv)));
3122 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3128 Return the num value of an SV, doing any necessary string or integer
3129 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3136 Perl_sv_2nv(pTHX_ register SV *sv)
3140 if (SvGMAGICAL(sv)) {
3144 if (SvPOKp(sv) && SvLEN(sv)) {
3145 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3146 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3148 return Atof(SvPVX(sv));
3152 return (NV)SvUVX(sv);
3154 return (NV)SvIVX(sv);
3157 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3158 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3164 if (SvTHINKFIRST(sv)) {
3167 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3168 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3169 return SvNV(tmpstr);
3170 return PTR2NV(SvRV(sv));
3173 sv_force_normal_flags(sv, 0);
3175 if (SvREADONLY(sv) && !SvOK(sv)) {
3176 if (ckWARN(WARN_UNINITIALIZED))
3181 if (SvTYPE(sv) < SVt_NV) {
3182 if (SvTYPE(sv) == SVt_IV)
3183 sv_upgrade(sv, SVt_PVNV);
3185 sv_upgrade(sv, SVt_NV);
3186 #ifdef USE_LONG_DOUBLE
3188 STORE_NUMERIC_LOCAL_SET_STANDARD();
3189 PerlIO_printf(Perl_debug_log,
3190 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3191 PTR2UV(sv), SvNVX(sv));
3192 RESTORE_NUMERIC_LOCAL();
3196 STORE_NUMERIC_LOCAL_SET_STANDARD();
3197 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3198 PTR2UV(sv), SvNVX(sv));
3199 RESTORE_NUMERIC_LOCAL();
3203 else if (SvTYPE(sv) < SVt_PVNV)
3204 sv_upgrade(sv, SVt_PVNV);
3209 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
3210 #ifdef NV_PRESERVES_UV
3213 /* Only set the public NV OK flag if this NV preserves the IV */
3214 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3215 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3216 : (SvIVX(sv) == I_V(SvNVX(sv))))
3222 else if (SvPOKp(sv) && SvLEN(sv)) {
3224 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3225 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3227 #ifdef NV_PRESERVES_UV
3228 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3229 == IS_NUMBER_IN_UV) {
3230 /* It's definitely an integer */
3231 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3233 SvNVX(sv) = Atof(SvPVX(sv));
3236 SvNVX(sv) = Atof(SvPVX(sv));
3237 /* Only set the public NV OK flag if this NV preserves the value in
3238 the PV at least as well as an IV/UV would.
3239 Not sure how to do this 100% reliably. */
3240 /* if that shift count is out of range then Configure's test is
3241 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3243 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3244 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3245 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3246 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3247 /* Can't use strtol etc to convert this string, so don't try.
3248 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3251 /* value has been set. It may not be precise. */
3252 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3253 /* 2s complement assumption for (UV)IV_MIN */
3254 SvNOK_on(sv); /* Integer is too negative. */
3259 if (numtype & IS_NUMBER_NEG) {
3260 SvIVX(sv) = -(IV)value;
3261 } else if (value <= (UV)IV_MAX) {
3262 SvIVX(sv) = (IV)value;
3268 if (numtype & IS_NUMBER_NOT_INT) {
3269 /* I believe that even if the original PV had decimals,
3270 they are lost beyond the limit of the FP precision.
3271 However, neither is canonical, so both only get p
3272 flags. NWC, 2000/11/25 */
3273 /* Both already have p flags, so do nothing */
3276 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3277 if (SvIVX(sv) == I_V(nv)) {
3282 /* It had no "." so it must be integer. */
3285 /* between IV_MAX and NV(UV_MAX).
3286 Could be slightly > UV_MAX */
3288 if (numtype & IS_NUMBER_NOT_INT) {
3289 /* UV and NV both imprecise. */
3291 UV nv_as_uv = U_V(nv);
3293 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3304 #endif /* NV_PRESERVES_UV */
3307 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3309 if (SvTYPE(sv) < SVt_NV)
3310 /* Typically the caller expects that sv_any is not NULL now. */
3311 /* XXX Ilya implies that this is a bug in callers that assume this
3312 and ideally should be fixed. */
3313 sv_upgrade(sv, SVt_NV);
3316 #if defined(USE_LONG_DOUBLE)
3318 STORE_NUMERIC_LOCAL_SET_STANDARD();
3319 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3320 PTR2UV(sv), SvNVX(sv));
3321 RESTORE_NUMERIC_LOCAL();
3325 STORE_NUMERIC_LOCAL_SET_STANDARD();
3326 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3327 PTR2UV(sv), SvNVX(sv));
3328 RESTORE_NUMERIC_LOCAL();
3334 /* asIV(): extract an integer from the string value of an SV.
3335 * Caller must validate PVX */
3338 S_asIV(pTHX_ SV *sv)
3341 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3343 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3344 == IS_NUMBER_IN_UV) {
3345 /* It's definitely an integer */
3346 if (numtype & IS_NUMBER_NEG) {
3347 if (value < (UV)IV_MIN)
3350 if (value < (UV)IV_MAX)
3355 if (ckWARN(WARN_NUMERIC))
3358 return I_V(Atof(SvPVX(sv)));
3361 /* asUV(): extract an unsigned integer from the string value of an SV
3362 * Caller must validate PVX */
3365 S_asUV(pTHX_ SV *sv)
3368 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3370 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3371 == IS_NUMBER_IN_UV) {
3372 /* It's definitely an integer */
3373 if (!(numtype & IS_NUMBER_NEG))
3377 if (ckWARN(WARN_NUMERIC))
3380 return U_V(Atof(SvPVX(sv)));
3384 =for apidoc sv_2pv_nolen
3386 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3387 use the macro wrapper C<SvPV_nolen(sv)> instead.
3392 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3395 return sv_2pv(sv, &n_a);
3398 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3399 * UV as a string towards the end of buf, and return pointers to start and
3402 * We assume that buf is at least TYPE_CHARS(UV) long.
3406 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3408 char *ptr = buf + TYPE_CHARS(UV);
3422 *--ptr = '0' + (char)(uv % 10);
3430 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3431 * this function provided for binary compatibility only
3435 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3437 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3441 =for apidoc sv_2pv_flags
3443 Returns a pointer to the string value of an SV, and sets *lp to its length.
3444 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3446 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3447 usually end up here too.
3453 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3458 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3459 char *tmpbuf = tbuf;
3465 if (SvGMAGICAL(sv)) {
3466 if (flags & SV_GMAGIC)
3474 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3476 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3481 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3486 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3487 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3494 if (SvTHINKFIRST(sv)) {
3497 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3498 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3499 char *pv = SvPV(tmpstr, *lp);
3513 switch (SvTYPE(sv)) {
3515 if ( ((SvFLAGS(sv) &
3516 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3517 == (SVs_OBJECT|SVs_SMG))
3518 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3519 regexp *re = (regexp *)mg->mg_obj;
3522 char *fptr = "msix";
3527 char need_newline = 0;
3528 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3530 while((ch = *fptr++)) {
3532 reflags[left++] = ch;
3535 reflags[right--] = ch;
3540 reflags[left] = '-';
3544 mg->mg_len = re->prelen + 4 + left;
3546 * If /x was used, we have to worry about a regex
3547 * ending with a comment later being embedded
3548 * within another regex. If so, we don't want this
3549 * regex's "commentization" to leak out to the
3550 * right part of the enclosing regex, we must cap
3551 * it with a newline.
3553 * So, if /x was used, we scan backwards from the
3554 * end of the regex. If we find a '#' before we
3555 * find a newline, we need to add a newline
3556 * ourself. If we find a '\n' first (or if we
3557 * don't find '#' or '\n'), we don't need to add
3558 * anything. -jfriedl
3560 if (PMf_EXTENDED & re->reganch)
3562 char *endptr = re->precomp + re->prelen;
3563 while (endptr >= re->precomp)
3565 char c = *(endptr--);
3567 break; /* don't need another */
3569 /* we end while in a comment, so we
3571 mg->mg_len++; /* save space for it */
3572 need_newline = 1; /* note to add it */
3578 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3579 Copy("(?", mg->mg_ptr, 2, char);
3580 Copy(reflags, mg->mg_ptr+2, left, char);
3581 Copy(":", mg->mg_ptr+left+2, 1, char);
3582 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3584 mg->mg_ptr[mg->mg_len - 2] = '\n';
3585 mg->mg_ptr[mg->mg_len - 1] = ')';
3586 mg->mg_ptr[mg->mg_len] = 0;
3588 PL_reginterp_cnt += re->program[0].next_off;
3590 if (re->reganch & ROPT_UTF8)
3605 case SVt_PVBM: if (SvROK(sv))
3608 s = "SCALAR"; break;
3609 case SVt_PVLV: s = SvROK(sv) ? "REF"
3610 /* tied lvalues should appear to be
3611 * scalars for backwards compatitbility */
3612 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3613 ? "SCALAR" : "LVALUE"; break;
3614 case SVt_PVAV: s = "ARRAY"; break;
3615 case SVt_PVHV: s = "HASH"; break;
3616 case SVt_PVCV: s = "CODE"; break;
3617 case SVt_PVGV: s = "GLOB"; break;
3618 case SVt_PVFM: s = "FORMAT"; break;
3619 case SVt_PVIO: s = "IO"; break;
3620 default: s = "UNKNOWN"; break;
3624 if (HvNAME(SvSTASH(sv)))
3625 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3627 Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3630 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3636 if (SvREADONLY(sv) && !SvOK(sv)) {
3637 if (ckWARN(WARN_UNINITIALIZED))
3643 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3644 /* I'm assuming that if both IV and NV are equally valid then
3645 converting the IV is going to be more efficient */
3646 U32 isIOK = SvIOK(sv);
3647 U32 isUIOK = SvIsUV(sv);
3648 char buf[TYPE_CHARS(UV)];
3651 if (SvTYPE(sv) < SVt_PVIV)
3652 sv_upgrade(sv, SVt_PVIV);
3654 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3656 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3657 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3658 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3659 SvCUR_set(sv, ebuf - ptr);
3669 else if (SvNOKp(sv)) {
3670 if (SvTYPE(sv) < SVt_PVNV)
3671 sv_upgrade(sv, SVt_PVNV);
3672 /* The +20 is pure guesswork. Configure test needed. --jhi */
3673 SvGROW(sv, NV_DIG + 20);
3675 olderrno = errno; /* some Xenix systems wipe out errno here */
3677 if (SvNVX(sv) == 0.0)
3678 (void)strcpy(s,"0");
3682 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3685 #ifdef FIXNEGATIVEZERO
3686 if (*s == '-' && s[1] == '0' && !s[2])
3696 if (ckWARN(WARN_UNINITIALIZED)
3697 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3700 if (SvTYPE(sv) < SVt_PV)
3701 /* Typically the caller expects that sv_any is not NULL now. */
3702 sv_upgrade(sv, SVt_PV);
3705 *lp = s - SvPVX(sv);
3708 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3709 PTR2UV(sv),SvPVX(sv)));
3713 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3714 /* Sneaky stuff here */
3718 tsv = newSVpv(tmpbuf, 0);
3734 len = strlen(tmpbuf);
3736 #ifdef FIXNEGATIVEZERO
3737 if (len == 2 && t[0] == '-' && t[1] == '0') {
3742 (void)SvUPGRADE(sv, SVt_PV);
3744 s = SvGROW(sv, len + 1);
3747 return strcpy(s, t);
3752 =for apidoc sv_copypv
3754 Copies a stringified representation of the source SV into the
3755 destination SV. Automatically performs any necessary mg_get and
3756 coercion of numeric values into strings. Guaranteed to preserve
3757 UTF-8 flag even from overloaded objects. Similar in nature to
3758 sv_2pv[_flags] but operates directly on an SV instead of just the
3759 string. Mostly uses sv_2pv_flags to do its work, except when that
3760 would lose the UTF-8'ness of the PV.
3766 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3771 sv_setpvn(dsv,s,len);
3779 =for apidoc sv_2pvbyte_nolen
3781 Return a pointer to the byte-encoded representation of the SV.
3782 May cause the SV to be downgraded from UTF-8 as a side-effect.
3784 Usually accessed via the C<SvPVbyte_nolen> macro.
3790 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3793 return sv_2pvbyte(sv, &n_a);
3797 =for apidoc sv_2pvbyte
3799 Return a pointer to the byte-encoded representation of the SV, and set *lp
3800 to its length. May cause the SV to be downgraded from UTF-8 as a
3803 Usually accessed via the C<SvPVbyte> macro.
3809 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3811 sv_utf8_downgrade(sv,0);
3812 return SvPV(sv,*lp);
3816 =for apidoc sv_2pvutf8_nolen
3818 Return a pointer to the UTF-8-encoded representation of the SV.
3819 May cause the SV to be upgraded to UTF-8 as a side-effect.
3821 Usually accessed via the C<SvPVutf8_nolen> macro.
3827 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3830 return sv_2pvutf8(sv, &n_a);
3834 =for apidoc sv_2pvutf8
3836 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3837 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3839 Usually accessed via the C<SvPVutf8> macro.
3845 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3847 sv_utf8_upgrade(sv);
3848 return SvPV(sv,*lp);
3852 =for apidoc sv_2bool
3854 This function is only called on magical items, and is only used by
3855 sv_true() or its macro equivalent.
3861 Perl_sv_2bool(pTHX_ register SV *sv)
3870 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3871 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3872 return (bool)SvTRUE(tmpsv);
3873 return SvRV(sv) != 0;
3876 register XPV* Xpvtmp;
3877 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3878 (*Xpvtmp->xpv_pv > '0' ||
3879 Xpvtmp->xpv_cur > 1 ||
3880 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3887 return SvIVX(sv) != 0;
3890 return SvNVX(sv) != 0.0;
3897 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3898 * this function provided for binary compatibility only
3903 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3905 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3909 =for apidoc sv_utf8_upgrade
3911 Converts the PV of an SV to its UTF-8-encoded form.
3912 Forces the SV to string form if it is not already.
3913 Always sets the SvUTF8 flag to avoid future validity checks even
3914 if all the bytes have hibit clear.
3916 This is not as a general purpose byte encoding to Unicode interface:
3917 use the Encode extension for that.
3919 =for apidoc sv_utf8_upgrade_flags
3921 Converts the PV of an SV to its UTF-8-encoded form.
3922 Forces the SV to string form if it is not already.
3923 Always sets the SvUTF8 flag to avoid future validity checks even
3924 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3925 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3926 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3928 This is not as a general purpose byte encoding to Unicode interface:
3929 use the Encode extension for that.
3935 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3940 if (sv == &PL_sv_undef)
3944 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3945 (void) sv_2pv_flags(sv,&len, flags);
3949 (void) SvPV_force(sv,len);
3958 sv_force_normal_flags(sv, 0);
3961 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3962 sv_recode_to_utf8(sv, PL_encoding);
3963 else { /* Assume Latin-1/EBCDIC */
3964 /* This function could be much more efficient if we
3965 * had a FLAG in SVs to signal if there are any hibit
3966 * chars in the PV. Given that there isn't such a flag
3967 * make the loop as fast as possible. */
3968 s = (U8 *) SvPVX(sv);
3969 e = (U8 *) SvEND(sv);
3973 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3978 (void)SvOOK_off(sv);
3980 len = SvCUR(sv) + 1; /* Plus the \0 */
3981 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3982 SvCUR(sv) = len - 1;
3984 Safefree(s); /* No longer using what was there before. */
3985 SvLEN(sv) = len; /* No longer know the real size. */
3987 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3994 =for apidoc sv_utf8_downgrade
3996 Attempts to convert the PV of an SV from characters to bytes.
3997 If the PV contains a character beyond byte, this conversion will fail;
3998 in this case, either returns false or, if C<fail_ok> is not
4001 This is not as a general purpose Unicode to byte encoding interface:
4002 use the Encode extension for that.
4008 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4010 if (SvPOKp(sv) && SvUTF8(sv)) {
4016 sv_force_normal_flags(sv, 0);
4018 s = (U8 *) SvPV(sv, len);
4019 if (!utf8_to_bytes(s, &len)) {
4024 Perl_croak(aTHX_ "Wide character in %s",
4027 Perl_croak(aTHX_ "Wide character");
4038 =for apidoc sv_utf8_encode
4040 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4041 flag off so that it looks like octets again.
4047 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4049 (void) sv_utf8_upgrade(sv);
4051 sv_force_normal_flags(sv, 0);
4053 if (SvREADONLY(sv)) {
4054 Perl_croak(aTHX_ PL_no_modify);
4060 =for apidoc sv_utf8_decode
4062 If the PV of the SV is an octet sequence in UTF-8
4063 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4064 so that it looks like a character. If the PV contains only single-byte
4065 characters, the C<SvUTF8> flag stays being off.
4066 Scans PV for validity and returns false if the PV is invalid UTF-8.
4072 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4078 /* The octets may have got themselves encoded - get them back as
4081 if (!sv_utf8_downgrade(sv, TRUE))
4084 /* it is actually just a matter of turning the utf8 flag on, but
4085 * we want to make sure everything inside is valid utf8 first.
4087 c = (U8 *) SvPVX(sv);
4088 if (!is_utf8_string(c, SvCUR(sv)+1))
4090 e = (U8 *) SvEND(sv);
4093 if (!UTF8_IS_INVARIANT(ch)) {
4102 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4103 * this function provided for binary compatibility only
4107 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4109 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4113 =for apidoc sv_setsv
4115 Copies the contents of the source SV C<ssv> into the destination SV
4116 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4117 function if the source SV needs to be reused. Does not handle 'set' magic.
4118 Loosely speaking, it performs a copy-by-value, obliterating any previous
4119 content of the destination.
4121 You probably want to use one of the assortment of wrappers, such as
4122 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4123 C<SvSetMagicSV_nosteal>.
4125 =for apidoc sv_setsv_flags
4127 Copies the contents of the source SV C<ssv> into the destination SV
4128 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4129 function if the source SV needs to be reused. Does not handle 'set' magic.
4130 Loosely speaking, it performs a copy-by-value, obliterating any previous
4131 content of the destination.
4132 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4133 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4134 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4135 and C<sv_setsv_nomg> are implemented in terms of this function.
4137 You probably want to use one of the assortment of wrappers, such as
4138 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4139 C<SvSetMagicSV_nosteal>.
4141 This is the primary function for copying scalars, and most other
4142 copy-ish functions and macros use this underneath.
4148 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4150 register U32 sflags;
4156 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4158 sstr = &PL_sv_undef;
4159 stype = SvTYPE(sstr);
4160 dtype = SvTYPE(dstr);
4165 /* need to nuke the magic */
4167 SvRMAGICAL_off(dstr);
4170 /* There's a lot of redundancy below but we're going for speed here */
4175 if (dtype != SVt_PVGV) {
4176 (void)SvOK_off(dstr);
4184 sv_upgrade(dstr, SVt_IV);
4187 sv_upgrade(dstr, SVt_PVNV);
4191 sv_upgrade(dstr, SVt_PVIV);
4194 (void)SvIOK_only(dstr);
4195 SvIVX(dstr) = SvIVX(sstr);
4198 if (SvTAINTED(sstr))
4209 sv_upgrade(dstr, SVt_NV);
4214 sv_upgrade(dstr, SVt_PVNV);
4217 SvNVX(dstr) = SvNVX(sstr);
4218 (void)SvNOK_only(dstr);
4219 if (SvTAINTED(sstr))
4227 sv_upgrade(dstr, SVt_RV);
4228 else if (dtype == SVt_PVGV &&
4229 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4232 if (GvIMPORTED(dstr) != GVf_IMPORTED
4233 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4235 GvIMPORTED_on(dstr);
4244 #ifdef PERL_COPY_ON_WRITE
4245 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4246 if (dtype < SVt_PVIV)
4247 sv_upgrade(dstr, SVt_PVIV);
4254 sv_upgrade(dstr, SVt_PV);
4257 if (dtype < SVt_PVIV)
4258 sv_upgrade(dstr, SVt_PVIV);
4261 if (dtype < SVt_PVNV)
4262 sv_upgrade(dstr, SVt_PVNV);
4269 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4272 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4276 if (dtype <= SVt_PVGV) {
4278 if (dtype != SVt_PVGV) {
4279 char *name = GvNAME(sstr);
4280 STRLEN len = GvNAMELEN(sstr);
4281 /* don't upgrade SVt_PVLV: it can hold a glob */
4282 if (dtype != SVt_PVLV)
4283 sv_upgrade(dstr, SVt_PVGV);
4284 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4285 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4286 GvNAME(dstr) = savepvn(name, len);
4287 GvNAMELEN(dstr) = len;
4288 SvFAKE_on(dstr); /* can coerce to non-glob */
4290 /* ahem, death to those who redefine active sort subs */
4291 else if (PL_curstackinfo->si_type == PERLSI_SORT
4292 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4293 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4296 #ifdef GV_UNIQUE_CHECK
4297 if (GvUNIQUE((GV*)dstr)) {
4298 Perl_croak(aTHX_ PL_no_modify);
4302 (void)SvOK_off(dstr);
4303 GvINTRO_off(dstr); /* one-shot flag */
4305 GvGP(dstr) = gp_ref(GvGP(sstr));
4306 if (SvTAINTED(sstr))
4308 if (GvIMPORTED(dstr) != GVf_IMPORTED
4309 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4311 GvIMPORTED_on(dstr);
4319 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4321 if ((int)SvTYPE(sstr) != stype) {
4322 stype = SvTYPE(sstr);
4323 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4327 if (stype == SVt_PVLV)
4328 (void)SvUPGRADE(dstr, SVt_PVNV);
4330 (void)SvUPGRADE(dstr, (U32)stype);
4333 sflags = SvFLAGS(sstr);
4335 if (sflags & SVf_ROK) {
4336 if (dtype >= SVt_PV) {
4337 if (dtype == SVt_PVGV) {
4338 SV *sref = SvREFCNT_inc(SvRV(sstr));
4340 int intro = GvINTRO(dstr);
4342 #ifdef GV_UNIQUE_CHECK
4343 if (GvUNIQUE((GV*)dstr)) {
4344 Perl_croak(aTHX_ PL_no_modify);
4349 GvINTRO_off(dstr); /* one-shot flag */
4350 GvLINE(dstr) = CopLINE(PL_curcop);
4351 GvEGV(dstr) = (GV*)dstr;
4354 switch (SvTYPE(sref)) {
4357 SAVEGENERICSV(GvAV(dstr));
4359 dref = (SV*)GvAV(dstr);
4360 GvAV(dstr) = (AV*)sref;
4361 if (!GvIMPORTED_AV(dstr)
4362 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4364 GvIMPORTED_AV_on(dstr);
4369 SAVEGENERICSV(GvHV(dstr));
4371 dref = (SV*)GvHV(dstr);
4372 GvHV(dstr) = (HV*)sref;
4373 if (!GvIMPORTED_HV(dstr)
4374 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4376 GvIMPORTED_HV_on(dstr);
4381 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4382 SvREFCNT_dec(GvCV(dstr));
4383 GvCV(dstr) = Nullcv;
4384 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4385 PL_sub_generation++;
4387 SAVEGENERICSV(GvCV(dstr));
4390 dref = (SV*)GvCV(dstr);
4391 if (GvCV(dstr) != (CV*)sref) {
4392 CV* cv = GvCV(dstr);
4394 if (!GvCVGEN((GV*)dstr) &&
4395 (CvROOT(cv) || CvXSUB(cv)))
4397 /* ahem, death to those who redefine
4398 * active sort subs */
4399 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4400 PL_sortcop == CvSTART(cv))
4402 "Can't redefine active sort subroutine %s",
4403 GvENAME((GV*)dstr));
4404 /* Redefining a sub - warning is mandatory if
4405 it was a const and its value changed. */
4406 if (ckWARN(WARN_REDEFINE)
4408 && (!CvCONST((CV*)sref)
4409 || sv_cmp(cv_const_sv(cv),
4410 cv_const_sv((CV*)sref)))))
4412 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4414 ? "Constant subroutine %s::%s redefined"
4415 : "Subroutine %s::%s redefined",
4416 HvNAME(GvSTASH((GV*)dstr)),
4417 GvENAME((GV*)dstr));
4421 cv_ckproto(cv, (GV*)dstr,
4422 SvPOK(sref) ? SvPVX(sref) : Nullch);
4424 GvCV(dstr) = (CV*)sref;
4425 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4426 GvASSUMECV_on(dstr);
4427 PL_sub_generation++;
4429 if (!GvIMPORTED_CV(dstr)
4430 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4432 GvIMPORTED_CV_on(dstr);
4437 SAVEGENERICSV(GvIOp(dstr));
4439 dref = (SV*)GvIOp(dstr);
4440 GvIOp(dstr) = (IO*)sref;
4444 SAVEGENERICSV(GvFORM(dstr));
4446 dref = (SV*)GvFORM(dstr);
4447 GvFORM(dstr) = (CV*)sref;
4451 SAVEGENERICSV(GvSV(dstr));
4453 dref = (SV*)GvSV(dstr);
4455 if (!GvIMPORTED_SV(dstr)
4456 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4458 GvIMPORTED_SV_on(dstr);
4464 if (SvTAINTED(sstr))
4469 (void)SvOOK_off(dstr); /* backoff */
4471 Safefree(SvPVX(dstr));
4472 SvLEN(dstr)=SvCUR(dstr)=0;
4475 (void)SvOK_off(dstr);
4476 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4478 if (sflags & SVp_NOK) {
4480 /* Only set the public OK flag if the source has public OK. */
4481 if (sflags & SVf_NOK)
4482 SvFLAGS(dstr) |= SVf_NOK;
4483 SvNVX(dstr) = SvNVX(sstr);
4485 if (sflags & SVp_IOK) {
4486 (void)SvIOKp_on(dstr);
4487 if (sflags & SVf_IOK)
4488 SvFLAGS(dstr) |= SVf_IOK;
4489 if (sflags & SVf_IVisUV)
4491 SvIVX(dstr) = SvIVX(sstr);
4493 if (SvAMAGIC(sstr)) {
4497 else if (sflags & SVp_POK) {
4501 * Check to see if we can just swipe the string. If so, it's a
4502 * possible small lose on short strings, but a big win on long ones.
4503 * It might even be a win on short strings if SvPVX(dstr)
4504 * has to be allocated and SvPVX(sstr) has to be freed.
4507 /* Whichever path we take through the next code, we want this true,
4508 and doing it now facilitates the COW check. */
4509 (void)SvPOK_only(dstr);
4512 #ifdef PERL_COPY_ON_WRITE
4513 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4517 (sflags & SVs_TEMP) && /* slated for free anyway? */
4518 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4519 (!(flags & SV_NOSTEAL)) &&
4520 /* and we're allowed to steal temps */
4521 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4522 SvLEN(sstr) && /* and really is a string */
4523 /* and won't be needed again, potentially */
4524 !(PL_op && PL_op->op_type == OP_AASSIGN))
4525 #ifdef PERL_COPY_ON_WRITE
4526 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4527 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4528 && SvTYPE(sstr) >= SVt_PVIV)
4531 /* Failed the swipe test, and it's not a shared hash key either.
4532 Have to copy the string. */
4533 STRLEN len = SvCUR(sstr);
4534 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4535 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4536 SvCUR_set(dstr, len);
4537 *SvEND(dstr) = '\0';
4539 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4541 #ifdef PERL_COPY_ON_WRITE
4542 /* Either it's a shared hash key, or it's suitable for
4543 copy-on-write or we can swipe the string. */
4545 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4550 /* I believe I should acquire a global SV mutex if
4551 it's a COW sv (not a shared hash key) to stop
4552 it going un copy-on-write.
4553 If the source SV has gone un copy on write between up there
4554 and down here, then (assert() that) it is of the correct
4555 form to make it copy on write again */
4556 if ((sflags & (SVf_FAKE | SVf_READONLY))
4557 != (SVf_FAKE | SVf_READONLY)) {
4558 SvREADONLY_on(sstr);
4560 /* Make the source SV into a loop of 1.
4561 (about to become 2) */
4562 SV_COW_NEXT_SV_SET(sstr, sstr);
4566 /* Initial code is common. */
4567 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4569 SvFLAGS(dstr) &= ~SVf_OOK;
4570 Safefree(SvPVX(dstr) - SvIVX(dstr));
4572 else if (SvLEN(dstr))
4573 Safefree(SvPVX(dstr));
4576 #ifdef PERL_COPY_ON_WRITE
4578 /* making another shared SV. */
4579 STRLEN cur = SvCUR(sstr);
4580 STRLEN len = SvLEN(sstr);
4581 assert (SvTYPE(dstr) >= SVt_PVIV);
4583 /* SvIsCOW_normal */
4584 /* splice us in between source and next-after-source. */
4585 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4586 SV_COW_NEXT_SV_SET(sstr, dstr);
4587 SvPV_set(dstr, SvPVX(sstr));
4589 /* SvIsCOW_shared_hash */
4590 UV hash = SvUVX(sstr);
4591 DEBUG_C(PerlIO_printf(Perl_debug_log,
4592 "Copy on write: Sharing hash\n"));
4594 sharepvn(SvPVX(sstr),
4595 (sflags & SVf_UTF8?-cur:cur), hash));
4600 SvREADONLY_on(dstr);
4602 /* Relesase a global SV mutex. */
4606 { /* Passes the swipe test. */
4607 SvPV_set(dstr, SvPVX(sstr));
4608 SvLEN_set(dstr, SvLEN(sstr));
4609 SvCUR_set(dstr, SvCUR(sstr));
4612 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4613 SvPV_set(sstr, Nullch);
4619 if (sflags & SVf_UTF8)
4622 if (sflags & SVp_NOK) {
4624 if (sflags & SVf_NOK)
4625 SvFLAGS(dstr) |= SVf_NOK;
4626 SvNVX(dstr) = SvNVX(sstr);
4628 if (sflags & SVp_IOK) {
4629 (void)SvIOKp_on(dstr);
4630 if (sflags & SVf_IOK)
4631 SvFLAGS(dstr) |= SVf_IOK;
4632 if (sflags & SVf_IVisUV)
4634 SvIVX(dstr) = SvIVX(sstr);
4637 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4638 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4639 smg->mg_ptr, smg->mg_len);
4640 SvRMAGICAL_on(dstr);
4643 else if (sflags & SVp_IOK) {
4644 if (sflags & SVf_IOK)
4645 (void)SvIOK_only(dstr);
4647 (void)SvOK_off(dstr);
4648 (void)SvIOKp_on(dstr);
4650 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4651 if (sflags & SVf_IVisUV)
4653 SvIVX(dstr) = SvIVX(sstr);
4654 if (sflags & SVp_NOK) {
4655 if (sflags & SVf_NOK)
4656 (void)SvNOK_on(dstr);
4658 (void)SvNOKp_on(dstr);
4659 SvNVX(dstr) = SvNVX(sstr);
4662 else if (sflags & SVp_NOK) {
4663 if (sflags & SVf_NOK)
4664 (void)SvNOK_only(dstr);
4666 (void)SvOK_off(dstr);
4669 SvNVX(dstr) = SvNVX(sstr);
4672 if (dtype == SVt_PVGV) {
4673 if (ckWARN(WARN_MISC))
4674 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4677 (void)SvOK_off(dstr);
4679 if (SvTAINTED(sstr))
4684 =for apidoc sv_setsv_mg
4686 Like C<sv_setsv>, but also handles 'set' magic.
4692 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4694 sv_setsv(dstr,sstr);
4698 #ifdef PERL_COPY_ON_WRITE
4700 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4702 STRLEN cur = SvCUR(sstr);
4703 STRLEN len = SvLEN(sstr);
4704 register char *new_pv;
4707 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4715 if (SvTHINKFIRST(dstr))
4716 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4717 else if (SvPVX(dstr))
4718 Safefree(SvPVX(dstr));
4722 (void)SvUPGRADE (dstr, SVt_PVIV);
4724 assert (SvPOK(sstr));
4725 assert (SvPOKp(sstr));
4726 assert (!SvIOK(sstr));
4727 assert (!SvIOKp(sstr));
4728 assert (!SvNOK(sstr));
4729 assert (!SvNOKp(sstr));
4731 if (SvIsCOW(sstr)) {
4733 if (SvLEN(sstr) == 0) {
4734 /* source is a COW shared hash key. */
4735 UV hash = SvUVX(sstr);
4736 DEBUG_C(PerlIO_printf(Perl_debug_log,
4737 "Fast copy on write: Sharing hash\n"));
4739 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4742 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4744 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4745 (void)SvUPGRADE (sstr, SVt_PVIV);
4746 SvREADONLY_on(sstr);
4748 DEBUG_C(PerlIO_printf(Perl_debug_log,
4749 "Fast copy on write: Converting sstr to COW\n"));
4750 SV_COW_NEXT_SV_SET(dstr, sstr);
4752 SV_COW_NEXT_SV_SET(sstr, dstr);
4753 new_pv = SvPVX(sstr);
4756 SvPV_set(dstr, new_pv);
4757 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4770 =for apidoc sv_setpvn
4772 Copies a string into an SV. The C<len> parameter indicates the number of
4773 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4774 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4780 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4782 register char *dptr;
4784 SV_CHECK_THINKFIRST_COW_DROP(sv);
4790 /* len is STRLEN which is unsigned, need to copy to signed */
4793 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4795 (void)SvUPGRADE(sv, SVt_PV);
4797 SvGROW(sv, len + 1);
4799 Move(ptr,dptr,len,char);
4802 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4807 =for apidoc sv_setpvn_mg
4809 Like C<sv_setpvn>, but also handles 'set' magic.
4815 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4817 sv_setpvn(sv,ptr,len);
4822 =for apidoc sv_setpv
4824 Copies a string into an SV. The string must be null-terminated. Does not
4825 handle 'set' magic. See C<sv_setpv_mg>.
4831 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4833 register STRLEN len;
4835 SV_CHECK_THINKFIRST_COW_DROP(sv);
4841 (void)SvUPGRADE(sv, SVt_PV);
4843 SvGROW(sv, len + 1);
4844 Move(ptr,SvPVX(sv),len+1,char);
4846 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4851 =for apidoc sv_setpv_mg
4853 Like C<sv_setpv>, but also handles 'set' magic.
4859 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4866 =for apidoc sv_usepvn
4868 Tells an SV to use C<ptr> to find its string value. Normally the string is
4869 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4870 The C<ptr> should point to memory that was allocated by C<malloc>. The
4871 string length, C<len>, must be supplied. This function will realloc the
4872 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4873 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4874 See C<sv_usepvn_mg>.
4880 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4882 SV_CHECK_THINKFIRST_COW_DROP(sv);
4883 (void)SvUPGRADE(sv, SVt_PV);
4888 (void)SvOOK_off(sv);
4889 if (SvPVX(sv) && SvLEN(sv))
4890 Safefree(SvPVX(sv));
4891 Renew(ptr, len+1, char);
4894 SvLEN_set(sv, len+1);
4896 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4901 =for apidoc sv_usepvn_mg
4903 Like C<sv_usepvn>, but also handles 'set' magic.
4909 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4911 sv_usepvn(sv,ptr,len);
4915 #ifdef PERL_COPY_ON_WRITE
4916 /* Need to do this *after* making the SV normal, as we need the buffer
4917 pointer to remain valid until after we've copied it. If we let go too early,
4918 another thread could invalidate it by unsharing last of the same hash key
4919 (which it can do by means other than releasing copy-on-write Svs)
4920 or by changing the other copy-on-write SVs in the loop. */
4922 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4923 U32 hash, SV *after)
4925 if (len) { /* this SV was SvIsCOW_normal(sv) */
4926 /* we need to find the SV pointing to us. */
4927 SV *current = SV_COW_NEXT_SV(after);
4929 if (current == sv) {
4930 /* The SV we point to points back to us (there were only two of us
4932 Hence other SV is no longer copy on write either. */
4934 SvREADONLY_off(after);
4936 /* We need to follow the pointers around the loop. */
4938 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4941 /* don't loop forever if the structure is bust, and we have
4942 a pointer into a closed loop. */
4943 assert (current != after);
4944 assert (SvPVX(current) == pvx);
4946 /* Make the SV before us point to the SV after us. */
4947 SV_COW_NEXT_SV_SET(current, after);
4950 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4955 Perl_sv_release_IVX(pTHX_ register SV *sv)
4958 sv_force_normal_flags(sv, 0);
4964 =for apidoc sv_force_normal_flags
4966 Undo various types of fakery on an SV: if the PV is a shared string, make
4967 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4968 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4969 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4970 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4971 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4972 set to some other value.) In addition, the C<flags> parameter gets passed to
4973 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4974 with flags set to 0.
4980 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4982 #ifdef PERL_COPY_ON_WRITE
4983 if (SvREADONLY(sv)) {
4984 /* At this point I believe I should acquire a global SV mutex. */
4986 char *pvx = SvPVX(sv);
4987 STRLEN len = SvLEN(sv);
4988 STRLEN cur = SvCUR(sv);
4989 U32 hash = SvUVX(sv);
4990 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4992 PerlIO_printf(Perl_debug_log,
4993 "Copy on write: Force normal %ld\n",
4999 /* This SV doesn't own the buffer, so need to New() a new one: */
5002 if (flags & SV_COW_DROP_PV) {
5003 /* OK, so we don't need to copy our buffer. */
5006 SvGROW(sv, cur + 1);
5007 Move(pvx,SvPVX(sv),cur,char);
5011 sv_release_COW(sv, pvx, cur, len, hash, next);
5016 else if (IN_PERL_RUNTIME)
5017 Perl_croak(aTHX_ PL_no_modify);
5018 /* At this point I believe that I can drop the global SV mutex. */
5021 if (SvREADONLY(sv)) {
5023 char *pvx = SvPVX(sv);
5024 int is_utf8 = SvUTF8(sv);
5025 STRLEN len = SvCUR(sv);
5026 U32 hash = SvUVX(sv);
5031 SvGROW(sv, len + 1);
5032 Move(pvx,SvPVX(sv),len,char);
5034 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5036 else if (IN_PERL_RUNTIME)
5037 Perl_croak(aTHX_ PL_no_modify);
5041 sv_unref_flags(sv, flags);
5042 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5047 =for apidoc sv_force_normal
5049 Undo various types of fakery on an SV: if the PV is a shared string, make
5050 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5051 an xpvmg. See also C<sv_force_normal_flags>.
5057 Perl_sv_force_normal(pTHX_ register SV *sv)
5059 sv_force_normal_flags(sv, 0);
5065 Efficient removal of characters from the beginning of the string buffer.
5066 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5067 the string buffer. The C<ptr> becomes the first character of the adjusted
5068 string. Uses the "OOK hack".
5069 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5070 refer to the same chunk of data.
5076 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5078 register STRLEN delta;
5079 if (!ptr || !SvPOKp(sv))
5081 delta = ptr - SvPVX(sv);
5082 SV_CHECK_THINKFIRST(sv);
5083 if (SvTYPE(sv) < SVt_PVIV)
5084 sv_upgrade(sv,SVt_PVIV);
5087 if (!SvLEN(sv)) { /* make copy of shared string */
5088 char *pvx = SvPVX(sv);
5089 STRLEN len = SvCUR(sv);
5090 SvGROW(sv, len + 1);
5091 Move(pvx,SvPVX(sv),len,char);
5095 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5096 and we do that anyway inside the SvNIOK_off
5098 SvFLAGS(sv) |= SVf_OOK;
5107 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5108 * this function provided for binary compatibility only
5112 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5114 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5118 =for apidoc sv_catpvn
5120 Concatenates the string onto the end of the string which is in the SV. The
5121 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5122 status set, then the bytes appended should be valid UTF-8.
5123 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5125 =for apidoc sv_catpvn_flags
5127 Concatenates the string onto the end of the string which is in the SV. The
5128 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5129 status set, then the bytes appended should be valid UTF-8.
5130 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5131 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5132 in terms of this function.
5138 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5143 dstr = SvPV_force_flags(dsv, dlen, flags);
5144 SvGROW(dsv, dlen + slen + 1);
5147 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5150 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5155 =for apidoc sv_catpvn_mg
5157 Like C<sv_catpvn>, but also handles 'set' magic.
5163 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5165 sv_catpvn(sv,ptr,len);
5169 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5170 * this function provided for binary compatibility only
5174 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5176 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5180 =for apidoc sv_catsv
5182 Concatenates the string from SV C<ssv> onto the end of the string in
5183 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5184 not 'set' magic. See C<sv_catsv_mg>.
5186 =for apidoc sv_catsv_flags
5188 Concatenates the string from SV C<ssv> onto the end of the string in
5189 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5190 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5191 and C<sv_catsv_nomg> are implemented in terms of this function.
5196 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5202 if ((spv = SvPV(ssv, slen))) {
5203 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5204 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5205 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5206 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5207 dsv->sv_flags doesn't have that bit set.
5208 Andy Dougherty 12 Oct 2001
5210 I32 sutf8 = DO_UTF8(ssv);
5213 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5215 dutf8 = DO_UTF8(dsv);
5217 if (dutf8 != sutf8) {
5219 /* Not modifying source SV, so taking a temporary copy. */
5220 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5222 sv_utf8_upgrade(csv);
5223 spv = SvPV(csv, slen);
5226 sv_utf8_upgrade_nomg(dsv);
5228 sv_catpvn_nomg(dsv, spv, slen);
5233 =for apidoc sv_catsv_mg
5235 Like C<sv_catsv>, but also handles 'set' magic.
5241 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5248 =for apidoc sv_catpv
5250 Concatenates the string onto the end of the string which is in the SV.
5251 If the SV has the UTF-8 status set, then the bytes appended should be
5252 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5257 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5259 register STRLEN len;
5265 junk = SvPV_force(sv, tlen);
5267 SvGROW(sv, tlen + len + 1);
5270 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5272 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5277 =for apidoc sv_catpv_mg
5279 Like C<sv_catpv>, but also handles 'set' magic.
5285 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5294 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5295 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5302 Perl_newSV(pTHX_ STRLEN len)
5308 sv_upgrade(sv, SVt_PV);
5309 SvGROW(sv, len + 1);
5314 =for apidoc sv_magicext
5316 Adds magic to an SV, upgrading it if necessary. Applies the
5317 supplied vtable and returns pointer to the magic added.
5319 Note that sv_magicext will allow things that sv_magic will not.
5320 In particular you can add magic to SvREADONLY SVs and and more than
5321 one instance of the same 'how'
5323 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
5324 if C<namelen> is zero then C<name> is stored as-is and - as another special
5325 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
5326 an C<SV*> and has its REFCNT incremented
5328 (This is now used as a subroutine by sv_magic.)
5333 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5334 const char* name, I32 namlen)
5338 if (SvTYPE(sv) < SVt_PVMG) {
5339 (void)SvUPGRADE(sv, SVt_PVMG);
5341 Newz(702,mg, 1, MAGIC);
5342 mg->mg_moremagic = SvMAGIC(sv);
5345 /* Some magic sontains a reference loop, where the sv and object refer to
5346 each other. To prevent a reference loop that would prevent such
5347 objects being freed, we look for such loops and if we find one we
5348 avoid incrementing the object refcount.
5350 Note we cannot do this to avoid self-tie loops as intervening RV must
5351 have its REFCNT incremented to keep it in existence.
5354 if (!obj || obj == sv ||
5355 how == PERL_MAGIC_arylen ||
5356 how == PERL_MAGIC_qr ||
5357 (SvTYPE(obj) == SVt_PVGV &&
5358 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5359 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5360 GvFORM(obj) == (CV*)sv)))
5365 mg->mg_obj = SvREFCNT_inc(obj);
5366 mg->mg_flags |= MGf_REFCOUNTED;
5369 /* Normal self-ties simply pass a null object, and instead of
5370 using mg_obj directly, use the SvTIED_obj macro to produce a
5371 new RV as needed. For glob "self-ties", we are tieing the PVIO
5372 with an RV obj pointing to the glob containing the PVIO. In
5373 this case, to avoid a reference loop, we need to weaken the
5377 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5378 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5384 mg->mg_len = namlen;
5387 mg->mg_ptr = savepvn(name, namlen);
5388 else if (namlen == HEf_SVKEY)
5389 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5391 mg->mg_ptr = (char *) name;
5393 mg->mg_virtual = vtable;
5397 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5402 =for apidoc sv_magic
5404 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5405 then adds a new magic item of type C<how> to the head of the magic list.
5411 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5416 #ifdef PERL_COPY_ON_WRITE
5418 sv_force_normal_flags(sv, 0);
5420 if (SvREADONLY(sv)) {
5422 && how != PERL_MAGIC_regex_global
5423 && how != PERL_MAGIC_bm
5424 && how != PERL_MAGIC_fm
5425 && how != PERL_MAGIC_sv
5426 && how != PERL_MAGIC_backref
5429 Perl_croak(aTHX_ PL_no_modify);
5432 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5433 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5434 /* sv_magic() refuses to add a magic of the same 'how' as an
5437 if (how == PERL_MAGIC_taint)
5445 vtable = &PL_vtbl_sv;
5447 case PERL_MAGIC_overload:
5448 vtable = &PL_vtbl_amagic;
5450 case PERL_MAGIC_overload_elem:
5451 vtable = &PL_vtbl_amagicelem;
5453 case PERL_MAGIC_overload_table:
5454 vtable = &PL_vtbl_ovrld;
5457 vtable = &PL_vtbl_bm;
5459 case PERL_MAGIC_regdata:
5460 vtable = &PL_vtbl_regdata;
5462 case PERL_MAGIC_regdatum:
5463 vtable = &PL_vtbl_regdatum;
5465 case PERL_MAGIC_env:
5466 vtable = &PL_vtbl_env;
5469 vtable = &PL_vtbl_fm;
5471 case PERL_MAGIC_envelem:
5472 vtable = &PL_vtbl_envelem;
5474 case PERL_MAGIC_regex_global:
5475 vtable = &PL_vtbl_mglob;
5477 case PERL_MAGIC_isa:
5478 vtable = &PL_vtbl_isa;
5480 case PERL_MAGIC_isaelem:
5481 vtable = &PL_vtbl_isaelem;
5483 case PERL_MAGIC_nkeys:
5484 vtable = &PL_vtbl_nkeys;
5486 case PERL_MAGIC_dbfile:
5489 case PERL_MAGIC_dbline:
5490 vtable = &PL_vtbl_dbline;
5492 #ifdef USE_LOCALE_COLLATE
5493 case PERL_MAGIC_collxfrm:
5494 vtable = &PL_vtbl_collxfrm;
5496 #endif /* USE_LOCALE_COLLATE */
5497 case PERL_MAGIC_tied:
5498 vtable = &PL_vtbl_pack;
5500 case PERL_MAGIC_tiedelem:
5501 case PERL_MAGIC_tiedscalar:
5502 vtable = &PL_vtbl_packelem;
5505 vtable = &PL_vtbl_regexp;
5507 case PERL_MAGIC_sig:
5508 vtable = &PL_vtbl_sig;
5510 case PERL_MAGIC_sigelem:
5511 vtable = &PL_vtbl_sigelem;
5513 case PERL_MAGIC_taint:
5514 vtable = &PL_vtbl_taint;
5516 case PERL_MAGIC_uvar:
5517 vtable = &PL_vtbl_uvar;
5519 case PERL_MAGIC_vec:
5520 vtable = &PL_vtbl_vec;
5522 case PERL_MAGIC_vstring:
5525 case PERL_MAGIC_utf8:
5526 vtable = &PL_vtbl_utf8;
5528 case PERL_MAGIC_substr:
5529 vtable = &PL_vtbl_substr;
5531 case PERL_MAGIC_defelem:
5532 vtable = &PL_vtbl_defelem;
5534 case PERL_MAGIC_glob:
5535 vtable = &PL_vtbl_glob;
5537 case PERL_MAGIC_arylen:
5538 vtable = &PL_vtbl_arylen;
5540 case PERL_MAGIC_pos:
5541 vtable = &PL_vtbl_pos;
5543 case PERL_MAGIC_backref:
5544 vtable = &PL_vtbl_backref;
5546 case PERL_MAGIC_ext:
5547 /* Reserved for use by extensions not perl internals. */
5548 /* Useful for attaching extension internal data to perl vars. */
5549 /* Note that multiple extensions may clash if magical scalars */
5550 /* etc holding private data from one are passed to another. */
5553 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5556 /* Rest of work is done else where */
5557 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5560 case PERL_MAGIC_taint:
5563 case PERL_MAGIC_ext:
5564 case PERL_MAGIC_dbfile:
5571 =for apidoc sv_unmagic
5573 Removes all magic of type C<type> from an SV.
5579 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5583 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5586 for (mg = *mgp; mg; mg = *mgp) {
5587 if (mg->mg_type == type) {
5588 MGVTBL* vtbl = mg->mg_virtual;
5589 *mgp = mg->mg_moremagic;
5590 if (vtbl && vtbl->svt_free)
5591 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5592 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5594 Safefree(mg->mg_ptr);
5595 else if (mg->mg_len == HEf_SVKEY)
5596 SvREFCNT_dec((SV*)mg->mg_ptr);
5597 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5598 Safefree(mg->mg_ptr);
5600 if (mg->mg_flags & MGf_REFCOUNTED)
5601 SvREFCNT_dec(mg->mg_obj);
5605 mgp = &mg->mg_moremagic;
5609 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5616 =for apidoc sv_rvweaken
5618 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5619 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5620 push a back-reference to this RV onto the array of backreferences
5621 associated with that magic.
5627 Perl_sv_rvweaken(pTHX_ SV *sv)
5630 if (!SvOK(sv)) /* let undefs pass */
5633 Perl_croak(aTHX_ "Can't weaken a nonreference");
5634 else if (SvWEAKREF(sv)) {
5635 if (ckWARN(WARN_MISC))
5636 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5640 sv_add_backref(tsv, sv);
5646 /* Give tsv backref magic if it hasn't already got it, then push a
5647 * back-reference to sv onto the array associated with the backref magic.
5651 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5655 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5656 av = (AV*)mg->mg_obj;
5659 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5660 /* av now has a refcnt of 2, which avoids it getting freed
5661 * before us during global cleanup. The extra ref is removed
5662 * by magic_killbackrefs() when tsv is being freed */
5664 if (AvFILLp(av) >= AvMAX(av)) {
5666 SV **svp = AvARRAY(av);
5667 for (i = AvFILLp(av); i >= 0; i--)
5669 svp[i] = sv; /* reuse the slot */
5672 av_extend(av, AvFILLp(av)+1);
5674 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5677 /* delete a back-reference to ourselves from the backref magic associated
5678 * with the SV we point to.
5682 S_sv_del_backref(pTHX_ SV *sv)
5689 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5690 Perl_croak(aTHX_ "panic: del_backref");
5691 av = (AV *)mg->mg_obj;
5693 for (i = AvFILLp(av); i >= 0; i--)
5694 if (svp[i] == sv) svp[i] = Nullsv;
5698 =for apidoc sv_insert
5700 Inserts a string at the specified offset/length within the SV. Similar to
5701 the Perl substr() function.
5707 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5711 register char *midend;
5712 register char *bigend;
5718 Perl_croak(aTHX_ "Can't modify non-existent substring");
5719 SvPV_force(bigstr, curlen);
5720 (void)SvPOK_only_UTF8(bigstr);
5721 if (offset + len > curlen) {
5722 SvGROW(bigstr, offset+len+1);
5723 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5724 SvCUR_set(bigstr, offset+len);
5728 i = littlelen - len;
5729 if (i > 0) { /* string might grow */
5730 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5731 mid = big + offset + len;
5732 midend = bigend = big + SvCUR(bigstr);
5735 while (midend > mid) /* shove everything down */
5736 *--bigend = *--midend;
5737 Move(little,big+offset,littlelen,char);
5743 Move(little,SvPVX(bigstr)+offset,len,char);
5748 big = SvPVX(bigstr);
5751 bigend = big + SvCUR(bigstr);
5753 if (midend > bigend)
5754 Perl_croak(aTHX_ "panic: sv_insert");
5756 if (mid - big > bigend - midend) { /* faster to shorten from end */
5758 Move(little, mid, littlelen,char);
5761 i = bigend - midend;
5763 Move(midend, mid, i,char);
5767 SvCUR_set(bigstr, mid - big);
5770 else if ((i = mid - big)) { /* faster from front */
5771 midend -= littlelen;
5773 sv_chop(bigstr,midend-i);
5778 Move(little, mid, littlelen,char);
5780 else if (littlelen) {
5781 midend -= littlelen;
5782 sv_chop(bigstr,midend);
5783 Move(little,midend,littlelen,char);
5786 sv_chop(bigstr,midend);
5792 =for apidoc sv_replace
5794 Make the first argument a copy of the second, then delete the original.
5795 The target SV physically takes over ownership of the body of the source SV
5796 and inherits its flags; however, the target keeps any magic it owns,
5797 and any magic in the source is discarded.
5798 Note that this is a rather specialist SV copying operation; most of the
5799 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5805 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5807 U32 refcnt = SvREFCNT(sv);
5808 SV_CHECK_THINKFIRST_COW_DROP(sv);
5809 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5810 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5811 if (SvMAGICAL(sv)) {
5815 sv_upgrade(nsv, SVt_PVMG);
5816 SvMAGIC(nsv) = SvMAGIC(sv);
5817 SvFLAGS(nsv) |= SvMAGICAL(sv);
5823 assert(!SvREFCNT(sv));
5824 StructCopy(nsv,sv,SV);
5825 #ifdef PERL_COPY_ON_WRITE
5826 if (SvIsCOW_normal(nsv)) {
5827 /* We need to follow the pointers around the loop to make the
5828 previous SV point to sv, rather than nsv. */
5831 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5834 assert(SvPVX(current) == SvPVX(nsv));
5836 /* Make the SV before us point to the SV after us. */
5838 PerlIO_printf(Perl_debug_log, "previous is\n");
5840 PerlIO_printf(Perl_debug_log,
5841 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5842 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5844 SV_COW_NEXT_SV_SET(current, sv);
5847 SvREFCNT(sv) = refcnt;
5848 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5854 =for apidoc sv_clear
5856 Clear an SV: call any destructors, free up any memory used by the body,
5857 and free the body itself. The SV's head is I<not> freed, although
5858 its type is set to all 1's so that it won't inadvertently be assumed
5859 to be live during global destruction etc.
5860 This function should only be called when REFCNT is zero. Most of the time
5861 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5868 Perl_sv_clear(pTHX_ register SV *sv)
5872 assert(SvREFCNT(sv) == 0);
5875 if (PL_defstash) { /* Still have a symbol table? */
5882 stash = SvSTASH(sv);
5883 destructor = StashHANDLER(stash,DESTROY);
5885 SV* tmpref = newRV(sv);
5886 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5888 PUSHSTACKi(PERLSI_DESTROY);
5893 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5899 if(SvREFCNT(tmpref) < 2) {
5900 /* tmpref is not kept alive! */
5905 SvREFCNT_dec(tmpref);
5907 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5911 if (PL_in_clean_objs)
5912 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5914 /* DESTROY gave object new lease on life */
5920 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5921 SvOBJECT_off(sv); /* Curse the object. */
5922 if (SvTYPE(sv) != SVt_PVIO)
5923 --PL_sv_objcount; /* XXX Might want something more general */
5926 if (SvTYPE(sv) >= SVt_PVMG) {
5929 if (SvFLAGS(sv) & SVpad_TYPED)
5930 SvREFCNT_dec(SvSTASH(sv));
5933 switch (SvTYPE(sv)) {
5936 IoIFP(sv) != PerlIO_stdin() &&
5937 IoIFP(sv) != PerlIO_stdout() &&
5938 IoIFP(sv) != PerlIO_stderr())
5940 io_close((IO*)sv, FALSE);
5942 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5943 PerlDir_close(IoDIRP(sv));
5944 IoDIRP(sv) = (DIR*)NULL;
5945 Safefree(IoTOP_NAME(sv));
5946 Safefree(IoFMT_NAME(sv));
5947 Safefree(IoBOTTOM_NAME(sv));
5962 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5963 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5964 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5965 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5967 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5968 SvREFCNT_dec(LvTARG(sv));
5972 Safefree(GvNAME(sv));
5973 /* cannot decrease stash refcount yet, as we might recursively delete
5974 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5975 of stash until current sv is completely gone.
5976 -- JohnPC, 27 Mar 1998 */
5977 stash = GvSTASH(sv);
5991 SvREFCNT_dec(SvRV(sv));
5993 #ifdef PERL_COPY_ON_WRITE
5994 else if (SvPVX(sv)) {
5996 /* I believe I need to grab the global SV mutex here and
5997 then recheck the COW status. */
5999 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6002 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
6003 SvUVX(sv), SV_COW_NEXT_SV(sv));
6004 /* And drop it here. */
6006 } else if (SvLEN(sv)) {
6007 Safefree(SvPVX(sv));
6011 else if (SvPVX(sv) && SvLEN(sv))
6012 Safefree(SvPVX(sv));
6013 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6014 unsharepvn(SvPVX(sv),
6015 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6029 switch (SvTYPE(sv)) {
6045 del_XPVIV(SvANY(sv));
6048 del_XPVNV(SvANY(sv));
6051 del_XPVMG(SvANY(sv));
6054 del_XPVLV(SvANY(sv));
6057 del_XPVAV(SvANY(sv));
6060 del_XPVHV(SvANY(sv));
6063 del_XPVCV(SvANY(sv));
6066 del_XPVGV(SvANY(sv));
6067 /* code duplication for increased performance. */
6068 SvFLAGS(sv) &= SVf_BREAK;
6069 SvFLAGS(sv) |= SVTYPEMASK;
6070 /* decrease refcount of the stash that owns this GV, if any */
6072 SvREFCNT_dec(stash);
6073 return; /* not break, SvFLAGS reset already happened */
6075 del_XPVBM(SvANY(sv));
6078 del_XPVFM(SvANY(sv));
6081 del_XPVIO(SvANY(sv));
6084 SvFLAGS(sv) &= SVf_BREAK;
6085 SvFLAGS(sv) |= SVTYPEMASK;
6089 =for apidoc sv_newref
6091 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6098 Perl_sv_newref(pTHX_ SV *sv)
6108 Decrement an SV's reference count, and if it drops to zero, call
6109 C<sv_clear> to invoke destructors and free up any memory used by
6110 the body; finally, deallocate the SV's head itself.
6111 Normally called via a wrapper macro C<SvREFCNT_dec>.
6117 Perl_sv_free(pTHX_ SV *sv)
6121 if (SvREFCNT(sv) == 0) {
6122 if (SvFLAGS(sv) & SVf_BREAK)
6123 /* this SV's refcnt has been artificially decremented to
6124 * trigger cleanup */
6126 if (PL_in_clean_all) /* All is fair */
6128 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6129 /* make sure SvREFCNT(sv)==0 happens very seldom */
6130 SvREFCNT(sv) = (~(U32)0)/2;
6133 if (ckWARN_d(WARN_INTERNAL))
6134 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6135 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6136 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6139 if (--(SvREFCNT(sv)) > 0)
6141 Perl_sv_free2(aTHX_ sv);
6145 Perl_sv_free2(pTHX_ SV *sv)
6149 if (ckWARN_d(WARN_DEBUGGING))
6150 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6151 "Attempt to free temp prematurely: SV 0x%"UVxf
6152 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6156 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6157 /* make sure SvREFCNT(sv)==0 happens very seldom */
6158 SvREFCNT(sv) = (~(U32)0)/2;
6169 Returns the length of the string in the SV. Handles magic and type
6170 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6176 Perl_sv_len(pTHX_ register SV *sv)
6184 len = mg_length(sv);
6186 (void)SvPV(sv, len);
6191 =for apidoc sv_len_utf8
6193 Returns the number of characters in the string in an SV, counting wide
6194 UTF-8 bytes as a single character. Handles magic and type coercion.
6200 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6201 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6202 * (Note that the mg_len is not the length of the mg_ptr field.)
6207 Perl_sv_len_utf8(pTHX_ register SV *sv)
6213 return mg_length(sv);
6217 U8 *s = (U8*)SvPV(sv, len);
6218 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6220 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6222 #ifdef PERL_UTF8_CACHE_ASSERT
6223 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6227 ulen = Perl_utf8_length(aTHX_ s, s + len);
6228 if (!mg && !SvREADONLY(sv)) {
6229 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6230 mg = mg_find(sv, PERL_MAGIC_utf8);
6240 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6241 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6242 * between UTF-8 and byte offsets. There are two (substr offset and substr
6243 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6244 * and byte offset) cache positions.
6246 * The mg_len field is used by sv_len_utf8(), see its comments.
6247 * Note that the mg_len is not the length of the mg_ptr field.
6251 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6255 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6257 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6261 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6263 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6264 (*mgp)->mg_ptr = (char *) *cachep;
6268 (*cachep)[i] = *offsetp;
6269 (*cachep)[i+1] = s - start;
6277 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6278 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6279 * between UTF-8 and byte offsets. See also the comments of
6280 * S_utf8_mg_pos_init().
6284 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6288 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6290 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6291 if (*mgp && (*mgp)->mg_ptr) {
6292 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6293 ASSERT_UTF8_CACHE(*cachep);
6294 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6296 else { /* We will skip to the right spot. */
6301 /* The assumption is that going backward is half
6302 * the speed of going forward (that's where the
6303 * 2 * backw in the below comes from). (The real
6304 * figure of course depends on the UTF-8 data.) */
6306 if ((*cachep)[i] > (STRLEN)uoff) {
6308 backw = (*cachep)[i] - (STRLEN)uoff;
6310 if (forw < 2 * backw)
6313 p = start + (*cachep)[i+1];
6315 /* Try this only for the substr offset (i == 0),
6316 * not for the substr length (i == 2). */
6317 else if (i == 0) { /* (*cachep)[i] < uoff */
6318 STRLEN ulen = sv_len_utf8(sv);
6320 if ((STRLEN)uoff < ulen) {
6321 forw = (STRLEN)uoff - (*cachep)[i];
6322 backw = ulen - (STRLEN)uoff;
6324 if (forw < 2 * backw)
6325 p = start + (*cachep)[i+1];
6330 /* If the string is not long enough for uoff,
6331 * we could extend it, but not at this low a level. */
6335 if (forw < 2 * backw) {
6342 while (UTF8_IS_CONTINUATION(*p))
6347 /* Update the cache. */
6348 (*cachep)[i] = (STRLEN)uoff;
6349 (*cachep)[i+1] = p - start;
6351 /* Drop the stale "length" cache */
6360 if (found) { /* Setup the return values. */
6361 *offsetp = (*cachep)[i+1];
6362 *sp = start + *offsetp;
6365 *offsetp = send - start;
6367 else if (*sp < start) {
6373 #ifdef PERL_UTF8_CACHE_ASSERT
6378 while (n-- && s < send)
6382 assert(*offsetp == s - start);
6383 assert((*cachep)[0] == (STRLEN)uoff);
6384 assert((*cachep)[1] == *offsetp);
6386 ASSERT_UTF8_CACHE(*cachep);
6395 =for apidoc sv_pos_u2b
6397 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6398 the start of the string, to a count of the equivalent number of bytes; if
6399 lenp is non-zero, it does the same to lenp, but this time starting from
6400 the offset, rather than from the start of the string. Handles magic and
6407 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6408 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6409 * byte offsets. See also the comments of S_utf8_mg_pos().
6414 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6425 start = s = (U8*)SvPV(sv, len);
6427 I32 uoffset = *offsetp;
6432 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6434 if (!found && uoffset > 0) {
6435 while (s < send && uoffset--)
6439 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6441 *offsetp = s - start;
6446 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6450 if (!found && *lenp > 0) {
6453 while (s < send && ulen--)
6457 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6461 ASSERT_UTF8_CACHE(cache);
6473 =for apidoc sv_pos_b2u
6475 Converts the value pointed to by offsetp from a count of bytes from the
6476 start of the string, to a count of the equivalent number of UTF-8 chars.
6477 Handles magic and type coercion.
6483 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6484 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6485 * byte offsets. See also the comments of S_utf8_mg_pos().
6490 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6498 s = (U8*)SvPV(sv, len);
6499 if ((I32)len < *offsetp)
6500 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6502 U8* send = s + *offsetp;
6504 STRLEN *cache = NULL;
6508 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6509 mg = mg_find(sv, PERL_MAGIC_utf8);
6510 if (mg && mg->mg_ptr) {
6511 cache = (STRLEN *) mg->mg_ptr;
6512 if (cache[1] == (STRLEN)*offsetp) {
6513 /* An exact match. */
6514 *offsetp = cache[0];
6518 else if (cache[1] < (STRLEN)*offsetp) {
6519 /* We already know part of the way. */
6522 /* Let the below loop do the rest. */
6524 else { /* cache[1] > *offsetp */
6525 /* We already know all of the way, now we may
6526 * be able to walk back. The same assumption
6527 * is made as in S_utf8_mg_pos(), namely that
6528 * walking backward is twice slower than
6529 * walking forward. */
6530 STRLEN forw = *offsetp;
6531 STRLEN backw = cache[1] - *offsetp;
6533 if (!(forw < 2 * backw)) {
6534 U8 *p = s + cache[1];
6541 while (UTF8_IS_CONTINUATION(*p)) {
6549 *offsetp = cache[0];
6551 /* Drop the stale "length" cache */
6559 ASSERT_UTF8_CACHE(cache);
6565 /* Call utf8n_to_uvchr() to validate the sequence
6566 * (unless a simple non-UTF character) */
6567 if (!UTF8_IS_INVARIANT(*s))
6568 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6577 if (!SvREADONLY(sv)) {
6579 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6580 mg = mg_find(sv, PERL_MAGIC_utf8);
6585 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6586 mg->mg_ptr = (char *) cache;
6591 cache[1] = *offsetp;
6592 /* Drop the stale "length" cache */
6605 Returns a boolean indicating whether the strings in the two SVs are
6606 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6607 coerce its args to strings if necessary.
6613 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6621 SV* svrecode = Nullsv;
6628 pv1 = SvPV(sv1, cur1);
6635 pv2 = SvPV(sv2, cur2);
6637 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6638 /* Differing utf8ness.
6639 * Do not UTF8size the comparands as a side-effect. */
6642 svrecode = newSVpvn(pv2, cur2);
6643 sv_recode_to_utf8(svrecode, PL_encoding);
6644 pv2 = SvPV(svrecode, cur2);
6647 svrecode = newSVpvn(pv1, cur1);
6648 sv_recode_to_utf8(svrecode, PL_encoding);
6649 pv1 = SvPV(svrecode, cur1);
6651 /* Now both are in UTF-8. */
6653 SvREFCNT_dec(svrecode);
6658 bool is_utf8 = TRUE;
6661 /* sv1 is the UTF-8 one,
6662 * if is equal it must be downgrade-able */
6663 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6669 /* sv2 is the UTF-8 one,
6670 * if is equal it must be downgrade-able */
6671 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6677 /* Downgrade not possible - cannot be eq */
6685 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6688 SvREFCNT_dec(svrecode);
6699 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6700 string in C<sv1> is less than, equal to, or greater than the string in
6701 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6702 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6708 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6711 char *pv1, *pv2, *tpv = Nullch;
6713 SV *svrecode = Nullsv;
6720 pv1 = SvPV(sv1, cur1);
6727 pv2 = SvPV(sv2, cur2);
6729 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6730 /* Differing utf8ness.
6731 * Do not UTF8size the comparands as a side-effect. */
6734 svrecode = newSVpvn(pv2, cur2);
6735 sv_recode_to_utf8(svrecode, PL_encoding);
6736 pv2 = SvPV(svrecode, cur2);
6739 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6744 svrecode = newSVpvn(pv1, cur1);
6745 sv_recode_to_utf8(svrecode, PL_encoding);
6746 pv1 = SvPV(svrecode, cur1);
6749 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6755 cmp = cur2 ? -1 : 0;
6759 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6762 cmp = retval < 0 ? -1 : 1;
6763 } else if (cur1 == cur2) {
6766 cmp = cur1 < cur2 ? -1 : 1;
6771 SvREFCNT_dec(svrecode);
6780 =for apidoc sv_cmp_locale
6782 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6783 'use bytes' aware, handles get magic, and will coerce its args to strings
6784 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6790 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6792 #ifdef USE_LOCALE_COLLATE
6798 if (PL_collation_standard)
6802 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6804 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6806 if (!pv1 || !len1) {
6817 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6820 return retval < 0 ? -1 : 1;
6823 * When the result of collation is equality, that doesn't mean
6824 * that there are no differences -- some locales exclude some
6825 * characters from consideration. So to avoid false equalities,
6826 * we use the raw string as a tiebreaker.
6832 #endif /* USE_LOCALE_COLLATE */
6834 return sv_cmp(sv1, sv2);
6838 #ifdef USE_LOCALE_COLLATE
6841 =for apidoc sv_collxfrm
6843 Add Collate Transform magic to an SV if it doesn't already have it.
6845 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6846 scalar data of the variable, but transformed to such a format that a normal
6847 memory comparison can be used to compare the data according to the locale
6854 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6858 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6859 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6864 Safefree(mg->mg_ptr);
6866 if ((xf = mem_collxfrm(s, len, &xlen))) {
6867 if (SvREADONLY(sv)) {
6870 return xf + sizeof(PL_collation_ix);
6873 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6874 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6887 if (mg && mg->mg_ptr) {
6889 return mg->mg_ptr + sizeof(PL_collation_ix);
6897 #endif /* USE_LOCALE_COLLATE */
6902 Get a line from the filehandle and store it into the SV, optionally
6903 appending to the currently-stored string.
6909 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6913 register STDCHAR rslast;
6914 register STDCHAR *bp;
6920 if (SvTHINKFIRST(sv))
6921 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6922 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6924 However, perlbench says it's slower, because the existing swipe code
6925 is faster than copy on write.
6926 Swings and roundabouts. */
6927 (void)SvUPGRADE(sv, SVt_PV);
6932 if (PerlIO_isutf8(fp)) {
6934 sv_utf8_upgrade_nomg(sv);
6935 sv_pos_u2b(sv,&append,0);
6937 } else if (SvUTF8(sv)) {
6938 SV *tsv = NEWSV(0,0);
6939 sv_gets(tsv, fp, 0);
6940 sv_utf8_upgrade_nomg(tsv);
6941 SvCUR_set(sv,append);
6944 goto return_string_or_null;
6949 if (PerlIO_isutf8(fp))
6952 if (IN_PERL_COMPILETIME) {
6953 /* we always read code in line mode */
6957 else if (RsSNARF(PL_rs)) {
6958 /* If it is a regular disk file use size from stat() as estimate
6959 of amount we are going to read - may result in malloc-ing
6960 more memory than we realy need if layers bellow reduce
6961 size we read (e.g. CRLF or a gzip layer)
6964 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6965 Off_t offset = PerlIO_tell(fp);
6966 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6967 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6973 else if (RsRECORD(PL_rs)) {
6977 /* Grab the size of the record we're getting */
6978 recsize = SvIV(SvRV(PL_rs));
6979 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6982 /* VMS wants read instead of fread, because fread doesn't respect */
6983 /* RMS record boundaries. This is not necessarily a good thing to be */
6984 /* doing, but we've got no other real choice - except avoid stdio
6985 as implementation - perhaps write a :vms layer ?
6987 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6989 bytesread = PerlIO_read(fp, buffer, recsize);
6993 SvCUR_set(sv, bytesread += append);
6994 buffer[bytesread] = '\0';
6995 goto return_string_or_null;
6997 else if (RsPARA(PL_rs)) {
7003 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7004 if (PerlIO_isutf8(fp)) {
7005 rsptr = SvPVutf8(PL_rs, rslen);
7008 if (SvUTF8(PL_rs)) {
7009 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7010 Perl_croak(aTHX_ "Wide character in $/");
7013 rsptr = SvPV(PL_rs, rslen);
7017 rslast = rslen ? rsptr[rslen - 1] : '\0';
7019 if (rspara) { /* have to do this both before and after */
7020 do { /* to make sure file boundaries work right */
7023 i = PerlIO_getc(fp);
7027 PerlIO_ungetc(fp,i);
7033 /* See if we know enough about I/O mechanism to cheat it ! */
7035 /* This used to be #ifdef test - it is made run-time test for ease
7036 of abstracting out stdio interface. One call should be cheap
7037 enough here - and may even be a macro allowing compile
7041 if (PerlIO_fast_gets(fp)) {
7044 * We're going to steal some values from the stdio struct
7045 * and put EVERYTHING in the innermost loop into registers.
7047 register STDCHAR *ptr;
7051 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7052 /* An ungetc()d char is handled separately from the regular
7053 * buffer, so we getc() it back out and stuff it in the buffer.
7055 i = PerlIO_getc(fp);
7056 if (i == EOF) return 0;
7057 *(--((*fp)->_ptr)) = (unsigned char) i;
7061 /* Here is some breathtakingly efficient cheating */
7063 cnt = PerlIO_get_cnt(fp); /* get count into register */
7064 /* make sure we have the room */
7065 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7066 /* Not room for all of it
7067 if we are looking for a separator and room for some
7069 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7070 /* just process what we have room for */
7071 shortbuffered = cnt - SvLEN(sv) + append + 1;
7072 cnt -= shortbuffered;
7076 /* remember that cnt can be negative */
7077 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7082 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7083 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7084 DEBUG_P(PerlIO_printf(Perl_debug_log,
7085 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7086 DEBUG_P(PerlIO_printf(Perl_debug_log,
7087 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7088 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7089 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7094 while (cnt > 0) { /* this | eat */
7096 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7097 goto thats_all_folks; /* screams | sed :-) */
7101 Copy(ptr, bp, cnt, char); /* this | eat */
7102 bp += cnt; /* screams | dust */
7103 ptr += cnt; /* louder | sed :-) */
7108 if (shortbuffered) { /* oh well, must extend */
7109 cnt = shortbuffered;
7111 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7113 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7114 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7118 DEBUG_P(PerlIO_printf(Perl_debug_log,
7119 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7120 PTR2UV(ptr),(long)cnt));
7121 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7123 DEBUG_P(PerlIO_printf(Perl_debug_log,
7124 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7125 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7126 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7128 /* This used to call 'filbuf' in stdio form, but as that behaves like
7129 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7130 another abstraction. */
7131 i = PerlIO_getc(fp); /* get more characters */
7133 DEBUG_P(PerlIO_printf(Perl_debug_log,
7134 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7135 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7136 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7138 cnt = PerlIO_get_cnt(fp);
7139 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7140 DEBUG_P(PerlIO_printf(Perl_debug_log,
7141 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7143 if (i == EOF) /* all done for ever? */
7144 goto thats_really_all_folks;
7146 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7148 SvGROW(sv, bpx + cnt + 2);
7149 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7151 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7153 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7154 goto thats_all_folks;
7158 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7159 memNE((char*)bp - rslen, rsptr, rslen))
7160 goto screamer; /* go back to the fray */
7161 thats_really_all_folks:
7163 cnt += shortbuffered;
7164 DEBUG_P(PerlIO_printf(Perl_debug_log,
7165 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7166 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7167 DEBUG_P(PerlIO_printf(Perl_debug_log,
7168 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7169 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7170 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7172 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7173 DEBUG_P(PerlIO_printf(Perl_debug_log,
7174 "Screamer: done, len=%ld, string=|%.*s|\n",
7175 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7179 /*The big, slow, and stupid way. */
7181 /* Any stack-challenged places. */
7183 /* EPOC: need to work around SDK features. *
7184 * On WINS: MS VC5 generates calls to _chkstk, *
7185 * if a "large" stack frame is allocated. *
7186 * gcc on MARM does not generate calls like these. */
7187 # define USEHEAPINSTEADOFSTACK
7190 #ifdef USEHEAPINSTEADOFSTACK
7192 New(0, buf, 8192, STDCHAR);
7200 register STDCHAR *bpe = buf + sizeof(buf);
7202 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7203 ; /* keep reading */
7207 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7208 /* Accomodate broken VAXC compiler, which applies U8 cast to
7209 * both args of ?: operator, causing EOF to change into 255
7212 i = (U8)buf[cnt - 1];
7218 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7220 sv_catpvn(sv, (char *) buf, cnt);
7222 sv_setpvn(sv, (char *) buf, cnt);
7224 if (i != EOF && /* joy */
7226 SvCUR(sv) < rslen ||
7227 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7231 * If we're reading from a TTY and we get a short read,
7232 * indicating that the user hit his EOF character, we need
7233 * to notice it now, because if we try to read from the TTY
7234 * again, the EOF condition will disappear.
7236 * The comparison of cnt to sizeof(buf) is an optimization
7237 * that prevents unnecessary calls to feof().
7241 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7245 #ifdef USEHEAPINSTEADOFSTACK
7250 if (rspara) { /* have to do this both before and after */
7251 while (i != EOF) { /* to make sure file boundaries work right */
7252 i = PerlIO_getc(fp);
7254 PerlIO_ungetc(fp,i);
7260 return_string_or_null:
7261 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7267 Auto-increment of the value in the SV, doing string to numeric conversion
7268 if necessary. Handles 'get' magic.
7274 Perl_sv_inc(pTHX_ register SV *sv)
7283 if (SvTHINKFIRST(sv)) {
7285 sv_force_normal_flags(sv, 0);
7286 if (SvREADONLY(sv)) {
7287 if (IN_PERL_RUNTIME)
7288 Perl_croak(aTHX_ PL_no_modify);
7292 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7294 i = PTR2IV(SvRV(sv));
7299 flags = SvFLAGS(sv);
7300 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7301 /* It's (privately or publicly) a float, but not tested as an
7302 integer, so test it to see. */
7304 flags = SvFLAGS(sv);
7306 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7307 /* It's publicly an integer, or privately an integer-not-float */
7308 #ifdef PERL_PRESERVE_IVUV
7312 if (SvUVX(sv) == UV_MAX)
7313 sv_setnv(sv, UV_MAX_P1);
7315 (void)SvIOK_only_UV(sv);
7318 if (SvIVX(sv) == IV_MAX)
7319 sv_setuv(sv, (UV)IV_MAX + 1);
7321 (void)SvIOK_only(sv);
7327 if (flags & SVp_NOK) {
7328 (void)SvNOK_only(sv);
7333 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7334 if ((flags & SVTYPEMASK) < SVt_PVIV)
7335 sv_upgrade(sv, SVt_IV);
7336 (void)SvIOK_only(sv);
7341 while (isALPHA(*d)) d++;
7342 while (isDIGIT(*d)) d++;
7344 #ifdef PERL_PRESERVE_IVUV
7345 /* Got to punt this as an integer if needs be, but we don't issue
7346 warnings. Probably ought to make the sv_iv_please() that does
7347 the conversion if possible, and silently. */
7348 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7349 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7350 /* Need to try really hard to see if it's an integer.
7351 9.22337203685478e+18 is an integer.
7352 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7353 so $a="9.22337203685478e+18"; $a+0; $a++
7354 needs to be the same as $a="9.22337203685478e+18"; $a++
7361 /* sv_2iv *should* have made this an NV */
7362 if (flags & SVp_NOK) {
7363 (void)SvNOK_only(sv);
7367 /* I don't think we can get here. Maybe I should assert this
7368 And if we do get here I suspect that sv_setnv will croak. NWC
7370 #if defined(USE_LONG_DOUBLE)
7371 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",
7372 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7374 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7375 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7378 #endif /* PERL_PRESERVE_IVUV */
7379 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7383 while (d >= SvPVX(sv)) {
7391 /* MKS: The original code here died if letters weren't consecutive.
7392 * at least it didn't have to worry about non-C locales. The
7393 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7394 * arranged in order (although not consecutively) and that only
7395 * [A-Za-z] are accepted by isALPHA in the C locale.
7397 if (*d != 'z' && *d != 'Z') {
7398 do { ++*d; } while (!isALPHA(*d));
7401 *(d--) -= 'z' - 'a';
7406 *(d--) -= 'z' - 'a' + 1;
7410 /* oh,oh, the number grew */
7411 SvGROW(sv, SvCUR(sv) + 2);
7413 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7424 Auto-decrement of the value in the SV, doing string to numeric conversion
7425 if necessary. Handles 'get' magic.
7431 Perl_sv_dec(pTHX_ register SV *sv)
7439 if (SvTHINKFIRST(sv)) {
7441 sv_force_normal_flags(sv, 0);
7442 if (SvREADONLY(sv)) {
7443 if (IN_PERL_RUNTIME)
7444 Perl_croak(aTHX_ PL_no_modify);
7448 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7450 i = PTR2IV(SvRV(sv));
7455 /* Unlike sv_inc we don't have to worry about string-never-numbers
7456 and keeping them magic. But we mustn't warn on punting */
7457 flags = SvFLAGS(sv);
7458 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7459 /* It's publicly an integer, or privately an integer-not-float */
7460 #ifdef PERL_PRESERVE_IVUV
7464 if (SvUVX(sv) == 0) {
7465 (void)SvIOK_only(sv);
7469 (void)SvIOK_only_UV(sv);
7473 if (SvIVX(sv) == IV_MIN)
7474 sv_setnv(sv, (NV)IV_MIN - 1.0);
7476 (void)SvIOK_only(sv);
7482 if (flags & SVp_NOK) {
7484 (void)SvNOK_only(sv);
7487 if (!(flags & SVp_POK)) {
7488 if ((flags & SVTYPEMASK) < SVt_PVNV)
7489 sv_upgrade(sv, SVt_NV);
7491 (void)SvNOK_only(sv);
7494 #ifdef PERL_PRESERVE_IVUV
7496 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7497 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7498 /* Need to try really hard to see if it's an integer.
7499 9.22337203685478e+18 is an integer.
7500 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7501 so $a="9.22337203685478e+18"; $a+0; $a--
7502 needs to be the same as $a="9.22337203685478e+18"; $a--
7509 /* sv_2iv *should* have made this an NV */
7510 if (flags & SVp_NOK) {
7511 (void)SvNOK_only(sv);
7515 /* I don't think we can get here. Maybe I should assert this
7516 And if we do get here I suspect that sv_setnv will croak. NWC
7518 #if defined(USE_LONG_DOUBLE)
7519 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",
7520 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7522 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7523 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7527 #endif /* PERL_PRESERVE_IVUV */
7528 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7532 =for apidoc sv_mortalcopy
7534 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7535 The new SV is marked as mortal. It will be destroyed "soon", either by an
7536 explicit call to FREETMPS, or by an implicit call at places such as
7537 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7542 /* Make a string that will exist for the duration of the expression
7543 * evaluation. Actually, it may have to last longer than that, but
7544 * hopefully we won't free it until it has been assigned to a
7545 * permanent location. */
7548 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7553 sv_setsv(sv,oldstr);
7555 PL_tmps_stack[++PL_tmps_ix] = sv;
7561 =for apidoc sv_newmortal
7563 Creates a new null SV which is mortal. The reference count of the SV is
7564 set to 1. It will be destroyed "soon", either by an explicit call to
7565 FREETMPS, or by an implicit call at places such as statement boundaries.
7566 See also C<sv_mortalcopy> and C<sv_2mortal>.
7572 Perl_sv_newmortal(pTHX)
7577 SvFLAGS(sv) = SVs_TEMP;
7579 PL_tmps_stack[++PL_tmps_ix] = sv;
7584 =for apidoc sv_2mortal
7586 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7587 by an explicit call to FREETMPS, or by an implicit call at places such as
7588 statement boundaries. SvTEMP() is turned on which means that the SV's
7589 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7590 and C<sv_mortalcopy>.
7596 Perl_sv_2mortal(pTHX_ register SV *sv)
7600 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7603 PL_tmps_stack[++PL_tmps_ix] = sv;
7611 Creates a new SV and copies a string into it. The reference count for the
7612 SV is set to 1. If C<len> is zero, Perl will compute the length using
7613 strlen(). For efficiency, consider using C<newSVpvn> instead.
7619 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7626 sv_setpvn(sv,s,len);
7631 =for apidoc newSVpvn
7633 Creates a new SV and copies a string into it. The reference count for the
7634 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7635 string. You are responsible for ensuring that the source string is at least
7636 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7642 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7647 sv_setpvn(sv,s,len);
7652 =for apidoc newSVpvn_share
7654 Creates a new SV with its SvPVX pointing to a shared string in the string
7655 table. If the string does not already exist in the table, it is created
7656 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7657 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7658 otherwise the hash is computed. The idea here is that as the string table
7659 is used for shared hash keys these strings will have SvPVX == HeKEY and
7660 hash lookup will avoid string compare.
7666 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7669 bool is_utf8 = FALSE;
7671 STRLEN tmplen = -len;
7673 /* See the note in hv.c:hv_fetch() --jhi */
7674 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7678 PERL_HASH(hash, src, len);
7680 sv_upgrade(sv, SVt_PVIV);
7681 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7694 #if defined(PERL_IMPLICIT_CONTEXT)
7696 /* pTHX_ magic can't cope with varargs, so this is a no-context
7697 * version of the main function, (which may itself be aliased to us).
7698 * Don't access this version directly.
7702 Perl_newSVpvf_nocontext(const char* pat, ...)
7707 va_start(args, pat);
7708 sv = vnewSVpvf(pat, &args);
7715 =for apidoc newSVpvf
7717 Creates a new SV and initializes it with the string formatted like
7724 Perl_newSVpvf(pTHX_ const char* pat, ...)
7728 va_start(args, pat);
7729 sv = vnewSVpvf(pat, &args);
7734 /* backend for newSVpvf() and newSVpvf_nocontext() */
7737 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7741 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7748 Creates a new SV and copies a floating point value into it.
7749 The reference count for the SV is set to 1.
7755 Perl_newSVnv(pTHX_ NV n)
7767 Creates a new SV and copies an integer into it. The reference count for the
7774 Perl_newSViv(pTHX_ IV i)
7786 Creates a new SV and copies an unsigned integer into it.
7787 The reference count for the SV is set to 1.
7793 Perl_newSVuv(pTHX_ UV u)
7803 =for apidoc newRV_noinc
7805 Creates an RV wrapper for an SV. The reference count for the original
7806 SV is B<not> incremented.
7812 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7817 sv_upgrade(sv, SVt_RV);
7824 /* newRV_inc is the official function name to use now.
7825 * newRV_inc is in fact #defined to newRV in sv.h
7829 Perl_newRV(pTHX_ SV *tmpRef)
7831 return newRV_noinc(SvREFCNT_inc(tmpRef));
7837 Creates a new SV which is an exact duplicate of the original SV.
7844 Perl_newSVsv(pTHX_ register SV *old)
7850 if (SvTYPE(old) == SVTYPEMASK) {
7851 if (ckWARN_d(WARN_INTERNAL))
7852 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7867 =for apidoc sv_reset
7869 Underlying implementation for the C<reset> Perl function.
7870 Note that the perl-level function is vaguely deprecated.
7876 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7884 char todo[PERL_UCHAR_MAX+1];
7889 if (!*s) { /* reset ?? searches */
7890 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7891 pm->op_pmdynflags &= ~PMdf_USED;
7896 /* reset variables */
7898 if (!HvARRAY(stash))
7901 Zero(todo, 256, char);
7903 i = (unsigned char)*s;
7907 max = (unsigned char)*s++;
7908 for ( ; i <= max; i++) {
7911 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7912 for (entry = HvARRAY(stash)[i];
7914 entry = HeNEXT(entry))
7916 if (!todo[(U8)*HeKEY(entry)])
7918 gv = (GV*)HeVAL(entry);
7920 if (SvTHINKFIRST(sv)) {
7921 if (!SvREADONLY(sv) && SvROK(sv))
7926 if (SvTYPE(sv) >= SVt_PV) {
7928 if (SvPVX(sv) != Nullch)
7935 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7938 #ifdef USE_ENVIRON_ARRAY
7940 # ifdef USE_ITHREADS
7941 && PL_curinterp == aTHX
7945 environ[0] = Nullch;
7948 #endif /* !PERL_MICRO */
7958 Using various gambits, try to get an IO from an SV: the IO slot if its a
7959 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7960 named after the PV if we're a string.
7966 Perl_sv_2io(pTHX_ SV *sv)
7972 switch (SvTYPE(sv)) {
7980 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7984 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7986 return sv_2io(SvRV(sv));
7987 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7993 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8002 Using various gambits, try to get a CV from an SV; in addition, try if
8003 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8009 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8016 return *gvp = Nullgv, Nullcv;
8017 switch (SvTYPE(sv)) {
8036 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8037 tryAMAGICunDEREF(to_cv);
8040 if (SvTYPE(sv) == SVt_PVCV) {
8049 Perl_croak(aTHX_ "Not a subroutine reference");
8054 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
8060 if (lref && !GvCVu(gv)) {
8063 tmpsv = NEWSV(704,0);
8064 gv_efullname3(tmpsv, gv, Nullch);
8065 /* XXX this is probably not what they think they're getting.
8066 * It has the same effect as "sub name;", i.e. just a forward
8068 newSUB(start_subparse(FALSE, 0),
8069 newSVOP(OP_CONST, 0, tmpsv),
8074 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8084 Returns true if the SV has a true value by Perl's rules.
8085 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8086 instead use an in-line version.
8092 Perl_sv_true(pTHX_ register SV *sv)
8098 if ((tXpv = (XPV*)SvANY(sv)) &&
8099 (tXpv->xpv_cur > 1 ||
8100 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8107 return SvIVX(sv) != 0;
8110 return SvNVX(sv) != 0.0;
8112 return sv_2bool(sv);
8120 A private implementation of the C<SvIVx> macro for compilers which can't
8121 cope with complex macro expressions. Always use the macro instead.
8127 Perl_sv_iv(pTHX_ register SV *sv)
8131 return (IV)SvUVX(sv);
8140 A private implementation of the C<SvUVx> macro for compilers which can't
8141 cope with complex macro expressions. Always use the macro instead.
8147 Perl_sv_uv(pTHX_ register SV *sv)
8152 return (UV)SvIVX(sv);
8160 A private implementation of the C<SvNVx> macro for compilers which can't
8161 cope with complex macro expressions. Always use the macro instead.
8167 Perl_sv_nv(pTHX_ register SV *sv)
8174 /* sv_pv() is now a macro using SvPV_nolen();
8175 * this function provided for binary compatibility only
8179 Perl_sv_pv(pTHX_ SV *sv)
8186 return sv_2pv(sv, &n_a);
8192 Use the C<SvPV_nolen> macro instead
8196 A private implementation of the C<SvPV> macro for compilers which can't
8197 cope with complex macro expressions. Always use the macro instead.
8203 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8209 return sv_2pv(sv, lp);
8214 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8220 return sv_2pv_flags(sv, lp, 0);
8223 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8224 * this function provided for binary compatibility only
8228 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8230 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8234 =for apidoc sv_pvn_force
8236 Get a sensible string out of the SV somehow.
8237 A private implementation of the C<SvPV_force> macro for compilers which
8238 can't cope with complex macro expressions. Always use the macro instead.
8240 =for apidoc sv_pvn_force_flags
8242 Get a sensible string out of the SV somehow.
8243 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8244 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8245 implemented in terms of this function.
8246 You normally want to use the various wrapper macros instead: see
8247 C<SvPV_force> and C<SvPV_force_nomg>
8253 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8257 if (SvTHINKFIRST(sv) && !SvROK(sv))
8258 sv_force_normal_flags(sv, 0);
8264 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8265 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8269 s = sv_2pv_flags(sv, lp, flags);
8270 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8275 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8276 SvGROW(sv, len + 1);
8277 Move(s,SvPVX(sv),len,char);
8282 SvPOK_on(sv); /* validate pointer */
8284 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8285 PTR2UV(sv),SvPVX(sv)));
8291 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8292 * this function provided for binary compatibility only
8296 Perl_sv_pvbyte(pTHX_ SV *sv)
8298 sv_utf8_downgrade(sv,0);
8303 =for apidoc sv_pvbyte
8305 Use C<SvPVbyte_nolen> instead.
8307 =for apidoc sv_pvbyten
8309 A private implementation of the C<SvPVbyte> macro for compilers
8310 which can't cope with complex macro expressions. Always use the macro
8317 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8319 sv_utf8_downgrade(sv,0);
8320 return sv_pvn(sv,lp);
8324 =for apidoc sv_pvbyten_force
8326 A private implementation of the C<SvPVbytex_force> macro for compilers
8327 which can't cope with complex macro expressions. Always use the macro
8334 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8336 sv_pvn_force(sv,lp);
8337 sv_utf8_downgrade(sv,0);
8342 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8343 * this function provided for binary compatibility only
8347 Perl_sv_pvutf8(pTHX_ SV *sv)
8349 sv_utf8_upgrade(sv);
8354 =for apidoc sv_pvutf8
8356 Use the C<SvPVutf8_nolen> macro instead
8358 =for apidoc sv_pvutf8n
8360 A private implementation of the C<SvPVutf8> macro for compilers
8361 which can't cope with complex macro expressions. Always use the macro
8368 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8370 sv_utf8_upgrade(sv);
8371 return sv_pvn(sv,lp);
8375 =for apidoc sv_pvutf8n_force
8377 A private implementation of the C<SvPVutf8_force> macro for compilers
8378 which can't cope with complex macro expressions. Always use the macro
8385 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8387 sv_pvn_force(sv,lp);
8388 sv_utf8_upgrade(sv);
8394 =for apidoc sv_reftype
8396 Returns a string describing what the SV is a reference to.
8402 Perl_sv_reftype(pTHX_ SV *sv, int ob)
8404 if (ob && SvOBJECT(sv)) {
8405 if (HvNAME(SvSTASH(sv)))
8406 return HvNAME(SvSTASH(sv));
8411 switch (SvTYPE(sv)) {
8428 case SVt_PVLV: return SvROK(sv) ? "REF"
8429 /* tied lvalues should appear to be
8430 * scalars for backwards compatitbility */
8431 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8432 ? "SCALAR" : "LVALUE";
8433 case SVt_PVAV: return "ARRAY";
8434 case SVt_PVHV: return "HASH";
8435 case SVt_PVCV: return "CODE";
8436 case SVt_PVGV: return "GLOB";
8437 case SVt_PVFM: return "FORMAT";
8438 case SVt_PVIO: return "IO";
8439 default: return "UNKNOWN";
8445 =for apidoc sv_isobject
8447 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8448 object. If the SV is not an RV, or if the object is not blessed, then this
8455 Perl_sv_isobject(pTHX_ SV *sv)
8472 Returns a boolean indicating whether the SV is blessed into the specified
8473 class. This does not check for subtypes; use C<sv_derived_from> to verify
8474 an inheritance relationship.
8480 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8491 if (!HvNAME(SvSTASH(sv)))
8494 return strEQ(HvNAME(SvSTASH(sv)), name);
8500 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8501 it will be upgraded to one. If C<classname> is non-null then the new SV will
8502 be blessed in the specified package. The new SV is returned and its
8503 reference count is 1.
8509 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8515 SV_CHECK_THINKFIRST_COW_DROP(rv);
8518 if (SvTYPE(rv) >= SVt_PVMG) {
8519 U32 refcnt = SvREFCNT(rv);
8523 SvREFCNT(rv) = refcnt;
8526 if (SvTYPE(rv) < SVt_RV)
8527 sv_upgrade(rv, SVt_RV);
8528 else if (SvTYPE(rv) > SVt_RV) {
8530 if (SvPVX(rv) && SvLEN(rv))
8531 Safefree(SvPVX(rv));
8541 HV* stash = gv_stashpv(classname, TRUE);
8542 (void)sv_bless(rv, stash);
8548 =for apidoc sv_setref_pv
8550 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8551 argument will be upgraded to an RV. That RV will be modified to point to
8552 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8553 into the SV. The C<classname> argument indicates the package for the
8554 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8555 will have a reference count of 1, and the RV will be returned.
8557 Do not use with other Perl types such as HV, AV, SV, CV, because those
8558 objects will become corrupted by the pointer copy process.
8560 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8566 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8569 sv_setsv(rv, &PL_sv_undef);
8573 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8578 =for apidoc sv_setref_iv
8580 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8581 argument will be upgraded to an RV. That RV will be modified to point to
8582 the new SV. The C<classname> argument indicates the package for the
8583 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8584 will have a reference count of 1, and the RV will be returned.
8590 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8592 sv_setiv(newSVrv(rv,classname), iv);
8597 =for apidoc sv_setref_uv
8599 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8600 argument will be upgraded to an RV. That RV will be modified to point to
8601 the new SV. The C<classname> argument indicates the package for the
8602 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8603 will have a reference count of 1, and the RV will be returned.
8609 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8611 sv_setuv(newSVrv(rv,classname), uv);
8616 =for apidoc sv_setref_nv
8618 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8619 argument will be upgraded to an RV. That RV will be modified to point to
8620 the new SV. The C<classname> argument indicates the package for the
8621 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8622 will have a reference count of 1, and the RV will be returned.
8628 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8630 sv_setnv(newSVrv(rv,classname), nv);
8635 =for apidoc sv_setref_pvn
8637 Copies a string into a new SV, optionally blessing the SV. The length of the
8638 string must be specified with C<n>. The C<rv> argument will be upgraded to
8639 an RV. That RV will be modified to point to the new SV. The C<classname>
8640 argument indicates the package for the blessing. Set C<classname> to
8641 C<Nullch> to avoid the blessing. The new SV will have a reference count
8642 of 1, and the RV will be returned.
8644 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8650 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8652 sv_setpvn(newSVrv(rv,classname), pv, n);
8657 =for apidoc sv_bless
8659 Blesses an SV into a specified package. The SV must be an RV. The package
8660 must be designated by its stash (see C<gv_stashpv()>). The reference count
8661 of the SV is unaffected.
8667 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8671 Perl_croak(aTHX_ "Can't bless non-reference value");
8673 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8674 if (SvREADONLY(tmpRef))
8675 Perl_croak(aTHX_ PL_no_modify);
8676 if (SvOBJECT(tmpRef)) {
8677 if (SvTYPE(tmpRef) != SVt_PVIO)
8679 SvREFCNT_dec(SvSTASH(tmpRef));
8682 SvOBJECT_on(tmpRef);
8683 if (SvTYPE(tmpRef) != SVt_PVIO)
8685 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8686 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8693 if(SvSMAGICAL(tmpRef))
8694 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8702 /* Downgrades a PVGV to a PVMG.
8706 S_sv_unglob(pTHX_ SV *sv)
8710 assert(SvTYPE(sv) == SVt_PVGV);
8715 SvREFCNT_dec(GvSTASH(sv));
8716 GvSTASH(sv) = Nullhv;
8718 sv_unmagic(sv, PERL_MAGIC_glob);
8719 Safefree(GvNAME(sv));
8722 /* need to keep SvANY(sv) in the right arena */
8723 xpvmg = new_XPVMG();
8724 StructCopy(SvANY(sv), xpvmg, XPVMG);
8725 del_XPVGV(SvANY(sv));
8728 SvFLAGS(sv) &= ~SVTYPEMASK;
8729 SvFLAGS(sv) |= SVt_PVMG;
8733 =for apidoc sv_unref_flags
8735 Unsets the RV status of the SV, and decrements the reference count of
8736 whatever was being referenced by the RV. This can almost be thought of
8737 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8738 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8739 (otherwise the decrementing is conditional on the reference count being
8740 different from one or the reference being a readonly SV).
8747 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8751 if (SvWEAKREF(sv)) {
8759 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8760 assigned to as BEGIN {$a = \"Foo"} will fail. */
8761 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8763 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8764 sv_2mortal(rv); /* Schedule for freeing later */
8768 =for apidoc sv_unref
8770 Unsets the RV status of the SV, and decrements the reference count of
8771 whatever was being referenced by the RV. This can almost be thought of
8772 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8773 being zero. See C<SvROK_off>.
8779 Perl_sv_unref(pTHX_ SV *sv)
8781 sv_unref_flags(sv, 0);
8785 =for apidoc sv_taint
8787 Taint an SV. Use C<SvTAINTED_on> instead.
8792 Perl_sv_taint(pTHX_ SV *sv)
8794 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8798 =for apidoc sv_untaint
8800 Untaint an SV. Use C<SvTAINTED_off> instead.
8805 Perl_sv_untaint(pTHX_ SV *sv)
8807 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8808 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8815 =for apidoc sv_tainted
8817 Test an SV for taintedness. Use C<SvTAINTED> instead.
8822 Perl_sv_tainted(pTHX_ SV *sv)
8824 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8825 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8826 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8833 =for apidoc sv_setpviv
8835 Copies an integer into the given SV, also updating its string value.
8836 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8842 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8844 char buf[TYPE_CHARS(UV)];
8846 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8848 sv_setpvn(sv, ptr, ebuf - ptr);
8852 =for apidoc sv_setpviv_mg
8854 Like C<sv_setpviv>, but also handles 'set' magic.
8860 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8862 char buf[TYPE_CHARS(UV)];
8864 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8866 sv_setpvn(sv, ptr, ebuf - ptr);
8870 #if defined(PERL_IMPLICIT_CONTEXT)
8872 /* pTHX_ magic can't cope with varargs, so this is a no-context
8873 * version of the main function, (which may itself be aliased to us).
8874 * Don't access this version directly.
8878 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8882 va_start(args, pat);
8883 sv_vsetpvf(sv, pat, &args);
8887 /* pTHX_ magic can't cope with varargs, so this is a no-context
8888 * version of the main function, (which may itself be aliased to us).
8889 * Don't access this version directly.
8893 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8897 va_start(args, pat);
8898 sv_vsetpvf_mg(sv, pat, &args);
8904 =for apidoc sv_setpvf
8906 Works like C<sv_catpvf> but copies the text into the SV instead of
8907 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8913 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8916 va_start(args, pat);
8917 sv_vsetpvf(sv, pat, &args);
8922 =for apidoc sv_vsetpvf
8924 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8925 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8927 Usually used via its frontend C<sv_setpvf>.
8933 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8935 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8939 =for apidoc sv_setpvf_mg
8941 Like C<sv_setpvf>, but also handles 'set' magic.
8947 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8950 va_start(args, pat);
8951 sv_vsetpvf_mg(sv, pat, &args);
8956 =for apidoc sv_vsetpvf_mg
8958 Like C<sv_vsetpvf>, but also handles 'set' magic.
8960 Usually used via its frontend C<sv_setpvf_mg>.
8966 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8968 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8972 #if defined(PERL_IMPLICIT_CONTEXT)
8974 /* pTHX_ magic can't cope with varargs, so this is a no-context
8975 * version of the main function, (which may itself be aliased to us).
8976 * Don't access this version directly.
8980 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8984 va_start(args, pat);
8985 sv_vcatpvf(sv, pat, &args);
8989 /* pTHX_ magic can't cope with varargs, so this is a no-context
8990 * version of the main function, (which may itself be aliased to us).
8991 * Don't access this version directly.
8995 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8999 va_start(args, pat);
9000 sv_vcatpvf_mg(sv, pat, &args);
9006 =for apidoc sv_catpvf
9008 Processes its arguments like C<sprintf> and appends the formatted
9009 output to an SV. If the appended data contains "wide" characters
9010 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9011 and characters >255 formatted with %c), the original SV might get
9012 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9018 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9021 va_start(args, pat);
9022 sv_vcatpvf(sv, pat, &args);
9027 =for apidoc sv_vcatpvf
9029 Processes its arguments like C<vsprintf> and appends the formatted output
9030 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9032 Usually used via its frontend C<sv_catpvf>.
9038 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9040 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9044 =for apidoc sv_catpvf_mg
9046 Like C<sv_catpvf>, but also handles 'set' magic.
9052 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9055 va_start(args, pat);
9056 sv_vcatpvf_mg(sv, pat, &args);
9061 =for apidoc sv_vcatpvf_mg
9063 Like C<sv_vcatpvf>, but also handles 'set' magic.
9065 Usually used via its frontend C<sv_catpvf_mg>.
9071 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9073 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9078 =for apidoc sv_vsetpvfn
9080 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9083 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9089 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9091 sv_setpvn(sv, "", 0);
9092 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9095 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9098 S_expect_number(pTHX_ char** pattern)
9101 switch (**pattern) {
9102 case '1': case '2': case '3':
9103 case '4': case '5': case '6':
9104 case '7': case '8': case '9':
9105 while (isDIGIT(**pattern))
9106 var = var * 10 + (*(*pattern)++ - '0');
9110 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9113 F0convert(NV nv, char *endbuf, STRLEN *len)
9124 if (uv & 1 && uv == nv)
9125 uv--; /* Round to even */
9127 unsigned dig = uv % 10;
9140 =for apidoc sv_vcatpvfn
9142 Processes its arguments like C<vsprintf> and appends the formatted output
9143 to an SV. Uses an array of SVs if the C style variable argument list is
9144 missing (NULL). When running with taint checks enabled, indicates via
9145 C<maybe_tainted> if results are untrustworthy (often due to the use of
9148 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9154 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9161 static char nullstr[] = "(null)";
9163 bool has_utf8; /* has the result utf8? */
9164 bool pat_utf8; /* the pattern is in utf8? */
9166 /* Times 4: a decimal digit takes more than 3 binary digits.
9167 * NV_DIG: mantissa takes than many decimal digits.
9168 * Plus 32: Playing safe. */
9169 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9170 /* large enough for "%#.#f" --chip */
9171 /* what about long double NVs? --jhi */
9173 has_utf8 = pat_utf8 = DO_UTF8(sv);
9175 /* no matter what, this is a string now */
9176 (void)SvPV_force(sv, origlen);
9178 /* special-case "", "%s", and "%_" */
9181 if (patlen == 2 && pat[0] == '%') {
9185 char *s = va_arg(*args, char*);
9186 sv_catpv(sv, s ? s : nullstr);
9188 else if (svix < svmax) {
9189 sv_catsv(sv, *svargs);
9190 if (DO_UTF8(*svargs))
9196 argsv = va_arg(*args, SV*);
9197 sv_catsv(sv, argsv);
9202 /* See comment on '_' below */
9207 #ifndef USE_LONG_DOUBLE
9208 /* special-case "%.<number>[gf]" */
9209 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9210 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9211 unsigned digits = 0;
9215 while (*pp >= '0' && *pp <= '9')
9216 digits = 10 * digits + (*pp++ - '0');
9217 if (pp - pat == (int)patlen - 1) {
9221 nv = (NV)va_arg(*args, double);
9222 else if (svix < svmax)
9227 /* Add check for digits != 0 because it seems that some
9228 gconverts are buggy in this case, and we don't yet have
9229 a Configure test for this. */
9230 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9231 /* 0, point, slack */
9232 Gconvert(nv, (int)digits, 0, ebuf);
9234 if (*ebuf) /* May return an empty string for digits==0 */
9237 } else if (!digits) {
9240 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9241 sv_catpvn(sv, p, l);
9247 #endif /* !USE_LONG_DOUBLE */
9249 if (!args && svix < svmax && DO_UTF8(*svargs))
9252 patend = (char*)pat + patlen;
9253 for (p = (char*)pat; p < patend; p = q) {
9256 bool vectorize = FALSE;
9257 bool vectorarg = FALSE;
9258 bool vec_utf8 = FALSE;
9264 bool has_precis = FALSE;
9267 bool is_utf8 = FALSE; /* is this item utf8? */
9268 #ifdef HAS_LDBL_SPRINTF_BUG
9269 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9270 with sfio - Allen <allens@cpan.org> */
9271 bool fix_ldbl_sprintf_bug = FALSE;
9275 U8 utf8buf[UTF8_MAXLEN+1];
9276 STRLEN esignlen = 0;
9278 char *eptr = Nullch;
9281 U8 *vecstr = Null(U8*);
9288 /* we need a long double target in case HAS_LONG_DOUBLE but
9291 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9300 STRLEN dotstrlen = 1;
9301 I32 efix = 0; /* explicit format parameter index */
9302 I32 ewix = 0; /* explicit width index */
9303 I32 epix = 0; /* explicit precision index */
9304 I32 evix = 0; /* explicit vector index */
9305 bool asterisk = FALSE;
9307 /* echo everything up to the next format specification */
9308 for (q = p; q < patend && *q != '%'; ++q) ;
9310 if (has_utf8 && !pat_utf8)
9311 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9313 sv_catpvn(sv, p, q - p);
9320 We allow format specification elements in this order:
9321 \d+\$ explicit format parameter index
9323 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9324 0 flag (as above): repeated to allow "v02"
9325 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9326 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9328 [%bcdefginopsux_DFOUX] format (mandatory)
9330 if (EXPECT_NUMBER(q, width)) {
9371 if (EXPECT_NUMBER(q, ewix))
9380 if ((vectorarg = asterisk)) {
9392 EXPECT_NUMBER(q, width);
9397 vecsv = va_arg(*args, SV*);
9399 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9400 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9401 dotstr = SvPVx(vecsv, dotstrlen);
9406 vecsv = va_arg(*args, SV*);
9407 vecstr = (U8*)SvPVx(vecsv,veclen);
9408 vec_utf8 = DO_UTF8(vecsv);
9410 else if (efix ? efix <= svmax : svix < svmax) {
9411 vecsv = svargs[efix ? efix-1 : svix++];
9412 vecstr = (U8*)SvPVx(vecsv,veclen);
9413 vec_utf8 = DO_UTF8(vecsv);
9414 /* if this is a version object, we need to return the
9415 * stringified representation (which the SvPVX has
9416 * already done for us), but not vectorize the args
9418 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9420 q++; /* skip past the rest of the %vd format */
9421 eptr = (char *) vecstr;
9422 elen = strlen(eptr);
9435 i = va_arg(*args, int);
9437 i = (ewix ? ewix <= svmax : svix < svmax) ?
9438 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9440 width = (i < 0) ? -i : i;
9450 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9452 /* XXX: todo, support specified precision parameter */
9456 i = va_arg(*args, int);
9458 i = (ewix ? ewix <= svmax : svix < svmax)
9459 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9460 precis = (i < 0) ? 0 : i;
9465 precis = precis * 10 + (*q++ - '0');
9474 case 'I': /* Ix, I32x, and I64x */
9476 if (q[1] == '6' && q[2] == '4') {
9482 if (q[1] == '3' && q[2] == '2') {
9492 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9503 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9504 if (*(q + 1) == 'l') { /* lld, llf */
9529 argsv = (efix ? efix <= svmax : svix < svmax) ?
9530 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9537 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9539 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9541 eptr = (char*)utf8buf;
9542 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9553 if (args && !vectorize) {
9554 eptr = va_arg(*args, char*);
9556 #ifdef MACOS_TRADITIONAL
9557 /* On MacOS, %#s format is used for Pascal strings */
9562 elen = strlen(eptr);
9565 elen = sizeof nullstr - 1;
9569 eptr = SvPVx(argsv, elen);
9570 if (DO_UTF8(argsv)) {
9571 if (has_precis && precis < elen) {
9573 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9576 if (width) { /* fudge width (can't fudge elen) */
9577 width += elen - sv_len_utf8(argsv);
9586 * The "%_" hack might have to be changed someday,
9587 * if ISO or ANSI decide to use '_' for something.
9588 * So we keep it hidden from users' code.
9590 if (!args || vectorize)
9592 argsv = va_arg(*args, SV*);
9593 eptr = SvPVx(argsv, elen);
9599 if (has_precis && elen > precis)
9606 if (alt || vectorize)
9608 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9626 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9635 esignbuf[esignlen++] = plus;
9639 case 'h': iv = (short)va_arg(*args, int); break;
9640 case 'l': iv = va_arg(*args, long); break;
9641 case 'V': iv = va_arg(*args, IV); break;
9642 default: iv = va_arg(*args, int); break;
9644 case 'q': iv = va_arg(*args, Quad_t); break;
9649 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9651 case 'h': iv = (short)tiv; break;
9652 case 'l': iv = (long)tiv; break;
9654 default: iv = tiv; break;
9656 case 'q': iv = (Quad_t)tiv; break;
9660 if ( !vectorize ) /* we already set uv above */
9665 esignbuf[esignlen++] = plus;
9669 esignbuf[esignlen++] = '-';
9712 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9723 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9724 case 'l': uv = va_arg(*args, unsigned long); break;
9725 case 'V': uv = va_arg(*args, UV); break;
9726 default: uv = va_arg(*args, unsigned); break;
9728 case 'q': uv = va_arg(*args, Uquad_t); break;
9733 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9735 case 'h': uv = (unsigned short)tuv; break;
9736 case 'l': uv = (unsigned long)tuv; break;
9738 default: uv = tuv; break;
9740 case 'q': uv = (Uquad_t)tuv; break;
9746 eptr = ebuf + sizeof ebuf;
9752 p = (char*)((c == 'X')
9753 ? "0123456789ABCDEF" : "0123456789abcdef");
9759 esignbuf[esignlen++] = '0';
9760 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9766 *--eptr = '0' + dig;
9768 if (alt && *eptr != '0')
9774 *--eptr = '0' + dig;
9777 esignbuf[esignlen++] = '0';
9778 esignbuf[esignlen++] = 'b';
9781 default: /* it had better be ten or less */
9782 #if defined(PERL_Y2KWARN)
9783 if (ckWARN(WARN_Y2K)) {
9785 char *s = SvPV(sv,n);
9786 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9787 && (n == 2 || !isDIGIT(s[n-3])))
9789 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9790 "Possible Y2K bug: %%%c %s",
9791 c, "format string following '19'");
9797 *--eptr = '0' + dig;
9798 } while (uv /= base);
9801 elen = (ebuf + sizeof ebuf) - eptr;
9804 zeros = precis - elen;
9805 else if (precis == 0 && elen == 1 && *eptr == '0')
9810 /* FLOATING POINT */
9813 c = 'f'; /* maybe %F isn't supported here */
9819 /* This is evil, but floating point is even more evil */
9821 /* for SV-style calling, we can only get NV
9822 for C-style calling, we assume %f is double;
9823 for simplicity we allow any of %Lf, %llf, %qf for long double
9827 #if defined(USE_LONG_DOUBLE)
9831 /* [perl #20339] - we should accept and ignore %lf rather than die */
9835 #if defined(USE_LONG_DOUBLE)
9836 intsize = args ? 0 : 'q';
9840 #if defined(HAS_LONG_DOUBLE)
9849 /* now we need (long double) if intsize == 'q', else (double) */
9850 nv = (args && !vectorize) ?
9851 #if LONG_DOUBLESIZE > DOUBLESIZE
9853 va_arg(*args, long double) :
9854 va_arg(*args, double)
9856 va_arg(*args, double)
9862 if (c != 'e' && c != 'E') {
9864 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9865 will cast our (long double) to (double) */
9866 (void)Perl_frexp(nv, &i);
9867 if (i == PERL_INT_MIN)
9868 Perl_die(aTHX_ "panic: frexp");
9870 need = BIT_DIGITS(i);
9872 need += has_precis ? precis : 6; /* known default */
9877 #ifdef HAS_LDBL_SPRINTF_BUG
9878 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9879 with sfio - Allen <allens@cpan.org> */
9882 # define MY_DBL_MAX DBL_MAX
9883 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9884 # if DOUBLESIZE >= 8
9885 # define MY_DBL_MAX 1.7976931348623157E+308L
9887 # define MY_DBL_MAX 3.40282347E+38L
9891 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9892 # define MY_DBL_MAX_BUG 1L
9894 # define MY_DBL_MAX_BUG MY_DBL_MAX
9898 # define MY_DBL_MIN DBL_MIN
9899 # else /* XXX guessing! -Allen */
9900 # if DOUBLESIZE >= 8
9901 # define MY_DBL_MIN 2.2250738585072014E-308L
9903 # define MY_DBL_MIN 1.17549435E-38L
9907 if ((intsize == 'q') && (c == 'f') &&
9908 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9910 /* it's going to be short enough that
9911 * long double precision is not needed */
9913 if ((nv <= 0L) && (nv >= -0L))
9914 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9916 /* would use Perl_fp_class as a double-check but not
9917 * functional on IRIX - see perl.h comments */
9919 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9920 /* It's within the range that a double can represent */
9921 #if defined(DBL_MAX) && !defined(DBL_MIN)
9922 if ((nv >= ((long double)1/DBL_MAX)) ||
9923 (nv <= (-(long double)1/DBL_MAX)))
9925 fix_ldbl_sprintf_bug = TRUE;
9928 if (fix_ldbl_sprintf_bug == TRUE) {
9938 # undef MY_DBL_MAX_BUG
9941 #endif /* HAS_LDBL_SPRINTF_BUG */
9943 need += 20; /* fudge factor */
9944 if (PL_efloatsize < need) {
9945 Safefree(PL_efloatbuf);
9946 PL_efloatsize = need + 20; /* more fudge */
9947 New(906, PL_efloatbuf, PL_efloatsize, char);
9948 PL_efloatbuf[0] = '\0';
9951 if ( !(width || left || plus || alt) && fill != '0'
9952 && has_precis && intsize != 'q' ) { /* Shortcuts */
9953 /* See earlier comment about buggy Gconvert when digits,
9955 if ( c == 'g' && precis) {
9956 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9957 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9958 goto float_converted;
9959 } else if ( c == 'f' && !precis) {
9960 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9964 eptr = ebuf + sizeof ebuf;
9967 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9968 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9969 if (intsize == 'q') {
9970 /* Copy the one or more characters in a long double
9971 * format before the 'base' ([efgEFG]) character to
9972 * the format string. */
9973 static char const prifldbl[] = PERL_PRIfldbl;
9974 char const *p = prifldbl + sizeof(prifldbl) - 3;
9975 while (p >= prifldbl) { *--eptr = *p--; }
9980 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9985 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9997 /* No taint. Otherwise we are in the strange situation
9998 * where printf() taints but print($float) doesn't.
10000 #if defined(HAS_LONG_DOUBLE)
10001 if (intsize == 'q')
10002 (void)sprintf(PL_efloatbuf, eptr, nv);
10004 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10006 (void)sprintf(PL_efloatbuf, eptr, nv);
10009 eptr = PL_efloatbuf;
10010 elen = strlen(PL_efloatbuf);
10016 i = SvCUR(sv) - origlen;
10017 if (args && !vectorize) {
10019 case 'h': *(va_arg(*args, short*)) = i; break;
10020 default: *(va_arg(*args, int*)) = i; break;
10021 case 'l': *(va_arg(*args, long*)) = i; break;
10022 case 'V': *(va_arg(*args, IV*)) = i; break;
10024 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10029 sv_setuv_mg(argsv, (UV)i);
10031 continue; /* not "break" */
10037 if (!args && ckWARN(WARN_PRINTF) &&
10038 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10039 SV *msg = sv_newmortal();
10040 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10041 (PL_op->op_type == OP_PRTF) ? "" : "s");
10044 Perl_sv_catpvf(aTHX_ msg,
10045 "\"%%%c\"", c & 0xFF);
10047 Perl_sv_catpvf(aTHX_ msg,
10048 "\"%%\\%03"UVof"\"",
10051 sv_catpv(msg, "end of string");
10052 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10055 /* output mangled stuff ... */
10061 /* ... right here, because formatting flags should not apply */
10062 SvGROW(sv, SvCUR(sv) + elen + 1);
10064 Copy(eptr, p, elen, char);
10067 SvCUR(sv) = p - SvPVX(sv);
10069 continue; /* not "break" */
10072 /* calculate width before utf8_upgrade changes it */
10073 have = esignlen + zeros + elen;
10075 if (is_utf8 != has_utf8) {
10078 sv_utf8_upgrade(sv);
10081 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10082 sv_utf8_upgrade(nsv);
10086 SvGROW(sv, SvCUR(sv) + elen + 1);
10091 need = (have > width ? have : width);
10094 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10096 if (esignlen && fill == '0') {
10097 for (i = 0; i < (int)esignlen; i++)
10098 *p++ = esignbuf[i];
10100 if (gap && !left) {
10101 memset(p, fill, gap);
10104 if (esignlen && fill != '0') {
10105 for (i = 0; i < (int)esignlen; i++)
10106 *p++ = esignbuf[i];
10109 for (i = zeros; i; i--)
10113 Copy(eptr, p, elen, char);
10117 memset(p, ' ', gap);
10122 Copy(dotstr, p, dotstrlen, char);
10126 vectorize = FALSE; /* done iterating over vecstr */
10133 SvCUR(sv) = p - SvPVX(sv);
10141 /* =========================================================================
10143 =head1 Cloning an interpreter
10145 All the macros and functions in this section are for the private use of
10146 the main function, perl_clone().
10148 The foo_dup() functions make an exact copy of an existing foo thinngy.
10149 During the course of a cloning, a hash table is used to map old addresses
10150 to new addresses. The table is created and manipulated with the
10151 ptr_table_* functions.
10155 ============================================================================*/
10158 #if defined(USE_ITHREADS)
10160 #ifndef GpREFCNT_inc
10161 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10165 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10166 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10167 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10168 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10169 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10170 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10171 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10172 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10173 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10174 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10175 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10176 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10177 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10180 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10181 regcomp.c. AMS 20010712 */
10184 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10188 struct reg_substr_datum *s;
10191 return (REGEXP *)NULL;
10193 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10196 len = r->offsets[0];
10197 npar = r->nparens+1;
10199 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10200 Copy(r->program, ret->program, len+1, regnode);
10202 New(0, ret->startp, npar, I32);
10203 Copy(r->startp, ret->startp, npar, I32);
10204 New(0, ret->endp, npar, I32);
10205 Copy(r->startp, ret->startp, npar, I32);
10207 New(0, ret->substrs, 1, struct reg_substr_data);
10208 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10209 s->min_offset = r->substrs->data[i].min_offset;
10210 s->max_offset = r->substrs->data[i].max_offset;
10211 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10212 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10215 ret->regstclass = NULL;
10217 struct reg_data *d;
10218 int count = r->data->count;
10220 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10221 char, struct reg_data);
10222 New(0, d->what, count, U8);
10225 for (i = 0; i < count; i++) {
10226 d->what[i] = r->data->what[i];
10227 switch (d->what[i]) {
10229 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10232 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10235 /* This is cheating. */
10236 New(0, d->data[i], 1, struct regnode_charclass_class);
10237 StructCopy(r->data->data[i], d->data[i],
10238 struct regnode_charclass_class);
10239 ret->regstclass = (regnode*)d->data[i];
10242 /* Compiled op trees are readonly, and can thus be
10243 shared without duplication. */
10244 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10247 d->data[i] = r->data->data[i];
10257 New(0, ret->offsets, 2*len+1, U32);
10258 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10260 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10261 ret->refcnt = r->refcnt;
10262 ret->minlen = r->minlen;
10263 ret->prelen = r->prelen;
10264 ret->nparens = r->nparens;
10265 ret->lastparen = r->lastparen;
10266 ret->lastcloseparen = r->lastcloseparen;
10267 ret->reganch = r->reganch;
10269 ret->sublen = r->sublen;
10271 if (RX_MATCH_COPIED(ret))
10272 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10274 ret->subbeg = Nullch;
10275 #ifdef PERL_COPY_ON_WRITE
10276 ret->saved_copy = Nullsv;
10279 ptr_table_store(PL_ptr_table, r, ret);
10283 /* duplicate a file handle */
10286 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10290 return (PerlIO*)NULL;
10292 /* look for it in the table first */
10293 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10297 /* create anew and remember what it is */
10298 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10299 ptr_table_store(PL_ptr_table, fp, ret);
10303 /* duplicate a directory handle */
10306 Perl_dirp_dup(pTHX_ DIR *dp)
10314 /* duplicate a typeglob */
10317 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10322 /* look for it in the table first */
10323 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10327 /* create anew and remember what it is */
10328 Newz(0, ret, 1, GP);
10329 ptr_table_store(PL_ptr_table, gp, ret);
10332 ret->gp_refcnt = 0; /* must be before any other dups! */
10333 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10334 ret->gp_io = io_dup_inc(gp->gp_io, param);
10335 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10336 ret->gp_av = av_dup_inc(gp->gp_av, param);
10337 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10338 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10339 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10340 ret->gp_cvgen = gp->gp_cvgen;
10341 ret->gp_flags = gp->gp_flags;
10342 ret->gp_line = gp->gp_line;
10343 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10347 /* duplicate a chain of magic */
10350 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10352 MAGIC *mgprev = (MAGIC*)NULL;
10355 return (MAGIC*)NULL;
10356 /* look for it in the table first */
10357 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10361 for (; mg; mg = mg->mg_moremagic) {
10363 Newz(0, nmg, 1, MAGIC);
10365 mgprev->mg_moremagic = nmg;
10368 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10369 nmg->mg_private = mg->mg_private;
10370 nmg->mg_type = mg->mg_type;
10371 nmg->mg_flags = mg->mg_flags;
10372 if (mg->mg_type == PERL_MAGIC_qr) {
10373 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10375 else if(mg->mg_type == PERL_MAGIC_backref) {
10376 AV *av = (AV*) mg->mg_obj;
10379 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10381 for (i = AvFILLp(av); i >= 0; i--) {
10382 if (!svp[i]) continue;
10383 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10387 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10388 ? sv_dup_inc(mg->mg_obj, param)
10389 : sv_dup(mg->mg_obj, param);
10391 nmg->mg_len = mg->mg_len;
10392 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10393 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10394 if (mg->mg_len > 0) {
10395 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10396 if (mg->mg_type == PERL_MAGIC_overload_table &&
10397 AMT_AMAGIC((AMT*)mg->mg_ptr))
10399 AMT *amtp = (AMT*)mg->mg_ptr;
10400 AMT *namtp = (AMT*)nmg->mg_ptr;
10402 for (i = 1; i < NofAMmeth; i++) {
10403 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10407 else if (mg->mg_len == HEf_SVKEY)
10408 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10410 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10411 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10418 /* create a new pointer-mapping table */
10421 Perl_ptr_table_new(pTHX)
10424 Newz(0, tbl, 1, PTR_TBL_t);
10425 tbl->tbl_max = 511;
10426 tbl->tbl_items = 0;
10427 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10432 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10434 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10437 /* map an existing pointer using a table */
10440 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10442 PTR_TBL_ENT_t *tblent;
10443 UV hash = PTR_TABLE_HASH(sv);
10445 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10446 for (; tblent; tblent = tblent->next) {
10447 if (tblent->oldval == sv)
10448 return tblent->newval;
10450 return (void*)NULL;
10453 /* add a new entry to a pointer-mapping table */
10456 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10458 PTR_TBL_ENT_t *tblent, **otblent;
10459 /* XXX this may be pessimal on platforms where pointers aren't good
10460 * hash values e.g. if they grow faster in the most significant
10462 UV hash = PTR_TABLE_HASH(oldv);
10466 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10467 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10468 if (tblent->oldval == oldv) {
10469 tblent->newval = newv;
10473 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10474 tblent->oldval = oldv;
10475 tblent->newval = newv;
10476 tblent->next = *otblent;
10479 if (!empty && tbl->tbl_items > tbl->tbl_max)
10480 ptr_table_split(tbl);
10483 /* double the hash bucket size of an existing ptr table */
10486 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10488 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10489 UV oldsize = tbl->tbl_max + 1;
10490 UV newsize = oldsize * 2;
10493 Renew(ary, newsize, PTR_TBL_ENT_t*);
10494 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10495 tbl->tbl_max = --newsize;
10496 tbl->tbl_ary = ary;
10497 for (i=0; i < oldsize; i++, ary++) {
10498 PTR_TBL_ENT_t **curentp, **entp, *ent;
10501 curentp = ary + oldsize;
10502 for (entp = ary, ent = *ary; ent; ent = *entp) {
10503 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10505 ent->next = *curentp;
10515 /* remove all the entries from a ptr table */
10518 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10520 register PTR_TBL_ENT_t **array;
10521 register PTR_TBL_ENT_t *entry;
10522 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10526 if (!tbl || !tbl->tbl_items) {
10530 array = tbl->tbl_ary;
10532 max = tbl->tbl_max;
10537 entry = entry->next;
10541 if (++riter > max) {
10544 entry = array[riter];
10548 tbl->tbl_items = 0;
10551 /* clear and free a ptr table */
10554 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10559 ptr_table_clear(tbl);
10560 Safefree(tbl->tbl_ary);
10565 char *PL_watch_pvx;
10568 /* attempt to make everything in the typeglob readonly */
10571 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10573 GV *gv = (GV*)sstr;
10574 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10576 if (GvIO(gv) || GvFORM(gv)) {
10577 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10579 else if (!GvCV(gv)) {
10580 GvCV(gv) = (CV*)sv;
10583 /* CvPADLISTs cannot be shared */
10584 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10589 if (!GvUNIQUE(gv)) {
10591 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10592 HvNAME(GvSTASH(gv)), GvNAME(gv));
10598 * write attempts will die with
10599 * "Modification of a read-only value attempted"
10605 SvREADONLY_on(GvSV(gv));
10609 GvAV(gv) = (AV*)sv;
10612 SvREADONLY_on(GvAV(gv));
10616 GvHV(gv) = (HV*)sv;
10619 SvREADONLY_on(GvHV(gv));
10622 return sstr; /* he_dup() will SvREFCNT_inc() */
10625 /* duplicate an SV of any type (including AV, HV etc) */
10628 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10631 SvRV(dstr) = SvWEAKREF(sstr)
10632 ? sv_dup(SvRV(sstr), param)
10633 : sv_dup_inc(SvRV(sstr), param);
10635 else if (SvPVX(sstr)) {
10636 /* Has something there */
10638 /* Normal PV - clone whole allocated space */
10639 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10640 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10641 /* Not that normal - actually sstr is copy on write.
10642 But we are a true, independant SV, so: */
10643 SvREADONLY_off(dstr);
10648 /* Special case - not normally malloced for some reason */
10649 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10650 /* A "shared" PV - clone it as unshared string */
10651 if(SvPADTMP(sstr)) {
10652 /* However, some of them live in the pad
10653 and they should not have these flags
10656 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10658 SvUVX(dstr) = SvUVX(sstr);
10661 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10663 SvREADONLY_off(dstr);
10667 /* Some other special case - random pointer */
10668 SvPVX(dstr) = SvPVX(sstr);
10673 /* Copy the Null */
10674 SvPVX(dstr) = SvPVX(sstr);
10679 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10683 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10685 /* look for it in the table first */
10686 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10690 if(param->flags & CLONEf_JOIN_IN) {
10691 /** We are joining here so we don't want do clone
10692 something that is bad **/
10694 if(SvTYPE(sstr) == SVt_PVHV &&
10696 /** don't clone stashes if they already exist **/
10697 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10698 return (SV*) old_stash;
10702 /* create anew and remember what it is */
10704 ptr_table_store(PL_ptr_table, sstr, dstr);
10707 SvFLAGS(dstr) = SvFLAGS(sstr);
10708 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10709 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10712 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10713 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10714 PL_watch_pvx, SvPVX(sstr));
10717 switch (SvTYPE(sstr)) {
10719 SvANY(dstr) = NULL;
10722 SvANY(dstr) = new_XIV();
10723 SvIVX(dstr) = SvIVX(sstr);
10726 SvANY(dstr) = new_XNV();
10727 SvNVX(dstr) = SvNVX(sstr);
10730 SvANY(dstr) = new_XRV();
10731 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10734 SvANY(dstr) = new_XPV();
10735 SvCUR(dstr) = SvCUR(sstr);
10736 SvLEN(dstr) = SvLEN(sstr);
10737 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10740 SvANY(dstr) = new_XPVIV();
10741 SvCUR(dstr) = SvCUR(sstr);
10742 SvLEN(dstr) = SvLEN(sstr);
10743 SvIVX(dstr) = SvIVX(sstr);
10744 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10747 SvANY(dstr) = new_XPVNV();
10748 SvCUR(dstr) = SvCUR(sstr);
10749 SvLEN(dstr) = SvLEN(sstr);
10750 SvIVX(dstr) = SvIVX(sstr);
10751 SvNVX(dstr) = SvNVX(sstr);
10752 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10755 SvANY(dstr) = new_XPVMG();
10756 SvCUR(dstr) = SvCUR(sstr);
10757 SvLEN(dstr) = SvLEN(sstr);
10758 SvIVX(dstr) = SvIVX(sstr);
10759 SvNVX(dstr) = SvNVX(sstr);
10760 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10761 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10762 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10765 SvANY(dstr) = new_XPVBM();
10766 SvCUR(dstr) = SvCUR(sstr);
10767 SvLEN(dstr) = SvLEN(sstr);
10768 SvIVX(dstr) = SvIVX(sstr);
10769 SvNVX(dstr) = SvNVX(sstr);
10770 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10771 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10772 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10773 BmRARE(dstr) = BmRARE(sstr);
10774 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10775 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10778 SvANY(dstr) = new_XPVLV();
10779 SvCUR(dstr) = SvCUR(sstr);
10780 SvLEN(dstr) = SvLEN(sstr);
10781 SvIVX(dstr) = SvIVX(sstr);
10782 SvNVX(dstr) = SvNVX(sstr);
10783 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10784 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10785 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10786 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10787 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10788 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10789 LvTARG(dstr) = dstr;
10790 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10791 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10793 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10794 LvTYPE(dstr) = LvTYPE(sstr);
10797 if (GvUNIQUE((GV*)sstr)) {
10799 if ((share = gv_share(sstr, param))) {
10802 ptr_table_store(PL_ptr_table, sstr, dstr);
10804 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10805 HvNAME(GvSTASH(share)), GvNAME(share));
10810 SvANY(dstr) = new_XPVGV();
10811 SvCUR(dstr) = SvCUR(sstr);
10812 SvLEN(dstr) = SvLEN(sstr);
10813 SvIVX(dstr) = SvIVX(sstr);
10814 SvNVX(dstr) = SvNVX(sstr);
10815 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10816 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10817 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10818 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10819 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10820 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10821 GvFLAGS(dstr) = GvFLAGS(sstr);
10822 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10823 (void)GpREFCNT_inc(GvGP(dstr));
10826 SvANY(dstr) = new_XPVIO();
10827 SvCUR(dstr) = SvCUR(sstr);
10828 SvLEN(dstr) = SvLEN(sstr);
10829 SvIVX(dstr) = SvIVX(sstr);
10830 SvNVX(dstr) = SvNVX(sstr);
10831 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10832 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10833 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10834 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10835 if (IoOFP(sstr) == IoIFP(sstr))
10836 IoOFP(dstr) = IoIFP(dstr);
10838 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10839 /* PL_rsfp_filters entries have fake IoDIRP() */
10840 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10841 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10843 IoDIRP(dstr) = IoDIRP(sstr);
10844 IoLINES(dstr) = IoLINES(sstr);
10845 IoPAGE(dstr) = IoPAGE(sstr);
10846 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10847 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10848 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10849 /* I have no idea why fake dirp (rsfps)
10850 should be treaded differently but otherwise
10851 we end up with leaks -- sky*/
10852 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10853 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10854 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10856 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10857 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10858 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10860 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10861 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10862 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10863 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10864 IoTYPE(dstr) = IoTYPE(sstr);
10865 IoFLAGS(dstr) = IoFLAGS(sstr);
10868 SvANY(dstr) = new_XPVAV();
10869 SvCUR(dstr) = SvCUR(sstr);
10870 SvLEN(dstr) = SvLEN(sstr);
10871 SvIVX(dstr) = SvIVX(sstr);
10872 SvNVX(dstr) = SvNVX(sstr);
10873 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10874 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10875 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10876 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10877 if (AvARRAY((AV*)sstr)) {
10878 SV **dst_ary, **src_ary;
10879 SSize_t items = AvFILLp((AV*)sstr) + 1;
10881 src_ary = AvARRAY((AV*)sstr);
10882 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10883 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10884 SvPVX(dstr) = (char*)dst_ary;
10885 AvALLOC((AV*)dstr) = dst_ary;
10886 if (AvREAL((AV*)sstr)) {
10887 while (items-- > 0)
10888 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10891 while (items-- > 0)
10892 *dst_ary++ = sv_dup(*src_ary++, param);
10894 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10895 while (items-- > 0) {
10896 *dst_ary++ = &PL_sv_undef;
10900 SvPVX(dstr) = Nullch;
10901 AvALLOC((AV*)dstr) = (SV**)NULL;
10905 SvANY(dstr) = new_XPVHV();
10906 SvCUR(dstr) = SvCUR(sstr);
10907 SvLEN(dstr) = SvLEN(sstr);
10908 SvIVX(dstr) = SvIVX(sstr);
10909 SvNVX(dstr) = SvNVX(sstr);
10910 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10911 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10912 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10913 if (HvARRAY((HV*)sstr)) {
10915 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10916 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10917 Newz(0, dxhv->xhv_array,
10918 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10919 while (i <= sxhv->xhv_max) {
10920 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10921 (bool)!!HvSHAREKEYS(sstr),
10925 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10926 (bool)!!HvSHAREKEYS(sstr), param);
10929 SvPVX(dstr) = Nullch;
10930 HvEITER((HV*)dstr) = (HE*)NULL;
10932 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10933 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10934 /* Record stashes for possible cloning in Perl_clone(). */
10935 if(HvNAME((HV*)dstr))
10936 av_push(param->stashes, dstr);
10939 SvANY(dstr) = new_XPVFM();
10940 FmLINES(dstr) = FmLINES(sstr);
10944 SvANY(dstr) = new_XPVCV();
10946 SvCUR(dstr) = SvCUR(sstr);
10947 SvLEN(dstr) = SvLEN(sstr);
10948 SvIVX(dstr) = SvIVX(sstr);
10949 SvNVX(dstr) = SvNVX(sstr);
10950 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10951 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10952 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10953 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10954 CvSTART(dstr) = CvSTART(sstr);
10955 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10956 CvXSUB(dstr) = CvXSUB(sstr);
10957 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10958 if (CvCONST(sstr)) {
10959 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10960 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10961 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10963 /* don't dup if copying back - CvGV isn't refcounted, so the
10964 * duped GV may never be freed. A bit of a hack! DAPM */
10965 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10966 Nullgv : gv_dup(CvGV(sstr), param) ;
10967 if (param->flags & CLONEf_COPY_STACKS) {
10968 CvDEPTH(dstr) = CvDEPTH(sstr);
10972 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10973 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10975 CvWEAKOUTSIDE(sstr)
10976 ? cv_dup( CvOUTSIDE(sstr), param)
10977 : cv_dup_inc(CvOUTSIDE(sstr), param);
10978 CvFLAGS(dstr) = CvFLAGS(sstr);
10979 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10982 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10986 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10992 /* duplicate a context */
10995 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10997 PERL_CONTEXT *ncxs;
11000 return (PERL_CONTEXT*)NULL;
11002 /* look for it in the table first */
11003 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11007 /* create anew and remember what it is */
11008 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11009 ptr_table_store(PL_ptr_table, cxs, ncxs);
11012 PERL_CONTEXT *cx = &cxs[ix];
11013 PERL_CONTEXT *ncx = &ncxs[ix];
11014 ncx->cx_type = cx->cx_type;
11015 if (CxTYPE(cx) == CXt_SUBST) {
11016 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11019 ncx->blk_oldsp = cx->blk_oldsp;
11020 ncx->blk_oldcop = cx->blk_oldcop;
11021 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11022 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11023 ncx->blk_oldpm = cx->blk_oldpm;
11024 ncx->blk_gimme = cx->blk_gimme;
11025 switch (CxTYPE(cx)) {
11027 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11028 ? cv_dup_inc(cx->blk_sub.cv, param)
11029 : cv_dup(cx->blk_sub.cv,param));
11030 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11031 ? av_dup_inc(cx->blk_sub.argarray, param)
11033 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11034 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11035 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11036 ncx->blk_sub.lval = cx->blk_sub.lval;
11037 ncx->blk_sub.retop = cx->blk_sub.retop;
11040 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11041 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11042 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11043 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11044 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11045 ncx->blk_eval.retop = cx->blk_eval.retop;
11048 ncx->blk_loop.label = cx->blk_loop.label;
11049 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11050 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11051 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11052 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11053 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11054 ? cx->blk_loop.iterdata
11055 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11056 ncx->blk_loop.oldcomppad
11057 = (PAD*)ptr_table_fetch(PL_ptr_table,
11058 cx->blk_loop.oldcomppad);
11059 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11060 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11061 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11062 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11063 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11066 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11067 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11068 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11069 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11070 ncx->blk_sub.retop = cx->blk_sub.retop;
11082 /* duplicate a stack info structure */
11085 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11090 return (PERL_SI*)NULL;
11092 /* look for it in the table first */
11093 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11097 /* create anew and remember what it is */
11098 Newz(56, nsi, 1, PERL_SI);
11099 ptr_table_store(PL_ptr_table, si, nsi);
11101 nsi->si_stack = av_dup_inc(si->si_stack, param);
11102 nsi->si_cxix = si->si_cxix;
11103 nsi->si_cxmax = si->si_cxmax;
11104 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11105 nsi->si_type = si->si_type;
11106 nsi->si_prev = si_dup(si->si_prev, param);
11107 nsi->si_next = si_dup(si->si_next, param);
11108 nsi->si_markoff = si->si_markoff;
11113 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11114 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11115 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11116 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11117 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11118 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11119 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11120 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11121 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11122 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11123 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11124 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11125 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11126 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11129 #define pv_dup_inc(p) SAVEPV(p)
11130 #define pv_dup(p) SAVEPV(p)
11131 #define svp_dup_inc(p,pp) any_dup(p,pp)
11133 /* map any object to the new equivent - either something in the
11134 * ptr table, or something in the interpreter structure
11138 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11143 return (void*)NULL;
11145 /* look for it in the table first */
11146 ret = ptr_table_fetch(PL_ptr_table, v);
11150 /* see if it is part of the interpreter structure */
11151 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11152 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11160 /* duplicate the save stack */
11163 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11165 ANY *ss = proto_perl->Tsavestack;
11166 I32 ix = proto_perl->Tsavestack_ix;
11167 I32 max = proto_perl->Tsavestack_max;
11180 void (*dptr) (void*);
11181 void (*dxptr) (pTHX_ void*);
11184 Newz(54, nss, max, ANY);
11188 TOPINT(nss,ix) = i;
11190 case SAVEt_ITEM: /* normal string */
11191 sv = (SV*)POPPTR(ss,ix);
11192 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11193 sv = (SV*)POPPTR(ss,ix);
11194 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11196 case SAVEt_SV: /* scalar reference */
11197 sv = (SV*)POPPTR(ss,ix);
11198 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11199 gv = (GV*)POPPTR(ss,ix);
11200 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11202 case SAVEt_GENERIC_PVREF: /* generic char* */
11203 c = (char*)POPPTR(ss,ix);
11204 TOPPTR(nss,ix) = pv_dup(c);
11205 ptr = POPPTR(ss,ix);
11206 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11208 case SAVEt_SHARED_PVREF: /* char* in shared space */
11209 c = (char*)POPPTR(ss,ix);
11210 TOPPTR(nss,ix) = savesharedpv(c);
11211 ptr = POPPTR(ss,ix);
11212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11214 case SAVEt_GENERIC_SVREF: /* generic sv */
11215 case SAVEt_SVREF: /* scalar reference */
11216 sv = (SV*)POPPTR(ss,ix);
11217 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11218 ptr = POPPTR(ss,ix);
11219 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11221 case SAVEt_AV: /* array reference */
11222 av = (AV*)POPPTR(ss,ix);
11223 TOPPTR(nss,ix) = av_dup_inc(av, param);
11224 gv = (GV*)POPPTR(ss,ix);
11225 TOPPTR(nss,ix) = gv_dup(gv, param);
11227 case SAVEt_HV: /* hash reference */
11228 hv = (HV*)POPPTR(ss,ix);
11229 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11230 gv = (GV*)POPPTR(ss,ix);
11231 TOPPTR(nss,ix) = gv_dup(gv, param);
11233 case SAVEt_INT: /* int reference */
11234 ptr = POPPTR(ss,ix);
11235 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11236 intval = (int)POPINT(ss,ix);
11237 TOPINT(nss,ix) = intval;
11239 case SAVEt_LONG: /* long reference */
11240 ptr = POPPTR(ss,ix);
11241 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11242 longval = (long)POPLONG(ss,ix);
11243 TOPLONG(nss,ix) = longval;
11245 case SAVEt_I32: /* I32 reference */
11246 case SAVEt_I16: /* I16 reference */
11247 case SAVEt_I8: /* I8 reference */
11248 ptr = POPPTR(ss,ix);
11249 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11251 TOPINT(nss,ix) = i;
11253 case SAVEt_IV: /* IV reference */
11254 ptr = POPPTR(ss,ix);
11255 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11257 TOPIV(nss,ix) = iv;
11259 case SAVEt_SPTR: /* SV* reference */
11260 ptr = POPPTR(ss,ix);
11261 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11262 sv = (SV*)POPPTR(ss,ix);
11263 TOPPTR(nss,ix) = sv_dup(sv, param);
11265 case SAVEt_VPTR: /* random* reference */
11266 ptr = POPPTR(ss,ix);
11267 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11268 ptr = POPPTR(ss,ix);
11269 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11271 case SAVEt_PPTR: /* char* reference */
11272 ptr = POPPTR(ss,ix);
11273 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11274 c = (char*)POPPTR(ss,ix);
11275 TOPPTR(nss,ix) = pv_dup(c);
11277 case SAVEt_HPTR: /* HV* reference */
11278 ptr = POPPTR(ss,ix);
11279 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11280 hv = (HV*)POPPTR(ss,ix);
11281 TOPPTR(nss,ix) = hv_dup(hv, param);
11283 case SAVEt_APTR: /* AV* reference */
11284 ptr = POPPTR(ss,ix);
11285 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11286 av = (AV*)POPPTR(ss,ix);
11287 TOPPTR(nss,ix) = av_dup(av, param);
11290 gv = (GV*)POPPTR(ss,ix);
11291 TOPPTR(nss,ix) = gv_dup(gv, param);
11293 case SAVEt_GP: /* scalar reference */
11294 gp = (GP*)POPPTR(ss,ix);
11295 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11296 (void)GpREFCNT_inc(gp);
11297 gv = (GV*)POPPTR(ss,ix);
11298 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11299 c = (char*)POPPTR(ss,ix);
11300 TOPPTR(nss,ix) = pv_dup(c);
11302 TOPIV(nss,ix) = iv;
11304 TOPIV(nss,ix) = iv;
11307 case SAVEt_MORTALIZESV:
11308 sv = (SV*)POPPTR(ss,ix);
11309 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11312 ptr = POPPTR(ss,ix);
11313 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11314 /* these are assumed to be refcounted properly */
11315 switch (((OP*)ptr)->op_type) {
11317 case OP_LEAVESUBLV:
11321 case OP_LEAVEWRITE:
11322 TOPPTR(nss,ix) = ptr;
11327 TOPPTR(nss,ix) = Nullop;
11332 TOPPTR(nss,ix) = Nullop;
11335 c = (char*)POPPTR(ss,ix);
11336 TOPPTR(nss,ix) = pv_dup_inc(c);
11338 case SAVEt_CLEARSV:
11339 longval = POPLONG(ss,ix);
11340 TOPLONG(nss,ix) = longval;
11343 hv = (HV*)POPPTR(ss,ix);
11344 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11345 c = (char*)POPPTR(ss,ix);
11346 TOPPTR(nss,ix) = pv_dup_inc(c);
11348 TOPINT(nss,ix) = i;
11350 case SAVEt_DESTRUCTOR:
11351 ptr = POPPTR(ss,ix);
11352 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11353 dptr = POPDPTR(ss,ix);
11354 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11356 case SAVEt_DESTRUCTOR_X:
11357 ptr = POPPTR(ss,ix);
11358 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11359 dxptr = POPDXPTR(ss,ix);
11360 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11362 case SAVEt_REGCONTEXT:
11365 TOPINT(nss,ix) = i;
11368 case SAVEt_STACK_POS: /* Position on Perl stack */
11370 TOPINT(nss,ix) = i;
11372 case SAVEt_AELEM: /* array element */
11373 sv = (SV*)POPPTR(ss,ix);
11374 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11376 TOPINT(nss,ix) = i;
11377 av = (AV*)POPPTR(ss,ix);
11378 TOPPTR(nss,ix) = av_dup_inc(av, param);
11380 case SAVEt_HELEM: /* hash element */
11381 sv = (SV*)POPPTR(ss,ix);
11382 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11383 sv = (SV*)POPPTR(ss,ix);
11384 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11385 hv = (HV*)POPPTR(ss,ix);
11386 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11389 ptr = POPPTR(ss,ix);
11390 TOPPTR(nss,ix) = ptr;
11394 TOPINT(nss,ix) = i;
11396 case SAVEt_COMPPAD:
11397 av = (AV*)POPPTR(ss,ix);
11398 TOPPTR(nss,ix) = av_dup(av, param);
11401 longval = (long)POPLONG(ss,ix);
11402 TOPLONG(nss,ix) = longval;
11403 ptr = POPPTR(ss,ix);
11404 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11405 sv = (SV*)POPPTR(ss,ix);
11406 TOPPTR(nss,ix) = sv_dup(sv, param);
11409 ptr = POPPTR(ss,ix);
11410 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11411 longval = (long)POPBOOL(ss,ix);
11412 TOPBOOL(nss,ix) = (bool)longval;
11414 case SAVEt_SET_SVFLAGS:
11416 TOPINT(nss,ix) = i;
11418 TOPINT(nss,ix) = i;
11419 sv = (SV*)POPPTR(ss,ix);
11420 TOPPTR(nss,ix) = sv_dup(sv, param);
11423 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11431 =for apidoc perl_clone
11433 Create and return a new interpreter by cloning the current one.
11435 perl_clone takes these flags as parameters:
11437 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11438 without it we only clone the data and zero the stacks,
11439 with it we copy the stacks and the new perl interpreter is
11440 ready to run at the exact same point as the previous one.
11441 The pseudo-fork code uses COPY_STACKS while the
11442 threads->new doesn't.
11444 CLONEf_KEEP_PTR_TABLE
11445 perl_clone keeps a ptr_table with the pointer of the old
11446 variable as a key and the new variable as a value,
11447 this allows it to check if something has been cloned and not
11448 clone it again but rather just use the value and increase the
11449 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11450 the ptr_table using the function
11451 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11452 reason to keep it around is if you want to dup some of your own
11453 variable who are outside the graph perl scans, example of this
11454 code is in threads.xs create
11457 This is a win32 thing, it is ignored on unix, it tells perls
11458 win32host code (which is c++) to clone itself, this is needed on
11459 win32 if you want to run two threads at the same time,
11460 if you just want to do some stuff in a separate perl interpreter
11461 and then throw it away and return to the original one,
11462 you don't need to do anything.
11467 /* XXX the above needs expanding by someone who actually understands it ! */
11468 EXTERN_C PerlInterpreter *
11469 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11472 perl_clone(PerlInterpreter *proto_perl, UV flags)
11474 #ifdef PERL_IMPLICIT_SYS
11476 /* perlhost.h so we need to call into it
11477 to clone the host, CPerlHost should have a c interface, sky */
11479 if (flags & CLONEf_CLONE_HOST) {
11480 return perl_clone_host(proto_perl,flags);
11482 return perl_clone_using(proto_perl, flags,
11484 proto_perl->IMemShared,
11485 proto_perl->IMemParse,
11487 proto_perl->IStdIO,
11491 proto_perl->IProc);
11495 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11496 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11497 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11498 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11499 struct IPerlDir* ipD, struct IPerlSock* ipS,
11500 struct IPerlProc* ipP)
11502 /* XXX many of the string copies here can be optimized if they're
11503 * constants; they need to be allocated as common memory and just
11504 * their pointers copied. */
11507 CLONE_PARAMS clone_params;
11508 CLONE_PARAMS* param = &clone_params;
11510 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11511 PERL_SET_THX(my_perl);
11514 Poison(my_perl, 1, PerlInterpreter);
11518 PL_savestack_ix = 0;
11519 PL_savestack_max = -1;
11520 PL_sig_pending = 0;
11521 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11522 # else /* !DEBUGGING */
11523 Zero(my_perl, 1, PerlInterpreter);
11524 # endif /* DEBUGGING */
11526 /* host pointers */
11528 PL_MemShared = ipMS;
11529 PL_MemParse = ipMP;
11536 #else /* !PERL_IMPLICIT_SYS */
11538 CLONE_PARAMS clone_params;
11539 CLONE_PARAMS* param = &clone_params;
11540 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11541 PERL_SET_THX(my_perl);
11546 Poison(my_perl, 1, PerlInterpreter);
11550 PL_savestack_ix = 0;
11551 PL_savestack_max = -1;
11552 PL_sig_pending = 0;
11553 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11554 # else /* !DEBUGGING */
11555 Zero(my_perl, 1, PerlInterpreter);
11556 # endif /* DEBUGGING */
11557 #endif /* PERL_IMPLICIT_SYS */
11558 param->flags = flags;
11559 param->proto_perl = proto_perl;
11562 PL_xiv_arenaroot = NULL;
11563 PL_xiv_root = NULL;
11564 PL_xnv_arenaroot = NULL;
11565 PL_xnv_root = NULL;
11566 PL_xrv_arenaroot = NULL;
11567 PL_xrv_root = NULL;
11568 PL_xpv_arenaroot = NULL;
11569 PL_xpv_root = NULL;
11570 PL_xpviv_arenaroot = NULL;
11571 PL_xpviv_root = NULL;
11572 PL_xpvnv_arenaroot = NULL;
11573 PL_xpvnv_root = NULL;
11574 PL_xpvcv_arenaroot = NULL;
11575 PL_xpvcv_root = NULL;
11576 PL_xpvav_arenaroot = NULL;
11577 PL_xpvav_root = NULL;
11578 PL_xpvhv_arenaroot = NULL;
11579 PL_xpvhv_root = NULL;
11580 PL_xpvmg_arenaroot = NULL;
11581 PL_xpvmg_root = NULL;
11582 PL_xpvlv_arenaroot = NULL;
11583 PL_xpvlv_root = NULL;
11584 PL_xpvbm_arenaroot = NULL;
11585 PL_xpvbm_root = NULL;
11586 PL_he_arenaroot = NULL;
11588 PL_nice_chunk = NULL;
11589 PL_nice_chunk_size = 0;
11591 PL_sv_objcount = 0;
11592 PL_sv_root = Nullsv;
11593 PL_sv_arenaroot = Nullsv;
11595 PL_debug = proto_perl->Idebug;
11597 #ifdef USE_REENTRANT_API
11598 /* XXX: things like -Dm will segfault here in perlio, but doing
11599 * PERL_SET_CONTEXT(proto_perl);
11600 * breaks too many other things
11602 Perl_reentrant_init(aTHX);
11605 /* create SV map for pointer relocation */
11606 PL_ptr_table = ptr_table_new();
11608 /* initialize these special pointers as early as possible */
11609 SvANY(&PL_sv_undef) = NULL;
11610 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11611 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11612 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11614 SvANY(&PL_sv_no) = new_XPVNV();
11615 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11616 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11617 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11618 SvCUR(&PL_sv_no) = 0;
11619 SvLEN(&PL_sv_no) = 1;
11620 SvNVX(&PL_sv_no) = 0;
11621 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11623 SvANY(&PL_sv_yes) = new_XPVNV();
11624 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11625 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11626 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11627 SvCUR(&PL_sv_yes) = 1;
11628 SvLEN(&PL_sv_yes) = 2;
11629 SvNVX(&PL_sv_yes) = 1;
11630 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11632 /* create (a non-shared!) shared string table */
11633 PL_strtab = newHV();
11634 HvSHAREKEYS_off(PL_strtab);
11635 hv_ksplit(PL_strtab, 512);
11636 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11638 PL_compiling = proto_perl->Icompiling;
11640 /* These two PVs will be free'd special way so must set them same way op.c does */
11641 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11642 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11644 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11645 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11647 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11648 if (!specialWARN(PL_compiling.cop_warnings))
11649 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11650 if (!specialCopIO(PL_compiling.cop_io))
11651 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11652 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11654 /* pseudo environmental stuff */
11655 PL_origargc = proto_perl->Iorigargc;
11656 PL_origargv = proto_perl->Iorigargv;
11658 param->stashes = newAV(); /* Setup array of objects to call clone on */
11660 #ifdef PERLIO_LAYERS
11661 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11662 PerlIO_clone(aTHX_ proto_perl, param);
11665 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11666 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11667 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11668 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11669 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11670 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11673 PL_minus_c = proto_perl->Iminus_c;
11674 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11675 PL_localpatches = proto_perl->Ilocalpatches;
11676 PL_splitstr = proto_perl->Isplitstr;
11677 PL_preprocess = proto_perl->Ipreprocess;
11678 PL_minus_n = proto_perl->Iminus_n;
11679 PL_minus_p = proto_perl->Iminus_p;
11680 PL_minus_l = proto_perl->Iminus_l;
11681 PL_minus_a = proto_perl->Iminus_a;
11682 PL_minus_F = proto_perl->Iminus_F;
11683 PL_doswitches = proto_perl->Idoswitches;
11684 PL_dowarn = proto_perl->Idowarn;
11685 PL_doextract = proto_perl->Idoextract;
11686 PL_sawampersand = proto_perl->Isawampersand;
11687 PL_unsafe = proto_perl->Iunsafe;
11688 PL_inplace = SAVEPV(proto_perl->Iinplace);
11689 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11690 PL_perldb = proto_perl->Iperldb;
11691 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11692 PL_exit_flags = proto_perl->Iexit_flags;
11694 /* magical thingies */
11695 /* XXX time(&PL_basetime) when asked for? */
11696 PL_basetime = proto_perl->Ibasetime;
11697 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11699 PL_maxsysfd = proto_perl->Imaxsysfd;
11700 PL_multiline = proto_perl->Imultiline;
11701 PL_statusvalue = proto_perl->Istatusvalue;
11703 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11705 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11707 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11708 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11709 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11711 /* Clone the regex array */
11712 PL_regex_padav = newAV();
11714 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11715 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11716 av_push(PL_regex_padav,
11717 sv_dup_inc(regexen[0],param));
11718 for(i = 1; i <= len; i++) {
11719 if(SvREPADTMP(regexen[i])) {
11720 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11722 av_push(PL_regex_padav,
11724 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11725 SvIVX(regexen[i])), param)))
11730 PL_regex_pad = AvARRAY(PL_regex_padav);
11732 /* shortcuts to various I/O objects */
11733 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11734 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11735 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11736 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11737 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11738 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11740 /* shortcuts to regexp stuff */
11741 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11743 /* shortcuts to misc objects */
11744 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11746 /* shortcuts to debugging objects */
11747 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11748 PL_DBline = gv_dup(proto_perl->IDBline, param);
11749 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11750 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11751 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11752 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11753 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11754 PL_lineary = av_dup(proto_perl->Ilineary, param);
11755 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11757 /* symbol tables */
11758 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11759 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11760 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11761 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11762 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11764 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11765 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11766 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11767 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11768 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11769 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11771 PL_sub_generation = proto_perl->Isub_generation;
11773 /* funky return mechanisms */
11774 PL_forkprocess = proto_perl->Iforkprocess;
11776 /* subprocess state */
11777 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11779 /* internal state */
11780 PL_tainting = proto_perl->Itainting;
11781 PL_taint_warn = proto_perl->Itaint_warn;
11782 PL_maxo = proto_perl->Imaxo;
11783 if (proto_perl->Iop_mask)
11784 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11786 PL_op_mask = Nullch;
11787 /* PL_asserting = proto_perl->Iasserting; */
11789 /* current interpreter roots */
11790 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11791 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11792 PL_main_start = proto_perl->Imain_start;
11793 PL_eval_root = proto_perl->Ieval_root;
11794 PL_eval_start = proto_perl->Ieval_start;
11796 /* runtime control stuff */
11797 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11798 PL_copline = proto_perl->Icopline;
11800 PL_filemode = proto_perl->Ifilemode;
11801 PL_lastfd = proto_perl->Ilastfd;
11802 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11805 PL_gensym = proto_perl->Igensym;
11806 PL_preambled = proto_perl->Ipreambled;
11807 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11808 PL_laststatval = proto_perl->Ilaststatval;
11809 PL_laststype = proto_perl->Ilaststype;
11810 PL_mess_sv = Nullsv;
11812 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11813 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11815 /* interpreter atexit processing */
11816 PL_exitlistlen = proto_perl->Iexitlistlen;
11817 if (PL_exitlistlen) {
11818 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11819 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11822 PL_exitlist = (PerlExitListEntry*)NULL;
11823 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11824 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11825 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11827 PL_profiledata = NULL;
11828 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11829 /* PL_rsfp_filters entries have fake IoDIRP() */
11830 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11832 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11834 PAD_CLONE_VARS(proto_perl, param);
11836 #ifdef HAVE_INTERP_INTERN
11837 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11840 /* more statics moved here */
11841 PL_generation = proto_perl->Igeneration;
11842 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11844 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11845 PL_in_clean_all = proto_perl->Iin_clean_all;
11847 PL_uid = proto_perl->Iuid;
11848 PL_euid = proto_perl->Ieuid;
11849 PL_gid = proto_perl->Igid;
11850 PL_egid = proto_perl->Iegid;
11851 PL_nomemok = proto_perl->Inomemok;
11852 PL_an = proto_perl->Ian;
11853 PL_evalseq = proto_perl->Ievalseq;
11854 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11855 PL_origalen = proto_perl->Iorigalen;
11856 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11857 PL_osname = SAVEPV(proto_perl->Iosname);
11858 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11859 PL_sighandlerp = proto_perl->Isighandlerp;
11862 PL_runops = proto_perl->Irunops;
11864 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11867 PL_cshlen = proto_perl->Icshlen;
11868 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11871 PL_lex_state = proto_perl->Ilex_state;
11872 PL_lex_defer = proto_perl->Ilex_defer;
11873 PL_lex_expect = proto_perl->Ilex_expect;
11874 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11875 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11876 PL_lex_starts = proto_perl->Ilex_starts;
11877 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11878 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11879 PL_lex_op = proto_perl->Ilex_op;
11880 PL_lex_inpat = proto_perl->Ilex_inpat;
11881 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11882 PL_lex_brackets = proto_perl->Ilex_brackets;
11883 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11884 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11885 PL_lex_casemods = proto_perl->Ilex_casemods;
11886 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11887 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11889 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11890 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11891 PL_nexttoke = proto_perl->Inexttoke;
11893 /* XXX This is probably masking the deeper issue of why
11894 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11895 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11896 * (A little debugging with a watchpoint on it may help.)
11898 if (SvANY(proto_perl->Ilinestr)) {
11899 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11900 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11901 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11902 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11903 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11904 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11905 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11906 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11907 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11910 PL_linestr = NEWSV(65,79);
11911 sv_upgrade(PL_linestr,SVt_PVIV);
11912 sv_setpvn(PL_linestr,"",0);
11913 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11915 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11916 PL_pending_ident = proto_perl->Ipending_ident;
11917 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11919 PL_expect = proto_perl->Iexpect;
11921 PL_multi_start = proto_perl->Imulti_start;
11922 PL_multi_end = proto_perl->Imulti_end;
11923 PL_multi_open = proto_perl->Imulti_open;
11924 PL_multi_close = proto_perl->Imulti_close;
11926 PL_error_count = proto_perl->Ierror_count;
11927 PL_subline = proto_perl->Isubline;
11928 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11930 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11931 if (SvANY(proto_perl->Ilinestr)) {
11932 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11933 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11934 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11935 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11936 PL_last_lop_op = proto_perl->Ilast_lop_op;
11939 PL_last_uni = SvPVX(PL_linestr);
11940 PL_last_lop = SvPVX(PL_linestr);
11941 PL_last_lop_op = 0;
11943 PL_in_my = proto_perl->Iin_my;
11944 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11946 PL_cryptseen = proto_perl->Icryptseen;
11949 PL_hints = proto_perl->Ihints;
11951 PL_amagic_generation = proto_perl->Iamagic_generation;
11953 #ifdef USE_LOCALE_COLLATE
11954 PL_collation_ix = proto_perl->Icollation_ix;
11955 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11956 PL_collation_standard = proto_perl->Icollation_standard;
11957 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11958 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11959 #endif /* USE_LOCALE_COLLATE */
11961 #ifdef USE_LOCALE_NUMERIC
11962 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11963 PL_numeric_standard = proto_perl->Inumeric_standard;
11964 PL_numeric_local = proto_perl->Inumeric_local;
11965 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11966 #endif /* !USE_LOCALE_NUMERIC */
11968 /* utf8 character classes */
11969 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11970 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11971 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11972 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11973 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11974 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11975 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11976 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11977 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11978 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11979 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11980 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11981 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11982 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11983 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11984 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11985 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11986 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11987 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11988 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11990 /* Did the locale setup indicate UTF-8? */
11991 PL_utf8locale = proto_perl->Iutf8locale;
11992 /* Unicode features (see perlrun/-C) */
11993 PL_unicode = proto_perl->Iunicode;
11995 /* Pre-5.8 signals control */
11996 PL_signals = proto_perl->Isignals;
11998 /* times() ticks per second */
11999 PL_clocktick = proto_perl->Iclocktick;
12001 /* Recursion stopper for PerlIO_find_layer */
12002 PL_in_load_module = proto_perl->Iin_load_module;
12004 /* sort() routine */
12005 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12007 /* Not really needed/useful since the reenrant_retint is "volatile",
12008 * but do it for consistency's sake. */
12009 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12011 /* Hooks to shared SVs and locks. */
12012 PL_sharehook = proto_perl->Isharehook;
12013 PL_lockhook = proto_perl->Ilockhook;
12014 PL_unlockhook = proto_perl->Iunlockhook;
12015 PL_threadhook = proto_perl->Ithreadhook;
12017 PL_runops_std = proto_perl->Irunops_std;
12018 PL_runops_dbg = proto_perl->Irunops_dbg;
12020 #ifdef THREADS_HAVE_PIDS
12021 PL_ppid = proto_perl->Ippid;
12025 PL_last_swash_hv = Nullhv; /* reinits on demand */
12026 PL_last_swash_klen = 0;
12027 PL_last_swash_key[0]= '\0';
12028 PL_last_swash_tmps = (U8*)NULL;
12029 PL_last_swash_slen = 0;
12031 PL_glob_index = proto_perl->Iglob_index;
12032 PL_srand_called = proto_perl->Isrand_called;
12033 PL_hash_seed = proto_perl->Ihash_seed;
12034 PL_rehash_seed = proto_perl->Irehash_seed;
12035 PL_uudmap['M'] = 0; /* reinits on demand */
12036 PL_bitcount = Nullch; /* reinits on demand */
12038 if (proto_perl->Ipsig_pend) {
12039 Newz(0, PL_psig_pend, SIG_SIZE, int);
12042 PL_psig_pend = (int*)NULL;
12045 if (proto_perl->Ipsig_ptr) {
12046 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12047 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12048 for (i = 1; i < SIG_SIZE; i++) {
12049 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12050 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12054 PL_psig_ptr = (SV**)NULL;
12055 PL_psig_name = (SV**)NULL;
12058 /* thrdvar.h stuff */
12060 if (flags & CLONEf_COPY_STACKS) {
12061 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12062 PL_tmps_ix = proto_perl->Ttmps_ix;
12063 PL_tmps_max = proto_perl->Ttmps_max;
12064 PL_tmps_floor = proto_perl->Ttmps_floor;
12065 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12067 while (i <= PL_tmps_ix) {
12068 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12072 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12073 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12074 Newz(54, PL_markstack, i, I32);
12075 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12076 - proto_perl->Tmarkstack);
12077 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12078 - proto_perl->Tmarkstack);
12079 Copy(proto_perl->Tmarkstack, PL_markstack,
12080 PL_markstack_ptr - PL_markstack + 1, I32);
12082 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12083 * NOTE: unlike the others! */
12084 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12085 PL_scopestack_max = proto_perl->Tscopestack_max;
12086 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12087 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12089 /* NOTE: si_dup() looks at PL_markstack */
12090 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12092 /* PL_curstack = PL_curstackinfo->si_stack; */
12093 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12094 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12096 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12097 PL_stack_base = AvARRAY(PL_curstack);
12098 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12099 - proto_perl->Tstack_base);
12100 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12102 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12103 * NOTE: unlike the others! */
12104 PL_savestack_ix = proto_perl->Tsavestack_ix;
12105 PL_savestack_max = proto_perl->Tsavestack_max;
12106 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12107 PL_savestack = ss_dup(proto_perl, param);
12111 ENTER; /* perl_destruct() wants to LEAVE; */
12114 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12115 PL_top_env = &PL_start_env;
12117 PL_op = proto_perl->Top;
12120 PL_Xpv = (XPV*)NULL;
12121 PL_na = proto_perl->Tna;
12123 PL_statbuf = proto_perl->Tstatbuf;
12124 PL_statcache = proto_perl->Tstatcache;
12125 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12126 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12128 PL_timesbuf = proto_perl->Ttimesbuf;
12131 PL_tainted = proto_perl->Ttainted;
12132 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12133 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12134 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12135 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12136 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12137 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12138 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12139 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12140 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12142 PL_restartop = proto_perl->Trestartop;
12143 PL_in_eval = proto_perl->Tin_eval;
12144 PL_delaymagic = proto_perl->Tdelaymagic;
12145 PL_dirty = proto_perl->Tdirty;
12146 PL_localizing = proto_perl->Tlocalizing;
12148 #ifdef PERL_FLEXIBLE_EXCEPTIONS
12149 PL_protect = proto_perl->Tprotect;
12151 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12152 PL_hv_fetch_ent_mh = Nullhe;
12153 PL_modcount = proto_perl->Tmodcount;
12154 PL_lastgotoprobe = Nullop;
12155 PL_dumpindent = proto_perl->Tdumpindent;
12157 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12158 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12159 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12160 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12161 PL_sortcxix = proto_perl->Tsortcxix;
12162 PL_efloatbuf = Nullch; /* reinits on demand */
12163 PL_efloatsize = 0; /* reinits on demand */
12167 PL_screamfirst = NULL;
12168 PL_screamnext = NULL;
12169 PL_maxscream = -1; /* reinits on demand */
12170 PL_lastscream = Nullsv;
12172 PL_watchaddr = NULL;
12173 PL_watchok = Nullch;
12175 PL_regdummy = proto_perl->Tregdummy;
12176 PL_regprecomp = Nullch;
12179 PL_colorset = 0; /* reinits PL_colors[] */
12180 /*PL_colors[6] = {0,0,0,0,0,0};*/
12181 PL_reginput = Nullch;
12182 PL_regbol = Nullch;
12183 PL_regeol = Nullch;
12184 PL_regstartp = (I32*)NULL;
12185 PL_regendp = (I32*)NULL;
12186 PL_reglastparen = (U32*)NULL;
12187 PL_reglastcloseparen = (U32*)NULL;
12188 PL_regtill = Nullch;
12189 PL_reg_start_tmp = (char**)NULL;
12190 PL_reg_start_tmpl = 0;
12191 PL_regdata = (struct reg_data*)NULL;
12194 PL_reg_eval_set = 0;
12196 PL_regprogram = (regnode*)NULL;
12198 PL_regcc = (CURCUR*)NULL;
12199 PL_reg_call_cc = (struct re_cc_state*)NULL;
12200 PL_reg_re = (regexp*)NULL;
12201 PL_reg_ganch = Nullch;
12202 PL_reg_sv = Nullsv;
12203 PL_reg_match_utf8 = FALSE;
12204 PL_reg_magic = (MAGIC*)NULL;
12206 PL_reg_oldcurpm = (PMOP*)NULL;
12207 PL_reg_curpm = (PMOP*)NULL;
12208 PL_reg_oldsaved = Nullch;
12209 PL_reg_oldsavedlen = 0;
12210 #ifdef PERL_COPY_ON_WRITE
12213 PL_reg_maxiter = 0;
12214 PL_reg_leftiter = 0;
12215 PL_reg_poscache = Nullch;
12216 PL_reg_poscache_size= 0;
12218 /* RE engine - function pointers */
12219 PL_regcompp = proto_perl->Tregcompp;
12220 PL_regexecp = proto_perl->Tregexecp;
12221 PL_regint_start = proto_perl->Tregint_start;
12222 PL_regint_string = proto_perl->Tregint_string;
12223 PL_regfree = proto_perl->Tregfree;
12225 PL_reginterp_cnt = 0;
12226 PL_reg_starttry = 0;
12228 /* Pluggable optimizer */
12229 PL_peepp = proto_perl->Tpeepp;
12231 PL_stashcache = newHV();
12233 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12234 ptr_table_free(PL_ptr_table);
12235 PL_ptr_table = NULL;
12238 /* Call the ->CLONE method, if it exists, for each of the stashes
12239 identified by sv_dup() above.
12241 while(av_len(param->stashes) != -1) {
12242 HV* stash = (HV*) av_shift(param->stashes);
12243 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12244 if (cloner && GvCV(cloner)) {
12249 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12251 call_sv((SV*)GvCV(cloner), G_DISCARD);
12257 SvREFCNT_dec(param->stashes);
12262 #endif /* USE_ITHREADS */
12265 =head1 Unicode Support
12267 =for apidoc sv_recode_to_utf8
12269 The encoding is assumed to be an Encode object, on entry the PV
12270 of the sv is assumed to be octets in that encoding, and the sv
12271 will be converted into Unicode (and UTF-8).
12273 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12274 is not a reference, nothing is done to the sv. If the encoding is not
12275 an C<Encode::XS> Encoding object, bad things will happen.
12276 (See F<lib/encoding.pm> and L<Encode>).
12278 The PV of the sv is returned.
12283 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12285 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12299 Passing sv_yes is wrong - it needs to be or'ed set of constants
12300 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12301 remove converted chars from source.
12303 Both will default the value - let them.
12305 XPUSHs(&PL_sv_yes);
12308 call_method("decode", G_SCALAR);
12312 s = SvPV(uni, len);
12313 if (s != SvPVX(sv)) {
12314 SvGROW(sv, len + 1);
12315 Move(s, SvPVX(sv), len, char);
12316 SvCUR_set(sv, len);
12317 SvPVX(sv)[len] = 0;
12324 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12328 =for apidoc sv_cat_decode
12330 The encoding is assumed to be an Encode object, the PV of the ssv is
12331 assumed to be octets in that encoding and decoding the input starts
12332 from the position which (PV + *offset) pointed to. The dsv will be
12333 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12334 when the string tstr appears in decoding output or the input ends on
12335 the PV of the ssv. The value which the offset points will be modified
12336 to the last input position on the ssv.
12338 Returns TRUE if the terminator was found, else returns FALSE.
12343 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12344 SV *ssv, int *offset, char *tstr, int tlen)
12347 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12358 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12359 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12361 call_method("cat_decode", G_SCALAR);
12363 ret = SvTRUE(TOPs);
12364 *offset = SvIV(offsv);
12370 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");