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)
1764 MAGIC* magic = NULL;
1767 if (mt != SVt_PV && SvIsCOW(sv)) {
1768 sv_force_normal_flags(sv, 0);
1771 if (SvTYPE(sv) == mt)
1775 (void)SvOOK_off(sv);
1777 switch (SvTYPE(sv)) {
1798 else if (mt < SVt_PVIV)
1815 pv = (char*)SvRV(sv);
1835 else if (mt == SVt_NV)
1846 del_XPVIV(SvANY(sv));
1856 del_XPVNV(SvANY(sv));
1864 magic = SvMAGIC(sv);
1865 stash = SvSTASH(sv);
1866 del_XPVMG(SvANY(sv));
1869 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1872 SvFLAGS(sv) &= ~SVTYPEMASK;
1877 Perl_croak(aTHX_ "Can't upgrade to undef");
1879 SvANY(sv) = new_XIV();
1883 SvANY(sv) = new_XNV();
1887 SvANY(sv) = new_XRV();
1891 SvANY(sv) = new_XPV();
1897 SvANY(sv) = new_XPVIV();
1907 SvANY(sv) = new_XPVNV();
1915 SvANY(sv) = new_XPVMG();
1921 SvMAGIC(sv) = magic;
1922 SvSTASH(sv) = stash;
1925 SvANY(sv) = new_XPVLV();
1931 SvMAGIC(sv) = magic;
1932 SvSTASH(sv) = stash;
1944 SvANY(sv) = new_XPVAV();
1952 SvMAGIC(sv) = magic;
1953 SvSTASH(sv) = stash;
1959 SvANY(sv) = new_XPVHV();
1965 HvTOTALKEYS(sv) = 0;
1966 HvPLACEHOLDERS(sv) = 0;
1967 SvMAGIC(sv) = magic;
1968 SvSTASH(sv) = stash;
1975 SvANY(sv) = new_XPVCV();
1976 Zero(SvANY(sv), 1, XPVCV);
1982 SvMAGIC(sv) = magic;
1983 SvSTASH(sv) = stash;
1986 SvANY(sv) = new_XPVGV();
1992 SvMAGIC(sv) = magic;
1993 SvSTASH(sv) = stash;
2001 SvANY(sv) = new_XPVBM();
2007 SvMAGIC(sv) = magic;
2008 SvSTASH(sv) = stash;
2014 SvANY(sv) = new_XPVFM();
2015 Zero(SvANY(sv), 1, XPVFM);
2021 SvMAGIC(sv) = magic;
2022 SvSTASH(sv) = stash;
2025 SvANY(sv) = new_XPVIO();
2026 Zero(SvANY(sv), 1, XPVIO);
2032 SvMAGIC(sv) = magic;
2033 SvSTASH(sv) = stash;
2034 IoPAGE_LEN(sv) = 60;
2041 =for apidoc sv_backoff
2043 Remove any string offset. You should normally use the C<SvOOK_off> macro
2050 Perl_sv_backoff(pTHX_ register SV *sv)
2054 char *s = SvPVX(sv);
2055 SvLEN(sv) += SvIVX(sv);
2056 SvPVX(sv) -= SvIVX(sv);
2058 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2060 SvFLAGS(sv) &= ~SVf_OOK;
2067 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2068 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2069 Use the C<SvGROW> wrapper instead.
2075 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2079 #ifdef HAS_64K_LIMIT
2080 if (newlen >= 0x10000) {
2081 PerlIO_printf(Perl_debug_log,
2082 "Allocation too large: %"UVxf"\n", (UV)newlen);
2085 #endif /* HAS_64K_LIMIT */
2088 if (SvTYPE(sv) < SVt_PV) {
2089 sv_upgrade(sv, SVt_PV);
2092 else if (SvOOK(sv)) { /* pv is offset? */
2095 if (newlen > SvLEN(sv))
2096 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2097 #ifdef HAS_64K_LIMIT
2098 if (newlen >= 0x10000)
2105 if (newlen > SvLEN(sv)) { /* need more room? */
2106 if (SvLEN(sv) && s) {
2108 STRLEN l = malloced_size((void*)SvPVX(sv));
2114 Renew(s,newlen,char);
2117 New(703, s, newlen, char);
2118 if (SvPVX(sv) && SvCUR(sv)) {
2119 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2123 SvLEN_set(sv, newlen);
2129 =for apidoc sv_setiv
2131 Copies an integer into the given SV, upgrading first if necessary.
2132 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2138 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2140 SV_CHECK_THINKFIRST_COW_DROP(sv);
2141 switch (SvTYPE(sv)) {
2143 sv_upgrade(sv, SVt_IV);
2146 sv_upgrade(sv, SVt_PVNV);
2150 sv_upgrade(sv, SVt_PVIV);
2159 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2162 (void)SvIOK_only(sv); /* validate number */
2168 =for apidoc sv_setiv_mg
2170 Like C<sv_setiv>, but also handles 'set' magic.
2176 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2183 =for apidoc sv_setuv
2185 Copies an unsigned integer into the given SV, upgrading first if necessary.
2186 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2192 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2194 /* With these two if statements:
2195 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2198 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2200 If you wish to remove them, please benchmark to see what the effect is
2202 if (u <= (UV)IV_MAX) {
2203 sv_setiv(sv, (IV)u);
2212 =for apidoc sv_setuv_mg
2214 Like C<sv_setuv>, but also handles 'set' magic.
2220 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2222 /* With these two if statements:
2223 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2226 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2228 If you wish to remove them, please benchmark to see what the effect is
2230 if (u <= (UV)IV_MAX) {
2231 sv_setiv(sv, (IV)u);
2241 =for apidoc sv_setnv
2243 Copies a double into the given SV, upgrading first if necessary.
2244 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2250 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2252 SV_CHECK_THINKFIRST_COW_DROP(sv);
2253 switch (SvTYPE(sv)) {
2256 sv_upgrade(sv, SVt_NV);
2261 sv_upgrade(sv, SVt_PVNV);
2270 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2274 (void)SvNOK_only(sv); /* validate number */
2279 =for apidoc sv_setnv_mg
2281 Like C<sv_setnv>, but also handles 'set' magic.
2287 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2293 /* Print an "isn't numeric" warning, using a cleaned-up,
2294 * printable version of the offending string
2298 S_not_a_number(pTHX_ SV *sv)
2305 dsv = sv_2mortal(newSVpv("", 0));
2306 pv = sv_uni_display(dsv, sv, 10, 0);
2309 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2310 /* each *s can expand to 4 chars + "...\0",
2311 i.e. need room for 8 chars */
2314 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2316 if (ch & 128 && !isPRINT_LC(ch)) {
2325 else if (ch == '\r') {
2329 else if (ch == '\f') {
2333 else if (ch == '\\') {
2337 else if (ch == '\0') {
2341 else if (isPRINT_LC(ch))
2358 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2359 "Argument \"%s\" isn't numeric in %s", pv,
2362 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2363 "Argument \"%s\" isn't numeric", pv);
2367 =for apidoc looks_like_number
2369 Test if the content of an SV looks like a number (or is a number).
2370 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2371 non-numeric warning), even if your atof() doesn't grok them.
2377 Perl_looks_like_number(pTHX_ SV *sv)
2379 register char *sbegin;
2386 else if (SvPOKp(sv))
2387 sbegin = SvPV(sv, len);
2389 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2390 return grok_number(sbegin, len, NULL);
2393 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2394 until proven guilty, assume that things are not that bad... */
2399 As 64 bit platforms often have an NV that doesn't preserve all bits of
2400 an IV (an assumption perl has been based on to date) it becomes necessary
2401 to remove the assumption that the NV always carries enough precision to
2402 recreate the IV whenever needed, and that the NV is the canonical form.
2403 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2404 precision as a side effect of conversion (which would lead to insanity
2405 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2406 1) to distinguish between IV/UV/NV slots that have cached a valid
2407 conversion where precision was lost and IV/UV/NV slots that have a
2408 valid conversion which has lost no precision
2409 2) to ensure that if a numeric conversion to one form is requested that
2410 would lose precision, the precise conversion (or differently
2411 imprecise conversion) is also performed and cached, to prevent
2412 requests for different numeric formats on the same SV causing
2413 lossy conversion chains. (lossless conversion chains are perfectly
2418 SvIOKp is true if the IV slot contains a valid value
2419 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2420 SvNOKp is true if the NV slot contains a valid value
2421 SvNOK is true only if the NV value is accurate
2424 while converting from PV to NV, check to see if converting that NV to an
2425 IV(or UV) would lose accuracy over a direct conversion from PV to
2426 IV(or UV). If it would, cache both conversions, return NV, but mark
2427 SV as IOK NOKp (ie not NOK).
2429 While converting from PV to IV, check to see if converting that IV to an
2430 NV would lose accuracy over a direct conversion from PV to NV. If it
2431 would, cache both conversions, flag similarly.
2433 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2434 correctly because if IV & NV were set NV *always* overruled.
2435 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2436 changes - now IV and NV together means that the two are interchangeable:
2437 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2439 The benefit of this is that operations such as pp_add know that if
2440 SvIOK is true for both left and right operands, then integer addition
2441 can be used instead of floating point (for cases where the result won't
2442 overflow). Before, floating point was always used, which could lead to
2443 loss of precision compared with integer addition.
2445 * making IV and NV equal status should make maths accurate on 64 bit
2447 * may speed up maths somewhat if pp_add and friends start to use
2448 integers when possible instead of fp. (Hopefully the overhead in
2449 looking for SvIOK and checking for overflow will not outweigh the
2450 fp to integer speedup)
2451 * will slow down integer operations (callers of SvIV) on "inaccurate"
2452 values, as the change from SvIOK to SvIOKp will cause a call into
2453 sv_2iv each time rather than a macro access direct to the IV slot
2454 * should speed up number->string conversion on integers as IV is
2455 favoured when IV and NV are equally accurate
2457 ####################################################################
2458 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2459 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2460 On the other hand, SvUOK is true iff UV.
2461 ####################################################################
2463 Your mileage will vary depending your CPU's relative fp to integer
2467 #ifndef NV_PRESERVES_UV
2468 # define IS_NUMBER_UNDERFLOW_IV 1
2469 # define IS_NUMBER_UNDERFLOW_UV 2
2470 # define IS_NUMBER_IV_AND_UV 2
2471 # define IS_NUMBER_OVERFLOW_IV 4
2472 # define IS_NUMBER_OVERFLOW_UV 5
2474 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2476 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2478 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2480 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2481 if (SvNVX(sv) < (NV)IV_MIN) {
2482 (void)SvIOKp_on(sv);
2485 return IS_NUMBER_UNDERFLOW_IV;
2487 if (SvNVX(sv) > (NV)UV_MAX) {
2488 (void)SvIOKp_on(sv);
2492 return IS_NUMBER_OVERFLOW_UV;
2494 (void)SvIOKp_on(sv);
2496 /* Can't use strtol etc to convert this string. (See truth table in
2498 if (SvNVX(sv) <= (UV)IV_MAX) {
2499 SvIVX(sv) = I_V(SvNVX(sv));
2500 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2501 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2503 /* Integer is imprecise. NOK, IOKp */
2505 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2508 SvUVX(sv) = U_V(SvNVX(sv));
2509 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2510 if (SvUVX(sv) == UV_MAX) {
2511 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2512 possibly be preserved by NV. Hence, it must be overflow.
2514 return IS_NUMBER_OVERFLOW_UV;
2516 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2518 /* Integer is imprecise. NOK, IOKp */
2520 return IS_NUMBER_OVERFLOW_IV;
2522 #endif /* !NV_PRESERVES_UV*/
2524 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2525 * this function provided for binary compatibility only
2529 Perl_sv_2iv(pTHX_ register SV *sv)
2531 return sv_2iv_flags(sv, SV_GMAGIC);
2535 =for apidoc sv_2iv_flags
2537 Return the integer value of an SV, doing any necessary string
2538 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2539 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2545 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2549 if (SvGMAGICAL(sv)) {
2550 if (flags & SV_GMAGIC)
2555 return I_V(SvNVX(sv));
2557 if (SvPOKp(sv) && SvLEN(sv))
2560 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2561 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2567 if (SvTHINKFIRST(sv)) {
2570 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2571 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2572 return SvIV(tmpstr);
2573 return PTR2IV(SvRV(sv));
2576 sv_force_normal_flags(sv, 0);
2578 if (SvREADONLY(sv) && !SvOK(sv)) {
2579 if (ckWARN(WARN_UNINITIALIZED))
2586 return (IV)(SvUVX(sv));
2593 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2594 * without also getting a cached IV/UV from it at the same time
2595 * (ie PV->NV conversion should detect loss of accuracy and cache
2596 * IV or UV at same time to avoid this. NWC */
2598 if (SvTYPE(sv) == SVt_NV)
2599 sv_upgrade(sv, SVt_PVNV);
2601 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2602 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2603 certainly cast into the IV range at IV_MAX, whereas the correct
2604 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2606 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2607 SvIVX(sv) = I_V(SvNVX(sv));
2608 if (SvNVX(sv) == (NV) SvIVX(sv)
2609 #ifndef NV_PRESERVES_UV
2610 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2611 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2612 /* Don't flag it as "accurately an integer" if the number
2613 came from a (by definition imprecise) NV operation, and
2614 we're outside the range of NV integer precision */
2617 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2618 DEBUG_c(PerlIO_printf(Perl_debug_log,
2619 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2625 /* IV not precise. No need to convert from PV, as NV
2626 conversion would already have cached IV if it detected
2627 that PV->IV would be better than PV->NV->IV
2628 flags already correct - don't set public IOK. */
2629 DEBUG_c(PerlIO_printf(Perl_debug_log,
2630 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2635 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2636 but the cast (NV)IV_MIN rounds to a the value less (more
2637 negative) than IV_MIN which happens to be equal to SvNVX ??
2638 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2639 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2640 (NV)UVX == NVX are both true, but the values differ. :-(
2641 Hopefully for 2s complement IV_MIN is something like
2642 0x8000000000000000 which will be exact. NWC */
2645 SvUVX(sv) = U_V(SvNVX(sv));
2647 (SvNVX(sv) == (NV) SvUVX(sv))
2648 #ifndef NV_PRESERVES_UV
2649 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2650 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2651 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2652 /* Don't flag it as "accurately an integer" if the number
2653 came from a (by definition imprecise) NV operation, and
2654 we're outside the range of NV integer precision */
2660 DEBUG_c(PerlIO_printf(Perl_debug_log,
2661 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2665 return (IV)SvUVX(sv);
2668 else if (SvPOKp(sv) && SvLEN(sv)) {
2670 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2671 /* We want to avoid a possible problem when we cache an IV which
2672 may be later translated to an NV, and the resulting NV is not
2673 the same as the direct translation of the initial string
2674 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2675 be careful to ensure that the value with the .456 is around if the
2676 NV value is requested in the future).
2678 This means that if we cache such an IV, we need to cache the
2679 NV as well. Moreover, we trade speed for space, and do not
2680 cache the NV if we are sure it's not needed.
2683 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2684 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2685 == IS_NUMBER_IN_UV) {
2686 /* It's definitely an integer, only upgrade to PVIV */
2687 if (SvTYPE(sv) < SVt_PVIV)
2688 sv_upgrade(sv, SVt_PVIV);
2690 } else if (SvTYPE(sv) < SVt_PVNV)
2691 sv_upgrade(sv, SVt_PVNV);
2693 /* If NV preserves UV then we only use the UV value if we know that
2694 we aren't going to call atof() below. If NVs don't preserve UVs
2695 then the value returned may have more precision than atof() will
2696 return, even though value isn't perfectly accurate. */
2697 if ((numtype & (IS_NUMBER_IN_UV
2698 #ifdef NV_PRESERVES_UV
2701 )) == IS_NUMBER_IN_UV) {
2702 /* This won't turn off the public IOK flag if it was set above */
2703 (void)SvIOKp_on(sv);
2705 if (!(numtype & IS_NUMBER_NEG)) {
2707 if (value <= (UV)IV_MAX) {
2708 SvIVX(sv) = (IV)value;
2714 /* 2s complement assumption */
2715 if (value <= (UV)IV_MIN) {
2716 SvIVX(sv) = -(IV)value;
2718 /* Too negative for an IV. This is a double upgrade, but
2719 I'm assuming it will be rare. */
2720 if (SvTYPE(sv) < SVt_PVNV)
2721 sv_upgrade(sv, SVt_PVNV);
2725 SvNVX(sv) = -(NV)value;
2730 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2731 will be in the previous block to set the IV slot, and the next
2732 block to set the NV slot. So no else here. */
2734 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2735 != IS_NUMBER_IN_UV) {
2736 /* It wasn't an (integer that doesn't overflow the UV). */
2737 SvNVX(sv) = Atof(SvPVX(sv));
2739 if (! numtype && ckWARN(WARN_NUMERIC))
2742 #if defined(USE_LONG_DOUBLE)
2743 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2744 PTR2UV(sv), SvNVX(sv)));
2746 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2747 PTR2UV(sv), SvNVX(sv)));
2751 #ifdef NV_PRESERVES_UV
2752 (void)SvIOKp_on(sv);
2754 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2755 SvIVX(sv) = I_V(SvNVX(sv));
2756 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2759 /* Integer is imprecise. NOK, IOKp */
2761 /* UV will not work better than IV */
2763 if (SvNVX(sv) > (NV)UV_MAX) {
2765 /* Integer is inaccurate. NOK, IOKp, is UV */
2769 SvUVX(sv) = U_V(SvNVX(sv));
2770 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2771 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2775 /* Integer is imprecise. NOK, IOKp, is UV */
2781 #else /* NV_PRESERVES_UV */
2782 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2783 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2784 /* The IV slot will have been set from value returned by
2785 grok_number above. The NV slot has just been set using
2788 assert (SvIOKp(sv));
2790 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2791 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2792 /* Small enough to preserve all bits. */
2793 (void)SvIOKp_on(sv);
2795 SvIVX(sv) = I_V(SvNVX(sv));
2796 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2798 /* Assumption: first non-preserved integer is < IV_MAX,
2799 this NV is in the preserved range, therefore: */
2800 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2802 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2806 0 0 already failed to read UV.
2807 0 1 already failed to read UV.
2808 1 0 you won't get here in this case. IV/UV
2809 slot set, public IOK, Atof() unneeded.
2810 1 1 already read UV.
2811 so there's no point in sv_2iuv_non_preserve() attempting
2812 to use atol, strtol, strtoul etc. */
2813 if (sv_2iuv_non_preserve (sv, numtype)
2814 >= IS_NUMBER_OVERFLOW_IV)
2818 #endif /* NV_PRESERVES_UV */
2821 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2823 if (SvTYPE(sv) < SVt_IV)
2824 /* Typically the caller expects that sv_any is not NULL now. */
2825 sv_upgrade(sv, SVt_IV);
2828 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2829 PTR2UV(sv),SvIVX(sv)));
2830 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2833 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2834 * this function provided for binary compatibility only
2838 Perl_sv_2uv(pTHX_ register SV *sv)
2840 return sv_2uv_flags(sv, SV_GMAGIC);
2844 =for apidoc sv_2uv_flags
2846 Return the unsigned integer value of an SV, doing any necessary string
2847 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2848 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2854 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2858 if (SvGMAGICAL(sv)) {
2859 if (flags & SV_GMAGIC)
2864 return U_V(SvNVX(sv));
2865 if (SvPOKp(sv) && SvLEN(sv))
2868 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2869 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2875 if (SvTHINKFIRST(sv)) {
2878 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2879 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2880 return SvUV(tmpstr);
2881 return PTR2UV(SvRV(sv));
2884 sv_force_normal_flags(sv, 0);
2886 if (SvREADONLY(sv) && !SvOK(sv)) {
2887 if (ckWARN(WARN_UNINITIALIZED))
2897 return (UV)SvIVX(sv);
2901 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2902 * without also getting a cached IV/UV from it at the same time
2903 * (ie PV->NV conversion should detect loss of accuracy and cache
2904 * IV or UV at same time to avoid this. */
2905 /* IV-over-UV optimisation - choose to cache IV if possible */
2907 if (SvTYPE(sv) == SVt_NV)
2908 sv_upgrade(sv, SVt_PVNV);
2910 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2911 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2912 SvIVX(sv) = I_V(SvNVX(sv));
2913 if (SvNVX(sv) == (NV) SvIVX(sv)
2914 #ifndef NV_PRESERVES_UV
2915 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2916 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2917 /* Don't flag it as "accurately an integer" if the number
2918 came from a (by definition imprecise) NV operation, and
2919 we're outside the range of NV integer precision */
2922 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2923 DEBUG_c(PerlIO_printf(Perl_debug_log,
2924 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2930 /* IV not precise. No need to convert from PV, as NV
2931 conversion would already have cached IV if it detected
2932 that PV->IV would be better than PV->NV->IV
2933 flags already correct - don't set public IOK. */
2934 DEBUG_c(PerlIO_printf(Perl_debug_log,
2935 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2940 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2941 but the cast (NV)IV_MIN rounds to a the value less (more
2942 negative) than IV_MIN which happens to be equal to SvNVX ??
2943 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2944 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2945 (NV)UVX == NVX are both true, but the values differ. :-(
2946 Hopefully for 2s complement IV_MIN is something like
2947 0x8000000000000000 which will be exact. NWC */
2950 SvUVX(sv) = U_V(SvNVX(sv));
2952 (SvNVX(sv) == (NV) SvUVX(sv))
2953 #ifndef NV_PRESERVES_UV
2954 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2955 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2956 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2957 /* Don't flag it as "accurately an integer" if the number
2958 came from a (by definition imprecise) NV operation, and
2959 we're outside the range of NV integer precision */
2964 DEBUG_c(PerlIO_printf(Perl_debug_log,
2965 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2971 else if (SvPOKp(sv) && SvLEN(sv)) {
2973 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2975 /* We want to avoid a possible problem when we cache a UV which
2976 may be later translated to an NV, and the resulting NV is not
2977 the translation of the initial data.
2979 This means that if we cache such a UV, we need to cache the
2980 NV as well. Moreover, we trade speed for space, and do not
2981 cache the NV if not needed.
2984 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2985 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2986 == IS_NUMBER_IN_UV) {
2987 /* It's definitely an integer, only upgrade to PVIV */
2988 if (SvTYPE(sv) < SVt_PVIV)
2989 sv_upgrade(sv, SVt_PVIV);
2991 } else if (SvTYPE(sv) < SVt_PVNV)
2992 sv_upgrade(sv, SVt_PVNV);
2994 /* If NV preserves UV then we only use the UV value if we know that
2995 we aren't going to call atof() below. If NVs don't preserve UVs
2996 then the value returned may have more precision than atof() will
2997 return, even though it isn't accurate. */
2998 if ((numtype & (IS_NUMBER_IN_UV
2999 #ifdef NV_PRESERVES_UV
3002 )) == IS_NUMBER_IN_UV) {
3003 /* This won't turn off the public IOK flag if it was set above */
3004 (void)SvIOKp_on(sv);
3006 if (!(numtype & IS_NUMBER_NEG)) {
3008 if (value <= (UV)IV_MAX) {
3009 SvIVX(sv) = (IV)value;
3011 /* it didn't overflow, and it was positive. */
3016 /* 2s complement assumption */
3017 if (value <= (UV)IV_MIN) {
3018 SvIVX(sv) = -(IV)value;
3020 /* Too negative for an IV. This is a double upgrade, but
3021 I'm assuming it will be rare. */
3022 if (SvTYPE(sv) < SVt_PVNV)
3023 sv_upgrade(sv, SVt_PVNV);
3027 SvNVX(sv) = -(NV)value;
3033 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3034 != IS_NUMBER_IN_UV) {
3035 /* It wasn't an integer, or it overflowed the UV. */
3036 SvNVX(sv) = Atof(SvPVX(sv));
3038 if (! numtype && ckWARN(WARN_NUMERIC))
3041 #if defined(USE_LONG_DOUBLE)
3042 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3043 PTR2UV(sv), SvNVX(sv)));
3045 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3046 PTR2UV(sv), SvNVX(sv)));
3049 #ifdef NV_PRESERVES_UV
3050 (void)SvIOKp_on(sv);
3052 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3053 SvIVX(sv) = I_V(SvNVX(sv));
3054 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3057 /* Integer is imprecise. NOK, IOKp */
3059 /* UV will not work better than IV */
3061 if (SvNVX(sv) > (NV)UV_MAX) {
3063 /* Integer is inaccurate. NOK, IOKp, is UV */
3067 SvUVX(sv) = U_V(SvNVX(sv));
3068 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3069 NV preservse UV so can do correct comparison. */
3070 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3074 /* Integer is imprecise. NOK, IOKp, is UV */
3079 #else /* NV_PRESERVES_UV */
3080 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3081 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3082 /* The UV slot will have been set from value returned by
3083 grok_number above. The NV slot has just been set using
3086 assert (SvIOKp(sv));
3088 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3089 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3090 /* Small enough to preserve all bits. */
3091 (void)SvIOKp_on(sv);
3093 SvIVX(sv) = I_V(SvNVX(sv));
3094 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3096 /* Assumption: first non-preserved integer is < IV_MAX,
3097 this NV is in the preserved range, therefore: */
3098 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3100 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
3103 sv_2iuv_non_preserve (sv, numtype);
3105 #endif /* NV_PRESERVES_UV */
3109 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3110 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3113 if (SvTYPE(sv) < SVt_IV)
3114 /* Typically the caller expects that sv_any is not NULL now. */
3115 sv_upgrade(sv, SVt_IV);
3119 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3120 PTR2UV(sv),SvUVX(sv)));
3121 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3127 Return the num value of an SV, doing any necessary string or integer
3128 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3135 Perl_sv_2nv(pTHX_ register SV *sv)
3139 if (SvGMAGICAL(sv)) {
3143 if (SvPOKp(sv) && SvLEN(sv)) {
3144 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3145 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3147 return Atof(SvPVX(sv));
3151 return (NV)SvUVX(sv);
3153 return (NV)SvIVX(sv);
3156 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3157 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3163 if (SvTHINKFIRST(sv)) {
3166 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3167 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3168 return SvNV(tmpstr);
3169 return PTR2NV(SvRV(sv));
3172 sv_force_normal_flags(sv, 0);
3174 if (SvREADONLY(sv) && !SvOK(sv)) {
3175 if (ckWARN(WARN_UNINITIALIZED))
3180 if (SvTYPE(sv) < SVt_NV) {
3181 if (SvTYPE(sv) == SVt_IV)
3182 sv_upgrade(sv, SVt_PVNV);
3184 sv_upgrade(sv, SVt_NV);
3185 #ifdef USE_LONG_DOUBLE
3187 STORE_NUMERIC_LOCAL_SET_STANDARD();
3188 PerlIO_printf(Perl_debug_log,
3189 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3190 PTR2UV(sv), SvNVX(sv));
3191 RESTORE_NUMERIC_LOCAL();
3195 STORE_NUMERIC_LOCAL_SET_STANDARD();
3196 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3197 PTR2UV(sv), SvNVX(sv));
3198 RESTORE_NUMERIC_LOCAL();
3202 else if (SvTYPE(sv) < SVt_PVNV)
3203 sv_upgrade(sv, SVt_PVNV);
3208 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
3209 #ifdef NV_PRESERVES_UV
3212 /* Only set the public NV OK flag if this NV preserves the IV */
3213 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3214 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3215 : (SvIVX(sv) == I_V(SvNVX(sv))))
3221 else if (SvPOKp(sv) && SvLEN(sv)) {
3223 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3224 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3226 #ifdef NV_PRESERVES_UV
3227 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3228 == IS_NUMBER_IN_UV) {
3229 /* It's definitely an integer */
3230 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3232 SvNVX(sv) = Atof(SvPVX(sv));
3235 SvNVX(sv) = Atof(SvPVX(sv));
3236 /* Only set the public NV OK flag if this NV preserves the value in
3237 the PV at least as well as an IV/UV would.
3238 Not sure how to do this 100% reliably. */
3239 /* if that shift count is out of range then Configure's test is
3240 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3242 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3243 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3244 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3245 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3246 /* Can't use strtol etc to convert this string, so don't try.
3247 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3250 /* value has been set. It may not be precise. */
3251 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3252 /* 2s complement assumption for (UV)IV_MIN */
3253 SvNOK_on(sv); /* Integer is too negative. */
3258 if (numtype & IS_NUMBER_NEG) {
3259 SvIVX(sv) = -(IV)value;
3260 } else if (value <= (UV)IV_MAX) {
3261 SvIVX(sv) = (IV)value;
3267 if (numtype & IS_NUMBER_NOT_INT) {
3268 /* I believe that even if the original PV had decimals,
3269 they are lost beyond the limit of the FP precision.
3270 However, neither is canonical, so both only get p
3271 flags. NWC, 2000/11/25 */
3272 /* Both already have p flags, so do nothing */
3275 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3276 if (SvIVX(sv) == I_V(nv)) {
3281 /* It had no "." so it must be integer. */
3284 /* between IV_MAX and NV(UV_MAX).
3285 Could be slightly > UV_MAX */
3287 if (numtype & IS_NUMBER_NOT_INT) {
3288 /* UV and NV both imprecise. */
3290 UV nv_as_uv = U_V(nv);
3292 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3303 #endif /* NV_PRESERVES_UV */
3306 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3308 if (SvTYPE(sv) < SVt_NV)
3309 /* Typically the caller expects that sv_any is not NULL now. */
3310 /* XXX Ilya implies that this is a bug in callers that assume this
3311 and ideally should be fixed. */
3312 sv_upgrade(sv, SVt_NV);
3315 #if defined(USE_LONG_DOUBLE)
3317 STORE_NUMERIC_LOCAL_SET_STANDARD();
3318 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3319 PTR2UV(sv), SvNVX(sv));
3320 RESTORE_NUMERIC_LOCAL();
3324 STORE_NUMERIC_LOCAL_SET_STANDARD();
3325 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3326 PTR2UV(sv), SvNVX(sv));
3327 RESTORE_NUMERIC_LOCAL();
3333 /* asIV(): extract an integer from the string value of an SV.
3334 * Caller must validate PVX */
3337 S_asIV(pTHX_ SV *sv)
3340 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3342 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3343 == IS_NUMBER_IN_UV) {
3344 /* It's definitely an integer */
3345 if (numtype & IS_NUMBER_NEG) {
3346 if (value < (UV)IV_MIN)
3349 if (value < (UV)IV_MAX)
3354 if (ckWARN(WARN_NUMERIC))
3357 return I_V(Atof(SvPVX(sv)));
3360 /* asUV(): extract an unsigned integer from the string value of an SV
3361 * Caller must validate PVX */
3364 S_asUV(pTHX_ SV *sv)
3367 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3369 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3370 == IS_NUMBER_IN_UV) {
3371 /* It's definitely an integer */
3372 if (!(numtype & IS_NUMBER_NEG))
3376 if (ckWARN(WARN_NUMERIC))
3379 return U_V(Atof(SvPVX(sv)));
3383 =for apidoc sv_2pv_nolen
3385 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3386 use the macro wrapper C<SvPV_nolen(sv)> instead.
3391 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3394 return sv_2pv(sv, &n_a);
3397 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3398 * UV as a string towards the end of buf, and return pointers to start and
3401 * We assume that buf is at least TYPE_CHARS(UV) long.
3405 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3407 char *ptr = buf + TYPE_CHARS(UV);
3421 *--ptr = '0' + (char)(uv % 10);
3429 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3430 * this function provided for binary compatibility only
3434 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3436 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3440 =for apidoc sv_2pv_flags
3442 Returns a pointer to the string value of an SV, and sets *lp to its length.
3443 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3445 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3446 usually end up here too.
3452 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3457 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3458 char *tmpbuf = tbuf;
3464 if (SvGMAGICAL(sv)) {
3465 if (flags & SV_GMAGIC)
3473 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3475 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3480 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3485 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3486 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3493 if (SvTHINKFIRST(sv)) {
3496 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3497 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3498 char *pv = SvPV(tmpstr, *lp);
3512 switch (SvTYPE(sv)) {
3514 if ( ((SvFLAGS(sv) &
3515 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3516 == (SVs_OBJECT|SVs_SMG))
3517 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3518 regexp *re = (regexp *)mg->mg_obj;
3521 char *fptr = "msix";
3526 char need_newline = 0;
3527 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3529 while((ch = *fptr++)) {
3531 reflags[left++] = ch;
3534 reflags[right--] = ch;
3539 reflags[left] = '-';
3543 mg->mg_len = re->prelen + 4 + left;
3545 * If /x was used, we have to worry about a regex
3546 * ending with a comment later being embedded
3547 * within another regex. If so, we don't want this
3548 * regex's "commentization" to leak out to the
3549 * right part of the enclosing regex, we must cap
3550 * it with a newline.
3552 * So, if /x was used, we scan backwards from the
3553 * end of the regex. If we find a '#' before we
3554 * find a newline, we need to add a newline
3555 * ourself. If we find a '\n' first (or if we
3556 * don't find '#' or '\n'), we don't need to add
3557 * anything. -jfriedl
3559 if (PMf_EXTENDED & re->reganch)
3561 char *endptr = re->precomp + re->prelen;
3562 while (endptr >= re->precomp)
3564 char c = *(endptr--);
3566 break; /* don't need another */
3568 /* we end while in a comment, so we
3570 mg->mg_len++; /* save space for it */
3571 need_newline = 1; /* note to add it */
3577 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3578 Copy("(?", mg->mg_ptr, 2, char);
3579 Copy(reflags, mg->mg_ptr+2, left, char);
3580 Copy(":", mg->mg_ptr+left+2, 1, char);
3581 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3583 mg->mg_ptr[mg->mg_len - 2] = '\n';
3584 mg->mg_ptr[mg->mg_len - 1] = ')';
3585 mg->mg_ptr[mg->mg_len] = 0;
3587 PL_reginterp_cnt += re->program[0].next_off;
3589 if (re->reganch & ROPT_UTF8)
3604 case SVt_PVBM: if (SvROK(sv))
3607 s = "SCALAR"; break;
3608 case SVt_PVLV: s = SvROK(sv) ? "REF"
3609 /* tied lvalues should appear to be
3610 * scalars for backwards compatitbility */
3611 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3612 ? "SCALAR" : "LVALUE"; break;
3613 case SVt_PVAV: s = "ARRAY"; break;
3614 case SVt_PVHV: s = "HASH"; break;
3615 case SVt_PVCV: s = "CODE"; break;
3616 case SVt_PVGV: s = "GLOB"; break;
3617 case SVt_PVFM: s = "FORMAT"; break;
3618 case SVt_PVIO: s = "IO"; break;
3619 default: s = "UNKNOWN"; break;
3623 if (HvNAME(SvSTASH(sv)))
3624 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3626 Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3629 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3635 if (SvREADONLY(sv) && !SvOK(sv)) {
3636 if (ckWARN(WARN_UNINITIALIZED))
3642 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3643 /* I'm assuming that if both IV and NV are equally valid then
3644 converting the IV is going to be more efficient */
3645 U32 isIOK = SvIOK(sv);
3646 U32 isUIOK = SvIsUV(sv);
3647 char buf[TYPE_CHARS(UV)];
3650 if (SvTYPE(sv) < SVt_PVIV)
3651 sv_upgrade(sv, SVt_PVIV);
3653 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3655 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3656 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3657 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3658 SvCUR_set(sv, ebuf - ptr);
3668 else if (SvNOKp(sv)) {
3669 if (SvTYPE(sv) < SVt_PVNV)
3670 sv_upgrade(sv, SVt_PVNV);
3671 /* The +20 is pure guesswork. Configure test needed. --jhi */
3672 SvGROW(sv, NV_DIG + 20);
3674 olderrno = errno; /* some Xenix systems wipe out errno here */
3676 if (SvNVX(sv) == 0.0)
3677 (void)strcpy(s,"0");
3681 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3684 #ifdef FIXNEGATIVEZERO
3685 if (*s == '-' && s[1] == '0' && !s[2])
3695 if (ckWARN(WARN_UNINITIALIZED)
3696 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3699 if (SvTYPE(sv) < SVt_PV)
3700 /* Typically the caller expects that sv_any is not NULL now. */
3701 sv_upgrade(sv, SVt_PV);
3704 *lp = s - SvPVX(sv);
3707 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3708 PTR2UV(sv),SvPVX(sv)));
3712 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3713 /* Sneaky stuff here */
3717 tsv = newSVpv(tmpbuf, 0);
3733 len = strlen(tmpbuf);
3735 #ifdef FIXNEGATIVEZERO
3736 if (len == 2 && t[0] == '-' && t[1] == '0') {
3741 (void)SvUPGRADE(sv, SVt_PV);
3743 s = SvGROW(sv, len + 1);
3746 return strcpy(s, t);
3751 =for apidoc sv_copypv
3753 Copies a stringified representation of the source SV into the
3754 destination SV. Automatically performs any necessary mg_get and
3755 coercion of numeric values into strings. Guaranteed to preserve
3756 UTF-8 flag even from overloaded objects. Similar in nature to
3757 sv_2pv[_flags] but operates directly on an SV instead of just the
3758 string. Mostly uses sv_2pv_flags to do its work, except when that
3759 would lose the UTF-8'ness of the PV.
3765 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3770 sv_setpvn(dsv,s,len);
3778 =for apidoc sv_2pvbyte_nolen
3780 Return a pointer to the byte-encoded representation of the SV.
3781 May cause the SV to be downgraded from UTF-8 as a side-effect.
3783 Usually accessed via the C<SvPVbyte_nolen> macro.
3789 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3792 return sv_2pvbyte(sv, &n_a);
3796 =for apidoc sv_2pvbyte
3798 Return a pointer to the byte-encoded representation of the SV, and set *lp
3799 to its length. May cause the SV to be downgraded from UTF-8 as a
3802 Usually accessed via the C<SvPVbyte> macro.
3808 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3810 sv_utf8_downgrade(sv,0);
3811 return SvPV(sv,*lp);
3815 =for apidoc sv_2pvutf8_nolen
3817 Return a pointer to the UTF-8-encoded representation of the SV.
3818 May cause the SV to be upgraded to UTF-8 as a side-effect.
3820 Usually accessed via the C<SvPVutf8_nolen> macro.
3826 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3829 return sv_2pvutf8(sv, &n_a);
3833 =for apidoc sv_2pvutf8
3835 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3836 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3838 Usually accessed via the C<SvPVutf8> macro.
3844 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3846 sv_utf8_upgrade(sv);
3847 return SvPV(sv,*lp);
3851 =for apidoc sv_2bool
3853 This function is only called on magical items, and is only used by
3854 sv_true() or its macro equivalent.
3860 Perl_sv_2bool(pTHX_ register SV *sv)
3869 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3870 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3871 return (bool)SvTRUE(tmpsv);
3872 return SvRV(sv) != 0;
3875 register XPV* Xpvtmp;
3876 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3877 (*Xpvtmp->xpv_pv > '0' ||
3878 Xpvtmp->xpv_cur > 1 ||
3879 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3886 return SvIVX(sv) != 0;
3889 return SvNVX(sv) != 0.0;
3896 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3897 * this function provided for binary compatibility only
3902 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3904 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3908 =for apidoc sv_utf8_upgrade
3910 Converts the PV of an SV to its UTF-8-encoded form.
3911 Forces the SV to string form if it is not already.
3912 Always sets the SvUTF8 flag to avoid future validity checks even
3913 if all the bytes have hibit clear.
3915 This is not as a general purpose byte encoding to Unicode interface:
3916 use the Encode extension for that.
3918 =for apidoc sv_utf8_upgrade_flags
3920 Converts the PV of an SV to its UTF-8-encoded form.
3921 Forces the SV to string form if it is not already.
3922 Always sets the SvUTF8 flag to avoid future validity checks even
3923 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3924 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3925 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3927 This is not as a general purpose byte encoding to Unicode interface:
3928 use the Encode extension for that.
3934 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3939 if (sv == &PL_sv_undef)
3943 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3944 (void) sv_2pv_flags(sv,&len, flags);
3948 (void) SvPV_force(sv,len);
3957 sv_force_normal_flags(sv, 0);
3960 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3961 sv_recode_to_utf8(sv, PL_encoding);
3962 else { /* Assume Latin-1/EBCDIC */
3963 /* This function could be much more efficient if we
3964 * had a FLAG in SVs to signal if there are any hibit
3965 * chars in the PV. Given that there isn't such a flag
3966 * make the loop as fast as possible. */
3967 s = (U8 *) SvPVX(sv);
3968 e = (U8 *) SvEND(sv);
3972 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3977 (void)SvOOK_off(sv);
3979 len = SvCUR(sv) + 1; /* Plus the \0 */
3980 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3981 SvCUR(sv) = len - 1;
3983 Safefree(s); /* No longer using what was there before. */
3984 SvLEN(sv) = len; /* No longer know the real size. */
3986 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3993 =for apidoc sv_utf8_downgrade
3995 Attempts to convert the PV of an SV from characters to bytes.
3996 If the PV contains a character beyond byte, this conversion will fail;
3997 in this case, either returns false or, if C<fail_ok> is not
4000 This is not as a general purpose Unicode to byte encoding interface:
4001 use the Encode extension for that.
4007 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4009 if (SvPOKp(sv) && SvUTF8(sv)) {
4015 sv_force_normal_flags(sv, 0);
4017 s = (U8 *) SvPV(sv, len);
4018 if (!utf8_to_bytes(s, &len)) {
4023 Perl_croak(aTHX_ "Wide character in %s",
4026 Perl_croak(aTHX_ "Wide character");
4037 =for apidoc sv_utf8_encode
4039 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4040 flag off so that it looks like octets again.
4046 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4048 (void) sv_utf8_upgrade(sv);
4050 sv_force_normal_flags(sv, 0);
4052 if (SvREADONLY(sv)) {
4053 Perl_croak(aTHX_ PL_no_modify);
4059 =for apidoc sv_utf8_decode
4061 If the PV of the SV is an octet sequence in UTF-8
4062 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4063 so that it looks like a character. If the PV contains only single-byte
4064 characters, the C<SvUTF8> flag stays being off.
4065 Scans PV for validity and returns false if the PV is invalid UTF-8.
4071 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4077 /* The octets may have got themselves encoded - get them back as
4080 if (!sv_utf8_downgrade(sv, TRUE))
4083 /* it is actually just a matter of turning the utf8 flag on, but
4084 * we want to make sure everything inside is valid utf8 first.
4086 c = (U8 *) SvPVX(sv);
4087 if (!is_utf8_string(c, SvCUR(sv)+1))
4089 e = (U8 *) SvEND(sv);
4092 if (!UTF8_IS_INVARIANT(ch)) {
4101 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4102 * this function provided for binary compatibility only
4106 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4108 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4112 =for apidoc sv_setsv
4114 Copies the contents of the source SV C<ssv> into the destination SV
4115 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4116 function if the source SV needs to be reused. Does not handle 'set' magic.
4117 Loosely speaking, it performs a copy-by-value, obliterating any previous
4118 content of the destination.
4120 You probably want to use one of the assortment of wrappers, such as
4121 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4122 C<SvSetMagicSV_nosteal>.
4124 =for apidoc sv_setsv_flags
4126 Copies the contents of the source SV C<ssv> into the destination SV
4127 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4128 function if the source SV needs to be reused. Does not handle 'set' magic.
4129 Loosely speaking, it performs a copy-by-value, obliterating any previous
4130 content of the destination.
4131 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4132 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4133 implemented in terms of this function.
4135 You probably want to use one of the assortment of wrappers, such as
4136 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4137 C<SvSetMagicSV_nosteal>.
4139 This is the primary function for copying scalars, and most other
4140 copy-ish functions and macros use this underneath.
4146 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4148 register U32 sflags;
4154 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4156 sstr = &PL_sv_undef;
4157 stype = SvTYPE(sstr);
4158 dtype = SvTYPE(dstr);
4163 /* need to nuke the magic */
4165 SvRMAGICAL_off(dstr);
4168 /* There's a lot of redundancy below but we're going for speed here */
4173 if (dtype != SVt_PVGV) {
4174 (void)SvOK_off(dstr);
4182 sv_upgrade(dstr, SVt_IV);
4185 sv_upgrade(dstr, SVt_PVNV);
4189 sv_upgrade(dstr, SVt_PVIV);
4192 (void)SvIOK_only(dstr);
4193 SvIVX(dstr) = SvIVX(sstr);
4196 if (SvTAINTED(sstr))
4207 sv_upgrade(dstr, SVt_NV);
4212 sv_upgrade(dstr, SVt_PVNV);
4215 SvNVX(dstr) = SvNVX(sstr);
4216 (void)SvNOK_only(dstr);
4217 if (SvTAINTED(sstr))
4225 sv_upgrade(dstr, SVt_RV);
4226 else if (dtype == SVt_PVGV &&
4227 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4230 if (GvIMPORTED(dstr) != GVf_IMPORTED
4231 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4233 GvIMPORTED_on(dstr);
4242 #ifdef PERL_COPY_ON_WRITE
4243 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4244 if (dtype < SVt_PVIV)
4245 sv_upgrade(dstr, SVt_PVIV);
4252 sv_upgrade(dstr, SVt_PV);
4255 if (dtype < SVt_PVIV)
4256 sv_upgrade(dstr, SVt_PVIV);
4259 if (dtype < SVt_PVNV)
4260 sv_upgrade(dstr, SVt_PVNV);
4267 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4270 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4274 if (dtype <= SVt_PVGV) {
4276 if (dtype != SVt_PVGV) {
4277 char *name = GvNAME(sstr);
4278 STRLEN len = GvNAMELEN(sstr);
4279 /* don't upgrade SVt_PVLV: it can hold a glob */
4280 if (dtype != SVt_PVLV)
4281 sv_upgrade(dstr, SVt_PVGV);
4282 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4283 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4284 GvNAME(dstr) = savepvn(name, len);
4285 GvNAMELEN(dstr) = len;
4286 SvFAKE_on(dstr); /* can coerce to non-glob */
4288 /* ahem, death to those who redefine active sort subs */
4289 else if (PL_curstackinfo->si_type == PERLSI_SORT
4290 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4291 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4294 #ifdef GV_UNIQUE_CHECK
4295 if (GvUNIQUE((GV*)dstr)) {
4296 Perl_croak(aTHX_ PL_no_modify);
4300 (void)SvOK_off(dstr);
4301 GvINTRO_off(dstr); /* one-shot flag */
4303 GvGP(dstr) = gp_ref(GvGP(sstr));
4304 if (SvTAINTED(sstr))
4306 if (GvIMPORTED(dstr) != GVf_IMPORTED
4307 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4309 GvIMPORTED_on(dstr);
4317 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4319 if ((int)SvTYPE(sstr) != stype) {
4320 stype = SvTYPE(sstr);
4321 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4325 if (stype == SVt_PVLV)
4326 (void)SvUPGRADE(dstr, SVt_PVNV);
4328 (void)SvUPGRADE(dstr, (U32)stype);
4331 sflags = SvFLAGS(sstr);
4333 if (sflags & SVf_ROK) {
4334 if (dtype >= SVt_PV) {
4335 if (dtype == SVt_PVGV) {
4336 SV *sref = SvREFCNT_inc(SvRV(sstr));
4338 int intro = GvINTRO(dstr);
4340 #ifdef GV_UNIQUE_CHECK
4341 if (GvUNIQUE((GV*)dstr)) {
4342 Perl_croak(aTHX_ PL_no_modify);
4347 GvINTRO_off(dstr); /* one-shot flag */
4348 GvLINE(dstr) = CopLINE(PL_curcop);
4349 GvEGV(dstr) = (GV*)dstr;
4352 switch (SvTYPE(sref)) {
4355 SAVEGENERICSV(GvAV(dstr));
4357 dref = (SV*)GvAV(dstr);
4358 GvAV(dstr) = (AV*)sref;
4359 if (!GvIMPORTED_AV(dstr)
4360 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4362 GvIMPORTED_AV_on(dstr);
4367 SAVEGENERICSV(GvHV(dstr));
4369 dref = (SV*)GvHV(dstr);
4370 GvHV(dstr) = (HV*)sref;
4371 if (!GvIMPORTED_HV(dstr)
4372 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4374 GvIMPORTED_HV_on(dstr);
4379 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4380 SvREFCNT_dec(GvCV(dstr));
4381 GvCV(dstr) = Nullcv;
4382 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4383 PL_sub_generation++;
4385 SAVEGENERICSV(GvCV(dstr));
4388 dref = (SV*)GvCV(dstr);
4389 if (GvCV(dstr) != (CV*)sref) {
4390 CV* cv = GvCV(dstr);
4392 if (!GvCVGEN((GV*)dstr) &&
4393 (CvROOT(cv) || CvXSUB(cv)))
4395 /* ahem, death to those who redefine
4396 * active sort subs */
4397 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4398 PL_sortcop == CvSTART(cv))
4400 "Can't redefine active sort subroutine %s",
4401 GvENAME((GV*)dstr));
4402 /* Redefining a sub - warning is mandatory if
4403 it was a const and its value changed. */
4404 if (ckWARN(WARN_REDEFINE)
4406 && (!CvCONST((CV*)sref)
4407 || sv_cmp(cv_const_sv(cv),
4408 cv_const_sv((CV*)sref)))))
4410 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4412 ? "Constant subroutine %s::%s redefined"
4413 : "Subroutine %s::%s redefined",
4414 HvNAME(GvSTASH((GV*)dstr)),
4415 GvENAME((GV*)dstr));
4419 cv_ckproto(cv, (GV*)dstr,
4420 SvPOK(sref) ? SvPVX(sref) : Nullch);
4422 GvCV(dstr) = (CV*)sref;
4423 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4424 GvASSUMECV_on(dstr);
4425 PL_sub_generation++;
4427 if (!GvIMPORTED_CV(dstr)
4428 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4430 GvIMPORTED_CV_on(dstr);
4435 SAVEGENERICSV(GvIOp(dstr));
4437 dref = (SV*)GvIOp(dstr);
4438 GvIOp(dstr) = (IO*)sref;
4442 SAVEGENERICSV(GvFORM(dstr));
4444 dref = (SV*)GvFORM(dstr);
4445 GvFORM(dstr) = (CV*)sref;
4449 SAVEGENERICSV(GvSV(dstr));
4451 dref = (SV*)GvSV(dstr);
4453 if (!GvIMPORTED_SV(dstr)
4454 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4456 GvIMPORTED_SV_on(dstr);
4462 if (SvTAINTED(sstr))
4467 (void)SvOOK_off(dstr); /* backoff */
4469 Safefree(SvPVX(dstr));
4470 SvLEN(dstr)=SvCUR(dstr)=0;
4473 (void)SvOK_off(dstr);
4474 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4476 if (sflags & SVp_NOK) {
4478 /* Only set the public OK flag if the source has public OK. */
4479 if (sflags & SVf_NOK)
4480 SvFLAGS(dstr) |= SVf_NOK;
4481 SvNVX(dstr) = SvNVX(sstr);
4483 if (sflags & SVp_IOK) {
4484 (void)SvIOKp_on(dstr);
4485 if (sflags & SVf_IOK)
4486 SvFLAGS(dstr) |= SVf_IOK;
4487 if (sflags & SVf_IVisUV)
4489 SvIVX(dstr) = SvIVX(sstr);
4491 if (SvAMAGIC(sstr)) {
4495 else if (sflags & SVp_POK) {
4499 * Check to see if we can just swipe the string. If so, it's a
4500 * possible small lose on short strings, but a big win on long ones.
4501 * It might even be a win on short strings if SvPVX(dstr)
4502 * has to be allocated and SvPVX(sstr) has to be freed.
4505 /* Whichever path we take through the next code, we want this true,
4506 and doing it now facilitates the COW check. */
4507 (void)SvPOK_only(dstr);
4510 #ifdef PERL_COPY_ON_WRITE
4511 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4515 (sflags & SVs_TEMP) && /* slated for free anyway? */
4516 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4517 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4518 SvLEN(sstr) && /* and really is a string */
4519 /* and won't be needed again, potentially */
4520 !(PL_op && PL_op->op_type == OP_AASSIGN))
4521 #ifdef PERL_COPY_ON_WRITE
4522 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4523 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4524 && SvTYPE(sstr) >= SVt_PVIV)
4527 /* Failed the swipe test, and it's not a shared hash key either.
4528 Have to copy the string. */
4529 STRLEN len = SvCUR(sstr);
4530 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4531 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4532 SvCUR_set(dstr, len);
4533 *SvEND(dstr) = '\0';
4535 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4537 #ifdef PERL_COPY_ON_WRITE
4538 /* Either it's a shared hash key, or it's suitable for
4539 copy-on-write or we can swipe the string. */
4541 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4546 /* I believe I should acquire a global SV mutex if
4547 it's a COW sv (not a shared hash key) to stop
4548 it going un copy-on-write.
4549 If the source SV has gone un copy on write between up there
4550 and down here, then (assert() that) it is of the correct
4551 form to make it copy on write again */
4552 if ((sflags & (SVf_FAKE | SVf_READONLY))
4553 != (SVf_FAKE | SVf_READONLY)) {
4554 SvREADONLY_on(sstr);
4556 /* Make the source SV into a loop of 1.
4557 (about to become 2) */
4558 SV_COW_NEXT_SV_SET(sstr, sstr);
4562 /* Initial code is common. */
4563 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4565 SvFLAGS(dstr) &= ~SVf_OOK;
4566 Safefree(SvPVX(dstr) - SvIVX(dstr));
4568 else if (SvLEN(dstr))
4569 Safefree(SvPVX(dstr));
4572 #ifdef PERL_COPY_ON_WRITE
4574 /* making another shared SV. */
4575 STRLEN cur = SvCUR(sstr);
4576 STRLEN len = SvLEN(sstr);
4577 assert (SvTYPE(dstr) >= SVt_PVIV);
4579 /* SvIsCOW_normal */
4580 /* splice us in between source and next-after-source. */
4581 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4582 SV_COW_NEXT_SV_SET(sstr, dstr);
4583 SvPV_set(dstr, SvPVX(sstr));
4585 /* SvIsCOW_shared_hash */
4586 UV hash = SvUVX(sstr);
4587 DEBUG_C(PerlIO_printf(Perl_debug_log,
4588 "Copy on write: Sharing hash\n"));
4590 sharepvn(SvPVX(sstr),
4591 (sflags & SVf_UTF8?-cur:cur), hash));
4596 SvREADONLY_on(dstr);
4598 /* Relesase a global SV mutex. */
4602 { /* Passes the swipe test. */
4603 SvPV_set(dstr, SvPVX(sstr));
4604 SvLEN_set(dstr, SvLEN(sstr));
4605 SvCUR_set(dstr, SvCUR(sstr));
4608 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4609 SvPV_set(sstr, Nullch);
4615 if (sflags & SVf_UTF8)
4618 if (sflags & SVp_NOK) {
4620 if (sflags & SVf_NOK)
4621 SvFLAGS(dstr) |= SVf_NOK;
4622 SvNVX(dstr) = SvNVX(sstr);
4624 if (sflags & SVp_IOK) {
4625 (void)SvIOKp_on(dstr);
4626 if (sflags & SVf_IOK)
4627 SvFLAGS(dstr) |= SVf_IOK;
4628 if (sflags & SVf_IVisUV)
4630 SvIVX(dstr) = SvIVX(sstr);
4633 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4634 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4635 smg->mg_ptr, smg->mg_len);
4636 SvRMAGICAL_on(dstr);
4639 else if (sflags & SVp_IOK) {
4640 if (sflags & SVf_IOK)
4641 (void)SvIOK_only(dstr);
4643 (void)SvOK_off(dstr);
4644 (void)SvIOKp_on(dstr);
4646 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4647 if (sflags & SVf_IVisUV)
4649 SvIVX(dstr) = SvIVX(sstr);
4650 if (sflags & SVp_NOK) {
4651 if (sflags & SVf_NOK)
4652 (void)SvNOK_on(dstr);
4654 (void)SvNOKp_on(dstr);
4655 SvNVX(dstr) = SvNVX(sstr);
4658 else if (sflags & SVp_NOK) {
4659 if (sflags & SVf_NOK)
4660 (void)SvNOK_only(dstr);
4662 (void)SvOK_off(dstr);
4665 SvNVX(dstr) = SvNVX(sstr);
4668 if (dtype == SVt_PVGV) {
4669 if (ckWARN(WARN_MISC))
4670 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4673 (void)SvOK_off(dstr);
4675 if (SvTAINTED(sstr))
4680 =for apidoc sv_setsv_mg
4682 Like C<sv_setsv>, but also handles 'set' magic.
4688 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4690 sv_setsv(dstr,sstr);
4694 #ifdef PERL_COPY_ON_WRITE
4696 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4698 STRLEN cur = SvCUR(sstr);
4699 STRLEN len = SvLEN(sstr);
4700 register char *new_pv;
4703 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4711 if (SvTHINKFIRST(dstr))
4712 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4713 else if (SvPVX(dstr))
4714 Safefree(SvPVX(dstr));
4718 (void)SvUPGRADE (dstr, SVt_PVIV);
4720 assert (SvPOK(sstr));
4721 assert (SvPOKp(sstr));
4722 assert (!SvIOK(sstr));
4723 assert (!SvIOKp(sstr));
4724 assert (!SvNOK(sstr));
4725 assert (!SvNOKp(sstr));
4727 if (SvIsCOW(sstr)) {
4729 if (SvLEN(sstr) == 0) {
4730 /* source is a COW shared hash key. */
4731 UV hash = SvUVX(sstr);
4732 DEBUG_C(PerlIO_printf(Perl_debug_log,
4733 "Fast copy on write: Sharing hash\n"));
4735 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4738 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4740 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4741 (void)SvUPGRADE (sstr, SVt_PVIV);
4742 SvREADONLY_on(sstr);
4744 DEBUG_C(PerlIO_printf(Perl_debug_log,
4745 "Fast copy on write: Converting sstr to COW\n"));
4746 SV_COW_NEXT_SV_SET(dstr, sstr);
4748 SV_COW_NEXT_SV_SET(sstr, dstr);
4749 new_pv = SvPVX(sstr);
4752 SvPV_set(dstr, new_pv);
4753 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4766 =for apidoc sv_setpvn
4768 Copies a string into an SV. The C<len> parameter indicates the number of
4769 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4770 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4776 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4778 register char *dptr;
4780 SV_CHECK_THINKFIRST_COW_DROP(sv);
4786 /* len is STRLEN which is unsigned, need to copy to signed */
4789 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4791 (void)SvUPGRADE(sv, SVt_PV);
4793 SvGROW(sv, len + 1);
4795 Move(ptr,dptr,len,char);
4798 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4803 =for apidoc sv_setpvn_mg
4805 Like C<sv_setpvn>, but also handles 'set' magic.
4811 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4813 sv_setpvn(sv,ptr,len);
4818 =for apidoc sv_setpv
4820 Copies a string into an SV. The string must be null-terminated. Does not
4821 handle 'set' magic. See C<sv_setpv_mg>.
4827 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4829 register STRLEN len;
4831 SV_CHECK_THINKFIRST_COW_DROP(sv);
4837 (void)SvUPGRADE(sv, SVt_PV);
4839 SvGROW(sv, len + 1);
4840 Move(ptr,SvPVX(sv),len+1,char);
4842 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4847 =for apidoc sv_setpv_mg
4849 Like C<sv_setpv>, but also handles 'set' magic.
4855 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4862 =for apidoc sv_usepvn
4864 Tells an SV to use C<ptr> to find its string value. Normally the string is
4865 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4866 The C<ptr> should point to memory that was allocated by C<malloc>. The
4867 string length, C<len>, must be supplied. This function will realloc the
4868 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4869 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4870 See C<sv_usepvn_mg>.
4876 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4878 SV_CHECK_THINKFIRST_COW_DROP(sv);
4879 (void)SvUPGRADE(sv, SVt_PV);
4884 (void)SvOOK_off(sv);
4885 if (SvPVX(sv) && SvLEN(sv))
4886 Safefree(SvPVX(sv));
4887 Renew(ptr, len+1, char);
4890 SvLEN_set(sv, len+1);
4892 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4897 =for apidoc sv_usepvn_mg
4899 Like C<sv_usepvn>, but also handles 'set' magic.
4905 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4907 sv_usepvn(sv,ptr,len);
4911 #ifdef PERL_COPY_ON_WRITE
4912 /* Need to do this *after* making the SV normal, as we need the buffer
4913 pointer to remain valid until after we've copied it. If we let go too early,
4914 another thread could invalidate it by unsharing last of the same hash key
4915 (which it can do by means other than releasing copy-on-write Svs)
4916 or by changing the other copy-on-write SVs in the loop. */
4918 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4919 U32 hash, SV *after)
4921 if (len) { /* this SV was SvIsCOW_normal(sv) */
4922 /* we need to find the SV pointing to us. */
4923 SV *current = SV_COW_NEXT_SV(after);
4925 if (current == sv) {
4926 /* The SV we point to points back to us (there were only two of us
4928 Hence other SV is no longer copy on write either. */
4930 SvREADONLY_off(after);
4932 /* We need to follow the pointers around the loop. */
4934 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4937 /* don't loop forever if the structure is bust, and we have
4938 a pointer into a closed loop. */
4939 assert (current != after);
4940 assert (SvPVX(current) == pvx);
4942 /* Make the SV before us point to the SV after us. */
4943 SV_COW_NEXT_SV_SET(current, after);
4946 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4951 Perl_sv_release_IVX(pTHX_ register SV *sv)
4954 sv_force_normal_flags(sv, 0);
4960 =for apidoc sv_force_normal_flags
4962 Undo various types of fakery on an SV: if the PV is a shared string, make
4963 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4964 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4965 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4966 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4967 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4968 set to some other value.) In addition, the C<flags> parameter gets passed to
4969 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4970 with flags set to 0.
4976 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4978 #ifdef PERL_COPY_ON_WRITE
4979 if (SvREADONLY(sv)) {
4980 /* At this point I believe I should acquire a global SV mutex. */
4982 char *pvx = SvPVX(sv);
4983 STRLEN len = SvLEN(sv);
4984 STRLEN cur = SvCUR(sv);
4985 U32 hash = SvUVX(sv);
4986 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4988 PerlIO_printf(Perl_debug_log,
4989 "Copy on write: Force normal %ld\n",
4995 /* This SV doesn't own the buffer, so need to New() a new one: */
4998 if (flags & SV_COW_DROP_PV) {
4999 /* OK, so we don't need to copy our buffer. */
5002 SvGROW(sv, cur + 1);
5003 Move(pvx,SvPVX(sv),cur,char);
5007 sv_release_COW(sv, pvx, cur, len, hash, next);
5012 else if (IN_PERL_RUNTIME)
5013 Perl_croak(aTHX_ PL_no_modify);
5014 /* At this point I believe that I can drop the global SV mutex. */
5017 if (SvREADONLY(sv)) {
5019 char *pvx = SvPVX(sv);
5020 int is_utf8 = SvUTF8(sv);
5021 STRLEN len = SvCUR(sv);
5022 U32 hash = SvUVX(sv);
5027 SvGROW(sv, len + 1);
5028 Move(pvx,SvPVX(sv),len,char);
5030 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5032 else if (IN_PERL_RUNTIME)
5033 Perl_croak(aTHX_ PL_no_modify);
5037 sv_unref_flags(sv, flags);
5038 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5043 =for apidoc sv_force_normal
5045 Undo various types of fakery on an SV: if the PV is a shared string, make
5046 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5047 an xpvmg. See also C<sv_force_normal_flags>.
5053 Perl_sv_force_normal(pTHX_ register SV *sv)
5055 sv_force_normal_flags(sv, 0);
5061 Efficient removal of characters from the beginning of the string buffer.
5062 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5063 the string buffer. The C<ptr> becomes the first character of the adjusted
5064 string. Uses the "OOK hack".
5065 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5066 refer to the same chunk of data.
5072 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5074 register STRLEN delta;
5075 if (!ptr || !SvPOKp(sv))
5077 delta = ptr - SvPVX(sv);
5078 SV_CHECK_THINKFIRST(sv);
5079 if (SvTYPE(sv) < SVt_PVIV)
5080 sv_upgrade(sv,SVt_PVIV);
5083 if (!SvLEN(sv)) { /* make copy of shared string */
5084 char *pvx = SvPVX(sv);
5085 STRLEN len = SvCUR(sv);
5086 SvGROW(sv, len + 1);
5087 Move(pvx,SvPVX(sv),len,char);
5091 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5092 and we do that anyway inside the SvNIOK_off
5094 SvFLAGS(sv) |= SVf_OOK;
5103 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5104 * this function provided for binary compatibility only
5108 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5110 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5114 =for apidoc sv_catpvn
5116 Concatenates the string onto the end of the string which is in the SV. The
5117 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5118 status set, then the bytes appended should be valid UTF-8.
5119 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5121 =for apidoc sv_catpvn_flags
5123 Concatenates the string onto the end of the string which is in the SV. The
5124 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5125 status set, then the bytes appended should be valid UTF-8.
5126 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5127 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5128 in terms of this function.
5134 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5139 dstr = SvPV_force_flags(dsv, dlen, flags);
5140 SvGROW(dsv, dlen + slen + 1);
5143 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5146 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5151 =for apidoc sv_catpvn_mg
5153 Like C<sv_catpvn>, but also handles 'set' magic.
5159 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5161 sv_catpvn(sv,ptr,len);
5165 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5166 * this function provided for binary compatibility only
5170 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5172 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5176 =for apidoc sv_catsv
5178 Concatenates the string from SV C<ssv> onto the end of the string in
5179 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5180 not 'set' magic. See C<sv_catsv_mg>.
5182 =for apidoc sv_catsv_flags
5184 Concatenates the string from SV C<ssv> onto the end of the string in
5185 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5186 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5187 and C<sv_catsv_nomg> are implemented in terms of this function.
5192 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5198 if ((spv = SvPV(ssv, slen))) {
5199 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5200 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5201 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5202 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5203 dsv->sv_flags doesn't have that bit set.
5204 Andy Dougherty 12 Oct 2001
5206 I32 sutf8 = DO_UTF8(ssv);
5209 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5211 dutf8 = DO_UTF8(dsv);
5213 if (dutf8 != sutf8) {
5215 /* Not modifying source SV, so taking a temporary copy. */
5216 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5218 sv_utf8_upgrade(csv);
5219 spv = SvPV(csv, slen);
5222 sv_utf8_upgrade_nomg(dsv);
5224 sv_catpvn_nomg(dsv, spv, slen);
5229 =for apidoc sv_catsv_mg
5231 Like C<sv_catsv>, but also handles 'set' magic.
5237 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5244 =for apidoc sv_catpv
5246 Concatenates the string onto the end of the string which is in the SV.
5247 If the SV has the UTF-8 status set, then the bytes appended should be
5248 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5253 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5255 register STRLEN len;
5261 junk = SvPV_force(sv, tlen);
5263 SvGROW(sv, tlen + len + 1);
5266 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5268 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5273 =for apidoc sv_catpv_mg
5275 Like C<sv_catpv>, but also handles 'set' magic.
5281 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5290 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5291 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5298 Perl_newSV(pTHX_ STRLEN len)
5304 sv_upgrade(sv, SVt_PV);
5305 SvGROW(sv, len + 1);
5310 =for apidoc sv_magicext
5312 Adds magic to an SV, upgrading it if necessary. Applies the
5313 supplied vtable and returns pointer to the magic added.
5315 Note that sv_magicext will allow things that sv_magic will not.
5316 In particular you can add magic to SvREADONLY SVs and and more than
5317 one instance of the same 'how'
5319 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
5320 if C<namelen> is zero then C<name> is stored as-is and - as another special
5321 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
5322 an C<SV*> and has its REFCNT incremented
5324 (This is now used as a subroutine by sv_magic.)
5329 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5330 const char* name, I32 namlen)
5334 if (SvTYPE(sv) < SVt_PVMG) {
5335 (void)SvUPGRADE(sv, SVt_PVMG);
5337 Newz(702,mg, 1, MAGIC);
5338 mg->mg_moremagic = SvMAGIC(sv);
5341 /* Some magic sontains a reference loop, where the sv and object refer to
5342 each other. To prevent a reference loop that would prevent such
5343 objects being freed, we look for such loops and if we find one we
5344 avoid incrementing the object refcount.
5346 Note we cannot do this to avoid self-tie loops as intervening RV must
5347 have its REFCNT incremented to keep it in existence.
5350 if (!obj || obj == sv ||
5351 how == PERL_MAGIC_arylen ||
5352 how == PERL_MAGIC_qr ||
5353 (SvTYPE(obj) == SVt_PVGV &&
5354 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5355 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5356 GvFORM(obj) == (CV*)sv)))
5361 mg->mg_obj = SvREFCNT_inc(obj);
5362 mg->mg_flags |= MGf_REFCOUNTED;
5365 /* Normal self-ties simply pass a null object, and instead of
5366 using mg_obj directly, use the SvTIED_obj macro to produce a
5367 new RV as needed. For glob "self-ties", we are tieing the PVIO
5368 with an RV obj pointing to the glob containing the PVIO. In
5369 this case, to avoid a reference loop, we need to weaken the
5373 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5374 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5380 mg->mg_len = namlen;
5383 mg->mg_ptr = savepvn(name, namlen);
5384 else if (namlen == HEf_SVKEY)
5385 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5387 mg->mg_ptr = (char *) name;
5389 mg->mg_virtual = vtable;
5393 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5398 =for apidoc sv_magic
5400 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5401 then adds a new magic item of type C<how> to the head of the magic list.
5407 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5412 #ifdef PERL_COPY_ON_WRITE
5414 sv_force_normal_flags(sv, 0);
5416 if (SvREADONLY(sv)) {
5418 && how != PERL_MAGIC_regex_global
5419 && how != PERL_MAGIC_bm
5420 && how != PERL_MAGIC_fm
5421 && how != PERL_MAGIC_sv
5422 && how != PERL_MAGIC_backref
5425 Perl_croak(aTHX_ PL_no_modify);
5428 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5429 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5430 /* sv_magic() refuses to add a magic of the same 'how' as an
5433 if (how == PERL_MAGIC_taint)
5441 vtable = &PL_vtbl_sv;
5443 case PERL_MAGIC_overload:
5444 vtable = &PL_vtbl_amagic;
5446 case PERL_MAGIC_overload_elem:
5447 vtable = &PL_vtbl_amagicelem;
5449 case PERL_MAGIC_overload_table:
5450 vtable = &PL_vtbl_ovrld;
5453 vtable = &PL_vtbl_bm;
5455 case PERL_MAGIC_regdata:
5456 vtable = &PL_vtbl_regdata;
5458 case PERL_MAGIC_regdatum:
5459 vtable = &PL_vtbl_regdatum;
5461 case PERL_MAGIC_env:
5462 vtable = &PL_vtbl_env;
5465 vtable = &PL_vtbl_fm;
5467 case PERL_MAGIC_envelem:
5468 vtable = &PL_vtbl_envelem;
5470 case PERL_MAGIC_regex_global:
5471 vtable = &PL_vtbl_mglob;
5473 case PERL_MAGIC_isa:
5474 vtable = &PL_vtbl_isa;
5476 case PERL_MAGIC_isaelem:
5477 vtable = &PL_vtbl_isaelem;
5479 case PERL_MAGIC_nkeys:
5480 vtable = &PL_vtbl_nkeys;
5482 case PERL_MAGIC_dbfile:
5485 case PERL_MAGIC_dbline:
5486 vtable = &PL_vtbl_dbline;
5488 #ifdef USE_LOCALE_COLLATE
5489 case PERL_MAGIC_collxfrm:
5490 vtable = &PL_vtbl_collxfrm;
5492 #endif /* USE_LOCALE_COLLATE */
5493 case PERL_MAGIC_tied:
5494 vtable = &PL_vtbl_pack;
5496 case PERL_MAGIC_tiedelem:
5497 case PERL_MAGIC_tiedscalar:
5498 vtable = &PL_vtbl_packelem;
5501 vtable = &PL_vtbl_regexp;
5503 case PERL_MAGIC_sig:
5504 vtable = &PL_vtbl_sig;
5506 case PERL_MAGIC_sigelem:
5507 vtable = &PL_vtbl_sigelem;
5509 case PERL_MAGIC_taint:
5510 vtable = &PL_vtbl_taint;
5512 case PERL_MAGIC_uvar:
5513 vtable = &PL_vtbl_uvar;
5515 case PERL_MAGIC_vec:
5516 vtable = &PL_vtbl_vec;
5518 case PERL_MAGIC_vstring:
5521 case PERL_MAGIC_utf8:
5522 vtable = &PL_vtbl_utf8;
5524 case PERL_MAGIC_substr:
5525 vtable = &PL_vtbl_substr;
5527 case PERL_MAGIC_defelem:
5528 vtable = &PL_vtbl_defelem;
5530 case PERL_MAGIC_glob:
5531 vtable = &PL_vtbl_glob;
5533 case PERL_MAGIC_arylen:
5534 vtable = &PL_vtbl_arylen;
5536 case PERL_MAGIC_pos:
5537 vtable = &PL_vtbl_pos;
5539 case PERL_MAGIC_backref:
5540 vtable = &PL_vtbl_backref;
5542 case PERL_MAGIC_ext:
5543 /* Reserved for use by extensions not perl internals. */
5544 /* Useful for attaching extension internal data to perl vars. */
5545 /* Note that multiple extensions may clash if magical scalars */
5546 /* etc holding private data from one are passed to another. */
5549 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5552 /* Rest of work is done else where */
5553 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5556 case PERL_MAGIC_taint:
5559 case PERL_MAGIC_ext:
5560 case PERL_MAGIC_dbfile:
5567 =for apidoc sv_unmagic
5569 Removes all magic of type C<type> from an SV.
5575 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5579 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5582 for (mg = *mgp; mg; mg = *mgp) {
5583 if (mg->mg_type == type) {
5584 MGVTBL* vtbl = mg->mg_virtual;
5585 *mgp = mg->mg_moremagic;
5586 if (vtbl && vtbl->svt_free)
5587 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5588 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5590 Safefree(mg->mg_ptr);
5591 else if (mg->mg_len == HEf_SVKEY)
5592 SvREFCNT_dec((SV*)mg->mg_ptr);
5593 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5594 Safefree(mg->mg_ptr);
5596 if (mg->mg_flags & MGf_REFCOUNTED)
5597 SvREFCNT_dec(mg->mg_obj);
5601 mgp = &mg->mg_moremagic;
5605 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5612 =for apidoc sv_rvweaken
5614 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5615 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5616 push a back-reference to this RV onto the array of backreferences
5617 associated with that magic.
5623 Perl_sv_rvweaken(pTHX_ SV *sv)
5626 if (!SvOK(sv)) /* let undefs pass */
5629 Perl_croak(aTHX_ "Can't weaken a nonreference");
5630 else if (SvWEAKREF(sv)) {
5631 if (ckWARN(WARN_MISC))
5632 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5636 sv_add_backref(tsv, sv);
5642 /* Give tsv backref magic if it hasn't already got it, then push a
5643 * back-reference to sv onto the array associated with the backref magic.
5647 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5651 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5652 av = (AV*)mg->mg_obj;
5655 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5656 /* av now has a refcnt of 2, which avoids it getting freed
5657 * before us during global cleanup. The extra ref is removed
5658 * by magic_killbackrefs() when tsv is being freed */
5660 if (AvFILLp(av) >= AvMAX(av)) {
5662 SV **svp = AvARRAY(av);
5663 for (i = AvFILLp(av); i >= 0; i--)
5665 svp[i] = sv; /* reuse the slot */
5668 av_extend(av, AvFILLp(av)+1);
5670 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5673 /* delete a back-reference to ourselves from the backref magic associated
5674 * with the SV we point to.
5678 S_sv_del_backref(pTHX_ SV *sv)
5685 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5686 Perl_croak(aTHX_ "panic: del_backref");
5687 av = (AV *)mg->mg_obj;
5689 for (i = AvFILLp(av); i >= 0; i--)
5690 if (svp[i] == sv) svp[i] = Nullsv;
5694 =for apidoc sv_insert
5696 Inserts a string at the specified offset/length within the SV. Similar to
5697 the Perl substr() function.
5703 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5707 register char *midend;
5708 register char *bigend;
5714 Perl_croak(aTHX_ "Can't modify non-existent substring");
5715 SvPV_force(bigstr, curlen);
5716 (void)SvPOK_only_UTF8(bigstr);
5717 if (offset + len > curlen) {
5718 SvGROW(bigstr, offset+len+1);
5719 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5720 SvCUR_set(bigstr, offset+len);
5724 i = littlelen - len;
5725 if (i > 0) { /* string might grow */
5726 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5727 mid = big + offset + len;
5728 midend = bigend = big + SvCUR(bigstr);
5731 while (midend > mid) /* shove everything down */
5732 *--bigend = *--midend;
5733 Move(little,big+offset,littlelen,char);
5739 Move(little,SvPVX(bigstr)+offset,len,char);
5744 big = SvPVX(bigstr);
5747 bigend = big + SvCUR(bigstr);
5749 if (midend > bigend)
5750 Perl_croak(aTHX_ "panic: sv_insert");
5752 if (mid - big > bigend - midend) { /* faster to shorten from end */
5754 Move(little, mid, littlelen,char);
5757 i = bigend - midend;
5759 Move(midend, mid, i,char);
5763 SvCUR_set(bigstr, mid - big);
5766 else if ((i = mid - big)) { /* faster from front */
5767 midend -= littlelen;
5769 sv_chop(bigstr,midend-i);
5774 Move(little, mid, littlelen,char);
5776 else if (littlelen) {
5777 midend -= littlelen;
5778 sv_chop(bigstr,midend);
5779 Move(little,midend,littlelen,char);
5782 sv_chop(bigstr,midend);
5788 =for apidoc sv_replace
5790 Make the first argument a copy of the second, then delete the original.
5791 The target SV physically takes over ownership of the body of the source SV
5792 and inherits its flags; however, the target keeps any magic it owns,
5793 and any magic in the source is discarded.
5794 Note that this is a rather specialist SV copying operation; most of the
5795 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5801 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5803 U32 refcnt = SvREFCNT(sv);
5804 SV_CHECK_THINKFIRST_COW_DROP(sv);
5805 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5806 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5807 if (SvMAGICAL(sv)) {
5811 sv_upgrade(nsv, SVt_PVMG);
5812 SvMAGIC(nsv) = SvMAGIC(sv);
5813 SvFLAGS(nsv) |= SvMAGICAL(sv);
5819 assert(!SvREFCNT(sv));
5820 StructCopy(nsv,sv,SV);
5821 #ifdef PERL_COPY_ON_WRITE
5822 if (SvIsCOW_normal(nsv)) {
5823 /* We need to follow the pointers around the loop to make the
5824 previous SV point to sv, rather than nsv. */
5827 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5830 assert(SvPVX(current) == SvPVX(nsv));
5832 /* Make the SV before us point to the SV after us. */
5834 PerlIO_printf(Perl_debug_log, "previous is\n");
5836 PerlIO_printf(Perl_debug_log,
5837 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5838 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5840 SV_COW_NEXT_SV_SET(current, sv);
5843 SvREFCNT(sv) = refcnt;
5844 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5850 =for apidoc sv_clear
5852 Clear an SV: call any destructors, free up any memory used by the body,
5853 and free the body itself. The SV's head is I<not> freed, although
5854 its type is set to all 1's so that it won't inadvertently be assumed
5855 to be live during global destruction etc.
5856 This function should only be called when REFCNT is zero. Most of the time
5857 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5864 Perl_sv_clear(pTHX_ register SV *sv)
5868 assert(SvREFCNT(sv) == 0);
5871 if (PL_defstash) { /* Still have a symbol table? */
5878 stash = SvSTASH(sv);
5879 destructor = StashHANDLER(stash,DESTROY);
5881 SV* tmpref = newRV(sv);
5882 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5884 PUSHSTACKi(PERLSI_DESTROY);
5889 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5895 if(SvREFCNT(tmpref) < 2) {
5896 /* tmpref is not kept alive! */
5901 SvREFCNT_dec(tmpref);
5903 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5907 if (PL_in_clean_objs)
5908 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5910 /* DESTROY gave object new lease on life */
5916 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5917 SvOBJECT_off(sv); /* Curse the object. */
5918 if (SvTYPE(sv) != SVt_PVIO)
5919 --PL_sv_objcount; /* XXX Might want something more general */
5922 if (SvTYPE(sv) >= SVt_PVMG) {
5925 if (SvFLAGS(sv) & SVpad_TYPED)
5926 SvREFCNT_dec(SvSTASH(sv));
5929 switch (SvTYPE(sv)) {
5932 IoIFP(sv) != PerlIO_stdin() &&
5933 IoIFP(sv) != PerlIO_stdout() &&
5934 IoIFP(sv) != PerlIO_stderr())
5936 io_close((IO*)sv, FALSE);
5938 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5939 PerlDir_close(IoDIRP(sv));
5940 IoDIRP(sv) = (DIR*)NULL;
5941 Safefree(IoTOP_NAME(sv));
5942 Safefree(IoFMT_NAME(sv));
5943 Safefree(IoBOTTOM_NAME(sv));
5958 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5959 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5960 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5961 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5963 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5964 SvREFCNT_dec(LvTARG(sv));
5968 Safefree(GvNAME(sv));
5969 /* cannot decrease stash refcount yet, as we might recursively delete
5970 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5971 of stash until current sv is completely gone.
5972 -- JohnPC, 27 Mar 1998 */
5973 stash = GvSTASH(sv);
5987 SvREFCNT_dec(SvRV(sv));
5989 #ifdef PERL_COPY_ON_WRITE
5990 else if (SvPVX(sv)) {
5992 /* I believe I need to grab the global SV mutex here and
5993 then recheck the COW status. */
5995 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5998 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5999 SvUVX(sv), SV_COW_NEXT_SV(sv));
6000 /* And drop it here. */
6002 } else if (SvLEN(sv)) {
6003 Safefree(SvPVX(sv));
6007 else if (SvPVX(sv) && SvLEN(sv))
6008 Safefree(SvPVX(sv));
6009 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6010 unsharepvn(SvPVX(sv),
6011 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6025 switch (SvTYPE(sv)) {
6041 del_XPVIV(SvANY(sv));
6044 del_XPVNV(SvANY(sv));
6047 del_XPVMG(SvANY(sv));
6050 del_XPVLV(SvANY(sv));
6053 del_XPVAV(SvANY(sv));
6056 del_XPVHV(SvANY(sv));
6059 del_XPVCV(SvANY(sv));
6062 del_XPVGV(SvANY(sv));
6063 /* code duplication for increased performance. */
6064 SvFLAGS(sv) &= SVf_BREAK;
6065 SvFLAGS(sv) |= SVTYPEMASK;
6066 /* decrease refcount of the stash that owns this GV, if any */
6068 SvREFCNT_dec(stash);
6069 return; /* not break, SvFLAGS reset already happened */
6071 del_XPVBM(SvANY(sv));
6074 del_XPVFM(SvANY(sv));
6077 del_XPVIO(SvANY(sv));
6080 SvFLAGS(sv) &= SVf_BREAK;
6081 SvFLAGS(sv) |= SVTYPEMASK;
6085 =for apidoc sv_newref
6087 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6094 Perl_sv_newref(pTHX_ SV *sv)
6104 Decrement an SV's reference count, and if it drops to zero, call
6105 C<sv_clear> to invoke destructors and free up any memory used by
6106 the body; finally, deallocate the SV's head itself.
6107 Normally called via a wrapper macro C<SvREFCNT_dec>.
6113 Perl_sv_free(pTHX_ SV *sv)
6117 if (SvREFCNT(sv) == 0) {
6118 if (SvFLAGS(sv) & SVf_BREAK)
6119 /* this SV's refcnt has been artificially decremented to
6120 * trigger cleanup */
6122 if (PL_in_clean_all) /* All is fair */
6124 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6125 /* make sure SvREFCNT(sv)==0 happens very seldom */
6126 SvREFCNT(sv) = (~(U32)0)/2;
6129 if (ckWARN_d(WARN_INTERNAL))
6130 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6131 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6132 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6135 if (--(SvREFCNT(sv)) > 0)
6137 Perl_sv_free2(aTHX_ sv);
6141 Perl_sv_free2(pTHX_ SV *sv)
6145 if (ckWARN_d(WARN_DEBUGGING))
6146 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6147 "Attempt to free temp prematurely: SV 0x%"UVxf
6148 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6152 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6153 /* make sure SvREFCNT(sv)==0 happens very seldom */
6154 SvREFCNT(sv) = (~(U32)0)/2;
6165 Returns the length of the string in the SV. Handles magic and type
6166 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6172 Perl_sv_len(pTHX_ register SV *sv)
6180 len = mg_length(sv);
6182 (void)SvPV(sv, len);
6187 =for apidoc sv_len_utf8
6189 Returns the number of characters in the string in an SV, counting wide
6190 UTF-8 bytes as a single character. Handles magic and type coercion.
6196 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6197 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6198 * (Note that the mg_len is not the length of the mg_ptr field.)
6203 Perl_sv_len_utf8(pTHX_ register SV *sv)
6209 return mg_length(sv);
6213 U8 *s = (U8*)SvPV(sv, len);
6214 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6216 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6218 #ifdef PERL_UTF8_CACHE_ASSERT
6219 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6223 ulen = Perl_utf8_length(aTHX_ s, s + len);
6224 if (!mg && !SvREADONLY(sv)) {
6225 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6226 mg = mg_find(sv, PERL_MAGIC_utf8);
6236 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6237 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6238 * between UTF-8 and byte offsets. There are two (substr offset and substr
6239 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6240 * and byte offset) cache positions.
6242 * The mg_len field is used by sv_len_utf8(), see its comments.
6243 * Note that the mg_len is not the length of the mg_ptr field.
6247 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6251 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6253 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6257 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6259 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6260 (*mgp)->mg_ptr = (char *) *cachep;
6264 (*cachep)[i] = *offsetp;
6265 (*cachep)[i+1] = s - start;
6273 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6274 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6275 * between UTF-8 and byte offsets. See also the comments of
6276 * S_utf8_mg_pos_init().
6280 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6284 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6286 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6287 if (*mgp && (*mgp)->mg_ptr) {
6288 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6289 ASSERT_UTF8_CACHE(*cachep);
6290 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6292 else { /* We will skip to the right spot. */
6297 /* The assumption is that going backward is half
6298 * the speed of going forward (that's where the
6299 * 2 * backw in the below comes from). (The real
6300 * figure of course depends on the UTF-8 data.) */
6302 if ((*cachep)[i] > (STRLEN)uoff) {
6304 backw = (*cachep)[i] - (STRLEN)uoff;
6306 if (forw < 2 * backw)
6309 p = start + (*cachep)[i+1];
6311 /* Try this only for the substr offset (i == 0),
6312 * not for the substr length (i == 2). */
6313 else if (i == 0) { /* (*cachep)[i] < uoff */
6314 STRLEN ulen = sv_len_utf8(sv);
6316 if ((STRLEN)uoff < ulen) {
6317 forw = (STRLEN)uoff - (*cachep)[i];
6318 backw = ulen - (STRLEN)uoff;
6320 if (forw < 2 * backw)
6321 p = start + (*cachep)[i+1];
6326 /* If the string is not long enough for uoff,
6327 * we could extend it, but not at this low a level. */
6331 if (forw < 2 * backw) {
6338 while (UTF8_IS_CONTINUATION(*p))
6343 /* Update the cache. */
6344 (*cachep)[i] = (STRLEN)uoff;
6345 (*cachep)[i+1] = p - start;
6347 /* Drop the stale "length" cache */
6356 if (found) { /* Setup the return values. */
6357 *offsetp = (*cachep)[i+1];
6358 *sp = start + *offsetp;
6361 *offsetp = send - start;
6363 else if (*sp < start) {
6369 #ifdef PERL_UTF8_CACHE_ASSERT
6374 while (n-- && s < send)
6378 assert(*offsetp == s - start);
6379 assert((*cachep)[0] == (STRLEN)uoff);
6380 assert((*cachep)[1] == *offsetp);
6382 ASSERT_UTF8_CACHE(*cachep);
6391 =for apidoc sv_pos_u2b
6393 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6394 the start of the string, to a count of the equivalent number of bytes; if
6395 lenp is non-zero, it does the same to lenp, but this time starting from
6396 the offset, rather than from the start of the string. Handles magic and
6403 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6404 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6405 * byte offsets. See also the comments of S_utf8_mg_pos().
6410 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6421 start = s = (U8*)SvPV(sv, len);
6423 I32 uoffset = *offsetp;
6428 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6430 if (!found && uoffset > 0) {
6431 while (s < send && uoffset--)
6435 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6437 *offsetp = s - start;
6442 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6446 if (!found && *lenp > 0) {
6449 while (s < send && ulen--)
6453 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6457 ASSERT_UTF8_CACHE(cache);
6469 =for apidoc sv_pos_b2u
6471 Converts the value pointed to by offsetp from a count of bytes from the
6472 start of the string, to a count of the equivalent number of UTF-8 chars.
6473 Handles magic and type coercion.
6479 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6480 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6481 * byte offsets. See also the comments of S_utf8_mg_pos().
6486 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6494 s = (U8*)SvPV(sv, len);
6495 if ((I32)len < *offsetp)
6496 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6498 U8* send = s + *offsetp;
6500 STRLEN *cache = NULL;
6504 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6505 mg = mg_find(sv, PERL_MAGIC_utf8);
6506 if (mg && mg->mg_ptr) {
6507 cache = (STRLEN *) mg->mg_ptr;
6508 if (cache[1] == (STRLEN)*offsetp) {
6509 /* An exact match. */
6510 *offsetp = cache[0];
6514 else if (cache[1] < (STRLEN)*offsetp) {
6515 /* We already know part of the way. */
6518 /* Let the below loop do the rest. */
6520 else { /* cache[1] > *offsetp */
6521 /* We already know all of the way, now we may
6522 * be able to walk back. The same assumption
6523 * is made as in S_utf8_mg_pos(), namely that
6524 * walking backward is twice slower than
6525 * walking forward. */
6526 STRLEN forw = *offsetp;
6527 STRLEN backw = cache[1] - *offsetp;
6529 if (!(forw < 2 * backw)) {
6530 U8 *p = s + cache[1];
6537 while (UTF8_IS_CONTINUATION(*p)) {
6545 *offsetp = cache[0];
6547 /* Drop the stale "length" cache */
6555 ASSERT_UTF8_CACHE(cache);
6561 /* Call utf8n_to_uvchr() to validate the sequence
6562 * (unless a simple non-UTF character) */
6563 if (!UTF8_IS_INVARIANT(*s))
6564 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6573 if (!SvREADONLY(sv)) {
6575 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6576 mg = mg_find(sv, PERL_MAGIC_utf8);
6581 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6582 mg->mg_ptr = (char *) cache;
6587 cache[1] = *offsetp;
6588 /* Drop the stale "length" cache */
6601 Returns a boolean indicating whether the strings in the two SVs are
6602 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6603 coerce its args to strings if necessary.
6609 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6617 SV* svrecode = Nullsv;
6624 pv1 = SvPV(sv1, cur1);
6631 pv2 = SvPV(sv2, cur2);
6633 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6634 /* Differing utf8ness.
6635 * Do not UTF8size the comparands as a side-effect. */
6638 svrecode = newSVpvn(pv2, cur2);
6639 sv_recode_to_utf8(svrecode, PL_encoding);
6640 pv2 = SvPV(svrecode, cur2);
6643 svrecode = newSVpvn(pv1, cur1);
6644 sv_recode_to_utf8(svrecode, PL_encoding);
6645 pv1 = SvPV(svrecode, cur1);
6647 /* Now both are in UTF-8. */
6649 SvREFCNT_dec(svrecode);
6654 bool is_utf8 = TRUE;
6657 /* sv1 is the UTF-8 one,
6658 * if is equal it must be downgrade-able */
6659 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6665 /* sv2 is the UTF-8 one,
6666 * if is equal it must be downgrade-able */
6667 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6673 /* Downgrade not possible - cannot be eq */
6681 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6684 SvREFCNT_dec(svrecode);
6695 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6696 string in C<sv1> is less than, equal to, or greater than the string in
6697 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6698 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6704 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6707 char *pv1, *pv2, *tpv = Nullch;
6709 SV *svrecode = Nullsv;
6716 pv1 = SvPV(sv1, cur1);
6723 pv2 = SvPV(sv2, cur2);
6725 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6726 /* Differing utf8ness.
6727 * Do not UTF8size the comparands as a side-effect. */
6730 svrecode = newSVpvn(pv2, cur2);
6731 sv_recode_to_utf8(svrecode, PL_encoding);
6732 pv2 = SvPV(svrecode, cur2);
6735 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6740 svrecode = newSVpvn(pv1, cur1);
6741 sv_recode_to_utf8(svrecode, PL_encoding);
6742 pv1 = SvPV(svrecode, cur1);
6745 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6751 cmp = cur2 ? -1 : 0;
6755 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6758 cmp = retval < 0 ? -1 : 1;
6759 } else if (cur1 == cur2) {
6762 cmp = cur1 < cur2 ? -1 : 1;
6767 SvREFCNT_dec(svrecode);
6776 =for apidoc sv_cmp_locale
6778 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6779 'use bytes' aware, handles get magic, and will coerce its args to strings
6780 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6786 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6788 #ifdef USE_LOCALE_COLLATE
6794 if (PL_collation_standard)
6798 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6800 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6802 if (!pv1 || !len1) {
6813 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6816 return retval < 0 ? -1 : 1;
6819 * When the result of collation is equality, that doesn't mean
6820 * that there are no differences -- some locales exclude some
6821 * characters from consideration. So to avoid false equalities,
6822 * we use the raw string as a tiebreaker.
6828 #endif /* USE_LOCALE_COLLATE */
6830 return sv_cmp(sv1, sv2);
6834 #ifdef USE_LOCALE_COLLATE
6837 =for apidoc sv_collxfrm
6839 Add Collate Transform magic to an SV if it doesn't already have it.
6841 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6842 scalar data of the variable, but transformed to such a format that a normal
6843 memory comparison can be used to compare the data according to the locale
6850 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6854 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6855 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6860 Safefree(mg->mg_ptr);
6862 if ((xf = mem_collxfrm(s, len, &xlen))) {
6863 if (SvREADONLY(sv)) {
6866 return xf + sizeof(PL_collation_ix);
6869 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6870 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6883 if (mg && mg->mg_ptr) {
6885 return mg->mg_ptr + sizeof(PL_collation_ix);
6893 #endif /* USE_LOCALE_COLLATE */
6898 Get a line from the filehandle and store it into the SV, optionally
6899 appending to the currently-stored string.
6905 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6909 register STDCHAR rslast;
6910 register STDCHAR *bp;
6916 if (SvTHINKFIRST(sv))
6917 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6918 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6920 However, perlbench says it's slower, because the existing swipe code
6921 is faster than copy on write.
6922 Swings and roundabouts. */
6923 (void)SvUPGRADE(sv, SVt_PV);
6928 if (PerlIO_isutf8(fp)) {
6930 sv_utf8_upgrade_nomg(sv);
6931 sv_pos_u2b(sv,&append,0);
6933 } else if (SvUTF8(sv)) {
6934 SV *tsv = NEWSV(0,0);
6935 sv_gets(tsv, fp, 0);
6936 sv_utf8_upgrade_nomg(tsv);
6937 SvCUR_set(sv,append);
6940 goto return_string_or_null;
6945 if (PerlIO_isutf8(fp))
6948 if (IN_PERL_COMPILETIME) {
6949 /* we always read code in line mode */
6953 else if (RsSNARF(PL_rs)) {
6954 /* If it is a regular disk file use size from stat() as estimate
6955 of amount we are going to read - may result in malloc-ing
6956 more memory than we realy need if layers bellow reduce
6957 size we read (e.g. CRLF or a gzip layer)
6960 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6961 Off_t offset = PerlIO_tell(fp);
6962 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6963 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6969 else if (RsRECORD(PL_rs)) {
6973 /* Grab the size of the record we're getting */
6974 recsize = SvIV(SvRV(PL_rs));
6975 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6978 /* VMS wants read instead of fread, because fread doesn't respect */
6979 /* RMS record boundaries. This is not necessarily a good thing to be */
6980 /* doing, but we've got no other real choice - except avoid stdio
6981 as implementation - perhaps write a :vms layer ?
6983 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6985 bytesread = PerlIO_read(fp, buffer, recsize);
6989 SvCUR_set(sv, bytesread += append);
6990 buffer[bytesread] = '\0';
6991 goto return_string_or_null;
6993 else if (RsPARA(PL_rs)) {
6999 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7000 if (PerlIO_isutf8(fp)) {
7001 rsptr = SvPVutf8(PL_rs, rslen);
7004 if (SvUTF8(PL_rs)) {
7005 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7006 Perl_croak(aTHX_ "Wide character in $/");
7009 rsptr = SvPV(PL_rs, rslen);
7013 rslast = rslen ? rsptr[rslen - 1] : '\0';
7015 if (rspara) { /* have to do this both before and after */
7016 do { /* to make sure file boundaries work right */
7019 i = PerlIO_getc(fp);
7023 PerlIO_ungetc(fp,i);
7029 /* See if we know enough about I/O mechanism to cheat it ! */
7031 /* This used to be #ifdef test - it is made run-time test for ease
7032 of abstracting out stdio interface. One call should be cheap
7033 enough here - and may even be a macro allowing compile
7037 if (PerlIO_fast_gets(fp)) {
7040 * We're going to steal some values from the stdio struct
7041 * and put EVERYTHING in the innermost loop into registers.
7043 register STDCHAR *ptr;
7047 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7048 /* An ungetc()d char is handled separately from the regular
7049 * buffer, so we getc() it back out and stuff it in the buffer.
7051 i = PerlIO_getc(fp);
7052 if (i == EOF) return 0;
7053 *(--((*fp)->_ptr)) = (unsigned char) i;
7057 /* Here is some breathtakingly efficient cheating */
7059 cnt = PerlIO_get_cnt(fp); /* get count into register */
7060 /* make sure we have the room */
7061 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7062 /* Not room for all of it
7063 if we are looking for a separator and room for some
7065 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7066 /* just process what we have room for */
7067 shortbuffered = cnt - SvLEN(sv) + append + 1;
7068 cnt -= shortbuffered;
7072 /* remember that cnt can be negative */
7073 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7078 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7079 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7080 DEBUG_P(PerlIO_printf(Perl_debug_log,
7081 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7082 DEBUG_P(PerlIO_printf(Perl_debug_log,
7083 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7084 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7085 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7090 while (cnt > 0) { /* this | eat */
7092 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7093 goto thats_all_folks; /* screams | sed :-) */
7097 Copy(ptr, bp, cnt, char); /* this | eat */
7098 bp += cnt; /* screams | dust */
7099 ptr += cnt; /* louder | sed :-) */
7104 if (shortbuffered) { /* oh well, must extend */
7105 cnt = shortbuffered;
7107 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7109 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7110 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7114 DEBUG_P(PerlIO_printf(Perl_debug_log,
7115 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7116 PTR2UV(ptr),(long)cnt));
7117 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7119 DEBUG_P(PerlIO_printf(Perl_debug_log,
7120 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7121 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7122 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7124 /* This used to call 'filbuf' in stdio form, but as that behaves like
7125 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7126 another abstraction. */
7127 i = PerlIO_getc(fp); /* get more characters */
7129 DEBUG_P(PerlIO_printf(Perl_debug_log,
7130 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7131 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7132 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7134 cnt = PerlIO_get_cnt(fp);
7135 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7136 DEBUG_P(PerlIO_printf(Perl_debug_log,
7137 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7139 if (i == EOF) /* all done for ever? */
7140 goto thats_really_all_folks;
7142 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7144 SvGROW(sv, bpx + cnt + 2);
7145 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7147 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7149 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7150 goto thats_all_folks;
7154 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7155 memNE((char*)bp - rslen, rsptr, rslen))
7156 goto screamer; /* go back to the fray */
7157 thats_really_all_folks:
7159 cnt += shortbuffered;
7160 DEBUG_P(PerlIO_printf(Perl_debug_log,
7161 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7162 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7163 DEBUG_P(PerlIO_printf(Perl_debug_log,
7164 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7165 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7166 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7168 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7169 DEBUG_P(PerlIO_printf(Perl_debug_log,
7170 "Screamer: done, len=%ld, string=|%.*s|\n",
7171 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7175 /*The big, slow, and stupid way. */
7177 /* Any stack-challenged places. */
7179 /* EPOC: need to work around SDK features. *
7180 * On WINS: MS VC5 generates calls to _chkstk, *
7181 * if a "large" stack frame is allocated. *
7182 * gcc on MARM does not generate calls like these. */
7183 # define USEHEAPINSTEADOFSTACK
7186 #ifdef USEHEAPINSTEADOFSTACK
7188 New(0, buf, 8192, STDCHAR);
7196 register STDCHAR *bpe = buf + sizeof(buf);
7198 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7199 ; /* keep reading */
7203 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7204 /* Accomodate broken VAXC compiler, which applies U8 cast to
7205 * both args of ?: operator, causing EOF to change into 255
7208 i = (U8)buf[cnt - 1];
7214 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7216 sv_catpvn(sv, (char *) buf, cnt);
7218 sv_setpvn(sv, (char *) buf, cnt);
7220 if (i != EOF && /* joy */
7222 SvCUR(sv) < rslen ||
7223 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7227 * If we're reading from a TTY and we get a short read,
7228 * indicating that the user hit his EOF character, we need
7229 * to notice it now, because if we try to read from the TTY
7230 * again, the EOF condition will disappear.
7232 * The comparison of cnt to sizeof(buf) is an optimization
7233 * that prevents unnecessary calls to feof().
7237 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7241 #ifdef USEHEAPINSTEADOFSTACK
7246 if (rspara) { /* have to do this both before and after */
7247 while (i != EOF) { /* to make sure file boundaries work right */
7248 i = PerlIO_getc(fp);
7250 PerlIO_ungetc(fp,i);
7256 return_string_or_null:
7257 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7263 Auto-increment of the value in the SV, doing string to numeric conversion
7264 if necessary. Handles 'get' magic.
7270 Perl_sv_inc(pTHX_ register SV *sv)
7279 if (SvTHINKFIRST(sv)) {
7281 sv_force_normal_flags(sv, 0);
7282 if (SvREADONLY(sv)) {
7283 if (IN_PERL_RUNTIME)
7284 Perl_croak(aTHX_ PL_no_modify);
7288 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7290 i = PTR2IV(SvRV(sv));
7295 flags = SvFLAGS(sv);
7296 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7297 /* It's (privately or publicly) a float, but not tested as an
7298 integer, so test it to see. */
7300 flags = SvFLAGS(sv);
7302 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7303 /* It's publicly an integer, or privately an integer-not-float */
7304 #ifdef PERL_PRESERVE_IVUV
7308 if (SvUVX(sv) == UV_MAX)
7309 sv_setnv(sv, UV_MAX_P1);
7311 (void)SvIOK_only_UV(sv);
7314 if (SvIVX(sv) == IV_MAX)
7315 sv_setuv(sv, (UV)IV_MAX + 1);
7317 (void)SvIOK_only(sv);
7323 if (flags & SVp_NOK) {
7324 (void)SvNOK_only(sv);
7329 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7330 if ((flags & SVTYPEMASK) < SVt_PVIV)
7331 sv_upgrade(sv, SVt_IV);
7332 (void)SvIOK_only(sv);
7337 while (isALPHA(*d)) d++;
7338 while (isDIGIT(*d)) d++;
7340 #ifdef PERL_PRESERVE_IVUV
7341 /* Got to punt this as an integer if needs be, but we don't issue
7342 warnings. Probably ought to make the sv_iv_please() that does
7343 the conversion if possible, and silently. */
7344 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7345 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7346 /* Need to try really hard to see if it's an integer.
7347 9.22337203685478e+18 is an integer.
7348 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7349 so $a="9.22337203685478e+18"; $a+0; $a++
7350 needs to be the same as $a="9.22337203685478e+18"; $a++
7357 /* sv_2iv *should* have made this an NV */
7358 if (flags & SVp_NOK) {
7359 (void)SvNOK_only(sv);
7363 /* I don't think we can get here. Maybe I should assert this
7364 And if we do get here I suspect that sv_setnv will croak. NWC
7366 #if defined(USE_LONG_DOUBLE)
7367 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",
7368 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7370 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7371 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7374 #endif /* PERL_PRESERVE_IVUV */
7375 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7379 while (d >= SvPVX(sv)) {
7387 /* MKS: The original code here died if letters weren't consecutive.
7388 * at least it didn't have to worry about non-C locales. The
7389 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7390 * arranged in order (although not consecutively) and that only
7391 * [A-Za-z] are accepted by isALPHA in the C locale.
7393 if (*d != 'z' && *d != 'Z') {
7394 do { ++*d; } while (!isALPHA(*d));
7397 *(d--) -= 'z' - 'a';
7402 *(d--) -= 'z' - 'a' + 1;
7406 /* oh,oh, the number grew */
7407 SvGROW(sv, SvCUR(sv) + 2);
7409 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7420 Auto-decrement of the value in the SV, doing string to numeric conversion
7421 if necessary. Handles 'get' magic.
7427 Perl_sv_dec(pTHX_ register SV *sv)
7435 if (SvTHINKFIRST(sv)) {
7437 sv_force_normal_flags(sv, 0);
7438 if (SvREADONLY(sv)) {
7439 if (IN_PERL_RUNTIME)
7440 Perl_croak(aTHX_ PL_no_modify);
7444 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7446 i = PTR2IV(SvRV(sv));
7451 /* Unlike sv_inc we don't have to worry about string-never-numbers
7452 and keeping them magic. But we mustn't warn on punting */
7453 flags = SvFLAGS(sv);
7454 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7455 /* It's publicly an integer, or privately an integer-not-float */
7456 #ifdef PERL_PRESERVE_IVUV
7460 if (SvUVX(sv) == 0) {
7461 (void)SvIOK_only(sv);
7465 (void)SvIOK_only_UV(sv);
7469 if (SvIVX(sv) == IV_MIN)
7470 sv_setnv(sv, (NV)IV_MIN - 1.0);
7472 (void)SvIOK_only(sv);
7478 if (flags & SVp_NOK) {
7480 (void)SvNOK_only(sv);
7483 if (!(flags & SVp_POK)) {
7484 if ((flags & SVTYPEMASK) < SVt_PVNV)
7485 sv_upgrade(sv, SVt_NV);
7487 (void)SvNOK_only(sv);
7490 #ifdef PERL_PRESERVE_IVUV
7492 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7493 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7494 /* Need to try really hard to see if it's an integer.
7495 9.22337203685478e+18 is an integer.
7496 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7497 so $a="9.22337203685478e+18"; $a+0; $a--
7498 needs to be the same as $a="9.22337203685478e+18"; $a--
7505 /* sv_2iv *should* have made this an NV */
7506 if (flags & SVp_NOK) {
7507 (void)SvNOK_only(sv);
7511 /* I don't think we can get here. Maybe I should assert this
7512 And if we do get here I suspect that sv_setnv will croak. NWC
7514 #if defined(USE_LONG_DOUBLE)
7515 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",
7516 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7518 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7519 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7523 #endif /* PERL_PRESERVE_IVUV */
7524 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7528 =for apidoc sv_mortalcopy
7530 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7531 The new SV is marked as mortal. It will be destroyed "soon", either by an
7532 explicit call to FREETMPS, or by an implicit call at places such as
7533 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7538 /* Make a string that will exist for the duration of the expression
7539 * evaluation. Actually, it may have to last longer than that, but
7540 * hopefully we won't free it until it has been assigned to a
7541 * permanent location. */
7544 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7549 sv_setsv(sv,oldstr);
7551 PL_tmps_stack[++PL_tmps_ix] = sv;
7557 =for apidoc sv_newmortal
7559 Creates a new null SV which is mortal. The reference count of the SV is
7560 set to 1. It will be destroyed "soon", either by an explicit call to
7561 FREETMPS, or by an implicit call at places such as statement boundaries.
7562 See also C<sv_mortalcopy> and C<sv_2mortal>.
7568 Perl_sv_newmortal(pTHX)
7573 SvFLAGS(sv) = SVs_TEMP;
7575 PL_tmps_stack[++PL_tmps_ix] = sv;
7580 =for apidoc sv_2mortal
7582 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7583 by an explicit call to FREETMPS, or by an implicit call at places such as
7584 statement boundaries. SvTEMP() is turned on which means that the SV's
7585 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7586 and C<sv_mortalcopy>.
7592 Perl_sv_2mortal(pTHX_ register SV *sv)
7596 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7599 PL_tmps_stack[++PL_tmps_ix] = sv;
7607 Creates a new SV and copies a string into it. The reference count for the
7608 SV is set to 1. If C<len> is zero, Perl will compute the length using
7609 strlen(). For efficiency, consider using C<newSVpvn> instead.
7615 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7622 sv_setpvn(sv,s,len);
7627 =for apidoc newSVpvn
7629 Creates a new SV and copies a string into it. The reference count for the
7630 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7631 string. You are responsible for ensuring that the source string is at least
7632 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7638 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7643 sv_setpvn(sv,s,len);
7648 =for apidoc newSVpvn_share
7650 Creates a new SV with its SvPVX pointing to a shared string in the string
7651 table. If the string does not already exist in the table, it is created
7652 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7653 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7654 otherwise the hash is computed. The idea here is that as the string table
7655 is used for shared hash keys these strings will have SvPVX == HeKEY and
7656 hash lookup will avoid string compare.
7662 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7665 bool is_utf8 = FALSE;
7667 STRLEN tmplen = -len;
7669 /* See the note in hv.c:hv_fetch() --jhi */
7670 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7674 PERL_HASH(hash, src, len);
7676 sv_upgrade(sv, SVt_PVIV);
7677 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7690 #if defined(PERL_IMPLICIT_CONTEXT)
7692 /* pTHX_ magic can't cope with varargs, so this is a no-context
7693 * version of the main function, (which may itself be aliased to us).
7694 * Don't access this version directly.
7698 Perl_newSVpvf_nocontext(const char* pat, ...)
7703 va_start(args, pat);
7704 sv = vnewSVpvf(pat, &args);
7711 =for apidoc newSVpvf
7713 Creates a new SV and initializes it with the string formatted like
7720 Perl_newSVpvf(pTHX_ const char* pat, ...)
7724 va_start(args, pat);
7725 sv = vnewSVpvf(pat, &args);
7730 /* backend for newSVpvf() and newSVpvf_nocontext() */
7733 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7737 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7744 Creates a new SV and copies a floating point value into it.
7745 The reference count for the SV is set to 1.
7751 Perl_newSVnv(pTHX_ NV n)
7763 Creates a new SV and copies an integer into it. The reference count for the
7770 Perl_newSViv(pTHX_ IV i)
7782 Creates a new SV and copies an unsigned integer into it.
7783 The reference count for the SV is set to 1.
7789 Perl_newSVuv(pTHX_ UV u)
7799 =for apidoc newRV_noinc
7801 Creates an RV wrapper for an SV. The reference count for the original
7802 SV is B<not> incremented.
7808 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7813 sv_upgrade(sv, SVt_RV);
7820 /* newRV_inc is the official function name to use now.
7821 * newRV_inc is in fact #defined to newRV in sv.h
7825 Perl_newRV(pTHX_ SV *tmpRef)
7827 return newRV_noinc(SvREFCNT_inc(tmpRef));
7833 Creates a new SV which is an exact duplicate of the original SV.
7840 Perl_newSVsv(pTHX_ register SV *old)
7846 if (SvTYPE(old) == SVTYPEMASK) {
7847 if (ckWARN_d(WARN_INTERNAL))
7848 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7863 =for apidoc sv_reset
7865 Underlying implementation for the C<reset> Perl function.
7866 Note that the perl-level function is vaguely deprecated.
7872 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7880 char todo[PERL_UCHAR_MAX+1];
7885 if (!*s) { /* reset ?? searches */
7886 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7887 pm->op_pmdynflags &= ~PMdf_USED;
7892 /* reset variables */
7894 if (!HvARRAY(stash))
7897 Zero(todo, 256, char);
7899 i = (unsigned char)*s;
7903 max = (unsigned char)*s++;
7904 for ( ; i <= max; i++) {
7907 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7908 for (entry = HvARRAY(stash)[i];
7910 entry = HeNEXT(entry))
7912 if (!todo[(U8)*HeKEY(entry)])
7914 gv = (GV*)HeVAL(entry);
7916 if (SvTHINKFIRST(sv)) {
7917 if (!SvREADONLY(sv) && SvROK(sv))
7922 if (SvTYPE(sv) >= SVt_PV) {
7924 if (SvPVX(sv) != Nullch)
7931 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7934 #ifdef USE_ENVIRON_ARRAY
7936 # ifdef USE_ITHREADS
7937 && PL_curinterp == aTHX
7941 environ[0] = Nullch;
7944 #endif /* !PERL_MICRO */
7954 Using various gambits, try to get an IO from an SV: the IO slot if its a
7955 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7956 named after the PV if we're a string.
7962 Perl_sv_2io(pTHX_ SV *sv)
7968 switch (SvTYPE(sv)) {
7976 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7980 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7982 return sv_2io(SvRV(sv));
7983 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7989 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7998 Using various gambits, try to get a CV from an SV; in addition, try if
7999 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8005 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8012 return *gvp = Nullgv, Nullcv;
8013 switch (SvTYPE(sv)) {
8032 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8033 tryAMAGICunDEREF(to_cv);
8036 if (SvTYPE(sv) == SVt_PVCV) {
8045 Perl_croak(aTHX_ "Not a subroutine reference");
8050 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
8056 if (lref && !GvCVu(gv)) {
8059 tmpsv = NEWSV(704,0);
8060 gv_efullname3(tmpsv, gv, Nullch);
8061 /* XXX this is probably not what they think they're getting.
8062 * It has the same effect as "sub name;", i.e. just a forward
8064 newSUB(start_subparse(FALSE, 0),
8065 newSVOP(OP_CONST, 0, tmpsv),
8070 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8080 Returns true if the SV has a true value by Perl's rules.
8081 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8082 instead use an in-line version.
8088 Perl_sv_true(pTHX_ register SV *sv)
8094 if ((tXpv = (XPV*)SvANY(sv)) &&
8095 (tXpv->xpv_cur > 1 ||
8096 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8103 return SvIVX(sv) != 0;
8106 return SvNVX(sv) != 0.0;
8108 return sv_2bool(sv);
8116 A private implementation of the C<SvIVx> macro for compilers which can't
8117 cope with complex macro expressions. Always use the macro instead.
8123 Perl_sv_iv(pTHX_ register SV *sv)
8127 return (IV)SvUVX(sv);
8136 A private implementation of the C<SvUVx> macro for compilers which can't
8137 cope with complex macro expressions. Always use the macro instead.
8143 Perl_sv_uv(pTHX_ register SV *sv)
8148 return (UV)SvIVX(sv);
8156 A private implementation of the C<SvNVx> macro for compilers which can't
8157 cope with complex macro expressions. Always use the macro instead.
8163 Perl_sv_nv(pTHX_ register SV *sv)
8170 /* sv_pv() is now a macro using SvPV_nolen();
8171 * this function provided for binary compatibility only
8175 Perl_sv_pv(pTHX_ SV *sv)
8182 return sv_2pv(sv, &n_a);
8188 Use the C<SvPV_nolen> macro instead
8192 A private implementation of the C<SvPV> macro for compilers which can't
8193 cope with complex macro expressions. Always use the macro instead.
8199 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8205 return sv_2pv(sv, lp);
8210 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8216 return sv_2pv_flags(sv, lp, 0);
8219 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8220 * this function provided for binary compatibility only
8224 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8226 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8230 =for apidoc sv_pvn_force
8232 Get a sensible string out of the SV somehow.
8233 A private implementation of the C<SvPV_force> macro for compilers which
8234 can't cope with complex macro expressions. Always use the macro instead.
8236 =for apidoc sv_pvn_force_flags
8238 Get a sensible string out of the SV somehow.
8239 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8240 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8241 implemented in terms of this function.
8242 You normally want to use the various wrapper macros instead: see
8243 C<SvPV_force> and C<SvPV_force_nomg>
8249 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8253 if (SvTHINKFIRST(sv) && !SvROK(sv))
8254 sv_force_normal_flags(sv, 0);
8260 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8261 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8265 s = sv_2pv_flags(sv, lp, flags);
8266 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8271 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8272 SvGROW(sv, len + 1);
8273 Move(s,SvPVX(sv),len,char);
8278 SvPOK_on(sv); /* validate pointer */
8280 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8281 PTR2UV(sv),SvPVX(sv)));
8287 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8288 * this function provided for binary compatibility only
8292 Perl_sv_pvbyte(pTHX_ SV *sv)
8294 sv_utf8_downgrade(sv,0);
8299 =for apidoc sv_pvbyte
8301 Use C<SvPVbyte_nolen> instead.
8303 =for apidoc sv_pvbyten
8305 A private implementation of the C<SvPVbyte> macro for compilers
8306 which can't cope with complex macro expressions. Always use the macro
8313 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8315 sv_utf8_downgrade(sv,0);
8316 return sv_pvn(sv,lp);
8320 =for apidoc sv_pvbyten_force
8322 A private implementation of the C<SvPVbytex_force> macro for compilers
8323 which can't cope with complex macro expressions. Always use the macro
8330 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8332 sv_pvn_force(sv,lp);
8333 sv_utf8_downgrade(sv,0);
8338 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8339 * this function provided for binary compatibility only
8343 Perl_sv_pvutf8(pTHX_ SV *sv)
8345 sv_utf8_upgrade(sv);
8350 =for apidoc sv_pvutf8
8352 Use the C<SvPVutf8_nolen> macro instead
8354 =for apidoc sv_pvutf8n
8356 A private implementation of the C<SvPVutf8> macro for compilers
8357 which can't cope with complex macro expressions. Always use the macro
8364 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8366 sv_utf8_upgrade(sv);
8367 return sv_pvn(sv,lp);
8371 =for apidoc sv_pvutf8n_force
8373 A private implementation of the C<SvPVutf8_force> macro for compilers
8374 which can't cope with complex macro expressions. Always use the macro
8381 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8383 sv_pvn_force(sv,lp);
8384 sv_utf8_upgrade(sv);
8390 =for apidoc sv_reftype
8392 Returns a string describing what the SV is a reference to.
8398 Perl_sv_reftype(pTHX_ SV *sv, int ob)
8400 if (ob && SvOBJECT(sv)) {
8401 if (HvNAME(SvSTASH(sv)))
8402 return HvNAME(SvSTASH(sv));
8407 switch (SvTYPE(sv)) {
8424 case SVt_PVLV: return SvROK(sv) ? "REF"
8425 /* tied lvalues should appear to be
8426 * scalars for backwards compatitbility */
8427 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8428 ? "SCALAR" : "LVALUE";
8429 case SVt_PVAV: return "ARRAY";
8430 case SVt_PVHV: return "HASH";
8431 case SVt_PVCV: return "CODE";
8432 case SVt_PVGV: return "GLOB";
8433 case SVt_PVFM: return "FORMAT";
8434 case SVt_PVIO: return "IO";
8435 default: return "UNKNOWN";
8441 =for apidoc sv_isobject
8443 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8444 object. If the SV is not an RV, or if the object is not blessed, then this
8451 Perl_sv_isobject(pTHX_ SV *sv)
8468 Returns a boolean indicating whether the SV is blessed into the specified
8469 class. This does not check for subtypes; use C<sv_derived_from> to verify
8470 an inheritance relationship.
8476 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8487 if (!HvNAME(SvSTASH(sv)))
8490 return strEQ(HvNAME(SvSTASH(sv)), name);
8496 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8497 it will be upgraded to one. If C<classname> is non-null then the new SV will
8498 be blessed in the specified package. The new SV is returned and its
8499 reference count is 1.
8505 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8511 SV_CHECK_THINKFIRST_COW_DROP(rv);
8514 if (SvTYPE(rv) >= SVt_PVMG) {
8515 U32 refcnt = SvREFCNT(rv);
8519 SvREFCNT(rv) = refcnt;
8522 if (SvTYPE(rv) < SVt_RV)
8523 sv_upgrade(rv, SVt_RV);
8524 else if (SvTYPE(rv) > SVt_RV) {
8526 if (SvPVX(rv) && SvLEN(rv))
8527 Safefree(SvPVX(rv));
8537 HV* stash = gv_stashpv(classname, TRUE);
8538 (void)sv_bless(rv, stash);
8544 =for apidoc sv_setref_pv
8546 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8547 argument will be upgraded to an RV. That RV will be modified to point to
8548 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8549 into the SV. The C<classname> argument indicates the package for the
8550 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8551 will have a reference count of 1, and the RV will be returned.
8553 Do not use with other Perl types such as HV, AV, SV, CV, because those
8554 objects will become corrupted by the pointer copy process.
8556 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8562 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8565 sv_setsv(rv, &PL_sv_undef);
8569 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8574 =for apidoc sv_setref_iv
8576 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8577 argument will be upgraded to an RV. That RV will be modified to point to
8578 the new SV. The C<classname> argument indicates the package for the
8579 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8580 will have a reference count of 1, and the RV will be returned.
8586 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8588 sv_setiv(newSVrv(rv,classname), iv);
8593 =for apidoc sv_setref_uv
8595 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8596 argument will be upgraded to an RV. That RV will be modified to point to
8597 the new SV. The C<classname> argument indicates the package for the
8598 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8599 will have a reference count of 1, and the RV will be returned.
8605 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8607 sv_setuv(newSVrv(rv,classname), uv);
8612 =for apidoc sv_setref_nv
8614 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8615 argument will be upgraded to an RV. That RV will be modified to point to
8616 the new SV. The C<classname> argument indicates the package for the
8617 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8618 will have a reference count of 1, and the RV will be returned.
8624 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8626 sv_setnv(newSVrv(rv,classname), nv);
8631 =for apidoc sv_setref_pvn
8633 Copies a string into a new SV, optionally blessing the SV. The length of the
8634 string must be specified with C<n>. The C<rv> argument will be upgraded to
8635 an RV. That RV will be modified to point to the new SV. The C<classname>
8636 argument indicates the package for the blessing. Set C<classname> to
8637 C<Nullch> to avoid the blessing. The new SV will have a reference count
8638 of 1, and the RV will be returned.
8640 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8646 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8648 sv_setpvn(newSVrv(rv,classname), pv, n);
8653 =for apidoc sv_bless
8655 Blesses an SV into a specified package. The SV must be an RV. The package
8656 must be designated by its stash (see C<gv_stashpv()>). The reference count
8657 of the SV is unaffected.
8663 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8667 Perl_croak(aTHX_ "Can't bless non-reference value");
8669 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8670 if (SvREADONLY(tmpRef))
8671 Perl_croak(aTHX_ PL_no_modify);
8672 if (SvOBJECT(tmpRef)) {
8673 if (SvTYPE(tmpRef) != SVt_PVIO)
8675 SvREFCNT_dec(SvSTASH(tmpRef));
8678 SvOBJECT_on(tmpRef);
8679 if (SvTYPE(tmpRef) != SVt_PVIO)
8681 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8682 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8689 if(SvSMAGICAL(tmpRef))
8690 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8698 /* Downgrades a PVGV to a PVMG.
8702 S_sv_unglob(pTHX_ SV *sv)
8706 assert(SvTYPE(sv) == SVt_PVGV);
8711 SvREFCNT_dec(GvSTASH(sv));
8712 GvSTASH(sv) = Nullhv;
8714 sv_unmagic(sv, PERL_MAGIC_glob);
8715 Safefree(GvNAME(sv));
8718 /* need to keep SvANY(sv) in the right arena */
8719 xpvmg = new_XPVMG();
8720 StructCopy(SvANY(sv), xpvmg, XPVMG);
8721 del_XPVGV(SvANY(sv));
8724 SvFLAGS(sv) &= ~SVTYPEMASK;
8725 SvFLAGS(sv) |= SVt_PVMG;
8729 =for apidoc sv_unref_flags
8731 Unsets the RV status of the SV, and decrements the reference count of
8732 whatever was being referenced by the RV. This can almost be thought of
8733 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8734 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8735 (otherwise the decrementing is conditional on the reference count being
8736 different from one or the reference being a readonly SV).
8743 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8747 if (SvWEAKREF(sv)) {
8755 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8756 assigned to as BEGIN {$a = \"Foo"} will fail. */
8757 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8759 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8760 sv_2mortal(rv); /* Schedule for freeing later */
8764 =for apidoc sv_unref
8766 Unsets the RV status of the SV, and decrements the reference count of
8767 whatever was being referenced by the RV. This can almost be thought of
8768 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8769 being zero. See C<SvROK_off>.
8775 Perl_sv_unref(pTHX_ SV *sv)
8777 sv_unref_flags(sv, 0);
8781 =for apidoc sv_taint
8783 Taint an SV. Use C<SvTAINTED_on> instead.
8788 Perl_sv_taint(pTHX_ SV *sv)
8790 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8794 =for apidoc sv_untaint
8796 Untaint an SV. Use C<SvTAINTED_off> instead.
8801 Perl_sv_untaint(pTHX_ SV *sv)
8803 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8804 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8811 =for apidoc sv_tainted
8813 Test an SV for taintedness. Use C<SvTAINTED> instead.
8818 Perl_sv_tainted(pTHX_ SV *sv)
8820 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8821 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8822 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8829 =for apidoc sv_setpviv
8831 Copies an integer into the given SV, also updating its string value.
8832 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8838 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8840 char buf[TYPE_CHARS(UV)];
8842 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8844 sv_setpvn(sv, ptr, ebuf - ptr);
8848 =for apidoc sv_setpviv_mg
8850 Like C<sv_setpviv>, but also handles 'set' magic.
8856 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8858 char buf[TYPE_CHARS(UV)];
8860 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8862 sv_setpvn(sv, ptr, ebuf - ptr);
8866 #if defined(PERL_IMPLICIT_CONTEXT)
8868 /* pTHX_ magic can't cope with varargs, so this is a no-context
8869 * version of the main function, (which may itself be aliased to us).
8870 * Don't access this version directly.
8874 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8878 va_start(args, pat);
8879 sv_vsetpvf(sv, pat, &args);
8883 /* pTHX_ magic can't cope with varargs, so this is a no-context
8884 * version of the main function, (which may itself be aliased to us).
8885 * Don't access this version directly.
8889 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8893 va_start(args, pat);
8894 sv_vsetpvf_mg(sv, pat, &args);
8900 =for apidoc sv_setpvf
8902 Processes its arguments like C<sprintf> and sets an SV to the formatted
8903 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8909 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8912 va_start(args, pat);
8913 sv_vsetpvf(sv, pat, &args);
8917 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8920 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8922 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8926 =for apidoc sv_setpvf_mg
8928 Like C<sv_setpvf>, but also handles 'set' magic.
8934 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8937 va_start(args, pat);
8938 sv_vsetpvf_mg(sv, pat, &args);
8942 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8945 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8947 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8951 #if defined(PERL_IMPLICIT_CONTEXT)
8953 /* pTHX_ magic can't cope with varargs, so this is a no-context
8954 * version of the main function, (which may itself be aliased to us).
8955 * Don't access this version directly.
8959 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8963 va_start(args, pat);
8964 sv_vcatpvf(sv, pat, &args);
8968 /* pTHX_ magic can't cope with varargs, so this is a no-context
8969 * version of the main function, (which may itself be aliased to us).
8970 * Don't access this version directly.
8974 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8978 va_start(args, pat);
8979 sv_vcatpvf_mg(sv, pat, &args);
8985 =for apidoc sv_catpvf
8987 Processes its arguments like C<sprintf> and appends the formatted
8988 output to an SV. If the appended data contains "wide" characters
8989 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8990 and characters >255 formatted with %c), the original SV might get
8991 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8992 C<SvSETMAGIC()> must typically be called after calling this function
8993 to handle 'set' magic.
8998 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9001 va_start(args, pat);
9002 sv_vcatpvf(sv, pat, &args);
9006 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
9009 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9011 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9015 =for apidoc sv_catpvf_mg
9017 Like C<sv_catpvf>, but also handles 'set' magic.
9023 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9026 va_start(args, pat);
9027 sv_vcatpvf_mg(sv, pat, &args);
9031 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
9034 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9036 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9041 =for apidoc sv_vsetpvfn
9043 Works like C<vcatpvfn> but copies the text into the SV instead of
9046 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
9052 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9054 sv_setpvn(sv, "", 0);
9055 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9058 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9061 S_expect_number(pTHX_ char** pattern)
9064 switch (**pattern) {
9065 case '1': case '2': case '3':
9066 case '4': case '5': case '6':
9067 case '7': case '8': case '9':
9068 while (isDIGIT(**pattern))
9069 var = var * 10 + (*(*pattern)++ - '0');
9073 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9076 F0convert(NV nv, char *endbuf, STRLEN *len)
9087 if (uv & 1 && uv == nv)
9088 uv--; /* Round to even */
9090 unsigned dig = uv % 10;
9103 =for apidoc sv_vcatpvfn
9105 Processes its arguments like C<vsprintf> and appends the formatted output
9106 to an SV. Uses an array of SVs if the C style variable argument list is
9107 missing (NULL). When running with taint checks enabled, indicates via
9108 C<maybe_tainted> if results are untrustworthy (often due to the use of
9111 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
9117 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9124 static char nullstr[] = "(null)";
9126 bool has_utf8; /* has the result utf8? */
9127 bool pat_utf8; /* the pattern is in utf8? */
9129 /* Times 4: a decimal digit takes more than 3 binary digits.
9130 * NV_DIG: mantissa takes than many decimal digits.
9131 * Plus 32: Playing safe. */
9132 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9133 /* large enough for "%#.#f" --chip */
9134 /* what about long double NVs? --jhi */
9136 has_utf8 = pat_utf8 = DO_UTF8(sv);
9138 /* no matter what, this is a string now */
9139 (void)SvPV_force(sv, origlen);
9141 /* special-case "", "%s", and "%_" */
9144 if (patlen == 2 && pat[0] == '%') {
9148 char *s = va_arg(*args, char*);
9149 sv_catpv(sv, s ? s : nullstr);
9151 else if (svix < svmax) {
9152 sv_catsv(sv, *svargs);
9153 if (DO_UTF8(*svargs))
9159 argsv = va_arg(*args, SV*);
9160 sv_catsv(sv, argsv);
9165 /* See comment on '_' below */
9170 #ifndef USE_LONG_DOUBLE
9171 /* special-case "%.<number>[gf]" */
9172 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9173 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9174 unsigned digits = 0;
9178 while (*pp >= '0' && *pp <= '9')
9179 digits = 10 * digits + (*pp++ - '0');
9180 if (pp - pat == (int)patlen - 1) {
9184 nv = (NV)va_arg(*args, double);
9185 else if (svix < svmax)
9190 /* Add check for digits != 0 because it seems that some
9191 gconverts are buggy in this case, and we don't yet have
9192 a Configure test for this. */
9193 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9194 /* 0, point, slack */
9195 Gconvert(nv, (int)digits, 0, ebuf);
9197 if (*ebuf) /* May return an empty string for digits==0 */
9200 } else if (!digits) {
9203 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9204 sv_catpvn(sv, p, l);
9210 #endif /* !USE_LONG_DOUBLE */
9212 if (!args && svix < svmax && DO_UTF8(*svargs))
9215 patend = (char*)pat + patlen;
9216 for (p = (char*)pat; p < patend; p = q) {
9219 bool vectorize = FALSE;
9220 bool vectorarg = FALSE;
9221 bool vec_utf8 = FALSE;
9227 bool has_precis = FALSE;
9230 bool is_utf8 = FALSE; /* is this item utf8? */
9231 #ifdef HAS_LDBL_SPRINTF_BUG
9232 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9233 with sfio - Allen <allens@cpan.org> */
9234 bool fix_ldbl_sprintf_bug = FALSE;
9238 U8 utf8buf[UTF8_MAXLEN+1];
9239 STRLEN esignlen = 0;
9241 char *eptr = Nullch;
9244 U8 *vecstr = Null(U8*);
9251 /* we need a long double target in case HAS_LONG_DOUBLE but
9254 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9263 STRLEN dotstrlen = 1;
9264 I32 efix = 0; /* explicit format parameter index */
9265 I32 ewix = 0; /* explicit width index */
9266 I32 epix = 0; /* explicit precision index */
9267 I32 evix = 0; /* explicit vector index */
9268 bool asterisk = FALSE;
9270 /* echo everything up to the next format specification */
9271 for (q = p; q < patend && *q != '%'; ++q) ;
9273 if (has_utf8 && !pat_utf8)
9274 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9276 sv_catpvn(sv, p, q - p);
9283 We allow format specification elements in this order:
9284 \d+\$ explicit format parameter index
9286 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9287 0 flag (as above): repeated to allow "v02"
9288 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9289 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9291 [%bcdefginopsux_DFOUX] format (mandatory)
9293 if (EXPECT_NUMBER(q, width)) {
9334 if (EXPECT_NUMBER(q, ewix))
9343 if ((vectorarg = asterisk)) {
9355 EXPECT_NUMBER(q, width);
9360 vecsv = va_arg(*args, SV*);
9362 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9363 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9364 dotstr = SvPVx(vecsv, dotstrlen);
9369 vecsv = va_arg(*args, SV*);
9370 vecstr = (U8*)SvPVx(vecsv,veclen);
9371 vec_utf8 = DO_UTF8(vecsv);
9373 else if (efix ? efix <= svmax : svix < svmax) {
9374 vecsv = svargs[efix ? efix-1 : svix++];
9375 vecstr = (U8*)SvPVx(vecsv,veclen);
9376 vec_utf8 = DO_UTF8(vecsv);
9377 /* if this is a version object, we need to return the
9378 * stringified representation (which the SvPVX has
9379 * already done for us), but not vectorize the args
9381 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9383 q++; /* skip past the rest of the %vd format */
9384 eptr = (char *) vecstr;
9385 elen = strlen(eptr);
9398 i = va_arg(*args, int);
9400 i = (ewix ? ewix <= svmax : svix < svmax) ?
9401 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9403 width = (i < 0) ? -i : i;
9413 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9415 /* XXX: todo, support specified precision parameter */
9419 i = va_arg(*args, int);
9421 i = (ewix ? ewix <= svmax : svix < svmax)
9422 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9423 precis = (i < 0) ? 0 : i;
9428 precis = precis * 10 + (*q++ - '0');
9437 case 'I': /* Ix, I32x, and I64x */
9439 if (q[1] == '6' && q[2] == '4') {
9445 if (q[1] == '3' && q[2] == '2') {
9455 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9466 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9467 if (*(q + 1) == 'l') { /* lld, llf */
9492 argsv = (efix ? efix <= svmax : svix < svmax) ?
9493 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9500 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9502 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9504 eptr = (char*)utf8buf;
9505 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9516 if (args && !vectorize) {
9517 eptr = va_arg(*args, char*);
9519 #ifdef MACOS_TRADITIONAL
9520 /* On MacOS, %#s format is used for Pascal strings */
9525 elen = strlen(eptr);
9528 elen = sizeof nullstr - 1;
9532 eptr = SvPVx(argsv, elen);
9533 if (DO_UTF8(argsv)) {
9534 if (has_precis && precis < elen) {
9536 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9539 if (width) { /* fudge width (can't fudge elen) */
9540 width += elen - sv_len_utf8(argsv);
9549 * The "%_" hack might have to be changed someday,
9550 * if ISO or ANSI decide to use '_' for something.
9551 * So we keep it hidden from users' code.
9553 if (!args || vectorize)
9555 argsv = va_arg(*args, SV*);
9556 eptr = SvPVx(argsv, elen);
9562 if (has_precis && elen > precis)
9569 if (alt || vectorize)
9571 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9589 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9598 esignbuf[esignlen++] = plus;
9602 case 'h': iv = (short)va_arg(*args, int); break;
9603 case 'l': iv = va_arg(*args, long); break;
9604 case 'V': iv = va_arg(*args, IV); break;
9605 default: iv = va_arg(*args, int); break;
9607 case 'q': iv = va_arg(*args, Quad_t); break;
9612 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9614 case 'h': iv = (short)tiv; break;
9615 case 'l': iv = (long)tiv; break;
9617 default: iv = tiv; break;
9619 case 'q': iv = (Quad_t)tiv; break;
9623 if ( !vectorize ) /* we already set uv above */
9628 esignbuf[esignlen++] = plus;
9632 esignbuf[esignlen++] = '-';
9675 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9686 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9687 case 'l': uv = va_arg(*args, unsigned long); break;
9688 case 'V': uv = va_arg(*args, UV); break;
9689 default: uv = va_arg(*args, unsigned); break;
9691 case 'q': uv = va_arg(*args, Uquad_t); break;
9696 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9698 case 'h': uv = (unsigned short)tuv; break;
9699 case 'l': uv = (unsigned long)tuv; break;
9701 default: uv = tuv; break;
9703 case 'q': uv = (Uquad_t)tuv; break;
9709 eptr = ebuf + sizeof ebuf;
9715 p = (char*)((c == 'X')
9716 ? "0123456789ABCDEF" : "0123456789abcdef");
9722 esignbuf[esignlen++] = '0';
9723 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9729 *--eptr = '0' + dig;
9731 if (alt && *eptr != '0')
9737 *--eptr = '0' + dig;
9740 esignbuf[esignlen++] = '0';
9741 esignbuf[esignlen++] = 'b';
9744 default: /* it had better be ten or less */
9745 #if defined(PERL_Y2KWARN)
9746 if (ckWARN(WARN_Y2K)) {
9748 char *s = SvPV(sv,n);
9749 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9750 && (n == 2 || !isDIGIT(s[n-3])))
9752 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9753 "Possible Y2K bug: %%%c %s",
9754 c, "format string following '19'");
9760 *--eptr = '0' + dig;
9761 } while (uv /= base);
9764 elen = (ebuf + sizeof ebuf) - eptr;
9767 zeros = precis - elen;
9768 else if (precis == 0 && elen == 1 && *eptr == '0')
9773 /* FLOATING POINT */
9776 c = 'f'; /* maybe %F isn't supported here */
9782 /* This is evil, but floating point is even more evil */
9784 /* for SV-style calling, we can only get NV
9785 for C-style calling, we assume %f is double;
9786 for simplicity we allow any of %Lf, %llf, %qf for long double
9790 #if defined(USE_LONG_DOUBLE)
9794 /* [perl #20339] - we should accept and ignore %lf rather than die */
9798 #if defined(USE_LONG_DOUBLE)
9799 intsize = args ? 0 : 'q';
9803 #if defined(HAS_LONG_DOUBLE)
9812 /* now we need (long double) if intsize == 'q', else (double) */
9813 nv = (args && !vectorize) ?
9814 #if LONG_DOUBLESIZE > DOUBLESIZE
9816 va_arg(*args, long double) :
9817 va_arg(*args, double)
9819 va_arg(*args, double)
9825 if (c != 'e' && c != 'E') {
9827 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9828 will cast our (long double) to (double) */
9829 (void)Perl_frexp(nv, &i);
9830 if (i == PERL_INT_MIN)
9831 Perl_die(aTHX_ "panic: frexp");
9833 need = BIT_DIGITS(i);
9835 need += has_precis ? precis : 6; /* known default */
9840 #ifdef HAS_LDBL_SPRINTF_BUG
9841 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9842 with sfio - Allen <allens@cpan.org> */
9845 # define MY_DBL_MAX DBL_MAX
9846 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9847 # if DOUBLESIZE >= 8
9848 # define MY_DBL_MAX 1.7976931348623157E+308L
9850 # define MY_DBL_MAX 3.40282347E+38L
9854 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9855 # define MY_DBL_MAX_BUG 1L
9857 # define MY_DBL_MAX_BUG MY_DBL_MAX
9861 # define MY_DBL_MIN DBL_MIN
9862 # else /* XXX guessing! -Allen */
9863 # if DOUBLESIZE >= 8
9864 # define MY_DBL_MIN 2.2250738585072014E-308L
9866 # define MY_DBL_MIN 1.17549435E-38L
9870 if ((intsize == 'q') && (c == 'f') &&
9871 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9873 /* it's going to be short enough that
9874 * long double precision is not needed */
9876 if ((nv <= 0L) && (nv >= -0L))
9877 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9879 /* would use Perl_fp_class as a double-check but not
9880 * functional on IRIX - see perl.h comments */
9882 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9883 /* It's within the range that a double can represent */
9884 #if defined(DBL_MAX) && !defined(DBL_MIN)
9885 if ((nv >= ((long double)1/DBL_MAX)) ||
9886 (nv <= (-(long double)1/DBL_MAX)))
9888 fix_ldbl_sprintf_bug = TRUE;
9891 if (fix_ldbl_sprintf_bug == TRUE) {
9901 # undef MY_DBL_MAX_BUG
9904 #endif /* HAS_LDBL_SPRINTF_BUG */
9906 need += 20; /* fudge factor */
9907 if (PL_efloatsize < need) {
9908 Safefree(PL_efloatbuf);
9909 PL_efloatsize = need + 20; /* more fudge */
9910 New(906, PL_efloatbuf, PL_efloatsize, char);
9911 PL_efloatbuf[0] = '\0';
9914 if ( !(width || left || plus || alt) && fill != '0'
9915 && has_precis && intsize != 'q' ) { /* Shortcuts */
9916 /* See earlier comment about buggy Gconvert when digits,
9918 if ( c == 'g' && precis) {
9919 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9920 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9921 goto float_converted;
9922 } else if ( c == 'f' && !precis) {
9923 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9927 eptr = ebuf + sizeof ebuf;
9930 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9931 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9932 if (intsize == 'q') {
9933 /* Copy the one or more characters in a long double
9934 * format before the 'base' ([efgEFG]) character to
9935 * the format string. */
9936 static char const prifldbl[] = PERL_PRIfldbl;
9937 char const *p = prifldbl + sizeof(prifldbl) - 3;
9938 while (p >= prifldbl) { *--eptr = *p--; }
9943 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9948 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9960 /* No taint. Otherwise we are in the strange situation
9961 * where printf() taints but print($float) doesn't.
9963 #if defined(HAS_LONG_DOUBLE)
9965 (void)sprintf(PL_efloatbuf, eptr, nv);
9967 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9969 (void)sprintf(PL_efloatbuf, eptr, nv);
9972 eptr = PL_efloatbuf;
9973 elen = strlen(PL_efloatbuf);
9979 i = SvCUR(sv) - origlen;
9980 if (args && !vectorize) {
9982 case 'h': *(va_arg(*args, short*)) = i; break;
9983 default: *(va_arg(*args, int*)) = i; break;
9984 case 'l': *(va_arg(*args, long*)) = i; break;
9985 case 'V': *(va_arg(*args, IV*)) = i; break;
9987 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9992 sv_setuv_mg(argsv, (UV)i);
9994 continue; /* not "break" */
10000 if (!args && ckWARN(WARN_PRINTF) &&
10001 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10002 SV *msg = sv_newmortal();
10003 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10004 (PL_op->op_type == OP_PRTF) ? "" : "s");
10007 Perl_sv_catpvf(aTHX_ msg,
10008 "\"%%%c\"", c & 0xFF);
10010 Perl_sv_catpvf(aTHX_ msg,
10011 "\"%%\\%03"UVof"\"",
10014 sv_catpv(msg, "end of string");
10015 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10018 /* output mangled stuff ... */
10024 /* ... right here, because formatting flags should not apply */
10025 SvGROW(sv, SvCUR(sv) + elen + 1);
10027 Copy(eptr, p, elen, char);
10030 SvCUR(sv) = p - SvPVX(sv);
10032 continue; /* not "break" */
10035 /* calculate width before utf8_upgrade changes it */
10036 have = esignlen + zeros + elen;
10038 if (is_utf8 != has_utf8) {
10041 sv_utf8_upgrade(sv);
10044 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10045 sv_utf8_upgrade(nsv);
10049 SvGROW(sv, SvCUR(sv) + elen + 1);
10054 need = (have > width ? have : width);
10057 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10059 if (esignlen && fill == '0') {
10060 for (i = 0; i < (int)esignlen; i++)
10061 *p++ = esignbuf[i];
10063 if (gap && !left) {
10064 memset(p, fill, gap);
10067 if (esignlen && fill != '0') {
10068 for (i = 0; i < (int)esignlen; i++)
10069 *p++ = esignbuf[i];
10072 for (i = zeros; i; i--)
10076 Copy(eptr, p, elen, char);
10080 memset(p, ' ', gap);
10085 Copy(dotstr, p, dotstrlen, char);
10089 vectorize = FALSE; /* done iterating over vecstr */
10096 SvCUR(sv) = p - SvPVX(sv);
10104 /* =========================================================================
10106 =head1 Cloning an interpreter
10108 All the macros and functions in this section are for the private use of
10109 the main function, perl_clone().
10111 The foo_dup() functions make an exact copy of an existing foo thinngy.
10112 During the course of a cloning, a hash table is used to map old addresses
10113 to new addresses. The table is created and manipulated with the
10114 ptr_table_* functions.
10118 ============================================================================*/
10121 #if defined(USE_ITHREADS)
10123 #ifndef GpREFCNT_inc
10124 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10128 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10129 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10130 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10131 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10132 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10133 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10134 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10135 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10136 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10137 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10138 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10139 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10140 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10143 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10144 regcomp.c. AMS 20010712 */
10147 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10151 struct reg_substr_datum *s;
10154 return (REGEXP *)NULL;
10156 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10159 len = r->offsets[0];
10160 npar = r->nparens+1;
10162 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10163 Copy(r->program, ret->program, len+1, regnode);
10165 New(0, ret->startp, npar, I32);
10166 Copy(r->startp, ret->startp, npar, I32);
10167 New(0, ret->endp, npar, I32);
10168 Copy(r->startp, ret->startp, npar, I32);
10170 New(0, ret->substrs, 1, struct reg_substr_data);
10171 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10172 s->min_offset = r->substrs->data[i].min_offset;
10173 s->max_offset = r->substrs->data[i].max_offset;
10174 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10175 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10178 ret->regstclass = NULL;
10180 struct reg_data *d;
10181 int count = r->data->count;
10183 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10184 char, struct reg_data);
10185 New(0, d->what, count, U8);
10188 for (i = 0; i < count; i++) {
10189 d->what[i] = r->data->what[i];
10190 switch (d->what[i]) {
10192 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10195 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10198 /* This is cheating. */
10199 New(0, d->data[i], 1, struct regnode_charclass_class);
10200 StructCopy(r->data->data[i], d->data[i],
10201 struct regnode_charclass_class);
10202 ret->regstclass = (regnode*)d->data[i];
10205 /* Compiled op trees are readonly, and can thus be
10206 shared without duplication. */
10207 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10210 d->data[i] = r->data->data[i];
10220 New(0, ret->offsets, 2*len+1, U32);
10221 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10223 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10224 ret->refcnt = r->refcnt;
10225 ret->minlen = r->minlen;
10226 ret->prelen = r->prelen;
10227 ret->nparens = r->nparens;
10228 ret->lastparen = r->lastparen;
10229 ret->lastcloseparen = r->lastcloseparen;
10230 ret->reganch = r->reganch;
10232 ret->sublen = r->sublen;
10234 if (RX_MATCH_COPIED(ret))
10235 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10237 ret->subbeg = Nullch;
10238 #ifdef PERL_COPY_ON_WRITE
10239 ret->saved_copy = Nullsv;
10242 ptr_table_store(PL_ptr_table, r, ret);
10246 /* duplicate a file handle */
10249 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10253 return (PerlIO*)NULL;
10255 /* look for it in the table first */
10256 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10260 /* create anew and remember what it is */
10261 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10262 ptr_table_store(PL_ptr_table, fp, ret);
10266 /* duplicate a directory handle */
10269 Perl_dirp_dup(pTHX_ DIR *dp)
10277 /* duplicate a typeglob */
10280 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10285 /* look for it in the table first */
10286 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10290 /* create anew and remember what it is */
10291 Newz(0, ret, 1, GP);
10292 ptr_table_store(PL_ptr_table, gp, ret);
10295 ret->gp_refcnt = 0; /* must be before any other dups! */
10296 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10297 ret->gp_io = io_dup_inc(gp->gp_io, param);
10298 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10299 ret->gp_av = av_dup_inc(gp->gp_av, param);
10300 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10301 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10302 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10303 ret->gp_cvgen = gp->gp_cvgen;
10304 ret->gp_flags = gp->gp_flags;
10305 ret->gp_line = gp->gp_line;
10306 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10310 /* duplicate a chain of magic */
10313 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10315 MAGIC *mgprev = (MAGIC*)NULL;
10318 return (MAGIC*)NULL;
10319 /* look for it in the table first */
10320 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10324 for (; mg; mg = mg->mg_moremagic) {
10326 Newz(0, nmg, 1, MAGIC);
10328 mgprev->mg_moremagic = nmg;
10331 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10332 nmg->mg_private = mg->mg_private;
10333 nmg->mg_type = mg->mg_type;
10334 nmg->mg_flags = mg->mg_flags;
10335 if (mg->mg_type == PERL_MAGIC_qr) {
10336 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10338 else if(mg->mg_type == PERL_MAGIC_backref) {
10339 AV *av = (AV*) mg->mg_obj;
10342 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10344 for (i = AvFILLp(av); i >= 0; i--) {
10345 if (!svp[i]) continue;
10346 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10350 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10351 ? sv_dup_inc(mg->mg_obj, param)
10352 : sv_dup(mg->mg_obj, param);
10354 nmg->mg_len = mg->mg_len;
10355 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10356 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10357 if (mg->mg_len > 0) {
10358 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10359 if (mg->mg_type == PERL_MAGIC_overload_table &&
10360 AMT_AMAGIC((AMT*)mg->mg_ptr))
10362 AMT *amtp = (AMT*)mg->mg_ptr;
10363 AMT *namtp = (AMT*)nmg->mg_ptr;
10365 for (i = 1; i < NofAMmeth; i++) {
10366 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10370 else if (mg->mg_len == HEf_SVKEY)
10371 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10373 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10374 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10381 /* create a new pointer-mapping table */
10384 Perl_ptr_table_new(pTHX)
10387 Newz(0, tbl, 1, PTR_TBL_t);
10388 tbl->tbl_max = 511;
10389 tbl->tbl_items = 0;
10390 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10395 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10397 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10400 /* map an existing pointer using a table */
10403 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10405 PTR_TBL_ENT_t *tblent;
10406 UV hash = PTR_TABLE_HASH(sv);
10408 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10409 for (; tblent; tblent = tblent->next) {
10410 if (tblent->oldval == sv)
10411 return tblent->newval;
10413 return (void*)NULL;
10416 /* add a new entry to a pointer-mapping table */
10419 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10421 PTR_TBL_ENT_t *tblent, **otblent;
10422 /* XXX this may be pessimal on platforms where pointers aren't good
10423 * hash values e.g. if they grow faster in the most significant
10425 UV hash = PTR_TABLE_HASH(oldv);
10429 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10430 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10431 if (tblent->oldval == oldv) {
10432 tblent->newval = newv;
10436 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10437 tblent->oldval = oldv;
10438 tblent->newval = newv;
10439 tblent->next = *otblent;
10442 if (!empty && tbl->tbl_items > tbl->tbl_max)
10443 ptr_table_split(tbl);
10446 /* double the hash bucket size of an existing ptr table */
10449 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10451 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10452 UV oldsize = tbl->tbl_max + 1;
10453 UV newsize = oldsize * 2;
10456 Renew(ary, newsize, PTR_TBL_ENT_t*);
10457 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10458 tbl->tbl_max = --newsize;
10459 tbl->tbl_ary = ary;
10460 for (i=0; i < oldsize; i++, ary++) {
10461 PTR_TBL_ENT_t **curentp, **entp, *ent;
10464 curentp = ary + oldsize;
10465 for (entp = ary, ent = *ary; ent; ent = *entp) {
10466 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10468 ent->next = *curentp;
10478 /* remove all the entries from a ptr table */
10481 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10483 register PTR_TBL_ENT_t **array;
10484 register PTR_TBL_ENT_t *entry;
10485 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10489 if (!tbl || !tbl->tbl_items) {
10493 array = tbl->tbl_ary;
10495 max = tbl->tbl_max;
10500 entry = entry->next;
10504 if (++riter > max) {
10507 entry = array[riter];
10511 tbl->tbl_items = 0;
10514 /* clear and free a ptr table */
10517 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10522 ptr_table_clear(tbl);
10523 Safefree(tbl->tbl_ary);
10528 char *PL_watch_pvx;
10531 /* attempt to make everything in the typeglob readonly */
10534 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10536 GV *gv = (GV*)sstr;
10537 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10539 if (GvIO(gv) || GvFORM(gv)) {
10540 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10542 else if (!GvCV(gv)) {
10543 GvCV(gv) = (CV*)sv;
10546 /* CvPADLISTs cannot be shared */
10547 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10552 if (!GvUNIQUE(gv)) {
10554 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10555 HvNAME(GvSTASH(gv)), GvNAME(gv));
10561 * write attempts will die with
10562 * "Modification of a read-only value attempted"
10568 SvREADONLY_on(GvSV(gv));
10572 GvAV(gv) = (AV*)sv;
10575 SvREADONLY_on(GvAV(gv));
10579 GvHV(gv) = (HV*)sv;
10582 SvREADONLY_on(GvHV(gv));
10585 return sstr; /* he_dup() will SvREFCNT_inc() */
10588 /* duplicate an SV of any type (including AV, HV etc) */
10591 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10594 SvRV(dstr) = SvWEAKREF(sstr)
10595 ? sv_dup(SvRV(sstr), param)
10596 : sv_dup_inc(SvRV(sstr), param);
10598 else if (SvPVX(sstr)) {
10599 /* Has something there */
10601 /* Normal PV - clone whole allocated space */
10602 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10603 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10604 /* Not that normal - actually sstr is copy on write.
10605 But we are a true, independant SV, so: */
10606 SvREADONLY_off(dstr);
10611 /* Special case - not normally malloced for some reason */
10612 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10613 /* A "shared" PV - clone it as unshared string */
10614 if(SvPADTMP(sstr)) {
10615 /* However, some of them live in the pad
10616 and they should not have these flags
10619 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10621 SvUVX(dstr) = SvUVX(sstr);
10624 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10626 SvREADONLY_off(dstr);
10630 /* Some other special case - random pointer */
10631 SvPVX(dstr) = SvPVX(sstr);
10636 /* Copy the Null */
10637 SvPVX(dstr) = SvPVX(sstr);
10642 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10646 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10648 /* look for it in the table first */
10649 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10653 if(param->flags & CLONEf_JOIN_IN) {
10654 /** We are joining here so we don't want do clone
10655 something that is bad **/
10657 if(SvTYPE(sstr) == SVt_PVHV &&
10659 /** don't clone stashes if they already exist **/
10660 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10661 return (SV*) old_stash;
10665 /* create anew and remember what it is */
10667 ptr_table_store(PL_ptr_table, sstr, dstr);
10670 SvFLAGS(dstr) = SvFLAGS(sstr);
10671 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10672 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10675 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10676 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10677 PL_watch_pvx, SvPVX(sstr));
10680 switch (SvTYPE(sstr)) {
10682 SvANY(dstr) = NULL;
10685 SvANY(dstr) = new_XIV();
10686 SvIVX(dstr) = SvIVX(sstr);
10689 SvANY(dstr) = new_XNV();
10690 SvNVX(dstr) = SvNVX(sstr);
10693 SvANY(dstr) = new_XRV();
10694 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10697 SvANY(dstr) = new_XPV();
10698 SvCUR(dstr) = SvCUR(sstr);
10699 SvLEN(dstr) = SvLEN(sstr);
10700 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10703 SvANY(dstr) = new_XPVIV();
10704 SvCUR(dstr) = SvCUR(sstr);
10705 SvLEN(dstr) = SvLEN(sstr);
10706 SvIVX(dstr) = SvIVX(sstr);
10707 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10710 SvANY(dstr) = new_XPVNV();
10711 SvCUR(dstr) = SvCUR(sstr);
10712 SvLEN(dstr) = SvLEN(sstr);
10713 SvIVX(dstr) = SvIVX(sstr);
10714 SvNVX(dstr) = SvNVX(sstr);
10715 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10718 SvANY(dstr) = new_XPVMG();
10719 SvCUR(dstr) = SvCUR(sstr);
10720 SvLEN(dstr) = SvLEN(sstr);
10721 SvIVX(dstr) = SvIVX(sstr);
10722 SvNVX(dstr) = SvNVX(sstr);
10723 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10724 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10725 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10728 SvANY(dstr) = new_XPVBM();
10729 SvCUR(dstr) = SvCUR(sstr);
10730 SvLEN(dstr) = SvLEN(sstr);
10731 SvIVX(dstr) = SvIVX(sstr);
10732 SvNVX(dstr) = SvNVX(sstr);
10733 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10734 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10735 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10736 BmRARE(dstr) = BmRARE(sstr);
10737 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10738 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10741 SvANY(dstr) = new_XPVLV();
10742 SvCUR(dstr) = SvCUR(sstr);
10743 SvLEN(dstr) = SvLEN(sstr);
10744 SvIVX(dstr) = SvIVX(sstr);
10745 SvNVX(dstr) = SvNVX(sstr);
10746 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10747 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10748 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10749 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10750 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10751 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10752 LvTARG(dstr) = dstr;
10753 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10754 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10756 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10757 LvTYPE(dstr) = LvTYPE(sstr);
10760 if (GvUNIQUE((GV*)sstr)) {
10762 if ((share = gv_share(sstr, param))) {
10765 ptr_table_store(PL_ptr_table, sstr, dstr);
10767 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10768 HvNAME(GvSTASH(share)), GvNAME(share));
10773 SvANY(dstr) = new_XPVGV();
10774 SvCUR(dstr) = SvCUR(sstr);
10775 SvLEN(dstr) = SvLEN(sstr);
10776 SvIVX(dstr) = SvIVX(sstr);
10777 SvNVX(dstr) = SvNVX(sstr);
10778 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10779 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10780 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10781 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10782 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10783 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10784 GvFLAGS(dstr) = GvFLAGS(sstr);
10785 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10786 (void)GpREFCNT_inc(GvGP(dstr));
10789 SvANY(dstr) = new_XPVIO();
10790 SvCUR(dstr) = SvCUR(sstr);
10791 SvLEN(dstr) = SvLEN(sstr);
10792 SvIVX(dstr) = SvIVX(sstr);
10793 SvNVX(dstr) = SvNVX(sstr);
10794 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10795 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10796 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10797 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10798 if (IoOFP(sstr) == IoIFP(sstr))
10799 IoOFP(dstr) = IoIFP(dstr);
10801 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10802 /* PL_rsfp_filters entries have fake IoDIRP() */
10803 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10804 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10806 IoDIRP(dstr) = IoDIRP(sstr);
10807 IoLINES(dstr) = IoLINES(sstr);
10808 IoPAGE(dstr) = IoPAGE(sstr);
10809 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10810 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10811 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10812 /* I have no idea why fake dirp (rsfps)
10813 should be treaded differently but otherwise
10814 we end up with leaks -- sky*/
10815 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10816 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10817 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10819 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10820 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10821 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10823 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10824 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10825 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10826 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10827 IoTYPE(dstr) = IoTYPE(sstr);
10828 IoFLAGS(dstr) = IoFLAGS(sstr);
10831 SvANY(dstr) = new_XPVAV();
10832 SvCUR(dstr) = SvCUR(sstr);
10833 SvLEN(dstr) = SvLEN(sstr);
10834 SvIVX(dstr) = SvIVX(sstr);
10835 SvNVX(dstr) = SvNVX(sstr);
10836 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10837 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10838 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10839 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10840 if (AvARRAY((AV*)sstr)) {
10841 SV **dst_ary, **src_ary;
10842 SSize_t items = AvFILLp((AV*)sstr) + 1;
10844 src_ary = AvARRAY((AV*)sstr);
10845 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10846 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10847 SvPVX(dstr) = (char*)dst_ary;
10848 AvALLOC((AV*)dstr) = dst_ary;
10849 if (AvREAL((AV*)sstr)) {
10850 while (items-- > 0)
10851 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10854 while (items-- > 0)
10855 *dst_ary++ = sv_dup(*src_ary++, param);
10857 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10858 while (items-- > 0) {
10859 *dst_ary++ = &PL_sv_undef;
10863 SvPVX(dstr) = Nullch;
10864 AvALLOC((AV*)dstr) = (SV**)NULL;
10868 SvANY(dstr) = new_XPVHV();
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 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10876 if (HvARRAY((HV*)sstr)) {
10878 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10879 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10880 Newz(0, dxhv->xhv_array,
10881 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10882 while (i <= sxhv->xhv_max) {
10883 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10884 (bool)!!HvSHAREKEYS(sstr),
10888 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10889 (bool)!!HvSHAREKEYS(sstr), param);
10892 SvPVX(dstr) = Nullch;
10893 HvEITER((HV*)dstr) = (HE*)NULL;
10895 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10896 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10897 /* Record stashes for possible cloning in Perl_clone(). */
10898 if(HvNAME((HV*)dstr))
10899 av_push(param->stashes, dstr);
10902 SvANY(dstr) = new_XPVFM();
10903 FmLINES(dstr) = FmLINES(sstr);
10907 SvANY(dstr) = new_XPVCV();
10909 SvCUR(dstr) = SvCUR(sstr);
10910 SvLEN(dstr) = SvLEN(sstr);
10911 SvIVX(dstr) = SvIVX(sstr);
10912 SvNVX(dstr) = SvNVX(sstr);
10913 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10914 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10915 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10916 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10917 CvSTART(dstr) = CvSTART(sstr);
10918 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10919 CvXSUB(dstr) = CvXSUB(sstr);
10920 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10921 if (CvCONST(sstr)) {
10922 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10923 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10924 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10926 /* don't dup if copying back - CvGV isn't refcounted, so the
10927 * duped GV may never be freed. A bit of a hack! DAPM */
10928 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10929 Nullgv : gv_dup(CvGV(sstr), param) ;
10930 if (param->flags & CLONEf_COPY_STACKS) {
10931 CvDEPTH(dstr) = CvDEPTH(sstr);
10935 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10936 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10938 CvWEAKOUTSIDE(sstr)
10939 ? cv_dup( CvOUTSIDE(sstr), param)
10940 : cv_dup_inc(CvOUTSIDE(sstr), param);
10941 CvFLAGS(dstr) = CvFLAGS(sstr);
10942 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10945 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10949 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10955 /* duplicate a context */
10958 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10960 PERL_CONTEXT *ncxs;
10963 return (PERL_CONTEXT*)NULL;
10965 /* look for it in the table first */
10966 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10970 /* create anew and remember what it is */
10971 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10972 ptr_table_store(PL_ptr_table, cxs, ncxs);
10975 PERL_CONTEXT *cx = &cxs[ix];
10976 PERL_CONTEXT *ncx = &ncxs[ix];
10977 ncx->cx_type = cx->cx_type;
10978 if (CxTYPE(cx) == CXt_SUBST) {
10979 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10982 ncx->blk_oldsp = cx->blk_oldsp;
10983 ncx->blk_oldcop = cx->blk_oldcop;
10984 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10985 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10986 ncx->blk_oldpm = cx->blk_oldpm;
10987 ncx->blk_gimme = cx->blk_gimme;
10988 switch (CxTYPE(cx)) {
10990 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10991 ? cv_dup_inc(cx->blk_sub.cv, param)
10992 : cv_dup(cx->blk_sub.cv,param));
10993 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10994 ? av_dup_inc(cx->blk_sub.argarray, param)
10996 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10997 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10998 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10999 ncx->blk_sub.lval = cx->blk_sub.lval;
11000 ncx->blk_sub.retop = cx->blk_sub.retop;
11003 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11004 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11005 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11006 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11007 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11008 ncx->blk_eval.retop = cx->blk_eval.retop;
11011 ncx->blk_loop.label = cx->blk_loop.label;
11012 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11013 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11014 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11015 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11016 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11017 ? cx->blk_loop.iterdata
11018 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11019 ncx->blk_loop.oldcomppad
11020 = (PAD*)ptr_table_fetch(PL_ptr_table,
11021 cx->blk_loop.oldcomppad);
11022 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11023 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11024 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11025 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11026 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11029 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11030 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11031 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11032 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11033 ncx->blk_sub.retop = cx->blk_sub.retop;
11045 /* duplicate a stack info structure */
11048 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11053 return (PERL_SI*)NULL;
11055 /* look for it in the table first */
11056 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11060 /* create anew and remember what it is */
11061 Newz(56, nsi, 1, PERL_SI);
11062 ptr_table_store(PL_ptr_table, si, nsi);
11064 nsi->si_stack = av_dup_inc(si->si_stack, param);
11065 nsi->si_cxix = si->si_cxix;
11066 nsi->si_cxmax = si->si_cxmax;
11067 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11068 nsi->si_type = si->si_type;
11069 nsi->si_prev = si_dup(si->si_prev, param);
11070 nsi->si_next = si_dup(si->si_next, param);
11071 nsi->si_markoff = si->si_markoff;
11076 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11077 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11078 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11079 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11080 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11081 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11082 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11083 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11084 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11085 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11086 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11087 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11088 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11089 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11092 #define pv_dup_inc(p) SAVEPV(p)
11093 #define pv_dup(p) SAVEPV(p)
11094 #define svp_dup_inc(p,pp) any_dup(p,pp)
11096 /* map any object to the new equivent - either something in the
11097 * ptr table, or something in the interpreter structure
11101 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11106 return (void*)NULL;
11108 /* look for it in the table first */
11109 ret = ptr_table_fetch(PL_ptr_table, v);
11113 /* see if it is part of the interpreter structure */
11114 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11115 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11123 /* duplicate the save stack */
11126 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11128 ANY *ss = proto_perl->Tsavestack;
11129 I32 ix = proto_perl->Tsavestack_ix;
11130 I32 max = proto_perl->Tsavestack_max;
11143 void (*dptr) (void*);
11144 void (*dxptr) (pTHX_ void*);
11147 Newz(54, nss, max, ANY);
11151 TOPINT(nss,ix) = i;
11153 case SAVEt_ITEM: /* normal string */
11154 sv = (SV*)POPPTR(ss,ix);
11155 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11156 sv = (SV*)POPPTR(ss,ix);
11157 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11159 case SAVEt_SV: /* scalar reference */
11160 sv = (SV*)POPPTR(ss,ix);
11161 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11162 gv = (GV*)POPPTR(ss,ix);
11163 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11165 case SAVEt_GENERIC_PVREF: /* generic char* */
11166 c = (char*)POPPTR(ss,ix);
11167 TOPPTR(nss,ix) = pv_dup(c);
11168 ptr = POPPTR(ss,ix);
11169 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11171 case SAVEt_SHARED_PVREF: /* char* in shared space */
11172 c = (char*)POPPTR(ss,ix);
11173 TOPPTR(nss,ix) = savesharedpv(c);
11174 ptr = POPPTR(ss,ix);
11175 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11177 case SAVEt_GENERIC_SVREF: /* generic sv */
11178 case SAVEt_SVREF: /* scalar reference */
11179 sv = (SV*)POPPTR(ss,ix);
11180 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11181 ptr = POPPTR(ss,ix);
11182 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11184 case SAVEt_AV: /* array reference */
11185 av = (AV*)POPPTR(ss,ix);
11186 TOPPTR(nss,ix) = av_dup_inc(av, param);
11187 gv = (GV*)POPPTR(ss,ix);
11188 TOPPTR(nss,ix) = gv_dup(gv, param);
11190 case SAVEt_HV: /* hash reference */
11191 hv = (HV*)POPPTR(ss,ix);
11192 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11193 gv = (GV*)POPPTR(ss,ix);
11194 TOPPTR(nss,ix) = gv_dup(gv, param);
11196 case SAVEt_INT: /* int reference */
11197 ptr = POPPTR(ss,ix);
11198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11199 intval = (int)POPINT(ss,ix);
11200 TOPINT(nss,ix) = intval;
11202 case SAVEt_LONG: /* long reference */
11203 ptr = POPPTR(ss,ix);
11204 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11205 longval = (long)POPLONG(ss,ix);
11206 TOPLONG(nss,ix) = longval;
11208 case SAVEt_I32: /* I32 reference */
11209 case SAVEt_I16: /* I16 reference */
11210 case SAVEt_I8: /* I8 reference */
11211 ptr = POPPTR(ss,ix);
11212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11214 TOPINT(nss,ix) = i;
11216 case SAVEt_IV: /* IV reference */
11217 ptr = POPPTR(ss,ix);
11218 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11220 TOPIV(nss,ix) = iv;
11222 case SAVEt_SPTR: /* SV* reference */
11223 ptr = POPPTR(ss,ix);
11224 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11225 sv = (SV*)POPPTR(ss,ix);
11226 TOPPTR(nss,ix) = sv_dup(sv, param);
11228 case SAVEt_VPTR: /* random* reference */
11229 ptr = POPPTR(ss,ix);
11230 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11231 ptr = POPPTR(ss,ix);
11232 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11234 case SAVEt_PPTR: /* char* reference */
11235 ptr = POPPTR(ss,ix);
11236 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11237 c = (char*)POPPTR(ss,ix);
11238 TOPPTR(nss,ix) = pv_dup(c);
11240 case SAVEt_HPTR: /* HV* reference */
11241 ptr = POPPTR(ss,ix);
11242 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11243 hv = (HV*)POPPTR(ss,ix);
11244 TOPPTR(nss,ix) = hv_dup(hv, param);
11246 case SAVEt_APTR: /* AV* reference */
11247 ptr = POPPTR(ss,ix);
11248 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11249 av = (AV*)POPPTR(ss,ix);
11250 TOPPTR(nss,ix) = av_dup(av, param);
11253 gv = (GV*)POPPTR(ss,ix);
11254 TOPPTR(nss,ix) = gv_dup(gv, param);
11256 case SAVEt_GP: /* scalar reference */
11257 gp = (GP*)POPPTR(ss,ix);
11258 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11259 (void)GpREFCNT_inc(gp);
11260 gv = (GV*)POPPTR(ss,ix);
11261 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11262 c = (char*)POPPTR(ss,ix);
11263 TOPPTR(nss,ix) = pv_dup(c);
11265 TOPIV(nss,ix) = iv;
11267 TOPIV(nss,ix) = iv;
11270 case SAVEt_MORTALIZESV:
11271 sv = (SV*)POPPTR(ss,ix);
11272 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11275 ptr = POPPTR(ss,ix);
11276 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11277 /* these are assumed to be refcounted properly */
11278 switch (((OP*)ptr)->op_type) {
11280 case OP_LEAVESUBLV:
11284 case OP_LEAVEWRITE:
11285 TOPPTR(nss,ix) = ptr;
11290 TOPPTR(nss,ix) = Nullop;
11295 TOPPTR(nss,ix) = Nullop;
11298 c = (char*)POPPTR(ss,ix);
11299 TOPPTR(nss,ix) = pv_dup_inc(c);
11301 case SAVEt_CLEARSV:
11302 longval = POPLONG(ss,ix);
11303 TOPLONG(nss,ix) = longval;
11306 hv = (HV*)POPPTR(ss,ix);
11307 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11308 c = (char*)POPPTR(ss,ix);
11309 TOPPTR(nss,ix) = pv_dup_inc(c);
11311 TOPINT(nss,ix) = i;
11313 case SAVEt_DESTRUCTOR:
11314 ptr = POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11316 dptr = POPDPTR(ss,ix);
11317 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11319 case SAVEt_DESTRUCTOR_X:
11320 ptr = POPPTR(ss,ix);
11321 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11322 dxptr = POPDXPTR(ss,ix);
11323 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11325 case SAVEt_REGCONTEXT:
11328 TOPINT(nss,ix) = i;
11331 case SAVEt_STACK_POS: /* Position on Perl stack */
11333 TOPINT(nss,ix) = i;
11335 case SAVEt_AELEM: /* array element */
11336 sv = (SV*)POPPTR(ss,ix);
11337 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11339 TOPINT(nss,ix) = i;
11340 av = (AV*)POPPTR(ss,ix);
11341 TOPPTR(nss,ix) = av_dup_inc(av, param);
11343 case SAVEt_HELEM: /* hash element */
11344 sv = (SV*)POPPTR(ss,ix);
11345 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11346 sv = (SV*)POPPTR(ss,ix);
11347 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11348 hv = (HV*)POPPTR(ss,ix);
11349 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11352 ptr = POPPTR(ss,ix);
11353 TOPPTR(nss,ix) = ptr;
11357 TOPINT(nss,ix) = i;
11359 case SAVEt_COMPPAD:
11360 av = (AV*)POPPTR(ss,ix);
11361 TOPPTR(nss,ix) = av_dup(av, param);
11364 longval = (long)POPLONG(ss,ix);
11365 TOPLONG(nss,ix) = longval;
11366 ptr = POPPTR(ss,ix);
11367 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11368 sv = (SV*)POPPTR(ss,ix);
11369 TOPPTR(nss,ix) = sv_dup(sv, param);
11372 ptr = POPPTR(ss,ix);
11373 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11374 longval = (long)POPBOOL(ss,ix);
11375 TOPBOOL(nss,ix) = (bool)longval;
11377 case SAVEt_SET_SVFLAGS:
11379 TOPINT(nss,ix) = i;
11381 TOPINT(nss,ix) = i;
11382 sv = (SV*)POPPTR(ss,ix);
11383 TOPPTR(nss,ix) = sv_dup(sv, param);
11386 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11394 =for apidoc perl_clone
11396 Create and return a new interpreter by cloning the current one.
11398 perl_clone takes these flags as parameters:
11400 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11401 without it we only clone the data and zero the stacks,
11402 with it we copy the stacks and the new perl interpreter is
11403 ready to run at the exact same point as the previous one.
11404 The pseudo-fork code uses COPY_STACKS while the
11405 threads->new doesn't.
11407 CLONEf_KEEP_PTR_TABLE
11408 perl_clone keeps a ptr_table with the pointer of the old
11409 variable as a key and the new variable as a value,
11410 this allows it to check if something has been cloned and not
11411 clone it again but rather just use the value and increase the
11412 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11413 the ptr_table using the function
11414 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11415 reason to keep it around is if you want to dup some of your own
11416 variable who are outside the graph perl scans, example of this
11417 code is in threads.xs create
11420 This is a win32 thing, it is ignored on unix, it tells perls
11421 win32host code (which is c++) to clone itself, this is needed on
11422 win32 if you want to run two threads at the same time,
11423 if you just want to do some stuff in a separate perl interpreter
11424 and then throw it away and return to the original one,
11425 you don't need to do anything.
11430 /* XXX the above needs expanding by someone who actually understands it ! */
11431 EXTERN_C PerlInterpreter *
11432 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11435 perl_clone(PerlInterpreter *proto_perl, UV flags)
11437 #ifdef PERL_IMPLICIT_SYS
11439 /* perlhost.h so we need to call into it
11440 to clone the host, CPerlHost should have a c interface, sky */
11442 if (flags & CLONEf_CLONE_HOST) {
11443 return perl_clone_host(proto_perl,flags);
11445 return perl_clone_using(proto_perl, flags,
11447 proto_perl->IMemShared,
11448 proto_perl->IMemParse,
11450 proto_perl->IStdIO,
11454 proto_perl->IProc);
11458 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11459 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11460 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11461 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11462 struct IPerlDir* ipD, struct IPerlSock* ipS,
11463 struct IPerlProc* ipP)
11465 /* XXX many of the string copies here can be optimized if they're
11466 * constants; they need to be allocated as common memory and just
11467 * their pointers copied. */
11470 CLONE_PARAMS clone_params;
11471 CLONE_PARAMS* param = &clone_params;
11473 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11474 PERL_SET_THX(my_perl);
11477 Poison(my_perl, 1, PerlInterpreter);
11481 PL_savestack_ix = 0;
11482 PL_savestack_max = -1;
11483 PL_sig_pending = 0;
11484 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11485 # else /* !DEBUGGING */
11486 Zero(my_perl, 1, PerlInterpreter);
11487 # endif /* DEBUGGING */
11489 /* host pointers */
11491 PL_MemShared = ipMS;
11492 PL_MemParse = ipMP;
11499 #else /* !PERL_IMPLICIT_SYS */
11501 CLONE_PARAMS clone_params;
11502 CLONE_PARAMS* param = &clone_params;
11503 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11504 PERL_SET_THX(my_perl);
11509 Poison(my_perl, 1, PerlInterpreter);
11513 PL_savestack_ix = 0;
11514 PL_savestack_max = -1;
11515 PL_sig_pending = 0;
11516 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11517 # else /* !DEBUGGING */
11518 Zero(my_perl, 1, PerlInterpreter);
11519 # endif /* DEBUGGING */
11520 #endif /* PERL_IMPLICIT_SYS */
11521 param->flags = flags;
11522 param->proto_perl = proto_perl;
11525 PL_xiv_arenaroot = NULL;
11526 PL_xiv_root = NULL;
11527 PL_xnv_arenaroot = NULL;
11528 PL_xnv_root = NULL;
11529 PL_xrv_arenaroot = NULL;
11530 PL_xrv_root = NULL;
11531 PL_xpv_arenaroot = NULL;
11532 PL_xpv_root = NULL;
11533 PL_xpviv_arenaroot = NULL;
11534 PL_xpviv_root = NULL;
11535 PL_xpvnv_arenaroot = NULL;
11536 PL_xpvnv_root = NULL;
11537 PL_xpvcv_arenaroot = NULL;
11538 PL_xpvcv_root = NULL;
11539 PL_xpvav_arenaroot = NULL;
11540 PL_xpvav_root = NULL;
11541 PL_xpvhv_arenaroot = NULL;
11542 PL_xpvhv_root = NULL;
11543 PL_xpvmg_arenaroot = NULL;
11544 PL_xpvmg_root = NULL;
11545 PL_xpvlv_arenaroot = NULL;
11546 PL_xpvlv_root = NULL;
11547 PL_xpvbm_arenaroot = NULL;
11548 PL_xpvbm_root = NULL;
11549 PL_he_arenaroot = NULL;
11551 PL_nice_chunk = NULL;
11552 PL_nice_chunk_size = 0;
11554 PL_sv_objcount = 0;
11555 PL_sv_root = Nullsv;
11556 PL_sv_arenaroot = Nullsv;
11558 PL_debug = proto_perl->Idebug;
11560 #ifdef USE_REENTRANT_API
11561 /* XXX: things like -Dm will segfault here in perlio, but doing
11562 * PERL_SET_CONTEXT(proto_perl);
11563 * breaks too many other things
11565 Perl_reentrant_init(aTHX);
11568 /* create SV map for pointer relocation */
11569 PL_ptr_table = ptr_table_new();
11571 /* initialize these special pointers as early as possible */
11572 SvANY(&PL_sv_undef) = NULL;
11573 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11574 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11575 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11577 SvANY(&PL_sv_no) = new_XPVNV();
11578 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11579 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11580 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11581 SvCUR(&PL_sv_no) = 0;
11582 SvLEN(&PL_sv_no) = 1;
11583 SvNVX(&PL_sv_no) = 0;
11584 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11586 SvANY(&PL_sv_yes) = new_XPVNV();
11587 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11588 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11589 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11590 SvCUR(&PL_sv_yes) = 1;
11591 SvLEN(&PL_sv_yes) = 2;
11592 SvNVX(&PL_sv_yes) = 1;
11593 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11595 /* create (a non-shared!) shared string table */
11596 PL_strtab = newHV();
11597 HvSHAREKEYS_off(PL_strtab);
11598 hv_ksplit(PL_strtab, 512);
11599 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11601 PL_compiling = proto_perl->Icompiling;
11603 /* These two PVs will be free'd special way so must set them same way op.c does */
11604 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11605 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11607 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11608 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11610 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11611 if (!specialWARN(PL_compiling.cop_warnings))
11612 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11613 if (!specialCopIO(PL_compiling.cop_io))
11614 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11615 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11617 /* pseudo environmental stuff */
11618 PL_origargc = proto_perl->Iorigargc;
11619 PL_origargv = proto_perl->Iorigargv;
11621 param->stashes = newAV(); /* Setup array of objects to call clone on */
11623 #ifdef PERLIO_LAYERS
11624 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11625 PerlIO_clone(aTHX_ proto_perl, param);
11628 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11629 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11630 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11631 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11632 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11633 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11636 PL_minus_c = proto_perl->Iminus_c;
11637 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11638 PL_localpatches = proto_perl->Ilocalpatches;
11639 PL_splitstr = proto_perl->Isplitstr;
11640 PL_preprocess = proto_perl->Ipreprocess;
11641 PL_minus_n = proto_perl->Iminus_n;
11642 PL_minus_p = proto_perl->Iminus_p;
11643 PL_minus_l = proto_perl->Iminus_l;
11644 PL_minus_a = proto_perl->Iminus_a;
11645 PL_minus_F = proto_perl->Iminus_F;
11646 PL_doswitches = proto_perl->Idoswitches;
11647 PL_dowarn = proto_perl->Idowarn;
11648 PL_doextract = proto_perl->Idoextract;
11649 PL_sawampersand = proto_perl->Isawampersand;
11650 PL_unsafe = proto_perl->Iunsafe;
11651 PL_inplace = SAVEPV(proto_perl->Iinplace);
11652 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11653 PL_perldb = proto_perl->Iperldb;
11654 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11655 PL_exit_flags = proto_perl->Iexit_flags;
11657 /* magical thingies */
11658 /* XXX time(&PL_basetime) when asked for? */
11659 PL_basetime = proto_perl->Ibasetime;
11660 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11662 PL_maxsysfd = proto_perl->Imaxsysfd;
11663 PL_multiline = proto_perl->Imultiline;
11664 PL_statusvalue = proto_perl->Istatusvalue;
11666 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11668 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11670 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11671 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11672 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11674 /* Clone the regex array */
11675 PL_regex_padav = newAV();
11677 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11678 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11679 av_push(PL_regex_padav,
11680 sv_dup_inc(regexen[0],param));
11681 for(i = 1; i <= len; i++) {
11682 if(SvREPADTMP(regexen[i])) {
11683 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11685 av_push(PL_regex_padav,
11687 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11688 SvIVX(regexen[i])), param)))
11693 PL_regex_pad = AvARRAY(PL_regex_padav);
11695 /* shortcuts to various I/O objects */
11696 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11697 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11698 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11699 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11700 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11701 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11703 /* shortcuts to regexp stuff */
11704 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11706 /* shortcuts to misc objects */
11707 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11709 /* shortcuts to debugging objects */
11710 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11711 PL_DBline = gv_dup(proto_perl->IDBline, param);
11712 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11713 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11714 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11715 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11716 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11717 PL_lineary = av_dup(proto_perl->Ilineary, param);
11718 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11720 /* symbol tables */
11721 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11722 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11723 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11724 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11725 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11727 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11728 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11729 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11730 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11731 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11732 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11734 PL_sub_generation = proto_perl->Isub_generation;
11736 /* funky return mechanisms */
11737 PL_forkprocess = proto_perl->Iforkprocess;
11739 /* subprocess state */
11740 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11742 /* internal state */
11743 PL_tainting = proto_perl->Itainting;
11744 PL_taint_warn = proto_perl->Itaint_warn;
11745 PL_maxo = proto_perl->Imaxo;
11746 if (proto_perl->Iop_mask)
11747 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11749 PL_op_mask = Nullch;
11750 /* PL_asserting = proto_perl->Iasserting; */
11752 /* current interpreter roots */
11753 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11754 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11755 PL_main_start = proto_perl->Imain_start;
11756 PL_eval_root = proto_perl->Ieval_root;
11757 PL_eval_start = proto_perl->Ieval_start;
11759 /* runtime control stuff */
11760 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11761 PL_copline = proto_perl->Icopline;
11763 PL_filemode = proto_perl->Ifilemode;
11764 PL_lastfd = proto_perl->Ilastfd;
11765 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11768 PL_gensym = proto_perl->Igensym;
11769 PL_preambled = proto_perl->Ipreambled;
11770 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11771 PL_laststatval = proto_perl->Ilaststatval;
11772 PL_laststype = proto_perl->Ilaststype;
11773 PL_mess_sv = Nullsv;
11775 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11776 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11778 /* interpreter atexit processing */
11779 PL_exitlistlen = proto_perl->Iexitlistlen;
11780 if (PL_exitlistlen) {
11781 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11782 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11785 PL_exitlist = (PerlExitListEntry*)NULL;
11786 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11787 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11788 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11790 PL_profiledata = NULL;
11791 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11792 /* PL_rsfp_filters entries have fake IoDIRP() */
11793 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11795 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11797 PAD_CLONE_VARS(proto_perl, param);
11799 #ifdef HAVE_INTERP_INTERN
11800 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11803 /* more statics moved here */
11804 PL_generation = proto_perl->Igeneration;
11805 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11807 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11808 PL_in_clean_all = proto_perl->Iin_clean_all;
11810 PL_uid = proto_perl->Iuid;
11811 PL_euid = proto_perl->Ieuid;
11812 PL_gid = proto_perl->Igid;
11813 PL_egid = proto_perl->Iegid;
11814 PL_nomemok = proto_perl->Inomemok;
11815 PL_an = proto_perl->Ian;
11816 PL_evalseq = proto_perl->Ievalseq;
11817 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11818 PL_origalen = proto_perl->Iorigalen;
11819 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11820 PL_osname = SAVEPV(proto_perl->Iosname);
11821 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11822 PL_sighandlerp = proto_perl->Isighandlerp;
11825 PL_runops = proto_perl->Irunops;
11827 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11830 PL_cshlen = proto_perl->Icshlen;
11831 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11834 PL_lex_state = proto_perl->Ilex_state;
11835 PL_lex_defer = proto_perl->Ilex_defer;
11836 PL_lex_expect = proto_perl->Ilex_expect;
11837 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11838 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11839 PL_lex_starts = proto_perl->Ilex_starts;
11840 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11841 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11842 PL_lex_op = proto_perl->Ilex_op;
11843 PL_lex_inpat = proto_perl->Ilex_inpat;
11844 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11845 PL_lex_brackets = proto_perl->Ilex_brackets;
11846 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11847 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11848 PL_lex_casemods = proto_perl->Ilex_casemods;
11849 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11850 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11852 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11853 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11854 PL_nexttoke = proto_perl->Inexttoke;
11856 /* XXX This is probably masking the deeper issue of why
11857 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11858 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11859 * (A little debugging with a watchpoint on it may help.)
11861 if (SvANY(proto_perl->Ilinestr)) {
11862 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11863 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11864 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11865 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11866 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11867 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11868 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11869 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11870 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11873 PL_linestr = NEWSV(65,79);
11874 sv_upgrade(PL_linestr,SVt_PVIV);
11875 sv_setpvn(PL_linestr,"",0);
11876 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11878 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11879 PL_pending_ident = proto_perl->Ipending_ident;
11880 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11882 PL_expect = proto_perl->Iexpect;
11884 PL_multi_start = proto_perl->Imulti_start;
11885 PL_multi_end = proto_perl->Imulti_end;
11886 PL_multi_open = proto_perl->Imulti_open;
11887 PL_multi_close = proto_perl->Imulti_close;
11889 PL_error_count = proto_perl->Ierror_count;
11890 PL_subline = proto_perl->Isubline;
11891 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11893 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11894 if (SvANY(proto_perl->Ilinestr)) {
11895 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11896 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11897 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11898 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11899 PL_last_lop_op = proto_perl->Ilast_lop_op;
11902 PL_last_uni = SvPVX(PL_linestr);
11903 PL_last_lop = SvPVX(PL_linestr);
11904 PL_last_lop_op = 0;
11906 PL_in_my = proto_perl->Iin_my;
11907 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11909 PL_cryptseen = proto_perl->Icryptseen;
11912 PL_hints = proto_perl->Ihints;
11914 PL_amagic_generation = proto_perl->Iamagic_generation;
11916 #ifdef USE_LOCALE_COLLATE
11917 PL_collation_ix = proto_perl->Icollation_ix;
11918 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11919 PL_collation_standard = proto_perl->Icollation_standard;
11920 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11921 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11922 #endif /* USE_LOCALE_COLLATE */
11924 #ifdef USE_LOCALE_NUMERIC
11925 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11926 PL_numeric_standard = proto_perl->Inumeric_standard;
11927 PL_numeric_local = proto_perl->Inumeric_local;
11928 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11929 #endif /* !USE_LOCALE_NUMERIC */
11931 /* utf8 character classes */
11932 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11933 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11934 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11935 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11936 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11937 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11938 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11939 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11940 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11941 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11942 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11943 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11944 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11945 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11946 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11947 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11948 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11949 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11950 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11951 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11953 /* Did the locale setup indicate UTF-8? */
11954 PL_utf8locale = proto_perl->Iutf8locale;
11955 /* Unicode features (see perlrun/-C) */
11956 PL_unicode = proto_perl->Iunicode;
11958 /* Pre-5.8 signals control */
11959 PL_signals = proto_perl->Isignals;
11961 /* times() ticks per second */
11962 PL_clocktick = proto_perl->Iclocktick;
11964 /* Recursion stopper for PerlIO_find_layer */
11965 PL_in_load_module = proto_perl->Iin_load_module;
11967 /* sort() routine */
11968 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11970 /* Not really needed/useful since the reenrant_retint is "volatile",
11971 * but do it for consistency's sake. */
11972 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11974 /* Hooks to shared SVs and locks. */
11975 PL_sharehook = proto_perl->Isharehook;
11976 PL_lockhook = proto_perl->Ilockhook;
11977 PL_unlockhook = proto_perl->Iunlockhook;
11978 PL_threadhook = proto_perl->Ithreadhook;
11980 PL_runops_std = proto_perl->Irunops_std;
11981 PL_runops_dbg = proto_perl->Irunops_dbg;
11983 #ifdef THREADS_HAVE_PIDS
11984 PL_ppid = proto_perl->Ippid;
11988 PL_last_swash_hv = Nullhv; /* reinits on demand */
11989 PL_last_swash_klen = 0;
11990 PL_last_swash_key[0]= '\0';
11991 PL_last_swash_tmps = (U8*)NULL;
11992 PL_last_swash_slen = 0;
11994 PL_glob_index = proto_perl->Iglob_index;
11995 PL_srand_called = proto_perl->Isrand_called;
11996 PL_hash_seed = proto_perl->Ihash_seed;
11997 PL_rehash_seed = proto_perl->Irehash_seed;
11998 PL_uudmap['M'] = 0; /* reinits on demand */
11999 PL_bitcount = Nullch; /* reinits on demand */
12001 if (proto_perl->Ipsig_pend) {
12002 Newz(0, PL_psig_pend, SIG_SIZE, int);
12005 PL_psig_pend = (int*)NULL;
12008 if (proto_perl->Ipsig_ptr) {
12009 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12010 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12011 for (i = 1; i < SIG_SIZE; i++) {
12012 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12013 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12017 PL_psig_ptr = (SV**)NULL;
12018 PL_psig_name = (SV**)NULL;
12021 /* thrdvar.h stuff */
12023 if (flags & CLONEf_COPY_STACKS) {
12024 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12025 PL_tmps_ix = proto_perl->Ttmps_ix;
12026 PL_tmps_max = proto_perl->Ttmps_max;
12027 PL_tmps_floor = proto_perl->Ttmps_floor;
12028 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12030 while (i <= PL_tmps_ix) {
12031 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12035 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12036 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12037 Newz(54, PL_markstack, i, I32);
12038 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12039 - proto_perl->Tmarkstack);
12040 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12041 - proto_perl->Tmarkstack);
12042 Copy(proto_perl->Tmarkstack, PL_markstack,
12043 PL_markstack_ptr - PL_markstack + 1, I32);
12045 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12046 * NOTE: unlike the others! */
12047 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12048 PL_scopestack_max = proto_perl->Tscopestack_max;
12049 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12050 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12052 /* NOTE: si_dup() looks at PL_markstack */
12053 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12055 /* PL_curstack = PL_curstackinfo->si_stack; */
12056 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12057 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12059 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12060 PL_stack_base = AvARRAY(PL_curstack);
12061 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12062 - proto_perl->Tstack_base);
12063 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12065 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12066 * NOTE: unlike the others! */
12067 PL_savestack_ix = proto_perl->Tsavestack_ix;
12068 PL_savestack_max = proto_perl->Tsavestack_max;
12069 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12070 PL_savestack = ss_dup(proto_perl, param);
12074 ENTER; /* perl_destruct() wants to LEAVE; */
12077 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12078 PL_top_env = &PL_start_env;
12080 PL_op = proto_perl->Top;
12083 PL_Xpv = (XPV*)NULL;
12084 PL_na = proto_perl->Tna;
12086 PL_statbuf = proto_perl->Tstatbuf;
12087 PL_statcache = proto_perl->Tstatcache;
12088 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12089 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12091 PL_timesbuf = proto_perl->Ttimesbuf;
12094 PL_tainted = proto_perl->Ttainted;
12095 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12096 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12097 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12098 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12099 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12100 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12101 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12102 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12103 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12105 PL_restartop = proto_perl->Trestartop;
12106 PL_in_eval = proto_perl->Tin_eval;
12107 PL_delaymagic = proto_perl->Tdelaymagic;
12108 PL_dirty = proto_perl->Tdirty;
12109 PL_localizing = proto_perl->Tlocalizing;
12111 #ifdef PERL_FLEXIBLE_EXCEPTIONS
12112 PL_protect = proto_perl->Tprotect;
12114 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12115 PL_hv_fetch_ent_mh = Nullhe;
12116 PL_modcount = proto_perl->Tmodcount;
12117 PL_lastgotoprobe = Nullop;
12118 PL_dumpindent = proto_perl->Tdumpindent;
12120 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12121 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12122 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12123 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12124 PL_sortcxix = proto_perl->Tsortcxix;
12125 PL_efloatbuf = Nullch; /* reinits on demand */
12126 PL_efloatsize = 0; /* reinits on demand */
12130 PL_screamfirst = NULL;
12131 PL_screamnext = NULL;
12132 PL_maxscream = -1; /* reinits on demand */
12133 PL_lastscream = Nullsv;
12135 PL_watchaddr = NULL;
12136 PL_watchok = Nullch;
12138 PL_regdummy = proto_perl->Tregdummy;
12139 PL_regprecomp = Nullch;
12142 PL_colorset = 0; /* reinits PL_colors[] */
12143 /*PL_colors[6] = {0,0,0,0,0,0};*/
12144 PL_reginput = Nullch;
12145 PL_regbol = Nullch;
12146 PL_regeol = Nullch;
12147 PL_regstartp = (I32*)NULL;
12148 PL_regendp = (I32*)NULL;
12149 PL_reglastparen = (U32*)NULL;
12150 PL_reglastcloseparen = (U32*)NULL;
12151 PL_regtill = Nullch;
12152 PL_reg_start_tmp = (char**)NULL;
12153 PL_reg_start_tmpl = 0;
12154 PL_regdata = (struct reg_data*)NULL;
12157 PL_reg_eval_set = 0;
12159 PL_regprogram = (regnode*)NULL;
12161 PL_regcc = (CURCUR*)NULL;
12162 PL_reg_call_cc = (struct re_cc_state*)NULL;
12163 PL_reg_re = (regexp*)NULL;
12164 PL_reg_ganch = Nullch;
12165 PL_reg_sv = Nullsv;
12166 PL_reg_match_utf8 = FALSE;
12167 PL_reg_magic = (MAGIC*)NULL;
12169 PL_reg_oldcurpm = (PMOP*)NULL;
12170 PL_reg_curpm = (PMOP*)NULL;
12171 PL_reg_oldsaved = Nullch;
12172 PL_reg_oldsavedlen = 0;
12173 #ifdef PERL_COPY_ON_WRITE
12176 PL_reg_maxiter = 0;
12177 PL_reg_leftiter = 0;
12178 PL_reg_poscache = Nullch;
12179 PL_reg_poscache_size= 0;
12181 /* RE engine - function pointers */
12182 PL_regcompp = proto_perl->Tregcompp;
12183 PL_regexecp = proto_perl->Tregexecp;
12184 PL_regint_start = proto_perl->Tregint_start;
12185 PL_regint_string = proto_perl->Tregint_string;
12186 PL_regfree = proto_perl->Tregfree;
12188 PL_reginterp_cnt = 0;
12189 PL_reg_starttry = 0;
12191 /* Pluggable optimizer */
12192 PL_peepp = proto_perl->Tpeepp;
12194 PL_stashcache = newHV();
12196 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12197 ptr_table_free(PL_ptr_table);
12198 PL_ptr_table = NULL;
12201 /* Call the ->CLONE method, if it exists, for each of the stashes
12202 identified by sv_dup() above.
12204 while(av_len(param->stashes) != -1) {
12205 HV* stash = (HV*) av_shift(param->stashes);
12206 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12207 if (cloner && GvCV(cloner)) {
12212 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12214 call_sv((SV*)GvCV(cloner), G_DISCARD);
12220 SvREFCNT_dec(param->stashes);
12225 #endif /* USE_ITHREADS */
12228 =head1 Unicode Support
12230 =for apidoc sv_recode_to_utf8
12232 The encoding is assumed to be an Encode object, on entry the PV
12233 of the sv is assumed to be octets in that encoding, and the sv
12234 will be converted into Unicode (and UTF-8).
12236 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12237 is not a reference, nothing is done to the sv. If the encoding is not
12238 an C<Encode::XS> Encoding object, bad things will happen.
12239 (See F<lib/encoding.pm> and L<Encode>).
12241 The PV of the sv is returned.
12246 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12248 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12262 Passing sv_yes is wrong - it needs to be or'ed set of constants
12263 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12264 remove converted chars from source.
12266 Both will default the value - let them.
12268 XPUSHs(&PL_sv_yes);
12271 call_method("decode", G_SCALAR);
12275 s = SvPV(uni, len);
12276 if (s != SvPVX(sv)) {
12277 SvGROW(sv, len + 1);
12278 Move(s, SvPVX(sv), len, char);
12279 SvCUR_set(sv, len);
12280 SvPVX(sv)[len] = 0;
12290 =for apidoc sv_cat_decode
12292 The encoding is assumed to be an Encode object, the PV of the ssv is
12293 assumed to be octets in that encoding and decoding the input starts
12294 from the position which (PV + *offset) pointed to. The dsv will be
12295 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12296 when the string tstr appears in decoding output or the input ends on
12297 the PV of the ssv. The value which the offset points will be modified
12298 to the last input position on the ssv.
12300 Returns TRUE if the terminator was found, else returns FALSE.
12305 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12306 SV *ssv, int *offset, char *tstr, int tlen)
12309 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12320 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12321 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12323 call_method("cat_decode", G_SCALAR);
12325 ret = SvTRUE(TOPs);
12326 *offset = SvIV(offsv);
12332 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");