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);
1807 pv = SvPVX_mutable(sv);
1813 else if (mt == SVt_NV)
1817 pv = SvPVX_mutable(sv);
1821 del_XPVIV(SvANY(sv));
1824 pv = SvPVX_mutable(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);
1840 pv = SvPVX_mutable(sv);
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)
2040 s = SvPVX_mutable(sv);
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)
3407 if (flags & SV_CONST_RETURN)
3408 return (char *)SvPVX_const(sv);
3413 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3415 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3420 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3425 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3426 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3433 if (SvTHINKFIRST(sv)) {
3436 register const char *typestr;
3437 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3438 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3439 char *pv = SvPV(tmpstr, *lp);
3449 typestr = "NULLREF";
3453 switch (SvTYPE(sv)) {
3455 if ( ((SvFLAGS(sv) &
3456 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3457 == (SVs_OBJECT|SVs_SMG))
3458 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3459 const regexp *re = (regexp *)mg->mg_obj;
3462 const char *fptr = "msix";
3467 char need_newline = 0;
3468 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3470 while((ch = *fptr++)) {
3472 reflags[left++] = ch;
3475 reflags[right--] = ch;
3480 reflags[left] = '-';
3484 mg->mg_len = re->prelen + 4 + left;
3486 * If /x was used, we have to worry about a regex
3487 * ending with a comment later being embedded
3488 * within another regex. If so, we don't want this
3489 * regex's "commentization" to leak out to the
3490 * right part of the enclosing regex, we must cap
3491 * it with a newline.
3493 * So, if /x was used, we scan backwards from the
3494 * end of the regex. If we find a '#' before we
3495 * find a newline, we need to add a newline
3496 * ourself. If we find a '\n' first (or if we
3497 * don't find '#' or '\n'), we don't need to add
3498 * anything. -jfriedl
3500 if (PMf_EXTENDED & re->reganch)
3502 const char *endptr = re->precomp + re->prelen;
3503 while (endptr >= re->precomp)
3505 const char c = *(endptr--);
3507 break; /* don't need another */
3509 /* we end while in a comment, so we
3511 mg->mg_len++; /* save space for it */
3512 need_newline = 1; /* note to add it */
3518 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3519 Copy("(?", mg->mg_ptr, 2, char);
3520 Copy(reflags, mg->mg_ptr+2, left, char);
3521 Copy(":", mg->mg_ptr+left+2, 1, char);
3522 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3524 mg->mg_ptr[mg->mg_len - 2] = '\n';
3525 mg->mg_ptr[mg->mg_len - 1] = ')';
3526 mg->mg_ptr[mg->mg_len] = 0;
3528 PL_reginterp_cnt += re->program[0].next_off;
3530 if (re->reganch & ROPT_UTF8)
3545 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3546 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3547 /* tied lvalues should appear to be
3548 * scalars for backwards compatitbility */
3549 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3550 ? "SCALAR" : "LVALUE"; break;
3551 case SVt_PVAV: typestr = "ARRAY"; break;
3552 case SVt_PVHV: typestr = "HASH"; break;
3553 case SVt_PVCV: typestr = "CODE"; break;
3554 case SVt_PVGV: typestr = "GLOB"; break;
3555 case SVt_PVFM: typestr = "FORMAT"; break;
3556 case SVt_PVIO: typestr = "IO"; break;
3557 default: typestr = "UNKNOWN"; break;
3561 const char *name = HvNAME_get(SvSTASH(sv));
3562 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3563 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3566 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3569 *lp = strlen(typestr);
3570 return (char *)typestr;
3572 if (SvREADONLY(sv) && !SvOK(sv)) {
3573 if (ckWARN(WARN_UNINITIALIZED))
3579 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3580 /* I'm assuming that if both IV and NV are equally valid then
3581 converting the IV is going to be more efficient */
3582 const U32 isIOK = SvIOK(sv);
3583 const U32 isUIOK = SvIsUV(sv);
3584 char buf[TYPE_CHARS(UV)];
3587 if (SvTYPE(sv) < SVt_PVIV)
3588 sv_upgrade(sv, SVt_PVIV);
3590 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3592 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3593 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3594 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3595 SvCUR_set(sv, ebuf - ptr);
3605 else if (SvNOKp(sv)) {
3606 if (SvTYPE(sv) < SVt_PVNV)
3607 sv_upgrade(sv, SVt_PVNV);
3608 /* The +20 is pure guesswork. Configure test needed. --jhi */
3609 SvGROW(sv, NV_DIG + 20);
3610 s = SvPVX_mutable(sv);
3611 olderrno = errno; /* some Xenix systems wipe out errno here */
3613 if (SvNVX(sv) == 0.0)
3614 (void)strcpy(s,"0");
3618 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3621 #ifdef FIXNEGATIVEZERO
3622 if (*s == '-' && s[1] == '0' && !s[2])
3632 if (ckWARN(WARN_UNINITIALIZED)
3633 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3636 if (SvTYPE(sv) < SVt_PV)
3637 /* Typically the caller expects that sv_any is not NULL now. */
3638 sv_upgrade(sv, SVt_PV);
3641 *lp = s - SvPVX_const(sv);
3644 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3645 PTR2UV(sv),SvPVX_const(sv)));
3646 if (flags & SV_CONST_RETURN)
3647 return (char *)SvPVX_const(sv);
3651 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3652 /* Sneaky stuff here */
3656 tsv = newSVpv(tmpbuf, 0);
3668 t = SvPVX_const(tsv);
3673 len = strlen(tmpbuf);
3675 #ifdef FIXNEGATIVEZERO
3676 if (len == 2 && t[0] == '-' && t[1] == '0') {
3681 SvUPGRADE(sv, SVt_PV);
3683 s = SvGROW(sv, len + 1);
3686 return strcpy(s, t);
3691 =for apidoc sv_copypv
3693 Copies a stringified representation of the source SV into the
3694 destination SV. Automatically performs any necessary mg_get and
3695 coercion of numeric values into strings. Guaranteed to preserve
3696 UTF-8 flag even from overloaded objects. Similar in nature to
3697 sv_2pv[_flags] but operates directly on an SV instead of just the
3698 string. Mostly uses sv_2pv_flags to do its work, except when that
3699 would lose the UTF-8'ness of the PV.
3705 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3709 s = SvPV_const(ssv,len);
3710 sv_setpvn(dsv,s,len);
3718 =for apidoc sv_2pvbyte_nolen
3720 Return a pointer to the byte-encoded representation of the SV.
3721 May cause the SV to be downgraded from UTF-8 as a side-effect.
3723 Usually accessed via the C<SvPVbyte_nolen> macro.
3729 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3732 return sv_2pvbyte(sv, &n_a);
3736 =for apidoc sv_2pvbyte
3738 Return a pointer to the byte-encoded representation of the SV, and set *lp
3739 to its length. May cause the SV to be downgraded from UTF-8 as a
3742 Usually accessed via the C<SvPVbyte> macro.
3748 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3750 sv_utf8_downgrade(sv,0);
3751 return SvPV(sv,*lp);
3755 =for apidoc sv_2pvutf8_nolen
3757 Return a pointer to the UTF-8-encoded representation of the SV.
3758 May cause the SV to be upgraded to UTF-8 as a side-effect.
3760 Usually accessed via the C<SvPVutf8_nolen> macro.
3766 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3769 return sv_2pvutf8(sv, &n_a);
3773 =for apidoc sv_2pvutf8
3775 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3776 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3778 Usually accessed via the C<SvPVutf8> macro.
3784 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3786 sv_utf8_upgrade(sv);
3787 return SvPV(sv,*lp);
3791 =for apidoc sv_2bool
3793 This function is only called on magical items, and is only used by
3794 sv_true() or its macro equivalent.
3800 Perl_sv_2bool(pTHX_ register SV *sv)
3809 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3810 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3811 return (bool)SvTRUE(tmpsv);
3812 return SvRV(sv) != 0;
3815 register XPV* Xpvtmp;
3816 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3817 (*sv->sv_u.svu_pv > '0' ||
3818 Xpvtmp->xpv_cur > 1 ||
3819 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3826 return SvIVX(sv) != 0;
3829 return SvNVX(sv) != 0.0;
3836 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3837 * this function provided for binary compatibility only
3842 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3844 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3848 =for apidoc sv_utf8_upgrade
3850 Converts the PV of an SV to its UTF-8-encoded form.
3851 Forces the SV to string form if it is not already.
3852 Always sets the SvUTF8 flag to avoid future validity checks even
3853 if all the bytes have hibit clear.
3855 This is not as a general purpose byte encoding to Unicode interface:
3856 use the Encode extension for that.
3858 =for apidoc sv_utf8_upgrade_flags
3860 Converts the PV of an SV to its UTF-8-encoded form.
3861 Forces the SV to string form if it is not already.
3862 Always sets the SvUTF8 flag to avoid future validity checks even
3863 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3864 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3865 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3867 This is not as a general purpose byte encoding to Unicode interface:
3868 use the Encode extension for that.
3874 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3876 if (sv == &PL_sv_undef)
3880 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3881 (void) sv_2pv_flags(sv,&len, flags);
3885 (void) SvPV_force(sv,len);
3894 sv_force_normal_flags(sv, 0);
3897 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3898 sv_recode_to_utf8(sv, PL_encoding);
3899 else { /* Assume Latin-1/EBCDIC */
3900 /* This function could be much more efficient if we
3901 * had a FLAG in SVs to signal if there are any hibit
3902 * chars in the PV. Given that there isn't such a flag
3903 * make the loop as fast as possible. */
3904 U8 *s = (U8 *) SvPVX(sv);
3905 U8 *e = (U8 *) SvEND(sv);
3911 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3915 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3916 s = bytes_to_utf8((U8*)s, &len);
3918 SvPV_free(sv); /* No longer using what was there before. */
3920 SvPV_set(sv, (char*)s);
3921 SvCUR_set(sv, len - 1);
3922 SvLEN_set(sv, len); /* No longer know the real size. */
3924 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3931 =for apidoc sv_utf8_downgrade
3933 Attempts to convert the PV of an SV from characters to bytes.
3934 If the PV contains a character beyond byte, this conversion will fail;
3935 in this case, either returns false or, if C<fail_ok> is not
3938 This is not as a general purpose Unicode to byte encoding interface:
3939 use the Encode extension for that.
3945 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3947 if (SvPOKp(sv) && SvUTF8(sv)) {
3953 sv_force_normal_flags(sv, 0);
3955 s = (U8 *) SvPV(sv, len);
3956 if (!utf8_to_bytes(s, &len)) {
3961 Perl_croak(aTHX_ "Wide character in %s",
3964 Perl_croak(aTHX_ "Wide character");
3975 =for apidoc sv_utf8_encode
3977 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3978 flag off so that it looks like octets again.
3984 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3986 (void) sv_utf8_upgrade(sv);
3988 sv_force_normal_flags(sv, 0);
3990 if (SvREADONLY(sv)) {
3991 Perl_croak(aTHX_ PL_no_modify);
3997 =for apidoc sv_utf8_decode
3999 If the PV of the SV is an octet sequence in UTF-8
4000 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4001 so that it looks like a character. If the PV contains only single-byte
4002 characters, the C<SvUTF8> flag stays being off.
4003 Scans PV for validity and returns false if the PV is invalid UTF-8.
4009 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4015 /* The octets may have got themselves encoded - get them back as
4018 if (!sv_utf8_downgrade(sv, TRUE))
4021 /* it is actually just a matter of turning the utf8 flag on, but
4022 * we want to make sure everything inside is valid utf8 first.
4024 c = (U8 *) SvPVX(sv);
4025 if (!is_utf8_string(c, SvCUR(sv)+1))
4027 e = (U8 *) SvEND(sv);
4030 if (!UTF8_IS_INVARIANT(ch)) {
4039 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4040 * this function provided for binary compatibility only
4044 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4046 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4050 =for apidoc sv_setsv
4052 Copies the contents of the source SV C<ssv> into the destination SV
4053 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4054 function if the source SV needs to be reused. Does not handle 'set' magic.
4055 Loosely speaking, it performs a copy-by-value, obliterating any previous
4056 content of the destination.
4058 You probably want to use one of the assortment of wrappers, such as
4059 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4060 C<SvSetMagicSV_nosteal>.
4062 =for apidoc sv_setsv_flags
4064 Copies the contents of the source SV C<ssv> into the destination SV
4065 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4066 function if the source SV needs to be reused. Does not handle 'set' magic.
4067 Loosely speaking, it performs a copy-by-value, obliterating any previous
4068 content of the destination.
4069 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4070 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4071 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4072 and C<sv_setsv_nomg> are implemented in terms of this function.
4074 You probably want to use one of the assortment of wrappers, such as
4075 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4076 C<SvSetMagicSV_nosteal>.
4078 This is the primary function for copying scalars, and most other
4079 copy-ish functions and macros use this underneath.
4085 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4087 register U32 sflags;
4093 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4095 sstr = &PL_sv_undef;
4096 stype = SvTYPE(sstr);
4097 dtype = SvTYPE(dstr);
4102 /* need to nuke the magic */
4104 SvRMAGICAL_off(dstr);
4107 /* There's a lot of redundancy below but we're going for speed here */
4112 if (dtype != SVt_PVGV) {
4113 (void)SvOK_off(dstr);
4121 sv_upgrade(dstr, SVt_IV);
4124 sv_upgrade(dstr, SVt_PVNV);
4128 sv_upgrade(dstr, SVt_PVIV);
4131 (void)SvIOK_only(dstr);
4132 SvIV_set(dstr, SvIVX(sstr));
4135 if (SvTAINTED(sstr))
4146 sv_upgrade(dstr, SVt_NV);
4151 sv_upgrade(dstr, SVt_PVNV);
4154 SvNV_set(dstr, SvNVX(sstr));
4155 (void)SvNOK_only(dstr);
4156 if (SvTAINTED(sstr))
4164 sv_upgrade(dstr, SVt_RV);
4165 else if (dtype == SVt_PVGV &&
4166 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4169 if (GvIMPORTED(dstr) != GVf_IMPORTED
4170 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4172 GvIMPORTED_on(dstr);
4181 #ifdef PERL_COPY_ON_WRITE
4182 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4183 if (dtype < SVt_PVIV)
4184 sv_upgrade(dstr, SVt_PVIV);
4191 sv_upgrade(dstr, SVt_PV);
4194 if (dtype < SVt_PVIV)
4195 sv_upgrade(dstr, SVt_PVIV);
4198 if (dtype < SVt_PVNV)
4199 sv_upgrade(dstr, SVt_PVNV);
4206 const char * const type = sv_reftype(sstr,0);
4208 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4210 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4215 if (dtype <= SVt_PVGV) {
4217 if (dtype != SVt_PVGV) {
4218 const char * const name = GvNAME(sstr);
4219 const STRLEN len = GvNAMELEN(sstr);
4220 /* don't upgrade SVt_PVLV: it can hold a glob */
4221 if (dtype != SVt_PVLV)
4222 sv_upgrade(dstr, SVt_PVGV);
4223 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4224 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4225 GvNAME(dstr) = savepvn(name, len);
4226 GvNAMELEN(dstr) = len;
4227 SvFAKE_on(dstr); /* can coerce to non-glob */
4229 /* ahem, death to those who redefine active sort subs */
4230 else if (PL_curstackinfo->si_type == PERLSI_SORT
4231 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4232 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4235 #ifdef GV_UNIQUE_CHECK
4236 if (GvUNIQUE((GV*)dstr)) {
4237 Perl_croak(aTHX_ PL_no_modify);
4241 (void)SvOK_off(dstr);
4242 GvINTRO_off(dstr); /* one-shot flag */
4244 GvGP(dstr) = gp_ref(GvGP(sstr));
4245 if (SvTAINTED(sstr))
4247 if (GvIMPORTED(dstr) != GVf_IMPORTED
4248 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4250 GvIMPORTED_on(dstr);
4258 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4260 if ((int)SvTYPE(sstr) != stype) {
4261 stype = SvTYPE(sstr);
4262 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4266 if (stype == SVt_PVLV)
4267 SvUPGRADE(dstr, SVt_PVNV);
4269 SvUPGRADE(dstr, (U32)stype);
4272 sflags = SvFLAGS(sstr);
4274 if (sflags & SVf_ROK) {
4275 if (dtype >= SVt_PV) {
4276 if (dtype == SVt_PVGV) {
4277 SV *sref = SvREFCNT_inc(SvRV(sstr));
4279 const int intro = GvINTRO(dstr);
4281 #ifdef GV_UNIQUE_CHECK
4282 if (GvUNIQUE((GV*)dstr)) {
4283 Perl_croak(aTHX_ PL_no_modify);
4288 GvINTRO_off(dstr); /* one-shot flag */
4289 GvLINE(dstr) = CopLINE(PL_curcop);
4290 GvEGV(dstr) = (GV*)dstr;
4293 switch (SvTYPE(sref)) {
4296 SAVEGENERICSV(GvAV(dstr));
4298 dref = (SV*)GvAV(dstr);
4299 GvAV(dstr) = (AV*)sref;
4300 if (!GvIMPORTED_AV(dstr)
4301 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4303 GvIMPORTED_AV_on(dstr);
4308 SAVEGENERICSV(GvHV(dstr));
4310 dref = (SV*)GvHV(dstr);
4311 GvHV(dstr) = (HV*)sref;
4312 if (!GvIMPORTED_HV(dstr)
4313 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4315 GvIMPORTED_HV_on(dstr);
4320 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4321 SvREFCNT_dec(GvCV(dstr));
4322 GvCV(dstr) = Nullcv;
4323 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4324 PL_sub_generation++;
4326 SAVEGENERICSV(GvCV(dstr));
4329 dref = (SV*)GvCV(dstr);
4330 if (GvCV(dstr) != (CV*)sref) {
4331 CV* cv = GvCV(dstr);
4333 if (!GvCVGEN((GV*)dstr) &&
4334 (CvROOT(cv) || CvXSUB(cv)))
4336 /* ahem, death to those who redefine
4337 * active sort subs */
4338 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4339 PL_sortcop == CvSTART(cv))
4341 "Can't redefine active sort subroutine %s",
4342 GvENAME((GV*)dstr));
4343 /* Redefining a sub - warning is mandatory if
4344 it was a const and its value changed. */
4345 if (ckWARN(WARN_REDEFINE)
4347 && (!CvCONST((CV*)sref)
4348 || sv_cmp(cv_const_sv(cv),
4349 cv_const_sv((CV*)sref)))))
4351 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4353 ? "Constant subroutine %s::%s redefined"
4354 : "Subroutine %s::%s redefined",
4355 HvNAME_get(GvSTASH((GV*)dstr)),
4356 GvENAME((GV*)dstr));
4360 cv_ckproto(cv, (GV*)dstr,
4361 SvPOK(sref) ? SvPVX(sref) : Nullch);
4363 GvCV(dstr) = (CV*)sref;
4364 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4365 GvASSUMECV_on(dstr);
4366 PL_sub_generation++;
4368 if (!GvIMPORTED_CV(dstr)
4369 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4371 GvIMPORTED_CV_on(dstr);
4376 SAVEGENERICSV(GvIOp(dstr));
4378 dref = (SV*)GvIOp(dstr);
4379 GvIOp(dstr) = (IO*)sref;
4383 SAVEGENERICSV(GvFORM(dstr));
4385 dref = (SV*)GvFORM(dstr);
4386 GvFORM(dstr) = (CV*)sref;
4390 SAVEGENERICSV(GvSV(dstr));
4392 dref = (SV*)GvSV(dstr);
4394 if (!GvIMPORTED_SV(dstr)
4395 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4397 GvIMPORTED_SV_on(dstr);
4403 if (SvTAINTED(sstr))
4407 if (SvPVX_const(dstr)) {
4413 (void)SvOK_off(dstr);
4414 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4416 if (sflags & SVp_NOK) {
4418 /* Only set the public OK flag if the source has public OK. */
4419 if (sflags & SVf_NOK)
4420 SvFLAGS(dstr) |= SVf_NOK;
4421 SvNV_set(dstr, SvNVX(sstr));
4423 if (sflags & SVp_IOK) {
4424 (void)SvIOKp_on(dstr);
4425 if (sflags & SVf_IOK)
4426 SvFLAGS(dstr) |= SVf_IOK;
4427 if (sflags & SVf_IVisUV)
4429 SvIV_set(dstr, SvIVX(sstr));
4431 if (SvAMAGIC(sstr)) {
4435 else if (sflags & SVp_POK) {
4439 * Check to see if we can just swipe the string. If so, it's a
4440 * possible small lose on short strings, but a big win on long ones.
4441 * It might even be a win on short strings if SvPVX_const(dstr)
4442 * has to be allocated and SvPVX_const(sstr) has to be freed.
4445 /* Whichever path we take through the next code, we want this true,
4446 and doing it now facilitates the COW check. */
4447 (void)SvPOK_only(dstr);
4450 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4453 (sflags & SVs_TEMP) && /* slated for free anyway? */
4454 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4455 (!(flags & SV_NOSTEAL)) &&
4456 /* and we're allowed to steal temps */
4457 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4458 SvLEN(sstr) && /* and really is a string */
4459 /* and won't be needed again, potentially */
4460 !(PL_op && PL_op->op_type == OP_AASSIGN))
4461 #ifdef PERL_COPY_ON_WRITE
4462 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4463 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4464 && SvTYPE(sstr) >= SVt_PVIV)
4467 /* Failed the swipe test, and it's not a shared hash key either.
4468 Have to copy the string. */
4469 STRLEN len = SvCUR(sstr);
4470 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4471 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4472 SvCUR_set(dstr, len);
4473 *SvEND(dstr) = '\0';
4475 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4477 /* Either it's a shared hash key, or it's suitable for
4478 copy-on-write or we can swipe the string. */
4480 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4484 #ifdef PERL_COPY_ON_WRITE
4486 /* I believe I should acquire a global SV mutex if
4487 it's a COW sv (not a shared hash key) to stop
4488 it going un copy-on-write.
4489 If the source SV has gone un copy on write between up there
4490 and down here, then (assert() that) it is of the correct
4491 form to make it copy on write again */
4492 if ((sflags & (SVf_FAKE | SVf_READONLY))
4493 != (SVf_FAKE | SVf_READONLY)) {
4494 SvREADONLY_on(sstr);
4496 /* Make the source SV into a loop of 1.
4497 (about to become 2) */
4498 SV_COW_NEXT_SV_SET(sstr, sstr);
4502 /* Initial code is common. */
4503 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4505 SvFLAGS(dstr) &= ~SVf_OOK;
4506 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4508 else if (SvLEN(dstr))
4509 Safefree(SvPVX_const(dstr));
4513 /* making another shared SV. */
4514 STRLEN cur = SvCUR(sstr);
4515 STRLEN len = SvLEN(sstr);
4516 assert (SvTYPE(dstr) >= SVt_PVIV);
4517 #ifdef PERL_COPY_ON_WRITE
4519 /* SvIsCOW_normal */
4520 /* splice us in between source and next-after-source. */
4521 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4522 SV_COW_NEXT_SV_SET(sstr, dstr);
4523 SvPV_set(dstr, SvPVX(sstr));
4527 /* SvIsCOW_shared_hash */
4528 UV hash = SvSHARED_HASH(sstr);
4529 DEBUG_C(PerlIO_printf(Perl_debug_log,
4530 "Copy on write: Sharing hash\n"));
4532 sharepvn(SvPVX_const(sstr),
4533 (sflags & SVf_UTF8?-cur:cur), hash));
4534 SvUV_set(dstr, hash);
4536 SvLEN_set(dstr, len);
4537 SvCUR_set(dstr, cur);
4538 SvREADONLY_on(dstr);
4540 /* Relesase a global SV mutex. */
4543 { /* Passes the swipe test. */
4544 SvPV_set(dstr, SvPVX(sstr));
4545 SvLEN_set(dstr, SvLEN(sstr));
4546 SvCUR_set(dstr, SvCUR(sstr));
4549 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4550 SvPV_set(sstr, Nullch);
4556 if (sflags & SVf_UTF8)
4559 if (sflags & SVp_NOK) {
4561 if (sflags & SVf_NOK)
4562 SvFLAGS(dstr) |= SVf_NOK;
4563 SvNV_set(dstr, SvNVX(sstr));
4565 if (sflags & SVp_IOK) {
4566 (void)SvIOKp_on(dstr);
4567 if (sflags & SVf_IOK)
4568 SvFLAGS(dstr) |= SVf_IOK;
4569 if (sflags & SVf_IVisUV)
4571 SvIV_set(dstr, SvIVX(sstr));
4574 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4575 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4576 smg->mg_ptr, smg->mg_len);
4577 SvRMAGICAL_on(dstr);
4580 else if (sflags & SVp_IOK) {
4581 if (sflags & SVf_IOK)
4582 (void)SvIOK_only(dstr);
4584 (void)SvOK_off(dstr);
4585 (void)SvIOKp_on(dstr);
4587 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4588 if (sflags & SVf_IVisUV)
4590 SvIV_set(dstr, SvIVX(sstr));
4591 if (sflags & SVp_NOK) {
4592 if (sflags & SVf_NOK)
4593 (void)SvNOK_on(dstr);
4595 (void)SvNOKp_on(dstr);
4596 SvNV_set(dstr, SvNVX(sstr));
4599 else if (sflags & SVp_NOK) {
4600 if (sflags & SVf_NOK)
4601 (void)SvNOK_only(dstr);
4603 (void)SvOK_off(dstr);
4606 SvNV_set(dstr, SvNVX(sstr));
4609 if (dtype == SVt_PVGV) {
4610 if (ckWARN(WARN_MISC))
4611 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4614 (void)SvOK_off(dstr);
4616 if (SvTAINTED(sstr))
4621 =for apidoc sv_setsv_mg
4623 Like C<sv_setsv>, but also handles 'set' magic.
4629 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4631 sv_setsv(dstr,sstr);
4635 #ifdef PERL_COPY_ON_WRITE
4637 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4639 STRLEN cur = SvCUR(sstr);
4640 STRLEN len = SvLEN(sstr);
4641 register char *new_pv;
4644 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4652 if (SvTHINKFIRST(dstr))
4653 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4654 else if (SvPVX_const(dstr))
4655 Safefree(SvPVX_const(dstr));
4659 SvUPGRADE(dstr, SVt_PVIV);
4661 assert (SvPOK(sstr));
4662 assert (SvPOKp(sstr));
4663 assert (!SvIOK(sstr));
4664 assert (!SvIOKp(sstr));
4665 assert (!SvNOK(sstr));
4666 assert (!SvNOKp(sstr));
4668 if (SvIsCOW(sstr)) {
4670 if (SvLEN(sstr) == 0) {
4671 /* source is a COW shared hash key. */
4672 UV hash = SvSHARED_HASH(sstr);
4673 DEBUG_C(PerlIO_printf(Perl_debug_log,
4674 "Fast copy on write: Sharing hash\n"));
4675 SvUV_set(dstr, hash);
4676 new_pv = sharepvn(SvPVX_const(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4679 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4681 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4682 SvUPGRADE(sstr, SVt_PVIV);
4683 SvREADONLY_on(sstr);
4685 DEBUG_C(PerlIO_printf(Perl_debug_log,
4686 "Fast copy on write: Converting sstr to COW\n"));
4687 SV_COW_NEXT_SV_SET(dstr, sstr);
4689 SV_COW_NEXT_SV_SET(sstr, dstr);
4690 new_pv = SvPVX(sstr);
4693 SvPV_set(dstr, new_pv);
4694 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4697 SvLEN_set(dstr, len);
4698 SvCUR_set(dstr, cur);
4707 =for apidoc sv_setpvn
4709 Copies a string into an SV. The C<len> parameter indicates the number of
4710 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4711 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4717 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4719 register char *dptr;
4721 SV_CHECK_THINKFIRST_COW_DROP(sv);
4727 /* len is STRLEN which is unsigned, need to copy to signed */
4730 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4732 SvUPGRADE(sv, SVt_PV);
4734 SvGROW(sv, len + 1);
4736 Move(ptr,dptr,len,char);
4739 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4744 =for apidoc sv_setpvn_mg
4746 Like C<sv_setpvn>, but also handles 'set' magic.
4752 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4754 sv_setpvn(sv,ptr,len);
4759 =for apidoc sv_setpv
4761 Copies a string into an SV. The string must be null-terminated. Does not
4762 handle 'set' magic. See C<sv_setpv_mg>.
4768 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4770 register STRLEN len;
4772 SV_CHECK_THINKFIRST_COW_DROP(sv);
4778 SvUPGRADE(sv, SVt_PV);
4780 SvGROW(sv, len + 1);
4781 Move(ptr,SvPVX(sv),len+1,char);
4783 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4788 =for apidoc sv_setpv_mg
4790 Like C<sv_setpv>, but also handles 'set' magic.
4796 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4803 =for apidoc sv_usepvn
4805 Tells an SV to use C<ptr> to find its string value. Normally the string is
4806 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4807 The C<ptr> should point to memory that was allocated by C<malloc>. The
4808 string length, C<len>, must be supplied. This function will realloc the
4809 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4810 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4811 See C<sv_usepvn_mg>.
4817 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4820 SV_CHECK_THINKFIRST_COW_DROP(sv);
4821 SvUPGRADE(sv, SVt_PV);
4826 if (SvPVX_const(sv))
4829 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4830 ptr = saferealloc (ptr, allocate);
4833 SvLEN_set(sv, allocate);
4835 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4840 =for apidoc sv_usepvn_mg
4842 Like C<sv_usepvn>, but also handles 'set' magic.
4848 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4850 sv_usepvn(sv,ptr,len);
4854 #ifdef PERL_COPY_ON_WRITE
4855 /* Need to do this *after* making the SV normal, as we need the buffer
4856 pointer to remain valid until after we've copied it. If we let go too early,
4857 another thread could invalidate it by unsharing last of the same hash key
4858 (which it can do by means other than releasing copy-on-write Svs)
4859 or by changing the other copy-on-write SVs in the loop. */
4861 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN cur, STRLEN len,
4862 U32 hash, SV *after)
4864 if (len) { /* this SV was SvIsCOW_normal(sv) */
4865 /* we need to find the SV pointing to us. */
4866 SV *current = SV_COW_NEXT_SV(after);
4868 if (current == sv) {
4869 /* The SV we point to points back to us (there were only two of us
4871 Hence other SV is no longer copy on write either. */
4873 SvREADONLY_off(after);
4875 /* We need to follow the pointers around the loop. */
4877 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4880 /* don't loop forever if the structure is bust, and we have
4881 a pointer into a closed loop. */
4882 assert (current != after);
4883 assert (SvPVX_const(current) == pvx);
4885 /* Make the SV before us point to the SV after us. */
4886 SV_COW_NEXT_SV_SET(current, after);
4889 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4894 Perl_sv_release_IVX(pTHX_ register SV *sv)
4897 sv_force_normal_flags(sv, 0);
4903 =for apidoc sv_force_normal_flags
4905 Undo various types of fakery on an SV: if the PV is a shared string, make
4906 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4907 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4908 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4909 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4910 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4911 set to some other value.) In addition, the C<flags> parameter gets passed to
4912 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4913 with flags set to 0.
4919 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4921 #ifdef PERL_COPY_ON_WRITE
4922 if (SvREADONLY(sv)) {
4923 /* At this point I believe I should acquire a global SV mutex. */
4925 const char *pvx = SvPVX_const(sv);
4926 STRLEN len = SvLEN(sv);
4927 STRLEN cur = SvCUR(sv);
4928 U32 hash = SvSHARED_HASH(sv);
4929 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4931 PerlIO_printf(Perl_debug_log,
4932 "Copy on write: Force normal %ld\n",
4938 /* This SV doesn't own the buffer, so need to New() a new one: */
4939 SvPV_set(sv, (char*)0);
4941 if (flags & SV_COW_DROP_PV) {
4942 /* OK, so we don't need to copy our buffer. */
4945 SvGROW(sv, cur + 1);
4946 Move(pvx,SvPVX(sv),cur,char);
4950 sv_release_COW(sv, pvx, cur, len, hash, next);
4955 else if (IN_PERL_RUNTIME)
4956 Perl_croak(aTHX_ PL_no_modify);
4957 /* At this point I believe that I can drop the global SV mutex. */
4960 if (SvREADONLY(sv)) {
4962 const char *pvx = SvPVX_const(sv);
4963 const int is_utf8 = SvUTF8(sv);
4964 STRLEN len = SvCUR(sv);
4965 U32 hash = SvSHARED_HASH(sv);
4968 SvPV_set(sv, (char*)0);
4970 SvGROW(sv, len + 1);
4971 Move(pvx,SvPVX_const(sv),len,char);
4973 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4975 else if (IN_PERL_RUNTIME)
4976 Perl_croak(aTHX_ PL_no_modify);
4980 sv_unref_flags(sv, flags);
4981 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4986 =for apidoc sv_force_normal
4988 Undo various types of fakery on an SV: if the PV is a shared string, make
4989 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4990 an xpvmg. See also C<sv_force_normal_flags>.
4996 Perl_sv_force_normal(pTHX_ register SV *sv)
4998 sv_force_normal_flags(sv, 0);
5004 Efficient removal of characters from the beginning of the string buffer.
5005 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5006 the string buffer. The C<ptr> becomes the first character of the adjusted
5007 string. Uses the "OOK hack".
5008 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5009 refer to the same chunk of data.
5015 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5017 register STRLEN delta;
5018 if (!ptr || !SvPOKp(sv))
5020 delta = ptr - SvPVX_const(sv);
5021 SV_CHECK_THINKFIRST(sv);
5022 if (SvTYPE(sv) < SVt_PVIV)
5023 sv_upgrade(sv,SVt_PVIV);
5026 if (!SvLEN(sv)) { /* make copy of shared string */
5027 const char *pvx = SvPVX_const(sv);
5028 STRLEN len = SvCUR(sv);
5029 SvGROW(sv, len + 1);
5030 Move(pvx,SvPVX_const(sv),len,char);
5034 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5035 and we do that anyway inside the SvNIOK_off
5037 SvFLAGS(sv) |= SVf_OOK;
5040 SvLEN_set(sv, SvLEN(sv) - delta);
5041 SvCUR_set(sv, SvCUR(sv) - delta);
5042 SvPV_set(sv, SvPVX(sv) + delta);
5043 SvIV_set(sv, SvIVX(sv) + delta);
5046 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5047 * this function provided for binary compatibility only
5051 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5053 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5057 =for apidoc sv_catpvn
5059 Concatenates the string onto the end of the string which is in the SV. The
5060 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5061 status set, then the bytes appended should be valid UTF-8.
5062 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5064 =for apidoc sv_catpvn_flags
5066 Concatenates the string onto the end of the string which is in the SV. The
5067 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5068 status set, then the bytes appended should be valid UTF-8.
5069 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5070 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5071 in terms of this function.
5077 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5080 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5082 SvGROW(dsv, dlen + slen + 1);
5084 sstr = SvPVX_const(dsv);
5085 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5086 SvCUR_set(dsv, SvCUR(dsv) + slen);
5088 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5093 =for apidoc sv_catpvn_mg
5095 Like C<sv_catpvn>, but also handles 'set' magic.
5101 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5103 sv_catpvn(sv,ptr,len);
5107 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5108 * this function provided for binary compatibility only
5112 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5114 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5118 =for apidoc sv_catsv
5120 Concatenates the string from SV C<ssv> onto the end of the string in
5121 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5122 not 'set' magic. See C<sv_catsv_mg>.
5124 =for apidoc sv_catsv_flags
5126 Concatenates the string from SV C<ssv> onto the end of the string in
5127 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5128 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5129 and C<sv_catsv_nomg> are implemented in terms of this function.
5134 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5140 if ((spv = SvPV_const(ssv, slen))) {
5141 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5142 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5143 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5144 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5145 dsv->sv_flags doesn't have that bit set.
5146 Andy Dougherty 12 Oct 2001
5148 const I32 sutf8 = DO_UTF8(ssv);
5151 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5153 dutf8 = DO_UTF8(dsv);
5155 if (dutf8 != sutf8) {
5157 /* Not modifying source SV, so taking a temporary copy. */
5158 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5160 sv_utf8_upgrade(csv);
5161 spv = SvPV(csv, slen);
5164 sv_utf8_upgrade_nomg(dsv);
5166 sv_catpvn_nomg(dsv, spv, slen);
5171 =for apidoc sv_catsv_mg
5173 Like C<sv_catsv>, but also handles 'set' magic.
5179 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5186 =for apidoc sv_catpv
5188 Concatenates the string onto the end of the string which is in the SV.
5189 If the SV has the UTF-8 status set, then the bytes appended should be
5190 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5195 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5197 register STRLEN len;
5203 junk = SvPV_force(sv, tlen);
5205 SvGROW(sv, tlen + len + 1);
5207 ptr = SvPVX_const(sv);
5208 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5209 SvCUR_set(sv, SvCUR(sv) + len);
5210 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5215 =for apidoc sv_catpv_mg
5217 Like C<sv_catpv>, but also handles 'set' magic.
5223 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5232 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5233 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5240 Perl_newSV(pTHX_ STRLEN len)
5246 sv_upgrade(sv, SVt_PV);
5247 SvGROW(sv, len + 1);
5252 =for apidoc sv_magicext
5254 Adds magic to an SV, upgrading it if necessary. Applies the
5255 supplied vtable and returns a pointer to the magic added.
5257 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5258 In particular, you can add magic to SvREADONLY SVs, and add more than
5259 one instance of the same 'how'.
5261 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5262 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5263 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5264 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5266 (This is now used as a subroutine by C<sv_magic>.)
5271 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5272 const char* name, I32 namlen)
5276 if (SvTYPE(sv) < SVt_PVMG) {
5277 SvUPGRADE(sv, SVt_PVMG);
5279 Newz(702,mg, 1, MAGIC);
5280 mg->mg_moremagic = SvMAGIC(sv);
5281 SvMAGIC_set(sv, mg);
5283 /* Sometimes a magic contains a reference loop, where the sv and
5284 object refer to each other. To prevent a reference loop that
5285 would prevent such objects being freed, we look for such loops
5286 and if we find one we avoid incrementing the object refcount.
5288 Note we cannot do this to avoid self-tie loops as intervening RV must
5289 have its REFCNT incremented to keep it in existence.
5292 if (!obj || obj == sv ||
5293 how == PERL_MAGIC_arylen ||
5294 how == PERL_MAGIC_qr ||
5295 how == PERL_MAGIC_symtab ||
5296 (SvTYPE(obj) == SVt_PVGV &&
5297 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5298 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5299 GvFORM(obj) == (CV*)sv)))
5304 mg->mg_obj = SvREFCNT_inc(obj);
5305 mg->mg_flags |= MGf_REFCOUNTED;
5308 /* Normal self-ties simply pass a null object, and instead of
5309 using mg_obj directly, use the SvTIED_obj macro to produce a
5310 new RV as needed. For glob "self-ties", we are tieing the PVIO
5311 with an RV obj pointing to the glob containing the PVIO. In
5312 this case, to avoid a reference loop, we need to weaken the
5316 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5317 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5323 mg->mg_len = namlen;
5326 mg->mg_ptr = savepvn(name, namlen);
5327 else if (namlen == HEf_SVKEY)
5328 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5330 mg->mg_ptr = (char *) name;
5332 mg->mg_virtual = vtable;
5336 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5341 =for apidoc sv_magic
5343 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5344 then adds a new magic item of type C<how> to the head of the magic list.
5346 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5347 handling of the C<name> and C<namlen> arguments.
5349 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5350 to add more than one instance of the same 'how'.
5356 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5358 const MGVTBL *vtable = 0;
5361 #ifdef PERL_COPY_ON_WRITE
5363 sv_force_normal_flags(sv, 0);
5365 if (SvREADONLY(sv)) {
5367 && how != PERL_MAGIC_regex_global
5368 && how != PERL_MAGIC_bm
5369 && how != PERL_MAGIC_fm
5370 && how != PERL_MAGIC_sv
5371 && how != PERL_MAGIC_backref
5374 Perl_croak(aTHX_ PL_no_modify);
5377 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5378 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5379 /* sv_magic() refuses to add a magic of the same 'how' as an
5382 if (how == PERL_MAGIC_taint)
5390 vtable = &PL_vtbl_sv;
5392 case PERL_MAGIC_overload:
5393 vtable = &PL_vtbl_amagic;
5395 case PERL_MAGIC_overload_elem:
5396 vtable = &PL_vtbl_amagicelem;
5398 case PERL_MAGIC_overload_table:
5399 vtable = &PL_vtbl_ovrld;
5402 vtable = &PL_vtbl_bm;
5404 case PERL_MAGIC_regdata:
5405 vtable = &PL_vtbl_regdata;
5407 case PERL_MAGIC_regdatum:
5408 vtable = &PL_vtbl_regdatum;
5410 case PERL_MAGIC_env:
5411 vtable = &PL_vtbl_env;
5414 vtable = &PL_vtbl_fm;
5416 case PERL_MAGIC_envelem:
5417 vtable = &PL_vtbl_envelem;
5419 case PERL_MAGIC_regex_global:
5420 vtable = &PL_vtbl_mglob;
5422 case PERL_MAGIC_isa:
5423 vtable = &PL_vtbl_isa;
5425 case PERL_MAGIC_isaelem:
5426 vtable = &PL_vtbl_isaelem;
5428 case PERL_MAGIC_nkeys:
5429 vtable = &PL_vtbl_nkeys;
5431 case PERL_MAGIC_dbfile:
5434 case PERL_MAGIC_dbline:
5435 vtable = &PL_vtbl_dbline;
5437 #ifdef USE_LOCALE_COLLATE
5438 case PERL_MAGIC_collxfrm:
5439 vtable = &PL_vtbl_collxfrm;
5441 #endif /* USE_LOCALE_COLLATE */
5442 case PERL_MAGIC_tied:
5443 vtable = &PL_vtbl_pack;
5445 case PERL_MAGIC_tiedelem:
5446 case PERL_MAGIC_tiedscalar:
5447 vtable = &PL_vtbl_packelem;
5450 vtable = &PL_vtbl_regexp;
5452 case PERL_MAGIC_sig:
5453 vtable = &PL_vtbl_sig;
5455 case PERL_MAGIC_sigelem:
5456 vtable = &PL_vtbl_sigelem;
5458 case PERL_MAGIC_taint:
5459 vtable = &PL_vtbl_taint;
5461 case PERL_MAGIC_uvar:
5462 vtable = &PL_vtbl_uvar;
5464 case PERL_MAGIC_vec:
5465 vtable = &PL_vtbl_vec;
5467 case PERL_MAGIC_arylen_p:
5468 case PERL_MAGIC_rhash:
5469 case PERL_MAGIC_symtab:
5470 case PERL_MAGIC_vstring:
5473 case PERL_MAGIC_utf8:
5474 vtable = &PL_vtbl_utf8;
5476 case PERL_MAGIC_substr:
5477 vtable = &PL_vtbl_substr;
5479 case PERL_MAGIC_defelem:
5480 vtable = &PL_vtbl_defelem;
5482 case PERL_MAGIC_glob:
5483 vtable = &PL_vtbl_glob;
5485 case PERL_MAGIC_arylen:
5486 vtable = &PL_vtbl_arylen;
5488 case PERL_MAGIC_pos:
5489 vtable = &PL_vtbl_pos;
5491 case PERL_MAGIC_backref:
5492 vtable = &PL_vtbl_backref;
5494 case PERL_MAGIC_ext:
5495 /* Reserved for use by extensions not perl internals. */
5496 /* Useful for attaching extension internal data to perl vars. */
5497 /* Note that multiple extensions may clash if magical scalars */
5498 /* etc holding private data from one are passed to another. */
5501 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5504 /* Rest of work is done else where */
5505 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5508 case PERL_MAGIC_taint:
5511 case PERL_MAGIC_ext:
5512 case PERL_MAGIC_dbfile:
5519 =for apidoc sv_unmagic
5521 Removes all magic of type C<type> from an SV.
5527 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5531 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5534 for (mg = *mgp; mg; mg = *mgp) {
5535 if (mg->mg_type == type) {
5536 const MGVTBL* const vtbl = mg->mg_virtual;
5537 *mgp = mg->mg_moremagic;
5538 if (vtbl && vtbl->svt_free)
5539 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5540 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5542 Safefree(mg->mg_ptr);
5543 else if (mg->mg_len == HEf_SVKEY)
5544 SvREFCNT_dec((SV*)mg->mg_ptr);
5545 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5546 Safefree(mg->mg_ptr);
5548 if (mg->mg_flags & MGf_REFCOUNTED)
5549 SvREFCNT_dec(mg->mg_obj);
5553 mgp = &mg->mg_moremagic;
5557 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5564 =for apidoc sv_rvweaken
5566 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5567 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5568 push a back-reference to this RV onto the array of backreferences
5569 associated with that magic.
5575 Perl_sv_rvweaken(pTHX_ SV *sv)
5578 if (!SvOK(sv)) /* let undefs pass */
5581 Perl_croak(aTHX_ "Can't weaken a nonreference");
5582 else if (SvWEAKREF(sv)) {
5583 if (ckWARN(WARN_MISC))
5584 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5588 sv_add_backref(tsv, sv);
5594 /* Give tsv backref magic if it hasn't already got it, then push a
5595 * back-reference to sv onto the array associated with the backref magic.
5599 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5603 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5604 av = (AV*)mg->mg_obj;
5607 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5608 /* av now has a refcnt of 2, which avoids it getting freed
5609 * before us during global cleanup. The extra ref is removed
5610 * by magic_killbackrefs() when tsv is being freed */
5612 if (AvFILLp(av) >= AvMAX(av)) {
5614 SV **svp = AvARRAY(av);
5615 for (i = AvFILLp(av); i >= 0; i--)
5617 svp[i] = sv; /* reuse the slot */
5620 av_extend(av, AvFILLp(av)+1);
5622 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5625 /* delete a back-reference to ourselves from the backref magic associated
5626 * with the SV we point to.
5630 S_sv_del_backref(pTHX_ SV *sv)
5637 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5638 Perl_croak(aTHX_ "panic: del_backref");
5639 av = (AV *)mg->mg_obj;
5641 for (i = AvFILLp(av); i >= 0; i--)
5642 if (svp[i] == sv) svp[i] = Nullsv;
5646 =for apidoc sv_insert
5648 Inserts a string at the specified offset/length within the SV. Similar to
5649 the Perl substr() function.
5655 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5659 register char *midend;
5660 register char *bigend;
5666 Perl_croak(aTHX_ "Can't modify non-existent substring");
5667 SvPV_force(bigstr, curlen);
5668 (void)SvPOK_only_UTF8(bigstr);
5669 if (offset + len > curlen) {
5670 SvGROW(bigstr, offset+len+1);
5671 Zero(SvPVX_const(bigstr)+curlen, offset+len-curlen, char);
5672 SvCUR_set(bigstr, offset+len);
5676 i = littlelen - len;
5677 if (i > 0) { /* string might grow */
5678 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5679 mid = big + offset + len;
5680 midend = bigend = big + SvCUR(bigstr);
5683 while (midend > mid) /* shove everything down */
5684 *--bigend = *--midend;
5685 Move(little,big+offset,littlelen,char);
5686 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5691 Move(little,SvPVX(bigstr)+offset,len,char);
5696 big = SvPVX(bigstr);
5699 bigend = big + SvCUR(bigstr);
5701 if (midend > bigend)
5702 Perl_croak(aTHX_ "panic: sv_insert");
5704 if (mid - big > bigend - midend) { /* faster to shorten from end */
5706 Move(little, mid, littlelen,char);
5709 i = bigend - midend;
5711 Move(midend, mid, i,char);
5715 SvCUR_set(bigstr, mid - big);
5718 else if ((i = mid - big)) { /* faster from front */
5719 midend -= littlelen;
5721 sv_chop(bigstr,midend-i);
5726 Move(little, mid, littlelen,char);
5728 else if (littlelen) {
5729 midend -= littlelen;
5730 sv_chop(bigstr,midend);
5731 Move(little,midend,littlelen,char);
5734 sv_chop(bigstr,midend);
5740 =for apidoc sv_replace
5742 Make the first argument a copy of the second, then delete the original.
5743 The target SV physically takes over ownership of the body of the source SV
5744 and inherits its flags; however, the target keeps any magic it owns,
5745 and any magic in the source is discarded.
5746 Note that this is a rather specialist SV copying operation; most of the
5747 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5753 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5755 const U32 refcnt = SvREFCNT(sv);
5756 SV_CHECK_THINKFIRST_COW_DROP(sv);
5757 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5758 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5759 if (SvMAGICAL(sv)) {
5763 sv_upgrade(nsv, SVt_PVMG);
5764 SvMAGIC_set(nsv, SvMAGIC(sv));
5765 SvFLAGS(nsv) |= SvMAGICAL(sv);
5767 SvMAGIC_set(sv, NULL);
5771 assert(!SvREFCNT(sv));
5772 #ifdef DEBUG_LEAKING_SCALARS
5773 sv->sv_flags = nsv->sv_flags;
5774 sv->sv_any = nsv->sv_any;
5775 sv->sv_refcnt = nsv->sv_refcnt;
5777 StructCopy(nsv,sv,SV);
5779 /* Currently could join these into one piece of pointer arithmetic, but
5780 it would be unclear. */
5781 if(SvTYPE(sv) == SVt_IV)
5783 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5784 else if (SvTYPE(sv) == SVt_RV) {
5785 SvANY(sv) = &sv->sv_u.svu_rv;
5789 #ifdef PERL_COPY_ON_WRITE
5790 if (SvIsCOW_normal(nsv)) {
5791 /* We need to follow the pointers around the loop to make the
5792 previous SV point to sv, rather than nsv. */
5795 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5798 assert(SvPVX_const(current) == SvPVX_const(nsv));
5800 /* Make the SV before us point to the SV after us. */
5802 PerlIO_printf(Perl_debug_log, "previous is\n");
5804 PerlIO_printf(Perl_debug_log,
5805 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5806 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5808 SV_COW_NEXT_SV_SET(current, sv);
5811 SvREFCNT(sv) = refcnt;
5812 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5818 =for apidoc sv_clear
5820 Clear an SV: call any destructors, free up any memory used by the body,
5821 and free the body itself. The SV's head is I<not> freed, although
5822 its type is set to all 1's so that it won't inadvertently be assumed
5823 to be live during global destruction etc.
5824 This function should only be called when REFCNT is zero. Most of the time
5825 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5832 Perl_sv_clear(pTHX_ register SV *sv)
5837 assert(SvREFCNT(sv) == 0);
5840 if (PL_defstash) { /* Still have a symbol table? */
5844 stash = SvSTASH(sv);
5845 destructor = StashHANDLER(stash,DESTROY);
5847 SV* tmpref = newRV(sv);
5848 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5850 PUSHSTACKi(PERLSI_DESTROY);
5855 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5861 if(SvREFCNT(tmpref) < 2) {
5862 /* tmpref is not kept alive! */
5864 SvRV_set(tmpref, NULL);
5867 SvREFCNT_dec(tmpref);
5869 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5873 if (PL_in_clean_objs)
5874 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5876 /* DESTROY gave object new lease on life */
5882 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5883 SvOBJECT_off(sv); /* Curse the object. */
5884 if (SvTYPE(sv) != SVt_PVIO)
5885 --PL_sv_objcount; /* XXX Might want something more general */
5888 if (SvTYPE(sv) >= SVt_PVMG) {
5891 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5892 SvREFCNT_dec(SvSTASH(sv));
5895 switch (SvTYPE(sv)) {
5898 IoIFP(sv) != PerlIO_stdin() &&
5899 IoIFP(sv) != PerlIO_stdout() &&
5900 IoIFP(sv) != PerlIO_stderr())
5902 io_close((IO*)sv, FALSE);
5904 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5905 PerlDir_close(IoDIRP(sv));
5906 IoDIRP(sv) = (DIR*)NULL;
5907 Safefree(IoTOP_NAME(sv));
5908 Safefree(IoFMT_NAME(sv));
5909 Safefree(IoBOTTOM_NAME(sv));
5924 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5925 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5926 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5927 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5929 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5930 SvREFCNT_dec(LvTARG(sv));
5934 Safefree(GvNAME(sv));
5935 /* cannot decrease stash refcount yet, as we might recursively delete
5936 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5937 of stash until current sv is completely gone.
5938 -- JohnPC, 27 Mar 1998 */
5939 stash = GvSTASH(sv);
5945 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5947 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5948 /* Don't even bother with turning off the OOK flag. */
5957 SvREFCNT_dec(SvRV(sv));
5959 #ifdef PERL_COPY_ON_WRITE
5960 else if (SvPVX_const(sv)) {
5962 /* I believe I need to grab the global SV mutex here and
5963 then recheck the COW status. */
5965 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5968 sv_release_COW(sv, SvPVX_const(sv), SvCUR(sv), SvLEN(sv),
5969 SvUVX(sv), SV_COW_NEXT_SV(sv));
5970 /* And drop it here. */
5972 } else if (SvLEN(sv)) {
5973 Safefree(SvPVX_const(sv));
5977 else if (SvPVX_const(sv) && SvLEN(sv))
5978 Safefree(SvPVX_const(sv));
5979 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5980 unsharepvn(SvPVX_const(sv),
5981 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5995 switch (SvTYPE(sv)) {
6009 del_XPVIV(SvANY(sv));
6012 del_XPVNV(SvANY(sv));
6015 del_XPVMG(SvANY(sv));
6018 del_XPVLV(SvANY(sv));
6021 del_XPVAV(SvANY(sv));
6024 del_XPVHV(SvANY(sv));
6027 del_XPVCV(SvANY(sv));
6030 del_XPVGV(SvANY(sv));
6031 /* code duplication for increased performance. */
6032 SvFLAGS(sv) &= SVf_BREAK;
6033 SvFLAGS(sv) |= SVTYPEMASK;
6034 /* decrease refcount of the stash that owns this GV, if any */
6036 SvREFCNT_dec(stash);
6037 return; /* not break, SvFLAGS reset already happened */
6039 del_XPVBM(SvANY(sv));
6042 del_XPVFM(SvANY(sv));
6045 del_XPVIO(SvANY(sv));
6048 SvFLAGS(sv) &= SVf_BREAK;
6049 SvFLAGS(sv) |= SVTYPEMASK;
6053 =for apidoc sv_newref
6055 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6062 Perl_sv_newref(pTHX_ SV *sv)
6072 Decrement an SV's reference count, and if it drops to zero, call
6073 C<sv_clear> to invoke destructors and free up any memory used by
6074 the body; finally, deallocate the SV's head itself.
6075 Normally called via a wrapper macro C<SvREFCNT_dec>.
6081 Perl_sv_free(pTHX_ SV *sv)
6086 if (SvREFCNT(sv) == 0) {
6087 if (SvFLAGS(sv) & SVf_BREAK)
6088 /* this SV's refcnt has been artificially decremented to
6089 * trigger cleanup */
6091 if (PL_in_clean_all) /* All is fair */
6093 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6094 /* make sure SvREFCNT(sv)==0 happens very seldom */
6095 SvREFCNT(sv) = (~(U32)0)/2;
6098 if (ckWARN_d(WARN_INTERNAL))
6099 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6100 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6101 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6104 if (--(SvREFCNT(sv)) > 0)
6106 Perl_sv_free2(aTHX_ sv);
6110 Perl_sv_free2(pTHX_ SV *sv)
6115 if (ckWARN_d(WARN_DEBUGGING))
6116 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6117 "Attempt to free temp prematurely: SV 0x%"UVxf
6118 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6122 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6123 /* make sure SvREFCNT(sv)==0 happens very seldom */
6124 SvREFCNT(sv) = (~(U32)0)/2;
6135 Returns the length of the string in the SV. Handles magic and type
6136 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6142 Perl_sv_len(pTHX_ register SV *sv)
6150 len = mg_length(sv);
6152 (void)SvPV_const(sv, len);
6157 =for apidoc sv_len_utf8
6159 Returns the number of characters in the string in an SV, counting wide
6160 UTF-8 bytes as a single character. Handles magic and type coercion.
6166 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6167 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6168 * (Note that the mg_len is not the length of the mg_ptr field.)
6173 Perl_sv_len_utf8(pTHX_ register SV *sv)
6179 return mg_length(sv);
6183 const U8 *s = (U8*)SvPV(sv, len);
6184 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6186 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6188 #ifdef PERL_UTF8_CACHE_ASSERT
6189 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6193 ulen = Perl_utf8_length(aTHX_ s, s + len);
6194 if (!mg && !SvREADONLY(sv)) {
6195 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6196 mg = mg_find(sv, PERL_MAGIC_utf8);
6206 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6207 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6208 * between UTF-8 and byte offsets. There are two (substr offset and substr
6209 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6210 * and byte offset) cache positions.
6212 * The mg_len field is used by sv_len_utf8(), see its comments.
6213 * Note that the mg_len is not the length of the mg_ptr field.
6217 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
6221 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6223 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6227 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6229 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6230 (*mgp)->mg_ptr = (char *) *cachep;
6234 (*cachep)[i] = offsetp;
6235 (*cachep)[i+1] = s - start;
6243 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6244 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6245 * between UTF-8 and byte offsets. See also the comments of
6246 * S_utf8_mg_pos_init().
6250 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6254 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6256 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6257 if (*mgp && (*mgp)->mg_ptr) {
6258 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6259 ASSERT_UTF8_CACHE(*cachep);
6260 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6262 else { /* We will skip to the right spot. */
6267 /* The assumption is that going backward is half
6268 * the speed of going forward (that's where the
6269 * 2 * backw in the below comes from). (The real
6270 * figure of course depends on the UTF-8 data.) */
6272 if ((*cachep)[i] > (STRLEN)uoff) {
6274 backw = (*cachep)[i] - (STRLEN)uoff;
6276 if (forw < 2 * backw)
6279 p = start + (*cachep)[i+1];
6281 /* Try this only for the substr offset (i == 0),
6282 * not for the substr length (i == 2). */
6283 else if (i == 0) { /* (*cachep)[i] < uoff */
6284 const STRLEN ulen = sv_len_utf8(sv);
6286 if ((STRLEN)uoff < ulen) {
6287 forw = (STRLEN)uoff - (*cachep)[i];
6288 backw = ulen - (STRLEN)uoff;
6290 if (forw < 2 * backw)
6291 p = start + (*cachep)[i+1];
6296 /* If the string is not long enough for uoff,
6297 * we could extend it, but not at this low a level. */
6301 if (forw < 2 * backw) {
6308 while (UTF8_IS_CONTINUATION(*p))
6313 /* Update the cache. */
6314 (*cachep)[i] = (STRLEN)uoff;
6315 (*cachep)[i+1] = p - start;
6317 /* Drop the stale "length" cache */
6326 if (found) { /* Setup the return values. */
6327 *offsetp = (*cachep)[i+1];
6328 *sp = start + *offsetp;
6331 *offsetp = send - start;
6333 else if (*sp < start) {
6339 #ifdef PERL_UTF8_CACHE_ASSERT
6344 while (n-- && s < send)
6348 assert(*offsetp == s - start);
6349 assert((*cachep)[0] == (STRLEN)uoff);
6350 assert((*cachep)[1] == *offsetp);
6352 ASSERT_UTF8_CACHE(*cachep);
6361 =for apidoc sv_pos_u2b
6363 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6364 the start of the string, to a count of the equivalent number of bytes; if
6365 lenp is non-zero, it does the same to lenp, but this time starting from
6366 the offset, rather than from the start of the string. Handles magic and
6373 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6374 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6375 * byte offsets. See also the comments of S_utf8_mg_pos().
6380 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6388 start = (U8*)SvPV(sv, len);
6393 I32 uoffset = *offsetp;
6398 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6400 if (!found && uoffset > 0) {
6401 while (s < send && uoffset--)
6405 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6407 *offsetp = s - start;
6412 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6416 if (!found && *lenp > 0) {
6419 while (s < send && ulen--)
6423 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6427 ASSERT_UTF8_CACHE(cache);
6439 =for apidoc sv_pos_b2u
6441 Converts the value pointed to by offsetp from a count of bytes from the
6442 start of the string, to a count of the equivalent number of UTF-8 chars.
6443 Handles magic and type coercion.
6449 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6450 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6451 * byte offsets. See also the comments of S_utf8_mg_pos().
6456 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6464 s = (U8*)SvPV(sv, len);
6465 if ((I32)len < *offsetp)
6466 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6468 U8* send = s + *offsetp;
6470 STRLEN *cache = NULL;
6474 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6475 mg = mg_find(sv, PERL_MAGIC_utf8);
6476 if (mg && mg->mg_ptr) {
6477 cache = (STRLEN *) mg->mg_ptr;
6478 if (cache[1] == (STRLEN)*offsetp) {
6479 /* An exact match. */
6480 *offsetp = cache[0];
6484 else if (cache[1] < (STRLEN)*offsetp) {
6485 /* We already know part of the way. */
6488 /* Let the below loop do the rest. */
6490 else { /* cache[1] > *offsetp */
6491 /* We already know all of the way, now we may
6492 * be able to walk back. The same assumption
6493 * is made as in S_utf8_mg_pos(), namely that
6494 * walking backward is twice slower than
6495 * walking forward. */
6496 STRLEN forw = *offsetp;
6497 STRLEN backw = cache[1] - *offsetp;
6499 if (!(forw < 2 * backw)) {
6500 U8 *p = s + cache[1];
6507 while (UTF8_IS_CONTINUATION(*p)) {
6515 *offsetp = cache[0];
6517 /* Drop the stale "length" cache */
6525 ASSERT_UTF8_CACHE(cache);
6531 /* Call utf8n_to_uvchr() to validate the sequence
6532 * (unless a simple non-UTF character) */
6533 if (!UTF8_IS_INVARIANT(*s))
6534 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6543 if (!SvREADONLY(sv)) {
6545 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6546 mg = mg_find(sv, PERL_MAGIC_utf8);
6551 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6552 mg->mg_ptr = (char *) cache;
6557 cache[1] = *offsetp;
6558 /* Drop the stale "length" cache */
6571 Returns a boolean indicating whether the strings in the two SVs are
6572 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6573 coerce its args to strings if necessary.
6579 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6587 SV* svrecode = Nullsv;
6594 pv1 = SvPV_const(sv1, cur1);
6601 pv2 = SvPV_const(sv2, cur2);
6603 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6604 /* Differing utf8ness.
6605 * Do not UTF8size the comparands as a side-effect. */
6608 svrecode = newSVpvn(pv2, cur2);
6609 sv_recode_to_utf8(svrecode, PL_encoding);
6610 pv2 = SvPV(svrecode, cur2);
6613 svrecode = newSVpvn(pv1, cur1);
6614 sv_recode_to_utf8(svrecode, PL_encoding);
6615 pv1 = SvPV(svrecode, cur1);
6617 /* Now both are in UTF-8. */
6619 SvREFCNT_dec(svrecode);
6624 bool is_utf8 = TRUE;
6627 /* sv1 is the UTF-8 one,
6628 * if is equal it must be downgrade-able */
6629 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6635 /* sv2 is the UTF-8 one,
6636 * if is equal it must be downgrade-able */
6637 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6643 /* Downgrade not possible - cannot be eq */
6651 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6654 SvREFCNT_dec(svrecode);
6665 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6666 string in C<sv1> is less than, equal to, or greater than the string in
6667 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6668 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6674 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6677 const char *pv1, *pv2;
6680 SV *svrecode = Nullsv;
6687 pv1 = SvPV_const(sv1, cur1);
6694 pv2 = SvPV_const(sv2, cur2);
6696 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6697 /* Differing utf8ness.
6698 * Do not UTF8size the comparands as a side-effect. */
6701 svrecode = newSVpvn(pv2, cur2);
6702 sv_recode_to_utf8(svrecode, PL_encoding);
6703 pv2 = SvPV(svrecode, cur2);
6706 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6711 svrecode = newSVpvn(pv1, cur1);
6712 sv_recode_to_utf8(svrecode, PL_encoding);
6713 pv1 = SvPV(svrecode, cur1);
6716 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6722 cmp = cur2 ? -1 : 0;
6726 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6729 cmp = retval < 0 ? -1 : 1;
6730 } else if (cur1 == cur2) {
6733 cmp = cur1 < cur2 ? -1 : 1;
6738 SvREFCNT_dec(svrecode);
6747 =for apidoc sv_cmp_locale
6749 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6750 'use bytes' aware, handles get magic, and will coerce its args to strings
6751 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6757 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6759 #ifdef USE_LOCALE_COLLATE
6765 if (PL_collation_standard)
6769 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6771 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6773 if (!pv1 || !len1) {
6784 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6787 return retval < 0 ? -1 : 1;
6790 * When the result of collation is equality, that doesn't mean
6791 * that there are no differences -- some locales exclude some
6792 * characters from consideration. So to avoid false equalities,
6793 * we use the raw string as a tiebreaker.
6799 #endif /* USE_LOCALE_COLLATE */
6801 return sv_cmp(sv1, sv2);
6805 #ifdef USE_LOCALE_COLLATE
6808 =for apidoc sv_collxfrm
6810 Add Collate Transform magic to an SV if it doesn't already have it.
6812 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6813 scalar data of the variable, but transformed to such a format that a normal
6814 memory comparison can be used to compare the data according to the locale
6821 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6825 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6826 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6831 Safefree(mg->mg_ptr);
6833 if ((xf = mem_collxfrm(s, len, &xlen))) {
6834 if (SvREADONLY(sv)) {
6837 return xf + sizeof(PL_collation_ix);
6840 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6841 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6854 if (mg && mg->mg_ptr) {
6856 return mg->mg_ptr + sizeof(PL_collation_ix);
6864 #endif /* USE_LOCALE_COLLATE */
6869 Get a line from the filehandle and store it into the SV, optionally
6870 appending to the currently-stored string.
6876 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6880 register STDCHAR rslast;
6881 register STDCHAR *bp;
6887 if (SvTHINKFIRST(sv))
6888 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6889 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6891 However, perlbench says it's slower, because the existing swipe code
6892 is faster than copy on write.
6893 Swings and roundabouts. */
6894 SvUPGRADE(sv, SVt_PV);
6899 if (PerlIO_isutf8(fp)) {
6901 sv_utf8_upgrade_nomg(sv);
6902 sv_pos_u2b(sv,&append,0);
6904 } else if (SvUTF8(sv)) {
6905 SV *tsv = NEWSV(0,0);
6906 sv_gets(tsv, fp, 0);
6907 sv_utf8_upgrade_nomg(tsv);
6908 SvCUR_set(sv,append);
6911 goto return_string_or_null;
6916 if (PerlIO_isutf8(fp))
6919 if (IN_PERL_COMPILETIME) {
6920 /* we always read code in line mode */
6924 else if (RsSNARF(PL_rs)) {
6925 /* If it is a regular disk file use size from stat() as estimate
6926 of amount we are going to read - may result in malloc-ing
6927 more memory than we realy need if layers bellow reduce
6928 size we read (e.g. CRLF or a gzip layer)
6931 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6932 const Off_t offset = PerlIO_tell(fp);
6933 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6934 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6940 else if (RsRECORD(PL_rs)) {
6944 /* Grab the size of the record we're getting */
6945 recsize = SvIV(SvRV(PL_rs));
6946 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6949 /* VMS wants read instead of fread, because fread doesn't respect */
6950 /* RMS record boundaries. This is not necessarily a good thing to be */
6951 /* doing, but we've got no other real choice - except avoid stdio
6952 as implementation - perhaps write a :vms layer ?
6954 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6956 bytesread = PerlIO_read(fp, buffer, recsize);
6960 SvCUR_set(sv, bytesread += append);
6961 buffer[bytesread] = '\0';
6962 goto return_string_or_null;
6964 else if (RsPARA(PL_rs)) {
6970 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6971 if (PerlIO_isutf8(fp)) {
6972 rsptr = SvPVutf8(PL_rs, rslen);
6975 if (SvUTF8(PL_rs)) {
6976 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6977 Perl_croak(aTHX_ "Wide character in $/");
6980 rsptr = SvPV(PL_rs, rslen);
6984 rslast = rslen ? rsptr[rslen - 1] : '\0';
6986 if (rspara) { /* have to do this both before and after */
6987 do { /* to make sure file boundaries work right */
6990 i = PerlIO_getc(fp);
6994 PerlIO_ungetc(fp,i);
7000 /* See if we know enough about I/O mechanism to cheat it ! */
7002 /* This used to be #ifdef test - it is made run-time test for ease
7003 of abstracting out stdio interface. One call should be cheap
7004 enough here - and may even be a macro allowing compile
7008 if (PerlIO_fast_gets(fp)) {
7011 * We're going to steal some values from the stdio struct
7012 * and put EVERYTHING in the innermost loop into registers.
7014 register STDCHAR *ptr;
7018 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7019 /* An ungetc()d char is handled separately from the regular
7020 * buffer, so we getc() it back out and stuff it in the buffer.
7022 i = PerlIO_getc(fp);
7023 if (i == EOF) return 0;
7024 *(--((*fp)->_ptr)) = (unsigned char) i;
7028 /* Here is some breathtakingly efficient cheating */
7030 cnt = PerlIO_get_cnt(fp); /* get count into register */
7031 /* make sure we have the room */
7032 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7033 /* Not room for all of it
7034 if we are looking for a separator and room for some
7036 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7037 /* just process what we have room for */
7038 shortbuffered = cnt - SvLEN(sv) + append + 1;
7039 cnt -= shortbuffered;
7043 /* remember that cnt can be negative */
7044 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7049 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7050 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7051 DEBUG_P(PerlIO_printf(Perl_debug_log,
7052 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7053 DEBUG_P(PerlIO_printf(Perl_debug_log,
7054 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7055 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7056 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7061 while (cnt > 0) { /* this | eat */
7063 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7064 goto thats_all_folks; /* screams | sed :-) */
7068 Copy(ptr, bp, cnt, char); /* this | eat */
7069 bp += cnt; /* screams | dust */
7070 ptr += cnt; /* louder | sed :-) */
7075 if (shortbuffered) { /* oh well, must extend */
7076 cnt = shortbuffered;
7078 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7080 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7081 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7085 DEBUG_P(PerlIO_printf(Perl_debug_log,
7086 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7087 PTR2UV(ptr),(long)cnt));
7088 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7090 DEBUG_P(PerlIO_printf(Perl_debug_log,
7091 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7092 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7093 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7095 /* This used to call 'filbuf' in stdio form, but as that behaves like
7096 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7097 another abstraction. */
7098 i = PerlIO_getc(fp); /* get more characters */
7100 DEBUG_P(PerlIO_printf(Perl_debug_log,
7101 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7102 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7103 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7105 cnt = PerlIO_get_cnt(fp);
7106 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7107 DEBUG_P(PerlIO_printf(Perl_debug_log,
7108 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7110 if (i == EOF) /* all done for ever? */
7111 goto thats_really_all_folks;
7113 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7115 SvGROW(sv, bpx + cnt + 2);
7116 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7118 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7120 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7121 goto thats_all_folks;
7125 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7126 memNE((char*)bp - rslen, rsptr, rslen))
7127 goto screamer; /* go back to the fray */
7128 thats_really_all_folks:
7130 cnt += shortbuffered;
7131 DEBUG_P(PerlIO_printf(Perl_debug_log,
7132 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7133 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7134 DEBUG_P(PerlIO_printf(Perl_debug_log,
7135 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7136 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7137 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7139 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7140 DEBUG_P(PerlIO_printf(Perl_debug_log,
7141 "Screamer: done, len=%ld, string=|%.*s|\n",
7142 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7146 /*The big, slow, and stupid way. */
7147 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7149 New(0, buf, 8192, STDCHAR);
7157 const register STDCHAR *bpe = buf + sizeof(buf);
7159 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7160 ; /* keep reading */
7164 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7165 /* Accomodate broken VAXC compiler, which applies U8 cast to
7166 * both args of ?: operator, causing EOF to change into 255
7169 i = (U8)buf[cnt - 1];
7175 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7177 sv_catpvn(sv, (char *) buf, cnt);
7179 sv_setpvn(sv, (char *) buf, cnt);
7181 if (i != EOF && /* joy */
7183 SvCUR(sv) < rslen ||
7184 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7188 * If we're reading from a TTY and we get a short read,
7189 * indicating that the user hit his EOF character, we need
7190 * to notice it now, because if we try to read from the TTY
7191 * again, the EOF condition will disappear.
7193 * The comparison of cnt to sizeof(buf) is an optimization
7194 * that prevents unnecessary calls to feof().
7198 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7202 #ifdef USE_HEAP_INSTEAD_OF_STACK
7207 if (rspara) { /* have to do this both before and after */
7208 while (i != EOF) { /* to make sure file boundaries work right */
7209 i = PerlIO_getc(fp);
7211 PerlIO_ungetc(fp,i);
7217 return_string_or_null:
7218 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7224 Auto-increment of the value in the SV, doing string to numeric conversion
7225 if necessary. Handles 'get' magic.
7231 Perl_sv_inc(pTHX_ register SV *sv)
7240 if (SvTHINKFIRST(sv)) {
7242 sv_force_normal_flags(sv, 0);
7243 if (SvREADONLY(sv)) {
7244 if (IN_PERL_RUNTIME)
7245 Perl_croak(aTHX_ PL_no_modify);
7249 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7251 i = PTR2IV(SvRV(sv));
7256 flags = SvFLAGS(sv);
7257 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7258 /* It's (privately or publicly) a float, but not tested as an
7259 integer, so test it to see. */
7261 flags = SvFLAGS(sv);
7263 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7264 /* It's publicly an integer, or privately an integer-not-float */
7265 #ifdef PERL_PRESERVE_IVUV
7269 if (SvUVX(sv) == UV_MAX)
7270 sv_setnv(sv, UV_MAX_P1);
7272 (void)SvIOK_only_UV(sv);
7273 SvUV_set(sv, SvUVX(sv) + 1);
7275 if (SvIVX(sv) == IV_MAX)
7276 sv_setuv(sv, (UV)IV_MAX + 1);
7278 (void)SvIOK_only(sv);
7279 SvIV_set(sv, SvIVX(sv) + 1);
7284 if (flags & SVp_NOK) {
7285 (void)SvNOK_only(sv);
7286 SvNV_set(sv, SvNVX(sv) + 1.0);
7290 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7291 if ((flags & SVTYPEMASK) < SVt_PVIV)
7292 sv_upgrade(sv, SVt_IV);
7293 (void)SvIOK_only(sv);
7298 while (isALPHA(*d)) d++;
7299 while (isDIGIT(*d)) d++;
7301 #ifdef PERL_PRESERVE_IVUV
7302 /* Got to punt this as an integer if needs be, but we don't issue
7303 warnings. Probably ought to make the sv_iv_please() that does
7304 the conversion if possible, and silently. */
7305 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7306 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7307 /* Need to try really hard to see if it's an integer.
7308 9.22337203685478e+18 is an integer.
7309 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7310 so $a="9.22337203685478e+18"; $a+0; $a++
7311 needs to be the same as $a="9.22337203685478e+18"; $a++
7318 /* sv_2iv *should* have made this an NV */
7319 if (flags & SVp_NOK) {
7320 (void)SvNOK_only(sv);
7321 SvNV_set(sv, SvNVX(sv) + 1.0);
7324 /* I don't think we can get here. Maybe I should assert this
7325 And if we do get here I suspect that sv_setnv will croak. NWC
7327 #if defined(USE_LONG_DOUBLE)
7328 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",
7329 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7331 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7332 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7335 #endif /* PERL_PRESERVE_IVUV */
7336 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7340 while (d >= SvPVX_const(sv)) {
7348 /* MKS: The original code here died if letters weren't consecutive.
7349 * at least it didn't have to worry about non-C locales. The
7350 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7351 * arranged in order (although not consecutively) and that only
7352 * [A-Za-z] are accepted by isALPHA in the C locale.
7354 if (*d != 'z' && *d != 'Z') {
7355 do { ++*d; } while (!isALPHA(*d));
7358 *(d--) -= 'z' - 'a';
7363 *(d--) -= 'z' - 'a' + 1;
7367 /* oh,oh, the number grew */
7368 SvGROW(sv, SvCUR(sv) + 2);
7369 SvCUR_set(sv, SvCUR(sv) + 1);
7370 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7381 Auto-decrement of the value in the SV, doing string to numeric conversion
7382 if necessary. Handles 'get' magic.
7388 Perl_sv_dec(pTHX_ register SV *sv)
7396 if (SvTHINKFIRST(sv)) {
7398 sv_force_normal_flags(sv, 0);
7399 if (SvREADONLY(sv)) {
7400 if (IN_PERL_RUNTIME)
7401 Perl_croak(aTHX_ PL_no_modify);
7405 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7407 i = PTR2IV(SvRV(sv));
7412 /* Unlike sv_inc we don't have to worry about string-never-numbers
7413 and keeping them magic. But we mustn't warn on punting */
7414 flags = SvFLAGS(sv);
7415 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7416 /* It's publicly an integer, or privately an integer-not-float */
7417 #ifdef PERL_PRESERVE_IVUV
7421 if (SvUVX(sv) == 0) {
7422 (void)SvIOK_only(sv);
7426 (void)SvIOK_only_UV(sv);
7427 SvUV_set(sv, SvUVX(sv) + 1);
7430 if (SvIVX(sv) == IV_MIN)
7431 sv_setnv(sv, (NV)IV_MIN - 1.0);
7433 (void)SvIOK_only(sv);
7434 SvIV_set(sv, SvIVX(sv) - 1);
7439 if (flags & SVp_NOK) {
7440 SvNV_set(sv, SvNVX(sv) - 1.0);
7441 (void)SvNOK_only(sv);
7444 if (!(flags & SVp_POK)) {
7445 if ((flags & SVTYPEMASK) < SVt_PVNV)
7446 sv_upgrade(sv, SVt_NV);
7448 (void)SvNOK_only(sv);
7451 #ifdef PERL_PRESERVE_IVUV
7453 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7454 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7455 /* Need to try really hard to see if it's an integer.
7456 9.22337203685478e+18 is an integer.
7457 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7458 so $a="9.22337203685478e+18"; $a+0; $a--
7459 needs to be the same as $a="9.22337203685478e+18"; $a--
7466 /* sv_2iv *should* have made this an NV */
7467 if (flags & SVp_NOK) {
7468 (void)SvNOK_only(sv);
7469 SvNV_set(sv, SvNVX(sv) - 1.0);
7472 /* I don't think we can get here. Maybe I should assert this
7473 And if we do get here I suspect that sv_setnv will croak. NWC
7475 #if defined(USE_LONG_DOUBLE)
7476 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",
7477 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7479 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7480 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7484 #endif /* PERL_PRESERVE_IVUV */
7485 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7489 =for apidoc sv_mortalcopy
7491 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7492 The new SV is marked as mortal. It will be destroyed "soon", either by an
7493 explicit call to FREETMPS, or by an implicit call at places such as
7494 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7499 /* Make a string that will exist for the duration of the expression
7500 * evaluation. Actually, it may have to last longer than that, but
7501 * hopefully we won't free it until it has been assigned to a
7502 * permanent location. */
7505 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7510 sv_setsv(sv,oldstr);
7512 PL_tmps_stack[++PL_tmps_ix] = sv;
7518 =for apidoc sv_newmortal
7520 Creates a new null SV which is mortal. The reference count of the SV is
7521 set to 1. It will be destroyed "soon", either by an explicit call to
7522 FREETMPS, or by an implicit call at places such as statement boundaries.
7523 See also C<sv_mortalcopy> and C<sv_2mortal>.
7529 Perl_sv_newmortal(pTHX)
7534 SvFLAGS(sv) = SVs_TEMP;
7536 PL_tmps_stack[++PL_tmps_ix] = sv;
7541 =for apidoc sv_2mortal
7543 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7544 by an explicit call to FREETMPS, or by an implicit call at places such as
7545 statement boundaries. SvTEMP() is turned on which means that the SV's
7546 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7547 and C<sv_mortalcopy>.
7553 Perl_sv_2mortal(pTHX_ register SV *sv)
7558 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7561 PL_tmps_stack[++PL_tmps_ix] = sv;
7569 Creates a new SV and copies a string into it. The reference count for the
7570 SV is set to 1. If C<len> is zero, Perl will compute the length using
7571 strlen(). For efficiency, consider using C<newSVpvn> instead.
7577 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7582 sv_setpvn(sv,s,len ? len : strlen(s));
7587 =for apidoc newSVpvn
7589 Creates a new SV and copies a string into it. The reference count for the
7590 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7591 string. You are responsible for ensuring that the source string is at least
7592 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7598 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7603 sv_setpvn(sv,s,len);
7609 =for apidoc newSVpv_hek
7611 Creates a new SV from the hash key structure. It will generate scalars that
7612 point to the shared string table where possible. Returns a new (undefined)
7613 SV if the hek is NULL.
7619 Perl_newSVhek(pTHX_ const HEK *hek)
7628 if (HEK_LEN(hek) == HEf_SVKEY) {
7629 return newSVsv(*(SV**)HEK_KEY(hek));
7631 const int flags = HEK_FLAGS(hek);
7632 if (flags & HVhek_WASUTF8) {
7634 Andreas would like keys he put in as utf8 to come back as utf8
7636 STRLEN utf8_len = HEK_LEN(hek);
7637 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7638 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7641 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7643 } else if (flags & HVhek_REHASH) {
7644 /* We don't have a pointer to the hv, so we have to replicate the
7645 flag into every HEK. This hv is using custom a hasing
7646 algorithm. Hence we can't return a shared string scalar, as
7647 that would contain the (wrong) hash value, and might get passed
7648 into an hv routine with a regular hash */
7650 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7655 /* This will be overwhelminly the most common case. */
7656 return newSVpvn_share(HEK_KEY(hek),
7657 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7663 =for apidoc newSVpvn_share
7665 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7666 table. If the string does not already exist in the table, it is created
7667 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7668 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7669 otherwise the hash is computed. The idea here is that as the string table
7670 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7671 hash lookup will avoid string compare.
7677 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7680 bool is_utf8 = FALSE;
7682 STRLEN tmplen = -len;
7684 /* See the note in hv.c:hv_fetch() --jhi */
7685 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7689 PERL_HASH(hash, src, len);
7691 sv_upgrade(sv, SVt_PVIV);
7692 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7705 #if defined(PERL_IMPLICIT_CONTEXT)
7707 /* pTHX_ magic can't cope with varargs, so this is a no-context
7708 * version of the main function, (which may itself be aliased to us).
7709 * Don't access this version directly.
7713 Perl_newSVpvf_nocontext(const char* pat, ...)
7718 va_start(args, pat);
7719 sv = vnewSVpvf(pat, &args);
7726 =for apidoc newSVpvf
7728 Creates a new SV and initializes it with the string formatted like
7735 Perl_newSVpvf(pTHX_ const char* pat, ...)
7739 va_start(args, pat);
7740 sv = vnewSVpvf(pat, &args);
7745 /* backend for newSVpvf() and newSVpvf_nocontext() */
7748 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7752 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7759 Creates a new SV and copies a floating point value into it.
7760 The reference count for the SV is set to 1.
7766 Perl_newSVnv(pTHX_ NV n)
7778 Creates a new SV and copies an integer into it. The reference count for the
7785 Perl_newSViv(pTHX_ IV i)
7797 Creates a new SV and copies an unsigned integer into it.
7798 The reference count for the SV is set to 1.
7804 Perl_newSVuv(pTHX_ UV u)
7814 =for apidoc newRV_noinc
7816 Creates an RV wrapper for an SV. The reference count for the original
7817 SV is B<not> incremented.
7823 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7828 sv_upgrade(sv, SVt_RV);
7830 SvRV_set(sv, tmpRef);
7835 /* newRV_inc is the official function name to use now.
7836 * newRV_inc is in fact #defined to newRV in sv.h
7840 Perl_newRV(pTHX_ SV *tmpRef)
7842 return newRV_noinc(SvREFCNT_inc(tmpRef));
7848 Creates a new SV which is an exact duplicate of the original SV.
7855 Perl_newSVsv(pTHX_ register SV *old)
7861 if (SvTYPE(old) == SVTYPEMASK) {
7862 if (ckWARN_d(WARN_INTERNAL))
7863 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7867 /* SV_GMAGIC is the default for sv_setv()
7868 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7869 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7870 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7875 =for apidoc sv_reset
7877 Underlying implementation for the C<reset> Perl function.
7878 Note that the perl-level function is vaguely deprecated.
7884 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7887 char todo[PERL_UCHAR_MAX+1];
7892 if (!*s) { /* reset ?? searches */
7893 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7895 PMOP *pm = (PMOP *) mg->mg_obj;
7897 pm->op_pmdynflags &= ~PMdf_USED;
7904 /* reset variables */
7906 if (!HvARRAY(stash))
7909 Zero(todo, 256, char);
7912 I32 i = (unsigned char)*s;
7916 max = (unsigned char)*s++;
7917 for ( ; i <= max; i++) {
7920 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7922 for (entry = HvARRAY(stash)[i];
7924 entry = HeNEXT(entry))
7929 if (!todo[(U8)*HeKEY(entry)])
7931 gv = (GV*)HeVAL(entry);
7933 if (SvTHINKFIRST(sv)) {
7934 if (!SvREADONLY(sv) && SvROK(sv))
7939 if (SvTYPE(sv) >= SVt_PV) {
7941 if (SvPVX_const(sv) != Nullch)
7948 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7951 #ifdef USE_ENVIRON_ARRAY
7953 # ifdef USE_ITHREADS
7954 && PL_curinterp == aTHX
7958 environ[0] = Nullch;
7961 #endif /* !PERL_MICRO */
7971 Using various gambits, try to get an IO from an SV: the IO slot if its a
7972 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7973 named after the PV if we're a string.
7979 Perl_sv_2io(pTHX_ SV *sv)
7984 switch (SvTYPE(sv)) {
7992 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7996 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7998 return sv_2io(SvRV(sv));
7999 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8005 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8014 Using various gambits, try to get a CV from an SV; in addition, try if
8015 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8021 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8028 return *gvp = Nullgv, Nullcv;
8029 switch (SvTYPE(sv)) {
8048 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8049 tryAMAGICunDEREF(to_cv);
8052 if (SvTYPE(sv) == SVt_PVCV) {
8061 Perl_croak(aTHX_ "Not a subroutine reference");
8066 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8072 if (lref && !GvCVu(gv)) {
8075 tmpsv = NEWSV(704,0);
8076 gv_efullname3(tmpsv, gv, Nullch);
8077 /* XXX this is probably not what they think they're getting.
8078 * It has the same effect as "sub name;", i.e. just a forward
8080 newSUB(start_subparse(FALSE, 0),
8081 newSVOP(OP_CONST, 0, tmpsv),
8086 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8096 Returns true if the SV has a true value by Perl's rules.
8097 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8098 instead use an in-line version.
8104 Perl_sv_true(pTHX_ register SV *sv)
8109 const register XPV* tXpv;
8110 if ((tXpv = (XPV*)SvANY(sv)) &&
8111 (tXpv->xpv_cur > 1 ||
8112 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8119 return SvIVX(sv) != 0;
8122 return SvNVX(sv) != 0.0;
8124 return sv_2bool(sv);
8132 A private implementation of the C<SvIVx> macro for compilers which can't
8133 cope with complex macro expressions. Always use the macro instead.
8139 Perl_sv_iv(pTHX_ register SV *sv)
8143 return (IV)SvUVX(sv);
8152 A private implementation of the C<SvUVx> macro for compilers which can't
8153 cope with complex macro expressions. Always use the macro instead.
8159 Perl_sv_uv(pTHX_ register SV *sv)
8164 return (UV)SvIVX(sv);
8172 A private implementation of the C<SvNVx> macro for compilers which can't
8173 cope with complex macro expressions. Always use the macro instead.
8179 Perl_sv_nv(pTHX_ register SV *sv)
8186 /* sv_pv() is now a macro using SvPV_nolen();
8187 * this function provided for binary compatibility only
8191 Perl_sv_pv(pTHX_ SV *sv)
8198 return sv_2pv(sv, &n_a);
8204 Use the C<SvPV_nolen> macro instead
8208 A private implementation of the C<SvPV> macro for compilers which can't
8209 cope with complex macro expressions. Always use the macro instead.
8215 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8221 return sv_2pv(sv, lp);
8226 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8232 return sv_2pv_flags(sv, lp, 0);
8235 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8236 * this function provided for binary compatibility only
8240 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8242 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8246 =for apidoc sv_pvn_force
8248 Get a sensible string out of the SV somehow.
8249 A private implementation of the C<SvPV_force> macro for compilers which
8250 can't cope with complex macro expressions. Always use the macro instead.
8252 =for apidoc sv_pvn_force_flags
8254 Get a sensible string out of the SV somehow.
8255 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8256 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8257 implemented in terms of this function.
8258 You normally want to use the various wrapper macros instead: see
8259 C<SvPV_force> and C<SvPV_force_nomg>
8265 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8268 if (SvTHINKFIRST(sv) && !SvROK(sv))
8269 sv_force_normal_flags(sv, 0);
8277 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8279 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8280 sv_reftype(sv,0), OP_NAME(PL_op));
8282 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
8285 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8286 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8290 s = sv_2pv_flags(sv, lp, flags);
8291 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8292 const STRLEN len = *lp;
8296 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8297 SvGROW(sv, len + 1);
8298 Move(s,SvPVX_const(sv),len,char);
8303 SvPOK_on(sv); /* validate pointer */
8305 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8306 PTR2UV(sv),SvPVX_const(sv)));
8309 return SvPVX_mutable(sv);
8312 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8313 * this function provided for binary compatibility only
8317 Perl_sv_pvbyte(pTHX_ SV *sv)
8319 sv_utf8_downgrade(sv,0);
8324 =for apidoc sv_pvbyte
8326 Use C<SvPVbyte_nolen> instead.
8328 =for apidoc sv_pvbyten
8330 A private implementation of the C<SvPVbyte> macro for compilers
8331 which can't cope with complex macro expressions. Always use the macro
8338 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8340 sv_utf8_downgrade(sv,0);
8341 return sv_pvn(sv,lp);
8345 =for apidoc sv_pvbyten_force
8347 A private implementation of the C<SvPVbytex_force> macro for compilers
8348 which can't cope with complex macro expressions. Always use the macro
8355 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8357 sv_pvn_force(sv,lp);
8358 sv_utf8_downgrade(sv,0);
8363 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8364 * this function provided for binary compatibility only
8368 Perl_sv_pvutf8(pTHX_ SV *sv)
8370 sv_utf8_upgrade(sv);
8375 =for apidoc sv_pvutf8
8377 Use the C<SvPVutf8_nolen> macro instead
8379 =for apidoc sv_pvutf8n
8381 A private implementation of the C<SvPVutf8> macro for compilers
8382 which can't cope with complex macro expressions. Always use the macro
8389 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8391 sv_utf8_upgrade(sv);
8392 return sv_pvn(sv,lp);
8396 =for apidoc sv_pvutf8n_force
8398 A private implementation of the C<SvPVutf8_force> macro for compilers
8399 which can't cope with complex macro expressions. Always use the macro
8406 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8408 sv_pvn_force(sv,lp);
8409 sv_utf8_upgrade(sv);
8415 =for apidoc sv_reftype
8417 Returns a string describing what the SV is a reference to.
8423 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8425 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8426 inside return suggests a const propagation bug in g++. */
8427 if (ob && SvOBJECT(sv)) {
8428 char *name = HvNAME_get(SvSTASH(sv));
8429 return name ? name : (char *) "__ANON__";
8432 switch (SvTYPE(sv)) {
8449 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8450 /* tied lvalues should appear to be
8451 * scalars for backwards compatitbility */
8452 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8453 ? "SCALAR" : "LVALUE");
8454 case SVt_PVAV: return "ARRAY";
8455 case SVt_PVHV: return "HASH";
8456 case SVt_PVCV: return "CODE";
8457 case SVt_PVGV: return "GLOB";
8458 case SVt_PVFM: return "FORMAT";
8459 case SVt_PVIO: return "IO";
8460 default: return "UNKNOWN";
8466 =for apidoc sv_isobject
8468 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8469 object. If the SV is not an RV, or if the object is not blessed, then this
8476 Perl_sv_isobject(pTHX_ SV *sv)
8493 Returns a boolean indicating whether the SV is blessed into the specified
8494 class. This does not check for subtypes; use C<sv_derived_from> to verify
8495 an inheritance relationship.
8501 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8513 hvname = HvNAME_get(SvSTASH(sv));
8517 return strEQ(hvname, name);
8523 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8524 it will be upgraded to one. If C<classname> is non-null then the new SV will
8525 be blessed in the specified package. The new SV is returned and its
8526 reference count is 1.
8532 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8538 SV_CHECK_THINKFIRST_COW_DROP(rv);
8541 if (SvTYPE(rv) >= SVt_PVMG) {
8542 const U32 refcnt = SvREFCNT(rv);
8546 SvREFCNT(rv) = refcnt;
8549 if (SvTYPE(rv) < SVt_RV)
8550 sv_upgrade(rv, SVt_RV);
8551 else if (SvTYPE(rv) > SVt_RV) {
8562 HV* stash = gv_stashpv(classname, TRUE);
8563 (void)sv_bless(rv, stash);
8569 =for apidoc sv_setref_pv
8571 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8572 argument will be upgraded to an RV. That RV will be modified to point to
8573 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8574 into the SV. The C<classname> argument indicates the package for the
8575 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8576 will have a reference count of 1, and the RV will be returned.
8578 Do not use with other Perl types such as HV, AV, SV, CV, because those
8579 objects will become corrupted by the pointer copy process.
8581 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8587 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8590 sv_setsv(rv, &PL_sv_undef);
8594 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8599 =for apidoc sv_setref_iv
8601 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8602 argument will be upgraded to an RV. That RV will be modified to point to
8603 the new SV. The C<classname> argument indicates the package for the
8604 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8605 will have a reference count of 1, and the RV will be returned.
8611 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8613 sv_setiv(newSVrv(rv,classname), iv);
8618 =for apidoc sv_setref_uv
8620 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8621 argument will be upgraded to an RV. That RV will be modified to point to
8622 the new SV. The C<classname> argument indicates the package for the
8623 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8624 will have a reference count of 1, and the RV will be returned.
8630 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8632 sv_setuv(newSVrv(rv,classname), uv);
8637 =for apidoc sv_setref_nv
8639 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8640 argument will be upgraded to an RV. That RV will be modified to point to
8641 the new SV. The C<classname> argument indicates the package for the
8642 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8643 will have a reference count of 1, and the RV will be returned.
8649 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8651 sv_setnv(newSVrv(rv,classname), nv);
8656 =for apidoc sv_setref_pvn
8658 Copies a string into a new SV, optionally blessing the SV. The length of the
8659 string must be specified with C<n>. The C<rv> argument will be upgraded to
8660 an RV. That RV will be modified to point to the new SV. The C<classname>
8661 argument indicates the package for the blessing. Set C<classname> to
8662 C<Nullch> to avoid the blessing. The new SV will have a reference count
8663 of 1, and the RV will be returned.
8665 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8671 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8673 sv_setpvn(newSVrv(rv,classname), pv, n);
8678 =for apidoc sv_bless
8680 Blesses an SV into a specified package. The SV must be an RV. The package
8681 must be designated by its stash (see C<gv_stashpv()>). The reference count
8682 of the SV is unaffected.
8688 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8692 Perl_croak(aTHX_ "Can't bless non-reference value");
8694 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8695 if (SvREADONLY(tmpRef))
8696 Perl_croak(aTHX_ PL_no_modify);
8697 if (SvOBJECT(tmpRef)) {
8698 if (SvTYPE(tmpRef) != SVt_PVIO)
8700 SvREFCNT_dec(SvSTASH(tmpRef));
8703 SvOBJECT_on(tmpRef);
8704 if (SvTYPE(tmpRef) != SVt_PVIO)
8706 SvUPGRADE(tmpRef, SVt_PVMG);
8707 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8714 if(SvSMAGICAL(tmpRef))
8715 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8723 /* Downgrades a PVGV to a PVMG.
8727 S_sv_unglob(pTHX_ SV *sv)
8731 assert(SvTYPE(sv) == SVt_PVGV);
8736 SvREFCNT_dec(GvSTASH(sv));
8737 GvSTASH(sv) = Nullhv;
8739 sv_unmagic(sv, PERL_MAGIC_glob);
8740 Safefree(GvNAME(sv));
8743 /* need to keep SvANY(sv) in the right arena */
8744 xpvmg = new_XPVMG();
8745 StructCopy(SvANY(sv), xpvmg, XPVMG);
8746 del_XPVGV(SvANY(sv));
8749 SvFLAGS(sv) &= ~SVTYPEMASK;
8750 SvFLAGS(sv) |= SVt_PVMG;
8754 =for apidoc sv_unref_flags
8756 Unsets the RV status of the SV, and decrements the reference count of
8757 whatever was being referenced by the RV. This can almost be thought of
8758 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8759 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8760 (otherwise the decrementing is conditional on the reference count being
8761 different from one or the reference being a readonly SV).
8768 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8772 if (SvWEAKREF(sv)) {
8780 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8781 assigned to as BEGIN {$a = \"Foo"} will fail. */
8782 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8784 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8785 sv_2mortal(rv); /* Schedule for freeing later */
8789 =for apidoc sv_unref
8791 Unsets the RV status of the SV, and decrements the reference count of
8792 whatever was being referenced by the RV. This can almost be thought of
8793 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8794 being zero. See C<SvROK_off>.
8800 Perl_sv_unref(pTHX_ SV *sv)
8802 sv_unref_flags(sv, 0);
8806 =for apidoc sv_taint
8808 Taint an SV. Use C<SvTAINTED_on> instead.
8813 Perl_sv_taint(pTHX_ SV *sv)
8815 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8819 =for apidoc sv_untaint
8821 Untaint an SV. Use C<SvTAINTED_off> instead.
8826 Perl_sv_untaint(pTHX_ SV *sv)
8828 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8829 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8836 =for apidoc sv_tainted
8838 Test an SV for taintedness. Use C<SvTAINTED> instead.
8843 Perl_sv_tainted(pTHX_ SV *sv)
8845 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8846 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8847 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8854 =for apidoc sv_setpviv
8856 Copies an integer into the given SV, also updating its string value.
8857 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8863 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8865 char buf[TYPE_CHARS(UV)];
8867 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8869 sv_setpvn(sv, ptr, ebuf - ptr);
8873 =for apidoc sv_setpviv_mg
8875 Like C<sv_setpviv>, but also handles 'set' magic.
8881 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8883 char buf[TYPE_CHARS(UV)];
8885 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8887 sv_setpvn(sv, ptr, ebuf - ptr);
8891 #if defined(PERL_IMPLICIT_CONTEXT)
8893 /* pTHX_ magic can't cope with varargs, so this is a no-context
8894 * version of the main function, (which may itself be aliased to us).
8895 * Don't access this version directly.
8899 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8903 va_start(args, pat);
8904 sv_vsetpvf(sv, pat, &args);
8908 /* pTHX_ magic can't cope with varargs, so this is a no-context
8909 * version of the main function, (which may itself be aliased to us).
8910 * Don't access this version directly.
8914 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8918 va_start(args, pat);
8919 sv_vsetpvf_mg(sv, pat, &args);
8925 =for apidoc sv_setpvf
8927 Works like C<sv_catpvf> but copies the text into the SV instead of
8928 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8934 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8937 va_start(args, pat);
8938 sv_vsetpvf(sv, pat, &args);
8943 =for apidoc sv_vsetpvf
8945 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8946 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8948 Usually used via its frontend C<sv_setpvf>.
8954 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8956 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8960 =for apidoc sv_setpvf_mg
8962 Like C<sv_setpvf>, but also handles 'set' magic.
8968 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8971 va_start(args, pat);
8972 sv_vsetpvf_mg(sv, pat, &args);
8977 =for apidoc sv_vsetpvf_mg
8979 Like C<sv_vsetpvf>, but also handles 'set' magic.
8981 Usually used via its frontend C<sv_setpvf_mg>.
8987 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8989 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8993 #if defined(PERL_IMPLICIT_CONTEXT)
8995 /* pTHX_ magic can't cope with varargs, so this is a no-context
8996 * version of the main function, (which may itself be aliased to us).
8997 * Don't access this version directly.
9001 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
9005 va_start(args, pat);
9006 sv_vcatpvf(sv, pat, &args);
9010 /* pTHX_ magic can't cope with varargs, so this is a no-context
9011 * version of the main function, (which may itself be aliased to us).
9012 * Don't access this version directly.
9016 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9020 va_start(args, pat);
9021 sv_vcatpvf_mg(sv, pat, &args);
9027 =for apidoc sv_catpvf
9029 Processes its arguments like C<sprintf> and appends the formatted
9030 output to an SV. If the appended data contains "wide" characters
9031 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9032 and characters >255 formatted with %c), the original SV might get
9033 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9034 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9035 valid UTF-8; if the original SV was bytes, the pattern should be too.
9040 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9043 va_start(args, pat);
9044 sv_vcatpvf(sv, pat, &args);
9049 =for apidoc sv_vcatpvf
9051 Processes its arguments like C<vsprintf> and appends the formatted output
9052 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9054 Usually used via its frontend C<sv_catpvf>.
9060 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9062 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9066 =for apidoc sv_catpvf_mg
9068 Like C<sv_catpvf>, but also handles 'set' magic.
9074 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9077 va_start(args, pat);
9078 sv_vcatpvf_mg(sv, pat, &args);
9083 =for apidoc sv_vcatpvf_mg
9085 Like C<sv_vcatpvf>, but also handles 'set' magic.
9087 Usually used via its frontend C<sv_catpvf_mg>.
9093 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9095 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9100 =for apidoc sv_vsetpvfn
9102 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9105 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9111 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9113 sv_setpvn(sv, "", 0);
9114 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9117 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9120 S_expect_number(pTHX_ char** pattern)
9123 switch (**pattern) {
9124 case '1': case '2': case '3':
9125 case '4': case '5': case '6':
9126 case '7': case '8': case '9':
9127 while (isDIGIT(**pattern))
9128 var = var * 10 + (*(*pattern)++ - '0');
9132 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9135 F0convert(NV nv, char *endbuf, STRLEN *len)
9137 const int neg = nv < 0;
9146 if (uv & 1 && uv == nv)
9147 uv--; /* Round to even */
9149 const unsigned dig = uv % 10;
9162 =for apidoc sv_vcatpvfn
9164 Processes its arguments like C<vsprintf> and appends the formatted output
9165 to an SV. Uses an array of SVs if the C style variable argument list is
9166 missing (NULL). When running with taint checks enabled, indicates via
9167 C<maybe_tainted> if results are untrustworthy (often due to the use of
9170 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9175 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9178 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9185 static const char nullstr[] = "(null)";
9187 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9188 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9190 /* Times 4: a decimal digit takes more than 3 binary digits.
9191 * NV_DIG: mantissa takes than many decimal digits.
9192 * Plus 32: Playing safe. */
9193 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9194 /* large enough for "%#.#f" --chip */
9195 /* what about long double NVs? --jhi */
9197 /* no matter what, this is a string now */
9198 (void)SvPV_force(sv, origlen);
9200 /* special-case "", "%s", and "%-p" (SVf) */
9203 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9205 const char *s = va_arg(*args, char*);
9206 sv_catpv(sv, s ? s : nullstr);
9208 else if (svix < svmax) {
9209 sv_catsv(sv, *svargs);
9210 if (DO_UTF8(*svargs))
9215 if (patlen == 3 && pat[0] == '%' &&
9216 pat[1] == '-' && pat[2] == 'p') {
9218 argsv = va_arg(*args, SV*);
9219 sv_catsv(sv, argsv);
9226 #ifndef USE_LONG_DOUBLE
9227 /* special-case "%.<number>[gf]" */
9228 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9229 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9230 unsigned digits = 0;
9234 while (*pp >= '0' && *pp <= '9')
9235 digits = 10 * digits + (*pp++ - '0');
9236 if (pp - pat == (int)patlen - 1) {
9240 nv = (NV)va_arg(*args, double);
9241 else if (svix < svmax)
9246 /* Add check for digits != 0 because it seems that some
9247 gconverts are buggy in this case, and we don't yet have
9248 a Configure test for this. */
9249 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9250 /* 0, point, slack */
9251 Gconvert(nv, (int)digits, 0, ebuf);
9253 if (*ebuf) /* May return an empty string for digits==0 */
9256 } else if (!digits) {
9259 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9260 sv_catpvn(sv, p, l);
9266 #endif /* !USE_LONG_DOUBLE */
9268 if (!args && svix < svmax && DO_UTF8(*svargs))
9271 patend = (char*)pat + patlen;
9272 for (p = (char*)pat; p < patend; p = q) {
9275 bool vectorize = FALSE;
9276 bool vectorarg = FALSE;
9277 bool vec_utf8 = FALSE;
9283 bool has_precis = FALSE;
9286 bool is_utf8 = FALSE; /* is this item utf8? */
9287 #ifdef HAS_LDBL_SPRINTF_BUG
9288 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9289 with sfio - Allen <allens@cpan.org> */
9290 bool fix_ldbl_sprintf_bug = FALSE;
9294 U8 utf8buf[UTF8_MAXBYTES+1];
9295 STRLEN esignlen = 0;
9297 const char *eptr = Nullch;
9300 U8 *vecstr = Null(U8*);
9307 /* we need a long double target in case HAS_LONG_DOUBLE but
9310 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9318 const char *dotstr = ".";
9319 STRLEN dotstrlen = 1;
9320 I32 efix = 0; /* explicit format parameter index */
9321 I32 ewix = 0; /* explicit width index */
9322 I32 epix = 0; /* explicit precision index */
9323 I32 evix = 0; /* explicit vector index */
9324 bool asterisk = FALSE;
9326 /* echo everything up to the next format specification */
9327 for (q = p; q < patend && *q != '%'; ++q) ;
9329 if (has_utf8 && !pat_utf8)
9330 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9332 sv_catpvn(sv, p, q - p);
9339 We allow format specification elements in this order:
9340 \d+\$ explicit format parameter index
9342 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9343 0 flag (as above): repeated to allow "v02"
9344 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9345 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9347 [%bcdefginopsux_DFOUX] format (mandatory)
9349 if (EXPECT_NUMBER(q, width)) {
9390 if (EXPECT_NUMBER(q, ewix))
9399 if ((vectorarg = asterisk)) {
9411 EXPECT_NUMBER(q, width);
9416 vecsv = va_arg(*args, SV*);
9418 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9419 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9420 dotstr = SvPVx(vecsv, dotstrlen);
9425 vecsv = va_arg(*args, SV*);
9426 vecstr = (U8*)SvPVx(vecsv,veclen);
9427 vec_utf8 = DO_UTF8(vecsv);
9429 else if (efix ? efix <= svmax : svix < svmax) {
9430 vecsv = svargs[efix ? efix-1 : svix++];
9431 vecstr = (U8*)SvPVx(vecsv,veclen);
9432 vec_utf8 = DO_UTF8(vecsv);
9433 /* if this is a version object, we need to return the
9434 * stringified representation (which the SvPVX_const has
9435 * already done for us), but not vectorize the args
9437 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9439 q++; /* skip past the rest of the %vd format */
9440 eptr = (char *) vecstr;
9441 elen = strlen(eptr);
9454 i = va_arg(*args, int);
9456 i = (ewix ? ewix <= svmax : svix < svmax) ?
9457 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9459 width = (i < 0) ? -i : i;
9469 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9471 /* XXX: todo, support specified precision parameter */
9475 i = va_arg(*args, int);
9477 i = (ewix ? ewix <= svmax : svix < svmax)
9478 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9479 precis = (i < 0) ? 0 : i;
9484 precis = precis * 10 + (*q++ - '0');
9493 case 'I': /* Ix, I32x, and I64x */
9495 if (q[1] == '6' && q[2] == '4') {
9501 if (q[1] == '3' && q[2] == '2') {
9511 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9522 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9523 if (*(q + 1) == 'l') { /* lld, llf */
9548 argsv = (efix ? efix <= svmax : svix < svmax) ?
9549 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9556 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9558 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9560 eptr = (char*)utf8buf;
9561 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9572 if (args && !vectorize) {
9573 eptr = va_arg(*args, char*);
9575 #ifdef MACOS_TRADITIONAL
9576 /* On MacOS, %#s format is used for Pascal strings */
9581 elen = strlen(eptr);
9583 eptr = (char *)nullstr;
9584 elen = sizeof nullstr - 1;
9588 eptr = SvPVx_const(argsv, elen);
9589 if (DO_UTF8(argsv)) {
9590 if (has_precis && precis < elen) {
9592 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9595 if (width) { /* fudge width (can't fudge elen) */
9596 width += elen - sv_len_utf8(argsv);
9604 if (has_precis && elen > precis)
9611 if (left && args) { /* SVf */
9620 argsv = va_arg(*args, SV*);
9621 eptr = SvPVx_const(argsv, elen);
9626 if (alt || vectorize)
9628 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9646 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9655 esignbuf[esignlen++] = plus;
9659 case 'h': iv = (short)va_arg(*args, int); break;
9660 case 'l': iv = va_arg(*args, long); break;
9661 case 'V': iv = va_arg(*args, IV); break;
9662 default: iv = va_arg(*args, int); break;
9664 case 'q': iv = va_arg(*args, Quad_t); break;
9669 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9671 case 'h': iv = (short)tiv; break;
9672 case 'l': iv = (long)tiv; break;
9674 default: iv = tiv; break;
9676 case 'q': iv = (Quad_t)tiv; break;
9680 if ( !vectorize ) /* we already set uv above */
9685 esignbuf[esignlen++] = plus;
9689 esignbuf[esignlen++] = '-';
9732 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9743 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9744 case 'l': uv = va_arg(*args, unsigned long); break;
9745 case 'V': uv = va_arg(*args, UV); break;
9746 default: uv = va_arg(*args, unsigned); break;
9748 case 'q': uv = va_arg(*args, Uquad_t); break;
9753 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9755 case 'h': uv = (unsigned short)tuv; break;
9756 case 'l': uv = (unsigned long)tuv; break;
9758 default: uv = tuv; break;
9760 case 'q': uv = (Uquad_t)tuv; break;
9767 char *ptr = ebuf + sizeof ebuf;
9773 p = (char*)((c == 'X')
9774 ? "0123456789ABCDEF" : "0123456789abcdef");
9780 esignbuf[esignlen++] = '0';
9781 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9789 if (alt && *ptr != '0')
9798 esignbuf[esignlen++] = '0';
9799 esignbuf[esignlen++] = 'b';
9802 default: /* it had better be ten or less */
9806 } while (uv /= base);
9809 elen = (ebuf + sizeof ebuf) - ptr;
9813 zeros = precis - elen;
9814 else if (precis == 0 && elen == 1 && *eptr == '0')
9820 /* FLOATING POINT */
9823 c = 'f'; /* maybe %F isn't supported here */
9829 /* This is evil, but floating point is even more evil */
9831 /* for SV-style calling, we can only get NV
9832 for C-style calling, we assume %f is double;
9833 for simplicity we allow any of %Lf, %llf, %qf for long double
9837 #if defined(USE_LONG_DOUBLE)
9841 /* [perl #20339] - we should accept and ignore %lf rather than die */
9845 #if defined(USE_LONG_DOUBLE)
9846 intsize = args ? 0 : 'q';
9850 #if defined(HAS_LONG_DOUBLE)
9859 /* now we need (long double) if intsize == 'q', else (double) */
9860 nv = (args && !vectorize) ?
9861 #if LONG_DOUBLESIZE > DOUBLESIZE
9863 va_arg(*args, long double) :
9864 va_arg(*args, double)
9866 va_arg(*args, double)
9872 if (c != 'e' && c != 'E') {
9874 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9875 will cast our (long double) to (double) */
9876 (void)Perl_frexp(nv, &i);
9877 if (i == PERL_INT_MIN)
9878 Perl_die(aTHX_ "panic: frexp");
9880 need = BIT_DIGITS(i);
9882 need += has_precis ? precis : 6; /* known default */
9887 #ifdef HAS_LDBL_SPRINTF_BUG
9888 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9889 with sfio - Allen <allens@cpan.org> */
9892 # define MY_DBL_MAX DBL_MAX
9893 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9894 # if DOUBLESIZE >= 8
9895 # define MY_DBL_MAX 1.7976931348623157E+308L
9897 # define MY_DBL_MAX 3.40282347E+38L
9901 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9902 # define MY_DBL_MAX_BUG 1L
9904 # define MY_DBL_MAX_BUG MY_DBL_MAX
9908 # define MY_DBL_MIN DBL_MIN
9909 # else /* XXX guessing! -Allen */
9910 # if DOUBLESIZE >= 8
9911 # define MY_DBL_MIN 2.2250738585072014E-308L
9913 # define MY_DBL_MIN 1.17549435E-38L
9917 if ((intsize == 'q') && (c == 'f') &&
9918 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9920 /* it's going to be short enough that
9921 * long double precision is not needed */
9923 if ((nv <= 0L) && (nv >= -0L))
9924 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9926 /* would use Perl_fp_class as a double-check but not
9927 * functional on IRIX - see perl.h comments */
9929 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9930 /* It's within the range that a double can represent */
9931 #if defined(DBL_MAX) && !defined(DBL_MIN)
9932 if ((nv >= ((long double)1/DBL_MAX)) ||
9933 (nv <= (-(long double)1/DBL_MAX)))
9935 fix_ldbl_sprintf_bug = TRUE;
9938 if (fix_ldbl_sprintf_bug == TRUE) {
9948 # undef MY_DBL_MAX_BUG
9951 #endif /* HAS_LDBL_SPRINTF_BUG */
9953 need += 20; /* fudge factor */
9954 if (PL_efloatsize < need) {
9955 Safefree(PL_efloatbuf);
9956 PL_efloatsize = need + 20; /* more fudge */
9957 New(906, PL_efloatbuf, PL_efloatsize, char);
9958 PL_efloatbuf[0] = '\0';
9961 if ( !(width || left || plus || alt) && fill != '0'
9962 && has_precis && intsize != 'q' ) { /* Shortcuts */
9963 /* See earlier comment about buggy Gconvert when digits,
9965 if ( c == 'g' && precis) {
9966 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9967 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9968 goto float_converted;
9969 } else if ( c == 'f' && !precis) {
9970 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9975 char *ptr = ebuf + sizeof ebuf;
9978 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9979 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9980 if (intsize == 'q') {
9981 /* Copy the one or more characters in a long double
9982 * format before the 'base' ([efgEFG]) character to
9983 * the format string. */
9984 static char const prifldbl[] = PERL_PRIfldbl;
9985 char const *p = prifldbl + sizeof(prifldbl) - 3;
9986 while (p >= prifldbl) { *--ptr = *p--; }
9991 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9996 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10008 /* No taint. Otherwise we are in the strange situation
10009 * where printf() taints but print($float) doesn't.
10011 #if defined(HAS_LONG_DOUBLE)
10012 if (intsize == 'q')
10013 (void)sprintf(PL_efloatbuf, ptr, nv);
10015 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
10017 (void)sprintf(PL_efloatbuf, ptr, nv);
10021 eptr = PL_efloatbuf;
10022 elen = strlen(PL_efloatbuf);
10028 i = SvCUR(sv) - origlen;
10029 if (args && !vectorize) {
10031 case 'h': *(va_arg(*args, short*)) = i; break;
10032 default: *(va_arg(*args, int*)) = i; break;
10033 case 'l': *(va_arg(*args, long*)) = i; break;
10034 case 'V': *(va_arg(*args, IV*)) = i; break;
10036 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10041 sv_setuv_mg(argsv, (UV)i);
10043 continue; /* not "break" */
10049 if (!args && ckWARN(WARN_PRINTF) &&
10050 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10051 SV *msg = sv_newmortal();
10052 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10053 (PL_op->op_type == OP_PRTF) ? "" : "s");
10056 Perl_sv_catpvf(aTHX_ msg,
10057 "\"%%%c\"", c & 0xFF);
10059 Perl_sv_catpvf(aTHX_ msg,
10060 "\"%%\\%03"UVof"\"",
10063 sv_catpv(msg, "end of string");
10064 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10067 /* output mangled stuff ... */
10073 /* ... right here, because formatting flags should not apply */
10074 SvGROW(sv, SvCUR(sv) + elen + 1);
10076 Copy(eptr, p, elen, char);
10079 SvCUR_set(sv, p - SvPVX_const(sv));
10081 continue; /* not "break" */
10084 /* calculate width before utf8_upgrade changes it */
10085 have = esignlen + zeros + elen;
10087 if (is_utf8 != has_utf8) {
10090 sv_utf8_upgrade(sv);
10093 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10094 sv_utf8_upgrade(nsv);
10098 SvGROW(sv, SvCUR(sv) + elen + 1);
10103 need = (have > width ? have : width);
10106 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10108 if (esignlen && fill == '0') {
10109 for (i = 0; i < (int)esignlen; i++)
10110 *p++ = esignbuf[i];
10112 if (gap && !left) {
10113 memset(p, fill, gap);
10116 if (esignlen && fill != '0') {
10117 for (i = 0; i < (int)esignlen; i++)
10118 *p++ = esignbuf[i];
10121 for (i = zeros; i; i--)
10125 Copy(eptr, p, elen, char);
10129 memset(p, ' ', gap);
10134 Copy(dotstr, p, dotstrlen, char);
10138 vectorize = FALSE; /* done iterating over vecstr */
10145 SvCUR_set(sv, p - SvPVX_const(sv));
10153 /* =========================================================================
10155 =head1 Cloning an interpreter
10157 All the macros and functions in this section are for the private use of
10158 the main function, perl_clone().
10160 The foo_dup() functions make an exact copy of an existing foo thinngy.
10161 During the course of a cloning, a hash table is used to map old addresses
10162 to new addresses. The table is created and manipulated with the
10163 ptr_table_* functions.
10167 ============================================================================*/
10170 #if defined(USE_ITHREADS)
10172 #ifndef GpREFCNT_inc
10173 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10177 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10178 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10179 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10180 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10181 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10182 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10183 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10184 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10185 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10186 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10187 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10188 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10189 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10192 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10193 regcomp.c. AMS 20010712 */
10196 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10201 struct reg_substr_datum *s;
10204 return (REGEXP *)NULL;
10206 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10209 len = r->offsets[0];
10210 npar = r->nparens+1;
10212 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10213 Copy(r->program, ret->program, len+1, regnode);
10215 New(0, ret->startp, npar, I32);
10216 Copy(r->startp, ret->startp, npar, I32);
10217 New(0, ret->endp, npar, I32);
10218 Copy(r->startp, ret->startp, npar, I32);
10220 New(0, ret->substrs, 1, struct reg_substr_data);
10221 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10222 s->min_offset = r->substrs->data[i].min_offset;
10223 s->max_offset = r->substrs->data[i].max_offset;
10224 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10225 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10228 ret->regstclass = NULL;
10230 struct reg_data *d;
10231 const int count = r->data->count;
10233 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10234 char, struct reg_data);
10235 New(0, d->what, count, U8);
10238 for (i = 0; i < count; i++) {
10239 d->what[i] = r->data->what[i];
10240 switch (d->what[i]) {
10241 /* legal options are one of: sfpont
10242 see also regcomp.h and pregfree() */
10244 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10247 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10250 /* This is cheating. */
10251 New(0, d->data[i], 1, struct regnode_charclass_class);
10252 StructCopy(r->data->data[i], d->data[i],
10253 struct regnode_charclass_class);
10254 ret->regstclass = (regnode*)d->data[i];
10257 /* Compiled op trees are readonly, and can thus be
10258 shared without duplication. */
10260 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10264 d->data[i] = r->data->data[i];
10267 d->data[i] = r->data->data[i];
10269 ((reg_trie_data*)d->data[i])->refcount++;
10273 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10282 New(0, ret->offsets, 2*len+1, U32);
10283 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10285 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10286 ret->refcnt = r->refcnt;
10287 ret->minlen = r->minlen;
10288 ret->prelen = r->prelen;
10289 ret->nparens = r->nparens;
10290 ret->lastparen = r->lastparen;
10291 ret->lastcloseparen = r->lastcloseparen;
10292 ret->reganch = r->reganch;
10294 ret->sublen = r->sublen;
10296 if (RX_MATCH_COPIED(ret))
10297 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10299 ret->subbeg = Nullch;
10300 #ifdef PERL_COPY_ON_WRITE
10301 ret->saved_copy = Nullsv;
10304 ptr_table_store(PL_ptr_table, r, ret);
10308 /* duplicate a file handle */
10311 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10317 return (PerlIO*)NULL;
10319 /* look for it in the table first */
10320 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10324 /* create anew and remember what it is */
10325 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10326 ptr_table_store(PL_ptr_table, fp, ret);
10330 /* duplicate a directory handle */
10333 Perl_dirp_dup(pTHX_ DIR *dp)
10341 /* duplicate a typeglob */
10344 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10349 /* look for it in the table first */
10350 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10354 /* create anew and remember what it is */
10355 Newz(0, ret, 1, GP);
10356 ptr_table_store(PL_ptr_table, gp, ret);
10359 ret->gp_refcnt = 0; /* must be before any other dups! */
10360 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10361 ret->gp_io = io_dup_inc(gp->gp_io, param);
10362 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10363 ret->gp_av = av_dup_inc(gp->gp_av, param);
10364 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10365 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10366 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10367 ret->gp_cvgen = gp->gp_cvgen;
10368 ret->gp_flags = gp->gp_flags;
10369 ret->gp_line = gp->gp_line;
10370 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10374 /* duplicate a chain of magic */
10377 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10379 MAGIC *mgprev = (MAGIC*)NULL;
10382 return (MAGIC*)NULL;
10383 /* look for it in the table first */
10384 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10388 for (; mg; mg = mg->mg_moremagic) {
10390 Newz(0, nmg, 1, MAGIC);
10392 mgprev->mg_moremagic = nmg;
10395 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10396 nmg->mg_private = mg->mg_private;
10397 nmg->mg_type = mg->mg_type;
10398 nmg->mg_flags = mg->mg_flags;
10399 if (mg->mg_type == PERL_MAGIC_qr) {
10400 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10402 else if(mg->mg_type == PERL_MAGIC_backref) {
10403 const AV * const av = (AV*) mg->mg_obj;
10406 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10408 for (i = AvFILLp(av); i >= 0; i--) {
10409 if (!svp[i]) continue;
10410 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10413 else if (mg->mg_type == PERL_MAGIC_symtab) {
10414 nmg->mg_obj = mg->mg_obj;
10417 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10418 ? sv_dup_inc(mg->mg_obj, param)
10419 : sv_dup(mg->mg_obj, param);
10421 nmg->mg_len = mg->mg_len;
10422 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10423 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10424 if (mg->mg_len > 0) {
10425 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10426 if (mg->mg_type == PERL_MAGIC_overload_table &&
10427 AMT_AMAGIC((AMT*)mg->mg_ptr))
10429 AMT *amtp = (AMT*)mg->mg_ptr;
10430 AMT *namtp = (AMT*)nmg->mg_ptr;
10432 for (i = 1; i < NofAMmeth; i++) {
10433 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10437 else if (mg->mg_len == HEf_SVKEY)
10438 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10440 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10441 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10448 /* create a new pointer-mapping table */
10451 Perl_ptr_table_new(pTHX)
10454 Newz(0, tbl, 1, PTR_TBL_t);
10455 tbl->tbl_max = 511;
10456 tbl->tbl_items = 0;
10457 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10462 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10464 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10472 struct ptr_tbl_ent* pte;
10473 struct ptr_tbl_ent* pteend;
10474 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10475 pte->next = PL_pte_arenaroot;
10476 PL_pte_arenaroot = pte;
10478 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10479 PL_pte_root = ++pte;
10480 while (pte < pteend) {
10481 pte->next = pte + 1;
10487 STATIC struct ptr_tbl_ent*
10490 struct ptr_tbl_ent* pte;
10494 PL_pte_root = pte->next;
10499 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10501 p->next = PL_pte_root;
10505 /* map an existing pointer using a table */
10508 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10510 PTR_TBL_ENT_t *tblent;
10511 const UV hash = PTR_TABLE_HASH(sv);
10513 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10514 for (; tblent; tblent = tblent->next) {
10515 if (tblent->oldval == sv)
10516 return tblent->newval;
10518 return (void*)NULL;
10521 /* add a new entry to a pointer-mapping table */
10524 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10526 PTR_TBL_ENT_t *tblent, **otblent;
10527 /* XXX this may be pessimal on platforms where pointers aren't good
10528 * hash values e.g. if they grow faster in the most significant
10530 const UV hash = PTR_TABLE_HASH(oldv);
10534 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10535 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10536 if (tblent->oldval == oldv) {
10537 tblent->newval = newv;
10541 tblent = S_new_pte(aTHX);
10542 tblent->oldval = oldv;
10543 tblent->newval = newv;
10544 tblent->next = *otblent;
10547 if (!empty && tbl->tbl_items > tbl->tbl_max)
10548 ptr_table_split(tbl);
10551 /* double the hash bucket size of an existing ptr table */
10554 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10556 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10557 const UV oldsize = tbl->tbl_max + 1;
10558 UV newsize = oldsize * 2;
10561 Renew(ary, newsize, PTR_TBL_ENT_t*);
10562 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10563 tbl->tbl_max = --newsize;
10564 tbl->tbl_ary = ary;
10565 for (i=0; i < oldsize; i++, ary++) {
10566 PTR_TBL_ENT_t **curentp, **entp, *ent;
10569 curentp = ary + oldsize;
10570 for (entp = ary, ent = *ary; ent; ent = *entp) {
10571 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10573 ent->next = *curentp;
10583 /* remove all the entries from a ptr table */
10586 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10588 register PTR_TBL_ENT_t **array;
10589 register PTR_TBL_ENT_t *entry;
10593 if (!tbl || !tbl->tbl_items) {
10597 array = tbl->tbl_ary;
10599 max = tbl->tbl_max;
10603 PTR_TBL_ENT_t *oentry = entry;
10604 entry = entry->next;
10605 S_del_pte(aTHX_ oentry);
10608 if (++riter > max) {
10611 entry = array[riter];
10615 tbl->tbl_items = 0;
10618 /* clear and free a ptr table */
10621 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10626 ptr_table_clear(tbl);
10627 Safefree(tbl->tbl_ary);
10631 /* attempt to make everything in the typeglob readonly */
10634 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10636 GV *gv = (GV*)sstr;
10637 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10639 if (GvIO(gv) || GvFORM(gv)) {
10640 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10642 else if (!GvCV(gv)) {
10643 GvCV(gv) = (CV*)sv;
10646 /* CvPADLISTs cannot be shared */
10647 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10652 if (!GvUNIQUE(gv)) {
10654 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10655 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10661 * write attempts will die with
10662 * "Modification of a read-only value attempted"
10668 SvREADONLY_on(GvSV(gv));
10672 GvAV(gv) = (AV*)sv;
10675 SvREADONLY_on(GvAV(gv));
10679 GvHV(gv) = (HV*)sv;
10682 SvREADONLY_on(GvHV(gv));
10685 return sstr; /* he_dup() will SvREFCNT_inc() */
10688 /* duplicate an SV of any type (including AV, HV etc) */
10691 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10694 SvRV_set(dstr, SvWEAKREF(sstr)
10695 ? sv_dup(SvRV(sstr), param)
10696 : sv_dup_inc(SvRV(sstr), param));
10699 else if (SvPVX_const(sstr)) {
10700 /* Has something there */
10702 /* Normal PV - clone whole allocated space */
10703 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10704 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10705 /* Not that normal - actually sstr is copy on write.
10706 But we are a true, independant SV, so: */
10707 SvREADONLY_off(dstr);
10712 /* Special case - not normally malloced for some reason */
10713 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10714 /* A "shared" PV - clone it as unshared string */
10715 if(SvPADTMP(sstr)) {
10716 /* However, some of them live in the pad
10717 and they should not have these flags
10720 SvPV_set(dstr, sharepvn(SvPVX_const(sstr), SvCUR(sstr),
10722 SvUV_set(dstr, SvUVX(sstr));
10725 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvCUR(sstr)));
10727 SvREADONLY_off(dstr);
10731 /* Some other special case - random pointer */
10732 SvPV_set(dstr, SvPVX(sstr));
10737 /* Copy the Null */
10738 if (SvTYPE(dstr) == SVt_RV)
10739 SvRV_set(dstr, NULL);
10746 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10751 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10753 /* look for it in the table first */
10754 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10758 if(param->flags & CLONEf_JOIN_IN) {
10759 /** We are joining here so we don't want do clone
10760 something that is bad **/
10761 const char *hvname;
10763 if(SvTYPE(sstr) == SVt_PVHV &&
10764 (hvname = HvNAME_get(sstr))) {
10765 /** don't clone stashes if they already exist **/
10766 HV* old_stash = gv_stashpv(hvname,0);
10767 return (SV*) old_stash;
10771 /* create anew and remember what it is */
10774 #ifdef DEBUG_LEAKING_SCALARS
10775 dstr->sv_debug_optype = sstr->sv_debug_optype;
10776 dstr->sv_debug_line = sstr->sv_debug_line;
10777 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10778 dstr->sv_debug_cloned = 1;
10780 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10782 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10786 ptr_table_store(PL_ptr_table, sstr, dstr);
10789 SvFLAGS(dstr) = SvFLAGS(sstr);
10790 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10791 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10794 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10795 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10796 PL_watch_pvx, SvPVX_const(sstr));
10799 /* don't clone objects whose class has asked us not to */
10800 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10801 SvFLAGS(dstr) &= ~SVTYPEMASK;
10802 SvOBJECT_off(dstr);
10806 switch (SvTYPE(sstr)) {
10808 SvANY(dstr) = NULL;
10811 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10812 SvIV_set(dstr, SvIVX(sstr));
10815 SvANY(dstr) = new_XNV();
10816 SvNV_set(dstr, SvNVX(sstr));
10819 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10820 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10823 SvANY(dstr) = new_XPV();
10824 SvCUR_set(dstr, SvCUR(sstr));
10825 SvLEN_set(dstr, SvLEN(sstr));
10826 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10829 SvANY(dstr) = new_XPVIV();
10830 SvCUR_set(dstr, SvCUR(sstr));
10831 SvLEN_set(dstr, SvLEN(sstr));
10832 SvIV_set(dstr, SvIVX(sstr));
10833 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10836 SvANY(dstr) = new_XPVNV();
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 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10844 SvANY(dstr) = new_XPVMG();
10845 SvCUR_set(dstr, SvCUR(sstr));
10846 SvLEN_set(dstr, SvLEN(sstr));
10847 SvIV_set(dstr, SvIVX(sstr));
10848 SvNV_set(dstr, SvNVX(sstr));
10849 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10850 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10851 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10854 SvANY(dstr) = new_XPVBM();
10855 SvCUR_set(dstr, SvCUR(sstr));
10856 SvLEN_set(dstr, SvLEN(sstr));
10857 SvIV_set(dstr, SvIVX(sstr));
10858 SvNV_set(dstr, SvNVX(sstr));
10859 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10860 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10861 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10862 BmRARE(dstr) = BmRARE(sstr);
10863 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10864 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10867 SvANY(dstr) = new_XPVLV();
10868 SvCUR_set(dstr, SvCUR(sstr));
10869 SvLEN_set(dstr, SvLEN(sstr));
10870 SvIV_set(dstr, SvIVX(sstr));
10871 SvNV_set(dstr, SvNVX(sstr));
10872 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10873 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10874 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10875 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10876 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10877 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10878 LvTARG(dstr) = dstr;
10879 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10880 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10882 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10883 LvTYPE(dstr) = LvTYPE(sstr);
10886 if (GvUNIQUE((GV*)sstr)) {
10888 if ((share = gv_share(sstr, param))) {
10891 ptr_table_store(PL_ptr_table, sstr, dstr);
10893 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10894 HvNAME_get(GvSTASH(share)), GvNAME(share));
10899 SvANY(dstr) = new_XPVGV();
10900 SvCUR_set(dstr, SvCUR(sstr));
10901 SvLEN_set(dstr, SvLEN(sstr));
10902 SvIV_set(dstr, SvIVX(sstr));
10903 SvNV_set(dstr, SvNVX(sstr));
10904 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10905 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10906 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10907 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10908 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10909 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10910 GvFLAGS(dstr) = GvFLAGS(sstr);
10911 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10912 (void)GpREFCNT_inc(GvGP(dstr));
10915 SvANY(dstr) = new_XPVIO();
10916 SvCUR_set(dstr, SvCUR(sstr));
10917 SvLEN_set(dstr, SvLEN(sstr));
10918 SvIV_set(dstr, SvIVX(sstr));
10919 SvNV_set(dstr, SvNVX(sstr));
10920 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10921 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10922 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10923 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10924 if (IoOFP(sstr) == IoIFP(sstr))
10925 IoOFP(dstr) = IoIFP(dstr);
10927 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10928 /* PL_rsfp_filters entries have fake IoDIRP() */
10929 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10930 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10932 IoDIRP(dstr) = IoDIRP(sstr);
10933 IoLINES(dstr) = IoLINES(sstr);
10934 IoPAGE(dstr) = IoPAGE(sstr);
10935 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10936 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10937 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10938 /* I have no idea why fake dirp (rsfps)
10939 should be treaded differently but otherwise
10940 we end up with leaks -- sky*/
10941 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10942 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10943 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10945 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10946 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10947 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10949 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10950 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10951 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10952 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10953 IoTYPE(dstr) = IoTYPE(sstr);
10954 IoFLAGS(dstr) = IoFLAGS(sstr);
10957 SvANY(dstr) = new_XPVAV();
10958 SvCUR_set(dstr, SvCUR(sstr));
10959 SvLEN_set(dstr, SvLEN(sstr));
10960 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10961 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10962 if (AvARRAY((AV*)sstr)) {
10963 SV **dst_ary, **src_ary;
10964 SSize_t items = AvFILLp((AV*)sstr) + 1;
10966 src_ary = AvARRAY((AV*)sstr);
10967 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10968 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10969 SvPV_set(dstr, (char*)dst_ary);
10970 AvALLOC((AV*)dstr) = dst_ary;
10971 if (AvREAL((AV*)sstr)) {
10972 while (items-- > 0)
10973 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10976 while (items-- > 0)
10977 *dst_ary++ = sv_dup(*src_ary++, param);
10979 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10980 while (items-- > 0) {
10981 *dst_ary++ = &PL_sv_undef;
10985 SvPV_set(dstr, Nullch);
10986 AvALLOC((AV*)dstr) = (SV**)NULL;
10990 SvANY(dstr) = new_XPVHV();
10991 SvCUR_set(dstr, SvCUR(sstr));
10992 SvLEN_set(dstr, SvLEN(sstr));
10993 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10994 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10995 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10999 if (HvARRAY((HV*)sstr)) {
11001 const bool sharekeys = !!HvSHAREKEYS(sstr);
11002 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11003 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11006 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11007 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
11008 HvARRAY(dstr) = (HE**)darray;
11009 while (i <= sxhv->xhv_max) {
11010 HE *source = HvARRAY(sstr)[i];
11012 = source ? he_dup(source, sharekeys, param) : 0;
11016 struct xpvhv_aux *saux = HvAUX(sstr);
11017 struct xpvhv_aux *daux = HvAUX(dstr);
11018 /* This flag isn't copied. */
11019 /* SvOOK_on(hv) attacks the IV flags. */
11020 SvFLAGS(dstr) |= SVf_OOK;
11022 hvname = saux->xhv_name;
11023 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11025 daux->xhv_riter = saux->xhv_riter;
11026 daux->xhv_eiter = saux->xhv_eiter
11027 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11032 SvPV_set(dstr, Nullch);
11034 /* Record stashes for possible cloning in Perl_clone(). */
11036 av_push(param->stashes, dstr);
11040 SvANY(dstr) = new_XPVFM();
11041 FmLINES(dstr) = FmLINES(sstr);
11045 SvANY(dstr) = new_XPVCV();
11047 SvCUR_set(dstr, SvCUR(sstr));
11048 SvLEN_set(dstr, SvLEN(sstr));
11049 SvIV_set(dstr, SvIVX(sstr));
11050 SvNV_set(dstr, SvNVX(sstr));
11051 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11052 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11053 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11054 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11055 CvSTART(dstr) = CvSTART(sstr);
11057 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11059 CvXSUB(dstr) = CvXSUB(sstr);
11060 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11061 if (CvCONST(sstr)) {
11062 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11063 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11064 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11066 /* don't dup if copying back - CvGV isn't refcounted, so the
11067 * duped GV may never be freed. A bit of a hack! DAPM */
11068 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11069 Nullgv : gv_dup(CvGV(sstr), param) ;
11070 if (param->flags & CLONEf_COPY_STACKS) {
11071 CvDEPTH(dstr) = CvDEPTH(sstr);
11075 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11076 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11078 CvWEAKOUTSIDE(sstr)
11079 ? cv_dup( CvOUTSIDE(sstr), param)
11080 : cv_dup_inc(CvOUTSIDE(sstr), param);
11081 CvFLAGS(dstr) = CvFLAGS(sstr);
11082 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11085 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11089 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11095 /* duplicate a context */
11098 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11100 PERL_CONTEXT *ncxs;
11103 return (PERL_CONTEXT*)NULL;
11105 /* look for it in the table first */
11106 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11110 /* create anew and remember what it is */
11111 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11112 ptr_table_store(PL_ptr_table, cxs, ncxs);
11115 PERL_CONTEXT *cx = &cxs[ix];
11116 PERL_CONTEXT *ncx = &ncxs[ix];
11117 ncx->cx_type = cx->cx_type;
11118 if (CxTYPE(cx) == CXt_SUBST) {
11119 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11122 ncx->blk_oldsp = cx->blk_oldsp;
11123 ncx->blk_oldcop = cx->blk_oldcop;
11124 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11125 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11126 ncx->blk_oldpm = cx->blk_oldpm;
11127 ncx->blk_gimme = cx->blk_gimme;
11128 switch (CxTYPE(cx)) {
11130 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11131 ? cv_dup_inc(cx->blk_sub.cv, param)
11132 : cv_dup(cx->blk_sub.cv,param));
11133 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11134 ? av_dup_inc(cx->blk_sub.argarray, param)
11136 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11137 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11138 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11139 ncx->blk_sub.lval = cx->blk_sub.lval;
11140 ncx->blk_sub.retop = cx->blk_sub.retop;
11143 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11144 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11145 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11146 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11147 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11148 ncx->blk_eval.retop = cx->blk_eval.retop;
11151 ncx->blk_loop.label = cx->blk_loop.label;
11152 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11153 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11154 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11155 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11156 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11157 ? cx->blk_loop.iterdata
11158 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11159 ncx->blk_loop.oldcomppad
11160 = (PAD*)ptr_table_fetch(PL_ptr_table,
11161 cx->blk_loop.oldcomppad);
11162 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11163 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11164 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11165 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11166 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11169 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11170 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11171 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11172 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11173 ncx->blk_sub.retop = cx->blk_sub.retop;
11185 /* duplicate a stack info structure */
11188 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11193 return (PERL_SI*)NULL;
11195 /* look for it in the table first */
11196 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11200 /* create anew and remember what it is */
11201 Newz(56, nsi, 1, PERL_SI);
11202 ptr_table_store(PL_ptr_table, si, nsi);
11204 nsi->si_stack = av_dup_inc(si->si_stack, param);
11205 nsi->si_cxix = si->si_cxix;
11206 nsi->si_cxmax = si->si_cxmax;
11207 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11208 nsi->si_type = si->si_type;
11209 nsi->si_prev = si_dup(si->si_prev, param);
11210 nsi->si_next = si_dup(si->si_next, param);
11211 nsi->si_markoff = si->si_markoff;
11216 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11217 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11218 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11219 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11220 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11221 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11222 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11223 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11224 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11225 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11226 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11227 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11228 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11229 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11232 #define pv_dup_inc(p) SAVEPV(p)
11233 #define pv_dup(p) SAVEPV(p)
11234 #define svp_dup_inc(p,pp) any_dup(p,pp)
11236 /* map any object to the new equivent - either something in the
11237 * ptr table, or something in the interpreter structure
11241 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11246 return (void*)NULL;
11248 /* look for it in the table first */
11249 ret = ptr_table_fetch(PL_ptr_table, v);
11253 /* see if it is part of the interpreter structure */
11254 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11255 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11263 /* duplicate the save stack */
11266 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11268 ANY *ss = proto_perl->Tsavestack;
11269 I32 ix = proto_perl->Tsavestack_ix;
11270 I32 max = proto_perl->Tsavestack_max;
11282 void (*dptr) (void*);
11283 void (*dxptr) (pTHX_ void*);
11285 /* Unions for circumventing strict ANSI C89 casting rules. */
11286 union { void *vptr; void (*dptr)(void*); } u1, u2;
11287 union { void *vptr; void (*dxptr)(pTHX_ void*); } u3, u4;
11289 Newz(54, nss, max, ANY);
11292 I32 i = POPINT(ss,ix);
11293 TOPINT(nss,ix) = i;
11295 case SAVEt_ITEM: /* normal string */
11296 sv = (SV*)POPPTR(ss,ix);
11297 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11298 sv = (SV*)POPPTR(ss,ix);
11299 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11301 case SAVEt_SV: /* scalar reference */
11302 sv = (SV*)POPPTR(ss,ix);
11303 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11304 gv = (GV*)POPPTR(ss,ix);
11305 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11307 case SAVEt_GENERIC_PVREF: /* generic char* */
11308 c = (char*)POPPTR(ss,ix);
11309 TOPPTR(nss,ix) = pv_dup(c);
11310 ptr = POPPTR(ss,ix);
11311 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11313 case SAVEt_SHARED_PVREF: /* char* in shared space */
11314 c = (char*)POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = savesharedpv(c);
11316 ptr = POPPTR(ss,ix);
11317 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11319 case SAVEt_GENERIC_SVREF: /* generic sv */
11320 case SAVEt_SVREF: /* scalar reference */
11321 sv = (SV*)POPPTR(ss,ix);
11322 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11323 ptr = POPPTR(ss,ix);
11324 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11326 case SAVEt_AV: /* array reference */
11327 av = (AV*)POPPTR(ss,ix);
11328 TOPPTR(nss,ix) = av_dup_inc(av, param);
11329 gv = (GV*)POPPTR(ss,ix);
11330 TOPPTR(nss,ix) = gv_dup(gv, param);
11332 case SAVEt_HV: /* hash reference */
11333 hv = (HV*)POPPTR(ss,ix);
11334 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11335 gv = (GV*)POPPTR(ss,ix);
11336 TOPPTR(nss,ix) = gv_dup(gv, param);
11338 case SAVEt_INT: /* int reference */
11339 ptr = POPPTR(ss,ix);
11340 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11341 intval = (int)POPINT(ss,ix);
11342 TOPINT(nss,ix) = intval;
11344 case SAVEt_LONG: /* long reference */
11345 ptr = POPPTR(ss,ix);
11346 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11347 longval = (long)POPLONG(ss,ix);
11348 TOPLONG(nss,ix) = longval;
11350 case SAVEt_I32: /* I32 reference */
11351 case SAVEt_I16: /* I16 reference */
11352 case SAVEt_I8: /* I8 reference */
11353 ptr = POPPTR(ss,ix);
11354 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11356 TOPINT(nss,ix) = i;
11358 case SAVEt_IV: /* IV reference */
11359 ptr = POPPTR(ss,ix);
11360 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11362 TOPIV(nss,ix) = iv;
11364 case SAVEt_SPTR: /* SV* reference */
11365 ptr = POPPTR(ss,ix);
11366 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11367 sv = (SV*)POPPTR(ss,ix);
11368 TOPPTR(nss,ix) = sv_dup(sv, param);
11370 case SAVEt_VPTR: /* random* reference */
11371 ptr = POPPTR(ss,ix);
11372 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11373 ptr = POPPTR(ss,ix);
11374 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11376 case SAVEt_PPTR: /* char* reference */
11377 ptr = POPPTR(ss,ix);
11378 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11379 c = (char*)POPPTR(ss,ix);
11380 TOPPTR(nss,ix) = pv_dup(c);
11382 case SAVEt_HPTR: /* HV* reference */
11383 ptr = POPPTR(ss,ix);
11384 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11385 hv = (HV*)POPPTR(ss,ix);
11386 TOPPTR(nss,ix) = hv_dup(hv, param);
11388 case SAVEt_APTR: /* AV* reference */
11389 ptr = POPPTR(ss,ix);
11390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11391 av = (AV*)POPPTR(ss,ix);
11392 TOPPTR(nss,ix) = av_dup(av, param);
11395 gv = (GV*)POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = gv_dup(gv, param);
11398 case SAVEt_GP: /* scalar reference */
11399 gp = (GP*)POPPTR(ss,ix);
11400 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11401 (void)GpREFCNT_inc(gp);
11402 gv = (GV*)POPPTR(ss,ix);
11403 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11404 c = (char*)POPPTR(ss,ix);
11405 TOPPTR(nss,ix) = pv_dup(c);
11407 TOPIV(nss,ix) = iv;
11409 TOPIV(nss,ix) = iv;
11412 case SAVEt_MORTALIZESV:
11413 sv = (SV*)POPPTR(ss,ix);
11414 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11417 ptr = POPPTR(ss,ix);
11418 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11419 /* these are assumed to be refcounted properly */
11420 switch (((OP*)ptr)->op_type) {
11422 case OP_LEAVESUBLV:
11426 case OP_LEAVEWRITE:
11427 TOPPTR(nss,ix) = ptr;
11432 TOPPTR(nss,ix) = Nullop;
11437 TOPPTR(nss,ix) = Nullop;
11440 c = (char*)POPPTR(ss,ix);
11441 TOPPTR(nss,ix) = pv_dup_inc(c);
11443 case SAVEt_CLEARSV:
11444 longval = POPLONG(ss,ix);
11445 TOPLONG(nss,ix) = longval;
11448 hv = (HV*)POPPTR(ss,ix);
11449 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11450 c = (char*)POPPTR(ss,ix);
11451 TOPPTR(nss,ix) = pv_dup_inc(c);
11453 TOPINT(nss,ix) = i;
11455 case SAVEt_DESTRUCTOR:
11456 ptr = POPPTR(ss,ix);
11457 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11458 dptr = POPDPTR(ss,ix);
11460 u2.vptr = any_dup(u1.vptr, proto_perl);
11461 TOPDPTR(nss,ix) = u2.dptr;
11463 case SAVEt_DESTRUCTOR_X:
11464 ptr = POPPTR(ss,ix);
11465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11466 dxptr = POPDXPTR(ss,ix);
11468 u4.vptr = any_dup(u3.vptr, proto_perl);;
11469 TOPDXPTR(nss,ix) = u4.dxptr;
11471 case SAVEt_REGCONTEXT:
11474 TOPINT(nss,ix) = i;
11477 case SAVEt_STACK_POS: /* Position on Perl stack */
11479 TOPINT(nss,ix) = i;
11481 case SAVEt_AELEM: /* array element */
11482 sv = (SV*)POPPTR(ss,ix);
11483 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11485 TOPINT(nss,ix) = i;
11486 av = (AV*)POPPTR(ss,ix);
11487 TOPPTR(nss,ix) = av_dup_inc(av, param);
11489 case SAVEt_HELEM: /* hash element */
11490 sv = (SV*)POPPTR(ss,ix);
11491 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11492 sv = (SV*)POPPTR(ss,ix);
11493 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11494 hv = (HV*)POPPTR(ss,ix);
11495 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11498 ptr = POPPTR(ss,ix);
11499 TOPPTR(nss,ix) = ptr;
11503 TOPINT(nss,ix) = i;
11505 case SAVEt_COMPPAD:
11506 av = (AV*)POPPTR(ss,ix);
11507 TOPPTR(nss,ix) = av_dup(av, param);
11510 longval = (long)POPLONG(ss,ix);
11511 TOPLONG(nss,ix) = longval;
11512 ptr = POPPTR(ss,ix);
11513 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11514 sv = (SV*)POPPTR(ss,ix);
11515 TOPPTR(nss,ix) = sv_dup(sv, param);
11518 ptr = POPPTR(ss,ix);
11519 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11520 longval = (long)POPBOOL(ss,ix);
11521 TOPBOOL(nss,ix) = (bool)longval;
11523 case SAVEt_SET_SVFLAGS:
11525 TOPINT(nss,ix) = i;
11527 TOPINT(nss,ix) = i;
11528 sv = (SV*)POPPTR(ss,ix);
11529 TOPPTR(nss,ix) = sv_dup(sv, param);
11532 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11540 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11541 * flag to the result. This is done for each stash before cloning starts,
11542 * so we know which stashes want their objects cloned */
11545 do_mark_cloneable_stash(pTHX_ SV *sv)
11547 const HEK *hvname = HvNAME_HEK((HV*)sv);
11549 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11550 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11551 if (cloner && GvCV(cloner)) {
11558 XPUSHs(sv_2mortal(newSVhek(hvname)));
11560 call_sv((SV*)GvCV(cloner), G_SCALAR);
11567 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11575 =for apidoc perl_clone
11577 Create and return a new interpreter by cloning the current one.
11579 perl_clone takes these flags as parameters:
11581 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11582 without it we only clone the data and zero the stacks,
11583 with it we copy the stacks and the new perl interpreter is
11584 ready to run at the exact same point as the previous one.
11585 The pseudo-fork code uses COPY_STACKS while the
11586 threads->new doesn't.
11588 CLONEf_KEEP_PTR_TABLE
11589 perl_clone keeps a ptr_table with the pointer of the old
11590 variable as a key and the new variable as a value,
11591 this allows it to check if something has been cloned and not
11592 clone it again but rather just use the value and increase the
11593 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11594 the ptr_table using the function
11595 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11596 reason to keep it around is if you want to dup some of your own
11597 variable who are outside the graph perl scans, example of this
11598 code is in threads.xs create
11601 This is a win32 thing, it is ignored on unix, it tells perls
11602 win32host code (which is c++) to clone itself, this is needed on
11603 win32 if you want to run two threads at the same time,
11604 if you just want to do some stuff in a separate perl interpreter
11605 and then throw it away and return to the original one,
11606 you don't need to do anything.
11611 /* XXX the above needs expanding by someone who actually understands it ! */
11612 EXTERN_C PerlInterpreter *
11613 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11616 perl_clone(PerlInterpreter *proto_perl, UV flags)
11619 #ifdef PERL_IMPLICIT_SYS
11621 /* perlhost.h so we need to call into it
11622 to clone the host, CPerlHost should have a c interface, sky */
11624 if (flags & CLONEf_CLONE_HOST) {
11625 return perl_clone_host(proto_perl,flags);
11627 return perl_clone_using(proto_perl, flags,
11629 proto_perl->IMemShared,
11630 proto_perl->IMemParse,
11632 proto_perl->IStdIO,
11636 proto_perl->IProc);
11640 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11641 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11642 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11643 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11644 struct IPerlDir* ipD, struct IPerlSock* ipS,
11645 struct IPerlProc* ipP)
11647 /* XXX many of the string copies here can be optimized if they're
11648 * constants; they need to be allocated as common memory and just
11649 * their pointers copied. */
11652 CLONE_PARAMS clone_params;
11653 CLONE_PARAMS* param = &clone_params;
11655 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11656 /* for each stash, determine whether its objects should be cloned */
11657 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11658 PERL_SET_THX(my_perl);
11661 Poison(my_perl, 1, PerlInterpreter);
11663 PL_curcop = (COP *)Nullop;
11667 PL_savestack_ix = 0;
11668 PL_savestack_max = -1;
11669 PL_sig_pending = 0;
11670 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11671 # else /* !DEBUGGING */
11672 Zero(my_perl, 1, PerlInterpreter);
11673 # endif /* DEBUGGING */
11675 /* host pointers */
11677 PL_MemShared = ipMS;
11678 PL_MemParse = ipMP;
11685 #else /* !PERL_IMPLICIT_SYS */
11687 CLONE_PARAMS clone_params;
11688 CLONE_PARAMS* param = &clone_params;
11689 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11690 /* for each stash, determine whether its objects should be cloned */
11691 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11692 PERL_SET_THX(my_perl);
11695 Poison(my_perl, 1, PerlInterpreter);
11697 PL_curcop = (COP *)Nullop;
11701 PL_savestack_ix = 0;
11702 PL_savestack_max = -1;
11703 PL_sig_pending = 0;
11704 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11705 # else /* !DEBUGGING */
11706 Zero(my_perl, 1, PerlInterpreter);
11707 # endif /* DEBUGGING */
11708 #endif /* PERL_IMPLICIT_SYS */
11709 param->flags = flags;
11710 param->proto_perl = proto_perl;
11713 PL_xnv_arenaroot = NULL;
11714 PL_xnv_root = NULL;
11715 PL_xpv_arenaroot = NULL;
11716 PL_xpv_root = NULL;
11717 PL_xpviv_arenaroot = NULL;
11718 PL_xpviv_root = NULL;
11719 PL_xpvnv_arenaroot = NULL;
11720 PL_xpvnv_root = NULL;
11721 PL_xpvcv_arenaroot = NULL;
11722 PL_xpvcv_root = NULL;
11723 PL_xpvav_arenaroot = NULL;
11724 PL_xpvav_root = NULL;
11725 PL_xpvhv_arenaroot = NULL;
11726 PL_xpvhv_root = NULL;
11727 PL_xpvmg_arenaroot = NULL;
11728 PL_xpvmg_root = NULL;
11729 PL_xpvgv_arenaroot = NULL;
11730 PL_xpvgv_root = NULL;
11731 PL_xpvlv_arenaroot = NULL;
11732 PL_xpvlv_root = NULL;
11733 PL_xpvbm_arenaroot = NULL;
11734 PL_xpvbm_root = NULL;
11735 PL_he_arenaroot = NULL;
11737 #if defined(USE_ITHREADS)
11738 PL_pte_arenaroot = NULL;
11739 PL_pte_root = NULL;
11741 PL_nice_chunk = NULL;
11742 PL_nice_chunk_size = 0;
11744 PL_sv_objcount = 0;
11745 PL_sv_root = Nullsv;
11746 PL_sv_arenaroot = Nullsv;
11748 PL_debug = proto_perl->Idebug;
11750 PL_hash_seed = proto_perl->Ihash_seed;
11751 PL_rehash_seed = proto_perl->Irehash_seed;
11753 #ifdef USE_REENTRANT_API
11754 /* XXX: things like -Dm will segfault here in perlio, but doing
11755 * PERL_SET_CONTEXT(proto_perl);
11756 * breaks too many other things
11758 Perl_reentrant_init(aTHX);
11761 /* create SV map for pointer relocation */
11762 PL_ptr_table = ptr_table_new();
11763 /* and one for finding shared hash keys quickly */
11764 PL_shared_hek_table = ptr_table_new();
11766 /* initialize these special pointers as early as possible */
11767 SvANY(&PL_sv_undef) = NULL;
11768 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11769 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11770 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11772 SvANY(&PL_sv_no) = new_XPVNV();
11773 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11774 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11775 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11776 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11777 SvCUR_set(&PL_sv_no, 0);
11778 SvLEN_set(&PL_sv_no, 1);
11779 SvIV_set(&PL_sv_no, 0);
11780 SvNV_set(&PL_sv_no, 0);
11781 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11783 SvANY(&PL_sv_yes) = new_XPVNV();
11784 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11785 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11786 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11787 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11788 SvCUR_set(&PL_sv_yes, 1);
11789 SvLEN_set(&PL_sv_yes, 2);
11790 SvIV_set(&PL_sv_yes, 1);
11791 SvNV_set(&PL_sv_yes, 1);
11792 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11794 /* create (a non-shared!) shared string table */
11795 PL_strtab = newHV();
11796 HvSHAREKEYS_off(PL_strtab);
11797 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11798 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11800 PL_compiling = proto_perl->Icompiling;
11802 /* These two PVs will be free'd special way so must set them same way op.c does */
11803 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11804 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11806 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11807 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11809 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11810 if (!specialWARN(PL_compiling.cop_warnings))
11811 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11812 if (!specialCopIO(PL_compiling.cop_io))
11813 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11814 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11816 /* pseudo environmental stuff */
11817 PL_origargc = proto_perl->Iorigargc;
11818 PL_origargv = proto_perl->Iorigargv;
11820 param->stashes = newAV(); /* Setup array of objects to call clone on */
11822 #ifdef PERLIO_LAYERS
11823 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11824 PerlIO_clone(aTHX_ proto_perl, param);
11827 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11828 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11829 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11830 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11831 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11832 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11835 PL_minus_c = proto_perl->Iminus_c;
11836 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11837 PL_localpatches = proto_perl->Ilocalpatches;
11838 PL_splitstr = proto_perl->Isplitstr;
11839 PL_preprocess = proto_perl->Ipreprocess;
11840 PL_minus_n = proto_perl->Iminus_n;
11841 PL_minus_p = proto_perl->Iminus_p;
11842 PL_minus_l = proto_perl->Iminus_l;
11843 PL_minus_a = proto_perl->Iminus_a;
11844 PL_minus_F = proto_perl->Iminus_F;
11845 PL_doswitches = proto_perl->Idoswitches;
11846 PL_dowarn = proto_perl->Idowarn;
11847 PL_doextract = proto_perl->Idoextract;
11848 PL_sawampersand = proto_perl->Isawampersand;
11849 PL_unsafe = proto_perl->Iunsafe;
11850 PL_inplace = SAVEPV(proto_perl->Iinplace);
11851 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11852 PL_perldb = proto_perl->Iperldb;
11853 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11854 PL_exit_flags = proto_perl->Iexit_flags;
11856 /* magical thingies */
11857 /* XXX time(&PL_basetime) when asked for? */
11858 PL_basetime = proto_perl->Ibasetime;
11859 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11861 PL_maxsysfd = proto_perl->Imaxsysfd;
11862 PL_multiline = proto_perl->Imultiline;
11863 PL_statusvalue = proto_perl->Istatusvalue;
11865 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11867 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11869 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11870 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11871 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11873 /* Clone the regex array */
11874 PL_regex_padav = newAV();
11876 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11877 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11879 av_push(PL_regex_padav,
11880 sv_dup_inc(regexen[0],param));
11881 for(i = 1; i <= len; i++) {
11882 if(SvREPADTMP(regexen[i])) {
11883 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11885 av_push(PL_regex_padav,
11887 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11888 SvIVX(regexen[i])), param)))
11893 PL_regex_pad = AvARRAY(PL_regex_padav);
11895 /* shortcuts to various I/O objects */
11896 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11897 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11898 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11899 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11900 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11901 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11903 /* shortcuts to regexp stuff */
11904 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11906 /* shortcuts to misc objects */
11907 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11909 /* shortcuts to debugging objects */
11910 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11911 PL_DBline = gv_dup(proto_perl->IDBline, param);
11912 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11913 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11914 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11915 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11916 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11917 PL_lineary = av_dup(proto_perl->Ilineary, param);
11918 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11920 /* symbol tables */
11921 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11922 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11923 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11924 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11925 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11927 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11928 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11929 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11930 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11931 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11932 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11934 PL_sub_generation = proto_perl->Isub_generation;
11936 /* funky return mechanisms */
11937 PL_forkprocess = proto_perl->Iforkprocess;
11939 /* subprocess state */
11940 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11942 /* internal state */
11943 PL_tainting = proto_perl->Itainting;
11944 PL_taint_warn = proto_perl->Itaint_warn;
11945 PL_maxo = proto_perl->Imaxo;
11946 if (proto_perl->Iop_mask)
11947 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11949 PL_op_mask = Nullch;
11950 /* PL_asserting = proto_perl->Iasserting; */
11952 /* current interpreter roots */
11953 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11954 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11955 PL_main_start = proto_perl->Imain_start;
11956 PL_eval_root = proto_perl->Ieval_root;
11957 PL_eval_start = proto_perl->Ieval_start;
11959 /* runtime control stuff */
11960 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11961 PL_copline = proto_perl->Icopline;
11963 PL_filemode = proto_perl->Ifilemode;
11964 PL_lastfd = proto_perl->Ilastfd;
11965 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11968 PL_gensym = proto_perl->Igensym;
11969 PL_preambled = proto_perl->Ipreambled;
11970 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11971 PL_laststatval = proto_perl->Ilaststatval;
11972 PL_laststype = proto_perl->Ilaststype;
11973 PL_mess_sv = Nullsv;
11975 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11976 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11978 /* interpreter atexit processing */
11979 PL_exitlistlen = proto_perl->Iexitlistlen;
11980 if (PL_exitlistlen) {
11981 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11982 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11985 PL_exitlist = (PerlExitListEntry*)NULL;
11986 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11987 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11988 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11990 PL_profiledata = NULL;
11991 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11992 /* PL_rsfp_filters entries have fake IoDIRP() */
11993 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11995 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11997 PAD_CLONE_VARS(proto_perl, param);
11999 #ifdef HAVE_INTERP_INTERN
12000 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12003 /* more statics moved here */
12004 PL_generation = proto_perl->Igeneration;
12005 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12007 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12008 PL_in_clean_all = proto_perl->Iin_clean_all;
12010 PL_uid = proto_perl->Iuid;
12011 PL_euid = proto_perl->Ieuid;
12012 PL_gid = proto_perl->Igid;
12013 PL_egid = proto_perl->Iegid;
12014 PL_nomemok = proto_perl->Inomemok;
12015 PL_an = proto_perl->Ian;
12016 PL_evalseq = proto_perl->Ievalseq;
12017 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12018 PL_origalen = proto_perl->Iorigalen;
12019 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12020 PL_osname = SAVEPV(proto_perl->Iosname);
12021 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12022 PL_sighandlerp = proto_perl->Isighandlerp;
12025 PL_runops = proto_perl->Irunops;
12027 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12030 PL_cshlen = proto_perl->Icshlen;
12031 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12034 PL_lex_state = proto_perl->Ilex_state;
12035 PL_lex_defer = proto_perl->Ilex_defer;
12036 PL_lex_expect = proto_perl->Ilex_expect;
12037 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12038 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12039 PL_lex_starts = proto_perl->Ilex_starts;
12040 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12041 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12042 PL_lex_op = proto_perl->Ilex_op;
12043 PL_lex_inpat = proto_perl->Ilex_inpat;
12044 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12045 PL_lex_brackets = proto_perl->Ilex_brackets;
12046 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12047 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12048 PL_lex_casemods = proto_perl->Ilex_casemods;
12049 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12050 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12052 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12053 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12054 PL_nexttoke = proto_perl->Inexttoke;
12056 /* XXX This is probably masking the deeper issue of why
12057 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12058 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12059 * (A little debugging with a watchpoint on it may help.)
12061 if (SvANY(proto_perl->Ilinestr)) {
12062 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12063 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12064 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12065 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12066 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12067 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12068 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12069 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12070 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12073 PL_linestr = NEWSV(65,79);
12074 sv_upgrade(PL_linestr,SVt_PVIV);
12075 sv_setpvn(PL_linestr,"",0);
12076 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12078 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12079 PL_pending_ident = proto_perl->Ipending_ident;
12080 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12082 PL_expect = proto_perl->Iexpect;
12084 PL_multi_start = proto_perl->Imulti_start;
12085 PL_multi_end = proto_perl->Imulti_end;
12086 PL_multi_open = proto_perl->Imulti_open;
12087 PL_multi_close = proto_perl->Imulti_close;
12089 PL_error_count = proto_perl->Ierror_count;
12090 PL_subline = proto_perl->Isubline;
12091 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12093 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12094 if (SvANY(proto_perl->Ilinestr)) {
12095 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12096 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12097 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12098 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12099 PL_last_lop_op = proto_perl->Ilast_lop_op;
12102 PL_last_uni = SvPVX(PL_linestr);
12103 PL_last_lop = SvPVX(PL_linestr);
12104 PL_last_lop_op = 0;
12106 PL_in_my = proto_perl->Iin_my;
12107 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12109 PL_cryptseen = proto_perl->Icryptseen;
12112 PL_hints = proto_perl->Ihints;
12114 PL_amagic_generation = proto_perl->Iamagic_generation;
12116 #ifdef USE_LOCALE_COLLATE
12117 PL_collation_ix = proto_perl->Icollation_ix;
12118 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12119 PL_collation_standard = proto_perl->Icollation_standard;
12120 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12121 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12122 #endif /* USE_LOCALE_COLLATE */
12124 #ifdef USE_LOCALE_NUMERIC
12125 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12126 PL_numeric_standard = proto_perl->Inumeric_standard;
12127 PL_numeric_local = proto_perl->Inumeric_local;
12128 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12129 #endif /* !USE_LOCALE_NUMERIC */
12131 /* utf8 character classes */
12132 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12133 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12134 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12135 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12136 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12137 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12138 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12139 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12140 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12141 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12142 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12143 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12144 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12145 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12146 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12147 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12148 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12149 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12150 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12151 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12153 /* Did the locale setup indicate UTF-8? */
12154 PL_utf8locale = proto_perl->Iutf8locale;
12155 /* Unicode features (see perlrun/-C) */
12156 PL_unicode = proto_perl->Iunicode;
12158 /* Pre-5.8 signals control */
12159 PL_signals = proto_perl->Isignals;
12161 /* times() ticks per second */
12162 PL_clocktick = proto_perl->Iclocktick;
12164 /* Recursion stopper for PerlIO_find_layer */
12165 PL_in_load_module = proto_perl->Iin_load_module;
12167 /* sort() routine */
12168 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12170 /* Not really needed/useful since the reenrant_retint is "volatile",
12171 * but do it for consistency's sake. */
12172 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12174 /* Hooks to shared SVs and locks. */
12175 PL_sharehook = proto_perl->Isharehook;
12176 PL_lockhook = proto_perl->Ilockhook;
12177 PL_unlockhook = proto_perl->Iunlockhook;
12178 PL_threadhook = proto_perl->Ithreadhook;
12180 PL_runops_std = proto_perl->Irunops_std;
12181 PL_runops_dbg = proto_perl->Irunops_dbg;
12183 #ifdef THREADS_HAVE_PIDS
12184 PL_ppid = proto_perl->Ippid;
12188 PL_last_swash_hv = Nullhv; /* reinits on demand */
12189 PL_last_swash_klen = 0;
12190 PL_last_swash_key[0]= '\0';
12191 PL_last_swash_tmps = (U8*)NULL;
12192 PL_last_swash_slen = 0;
12194 PL_glob_index = proto_perl->Iglob_index;
12195 PL_srand_called = proto_perl->Isrand_called;
12196 PL_uudmap['M'] = 0; /* reinits on demand */
12197 PL_bitcount = Nullch; /* reinits on demand */
12199 if (proto_perl->Ipsig_pend) {
12200 Newz(0, PL_psig_pend, SIG_SIZE, int);
12203 PL_psig_pend = (int*)NULL;
12206 if (proto_perl->Ipsig_ptr) {
12207 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12208 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12209 for (i = 1; i < SIG_SIZE; i++) {
12210 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12211 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12215 PL_psig_ptr = (SV**)NULL;
12216 PL_psig_name = (SV**)NULL;
12219 /* thrdvar.h stuff */
12221 if (flags & CLONEf_COPY_STACKS) {
12222 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12223 PL_tmps_ix = proto_perl->Ttmps_ix;
12224 PL_tmps_max = proto_perl->Ttmps_max;
12225 PL_tmps_floor = proto_perl->Ttmps_floor;
12226 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12228 while (i <= PL_tmps_ix) {
12229 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12233 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12234 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12235 Newz(54, PL_markstack, i, I32);
12236 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12237 - proto_perl->Tmarkstack);
12238 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12239 - proto_perl->Tmarkstack);
12240 Copy(proto_perl->Tmarkstack, PL_markstack,
12241 PL_markstack_ptr - PL_markstack + 1, I32);
12243 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12244 * NOTE: unlike the others! */
12245 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12246 PL_scopestack_max = proto_perl->Tscopestack_max;
12247 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12248 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12250 /* NOTE: si_dup() looks at PL_markstack */
12251 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12253 /* PL_curstack = PL_curstackinfo->si_stack; */
12254 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12255 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12257 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12258 PL_stack_base = AvARRAY(PL_curstack);
12259 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12260 - proto_perl->Tstack_base);
12261 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12263 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12264 * NOTE: unlike the others! */
12265 PL_savestack_ix = proto_perl->Tsavestack_ix;
12266 PL_savestack_max = proto_perl->Tsavestack_max;
12267 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12268 PL_savestack = ss_dup(proto_perl, param);
12272 ENTER; /* perl_destruct() wants to LEAVE; */
12275 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12276 PL_top_env = &PL_start_env;
12278 PL_op = proto_perl->Top;
12281 PL_Xpv = (XPV*)NULL;
12282 PL_na = proto_perl->Tna;
12284 PL_statbuf = proto_perl->Tstatbuf;
12285 PL_statcache = proto_perl->Tstatcache;
12286 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12287 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12289 PL_timesbuf = proto_perl->Ttimesbuf;
12292 PL_tainted = proto_perl->Ttainted;
12293 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12294 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12295 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12296 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12297 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12298 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12299 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12300 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12301 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12303 PL_restartop = proto_perl->Trestartop;
12304 PL_in_eval = proto_perl->Tin_eval;
12305 PL_delaymagic = proto_perl->Tdelaymagic;
12306 PL_dirty = proto_perl->Tdirty;
12307 PL_localizing = proto_perl->Tlocalizing;
12309 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12310 PL_hv_fetch_ent_mh = Nullhe;
12311 PL_modcount = proto_perl->Tmodcount;
12312 PL_lastgotoprobe = Nullop;
12313 PL_dumpindent = proto_perl->Tdumpindent;
12315 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12316 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12317 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12318 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12319 PL_sortcxix = proto_perl->Tsortcxix;
12320 PL_efloatbuf = Nullch; /* reinits on demand */
12321 PL_efloatsize = 0; /* reinits on demand */
12325 PL_screamfirst = NULL;
12326 PL_screamnext = NULL;
12327 PL_maxscream = -1; /* reinits on demand */
12328 PL_lastscream = Nullsv;
12330 PL_watchaddr = NULL;
12331 PL_watchok = Nullch;
12333 PL_regdummy = proto_perl->Tregdummy;
12334 PL_regprecomp = Nullch;
12337 PL_colorset = 0; /* reinits PL_colors[] */
12338 /*PL_colors[6] = {0,0,0,0,0,0};*/
12339 PL_reginput = Nullch;
12340 PL_regbol = Nullch;
12341 PL_regeol = Nullch;
12342 PL_regstartp = (I32*)NULL;
12343 PL_regendp = (I32*)NULL;
12344 PL_reglastparen = (U32*)NULL;
12345 PL_reglastcloseparen = (U32*)NULL;
12346 PL_regtill = Nullch;
12347 PL_reg_start_tmp = (char**)NULL;
12348 PL_reg_start_tmpl = 0;
12349 PL_regdata = (struct reg_data*)NULL;
12352 PL_reg_eval_set = 0;
12354 PL_regprogram = (regnode*)NULL;
12356 PL_regcc = (CURCUR*)NULL;
12357 PL_reg_call_cc = (struct re_cc_state*)NULL;
12358 PL_reg_re = (regexp*)NULL;
12359 PL_reg_ganch = Nullch;
12360 PL_reg_sv = Nullsv;
12361 PL_reg_match_utf8 = FALSE;
12362 PL_reg_magic = (MAGIC*)NULL;
12364 PL_reg_oldcurpm = (PMOP*)NULL;
12365 PL_reg_curpm = (PMOP*)NULL;
12366 PL_reg_oldsaved = Nullch;
12367 PL_reg_oldsavedlen = 0;
12368 #ifdef PERL_COPY_ON_WRITE
12371 PL_reg_maxiter = 0;
12372 PL_reg_leftiter = 0;
12373 PL_reg_poscache = Nullch;
12374 PL_reg_poscache_size= 0;
12376 /* RE engine - function pointers */
12377 PL_regcompp = proto_perl->Tregcompp;
12378 PL_regexecp = proto_perl->Tregexecp;
12379 PL_regint_start = proto_perl->Tregint_start;
12380 PL_regint_string = proto_perl->Tregint_string;
12381 PL_regfree = proto_perl->Tregfree;
12383 PL_reginterp_cnt = 0;
12384 PL_reg_starttry = 0;
12386 /* Pluggable optimizer */
12387 PL_peepp = proto_perl->Tpeepp;
12389 PL_stashcache = newHV();
12391 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12392 ptr_table_free(PL_ptr_table);
12393 PL_ptr_table = NULL;
12394 ptr_table_free(PL_shared_hek_table);
12395 PL_shared_hek_table = NULL;
12398 /* Call the ->CLONE method, if it exists, for each of the stashes
12399 identified by sv_dup() above.
12401 while(av_len(param->stashes) != -1) {
12402 HV* stash = (HV*) av_shift(param->stashes);
12403 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12404 if (cloner && GvCV(cloner)) {
12409 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12411 call_sv((SV*)GvCV(cloner), G_DISCARD);
12417 SvREFCNT_dec(param->stashes);
12419 /* orphaned? eg threads->new inside BEGIN or use */
12420 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12421 (void)SvREFCNT_inc(PL_compcv);
12422 SAVEFREESV(PL_compcv);
12428 #endif /* USE_ITHREADS */
12431 =head1 Unicode Support
12433 =for apidoc sv_recode_to_utf8
12435 The encoding is assumed to be an Encode object, on entry the PV
12436 of the sv is assumed to be octets in that encoding, and the sv
12437 will be converted into Unicode (and UTF-8).
12439 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12440 is not a reference, nothing is done to the sv. If the encoding is not
12441 an C<Encode::XS> Encoding object, bad things will happen.
12442 (See F<lib/encoding.pm> and L<Encode>).
12444 The PV of the sv is returned.
12449 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12452 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12466 Passing sv_yes is wrong - it needs to be or'ed set of constants
12467 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12468 remove converted chars from source.
12470 Both will default the value - let them.
12472 XPUSHs(&PL_sv_yes);
12475 call_method("decode", G_SCALAR);
12479 s = SvPV(uni, len);
12480 if (s != SvPVX_const(sv)) {
12481 SvGROW(sv, len + 1);
12482 Move(s, SvPVX_const(sv), len, char);
12483 SvCUR_set(sv, len);
12484 SvPVX(sv)[len] = 0;
12491 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12495 =for apidoc sv_cat_decode
12497 The encoding is assumed to be an Encode object, the PV of the ssv is
12498 assumed to be octets in that encoding and decoding the input starts
12499 from the position which (PV + *offset) pointed to. The dsv will be
12500 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12501 when the string tstr appears in decoding output or the input ends on
12502 the PV of the ssv. The value which the offset points will be modified
12503 to the last input position on the ssv.
12505 Returns TRUE if the terminator was found, else returns FALSE.
12510 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12511 SV *ssv, int *offset, char *tstr, int tlen)
12515 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12526 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12527 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12529 call_method("cat_decode", G_SCALAR);
12531 ret = SvTRUE(TOPs);
12532 *offset = SvIV(offsv);
12538 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12544 * c-indentation-style: bsd
12545 * c-basic-offset: 4
12546 * indent-tabs-mode: t
12549 * ex: set ts=8 sts=4 sw=4 noet: