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);
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);
763 if (!cv || !CvPADLIST(cv))
765 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
766 sv = *av_fetch(av, targ, FALSE);
767 /* SvLEN in a pad name is not to be trusted */
769 sv_setpvn(name, str, len);
772 if (subscript_type == FUV_SUBSCRIPT_HASH) {
775 Perl_sv_catpvf(aTHX_ name, "{%s}",
776 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
779 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
781 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
783 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
784 sv_insert(name, 0, 0, "within ", 7);
791 =for apidoc find_uninit_var
793 Find the name of the undefined variable (if any) that caused the operator o
794 to issue a "Use of uninitialized value" warning.
795 If match is true, only return a name if it's value matches uninit_sv.
796 So roughly speaking, if a unary operator (such as OP_COS) generates a
797 warning, then following the direct child of the op may yield an
798 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
799 other hand, with OP_ADD there are two branches to follow, so we only print
800 the variable name if we get an exact match.
802 The name is returned as a mortal SV.
804 Assumes that PL_op is the op that originally triggered the error, and that
805 PL_comppad/PL_curpad points to the currently executing pad.
811 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
820 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
821 uninit_sv == &PL_sv_placeholder)))
824 switch (obase->op_type) {
831 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
832 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
835 int subscript_type = FUV_SUBSCRIPT_WITHIN;
837 if (pad) { /* @lex, %lex */
838 sv = PAD_SVl(obase->op_targ);
842 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
843 /* @global, %global */
844 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
847 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
849 else /* @{expr}, %{expr} */
850 return find_uninit_var(cUNOPx(obase)->op_first,
854 /* attempt to find a match within the aggregate */
856 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
858 subscript_type = FUV_SUBSCRIPT_HASH;
861 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
863 subscript_type = FUV_SUBSCRIPT_ARRAY;
866 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
869 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
870 keysv, index, subscript_type);
874 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
876 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
877 Nullsv, 0, FUV_SUBSCRIPT_NONE);
880 gv = cGVOPx_gv(obase);
881 if (!gv || (match && GvSV(gv) != uninit_sv))
883 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
886 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
888 av = (AV*)PAD_SV(obase->op_targ);
889 if (!av || SvRMAGICAL(av))
891 svp = av_fetch(av, (I32)obase->op_private, FALSE);
892 if (!svp || *svp != uninit_sv)
895 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
896 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
899 gv = cGVOPx_gv(obase);
904 if (!av || SvRMAGICAL(av))
906 svp = av_fetch(av, (I32)obase->op_private, FALSE);
907 if (!svp || *svp != uninit_sv)
910 return S_varname(aTHX_ gv, "$", 0,
911 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
916 o = cUNOPx(obase)->op_first;
917 if (!o || o->op_type != OP_NULL ||
918 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
920 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
925 /* $a[uninit_expr] or $h{uninit_expr} */
926 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
929 o = cBINOPx(obase)->op_first;
930 kid = cBINOPx(obase)->op_last;
932 /* get the av or hv, and optionally the gv */
934 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
935 sv = PAD_SV(o->op_targ);
937 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
938 && cUNOPo->op_first->op_type == OP_GV)
940 gv = cGVOPx_gv(cUNOPo->op_first);
943 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
948 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
949 /* index is constant */
953 if (obase->op_type == OP_HELEM) {
954 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
955 if (!he || HeVAL(he) != uninit_sv)
959 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
960 if (!svp || *svp != uninit_sv)
964 if (obase->op_type == OP_HELEM)
965 return S_varname(aTHX_ gv, "%", o->op_targ,
966 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
968 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
969 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
973 /* index is an expression;
974 * attempt to find a match within the aggregate */
975 if (obase->op_type == OP_HELEM) {
976 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
978 return S_varname(aTHX_ gv, "%", o->op_targ,
979 keysv, 0, FUV_SUBSCRIPT_HASH);
982 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
984 return S_varname(aTHX_ gv, "@", o->op_targ,
985 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
989 return S_varname(aTHX_ gv,
990 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
992 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
998 /* only examine RHS */
999 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
1002 o = cUNOPx(obase)->op_first;
1003 if (o->op_type == OP_PUSHMARK)
1006 if (!o->op_sibling) {
1007 /* one-arg version of open is highly magical */
1009 if (o->op_type == OP_GV) { /* open FOO; */
1011 if (match && GvSV(gv) != uninit_sv)
1013 return S_varname(aTHX_ gv, "$", 0,
1014 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1016 /* other possibilities not handled are:
1017 * open $x; or open my $x; should return '${*$x}'
1018 * open expr; should return '$'.expr ideally
1024 /* ops where $_ may be an implicit arg */
1028 if ( !(obase->op_flags & OPf_STACKED)) {
1029 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1030 ? PAD_SVl(obase->op_targ)
1033 sv = sv_newmortal();
1034 sv_setpvn(sv, "$_", 2);
1042 /* skip filehandle as it can't produce 'undef' warning */
1043 o = cUNOPx(obase)->op_first;
1044 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1045 o = o->op_sibling->op_sibling;
1052 match = 1; /* XS or custom code could trigger random warnings */
1057 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1058 return sv_2mortal(newSVpv("${$/}", 0));
1063 if (!(obase->op_flags & OPf_KIDS))
1065 o = cUNOPx(obase)->op_first;
1071 /* if all except one arg are constant, or have no side-effects,
1072 * or are optimized away, then it's unambiguous */
1074 for (kid=o; kid; kid = kid->op_sibling) {
1076 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1077 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1078 || (kid->op_type == OP_PUSHMARK)
1082 if (o2) { /* more than one found */
1089 return find_uninit_var(o2, uninit_sv, match);
1093 sv = find_uninit_var(o, uninit_sv, 1);
1105 =for apidoc report_uninit
1107 Print appropriate "Use of uninitialized variable" warning
1113 Perl_report_uninit(pTHX_ SV* uninit_sv)
1116 SV* varname = Nullsv;
1118 varname = find_uninit_var(PL_op, uninit_sv,0);
1120 sv_insert(varname, 0, 0, " ", 1);
1122 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1123 varname ? SvPV_nolen(varname) : "",
1124 " in ", OP_DESC(PL_op));
1127 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1131 /* allocate another arena's worth of NV bodies */
1139 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1140 *((void **) ptr) = (void *)PL_xnv_arenaroot;
1141 PL_xnv_arenaroot = ptr;
1144 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1145 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1147 while (xnv < xnvend) {
1148 *(NV**)xnv = (NV*)(xnv + 1);
1154 /* allocate another arena's worth of struct xpv */
1160 xpv_allocated* xpvend;
1161 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1162 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
1163 PL_xpv_arenaroot = xpv;
1165 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
1166 PL_xpv_root = ++xpv;
1167 while (xpv < xpvend) {
1168 *((xpv_allocated**)xpv) = xpv + 1;
1171 *((xpv_allocated**)xpv) = 0;
1174 /* allocate another arena's worth of struct xpviv */
1179 xpviv_allocated* xpviv;
1180 xpviv_allocated* xpvivend;
1181 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1182 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
1183 PL_xpviv_arenaroot = xpviv;
1185 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
1186 PL_xpviv_root = ++xpviv;
1187 while (xpviv < xpvivend) {
1188 *((xpviv_allocated**)xpviv) = xpviv + 1;
1191 *((xpviv_allocated**)xpviv) = 0;
1194 /* allocate another arena's worth of struct xpvnv */
1201 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1202 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
1203 PL_xpvnv_arenaroot = xpvnv;
1205 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1206 PL_xpvnv_root = ++xpvnv;
1207 while (xpvnv < xpvnvend) {
1208 *((XPVNV**)xpvnv) = xpvnv + 1;
1211 *((XPVNV**)xpvnv) = 0;
1214 /* allocate another arena's worth of struct xpvcv */
1221 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1222 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
1223 PL_xpvcv_arenaroot = xpvcv;
1225 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1226 PL_xpvcv_root = ++xpvcv;
1227 while (xpvcv < xpvcvend) {
1228 *((XPVCV**)xpvcv) = xpvcv + 1;
1231 *((XPVCV**)xpvcv) = 0;
1234 /* allocate another arena's worth of struct xpvav */
1239 xpvav_allocated* xpvav;
1240 xpvav_allocated* xpvavend;
1241 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1243 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
1244 PL_xpvav_arenaroot = xpvav;
1246 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
1247 PL_xpvav_root = ++xpvav;
1248 while (xpvav < xpvavend) {
1249 *((xpvav_allocated**)xpvav) = xpvav + 1;
1252 *((xpvav_allocated**)xpvav) = 0;
1255 /* allocate another arena's worth of struct xpvhv */
1260 xpvhv_allocated* xpvhv;
1261 xpvhv_allocated* xpvhvend;
1262 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1264 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
1265 PL_xpvhv_arenaroot = xpvhv;
1267 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
1268 PL_xpvhv_root = ++xpvhv;
1269 while (xpvhv < xpvhvend) {
1270 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
1273 *((xpvhv_allocated**)xpvhv) = 0;
1276 /* allocate another arena's worth of struct xpvmg */
1283 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1284 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1285 PL_xpvmg_arenaroot = xpvmg;
1287 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1288 PL_xpvmg_root = ++xpvmg;
1289 while (xpvmg < xpvmgend) {
1290 *((XPVMG**)xpvmg) = xpvmg + 1;
1293 *((XPVMG**)xpvmg) = 0;
1296 /* allocate another arena's worth of struct xpvgv */
1303 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1304 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1305 PL_xpvgv_arenaroot = xpvgv;
1307 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1308 PL_xpvgv_root = ++xpvgv;
1309 while (xpvgv < xpvgvend) {
1310 *((XPVGV**)xpvgv) = xpvgv + 1;
1313 *((XPVGV**)xpvgv) = 0;
1316 /* allocate another arena's worth of struct xpvlv */
1323 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1324 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1325 PL_xpvlv_arenaroot = xpvlv;
1327 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1328 PL_xpvlv_root = ++xpvlv;
1329 while (xpvlv < xpvlvend) {
1330 *((XPVLV**)xpvlv) = xpvlv + 1;
1333 *((XPVLV**)xpvlv) = 0;
1336 /* allocate another arena's worth of struct xpvbm */
1343 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1344 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1345 PL_xpvbm_arenaroot = xpvbm;
1347 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1348 PL_xpvbm_root = ++xpvbm;
1349 while (xpvbm < xpvbmend) {
1350 *((XPVBM**)xpvbm) = xpvbm + 1;
1353 *((XPVBM**)xpvbm) = 0;
1356 /* grab a new NV body from the free list, allocating more if necessary */
1366 PL_xnv_root = *(NV**)xnv;
1368 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1371 /* return an NV body to the free list */
1374 S_del_xnv(pTHX_ XPVNV *p)
1376 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1378 *(NV**)xnv = PL_xnv_root;
1383 /* grab a new struct xpv from the free list, allocating more if necessary */
1393 PL_xpv_root = *(xpv_allocated**)xpv;
1395 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1396 sum to zero, and the pointer is unchanged. If the allocated structure
1397 is smaller (no initial IV actually allocated) then the net effect is
1398 to subtract the size of the IV from the pointer, to return a new pointer
1399 as if an initial IV were actually allocated. */
1400 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1401 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
1404 /* return a struct xpv to the free list */
1407 S_del_xpv(pTHX_ XPV *p)
1410 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1411 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
1413 *(xpv_allocated**)xpv = PL_xpv_root;
1418 /* grab a new struct xpviv from the free list, allocating more if necessary */
1423 xpviv_allocated* xpviv;
1427 xpviv = PL_xpviv_root;
1428 PL_xpviv_root = *(xpviv_allocated**)xpviv;
1430 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1431 sum to zero, and the pointer is unchanged. If the allocated structure
1432 is smaller (no initial IV actually allocated) then the net effect is
1433 to subtract the size of the IV from the pointer, to return a new pointer
1434 as if an initial IV were actually allocated. */
1435 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1436 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1439 /* return a struct xpviv to the free list */
1442 S_del_xpviv(pTHX_ XPVIV *p)
1444 xpviv_allocated* xpviv
1445 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1446 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1448 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1449 PL_xpviv_root = xpviv;
1453 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1462 xpvnv = PL_xpvnv_root;
1463 PL_xpvnv_root = *(XPVNV**)xpvnv;
1468 /* return a struct xpvnv to the free list */
1471 S_del_xpvnv(pTHX_ XPVNV *p)
1474 *(XPVNV**)p = PL_xpvnv_root;
1479 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1488 xpvcv = PL_xpvcv_root;
1489 PL_xpvcv_root = *(XPVCV**)xpvcv;
1494 /* return a struct xpvcv to the free list */
1497 S_del_xpvcv(pTHX_ XPVCV *p)
1500 *(XPVCV**)p = PL_xpvcv_root;
1505 /* grab a new struct xpvav from the free list, allocating more if necessary */
1510 xpvav_allocated* xpvav;
1514 xpvav = PL_xpvav_root;
1515 PL_xpvav_root = *(xpvav_allocated**)xpvav;
1517 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1518 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
1521 /* return a struct xpvav to the free list */
1524 S_del_xpvav(pTHX_ XPVAV *p)
1526 xpvav_allocated* xpvav
1527 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1528 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
1530 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1531 PL_xpvav_root = xpvav;
1535 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1540 xpvhv_allocated* xpvhv;
1544 xpvhv = PL_xpvhv_root;
1545 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
1547 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1548 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1551 /* return a struct xpvhv to the free list */
1554 S_del_xpvhv(pTHX_ XPVHV *p)
1556 xpvhv_allocated* xpvhv
1557 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1558 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1560 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1561 PL_xpvhv_root = xpvhv;
1565 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1574 xpvmg = PL_xpvmg_root;
1575 PL_xpvmg_root = *(XPVMG**)xpvmg;
1580 /* return a struct xpvmg to the free list */
1583 S_del_xpvmg(pTHX_ XPVMG *p)
1586 *(XPVMG**)p = PL_xpvmg_root;
1591 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1600 xpvgv = PL_xpvgv_root;
1601 PL_xpvgv_root = *(XPVGV**)xpvgv;
1606 /* return a struct xpvgv to the free list */
1609 S_del_xpvgv(pTHX_ XPVGV *p)
1612 *(XPVGV**)p = PL_xpvgv_root;
1617 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1626 xpvlv = PL_xpvlv_root;
1627 PL_xpvlv_root = *(XPVLV**)xpvlv;
1632 /* return a struct xpvlv to the free list */
1635 S_del_xpvlv(pTHX_ XPVLV *p)
1638 *(XPVLV**)p = PL_xpvlv_root;
1643 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1652 xpvbm = PL_xpvbm_root;
1653 PL_xpvbm_root = *(XPVBM**)xpvbm;
1658 /* return a struct xpvbm to the free list */
1661 S_del_xpvbm(pTHX_ XPVBM *p)
1664 *(XPVBM**)p = PL_xpvbm_root;
1669 #define my_safemalloc(s) (void*)safemalloc(s)
1670 #define my_safefree(p) safefree((char*)p)
1674 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1675 #define del_XNV(p) my_safefree(p)
1677 #define new_XPV() my_safemalloc(sizeof(XPV))
1678 #define del_XPV(p) my_safefree(p)
1680 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1681 #define del_XPVIV(p) my_safefree(p)
1683 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1684 #define del_XPVNV(p) my_safefree(p)
1686 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1687 #define del_XPVCV(p) my_safefree(p)
1689 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1690 #define del_XPVAV(p) my_safefree(p)
1692 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1693 #define del_XPVHV(p) my_safefree(p)
1695 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1696 #define del_XPVMG(p) my_safefree(p)
1698 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1699 #define del_XPVGV(p) my_safefree(p)
1701 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1702 #define del_XPVLV(p) my_safefree(p)
1704 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1705 #define del_XPVBM(p) my_safefree(p)
1709 #define new_XNV() (void*)new_xnv()
1710 #define del_XNV(p) del_xnv((XPVNV*) p)
1712 #define new_XPV() (void*)new_xpv()
1713 #define del_XPV(p) del_xpv((XPV *)p)
1715 #define new_XPVIV() (void*)new_xpviv()
1716 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1718 #define new_XPVNV() (void*)new_xpvnv()
1719 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1721 #define new_XPVCV() (void*)new_xpvcv()
1722 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1724 #define new_XPVAV() (void*)new_xpvav()
1725 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1727 #define new_XPVHV() (void*)new_xpvhv()
1728 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1730 #define new_XPVMG() (void*)new_xpvmg()
1731 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1733 #define new_XPVGV() (void*)new_xpvgv()
1734 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1736 #define new_XPVLV() (void*)new_xpvlv()
1737 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1739 #define new_XPVBM() (void*)new_xpvbm()
1740 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1744 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1745 #define del_XPVFM(p) my_safefree(p)
1747 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1748 #define del_XPVIO(p) my_safefree(p)
1751 =for apidoc sv_upgrade
1753 Upgrade an SV to a more complex form. Generally adds a new body type to the
1754 SV, then copies across as much information as possible from the old body.
1755 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1761 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1772 if (mt != SVt_PV && SvIsCOW(sv)) {
1773 sv_force_normal_flags(sv, 0);
1776 if (SvTYPE(sv) == mt)
1787 switch (SvTYPE(sv)) {
1794 else if (mt < SVt_PVIV)
1804 pv = (char*)SvRV(sv);
1813 else if (mt == SVt_NV)
1821 del_XPVIV(SvANY(sv));
1829 del_XPVNV(SvANY(sv));
1832 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1833 there's no way that it can be safely upgraded, because perl.c
1834 expects to Safefree(SvANY(PL_mess_sv)) */
1835 assert(sv != PL_mess_sv);
1836 /* This flag bit is used to mean other things in other scalar types.
1837 Given that it only has meaning inside the pad, it shouldn't be set
1838 on anything that can get upgraded. */
1839 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1845 magic = SvMAGIC(sv);
1846 stash = SvSTASH(sv);
1847 del_XPVMG(SvANY(sv));
1850 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1853 SvFLAGS(sv) &= ~SVTYPEMASK;
1858 Perl_croak(aTHX_ "Can't upgrade to undef");
1860 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1864 SvANY(sv) = new_XNV();
1868 SvANY(sv) = &sv->sv_u.svu_rv;
1869 SvRV_set(sv, (SV*)pv);
1872 SvANY(sv) = new_XPVHV();
1875 HvTOTALKEYS(sv) = 0;
1877 /* Fall through... */
1880 SvANY(sv) = new_XPVAV();
1887 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1889 /* FIXME. Should be able to remove all this if()... if the above
1890 assertion is genuinely always true. */
1893 SvFLAGS(sv) &= ~SVf_OOK;
1896 SvPV_set(sv, (char*)0);
1897 SvMAGIC_set(sv, magic);
1898 SvSTASH_set(sv, stash);
1902 SvANY(sv) = new_XPVIO();
1903 Zero(SvANY(sv), 1, XPVIO);
1904 IoPAGE_LEN(sv) = 60;
1905 goto set_magic_common;
1907 SvANY(sv) = new_XPVFM();
1908 Zero(SvANY(sv), 1, XPVFM);
1909 goto set_magic_common;
1911 SvANY(sv) = new_XPVBM();
1915 goto set_magic_common;
1917 SvANY(sv) = new_XPVGV();
1923 goto set_magic_common;
1925 SvANY(sv) = new_XPVCV();
1926 Zero(SvANY(sv), 1, XPVCV);
1927 goto set_magic_common;
1929 SvANY(sv) = new_XPVLV();
1942 SvANY(sv) = new_XPVMG();
1945 SvMAGIC_set(sv, magic);
1946 SvSTASH_set(sv, stash);
1950 SvANY(sv) = new_XPVNV();
1956 SvANY(sv) = new_XPVIV();
1965 SvANY(sv) = new_XPV();
1976 =for apidoc sv_backoff
1978 Remove any string offset. You should normally use the C<SvOOK_off> macro
1985 Perl_sv_backoff(pTHX_ register SV *sv)
1988 assert(SvTYPE(sv) != SVt_PVHV);
1989 assert(SvTYPE(sv) != SVt_PVAV);
1991 const char *s = SvPVX_const(sv);
1992 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1993 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1995 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1997 SvFLAGS(sv) &= ~SVf_OOK;
2004 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2005 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2006 Use the C<SvGROW> wrapper instead.
2012 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2016 #ifdef HAS_64K_LIMIT
2017 if (newlen >= 0x10000) {
2018 PerlIO_printf(Perl_debug_log,
2019 "Allocation too large: %"UVxf"\n", (UV)newlen);
2022 #endif /* HAS_64K_LIMIT */
2025 if (SvTYPE(sv) < SVt_PV) {
2026 sv_upgrade(sv, SVt_PV);
2029 else if (SvOOK(sv)) { /* pv is offset? */
2032 if (newlen > SvLEN(sv))
2033 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2034 #ifdef HAS_64K_LIMIT
2035 if (newlen >= 0x10000)
2042 if (newlen > SvLEN(sv)) { /* need more room? */
2043 newlen = PERL_STRLEN_ROUNDUP(newlen);
2044 if (SvLEN(sv) && s) {
2046 const STRLEN l = malloced_size((void*)SvPVX(sv));
2052 s = saferealloc(s, newlen);
2055 s = safemalloc(newlen);
2056 if (SvPVX_const(sv) && SvCUR(sv)) {
2057 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2061 SvLEN_set(sv, newlen);
2067 =for apidoc sv_setiv
2069 Copies an integer into the given SV, upgrading first if necessary.
2070 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2076 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2078 SV_CHECK_THINKFIRST_COW_DROP(sv);
2079 switch (SvTYPE(sv)) {
2081 sv_upgrade(sv, SVt_IV);
2084 sv_upgrade(sv, SVt_PVNV);
2088 sv_upgrade(sv, SVt_PVIV);
2097 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2100 (void)SvIOK_only(sv); /* validate number */
2106 =for apidoc sv_setiv_mg
2108 Like C<sv_setiv>, but also handles 'set' magic.
2114 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2121 =for apidoc sv_setuv
2123 Copies an unsigned integer into the given SV, upgrading first if necessary.
2124 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2130 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2132 /* With these two if statements:
2133 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2136 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2138 If you wish to remove them, please benchmark to see what the effect is
2140 if (u <= (UV)IV_MAX) {
2141 sv_setiv(sv, (IV)u);
2150 =for apidoc sv_setuv_mg
2152 Like C<sv_setuv>, but also handles 'set' magic.
2158 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2160 /* With these two if statements:
2161 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2164 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2166 If you wish to remove them, please benchmark to see what the effect is
2168 if (u <= (UV)IV_MAX) {
2169 sv_setiv(sv, (IV)u);
2179 =for apidoc sv_setnv
2181 Copies a double into the given SV, upgrading first if necessary.
2182 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2188 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2190 SV_CHECK_THINKFIRST_COW_DROP(sv);
2191 switch (SvTYPE(sv)) {
2194 sv_upgrade(sv, SVt_NV);
2199 sv_upgrade(sv, SVt_PVNV);
2208 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2212 (void)SvNOK_only(sv); /* validate number */
2217 =for apidoc sv_setnv_mg
2219 Like C<sv_setnv>, but also handles 'set' magic.
2225 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2231 /* Print an "isn't numeric" warning, using a cleaned-up,
2232 * printable version of the offending string
2236 S_not_a_number(pTHX_ SV *sv)
2243 dsv = sv_2mortal(newSVpv("", 0));
2244 pv = sv_uni_display(dsv, sv, 10, 0);
2247 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2248 /* each *s can expand to 4 chars + "...\0",
2249 i.e. need room for 8 chars */
2252 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2254 if (ch & 128 && !isPRINT_LC(ch)) {
2263 else if (ch == '\r') {
2267 else if (ch == '\f') {
2271 else if (ch == '\\') {
2275 else if (ch == '\0') {
2279 else if (isPRINT_LC(ch))
2296 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2297 "Argument \"%s\" isn't numeric in %s", pv,
2300 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2301 "Argument \"%s\" isn't numeric", pv);
2305 =for apidoc looks_like_number
2307 Test if the content of an SV looks like a number (or is a number).
2308 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2309 non-numeric warning), even if your atof() doesn't grok them.
2315 Perl_looks_like_number(pTHX_ SV *sv)
2317 register const char *sbegin;
2321 sbegin = SvPVX_const(sv);
2324 else if (SvPOKp(sv))
2325 sbegin = SvPV(sv, len);
2327 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2328 return grok_number(sbegin, len, NULL);
2331 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2332 until proven guilty, assume that things are not that bad... */
2337 As 64 bit platforms often have an NV that doesn't preserve all bits of
2338 an IV (an assumption perl has been based on to date) it becomes necessary
2339 to remove the assumption that the NV always carries enough precision to
2340 recreate the IV whenever needed, and that the NV is the canonical form.
2341 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2342 precision as a side effect of conversion (which would lead to insanity
2343 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2344 1) to distinguish between IV/UV/NV slots that have cached a valid
2345 conversion where precision was lost and IV/UV/NV slots that have a
2346 valid conversion which has lost no precision
2347 2) to ensure that if a numeric conversion to one form is requested that
2348 would lose precision, the precise conversion (or differently
2349 imprecise conversion) is also performed and cached, to prevent
2350 requests for different numeric formats on the same SV causing
2351 lossy conversion chains. (lossless conversion chains are perfectly
2356 SvIOKp is true if the IV slot contains a valid value
2357 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2358 SvNOKp is true if the NV slot contains a valid value
2359 SvNOK is true only if the NV value is accurate
2362 while converting from PV to NV, check to see if converting that NV to an
2363 IV(or UV) would lose accuracy over a direct conversion from PV to
2364 IV(or UV). If it would, cache both conversions, return NV, but mark
2365 SV as IOK NOKp (ie not NOK).
2367 While converting from PV to IV, check to see if converting that IV to an
2368 NV would lose accuracy over a direct conversion from PV to NV. If it
2369 would, cache both conversions, flag similarly.
2371 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2372 correctly because if IV & NV were set NV *always* overruled.
2373 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2374 changes - now IV and NV together means that the two are interchangeable:
2375 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2377 The benefit of this is that operations such as pp_add know that if
2378 SvIOK is true for both left and right operands, then integer addition
2379 can be used instead of floating point (for cases where the result won't
2380 overflow). Before, floating point was always used, which could lead to
2381 loss of precision compared with integer addition.
2383 * making IV and NV equal status should make maths accurate on 64 bit
2385 * may speed up maths somewhat if pp_add and friends start to use
2386 integers when possible instead of fp. (Hopefully the overhead in
2387 looking for SvIOK and checking for overflow will not outweigh the
2388 fp to integer speedup)
2389 * will slow down integer operations (callers of SvIV) on "inaccurate"
2390 values, as the change from SvIOK to SvIOKp will cause a call into
2391 sv_2iv each time rather than a macro access direct to the IV slot
2392 * should speed up number->string conversion on integers as IV is
2393 favoured when IV and NV are equally accurate
2395 ####################################################################
2396 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2397 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2398 On the other hand, SvUOK is true iff UV.
2399 ####################################################################
2401 Your mileage will vary depending your CPU's relative fp to integer
2405 #ifndef NV_PRESERVES_UV
2406 # define IS_NUMBER_UNDERFLOW_IV 1
2407 # define IS_NUMBER_UNDERFLOW_UV 2
2408 # define IS_NUMBER_IV_AND_UV 2
2409 # define IS_NUMBER_OVERFLOW_IV 4
2410 # define IS_NUMBER_OVERFLOW_UV 5
2412 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2414 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2416 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2418 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2419 if (SvNVX(sv) < (NV)IV_MIN) {
2420 (void)SvIOKp_on(sv);
2422 SvIV_set(sv, IV_MIN);
2423 return IS_NUMBER_UNDERFLOW_IV;
2425 if (SvNVX(sv) > (NV)UV_MAX) {
2426 (void)SvIOKp_on(sv);
2429 SvUV_set(sv, UV_MAX);
2430 return IS_NUMBER_OVERFLOW_UV;
2432 (void)SvIOKp_on(sv);
2434 /* Can't use strtol etc to convert this string. (See truth table in
2436 if (SvNVX(sv) <= (UV)IV_MAX) {
2437 SvIV_set(sv, I_V(SvNVX(sv)));
2438 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2439 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2441 /* Integer is imprecise. NOK, IOKp */
2443 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2446 SvUV_set(sv, U_V(SvNVX(sv)));
2447 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2448 if (SvUVX(sv) == UV_MAX) {
2449 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2450 possibly be preserved by NV. Hence, it must be overflow.
2452 return IS_NUMBER_OVERFLOW_UV;
2454 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2456 /* Integer is imprecise. NOK, IOKp */
2458 return IS_NUMBER_OVERFLOW_IV;
2460 #endif /* !NV_PRESERVES_UV*/
2462 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2463 * this function provided for binary compatibility only
2467 Perl_sv_2iv(pTHX_ register SV *sv)
2469 return sv_2iv_flags(sv, SV_GMAGIC);
2473 =for apidoc sv_2iv_flags
2475 Return the integer value of an SV, doing any necessary string
2476 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2477 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2483 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2487 if (SvGMAGICAL(sv)) {
2488 if (flags & SV_GMAGIC)
2493 return I_V(SvNVX(sv));
2495 if (SvPOKp(sv) && SvLEN(sv))
2498 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2499 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2505 if (SvTHINKFIRST(sv)) {
2508 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2509 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2510 return SvIV(tmpstr);
2511 return PTR2IV(SvRV(sv));
2514 sv_force_normal_flags(sv, 0);
2516 if (SvREADONLY(sv) && !SvOK(sv)) {
2517 if (ckWARN(WARN_UNINITIALIZED))
2524 return (IV)(SvUVX(sv));
2531 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2532 * without also getting a cached IV/UV from it at the same time
2533 * (ie PV->NV conversion should detect loss of accuracy and cache
2534 * IV or UV at same time to avoid this. NWC */
2536 if (SvTYPE(sv) == SVt_NV)
2537 sv_upgrade(sv, SVt_PVNV);
2539 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2540 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2541 certainly cast into the IV range at IV_MAX, whereas the correct
2542 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2544 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2545 SvIV_set(sv, I_V(SvNVX(sv)));
2546 if (SvNVX(sv) == (NV) SvIVX(sv)
2547 #ifndef NV_PRESERVES_UV
2548 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2549 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2550 /* Don't flag it as "accurately an integer" if the number
2551 came from a (by definition imprecise) NV operation, and
2552 we're outside the range of NV integer precision */
2555 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2556 DEBUG_c(PerlIO_printf(Perl_debug_log,
2557 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2563 /* IV not precise. No need to convert from PV, as NV
2564 conversion would already have cached IV if it detected
2565 that PV->IV would be better than PV->NV->IV
2566 flags already correct - don't set public IOK. */
2567 DEBUG_c(PerlIO_printf(Perl_debug_log,
2568 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2573 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2574 but the cast (NV)IV_MIN rounds to a the value less (more
2575 negative) than IV_MIN which happens to be equal to SvNVX ??
2576 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2577 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2578 (NV)UVX == NVX are both true, but the values differ. :-(
2579 Hopefully for 2s complement IV_MIN is something like
2580 0x8000000000000000 which will be exact. NWC */
2583 SvUV_set(sv, U_V(SvNVX(sv)));
2585 (SvNVX(sv) == (NV) SvUVX(sv))
2586 #ifndef NV_PRESERVES_UV
2587 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2588 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2589 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2590 /* Don't flag it as "accurately an integer" if the number
2591 came from a (by definition imprecise) NV operation, and
2592 we're outside the range of NV integer precision */
2598 DEBUG_c(PerlIO_printf(Perl_debug_log,
2599 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2603 return (IV)SvUVX(sv);
2606 else if (SvPOKp(sv) && SvLEN(sv)) {
2608 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2609 /* We want to avoid a possible problem when we cache an IV which
2610 may be later translated to an NV, and the resulting NV is not
2611 the same as the direct translation of the initial string
2612 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2613 be careful to ensure that the value with the .456 is around if the
2614 NV value is requested in the future).
2616 This means that if we cache such an IV, we need to cache the
2617 NV as well. Moreover, we trade speed for space, and do not
2618 cache the NV if we are sure it's not needed.
2621 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2622 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2623 == IS_NUMBER_IN_UV) {
2624 /* It's definitely an integer, only upgrade to PVIV */
2625 if (SvTYPE(sv) < SVt_PVIV)
2626 sv_upgrade(sv, SVt_PVIV);
2628 } else if (SvTYPE(sv) < SVt_PVNV)
2629 sv_upgrade(sv, SVt_PVNV);
2631 /* If NV preserves UV then we only use the UV value if we know that
2632 we aren't going to call atof() below. If NVs don't preserve UVs
2633 then the value returned may have more precision than atof() will
2634 return, even though value isn't perfectly accurate. */
2635 if ((numtype & (IS_NUMBER_IN_UV
2636 #ifdef NV_PRESERVES_UV
2639 )) == IS_NUMBER_IN_UV) {
2640 /* This won't turn off the public IOK flag if it was set above */
2641 (void)SvIOKp_on(sv);
2643 if (!(numtype & IS_NUMBER_NEG)) {
2645 if (value <= (UV)IV_MAX) {
2646 SvIV_set(sv, (IV)value);
2648 SvUV_set(sv, value);
2652 /* 2s complement assumption */
2653 if (value <= (UV)IV_MIN) {
2654 SvIV_set(sv, -(IV)value);
2656 /* Too negative for an IV. This is a double upgrade, but
2657 I'm assuming it will be rare. */
2658 if (SvTYPE(sv) < SVt_PVNV)
2659 sv_upgrade(sv, SVt_PVNV);
2663 SvNV_set(sv, -(NV)value);
2664 SvIV_set(sv, IV_MIN);
2668 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2669 will be in the previous block to set the IV slot, and the next
2670 block to set the NV slot. So no else here. */
2672 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2673 != IS_NUMBER_IN_UV) {
2674 /* It wasn't an (integer that doesn't overflow the UV). */
2675 SvNV_set(sv, Atof(SvPVX_const(sv)));
2677 if (! numtype && ckWARN(WARN_NUMERIC))
2680 #if defined(USE_LONG_DOUBLE)
2681 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2682 PTR2UV(sv), SvNVX(sv)));
2684 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2685 PTR2UV(sv), SvNVX(sv)));
2689 #ifdef NV_PRESERVES_UV
2690 (void)SvIOKp_on(sv);
2692 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2693 SvIV_set(sv, I_V(SvNVX(sv)));
2694 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2697 /* Integer is imprecise. NOK, IOKp */
2699 /* UV will not work better than IV */
2701 if (SvNVX(sv) > (NV)UV_MAX) {
2703 /* Integer is inaccurate. NOK, IOKp, is UV */
2704 SvUV_set(sv, UV_MAX);
2707 SvUV_set(sv, U_V(SvNVX(sv)));
2708 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2709 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2713 /* Integer is imprecise. NOK, IOKp, is UV */
2719 #else /* NV_PRESERVES_UV */
2720 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2721 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2722 /* The IV slot will have been set from value returned by
2723 grok_number above. The NV slot has just been set using
2726 assert (SvIOKp(sv));
2728 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2729 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2730 /* Small enough to preserve all bits. */
2731 (void)SvIOKp_on(sv);
2733 SvIV_set(sv, I_V(SvNVX(sv)));
2734 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2736 /* Assumption: first non-preserved integer is < IV_MAX,
2737 this NV is in the preserved range, therefore: */
2738 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2740 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);
2744 0 0 already failed to read UV.
2745 0 1 already failed to read UV.
2746 1 0 you won't get here in this case. IV/UV
2747 slot set, public IOK, Atof() unneeded.
2748 1 1 already read UV.
2749 so there's no point in sv_2iuv_non_preserve() attempting
2750 to use atol, strtol, strtoul etc. */
2751 if (sv_2iuv_non_preserve (sv, numtype)
2752 >= IS_NUMBER_OVERFLOW_IV)
2756 #endif /* NV_PRESERVES_UV */
2759 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2761 if (SvTYPE(sv) < SVt_IV)
2762 /* Typically the caller expects that sv_any is not NULL now. */
2763 sv_upgrade(sv, SVt_IV);
2766 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2767 PTR2UV(sv),SvIVX(sv)));
2768 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2771 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2772 * this function provided for binary compatibility only
2776 Perl_sv_2uv(pTHX_ register SV *sv)
2778 return sv_2uv_flags(sv, SV_GMAGIC);
2782 =for apidoc sv_2uv_flags
2784 Return the unsigned integer value of an SV, doing any necessary string
2785 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2786 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2792 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2796 if (SvGMAGICAL(sv)) {
2797 if (flags & SV_GMAGIC)
2802 return U_V(SvNVX(sv));
2803 if (SvPOKp(sv) && SvLEN(sv))
2806 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2807 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2813 if (SvTHINKFIRST(sv)) {
2816 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2817 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2818 return SvUV(tmpstr);
2819 return PTR2UV(SvRV(sv));
2822 sv_force_normal_flags(sv, 0);
2824 if (SvREADONLY(sv) && !SvOK(sv)) {
2825 if (ckWARN(WARN_UNINITIALIZED))
2835 return (UV)SvIVX(sv);
2839 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2840 * without also getting a cached IV/UV from it at the same time
2841 * (ie PV->NV conversion should detect loss of accuracy and cache
2842 * IV or UV at same time to avoid this. */
2843 /* IV-over-UV optimisation - choose to cache IV if possible */
2845 if (SvTYPE(sv) == SVt_NV)
2846 sv_upgrade(sv, SVt_PVNV);
2848 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2849 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2850 SvIV_set(sv, I_V(SvNVX(sv)));
2851 if (SvNVX(sv) == (NV) SvIVX(sv)
2852 #ifndef NV_PRESERVES_UV
2853 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2854 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2855 /* Don't flag it as "accurately an integer" if the number
2856 came from a (by definition imprecise) NV operation, and
2857 we're outside the range of NV integer precision */
2860 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2861 DEBUG_c(PerlIO_printf(Perl_debug_log,
2862 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2868 /* IV not precise. No need to convert from PV, as NV
2869 conversion would already have cached IV if it detected
2870 that PV->IV would be better than PV->NV->IV
2871 flags already correct - don't set public IOK. */
2872 DEBUG_c(PerlIO_printf(Perl_debug_log,
2873 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2878 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2879 but the cast (NV)IV_MIN rounds to a the value less (more
2880 negative) than IV_MIN which happens to be equal to SvNVX ??
2881 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2882 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2883 (NV)UVX == NVX are both true, but the values differ. :-(
2884 Hopefully for 2s complement IV_MIN is something like
2885 0x8000000000000000 which will be exact. NWC */
2888 SvUV_set(sv, U_V(SvNVX(sv)));
2890 (SvNVX(sv) == (NV) SvUVX(sv))
2891 #ifndef NV_PRESERVES_UV
2892 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2893 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2894 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2895 /* Don't flag it as "accurately an integer" if the number
2896 came from a (by definition imprecise) NV operation, and
2897 we're outside the range of NV integer precision */
2902 DEBUG_c(PerlIO_printf(Perl_debug_log,
2903 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2909 else if (SvPOKp(sv) && SvLEN(sv)) {
2911 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2913 /* We want to avoid a possible problem when we cache a UV which
2914 may be later translated to an NV, and the resulting NV is not
2915 the translation of the initial data.
2917 This means that if we cache such a UV, we need to cache the
2918 NV as well. Moreover, we trade speed for space, and do not
2919 cache the NV if not needed.
2922 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2923 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2924 == IS_NUMBER_IN_UV) {
2925 /* It's definitely an integer, only upgrade to PVIV */
2926 if (SvTYPE(sv) < SVt_PVIV)
2927 sv_upgrade(sv, SVt_PVIV);
2929 } else if (SvTYPE(sv) < SVt_PVNV)
2930 sv_upgrade(sv, SVt_PVNV);
2932 /* If NV preserves UV then we only use the UV value if we know that
2933 we aren't going to call atof() below. If NVs don't preserve UVs
2934 then the value returned may have more precision than atof() will
2935 return, even though it isn't accurate. */
2936 if ((numtype & (IS_NUMBER_IN_UV
2937 #ifdef NV_PRESERVES_UV
2940 )) == IS_NUMBER_IN_UV) {
2941 /* This won't turn off the public IOK flag if it was set above */
2942 (void)SvIOKp_on(sv);
2944 if (!(numtype & IS_NUMBER_NEG)) {
2946 if (value <= (UV)IV_MAX) {
2947 SvIV_set(sv, (IV)value);
2949 /* it didn't overflow, and it was positive. */
2950 SvUV_set(sv, value);
2954 /* 2s complement assumption */
2955 if (value <= (UV)IV_MIN) {
2956 SvIV_set(sv, -(IV)value);
2958 /* Too negative for an IV. This is a double upgrade, but
2959 I'm assuming it will be rare. */
2960 if (SvTYPE(sv) < SVt_PVNV)
2961 sv_upgrade(sv, SVt_PVNV);
2965 SvNV_set(sv, -(NV)value);
2966 SvIV_set(sv, IV_MIN);
2971 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2972 != IS_NUMBER_IN_UV) {
2973 /* It wasn't an integer, or it overflowed the UV. */
2974 SvNV_set(sv, Atof(SvPVX_const(sv)));
2976 if (! numtype && ckWARN(WARN_NUMERIC))
2979 #if defined(USE_LONG_DOUBLE)
2980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2981 PTR2UV(sv), SvNVX(sv)));
2983 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2984 PTR2UV(sv), SvNVX(sv)));
2987 #ifdef NV_PRESERVES_UV
2988 (void)SvIOKp_on(sv);
2990 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2991 SvIV_set(sv, I_V(SvNVX(sv)));
2992 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2995 /* Integer is imprecise. NOK, IOKp */
2997 /* UV will not work better than IV */
2999 if (SvNVX(sv) > (NV)UV_MAX) {
3001 /* Integer is inaccurate. NOK, IOKp, is UV */
3002 SvUV_set(sv, UV_MAX);
3005 SvUV_set(sv, U_V(SvNVX(sv)));
3006 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3007 NV preservse UV so can do correct comparison. */
3008 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3012 /* Integer is imprecise. NOK, IOKp, is UV */
3017 #else /* NV_PRESERVES_UV */
3018 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3019 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3020 /* The UV slot will have been set from value returned by
3021 grok_number above. The NV slot has just been set using
3024 assert (SvIOKp(sv));
3026 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3027 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3028 /* Small enough to preserve all bits. */
3029 (void)SvIOKp_on(sv);
3031 SvIV_set(sv, I_V(SvNVX(sv)));
3032 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3034 /* Assumption: first non-preserved integer is < IV_MAX,
3035 this NV is in the preserved range, therefore: */
3036 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3038 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);
3041 sv_2iuv_non_preserve (sv, numtype);
3043 #endif /* NV_PRESERVES_UV */
3047 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3048 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3051 if (SvTYPE(sv) < SVt_IV)
3052 /* Typically the caller expects that sv_any is not NULL now. */
3053 sv_upgrade(sv, SVt_IV);
3057 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3058 PTR2UV(sv),SvUVX(sv)));
3059 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3065 Return the num value of an SV, doing any necessary string or integer
3066 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3073 Perl_sv_2nv(pTHX_ register SV *sv)
3077 if (SvGMAGICAL(sv)) {
3081 if (SvPOKp(sv) && SvLEN(sv)) {
3082 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3083 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3085 return Atof(SvPVX_const(sv));
3089 return (NV)SvUVX(sv);
3091 return (NV)SvIVX(sv);
3094 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3095 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3101 if (SvTHINKFIRST(sv)) {
3104 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3105 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3106 return SvNV(tmpstr);
3107 return PTR2NV(SvRV(sv));
3110 sv_force_normal_flags(sv, 0);
3112 if (SvREADONLY(sv) && !SvOK(sv)) {
3113 if (ckWARN(WARN_UNINITIALIZED))
3118 if (SvTYPE(sv) < SVt_NV) {
3119 if (SvTYPE(sv) == SVt_IV)
3120 sv_upgrade(sv, SVt_PVNV);
3122 sv_upgrade(sv, SVt_NV);
3123 #ifdef USE_LONG_DOUBLE
3125 STORE_NUMERIC_LOCAL_SET_STANDARD();
3126 PerlIO_printf(Perl_debug_log,
3127 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3128 PTR2UV(sv), SvNVX(sv));
3129 RESTORE_NUMERIC_LOCAL();
3133 STORE_NUMERIC_LOCAL_SET_STANDARD();
3134 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3135 PTR2UV(sv), SvNVX(sv));
3136 RESTORE_NUMERIC_LOCAL();
3140 else if (SvTYPE(sv) < SVt_PVNV)
3141 sv_upgrade(sv, SVt_PVNV);
3146 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3147 #ifdef NV_PRESERVES_UV
3150 /* Only set the public NV OK flag if this NV preserves the IV */
3151 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3152 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3153 : (SvIVX(sv) == I_V(SvNVX(sv))))
3159 else if (SvPOKp(sv) && SvLEN(sv)) {
3161 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3162 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3164 #ifdef NV_PRESERVES_UV
3165 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3166 == IS_NUMBER_IN_UV) {
3167 /* It's definitely an integer */
3168 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3170 SvNV_set(sv, Atof(SvPVX_const(sv)));
3173 SvNV_set(sv, Atof(SvPVX_const(sv)));
3174 /* Only set the public NV OK flag if this NV preserves the value in
3175 the PV at least as well as an IV/UV would.
3176 Not sure how to do this 100% reliably. */
3177 /* if that shift count is out of range then Configure's test is
3178 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3180 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3181 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3182 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3183 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3184 /* Can't use strtol etc to convert this string, so don't try.
3185 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3188 /* value has been set. It may not be precise. */
3189 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3190 /* 2s complement assumption for (UV)IV_MIN */
3191 SvNOK_on(sv); /* Integer is too negative. */
3196 if (numtype & IS_NUMBER_NEG) {
3197 SvIV_set(sv, -(IV)value);
3198 } else if (value <= (UV)IV_MAX) {
3199 SvIV_set(sv, (IV)value);
3201 SvUV_set(sv, value);
3205 if (numtype & IS_NUMBER_NOT_INT) {
3206 /* I believe that even if the original PV had decimals,
3207 they are lost beyond the limit of the FP precision.
3208 However, neither is canonical, so both only get p
3209 flags. NWC, 2000/11/25 */
3210 /* Both already have p flags, so do nothing */
3213 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3214 if (SvIVX(sv) == I_V(nv)) {
3219 /* It had no "." so it must be integer. */
3222 /* between IV_MAX and NV(UV_MAX).
3223 Could be slightly > UV_MAX */
3225 if (numtype & IS_NUMBER_NOT_INT) {
3226 /* UV and NV both imprecise. */
3228 UV nv_as_uv = U_V(nv);
3230 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3241 #endif /* NV_PRESERVES_UV */
3244 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3246 if (SvTYPE(sv) < SVt_NV)
3247 /* Typically the caller expects that sv_any is not NULL now. */
3248 /* XXX Ilya implies that this is a bug in callers that assume this
3249 and ideally should be fixed. */
3250 sv_upgrade(sv, SVt_NV);
3253 #if defined(USE_LONG_DOUBLE)
3255 STORE_NUMERIC_LOCAL_SET_STANDARD();
3256 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3257 PTR2UV(sv), SvNVX(sv));
3258 RESTORE_NUMERIC_LOCAL();
3262 STORE_NUMERIC_LOCAL_SET_STANDARD();
3263 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3264 PTR2UV(sv), SvNVX(sv));
3265 RESTORE_NUMERIC_LOCAL();
3271 /* asIV(): extract an integer from the string value of an SV.
3272 * Caller must validate PVX */
3275 S_asIV(pTHX_ SV *sv)
3278 int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3281 == IS_NUMBER_IN_UV) {
3282 /* It's definitely an integer */
3283 if (numtype & IS_NUMBER_NEG) {
3284 if (value < (UV)IV_MIN)
3287 if (value < (UV)IV_MAX)
3292 if (ckWARN(WARN_NUMERIC))
3295 return I_V(Atof(SvPVX_const(sv)));
3298 /* asUV(): extract an unsigned integer from the string value of an SV
3299 * Caller must validate PVX */
3302 S_asUV(pTHX_ SV *sv)
3305 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3307 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3308 == IS_NUMBER_IN_UV) {
3309 /* It's definitely an integer */
3310 if (!(numtype & IS_NUMBER_NEG))
3314 if (ckWARN(WARN_NUMERIC))
3317 return U_V(Atof(SvPVX_const(sv)));
3321 =for apidoc sv_2pv_nolen
3323 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3324 use the macro wrapper C<SvPV_nolen(sv)> instead.
3329 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3332 return sv_2pv(sv, &n_a);
3335 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3336 * UV as a string towards the end of buf, and return pointers to start and
3339 * We assume that buf is at least TYPE_CHARS(UV) long.
3343 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3345 char *ptr = buf + TYPE_CHARS(UV);
3359 *--ptr = '0' + (char)(uv % 10);
3367 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3368 * this function provided for binary compatibility only
3372 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3374 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3378 =for apidoc sv_2pv_flags
3380 Returns a pointer to the string value of an SV, and sets *lp to its length.
3381 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3383 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3384 usually end up here too.
3390 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3395 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3396 char *tmpbuf = tbuf;
3402 if (SvGMAGICAL(sv)) {
3403 if (flags & SV_GMAGIC)
3411 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3413 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3418 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3423 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3424 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3431 if (SvTHINKFIRST(sv)) {
3434 register const char *typestr;
3435 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3436 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3437 char *pv = SvPV(tmpstr, *lp);
3447 typestr = "NULLREF";
3451 switch (SvTYPE(sv)) {
3453 if ( ((SvFLAGS(sv) &
3454 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3455 == (SVs_OBJECT|SVs_SMG))
3456 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3457 const regexp *re = (regexp *)mg->mg_obj;
3460 const char *fptr = "msix";
3465 char need_newline = 0;
3466 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3468 while((ch = *fptr++)) {
3470 reflags[left++] = ch;
3473 reflags[right--] = ch;
3478 reflags[left] = '-';
3482 mg->mg_len = re->prelen + 4 + left;
3484 * If /x was used, we have to worry about a regex
3485 * ending with a comment later being embedded
3486 * within another regex. If so, we don't want this
3487 * regex's "commentization" to leak out to the
3488 * right part of the enclosing regex, we must cap
3489 * it with a newline.
3491 * So, if /x was used, we scan backwards from the
3492 * end of the regex. If we find a '#' before we
3493 * find a newline, we need to add a newline
3494 * ourself. If we find a '\n' first (or if we
3495 * don't find '#' or '\n'), we don't need to add
3496 * anything. -jfriedl
3498 if (PMf_EXTENDED & re->reganch)
3500 const char *endptr = re->precomp + re->prelen;
3501 while (endptr >= re->precomp)
3503 const char c = *(endptr--);
3505 break; /* don't need another */
3507 /* we end while in a comment, so we
3509 mg->mg_len++; /* save space for it */
3510 need_newline = 1; /* note to add it */
3516 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3517 Copy("(?", mg->mg_ptr, 2, char);
3518 Copy(reflags, mg->mg_ptr+2, left, char);
3519 Copy(":", mg->mg_ptr+left+2, 1, char);
3520 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3522 mg->mg_ptr[mg->mg_len - 2] = '\n';
3523 mg->mg_ptr[mg->mg_len - 1] = ')';
3524 mg->mg_ptr[mg->mg_len] = 0;
3526 PL_reginterp_cnt += re->program[0].next_off;
3528 if (re->reganch & ROPT_UTF8)
3543 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3544 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3545 /* tied lvalues should appear to be
3546 * scalars for backwards compatitbility */
3547 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3548 ? "SCALAR" : "LVALUE"; break;
3549 case SVt_PVAV: typestr = "ARRAY"; break;
3550 case SVt_PVHV: typestr = "HASH"; break;
3551 case SVt_PVCV: typestr = "CODE"; break;
3552 case SVt_PVGV: typestr = "GLOB"; break;
3553 case SVt_PVFM: typestr = "FORMAT"; break;
3554 case SVt_PVIO: typestr = "IO"; break;
3555 default: typestr = "UNKNOWN"; break;
3559 const char *name = HvNAME_get(SvSTASH(sv));
3560 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3561 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3564 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3567 *lp = strlen(typestr);
3568 return (char *)typestr;
3570 if (SvREADONLY(sv) && !SvOK(sv)) {
3571 if (ckWARN(WARN_UNINITIALIZED))
3577 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3578 /* I'm assuming that if both IV and NV are equally valid then
3579 converting the IV is going to be more efficient */
3580 const U32 isIOK = SvIOK(sv);
3581 const U32 isUIOK = SvIsUV(sv);
3582 char buf[TYPE_CHARS(UV)];
3585 if (SvTYPE(sv) < SVt_PVIV)
3586 sv_upgrade(sv, SVt_PVIV);
3588 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3590 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3591 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3592 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3593 SvCUR_set(sv, ebuf - ptr);
3603 else if (SvNOKp(sv)) {
3604 if (SvTYPE(sv) < SVt_PVNV)
3605 sv_upgrade(sv, SVt_PVNV);
3606 /* The +20 is pure guesswork. Configure test needed. --jhi */
3607 SvGROW(sv, NV_DIG + 20);
3609 olderrno = errno; /* some Xenix systems wipe out errno here */
3611 if (SvNVX(sv) == 0.0)
3612 (void)strcpy(s,"0");
3616 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3619 #ifdef FIXNEGATIVEZERO
3620 if (*s == '-' && s[1] == '0' && !s[2])
3630 if (ckWARN(WARN_UNINITIALIZED)
3631 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3634 if (SvTYPE(sv) < SVt_PV)
3635 /* Typically the caller expects that sv_any is not NULL now. */
3636 sv_upgrade(sv, SVt_PV);
3639 *lp = s - SvPVX_const(sv);
3642 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3643 PTR2UV(sv),SvPVX_const(sv)));
3647 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3648 /* Sneaky stuff here */
3652 tsv = newSVpv(tmpbuf, 0);
3664 t = SvPVX_const(tsv);
3669 len = strlen(tmpbuf);
3671 #ifdef FIXNEGATIVEZERO
3672 if (len == 2 && t[0] == '-' && t[1] == '0') {
3677 (void)SvUPGRADE(sv, SVt_PV);
3679 s = SvGROW(sv, len + 1);
3682 return strcpy(s, t);
3687 =for apidoc sv_copypv
3689 Copies a stringified representation of the source SV into the
3690 destination SV. Automatically performs any necessary mg_get and
3691 coercion of numeric values into strings. Guaranteed to preserve
3692 UTF-8 flag even from overloaded objects. Similar in nature to
3693 sv_2pv[_flags] but operates directly on an SV instead of just the
3694 string. Mostly uses sv_2pv_flags to do its work, except when that
3695 would lose the UTF-8'ness of the PV.
3701 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3706 sv_setpvn(dsv,s,len);
3714 =for apidoc sv_2pvbyte_nolen
3716 Return a pointer to the byte-encoded representation of the SV.
3717 May cause the SV to be downgraded from UTF-8 as a side-effect.
3719 Usually accessed via the C<SvPVbyte_nolen> macro.
3725 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3728 return sv_2pvbyte(sv, &n_a);
3732 =for apidoc sv_2pvbyte
3734 Return a pointer to the byte-encoded representation of the SV, and set *lp
3735 to its length. May cause the SV to be downgraded from UTF-8 as a
3738 Usually accessed via the C<SvPVbyte> macro.
3744 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3746 sv_utf8_downgrade(sv,0);
3747 return SvPV(sv,*lp);
3751 =for apidoc sv_2pvutf8_nolen
3753 Return a pointer to the UTF-8-encoded representation of the SV.
3754 May cause the SV to be upgraded to UTF-8 as a side-effect.
3756 Usually accessed via the C<SvPVutf8_nolen> macro.
3762 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3765 return sv_2pvutf8(sv, &n_a);
3769 =for apidoc sv_2pvutf8
3771 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3772 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3774 Usually accessed via the C<SvPVutf8> macro.
3780 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3782 sv_utf8_upgrade(sv);
3783 return SvPV(sv,*lp);
3787 =for apidoc sv_2bool
3789 This function is only called on magical items, and is only used by
3790 sv_true() or its macro equivalent.
3796 Perl_sv_2bool(pTHX_ register SV *sv)
3805 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3806 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3807 return (bool)SvTRUE(tmpsv);
3808 return SvRV(sv) != 0;
3811 register XPV* Xpvtmp;
3812 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3813 (*sv->sv_u.svu_pv > '0' ||
3814 Xpvtmp->xpv_cur > 1 ||
3815 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3822 return SvIVX(sv) != 0;
3825 return SvNVX(sv) != 0.0;
3832 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3833 * this function provided for binary compatibility only
3838 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3840 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3844 =for apidoc sv_utf8_upgrade
3846 Converts the PV of an SV to its UTF-8-encoded form.
3847 Forces the SV to string form if it is not already.
3848 Always sets the SvUTF8 flag to avoid future validity checks even
3849 if all the bytes have hibit clear.
3851 This is not as a general purpose byte encoding to Unicode interface:
3852 use the Encode extension for that.
3854 =for apidoc sv_utf8_upgrade_flags
3856 Converts the PV of an SV to its UTF-8-encoded form.
3857 Forces the SV to string form if it is not already.
3858 Always sets the SvUTF8 flag to avoid future validity checks even
3859 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3860 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3861 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3863 This is not as a general purpose byte encoding to Unicode interface:
3864 use the Encode extension for that.
3870 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3872 if (sv == &PL_sv_undef)
3876 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3877 (void) sv_2pv_flags(sv,&len, flags);
3881 (void) SvPV_force(sv,len);
3890 sv_force_normal_flags(sv, 0);
3893 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3894 sv_recode_to_utf8(sv, PL_encoding);
3895 else { /* Assume Latin-1/EBCDIC */
3896 /* This function could be much more efficient if we
3897 * had a FLAG in SVs to signal if there are any hibit
3898 * chars in the PV. Given that there isn't such a flag
3899 * make the loop as fast as possible. */
3900 U8 *s = (U8 *) SvPVX(sv);
3901 U8 *e = (U8 *) SvEND(sv);
3907 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3911 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3912 s = bytes_to_utf8((U8*)s, &len);
3914 SvPV_free(sv); /* No longer using what was there before. */
3916 SvPV_set(sv, (char*)s);
3917 SvCUR_set(sv, len - 1);
3918 SvLEN_set(sv, len); /* No longer know the real size. */
3920 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3927 =for apidoc sv_utf8_downgrade
3929 Attempts to convert the PV of an SV from characters to bytes.
3930 If the PV contains a character beyond byte, this conversion will fail;
3931 in this case, either returns false or, if C<fail_ok> is not
3934 This is not as a general purpose Unicode to byte encoding interface:
3935 use the Encode extension for that.
3941 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3943 if (SvPOKp(sv) && SvUTF8(sv)) {
3949 sv_force_normal_flags(sv, 0);
3951 s = (U8 *) SvPV(sv, len);
3952 if (!utf8_to_bytes(s, &len)) {
3957 Perl_croak(aTHX_ "Wide character in %s",
3960 Perl_croak(aTHX_ "Wide character");
3971 =for apidoc sv_utf8_encode
3973 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3974 flag off so that it looks like octets again.
3980 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3982 (void) sv_utf8_upgrade(sv);
3984 sv_force_normal_flags(sv, 0);
3986 if (SvREADONLY(sv)) {
3987 Perl_croak(aTHX_ PL_no_modify);
3993 =for apidoc sv_utf8_decode
3995 If the PV of the SV is an octet sequence in UTF-8
3996 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3997 so that it looks like a character. If the PV contains only single-byte
3998 characters, the C<SvUTF8> flag stays being off.
3999 Scans PV for validity and returns false if the PV is invalid UTF-8.
4005 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4011 /* The octets may have got themselves encoded - get them back as
4014 if (!sv_utf8_downgrade(sv, TRUE))
4017 /* it is actually just a matter of turning the utf8 flag on, but
4018 * we want to make sure everything inside is valid utf8 first.
4020 c = (U8 *) SvPVX(sv);
4021 if (!is_utf8_string(c, SvCUR(sv)+1))
4023 e = (U8 *) SvEND(sv);
4026 if (!UTF8_IS_INVARIANT(ch)) {
4035 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4036 * this function provided for binary compatibility only
4040 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4042 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4046 =for apidoc sv_setsv
4048 Copies the contents of the source SV C<ssv> into the destination SV
4049 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4050 function if the source SV needs to be reused. Does not handle 'set' magic.
4051 Loosely speaking, it performs a copy-by-value, obliterating any previous
4052 content of the destination.
4054 You probably want to use one of the assortment of wrappers, such as
4055 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4056 C<SvSetMagicSV_nosteal>.
4058 =for apidoc sv_setsv_flags
4060 Copies the contents of the source SV C<ssv> into the destination SV
4061 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4062 function if the source SV needs to be reused. Does not handle 'set' magic.
4063 Loosely speaking, it performs a copy-by-value, obliterating any previous
4064 content of the destination.
4065 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4066 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4067 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4068 and C<sv_setsv_nomg> are implemented in terms of this function.
4070 You probably want to use one of the assortment of wrappers, such as
4071 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4072 C<SvSetMagicSV_nosteal>.
4074 This is the primary function for copying scalars, and most other
4075 copy-ish functions and macros use this underneath.
4081 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4083 register U32 sflags;
4089 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4091 sstr = &PL_sv_undef;
4092 stype = SvTYPE(sstr);
4093 dtype = SvTYPE(dstr);
4098 /* need to nuke the magic */
4100 SvRMAGICAL_off(dstr);
4103 /* There's a lot of redundancy below but we're going for speed here */
4108 if (dtype != SVt_PVGV) {
4109 (void)SvOK_off(dstr);
4117 sv_upgrade(dstr, SVt_IV);
4120 sv_upgrade(dstr, SVt_PVNV);
4124 sv_upgrade(dstr, SVt_PVIV);
4127 (void)SvIOK_only(dstr);
4128 SvIV_set(dstr, SvIVX(sstr));
4131 if (SvTAINTED(sstr))
4142 sv_upgrade(dstr, SVt_NV);
4147 sv_upgrade(dstr, SVt_PVNV);
4150 SvNV_set(dstr, SvNVX(sstr));
4151 (void)SvNOK_only(dstr);
4152 if (SvTAINTED(sstr))
4160 sv_upgrade(dstr, SVt_RV);
4161 else if (dtype == SVt_PVGV &&
4162 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4165 if (GvIMPORTED(dstr) != GVf_IMPORTED
4166 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4168 GvIMPORTED_on(dstr);
4177 #ifdef PERL_COPY_ON_WRITE
4178 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4179 if (dtype < SVt_PVIV)
4180 sv_upgrade(dstr, SVt_PVIV);
4187 sv_upgrade(dstr, SVt_PV);
4190 if (dtype < SVt_PVIV)
4191 sv_upgrade(dstr, SVt_PVIV);
4194 if (dtype < SVt_PVNV)
4195 sv_upgrade(dstr, SVt_PVNV);
4202 const char * const type = sv_reftype(sstr,0);
4204 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4206 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4211 if (dtype <= SVt_PVGV) {
4213 if (dtype != SVt_PVGV) {
4214 const char * const name = GvNAME(sstr);
4215 const STRLEN len = GvNAMELEN(sstr);
4216 /* don't upgrade SVt_PVLV: it can hold a glob */
4217 if (dtype != SVt_PVLV)
4218 sv_upgrade(dstr, SVt_PVGV);
4219 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4220 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4221 GvNAME(dstr) = savepvn(name, len);
4222 GvNAMELEN(dstr) = len;
4223 SvFAKE_on(dstr); /* can coerce to non-glob */
4225 /* ahem, death to those who redefine active sort subs */
4226 else if (PL_curstackinfo->si_type == PERLSI_SORT
4227 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4228 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4231 #ifdef GV_UNIQUE_CHECK
4232 if (GvUNIQUE((GV*)dstr)) {
4233 Perl_croak(aTHX_ PL_no_modify);
4237 (void)SvOK_off(dstr);
4238 GvINTRO_off(dstr); /* one-shot flag */
4240 GvGP(dstr) = gp_ref(GvGP(sstr));
4241 if (SvTAINTED(sstr))
4243 if (GvIMPORTED(dstr) != GVf_IMPORTED
4244 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4246 GvIMPORTED_on(dstr);
4254 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4256 if ((int)SvTYPE(sstr) != stype) {
4257 stype = SvTYPE(sstr);
4258 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4262 if (stype == SVt_PVLV)
4263 (void)SvUPGRADE(dstr, SVt_PVNV);
4265 (void)SvUPGRADE(dstr, (U32)stype);
4268 sflags = SvFLAGS(sstr);
4270 if (sflags & SVf_ROK) {
4271 if (dtype >= SVt_PV) {
4272 if (dtype == SVt_PVGV) {
4273 SV *sref = SvREFCNT_inc(SvRV(sstr));
4275 const int intro = GvINTRO(dstr);
4277 #ifdef GV_UNIQUE_CHECK
4278 if (GvUNIQUE((GV*)dstr)) {
4279 Perl_croak(aTHX_ PL_no_modify);
4284 GvINTRO_off(dstr); /* one-shot flag */
4285 GvLINE(dstr) = CopLINE(PL_curcop);
4286 GvEGV(dstr) = (GV*)dstr;
4289 switch (SvTYPE(sref)) {
4292 SAVEGENERICSV(GvAV(dstr));
4294 dref = (SV*)GvAV(dstr);
4295 GvAV(dstr) = (AV*)sref;
4296 if (!GvIMPORTED_AV(dstr)
4297 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4299 GvIMPORTED_AV_on(dstr);
4304 SAVEGENERICSV(GvHV(dstr));
4306 dref = (SV*)GvHV(dstr);
4307 GvHV(dstr) = (HV*)sref;
4308 if (!GvIMPORTED_HV(dstr)
4309 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4311 GvIMPORTED_HV_on(dstr);
4316 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4317 SvREFCNT_dec(GvCV(dstr));
4318 GvCV(dstr) = Nullcv;
4319 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4320 PL_sub_generation++;
4322 SAVEGENERICSV(GvCV(dstr));
4325 dref = (SV*)GvCV(dstr);
4326 if (GvCV(dstr) != (CV*)sref) {
4327 CV* cv = GvCV(dstr);
4329 if (!GvCVGEN((GV*)dstr) &&
4330 (CvROOT(cv) || CvXSUB(cv)))
4332 /* ahem, death to those who redefine
4333 * active sort subs */
4334 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4335 PL_sortcop == CvSTART(cv))
4337 "Can't redefine active sort subroutine %s",
4338 GvENAME((GV*)dstr));
4339 /* Redefining a sub - warning is mandatory if
4340 it was a const and its value changed. */
4341 if (ckWARN(WARN_REDEFINE)
4343 && (!CvCONST((CV*)sref)
4344 || sv_cmp(cv_const_sv(cv),
4345 cv_const_sv((CV*)sref)))))
4347 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4349 ? "Constant subroutine %s::%s redefined"
4350 : "Subroutine %s::%s redefined",
4351 HvNAME_get(GvSTASH((GV*)dstr)),
4352 GvENAME((GV*)dstr));
4356 cv_ckproto(cv, (GV*)dstr,
4357 SvPOK(sref) ? SvPVX(sref) : Nullch);
4359 GvCV(dstr) = (CV*)sref;
4360 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4361 GvASSUMECV_on(dstr);
4362 PL_sub_generation++;
4364 if (!GvIMPORTED_CV(dstr)
4365 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4367 GvIMPORTED_CV_on(dstr);
4372 SAVEGENERICSV(GvIOp(dstr));
4374 dref = (SV*)GvIOp(dstr);
4375 GvIOp(dstr) = (IO*)sref;
4379 SAVEGENERICSV(GvFORM(dstr));
4381 dref = (SV*)GvFORM(dstr);
4382 GvFORM(dstr) = (CV*)sref;
4386 SAVEGENERICSV(GvSV(dstr));
4388 dref = (SV*)GvSV(dstr);
4390 if (!GvIMPORTED_SV(dstr)
4391 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4393 GvIMPORTED_SV_on(dstr);
4399 if (SvTAINTED(sstr))
4403 if (SvPVX_const(dstr)) {
4409 (void)SvOK_off(dstr);
4410 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4412 if (sflags & SVp_NOK) {
4414 /* Only set the public OK flag if the source has public OK. */
4415 if (sflags & SVf_NOK)
4416 SvFLAGS(dstr) |= SVf_NOK;
4417 SvNV_set(dstr, SvNVX(sstr));
4419 if (sflags & SVp_IOK) {
4420 (void)SvIOKp_on(dstr);
4421 if (sflags & SVf_IOK)
4422 SvFLAGS(dstr) |= SVf_IOK;
4423 if (sflags & SVf_IVisUV)
4425 SvIV_set(dstr, SvIVX(sstr));
4427 if (SvAMAGIC(sstr)) {
4431 else if (sflags & SVp_POK) {
4435 * Check to see if we can just swipe the string. If so, it's a
4436 * possible small lose on short strings, but a big win on long ones.
4437 * It might even be a win on short strings if SvPVX_const(dstr)
4438 * has to be allocated and SvPVX_const(sstr) has to be freed.
4441 /* Whichever path we take through the next code, we want this true,
4442 and doing it now facilitates the COW check. */
4443 (void)SvPOK_only(dstr);
4446 #ifdef PERL_COPY_ON_WRITE
4447 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4451 (sflags & SVs_TEMP) && /* slated for free anyway? */
4452 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4453 (!(flags & SV_NOSTEAL)) &&
4454 /* and we're allowed to steal temps */
4455 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4456 SvLEN(sstr) && /* and really is a string */
4457 /* and won't be needed again, potentially */
4458 !(PL_op && PL_op->op_type == OP_AASSIGN))
4459 #ifdef PERL_COPY_ON_WRITE
4460 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4461 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4462 && SvTYPE(sstr) >= SVt_PVIV)
4465 /* Failed the swipe test, and it's not a shared hash key either.
4466 Have to copy the string. */
4467 STRLEN len = SvCUR(sstr);
4468 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4469 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4470 SvCUR_set(dstr, len);
4471 *SvEND(dstr) = '\0';
4473 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4475 #ifdef PERL_COPY_ON_WRITE
4476 /* Either it's a shared hash key, or it's suitable for
4477 copy-on-write or we can swipe the string. */
4479 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4484 /* I believe I should acquire a global SV mutex if
4485 it's a COW sv (not a shared hash key) to stop
4486 it going un copy-on-write.
4487 If the source SV has gone un copy on write between up there
4488 and down here, then (assert() that) it is of the correct
4489 form to make it copy on write again */
4490 if ((sflags & (SVf_FAKE | SVf_READONLY))
4491 != (SVf_FAKE | SVf_READONLY)) {
4492 SvREADONLY_on(sstr);
4494 /* Make the source SV into a loop of 1.
4495 (about to become 2) */
4496 SV_COW_NEXT_SV_SET(sstr, sstr);
4500 /* Initial code is common. */
4501 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4503 SvFLAGS(dstr) &= ~SVf_OOK;
4504 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4506 else if (SvLEN(dstr))
4507 Safefree(SvPVX_const(dstr));
4510 #ifdef PERL_COPY_ON_WRITE
4512 /* making another shared SV. */
4513 STRLEN cur = SvCUR(sstr);
4514 STRLEN len = SvLEN(sstr);
4515 assert (SvTYPE(dstr) >= SVt_PVIV);
4517 /* SvIsCOW_normal */
4518 /* splice us in between source and next-after-source. */
4519 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4520 SV_COW_NEXT_SV_SET(sstr, dstr);
4521 SvPV_set(dstr, SvPVX(sstr));
4523 /* SvIsCOW_shared_hash */
4524 UV hash = SvUVX(sstr);
4525 DEBUG_C(PerlIO_printf(Perl_debug_log,
4526 "Copy on write: Sharing hash\n"));
4528 sharepvn(SvPVX_const(sstr),
4529 (sflags & SVf_UTF8?-cur:cur), hash));
4530 SvUV_set(dstr, hash);
4532 SvLEN_set(dstr, len);
4533 SvCUR_set(dstr, cur);
4534 SvREADONLY_on(dstr);
4536 /* Relesase a global SV mutex. */
4540 { /* Passes the swipe test. */
4541 SvPV_set(dstr, SvPVX(sstr));
4542 SvLEN_set(dstr, SvLEN(sstr));
4543 SvCUR_set(dstr, SvCUR(sstr));
4546 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4547 SvPV_set(sstr, Nullch);
4553 if (sflags & SVf_UTF8)
4556 if (sflags & SVp_NOK) {
4558 if (sflags & SVf_NOK)
4559 SvFLAGS(dstr) |= SVf_NOK;
4560 SvNV_set(dstr, SvNVX(sstr));
4562 if (sflags & SVp_IOK) {
4563 (void)SvIOKp_on(dstr);
4564 if (sflags & SVf_IOK)
4565 SvFLAGS(dstr) |= SVf_IOK;
4566 if (sflags & SVf_IVisUV)
4568 SvIV_set(dstr, SvIVX(sstr));
4571 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4572 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4573 smg->mg_ptr, smg->mg_len);
4574 SvRMAGICAL_on(dstr);
4577 else if (sflags & SVp_IOK) {
4578 if (sflags & SVf_IOK)
4579 (void)SvIOK_only(dstr);
4581 (void)SvOK_off(dstr);
4582 (void)SvIOKp_on(dstr);
4584 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4585 if (sflags & SVf_IVisUV)
4587 SvIV_set(dstr, SvIVX(sstr));
4588 if (sflags & SVp_NOK) {
4589 if (sflags & SVf_NOK)
4590 (void)SvNOK_on(dstr);
4592 (void)SvNOKp_on(dstr);
4593 SvNV_set(dstr, SvNVX(sstr));
4596 else if (sflags & SVp_NOK) {
4597 if (sflags & SVf_NOK)
4598 (void)SvNOK_only(dstr);
4600 (void)SvOK_off(dstr);
4603 SvNV_set(dstr, SvNVX(sstr));
4606 if (dtype == SVt_PVGV) {
4607 if (ckWARN(WARN_MISC))
4608 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4611 (void)SvOK_off(dstr);
4613 if (SvTAINTED(sstr))
4618 =for apidoc sv_setsv_mg
4620 Like C<sv_setsv>, but also handles 'set' magic.
4626 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4628 sv_setsv(dstr,sstr);
4632 #ifdef PERL_COPY_ON_WRITE
4634 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4636 STRLEN cur = SvCUR(sstr);
4637 STRLEN len = SvLEN(sstr);
4638 register char *new_pv;
4641 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4649 if (SvTHINKFIRST(dstr))
4650 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4651 else if (SvPVX_const(dstr))
4652 Safefree(SvPVX_const(dstr));
4656 (void)SvUPGRADE (dstr, SVt_PVIV);
4658 assert (SvPOK(sstr));
4659 assert (SvPOKp(sstr));
4660 assert (!SvIOK(sstr));
4661 assert (!SvIOKp(sstr));
4662 assert (!SvNOK(sstr));
4663 assert (!SvNOKp(sstr));
4665 if (SvIsCOW(sstr)) {
4667 if (SvLEN(sstr) == 0) {
4668 /* source is a COW shared hash key. */
4669 UV hash = SvUVX(sstr);
4670 DEBUG_C(PerlIO_printf(Perl_debug_log,
4671 "Fast copy on write: Sharing hash\n"));
4672 SvUV_set(dstr, hash);
4673 new_pv = sharepvn(SvPVX_const(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4676 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4678 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4679 (void)SvUPGRADE (sstr, SVt_PVIV);
4680 SvREADONLY_on(sstr);
4682 DEBUG_C(PerlIO_printf(Perl_debug_log,
4683 "Fast copy on write: Converting sstr to COW\n"));
4684 SV_COW_NEXT_SV_SET(dstr, sstr);
4686 SV_COW_NEXT_SV_SET(sstr, dstr);
4687 new_pv = SvPVX(sstr);
4690 SvPV_set(dstr, new_pv);
4691 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4694 SvLEN_set(dstr, len);
4695 SvCUR_set(dstr, cur);
4704 =for apidoc sv_setpvn
4706 Copies a string into an SV. The C<len> parameter indicates the number of
4707 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4708 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4714 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4716 register char *dptr;
4718 SV_CHECK_THINKFIRST_COW_DROP(sv);
4724 /* len is STRLEN which is unsigned, need to copy to signed */
4727 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4729 (void)SvUPGRADE(sv, SVt_PV);
4731 SvGROW(sv, len + 1);
4733 Move(ptr,dptr,len,char);
4736 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4741 =for apidoc sv_setpvn_mg
4743 Like C<sv_setpvn>, but also handles 'set' magic.
4749 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4751 sv_setpvn(sv,ptr,len);
4756 =for apidoc sv_setpv
4758 Copies a string into an SV. The string must be null-terminated. Does not
4759 handle 'set' magic. See C<sv_setpv_mg>.
4765 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4767 register STRLEN len;
4769 SV_CHECK_THINKFIRST_COW_DROP(sv);
4775 (void)SvUPGRADE(sv, SVt_PV);
4777 SvGROW(sv, len + 1);
4778 Move(ptr,SvPVX(sv),len+1,char);
4780 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4785 =for apidoc sv_setpv_mg
4787 Like C<sv_setpv>, but also handles 'set' magic.
4793 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4800 =for apidoc sv_usepvn
4802 Tells an SV to use C<ptr> to find its string value. Normally the string is
4803 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4804 The C<ptr> should point to memory that was allocated by C<malloc>. The
4805 string length, C<len>, must be supplied. This function will realloc the
4806 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4807 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4808 See C<sv_usepvn_mg>.
4814 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4817 SV_CHECK_THINKFIRST_COW_DROP(sv);
4818 (void)SvUPGRADE(sv, SVt_PV);
4823 if (SvPVX_const(sv))
4826 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4827 ptr = saferealloc (ptr, allocate);
4830 SvLEN_set(sv, allocate);
4832 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4837 =for apidoc sv_usepvn_mg
4839 Like C<sv_usepvn>, but also handles 'set' magic.
4845 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4847 sv_usepvn(sv,ptr,len);
4851 #ifdef PERL_COPY_ON_WRITE
4852 /* Need to do this *after* making the SV normal, as we need the buffer
4853 pointer to remain valid until after we've copied it. If we let go too early,
4854 another thread could invalidate it by unsharing last of the same hash key
4855 (which it can do by means other than releasing copy-on-write Svs)
4856 or by changing the other copy-on-write SVs in the loop. */
4858 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN cur, STRLEN len,
4859 U32 hash, SV *after)
4861 if (len) { /* this SV was SvIsCOW_normal(sv) */
4862 /* we need to find the SV pointing to us. */
4863 SV *current = SV_COW_NEXT_SV(after);
4865 if (current == sv) {
4866 /* The SV we point to points back to us (there were only two of us
4868 Hence other SV is no longer copy on write either. */
4870 SvREADONLY_off(after);
4872 /* We need to follow the pointers around the loop. */
4874 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4877 /* don't loop forever if the structure is bust, and we have
4878 a pointer into a closed loop. */
4879 assert (current != after);
4880 assert (SvPVX_const(current) == pvx);
4882 /* Make the SV before us point to the SV after us. */
4883 SV_COW_NEXT_SV_SET(current, after);
4886 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4891 Perl_sv_release_IVX(pTHX_ register SV *sv)
4894 sv_force_normal_flags(sv, 0);
4900 =for apidoc sv_force_normal_flags
4902 Undo various types of fakery on an SV: if the PV is a shared string, make
4903 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4904 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4905 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4906 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4907 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4908 set to some other value.) In addition, the C<flags> parameter gets passed to
4909 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4910 with flags set to 0.
4916 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4918 #ifdef PERL_COPY_ON_WRITE
4919 if (SvREADONLY(sv)) {
4920 /* At this point I believe I should acquire a global SV mutex. */
4922 const char *pvx = SvPVX_const(sv);
4923 STRLEN len = SvLEN(sv);
4924 STRLEN cur = SvCUR(sv);
4925 U32 hash = SvUVX(sv);
4926 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4928 PerlIO_printf(Perl_debug_log,
4929 "Copy on write: Force normal %ld\n",
4935 /* This SV doesn't own the buffer, so need to New() a new one: */
4936 SvPV_set(sv, (char*)0);
4938 if (flags & SV_COW_DROP_PV) {
4939 /* OK, so we don't need to copy our buffer. */
4942 SvGROW(sv, cur + 1);
4943 Move(pvx,SvPVX(sv),cur,char);
4947 sv_release_COW(sv, pvx, cur, len, hash, next);
4952 else if (IN_PERL_RUNTIME)
4953 Perl_croak(aTHX_ PL_no_modify);
4954 /* At this point I believe that I can drop the global SV mutex. */
4957 if (SvREADONLY(sv)) {
4959 const char *pvx = SvPVX_const(sv);
4960 const int is_utf8 = SvUTF8(sv);
4961 STRLEN len = SvCUR(sv);
4962 U32 hash = SvUVX(sv);
4965 SvPV_set(sv, (char*)0);
4967 SvGROW(sv, len + 1);
4968 Move(pvx,SvPVX_const(sv),len,char);
4970 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4972 else if (IN_PERL_RUNTIME)
4973 Perl_croak(aTHX_ PL_no_modify);
4977 sv_unref_flags(sv, flags);
4978 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4983 =for apidoc sv_force_normal
4985 Undo various types of fakery on an SV: if the PV is a shared string, make
4986 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4987 an xpvmg. See also C<sv_force_normal_flags>.
4993 Perl_sv_force_normal(pTHX_ register SV *sv)
4995 sv_force_normal_flags(sv, 0);
5001 Efficient removal of characters from the beginning of the string buffer.
5002 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5003 the string buffer. The C<ptr> becomes the first character of the adjusted
5004 string. Uses the "OOK hack".
5005 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5006 refer to the same chunk of data.
5012 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5014 register STRLEN delta;
5015 if (!ptr || !SvPOKp(sv))
5017 delta = ptr - SvPVX_const(sv);
5018 SV_CHECK_THINKFIRST(sv);
5019 if (SvTYPE(sv) < SVt_PVIV)
5020 sv_upgrade(sv,SVt_PVIV);
5023 if (!SvLEN(sv)) { /* make copy of shared string */
5024 const char *pvx = SvPVX_const(sv);
5025 STRLEN len = SvCUR(sv);
5026 SvGROW(sv, len + 1);
5027 Move(pvx,SvPVX_const(sv),len,char);
5031 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5032 and we do that anyway inside the SvNIOK_off
5034 SvFLAGS(sv) |= SVf_OOK;
5037 SvLEN_set(sv, SvLEN(sv) - delta);
5038 SvCUR_set(sv, SvCUR(sv) - delta);
5039 SvPV_set(sv, SvPVX(sv) + delta);
5040 SvIV_set(sv, SvIVX(sv) + delta);
5043 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5044 * this function provided for binary compatibility only
5048 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5050 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5054 =for apidoc sv_catpvn
5056 Concatenates the string onto the end of the string which is in the SV. The
5057 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5058 status set, then the bytes appended should be valid UTF-8.
5059 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5061 =for apidoc sv_catpvn_flags
5063 Concatenates the string onto the end of the string which is in the SV. The
5064 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5065 status set, then the bytes appended should be valid UTF-8.
5066 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5067 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5068 in terms of this function.
5074 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5077 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5079 SvGROW(dsv, dlen + slen + 1);
5081 sstr = SvPVX_const(dsv);
5082 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5083 SvCUR_set(dsv, SvCUR(dsv) + slen);
5085 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5090 =for apidoc sv_catpvn_mg
5092 Like C<sv_catpvn>, but also handles 'set' magic.
5098 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5100 sv_catpvn(sv,ptr,len);
5104 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5105 * this function provided for binary compatibility only
5109 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5111 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5115 =for apidoc sv_catsv
5117 Concatenates the string from SV C<ssv> onto the end of the string in
5118 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5119 not 'set' magic. See C<sv_catsv_mg>.
5121 =for apidoc sv_catsv_flags
5123 Concatenates the string from SV C<ssv> onto the end of the string in
5124 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5125 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5126 and C<sv_catsv_nomg> are implemented in terms of this function.
5131 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5137 if ((spv = SvPV(ssv, slen))) {
5138 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5139 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5140 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5141 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5142 dsv->sv_flags doesn't have that bit set.
5143 Andy Dougherty 12 Oct 2001
5145 const I32 sutf8 = DO_UTF8(ssv);
5148 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5150 dutf8 = DO_UTF8(dsv);
5152 if (dutf8 != sutf8) {
5154 /* Not modifying source SV, so taking a temporary copy. */
5155 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5157 sv_utf8_upgrade(csv);
5158 spv = SvPV(csv, slen);
5161 sv_utf8_upgrade_nomg(dsv);
5163 sv_catpvn_nomg(dsv, spv, slen);
5168 =for apidoc sv_catsv_mg
5170 Like C<sv_catsv>, but also handles 'set' magic.
5176 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5183 =for apidoc sv_catpv
5185 Concatenates the string onto the end of the string which is in the SV.
5186 If the SV has the UTF-8 status set, then the bytes appended should be
5187 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5192 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5194 register STRLEN len;
5200 junk = SvPV_force(sv, tlen);
5202 SvGROW(sv, tlen + len + 1);
5204 ptr = SvPVX_const(sv);
5205 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5206 SvCUR_set(sv, SvCUR(sv) + len);
5207 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5212 =for apidoc sv_catpv_mg
5214 Like C<sv_catpv>, but also handles 'set' magic.
5220 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5229 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5230 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5237 Perl_newSV(pTHX_ STRLEN len)
5243 sv_upgrade(sv, SVt_PV);
5244 SvGROW(sv, len + 1);
5249 =for apidoc sv_magicext
5251 Adds magic to an SV, upgrading it if necessary. Applies the
5252 supplied vtable and returns a pointer to the magic added.
5254 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5255 In particular, you can add magic to SvREADONLY SVs, and add more than
5256 one instance of the same 'how'.
5258 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5259 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5260 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5261 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5263 (This is now used as a subroutine by C<sv_magic>.)
5268 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5269 const char* name, I32 namlen)
5273 if (SvTYPE(sv) < SVt_PVMG) {
5274 (void)SvUPGRADE(sv, SVt_PVMG);
5276 Newz(702,mg, 1, MAGIC);
5277 mg->mg_moremagic = SvMAGIC(sv);
5278 SvMAGIC_set(sv, mg);
5280 /* Sometimes a magic contains a reference loop, where the sv and
5281 object refer to each other. To prevent a reference loop that
5282 would prevent such objects being freed, we look for such loops
5283 and if we find one we avoid incrementing the object refcount.
5285 Note we cannot do this to avoid self-tie loops as intervening RV must
5286 have its REFCNT incremented to keep it in existence.
5289 if (!obj || obj == sv ||
5290 how == PERL_MAGIC_arylen ||
5291 how == PERL_MAGIC_qr ||
5292 how == PERL_MAGIC_symtab ||
5293 (SvTYPE(obj) == SVt_PVGV &&
5294 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5295 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5296 GvFORM(obj) == (CV*)sv)))
5301 mg->mg_obj = SvREFCNT_inc(obj);
5302 mg->mg_flags |= MGf_REFCOUNTED;
5305 /* Normal self-ties simply pass a null object, and instead of
5306 using mg_obj directly, use the SvTIED_obj macro to produce a
5307 new RV as needed. For glob "self-ties", we are tieing the PVIO
5308 with an RV obj pointing to the glob containing the PVIO. In
5309 this case, to avoid a reference loop, we need to weaken the
5313 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5314 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5320 mg->mg_len = namlen;
5323 mg->mg_ptr = savepvn(name, namlen);
5324 else if (namlen == HEf_SVKEY)
5325 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5327 mg->mg_ptr = (char *) name;
5329 mg->mg_virtual = vtable;
5333 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5338 =for apidoc sv_magic
5340 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5341 then adds a new magic item of type C<how> to the head of the magic list.
5343 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5344 handling of the C<name> and C<namlen> arguments.
5346 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5347 to add more than one instance of the same 'how'.
5353 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5355 const MGVTBL *vtable = 0;
5358 #ifdef PERL_COPY_ON_WRITE
5360 sv_force_normal_flags(sv, 0);
5362 if (SvREADONLY(sv)) {
5364 && how != PERL_MAGIC_regex_global
5365 && how != PERL_MAGIC_bm
5366 && how != PERL_MAGIC_fm
5367 && how != PERL_MAGIC_sv
5368 && how != PERL_MAGIC_backref
5371 Perl_croak(aTHX_ PL_no_modify);
5374 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5375 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5376 /* sv_magic() refuses to add a magic of the same 'how' as an
5379 if (how == PERL_MAGIC_taint)
5387 vtable = &PL_vtbl_sv;
5389 case PERL_MAGIC_overload:
5390 vtable = &PL_vtbl_amagic;
5392 case PERL_MAGIC_overload_elem:
5393 vtable = &PL_vtbl_amagicelem;
5395 case PERL_MAGIC_overload_table:
5396 vtable = &PL_vtbl_ovrld;
5399 vtable = &PL_vtbl_bm;
5401 case PERL_MAGIC_regdata:
5402 vtable = &PL_vtbl_regdata;
5404 case PERL_MAGIC_regdatum:
5405 vtable = &PL_vtbl_regdatum;
5407 case PERL_MAGIC_env:
5408 vtable = &PL_vtbl_env;
5411 vtable = &PL_vtbl_fm;
5413 case PERL_MAGIC_envelem:
5414 vtable = &PL_vtbl_envelem;
5416 case PERL_MAGIC_regex_global:
5417 vtable = &PL_vtbl_mglob;
5419 case PERL_MAGIC_isa:
5420 vtable = &PL_vtbl_isa;
5422 case PERL_MAGIC_isaelem:
5423 vtable = &PL_vtbl_isaelem;
5425 case PERL_MAGIC_nkeys:
5426 vtable = &PL_vtbl_nkeys;
5428 case PERL_MAGIC_dbfile:
5431 case PERL_MAGIC_dbline:
5432 vtable = &PL_vtbl_dbline;
5434 #ifdef USE_LOCALE_COLLATE
5435 case PERL_MAGIC_collxfrm:
5436 vtable = &PL_vtbl_collxfrm;
5438 #endif /* USE_LOCALE_COLLATE */
5439 case PERL_MAGIC_tied:
5440 vtable = &PL_vtbl_pack;
5442 case PERL_MAGIC_tiedelem:
5443 case PERL_MAGIC_tiedscalar:
5444 vtable = &PL_vtbl_packelem;
5447 vtable = &PL_vtbl_regexp;
5449 case PERL_MAGIC_sig:
5450 vtable = &PL_vtbl_sig;
5452 case PERL_MAGIC_sigelem:
5453 vtable = &PL_vtbl_sigelem;
5455 case PERL_MAGIC_taint:
5456 vtable = &PL_vtbl_taint;
5458 case PERL_MAGIC_uvar:
5459 vtable = &PL_vtbl_uvar;
5461 case PERL_MAGIC_vec:
5462 vtable = &PL_vtbl_vec;
5464 case PERL_MAGIC_arylen_p:
5465 case PERL_MAGIC_rhash:
5466 case PERL_MAGIC_symtab:
5467 case PERL_MAGIC_vstring:
5470 case PERL_MAGIC_utf8:
5471 vtable = &PL_vtbl_utf8;
5473 case PERL_MAGIC_substr:
5474 vtable = &PL_vtbl_substr;
5476 case PERL_MAGIC_defelem:
5477 vtable = &PL_vtbl_defelem;
5479 case PERL_MAGIC_glob:
5480 vtable = &PL_vtbl_glob;
5482 case PERL_MAGIC_arylen:
5483 vtable = &PL_vtbl_arylen;
5485 case PERL_MAGIC_pos:
5486 vtable = &PL_vtbl_pos;
5488 case PERL_MAGIC_backref:
5489 vtable = &PL_vtbl_backref;
5491 case PERL_MAGIC_ext:
5492 /* Reserved for use by extensions not perl internals. */
5493 /* Useful for attaching extension internal data to perl vars. */
5494 /* Note that multiple extensions may clash if magical scalars */
5495 /* etc holding private data from one are passed to another. */
5498 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5501 /* Rest of work is done else where */
5502 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5505 case PERL_MAGIC_taint:
5508 case PERL_MAGIC_ext:
5509 case PERL_MAGIC_dbfile:
5516 =for apidoc sv_unmagic
5518 Removes all magic of type C<type> from an SV.
5524 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5528 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5531 for (mg = *mgp; mg; mg = *mgp) {
5532 if (mg->mg_type == type) {
5533 const MGVTBL* const vtbl = mg->mg_virtual;
5534 *mgp = mg->mg_moremagic;
5535 if (vtbl && vtbl->svt_free)
5536 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5537 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5539 Safefree(mg->mg_ptr);
5540 else if (mg->mg_len == HEf_SVKEY)
5541 SvREFCNT_dec((SV*)mg->mg_ptr);
5542 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5543 Safefree(mg->mg_ptr);
5545 if (mg->mg_flags & MGf_REFCOUNTED)
5546 SvREFCNT_dec(mg->mg_obj);
5550 mgp = &mg->mg_moremagic;
5554 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5561 =for apidoc sv_rvweaken
5563 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5564 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5565 push a back-reference to this RV onto the array of backreferences
5566 associated with that magic.
5572 Perl_sv_rvweaken(pTHX_ SV *sv)
5575 if (!SvOK(sv)) /* let undefs pass */
5578 Perl_croak(aTHX_ "Can't weaken a nonreference");
5579 else if (SvWEAKREF(sv)) {
5580 if (ckWARN(WARN_MISC))
5581 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5585 sv_add_backref(tsv, sv);
5591 /* Give tsv backref magic if it hasn't already got it, then push a
5592 * back-reference to sv onto the array associated with the backref magic.
5596 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5600 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5601 av = (AV*)mg->mg_obj;
5604 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5605 /* av now has a refcnt of 2, which avoids it getting freed
5606 * before us during global cleanup. The extra ref is removed
5607 * by magic_killbackrefs() when tsv is being freed */
5609 if (AvFILLp(av) >= AvMAX(av)) {
5611 SV **svp = AvARRAY(av);
5612 for (i = AvFILLp(av); i >= 0; i--)
5614 svp[i] = sv; /* reuse the slot */
5617 av_extend(av, AvFILLp(av)+1);
5619 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5622 /* delete a back-reference to ourselves from the backref magic associated
5623 * with the SV we point to.
5627 S_sv_del_backref(pTHX_ SV *sv)
5634 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5635 Perl_croak(aTHX_ "panic: del_backref");
5636 av = (AV *)mg->mg_obj;
5638 for (i = AvFILLp(av); i >= 0; i--)
5639 if (svp[i] == sv) svp[i] = Nullsv;
5643 =for apidoc sv_insert
5645 Inserts a string at the specified offset/length within the SV. Similar to
5646 the Perl substr() function.
5652 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5656 register char *midend;
5657 register char *bigend;
5663 Perl_croak(aTHX_ "Can't modify non-existent substring");
5664 SvPV_force(bigstr, curlen);
5665 (void)SvPOK_only_UTF8(bigstr);
5666 if (offset + len > curlen) {
5667 SvGROW(bigstr, offset+len+1);
5668 Zero(SvPVX_const(bigstr)+curlen, offset+len-curlen, char);
5669 SvCUR_set(bigstr, offset+len);
5673 i = littlelen - len;
5674 if (i > 0) { /* string might grow */
5675 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5676 mid = big + offset + len;
5677 midend = bigend = big + SvCUR(bigstr);
5680 while (midend > mid) /* shove everything down */
5681 *--bigend = *--midend;
5682 Move(little,big+offset,littlelen,char);
5683 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5688 Move(little,SvPVX(bigstr)+offset,len,char);
5693 big = SvPVX(bigstr);
5696 bigend = big + SvCUR(bigstr);
5698 if (midend > bigend)
5699 Perl_croak(aTHX_ "panic: sv_insert");
5701 if (mid - big > bigend - midend) { /* faster to shorten from end */
5703 Move(little, mid, littlelen,char);
5706 i = bigend - midend;
5708 Move(midend, mid, i,char);
5712 SvCUR_set(bigstr, mid - big);
5715 else if ((i = mid - big)) { /* faster from front */
5716 midend -= littlelen;
5718 sv_chop(bigstr,midend-i);
5723 Move(little, mid, littlelen,char);
5725 else if (littlelen) {
5726 midend -= littlelen;
5727 sv_chop(bigstr,midend);
5728 Move(little,midend,littlelen,char);
5731 sv_chop(bigstr,midend);
5737 =for apidoc sv_replace
5739 Make the first argument a copy of the second, then delete the original.
5740 The target SV physically takes over ownership of the body of the source SV
5741 and inherits its flags; however, the target keeps any magic it owns,
5742 and any magic in the source is discarded.
5743 Note that this is a rather specialist SV copying operation; most of the
5744 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5750 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5752 const U32 refcnt = SvREFCNT(sv);
5753 SV_CHECK_THINKFIRST_COW_DROP(sv);
5754 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5755 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5756 if (SvMAGICAL(sv)) {
5760 sv_upgrade(nsv, SVt_PVMG);
5761 SvMAGIC_set(nsv, SvMAGIC(sv));
5762 SvFLAGS(nsv) |= SvMAGICAL(sv);
5764 SvMAGIC_set(sv, NULL);
5768 assert(!SvREFCNT(sv));
5769 #ifdef DEBUG_LEAKING_SCALARS
5770 sv->sv_flags = nsv->sv_flags;
5771 sv->sv_any = nsv->sv_any;
5772 sv->sv_refcnt = nsv->sv_refcnt;
5774 StructCopy(nsv,sv,SV);
5776 /* Currently could join these into one piece of pointer arithmetic, but
5777 it would be unclear. */
5778 if(SvTYPE(sv) == SVt_IV)
5780 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5781 else if (SvTYPE(sv) == SVt_RV) {
5782 SvANY(sv) = &sv->sv_u.svu_rv;
5786 #ifdef PERL_COPY_ON_WRITE
5787 if (SvIsCOW_normal(nsv)) {
5788 /* We need to follow the pointers around the loop to make the
5789 previous SV point to sv, rather than nsv. */
5792 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5795 assert(SvPVX_const(current) == SvPVX_const(nsv));
5797 /* Make the SV before us point to the SV after us. */
5799 PerlIO_printf(Perl_debug_log, "previous is\n");
5801 PerlIO_printf(Perl_debug_log,
5802 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5803 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5805 SV_COW_NEXT_SV_SET(current, sv);
5808 SvREFCNT(sv) = refcnt;
5809 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5815 =for apidoc sv_clear
5817 Clear an SV: call any destructors, free up any memory used by the body,
5818 and free the body itself. The SV's head is I<not> freed, although
5819 its type is set to all 1's so that it won't inadvertently be assumed
5820 to be live during global destruction etc.
5821 This function should only be called when REFCNT is zero. Most of the time
5822 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5829 Perl_sv_clear(pTHX_ register SV *sv)
5834 assert(SvREFCNT(sv) == 0);
5837 if (PL_defstash) { /* Still have a symbol table? */
5841 stash = SvSTASH(sv);
5842 destructor = StashHANDLER(stash,DESTROY);
5844 SV* tmpref = newRV(sv);
5845 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5847 PUSHSTACKi(PERLSI_DESTROY);
5852 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5858 if(SvREFCNT(tmpref) < 2) {
5859 /* tmpref is not kept alive! */
5861 SvRV_set(tmpref, NULL);
5864 SvREFCNT_dec(tmpref);
5866 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5870 if (PL_in_clean_objs)
5871 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5873 /* DESTROY gave object new lease on life */
5879 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5880 SvOBJECT_off(sv); /* Curse the object. */
5881 if (SvTYPE(sv) != SVt_PVIO)
5882 --PL_sv_objcount; /* XXX Might want something more general */
5885 if (SvTYPE(sv) >= SVt_PVMG) {
5888 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5889 SvREFCNT_dec(SvSTASH(sv));
5892 switch (SvTYPE(sv)) {
5895 IoIFP(sv) != PerlIO_stdin() &&
5896 IoIFP(sv) != PerlIO_stdout() &&
5897 IoIFP(sv) != PerlIO_stderr())
5899 io_close((IO*)sv, FALSE);
5901 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5902 PerlDir_close(IoDIRP(sv));
5903 IoDIRP(sv) = (DIR*)NULL;
5904 Safefree(IoTOP_NAME(sv));
5905 Safefree(IoFMT_NAME(sv));
5906 Safefree(IoBOTTOM_NAME(sv));
5921 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5922 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5923 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5924 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5926 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5927 SvREFCNT_dec(LvTARG(sv));
5931 Safefree(GvNAME(sv));
5932 /* cannot decrease stash refcount yet, as we might recursively delete
5933 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5934 of stash until current sv is completely gone.
5935 -- JohnPC, 27 Mar 1998 */
5936 stash = GvSTASH(sv);
5942 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5944 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5945 /* Don't even bother with turning off the OOK flag. */
5954 SvREFCNT_dec(SvRV(sv));
5956 #ifdef PERL_COPY_ON_WRITE
5957 else if (SvPVX_const(sv)) {
5959 /* I believe I need to grab the global SV mutex here and
5960 then recheck the COW status. */
5962 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5965 sv_release_COW(sv, SvPVX_const(sv), SvCUR(sv), SvLEN(sv),
5966 SvUVX(sv), SV_COW_NEXT_SV(sv));
5967 /* And drop it here. */
5969 } else if (SvLEN(sv)) {
5970 Safefree(SvPVX_const(sv));
5974 else if (SvPVX_const(sv) && SvLEN(sv))
5975 Safefree(SvPVX_const(sv));
5976 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5977 unsharepvn(SvPVX_const(sv),
5978 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5992 switch (SvTYPE(sv)) {
6006 del_XPVIV(SvANY(sv));
6009 del_XPVNV(SvANY(sv));
6012 del_XPVMG(SvANY(sv));
6015 del_XPVLV(SvANY(sv));
6018 del_XPVAV(SvANY(sv));
6021 del_XPVHV(SvANY(sv));
6024 del_XPVCV(SvANY(sv));
6027 del_XPVGV(SvANY(sv));
6028 /* code duplication for increased performance. */
6029 SvFLAGS(sv) &= SVf_BREAK;
6030 SvFLAGS(sv) |= SVTYPEMASK;
6031 /* decrease refcount of the stash that owns this GV, if any */
6033 SvREFCNT_dec(stash);
6034 return; /* not break, SvFLAGS reset already happened */
6036 del_XPVBM(SvANY(sv));
6039 del_XPVFM(SvANY(sv));
6042 del_XPVIO(SvANY(sv));
6045 SvFLAGS(sv) &= SVf_BREAK;
6046 SvFLAGS(sv) |= SVTYPEMASK;
6050 =for apidoc sv_newref
6052 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6059 Perl_sv_newref(pTHX_ SV *sv)
6069 Decrement an SV's reference count, and if it drops to zero, call
6070 C<sv_clear> to invoke destructors and free up any memory used by
6071 the body; finally, deallocate the SV's head itself.
6072 Normally called via a wrapper macro C<SvREFCNT_dec>.
6078 Perl_sv_free(pTHX_ SV *sv)
6083 if (SvREFCNT(sv) == 0) {
6084 if (SvFLAGS(sv) & SVf_BREAK)
6085 /* this SV's refcnt has been artificially decremented to
6086 * trigger cleanup */
6088 if (PL_in_clean_all) /* All is fair */
6090 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6091 /* make sure SvREFCNT(sv)==0 happens very seldom */
6092 SvREFCNT(sv) = (~(U32)0)/2;
6095 if (ckWARN_d(WARN_INTERNAL))
6096 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6097 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6098 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6101 if (--(SvREFCNT(sv)) > 0)
6103 Perl_sv_free2(aTHX_ sv);
6107 Perl_sv_free2(pTHX_ SV *sv)
6112 if (ckWARN_d(WARN_DEBUGGING))
6113 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6114 "Attempt to free temp prematurely: SV 0x%"UVxf
6115 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6119 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6120 /* make sure SvREFCNT(sv)==0 happens very seldom */
6121 SvREFCNT(sv) = (~(U32)0)/2;
6132 Returns the length of the string in the SV. Handles magic and type
6133 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6139 Perl_sv_len(pTHX_ register SV *sv)
6147 len = mg_length(sv);
6149 (void)SvPV(sv, len);
6154 =for apidoc sv_len_utf8
6156 Returns the number of characters in the string in an SV, counting wide
6157 UTF-8 bytes as a single character. Handles magic and type coercion.
6163 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6164 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6165 * (Note that the mg_len is not the length of the mg_ptr field.)
6170 Perl_sv_len_utf8(pTHX_ register SV *sv)
6176 return mg_length(sv);
6180 const U8 *s = (U8*)SvPV(sv, len);
6181 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6183 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6185 #ifdef PERL_UTF8_CACHE_ASSERT
6186 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6190 ulen = Perl_utf8_length(aTHX_ s, s + len);
6191 if (!mg && !SvREADONLY(sv)) {
6192 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6193 mg = mg_find(sv, PERL_MAGIC_utf8);
6203 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6204 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6205 * between UTF-8 and byte offsets. There are two (substr offset and substr
6206 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6207 * and byte offset) cache positions.
6209 * The mg_len field is used by sv_len_utf8(), see its comments.
6210 * Note that the mg_len is not the length of the mg_ptr field.
6214 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
6218 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6220 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6224 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6226 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6227 (*mgp)->mg_ptr = (char *) *cachep;
6231 (*cachep)[i] = offsetp;
6232 (*cachep)[i+1] = s - start;
6240 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6241 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6242 * between UTF-8 and byte offsets. See also the comments of
6243 * S_utf8_mg_pos_init().
6247 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6251 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6253 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6254 if (*mgp && (*mgp)->mg_ptr) {
6255 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6256 ASSERT_UTF8_CACHE(*cachep);
6257 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6259 else { /* We will skip to the right spot. */
6264 /* The assumption is that going backward is half
6265 * the speed of going forward (that's where the
6266 * 2 * backw in the below comes from). (The real
6267 * figure of course depends on the UTF-8 data.) */
6269 if ((*cachep)[i] > (STRLEN)uoff) {
6271 backw = (*cachep)[i] - (STRLEN)uoff;
6273 if (forw < 2 * backw)
6276 p = start + (*cachep)[i+1];
6278 /* Try this only for the substr offset (i == 0),
6279 * not for the substr length (i == 2). */
6280 else if (i == 0) { /* (*cachep)[i] < uoff */
6281 const STRLEN ulen = sv_len_utf8(sv);
6283 if ((STRLEN)uoff < ulen) {
6284 forw = (STRLEN)uoff - (*cachep)[i];
6285 backw = ulen - (STRLEN)uoff;
6287 if (forw < 2 * backw)
6288 p = start + (*cachep)[i+1];
6293 /* If the string is not long enough for uoff,
6294 * we could extend it, but not at this low a level. */
6298 if (forw < 2 * backw) {
6305 while (UTF8_IS_CONTINUATION(*p))
6310 /* Update the cache. */
6311 (*cachep)[i] = (STRLEN)uoff;
6312 (*cachep)[i+1] = p - start;
6314 /* Drop the stale "length" cache */
6323 if (found) { /* Setup the return values. */
6324 *offsetp = (*cachep)[i+1];
6325 *sp = start + *offsetp;
6328 *offsetp = send - start;
6330 else if (*sp < start) {
6336 #ifdef PERL_UTF8_CACHE_ASSERT
6341 while (n-- && s < send)
6345 assert(*offsetp == s - start);
6346 assert((*cachep)[0] == (STRLEN)uoff);
6347 assert((*cachep)[1] == *offsetp);
6349 ASSERT_UTF8_CACHE(*cachep);
6358 =for apidoc sv_pos_u2b
6360 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6361 the start of the string, to a count of the equivalent number of bytes; if
6362 lenp is non-zero, it does the same to lenp, but this time starting from
6363 the offset, rather than from the start of the string. Handles magic and
6370 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6371 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6372 * byte offsets. See also the comments of S_utf8_mg_pos().
6377 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6385 start = (U8*)SvPV(sv, len);
6390 I32 uoffset = *offsetp;
6395 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6397 if (!found && uoffset > 0) {
6398 while (s < send && uoffset--)
6402 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6404 *offsetp = s - start;
6409 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6413 if (!found && *lenp > 0) {
6416 while (s < send && ulen--)
6420 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6424 ASSERT_UTF8_CACHE(cache);
6436 =for apidoc sv_pos_b2u
6438 Converts the value pointed to by offsetp from a count of bytes from the
6439 start of the string, to a count of the equivalent number of UTF-8 chars.
6440 Handles magic and type coercion.
6446 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6447 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6448 * byte offsets. See also the comments of S_utf8_mg_pos().
6453 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6461 s = (U8*)SvPV(sv, len);
6462 if ((I32)len < *offsetp)
6463 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6465 U8* send = s + *offsetp;
6467 STRLEN *cache = NULL;
6471 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6472 mg = mg_find(sv, PERL_MAGIC_utf8);
6473 if (mg && mg->mg_ptr) {
6474 cache = (STRLEN *) mg->mg_ptr;
6475 if (cache[1] == (STRLEN)*offsetp) {
6476 /* An exact match. */
6477 *offsetp = cache[0];
6481 else if (cache[1] < (STRLEN)*offsetp) {
6482 /* We already know part of the way. */
6485 /* Let the below loop do the rest. */
6487 else { /* cache[1] > *offsetp */
6488 /* We already know all of the way, now we may
6489 * be able to walk back. The same assumption
6490 * is made as in S_utf8_mg_pos(), namely that
6491 * walking backward is twice slower than
6492 * walking forward. */
6493 STRLEN forw = *offsetp;
6494 STRLEN backw = cache[1] - *offsetp;
6496 if (!(forw < 2 * backw)) {
6497 U8 *p = s + cache[1];
6504 while (UTF8_IS_CONTINUATION(*p)) {
6512 *offsetp = cache[0];
6514 /* Drop the stale "length" cache */
6522 ASSERT_UTF8_CACHE(cache);
6528 /* Call utf8n_to_uvchr() to validate the sequence
6529 * (unless a simple non-UTF character) */
6530 if (!UTF8_IS_INVARIANT(*s))
6531 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6540 if (!SvREADONLY(sv)) {
6542 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6543 mg = mg_find(sv, PERL_MAGIC_utf8);
6548 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6549 mg->mg_ptr = (char *) cache;
6554 cache[1] = *offsetp;
6555 /* Drop the stale "length" cache */
6568 Returns a boolean indicating whether the strings in the two SVs are
6569 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6570 coerce its args to strings if necessary.
6576 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6584 SV* svrecode = Nullsv;
6591 pv1 = SvPV(sv1, cur1);
6598 pv2 = SvPV(sv2, cur2);
6600 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6601 /* Differing utf8ness.
6602 * Do not UTF8size the comparands as a side-effect. */
6605 svrecode = newSVpvn(pv2, cur2);
6606 sv_recode_to_utf8(svrecode, PL_encoding);
6607 pv2 = SvPV(svrecode, cur2);
6610 svrecode = newSVpvn(pv1, cur1);
6611 sv_recode_to_utf8(svrecode, PL_encoding);
6612 pv1 = SvPV(svrecode, cur1);
6614 /* Now both are in UTF-8. */
6616 SvREFCNT_dec(svrecode);
6621 bool is_utf8 = TRUE;
6624 /* sv1 is the UTF-8 one,
6625 * if is equal it must be downgrade-able */
6626 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6632 /* sv2 is the UTF-8 one,
6633 * if is equal it must be downgrade-able */
6634 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6640 /* Downgrade not possible - cannot be eq */
6648 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6651 SvREFCNT_dec(svrecode);
6662 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6663 string in C<sv1> is less than, equal to, or greater than the string in
6664 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6665 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6671 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6674 const char *pv1, *pv2;
6677 SV *svrecode = Nullsv;
6684 pv1 = SvPV(sv1, cur1);
6691 pv2 = SvPV(sv2, cur2);
6693 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6694 /* Differing utf8ness.
6695 * Do not UTF8size the comparands as a side-effect. */
6698 svrecode = newSVpvn(pv2, cur2);
6699 sv_recode_to_utf8(svrecode, PL_encoding);
6700 pv2 = SvPV(svrecode, cur2);
6703 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6708 svrecode = newSVpvn(pv1, cur1);
6709 sv_recode_to_utf8(svrecode, PL_encoding);
6710 pv1 = SvPV(svrecode, cur1);
6713 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6719 cmp = cur2 ? -1 : 0;
6723 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6726 cmp = retval < 0 ? -1 : 1;
6727 } else if (cur1 == cur2) {
6730 cmp = cur1 < cur2 ? -1 : 1;
6735 SvREFCNT_dec(svrecode);
6744 =for apidoc sv_cmp_locale
6746 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6747 'use bytes' aware, handles get magic, and will coerce its args to strings
6748 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6754 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6756 #ifdef USE_LOCALE_COLLATE
6762 if (PL_collation_standard)
6766 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6768 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6770 if (!pv1 || !len1) {
6781 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6784 return retval < 0 ? -1 : 1;
6787 * When the result of collation is equality, that doesn't mean
6788 * that there are no differences -- some locales exclude some
6789 * characters from consideration. So to avoid false equalities,
6790 * we use the raw string as a tiebreaker.
6796 #endif /* USE_LOCALE_COLLATE */
6798 return sv_cmp(sv1, sv2);
6802 #ifdef USE_LOCALE_COLLATE
6805 =for apidoc sv_collxfrm
6807 Add Collate Transform magic to an SV if it doesn't already have it.
6809 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6810 scalar data of the variable, but transformed to such a format that a normal
6811 memory comparison can be used to compare the data according to the locale
6818 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6822 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6823 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6828 Safefree(mg->mg_ptr);
6830 if ((xf = mem_collxfrm(s, len, &xlen))) {
6831 if (SvREADONLY(sv)) {
6834 return xf + sizeof(PL_collation_ix);
6837 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6838 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6851 if (mg && mg->mg_ptr) {
6853 return mg->mg_ptr + sizeof(PL_collation_ix);
6861 #endif /* USE_LOCALE_COLLATE */
6866 Get a line from the filehandle and store it into the SV, optionally
6867 appending to the currently-stored string.
6873 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6877 register STDCHAR rslast;
6878 register STDCHAR *bp;
6884 if (SvTHINKFIRST(sv))
6885 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6886 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6888 However, perlbench says it's slower, because the existing swipe code
6889 is faster than copy on write.
6890 Swings and roundabouts. */
6891 (void)SvUPGRADE(sv, SVt_PV);
6896 if (PerlIO_isutf8(fp)) {
6898 sv_utf8_upgrade_nomg(sv);
6899 sv_pos_u2b(sv,&append,0);
6901 } else if (SvUTF8(sv)) {
6902 SV *tsv = NEWSV(0,0);
6903 sv_gets(tsv, fp, 0);
6904 sv_utf8_upgrade_nomg(tsv);
6905 SvCUR_set(sv,append);
6908 goto return_string_or_null;
6913 if (PerlIO_isutf8(fp))
6916 if (IN_PERL_COMPILETIME) {
6917 /* we always read code in line mode */
6921 else if (RsSNARF(PL_rs)) {
6922 /* If it is a regular disk file use size from stat() as estimate
6923 of amount we are going to read - may result in malloc-ing
6924 more memory than we realy need if layers bellow reduce
6925 size we read (e.g. CRLF or a gzip layer)
6928 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6929 const Off_t offset = PerlIO_tell(fp);
6930 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6931 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6937 else if (RsRECORD(PL_rs)) {
6941 /* Grab the size of the record we're getting */
6942 recsize = SvIV(SvRV(PL_rs));
6943 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6946 /* VMS wants read instead of fread, because fread doesn't respect */
6947 /* RMS record boundaries. This is not necessarily a good thing to be */
6948 /* doing, but we've got no other real choice - except avoid stdio
6949 as implementation - perhaps write a :vms layer ?
6951 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6953 bytesread = PerlIO_read(fp, buffer, recsize);
6957 SvCUR_set(sv, bytesread += append);
6958 buffer[bytesread] = '\0';
6959 goto return_string_or_null;
6961 else if (RsPARA(PL_rs)) {
6967 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6968 if (PerlIO_isutf8(fp)) {
6969 rsptr = SvPVutf8(PL_rs, rslen);
6972 if (SvUTF8(PL_rs)) {
6973 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6974 Perl_croak(aTHX_ "Wide character in $/");
6977 rsptr = SvPV(PL_rs, rslen);
6981 rslast = rslen ? rsptr[rslen - 1] : '\0';
6983 if (rspara) { /* have to do this both before and after */
6984 do { /* to make sure file boundaries work right */
6987 i = PerlIO_getc(fp);
6991 PerlIO_ungetc(fp,i);
6997 /* See if we know enough about I/O mechanism to cheat it ! */
6999 /* This used to be #ifdef test - it is made run-time test for ease
7000 of abstracting out stdio interface. One call should be cheap
7001 enough here - and may even be a macro allowing compile
7005 if (PerlIO_fast_gets(fp)) {
7008 * We're going to steal some values from the stdio struct
7009 * and put EVERYTHING in the innermost loop into registers.
7011 register STDCHAR *ptr;
7015 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7016 /* An ungetc()d char is handled separately from the regular
7017 * buffer, so we getc() it back out and stuff it in the buffer.
7019 i = PerlIO_getc(fp);
7020 if (i == EOF) return 0;
7021 *(--((*fp)->_ptr)) = (unsigned char) i;
7025 /* Here is some breathtakingly efficient cheating */
7027 cnt = PerlIO_get_cnt(fp); /* get count into register */
7028 /* make sure we have the room */
7029 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7030 /* Not room for all of it
7031 if we are looking for a separator and room for some
7033 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7034 /* just process what we have room for */
7035 shortbuffered = cnt - SvLEN(sv) + append + 1;
7036 cnt -= shortbuffered;
7040 /* remember that cnt can be negative */
7041 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7046 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7047 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7048 DEBUG_P(PerlIO_printf(Perl_debug_log,
7049 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7050 DEBUG_P(PerlIO_printf(Perl_debug_log,
7051 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7052 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7053 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7058 while (cnt > 0) { /* this | eat */
7060 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7061 goto thats_all_folks; /* screams | sed :-) */
7065 Copy(ptr, bp, cnt, char); /* this | eat */
7066 bp += cnt; /* screams | dust */
7067 ptr += cnt; /* louder | sed :-) */
7072 if (shortbuffered) { /* oh well, must extend */
7073 cnt = shortbuffered;
7075 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7077 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7078 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7082 DEBUG_P(PerlIO_printf(Perl_debug_log,
7083 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7084 PTR2UV(ptr),(long)cnt));
7085 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7087 DEBUG_P(PerlIO_printf(Perl_debug_log,
7088 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7089 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7090 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7092 /* This used to call 'filbuf' in stdio form, but as that behaves like
7093 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7094 another abstraction. */
7095 i = PerlIO_getc(fp); /* get more characters */
7097 DEBUG_P(PerlIO_printf(Perl_debug_log,
7098 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7099 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7100 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7102 cnt = PerlIO_get_cnt(fp);
7103 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7104 DEBUG_P(PerlIO_printf(Perl_debug_log,
7105 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7107 if (i == EOF) /* all done for ever? */
7108 goto thats_really_all_folks;
7110 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7112 SvGROW(sv, bpx + cnt + 2);
7113 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7115 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7117 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7118 goto thats_all_folks;
7122 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7123 memNE((char*)bp - rslen, rsptr, rslen))
7124 goto screamer; /* go back to the fray */
7125 thats_really_all_folks:
7127 cnt += shortbuffered;
7128 DEBUG_P(PerlIO_printf(Perl_debug_log,
7129 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7130 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7131 DEBUG_P(PerlIO_printf(Perl_debug_log,
7132 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7133 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7134 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7136 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7137 DEBUG_P(PerlIO_printf(Perl_debug_log,
7138 "Screamer: done, len=%ld, string=|%.*s|\n",
7139 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7143 /*The big, slow, and stupid way. */
7144 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7146 New(0, buf, 8192, STDCHAR);
7154 const register STDCHAR *bpe = buf + sizeof(buf);
7156 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7157 ; /* keep reading */
7161 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7162 /* Accomodate broken VAXC compiler, which applies U8 cast to
7163 * both args of ?: operator, causing EOF to change into 255
7166 i = (U8)buf[cnt - 1];
7172 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7174 sv_catpvn(sv, (char *) buf, cnt);
7176 sv_setpvn(sv, (char *) buf, cnt);
7178 if (i != EOF && /* joy */
7180 SvCUR(sv) < rslen ||
7181 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7185 * If we're reading from a TTY and we get a short read,
7186 * indicating that the user hit his EOF character, we need
7187 * to notice it now, because if we try to read from the TTY
7188 * again, the EOF condition will disappear.
7190 * The comparison of cnt to sizeof(buf) is an optimization
7191 * that prevents unnecessary calls to feof().
7195 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7199 #ifdef USE_HEAP_INSTEAD_OF_STACK
7204 if (rspara) { /* have to do this both before and after */
7205 while (i != EOF) { /* to make sure file boundaries work right */
7206 i = PerlIO_getc(fp);
7208 PerlIO_ungetc(fp,i);
7214 return_string_or_null:
7215 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7221 Auto-increment of the value in the SV, doing string to numeric conversion
7222 if necessary. Handles 'get' magic.
7228 Perl_sv_inc(pTHX_ register SV *sv)
7237 if (SvTHINKFIRST(sv)) {
7239 sv_force_normal_flags(sv, 0);
7240 if (SvREADONLY(sv)) {
7241 if (IN_PERL_RUNTIME)
7242 Perl_croak(aTHX_ PL_no_modify);
7246 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7248 i = PTR2IV(SvRV(sv));
7253 flags = SvFLAGS(sv);
7254 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7255 /* It's (privately or publicly) a float, but not tested as an
7256 integer, so test it to see. */
7258 flags = SvFLAGS(sv);
7260 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7261 /* It's publicly an integer, or privately an integer-not-float */
7262 #ifdef PERL_PRESERVE_IVUV
7266 if (SvUVX(sv) == UV_MAX)
7267 sv_setnv(sv, UV_MAX_P1);
7269 (void)SvIOK_only_UV(sv);
7270 SvUV_set(sv, SvUVX(sv) + 1);
7272 if (SvIVX(sv) == IV_MAX)
7273 sv_setuv(sv, (UV)IV_MAX + 1);
7275 (void)SvIOK_only(sv);
7276 SvIV_set(sv, SvIVX(sv) + 1);
7281 if (flags & SVp_NOK) {
7282 (void)SvNOK_only(sv);
7283 SvNV_set(sv, SvNVX(sv) + 1.0);
7287 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7288 if ((flags & SVTYPEMASK) < SVt_PVIV)
7289 sv_upgrade(sv, SVt_IV);
7290 (void)SvIOK_only(sv);
7295 while (isALPHA(*d)) d++;
7296 while (isDIGIT(*d)) d++;
7298 #ifdef PERL_PRESERVE_IVUV
7299 /* Got to punt this as an integer if needs be, but we don't issue
7300 warnings. Probably ought to make the sv_iv_please() that does
7301 the conversion if possible, and silently. */
7302 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7303 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7304 /* Need to try really hard to see if it's an integer.
7305 9.22337203685478e+18 is an integer.
7306 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7307 so $a="9.22337203685478e+18"; $a+0; $a++
7308 needs to be the same as $a="9.22337203685478e+18"; $a++
7315 /* sv_2iv *should* have made this an NV */
7316 if (flags & SVp_NOK) {
7317 (void)SvNOK_only(sv);
7318 SvNV_set(sv, SvNVX(sv) + 1.0);
7321 /* I don't think we can get here. Maybe I should assert this
7322 And if we do get here I suspect that sv_setnv will croak. NWC
7324 #if defined(USE_LONG_DOUBLE)
7325 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",
7326 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7328 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7329 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7332 #endif /* PERL_PRESERVE_IVUV */
7333 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7337 while (d >= SvPVX_const(sv)) {
7345 /* MKS: The original code here died if letters weren't consecutive.
7346 * at least it didn't have to worry about non-C locales. The
7347 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7348 * arranged in order (although not consecutively) and that only
7349 * [A-Za-z] are accepted by isALPHA in the C locale.
7351 if (*d != 'z' && *d != 'Z') {
7352 do { ++*d; } while (!isALPHA(*d));
7355 *(d--) -= 'z' - 'a';
7360 *(d--) -= 'z' - 'a' + 1;
7364 /* oh,oh, the number grew */
7365 SvGROW(sv, SvCUR(sv) + 2);
7366 SvCUR_set(sv, SvCUR(sv) + 1);
7367 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7378 Auto-decrement of the value in the SV, doing string to numeric conversion
7379 if necessary. Handles 'get' magic.
7385 Perl_sv_dec(pTHX_ register SV *sv)
7393 if (SvTHINKFIRST(sv)) {
7395 sv_force_normal_flags(sv, 0);
7396 if (SvREADONLY(sv)) {
7397 if (IN_PERL_RUNTIME)
7398 Perl_croak(aTHX_ PL_no_modify);
7402 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7404 i = PTR2IV(SvRV(sv));
7409 /* Unlike sv_inc we don't have to worry about string-never-numbers
7410 and keeping them magic. But we mustn't warn on punting */
7411 flags = SvFLAGS(sv);
7412 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7413 /* It's publicly an integer, or privately an integer-not-float */
7414 #ifdef PERL_PRESERVE_IVUV
7418 if (SvUVX(sv) == 0) {
7419 (void)SvIOK_only(sv);
7423 (void)SvIOK_only_UV(sv);
7424 SvUV_set(sv, SvUVX(sv) + 1);
7427 if (SvIVX(sv) == IV_MIN)
7428 sv_setnv(sv, (NV)IV_MIN - 1.0);
7430 (void)SvIOK_only(sv);
7431 SvIV_set(sv, SvIVX(sv) - 1);
7436 if (flags & SVp_NOK) {
7437 SvNV_set(sv, SvNVX(sv) - 1.0);
7438 (void)SvNOK_only(sv);
7441 if (!(flags & SVp_POK)) {
7442 if ((flags & SVTYPEMASK) < SVt_PVNV)
7443 sv_upgrade(sv, SVt_NV);
7445 (void)SvNOK_only(sv);
7448 #ifdef PERL_PRESERVE_IVUV
7450 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7451 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7452 /* Need to try really hard to see if it's an integer.
7453 9.22337203685478e+18 is an integer.
7454 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7455 so $a="9.22337203685478e+18"; $a+0; $a--
7456 needs to be the same as $a="9.22337203685478e+18"; $a--
7463 /* sv_2iv *should* have made this an NV */
7464 if (flags & SVp_NOK) {
7465 (void)SvNOK_only(sv);
7466 SvNV_set(sv, SvNVX(sv) - 1.0);
7469 /* I don't think we can get here. Maybe I should assert this
7470 And if we do get here I suspect that sv_setnv will croak. NWC
7472 #if defined(USE_LONG_DOUBLE)
7473 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",
7474 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7476 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7477 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7481 #endif /* PERL_PRESERVE_IVUV */
7482 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7486 =for apidoc sv_mortalcopy
7488 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7489 The new SV is marked as mortal. It will be destroyed "soon", either by an
7490 explicit call to FREETMPS, or by an implicit call at places such as
7491 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7496 /* Make a string that will exist for the duration of the expression
7497 * evaluation. Actually, it may have to last longer than that, but
7498 * hopefully we won't free it until it has been assigned to a
7499 * permanent location. */
7502 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7507 sv_setsv(sv,oldstr);
7509 PL_tmps_stack[++PL_tmps_ix] = sv;
7515 =for apidoc sv_newmortal
7517 Creates a new null SV which is mortal. The reference count of the SV is
7518 set to 1. It will be destroyed "soon", either by an explicit call to
7519 FREETMPS, or by an implicit call at places such as statement boundaries.
7520 See also C<sv_mortalcopy> and C<sv_2mortal>.
7526 Perl_sv_newmortal(pTHX)
7531 SvFLAGS(sv) = SVs_TEMP;
7533 PL_tmps_stack[++PL_tmps_ix] = sv;
7538 =for apidoc sv_2mortal
7540 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7541 by an explicit call to FREETMPS, or by an implicit call at places such as
7542 statement boundaries. SvTEMP() is turned on which means that the SV's
7543 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7544 and C<sv_mortalcopy>.
7550 Perl_sv_2mortal(pTHX_ register SV *sv)
7555 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7558 PL_tmps_stack[++PL_tmps_ix] = sv;
7566 Creates a new SV and copies a string into it. The reference count for the
7567 SV is set to 1. If C<len> is zero, Perl will compute the length using
7568 strlen(). For efficiency, consider using C<newSVpvn> instead.
7574 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7579 sv_setpvn(sv,s,len ? len : strlen(s));
7584 =for apidoc newSVpvn
7586 Creates a new SV and copies a string into it. The reference count for the
7587 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7588 string. You are responsible for ensuring that the source string is at least
7589 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7595 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7600 sv_setpvn(sv,s,len);
7606 =for apidoc newSVpv_hek
7608 Creates a new SV from the hash key structure. It will generate scalars that
7609 point to the shared string table where possible. Returns a new (undefined)
7610 SV if the hek is NULL.
7616 Perl_newSVhek(pTHX_ const HEK *hek)
7625 if (HEK_LEN(hek) == HEf_SVKEY) {
7626 return newSVsv(*(SV**)HEK_KEY(hek));
7628 const int flags = HEK_FLAGS(hek);
7629 if (flags & HVhek_WASUTF8) {
7631 Andreas would like keys he put in as utf8 to come back as utf8
7633 STRLEN utf8_len = HEK_LEN(hek);
7634 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7635 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7638 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7640 } else if (flags & HVhek_REHASH) {
7641 /* We don't have a pointer to the hv, so we have to replicate the
7642 flag into every HEK. This hv is using custom a hasing
7643 algorithm. Hence we can't return a shared string scalar, as
7644 that would contain the (wrong) hash value, and might get passed
7645 into an hv routine with a regular hash */
7647 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7652 /* This will be overwhelminly the most common case. */
7653 return newSVpvn_share(HEK_KEY(hek),
7654 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7660 =for apidoc newSVpvn_share
7662 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7663 table. If the string does not already exist in the table, it is created
7664 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7665 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7666 otherwise the hash is computed. The idea here is that as the string table
7667 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7668 hash lookup will avoid string compare.
7674 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7677 bool is_utf8 = FALSE;
7679 STRLEN tmplen = -len;
7681 /* See the note in hv.c:hv_fetch() --jhi */
7682 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7686 PERL_HASH(hash, src, len);
7688 sv_upgrade(sv, SVt_PVIV);
7689 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7702 #if defined(PERL_IMPLICIT_CONTEXT)
7704 /* pTHX_ magic can't cope with varargs, so this is a no-context
7705 * version of the main function, (which may itself be aliased to us).
7706 * Don't access this version directly.
7710 Perl_newSVpvf_nocontext(const char* pat, ...)
7715 va_start(args, pat);
7716 sv = vnewSVpvf(pat, &args);
7723 =for apidoc newSVpvf
7725 Creates a new SV and initializes it with the string formatted like
7732 Perl_newSVpvf(pTHX_ const char* pat, ...)
7736 va_start(args, pat);
7737 sv = vnewSVpvf(pat, &args);
7742 /* backend for newSVpvf() and newSVpvf_nocontext() */
7745 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7749 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7756 Creates a new SV and copies a floating point value into it.
7757 The reference count for the SV is set to 1.
7763 Perl_newSVnv(pTHX_ NV n)
7775 Creates a new SV and copies an integer into it. The reference count for the
7782 Perl_newSViv(pTHX_ IV i)
7794 Creates a new SV and copies an unsigned integer into it.
7795 The reference count for the SV is set to 1.
7801 Perl_newSVuv(pTHX_ UV u)
7811 =for apidoc newRV_noinc
7813 Creates an RV wrapper for an SV. The reference count for the original
7814 SV is B<not> incremented.
7820 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7825 sv_upgrade(sv, SVt_RV);
7827 SvRV_set(sv, tmpRef);
7832 /* newRV_inc is the official function name to use now.
7833 * newRV_inc is in fact #defined to newRV in sv.h
7837 Perl_newRV(pTHX_ SV *tmpRef)
7839 return newRV_noinc(SvREFCNT_inc(tmpRef));
7845 Creates a new SV which is an exact duplicate of the original SV.
7852 Perl_newSVsv(pTHX_ register SV *old)
7858 if (SvTYPE(old) == SVTYPEMASK) {
7859 if (ckWARN_d(WARN_INTERNAL))
7860 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7864 /* SV_GMAGIC is the default for sv_setv()
7865 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7866 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7867 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7872 =for apidoc sv_reset
7874 Underlying implementation for the C<reset> Perl function.
7875 Note that the perl-level function is vaguely deprecated.
7881 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7884 char todo[PERL_UCHAR_MAX+1];
7889 if (!*s) { /* reset ?? searches */
7890 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7892 PMOP *pm = (PMOP *) mg->mg_obj;
7894 pm->op_pmdynflags &= ~PMdf_USED;
7901 /* reset variables */
7903 if (!HvARRAY(stash))
7906 Zero(todo, 256, char);
7909 I32 i = (unsigned char)*s;
7913 max = (unsigned char)*s++;
7914 for ( ; i <= max; i++) {
7917 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7919 for (entry = HvARRAY(stash)[i];
7921 entry = HeNEXT(entry))
7926 if (!todo[(U8)*HeKEY(entry)])
7928 gv = (GV*)HeVAL(entry);
7930 if (SvTHINKFIRST(sv)) {
7931 if (!SvREADONLY(sv) && SvROK(sv))
7936 if (SvTYPE(sv) >= SVt_PV) {
7938 if (SvPVX_const(sv) != Nullch)
7945 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7948 #ifdef USE_ENVIRON_ARRAY
7950 # ifdef USE_ITHREADS
7951 && PL_curinterp == aTHX
7955 environ[0] = Nullch;
7958 #endif /* !PERL_MICRO */
7968 Using various gambits, try to get an IO from an SV: the IO slot if its a
7969 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7970 named after the PV if we're a string.
7976 Perl_sv_2io(pTHX_ SV *sv)
7981 switch (SvTYPE(sv)) {
7989 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7993 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7995 return sv_2io(SvRV(sv));
7996 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8002 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8011 Using various gambits, try to get a CV from an SV; in addition, try if
8012 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8018 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8025 return *gvp = Nullgv, Nullcv;
8026 switch (SvTYPE(sv)) {
8045 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8046 tryAMAGICunDEREF(to_cv);
8049 if (SvTYPE(sv) == SVt_PVCV) {
8058 Perl_croak(aTHX_ "Not a subroutine reference");
8063 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8069 if (lref && !GvCVu(gv)) {
8072 tmpsv = NEWSV(704,0);
8073 gv_efullname3(tmpsv, gv, Nullch);
8074 /* XXX this is probably not what they think they're getting.
8075 * It has the same effect as "sub name;", i.e. just a forward
8077 newSUB(start_subparse(FALSE, 0),
8078 newSVOP(OP_CONST, 0, tmpsv),
8083 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8093 Returns true if the SV has a true value by Perl's rules.
8094 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8095 instead use an in-line version.
8101 Perl_sv_true(pTHX_ register SV *sv)
8106 const register XPV* tXpv;
8107 if ((tXpv = (XPV*)SvANY(sv)) &&
8108 (tXpv->xpv_cur > 1 ||
8109 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8116 return SvIVX(sv) != 0;
8119 return SvNVX(sv) != 0.0;
8121 return sv_2bool(sv);
8129 A private implementation of the C<SvIVx> macro for compilers which can't
8130 cope with complex macro expressions. Always use the macro instead.
8136 Perl_sv_iv(pTHX_ register SV *sv)
8140 return (IV)SvUVX(sv);
8149 A private implementation of the C<SvUVx> macro for compilers which can't
8150 cope with complex macro expressions. Always use the macro instead.
8156 Perl_sv_uv(pTHX_ register SV *sv)
8161 return (UV)SvIVX(sv);
8169 A private implementation of the C<SvNVx> macro for compilers which can't
8170 cope with complex macro expressions. Always use the macro instead.
8176 Perl_sv_nv(pTHX_ register SV *sv)
8183 /* sv_pv() is now a macro using SvPV_nolen();
8184 * this function provided for binary compatibility only
8188 Perl_sv_pv(pTHX_ SV *sv)
8195 return sv_2pv(sv, &n_a);
8201 Use the C<SvPV_nolen> macro instead
8205 A private implementation of the C<SvPV> macro for compilers which can't
8206 cope with complex macro expressions. Always use the macro instead.
8212 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8218 return sv_2pv(sv, lp);
8223 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8229 return sv_2pv_flags(sv, lp, 0);
8232 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8233 * this function provided for binary compatibility only
8237 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8239 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8243 =for apidoc sv_pvn_force
8245 Get a sensible string out of the SV somehow.
8246 A private implementation of the C<SvPV_force> macro for compilers which
8247 can't cope with complex macro expressions. Always use the macro instead.
8249 =for apidoc sv_pvn_force_flags
8251 Get a sensible string out of the SV somehow.
8252 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8253 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8254 implemented in terms of this function.
8255 You normally want to use the various wrapper macros instead: see
8256 C<SvPV_force> and C<SvPV_force_nomg>
8262 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8265 if (SvTHINKFIRST(sv) && !SvROK(sv))
8266 sv_force_normal_flags(sv, 0);
8273 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8274 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8278 s = sv_2pv_flags(sv, lp, flags);
8279 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8280 const STRLEN len = *lp;
8284 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8285 SvGROW(sv, len + 1);
8286 Move(s,SvPVX_const(sv),len,char);
8291 SvPOK_on(sv); /* validate pointer */
8293 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8294 PTR2UV(sv),SvPVX_const(sv)));
8300 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8301 * this function provided for binary compatibility only
8305 Perl_sv_pvbyte(pTHX_ SV *sv)
8307 sv_utf8_downgrade(sv,0);
8312 =for apidoc sv_pvbyte
8314 Use C<SvPVbyte_nolen> instead.
8316 =for apidoc sv_pvbyten
8318 A private implementation of the C<SvPVbyte> macro for compilers
8319 which can't cope with complex macro expressions. Always use the macro
8326 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8328 sv_utf8_downgrade(sv,0);
8329 return sv_pvn(sv,lp);
8333 =for apidoc sv_pvbyten_force
8335 A private implementation of the C<SvPVbytex_force> macro for compilers
8336 which can't cope with complex macro expressions. Always use the macro
8343 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8345 sv_pvn_force(sv,lp);
8346 sv_utf8_downgrade(sv,0);
8351 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8352 * this function provided for binary compatibility only
8356 Perl_sv_pvutf8(pTHX_ SV *sv)
8358 sv_utf8_upgrade(sv);
8363 =for apidoc sv_pvutf8
8365 Use the C<SvPVutf8_nolen> macro instead
8367 =for apidoc sv_pvutf8n
8369 A private implementation of the C<SvPVutf8> macro for compilers
8370 which can't cope with complex macro expressions. Always use the macro
8377 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8379 sv_utf8_upgrade(sv);
8380 return sv_pvn(sv,lp);
8384 =for apidoc sv_pvutf8n_force
8386 A private implementation of the C<SvPVutf8_force> macro for compilers
8387 which can't cope with complex macro expressions. Always use the macro
8394 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8396 sv_pvn_force(sv,lp);
8397 sv_utf8_upgrade(sv);
8403 =for apidoc sv_reftype
8405 Returns a string describing what the SV is a reference to.
8411 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8413 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8414 inside return suggests a const propagation bug in g++. */
8415 if (ob && SvOBJECT(sv)) {
8416 char *name = HvNAME_get(SvSTASH(sv));
8417 return name ? name : (char *) "__ANON__";
8420 switch (SvTYPE(sv)) {
8437 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8438 /* tied lvalues should appear to be
8439 * scalars for backwards compatitbility */
8440 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8441 ? "SCALAR" : "LVALUE");
8442 case SVt_PVAV: return "ARRAY";
8443 case SVt_PVHV: return "HASH";
8444 case SVt_PVCV: return "CODE";
8445 case SVt_PVGV: return "GLOB";
8446 case SVt_PVFM: return "FORMAT";
8447 case SVt_PVIO: return "IO";
8448 default: return "UNKNOWN";
8454 =for apidoc sv_isobject
8456 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8457 object. If the SV is not an RV, or if the object is not blessed, then this
8464 Perl_sv_isobject(pTHX_ SV *sv)
8481 Returns a boolean indicating whether the SV is blessed into the specified
8482 class. This does not check for subtypes; use C<sv_derived_from> to verify
8483 an inheritance relationship.
8489 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8501 hvname = HvNAME_get(SvSTASH(sv));
8505 return strEQ(hvname, name);
8511 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8512 it will be upgraded to one. If C<classname> is non-null then the new SV will
8513 be blessed in the specified package. The new SV is returned and its
8514 reference count is 1.
8520 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8526 SV_CHECK_THINKFIRST_COW_DROP(rv);
8529 if (SvTYPE(rv) >= SVt_PVMG) {
8530 const U32 refcnt = SvREFCNT(rv);
8534 SvREFCNT(rv) = refcnt;
8537 if (SvTYPE(rv) < SVt_RV)
8538 sv_upgrade(rv, SVt_RV);
8539 else if (SvTYPE(rv) > SVt_RV) {
8550 HV* stash = gv_stashpv(classname, TRUE);
8551 (void)sv_bless(rv, stash);
8557 =for apidoc sv_setref_pv
8559 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8560 argument will be upgraded to an RV. That RV will be modified to point to
8561 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8562 into the 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.
8566 Do not use with other Perl types such as HV, AV, SV, CV, because those
8567 objects will become corrupted by the pointer copy process.
8569 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8575 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8578 sv_setsv(rv, &PL_sv_undef);
8582 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8587 =for apidoc sv_setref_iv
8589 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8590 argument will be upgraded to an RV. That RV will be modified to point to
8591 the new SV. The C<classname> argument indicates the package for the
8592 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8593 will have a reference count of 1, and the RV will be returned.
8599 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8601 sv_setiv(newSVrv(rv,classname), iv);
8606 =for apidoc sv_setref_uv
8608 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8609 argument will be upgraded to an RV. That RV will be modified to point to
8610 the new SV. The C<classname> argument indicates the package for the
8611 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8612 will have a reference count of 1, and the RV will be returned.
8618 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8620 sv_setuv(newSVrv(rv,classname), uv);
8625 =for apidoc sv_setref_nv
8627 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8628 argument will be upgraded to an RV. That RV will be modified to point to
8629 the new SV. The C<classname> argument indicates the package for the
8630 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8631 will have a reference count of 1, and the RV will be returned.
8637 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8639 sv_setnv(newSVrv(rv,classname), nv);
8644 =for apidoc sv_setref_pvn
8646 Copies a string into a new SV, optionally blessing the SV. The length of the
8647 string must be specified with C<n>. The C<rv> argument will be upgraded to
8648 an RV. That RV will be modified to point to the new SV. The C<classname>
8649 argument indicates the package for the blessing. Set C<classname> to
8650 C<Nullch> to avoid the blessing. The new SV will have a reference count
8651 of 1, and the RV will be returned.
8653 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8659 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8661 sv_setpvn(newSVrv(rv,classname), pv, n);
8666 =for apidoc sv_bless
8668 Blesses an SV into a specified package. The SV must be an RV. The package
8669 must be designated by its stash (see C<gv_stashpv()>). The reference count
8670 of the SV is unaffected.
8676 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8680 Perl_croak(aTHX_ "Can't bless non-reference value");
8682 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8683 if (SvREADONLY(tmpRef))
8684 Perl_croak(aTHX_ PL_no_modify);
8685 if (SvOBJECT(tmpRef)) {
8686 if (SvTYPE(tmpRef) != SVt_PVIO)
8688 SvREFCNT_dec(SvSTASH(tmpRef));
8691 SvOBJECT_on(tmpRef);
8692 if (SvTYPE(tmpRef) != SVt_PVIO)
8694 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8695 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8702 if(SvSMAGICAL(tmpRef))
8703 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8711 /* Downgrades a PVGV to a PVMG.
8715 S_sv_unglob(pTHX_ SV *sv)
8719 assert(SvTYPE(sv) == SVt_PVGV);
8724 SvREFCNT_dec(GvSTASH(sv));
8725 GvSTASH(sv) = Nullhv;
8727 sv_unmagic(sv, PERL_MAGIC_glob);
8728 Safefree(GvNAME(sv));
8731 /* need to keep SvANY(sv) in the right arena */
8732 xpvmg = new_XPVMG();
8733 StructCopy(SvANY(sv), xpvmg, XPVMG);
8734 del_XPVGV(SvANY(sv));
8737 SvFLAGS(sv) &= ~SVTYPEMASK;
8738 SvFLAGS(sv) |= SVt_PVMG;
8742 =for apidoc sv_unref_flags
8744 Unsets the RV status of the SV, and decrements the reference count of
8745 whatever was being referenced by the RV. This can almost be thought of
8746 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8747 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8748 (otherwise the decrementing is conditional on the reference count being
8749 different from one or the reference being a readonly SV).
8756 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8760 if (SvWEAKREF(sv)) {
8768 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8769 assigned to as BEGIN {$a = \"Foo"} will fail. */
8770 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8772 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8773 sv_2mortal(rv); /* Schedule for freeing later */
8777 =for apidoc sv_unref
8779 Unsets the RV status of the SV, and decrements the reference count of
8780 whatever was being referenced by the RV. This can almost be thought of
8781 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8782 being zero. See C<SvROK_off>.
8788 Perl_sv_unref(pTHX_ SV *sv)
8790 sv_unref_flags(sv, 0);
8794 =for apidoc sv_taint
8796 Taint an SV. Use C<SvTAINTED_on> instead.
8801 Perl_sv_taint(pTHX_ SV *sv)
8803 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8807 =for apidoc sv_untaint
8809 Untaint an SV. Use C<SvTAINTED_off> instead.
8814 Perl_sv_untaint(pTHX_ SV *sv)
8816 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8817 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8824 =for apidoc sv_tainted
8826 Test an SV for taintedness. Use C<SvTAINTED> instead.
8831 Perl_sv_tainted(pTHX_ SV *sv)
8833 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8834 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8835 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8842 =for apidoc sv_setpviv
8844 Copies an integer into the given SV, also updating its string value.
8845 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8851 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8853 char buf[TYPE_CHARS(UV)];
8855 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8857 sv_setpvn(sv, ptr, ebuf - ptr);
8861 =for apidoc sv_setpviv_mg
8863 Like C<sv_setpviv>, but also handles 'set' magic.
8869 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8871 char buf[TYPE_CHARS(UV)];
8873 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8875 sv_setpvn(sv, ptr, ebuf - ptr);
8879 #if defined(PERL_IMPLICIT_CONTEXT)
8881 /* pTHX_ magic can't cope with varargs, so this is a no-context
8882 * version of the main function, (which may itself be aliased to us).
8883 * Don't access this version directly.
8887 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8891 va_start(args, pat);
8892 sv_vsetpvf(sv, pat, &args);
8896 /* pTHX_ magic can't cope with varargs, so this is a no-context
8897 * version of the main function, (which may itself be aliased to us).
8898 * Don't access this version directly.
8902 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8906 va_start(args, pat);
8907 sv_vsetpvf_mg(sv, pat, &args);
8913 =for apidoc sv_setpvf
8915 Works like C<sv_catpvf> but copies the text into the SV instead of
8916 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8922 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8925 va_start(args, pat);
8926 sv_vsetpvf(sv, pat, &args);
8931 =for apidoc sv_vsetpvf
8933 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8934 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8936 Usually used via its frontend C<sv_setpvf>.
8942 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8944 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8948 =for apidoc sv_setpvf_mg
8950 Like C<sv_setpvf>, but also handles 'set' magic.
8956 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8959 va_start(args, pat);
8960 sv_vsetpvf_mg(sv, pat, &args);
8965 =for apidoc sv_vsetpvf_mg
8967 Like C<sv_vsetpvf>, but also handles 'set' magic.
8969 Usually used via its frontend C<sv_setpvf_mg>.
8975 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8977 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8981 #if defined(PERL_IMPLICIT_CONTEXT)
8983 /* pTHX_ magic can't cope with varargs, so this is a no-context
8984 * version of the main function, (which may itself be aliased to us).
8985 * Don't access this version directly.
8989 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8993 va_start(args, pat);
8994 sv_vcatpvf(sv, pat, &args);
8998 /* pTHX_ magic can't cope with varargs, so this is a no-context
8999 * version of the main function, (which may itself be aliased to us).
9000 * Don't access this version directly.
9004 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9008 va_start(args, pat);
9009 sv_vcatpvf_mg(sv, pat, &args);
9015 =for apidoc sv_catpvf
9017 Processes its arguments like C<sprintf> and appends the formatted
9018 output to an SV. If the appended data contains "wide" characters
9019 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9020 and characters >255 formatted with %c), the original SV might get
9021 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9022 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9023 valid UTF-8; if the original SV was bytes, the pattern should be too.
9028 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9031 va_start(args, pat);
9032 sv_vcatpvf(sv, pat, &args);
9037 =for apidoc sv_vcatpvf
9039 Processes its arguments like C<vsprintf> and appends the formatted output
9040 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9042 Usually used via its frontend C<sv_catpvf>.
9048 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9050 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9054 =for apidoc sv_catpvf_mg
9056 Like C<sv_catpvf>, but also handles 'set' magic.
9062 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9065 va_start(args, pat);
9066 sv_vcatpvf_mg(sv, pat, &args);
9071 =for apidoc sv_vcatpvf_mg
9073 Like C<sv_vcatpvf>, but also handles 'set' magic.
9075 Usually used via its frontend C<sv_catpvf_mg>.
9081 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9083 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9088 =for apidoc sv_vsetpvfn
9090 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9093 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9099 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9101 sv_setpvn(sv, "", 0);
9102 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9105 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9108 S_expect_number(pTHX_ char** pattern)
9111 switch (**pattern) {
9112 case '1': case '2': case '3':
9113 case '4': case '5': case '6':
9114 case '7': case '8': case '9':
9115 while (isDIGIT(**pattern))
9116 var = var * 10 + (*(*pattern)++ - '0');
9120 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9123 F0convert(NV nv, char *endbuf, STRLEN *len)
9125 const int neg = nv < 0;
9134 if (uv & 1 && uv == nv)
9135 uv--; /* Round to even */
9137 const unsigned dig = uv % 10;
9150 =for apidoc sv_vcatpvfn
9152 Processes its arguments like C<vsprintf> and appends the formatted output
9153 to an SV. Uses an array of SVs if the C style variable argument list is
9154 missing (NULL). When running with taint checks enabled, indicates via
9155 C<maybe_tainted> if results are untrustworthy (often due to the use of
9158 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9163 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9166 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9173 static const char nullstr[] = "(null)";
9175 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9176 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9178 /* Times 4: a decimal digit takes more than 3 binary digits.
9179 * NV_DIG: mantissa takes than many decimal digits.
9180 * Plus 32: Playing safe. */
9181 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9182 /* large enough for "%#.#f" --chip */
9183 /* what about long double NVs? --jhi */
9185 /* no matter what, this is a string now */
9186 (void)SvPV_force(sv, origlen);
9188 /* special-case "", "%s", and "%-p" (SVf) */
9191 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9193 const char *s = va_arg(*args, char*);
9194 sv_catpv(sv, s ? s : nullstr);
9196 else if (svix < svmax) {
9197 sv_catsv(sv, *svargs);
9198 if (DO_UTF8(*svargs))
9203 if (patlen == 3 && pat[0] == '%' &&
9204 pat[1] == '-' && pat[2] == 'p') {
9206 argsv = va_arg(*args, SV*);
9207 sv_catsv(sv, argsv);
9214 #ifndef USE_LONG_DOUBLE
9215 /* special-case "%.<number>[gf]" */
9216 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9217 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9218 unsigned digits = 0;
9222 while (*pp >= '0' && *pp <= '9')
9223 digits = 10 * digits + (*pp++ - '0');
9224 if (pp - pat == (int)patlen - 1) {
9228 nv = (NV)va_arg(*args, double);
9229 else if (svix < svmax)
9234 /* Add check for digits != 0 because it seems that some
9235 gconverts are buggy in this case, and we don't yet have
9236 a Configure test for this. */
9237 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9238 /* 0, point, slack */
9239 Gconvert(nv, (int)digits, 0, ebuf);
9241 if (*ebuf) /* May return an empty string for digits==0 */
9244 } else if (!digits) {
9247 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9248 sv_catpvn(sv, p, l);
9254 #endif /* !USE_LONG_DOUBLE */
9256 if (!args && svix < svmax && DO_UTF8(*svargs))
9259 patend = (char*)pat + patlen;
9260 for (p = (char*)pat; p < patend; p = q) {
9263 bool vectorize = FALSE;
9264 bool vectorarg = FALSE;
9265 bool vec_utf8 = FALSE;
9271 bool has_precis = FALSE;
9274 bool is_utf8 = FALSE; /* is this item utf8? */
9275 #ifdef HAS_LDBL_SPRINTF_BUG
9276 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9277 with sfio - Allen <allens@cpan.org> */
9278 bool fix_ldbl_sprintf_bug = FALSE;
9282 U8 utf8buf[UTF8_MAXBYTES+1];
9283 STRLEN esignlen = 0;
9285 char *eptr = Nullch;
9288 U8 *vecstr = Null(U8*);
9295 /* we need a long double target in case HAS_LONG_DOUBLE but
9298 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9306 const char *dotstr = ".";
9307 STRLEN dotstrlen = 1;
9308 I32 efix = 0; /* explicit format parameter index */
9309 I32 ewix = 0; /* explicit width index */
9310 I32 epix = 0; /* explicit precision index */
9311 I32 evix = 0; /* explicit vector index */
9312 bool asterisk = FALSE;
9314 /* echo everything up to the next format specification */
9315 for (q = p; q < patend && *q != '%'; ++q) ;
9317 if (has_utf8 && !pat_utf8)
9318 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9320 sv_catpvn(sv, p, q - p);
9327 We allow format specification elements in this order:
9328 \d+\$ explicit format parameter index
9330 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9331 0 flag (as above): repeated to allow "v02"
9332 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9333 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9335 [%bcdefginopsux_DFOUX] format (mandatory)
9337 if (EXPECT_NUMBER(q, width)) {
9378 if (EXPECT_NUMBER(q, ewix))
9387 if ((vectorarg = asterisk)) {
9399 EXPECT_NUMBER(q, width);
9404 vecsv = va_arg(*args, SV*);
9406 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9407 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9408 dotstr = SvPVx(vecsv, dotstrlen);
9413 vecsv = va_arg(*args, SV*);
9414 vecstr = (U8*)SvPVx(vecsv,veclen);
9415 vec_utf8 = DO_UTF8(vecsv);
9417 else if (efix ? efix <= svmax : svix < svmax) {
9418 vecsv = svargs[efix ? efix-1 : svix++];
9419 vecstr = (U8*)SvPVx(vecsv,veclen);
9420 vec_utf8 = DO_UTF8(vecsv);
9421 /* if this is a version object, we need to return the
9422 * stringified representation (which the SvPVX_const has
9423 * already done for us), but not vectorize the args
9425 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9427 q++; /* skip past the rest of the %vd format */
9428 eptr = (char *) vecstr;
9429 elen = strlen(eptr);
9442 i = va_arg(*args, int);
9444 i = (ewix ? ewix <= svmax : svix < svmax) ?
9445 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9447 width = (i < 0) ? -i : i;
9457 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9459 /* XXX: todo, support specified precision parameter */
9463 i = va_arg(*args, int);
9465 i = (ewix ? ewix <= svmax : svix < svmax)
9466 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9467 precis = (i < 0) ? 0 : i;
9472 precis = precis * 10 + (*q++ - '0');
9481 case 'I': /* Ix, I32x, and I64x */
9483 if (q[1] == '6' && q[2] == '4') {
9489 if (q[1] == '3' && q[2] == '2') {
9499 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9510 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9511 if (*(q + 1) == 'l') { /* lld, llf */
9536 argsv = (efix ? efix <= svmax : svix < svmax) ?
9537 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9544 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9546 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9548 eptr = (char*)utf8buf;
9549 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9560 if (args && !vectorize) {
9561 eptr = va_arg(*args, char*);
9563 #ifdef MACOS_TRADITIONAL
9564 /* On MacOS, %#s format is used for Pascal strings */
9569 elen = strlen(eptr);
9571 eptr = (char *)nullstr;
9572 elen = sizeof nullstr - 1;
9576 eptr = SvPVx(argsv, elen);
9577 if (DO_UTF8(argsv)) {
9578 if (has_precis && precis < elen) {
9580 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9583 if (width) { /* fudge width (can't fudge elen) */
9584 width += elen - sv_len_utf8(argsv);
9592 if (has_precis && elen > precis)
9599 if (left && args) { /* SVf */
9608 argsv = va_arg(*args, SV*);
9609 eptr = SvPVx(argsv, elen);
9614 if (alt || vectorize)
9616 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9634 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9643 esignbuf[esignlen++] = plus;
9647 case 'h': iv = (short)va_arg(*args, int); break;
9648 case 'l': iv = va_arg(*args, long); break;
9649 case 'V': iv = va_arg(*args, IV); break;
9650 default: iv = va_arg(*args, int); break;
9652 case 'q': iv = va_arg(*args, Quad_t); break;
9657 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9659 case 'h': iv = (short)tiv; break;
9660 case 'l': iv = (long)tiv; break;
9662 default: iv = tiv; break;
9664 case 'q': iv = (Quad_t)tiv; break;
9668 if ( !vectorize ) /* we already set uv above */
9673 esignbuf[esignlen++] = plus;
9677 esignbuf[esignlen++] = '-';
9720 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9731 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9732 case 'l': uv = va_arg(*args, unsigned long); break;
9733 case 'V': uv = va_arg(*args, UV); break;
9734 default: uv = va_arg(*args, unsigned); break;
9736 case 'q': uv = va_arg(*args, Uquad_t); break;
9741 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9743 case 'h': uv = (unsigned short)tuv; break;
9744 case 'l': uv = (unsigned long)tuv; break;
9746 default: uv = tuv; break;
9748 case 'q': uv = (Uquad_t)tuv; break;
9754 eptr = ebuf + sizeof ebuf;
9760 p = (char*)((c == 'X')
9761 ? "0123456789ABCDEF" : "0123456789abcdef");
9767 esignbuf[esignlen++] = '0';
9768 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9774 *--eptr = '0' + dig;
9776 if (alt && *eptr != '0')
9782 *--eptr = '0' + dig;
9785 esignbuf[esignlen++] = '0';
9786 esignbuf[esignlen++] = 'b';
9789 default: /* it had better be ten or less */
9792 *--eptr = '0' + dig;
9793 } while (uv /= base);
9796 elen = (ebuf + sizeof ebuf) - eptr;
9799 zeros = precis - elen;
9800 else if (precis == 0 && elen == 1 && *eptr == '0')
9805 /* FLOATING POINT */
9808 c = 'f'; /* maybe %F isn't supported here */
9814 /* This is evil, but floating point is even more evil */
9816 /* for SV-style calling, we can only get NV
9817 for C-style calling, we assume %f is double;
9818 for simplicity we allow any of %Lf, %llf, %qf for long double
9822 #if defined(USE_LONG_DOUBLE)
9826 /* [perl #20339] - we should accept and ignore %lf rather than die */
9830 #if defined(USE_LONG_DOUBLE)
9831 intsize = args ? 0 : 'q';
9835 #if defined(HAS_LONG_DOUBLE)
9844 /* now we need (long double) if intsize == 'q', else (double) */
9845 nv = (args && !vectorize) ?
9846 #if LONG_DOUBLESIZE > DOUBLESIZE
9848 va_arg(*args, long double) :
9849 va_arg(*args, double)
9851 va_arg(*args, double)
9857 if (c != 'e' && c != 'E') {
9859 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9860 will cast our (long double) to (double) */
9861 (void)Perl_frexp(nv, &i);
9862 if (i == PERL_INT_MIN)
9863 Perl_die(aTHX_ "panic: frexp");
9865 need = BIT_DIGITS(i);
9867 need += has_precis ? precis : 6; /* known default */
9872 #ifdef HAS_LDBL_SPRINTF_BUG
9873 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9874 with sfio - Allen <allens@cpan.org> */
9877 # define MY_DBL_MAX DBL_MAX
9878 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9879 # if DOUBLESIZE >= 8
9880 # define MY_DBL_MAX 1.7976931348623157E+308L
9882 # define MY_DBL_MAX 3.40282347E+38L
9886 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9887 # define MY_DBL_MAX_BUG 1L
9889 # define MY_DBL_MAX_BUG MY_DBL_MAX
9893 # define MY_DBL_MIN DBL_MIN
9894 # else /* XXX guessing! -Allen */
9895 # if DOUBLESIZE >= 8
9896 # define MY_DBL_MIN 2.2250738585072014E-308L
9898 # define MY_DBL_MIN 1.17549435E-38L
9902 if ((intsize == 'q') && (c == 'f') &&
9903 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9905 /* it's going to be short enough that
9906 * long double precision is not needed */
9908 if ((nv <= 0L) && (nv >= -0L))
9909 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9911 /* would use Perl_fp_class as a double-check but not
9912 * functional on IRIX - see perl.h comments */
9914 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9915 /* It's within the range that a double can represent */
9916 #if defined(DBL_MAX) && !defined(DBL_MIN)
9917 if ((nv >= ((long double)1/DBL_MAX)) ||
9918 (nv <= (-(long double)1/DBL_MAX)))
9920 fix_ldbl_sprintf_bug = TRUE;
9923 if (fix_ldbl_sprintf_bug == TRUE) {
9933 # undef MY_DBL_MAX_BUG
9936 #endif /* HAS_LDBL_SPRINTF_BUG */
9938 need += 20; /* fudge factor */
9939 if (PL_efloatsize < need) {
9940 Safefree(PL_efloatbuf);
9941 PL_efloatsize = need + 20; /* more fudge */
9942 New(906, PL_efloatbuf, PL_efloatsize, char);
9943 PL_efloatbuf[0] = '\0';
9946 if ( !(width || left || plus || alt) && fill != '0'
9947 && has_precis && intsize != 'q' ) { /* Shortcuts */
9948 /* See earlier comment about buggy Gconvert when digits,
9950 if ( c == 'g' && precis) {
9951 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9952 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9953 goto float_converted;
9954 } else if ( c == 'f' && !precis) {
9955 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9959 eptr = ebuf + sizeof ebuf;
9962 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9963 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9964 if (intsize == 'q') {
9965 /* Copy the one or more characters in a long double
9966 * format before the 'base' ([efgEFG]) character to
9967 * the format string. */
9968 static char const prifldbl[] = PERL_PRIfldbl;
9969 char const *p = prifldbl + sizeof(prifldbl) - 3;
9970 while (p >= prifldbl) { *--eptr = *p--; }
9975 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9980 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9992 /* No taint. Otherwise we are in the strange situation
9993 * where printf() taints but print($float) doesn't.
9995 #if defined(HAS_LONG_DOUBLE)
9997 (void)sprintf(PL_efloatbuf, eptr, nv);
9999 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10001 (void)sprintf(PL_efloatbuf, eptr, nv);
10004 eptr = PL_efloatbuf;
10005 elen = strlen(PL_efloatbuf);
10011 i = SvCUR(sv) - origlen;
10012 if (args && !vectorize) {
10014 case 'h': *(va_arg(*args, short*)) = i; break;
10015 default: *(va_arg(*args, int*)) = i; break;
10016 case 'l': *(va_arg(*args, long*)) = i; break;
10017 case 'V': *(va_arg(*args, IV*)) = i; break;
10019 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10024 sv_setuv_mg(argsv, (UV)i);
10026 continue; /* not "break" */
10032 if (!args && ckWARN(WARN_PRINTF) &&
10033 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10034 SV *msg = sv_newmortal();
10035 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10036 (PL_op->op_type == OP_PRTF) ? "" : "s");
10039 Perl_sv_catpvf(aTHX_ msg,
10040 "\"%%%c\"", c & 0xFF);
10042 Perl_sv_catpvf(aTHX_ msg,
10043 "\"%%\\%03"UVof"\"",
10046 sv_catpv(msg, "end of string");
10047 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10050 /* output mangled stuff ... */
10056 /* ... right here, because formatting flags should not apply */
10057 SvGROW(sv, SvCUR(sv) + elen + 1);
10059 Copy(eptr, p, elen, char);
10062 SvCUR_set(sv, p - SvPVX_const(sv));
10064 continue; /* not "break" */
10067 /* calculate width before utf8_upgrade changes it */
10068 have = esignlen + zeros + elen;
10070 if (is_utf8 != has_utf8) {
10073 sv_utf8_upgrade(sv);
10076 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10077 sv_utf8_upgrade(nsv);
10081 SvGROW(sv, SvCUR(sv) + elen + 1);
10086 need = (have > width ? have : width);
10089 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10091 if (esignlen && fill == '0') {
10092 for (i = 0; i < (int)esignlen; i++)
10093 *p++ = esignbuf[i];
10095 if (gap && !left) {
10096 memset(p, fill, gap);
10099 if (esignlen && fill != '0') {
10100 for (i = 0; i < (int)esignlen; i++)
10101 *p++ = esignbuf[i];
10104 for (i = zeros; i; i--)
10108 Copy(eptr, p, elen, char);
10112 memset(p, ' ', gap);
10117 Copy(dotstr, p, dotstrlen, char);
10121 vectorize = FALSE; /* done iterating over vecstr */
10128 SvCUR_set(sv, p - SvPVX_const(sv));
10136 /* =========================================================================
10138 =head1 Cloning an interpreter
10140 All the macros and functions in this section are for the private use of
10141 the main function, perl_clone().
10143 The foo_dup() functions make an exact copy of an existing foo thinngy.
10144 During the course of a cloning, a hash table is used to map old addresses
10145 to new addresses. The table is created and manipulated with the
10146 ptr_table_* functions.
10150 ============================================================================*/
10153 #if defined(USE_ITHREADS)
10155 #ifndef GpREFCNT_inc
10156 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10160 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10161 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10162 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10163 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10164 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10165 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10166 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10167 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10168 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10169 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10170 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10171 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10172 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10175 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10176 regcomp.c. AMS 20010712 */
10179 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10184 struct reg_substr_datum *s;
10187 return (REGEXP *)NULL;
10189 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10192 len = r->offsets[0];
10193 npar = r->nparens+1;
10195 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10196 Copy(r->program, ret->program, len+1, regnode);
10198 New(0, ret->startp, npar, I32);
10199 Copy(r->startp, ret->startp, npar, I32);
10200 New(0, ret->endp, npar, I32);
10201 Copy(r->startp, ret->startp, npar, I32);
10203 New(0, ret->substrs, 1, struct reg_substr_data);
10204 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10205 s->min_offset = r->substrs->data[i].min_offset;
10206 s->max_offset = r->substrs->data[i].max_offset;
10207 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10208 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10211 ret->regstclass = NULL;
10213 struct reg_data *d;
10214 const int count = r->data->count;
10216 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10217 char, struct reg_data);
10218 New(0, d->what, count, U8);
10221 for (i = 0; i < count; i++) {
10222 d->what[i] = r->data->what[i];
10223 switch (d->what[i]) {
10224 /* legal options are one of: sfpont
10225 see also regcomp.h and pregfree() */
10227 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10230 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10233 /* This is cheating. */
10234 New(0, d->data[i], 1, struct regnode_charclass_class);
10235 StructCopy(r->data->data[i], d->data[i],
10236 struct regnode_charclass_class);
10237 ret->regstclass = (regnode*)d->data[i];
10240 /* Compiled op trees are readonly, and can thus be
10241 shared without duplication. */
10243 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10247 d->data[i] = r->data->data[i];
10250 d->data[i] = r->data->data[i];
10252 ((reg_trie_data*)d->data[i])->refcount++;
10256 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10265 New(0, ret->offsets, 2*len+1, U32);
10266 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10268 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10269 ret->refcnt = r->refcnt;
10270 ret->minlen = r->minlen;
10271 ret->prelen = r->prelen;
10272 ret->nparens = r->nparens;
10273 ret->lastparen = r->lastparen;
10274 ret->lastcloseparen = r->lastcloseparen;
10275 ret->reganch = r->reganch;
10277 ret->sublen = r->sublen;
10279 if (RX_MATCH_COPIED(ret))
10280 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10282 ret->subbeg = Nullch;
10283 #ifdef PERL_COPY_ON_WRITE
10284 ret->saved_copy = Nullsv;
10287 ptr_table_store(PL_ptr_table, r, ret);
10291 /* duplicate a file handle */
10294 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10300 return (PerlIO*)NULL;
10302 /* look for it in the table first */
10303 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10307 /* create anew and remember what it is */
10308 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10309 ptr_table_store(PL_ptr_table, fp, ret);
10313 /* duplicate a directory handle */
10316 Perl_dirp_dup(pTHX_ DIR *dp)
10324 /* duplicate a typeglob */
10327 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10332 /* look for it in the table first */
10333 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10337 /* create anew and remember what it is */
10338 Newz(0, ret, 1, GP);
10339 ptr_table_store(PL_ptr_table, gp, ret);
10342 ret->gp_refcnt = 0; /* must be before any other dups! */
10343 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10344 ret->gp_io = io_dup_inc(gp->gp_io, param);
10345 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10346 ret->gp_av = av_dup_inc(gp->gp_av, param);
10347 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10348 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10349 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10350 ret->gp_cvgen = gp->gp_cvgen;
10351 ret->gp_flags = gp->gp_flags;
10352 ret->gp_line = gp->gp_line;
10353 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10357 /* duplicate a chain of magic */
10360 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10362 MAGIC *mgprev = (MAGIC*)NULL;
10365 return (MAGIC*)NULL;
10366 /* look for it in the table first */
10367 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10371 for (; mg; mg = mg->mg_moremagic) {
10373 Newz(0, nmg, 1, MAGIC);
10375 mgprev->mg_moremagic = nmg;
10378 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10379 nmg->mg_private = mg->mg_private;
10380 nmg->mg_type = mg->mg_type;
10381 nmg->mg_flags = mg->mg_flags;
10382 if (mg->mg_type == PERL_MAGIC_qr) {
10383 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10385 else if(mg->mg_type == PERL_MAGIC_backref) {
10386 const AV * const av = (AV*) mg->mg_obj;
10389 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10391 for (i = AvFILLp(av); i >= 0; i--) {
10392 if (!svp[i]) continue;
10393 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10396 else if (mg->mg_type == PERL_MAGIC_symtab) {
10397 nmg->mg_obj = mg->mg_obj;
10400 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10401 ? sv_dup_inc(mg->mg_obj, param)
10402 : sv_dup(mg->mg_obj, param);
10404 nmg->mg_len = mg->mg_len;
10405 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10406 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10407 if (mg->mg_len > 0) {
10408 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10409 if (mg->mg_type == PERL_MAGIC_overload_table &&
10410 AMT_AMAGIC((AMT*)mg->mg_ptr))
10412 AMT *amtp = (AMT*)mg->mg_ptr;
10413 AMT *namtp = (AMT*)nmg->mg_ptr;
10415 for (i = 1; i < NofAMmeth; i++) {
10416 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10420 else if (mg->mg_len == HEf_SVKEY)
10421 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10423 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10424 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10431 /* create a new pointer-mapping table */
10434 Perl_ptr_table_new(pTHX)
10437 Newz(0, tbl, 1, PTR_TBL_t);
10438 tbl->tbl_max = 511;
10439 tbl->tbl_items = 0;
10440 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10445 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10447 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10455 struct ptr_tbl_ent* pte;
10456 struct ptr_tbl_ent* pteend;
10457 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10458 pte->next = PL_pte_arenaroot;
10459 PL_pte_arenaroot = pte;
10461 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10462 PL_pte_root = ++pte;
10463 while (pte < pteend) {
10464 pte->next = pte + 1;
10470 STATIC struct ptr_tbl_ent*
10473 struct ptr_tbl_ent* pte;
10477 PL_pte_root = pte->next;
10482 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10484 p->next = PL_pte_root;
10488 /* map an existing pointer using a table */
10491 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10493 PTR_TBL_ENT_t *tblent;
10494 const UV hash = PTR_TABLE_HASH(sv);
10496 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10497 for (; tblent; tblent = tblent->next) {
10498 if (tblent->oldval == sv)
10499 return tblent->newval;
10501 return (void*)NULL;
10504 /* add a new entry to a pointer-mapping table */
10507 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10509 PTR_TBL_ENT_t *tblent, **otblent;
10510 /* XXX this may be pessimal on platforms where pointers aren't good
10511 * hash values e.g. if they grow faster in the most significant
10513 const UV hash = PTR_TABLE_HASH(oldv);
10517 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10518 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10519 if (tblent->oldval == oldv) {
10520 tblent->newval = newv;
10524 tblent = S_new_pte(aTHX);
10525 tblent->oldval = oldv;
10526 tblent->newval = newv;
10527 tblent->next = *otblent;
10530 if (!empty && tbl->tbl_items > tbl->tbl_max)
10531 ptr_table_split(tbl);
10534 /* double the hash bucket size of an existing ptr table */
10537 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10539 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10540 const UV oldsize = tbl->tbl_max + 1;
10541 UV newsize = oldsize * 2;
10544 Renew(ary, newsize, PTR_TBL_ENT_t*);
10545 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10546 tbl->tbl_max = --newsize;
10547 tbl->tbl_ary = ary;
10548 for (i=0; i < oldsize; i++, ary++) {
10549 PTR_TBL_ENT_t **curentp, **entp, *ent;
10552 curentp = ary + oldsize;
10553 for (entp = ary, ent = *ary; ent; ent = *entp) {
10554 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10556 ent->next = *curentp;
10566 /* remove all the entries from a ptr table */
10569 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10571 register PTR_TBL_ENT_t **array;
10572 register PTR_TBL_ENT_t *entry;
10576 if (!tbl || !tbl->tbl_items) {
10580 array = tbl->tbl_ary;
10582 max = tbl->tbl_max;
10586 PTR_TBL_ENT_t *oentry = entry;
10587 entry = entry->next;
10588 S_del_pte(aTHX_ oentry);
10591 if (++riter > max) {
10594 entry = array[riter];
10598 tbl->tbl_items = 0;
10601 /* clear and free a ptr table */
10604 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10609 ptr_table_clear(tbl);
10610 Safefree(tbl->tbl_ary);
10614 /* attempt to make everything in the typeglob readonly */
10617 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10619 GV *gv = (GV*)sstr;
10620 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10622 if (GvIO(gv) || GvFORM(gv)) {
10623 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10625 else if (!GvCV(gv)) {
10626 GvCV(gv) = (CV*)sv;
10629 /* CvPADLISTs cannot be shared */
10630 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10635 if (!GvUNIQUE(gv)) {
10637 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10638 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10644 * write attempts will die with
10645 * "Modification of a read-only value attempted"
10651 SvREADONLY_on(GvSV(gv));
10655 GvAV(gv) = (AV*)sv;
10658 SvREADONLY_on(GvAV(gv));
10662 GvHV(gv) = (HV*)sv;
10665 SvREADONLY_on(GvHV(gv));
10668 return sstr; /* he_dup() will SvREFCNT_inc() */
10671 /* duplicate an SV of any type (including AV, HV etc) */
10674 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10677 SvRV_set(dstr, SvWEAKREF(sstr)
10678 ? sv_dup(SvRV(sstr), param)
10679 : sv_dup_inc(SvRV(sstr), param));
10682 else if (SvPVX_const(sstr)) {
10683 /* Has something there */
10685 /* Normal PV - clone whole allocated space */
10686 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10687 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10688 /* Not that normal - actually sstr is copy on write.
10689 But we are a true, independant SV, so: */
10690 SvREADONLY_off(dstr);
10695 /* Special case - not normally malloced for some reason */
10696 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10697 /* A "shared" PV - clone it as unshared string */
10698 if(SvPADTMP(sstr)) {
10699 /* However, some of them live in the pad
10700 and they should not have these flags
10703 SvPV_set(dstr, sharepvn(SvPVX_const(sstr), SvCUR(sstr),
10705 SvUV_set(dstr, SvUVX(sstr));
10708 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvCUR(sstr)));
10710 SvREADONLY_off(dstr);
10714 /* Some other special case - random pointer */
10715 SvPV_set(dstr, SvPVX(sstr));
10720 /* Copy the Null */
10721 if (SvTYPE(dstr) == SVt_RV)
10722 SvRV_set(dstr, NULL);
10729 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10734 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10736 /* look for it in the table first */
10737 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10741 if(param->flags & CLONEf_JOIN_IN) {
10742 /** We are joining here so we don't want do clone
10743 something that is bad **/
10744 const char *hvname;
10746 if(SvTYPE(sstr) == SVt_PVHV &&
10747 (hvname = HvNAME_get(sstr))) {
10748 /** don't clone stashes if they already exist **/
10749 HV* old_stash = gv_stashpv(hvname,0);
10750 return (SV*) old_stash;
10754 /* create anew and remember what it is */
10757 #ifdef DEBUG_LEAKING_SCALARS
10758 dstr->sv_debug_optype = sstr->sv_debug_optype;
10759 dstr->sv_debug_line = sstr->sv_debug_line;
10760 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10761 dstr->sv_debug_cloned = 1;
10763 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10765 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10769 ptr_table_store(PL_ptr_table, sstr, dstr);
10772 SvFLAGS(dstr) = SvFLAGS(sstr);
10773 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10774 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10777 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10778 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10779 PL_watch_pvx, SvPVX_const(sstr));
10782 /* don't clone objects whose class has asked us not to */
10783 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10784 SvFLAGS(dstr) &= ~SVTYPEMASK;
10785 SvOBJECT_off(dstr);
10789 switch (SvTYPE(sstr)) {
10791 SvANY(dstr) = NULL;
10794 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10795 SvIV_set(dstr, SvIVX(sstr));
10798 SvANY(dstr) = new_XNV();
10799 SvNV_set(dstr, SvNVX(sstr));
10802 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10803 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10806 SvANY(dstr) = new_XPV();
10807 SvCUR_set(dstr, SvCUR(sstr));
10808 SvLEN_set(dstr, SvLEN(sstr));
10809 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10812 SvANY(dstr) = new_XPVIV();
10813 SvCUR_set(dstr, SvCUR(sstr));
10814 SvLEN_set(dstr, SvLEN(sstr));
10815 SvIV_set(dstr, SvIVX(sstr));
10816 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10819 SvANY(dstr) = new_XPVNV();
10820 SvCUR_set(dstr, SvCUR(sstr));
10821 SvLEN_set(dstr, SvLEN(sstr));
10822 SvIV_set(dstr, SvIVX(sstr));
10823 SvNV_set(dstr, SvNVX(sstr));
10824 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10827 SvANY(dstr) = new_XPVMG();
10828 SvCUR_set(dstr, SvCUR(sstr));
10829 SvLEN_set(dstr, SvLEN(sstr));
10830 SvIV_set(dstr, SvIVX(sstr));
10831 SvNV_set(dstr, SvNVX(sstr));
10832 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10833 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10834 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10837 SvANY(dstr) = new_XPVBM();
10838 SvCUR_set(dstr, SvCUR(sstr));
10839 SvLEN_set(dstr, SvLEN(sstr));
10840 SvIV_set(dstr, SvIVX(sstr));
10841 SvNV_set(dstr, SvNVX(sstr));
10842 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10843 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10844 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10845 BmRARE(dstr) = BmRARE(sstr);
10846 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10847 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10850 SvANY(dstr) = new_XPVLV();
10851 SvCUR_set(dstr, SvCUR(sstr));
10852 SvLEN_set(dstr, SvLEN(sstr));
10853 SvIV_set(dstr, SvIVX(sstr));
10854 SvNV_set(dstr, SvNVX(sstr));
10855 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10856 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10857 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10858 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10859 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10860 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10861 LvTARG(dstr) = dstr;
10862 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10863 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10865 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10866 LvTYPE(dstr) = LvTYPE(sstr);
10869 if (GvUNIQUE((GV*)sstr)) {
10871 if ((share = gv_share(sstr, param))) {
10874 ptr_table_store(PL_ptr_table, sstr, dstr);
10876 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10877 HvNAME_get(GvSTASH(share)), GvNAME(share));
10882 SvANY(dstr) = new_XPVGV();
10883 SvCUR_set(dstr, SvCUR(sstr));
10884 SvLEN_set(dstr, SvLEN(sstr));
10885 SvIV_set(dstr, SvIVX(sstr));
10886 SvNV_set(dstr, SvNVX(sstr));
10887 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10888 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10889 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10890 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10891 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10892 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10893 GvFLAGS(dstr) = GvFLAGS(sstr);
10894 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10895 (void)GpREFCNT_inc(GvGP(dstr));
10898 SvANY(dstr) = new_XPVIO();
10899 SvCUR_set(dstr, SvCUR(sstr));
10900 SvLEN_set(dstr, SvLEN(sstr));
10901 SvIV_set(dstr, SvIVX(sstr));
10902 SvNV_set(dstr, SvNVX(sstr));
10903 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10904 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10905 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10906 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10907 if (IoOFP(sstr) == IoIFP(sstr))
10908 IoOFP(dstr) = IoIFP(dstr);
10910 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10911 /* PL_rsfp_filters entries have fake IoDIRP() */
10912 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10913 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10915 IoDIRP(dstr) = IoDIRP(sstr);
10916 IoLINES(dstr) = IoLINES(sstr);
10917 IoPAGE(dstr) = IoPAGE(sstr);
10918 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10919 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10920 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10921 /* I have no idea why fake dirp (rsfps)
10922 should be treaded differently but otherwise
10923 we end up with leaks -- sky*/
10924 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10925 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10926 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10928 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10929 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10930 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10932 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10933 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10934 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10935 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10936 IoTYPE(dstr) = IoTYPE(sstr);
10937 IoFLAGS(dstr) = IoFLAGS(sstr);
10940 SvANY(dstr) = new_XPVAV();
10941 SvCUR_set(dstr, SvCUR(sstr));
10942 SvLEN_set(dstr, SvLEN(sstr));
10943 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10944 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10945 if (AvARRAY((AV*)sstr)) {
10946 SV **dst_ary, **src_ary;
10947 SSize_t items = AvFILLp((AV*)sstr) + 1;
10949 src_ary = AvARRAY((AV*)sstr);
10950 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10951 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10952 SvPV_set(dstr, (char*)dst_ary);
10953 AvALLOC((AV*)dstr) = dst_ary;
10954 if (AvREAL((AV*)sstr)) {
10955 while (items-- > 0)
10956 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10959 while (items-- > 0)
10960 *dst_ary++ = sv_dup(*src_ary++, param);
10962 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10963 while (items-- > 0) {
10964 *dst_ary++ = &PL_sv_undef;
10968 SvPV_set(dstr, Nullch);
10969 AvALLOC((AV*)dstr) = (SV**)NULL;
10973 SvANY(dstr) = new_XPVHV();
10974 SvCUR_set(dstr, SvCUR(sstr));
10975 SvLEN_set(dstr, SvLEN(sstr));
10976 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10977 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10978 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10982 if (HvARRAY((HV*)sstr)) {
10984 const bool sharekeys = !!HvSHAREKEYS(sstr);
10985 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10986 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10989 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10990 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
10991 HvARRAY(dstr) = (HE**)darray;
10992 while (i <= sxhv->xhv_max) {
10993 HE *source = HvARRAY(sstr)[i];
10995 = source ? he_dup(source, sharekeys, param) : 0;
10999 struct xpvhv_aux *saux = HvAUX(sstr);
11000 struct xpvhv_aux *daux = HvAUX(dstr);
11001 /* This flag isn't copied. */
11002 /* SvOOK_on(hv) attacks the IV flags. */
11003 SvFLAGS(dstr) |= SVf_OOK;
11005 hvname = saux->xhv_name;
11006 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11008 daux->xhv_riter = saux->xhv_riter;
11009 daux->xhv_eiter = saux->xhv_eiter
11010 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11015 SvPV_set(dstr, Nullch);
11017 /* Record stashes for possible cloning in Perl_clone(). */
11019 av_push(param->stashes, dstr);
11023 SvANY(dstr) = new_XPVFM();
11024 FmLINES(dstr) = FmLINES(sstr);
11028 SvANY(dstr) = new_XPVCV();
11030 SvCUR_set(dstr, SvCUR(sstr));
11031 SvLEN_set(dstr, SvLEN(sstr));
11032 SvIV_set(dstr, SvIVX(sstr));
11033 SvNV_set(dstr, SvNVX(sstr));
11034 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11035 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11036 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11037 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11038 CvSTART(dstr) = CvSTART(sstr);
11040 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11042 CvXSUB(dstr) = CvXSUB(sstr);
11043 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11044 if (CvCONST(sstr)) {
11045 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11046 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11047 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11049 /* don't dup if copying back - CvGV isn't refcounted, so the
11050 * duped GV may never be freed. A bit of a hack! DAPM */
11051 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11052 Nullgv : gv_dup(CvGV(sstr), param) ;
11053 if (param->flags & CLONEf_COPY_STACKS) {
11054 CvDEPTH(dstr) = CvDEPTH(sstr);
11058 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11059 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11061 CvWEAKOUTSIDE(sstr)
11062 ? cv_dup( CvOUTSIDE(sstr), param)
11063 : cv_dup_inc(CvOUTSIDE(sstr), param);
11064 CvFLAGS(dstr) = CvFLAGS(sstr);
11065 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11068 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11072 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11078 /* duplicate a context */
11081 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11083 PERL_CONTEXT *ncxs;
11086 return (PERL_CONTEXT*)NULL;
11088 /* look for it in the table first */
11089 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11093 /* create anew and remember what it is */
11094 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11095 ptr_table_store(PL_ptr_table, cxs, ncxs);
11098 PERL_CONTEXT *cx = &cxs[ix];
11099 PERL_CONTEXT *ncx = &ncxs[ix];
11100 ncx->cx_type = cx->cx_type;
11101 if (CxTYPE(cx) == CXt_SUBST) {
11102 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11105 ncx->blk_oldsp = cx->blk_oldsp;
11106 ncx->blk_oldcop = cx->blk_oldcop;
11107 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11108 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11109 ncx->blk_oldpm = cx->blk_oldpm;
11110 ncx->blk_gimme = cx->blk_gimme;
11111 switch (CxTYPE(cx)) {
11113 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11114 ? cv_dup_inc(cx->blk_sub.cv, param)
11115 : cv_dup(cx->blk_sub.cv,param));
11116 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11117 ? av_dup_inc(cx->blk_sub.argarray, param)
11119 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11120 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11121 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11122 ncx->blk_sub.lval = cx->blk_sub.lval;
11123 ncx->blk_sub.retop = cx->blk_sub.retop;
11126 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11127 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11128 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11129 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11130 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11131 ncx->blk_eval.retop = cx->blk_eval.retop;
11134 ncx->blk_loop.label = cx->blk_loop.label;
11135 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11136 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11137 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11138 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11139 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11140 ? cx->blk_loop.iterdata
11141 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11142 ncx->blk_loop.oldcomppad
11143 = (PAD*)ptr_table_fetch(PL_ptr_table,
11144 cx->blk_loop.oldcomppad);
11145 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11146 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11147 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11148 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11149 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11152 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11153 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11154 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11155 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11156 ncx->blk_sub.retop = cx->blk_sub.retop;
11168 /* duplicate a stack info structure */
11171 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11176 return (PERL_SI*)NULL;
11178 /* look for it in the table first */
11179 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11183 /* create anew and remember what it is */
11184 Newz(56, nsi, 1, PERL_SI);
11185 ptr_table_store(PL_ptr_table, si, nsi);
11187 nsi->si_stack = av_dup_inc(si->si_stack, param);
11188 nsi->si_cxix = si->si_cxix;
11189 nsi->si_cxmax = si->si_cxmax;
11190 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11191 nsi->si_type = si->si_type;
11192 nsi->si_prev = si_dup(si->si_prev, param);
11193 nsi->si_next = si_dup(si->si_next, param);
11194 nsi->si_markoff = si->si_markoff;
11199 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11200 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11201 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11202 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11203 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11204 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11205 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11206 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11207 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11208 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11209 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11210 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11211 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11212 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11215 #define pv_dup_inc(p) SAVEPV(p)
11216 #define pv_dup(p) SAVEPV(p)
11217 #define svp_dup_inc(p,pp) any_dup(p,pp)
11219 /* map any object to the new equivent - either something in the
11220 * ptr table, or something in the interpreter structure
11224 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11229 return (void*)NULL;
11231 /* look for it in the table first */
11232 ret = ptr_table_fetch(PL_ptr_table, v);
11236 /* see if it is part of the interpreter structure */
11237 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11238 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11246 /* duplicate the save stack */
11249 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11251 ANY *ss = proto_perl->Tsavestack;
11252 I32 ix = proto_perl->Tsavestack_ix;
11253 I32 max = proto_perl->Tsavestack_max;
11265 void (*dptr) (void*);
11266 void (*dxptr) (pTHX_ void*);
11268 /* Unions for circumventing strict ANSI C89 casting rules. */
11269 union { void *vptr; void (*dptr)(void*); } u1, u2;
11270 union { void *vptr; void (*dxptr)(pTHX_ void*); } u3, u4;
11272 Newz(54, nss, max, ANY);
11275 I32 i = POPINT(ss,ix);
11276 TOPINT(nss,ix) = i;
11278 case SAVEt_ITEM: /* normal string */
11279 sv = (SV*)POPPTR(ss,ix);
11280 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11281 sv = (SV*)POPPTR(ss,ix);
11282 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11284 case SAVEt_SV: /* scalar reference */
11285 sv = (SV*)POPPTR(ss,ix);
11286 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11287 gv = (GV*)POPPTR(ss,ix);
11288 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11290 case SAVEt_GENERIC_PVREF: /* generic char* */
11291 c = (char*)POPPTR(ss,ix);
11292 TOPPTR(nss,ix) = pv_dup(c);
11293 ptr = POPPTR(ss,ix);
11294 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11296 case SAVEt_SHARED_PVREF: /* char* in shared space */
11297 c = (char*)POPPTR(ss,ix);
11298 TOPPTR(nss,ix) = savesharedpv(c);
11299 ptr = POPPTR(ss,ix);
11300 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11302 case SAVEt_GENERIC_SVREF: /* generic sv */
11303 case SAVEt_SVREF: /* scalar reference */
11304 sv = (SV*)POPPTR(ss,ix);
11305 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11306 ptr = POPPTR(ss,ix);
11307 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11309 case SAVEt_AV: /* array reference */
11310 av = (AV*)POPPTR(ss,ix);
11311 TOPPTR(nss,ix) = av_dup_inc(av, param);
11312 gv = (GV*)POPPTR(ss,ix);
11313 TOPPTR(nss,ix) = gv_dup(gv, param);
11315 case SAVEt_HV: /* hash reference */
11316 hv = (HV*)POPPTR(ss,ix);
11317 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11318 gv = (GV*)POPPTR(ss,ix);
11319 TOPPTR(nss,ix) = gv_dup(gv, param);
11321 case SAVEt_INT: /* int reference */
11322 ptr = POPPTR(ss,ix);
11323 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11324 intval = (int)POPINT(ss,ix);
11325 TOPINT(nss,ix) = intval;
11327 case SAVEt_LONG: /* long reference */
11328 ptr = POPPTR(ss,ix);
11329 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11330 longval = (long)POPLONG(ss,ix);
11331 TOPLONG(nss,ix) = longval;
11333 case SAVEt_I32: /* I32 reference */
11334 case SAVEt_I16: /* I16 reference */
11335 case SAVEt_I8: /* I8 reference */
11336 ptr = POPPTR(ss,ix);
11337 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11339 TOPINT(nss,ix) = i;
11341 case SAVEt_IV: /* IV reference */
11342 ptr = POPPTR(ss,ix);
11343 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11345 TOPIV(nss,ix) = iv;
11347 case SAVEt_SPTR: /* SV* reference */
11348 ptr = POPPTR(ss,ix);
11349 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11350 sv = (SV*)POPPTR(ss,ix);
11351 TOPPTR(nss,ix) = sv_dup(sv, param);
11353 case SAVEt_VPTR: /* random* reference */
11354 ptr = POPPTR(ss,ix);
11355 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11356 ptr = POPPTR(ss,ix);
11357 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11359 case SAVEt_PPTR: /* char* reference */
11360 ptr = POPPTR(ss,ix);
11361 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11362 c = (char*)POPPTR(ss,ix);
11363 TOPPTR(nss,ix) = pv_dup(c);
11365 case SAVEt_HPTR: /* HV* reference */
11366 ptr = POPPTR(ss,ix);
11367 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11368 hv = (HV*)POPPTR(ss,ix);
11369 TOPPTR(nss,ix) = hv_dup(hv, param);
11371 case SAVEt_APTR: /* AV* reference */
11372 ptr = POPPTR(ss,ix);
11373 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11374 av = (AV*)POPPTR(ss,ix);
11375 TOPPTR(nss,ix) = av_dup(av, param);
11378 gv = (GV*)POPPTR(ss,ix);
11379 TOPPTR(nss,ix) = gv_dup(gv, param);
11381 case SAVEt_GP: /* scalar reference */
11382 gp = (GP*)POPPTR(ss,ix);
11383 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11384 (void)GpREFCNT_inc(gp);
11385 gv = (GV*)POPPTR(ss,ix);
11386 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11387 c = (char*)POPPTR(ss,ix);
11388 TOPPTR(nss,ix) = pv_dup(c);
11390 TOPIV(nss,ix) = iv;
11392 TOPIV(nss,ix) = iv;
11395 case SAVEt_MORTALIZESV:
11396 sv = (SV*)POPPTR(ss,ix);
11397 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11400 ptr = POPPTR(ss,ix);
11401 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11402 /* these are assumed to be refcounted properly */
11403 switch (((OP*)ptr)->op_type) {
11405 case OP_LEAVESUBLV:
11409 case OP_LEAVEWRITE:
11410 TOPPTR(nss,ix) = ptr;
11415 TOPPTR(nss,ix) = Nullop;
11420 TOPPTR(nss,ix) = Nullop;
11423 c = (char*)POPPTR(ss,ix);
11424 TOPPTR(nss,ix) = pv_dup_inc(c);
11426 case SAVEt_CLEARSV:
11427 longval = POPLONG(ss,ix);
11428 TOPLONG(nss,ix) = longval;
11431 hv = (HV*)POPPTR(ss,ix);
11432 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11433 c = (char*)POPPTR(ss,ix);
11434 TOPPTR(nss,ix) = pv_dup_inc(c);
11436 TOPINT(nss,ix) = i;
11438 case SAVEt_DESTRUCTOR:
11439 ptr = POPPTR(ss,ix);
11440 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11441 dptr = POPDPTR(ss,ix);
11443 u2.vptr = any_dup(u1.vptr, proto_perl);
11444 TOPDPTR(nss,ix) = u2.dptr;
11446 case SAVEt_DESTRUCTOR_X:
11447 ptr = POPPTR(ss,ix);
11448 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11449 dxptr = POPDXPTR(ss,ix);
11451 u4.vptr = any_dup(u3.vptr, proto_perl);;
11452 TOPDXPTR(nss,ix) = u4.dxptr;
11454 case SAVEt_REGCONTEXT:
11457 TOPINT(nss,ix) = i;
11460 case SAVEt_STACK_POS: /* Position on Perl stack */
11462 TOPINT(nss,ix) = i;
11464 case SAVEt_AELEM: /* array element */
11465 sv = (SV*)POPPTR(ss,ix);
11466 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11468 TOPINT(nss,ix) = i;
11469 av = (AV*)POPPTR(ss,ix);
11470 TOPPTR(nss,ix) = av_dup_inc(av, param);
11472 case SAVEt_HELEM: /* hash element */
11473 sv = (SV*)POPPTR(ss,ix);
11474 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11475 sv = (SV*)POPPTR(ss,ix);
11476 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11477 hv = (HV*)POPPTR(ss,ix);
11478 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11481 ptr = POPPTR(ss,ix);
11482 TOPPTR(nss,ix) = ptr;
11486 TOPINT(nss,ix) = i;
11488 case SAVEt_COMPPAD:
11489 av = (AV*)POPPTR(ss,ix);
11490 TOPPTR(nss,ix) = av_dup(av, param);
11493 longval = (long)POPLONG(ss,ix);
11494 TOPLONG(nss,ix) = longval;
11495 ptr = POPPTR(ss,ix);
11496 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11497 sv = (SV*)POPPTR(ss,ix);
11498 TOPPTR(nss,ix) = sv_dup(sv, param);
11501 ptr = POPPTR(ss,ix);
11502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11503 longval = (long)POPBOOL(ss,ix);
11504 TOPBOOL(nss,ix) = (bool)longval;
11506 case SAVEt_SET_SVFLAGS:
11508 TOPINT(nss,ix) = i;
11510 TOPINT(nss,ix) = i;
11511 sv = (SV*)POPPTR(ss,ix);
11512 TOPPTR(nss,ix) = sv_dup(sv, param);
11515 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11523 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11524 * flag to the result. This is done for each stash before cloning starts,
11525 * so we know which stashes want their objects cloned */
11528 do_mark_cloneable_stash(pTHX_ SV *sv)
11530 const HEK *hvname = HvNAME_HEK((HV*)sv);
11532 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11533 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11534 if (cloner && GvCV(cloner)) {
11541 XPUSHs(sv_2mortal(newSVhek(hvname)));
11543 call_sv((SV*)GvCV(cloner), G_SCALAR);
11550 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11558 =for apidoc perl_clone
11560 Create and return a new interpreter by cloning the current one.
11562 perl_clone takes these flags as parameters:
11564 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11565 without it we only clone the data and zero the stacks,
11566 with it we copy the stacks and the new perl interpreter is
11567 ready to run at the exact same point as the previous one.
11568 The pseudo-fork code uses COPY_STACKS while the
11569 threads->new doesn't.
11571 CLONEf_KEEP_PTR_TABLE
11572 perl_clone keeps a ptr_table with the pointer of the old
11573 variable as a key and the new variable as a value,
11574 this allows it to check if something has been cloned and not
11575 clone it again but rather just use the value and increase the
11576 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11577 the ptr_table using the function
11578 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11579 reason to keep it around is if you want to dup some of your own
11580 variable who are outside the graph perl scans, example of this
11581 code is in threads.xs create
11584 This is a win32 thing, it is ignored on unix, it tells perls
11585 win32host code (which is c++) to clone itself, this is needed on
11586 win32 if you want to run two threads at the same time,
11587 if you just want to do some stuff in a separate perl interpreter
11588 and then throw it away and return to the original one,
11589 you don't need to do anything.
11594 /* XXX the above needs expanding by someone who actually understands it ! */
11595 EXTERN_C PerlInterpreter *
11596 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11599 perl_clone(PerlInterpreter *proto_perl, UV flags)
11602 #ifdef PERL_IMPLICIT_SYS
11604 /* perlhost.h so we need to call into it
11605 to clone the host, CPerlHost should have a c interface, sky */
11607 if (flags & CLONEf_CLONE_HOST) {
11608 return perl_clone_host(proto_perl,flags);
11610 return perl_clone_using(proto_perl, flags,
11612 proto_perl->IMemShared,
11613 proto_perl->IMemParse,
11615 proto_perl->IStdIO,
11619 proto_perl->IProc);
11623 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11624 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11625 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11626 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11627 struct IPerlDir* ipD, struct IPerlSock* ipS,
11628 struct IPerlProc* ipP)
11630 /* XXX many of the string copies here can be optimized if they're
11631 * constants; they need to be allocated as common memory and just
11632 * their pointers copied. */
11635 CLONE_PARAMS clone_params;
11636 CLONE_PARAMS* param = &clone_params;
11638 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11639 /* for each stash, determine whether its objects should be cloned */
11640 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11641 PERL_SET_THX(my_perl);
11644 Poison(my_perl, 1, PerlInterpreter);
11646 PL_curcop = (COP *)Nullop;
11650 PL_savestack_ix = 0;
11651 PL_savestack_max = -1;
11652 PL_sig_pending = 0;
11653 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11654 # else /* !DEBUGGING */
11655 Zero(my_perl, 1, PerlInterpreter);
11656 # endif /* DEBUGGING */
11658 /* host pointers */
11660 PL_MemShared = ipMS;
11661 PL_MemParse = ipMP;
11668 #else /* !PERL_IMPLICIT_SYS */
11670 CLONE_PARAMS clone_params;
11671 CLONE_PARAMS* param = &clone_params;
11672 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11673 /* for each stash, determine whether its objects should be cloned */
11674 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11675 PERL_SET_THX(my_perl);
11678 Poison(my_perl, 1, PerlInterpreter);
11680 PL_curcop = (COP *)Nullop;
11684 PL_savestack_ix = 0;
11685 PL_savestack_max = -1;
11686 PL_sig_pending = 0;
11687 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11688 # else /* !DEBUGGING */
11689 Zero(my_perl, 1, PerlInterpreter);
11690 # endif /* DEBUGGING */
11691 #endif /* PERL_IMPLICIT_SYS */
11692 param->flags = flags;
11693 param->proto_perl = proto_perl;
11696 PL_xnv_arenaroot = NULL;
11697 PL_xnv_root = NULL;
11698 PL_xpv_arenaroot = NULL;
11699 PL_xpv_root = NULL;
11700 PL_xpviv_arenaroot = NULL;
11701 PL_xpviv_root = NULL;
11702 PL_xpvnv_arenaroot = NULL;
11703 PL_xpvnv_root = NULL;
11704 PL_xpvcv_arenaroot = NULL;
11705 PL_xpvcv_root = NULL;
11706 PL_xpvav_arenaroot = NULL;
11707 PL_xpvav_root = NULL;
11708 PL_xpvhv_arenaroot = NULL;
11709 PL_xpvhv_root = NULL;
11710 PL_xpvmg_arenaroot = NULL;
11711 PL_xpvmg_root = NULL;
11712 PL_xpvgv_arenaroot = NULL;
11713 PL_xpvgv_root = NULL;
11714 PL_xpvlv_arenaroot = NULL;
11715 PL_xpvlv_root = NULL;
11716 PL_xpvbm_arenaroot = NULL;
11717 PL_xpvbm_root = NULL;
11718 PL_he_arenaroot = NULL;
11720 #if defined(USE_ITHREADS)
11721 PL_pte_arenaroot = NULL;
11722 PL_pte_root = NULL;
11724 PL_nice_chunk = NULL;
11725 PL_nice_chunk_size = 0;
11727 PL_sv_objcount = 0;
11728 PL_sv_root = Nullsv;
11729 PL_sv_arenaroot = Nullsv;
11731 PL_debug = proto_perl->Idebug;
11733 PL_hash_seed = proto_perl->Ihash_seed;
11734 PL_rehash_seed = proto_perl->Irehash_seed;
11736 #ifdef USE_REENTRANT_API
11737 /* XXX: things like -Dm will segfault here in perlio, but doing
11738 * PERL_SET_CONTEXT(proto_perl);
11739 * breaks too many other things
11741 Perl_reentrant_init(aTHX);
11744 /* create SV map for pointer relocation */
11745 PL_ptr_table = ptr_table_new();
11746 /* and one for finding shared hash keys quickly */
11747 PL_shared_hek_table = ptr_table_new();
11749 /* initialize these special pointers as early as possible */
11750 SvANY(&PL_sv_undef) = NULL;
11751 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11752 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11753 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11755 SvANY(&PL_sv_no) = new_XPVNV();
11756 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11757 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11758 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11759 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11760 SvCUR_set(&PL_sv_no, 0);
11761 SvLEN_set(&PL_sv_no, 1);
11762 SvIV_set(&PL_sv_no, 0);
11763 SvNV_set(&PL_sv_no, 0);
11764 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11766 SvANY(&PL_sv_yes) = new_XPVNV();
11767 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11768 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11769 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11770 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11771 SvCUR_set(&PL_sv_yes, 1);
11772 SvLEN_set(&PL_sv_yes, 2);
11773 SvIV_set(&PL_sv_yes, 1);
11774 SvNV_set(&PL_sv_yes, 1);
11775 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11777 /* create (a non-shared!) shared string table */
11778 PL_strtab = newHV();
11779 HvSHAREKEYS_off(PL_strtab);
11780 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11781 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11783 PL_compiling = proto_perl->Icompiling;
11785 /* These two PVs will be free'd special way so must set them same way op.c does */
11786 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11787 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11789 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11790 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11792 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11793 if (!specialWARN(PL_compiling.cop_warnings))
11794 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11795 if (!specialCopIO(PL_compiling.cop_io))
11796 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11797 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11799 /* pseudo environmental stuff */
11800 PL_origargc = proto_perl->Iorigargc;
11801 PL_origargv = proto_perl->Iorigargv;
11803 param->stashes = newAV(); /* Setup array of objects to call clone on */
11805 #ifdef PERLIO_LAYERS
11806 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11807 PerlIO_clone(aTHX_ proto_perl, param);
11810 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11811 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11812 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11813 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11814 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11815 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11818 PL_minus_c = proto_perl->Iminus_c;
11819 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11820 PL_localpatches = proto_perl->Ilocalpatches;
11821 PL_splitstr = proto_perl->Isplitstr;
11822 PL_preprocess = proto_perl->Ipreprocess;
11823 PL_minus_n = proto_perl->Iminus_n;
11824 PL_minus_p = proto_perl->Iminus_p;
11825 PL_minus_l = proto_perl->Iminus_l;
11826 PL_minus_a = proto_perl->Iminus_a;
11827 PL_minus_F = proto_perl->Iminus_F;
11828 PL_doswitches = proto_perl->Idoswitches;
11829 PL_dowarn = proto_perl->Idowarn;
11830 PL_doextract = proto_perl->Idoextract;
11831 PL_sawampersand = proto_perl->Isawampersand;
11832 PL_unsafe = proto_perl->Iunsafe;
11833 PL_inplace = SAVEPV(proto_perl->Iinplace);
11834 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11835 PL_perldb = proto_perl->Iperldb;
11836 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11837 PL_exit_flags = proto_perl->Iexit_flags;
11839 /* magical thingies */
11840 /* XXX time(&PL_basetime) when asked for? */
11841 PL_basetime = proto_perl->Ibasetime;
11842 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11844 PL_maxsysfd = proto_perl->Imaxsysfd;
11845 PL_multiline = proto_perl->Imultiline;
11846 PL_statusvalue = proto_perl->Istatusvalue;
11848 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11850 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11852 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11853 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11854 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11856 /* Clone the regex array */
11857 PL_regex_padav = newAV();
11859 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11860 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11862 av_push(PL_regex_padav,
11863 sv_dup_inc(regexen[0],param));
11864 for(i = 1; i <= len; i++) {
11865 if(SvREPADTMP(regexen[i])) {
11866 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11868 av_push(PL_regex_padav,
11870 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11871 SvIVX(regexen[i])), param)))
11876 PL_regex_pad = AvARRAY(PL_regex_padav);
11878 /* shortcuts to various I/O objects */
11879 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11880 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11881 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11882 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11883 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11884 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11886 /* shortcuts to regexp stuff */
11887 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11889 /* shortcuts to misc objects */
11890 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11892 /* shortcuts to debugging objects */
11893 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11894 PL_DBline = gv_dup(proto_perl->IDBline, param);
11895 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11896 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11897 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11898 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11899 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11900 PL_lineary = av_dup(proto_perl->Ilineary, param);
11901 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11903 /* symbol tables */
11904 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11905 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11906 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11907 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11908 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11910 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11911 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11912 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11913 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11914 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11915 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11917 PL_sub_generation = proto_perl->Isub_generation;
11919 /* funky return mechanisms */
11920 PL_forkprocess = proto_perl->Iforkprocess;
11922 /* subprocess state */
11923 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11925 /* internal state */
11926 PL_tainting = proto_perl->Itainting;
11927 PL_taint_warn = proto_perl->Itaint_warn;
11928 PL_maxo = proto_perl->Imaxo;
11929 if (proto_perl->Iop_mask)
11930 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11932 PL_op_mask = Nullch;
11933 /* PL_asserting = proto_perl->Iasserting; */
11935 /* current interpreter roots */
11936 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11937 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11938 PL_main_start = proto_perl->Imain_start;
11939 PL_eval_root = proto_perl->Ieval_root;
11940 PL_eval_start = proto_perl->Ieval_start;
11942 /* runtime control stuff */
11943 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11944 PL_copline = proto_perl->Icopline;
11946 PL_filemode = proto_perl->Ifilemode;
11947 PL_lastfd = proto_perl->Ilastfd;
11948 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11951 PL_gensym = proto_perl->Igensym;
11952 PL_preambled = proto_perl->Ipreambled;
11953 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11954 PL_laststatval = proto_perl->Ilaststatval;
11955 PL_laststype = proto_perl->Ilaststype;
11956 PL_mess_sv = Nullsv;
11958 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11959 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11961 /* interpreter atexit processing */
11962 PL_exitlistlen = proto_perl->Iexitlistlen;
11963 if (PL_exitlistlen) {
11964 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11965 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11968 PL_exitlist = (PerlExitListEntry*)NULL;
11969 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11970 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11971 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11973 PL_profiledata = NULL;
11974 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11975 /* PL_rsfp_filters entries have fake IoDIRP() */
11976 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11978 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11980 PAD_CLONE_VARS(proto_perl, param);
11982 #ifdef HAVE_INTERP_INTERN
11983 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11986 /* more statics moved here */
11987 PL_generation = proto_perl->Igeneration;
11988 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11990 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11991 PL_in_clean_all = proto_perl->Iin_clean_all;
11993 PL_uid = proto_perl->Iuid;
11994 PL_euid = proto_perl->Ieuid;
11995 PL_gid = proto_perl->Igid;
11996 PL_egid = proto_perl->Iegid;
11997 PL_nomemok = proto_perl->Inomemok;
11998 PL_an = proto_perl->Ian;
11999 PL_evalseq = proto_perl->Ievalseq;
12000 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12001 PL_origalen = proto_perl->Iorigalen;
12002 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12003 PL_osname = SAVEPV(proto_perl->Iosname);
12004 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12005 PL_sighandlerp = proto_perl->Isighandlerp;
12008 PL_runops = proto_perl->Irunops;
12010 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12013 PL_cshlen = proto_perl->Icshlen;
12014 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12017 PL_lex_state = proto_perl->Ilex_state;
12018 PL_lex_defer = proto_perl->Ilex_defer;
12019 PL_lex_expect = proto_perl->Ilex_expect;
12020 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12021 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12022 PL_lex_starts = proto_perl->Ilex_starts;
12023 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12024 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12025 PL_lex_op = proto_perl->Ilex_op;
12026 PL_lex_inpat = proto_perl->Ilex_inpat;
12027 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12028 PL_lex_brackets = proto_perl->Ilex_brackets;
12029 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12030 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12031 PL_lex_casemods = proto_perl->Ilex_casemods;
12032 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12033 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12035 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12036 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12037 PL_nexttoke = proto_perl->Inexttoke;
12039 /* XXX This is probably masking the deeper issue of why
12040 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12041 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12042 * (A little debugging with a watchpoint on it may help.)
12044 if (SvANY(proto_perl->Ilinestr)) {
12045 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12046 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12047 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12048 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12049 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12050 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12051 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12052 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12053 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12056 PL_linestr = NEWSV(65,79);
12057 sv_upgrade(PL_linestr,SVt_PVIV);
12058 sv_setpvn(PL_linestr,"",0);
12059 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12061 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12062 PL_pending_ident = proto_perl->Ipending_ident;
12063 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12065 PL_expect = proto_perl->Iexpect;
12067 PL_multi_start = proto_perl->Imulti_start;
12068 PL_multi_end = proto_perl->Imulti_end;
12069 PL_multi_open = proto_perl->Imulti_open;
12070 PL_multi_close = proto_perl->Imulti_close;
12072 PL_error_count = proto_perl->Ierror_count;
12073 PL_subline = proto_perl->Isubline;
12074 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12076 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12077 if (SvANY(proto_perl->Ilinestr)) {
12078 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12079 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12080 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12081 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12082 PL_last_lop_op = proto_perl->Ilast_lop_op;
12085 PL_last_uni = SvPVX(PL_linestr);
12086 PL_last_lop = SvPVX(PL_linestr);
12087 PL_last_lop_op = 0;
12089 PL_in_my = proto_perl->Iin_my;
12090 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12092 PL_cryptseen = proto_perl->Icryptseen;
12095 PL_hints = proto_perl->Ihints;
12097 PL_amagic_generation = proto_perl->Iamagic_generation;
12099 #ifdef USE_LOCALE_COLLATE
12100 PL_collation_ix = proto_perl->Icollation_ix;
12101 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12102 PL_collation_standard = proto_perl->Icollation_standard;
12103 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12104 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12105 #endif /* USE_LOCALE_COLLATE */
12107 #ifdef USE_LOCALE_NUMERIC
12108 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12109 PL_numeric_standard = proto_perl->Inumeric_standard;
12110 PL_numeric_local = proto_perl->Inumeric_local;
12111 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12112 #endif /* !USE_LOCALE_NUMERIC */
12114 /* utf8 character classes */
12115 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12116 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12117 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12118 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12119 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12120 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12121 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12122 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12123 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12124 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12125 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12126 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12127 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12128 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12129 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12130 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12131 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12132 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12133 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12134 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12136 /* Did the locale setup indicate UTF-8? */
12137 PL_utf8locale = proto_perl->Iutf8locale;
12138 /* Unicode features (see perlrun/-C) */
12139 PL_unicode = proto_perl->Iunicode;
12141 /* Pre-5.8 signals control */
12142 PL_signals = proto_perl->Isignals;
12144 /* times() ticks per second */
12145 PL_clocktick = proto_perl->Iclocktick;
12147 /* Recursion stopper for PerlIO_find_layer */
12148 PL_in_load_module = proto_perl->Iin_load_module;
12150 /* sort() routine */
12151 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12153 /* Not really needed/useful since the reenrant_retint is "volatile",
12154 * but do it for consistency's sake. */
12155 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12157 /* Hooks to shared SVs and locks. */
12158 PL_sharehook = proto_perl->Isharehook;
12159 PL_lockhook = proto_perl->Ilockhook;
12160 PL_unlockhook = proto_perl->Iunlockhook;
12161 PL_threadhook = proto_perl->Ithreadhook;
12163 PL_runops_std = proto_perl->Irunops_std;
12164 PL_runops_dbg = proto_perl->Irunops_dbg;
12166 #ifdef THREADS_HAVE_PIDS
12167 PL_ppid = proto_perl->Ippid;
12171 PL_last_swash_hv = Nullhv; /* reinits on demand */
12172 PL_last_swash_klen = 0;
12173 PL_last_swash_key[0]= '\0';
12174 PL_last_swash_tmps = (U8*)NULL;
12175 PL_last_swash_slen = 0;
12177 PL_glob_index = proto_perl->Iglob_index;
12178 PL_srand_called = proto_perl->Isrand_called;
12179 PL_uudmap['M'] = 0; /* reinits on demand */
12180 PL_bitcount = Nullch; /* reinits on demand */
12182 if (proto_perl->Ipsig_pend) {
12183 Newz(0, PL_psig_pend, SIG_SIZE, int);
12186 PL_psig_pend = (int*)NULL;
12189 if (proto_perl->Ipsig_ptr) {
12190 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12191 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12192 for (i = 1; i < SIG_SIZE; i++) {
12193 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12194 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12198 PL_psig_ptr = (SV**)NULL;
12199 PL_psig_name = (SV**)NULL;
12202 /* thrdvar.h stuff */
12204 if (flags & CLONEf_COPY_STACKS) {
12205 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12206 PL_tmps_ix = proto_perl->Ttmps_ix;
12207 PL_tmps_max = proto_perl->Ttmps_max;
12208 PL_tmps_floor = proto_perl->Ttmps_floor;
12209 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12211 while (i <= PL_tmps_ix) {
12212 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12216 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12217 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12218 Newz(54, PL_markstack, i, I32);
12219 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12220 - proto_perl->Tmarkstack);
12221 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12222 - proto_perl->Tmarkstack);
12223 Copy(proto_perl->Tmarkstack, PL_markstack,
12224 PL_markstack_ptr - PL_markstack + 1, I32);
12226 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12227 * NOTE: unlike the others! */
12228 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12229 PL_scopestack_max = proto_perl->Tscopestack_max;
12230 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12231 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12233 /* NOTE: si_dup() looks at PL_markstack */
12234 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12236 /* PL_curstack = PL_curstackinfo->si_stack; */
12237 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12238 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12240 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12241 PL_stack_base = AvARRAY(PL_curstack);
12242 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12243 - proto_perl->Tstack_base);
12244 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12246 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12247 * NOTE: unlike the others! */
12248 PL_savestack_ix = proto_perl->Tsavestack_ix;
12249 PL_savestack_max = proto_perl->Tsavestack_max;
12250 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12251 PL_savestack = ss_dup(proto_perl, param);
12255 ENTER; /* perl_destruct() wants to LEAVE; */
12258 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12259 PL_top_env = &PL_start_env;
12261 PL_op = proto_perl->Top;
12264 PL_Xpv = (XPV*)NULL;
12265 PL_na = proto_perl->Tna;
12267 PL_statbuf = proto_perl->Tstatbuf;
12268 PL_statcache = proto_perl->Tstatcache;
12269 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12270 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12272 PL_timesbuf = proto_perl->Ttimesbuf;
12275 PL_tainted = proto_perl->Ttainted;
12276 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12277 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12278 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12279 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12280 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12281 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12282 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12283 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12284 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12286 PL_restartop = proto_perl->Trestartop;
12287 PL_in_eval = proto_perl->Tin_eval;
12288 PL_delaymagic = proto_perl->Tdelaymagic;
12289 PL_dirty = proto_perl->Tdirty;
12290 PL_localizing = proto_perl->Tlocalizing;
12292 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12293 PL_hv_fetch_ent_mh = Nullhe;
12294 PL_modcount = proto_perl->Tmodcount;
12295 PL_lastgotoprobe = Nullop;
12296 PL_dumpindent = proto_perl->Tdumpindent;
12298 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12299 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12300 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12301 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12302 PL_sortcxix = proto_perl->Tsortcxix;
12303 PL_efloatbuf = Nullch; /* reinits on demand */
12304 PL_efloatsize = 0; /* reinits on demand */
12308 PL_screamfirst = NULL;
12309 PL_screamnext = NULL;
12310 PL_maxscream = -1; /* reinits on demand */
12311 PL_lastscream = Nullsv;
12313 PL_watchaddr = NULL;
12314 PL_watchok = Nullch;
12316 PL_regdummy = proto_perl->Tregdummy;
12317 PL_regprecomp = Nullch;
12320 PL_colorset = 0; /* reinits PL_colors[] */
12321 /*PL_colors[6] = {0,0,0,0,0,0};*/
12322 PL_reginput = Nullch;
12323 PL_regbol = Nullch;
12324 PL_regeol = Nullch;
12325 PL_regstartp = (I32*)NULL;
12326 PL_regendp = (I32*)NULL;
12327 PL_reglastparen = (U32*)NULL;
12328 PL_reglastcloseparen = (U32*)NULL;
12329 PL_regtill = Nullch;
12330 PL_reg_start_tmp = (char**)NULL;
12331 PL_reg_start_tmpl = 0;
12332 PL_regdata = (struct reg_data*)NULL;
12335 PL_reg_eval_set = 0;
12337 PL_regprogram = (regnode*)NULL;
12339 PL_regcc = (CURCUR*)NULL;
12340 PL_reg_call_cc = (struct re_cc_state*)NULL;
12341 PL_reg_re = (regexp*)NULL;
12342 PL_reg_ganch = Nullch;
12343 PL_reg_sv = Nullsv;
12344 PL_reg_match_utf8 = FALSE;
12345 PL_reg_magic = (MAGIC*)NULL;
12347 PL_reg_oldcurpm = (PMOP*)NULL;
12348 PL_reg_curpm = (PMOP*)NULL;
12349 PL_reg_oldsaved = Nullch;
12350 PL_reg_oldsavedlen = 0;
12351 #ifdef PERL_COPY_ON_WRITE
12354 PL_reg_maxiter = 0;
12355 PL_reg_leftiter = 0;
12356 PL_reg_poscache = Nullch;
12357 PL_reg_poscache_size= 0;
12359 /* RE engine - function pointers */
12360 PL_regcompp = proto_perl->Tregcompp;
12361 PL_regexecp = proto_perl->Tregexecp;
12362 PL_regint_start = proto_perl->Tregint_start;
12363 PL_regint_string = proto_perl->Tregint_string;
12364 PL_regfree = proto_perl->Tregfree;
12366 PL_reginterp_cnt = 0;
12367 PL_reg_starttry = 0;
12369 /* Pluggable optimizer */
12370 PL_peepp = proto_perl->Tpeepp;
12372 PL_stashcache = newHV();
12374 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12375 ptr_table_free(PL_ptr_table);
12376 PL_ptr_table = NULL;
12377 ptr_table_free(PL_shared_hek_table);
12378 PL_shared_hek_table = NULL;
12381 /* Call the ->CLONE method, if it exists, for each of the stashes
12382 identified by sv_dup() above.
12384 while(av_len(param->stashes) != -1) {
12385 HV* stash = (HV*) av_shift(param->stashes);
12386 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12387 if (cloner && GvCV(cloner)) {
12392 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12394 call_sv((SV*)GvCV(cloner), G_DISCARD);
12400 SvREFCNT_dec(param->stashes);
12402 /* orphaned? eg threads->new inside BEGIN or use */
12403 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12404 (void)SvREFCNT_inc(PL_compcv);
12405 SAVEFREESV(PL_compcv);
12411 #endif /* USE_ITHREADS */
12414 =head1 Unicode Support
12416 =for apidoc sv_recode_to_utf8
12418 The encoding is assumed to be an Encode object, on entry the PV
12419 of the sv is assumed to be octets in that encoding, and the sv
12420 will be converted into Unicode (and UTF-8).
12422 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12423 is not a reference, nothing is done to the sv. If the encoding is not
12424 an C<Encode::XS> Encoding object, bad things will happen.
12425 (See F<lib/encoding.pm> and L<Encode>).
12427 The PV of the sv is returned.
12432 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12435 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12449 Passing sv_yes is wrong - it needs to be or'ed set of constants
12450 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12451 remove converted chars from source.
12453 Both will default the value - let them.
12455 XPUSHs(&PL_sv_yes);
12458 call_method("decode", G_SCALAR);
12462 s = SvPV(uni, len);
12463 if (s != SvPVX_const(sv)) {
12464 SvGROW(sv, len + 1);
12465 Move(s, SvPVX_const(sv), len, char);
12466 SvCUR_set(sv, len);
12467 SvPVX(sv)[len] = 0;
12474 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12478 =for apidoc sv_cat_decode
12480 The encoding is assumed to be an Encode object, the PV of the ssv is
12481 assumed to be octets in that encoding and decoding the input starts
12482 from the position which (PV + *offset) pointed to. The dsv will be
12483 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12484 when the string tstr appears in decoding output or the input ends on
12485 the PV of the ssv. The value which the offset points will be modified
12486 to the last input position on the ssv.
12488 Returns TRUE if the terminator was found, else returns FALSE.
12493 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12494 SV *ssv, int *offset, char *tstr, int tlen)
12498 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12509 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12510 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12512 call_method("cat_decode", G_SCALAR);
12514 ret = SvTRUE(TOPs);
12515 *offset = SvIV(offsv);
12521 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12527 * c-indentation-style: bsd
12528 * c-basic-offset: 4
12529 * indent-tabs-mode: t
12532 * ex: set ts=8 sts=4 sw=4 noet: