3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 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_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(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 by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and 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 list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
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..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
761 if (!cv || !CvPADLIST(cv))
763 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
764 sv = *av_fetch(av, targ, FALSE);
765 /* SvLEN in a pad name is not to be trusted */
766 sv_setpv(name, SvPV_nolen_const(sv));
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
773 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
776 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
778 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
780 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
781 sv_insert(name, 0, 0, "within ", 7);
788 =for apidoc find_uninit_var
790 Find the name of the undefined variable (if any) that caused the operator o
791 to issue a "Use of uninitialized value" warning.
792 If match is true, only return a name if it's value matches uninit_sv.
793 So roughly speaking, if a unary operator (such as OP_COS) generates a
794 warning, then following the direct child of the op may yield an
795 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
796 other hand, with OP_ADD there are two branches to follow, so we only print
797 the variable name if we get an exact match.
799 The name is returned as a mortal SV.
801 Assumes that PL_op is the op that originally triggered the error, and that
802 PL_comppad/PL_curpad points to the currently executing pad.
808 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
817 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
818 uninit_sv == &PL_sv_placeholder)))
821 switch (obase->op_type) {
828 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
829 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
832 int subscript_type = FUV_SUBSCRIPT_WITHIN;
834 if (pad) { /* @lex, %lex */
835 sv = PAD_SVl(obase->op_targ);
839 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
840 /* @global, %global */
841 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
844 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
846 else /* @{expr}, %{expr} */
847 return find_uninit_var(cUNOPx(obase)->op_first,
851 /* attempt to find a match within the aggregate */
853 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
855 subscript_type = FUV_SUBSCRIPT_HASH;
858 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
860 subscript_type = FUV_SUBSCRIPT_ARRAY;
863 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
866 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
867 keysv, index, subscript_type);
871 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
873 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
874 Nullsv, 0, FUV_SUBSCRIPT_NONE);
877 gv = cGVOPx_gv(obase);
878 if (!gv || (match && GvSV(gv) != uninit_sv))
880 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
883 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
885 av = (AV*)PAD_SV(obase->op_targ);
886 if (!av || SvRMAGICAL(av))
888 svp = av_fetch(av, (I32)obase->op_private, FALSE);
889 if (!svp || *svp != uninit_sv)
892 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
893 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
896 gv = cGVOPx_gv(obase);
901 if (!av || SvRMAGICAL(av))
903 svp = av_fetch(av, (I32)obase->op_private, FALSE);
904 if (!svp || *svp != uninit_sv)
907 return S_varname(aTHX_ gv, "$", 0,
908 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
913 o = cUNOPx(obase)->op_first;
914 if (!o || o->op_type != OP_NULL ||
915 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
917 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
922 /* $a[uninit_expr] or $h{uninit_expr} */
923 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
926 o = cBINOPx(obase)->op_first;
927 kid = cBINOPx(obase)->op_last;
929 /* get the av or hv, and optionally the gv */
931 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
932 sv = PAD_SV(o->op_targ);
934 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
935 && cUNOPo->op_first->op_type == OP_GV)
937 gv = cGVOPx_gv(cUNOPo->op_first);
940 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
945 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
946 /* index is constant */
950 if (obase->op_type == OP_HELEM) {
951 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
952 if (!he || HeVAL(he) != uninit_sv)
956 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
957 if (!svp || *svp != uninit_sv)
961 if (obase->op_type == OP_HELEM)
962 return S_varname(aTHX_ gv, "%", o->op_targ,
963 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
965 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
966 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
970 /* index is an expression;
971 * attempt to find a match within the aggregate */
972 if (obase->op_type == OP_HELEM) {
973 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
975 return S_varname(aTHX_ gv, "%", o->op_targ,
976 keysv, 0, FUV_SUBSCRIPT_HASH);
979 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
981 return S_varname(aTHX_ gv, "@", o->op_targ,
982 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
986 return S_varname(aTHX_ gv,
987 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
989 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
995 /* only examine RHS */
996 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
999 o = cUNOPx(obase)->op_first;
1000 if (o->op_type == OP_PUSHMARK)
1003 if (!o->op_sibling) {
1004 /* one-arg version of open is highly magical */
1006 if (o->op_type == OP_GV) { /* open FOO; */
1008 if (match && GvSV(gv) != uninit_sv)
1010 return S_varname(aTHX_ gv, "$", 0,
1011 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1013 /* other possibilities not handled are:
1014 * open $x; or open my $x; should return '${*$x}'
1015 * open expr; should return '$'.expr ideally
1021 /* ops where $_ may be an implicit arg */
1025 if ( !(obase->op_flags & OPf_STACKED)) {
1026 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1027 ? PAD_SVl(obase->op_targ)
1030 sv = sv_newmortal();
1031 sv_setpvn(sv, "$_", 2);
1039 /* skip filehandle as it can't produce 'undef' warning */
1040 o = cUNOPx(obase)->op_first;
1041 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1042 o = o->op_sibling->op_sibling;
1049 match = 1; /* XS or custom code could trigger random warnings */
1054 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1055 return sv_2mortal(newSVpv("${$/}", 0));
1060 if (!(obase->op_flags & OPf_KIDS))
1062 o = cUNOPx(obase)->op_first;
1068 /* if all except one arg are constant, or have no side-effects,
1069 * or are optimized away, then it's unambiguous */
1071 for (kid=o; kid; kid = kid->op_sibling) {
1073 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1074 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1075 || (kid->op_type == OP_PUSHMARK)
1079 if (o2) { /* more than one found */
1086 return find_uninit_var(o2, uninit_sv, match);
1090 sv = find_uninit_var(o, uninit_sv, 1);
1102 =for apidoc report_uninit
1104 Print appropriate "Use of uninitialized variable" warning
1110 Perl_report_uninit(pTHX_ SV* uninit_sv)
1113 SV* varname = Nullsv;
1115 varname = find_uninit_var(PL_op, uninit_sv,0);
1117 sv_insert(varname, 0, 0, " ", 1);
1119 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1120 varname ? SvPV_nolen_const(varname) : "",
1121 " in ", OP_DESC(PL_op));
1124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1129 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1133 size_t count = PERL_ARENA_SIZE/size;
1134 New(0, start, count*size, char);
1135 *((void **) start) = *arena_root;
1136 *arena_root = (void *)start;
1138 end = start + (count-1) * size;
1140 /* The initial slot is used to link the arenas together, so it isn't to be
1141 linked into the list of ready-to-use bodies. */
1145 *root = (void *)start;
1147 while (start < end) {
1148 char *next = start + size;
1149 *(void**) start = (void *)next;
1152 *(void **)start = 0;
1157 /* grab a new thing from the free list, allocating more if necessary */
1160 S_new_body(pTHX_ void **arena_root, void **root, size_t size, size_t offset)
1164 xpv = *root ? *root : S_more_bodies(aTHX_ arena_root, root, size);
1165 *root = *(void**)xpv;
1167 return (void*)((char*)xpv - offset);
1170 /* return a thing to the free list */
1173 S_del_body(pTHX_ void *thing, void **root, size_t offset)
1175 void **real_thing = (void**)((char *)thing + offset);
1177 *real_thing = *root;
1178 *root = (void*)real_thing;
1182 /* Conventionally we simply malloc() a big block of memory, then divide it
1183 up into lots of the thing that we're allocating.
1185 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1188 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1189 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1192 #define new_body(TYPE,lctype) \
1193 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1194 (void**)&PL_ ## lctype ## _root, \
1198 /* But for some types, we cheat. The type starts with some members that are
1199 never accessed. So we allocate the substructure, starting at the first used
1200 member, then adjust the pointer back in memory by the size of the bit not
1201 allocated, so it's as if we allocated the full structure.
1202 (But things will all go boom if you write to the part that is "not there",
1203 because you'll be overwriting the last members of the preceding structure
1206 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1207 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1208 and the pointer is unchanged. If the allocated structure is smaller (no
1209 initial NV actually allocated) then the net effect is to subtract the size
1210 of the NV from the pointer, to return a new pointer as if an initial NV were
1213 This is the same trick as was used for NV and IV bodies. Ironically it
1214 doesn't need to be used for NV bodies any more, because NV is now at the
1215 start of the structure. IV bodies don't need it either, because they are
1216 no longer allocated. */
1218 #define new_body_allocated(TYPE,lctype,member) \
1219 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1220 (void**)&PL_ ## lctype ## _root, \
1221 sizeof(lctype ## _allocated), \
1222 STRUCT_OFFSET(TYPE, member) \
1223 - STRUCT_OFFSET(lctype ## _allocated, member))
1226 #define del_body(p,TYPE,lctype) \
1227 S_del_body(aTHX_ (void*)p, (void**)&PL_ ## lctype ## _root, 0)
1229 #define del_body_allocated(p,TYPE,lctype,member) \
1230 S_del_body(aTHX_ (void*)p, (void**)&PL_ ## lctype ## _root, \
1231 STRUCT_OFFSET(TYPE, member) \
1232 - STRUCT_OFFSET(lctype ## _allocated, member))
1234 #define my_safemalloc(s) (void*)safemalloc(s)
1235 #define my_safefree(p) safefree((char*)p)
1239 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1240 #define del_XNV(p) my_safefree(p)
1242 #define new_XPV() my_safemalloc(sizeof(XPV))
1243 #define del_XPV(p) my_safefree(p)
1245 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1246 #define del_XPVIV(p) my_safefree(p)
1248 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1249 #define del_XPVNV(p) my_safefree(p)
1251 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1252 #define del_XPVCV(p) my_safefree(p)
1254 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1255 #define del_XPVAV(p) my_safefree(p)
1257 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1258 #define del_XPVHV(p) my_safefree(p)
1260 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1261 #define del_XPVMG(p) my_safefree(p)
1263 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1264 #define del_XPVGV(p) my_safefree(p)
1266 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1267 #define del_XPVLV(p) my_safefree(p)
1269 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1270 #define del_XPVBM(p) my_safefree(p)
1274 #define new_XNV() new_body(NV, xnv)
1275 #define del_XNV(p) del_body(p, NV, xnv)
1277 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1278 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1280 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1281 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1283 #define new_XPVNV() new_body(XPVNV, xpvnv)
1284 #define del_XPVNV(p) del_body(p, XPVNV, xpvnv)
1286 #define new_XPVCV() new_body(XPVCV, xpvcv)
1287 #define del_XPVCV(p) del_body(p, XPVCV, xpvcv)
1289 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1290 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1292 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1293 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1295 #define new_XPVMG() new_body(XPVMG, xpvmg)
1296 #define del_XPVMG(p) del_body(p, XPVMG, xpvmg)
1298 #define new_XPVGV() new_body(XPVGV, xpvgv)
1299 #define del_XPVGV(p) del_body(p, XPVGV, xpvgv)
1301 #define new_XPVLV() new_body(XPVLV, xpvlv)
1302 #define del_XPVLV(p) del_body(p, XPVLV, xpvlv)
1304 #define new_XPVBM() new_body(XPVBM, xpvbm)
1305 #define del_XPVBM(p) del_body(p, XPVBM, xpvbm)
1309 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1310 #define del_XPVFM(p) my_safefree(p)
1312 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1313 #define del_XPVIO(p) my_safefree(p)
1316 =for apidoc sv_upgrade
1318 Upgrade an SV to a more complex form. Generally adds a new body type to the
1319 SV, then copies across as much information as possible from the old body.
1320 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1326 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1336 void* old_body_arena;
1337 size_t old_body_offset;
1340 if (mt != SVt_PV && SvIsCOW(sv)) {
1341 sv_force_normal_flags(sv, 0);
1344 if (SvTYPE(sv) == mt)
1347 if (SvTYPE(sv) > mt)
1348 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1349 (int)SvTYPE(sv), (int)mt);
1359 old_body = SvANY(sv);
1361 old_body_offset = 0;
1363 switch (SvTYPE(sv)) {
1370 else if (mt < SVt_PVIV)
1375 old_body_arena = PL_xnv_root;
1381 pv = (char*)SvRV(sv);
1384 pv = SvPVX_mutable(sv);
1387 old_body_arena = PL_xpv_root;
1388 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1389 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1392 else if (mt == SVt_NV)
1396 pv = SvPVX_mutable(sv);
1400 old_body_arena = PL_xpviv_root;
1401 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1402 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1405 pv = SvPVX_mutable(sv);
1410 old_body_arena = PL_xpvnv_root;
1413 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1414 there's no way that it can be safely upgraded, because perl.c
1415 expects to Safefree(SvANY(PL_mess_sv)) */
1416 assert(sv != PL_mess_sv);
1417 /* This flag bit is used to mean other things in other scalar types.
1418 Given that it only has meaning inside the pad, it shouldn't be set
1419 on anything that can get upgraded. */
1420 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1421 pv = SvPVX_mutable(sv);
1426 magic = SvMAGIC(sv);
1427 stash = SvSTASH(sv);
1428 old_body_arena = PL_xpvmg_root;
1431 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1434 SvFLAGS(sv) &= ~SVTYPEMASK;
1439 Perl_croak(aTHX_ "Can't upgrade to undef");
1441 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1445 SvANY(sv) = new_XNV();
1449 SvANY(sv) = &sv->sv_u.svu_rv;
1450 SvRV_set(sv, (SV*)pv);
1453 SvANY(sv) = new_XPVHV();
1456 HvTOTALKEYS(sv) = 0;
1458 /* Fall through... */
1461 SvANY(sv) = new_XPVAV();
1468 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1470 /* FIXME. Should be able to remove all this if()... if the above
1471 assertion is genuinely always true. */
1474 SvFLAGS(sv) &= ~SVf_OOK;
1477 SvPV_set(sv, (char*)0);
1478 SvMAGIC_set(sv, magic);
1479 SvSTASH_set(sv, stash);
1483 SvANY(sv) = new_XPVIO();
1484 Zero(SvANY(sv), 1, XPVIO);
1485 IoPAGE_LEN(sv) = 60;
1486 goto set_magic_common;
1488 SvANY(sv) = new_XPVFM();
1489 Zero(SvANY(sv), 1, XPVFM);
1490 goto set_magic_common;
1492 SvANY(sv) = new_XPVBM();
1496 goto set_magic_common;
1498 SvANY(sv) = new_XPVGV();
1504 goto set_magic_common;
1506 SvANY(sv) = new_XPVCV();
1507 Zero(SvANY(sv), 1, XPVCV);
1508 goto set_magic_common;
1510 SvANY(sv) = new_XPVLV();
1523 SvANY(sv) = new_XPVMG();
1526 SvMAGIC_set(sv, magic);
1527 SvSTASH_set(sv, stash);
1531 SvANY(sv) = new_XPVNV();
1537 SvANY(sv) = new_XPVIV();
1546 SvANY(sv) = new_XPV();
1555 if (old_body_arena) {
1557 my_safefree(old_body)
1559 S_del_body(aTHX_ old_body, old_body_arena, old_body_offset);
1565 =for apidoc sv_backoff
1567 Remove any string offset. You should normally use the C<SvOOK_off> macro
1574 Perl_sv_backoff(pTHX_ register SV *sv)
1577 assert(SvTYPE(sv) != SVt_PVHV);
1578 assert(SvTYPE(sv) != SVt_PVAV);
1580 const char *s = SvPVX_const(sv);
1581 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1582 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1584 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1586 SvFLAGS(sv) &= ~SVf_OOK;
1593 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1594 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1595 Use the C<SvGROW> wrapper instead.
1601 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1605 #ifdef HAS_64K_LIMIT
1606 if (newlen >= 0x10000) {
1607 PerlIO_printf(Perl_debug_log,
1608 "Allocation too large: %"UVxf"\n", (UV)newlen);
1611 #endif /* HAS_64K_LIMIT */
1614 if (SvTYPE(sv) < SVt_PV) {
1615 sv_upgrade(sv, SVt_PV);
1616 s = SvPVX_mutable(sv);
1618 else if (SvOOK(sv)) { /* pv is offset? */
1620 s = SvPVX_mutable(sv);
1621 if (newlen > SvLEN(sv))
1622 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1623 #ifdef HAS_64K_LIMIT
1624 if (newlen >= 0x10000)
1629 s = SvPVX_mutable(sv);
1631 if (newlen > SvLEN(sv)) { /* need more room? */
1632 newlen = PERL_STRLEN_ROUNDUP(newlen);
1633 if (SvLEN(sv) && s) {
1635 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1641 s = saferealloc(s, newlen);
1644 s = safemalloc(newlen);
1645 if (SvPVX_const(sv) && SvCUR(sv)) {
1646 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1650 SvLEN_set(sv, newlen);
1656 =for apidoc sv_setiv
1658 Copies an integer into the given SV, upgrading first if necessary.
1659 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1665 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1667 SV_CHECK_THINKFIRST_COW_DROP(sv);
1668 switch (SvTYPE(sv)) {
1670 sv_upgrade(sv, SVt_IV);
1673 sv_upgrade(sv, SVt_PVNV);
1677 sv_upgrade(sv, SVt_PVIV);
1686 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1689 (void)SvIOK_only(sv); /* validate number */
1695 =for apidoc sv_setiv_mg
1697 Like C<sv_setiv>, but also handles 'set' magic.
1703 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1710 =for apidoc sv_setuv
1712 Copies an unsigned integer into the given SV, upgrading first if necessary.
1713 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1719 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1721 /* With these two if statements:
1722 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1725 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1727 If you wish to remove them, please benchmark to see what the effect is
1729 if (u <= (UV)IV_MAX) {
1730 sv_setiv(sv, (IV)u);
1739 =for apidoc sv_setuv_mg
1741 Like C<sv_setuv>, but also handles 'set' magic.
1747 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1749 /* With these two if statements:
1750 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1753 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1755 If you wish to remove them, please benchmark to see what the effect is
1757 if (u <= (UV)IV_MAX) {
1758 sv_setiv(sv, (IV)u);
1768 =for apidoc sv_setnv
1770 Copies a double into the given SV, upgrading first if necessary.
1771 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1777 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1779 SV_CHECK_THINKFIRST_COW_DROP(sv);
1780 switch (SvTYPE(sv)) {
1783 sv_upgrade(sv, SVt_NV);
1788 sv_upgrade(sv, SVt_PVNV);
1797 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1801 (void)SvNOK_only(sv); /* validate number */
1806 =for apidoc sv_setnv_mg
1808 Like C<sv_setnv>, but also handles 'set' magic.
1814 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1820 /* Print an "isn't numeric" warning, using a cleaned-up,
1821 * printable version of the offending string
1825 S_not_a_number(pTHX_ SV *sv)
1832 dsv = sv_2mortal(newSVpv("", 0));
1833 pv = sv_uni_display(dsv, sv, 10, 0);
1836 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1837 /* each *s can expand to 4 chars + "...\0",
1838 i.e. need room for 8 chars */
1840 const char *s, *end;
1841 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1844 if (ch & 128 && !isPRINT_LC(ch)) {
1853 else if (ch == '\r') {
1857 else if (ch == '\f') {
1861 else if (ch == '\\') {
1865 else if (ch == '\0') {
1869 else if (isPRINT_LC(ch))
1886 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1887 "Argument \"%s\" isn't numeric in %s", pv,
1890 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1891 "Argument \"%s\" isn't numeric", pv);
1895 =for apidoc looks_like_number
1897 Test if the content of an SV looks like a number (or is a number).
1898 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1899 non-numeric warning), even if your atof() doesn't grok them.
1905 Perl_looks_like_number(pTHX_ SV *sv)
1907 register const char *sbegin;
1911 sbegin = SvPVX_const(sv);
1914 else if (SvPOKp(sv))
1915 sbegin = SvPV_const(sv, len);
1917 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1918 return grok_number(sbegin, len, NULL);
1921 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1922 until proven guilty, assume that things are not that bad... */
1927 As 64 bit platforms often have an NV that doesn't preserve all bits of
1928 an IV (an assumption perl has been based on to date) it becomes necessary
1929 to remove the assumption that the NV always carries enough precision to
1930 recreate the IV whenever needed, and that the NV is the canonical form.
1931 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1932 precision as a side effect of conversion (which would lead to insanity
1933 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1934 1) to distinguish between IV/UV/NV slots that have cached a valid
1935 conversion where precision was lost and IV/UV/NV slots that have a
1936 valid conversion which has lost no precision
1937 2) to ensure that if a numeric conversion to one form is requested that
1938 would lose precision, the precise conversion (or differently
1939 imprecise conversion) is also performed and cached, to prevent
1940 requests for different numeric formats on the same SV causing
1941 lossy conversion chains. (lossless conversion chains are perfectly
1946 SvIOKp is true if the IV slot contains a valid value
1947 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1948 SvNOKp is true if the NV slot contains a valid value
1949 SvNOK is true only if the NV value is accurate
1952 while converting from PV to NV, check to see if converting that NV to an
1953 IV(or UV) would lose accuracy over a direct conversion from PV to
1954 IV(or UV). If it would, cache both conversions, return NV, but mark
1955 SV as IOK NOKp (ie not NOK).
1957 While converting from PV to IV, check to see if converting that IV to an
1958 NV would lose accuracy over a direct conversion from PV to NV. If it
1959 would, cache both conversions, flag similarly.
1961 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1962 correctly because if IV & NV were set NV *always* overruled.
1963 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1964 changes - now IV and NV together means that the two are interchangeable:
1965 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1967 The benefit of this is that operations such as pp_add know that if
1968 SvIOK is true for both left and right operands, then integer addition
1969 can be used instead of floating point (for cases where the result won't
1970 overflow). Before, floating point was always used, which could lead to
1971 loss of precision compared with integer addition.
1973 * making IV and NV equal status should make maths accurate on 64 bit
1975 * may speed up maths somewhat if pp_add and friends start to use
1976 integers when possible instead of fp. (Hopefully the overhead in
1977 looking for SvIOK and checking for overflow will not outweigh the
1978 fp to integer speedup)
1979 * will slow down integer operations (callers of SvIV) on "inaccurate"
1980 values, as the change from SvIOK to SvIOKp will cause a call into
1981 sv_2iv each time rather than a macro access direct to the IV slot
1982 * should speed up number->string conversion on integers as IV is
1983 favoured when IV and NV are equally accurate
1985 ####################################################################
1986 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1987 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1988 On the other hand, SvUOK is true iff UV.
1989 ####################################################################
1991 Your mileage will vary depending your CPU's relative fp to integer
1995 #ifndef NV_PRESERVES_UV
1996 # define IS_NUMBER_UNDERFLOW_IV 1
1997 # define IS_NUMBER_UNDERFLOW_UV 2
1998 # define IS_NUMBER_IV_AND_UV 2
1999 # define IS_NUMBER_OVERFLOW_IV 4
2000 # define IS_NUMBER_OVERFLOW_UV 5
2002 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2004 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2006 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2008 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2009 if (SvNVX(sv) < (NV)IV_MIN) {
2010 (void)SvIOKp_on(sv);
2012 SvIV_set(sv, IV_MIN);
2013 return IS_NUMBER_UNDERFLOW_IV;
2015 if (SvNVX(sv) > (NV)UV_MAX) {
2016 (void)SvIOKp_on(sv);
2019 SvUV_set(sv, UV_MAX);
2020 return IS_NUMBER_OVERFLOW_UV;
2022 (void)SvIOKp_on(sv);
2024 /* Can't use strtol etc to convert this string. (See truth table in
2026 if (SvNVX(sv) <= (UV)IV_MAX) {
2027 SvIV_set(sv, I_V(SvNVX(sv)));
2028 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2029 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2031 /* Integer is imprecise. NOK, IOKp */
2033 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2036 SvUV_set(sv, U_V(SvNVX(sv)));
2037 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2038 if (SvUVX(sv) == UV_MAX) {
2039 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2040 possibly be preserved by NV. Hence, it must be overflow.
2042 return IS_NUMBER_OVERFLOW_UV;
2044 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2046 /* Integer is imprecise. NOK, IOKp */
2048 return IS_NUMBER_OVERFLOW_IV;
2050 #endif /* !NV_PRESERVES_UV*/
2052 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2053 * this function provided for binary compatibility only
2057 Perl_sv_2iv(pTHX_ register SV *sv)
2059 return sv_2iv_flags(sv, SV_GMAGIC);
2063 =for apidoc sv_2iv_flags
2065 Return the integer value of an SV, doing any necessary string
2066 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2067 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2073 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2077 if (SvGMAGICAL(sv)) {
2078 if (flags & SV_GMAGIC)
2083 return I_V(SvNVX(sv));
2085 if (SvPOKp(sv) && SvLEN(sv))
2088 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2089 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2095 if (SvTHINKFIRST(sv)) {
2098 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2099 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2100 return SvIV(tmpstr);
2101 return PTR2IV(SvRV(sv));
2104 sv_force_normal_flags(sv, 0);
2106 if (SvREADONLY(sv) && !SvOK(sv)) {
2107 if (ckWARN(WARN_UNINITIALIZED))
2114 return (IV)(SvUVX(sv));
2121 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2122 * without also getting a cached IV/UV from it at the same time
2123 * (ie PV->NV conversion should detect loss of accuracy and cache
2124 * IV or UV at same time to avoid this. NWC */
2126 if (SvTYPE(sv) == SVt_NV)
2127 sv_upgrade(sv, SVt_PVNV);
2129 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2130 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2131 certainly cast into the IV range at IV_MAX, whereas the correct
2132 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2134 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2135 SvIV_set(sv, I_V(SvNVX(sv)));
2136 if (SvNVX(sv) == (NV) SvIVX(sv)
2137 #ifndef NV_PRESERVES_UV
2138 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2139 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2140 /* Don't flag it as "accurately an integer" if the number
2141 came from a (by definition imprecise) NV operation, and
2142 we're outside the range of NV integer precision */
2145 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2146 DEBUG_c(PerlIO_printf(Perl_debug_log,
2147 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2153 /* IV not precise. No need to convert from PV, as NV
2154 conversion would already have cached IV if it detected
2155 that PV->IV would be better than PV->NV->IV
2156 flags already correct - don't set public IOK. */
2157 DEBUG_c(PerlIO_printf(Perl_debug_log,
2158 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2163 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2164 but the cast (NV)IV_MIN rounds to a the value less (more
2165 negative) than IV_MIN which happens to be equal to SvNVX ??
2166 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2167 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2168 (NV)UVX == NVX are both true, but the values differ. :-(
2169 Hopefully for 2s complement IV_MIN is something like
2170 0x8000000000000000 which will be exact. NWC */
2173 SvUV_set(sv, U_V(SvNVX(sv)));
2175 (SvNVX(sv) == (NV) SvUVX(sv))
2176 #ifndef NV_PRESERVES_UV
2177 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2178 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2179 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2180 /* Don't flag it as "accurately an integer" if the number
2181 came from a (by definition imprecise) NV operation, and
2182 we're outside the range of NV integer precision */
2188 DEBUG_c(PerlIO_printf(Perl_debug_log,
2189 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2193 return (IV)SvUVX(sv);
2196 else if (SvPOKp(sv) && SvLEN(sv)) {
2198 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2199 /* We want to avoid a possible problem when we cache an IV which
2200 may be later translated to an NV, and the resulting NV is not
2201 the same as the direct translation of the initial string
2202 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2203 be careful to ensure that the value with the .456 is around if the
2204 NV value is requested in the future).
2206 This means that if we cache such an IV, we need to cache the
2207 NV as well. Moreover, we trade speed for space, and do not
2208 cache the NV if we are sure it's not needed.
2211 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2212 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2213 == IS_NUMBER_IN_UV) {
2214 /* It's definitely an integer, only upgrade to PVIV */
2215 if (SvTYPE(sv) < SVt_PVIV)
2216 sv_upgrade(sv, SVt_PVIV);
2218 } else if (SvTYPE(sv) < SVt_PVNV)
2219 sv_upgrade(sv, SVt_PVNV);
2221 /* If NV preserves UV then we only use the UV value if we know that
2222 we aren't going to call atof() below. If NVs don't preserve UVs
2223 then the value returned may have more precision than atof() will
2224 return, even though value isn't perfectly accurate. */
2225 if ((numtype & (IS_NUMBER_IN_UV
2226 #ifdef NV_PRESERVES_UV
2229 )) == IS_NUMBER_IN_UV) {
2230 /* This won't turn off the public IOK flag if it was set above */
2231 (void)SvIOKp_on(sv);
2233 if (!(numtype & IS_NUMBER_NEG)) {
2235 if (value <= (UV)IV_MAX) {
2236 SvIV_set(sv, (IV)value);
2238 SvUV_set(sv, value);
2242 /* 2s complement assumption */
2243 if (value <= (UV)IV_MIN) {
2244 SvIV_set(sv, -(IV)value);
2246 /* Too negative for an IV. This is a double upgrade, but
2247 I'm assuming it will be rare. */
2248 if (SvTYPE(sv) < SVt_PVNV)
2249 sv_upgrade(sv, SVt_PVNV);
2253 SvNV_set(sv, -(NV)value);
2254 SvIV_set(sv, IV_MIN);
2258 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2259 will be in the previous block to set the IV slot, and the next
2260 block to set the NV slot. So no else here. */
2262 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2263 != IS_NUMBER_IN_UV) {
2264 /* It wasn't an (integer that doesn't overflow the UV). */
2265 SvNV_set(sv, Atof(SvPVX_const(sv)));
2267 if (! numtype && ckWARN(WARN_NUMERIC))
2270 #if defined(USE_LONG_DOUBLE)
2271 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2272 PTR2UV(sv), SvNVX(sv)));
2274 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2275 PTR2UV(sv), SvNVX(sv)));
2279 #ifdef NV_PRESERVES_UV
2280 (void)SvIOKp_on(sv);
2282 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2283 SvIV_set(sv, I_V(SvNVX(sv)));
2284 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2287 /* Integer is imprecise. NOK, IOKp */
2289 /* UV will not work better than IV */
2291 if (SvNVX(sv) > (NV)UV_MAX) {
2293 /* Integer is inaccurate. NOK, IOKp, is UV */
2294 SvUV_set(sv, UV_MAX);
2297 SvUV_set(sv, U_V(SvNVX(sv)));
2298 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2299 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2303 /* Integer is imprecise. NOK, IOKp, is UV */
2309 #else /* NV_PRESERVES_UV */
2310 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2311 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2312 /* The IV slot will have been set from value returned by
2313 grok_number above. The NV slot has just been set using
2316 assert (SvIOKp(sv));
2318 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2319 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2320 /* Small enough to preserve all bits. */
2321 (void)SvIOKp_on(sv);
2323 SvIV_set(sv, I_V(SvNVX(sv)));
2324 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2326 /* Assumption: first non-preserved integer is < IV_MAX,
2327 this NV is in the preserved range, therefore: */
2328 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2330 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);
2334 0 0 already failed to read UV.
2335 0 1 already failed to read UV.
2336 1 0 you won't get here in this case. IV/UV
2337 slot set, public IOK, Atof() unneeded.
2338 1 1 already read UV.
2339 so there's no point in sv_2iuv_non_preserve() attempting
2340 to use atol, strtol, strtoul etc. */
2341 if (sv_2iuv_non_preserve (sv, numtype)
2342 >= IS_NUMBER_OVERFLOW_IV)
2346 #endif /* NV_PRESERVES_UV */
2349 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2351 if (SvTYPE(sv) < SVt_IV)
2352 /* Typically the caller expects that sv_any is not NULL now. */
2353 sv_upgrade(sv, SVt_IV);
2356 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2357 PTR2UV(sv),SvIVX(sv)));
2358 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2361 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2362 * this function provided for binary compatibility only
2366 Perl_sv_2uv(pTHX_ register SV *sv)
2368 return sv_2uv_flags(sv, SV_GMAGIC);
2372 =for apidoc sv_2uv_flags
2374 Return the unsigned integer value of an SV, doing any necessary string
2375 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2376 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2382 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2386 if (SvGMAGICAL(sv)) {
2387 if (flags & SV_GMAGIC)
2392 return U_V(SvNVX(sv));
2393 if (SvPOKp(sv) && SvLEN(sv))
2396 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2397 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2403 if (SvTHINKFIRST(sv)) {
2406 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2407 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2408 return SvUV(tmpstr);
2409 return PTR2UV(SvRV(sv));
2412 sv_force_normal_flags(sv, 0);
2414 if (SvREADONLY(sv) && !SvOK(sv)) {
2415 if (ckWARN(WARN_UNINITIALIZED))
2425 return (UV)SvIVX(sv);
2429 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2430 * without also getting a cached IV/UV from it at the same time
2431 * (ie PV->NV conversion should detect loss of accuracy and cache
2432 * IV or UV at same time to avoid this. */
2433 /* IV-over-UV optimisation - choose to cache IV if possible */
2435 if (SvTYPE(sv) == SVt_NV)
2436 sv_upgrade(sv, SVt_PVNV);
2438 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2439 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2440 SvIV_set(sv, I_V(SvNVX(sv)));
2441 if (SvNVX(sv) == (NV) SvIVX(sv)
2442 #ifndef NV_PRESERVES_UV
2443 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2444 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2445 /* Don't flag it as "accurately an integer" if the number
2446 came from a (by definition imprecise) NV operation, and
2447 we're outside the range of NV integer precision */
2450 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2451 DEBUG_c(PerlIO_printf(Perl_debug_log,
2452 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2458 /* IV not precise. No need to convert from PV, as NV
2459 conversion would already have cached IV if it detected
2460 that PV->IV would be better than PV->NV->IV
2461 flags already correct - don't set public IOK. */
2462 DEBUG_c(PerlIO_printf(Perl_debug_log,
2463 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2468 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2469 but the cast (NV)IV_MIN rounds to a the value less (more
2470 negative) than IV_MIN which happens to be equal to SvNVX ??
2471 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2472 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2473 (NV)UVX == NVX are both true, but the values differ. :-(
2474 Hopefully for 2s complement IV_MIN is something like
2475 0x8000000000000000 which will be exact. NWC */
2478 SvUV_set(sv, U_V(SvNVX(sv)));
2480 (SvNVX(sv) == (NV) SvUVX(sv))
2481 #ifndef NV_PRESERVES_UV
2482 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2483 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2484 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2485 /* Don't flag it as "accurately an integer" if the number
2486 came from a (by definition imprecise) NV operation, and
2487 we're outside the range of NV integer precision */
2492 DEBUG_c(PerlIO_printf(Perl_debug_log,
2493 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2499 else if (SvPOKp(sv) && SvLEN(sv)) {
2501 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2503 /* We want to avoid a possible problem when we cache a UV which
2504 may be later translated to an NV, and the resulting NV is not
2505 the translation of the initial data.
2507 This means that if we cache such a UV, we need to cache the
2508 NV as well. Moreover, we trade speed for space, and do not
2509 cache the NV if not needed.
2512 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2513 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2514 == IS_NUMBER_IN_UV) {
2515 /* It's definitely an integer, only upgrade to PVIV */
2516 if (SvTYPE(sv) < SVt_PVIV)
2517 sv_upgrade(sv, SVt_PVIV);
2519 } else if (SvTYPE(sv) < SVt_PVNV)
2520 sv_upgrade(sv, SVt_PVNV);
2522 /* If NV preserves UV then we only use the UV value if we know that
2523 we aren't going to call atof() below. If NVs don't preserve UVs
2524 then the value returned may have more precision than atof() will
2525 return, even though it isn't accurate. */
2526 if ((numtype & (IS_NUMBER_IN_UV
2527 #ifdef NV_PRESERVES_UV
2530 )) == IS_NUMBER_IN_UV) {
2531 /* This won't turn off the public IOK flag if it was set above */
2532 (void)SvIOKp_on(sv);
2534 if (!(numtype & IS_NUMBER_NEG)) {
2536 if (value <= (UV)IV_MAX) {
2537 SvIV_set(sv, (IV)value);
2539 /* it didn't overflow, and it was positive. */
2540 SvUV_set(sv, value);
2544 /* 2s complement assumption */
2545 if (value <= (UV)IV_MIN) {
2546 SvIV_set(sv, -(IV)value);
2548 /* Too negative for an IV. This is a double upgrade, but
2549 I'm assuming it will be rare. */
2550 if (SvTYPE(sv) < SVt_PVNV)
2551 sv_upgrade(sv, SVt_PVNV);
2555 SvNV_set(sv, -(NV)value);
2556 SvIV_set(sv, IV_MIN);
2561 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2562 != IS_NUMBER_IN_UV) {
2563 /* It wasn't an integer, or it overflowed the UV. */
2564 SvNV_set(sv, Atof(SvPVX_const(sv)));
2566 if (! numtype && ckWARN(WARN_NUMERIC))
2569 #if defined(USE_LONG_DOUBLE)
2570 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2571 PTR2UV(sv), SvNVX(sv)));
2573 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2574 PTR2UV(sv), SvNVX(sv)));
2577 #ifdef NV_PRESERVES_UV
2578 (void)SvIOKp_on(sv);
2580 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2581 SvIV_set(sv, I_V(SvNVX(sv)));
2582 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2585 /* Integer is imprecise. NOK, IOKp */
2587 /* UV will not work better than IV */
2589 if (SvNVX(sv) > (NV)UV_MAX) {
2591 /* Integer is inaccurate. NOK, IOKp, is UV */
2592 SvUV_set(sv, UV_MAX);
2595 SvUV_set(sv, U_V(SvNVX(sv)));
2596 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2597 NV preservse UV so can do correct comparison. */
2598 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2602 /* Integer is imprecise. NOK, IOKp, is UV */
2607 #else /* NV_PRESERVES_UV */
2608 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2609 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2610 /* The UV slot will have been set from value returned by
2611 grok_number above. The NV slot has just been set using
2614 assert (SvIOKp(sv));
2616 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2617 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2618 /* Small enough to preserve all bits. */
2619 (void)SvIOKp_on(sv);
2621 SvIV_set(sv, I_V(SvNVX(sv)));
2622 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2624 /* Assumption: first non-preserved integer is < IV_MAX,
2625 this NV is in the preserved range, therefore: */
2626 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2628 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);
2631 sv_2iuv_non_preserve (sv, numtype);
2633 #endif /* NV_PRESERVES_UV */
2637 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2638 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2641 if (SvTYPE(sv) < SVt_IV)
2642 /* Typically the caller expects that sv_any is not NULL now. */
2643 sv_upgrade(sv, SVt_IV);
2647 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2648 PTR2UV(sv),SvUVX(sv)));
2649 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2655 Return the num value of an SV, doing any necessary string or integer
2656 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2663 Perl_sv_2nv(pTHX_ register SV *sv)
2667 if (SvGMAGICAL(sv)) {
2671 if (SvPOKp(sv) && SvLEN(sv)) {
2672 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2673 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2675 return Atof(SvPVX_const(sv));
2679 return (NV)SvUVX(sv);
2681 return (NV)SvIVX(sv);
2684 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2685 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2691 if (SvTHINKFIRST(sv)) {
2694 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2695 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2696 return SvNV(tmpstr);
2697 return PTR2NV(SvRV(sv));
2700 sv_force_normal_flags(sv, 0);
2702 if (SvREADONLY(sv) && !SvOK(sv)) {
2703 if (ckWARN(WARN_UNINITIALIZED))
2708 if (SvTYPE(sv) < SVt_NV) {
2709 if (SvTYPE(sv) == SVt_IV)
2710 sv_upgrade(sv, SVt_PVNV);
2712 sv_upgrade(sv, SVt_NV);
2713 #ifdef USE_LONG_DOUBLE
2715 STORE_NUMERIC_LOCAL_SET_STANDARD();
2716 PerlIO_printf(Perl_debug_log,
2717 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2718 PTR2UV(sv), SvNVX(sv));
2719 RESTORE_NUMERIC_LOCAL();
2723 STORE_NUMERIC_LOCAL_SET_STANDARD();
2724 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2725 PTR2UV(sv), SvNVX(sv));
2726 RESTORE_NUMERIC_LOCAL();
2730 else if (SvTYPE(sv) < SVt_PVNV)
2731 sv_upgrade(sv, SVt_PVNV);
2736 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2737 #ifdef NV_PRESERVES_UV
2740 /* Only set the public NV OK flag if this NV preserves the IV */
2741 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2742 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2743 : (SvIVX(sv) == I_V(SvNVX(sv))))
2749 else if (SvPOKp(sv) && SvLEN(sv)) {
2751 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2752 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2754 #ifdef NV_PRESERVES_UV
2755 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2756 == IS_NUMBER_IN_UV) {
2757 /* It's definitely an integer */
2758 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2760 SvNV_set(sv, Atof(SvPVX_const(sv)));
2763 SvNV_set(sv, Atof(SvPVX_const(sv)));
2764 /* Only set the public NV OK flag if this NV preserves the value in
2765 the PV at least as well as an IV/UV would.
2766 Not sure how to do this 100% reliably. */
2767 /* if that shift count is out of range then Configure's test is
2768 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2770 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2771 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2772 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2773 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2774 /* Can't use strtol etc to convert this string, so don't try.
2775 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2778 /* value has been set. It may not be precise. */
2779 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2780 /* 2s complement assumption for (UV)IV_MIN */
2781 SvNOK_on(sv); /* Integer is too negative. */
2786 if (numtype & IS_NUMBER_NEG) {
2787 SvIV_set(sv, -(IV)value);
2788 } else if (value <= (UV)IV_MAX) {
2789 SvIV_set(sv, (IV)value);
2791 SvUV_set(sv, value);
2795 if (numtype & IS_NUMBER_NOT_INT) {
2796 /* I believe that even if the original PV had decimals,
2797 they are lost beyond the limit of the FP precision.
2798 However, neither is canonical, so both only get p
2799 flags. NWC, 2000/11/25 */
2800 /* Both already have p flags, so do nothing */
2802 const NV nv = SvNVX(sv);
2803 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2804 if (SvIVX(sv) == I_V(nv)) {
2809 /* It had no "." so it must be integer. */
2812 /* between IV_MAX and NV(UV_MAX).
2813 Could be slightly > UV_MAX */
2815 if (numtype & IS_NUMBER_NOT_INT) {
2816 /* UV and NV both imprecise. */
2818 const UV nv_as_uv = U_V(nv);
2820 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2831 #endif /* NV_PRESERVES_UV */
2834 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2836 if (SvTYPE(sv) < SVt_NV)
2837 /* Typically the caller expects that sv_any is not NULL now. */
2838 /* XXX Ilya implies that this is a bug in callers that assume this
2839 and ideally should be fixed. */
2840 sv_upgrade(sv, SVt_NV);
2843 #if defined(USE_LONG_DOUBLE)
2845 STORE_NUMERIC_LOCAL_SET_STANDARD();
2846 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2847 PTR2UV(sv), SvNVX(sv));
2848 RESTORE_NUMERIC_LOCAL();
2852 STORE_NUMERIC_LOCAL_SET_STANDARD();
2853 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2854 PTR2UV(sv), SvNVX(sv));
2855 RESTORE_NUMERIC_LOCAL();
2861 /* asIV(): extract an integer from the string value of an SV.
2862 * Caller must validate PVX */
2865 S_asIV(pTHX_ SV *sv)
2868 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2870 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2871 == IS_NUMBER_IN_UV) {
2872 /* It's definitely an integer */
2873 if (numtype & IS_NUMBER_NEG) {
2874 if (value < (UV)IV_MIN)
2877 if (value < (UV)IV_MAX)
2882 if (ckWARN(WARN_NUMERIC))
2885 return I_V(Atof(SvPVX_const(sv)));
2888 /* asUV(): extract an unsigned integer from the string value of an SV
2889 * Caller must validate PVX */
2892 S_asUV(pTHX_ SV *sv)
2895 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2897 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2898 == IS_NUMBER_IN_UV) {
2899 /* It's definitely an integer */
2900 if (!(numtype & IS_NUMBER_NEG))
2904 if (ckWARN(WARN_NUMERIC))
2907 return U_V(Atof(SvPVX_const(sv)));
2911 =for apidoc sv_2pv_nolen
2913 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2914 use the macro wrapper C<SvPV_nolen(sv)> instead.
2919 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2921 return sv_2pv(sv, 0);
2924 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2925 * UV as a string towards the end of buf, and return pointers to start and
2928 * We assume that buf is at least TYPE_CHARS(UV) long.
2932 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2934 char *ptr = buf + TYPE_CHARS(UV);
2948 *--ptr = '0' + (char)(uv % 10);
2956 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2957 * this function provided for binary compatibility only
2961 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2963 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2967 =for apidoc sv_2pv_flags
2969 Returns a pointer to the string value of an SV, and sets *lp to its length.
2970 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2972 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2973 usually end up here too.
2979 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2984 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2985 char *tmpbuf = tbuf;
2992 if (SvGMAGICAL(sv)) {
2993 if (flags & SV_GMAGIC)
2998 if (flags & SV_MUTABLE_RETURN)
2999 return SvPVX_mutable(sv);
3000 if (flags & SV_CONST_RETURN)
3001 return (char *)SvPVX_const(sv);
3006 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3008 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3013 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3018 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3019 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3027 if (SvTHINKFIRST(sv)) {
3030 register const char *typestr;
3031 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3032 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3034 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3037 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3038 if (flags & SV_CONST_RETURN) {
3039 pv = (char *) SvPVX_const(tmpstr);
3041 pv = (flags & SV_MUTABLE_RETURN)
3042 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3045 *lp = SvCUR(tmpstr);
3047 pv = sv_2pv_flags(tmpstr, lp, flags);
3058 typestr = "NULLREF";
3062 switch (SvTYPE(sv)) {
3064 if ( ((SvFLAGS(sv) &
3065 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3066 == (SVs_OBJECT|SVs_SMG))
3067 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3068 const regexp *re = (regexp *)mg->mg_obj;
3071 const char *fptr = "msix";
3076 char need_newline = 0;
3077 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3079 while((ch = *fptr++)) {
3081 reflags[left++] = ch;
3084 reflags[right--] = ch;
3089 reflags[left] = '-';
3093 mg->mg_len = re->prelen + 4 + left;
3095 * If /x was used, we have to worry about a regex
3096 * ending with a comment later being embedded
3097 * within another regex. If so, we don't want this
3098 * regex's "commentization" to leak out to the
3099 * right part of the enclosing regex, we must cap
3100 * it with a newline.
3102 * So, if /x was used, we scan backwards from the
3103 * end of the regex. If we find a '#' before we
3104 * find a newline, we need to add a newline
3105 * ourself. If we find a '\n' first (or if we
3106 * don't find '#' or '\n'), we don't need to add
3107 * anything. -jfriedl
3109 if (PMf_EXTENDED & re->reganch)
3111 const char *endptr = re->precomp + re->prelen;
3112 while (endptr >= re->precomp)
3114 const char c = *(endptr--);
3116 break; /* don't need another */
3118 /* we end while in a comment, so we
3120 mg->mg_len++; /* save space for it */
3121 need_newline = 1; /* note to add it */
3127 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3128 Copy("(?", mg->mg_ptr, 2, char);
3129 Copy(reflags, mg->mg_ptr+2, left, char);
3130 Copy(":", mg->mg_ptr+left+2, 1, char);
3131 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3133 mg->mg_ptr[mg->mg_len - 2] = '\n';
3134 mg->mg_ptr[mg->mg_len - 1] = ')';
3135 mg->mg_ptr[mg->mg_len] = 0;
3137 PL_reginterp_cnt += re->program[0].next_off;
3139 if (re->reganch & ROPT_UTF8)
3155 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3156 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3157 /* tied lvalues should appear to be
3158 * scalars for backwards compatitbility */
3159 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3160 ? "SCALAR" : "LVALUE"; break;
3161 case SVt_PVAV: typestr = "ARRAY"; break;
3162 case SVt_PVHV: typestr = "HASH"; break;
3163 case SVt_PVCV: typestr = "CODE"; break;
3164 case SVt_PVGV: typestr = "GLOB"; break;
3165 case SVt_PVFM: typestr = "FORMAT"; break;
3166 case SVt_PVIO: typestr = "IO"; break;
3167 default: typestr = "UNKNOWN"; break;
3171 const char *name = HvNAME_get(SvSTASH(sv));
3172 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3173 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3176 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3180 *lp = strlen(typestr);
3181 return (char *)typestr;
3183 if (SvREADONLY(sv) && !SvOK(sv)) {
3184 if (ckWARN(WARN_UNINITIALIZED))
3191 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3192 /* I'm assuming that if both IV and NV are equally valid then
3193 converting the IV is going to be more efficient */
3194 const U32 isIOK = SvIOK(sv);
3195 const U32 isUIOK = SvIsUV(sv);
3196 char buf[TYPE_CHARS(UV)];
3199 if (SvTYPE(sv) < SVt_PVIV)
3200 sv_upgrade(sv, SVt_PVIV);
3202 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3204 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3205 /* inlined from sv_setpvn */
3206 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3207 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3208 SvCUR_set(sv, ebuf - ptr);
3218 else if (SvNOKp(sv)) {
3219 if (SvTYPE(sv) < SVt_PVNV)
3220 sv_upgrade(sv, SVt_PVNV);
3221 /* The +20 is pure guesswork. Configure test needed. --jhi */
3222 s = SvGROW_mutable(sv, NV_DIG + 20);
3223 olderrno = errno; /* some Xenix systems wipe out errno here */
3225 if (SvNVX(sv) == 0.0)
3226 (void)strcpy(s,"0");
3230 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3233 #ifdef FIXNEGATIVEZERO
3234 if (*s == '-' && s[1] == '0' && !s[2])
3244 if (ckWARN(WARN_UNINITIALIZED)
3245 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3249 if (SvTYPE(sv) < SVt_PV)
3250 /* Typically the caller expects that sv_any is not NULL now. */
3251 sv_upgrade(sv, SVt_PV);
3255 STRLEN len = s - SvPVX_const(sv);
3261 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3262 PTR2UV(sv),SvPVX_const(sv)));
3263 if (flags & SV_CONST_RETURN)
3264 return (char *)SvPVX_const(sv);
3265 if (flags & SV_MUTABLE_RETURN)
3266 return SvPVX_mutable(sv);
3270 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3271 /* Sneaky stuff here */
3275 tsv = newSVpv(tmpbuf, 0);
3288 t = SvPVX_const(tsv);
3293 len = strlen(tmpbuf);
3295 #ifdef FIXNEGATIVEZERO
3296 if (len == 2 && t[0] == '-' && t[1] == '0') {
3301 SvUPGRADE(sv, SVt_PV);
3304 s = SvGROW_mutable(sv, len + 1);
3307 return strcpy(s, t);
3312 =for apidoc sv_copypv
3314 Copies a stringified representation of the source SV into the
3315 destination SV. Automatically performs any necessary mg_get and
3316 coercion of numeric values into strings. Guaranteed to preserve
3317 UTF-8 flag even from overloaded objects. Similar in nature to
3318 sv_2pv[_flags] but operates directly on an SV instead of just the
3319 string. Mostly uses sv_2pv_flags to do its work, except when that
3320 would lose the UTF-8'ness of the PV.
3326 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3330 s = SvPV_const(ssv,len);
3331 sv_setpvn(dsv,s,len);
3339 =for apidoc sv_2pvbyte_nolen
3341 Return a pointer to the byte-encoded representation of the SV.
3342 May cause the SV to be downgraded from UTF-8 as a side-effect.
3344 Usually accessed via the C<SvPVbyte_nolen> macro.
3350 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3352 return sv_2pvbyte(sv, 0);
3356 =for apidoc sv_2pvbyte
3358 Return a pointer to the byte-encoded representation of the SV, and set *lp
3359 to its length. May cause the SV to be downgraded from UTF-8 as a
3362 Usually accessed via the C<SvPVbyte> macro.
3368 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3370 sv_utf8_downgrade(sv,0);
3371 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3375 =for apidoc sv_2pvutf8_nolen
3377 Return a pointer to the UTF-8-encoded representation of the SV.
3378 May cause the SV to be upgraded to UTF-8 as a side-effect.
3380 Usually accessed via the C<SvPVutf8_nolen> macro.
3386 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3388 return sv_2pvutf8(sv, 0);
3392 =for apidoc sv_2pvutf8
3394 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3395 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3397 Usually accessed via the C<SvPVutf8> macro.
3403 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3405 sv_utf8_upgrade(sv);
3406 return SvPV(sv,*lp);
3410 =for apidoc sv_2bool
3412 This function is only called on magical items, and is only used by
3413 sv_true() or its macro equivalent.
3419 Perl_sv_2bool(pTHX_ register SV *sv)
3428 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3429 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3430 return (bool)SvTRUE(tmpsv);
3431 return SvRV(sv) != 0;
3434 register XPV* Xpvtmp;
3435 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3436 (*sv->sv_u.svu_pv > '0' ||
3437 Xpvtmp->xpv_cur > 1 ||
3438 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3445 return SvIVX(sv) != 0;
3448 return SvNVX(sv) != 0.0;
3455 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3456 * this function provided for binary compatibility only
3461 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3463 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3467 =for apidoc sv_utf8_upgrade
3469 Converts the PV of an SV to its UTF-8-encoded form.
3470 Forces the SV to string form if it is not already.
3471 Always sets the SvUTF8 flag to avoid future validity checks even
3472 if all the bytes have hibit clear.
3474 This is not as a general purpose byte encoding to Unicode interface:
3475 use the Encode extension for that.
3477 =for apidoc sv_utf8_upgrade_flags
3479 Converts the PV of an SV to its UTF-8-encoded form.
3480 Forces the SV to string form if it is not already.
3481 Always sets the SvUTF8 flag to avoid future validity checks even
3482 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3483 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3484 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3486 This is not as a general purpose byte encoding to Unicode interface:
3487 use the Encode extension for that.
3493 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3495 if (sv == &PL_sv_undef)
3499 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3500 (void) sv_2pv_flags(sv,&len, flags);
3504 (void) SvPV_force(sv,len);
3513 sv_force_normal_flags(sv, 0);
3516 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3517 sv_recode_to_utf8(sv, PL_encoding);
3518 else { /* Assume Latin-1/EBCDIC */
3519 /* This function could be much more efficient if we
3520 * had a FLAG in SVs to signal if there are any hibit
3521 * chars in the PV. Given that there isn't such a flag
3522 * make the loop as fast as possible. */
3523 const U8 *s = (U8 *) SvPVX_const(sv);
3524 const U8 *e = (U8 *) SvEND(sv);
3530 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3534 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3535 U8 *recoded = bytes_to_utf8((U8*)s, &len);
3537 SvPV_free(sv); /* No longer using what was there before. */
3539 SvPV_set(sv, (char*)recoded);
3540 SvCUR_set(sv, len - 1);
3541 SvLEN_set(sv, len); /* No longer know the real size. */
3543 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3550 =for apidoc sv_utf8_downgrade
3552 Attempts to convert the PV of an SV from characters to bytes.
3553 If the PV contains a character beyond byte, this conversion will fail;
3554 in this case, either returns false or, if C<fail_ok> is not
3557 This is not as a general purpose Unicode to byte encoding interface:
3558 use the Encode extension for that.
3564 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3566 if (SvPOKp(sv) && SvUTF8(sv)) {
3572 sv_force_normal_flags(sv, 0);
3574 s = (U8 *) SvPV(sv, len);
3575 if (!utf8_to_bytes(s, &len)) {
3580 Perl_croak(aTHX_ "Wide character in %s",
3583 Perl_croak(aTHX_ "Wide character");
3594 =for apidoc sv_utf8_encode
3596 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3597 flag off so that it looks like octets again.
3603 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3605 (void) sv_utf8_upgrade(sv);
3607 sv_force_normal_flags(sv, 0);
3609 if (SvREADONLY(sv)) {
3610 Perl_croak(aTHX_ PL_no_modify);
3616 =for apidoc sv_utf8_decode
3618 If the PV of the SV is an octet sequence in UTF-8
3619 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3620 so that it looks like a character. If the PV contains only single-byte
3621 characters, the C<SvUTF8> flag stays being off.
3622 Scans PV for validity and returns false if the PV is invalid UTF-8.
3628 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3634 /* The octets may have got themselves encoded - get them back as
3637 if (!sv_utf8_downgrade(sv, TRUE))
3640 /* it is actually just a matter of turning the utf8 flag on, but
3641 * we want to make sure everything inside is valid utf8 first.
3643 c = (const U8 *) SvPVX_const(sv);
3644 if (!is_utf8_string(c, SvCUR(sv)+1))
3646 e = (const U8 *) SvEND(sv);
3649 if (!UTF8_IS_INVARIANT(ch)) {
3658 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3659 * this function provided for binary compatibility only
3663 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3665 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3669 =for apidoc sv_setsv
3671 Copies the contents of the source SV C<ssv> into the destination SV
3672 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3673 function if the source SV needs to be reused. Does not handle 'set' magic.
3674 Loosely speaking, it performs a copy-by-value, obliterating any previous
3675 content of the destination.
3677 You probably want to use one of the assortment of wrappers, such as
3678 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3679 C<SvSetMagicSV_nosteal>.
3681 =for apidoc sv_setsv_flags
3683 Copies the contents of the source SV C<ssv> into the destination SV
3684 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3685 function if the source SV needs to be reused. Does not handle 'set' magic.
3686 Loosely speaking, it performs a copy-by-value, obliterating any previous
3687 content of the destination.
3688 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3689 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3690 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3691 and C<sv_setsv_nomg> are implemented in terms of this function.
3693 You probably want to use one of the assortment of wrappers, such as
3694 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3695 C<SvSetMagicSV_nosteal>.
3697 This is the primary function for copying scalars, and most other
3698 copy-ish functions and macros use this underneath.
3704 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3706 register U32 sflags;
3712 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3714 sstr = &PL_sv_undef;
3715 stype = SvTYPE(sstr);
3716 dtype = SvTYPE(dstr);
3721 /* need to nuke the magic */
3723 SvRMAGICAL_off(dstr);
3726 /* There's a lot of redundancy below but we're going for speed here */
3731 if (dtype != SVt_PVGV) {
3732 (void)SvOK_off(dstr);
3740 sv_upgrade(dstr, SVt_IV);
3743 sv_upgrade(dstr, SVt_PVNV);
3747 sv_upgrade(dstr, SVt_PVIV);
3750 (void)SvIOK_only(dstr);
3751 SvIV_set(dstr, SvIVX(sstr));
3754 if (SvTAINTED(sstr))
3765 sv_upgrade(dstr, SVt_NV);
3770 sv_upgrade(dstr, SVt_PVNV);
3773 SvNV_set(dstr, SvNVX(sstr));
3774 (void)SvNOK_only(dstr);
3775 if (SvTAINTED(sstr))
3783 sv_upgrade(dstr, SVt_RV);
3784 else if (dtype == SVt_PVGV &&
3785 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3788 if (GvIMPORTED(dstr) != GVf_IMPORTED
3789 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3791 GvIMPORTED_on(dstr);
3800 #ifdef PERL_OLD_COPY_ON_WRITE
3801 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3802 if (dtype < SVt_PVIV)
3803 sv_upgrade(dstr, SVt_PVIV);
3810 sv_upgrade(dstr, SVt_PV);
3813 if (dtype < SVt_PVIV)
3814 sv_upgrade(dstr, SVt_PVIV);
3817 if (dtype < SVt_PVNV)
3818 sv_upgrade(dstr, SVt_PVNV);
3825 const char * const type = sv_reftype(sstr,0);
3827 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3829 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3834 if (dtype <= SVt_PVGV) {
3836 if (dtype != SVt_PVGV) {
3837 const char * const name = GvNAME(sstr);
3838 const STRLEN len = GvNAMELEN(sstr);
3839 /* don't upgrade SVt_PVLV: it can hold a glob */
3840 if (dtype != SVt_PVLV)
3841 sv_upgrade(dstr, SVt_PVGV);
3842 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3843 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3844 GvNAME(dstr) = savepvn(name, len);
3845 GvNAMELEN(dstr) = len;
3846 SvFAKE_on(dstr); /* can coerce to non-glob */
3848 /* ahem, death to those who redefine active sort subs */
3849 else if (PL_curstackinfo->si_type == PERLSI_SORT
3850 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3851 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3854 #ifdef GV_UNIQUE_CHECK
3855 if (GvUNIQUE((GV*)dstr)) {
3856 Perl_croak(aTHX_ PL_no_modify);
3860 (void)SvOK_off(dstr);
3861 GvINTRO_off(dstr); /* one-shot flag */
3863 GvGP(dstr) = gp_ref(GvGP(sstr));
3864 if (SvTAINTED(sstr))
3866 if (GvIMPORTED(dstr) != GVf_IMPORTED
3867 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3869 GvIMPORTED_on(dstr);
3877 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3879 if ((int)SvTYPE(sstr) != stype) {
3880 stype = SvTYPE(sstr);
3881 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3885 if (stype == SVt_PVLV)
3886 SvUPGRADE(dstr, SVt_PVNV);
3888 SvUPGRADE(dstr, (U32)stype);
3891 sflags = SvFLAGS(sstr);
3893 if (sflags & SVf_ROK) {
3894 if (dtype >= SVt_PV) {
3895 if (dtype == SVt_PVGV) {
3896 SV *sref = SvREFCNT_inc(SvRV(sstr));
3898 const int intro = GvINTRO(dstr);
3900 #ifdef GV_UNIQUE_CHECK
3901 if (GvUNIQUE((GV*)dstr)) {
3902 Perl_croak(aTHX_ PL_no_modify);
3907 GvINTRO_off(dstr); /* one-shot flag */
3908 GvLINE(dstr) = CopLINE(PL_curcop);
3909 GvEGV(dstr) = (GV*)dstr;
3912 switch (SvTYPE(sref)) {
3915 SAVEGENERICSV(GvAV(dstr));
3917 dref = (SV*)GvAV(dstr);
3918 GvAV(dstr) = (AV*)sref;
3919 if (!GvIMPORTED_AV(dstr)
3920 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3922 GvIMPORTED_AV_on(dstr);
3927 SAVEGENERICSV(GvHV(dstr));
3929 dref = (SV*)GvHV(dstr);
3930 GvHV(dstr) = (HV*)sref;
3931 if (!GvIMPORTED_HV(dstr)
3932 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3934 GvIMPORTED_HV_on(dstr);
3939 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3940 SvREFCNT_dec(GvCV(dstr));
3941 GvCV(dstr) = Nullcv;
3942 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3943 PL_sub_generation++;
3945 SAVEGENERICSV(GvCV(dstr));
3948 dref = (SV*)GvCV(dstr);
3949 if (GvCV(dstr) != (CV*)sref) {
3950 CV* cv = GvCV(dstr);
3952 if (!GvCVGEN((GV*)dstr) &&
3953 (CvROOT(cv) || CvXSUB(cv)))
3955 /* ahem, death to those who redefine
3956 * active sort subs */
3957 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3958 PL_sortcop == CvSTART(cv))
3960 "Can't redefine active sort subroutine %s",
3961 GvENAME((GV*)dstr));
3962 /* Redefining a sub - warning is mandatory if
3963 it was a const and its value changed. */
3964 if (ckWARN(WARN_REDEFINE)
3966 && (!CvCONST((CV*)sref)
3967 || sv_cmp(cv_const_sv(cv),
3968 cv_const_sv((CV*)sref)))))
3970 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3972 ? "Constant subroutine %s::%s redefined"
3973 : "Subroutine %s::%s redefined",
3974 HvNAME_get(GvSTASH((GV*)dstr)),
3975 GvENAME((GV*)dstr));
3979 cv_ckproto(cv, (GV*)dstr,
3981 ? SvPVX_const(sref) : Nullch);
3983 GvCV(dstr) = (CV*)sref;
3984 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3985 GvASSUMECV_on(dstr);
3986 PL_sub_generation++;
3988 if (!GvIMPORTED_CV(dstr)
3989 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3991 GvIMPORTED_CV_on(dstr);
3996 SAVEGENERICSV(GvIOp(dstr));
3998 dref = (SV*)GvIOp(dstr);
3999 GvIOp(dstr) = (IO*)sref;
4003 SAVEGENERICSV(GvFORM(dstr));
4005 dref = (SV*)GvFORM(dstr);
4006 GvFORM(dstr) = (CV*)sref;
4010 SAVEGENERICSV(GvSV(dstr));
4012 dref = (SV*)GvSV(dstr);
4014 if (!GvIMPORTED_SV(dstr)
4015 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4017 GvIMPORTED_SV_on(dstr);
4023 if (SvTAINTED(sstr))
4027 if (SvPVX_const(dstr)) {
4033 (void)SvOK_off(dstr);
4034 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4036 if (sflags & SVp_NOK) {
4038 /* Only set the public OK flag if the source has public OK. */
4039 if (sflags & SVf_NOK)
4040 SvFLAGS(dstr) |= SVf_NOK;
4041 SvNV_set(dstr, SvNVX(sstr));
4043 if (sflags & SVp_IOK) {
4044 (void)SvIOKp_on(dstr);
4045 if (sflags & SVf_IOK)
4046 SvFLAGS(dstr) |= SVf_IOK;
4047 if (sflags & SVf_IVisUV)
4049 SvIV_set(dstr, SvIVX(sstr));
4051 if (SvAMAGIC(sstr)) {
4055 else if (sflags & SVp_POK) {
4059 * Check to see if we can just swipe the string. If so, it's a
4060 * possible small lose on short strings, but a big win on long ones.
4061 * It might even be a win on short strings if SvPVX_const(dstr)
4062 * has to be allocated and SvPVX_const(sstr) has to be freed.
4065 /* Whichever path we take through the next code, we want this true,
4066 and doing it now facilitates the COW check. */
4067 (void)SvPOK_only(dstr);
4070 /* We're not already COW */
4071 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4072 #ifndef PERL_OLD_COPY_ON_WRITE
4073 /* or we are, but dstr isn't a suitable target. */
4074 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4079 (sflags & SVs_TEMP) && /* slated for free anyway? */
4080 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4081 (!(flags & SV_NOSTEAL)) &&
4082 /* and we're allowed to steal temps */
4083 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4084 SvLEN(sstr) && /* and really is a string */
4085 /* and won't be needed again, potentially */
4086 !(PL_op && PL_op->op_type == OP_AASSIGN))
4087 #ifdef PERL_OLD_COPY_ON_WRITE
4088 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4089 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4090 && SvTYPE(sstr) >= SVt_PVIV)
4093 /* Failed the swipe test, and it's not a shared hash key either.
4094 Have to copy the string. */
4095 STRLEN len = SvCUR(sstr);
4096 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4097 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4098 SvCUR_set(dstr, len);
4099 *SvEND(dstr) = '\0';
4101 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4103 /* Either it's a shared hash key, or it's suitable for
4104 copy-on-write or we can swipe the string. */
4106 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4110 #ifdef PERL_OLD_COPY_ON_WRITE
4112 /* I believe I should acquire a global SV mutex if
4113 it's a COW sv (not a shared hash key) to stop
4114 it going un copy-on-write.
4115 If the source SV has gone un copy on write between up there
4116 and down here, then (assert() that) it is of the correct
4117 form to make it copy on write again */
4118 if ((sflags & (SVf_FAKE | SVf_READONLY))
4119 != (SVf_FAKE | SVf_READONLY)) {
4120 SvREADONLY_on(sstr);
4122 /* Make the source SV into a loop of 1.
4123 (about to become 2) */
4124 SV_COW_NEXT_SV_SET(sstr, sstr);
4128 /* Initial code is common. */
4129 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4131 SvFLAGS(dstr) &= ~SVf_OOK;
4132 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4134 else if (SvLEN(dstr))
4135 Safefree(SvPVX_const(dstr));
4139 /* making another shared SV. */
4140 STRLEN cur = SvCUR(sstr);
4141 STRLEN len = SvLEN(sstr);
4142 #ifdef PERL_OLD_COPY_ON_WRITE
4144 assert (SvTYPE(dstr) >= SVt_PVIV);
4145 /* SvIsCOW_normal */
4146 /* splice us in between source and next-after-source. */
4147 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4148 SV_COW_NEXT_SV_SET(sstr, dstr);
4149 SvPV_set(dstr, SvPVX_mutable(sstr));
4153 /* SvIsCOW_shared_hash */
4154 DEBUG_C(PerlIO_printf(Perl_debug_log,
4155 "Copy on write: Sharing hash\n"));
4157 assert (SvTYPE(dstr) >= SVt_PV);
4159 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4161 SvLEN_set(dstr, len);
4162 SvCUR_set(dstr, cur);
4163 SvREADONLY_on(dstr);
4165 /* Relesase a global SV mutex. */
4168 { /* Passes the swipe test. */
4169 SvPV_set(dstr, SvPVX_mutable(sstr));
4170 SvLEN_set(dstr, SvLEN(sstr));
4171 SvCUR_set(dstr, SvCUR(sstr));
4174 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4175 SvPV_set(sstr, Nullch);
4181 if (sflags & SVf_UTF8)
4183 if (sflags & SVp_NOK) {
4185 if (sflags & SVf_NOK)
4186 SvFLAGS(dstr) |= SVf_NOK;
4187 SvNV_set(dstr, SvNVX(sstr));
4189 if (sflags & SVp_IOK) {
4190 (void)SvIOKp_on(dstr);
4191 if (sflags & SVf_IOK)
4192 SvFLAGS(dstr) |= SVf_IOK;
4193 if (sflags & SVf_IVisUV)
4195 SvIV_set(dstr, SvIVX(sstr));
4198 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4199 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4200 smg->mg_ptr, smg->mg_len);
4201 SvRMAGICAL_on(dstr);
4204 else if (sflags & SVp_IOK) {
4205 if (sflags & SVf_IOK)
4206 (void)SvIOK_only(dstr);
4208 (void)SvOK_off(dstr);
4209 (void)SvIOKp_on(dstr);
4211 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4212 if (sflags & SVf_IVisUV)
4214 SvIV_set(dstr, SvIVX(sstr));
4215 if (sflags & SVp_NOK) {
4216 if (sflags & SVf_NOK)
4217 (void)SvNOK_on(dstr);
4219 (void)SvNOKp_on(dstr);
4220 SvNV_set(dstr, SvNVX(sstr));
4223 else if (sflags & SVp_NOK) {
4224 if (sflags & SVf_NOK)
4225 (void)SvNOK_only(dstr);
4227 (void)SvOK_off(dstr);
4230 SvNV_set(dstr, SvNVX(sstr));
4233 if (dtype == SVt_PVGV) {
4234 if (ckWARN(WARN_MISC))
4235 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4238 (void)SvOK_off(dstr);
4240 if (SvTAINTED(sstr))
4245 =for apidoc sv_setsv_mg
4247 Like C<sv_setsv>, but also handles 'set' magic.
4253 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4255 sv_setsv(dstr,sstr);
4259 #ifdef PERL_OLD_COPY_ON_WRITE
4261 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4263 STRLEN cur = SvCUR(sstr);
4264 STRLEN len = SvLEN(sstr);
4265 register char *new_pv;
4268 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4276 if (SvTHINKFIRST(dstr))
4277 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4278 else if (SvPVX_const(dstr))
4279 Safefree(SvPVX_const(dstr));
4283 SvUPGRADE(dstr, SVt_PVIV);
4285 assert (SvPOK(sstr));
4286 assert (SvPOKp(sstr));
4287 assert (!SvIOK(sstr));
4288 assert (!SvIOKp(sstr));
4289 assert (!SvNOK(sstr));
4290 assert (!SvNOKp(sstr));
4292 if (SvIsCOW(sstr)) {
4294 if (SvLEN(sstr) == 0) {
4295 /* source is a COW shared hash key. */
4296 DEBUG_C(PerlIO_printf(Perl_debug_log,
4297 "Fast copy on write: Sharing hash\n"));
4298 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4301 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4303 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4304 SvUPGRADE(sstr, SVt_PVIV);
4305 SvREADONLY_on(sstr);
4307 DEBUG_C(PerlIO_printf(Perl_debug_log,
4308 "Fast copy on write: Converting sstr to COW\n"));
4309 SV_COW_NEXT_SV_SET(dstr, sstr);
4311 SV_COW_NEXT_SV_SET(sstr, dstr);
4312 new_pv = SvPVX_mutable(sstr);
4315 SvPV_set(dstr, new_pv);
4316 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4319 SvLEN_set(dstr, len);
4320 SvCUR_set(dstr, cur);
4329 =for apidoc sv_setpvn
4331 Copies a string into an SV. The C<len> parameter indicates the number of
4332 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4333 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4339 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4341 register char *dptr;
4343 SV_CHECK_THINKFIRST_COW_DROP(sv);
4349 /* len is STRLEN which is unsigned, need to copy to signed */
4352 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4354 SvUPGRADE(sv, SVt_PV);
4356 dptr = SvGROW(sv, len + 1);
4357 Move(ptr,dptr,len,char);
4360 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4365 =for apidoc sv_setpvn_mg
4367 Like C<sv_setpvn>, but also handles 'set' magic.
4373 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4375 sv_setpvn(sv,ptr,len);
4380 =for apidoc sv_setpv
4382 Copies a string into an SV. The string must be null-terminated. Does not
4383 handle 'set' magic. See C<sv_setpv_mg>.
4389 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4391 register STRLEN len;
4393 SV_CHECK_THINKFIRST_COW_DROP(sv);
4399 SvUPGRADE(sv, SVt_PV);
4401 SvGROW(sv, len + 1);
4402 Move(ptr,SvPVX(sv),len+1,char);
4404 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4409 =for apidoc sv_setpv_mg
4411 Like C<sv_setpv>, but also handles 'set' magic.
4417 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4424 =for apidoc sv_usepvn
4426 Tells an SV to use C<ptr> to find its string value. Normally the string is
4427 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4428 The C<ptr> should point to memory that was allocated by C<malloc>. The
4429 string length, C<len>, must be supplied. This function will realloc the
4430 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4431 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4432 See C<sv_usepvn_mg>.
4438 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4441 SV_CHECK_THINKFIRST_COW_DROP(sv);
4442 SvUPGRADE(sv, SVt_PV);
4447 if (SvPVX_const(sv))
4450 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4451 ptr = saferealloc (ptr, allocate);
4454 SvLEN_set(sv, allocate);
4456 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4461 =for apidoc sv_usepvn_mg
4463 Like C<sv_usepvn>, but also handles 'set' magic.
4469 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4471 sv_usepvn(sv,ptr,len);
4475 #ifdef PERL_OLD_COPY_ON_WRITE
4476 /* Need to do this *after* making the SV normal, as we need the buffer
4477 pointer to remain valid until after we've copied it. If we let go too early,
4478 another thread could invalidate it by unsharing last of the same hash key
4479 (which it can do by means other than releasing copy-on-write Svs)
4480 or by changing the other copy-on-write SVs in the loop. */
4482 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4484 if (len) { /* this SV was SvIsCOW_normal(sv) */
4485 /* we need to find the SV pointing to us. */
4486 SV *current = SV_COW_NEXT_SV(after);
4488 if (current == sv) {
4489 /* The SV we point to points back to us (there were only two of us
4491 Hence other SV is no longer copy on write either. */
4493 SvREADONLY_off(after);
4495 /* We need to follow the pointers around the loop. */
4497 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4500 /* don't loop forever if the structure is bust, and we have
4501 a pointer into a closed loop. */
4502 assert (current != after);
4503 assert (SvPVX_const(current) == pvx);
4505 /* Make the SV before us point to the SV after us. */
4506 SV_COW_NEXT_SV_SET(current, after);
4509 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4514 Perl_sv_release_IVX(pTHX_ register SV *sv)
4517 sv_force_normal_flags(sv, 0);
4523 =for apidoc sv_force_normal_flags
4525 Undo various types of fakery on an SV: if the PV is a shared string, make
4526 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4527 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4528 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4529 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4530 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4531 set to some other value.) In addition, the C<flags> parameter gets passed to
4532 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4533 with flags set to 0.
4539 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4541 #ifdef PERL_OLD_COPY_ON_WRITE
4542 if (SvREADONLY(sv)) {
4543 /* At this point I believe I should acquire a global SV mutex. */
4545 const char *pvx = SvPVX_const(sv);
4546 const STRLEN len = SvLEN(sv);
4547 const STRLEN cur = SvCUR(sv);
4548 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4550 PerlIO_printf(Perl_debug_log,
4551 "Copy on write: Force normal %ld\n",
4557 /* This SV doesn't own the buffer, so need to New() a new one: */
4558 SvPV_set(sv, (char*)0);
4560 if (flags & SV_COW_DROP_PV) {
4561 /* OK, so we don't need to copy our buffer. */
4564 SvGROW(sv, cur + 1);
4565 Move(pvx,SvPVX(sv),cur,char);
4569 sv_release_COW(sv, pvx, len, next);
4574 else if (IN_PERL_RUNTIME)
4575 Perl_croak(aTHX_ PL_no_modify);
4576 /* At this point I believe that I can drop the global SV mutex. */
4579 if (SvREADONLY(sv)) {
4581 const char *pvx = SvPVX_const(sv);
4582 const STRLEN len = SvCUR(sv);
4585 SvPV_set(sv, Nullch);
4587 SvGROW(sv, len + 1);
4588 Move(pvx,SvPVX_const(sv),len,char);
4590 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4592 else if (IN_PERL_RUNTIME)
4593 Perl_croak(aTHX_ PL_no_modify);
4597 sv_unref_flags(sv, flags);
4598 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4603 =for apidoc sv_force_normal
4605 Undo various types of fakery on an SV: if the PV is a shared string, make
4606 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4607 an xpvmg. See also C<sv_force_normal_flags>.
4613 Perl_sv_force_normal(pTHX_ register SV *sv)
4615 sv_force_normal_flags(sv, 0);
4621 Efficient removal of characters from the beginning of the string buffer.
4622 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4623 the string buffer. The C<ptr> becomes the first character of the adjusted
4624 string. Uses the "OOK hack".
4625 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4626 refer to the same chunk of data.
4632 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4634 register STRLEN delta;
4635 if (!ptr || !SvPOKp(sv))
4637 delta = ptr - SvPVX_const(sv);
4638 SV_CHECK_THINKFIRST(sv);
4639 if (SvTYPE(sv) < SVt_PVIV)
4640 sv_upgrade(sv,SVt_PVIV);
4643 if (!SvLEN(sv)) { /* make copy of shared string */
4644 const char *pvx = SvPVX_const(sv);
4645 const STRLEN len = SvCUR(sv);
4646 SvGROW(sv, len + 1);
4647 Move(pvx,SvPVX_const(sv),len,char);
4651 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4652 and we do that anyway inside the SvNIOK_off
4654 SvFLAGS(sv) |= SVf_OOK;
4657 SvLEN_set(sv, SvLEN(sv) - delta);
4658 SvCUR_set(sv, SvCUR(sv) - delta);
4659 SvPV_set(sv, SvPVX(sv) + delta);
4660 SvIV_set(sv, SvIVX(sv) + delta);
4663 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4664 * this function provided for binary compatibility only
4668 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4670 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4674 =for apidoc sv_catpvn
4676 Concatenates the string onto the end of the string which is in the SV. The
4677 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4678 status set, then the bytes appended should be valid UTF-8.
4679 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4681 =for apidoc sv_catpvn_flags
4683 Concatenates the string onto the end of the string which is in the SV. The
4684 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4685 status set, then the bytes appended should be valid UTF-8.
4686 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4687 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4688 in terms of this function.
4694 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4697 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4699 SvGROW(dsv, dlen + slen + 1);
4701 sstr = SvPVX_const(dsv);
4702 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4703 SvCUR_set(dsv, SvCUR(dsv) + slen);
4705 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4710 =for apidoc sv_catpvn_mg
4712 Like C<sv_catpvn>, but also handles 'set' magic.
4718 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4720 sv_catpvn(sv,ptr,len);
4724 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4725 * this function provided for binary compatibility only
4729 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4731 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4735 =for apidoc sv_catsv
4737 Concatenates the string from SV C<ssv> onto the end of the string in
4738 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4739 not 'set' magic. See C<sv_catsv_mg>.
4741 =for apidoc sv_catsv_flags
4743 Concatenates the string from SV C<ssv> onto the end of the string in
4744 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4745 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4746 and C<sv_catsv_nomg> are implemented in terms of this function.
4751 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4757 if ((spv = SvPV_const(ssv, slen))) {
4758 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4759 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4760 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4761 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4762 dsv->sv_flags doesn't have that bit set.
4763 Andy Dougherty 12 Oct 2001
4765 const I32 sutf8 = DO_UTF8(ssv);
4768 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4770 dutf8 = DO_UTF8(dsv);
4772 if (dutf8 != sutf8) {
4774 /* Not modifying source SV, so taking a temporary copy. */
4775 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4777 sv_utf8_upgrade(csv);
4778 spv = SvPV_const(csv, slen);
4781 sv_utf8_upgrade_nomg(dsv);
4783 sv_catpvn_nomg(dsv, spv, slen);
4788 =for apidoc sv_catsv_mg
4790 Like C<sv_catsv>, but also handles 'set' magic.
4796 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4803 =for apidoc sv_catpv
4805 Concatenates the string onto the end of the string which is in the SV.
4806 If the SV has the UTF-8 status set, then the bytes appended should be
4807 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4812 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4814 register STRLEN len;
4820 junk = SvPV_force(sv, tlen);
4822 SvGROW(sv, tlen + len + 1);
4824 ptr = SvPVX_const(sv);
4825 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4826 SvCUR_set(sv, SvCUR(sv) + len);
4827 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4832 =for apidoc sv_catpv_mg
4834 Like C<sv_catpv>, but also handles 'set' magic.
4840 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4849 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4850 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4857 Perl_newSV(pTHX_ STRLEN len)
4863 sv_upgrade(sv, SVt_PV);
4864 SvGROW(sv, len + 1);
4869 =for apidoc sv_magicext
4871 Adds magic to an SV, upgrading it if necessary. Applies the
4872 supplied vtable and returns a pointer to the magic added.
4874 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4875 In particular, you can add magic to SvREADONLY SVs, and add more than
4876 one instance of the same 'how'.
4878 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4879 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4880 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4881 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4883 (This is now used as a subroutine by C<sv_magic>.)
4888 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4889 const char* name, I32 namlen)
4893 if (SvTYPE(sv) < SVt_PVMG) {
4894 SvUPGRADE(sv, SVt_PVMG);
4896 Newz(702,mg, 1, MAGIC);
4897 mg->mg_moremagic = SvMAGIC(sv);
4898 SvMAGIC_set(sv, mg);
4900 /* Sometimes a magic contains a reference loop, where the sv and
4901 object refer to each other. To prevent a reference loop that
4902 would prevent such objects being freed, we look for such loops
4903 and if we find one we avoid incrementing the object refcount.
4905 Note we cannot do this to avoid self-tie loops as intervening RV must
4906 have its REFCNT incremented to keep it in existence.
4909 if (!obj || obj == sv ||
4910 how == PERL_MAGIC_arylen ||
4911 how == PERL_MAGIC_qr ||
4912 how == PERL_MAGIC_symtab ||
4913 (SvTYPE(obj) == SVt_PVGV &&
4914 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4915 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4916 GvFORM(obj) == (CV*)sv)))
4921 mg->mg_obj = SvREFCNT_inc(obj);
4922 mg->mg_flags |= MGf_REFCOUNTED;
4925 /* Normal self-ties simply pass a null object, and instead of
4926 using mg_obj directly, use the SvTIED_obj macro to produce a
4927 new RV as needed. For glob "self-ties", we are tieing the PVIO
4928 with an RV obj pointing to the glob containing the PVIO. In
4929 this case, to avoid a reference loop, we need to weaken the
4933 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4934 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4940 mg->mg_len = namlen;
4943 mg->mg_ptr = savepvn(name, namlen);
4944 else if (namlen == HEf_SVKEY)
4945 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4947 mg->mg_ptr = (char *) name;
4949 mg->mg_virtual = vtable;
4953 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4958 =for apidoc sv_magic
4960 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4961 then adds a new magic item of type C<how> to the head of the magic list.
4963 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4964 handling of the C<name> and C<namlen> arguments.
4966 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4967 to add more than one instance of the same 'how'.
4973 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4975 const MGVTBL *vtable = 0;
4978 #ifdef PERL_OLD_COPY_ON_WRITE
4980 sv_force_normal_flags(sv, 0);
4982 if (SvREADONLY(sv)) {
4984 && how != PERL_MAGIC_regex_global
4985 && how != PERL_MAGIC_bm
4986 && how != PERL_MAGIC_fm
4987 && how != PERL_MAGIC_sv
4988 && how != PERL_MAGIC_backref
4991 Perl_croak(aTHX_ PL_no_modify);
4994 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4995 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4996 /* sv_magic() refuses to add a magic of the same 'how' as an
4999 if (how == PERL_MAGIC_taint)
5007 vtable = &PL_vtbl_sv;
5009 case PERL_MAGIC_overload:
5010 vtable = &PL_vtbl_amagic;
5012 case PERL_MAGIC_overload_elem:
5013 vtable = &PL_vtbl_amagicelem;
5015 case PERL_MAGIC_overload_table:
5016 vtable = &PL_vtbl_ovrld;
5019 vtable = &PL_vtbl_bm;
5021 case PERL_MAGIC_regdata:
5022 vtable = &PL_vtbl_regdata;
5024 case PERL_MAGIC_regdatum:
5025 vtable = &PL_vtbl_regdatum;
5027 case PERL_MAGIC_env:
5028 vtable = &PL_vtbl_env;
5031 vtable = &PL_vtbl_fm;
5033 case PERL_MAGIC_envelem:
5034 vtable = &PL_vtbl_envelem;
5036 case PERL_MAGIC_regex_global:
5037 vtable = &PL_vtbl_mglob;
5039 case PERL_MAGIC_isa:
5040 vtable = &PL_vtbl_isa;
5042 case PERL_MAGIC_isaelem:
5043 vtable = &PL_vtbl_isaelem;
5045 case PERL_MAGIC_nkeys:
5046 vtable = &PL_vtbl_nkeys;
5048 case PERL_MAGIC_dbfile:
5051 case PERL_MAGIC_dbline:
5052 vtable = &PL_vtbl_dbline;
5054 #ifdef USE_LOCALE_COLLATE
5055 case PERL_MAGIC_collxfrm:
5056 vtable = &PL_vtbl_collxfrm;
5058 #endif /* USE_LOCALE_COLLATE */
5059 case PERL_MAGIC_tied:
5060 vtable = &PL_vtbl_pack;
5062 case PERL_MAGIC_tiedelem:
5063 case PERL_MAGIC_tiedscalar:
5064 vtable = &PL_vtbl_packelem;
5067 vtable = &PL_vtbl_regexp;
5069 case PERL_MAGIC_sig:
5070 vtable = &PL_vtbl_sig;
5072 case PERL_MAGIC_sigelem:
5073 vtable = &PL_vtbl_sigelem;
5075 case PERL_MAGIC_taint:
5076 vtable = &PL_vtbl_taint;
5078 case PERL_MAGIC_uvar:
5079 vtable = &PL_vtbl_uvar;
5081 case PERL_MAGIC_vec:
5082 vtable = &PL_vtbl_vec;
5084 case PERL_MAGIC_arylen_p:
5085 case PERL_MAGIC_rhash:
5086 case PERL_MAGIC_symtab:
5087 case PERL_MAGIC_vstring:
5090 case PERL_MAGIC_utf8:
5091 vtable = &PL_vtbl_utf8;
5093 case PERL_MAGIC_substr:
5094 vtable = &PL_vtbl_substr;
5096 case PERL_MAGIC_defelem:
5097 vtable = &PL_vtbl_defelem;
5099 case PERL_MAGIC_glob:
5100 vtable = &PL_vtbl_glob;
5102 case PERL_MAGIC_arylen:
5103 vtable = &PL_vtbl_arylen;
5105 case PERL_MAGIC_pos:
5106 vtable = &PL_vtbl_pos;
5108 case PERL_MAGIC_backref:
5109 vtable = &PL_vtbl_backref;
5111 case PERL_MAGIC_ext:
5112 /* Reserved for use by extensions not perl internals. */
5113 /* Useful for attaching extension internal data to perl vars. */
5114 /* Note that multiple extensions may clash if magical scalars */
5115 /* etc holding private data from one are passed to another. */
5118 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5121 /* Rest of work is done else where */
5122 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5125 case PERL_MAGIC_taint:
5128 case PERL_MAGIC_ext:
5129 case PERL_MAGIC_dbfile:
5136 =for apidoc sv_unmagic
5138 Removes all magic of type C<type> from an SV.
5144 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5148 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5151 for (mg = *mgp; mg; mg = *mgp) {
5152 if (mg->mg_type == type) {
5153 const MGVTBL* const vtbl = mg->mg_virtual;
5154 *mgp = mg->mg_moremagic;
5155 if (vtbl && vtbl->svt_free)
5156 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5157 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5159 Safefree(mg->mg_ptr);
5160 else if (mg->mg_len == HEf_SVKEY)
5161 SvREFCNT_dec((SV*)mg->mg_ptr);
5162 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5163 Safefree(mg->mg_ptr);
5165 if (mg->mg_flags & MGf_REFCOUNTED)
5166 SvREFCNT_dec(mg->mg_obj);
5170 mgp = &mg->mg_moremagic;
5174 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5181 =for apidoc sv_rvweaken
5183 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5184 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5185 push a back-reference to this RV onto the array of backreferences
5186 associated with that magic.
5192 Perl_sv_rvweaken(pTHX_ SV *sv)
5195 if (!SvOK(sv)) /* let undefs pass */
5198 Perl_croak(aTHX_ "Can't weaken a nonreference");
5199 else if (SvWEAKREF(sv)) {
5200 if (ckWARN(WARN_MISC))
5201 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5205 sv_add_backref(tsv, sv);
5211 /* Give tsv backref magic if it hasn't already got it, then push a
5212 * back-reference to sv onto the array associated with the backref magic.
5216 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5220 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5221 av = (AV*)mg->mg_obj;
5224 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5225 /* av now has a refcnt of 2, which avoids it getting freed
5226 * before us during global cleanup. The extra ref is removed
5227 * by magic_killbackrefs() when tsv is being freed */
5229 if (AvFILLp(av) >= AvMAX(av)) {
5231 SV **svp = AvARRAY(av);
5232 for (i = AvFILLp(av); i >= 0; i--)
5234 svp[i] = sv; /* reuse the slot */
5237 av_extend(av, AvFILLp(av)+1);
5239 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5242 /* delete a back-reference to ourselves from the backref magic associated
5243 * with the SV we point to.
5247 S_sv_del_backref(pTHX_ SV *sv)
5254 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5255 Perl_croak(aTHX_ "panic: del_backref");
5256 av = (AV *)mg->mg_obj;
5258 for (i = AvFILLp(av); i >= 0; i--)
5259 if (svp[i] == sv) svp[i] = Nullsv;
5263 =for apidoc sv_insert
5265 Inserts a string at the specified offset/length within the SV. Similar to
5266 the Perl substr() function.
5272 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5276 register char *midend;
5277 register char *bigend;
5283 Perl_croak(aTHX_ "Can't modify non-existent substring");
5284 SvPV_force(bigstr, curlen);
5285 (void)SvPOK_only_UTF8(bigstr);
5286 if (offset + len > curlen) {
5287 SvGROW(bigstr, offset+len+1);
5288 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5289 SvCUR_set(bigstr, offset+len);
5293 i = littlelen - len;
5294 if (i > 0) { /* string might grow */
5295 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5296 mid = big + offset + len;
5297 midend = bigend = big + SvCUR(bigstr);
5300 while (midend > mid) /* shove everything down */
5301 *--bigend = *--midend;
5302 Move(little,big+offset,littlelen,char);
5303 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5308 Move(little,SvPVX(bigstr)+offset,len,char);
5313 big = SvPVX(bigstr);
5316 bigend = big + SvCUR(bigstr);
5318 if (midend > bigend)
5319 Perl_croak(aTHX_ "panic: sv_insert");
5321 if (mid - big > bigend - midend) { /* faster to shorten from end */
5323 Move(little, mid, littlelen,char);
5326 i = bigend - midend;
5328 Move(midend, mid, i,char);
5332 SvCUR_set(bigstr, mid - big);
5334 else if ((i = mid - big)) { /* faster from front */
5335 midend -= littlelen;
5337 sv_chop(bigstr,midend-i);
5342 Move(little, mid, littlelen,char);
5344 else if (littlelen) {
5345 midend -= littlelen;
5346 sv_chop(bigstr,midend);
5347 Move(little,midend,littlelen,char);
5350 sv_chop(bigstr,midend);
5356 =for apidoc sv_replace
5358 Make the first argument a copy of the second, then delete the original.
5359 The target SV physically takes over ownership of the body of the source SV
5360 and inherits its flags; however, the target keeps any magic it owns,
5361 and any magic in the source is discarded.
5362 Note that this is a rather specialist SV copying operation; most of the
5363 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5369 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5371 const U32 refcnt = SvREFCNT(sv);
5372 SV_CHECK_THINKFIRST_COW_DROP(sv);
5373 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5374 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5375 if (SvMAGICAL(sv)) {
5379 sv_upgrade(nsv, SVt_PVMG);
5380 SvMAGIC_set(nsv, SvMAGIC(sv));
5381 SvFLAGS(nsv) |= SvMAGICAL(sv);
5383 SvMAGIC_set(sv, NULL);
5387 assert(!SvREFCNT(sv));
5388 #ifdef DEBUG_LEAKING_SCALARS
5389 sv->sv_flags = nsv->sv_flags;
5390 sv->sv_any = nsv->sv_any;
5391 sv->sv_refcnt = nsv->sv_refcnt;
5392 sv->sv_u = nsv->sv_u;
5394 StructCopy(nsv,sv,SV);
5396 /* Currently could join these into one piece of pointer arithmetic, but
5397 it would be unclear. */
5398 if(SvTYPE(sv) == SVt_IV)
5400 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5401 else if (SvTYPE(sv) == SVt_RV) {
5402 SvANY(sv) = &sv->sv_u.svu_rv;
5406 #ifdef PERL_OLD_COPY_ON_WRITE
5407 if (SvIsCOW_normal(nsv)) {
5408 /* We need to follow the pointers around the loop to make the
5409 previous SV point to sv, rather than nsv. */
5412 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5415 assert(SvPVX_const(current) == SvPVX_const(nsv));
5417 /* Make the SV before us point to the SV after us. */
5419 PerlIO_printf(Perl_debug_log, "previous is\n");
5421 PerlIO_printf(Perl_debug_log,
5422 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5423 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5425 SV_COW_NEXT_SV_SET(current, sv);
5428 SvREFCNT(sv) = refcnt;
5429 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5435 =for apidoc sv_clear
5437 Clear an SV: call any destructors, free up any memory used by the body,
5438 and free the body itself. The SV's head is I<not> freed, although
5439 its type is set to all 1's so that it won't inadvertently be assumed
5440 to be live during global destruction etc.
5441 This function should only be called when REFCNT is zero. Most of the time
5442 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5449 Perl_sv_clear(pTHX_ register SV *sv)
5454 assert(SvREFCNT(sv) == 0);
5457 if (PL_defstash) { /* Still have a symbol table? */
5461 stash = SvSTASH(sv);
5462 destructor = StashHANDLER(stash,DESTROY);
5464 SV* tmpref = newRV(sv);
5465 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5467 PUSHSTACKi(PERLSI_DESTROY);
5472 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5478 if(SvREFCNT(tmpref) < 2) {
5479 /* tmpref is not kept alive! */
5481 SvRV_set(tmpref, NULL);
5484 SvREFCNT_dec(tmpref);
5486 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5490 if (PL_in_clean_objs)
5491 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5493 /* DESTROY gave object new lease on life */
5499 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5500 SvOBJECT_off(sv); /* Curse the object. */
5501 if (SvTYPE(sv) != SVt_PVIO)
5502 --PL_sv_objcount; /* XXX Might want something more general */
5505 if (SvTYPE(sv) >= SVt_PVMG) {
5508 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5509 SvREFCNT_dec(SvSTASH(sv));
5512 switch (SvTYPE(sv)) {
5515 IoIFP(sv) != PerlIO_stdin() &&
5516 IoIFP(sv) != PerlIO_stdout() &&
5517 IoIFP(sv) != PerlIO_stderr())
5519 io_close((IO*)sv, FALSE);
5521 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5522 PerlDir_close(IoDIRP(sv));
5523 IoDIRP(sv) = (DIR*)NULL;
5524 Safefree(IoTOP_NAME(sv));
5525 Safefree(IoFMT_NAME(sv));
5526 Safefree(IoBOTTOM_NAME(sv));
5541 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5542 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5543 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5544 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5546 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5547 SvREFCNT_dec(LvTARG(sv));
5551 Safefree(GvNAME(sv));
5552 /* cannot decrease stash refcount yet, as we might recursively delete
5553 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5554 of stash until current sv is completely gone.
5555 -- JohnPC, 27 Mar 1998 */
5556 stash = GvSTASH(sv);
5562 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5564 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5565 /* Don't even bother with turning off the OOK flag. */
5574 SvREFCNT_dec(SvRV(sv));
5576 #ifdef PERL_OLD_COPY_ON_WRITE
5577 else if (SvPVX_const(sv)) {
5579 /* I believe I need to grab the global SV mutex here and
5580 then recheck the COW status. */
5582 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5585 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5586 SV_COW_NEXT_SV(sv));
5587 /* And drop it here. */
5589 } else if (SvLEN(sv)) {
5590 Safefree(SvPVX_const(sv));
5594 else if (SvPVX_const(sv) && SvLEN(sv))
5595 Safefree(SvPVX_const(sv));
5596 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5597 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5610 switch (SvTYPE(sv)) {
5624 del_XPVIV(SvANY(sv));
5627 del_XPVNV(SvANY(sv));
5630 del_XPVMG(SvANY(sv));
5633 del_XPVLV(SvANY(sv));
5636 del_XPVAV(SvANY(sv));
5639 del_XPVHV(SvANY(sv));
5642 del_XPVCV(SvANY(sv));
5645 del_XPVGV(SvANY(sv));
5646 /* code duplication for increased performance. */
5647 SvFLAGS(sv) &= SVf_BREAK;
5648 SvFLAGS(sv) |= SVTYPEMASK;
5649 /* decrease refcount of the stash that owns this GV, if any */
5651 SvREFCNT_dec(stash);
5652 return; /* not break, SvFLAGS reset already happened */
5654 del_XPVBM(SvANY(sv));
5657 del_XPVFM(SvANY(sv));
5660 del_XPVIO(SvANY(sv));
5663 SvFLAGS(sv) &= SVf_BREAK;
5664 SvFLAGS(sv) |= SVTYPEMASK;
5668 =for apidoc sv_newref
5670 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5677 Perl_sv_newref(pTHX_ SV *sv)
5687 Decrement an SV's reference count, and if it drops to zero, call
5688 C<sv_clear> to invoke destructors and free up any memory used by
5689 the body; finally, deallocate the SV's head itself.
5690 Normally called via a wrapper macro C<SvREFCNT_dec>.
5696 Perl_sv_free(pTHX_ SV *sv)
5701 if (SvREFCNT(sv) == 0) {
5702 if (SvFLAGS(sv) & SVf_BREAK)
5703 /* this SV's refcnt has been artificially decremented to
5704 * trigger cleanup */
5706 if (PL_in_clean_all) /* All is fair */
5708 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5709 /* make sure SvREFCNT(sv)==0 happens very seldom */
5710 SvREFCNT(sv) = (~(U32)0)/2;
5713 if (ckWARN_d(WARN_INTERNAL))
5714 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5715 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5716 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5719 if (--(SvREFCNT(sv)) > 0)
5721 Perl_sv_free2(aTHX_ sv);
5725 Perl_sv_free2(pTHX_ SV *sv)
5730 if (ckWARN_d(WARN_DEBUGGING))
5731 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5732 "Attempt to free temp prematurely: SV 0x%"UVxf
5733 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5737 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5738 /* make sure SvREFCNT(sv)==0 happens very seldom */
5739 SvREFCNT(sv) = (~(U32)0)/2;
5750 Returns the length of the string in the SV. Handles magic and type
5751 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5757 Perl_sv_len(pTHX_ register SV *sv)
5765 len = mg_length(sv);
5767 (void)SvPV_const(sv, len);
5772 =for apidoc sv_len_utf8
5774 Returns the number of characters in the string in an SV, counting wide
5775 UTF-8 bytes as a single character. Handles magic and type coercion.
5781 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5782 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5783 * (Note that the mg_len is not the length of the mg_ptr field.)
5788 Perl_sv_len_utf8(pTHX_ register SV *sv)
5794 return mg_length(sv);
5798 const U8 *s = (U8*)SvPV_const(sv, len);
5799 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5801 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5803 #ifdef PERL_UTF8_CACHE_ASSERT
5804 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5808 ulen = Perl_utf8_length(aTHX_ s, s + len);
5809 if (!mg && !SvREADONLY(sv)) {
5810 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5811 mg = mg_find(sv, PERL_MAGIC_utf8);
5821 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5822 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5823 * between UTF-8 and byte offsets. There are two (substr offset and substr
5824 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5825 * and byte offset) cache positions.
5827 * The mg_len field is used by sv_len_utf8(), see its comments.
5828 * Note that the mg_len is not the length of the mg_ptr field.
5832 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5833 I32 offsetp, const U8 *s, const U8 *start)
5837 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5839 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5843 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5845 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5846 (*mgp)->mg_ptr = (char *) *cachep;
5850 (*cachep)[i] = offsetp;
5851 (*cachep)[i+1] = s - start;
5859 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5860 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5861 * between UTF-8 and byte offsets. See also the comments of
5862 * S_utf8_mg_pos_init().
5866 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5870 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5872 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5873 if (*mgp && (*mgp)->mg_ptr) {
5874 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5875 ASSERT_UTF8_CACHE(*cachep);
5876 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5878 else { /* We will skip to the right spot. */
5883 /* The assumption is that going backward is half
5884 * the speed of going forward (that's where the
5885 * 2 * backw in the below comes from). (The real
5886 * figure of course depends on the UTF-8 data.) */
5888 if ((*cachep)[i] > (STRLEN)uoff) {
5890 backw = (*cachep)[i] - (STRLEN)uoff;
5892 if (forw < 2 * backw)
5895 p = start + (*cachep)[i+1];
5897 /* Try this only for the substr offset (i == 0),
5898 * not for the substr length (i == 2). */
5899 else if (i == 0) { /* (*cachep)[i] < uoff */
5900 const STRLEN ulen = sv_len_utf8(sv);
5902 if ((STRLEN)uoff < ulen) {
5903 forw = (STRLEN)uoff - (*cachep)[i];
5904 backw = ulen - (STRLEN)uoff;
5906 if (forw < 2 * backw)
5907 p = start + (*cachep)[i+1];
5912 /* If the string is not long enough for uoff,
5913 * we could extend it, but not at this low a level. */
5917 if (forw < 2 * backw) {
5924 while (UTF8_IS_CONTINUATION(*p))
5929 /* Update the cache. */
5930 (*cachep)[i] = (STRLEN)uoff;
5931 (*cachep)[i+1] = p - start;
5933 /* Drop the stale "length" cache */
5942 if (found) { /* Setup the return values. */
5943 *offsetp = (*cachep)[i+1];
5944 *sp = start + *offsetp;
5947 *offsetp = send - start;
5949 else if (*sp < start) {
5955 #ifdef PERL_UTF8_CACHE_ASSERT
5960 while (n-- && s < send)
5964 assert(*offsetp == s - start);
5965 assert((*cachep)[0] == (STRLEN)uoff);
5966 assert((*cachep)[1] == *offsetp);
5968 ASSERT_UTF8_CACHE(*cachep);
5977 =for apidoc sv_pos_u2b
5979 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5980 the start of the string, to a count of the equivalent number of bytes; if
5981 lenp is non-zero, it does the same to lenp, but this time starting from
5982 the offset, rather than from the start of the string. Handles magic and
5989 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5990 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5991 * byte offsets. See also the comments of S_utf8_mg_pos().
5996 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6004 start = (U8*)SvPV_const(sv, len);
6008 const U8 *s = start;
6009 I32 uoffset = *offsetp;
6010 const U8 *send = s + len;
6014 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6016 if (!found && uoffset > 0) {
6017 while (s < send && uoffset--)
6021 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6023 *offsetp = s - start;
6028 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6032 if (!found && *lenp > 0) {
6035 while (s < send && ulen--)
6039 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6043 ASSERT_UTF8_CACHE(cache);
6055 =for apidoc sv_pos_b2u
6057 Converts the value pointed to by offsetp from a count of bytes from the
6058 start of the string, to a count of the equivalent number of UTF-8 chars.
6059 Handles magic and type coercion.
6065 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6066 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6067 * byte offsets. See also the comments of S_utf8_mg_pos().
6072 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6080 s = (const U8*)SvPV_const(sv, len);
6081 if ((I32)len < *offsetp)
6082 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6084 const U8* send = s + *offsetp;
6086 STRLEN *cache = NULL;
6090 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6091 mg = mg_find(sv, PERL_MAGIC_utf8);
6092 if (mg && mg->mg_ptr) {
6093 cache = (STRLEN *) mg->mg_ptr;
6094 if (cache[1] == (STRLEN)*offsetp) {
6095 /* An exact match. */
6096 *offsetp = cache[0];
6100 else if (cache[1] < (STRLEN)*offsetp) {
6101 /* We already know part of the way. */
6104 /* Let the below loop do the rest. */
6106 else { /* cache[1] > *offsetp */
6107 /* We already know all of the way, now we may
6108 * be able to walk back. The same assumption
6109 * is made as in S_utf8_mg_pos(), namely that
6110 * walking backward is twice slower than
6111 * walking forward. */
6112 STRLEN forw = *offsetp;
6113 STRLEN backw = cache[1] - *offsetp;
6115 if (!(forw < 2 * backw)) {
6116 const U8 *p = s + cache[1];
6123 while (UTF8_IS_CONTINUATION(*p)) {
6131 *offsetp = cache[0];
6133 /* Drop the stale "length" cache */
6141 ASSERT_UTF8_CACHE(cache);
6147 /* Call utf8n_to_uvchr() to validate the sequence
6148 * (unless a simple non-UTF character) */
6149 if (!UTF8_IS_INVARIANT(*s))
6150 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6159 if (!SvREADONLY(sv)) {
6161 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6162 mg = mg_find(sv, PERL_MAGIC_utf8);
6167 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6168 mg->mg_ptr = (char *) cache;
6173 cache[1] = *offsetp;
6174 /* Drop the stale "length" cache */
6187 Returns a boolean indicating whether the strings in the two SVs are
6188 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6189 coerce its args to strings if necessary.
6195 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6203 SV* svrecode = Nullsv;
6210 pv1 = SvPV_const(sv1, cur1);
6217 pv2 = SvPV_const(sv2, cur2);
6219 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6220 /* Differing utf8ness.
6221 * Do not UTF8size the comparands as a side-effect. */
6224 svrecode = newSVpvn(pv2, cur2);
6225 sv_recode_to_utf8(svrecode, PL_encoding);
6226 pv2 = SvPV_const(svrecode, cur2);
6229 svrecode = newSVpvn(pv1, cur1);
6230 sv_recode_to_utf8(svrecode, PL_encoding);
6231 pv1 = SvPV_const(svrecode, cur1);
6233 /* Now both are in UTF-8. */
6235 SvREFCNT_dec(svrecode);
6240 bool is_utf8 = TRUE;
6243 /* sv1 is the UTF-8 one,
6244 * if is equal it must be downgrade-able */
6245 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6251 /* sv2 is the UTF-8 one,
6252 * if is equal it must be downgrade-able */
6253 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6259 /* Downgrade not possible - cannot be eq */
6267 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6270 SvREFCNT_dec(svrecode);
6281 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6282 string in C<sv1> is less than, equal to, or greater than the string in
6283 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6284 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6290 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6293 const char *pv1, *pv2;
6296 SV *svrecode = Nullsv;
6303 pv1 = SvPV_const(sv1, cur1);
6310 pv2 = SvPV_const(sv2, cur2);
6312 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6313 /* Differing utf8ness.
6314 * Do not UTF8size the comparands as a side-effect. */
6317 svrecode = newSVpvn(pv2, cur2);
6318 sv_recode_to_utf8(svrecode, PL_encoding);
6319 pv2 = SvPV_const(svrecode, cur2);
6322 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6327 svrecode = newSVpvn(pv1, cur1);
6328 sv_recode_to_utf8(svrecode, PL_encoding);
6329 pv1 = SvPV_const(svrecode, cur1);
6332 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6338 cmp = cur2 ? -1 : 0;
6342 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6345 cmp = retval < 0 ? -1 : 1;
6346 } else if (cur1 == cur2) {
6349 cmp = cur1 < cur2 ? -1 : 1;
6354 SvREFCNT_dec(svrecode);
6363 =for apidoc sv_cmp_locale
6365 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6366 'use bytes' aware, handles get magic, and will coerce its args to strings
6367 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6373 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6375 #ifdef USE_LOCALE_COLLATE
6381 if (PL_collation_standard)
6385 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6387 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6389 if (!pv1 || !len1) {
6400 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6403 return retval < 0 ? -1 : 1;
6406 * When the result of collation is equality, that doesn't mean
6407 * that there are no differences -- some locales exclude some
6408 * characters from consideration. So to avoid false equalities,
6409 * we use the raw string as a tiebreaker.
6415 #endif /* USE_LOCALE_COLLATE */
6417 return sv_cmp(sv1, sv2);
6421 #ifdef USE_LOCALE_COLLATE
6424 =for apidoc sv_collxfrm
6426 Add Collate Transform magic to an SV if it doesn't already have it.
6428 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6429 scalar data of the variable, but transformed to such a format that a normal
6430 memory comparison can be used to compare the data according to the locale
6437 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6441 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6442 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6448 Safefree(mg->mg_ptr);
6449 s = SvPV_const(sv, len);
6450 if ((xf = mem_collxfrm(s, len, &xlen))) {
6451 if (SvREADONLY(sv)) {
6454 return xf + sizeof(PL_collation_ix);
6457 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6458 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6471 if (mg && mg->mg_ptr) {
6473 return mg->mg_ptr + sizeof(PL_collation_ix);
6481 #endif /* USE_LOCALE_COLLATE */
6486 Get a line from the filehandle and store it into the SV, optionally
6487 appending to the currently-stored string.
6493 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6497 register STDCHAR rslast;
6498 register STDCHAR *bp;
6504 if (SvTHINKFIRST(sv))
6505 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6506 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6508 However, perlbench says it's slower, because the existing swipe code
6509 is faster than copy on write.
6510 Swings and roundabouts. */
6511 SvUPGRADE(sv, SVt_PV);
6516 if (PerlIO_isutf8(fp)) {
6518 sv_utf8_upgrade_nomg(sv);
6519 sv_pos_u2b(sv,&append,0);
6521 } else if (SvUTF8(sv)) {
6522 SV *tsv = NEWSV(0,0);
6523 sv_gets(tsv, fp, 0);
6524 sv_utf8_upgrade_nomg(tsv);
6525 SvCUR_set(sv,append);
6528 goto return_string_or_null;
6533 if (PerlIO_isutf8(fp))
6536 if (IN_PERL_COMPILETIME) {
6537 /* we always read code in line mode */
6541 else if (RsSNARF(PL_rs)) {
6542 /* If it is a regular disk file use size from stat() as estimate
6543 of amount we are going to read - may result in malloc-ing
6544 more memory than we realy need if layers bellow reduce
6545 size we read (e.g. CRLF or a gzip layer)
6548 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6549 const Off_t offset = PerlIO_tell(fp);
6550 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6551 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6557 else if (RsRECORD(PL_rs)) {
6561 /* Grab the size of the record we're getting */
6562 recsize = SvIV(SvRV(PL_rs));
6563 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6566 /* VMS wants read instead of fread, because fread doesn't respect */
6567 /* RMS record boundaries. This is not necessarily a good thing to be */
6568 /* doing, but we've got no other real choice - except avoid stdio
6569 as implementation - perhaps write a :vms layer ?
6571 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6573 bytesread = PerlIO_read(fp, buffer, recsize);
6577 SvCUR_set(sv, bytesread += append);
6578 buffer[bytesread] = '\0';
6579 goto return_string_or_null;
6581 else if (RsPARA(PL_rs)) {
6587 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6588 if (PerlIO_isutf8(fp)) {
6589 rsptr = SvPVutf8(PL_rs, rslen);
6592 if (SvUTF8(PL_rs)) {
6593 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6594 Perl_croak(aTHX_ "Wide character in $/");
6597 rsptr = SvPV_const(PL_rs, rslen);
6601 rslast = rslen ? rsptr[rslen - 1] : '\0';
6603 if (rspara) { /* have to do this both before and after */
6604 do { /* to make sure file boundaries work right */
6607 i = PerlIO_getc(fp);
6611 PerlIO_ungetc(fp,i);
6617 /* See if we know enough about I/O mechanism to cheat it ! */
6619 /* This used to be #ifdef test - it is made run-time test for ease
6620 of abstracting out stdio interface. One call should be cheap
6621 enough here - and may even be a macro allowing compile
6625 if (PerlIO_fast_gets(fp)) {
6628 * We're going to steal some values from the stdio struct
6629 * and put EVERYTHING in the innermost loop into registers.
6631 register STDCHAR *ptr;
6635 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6636 /* An ungetc()d char is handled separately from the regular
6637 * buffer, so we getc() it back out and stuff it in the buffer.
6639 i = PerlIO_getc(fp);
6640 if (i == EOF) return 0;
6641 *(--((*fp)->_ptr)) = (unsigned char) i;
6645 /* Here is some breathtakingly efficient cheating */
6647 cnt = PerlIO_get_cnt(fp); /* get count into register */
6648 /* make sure we have the room */
6649 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6650 /* Not room for all of it
6651 if we are looking for a separator and room for some
6653 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6654 /* just process what we have room for */
6655 shortbuffered = cnt - SvLEN(sv) + append + 1;
6656 cnt -= shortbuffered;
6660 /* remember that cnt can be negative */
6661 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6666 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6667 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6668 DEBUG_P(PerlIO_printf(Perl_debug_log,
6669 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6670 DEBUG_P(PerlIO_printf(Perl_debug_log,
6671 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6672 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6673 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6678 while (cnt > 0) { /* this | eat */
6680 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6681 goto thats_all_folks; /* screams | sed :-) */
6685 Copy(ptr, bp, cnt, char); /* this | eat */
6686 bp += cnt; /* screams | dust */
6687 ptr += cnt; /* louder | sed :-) */
6692 if (shortbuffered) { /* oh well, must extend */
6693 cnt = shortbuffered;
6695 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6697 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6698 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6702 DEBUG_P(PerlIO_printf(Perl_debug_log,
6703 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6704 PTR2UV(ptr),(long)cnt));
6705 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6707 DEBUG_P(PerlIO_printf(Perl_debug_log,
6708 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6709 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6710 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6712 /* This used to call 'filbuf' in stdio form, but as that behaves like
6713 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6714 another abstraction. */
6715 i = PerlIO_getc(fp); /* get more characters */
6717 DEBUG_P(PerlIO_printf(Perl_debug_log,
6718 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6719 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6720 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6722 cnt = PerlIO_get_cnt(fp);
6723 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6724 DEBUG_P(PerlIO_printf(Perl_debug_log,
6725 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6727 if (i == EOF) /* all done for ever? */
6728 goto thats_really_all_folks;
6730 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6732 SvGROW(sv, bpx + cnt + 2);
6733 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6735 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6737 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6738 goto thats_all_folks;
6742 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6743 memNE((char*)bp - rslen, rsptr, rslen))
6744 goto screamer; /* go back to the fray */
6745 thats_really_all_folks:
6747 cnt += shortbuffered;
6748 DEBUG_P(PerlIO_printf(Perl_debug_log,
6749 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6750 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6751 DEBUG_P(PerlIO_printf(Perl_debug_log,
6752 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6753 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6754 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6756 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6757 DEBUG_P(PerlIO_printf(Perl_debug_log,
6758 "Screamer: done, len=%ld, string=|%.*s|\n",
6759 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6763 /*The big, slow, and stupid way. */
6764 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6766 New(0, buf, 8192, STDCHAR);
6774 const register STDCHAR *bpe = buf + sizeof(buf);
6776 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6777 ; /* keep reading */
6781 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6782 /* Accomodate broken VAXC compiler, which applies U8 cast to
6783 * both args of ?: operator, causing EOF to change into 255
6786 i = (U8)buf[cnt - 1];
6792 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6794 sv_catpvn(sv, (char *) buf, cnt);
6796 sv_setpvn(sv, (char *) buf, cnt);
6798 if (i != EOF && /* joy */
6800 SvCUR(sv) < rslen ||
6801 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6805 * If we're reading from a TTY and we get a short read,
6806 * indicating that the user hit his EOF character, we need
6807 * to notice it now, because if we try to read from the TTY
6808 * again, the EOF condition will disappear.
6810 * The comparison of cnt to sizeof(buf) is an optimization
6811 * that prevents unnecessary calls to feof().
6815 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6819 #ifdef USE_HEAP_INSTEAD_OF_STACK
6824 if (rspara) { /* have to do this both before and after */
6825 while (i != EOF) { /* to make sure file boundaries work right */
6826 i = PerlIO_getc(fp);
6828 PerlIO_ungetc(fp,i);
6834 return_string_or_null:
6835 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6841 Auto-increment of the value in the SV, doing string to numeric conversion
6842 if necessary. Handles 'get' magic.
6848 Perl_sv_inc(pTHX_ register SV *sv)
6857 if (SvTHINKFIRST(sv)) {
6859 sv_force_normal_flags(sv, 0);
6860 if (SvREADONLY(sv)) {
6861 if (IN_PERL_RUNTIME)
6862 Perl_croak(aTHX_ PL_no_modify);
6866 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6868 i = PTR2IV(SvRV(sv));
6873 flags = SvFLAGS(sv);
6874 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6875 /* It's (privately or publicly) a float, but not tested as an
6876 integer, so test it to see. */
6878 flags = SvFLAGS(sv);
6880 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6881 /* It's publicly an integer, or privately an integer-not-float */
6882 #ifdef PERL_PRESERVE_IVUV
6886 if (SvUVX(sv) == UV_MAX)
6887 sv_setnv(sv, UV_MAX_P1);
6889 (void)SvIOK_only_UV(sv);
6890 SvUV_set(sv, SvUVX(sv) + 1);
6892 if (SvIVX(sv) == IV_MAX)
6893 sv_setuv(sv, (UV)IV_MAX + 1);
6895 (void)SvIOK_only(sv);
6896 SvIV_set(sv, SvIVX(sv) + 1);
6901 if (flags & SVp_NOK) {
6902 (void)SvNOK_only(sv);
6903 SvNV_set(sv, SvNVX(sv) + 1.0);
6907 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6908 if ((flags & SVTYPEMASK) < SVt_PVIV)
6909 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6910 (void)SvIOK_only(sv);
6915 while (isALPHA(*d)) d++;
6916 while (isDIGIT(*d)) d++;
6918 #ifdef PERL_PRESERVE_IVUV
6919 /* Got to punt this as an integer if needs be, but we don't issue
6920 warnings. Probably ought to make the sv_iv_please() that does
6921 the conversion if possible, and silently. */
6922 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6923 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6924 /* Need to try really hard to see if it's an integer.
6925 9.22337203685478e+18 is an integer.
6926 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6927 so $a="9.22337203685478e+18"; $a+0; $a++
6928 needs to be the same as $a="9.22337203685478e+18"; $a++
6935 /* sv_2iv *should* have made this an NV */
6936 if (flags & SVp_NOK) {
6937 (void)SvNOK_only(sv);
6938 SvNV_set(sv, SvNVX(sv) + 1.0);
6941 /* I don't think we can get here. Maybe I should assert this
6942 And if we do get here I suspect that sv_setnv will croak. NWC
6944 #if defined(USE_LONG_DOUBLE)
6945 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",
6946 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6948 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6949 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6952 #endif /* PERL_PRESERVE_IVUV */
6953 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6957 while (d >= SvPVX_const(sv)) {
6965 /* MKS: The original code here died if letters weren't consecutive.
6966 * at least it didn't have to worry about non-C locales. The
6967 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6968 * arranged in order (although not consecutively) and that only
6969 * [A-Za-z] are accepted by isALPHA in the C locale.
6971 if (*d != 'z' && *d != 'Z') {
6972 do { ++*d; } while (!isALPHA(*d));
6975 *(d--) -= 'z' - 'a';
6980 *(d--) -= 'z' - 'a' + 1;
6984 /* oh,oh, the number grew */
6985 SvGROW(sv, SvCUR(sv) + 2);
6986 SvCUR_set(sv, SvCUR(sv) + 1);
6987 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6998 Auto-decrement of the value in the SV, doing string to numeric conversion
6999 if necessary. Handles 'get' magic.
7005 Perl_sv_dec(pTHX_ register SV *sv)
7013 if (SvTHINKFIRST(sv)) {
7015 sv_force_normal_flags(sv, 0);
7016 if (SvREADONLY(sv)) {
7017 if (IN_PERL_RUNTIME)
7018 Perl_croak(aTHX_ PL_no_modify);
7022 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7024 i = PTR2IV(SvRV(sv));
7029 /* Unlike sv_inc we don't have to worry about string-never-numbers
7030 and keeping them magic. But we mustn't warn on punting */
7031 flags = SvFLAGS(sv);
7032 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7033 /* It's publicly an integer, or privately an integer-not-float */
7034 #ifdef PERL_PRESERVE_IVUV
7038 if (SvUVX(sv) == 0) {
7039 (void)SvIOK_only(sv);
7043 (void)SvIOK_only_UV(sv);
7044 SvUV_set(sv, SvUVX(sv) + 1);
7047 if (SvIVX(sv) == IV_MIN)
7048 sv_setnv(sv, (NV)IV_MIN - 1.0);
7050 (void)SvIOK_only(sv);
7051 SvIV_set(sv, SvIVX(sv) - 1);
7056 if (flags & SVp_NOK) {
7057 SvNV_set(sv, SvNVX(sv) - 1.0);
7058 (void)SvNOK_only(sv);
7061 if (!(flags & SVp_POK)) {
7062 if ((flags & SVTYPEMASK) < SVt_PVNV)
7063 sv_upgrade(sv, SVt_NV);
7065 (void)SvNOK_only(sv);
7068 #ifdef PERL_PRESERVE_IVUV
7070 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7071 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7072 /* Need to try really hard to see if it's an integer.
7073 9.22337203685478e+18 is an integer.
7074 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7075 so $a="9.22337203685478e+18"; $a+0; $a--
7076 needs to be the same as $a="9.22337203685478e+18"; $a--
7083 /* sv_2iv *should* have made this an NV */
7084 if (flags & SVp_NOK) {
7085 (void)SvNOK_only(sv);
7086 SvNV_set(sv, SvNVX(sv) - 1.0);
7089 /* I don't think we can get here. Maybe I should assert this
7090 And if we do get here I suspect that sv_setnv will croak. NWC
7092 #if defined(USE_LONG_DOUBLE)
7093 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",
7094 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7096 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7097 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7101 #endif /* PERL_PRESERVE_IVUV */
7102 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7106 =for apidoc sv_mortalcopy
7108 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7109 The new SV is marked as mortal. It will be destroyed "soon", either by an
7110 explicit call to FREETMPS, or by an implicit call at places such as
7111 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7116 /* Make a string that will exist for the duration of the expression
7117 * evaluation. Actually, it may have to last longer than that, but
7118 * hopefully we won't free it until it has been assigned to a
7119 * permanent location. */
7122 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7127 sv_setsv(sv,oldstr);
7129 PL_tmps_stack[++PL_tmps_ix] = sv;
7135 =for apidoc sv_newmortal
7137 Creates a new null SV which is mortal. The reference count of the SV is
7138 set to 1. It will be destroyed "soon", either by an explicit call to
7139 FREETMPS, or by an implicit call at places such as statement boundaries.
7140 See also C<sv_mortalcopy> and C<sv_2mortal>.
7146 Perl_sv_newmortal(pTHX)
7151 SvFLAGS(sv) = SVs_TEMP;
7153 PL_tmps_stack[++PL_tmps_ix] = sv;
7158 =for apidoc sv_2mortal
7160 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7161 by an explicit call to FREETMPS, or by an implicit call at places such as
7162 statement boundaries. SvTEMP() is turned on which means that the SV's
7163 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7164 and C<sv_mortalcopy>.
7170 Perl_sv_2mortal(pTHX_ register SV *sv)
7175 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7178 PL_tmps_stack[++PL_tmps_ix] = sv;
7186 Creates a new SV and copies a string into it. The reference count for the
7187 SV is set to 1. If C<len> is zero, Perl will compute the length using
7188 strlen(). For efficiency, consider using C<newSVpvn> instead.
7194 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7199 sv_setpvn(sv,s,len ? len : strlen(s));
7204 =for apidoc newSVpvn
7206 Creates a new SV and copies a string into it. The reference count for the
7207 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7208 string. You are responsible for ensuring that the source string is at least
7209 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7215 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7220 sv_setpvn(sv,s,len);
7226 =for apidoc newSVhek
7228 Creates a new SV from the hash key structure. It will generate scalars that
7229 point to the shared string table where possible. Returns a new (undefined)
7230 SV if the hek is NULL.
7236 Perl_newSVhek(pTHX_ const HEK *hek)
7245 if (HEK_LEN(hek) == HEf_SVKEY) {
7246 return newSVsv(*(SV**)HEK_KEY(hek));
7248 const int flags = HEK_FLAGS(hek);
7249 if (flags & HVhek_WASUTF8) {
7251 Andreas would like keys he put in as utf8 to come back as utf8
7253 STRLEN utf8_len = HEK_LEN(hek);
7254 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7255 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7258 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7260 } else if (flags & HVhek_REHASH) {
7261 /* We don't have a pointer to the hv, so we have to replicate the
7262 flag into every HEK. This hv is using custom a hasing
7263 algorithm. Hence we can't return a shared string scalar, as
7264 that would contain the (wrong) hash value, and might get passed
7265 into an hv routine with a regular hash */
7267 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7272 /* This will be overwhelminly the most common case. */
7273 return newSVpvn_share(HEK_KEY(hek),
7274 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7280 =for apidoc newSVpvn_share
7282 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7283 table. If the string does not already exist in the table, it is created
7284 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7285 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7286 otherwise the hash is computed. The idea here is that as the string table
7287 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7288 hash lookup will avoid string compare.
7294 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7297 bool is_utf8 = FALSE;
7299 STRLEN tmplen = -len;
7301 /* See the note in hv.c:hv_fetch() --jhi */
7302 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7306 PERL_HASH(hash, src, len);
7308 sv_upgrade(sv, SVt_PV);
7309 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7321 #if defined(PERL_IMPLICIT_CONTEXT)
7323 /* pTHX_ magic can't cope with varargs, so this is a no-context
7324 * version of the main function, (which may itself be aliased to us).
7325 * Don't access this version directly.
7329 Perl_newSVpvf_nocontext(const char* pat, ...)
7334 va_start(args, pat);
7335 sv = vnewSVpvf(pat, &args);
7342 =for apidoc newSVpvf
7344 Creates a new SV and initializes it with the string formatted like
7351 Perl_newSVpvf(pTHX_ const char* pat, ...)
7355 va_start(args, pat);
7356 sv = vnewSVpvf(pat, &args);
7361 /* backend for newSVpvf() and newSVpvf_nocontext() */
7364 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7368 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7375 Creates a new SV and copies a floating point value into it.
7376 The reference count for the SV is set to 1.
7382 Perl_newSVnv(pTHX_ NV n)
7394 Creates a new SV and copies an integer into it. The reference count for the
7401 Perl_newSViv(pTHX_ IV i)
7413 Creates a new SV and copies an unsigned integer into it.
7414 The reference count for the SV is set to 1.
7420 Perl_newSVuv(pTHX_ UV u)
7430 =for apidoc newRV_noinc
7432 Creates an RV wrapper for an SV. The reference count for the original
7433 SV is B<not> incremented.
7439 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7444 sv_upgrade(sv, SVt_RV);
7446 SvRV_set(sv, tmpRef);
7451 /* newRV_inc is the official function name to use now.
7452 * newRV_inc is in fact #defined to newRV in sv.h
7456 Perl_newRV(pTHX_ SV *tmpRef)
7458 return newRV_noinc(SvREFCNT_inc(tmpRef));
7464 Creates a new SV which is an exact duplicate of the original SV.
7471 Perl_newSVsv(pTHX_ register SV *old)
7477 if (SvTYPE(old) == SVTYPEMASK) {
7478 if (ckWARN_d(WARN_INTERNAL))
7479 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7483 /* SV_GMAGIC is the default for sv_setv()
7484 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7485 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7486 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7491 =for apidoc sv_reset
7493 Underlying implementation for the C<reset> Perl function.
7494 Note that the perl-level function is vaguely deprecated.
7500 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7503 char todo[PERL_UCHAR_MAX+1];
7508 if (!*s) { /* reset ?? searches */
7509 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7511 PMOP *pm = (PMOP *) mg->mg_obj;
7513 pm->op_pmdynflags &= ~PMdf_USED;
7520 /* reset variables */
7522 if (!HvARRAY(stash))
7525 Zero(todo, 256, char);
7528 I32 i = (unsigned char)*s;
7532 max = (unsigned char)*s++;
7533 for ( ; i <= max; i++) {
7536 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7538 for (entry = HvARRAY(stash)[i];
7540 entry = HeNEXT(entry))
7545 if (!todo[(U8)*HeKEY(entry)])
7547 gv = (GV*)HeVAL(entry);
7549 if (SvTHINKFIRST(sv)) {
7550 if (!SvREADONLY(sv) && SvROK(sv))
7555 if (SvTYPE(sv) >= SVt_PV) {
7557 if (SvPVX_const(sv) != Nullch)
7564 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7567 #ifdef USE_ENVIRON_ARRAY
7569 # ifdef USE_ITHREADS
7570 && PL_curinterp == aTHX
7574 environ[0] = Nullch;
7577 #endif /* !PERL_MICRO */
7587 Using various gambits, try to get an IO from an SV: the IO slot if its a
7588 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7589 named after the PV if we're a string.
7595 Perl_sv_2io(pTHX_ SV *sv)
7600 switch (SvTYPE(sv)) {
7608 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7612 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7614 return sv_2io(SvRV(sv));
7615 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7621 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7630 Using various gambits, try to get a CV from an SV; in addition, try if
7631 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7637 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7644 return *gvp = Nullgv, Nullcv;
7645 switch (SvTYPE(sv)) {
7664 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7665 tryAMAGICunDEREF(to_cv);
7668 if (SvTYPE(sv) == SVt_PVCV) {
7677 Perl_croak(aTHX_ "Not a subroutine reference");
7682 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7688 if (lref && !GvCVu(gv)) {
7691 tmpsv = NEWSV(704,0);
7692 gv_efullname3(tmpsv, gv, Nullch);
7693 /* XXX this is probably not what they think they're getting.
7694 * It has the same effect as "sub name;", i.e. just a forward
7696 newSUB(start_subparse(FALSE, 0),
7697 newSVOP(OP_CONST, 0, tmpsv),
7702 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7712 Returns true if the SV has a true value by Perl's rules.
7713 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7714 instead use an in-line version.
7720 Perl_sv_true(pTHX_ register SV *sv)
7725 const register XPV* tXpv;
7726 if ((tXpv = (XPV*)SvANY(sv)) &&
7727 (tXpv->xpv_cur > 1 ||
7728 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7735 return SvIVX(sv) != 0;
7738 return SvNVX(sv) != 0.0;
7740 return sv_2bool(sv);
7748 A private implementation of the C<SvIVx> macro for compilers which can't
7749 cope with complex macro expressions. Always use the macro instead.
7755 Perl_sv_iv(pTHX_ register SV *sv)
7759 return (IV)SvUVX(sv);
7768 A private implementation of the C<SvUVx> macro for compilers which can't
7769 cope with complex macro expressions. Always use the macro instead.
7775 Perl_sv_uv(pTHX_ register SV *sv)
7780 return (UV)SvIVX(sv);
7788 A private implementation of the C<SvNVx> macro for compilers which can't
7789 cope with complex macro expressions. Always use the macro instead.
7795 Perl_sv_nv(pTHX_ register SV *sv)
7802 /* sv_pv() is now a macro using SvPV_nolen();
7803 * this function provided for binary compatibility only
7807 Perl_sv_pv(pTHX_ SV *sv)
7812 return sv_2pv(sv, 0);
7818 Use the C<SvPV_nolen> macro instead
7822 A private implementation of the C<SvPV> macro for compilers which can't
7823 cope with complex macro expressions. Always use the macro instead.
7829 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7835 return sv_2pv(sv, lp);
7840 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7846 return sv_2pv_flags(sv, lp, 0);
7849 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7850 * this function provided for binary compatibility only
7854 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7856 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7860 =for apidoc sv_pvn_force
7862 Get a sensible string out of the SV somehow.
7863 A private implementation of the C<SvPV_force> macro for compilers which
7864 can't cope with complex macro expressions. Always use the macro instead.
7866 =for apidoc sv_pvn_force_flags
7868 Get a sensible string out of the SV somehow.
7869 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7870 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7871 implemented in terms of this function.
7872 You normally want to use the various wrapper macros instead: see
7873 C<SvPV_force> and C<SvPV_force_nomg>
7879 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7882 if (SvTHINKFIRST(sv) && !SvROK(sv))
7883 sv_force_normal_flags(sv, 0);
7893 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7895 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7896 sv_reftype(sv,0), OP_NAME(PL_op));
7898 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
7901 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7902 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7906 s = sv_2pv_flags(sv, &len, flags);
7910 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7913 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7914 SvGROW(sv, len + 1);
7915 Move(s,SvPVX_const(sv),len,char);
7920 SvPOK_on(sv); /* validate pointer */
7922 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7923 PTR2UV(sv),SvPVX_const(sv)));
7926 return SvPVX_mutable(sv);
7929 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7930 * this function provided for binary compatibility only
7934 Perl_sv_pvbyte(pTHX_ SV *sv)
7936 sv_utf8_downgrade(sv,0);
7941 =for apidoc sv_pvbyte
7943 Use C<SvPVbyte_nolen> instead.
7945 =for apidoc sv_pvbyten
7947 A private implementation of the C<SvPVbyte> macro for compilers
7948 which can't cope with complex macro expressions. Always use the macro
7955 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7957 sv_utf8_downgrade(sv,0);
7958 return sv_pvn(sv,lp);
7962 =for apidoc sv_pvbyten_force
7964 A private implementation of the C<SvPVbytex_force> macro for compilers
7965 which can't cope with complex macro expressions. Always use the macro
7972 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7974 sv_pvn_force(sv,lp);
7975 sv_utf8_downgrade(sv,0);
7980 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7981 * this function provided for binary compatibility only
7985 Perl_sv_pvutf8(pTHX_ SV *sv)
7987 sv_utf8_upgrade(sv);
7992 =for apidoc sv_pvutf8
7994 Use the C<SvPVutf8_nolen> macro instead
7996 =for apidoc sv_pvutf8n
7998 A private implementation of the C<SvPVutf8> macro for compilers
7999 which can't cope with complex macro expressions. Always use the macro
8006 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8008 sv_utf8_upgrade(sv);
8009 return sv_pvn(sv,lp);
8013 =for apidoc sv_pvutf8n_force
8015 A private implementation of the C<SvPVutf8_force> macro for compilers
8016 which can't cope with complex macro expressions. Always use the macro
8023 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8025 sv_pvn_force(sv,lp);
8026 sv_utf8_upgrade(sv);
8032 =for apidoc sv_reftype
8034 Returns a string describing what the SV is a reference to.
8040 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8042 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8043 inside return suggests a const propagation bug in g++. */
8044 if (ob && SvOBJECT(sv)) {
8045 char *name = HvNAME_get(SvSTASH(sv));
8046 return name ? name : (char *) "__ANON__";
8049 switch (SvTYPE(sv)) {
8066 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8067 /* tied lvalues should appear to be
8068 * scalars for backwards compatitbility */
8069 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8070 ? "SCALAR" : "LVALUE");
8071 case SVt_PVAV: return "ARRAY";
8072 case SVt_PVHV: return "HASH";
8073 case SVt_PVCV: return "CODE";
8074 case SVt_PVGV: return "GLOB";
8075 case SVt_PVFM: return "FORMAT";
8076 case SVt_PVIO: return "IO";
8077 default: return "UNKNOWN";
8083 =for apidoc sv_isobject
8085 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8086 object. If the SV is not an RV, or if the object is not blessed, then this
8093 Perl_sv_isobject(pTHX_ SV *sv)
8110 Returns a boolean indicating whether the SV is blessed into the specified
8111 class. This does not check for subtypes; use C<sv_derived_from> to verify
8112 an inheritance relationship.
8118 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8130 hvname = HvNAME_get(SvSTASH(sv));
8134 return strEQ(hvname, name);
8140 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8141 it will be upgraded to one. If C<classname> is non-null then the new SV will
8142 be blessed in the specified package. The new SV is returned and its
8143 reference count is 1.
8149 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8155 SV_CHECK_THINKFIRST_COW_DROP(rv);
8158 if (SvTYPE(rv) >= SVt_PVMG) {
8159 const U32 refcnt = SvREFCNT(rv);
8163 SvREFCNT(rv) = refcnt;
8166 if (SvTYPE(rv) < SVt_RV)
8167 sv_upgrade(rv, SVt_RV);
8168 else if (SvTYPE(rv) > SVt_RV) {
8179 HV* stash = gv_stashpv(classname, TRUE);
8180 (void)sv_bless(rv, stash);
8186 =for apidoc sv_setref_pv
8188 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8189 argument will be upgraded to an RV. That RV will be modified to point to
8190 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8191 into the SV. The C<classname> argument indicates the package for the
8192 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8193 will have a reference count of 1, and the RV will be returned.
8195 Do not use with other Perl types such as HV, AV, SV, CV, because those
8196 objects will become corrupted by the pointer copy process.
8198 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8204 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8207 sv_setsv(rv, &PL_sv_undef);
8211 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8216 =for apidoc sv_setref_iv
8218 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8219 argument will be upgraded to an RV. That RV will be modified to point to
8220 the new SV. The C<classname> argument indicates the package for the
8221 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8222 will have a reference count of 1, and the RV will be returned.
8228 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8230 sv_setiv(newSVrv(rv,classname), iv);
8235 =for apidoc sv_setref_uv
8237 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8238 argument will be upgraded to an RV. That RV will be modified to point to
8239 the new SV. The C<classname> argument indicates the package for the
8240 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8241 will have a reference count of 1, and the RV will be returned.
8247 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8249 sv_setuv(newSVrv(rv,classname), uv);
8254 =for apidoc sv_setref_nv
8256 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8257 argument will be upgraded to an RV. That RV will be modified to point to
8258 the new SV. The C<classname> argument indicates the package for the
8259 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8260 will have a reference count of 1, and the RV will be returned.
8266 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8268 sv_setnv(newSVrv(rv,classname), nv);
8273 =for apidoc sv_setref_pvn
8275 Copies a string into a new SV, optionally blessing the SV. The length of the
8276 string must be specified with C<n>. The C<rv> argument will be upgraded to
8277 an RV. That RV will be modified to point to the new SV. The C<classname>
8278 argument indicates the package for the blessing. Set C<classname> to
8279 C<Nullch> to avoid the blessing. The new SV will have a reference count
8280 of 1, and the RV will be returned.
8282 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8288 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8290 sv_setpvn(newSVrv(rv,classname), pv, n);
8295 =for apidoc sv_bless
8297 Blesses an SV into a specified package. The SV must be an RV. The package
8298 must be designated by its stash (see C<gv_stashpv()>). The reference count
8299 of the SV is unaffected.
8305 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8309 Perl_croak(aTHX_ "Can't bless non-reference value");
8311 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8312 if (SvREADONLY(tmpRef))
8313 Perl_croak(aTHX_ PL_no_modify);
8314 if (SvOBJECT(tmpRef)) {
8315 if (SvTYPE(tmpRef) != SVt_PVIO)
8317 SvREFCNT_dec(SvSTASH(tmpRef));
8320 SvOBJECT_on(tmpRef);
8321 if (SvTYPE(tmpRef) != SVt_PVIO)
8323 SvUPGRADE(tmpRef, SVt_PVMG);
8324 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8331 if(SvSMAGICAL(tmpRef))
8332 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8340 /* Downgrades a PVGV to a PVMG.
8344 S_sv_unglob(pTHX_ SV *sv)
8348 assert(SvTYPE(sv) == SVt_PVGV);
8353 SvREFCNT_dec(GvSTASH(sv));
8354 GvSTASH(sv) = Nullhv;
8356 sv_unmagic(sv, PERL_MAGIC_glob);
8357 Safefree(GvNAME(sv));
8360 /* need to keep SvANY(sv) in the right arena */
8361 xpvmg = new_XPVMG();
8362 StructCopy(SvANY(sv), xpvmg, XPVMG);
8363 del_XPVGV(SvANY(sv));
8366 SvFLAGS(sv) &= ~SVTYPEMASK;
8367 SvFLAGS(sv) |= SVt_PVMG;
8371 =for apidoc sv_unref_flags
8373 Unsets the RV status of the SV, and decrements the reference count of
8374 whatever was being referenced by the RV. This can almost be thought of
8375 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8376 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8377 (otherwise the decrementing is conditional on the reference count being
8378 different from one or the reference being a readonly SV).
8385 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8389 if (SvWEAKREF(sv)) {
8397 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8398 assigned to as BEGIN {$a = \"Foo"} will fail. */
8399 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8401 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8402 sv_2mortal(rv); /* Schedule for freeing later */
8406 =for apidoc sv_unref
8408 Unsets the RV status of the SV, and decrements the reference count of
8409 whatever was being referenced by the RV. This can almost be thought of
8410 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8411 being zero. See C<SvROK_off>.
8417 Perl_sv_unref(pTHX_ SV *sv)
8419 sv_unref_flags(sv, 0);
8423 =for apidoc sv_taint
8425 Taint an SV. Use C<SvTAINTED_on> instead.
8430 Perl_sv_taint(pTHX_ SV *sv)
8432 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8436 =for apidoc sv_untaint
8438 Untaint an SV. Use C<SvTAINTED_off> instead.
8443 Perl_sv_untaint(pTHX_ SV *sv)
8445 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8446 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8453 =for apidoc sv_tainted
8455 Test an SV for taintedness. Use C<SvTAINTED> instead.
8460 Perl_sv_tainted(pTHX_ SV *sv)
8462 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8463 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8464 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8471 =for apidoc sv_setpviv
8473 Copies an integer into the given SV, also updating its string value.
8474 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8480 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8482 char buf[TYPE_CHARS(UV)];
8484 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8486 sv_setpvn(sv, ptr, ebuf - ptr);
8490 =for apidoc sv_setpviv_mg
8492 Like C<sv_setpviv>, but also handles 'set' magic.
8498 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8500 char buf[TYPE_CHARS(UV)];
8502 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8504 sv_setpvn(sv, ptr, ebuf - ptr);
8508 #if defined(PERL_IMPLICIT_CONTEXT)
8510 /* pTHX_ magic can't cope with varargs, so this is a no-context
8511 * version of the main function, (which may itself be aliased to us).
8512 * Don't access this version directly.
8516 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8520 va_start(args, pat);
8521 sv_vsetpvf(sv, pat, &args);
8525 /* pTHX_ magic can't cope with varargs, so this is a no-context
8526 * version of the main function, (which may itself be aliased to us).
8527 * Don't access this version directly.
8531 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8535 va_start(args, pat);
8536 sv_vsetpvf_mg(sv, pat, &args);
8542 =for apidoc sv_setpvf
8544 Works like C<sv_catpvf> but copies the text into the SV instead of
8545 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8551 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8554 va_start(args, pat);
8555 sv_vsetpvf(sv, pat, &args);
8560 =for apidoc sv_vsetpvf
8562 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8563 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8565 Usually used via its frontend C<sv_setpvf>.
8571 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8573 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8577 =for apidoc sv_setpvf_mg
8579 Like C<sv_setpvf>, but also handles 'set' magic.
8585 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8588 va_start(args, pat);
8589 sv_vsetpvf_mg(sv, pat, &args);
8594 =for apidoc sv_vsetpvf_mg
8596 Like C<sv_vsetpvf>, but also handles 'set' magic.
8598 Usually used via its frontend C<sv_setpvf_mg>.
8604 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8606 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8610 #if defined(PERL_IMPLICIT_CONTEXT)
8612 /* pTHX_ magic can't cope with varargs, so this is a no-context
8613 * version of the main function, (which may itself be aliased to us).
8614 * Don't access this version directly.
8618 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8622 va_start(args, pat);
8623 sv_vcatpvf(sv, pat, &args);
8627 /* pTHX_ magic can't cope with varargs, so this is a no-context
8628 * version of the main function, (which may itself be aliased to us).
8629 * Don't access this version directly.
8633 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8637 va_start(args, pat);
8638 sv_vcatpvf_mg(sv, pat, &args);
8644 =for apidoc sv_catpvf
8646 Processes its arguments like C<sprintf> and appends the formatted
8647 output to an SV. If the appended data contains "wide" characters
8648 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8649 and characters >255 formatted with %c), the original SV might get
8650 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8651 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8652 valid UTF-8; if the original SV was bytes, the pattern should be too.
8657 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8660 va_start(args, pat);
8661 sv_vcatpvf(sv, pat, &args);
8666 =for apidoc sv_vcatpvf
8668 Processes its arguments like C<vsprintf> and appends the formatted output
8669 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8671 Usually used via its frontend C<sv_catpvf>.
8677 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8679 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8683 =for apidoc sv_catpvf_mg
8685 Like C<sv_catpvf>, but also handles 'set' magic.
8691 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8694 va_start(args, pat);
8695 sv_vcatpvf_mg(sv, pat, &args);
8700 =for apidoc sv_vcatpvf_mg
8702 Like C<sv_vcatpvf>, but also handles 'set' magic.
8704 Usually used via its frontend C<sv_catpvf_mg>.
8710 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8712 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8717 =for apidoc sv_vsetpvfn
8719 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8722 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8728 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8730 sv_setpvn(sv, "", 0);
8731 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8734 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8737 S_expect_number(pTHX_ char** pattern)
8740 switch (**pattern) {
8741 case '1': case '2': case '3':
8742 case '4': case '5': case '6':
8743 case '7': case '8': case '9':
8744 while (isDIGIT(**pattern))
8745 var = var * 10 + (*(*pattern)++ - '0');
8749 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8752 F0convert(NV nv, char *endbuf, STRLEN *len)
8754 const int neg = nv < 0;
8763 if (uv & 1 && uv == nv)
8764 uv--; /* Round to even */
8766 const unsigned dig = uv % 10;
8779 =for apidoc sv_vcatpvfn
8781 Processes its arguments like C<vsprintf> and appends the formatted output
8782 to an SV. Uses an array of SVs if the C style variable argument list is
8783 missing (NULL). When running with taint checks enabled, indicates via
8784 C<maybe_tainted> if results are untrustworthy (often due to the use of
8787 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8792 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8795 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8802 static const char nullstr[] = "(null)";
8804 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8805 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8807 /* Times 4: a decimal digit takes more than 3 binary digits.
8808 * NV_DIG: mantissa takes than many decimal digits.
8809 * Plus 32: Playing safe. */
8810 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8811 /* large enough for "%#.#f" --chip */
8812 /* what about long double NVs? --jhi */
8814 /* no matter what, this is a string now */
8815 (void)SvPV_force(sv, origlen);
8817 /* special-case "", "%s", and "%-p" (SVf) */
8820 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8822 const char *s = va_arg(*args, char*);
8823 sv_catpv(sv, s ? s : nullstr);
8825 else if (svix < svmax) {
8826 sv_catsv(sv, *svargs);
8827 if (DO_UTF8(*svargs))
8832 if (patlen == 3 && pat[0] == '%' &&
8833 pat[1] == '-' && pat[2] == 'p') {
8835 argsv = va_arg(*args, SV*);
8836 sv_catsv(sv, argsv);
8843 #ifndef USE_LONG_DOUBLE
8844 /* special-case "%.<number>[gf]" */
8845 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8846 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8847 unsigned digits = 0;
8851 while (*pp >= '0' && *pp <= '9')
8852 digits = 10 * digits + (*pp++ - '0');
8853 if (pp - pat == (int)patlen - 1) {
8857 nv = (NV)va_arg(*args, double);
8858 else if (svix < svmax)
8863 /* Add check for digits != 0 because it seems that some
8864 gconverts are buggy in this case, and we don't yet have
8865 a Configure test for this. */
8866 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8867 /* 0, point, slack */
8868 Gconvert(nv, (int)digits, 0, ebuf);
8870 if (*ebuf) /* May return an empty string for digits==0 */
8873 } else if (!digits) {
8876 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8877 sv_catpvn(sv, p, l);
8883 #endif /* !USE_LONG_DOUBLE */
8885 if (!args && svix < svmax && DO_UTF8(*svargs))
8888 patend = (char*)pat + patlen;
8889 for (p = (char*)pat; p < patend; p = q) {
8892 bool vectorize = FALSE;
8893 bool vectorarg = FALSE;
8894 bool vec_utf8 = FALSE;
8900 bool has_precis = FALSE;
8903 bool is_utf8 = FALSE; /* is this item utf8? */
8904 #ifdef HAS_LDBL_SPRINTF_BUG
8905 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8906 with sfio - Allen <allens@cpan.org> */
8907 bool fix_ldbl_sprintf_bug = FALSE;
8911 U8 utf8buf[UTF8_MAXBYTES+1];
8912 STRLEN esignlen = 0;
8914 const char *eptr = Nullch;
8917 const U8 *vecstr = Null(U8*);
8924 /* we need a long double target in case HAS_LONG_DOUBLE but
8927 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8935 const char *dotstr = ".";
8936 STRLEN dotstrlen = 1;
8937 I32 efix = 0; /* explicit format parameter index */
8938 I32 ewix = 0; /* explicit width index */
8939 I32 epix = 0; /* explicit precision index */
8940 I32 evix = 0; /* explicit vector index */
8941 bool asterisk = FALSE;
8943 /* echo everything up to the next format specification */
8944 for (q = p; q < patend && *q != '%'; ++q) ;
8946 if (has_utf8 && !pat_utf8)
8947 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8949 sv_catpvn(sv, p, q - p);
8956 We allow format specification elements in this order:
8957 \d+\$ explicit format parameter index
8959 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8960 0 flag (as above): repeated to allow "v02"
8961 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8962 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8964 [%bcdefginopsux_DFOUX] format (mandatory)
8966 if (EXPECT_NUMBER(q, width)) {
9007 if (EXPECT_NUMBER(q, ewix))
9016 if ((vectorarg = asterisk)) {
9028 EXPECT_NUMBER(q, width);
9033 vecsv = va_arg(*args, SV*);
9035 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9036 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9037 dotstr = SvPV_const(vecsv, dotstrlen);
9042 vecsv = va_arg(*args, SV*);
9043 vecstr = (U8*)SvPV_const(vecsv,veclen);
9044 vec_utf8 = DO_UTF8(vecsv);
9046 else if (efix ? efix <= svmax : svix < svmax) {
9047 vecsv = svargs[efix ? efix-1 : svix++];
9048 vecstr = (U8*)SvPV_const(vecsv,veclen);
9049 vec_utf8 = DO_UTF8(vecsv);
9050 /* if this is a version object, we need to return the
9051 * stringified representation (which the SvPVX_const has
9052 * already done for us), but not vectorize the args
9054 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9056 q++; /* skip past the rest of the %vd format */
9057 eptr = (const char *) vecstr;
9058 elen = strlen(eptr);
9071 i = va_arg(*args, int);
9073 i = (ewix ? ewix <= svmax : svix < svmax) ?
9074 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9076 width = (i < 0) ? -i : i;
9086 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9088 /* XXX: todo, support specified precision parameter */
9092 i = va_arg(*args, int);
9094 i = (ewix ? ewix <= svmax : svix < svmax)
9095 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9096 precis = (i < 0) ? 0 : i;
9101 precis = precis * 10 + (*q++ - '0');
9110 case 'I': /* Ix, I32x, and I64x */
9112 if (q[1] == '6' && q[2] == '4') {
9118 if (q[1] == '3' && q[2] == '2') {
9128 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9139 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9140 if (*(q + 1) == 'l') { /* lld, llf */
9165 argsv = (efix ? efix <= svmax : svix < svmax) ?
9166 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9173 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9175 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9177 eptr = (char*)utf8buf;
9178 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9189 if (args && !vectorize) {
9190 eptr = va_arg(*args, char*);
9192 #ifdef MACOS_TRADITIONAL
9193 /* On MacOS, %#s format is used for Pascal strings */
9198 elen = strlen(eptr);
9200 eptr = (char *)nullstr;
9201 elen = sizeof nullstr - 1;
9205 eptr = SvPVx_const(argsv, elen);
9206 if (DO_UTF8(argsv)) {
9207 if (has_precis && precis < elen) {
9209 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9212 if (width) { /* fudge width (can't fudge elen) */
9213 width += elen - sv_len_utf8(argsv);
9221 if (has_precis && elen > precis)
9228 if (left && args) { /* SVf */
9237 argsv = va_arg(*args, SV*);
9238 eptr = SvPVx_const(argsv, elen);
9243 if (alt || vectorize)
9245 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9263 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9272 esignbuf[esignlen++] = plus;
9276 case 'h': iv = (short)va_arg(*args, int); break;
9277 case 'l': iv = va_arg(*args, long); break;
9278 case 'V': iv = va_arg(*args, IV); break;
9279 default: iv = va_arg(*args, int); break;
9281 case 'q': iv = va_arg(*args, Quad_t); break;
9286 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9288 case 'h': iv = (short)tiv; break;
9289 case 'l': iv = (long)tiv; break;
9291 default: iv = tiv; break;
9293 case 'q': iv = (Quad_t)tiv; break;
9297 if ( !vectorize ) /* we already set uv above */
9302 esignbuf[esignlen++] = plus;
9306 esignbuf[esignlen++] = '-';
9349 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9360 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9361 case 'l': uv = va_arg(*args, unsigned long); break;
9362 case 'V': uv = va_arg(*args, UV); break;
9363 default: uv = va_arg(*args, unsigned); break;
9365 case 'q': uv = va_arg(*args, Uquad_t); break;
9370 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9372 case 'h': uv = (unsigned short)tuv; break;
9373 case 'l': uv = (unsigned long)tuv; break;
9375 default: uv = tuv; break;
9377 case 'q': uv = (Uquad_t)tuv; break;
9384 char *ptr = ebuf + sizeof ebuf;
9390 p = (char*)((c == 'X')
9391 ? "0123456789ABCDEF" : "0123456789abcdef");
9397 esignbuf[esignlen++] = '0';
9398 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9406 if (alt && *ptr != '0')
9415 esignbuf[esignlen++] = '0';
9416 esignbuf[esignlen++] = 'b';
9419 default: /* it had better be ten or less */
9423 } while (uv /= base);
9426 elen = (ebuf + sizeof ebuf) - ptr;
9430 zeros = precis - elen;
9431 else if (precis == 0 && elen == 1 && *eptr == '0')
9437 /* FLOATING POINT */
9440 c = 'f'; /* maybe %F isn't supported here */
9446 /* This is evil, but floating point is even more evil */
9448 /* for SV-style calling, we can only get NV
9449 for C-style calling, we assume %f is double;
9450 for simplicity we allow any of %Lf, %llf, %qf for long double
9454 #if defined(USE_LONG_DOUBLE)
9458 /* [perl #20339] - we should accept and ignore %lf rather than die */
9462 #if defined(USE_LONG_DOUBLE)
9463 intsize = args ? 0 : 'q';
9467 #if defined(HAS_LONG_DOUBLE)
9476 /* now we need (long double) if intsize == 'q', else (double) */
9477 nv = (args && !vectorize) ?
9478 #if LONG_DOUBLESIZE > DOUBLESIZE
9480 va_arg(*args, long double) :
9481 va_arg(*args, double)
9483 va_arg(*args, double)
9489 if (c != 'e' && c != 'E') {
9491 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9492 will cast our (long double) to (double) */
9493 (void)Perl_frexp(nv, &i);
9494 if (i == PERL_INT_MIN)
9495 Perl_die(aTHX_ "panic: frexp");
9497 need = BIT_DIGITS(i);
9499 need += has_precis ? precis : 6; /* known default */
9504 #ifdef HAS_LDBL_SPRINTF_BUG
9505 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9506 with sfio - Allen <allens@cpan.org> */
9509 # define MY_DBL_MAX DBL_MAX
9510 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9511 # if DOUBLESIZE >= 8
9512 # define MY_DBL_MAX 1.7976931348623157E+308L
9514 # define MY_DBL_MAX 3.40282347E+38L
9518 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9519 # define MY_DBL_MAX_BUG 1L
9521 # define MY_DBL_MAX_BUG MY_DBL_MAX
9525 # define MY_DBL_MIN DBL_MIN
9526 # else /* XXX guessing! -Allen */
9527 # if DOUBLESIZE >= 8
9528 # define MY_DBL_MIN 2.2250738585072014E-308L
9530 # define MY_DBL_MIN 1.17549435E-38L
9534 if ((intsize == 'q') && (c == 'f') &&
9535 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9537 /* it's going to be short enough that
9538 * long double precision is not needed */
9540 if ((nv <= 0L) && (nv >= -0L))
9541 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9543 /* would use Perl_fp_class as a double-check but not
9544 * functional on IRIX - see perl.h comments */
9546 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9547 /* It's within the range that a double can represent */
9548 #if defined(DBL_MAX) && !defined(DBL_MIN)
9549 if ((nv >= ((long double)1/DBL_MAX)) ||
9550 (nv <= (-(long double)1/DBL_MAX)))
9552 fix_ldbl_sprintf_bug = TRUE;
9555 if (fix_ldbl_sprintf_bug == TRUE) {
9565 # undef MY_DBL_MAX_BUG
9568 #endif /* HAS_LDBL_SPRINTF_BUG */
9570 need += 20; /* fudge factor */
9571 if (PL_efloatsize < need) {
9572 Safefree(PL_efloatbuf);
9573 PL_efloatsize = need + 20; /* more fudge */
9574 New(906, PL_efloatbuf, PL_efloatsize, char);
9575 PL_efloatbuf[0] = '\0';
9578 if ( !(width || left || plus || alt) && fill != '0'
9579 && has_precis && intsize != 'q' ) { /* Shortcuts */
9580 /* See earlier comment about buggy Gconvert when digits,
9582 if ( c == 'g' && precis) {
9583 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9584 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9585 goto float_converted;
9586 } else if ( c == 'f' && !precis) {
9587 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9592 char *ptr = ebuf + sizeof ebuf;
9595 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9596 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9597 if (intsize == 'q') {
9598 /* Copy the one or more characters in a long double
9599 * format before the 'base' ([efgEFG]) character to
9600 * the format string. */
9601 static char const prifldbl[] = PERL_PRIfldbl;
9602 char const *p = prifldbl + sizeof(prifldbl) - 3;
9603 while (p >= prifldbl) { *--ptr = *p--; }
9608 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9613 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9625 /* No taint. Otherwise we are in the strange situation
9626 * where printf() taints but print($float) doesn't.
9628 #if defined(HAS_LONG_DOUBLE)
9630 (void)sprintf(PL_efloatbuf, ptr, nv);
9632 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9634 (void)sprintf(PL_efloatbuf, ptr, nv);
9638 eptr = PL_efloatbuf;
9639 elen = strlen(PL_efloatbuf);
9645 i = SvCUR(sv) - origlen;
9646 if (args && !vectorize) {
9648 case 'h': *(va_arg(*args, short*)) = i; break;
9649 default: *(va_arg(*args, int*)) = i; break;
9650 case 'l': *(va_arg(*args, long*)) = i; break;
9651 case 'V': *(va_arg(*args, IV*)) = i; break;
9653 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9658 sv_setuv_mg(argsv, (UV)i);
9660 continue; /* not "break" */
9666 if (!args && ckWARN(WARN_PRINTF) &&
9667 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9668 SV *msg = sv_newmortal();
9669 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9670 (PL_op->op_type == OP_PRTF) ? "" : "s");
9673 Perl_sv_catpvf(aTHX_ msg,
9674 "\"%%%c\"", c & 0xFF);
9676 Perl_sv_catpvf(aTHX_ msg,
9677 "\"%%\\%03"UVof"\"",
9680 sv_catpv(msg, "end of string");
9681 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9684 /* output mangled stuff ... */
9690 /* ... right here, because formatting flags should not apply */
9691 SvGROW(sv, SvCUR(sv) + elen + 1);
9693 Copy(eptr, p, elen, char);
9696 SvCUR_set(sv, p - SvPVX_const(sv));
9698 continue; /* not "break" */
9701 /* calculate width before utf8_upgrade changes it */
9702 have = esignlen + zeros + elen;
9704 if (is_utf8 != has_utf8) {
9707 sv_utf8_upgrade(sv);
9710 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9711 sv_utf8_upgrade(nsv);
9712 eptr = SvPVX_const(nsv);
9715 SvGROW(sv, SvCUR(sv) + elen + 1);
9720 need = (have > width ? have : width);
9723 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9725 if (esignlen && fill == '0') {
9726 for (i = 0; i < (int)esignlen; i++)
9730 memset(p, fill, gap);
9733 if (esignlen && fill != '0') {
9734 for (i = 0; i < (int)esignlen; i++)
9738 for (i = zeros; i; i--)
9742 Copy(eptr, p, elen, char);
9746 memset(p, ' ', gap);
9751 Copy(dotstr, p, dotstrlen, char);
9755 vectorize = FALSE; /* done iterating over vecstr */
9762 SvCUR_set(sv, p - SvPVX_const(sv));
9770 /* =========================================================================
9772 =head1 Cloning an interpreter
9774 All the macros and functions in this section are for the private use of
9775 the main function, perl_clone().
9777 The foo_dup() functions make an exact copy of an existing foo thinngy.
9778 During the course of a cloning, a hash table is used to map old addresses
9779 to new addresses. The table is created and manipulated with the
9780 ptr_table_* functions.
9784 ============================================================================*/
9787 #if defined(USE_ITHREADS)
9789 #ifndef GpREFCNT_inc
9790 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9794 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9795 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9796 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9797 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9798 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9799 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9800 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9801 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9802 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9803 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9804 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9805 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9806 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9809 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9810 regcomp.c. AMS 20010712 */
9813 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9818 struct reg_substr_datum *s;
9821 return (REGEXP *)NULL;
9823 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9826 len = r->offsets[0];
9827 npar = r->nparens+1;
9829 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9830 Copy(r->program, ret->program, len+1, regnode);
9832 New(0, ret->startp, npar, I32);
9833 Copy(r->startp, ret->startp, npar, I32);
9834 New(0, ret->endp, npar, I32);
9835 Copy(r->startp, ret->startp, npar, I32);
9837 New(0, ret->substrs, 1, struct reg_substr_data);
9838 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9839 s->min_offset = r->substrs->data[i].min_offset;
9840 s->max_offset = r->substrs->data[i].max_offset;
9841 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9842 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9845 ret->regstclass = NULL;
9848 const int count = r->data->count;
9850 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9851 char, struct reg_data);
9852 New(0, d->what, count, U8);
9855 for (i = 0; i < count; i++) {
9856 d->what[i] = r->data->what[i];
9857 switch (d->what[i]) {
9858 /* legal options are one of: sfpont
9859 see also regcomp.h and pregfree() */
9861 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9864 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9867 /* This is cheating. */
9868 New(0, d->data[i], 1, struct regnode_charclass_class);
9869 StructCopy(r->data->data[i], d->data[i],
9870 struct regnode_charclass_class);
9871 ret->regstclass = (regnode*)d->data[i];
9874 /* Compiled op trees are readonly, and can thus be
9875 shared without duplication. */
9877 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9881 d->data[i] = r->data->data[i];
9884 d->data[i] = r->data->data[i];
9886 ((reg_trie_data*)d->data[i])->refcount++;
9890 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9899 New(0, ret->offsets, 2*len+1, U32);
9900 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9902 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9903 ret->refcnt = r->refcnt;
9904 ret->minlen = r->minlen;
9905 ret->prelen = r->prelen;
9906 ret->nparens = r->nparens;
9907 ret->lastparen = r->lastparen;
9908 ret->lastcloseparen = r->lastcloseparen;
9909 ret->reganch = r->reganch;
9911 ret->sublen = r->sublen;
9913 if (RX_MATCH_COPIED(ret))
9914 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9916 ret->subbeg = Nullch;
9917 #ifdef PERL_OLD_COPY_ON_WRITE
9918 ret->saved_copy = Nullsv;
9921 ptr_table_store(PL_ptr_table, r, ret);
9925 /* duplicate a file handle */
9928 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9934 return (PerlIO*)NULL;
9936 /* look for it in the table first */
9937 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9941 /* create anew and remember what it is */
9942 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9943 ptr_table_store(PL_ptr_table, fp, ret);
9947 /* duplicate a directory handle */
9950 Perl_dirp_dup(pTHX_ DIR *dp)
9958 /* duplicate a typeglob */
9961 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9966 /* look for it in the table first */
9967 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9971 /* create anew and remember what it is */
9972 Newz(0, ret, 1, GP);
9973 ptr_table_store(PL_ptr_table, gp, ret);
9976 ret->gp_refcnt = 0; /* must be before any other dups! */
9977 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9978 ret->gp_io = io_dup_inc(gp->gp_io, param);
9979 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9980 ret->gp_av = av_dup_inc(gp->gp_av, param);
9981 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9982 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9983 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9984 ret->gp_cvgen = gp->gp_cvgen;
9985 ret->gp_flags = gp->gp_flags;
9986 ret->gp_line = gp->gp_line;
9987 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9991 /* duplicate a chain of magic */
9994 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9996 MAGIC *mgprev = (MAGIC*)NULL;
9999 return (MAGIC*)NULL;
10000 /* look for it in the table first */
10001 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10005 for (; mg; mg = mg->mg_moremagic) {
10007 Newz(0, nmg, 1, MAGIC);
10009 mgprev->mg_moremagic = nmg;
10012 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10013 nmg->mg_private = mg->mg_private;
10014 nmg->mg_type = mg->mg_type;
10015 nmg->mg_flags = mg->mg_flags;
10016 if (mg->mg_type == PERL_MAGIC_qr) {
10017 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10019 else if(mg->mg_type == PERL_MAGIC_backref) {
10020 const AV * const av = (AV*) mg->mg_obj;
10023 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10025 for (i = AvFILLp(av); i >= 0; i--) {
10026 if (!svp[i]) continue;
10027 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10030 else if (mg->mg_type == PERL_MAGIC_symtab) {
10031 nmg->mg_obj = mg->mg_obj;
10034 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10035 ? sv_dup_inc(mg->mg_obj, param)
10036 : sv_dup(mg->mg_obj, param);
10038 nmg->mg_len = mg->mg_len;
10039 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10040 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10041 if (mg->mg_len > 0) {
10042 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10043 if (mg->mg_type == PERL_MAGIC_overload_table &&
10044 AMT_AMAGIC((AMT*)mg->mg_ptr))
10046 AMT *amtp = (AMT*)mg->mg_ptr;
10047 AMT *namtp = (AMT*)nmg->mg_ptr;
10049 for (i = 1; i < NofAMmeth; i++) {
10050 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10054 else if (mg->mg_len == HEf_SVKEY)
10055 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10057 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10058 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10065 /* create a new pointer-mapping table */
10068 Perl_ptr_table_new(pTHX)
10071 Newz(0, tbl, 1, PTR_TBL_t);
10072 tbl->tbl_max = 511;
10073 tbl->tbl_items = 0;
10074 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10079 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10081 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10084 #define new_pte() new_body(struct ptr_tbl_ent, pte)
10085 #define del_pte(p) del_body(p, struct ptr_tbl_ent, pte)
10087 /* map an existing pointer using a table */
10090 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10092 PTR_TBL_ENT_t *tblent;
10093 const UV hash = PTR_TABLE_HASH(sv);
10095 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10096 for (; tblent; tblent = tblent->next) {
10097 if (tblent->oldval == sv)
10098 return tblent->newval;
10100 return (void*)NULL;
10103 /* add a new entry to a pointer-mapping table */
10106 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10108 PTR_TBL_ENT_t *tblent, **otblent;
10109 /* XXX this may be pessimal on platforms where pointers aren't good
10110 * hash values e.g. if they grow faster in the most significant
10112 const UV hash = PTR_TABLE_HASH(oldv);
10116 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10117 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10118 if (tblent->oldval == oldv) {
10119 tblent->newval = newv;
10123 tblent = new_pte();
10124 tblent->oldval = oldv;
10125 tblent->newval = newv;
10126 tblent->next = *otblent;
10129 if (!empty && tbl->tbl_items > tbl->tbl_max)
10130 ptr_table_split(tbl);
10133 /* double the hash bucket size of an existing ptr table */
10136 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10138 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10139 const UV oldsize = tbl->tbl_max + 1;
10140 UV newsize = oldsize * 2;
10143 Renew(ary, newsize, PTR_TBL_ENT_t*);
10144 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10145 tbl->tbl_max = --newsize;
10146 tbl->tbl_ary = ary;
10147 for (i=0; i < oldsize; i++, ary++) {
10148 PTR_TBL_ENT_t **curentp, **entp, *ent;
10151 curentp = ary + oldsize;
10152 for (entp = ary, ent = *ary; ent; ent = *entp) {
10153 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10155 ent->next = *curentp;
10165 /* remove all the entries from a ptr table */
10168 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10170 register PTR_TBL_ENT_t **array;
10171 register PTR_TBL_ENT_t *entry;
10175 if (!tbl || !tbl->tbl_items) {
10179 array = tbl->tbl_ary;
10181 max = tbl->tbl_max;
10185 PTR_TBL_ENT_t *oentry = entry;
10186 entry = entry->next;
10190 if (++riter > max) {
10193 entry = array[riter];
10197 tbl->tbl_items = 0;
10200 /* clear and free a ptr table */
10203 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10208 ptr_table_clear(tbl);
10209 Safefree(tbl->tbl_ary);
10213 /* attempt to make everything in the typeglob readonly */
10216 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10218 GV *gv = (GV*)sstr;
10219 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10221 if (GvIO(gv) || GvFORM(gv)) {
10222 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10224 else if (!GvCV(gv)) {
10225 GvCV(gv) = (CV*)sv;
10228 /* CvPADLISTs cannot be shared */
10229 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10234 if (!GvUNIQUE(gv)) {
10236 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10237 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10243 * write attempts will die with
10244 * "Modification of a read-only value attempted"
10250 SvREADONLY_on(GvSV(gv));
10254 GvAV(gv) = (AV*)sv;
10257 SvREADONLY_on(GvAV(gv));
10261 GvHV(gv) = (HV*)sv;
10264 SvREADONLY_on(GvHV(gv));
10267 return sstr; /* he_dup() will SvREFCNT_inc() */
10270 /* duplicate an SV of any type (including AV, HV etc) */
10273 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10276 SvRV_set(dstr, SvWEAKREF(sstr)
10277 ? sv_dup(SvRV(sstr), param)
10278 : sv_dup_inc(SvRV(sstr), param));
10281 else if (SvPVX_const(sstr)) {
10282 /* Has something there */
10284 /* Normal PV - clone whole allocated space */
10285 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10286 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10287 /* Not that normal - actually sstr is copy on write.
10288 But we are a true, independant SV, so: */
10289 SvREADONLY_off(dstr);
10294 /* Special case - not normally malloced for some reason */
10295 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10296 /* A "shared" PV - clone it as "shared" PV */
10298 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10302 /* Some other special case - random pointer */
10303 SvPV_set(dstr, SvPVX(sstr));
10308 /* Copy the Null */
10309 if (SvTYPE(dstr) == SVt_RV)
10310 SvRV_set(dstr, NULL);
10317 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10322 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10324 /* look for it in the table first */
10325 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10329 if(param->flags & CLONEf_JOIN_IN) {
10330 /** We are joining here so we don't want do clone
10331 something that is bad **/
10332 const char *hvname;
10334 if(SvTYPE(sstr) == SVt_PVHV &&
10335 (hvname = HvNAME_get(sstr))) {
10336 /** don't clone stashes if they already exist **/
10337 HV* old_stash = gv_stashpv(hvname,0);
10338 return (SV*) old_stash;
10342 /* create anew and remember what it is */
10345 #ifdef DEBUG_LEAKING_SCALARS
10346 dstr->sv_debug_optype = sstr->sv_debug_optype;
10347 dstr->sv_debug_line = sstr->sv_debug_line;
10348 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10349 dstr->sv_debug_cloned = 1;
10351 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10353 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10357 ptr_table_store(PL_ptr_table, sstr, dstr);
10360 SvFLAGS(dstr) = SvFLAGS(sstr);
10361 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10362 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10365 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10366 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10367 PL_watch_pvx, SvPVX_const(sstr));
10370 /* don't clone objects whose class has asked us not to */
10371 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10372 SvFLAGS(dstr) &= ~SVTYPEMASK;
10373 SvOBJECT_off(dstr);
10377 switch (SvTYPE(sstr)) {
10379 SvANY(dstr) = NULL;
10382 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10383 SvIV_set(dstr, SvIVX(sstr));
10386 SvANY(dstr) = new_XNV();
10387 SvNV_set(dstr, SvNVX(sstr));
10390 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10391 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10394 SvANY(dstr) = new_XPV();
10395 SvCUR_set(dstr, SvCUR(sstr));
10396 SvLEN_set(dstr, SvLEN(sstr));
10397 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10400 SvANY(dstr) = new_XPVIV();
10401 SvCUR_set(dstr, SvCUR(sstr));
10402 SvLEN_set(dstr, SvLEN(sstr));
10403 SvIV_set(dstr, SvIVX(sstr));
10404 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10407 SvANY(dstr) = new_XPVNV();
10408 SvCUR_set(dstr, SvCUR(sstr));
10409 SvLEN_set(dstr, SvLEN(sstr));
10410 SvIV_set(dstr, SvIVX(sstr));
10411 SvNV_set(dstr, SvNVX(sstr));
10412 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10415 SvANY(dstr) = new_XPVMG();
10416 SvCUR_set(dstr, SvCUR(sstr));
10417 SvLEN_set(dstr, SvLEN(sstr));
10418 SvIV_set(dstr, SvIVX(sstr));
10419 SvNV_set(dstr, SvNVX(sstr));
10420 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10421 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10422 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10425 SvANY(dstr) = new_XPVBM();
10426 SvCUR_set(dstr, SvCUR(sstr));
10427 SvLEN_set(dstr, SvLEN(sstr));
10428 SvIV_set(dstr, SvIVX(sstr));
10429 SvNV_set(dstr, SvNVX(sstr));
10430 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10431 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10432 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10433 BmRARE(dstr) = BmRARE(sstr);
10434 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10435 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10438 SvANY(dstr) = new_XPVLV();
10439 SvCUR_set(dstr, SvCUR(sstr));
10440 SvLEN_set(dstr, SvLEN(sstr));
10441 SvIV_set(dstr, SvIVX(sstr));
10442 SvNV_set(dstr, SvNVX(sstr));
10443 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10444 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10445 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10446 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10447 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10448 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10449 LvTARG(dstr) = dstr;
10450 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10451 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10453 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10454 LvTYPE(dstr) = LvTYPE(sstr);
10457 if (GvUNIQUE((GV*)sstr)) {
10459 if ((share = gv_share(sstr, param))) {
10462 ptr_table_store(PL_ptr_table, sstr, dstr);
10464 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10465 HvNAME_get(GvSTASH(share)), GvNAME(share));
10470 SvANY(dstr) = new_XPVGV();
10471 SvCUR_set(dstr, SvCUR(sstr));
10472 SvLEN_set(dstr, SvLEN(sstr));
10473 SvIV_set(dstr, SvIVX(sstr));
10474 SvNV_set(dstr, SvNVX(sstr));
10475 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10476 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10477 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10478 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10479 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10480 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10481 GvFLAGS(dstr) = GvFLAGS(sstr);
10482 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10483 (void)GpREFCNT_inc(GvGP(dstr));
10486 SvANY(dstr) = new_XPVIO();
10487 SvCUR_set(dstr, SvCUR(sstr));
10488 SvLEN_set(dstr, SvLEN(sstr));
10489 SvIV_set(dstr, SvIVX(sstr));
10490 SvNV_set(dstr, SvNVX(sstr));
10491 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10492 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10493 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10494 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10495 if (IoOFP(sstr) == IoIFP(sstr))
10496 IoOFP(dstr) = IoIFP(dstr);
10498 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10499 /* PL_rsfp_filters entries have fake IoDIRP() */
10500 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10501 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10503 IoDIRP(dstr) = IoDIRP(sstr);
10504 IoLINES(dstr) = IoLINES(sstr);
10505 IoPAGE(dstr) = IoPAGE(sstr);
10506 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10507 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10508 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10509 /* I have no idea why fake dirp (rsfps)
10510 should be treaded differently but otherwise
10511 we end up with leaks -- sky*/
10512 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10513 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10514 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10516 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10517 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10518 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10520 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10521 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10522 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10523 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10524 IoTYPE(dstr) = IoTYPE(sstr);
10525 IoFLAGS(dstr) = IoFLAGS(sstr);
10528 SvANY(dstr) = new_XPVAV();
10529 SvCUR_set(dstr, SvCUR(sstr));
10530 SvLEN_set(dstr, SvLEN(sstr));
10531 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10532 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10533 if (AvARRAY((AV*)sstr)) {
10534 SV **dst_ary, **src_ary;
10535 SSize_t items = AvFILLp((AV*)sstr) + 1;
10537 src_ary = AvARRAY((AV*)sstr);
10538 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10539 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10540 SvPV_set(dstr, (char*)dst_ary);
10541 AvALLOC((AV*)dstr) = dst_ary;
10542 if (AvREAL((AV*)sstr)) {
10543 while (items-- > 0)
10544 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10547 while (items-- > 0)
10548 *dst_ary++ = sv_dup(*src_ary++, param);
10550 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10551 while (items-- > 0) {
10552 *dst_ary++ = &PL_sv_undef;
10556 SvPV_set(dstr, Nullch);
10557 AvALLOC((AV*)dstr) = (SV**)NULL;
10561 SvANY(dstr) = new_XPVHV();
10562 SvCUR_set(dstr, SvCUR(sstr));
10563 SvLEN_set(dstr, SvLEN(sstr));
10564 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10565 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10566 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10570 if (HvARRAY((HV*)sstr)) {
10572 const bool sharekeys = !!HvSHAREKEYS(sstr);
10573 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10574 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10577 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10578 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
10579 HvARRAY(dstr) = (HE**)darray;
10580 while (i <= sxhv->xhv_max) {
10581 HE *source = HvARRAY(sstr)[i];
10583 = source ? he_dup(source, sharekeys, param) : 0;
10587 struct xpvhv_aux *saux = HvAUX(sstr);
10588 struct xpvhv_aux *daux = HvAUX(dstr);
10589 /* This flag isn't copied. */
10590 /* SvOOK_on(hv) attacks the IV flags. */
10591 SvFLAGS(dstr) |= SVf_OOK;
10593 hvname = saux->xhv_name;
10594 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10596 daux->xhv_riter = saux->xhv_riter;
10597 daux->xhv_eiter = saux->xhv_eiter
10598 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
10603 SvPV_set(dstr, Nullch);
10605 /* Record stashes for possible cloning in Perl_clone(). */
10607 av_push(param->stashes, dstr);
10611 SvANY(dstr) = new_XPVFM();
10612 FmLINES(dstr) = FmLINES(sstr);
10616 SvANY(dstr) = new_XPVCV();
10618 SvCUR_set(dstr, SvCUR(sstr));
10619 SvLEN_set(dstr, SvLEN(sstr));
10620 SvIV_set(dstr, SvIVX(sstr));
10621 SvNV_set(dstr, SvNVX(sstr));
10622 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10623 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10624 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10625 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10626 CvSTART(dstr) = CvSTART(sstr);
10628 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10630 CvXSUB(dstr) = CvXSUB(sstr);
10631 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10632 if (CvCONST(sstr)) {
10633 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10634 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10635 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
10637 /* don't dup if copying back - CvGV isn't refcounted, so the
10638 * duped GV may never be freed. A bit of a hack! DAPM */
10639 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10640 Nullgv : gv_dup(CvGV(sstr), param) ;
10641 if (param->flags & CLONEf_COPY_STACKS) {
10642 CvDEPTH(dstr) = CvDEPTH(sstr);
10646 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10647 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10649 CvWEAKOUTSIDE(sstr)
10650 ? cv_dup( CvOUTSIDE(sstr), param)
10651 : cv_dup_inc(CvOUTSIDE(sstr), param);
10652 CvFLAGS(dstr) = CvFLAGS(sstr);
10653 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10656 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10660 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10666 /* duplicate a context */
10669 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10671 PERL_CONTEXT *ncxs;
10674 return (PERL_CONTEXT*)NULL;
10676 /* look for it in the table first */
10677 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10681 /* create anew and remember what it is */
10682 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10683 ptr_table_store(PL_ptr_table, cxs, ncxs);
10686 PERL_CONTEXT *cx = &cxs[ix];
10687 PERL_CONTEXT *ncx = &ncxs[ix];
10688 ncx->cx_type = cx->cx_type;
10689 if (CxTYPE(cx) == CXt_SUBST) {
10690 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10693 ncx->blk_oldsp = cx->blk_oldsp;
10694 ncx->blk_oldcop = cx->blk_oldcop;
10695 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10696 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10697 ncx->blk_oldpm = cx->blk_oldpm;
10698 ncx->blk_gimme = cx->blk_gimme;
10699 switch (CxTYPE(cx)) {
10701 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10702 ? cv_dup_inc(cx->blk_sub.cv, param)
10703 : cv_dup(cx->blk_sub.cv,param));
10704 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10705 ? av_dup_inc(cx->blk_sub.argarray, param)
10707 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10708 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10709 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10710 ncx->blk_sub.lval = cx->blk_sub.lval;
10711 ncx->blk_sub.retop = cx->blk_sub.retop;
10714 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10715 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10716 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10717 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10718 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10719 ncx->blk_eval.retop = cx->blk_eval.retop;
10722 ncx->blk_loop.label = cx->blk_loop.label;
10723 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10724 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10725 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10726 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10727 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10728 ? cx->blk_loop.iterdata
10729 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10730 ncx->blk_loop.oldcomppad
10731 = (PAD*)ptr_table_fetch(PL_ptr_table,
10732 cx->blk_loop.oldcomppad);
10733 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10734 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10735 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10736 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10737 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10740 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10741 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10742 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10743 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10744 ncx->blk_sub.retop = cx->blk_sub.retop;
10756 /* duplicate a stack info structure */
10759 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10764 return (PERL_SI*)NULL;
10766 /* look for it in the table first */
10767 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10771 /* create anew and remember what it is */
10772 Newz(56, nsi, 1, PERL_SI);
10773 ptr_table_store(PL_ptr_table, si, nsi);
10775 nsi->si_stack = av_dup_inc(si->si_stack, param);
10776 nsi->si_cxix = si->si_cxix;
10777 nsi->si_cxmax = si->si_cxmax;
10778 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10779 nsi->si_type = si->si_type;
10780 nsi->si_prev = si_dup(si->si_prev, param);
10781 nsi->si_next = si_dup(si->si_next, param);
10782 nsi->si_markoff = si->si_markoff;
10787 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10788 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10789 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10790 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10791 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10792 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10793 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10794 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10795 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10796 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10797 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10798 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10799 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10800 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10803 #define pv_dup_inc(p) SAVEPV(p)
10804 #define pv_dup(p) SAVEPV(p)
10805 #define svp_dup_inc(p,pp) any_dup(p,pp)
10807 /* map any object to the new equivent - either something in the
10808 * ptr table, or something in the interpreter structure
10812 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10817 return (void*)NULL;
10819 /* look for it in the table first */
10820 ret = ptr_table_fetch(PL_ptr_table, v);
10824 /* see if it is part of the interpreter structure */
10825 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10826 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10834 /* duplicate the save stack */
10837 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10839 ANY *ss = proto_perl->Tsavestack;
10840 I32 ix = proto_perl->Tsavestack_ix;
10841 I32 max = proto_perl->Tsavestack_max;
10853 void (*dptr) (void*);
10854 void (*dxptr) (pTHX_ void*);
10857 Newz(54, nss, max, ANY);
10860 I32 i = POPINT(ss,ix);
10861 TOPINT(nss,ix) = i;
10863 case SAVEt_ITEM: /* normal string */
10864 sv = (SV*)POPPTR(ss,ix);
10865 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10866 sv = (SV*)POPPTR(ss,ix);
10867 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10869 case SAVEt_SV: /* scalar reference */
10870 sv = (SV*)POPPTR(ss,ix);
10871 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10872 gv = (GV*)POPPTR(ss,ix);
10873 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10875 case SAVEt_GENERIC_PVREF: /* generic char* */
10876 c = (char*)POPPTR(ss,ix);
10877 TOPPTR(nss,ix) = pv_dup(c);
10878 ptr = POPPTR(ss,ix);
10879 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10881 case SAVEt_SHARED_PVREF: /* char* in shared space */
10882 c = (char*)POPPTR(ss,ix);
10883 TOPPTR(nss,ix) = savesharedpv(c);
10884 ptr = POPPTR(ss,ix);
10885 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10887 case SAVEt_GENERIC_SVREF: /* generic sv */
10888 case SAVEt_SVREF: /* scalar reference */
10889 sv = (SV*)POPPTR(ss,ix);
10890 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10891 ptr = POPPTR(ss,ix);
10892 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10894 case SAVEt_AV: /* array reference */
10895 av = (AV*)POPPTR(ss,ix);
10896 TOPPTR(nss,ix) = av_dup_inc(av, param);
10897 gv = (GV*)POPPTR(ss,ix);
10898 TOPPTR(nss,ix) = gv_dup(gv, param);
10900 case SAVEt_HV: /* hash reference */
10901 hv = (HV*)POPPTR(ss,ix);
10902 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10903 gv = (GV*)POPPTR(ss,ix);
10904 TOPPTR(nss,ix) = gv_dup(gv, param);
10906 case SAVEt_INT: /* int reference */
10907 ptr = POPPTR(ss,ix);
10908 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10909 intval = (int)POPINT(ss,ix);
10910 TOPINT(nss,ix) = intval;
10912 case SAVEt_LONG: /* long reference */
10913 ptr = POPPTR(ss,ix);
10914 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10915 longval = (long)POPLONG(ss,ix);
10916 TOPLONG(nss,ix) = longval;
10918 case SAVEt_I32: /* I32 reference */
10919 case SAVEt_I16: /* I16 reference */
10920 case SAVEt_I8: /* I8 reference */
10921 ptr = POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10924 TOPINT(nss,ix) = i;
10926 case SAVEt_IV: /* IV reference */
10927 ptr = POPPTR(ss,ix);
10928 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10930 TOPIV(nss,ix) = iv;
10932 case SAVEt_SPTR: /* SV* reference */
10933 ptr = POPPTR(ss,ix);
10934 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10935 sv = (SV*)POPPTR(ss,ix);
10936 TOPPTR(nss,ix) = sv_dup(sv, param);
10938 case SAVEt_VPTR: /* random* reference */
10939 ptr = POPPTR(ss,ix);
10940 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10941 ptr = POPPTR(ss,ix);
10942 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10944 case SAVEt_PPTR: /* char* reference */
10945 ptr = POPPTR(ss,ix);
10946 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10947 c = (char*)POPPTR(ss,ix);
10948 TOPPTR(nss,ix) = pv_dup(c);
10950 case SAVEt_HPTR: /* HV* reference */
10951 ptr = POPPTR(ss,ix);
10952 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10953 hv = (HV*)POPPTR(ss,ix);
10954 TOPPTR(nss,ix) = hv_dup(hv, param);
10956 case SAVEt_APTR: /* AV* reference */
10957 ptr = POPPTR(ss,ix);
10958 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10959 av = (AV*)POPPTR(ss,ix);
10960 TOPPTR(nss,ix) = av_dup(av, param);
10963 gv = (GV*)POPPTR(ss,ix);
10964 TOPPTR(nss,ix) = gv_dup(gv, param);
10966 case SAVEt_GP: /* scalar reference */
10967 gp = (GP*)POPPTR(ss,ix);
10968 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10969 (void)GpREFCNT_inc(gp);
10970 gv = (GV*)POPPTR(ss,ix);
10971 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10972 c = (char*)POPPTR(ss,ix);
10973 TOPPTR(nss,ix) = pv_dup(c);
10975 TOPIV(nss,ix) = iv;
10977 TOPIV(nss,ix) = iv;
10980 case SAVEt_MORTALIZESV:
10981 sv = (SV*)POPPTR(ss,ix);
10982 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10985 ptr = POPPTR(ss,ix);
10986 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10987 /* these are assumed to be refcounted properly */
10988 switch (((OP*)ptr)->op_type) {
10990 case OP_LEAVESUBLV:
10994 case OP_LEAVEWRITE:
10995 TOPPTR(nss,ix) = ptr;
11000 TOPPTR(nss,ix) = Nullop;
11005 TOPPTR(nss,ix) = Nullop;
11008 c = (char*)POPPTR(ss,ix);
11009 TOPPTR(nss,ix) = pv_dup_inc(c);
11011 case SAVEt_CLEARSV:
11012 longval = POPLONG(ss,ix);
11013 TOPLONG(nss,ix) = longval;
11016 hv = (HV*)POPPTR(ss,ix);
11017 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11018 c = (char*)POPPTR(ss,ix);
11019 TOPPTR(nss,ix) = pv_dup_inc(c);
11021 TOPINT(nss,ix) = i;
11023 case SAVEt_DESTRUCTOR:
11024 ptr = POPPTR(ss,ix);
11025 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11026 dptr = POPDPTR(ss,ix);
11027 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11028 any_dup(FPTR2DPTR(void *, dptr),
11031 case SAVEt_DESTRUCTOR_X:
11032 ptr = POPPTR(ss,ix);
11033 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11034 dxptr = POPDXPTR(ss,ix);
11035 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11036 any_dup(FPTR2DPTR(void *, dxptr),
11039 case SAVEt_REGCONTEXT:
11042 TOPINT(nss,ix) = i;
11045 case SAVEt_STACK_POS: /* Position on Perl stack */
11047 TOPINT(nss,ix) = i;
11049 case SAVEt_AELEM: /* array element */
11050 sv = (SV*)POPPTR(ss,ix);
11051 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11053 TOPINT(nss,ix) = i;
11054 av = (AV*)POPPTR(ss,ix);
11055 TOPPTR(nss,ix) = av_dup_inc(av, param);
11057 case SAVEt_HELEM: /* hash element */
11058 sv = (SV*)POPPTR(ss,ix);
11059 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11060 sv = (SV*)POPPTR(ss,ix);
11061 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11062 hv = (HV*)POPPTR(ss,ix);
11063 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11066 ptr = POPPTR(ss,ix);
11067 TOPPTR(nss,ix) = ptr;
11071 TOPINT(nss,ix) = i;
11073 case SAVEt_COMPPAD:
11074 av = (AV*)POPPTR(ss,ix);
11075 TOPPTR(nss,ix) = av_dup(av, param);
11078 longval = (long)POPLONG(ss,ix);
11079 TOPLONG(nss,ix) = longval;
11080 ptr = POPPTR(ss,ix);
11081 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11082 sv = (SV*)POPPTR(ss,ix);
11083 TOPPTR(nss,ix) = sv_dup(sv, param);
11086 ptr = POPPTR(ss,ix);
11087 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11088 longval = (long)POPBOOL(ss,ix);
11089 TOPBOOL(nss,ix) = (bool)longval;
11091 case SAVEt_SET_SVFLAGS:
11093 TOPINT(nss,ix) = i;
11095 TOPINT(nss,ix) = i;
11096 sv = (SV*)POPPTR(ss,ix);
11097 TOPPTR(nss,ix) = sv_dup(sv, param);
11100 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11108 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11109 * flag to the result. This is done for each stash before cloning starts,
11110 * so we know which stashes want their objects cloned */
11113 do_mark_cloneable_stash(pTHX_ SV *sv)
11115 const HEK *hvname = HvNAME_HEK((HV*)sv);
11117 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11118 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11119 if (cloner && GvCV(cloner)) {
11126 XPUSHs(sv_2mortal(newSVhek(hvname)));
11128 call_sv((SV*)GvCV(cloner), G_SCALAR);
11135 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11143 =for apidoc perl_clone
11145 Create and return a new interpreter by cloning the current one.
11147 perl_clone takes these flags as parameters:
11149 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11150 without it we only clone the data and zero the stacks,
11151 with it we copy the stacks and the new perl interpreter is
11152 ready to run at the exact same point as the previous one.
11153 The pseudo-fork code uses COPY_STACKS while the
11154 threads->new doesn't.
11156 CLONEf_KEEP_PTR_TABLE
11157 perl_clone keeps a ptr_table with the pointer of the old
11158 variable as a key and the new variable as a value,
11159 this allows it to check if something has been cloned and not
11160 clone it again but rather just use the value and increase the
11161 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11162 the ptr_table using the function
11163 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11164 reason to keep it around is if you want to dup some of your own
11165 variable who are outside the graph perl scans, example of this
11166 code is in threads.xs create
11169 This is a win32 thing, it is ignored on unix, it tells perls
11170 win32host code (which is c++) to clone itself, this is needed on
11171 win32 if you want to run two threads at the same time,
11172 if you just want to do some stuff in a separate perl interpreter
11173 and then throw it away and return to the original one,
11174 you don't need to do anything.
11179 /* XXX the above needs expanding by someone who actually understands it ! */
11180 EXTERN_C PerlInterpreter *
11181 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11184 perl_clone(PerlInterpreter *proto_perl, UV flags)
11187 #ifdef PERL_IMPLICIT_SYS
11189 /* perlhost.h so we need to call into it
11190 to clone the host, CPerlHost should have a c interface, sky */
11192 if (flags & CLONEf_CLONE_HOST) {
11193 return perl_clone_host(proto_perl,flags);
11195 return perl_clone_using(proto_perl, flags,
11197 proto_perl->IMemShared,
11198 proto_perl->IMemParse,
11200 proto_perl->IStdIO,
11204 proto_perl->IProc);
11208 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11209 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11210 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11211 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11212 struct IPerlDir* ipD, struct IPerlSock* ipS,
11213 struct IPerlProc* ipP)
11215 /* XXX many of the string copies here can be optimized if they're
11216 * constants; they need to be allocated as common memory and just
11217 * their pointers copied. */
11220 CLONE_PARAMS clone_params;
11221 CLONE_PARAMS* param = &clone_params;
11223 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11224 /* for each stash, determine whether its objects should be cloned */
11225 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11226 PERL_SET_THX(my_perl);
11229 Poison(my_perl, 1, PerlInterpreter);
11231 PL_curcop = (COP *)Nullop;
11235 PL_savestack_ix = 0;
11236 PL_savestack_max = -1;
11237 PL_sig_pending = 0;
11238 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11239 # else /* !DEBUGGING */
11240 Zero(my_perl, 1, PerlInterpreter);
11241 # endif /* DEBUGGING */
11243 /* host pointers */
11245 PL_MemShared = ipMS;
11246 PL_MemParse = ipMP;
11253 #else /* !PERL_IMPLICIT_SYS */
11255 CLONE_PARAMS clone_params;
11256 CLONE_PARAMS* param = &clone_params;
11257 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11258 /* for each stash, determine whether its objects should be cloned */
11259 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11260 PERL_SET_THX(my_perl);
11263 Poison(my_perl, 1, PerlInterpreter);
11265 PL_curcop = (COP *)Nullop;
11269 PL_savestack_ix = 0;
11270 PL_savestack_max = -1;
11271 PL_sig_pending = 0;
11272 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11273 # else /* !DEBUGGING */
11274 Zero(my_perl, 1, PerlInterpreter);
11275 # endif /* DEBUGGING */
11276 #endif /* PERL_IMPLICIT_SYS */
11277 param->flags = flags;
11278 param->proto_perl = proto_perl;
11281 PL_xnv_arenaroot = NULL;
11282 PL_xnv_root = NULL;
11283 PL_xpv_arenaroot = NULL;
11284 PL_xpv_root = NULL;
11285 PL_xpviv_arenaroot = NULL;
11286 PL_xpviv_root = NULL;
11287 PL_xpvnv_arenaroot = NULL;
11288 PL_xpvnv_root = NULL;
11289 PL_xpvcv_arenaroot = NULL;
11290 PL_xpvcv_root = NULL;
11291 PL_xpvav_arenaroot = NULL;
11292 PL_xpvav_root = NULL;
11293 PL_xpvhv_arenaroot = NULL;
11294 PL_xpvhv_root = NULL;
11295 PL_xpvmg_arenaroot = NULL;
11296 PL_xpvmg_root = NULL;
11297 PL_xpvgv_arenaroot = NULL;
11298 PL_xpvgv_root = NULL;
11299 PL_xpvlv_arenaroot = NULL;
11300 PL_xpvlv_root = NULL;
11301 PL_xpvbm_arenaroot = NULL;
11302 PL_xpvbm_root = NULL;
11303 PL_he_arenaroot = NULL;
11305 #if defined(USE_ITHREADS)
11306 PL_pte_arenaroot = NULL;
11307 PL_pte_root = NULL;
11309 PL_nice_chunk = NULL;
11310 PL_nice_chunk_size = 0;
11312 PL_sv_objcount = 0;
11313 PL_sv_root = Nullsv;
11314 PL_sv_arenaroot = Nullsv;
11316 PL_debug = proto_perl->Idebug;
11318 PL_hash_seed = proto_perl->Ihash_seed;
11319 PL_rehash_seed = proto_perl->Irehash_seed;
11321 #ifdef USE_REENTRANT_API
11322 /* XXX: things like -Dm will segfault here in perlio, but doing
11323 * PERL_SET_CONTEXT(proto_perl);
11324 * breaks too many other things
11326 Perl_reentrant_init(aTHX);
11329 /* create SV map for pointer relocation */
11330 PL_ptr_table = ptr_table_new();
11332 /* initialize these special pointers as early as possible */
11333 SvANY(&PL_sv_undef) = NULL;
11334 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11335 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11336 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11338 SvANY(&PL_sv_no) = new_XPVNV();
11339 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11340 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11341 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11342 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11343 SvCUR_set(&PL_sv_no, 0);
11344 SvLEN_set(&PL_sv_no, 1);
11345 SvIV_set(&PL_sv_no, 0);
11346 SvNV_set(&PL_sv_no, 0);
11347 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11349 SvANY(&PL_sv_yes) = new_XPVNV();
11350 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11351 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11352 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11353 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11354 SvCUR_set(&PL_sv_yes, 1);
11355 SvLEN_set(&PL_sv_yes, 2);
11356 SvIV_set(&PL_sv_yes, 1);
11357 SvNV_set(&PL_sv_yes, 1);
11358 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11360 /* create (a non-shared!) shared string table */
11361 PL_strtab = newHV();
11362 HvSHAREKEYS_off(PL_strtab);
11363 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11364 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11366 PL_compiling = proto_perl->Icompiling;
11368 /* These two PVs will be free'd special way so must set them same way op.c does */
11369 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11370 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11372 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11373 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11375 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11376 if (!specialWARN(PL_compiling.cop_warnings))
11377 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11378 if (!specialCopIO(PL_compiling.cop_io))
11379 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11380 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11382 /* pseudo environmental stuff */
11383 PL_origargc = proto_perl->Iorigargc;
11384 PL_origargv = proto_perl->Iorigargv;
11386 param->stashes = newAV(); /* Setup array of objects to call clone on */
11388 #ifdef PERLIO_LAYERS
11389 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11390 PerlIO_clone(aTHX_ proto_perl, param);
11393 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11394 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11395 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11396 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11397 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11398 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11401 PL_minus_c = proto_perl->Iminus_c;
11402 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11403 PL_localpatches = proto_perl->Ilocalpatches;
11404 PL_splitstr = proto_perl->Isplitstr;
11405 PL_preprocess = proto_perl->Ipreprocess;
11406 PL_minus_n = proto_perl->Iminus_n;
11407 PL_minus_p = proto_perl->Iminus_p;
11408 PL_minus_l = proto_perl->Iminus_l;
11409 PL_minus_a = proto_perl->Iminus_a;
11410 PL_minus_F = proto_perl->Iminus_F;
11411 PL_doswitches = proto_perl->Idoswitches;
11412 PL_dowarn = proto_perl->Idowarn;
11413 PL_doextract = proto_perl->Idoextract;
11414 PL_sawampersand = proto_perl->Isawampersand;
11415 PL_unsafe = proto_perl->Iunsafe;
11416 PL_inplace = SAVEPV(proto_perl->Iinplace);
11417 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11418 PL_perldb = proto_perl->Iperldb;
11419 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11420 PL_exit_flags = proto_perl->Iexit_flags;
11422 /* magical thingies */
11423 /* XXX time(&PL_basetime) when asked for? */
11424 PL_basetime = proto_perl->Ibasetime;
11425 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11427 PL_maxsysfd = proto_perl->Imaxsysfd;
11428 PL_multiline = proto_perl->Imultiline;
11429 PL_statusvalue = proto_perl->Istatusvalue;
11431 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11433 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11435 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11436 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11437 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11439 /* Clone the regex array */
11440 PL_regex_padav = newAV();
11442 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11443 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11445 av_push(PL_regex_padav,
11446 sv_dup_inc(regexen[0],param));
11447 for(i = 1; i <= len; i++) {
11448 if(SvREPADTMP(regexen[i])) {
11449 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11451 av_push(PL_regex_padav,
11453 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11454 SvIVX(regexen[i])), param)))
11459 PL_regex_pad = AvARRAY(PL_regex_padav);
11461 /* shortcuts to various I/O objects */
11462 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11463 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11464 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11465 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11466 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11467 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11469 /* shortcuts to regexp stuff */
11470 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11472 /* shortcuts to misc objects */
11473 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11475 /* shortcuts to debugging objects */
11476 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11477 PL_DBline = gv_dup(proto_perl->IDBline, param);
11478 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11479 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11480 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11481 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11482 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11483 PL_lineary = av_dup(proto_perl->Ilineary, param);
11484 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11486 /* symbol tables */
11487 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11488 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11489 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11490 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11491 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11493 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11494 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11495 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11496 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11497 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11498 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11500 PL_sub_generation = proto_perl->Isub_generation;
11502 /* funky return mechanisms */
11503 PL_forkprocess = proto_perl->Iforkprocess;
11505 /* subprocess state */
11506 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11508 /* internal state */
11509 PL_tainting = proto_perl->Itainting;
11510 PL_taint_warn = proto_perl->Itaint_warn;
11511 PL_maxo = proto_perl->Imaxo;
11512 if (proto_perl->Iop_mask)
11513 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11515 PL_op_mask = Nullch;
11516 /* PL_asserting = proto_perl->Iasserting; */
11518 /* current interpreter roots */
11519 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11520 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11521 PL_main_start = proto_perl->Imain_start;
11522 PL_eval_root = proto_perl->Ieval_root;
11523 PL_eval_start = proto_perl->Ieval_start;
11525 /* runtime control stuff */
11526 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11527 PL_copline = proto_perl->Icopline;
11529 PL_filemode = proto_perl->Ifilemode;
11530 PL_lastfd = proto_perl->Ilastfd;
11531 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11534 PL_gensym = proto_perl->Igensym;
11535 PL_preambled = proto_perl->Ipreambled;
11536 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11537 PL_laststatval = proto_perl->Ilaststatval;
11538 PL_laststype = proto_perl->Ilaststype;
11539 PL_mess_sv = Nullsv;
11541 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11542 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11544 /* interpreter atexit processing */
11545 PL_exitlistlen = proto_perl->Iexitlistlen;
11546 if (PL_exitlistlen) {
11547 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11548 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11551 PL_exitlist = (PerlExitListEntry*)NULL;
11552 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11553 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11554 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11556 PL_profiledata = NULL;
11557 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11558 /* PL_rsfp_filters entries have fake IoDIRP() */
11559 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11561 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11563 PAD_CLONE_VARS(proto_perl, param);
11565 #ifdef HAVE_INTERP_INTERN
11566 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11569 /* more statics moved here */
11570 PL_generation = proto_perl->Igeneration;
11571 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11573 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11574 PL_in_clean_all = proto_perl->Iin_clean_all;
11576 PL_uid = proto_perl->Iuid;
11577 PL_euid = proto_perl->Ieuid;
11578 PL_gid = proto_perl->Igid;
11579 PL_egid = proto_perl->Iegid;
11580 PL_nomemok = proto_perl->Inomemok;
11581 PL_an = proto_perl->Ian;
11582 PL_evalseq = proto_perl->Ievalseq;
11583 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11584 PL_origalen = proto_perl->Iorigalen;
11585 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11586 PL_osname = SAVEPV(proto_perl->Iosname);
11587 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11588 PL_sighandlerp = proto_perl->Isighandlerp;
11591 PL_runops = proto_perl->Irunops;
11593 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11596 PL_cshlen = proto_perl->Icshlen;
11597 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11600 PL_lex_state = proto_perl->Ilex_state;
11601 PL_lex_defer = proto_perl->Ilex_defer;
11602 PL_lex_expect = proto_perl->Ilex_expect;
11603 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11604 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11605 PL_lex_starts = proto_perl->Ilex_starts;
11606 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11607 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11608 PL_lex_op = proto_perl->Ilex_op;
11609 PL_lex_inpat = proto_perl->Ilex_inpat;
11610 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11611 PL_lex_brackets = proto_perl->Ilex_brackets;
11612 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11613 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11614 PL_lex_casemods = proto_perl->Ilex_casemods;
11615 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11616 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11618 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11619 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11620 PL_nexttoke = proto_perl->Inexttoke;
11622 /* XXX This is probably masking the deeper issue of why
11623 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11624 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11625 * (A little debugging with a watchpoint on it may help.)
11627 if (SvANY(proto_perl->Ilinestr)) {
11628 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11629 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11630 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11631 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11632 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11633 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11634 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11635 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11636 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11639 PL_linestr = NEWSV(65,79);
11640 sv_upgrade(PL_linestr,SVt_PVIV);
11641 sv_setpvn(PL_linestr,"",0);
11642 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11644 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11645 PL_pending_ident = proto_perl->Ipending_ident;
11646 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11648 PL_expect = proto_perl->Iexpect;
11650 PL_multi_start = proto_perl->Imulti_start;
11651 PL_multi_end = proto_perl->Imulti_end;
11652 PL_multi_open = proto_perl->Imulti_open;
11653 PL_multi_close = proto_perl->Imulti_close;
11655 PL_error_count = proto_perl->Ierror_count;
11656 PL_subline = proto_perl->Isubline;
11657 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11659 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11660 if (SvANY(proto_perl->Ilinestr)) {
11661 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11662 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11663 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11664 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11665 PL_last_lop_op = proto_perl->Ilast_lop_op;
11668 PL_last_uni = SvPVX(PL_linestr);
11669 PL_last_lop = SvPVX(PL_linestr);
11670 PL_last_lop_op = 0;
11672 PL_in_my = proto_perl->Iin_my;
11673 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11675 PL_cryptseen = proto_perl->Icryptseen;
11678 PL_hints = proto_perl->Ihints;
11680 PL_amagic_generation = proto_perl->Iamagic_generation;
11682 #ifdef USE_LOCALE_COLLATE
11683 PL_collation_ix = proto_perl->Icollation_ix;
11684 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11685 PL_collation_standard = proto_perl->Icollation_standard;
11686 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11687 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11688 #endif /* USE_LOCALE_COLLATE */
11690 #ifdef USE_LOCALE_NUMERIC
11691 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11692 PL_numeric_standard = proto_perl->Inumeric_standard;
11693 PL_numeric_local = proto_perl->Inumeric_local;
11694 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11695 #endif /* !USE_LOCALE_NUMERIC */
11697 /* utf8 character classes */
11698 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11699 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11700 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11701 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11702 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11703 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11704 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11705 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11706 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11707 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11708 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11709 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11710 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11711 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11712 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11713 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11714 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11715 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11716 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11717 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11719 /* Did the locale setup indicate UTF-8? */
11720 PL_utf8locale = proto_perl->Iutf8locale;
11721 /* Unicode features (see perlrun/-C) */
11722 PL_unicode = proto_perl->Iunicode;
11724 /* Pre-5.8 signals control */
11725 PL_signals = proto_perl->Isignals;
11727 /* times() ticks per second */
11728 PL_clocktick = proto_perl->Iclocktick;
11730 /* Recursion stopper for PerlIO_find_layer */
11731 PL_in_load_module = proto_perl->Iin_load_module;
11733 /* sort() routine */
11734 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11736 /* Not really needed/useful since the reenrant_retint is "volatile",
11737 * but do it for consistency's sake. */
11738 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11740 /* Hooks to shared SVs and locks. */
11741 PL_sharehook = proto_perl->Isharehook;
11742 PL_lockhook = proto_perl->Ilockhook;
11743 PL_unlockhook = proto_perl->Iunlockhook;
11744 PL_threadhook = proto_perl->Ithreadhook;
11746 PL_runops_std = proto_perl->Irunops_std;
11747 PL_runops_dbg = proto_perl->Irunops_dbg;
11749 #ifdef THREADS_HAVE_PIDS
11750 PL_ppid = proto_perl->Ippid;
11754 PL_last_swash_hv = Nullhv; /* reinits on demand */
11755 PL_last_swash_klen = 0;
11756 PL_last_swash_key[0]= '\0';
11757 PL_last_swash_tmps = (U8*)NULL;
11758 PL_last_swash_slen = 0;
11760 PL_glob_index = proto_perl->Iglob_index;
11761 PL_srand_called = proto_perl->Isrand_called;
11762 PL_uudmap['M'] = 0; /* reinits on demand */
11763 PL_bitcount = Nullch; /* reinits on demand */
11765 if (proto_perl->Ipsig_pend) {
11766 Newz(0, PL_psig_pend, SIG_SIZE, int);
11769 PL_psig_pend = (int*)NULL;
11772 if (proto_perl->Ipsig_ptr) {
11773 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11774 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11775 for (i = 1; i < SIG_SIZE; i++) {
11776 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11777 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11781 PL_psig_ptr = (SV**)NULL;
11782 PL_psig_name = (SV**)NULL;
11785 /* thrdvar.h stuff */
11787 if (flags & CLONEf_COPY_STACKS) {
11788 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11789 PL_tmps_ix = proto_perl->Ttmps_ix;
11790 PL_tmps_max = proto_perl->Ttmps_max;
11791 PL_tmps_floor = proto_perl->Ttmps_floor;
11792 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11794 while (i <= PL_tmps_ix) {
11795 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11799 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11800 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11801 Newz(54, PL_markstack, i, I32);
11802 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11803 - proto_perl->Tmarkstack);
11804 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11805 - proto_perl->Tmarkstack);
11806 Copy(proto_perl->Tmarkstack, PL_markstack,
11807 PL_markstack_ptr - PL_markstack + 1, I32);
11809 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11810 * NOTE: unlike the others! */
11811 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11812 PL_scopestack_max = proto_perl->Tscopestack_max;
11813 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11814 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11816 /* NOTE: si_dup() looks at PL_markstack */
11817 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11819 /* PL_curstack = PL_curstackinfo->si_stack; */
11820 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11821 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11823 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11824 PL_stack_base = AvARRAY(PL_curstack);
11825 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11826 - proto_perl->Tstack_base);
11827 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11829 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11830 * NOTE: unlike the others! */
11831 PL_savestack_ix = proto_perl->Tsavestack_ix;
11832 PL_savestack_max = proto_perl->Tsavestack_max;
11833 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11834 PL_savestack = ss_dup(proto_perl, param);
11838 ENTER; /* perl_destruct() wants to LEAVE; */
11841 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11842 PL_top_env = &PL_start_env;
11844 PL_op = proto_perl->Top;
11847 PL_Xpv = (XPV*)NULL;
11848 PL_na = proto_perl->Tna;
11850 PL_statbuf = proto_perl->Tstatbuf;
11851 PL_statcache = proto_perl->Tstatcache;
11852 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11853 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11855 PL_timesbuf = proto_perl->Ttimesbuf;
11858 PL_tainted = proto_perl->Ttainted;
11859 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11860 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11861 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11862 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11863 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11864 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11865 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11866 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11867 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11869 PL_restartop = proto_perl->Trestartop;
11870 PL_in_eval = proto_perl->Tin_eval;
11871 PL_delaymagic = proto_perl->Tdelaymagic;
11872 PL_dirty = proto_perl->Tdirty;
11873 PL_localizing = proto_perl->Tlocalizing;
11875 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11876 PL_hv_fetch_ent_mh = Nullhe;
11877 PL_modcount = proto_perl->Tmodcount;
11878 PL_lastgotoprobe = Nullop;
11879 PL_dumpindent = proto_perl->Tdumpindent;
11881 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11882 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11883 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11884 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11885 PL_sortcxix = proto_perl->Tsortcxix;
11886 PL_efloatbuf = Nullch; /* reinits on demand */
11887 PL_efloatsize = 0; /* reinits on demand */
11891 PL_screamfirst = NULL;
11892 PL_screamnext = NULL;
11893 PL_maxscream = -1; /* reinits on demand */
11894 PL_lastscream = Nullsv;
11896 PL_watchaddr = NULL;
11897 PL_watchok = Nullch;
11899 PL_regdummy = proto_perl->Tregdummy;
11900 PL_regprecomp = Nullch;
11903 PL_colorset = 0; /* reinits PL_colors[] */
11904 /*PL_colors[6] = {0,0,0,0,0,0};*/
11905 PL_reginput = Nullch;
11906 PL_regbol = Nullch;
11907 PL_regeol = Nullch;
11908 PL_regstartp = (I32*)NULL;
11909 PL_regendp = (I32*)NULL;
11910 PL_reglastparen = (U32*)NULL;
11911 PL_reglastcloseparen = (U32*)NULL;
11912 PL_regtill = Nullch;
11913 PL_reg_start_tmp = (char**)NULL;
11914 PL_reg_start_tmpl = 0;
11915 PL_regdata = (struct reg_data*)NULL;
11918 PL_reg_eval_set = 0;
11920 PL_regprogram = (regnode*)NULL;
11922 PL_regcc = (CURCUR*)NULL;
11923 PL_reg_call_cc = (struct re_cc_state*)NULL;
11924 PL_reg_re = (regexp*)NULL;
11925 PL_reg_ganch = Nullch;
11926 PL_reg_sv = Nullsv;
11927 PL_reg_match_utf8 = FALSE;
11928 PL_reg_magic = (MAGIC*)NULL;
11930 PL_reg_oldcurpm = (PMOP*)NULL;
11931 PL_reg_curpm = (PMOP*)NULL;
11932 PL_reg_oldsaved = Nullch;
11933 PL_reg_oldsavedlen = 0;
11934 #ifdef PERL_OLD_COPY_ON_WRITE
11937 PL_reg_maxiter = 0;
11938 PL_reg_leftiter = 0;
11939 PL_reg_poscache = Nullch;
11940 PL_reg_poscache_size= 0;
11942 /* RE engine - function pointers */
11943 PL_regcompp = proto_perl->Tregcompp;
11944 PL_regexecp = proto_perl->Tregexecp;
11945 PL_regint_start = proto_perl->Tregint_start;
11946 PL_regint_string = proto_perl->Tregint_string;
11947 PL_regfree = proto_perl->Tregfree;
11949 PL_reginterp_cnt = 0;
11950 PL_reg_starttry = 0;
11952 /* Pluggable optimizer */
11953 PL_peepp = proto_perl->Tpeepp;
11955 PL_stashcache = newHV();
11957 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11958 ptr_table_free(PL_ptr_table);
11959 PL_ptr_table = NULL;
11962 /* Call the ->CLONE method, if it exists, for each of the stashes
11963 identified by sv_dup() above.
11965 while(av_len(param->stashes) != -1) {
11966 HV* stash = (HV*) av_shift(param->stashes);
11967 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11968 if (cloner && GvCV(cloner)) {
11973 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11975 call_sv((SV*)GvCV(cloner), G_DISCARD);
11981 SvREFCNT_dec(param->stashes);
11983 /* orphaned? eg threads->new inside BEGIN or use */
11984 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11985 (void)SvREFCNT_inc(PL_compcv);
11986 SAVEFREESV(PL_compcv);
11992 #endif /* USE_ITHREADS */
11995 =head1 Unicode Support
11997 =for apidoc sv_recode_to_utf8
11999 The encoding is assumed to be an Encode object, on entry the PV
12000 of the sv is assumed to be octets in that encoding, and the sv
12001 will be converted into Unicode (and UTF-8).
12003 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12004 is not a reference, nothing is done to the sv. If the encoding is not
12005 an C<Encode::XS> Encoding object, bad things will happen.
12006 (See F<lib/encoding.pm> and L<Encode>).
12008 The PV of the sv is returned.
12013 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12016 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12030 Passing sv_yes is wrong - it needs to be or'ed set of constants
12031 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12032 remove converted chars from source.
12034 Both will default the value - let them.
12036 XPUSHs(&PL_sv_yes);
12039 call_method("decode", G_SCALAR);
12043 s = SvPV_const(uni, len);
12044 if (s != SvPVX_const(sv)) {
12045 SvGROW(sv, len + 1);
12046 Move(s, SvPVX(sv), len + 1, char);
12047 SvCUR_set(sv, len);
12054 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12058 =for apidoc sv_cat_decode
12060 The encoding is assumed to be an Encode object, the PV of the ssv is
12061 assumed to be octets in that encoding and decoding the input starts
12062 from the position which (PV + *offset) pointed to. The dsv will be
12063 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12064 when the string tstr appears in decoding output or the input ends on
12065 the PV of the ssv. The value which the offset points will be modified
12066 to the last input position on the ssv.
12068 Returns TRUE if the terminator was found, else returns FALSE.
12073 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12074 SV *ssv, int *offset, char *tstr, int tlen)
12078 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12089 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12090 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12092 call_method("cat_decode", G_SCALAR);
12094 ret = SvTRUE(TOPs);
12095 *offset = SvIV(offsv);
12101 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12107 * c-indentation-style: bsd
12108 * c-basic-offset: 4
12109 * indent-tabs-mode: t
12112 * ex: set ts=8 sts=4 sw=4 noet: