3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
763 if (!cv || !CvPADLIST(cv))
765 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
766 sv = *av_fetch(av, targ, FALSE);
767 /* SvLEN in a pad name is not to be trusted */
769 sv_setpvn(name, str, len);
772 if (subscript_type == FUV_SUBSCRIPT_HASH) {
775 Perl_sv_catpvf(aTHX_ name, "{%s}",
776 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
779 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
781 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
783 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
784 sv_insert(name, 0, 0, "within ", 7);
791 =for apidoc find_uninit_var
793 Find the name of the undefined variable (if any) that caused the operator o
794 to issue a "Use of uninitialized value" warning.
795 If match is true, only return a name if it's value matches uninit_sv.
796 So roughly speaking, if a unary operator (such as OP_COS) generates a
797 warning, then following the direct child of the op may yield an
798 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
799 other hand, with OP_ADD there are two branches to follow, so we only print
800 the variable name if we get an exact match.
802 The name is returned as a mortal SV.
804 Assumes that PL_op is the op that originally triggered the error, and that
805 PL_comppad/PL_curpad points to the currently executing pad.
811 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
820 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
821 uninit_sv == &PL_sv_placeholder)))
824 switch (obase->op_type) {
831 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
832 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
835 int subscript_type = FUV_SUBSCRIPT_WITHIN;
837 if (pad) { /* @lex, %lex */
838 sv = PAD_SVl(obase->op_targ);
842 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
843 /* @global, %global */
844 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
847 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
849 else /* @{expr}, %{expr} */
850 return find_uninit_var(cUNOPx(obase)->op_first,
854 /* attempt to find a match within the aggregate */
856 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
858 subscript_type = FUV_SUBSCRIPT_HASH;
861 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
863 subscript_type = FUV_SUBSCRIPT_ARRAY;
866 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
869 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
870 keysv, index, subscript_type);
874 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
876 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
877 Nullsv, 0, FUV_SUBSCRIPT_NONE);
880 gv = cGVOPx_gv(obase);
881 if (!gv || (match && GvSV(gv) != uninit_sv))
883 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
886 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
888 av = (AV*)PAD_SV(obase->op_targ);
889 if (!av || SvRMAGICAL(av))
891 svp = av_fetch(av, (I32)obase->op_private, FALSE);
892 if (!svp || *svp != uninit_sv)
895 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
896 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
899 gv = cGVOPx_gv(obase);
904 if (!av || SvRMAGICAL(av))
906 svp = av_fetch(av, (I32)obase->op_private, FALSE);
907 if (!svp || *svp != uninit_sv)
910 return S_varname(aTHX_ gv, "$", 0,
911 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
916 o = cUNOPx(obase)->op_first;
917 if (!o || o->op_type != OP_NULL ||
918 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
920 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
925 /* $a[uninit_expr] or $h{uninit_expr} */
926 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
929 o = cBINOPx(obase)->op_first;
930 kid = cBINOPx(obase)->op_last;
932 /* get the av or hv, and optionally the gv */
934 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
935 sv = PAD_SV(o->op_targ);
937 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
938 && cUNOPo->op_first->op_type == OP_GV)
940 gv = cGVOPx_gv(cUNOPo->op_first);
943 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
948 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
949 /* index is constant */
953 if (obase->op_type == OP_HELEM) {
954 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
955 if (!he || HeVAL(he) != uninit_sv)
959 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
960 if (!svp || *svp != uninit_sv)
964 if (obase->op_type == OP_HELEM)
965 return S_varname(aTHX_ gv, "%", o->op_targ,
966 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
968 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
969 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
973 /* index is an expression;
974 * attempt to find a match within the aggregate */
975 if (obase->op_type == OP_HELEM) {
976 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
978 return S_varname(aTHX_ gv, "%", o->op_targ,
979 keysv, 0, FUV_SUBSCRIPT_HASH);
982 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
984 return S_varname(aTHX_ gv, "@", o->op_targ,
985 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
989 return S_varname(aTHX_ gv,
990 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
992 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
998 /* only examine RHS */
999 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
1002 o = cUNOPx(obase)->op_first;
1003 if (o->op_type == OP_PUSHMARK)
1006 if (!o->op_sibling) {
1007 /* one-arg version of open is highly magical */
1009 if (o->op_type == OP_GV) { /* open FOO; */
1011 if (match && GvSV(gv) != uninit_sv)
1013 return S_varname(aTHX_ gv, "$", 0,
1014 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1016 /* other possibilities not handled are:
1017 * open $x; or open my $x; should return '${*$x}'
1018 * open expr; should return '$'.expr ideally
1024 /* ops where $_ may be an implicit arg */
1028 if ( !(obase->op_flags & OPf_STACKED)) {
1029 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1030 ? PAD_SVl(obase->op_targ)
1033 sv = sv_newmortal();
1034 sv_setpvn(sv, "$_", 2);
1042 /* skip filehandle as it can't produce 'undef' warning */
1043 o = cUNOPx(obase)->op_first;
1044 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1045 o = o->op_sibling->op_sibling;
1052 match = 1; /* XS or custom code could trigger random warnings */
1057 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1058 return sv_2mortal(newSVpv("${$/}", 0));
1063 if (!(obase->op_flags & OPf_KIDS))
1065 o = cUNOPx(obase)->op_first;
1071 /* if all except one arg are constant, or have no side-effects,
1072 * or are optimized away, then it's unambiguous */
1074 for (kid=o; kid; kid = kid->op_sibling) {
1076 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1077 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1078 || (kid->op_type == OP_PUSHMARK)
1082 if (o2) { /* more than one found */
1089 return find_uninit_var(o2, uninit_sv, match);
1093 sv = find_uninit_var(o, uninit_sv, 1);
1105 =for apidoc report_uninit
1107 Print appropriate "Use of uninitialized variable" warning
1113 Perl_report_uninit(pTHX_ SV* uninit_sv)
1116 SV* varname = Nullsv;
1118 varname = find_uninit_var(PL_op, uninit_sv,0);
1120 sv_insert(varname, 0, 0, " ", 1);
1122 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1123 varname ? SvPV_nolen(varname) : "",
1124 " in ", OP_DESC(PL_op));
1127 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1131 /* allocate another arena's worth of NV bodies */
1139 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1140 *((void **) ptr) = (void *)PL_xnv_arenaroot;
1141 PL_xnv_arenaroot = ptr;
1144 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1145 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1147 while (xnv < xnvend) {
1148 *(NV**)xnv = (NV*)(xnv + 1);
1154 /* allocate another arena's worth of struct xpv */
1160 xpv_allocated* xpvend;
1161 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1162 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
1163 PL_xpv_arenaroot = xpv;
1165 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
1166 PL_xpv_root = ++xpv;
1167 while (xpv < xpvend) {
1168 *((xpv_allocated**)xpv) = xpv + 1;
1171 *((xpv_allocated**)xpv) = 0;
1174 /* allocate another arena's worth of struct xpviv */
1179 xpviv_allocated* xpviv;
1180 xpviv_allocated* xpvivend;
1181 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1182 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
1183 PL_xpviv_arenaroot = xpviv;
1185 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
1186 PL_xpviv_root = ++xpviv;
1187 while (xpviv < xpvivend) {
1188 *((xpviv_allocated**)xpviv) = xpviv + 1;
1191 *((xpviv_allocated**)xpviv) = 0;
1194 /* allocate another arena's worth of struct xpvnv */
1201 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1202 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
1203 PL_xpvnv_arenaroot = xpvnv;
1205 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1206 PL_xpvnv_root = ++xpvnv;
1207 while (xpvnv < xpvnvend) {
1208 *((XPVNV**)xpvnv) = xpvnv + 1;
1211 *((XPVNV**)xpvnv) = 0;
1214 /* allocate another arena's worth of struct xpvcv */
1221 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1222 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
1223 PL_xpvcv_arenaroot = xpvcv;
1225 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1226 PL_xpvcv_root = ++xpvcv;
1227 while (xpvcv < xpvcvend) {
1228 *((XPVCV**)xpvcv) = xpvcv + 1;
1231 *((XPVCV**)xpvcv) = 0;
1234 /* allocate another arena's worth of struct xpvav */
1239 xpvav_allocated* xpvav;
1240 xpvav_allocated* xpvavend;
1241 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1243 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
1244 PL_xpvav_arenaroot = xpvav;
1246 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
1247 PL_xpvav_root = ++xpvav;
1248 while (xpvav < xpvavend) {
1249 *((xpvav_allocated**)xpvav) = xpvav + 1;
1252 *((xpvav_allocated**)xpvav) = 0;
1255 /* allocate another arena's worth of struct xpvhv */
1260 xpvhv_allocated* xpvhv;
1261 xpvhv_allocated* xpvhvend;
1262 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1264 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
1265 PL_xpvhv_arenaroot = xpvhv;
1267 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
1268 PL_xpvhv_root = ++xpvhv;
1269 while (xpvhv < xpvhvend) {
1270 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
1273 *((xpvhv_allocated**)xpvhv) = 0;
1276 /* allocate another arena's worth of struct xpvmg */
1283 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1284 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1285 PL_xpvmg_arenaroot = xpvmg;
1287 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1288 PL_xpvmg_root = ++xpvmg;
1289 while (xpvmg < xpvmgend) {
1290 *((XPVMG**)xpvmg) = xpvmg + 1;
1293 *((XPVMG**)xpvmg) = 0;
1296 /* allocate another arena's worth of struct xpvgv */
1303 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1304 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1305 PL_xpvgv_arenaroot = xpvgv;
1307 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1308 PL_xpvgv_root = ++xpvgv;
1309 while (xpvgv < xpvgvend) {
1310 *((XPVGV**)xpvgv) = xpvgv + 1;
1313 *((XPVGV**)xpvgv) = 0;
1316 /* allocate another arena's worth of struct xpvlv */
1323 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1324 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1325 PL_xpvlv_arenaroot = xpvlv;
1327 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1328 PL_xpvlv_root = ++xpvlv;
1329 while (xpvlv < xpvlvend) {
1330 *((XPVLV**)xpvlv) = xpvlv + 1;
1333 *((XPVLV**)xpvlv) = 0;
1336 /* allocate another arena's worth of struct xpvbm */
1343 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1344 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1345 PL_xpvbm_arenaroot = xpvbm;
1347 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1348 PL_xpvbm_root = ++xpvbm;
1349 while (xpvbm < xpvbmend) {
1350 *((XPVBM**)xpvbm) = xpvbm + 1;
1353 *((XPVBM**)xpvbm) = 0;
1356 /* grab a new NV body from the free list, allocating more if necessary */
1366 PL_xnv_root = *(NV**)xnv;
1368 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1371 /* return an NV body to the free list */
1374 S_del_xnv(pTHX_ XPVNV *p)
1376 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1378 *(NV**)xnv = PL_xnv_root;
1383 /* grab a new struct xpv from the free list, allocating more if necessary */
1393 PL_xpv_root = *(xpv_allocated**)xpv;
1395 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1396 sum to zero, and the pointer is unchanged. If the allocated structure
1397 is smaller (no initial IV actually allocated) then the net effect is
1398 to subtract the size of the IV from the pointer, to return a new pointer
1399 as if an initial IV were actually allocated. */
1400 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1401 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
1404 /* return a struct xpv to the free list */
1407 S_del_xpv(pTHX_ XPV *p)
1410 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1411 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
1413 *(xpv_allocated**)xpv = PL_xpv_root;
1418 /* grab a new struct xpviv from the free list, allocating more if necessary */
1423 xpviv_allocated* xpviv;
1427 xpviv = PL_xpviv_root;
1428 PL_xpviv_root = *(xpviv_allocated**)xpviv;
1430 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1431 sum to zero, and the pointer is unchanged. If the allocated structure
1432 is smaller (no initial IV actually allocated) then the net effect is
1433 to subtract the size of the IV from the pointer, to return a new pointer
1434 as if an initial IV were actually allocated. */
1435 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1436 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1439 /* return a struct xpviv to the free list */
1442 S_del_xpviv(pTHX_ XPVIV *p)
1444 xpviv_allocated* xpviv
1445 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1446 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1448 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1449 PL_xpviv_root = xpviv;
1453 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1462 xpvnv = PL_xpvnv_root;
1463 PL_xpvnv_root = *(XPVNV**)xpvnv;
1468 /* return a struct xpvnv to the free list */
1471 S_del_xpvnv(pTHX_ XPVNV *p)
1474 *(XPVNV**)p = PL_xpvnv_root;
1479 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1488 xpvcv = PL_xpvcv_root;
1489 PL_xpvcv_root = *(XPVCV**)xpvcv;
1494 /* return a struct xpvcv to the free list */
1497 S_del_xpvcv(pTHX_ XPVCV *p)
1500 *(XPVCV**)p = PL_xpvcv_root;
1505 /* grab a new struct xpvav from the free list, allocating more if necessary */
1510 xpvav_allocated* xpvav;
1514 xpvav = PL_xpvav_root;
1515 PL_xpvav_root = *(xpvav_allocated**)xpvav;
1517 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1518 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
1521 /* return a struct xpvav to the free list */
1524 S_del_xpvav(pTHX_ XPVAV *p)
1526 xpvav_allocated* xpvav
1527 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1528 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
1530 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1531 PL_xpvav_root = xpvav;
1535 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1540 xpvhv_allocated* xpvhv;
1544 xpvhv = PL_xpvhv_root;
1545 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
1547 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1548 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1551 /* return a struct xpvhv to the free list */
1554 S_del_xpvhv(pTHX_ XPVHV *p)
1556 xpvhv_allocated* xpvhv
1557 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1558 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1560 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1561 PL_xpvhv_root = xpvhv;
1565 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1574 xpvmg = PL_xpvmg_root;
1575 PL_xpvmg_root = *(XPVMG**)xpvmg;
1580 /* return a struct xpvmg to the free list */
1583 S_del_xpvmg(pTHX_ XPVMG *p)
1586 *(XPVMG**)p = PL_xpvmg_root;
1591 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1600 xpvgv = PL_xpvgv_root;
1601 PL_xpvgv_root = *(XPVGV**)xpvgv;
1606 /* return a struct xpvgv to the free list */
1609 S_del_xpvgv(pTHX_ XPVGV *p)
1612 *(XPVGV**)p = PL_xpvgv_root;
1617 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1626 xpvlv = PL_xpvlv_root;
1627 PL_xpvlv_root = *(XPVLV**)xpvlv;
1632 /* return a struct xpvlv to the free list */
1635 S_del_xpvlv(pTHX_ XPVLV *p)
1638 *(XPVLV**)p = PL_xpvlv_root;
1643 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1652 xpvbm = PL_xpvbm_root;
1653 PL_xpvbm_root = *(XPVBM**)xpvbm;
1658 /* return a struct xpvbm to the free list */
1661 S_del_xpvbm(pTHX_ XPVBM *p)
1664 *(XPVBM**)p = PL_xpvbm_root;
1669 #define my_safemalloc(s) (void*)safemalloc(s)
1670 #define my_safefree(p) safefree((char*)p)
1674 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1675 #define del_XNV(p) my_safefree(p)
1677 #define new_XPV() my_safemalloc(sizeof(XPV))
1678 #define del_XPV(p) my_safefree(p)
1680 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1681 #define del_XPVIV(p) my_safefree(p)
1683 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1684 #define del_XPVNV(p) my_safefree(p)
1686 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1687 #define del_XPVCV(p) my_safefree(p)
1689 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1690 #define del_XPVAV(p) my_safefree(p)
1692 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1693 #define del_XPVHV(p) my_safefree(p)
1695 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1696 #define del_XPVMG(p) my_safefree(p)
1698 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1699 #define del_XPVGV(p) my_safefree(p)
1701 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1702 #define del_XPVLV(p) my_safefree(p)
1704 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1705 #define del_XPVBM(p) my_safefree(p)
1709 #define new_XNV() (void*)new_xnv()
1710 #define del_XNV(p) del_xnv((XPVNV*) p)
1712 #define new_XPV() (void*)new_xpv()
1713 #define del_XPV(p) del_xpv((XPV *)p)
1715 #define new_XPVIV() (void*)new_xpviv()
1716 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1718 #define new_XPVNV() (void*)new_xpvnv()
1719 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1721 #define new_XPVCV() (void*)new_xpvcv()
1722 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1724 #define new_XPVAV() (void*)new_xpvav()
1725 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1727 #define new_XPVHV() (void*)new_xpvhv()
1728 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1730 #define new_XPVMG() (void*)new_xpvmg()
1731 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1733 #define new_XPVGV() (void*)new_xpvgv()
1734 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1736 #define new_XPVLV() (void*)new_xpvlv()
1737 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1739 #define new_XPVBM() (void*)new_xpvbm()
1740 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1744 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1745 #define del_XPVFM(p) my_safefree(p)
1747 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1748 #define del_XPVIO(p) my_safefree(p)
1751 =for apidoc sv_upgrade
1753 Upgrade an SV to a more complex form. Generally adds a new body type to the
1754 SV, then copies across as much information as possible from the old body.
1755 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1761 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1772 if (mt != SVt_PV && SvIsCOW(sv)) {
1773 sv_force_normal_flags(sv, 0);
1776 if (SvTYPE(sv) == mt)
1787 switch (SvTYPE(sv)) {
1794 else if (mt < SVt_PVIV)
1804 pv = (char*)SvRV(sv);
1813 else if (mt == SVt_NV)
1821 del_XPVIV(SvANY(sv));
1829 del_XPVNV(SvANY(sv));
1832 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1833 there's no way that it can be safely upgraded, because perl.c
1834 expects to Safefree(SvANY(PL_mess_sv)) */
1835 assert(sv != PL_mess_sv);
1836 /* This flag bit is used to mean other things in other scalar types.
1837 Given that it only has meaning inside the pad, it shouldn't be set
1838 on anything that can get upgraded. */
1839 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1845 magic = SvMAGIC(sv);
1846 stash = SvSTASH(sv);
1847 del_XPVMG(SvANY(sv));
1850 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1853 SvFLAGS(sv) &= ~SVTYPEMASK;
1858 Perl_croak(aTHX_ "Can't upgrade to undef");
1860 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1864 SvANY(sv) = new_XNV();
1868 SvANY(sv) = &sv->sv_u.svu_rv;
1869 SvRV_set(sv, (SV*)pv);
1872 SvANY(sv) = new_XPVHV();
1875 HvTOTALKEYS(sv) = 0;
1877 /* Fall through... */
1880 SvANY(sv) = new_XPVAV();
1887 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1889 /* FIXME. Should be able to remove all this if()... if the above
1890 assertion is genuinely always true. */
1893 SvFLAGS(sv) &= ~SVf_OOK;
1896 SvPV_set(sv, (char*)0);
1897 SvMAGIC_set(sv, magic);
1898 SvSTASH_set(sv, stash);
1902 SvANY(sv) = new_XPVIO();
1903 Zero(SvANY(sv), 1, XPVIO);
1904 IoPAGE_LEN(sv) = 60;
1905 goto set_magic_common;
1907 SvANY(sv) = new_XPVFM();
1908 Zero(SvANY(sv), 1, XPVFM);
1909 goto set_magic_common;
1911 SvANY(sv) = new_XPVBM();
1915 goto set_magic_common;
1917 SvANY(sv) = new_XPVGV();
1923 goto set_magic_common;
1925 SvANY(sv) = new_XPVCV();
1926 Zero(SvANY(sv), 1, XPVCV);
1927 goto set_magic_common;
1929 SvANY(sv) = new_XPVLV();
1942 SvANY(sv) = new_XPVMG();
1945 SvMAGIC_set(sv, magic);
1946 SvSTASH_set(sv, stash);
1950 SvANY(sv) = new_XPVNV();
1956 SvANY(sv) = new_XPVIV();
1965 SvANY(sv) = new_XPV();
1976 =for apidoc sv_backoff
1978 Remove any string offset. You should normally use the C<SvOOK_off> macro
1985 Perl_sv_backoff(pTHX_ register SV *sv)
1988 assert(SvTYPE(sv) != SVt_PVHV);
1989 assert(SvTYPE(sv) != SVt_PVAV);
1991 const char *s = SvPVX_const(sv);
1992 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1993 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1995 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1997 SvFLAGS(sv) &= ~SVf_OOK;
2004 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2005 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2006 Use the C<SvGROW> wrapper instead.
2012 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2016 #ifdef HAS_64K_LIMIT
2017 if (newlen >= 0x10000) {
2018 PerlIO_printf(Perl_debug_log,
2019 "Allocation too large: %"UVxf"\n", (UV)newlen);
2022 #endif /* HAS_64K_LIMIT */
2025 if (SvTYPE(sv) < SVt_PV) {
2026 sv_upgrade(sv, SVt_PV);
2029 else if (SvOOK(sv)) { /* pv is offset? */
2032 if (newlen > SvLEN(sv))
2033 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2034 #ifdef HAS_64K_LIMIT
2035 if (newlen >= 0x10000)
2042 if (newlen > SvLEN(sv)) { /* need more room? */
2043 newlen = PERL_STRLEN_ROUNDUP(newlen);
2044 if (SvLEN(sv) && s) {
2046 const STRLEN l = malloced_size((void*)SvPVX(sv));
2052 s = saferealloc(s, newlen);
2055 s = safemalloc(newlen);
2056 if (SvPVX_const(sv) && SvCUR(sv)) {
2057 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2061 SvLEN_set(sv, newlen);
2067 =for apidoc sv_setiv
2069 Copies an integer into the given SV, upgrading first if necessary.
2070 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2076 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2078 SV_CHECK_THINKFIRST_COW_DROP(sv);
2079 switch (SvTYPE(sv)) {
2081 sv_upgrade(sv, SVt_IV);
2084 sv_upgrade(sv, SVt_PVNV);
2088 sv_upgrade(sv, SVt_PVIV);
2097 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2100 (void)SvIOK_only(sv); /* validate number */
2106 =for apidoc sv_setiv_mg
2108 Like C<sv_setiv>, but also handles 'set' magic.
2114 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2121 =for apidoc sv_setuv
2123 Copies an unsigned integer into the given SV, upgrading first if necessary.
2124 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2130 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2132 /* With these two if statements:
2133 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2136 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2138 If you wish to remove them, please benchmark to see what the effect is
2140 if (u <= (UV)IV_MAX) {
2141 sv_setiv(sv, (IV)u);
2150 =for apidoc sv_setuv_mg
2152 Like C<sv_setuv>, but also handles 'set' magic.
2158 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2160 /* With these two if statements:
2161 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2164 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2166 If you wish to remove them, please benchmark to see what the effect is
2168 if (u <= (UV)IV_MAX) {
2169 sv_setiv(sv, (IV)u);
2179 =for apidoc sv_setnv
2181 Copies a double into the given SV, upgrading first if necessary.
2182 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2188 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2190 SV_CHECK_THINKFIRST_COW_DROP(sv);
2191 switch (SvTYPE(sv)) {
2194 sv_upgrade(sv, SVt_NV);
2199 sv_upgrade(sv, SVt_PVNV);
2208 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2212 (void)SvNOK_only(sv); /* validate number */
2217 =for apidoc sv_setnv_mg
2219 Like C<sv_setnv>, but also handles 'set' magic.
2225 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2231 /* Print an "isn't numeric" warning, using a cleaned-up,
2232 * printable version of the offending string
2236 S_not_a_number(pTHX_ SV *sv)
2243 dsv = sv_2mortal(newSVpv("", 0));
2244 pv = sv_uni_display(dsv, sv, 10, 0);
2247 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2248 /* each *s can expand to 4 chars + "...\0",
2249 i.e. need room for 8 chars */
2252 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2254 if (ch & 128 && !isPRINT_LC(ch)) {
2263 else if (ch == '\r') {
2267 else if (ch == '\f') {
2271 else if (ch == '\\') {
2275 else if (ch == '\0') {
2279 else if (isPRINT_LC(ch))
2296 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2297 "Argument \"%s\" isn't numeric in %s", pv,
2300 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2301 "Argument \"%s\" isn't numeric", pv);
2305 =for apidoc looks_like_number
2307 Test if the content of an SV looks like a number (or is a number).
2308 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2309 non-numeric warning), even if your atof() doesn't grok them.
2315 Perl_looks_like_number(pTHX_ SV *sv)
2317 register const char *sbegin;
2321 sbegin = SvPVX_const(sv);
2324 else if (SvPOKp(sv))
2325 sbegin = SvPV(sv, len);
2327 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2328 return grok_number(sbegin, len, NULL);
2331 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2332 until proven guilty, assume that things are not that bad... */
2337 As 64 bit platforms often have an NV that doesn't preserve all bits of
2338 an IV (an assumption perl has been based on to date) it becomes necessary
2339 to remove the assumption that the NV always carries enough precision to
2340 recreate the IV whenever needed, and that the NV is the canonical form.
2341 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2342 precision as a side effect of conversion (which would lead to insanity
2343 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2344 1) to distinguish between IV/UV/NV slots that have cached a valid
2345 conversion where precision was lost and IV/UV/NV slots that have a
2346 valid conversion which has lost no precision
2347 2) to ensure that if a numeric conversion to one form is requested that
2348 would lose precision, the precise conversion (or differently
2349 imprecise conversion) is also performed and cached, to prevent
2350 requests for different numeric formats on the same SV causing
2351 lossy conversion chains. (lossless conversion chains are perfectly
2356 SvIOKp is true if the IV slot contains a valid value
2357 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2358 SvNOKp is true if the NV slot contains a valid value
2359 SvNOK is true only if the NV value is accurate
2362 while converting from PV to NV, check to see if converting that NV to an
2363 IV(or UV) would lose accuracy over a direct conversion from PV to
2364 IV(or UV). If it would, cache both conversions, return NV, but mark
2365 SV as IOK NOKp (ie not NOK).
2367 While converting from PV to IV, check to see if converting that IV to an
2368 NV would lose accuracy over a direct conversion from PV to NV. If it
2369 would, cache both conversions, flag similarly.
2371 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2372 correctly because if IV & NV were set NV *always* overruled.
2373 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2374 changes - now IV and NV together means that the two are interchangeable:
2375 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2377 The benefit of this is that operations such as pp_add know that if
2378 SvIOK is true for both left and right operands, then integer addition
2379 can be used instead of floating point (for cases where the result won't
2380 overflow). Before, floating point was always used, which could lead to
2381 loss of precision compared with integer addition.
2383 * making IV and NV equal status should make maths accurate on 64 bit
2385 * may speed up maths somewhat if pp_add and friends start to use
2386 integers when possible instead of fp. (Hopefully the overhead in
2387 looking for SvIOK and checking for overflow will not outweigh the
2388 fp to integer speedup)
2389 * will slow down integer operations (callers of SvIV) on "inaccurate"
2390 values, as the change from SvIOK to SvIOKp will cause a call into
2391 sv_2iv each time rather than a macro access direct to the IV slot
2392 * should speed up number->string conversion on integers as IV is
2393 favoured when IV and NV are equally accurate
2395 ####################################################################
2396 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2397 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2398 On the other hand, SvUOK is true iff UV.
2399 ####################################################################
2401 Your mileage will vary depending your CPU's relative fp to integer
2405 #ifndef NV_PRESERVES_UV
2406 # define IS_NUMBER_UNDERFLOW_IV 1
2407 # define IS_NUMBER_UNDERFLOW_UV 2
2408 # define IS_NUMBER_IV_AND_UV 2
2409 # define IS_NUMBER_OVERFLOW_IV 4
2410 # define IS_NUMBER_OVERFLOW_UV 5
2412 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2414 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2416 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2418 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2419 if (SvNVX(sv) < (NV)IV_MIN) {
2420 (void)SvIOKp_on(sv);
2422 SvIV_set(sv, IV_MIN);
2423 return IS_NUMBER_UNDERFLOW_IV;
2425 if (SvNVX(sv) > (NV)UV_MAX) {
2426 (void)SvIOKp_on(sv);
2429 SvUV_set(sv, UV_MAX);
2430 return IS_NUMBER_OVERFLOW_UV;
2432 (void)SvIOKp_on(sv);
2434 /* Can't use strtol etc to convert this string. (See truth table in
2436 if (SvNVX(sv) <= (UV)IV_MAX) {
2437 SvIV_set(sv, I_V(SvNVX(sv)));
2438 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2439 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2441 /* Integer is imprecise. NOK, IOKp */
2443 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2446 SvUV_set(sv, U_V(SvNVX(sv)));
2447 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2448 if (SvUVX(sv) == UV_MAX) {
2449 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2450 possibly be preserved by NV. Hence, it must be overflow.
2452 return IS_NUMBER_OVERFLOW_UV;
2454 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2456 /* Integer is imprecise. NOK, IOKp */
2458 return IS_NUMBER_OVERFLOW_IV;
2460 #endif /* !NV_PRESERVES_UV*/
2462 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2463 * this function provided for binary compatibility only
2467 Perl_sv_2iv(pTHX_ register SV *sv)
2469 return sv_2iv_flags(sv, SV_GMAGIC);
2473 =for apidoc sv_2iv_flags
2475 Return the integer value of an SV, doing any necessary string
2476 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2477 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2483 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2487 if (SvGMAGICAL(sv)) {
2488 if (flags & SV_GMAGIC)
2493 return I_V(SvNVX(sv));
2495 if (SvPOKp(sv) && SvLEN(sv))
2498 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2499 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2505 if (SvTHINKFIRST(sv)) {
2508 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2509 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2510 return SvIV(tmpstr);
2511 return PTR2IV(SvRV(sv));
2514 sv_force_normal_flags(sv, 0);
2516 if (SvREADONLY(sv) && !SvOK(sv)) {
2517 if (ckWARN(WARN_UNINITIALIZED))
2524 return (IV)(SvUVX(sv));
2531 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2532 * without also getting a cached IV/UV from it at the same time
2533 * (ie PV->NV conversion should detect loss of accuracy and cache
2534 * IV or UV at same time to avoid this. NWC */
2536 if (SvTYPE(sv) == SVt_NV)
2537 sv_upgrade(sv, SVt_PVNV);
2539 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2540 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2541 certainly cast into the IV range at IV_MAX, whereas the correct
2542 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2544 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2545 SvIV_set(sv, I_V(SvNVX(sv)));
2546 if (SvNVX(sv) == (NV) SvIVX(sv)
2547 #ifndef NV_PRESERVES_UV
2548 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2549 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2550 /* Don't flag it as "accurately an integer" if the number
2551 came from a (by definition imprecise) NV operation, and
2552 we're outside the range of NV integer precision */
2555 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2556 DEBUG_c(PerlIO_printf(Perl_debug_log,
2557 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2563 /* IV not precise. No need to convert from PV, as NV
2564 conversion would already have cached IV if it detected
2565 that PV->IV would be better than PV->NV->IV
2566 flags already correct - don't set public IOK. */
2567 DEBUG_c(PerlIO_printf(Perl_debug_log,
2568 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2573 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2574 but the cast (NV)IV_MIN rounds to a the value less (more
2575 negative) than IV_MIN which happens to be equal to SvNVX ??
2576 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2577 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2578 (NV)UVX == NVX are both true, but the values differ. :-(
2579 Hopefully for 2s complement IV_MIN is something like
2580 0x8000000000000000 which will be exact. NWC */
2583 SvUV_set(sv, U_V(SvNVX(sv)));
2585 (SvNVX(sv) == (NV) SvUVX(sv))
2586 #ifndef NV_PRESERVES_UV
2587 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2588 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2589 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2590 /* Don't flag it as "accurately an integer" if the number
2591 came from a (by definition imprecise) NV operation, and
2592 we're outside the range of NV integer precision */
2598 DEBUG_c(PerlIO_printf(Perl_debug_log,
2599 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2603 return (IV)SvUVX(sv);
2606 else if (SvPOKp(sv) && SvLEN(sv)) {
2608 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2609 /* We want to avoid a possible problem when we cache an IV which
2610 may be later translated to an NV, and the resulting NV is not
2611 the same as the direct translation of the initial string
2612 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2613 be careful to ensure that the value with the .456 is around if the
2614 NV value is requested in the future).
2616 This means that if we cache such an IV, we need to cache the
2617 NV as well. Moreover, we trade speed for space, and do not
2618 cache the NV if we are sure it's not needed.
2621 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2622 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2623 == IS_NUMBER_IN_UV) {
2624 /* It's definitely an integer, only upgrade to PVIV */
2625 if (SvTYPE(sv) < SVt_PVIV)
2626 sv_upgrade(sv, SVt_PVIV);
2628 } else if (SvTYPE(sv) < SVt_PVNV)
2629 sv_upgrade(sv, SVt_PVNV);
2631 /* If NV preserves UV then we only use the UV value if we know that
2632 we aren't going to call atof() below. If NVs don't preserve UVs
2633 then the value returned may have more precision than atof() will
2634 return, even though value isn't perfectly accurate. */
2635 if ((numtype & (IS_NUMBER_IN_UV
2636 #ifdef NV_PRESERVES_UV
2639 )) == IS_NUMBER_IN_UV) {
2640 /* This won't turn off the public IOK flag if it was set above */
2641 (void)SvIOKp_on(sv);
2643 if (!(numtype & IS_NUMBER_NEG)) {
2645 if (value <= (UV)IV_MAX) {
2646 SvIV_set(sv, (IV)value);
2648 SvUV_set(sv, value);
2652 /* 2s complement assumption */
2653 if (value <= (UV)IV_MIN) {
2654 SvIV_set(sv, -(IV)value);
2656 /* Too negative for an IV. This is a double upgrade, but
2657 I'm assuming it will be rare. */
2658 if (SvTYPE(sv) < SVt_PVNV)
2659 sv_upgrade(sv, SVt_PVNV);
2663 SvNV_set(sv, -(NV)value);
2664 SvIV_set(sv, IV_MIN);
2668 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2669 will be in the previous block to set the IV slot, and the next
2670 block to set the NV slot. So no else here. */
2672 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2673 != IS_NUMBER_IN_UV) {
2674 /* It wasn't an (integer that doesn't overflow the UV). */
2675 SvNV_set(sv, Atof(SvPVX_const(sv)));
2677 if (! numtype && ckWARN(WARN_NUMERIC))
2680 #if defined(USE_LONG_DOUBLE)
2681 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2682 PTR2UV(sv), SvNVX(sv)));
2684 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2685 PTR2UV(sv), SvNVX(sv)));
2689 #ifdef NV_PRESERVES_UV
2690 (void)SvIOKp_on(sv);
2692 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2693 SvIV_set(sv, I_V(SvNVX(sv)));
2694 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2697 /* Integer is imprecise. NOK, IOKp */
2699 /* UV will not work better than IV */
2701 if (SvNVX(sv) > (NV)UV_MAX) {
2703 /* Integer is inaccurate. NOK, IOKp, is UV */
2704 SvUV_set(sv, UV_MAX);
2707 SvUV_set(sv, U_V(SvNVX(sv)));
2708 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2709 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2713 /* Integer is imprecise. NOK, IOKp, is UV */
2719 #else /* NV_PRESERVES_UV */
2720 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2721 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2722 /* The IV slot will have been set from value returned by
2723 grok_number above. The NV slot has just been set using
2726 assert (SvIOKp(sv));
2728 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2729 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2730 /* Small enough to preserve all bits. */
2731 (void)SvIOKp_on(sv);
2733 SvIV_set(sv, I_V(SvNVX(sv)));
2734 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2736 /* Assumption: first non-preserved integer is < IV_MAX,
2737 this NV is in the preserved range, therefore: */
2738 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2740 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2744 0 0 already failed to read UV.
2745 0 1 already failed to read UV.
2746 1 0 you won't get here in this case. IV/UV
2747 slot set, public IOK, Atof() unneeded.
2748 1 1 already read UV.
2749 so there's no point in sv_2iuv_non_preserve() attempting
2750 to use atol, strtol, strtoul etc. */
2751 if (sv_2iuv_non_preserve (sv, numtype)
2752 >= IS_NUMBER_OVERFLOW_IV)
2756 #endif /* NV_PRESERVES_UV */
2759 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2761 if (SvTYPE(sv) < SVt_IV)
2762 /* Typically the caller expects that sv_any is not NULL now. */
2763 sv_upgrade(sv, SVt_IV);
2766 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2767 PTR2UV(sv),SvIVX(sv)));
2768 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2771 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2772 * this function provided for binary compatibility only
2776 Perl_sv_2uv(pTHX_ register SV *sv)
2778 return sv_2uv_flags(sv, SV_GMAGIC);
2782 =for apidoc sv_2uv_flags
2784 Return the unsigned integer value of an SV, doing any necessary string
2785 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2786 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2792 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2796 if (SvGMAGICAL(sv)) {
2797 if (flags & SV_GMAGIC)
2802 return U_V(SvNVX(sv));
2803 if (SvPOKp(sv) && SvLEN(sv))
2806 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2807 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2813 if (SvTHINKFIRST(sv)) {
2816 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2817 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2818 return SvUV(tmpstr);
2819 return PTR2UV(SvRV(sv));
2822 sv_force_normal_flags(sv, 0);
2824 if (SvREADONLY(sv) && !SvOK(sv)) {
2825 if (ckWARN(WARN_UNINITIALIZED))
2835 return (UV)SvIVX(sv);
2839 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2840 * without also getting a cached IV/UV from it at the same time
2841 * (ie PV->NV conversion should detect loss of accuracy and cache
2842 * IV or UV at same time to avoid this. */
2843 /* IV-over-UV optimisation - choose to cache IV if possible */
2845 if (SvTYPE(sv) == SVt_NV)
2846 sv_upgrade(sv, SVt_PVNV);
2848 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2849 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2850 SvIV_set(sv, I_V(SvNVX(sv)));
2851 if (SvNVX(sv) == (NV) SvIVX(sv)
2852 #ifndef NV_PRESERVES_UV
2853 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2854 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2855 /* Don't flag it as "accurately an integer" if the number
2856 came from a (by definition imprecise) NV operation, and
2857 we're outside the range of NV integer precision */
2860 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2861 DEBUG_c(PerlIO_printf(Perl_debug_log,
2862 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2868 /* IV not precise. No need to convert from PV, as NV
2869 conversion would already have cached IV if it detected
2870 that PV->IV would be better than PV->NV->IV
2871 flags already correct - don't set public IOK. */
2872 DEBUG_c(PerlIO_printf(Perl_debug_log,
2873 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2878 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2879 but the cast (NV)IV_MIN rounds to a the value less (more
2880 negative) than IV_MIN which happens to be equal to SvNVX ??
2881 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2882 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2883 (NV)UVX == NVX are both true, but the values differ. :-(
2884 Hopefully for 2s complement IV_MIN is something like
2885 0x8000000000000000 which will be exact. NWC */
2888 SvUV_set(sv, U_V(SvNVX(sv)));
2890 (SvNVX(sv) == (NV) SvUVX(sv))
2891 #ifndef NV_PRESERVES_UV
2892 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2893 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2894 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2895 /* Don't flag it as "accurately an integer" if the number
2896 came from a (by definition imprecise) NV operation, and
2897 we're outside the range of NV integer precision */
2902 DEBUG_c(PerlIO_printf(Perl_debug_log,
2903 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2909 else if (SvPOKp(sv) && SvLEN(sv)) {
2911 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2913 /* We want to avoid a possible problem when we cache a UV which
2914 may be later translated to an NV, and the resulting NV is not
2915 the translation of the initial data.
2917 This means that if we cache such a UV, we need to cache the
2918 NV as well. Moreover, we trade speed for space, and do not
2919 cache the NV if not needed.
2922 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2923 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2924 == IS_NUMBER_IN_UV) {
2925 /* It's definitely an integer, only upgrade to PVIV */
2926 if (SvTYPE(sv) < SVt_PVIV)
2927 sv_upgrade(sv, SVt_PVIV);
2929 } else if (SvTYPE(sv) < SVt_PVNV)
2930 sv_upgrade(sv, SVt_PVNV);
2932 /* If NV preserves UV then we only use the UV value if we know that
2933 we aren't going to call atof() below. If NVs don't preserve UVs
2934 then the value returned may have more precision than atof() will
2935 return, even though it isn't accurate. */
2936 if ((numtype & (IS_NUMBER_IN_UV
2937 #ifdef NV_PRESERVES_UV
2940 )) == IS_NUMBER_IN_UV) {
2941 /* This won't turn off the public IOK flag if it was set above */
2942 (void)SvIOKp_on(sv);
2944 if (!(numtype & IS_NUMBER_NEG)) {
2946 if (value <= (UV)IV_MAX) {
2947 SvIV_set(sv, (IV)value);
2949 /* it didn't overflow, and it was positive. */
2950 SvUV_set(sv, value);
2954 /* 2s complement assumption */
2955 if (value <= (UV)IV_MIN) {
2956 SvIV_set(sv, -(IV)value);
2958 /* Too negative for an IV. This is a double upgrade, but
2959 I'm assuming it will be rare. */
2960 if (SvTYPE(sv) < SVt_PVNV)
2961 sv_upgrade(sv, SVt_PVNV);
2965 SvNV_set(sv, -(NV)value);
2966 SvIV_set(sv, IV_MIN);
2971 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2972 != IS_NUMBER_IN_UV) {
2973 /* It wasn't an integer, or it overflowed the UV. */
2974 SvNV_set(sv, Atof(SvPVX_const(sv)));
2976 if (! numtype && ckWARN(WARN_NUMERIC))
2979 #if defined(USE_LONG_DOUBLE)
2980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2981 PTR2UV(sv), SvNVX(sv)));
2983 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2984 PTR2UV(sv), SvNVX(sv)));
2987 #ifdef NV_PRESERVES_UV
2988 (void)SvIOKp_on(sv);
2990 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2991 SvIV_set(sv, I_V(SvNVX(sv)));
2992 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2995 /* Integer is imprecise. NOK, IOKp */
2997 /* UV will not work better than IV */
2999 if (SvNVX(sv) > (NV)UV_MAX) {
3001 /* Integer is inaccurate. NOK, IOKp, is UV */
3002 SvUV_set(sv, UV_MAX);
3005 SvUV_set(sv, U_V(SvNVX(sv)));
3006 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3007 NV preservse UV so can do correct comparison. */
3008 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3012 /* Integer is imprecise. NOK, IOKp, is UV */
3017 #else /* NV_PRESERVES_UV */
3018 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3019 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3020 /* The UV slot will have been set from value returned by
3021 grok_number above. The NV slot has just been set using
3024 assert (SvIOKp(sv));
3026 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3027 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3028 /* Small enough to preserve all bits. */
3029 (void)SvIOKp_on(sv);
3031 SvIV_set(sv, I_V(SvNVX(sv)));
3032 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3034 /* Assumption: first non-preserved integer is < IV_MAX,
3035 this NV is in the preserved range, therefore: */
3036 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3038 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
3041 sv_2iuv_non_preserve (sv, numtype);
3043 #endif /* NV_PRESERVES_UV */
3047 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3048 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3051 if (SvTYPE(sv) < SVt_IV)
3052 /* Typically the caller expects that sv_any is not NULL now. */
3053 sv_upgrade(sv, SVt_IV);
3057 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3058 PTR2UV(sv),SvUVX(sv)));
3059 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3065 Return the num value of an SV, doing any necessary string or integer
3066 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3073 Perl_sv_2nv(pTHX_ register SV *sv)
3077 if (SvGMAGICAL(sv)) {
3081 if (SvPOKp(sv) && SvLEN(sv)) {
3082 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3083 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3085 return Atof(SvPVX_const(sv));
3089 return (NV)SvUVX(sv);
3091 return (NV)SvIVX(sv);
3094 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3095 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3101 if (SvTHINKFIRST(sv)) {
3104 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3105 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3106 return SvNV(tmpstr);
3107 return PTR2NV(SvRV(sv));
3110 sv_force_normal_flags(sv, 0);
3112 if (SvREADONLY(sv) && !SvOK(sv)) {
3113 if (ckWARN(WARN_UNINITIALIZED))
3118 if (SvTYPE(sv) < SVt_NV) {
3119 if (SvTYPE(sv) == SVt_IV)
3120 sv_upgrade(sv, SVt_PVNV);
3122 sv_upgrade(sv, SVt_NV);
3123 #ifdef USE_LONG_DOUBLE
3125 STORE_NUMERIC_LOCAL_SET_STANDARD();
3126 PerlIO_printf(Perl_debug_log,
3127 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3128 PTR2UV(sv), SvNVX(sv));
3129 RESTORE_NUMERIC_LOCAL();
3133 STORE_NUMERIC_LOCAL_SET_STANDARD();
3134 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3135 PTR2UV(sv), SvNVX(sv));
3136 RESTORE_NUMERIC_LOCAL();
3140 else if (SvTYPE(sv) < SVt_PVNV)
3141 sv_upgrade(sv, SVt_PVNV);
3146 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3147 #ifdef NV_PRESERVES_UV
3150 /* Only set the public NV OK flag if this NV preserves the IV */
3151 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3152 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3153 : (SvIVX(sv) == I_V(SvNVX(sv))))
3159 else if (SvPOKp(sv) && SvLEN(sv)) {
3161 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3162 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3164 #ifdef NV_PRESERVES_UV
3165 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3166 == IS_NUMBER_IN_UV) {
3167 /* It's definitely an integer */
3168 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3170 SvNV_set(sv, Atof(SvPVX_const(sv)));
3173 SvNV_set(sv, Atof(SvPVX_const(sv)));
3174 /* Only set the public NV OK flag if this NV preserves the value in
3175 the PV at least as well as an IV/UV would.
3176 Not sure how to do this 100% reliably. */
3177 /* if that shift count is out of range then Configure's test is
3178 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3180 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3181 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3182 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3183 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3184 /* Can't use strtol etc to convert this string, so don't try.
3185 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3188 /* value has been set. It may not be precise. */
3189 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3190 /* 2s complement assumption for (UV)IV_MIN */
3191 SvNOK_on(sv); /* Integer is too negative. */
3196 if (numtype & IS_NUMBER_NEG) {
3197 SvIV_set(sv, -(IV)value);
3198 } else if (value <= (UV)IV_MAX) {
3199 SvIV_set(sv, (IV)value);
3201 SvUV_set(sv, value);
3205 if (numtype & IS_NUMBER_NOT_INT) {
3206 /* I believe that even if the original PV had decimals,
3207 they are lost beyond the limit of the FP precision.
3208 However, neither is canonical, so both only get p
3209 flags. NWC, 2000/11/25 */
3210 /* Both already have p flags, so do nothing */
3213 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3214 if (SvIVX(sv) == I_V(nv)) {
3219 /* It had no "." so it must be integer. */
3222 /* between IV_MAX and NV(UV_MAX).
3223 Could be slightly > UV_MAX */
3225 if (numtype & IS_NUMBER_NOT_INT) {
3226 /* UV and NV both imprecise. */
3228 UV nv_as_uv = U_V(nv);
3230 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3241 #endif /* NV_PRESERVES_UV */
3244 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3246 if (SvTYPE(sv) < SVt_NV)
3247 /* Typically the caller expects that sv_any is not NULL now. */
3248 /* XXX Ilya implies that this is a bug in callers that assume this
3249 and ideally should be fixed. */
3250 sv_upgrade(sv, SVt_NV);
3253 #if defined(USE_LONG_DOUBLE)
3255 STORE_NUMERIC_LOCAL_SET_STANDARD();
3256 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3257 PTR2UV(sv), SvNVX(sv));
3258 RESTORE_NUMERIC_LOCAL();
3262 STORE_NUMERIC_LOCAL_SET_STANDARD();
3263 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3264 PTR2UV(sv), SvNVX(sv));
3265 RESTORE_NUMERIC_LOCAL();
3271 /* asIV(): extract an integer from the string value of an SV.
3272 * Caller must validate PVX */
3275 S_asIV(pTHX_ SV *sv)
3278 int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3281 == IS_NUMBER_IN_UV) {
3282 /* It's definitely an integer */
3283 if (numtype & IS_NUMBER_NEG) {
3284 if (value < (UV)IV_MIN)
3287 if (value < (UV)IV_MAX)
3292 if (ckWARN(WARN_NUMERIC))
3295 return I_V(Atof(SvPVX_const(sv)));
3298 /* asUV(): extract an unsigned integer from the string value of an SV
3299 * Caller must validate PVX */
3302 S_asUV(pTHX_ SV *sv)
3305 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3307 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3308 == IS_NUMBER_IN_UV) {
3309 /* It's definitely an integer */
3310 if (!(numtype & IS_NUMBER_NEG))
3314 if (ckWARN(WARN_NUMERIC))
3317 return U_V(Atof(SvPVX_const(sv)));
3321 =for apidoc sv_2pv_nolen
3323 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3324 use the macro wrapper C<SvPV_nolen(sv)> instead.
3329 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3332 return sv_2pv(sv, &n_a);
3335 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3336 * UV as a string towards the end of buf, and return pointers to start and
3339 * We assume that buf is at least TYPE_CHARS(UV) long.
3343 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3345 char *ptr = buf + TYPE_CHARS(UV);
3359 *--ptr = '0' + (char)(uv % 10);
3367 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3368 * this function provided for binary compatibility only
3372 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3374 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3378 =for apidoc sv_2pv_flags
3380 Returns a pointer to the string value of an SV, and sets *lp to its length.
3381 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3383 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3384 usually end up here too.
3390 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3395 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3396 char *tmpbuf = tbuf;
3402 if (SvGMAGICAL(sv)) {
3403 if (flags & SV_GMAGIC)
3411 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3413 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3418 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3423 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3424 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3431 if (SvTHINKFIRST(sv)) {
3434 register const char *typestr;
3435 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3436 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3437 char *pv = SvPV(tmpstr, *lp);
3447 typestr = "NULLREF";
3451 switch (SvTYPE(sv)) {
3453 if ( ((SvFLAGS(sv) &
3454 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3455 == (SVs_OBJECT|SVs_SMG))
3456 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3457 const regexp *re = (regexp *)mg->mg_obj;
3460 const char *fptr = "msix";
3465 char need_newline = 0;
3466 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3468 while((ch = *fptr++)) {
3470 reflags[left++] = ch;
3473 reflags[right--] = ch;
3478 reflags[left] = '-';
3482 mg->mg_len = re->prelen + 4 + left;
3484 * If /x was used, we have to worry about a regex
3485 * ending with a comment later being embedded
3486 * within another regex. If so, we don't want this
3487 * regex's "commentization" to leak out to the
3488 * right part of the enclosing regex, we must cap
3489 * it with a newline.
3491 * So, if /x was used, we scan backwards from the
3492 * end of the regex. If we find a '#' before we
3493 * find a newline, we need to add a newline
3494 * ourself. If we find a '\n' first (or if we
3495 * don't find '#' or '\n'), we don't need to add
3496 * anything. -jfriedl
3498 if (PMf_EXTENDED & re->reganch)
3500 const char *endptr = re->precomp + re->prelen;
3501 while (endptr >= re->precomp)
3503 const char c = *(endptr--);
3505 break; /* don't need another */
3507 /* we end while in a comment, so we
3509 mg->mg_len++; /* save space for it */
3510 need_newline = 1; /* note to add it */
3516 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3517 Copy("(?", mg->mg_ptr, 2, char);
3518 Copy(reflags, mg->mg_ptr+2, left, char);
3519 Copy(":", mg->mg_ptr+left+2, 1, char);
3520 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3522 mg->mg_ptr[mg->mg_len - 2] = '\n';
3523 mg->mg_ptr[mg->mg_len - 1] = ')';
3524 mg->mg_ptr[mg->mg_len] = 0;
3526 PL_reginterp_cnt += re->program[0].next_off;
3528 if (re->reganch & ROPT_UTF8)
3543 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3544 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3545 /* tied lvalues should appear to be
3546 * scalars for backwards compatitbility */
3547 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3548 ? "SCALAR" : "LVALUE"; break;
3549 case SVt_PVAV: typestr = "ARRAY"; break;
3550 case SVt_PVHV: typestr = "HASH"; break;
3551 case SVt_PVCV: typestr = "CODE"; break;
3552 case SVt_PVGV: typestr = "GLOB"; break;
3553 case SVt_PVFM: typestr = "FORMAT"; break;
3554 case SVt_PVIO: typestr = "IO"; break;
3555 default: typestr = "UNKNOWN"; break;
3559 const char *name = HvNAME_get(SvSTASH(sv));
3560 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3561 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3564 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3567 *lp = strlen(typestr);
3568 return (char *)typestr;
3570 if (SvREADONLY(sv) && !SvOK(sv)) {
3571 if (ckWARN(WARN_UNINITIALIZED))
3577 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3578 /* I'm assuming that if both IV and NV are equally valid then
3579 converting the IV is going to be more efficient */
3580 const U32 isIOK = SvIOK(sv);
3581 const U32 isUIOK = SvIsUV(sv);
3582 char buf[TYPE_CHARS(UV)];
3585 if (SvTYPE(sv) < SVt_PVIV)
3586 sv_upgrade(sv, SVt_PVIV);
3588 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3590 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3591 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3592 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3593 SvCUR_set(sv, ebuf - ptr);
3603 else if (SvNOKp(sv)) {
3604 if (SvTYPE(sv) < SVt_PVNV)
3605 sv_upgrade(sv, SVt_PVNV);
3606 /* The +20 is pure guesswork. Configure test needed. --jhi */
3607 SvGROW(sv, NV_DIG + 20);
3609 olderrno = errno; /* some Xenix systems wipe out errno here */
3611 if (SvNVX(sv) == 0.0)
3612 (void)strcpy(s,"0");
3616 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3619 #ifdef FIXNEGATIVEZERO
3620 if (*s == '-' && s[1] == '0' && !s[2])
3630 if (ckWARN(WARN_UNINITIALIZED)
3631 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3634 if (SvTYPE(sv) < SVt_PV)
3635 /* Typically the caller expects that sv_any is not NULL now. */
3636 sv_upgrade(sv, SVt_PV);
3639 *lp = s - SvPVX_const(sv);
3642 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3643 PTR2UV(sv),SvPVX_const(sv)));
3647 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3648 /* Sneaky stuff here */
3652 tsv = newSVpv(tmpbuf, 0);
3664 t = SvPVX_const(tsv);
3669 len = strlen(tmpbuf);
3671 #ifdef FIXNEGATIVEZERO
3672 if (len == 2 && t[0] == '-' && t[1] == '0') {
3677 (void)SvUPGRADE(sv, SVt_PV);
3679 s = SvGROW(sv, len + 1);
3682 return strcpy(s, t);
3687 =for apidoc sv_copypv
3689 Copies a stringified representation of the source SV into the
3690 destination SV. Automatically performs any necessary mg_get and
3691 coercion of numeric values into strings. Guaranteed to preserve
3692 UTF-8 flag even from overloaded objects. Similar in nature to
3693 sv_2pv[_flags] but operates directly on an SV instead of just the
3694 string. Mostly uses sv_2pv_flags to do its work, except when that
3695 would lose the UTF-8'ness of the PV.
3701 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3706 sv_setpvn(dsv,s,len);
3714 =for apidoc sv_2pvbyte_nolen
3716 Return a pointer to the byte-encoded representation of the SV.
3717 May cause the SV to be downgraded from UTF-8 as a side-effect.
3719 Usually accessed via the C<SvPVbyte_nolen> macro.
3725 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3728 return sv_2pvbyte(sv, &n_a);
3732 =for apidoc sv_2pvbyte
3734 Return a pointer to the byte-encoded representation of the SV, and set *lp
3735 to its length. May cause the SV to be downgraded from UTF-8 as a
3738 Usually accessed via the C<SvPVbyte> macro.
3744 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3746 sv_utf8_downgrade(sv,0);
3747 return SvPV(sv,*lp);
3751 =for apidoc sv_2pvutf8_nolen
3753 Return a pointer to the UTF-8-encoded representation of the SV.
3754 May cause the SV to be upgraded to UTF-8 as a side-effect.
3756 Usually accessed via the C<SvPVutf8_nolen> macro.
3762 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3765 return sv_2pvutf8(sv, &n_a);
3769 =for apidoc sv_2pvutf8
3771 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3772 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3774 Usually accessed via the C<SvPVutf8> macro.
3780 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3782 sv_utf8_upgrade(sv);
3783 return SvPV(sv,*lp);
3787 =for apidoc sv_2bool
3789 This function is only called on magical items, and is only used by
3790 sv_true() or its macro equivalent.
3796 Perl_sv_2bool(pTHX_ register SV *sv)
3805 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3806 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3807 return (bool)SvTRUE(tmpsv);
3808 return SvRV(sv) != 0;
3811 register XPV* Xpvtmp;
3812 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3813 (*sv->sv_u.svu_pv > '0' ||
3814 Xpvtmp->xpv_cur > 1 ||
3815 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3822 return SvIVX(sv) != 0;
3825 return SvNVX(sv) != 0.0;
3832 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3833 * this function provided for binary compatibility only
3838 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3840 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3844 =for apidoc sv_utf8_upgrade
3846 Converts the PV of an SV to its UTF-8-encoded form.
3847 Forces the SV to string form if it is not already.
3848 Always sets the SvUTF8 flag to avoid future validity checks even
3849 if all the bytes have hibit clear.
3851 This is not as a general purpose byte encoding to Unicode interface:
3852 use the Encode extension for that.
3854 =for apidoc sv_utf8_upgrade_flags
3856 Converts the PV of an SV to its UTF-8-encoded form.
3857 Forces the SV to string form if it is not already.
3858 Always sets the SvUTF8 flag to avoid future validity checks even
3859 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3860 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3861 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3863 This is not as a general purpose byte encoding to Unicode interface:
3864 use the Encode extension for that.
3870 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3872 if (sv == &PL_sv_undef)
3876 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3877 (void) sv_2pv_flags(sv,&len, flags);
3881 (void) SvPV_force(sv,len);
3890 sv_force_normal_flags(sv, 0);
3893 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3894 sv_recode_to_utf8(sv, PL_encoding);
3895 else { /* Assume Latin-1/EBCDIC */
3896 /* This function could be much more efficient if we
3897 * had a FLAG in SVs to signal if there are any hibit
3898 * chars in the PV. Given that there isn't such a flag
3899 * make the loop as fast as possible. */
3900 U8 *s = (U8 *) SvPVX(sv);
3901 U8 *e = (U8 *) SvEND(sv);
3907 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3911 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3912 s = bytes_to_utf8((U8*)s, &len);
3914 SvPV_free(sv); /* No longer using what was there before. */
3916 SvPV_set(sv, (char*)s);
3917 SvCUR_set(sv, len - 1);
3918 SvLEN_set(sv, len); /* No longer know the real size. */
3920 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3927 =for apidoc sv_utf8_downgrade
3929 Attempts to convert the PV of an SV from characters to bytes.
3930 If the PV contains a character beyond byte, this conversion will fail;
3931 in this case, either returns false or, if C<fail_ok> is not
3934 This is not as a general purpose Unicode to byte encoding interface:
3935 use the Encode extension for that.
3941 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3943 if (SvPOKp(sv) && SvUTF8(sv)) {
3949 sv_force_normal_flags(sv, 0);
3951 s = (U8 *) SvPV(sv, len);
3952 if (!utf8_to_bytes(s, &len)) {
3957 Perl_croak(aTHX_ "Wide character in %s",
3960 Perl_croak(aTHX_ "Wide character");
3971 =for apidoc sv_utf8_encode
3973 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3974 flag off so that it looks like octets again.
3980 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3982 (void) sv_utf8_upgrade(sv);
3984 sv_force_normal_flags(sv, 0);
3986 if (SvREADONLY(sv)) {
3987 Perl_croak(aTHX_ PL_no_modify);
3993 =for apidoc sv_utf8_decode
3995 If the PV of the SV is an octet sequence in UTF-8
3996 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3997 so that it looks like a character. If the PV contains only single-byte
3998 characters, the C<SvUTF8> flag stays being off.
3999 Scans PV for validity and returns false if the PV is invalid UTF-8.
4005 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4011 /* The octets may have got themselves encoded - get them back as
4014 if (!sv_utf8_downgrade(sv, TRUE))
4017 /* it is actually just a matter of turning the utf8 flag on, but
4018 * we want to make sure everything inside is valid utf8 first.
4020 c = (U8 *) SvPVX(sv);
4021 if (!is_utf8_string(c, SvCUR(sv)+1))
4023 e = (U8 *) SvEND(sv);
4026 if (!UTF8_IS_INVARIANT(ch)) {
4035 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4036 * this function provided for binary compatibility only
4040 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4042 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4046 =for apidoc sv_setsv
4048 Copies the contents of the source SV C<ssv> into the destination SV
4049 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4050 function if the source SV needs to be reused. Does not handle 'set' magic.
4051 Loosely speaking, it performs a copy-by-value, obliterating any previous
4052 content of the destination.
4054 You probably want to use one of the assortment of wrappers, such as
4055 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4056 C<SvSetMagicSV_nosteal>.
4058 =for apidoc sv_setsv_flags
4060 Copies the contents of the source SV C<ssv> into the destination SV
4061 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4062 function if the source SV needs to be reused. Does not handle 'set' magic.
4063 Loosely speaking, it performs a copy-by-value, obliterating any previous
4064 content of the destination.
4065 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4066 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4067 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4068 and C<sv_setsv_nomg> are implemented in terms of this function.
4070 You probably want to use one of the assortment of wrappers, such as
4071 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4072 C<SvSetMagicSV_nosteal>.
4074 This is the primary function for copying scalars, and most other
4075 copy-ish functions and macros use this underneath.
4081 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4083 register U32 sflags;
4089 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4091 sstr = &PL_sv_undef;
4092 stype = SvTYPE(sstr);
4093 dtype = SvTYPE(dstr);
4098 /* need to nuke the magic */
4100 SvRMAGICAL_off(dstr);
4103 /* There's a lot of redundancy below but we're going for speed here */
4108 if (dtype != SVt_PVGV) {
4109 (void)SvOK_off(dstr);
4117 sv_upgrade(dstr, SVt_IV);
4120 sv_upgrade(dstr, SVt_PVNV);
4124 sv_upgrade(dstr, SVt_PVIV);
4127 (void)SvIOK_only(dstr);
4128 SvIV_set(dstr, SvIVX(sstr));
4131 if (SvTAINTED(sstr))
4142 sv_upgrade(dstr, SVt_NV);
4147 sv_upgrade(dstr, SVt_PVNV);
4150 SvNV_set(dstr, SvNVX(sstr));
4151 (void)SvNOK_only(dstr);
4152 if (SvTAINTED(sstr))
4160 sv_upgrade(dstr, SVt_RV);
4161 else if (dtype == SVt_PVGV &&
4162 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4165 if (GvIMPORTED(dstr) != GVf_IMPORTED
4166 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4168 GvIMPORTED_on(dstr);
4177 #ifdef PERL_COPY_ON_WRITE
4178 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4179 if (dtype < SVt_PVIV)
4180 sv_upgrade(dstr, SVt_PVIV);
4187 sv_upgrade(dstr, SVt_PV);
4190 if (dtype < SVt_PVIV)
4191 sv_upgrade(dstr, SVt_PVIV);
4194 if (dtype < SVt_PVNV)
4195 sv_upgrade(dstr, SVt_PVNV);
4202 const char * const type = sv_reftype(sstr,0);
4204 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4206 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4211 if (dtype <= SVt_PVGV) {
4213 if (dtype != SVt_PVGV) {
4214 const char * const name = GvNAME(sstr);
4215 const STRLEN len = GvNAMELEN(sstr);
4216 /* don't upgrade SVt_PVLV: it can hold a glob */
4217 if (dtype != SVt_PVLV)
4218 sv_upgrade(dstr, SVt_PVGV);
4219 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4220 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4221 GvNAME(dstr) = savepvn(name, len);
4222 GvNAMELEN(dstr) = len;
4223 SvFAKE_on(dstr); /* can coerce to non-glob */
4225 /* ahem, death to those who redefine active sort subs */
4226 else if (PL_curstackinfo->si_type == PERLSI_SORT
4227 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4228 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4231 #ifdef GV_UNIQUE_CHECK
4232 if (GvUNIQUE((GV*)dstr)) {
4233 Perl_croak(aTHX_ PL_no_modify);
4237 (void)SvOK_off(dstr);
4238 GvINTRO_off(dstr); /* one-shot flag */
4240 GvGP(dstr) = gp_ref(GvGP(sstr));
4241 if (SvTAINTED(sstr))
4243 if (GvIMPORTED(dstr) != GVf_IMPORTED
4244 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4246 GvIMPORTED_on(dstr);
4254 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4256 if ((int)SvTYPE(sstr) != stype) {
4257 stype = SvTYPE(sstr);
4258 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4262 if (stype == SVt_PVLV)
4263 (void)SvUPGRADE(dstr, SVt_PVNV);
4265 (void)SvUPGRADE(dstr, (U32)stype);
4268 sflags = SvFLAGS(sstr);
4270 if (sflags & SVf_ROK) {
4271 if (dtype >= SVt_PV) {
4272 if (dtype == SVt_PVGV) {
4273 SV *sref = SvREFCNT_inc(SvRV(sstr));
4275 const int intro = GvINTRO(dstr);
4277 #ifdef GV_UNIQUE_CHECK
4278 if (GvUNIQUE((GV*)dstr)) {
4279 Perl_croak(aTHX_ PL_no_modify);
4284 GvINTRO_off(dstr); /* one-shot flag */
4285 GvLINE(dstr) = CopLINE(PL_curcop);
4286 GvEGV(dstr) = (GV*)dstr;
4289 switch (SvTYPE(sref)) {
4292 SAVEGENERICSV(GvAV(dstr));
4294 dref = (SV*)GvAV(dstr);
4295 GvAV(dstr) = (AV*)sref;
4296 if (!GvIMPORTED_AV(dstr)
4297 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4299 GvIMPORTED_AV_on(dstr);
4304 SAVEGENERICSV(GvHV(dstr));
4306 dref = (SV*)GvHV(dstr);
4307 GvHV(dstr) = (HV*)sref;
4308 if (!GvIMPORTED_HV(dstr)
4309 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4311 GvIMPORTED_HV_on(dstr);
4316 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4317 SvREFCNT_dec(GvCV(dstr));
4318 GvCV(dstr) = Nullcv;
4319 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4320 PL_sub_generation++;
4322 SAVEGENERICSV(GvCV(dstr));
4325 dref = (SV*)GvCV(dstr);
4326 if (GvCV(dstr) != (CV*)sref) {
4327 CV* cv = GvCV(dstr);
4329 if (!GvCVGEN((GV*)dstr) &&
4330 (CvROOT(cv) || CvXSUB(cv)))
4332 /* ahem, death to those who redefine
4333 * active sort subs */
4334 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4335 PL_sortcop == CvSTART(cv))
4337 "Can't redefine active sort subroutine %s",
4338 GvENAME((GV*)dstr));
4339 /* Redefining a sub - warning is mandatory if
4340 it was a const and its value changed. */
4341 if (ckWARN(WARN_REDEFINE)
4343 && (!CvCONST((CV*)sref)
4344 || sv_cmp(cv_const_sv(cv),
4345 cv_const_sv((CV*)sref)))))
4347 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4349 ? "Constant subroutine %s::%s redefined"
4350 : "Subroutine %s::%s redefined",
4351 HvNAME_get(GvSTASH((GV*)dstr)),
4352 GvENAME((GV*)dstr));
4356 cv_ckproto(cv, (GV*)dstr,
4357 SvPOK(sref) ? SvPVX(sref) : Nullch);
4359 GvCV(dstr) = (CV*)sref;
4360 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4361 GvASSUMECV_on(dstr);
4362 PL_sub_generation++;
4364 if (!GvIMPORTED_CV(dstr)
4365 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4367 GvIMPORTED_CV_on(dstr);
4372 SAVEGENERICSV(GvIOp(dstr));
4374 dref = (SV*)GvIOp(dstr);
4375 GvIOp(dstr) = (IO*)sref;
4379 SAVEGENERICSV(GvFORM(dstr));
4381 dref = (SV*)GvFORM(dstr);
4382 GvFORM(dstr) = (CV*)sref;
4386 SAVEGENERICSV(GvSV(dstr));
4388 dref = (SV*)GvSV(dstr);
4390 if (!GvIMPORTED_SV(dstr)
4391 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4393 GvIMPORTED_SV_on(dstr);
4399 if (SvTAINTED(sstr))
4403 if (SvPVX_const(dstr)) {
4409 (void)SvOK_off(dstr);
4410 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4412 if (sflags & SVp_NOK) {
4414 /* Only set the public OK flag if the source has public OK. */
4415 if (sflags & SVf_NOK)
4416 SvFLAGS(dstr) |= SVf_NOK;
4417 SvNV_set(dstr, SvNVX(sstr));
4419 if (sflags & SVp_IOK) {
4420 (void)SvIOKp_on(dstr);
4421 if (sflags & SVf_IOK)
4422 SvFLAGS(dstr) |= SVf_IOK;
4423 if (sflags & SVf_IVisUV)
4425 SvIV_set(dstr, SvIVX(sstr));
4427 if (SvAMAGIC(sstr)) {
4431 else if (sflags & SVp_POK) {
4435 * Check to see if we can just swipe the string. If so, it's a
4436 * possible small lose on short strings, but a big win on long ones.
4437 * It might even be a win on short strings if SvPVX_const(dstr)
4438 * has to be allocated and SvPVX_const(sstr) has to be freed.
4441 /* Whichever path we take through the next code, we want this true,
4442 and doing it now facilitates the COW check. */
4443 (void)SvPOK_only(dstr);
4446 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4449 (sflags & SVs_TEMP) && /* slated for free anyway? */
4450 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4451 (!(flags & SV_NOSTEAL)) &&
4452 /* and we're allowed to steal temps */
4453 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4454 SvLEN(sstr) && /* and really is a string */
4455 /* and won't be needed again, potentially */
4456 !(PL_op && PL_op->op_type == OP_AASSIGN))
4457 #ifdef PERL_COPY_ON_WRITE
4458 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4459 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4460 && SvTYPE(sstr) >= SVt_PVIV)
4463 /* Failed the swipe test, and it's not a shared hash key either.
4464 Have to copy the string. */
4465 STRLEN len = SvCUR(sstr);
4466 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4467 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4468 SvCUR_set(dstr, len);
4469 *SvEND(dstr) = '\0';
4471 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4473 /* Either it's a shared hash key, or it's suitable for
4474 copy-on-write or we can swipe the string. */
4476 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4480 #ifdef PERL_COPY_ON_WRITE
4482 /* I believe I should acquire a global SV mutex if
4483 it's a COW sv (not a shared hash key) to stop
4484 it going un copy-on-write.
4485 If the source SV has gone un copy on write between up there
4486 and down here, then (assert() that) it is of the correct
4487 form to make it copy on write again */
4488 if ((sflags & (SVf_FAKE | SVf_READONLY))
4489 != (SVf_FAKE | SVf_READONLY)) {
4490 SvREADONLY_on(sstr);
4492 /* Make the source SV into a loop of 1.
4493 (about to become 2) */
4494 SV_COW_NEXT_SV_SET(sstr, sstr);
4498 /* Initial code is common. */
4499 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4501 SvFLAGS(dstr) &= ~SVf_OOK;
4502 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4504 else if (SvLEN(dstr))
4505 Safefree(SvPVX_const(dstr));
4509 /* making another shared SV. */
4510 STRLEN cur = SvCUR(sstr);
4511 STRLEN len = SvLEN(sstr);
4512 assert (SvTYPE(dstr) >= SVt_PVIV);
4513 #ifdef PERL_COPY_ON_WRITE
4515 /* SvIsCOW_normal */
4516 /* splice us in between source and next-after-source. */
4517 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4518 SV_COW_NEXT_SV_SET(sstr, dstr);
4519 SvPV_set(dstr, SvPVX(sstr));
4523 /* SvIsCOW_shared_hash */
4524 UV hash = SvUVX(sstr);
4525 DEBUG_C(PerlIO_printf(Perl_debug_log,
4526 "Copy on write: Sharing hash\n"));
4528 sharepvn(SvPVX_const(sstr),
4529 (sflags & SVf_UTF8?-cur:cur), hash));
4530 SvUV_set(dstr, hash);
4532 SvLEN_set(dstr, len);
4533 SvCUR_set(dstr, cur);
4534 SvREADONLY_on(dstr);
4536 /* Relesase a global SV mutex. */
4539 { /* Passes the swipe test. */
4540 SvPV_set(dstr, SvPVX(sstr));
4541 SvLEN_set(dstr, SvLEN(sstr));
4542 SvCUR_set(dstr, SvCUR(sstr));
4545 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4546 SvPV_set(sstr, Nullch);
4552 if (sflags & SVf_UTF8)
4555 if (sflags & SVp_NOK) {
4557 if (sflags & SVf_NOK)
4558 SvFLAGS(dstr) |= SVf_NOK;
4559 SvNV_set(dstr, SvNVX(sstr));
4561 if (sflags & SVp_IOK) {
4562 (void)SvIOKp_on(dstr);
4563 if (sflags & SVf_IOK)
4564 SvFLAGS(dstr) |= SVf_IOK;
4565 if (sflags & SVf_IVisUV)
4567 SvIV_set(dstr, SvIVX(sstr));
4570 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4571 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4572 smg->mg_ptr, smg->mg_len);
4573 SvRMAGICAL_on(dstr);
4576 else if (sflags & SVp_IOK) {
4577 if (sflags & SVf_IOK)
4578 (void)SvIOK_only(dstr);
4580 (void)SvOK_off(dstr);
4581 (void)SvIOKp_on(dstr);
4583 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4584 if (sflags & SVf_IVisUV)
4586 SvIV_set(dstr, SvIVX(sstr));
4587 if (sflags & SVp_NOK) {
4588 if (sflags & SVf_NOK)
4589 (void)SvNOK_on(dstr);
4591 (void)SvNOKp_on(dstr);
4592 SvNV_set(dstr, SvNVX(sstr));
4595 else if (sflags & SVp_NOK) {
4596 if (sflags & SVf_NOK)
4597 (void)SvNOK_only(dstr);
4599 (void)SvOK_off(dstr);
4602 SvNV_set(dstr, SvNVX(sstr));
4605 if (dtype == SVt_PVGV) {
4606 if (ckWARN(WARN_MISC))
4607 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4610 (void)SvOK_off(dstr);
4612 if (SvTAINTED(sstr))
4617 =for apidoc sv_setsv_mg
4619 Like C<sv_setsv>, but also handles 'set' magic.
4625 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4627 sv_setsv(dstr,sstr);
4631 #ifdef PERL_COPY_ON_WRITE
4633 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4635 STRLEN cur = SvCUR(sstr);
4636 STRLEN len = SvLEN(sstr);
4637 register char *new_pv;
4640 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4648 if (SvTHINKFIRST(dstr))
4649 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4650 else if (SvPVX_const(dstr))
4651 Safefree(SvPVX_const(dstr));
4655 (void)SvUPGRADE (dstr, SVt_PVIV);
4657 assert (SvPOK(sstr));
4658 assert (SvPOKp(sstr));
4659 assert (!SvIOK(sstr));
4660 assert (!SvIOKp(sstr));
4661 assert (!SvNOK(sstr));
4662 assert (!SvNOKp(sstr));
4664 if (SvIsCOW(sstr)) {
4666 if (SvLEN(sstr) == 0) {
4667 /* source is a COW shared hash key. */
4668 UV hash = SvUVX(sstr);
4669 DEBUG_C(PerlIO_printf(Perl_debug_log,
4670 "Fast copy on write: Sharing hash\n"));
4671 SvUV_set(dstr, hash);
4672 new_pv = sharepvn(SvPVX_const(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4675 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4677 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4678 (void)SvUPGRADE (sstr, SVt_PVIV);
4679 SvREADONLY_on(sstr);
4681 DEBUG_C(PerlIO_printf(Perl_debug_log,
4682 "Fast copy on write: Converting sstr to COW\n"));
4683 SV_COW_NEXT_SV_SET(dstr, sstr);
4685 SV_COW_NEXT_SV_SET(sstr, dstr);
4686 new_pv = SvPVX(sstr);
4689 SvPV_set(dstr, new_pv);
4690 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4693 SvLEN_set(dstr, len);
4694 SvCUR_set(dstr, cur);
4703 =for apidoc sv_setpvn
4705 Copies a string into an SV. The C<len> parameter indicates the number of
4706 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4707 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4713 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4715 register char *dptr;
4717 SV_CHECK_THINKFIRST_COW_DROP(sv);
4723 /* len is STRLEN which is unsigned, need to copy to signed */
4726 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4728 (void)SvUPGRADE(sv, SVt_PV);
4730 SvGROW(sv, len + 1);
4732 Move(ptr,dptr,len,char);
4735 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4740 =for apidoc sv_setpvn_mg
4742 Like C<sv_setpvn>, but also handles 'set' magic.
4748 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4750 sv_setpvn(sv,ptr,len);
4755 =for apidoc sv_setpv
4757 Copies a string into an SV. The string must be null-terminated. Does not
4758 handle 'set' magic. See C<sv_setpv_mg>.
4764 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4766 register STRLEN len;
4768 SV_CHECK_THINKFIRST_COW_DROP(sv);
4774 (void)SvUPGRADE(sv, SVt_PV);
4776 SvGROW(sv, len + 1);
4777 Move(ptr,SvPVX(sv),len+1,char);
4779 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4784 =for apidoc sv_setpv_mg
4786 Like C<sv_setpv>, but also handles 'set' magic.
4792 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4799 =for apidoc sv_usepvn
4801 Tells an SV to use C<ptr> to find its string value. Normally the string is
4802 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4803 The C<ptr> should point to memory that was allocated by C<malloc>. The
4804 string length, C<len>, must be supplied. This function will realloc the
4805 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4806 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4807 See C<sv_usepvn_mg>.
4813 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4816 SV_CHECK_THINKFIRST_COW_DROP(sv);
4817 (void)SvUPGRADE(sv, SVt_PV);
4822 if (SvPVX_const(sv))
4825 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4826 ptr = saferealloc (ptr, allocate);
4829 SvLEN_set(sv, allocate);
4831 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4836 =for apidoc sv_usepvn_mg
4838 Like C<sv_usepvn>, but also handles 'set' magic.
4844 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4846 sv_usepvn(sv,ptr,len);
4850 #ifdef PERL_COPY_ON_WRITE
4851 /* Need to do this *after* making the SV normal, as we need the buffer
4852 pointer to remain valid until after we've copied it. If we let go too early,
4853 another thread could invalidate it by unsharing last of the same hash key
4854 (which it can do by means other than releasing copy-on-write Svs)
4855 or by changing the other copy-on-write SVs in the loop. */
4857 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN cur, STRLEN len,
4858 U32 hash, SV *after)
4860 if (len) { /* this SV was SvIsCOW_normal(sv) */
4861 /* we need to find the SV pointing to us. */
4862 SV *current = SV_COW_NEXT_SV(after);
4864 if (current == sv) {
4865 /* The SV we point to points back to us (there were only two of us
4867 Hence other SV is no longer copy on write either. */
4869 SvREADONLY_off(after);
4871 /* We need to follow the pointers around the loop. */
4873 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4876 /* don't loop forever if the structure is bust, and we have
4877 a pointer into a closed loop. */
4878 assert (current != after);
4879 assert (SvPVX_const(current) == pvx);
4881 /* Make the SV before us point to the SV after us. */
4882 SV_COW_NEXT_SV_SET(current, after);
4885 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4890 Perl_sv_release_IVX(pTHX_ register SV *sv)
4893 sv_force_normal_flags(sv, 0);
4899 =for apidoc sv_force_normal_flags
4901 Undo various types of fakery on an SV: if the PV is a shared string, make
4902 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4903 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4904 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4905 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4906 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4907 set to some other value.) In addition, the C<flags> parameter gets passed to
4908 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4909 with flags set to 0.
4915 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4917 #ifdef PERL_COPY_ON_WRITE
4918 if (SvREADONLY(sv)) {
4919 /* At this point I believe I should acquire a global SV mutex. */
4921 const char *pvx = SvPVX_const(sv);
4922 STRLEN len = SvLEN(sv);
4923 STRLEN cur = SvCUR(sv);
4924 U32 hash = SvUVX(sv);
4925 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4927 PerlIO_printf(Perl_debug_log,
4928 "Copy on write: Force normal %ld\n",
4934 /* This SV doesn't own the buffer, so need to New() a new one: */
4935 SvPV_set(sv, (char*)0);
4937 if (flags & SV_COW_DROP_PV) {
4938 /* OK, so we don't need to copy our buffer. */
4941 SvGROW(sv, cur + 1);
4942 Move(pvx,SvPVX(sv),cur,char);
4946 sv_release_COW(sv, pvx, cur, len, hash, next);
4951 else if (IN_PERL_RUNTIME)
4952 Perl_croak(aTHX_ PL_no_modify);
4953 /* At this point I believe that I can drop the global SV mutex. */
4956 if (SvREADONLY(sv)) {
4958 const char *pvx = SvPVX_const(sv);
4959 const int is_utf8 = SvUTF8(sv);
4960 STRLEN len = SvCUR(sv);
4961 U32 hash = SvUVX(sv);
4964 SvPV_set(sv, (char*)0);
4966 SvGROW(sv, len + 1);
4967 Move(pvx,SvPVX_const(sv),len,char);
4969 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4971 else if (IN_PERL_RUNTIME)
4972 Perl_croak(aTHX_ PL_no_modify);
4976 sv_unref_flags(sv, flags);
4977 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4982 =for apidoc sv_force_normal
4984 Undo various types of fakery on an SV: if the PV is a shared string, make
4985 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4986 an xpvmg. See also C<sv_force_normal_flags>.
4992 Perl_sv_force_normal(pTHX_ register SV *sv)
4994 sv_force_normal_flags(sv, 0);
5000 Efficient removal of characters from the beginning of the string buffer.
5001 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5002 the string buffer. The C<ptr> becomes the first character of the adjusted
5003 string. Uses the "OOK hack".
5004 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5005 refer to the same chunk of data.
5011 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5013 register STRLEN delta;
5014 if (!ptr || !SvPOKp(sv))
5016 delta = ptr - SvPVX_const(sv);
5017 SV_CHECK_THINKFIRST(sv);
5018 if (SvTYPE(sv) < SVt_PVIV)
5019 sv_upgrade(sv,SVt_PVIV);
5022 if (!SvLEN(sv)) { /* make copy of shared string */
5023 const char *pvx = SvPVX_const(sv);
5024 STRLEN len = SvCUR(sv);
5025 SvGROW(sv, len + 1);
5026 Move(pvx,SvPVX_const(sv),len,char);
5030 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5031 and we do that anyway inside the SvNIOK_off
5033 SvFLAGS(sv) |= SVf_OOK;
5036 SvLEN_set(sv, SvLEN(sv) - delta);
5037 SvCUR_set(sv, SvCUR(sv) - delta);
5038 SvPV_set(sv, SvPVX(sv) + delta);
5039 SvIV_set(sv, SvIVX(sv) + delta);
5042 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5043 * this function provided for binary compatibility only
5047 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5049 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5053 =for apidoc sv_catpvn
5055 Concatenates the string onto the end of the string which is in the SV. The
5056 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5057 status set, then the bytes appended should be valid UTF-8.
5058 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5060 =for apidoc sv_catpvn_flags
5062 Concatenates the string onto the end of the string which is in the SV. The
5063 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5064 status set, then the bytes appended should be valid UTF-8.
5065 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5066 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5067 in terms of this function.
5073 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5076 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5078 SvGROW(dsv, dlen + slen + 1);
5080 sstr = SvPVX_const(dsv);
5081 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5082 SvCUR_set(dsv, SvCUR(dsv) + slen);
5084 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5089 =for apidoc sv_catpvn_mg
5091 Like C<sv_catpvn>, but also handles 'set' magic.
5097 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5099 sv_catpvn(sv,ptr,len);
5103 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5104 * this function provided for binary compatibility only
5108 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5110 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5114 =for apidoc sv_catsv
5116 Concatenates the string from SV C<ssv> onto the end of the string in
5117 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5118 not 'set' magic. See C<sv_catsv_mg>.
5120 =for apidoc sv_catsv_flags
5122 Concatenates the string from SV C<ssv> onto the end of the string in
5123 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5124 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5125 and C<sv_catsv_nomg> are implemented in terms of this function.
5130 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5136 if ((spv = SvPV(ssv, slen))) {
5137 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5138 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5139 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5140 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5141 dsv->sv_flags doesn't have that bit set.
5142 Andy Dougherty 12 Oct 2001
5144 const I32 sutf8 = DO_UTF8(ssv);
5147 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5149 dutf8 = DO_UTF8(dsv);
5151 if (dutf8 != sutf8) {
5153 /* Not modifying source SV, so taking a temporary copy. */
5154 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5156 sv_utf8_upgrade(csv);
5157 spv = SvPV(csv, slen);
5160 sv_utf8_upgrade_nomg(dsv);
5162 sv_catpvn_nomg(dsv, spv, slen);
5167 =for apidoc sv_catsv_mg
5169 Like C<sv_catsv>, but also handles 'set' magic.
5175 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5182 =for apidoc sv_catpv
5184 Concatenates the string onto the end of the string which is in the SV.
5185 If the SV has the UTF-8 status set, then the bytes appended should be
5186 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5191 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5193 register STRLEN len;
5199 junk = SvPV_force(sv, tlen);
5201 SvGROW(sv, tlen + len + 1);
5203 ptr = SvPVX_const(sv);
5204 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5205 SvCUR_set(sv, SvCUR(sv) + len);
5206 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5211 =for apidoc sv_catpv_mg
5213 Like C<sv_catpv>, but also handles 'set' magic.
5219 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5228 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5229 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5236 Perl_newSV(pTHX_ STRLEN len)
5242 sv_upgrade(sv, SVt_PV);
5243 SvGROW(sv, len + 1);
5248 =for apidoc sv_magicext
5250 Adds magic to an SV, upgrading it if necessary. Applies the
5251 supplied vtable and returns a pointer to the magic added.
5253 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5254 In particular, you can add magic to SvREADONLY SVs, and add more than
5255 one instance of the same 'how'.
5257 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5258 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5259 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5260 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5262 (This is now used as a subroutine by C<sv_magic>.)
5267 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5268 const char* name, I32 namlen)
5272 if (SvTYPE(sv) < SVt_PVMG) {
5273 (void)SvUPGRADE(sv, SVt_PVMG);
5275 Newz(702,mg, 1, MAGIC);
5276 mg->mg_moremagic = SvMAGIC(sv);
5277 SvMAGIC_set(sv, mg);
5279 /* Sometimes a magic contains a reference loop, where the sv and
5280 object refer to each other. To prevent a reference loop that
5281 would prevent such objects being freed, we look for such loops
5282 and if we find one we avoid incrementing the object refcount.
5284 Note we cannot do this to avoid self-tie loops as intervening RV must
5285 have its REFCNT incremented to keep it in existence.
5288 if (!obj || obj == sv ||
5289 how == PERL_MAGIC_arylen ||
5290 how == PERL_MAGIC_qr ||
5291 how == PERL_MAGIC_symtab ||
5292 (SvTYPE(obj) == SVt_PVGV &&
5293 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5294 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5295 GvFORM(obj) == (CV*)sv)))
5300 mg->mg_obj = SvREFCNT_inc(obj);
5301 mg->mg_flags |= MGf_REFCOUNTED;
5304 /* Normal self-ties simply pass a null object, and instead of
5305 using mg_obj directly, use the SvTIED_obj macro to produce a
5306 new RV as needed. For glob "self-ties", we are tieing the PVIO
5307 with an RV obj pointing to the glob containing the PVIO. In
5308 this case, to avoid a reference loop, we need to weaken the
5312 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5313 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5319 mg->mg_len = namlen;
5322 mg->mg_ptr = savepvn(name, namlen);
5323 else if (namlen == HEf_SVKEY)
5324 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5326 mg->mg_ptr = (char *) name;
5328 mg->mg_virtual = vtable;
5332 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5337 =for apidoc sv_magic
5339 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5340 then adds a new magic item of type C<how> to the head of the magic list.
5342 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5343 handling of the C<name> and C<namlen> arguments.
5345 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5346 to add more than one instance of the same 'how'.
5352 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5354 const MGVTBL *vtable = 0;
5357 #ifdef PERL_COPY_ON_WRITE
5359 sv_force_normal_flags(sv, 0);
5361 if (SvREADONLY(sv)) {
5363 && how != PERL_MAGIC_regex_global
5364 && how != PERL_MAGIC_bm
5365 && how != PERL_MAGIC_fm
5366 && how != PERL_MAGIC_sv
5367 && how != PERL_MAGIC_backref
5370 Perl_croak(aTHX_ PL_no_modify);
5373 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5374 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5375 /* sv_magic() refuses to add a magic of the same 'how' as an
5378 if (how == PERL_MAGIC_taint)
5386 vtable = &PL_vtbl_sv;
5388 case PERL_MAGIC_overload:
5389 vtable = &PL_vtbl_amagic;
5391 case PERL_MAGIC_overload_elem:
5392 vtable = &PL_vtbl_amagicelem;
5394 case PERL_MAGIC_overload_table:
5395 vtable = &PL_vtbl_ovrld;
5398 vtable = &PL_vtbl_bm;
5400 case PERL_MAGIC_regdata:
5401 vtable = &PL_vtbl_regdata;
5403 case PERL_MAGIC_regdatum:
5404 vtable = &PL_vtbl_regdatum;
5406 case PERL_MAGIC_env:
5407 vtable = &PL_vtbl_env;
5410 vtable = &PL_vtbl_fm;
5412 case PERL_MAGIC_envelem:
5413 vtable = &PL_vtbl_envelem;
5415 case PERL_MAGIC_regex_global:
5416 vtable = &PL_vtbl_mglob;
5418 case PERL_MAGIC_isa:
5419 vtable = &PL_vtbl_isa;
5421 case PERL_MAGIC_isaelem:
5422 vtable = &PL_vtbl_isaelem;
5424 case PERL_MAGIC_nkeys:
5425 vtable = &PL_vtbl_nkeys;
5427 case PERL_MAGIC_dbfile:
5430 case PERL_MAGIC_dbline:
5431 vtable = &PL_vtbl_dbline;
5433 #ifdef USE_LOCALE_COLLATE
5434 case PERL_MAGIC_collxfrm:
5435 vtable = &PL_vtbl_collxfrm;
5437 #endif /* USE_LOCALE_COLLATE */
5438 case PERL_MAGIC_tied:
5439 vtable = &PL_vtbl_pack;
5441 case PERL_MAGIC_tiedelem:
5442 case PERL_MAGIC_tiedscalar:
5443 vtable = &PL_vtbl_packelem;
5446 vtable = &PL_vtbl_regexp;
5448 case PERL_MAGIC_sig:
5449 vtable = &PL_vtbl_sig;
5451 case PERL_MAGIC_sigelem:
5452 vtable = &PL_vtbl_sigelem;
5454 case PERL_MAGIC_taint:
5455 vtable = &PL_vtbl_taint;
5457 case PERL_MAGIC_uvar:
5458 vtable = &PL_vtbl_uvar;
5460 case PERL_MAGIC_vec:
5461 vtable = &PL_vtbl_vec;
5463 case PERL_MAGIC_arylen_p:
5464 case PERL_MAGIC_rhash:
5465 case PERL_MAGIC_symtab:
5466 case PERL_MAGIC_vstring:
5469 case PERL_MAGIC_utf8:
5470 vtable = &PL_vtbl_utf8;
5472 case PERL_MAGIC_substr:
5473 vtable = &PL_vtbl_substr;
5475 case PERL_MAGIC_defelem:
5476 vtable = &PL_vtbl_defelem;
5478 case PERL_MAGIC_glob:
5479 vtable = &PL_vtbl_glob;
5481 case PERL_MAGIC_arylen:
5482 vtable = &PL_vtbl_arylen;
5484 case PERL_MAGIC_pos:
5485 vtable = &PL_vtbl_pos;
5487 case PERL_MAGIC_backref:
5488 vtable = &PL_vtbl_backref;
5490 case PERL_MAGIC_ext:
5491 /* Reserved for use by extensions not perl internals. */
5492 /* Useful for attaching extension internal data to perl vars. */
5493 /* Note that multiple extensions may clash if magical scalars */
5494 /* etc holding private data from one are passed to another. */
5497 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5500 /* Rest of work is done else where */
5501 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5504 case PERL_MAGIC_taint:
5507 case PERL_MAGIC_ext:
5508 case PERL_MAGIC_dbfile:
5515 =for apidoc sv_unmagic
5517 Removes all magic of type C<type> from an SV.
5523 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5527 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5530 for (mg = *mgp; mg; mg = *mgp) {
5531 if (mg->mg_type == type) {
5532 const MGVTBL* const vtbl = mg->mg_virtual;
5533 *mgp = mg->mg_moremagic;
5534 if (vtbl && vtbl->svt_free)
5535 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5536 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5538 Safefree(mg->mg_ptr);
5539 else if (mg->mg_len == HEf_SVKEY)
5540 SvREFCNT_dec((SV*)mg->mg_ptr);
5541 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5542 Safefree(mg->mg_ptr);
5544 if (mg->mg_flags & MGf_REFCOUNTED)
5545 SvREFCNT_dec(mg->mg_obj);
5549 mgp = &mg->mg_moremagic;
5553 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5560 =for apidoc sv_rvweaken
5562 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5563 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5564 push a back-reference to this RV onto the array of backreferences
5565 associated with that magic.
5571 Perl_sv_rvweaken(pTHX_ SV *sv)
5574 if (!SvOK(sv)) /* let undefs pass */
5577 Perl_croak(aTHX_ "Can't weaken a nonreference");
5578 else if (SvWEAKREF(sv)) {
5579 if (ckWARN(WARN_MISC))
5580 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5584 sv_add_backref(tsv, sv);
5590 /* Give tsv backref magic if it hasn't already got it, then push a
5591 * back-reference to sv onto the array associated with the backref magic.
5595 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5599 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5600 av = (AV*)mg->mg_obj;
5603 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5604 /* av now has a refcnt of 2, which avoids it getting freed
5605 * before us during global cleanup. The extra ref is removed
5606 * by magic_killbackrefs() when tsv is being freed */
5608 if (AvFILLp(av) >= AvMAX(av)) {
5610 SV **svp = AvARRAY(av);
5611 for (i = AvFILLp(av); i >= 0; i--)
5613 svp[i] = sv; /* reuse the slot */
5616 av_extend(av, AvFILLp(av)+1);
5618 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5621 /* delete a back-reference to ourselves from the backref magic associated
5622 * with the SV we point to.
5626 S_sv_del_backref(pTHX_ SV *sv)
5633 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5634 Perl_croak(aTHX_ "panic: del_backref");
5635 av = (AV *)mg->mg_obj;
5637 for (i = AvFILLp(av); i >= 0; i--)
5638 if (svp[i] == sv) svp[i] = Nullsv;
5642 =for apidoc sv_insert
5644 Inserts a string at the specified offset/length within the SV. Similar to
5645 the Perl substr() function.
5651 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5655 register char *midend;
5656 register char *bigend;
5662 Perl_croak(aTHX_ "Can't modify non-existent substring");
5663 SvPV_force(bigstr, curlen);
5664 (void)SvPOK_only_UTF8(bigstr);
5665 if (offset + len > curlen) {
5666 SvGROW(bigstr, offset+len+1);
5667 Zero(SvPVX_const(bigstr)+curlen, offset+len-curlen, char);
5668 SvCUR_set(bigstr, offset+len);
5672 i = littlelen - len;
5673 if (i > 0) { /* string might grow */
5674 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5675 mid = big + offset + len;
5676 midend = bigend = big + SvCUR(bigstr);
5679 while (midend > mid) /* shove everything down */
5680 *--bigend = *--midend;
5681 Move(little,big+offset,littlelen,char);
5682 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5687 Move(little,SvPVX(bigstr)+offset,len,char);
5692 big = SvPVX(bigstr);
5695 bigend = big + SvCUR(bigstr);
5697 if (midend > bigend)
5698 Perl_croak(aTHX_ "panic: sv_insert");
5700 if (mid - big > bigend - midend) { /* faster to shorten from end */
5702 Move(little, mid, littlelen,char);
5705 i = bigend - midend;
5707 Move(midend, mid, i,char);
5711 SvCUR_set(bigstr, mid - big);
5714 else if ((i = mid - big)) { /* faster from front */
5715 midend -= littlelen;
5717 sv_chop(bigstr,midend-i);
5722 Move(little, mid, littlelen,char);
5724 else if (littlelen) {
5725 midend -= littlelen;
5726 sv_chop(bigstr,midend);
5727 Move(little,midend,littlelen,char);
5730 sv_chop(bigstr,midend);
5736 =for apidoc sv_replace
5738 Make the first argument a copy of the second, then delete the original.
5739 The target SV physically takes over ownership of the body of the source SV
5740 and inherits its flags; however, the target keeps any magic it owns,
5741 and any magic in the source is discarded.
5742 Note that this is a rather specialist SV copying operation; most of the
5743 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5749 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5751 const U32 refcnt = SvREFCNT(sv);
5752 SV_CHECK_THINKFIRST_COW_DROP(sv);
5753 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5754 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5755 if (SvMAGICAL(sv)) {
5759 sv_upgrade(nsv, SVt_PVMG);
5760 SvMAGIC_set(nsv, SvMAGIC(sv));
5761 SvFLAGS(nsv) |= SvMAGICAL(sv);
5763 SvMAGIC_set(sv, NULL);
5767 assert(!SvREFCNT(sv));
5768 #ifdef DEBUG_LEAKING_SCALARS
5769 sv->sv_flags = nsv->sv_flags;
5770 sv->sv_any = nsv->sv_any;
5771 sv->sv_refcnt = nsv->sv_refcnt;
5773 StructCopy(nsv,sv,SV);
5775 /* Currently could join these into one piece of pointer arithmetic, but
5776 it would be unclear. */
5777 if(SvTYPE(sv) == SVt_IV)
5779 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5780 else if (SvTYPE(sv) == SVt_RV) {
5781 SvANY(sv) = &sv->sv_u.svu_rv;
5785 #ifdef PERL_COPY_ON_WRITE
5786 if (SvIsCOW_normal(nsv)) {
5787 /* We need to follow the pointers around the loop to make the
5788 previous SV point to sv, rather than nsv. */
5791 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5794 assert(SvPVX_const(current) == SvPVX_const(nsv));
5796 /* Make the SV before us point to the SV after us. */
5798 PerlIO_printf(Perl_debug_log, "previous is\n");
5800 PerlIO_printf(Perl_debug_log,
5801 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5802 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5804 SV_COW_NEXT_SV_SET(current, sv);
5807 SvREFCNT(sv) = refcnt;
5808 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5814 =for apidoc sv_clear
5816 Clear an SV: call any destructors, free up any memory used by the body,
5817 and free the body itself. The SV's head is I<not> freed, although
5818 its type is set to all 1's so that it won't inadvertently be assumed
5819 to be live during global destruction etc.
5820 This function should only be called when REFCNT is zero. Most of the time
5821 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5828 Perl_sv_clear(pTHX_ register SV *sv)
5833 assert(SvREFCNT(sv) == 0);
5836 if (PL_defstash) { /* Still have a symbol table? */
5840 stash = SvSTASH(sv);
5841 destructor = StashHANDLER(stash,DESTROY);
5843 SV* tmpref = newRV(sv);
5844 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5846 PUSHSTACKi(PERLSI_DESTROY);
5851 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5857 if(SvREFCNT(tmpref) < 2) {
5858 /* tmpref is not kept alive! */
5860 SvRV_set(tmpref, NULL);
5863 SvREFCNT_dec(tmpref);
5865 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5869 if (PL_in_clean_objs)
5870 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5872 /* DESTROY gave object new lease on life */
5878 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5879 SvOBJECT_off(sv); /* Curse the object. */
5880 if (SvTYPE(sv) != SVt_PVIO)
5881 --PL_sv_objcount; /* XXX Might want something more general */
5884 if (SvTYPE(sv) >= SVt_PVMG) {
5887 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5888 SvREFCNT_dec(SvSTASH(sv));
5891 switch (SvTYPE(sv)) {
5894 IoIFP(sv) != PerlIO_stdin() &&
5895 IoIFP(sv) != PerlIO_stdout() &&
5896 IoIFP(sv) != PerlIO_stderr())
5898 io_close((IO*)sv, FALSE);
5900 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5901 PerlDir_close(IoDIRP(sv));
5902 IoDIRP(sv) = (DIR*)NULL;
5903 Safefree(IoTOP_NAME(sv));
5904 Safefree(IoFMT_NAME(sv));
5905 Safefree(IoBOTTOM_NAME(sv));
5920 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5921 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5922 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5923 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5925 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5926 SvREFCNT_dec(LvTARG(sv));
5930 Safefree(GvNAME(sv));
5931 /* cannot decrease stash refcount yet, as we might recursively delete
5932 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5933 of stash until current sv is completely gone.
5934 -- JohnPC, 27 Mar 1998 */
5935 stash = GvSTASH(sv);
5941 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5943 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5944 /* Don't even bother with turning off the OOK flag. */
5953 SvREFCNT_dec(SvRV(sv));
5955 #ifdef PERL_COPY_ON_WRITE
5956 else if (SvPVX_const(sv)) {
5958 /* I believe I need to grab the global SV mutex here and
5959 then recheck the COW status. */
5961 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5964 sv_release_COW(sv, SvPVX_const(sv), SvCUR(sv), SvLEN(sv),
5965 SvUVX(sv), SV_COW_NEXT_SV(sv));
5966 /* And drop it here. */
5968 } else if (SvLEN(sv)) {
5969 Safefree(SvPVX_const(sv));
5973 else if (SvPVX_const(sv) && SvLEN(sv))
5974 Safefree(SvPVX_const(sv));
5975 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5976 unsharepvn(SvPVX_const(sv),
5977 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5991 switch (SvTYPE(sv)) {
6005 del_XPVIV(SvANY(sv));
6008 del_XPVNV(SvANY(sv));
6011 del_XPVMG(SvANY(sv));
6014 del_XPVLV(SvANY(sv));
6017 del_XPVAV(SvANY(sv));
6020 del_XPVHV(SvANY(sv));
6023 del_XPVCV(SvANY(sv));
6026 del_XPVGV(SvANY(sv));
6027 /* code duplication for increased performance. */
6028 SvFLAGS(sv) &= SVf_BREAK;
6029 SvFLAGS(sv) |= SVTYPEMASK;
6030 /* decrease refcount of the stash that owns this GV, if any */
6032 SvREFCNT_dec(stash);
6033 return; /* not break, SvFLAGS reset already happened */
6035 del_XPVBM(SvANY(sv));
6038 del_XPVFM(SvANY(sv));
6041 del_XPVIO(SvANY(sv));
6044 SvFLAGS(sv) &= SVf_BREAK;
6045 SvFLAGS(sv) |= SVTYPEMASK;
6049 =for apidoc sv_newref
6051 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6058 Perl_sv_newref(pTHX_ SV *sv)
6068 Decrement an SV's reference count, and if it drops to zero, call
6069 C<sv_clear> to invoke destructors and free up any memory used by
6070 the body; finally, deallocate the SV's head itself.
6071 Normally called via a wrapper macro C<SvREFCNT_dec>.
6077 Perl_sv_free(pTHX_ SV *sv)
6082 if (SvREFCNT(sv) == 0) {
6083 if (SvFLAGS(sv) & SVf_BREAK)
6084 /* this SV's refcnt has been artificially decremented to
6085 * trigger cleanup */
6087 if (PL_in_clean_all) /* All is fair */
6089 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6090 /* make sure SvREFCNT(sv)==0 happens very seldom */
6091 SvREFCNT(sv) = (~(U32)0)/2;
6094 if (ckWARN_d(WARN_INTERNAL))
6095 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6096 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6097 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6100 if (--(SvREFCNT(sv)) > 0)
6102 Perl_sv_free2(aTHX_ sv);
6106 Perl_sv_free2(pTHX_ SV *sv)
6111 if (ckWARN_d(WARN_DEBUGGING))
6112 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6113 "Attempt to free temp prematurely: SV 0x%"UVxf
6114 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6118 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6119 /* make sure SvREFCNT(sv)==0 happens very seldom */
6120 SvREFCNT(sv) = (~(U32)0)/2;
6131 Returns the length of the string in the SV. Handles magic and type
6132 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6138 Perl_sv_len(pTHX_ register SV *sv)
6146 len = mg_length(sv);
6148 (void)SvPV(sv, len);
6153 =for apidoc sv_len_utf8
6155 Returns the number of characters in the string in an SV, counting wide
6156 UTF-8 bytes as a single character. Handles magic and type coercion.
6162 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6163 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6164 * (Note that the mg_len is not the length of the mg_ptr field.)
6169 Perl_sv_len_utf8(pTHX_ register SV *sv)
6175 return mg_length(sv);
6179 const U8 *s = (U8*)SvPV(sv, len);
6180 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6182 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6184 #ifdef PERL_UTF8_CACHE_ASSERT
6185 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6189 ulen = Perl_utf8_length(aTHX_ s, s + len);
6190 if (!mg && !SvREADONLY(sv)) {
6191 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6192 mg = mg_find(sv, PERL_MAGIC_utf8);
6202 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6203 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6204 * between UTF-8 and byte offsets. There are two (substr offset and substr
6205 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6206 * and byte offset) cache positions.
6208 * The mg_len field is used by sv_len_utf8(), see its comments.
6209 * Note that the mg_len is not the length of the mg_ptr field.
6213 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
6217 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6219 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6223 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6225 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6226 (*mgp)->mg_ptr = (char *) *cachep;
6230 (*cachep)[i] = offsetp;
6231 (*cachep)[i+1] = s - start;
6239 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6240 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6241 * between UTF-8 and byte offsets. See also the comments of
6242 * S_utf8_mg_pos_init().
6246 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6250 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6252 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6253 if (*mgp && (*mgp)->mg_ptr) {
6254 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6255 ASSERT_UTF8_CACHE(*cachep);
6256 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6258 else { /* We will skip to the right spot. */
6263 /* The assumption is that going backward is half
6264 * the speed of going forward (that's where the
6265 * 2 * backw in the below comes from). (The real
6266 * figure of course depends on the UTF-8 data.) */
6268 if ((*cachep)[i] > (STRLEN)uoff) {
6270 backw = (*cachep)[i] - (STRLEN)uoff;
6272 if (forw < 2 * backw)
6275 p = start + (*cachep)[i+1];
6277 /* Try this only for the substr offset (i == 0),
6278 * not for the substr length (i == 2). */
6279 else if (i == 0) { /* (*cachep)[i] < uoff */
6280 const STRLEN ulen = sv_len_utf8(sv);
6282 if ((STRLEN)uoff < ulen) {
6283 forw = (STRLEN)uoff - (*cachep)[i];
6284 backw = ulen - (STRLEN)uoff;
6286 if (forw < 2 * backw)
6287 p = start + (*cachep)[i+1];
6292 /* If the string is not long enough for uoff,
6293 * we could extend it, but not at this low a level. */
6297 if (forw < 2 * backw) {
6304 while (UTF8_IS_CONTINUATION(*p))
6309 /* Update the cache. */
6310 (*cachep)[i] = (STRLEN)uoff;
6311 (*cachep)[i+1] = p - start;
6313 /* Drop the stale "length" cache */
6322 if (found) { /* Setup the return values. */
6323 *offsetp = (*cachep)[i+1];
6324 *sp = start + *offsetp;
6327 *offsetp = send - start;
6329 else if (*sp < start) {
6335 #ifdef PERL_UTF8_CACHE_ASSERT
6340 while (n-- && s < send)
6344 assert(*offsetp == s - start);
6345 assert((*cachep)[0] == (STRLEN)uoff);
6346 assert((*cachep)[1] == *offsetp);
6348 ASSERT_UTF8_CACHE(*cachep);
6357 =for apidoc sv_pos_u2b
6359 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6360 the start of the string, to a count of the equivalent number of bytes; if
6361 lenp is non-zero, it does the same to lenp, but this time starting from
6362 the offset, rather than from the start of the string. Handles magic and
6369 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6370 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6371 * byte offsets. See also the comments of S_utf8_mg_pos().
6376 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6384 start = (U8*)SvPV(sv, len);
6389 I32 uoffset = *offsetp;
6394 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6396 if (!found && uoffset > 0) {
6397 while (s < send && uoffset--)
6401 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6403 *offsetp = s - start;
6408 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6412 if (!found && *lenp > 0) {
6415 while (s < send && ulen--)
6419 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6423 ASSERT_UTF8_CACHE(cache);
6435 =for apidoc sv_pos_b2u
6437 Converts the value pointed to by offsetp from a count of bytes from the
6438 start of the string, to a count of the equivalent number of UTF-8 chars.
6439 Handles magic and type coercion.
6445 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6446 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6447 * byte offsets. See also the comments of S_utf8_mg_pos().
6452 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6460 s = (U8*)SvPV(sv, len);
6461 if ((I32)len < *offsetp)
6462 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6464 U8* send = s + *offsetp;
6466 STRLEN *cache = NULL;
6470 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6471 mg = mg_find(sv, PERL_MAGIC_utf8);
6472 if (mg && mg->mg_ptr) {
6473 cache = (STRLEN *) mg->mg_ptr;
6474 if (cache[1] == (STRLEN)*offsetp) {
6475 /* An exact match. */
6476 *offsetp = cache[0];
6480 else if (cache[1] < (STRLEN)*offsetp) {
6481 /* We already know part of the way. */
6484 /* Let the below loop do the rest. */
6486 else { /* cache[1] > *offsetp */
6487 /* We already know all of the way, now we may
6488 * be able to walk back. The same assumption
6489 * is made as in S_utf8_mg_pos(), namely that
6490 * walking backward is twice slower than
6491 * walking forward. */
6492 STRLEN forw = *offsetp;
6493 STRLEN backw = cache[1] - *offsetp;
6495 if (!(forw < 2 * backw)) {
6496 U8 *p = s + cache[1];
6503 while (UTF8_IS_CONTINUATION(*p)) {
6511 *offsetp = cache[0];
6513 /* Drop the stale "length" cache */
6521 ASSERT_UTF8_CACHE(cache);
6527 /* Call utf8n_to_uvchr() to validate the sequence
6528 * (unless a simple non-UTF character) */
6529 if (!UTF8_IS_INVARIANT(*s))
6530 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6539 if (!SvREADONLY(sv)) {
6541 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6542 mg = mg_find(sv, PERL_MAGIC_utf8);
6547 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6548 mg->mg_ptr = (char *) cache;
6553 cache[1] = *offsetp;
6554 /* Drop the stale "length" cache */
6567 Returns a boolean indicating whether the strings in the two SVs are
6568 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6569 coerce its args to strings if necessary.
6575 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6583 SV* svrecode = Nullsv;
6590 pv1 = SvPV(sv1, cur1);
6597 pv2 = SvPV(sv2, cur2);
6599 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6600 /* Differing utf8ness.
6601 * Do not UTF8size the comparands as a side-effect. */
6604 svrecode = newSVpvn(pv2, cur2);
6605 sv_recode_to_utf8(svrecode, PL_encoding);
6606 pv2 = SvPV(svrecode, cur2);
6609 svrecode = newSVpvn(pv1, cur1);
6610 sv_recode_to_utf8(svrecode, PL_encoding);
6611 pv1 = SvPV(svrecode, cur1);
6613 /* Now both are in UTF-8. */
6615 SvREFCNT_dec(svrecode);
6620 bool is_utf8 = TRUE;
6623 /* sv1 is the UTF-8 one,
6624 * if is equal it must be downgrade-able */
6625 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6631 /* sv2 is the UTF-8 one,
6632 * if is equal it must be downgrade-able */
6633 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6639 /* Downgrade not possible - cannot be eq */
6647 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6650 SvREFCNT_dec(svrecode);
6661 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6662 string in C<sv1> is less than, equal to, or greater than the string in
6663 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6664 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6670 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6673 const char *pv1, *pv2;
6676 SV *svrecode = Nullsv;
6683 pv1 = SvPV(sv1, cur1);
6690 pv2 = SvPV(sv2, cur2);
6692 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6693 /* Differing utf8ness.
6694 * Do not UTF8size the comparands as a side-effect. */
6697 svrecode = newSVpvn(pv2, cur2);
6698 sv_recode_to_utf8(svrecode, PL_encoding);
6699 pv2 = SvPV(svrecode, cur2);
6702 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6707 svrecode = newSVpvn(pv1, cur1);
6708 sv_recode_to_utf8(svrecode, PL_encoding);
6709 pv1 = SvPV(svrecode, cur1);
6712 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6718 cmp = cur2 ? -1 : 0;
6722 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6725 cmp = retval < 0 ? -1 : 1;
6726 } else if (cur1 == cur2) {
6729 cmp = cur1 < cur2 ? -1 : 1;
6734 SvREFCNT_dec(svrecode);
6743 =for apidoc sv_cmp_locale
6745 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6746 'use bytes' aware, handles get magic, and will coerce its args to strings
6747 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6753 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6755 #ifdef USE_LOCALE_COLLATE
6761 if (PL_collation_standard)
6765 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6767 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6769 if (!pv1 || !len1) {
6780 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6783 return retval < 0 ? -1 : 1;
6786 * When the result of collation is equality, that doesn't mean
6787 * that there are no differences -- some locales exclude some
6788 * characters from consideration. So to avoid false equalities,
6789 * we use the raw string as a tiebreaker.
6795 #endif /* USE_LOCALE_COLLATE */
6797 return sv_cmp(sv1, sv2);
6801 #ifdef USE_LOCALE_COLLATE
6804 =for apidoc sv_collxfrm
6806 Add Collate Transform magic to an SV if it doesn't already have it.
6808 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6809 scalar data of the variable, but transformed to such a format that a normal
6810 memory comparison can be used to compare the data according to the locale
6817 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6821 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6822 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6827 Safefree(mg->mg_ptr);
6829 if ((xf = mem_collxfrm(s, len, &xlen))) {
6830 if (SvREADONLY(sv)) {
6833 return xf + sizeof(PL_collation_ix);
6836 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6837 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6850 if (mg && mg->mg_ptr) {
6852 return mg->mg_ptr + sizeof(PL_collation_ix);
6860 #endif /* USE_LOCALE_COLLATE */
6865 Get a line from the filehandle and store it into the SV, optionally
6866 appending to the currently-stored string.
6872 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6876 register STDCHAR rslast;
6877 register STDCHAR *bp;
6883 if (SvTHINKFIRST(sv))
6884 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6885 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6887 However, perlbench says it's slower, because the existing swipe code
6888 is faster than copy on write.
6889 Swings and roundabouts. */
6890 (void)SvUPGRADE(sv, SVt_PV);
6895 if (PerlIO_isutf8(fp)) {
6897 sv_utf8_upgrade_nomg(sv);
6898 sv_pos_u2b(sv,&append,0);
6900 } else if (SvUTF8(sv)) {
6901 SV *tsv = NEWSV(0,0);
6902 sv_gets(tsv, fp, 0);
6903 sv_utf8_upgrade_nomg(tsv);
6904 SvCUR_set(sv,append);
6907 goto return_string_or_null;
6912 if (PerlIO_isutf8(fp))
6915 if (IN_PERL_COMPILETIME) {
6916 /* we always read code in line mode */
6920 else if (RsSNARF(PL_rs)) {
6921 /* If it is a regular disk file use size from stat() as estimate
6922 of amount we are going to read - may result in malloc-ing
6923 more memory than we realy need if layers bellow reduce
6924 size we read (e.g. CRLF or a gzip layer)
6927 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6928 const Off_t offset = PerlIO_tell(fp);
6929 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6930 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6936 else if (RsRECORD(PL_rs)) {
6940 /* Grab the size of the record we're getting */
6941 recsize = SvIV(SvRV(PL_rs));
6942 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6945 /* VMS wants read instead of fread, because fread doesn't respect */
6946 /* RMS record boundaries. This is not necessarily a good thing to be */
6947 /* doing, but we've got no other real choice - except avoid stdio
6948 as implementation - perhaps write a :vms layer ?
6950 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6952 bytesread = PerlIO_read(fp, buffer, recsize);
6956 SvCUR_set(sv, bytesread += append);
6957 buffer[bytesread] = '\0';
6958 goto return_string_or_null;
6960 else if (RsPARA(PL_rs)) {
6966 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6967 if (PerlIO_isutf8(fp)) {
6968 rsptr = SvPVutf8(PL_rs, rslen);
6971 if (SvUTF8(PL_rs)) {
6972 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6973 Perl_croak(aTHX_ "Wide character in $/");
6976 rsptr = SvPV(PL_rs, rslen);
6980 rslast = rslen ? rsptr[rslen - 1] : '\0';
6982 if (rspara) { /* have to do this both before and after */
6983 do { /* to make sure file boundaries work right */
6986 i = PerlIO_getc(fp);
6990 PerlIO_ungetc(fp,i);
6996 /* See if we know enough about I/O mechanism to cheat it ! */
6998 /* This used to be #ifdef test - it is made run-time test for ease
6999 of abstracting out stdio interface. One call should be cheap
7000 enough here - and may even be a macro allowing compile
7004 if (PerlIO_fast_gets(fp)) {
7007 * We're going to steal some values from the stdio struct
7008 * and put EVERYTHING in the innermost loop into registers.
7010 register STDCHAR *ptr;
7014 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7015 /* An ungetc()d char is handled separately from the regular
7016 * buffer, so we getc() it back out and stuff it in the buffer.
7018 i = PerlIO_getc(fp);
7019 if (i == EOF) return 0;
7020 *(--((*fp)->_ptr)) = (unsigned char) i;
7024 /* Here is some breathtakingly efficient cheating */
7026 cnt = PerlIO_get_cnt(fp); /* get count into register */
7027 /* make sure we have the room */
7028 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7029 /* Not room for all of it
7030 if we are looking for a separator and room for some
7032 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7033 /* just process what we have room for */
7034 shortbuffered = cnt - SvLEN(sv) + append + 1;
7035 cnt -= shortbuffered;
7039 /* remember that cnt can be negative */
7040 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7045 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7046 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7047 DEBUG_P(PerlIO_printf(Perl_debug_log,
7048 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7049 DEBUG_P(PerlIO_printf(Perl_debug_log,
7050 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7051 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7052 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7057 while (cnt > 0) { /* this | eat */
7059 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7060 goto thats_all_folks; /* screams | sed :-) */
7064 Copy(ptr, bp, cnt, char); /* this | eat */
7065 bp += cnt; /* screams | dust */
7066 ptr += cnt; /* louder | sed :-) */
7071 if (shortbuffered) { /* oh well, must extend */
7072 cnt = shortbuffered;
7074 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7076 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7077 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7081 DEBUG_P(PerlIO_printf(Perl_debug_log,
7082 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7083 PTR2UV(ptr),(long)cnt));
7084 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7086 DEBUG_P(PerlIO_printf(Perl_debug_log,
7087 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7088 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7089 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7091 /* This used to call 'filbuf' in stdio form, but as that behaves like
7092 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7093 another abstraction. */
7094 i = PerlIO_getc(fp); /* get more characters */
7096 DEBUG_P(PerlIO_printf(Perl_debug_log,
7097 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7098 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7099 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7101 cnt = PerlIO_get_cnt(fp);
7102 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7103 DEBUG_P(PerlIO_printf(Perl_debug_log,
7104 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7106 if (i == EOF) /* all done for ever? */
7107 goto thats_really_all_folks;
7109 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7111 SvGROW(sv, bpx + cnt + 2);
7112 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7114 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7116 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7117 goto thats_all_folks;
7121 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7122 memNE((char*)bp - rslen, rsptr, rslen))
7123 goto screamer; /* go back to the fray */
7124 thats_really_all_folks:
7126 cnt += shortbuffered;
7127 DEBUG_P(PerlIO_printf(Perl_debug_log,
7128 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7129 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7130 DEBUG_P(PerlIO_printf(Perl_debug_log,
7131 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7132 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7133 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7135 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7136 DEBUG_P(PerlIO_printf(Perl_debug_log,
7137 "Screamer: done, len=%ld, string=|%.*s|\n",
7138 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7142 /*The big, slow, and stupid way. */
7143 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7145 New(0, buf, 8192, STDCHAR);
7153 const register STDCHAR *bpe = buf + sizeof(buf);
7155 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7156 ; /* keep reading */
7160 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7161 /* Accomodate broken VAXC compiler, which applies U8 cast to
7162 * both args of ?: operator, causing EOF to change into 255
7165 i = (U8)buf[cnt - 1];
7171 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7173 sv_catpvn(sv, (char *) buf, cnt);
7175 sv_setpvn(sv, (char *) buf, cnt);
7177 if (i != EOF && /* joy */
7179 SvCUR(sv) < rslen ||
7180 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7184 * If we're reading from a TTY and we get a short read,
7185 * indicating that the user hit his EOF character, we need
7186 * to notice it now, because if we try to read from the TTY
7187 * again, the EOF condition will disappear.
7189 * The comparison of cnt to sizeof(buf) is an optimization
7190 * that prevents unnecessary calls to feof().
7194 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7198 #ifdef USE_HEAP_INSTEAD_OF_STACK
7203 if (rspara) { /* have to do this both before and after */
7204 while (i != EOF) { /* to make sure file boundaries work right */
7205 i = PerlIO_getc(fp);
7207 PerlIO_ungetc(fp,i);
7213 return_string_or_null:
7214 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7220 Auto-increment of the value in the SV, doing string to numeric conversion
7221 if necessary. Handles 'get' magic.
7227 Perl_sv_inc(pTHX_ register SV *sv)
7236 if (SvTHINKFIRST(sv)) {
7238 sv_force_normal_flags(sv, 0);
7239 if (SvREADONLY(sv)) {
7240 if (IN_PERL_RUNTIME)
7241 Perl_croak(aTHX_ PL_no_modify);
7245 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7247 i = PTR2IV(SvRV(sv));
7252 flags = SvFLAGS(sv);
7253 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7254 /* It's (privately or publicly) a float, but not tested as an
7255 integer, so test it to see. */
7257 flags = SvFLAGS(sv);
7259 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7260 /* It's publicly an integer, or privately an integer-not-float */
7261 #ifdef PERL_PRESERVE_IVUV
7265 if (SvUVX(sv) == UV_MAX)
7266 sv_setnv(sv, UV_MAX_P1);
7268 (void)SvIOK_only_UV(sv);
7269 SvUV_set(sv, SvUVX(sv) + 1);
7271 if (SvIVX(sv) == IV_MAX)
7272 sv_setuv(sv, (UV)IV_MAX + 1);
7274 (void)SvIOK_only(sv);
7275 SvIV_set(sv, SvIVX(sv) + 1);
7280 if (flags & SVp_NOK) {
7281 (void)SvNOK_only(sv);
7282 SvNV_set(sv, SvNVX(sv) + 1.0);
7286 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7287 if ((flags & SVTYPEMASK) < SVt_PVIV)
7288 sv_upgrade(sv, SVt_IV);
7289 (void)SvIOK_only(sv);
7294 while (isALPHA(*d)) d++;
7295 while (isDIGIT(*d)) d++;
7297 #ifdef PERL_PRESERVE_IVUV
7298 /* Got to punt this as an integer if needs be, but we don't issue
7299 warnings. Probably ought to make the sv_iv_please() that does
7300 the conversion if possible, and silently. */
7301 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7302 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7303 /* Need to try really hard to see if it's an integer.
7304 9.22337203685478e+18 is an integer.
7305 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7306 so $a="9.22337203685478e+18"; $a+0; $a++
7307 needs to be the same as $a="9.22337203685478e+18"; $a++
7314 /* sv_2iv *should* have made this an NV */
7315 if (flags & SVp_NOK) {
7316 (void)SvNOK_only(sv);
7317 SvNV_set(sv, SvNVX(sv) + 1.0);
7320 /* I don't think we can get here. Maybe I should assert this
7321 And if we do get here I suspect that sv_setnv will croak. NWC
7323 #if defined(USE_LONG_DOUBLE)
7324 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",
7325 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7327 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7328 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7331 #endif /* PERL_PRESERVE_IVUV */
7332 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7336 while (d >= SvPVX_const(sv)) {
7344 /* MKS: The original code here died if letters weren't consecutive.
7345 * at least it didn't have to worry about non-C locales. The
7346 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7347 * arranged in order (although not consecutively) and that only
7348 * [A-Za-z] are accepted by isALPHA in the C locale.
7350 if (*d != 'z' && *d != 'Z') {
7351 do { ++*d; } while (!isALPHA(*d));
7354 *(d--) -= 'z' - 'a';
7359 *(d--) -= 'z' - 'a' + 1;
7363 /* oh,oh, the number grew */
7364 SvGROW(sv, SvCUR(sv) + 2);
7365 SvCUR_set(sv, SvCUR(sv) + 1);
7366 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7377 Auto-decrement of the value in the SV, doing string to numeric conversion
7378 if necessary. Handles 'get' magic.
7384 Perl_sv_dec(pTHX_ register SV *sv)
7392 if (SvTHINKFIRST(sv)) {
7394 sv_force_normal_flags(sv, 0);
7395 if (SvREADONLY(sv)) {
7396 if (IN_PERL_RUNTIME)
7397 Perl_croak(aTHX_ PL_no_modify);
7401 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7403 i = PTR2IV(SvRV(sv));
7408 /* Unlike sv_inc we don't have to worry about string-never-numbers
7409 and keeping them magic. But we mustn't warn on punting */
7410 flags = SvFLAGS(sv);
7411 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7412 /* It's publicly an integer, or privately an integer-not-float */
7413 #ifdef PERL_PRESERVE_IVUV
7417 if (SvUVX(sv) == 0) {
7418 (void)SvIOK_only(sv);
7422 (void)SvIOK_only_UV(sv);
7423 SvUV_set(sv, SvUVX(sv) + 1);
7426 if (SvIVX(sv) == IV_MIN)
7427 sv_setnv(sv, (NV)IV_MIN - 1.0);
7429 (void)SvIOK_only(sv);
7430 SvIV_set(sv, SvIVX(sv) - 1);
7435 if (flags & SVp_NOK) {
7436 SvNV_set(sv, SvNVX(sv) - 1.0);
7437 (void)SvNOK_only(sv);
7440 if (!(flags & SVp_POK)) {
7441 if ((flags & SVTYPEMASK) < SVt_PVNV)
7442 sv_upgrade(sv, SVt_NV);
7444 (void)SvNOK_only(sv);
7447 #ifdef PERL_PRESERVE_IVUV
7449 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7450 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7451 /* Need to try really hard to see if it's an integer.
7452 9.22337203685478e+18 is an integer.
7453 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7454 so $a="9.22337203685478e+18"; $a+0; $a--
7455 needs to be the same as $a="9.22337203685478e+18"; $a--
7462 /* sv_2iv *should* have made this an NV */
7463 if (flags & SVp_NOK) {
7464 (void)SvNOK_only(sv);
7465 SvNV_set(sv, SvNVX(sv) - 1.0);
7468 /* I don't think we can get here. Maybe I should assert this
7469 And if we do get here I suspect that sv_setnv will croak. NWC
7471 #if defined(USE_LONG_DOUBLE)
7472 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",
7473 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7475 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7476 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7480 #endif /* PERL_PRESERVE_IVUV */
7481 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7485 =for apidoc sv_mortalcopy
7487 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7488 The new SV is marked as mortal. It will be destroyed "soon", either by an
7489 explicit call to FREETMPS, or by an implicit call at places such as
7490 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7495 /* Make a string that will exist for the duration of the expression
7496 * evaluation. Actually, it may have to last longer than that, but
7497 * hopefully we won't free it until it has been assigned to a
7498 * permanent location. */
7501 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7506 sv_setsv(sv,oldstr);
7508 PL_tmps_stack[++PL_tmps_ix] = sv;
7514 =for apidoc sv_newmortal
7516 Creates a new null SV which is mortal. The reference count of the SV is
7517 set to 1. It will be destroyed "soon", either by an explicit call to
7518 FREETMPS, or by an implicit call at places such as statement boundaries.
7519 See also C<sv_mortalcopy> and C<sv_2mortal>.
7525 Perl_sv_newmortal(pTHX)
7530 SvFLAGS(sv) = SVs_TEMP;
7532 PL_tmps_stack[++PL_tmps_ix] = sv;
7537 =for apidoc sv_2mortal
7539 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7540 by an explicit call to FREETMPS, or by an implicit call at places such as
7541 statement boundaries. SvTEMP() is turned on which means that the SV's
7542 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7543 and C<sv_mortalcopy>.
7549 Perl_sv_2mortal(pTHX_ register SV *sv)
7554 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7557 PL_tmps_stack[++PL_tmps_ix] = sv;
7565 Creates a new SV and copies a string into it. The reference count for the
7566 SV is set to 1. If C<len> is zero, Perl will compute the length using
7567 strlen(). For efficiency, consider using C<newSVpvn> instead.
7573 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7578 sv_setpvn(sv,s,len ? len : strlen(s));
7583 =for apidoc newSVpvn
7585 Creates a new SV and copies a string into it. The reference count for the
7586 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7587 string. You are responsible for ensuring that the source string is at least
7588 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7594 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7599 sv_setpvn(sv,s,len);
7605 =for apidoc newSVpv_hek
7607 Creates a new SV from the hash key structure. It will generate scalars that
7608 point to the shared string table where possible. Returns a new (undefined)
7609 SV if the hek is NULL.
7615 Perl_newSVhek(pTHX_ const HEK *hek)
7624 if (HEK_LEN(hek) == HEf_SVKEY) {
7625 return newSVsv(*(SV**)HEK_KEY(hek));
7627 const int flags = HEK_FLAGS(hek);
7628 if (flags & HVhek_WASUTF8) {
7630 Andreas would like keys he put in as utf8 to come back as utf8
7632 STRLEN utf8_len = HEK_LEN(hek);
7633 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7634 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7637 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7639 } else if (flags & HVhek_REHASH) {
7640 /* We don't have a pointer to the hv, so we have to replicate the
7641 flag into every HEK. This hv is using custom a hasing
7642 algorithm. Hence we can't return a shared string scalar, as
7643 that would contain the (wrong) hash value, and might get passed
7644 into an hv routine with a regular hash */
7646 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7651 /* This will be overwhelminly the most common case. */
7652 return newSVpvn_share(HEK_KEY(hek),
7653 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7659 =for apidoc newSVpvn_share
7661 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7662 table. If the string does not already exist in the table, it is created
7663 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7664 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7665 otherwise the hash is computed. The idea here is that as the string table
7666 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7667 hash lookup will avoid string compare.
7673 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7676 bool is_utf8 = FALSE;
7678 STRLEN tmplen = -len;
7680 /* See the note in hv.c:hv_fetch() --jhi */
7681 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7685 PERL_HASH(hash, src, len);
7687 sv_upgrade(sv, SVt_PVIV);
7688 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7701 #if defined(PERL_IMPLICIT_CONTEXT)
7703 /* pTHX_ magic can't cope with varargs, so this is a no-context
7704 * version of the main function, (which may itself be aliased to us).
7705 * Don't access this version directly.
7709 Perl_newSVpvf_nocontext(const char* pat, ...)
7714 va_start(args, pat);
7715 sv = vnewSVpvf(pat, &args);
7722 =for apidoc newSVpvf
7724 Creates a new SV and initializes it with the string formatted like
7731 Perl_newSVpvf(pTHX_ const char* pat, ...)
7735 va_start(args, pat);
7736 sv = vnewSVpvf(pat, &args);
7741 /* backend for newSVpvf() and newSVpvf_nocontext() */
7744 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7748 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7755 Creates a new SV and copies a floating point value into it.
7756 The reference count for the SV is set to 1.
7762 Perl_newSVnv(pTHX_ NV n)
7774 Creates a new SV and copies an integer into it. The reference count for the
7781 Perl_newSViv(pTHX_ IV i)
7793 Creates a new SV and copies an unsigned integer into it.
7794 The reference count for the SV is set to 1.
7800 Perl_newSVuv(pTHX_ UV u)
7810 =for apidoc newRV_noinc
7812 Creates an RV wrapper for an SV. The reference count for the original
7813 SV is B<not> incremented.
7819 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7824 sv_upgrade(sv, SVt_RV);
7826 SvRV_set(sv, tmpRef);
7831 /* newRV_inc is the official function name to use now.
7832 * newRV_inc is in fact #defined to newRV in sv.h
7836 Perl_newRV(pTHX_ SV *tmpRef)
7838 return newRV_noinc(SvREFCNT_inc(tmpRef));
7844 Creates a new SV which is an exact duplicate of the original SV.
7851 Perl_newSVsv(pTHX_ register SV *old)
7857 if (SvTYPE(old) == SVTYPEMASK) {
7858 if (ckWARN_d(WARN_INTERNAL))
7859 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7863 /* SV_GMAGIC is the default for sv_setv()
7864 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7865 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7866 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7871 =for apidoc sv_reset
7873 Underlying implementation for the C<reset> Perl function.
7874 Note that the perl-level function is vaguely deprecated.
7880 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7883 char todo[PERL_UCHAR_MAX+1];
7888 if (!*s) { /* reset ?? searches */
7889 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7891 PMOP *pm = (PMOP *) mg->mg_obj;
7893 pm->op_pmdynflags &= ~PMdf_USED;
7900 /* reset variables */
7902 if (!HvARRAY(stash))
7905 Zero(todo, 256, char);
7908 I32 i = (unsigned char)*s;
7912 max = (unsigned char)*s++;
7913 for ( ; i <= max; i++) {
7916 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7918 for (entry = HvARRAY(stash)[i];
7920 entry = HeNEXT(entry))
7925 if (!todo[(U8)*HeKEY(entry)])
7927 gv = (GV*)HeVAL(entry);
7929 if (SvTHINKFIRST(sv)) {
7930 if (!SvREADONLY(sv) && SvROK(sv))
7935 if (SvTYPE(sv) >= SVt_PV) {
7937 if (SvPVX_const(sv) != Nullch)
7944 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7947 #ifdef USE_ENVIRON_ARRAY
7949 # ifdef USE_ITHREADS
7950 && PL_curinterp == aTHX
7954 environ[0] = Nullch;
7957 #endif /* !PERL_MICRO */
7967 Using various gambits, try to get an IO from an SV: the IO slot if its a
7968 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7969 named after the PV if we're a string.
7975 Perl_sv_2io(pTHX_ SV *sv)
7980 switch (SvTYPE(sv)) {
7988 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7992 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7994 return sv_2io(SvRV(sv));
7995 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8001 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8010 Using various gambits, try to get a CV from an SV; in addition, try if
8011 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8017 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8024 return *gvp = Nullgv, Nullcv;
8025 switch (SvTYPE(sv)) {
8044 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8045 tryAMAGICunDEREF(to_cv);
8048 if (SvTYPE(sv) == SVt_PVCV) {
8057 Perl_croak(aTHX_ "Not a subroutine reference");
8062 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8068 if (lref && !GvCVu(gv)) {
8071 tmpsv = NEWSV(704,0);
8072 gv_efullname3(tmpsv, gv, Nullch);
8073 /* XXX this is probably not what they think they're getting.
8074 * It has the same effect as "sub name;", i.e. just a forward
8076 newSUB(start_subparse(FALSE, 0),
8077 newSVOP(OP_CONST, 0, tmpsv),
8082 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8092 Returns true if the SV has a true value by Perl's rules.
8093 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8094 instead use an in-line version.
8100 Perl_sv_true(pTHX_ register SV *sv)
8105 const register XPV* tXpv;
8106 if ((tXpv = (XPV*)SvANY(sv)) &&
8107 (tXpv->xpv_cur > 1 ||
8108 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8115 return SvIVX(sv) != 0;
8118 return SvNVX(sv) != 0.0;
8120 return sv_2bool(sv);
8128 A private implementation of the C<SvIVx> macro for compilers which can't
8129 cope with complex macro expressions. Always use the macro instead.
8135 Perl_sv_iv(pTHX_ register SV *sv)
8139 return (IV)SvUVX(sv);
8148 A private implementation of the C<SvUVx> macro for compilers which can't
8149 cope with complex macro expressions. Always use the macro instead.
8155 Perl_sv_uv(pTHX_ register SV *sv)
8160 return (UV)SvIVX(sv);
8168 A private implementation of the C<SvNVx> macro for compilers which can't
8169 cope with complex macro expressions. Always use the macro instead.
8175 Perl_sv_nv(pTHX_ register SV *sv)
8182 /* sv_pv() is now a macro using SvPV_nolen();
8183 * this function provided for binary compatibility only
8187 Perl_sv_pv(pTHX_ SV *sv)
8194 return sv_2pv(sv, &n_a);
8200 Use the C<SvPV_nolen> macro instead
8204 A private implementation of the C<SvPV> macro for compilers which can't
8205 cope with complex macro expressions. Always use the macro instead.
8211 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8217 return sv_2pv(sv, lp);
8222 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8228 return sv_2pv_flags(sv, lp, 0);
8231 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8232 * this function provided for binary compatibility only
8236 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8238 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8242 =for apidoc sv_pvn_force
8244 Get a sensible string out of the SV somehow.
8245 A private implementation of the C<SvPV_force> macro for compilers which
8246 can't cope with complex macro expressions. Always use the macro instead.
8248 =for apidoc sv_pvn_force_flags
8250 Get a sensible string out of the SV somehow.
8251 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8252 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8253 implemented in terms of this function.
8254 You normally want to use the various wrapper macros instead: see
8255 C<SvPV_force> and C<SvPV_force_nomg>
8261 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8264 if (SvTHINKFIRST(sv) && !SvROK(sv))
8265 sv_force_normal_flags(sv, 0);
8272 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8273 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8277 s = sv_2pv_flags(sv, lp, flags);
8278 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8279 const STRLEN len = *lp;
8283 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8284 SvGROW(sv, len + 1);
8285 Move(s,SvPVX_const(sv),len,char);
8290 SvPOK_on(sv); /* validate pointer */
8292 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8293 PTR2UV(sv),SvPVX_const(sv)));
8299 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8300 * this function provided for binary compatibility only
8304 Perl_sv_pvbyte(pTHX_ SV *sv)
8306 sv_utf8_downgrade(sv,0);
8311 =for apidoc sv_pvbyte
8313 Use C<SvPVbyte_nolen> instead.
8315 =for apidoc sv_pvbyten
8317 A private implementation of the C<SvPVbyte> macro for compilers
8318 which can't cope with complex macro expressions. Always use the macro
8325 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8327 sv_utf8_downgrade(sv,0);
8328 return sv_pvn(sv,lp);
8332 =for apidoc sv_pvbyten_force
8334 A private implementation of the C<SvPVbytex_force> macro for compilers
8335 which can't cope with complex macro expressions. Always use the macro
8342 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8344 sv_pvn_force(sv,lp);
8345 sv_utf8_downgrade(sv,0);
8350 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8351 * this function provided for binary compatibility only
8355 Perl_sv_pvutf8(pTHX_ SV *sv)
8357 sv_utf8_upgrade(sv);
8362 =for apidoc sv_pvutf8
8364 Use the C<SvPVutf8_nolen> macro instead
8366 =for apidoc sv_pvutf8n
8368 A private implementation of the C<SvPVutf8> macro for compilers
8369 which can't cope with complex macro expressions. Always use the macro
8376 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8378 sv_utf8_upgrade(sv);
8379 return sv_pvn(sv,lp);
8383 =for apidoc sv_pvutf8n_force
8385 A private implementation of the C<SvPVutf8_force> macro for compilers
8386 which can't cope with complex macro expressions. Always use the macro
8393 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8395 sv_pvn_force(sv,lp);
8396 sv_utf8_upgrade(sv);
8402 =for apidoc sv_reftype
8404 Returns a string describing what the SV is a reference to.
8410 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8412 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8413 inside return suggests a const propagation bug in g++. */
8414 if (ob && SvOBJECT(sv)) {
8415 char *name = HvNAME_get(SvSTASH(sv));
8416 return name ? name : (char *) "__ANON__";
8419 switch (SvTYPE(sv)) {
8436 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8437 /* tied lvalues should appear to be
8438 * scalars for backwards compatitbility */
8439 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8440 ? "SCALAR" : "LVALUE");
8441 case SVt_PVAV: return "ARRAY";
8442 case SVt_PVHV: return "HASH";
8443 case SVt_PVCV: return "CODE";
8444 case SVt_PVGV: return "GLOB";
8445 case SVt_PVFM: return "FORMAT";
8446 case SVt_PVIO: return "IO";
8447 default: return "UNKNOWN";
8453 =for apidoc sv_isobject
8455 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8456 object. If the SV is not an RV, or if the object is not blessed, then this
8463 Perl_sv_isobject(pTHX_ SV *sv)
8480 Returns a boolean indicating whether the SV is blessed into the specified
8481 class. This does not check for subtypes; use C<sv_derived_from> to verify
8482 an inheritance relationship.
8488 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8500 hvname = HvNAME_get(SvSTASH(sv));
8504 return strEQ(hvname, name);
8510 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8511 it will be upgraded to one. If C<classname> is non-null then the new SV will
8512 be blessed in the specified package. The new SV is returned and its
8513 reference count is 1.
8519 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8525 SV_CHECK_THINKFIRST_COW_DROP(rv);
8528 if (SvTYPE(rv) >= SVt_PVMG) {
8529 const U32 refcnt = SvREFCNT(rv);
8533 SvREFCNT(rv) = refcnt;
8536 if (SvTYPE(rv) < SVt_RV)
8537 sv_upgrade(rv, SVt_RV);
8538 else if (SvTYPE(rv) > SVt_RV) {
8549 HV* stash = gv_stashpv(classname, TRUE);
8550 (void)sv_bless(rv, stash);
8556 =for apidoc sv_setref_pv
8558 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8559 argument will be upgraded to an RV. That RV will be modified to point to
8560 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8561 into the SV. The C<classname> argument indicates the package for the
8562 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8563 will have a reference count of 1, and the RV will be returned.
8565 Do not use with other Perl types such as HV, AV, SV, CV, because those
8566 objects will become corrupted by the pointer copy process.
8568 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8574 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8577 sv_setsv(rv, &PL_sv_undef);
8581 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8586 =for apidoc sv_setref_iv
8588 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8589 argument will be upgraded to an RV. That RV will be modified to point to
8590 the new SV. The C<classname> argument indicates the package for the
8591 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8592 will have a reference count of 1, and the RV will be returned.
8598 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8600 sv_setiv(newSVrv(rv,classname), iv);
8605 =for apidoc sv_setref_uv
8607 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8608 argument will be upgraded to an RV. That RV will be modified to point to
8609 the new SV. The C<classname> argument indicates the package for the
8610 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8611 will have a reference count of 1, and the RV will be returned.
8617 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8619 sv_setuv(newSVrv(rv,classname), uv);
8624 =for apidoc sv_setref_nv
8626 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8627 argument will be upgraded to an RV. That RV will be modified to point to
8628 the new SV. The C<classname> argument indicates the package for the
8629 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8630 will have a reference count of 1, and the RV will be returned.
8636 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8638 sv_setnv(newSVrv(rv,classname), nv);
8643 =for apidoc sv_setref_pvn
8645 Copies a string into a new SV, optionally blessing the SV. The length of the
8646 string must be specified with C<n>. The C<rv> argument will be upgraded to
8647 an RV. That RV will be modified to point to the new SV. The C<classname>
8648 argument indicates the package for the blessing. Set C<classname> to
8649 C<Nullch> to avoid the blessing. The new SV will have a reference count
8650 of 1, and the RV will be returned.
8652 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8658 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8660 sv_setpvn(newSVrv(rv,classname), pv, n);
8665 =for apidoc sv_bless
8667 Blesses an SV into a specified package. The SV must be an RV. The package
8668 must be designated by its stash (see C<gv_stashpv()>). The reference count
8669 of the SV is unaffected.
8675 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8679 Perl_croak(aTHX_ "Can't bless non-reference value");
8681 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8682 if (SvREADONLY(tmpRef))
8683 Perl_croak(aTHX_ PL_no_modify);
8684 if (SvOBJECT(tmpRef)) {
8685 if (SvTYPE(tmpRef) != SVt_PVIO)
8687 SvREFCNT_dec(SvSTASH(tmpRef));
8690 SvOBJECT_on(tmpRef);
8691 if (SvTYPE(tmpRef) != SVt_PVIO)
8693 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8694 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8701 if(SvSMAGICAL(tmpRef))
8702 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8710 /* Downgrades a PVGV to a PVMG.
8714 S_sv_unglob(pTHX_ SV *sv)
8718 assert(SvTYPE(sv) == SVt_PVGV);
8723 SvREFCNT_dec(GvSTASH(sv));
8724 GvSTASH(sv) = Nullhv;
8726 sv_unmagic(sv, PERL_MAGIC_glob);
8727 Safefree(GvNAME(sv));
8730 /* need to keep SvANY(sv) in the right arena */
8731 xpvmg = new_XPVMG();
8732 StructCopy(SvANY(sv), xpvmg, XPVMG);
8733 del_XPVGV(SvANY(sv));
8736 SvFLAGS(sv) &= ~SVTYPEMASK;
8737 SvFLAGS(sv) |= SVt_PVMG;
8741 =for apidoc sv_unref_flags
8743 Unsets the RV status of the SV, and decrements the reference count of
8744 whatever was being referenced by the RV. This can almost be thought of
8745 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8746 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8747 (otherwise the decrementing is conditional on the reference count being
8748 different from one or the reference being a readonly SV).
8755 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8759 if (SvWEAKREF(sv)) {
8767 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8768 assigned to as BEGIN {$a = \"Foo"} will fail. */
8769 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8771 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8772 sv_2mortal(rv); /* Schedule for freeing later */
8776 =for apidoc sv_unref
8778 Unsets the RV status of the SV, and decrements the reference count of
8779 whatever was being referenced by the RV. This can almost be thought of
8780 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8781 being zero. See C<SvROK_off>.
8787 Perl_sv_unref(pTHX_ SV *sv)
8789 sv_unref_flags(sv, 0);
8793 =for apidoc sv_taint
8795 Taint an SV. Use C<SvTAINTED_on> instead.
8800 Perl_sv_taint(pTHX_ SV *sv)
8802 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8806 =for apidoc sv_untaint
8808 Untaint an SV. Use C<SvTAINTED_off> instead.
8813 Perl_sv_untaint(pTHX_ SV *sv)
8815 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8816 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8823 =for apidoc sv_tainted
8825 Test an SV for taintedness. Use C<SvTAINTED> instead.
8830 Perl_sv_tainted(pTHX_ SV *sv)
8832 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8833 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8834 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8841 =for apidoc sv_setpviv
8843 Copies an integer into the given SV, also updating its string value.
8844 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8850 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8852 char buf[TYPE_CHARS(UV)];
8854 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8856 sv_setpvn(sv, ptr, ebuf - ptr);
8860 =for apidoc sv_setpviv_mg
8862 Like C<sv_setpviv>, but also handles 'set' magic.
8868 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8870 char buf[TYPE_CHARS(UV)];
8872 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8874 sv_setpvn(sv, ptr, ebuf - ptr);
8878 #if defined(PERL_IMPLICIT_CONTEXT)
8880 /* pTHX_ magic can't cope with varargs, so this is a no-context
8881 * version of the main function, (which may itself be aliased to us).
8882 * Don't access this version directly.
8886 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8890 va_start(args, pat);
8891 sv_vsetpvf(sv, pat, &args);
8895 /* pTHX_ magic can't cope with varargs, so this is a no-context
8896 * version of the main function, (which may itself be aliased to us).
8897 * Don't access this version directly.
8901 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8905 va_start(args, pat);
8906 sv_vsetpvf_mg(sv, pat, &args);
8912 =for apidoc sv_setpvf
8914 Works like C<sv_catpvf> but copies the text into the SV instead of
8915 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8921 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8924 va_start(args, pat);
8925 sv_vsetpvf(sv, pat, &args);
8930 =for apidoc sv_vsetpvf
8932 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8933 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8935 Usually used via its frontend C<sv_setpvf>.
8941 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8943 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8947 =for apidoc sv_setpvf_mg
8949 Like C<sv_setpvf>, but also handles 'set' magic.
8955 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8958 va_start(args, pat);
8959 sv_vsetpvf_mg(sv, pat, &args);
8964 =for apidoc sv_vsetpvf_mg
8966 Like C<sv_vsetpvf>, but also handles 'set' magic.
8968 Usually used via its frontend C<sv_setpvf_mg>.
8974 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8976 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8980 #if defined(PERL_IMPLICIT_CONTEXT)
8982 /* pTHX_ magic can't cope with varargs, so this is a no-context
8983 * version of the main function, (which may itself be aliased to us).
8984 * Don't access this version directly.
8988 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8992 va_start(args, pat);
8993 sv_vcatpvf(sv, pat, &args);
8997 /* pTHX_ magic can't cope with varargs, so this is a no-context
8998 * version of the main function, (which may itself be aliased to us).
8999 * Don't access this version directly.
9003 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9007 va_start(args, pat);
9008 sv_vcatpvf_mg(sv, pat, &args);
9014 =for apidoc sv_catpvf
9016 Processes its arguments like C<sprintf> and appends the formatted
9017 output to an SV. If the appended data contains "wide" characters
9018 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9019 and characters >255 formatted with %c), the original SV might get
9020 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9021 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9022 valid UTF-8; if the original SV was bytes, the pattern should be too.
9027 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9030 va_start(args, pat);
9031 sv_vcatpvf(sv, pat, &args);
9036 =for apidoc sv_vcatpvf
9038 Processes its arguments like C<vsprintf> and appends the formatted output
9039 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9041 Usually used via its frontend C<sv_catpvf>.
9047 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9049 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9053 =for apidoc sv_catpvf_mg
9055 Like C<sv_catpvf>, but also handles 'set' magic.
9061 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9064 va_start(args, pat);
9065 sv_vcatpvf_mg(sv, pat, &args);
9070 =for apidoc sv_vcatpvf_mg
9072 Like C<sv_vcatpvf>, but also handles 'set' magic.
9074 Usually used via its frontend C<sv_catpvf_mg>.
9080 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9082 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9087 =for apidoc sv_vsetpvfn
9089 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9092 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9098 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9100 sv_setpvn(sv, "", 0);
9101 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9104 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9107 S_expect_number(pTHX_ char** pattern)
9110 switch (**pattern) {
9111 case '1': case '2': case '3':
9112 case '4': case '5': case '6':
9113 case '7': case '8': case '9':
9114 while (isDIGIT(**pattern))
9115 var = var * 10 + (*(*pattern)++ - '0');
9119 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9122 F0convert(NV nv, char *endbuf, STRLEN *len)
9124 const int neg = nv < 0;
9133 if (uv & 1 && uv == nv)
9134 uv--; /* Round to even */
9136 const unsigned dig = uv % 10;
9149 =for apidoc sv_vcatpvfn
9151 Processes its arguments like C<vsprintf> and appends the formatted output
9152 to an SV. Uses an array of SVs if the C style variable argument list is
9153 missing (NULL). When running with taint checks enabled, indicates via
9154 C<maybe_tainted> if results are untrustworthy (often due to the use of
9157 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9162 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9165 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9172 static const char nullstr[] = "(null)";
9174 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9175 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9177 /* Times 4: a decimal digit takes more than 3 binary digits.
9178 * NV_DIG: mantissa takes than many decimal digits.
9179 * Plus 32: Playing safe. */
9180 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9181 /* large enough for "%#.#f" --chip */
9182 /* what about long double NVs? --jhi */
9184 /* no matter what, this is a string now */
9185 (void)SvPV_force(sv, origlen);
9187 /* special-case "", "%s", and "%-p" (SVf) */
9190 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9192 const char *s = va_arg(*args, char*);
9193 sv_catpv(sv, s ? s : nullstr);
9195 else if (svix < svmax) {
9196 sv_catsv(sv, *svargs);
9197 if (DO_UTF8(*svargs))
9202 if (patlen == 3 && pat[0] == '%' &&
9203 pat[1] == '-' && pat[2] == 'p') {
9205 argsv = va_arg(*args, SV*);
9206 sv_catsv(sv, argsv);
9213 #ifndef USE_LONG_DOUBLE
9214 /* special-case "%.<number>[gf]" */
9215 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9216 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9217 unsigned digits = 0;
9221 while (*pp >= '0' && *pp <= '9')
9222 digits = 10 * digits + (*pp++ - '0');
9223 if (pp - pat == (int)patlen - 1) {
9227 nv = (NV)va_arg(*args, double);
9228 else if (svix < svmax)
9233 /* Add check for digits != 0 because it seems that some
9234 gconverts are buggy in this case, and we don't yet have
9235 a Configure test for this. */
9236 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9237 /* 0, point, slack */
9238 Gconvert(nv, (int)digits, 0, ebuf);
9240 if (*ebuf) /* May return an empty string for digits==0 */
9243 } else if (!digits) {
9246 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9247 sv_catpvn(sv, p, l);
9253 #endif /* !USE_LONG_DOUBLE */
9255 if (!args && svix < svmax && DO_UTF8(*svargs))
9258 patend = (char*)pat + patlen;
9259 for (p = (char*)pat; p < patend; p = q) {
9262 bool vectorize = FALSE;
9263 bool vectorarg = FALSE;
9264 bool vec_utf8 = FALSE;
9270 bool has_precis = FALSE;
9273 bool is_utf8 = FALSE; /* is this item utf8? */
9274 #ifdef HAS_LDBL_SPRINTF_BUG
9275 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9276 with sfio - Allen <allens@cpan.org> */
9277 bool fix_ldbl_sprintf_bug = FALSE;
9281 U8 utf8buf[UTF8_MAXBYTES+1];
9282 STRLEN esignlen = 0;
9284 char *eptr = Nullch;
9287 U8 *vecstr = Null(U8*);
9294 /* we need a long double target in case HAS_LONG_DOUBLE but
9297 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9305 const char *dotstr = ".";
9306 STRLEN dotstrlen = 1;
9307 I32 efix = 0; /* explicit format parameter index */
9308 I32 ewix = 0; /* explicit width index */
9309 I32 epix = 0; /* explicit precision index */
9310 I32 evix = 0; /* explicit vector index */
9311 bool asterisk = FALSE;
9313 /* echo everything up to the next format specification */
9314 for (q = p; q < patend && *q != '%'; ++q) ;
9316 if (has_utf8 && !pat_utf8)
9317 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9319 sv_catpvn(sv, p, q - p);
9326 We allow format specification elements in this order:
9327 \d+\$ explicit format parameter index
9329 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9330 0 flag (as above): repeated to allow "v02"
9331 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9332 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9334 [%bcdefginopsux_DFOUX] format (mandatory)
9336 if (EXPECT_NUMBER(q, width)) {
9377 if (EXPECT_NUMBER(q, ewix))
9386 if ((vectorarg = asterisk)) {
9398 EXPECT_NUMBER(q, width);
9403 vecsv = va_arg(*args, SV*);
9405 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9406 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9407 dotstr = SvPVx(vecsv, dotstrlen);
9412 vecsv = va_arg(*args, SV*);
9413 vecstr = (U8*)SvPVx(vecsv,veclen);
9414 vec_utf8 = DO_UTF8(vecsv);
9416 else if (efix ? efix <= svmax : svix < svmax) {
9417 vecsv = svargs[efix ? efix-1 : svix++];
9418 vecstr = (U8*)SvPVx(vecsv,veclen);
9419 vec_utf8 = DO_UTF8(vecsv);
9420 /* if this is a version object, we need to return the
9421 * stringified representation (which the SvPVX_const has
9422 * already done for us), but not vectorize the args
9424 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9426 q++; /* skip past the rest of the %vd format */
9427 eptr = (char *) vecstr;
9428 elen = strlen(eptr);
9441 i = va_arg(*args, int);
9443 i = (ewix ? ewix <= svmax : svix < svmax) ?
9444 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9446 width = (i < 0) ? -i : i;
9456 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9458 /* XXX: todo, support specified precision parameter */
9462 i = va_arg(*args, int);
9464 i = (ewix ? ewix <= svmax : svix < svmax)
9465 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9466 precis = (i < 0) ? 0 : i;
9471 precis = precis * 10 + (*q++ - '0');
9480 case 'I': /* Ix, I32x, and I64x */
9482 if (q[1] == '6' && q[2] == '4') {
9488 if (q[1] == '3' && q[2] == '2') {
9498 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9509 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9510 if (*(q + 1) == 'l') { /* lld, llf */
9535 argsv = (efix ? efix <= svmax : svix < svmax) ?
9536 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9543 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9545 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9547 eptr = (char*)utf8buf;
9548 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9559 if (args && !vectorize) {
9560 eptr = va_arg(*args, char*);
9562 #ifdef MACOS_TRADITIONAL
9563 /* On MacOS, %#s format is used for Pascal strings */
9568 elen = strlen(eptr);
9570 eptr = (char *)nullstr;
9571 elen = sizeof nullstr - 1;
9575 eptr = SvPVx(argsv, elen);
9576 if (DO_UTF8(argsv)) {
9577 if (has_precis && precis < elen) {
9579 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9582 if (width) { /* fudge width (can't fudge elen) */
9583 width += elen - sv_len_utf8(argsv);
9591 if (has_precis && elen > precis)
9598 if (left && args) { /* SVf */
9607 argsv = va_arg(*args, SV*);
9608 eptr = SvPVx(argsv, elen);
9613 if (alt || vectorize)
9615 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9633 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9642 esignbuf[esignlen++] = plus;
9646 case 'h': iv = (short)va_arg(*args, int); break;
9647 case 'l': iv = va_arg(*args, long); break;
9648 case 'V': iv = va_arg(*args, IV); break;
9649 default: iv = va_arg(*args, int); break;
9651 case 'q': iv = va_arg(*args, Quad_t); break;
9656 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9658 case 'h': iv = (short)tiv; break;
9659 case 'l': iv = (long)tiv; break;
9661 default: iv = tiv; break;
9663 case 'q': iv = (Quad_t)tiv; break;
9667 if ( !vectorize ) /* we already set uv above */
9672 esignbuf[esignlen++] = plus;
9676 esignbuf[esignlen++] = '-';
9719 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9730 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9731 case 'l': uv = va_arg(*args, unsigned long); break;
9732 case 'V': uv = va_arg(*args, UV); break;
9733 default: uv = va_arg(*args, unsigned); break;
9735 case 'q': uv = va_arg(*args, Uquad_t); break;
9740 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9742 case 'h': uv = (unsigned short)tuv; break;
9743 case 'l': uv = (unsigned long)tuv; break;
9745 default: uv = tuv; break;
9747 case 'q': uv = (Uquad_t)tuv; break;
9753 eptr = ebuf + sizeof ebuf;
9759 p = (char*)((c == 'X')
9760 ? "0123456789ABCDEF" : "0123456789abcdef");
9766 esignbuf[esignlen++] = '0';
9767 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9773 *--eptr = '0' + dig;
9775 if (alt && *eptr != '0')
9781 *--eptr = '0' + dig;
9784 esignbuf[esignlen++] = '0';
9785 esignbuf[esignlen++] = 'b';
9788 default: /* it had better be ten or less */
9791 *--eptr = '0' + dig;
9792 } while (uv /= base);
9795 elen = (ebuf + sizeof ebuf) - eptr;
9798 zeros = precis - elen;
9799 else if (precis == 0 && elen == 1 && *eptr == '0')
9804 /* FLOATING POINT */
9807 c = 'f'; /* maybe %F isn't supported here */
9813 /* This is evil, but floating point is even more evil */
9815 /* for SV-style calling, we can only get NV
9816 for C-style calling, we assume %f is double;
9817 for simplicity we allow any of %Lf, %llf, %qf for long double
9821 #if defined(USE_LONG_DOUBLE)
9825 /* [perl #20339] - we should accept and ignore %lf rather than die */
9829 #if defined(USE_LONG_DOUBLE)
9830 intsize = args ? 0 : 'q';
9834 #if defined(HAS_LONG_DOUBLE)
9843 /* now we need (long double) if intsize == 'q', else (double) */
9844 nv = (args && !vectorize) ?
9845 #if LONG_DOUBLESIZE > DOUBLESIZE
9847 va_arg(*args, long double) :
9848 va_arg(*args, double)
9850 va_arg(*args, double)
9856 if (c != 'e' && c != 'E') {
9858 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9859 will cast our (long double) to (double) */
9860 (void)Perl_frexp(nv, &i);
9861 if (i == PERL_INT_MIN)
9862 Perl_die(aTHX_ "panic: frexp");
9864 need = BIT_DIGITS(i);
9866 need += has_precis ? precis : 6; /* known default */
9871 #ifdef HAS_LDBL_SPRINTF_BUG
9872 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9873 with sfio - Allen <allens@cpan.org> */
9876 # define MY_DBL_MAX DBL_MAX
9877 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9878 # if DOUBLESIZE >= 8
9879 # define MY_DBL_MAX 1.7976931348623157E+308L
9881 # define MY_DBL_MAX 3.40282347E+38L
9885 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9886 # define MY_DBL_MAX_BUG 1L
9888 # define MY_DBL_MAX_BUG MY_DBL_MAX
9892 # define MY_DBL_MIN DBL_MIN
9893 # else /* XXX guessing! -Allen */
9894 # if DOUBLESIZE >= 8
9895 # define MY_DBL_MIN 2.2250738585072014E-308L
9897 # define MY_DBL_MIN 1.17549435E-38L
9901 if ((intsize == 'q') && (c == 'f') &&
9902 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9904 /* it's going to be short enough that
9905 * long double precision is not needed */
9907 if ((nv <= 0L) && (nv >= -0L))
9908 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9910 /* would use Perl_fp_class as a double-check but not
9911 * functional on IRIX - see perl.h comments */
9913 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9914 /* It's within the range that a double can represent */
9915 #if defined(DBL_MAX) && !defined(DBL_MIN)
9916 if ((nv >= ((long double)1/DBL_MAX)) ||
9917 (nv <= (-(long double)1/DBL_MAX)))
9919 fix_ldbl_sprintf_bug = TRUE;
9922 if (fix_ldbl_sprintf_bug == TRUE) {
9932 # undef MY_DBL_MAX_BUG
9935 #endif /* HAS_LDBL_SPRINTF_BUG */
9937 need += 20; /* fudge factor */
9938 if (PL_efloatsize < need) {
9939 Safefree(PL_efloatbuf);
9940 PL_efloatsize = need + 20; /* more fudge */
9941 New(906, PL_efloatbuf, PL_efloatsize, char);
9942 PL_efloatbuf[0] = '\0';
9945 if ( !(width || left || plus || alt) && fill != '0'
9946 && has_precis && intsize != 'q' ) { /* Shortcuts */
9947 /* See earlier comment about buggy Gconvert when digits,
9949 if ( c == 'g' && precis) {
9950 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9951 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9952 goto float_converted;
9953 } else if ( c == 'f' && !precis) {
9954 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9958 eptr = ebuf + sizeof ebuf;
9961 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9962 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9963 if (intsize == 'q') {
9964 /* Copy the one or more characters in a long double
9965 * format before the 'base' ([efgEFG]) character to
9966 * the format string. */
9967 static char const prifldbl[] = PERL_PRIfldbl;
9968 char const *p = prifldbl + sizeof(prifldbl) - 3;
9969 while (p >= prifldbl) { *--eptr = *p--; }
9974 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9979 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9991 /* No taint. Otherwise we are in the strange situation
9992 * where printf() taints but print($float) doesn't.
9994 #if defined(HAS_LONG_DOUBLE)
9996 (void)sprintf(PL_efloatbuf, eptr, nv);
9998 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10000 (void)sprintf(PL_efloatbuf, eptr, nv);
10003 eptr = PL_efloatbuf;
10004 elen = strlen(PL_efloatbuf);
10010 i = SvCUR(sv) - origlen;
10011 if (args && !vectorize) {
10013 case 'h': *(va_arg(*args, short*)) = i; break;
10014 default: *(va_arg(*args, int*)) = i; break;
10015 case 'l': *(va_arg(*args, long*)) = i; break;
10016 case 'V': *(va_arg(*args, IV*)) = i; break;
10018 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10023 sv_setuv_mg(argsv, (UV)i);
10025 continue; /* not "break" */
10031 if (!args && ckWARN(WARN_PRINTF) &&
10032 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10033 SV *msg = sv_newmortal();
10034 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10035 (PL_op->op_type == OP_PRTF) ? "" : "s");
10038 Perl_sv_catpvf(aTHX_ msg,
10039 "\"%%%c\"", c & 0xFF);
10041 Perl_sv_catpvf(aTHX_ msg,
10042 "\"%%\\%03"UVof"\"",
10045 sv_catpv(msg, "end of string");
10046 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10049 /* output mangled stuff ... */
10055 /* ... right here, because formatting flags should not apply */
10056 SvGROW(sv, SvCUR(sv) + elen + 1);
10058 Copy(eptr, p, elen, char);
10061 SvCUR_set(sv, p - SvPVX_const(sv));
10063 continue; /* not "break" */
10066 /* calculate width before utf8_upgrade changes it */
10067 have = esignlen + zeros + elen;
10069 if (is_utf8 != has_utf8) {
10072 sv_utf8_upgrade(sv);
10075 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10076 sv_utf8_upgrade(nsv);
10080 SvGROW(sv, SvCUR(sv) + elen + 1);
10085 need = (have > width ? have : width);
10088 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10090 if (esignlen && fill == '0') {
10091 for (i = 0; i < (int)esignlen; i++)
10092 *p++ = esignbuf[i];
10094 if (gap && !left) {
10095 memset(p, fill, gap);
10098 if (esignlen && fill != '0') {
10099 for (i = 0; i < (int)esignlen; i++)
10100 *p++ = esignbuf[i];
10103 for (i = zeros; i; i--)
10107 Copy(eptr, p, elen, char);
10111 memset(p, ' ', gap);
10116 Copy(dotstr, p, dotstrlen, char);
10120 vectorize = FALSE; /* done iterating over vecstr */
10127 SvCUR_set(sv, p - SvPVX_const(sv));
10135 /* =========================================================================
10137 =head1 Cloning an interpreter
10139 All the macros and functions in this section are for the private use of
10140 the main function, perl_clone().
10142 The foo_dup() functions make an exact copy of an existing foo thinngy.
10143 During the course of a cloning, a hash table is used to map old addresses
10144 to new addresses. The table is created and manipulated with the
10145 ptr_table_* functions.
10149 ============================================================================*/
10152 #if defined(USE_ITHREADS)
10154 #ifndef GpREFCNT_inc
10155 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10159 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10160 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10161 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10162 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10163 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10164 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10165 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10166 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10167 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10168 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10169 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10170 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10171 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10174 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10175 regcomp.c. AMS 20010712 */
10178 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10183 struct reg_substr_datum *s;
10186 return (REGEXP *)NULL;
10188 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10191 len = r->offsets[0];
10192 npar = r->nparens+1;
10194 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10195 Copy(r->program, ret->program, len+1, regnode);
10197 New(0, ret->startp, npar, I32);
10198 Copy(r->startp, ret->startp, npar, I32);
10199 New(0, ret->endp, npar, I32);
10200 Copy(r->startp, ret->startp, npar, I32);
10202 New(0, ret->substrs, 1, struct reg_substr_data);
10203 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10204 s->min_offset = r->substrs->data[i].min_offset;
10205 s->max_offset = r->substrs->data[i].max_offset;
10206 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10207 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10210 ret->regstclass = NULL;
10212 struct reg_data *d;
10213 const int count = r->data->count;
10215 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10216 char, struct reg_data);
10217 New(0, d->what, count, U8);
10220 for (i = 0; i < count; i++) {
10221 d->what[i] = r->data->what[i];
10222 switch (d->what[i]) {
10223 /* legal options are one of: sfpont
10224 see also regcomp.h and pregfree() */
10226 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10229 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10232 /* This is cheating. */
10233 New(0, d->data[i], 1, struct regnode_charclass_class);
10234 StructCopy(r->data->data[i], d->data[i],
10235 struct regnode_charclass_class);
10236 ret->regstclass = (regnode*)d->data[i];
10239 /* Compiled op trees are readonly, and can thus be
10240 shared without duplication. */
10242 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10246 d->data[i] = r->data->data[i];
10249 d->data[i] = r->data->data[i];
10251 ((reg_trie_data*)d->data[i])->refcount++;
10255 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10264 New(0, ret->offsets, 2*len+1, U32);
10265 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10267 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10268 ret->refcnt = r->refcnt;
10269 ret->minlen = r->minlen;
10270 ret->prelen = r->prelen;
10271 ret->nparens = r->nparens;
10272 ret->lastparen = r->lastparen;
10273 ret->lastcloseparen = r->lastcloseparen;
10274 ret->reganch = r->reganch;
10276 ret->sublen = r->sublen;
10278 if (RX_MATCH_COPIED(ret))
10279 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10281 ret->subbeg = Nullch;
10282 #ifdef PERL_COPY_ON_WRITE
10283 ret->saved_copy = Nullsv;
10286 ptr_table_store(PL_ptr_table, r, ret);
10290 /* duplicate a file handle */
10293 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10299 return (PerlIO*)NULL;
10301 /* look for it in the table first */
10302 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10306 /* create anew and remember what it is */
10307 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10308 ptr_table_store(PL_ptr_table, fp, ret);
10312 /* duplicate a directory handle */
10315 Perl_dirp_dup(pTHX_ DIR *dp)
10323 /* duplicate a typeglob */
10326 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10331 /* look for it in the table first */
10332 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10336 /* create anew and remember what it is */
10337 Newz(0, ret, 1, GP);
10338 ptr_table_store(PL_ptr_table, gp, ret);
10341 ret->gp_refcnt = 0; /* must be before any other dups! */
10342 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10343 ret->gp_io = io_dup_inc(gp->gp_io, param);
10344 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10345 ret->gp_av = av_dup_inc(gp->gp_av, param);
10346 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10347 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10348 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10349 ret->gp_cvgen = gp->gp_cvgen;
10350 ret->gp_flags = gp->gp_flags;
10351 ret->gp_line = gp->gp_line;
10352 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10356 /* duplicate a chain of magic */
10359 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10361 MAGIC *mgprev = (MAGIC*)NULL;
10364 return (MAGIC*)NULL;
10365 /* look for it in the table first */
10366 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10370 for (; mg; mg = mg->mg_moremagic) {
10372 Newz(0, nmg, 1, MAGIC);
10374 mgprev->mg_moremagic = nmg;
10377 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10378 nmg->mg_private = mg->mg_private;
10379 nmg->mg_type = mg->mg_type;
10380 nmg->mg_flags = mg->mg_flags;
10381 if (mg->mg_type == PERL_MAGIC_qr) {
10382 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10384 else if(mg->mg_type == PERL_MAGIC_backref) {
10385 const AV * const av = (AV*) mg->mg_obj;
10388 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10390 for (i = AvFILLp(av); i >= 0; i--) {
10391 if (!svp[i]) continue;
10392 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10395 else if (mg->mg_type == PERL_MAGIC_symtab) {
10396 nmg->mg_obj = mg->mg_obj;
10399 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10400 ? sv_dup_inc(mg->mg_obj, param)
10401 : sv_dup(mg->mg_obj, param);
10403 nmg->mg_len = mg->mg_len;
10404 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10405 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10406 if (mg->mg_len > 0) {
10407 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10408 if (mg->mg_type == PERL_MAGIC_overload_table &&
10409 AMT_AMAGIC((AMT*)mg->mg_ptr))
10411 AMT *amtp = (AMT*)mg->mg_ptr;
10412 AMT *namtp = (AMT*)nmg->mg_ptr;
10414 for (i = 1; i < NofAMmeth; i++) {
10415 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10419 else if (mg->mg_len == HEf_SVKEY)
10420 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10422 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10423 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10430 /* create a new pointer-mapping table */
10433 Perl_ptr_table_new(pTHX)
10436 Newz(0, tbl, 1, PTR_TBL_t);
10437 tbl->tbl_max = 511;
10438 tbl->tbl_items = 0;
10439 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10444 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10446 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10454 struct ptr_tbl_ent* pte;
10455 struct ptr_tbl_ent* pteend;
10456 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10457 pte->next = PL_pte_arenaroot;
10458 PL_pte_arenaroot = pte;
10460 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10461 PL_pte_root = ++pte;
10462 while (pte < pteend) {
10463 pte->next = pte + 1;
10469 STATIC struct ptr_tbl_ent*
10472 struct ptr_tbl_ent* pte;
10476 PL_pte_root = pte->next;
10481 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10483 p->next = PL_pte_root;
10487 /* map an existing pointer using a table */
10490 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10492 PTR_TBL_ENT_t *tblent;
10493 const UV hash = PTR_TABLE_HASH(sv);
10495 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10496 for (; tblent; tblent = tblent->next) {
10497 if (tblent->oldval == sv)
10498 return tblent->newval;
10500 return (void*)NULL;
10503 /* add a new entry to a pointer-mapping table */
10506 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10508 PTR_TBL_ENT_t *tblent, **otblent;
10509 /* XXX this may be pessimal on platforms where pointers aren't good
10510 * hash values e.g. if they grow faster in the most significant
10512 const UV hash = PTR_TABLE_HASH(oldv);
10516 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10517 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10518 if (tblent->oldval == oldv) {
10519 tblent->newval = newv;
10523 tblent = S_new_pte(aTHX);
10524 tblent->oldval = oldv;
10525 tblent->newval = newv;
10526 tblent->next = *otblent;
10529 if (!empty && tbl->tbl_items > tbl->tbl_max)
10530 ptr_table_split(tbl);
10533 /* double the hash bucket size of an existing ptr table */
10536 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10538 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10539 const UV oldsize = tbl->tbl_max + 1;
10540 UV newsize = oldsize * 2;
10543 Renew(ary, newsize, PTR_TBL_ENT_t*);
10544 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10545 tbl->tbl_max = --newsize;
10546 tbl->tbl_ary = ary;
10547 for (i=0; i < oldsize; i++, ary++) {
10548 PTR_TBL_ENT_t **curentp, **entp, *ent;
10551 curentp = ary + oldsize;
10552 for (entp = ary, ent = *ary; ent; ent = *entp) {
10553 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10555 ent->next = *curentp;
10565 /* remove all the entries from a ptr table */
10568 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10570 register PTR_TBL_ENT_t **array;
10571 register PTR_TBL_ENT_t *entry;
10575 if (!tbl || !tbl->tbl_items) {
10579 array = tbl->tbl_ary;
10581 max = tbl->tbl_max;
10585 PTR_TBL_ENT_t *oentry = entry;
10586 entry = entry->next;
10587 S_del_pte(aTHX_ oentry);
10590 if (++riter > max) {
10593 entry = array[riter];
10597 tbl->tbl_items = 0;
10600 /* clear and free a ptr table */
10603 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10608 ptr_table_clear(tbl);
10609 Safefree(tbl->tbl_ary);
10613 /* attempt to make everything in the typeglob readonly */
10616 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10618 GV *gv = (GV*)sstr;
10619 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10621 if (GvIO(gv) || GvFORM(gv)) {
10622 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10624 else if (!GvCV(gv)) {
10625 GvCV(gv) = (CV*)sv;
10628 /* CvPADLISTs cannot be shared */
10629 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10634 if (!GvUNIQUE(gv)) {
10636 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10637 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10643 * write attempts will die with
10644 * "Modification of a read-only value attempted"
10650 SvREADONLY_on(GvSV(gv));
10654 GvAV(gv) = (AV*)sv;
10657 SvREADONLY_on(GvAV(gv));
10661 GvHV(gv) = (HV*)sv;
10664 SvREADONLY_on(GvHV(gv));
10667 return sstr; /* he_dup() will SvREFCNT_inc() */
10670 /* duplicate an SV of any type (including AV, HV etc) */
10673 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10676 SvRV_set(dstr, SvWEAKREF(sstr)
10677 ? sv_dup(SvRV(sstr), param)
10678 : sv_dup_inc(SvRV(sstr), param));
10681 else if (SvPVX_const(sstr)) {
10682 /* Has something there */
10684 /* Normal PV - clone whole allocated space */
10685 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10686 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10687 /* Not that normal - actually sstr is copy on write.
10688 But we are a true, independant SV, so: */
10689 SvREADONLY_off(dstr);
10694 /* Special case - not normally malloced for some reason */
10695 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10696 /* A "shared" PV - clone it as unshared string */
10697 if(SvPADTMP(sstr)) {
10698 /* However, some of them live in the pad
10699 and they should not have these flags
10702 SvPV_set(dstr, sharepvn(SvPVX_const(sstr), SvCUR(sstr),
10704 SvUV_set(dstr, SvUVX(sstr));
10707 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvCUR(sstr)));
10709 SvREADONLY_off(dstr);
10713 /* Some other special case - random pointer */
10714 SvPV_set(dstr, SvPVX(sstr));
10719 /* Copy the Null */
10720 if (SvTYPE(dstr) == SVt_RV)
10721 SvRV_set(dstr, NULL);
10728 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10733 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10735 /* look for it in the table first */
10736 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10740 if(param->flags & CLONEf_JOIN_IN) {
10741 /** We are joining here so we don't want do clone
10742 something that is bad **/
10743 const char *hvname;
10745 if(SvTYPE(sstr) == SVt_PVHV &&
10746 (hvname = HvNAME_get(sstr))) {
10747 /** don't clone stashes if they already exist **/
10748 HV* old_stash = gv_stashpv(hvname,0);
10749 return (SV*) old_stash;
10753 /* create anew and remember what it is */
10756 #ifdef DEBUG_LEAKING_SCALARS
10757 dstr->sv_debug_optype = sstr->sv_debug_optype;
10758 dstr->sv_debug_line = sstr->sv_debug_line;
10759 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10760 dstr->sv_debug_cloned = 1;
10762 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10764 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10768 ptr_table_store(PL_ptr_table, sstr, dstr);
10771 SvFLAGS(dstr) = SvFLAGS(sstr);
10772 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10773 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10776 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10777 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10778 PL_watch_pvx, SvPVX_const(sstr));
10781 /* don't clone objects whose class has asked us not to */
10782 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10783 SvFLAGS(dstr) &= ~SVTYPEMASK;
10784 SvOBJECT_off(dstr);
10788 switch (SvTYPE(sstr)) {
10790 SvANY(dstr) = NULL;
10793 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10794 SvIV_set(dstr, SvIVX(sstr));
10797 SvANY(dstr) = new_XNV();
10798 SvNV_set(dstr, SvNVX(sstr));
10801 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10802 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10805 SvANY(dstr) = new_XPV();
10806 SvCUR_set(dstr, SvCUR(sstr));
10807 SvLEN_set(dstr, SvLEN(sstr));
10808 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10811 SvANY(dstr) = new_XPVIV();
10812 SvCUR_set(dstr, SvCUR(sstr));
10813 SvLEN_set(dstr, SvLEN(sstr));
10814 SvIV_set(dstr, SvIVX(sstr));
10815 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10818 SvANY(dstr) = new_XPVNV();
10819 SvCUR_set(dstr, SvCUR(sstr));
10820 SvLEN_set(dstr, SvLEN(sstr));
10821 SvIV_set(dstr, SvIVX(sstr));
10822 SvNV_set(dstr, SvNVX(sstr));
10823 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10826 SvANY(dstr) = new_XPVMG();
10827 SvCUR_set(dstr, SvCUR(sstr));
10828 SvLEN_set(dstr, SvLEN(sstr));
10829 SvIV_set(dstr, SvIVX(sstr));
10830 SvNV_set(dstr, SvNVX(sstr));
10831 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10832 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10833 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10836 SvANY(dstr) = new_XPVBM();
10837 SvCUR_set(dstr, SvCUR(sstr));
10838 SvLEN_set(dstr, SvLEN(sstr));
10839 SvIV_set(dstr, SvIVX(sstr));
10840 SvNV_set(dstr, SvNVX(sstr));
10841 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10842 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10843 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10844 BmRARE(dstr) = BmRARE(sstr);
10845 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10846 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10849 SvANY(dstr) = new_XPVLV();
10850 SvCUR_set(dstr, SvCUR(sstr));
10851 SvLEN_set(dstr, SvLEN(sstr));
10852 SvIV_set(dstr, SvIVX(sstr));
10853 SvNV_set(dstr, SvNVX(sstr));
10854 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10855 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10856 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10857 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10858 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10859 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10860 LvTARG(dstr) = dstr;
10861 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10862 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10864 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10865 LvTYPE(dstr) = LvTYPE(sstr);
10868 if (GvUNIQUE((GV*)sstr)) {
10870 if ((share = gv_share(sstr, param))) {
10873 ptr_table_store(PL_ptr_table, sstr, dstr);
10875 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10876 HvNAME_get(GvSTASH(share)), GvNAME(share));
10881 SvANY(dstr) = new_XPVGV();
10882 SvCUR_set(dstr, SvCUR(sstr));
10883 SvLEN_set(dstr, SvLEN(sstr));
10884 SvIV_set(dstr, SvIVX(sstr));
10885 SvNV_set(dstr, SvNVX(sstr));
10886 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10887 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10888 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10889 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10890 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10891 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10892 GvFLAGS(dstr) = GvFLAGS(sstr);
10893 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10894 (void)GpREFCNT_inc(GvGP(dstr));
10897 SvANY(dstr) = new_XPVIO();
10898 SvCUR_set(dstr, SvCUR(sstr));
10899 SvLEN_set(dstr, SvLEN(sstr));
10900 SvIV_set(dstr, SvIVX(sstr));
10901 SvNV_set(dstr, SvNVX(sstr));
10902 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10903 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10904 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10905 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10906 if (IoOFP(sstr) == IoIFP(sstr))
10907 IoOFP(dstr) = IoIFP(dstr);
10909 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10910 /* PL_rsfp_filters entries have fake IoDIRP() */
10911 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10912 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10914 IoDIRP(dstr) = IoDIRP(sstr);
10915 IoLINES(dstr) = IoLINES(sstr);
10916 IoPAGE(dstr) = IoPAGE(sstr);
10917 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10918 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10919 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10920 /* I have no idea why fake dirp (rsfps)
10921 should be treaded differently but otherwise
10922 we end up with leaks -- sky*/
10923 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10924 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10925 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10927 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10928 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10929 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10931 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10932 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10933 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10934 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10935 IoTYPE(dstr) = IoTYPE(sstr);
10936 IoFLAGS(dstr) = IoFLAGS(sstr);
10939 SvANY(dstr) = new_XPVAV();
10940 SvCUR_set(dstr, SvCUR(sstr));
10941 SvLEN_set(dstr, SvLEN(sstr));
10942 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10943 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10944 if (AvARRAY((AV*)sstr)) {
10945 SV **dst_ary, **src_ary;
10946 SSize_t items = AvFILLp((AV*)sstr) + 1;
10948 src_ary = AvARRAY((AV*)sstr);
10949 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10950 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10951 SvPV_set(dstr, (char*)dst_ary);
10952 AvALLOC((AV*)dstr) = dst_ary;
10953 if (AvREAL((AV*)sstr)) {
10954 while (items-- > 0)
10955 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10958 while (items-- > 0)
10959 *dst_ary++ = sv_dup(*src_ary++, param);
10961 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10962 while (items-- > 0) {
10963 *dst_ary++ = &PL_sv_undef;
10967 SvPV_set(dstr, Nullch);
10968 AvALLOC((AV*)dstr) = (SV**)NULL;
10972 SvANY(dstr) = new_XPVHV();
10973 SvCUR_set(dstr, SvCUR(sstr));
10974 SvLEN_set(dstr, SvLEN(sstr));
10975 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10976 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10977 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10981 if (HvARRAY((HV*)sstr)) {
10983 const bool sharekeys = !!HvSHAREKEYS(sstr);
10984 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10985 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10988 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10989 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
10990 HvARRAY(dstr) = (HE**)darray;
10991 while (i <= sxhv->xhv_max) {
10992 HE *source = HvARRAY(sstr)[i];
10994 = source ? he_dup(source, sharekeys, param) : 0;
10998 struct xpvhv_aux *saux = HvAUX(sstr);
10999 struct xpvhv_aux *daux = HvAUX(dstr);
11000 /* This flag isn't copied. */
11001 /* SvOOK_on(hv) attacks the IV flags. */
11002 SvFLAGS(dstr) |= SVf_OOK;
11004 hvname = saux->xhv_name;
11005 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11007 daux->xhv_riter = saux->xhv_riter;
11008 daux->xhv_eiter = saux->xhv_eiter
11009 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11014 SvPV_set(dstr, Nullch);
11016 /* Record stashes for possible cloning in Perl_clone(). */
11018 av_push(param->stashes, dstr);
11022 SvANY(dstr) = new_XPVFM();
11023 FmLINES(dstr) = FmLINES(sstr);
11027 SvANY(dstr) = new_XPVCV();
11029 SvCUR_set(dstr, SvCUR(sstr));
11030 SvLEN_set(dstr, SvLEN(sstr));
11031 SvIV_set(dstr, SvIVX(sstr));
11032 SvNV_set(dstr, SvNVX(sstr));
11033 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11034 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11035 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11036 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11037 CvSTART(dstr) = CvSTART(sstr);
11039 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11041 CvXSUB(dstr) = CvXSUB(sstr);
11042 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11043 if (CvCONST(sstr)) {
11044 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11045 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11046 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11048 /* don't dup if copying back - CvGV isn't refcounted, so the
11049 * duped GV may never be freed. A bit of a hack! DAPM */
11050 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11051 Nullgv : gv_dup(CvGV(sstr), param) ;
11052 if (param->flags & CLONEf_COPY_STACKS) {
11053 CvDEPTH(dstr) = CvDEPTH(sstr);
11057 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11058 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11060 CvWEAKOUTSIDE(sstr)
11061 ? cv_dup( CvOUTSIDE(sstr), param)
11062 : cv_dup_inc(CvOUTSIDE(sstr), param);
11063 CvFLAGS(dstr) = CvFLAGS(sstr);
11064 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11067 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11071 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11077 /* duplicate a context */
11080 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11082 PERL_CONTEXT *ncxs;
11085 return (PERL_CONTEXT*)NULL;
11087 /* look for it in the table first */
11088 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11092 /* create anew and remember what it is */
11093 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11094 ptr_table_store(PL_ptr_table, cxs, ncxs);
11097 PERL_CONTEXT *cx = &cxs[ix];
11098 PERL_CONTEXT *ncx = &ncxs[ix];
11099 ncx->cx_type = cx->cx_type;
11100 if (CxTYPE(cx) == CXt_SUBST) {
11101 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11104 ncx->blk_oldsp = cx->blk_oldsp;
11105 ncx->blk_oldcop = cx->blk_oldcop;
11106 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11107 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11108 ncx->blk_oldpm = cx->blk_oldpm;
11109 ncx->blk_gimme = cx->blk_gimme;
11110 switch (CxTYPE(cx)) {
11112 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11113 ? cv_dup_inc(cx->blk_sub.cv, param)
11114 : cv_dup(cx->blk_sub.cv,param));
11115 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11116 ? av_dup_inc(cx->blk_sub.argarray, param)
11118 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11119 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11120 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11121 ncx->blk_sub.lval = cx->blk_sub.lval;
11122 ncx->blk_sub.retop = cx->blk_sub.retop;
11125 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11126 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11127 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11128 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11129 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11130 ncx->blk_eval.retop = cx->blk_eval.retop;
11133 ncx->blk_loop.label = cx->blk_loop.label;
11134 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11135 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11136 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11137 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11138 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11139 ? cx->blk_loop.iterdata
11140 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11141 ncx->blk_loop.oldcomppad
11142 = (PAD*)ptr_table_fetch(PL_ptr_table,
11143 cx->blk_loop.oldcomppad);
11144 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11145 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11146 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11147 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11148 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11151 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11152 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11153 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11154 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11155 ncx->blk_sub.retop = cx->blk_sub.retop;
11167 /* duplicate a stack info structure */
11170 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11175 return (PERL_SI*)NULL;
11177 /* look for it in the table first */
11178 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11182 /* create anew and remember what it is */
11183 Newz(56, nsi, 1, PERL_SI);
11184 ptr_table_store(PL_ptr_table, si, nsi);
11186 nsi->si_stack = av_dup_inc(si->si_stack, param);
11187 nsi->si_cxix = si->si_cxix;
11188 nsi->si_cxmax = si->si_cxmax;
11189 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11190 nsi->si_type = si->si_type;
11191 nsi->si_prev = si_dup(si->si_prev, param);
11192 nsi->si_next = si_dup(si->si_next, param);
11193 nsi->si_markoff = si->si_markoff;
11198 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11199 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11200 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11201 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11202 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11203 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11204 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11205 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11206 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11207 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11208 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11209 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11210 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11211 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11214 #define pv_dup_inc(p) SAVEPV(p)
11215 #define pv_dup(p) SAVEPV(p)
11216 #define svp_dup_inc(p,pp) any_dup(p,pp)
11218 /* map any object to the new equivent - either something in the
11219 * ptr table, or something in the interpreter structure
11223 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11228 return (void*)NULL;
11230 /* look for it in the table first */
11231 ret = ptr_table_fetch(PL_ptr_table, v);
11235 /* see if it is part of the interpreter structure */
11236 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11237 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11245 /* duplicate the save stack */
11248 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11250 ANY *ss = proto_perl->Tsavestack;
11251 I32 ix = proto_perl->Tsavestack_ix;
11252 I32 max = proto_perl->Tsavestack_max;
11264 void (*dptr) (void*);
11265 void (*dxptr) (pTHX_ void*);
11267 /* Unions for circumventing strict ANSI C89 casting rules. */
11268 union { void *vptr; void (*dptr)(void*); } u1, u2;
11269 union { void *vptr; void (*dxptr)(pTHX_ void*); } u3, u4;
11271 Newz(54, nss, max, ANY);
11274 I32 i = POPINT(ss,ix);
11275 TOPINT(nss,ix) = i;
11277 case SAVEt_ITEM: /* normal string */
11278 sv = (SV*)POPPTR(ss,ix);
11279 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11280 sv = (SV*)POPPTR(ss,ix);
11281 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11283 case SAVEt_SV: /* scalar reference */
11284 sv = (SV*)POPPTR(ss,ix);
11285 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11286 gv = (GV*)POPPTR(ss,ix);
11287 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11289 case SAVEt_GENERIC_PVREF: /* generic char* */
11290 c = (char*)POPPTR(ss,ix);
11291 TOPPTR(nss,ix) = pv_dup(c);
11292 ptr = POPPTR(ss,ix);
11293 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11295 case SAVEt_SHARED_PVREF: /* char* in shared space */
11296 c = (char*)POPPTR(ss,ix);
11297 TOPPTR(nss,ix) = savesharedpv(c);
11298 ptr = POPPTR(ss,ix);
11299 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11301 case SAVEt_GENERIC_SVREF: /* generic sv */
11302 case SAVEt_SVREF: /* scalar reference */
11303 sv = (SV*)POPPTR(ss,ix);
11304 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11305 ptr = POPPTR(ss,ix);
11306 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11308 case SAVEt_AV: /* array reference */
11309 av = (AV*)POPPTR(ss,ix);
11310 TOPPTR(nss,ix) = av_dup_inc(av, param);
11311 gv = (GV*)POPPTR(ss,ix);
11312 TOPPTR(nss,ix) = gv_dup(gv, param);
11314 case SAVEt_HV: /* hash reference */
11315 hv = (HV*)POPPTR(ss,ix);
11316 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11317 gv = (GV*)POPPTR(ss,ix);
11318 TOPPTR(nss,ix) = gv_dup(gv, param);
11320 case SAVEt_INT: /* int reference */
11321 ptr = POPPTR(ss,ix);
11322 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11323 intval = (int)POPINT(ss,ix);
11324 TOPINT(nss,ix) = intval;
11326 case SAVEt_LONG: /* long reference */
11327 ptr = POPPTR(ss,ix);
11328 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11329 longval = (long)POPLONG(ss,ix);
11330 TOPLONG(nss,ix) = longval;
11332 case SAVEt_I32: /* I32 reference */
11333 case SAVEt_I16: /* I16 reference */
11334 case SAVEt_I8: /* I8 reference */
11335 ptr = POPPTR(ss,ix);
11336 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11338 TOPINT(nss,ix) = i;
11340 case SAVEt_IV: /* IV reference */
11341 ptr = POPPTR(ss,ix);
11342 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11344 TOPIV(nss,ix) = iv;
11346 case SAVEt_SPTR: /* SV* reference */
11347 ptr = POPPTR(ss,ix);
11348 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11349 sv = (SV*)POPPTR(ss,ix);
11350 TOPPTR(nss,ix) = sv_dup(sv, param);
11352 case SAVEt_VPTR: /* random* reference */
11353 ptr = POPPTR(ss,ix);
11354 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11355 ptr = POPPTR(ss,ix);
11356 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11358 case SAVEt_PPTR: /* char* reference */
11359 ptr = POPPTR(ss,ix);
11360 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11361 c = (char*)POPPTR(ss,ix);
11362 TOPPTR(nss,ix) = pv_dup(c);
11364 case SAVEt_HPTR: /* HV* reference */
11365 ptr = POPPTR(ss,ix);
11366 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11367 hv = (HV*)POPPTR(ss,ix);
11368 TOPPTR(nss,ix) = hv_dup(hv, param);
11370 case SAVEt_APTR: /* AV* reference */
11371 ptr = POPPTR(ss,ix);
11372 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11373 av = (AV*)POPPTR(ss,ix);
11374 TOPPTR(nss,ix) = av_dup(av, param);
11377 gv = (GV*)POPPTR(ss,ix);
11378 TOPPTR(nss,ix) = gv_dup(gv, param);
11380 case SAVEt_GP: /* scalar reference */
11381 gp = (GP*)POPPTR(ss,ix);
11382 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11383 (void)GpREFCNT_inc(gp);
11384 gv = (GV*)POPPTR(ss,ix);
11385 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11386 c = (char*)POPPTR(ss,ix);
11387 TOPPTR(nss,ix) = pv_dup(c);
11389 TOPIV(nss,ix) = iv;
11391 TOPIV(nss,ix) = iv;
11394 case SAVEt_MORTALIZESV:
11395 sv = (SV*)POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11399 ptr = POPPTR(ss,ix);
11400 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11401 /* these are assumed to be refcounted properly */
11402 switch (((OP*)ptr)->op_type) {
11404 case OP_LEAVESUBLV:
11408 case OP_LEAVEWRITE:
11409 TOPPTR(nss,ix) = ptr;
11414 TOPPTR(nss,ix) = Nullop;
11419 TOPPTR(nss,ix) = Nullop;
11422 c = (char*)POPPTR(ss,ix);
11423 TOPPTR(nss,ix) = pv_dup_inc(c);
11425 case SAVEt_CLEARSV:
11426 longval = POPLONG(ss,ix);
11427 TOPLONG(nss,ix) = longval;
11430 hv = (HV*)POPPTR(ss,ix);
11431 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11432 c = (char*)POPPTR(ss,ix);
11433 TOPPTR(nss,ix) = pv_dup_inc(c);
11435 TOPINT(nss,ix) = i;
11437 case SAVEt_DESTRUCTOR:
11438 ptr = POPPTR(ss,ix);
11439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11440 dptr = POPDPTR(ss,ix);
11442 u2.vptr = any_dup(u1.vptr, proto_perl);
11443 TOPDPTR(nss,ix) = u2.dptr;
11445 case SAVEt_DESTRUCTOR_X:
11446 ptr = POPPTR(ss,ix);
11447 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11448 dxptr = POPDXPTR(ss,ix);
11450 u4.vptr = any_dup(u3.vptr, proto_perl);;
11451 TOPDXPTR(nss,ix) = u4.dxptr;
11453 case SAVEt_REGCONTEXT:
11456 TOPINT(nss,ix) = i;
11459 case SAVEt_STACK_POS: /* Position on Perl stack */
11461 TOPINT(nss,ix) = i;
11463 case SAVEt_AELEM: /* array element */
11464 sv = (SV*)POPPTR(ss,ix);
11465 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11467 TOPINT(nss,ix) = i;
11468 av = (AV*)POPPTR(ss,ix);
11469 TOPPTR(nss,ix) = av_dup_inc(av, param);
11471 case SAVEt_HELEM: /* hash element */
11472 sv = (SV*)POPPTR(ss,ix);
11473 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11474 sv = (SV*)POPPTR(ss,ix);
11475 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11476 hv = (HV*)POPPTR(ss,ix);
11477 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11480 ptr = POPPTR(ss,ix);
11481 TOPPTR(nss,ix) = ptr;
11485 TOPINT(nss,ix) = i;
11487 case SAVEt_COMPPAD:
11488 av = (AV*)POPPTR(ss,ix);
11489 TOPPTR(nss,ix) = av_dup(av, param);
11492 longval = (long)POPLONG(ss,ix);
11493 TOPLONG(nss,ix) = longval;
11494 ptr = POPPTR(ss,ix);
11495 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11496 sv = (SV*)POPPTR(ss,ix);
11497 TOPPTR(nss,ix) = sv_dup(sv, param);
11500 ptr = POPPTR(ss,ix);
11501 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11502 longval = (long)POPBOOL(ss,ix);
11503 TOPBOOL(nss,ix) = (bool)longval;
11505 case SAVEt_SET_SVFLAGS:
11507 TOPINT(nss,ix) = i;
11509 TOPINT(nss,ix) = i;
11510 sv = (SV*)POPPTR(ss,ix);
11511 TOPPTR(nss,ix) = sv_dup(sv, param);
11514 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11522 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11523 * flag to the result. This is done for each stash before cloning starts,
11524 * so we know which stashes want their objects cloned */
11527 do_mark_cloneable_stash(pTHX_ SV *sv)
11529 const HEK *hvname = HvNAME_HEK((HV*)sv);
11531 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11532 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11533 if (cloner && GvCV(cloner)) {
11540 XPUSHs(sv_2mortal(newSVhek(hvname)));
11542 call_sv((SV*)GvCV(cloner), G_SCALAR);
11549 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11557 =for apidoc perl_clone
11559 Create and return a new interpreter by cloning the current one.
11561 perl_clone takes these flags as parameters:
11563 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11564 without it we only clone the data and zero the stacks,
11565 with it we copy the stacks and the new perl interpreter is
11566 ready to run at the exact same point as the previous one.
11567 The pseudo-fork code uses COPY_STACKS while the
11568 threads->new doesn't.
11570 CLONEf_KEEP_PTR_TABLE
11571 perl_clone keeps a ptr_table with the pointer of the old
11572 variable as a key and the new variable as a value,
11573 this allows it to check if something has been cloned and not
11574 clone it again but rather just use the value and increase the
11575 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11576 the ptr_table using the function
11577 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11578 reason to keep it around is if you want to dup some of your own
11579 variable who are outside the graph perl scans, example of this
11580 code is in threads.xs create
11583 This is a win32 thing, it is ignored on unix, it tells perls
11584 win32host code (which is c++) to clone itself, this is needed on
11585 win32 if you want to run two threads at the same time,
11586 if you just want to do some stuff in a separate perl interpreter
11587 and then throw it away and return to the original one,
11588 you don't need to do anything.
11593 /* XXX the above needs expanding by someone who actually understands it ! */
11594 EXTERN_C PerlInterpreter *
11595 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11598 perl_clone(PerlInterpreter *proto_perl, UV flags)
11601 #ifdef PERL_IMPLICIT_SYS
11603 /* perlhost.h so we need to call into it
11604 to clone the host, CPerlHost should have a c interface, sky */
11606 if (flags & CLONEf_CLONE_HOST) {
11607 return perl_clone_host(proto_perl,flags);
11609 return perl_clone_using(proto_perl, flags,
11611 proto_perl->IMemShared,
11612 proto_perl->IMemParse,
11614 proto_perl->IStdIO,
11618 proto_perl->IProc);
11622 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11623 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11624 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11625 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11626 struct IPerlDir* ipD, struct IPerlSock* ipS,
11627 struct IPerlProc* ipP)
11629 /* XXX many of the string copies here can be optimized if they're
11630 * constants; they need to be allocated as common memory and just
11631 * their pointers copied. */
11634 CLONE_PARAMS clone_params;
11635 CLONE_PARAMS* param = &clone_params;
11637 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11638 /* for each stash, determine whether its objects should be cloned */
11639 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11640 PERL_SET_THX(my_perl);
11643 Poison(my_perl, 1, PerlInterpreter);
11645 PL_curcop = (COP *)Nullop;
11649 PL_savestack_ix = 0;
11650 PL_savestack_max = -1;
11651 PL_sig_pending = 0;
11652 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11653 # else /* !DEBUGGING */
11654 Zero(my_perl, 1, PerlInterpreter);
11655 # endif /* DEBUGGING */
11657 /* host pointers */
11659 PL_MemShared = ipMS;
11660 PL_MemParse = ipMP;
11667 #else /* !PERL_IMPLICIT_SYS */
11669 CLONE_PARAMS clone_params;
11670 CLONE_PARAMS* param = &clone_params;
11671 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11672 /* for each stash, determine whether its objects should be cloned */
11673 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11674 PERL_SET_THX(my_perl);
11677 Poison(my_perl, 1, PerlInterpreter);
11679 PL_curcop = (COP *)Nullop;
11683 PL_savestack_ix = 0;
11684 PL_savestack_max = -1;
11685 PL_sig_pending = 0;
11686 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11687 # else /* !DEBUGGING */
11688 Zero(my_perl, 1, PerlInterpreter);
11689 # endif /* DEBUGGING */
11690 #endif /* PERL_IMPLICIT_SYS */
11691 param->flags = flags;
11692 param->proto_perl = proto_perl;
11695 PL_xnv_arenaroot = NULL;
11696 PL_xnv_root = NULL;
11697 PL_xpv_arenaroot = NULL;
11698 PL_xpv_root = NULL;
11699 PL_xpviv_arenaroot = NULL;
11700 PL_xpviv_root = NULL;
11701 PL_xpvnv_arenaroot = NULL;
11702 PL_xpvnv_root = NULL;
11703 PL_xpvcv_arenaroot = NULL;
11704 PL_xpvcv_root = NULL;
11705 PL_xpvav_arenaroot = NULL;
11706 PL_xpvav_root = NULL;
11707 PL_xpvhv_arenaroot = NULL;
11708 PL_xpvhv_root = NULL;
11709 PL_xpvmg_arenaroot = NULL;
11710 PL_xpvmg_root = NULL;
11711 PL_xpvgv_arenaroot = NULL;
11712 PL_xpvgv_root = NULL;
11713 PL_xpvlv_arenaroot = NULL;
11714 PL_xpvlv_root = NULL;
11715 PL_xpvbm_arenaroot = NULL;
11716 PL_xpvbm_root = NULL;
11717 PL_he_arenaroot = NULL;
11719 #if defined(USE_ITHREADS)
11720 PL_pte_arenaroot = NULL;
11721 PL_pte_root = NULL;
11723 PL_nice_chunk = NULL;
11724 PL_nice_chunk_size = 0;
11726 PL_sv_objcount = 0;
11727 PL_sv_root = Nullsv;
11728 PL_sv_arenaroot = Nullsv;
11730 PL_debug = proto_perl->Idebug;
11732 PL_hash_seed = proto_perl->Ihash_seed;
11733 PL_rehash_seed = proto_perl->Irehash_seed;
11735 #ifdef USE_REENTRANT_API
11736 /* XXX: things like -Dm will segfault here in perlio, but doing
11737 * PERL_SET_CONTEXT(proto_perl);
11738 * breaks too many other things
11740 Perl_reentrant_init(aTHX);
11743 /* create SV map for pointer relocation */
11744 PL_ptr_table = ptr_table_new();
11745 /* and one for finding shared hash keys quickly */
11746 PL_shared_hek_table = ptr_table_new();
11748 /* initialize these special pointers as early as possible */
11749 SvANY(&PL_sv_undef) = NULL;
11750 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11751 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11752 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11754 SvANY(&PL_sv_no) = new_XPVNV();
11755 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11756 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11757 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11758 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11759 SvCUR_set(&PL_sv_no, 0);
11760 SvLEN_set(&PL_sv_no, 1);
11761 SvIV_set(&PL_sv_no, 0);
11762 SvNV_set(&PL_sv_no, 0);
11763 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11765 SvANY(&PL_sv_yes) = new_XPVNV();
11766 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11767 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11768 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11769 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11770 SvCUR_set(&PL_sv_yes, 1);
11771 SvLEN_set(&PL_sv_yes, 2);
11772 SvIV_set(&PL_sv_yes, 1);
11773 SvNV_set(&PL_sv_yes, 1);
11774 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11776 /* create (a non-shared!) shared string table */
11777 PL_strtab = newHV();
11778 HvSHAREKEYS_off(PL_strtab);
11779 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11780 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11782 PL_compiling = proto_perl->Icompiling;
11784 /* These two PVs will be free'd special way so must set them same way op.c does */
11785 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11786 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11788 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11789 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11791 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11792 if (!specialWARN(PL_compiling.cop_warnings))
11793 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11794 if (!specialCopIO(PL_compiling.cop_io))
11795 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11796 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11798 /* pseudo environmental stuff */
11799 PL_origargc = proto_perl->Iorigargc;
11800 PL_origargv = proto_perl->Iorigargv;
11802 param->stashes = newAV(); /* Setup array of objects to call clone on */
11804 #ifdef PERLIO_LAYERS
11805 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11806 PerlIO_clone(aTHX_ proto_perl, param);
11809 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11810 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11811 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11812 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11813 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11814 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11817 PL_minus_c = proto_perl->Iminus_c;
11818 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11819 PL_localpatches = proto_perl->Ilocalpatches;
11820 PL_splitstr = proto_perl->Isplitstr;
11821 PL_preprocess = proto_perl->Ipreprocess;
11822 PL_minus_n = proto_perl->Iminus_n;
11823 PL_minus_p = proto_perl->Iminus_p;
11824 PL_minus_l = proto_perl->Iminus_l;
11825 PL_minus_a = proto_perl->Iminus_a;
11826 PL_minus_F = proto_perl->Iminus_F;
11827 PL_doswitches = proto_perl->Idoswitches;
11828 PL_dowarn = proto_perl->Idowarn;
11829 PL_doextract = proto_perl->Idoextract;
11830 PL_sawampersand = proto_perl->Isawampersand;
11831 PL_unsafe = proto_perl->Iunsafe;
11832 PL_inplace = SAVEPV(proto_perl->Iinplace);
11833 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11834 PL_perldb = proto_perl->Iperldb;
11835 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11836 PL_exit_flags = proto_perl->Iexit_flags;
11838 /* magical thingies */
11839 /* XXX time(&PL_basetime) when asked for? */
11840 PL_basetime = proto_perl->Ibasetime;
11841 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11843 PL_maxsysfd = proto_perl->Imaxsysfd;
11844 PL_multiline = proto_perl->Imultiline;
11845 PL_statusvalue = proto_perl->Istatusvalue;
11847 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11849 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11851 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11852 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11853 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11855 /* Clone the regex array */
11856 PL_regex_padav = newAV();
11858 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11859 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11861 av_push(PL_regex_padav,
11862 sv_dup_inc(regexen[0],param));
11863 for(i = 1; i <= len; i++) {
11864 if(SvREPADTMP(regexen[i])) {
11865 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11867 av_push(PL_regex_padav,
11869 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11870 SvIVX(regexen[i])), param)))
11875 PL_regex_pad = AvARRAY(PL_regex_padav);
11877 /* shortcuts to various I/O objects */
11878 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11879 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11880 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11881 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11882 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11883 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11885 /* shortcuts to regexp stuff */
11886 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11888 /* shortcuts to misc objects */
11889 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11891 /* shortcuts to debugging objects */
11892 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11893 PL_DBline = gv_dup(proto_perl->IDBline, param);
11894 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11895 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11896 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11897 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11898 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11899 PL_lineary = av_dup(proto_perl->Ilineary, param);
11900 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11902 /* symbol tables */
11903 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11904 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11905 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11906 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11907 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11909 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11910 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11911 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11912 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11913 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11914 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11916 PL_sub_generation = proto_perl->Isub_generation;
11918 /* funky return mechanisms */
11919 PL_forkprocess = proto_perl->Iforkprocess;
11921 /* subprocess state */
11922 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11924 /* internal state */
11925 PL_tainting = proto_perl->Itainting;
11926 PL_taint_warn = proto_perl->Itaint_warn;
11927 PL_maxo = proto_perl->Imaxo;
11928 if (proto_perl->Iop_mask)
11929 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11931 PL_op_mask = Nullch;
11932 /* PL_asserting = proto_perl->Iasserting; */
11934 /* current interpreter roots */
11935 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11936 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11937 PL_main_start = proto_perl->Imain_start;
11938 PL_eval_root = proto_perl->Ieval_root;
11939 PL_eval_start = proto_perl->Ieval_start;
11941 /* runtime control stuff */
11942 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11943 PL_copline = proto_perl->Icopline;
11945 PL_filemode = proto_perl->Ifilemode;
11946 PL_lastfd = proto_perl->Ilastfd;
11947 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11950 PL_gensym = proto_perl->Igensym;
11951 PL_preambled = proto_perl->Ipreambled;
11952 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11953 PL_laststatval = proto_perl->Ilaststatval;
11954 PL_laststype = proto_perl->Ilaststype;
11955 PL_mess_sv = Nullsv;
11957 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11958 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11960 /* interpreter atexit processing */
11961 PL_exitlistlen = proto_perl->Iexitlistlen;
11962 if (PL_exitlistlen) {
11963 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11964 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11967 PL_exitlist = (PerlExitListEntry*)NULL;
11968 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11969 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11970 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11972 PL_profiledata = NULL;
11973 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11974 /* PL_rsfp_filters entries have fake IoDIRP() */
11975 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11977 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11979 PAD_CLONE_VARS(proto_perl, param);
11981 #ifdef HAVE_INTERP_INTERN
11982 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11985 /* more statics moved here */
11986 PL_generation = proto_perl->Igeneration;
11987 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11989 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11990 PL_in_clean_all = proto_perl->Iin_clean_all;
11992 PL_uid = proto_perl->Iuid;
11993 PL_euid = proto_perl->Ieuid;
11994 PL_gid = proto_perl->Igid;
11995 PL_egid = proto_perl->Iegid;
11996 PL_nomemok = proto_perl->Inomemok;
11997 PL_an = proto_perl->Ian;
11998 PL_evalseq = proto_perl->Ievalseq;
11999 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12000 PL_origalen = proto_perl->Iorigalen;
12001 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12002 PL_osname = SAVEPV(proto_perl->Iosname);
12003 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12004 PL_sighandlerp = proto_perl->Isighandlerp;
12007 PL_runops = proto_perl->Irunops;
12009 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12012 PL_cshlen = proto_perl->Icshlen;
12013 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12016 PL_lex_state = proto_perl->Ilex_state;
12017 PL_lex_defer = proto_perl->Ilex_defer;
12018 PL_lex_expect = proto_perl->Ilex_expect;
12019 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12020 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12021 PL_lex_starts = proto_perl->Ilex_starts;
12022 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12023 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12024 PL_lex_op = proto_perl->Ilex_op;
12025 PL_lex_inpat = proto_perl->Ilex_inpat;
12026 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12027 PL_lex_brackets = proto_perl->Ilex_brackets;
12028 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12029 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12030 PL_lex_casemods = proto_perl->Ilex_casemods;
12031 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12032 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12034 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12035 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12036 PL_nexttoke = proto_perl->Inexttoke;
12038 /* XXX This is probably masking the deeper issue of why
12039 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12040 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12041 * (A little debugging with a watchpoint on it may help.)
12043 if (SvANY(proto_perl->Ilinestr)) {
12044 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12045 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12046 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12047 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12048 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12049 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12050 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12051 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12052 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12055 PL_linestr = NEWSV(65,79);
12056 sv_upgrade(PL_linestr,SVt_PVIV);
12057 sv_setpvn(PL_linestr,"",0);
12058 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12060 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12061 PL_pending_ident = proto_perl->Ipending_ident;
12062 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12064 PL_expect = proto_perl->Iexpect;
12066 PL_multi_start = proto_perl->Imulti_start;
12067 PL_multi_end = proto_perl->Imulti_end;
12068 PL_multi_open = proto_perl->Imulti_open;
12069 PL_multi_close = proto_perl->Imulti_close;
12071 PL_error_count = proto_perl->Ierror_count;
12072 PL_subline = proto_perl->Isubline;
12073 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12075 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12076 if (SvANY(proto_perl->Ilinestr)) {
12077 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12078 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12079 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12080 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12081 PL_last_lop_op = proto_perl->Ilast_lop_op;
12084 PL_last_uni = SvPVX(PL_linestr);
12085 PL_last_lop = SvPVX(PL_linestr);
12086 PL_last_lop_op = 0;
12088 PL_in_my = proto_perl->Iin_my;
12089 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12091 PL_cryptseen = proto_perl->Icryptseen;
12094 PL_hints = proto_perl->Ihints;
12096 PL_amagic_generation = proto_perl->Iamagic_generation;
12098 #ifdef USE_LOCALE_COLLATE
12099 PL_collation_ix = proto_perl->Icollation_ix;
12100 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12101 PL_collation_standard = proto_perl->Icollation_standard;
12102 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12103 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12104 #endif /* USE_LOCALE_COLLATE */
12106 #ifdef USE_LOCALE_NUMERIC
12107 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12108 PL_numeric_standard = proto_perl->Inumeric_standard;
12109 PL_numeric_local = proto_perl->Inumeric_local;
12110 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12111 #endif /* !USE_LOCALE_NUMERIC */
12113 /* utf8 character classes */
12114 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12115 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12116 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12117 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12118 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12119 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12120 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12121 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12122 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12123 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12124 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12125 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12126 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12127 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12128 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12129 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12130 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12131 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12132 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12133 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12135 /* Did the locale setup indicate UTF-8? */
12136 PL_utf8locale = proto_perl->Iutf8locale;
12137 /* Unicode features (see perlrun/-C) */
12138 PL_unicode = proto_perl->Iunicode;
12140 /* Pre-5.8 signals control */
12141 PL_signals = proto_perl->Isignals;
12143 /* times() ticks per second */
12144 PL_clocktick = proto_perl->Iclocktick;
12146 /* Recursion stopper for PerlIO_find_layer */
12147 PL_in_load_module = proto_perl->Iin_load_module;
12149 /* sort() routine */
12150 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12152 /* Not really needed/useful since the reenrant_retint is "volatile",
12153 * but do it for consistency's sake. */
12154 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12156 /* Hooks to shared SVs and locks. */
12157 PL_sharehook = proto_perl->Isharehook;
12158 PL_lockhook = proto_perl->Ilockhook;
12159 PL_unlockhook = proto_perl->Iunlockhook;
12160 PL_threadhook = proto_perl->Ithreadhook;
12162 PL_runops_std = proto_perl->Irunops_std;
12163 PL_runops_dbg = proto_perl->Irunops_dbg;
12165 #ifdef THREADS_HAVE_PIDS
12166 PL_ppid = proto_perl->Ippid;
12170 PL_last_swash_hv = Nullhv; /* reinits on demand */
12171 PL_last_swash_klen = 0;
12172 PL_last_swash_key[0]= '\0';
12173 PL_last_swash_tmps = (U8*)NULL;
12174 PL_last_swash_slen = 0;
12176 PL_glob_index = proto_perl->Iglob_index;
12177 PL_srand_called = proto_perl->Isrand_called;
12178 PL_uudmap['M'] = 0; /* reinits on demand */
12179 PL_bitcount = Nullch; /* reinits on demand */
12181 if (proto_perl->Ipsig_pend) {
12182 Newz(0, PL_psig_pend, SIG_SIZE, int);
12185 PL_psig_pend = (int*)NULL;
12188 if (proto_perl->Ipsig_ptr) {
12189 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12190 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12191 for (i = 1; i < SIG_SIZE; i++) {
12192 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12193 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12197 PL_psig_ptr = (SV**)NULL;
12198 PL_psig_name = (SV**)NULL;
12201 /* thrdvar.h stuff */
12203 if (flags & CLONEf_COPY_STACKS) {
12204 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12205 PL_tmps_ix = proto_perl->Ttmps_ix;
12206 PL_tmps_max = proto_perl->Ttmps_max;
12207 PL_tmps_floor = proto_perl->Ttmps_floor;
12208 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12210 while (i <= PL_tmps_ix) {
12211 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12215 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12216 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12217 Newz(54, PL_markstack, i, I32);
12218 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12219 - proto_perl->Tmarkstack);
12220 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12221 - proto_perl->Tmarkstack);
12222 Copy(proto_perl->Tmarkstack, PL_markstack,
12223 PL_markstack_ptr - PL_markstack + 1, I32);
12225 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12226 * NOTE: unlike the others! */
12227 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12228 PL_scopestack_max = proto_perl->Tscopestack_max;
12229 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12230 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12232 /* NOTE: si_dup() looks at PL_markstack */
12233 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12235 /* PL_curstack = PL_curstackinfo->si_stack; */
12236 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12237 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12239 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12240 PL_stack_base = AvARRAY(PL_curstack);
12241 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12242 - proto_perl->Tstack_base);
12243 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12245 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12246 * NOTE: unlike the others! */
12247 PL_savestack_ix = proto_perl->Tsavestack_ix;
12248 PL_savestack_max = proto_perl->Tsavestack_max;
12249 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12250 PL_savestack = ss_dup(proto_perl, param);
12254 ENTER; /* perl_destruct() wants to LEAVE; */
12257 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12258 PL_top_env = &PL_start_env;
12260 PL_op = proto_perl->Top;
12263 PL_Xpv = (XPV*)NULL;
12264 PL_na = proto_perl->Tna;
12266 PL_statbuf = proto_perl->Tstatbuf;
12267 PL_statcache = proto_perl->Tstatcache;
12268 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12269 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12271 PL_timesbuf = proto_perl->Ttimesbuf;
12274 PL_tainted = proto_perl->Ttainted;
12275 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12276 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12277 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12278 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12279 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12280 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12281 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12282 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12283 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12285 PL_restartop = proto_perl->Trestartop;
12286 PL_in_eval = proto_perl->Tin_eval;
12287 PL_delaymagic = proto_perl->Tdelaymagic;
12288 PL_dirty = proto_perl->Tdirty;
12289 PL_localizing = proto_perl->Tlocalizing;
12291 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12292 PL_hv_fetch_ent_mh = Nullhe;
12293 PL_modcount = proto_perl->Tmodcount;
12294 PL_lastgotoprobe = Nullop;
12295 PL_dumpindent = proto_perl->Tdumpindent;
12297 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12298 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12299 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12300 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12301 PL_sortcxix = proto_perl->Tsortcxix;
12302 PL_efloatbuf = Nullch; /* reinits on demand */
12303 PL_efloatsize = 0; /* reinits on demand */
12307 PL_screamfirst = NULL;
12308 PL_screamnext = NULL;
12309 PL_maxscream = -1; /* reinits on demand */
12310 PL_lastscream = Nullsv;
12312 PL_watchaddr = NULL;
12313 PL_watchok = Nullch;
12315 PL_regdummy = proto_perl->Tregdummy;
12316 PL_regprecomp = Nullch;
12319 PL_colorset = 0; /* reinits PL_colors[] */
12320 /*PL_colors[6] = {0,0,0,0,0,0};*/
12321 PL_reginput = Nullch;
12322 PL_regbol = Nullch;
12323 PL_regeol = Nullch;
12324 PL_regstartp = (I32*)NULL;
12325 PL_regendp = (I32*)NULL;
12326 PL_reglastparen = (U32*)NULL;
12327 PL_reglastcloseparen = (U32*)NULL;
12328 PL_regtill = Nullch;
12329 PL_reg_start_tmp = (char**)NULL;
12330 PL_reg_start_tmpl = 0;
12331 PL_regdata = (struct reg_data*)NULL;
12334 PL_reg_eval_set = 0;
12336 PL_regprogram = (regnode*)NULL;
12338 PL_regcc = (CURCUR*)NULL;
12339 PL_reg_call_cc = (struct re_cc_state*)NULL;
12340 PL_reg_re = (regexp*)NULL;
12341 PL_reg_ganch = Nullch;
12342 PL_reg_sv = Nullsv;
12343 PL_reg_match_utf8 = FALSE;
12344 PL_reg_magic = (MAGIC*)NULL;
12346 PL_reg_oldcurpm = (PMOP*)NULL;
12347 PL_reg_curpm = (PMOP*)NULL;
12348 PL_reg_oldsaved = Nullch;
12349 PL_reg_oldsavedlen = 0;
12350 #ifdef PERL_COPY_ON_WRITE
12353 PL_reg_maxiter = 0;
12354 PL_reg_leftiter = 0;
12355 PL_reg_poscache = Nullch;
12356 PL_reg_poscache_size= 0;
12358 /* RE engine - function pointers */
12359 PL_regcompp = proto_perl->Tregcompp;
12360 PL_regexecp = proto_perl->Tregexecp;
12361 PL_regint_start = proto_perl->Tregint_start;
12362 PL_regint_string = proto_perl->Tregint_string;
12363 PL_regfree = proto_perl->Tregfree;
12365 PL_reginterp_cnt = 0;
12366 PL_reg_starttry = 0;
12368 /* Pluggable optimizer */
12369 PL_peepp = proto_perl->Tpeepp;
12371 PL_stashcache = newHV();
12373 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12374 ptr_table_free(PL_ptr_table);
12375 PL_ptr_table = NULL;
12376 ptr_table_free(PL_shared_hek_table);
12377 PL_shared_hek_table = NULL;
12380 /* Call the ->CLONE method, if it exists, for each of the stashes
12381 identified by sv_dup() above.
12383 while(av_len(param->stashes) != -1) {
12384 HV* stash = (HV*) av_shift(param->stashes);
12385 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12386 if (cloner && GvCV(cloner)) {
12391 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12393 call_sv((SV*)GvCV(cloner), G_DISCARD);
12399 SvREFCNT_dec(param->stashes);
12401 /* orphaned? eg threads->new inside BEGIN or use */
12402 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12403 (void)SvREFCNT_inc(PL_compcv);
12404 SAVEFREESV(PL_compcv);
12410 #endif /* USE_ITHREADS */
12413 =head1 Unicode Support
12415 =for apidoc sv_recode_to_utf8
12417 The encoding is assumed to be an Encode object, on entry the PV
12418 of the sv is assumed to be octets in that encoding, and the sv
12419 will be converted into Unicode (and UTF-8).
12421 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12422 is not a reference, nothing is done to the sv. If the encoding is not
12423 an C<Encode::XS> Encoding object, bad things will happen.
12424 (See F<lib/encoding.pm> and L<Encode>).
12426 The PV of the sv is returned.
12431 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12434 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12448 Passing sv_yes is wrong - it needs to be or'ed set of constants
12449 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12450 remove converted chars from source.
12452 Both will default the value - let them.
12454 XPUSHs(&PL_sv_yes);
12457 call_method("decode", G_SCALAR);
12461 s = SvPV(uni, len);
12462 if (s != SvPVX_const(sv)) {
12463 SvGROW(sv, len + 1);
12464 Move(s, SvPVX_const(sv), len, char);
12465 SvCUR_set(sv, len);
12466 SvPVX(sv)[len] = 0;
12473 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12477 =for apidoc sv_cat_decode
12479 The encoding is assumed to be an Encode object, the PV of the ssv is
12480 assumed to be octets in that encoding and decoding the input starts
12481 from the position which (PV + *offset) pointed to. The dsv will be
12482 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12483 when the string tstr appears in decoding output or the input ends on
12484 the PV of the ssv. The value which the offset points will be modified
12485 to the last input position on the ssv.
12487 Returns TRUE if the terminator was found, else returns FALSE.
12492 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12493 SV *ssv, int *offset, char *tstr, int tlen)
12497 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12508 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12509 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12511 call_method("cat_decode", G_SCALAR);
12513 ret = SvTRUE(TOPs);
12514 *offset = SvIV(offsv);
12520 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12526 * c-indentation-style: bsd
12527 * c-basic-offset: 4
12528 * indent-tabs-mode: t
12531 * ex: set ts=8 sts=4 sw=4 noet: