3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
761 if (!cv || !CvPADLIST(cv))
763 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
764 sv = *av_fetch(av, targ, FALSE);
765 /* SvLEN in a pad name is not to be trusted */
766 sv_setpv(name, SvPV_nolen_const(sv));
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
773 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
776 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
778 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
780 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
781 sv_insert(name, 0, 0, "within ", 7);
788 =for apidoc find_uninit_var
790 Find the name of the undefined variable (if any) that caused the operator o
791 to issue a "Use of uninitialized value" warning.
792 If match is true, only return a name if it's value matches uninit_sv.
793 So roughly speaking, if a unary operator (such as OP_COS) generates a
794 warning, then following the direct child of the op may yield an
795 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
796 other hand, with OP_ADD there are two branches to follow, so we only print
797 the variable name if we get an exact match.
799 The name is returned as a mortal SV.
801 Assumes that PL_op is the op that originally triggered the error, and that
802 PL_comppad/PL_curpad points to the currently executing pad.
808 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
817 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
818 uninit_sv == &PL_sv_placeholder)))
821 switch (obase->op_type) {
828 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
829 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
832 int subscript_type = FUV_SUBSCRIPT_WITHIN;
834 if (pad) { /* @lex, %lex */
835 sv = PAD_SVl(obase->op_targ);
839 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
840 /* @global, %global */
841 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
844 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
846 else /* @{expr}, %{expr} */
847 return find_uninit_var(cUNOPx(obase)->op_first,
851 /* attempt to find a match within the aggregate */
853 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
855 subscript_type = FUV_SUBSCRIPT_HASH;
858 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
860 subscript_type = FUV_SUBSCRIPT_ARRAY;
863 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
866 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
867 keysv, index, subscript_type);
871 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
873 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
874 Nullsv, 0, FUV_SUBSCRIPT_NONE);
877 gv = cGVOPx_gv(obase);
878 if (!gv || (match && GvSV(gv) != uninit_sv))
880 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
883 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
885 av = (AV*)PAD_SV(obase->op_targ);
886 if (!av || SvRMAGICAL(av))
888 svp = av_fetch(av, (I32)obase->op_private, FALSE);
889 if (!svp || *svp != uninit_sv)
892 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
893 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
896 gv = cGVOPx_gv(obase);
901 if (!av || SvRMAGICAL(av))
903 svp = av_fetch(av, (I32)obase->op_private, FALSE);
904 if (!svp || *svp != uninit_sv)
907 return S_varname(aTHX_ gv, "$", 0,
908 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
913 o = cUNOPx(obase)->op_first;
914 if (!o || o->op_type != OP_NULL ||
915 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
917 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
922 /* $a[uninit_expr] or $h{uninit_expr} */
923 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
926 o = cBINOPx(obase)->op_first;
927 kid = cBINOPx(obase)->op_last;
929 /* get the av or hv, and optionally the gv */
931 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
932 sv = PAD_SV(o->op_targ);
934 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
935 && cUNOPo->op_first->op_type == OP_GV)
937 gv = cGVOPx_gv(cUNOPo->op_first);
940 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
945 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
946 /* index is constant */
950 if (obase->op_type == OP_HELEM) {
951 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
952 if (!he || HeVAL(he) != uninit_sv)
956 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
957 if (!svp || *svp != uninit_sv)
961 if (obase->op_type == OP_HELEM)
962 return S_varname(aTHX_ gv, "%", o->op_targ,
963 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
965 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
966 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
970 /* index is an expression;
971 * attempt to find a match within the aggregate */
972 if (obase->op_type == OP_HELEM) {
973 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
975 return S_varname(aTHX_ gv, "%", o->op_targ,
976 keysv, 0, FUV_SUBSCRIPT_HASH);
979 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
981 return S_varname(aTHX_ gv, "@", o->op_targ,
982 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
986 return S_varname(aTHX_ gv,
987 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
989 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
995 /* only examine RHS */
996 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
999 o = cUNOPx(obase)->op_first;
1000 if (o->op_type == OP_PUSHMARK)
1003 if (!o->op_sibling) {
1004 /* one-arg version of open is highly magical */
1006 if (o->op_type == OP_GV) { /* open FOO; */
1008 if (match && GvSV(gv) != uninit_sv)
1010 return S_varname(aTHX_ gv, "$", 0,
1011 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1013 /* other possibilities not handled are:
1014 * open $x; or open my $x; should return '${*$x}'
1015 * open expr; should return '$'.expr ideally
1021 /* ops where $_ may be an implicit arg */
1025 if ( !(obase->op_flags & OPf_STACKED)) {
1026 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1027 ? PAD_SVl(obase->op_targ)
1030 sv = sv_newmortal();
1031 sv_setpvn(sv, "$_", 2);
1039 /* skip filehandle as it can't produce 'undef' warning */
1040 o = cUNOPx(obase)->op_first;
1041 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1042 o = o->op_sibling->op_sibling;
1049 match = 1; /* XS or custom code could trigger random warnings */
1054 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1055 return sv_2mortal(newSVpv("${$/}", 0));
1060 if (!(obase->op_flags & OPf_KIDS))
1062 o = cUNOPx(obase)->op_first;
1068 /* if all except one arg are constant, or have no side-effects,
1069 * or are optimized away, then it's unambiguous */
1071 for (kid=o; kid; kid = kid->op_sibling) {
1073 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1074 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1075 || (kid->op_type == OP_PUSHMARK)
1079 if (o2) { /* more than one found */
1086 return find_uninit_var(o2, uninit_sv, match);
1090 sv = find_uninit_var(o, uninit_sv, 1);
1102 =for apidoc report_uninit
1104 Print appropriate "Use of uninitialized variable" warning
1110 Perl_report_uninit(pTHX_ SV* uninit_sv)
1113 SV* varname = Nullsv;
1115 varname = find_uninit_var(PL_op, uninit_sv,0);
1117 sv_insert(varname, 0, 0, " ", 1);
1119 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1120 varname ? SvPV_nolen_const(varname) : "",
1121 " in ", OP_DESC(PL_op));
1124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1128 /* allocate another arena's worth of NV bodies */
1136 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1137 *((void **) ptr) = (void *)PL_xnv_arenaroot;
1138 PL_xnv_arenaroot = ptr;
1141 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1142 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1144 while (xnv < xnvend) {
1145 *(NV**)xnv = (NV*)(xnv + 1);
1151 /* allocate another arena's worth of struct xpv */
1157 xpv_allocated* xpvend;
1158 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1159 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
1160 PL_xpv_arenaroot = xpv;
1162 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
1163 PL_xpv_root = ++xpv;
1164 while (xpv < xpvend) {
1165 *((xpv_allocated**)xpv) = xpv + 1;
1168 *((xpv_allocated**)xpv) = 0;
1171 /* allocate another arena's worth of struct xpviv */
1176 xpviv_allocated* xpviv;
1177 xpviv_allocated* xpvivend;
1178 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1179 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
1180 PL_xpviv_arenaroot = xpviv;
1182 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
1183 PL_xpviv_root = ++xpviv;
1184 while (xpviv < xpvivend) {
1185 *((xpviv_allocated**)xpviv) = xpviv + 1;
1188 *((xpviv_allocated**)xpviv) = 0;
1191 /* allocate another arena's worth of struct xpvnv */
1198 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1199 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
1200 PL_xpvnv_arenaroot = xpvnv;
1202 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1203 PL_xpvnv_root = ++xpvnv;
1204 while (xpvnv < xpvnvend) {
1205 *((XPVNV**)xpvnv) = xpvnv + 1;
1208 *((XPVNV**)xpvnv) = 0;
1211 /* allocate another arena's worth of struct xpvcv */
1218 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1219 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
1220 PL_xpvcv_arenaroot = xpvcv;
1222 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1223 PL_xpvcv_root = ++xpvcv;
1224 while (xpvcv < xpvcvend) {
1225 *((XPVCV**)xpvcv) = xpvcv + 1;
1228 *((XPVCV**)xpvcv) = 0;
1231 /* allocate another arena's worth of struct xpvav */
1236 xpvav_allocated* xpvav;
1237 xpvav_allocated* xpvavend;
1238 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1240 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
1241 PL_xpvav_arenaroot = xpvav;
1243 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
1244 PL_xpvav_root = ++xpvav;
1245 while (xpvav < xpvavend) {
1246 *((xpvav_allocated**)xpvav) = xpvav + 1;
1249 *((xpvav_allocated**)xpvav) = 0;
1252 /* allocate another arena's worth of struct xpvhv */
1257 xpvhv_allocated* xpvhv;
1258 xpvhv_allocated* xpvhvend;
1259 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1261 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
1262 PL_xpvhv_arenaroot = xpvhv;
1264 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
1265 PL_xpvhv_root = ++xpvhv;
1266 while (xpvhv < xpvhvend) {
1267 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
1270 *((xpvhv_allocated**)xpvhv) = 0;
1273 /* allocate another arena's worth of struct xpvmg */
1280 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1281 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1282 PL_xpvmg_arenaroot = xpvmg;
1284 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1285 PL_xpvmg_root = ++xpvmg;
1286 while (xpvmg < xpvmgend) {
1287 *((XPVMG**)xpvmg) = xpvmg + 1;
1290 *((XPVMG**)xpvmg) = 0;
1293 /* allocate another arena's worth of struct xpvgv */
1300 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1301 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1302 PL_xpvgv_arenaroot = xpvgv;
1304 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1305 PL_xpvgv_root = ++xpvgv;
1306 while (xpvgv < xpvgvend) {
1307 *((XPVGV**)xpvgv) = xpvgv + 1;
1310 *((XPVGV**)xpvgv) = 0;
1313 /* allocate another arena's worth of struct xpvlv */
1320 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1321 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1322 PL_xpvlv_arenaroot = xpvlv;
1324 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1325 PL_xpvlv_root = ++xpvlv;
1326 while (xpvlv < xpvlvend) {
1327 *((XPVLV**)xpvlv) = xpvlv + 1;
1330 *((XPVLV**)xpvlv) = 0;
1333 /* allocate another arena's worth of struct xpvbm */
1340 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1341 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1342 PL_xpvbm_arenaroot = xpvbm;
1344 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1345 PL_xpvbm_root = ++xpvbm;
1346 while (xpvbm < xpvbmend) {
1347 *((XPVBM**)xpvbm) = xpvbm + 1;
1350 *((XPVBM**)xpvbm) = 0;
1353 /* grab a new NV body from the free list, allocating more if necessary */
1363 PL_xnv_root = *(NV**)xnv;
1365 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1368 /* return an NV body to the free list */
1371 S_del_xnv(pTHX_ XPVNV *p)
1373 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1375 *(NV**)xnv = PL_xnv_root;
1380 /* grab a new struct xpv from the free list, allocating more if necessary */
1390 PL_xpv_root = *(xpv_allocated**)xpv;
1392 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1393 sum to zero, and the pointer is unchanged. If the allocated structure
1394 is smaller (no initial IV actually allocated) then the net effect is
1395 to subtract the size of the IV from the pointer, to return a new pointer
1396 as if an initial IV were actually allocated. */
1397 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1398 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
1401 /* return a struct xpv to the free list */
1404 S_del_xpv(pTHX_ XPV *p)
1407 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1408 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
1410 *(xpv_allocated**)xpv = PL_xpv_root;
1415 /* grab a new struct xpviv from the free list, allocating more if necessary */
1420 xpviv_allocated* xpviv;
1424 xpviv = PL_xpviv_root;
1425 PL_xpviv_root = *(xpviv_allocated**)xpviv;
1427 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1428 sum to zero, and the pointer is unchanged. If the allocated structure
1429 is smaller (no initial IV actually allocated) then the net effect is
1430 to subtract the size of the IV from the pointer, to return a new pointer
1431 as if an initial IV were actually allocated. */
1432 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1433 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1436 /* return a struct xpviv to the free list */
1439 S_del_xpviv(pTHX_ XPVIV *p)
1441 xpviv_allocated* xpviv
1442 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1443 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1445 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1446 PL_xpviv_root = xpviv;
1450 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1459 xpvnv = PL_xpvnv_root;
1460 PL_xpvnv_root = *(XPVNV**)xpvnv;
1465 /* return a struct xpvnv to the free list */
1468 S_del_xpvnv(pTHX_ XPVNV *p)
1471 *(XPVNV**)p = PL_xpvnv_root;
1476 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1485 xpvcv = PL_xpvcv_root;
1486 PL_xpvcv_root = *(XPVCV**)xpvcv;
1491 /* return a struct xpvcv to the free list */
1494 S_del_xpvcv(pTHX_ XPVCV *p)
1497 *(XPVCV**)p = PL_xpvcv_root;
1502 /* grab a new struct xpvav from the free list, allocating more if necessary */
1507 xpvav_allocated* xpvav;
1511 xpvav = PL_xpvav_root;
1512 PL_xpvav_root = *(xpvav_allocated**)xpvav;
1514 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1515 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
1518 /* return a struct xpvav to the free list */
1521 S_del_xpvav(pTHX_ XPVAV *p)
1523 xpvav_allocated* xpvav
1524 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1525 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
1527 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1528 PL_xpvav_root = xpvav;
1532 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1537 xpvhv_allocated* xpvhv;
1541 xpvhv = PL_xpvhv_root;
1542 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
1544 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1545 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1548 /* return a struct xpvhv to the free list */
1551 S_del_xpvhv(pTHX_ XPVHV *p)
1553 xpvhv_allocated* xpvhv
1554 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1555 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1557 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1558 PL_xpvhv_root = xpvhv;
1562 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1571 xpvmg = PL_xpvmg_root;
1572 PL_xpvmg_root = *(XPVMG**)xpvmg;
1577 /* return a struct xpvmg to the free list */
1580 S_del_xpvmg(pTHX_ XPVMG *p)
1583 *(XPVMG**)p = PL_xpvmg_root;
1588 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1597 xpvgv = PL_xpvgv_root;
1598 PL_xpvgv_root = *(XPVGV**)xpvgv;
1603 /* return a struct xpvgv to the free list */
1606 S_del_xpvgv(pTHX_ XPVGV *p)
1609 *(XPVGV**)p = PL_xpvgv_root;
1614 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1623 xpvlv = PL_xpvlv_root;
1624 PL_xpvlv_root = *(XPVLV**)xpvlv;
1629 /* return a struct xpvlv to the free list */
1632 S_del_xpvlv(pTHX_ XPVLV *p)
1635 *(XPVLV**)p = PL_xpvlv_root;
1640 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1649 xpvbm = PL_xpvbm_root;
1650 PL_xpvbm_root = *(XPVBM**)xpvbm;
1655 /* return a struct xpvbm to the free list */
1658 S_del_xpvbm(pTHX_ XPVBM *p)
1661 *(XPVBM**)p = PL_xpvbm_root;
1666 #define my_safemalloc(s) (void*)safemalloc(s)
1667 #define my_safefree(p) safefree((char*)p)
1671 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1672 #define del_XNV(p) my_safefree(p)
1674 #define new_XPV() my_safemalloc(sizeof(XPV))
1675 #define del_XPV(p) my_safefree(p)
1677 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1678 #define del_XPVIV(p) my_safefree(p)
1680 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1681 #define del_XPVNV(p) my_safefree(p)
1683 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1684 #define del_XPVCV(p) my_safefree(p)
1686 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1687 #define del_XPVAV(p) my_safefree(p)
1689 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1690 #define del_XPVHV(p) my_safefree(p)
1692 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1693 #define del_XPVMG(p) my_safefree(p)
1695 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1696 #define del_XPVGV(p) my_safefree(p)
1698 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1699 #define del_XPVLV(p) my_safefree(p)
1701 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1702 #define del_XPVBM(p) my_safefree(p)
1706 #define new_XNV() (void*)new_xnv()
1707 #define del_XNV(p) del_xnv((XPVNV*) p)
1709 #define new_XPV() (void*)new_xpv()
1710 #define del_XPV(p) del_xpv((XPV *)p)
1712 #define new_XPVIV() (void*)new_xpviv()
1713 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1715 #define new_XPVNV() (void*)new_xpvnv()
1716 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1718 #define new_XPVCV() (void*)new_xpvcv()
1719 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1721 #define new_XPVAV() (void*)new_xpvav()
1722 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1724 #define new_XPVHV() (void*)new_xpvhv()
1725 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1727 #define new_XPVMG() (void*)new_xpvmg()
1728 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1730 #define new_XPVGV() (void*)new_xpvgv()
1731 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1733 #define new_XPVLV() (void*)new_xpvlv()
1734 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1736 #define new_XPVBM() (void*)new_xpvbm()
1737 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1741 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1742 #define del_XPVFM(p) my_safefree(p)
1744 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1745 #define del_XPVIO(p) my_safefree(p)
1748 =for apidoc sv_upgrade
1750 Upgrade an SV to a more complex form. Generally adds a new body type to the
1751 SV, then copies across as much information as possible from the old body.
1752 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1758 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1769 if (mt != SVt_PV && SvIsCOW(sv)) {
1770 sv_force_normal_flags(sv, 0);
1773 if (SvTYPE(sv) == mt)
1784 switch (SvTYPE(sv)) {
1791 else if (mt < SVt_PVIV)
1801 pv = (char*)SvRV(sv);
1804 pv = SvPVX_mutable(sv);
1810 else if (mt == SVt_NV)
1814 pv = SvPVX_mutable(sv);
1818 del_XPVIV(SvANY(sv));
1821 pv = SvPVX_mutable(sv);
1826 del_XPVNV(SvANY(sv));
1829 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1830 there's no way that it can be safely upgraded, because perl.c
1831 expects to Safefree(SvANY(PL_mess_sv)) */
1832 assert(sv != PL_mess_sv);
1833 /* This flag bit is used to mean other things in other scalar types.
1834 Given that it only has meaning inside the pad, it shouldn't be set
1835 on anything that can get upgraded. */
1836 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1837 pv = SvPVX_mutable(sv);
1842 magic = SvMAGIC(sv);
1843 stash = SvSTASH(sv);
1844 del_XPVMG(SvANY(sv));
1847 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1850 SvFLAGS(sv) &= ~SVTYPEMASK;
1855 Perl_croak(aTHX_ "Can't upgrade to undef");
1857 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1861 SvANY(sv) = new_XNV();
1865 SvANY(sv) = &sv->sv_u.svu_rv;
1866 SvRV_set(sv, (SV*)pv);
1869 SvANY(sv) = new_XPVHV();
1872 HvTOTALKEYS(sv) = 0;
1874 /* Fall through... */
1877 SvANY(sv) = new_XPVAV();
1884 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1886 /* FIXME. Should be able to remove all this if()... if the above
1887 assertion is genuinely always true. */
1890 SvFLAGS(sv) &= ~SVf_OOK;
1893 SvPV_set(sv, (char*)0);
1894 SvMAGIC_set(sv, magic);
1895 SvSTASH_set(sv, stash);
1899 SvANY(sv) = new_XPVIO();
1900 Zero(SvANY(sv), 1, XPVIO);
1901 IoPAGE_LEN(sv) = 60;
1902 goto set_magic_common;
1904 SvANY(sv) = new_XPVFM();
1905 Zero(SvANY(sv), 1, XPVFM);
1906 goto set_magic_common;
1908 SvANY(sv) = new_XPVBM();
1912 goto set_magic_common;
1914 SvANY(sv) = new_XPVGV();
1920 goto set_magic_common;
1922 SvANY(sv) = new_XPVCV();
1923 Zero(SvANY(sv), 1, XPVCV);
1924 goto set_magic_common;
1926 SvANY(sv) = new_XPVLV();
1939 SvANY(sv) = new_XPVMG();
1942 SvMAGIC_set(sv, magic);
1943 SvSTASH_set(sv, stash);
1947 SvANY(sv) = new_XPVNV();
1953 SvANY(sv) = new_XPVIV();
1962 SvANY(sv) = new_XPV();
1972 =for apidoc sv_backoff
1974 Remove any string offset. You should normally use the C<SvOOK_off> macro
1981 Perl_sv_backoff(pTHX_ register SV *sv)
1984 assert(SvTYPE(sv) != SVt_PVHV);
1985 assert(SvTYPE(sv) != SVt_PVAV);
1987 const char *s = SvPVX_const(sv);
1988 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1989 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1991 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1993 SvFLAGS(sv) &= ~SVf_OOK;
2000 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2001 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2002 Use the C<SvGROW> wrapper instead.
2008 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2012 #ifdef HAS_64K_LIMIT
2013 if (newlen >= 0x10000) {
2014 PerlIO_printf(Perl_debug_log,
2015 "Allocation too large: %"UVxf"\n", (UV)newlen);
2018 #endif /* HAS_64K_LIMIT */
2021 if (SvTYPE(sv) < SVt_PV) {
2022 sv_upgrade(sv, SVt_PV);
2023 s = SvPVX_mutable(sv);
2025 else if (SvOOK(sv)) { /* pv is offset? */
2027 s = SvPVX_mutable(sv);
2028 if (newlen > SvLEN(sv))
2029 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2030 #ifdef HAS_64K_LIMIT
2031 if (newlen >= 0x10000)
2036 s = SvPVX_mutable(sv);
2038 if (newlen > SvLEN(sv)) { /* need more room? */
2039 newlen = PERL_STRLEN_ROUNDUP(newlen);
2040 if (SvLEN(sv) && s) {
2042 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
2048 s = saferealloc(s, newlen);
2051 s = safemalloc(newlen);
2052 if (SvPVX_const(sv) && SvCUR(sv)) {
2053 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2057 SvLEN_set(sv, newlen);
2063 =for apidoc sv_setiv
2065 Copies an integer into the given SV, upgrading first if necessary.
2066 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2072 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2074 SV_CHECK_THINKFIRST_COW_DROP(sv);
2075 switch (SvTYPE(sv)) {
2077 sv_upgrade(sv, SVt_IV);
2080 sv_upgrade(sv, SVt_PVNV);
2084 sv_upgrade(sv, SVt_PVIV);
2093 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2096 (void)SvIOK_only(sv); /* validate number */
2102 =for apidoc sv_setiv_mg
2104 Like C<sv_setiv>, but also handles 'set' magic.
2110 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2117 =for apidoc sv_setuv
2119 Copies an unsigned integer into the given SV, upgrading first if necessary.
2120 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2126 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2128 /* With these two if statements:
2129 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2132 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2134 If you wish to remove them, please benchmark to see what the effect is
2136 if (u <= (UV)IV_MAX) {
2137 sv_setiv(sv, (IV)u);
2146 =for apidoc sv_setuv_mg
2148 Like C<sv_setuv>, but also handles 'set' magic.
2154 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2156 /* With these two if statements:
2157 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2160 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2162 If you wish to remove them, please benchmark to see what the effect is
2164 if (u <= (UV)IV_MAX) {
2165 sv_setiv(sv, (IV)u);
2175 =for apidoc sv_setnv
2177 Copies a double into the given SV, upgrading first if necessary.
2178 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2184 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2186 SV_CHECK_THINKFIRST_COW_DROP(sv);
2187 switch (SvTYPE(sv)) {
2190 sv_upgrade(sv, SVt_NV);
2195 sv_upgrade(sv, SVt_PVNV);
2204 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2208 (void)SvNOK_only(sv); /* validate number */
2213 =for apidoc sv_setnv_mg
2215 Like C<sv_setnv>, but also handles 'set' magic.
2221 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2227 /* Print an "isn't numeric" warning, using a cleaned-up,
2228 * printable version of the offending string
2232 S_not_a_number(pTHX_ SV *sv)
2239 dsv = sv_2mortal(newSVpv("", 0));
2240 pv = sv_uni_display(dsv, sv, 10, 0);
2243 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2244 /* each *s can expand to 4 chars + "...\0",
2245 i.e. need room for 8 chars */
2247 const char *s, *end;
2248 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
2251 if (ch & 128 && !isPRINT_LC(ch)) {
2260 else if (ch == '\r') {
2264 else if (ch == '\f') {
2268 else if (ch == '\\') {
2272 else if (ch == '\0') {
2276 else if (isPRINT_LC(ch))
2293 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2294 "Argument \"%s\" isn't numeric in %s", pv,
2297 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2298 "Argument \"%s\" isn't numeric", pv);
2302 =for apidoc looks_like_number
2304 Test if the content of an SV looks like a number (or is a number).
2305 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2306 non-numeric warning), even if your atof() doesn't grok them.
2312 Perl_looks_like_number(pTHX_ SV *sv)
2314 register const char *sbegin;
2318 sbegin = SvPVX_const(sv);
2321 else if (SvPOKp(sv))
2322 sbegin = SvPV_const(sv, len);
2324 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2325 return grok_number(sbegin, len, NULL);
2328 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2329 until proven guilty, assume that things are not that bad... */
2334 As 64 bit platforms often have an NV that doesn't preserve all bits of
2335 an IV (an assumption perl has been based on to date) it becomes necessary
2336 to remove the assumption that the NV always carries enough precision to
2337 recreate the IV whenever needed, and that the NV is the canonical form.
2338 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2339 precision as a side effect of conversion (which would lead to insanity
2340 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2341 1) to distinguish between IV/UV/NV slots that have cached a valid
2342 conversion where precision was lost and IV/UV/NV slots that have a
2343 valid conversion which has lost no precision
2344 2) to ensure that if a numeric conversion to one form is requested that
2345 would lose precision, the precise conversion (or differently
2346 imprecise conversion) is also performed and cached, to prevent
2347 requests for different numeric formats on the same SV causing
2348 lossy conversion chains. (lossless conversion chains are perfectly
2353 SvIOKp is true if the IV slot contains a valid value
2354 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2355 SvNOKp is true if the NV slot contains a valid value
2356 SvNOK is true only if the NV value is accurate
2359 while converting from PV to NV, check to see if converting that NV to an
2360 IV(or UV) would lose accuracy over a direct conversion from PV to
2361 IV(or UV). If it would, cache both conversions, return NV, but mark
2362 SV as IOK NOKp (ie not NOK).
2364 While converting from PV to IV, check to see if converting that IV to an
2365 NV would lose accuracy over a direct conversion from PV to NV. If it
2366 would, cache both conversions, flag similarly.
2368 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2369 correctly because if IV & NV were set NV *always* overruled.
2370 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2371 changes - now IV and NV together means that the two are interchangeable:
2372 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2374 The benefit of this is that operations such as pp_add know that if
2375 SvIOK is true for both left and right operands, then integer addition
2376 can be used instead of floating point (for cases where the result won't
2377 overflow). Before, floating point was always used, which could lead to
2378 loss of precision compared with integer addition.
2380 * making IV and NV equal status should make maths accurate on 64 bit
2382 * may speed up maths somewhat if pp_add and friends start to use
2383 integers when possible instead of fp. (Hopefully the overhead in
2384 looking for SvIOK and checking for overflow will not outweigh the
2385 fp to integer speedup)
2386 * will slow down integer operations (callers of SvIV) on "inaccurate"
2387 values, as the change from SvIOK to SvIOKp will cause a call into
2388 sv_2iv each time rather than a macro access direct to the IV slot
2389 * should speed up number->string conversion on integers as IV is
2390 favoured when IV and NV are equally accurate
2392 ####################################################################
2393 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2394 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2395 On the other hand, SvUOK is true iff UV.
2396 ####################################################################
2398 Your mileage will vary depending your CPU's relative fp to integer
2402 #ifndef NV_PRESERVES_UV
2403 # define IS_NUMBER_UNDERFLOW_IV 1
2404 # define IS_NUMBER_UNDERFLOW_UV 2
2405 # define IS_NUMBER_IV_AND_UV 2
2406 # define IS_NUMBER_OVERFLOW_IV 4
2407 # define IS_NUMBER_OVERFLOW_UV 5
2409 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2411 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2413 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2415 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));
2416 if (SvNVX(sv) < (NV)IV_MIN) {
2417 (void)SvIOKp_on(sv);
2419 SvIV_set(sv, IV_MIN);
2420 return IS_NUMBER_UNDERFLOW_IV;
2422 if (SvNVX(sv) > (NV)UV_MAX) {
2423 (void)SvIOKp_on(sv);
2426 SvUV_set(sv, UV_MAX);
2427 return IS_NUMBER_OVERFLOW_UV;
2429 (void)SvIOKp_on(sv);
2431 /* Can't use strtol etc to convert this string. (See truth table in
2433 if (SvNVX(sv) <= (UV)IV_MAX) {
2434 SvIV_set(sv, I_V(SvNVX(sv)));
2435 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2436 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2438 /* Integer is imprecise. NOK, IOKp */
2440 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2443 SvUV_set(sv, U_V(SvNVX(sv)));
2444 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2445 if (SvUVX(sv) == UV_MAX) {
2446 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2447 possibly be preserved by NV. Hence, it must be overflow.
2449 return IS_NUMBER_OVERFLOW_UV;
2451 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2453 /* Integer is imprecise. NOK, IOKp */
2455 return IS_NUMBER_OVERFLOW_IV;
2457 #endif /* !NV_PRESERVES_UV*/
2459 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2460 * this function provided for binary compatibility only
2464 Perl_sv_2iv(pTHX_ register SV *sv)
2466 return sv_2iv_flags(sv, SV_GMAGIC);
2470 =for apidoc sv_2iv_flags
2472 Return the integer value of an SV, doing any necessary string
2473 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2474 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2480 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2484 if (SvGMAGICAL(sv)) {
2485 if (flags & SV_GMAGIC)
2490 return I_V(SvNVX(sv));
2492 if (SvPOKp(sv) && SvLEN(sv))
2495 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2496 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2502 if (SvTHINKFIRST(sv)) {
2505 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2506 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2507 return SvIV(tmpstr);
2508 return PTR2IV(SvRV(sv));
2511 sv_force_normal_flags(sv, 0);
2513 if (SvREADONLY(sv) && !SvOK(sv)) {
2514 if (ckWARN(WARN_UNINITIALIZED))
2521 return (IV)(SvUVX(sv));
2528 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2529 * without also getting a cached IV/UV from it at the same time
2530 * (ie PV->NV conversion should detect loss of accuracy and cache
2531 * IV or UV at same time to avoid this. NWC */
2533 if (SvTYPE(sv) == SVt_NV)
2534 sv_upgrade(sv, SVt_PVNV);
2536 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2537 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2538 certainly cast into the IV range at IV_MAX, whereas the correct
2539 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2541 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2542 SvIV_set(sv, I_V(SvNVX(sv)));
2543 if (SvNVX(sv) == (NV) SvIVX(sv)
2544 #ifndef NV_PRESERVES_UV
2545 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2546 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2547 /* Don't flag it as "accurately an integer" if the number
2548 came from a (by definition imprecise) NV operation, and
2549 we're outside the range of NV integer precision */
2552 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2553 DEBUG_c(PerlIO_printf(Perl_debug_log,
2554 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2560 /* IV not precise. No need to convert from PV, as NV
2561 conversion would already have cached IV if it detected
2562 that PV->IV would be better than PV->NV->IV
2563 flags already correct - don't set public IOK. */
2564 DEBUG_c(PerlIO_printf(Perl_debug_log,
2565 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2570 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2571 but the cast (NV)IV_MIN rounds to a the value less (more
2572 negative) than IV_MIN which happens to be equal to SvNVX ??
2573 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2574 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2575 (NV)UVX == NVX are both true, but the values differ. :-(
2576 Hopefully for 2s complement IV_MIN is something like
2577 0x8000000000000000 which will be exact. NWC */
2580 SvUV_set(sv, U_V(SvNVX(sv)));
2582 (SvNVX(sv) == (NV) SvUVX(sv))
2583 #ifndef NV_PRESERVES_UV
2584 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2585 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2586 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2587 /* Don't flag it as "accurately an integer" if the number
2588 came from a (by definition imprecise) NV operation, and
2589 we're outside the range of NV integer precision */
2595 DEBUG_c(PerlIO_printf(Perl_debug_log,
2596 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2600 return (IV)SvUVX(sv);
2603 else if (SvPOKp(sv) && SvLEN(sv)) {
2605 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2606 /* We want to avoid a possible problem when we cache an IV which
2607 may be later translated to an NV, and the resulting NV is not
2608 the same as the direct translation of the initial string
2609 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2610 be careful to ensure that the value with the .456 is around if the
2611 NV value is requested in the future).
2613 This means that if we cache such an IV, we need to cache the
2614 NV as well. Moreover, we trade speed for space, and do not
2615 cache the NV if we are sure it's not needed.
2618 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2619 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2620 == IS_NUMBER_IN_UV) {
2621 /* It's definitely an integer, only upgrade to PVIV */
2622 if (SvTYPE(sv) < SVt_PVIV)
2623 sv_upgrade(sv, SVt_PVIV);
2625 } else if (SvTYPE(sv) < SVt_PVNV)
2626 sv_upgrade(sv, SVt_PVNV);
2628 /* If NV preserves UV then we only use the UV value if we know that
2629 we aren't going to call atof() below. If NVs don't preserve UVs
2630 then the value returned may have more precision than atof() will
2631 return, even though value isn't perfectly accurate. */
2632 if ((numtype & (IS_NUMBER_IN_UV
2633 #ifdef NV_PRESERVES_UV
2636 )) == IS_NUMBER_IN_UV) {
2637 /* This won't turn off the public IOK flag if it was set above */
2638 (void)SvIOKp_on(sv);
2640 if (!(numtype & IS_NUMBER_NEG)) {
2642 if (value <= (UV)IV_MAX) {
2643 SvIV_set(sv, (IV)value);
2645 SvUV_set(sv, value);
2649 /* 2s complement assumption */
2650 if (value <= (UV)IV_MIN) {
2651 SvIV_set(sv, -(IV)value);
2653 /* Too negative for an IV. This is a double upgrade, but
2654 I'm assuming it will be rare. */
2655 if (SvTYPE(sv) < SVt_PVNV)
2656 sv_upgrade(sv, SVt_PVNV);
2660 SvNV_set(sv, -(NV)value);
2661 SvIV_set(sv, IV_MIN);
2665 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2666 will be in the previous block to set the IV slot, and the next
2667 block to set the NV slot. So no else here. */
2669 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2670 != IS_NUMBER_IN_UV) {
2671 /* It wasn't an (integer that doesn't overflow the UV). */
2672 SvNV_set(sv, Atof(SvPVX_const(sv)));
2674 if (! numtype && ckWARN(WARN_NUMERIC))
2677 #if defined(USE_LONG_DOUBLE)
2678 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2679 PTR2UV(sv), SvNVX(sv)));
2681 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2682 PTR2UV(sv), SvNVX(sv)));
2686 #ifdef NV_PRESERVES_UV
2687 (void)SvIOKp_on(sv);
2689 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2690 SvIV_set(sv, I_V(SvNVX(sv)));
2691 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2694 /* Integer is imprecise. NOK, IOKp */
2696 /* UV will not work better than IV */
2698 if (SvNVX(sv) > (NV)UV_MAX) {
2700 /* Integer is inaccurate. NOK, IOKp, is UV */
2701 SvUV_set(sv, UV_MAX);
2704 SvUV_set(sv, U_V(SvNVX(sv)));
2705 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2706 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2710 /* Integer is imprecise. NOK, IOKp, is UV */
2716 #else /* NV_PRESERVES_UV */
2717 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2718 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2719 /* The IV slot will have been set from value returned by
2720 grok_number above. The NV slot has just been set using
2723 assert (SvIOKp(sv));
2725 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2726 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2727 /* Small enough to preserve all bits. */
2728 (void)SvIOKp_on(sv);
2730 SvIV_set(sv, I_V(SvNVX(sv)));
2731 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2733 /* Assumption: first non-preserved integer is < IV_MAX,
2734 this NV is in the preserved range, therefore: */
2735 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2737 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);
2741 0 0 already failed to read UV.
2742 0 1 already failed to read UV.
2743 1 0 you won't get here in this case. IV/UV
2744 slot set, public IOK, Atof() unneeded.
2745 1 1 already read UV.
2746 so there's no point in sv_2iuv_non_preserve() attempting
2747 to use atol, strtol, strtoul etc. */
2748 if (sv_2iuv_non_preserve (sv, numtype)
2749 >= IS_NUMBER_OVERFLOW_IV)
2753 #endif /* NV_PRESERVES_UV */
2756 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2758 if (SvTYPE(sv) < SVt_IV)
2759 /* Typically the caller expects that sv_any is not NULL now. */
2760 sv_upgrade(sv, SVt_IV);
2763 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2764 PTR2UV(sv),SvIVX(sv)));
2765 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2768 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2769 * this function provided for binary compatibility only
2773 Perl_sv_2uv(pTHX_ register SV *sv)
2775 return sv_2uv_flags(sv, SV_GMAGIC);
2779 =for apidoc sv_2uv_flags
2781 Return the unsigned integer value of an SV, doing any necessary string
2782 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2783 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2789 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2793 if (SvGMAGICAL(sv)) {
2794 if (flags & SV_GMAGIC)
2799 return U_V(SvNVX(sv));
2800 if (SvPOKp(sv) && SvLEN(sv))
2803 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2804 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2810 if (SvTHINKFIRST(sv)) {
2813 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2814 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2815 return SvUV(tmpstr);
2816 return PTR2UV(SvRV(sv));
2819 sv_force_normal_flags(sv, 0);
2821 if (SvREADONLY(sv) && !SvOK(sv)) {
2822 if (ckWARN(WARN_UNINITIALIZED))
2832 return (UV)SvIVX(sv);
2836 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2837 * without also getting a cached IV/UV from it at the same time
2838 * (ie PV->NV conversion should detect loss of accuracy and cache
2839 * IV or UV at same time to avoid this. */
2840 /* IV-over-UV optimisation - choose to cache IV if possible */
2842 if (SvTYPE(sv) == SVt_NV)
2843 sv_upgrade(sv, SVt_PVNV);
2845 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2846 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2847 SvIV_set(sv, I_V(SvNVX(sv)));
2848 if (SvNVX(sv) == (NV) SvIVX(sv)
2849 #ifndef NV_PRESERVES_UV
2850 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2851 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2852 /* Don't flag it as "accurately an integer" if the number
2853 came from a (by definition imprecise) NV operation, and
2854 we're outside the range of NV integer precision */
2857 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2858 DEBUG_c(PerlIO_printf(Perl_debug_log,
2859 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2865 /* IV not precise. No need to convert from PV, as NV
2866 conversion would already have cached IV if it detected
2867 that PV->IV would be better than PV->NV->IV
2868 flags already correct - don't set public IOK. */
2869 DEBUG_c(PerlIO_printf(Perl_debug_log,
2870 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2875 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2876 but the cast (NV)IV_MIN rounds to a the value less (more
2877 negative) than IV_MIN which happens to be equal to SvNVX ??
2878 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2879 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2880 (NV)UVX == NVX are both true, but the values differ. :-(
2881 Hopefully for 2s complement IV_MIN is something like
2882 0x8000000000000000 which will be exact. NWC */
2885 SvUV_set(sv, U_V(SvNVX(sv)));
2887 (SvNVX(sv) == (NV) SvUVX(sv))
2888 #ifndef NV_PRESERVES_UV
2889 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2890 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2891 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2892 /* Don't flag it as "accurately an integer" if the number
2893 came from a (by definition imprecise) NV operation, and
2894 we're outside the range of NV integer precision */
2899 DEBUG_c(PerlIO_printf(Perl_debug_log,
2900 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2906 else if (SvPOKp(sv) && SvLEN(sv)) {
2908 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2910 /* We want to avoid a possible problem when we cache a UV which
2911 may be later translated to an NV, and the resulting NV is not
2912 the translation of the initial data.
2914 This means that if we cache such a UV, we need to cache the
2915 NV as well. Moreover, we trade speed for space, and do not
2916 cache the NV if not needed.
2919 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2921 == IS_NUMBER_IN_UV) {
2922 /* It's definitely an integer, only upgrade to PVIV */
2923 if (SvTYPE(sv) < SVt_PVIV)
2924 sv_upgrade(sv, SVt_PVIV);
2926 } else if (SvTYPE(sv) < SVt_PVNV)
2927 sv_upgrade(sv, SVt_PVNV);
2929 /* If NV preserves UV then we only use the UV value if we know that
2930 we aren't going to call atof() below. If NVs don't preserve UVs
2931 then the value returned may have more precision than atof() will
2932 return, even though it isn't accurate. */
2933 if ((numtype & (IS_NUMBER_IN_UV
2934 #ifdef NV_PRESERVES_UV
2937 )) == IS_NUMBER_IN_UV) {
2938 /* This won't turn off the public IOK flag if it was set above */
2939 (void)SvIOKp_on(sv);
2941 if (!(numtype & IS_NUMBER_NEG)) {
2943 if (value <= (UV)IV_MAX) {
2944 SvIV_set(sv, (IV)value);
2946 /* it didn't overflow, and it was positive. */
2947 SvUV_set(sv, value);
2951 /* 2s complement assumption */
2952 if (value <= (UV)IV_MIN) {
2953 SvIV_set(sv, -(IV)value);
2955 /* Too negative for an IV. This is a double upgrade, but
2956 I'm assuming it will be rare. */
2957 if (SvTYPE(sv) < SVt_PVNV)
2958 sv_upgrade(sv, SVt_PVNV);
2962 SvNV_set(sv, -(NV)value);
2963 SvIV_set(sv, IV_MIN);
2968 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2969 != IS_NUMBER_IN_UV) {
2970 /* It wasn't an integer, or it overflowed the UV. */
2971 SvNV_set(sv, Atof(SvPVX_const(sv)));
2973 if (! numtype && ckWARN(WARN_NUMERIC))
2976 #if defined(USE_LONG_DOUBLE)
2977 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2978 PTR2UV(sv), SvNVX(sv)));
2980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2981 PTR2UV(sv), SvNVX(sv)));
2984 #ifdef NV_PRESERVES_UV
2985 (void)SvIOKp_on(sv);
2987 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2988 SvIV_set(sv, I_V(SvNVX(sv)));
2989 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2992 /* Integer is imprecise. NOK, IOKp */
2994 /* UV will not work better than IV */
2996 if (SvNVX(sv) > (NV)UV_MAX) {
2998 /* Integer is inaccurate. NOK, IOKp, is UV */
2999 SvUV_set(sv, UV_MAX);
3002 SvUV_set(sv, U_V(SvNVX(sv)));
3003 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3004 NV preservse UV so can do correct comparison. */
3005 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3009 /* Integer is imprecise. NOK, IOKp, is UV */
3014 #else /* NV_PRESERVES_UV */
3015 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3016 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3017 /* The UV slot will have been set from value returned by
3018 grok_number above. The NV slot has just been set using
3021 assert (SvIOKp(sv));
3023 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3024 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3025 /* Small enough to preserve all bits. */
3026 (void)SvIOKp_on(sv);
3028 SvIV_set(sv, I_V(SvNVX(sv)));
3029 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3031 /* Assumption: first non-preserved integer is < IV_MAX,
3032 this NV is in the preserved range, therefore: */
3033 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3035 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);
3038 sv_2iuv_non_preserve (sv, numtype);
3040 #endif /* NV_PRESERVES_UV */
3044 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3045 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3048 if (SvTYPE(sv) < SVt_IV)
3049 /* Typically the caller expects that sv_any is not NULL now. */
3050 sv_upgrade(sv, SVt_IV);
3054 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3055 PTR2UV(sv),SvUVX(sv)));
3056 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3062 Return the num value of an SV, doing any necessary string or integer
3063 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3070 Perl_sv_2nv(pTHX_ register SV *sv)
3074 if (SvGMAGICAL(sv)) {
3078 if (SvPOKp(sv) && SvLEN(sv)) {
3079 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3080 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3082 return Atof(SvPVX_const(sv));
3086 return (NV)SvUVX(sv);
3088 return (NV)SvIVX(sv);
3091 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3092 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3098 if (SvTHINKFIRST(sv)) {
3101 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3102 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3103 return SvNV(tmpstr);
3104 return PTR2NV(SvRV(sv));
3107 sv_force_normal_flags(sv, 0);
3109 if (SvREADONLY(sv) && !SvOK(sv)) {
3110 if (ckWARN(WARN_UNINITIALIZED))
3115 if (SvTYPE(sv) < SVt_NV) {
3116 if (SvTYPE(sv) == SVt_IV)
3117 sv_upgrade(sv, SVt_PVNV);
3119 sv_upgrade(sv, SVt_NV);
3120 #ifdef USE_LONG_DOUBLE
3122 STORE_NUMERIC_LOCAL_SET_STANDARD();
3123 PerlIO_printf(Perl_debug_log,
3124 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3125 PTR2UV(sv), SvNVX(sv));
3126 RESTORE_NUMERIC_LOCAL();
3130 STORE_NUMERIC_LOCAL_SET_STANDARD();
3131 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3132 PTR2UV(sv), SvNVX(sv));
3133 RESTORE_NUMERIC_LOCAL();
3137 else if (SvTYPE(sv) < SVt_PVNV)
3138 sv_upgrade(sv, SVt_PVNV);
3143 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3144 #ifdef NV_PRESERVES_UV
3147 /* Only set the public NV OK flag if this NV preserves the IV */
3148 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3149 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3150 : (SvIVX(sv) == I_V(SvNVX(sv))))
3156 else if (SvPOKp(sv) && SvLEN(sv)) {
3158 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3159 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3161 #ifdef NV_PRESERVES_UV
3162 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3163 == IS_NUMBER_IN_UV) {
3164 /* It's definitely an integer */
3165 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3167 SvNV_set(sv, Atof(SvPVX_const(sv)));
3170 SvNV_set(sv, Atof(SvPVX_const(sv)));
3171 /* Only set the public NV OK flag if this NV preserves the value in
3172 the PV at least as well as an IV/UV would.
3173 Not sure how to do this 100% reliably. */
3174 /* if that shift count is out of range then Configure's test is
3175 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3177 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3178 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3179 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3180 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3181 /* Can't use strtol etc to convert this string, so don't try.
3182 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3185 /* value has been set. It may not be precise. */
3186 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3187 /* 2s complement assumption for (UV)IV_MIN */
3188 SvNOK_on(sv); /* Integer is too negative. */
3193 if (numtype & IS_NUMBER_NEG) {
3194 SvIV_set(sv, -(IV)value);
3195 } else if (value <= (UV)IV_MAX) {
3196 SvIV_set(sv, (IV)value);
3198 SvUV_set(sv, value);
3202 if (numtype & IS_NUMBER_NOT_INT) {
3203 /* I believe that even if the original PV had decimals,
3204 they are lost beyond the limit of the FP precision.
3205 However, neither is canonical, so both only get p
3206 flags. NWC, 2000/11/25 */
3207 /* Both already have p flags, so do nothing */
3209 const NV nv = SvNVX(sv);
3210 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3211 if (SvIVX(sv) == I_V(nv)) {
3216 /* It had no "." so it must be integer. */
3219 /* between IV_MAX and NV(UV_MAX).
3220 Could be slightly > UV_MAX */
3222 if (numtype & IS_NUMBER_NOT_INT) {
3223 /* UV and NV both imprecise. */
3225 const UV nv_as_uv = U_V(nv);
3227 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3238 #endif /* NV_PRESERVES_UV */
3241 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3243 if (SvTYPE(sv) < SVt_NV)
3244 /* Typically the caller expects that sv_any is not NULL now. */
3245 /* XXX Ilya implies that this is a bug in callers that assume this
3246 and ideally should be fixed. */
3247 sv_upgrade(sv, SVt_NV);
3250 #if defined(USE_LONG_DOUBLE)
3252 STORE_NUMERIC_LOCAL_SET_STANDARD();
3253 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3254 PTR2UV(sv), SvNVX(sv));
3255 RESTORE_NUMERIC_LOCAL();
3259 STORE_NUMERIC_LOCAL_SET_STANDARD();
3260 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3261 PTR2UV(sv), SvNVX(sv));
3262 RESTORE_NUMERIC_LOCAL();
3268 /* asIV(): extract an integer from the string value of an SV.
3269 * Caller must validate PVX */
3272 S_asIV(pTHX_ SV *sv)
3275 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3277 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3278 == IS_NUMBER_IN_UV) {
3279 /* It's definitely an integer */
3280 if (numtype & IS_NUMBER_NEG) {
3281 if (value < (UV)IV_MIN)
3284 if (value < (UV)IV_MAX)
3289 if (ckWARN(WARN_NUMERIC))
3292 return I_V(Atof(SvPVX_const(sv)));
3295 /* asUV(): extract an unsigned integer from the string value of an SV
3296 * Caller must validate PVX */
3299 S_asUV(pTHX_ SV *sv)
3302 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3304 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3305 == IS_NUMBER_IN_UV) {
3306 /* It's definitely an integer */
3307 if (!(numtype & IS_NUMBER_NEG))
3311 if (ckWARN(WARN_NUMERIC))
3314 return U_V(Atof(SvPVX_const(sv)));
3318 =for apidoc sv_2pv_nolen
3320 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3321 use the macro wrapper C<SvPV_nolen(sv)> instead.
3326 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3328 return sv_2pv(sv, 0);
3331 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3332 * UV as a string towards the end of buf, and return pointers to start and
3335 * We assume that buf is at least TYPE_CHARS(UV) long.
3339 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3341 char *ptr = buf + TYPE_CHARS(UV);
3355 *--ptr = '0' + (char)(uv % 10);
3363 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3364 * this function provided for binary compatibility only
3368 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3370 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3374 =for apidoc sv_2pv_flags
3376 Returns a pointer to the string value of an SV, and sets *lp to its length.
3377 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3379 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3380 usually end up here too.
3386 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3391 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3392 char *tmpbuf = tbuf;
3399 if (SvGMAGICAL(sv)) {
3400 if (flags & SV_GMAGIC)
3405 if (flags & SV_MUTABLE_RETURN)
3406 return SvPVX_mutable(sv);
3407 if (flags & SV_CONST_RETURN)
3408 return (char *)SvPVX_const(sv);
3413 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3415 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3420 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3425 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3426 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3434 if (SvTHINKFIRST(sv)) {
3437 register const char *typestr;
3438 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3439 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3441 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3444 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3445 if (flags & SV_CONST_RETURN) {
3446 pv = (char *) SvPVX_const(tmpstr);
3448 pv = (flags & SV_MUTABLE_RETURN)
3449 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3452 *lp = SvCUR(tmpstr);
3454 pv = sv_2pv_flags(tmpstr, lp, flags);
3465 typestr = "NULLREF";
3469 switch (SvTYPE(sv)) {
3471 if ( ((SvFLAGS(sv) &
3472 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3473 == (SVs_OBJECT|SVs_SMG))
3474 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3475 const regexp *re = (regexp *)mg->mg_obj;
3478 const char *fptr = "msix";
3483 char need_newline = 0;
3484 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3486 while((ch = *fptr++)) {
3488 reflags[left++] = ch;
3491 reflags[right--] = ch;
3496 reflags[left] = '-';
3500 mg->mg_len = re->prelen + 4 + left;
3502 * If /x was used, we have to worry about a regex
3503 * ending with a comment later being embedded
3504 * within another regex. If so, we don't want this
3505 * regex's "commentization" to leak out to the
3506 * right part of the enclosing regex, we must cap
3507 * it with a newline.
3509 * So, if /x was used, we scan backwards from the
3510 * end of the regex. If we find a '#' before we
3511 * find a newline, we need to add a newline
3512 * ourself. If we find a '\n' first (or if we
3513 * don't find '#' or '\n'), we don't need to add
3514 * anything. -jfriedl
3516 if (PMf_EXTENDED & re->reganch)
3518 const char *endptr = re->precomp + re->prelen;
3519 while (endptr >= re->precomp)
3521 const char c = *(endptr--);
3523 break; /* don't need another */
3525 /* we end while in a comment, so we
3527 mg->mg_len++; /* save space for it */
3528 need_newline = 1; /* note to add it */
3534 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3535 Copy("(?", mg->mg_ptr, 2, char);
3536 Copy(reflags, mg->mg_ptr+2, left, char);
3537 Copy(":", mg->mg_ptr+left+2, 1, char);
3538 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3540 mg->mg_ptr[mg->mg_len - 2] = '\n';
3541 mg->mg_ptr[mg->mg_len - 1] = ')';
3542 mg->mg_ptr[mg->mg_len] = 0;
3544 PL_reginterp_cnt += re->program[0].next_off;
3546 if (re->reganch & ROPT_UTF8)
3562 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3563 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3564 /* tied lvalues should appear to be
3565 * scalars for backwards compatitbility */
3566 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3567 ? "SCALAR" : "LVALUE"; break;
3568 case SVt_PVAV: typestr = "ARRAY"; break;
3569 case SVt_PVHV: typestr = "HASH"; break;
3570 case SVt_PVCV: typestr = "CODE"; break;
3571 case SVt_PVGV: typestr = "GLOB"; break;
3572 case SVt_PVFM: typestr = "FORMAT"; break;
3573 case SVt_PVIO: typestr = "IO"; break;
3574 default: typestr = "UNKNOWN"; break;
3578 const char *name = HvNAME_get(SvSTASH(sv));
3579 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3580 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3583 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3587 *lp = strlen(typestr);
3588 return (char *)typestr;
3590 if (SvREADONLY(sv) && !SvOK(sv)) {
3591 if (ckWARN(WARN_UNINITIALIZED))
3598 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3599 /* I'm assuming that if both IV and NV are equally valid then
3600 converting the IV is going to be more efficient */
3601 const U32 isIOK = SvIOK(sv);
3602 const U32 isUIOK = SvIsUV(sv);
3603 char buf[TYPE_CHARS(UV)];
3606 if (SvTYPE(sv) < SVt_PVIV)
3607 sv_upgrade(sv, SVt_PVIV);
3609 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3611 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3612 /* inlined from sv_setpvn */
3613 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3614 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3615 SvCUR_set(sv, ebuf - ptr);
3625 else if (SvNOKp(sv)) {
3626 if (SvTYPE(sv) < SVt_PVNV)
3627 sv_upgrade(sv, SVt_PVNV);
3628 /* The +20 is pure guesswork. Configure test needed. --jhi */
3629 s = SvGROW_mutable(sv, NV_DIG + 20);
3630 olderrno = errno; /* some Xenix systems wipe out errno here */
3632 if (SvNVX(sv) == 0.0)
3633 (void)strcpy(s,"0");
3637 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3640 #ifdef FIXNEGATIVEZERO
3641 if (*s == '-' && s[1] == '0' && !s[2])
3651 if (ckWARN(WARN_UNINITIALIZED)
3652 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3656 if (SvTYPE(sv) < SVt_PV)
3657 /* Typically the caller expects that sv_any is not NULL now. */
3658 sv_upgrade(sv, SVt_PV);
3662 STRLEN len = s - SvPVX_const(sv);
3668 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3669 PTR2UV(sv),SvPVX_const(sv)));
3670 if (flags & SV_CONST_RETURN)
3671 return (char *)SvPVX_const(sv);
3672 if (flags & SV_MUTABLE_RETURN)
3673 return SvPVX_mutable(sv);
3677 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3678 /* Sneaky stuff here */
3682 tsv = newSVpv(tmpbuf, 0);
3695 t = SvPVX_const(tsv);
3700 len = strlen(tmpbuf);
3702 #ifdef FIXNEGATIVEZERO
3703 if (len == 2 && t[0] == '-' && t[1] == '0') {
3708 SvUPGRADE(sv, SVt_PV);
3711 s = SvGROW_mutable(sv, len + 1);
3714 return strcpy(s, t);
3719 =for apidoc sv_copypv
3721 Copies a stringified representation of the source SV into the
3722 destination SV. Automatically performs any necessary mg_get and
3723 coercion of numeric values into strings. Guaranteed to preserve
3724 UTF-8 flag even from overloaded objects. Similar in nature to
3725 sv_2pv[_flags] but operates directly on an SV instead of just the
3726 string. Mostly uses sv_2pv_flags to do its work, except when that
3727 would lose the UTF-8'ness of the PV.
3733 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3737 s = SvPV_const(ssv,len);
3738 sv_setpvn(dsv,s,len);
3746 =for apidoc sv_2pvbyte_nolen
3748 Return a pointer to the byte-encoded representation of the SV.
3749 May cause the SV to be downgraded from UTF-8 as a side-effect.
3751 Usually accessed via the C<SvPVbyte_nolen> macro.
3757 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3759 return sv_2pvbyte(sv, 0);
3763 =for apidoc sv_2pvbyte
3765 Return a pointer to the byte-encoded representation of the SV, and set *lp
3766 to its length. May cause the SV to be downgraded from UTF-8 as a
3769 Usually accessed via the C<SvPVbyte> macro.
3775 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3777 sv_utf8_downgrade(sv,0);
3778 return SvPV(sv,*lp);
3782 =for apidoc sv_2pvutf8_nolen
3784 Return a pointer to the UTF-8-encoded representation of the SV.
3785 May cause the SV to be upgraded to UTF-8 as a side-effect.
3787 Usually accessed via the C<SvPVutf8_nolen> macro.
3793 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3795 return sv_2pvutf8(sv, 0);
3799 =for apidoc sv_2pvutf8
3801 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3802 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3804 Usually accessed via the C<SvPVutf8> macro.
3810 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3812 sv_utf8_upgrade(sv);
3813 return SvPV(sv,*lp);
3817 =for apidoc sv_2bool
3819 This function is only called on magical items, and is only used by
3820 sv_true() or its macro equivalent.
3826 Perl_sv_2bool(pTHX_ register SV *sv)
3835 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3836 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3837 return (bool)SvTRUE(tmpsv);
3838 return SvRV(sv) != 0;
3841 register XPV* Xpvtmp;
3842 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3843 (*sv->sv_u.svu_pv > '0' ||
3844 Xpvtmp->xpv_cur > 1 ||
3845 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3852 return SvIVX(sv) != 0;
3855 return SvNVX(sv) != 0.0;
3862 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3863 * this function provided for binary compatibility only
3868 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3870 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3874 =for apidoc sv_utf8_upgrade
3876 Converts the PV of an SV to its UTF-8-encoded form.
3877 Forces the SV to string form if it is not already.
3878 Always sets the SvUTF8 flag to avoid future validity checks even
3879 if all the bytes have hibit clear.
3881 This is not as a general purpose byte encoding to Unicode interface:
3882 use the Encode extension for that.
3884 =for apidoc sv_utf8_upgrade_flags
3886 Converts the PV of an SV to its UTF-8-encoded form.
3887 Forces the SV to string form if it is not already.
3888 Always sets the SvUTF8 flag to avoid future validity checks even
3889 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3890 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3891 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3893 This is not as a general purpose byte encoding to Unicode interface:
3894 use the Encode extension for that.
3900 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3902 if (sv == &PL_sv_undef)
3906 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3907 (void) sv_2pv_flags(sv,&len, flags);
3911 (void) SvPV_force(sv,len);
3920 sv_force_normal_flags(sv, 0);
3923 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3924 sv_recode_to_utf8(sv, PL_encoding);
3925 else { /* Assume Latin-1/EBCDIC */
3926 /* This function could be much more efficient if we
3927 * had a FLAG in SVs to signal if there are any hibit
3928 * chars in the PV. Given that there isn't such a flag
3929 * make the loop as fast as possible. */
3930 const U8 *s = (U8 *) SvPVX_const(sv);
3931 const U8 *e = (U8 *) SvEND(sv);
3937 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3941 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3942 char *recoded = bytes_to_utf8((U8*)s, &len);
3944 SvPV_free(sv); /* No longer using what was there before. */
3946 SvPV_set(sv, recoded);
3947 SvCUR_set(sv, len - 1);
3948 SvLEN_set(sv, len); /* No longer know the real size. */
3950 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3957 =for apidoc sv_utf8_downgrade
3959 Attempts to convert the PV of an SV from characters to bytes.
3960 If the PV contains a character beyond byte, this conversion will fail;
3961 in this case, either returns false or, if C<fail_ok> is not
3964 This is not as a general purpose Unicode to byte encoding interface:
3965 use the Encode extension for that.
3971 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3973 if (SvPOKp(sv) && SvUTF8(sv)) {
3979 sv_force_normal_flags(sv, 0);
3981 s = (U8 *) SvPV(sv, len);
3982 if (!utf8_to_bytes(s, &len)) {
3987 Perl_croak(aTHX_ "Wide character in %s",
3990 Perl_croak(aTHX_ "Wide character");
4001 =for apidoc sv_utf8_encode
4003 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4004 flag off so that it looks like octets again.
4010 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4012 (void) sv_utf8_upgrade(sv);
4014 sv_force_normal_flags(sv, 0);
4016 if (SvREADONLY(sv)) {
4017 Perl_croak(aTHX_ PL_no_modify);
4023 =for apidoc sv_utf8_decode
4025 If the PV of the SV is an octet sequence in UTF-8
4026 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4027 so that it looks like a character. If the PV contains only single-byte
4028 characters, the C<SvUTF8> flag stays being off.
4029 Scans PV for validity and returns false if the PV is invalid UTF-8.
4035 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4041 /* The octets may have got themselves encoded - get them back as
4044 if (!sv_utf8_downgrade(sv, TRUE))
4047 /* it is actually just a matter of turning the utf8 flag on, but
4048 * we want to make sure everything inside is valid utf8 first.
4050 c = (const U8 *) SvPVX_const(sv);
4051 if (!is_utf8_string(c, SvCUR(sv)+1))
4053 e = (const U8 *) SvEND(sv);
4056 if (!UTF8_IS_INVARIANT(ch)) {
4065 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4066 * this function provided for binary compatibility only
4070 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4072 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4076 =for apidoc sv_setsv
4078 Copies the contents of the source SV C<ssv> into the destination SV
4079 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4080 function if the source SV needs to be reused. Does not handle 'set' magic.
4081 Loosely speaking, it performs a copy-by-value, obliterating any previous
4082 content of the destination.
4084 You probably want to use one of the assortment of wrappers, such as
4085 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4086 C<SvSetMagicSV_nosteal>.
4088 =for apidoc sv_setsv_flags
4090 Copies the contents of the source SV C<ssv> into the destination SV
4091 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4092 function if the source SV needs to be reused. Does not handle 'set' magic.
4093 Loosely speaking, it performs a copy-by-value, obliterating any previous
4094 content of the destination.
4095 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4096 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4097 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4098 and C<sv_setsv_nomg> are implemented in terms of this function.
4100 You probably want to use one of the assortment of wrappers, such as
4101 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4102 C<SvSetMagicSV_nosteal>.
4104 This is the primary function for copying scalars, and most other
4105 copy-ish functions and macros use this underneath.
4111 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4113 register U32 sflags;
4119 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4121 sstr = &PL_sv_undef;
4122 stype = SvTYPE(sstr);
4123 dtype = SvTYPE(dstr);
4128 /* need to nuke the magic */
4130 SvRMAGICAL_off(dstr);
4133 /* There's a lot of redundancy below but we're going for speed here */
4138 if (dtype != SVt_PVGV) {
4139 (void)SvOK_off(dstr);
4147 sv_upgrade(dstr, SVt_IV);
4150 sv_upgrade(dstr, SVt_PVNV);
4154 sv_upgrade(dstr, SVt_PVIV);
4157 (void)SvIOK_only(dstr);
4158 SvIV_set(dstr, SvIVX(sstr));
4161 if (SvTAINTED(sstr))
4172 sv_upgrade(dstr, SVt_NV);
4177 sv_upgrade(dstr, SVt_PVNV);
4180 SvNV_set(dstr, SvNVX(sstr));
4181 (void)SvNOK_only(dstr);
4182 if (SvTAINTED(sstr))
4190 sv_upgrade(dstr, SVt_RV);
4191 else if (dtype == SVt_PVGV &&
4192 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4195 if (GvIMPORTED(dstr) != GVf_IMPORTED
4196 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4198 GvIMPORTED_on(dstr);
4207 #ifdef PERL_OLD_COPY_ON_WRITE
4208 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4209 if (dtype < SVt_PVIV)
4210 sv_upgrade(dstr, SVt_PVIV);
4217 sv_upgrade(dstr, SVt_PV);
4220 if (dtype < SVt_PVIV)
4221 sv_upgrade(dstr, SVt_PVIV);
4224 if (dtype < SVt_PVNV)
4225 sv_upgrade(dstr, SVt_PVNV);
4232 const char * const type = sv_reftype(sstr,0);
4234 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4236 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4241 if (dtype <= SVt_PVGV) {
4243 if (dtype != SVt_PVGV) {
4244 const char * const name = GvNAME(sstr);
4245 const STRLEN len = GvNAMELEN(sstr);
4246 /* don't upgrade SVt_PVLV: it can hold a glob */
4247 if (dtype != SVt_PVLV)
4248 sv_upgrade(dstr, SVt_PVGV);
4249 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4250 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4251 GvNAME(dstr) = savepvn(name, len);
4252 GvNAMELEN(dstr) = len;
4253 SvFAKE_on(dstr); /* can coerce to non-glob */
4255 /* ahem, death to those who redefine active sort subs */
4256 else if (PL_curstackinfo->si_type == PERLSI_SORT
4257 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4258 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4261 #ifdef GV_UNIQUE_CHECK
4262 if (GvUNIQUE((GV*)dstr)) {
4263 Perl_croak(aTHX_ PL_no_modify);
4267 (void)SvOK_off(dstr);
4268 GvINTRO_off(dstr); /* one-shot flag */
4270 GvGP(dstr) = gp_ref(GvGP(sstr));
4271 if (SvTAINTED(sstr))
4273 if (GvIMPORTED(dstr) != GVf_IMPORTED
4274 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4276 GvIMPORTED_on(dstr);
4284 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4286 if ((int)SvTYPE(sstr) != stype) {
4287 stype = SvTYPE(sstr);
4288 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4292 if (stype == SVt_PVLV)
4293 SvUPGRADE(dstr, SVt_PVNV);
4295 SvUPGRADE(dstr, (U32)stype);
4298 sflags = SvFLAGS(sstr);
4300 if (sflags & SVf_ROK) {
4301 if (dtype >= SVt_PV) {
4302 if (dtype == SVt_PVGV) {
4303 SV *sref = SvREFCNT_inc(SvRV(sstr));
4305 const int intro = GvINTRO(dstr);
4307 #ifdef GV_UNIQUE_CHECK
4308 if (GvUNIQUE((GV*)dstr)) {
4309 Perl_croak(aTHX_ PL_no_modify);
4314 GvINTRO_off(dstr); /* one-shot flag */
4315 GvLINE(dstr) = CopLINE(PL_curcop);
4316 GvEGV(dstr) = (GV*)dstr;
4319 switch (SvTYPE(sref)) {
4322 SAVEGENERICSV(GvAV(dstr));
4324 dref = (SV*)GvAV(dstr);
4325 GvAV(dstr) = (AV*)sref;
4326 if (!GvIMPORTED_AV(dstr)
4327 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4329 GvIMPORTED_AV_on(dstr);
4334 SAVEGENERICSV(GvHV(dstr));
4336 dref = (SV*)GvHV(dstr);
4337 GvHV(dstr) = (HV*)sref;
4338 if (!GvIMPORTED_HV(dstr)
4339 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4341 GvIMPORTED_HV_on(dstr);
4346 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4347 SvREFCNT_dec(GvCV(dstr));
4348 GvCV(dstr) = Nullcv;
4349 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4350 PL_sub_generation++;
4352 SAVEGENERICSV(GvCV(dstr));
4355 dref = (SV*)GvCV(dstr);
4356 if (GvCV(dstr) != (CV*)sref) {
4357 CV* cv = GvCV(dstr);
4359 if (!GvCVGEN((GV*)dstr) &&
4360 (CvROOT(cv) || CvXSUB(cv)))
4362 /* ahem, death to those who redefine
4363 * active sort subs */
4364 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4365 PL_sortcop == CvSTART(cv))
4367 "Can't redefine active sort subroutine %s",
4368 GvENAME((GV*)dstr));
4369 /* Redefining a sub - warning is mandatory if
4370 it was a const and its value changed. */
4371 if (ckWARN(WARN_REDEFINE)
4373 && (!CvCONST((CV*)sref)
4374 || sv_cmp(cv_const_sv(cv),
4375 cv_const_sv((CV*)sref)))))
4377 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4379 ? "Constant subroutine %s::%s redefined"
4380 : "Subroutine %s::%s redefined",
4381 HvNAME_get(GvSTASH((GV*)dstr)),
4382 GvENAME((GV*)dstr));
4386 cv_ckproto(cv, (GV*)dstr,
4388 ? SvPVX_const(sref) : Nullch);
4390 GvCV(dstr) = (CV*)sref;
4391 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4392 GvASSUMECV_on(dstr);
4393 PL_sub_generation++;
4395 if (!GvIMPORTED_CV(dstr)
4396 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4398 GvIMPORTED_CV_on(dstr);
4403 SAVEGENERICSV(GvIOp(dstr));
4405 dref = (SV*)GvIOp(dstr);
4406 GvIOp(dstr) = (IO*)sref;
4410 SAVEGENERICSV(GvFORM(dstr));
4412 dref = (SV*)GvFORM(dstr);
4413 GvFORM(dstr) = (CV*)sref;
4417 SAVEGENERICSV(GvSV(dstr));
4419 dref = (SV*)GvSV(dstr);
4421 if (!GvIMPORTED_SV(dstr)
4422 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4424 GvIMPORTED_SV_on(dstr);
4430 if (SvTAINTED(sstr))
4434 if (SvPVX_const(dstr)) {
4440 (void)SvOK_off(dstr);
4441 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4443 if (sflags & SVp_NOK) {
4445 /* Only set the public OK flag if the source has public OK. */
4446 if (sflags & SVf_NOK)
4447 SvFLAGS(dstr) |= SVf_NOK;
4448 SvNV_set(dstr, SvNVX(sstr));
4450 if (sflags & SVp_IOK) {
4451 (void)SvIOKp_on(dstr);
4452 if (sflags & SVf_IOK)
4453 SvFLAGS(dstr) |= SVf_IOK;
4454 if (sflags & SVf_IVisUV)
4456 SvIV_set(dstr, SvIVX(sstr));
4458 if (SvAMAGIC(sstr)) {
4462 else if (sflags & SVp_POK) {
4466 * Check to see if we can just swipe the string. If so, it's a
4467 * possible small lose on short strings, but a big win on long ones.
4468 * It might even be a win on short strings if SvPVX_const(dstr)
4469 * has to be allocated and SvPVX_const(sstr) has to be freed.
4472 /* Whichever path we take through the next code, we want this true,
4473 and doing it now facilitates the COW check. */
4474 (void)SvPOK_only(dstr);
4477 /* We're not already COW */
4478 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4479 #ifndef PERL_OLD_COPY_ON_WRITE
4480 /* or we are, but dstr isn't a suitable target. */
4481 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4486 (sflags & SVs_TEMP) && /* slated for free anyway? */
4487 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4488 (!(flags & SV_NOSTEAL)) &&
4489 /* and we're allowed to steal temps */
4490 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4491 SvLEN(sstr) && /* and really is a string */
4492 /* and won't be needed again, potentially */
4493 !(PL_op && PL_op->op_type == OP_AASSIGN))
4494 #ifdef PERL_OLD_COPY_ON_WRITE
4495 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4496 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4497 && SvTYPE(sstr) >= SVt_PVIV)
4500 /* Failed the swipe test, and it's not a shared hash key either.
4501 Have to copy the string. */
4502 STRLEN len = SvCUR(sstr);
4503 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4504 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4505 SvCUR_set(dstr, len);
4506 *SvEND(dstr) = '\0';
4508 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4510 /* Either it's a shared hash key, or it's suitable for
4511 copy-on-write or we can swipe the string. */
4513 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4517 #ifdef PERL_OLD_COPY_ON_WRITE
4519 /* I believe I should acquire a global SV mutex if
4520 it's a COW sv (not a shared hash key) to stop
4521 it going un copy-on-write.
4522 If the source SV has gone un copy on write between up there
4523 and down here, then (assert() that) it is of the correct
4524 form to make it copy on write again */
4525 if ((sflags & (SVf_FAKE | SVf_READONLY))
4526 != (SVf_FAKE | SVf_READONLY)) {
4527 SvREADONLY_on(sstr);
4529 /* Make the source SV into a loop of 1.
4530 (about to become 2) */
4531 SV_COW_NEXT_SV_SET(sstr, sstr);
4535 /* Initial code is common. */
4536 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4538 SvFLAGS(dstr) &= ~SVf_OOK;
4539 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4541 else if (SvLEN(dstr))
4542 Safefree(SvPVX_const(dstr));
4546 /* making another shared SV. */
4547 STRLEN cur = SvCUR(sstr);
4548 STRLEN len = SvLEN(sstr);
4549 #ifdef PERL_OLD_COPY_ON_WRITE
4551 assert (SvTYPE(dstr) >= SVt_PVIV);
4552 /* SvIsCOW_normal */
4553 /* splice us in between source and next-after-source. */
4554 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4555 SV_COW_NEXT_SV_SET(sstr, dstr);
4556 SvPV_set(dstr, SvPVX_mutable(sstr));
4560 /* SvIsCOW_shared_hash */
4561 DEBUG_C(PerlIO_printf(Perl_debug_log,
4562 "Copy on write: Sharing hash\n"));
4564 assert (SvTYPE(dstr) >= SVt_PV);
4566 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4568 SvLEN_set(dstr, len);
4569 SvCUR_set(dstr, cur);
4570 SvREADONLY_on(dstr);
4572 /* Relesase a global SV mutex. */
4575 { /* Passes the swipe test. */
4576 SvPV_set(dstr, SvPVX_mutable(sstr));
4577 SvLEN_set(dstr, SvLEN(sstr));
4578 SvCUR_set(dstr, SvCUR(sstr));
4581 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4582 SvPV_set(sstr, Nullch);
4588 if (sflags & SVf_UTF8)
4591 if (sflags & SVp_NOK) {
4593 if (sflags & SVf_NOK)
4594 SvFLAGS(dstr) |= SVf_NOK;
4595 SvNV_set(dstr, SvNVX(sstr));
4597 if (sflags & SVp_IOK) {
4598 (void)SvIOKp_on(dstr);
4599 if (sflags & SVf_IOK)
4600 SvFLAGS(dstr) |= SVf_IOK;
4601 if (sflags & SVf_IVisUV)
4603 SvIV_set(dstr, SvIVX(sstr));
4606 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4607 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4608 smg->mg_ptr, smg->mg_len);
4609 SvRMAGICAL_on(dstr);
4612 else if (sflags & SVp_IOK) {
4613 if (sflags & SVf_IOK)
4614 (void)SvIOK_only(dstr);
4616 (void)SvOK_off(dstr);
4617 (void)SvIOKp_on(dstr);
4619 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4620 if (sflags & SVf_IVisUV)
4622 SvIV_set(dstr, SvIVX(sstr));
4623 if (sflags & SVp_NOK) {
4624 if (sflags & SVf_NOK)
4625 (void)SvNOK_on(dstr);
4627 (void)SvNOKp_on(dstr);
4628 SvNV_set(dstr, SvNVX(sstr));
4631 else if (sflags & SVp_NOK) {
4632 if (sflags & SVf_NOK)
4633 (void)SvNOK_only(dstr);
4635 (void)SvOK_off(dstr);
4638 SvNV_set(dstr, SvNVX(sstr));
4641 if (dtype == SVt_PVGV) {
4642 if (ckWARN(WARN_MISC))
4643 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4646 (void)SvOK_off(dstr);
4648 if (SvTAINTED(sstr))
4653 =for apidoc sv_setsv_mg
4655 Like C<sv_setsv>, but also handles 'set' magic.
4661 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4663 sv_setsv(dstr,sstr);
4667 #ifdef PERL_OLD_COPY_ON_WRITE
4669 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4671 STRLEN cur = SvCUR(sstr);
4672 STRLEN len = SvLEN(sstr);
4673 register char *new_pv;
4676 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4684 if (SvTHINKFIRST(dstr))
4685 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4686 else if (SvPVX_const(dstr))
4687 Safefree(SvPVX_const(dstr));
4691 SvUPGRADE(dstr, SVt_PVIV);
4693 assert (SvPOK(sstr));
4694 assert (SvPOKp(sstr));
4695 assert (!SvIOK(sstr));
4696 assert (!SvIOKp(sstr));
4697 assert (!SvNOK(sstr));
4698 assert (!SvNOKp(sstr));
4700 if (SvIsCOW(sstr)) {
4702 if (SvLEN(sstr) == 0) {
4703 /* source is a COW shared hash key. */
4704 DEBUG_C(PerlIO_printf(Perl_debug_log,
4705 "Fast copy on write: Sharing hash\n"));
4706 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4709 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4711 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4712 SvUPGRADE(sstr, SVt_PVIV);
4713 SvREADONLY_on(sstr);
4715 DEBUG_C(PerlIO_printf(Perl_debug_log,
4716 "Fast copy on write: Converting sstr to COW\n"));
4717 SV_COW_NEXT_SV_SET(dstr, sstr);
4719 SV_COW_NEXT_SV_SET(sstr, dstr);
4720 new_pv = SvPVX_mutable(sstr);
4723 SvPV_set(dstr, new_pv);
4724 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4727 SvLEN_set(dstr, len);
4728 SvCUR_set(dstr, cur);
4737 =for apidoc sv_setpvn
4739 Copies a string into an SV. The C<len> parameter indicates the number of
4740 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4741 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4747 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4749 register char *dptr;
4751 SV_CHECK_THINKFIRST_COW_DROP(sv);
4757 /* len is STRLEN which is unsigned, need to copy to signed */
4760 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4762 SvUPGRADE(sv, SVt_PV);
4764 dptr = SvGROW(sv, len + 1);
4765 Move(ptr,dptr,len,char);
4768 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4773 =for apidoc sv_setpvn_mg
4775 Like C<sv_setpvn>, but also handles 'set' magic.
4781 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4783 sv_setpvn(sv,ptr,len);
4788 =for apidoc sv_setpv
4790 Copies a string into an SV. The string must be null-terminated. Does not
4791 handle 'set' magic. See C<sv_setpv_mg>.
4797 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4799 register STRLEN len;
4801 SV_CHECK_THINKFIRST_COW_DROP(sv);
4807 SvUPGRADE(sv, SVt_PV);
4809 SvGROW(sv, len + 1);
4810 Move(ptr,SvPVX(sv),len+1,char);
4812 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4817 =for apidoc sv_setpv_mg
4819 Like C<sv_setpv>, but also handles 'set' magic.
4825 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4832 =for apidoc sv_usepvn
4834 Tells an SV to use C<ptr> to find its string value. Normally the string is
4835 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4836 The C<ptr> should point to memory that was allocated by C<malloc>. The
4837 string length, C<len>, must be supplied. This function will realloc the
4838 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4839 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4840 See C<sv_usepvn_mg>.
4846 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4849 SV_CHECK_THINKFIRST_COW_DROP(sv);
4850 SvUPGRADE(sv, SVt_PV);
4855 if (SvPVX_const(sv))
4858 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4859 ptr = saferealloc (ptr, allocate);
4862 SvLEN_set(sv, allocate);
4864 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4869 =for apidoc sv_usepvn_mg
4871 Like C<sv_usepvn>, but also handles 'set' magic.
4877 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4879 sv_usepvn(sv,ptr,len);
4883 #ifdef PERL_OLD_COPY_ON_WRITE
4884 /* Need to do this *after* making the SV normal, as we need the buffer
4885 pointer to remain valid until after we've copied it. If we let go too early,
4886 another thread could invalidate it by unsharing last of the same hash key
4887 (which it can do by means other than releasing copy-on-write Svs)
4888 or by changing the other copy-on-write SVs in the loop. */
4890 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4892 if (len) { /* this SV was SvIsCOW_normal(sv) */
4893 /* we need to find the SV pointing to us. */
4894 SV *current = SV_COW_NEXT_SV(after);
4896 if (current == sv) {
4897 /* The SV we point to points back to us (there were only two of us
4899 Hence other SV is no longer copy on write either. */
4901 SvREADONLY_off(after);
4903 /* We need to follow the pointers around the loop. */
4905 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4908 /* don't loop forever if the structure is bust, and we have
4909 a pointer into a closed loop. */
4910 assert (current != after);
4911 assert (SvPVX_const(current) == pvx);
4913 /* Make the SV before us point to the SV after us. */
4914 SV_COW_NEXT_SV_SET(current, after);
4917 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4922 Perl_sv_release_IVX(pTHX_ register SV *sv)
4925 sv_force_normal_flags(sv, 0);
4931 =for apidoc sv_force_normal_flags
4933 Undo various types of fakery on an SV: if the PV is a shared string, make
4934 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4935 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4936 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4937 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4938 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4939 set to some other value.) In addition, the C<flags> parameter gets passed to
4940 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4941 with flags set to 0.
4947 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4949 #ifdef PERL_OLD_COPY_ON_WRITE
4950 if (SvREADONLY(sv)) {
4951 /* At this point I believe I should acquire a global SV mutex. */
4953 const char *pvx = SvPVX_const(sv);
4954 const STRLEN len = SvLEN(sv);
4955 const STRLEN cur = SvCUR(sv);
4956 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4958 PerlIO_printf(Perl_debug_log,
4959 "Copy on write: Force normal %ld\n",
4965 /* This SV doesn't own the buffer, so need to New() a new one: */
4966 SvPV_set(sv, (char*)0);
4968 if (flags & SV_COW_DROP_PV) {
4969 /* OK, so we don't need to copy our buffer. */
4972 SvGROW(sv, cur + 1);
4973 Move(pvx,SvPVX(sv),cur,char);
4977 sv_release_COW(sv, pvx, len, next);
4982 else if (IN_PERL_RUNTIME)
4983 Perl_croak(aTHX_ PL_no_modify);
4984 /* At this point I believe that I can drop the global SV mutex. */
4987 if (SvREADONLY(sv)) {
4989 const char *pvx = SvPVX_const(sv);
4990 const STRLEN len = SvCUR(sv);
4993 SvPV_set(sv, Nullch);
4995 SvGROW(sv, len + 1);
4996 Move(pvx,SvPVX_const(sv),len,char);
4998 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
5000 else if (IN_PERL_RUNTIME)
5001 Perl_croak(aTHX_ PL_no_modify);
5005 sv_unref_flags(sv, flags);
5006 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5011 =for apidoc sv_force_normal
5013 Undo various types of fakery on an SV: if the PV is a shared string, make
5014 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5015 an xpvmg. See also C<sv_force_normal_flags>.
5021 Perl_sv_force_normal(pTHX_ register SV *sv)
5023 sv_force_normal_flags(sv, 0);
5029 Efficient removal of characters from the beginning of the string buffer.
5030 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5031 the string buffer. The C<ptr> becomes the first character of the adjusted
5032 string. Uses the "OOK hack".
5033 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5034 refer to the same chunk of data.
5040 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5042 register STRLEN delta;
5043 if (!ptr || !SvPOKp(sv))
5045 delta = ptr - SvPVX_const(sv);
5046 SV_CHECK_THINKFIRST(sv);
5047 if (SvTYPE(sv) < SVt_PVIV)
5048 sv_upgrade(sv,SVt_PVIV);
5051 if (!SvLEN(sv)) { /* make copy of shared string */
5052 const char *pvx = SvPVX_const(sv);
5053 const STRLEN len = SvCUR(sv);
5054 SvGROW(sv, len + 1);
5055 Move(pvx,SvPVX_const(sv),len,char);
5059 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5060 and we do that anyway inside the SvNIOK_off
5062 SvFLAGS(sv) |= SVf_OOK;
5065 SvLEN_set(sv, SvLEN(sv) - delta);
5066 SvCUR_set(sv, SvCUR(sv) - delta);
5067 SvPV_set(sv, SvPVX(sv) + delta);
5068 SvIV_set(sv, SvIVX(sv) + delta);
5071 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5072 * this function provided for binary compatibility only
5076 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5078 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5082 =for apidoc sv_catpvn
5084 Concatenates the string onto the end of the string which is in the SV. The
5085 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5086 status set, then the bytes appended should be valid UTF-8.
5087 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5089 =for apidoc sv_catpvn_flags
5091 Concatenates the string onto the end of the string which is in the SV. The
5092 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5093 status set, then the bytes appended should be valid UTF-8.
5094 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5095 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5096 in terms of this function.
5102 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5105 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5107 SvGROW(dsv, dlen + slen + 1);
5109 sstr = SvPVX_const(dsv);
5110 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5111 SvCUR_set(dsv, SvCUR(dsv) + slen);
5113 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5118 =for apidoc sv_catpvn_mg
5120 Like C<sv_catpvn>, but also handles 'set' magic.
5126 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5128 sv_catpvn(sv,ptr,len);
5132 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5133 * this function provided for binary compatibility only
5137 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5139 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5143 =for apidoc sv_catsv
5145 Concatenates the string from SV C<ssv> onto the end of the string in
5146 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5147 not 'set' magic. See C<sv_catsv_mg>.
5149 =for apidoc sv_catsv_flags
5151 Concatenates the string from SV C<ssv> onto the end of the string in
5152 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5153 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5154 and C<sv_catsv_nomg> are implemented in terms of this function.
5159 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5165 if ((spv = SvPV_const(ssv, slen))) {
5166 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5167 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5168 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5169 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5170 dsv->sv_flags doesn't have that bit set.
5171 Andy Dougherty 12 Oct 2001
5173 const I32 sutf8 = DO_UTF8(ssv);
5176 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5178 dutf8 = DO_UTF8(dsv);
5180 if (dutf8 != sutf8) {
5182 /* Not modifying source SV, so taking a temporary copy. */
5183 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5185 sv_utf8_upgrade(csv);
5186 spv = SvPV_const(csv, slen);
5189 sv_utf8_upgrade_nomg(dsv);
5191 sv_catpvn_nomg(dsv, spv, slen);
5196 =for apidoc sv_catsv_mg
5198 Like C<sv_catsv>, but also handles 'set' magic.
5204 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5211 =for apidoc sv_catpv
5213 Concatenates the string onto the end of the string which is in the SV.
5214 If the SV has the UTF-8 status set, then the bytes appended should be
5215 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5220 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5222 register STRLEN len;
5228 junk = SvPV_force(sv, tlen);
5230 SvGROW(sv, tlen + len + 1);
5232 ptr = SvPVX_const(sv);
5233 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5234 SvCUR_set(sv, SvCUR(sv) + len);
5235 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5240 =for apidoc sv_catpv_mg
5242 Like C<sv_catpv>, but also handles 'set' magic.
5248 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5257 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5258 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5265 Perl_newSV(pTHX_ STRLEN len)
5271 sv_upgrade(sv, SVt_PV);
5272 SvGROW(sv, len + 1);
5277 =for apidoc sv_magicext
5279 Adds magic to an SV, upgrading it if necessary. Applies the
5280 supplied vtable and returns a pointer to the magic added.
5282 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5283 In particular, you can add magic to SvREADONLY SVs, and add more than
5284 one instance of the same 'how'.
5286 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5287 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5288 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5289 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5291 (This is now used as a subroutine by C<sv_magic>.)
5296 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5297 const char* name, I32 namlen)
5301 if (SvTYPE(sv) < SVt_PVMG) {
5302 SvUPGRADE(sv, SVt_PVMG);
5304 Newz(702,mg, 1, MAGIC);
5305 mg->mg_moremagic = SvMAGIC(sv);
5306 SvMAGIC_set(sv, mg);
5308 /* Sometimes a magic contains a reference loop, where the sv and
5309 object refer to each other. To prevent a reference loop that
5310 would prevent such objects being freed, we look for such loops
5311 and if we find one we avoid incrementing the object refcount.
5313 Note we cannot do this to avoid self-tie loops as intervening RV must
5314 have its REFCNT incremented to keep it in existence.
5317 if (!obj || obj == sv ||
5318 how == PERL_MAGIC_arylen ||
5319 how == PERL_MAGIC_qr ||
5320 how == PERL_MAGIC_symtab ||
5321 (SvTYPE(obj) == SVt_PVGV &&
5322 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5323 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5324 GvFORM(obj) == (CV*)sv)))
5329 mg->mg_obj = SvREFCNT_inc(obj);
5330 mg->mg_flags |= MGf_REFCOUNTED;
5333 /* Normal self-ties simply pass a null object, and instead of
5334 using mg_obj directly, use the SvTIED_obj macro to produce a
5335 new RV as needed. For glob "self-ties", we are tieing the PVIO
5336 with an RV obj pointing to the glob containing the PVIO. In
5337 this case, to avoid a reference loop, we need to weaken the
5341 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5342 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5348 mg->mg_len = namlen;
5351 mg->mg_ptr = savepvn(name, namlen);
5352 else if (namlen == HEf_SVKEY)
5353 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5355 mg->mg_ptr = (char *) name;
5357 mg->mg_virtual = vtable;
5361 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5366 =for apidoc sv_magic
5368 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5369 then adds a new magic item of type C<how> to the head of the magic list.
5371 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5372 handling of the C<name> and C<namlen> arguments.
5374 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5375 to add more than one instance of the same 'how'.
5381 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5383 const MGVTBL *vtable = 0;
5386 #ifdef PERL_OLD_COPY_ON_WRITE
5388 sv_force_normal_flags(sv, 0);
5390 if (SvREADONLY(sv)) {
5392 && how != PERL_MAGIC_regex_global
5393 && how != PERL_MAGIC_bm
5394 && how != PERL_MAGIC_fm
5395 && how != PERL_MAGIC_sv
5396 && how != PERL_MAGIC_backref
5399 Perl_croak(aTHX_ PL_no_modify);
5402 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5403 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5404 /* sv_magic() refuses to add a magic of the same 'how' as an
5407 if (how == PERL_MAGIC_taint)
5415 vtable = &PL_vtbl_sv;
5417 case PERL_MAGIC_overload:
5418 vtable = &PL_vtbl_amagic;
5420 case PERL_MAGIC_overload_elem:
5421 vtable = &PL_vtbl_amagicelem;
5423 case PERL_MAGIC_overload_table:
5424 vtable = &PL_vtbl_ovrld;
5427 vtable = &PL_vtbl_bm;
5429 case PERL_MAGIC_regdata:
5430 vtable = &PL_vtbl_regdata;
5432 case PERL_MAGIC_regdatum:
5433 vtable = &PL_vtbl_regdatum;
5435 case PERL_MAGIC_env:
5436 vtable = &PL_vtbl_env;
5439 vtable = &PL_vtbl_fm;
5441 case PERL_MAGIC_envelem:
5442 vtable = &PL_vtbl_envelem;
5444 case PERL_MAGIC_regex_global:
5445 vtable = &PL_vtbl_mglob;
5447 case PERL_MAGIC_isa:
5448 vtable = &PL_vtbl_isa;
5450 case PERL_MAGIC_isaelem:
5451 vtable = &PL_vtbl_isaelem;
5453 case PERL_MAGIC_nkeys:
5454 vtable = &PL_vtbl_nkeys;
5456 case PERL_MAGIC_dbfile:
5459 case PERL_MAGIC_dbline:
5460 vtable = &PL_vtbl_dbline;
5462 #ifdef USE_LOCALE_COLLATE
5463 case PERL_MAGIC_collxfrm:
5464 vtable = &PL_vtbl_collxfrm;
5466 #endif /* USE_LOCALE_COLLATE */
5467 case PERL_MAGIC_tied:
5468 vtable = &PL_vtbl_pack;
5470 case PERL_MAGIC_tiedelem:
5471 case PERL_MAGIC_tiedscalar:
5472 vtable = &PL_vtbl_packelem;
5475 vtable = &PL_vtbl_regexp;
5477 case PERL_MAGIC_sig:
5478 vtable = &PL_vtbl_sig;
5480 case PERL_MAGIC_sigelem:
5481 vtable = &PL_vtbl_sigelem;
5483 case PERL_MAGIC_taint:
5484 vtable = &PL_vtbl_taint;
5486 case PERL_MAGIC_uvar:
5487 vtable = &PL_vtbl_uvar;
5489 case PERL_MAGIC_vec:
5490 vtable = &PL_vtbl_vec;
5492 case PERL_MAGIC_arylen_p:
5493 case PERL_MAGIC_rhash:
5494 case PERL_MAGIC_symtab:
5495 case PERL_MAGIC_vstring:
5498 case PERL_MAGIC_utf8:
5499 vtable = &PL_vtbl_utf8;
5501 case PERL_MAGIC_substr:
5502 vtable = &PL_vtbl_substr;
5504 case PERL_MAGIC_defelem:
5505 vtable = &PL_vtbl_defelem;
5507 case PERL_MAGIC_glob:
5508 vtable = &PL_vtbl_glob;
5510 case PERL_MAGIC_arylen:
5511 vtable = &PL_vtbl_arylen;
5513 case PERL_MAGIC_pos:
5514 vtable = &PL_vtbl_pos;
5516 case PERL_MAGIC_backref:
5517 vtable = &PL_vtbl_backref;
5519 case PERL_MAGIC_ext:
5520 /* Reserved for use by extensions not perl internals. */
5521 /* Useful for attaching extension internal data to perl vars. */
5522 /* Note that multiple extensions may clash if magical scalars */
5523 /* etc holding private data from one are passed to another. */
5526 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5529 /* Rest of work is done else where */
5530 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5533 case PERL_MAGIC_taint:
5536 case PERL_MAGIC_ext:
5537 case PERL_MAGIC_dbfile:
5544 =for apidoc sv_unmagic
5546 Removes all magic of type C<type> from an SV.
5552 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5556 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5559 for (mg = *mgp; mg; mg = *mgp) {
5560 if (mg->mg_type == type) {
5561 const MGVTBL* const vtbl = mg->mg_virtual;
5562 *mgp = mg->mg_moremagic;
5563 if (vtbl && vtbl->svt_free)
5564 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5565 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5567 Safefree(mg->mg_ptr);
5568 else if (mg->mg_len == HEf_SVKEY)
5569 SvREFCNT_dec((SV*)mg->mg_ptr);
5570 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5571 Safefree(mg->mg_ptr);
5573 if (mg->mg_flags & MGf_REFCOUNTED)
5574 SvREFCNT_dec(mg->mg_obj);
5578 mgp = &mg->mg_moremagic;
5582 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5589 =for apidoc sv_rvweaken
5591 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5592 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5593 push a back-reference to this RV onto the array of backreferences
5594 associated with that magic.
5600 Perl_sv_rvweaken(pTHX_ SV *sv)
5603 if (!SvOK(sv)) /* let undefs pass */
5606 Perl_croak(aTHX_ "Can't weaken a nonreference");
5607 else if (SvWEAKREF(sv)) {
5608 if (ckWARN(WARN_MISC))
5609 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5613 sv_add_backref(tsv, sv);
5619 /* Give tsv backref magic if it hasn't already got it, then push a
5620 * back-reference to sv onto the array associated with the backref magic.
5624 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5628 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5629 av = (AV*)mg->mg_obj;
5632 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5633 /* av now has a refcnt of 2, which avoids it getting freed
5634 * before us during global cleanup. The extra ref is removed
5635 * by magic_killbackrefs() when tsv is being freed */
5637 if (AvFILLp(av) >= AvMAX(av)) {
5639 SV **svp = AvARRAY(av);
5640 for (i = AvFILLp(av); i >= 0; i--)
5642 svp[i] = sv; /* reuse the slot */
5645 av_extend(av, AvFILLp(av)+1);
5647 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5650 /* delete a back-reference to ourselves from the backref magic associated
5651 * with the SV we point to.
5655 S_sv_del_backref(pTHX_ SV *sv)
5662 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5663 Perl_croak(aTHX_ "panic: del_backref");
5664 av = (AV *)mg->mg_obj;
5666 for (i = AvFILLp(av); i >= 0; i--)
5667 if (svp[i] == sv) svp[i] = Nullsv;
5671 =for apidoc sv_insert
5673 Inserts a string at the specified offset/length within the SV. Similar to
5674 the Perl substr() function.
5680 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5684 register char *midend;
5685 register char *bigend;
5691 Perl_croak(aTHX_ "Can't modify non-existent substring");
5692 SvPV_force(bigstr, curlen);
5693 (void)SvPOK_only_UTF8(bigstr);
5694 if (offset + len > curlen) {
5695 SvGROW(bigstr, offset+len+1);
5696 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5697 SvCUR_set(bigstr, offset+len);
5701 i = littlelen - len;
5702 if (i > 0) { /* string might grow */
5703 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5704 mid = big + offset + len;
5705 midend = bigend = big + SvCUR(bigstr);
5708 while (midend > mid) /* shove everything down */
5709 *--bigend = *--midend;
5710 Move(little,big+offset,littlelen,char);
5711 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5716 Move(little,SvPVX(bigstr)+offset,len,char);
5721 big = SvPVX(bigstr);
5724 bigend = big + SvCUR(bigstr);
5726 if (midend > bigend)
5727 Perl_croak(aTHX_ "panic: sv_insert");
5729 if (mid - big > bigend - midend) { /* faster to shorten from end */
5731 Move(little, mid, littlelen,char);
5734 i = bigend - midend;
5736 Move(midend, mid, i,char);
5740 SvCUR_set(bigstr, mid - big);
5743 else if ((i = mid - big)) { /* faster from front */
5744 midend -= littlelen;
5746 sv_chop(bigstr,midend-i);
5751 Move(little, mid, littlelen,char);
5753 else if (littlelen) {
5754 midend -= littlelen;
5755 sv_chop(bigstr,midend);
5756 Move(little,midend,littlelen,char);
5759 sv_chop(bigstr,midend);
5765 =for apidoc sv_replace
5767 Make the first argument a copy of the second, then delete the original.
5768 The target SV physically takes over ownership of the body of the source SV
5769 and inherits its flags; however, the target keeps any magic it owns,
5770 and any magic in the source is discarded.
5771 Note that this is a rather specialist SV copying operation; most of the
5772 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5778 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5780 const U32 refcnt = SvREFCNT(sv);
5781 SV_CHECK_THINKFIRST_COW_DROP(sv);
5782 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5783 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5784 if (SvMAGICAL(sv)) {
5788 sv_upgrade(nsv, SVt_PVMG);
5789 SvMAGIC_set(nsv, SvMAGIC(sv));
5790 SvFLAGS(nsv) |= SvMAGICAL(sv);
5792 SvMAGIC_set(sv, NULL);
5796 assert(!SvREFCNT(sv));
5797 #ifdef DEBUG_LEAKING_SCALARS
5798 sv->sv_flags = nsv->sv_flags;
5799 sv->sv_any = nsv->sv_any;
5800 sv->sv_refcnt = nsv->sv_refcnt;
5801 sv->sv_u = nsv->sv_u;
5803 StructCopy(nsv,sv,SV);
5805 /* Currently could join these into one piece of pointer arithmetic, but
5806 it would be unclear. */
5807 if(SvTYPE(sv) == SVt_IV)
5809 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5810 else if (SvTYPE(sv) == SVt_RV) {
5811 SvANY(sv) = &sv->sv_u.svu_rv;
5815 #ifdef PERL_OLD_COPY_ON_WRITE
5816 if (SvIsCOW_normal(nsv)) {
5817 /* We need to follow the pointers around the loop to make the
5818 previous SV point to sv, rather than nsv. */
5821 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5824 assert(SvPVX_const(current) == SvPVX_const(nsv));
5826 /* Make the SV before us point to the SV after us. */
5828 PerlIO_printf(Perl_debug_log, "previous is\n");
5830 PerlIO_printf(Perl_debug_log,
5831 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5832 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5834 SV_COW_NEXT_SV_SET(current, sv);
5837 SvREFCNT(sv) = refcnt;
5838 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5844 =for apidoc sv_clear
5846 Clear an SV: call any destructors, free up any memory used by the body,
5847 and free the body itself. The SV's head is I<not> freed, although
5848 its type is set to all 1's so that it won't inadvertently be assumed
5849 to be live during global destruction etc.
5850 This function should only be called when REFCNT is zero. Most of the time
5851 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5858 Perl_sv_clear(pTHX_ register SV *sv)
5863 assert(SvREFCNT(sv) == 0);
5866 if (PL_defstash) { /* Still have a symbol table? */
5870 stash = SvSTASH(sv);
5871 destructor = StashHANDLER(stash,DESTROY);
5873 SV* tmpref = newRV(sv);
5874 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5876 PUSHSTACKi(PERLSI_DESTROY);
5881 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5887 if(SvREFCNT(tmpref) < 2) {
5888 /* tmpref is not kept alive! */
5890 SvRV_set(tmpref, NULL);
5893 SvREFCNT_dec(tmpref);
5895 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5899 if (PL_in_clean_objs)
5900 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5902 /* DESTROY gave object new lease on life */
5908 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5909 SvOBJECT_off(sv); /* Curse the object. */
5910 if (SvTYPE(sv) != SVt_PVIO)
5911 --PL_sv_objcount; /* XXX Might want something more general */
5914 if (SvTYPE(sv) >= SVt_PVMG) {
5917 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5918 SvREFCNT_dec(SvSTASH(sv));
5921 switch (SvTYPE(sv)) {
5924 IoIFP(sv) != PerlIO_stdin() &&
5925 IoIFP(sv) != PerlIO_stdout() &&
5926 IoIFP(sv) != PerlIO_stderr())
5928 io_close((IO*)sv, FALSE);
5930 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5931 PerlDir_close(IoDIRP(sv));
5932 IoDIRP(sv) = (DIR*)NULL;
5933 Safefree(IoTOP_NAME(sv));
5934 Safefree(IoFMT_NAME(sv));
5935 Safefree(IoBOTTOM_NAME(sv));
5950 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5951 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5952 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5953 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5955 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5956 SvREFCNT_dec(LvTARG(sv));
5960 Safefree(GvNAME(sv));
5961 /* cannot decrease stash refcount yet, as we might recursively delete
5962 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5963 of stash until current sv is completely gone.
5964 -- JohnPC, 27 Mar 1998 */
5965 stash = GvSTASH(sv);
5971 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5973 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5974 /* Don't even bother with turning off the OOK flag. */
5983 SvREFCNT_dec(SvRV(sv));
5985 #ifdef PERL_OLD_COPY_ON_WRITE
5986 else if (SvPVX_const(sv)) {
5988 /* I believe I need to grab the global SV mutex here and
5989 then recheck the COW status. */
5991 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5994 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5995 SV_COW_NEXT_SV(sv));
5996 /* And drop it here. */
5998 } else if (SvLEN(sv)) {
5999 Safefree(SvPVX_const(sv));
6003 else if (SvPVX_const(sv) && SvLEN(sv))
6004 Safefree(SvPVX_const(sv));
6005 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6006 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6019 switch (SvTYPE(sv)) {
6033 del_XPVIV(SvANY(sv));
6036 del_XPVNV(SvANY(sv));
6039 del_XPVMG(SvANY(sv));
6042 del_XPVLV(SvANY(sv));
6045 del_XPVAV(SvANY(sv));
6048 del_XPVHV(SvANY(sv));
6051 del_XPVCV(SvANY(sv));
6054 del_XPVGV(SvANY(sv));
6055 /* code duplication for increased performance. */
6056 SvFLAGS(sv) &= SVf_BREAK;
6057 SvFLAGS(sv) |= SVTYPEMASK;
6058 /* decrease refcount of the stash that owns this GV, if any */
6060 SvREFCNT_dec(stash);
6061 return; /* not break, SvFLAGS reset already happened */
6063 del_XPVBM(SvANY(sv));
6066 del_XPVFM(SvANY(sv));
6069 del_XPVIO(SvANY(sv));
6072 SvFLAGS(sv) &= SVf_BREAK;
6073 SvFLAGS(sv) |= SVTYPEMASK;
6077 =for apidoc sv_newref
6079 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6086 Perl_sv_newref(pTHX_ SV *sv)
6096 Decrement an SV's reference count, and if it drops to zero, call
6097 C<sv_clear> to invoke destructors and free up any memory used by
6098 the body; finally, deallocate the SV's head itself.
6099 Normally called via a wrapper macro C<SvREFCNT_dec>.
6105 Perl_sv_free(pTHX_ SV *sv)
6110 if (SvREFCNT(sv) == 0) {
6111 if (SvFLAGS(sv) & SVf_BREAK)
6112 /* this SV's refcnt has been artificially decremented to
6113 * trigger cleanup */
6115 if (PL_in_clean_all) /* All is fair */
6117 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6118 /* make sure SvREFCNT(sv)==0 happens very seldom */
6119 SvREFCNT(sv) = (~(U32)0)/2;
6122 if (ckWARN_d(WARN_INTERNAL))
6123 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6124 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6125 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6128 if (--(SvREFCNT(sv)) > 0)
6130 Perl_sv_free2(aTHX_ sv);
6134 Perl_sv_free2(pTHX_ SV *sv)
6139 if (ckWARN_d(WARN_DEBUGGING))
6140 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6141 "Attempt to free temp prematurely: SV 0x%"UVxf
6142 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6146 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6147 /* make sure SvREFCNT(sv)==0 happens very seldom */
6148 SvREFCNT(sv) = (~(U32)0)/2;
6159 Returns the length of the string in the SV. Handles magic and type
6160 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6166 Perl_sv_len(pTHX_ register SV *sv)
6174 len = mg_length(sv);
6176 (void)SvPV_const(sv, len);
6181 =for apidoc sv_len_utf8
6183 Returns the number of characters in the string in an SV, counting wide
6184 UTF-8 bytes as a single character. Handles magic and type coercion.
6190 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6191 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6192 * (Note that the mg_len is not the length of the mg_ptr field.)
6197 Perl_sv_len_utf8(pTHX_ register SV *sv)
6203 return mg_length(sv);
6207 const U8 *s = (U8*)SvPV_const(sv, len);
6208 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6210 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6212 #ifdef PERL_UTF8_CACHE_ASSERT
6213 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6217 ulen = Perl_utf8_length(aTHX_ s, s + len);
6218 if (!mg && !SvREADONLY(sv)) {
6219 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6220 mg = mg_find(sv, PERL_MAGIC_utf8);
6230 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6231 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6232 * between UTF-8 and byte offsets. There are two (substr offset and substr
6233 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6234 * and byte offset) cache positions.
6236 * The mg_len field is used by sv_len_utf8(), see its comments.
6237 * Note that the mg_len is not the length of the mg_ptr field.
6241 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
6242 I32 offsetp, const U8 *s, const U8 *start)
6246 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6248 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6252 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6254 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6255 (*mgp)->mg_ptr = (char *) *cachep;
6259 (*cachep)[i] = offsetp;
6260 (*cachep)[i+1] = s - start;
6268 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6269 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6270 * between UTF-8 and byte offsets. See also the comments of
6271 * S_utf8_mg_pos_init().
6275 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
6279 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6281 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6282 if (*mgp && (*mgp)->mg_ptr) {
6283 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6284 ASSERT_UTF8_CACHE(*cachep);
6285 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6287 else { /* We will skip to the right spot. */
6292 /* The assumption is that going backward is half
6293 * the speed of going forward (that's where the
6294 * 2 * backw in the below comes from). (The real
6295 * figure of course depends on the UTF-8 data.) */
6297 if ((*cachep)[i] > (STRLEN)uoff) {
6299 backw = (*cachep)[i] - (STRLEN)uoff;
6301 if (forw < 2 * backw)
6304 p = start + (*cachep)[i+1];
6306 /* Try this only for the substr offset (i == 0),
6307 * not for the substr length (i == 2). */
6308 else if (i == 0) { /* (*cachep)[i] < uoff */
6309 const STRLEN ulen = sv_len_utf8(sv);
6311 if ((STRLEN)uoff < ulen) {
6312 forw = (STRLEN)uoff - (*cachep)[i];
6313 backw = ulen - (STRLEN)uoff;
6315 if (forw < 2 * backw)
6316 p = start + (*cachep)[i+1];
6321 /* If the string is not long enough for uoff,
6322 * we could extend it, but not at this low a level. */
6326 if (forw < 2 * backw) {
6333 while (UTF8_IS_CONTINUATION(*p))
6338 /* Update the cache. */
6339 (*cachep)[i] = (STRLEN)uoff;
6340 (*cachep)[i+1] = p - start;
6342 /* Drop the stale "length" cache */
6351 if (found) { /* Setup the return values. */
6352 *offsetp = (*cachep)[i+1];
6353 *sp = start + *offsetp;
6356 *offsetp = send - start;
6358 else if (*sp < start) {
6364 #ifdef PERL_UTF8_CACHE_ASSERT
6369 while (n-- && s < send)
6373 assert(*offsetp == s - start);
6374 assert((*cachep)[0] == (STRLEN)uoff);
6375 assert((*cachep)[1] == *offsetp);
6377 ASSERT_UTF8_CACHE(*cachep);
6386 =for apidoc sv_pos_u2b
6388 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6389 the start of the string, to a count of the equivalent number of bytes; if
6390 lenp is non-zero, it does the same to lenp, but this time starting from
6391 the offset, rather than from the start of the string. Handles magic and
6398 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6399 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6400 * byte offsets. See also the comments of S_utf8_mg_pos().
6405 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6413 start = (U8*)SvPV_const(sv, len);
6417 const U8 *s = start;
6418 I32 uoffset = *offsetp;
6419 const U8 *send = s + len;
6423 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6425 if (!found && uoffset > 0) {
6426 while (s < send && uoffset--)
6430 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6432 *offsetp = s - start;
6437 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6441 if (!found && *lenp > 0) {
6444 while (s < send && ulen--)
6448 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6452 ASSERT_UTF8_CACHE(cache);
6464 =for apidoc sv_pos_b2u
6466 Converts the value pointed to by offsetp from a count of bytes from the
6467 start of the string, to a count of the equivalent number of UTF-8 chars.
6468 Handles magic and type coercion.
6474 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6475 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6476 * byte offsets. See also the comments of S_utf8_mg_pos().
6481 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6489 s = (const U8*)SvPV_const(sv, len);
6490 if ((I32)len < *offsetp)
6491 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6493 const U8* send = s + *offsetp;
6495 STRLEN *cache = NULL;
6499 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6500 mg = mg_find(sv, PERL_MAGIC_utf8);
6501 if (mg && mg->mg_ptr) {
6502 cache = (STRLEN *) mg->mg_ptr;
6503 if (cache[1] == (STRLEN)*offsetp) {
6504 /* An exact match. */
6505 *offsetp = cache[0];
6509 else if (cache[1] < (STRLEN)*offsetp) {
6510 /* We already know part of the way. */
6513 /* Let the below loop do the rest. */
6515 else { /* cache[1] > *offsetp */
6516 /* We already know all of the way, now we may
6517 * be able to walk back. The same assumption
6518 * is made as in S_utf8_mg_pos(), namely that
6519 * walking backward is twice slower than
6520 * walking forward. */
6521 STRLEN forw = *offsetp;
6522 STRLEN backw = cache[1] - *offsetp;
6524 if (!(forw < 2 * backw)) {
6525 const U8 *p = s + cache[1];
6532 while (UTF8_IS_CONTINUATION(*p)) {
6540 *offsetp = cache[0];
6542 /* Drop the stale "length" cache */
6550 ASSERT_UTF8_CACHE(cache);
6556 /* Call utf8n_to_uvchr() to validate the sequence
6557 * (unless a simple non-UTF character) */
6558 if (!UTF8_IS_INVARIANT(*s))
6559 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6568 if (!SvREADONLY(sv)) {
6570 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6571 mg = mg_find(sv, PERL_MAGIC_utf8);
6576 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6577 mg->mg_ptr = (char *) cache;
6582 cache[1] = *offsetp;
6583 /* Drop the stale "length" cache */
6596 Returns a boolean indicating whether the strings in the two SVs are
6597 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6598 coerce its args to strings if necessary.
6604 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6612 SV* svrecode = Nullsv;
6619 pv1 = SvPV_const(sv1, cur1);
6626 pv2 = SvPV_const(sv2, cur2);
6628 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6629 /* Differing utf8ness.
6630 * Do not UTF8size the comparands as a side-effect. */
6633 svrecode = newSVpvn(pv2, cur2);
6634 sv_recode_to_utf8(svrecode, PL_encoding);
6635 pv2 = SvPV_const(svrecode, cur2);
6638 svrecode = newSVpvn(pv1, cur1);
6639 sv_recode_to_utf8(svrecode, PL_encoding);
6640 pv1 = SvPV_const(svrecode, cur1);
6642 /* Now both are in UTF-8. */
6644 SvREFCNT_dec(svrecode);
6649 bool is_utf8 = TRUE;
6652 /* sv1 is the UTF-8 one,
6653 * if is equal it must be downgrade-able */
6654 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6660 /* sv2 is the UTF-8 one,
6661 * if is equal it must be downgrade-able */
6662 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6668 /* Downgrade not possible - cannot be eq */
6676 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6679 SvREFCNT_dec(svrecode);
6690 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6691 string in C<sv1> is less than, equal to, or greater than the string in
6692 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6693 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6699 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6702 const char *pv1, *pv2;
6705 SV *svrecode = Nullsv;
6712 pv1 = SvPV_const(sv1, cur1);
6719 pv2 = SvPV_const(sv2, cur2);
6721 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6722 /* Differing utf8ness.
6723 * Do not UTF8size the comparands as a side-effect. */
6726 svrecode = newSVpvn(pv2, cur2);
6727 sv_recode_to_utf8(svrecode, PL_encoding);
6728 pv2 = SvPV_const(svrecode, cur2);
6731 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6736 svrecode = newSVpvn(pv1, cur1);
6737 sv_recode_to_utf8(svrecode, PL_encoding);
6738 pv1 = SvPV_const(svrecode, cur1);
6741 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6747 cmp = cur2 ? -1 : 0;
6751 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6754 cmp = retval < 0 ? -1 : 1;
6755 } else if (cur1 == cur2) {
6758 cmp = cur1 < cur2 ? -1 : 1;
6763 SvREFCNT_dec(svrecode);
6772 =for apidoc sv_cmp_locale
6774 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6775 'use bytes' aware, handles get magic, and will coerce its args to strings
6776 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6782 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6784 #ifdef USE_LOCALE_COLLATE
6790 if (PL_collation_standard)
6794 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6796 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6798 if (!pv1 || !len1) {
6809 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6812 return retval < 0 ? -1 : 1;
6815 * When the result of collation is equality, that doesn't mean
6816 * that there are no differences -- some locales exclude some
6817 * characters from consideration. So to avoid false equalities,
6818 * we use the raw string as a tiebreaker.
6824 #endif /* USE_LOCALE_COLLATE */
6826 return sv_cmp(sv1, sv2);
6830 #ifdef USE_LOCALE_COLLATE
6833 =for apidoc sv_collxfrm
6835 Add Collate Transform magic to an SV if it doesn't already have it.
6837 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6838 scalar data of the variable, but transformed to such a format that a normal
6839 memory comparison can be used to compare the data according to the locale
6846 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6850 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6851 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6857 Safefree(mg->mg_ptr);
6858 s = SvPV_const(sv, len);
6859 if ((xf = mem_collxfrm(s, len, &xlen))) {
6860 if (SvREADONLY(sv)) {
6863 return xf + sizeof(PL_collation_ix);
6866 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6867 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6880 if (mg && mg->mg_ptr) {
6882 return mg->mg_ptr + sizeof(PL_collation_ix);
6890 #endif /* USE_LOCALE_COLLATE */
6895 Get a line from the filehandle and store it into the SV, optionally
6896 appending to the currently-stored string.
6902 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6906 register STDCHAR rslast;
6907 register STDCHAR *bp;
6913 if (SvTHINKFIRST(sv))
6914 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6915 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6917 However, perlbench says it's slower, because the existing swipe code
6918 is faster than copy on write.
6919 Swings and roundabouts. */
6920 SvUPGRADE(sv, SVt_PV);
6925 if (PerlIO_isutf8(fp)) {
6927 sv_utf8_upgrade_nomg(sv);
6928 sv_pos_u2b(sv,&append,0);
6930 } else if (SvUTF8(sv)) {
6931 SV *tsv = NEWSV(0,0);
6932 sv_gets(tsv, fp, 0);
6933 sv_utf8_upgrade_nomg(tsv);
6934 SvCUR_set(sv,append);
6937 goto return_string_or_null;
6942 if (PerlIO_isutf8(fp))
6945 if (IN_PERL_COMPILETIME) {
6946 /* we always read code in line mode */
6950 else if (RsSNARF(PL_rs)) {
6951 /* If it is a regular disk file use size from stat() as estimate
6952 of amount we are going to read - may result in malloc-ing
6953 more memory than we realy need if layers bellow reduce
6954 size we read (e.g. CRLF or a gzip layer)
6957 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6958 const Off_t offset = PerlIO_tell(fp);
6959 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6960 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6966 else if (RsRECORD(PL_rs)) {
6970 /* Grab the size of the record we're getting */
6971 recsize = SvIV(SvRV(PL_rs));
6972 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6975 /* VMS wants read instead of fread, because fread doesn't respect */
6976 /* RMS record boundaries. This is not necessarily a good thing to be */
6977 /* doing, but we've got no other real choice - except avoid stdio
6978 as implementation - perhaps write a :vms layer ?
6980 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6982 bytesread = PerlIO_read(fp, buffer, recsize);
6986 SvCUR_set(sv, bytesread += append);
6987 buffer[bytesread] = '\0';
6988 goto return_string_or_null;
6990 else if (RsPARA(PL_rs)) {
6996 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6997 if (PerlIO_isutf8(fp)) {
6998 rsptr = SvPVutf8(PL_rs, rslen);
7001 if (SvUTF8(PL_rs)) {
7002 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7003 Perl_croak(aTHX_ "Wide character in $/");
7006 rsptr = SvPV_const(PL_rs, rslen);
7010 rslast = rslen ? rsptr[rslen - 1] : '\0';
7012 if (rspara) { /* have to do this both before and after */
7013 do { /* to make sure file boundaries work right */
7016 i = PerlIO_getc(fp);
7020 PerlIO_ungetc(fp,i);
7026 /* See if we know enough about I/O mechanism to cheat it ! */
7028 /* This used to be #ifdef test - it is made run-time test for ease
7029 of abstracting out stdio interface. One call should be cheap
7030 enough here - and may even be a macro allowing compile
7034 if (PerlIO_fast_gets(fp)) {
7037 * We're going to steal some values from the stdio struct
7038 * and put EVERYTHING in the innermost loop into registers.
7040 register STDCHAR *ptr;
7044 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7045 /* An ungetc()d char is handled separately from the regular
7046 * buffer, so we getc() it back out and stuff it in the buffer.
7048 i = PerlIO_getc(fp);
7049 if (i == EOF) return 0;
7050 *(--((*fp)->_ptr)) = (unsigned char) i;
7054 /* Here is some breathtakingly efficient cheating */
7056 cnt = PerlIO_get_cnt(fp); /* get count into register */
7057 /* make sure we have the room */
7058 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7059 /* Not room for all of it
7060 if we are looking for a separator and room for some
7062 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7063 /* just process what we have room for */
7064 shortbuffered = cnt - SvLEN(sv) + append + 1;
7065 cnt -= shortbuffered;
7069 /* remember that cnt can be negative */
7070 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7075 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7076 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7077 DEBUG_P(PerlIO_printf(Perl_debug_log,
7078 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7079 DEBUG_P(PerlIO_printf(Perl_debug_log,
7080 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7081 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7082 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7087 while (cnt > 0) { /* this | eat */
7089 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7090 goto thats_all_folks; /* screams | sed :-) */
7094 Copy(ptr, bp, cnt, char); /* this | eat */
7095 bp += cnt; /* screams | dust */
7096 ptr += cnt; /* louder | sed :-) */
7101 if (shortbuffered) { /* oh well, must extend */
7102 cnt = shortbuffered;
7104 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7106 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7107 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7111 DEBUG_P(PerlIO_printf(Perl_debug_log,
7112 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7113 PTR2UV(ptr),(long)cnt));
7114 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7116 DEBUG_P(PerlIO_printf(Perl_debug_log,
7117 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7118 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7119 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7121 /* This used to call 'filbuf' in stdio form, but as that behaves like
7122 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7123 another abstraction. */
7124 i = PerlIO_getc(fp); /* get more characters */
7126 DEBUG_P(PerlIO_printf(Perl_debug_log,
7127 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7128 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7129 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7131 cnt = PerlIO_get_cnt(fp);
7132 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7133 DEBUG_P(PerlIO_printf(Perl_debug_log,
7134 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7136 if (i == EOF) /* all done for ever? */
7137 goto thats_really_all_folks;
7139 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7141 SvGROW(sv, bpx + cnt + 2);
7142 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7144 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7146 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7147 goto thats_all_folks;
7151 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7152 memNE((char*)bp - rslen, rsptr, rslen))
7153 goto screamer; /* go back to the fray */
7154 thats_really_all_folks:
7156 cnt += shortbuffered;
7157 DEBUG_P(PerlIO_printf(Perl_debug_log,
7158 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7159 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7160 DEBUG_P(PerlIO_printf(Perl_debug_log,
7161 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7162 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7163 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7165 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7166 DEBUG_P(PerlIO_printf(Perl_debug_log,
7167 "Screamer: done, len=%ld, string=|%.*s|\n",
7168 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7172 /*The big, slow, and stupid way. */
7173 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7175 New(0, buf, 8192, STDCHAR);
7183 const register STDCHAR *bpe = buf + sizeof(buf);
7185 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7186 ; /* keep reading */
7190 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7191 /* Accomodate broken VAXC compiler, which applies U8 cast to
7192 * both args of ?: operator, causing EOF to change into 255
7195 i = (U8)buf[cnt - 1];
7201 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7203 sv_catpvn(sv, (char *) buf, cnt);
7205 sv_setpvn(sv, (char *) buf, cnt);
7207 if (i != EOF && /* joy */
7209 SvCUR(sv) < rslen ||
7210 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7214 * If we're reading from a TTY and we get a short read,
7215 * indicating that the user hit his EOF character, we need
7216 * to notice it now, because if we try to read from the TTY
7217 * again, the EOF condition will disappear.
7219 * The comparison of cnt to sizeof(buf) is an optimization
7220 * that prevents unnecessary calls to feof().
7224 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7228 #ifdef USE_HEAP_INSTEAD_OF_STACK
7233 if (rspara) { /* have to do this both before and after */
7234 while (i != EOF) { /* to make sure file boundaries work right */
7235 i = PerlIO_getc(fp);
7237 PerlIO_ungetc(fp,i);
7243 return_string_or_null:
7244 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7250 Auto-increment of the value in the SV, doing string to numeric conversion
7251 if necessary. Handles 'get' magic.
7257 Perl_sv_inc(pTHX_ register SV *sv)
7266 if (SvTHINKFIRST(sv)) {
7268 sv_force_normal_flags(sv, 0);
7269 if (SvREADONLY(sv)) {
7270 if (IN_PERL_RUNTIME)
7271 Perl_croak(aTHX_ PL_no_modify);
7275 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7277 i = PTR2IV(SvRV(sv));
7282 flags = SvFLAGS(sv);
7283 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7284 /* It's (privately or publicly) a float, but not tested as an
7285 integer, so test it to see. */
7287 flags = SvFLAGS(sv);
7289 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7290 /* It's publicly an integer, or privately an integer-not-float */
7291 #ifdef PERL_PRESERVE_IVUV
7295 if (SvUVX(sv) == UV_MAX)
7296 sv_setnv(sv, UV_MAX_P1);
7298 (void)SvIOK_only_UV(sv);
7299 SvUV_set(sv, SvUVX(sv) + 1);
7301 if (SvIVX(sv) == IV_MAX)
7302 sv_setuv(sv, (UV)IV_MAX + 1);
7304 (void)SvIOK_only(sv);
7305 SvIV_set(sv, SvIVX(sv) + 1);
7310 if (flags & SVp_NOK) {
7311 (void)SvNOK_only(sv);
7312 SvNV_set(sv, SvNVX(sv) + 1.0);
7316 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7317 if ((flags & SVTYPEMASK) < SVt_PVIV)
7318 sv_upgrade(sv, SVt_IV);
7319 (void)SvIOK_only(sv);
7324 while (isALPHA(*d)) d++;
7325 while (isDIGIT(*d)) d++;
7327 #ifdef PERL_PRESERVE_IVUV
7328 /* Got to punt this as an integer if needs be, but we don't issue
7329 warnings. Probably ought to make the sv_iv_please() that does
7330 the conversion if possible, and silently. */
7331 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7332 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7333 /* Need to try really hard to see if it's an integer.
7334 9.22337203685478e+18 is an integer.
7335 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7336 so $a="9.22337203685478e+18"; $a+0; $a++
7337 needs to be the same as $a="9.22337203685478e+18"; $a++
7344 /* sv_2iv *should* have made this an NV */
7345 if (flags & SVp_NOK) {
7346 (void)SvNOK_only(sv);
7347 SvNV_set(sv, SvNVX(sv) + 1.0);
7350 /* I don't think we can get here. Maybe I should assert this
7351 And if we do get here I suspect that sv_setnv will croak. NWC
7353 #if defined(USE_LONG_DOUBLE)
7354 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",
7355 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7357 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7358 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7361 #endif /* PERL_PRESERVE_IVUV */
7362 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7366 while (d >= SvPVX_const(sv)) {
7374 /* MKS: The original code here died if letters weren't consecutive.
7375 * at least it didn't have to worry about non-C locales. The
7376 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7377 * arranged in order (although not consecutively) and that only
7378 * [A-Za-z] are accepted by isALPHA in the C locale.
7380 if (*d != 'z' && *d != 'Z') {
7381 do { ++*d; } while (!isALPHA(*d));
7384 *(d--) -= 'z' - 'a';
7389 *(d--) -= 'z' - 'a' + 1;
7393 /* oh,oh, the number grew */
7394 SvGROW(sv, SvCUR(sv) + 2);
7395 SvCUR_set(sv, SvCUR(sv) + 1);
7396 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7407 Auto-decrement of the value in the SV, doing string to numeric conversion
7408 if necessary. Handles 'get' magic.
7414 Perl_sv_dec(pTHX_ register SV *sv)
7422 if (SvTHINKFIRST(sv)) {
7424 sv_force_normal_flags(sv, 0);
7425 if (SvREADONLY(sv)) {
7426 if (IN_PERL_RUNTIME)
7427 Perl_croak(aTHX_ PL_no_modify);
7431 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7433 i = PTR2IV(SvRV(sv));
7438 /* Unlike sv_inc we don't have to worry about string-never-numbers
7439 and keeping them magic. But we mustn't warn on punting */
7440 flags = SvFLAGS(sv);
7441 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7442 /* It's publicly an integer, or privately an integer-not-float */
7443 #ifdef PERL_PRESERVE_IVUV
7447 if (SvUVX(sv) == 0) {
7448 (void)SvIOK_only(sv);
7452 (void)SvIOK_only_UV(sv);
7453 SvUV_set(sv, SvUVX(sv) + 1);
7456 if (SvIVX(sv) == IV_MIN)
7457 sv_setnv(sv, (NV)IV_MIN - 1.0);
7459 (void)SvIOK_only(sv);
7460 SvIV_set(sv, SvIVX(sv) - 1);
7465 if (flags & SVp_NOK) {
7466 SvNV_set(sv, SvNVX(sv) - 1.0);
7467 (void)SvNOK_only(sv);
7470 if (!(flags & SVp_POK)) {
7471 if ((flags & SVTYPEMASK) < SVt_PVNV)
7472 sv_upgrade(sv, SVt_NV);
7474 (void)SvNOK_only(sv);
7477 #ifdef PERL_PRESERVE_IVUV
7479 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7480 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7481 /* Need to try really hard to see if it's an integer.
7482 9.22337203685478e+18 is an integer.
7483 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7484 so $a="9.22337203685478e+18"; $a+0; $a--
7485 needs to be the same as $a="9.22337203685478e+18"; $a--
7492 /* sv_2iv *should* have made this an NV */
7493 if (flags & SVp_NOK) {
7494 (void)SvNOK_only(sv);
7495 SvNV_set(sv, SvNVX(sv) - 1.0);
7498 /* I don't think we can get here. Maybe I should assert this
7499 And if we do get here I suspect that sv_setnv will croak. NWC
7501 #if defined(USE_LONG_DOUBLE)
7502 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",
7503 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7505 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7506 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7510 #endif /* PERL_PRESERVE_IVUV */
7511 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7515 =for apidoc sv_mortalcopy
7517 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7518 The new SV is marked as mortal. It will be destroyed "soon", either by an
7519 explicit call to FREETMPS, or by an implicit call at places such as
7520 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7525 /* Make a string that will exist for the duration of the expression
7526 * evaluation. Actually, it may have to last longer than that, but
7527 * hopefully we won't free it until it has been assigned to a
7528 * permanent location. */
7531 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7536 sv_setsv(sv,oldstr);
7538 PL_tmps_stack[++PL_tmps_ix] = sv;
7544 =for apidoc sv_newmortal
7546 Creates a new null SV which is mortal. The reference count of the SV is
7547 set to 1. It will be destroyed "soon", either by an explicit call to
7548 FREETMPS, or by an implicit call at places such as statement boundaries.
7549 See also C<sv_mortalcopy> and C<sv_2mortal>.
7555 Perl_sv_newmortal(pTHX)
7560 SvFLAGS(sv) = SVs_TEMP;
7562 PL_tmps_stack[++PL_tmps_ix] = sv;
7567 =for apidoc sv_2mortal
7569 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7570 by an explicit call to FREETMPS, or by an implicit call at places such as
7571 statement boundaries. SvTEMP() is turned on which means that the SV's
7572 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7573 and C<sv_mortalcopy>.
7579 Perl_sv_2mortal(pTHX_ register SV *sv)
7584 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7587 PL_tmps_stack[++PL_tmps_ix] = sv;
7595 Creates a new SV and copies a string into it. The reference count for the
7596 SV is set to 1. If C<len> is zero, Perl will compute the length using
7597 strlen(). For efficiency, consider using C<newSVpvn> instead.
7603 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7608 sv_setpvn(sv,s,len ? len : strlen(s));
7613 =for apidoc newSVpvn
7615 Creates a new SV and copies a string into it. The reference count for the
7616 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7617 string. You are responsible for ensuring that the source string is at least
7618 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7624 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7629 sv_setpvn(sv,s,len);
7635 =for apidoc newSVhek
7637 Creates a new SV from the hash key structure. It will generate scalars that
7638 point to the shared string table where possible. Returns a new (undefined)
7639 SV if the hek is NULL.
7645 Perl_newSVhek(pTHX_ const HEK *hek)
7654 if (HEK_LEN(hek) == HEf_SVKEY) {
7655 return newSVsv(*(SV**)HEK_KEY(hek));
7657 const int flags = HEK_FLAGS(hek);
7658 if (flags & HVhek_WASUTF8) {
7660 Andreas would like keys he put in as utf8 to come back as utf8
7662 STRLEN utf8_len = HEK_LEN(hek);
7663 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7664 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7667 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7669 } else if (flags & HVhek_REHASH) {
7670 /* We don't have a pointer to the hv, so we have to replicate the
7671 flag into every HEK. This hv is using custom a hasing
7672 algorithm. Hence we can't return a shared string scalar, as
7673 that would contain the (wrong) hash value, and might get passed
7674 into an hv routine with a regular hash */
7676 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7681 /* This will be overwhelminly the most common case. */
7682 return newSVpvn_share(HEK_KEY(hek),
7683 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7689 =for apidoc newSVpvn_share
7691 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7692 table. If the string does not already exist in the table, it is created
7693 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7694 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7695 otherwise the hash is computed. The idea here is that as the string table
7696 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7697 hash lookup will avoid string compare.
7703 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7706 bool is_utf8 = FALSE;
7708 STRLEN tmplen = -len;
7710 /* See the note in hv.c:hv_fetch() --jhi */
7711 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7715 PERL_HASH(hash, src, len);
7717 sv_upgrade(sv, SVt_PV);
7718 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7730 #if defined(PERL_IMPLICIT_CONTEXT)
7732 /* pTHX_ magic can't cope with varargs, so this is a no-context
7733 * version of the main function, (which may itself be aliased to us).
7734 * Don't access this version directly.
7738 Perl_newSVpvf_nocontext(const char* pat, ...)
7743 va_start(args, pat);
7744 sv = vnewSVpvf(pat, &args);
7751 =for apidoc newSVpvf
7753 Creates a new SV and initializes it with the string formatted like
7760 Perl_newSVpvf(pTHX_ const char* pat, ...)
7764 va_start(args, pat);
7765 sv = vnewSVpvf(pat, &args);
7770 /* backend for newSVpvf() and newSVpvf_nocontext() */
7773 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7777 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7784 Creates a new SV and copies a floating point value into it.
7785 The reference count for the SV is set to 1.
7791 Perl_newSVnv(pTHX_ NV n)
7803 Creates a new SV and copies an integer into it. The reference count for the
7810 Perl_newSViv(pTHX_ IV i)
7822 Creates a new SV and copies an unsigned integer into it.
7823 The reference count for the SV is set to 1.
7829 Perl_newSVuv(pTHX_ UV u)
7839 =for apidoc newRV_noinc
7841 Creates an RV wrapper for an SV. The reference count for the original
7842 SV is B<not> incremented.
7848 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7853 sv_upgrade(sv, SVt_RV);
7855 SvRV_set(sv, tmpRef);
7860 /* newRV_inc is the official function name to use now.
7861 * newRV_inc is in fact #defined to newRV in sv.h
7865 Perl_newRV(pTHX_ SV *tmpRef)
7867 return newRV_noinc(SvREFCNT_inc(tmpRef));
7873 Creates a new SV which is an exact duplicate of the original SV.
7880 Perl_newSVsv(pTHX_ register SV *old)
7886 if (SvTYPE(old) == SVTYPEMASK) {
7887 if (ckWARN_d(WARN_INTERNAL))
7888 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7892 /* SV_GMAGIC is the default for sv_setv()
7893 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7894 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7895 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7900 =for apidoc sv_reset
7902 Underlying implementation for the C<reset> Perl function.
7903 Note that the perl-level function is vaguely deprecated.
7909 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7912 char todo[PERL_UCHAR_MAX+1];
7917 if (!*s) { /* reset ?? searches */
7918 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7920 PMOP *pm = (PMOP *) mg->mg_obj;
7922 pm->op_pmdynflags &= ~PMdf_USED;
7929 /* reset variables */
7931 if (!HvARRAY(stash))
7934 Zero(todo, 256, char);
7937 I32 i = (unsigned char)*s;
7941 max = (unsigned char)*s++;
7942 for ( ; i <= max; i++) {
7945 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7947 for (entry = HvARRAY(stash)[i];
7949 entry = HeNEXT(entry))
7954 if (!todo[(U8)*HeKEY(entry)])
7956 gv = (GV*)HeVAL(entry);
7958 if (SvTHINKFIRST(sv)) {
7959 if (!SvREADONLY(sv) && SvROK(sv))
7964 if (SvTYPE(sv) >= SVt_PV) {
7966 if (SvPVX_const(sv) != Nullch)
7973 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7976 #ifdef USE_ENVIRON_ARRAY
7978 # ifdef USE_ITHREADS
7979 && PL_curinterp == aTHX
7983 environ[0] = Nullch;
7986 #endif /* !PERL_MICRO */
7996 Using various gambits, try to get an IO from an SV: the IO slot if its a
7997 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7998 named after the PV if we're a string.
8004 Perl_sv_2io(pTHX_ SV *sv)
8009 switch (SvTYPE(sv)) {
8017 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8021 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8023 return sv_2io(SvRV(sv));
8024 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8030 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8039 Using various gambits, try to get a CV from an SV; in addition, try if
8040 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8046 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8053 return *gvp = Nullgv, Nullcv;
8054 switch (SvTYPE(sv)) {
8073 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8074 tryAMAGICunDEREF(to_cv);
8077 if (SvTYPE(sv) == SVt_PVCV) {
8086 Perl_croak(aTHX_ "Not a subroutine reference");
8091 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8097 if (lref && !GvCVu(gv)) {
8100 tmpsv = NEWSV(704,0);
8101 gv_efullname3(tmpsv, gv, Nullch);
8102 /* XXX this is probably not what they think they're getting.
8103 * It has the same effect as "sub name;", i.e. just a forward
8105 newSUB(start_subparse(FALSE, 0),
8106 newSVOP(OP_CONST, 0, tmpsv),
8111 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8121 Returns true if the SV has a true value by Perl's rules.
8122 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8123 instead use an in-line version.
8129 Perl_sv_true(pTHX_ register SV *sv)
8134 const register XPV* tXpv;
8135 if ((tXpv = (XPV*)SvANY(sv)) &&
8136 (tXpv->xpv_cur > 1 ||
8137 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8144 return SvIVX(sv) != 0;
8147 return SvNVX(sv) != 0.0;
8149 return sv_2bool(sv);
8157 A private implementation of the C<SvIVx> macro for compilers which can't
8158 cope with complex macro expressions. Always use the macro instead.
8164 Perl_sv_iv(pTHX_ register SV *sv)
8168 return (IV)SvUVX(sv);
8177 A private implementation of the C<SvUVx> macro for compilers which can't
8178 cope with complex macro expressions. Always use the macro instead.
8184 Perl_sv_uv(pTHX_ register SV *sv)
8189 return (UV)SvIVX(sv);
8197 A private implementation of the C<SvNVx> macro for compilers which can't
8198 cope with complex macro expressions. Always use the macro instead.
8204 Perl_sv_nv(pTHX_ register SV *sv)
8211 /* sv_pv() is now a macro using SvPV_nolen();
8212 * this function provided for binary compatibility only
8216 Perl_sv_pv(pTHX_ SV *sv)
8221 return sv_2pv(sv, 0);
8227 Use the C<SvPV_nolen> macro instead
8231 A private implementation of the C<SvPV> macro for compilers which can't
8232 cope with complex macro expressions. Always use the macro instead.
8238 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8244 return sv_2pv(sv, lp);
8249 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8255 return sv_2pv_flags(sv, lp, 0);
8258 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8259 * this function provided for binary compatibility only
8263 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8265 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8269 =for apidoc sv_pvn_force
8271 Get a sensible string out of the SV somehow.
8272 A private implementation of the C<SvPV_force> macro for compilers which
8273 can't cope with complex macro expressions. Always use the macro instead.
8275 =for apidoc sv_pvn_force_flags
8277 Get a sensible string out of the SV somehow.
8278 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8279 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8280 implemented in terms of this function.
8281 You normally want to use the various wrapper macros instead: see
8282 C<SvPV_force> and C<SvPV_force_nomg>
8288 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8291 if (SvTHINKFIRST(sv) && !SvROK(sv))
8292 sv_force_normal_flags(sv, 0);
8302 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8304 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8305 sv_reftype(sv,0), OP_NAME(PL_op));
8307 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
8310 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8311 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8315 s = sv_2pv_flags(sv, &len, flags);
8319 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8322 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8323 SvGROW(sv, len + 1);
8324 Move(s,SvPVX_const(sv),len,char);
8329 SvPOK_on(sv); /* validate pointer */
8331 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8332 PTR2UV(sv),SvPVX_const(sv)));
8335 return SvPVX_mutable(sv);
8338 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8339 * this function provided for binary compatibility only
8343 Perl_sv_pvbyte(pTHX_ SV *sv)
8345 sv_utf8_downgrade(sv,0);
8350 =for apidoc sv_pvbyte
8352 Use C<SvPVbyte_nolen> instead.
8354 =for apidoc sv_pvbyten
8356 A private implementation of the C<SvPVbyte> macro for compilers
8357 which can't cope with complex macro expressions. Always use the macro
8364 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8366 sv_utf8_downgrade(sv,0);
8367 return sv_pvn(sv,lp);
8371 =for apidoc sv_pvbyten_force
8373 A private implementation of the C<SvPVbytex_force> macro for compilers
8374 which can't cope with complex macro expressions. Always use the macro
8381 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8383 sv_pvn_force(sv,lp);
8384 sv_utf8_downgrade(sv,0);
8389 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8390 * this function provided for binary compatibility only
8394 Perl_sv_pvutf8(pTHX_ SV *sv)
8396 sv_utf8_upgrade(sv);
8401 =for apidoc sv_pvutf8
8403 Use the C<SvPVutf8_nolen> macro instead
8405 =for apidoc sv_pvutf8n
8407 A private implementation of the C<SvPVutf8> macro for compilers
8408 which can't cope with complex macro expressions. Always use the macro
8415 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8417 sv_utf8_upgrade(sv);
8418 return sv_pvn(sv,lp);
8422 =for apidoc sv_pvutf8n_force
8424 A private implementation of the C<SvPVutf8_force> macro for compilers
8425 which can't cope with complex macro expressions. Always use the macro
8432 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8434 sv_pvn_force(sv,lp);
8435 sv_utf8_upgrade(sv);
8441 =for apidoc sv_reftype
8443 Returns a string describing what the SV is a reference to.
8449 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8451 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8452 inside return suggests a const propagation bug in g++. */
8453 if (ob && SvOBJECT(sv)) {
8454 char *name = HvNAME_get(SvSTASH(sv));
8455 return name ? name : (char *) "__ANON__";
8458 switch (SvTYPE(sv)) {
8475 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8476 /* tied lvalues should appear to be
8477 * scalars for backwards compatitbility */
8478 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8479 ? "SCALAR" : "LVALUE");
8480 case SVt_PVAV: return "ARRAY";
8481 case SVt_PVHV: return "HASH";
8482 case SVt_PVCV: return "CODE";
8483 case SVt_PVGV: return "GLOB";
8484 case SVt_PVFM: return "FORMAT";
8485 case SVt_PVIO: return "IO";
8486 default: return "UNKNOWN";
8492 =for apidoc sv_isobject
8494 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8495 object. If the SV is not an RV, or if the object is not blessed, then this
8502 Perl_sv_isobject(pTHX_ SV *sv)
8519 Returns a boolean indicating whether the SV is blessed into the specified
8520 class. This does not check for subtypes; use C<sv_derived_from> to verify
8521 an inheritance relationship.
8527 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8539 hvname = HvNAME_get(SvSTASH(sv));
8543 return strEQ(hvname, name);
8549 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8550 it will be upgraded to one. If C<classname> is non-null then the new SV will
8551 be blessed in the specified package. The new SV is returned and its
8552 reference count is 1.
8558 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8564 SV_CHECK_THINKFIRST_COW_DROP(rv);
8567 if (SvTYPE(rv) >= SVt_PVMG) {
8568 const U32 refcnt = SvREFCNT(rv);
8572 SvREFCNT(rv) = refcnt;
8575 if (SvTYPE(rv) < SVt_RV)
8576 sv_upgrade(rv, SVt_RV);
8577 else if (SvTYPE(rv) > SVt_RV) {
8588 HV* stash = gv_stashpv(classname, TRUE);
8589 (void)sv_bless(rv, stash);
8595 =for apidoc sv_setref_pv
8597 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8598 argument will be upgraded to an RV. That RV will be modified to point to
8599 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8600 into the SV. The C<classname> argument indicates the package for the
8601 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8602 will have a reference count of 1, and the RV will be returned.
8604 Do not use with other Perl types such as HV, AV, SV, CV, because those
8605 objects will become corrupted by the pointer copy process.
8607 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8613 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8616 sv_setsv(rv, &PL_sv_undef);
8620 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8625 =for apidoc sv_setref_iv
8627 Copies an integer 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_iv(pTHX_ SV *rv, const char *classname, IV iv)
8639 sv_setiv(newSVrv(rv,classname), iv);
8644 =for apidoc sv_setref_uv
8646 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8647 argument will be upgraded to an RV. That RV will be modified to point to
8648 the new SV. The C<classname> argument indicates the package for the
8649 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8650 will have a reference count of 1, and the RV will be returned.
8656 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8658 sv_setuv(newSVrv(rv,classname), uv);
8663 =for apidoc sv_setref_nv
8665 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8666 argument will be upgraded to an RV. That RV will be modified to point to
8667 the new SV. The C<classname> argument indicates the package for the
8668 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8669 will have a reference count of 1, and the RV will be returned.
8675 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8677 sv_setnv(newSVrv(rv,classname), nv);
8682 =for apidoc sv_setref_pvn
8684 Copies a string into a new SV, optionally blessing the SV. The length of the
8685 string must be specified with C<n>. The C<rv> argument will be upgraded to
8686 an RV. That RV will be modified to point to the new SV. The C<classname>
8687 argument indicates the package for the blessing. Set C<classname> to
8688 C<Nullch> to avoid the blessing. The new SV will have a reference count
8689 of 1, and the RV will be returned.
8691 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8697 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8699 sv_setpvn(newSVrv(rv,classname), pv, n);
8704 =for apidoc sv_bless
8706 Blesses an SV into a specified package. The SV must be an RV. The package
8707 must be designated by its stash (see C<gv_stashpv()>). The reference count
8708 of the SV is unaffected.
8714 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8718 Perl_croak(aTHX_ "Can't bless non-reference value");
8720 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8721 if (SvREADONLY(tmpRef))
8722 Perl_croak(aTHX_ PL_no_modify);
8723 if (SvOBJECT(tmpRef)) {
8724 if (SvTYPE(tmpRef) != SVt_PVIO)
8726 SvREFCNT_dec(SvSTASH(tmpRef));
8729 SvOBJECT_on(tmpRef);
8730 if (SvTYPE(tmpRef) != SVt_PVIO)
8732 SvUPGRADE(tmpRef, SVt_PVMG);
8733 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8740 if(SvSMAGICAL(tmpRef))
8741 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8749 /* Downgrades a PVGV to a PVMG.
8753 S_sv_unglob(pTHX_ SV *sv)
8757 assert(SvTYPE(sv) == SVt_PVGV);
8762 SvREFCNT_dec(GvSTASH(sv));
8763 GvSTASH(sv) = Nullhv;
8765 sv_unmagic(sv, PERL_MAGIC_glob);
8766 Safefree(GvNAME(sv));
8769 /* need to keep SvANY(sv) in the right arena */
8770 xpvmg = new_XPVMG();
8771 StructCopy(SvANY(sv), xpvmg, XPVMG);
8772 del_XPVGV(SvANY(sv));
8775 SvFLAGS(sv) &= ~SVTYPEMASK;
8776 SvFLAGS(sv) |= SVt_PVMG;
8780 =for apidoc sv_unref_flags
8782 Unsets the RV status of the SV, and decrements the reference count of
8783 whatever was being referenced by the RV. This can almost be thought of
8784 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8785 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8786 (otherwise the decrementing is conditional on the reference count being
8787 different from one or the reference being a readonly SV).
8794 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8798 if (SvWEAKREF(sv)) {
8806 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8807 assigned to as BEGIN {$a = \"Foo"} will fail. */
8808 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8810 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8811 sv_2mortal(rv); /* Schedule for freeing later */
8815 =for apidoc sv_unref
8817 Unsets the RV status of the SV, and decrements the reference count of
8818 whatever was being referenced by the RV. This can almost be thought of
8819 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8820 being zero. See C<SvROK_off>.
8826 Perl_sv_unref(pTHX_ SV *sv)
8828 sv_unref_flags(sv, 0);
8832 =for apidoc sv_taint
8834 Taint an SV. Use C<SvTAINTED_on> instead.
8839 Perl_sv_taint(pTHX_ SV *sv)
8841 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8845 =for apidoc sv_untaint
8847 Untaint an SV. Use C<SvTAINTED_off> instead.
8852 Perl_sv_untaint(pTHX_ SV *sv)
8854 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8855 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8862 =for apidoc sv_tainted
8864 Test an SV for taintedness. Use C<SvTAINTED> instead.
8869 Perl_sv_tainted(pTHX_ SV *sv)
8871 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8872 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8873 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8880 =for apidoc sv_setpviv
8882 Copies an integer into the given SV, also updating its string value.
8883 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8889 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8891 char buf[TYPE_CHARS(UV)];
8893 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8895 sv_setpvn(sv, ptr, ebuf - ptr);
8899 =for apidoc sv_setpviv_mg
8901 Like C<sv_setpviv>, but also handles 'set' magic.
8907 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8909 char buf[TYPE_CHARS(UV)];
8911 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8913 sv_setpvn(sv, ptr, ebuf - ptr);
8917 #if defined(PERL_IMPLICIT_CONTEXT)
8919 /* pTHX_ magic can't cope with varargs, so this is a no-context
8920 * version of the main function, (which may itself be aliased to us).
8921 * Don't access this version directly.
8925 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8929 va_start(args, pat);
8930 sv_vsetpvf(sv, pat, &args);
8934 /* pTHX_ magic can't cope with varargs, so this is a no-context
8935 * version of the main function, (which may itself be aliased to us).
8936 * Don't access this version directly.
8940 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8944 va_start(args, pat);
8945 sv_vsetpvf_mg(sv, pat, &args);
8951 =for apidoc sv_setpvf
8953 Works like C<sv_catpvf> but copies the text into the SV instead of
8954 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8960 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8963 va_start(args, pat);
8964 sv_vsetpvf(sv, pat, &args);
8969 =for apidoc sv_vsetpvf
8971 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8972 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8974 Usually used via its frontend C<sv_setpvf>.
8980 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8982 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8986 =for apidoc sv_setpvf_mg
8988 Like C<sv_setpvf>, but also handles 'set' magic.
8994 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8997 va_start(args, pat);
8998 sv_vsetpvf_mg(sv, pat, &args);
9003 =for apidoc sv_vsetpvf_mg
9005 Like C<sv_vsetpvf>, but also handles 'set' magic.
9007 Usually used via its frontend C<sv_setpvf_mg>.
9013 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9015 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9019 #if defined(PERL_IMPLICIT_CONTEXT)
9021 /* pTHX_ magic can't cope with varargs, so this is a no-context
9022 * version of the main function, (which may itself be aliased to us).
9023 * Don't access this version directly.
9027 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
9031 va_start(args, pat);
9032 sv_vcatpvf(sv, pat, &args);
9036 /* pTHX_ magic can't cope with varargs, so this is a no-context
9037 * version of the main function, (which may itself be aliased to us).
9038 * Don't access this version directly.
9042 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9046 va_start(args, pat);
9047 sv_vcatpvf_mg(sv, pat, &args);
9053 =for apidoc sv_catpvf
9055 Processes its arguments like C<sprintf> and appends the formatted
9056 output to an SV. If the appended data contains "wide" characters
9057 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9058 and characters >255 formatted with %c), the original SV might get
9059 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9060 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9061 valid UTF-8; if the original SV was bytes, the pattern should be too.
9066 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9069 va_start(args, pat);
9070 sv_vcatpvf(sv, pat, &args);
9075 =for apidoc sv_vcatpvf
9077 Processes its arguments like C<vsprintf> and appends the formatted output
9078 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9080 Usually used via its frontend C<sv_catpvf>.
9086 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9088 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9092 =for apidoc sv_catpvf_mg
9094 Like C<sv_catpvf>, but also handles 'set' magic.
9100 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9103 va_start(args, pat);
9104 sv_vcatpvf_mg(sv, pat, &args);
9109 =for apidoc sv_vcatpvf_mg
9111 Like C<sv_vcatpvf>, but also handles 'set' magic.
9113 Usually used via its frontend C<sv_catpvf_mg>.
9119 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9121 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9126 =for apidoc sv_vsetpvfn
9128 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9131 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9137 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9139 sv_setpvn(sv, "", 0);
9140 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9143 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9146 S_expect_number(pTHX_ char** pattern)
9149 switch (**pattern) {
9150 case '1': case '2': case '3':
9151 case '4': case '5': case '6':
9152 case '7': case '8': case '9':
9153 while (isDIGIT(**pattern))
9154 var = var * 10 + (*(*pattern)++ - '0');
9158 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9161 F0convert(NV nv, char *endbuf, STRLEN *len)
9163 const int neg = nv < 0;
9172 if (uv & 1 && uv == nv)
9173 uv--; /* Round to even */
9175 const unsigned dig = uv % 10;
9188 =for apidoc sv_vcatpvfn
9190 Processes its arguments like C<vsprintf> and appends the formatted output
9191 to an SV. Uses an array of SVs if the C style variable argument list is
9192 missing (NULL). When running with taint checks enabled, indicates via
9193 C<maybe_tainted> if results are untrustworthy (often due to the use of
9196 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9201 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9204 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9211 static const char nullstr[] = "(null)";
9213 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9214 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9216 /* Times 4: a decimal digit takes more than 3 binary digits.
9217 * NV_DIG: mantissa takes than many decimal digits.
9218 * Plus 32: Playing safe. */
9219 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9220 /* large enough for "%#.#f" --chip */
9221 /* what about long double NVs? --jhi */
9223 /* no matter what, this is a string now */
9224 (void)SvPV_force(sv, origlen);
9226 /* special-case "", "%s", and "%-p" (SVf) */
9229 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9231 const char *s = va_arg(*args, char*);
9232 sv_catpv(sv, s ? s : nullstr);
9234 else if (svix < svmax) {
9235 sv_catsv(sv, *svargs);
9236 if (DO_UTF8(*svargs))
9241 if (patlen == 3 && pat[0] == '%' &&
9242 pat[1] == '-' && pat[2] == 'p') {
9244 argsv = va_arg(*args, SV*);
9245 sv_catsv(sv, argsv);
9252 #ifndef USE_LONG_DOUBLE
9253 /* special-case "%.<number>[gf]" */
9254 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9255 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9256 unsigned digits = 0;
9260 while (*pp >= '0' && *pp <= '9')
9261 digits = 10 * digits + (*pp++ - '0');
9262 if (pp - pat == (int)patlen - 1) {
9266 nv = (NV)va_arg(*args, double);
9267 else if (svix < svmax)
9272 /* Add check for digits != 0 because it seems that some
9273 gconverts are buggy in this case, and we don't yet have
9274 a Configure test for this. */
9275 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9276 /* 0, point, slack */
9277 Gconvert(nv, (int)digits, 0, ebuf);
9279 if (*ebuf) /* May return an empty string for digits==0 */
9282 } else if (!digits) {
9285 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9286 sv_catpvn(sv, p, l);
9292 #endif /* !USE_LONG_DOUBLE */
9294 if (!args && svix < svmax && DO_UTF8(*svargs))
9297 patend = (char*)pat + patlen;
9298 for (p = (char*)pat; p < patend; p = q) {
9301 bool vectorize = FALSE;
9302 bool vectorarg = FALSE;
9303 bool vec_utf8 = FALSE;
9309 bool has_precis = FALSE;
9312 bool is_utf8 = FALSE; /* is this item utf8? */
9313 #ifdef HAS_LDBL_SPRINTF_BUG
9314 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9315 with sfio - Allen <allens@cpan.org> */
9316 bool fix_ldbl_sprintf_bug = FALSE;
9320 U8 utf8buf[UTF8_MAXBYTES+1];
9321 STRLEN esignlen = 0;
9323 const char *eptr = Nullch;
9326 const U8 *vecstr = Null(U8*);
9333 /* we need a long double target in case HAS_LONG_DOUBLE but
9336 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9344 const char *dotstr = ".";
9345 STRLEN dotstrlen = 1;
9346 I32 efix = 0; /* explicit format parameter index */
9347 I32 ewix = 0; /* explicit width index */
9348 I32 epix = 0; /* explicit precision index */
9349 I32 evix = 0; /* explicit vector index */
9350 bool asterisk = FALSE;
9352 /* echo everything up to the next format specification */
9353 for (q = p; q < patend && *q != '%'; ++q) ;
9355 if (has_utf8 && !pat_utf8)
9356 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9358 sv_catpvn(sv, p, q - p);
9365 We allow format specification elements in this order:
9366 \d+\$ explicit format parameter index
9368 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9369 0 flag (as above): repeated to allow "v02"
9370 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9371 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9373 [%bcdefginopsux_DFOUX] format (mandatory)
9375 if (EXPECT_NUMBER(q, width)) {
9416 if (EXPECT_NUMBER(q, ewix))
9425 if ((vectorarg = asterisk)) {
9437 EXPECT_NUMBER(q, width);
9442 vecsv = va_arg(*args, SV*);
9444 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9445 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9446 dotstr = SvPV_const(vecsv, dotstrlen);
9451 vecsv = va_arg(*args, SV*);
9452 vecstr = (U8*)SvPV_const(vecsv,veclen);
9453 vec_utf8 = DO_UTF8(vecsv);
9455 else if (efix ? efix <= svmax : svix < svmax) {
9456 vecsv = svargs[efix ? efix-1 : svix++];
9457 vecstr = (U8*)SvPV_const(vecsv,veclen);
9458 vec_utf8 = DO_UTF8(vecsv);
9459 /* if this is a version object, we need to return the
9460 * stringified representation (which the SvPVX_const has
9461 * already done for us), but not vectorize the args
9463 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9465 q++; /* skip past the rest of the %vd format */
9466 eptr = (const char *) vecstr;
9467 elen = strlen(eptr);
9480 i = va_arg(*args, int);
9482 i = (ewix ? ewix <= svmax : svix < svmax) ?
9483 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9485 width = (i < 0) ? -i : i;
9495 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9497 /* XXX: todo, support specified precision parameter */
9501 i = va_arg(*args, int);
9503 i = (ewix ? ewix <= svmax : svix < svmax)
9504 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9505 precis = (i < 0) ? 0 : i;
9510 precis = precis * 10 + (*q++ - '0');
9519 case 'I': /* Ix, I32x, and I64x */
9521 if (q[1] == '6' && q[2] == '4') {
9527 if (q[1] == '3' && q[2] == '2') {
9537 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9548 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9549 if (*(q + 1) == 'l') { /* lld, llf */
9574 argsv = (efix ? efix <= svmax : svix < svmax) ?
9575 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9582 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9584 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9586 eptr = (char*)utf8buf;
9587 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9598 if (args && !vectorize) {
9599 eptr = va_arg(*args, char*);
9601 #ifdef MACOS_TRADITIONAL
9602 /* On MacOS, %#s format is used for Pascal strings */
9607 elen = strlen(eptr);
9609 eptr = (char *)nullstr;
9610 elen = sizeof nullstr - 1;
9614 eptr = SvPVx_const(argsv, elen);
9615 if (DO_UTF8(argsv)) {
9616 if (has_precis && precis < elen) {
9618 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9621 if (width) { /* fudge width (can't fudge elen) */
9622 width += elen - sv_len_utf8(argsv);
9630 if (has_precis && elen > precis)
9637 if (left && args) { /* SVf */
9646 argsv = va_arg(*args, SV*);
9647 eptr = SvPVx_const(argsv, elen);
9652 if (alt || vectorize)
9654 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9672 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9681 esignbuf[esignlen++] = plus;
9685 case 'h': iv = (short)va_arg(*args, int); break;
9686 case 'l': iv = va_arg(*args, long); break;
9687 case 'V': iv = va_arg(*args, IV); break;
9688 default: iv = va_arg(*args, int); break;
9690 case 'q': iv = va_arg(*args, Quad_t); break;
9695 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9697 case 'h': iv = (short)tiv; break;
9698 case 'l': iv = (long)tiv; break;
9700 default: iv = tiv; break;
9702 case 'q': iv = (Quad_t)tiv; break;
9706 if ( !vectorize ) /* we already set uv above */
9711 esignbuf[esignlen++] = plus;
9715 esignbuf[esignlen++] = '-';
9758 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9769 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9770 case 'l': uv = va_arg(*args, unsigned long); break;
9771 case 'V': uv = va_arg(*args, UV); break;
9772 default: uv = va_arg(*args, unsigned); break;
9774 case 'q': uv = va_arg(*args, Uquad_t); break;
9779 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9781 case 'h': uv = (unsigned short)tuv; break;
9782 case 'l': uv = (unsigned long)tuv; break;
9784 default: uv = tuv; break;
9786 case 'q': uv = (Uquad_t)tuv; break;
9793 char *ptr = ebuf + sizeof ebuf;
9799 p = (char*)((c == 'X')
9800 ? "0123456789ABCDEF" : "0123456789abcdef");
9806 esignbuf[esignlen++] = '0';
9807 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9815 if (alt && *ptr != '0')
9824 esignbuf[esignlen++] = '0';
9825 esignbuf[esignlen++] = 'b';
9828 default: /* it had better be ten or less */
9832 } while (uv /= base);
9835 elen = (ebuf + sizeof ebuf) - ptr;
9839 zeros = precis - elen;
9840 else if (precis == 0 && elen == 1 && *eptr == '0')
9846 /* FLOATING POINT */
9849 c = 'f'; /* maybe %F isn't supported here */
9855 /* This is evil, but floating point is even more evil */
9857 /* for SV-style calling, we can only get NV
9858 for C-style calling, we assume %f is double;
9859 for simplicity we allow any of %Lf, %llf, %qf for long double
9863 #if defined(USE_LONG_DOUBLE)
9867 /* [perl #20339] - we should accept and ignore %lf rather than die */
9871 #if defined(USE_LONG_DOUBLE)
9872 intsize = args ? 0 : 'q';
9876 #if defined(HAS_LONG_DOUBLE)
9885 /* now we need (long double) if intsize == 'q', else (double) */
9886 nv = (args && !vectorize) ?
9887 #if LONG_DOUBLESIZE > DOUBLESIZE
9889 va_arg(*args, long double) :
9890 va_arg(*args, double)
9892 va_arg(*args, double)
9898 if (c != 'e' && c != 'E') {
9900 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9901 will cast our (long double) to (double) */
9902 (void)Perl_frexp(nv, &i);
9903 if (i == PERL_INT_MIN)
9904 Perl_die(aTHX_ "panic: frexp");
9906 need = BIT_DIGITS(i);
9908 need += has_precis ? precis : 6; /* known default */
9913 #ifdef HAS_LDBL_SPRINTF_BUG
9914 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9915 with sfio - Allen <allens@cpan.org> */
9918 # define MY_DBL_MAX DBL_MAX
9919 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9920 # if DOUBLESIZE >= 8
9921 # define MY_DBL_MAX 1.7976931348623157E+308L
9923 # define MY_DBL_MAX 3.40282347E+38L
9927 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9928 # define MY_DBL_MAX_BUG 1L
9930 # define MY_DBL_MAX_BUG MY_DBL_MAX
9934 # define MY_DBL_MIN DBL_MIN
9935 # else /* XXX guessing! -Allen */
9936 # if DOUBLESIZE >= 8
9937 # define MY_DBL_MIN 2.2250738585072014E-308L
9939 # define MY_DBL_MIN 1.17549435E-38L
9943 if ((intsize == 'q') && (c == 'f') &&
9944 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9946 /* it's going to be short enough that
9947 * long double precision is not needed */
9949 if ((nv <= 0L) && (nv >= -0L))
9950 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9952 /* would use Perl_fp_class as a double-check but not
9953 * functional on IRIX - see perl.h comments */
9955 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9956 /* It's within the range that a double can represent */
9957 #if defined(DBL_MAX) && !defined(DBL_MIN)
9958 if ((nv >= ((long double)1/DBL_MAX)) ||
9959 (nv <= (-(long double)1/DBL_MAX)))
9961 fix_ldbl_sprintf_bug = TRUE;
9964 if (fix_ldbl_sprintf_bug == TRUE) {
9974 # undef MY_DBL_MAX_BUG
9977 #endif /* HAS_LDBL_SPRINTF_BUG */
9979 need += 20; /* fudge factor */
9980 if (PL_efloatsize < need) {
9981 Safefree(PL_efloatbuf);
9982 PL_efloatsize = need + 20; /* more fudge */
9983 New(906, PL_efloatbuf, PL_efloatsize, char);
9984 PL_efloatbuf[0] = '\0';
9987 if ( !(width || left || plus || alt) && fill != '0'
9988 && has_precis && intsize != 'q' ) { /* Shortcuts */
9989 /* See earlier comment about buggy Gconvert when digits,
9991 if ( c == 'g' && precis) {
9992 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9993 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9994 goto float_converted;
9995 } else if ( c == 'f' && !precis) {
9996 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10001 char *ptr = ebuf + sizeof ebuf;
10004 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10005 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10006 if (intsize == 'q') {
10007 /* Copy the one or more characters in a long double
10008 * format before the 'base' ([efgEFG]) character to
10009 * the format string. */
10010 static char const prifldbl[] = PERL_PRIfldbl;
10011 char const *p = prifldbl + sizeof(prifldbl) - 3;
10012 while (p >= prifldbl) { *--ptr = *p--; }
10017 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10022 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10034 /* No taint. Otherwise we are in the strange situation
10035 * where printf() taints but print($float) doesn't.
10037 #if defined(HAS_LONG_DOUBLE)
10038 if (intsize == 'q')
10039 (void)sprintf(PL_efloatbuf, ptr, nv);
10041 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
10043 (void)sprintf(PL_efloatbuf, ptr, nv);
10047 eptr = PL_efloatbuf;
10048 elen = strlen(PL_efloatbuf);
10054 i = SvCUR(sv) - origlen;
10055 if (args && !vectorize) {
10057 case 'h': *(va_arg(*args, short*)) = i; break;
10058 default: *(va_arg(*args, int*)) = i; break;
10059 case 'l': *(va_arg(*args, long*)) = i; break;
10060 case 'V': *(va_arg(*args, IV*)) = i; break;
10062 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10067 sv_setuv_mg(argsv, (UV)i);
10069 continue; /* not "break" */
10075 if (!args && ckWARN(WARN_PRINTF) &&
10076 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10077 SV *msg = sv_newmortal();
10078 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10079 (PL_op->op_type == OP_PRTF) ? "" : "s");
10082 Perl_sv_catpvf(aTHX_ msg,
10083 "\"%%%c\"", c & 0xFF);
10085 Perl_sv_catpvf(aTHX_ msg,
10086 "\"%%\\%03"UVof"\"",
10089 sv_catpv(msg, "end of string");
10090 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10093 /* output mangled stuff ... */
10099 /* ... right here, because formatting flags should not apply */
10100 SvGROW(sv, SvCUR(sv) + elen + 1);
10102 Copy(eptr, p, elen, char);
10105 SvCUR_set(sv, p - SvPVX_const(sv));
10107 continue; /* not "break" */
10110 /* calculate width before utf8_upgrade changes it */
10111 have = esignlen + zeros + elen;
10113 if (is_utf8 != has_utf8) {
10116 sv_utf8_upgrade(sv);
10119 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10120 sv_utf8_upgrade(nsv);
10121 eptr = SvPVX_const(nsv);
10124 SvGROW(sv, SvCUR(sv) + elen + 1);
10129 need = (have > width ? have : width);
10132 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10134 if (esignlen && fill == '0') {
10135 for (i = 0; i < (int)esignlen; i++)
10136 *p++ = esignbuf[i];
10138 if (gap && !left) {
10139 memset(p, fill, gap);
10142 if (esignlen && fill != '0') {
10143 for (i = 0; i < (int)esignlen; i++)
10144 *p++ = esignbuf[i];
10147 for (i = zeros; i; i--)
10151 Copy(eptr, p, elen, char);
10155 memset(p, ' ', gap);
10160 Copy(dotstr, p, dotstrlen, char);
10164 vectorize = FALSE; /* done iterating over vecstr */
10171 SvCUR_set(sv, p - SvPVX_const(sv));
10179 /* =========================================================================
10181 =head1 Cloning an interpreter
10183 All the macros and functions in this section are for the private use of
10184 the main function, perl_clone().
10186 The foo_dup() functions make an exact copy of an existing foo thinngy.
10187 During the course of a cloning, a hash table is used to map old addresses
10188 to new addresses. The table is created and manipulated with the
10189 ptr_table_* functions.
10193 ============================================================================*/
10196 #if defined(USE_ITHREADS)
10198 #ifndef GpREFCNT_inc
10199 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10203 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10204 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10205 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10206 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10207 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10208 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10209 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10210 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10211 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10212 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10213 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10214 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10215 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10218 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10219 regcomp.c. AMS 20010712 */
10222 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10227 struct reg_substr_datum *s;
10230 return (REGEXP *)NULL;
10232 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10235 len = r->offsets[0];
10236 npar = r->nparens+1;
10238 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10239 Copy(r->program, ret->program, len+1, regnode);
10241 New(0, ret->startp, npar, I32);
10242 Copy(r->startp, ret->startp, npar, I32);
10243 New(0, ret->endp, npar, I32);
10244 Copy(r->startp, ret->startp, npar, I32);
10246 New(0, ret->substrs, 1, struct reg_substr_data);
10247 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10248 s->min_offset = r->substrs->data[i].min_offset;
10249 s->max_offset = r->substrs->data[i].max_offset;
10250 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10251 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10254 ret->regstclass = NULL;
10256 struct reg_data *d;
10257 const int count = r->data->count;
10259 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10260 char, struct reg_data);
10261 New(0, d->what, count, U8);
10264 for (i = 0; i < count; i++) {
10265 d->what[i] = r->data->what[i];
10266 switch (d->what[i]) {
10267 /* legal options are one of: sfpont
10268 see also regcomp.h and pregfree() */
10270 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10273 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10276 /* This is cheating. */
10277 New(0, d->data[i], 1, struct regnode_charclass_class);
10278 StructCopy(r->data->data[i], d->data[i],
10279 struct regnode_charclass_class);
10280 ret->regstclass = (regnode*)d->data[i];
10283 /* Compiled op trees are readonly, and can thus be
10284 shared without duplication. */
10286 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10290 d->data[i] = r->data->data[i];
10293 d->data[i] = r->data->data[i];
10295 ((reg_trie_data*)d->data[i])->refcount++;
10299 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10308 New(0, ret->offsets, 2*len+1, U32);
10309 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10311 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10312 ret->refcnt = r->refcnt;
10313 ret->minlen = r->minlen;
10314 ret->prelen = r->prelen;
10315 ret->nparens = r->nparens;
10316 ret->lastparen = r->lastparen;
10317 ret->lastcloseparen = r->lastcloseparen;
10318 ret->reganch = r->reganch;
10320 ret->sublen = r->sublen;
10322 if (RX_MATCH_COPIED(ret))
10323 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10325 ret->subbeg = Nullch;
10326 #ifdef PERL_OLD_COPY_ON_WRITE
10327 ret->saved_copy = Nullsv;
10330 ptr_table_store(PL_ptr_table, r, ret);
10334 /* duplicate a file handle */
10337 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10343 return (PerlIO*)NULL;
10345 /* look for it in the table first */
10346 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10350 /* create anew and remember what it is */
10351 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10352 ptr_table_store(PL_ptr_table, fp, ret);
10356 /* duplicate a directory handle */
10359 Perl_dirp_dup(pTHX_ DIR *dp)
10367 /* duplicate a typeglob */
10370 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10375 /* look for it in the table first */
10376 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10380 /* create anew and remember what it is */
10381 Newz(0, ret, 1, GP);
10382 ptr_table_store(PL_ptr_table, gp, ret);
10385 ret->gp_refcnt = 0; /* must be before any other dups! */
10386 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10387 ret->gp_io = io_dup_inc(gp->gp_io, param);
10388 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10389 ret->gp_av = av_dup_inc(gp->gp_av, param);
10390 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10391 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10392 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10393 ret->gp_cvgen = gp->gp_cvgen;
10394 ret->gp_flags = gp->gp_flags;
10395 ret->gp_line = gp->gp_line;
10396 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10400 /* duplicate a chain of magic */
10403 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10405 MAGIC *mgprev = (MAGIC*)NULL;
10408 return (MAGIC*)NULL;
10409 /* look for it in the table first */
10410 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10414 for (; mg; mg = mg->mg_moremagic) {
10416 Newz(0, nmg, 1, MAGIC);
10418 mgprev->mg_moremagic = nmg;
10421 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10422 nmg->mg_private = mg->mg_private;
10423 nmg->mg_type = mg->mg_type;
10424 nmg->mg_flags = mg->mg_flags;
10425 if (mg->mg_type == PERL_MAGIC_qr) {
10426 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10428 else if(mg->mg_type == PERL_MAGIC_backref) {
10429 const AV * const av = (AV*) mg->mg_obj;
10432 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10434 for (i = AvFILLp(av); i >= 0; i--) {
10435 if (!svp[i]) continue;
10436 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10439 else if (mg->mg_type == PERL_MAGIC_symtab) {
10440 nmg->mg_obj = mg->mg_obj;
10443 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10444 ? sv_dup_inc(mg->mg_obj, param)
10445 : sv_dup(mg->mg_obj, param);
10447 nmg->mg_len = mg->mg_len;
10448 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10449 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10450 if (mg->mg_len > 0) {
10451 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10452 if (mg->mg_type == PERL_MAGIC_overload_table &&
10453 AMT_AMAGIC((AMT*)mg->mg_ptr))
10455 AMT *amtp = (AMT*)mg->mg_ptr;
10456 AMT *namtp = (AMT*)nmg->mg_ptr;
10458 for (i = 1; i < NofAMmeth; i++) {
10459 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10463 else if (mg->mg_len == HEf_SVKEY)
10464 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10466 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10467 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10474 /* create a new pointer-mapping table */
10477 Perl_ptr_table_new(pTHX)
10480 Newz(0, tbl, 1, PTR_TBL_t);
10481 tbl->tbl_max = 511;
10482 tbl->tbl_items = 0;
10483 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10488 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10490 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10498 struct ptr_tbl_ent* pte;
10499 struct ptr_tbl_ent* pteend;
10500 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10501 pte->next = PL_pte_arenaroot;
10502 PL_pte_arenaroot = pte;
10504 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10505 PL_pte_root = ++pte;
10506 while (pte < pteend) {
10507 pte->next = pte + 1;
10513 STATIC struct ptr_tbl_ent*
10516 struct ptr_tbl_ent* pte;
10520 PL_pte_root = pte->next;
10525 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10527 p->next = PL_pte_root;
10531 /* map an existing pointer using a table */
10534 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10536 PTR_TBL_ENT_t *tblent;
10537 const UV hash = PTR_TABLE_HASH(sv);
10539 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10540 for (; tblent; tblent = tblent->next) {
10541 if (tblent->oldval == sv)
10542 return tblent->newval;
10544 return (void*)NULL;
10547 /* add a new entry to a pointer-mapping table */
10550 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10552 PTR_TBL_ENT_t *tblent, **otblent;
10553 /* XXX this may be pessimal on platforms where pointers aren't good
10554 * hash values e.g. if they grow faster in the most significant
10556 const UV hash = PTR_TABLE_HASH(oldv);
10560 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10561 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10562 if (tblent->oldval == oldv) {
10563 tblent->newval = newv;
10567 tblent = S_new_pte(aTHX);
10568 tblent->oldval = oldv;
10569 tblent->newval = newv;
10570 tblent->next = *otblent;
10573 if (!empty && tbl->tbl_items > tbl->tbl_max)
10574 ptr_table_split(tbl);
10577 /* double the hash bucket size of an existing ptr table */
10580 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10582 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10583 const UV oldsize = tbl->tbl_max + 1;
10584 UV newsize = oldsize * 2;
10587 Renew(ary, newsize, PTR_TBL_ENT_t*);
10588 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10589 tbl->tbl_max = --newsize;
10590 tbl->tbl_ary = ary;
10591 for (i=0; i < oldsize; i++, ary++) {
10592 PTR_TBL_ENT_t **curentp, **entp, *ent;
10595 curentp = ary + oldsize;
10596 for (entp = ary, ent = *ary; ent; ent = *entp) {
10597 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10599 ent->next = *curentp;
10609 /* remove all the entries from a ptr table */
10612 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10614 register PTR_TBL_ENT_t **array;
10615 register PTR_TBL_ENT_t *entry;
10619 if (!tbl || !tbl->tbl_items) {
10623 array = tbl->tbl_ary;
10625 max = tbl->tbl_max;
10629 PTR_TBL_ENT_t *oentry = entry;
10630 entry = entry->next;
10631 S_del_pte(aTHX_ oentry);
10634 if (++riter > max) {
10637 entry = array[riter];
10641 tbl->tbl_items = 0;
10644 /* clear and free a ptr table */
10647 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10652 ptr_table_clear(tbl);
10653 Safefree(tbl->tbl_ary);
10657 /* attempt to make everything in the typeglob readonly */
10660 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10662 GV *gv = (GV*)sstr;
10663 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10665 if (GvIO(gv) || GvFORM(gv)) {
10666 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10668 else if (!GvCV(gv)) {
10669 GvCV(gv) = (CV*)sv;
10672 /* CvPADLISTs cannot be shared */
10673 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10678 if (!GvUNIQUE(gv)) {
10680 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10681 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10687 * write attempts will die with
10688 * "Modification of a read-only value attempted"
10694 SvREADONLY_on(GvSV(gv));
10698 GvAV(gv) = (AV*)sv;
10701 SvREADONLY_on(GvAV(gv));
10705 GvHV(gv) = (HV*)sv;
10708 SvREADONLY_on(GvHV(gv));
10711 return sstr; /* he_dup() will SvREFCNT_inc() */
10714 /* duplicate an SV of any type (including AV, HV etc) */
10717 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10720 SvRV_set(dstr, SvWEAKREF(sstr)
10721 ? sv_dup(SvRV(sstr), param)
10722 : sv_dup_inc(SvRV(sstr), param));
10725 else if (SvPVX_const(sstr)) {
10726 /* Has something there */
10728 /* Normal PV - clone whole allocated space */
10729 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10730 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10731 /* Not that normal - actually sstr is copy on write.
10732 But we are a true, independant SV, so: */
10733 SvREADONLY_off(dstr);
10738 /* Special case - not normally malloced for some reason */
10739 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10740 /* A "shared" PV - clone it as "shared" PV */
10742 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10746 /* Some other special case - random pointer */
10747 SvPV_set(dstr, SvPVX(sstr));
10752 /* Copy the Null */
10753 if (SvTYPE(dstr) == SVt_RV)
10754 SvRV_set(dstr, NULL);
10761 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10766 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10768 /* look for it in the table first */
10769 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10773 if(param->flags & CLONEf_JOIN_IN) {
10774 /** We are joining here so we don't want do clone
10775 something that is bad **/
10776 const char *hvname;
10778 if(SvTYPE(sstr) == SVt_PVHV &&
10779 (hvname = HvNAME_get(sstr))) {
10780 /** don't clone stashes if they already exist **/
10781 HV* old_stash = gv_stashpv(hvname,0);
10782 return (SV*) old_stash;
10786 /* create anew and remember what it is */
10789 #ifdef DEBUG_LEAKING_SCALARS
10790 dstr->sv_debug_optype = sstr->sv_debug_optype;
10791 dstr->sv_debug_line = sstr->sv_debug_line;
10792 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10793 dstr->sv_debug_cloned = 1;
10795 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10797 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10801 ptr_table_store(PL_ptr_table, sstr, dstr);
10804 SvFLAGS(dstr) = SvFLAGS(sstr);
10805 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10806 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10809 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10810 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10811 PL_watch_pvx, SvPVX_const(sstr));
10814 /* don't clone objects whose class has asked us not to */
10815 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10816 SvFLAGS(dstr) &= ~SVTYPEMASK;
10817 SvOBJECT_off(dstr);
10821 switch (SvTYPE(sstr)) {
10823 SvANY(dstr) = NULL;
10826 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10827 SvIV_set(dstr, SvIVX(sstr));
10830 SvANY(dstr) = new_XNV();
10831 SvNV_set(dstr, SvNVX(sstr));
10834 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10835 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10838 SvANY(dstr) = new_XPV();
10839 SvCUR_set(dstr, SvCUR(sstr));
10840 SvLEN_set(dstr, SvLEN(sstr));
10841 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10844 SvANY(dstr) = new_XPVIV();
10845 SvCUR_set(dstr, SvCUR(sstr));
10846 SvLEN_set(dstr, SvLEN(sstr));
10847 SvIV_set(dstr, SvIVX(sstr));
10848 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10851 SvANY(dstr) = new_XPVNV();
10852 SvCUR_set(dstr, SvCUR(sstr));
10853 SvLEN_set(dstr, SvLEN(sstr));
10854 SvIV_set(dstr, SvIVX(sstr));
10855 SvNV_set(dstr, SvNVX(sstr));
10856 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10859 SvANY(dstr) = new_XPVMG();
10860 SvCUR_set(dstr, SvCUR(sstr));
10861 SvLEN_set(dstr, SvLEN(sstr));
10862 SvIV_set(dstr, SvIVX(sstr));
10863 SvNV_set(dstr, SvNVX(sstr));
10864 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10865 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10866 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10869 SvANY(dstr) = new_XPVBM();
10870 SvCUR_set(dstr, SvCUR(sstr));
10871 SvLEN_set(dstr, SvLEN(sstr));
10872 SvIV_set(dstr, SvIVX(sstr));
10873 SvNV_set(dstr, SvNVX(sstr));
10874 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10875 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10876 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10877 BmRARE(dstr) = BmRARE(sstr);
10878 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10879 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10882 SvANY(dstr) = new_XPVLV();
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 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10891 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10892 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10893 LvTARG(dstr) = dstr;
10894 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10895 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10897 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10898 LvTYPE(dstr) = LvTYPE(sstr);
10901 if (GvUNIQUE((GV*)sstr)) {
10903 if ((share = gv_share(sstr, param))) {
10906 ptr_table_store(PL_ptr_table, sstr, dstr);
10908 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10909 HvNAME_get(GvSTASH(share)), GvNAME(share));
10914 SvANY(dstr) = new_XPVGV();
10915 SvCUR_set(dstr, SvCUR(sstr));
10916 SvLEN_set(dstr, SvLEN(sstr));
10917 SvIV_set(dstr, SvIVX(sstr));
10918 SvNV_set(dstr, SvNVX(sstr));
10919 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10920 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10921 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10922 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10923 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10924 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10925 GvFLAGS(dstr) = GvFLAGS(sstr);
10926 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10927 (void)GpREFCNT_inc(GvGP(dstr));
10930 SvANY(dstr) = new_XPVIO();
10931 SvCUR_set(dstr, SvCUR(sstr));
10932 SvLEN_set(dstr, SvLEN(sstr));
10933 SvIV_set(dstr, SvIVX(sstr));
10934 SvNV_set(dstr, SvNVX(sstr));
10935 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10936 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10937 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10938 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10939 if (IoOFP(sstr) == IoIFP(sstr))
10940 IoOFP(dstr) = IoIFP(dstr);
10942 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10943 /* PL_rsfp_filters entries have fake IoDIRP() */
10944 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10945 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10947 IoDIRP(dstr) = IoDIRP(sstr);
10948 IoLINES(dstr) = IoLINES(sstr);
10949 IoPAGE(dstr) = IoPAGE(sstr);
10950 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10951 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10952 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10953 /* I have no idea why fake dirp (rsfps)
10954 should be treaded differently but otherwise
10955 we end up with leaks -- sky*/
10956 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10957 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10958 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10960 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10961 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10962 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10964 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10965 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10966 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10967 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10968 IoTYPE(dstr) = IoTYPE(sstr);
10969 IoFLAGS(dstr) = IoFLAGS(sstr);
10972 SvANY(dstr) = new_XPVAV();
10973 SvCUR_set(dstr, SvCUR(sstr));
10974 SvLEN_set(dstr, SvLEN(sstr));
10975 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10976 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10977 if (AvARRAY((AV*)sstr)) {
10978 SV **dst_ary, **src_ary;
10979 SSize_t items = AvFILLp((AV*)sstr) + 1;
10981 src_ary = AvARRAY((AV*)sstr);
10982 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10983 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10984 SvPV_set(dstr, (char*)dst_ary);
10985 AvALLOC((AV*)dstr) = dst_ary;
10986 if (AvREAL((AV*)sstr)) {
10987 while (items-- > 0)
10988 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10991 while (items-- > 0)
10992 *dst_ary++ = sv_dup(*src_ary++, param);
10994 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10995 while (items-- > 0) {
10996 *dst_ary++ = &PL_sv_undef;
11000 SvPV_set(dstr, Nullch);
11001 AvALLOC((AV*)dstr) = (SV**)NULL;
11005 SvANY(dstr) = new_XPVHV();
11006 SvCUR_set(dstr, SvCUR(sstr));
11007 SvLEN_set(dstr, SvLEN(sstr));
11008 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
11009 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11010 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11014 if (HvARRAY((HV*)sstr)) {
11016 const bool sharekeys = !!HvSHAREKEYS(sstr);
11017 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11018 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11021 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11022 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
11023 HvARRAY(dstr) = (HE**)darray;
11024 while (i <= sxhv->xhv_max) {
11025 HE *source = HvARRAY(sstr)[i];
11027 = source ? he_dup(source, sharekeys, param) : 0;
11031 struct xpvhv_aux *saux = HvAUX(sstr);
11032 struct xpvhv_aux *daux = HvAUX(dstr);
11033 /* This flag isn't copied. */
11034 /* SvOOK_on(hv) attacks the IV flags. */
11035 SvFLAGS(dstr) |= SVf_OOK;
11037 hvname = saux->xhv_name;
11038 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11040 daux->xhv_riter = saux->xhv_riter;
11041 daux->xhv_eiter = saux->xhv_eiter
11042 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11047 SvPV_set(dstr, Nullch);
11049 /* Record stashes for possible cloning in Perl_clone(). */
11051 av_push(param->stashes, dstr);
11055 SvANY(dstr) = new_XPVFM();
11056 FmLINES(dstr) = FmLINES(sstr);
11060 SvANY(dstr) = new_XPVCV();
11062 SvCUR_set(dstr, SvCUR(sstr));
11063 SvLEN_set(dstr, SvLEN(sstr));
11064 SvIV_set(dstr, SvIVX(sstr));
11065 SvNV_set(dstr, SvNVX(sstr));
11066 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11067 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11068 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11069 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11070 CvSTART(dstr) = CvSTART(sstr);
11072 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11074 CvXSUB(dstr) = CvXSUB(sstr);
11075 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11076 if (CvCONST(sstr)) {
11077 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11078 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11079 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11081 /* don't dup if copying back - CvGV isn't refcounted, so the
11082 * duped GV may never be freed. A bit of a hack! DAPM */
11083 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11084 Nullgv : gv_dup(CvGV(sstr), param) ;
11085 if (param->flags & CLONEf_COPY_STACKS) {
11086 CvDEPTH(dstr) = CvDEPTH(sstr);
11090 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11091 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11093 CvWEAKOUTSIDE(sstr)
11094 ? cv_dup( CvOUTSIDE(sstr), param)
11095 : cv_dup_inc(CvOUTSIDE(sstr), param);
11096 CvFLAGS(dstr) = CvFLAGS(sstr);
11097 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11100 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11104 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11110 /* duplicate a context */
11113 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11115 PERL_CONTEXT *ncxs;
11118 return (PERL_CONTEXT*)NULL;
11120 /* look for it in the table first */
11121 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11125 /* create anew and remember what it is */
11126 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11127 ptr_table_store(PL_ptr_table, cxs, ncxs);
11130 PERL_CONTEXT *cx = &cxs[ix];
11131 PERL_CONTEXT *ncx = &ncxs[ix];
11132 ncx->cx_type = cx->cx_type;
11133 if (CxTYPE(cx) == CXt_SUBST) {
11134 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11137 ncx->blk_oldsp = cx->blk_oldsp;
11138 ncx->blk_oldcop = cx->blk_oldcop;
11139 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11140 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11141 ncx->blk_oldpm = cx->blk_oldpm;
11142 ncx->blk_gimme = cx->blk_gimme;
11143 switch (CxTYPE(cx)) {
11145 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11146 ? cv_dup_inc(cx->blk_sub.cv, param)
11147 : cv_dup(cx->blk_sub.cv,param));
11148 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11149 ? av_dup_inc(cx->blk_sub.argarray, param)
11151 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11152 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11153 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11154 ncx->blk_sub.lval = cx->blk_sub.lval;
11155 ncx->blk_sub.retop = cx->blk_sub.retop;
11158 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11159 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11160 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11161 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11162 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11163 ncx->blk_eval.retop = cx->blk_eval.retop;
11166 ncx->blk_loop.label = cx->blk_loop.label;
11167 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11168 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11169 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11170 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11171 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11172 ? cx->blk_loop.iterdata
11173 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11174 ncx->blk_loop.oldcomppad
11175 = (PAD*)ptr_table_fetch(PL_ptr_table,
11176 cx->blk_loop.oldcomppad);
11177 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11178 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11179 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11180 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11181 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11184 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11185 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11186 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11187 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11188 ncx->blk_sub.retop = cx->blk_sub.retop;
11200 /* duplicate a stack info structure */
11203 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11208 return (PERL_SI*)NULL;
11210 /* look for it in the table first */
11211 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11215 /* create anew and remember what it is */
11216 Newz(56, nsi, 1, PERL_SI);
11217 ptr_table_store(PL_ptr_table, si, nsi);
11219 nsi->si_stack = av_dup_inc(si->si_stack, param);
11220 nsi->si_cxix = si->si_cxix;
11221 nsi->si_cxmax = si->si_cxmax;
11222 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11223 nsi->si_type = si->si_type;
11224 nsi->si_prev = si_dup(si->si_prev, param);
11225 nsi->si_next = si_dup(si->si_next, param);
11226 nsi->si_markoff = si->si_markoff;
11231 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11232 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11233 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11234 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11235 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11236 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11237 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11238 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11239 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11240 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11241 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11242 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11243 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11244 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11247 #define pv_dup_inc(p) SAVEPV(p)
11248 #define pv_dup(p) SAVEPV(p)
11249 #define svp_dup_inc(p,pp) any_dup(p,pp)
11251 /* map any object to the new equivent - either something in the
11252 * ptr table, or something in the interpreter structure
11256 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11261 return (void*)NULL;
11263 /* look for it in the table first */
11264 ret = ptr_table_fetch(PL_ptr_table, v);
11268 /* see if it is part of the interpreter structure */
11269 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11270 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11278 /* duplicate the save stack */
11281 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11283 ANY *ss = proto_perl->Tsavestack;
11284 I32 ix = proto_perl->Tsavestack_ix;
11285 I32 max = proto_perl->Tsavestack_max;
11297 void (*dptr) (void*);
11298 void (*dxptr) (pTHX_ void*);
11301 Newz(54, nss, max, ANY);
11304 I32 i = POPINT(ss,ix);
11305 TOPINT(nss,ix) = i;
11307 case SAVEt_ITEM: /* normal string */
11308 sv = (SV*)POPPTR(ss,ix);
11309 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11310 sv = (SV*)POPPTR(ss,ix);
11311 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11313 case SAVEt_SV: /* scalar reference */
11314 sv = (SV*)POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11316 gv = (GV*)POPPTR(ss,ix);
11317 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11319 case SAVEt_GENERIC_PVREF: /* generic char* */
11320 c = (char*)POPPTR(ss,ix);
11321 TOPPTR(nss,ix) = pv_dup(c);
11322 ptr = POPPTR(ss,ix);
11323 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11325 case SAVEt_SHARED_PVREF: /* char* in shared space */
11326 c = (char*)POPPTR(ss,ix);
11327 TOPPTR(nss,ix) = savesharedpv(c);
11328 ptr = POPPTR(ss,ix);
11329 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11331 case SAVEt_GENERIC_SVREF: /* generic sv */
11332 case SAVEt_SVREF: /* scalar reference */
11333 sv = (SV*)POPPTR(ss,ix);
11334 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11335 ptr = POPPTR(ss,ix);
11336 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11338 case SAVEt_AV: /* array reference */
11339 av = (AV*)POPPTR(ss,ix);
11340 TOPPTR(nss,ix) = av_dup_inc(av, param);
11341 gv = (GV*)POPPTR(ss,ix);
11342 TOPPTR(nss,ix) = gv_dup(gv, param);
11344 case SAVEt_HV: /* hash reference */
11345 hv = (HV*)POPPTR(ss,ix);
11346 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11347 gv = (GV*)POPPTR(ss,ix);
11348 TOPPTR(nss,ix) = gv_dup(gv, param);
11350 case SAVEt_INT: /* int reference */
11351 ptr = POPPTR(ss,ix);
11352 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11353 intval = (int)POPINT(ss,ix);
11354 TOPINT(nss,ix) = intval;
11356 case SAVEt_LONG: /* long reference */
11357 ptr = POPPTR(ss,ix);
11358 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11359 longval = (long)POPLONG(ss,ix);
11360 TOPLONG(nss,ix) = longval;
11362 case SAVEt_I32: /* I32 reference */
11363 case SAVEt_I16: /* I16 reference */
11364 case SAVEt_I8: /* I8 reference */
11365 ptr = POPPTR(ss,ix);
11366 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11368 TOPINT(nss,ix) = i;
11370 case SAVEt_IV: /* IV reference */
11371 ptr = POPPTR(ss,ix);
11372 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11374 TOPIV(nss,ix) = iv;
11376 case SAVEt_SPTR: /* SV* reference */
11377 ptr = POPPTR(ss,ix);
11378 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11379 sv = (SV*)POPPTR(ss,ix);
11380 TOPPTR(nss,ix) = sv_dup(sv, param);
11382 case SAVEt_VPTR: /* random* reference */
11383 ptr = POPPTR(ss,ix);
11384 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11385 ptr = POPPTR(ss,ix);
11386 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11388 case SAVEt_PPTR: /* char* reference */
11389 ptr = POPPTR(ss,ix);
11390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11391 c = (char*)POPPTR(ss,ix);
11392 TOPPTR(nss,ix) = pv_dup(c);
11394 case SAVEt_HPTR: /* HV* reference */
11395 ptr = POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11397 hv = (HV*)POPPTR(ss,ix);
11398 TOPPTR(nss,ix) = hv_dup(hv, param);
11400 case SAVEt_APTR: /* AV* reference */
11401 ptr = POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11403 av = (AV*)POPPTR(ss,ix);
11404 TOPPTR(nss,ix) = av_dup(av, param);
11407 gv = (GV*)POPPTR(ss,ix);
11408 TOPPTR(nss,ix) = gv_dup(gv, param);
11410 case SAVEt_GP: /* scalar reference */
11411 gp = (GP*)POPPTR(ss,ix);
11412 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11413 (void)GpREFCNT_inc(gp);
11414 gv = (GV*)POPPTR(ss,ix);
11415 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11416 c = (char*)POPPTR(ss,ix);
11417 TOPPTR(nss,ix) = pv_dup(c);
11419 TOPIV(nss,ix) = iv;
11421 TOPIV(nss,ix) = iv;
11424 case SAVEt_MORTALIZESV:
11425 sv = (SV*)POPPTR(ss,ix);
11426 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11429 ptr = POPPTR(ss,ix);
11430 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11431 /* these are assumed to be refcounted properly */
11432 switch (((OP*)ptr)->op_type) {
11434 case OP_LEAVESUBLV:
11438 case OP_LEAVEWRITE:
11439 TOPPTR(nss,ix) = ptr;
11444 TOPPTR(nss,ix) = Nullop;
11449 TOPPTR(nss,ix) = Nullop;
11452 c = (char*)POPPTR(ss,ix);
11453 TOPPTR(nss,ix) = pv_dup_inc(c);
11455 case SAVEt_CLEARSV:
11456 longval = POPLONG(ss,ix);
11457 TOPLONG(nss,ix) = longval;
11460 hv = (HV*)POPPTR(ss,ix);
11461 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11462 c = (char*)POPPTR(ss,ix);
11463 TOPPTR(nss,ix) = pv_dup_inc(c);
11465 TOPINT(nss,ix) = i;
11467 case SAVEt_DESTRUCTOR:
11468 ptr = POPPTR(ss,ix);
11469 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11470 dptr = POPDPTR(ss,ix);
11471 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11472 any_dup(FPTR2DPTR(void *, dptr),
11475 case SAVEt_DESTRUCTOR_X:
11476 ptr = POPPTR(ss,ix);
11477 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11478 dxptr = POPDXPTR(ss,ix);
11479 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11480 any_dup(FPTR2DPTR(void *, dxptr),
11483 case SAVEt_REGCONTEXT:
11486 TOPINT(nss,ix) = i;
11489 case SAVEt_STACK_POS: /* Position on Perl stack */
11491 TOPINT(nss,ix) = i;
11493 case SAVEt_AELEM: /* array element */
11494 sv = (SV*)POPPTR(ss,ix);
11495 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11497 TOPINT(nss,ix) = i;
11498 av = (AV*)POPPTR(ss,ix);
11499 TOPPTR(nss,ix) = av_dup_inc(av, param);
11501 case SAVEt_HELEM: /* hash element */
11502 sv = (SV*)POPPTR(ss,ix);
11503 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11504 sv = (SV*)POPPTR(ss,ix);
11505 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11506 hv = (HV*)POPPTR(ss,ix);
11507 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11510 ptr = POPPTR(ss,ix);
11511 TOPPTR(nss,ix) = ptr;
11515 TOPINT(nss,ix) = i;
11517 case SAVEt_COMPPAD:
11518 av = (AV*)POPPTR(ss,ix);
11519 TOPPTR(nss,ix) = av_dup(av, param);
11522 longval = (long)POPLONG(ss,ix);
11523 TOPLONG(nss,ix) = longval;
11524 ptr = POPPTR(ss,ix);
11525 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11526 sv = (SV*)POPPTR(ss,ix);
11527 TOPPTR(nss,ix) = sv_dup(sv, param);
11530 ptr = POPPTR(ss,ix);
11531 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11532 longval = (long)POPBOOL(ss,ix);
11533 TOPBOOL(nss,ix) = (bool)longval;
11535 case SAVEt_SET_SVFLAGS:
11537 TOPINT(nss,ix) = i;
11539 TOPINT(nss,ix) = i;
11540 sv = (SV*)POPPTR(ss,ix);
11541 TOPPTR(nss,ix) = sv_dup(sv, param);
11544 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11552 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11553 * flag to the result. This is done for each stash before cloning starts,
11554 * so we know which stashes want their objects cloned */
11557 do_mark_cloneable_stash(pTHX_ SV *sv)
11559 const HEK *hvname = HvNAME_HEK((HV*)sv);
11561 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11562 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11563 if (cloner && GvCV(cloner)) {
11570 XPUSHs(sv_2mortal(newSVhek(hvname)));
11572 call_sv((SV*)GvCV(cloner), G_SCALAR);
11579 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11587 =for apidoc perl_clone
11589 Create and return a new interpreter by cloning the current one.
11591 perl_clone takes these flags as parameters:
11593 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11594 without it we only clone the data and zero the stacks,
11595 with it we copy the stacks and the new perl interpreter is
11596 ready to run at the exact same point as the previous one.
11597 The pseudo-fork code uses COPY_STACKS while the
11598 threads->new doesn't.
11600 CLONEf_KEEP_PTR_TABLE
11601 perl_clone keeps a ptr_table with the pointer of the old
11602 variable as a key and the new variable as a value,
11603 this allows it to check if something has been cloned and not
11604 clone it again but rather just use the value and increase the
11605 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11606 the ptr_table using the function
11607 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11608 reason to keep it around is if you want to dup some of your own
11609 variable who are outside the graph perl scans, example of this
11610 code is in threads.xs create
11613 This is a win32 thing, it is ignored on unix, it tells perls
11614 win32host code (which is c++) to clone itself, this is needed on
11615 win32 if you want to run two threads at the same time,
11616 if you just want to do some stuff in a separate perl interpreter
11617 and then throw it away and return to the original one,
11618 you don't need to do anything.
11623 /* XXX the above needs expanding by someone who actually understands it ! */
11624 EXTERN_C PerlInterpreter *
11625 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11628 perl_clone(PerlInterpreter *proto_perl, UV flags)
11631 #ifdef PERL_IMPLICIT_SYS
11633 /* perlhost.h so we need to call into it
11634 to clone the host, CPerlHost should have a c interface, sky */
11636 if (flags & CLONEf_CLONE_HOST) {
11637 return perl_clone_host(proto_perl,flags);
11639 return perl_clone_using(proto_perl, flags,
11641 proto_perl->IMemShared,
11642 proto_perl->IMemParse,
11644 proto_perl->IStdIO,
11648 proto_perl->IProc);
11652 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11653 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11654 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11655 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11656 struct IPerlDir* ipD, struct IPerlSock* ipS,
11657 struct IPerlProc* ipP)
11659 /* XXX many of the string copies here can be optimized if they're
11660 * constants; they need to be allocated as common memory and just
11661 * their pointers copied. */
11664 CLONE_PARAMS clone_params;
11665 CLONE_PARAMS* param = &clone_params;
11667 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11668 /* for each stash, determine whether its objects should be cloned */
11669 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11670 PERL_SET_THX(my_perl);
11673 Poison(my_perl, 1, PerlInterpreter);
11675 PL_curcop = (COP *)Nullop;
11679 PL_savestack_ix = 0;
11680 PL_savestack_max = -1;
11681 PL_sig_pending = 0;
11682 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11683 # else /* !DEBUGGING */
11684 Zero(my_perl, 1, PerlInterpreter);
11685 # endif /* DEBUGGING */
11687 /* host pointers */
11689 PL_MemShared = ipMS;
11690 PL_MemParse = ipMP;
11697 #else /* !PERL_IMPLICIT_SYS */
11699 CLONE_PARAMS clone_params;
11700 CLONE_PARAMS* param = &clone_params;
11701 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11702 /* for each stash, determine whether its objects should be cloned */
11703 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11704 PERL_SET_THX(my_perl);
11707 Poison(my_perl, 1, PerlInterpreter);
11709 PL_curcop = (COP *)Nullop;
11713 PL_savestack_ix = 0;
11714 PL_savestack_max = -1;
11715 PL_sig_pending = 0;
11716 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11717 # else /* !DEBUGGING */
11718 Zero(my_perl, 1, PerlInterpreter);
11719 # endif /* DEBUGGING */
11720 #endif /* PERL_IMPLICIT_SYS */
11721 param->flags = flags;
11722 param->proto_perl = proto_perl;
11725 PL_xnv_arenaroot = NULL;
11726 PL_xnv_root = NULL;
11727 PL_xpv_arenaroot = NULL;
11728 PL_xpv_root = NULL;
11729 PL_xpviv_arenaroot = NULL;
11730 PL_xpviv_root = NULL;
11731 PL_xpvnv_arenaroot = NULL;
11732 PL_xpvnv_root = NULL;
11733 PL_xpvcv_arenaroot = NULL;
11734 PL_xpvcv_root = NULL;
11735 PL_xpvav_arenaroot = NULL;
11736 PL_xpvav_root = NULL;
11737 PL_xpvhv_arenaroot = NULL;
11738 PL_xpvhv_root = NULL;
11739 PL_xpvmg_arenaroot = NULL;
11740 PL_xpvmg_root = NULL;
11741 PL_xpvgv_arenaroot = NULL;
11742 PL_xpvgv_root = NULL;
11743 PL_xpvlv_arenaroot = NULL;
11744 PL_xpvlv_root = NULL;
11745 PL_xpvbm_arenaroot = NULL;
11746 PL_xpvbm_root = NULL;
11747 PL_he_arenaroot = NULL;
11749 #if defined(USE_ITHREADS)
11750 PL_pte_arenaroot = NULL;
11751 PL_pte_root = NULL;
11753 PL_nice_chunk = NULL;
11754 PL_nice_chunk_size = 0;
11756 PL_sv_objcount = 0;
11757 PL_sv_root = Nullsv;
11758 PL_sv_arenaroot = Nullsv;
11760 PL_debug = proto_perl->Idebug;
11762 PL_hash_seed = proto_perl->Ihash_seed;
11763 PL_rehash_seed = proto_perl->Irehash_seed;
11765 #ifdef USE_REENTRANT_API
11766 /* XXX: things like -Dm will segfault here in perlio, but doing
11767 * PERL_SET_CONTEXT(proto_perl);
11768 * breaks too many other things
11770 Perl_reentrant_init(aTHX);
11773 /* create SV map for pointer relocation */
11774 PL_ptr_table = ptr_table_new();
11776 /* initialize these special pointers as early as possible */
11777 SvANY(&PL_sv_undef) = NULL;
11778 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11779 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11780 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11782 SvANY(&PL_sv_no) = new_XPVNV();
11783 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11784 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11785 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11786 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11787 SvCUR_set(&PL_sv_no, 0);
11788 SvLEN_set(&PL_sv_no, 1);
11789 SvIV_set(&PL_sv_no, 0);
11790 SvNV_set(&PL_sv_no, 0);
11791 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11793 SvANY(&PL_sv_yes) = new_XPVNV();
11794 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11795 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11796 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11797 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11798 SvCUR_set(&PL_sv_yes, 1);
11799 SvLEN_set(&PL_sv_yes, 2);
11800 SvIV_set(&PL_sv_yes, 1);
11801 SvNV_set(&PL_sv_yes, 1);
11802 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11804 /* create (a non-shared!) shared string table */
11805 PL_strtab = newHV();
11806 HvSHAREKEYS_off(PL_strtab);
11807 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11808 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11810 PL_compiling = proto_perl->Icompiling;
11812 /* These two PVs will be free'd special way so must set them same way op.c does */
11813 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11814 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11816 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11817 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11819 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11820 if (!specialWARN(PL_compiling.cop_warnings))
11821 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11822 if (!specialCopIO(PL_compiling.cop_io))
11823 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11824 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11826 /* pseudo environmental stuff */
11827 PL_origargc = proto_perl->Iorigargc;
11828 PL_origargv = proto_perl->Iorigargv;
11830 param->stashes = newAV(); /* Setup array of objects to call clone on */
11832 #ifdef PERLIO_LAYERS
11833 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11834 PerlIO_clone(aTHX_ proto_perl, param);
11837 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11838 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11839 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11840 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11841 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11842 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11845 PL_minus_c = proto_perl->Iminus_c;
11846 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11847 PL_localpatches = proto_perl->Ilocalpatches;
11848 PL_splitstr = proto_perl->Isplitstr;
11849 PL_preprocess = proto_perl->Ipreprocess;
11850 PL_minus_n = proto_perl->Iminus_n;
11851 PL_minus_p = proto_perl->Iminus_p;
11852 PL_minus_l = proto_perl->Iminus_l;
11853 PL_minus_a = proto_perl->Iminus_a;
11854 PL_minus_F = proto_perl->Iminus_F;
11855 PL_doswitches = proto_perl->Idoswitches;
11856 PL_dowarn = proto_perl->Idowarn;
11857 PL_doextract = proto_perl->Idoextract;
11858 PL_sawampersand = proto_perl->Isawampersand;
11859 PL_unsafe = proto_perl->Iunsafe;
11860 PL_inplace = SAVEPV(proto_perl->Iinplace);
11861 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11862 PL_perldb = proto_perl->Iperldb;
11863 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11864 PL_exit_flags = proto_perl->Iexit_flags;
11866 /* magical thingies */
11867 /* XXX time(&PL_basetime) when asked for? */
11868 PL_basetime = proto_perl->Ibasetime;
11869 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11871 PL_maxsysfd = proto_perl->Imaxsysfd;
11872 PL_multiline = proto_perl->Imultiline;
11873 PL_statusvalue = proto_perl->Istatusvalue;
11875 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11877 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11879 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11880 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11881 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11883 /* Clone the regex array */
11884 PL_regex_padav = newAV();
11886 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11887 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11889 av_push(PL_regex_padav,
11890 sv_dup_inc(regexen[0],param));
11891 for(i = 1; i <= len; i++) {
11892 if(SvREPADTMP(regexen[i])) {
11893 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11895 av_push(PL_regex_padav,
11897 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11898 SvIVX(regexen[i])), param)))
11903 PL_regex_pad = AvARRAY(PL_regex_padav);
11905 /* shortcuts to various I/O objects */
11906 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11907 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11908 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11909 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11910 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11911 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11913 /* shortcuts to regexp stuff */
11914 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11916 /* shortcuts to misc objects */
11917 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11919 /* shortcuts to debugging objects */
11920 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11921 PL_DBline = gv_dup(proto_perl->IDBline, param);
11922 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11923 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11924 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11925 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11926 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11927 PL_lineary = av_dup(proto_perl->Ilineary, param);
11928 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11930 /* symbol tables */
11931 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11932 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11933 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11934 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11935 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11937 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11938 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11939 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11940 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11941 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11942 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11944 PL_sub_generation = proto_perl->Isub_generation;
11946 /* funky return mechanisms */
11947 PL_forkprocess = proto_perl->Iforkprocess;
11949 /* subprocess state */
11950 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11952 /* internal state */
11953 PL_tainting = proto_perl->Itainting;
11954 PL_taint_warn = proto_perl->Itaint_warn;
11955 PL_maxo = proto_perl->Imaxo;
11956 if (proto_perl->Iop_mask)
11957 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11959 PL_op_mask = Nullch;
11960 /* PL_asserting = proto_perl->Iasserting; */
11962 /* current interpreter roots */
11963 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11964 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11965 PL_main_start = proto_perl->Imain_start;
11966 PL_eval_root = proto_perl->Ieval_root;
11967 PL_eval_start = proto_perl->Ieval_start;
11969 /* runtime control stuff */
11970 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11971 PL_copline = proto_perl->Icopline;
11973 PL_filemode = proto_perl->Ifilemode;
11974 PL_lastfd = proto_perl->Ilastfd;
11975 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11978 PL_gensym = proto_perl->Igensym;
11979 PL_preambled = proto_perl->Ipreambled;
11980 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11981 PL_laststatval = proto_perl->Ilaststatval;
11982 PL_laststype = proto_perl->Ilaststype;
11983 PL_mess_sv = Nullsv;
11985 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11986 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11988 /* interpreter atexit processing */
11989 PL_exitlistlen = proto_perl->Iexitlistlen;
11990 if (PL_exitlistlen) {
11991 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11992 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11995 PL_exitlist = (PerlExitListEntry*)NULL;
11996 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11997 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11998 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12000 PL_profiledata = NULL;
12001 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
12002 /* PL_rsfp_filters entries have fake IoDIRP() */
12003 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
12005 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12007 PAD_CLONE_VARS(proto_perl, param);
12009 #ifdef HAVE_INTERP_INTERN
12010 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12013 /* more statics moved here */
12014 PL_generation = proto_perl->Igeneration;
12015 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12017 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12018 PL_in_clean_all = proto_perl->Iin_clean_all;
12020 PL_uid = proto_perl->Iuid;
12021 PL_euid = proto_perl->Ieuid;
12022 PL_gid = proto_perl->Igid;
12023 PL_egid = proto_perl->Iegid;
12024 PL_nomemok = proto_perl->Inomemok;
12025 PL_an = proto_perl->Ian;
12026 PL_evalseq = proto_perl->Ievalseq;
12027 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12028 PL_origalen = proto_perl->Iorigalen;
12029 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12030 PL_osname = SAVEPV(proto_perl->Iosname);
12031 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12032 PL_sighandlerp = proto_perl->Isighandlerp;
12035 PL_runops = proto_perl->Irunops;
12037 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12040 PL_cshlen = proto_perl->Icshlen;
12041 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12044 PL_lex_state = proto_perl->Ilex_state;
12045 PL_lex_defer = proto_perl->Ilex_defer;
12046 PL_lex_expect = proto_perl->Ilex_expect;
12047 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12048 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12049 PL_lex_starts = proto_perl->Ilex_starts;
12050 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12051 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12052 PL_lex_op = proto_perl->Ilex_op;
12053 PL_lex_inpat = proto_perl->Ilex_inpat;
12054 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12055 PL_lex_brackets = proto_perl->Ilex_brackets;
12056 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12057 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12058 PL_lex_casemods = proto_perl->Ilex_casemods;
12059 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12060 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12062 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12063 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12064 PL_nexttoke = proto_perl->Inexttoke;
12066 /* XXX This is probably masking the deeper issue of why
12067 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12068 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12069 * (A little debugging with a watchpoint on it may help.)
12071 if (SvANY(proto_perl->Ilinestr)) {
12072 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12073 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12074 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12075 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12076 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12077 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12078 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12079 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12080 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12083 PL_linestr = NEWSV(65,79);
12084 sv_upgrade(PL_linestr,SVt_PVIV);
12085 sv_setpvn(PL_linestr,"",0);
12086 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12088 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12089 PL_pending_ident = proto_perl->Ipending_ident;
12090 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12092 PL_expect = proto_perl->Iexpect;
12094 PL_multi_start = proto_perl->Imulti_start;
12095 PL_multi_end = proto_perl->Imulti_end;
12096 PL_multi_open = proto_perl->Imulti_open;
12097 PL_multi_close = proto_perl->Imulti_close;
12099 PL_error_count = proto_perl->Ierror_count;
12100 PL_subline = proto_perl->Isubline;
12101 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12103 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12104 if (SvANY(proto_perl->Ilinestr)) {
12105 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12106 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12107 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12108 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12109 PL_last_lop_op = proto_perl->Ilast_lop_op;
12112 PL_last_uni = SvPVX(PL_linestr);
12113 PL_last_lop = SvPVX(PL_linestr);
12114 PL_last_lop_op = 0;
12116 PL_in_my = proto_perl->Iin_my;
12117 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12119 PL_cryptseen = proto_perl->Icryptseen;
12122 PL_hints = proto_perl->Ihints;
12124 PL_amagic_generation = proto_perl->Iamagic_generation;
12126 #ifdef USE_LOCALE_COLLATE
12127 PL_collation_ix = proto_perl->Icollation_ix;
12128 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12129 PL_collation_standard = proto_perl->Icollation_standard;
12130 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12131 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12132 #endif /* USE_LOCALE_COLLATE */
12134 #ifdef USE_LOCALE_NUMERIC
12135 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12136 PL_numeric_standard = proto_perl->Inumeric_standard;
12137 PL_numeric_local = proto_perl->Inumeric_local;
12138 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12139 #endif /* !USE_LOCALE_NUMERIC */
12141 /* utf8 character classes */
12142 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12143 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12144 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12145 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12146 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12147 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12148 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12149 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12150 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12151 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12152 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12153 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12154 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12155 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12156 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12157 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12158 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12159 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12160 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12161 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12163 /* Did the locale setup indicate UTF-8? */
12164 PL_utf8locale = proto_perl->Iutf8locale;
12165 /* Unicode features (see perlrun/-C) */
12166 PL_unicode = proto_perl->Iunicode;
12168 /* Pre-5.8 signals control */
12169 PL_signals = proto_perl->Isignals;
12171 /* times() ticks per second */
12172 PL_clocktick = proto_perl->Iclocktick;
12174 /* Recursion stopper for PerlIO_find_layer */
12175 PL_in_load_module = proto_perl->Iin_load_module;
12177 /* sort() routine */
12178 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12180 /* Not really needed/useful since the reenrant_retint is "volatile",
12181 * but do it for consistency's sake. */
12182 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12184 /* Hooks to shared SVs and locks. */
12185 PL_sharehook = proto_perl->Isharehook;
12186 PL_lockhook = proto_perl->Ilockhook;
12187 PL_unlockhook = proto_perl->Iunlockhook;
12188 PL_threadhook = proto_perl->Ithreadhook;
12190 PL_runops_std = proto_perl->Irunops_std;
12191 PL_runops_dbg = proto_perl->Irunops_dbg;
12193 #ifdef THREADS_HAVE_PIDS
12194 PL_ppid = proto_perl->Ippid;
12198 PL_last_swash_hv = Nullhv; /* reinits on demand */
12199 PL_last_swash_klen = 0;
12200 PL_last_swash_key[0]= '\0';
12201 PL_last_swash_tmps = (U8*)NULL;
12202 PL_last_swash_slen = 0;
12204 PL_glob_index = proto_perl->Iglob_index;
12205 PL_srand_called = proto_perl->Isrand_called;
12206 PL_uudmap['M'] = 0; /* reinits on demand */
12207 PL_bitcount = Nullch; /* reinits on demand */
12209 if (proto_perl->Ipsig_pend) {
12210 Newz(0, PL_psig_pend, SIG_SIZE, int);
12213 PL_psig_pend = (int*)NULL;
12216 if (proto_perl->Ipsig_ptr) {
12217 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12218 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12219 for (i = 1; i < SIG_SIZE; i++) {
12220 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12221 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12225 PL_psig_ptr = (SV**)NULL;
12226 PL_psig_name = (SV**)NULL;
12229 /* thrdvar.h stuff */
12231 if (flags & CLONEf_COPY_STACKS) {
12232 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12233 PL_tmps_ix = proto_perl->Ttmps_ix;
12234 PL_tmps_max = proto_perl->Ttmps_max;
12235 PL_tmps_floor = proto_perl->Ttmps_floor;
12236 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12238 while (i <= PL_tmps_ix) {
12239 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12243 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12244 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12245 Newz(54, PL_markstack, i, I32);
12246 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12247 - proto_perl->Tmarkstack);
12248 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12249 - proto_perl->Tmarkstack);
12250 Copy(proto_perl->Tmarkstack, PL_markstack,
12251 PL_markstack_ptr - PL_markstack + 1, I32);
12253 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12254 * NOTE: unlike the others! */
12255 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12256 PL_scopestack_max = proto_perl->Tscopestack_max;
12257 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12258 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12260 /* NOTE: si_dup() looks at PL_markstack */
12261 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12263 /* PL_curstack = PL_curstackinfo->si_stack; */
12264 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12265 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12267 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12268 PL_stack_base = AvARRAY(PL_curstack);
12269 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12270 - proto_perl->Tstack_base);
12271 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12273 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12274 * NOTE: unlike the others! */
12275 PL_savestack_ix = proto_perl->Tsavestack_ix;
12276 PL_savestack_max = proto_perl->Tsavestack_max;
12277 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12278 PL_savestack = ss_dup(proto_perl, param);
12282 ENTER; /* perl_destruct() wants to LEAVE; */
12285 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12286 PL_top_env = &PL_start_env;
12288 PL_op = proto_perl->Top;
12291 PL_Xpv = (XPV*)NULL;
12292 PL_na = proto_perl->Tna;
12294 PL_statbuf = proto_perl->Tstatbuf;
12295 PL_statcache = proto_perl->Tstatcache;
12296 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12297 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12299 PL_timesbuf = proto_perl->Ttimesbuf;
12302 PL_tainted = proto_perl->Ttainted;
12303 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12304 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12305 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12306 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12307 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12308 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12309 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12310 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12311 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12313 PL_restartop = proto_perl->Trestartop;
12314 PL_in_eval = proto_perl->Tin_eval;
12315 PL_delaymagic = proto_perl->Tdelaymagic;
12316 PL_dirty = proto_perl->Tdirty;
12317 PL_localizing = proto_perl->Tlocalizing;
12319 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12320 PL_hv_fetch_ent_mh = Nullhe;
12321 PL_modcount = proto_perl->Tmodcount;
12322 PL_lastgotoprobe = Nullop;
12323 PL_dumpindent = proto_perl->Tdumpindent;
12325 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12326 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12327 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12328 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12329 PL_sortcxix = proto_perl->Tsortcxix;
12330 PL_efloatbuf = Nullch; /* reinits on demand */
12331 PL_efloatsize = 0; /* reinits on demand */
12335 PL_screamfirst = NULL;
12336 PL_screamnext = NULL;
12337 PL_maxscream = -1; /* reinits on demand */
12338 PL_lastscream = Nullsv;
12340 PL_watchaddr = NULL;
12341 PL_watchok = Nullch;
12343 PL_regdummy = proto_perl->Tregdummy;
12344 PL_regprecomp = Nullch;
12347 PL_colorset = 0; /* reinits PL_colors[] */
12348 /*PL_colors[6] = {0,0,0,0,0,0};*/
12349 PL_reginput = Nullch;
12350 PL_regbol = Nullch;
12351 PL_regeol = Nullch;
12352 PL_regstartp = (I32*)NULL;
12353 PL_regendp = (I32*)NULL;
12354 PL_reglastparen = (U32*)NULL;
12355 PL_reglastcloseparen = (U32*)NULL;
12356 PL_regtill = Nullch;
12357 PL_reg_start_tmp = (char**)NULL;
12358 PL_reg_start_tmpl = 0;
12359 PL_regdata = (struct reg_data*)NULL;
12362 PL_reg_eval_set = 0;
12364 PL_regprogram = (regnode*)NULL;
12366 PL_regcc = (CURCUR*)NULL;
12367 PL_reg_call_cc = (struct re_cc_state*)NULL;
12368 PL_reg_re = (regexp*)NULL;
12369 PL_reg_ganch = Nullch;
12370 PL_reg_sv = Nullsv;
12371 PL_reg_match_utf8 = FALSE;
12372 PL_reg_magic = (MAGIC*)NULL;
12374 PL_reg_oldcurpm = (PMOP*)NULL;
12375 PL_reg_curpm = (PMOP*)NULL;
12376 PL_reg_oldsaved = Nullch;
12377 PL_reg_oldsavedlen = 0;
12378 #ifdef PERL_OLD_COPY_ON_WRITE
12381 PL_reg_maxiter = 0;
12382 PL_reg_leftiter = 0;
12383 PL_reg_poscache = Nullch;
12384 PL_reg_poscache_size= 0;
12386 /* RE engine - function pointers */
12387 PL_regcompp = proto_perl->Tregcompp;
12388 PL_regexecp = proto_perl->Tregexecp;
12389 PL_regint_start = proto_perl->Tregint_start;
12390 PL_regint_string = proto_perl->Tregint_string;
12391 PL_regfree = proto_perl->Tregfree;
12393 PL_reginterp_cnt = 0;
12394 PL_reg_starttry = 0;
12396 /* Pluggable optimizer */
12397 PL_peepp = proto_perl->Tpeepp;
12399 PL_stashcache = newHV();
12401 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12402 ptr_table_free(PL_ptr_table);
12403 PL_ptr_table = NULL;
12406 /* Call the ->CLONE method, if it exists, for each of the stashes
12407 identified by sv_dup() above.
12409 while(av_len(param->stashes) != -1) {
12410 HV* stash = (HV*) av_shift(param->stashes);
12411 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12412 if (cloner && GvCV(cloner)) {
12417 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12419 call_sv((SV*)GvCV(cloner), G_DISCARD);
12425 SvREFCNT_dec(param->stashes);
12427 /* orphaned? eg threads->new inside BEGIN or use */
12428 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12429 (void)SvREFCNT_inc(PL_compcv);
12430 SAVEFREESV(PL_compcv);
12436 #endif /* USE_ITHREADS */
12439 =head1 Unicode Support
12441 =for apidoc sv_recode_to_utf8
12443 The encoding is assumed to be an Encode object, on entry the PV
12444 of the sv is assumed to be octets in that encoding, and the sv
12445 will be converted into Unicode (and UTF-8).
12447 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12448 is not a reference, nothing is done to the sv. If the encoding is not
12449 an C<Encode::XS> Encoding object, bad things will happen.
12450 (See F<lib/encoding.pm> and L<Encode>).
12452 The PV of the sv is returned.
12457 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12460 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12474 Passing sv_yes is wrong - it needs to be or'ed set of constants
12475 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12476 remove converted chars from source.
12478 Both will default the value - let them.
12480 XPUSHs(&PL_sv_yes);
12483 call_method("decode", G_SCALAR);
12487 s = SvPV_const(uni, len);
12488 if (s != SvPVX_const(sv)) {
12489 SvGROW(sv, len + 1);
12490 Move(s, SvPVX(sv), len + 1, char);
12491 SvCUR_set(sv, len);
12498 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12502 =for apidoc sv_cat_decode
12504 The encoding is assumed to be an Encode object, the PV of the ssv is
12505 assumed to be octets in that encoding and decoding the input starts
12506 from the position which (PV + *offset) pointed to. The dsv will be
12507 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12508 when the string tstr appears in decoding output or the input ends on
12509 the PV of the ssv. The value which the offset points will be modified
12510 to the last input position on the ssv.
12512 Returns TRUE if the terminator was found, else returns FALSE.
12517 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12518 SV *ssv, int *offset, char *tstr, int tlen)
12522 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12533 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12534 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12536 call_method("cat_decode", G_SCALAR);
12538 ret = SvTRUE(TOPs);
12539 *offset = SvIV(offsv);
12545 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12551 * c-indentation-style: bsd
12552 * c-basic-offset: 4
12553 * indent-tabs-mode: t
12556 * ex: set ts=8 sts=4 sw=4 noet: