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_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);
537 Safefree((void *)sva);
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(sv));
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
773 pv_display(sv,SvPVX(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();
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(varname) : "",
1121 " in ", OP_DESC(PL_op));
1124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1128 /* allocate another arena's worth of NV bodies */
1136 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1137 *((void **) ptr) = (void *)PL_xnv_arenaroot;
1138 PL_xnv_arenaroot = ptr;
1141 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1142 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1144 while (xnv < xnvend) {
1145 *(NV**)xnv = (NV*)(xnv + 1);
1151 /* allocate another arena's worth of struct xpv */
1157 xpv_allocated* xpvend;
1158 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1159 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
1160 PL_xpv_arenaroot = xpv;
1162 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
1163 PL_xpv_root = ++xpv;
1164 while (xpv < xpvend) {
1165 *((xpv_allocated**)xpv) = xpv + 1;
1168 *((xpv_allocated**)xpv) = 0;
1171 /* allocate another arena's worth of struct xpviv */
1178 New(714, xpviv, PERL_ARENA_SIZE/sizeof(XPVIV), XPVIV);
1179 *((XPVIV**)xpviv) = PL_xpviv_arenaroot;
1180 PL_xpviv_arenaroot = xpviv;
1182 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(XPVIV) - 1];
1183 PL_xpviv_root = ++xpviv;
1184 while (xpviv < xpvivend) {
1185 *((XPVIV**)xpviv) = xpviv + 1;
1188 *((XPVIV**)xpviv) = 0;
1191 /* allocate another arena's worth of struct xpvnv */
1198 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1199 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
1200 PL_xpvnv_arenaroot = xpvnv;
1202 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1203 PL_xpvnv_root = ++xpvnv;
1204 while (xpvnv < xpvnvend) {
1205 *((XPVNV**)xpvnv) = xpvnv + 1;
1208 *((XPVNV**)xpvnv) = 0;
1211 /* allocate another arena's worth of struct xpvcv */
1218 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1219 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
1220 PL_xpvcv_arenaroot = xpvcv;
1222 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1223 PL_xpvcv_root = ++xpvcv;
1224 while (xpvcv < xpvcvend) {
1225 *((XPVCV**)xpvcv) = xpvcv + 1;
1228 *((XPVCV**)xpvcv) = 0;
1231 /* allocate another arena's worth of struct xpvav */
1236 xpvav_allocated* xpvav;
1237 xpvav_allocated* xpvavend;
1238 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1240 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
1241 PL_xpvav_arenaroot = xpvav;
1243 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
1244 PL_xpvav_root = ++xpvav;
1245 while (xpvav < xpvavend) {
1246 *((xpvav_allocated**)xpvav) = xpvav + 1;
1249 *((xpvav_allocated**)xpvav) = 0;
1252 /* allocate another arena's worth of struct xpvhv */
1257 xpvhv_allocated* xpvhv;
1258 xpvhv_allocated* xpvhvend;
1259 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1261 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
1262 PL_xpvhv_arenaroot = xpvhv;
1264 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
1265 PL_xpvhv_root = ++xpvhv;
1266 while (xpvhv < xpvhvend) {
1267 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
1270 *((xpvhv_allocated**)xpvhv) = 0;
1273 /* allocate another arena's worth of struct xpvmg */
1280 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1281 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1282 PL_xpvmg_arenaroot = xpvmg;
1284 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1285 PL_xpvmg_root = ++xpvmg;
1286 while (xpvmg < xpvmgend) {
1287 *((XPVMG**)xpvmg) = xpvmg + 1;
1290 *((XPVMG**)xpvmg) = 0;
1293 /* allocate another arena's worth of struct xpvgv */
1300 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1301 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1302 PL_xpvgv_arenaroot = xpvgv;
1304 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1305 PL_xpvgv_root = ++xpvgv;
1306 while (xpvgv < xpvgvend) {
1307 *((XPVGV**)xpvgv) = xpvgv + 1;
1310 *((XPVGV**)xpvgv) = 0;
1313 /* allocate another arena's worth of struct xpvlv */
1320 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1321 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1322 PL_xpvlv_arenaroot = xpvlv;
1324 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1325 PL_xpvlv_root = ++xpvlv;
1326 while (xpvlv < xpvlvend) {
1327 *((XPVLV**)xpvlv) = xpvlv + 1;
1330 *((XPVLV**)xpvlv) = 0;
1333 /* allocate another arena's worth of struct xpvbm */
1340 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1341 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1342 PL_xpvbm_arenaroot = xpvbm;
1344 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1345 PL_xpvbm_root = ++xpvbm;
1346 while (xpvbm < xpvbmend) {
1347 *((XPVBM**)xpvbm) = xpvbm + 1;
1350 *((XPVBM**)xpvbm) = 0;
1353 /* grab a new NV body from the free list, allocating more if necessary */
1363 PL_xnv_root = *(NV**)xnv;
1365 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1368 /* return an NV body to the free list */
1371 S_del_xnv(pTHX_ XPVNV *p)
1373 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1375 *(NV**)xnv = PL_xnv_root;
1380 /* grab a new struct xpv from the free list, allocating more if necessary */
1390 PL_xpv_root = *(xpv_allocated**)xpv;
1392 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1393 sum to zero, and the pointer is unchanged. If the allocated structure
1394 is smaller (no initial IV actually allocated) then the net effect is
1395 to subtract the size of the IV from the pointer, to return a new pointer
1396 as if an initial IV were actually allocated. */
1397 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1398 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
1401 /* return a struct xpv to the free list */
1404 S_del_xpv(pTHX_ XPV *p)
1407 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1408 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
1410 *(xpv_allocated**)xpv = PL_xpv_root;
1415 /* grab a new struct xpviv from the free list, allocating more if necessary */
1424 xpviv = PL_xpviv_root;
1425 PL_xpviv_root = *(XPVIV**)xpviv;
1430 /* return a struct xpviv to the free list */
1433 S_del_xpviv(pTHX_ XPVIV *p)
1436 *(XPVIV**)p = PL_xpviv_root;
1441 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1450 xpvnv = PL_xpvnv_root;
1451 PL_xpvnv_root = *(XPVNV**)xpvnv;
1456 /* return a struct xpvnv to the free list */
1459 S_del_xpvnv(pTHX_ XPVNV *p)
1462 *(XPVNV**)p = PL_xpvnv_root;
1467 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1476 xpvcv = PL_xpvcv_root;
1477 PL_xpvcv_root = *(XPVCV**)xpvcv;
1482 /* return a struct xpvcv to the free list */
1485 S_del_xpvcv(pTHX_ XPVCV *p)
1488 *(XPVCV**)p = PL_xpvcv_root;
1493 /* grab a new struct xpvav from the free list, allocating more if necessary */
1498 xpvav_allocated* xpvav;
1502 xpvav = PL_xpvav_root;
1503 PL_xpvav_root = *(xpvav_allocated**)xpvav;
1505 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1506 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
1509 /* return a struct xpvav to the free list */
1512 S_del_xpvav(pTHX_ XPVAV *p)
1514 xpvav_allocated* xpvav
1515 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1516 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
1518 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1519 PL_xpvav_root = xpvav;
1523 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1528 xpvhv_allocated* xpvhv;
1532 xpvhv = PL_xpvhv_root;
1533 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
1535 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1536 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1539 /* return a struct xpvhv to the free list */
1542 S_del_xpvhv(pTHX_ XPVHV *p)
1544 xpvhv_allocated* xpvhv
1545 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1546 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1548 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1549 PL_xpvhv_root = xpvhv;
1553 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1562 xpvmg = PL_xpvmg_root;
1563 PL_xpvmg_root = *(XPVMG**)xpvmg;
1568 /* return a struct xpvmg to the free list */
1571 S_del_xpvmg(pTHX_ XPVMG *p)
1574 *(XPVMG**)p = PL_xpvmg_root;
1579 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1588 xpvgv = PL_xpvgv_root;
1589 PL_xpvgv_root = *(XPVGV**)xpvgv;
1594 /* return a struct xpvgv to the free list */
1597 S_del_xpvgv(pTHX_ XPVGV *p)
1600 *(XPVGV**)p = PL_xpvgv_root;
1605 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1614 xpvlv = PL_xpvlv_root;
1615 PL_xpvlv_root = *(XPVLV**)xpvlv;
1620 /* return a struct xpvlv to the free list */
1623 S_del_xpvlv(pTHX_ XPVLV *p)
1626 *(XPVLV**)p = PL_xpvlv_root;
1631 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1640 xpvbm = PL_xpvbm_root;
1641 PL_xpvbm_root = *(XPVBM**)xpvbm;
1646 /* return a struct xpvbm to the free list */
1649 S_del_xpvbm(pTHX_ XPVBM *p)
1652 *(XPVBM**)p = PL_xpvbm_root;
1657 #define my_safemalloc(s) (void*)safemalloc(s)
1658 #define my_safefree(p) safefree((char*)p)
1662 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1663 #define del_XNV(p) my_safefree(p)
1665 #define new_XPV() my_safemalloc(sizeof(XPV))
1666 #define del_XPV(p) my_safefree(p)
1668 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1669 #define del_XPVIV(p) my_safefree(p)
1671 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1672 #define del_XPVNV(p) my_safefree(p)
1674 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1675 #define del_XPVCV(p) my_safefree(p)
1677 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1678 #define del_XPVAV(p) my_safefree(p)
1680 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1681 #define del_XPVHV(p) my_safefree(p)
1683 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1684 #define del_XPVMG(p) my_safefree(p)
1686 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1687 #define del_XPVGV(p) my_safefree(p)
1689 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1690 #define del_XPVLV(p) my_safefree(p)
1692 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1693 #define del_XPVBM(p) my_safefree(p)
1697 #define new_XNV() (void*)new_xnv()
1698 #define del_XNV(p) del_xnv((XPVNV*) p)
1700 #define new_XPV() (void*)new_xpv()
1701 #define del_XPV(p) del_xpv((XPV *)p)
1703 #define new_XPVIV() (void*)new_xpviv()
1704 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1706 #define new_XPVNV() (void*)new_xpvnv()
1707 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1709 #define new_XPVCV() (void*)new_xpvcv()
1710 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1712 #define new_XPVAV() (void*)new_xpvav()
1713 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1715 #define new_XPVHV() (void*)new_xpvhv()
1716 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1718 #define new_XPVMG() (void*)new_xpvmg()
1719 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1721 #define new_XPVGV() (void*)new_xpvgv()
1722 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1724 #define new_XPVLV() (void*)new_xpvlv()
1725 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1727 #define new_XPVBM() (void*)new_xpvbm()
1728 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1732 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1733 #define del_XPVFM(p) my_safefree(p)
1735 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1736 #define del_XPVIO(p) my_safefree(p)
1739 =for apidoc sv_upgrade
1741 Upgrade an SV to a more complex form. Generally adds a new body type to the
1742 SV, then copies across as much information as possible from the old body.
1743 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1749 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1760 if (mt != SVt_PV && SvIsCOW(sv)) {
1761 sv_force_normal_flags(sv, 0);
1764 if (SvTYPE(sv) == mt)
1775 switch (SvTYPE(sv)) {
1782 else if (mt < SVt_PVIV)
1792 pv = (char*)SvRV(sv);
1801 else if (mt == SVt_NV)
1809 del_XPVIV(SvANY(sv));
1817 del_XPVNV(SvANY(sv));
1820 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1821 there's no way that it can be safely upgraded, because perl.c
1822 expects to Safefree(SvANY(PL_mess_sv)) */
1823 assert(sv != PL_mess_sv);
1824 /* This flag bit is used to mean other things in other scalar types.
1825 Given that it only has meaning inside the pad, it shouldn't be set
1826 on anything that can get upgraded. */
1827 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1833 magic = SvMAGIC(sv);
1834 stash = SvSTASH(sv);
1835 del_XPVMG(SvANY(sv));
1838 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1841 SvFLAGS(sv) &= ~SVTYPEMASK;
1846 Perl_croak(aTHX_ "Can't upgrade to undef");
1848 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.sv_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1852 SvANY(sv) = new_XNV();
1856 SvANY(sv) = &sv->sv_u.sv_rv;
1857 SvRV_set(sv, (SV*)pv);
1860 SvANY(sv) = new_XPVHV();
1861 ((XPVHV*) SvANY(sv))->xhv_aux = 0;
1864 HvTOTALKEYS(sv) = 0;
1866 /* Fall through... */
1869 SvANY(sv) = new_XPVAV();
1877 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1879 /* FIXME. Should be able to remove all this if()... if the above
1880 assertion is genuinely always true. */
1883 SvFLAGS(sv) &= ~SVf_OOK;
1886 SvPV_set(sv, (char*)0);
1887 SvMAGIC_set(sv, magic);
1888 SvSTASH_set(sv, stash);
1892 SvANY(sv) = new_XPVIO();
1893 Zero(SvANY(sv), 1, XPVIO);
1894 IoPAGE_LEN(sv) = 60;
1895 goto set_magic_common;
1897 SvANY(sv) = new_XPVFM();
1898 Zero(SvANY(sv), 1, XPVFM);
1899 goto set_magic_common;
1901 SvANY(sv) = new_XPVBM();
1905 goto set_magic_common;
1907 SvANY(sv) = new_XPVGV();
1913 goto set_magic_common;
1915 SvANY(sv) = new_XPVCV();
1916 Zero(SvANY(sv), 1, XPVCV);
1917 goto set_magic_common;
1919 SvANY(sv) = new_XPVLV();
1932 SvANY(sv) = new_XPVMG();
1935 SvMAGIC_set(sv, magic);
1936 SvSTASH_set(sv, stash);
1940 SvANY(sv) = new_XPVNV();
1946 SvANY(sv) = new_XPVIV();
1955 SvANY(sv) = new_XPV();
1966 =for apidoc sv_backoff
1968 Remove any string offset. You should normally use the C<SvOOK_off> macro
1975 Perl_sv_backoff(pTHX_ register SV *sv)
1979 char *s = SvPVX(sv);
1980 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1981 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1983 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1985 SvFLAGS(sv) &= ~SVf_OOK;
1992 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1993 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1994 Use the C<SvGROW> wrapper instead.
2000 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2004 #ifdef HAS_64K_LIMIT
2005 if (newlen >= 0x10000) {
2006 PerlIO_printf(Perl_debug_log,
2007 "Allocation too large: %"UVxf"\n", (UV)newlen);
2010 #endif /* HAS_64K_LIMIT */
2013 if (SvTYPE(sv) < SVt_PV) {
2014 sv_upgrade(sv, SVt_PV);
2017 else if (SvOOK(sv)) { /* pv is offset? */
2020 if (newlen > SvLEN(sv))
2021 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2022 #ifdef HAS_64K_LIMIT
2023 if (newlen >= 0x10000)
2030 if (newlen > SvLEN(sv)) { /* need more room? */
2031 if (SvLEN(sv) && s) {
2033 const STRLEN l = malloced_size((void*)SvPVX(sv));
2039 Renew(s,newlen,char);
2042 New(703, s, newlen, char);
2043 if (SvPVX(sv) && SvCUR(sv)) {
2044 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2048 SvLEN_set(sv, newlen);
2054 =for apidoc sv_setiv
2056 Copies an integer into the given SV, upgrading first if necessary.
2057 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2063 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2065 SV_CHECK_THINKFIRST_COW_DROP(sv);
2066 switch (SvTYPE(sv)) {
2068 sv_upgrade(sv, SVt_IV);
2071 sv_upgrade(sv, SVt_PVNV);
2075 sv_upgrade(sv, SVt_PVIV);
2084 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2087 (void)SvIOK_only(sv); /* validate number */
2093 =for apidoc sv_setiv_mg
2095 Like C<sv_setiv>, but also handles 'set' magic.
2101 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2108 =for apidoc sv_setuv
2110 Copies an unsigned integer into the given SV, upgrading first if necessary.
2111 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2117 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2119 /* With these two if statements:
2120 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2123 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2125 If you wish to remove them, please benchmark to see what the effect is
2127 if (u <= (UV)IV_MAX) {
2128 sv_setiv(sv, (IV)u);
2137 =for apidoc sv_setuv_mg
2139 Like C<sv_setuv>, but also handles 'set' magic.
2145 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2147 /* With these two if statements:
2148 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2151 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2153 If you wish to remove them, please benchmark to see what the effect is
2155 if (u <= (UV)IV_MAX) {
2156 sv_setiv(sv, (IV)u);
2166 =for apidoc sv_setnv
2168 Copies a double into the given SV, upgrading first if necessary.
2169 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2175 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2177 SV_CHECK_THINKFIRST_COW_DROP(sv);
2178 switch (SvTYPE(sv)) {
2181 sv_upgrade(sv, SVt_NV);
2186 sv_upgrade(sv, SVt_PVNV);
2195 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2199 (void)SvNOK_only(sv); /* validate number */
2204 =for apidoc sv_setnv_mg
2206 Like C<sv_setnv>, but also handles 'set' magic.
2212 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2218 /* Print an "isn't numeric" warning, using a cleaned-up,
2219 * printable version of the offending string
2223 S_not_a_number(pTHX_ SV *sv)
2230 dsv = sv_2mortal(newSVpv("", 0));
2231 pv = sv_uni_display(dsv, sv, 10, 0);
2234 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2235 /* each *s can expand to 4 chars + "...\0",
2236 i.e. need room for 8 chars */
2239 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2241 if (ch & 128 && !isPRINT_LC(ch)) {
2250 else if (ch == '\r') {
2254 else if (ch == '\f') {
2258 else if (ch == '\\') {
2262 else if (ch == '\0') {
2266 else if (isPRINT_LC(ch))
2283 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2284 "Argument \"%s\" isn't numeric in %s", pv,
2287 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2288 "Argument \"%s\" isn't numeric", pv);
2292 =for apidoc looks_like_number
2294 Test if the content of an SV looks like a number (or is a number).
2295 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2296 non-numeric warning), even if your atof() doesn't grok them.
2302 Perl_looks_like_number(pTHX_ SV *sv)
2304 register const char *sbegin;
2311 else if (SvPOKp(sv))
2312 sbegin = SvPV(sv, len);
2314 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2315 return grok_number(sbegin, len, NULL);
2318 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2319 until proven guilty, assume that things are not that bad... */
2324 As 64 bit platforms often have an NV that doesn't preserve all bits of
2325 an IV (an assumption perl has been based on to date) it becomes necessary
2326 to remove the assumption that the NV always carries enough precision to
2327 recreate the IV whenever needed, and that the NV is the canonical form.
2328 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2329 precision as a side effect of conversion (which would lead to insanity
2330 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2331 1) to distinguish between IV/UV/NV slots that have cached a valid
2332 conversion where precision was lost and IV/UV/NV slots that have a
2333 valid conversion which has lost no precision
2334 2) to ensure that if a numeric conversion to one form is requested that
2335 would lose precision, the precise conversion (or differently
2336 imprecise conversion) is also performed and cached, to prevent
2337 requests for different numeric formats on the same SV causing
2338 lossy conversion chains. (lossless conversion chains are perfectly
2343 SvIOKp is true if the IV slot contains a valid value
2344 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2345 SvNOKp is true if the NV slot contains a valid value
2346 SvNOK is true only if the NV value is accurate
2349 while converting from PV to NV, check to see if converting that NV to an
2350 IV(or UV) would lose accuracy over a direct conversion from PV to
2351 IV(or UV). If it would, cache both conversions, return NV, but mark
2352 SV as IOK NOKp (ie not NOK).
2354 While converting from PV to IV, check to see if converting that IV to an
2355 NV would lose accuracy over a direct conversion from PV to NV. If it
2356 would, cache both conversions, flag similarly.
2358 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2359 correctly because if IV & NV were set NV *always* overruled.
2360 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2361 changes - now IV and NV together means that the two are interchangeable:
2362 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2364 The benefit of this is that operations such as pp_add know that if
2365 SvIOK is true for both left and right operands, then integer addition
2366 can be used instead of floating point (for cases where the result won't
2367 overflow). Before, floating point was always used, which could lead to
2368 loss of precision compared with integer addition.
2370 * making IV and NV equal status should make maths accurate on 64 bit
2372 * may speed up maths somewhat if pp_add and friends start to use
2373 integers when possible instead of fp. (Hopefully the overhead in
2374 looking for SvIOK and checking for overflow will not outweigh the
2375 fp to integer speedup)
2376 * will slow down integer operations (callers of SvIV) on "inaccurate"
2377 values, as the change from SvIOK to SvIOKp will cause a call into
2378 sv_2iv each time rather than a macro access direct to the IV slot
2379 * should speed up number->string conversion on integers as IV is
2380 favoured when IV and NV are equally accurate
2382 ####################################################################
2383 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2384 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2385 On the other hand, SvUOK is true iff UV.
2386 ####################################################################
2388 Your mileage will vary depending your CPU's relative fp to integer
2392 #ifndef NV_PRESERVES_UV
2393 # define IS_NUMBER_UNDERFLOW_IV 1
2394 # define IS_NUMBER_UNDERFLOW_UV 2
2395 # define IS_NUMBER_IV_AND_UV 2
2396 # define IS_NUMBER_OVERFLOW_IV 4
2397 # define IS_NUMBER_OVERFLOW_UV 5
2399 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2401 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2403 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2405 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2406 if (SvNVX(sv) < (NV)IV_MIN) {
2407 (void)SvIOKp_on(sv);
2409 SvIV_set(sv, IV_MIN);
2410 return IS_NUMBER_UNDERFLOW_IV;
2412 if (SvNVX(sv) > (NV)UV_MAX) {
2413 (void)SvIOKp_on(sv);
2416 SvUV_set(sv, UV_MAX);
2417 return IS_NUMBER_OVERFLOW_UV;
2419 (void)SvIOKp_on(sv);
2421 /* Can't use strtol etc to convert this string. (See truth table in
2423 if (SvNVX(sv) <= (UV)IV_MAX) {
2424 SvIV_set(sv, I_V(SvNVX(sv)));
2425 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2426 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2428 /* Integer is imprecise. NOK, IOKp */
2430 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2433 SvUV_set(sv, U_V(SvNVX(sv)));
2434 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2435 if (SvUVX(sv) == UV_MAX) {
2436 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2437 possibly be preserved by NV. Hence, it must be overflow.
2439 return IS_NUMBER_OVERFLOW_UV;
2441 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2443 /* Integer is imprecise. NOK, IOKp */
2445 return IS_NUMBER_OVERFLOW_IV;
2447 #endif /* !NV_PRESERVES_UV*/
2449 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2450 * this function provided for binary compatibility only
2454 Perl_sv_2iv(pTHX_ register SV *sv)
2456 return sv_2iv_flags(sv, SV_GMAGIC);
2460 =for apidoc sv_2iv_flags
2462 Return the integer value of an SV, doing any necessary string
2463 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2464 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2470 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2474 if (SvGMAGICAL(sv)) {
2475 if (flags & SV_GMAGIC)
2480 return I_V(SvNVX(sv));
2482 if (SvPOKp(sv) && SvLEN(sv))
2485 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2486 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2492 if (SvTHINKFIRST(sv)) {
2495 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2496 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2497 return SvIV(tmpstr);
2498 return PTR2IV(SvRV(sv));
2501 sv_force_normal_flags(sv, 0);
2503 if (SvREADONLY(sv) && !SvOK(sv)) {
2504 if (ckWARN(WARN_UNINITIALIZED))
2511 return (IV)(SvUVX(sv));
2518 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2519 * without also getting a cached IV/UV from it at the same time
2520 * (ie PV->NV conversion should detect loss of accuracy and cache
2521 * IV or UV at same time to avoid this. NWC */
2523 if (SvTYPE(sv) == SVt_NV)
2524 sv_upgrade(sv, SVt_PVNV);
2526 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2527 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2528 certainly cast into the IV range at IV_MAX, whereas the correct
2529 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2531 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2532 SvIV_set(sv, I_V(SvNVX(sv)));
2533 if (SvNVX(sv) == (NV) SvIVX(sv)
2534 #ifndef NV_PRESERVES_UV
2535 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2536 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2537 /* Don't flag it as "accurately an integer" if the number
2538 came from a (by definition imprecise) NV operation, and
2539 we're outside the range of NV integer precision */
2542 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2543 DEBUG_c(PerlIO_printf(Perl_debug_log,
2544 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2550 /* IV not precise. No need to convert from PV, as NV
2551 conversion would already have cached IV if it detected
2552 that PV->IV would be better than PV->NV->IV
2553 flags already correct - don't set public IOK. */
2554 DEBUG_c(PerlIO_printf(Perl_debug_log,
2555 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2560 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2561 but the cast (NV)IV_MIN rounds to a the value less (more
2562 negative) than IV_MIN which happens to be equal to SvNVX ??
2563 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2564 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2565 (NV)UVX == NVX are both true, but the values differ. :-(
2566 Hopefully for 2s complement IV_MIN is something like
2567 0x8000000000000000 which will be exact. NWC */
2570 SvUV_set(sv, U_V(SvNVX(sv)));
2572 (SvNVX(sv) == (NV) SvUVX(sv))
2573 #ifndef NV_PRESERVES_UV
2574 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2575 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2576 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2577 /* Don't flag it as "accurately an integer" if the number
2578 came from a (by definition imprecise) NV operation, and
2579 we're outside the range of NV integer precision */
2585 DEBUG_c(PerlIO_printf(Perl_debug_log,
2586 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2590 return (IV)SvUVX(sv);
2593 else if (SvPOKp(sv) && SvLEN(sv)) {
2595 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2596 /* We want to avoid a possible problem when we cache an IV which
2597 may be later translated to an NV, and the resulting NV is not
2598 the same as the direct translation of the initial string
2599 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2600 be careful to ensure that the value with the .456 is around if the
2601 NV value is requested in the future).
2603 This means that if we cache such an IV, we need to cache the
2604 NV as well. Moreover, we trade speed for space, and do not
2605 cache the NV if we are sure it's not needed.
2608 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2609 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2610 == IS_NUMBER_IN_UV) {
2611 /* It's definitely an integer, only upgrade to PVIV */
2612 if (SvTYPE(sv) < SVt_PVIV)
2613 sv_upgrade(sv, SVt_PVIV);
2615 } else if (SvTYPE(sv) < SVt_PVNV)
2616 sv_upgrade(sv, SVt_PVNV);
2618 /* If NV preserves UV then we only use the UV value if we know that
2619 we aren't going to call atof() below. If NVs don't preserve UVs
2620 then the value returned may have more precision than atof() will
2621 return, even though value isn't perfectly accurate. */
2622 if ((numtype & (IS_NUMBER_IN_UV
2623 #ifdef NV_PRESERVES_UV
2626 )) == IS_NUMBER_IN_UV) {
2627 /* This won't turn off the public IOK flag if it was set above */
2628 (void)SvIOKp_on(sv);
2630 if (!(numtype & IS_NUMBER_NEG)) {
2632 if (value <= (UV)IV_MAX) {
2633 SvIV_set(sv, (IV)value);
2635 SvUV_set(sv, value);
2639 /* 2s complement assumption */
2640 if (value <= (UV)IV_MIN) {
2641 SvIV_set(sv, -(IV)value);
2643 /* Too negative for an IV. This is a double upgrade, but
2644 I'm assuming it will be rare. */
2645 if (SvTYPE(sv) < SVt_PVNV)
2646 sv_upgrade(sv, SVt_PVNV);
2650 SvNV_set(sv, -(NV)value);
2651 SvIV_set(sv, IV_MIN);
2655 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2656 will be in the previous block to set the IV slot, and the next
2657 block to set the NV slot. So no else here. */
2659 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2660 != IS_NUMBER_IN_UV) {
2661 /* It wasn't an (integer that doesn't overflow the UV). */
2662 SvNV_set(sv, Atof(SvPVX(sv)));
2664 if (! numtype && ckWARN(WARN_NUMERIC))
2667 #if defined(USE_LONG_DOUBLE)
2668 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2669 PTR2UV(sv), SvNVX(sv)));
2671 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2672 PTR2UV(sv), SvNVX(sv)));
2676 #ifdef NV_PRESERVES_UV
2677 (void)SvIOKp_on(sv);
2679 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2680 SvIV_set(sv, I_V(SvNVX(sv)));
2681 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2684 /* Integer is imprecise. NOK, IOKp */
2686 /* UV will not work better than IV */
2688 if (SvNVX(sv) > (NV)UV_MAX) {
2690 /* Integer is inaccurate. NOK, IOKp, is UV */
2691 SvUV_set(sv, UV_MAX);
2694 SvUV_set(sv, U_V(SvNVX(sv)));
2695 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2696 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2700 /* Integer is imprecise. NOK, IOKp, is UV */
2706 #else /* NV_PRESERVES_UV */
2707 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2708 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2709 /* The IV slot will have been set from value returned by
2710 grok_number above. The NV slot has just been set using
2713 assert (SvIOKp(sv));
2715 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2716 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2717 /* Small enough to preserve all bits. */
2718 (void)SvIOKp_on(sv);
2720 SvIV_set(sv, I_V(SvNVX(sv)));
2721 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2723 /* Assumption: first non-preserved integer is < IV_MAX,
2724 this NV is in the preserved range, therefore: */
2725 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2727 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);
2731 0 0 already failed to read UV.
2732 0 1 already failed to read UV.
2733 1 0 you won't get here in this case. IV/UV
2734 slot set, public IOK, Atof() unneeded.
2735 1 1 already read UV.
2736 so there's no point in sv_2iuv_non_preserve() attempting
2737 to use atol, strtol, strtoul etc. */
2738 if (sv_2iuv_non_preserve (sv, numtype)
2739 >= IS_NUMBER_OVERFLOW_IV)
2743 #endif /* NV_PRESERVES_UV */
2746 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2748 if (SvTYPE(sv) < SVt_IV)
2749 /* Typically the caller expects that sv_any is not NULL now. */
2750 sv_upgrade(sv, SVt_IV);
2753 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2754 PTR2UV(sv),SvIVX(sv)));
2755 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2758 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2759 * this function provided for binary compatibility only
2763 Perl_sv_2uv(pTHX_ register SV *sv)
2765 return sv_2uv_flags(sv, SV_GMAGIC);
2769 =for apidoc sv_2uv_flags
2771 Return the unsigned integer value of an SV, doing any necessary string
2772 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2773 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2779 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2783 if (SvGMAGICAL(sv)) {
2784 if (flags & SV_GMAGIC)
2789 return U_V(SvNVX(sv));
2790 if (SvPOKp(sv) && SvLEN(sv))
2793 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2794 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2800 if (SvTHINKFIRST(sv)) {
2803 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2804 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2805 return SvUV(tmpstr);
2806 return PTR2UV(SvRV(sv));
2809 sv_force_normal_flags(sv, 0);
2811 if (SvREADONLY(sv) && !SvOK(sv)) {
2812 if (ckWARN(WARN_UNINITIALIZED))
2822 return (UV)SvIVX(sv);
2826 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2827 * without also getting a cached IV/UV from it at the same time
2828 * (ie PV->NV conversion should detect loss of accuracy and cache
2829 * IV or UV at same time to avoid this. */
2830 /* IV-over-UV optimisation - choose to cache IV if possible */
2832 if (SvTYPE(sv) == SVt_NV)
2833 sv_upgrade(sv, SVt_PVNV);
2835 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2836 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2837 SvIV_set(sv, I_V(SvNVX(sv)));
2838 if (SvNVX(sv) == (NV) SvIVX(sv)
2839 #ifndef NV_PRESERVES_UV
2840 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2841 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2842 /* Don't flag it as "accurately an integer" if the number
2843 came from a (by definition imprecise) NV operation, and
2844 we're outside the range of NV integer precision */
2847 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2848 DEBUG_c(PerlIO_printf(Perl_debug_log,
2849 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2855 /* IV not precise. No need to convert from PV, as NV
2856 conversion would already have cached IV if it detected
2857 that PV->IV would be better than PV->NV->IV
2858 flags already correct - don't set public IOK. */
2859 DEBUG_c(PerlIO_printf(Perl_debug_log,
2860 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2865 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2866 but the cast (NV)IV_MIN rounds to a the value less (more
2867 negative) than IV_MIN which happens to be equal to SvNVX ??
2868 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2869 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2870 (NV)UVX == NVX are both true, but the values differ. :-(
2871 Hopefully for 2s complement IV_MIN is something like
2872 0x8000000000000000 which will be exact. NWC */
2875 SvUV_set(sv, U_V(SvNVX(sv)));
2877 (SvNVX(sv) == (NV) SvUVX(sv))
2878 #ifndef NV_PRESERVES_UV
2879 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2880 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2881 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2882 /* Don't flag it as "accurately an integer" if the number
2883 came from a (by definition imprecise) NV operation, and
2884 we're outside the range of NV integer precision */
2889 DEBUG_c(PerlIO_printf(Perl_debug_log,
2890 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2896 else if (SvPOKp(sv) && SvLEN(sv)) {
2898 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2900 /* We want to avoid a possible problem when we cache a UV which
2901 may be later translated to an NV, and the resulting NV is not
2902 the translation of the initial data.
2904 This means that if we cache such a UV, we need to cache the
2905 NV as well. Moreover, we trade speed for space, and do not
2906 cache the NV if not needed.
2909 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2910 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2911 == IS_NUMBER_IN_UV) {
2912 /* It's definitely an integer, only upgrade to PVIV */
2913 if (SvTYPE(sv) < SVt_PVIV)
2914 sv_upgrade(sv, SVt_PVIV);
2916 } else if (SvTYPE(sv) < SVt_PVNV)
2917 sv_upgrade(sv, SVt_PVNV);
2919 /* If NV preserves UV then we only use the UV value if we know that
2920 we aren't going to call atof() below. If NVs don't preserve UVs
2921 then the value returned may have more precision than atof() will
2922 return, even though it isn't accurate. */
2923 if ((numtype & (IS_NUMBER_IN_UV
2924 #ifdef NV_PRESERVES_UV
2927 )) == IS_NUMBER_IN_UV) {
2928 /* This won't turn off the public IOK flag if it was set above */
2929 (void)SvIOKp_on(sv);
2931 if (!(numtype & IS_NUMBER_NEG)) {
2933 if (value <= (UV)IV_MAX) {
2934 SvIV_set(sv, (IV)value);
2936 /* it didn't overflow, and it was positive. */
2937 SvUV_set(sv, value);
2941 /* 2s complement assumption */
2942 if (value <= (UV)IV_MIN) {
2943 SvIV_set(sv, -(IV)value);
2945 /* Too negative for an IV. This is a double upgrade, but
2946 I'm assuming it will be rare. */
2947 if (SvTYPE(sv) < SVt_PVNV)
2948 sv_upgrade(sv, SVt_PVNV);
2952 SvNV_set(sv, -(NV)value);
2953 SvIV_set(sv, IV_MIN);
2958 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2959 != IS_NUMBER_IN_UV) {
2960 /* It wasn't an integer, or it overflowed the UV. */
2961 SvNV_set(sv, Atof(SvPVX(sv)));
2963 if (! numtype && ckWARN(WARN_NUMERIC))
2966 #if defined(USE_LONG_DOUBLE)
2967 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2968 PTR2UV(sv), SvNVX(sv)));
2970 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2971 PTR2UV(sv), SvNVX(sv)));
2974 #ifdef NV_PRESERVES_UV
2975 (void)SvIOKp_on(sv);
2977 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2978 SvIV_set(sv, I_V(SvNVX(sv)));
2979 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2982 /* Integer is imprecise. NOK, IOKp */
2984 /* UV will not work better than IV */
2986 if (SvNVX(sv) > (NV)UV_MAX) {
2988 /* Integer is inaccurate. NOK, IOKp, is UV */
2989 SvUV_set(sv, UV_MAX);
2992 SvUV_set(sv, U_V(SvNVX(sv)));
2993 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2994 NV preservse UV so can do correct comparison. */
2995 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2999 /* Integer is imprecise. NOK, IOKp, is UV */
3004 #else /* NV_PRESERVES_UV */
3005 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3006 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3007 /* The UV slot will have been set from value returned by
3008 grok_number above. The NV slot has just been set using
3011 assert (SvIOKp(sv));
3013 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3014 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3015 /* Small enough to preserve all bits. */
3016 (void)SvIOKp_on(sv);
3018 SvIV_set(sv, I_V(SvNVX(sv)));
3019 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3021 /* Assumption: first non-preserved integer is < IV_MAX,
3022 this NV is in the preserved range, therefore: */
3023 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3025 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);
3028 sv_2iuv_non_preserve (sv, numtype);
3030 #endif /* NV_PRESERVES_UV */
3034 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3035 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3038 if (SvTYPE(sv) < SVt_IV)
3039 /* Typically the caller expects that sv_any is not NULL now. */
3040 sv_upgrade(sv, SVt_IV);
3044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3045 PTR2UV(sv),SvUVX(sv)));
3046 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3052 Return the num value of an SV, doing any necessary string or integer
3053 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3060 Perl_sv_2nv(pTHX_ register SV *sv)
3064 if (SvGMAGICAL(sv)) {
3068 if (SvPOKp(sv) && SvLEN(sv)) {
3069 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3070 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3072 return Atof(SvPVX(sv));
3076 return (NV)SvUVX(sv);
3078 return (NV)SvIVX(sv);
3081 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3082 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3088 if (SvTHINKFIRST(sv)) {
3091 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3092 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3093 return SvNV(tmpstr);
3094 return PTR2NV(SvRV(sv));
3097 sv_force_normal_flags(sv, 0);
3099 if (SvREADONLY(sv) && !SvOK(sv)) {
3100 if (ckWARN(WARN_UNINITIALIZED))
3105 if (SvTYPE(sv) < SVt_NV) {
3106 if (SvTYPE(sv) == SVt_IV)
3107 sv_upgrade(sv, SVt_PVNV);
3109 sv_upgrade(sv, SVt_NV);
3110 #ifdef USE_LONG_DOUBLE
3112 STORE_NUMERIC_LOCAL_SET_STANDARD();
3113 PerlIO_printf(Perl_debug_log,
3114 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3115 PTR2UV(sv), SvNVX(sv));
3116 RESTORE_NUMERIC_LOCAL();
3120 STORE_NUMERIC_LOCAL_SET_STANDARD();
3121 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3122 PTR2UV(sv), SvNVX(sv));
3123 RESTORE_NUMERIC_LOCAL();
3127 else if (SvTYPE(sv) < SVt_PVNV)
3128 sv_upgrade(sv, SVt_PVNV);
3133 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3134 #ifdef NV_PRESERVES_UV
3137 /* Only set the public NV OK flag if this NV preserves the IV */
3138 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3139 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3140 : (SvIVX(sv) == I_V(SvNVX(sv))))
3146 else if (SvPOKp(sv) && SvLEN(sv)) {
3148 const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3149 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3151 #ifdef NV_PRESERVES_UV
3152 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3153 == IS_NUMBER_IN_UV) {
3154 /* It's definitely an integer */
3155 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3157 SvNV_set(sv, Atof(SvPVX(sv)));
3160 SvNV_set(sv, Atof(SvPVX(sv)));
3161 /* Only set the public NV OK flag if this NV preserves the value in
3162 the PV at least as well as an IV/UV would.
3163 Not sure how to do this 100% reliably. */
3164 /* if that shift count is out of range then Configure's test is
3165 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3167 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3168 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3169 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3170 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3171 /* Can't use strtol etc to convert this string, so don't try.
3172 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3175 /* value has been set. It may not be precise. */
3176 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3177 /* 2s complement assumption for (UV)IV_MIN */
3178 SvNOK_on(sv); /* Integer is too negative. */
3183 if (numtype & IS_NUMBER_NEG) {
3184 SvIV_set(sv, -(IV)value);
3185 } else if (value <= (UV)IV_MAX) {
3186 SvIV_set(sv, (IV)value);
3188 SvUV_set(sv, value);
3192 if (numtype & IS_NUMBER_NOT_INT) {
3193 /* I believe that even if the original PV had decimals,
3194 they are lost beyond the limit of the FP precision.
3195 However, neither is canonical, so both only get p
3196 flags. NWC, 2000/11/25 */
3197 /* Both already have p flags, so do nothing */
3200 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3201 if (SvIVX(sv) == I_V(nv)) {
3206 /* It had no "." so it must be integer. */
3209 /* between IV_MAX and NV(UV_MAX).
3210 Could be slightly > UV_MAX */
3212 if (numtype & IS_NUMBER_NOT_INT) {
3213 /* UV and NV both imprecise. */
3215 UV nv_as_uv = U_V(nv);
3217 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3228 #endif /* NV_PRESERVES_UV */
3231 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3233 if (SvTYPE(sv) < SVt_NV)
3234 /* Typically the caller expects that sv_any is not NULL now. */
3235 /* XXX Ilya implies that this is a bug in callers that assume this
3236 and ideally should be fixed. */
3237 sv_upgrade(sv, SVt_NV);
3240 #if defined(USE_LONG_DOUBLE)
3242 STORE_NUMERIC_LOCAL_SET_STANDARD();
3243 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3244 PTR2UV(sv), SvNVX(sv));
3245 RESTORE_NUMERIC_LOCAL();
3249 STORE_NUMERIC_LOCAL_SET_STANDARD();
3250 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3251 PTR2UV(sv), SvNVX(sv));
3252 RESTORE_NUMERIC_LOCAL();
3258 /* asIV(): extract an integer from the string value of an SV.
3259 * Caller must validate PVX */
3262 S_asIV(pTHX_ SV *sv)
3265 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3267 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3268 == IS_NUMBER_IN_UV) {
3269 /* It's definitely an integer */
3270 if (numtype & IS_NUMBER_NEG) {
3271 if (value < (UV)IV_MIN)
3274 if (value < (UV)IV_MAX)
3279 if (ckWARN(WARN_NUMERIC))
3282 return I_V(Atof(SvPVX(sv)));
3285 /* asUV(): extract an unsigned integer from the string value of an SV
3286 * Caller must validate PVX */
3289 S_asUV(pTHX_ SV *sv)
3292 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3294 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3295 == IS_NUMBER_IN_UV) {
3296 /* It's definitely an integer */
3297 if (!(numtype & IS_NUMBER_NEG))
3301 if (ckWARN(WARN_NUMERIC))
3304 return U_V(Atof(SvPVX(sv)));
3308 =for apidoc sv_2pv_nolen
3310 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3311 use the macro wrapper C<SvPV_nolen(sv)> instead.
3316 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3319 return sv_2pv(sv, &n_a);
3322 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3323 * UV as a string towards the end of buf, and return pointers to start and
3326 * We assume that buf is at least TYPE_CHARS(UV) long.
3330 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3332 char *ptr = buf + TYPE_CHARS(UV);
3346 *--ptr = '0' + (char)(uv % 10);
3354 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3355 * this function provided for binary compatibility only
3359 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3361 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3365 =for apidoc sv_2pv_flags
3367 Returns a pointer to the string value of an SV, and sets *lp to its length.
3368 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3370 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3371 usually end up here too.
3377 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3382 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3383 char *tmpbuf = tbuf;
3389 if (SvGMAGICAL(sv)) {
3390 if (flags & SV_GMAGIC)
3398 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3400 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3405 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3410 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3411 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3418 if (SvTHINKFIRST(sv)) {
3421 register const char *typestr;
3422 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3423 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3424 char *pv = SvPV(tmpstr, *lp);
3434 typestr = "NULLREF";
3438 switch (SvTYPE(sv)) {
3440 if ( ((SvFLAGS(sv) &
3441 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3442 == (SVs_OBJECT|SVs_SMG))
3443 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3444 const regexp *re = (regexp *)mg->mg_obj;
3447 const char *fptr = "msix";
3452 char need_newline = 0;
3453 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3455 while((ch = *fptr++)) {
3457 reflags[left++] = ch;
3460 reflags[right--] = ch;
3465 reflags[left] = '-';
3469 mg->mg_len = re->prelen + 4 + left;
3471 * If /x was used, we have to worry about a regex
3472 * ending with a comment later being embedded
3473 * within another regex. If so, we don't want this
3474 * regex's "commentization" to leak out to the
3475 * right part of the enclosing regex, we must cap
3476 * it with a newline.
3478 * So, if /x was used, we scan backwards from the
3479 * end of the regex. If we find a '#' before we
3480 * find a newline, we need to add a newline
3481 * ourself. If we find a '\n' first (or if we
3482 * don't find '#' or '\n'), we don't need to add
3483 * anything. -jfriedl
3485 if (PMf_EXTENDED & re->reganch)
3487 const char *endptr = re->precomp + re->prelen;
3488 while (endptr >= re->precomp)
3490 const char c = *(endptr--);
3492 break; /* don't need another */
3494 /* we end while in a comment, so we
3496 mg->mg_len++; /* save space for it */
3497 need_newline = 1; /* note to add it */
3503 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3504 Copy("(?", mg->mg_ptr, 2, char);
3505 Copy(reflags, mg->mg_ptr+2, left, char);
3506 Copy(":", mg->mg_ptr+left+2, 1, char);
3507 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3509 mg->mg_ptr[mg->mg_len - 2] = '\n';
3510 mg->mg_ptr[mg->mg_len - 1] = ')';
3511 mg->mg_ptr[mg->mg_len] = 0;
3513 PL_reginterp_cnt += re->program[0].next_off;
3515 if (re->reganch & ROPT_UTF8)
3530 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3531 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3532 /* tied lvalues should appear to be
3533 * scalars for backwards compatitbility */
3534 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3535 ? "SCALAR" : "LVALUE"; break;
3536 case SVt_PVAV: typestr = "ARRAY"; break;
3537 case SVt_PVHV: typestr = "HASH"; break;
3538 case SVt_PVCV: typestr = "CODE"; break;
3539 case SVt_PVGV: typestr = "GLOB"; break;
3540 case SVt_PVFM: typestr = "FORMAT"; break;
3541 case SVt_PVIO: typestr = "IO"; break;
3542 default: typestr = "UNKNOWN"; break;
3546 const char *name = HvNAME_get(SvSTASH(sv));
3547 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3548 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3551 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3554 *lp = strlen(typestr);
3555 return (char *)typestr;
3557 if (SvREADONLY(sv) && !SvOK(sv)) {
3558 if (ckWARN(WARN_UNINITIALIZED))
3564 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3565 /* I'm assuming that if both IV and NV are equally valid then
3566 converting the IV is going to be more efficient */
3567 const U32 isIOK = SvIOK(sv);
3568 const U32 isUIOK = SvIsUV(sv);
3569 char buf[TYPE_CHARS(UV)];
3572 if (SvTYPE(sv) < SVt_PVIV)
3573 sv_upgrade(sv, SVt_PVIV);
3575 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3577 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3578 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3579 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3580 SvCUR_set(sv, ebuf - ptr);
3590 else if (SvNOKp(sv)) {
3591 if (SvTYPE(sv) < SVt_PVNV)
3592 sv_upgrade(sv, SVt_PVNV);
3593 /* The +20 is pure guesswork. Configure test needed. --jhi */
3594 SvGROW(sv, NV_DIG + 20);
3596 olderrno = errno; /* some Xenix systems wipe out errno here */
3598 if (SvNVX(sv) == 0.0)
3599 (void)strcpy(s,"0");
3603 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3606 #ifdef FIXNEGATIVEZERO
3607 if (*s == '-' && s[1] == '0' && !s[2])
3617 if (ckWARN(WARN_UNINITIALIZED)
3618 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3621 if (SvTYPE(sv) < SVt_PV)
3622 /* Typically the caller expects that sv_any is not NULL now. */
3623 sv_upgrade(sv, SVt_PV);
3626 *lp = s - SvPVX(sv);
3629 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3630 PTR2UV(sv),SvPVX(sv)));
3634 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3635 /* Sneaky stuff here */
3639 tsv = newSVpv(tmpbuf, 0);
3656 len = strlen(tmpbuf);
3658 #ifdef FIXNEGATIVEZERO
3659 if (len == 2 && t[0] == '-' && t[1] == '0') {
3664 (void)SvUPGRADE(sv, SVt_PV);
3666 s = SvGROW(sv, len + 1);
3669 return strcpy(s, t);
3674 =for apidoc sv_copypv
3676 Copies a stringified representation of the source SV into the
3677 destination SV. Automatically performs any necessary mg_get and
3678 coercion of numeric values into strings. Guaranteed to preserve
3679 UTF-8 flag even from overloaded objects. Similar in nature to
3680 sv_2pv[_flags] but operates directly on an SV instead of just the
3681 string. Mostly uses sv_2pv_flags to do its work, except when that
3682 would lose the UTF-8'ness of the PV.
3688 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3693 sv_setpvn(dsv,s,len);
3701 =for apidoc sv_2pvbyte_nolen
3703 Return a pointer to the byte-encoded representation of the SV.
3704 May cause the SV to be downgraded from UTF-8 as a side-effect.
3706 Usually accessed via the C<SvPVbyte_nolen> macro.
3712 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3715 return sv_2pvbyte(sv, &n_a);
3719 =for apidoc sv_2pvbyte
3721 Return a pointer to the byte-encoded representation of the SV, and set *lp
3722 to its length. May cause the SV to be downgraded from UTF-8 as a
3725 Usually accessed via the C<SvPVbyte> macro.
3731 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3733 sv_utf8_downgrade(sv,0);
3734 return SvPV(sv,*lp);
3738 =for apidoc sv_2pvutf8_nolen
3740 Return a pointer to the UTF-8-encoded representation of the SV.
3741 May cause the SV to be upgraded to UTF-8 as a side-effect.
3743 Usually accessed via the C<SvPVutf8_nolen> macro.
3749 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3752 return sv_2pvutf8(sv, &n_a);
3756 =for apidoc sv_2pvutf8
3758 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3759 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3761 Usually accessed via the C<SvPVutf8> macro.
3767 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3769 sv_utf8_upgrade(sv);
3770 return SvPV(sv,*lp);
3774 =for apidoc sv_2bool
3776 This function is only called on magical items, and is only used by
3777 sv_true() or its macro equivalent.
3783 Perl_sv_2bool(pTHX_ register SV *sv)
3792 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3793 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3794 return (bool)SvTRUE(tmpsv);
3795 return SvRV(sv) != 0;
3798 register XPV* Xpvtmp;
3799 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3800 (*sv->sv_u.sv_pv > '0' ||
3801 Xpvtmp->xpv_cur > 1 ||
3802 (Xpvtmp->xpv_cur && *sv->sv_u.sv_pv != '0')))
3809 return SvIVX(sv) != 0;
3812 return SvNVX(sv) != 0.0;
3819 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3820 * this function provided for binary compatibility only
3825 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3827 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3831 =for apidoc sv_utf8_upgrade
3833 Converts the PV of an SV to its UTF-8-encoded form.
3834 Forces the SV to string form if it is not already.
3835 Always sets the SvUTF8 flag to avoid future validity checks even
3836 if all the bytes have hibit clear.
3838 This is not as a general purpose byte encoding to Unicode interface:
3839 use the Encode extension for that.
3841 =for apidoc sv_utf8_upgrade_flags
3843 Converts the PV of an SV to its UTF-8-encoded form.
3844 Forces the SV to string form if it is not already.
3845 Always sets the SvUTF8 flag to avoid future validity checks even
3846 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3847 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3848 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3850 This is not as a general purpose byte encoding to Unicode interface:
3851 use the Encode extension for that.
3857 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3859 if (sv == &PL_sv_undef)
3863 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3864 (void) sv_2pv_flags(sv,&len, flags);
3868 (void) SvPV_force(sv,len);
3877 sv_force_normal_flags(sv, 0);
3880 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3881 sv_recode_to_utf8(sv, PL_encoding);
3882 else { /* Assume Latin-1/EBCDIC */
3883 /* This function could be much more efficient if we
3884 * had a FLAG in SVs to signal if there are any hibit
3885 * chars in the PV. Given that there isn't such a flag
3886 * make the loop as fast as possible. */
3887 U8 *s = (U8 *) SvPVX(sv);
3888 U8 *e = (U8 *) SvEND(sv);
3894 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3898 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3899 s = bytes_to_utf8((U8*)s, &len);
3901 SvPV_free(sv); /* No longer using what was there before. */
3903 SvPV_set(sv, (char*)s);
3904 SvCUR_set(sv, len - 1);
3905 SvLEN_set(sv, len); /* No longer know the real size. */
3907 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3914 =for apidoc sv_utf8_downgrade
3916 Attempts to convert the PV of an SV from characters to bytes.
3917 If the PV contains a character beyond byte, this conversion will fail;
3918 in this case, either returns false or, if C<fail_ok> is not
3921 This is not as a general purpose Unicode to byte encoding interface:
3922 use the Encode extension for that.
3928 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3930 if (SvPOKp(sv) && SvUTF8(sv)) {
3936 sv_force_normal_flags(sv, 0);
3938 s = (U8 *) SvPV(sv, len);
3939 if (!utf8_to_bytes(s, &len)) {
3944 Perl_croak(aTHX_ "Wide character in %s",
3947 Perl_croak(aTHX_ "Wide character");
3958 =for apidoc sv_utf8_encode
3960 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3961 flag off so that it looks like octets again.
3967 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3969 (void) sv_utf8_upgrade(sv);
3971 sv_force_normal_flags(sv, 0);
3973 if (SvREADONLY(sv)) {
3974 Perl_croak(aTHX_ PL_no_modify);
3980 =for apidoc sv_utf8_decode
3982 If the PV of the SV is an octet sequence in UTF-8
3983 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3984 so that it looks like a character. If the PV contains only single-byte
3985 characters, the C<SvUTF8> flag stays being off.
3986 Scans PV for validity and returns false if the PV is invalid UTF-8.
3992 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3998 /* The octets may have got themselves encoded - get them back as
4001 if (!sv_utf8_downgrade(sv, TRUE))
4004 /* it is actually just a matter of turning the utf8 flag on, but
4005 * we want to make sure everything inside is valid utf8 first.
4007 c = (U8 *) SvPVX(sv);
4008 if (!is_utf8_string(c, SvCUR(sv)+1))
4010 e = (U8 *) SvEND(sv);
4013 if (!UTF8_IS_INVARIANT(ch)) {
4022 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4023 * this function provided for binary compatibility only
4027 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4029 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4033 =for apidoc sv_setsv
4035 Copies the contents of the source SV C<ssv> into the destination SV
4036 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4037 function if the source SV needs to be reused. Does not handle 'set' magic.
4038 Loosely speaking, it performs a copy-by-value, obliterating any previous
4039 content of the destination.
4041 You probably want to use one of the assortment of wrappers, such as
4042 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4043 C<SvSetMagicSV_nosteal>.
4045 =for apidoc sv_setsv_flags
4047 Copies the contents of the source SV C<ssv> into the destination SV
4048 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4049 function if the source SV needs to be reused. Does not handle 'set' magic.
4050 Loosely speaking, it performs a copy-by-value, obliterating any previous
4051 content of the destination.
4052 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4053 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4054 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4055 and C<sv_setsv_nomg> are implemented in terms of this function.
4057 You probably want to use one of the assortment of wrappers, such as
4058 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4059 C<SvSetMagicSV_nosteal>.
4061 This is the primary function for copying scalars, and most other
4062 copy-ish functions and macros use this underneath.
4068 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4070 register U32 sflags;
4076 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4078 sstr = &PL_sv_undef;
4079 stype = SvTYPE(sstr);
4080 dtype = SvTYPE(dstr);
4085 /* need to nuke the magic */
4087 SvRMAGICAL_off(dstr);
4090 /* There's a lot of redundancy below but we're going for speed here */
4095 if (dtype != SVt_PVGV) {
4096 (void)SvOK_off(dstr);
4104 sv_upgrade(dstr, SVt_IV);
4107 sv_upgrade(dstr, SVt_PVNV);
4111 sv_upgrade(dstr, SVt_PVIV);
4114 (void)SvIOK_only(dstr);
4115 SvIV_set(dstr, SvIVX(sstr));
4118 if (SvTAINTED(sstr))
4129 sv_upgrade(dstr, SVt_NV);
4134 sv_upgrade(dstr, SVt_PVNV);
4137 SvNV_set(dstr, SvNVX(sstr));
4138 (void)SvNOK_only(dstr);
4139 if (SvTAINTED(sstr))
4147 sv_upgrade(dstr, SVt_RV);
4148 else if (dtype == SVt_PVGV &&
4149 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4152 if (GvIMPORTED(dstr) != GVf_IMPORTED
4153 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4155 GvIMPORTED_on(dstr);
4164 #ifdef PERL_COPY_ON_WRITE
4165 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4166 if (dtype < SVt_PVIV)
4167 sv_upgrade(dstr, SVt_PVIV);
4174 sv_upgrade(dstr, SVt_PV);
4177 if (dtype < SVt_PVIV)
4178 sv_upgrade(dstr, SVt_PVIV);
4181 if (dtype < SVt_PVNV)
4182 sv_upgrade(dstr, SVt_PVNV);
4189 const char * const type = sv_reftype(sstr,0);
4191 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4193 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4198 if (dtype <= SVt_PVGV) {
4200 if (dtype != SVt_PVGV) {
4201 const char * const name = GvNAME(sstr);
4202 const STRLEN len = GvNAMELEN(sstr);
4203 /* don't upgrade SVt_PVLV: it can hold a glob */
4204 if (dtype != SVt_PVLV)
4205 sv_upgrade(dstr, SVt_PVGV);
4206 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4207 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4208 GvNAME(dstr) = savepvn(name, len);
4209 GvNAMELEN(dstr) = len;
4210 SvFAKE_on(dstr); /* can coerce to non-glob */
4212 /* ahem, death to those who redefine active sort subs */
4213 else if (PL_curstackinfo->si_type == PERLSI_SORT
4214 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4215 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4218 #ifdef GV_UNIQUE_CHECK
4219 if (GvUNIQUE((GV*)dstr)) {
4220 Perl_croak(aTHX_ PL_no_modify);
4224 (void)SvOK_off(dstr);
4225 GvINTRO_off(dstr); /* one-shot flag */
4227 GvGP(dstr) = gp_ref(GvGP(sstr));
4228 if (SvTAINTED(sstr))
4230 if (GvIMPORTED(dstr) != GVf_IMPORTED
4231 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4233 GvIMPORTED_on(dstr);
4241 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4243 if ((int)SvTYPE(sstr) != stype) {
4244 stype = SvTYPE(sstr);
4245 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4249 if (stype == SVt_PVLV)
4250 (void)SvUPGRADE(dstr, SVt_PVNV);
4252 (void)SvUPGRADE(dstr, (U32)stype);
4255 sflags = SvFLAGS(sstr);
4257 if (sflags & SVf_ROK) {
4258 if (dtype >= SVt_PV) {
4259 if (dtype == SVt_PVGV) {
4260 SV *sref = SvREFCNT_inc(SvRV(sstr));
4262 const int intro = GvINTRO(dstr);
4264 #ifdef GV_UNIQUE_CHECK
4265 if (GvUNIQUE((GV*)dstr)) {
4266 Perl_croak(aTHX_ PL_no_modify);
4271 GvINTRO_off(dstr); /* one-shot flag */
4272 GvLINE(dstr) = CopLINE(PL_curcop);
4273 GvEGV(dstr) = (GV*)dstr;
4276 switch (SvTYPE(sref)) {
4279 SAVEGENERICSV(GvAV(dstr));
4281 dref = (SV*)GvAV(dstr);
4282 GvAV(dstr) = (AV*)sref;
4283 if (!GvIMPORTED_AV(dstr)
4284 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4286 GvIMPORTED_AV_on(dstr);
4291 SAVEGENERICSV(GvHV(dstr));
4293 dref = (SV*)GvHV(dstr);
4294 GvHV(dstr) = (HV*)sref;
4295 if (!GvIMPORTED_HV(dstr)
4296 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4298 GvIMPORTED_HV_on(dstr);
4303 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4304 SvREFCNT_dec(GvCV(dstr));
4305 GvCV(dstr) = Nullcv;
4306 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4307 PL_sub_generation++;
4309 SAVEGENERICSV(GvCV(dstr));
4312 dref = (SV*)GvCV(dstr);
4313 if (GvCV(dstr) != (CV*)sref) {
4314 CV* cv = GvCV(dstr);
4316 if (!GvCVGEN((GV*)dstr) &&
4317 (CvROOT(cv) || CvXSUB(cv)))
4319 /* ahem, death to those who redefine
4320 * active sort subs */
4321 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4322 PL_sortcop == CvSTART(cv))
4324 "Can't redefine active sort subroutine %s",
4325 GvENAME((GV*)dstr));
4326 /* Redefining a sub - warning is mandatory if
4327 it was a const and its value changed. */
4328 if (ckWARN(WARN_REDEFINE)
4330 && (!CvCONST((CV*)sref)
4331 || sv_cmp(cv_const_sv(cv),
4332 cv_const_sv((CV*)sref)))))
4334 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4336 ? "Constant subroutine %s::%s redefined"
4337 : "Subroutine %s::%s redefined",
4338 HvNAME_get(GvSTASH((GV*)dstr)),
4339 GvENAME((GV*)dstr));
4343 cv_ckproto(cv, (GV*)dstr,
4344 SvPOK(sref) ? SvPVX(sref) : Nullch);
4346 GvCV(dstr) = (CV*)sref;
4347 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4348 GvASSUMECV_on(dstr);
4349 PL_sub_generation++;
4351 if (!GvIMPORTED_CV(dstr)
4352 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4354 GvIMPORTED_CV_on(dstr);
4359 SAVEGENERICSV(GvIOp(dstr));
4361 dref = (SV*)GvIOp(dstr);
4362 GvIOp(dstr) = (IO*)sref;
4366 SAVEGENERICSV(GvFORM(dstr));
4368 dref = (SV*)GvFORM(dstr);
4369 GvFORM(dstr) = (CV*)sref;
4373 SAVEGENERICSV(GvSV(dstr));
4375 dref = (SV*)GvSV(dstr);
4377 if (!GvIMPORTED_SV(dstr)
4378 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4380 GvIMPORTED_SV_on(dstr);
4386 if (SvTAINTED(sstr))
4396 (void)SvOK_off(dstr);
4397 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4399 if (sflags & SVp_NOK) {
4401 /* Only set the public OK flag if the source has public OK. */
4402 if (sflags & SVf_NOK)
4403 SvFLAGS(dstr) |= SVf_NOK;
4404 SvNV_set(dstr, SvNVX(sstr));
4406 if (sflags & SVp_IOK) {
4407 (void)SvIOKp_on(dstr);
4408 if (sflags & SVf_IOK)
4409 SvFLAGS(dstr) |= SVf_IOK;
4410 if (sflags & SVf_IVisUV)
4412 SvIV_set(dstr, SvIVX(sstr));
4414 if (SvAMAGIC(sstr)) {
4418 else if (sflags & SVp_POK) {
4422 * Check to see if we can just swipe the string. If so, it's a
4423 * possible small lose on short strings, but a big win on long ones.
4424 * It might even be a win on short strings if SvPVX(dstr)
4425 * has to be allocated and SvPVX(sstr) has to be freed.
4428 /* Whichever path we take through the next code, we want this true,
4429 and doing it now facilitates the COW check. */
4430 (void)SvPOK_only(dstr);
4433 #ifdef PERL_COPY_ON_WRITE
4434 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4438 (sflags & SVs_TEMP) && /* slated for free anyway? */
4439 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4440 (!(flags & SV_NOSTEAL)) &&
4441 /* and we're allowed to steal temps */
4442 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4443 SvLEN(sstr) && /* and really is a string */
4444 /* and won't be needed again, potentially */
4445 !(PL_op && PL_op->op_type == OP_AASSIGN))
4446 #ifdef PERL_COPY_ON_WRITE
4447 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4448 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4449 && SvTYPE(sstr) >= SVt_PVIV)
4452 /* Failed the swipe test, and it's not a shared hash key either.
4453 Have to copy the string. */
4454 STRLEN len = SvCUR(sstr);
4455 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4456 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4457 SvCUR_set(dstr, len);
4458 *SvEND(dstr) = '\0';
4460 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4462 #ifdef PERL_COPY_ON_WRITE
4463 /* Either it's a shared hash key, or it's suitable for
4464 copy-on-write or we can swipe the string. */
4466 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4471 /* I believe I should acquire a global SV mutex if
4472 it's a COW sv (not a shared hash key) to stop
4473 it going un copy-on-write.
4474 If the source SV has gone un copy on write between up there
4475 and down here, then (assert() that) it is of the correct
4476 form to make it copy on write again */
4477 if ((sflags & (SVf_FAKE | SVf_READONLY))
4478 != (SVf_FAKE | SVf_READONLY)) {
4479 SvREADONLY_on(sstr);
4481 /* Make the source SV into a loop of 1.
4482 (about to become 2) */
4483 SV_COW_NEXT_SV_SET(sstr, sstr);
4487 /* Initial code is common. */
4488 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4490 SvFLAGS(dstr) &= ~SVf_OOK;
4491 Safefree(SvPVX(dstr) - SvIVX(dstr));
4493 else if (SvLEN(dstr))
4494 Safefree(SvPVX(dstr));
4497 #ifdef PERL_COPY_ON_WRITE
4499 /* making another shared SV. */
4500 STRLEN cur = SvCUR(sstr);
4501 STRLEN len = SvLEN(sstr);
4502 assert (SvTYPE(dstr) >= SVt_PVIV);
4504 /* SvIsCOW_normal */
4505 /* splice us in between source and next-after-source. */
4506 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4507 SV_COW_NEXT_SV_SET(sstr, dstr);
4508 SvPV_set(dstr, SvPVX(sstr));
4510 /* SvIsCOW_shared_hash */
4511 UV hash = SvUVX(sstr);
4512 DEBUG_C(PerlIO_printf(Perl_debug_log,
4513 "Copy on write: Sharing hash\n"));
4515 sharepvn(SvPVX(sstr),
4516 (sflags & SVf_UTF8?-cur:cur), hash));
4517 SvUV_set(dstr, hash);
4519 SvLEN_set(dstr, len);
4520 SvCUR_set(dstr, cur);
4521 SvREADONLY_on(dstr);
4523 /* Relesase a global SV mutex. */
4527 { /* Passes the swipe test. */
4528 SvPV_set(dstr, SvPVX(sstr));
4529 SvLEN_set(dstr, SvLEN(sstr));
4530 SvCUR_set(dstr, SvCUR(sstr));
4533 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4534 SvPV_set(sstr, Nullch);
4540 if (sflags & SVf_UTF8)
4543 if (sflags & SVp_NOK) {
4545 if (sflags & SVf_NOK)
4546 SvFLAGS(dstr) |= SVf_NOK;
4547 SvNV_set(dstr, SvNVX(sstr));
4549 if (sflags & SVp_IOK) {
4550 (void)SvIOKp_on(dstr);
4551 if (sflags & SVf_IOK)
4552 SvFLAGS(dstr) |= SVf_IOK;
4553 if (sflags & SVf_IVisUV)
4555 SvIV_set(dstr, SvIVX(sstr));
4558 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4559 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4560 smg->mg_ptr, smg->mg_len);
4561 SvRMAGICAL_on(dstr);
4564 else if (sflags & SVp_IOK) {
4565 if (sflags & SVf_IOK)
4566 (void)SvIOK_only(dstr);
4568 (void)SvOK_off(dstr);
4569 (void)SvIOKp_on(dstr);
4571 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4572 if (sflags & SVf_IVisUV)
4574 SvIV_set(dstr, SvIVX(sstr));
4575 if (sflags & SVp_NOK) {
4576 if (sflags & SVf_NOK)
4577 (void)SvNOK_on(dstr);
4579 (void)SvNOKp_on(dstr);
4580 SvNV_set(dstr, SvNVX(sstr));
4583 else if (sflags & SVp_NOK) {
4584 if (sflags & SVf_NOK)
4585 (void)SvNOK_only(dstr);
4587 (void)SvOK_off(dstr);
4590 SvNV_set(dstr, SvNVX(sstr));
4593 if (dtype == SVt_PVGV) {
4594 if (ckWARN(WARN_MISC))
4595 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4598 (void)SvOK_off(dstr);
4600 if (SvTAINTED(sstr))
4605 =for apidoc sv_setsv_mg
4607 Like C<sv_setsv>, but also handles 'set' magic.
4613 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4615 sv_setsv(dstr,sstr);
4619 #ifdef PERL_COPY_ON_WRITE
4621 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4623 STRLEN cur = SvCUR(sstr);
4624 STRLEN len = SvLEN(sstr);
4625 register char *new_pv;
4628 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4636 if (SvTHINKFIRST(dstr))
4637 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4638 else if (SvPVX(dstr))
4639 Safefree(SvPVX(dstr));
4643 (void)SvUPGRADE (dstr, SVt_PVIV);
4645 assert (SvPOK(sstr));
4646 assert (SvPOKp(sstr));
4647 assert (!SvIOK(sstr));
4648 assert (!SvIOKp(sstr));
4649 assert (!SvNOK(sstr));
4650 assert (!SvNOKp(sstr));
4652 if (SvIsCOW(sstr)) {
4654 if (SvLEN(sstr) == 0) {
4655 /* source is a COW shared hash key. */
4656 UV hash = SvUVX(sstr);
4657 DEBUG_C(PerlIO_printf(Perl_debug_log,
4658 "Fast copy on write: Sharing hash\n"));
4659 SvUV_set(dstr, hash);
4660 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4663 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4665 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4666 (void)SvUPGRADE (sstr, SVt_PVIV);
4667 SvREADONLY_on(sstr);
4669 DEBUG_C(PerlIO_printf(Perl_debug_log,
4670 "Fast copy on write: Converting sstr to COW\n"));
4671 SV_COW_NEXT_SV_SET(dstr, sstr);
4673 SV_COW_NEXT_SV_SET(sstr, dstr);
4674 new_pv = SvPVX(sstr);
4677 SvPV_set(dstr, new_pv);
4678 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4681 SvLEN_set(dstr, len);
4682 SvCUR_set(dstr, cur);
4691 =for apidoc sv_setpvn
4693 Copies a string into an SV. The C<len> parameter indicates the number of
4694 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4695 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4701 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4703 register char *dptr;
4705 SV_CHECK_THINKFIRST_COW_DROP(sv);
4711 /* len is STRLEN which is unsigned, need to copy to signed */
4714 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4716 (void)SvUPGRADE(sv, SVt_PV);
4718 SvGROW(sv, len + 1);
4720 Move(ptr,dptr,len,char);
4723 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4728 =for apidoc sv_setpvn_mg
4730 Like C<sv_setpvn>, but also handles 'set' magic.
4736 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4738 sv_setpvn(sv,ptr,len);
4743 =for apidoc sv_setpv
4745 Copies a string into an SV. The string must be null-terminated. Does not
4746 handle 'set' magic. See C<sv_setpv_mg>.
4752 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4754 register STRLEN len;
4756 SV_CHECK_THINKFIRST_COW_DROP(sv);
4762 (void)SvUPGRADE(sv, SVt_PV);
4764 SvGROW(sv, len + 1);
4765 Move(ptr,SvPVX(sv),len+1,char);
4767 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4772 =for apidoc sv_setpv_mg
4774 Like C<sv_setpv>, but also handles 'set' magic.
4780 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4787 =for apidoc sv_usepvn
4789 Tells an SV to use C<ptr> to find its string value. Normally the string is
4790 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4791 The C<ptr> should point to memory that was allocated by C<malloc>. The
4792 string length, C<len>, must be supplied. This function will realloc the
4793 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4794 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4795 See C<sv_usepvn_mg>.
4801 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4803 SV_CHECK_THINKFIRST_COW_DROP(sv);
4804 (void)SvUPGRADE(sv, SVt_PV);
4811 Renew(ptr, len+1, char);
4814 SvLEN_set(sv, len+1);
4816 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4821 =for apidoc sv_usepvn_mg
4823 Like C<sv_usepvn>, but also handles 'set' magic.
4829 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4831 sv_usepvn(sv,ptr,len);
4835 #ifdef PERL_COPY_ON_WRITE
4836 /* Need to do this *after* making the SV normal, as we need the buffer
4837 pointer to remain valid until after we've copied it. If we let go too early,
4838 another thread could invalidate it by unsharing last of the same hash key
4839 (which it can do by means other than releasing copy-on-write Svs)
4840 or by changing the other copy-on-write SVs in the loop. */
4842 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4843 U32 hash, SV *after)
4845 if (len) { /* this SV was SvIsCOW_normal(sv) */
4846 /* we need to find the SV pointing to us. */
4847 SV *current = SV_COW_NEXT_SV(after);
4849 if (current == sv) {
4850 /* The SV we point to points back to us (there were only two of us
4852 Hence other SV is no longer copy on write either. */
4854 SvREADONLY_off(after);
4856 /* We need to follow the pointers around the loop. */
4858 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4861 /* don't loop forever if the structure is bust, and we have
4862 a pointer into a closed loop. */
4863 assert (current != after);
4864 assert (SvPVX(current) == pvx);
4866 /* Make the SV before us point to the SV after us. */
4867 SV_COW_NEXT_SV_SET(current, after);
4870 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4875 Perl_sv_release_IVX(pTHX_ register SV *sv)
4878 sv_force_normal_flags(sv, 0);
4884 =for apidoc sv_force_normal_flags
4886 Undo various types of fakery on an SV: if the PV is a shared string, make
4887 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4888 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4889 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4890 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4891 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4892 set to some other value.) In addition, the C<flags> parameter gets passed to
4893 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4894 with flags set to 0.
4900 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4902 #ifdef PERL_COPY_ON_WRITE
4903 if (SvREADONLY(sv)) {
4904 /* At this point I believe I should acquire a global SV mutex. */
4906 char *pvx = SvPVX(sv);
4907 STRLEN len = SvLEN(sv);
4908 STRLEN cur = SvCUR(sv);
4909 U32 hash = SvUVX(sv);
4910 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4912 PerlIO_printf(Perl_debug_log,
4913 "Copy on write: Force normal %ld\n",
4919 /* This SV doesn't own the buffer, so need to New() a new one: */
4920 SvPV_set(sv, (char*)0);
4922 if (flags & SV_COW_DROP_PV) {
4923 /* OK, so we don't need to copy our buffer. */
4926 SvGROW(sv, cur + 1);
4927 Move(pvx,SvPVX(sv),cur,char);
4931 sv_release_COW(sv, pvx, cur, len, hash, next);
4936 else if (IN_PERL_RUNTIME)
4937 Perl_croak(aTHX_ PL_no_modify);
4938 /* At this point I believe that I can drop the global SV mutex. */
4941 if (SvREADONLY(sv)) {
4943 char *pvx = SvPVX(sv);
4944 int is_utf8 = SvUTF8(sv);
4945 STRLEN len = SvCUR(sv);
4946 U32 hash = SvUVX(sv);
4949 SvPV_set(sv, (char*)0);
4951 SvGROW(sv, len + 1);
4952 Move(pvx,SvPVX(sv),len,char);
4954 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4956 else if (IN_PERL_RUNTIME)
4957 Perl_croak(aTHX_ PL_no_modify);
4961 sv_unref_flags(sv, flags);
4962 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4967 =for apidoc sv_force_normal
4969 Undo various types of fakery on an SV: if the PV is a shared string, make
4970 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4971 an xpvmg. See also C<sv_force_normal_flags>.
4977 Perl_sv_force_normal(pTHX_ register SV *sv)
4979 sv_force_normal_flags(sv, 0);
4985 Efficient removal of characters from the beginning of the string buffer.
4986 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4987 the string buffer. The C<ptr> becomes the first character of the adjusted
4988 string. Uses the "OOK hack".
4989 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4990 refer to the same chunk of data.
4996 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4998 register STRLEN delta;
4999 if (!ptr || !SvPOKp(sv))
5001 delta = ptr - SvPVX(sv);
5002 SV_CHECK_THINKFIRST(sv);
5003 if (SvTYPE(sv) < SVt_PVIV)
5004 sv_upgrade(sv,SVt_PVIV);
5007 if (!SvLEN(sv)) { /* make copy of shared string */
5008 const char *pvx = SvPVX(sv);
5009 STRLEN len = SvCUR(sv);
5010 SvGROW(sv, len + 1);
5011 Move(pvx,SvPVX(sv),len,char);
5015 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5016 and we do that anyway inside the SvNIOK_off
5018 SvFLAGS(sv) |= SVf_OOK;
5021 SvLEN_set(sv, SvLEN(sv) - delta);
5022 SvCUR_set(sv, SvCUR(sv) - delta);
5023 SvPV_set(sv, SvPVX(sv) + delta);
5024 SvIV_set(sv, SvIVX(sv) + delta);
5027 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5028 * this function provided for binary compatibility only
5032 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5034 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5038 =for apidoc sv_catpvn
5040 Concatenates the string onto the end of the string which is in the SV. The
5041 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5042 status set, then the bytes appended should be valid UTF-8.
5043 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5045 =for apidoc sv_catpvn_flags
5047 Concatenates the string onto the end of the string which is in the SV. The
5048 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5049 status set, then the bytes appended should be valid UTF-8.
5050 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5051 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5052 in terms of this function.
5058 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5061 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5063 SvGROW(dsv, dlen + slen + 1);
5066 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5067 SvCUR_set(dsv, SvCUR(dsv) + slen);
5069 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5074 =for apidoc sv_catpvn_mg
5076 Like C<sv_catpvn>, but also handles 'set' magic.
5082 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5084 sv_catpvn(sv,ptr,len);
5088 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5089 * this function provided for binary compatibility only
5093 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5095 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5099 =for apidoc sv_catsv
5101 Concatenates the string from SV C<ssv> onto the end of the string in
5102 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5103 not 'set' magic. See C<sv_catsv_mg>.
5105 =for apidoc sv_catsv_flags
5107 Concatenates the string from SV C<ssv> onto the end of the string in
5108 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5109 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5110 and C<sv_catsv_nomg> are implemented in terms of this function.
5115 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5121 if ((spv = SvPV(ssv, slen))) {
5122 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5123 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5124 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5125 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5126 dsv->sv_flags doesn't have that bit set.
5127 Andy Dougherty 12 Oct 2001
5129 I32 sutf8 = DO_UTF8(ssv);
5132 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5134 dutf8 = DO_UTF8(dsv);
5136 if (dutf8 != sutf8) {
5138 /* Not modifying source SV, so taking a temporary copy. */
5139 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5141 sv_utf8_upgrade(csv);
5142 spv = SvPV(csv, slen);
5145 sv_utf8_upgrade_nomg(dsv);
5147 sv_catpvn_nomg(dsv, spv, slen);
5152 =for apidoc sv_catsv_mg
5154 Like C<sv_catsv>, but also handles 'set' magic.
5160 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5167 =for apidoc sv_catpv
5169 Concatenates the string onto the end of the string which is in the SV.
5170 If the SV has the UTF-8 status set, then the bytes appended should be
5171 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5176 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5178 register STRLEN len;
5184 junk = SvPV_force(sv, tlen);
5186 SvGROW(sv, tlen + len + 1);
5189 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5190 SvCUR_set(sv, SvCUR(sv) + len);
5191 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5196 =for apidoc sv_catpv_mg
5198 Like C<sv_catpv>, but also handles 'set' magic.
5204 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5213 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5214 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5221 Perl_newSV(pTHX_ STRLEN len)
5227 sv_upgrade(sv, SVt_PV);
5228 SvGROW(sv, len + 1);
5233 =for apidoc sv_magicext
5235 Adds magic to an SV, upgrading it if necessary. Applies the
5236 supplied vtable and returns a pointer to the magic added.
5238 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5239 In particular, you can add magic to SvREADONLY SVs, and add more than
5240 one instance of the same 'how'.
5242 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5243 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5244 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5245 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5247 (This is now used as a subroutine by C<sv_magic>.)
5252 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5253 const char* name, I32 namlen)
5257 if (SvTYPE(sv) < SVt_PVMG) {
5258 (void)SvUPGRADE(sv, SVt_PVMG);
5260 Newz(702,mg, 1, MAGIC);
5261 mg->mg_moremagic = SvMAGIC(sv);
5262 SvMAGIC_set(sv, mg);
5264 /* Sometimes a magic contains a reference loop, where the sv and
5265 object refer to each other. To prevent a reference loop that
5266 would prevent such objects being freed, we look for such loops
5267 and if we find one we avoid incrementing the object refcount.
5269 Note we cannot do this to avoid self-tie loops as intervening RV must
5270 have its REFCNT incremented to keep it in existence.
5273 if (!obj || obj == sv ||
5274 how == PERL_MAGIC_arylen ||
5275 how == PERL_MAGIC_qr ||
5276 how == PERL_MAGIC_symtab ||
5277 (SvTYPE(obj) == SVt_PVGV &&
5278 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5279 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5280 GvFORM(obj) == (CV*)sv)))
5285 mg->mg_obj = SvREFCNT_inc(obj);
5286 mg->mg_flags |= MGf_REFCOUNTED;
5289 /* Normal self-ties simply pass a null object, and instead of
5290 using mg_obj directly, use the SvTIED_obj macro to produce a
5291 new RV as needed. For glob "self-ties", we are tieing the PVIO
5292 with an RV obj pointing to the glob containing the PVIO. In
5293 this case, to avoid a reference loop, we need to weaken the
5297 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5298 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5304 mg->mg_len = namlen;
5307 mg->mg_ptr = savepvn(name, namlen);
5308 else if (namlen == HEf_SVKEY)
5309 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5311 mg->mg_ptr = (char *) name;
5313 mg->mg_virtual = vtable;
5317 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5322 =for apidoc sv_magic
5324 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5325 then adds a new magic item of type C<how> to the head of the magic list.
5327 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5328 handling of the C<name> and C<namlen> arguments.
5330 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5331 to add more than one instance of the same 'how'.
5337 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5339 const MGVTBL *vtable = 0;
5342 #ifdef PERL_COPY_ON_WRITE
5344 sv_force_normal_flags(sv, 0);
5346 if (SvREADONLY(sv)) {
5348 && how != PERL_MAGIC_regex_global
5349 && how != PERL_MAGIC_bm
5350 && how != PERL_MAGIC_fm
5351 && how != PERL_MAGIC_sv
5352 && how != PERL_MAGIC_backref
5355 Perl_croak(aTHX_ PL_no_modify);
5358 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5359 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5360 /* sv_magic() refuses to add a magic of the same 'how' as an
5363 if (how == PERL_MAGIC_taint)
5371 vtable = &PL_vtbl_sv;
5373 case PERL_MAGIC_overload:
5374 vtable = &PL_vtbl_amagic;
5376 case PERL_MAGIC_overload_elem:
5377 vtable = &PL_vtbl_amagicelem;
5379 case PERL_MAGIC_overload_table:
5380 vtable = &PL_vtbl_ovrld;
5383 vtable = &PL_vtbl_bm;
5385 case PERL_MAGIC_regdata:
5386 vtable = &PL_vtbl_regdata;
5388 case PERL_MAGIC_regdatum:
5389 vtable = &PL_vtbl_regdatum;
5391 case PERL_MAGIC_env:
5392 vtable = &PL_vtbl_env;
5395 vtable = &PL_vtbl_fm;
5397 case PERL_MAGIC_envelem:
5398 vtable = &PL_vtbl_envelem;
5400 case PERL_MAGIC_regex_global:
5401 vtable = &PL_vtbl_mglob;
5403 case PERL_MAGIC_isa:
5404 vtable = &PL_vtbl_isa;
5406 case PERL_MAGIC_isaelem:
5407 vtable = &PL_vtbl_isaelem;
5409 case PERL_MAGIC_nkeys:
5410 vtable = &PL_vtbl_nkeys;
5412 case PERL_MAGIC_dbfile:
5415 case PERL_MAGIC_dbline:
5416 vtable = &PL_vtbl_dbline;
5418 #ifdef USE_LOCALE_COLLATE
5419 case PERL_MAGIC_collxfrm:
5420 vtable = &PL_vtbl_collxfrm;
5422 #endif /* USE_LOCALE_COLLATE */
5423 case PERL_MAGIC_tied:
5424 vtable = &PL_vtbl_pack;
5426 case PERL_MAGIC_tiedelem:
5427 case PERL_MAGIC_tiedscalar:
5428 vtable = &PL_vtbl_packelem;
5431 vtable = &PL_vtbl_regexp;
5433 case PERL_MAGIC_sig:
5434 vtable = &PL_vtbl_sig;
5436 case PERL_MAGIC_sigelem:
5437 vtable = &PL_vtbl_sigelem;
5439 case PERL_MAGIC_taint:
5440 vtable = &PL_vtbl_taint;
5442 case PERL_MAGIC_uvar:
5443 vtable = &PL_vtbl_uvar;
5445 case PERL_MAGIC_vec:
5446 vtable = &PL_vtbl_vec;
5448 case PERL_MAGIC_rhash:
5449 case PERL_MAGIC_symtab:
5450 case PERL_MAGIC_vstring:
5453 case PERL_MAGIC_utf8:
5454 vtable = &PL_vtbl_utf8;
5456 case PERL_MAGIC_substr:
5457 vtable = &PL_vtbl_substr;
5459 case PERL_MAGIC_defelem:
5460 vtable = &PL_vtbl_defelem;
5462 case PERL_MAGIC_glob:
5463 vtable = &PL_vtbl_glob;
5465 case PERL_MAGIC_arylen:
5466 vtable = &PL_vtbl_arylen;
5468 case PERL_MAGIC_pos:
5469 vtable = &PL_vtbl_pos;
5471 case PERL_MAGIC_backref:
5472 vtable = &PL_vtbl_backref;
5474 case PERL_MAGIC_ext:
5475 /* Reserved for use by extensions not perl internals. */
5476 /* Useful for attaching extension internal data to perl vars. */
5477 /* Note that multiple extensions may clash if magical scalars */
5478 /* etc holding private data from one are passed to another. */
5481 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5484 /* Rest of work is done else where */
5485 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5488 case PERL_MAGIC_taint:
5491 case PERL_MAGIC_ext:
5492 case PERL_MAGIC_dbfile:
5499 =for apidoc sv_unmagic
5501 Removes all magic of type C<type> from an SV.
5507 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5511 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5514 for (mg = *mgp; mg; mg = *mgp) {
5515 if (mg->mg_type == type) {
5516 const MGVTBL* const vtbl = mg->mg_virtual;
5517 *mgp = mg->mg_moremagic;
5518 if (vtbl && vtbl->svt_free)
5519 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5520 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5522 Safefree(mg->mg_ptr);
5523 else if (mg->mg_len == HEf_SVKEY)
5524 SvREFCNT_dec((SV*)mg->mg_ptr);
5525 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5526 Safefree(mg->mg_ptr);
5528 if (mg->mg_flags & MGf_REFCOUNTED)
5529 SvREFCNT_dec(mg->mg_obj);
5533 mgp = &mg->mg_moremagic;
5537 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5544 =for apidoc sv_rvweaken
5546 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5547 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5548 push a back-reference to this RV onto the array of backreferences
5549 associated with that magic.
5555 Perl_sv_rvweaken(pTHX_ SV *sv)
5558 if (!SvOK(sv)) /* let undefs pass */
5561 Perl_croak(aTHX_ "Can't weaken a nonreference");
5562 else if (SvWEAKREF(sv)) {
5563 if (ckWARN(WARN_MISC))
5564 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5568 sv_add_backref(tsv, sv);
5574 /* Give tsv backref magic if it hasn't already got it, then push a
5575 * back-reference to sv onto the array associated with the backref magic.
5579 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5583 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5584 av = (AV*)mg->mg_obj;
5587 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5588 /* av now has a refcnt of 2, which avoids it getting freed
5589 * before us during global cleanup. The extra ref is removed
5590 * by magic_killbackrefs() when tsv is being freed */
5592 if (AvFILLp(av) >= AvMAX(av)) {
5594 SV **svp = AvARRAY(av);
5595 for (i = AvFILLp(av); i >= 0; i--)
5597 svp[i] = sv; /* reuse the slot */
5600 av_extend(av, AvFILLp(av)+1);
5602 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5605 /* delete a back-reference to ourselves from the backref magic associated
5606 * with the SV we point to.
5610 S_sv_del_backref(pTHX_ SV *sv)
5617 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5618 Perl_croak(aTHX_ "panic: del_backref");
5619 av = (AV *)mg->mg_obj;
5621 for (i = AvFILLp(av); i >= 0; i--)
5622 if (svp[i] == sv) svp[i] = Nullsv;
5626 =for apidoc sv_insert
5628 Inserts a string at the specified offset/length within the SV. Similar to
5629 the Perl substr() function.
5635 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5639 register char *midend;
5640 register char *bigend;
5646 Perl_croak(aTHX_ "Can't modify non-existent substring");
5647 SvPV_force(bigstr, curlen);
5648 (void)SvPOK_only_UTF8(bigstr);
5649 if (offset + len > curlen) {
5650 SvGROW(bigstr, offset+len+1);
5651 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5652 SvCUR_set(bigstr, offset+len);
5656 i = littlelen - len;
5657 if (i > 0) { /* string might grow */
5658 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5659 mid = big + offset + len;
5660 midend = bigend = big + SvCUR(bigstr);
5663 while (midend > mid) /* shove everything down */
5664 *--bigend = *--midend;
5665 Move(little,big+offset,littlelen,char);
5666 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5671 Move(little,SvPVX(bigstr)+offset,len,char);
5676 big = SvPVX(bigstr);
5679 bigend = big + SvCUR(bigstr);
5681 if (midend > bigend)
5682 Perl_croak(aTHX_ "panic: sv_insert");
5684 if (mid - big > bigend - midend) { /* faster to shorten from end */
5686 Move(little, mid, littlelen,char);
5689 i = bigend - midend;
5691 Move(midend, mid, i,char);
5695 SvCUR_set(bigstr, mid - big);
5698 else if ((i = mid - big)) { /* faster from front */
5699 midend -= littlelen;
5701 sv_chop(bigstr,midend-i);
5706 Move(little, mid, littlelen,char);
5708 else if (littlelen) {
5709 midend -= littlelen;
5710 sv_chop(bigstr,midend);
5711 Move(little,midend,littlelen,char);
5714 sv_chop(bigstr,midend);
5720 =for apidoc sv_replace
5722 Make the first argument a copy of the second, then delete the original.
5723 The target SV physically takes over ownership of the body of the source SV
5724 and inherits its flags; however, the target keeps any magic it owns,
5725 and any magic in the source is discarded.
5726 Note that this is a rather specialist SV copying operation; most of the
5727 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5733 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5735 const U32 refcnt = SvREFCNT(sv);
5736 SV_CHECK_THINKFIRST_COW_DROP(sv);
5737 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5738 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5739 if (SvMAGICAL(sv)) {
5743 sv_upgrade(nsv, SVt_PVMG);
5744 SvMAGIC_set(nsv, SvMAGIC(sv));
5745 SvFLAGS(nsv) |= SvMAGICAL(sv);
5747 SvMAGIC_set(sv, NULL);
5751 assert(!SvREFCNT(sv));
5752 #ifdef DEBUG_LEAKING_SCALARS
5753 sv->sv_flags = nsv->sv_flags;
5754 sv->sv_any = nsv->sv_any;
5755 sv->sv_refcnt = nsv->sv_refcnt;
5757 StructCopy(nsv,sv,SV);
5759 /* Currently could join these into one piece of pointer arithmetic, but
5760 it would be unclear. */
5761 if(SvTYPE(sv) == SVt_IV)
5763 = (XPVIV*)((char*)&(sv->sv_u.sv_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5764 else if (SvTYPE(sv) == SVt_RV) {
5765 SvANY(sv) = &sv->sv_u.sv_rv;
5769 #ifdef PERL_COPY_ON_WRITE
5770 if (SvIsCOW_normal(nsv)) {
5771 /* We need to follow the pointers around the loop to make the
5772 previous SV point to sv, rather than nsv. */
5775 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5778 assert(SvPVX(current) == SvPVX(nsv));
5780 /* Make the SV before us point to the SV after us. */
5782 PerlIO_printf(Perl_debug_log, "previous is\n");
5784 PerlIO_printf(Perl_debug_log,
5785 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5786 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5788 SV_COW_NEXT_SV_SET(current, sv);
5791 SvREFCNT(sv) = refcnt;
5792 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5798 =for apidoc sv_clear
5800 Clear an SV: call any destructors, free up any memory used by the body,
5801 and free the body itself. The SV's head is I<not> freed, although
5802 its type is set to all 1's so that it won't inadvertently be assumed
5803 to be live during global destruction etc.
5804 This function should only be called when REFCNT is zero. Most of the time
5805 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5812 Perl_sv_clear(pTHX_ register SV *sv)
5817 assert(SvREFCNT(sv) == 0);
5820 if (PL_defstash) { /* Still have a symbol table? */
5827 stash = SvSTASH(sv);
5828 destructor = StashHANDLER(stash,DESTROY);
5830 SV* tmpref = newRV(sv);
5831 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5833 PUSHSTACKi(PERLSI_DESTROY);
5838 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5844 if(SvREFCNT(tmpref) < 2) {
5845 /* tmpref is not kept alive! */
5847 SvRV_set(tmpref, NULL);
5850 SvREFCNT_dec(tmpref);
5852 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5856 if (PL_in_clean_objs)
5857 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5859 /* DESTROY gave object new lease on life */
5865 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5866 SvOBJECT_off(sv); /* Curse the object. */
5867 if (SvTYPE(sv) != SVt_PVIO)
5868 --PL_sv_objcount; /* XXX Might want something more general */
5871 if (SvTYPE(sv) >= SVt_PVMG) {
5874 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5875 SvREFCNT_dec(SvSTASH(sv));
5878 switch (SvTYPE(sv)) {
5881 IoIFP(sv) != PerlIO_stdin() &&
5882 IoIFP(sv) != PerlIO_stdout() &&
5883 IoIFP(sv) != PerlIO_stderr())
5885 io_close((IO*)sv, FALSE);
5887 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5888 PerlDir_close(IoDIRP(sv));
5889 IoDIRP(sv) = (DIR*)NULL;
5890 Safefree(IoTOP_NAME(sv));
5891 Safefree(IoFMT_NAME(sv));
5892 Safefree(IoBOTTOM_NAME(sv));
5907 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5908 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5909 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5910 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5912 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5913 SvREFCNT_dec(LvTARG(sv));
5917 Safefree(GvNAME(sv));
5918 /* cannot decrease stash refcount yet, as we might recursively delete
5919 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5920 of stash until current sv is completely gone.
5921 -- JohnPC, 27 Mar 1998 */
5922 stash = GvSTASH(sv);
5928 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5930 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5931 /* Don't even bother with turning off the OOK flag. */
5940 SvREFCNT_dec(SvRV(sv));
5942 #ifdef PERL_COPY_ON_WRITE
5943 else if (SvPVX(sv)) {
5945 /* I believe I need to grab the global SV mutex here and
5946 then recheck the COW status. */
5948 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5951 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5952 SvUVX(sv), SV_COW_NEXT_SV(sv));
5953 /* And drop it here. */
5955 } else if (SvLEN(sv)) {
5956 Safefree(SvPVX(sv));
5960 else if (SvPVX(sv) && SvLEN(sv))
5961 Safefree(SvPVX(sv));
5962 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5963 unsharepvn(SvPVX(sv),
5964 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5978 switch (SvTYPE(sv)) {
5992 del_XPVIV(SvANY(sv));
5995 del_XPVNV(SvANY(sv));
5998 del_XPVMG(SvANY(sv));
6001 del_XPVLV(SvANY(sv));
6004 del_XPVAV(SvANY(sv));
6007 del_XPVHV(SvANY(sv));
6010 del_XPVCV(SvANY(sv));
6013 del_XPVGV(SvANY(sv));
6014 /* code duplication for increased performance. */
6015 SvFLAGS(sv) &= SVf_BREAK;
6016 SvFLAGS(sv) |= SVTYPEMASK;
6017 /* decrease refcount of the stash that owns this GV, if any */
6019 SvREFCNT_dec(stash);
6020 return; /* not break, SvFLAGS reset already happened */
6022 del_XPVBM(SvANY(sv));
6025 del_XPVFM(SvANY(sv));
6028 del_XPVIO(SvANY(sv));
6031 SvFLAGS(sv) &= SVf_BREAK;
6032 SvFLAGS(sv) |= SVTYPEMASK;
6036 =for apidoc sv_newref
6038 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6045 Perl_sv_newref(pTHX_ SV *sv)
6055 Decrement an SV's reference count, and if it drops to zero, call
6056 C<sv_clear> to invoke destructors and free up any memory used by
6057 the body; finally, deallocate the SV's head itself.
6058 Normally called via a wrapper macro C<SvREFCNT_dec>.
6064 Perl_sv_free(pTHX_ SV *sv)
6069 if (SvREFCNT(sv) == 0) {
6070 if (SvFLAGS(sv) & SVf_BREAK)
6071 /* this SV's refcnt has been artificially decremented to
6072 * trigger cleanup */
6074 if (PL_in_clean_all) /* All is fair */
6076 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6077 /* make sure SvREFCNT(sv)==0 happens very seldom */
6078 SvREFCNT(sv) = (~(U32)0)/2;
6081 if (ckWARN_d(WARN_INTERNAL))
6082 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6083 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6084 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6087 if (--(SvREFCNT(sv)) > 0)
6089 Perl_sv_free2(aTHX_ sv);
6093 Perl_sv_free2(pTHX_ SV *sv)
6098 if (ckWARN_d(WARN_DEBUGGING))
6099 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6100 "Attempt to free temp prematurely: SV 0x%"UVxf
6101 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6105 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6106 /* make sure SvREFCNT(sv)==0 happens very seldom */
6107 SvREFCNT(sv) = (~(U32)0)/2;
6118 Returns the length of the string in the SV. Handles magic and type
6119 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6125 Perl_sv_len(pTHX_ register SV *sv)
6133 len = mg_length(sv);
6135 (void)SvPV(sv, len);
6140 =for apidoc sv_len_utf8
6142 Returns the number of characters in the string in an SV, counting wide
6143 UTF-8 bytes as a single character. Handles magic and type coercion.
6149 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6150 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6151 * (Note that the mg_len is not the length of the mg_ptr field.)
6156 Perl_sv_len_utf8(pTHX_ register SV *sv)
6162 return mg_length(sv);
6166 const U8 *s = (U8*)SvPV(sv, len);
6167 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6169 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6171 #ifdef PERL_UTF8_CACHE_ASSERT
6172 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6176 ulen = Perl_utf8_length(aTHX_ s, s + len);
6177 if (!mg && !SvREADONLY(sv)) {
6178 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6179 mg = mg_find(sv, PERL_MAGIC_utf8);
6189 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6190 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6191 * between UTF-8 and byte offsets. There are two (substr offset and substr
6192 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6193 * and byte offset) cache positions.
6195 * The mg_len field is used by sv_len_utf8(), see its comments.
6196 * Note that the mg_len is not the length of the mg_ptr field.
6200 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
6204 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6206 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6210 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6212 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6213 (*mgp)->mg_ptr = (char *) *cachep;
6217 (*cachep)[i] = offsetp;
6218 (*cachep)[i+1] = s - start;
6226 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6227 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6228 * between UTF-8 and byte offsets. See also the comments of
6229 * S_utf8_mg_pos_init().
6233 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6237 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6239 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6240 if (*mgp && (*mgp)->mg_ptr) {
6241 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6242 ASSERT_UTF8_CACHE(*cachep);
6243 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6245 else { /* We will skip to the right spot. */
6250 /* The assumption is that going backward is half
6251 * the speed of going forward (that's where the
6252 * 2 * backw in the below comes from). (The real
6253 * figure of course depends on the UTF-8 data.) */
6255 if ((*cachep)[i] > (STRLEN)uoff) {
6257 backw = (*cachep)[i] - (STRLEN)uoff;
6259 if (forw < 2 * backw)
6262 p = start + (*cachep)[i+1];
6264 /* Try this only for the substr offset (i == 0),
6265 * not for the substr length (i == 2). */
6266 else if (i == 0) { /* (*cachep)[i] < uoff */
6267 const STRLEN ulen = sv_len_utf8(sv);
6269 if ((STRLEN)uoff < ulen) {
6270 forw = (STRLEN)uoff - (*cachep)[i];
6271 backw = ulen - (STRLEN)uoff;
6273 if (forw < 2 * backw)
6274 p = start + (*cachep)[i+1];
6279 /* If the string is not long enough for uoff,
6280 * we could extend it, but not at this low a level. */
6284 if (forw < 2 * backw) {
6291 while (UTF8_IS_CONTINUATION(*p))
6296 /* Update the cache. */
6297 (*cachep)[i] = (STRLEN)uoff;
6298 (*cachep)[i+1] = p - start;
6300 /* Drop the stale "length" cache */
6309 if (found) { /* Setup the return values. */
6310 *offsetp = (*cachep)[i+1];
6311 *sp = start + *offsetp;
6314 *offsetp = send - start;
6316 else if (*sp < start) {
6322 #ifdef PERL_UTF8_CACHE_ASSERT
6327 while (n-- && s < send)
6331 assert(*offsetp == s - start);
6332 assert((*cachep)[0] == (STRLEN)uoff);
6333 assert((*cachep)[1] == *offsetp);
6335 ASSERT_UTF8_CACHE(*cachep);
6344 =for apidoc sv_pos_u2b
6346 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6347 the start of the string, to a count of the equivalent number of bytes; if
6348 lenp is non-zero, it does the same to lenp, but this time starting from
6349 the offset, rather than from the start of the string. Handles magic and
6356 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6357 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6358 * byte offsets. See also the comments of S_utf8_mg_pos().
6363 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6374 start = s = (U8*)SvPV(sv, len);
6376 I32 uoffset = *offsetp;
6381 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6383 if (!found && uoffset > 0) {
6384 while (s < send && uoffset--)
6388 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6390 *offsetp = s - start;
6395 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6399 if (!found && *lenp > 0) {
6402 while (s < send && ulen--)
6406 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6410 ASSERT_UTF8_CACHE(cache);
6422 =for apidoc sv_pos_b2u
6424 Converts the value pointed to by offsetp from a count of bytes from the
6425 start of the string, to a count of the equivalent number of UTF-8 chars.
6426 Handles magic and type coercion.
6432 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6433 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6434 * byte offsets. See also the comments of S_utf8_mg_pos().
6439 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6447 s = (U8*)SvPV(sv, len);
6448 if ((I32)len < *offsetp)
6449 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6451 U8* send = s + *offsetp;
6453 STRLEN *cache = NULL;
6457 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6458 mg = mg_find(sv, PERL_MAGIC_utf8);
6459 if (mg && mg->mg_ptr) {
6460 cache = (STRLEN *) mg->mg_ptr;
6461 if (cache[1] == (STRLEN)*offsetp) {
6462 /* An exact match. */
6463 *offsetp = cache[0];
6467 else if (cache[1] < (STRLEN)*offsetp) {
6468 /* We already know part of the way. */
6471 /* Let the below loop do the rest. */
6473 else { /* cache[1] > *offsetp */
6474 /* We already know all of the way, now we may
6475 * be able to walk back. The same assumption
6476 * is made as in S_utf8_mg_pos(), namely that
6477 * walking backward is twice slower than
6478 * walking forward. */
6479 STRLEN forw = *offsetp;
6480 STRLEN backw = cache[1] - *offsetp;
6482 if (!(forw < 2 * backw)) {
6483 U8 *p = s + cache[1];
6490 while (UTF8_IS_CONTINUATION(*p)) {
6498 *offsetp = cache[0];
6500 /* Drop the stale "length" cache */
6508 ASSERT_UTF8_CACHE(cache);
6514 /* Call utf8n_to_uvchr() to validate the sequence
6515 * (unless a simple non-UTF character) */
6516 if (!UTF8_IS_INVARIANT(*s))
6517 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6526 if (!SvREADONLY(sv)) {
6528 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6529 mg = mg_find(sv, PERL_MAGIC_utf8);
6534 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6535 mg->mg_ptr = (char *) cache;
6540 cache[1] = *offsetp;
6541 /* Drop the stale "length" cache */
6554 Returns a boolean indicating whether the strings in the two SVs are
6555 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6556 coerce its args to strings if necessary.
6562 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6570 SV* svrecode = Nullsv;
6577 pv1 = SvPV(sv1, cur1);
6584 pv2 = SvPV(sv2, cur2);
6586 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6587 /* Differing utf8ness.
6588 * Do not UTF8size the comparands as a side-effect. */
6591 svrecode = newSVpvn(pv2, cur2);
6592 sv_recode_to_utf8(svrecode, PL_encoding);
6593 pv2 = SvPV(svrecode, cur2);
6596 svrecode = newSVpvn(pv1, cur1);
6597 sv_recode_to_utf8(svrecode, PL_encoding);
6598 pv1 = SvPV(svrecode, cur1);
6600 /* Now both are in UTF-8. */
6602 SvREFCNT_dec(svrecode);
6607 bool is_utf8 = TRUE;
6610 /* sv1 is the UTF-8 one,
6611 * if is equal it must be downgrade-able */
6612 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6618 /* sv2 is the UTF-8 one,
6619 * if is equal it must be downgrade-able */
6620 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6626 /* Downgrade not possible - cannot be eq */
6634 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6637 SvREFCNT_dec(svrecode);
6648 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6649 string in C<sv1> is less than, equal to, or greater than the string in
6650 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6651 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6657 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6660 const char *pv1, *pv2;
6663 SV *svrecode = Nullsv;
6670 pv1 = SvPV(sv1, cur1);
6677 pv2 = SvPV(sv2, cur2);
6679 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6680 /* Differing utf8ness.
6681 * Do not UTF8size the comparands as a side-effect. */
6684 svrecode = newSVpvn(pv2, cur2);
6685 sv_recode_to_utf8(svrecode, PL_encoding);
6686 pv2 = SvPV(svrecode, cur2);
6689 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6694 svrecode = newSVpvn(pv1, cur1);
6695 sv_recode_to_utf8(svrecode, PL_encoding);
6696 pv1 = SvPV(svrecode, cur1);
6699 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6705 cmp = cur2 ? -1 : 0;
6709 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6712 cmp = retval < 0 ? -1 : 1;
6713 } else if (cur1 == cur2) {
6716 cmp = cur1 < cur2 ? -1 : 1;
6721 SvREFCNT_dec(svrecode);
6730 =for apidoc sv_cmp_locale
6732 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6733 'use bytes' aware, handles get magic, and will coerce its args to strings
6734 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6740 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6742 #ifdef USE_LOCALE_COLLATE
6748 if (PL_collation_standard)
6752 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6754 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6756 if (!pv1 || !len1) {
6767 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6770 return retval < 0 ? -1 : 1;
6773 * When the result of collation is equality, that doesn't mean
6774 * that there are no differences -- some locales exclude some
6775 * characters from consideration. So to avoid false equalities,
6776 * we use the raw string as a tiebreaker.
6782 #endif /* USE_LOCALE_COLLATE */
6784 return sv_cmp(sv1, sv2);
6788 #ifdef USE_LOCALE_COLLATE
6791 =for apidoc sv_collxfrm
6793 Add Collate Transform magic to an SV if it doesn't already have it.
6795 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6796 scalar data of the variable, but transformed to such a format that a normal
6797 memory comparison can be used to compare the data according to the locale
6804 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6808 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6809 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6814 Safefree(mg->mg_ptr);
6816 if ((xf = mem_collxfrm(s, len, &xlen))) {
6817 if (SvREADONLY(sv)) {
6820 return xf + sizeof(PL_collation_ix);
6823 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6824 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6837 if (mg && mg->mg_ptr) {
6839 return mg->mg_ptr + sizeof(PL_collation_ix);
6847 #endif /* USE_LOCALE_COLLATE */
6852 Get a line from the filehandle and store it into the SV, optionally
6853 appending to the currently-stored string.
6859 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6863 register STDCHAR rslast;
6864 register STDCHAR *bp;
6870 if (SvTHINKFIRST(sv))
6871 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6872 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6874 However, perlbench says it's slower, because the existing swipe code
6875 is faster than copy on write.
6876 Swings and roundabouts. */
6877 (void)SvUPGRADE(sv, SVt_PV);
6882 if (PerlIO_isutf8(fp)) {
6884 sv_utf8_upgrade_nomg(sv);
6885 sv_pos_u2b(sv,&append,0);
6887 } else if (SvUTF8(sv)) {
6888 SV *tsv = NEWSV(0,0);
6889 sv_gets(tsv, fp, 0);
6890 sv_utf8_upgrade_nomg(tsv);
6891 SvCUR_set(sv,append);
6894 goto return_string_or_null;
6899 if (PerlIO_isutf8(fp))
6902 if (IN_PERL_COMPILETIME) {
6903 /* we always read code in line mode */
6907 else if (RsSNARF(PL_rs)) {
6908 /* If it is a regular disk file use size from stat() as estimate
6909 of amount we are going to read - may result in malloc-ing
6910 more memory than we realy need if layers bellow reduce
6911 size we read (e.g. CRLF or a gzip layer)
6914 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6915 const Off_t offset = PerlIO_tell(fp);
6916 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6917 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6923 else if (RsRECORD(PL_rs)) {
6927 /* Grab the size of the record we're getting */
6928 recsize = SvIV(SvRV(PL_rs));
6929 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6932 /* VMS wants read instead of fread, because fread doesn't respect */
6933 /* RMS record boundaries. This is not necessarily a good thing to be */
6934 /* doing, but we've got no other real choice - except avoid stdio
6935 as implementation - perhaps write a :vms layer ?
6937 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6939 bytesread = PerlIO_read(fp, buffer, recsize);
6943 SvCUR_set(sv, bytesread += append);
6944 buffer[bytesread] = '\0';
6945 goto return_string_or_null;
6947 else if (RsPARA(PL_rs)) {
6953 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6954 if (PerlIO_isutf8(fp)) {
6955 rsptr = SvPVutf8(PL_rs, rslen);
6958 if (SvUTF8(PL_rs)) {
6959 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6960 Perl_croak(aTHX_ "Wide character in $/");
6963 rsptr = SvPV(PL_rs, rslen);
6967 rslast = rslen ? rsptr[rslen - 1] : '\0';
6969 if (rspara) { /* have to do this both before and after */
6970 do { /* to make sure file boundaries work right */
6973 i = PerlIO_getc(fp);
6977 PerlIO_ungetc(fp,i);
6983 /* See if we know enough about I/O mechanism to cheat it ! */
6985 /* This used to be #ifdef test - it is made run-time test for ease
6986 of abstracting out stdio interface. One call should be cheap
6987 enough here - and may even be a macro allowing compile
6991 if (PerlIO_fast_gets(fp)) {
6994 * We're going to steal some values from the stdio struct
6995 * and put EVERYTHING in the innermost loop into registers.
6997 register STDCHAR *ptr;
7001 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7002 /* An ungetc()d char is handled separately from the regular
7003 * buffer, so we getc() it back out and stuff it in the buffer.
7005 i = PerlIO_getc(fp);
7006 if (i == EOF) return 0;
7007 *(--((*fp)->_ptr)) = (unsigned char) i;
7011 /* Here is some breathtakingly efficient cheating */
7013 cnt = PerlIO_get_cnt(fp); /* get count into register */
7014 /* make sure we have the room */
7015 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7016 /* Not room for all of it
7017 if we are looking for a separator and room for some
7019 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7020 /* just process what we have room for */
7021 shortbuffered = cnt - SvLEN(sv) + append + 1;
7022 cnt -= shortbuffered;
7026 /* remember that cnt can be negative */
7027 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7032 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7033 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7034 DEBUG_P(PerlIO_printf(Perl_debug_log,
7035 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7036 DEBUG_P(PerlIO_printf(Perl_debug_log,
7037 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7038 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7039 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7044 while (cnt > 0) { /* this | eat */
7046 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7047 goto thats_all_folks; /* screams | sed :-) */
7051 Copy(ptr, bp, cnt, char); /* this | eat */
7052 bp += cnt; /* screams | dust */
7053 ptr += cnt; /* louder | sed :-) */
7058 if (shortbuffered) { /* oh well, must extend */
7059 cnt = shortbuffered;
7061 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7063 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7064 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7068 DEBUG_P(PerlIO_printf(Perl_debug_log,
7069 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7070 PTR2UV(ptr),(long)cnt));
7071 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7073 DEBUG_P(PerlIO_printf(Perl_debug_log,
7074 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7075 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7076 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7078 /* This used to call 'filbuf' in stdio form, but as that behaves like
7079 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7080 another abstraction. */
7081 i = PerlIO_getc(fp); /* get more characters */
7083 DEBUG_P(PerlIO_printf(Perl_debug_log,
7084 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7085 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7086 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7088 cnt = PerlIO_get_cnt(fp);
7089 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7090 DEBUG_P(PerlIO_printf(Perl_debug_log,
7091 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7093 if (i == EOF) /* all done for ever? */
7094 goto thats_really_all_folks;
7096 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7098 SvGROW(sv, bpx + cnt + 2);
7099 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7101 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7103 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7104 goto thats_all_folks;
7108 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7109 memNE((char*)bp - rslen, rsptr, rslen))
7110 goto screamer; /* go back to the fray */
7111 thats_really_all_folks:
7113 cnt += shortbuffered;
7114 DEBUG_P(PerlIO_printf(Perl_debug_log,
7115 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7116 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7117 DEBUG_P(PerlIO_printf(Perl_debug_log,
7118 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7119 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7120 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7122 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7123 DEBUG_P(PerlIO_printf(Perl_debug_log,
7124 "Screamer: done, len=%ld, string=|%.*s|\n",
7125 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7129 /*The big, slow, and stupid way. */
7130 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7132 New(0, buf, 8192, STDCHAR);
7140 const register STDCHAR *bpe = buf + sizeof(buf);
7142 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7143 ; /* keep reading */
7147 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7148 /* Accomodate broken VAXC compiler, which applies U8 cast to
7149 * both args of ?: operator, causing EOF to change into 255
7152 i = (U8)buf[cnt - 1];
7158 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7160 sv_catpvn(sv, (char *) buf, cnt);
7162 sv_setpvn(sv, (char *) buf, cnt);
7164 if (i != EOF && /* joy */
7166 SvCUR(sv) < rslen ||
7167 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7171 * If we're reading from a TTY and we get a short read,
7172 * indicating that the user hit his EOF character, we need
7173 * to notice it now, because if we try to read from the TTY
7174 * again, the EOF condition will disappear.
7176 * The comparison of cnt to sizeof(buf) is an optimization
7177 * that prevents unnecessary calls to feof().
7181 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7185 #ifdef USE_HEAP_INSTEAD_OF_STACK
7190 if (rspara) { /* have to do this both before and after */
7191 while (i != EOF) { /* to make sure file boundaries work right */
7192 i = PerlIO_getc(fp);
7194 PerlIO_ungetc(fp,i);
7200 return_string_or_null:
7201 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7207 Auto-increment of the value in the SV, doing string to numeric conversion
7208 if necessary. Handles 'get' magic.
7214 Perl_sv_inc(pTHX_ register SV *sv)
7223 if (SvTHINKFIRST(sv)) {
7225 sv_force_normal_flags(sv, 0);
7226 if (SvREADONLY(sv)) {
7227 if (IN_PERL_RUNTIME)
7228 Perl_croak(aTHX_ PL_no_modify);
7232 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7234 i = PTR2IV(SvRV(sv));
7239 flags = SvFLAGS(sv);
7240 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7241 /* It's (privately or publicly) a float, but not tested as an
7242 integer, so test it to see. */
7244 flags = SvFLAGS(sv);
7246 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7247 /* It's publicly an integer, or privately an integer-not-float */
7248 #ifdef PERL_PRESERVE_IVUV
7252 if (SvUVX(sv) == UV_MAX)
7253 sv_setnv(sv, UV_MAX_P1);
7255 (void)SvIOK_only_UV(sv);
7256 SvUV_set(sv, SvUVX(sv) + 1);
7258 if (SvIVX(sv) == IV_MAX)
7259 sv_setuv(sv, (UV)IV_MAX + 1);
7261 (void)SvIOK_only(sv);
7262 SvIV_set(sv, SvIVX(sv) + 1);
7267 if (flags & SVp_NOK) {
7268 (void)SvNOK_only(sv);
7269 SvNV_set(sv, SvNVX(sv) + 1.0);
7273 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7274 if ((flags & SVTYPEMASK) < SVt_PVIV)
7275 sv_upgrade(sv, SVt_IV);
7276 (void)SvIOK_only(sv);
7281 while (isALPHA(*d)) d++;
7282 while (isDIGIT(*d)) d++;
7284 #ifdef PERL_PRESERVE_IVUV
7285 /* Got to punt this as an integer if needs be, but we don't issue
7286 warnings. Probably ought to make the sv_iv_please() that does
7287 the conversion if possible, and silently. */
7288 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7289 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7290 /* Need to try really hard to see if it's an integer.
7291 9.22337203685478e+18 is an integer.
7292 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7293 so $a="9.22337203685478e+18"; $a+0; $a++
7294 needs to be the same as $a="9.22337203685478e+18"; $a++
7301 /* sv_2iv *should* have made this an NV */
7302 if (flags & SVp_NOK) {
7303 (void)SvNOK_only(sv);
7304 SvNV_set(sv, SvNVX(sv) + 1.0);
7307 /* I don't think we can get here. Maybe I should assert this
7308 And if we do get here I suspect that sv_setnv will croak. NWC
7310 #if defined(USE_LONG_DOUBLE)
7311 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",
7312 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7314 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7315 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7318 #endif /* PERL_PRESERVE_IVUV */
7319 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7323 while (d >= SvPVX(sv)) {
7331 /* MKS: The original code here died if letters weren't consecutive.
7332 * at least it didn't have to worry about non-C locales. The
7333 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7334 * arranged in order (although not consecutively) and that only
7335 * [A-Za-z] are accepted by isALPHA in the C locale.
7337 if (*d != 'z' && *d != 'Z') {
7338 do { ++*d; } while (!isALPHA(*d));
7341 *(d--) -= 'z' - 'a';
7346 *(d--) -= 'z' - 'a' + 1;
7350 /* oh,oh, the number grew */
7351 SvGROW(sv, SvCUR(sv) + 2);
7352 SvCUR_set(sv, SvCUR(sv) + 1);
7353 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7364 Auto-decrement of the value in the SV, doing string to numeric conversion
7365 if necessary. Handles 'get' magic.
7371 Perl_sv_dec(pTHX_ register SV *sv)
7379 if (SvTHINKFIRST(sv)) {
7381 sv_force_normal_flags(sv, 0);
7382 if (SvREADONLY(sv)) {
7383 if (IN_PERL_RUNTIME)
7384 Perl_croak(aTHX_ PL_no_modify);
7388 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7390 i = PTR2IV(SvRV(sv));
7395 /* Unlike sv_inc we don't have to worry about string-never-numbers
7396 and keeping them magic. But we mustn't warn on punting */
7397 flags = SvFLAGS(sv);
7398 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7399 /* It's publicly an integer, or privately an integer-not-float */
7400 #ifdef PERL_PRESERVE_IVUV
7404 if (SvUVX(sv) == 0) {
7405 (void)SvIOK_only(sv);
7409 (void)SvIOK_only_UV(sv);
7410 SvUV_set(sv, SvUVX(sv) + 1);
7413 if (SvIVX(sv) == IV_MIN)
7414 sv_setnv(sv, (NV)IV_MIN - 1.0);
7416 (void)SvIOK_only(sv);
7417 SvIV_set(sv, SvIVX(sv) - 1);
7422 if (flags & SVp_NOK) {
7423 SvNV_set(sv, SvNVX(sv) - 1.0);
7424 (void)SvNOK_only(sv);
7427 if (!(flags & SVp_POK)) {
7428 if ((flags & SVTYPEMASK) < SVt_PVNV)
7429 sv_upgrade(sv, SVt_NV);
7431 (void)SvNOK_only(sv);
7434 #ifdef PERL_PRESERVE_IVUV
7436 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7437 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7438 /* Need to try really hard to see if it's an integer.
7439 9.22337203685478e+18 is an integer.
7440 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7441 so $a="9.22337203685478e+18"; $a+0; $a--
7442 needs to be the same as $a="9.22337203685478e+18"; $a--
7449 /* sv_2iv *should* have made this an NV */
7450 if (flags & SVp_NOK) {
7451 (void)SvNOK_only(sv);
7452 SvNV_set(sv, SvNVX(sv) - 1.0);
7455 /* I don't think we can get here. Maybe I should assert this
7456 And if we do get here I suspect that sv_setnv will croak. NWC
7458 #if defined(USE_LONG_DOUBLE)
7459 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",
7460 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7462 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7463 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7467 #endif /* PERL_PRESERVE_IVUV */
7468 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7472 =for apidoc sv_mortalcopy
7474 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7475 The new SV is marked as mortal. It will be destroyed "soon", either by an
7476 explicit call to FREETMPS, or by an implicit call at places such as
7477 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7482 /* Make a string that will exist for the duration of the expression
7483 * evaluation. Actually, it may have to last longer than that, but
7484 * hopefully we won't free it until it has been assigned to a
7485 * permanent location. */
7488 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7493 sv_setsv(sv,oldstr);
7495 PL_tmps_stack[++PL_tmps_ix] = sv;
7501 =for apidoc sv_newmortal
7503 Creates a new null SV which is mortal. The reference count of the SV is
7504 set to 1. It will be destroyed "soon", either by an explicit call to
7505 FREETMPS, or by an implicit call at places such as statement boundaries.
7506 See also C<sv_mortalcopy> and C<sv_2mortal>.
7512 Perl_sv_newmortal(pTHX)
7517 SvFLAGS(sv) = SVs_TEMP;
7519 PL_tmps_stack[++PL_tmps_ix] = sv;
7524 =for apidoc sv_2mortal
7526 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7527 by an explicit call to FREETMPS, or by an implicit call at places such as
7528 statement boundaries. SvTEMP() is turned on which means that the SV's
7529 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7530 and C<sv_mortalcopy>.
7536 Perl_sv_2mortal(pTHX_ register SV *sv)
7541 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7544 PL_tmps_stack[++PL_tmps_ix] = sv;
7552 Creates a new SV and copies a string into it. The reference count for the
7553 SV is set to 1. If C<len> is zero, Perl will compute the length using
7554 strlen(). For efficiency, consider using C<newSVpvn> instead.
7560 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7567 sv_setpvn(sv,s,len);
7572 =for apidoc newSVpvn
7574 Creates a new SV and copies a string into it. The reference count for the
7575 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7576 string. You are responsible for ensuring that the source string is at least
7577 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7583 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7588 sv_setpvn(sv,s,len);
7593 =for apidoc newSVpvn_share
7595 Creates a new SV with its SvPVX pointing to a shared string in the string
7596 table. If the string does not already exist in the table, it is created
7597 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7598 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7599 otherwise the hash is computed. The idea here is that as the string table
7600 is used for shared hash keys these strings will have SvPVX == HeKEY and
7601 hash lookup will avoid string compare.
7607 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7610 bool is_utf8 = FALSE;
7612 STRLEN tmplen = -len;
7614 /* See the note in hv.c:hv_fetch() --jhi */
7615 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7619 PERL_HASH(hash, src, len);
7621 sv_upgrade(sv, SVt_PVIV);
7622 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7635 #if defined(PERL_IMPLICIT_CONTEXT)
7637 /* pTHX_ magic can't cope with varargs, so this is a no-context
7638 * version of the main function, (which may itself be aliased to us).
7639 * Don't access this version directly.
7643 Perl_newSVpvf_nocontext(const char* pat, ...)
7648 va_start(args, pat);
7649 sv = vnewSVpvf(pat, &args);
7656 =for apidoc newSVpvf
7658 Creates a new SV and initializes it with the string formatted like
7665 Perl_newSVpvf(pTHX_ const char* pat, ...)
7669 va_start(args, pat);
7670 sv = vnewSVpvf(pat, &args);
7675 /* backend for newSVpvf() and newSVpvf_nocontext() */
7678 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7682 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7689 Creates a new SV and copies a floating point value into it.
7690 The reference count for the SV is set to 1.
7696 Perl_newSVnv(pTHX_ NV n)
7708 Creates a new SV and copies an integer into it. The reference count for the
7715 Perl_newSViv(pTHX_ IV i)
7727 Creates a new SV and copies an unsigned integer into it.
7728 The reference count for the SV is set to 1.
7734 Perl_newSVuv(pTHX_ UV u)
7744 =for apidoc newRV_noinc
7746 Creates an RV wrapper for an SV. The reference count for the original
7747 SV is B<not> incremented.
7753 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7758 sv_upgrade(sv, SVt_RV);
7760 SvRV_set(sv, tmpRef);
7765 /* newRV_inc is the official function name to use now.
7766 * newRV_inc is in fact #defined to newRV in sv.h
7770 Perl_newRV(pTHX_ SV *tmpRef)
7772 return newRV_noinc(SvREFCNT_inc(tmpRef));
7778 Creates a new SV which is an exact duplicate of the original SV.
7785 Perl_newSVsv(pTHX_ register SV *old)
7791 if (SvTYPE(old) == SVTYPEMASK) {
7792 if (ckWARN_d(WARN_INTERNAL))
7793 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7797 /* SV_GMAGIC is the default for sv_setv()
7798 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7799 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7800 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7805 =for apidoc sv_reset
7807 Underlying implementation for the C<reset> Perl function.
7808 Note that the perl-level function is vaguely deprecated.
7814 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7822 char todo[PERL_UCHAR_MAX+1];
7827 if (!*s) { /* reset ?? searches */
7828 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7830 PMOP *pm = (PMOP *) mg->mg_obj;
7832 pm->op_pmdynflags &= ~PMdf_USED;
7839 /* reset variables */
7841 if (!HvARRAY(stash))
7844 Zero(todo, 256, char);
7846 i = (unsigned char)*s;
7850 max = (unsigned char)*s++;
7851 for ( ; i <= max; i++) {
7854 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7855 for (entry = HvARRAY(stash)[i];
7857 entry = HeNEXT(entry))
7859 if (!todo[(U8)*HeKEY(entry)])
7861 gv = (GV*)HeVAL(entry);
7863 if (SvTHINKFIRST(sv)) {
7864 if (!SvREADONLY(sv) && SvROK(sv))
7869 if (SvTYPE(sv) >= SVt_PV) {
7871 if (SvPVX(sv) != Nullch)
7878 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7881 #ifdef USE_ENVIRON_ARRAY
7883 # ifdef USE_ITHREADS
7884 && PL_curinterp == aTHX
7888 environ[0] = Nullch;
7891 #endif /* !PERL_MICRO */
7901 Using various gambits, try to get an IO from an SV: the IO slot if its a
7902 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7903 named after the PV if we're a string.
7909 Perl_sv_2io(pTHX_ SV *sv)
7914 switch (SvTYPE(sv)) {
7922 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7926 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7928 return sv_2io(SvRV(sv));
7929 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7935 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7944 Using various gambits, try to get a CV from an SV; in addition, try if
7945 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7951 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7958 return *gvp = Nullgv, Nullcv;
7959 switch (SvTYPE(sv)) {
7978 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7979 tryAMAGICunDEREF(to_cv);
7982 if (SvTYPE(sv) == SVt_PVCV) {
7991 Perl_croak(aTHX_ "Not a subroutine reference");
7996 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8002 if (lref && !GvCVu(gv)) {
8005 tmpsv = NEWSV(704,0);
8006 gv_efullname3(tmpsv, gv, Nullch);
8007 /* XXX this is probably not what they think they're getting.
8008 * It has the same effect as "sub name;", i.e. just a forward
8010 newSUB(start_subparse(FALSE, 0),
8011 newSVOP(OP_CONST, 0, tmpsv),
8016 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8026 Returns true if the SV has a true value by Perl's rules.
8027 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8028 instead use an in-line version.
8034 Perl_sv_true(pTHX_ register SV *sv)
8039 const register XPV* tXpv;
8040 if ((tXpv = (XPV*)SvANY(sv)) &&
8041 (tXpv->xpv_cur > 1 ||
8042 (tXpv->xpv_cur && *sv->sv_u.sv_pv != '0')))
8049 return SvIVX(sv) != 0;
8052 return SvNVX(sv) != 0.0;
8054 return sv_2bool(sv);
8062 A private implementation of the C<SvIVx> macro for compilers which can't
8063 cope with complex macro expressions. Always use the macro instead.
8069 Perl_sv_iv(pTHX_ register SV *sv)
8073 return (IV)SvUVX(sv);
8082 A private implementation of the C<SvUVx> macro for compilers which can't
8083 cope with complex macro expressions. Always use the macro instead.
8089 Perl_sv_uv(pTHX_ register SV *sv)
8094 return (UV)SvIVX(sv);
8102 A private implementation of the C<SvNVx> macro for compilers which can't
8103 cope with complex macro expressions. Always use the macro instead.
8109 Perl_sv_nv(pTHX_ register SV *sv)
8116 /* sv_pv() is now a macro using SvPV_nolen();
8117 * this function provided for binary compatibility only
8121 Perl_sv_pv(pTHX_ SV *sv)
8128 return sv_2pv(sv, &n_a);
8134 Use the C<SvPV_nolen> macro instead
8138 A private implementation of the C<SvPV> macro for compilers which can't
8139 cope with complex macro expressions. Always use the macro instead.
8145 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8151 return sv_2pv(sv, lp);
8156 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8162 return sv_2pv_flags(sv, lp, 0);
8165 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8166 * this function provided for binary compatibility only
8170 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8172 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8176 =for apidoc sv_pvn_force
8178 Get a sensible string out of the SV somehow.
8179 A private implementation of the C<SvPV_force> macro for compilers which
8180 can't cope with complex macro expressions. Always use the macro instead.
8182 =for apidoc sv_pvn_force_flags
8184 Get a sensible string out of the SV somehow.
8185 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8186 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8187 implemented in terms of this function.
8188 You normally want to use the various wrapper macros instead: see
8189 C<SvPV_force> and C<SvPV_force_nomg>
8195 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8198 if (SvTHINKFIRST(sv) && !SvROK(sv))
8199 sv_force_normal_flags(sv, 0);
8206 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8207 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8211 s = sv_2pv_flags(sv, lp, flags);
8212 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8213 const STRLEN len = *lp;
8217 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8218 SvGROW(sv, len + 1);
8219 Move(s,SvPVX(sv),len,char);
8224 SvPOK_on(sv); /* validate pointer */
8226 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8227 PTR2UV(sv),SvPVX(sv)));
8233 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8234 * this function provided for binary compatibility only
8238 Perl_sv_pvbyte(pTHX_ SV *sv)
8240 sv_utf8_downgrade(sv,0);
8245 =for apidoc sv_pvbyte
8247 Use C<SvPVbyte_nolen> instead.
8249 =for apidoc sv_pvbyten
8251 A private implementation of the C<SvPVbyte> macro for compilers
8252 which can't cope with complex macro expressions. Always use the macro
8259 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8261 sv_utf8_downgrade(sv,0);
8262 return sv_pvn(sv,lp);
8266 =for apidoc sv_pvbyten_force
8268 A private implementation of the C<SvPVbytex_force> macro for compilers
8269 which can't cope with complex macro expressions. Always use the macro
8276 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8278 sv_pvn_force(sv,lp);
8279 sv_utf8_downgrade(sv,0);
8284 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8285 * this function provided for binary compatibility only
8289 Perl_sv_pvutf8(pTHX_ SV *sv)
8291 sv_utf8_upgrade(sv);
8296 =for apidoc sv_pvutf8
8298 Use the C<SvPVutf8_nolen> macro instead
8300 =for apidoc sv_pvutf8n
8302 A private implementation of the C<SvPVutf8> macro for compilers
8303 which can't cope with complex macro expressions. Always use the macro
8310 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8312 sv_utf8_upgrade(sv);
8313 return sv_pvn(sv,lp);
8317 =for apidoc sv_pvutf8n_force
8319 A private implementation of the C<SvPVutf8_force> macro for compilers
8320 which can't cope with complex macro expressions. Always use the macro
8327 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8329 sv_pvn_force(sv,lp);
8330 sv_utf8_upgrade(sv);
8336 =for apidoc sv_reftype
8338 Returns a string describing what the SV is a reference to.
8344 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8346 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8347 inside return suggests a const propagation bug in g++. */
8348 if (ob && SvOBJECT(sv)) {
8349 char *name = HvNAME_get(SvSTASH(sv));
8350 return name ? name : (char *) "__ANON__";
8353 switch (SvTYPE(sv)) {
8370 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8371 /* tied lvalues should appear to be
8372 * scalars for backwards compatitbility */
8373 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8374 ? "SCALAR" : "LVALUE");
8375 case SVt_PVAV: return "ARRAY";
8376 case SVt_PVHV: return "HASH";
8377 case SVt_PVCV: return "CODE";
8378 case SVt_PVGV: return "GLOB";
8379 case SVt_PVFM: return "FORMAT";
8380 case SVt_PVIO: return "IO";
8381 default: return "UNKNOWN";
8387 =for apidoc sv_isobject
8389 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8390 object. If the SV is not an RV, or if the object is not blessed, then this
8397 Perl_sv_isobject(pTHX_ SV *sv)
8414 Returns a boolean indicating whether the SV is blessed into the specified
8415 class. This does not check for subtypes; use C<sv_derived_from> to verify
8416 an inheritance relationship.
8422 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8434 hvname = HvNAME_get(SvSTASH(sv));
8438 return strEQ(hvname, name);
8444 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8445 it will be upgraded to one. If C<classname> is non-null then the new SV will
8446 be blessed in the specified package. The new SV is returned and its
8447 reference count is 1.
8453 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8459 SV_CHECK_THINKFIRST_COW_DROP(rv);
8462 if (SvTYPE(rv) >= SVt_PVMG) {
8463 const U32 refcnt = SvREFCNT(rv);
8467 SvREFCNT(rv) = refcnt;
8470 if (SvTYPE(rv) < SVt_RV)
8471 sv_upgrade(rv, SVt_RV);
8472 else if (SvTYPE(rv) > SVt_RV) {
8483 HV* stash = gv_stashpv(classname, TRUE);
8484 (void)sv_bless(rv, stash);
8490 =for apidoc sv_setref_pv
8492 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8493 argument will be upgraded to an RV. That RV will be modified to point to
8494 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8495 into the SV. The C<classname> argument indicates the package for the
8496 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8497 will have a reference count of 1, and the RV will be returned.
8499 Do not use with other Perl types such as HV, AV, SV, CV, because those
8500 objects will become corrupted by the pointer copy process.
8502 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8508 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8511 sv_setsv(rv, &PL_sv_undef);
8515 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8520 =for apidoc sv_setref_iv
8522 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8523 argument will be upgraded to an RV. That RV will be modified to point to
8524 the new SV. The C<classname> argument indicates the package for the
8525 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8526 will have a reference count of 1, and the RV will be returned.
8532 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8534 sv_setiv(newSVrv(rv,classname), iv);
8539 =for apidoc sv_setref_uv
8541 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8542 argument will be upgraded to an RV. That RV will be modified to point to
8543 the new SV. The C<classname> argument indicates the package for the
8544 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8545 will have a reference count of 1, and the RV will be returned.
8551 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8553 sv_setuv(newSVrv(rv,classname), uv);
8558 =for apidoc sv_setref_nv
8560 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8561 argument will be upgraded to an RV. That RV will be modified to point to
8562 the new SV. The C<classname> argument indicates the package for the
8563 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8564 will have a reference count of 1, and the RV will be returned.
8570 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8572 sv_setnv(newSVrv(rv,classname), nv);
8577 =for apidoc sv_setref_pvn
8579 Copies a string into a new SV, optionally blessing the SV. The length of the
8580 string must be specified with C<n>. The C<rv> argument will be upgraded to
8581 an RV. That RV will be modified to point to the new SV. The C<classname>
8582 argument indicates the package for the blessing. Set C<classname> to
8583 C<Nullch> to avoid the blessing. The new SV will have a reference count
8584 of 1, and the RV will be returned.
8586 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8592 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8594 sv_setpvn(newSVrv(rv,classname), pv, n);
8599 =for apidoc sv_bless
8601 Blesses an SV into a specified package. The SV must be an RV. The package
8602 must be designated by its stash (see C<gv_stashpv()>). The reference count
8603 of the SV is unaffected.
8609 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8613 Perl_croak(aTHX_ "Can't bless non-reference value");
8615 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8616 if (SvREADONLY(tmpRef))
8617 Perl_croak(aTHX_ PL_no_modify);
8618 if (SvOBJECT(tmpRef)) {
8619 if (SvTYPE(tmpRef) != SVt_PVIO)
8621 SvREFCNT_dec(SvSTASH(tmpRef));
8624 SvOBJECT_on(tmpRef);
8625 if (SvTYPE(tmpRef) != SVt_PVIO)
8627 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8628 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8635 if(SvSMAGICAL(tmpRef))
8636 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8644 /* Downgrades a PVGV to a PVMG.
8648 S_sv_unglob(pTHX_ SV *sv)
8652 assert(SvTYPE(sv) == SVt_PVGV);
8657 SvREFCNT_dec(GvSTASH(sv));
8658 GvSTASH(sv) = Nullhv;
8660 sv_unmagic(sv, PERL_MAGIC_glob);
8661 Safefree(GvNAME(sv));
8664 /* need to keep SvANY(sv) in the right arena */
8665 xpvmg = new_XPVMG();
8666 StructCopy(SvANY(sv), xpvmg, XPVMG);
8667 del_XPVGV(SvANY(sv));
8670 SvFLAGS(sv) &= ~SVTYPEMASK;
8671 SvFLAGS(sv) |= SVt_PVMG;
8675 =for apidoc sv_unref_flags
8677 Unsets the RV status of the SV, and decrements the reference count of
8678 whatever was being referenced by the RV. This can almost be thought of
8679 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8680 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8681 (otherwise the decrementing is conditional on the reference count being
8682 different from one or the reference being a readonly SV).
8689 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8693 if (SvWEAKREF(sv)) {
8701 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8702 assigned to as BEGIN {$a = \"Foo"} will fail. */
8703 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8705 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8706 sv_2mortal(rv); /* Schedule for freeing later */
8710 =for apidoc sv_unref
8712 Unsets the RV status of the SV, and decrements the reference count of
8713 whatever was being referenced by the RV. This can almost be thought of
8714 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8715 being zero. See C<SvROK_off>.
8721 Perl_sv_unref(pTHX_ SV *sv)
8723 sv_unref_flags(sv, 0);
8727 =for apidoc sv_taint
8729 Taint an SV. Use C<SvTAINTED_on> instead.
8734 Perl_sv_taint(pTHX_ SV *sv)
8736 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8740 =for apidoc sv_untaint
8742 Untaint an SV. Use C<SvTAINTED_off> instead.
8747 Perl_sv_untaint(pTHX_ SV *sv)
8749 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8750 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8757 =for apidoc sv_tainted
8759 Test an SV for taintedness. Use C<SvTAINTED> instead.
8764 Perl_sv_tainted(pTHX_ SV *sv)
8766 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8767 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8768 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8775 =for apidoc sv_setpviv
8777 Copies an integer into the given SV, also updating its string value.
8778 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8784 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8786 char buf[TYPE_CHARS(UV)];
8788 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8790 sv_setpvn(sv, ptr, ebuf - ptr);
8794 =for apidoc sv_setpviv_mg
8796 Like C<sv_setpviv>, but also handles 'set' magic.
8802 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8804 char buf[TYPE_CHARS(UV)];
8806 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8808 sv_setpvn(sv, ptr, ebuf - ptr);
8812 #if defined(PERL_IMPLICIT_CONTEXT)
8814 /* pTHX_ magic can't cope with varargs, so this is a no-context
8815 * version of the main function, (which may itself be aliased to us).
8816 * Don't access this version directly.
8820 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8824 va_start(args, pat);
8825 sv_vsetpvf(sv, pat, &args);
8829 /* pTHX_ magic can't cope with varargs, so this is a no-context
8830 * version of the main function, (which may itself be aliased to us).
8831 * Don't access this version directly.
8835 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8839 va_start(args, pat);
8840 sv_vsetpvf_mg(sv, pat, &args);
8846 =for apidoc sv_setpvf
8848 Works like C<sv_catpvf> but copies the text into the SV instead of
8849 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8855 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8858 va_start(args, pat);
8859 sv_vsetpvf(sv, pat, &args);
8864 =for apidoc sv_vsetpvf
8866 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8867 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8869 Usually used via its frontend C<sv_setpvf>.
8875 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8877 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8881 =for apidoc sv_setpvf_mg
8883 Like C<sv_setpvf>, but also handles 'set' magic.
8889 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8892 va_start(args, pat);
8893 sv_vsetpvf_mg(sv, pat, &args);
8898 =for apidoc sv_vsetpvf_mg
8900 Like C<sv_vsetpvf>, but also handles 'set' magic.
8902 Usually used via its frontend C<sv_setpvf_mg>.
8908 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8910 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8914 #if defined(PERL_IMPLICIT_CONTEXT)
8916 /* pTHX_ magic can't cope with varargs, so this is a no-context
8917 * version of the main function, (which may itself be aliased to us).
8918 * Don't access this version directly.
8922 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8926 va_start(args, pat);
8927 sv_vcatpvf(sv, pat, &args);
8931 /* pTHX_ magic can't cope with varargs, so this is a no-context
8932 * version of the main function, (which may itself be aliased to us).
8933 * Don't access this version directly.
8937 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8941 va_start(args, pat);
8942 sv_vcatpvf_mg(sv, pat, &args);
8948 =for apidoc sv_catpvf
8950 Processes its arguments like C<sprintf> and appends the formatted
8951 output to an SV. If the appended data contains "wide" characters
8952 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8953 and characters >255 formatted with %c), the original SV might get
8954 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8955 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8956 valid UTF-8; if the original SV was bytes, the pattern should be too.
8961 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8964 va_start(args, pat);
8965 sv_vcatpvf(sv, pat, &args);
8970 =for apidoc sv_vcatpvf
8972 Processes its arguments like C<vsprintf> and appends the formatted output
8973 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8975 Usually used via its frontend C<sv_catpvf>.
8981 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8983 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8987 =for apidoc sv_catpvf_mg
8989 Like C<sv_catpvf>, but also handles 'set' magic.
8995 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8998 va_start(args, pat);
8999 sv_vcatpvf_mg(sv, pat, &args);
9004 =for apidoc sv_vcatpvf_mg
9006 Like C<sv_vcatpvf>, but also handles 'set' magic.
9008 Usually used via its frontend C<sv_catpvf_mg>.
9014 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9016 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9021 =for apidoc sv_vsetpvfn
9023 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9026 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9032 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9034 sv_setpvn(sv, "", 0);
9035 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9038 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9041 S_expect_number(pTHX_ char** pattern)
9044 switch (**pattern) {
9045 case '1': case '2': case '3':
9046 case '4': case '5': case '6':
9047 case '7': case '8': case '9':
9048 while (isDIGIT(**pattern))
9049 var = var * 10 + (*(*pattern)++ - '0');
9053 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9056 F0convert(NV nv, char *endbuf, STRLEN *len)
9058 const int neg = nv < 0;
9067 if (uv & 1 && uv == nv)
9068 uv--; /* Round to even */
9070 const unsigned dig = uv % 10;
9083 =for apidoc sv_vcatpvfn
9085 Processes its arguments like C<vsprintf> and appends the formatted output
9086 to an SV. Uses an array of SVs if the C style variable argument list is
9087 missing (NULL). When running with taint checks enabled, indicates via
9088 C<maybe_tainted> if results are untrustworthy (often due to the use of
9091 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9096 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9099 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9106 static const char nullstr[] = "(null)";
9108 bool has_utf8; /* has the result utf8? */
9109 bool pat_utf8; /* the pattern is in utf8? */
9111 /* Times 4: a decimal digit takes more than 3 binary digits.
9112 * NV_DIG: mantissa takes than many decimal digits.
9113 * Plus 32: Playing safe. */
9114 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9115 /* large enough for "%#.#f" --chip */
9116 /* what about long double NVs? --jhi */
9118 has_utf8 = pat_utf8 = DO_UTF8(sv);
9120 /* no matter what, this is a string now */
9121 (void)SvPV_force(sv, origlen);
9123 /* special-case "", "%s", and "%-p" (SVf) */
9126 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9128 const char *s = va_arg(*args, char*);
9129 sv_catpv(sv, s ? s : nullstr);
9131 else if (svix < svmax) {
9132 sv_catsv(sv, *svargs);
9133 if (DO_UTF8(*svargs))
9138 if (patlen == 3 && pat[0] == '%' &&
9139 pat[1] == '-' && pat[2] == 'p') {
9141 argsv = va_arg(*args, SV*);
9142 sv_catsv(sv, argsv);
9149 #ifndef USE_LONG_DOUBLE
9150 /* special-case "%.<number>[gf]" */
9151 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9152 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9153 unsigned digits = 0;
9157 while (*pp >= '0' && *pp <= '9')
9158 digits = 10 * digits + (*pp++ - '0');
9159 if (pp - pat == (int)patlen - 1) {
9163 nv = (NV)va_arg(*args, double);
9164 else if (svix < svmax)
9169 /* Add check for digits != 0 because it seems that some
9170 gconverts are buggy in this case, and we don't yet have
9171 a Configure test for this. */
9172 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9173 /* 0, point, slack */
9174 Gconvert(nv, (int)digits, 0, ebuf);
9176 if (*ebuf) /* May return an empty string for digits==0 */
9179 } else if (!digits) {
9182 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9183 sv_catpvn(sv, p, l);
9189 #endif /* !USE_LONG_DOUBLE */
9191 if (!args && svix < svmax && DO_UTF8(*svargs))
9194 patend = (char*)pat + patlen;
9195 for (p = (char*)pat; p < patend; p = q) {
9198 bool vectorize = FALSE;
9199 bool vectorarg = FALSE;
9200 bool vec_utf8 = FALSE;
9206 bool has_precis = FALSE;
9209 bool is_utf8 = FALSE; /* is this item utf8? */
9210 #ifdef HAS_LDBL_SPRINTF_BUG
9211 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9212 with sfio - Allen <allens@cpan.org> */
9213 bool fix_ldbl_sprintf_bug = FALSE;
9217 U8 utf8buf[UTF8_MAXBYTES+1];
9218 STRLEN esignlen = 0;
9220 char *eptr = Nullch;
9223 U8 *vecstr = Null(U8*);
9230 /* we need a long double target in case HAS_LONG_DOUBLE but
9233 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9241 const char *dotstr = ".";
9242 STRLEN dotstrlen = 1;
9243 I32 efix = 0; /* explicit format parameter index */
9244 I32 ewix = 0; /* explicit width index */
9245 I32 epix = 0; /* explicit precision index */
9246 I32 evix = 0; /* explicit vector index */
9247 bool asterisk = FALSE;
9249 /* echo everything up to the next format specification */
9250 for (q = p; q < patend && *q != '%'; ++q) ;
9252 if (has_utf8 && !pat_utf8)
9253 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9255 sv_catpvn(sv, p, q - p);
9262 We allow format specification elements in this order:
9263 \d+\$ explicit format parameter index
9265 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9266 0 flag (as above): repeated to allow "v02"
9267 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9268 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9270 [%bcdefginopsux_DFOUX] format (mandatory)
9272 if (EXPECT_NUMBER(q, width)) {
9313 if (EXPECT_NUMBER(q, ewix))
9322 if ((vectorarg = asterisk)) {
9334 EXPECT_NUMBER(q, width);
9339 vecsv = va_arg(*args, SV*);
9341 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9342 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9343 dotstr = SvPVx(vecsv, dotstrlen);
9348 vecsv = va_arg(*args, SV*);
9349 vecstr = (U8*)SvPVx(vecsv,veclen);
9350 vec_utf8 = DO_UTF8(vecsv);
9352 else if (efix ? efix <= svmax : svix < svmax) {
9353 vecsv = svargs[efix ? efix-1 : svix++];
9354 vecstr = (U8*)SvPVx(vecsv,veclen);
9355 vec_utf8 = DO_UTF8(vecsv);
9356 /* if this is a version object, we need to return the
9357 * stringified representation (which the SvPVX has
9358 * already done for us), but not vectorize the args
9360 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9362 q++; /* skip past the rest of the %vd format */
9363 eptr = (char *) vecstr;
9364 elen = strlen(eptr);
9377 i = va_arg(*args, int);
9379 i = (ewix ? ewix <= svmax : svix < svmax) ?
9380 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9382 width = (i < 0) ? -i : i;
9392 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9394 /* XXX: todo, support specified precision parameter */
9398 i = va_arg(*args, int);
9400 i = (ewix ? ewix <= svmax : svix < svmax)
9401 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9402 precis = (i < 0) ? 0 : i;
9407 precis = precis * 10 + (*q++ - '0');
9416 case 'I': /* Ix, I32x, and I64x */
9418 if (q[1] == '6' && q[2] == '4') {
9424 if (q[1] == '3' && q[2] == '2') {
9434 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9445 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9446 if (*(q + 1) == 'l') { /* lld, llf */
9471 argsv = (efix ? efix <= svmax : svix < svmax) ?
9472 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9479 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9481 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9483 eptr = (char*)utf8buf;
9484 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9495 if (args && !vectorize) {
9496 eptr = va_arg(*args, char*);
9498 #ifdef MACOS_TRADITIONAL
9499 /* On MacOS, %#s format is used for Pascal strings */
9504 elen = strlen(eptr);
9506 eptr = (char *)nullstr;
9507 elen = sizeof nullstr - 1;
9511 eptr = SvPVx(argsv, elen);
9512 if (DO_UTF8(argsv)) {
9513 if (has_precis && precis < elen) {
9515 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9518 if (width) { /* fudge width (can't fudge elen) */
9519 width += elen - sv_len_utf8(argsv);
9527 if (has_precis && elen > precis)
9534 if (left && args) { /* SVf */
9543 argsv = va_arg(*args, SV*);
9544 eptr = SvPVx(argsv, elen);
9549 if (alt || vectorize)
9551 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9569 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9578 esignbuf[esignlen++] = plus;
9582 case 'h': iv = (short)va_arg(*args, int); break;
9583 case 'l': iv = va_arg(*args, long); break;
9584 case 'V': iv = va_arg(*args, IV); break;
9585 default: iv = va_arg(*args, int); break;
9587 case 'q': iv = va_arg(*args, Quad_t); break;
9592 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9594 case 'h': iv = (short)tiv; break;
9595 case 'l': iv = (long)tiv; break;
9597 default: iv = tiv; break;
9599 case 'q': iv = (Quad_t)tiv; break;
9603 if ( !vectorize ) /* we already set uv above */
9608 esignbuf[esignlen++] = plus;
9612 esignbuf[esignlen++] = '-';
9655 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9666 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9667 case 'l': uv = va_arg(*args, unsigned long); break;
9668 case 'V': uv = va_arg(*args, UV); break;
9669 default: uv = va_arg(*args, unsigned); break;
9671 case 'q': uv = va_arg(*args, Uquad_t); break;
9676 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9678 case 'h': uv = (unsigned short)tuv; break;
9679 case 'l': uv = (unsigned long)tuv; break;
9681 default: uv = tuv; break;
9683 case 'q': uv = (Uquad_t)tuv; break;
9689 eptr = ebuf + sizeof ebuf;
9695 p = (char*)((c == 'X')
9696 ? "0123456789ABCDEF" : "0123456789abcdef");
9702 esignbuf[esignlen++] = '0';
9703 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9709 *--eptr = '0' + dig;
9711 if (alt && *eptr != '0')
9717 *--eptr = '0' + dig;
9720 esignbuf[esignlen++] = '0';
9721 esignbuf[esignlen++] = 'b';
9724 default: /* it had better be ten or less */
9727 *--eptr = '0' + dig;
9728 } while (uv /= base);
9731 elen = (ebuf + sizeof ebuf) - eptr;
9734 zeros = precis - elen;
9735 else if (precis == 0 && elen == 1 && *eptr == '0')
9740 /* FLOATING POINT */
9743 c = 'f'; /* maybe %F isn't supported here */
9749 /* This is evil, but floating point is even more evil */
9751 /* for SV-style calling, we can only get NV
9752 for C-style calling, we assume %f is double;
9753 for simplicity we allow any of %Lf, %llf, %qf for long double
9757 #if defined(USE_LONG_DOUBLE)
9761 /* [perl #20339] - we should accept and ignore %lf rather than die */
9765 #if defined(USE_LONG_DOUBLE)
9766 intsize = args ? 0 : 'q';
9770 #if defined(HAS_LONG_DOUBLE)
9779 /* now we need (long double) if intsize == 'q', else (double) */
9780 nv = (args && !vectorize) ?
9781 #if LONG_DOUBLESIZE > DOUBLESIZE
9783 va_arg(*args, long double) :
9784 va_arg(*args, double)
9786 va_arg(*args, double)
9792 if (c != 'e' && c != 'E') {
9794 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9795 will cast our (long double) to (double) */
9796 (void)Perl_frexp(nv, &i);
9797 if (i == PERL_INT_MIN)
9798 Perl_die(aTHX_ "panic: frexp");
9800 need = BIT_DIGITS(i);
9802 need += has_precis ? precis : 6; /* known default */
9807 #ifdef HAS_LDBL_SPRINTF_BUG
9808 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9809 with sfio - Allen <allens@cpan.org> */
9812 # define MY_DBL_MAX DBL_MAX
9813 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9814 # if DOUBLESIZE >= 8
9815 # define MY_DBL_MAX 1.7976931348623157E+308L
9817 # define MY_DBL_MAX 3.40282347E+38L
9821 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9822 # define MY_DBL_MAX_BUG 1L
9824 # define MY_DBL_MAX_BUG MY_DBL_MAX
9828 # define MY_DBL_MIN DBL_MIN
9829 # else /* XXX guessing! -Allen */
9830 # if DOUBLESIZE >= 8
9831 # define MY_DBL_MIN 2.2250738585072014E-308L
9833 # define MY_DBL_MIN 1.17549435E-38L
9837 if ((intsize == 'q') && (c == 'f') &&
9838 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9840 /* it's going to be short enough that
9841 * long double precision is not needed */
9843 if ((nv <= 0L) && (nv >= -0L))
9844 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9846 /* would use Perl_fp_class as a double-check but not
9847 * functional on IRIX - see perl.h comments */
9849 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9850 /* It's within the range that a double can represent */
9851 #if defined(DBL_MAX) && !defined(DBL_MIN)
9852 if ((nv >= ((long double)1/DBL_MAX)) ||
9853 (nv <= (-(long double)1/DBL_MAX)))
9855 fix_ldbl_sprintf_bug = TRUE;
9858 if (fix_ldbl_sprintf_bug == TRUE) {
9868 # undef MY_DBL_MAX_BUG
9871 #endif /* HAS_LDBL_SPRINTF_BUG */
9873 need += 20; /* fudge factor */
9874 if (PL_efloatsize < need) {
9875 Safefree(PL_efloatbuf);
9876 PL_efloatsize = need + 20; /* more fudge */
9877 New(906, PL_efloatbuf, PL_efloatsize, char);
9878 PL_efloatbuf[0] = '\0';
9881 if ( !(width || left || plus || alt) && fill != '0'
9882 && has_precis && intsize != 'q' ) { /* Shortcuts */
9883 /* See earlier comment about buggy Gconvert when digits,
9885 if ( c == 'g' && precis) {
9886 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9887 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9888 goto float_converted;
9889 } else if ( c == 'f' && !precis) {
9890 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9894 eptr = ebuf + sizeof ebuf;
9897 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9898 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9899 if (intsize == 'q') {
9900 /* Copy the one or more characters in a long double
9901 * format before the 'base' ([efgEFG]) character to
9902 * the format string. */
9903 static char const prifldbl[] = PERL_PRIfldbl;
9904 char const *p = prifldbl + sizeof(prifldbl) - 3;
9905 while (p >= prifldbl) { *--eptr = *p--; }
9910 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9915 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9927 /* No taint. Otherwise we are in the strange situation
9928 * where printf() taints but print($float) doesn't.
9930 #if defined(HAS_LONG_DOUBLE)
9932 (void)sprintf(PL_efloatbuf, eptr, nv);
9934 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9936 (void)sprintf(PL_efloatbuf, eptr, nv);
9939 eptr = PL_efloatbuf;
9940 elen = strlen(PL_efloatbuf);
9946 i = SvCUR(sv) - origlen;
9947 if (args && !vectorize) {
9949 case 'h': *(va_arg(*args, short*)) = i; break;
9950 default: *(va_arg(*args, int*)) = i; break;
9951 case 'l': *(va_arg(*args, long*)) = i; break;
9952 case 'V': *(va_arg(*args, IV*)) = i; break;
9954 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9959 sv_setuv_mg(argsv, (UV)i);
9961 continue; /* not "break" */
9967 if (!args && ckWARN(WARN_PRINTF) &&
9968 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9969 SV *msg = sv_newmortal();
9970 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9971 (PL_op->op_type == OP_PRTF) ? "" : "s");
9974 Perl_sv_catpvf(aTHX_ msg,
9975 "\"%%%c\"", c & 0xFF);
9977 Perl_sv_catpvf(aTHX_ msg,
9978 "\"%%\\%03"UVof"\"",
9981 sv_catpv(msg, "end of string");
9982 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9985 /* output mangled stuff ... */
9991 /* ... right here, because formatting flags should not apply */
9992 SvGROW(sv, SvCUR(sv) + elen + 1);
9994 Copy(eptr, p, elen, char);
9997 SvCUR_set(sv, p - SvPVX(sv));
9999 continue; /* not "break" */
10002 /* calculate width before utf8_upgrade changes it */
10003 have = esignlen + zeros + elen;
10005 if (is_utf8 != has_utf8) {
10008 sv_utf8_upgrade(sv);
10011 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10012 sv_utf8_upgrade(nsv);
10016 SvGROW(sv, SvCUR(sv) + elen + 1);
10021 need = (have > width ? have : width);
10024 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10026 if (esignlen && fill == '0') {
10027 for (i = 0; i < (int)esignlen; i++)
10028 *p++ = esignbuf[i];
10030 if (gap && !left) {
10031 memset(p, fill, gap);
10034 if (esignlen && fill != '0') {
10035 for (i = 0; i < (int)esignlen; i++)
10036 *p++ = esignbuf[i];
10039 for (i = zeros; i; i--)
10043 Copy(eptr, p, elen, char);
10047 memset(p, ' ', gap);
10052 Copy(dotstr, p, dotstrlen, char);
10056 vectorize = FALSE; /* done iterating over vecstr */
10063 SvCUR_set(sv, p - SvPVX(sv));
10071 /* =========================================================================
10073 =head1 Cloning an interpreter
10075 All the macros and functions in this section are for the private use of
10076 the main function, perl_clone().
10078 The foo_dup() functions make an exact copy of an existing foo thinngy.
10079 During the course of a cloning, a hash table is used to map old addresses
10080 to new addresses. The table is created and manipulated with the
10081 ptr_table_* functions.
10085 ============================================================================*/
10088 #if defined(USE_ITHREADS)
10090 #ifndef GpREFCNT_inc
10091 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10095 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10096 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10097 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10098 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10099 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10100 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10101 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10102 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10103 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10104 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10105 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10106 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10107 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10110 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10111 regcomp.c. AMS 20010712 */
10114 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10119 struct reg_substr_datum *s;
10122 return (REGEXP *)NULL;
10124 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10127 len = r->offsets[0];
10128 npar = r->nparens+1;
10130 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10131 Copy(r->program, ret->program, len+1, regnode);
10133 New(0, ret->startp, npar, I32);
10134 Copy(r->startp, ret->startp, npar, I32);
10135 New(0, ret->endp, npar, I32);
10136 Copy(r->startp, ret->startp, npar, I32);
10138 New(0, ret->substrs, 1, struct reg_substr_data);
10139 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10140 s->min_offset = r->substrs->data[i].min_offset;
10141 s->max_offset = r->substrs->data[i].max_offset;
10142 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10143 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10146 ret->regstclass = NULL;
10148 struct reg_data *d;
10149 const int count = r->data->count;
10151 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10152 char, struct reg_data);
10153 New(0, d->what, count, U8);
10156 for (i = 0; i < count; i++) {
10157 d->what[i] = r->data->what[i];
10158 switch (d->what[i]) {
10159 /* legal options are one of: sfpont
10160 see also regcomp.h and pregfree() */
10162 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10165 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10168 /* This is cheating. */
10169 New(0, d->data[i], 1, struct regnode_charclass_class);
10170 StructCopy(r->data->data[i], d->data[i],
10171 struct regnode_charclass_class);
10172 ret->regstclass = (regnode*)d->data[i];
10175 /* Compiled op trees are readonly, and can thus be
10176 shared without duplication. */
10178 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10182 d->data[i] = r->data->data[i];
10185 d->data[i] = r->data->data[i];
10187 ((reg_trie_data*)d->data[i])->refcount++;
10191 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10200 New(0, ret->offsets, 2*len+1, U32);
10201 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10203 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10204 ret->refcnt = r->refcnt;
10205 ret->minlen = r->minlen;
10206 ret->prelen = r->prelen;
10207 ret->nparens = r->nparens;
10208 ret->lastparen = r->lastparen;
10209 ret->lastcloseparen = r->lastcloseparen;
10210 ret->reganch = r->reganch;
10212 ret->sublen = r->sublen;
10214 if (RX_MATCH_COPIED(ret))
10215 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10217 ret->subbeg = Nullch;
10218 #ifdef PERL_COPY_ON_WRITE
10219 ret->saved_copy = Nullsv;
10222 ptr_table_store(PL_ptr_table, r, ret);
10226 /* duplicate a file handle */
10229 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10235 return (PerlIO*)NULL;
10237 /* look for it in the table first */
10238 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10242 /* create anew and remember what it is */
10243 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10244 ptr_table_store(PL_ptr_table, fp, ret);
10248 /* duplicate a directory handle */
10251 Perl_dirp_dup(pTHX_ DIR *dp)
10259 /* duplicate a typeglob */
10262 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10267 /* look for it in the table first */
10268 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10272 /* create anew and remember what it is */
10273 Newz(0, ret, 1, GP);
10274 ptr_table_store(PL_ptr_table, gp, ret);
10277 ret->gp_refcnt = 0; /* must be before any other dups! */
10278 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10279 ret->gp_io = io_dup_inc(gp->gp_io, param);
10280 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10281 ret->gp_av = av_dup_inc(gp->gp_av, param);
10282 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10283 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10284 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10285 ret->gp_cvgen = gp->gp_cvgen;
10286 ret->gp_flags = gp->gp_flags;
10287 ret->gp_line = gp->gp_line;
10288 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10292 /* duplicate a chain of magic */
10295 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10297 MAGIC *mgprev = (MAGIC*)NULL;
10300 return (MAGIC*)NULL;
10301 /* look for it in the table first */
10302 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10306 for (; mg; mg = mg->mg_moremagic) {
10308 Newz(0, nmg, 1, MAGIC);
10310 mgprev->mg_moremagic = nmg;
10313 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10314 nmg->mg_private = mg->mg_private;
10315 nmg->mg_type = mg->mg_type;
10316 nmg->mg_flags = mg->mg_flags;
10317 if (mg->mg_type == PERL_MAGIC_qr) {
10318 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10320 else if(mg->mg_type == PERL_MAGIC_backref) {
10321 const AV * const av = (AV*) mg->mg_obj;
10324 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10326 for (i = AvFILLp(av); i >= 0; i--) {
10327 if (!svp[i]) continue;
10328 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10331 else if (mg->mg_type == PERL_MAGIC_symtab) {
10332 nmg->mg_obj = mg->mg_obj;
10335 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10336 ? sv_dup_inc(mg->mg_obj, param)
10337 : sv_dup(mg->mg_obj, param);
10339 nmg->mg_len = mg->mg_len;
10340 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10341 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10342 if (mg->mg_len > 0) {
10343 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10344 if (mg->mg_type == PERL_MAGIC_overload_table &&
10345 AMT_AMAGIC((AMT*)mg->mg_ptr))
10347 AMT *amtp = (AMT*)mg->mg_ptr;
10348 AMT *namtp = (AMT*)nmg->mg_ptr;
10350 for (i = 1; i < NofAMmeth; i++) {
10351 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10355 else if (mg->mg_len == HEf_SVKEY)
10356 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10358 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10359 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10366 /* create a new pointer-mapping table */
10369 Perl_ptr_table_new(pTHX)
10372 Newz(0, tbl, 1, PTR_TBL_t);
10373 tbl->tbl_max = 511;
10374 tbl->tbl_items = 0;
10375 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10380 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10382 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10390 struct ptr_tbl_ent* pte;
10391 struct ptr_tbl_ent* pteend;
10392 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10393 pte->next = PL_pte_arenaroot;
10394 PL_pte_arenaroot = pte;
10396 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10397 PL_pte_root = ++pte;
10398 while (pte < pteend) {
10399 pte->next = pte + 1;
10405 STATIC struct ptr_tbl_ent*
10408 struct ptr_tbl_ent* pte;
10412 PL_pte_root = pte->next;
10417 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10419 p->next = PL_pte_root;
10423 /* map an existing pointer using a table */
10426 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10428 PTR_TBL_ENT_t *tblent;
10429 const UV hash = PTR_TABLE_HASH(sv);
10431 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10432 for (; tblent; tblent = tblent->next) {
10433 if (tblent->oldval == sv)
10434 return tblent->newval;
10436 return (void*)NULL;
10439 /* add a new entry to a pointer-mapping table */
10442 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10444 PTR_TBL_ENT_t *tblent, **otblent;
10445 /* XXX this may be pessimal on platforms where pointers aren't good
10446 * hash values e.g. if they grow faster in the most significant
10448 const UV hash = PTR_TABLE_HASH(oldv);
10452 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10453 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10454 if (tblent->oldval == oldv) {
10455 tblent->newval = newv;
10459 tblent = S_new_pte(aTHX);
10460 tblent->oldval = oldv;
10461 tblent->newval = newv;
10462 tblent->next = *otblent;
10465 if (!empty && tbl->tbl_items > tbl->tbl_max)
10466 ptr_table_split(tbl);
10469 /* double the hash bucket size of an existing ptr table */
10472 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10474 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10475 const UV oldsize = tbl->tbl_max + 1;
10476 UV newsize = oldsize * 2;
10479 Renew(ary, newsize, PTR_TBL_ENT_t*);
10480 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10481 tbl->tbl_max = --newsize;
10482 tbl->tbl_ary = ary;
10483 for (i=0; i < oldsize; i++, ary++) {
10484 PTR_TBL_ENT_t **curentp, **entp, *ent;
10487 curentp = ary + oldsize;
10488 for (entp = ary, ent = *ary; ent; ent = *entp) {
10489 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10491 ent->next = *curentp;
10501 /* remove all the entries from a ptr table */
10504 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10506 register PTR_TBL_ENT_t **array;
10507 register PTR_TBL_ENT_t *entry;
10511 if (!tbl || !tbl->tbl_items) {
10515 array = tbl->tbl_ary;
10517 max = tbl->tbl_max;
10521 PTR_TBL_ENT_t *oentry = entry;
10522 entry = entry->next;
10523 S_del_pte(aTHX_ oentry);
10526 if (++riter > max) {
10529 entry = array[riter];
10533 tbl->tbl_items = 0;
10536 /* clear and free a ptr table */
10539 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10544 ptr_table_clear(tbl);
10545 Safefree(tbl->tbl_ary);
10549 /* attempt to make everything in the typeglob readonly */
10552 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10554 GV *gv = (GV*)sstr;
10555 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10557 if (GvIO(gv) || GvFORM(gv)) {
10558 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10560 else if (!GvCV(gv)) {
10561 GvCV(gv) = (CV*)sv;
10564 /* CvPADLISTs cannot be shared */
10565 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10570 if (!GvUNIQUE(gv)) {
10572 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10573 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10579 * write attempts will die with
10580 * "Modification of a read-only value attempted"
10586 SvREADONLY_on(GvSV(gv));
10590 GvAV(gv) = (AV*)sv;
10593 SvREADONLY_on(GvAV(gv));
10597 GvHV(gv) = (HV*)sv;
10600 SvREADONLY_on(GvHV(gv));
10603 return sstr; /* he_dup() will SvREFCNT_inc() */
10606 /* duplicate an SV of any type (including AV, HV etc) */
10609 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10612 SvRV_set(dstr, SvWEAKREF(sstr)
10613 ? sv_dup(SvRV(sstr), param)
10614 : sv_dup_inc(SvRV(sstr), param));
10617 else if (SvPVX(sstr)) {
10618 /* Has something there */
10620 /* Normal PV - clone whole allocated space */
10621 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1));
10622 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10623 /* Not that normal - actually sstr is copy on write.
10624 But we are a true, independant SV, so: */
10625 SvREADONLY_off(dstr);
10630 /* Special case - not normally malloced for some reason */
10631 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10632 /* A "shared" PV - clone it as unshared string */
10633 if(SvPADTMP(sstr)) {
10634 /* However, some of them live in the pad
10635 and they should not have these flags
10638 SvPV_set(dstr, sharepvn(SvPVX(sstr), SvCUR(sstr),
10640 SvUV_set(dstr, SvUVX(sstr));
10643 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvCUR(sstr)));
10645 SvREADONLY_off(dstr);
10649 /* Some other special case - random pointer */
10650 SvPV_set(dstr, SvPVX(sstr));
10655 /* Copy the Null */
10656 if (SvTYPE(dstr) == SVt_RV)
10657 SvRV_set(dstr, NULL);
10664 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10669 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10671 /* look for it in the table first */
10672 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10676 if(param->flags & CLONEf_JOIN_IN) {
10677 /** We are joining here so we don't want do clone
10678 something that is bad **/
10679 const char *hvname;
10681 if(SvTYPE(sstr) == SVt_PVHV &&
10682 (hvname = HvNAME_get(sstr))) {
10683 /** don't clone stashes if they already exist **/
10684 HV* old_stash = gv_stashpv(hvname,0);
10685 return (SV*) old_stash;
10689 /* create anew and remember what it is */
10692 #ifdef DEBUG_LEAKING_SCALARS
10693 dstr->sv_debug_optype = sstr->sv_debug_optype;
10694 dstr->sv_debug_line = sstr->sv_debug_line;
10695 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10696 dstr->sv_debug_cloned = 1;
10698 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10700 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10704 ptr_table_store(PL_ptr_table, sstr, dstr);
10707 SvFLAGS(dstr) = SvFLAGS(sstr);
10708 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10709 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10712 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10713 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10714 PL_watch_pvx, SvPVX(sstr));
10717 /* don't clone objects whose class has asked us not to */
10718 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10719 SvFLAGS(dstr) &= ~SVTYPEMASK;
10720 SvOBJECT_off(dstr);
10724 switch (SvTYPE(sstr)) {
10726 SvANY(dstr) = NULL;
10729 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.sv_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10730 SvIV_set(dstr, SvIVX(sstr));
10733 SvANY(dstr) = new_XNV();
10734 SvNV_set(dstr, SvNVX(sstr));
10737 SvANY(dstr) = &(dstr->sv_u.sv_rv);
10738 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10741 SvANY(dstr) = new_XPV();
10742 SvCUR_set(dstr, SvCUR(sstr));
10743 SvLEN_set(dstr, SvLEN(sstr));
10744 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10747 SvANY(dstr) = new_XPVIV();
10748 SvCUR_set(dstr, SvCUR(sstr));
10749 SvLEN_set(dstr, SvLEN(sstr));
10750 SvIV_set(dstr, SvIVX(sstr));
10751 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10754 SvANY(dstr) = new_XPVNV();
10755 SvCUR_set(dstr, SvCUR(sstr));
10756 SvLEN_set(dstr, SvLEN(sstr));
10757 SvIV_set(dstr, SvIVX(sstr));
10758 SvNV_set(dstr, SvNVX(sstr));
10759 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10762 SvANY(dstr) = new_XPVMG();
10763 SvCUR_set(dstr, SvCUR(sstr));
10764 SvLEN_set(dstr, SvLEN(sstr));
10765 SvIV_set(dstr, SvIVX(sstr));
10766 SvNV_set(dstr, SvNVX(sstr));
10767 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10768 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10769 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10772 SvANY(dstr) = new_XPVBM();
10773 SvCUR_set(dstr, SvCUR(sstr));
10774 SvLEN_set(dstr, SvLEN(sstr));
10775 SvIV_set(dstr, SvIVX(sstr));
10776 SvNV_set(dstr, SvNVX(sstr));
10777 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10778 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10779 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10780 BmRARE(dstr) = BmRARE(sstr);
10781 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10782 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10785 SvANY(dstr) = new_XPVLV();
10786 SvCUR_set(dstr, SvCUR(sstr));
10787 SvLEN_set(dstr, SvLEN(sstr));
10788 SvIV_set(dstr, SvIVX(sstr));
10789 SvNV_set(dstr, SvNVX(sstr));
10790 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10791 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10792 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10793 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10794 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10795 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10796 LvTARG(dstr) = dstr;
10797 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10798 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10800 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10801 LvTYPE(dstr) = LvTYPE(sstr);
10804 if (GvUNIQUE((GV*)sstr)) {
10806 if ((share = gv_share(sstr, param))) {
10809 ptr_table_store(PL_ptr_table, sstr, dstr);
10811 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10812 HvNAME_get(GvSTASH(share)), GvNAME(share));
10817 SvANY(dstr) = new_XPVGV();
10818 SvCUR_set(dstr, SvCUR(sstr));
10819 SvLEN_set(dstr, SvLEN(sstr));
10820 SvIV_set(dstr, SvIVX(sstr));
10821 SvNV_set(dstr, SvNVX(sstr));
10822 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10823 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10824 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10825 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10826 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10827 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10828 GvFLAGS(dstr) = GvFLAGS(sstr);
10829 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10830 (void)GpREFCNT_inc(GvGP(dstr));
10833 SvANY(dstr) = new_XPVIO();
10834 SvCUR_set(dstr, SvCUR(sstr));
10835 SvLEN_set(dstr, SvLEN(sstr));
10836 SvIV_set(dstr, SvIVX(sstr));
10837 SvNV_set(dstr, SvNVX(sstr));
10838 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10839 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10840 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10841 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10842 if (IoOFP(sstr) == IoIFP(sstr))
10843 IoOFP(dstr) = IoIFP(dstr);
10845 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10846 /* PL_rsfp_filters entries have fake IoDIRP() */
10847 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10848 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10850 IoDIRP(dstr) = IoDIRP(sstr);
10851 IoLINES(dstr) = IoLINES(sstr);
10852 IoPAGE(dstr) = IoPAGE(sstr);
10853 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10854 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10855 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10856 /* I have no idea why fake dirp (rsfps)
10857 should be treaded differently but otherwise
10858 we end up with leaks -- sky*/
10859 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10860 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10861 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10863 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10864 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10865 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10867 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10868 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10869 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10870 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10871 IoTYPE(dstr) = IoTYPE(sstr);
10872 IoFLAGS(dstr) = IoFLAGS(sstr);
10875 SvANY(dstr) = new_XPVAV();
10876 SvCUR_set(dstr, SvCUR(sstr));
10877 SvLEN_set(dstr, SvLEN(sstr));
10878 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10879 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10880 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10881 if (AvARRAY((AV*)sstr)) {
10882 SV **dst_ary, **src_ary;
10883 SSize_t items = AvFILLp((AV*)sstr) + 1;
10885 src_ary = AvARRAY((AV*)sstr);
10886 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10887 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10888 SvPV_set(dstr, (char*)dst_ary);
10889 AvALLOC((AV*)dstr) = dst_ary;
10890 if (AvREAL((AV*)sstr)) {
10891 while (items-- > 0)
10892 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10895 while (items-- > 0)
10896 *dst_ary++ = sv_dup(*src_ary++, param);
10898 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10899 while (items-- > 0) {
10900 *dst_ary++ = &PL_sv_undef;
10904 SvPV_set(dstr, Nullch);
10905 AvALLOC((AV*)dstr) = (SV**)NULL;
10909 SvANY(dstr) = new_XPVHV();
10910 SvCUR_set(dstr, SvCUR(sstr));
10911 SvLEN_set(dstr, SvLEN(sstr));
10912 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10913 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10914 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10916 const char *hvname = HvNAME_get((HV*)sstr);
10917 struct xpvhv_aux *aux = ((XPVHV *)SvANY(sstr))->xhv_aux;
10919 ((XPVHV *)SvANY(dstr))->xhv_aux = 0;
10921 HvRITER_set((HV*)dstr, HvRITER_get((HV*)sstr));
10922 /* FIXME strlen HvNAME */
10923 Perl_hv_name_set(aTHX_ (HV*) dstr, hvname,
10924 hvname ? strlen(hvname) : 0,
10927 if (HvARRAY((HV*)sstr)) {
10929 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10930 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10932 /* FIXME - surely this doesn't need to be zeroed? */
10934 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10935 HvARRAY(dstr) = (HE**)darray;
10936 while (i <= sxhv->xhv_max) {
10938 = he_dup(HvARRAY(sstr)[i],
10939 (bool)!!HvSHAREKEYS(sstr), param);
10942 HvEITER_set(dstr, he_dup(HvEITER_get(sstr),
10943 (bool)!!HvSHAREKEYS(sstr), param));
10946 SvPV_set(dstr, Nullch);
10947 HvEITER_set((HV*)dstr, (HE*)NULL);
10949 /* Record stashes for possible cloning in Perl_clone(). */
10951 av_push(param->stashes, dstr);
10955 SvANY(dstr) = new_XPVFM();
10956 FmLINES(dstr) = FmLINES(sstr);
10960 SvANY(dstr) = new_XPVCV();
10962 SvCUR_set(dstr, SvCUR(sstr));
10963 SvLEN_set(dstr, SvLEN(sstr));
10964 SvIV_set(dstr, SvIVX(sstr));
10965 SvNV_set(dstr, SvNVX(sstr));
10966 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10967 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10968 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10969 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10970 CvSTART(dstr) = CvSTART(sstr);
10972 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10974 CvXSUB(dstr) = CvXSUB(sstr);
10975 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10976 if (CvCONST(sstr)) {
10977 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10978 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10979 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
10981 /* don't dup if copying back - CvGV isn't refcounted, so the
10982 * duped GV may never be freed. A bit of a hack! DAPM */
10983 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10984 Nullgv : gv_dup(CvGV(sstr), param) ;
10985 if (param->flags & CLONEf_COPY_STACKS) {
10986 CvDEPTH(dstr) = CvDEPTH(sstr);
10990 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10991 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10993 CvWEAKOUTSIDE(sstr)
10994 ? cv_dup( CvOUTSIDE(sstr), param)
10995 : cv_dup_inc(CvOUTSIDE(sstr), param);
10996 CvFLAGS(dstr) = CvFLAGS(sstr);
10997 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11000 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11004 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11010 /* duplicate a context */
11013 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11015 PERL_CONTEXT *ncxs;
11018 return (PERL_CONTEXT*)NULL;
11020 /* look for it in the table first */
11021 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11025 /* create anew and remember what it is */
11026 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11027 ptr_table_store(PL_ptr_table, cxs, ncxs);
11030 PERL_CONTEXT *cx = &cxs[ix];
11031 PERL_CONTEXT *ncx = &ncxs[ix];
11032 ncx->cx_type = cx->cx_type;
11033 if (CxTYPE(cx) == CXt_SUBST) {
11034 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11037 ncx->blk_oldsp = cx->blk_oldsp;
11038 ncx->blk_oldcop = cx->blk_oldcop;
11039 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11040 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11041 ncx->blk_oldpm = cx->blk_oldpm;
11042 ncx->blk_gimme = cx->blk_gimme;
11043 switch (CxTYPE(cx)) {
11045 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11046 ? cv_dup_inc(cx->blk_sub.cv, param)
11047 : cv_dup(cx->blk_sub.cv,param));
11048 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11049 ? av_dup_inc(cx->blk_sub.argarray, param)
11051 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11052 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11053 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11054 ncx->blk_sub.lval = cx->blk_sub.lval;
11055 ncx->blk_sub.retop = cx->blk_sub.retop;
11058 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11059 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11060 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11061 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11062 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11063 ncx->blk_eval.retop = cx->blk_eval.retop;
11066 ncx->blk_loop.label = cx->blk_loop.label;
11067 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11068 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11069 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11070 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11071 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11072 ? cx->blk_loop.iterdata
11073 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11074 ncx->blk_loop.oldcomppad
11075 = (PAD*)ptr_table_fetch(PL_ptr_table,
11076 cx->blk_loop.oldcomppad);
11077 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11078 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11079 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11080 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11081 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11084 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11085 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11086 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11087 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11088 ncx->blk_sub.retop = cx->blk_sub.retop;
11100 /* duplicate a stack info structure */
11103 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11108 return (PERL_SI*)NULL;
11110 /* look for it in the table first */
11111 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11115 /* create anew and remember what it is */
11116 Newz(56, nsi, 1, PERL_SI);
11117 ptr_table_store(PL_ptr_table, si, nsi);
11119 nsi->si_stack = av_dup_inc(si->si_stack, param);
11120 nsi->si_cxix = si->si_cxix;
11121 nsi->si_cxmax = si->si_cxmax;
11122 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11123 nsi->si_type = si->si_type;
11124 nsi->si_prev = si_dup(si->si_prev, param);
11125 nsi->si_next = si_dup(si->si_next, param);
11126 nsi->si_markoff = si->si_markoff;
11131 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11132 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11133 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11134 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11135 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11136 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11137 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11138 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11139 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11140 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11141 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11142 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11143 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11144 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11147 #define pv_dup_inc(p) SAVEPV(p)
11148 #define pv_dup(p) SAVEPV(p)
11149 #define svp_dup_inc(p,pp) any_dup(p,pp)
11151 /* map any object to the new equivent - either something in the
11152 * ptr table, or something in the interpreter structure
11156 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11161 return (void*)NULL;
11163 /* look for it in the table first */
11164 ret = ptr_table_fetch(PL_ptr_table, v);
11168 /* see if it is part of the interpreter structure */
11169 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11170 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11178 /* duplicate the save stack */
11181 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11183 ANY *ss = proto_perl->Tsavestack;
11184 I32 ix = proto_perl->Tsavestack_ix;
11185 I32 max = proto_perl->Tsavestack_max;
11198 void (*dptr) (void*);
11199 void (*dxptr) (pTHX_ void*);
11202 Newz(54, nss, max, ANY);
11206 TOPINT(nss,ix) = i;
11208 case SAVEt_ITEM: /* normal string */
11209 sv = (SV*)POPPTR(ss,ix);
11210 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11211 sv = (SV*)POPPTR(ss,ix);
11212 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11214 case SAVEt_SV: /* scalar reference */
11215 sv = (SV*)POPPTR(ss,ix);
11216 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11217 gv = (GV*)POPPTR(ss,ix);
11218 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11220 case SAVEt_GENERIC_PVREF: /* generic char* */
11221 c = (char*)POPPTR(ss,ix);
11222 TOPPTR(nss,ix) = pv_dup(c);
11223 ptr = POPPTR(ss,ix);
11224 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11226 case SAVEt_SHARED_PVREF: /* char* in shared space */
11227 c = (char*)POPPTR(ss,ix);
11228 TOPPTR(nss,ix) = savesharedpv(c);
11229 ptr = POPPTR(ss,ix);
11230 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11232 case SAVEt_GENERIC_SVREF: /* generic sv */
11233 case SAVEt_SVREF: /* scalar reference */
11234 sv = (SV*)POPPTR(ss,ix);
11235 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11236 ptr = POPPTR(ss,ix);
11237 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11239 case SAVEt_AV: /* array reference */
11240 av = (AV*)POPPTR(ss,ix);
11241 TOPPTR(nss,ix) = av_dup_inc(av, param);
11242 gv = (GV*)POPPTR(ss,ix);
11243 TOPPTR(nss,ix) = gv_dup(gv, param);
11245 case SAVEt_HV: /* hash reference */
11246 hv = (HV*)POPPTR(ss,ix);
11247 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11248 gv = (GV*)POPPTR(ss,ix);
11249 TOPPTR(nss,ix) = gv_dup(gv, param);
11251 case SAVEt_INT: /* int reference */
11252 ptr = POPPTR(ss,ix);
11253 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11254 intval = (int)POPINT(ss,ix);
11255 TOPINT(nss,ix) = intval;
11257 case SAVEt_LONG: /* long reference */
11258 ptr = POPPTR(ss,ix);
11259 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11260 longval = (long)POPLONG(ss,ix);
11261 TOPLONG(nss,ix) = longval;
11263 case SAVEt_I32: /* I32 reference */
11264 case SAVEt_I16: /* I16 reference */
11265 case SAVEt_I8: /* I8 reference */
11266 ptr = POPPTR(ss,ix);
11267 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11269 TOPINT(nss,ix) = i;
11271 case SAVEt_IV: /* IV reference */
11272 ptr = POPPTR(ss,ix);
11273 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11275 TOPIV(nss,ix) = iv;
11277 case SAVEt_SPTR: /* SV* reference */
11278 ptr = POPPTR(ss,ix);
11279 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11280 sv = (SV*)POPPTR(ss,ix);
11281 TOPPTR(nss,ix) = sv_dup(sv, param);
11283 case SAVEt_VPTR: /* random* reference */
11284 ptr = POPPTR(ss,ix);
11285 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11286 ptr = POPPTR(ss,ix);
11287 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11289 case SAVEt_PPTR: /* char* reference */
11290 ptr = POPPTR(ss,ix);
11291 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11292 c = (char*)POPPTR(ss,ix);
11293 TOPPTR(nss,ix) = pv_dup(c);
11295 case SAVEt_HPTR: /* HV* reference */
11296 ptr = POPPTR(ss,ix);
11297 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11298 hv = (HV*)POPPTR(ss,ix);
11299 TOPPTR(nss,ix) = hv_dup(hv, param);
11301 case SAVEt_APTR: /* AV* reference */
11302 ptr = POPPTR(ss,ix);
11303 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11304 av = (AV*)POPPTR(ss,ix);
11305 TOPPTR(nss,ix) = av_dup(av, param);
11308 gv = (GV*)POPPTR(ss,ix);
11309 TOPPTR(nss,ix) = gv_dup(gv, param);
11311 case SAVEt_GP: /* scalar reference */
11312 gp = (GP*)POPPTR(ss,ix);
11313 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11314 (void)GpREFCNT_inc(gp);
11315 gv = (GV*)POPPTR(ss,ix);
11316 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11317 c = (char*)POPPTR(ss,ix);
11318 TOPPTR(nss,ix) = pv_dup(c);
11320 TOPIV(nss,ix) = iv;
11322 TOPIV(nss,ix) = iv;
11325 case SAVEt_MORTALIZESV:
11326 sv = (SV*)POPPTR(ss,ix);
11327 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11330 ptr = POPPTR(ss,ix);
11331 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11332 /* these are assumed to be refcounted properly */
11333 switch (((OP*)ptr)->op_type) {
11335 case OP_LEAVESUBLV:
11339 case OP_LEAVEWRITE:
11340 TOPPTR(nss,ix) = ptr;
11345 TOPPTR(nss,ix) = Nullop;
11350 TOPPTR(nss,ix) = Nullop;
11353 c = (char*)POPPTR(ss,ix);
11354 TOPPTR(nss,ix) = pv_dup_inc(c);
11356 case SAVEt_CLEARSV:
11357 longval = POPLONG(ss,ix);
11358 TOPLONG(nss,ix) = longval;
11361 hv = (HV*)POPPTR(ss,ix);
11362 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11363 c = (char*)POPPTR(ss,ix);
11364 TOPPTR(nss,ix) = pv_dup_inc(c);
11366 TOPINT(nss,ix) = i;
11368 case SAVEt_DESTRUCTOR:
11369 ptr = POPPTR(ss,ix);
11370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11371 dptr = POPDPTR(ss,ix);
11372 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11374 case SAVEt_DESTRUCTOR_X:
11375 ptr = POPPTR(ss,ix);
11376 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11377 dxptr = POPDXPTR(ss,ix);
11378 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11380 case SAVEt_REGCONTEXT:
11383 TOPINT(nss,ix) = i;
11386 case SAVEt_STACK_POS: /* Position on Perl stack */
11388 TOPINT(nss,ix) = i;
11390 case SAVEt_AELEM: /* array element */
11391 sv = (SV*)POPPTR(ss,ix);
11392 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11394 TOPINT(nss,ix) = i;
11395 av = (AV*)POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = av_dup_inc(av, param);
11398 case SAVEt_HELEM: /* hash element */
11399 sv = (SV*)POPPTR(ss,ix);
11400 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11401 sv = (SV*)POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11403 hv = (HV*)POPPTR(ss,ix);
11404 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11407 ptr = POPPTR(ss,ix);
11408 TOPPTR(nss,ix) = ptr;
11412 TOPINT(nss,ix) = i;
11414 case SAVEt_COMPPAD:
11415 av = (AV*)POPPTR(ss,ix);
11416 TOPPTR(nss,ix) = av_dup(av, param);
11419 longval = (long)POPLONG(ss,ix);
11420 TOPLONG(nss,ix) = longval;
11421 ptr = POPPTR(ss,ix);
11422 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11423 sv = (SV*)POPPTR(ss,ix);
11424 TOPPTR(nss,ix) = sv_dup(sv, param);
11427 ptr = POPPTR(ss,ix);
11428 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11429 longval = (long)POPBOOL(ss,ix);
11430 TOPBOOL(nss,ix) = (bool)longval;
11432 case SAVEt_SET_SVFLAGS:
11434 TOPINT(nss,ix) = i;
11436 TOPINT(nss,ix) = i;
11437 sv = (SV*)POPPTR(ss,ix);
11438 TOPPTR(nss,ix) = sv_dup(sv, param);
11441 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11449 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11450 * flag to the result. This is done for each stash before cloning starts,
11451 * so we know which stashes want their objects cloned */
11454 do_mark_cloneable_stash(pTHX_ SV *sv)
11456 const char *hvname = HvNAME_get((HV*)sv);
11458 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11459 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11460 if (cloner && GvCV(cloner)) {
11467 XPUSHs(sv_2mortal(newSVpv(hvname, 0)));
11469 call_sv((SV*)GvCV(cloner), G_SCALAR);
11476 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11484 =for apidoc perl_clone
11486 Create and return a new interpreter by cloning the current one.
11488 perl_clone takes these flags as parameters:
11490 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11491 without it we only clone the data and zero the stacks,
11492 with it we copy the stacks and the new perl interpreter is
11493 ready to run at the exact same point as the previous one.
11494 The pseudo-fork code uses COPY_STACKS while the
11495 threads->new doesn't.
11497 CLONEf_KEEP_PTR_TABLE
11498 perl_clone keeps a ptr_table with the pointer of the old
11499 variable as a key and the new variable as a value,
11500 this allows it to check if something has been cloned and not
11501 clone it again but rather just use the value and increase the
11502 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11503 the ptr_table using the function
11504 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11505 reason to keep it around is if you want to dup some of your own
11506 variable who are outside the graph perl scans, example of this
11507 code is in threads.xs create
11510 This is a win32 thing, it is ignored on unix, it tells perls
11511 win32host code (which is c++) to clone itself, this is needed on
11512 win32 if you want to run two threads at the same time,
11513 if you just want to do some stuff in a separate perl interpreter
11514 and then throw it away and return to the original one,
11515 you don't need to do anything.
11520 /* XXX the above needs expanding by someone who actually understands it ! */
11521 EXTERN_C PerlInterpreter *
11522 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11525 perl_clone(PerlInterpreter *proto_perl, UV flags)
11528 #ifdef PERL_IMPLICIT_SYS
11530 /* perlhost.h so we need to call into it
11531 to clone the host, CPerlHost should have a c interface, sky */
11533 if (flags & CLONEf_CLONE_HOST) {
11534 return perl_clone_host(proto_perl,flags);
11536 return perl_clone_using(proto_perl, flags,
11538 proto_perl->IMemShared,
11539 proto_perl->IMemParse,
11541 proto_perl->IStdIO,
11545 proto_perl->IProc);
11549 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11550 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11551 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11552 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11553 struct IPerlDir* ipD, struct IPerlSock* ipS,
11554 struct IPerlProc* ipP)
11556 /* XXX many of the string copies here can be optimized if they're
11557 * constants; they need to be allocated as common memory and just
11558 * their pointers copied. */
11561 CLONE_PARAMS clone_params;
11562 CLONE_PARAMS* param = &clone_params;
11564 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11565 /* for each stash, determine whether its objects should be cloned */
11566 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11567 PERL_SET_THX(my_perl);
11570 Poison(my_perl, 1, PerlInterpreter);
11572 PL_curcop = (COP *)Nullop;
11576 PL_savestack_ix = 0;
11577 PL_savestack_max = -1;
11578 PL_sig_pending = 0;
11579 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11580 # else /* !DEBUGGING */
11581 Zero(my_perl, 1, PerlInterpreter);
11582 # endif /* DEBUGGING */
11584 /* host pointers */
11586 PL_MemShared = ipMS;
11587 PL_MemParse = ipMP;
11594 #else /* !PERL_IMPLICIT_SYS */
11596 CLONE_PARAMS clone_params;
11597 CLONE_PARAMS* param = &clone_params;
11598 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11599 /* for each stash, determine whether its objects should be cloned */
11600 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11601 PERL_SET_THX(my_perl);
11604 Poison(my_perl, 1, PerlInterpreter);
11606 PL_curcop = (COP *)Nullop;
11610 PL_savestack_ix = 0;
11611 PL_savestack_max = -1;
11612 PL_sig_pending = 0;
11613 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11614 # else /* !DEBUGGING */
11615 Zero(my_perl, 1, PerlInterpreter);
11616 # endif /* DEBUGGING */
11617 #endif /* PERL_IMPLICIT_SYS */
11618 param->flags = flags;
11619 param->proto_perl = proto_perl;
11622 PL_xnv_arenaroot = NULL;
11623 PL_xnv_root = NULL;
11624 PL_xpv_arenaroot = NULL;
11625 PL_xpv_root = NULL;
11626 PL_xpviv_arenaroot = NULL;
11627 PL_xpviv_root = NULL;
11628 PL_xpvnv_arenaroot = NULL;
11629 PL_xpvnv_root = NULL;
11630 PL_xpvcv_arenaroot = NULL;
11631 PL_xpvcv_root = NULL;
11632 PL_xpvav_arenaroot = NULL;
11633 PL_xpvav_root = NULL;
11634 PL_xpvhv_arenaroot = NULL;
11635 PL_xpvhv_root = NULL;
11636 PL_xpvmg_arenaroot = NULL;
11637 PL_xpvmg_root = NULL;
11638 PL_xpvgv_arenaroot = NULL;
11639 PL_xpvgv_root = NULL;
11640 PL_xpvlv_arenaroot = NULL;
11641 PL_xpvlv_root = NULL;
11642 PL_xpvbm_arenaroot = NULL;
11643 PL_xpvbm_root = NULL;
11644 PL_he_arenaroot = NULL;
11646 #if defined(USE_ITHREADS)
11647 PL_pte_arenaroot = NULL;
11648 PL_pte_root = NULL;
11650 PL_nice_chunk = NULL;
11651 PL_nice_chunk_size = 0;
11653 PL_sv_objcount = 0;
11654 PL_sv_root = Nullsv;
11655 PL_sv_arenaroot = Nullsv;
11657 PL_debug = proto_perl->Idebug;
11659 PL_hash_seed = proto_perl->Ihash_seed;
11660 PL_rehash_seed = proto_perl->Irehash_seed;
11662 #ifdef USE_REENTRANT_API
11663 /* XXX: things like -Dm will segfault here in perlio, but doing
11664 * PERL_SET_CONTEXT(proto_perl);
11665 * breaks too many other things
11667 Perl_reentrant_init(aTHX);
11670 /* create SV map for pointer relocation */
11671 PL_ptr_table = ptr_table_new();
11672 /* and one for finding shared hash keys quickly */
11673 PL_shared_hek_table = ptr_table_new();
11675 /* initialize these special pointers as early as possible */
11676 SvANY(&PL_sv_undef) = NULL;
11677 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11678 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11679 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11681 SvANY(&PL_sv_no) = new_XPVNV();
11682 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11683 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11684 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11685 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11686 SvCUR_set(&PL_sv_no, 0);
11687 SvLEN_set(&PL_sv_no, 1);
11688 SvIV_set(&PL_sv_no, 0);
11689 SvNV_set(&PL_sv_no, 0);
11690 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11692 SvANY(&PL_sv_yes) = new_XPVNV();
11693 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11694 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11695 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11696 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11697 SvCUR_set(&PL_sv_yes, 1);
11698 SvLEN_set(&PL_sv_yes, 2);
11699 SvIV_set(&PL_sv_yes, 1);
11700 SvNV_set(&PL_sv_yes, 1);
11701 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11703 /* create (a non-shared!) shared string table */
11704 PL_strtab = newHV();
11705 HvSHAREKEYS_off(PL_strtab);
11706 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11707 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11709 PL_compiling = proto_perl->Icompiling;
11711 /* These two PVs will be free'd special way so must set them same way op.c does */
11712 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11713 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11715 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11716 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11718 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11719 if (!specialWARN(PL_compiling.cop_warnings))
11720 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11721 if (!specialCopIO(PL_compiling.cop_io))
11722 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11723 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11725 /* pseudo environmental stuff */
11726 PL_origargc = proto_perl->Iorigargc;
11727 PL_origargv = proto_perl->Iorigargv;
11729 param->stashes = newAV(); /* Setup array of objects to call clone on */
11731 #ifdef PERLIO_LAYERS
11732 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11733 PerlIO_clone(aTHX_ proto_perl, param);
11736 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11737 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11738 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11739 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11740 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11741 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11744 PL_minus_c = proto_perl->Iminus_c;
11745 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11746 PL_localpatches = proto_perl->Ilocalpatches;
11747 PL_splitstr = proto_perl->Isplitstr;
11748 PL_preprocess = proto_perl->Ipreprocess;
11749 PL_minus_n = proto_perl->Iminus_n;
11750 PL_minus_p = proto_perl->Iminus_p;
11751 PL_minus_l = proto_perl->Iminus_l;
11752 PL_minus_a = proto_perl->Iminus_a;
11753 PL_minus_F = proto_perl->Iminus_F;
11754 PL_doswitches = proto_perl->Idoswitches;
11755 PL_dowarn = proto_perl->Idowarn;
11756 PL_doextract = proto_perl->Idoextract;
11757 PL_sawampersand = proto_perl->Isawampersand;
11758 PL_unsafe = proto_perl->Iunsafe;
11759 PL_inplace = SAVEPV(proto_perl->Iinplace);
11760 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11761 PL_perldb = proto_perl->Iperldb;
11762 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11763 PL_exit_flags = proto_perl->Iexit_flags;
11765 /* magical thingies */
11766 /* XXX time(&PL_basetime) when asked for? */
11767 PL_basetime = proto_perl->Ibasetime;
11768 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11770 PL_maxsysfd = proto_perl->Imaxsysfd;
11771 PL_multiline = proto_perl->Imultiline;
11772 PL_statusvalue = proto_perl->Istatusvalue;
11774 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11776 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11778 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11779 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11780 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11782 /* Clone the regex array */
11783 PL_regex_padav = newAV();
11785 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11786 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11787 av_push(PL_regex_padav,
11788 sv_dup_inc(regexen[0],param));
11789 for(i = 1; i <= len; i++) {
11790 if(SvREPADTMP(regexen[i])) {
11791 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11793 av_push(PL_regex_padav,
11795 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11796 SvIVX(regexen[i])), param)))
11801 PL_regex_pad = AvARRAY(PL_regex_padav);
11803 /* shortcuts to various I/O objects */
11804 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11805 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11806 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11807 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11808 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11809 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11811 /* shortcuts to regexp stuff */
11812 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11814 /* shortcuts to misc objects */
11815 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11817 /* shortcuts to debugging objects */
11818 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11819 PL_DBline = gv_dup(proto_perl->IDBline, param);
11820 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11821 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11822 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11823 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11824 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11825 PL_lineary = av_dup(proto_perl->Ilineary, param);
11826 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11828 /* symbol tables */
11829 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11830 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11831 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11832 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11833 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11835 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11836 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11837 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11838 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11839 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11840 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11842 PL_sub_generation = proto_perl->Isub_generation;
11844 /* funky return mechanisms */
11845 PL_forkprocess = proto_perl->Iforkprocess;
11847 /* subprocess state */
11848 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11850 /* internal state */
11851 PL_tainting = proto_perl->Itainting;
11852 PL_taint_warn = proto_perl->Itaint_warn;
11853 PL_maxo = proto_perl->Imaxo;
11854 if (proto_perl->Iop_mask)
11855 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11857 PL_op_mask = Nullch;
11858 /* PL_asserting = proto_perl->Iasserting; */
11860 /* current interpreter roots */
11861 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11862 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11863 PL_main_start = proto_perl->Imain_start;
11864 PL_eval_root = proto_perl->Ieval_root;
11865 PL_eval_start = proto_perl->Ieval_start;
11867 /* runtime control stuff */
11868 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11869 PL_copline = proto_perl->Icopline;
11871 PL_filemode = proto_perl->Ifilemode;
11872 PL_lastfd = proto_perl->Ilastfd;
11873 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11876 PL_gensym = proto_perl->Igensym;
11877 PL_preambled = proto_perl->Ipreambled;
11878 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11879 PL_laststatval = proto_perl->Ilaststatval;
11880 PL_laststype = proto_perl->Ilaststype;
11881 PL_mess_sv = Nullsv;
11883 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11884 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11886 /* interpreter atexit processing */
11887 PL_exitlistlen = proto_perl->Iexitlistlen;
11888 if (PL_exitlistlen) {
11889 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11890 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11893 PL_exitlist = (PerlExitListEntry*)NULL;
11894 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11895 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11896 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11898 PL_profiledata = NULL;
11899 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11900 /* PL_rsfp_filters entries have fake IoDIRP() */
11901 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11903 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11905 PAD_CLONE_VARS(proto_perl, param);
11907 #ifdef HAVE_INTERP_INTERN
11908 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11911 /* more statics moved here */
11912 PL_generation = proto_perl->Igeneration;
11913 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11915 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11916 PL_in_clean_all = proto_perl->Iin_clean_all;
11918 PL_uid = proto_perl->Iuid;
11919 PL_euid = proto_perl->Ieuid;
11920 PL_gid = proto_perl->Igid;
11921 PL_egid = proto_perl->Iegid;
11922 PL_nomemok = proto_perl->Inomemok;
11923 PL_an = proto_perl->Ian;
11924 PL_evalseq = proto_perl->Ievalseq;
11925 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11926 PL_origalen = proto_perl->Iorigalen;
11927 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11928 PL_osname = SAVEPV(proto_perl->Iosname);
11929 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11930 PL_sighandlerp = proto_perl->Isighandlerp;
11933 PL_runops = proto_perl->Irunops;
11935 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11938 PL_cshlen = proto_perl->Icshlen;
11939 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11942 PL_lex_state = proto_perl->Ilex_state;
11943 PL_lex_defer = proto_perl->Ilex_defer;
11944 PL_lex_expect = proto_perl->Ilex_expect;
11945 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11946 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11947 PL_lex_starts = proto_perl->Ilex_starts;
11948 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11949 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11950 PL_lex_op = proto_perl->Ilex_op;
11951 PL_lex_inpat = proto_perl->Ilex_inpat;
11952 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11953 PL_lex_brackets = proto_perl->Ilex_brackets;
11954 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11955 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11956 PL_lex_casemods = proto_perl->Ilex_casemods;
11957 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11958 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11960 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11961 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11962 PL_nexttoke = proto_perl->Inexttoke;
11964 /* XXX This is probably masking the deeper issue of why
11965 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11966 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11967 * (A little debugging with a watchpoint on it may help.)
11969 if (SvANY(proto_perl->Ilinestr)) {
11970 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11971 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11972 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11973 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11974 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11975 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11976 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11977 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11978 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11981 PL_linestr = NEWSV(65,79);
11982 sv_upgrade(PL_linestr,SVt_PVIV);
11983 sv_setpvn(PL_linestr,"",0);
11984 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11986 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11987 PL_pending_ident = proto_perl->Ipending_ident;
11988 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11990 PL_expect = proto_perl->Iexpect;
11992 PL_multi_start = proto_perl->Imulti_start;
11993 PL_multi_end = proto_perl->Imulti_end;
11994 PL_multi_open = proto_perl->Imulti_open;
11995 PL_multi_close = proto_perl->Imulti_close;
11997 PL_error_count = proto_perl->Ierror_count;
11998 PL_subline = proto_perl->Isubline;
11999 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12001 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12002 if (SvANY(proto_perl->Ilinestr)) {
12003 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
12004 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12005 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
12006 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12007 PL_last_lop_op = proto_perl->Ilast_lop_op;
12010 PL_last_uni = SvPVX(PL_linestr);
12011 PL_last_lop = SvPVX(PL_linestr);
12012 PL_last_lop_op = 0;
12014 PL_in_my = proto_perl->Iin_my;
12015 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12017 PL_cryptseen = proto_perl->Icryptseen;
12020 PL_hints = proto_perl->Ihints;
12022 PL_amagic_generation = proto_perl->Iamagic_generation;
12024 #ifdef USE_LOCALE_COLLATE
12025 PL_collation_ix = proto_perl->Icollation_ix;
12026 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12027 PL_collation_standard = proto_perl->Icollation_standard;
12028 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12029 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12030 #endif /* USE_LOCALE_COLLATE */
12032 #ifdef USE_LOCALE_NUMERIC
12033 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12034 PL_numeric_standard = proto_perl->Inumeric_standard;
12035 PL_numeric_local = proto_perl->Inumeric_local;
12036 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12037 #endif /* !USE_LOCALE_NUMERIC */
12039 /* utf8 character classes */
12040 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12041 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12042 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12043 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12044 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12045 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12046 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12047 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12048 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12049 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12050 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12051 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12052 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12053 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12054 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12055 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12056 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12057 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12058 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12059 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12061 /* Did the locale setup indicate UTF-8? */
12062 PL_utf8locale = proto_perl->Iutf8locale;
12063 /* Unicode features (see perlrun/-C) */
12064 PL_unicode = proto_perl->Iunicode;
12066 /* Pre-5.8 signals control */
12067 PL_signals = proto_perl->Isignals;
12069 /* times() ticks per second */
12070 PL_clocktick = proto_perl->Iclocktick;
12072 /* Recursion stopper for PerlIO_find_layer */
12073 PL_in_load_module = proto_perl->Iin_load_module;
12075 /* sort() routine */
12076 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12078 /* Not really needed/useful since the reenrant_retint is "volatile",
12079 * but do it for consistency's sake. */
12080 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12082 /* Hooks to shared SVs and locks. */
12083 PL_sharehook = proto_perl->Isharehook;
12084 PL_lockhook = proto_perl->Ilockhook;
12085 PL_unlockhook = proto_perl->Iunlockhook;
12086 PL_threadhook = proto_perl->Ithreadhook;
12088 PL_runops_std = proto_perl->Irunops_std;
12089 PL_runops_dbg = proto_perl->Irunops_dbg;
12091 #ifdef THREADS_HAVE_PIDS
12092 PL_ppid = proto_perl->Ippid;
12096 PL_last_swash_hv = Nullhv; /* reinits on demand */
12097 PL_last_swash_klen = 0;
12098 PL_last_swash_key[0]= '\0';
12099 PL_last_swash_tmps = (U8*)NULL;
12100 PL_last_swash_slen = 0;
12102 PL_glob_index = proto_perl->Iglob_index;
12103 PL_srand_called = proto_perl->Isrand_called;
12104 PL_uudmap['M'] = 0; /* reinits on demand */
12105 PL_bitcount = Nullch; /* reinits on demand */
12107 if (proto_perl->Ipsig_pend) {
12108 Newz(0, PL_psig_pend, SIG_SIZE, int);
12111 PL_psig_pend = (int*)NULL;
12114 if (proto_perl->Ipsig_ptr) {
12115 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12116 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12117 for (i = 1; i < SIG_SIZE; i++) {
12118 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12119 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12123 PL_psig_ptr = (SV**)NULL;
12124 PL_psig_name = (SV**)NULL;
12127 /* thrdvar.h stuff */
12129 if (flags & CLONEf_COPY_STACKS) {
12130 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12131 PL_tmps_ix = proto_perl->Ttmps_ix;
12132 PL_tmps_max = proto_perl->Ttmps_max;
12133 PL_tmps_floor = proto_perl->Ttmps_floor;
12134 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12136 while (i <= PL_tmps_ix) {
12137 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12141 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12142 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12143 Newz(54, PL_markstack, i, I32);
12144 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12145 - proto_perl->Tmarkstack);
12146 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12147 - proto_perl->Tmarkstack);
12148 Copy(proto_perl->Tmarkstack, PL_markstack,
12149 PL_markstack_ptr - PL_markstack + 1, I32);
12151 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12152 * NOTE: unlike the others! */
12153 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12154 PL_scopestack_max = proto_perl->Tscopestack_max;
12155 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12156 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12158 /* NOTE: si_dup() looks at PL_markstack */
12159 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12161 /* PL_curstack = PL_curstackinfo->si_stack; */
12162 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12163 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12165 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12166 PL_stack_base = AvARRAY(PL_curstack);
12167 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12168 - proto_perl->Tstack_base);
12169 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12171 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12172 * NOTE: unlike the others! */
12173 PL_savestack_ix = proto_perl->Tsavestack_ix;
12174 PL_savestack_max = proto_perl->Tsavestack_max;
12175 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12176 PL_savestack = ss_dup(proto_perl, param);
12180 ENTER; /* perl_destruct() wants to LEAVE; */
12183 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12184 PL_top_env = &PL_start_env;
12186 PL_op = proto_perl->Top;
12189 PL_Xpv = (XPV*)NULL;
12190 PL_na = proto_perl->Tna;
12192 PL_statbuf = proto_perl->Tstatbuf;
12193 PL_statcache = proto_perl->Tstatcache;
12194 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12195 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12197 PL_timesbuf = proto_perl->Ttimesbuf;
12200 PL_tainted = proto_perl->Ttainted;
12201 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12202 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12203 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12204 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12205 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12206 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12207 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12208 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12209 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12211 PL_restartop = proto_perl->Trestartop;
12212 PL_in_eval = proto_perl->Tin_eval;
12213 PL_delaymagic = proto_perl->Tdelaymagic;
12214 PL_dirty = proto_perl->Tdirty;
12215 PL_localizing = proto_perl->Tlocalizing;
12217 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12218 PL_hv_fetch_ent_mh = Nullhe;
12219 PL_modcount = proto_perl->Tmodcount;
12220 PL_lastgotoprobe = Nullop;
12221 PL_dumpindent = proto_perl->Tdumpindent;
12223 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12224 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12225 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12226 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12227 PL_sortcxix = proto_perl->Tsortcxix;
12228 PL_efloatbuf = Nullch; /* reinits on demand */
12229 PL_efloatsize = 0; /* reinits on demand */
12233 PL_screamfirst = NULL;
12234 PL_screamnext = NULL;
12235 PL_maxscream = -1; /* reinits on demand */
12236 PL_lastscream = Nullsv;
12238 PL_watchaddr = NULL;
12239 PL_watchok = Nullch;
12241 PL_regdummy = proto_perl->Tregdummy;
12242 PL_regprecomp = Nullch;
12245 PL_colorset = 0; /* reinits PL_colors[] */
12246 /*PL_colors[6] = {0,0,0,0,0,0};*/
12247 PL_reginput = Nullch;
12248 PL_regbol = Nullch;
12249 PL_regeol = Nullch;
12250 PL_regstartp = (I32*)NULL;
12251 PL_regendp = (I32*)NULL;
12252 PL_reglastparen = (U32*)NULL;
12253 PL_reglastcloseparen = (U32*)NULL;
12254 PL_regtill = Nullch;
12255 PL_reg_start_tmp = (char**)NULL;
12256 PL_reg_start_tmpl = 0;
12257 PL_regdata = (struct reg_data*)NULL;
12260 PL_reg_eval_set = 0;
12262 PL_regprogram = (regnode*)NULL;
12264 PL_regcc = (CURCUR*)NULL;
12265 PL_reg_call_cc = (struct re_cc_state*)NULL;
12266 PL_reg_re = (regexp*)NULL;
12267 PL_reg_ganch = Nullch;
12268 PL_reg_sv = Nullsv;
12269 PL_reg_match_utf8 = FALSE;
12270 PL_reg_magic = (MAGIC*)NULL;
12272 PL_reg_oldcurpm = (PMOP*)NULL;
12273 PL_reg_curpm = (PMOP*)NULL;
12274 PL_reg_oldsaved = Nullch;
12275 PL_reg_oldsavedlen = 0;
12276 #ifdef PERL_COPY_ON_WRITE
12279 PL_reg_maxiter = 0;
12280 PL_reg_leftiter = 0;
12281 PL_reg_poscache = Nullch;
12282 PL_reg_poscache_size= 0;
12284 /* RE engine - function pointers */
12285 PL_regcompp = proto_perl->Tregcompp;
12286 PL_regexecp = proto_perl->Tregexecp;
12287 PL_regint_start = proto_perl->Tregint_start;
12288 PL_regint_string = proto_perl->Tregint_string;
12289 PL_regfree = proto_perl->Tregfree;
12291 PL_reginterp_cnt = 0;
12292 PL_reg_starttry = 0;
12294 /* Pluggable optimizer */
12295 PL_peepp = proto_perl->Tpeepp;
12297 PL_stashcache = newHV();
12299 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12300 ptr_table_free(PL_ptr_table);
12301 PL_ptr_table = NULL;
12302 ptr_table_free(PL_shared_hek_table);
12303 PL_shared_hek_table = NULL;
12306 /* Call the ->CLONE method, if it exists, for each of the stashes
12307 identified by sv_dup() above.
12309 while(av_len(param->stashes) != -1) {
12310 HV* stash = (HV*) av_shift(param->stashes);
12311 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12312 if (cloner && GvCV(cloner)) {
12317 XPUSHs(sv_2mortal(newSVpv(HvNAME_get(stash), 0)));
12319 call_sv((SV*)GvCV(cloner), G_DISCARD);
12325 SvREFCNT_dec(param->stashes);
12327 /* orphaned? eg threads->new inside BEGIN or use */
12328 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12329 (void)SvREFCNT_inc(PL_compcv);
12330 SAVEFREESV(PL_compcv);
12336 #endif /* USE_ITHREADS */
12339 =head1 Unicode Support
12341 =for apidoc sv_recode_to_utf8
12343 The encoding is assumed to be an Encode object, on entry the PV
12344 of the sv is assumed to be octets in that encoding, and the sv
12345 will be converted into Unicode (and UTF-8).
12347 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12348 is not a reference, nothing is done to the sv. If the encoding is not
12349 an C<Encode::XS> Encoding object, bad things will happen.
12350 (See F<lib/encoding.pm> and L<Encode>).
12352 The PV of the sv is returned.
12357 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12360 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12374 Passing sv_yes is wrong - it needs to be or'ed set of constants
12375 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12376 remove converted chars from source.
12378 Both will default the value - let them.
12380 XPUSHs(&PL_sv_yes);
12383 call_method("decode", G_SCALAR);
12387 s = SvPV(uni, len);
12388 if (s != SvPVX(sv)) {
12389 SvGROW(sv, len + 1);
12390 Move(s, SvPVX(sv), len, char);
12391 SvCUR_set(sv, len);
12392 SvPVX(sv)[len] = 0;
12399 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12403 =for apidoc sv_cat_decode
12405 The encoding is assumed to be an Encode object, the PV of the ssv is
12406 assumed to be octets in that encoding and decoding the input starts
12407 from the position which (PV + *offset) pointed to. The dsv will be
12408 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12409 when the string tstr appears in decoding output or the input ends on
12410 the PV of the ssv. The value which the offset points will be modified
12411 to the last input position on the ssv.
12413 Returns TRUE if the terminator was found, else returns FALSE.
12418 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12419 SV *ssv, int *offset, char *tstr, int tlen)
12423 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12434 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12435 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12437 call_method("cat_decode", G_SCALAR);
12439 ret = SvTRUE(TOPs);
12440 *offset = SvIV(offsv);
12446 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12452 * c-indentation-style: bsd
12453 * c-basic-offset: 4
12454 * indent-tabs-mode: t
12457 * ex: set ts=8 sts=4 sw=4 noet: