3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 * nice_chunk and nice_chunk size need to be set
170 * and queried under the protection of sv_mutex
173 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
178 new_chunk = (void *)(chunk);
179 new_chunk_size = (chunk_size);
180 if (new_chunk_size > PL_nice_chunk_size) {
181 Safefree(PL_nice_chunk);
182 PL_nice_chunk = (char *) new_chunk;
183 PL_nice_chunk_size = new_chunk_size;
190 #ifdef DEBUG_LEAKING_SCALARS
191 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
193 # define FREE_SV_DEBUG_FILE(sv)
196 #define plant_SV(p) \
198 FREE_SV_DEBUG_FILE(p); \
199 SvANY(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 /* sv_mutex must be held while calling uproot_SV() */
206 #define uproot_SV(p) \
209 PL_sv_root = (SV*)SvANY(p); \
214 /* make some more SVs by adding another arena */
216 /* sv_mutex must be held while calling more_sv() */
223 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
224 PL_nice_chunk = Nullch;
225 PL_nice_chunk_size = 0;
228 char *chunk; /* must use New here to match call to */
229 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
230 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
236 /* new_SV(): return a new, empty SV head */
238 #ifdef DEBUG_LEAKING_SCALARS
239 /* provide a real function for a debugger to play with */
249 sv = S_more_sv(aTHX);
254 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
255 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
256 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
257 sv->sv_debug_inpad = 0;
258 sv->sv_debug_cloned = 0;
259 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
263 # define new_SV(p) (p)=S_new_SV(aTHX)
272 (p) = S_more_sv(aTHX); \
281 /* del_SV(): return an empty SV head to the free list */
296 S_del_sv(pTHX_ SV *p)
301 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
302 const SV * const sv = sva + 1;
303 const SV * const svend = &sva[SvREFCNT(sva)];
304 if (p >= sv && p < svend) {
310 if (ckWARN_d(WARN_INTERNAL))
311 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
312 "Attempt to free non-arena SV: 0x%"UVxf
313 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
320 #else /* ! DEBUGGING */
322 #define del_SV(p) plant_SV(p)
324 #endif /* DEBUGGING */
328 =head1 SV Manipulation Functions
330 =for apidoc sv_add_arena
332 Given a chunk of memory, link it to the head of the list of arenas,
333 and split it into a list of free SVs.
339 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
345 /* The first SV in an arena isn't an SV. */
346 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
347 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
348 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
350 PL_sv_arenaroot = sva;
351 PL_sv_root = sva + 1;
353 svend = &sva[SvREFCNT(sva) - 1];
356 SvANY(sv) = (void *)(SV*)(sv + 1);
360 /* Must always set typemask because it's awlays checked in on cleanup
361 when the arenas are walked looking for objects. */
362 SvFLAGS(sv) = SVTYPEMASK;
369 SvFLAGS(sv) = SVTYPEMASK;
372 /* visit(): call the named function for each non-free SV in the arenas
373 * whose flags field matches the flags/mask args. */
376 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
381 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
382 register const SV * const svend = &sva[SvREFCNT(sva)];
384 for (sv = sva + 1; sv < svend; ++sv) {
385 if (SvTYPE(sv) != SVTYPEMASK
386 && (sv->sv_flags & mask) == flags
399 /* called by sv_report_used() for each live SV */
402 do_report_used(pTHX_ SV *sv)
404 if (SvTYPE(sv) != SVTYPEMASK) {
405 PerlIO_printf(Perl_debug_log, "****\n");
412 =for apidoc sv_report_used
414 Dump the contents of all SVs not yet freed. (Debugging aid).
420 Perl_sv_report_used(pTHX)
423 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
433 SV * const target = SvRV(ref);
434 if (SvOBJECT(target)) {
435 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
436 if (SvWEAKREF(ref)) {
437 sv_del_backref(target, ref);
443 SvREFCNT_dec(target);
448 /* XXX Might want to check arrays, etc. */
451 /* called by sv_clean_objs() for each live SV */
453 #ifndef DISABLE_DESTRUCTOR_KLUDGE
455 do_clean_named_objs(pTHX_ SV *sv)
457 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
459 #ifdef PERL_DONT_CREATE_GVSV
462 SvOBJECT(GvSV(sv))) ||
463 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
464 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
465 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
466 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
468 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
469 SvFLAGS(sv) |= SVf_BREAK;
477 =for apidoc sv_clean_objs
479 Attempt to destroy all objects not yet freed
485 Perl_sv_clean_objs(pTHX)
487 PL_in_clean_objs = TRUE;
488 visit(do_clean_objs, SVf_ROK, SVf_ROK);
489 #ifndef DISABLE_DESTRUCTOR_KLUDGE
490 /* some barnacles may yet remain, clinging to typeglobs */
491 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
493 PL_in_clean_objs = FALSE;
496 /* called by sv_clean_all() for each live SV */
499 do_clean_all(pTHX_ SV *sv)
501 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
502 SvFLAGS(sv) |= SVf_BREAK;
503 if (PL_comppad == (AV*)sv) {
505 PL_curpad = Null(SV**);
511 =for apidoc sv_clean_all
513 Decrement the refcnt of each remaining SV, possibly triggering a
514 cleanup. This function may have to be called multiple times to free
515 SVs which are in complex self-referential hierarchies.
521 Perl_sv_clean_all(pTHX)
524 PL_in_clean_all = TRUE;
525 cleaned = visit(do_clean_all, 0,0);
526 PL_in_clean_all = FALSE;
531 S_free_arena(pTHX_ void **root) {
533 void ** const next = *(void **)root;
540 =for apidoc sv_free_arenas
542 Deallocate the memory used by all arenas. Note that all the individual SV
543 heads and bodies within the arenas must already have been freed.
548 #define free_arena(name) \
550 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
551 PL_ ## name ## _arenaroot = 0; \
552 PL_ ## name ## _root = 0; \
556 Perl_sv_free_arenas(pTHX)
561 /* Free arenas here, but be careful about fake ones. (We assume
562 contiguity of the fake ones with the corresponding real ones.) */
564 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
565 svanext = (SV*) SvANY(sva);
566 while (svanext && SvFAKE(svanext))
567 svanext = (SV*) SvANY(svanext);
585 #if defined(USE_ITHREADS)
589 Safefree(PL_nice_chunk);
590 PL_nice_chunk = Nullch;
591 PL_nice_chunk_size = 0;
596 /* ---------------------------------------------------------------------
598 * support functions for report_uninit()
601 /* the maxiumum size of array or hash where we will scan looking
602 * for the undefined element that triggered the warning */
604 #define FUV_MAX_SEARCH_SIZE 1000
606 /* Look for an entry in the hash whose value has the same SV as val;
607 * If so, return a mortal copy of the key. */
610 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
616 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
617 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
622 for (i=HvMAX(hv); i>0; i--) {
624 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
625 if (HeVAL(entry) != val)
627 if ( HeVAL(entry) == &PL_sv_undef ||
628 HeVAL(entry) == &PL_sv_placeholder)
632 if (HeKLEN(entry) == HEf_SVKEY)
633 return sv_mortalcopy(HeKEY_sv(entry));
634 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
640 /* Look for an entry in the array whose value has the same SV as val;
641 * If so, return the index, otherwise return -1. */
644 S_find_array_subscript(pTHX_ AV *av, SV* val)
648 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
649 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
653 for (i=AvFILLp(av); i>=0; i--) {
654 if (svp[i] == val && svp[i] != &PL_sv_undef)
660 /* S_varname(): return the name of a variable, optionally with a subscript.
661 * If gv is non-zero, use the name of that global, along with gvtype (one
662 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
663 * targ. Depending on the value of the subscript_type flag, return:
666 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
667 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
668 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
669 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
672 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
673 SV* keyname, I32 aindex, int subscript_type)
676 SV * const name = sv_newmortal();
679 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
680 * XXX get rid of all this if gv_fullnameX() ever supports this
684 HV * const hv = GvSTASH(gv);
687 else if (!(p=HvNAME_get(hv)))
689 if (strEQ(p, "main"))
690 sv_setpvn(name, &gvtype, 1);
692 Perl_sv_setpvf(aTHX_ name, "%c%s::", gvtype, p);
694 if (GvNAMELEN(gv)>= 1 &&
695 ((unsigned int)*GvNAME(gv)) <= 26)
697 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
698 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
701 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
705 CV * const cv = find_runcv(&unused);
709 if (!cv || !CvPADLIST(cv))
711 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
712 sv = *av_fetch(av, targ, FALSE);
713 /* SvLEN in a pad name is not to be trusted */
714 sv_setpv(name, SvPV_nolen_const(sv));
717 if (subscript_type == FUV_SUBSCRIPT_HASH) {
718 SV * const sv = NEWSV(0,0);
720 Perl_sv_catpvf(aTHX_ name, "{%s}",
721 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
724 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
726 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
728 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
729 sv_insert(name, 0, 0, "within ", 7);
736 =for apidoc find_uninit_var
738 Find the name of the undefined variable (if any) that caused the operator o
739 to issue a "Use of uninitialized value" warning.
740 If match is true, only return a name if it's value matches uninit_sv.
741 So roughly speaking, if a unary operator (such as OP_COS) generates a
742 warning, then following the direct child of the op may yield an
743 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
744 other hand, with OP_ADD there are two branches to follow, so we only print
745 the variable name if we get an exact match.
747 The name is returned as a mortal SV.
749 Assumes that PL_op is the op that originally triggered the error, and that
750 PL_comppad/PL_curpad points to the currently executing pad.
756 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
764 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
765 uninit_sv == &PL_sv_placeholder)))
768 switch (obase->op_type) {
775 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
776 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
779 int subscript_type = FUV_SUBSCRIPT_WITHIN;
781 if (pad) { /* @lex, %lex */
782 sv = PAD_SVl(obase->op_targ);
786 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
787 /* @global, %global */
788 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
791 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
793 else /* @{expr}, %{expr} */
794 return find_uninit_var(cUNOPx(obase)->op_first,
798 /* attempt to find a match within the aggregate */
800 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
802 subscript_type = FUV_SUBSCRIPT_HASH;
805 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
807 subscript_type = FUV_SUBSCRIPT_ARRAY;
810 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
813 return varname(gv, hash ? '%' : '@', obase->op_targ,
814 keysv, index, subscript_type);
818 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
820 return varname(Nullgv, '$', obase->op_targ,
821 Nullsv, 0, FUV_SUBSCRIPT_NONE);
824 gv = cGVOPx_gv(obase);
825 if (!gv || (match && GvSV(gv) != uninit_sv))
827 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
830 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
833 av = (AV*)PAD_SV(obase->op_targ);
834 if (!av || SvRMAGICAL(av))
836 svp = av_fetch(av, (I32)obase->op_private, FALSE);
837 if (!svp || *svp != uninit_sv)
840 return varname(Nullgv, '$', obase->op_targ,
841 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
844 gv = cGVOPx_gv(obase);
850 if (!av || SvRMAGICAL(av))
852 svp = av_fetch(av, (I32)obase->op_private, FALSE);
853 if (!svp || *svp != uninit_sv)
856 return varname(gv, '$', 0,
857 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
862 o = cUNOPx(obase)->op_first;
863 if (!o || o->op_type != OP_NULL ||
864 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
866 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
871 /* $a[uninit_expr] or $h{uninit_expr} */
872 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
875 o = cBINOPx(obase)->op_first;
876 kid = cBINOPx(obase)->op_last;
878 /* get the av or hv, and optionally the gv */
880 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
881 sv = PAD_SV(o->op_targ);
883 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
884 && cUNOPo->op_first->op_type == OP_GV)
886 gv = cGVOPx_gv(cUNOPo->op_first);
889 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
894 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
895 /* index is constant */
899 if (obase->op_type == OP_HELEM) {
900 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
901 if (!he || HeVAL(he) != uninit_sv)
905 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
906 if (!svp || *svp != uninit_sv)
910 if (obase->op_type == OP_HELEM)
911 return varname(gv, '%', o->op_targ,
912 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
914 return varname(gv, '@', o->op_targ, Nullsv,
915 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
919 /* index is an expression;
920 * attempt to find a match within the aggregate */
921 if (obase->op_type == OP_HELEM) {
922 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
924 return varname(gv, '%', o->op_targ,
925 keysv, 0, FUV_SUBSCRIPT_HASH);
928 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
930 return varname(gv, '@', o->op_targ,
931 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
936 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
938 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
944 /* only examine RHS */
945 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
948 o = cUNOPx(obase)->op_first;
949 if (o->op_type == OP_PUSHMARK)
952 if (!o->op_sibling) {
953 /* one-arg version of open is highly magical */
955 if (o->op_type == OP_GV) { /* open FOO; */
957 if (match && GvSV(gv) != uninit_sv)
959 return varname(gv, '$', 0,
960 Nullsv, 0, FUV_SUBSCRIPT_NONE);
962 /* other possibilities not handled are:
963 * open $x; or open my $x; should return '${*$x}'
964 * open expr; should return '$'.expr ideally
970 /* ops where $_ may be an implicit arg */
974 if ( !(obase->op_flags & OPf_STACKED)) {
975 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
976 ? PAD_SVl(obase->op_targ)
980 sv_setpvn(sv, "$_", 2);
988 /* skip filehandle as it can't produce 'undef' warning */
989 o = cUNOPx(obase)->op_first;
990 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
991 o = o->op_sibling->op_sibling;
998 match = 1; /* XS or custom code could trigger random warnings */
1003 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1004 return sv_2mortal(newSVpvn("${$/}", 5));
1009 if (!(obase->op_flags & OPf_KIDS))
1011 o = cUNOPx(obase)->op_first;
1017 /* if all except one arg are constant, or have no side-effects,
1018 * or are optimized away, then it's unambiguous */
1020 for (kid=o; kid; kid = kid->op_sibling) {
1022 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1023 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1024 || (kid->op_type == OP_PUSHMARK)
1028 if (o2) { /* more than one found */
1035 return find_uninit_var(o2, uninit_sv, match);
1039 sv = find_uninit_var(o, uninit_sv, 1);
1051 =for apidoc report_uninit
1053 Print appropriate "Use of uninitialized variable" warning
1059 Perl_report_uninit(pTHX_ SV* uninit_sv)
1062 SV* varname = Nullsv;
1064 varname = find_uninit_var(PL_op, uninit_sv,0);
1066 sv_insert(varname, 0, 0, " ", 1);
1068 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1069 varname ? SvPV_nolen_const(varname) : "",
1070 " in ", OP_DESC(PL_op));
1073 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1078 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1082 const size_t count = PERL_ARENA_SIZE/size;
1083 Newx(start, count*size, char);
1084 *((void **) start) = *arena_root;
1085 *arena_root = (void *)start;
1087 end = start + (count-1) * size;
1089 /* The initial slot is used to link the arenas together, so it isn't to be
1090 linked into the list of ready-to-use bodies. */
1094 *root = (void *)start;
1096 while (start < end) {
1097 char * const next = start + size;
1098 *(void**) start = (void *)next;
1101 *(void **)start = 0;
1106 /* grab a new thing from the free list, allocating more if necessary */
1108 /* 1st, the inline version */
1110 #define new_body_inline(xpv, arena_root, root, size) \
1113 xpv = *((void **)(root)) \
1114 ? *((void **)(root)) : S_more_bodies(aTHX_ arena_root, root, size); \
1115 *(root) = *(void**)(xpv); \
1119 /* now use the inline version in the proper function */
1122 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1125 new_body_inline(xpv, arena_root, root, size);
1129 /* return a thing to the free list */
1131 #define del_body(thing, root) \
1133 void **thing_copy = (void **)thing; \
1135 *thing_copy = *root; \
1136 *root = (void*)thing_copy; \
1140 /* Conventionally we simply malloc() a big block of memory, then divide it
1141 up into lots of the thing that we're allocating.
1143 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1146 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1147 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1150 #define new_body_type(TYPE,lctype) \
1151 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1152 (void**)&PL_ ## lctype ## _root, \
1155 #define del_body_type(p,TYPE,lctype) \
1156 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1158 /* But for some types, we cheat. The type starts with some members that are
1159 never accessed. So we allocate the substructure, starting at the first used
1160 member, then adjust the pointer back in memory by the size of the bit not
1161 allocated, so it's as if we allocated the full structure.
1162 (But things will all go boom if you write to the part that is "not there",
1163 because you'll be overwriting the last members of the preceding structure
1166 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1167 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1168 and the pointer is unchanged. If the allocated structure is smaller (no
1169 initial NV actually allocated) then the net effect is to subtract the size
1170 of the NV from the pointer, to return a new pointer as if an initial NV were
1173 This is the same trick as was used for NV and IV bodies. Ironically it
1174 doesn't need to be used for NV bodies any more, because NV is now at the
1175 start of the structure. IV bodies don't need it either, because they are
1176 no longer allocated. */
1178 #define new_body_allocated(TYPE,lctype,member) \
1179 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1180 (void**)&PL_ ## lctype ## _root, \
1181 sizeof(lctype ## _allocated)) - \
1182 STRUCT_OFFSET(TYPE, member) \
1183 + STRUCT_OFFSET(lctype ## _allocated, member))
1186 #define del_body_allocated(p,TYPE,lctype,member) \
1187 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1188 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1189 (void**)&PL_ ## lctype ## _root)
1191 #define my_safemalloc(s) (void*)safemalloc(s)
1192 #define my_safefree(p) safefree((char*)p)
1196 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1197 #define del_XNV(p) my_safefree(p)
1199 #define new_XPV() my_safemalloc(sizeof(XPV))
1200 #define del_XPV(p) my_safefree(p)
1202 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1203 #define del_XPVIV(p) my_safefree(p)
1205 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1206 #define del_XPVNV(p) my_safefree(p)
1208 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1209 #define del_XPVCV(p) my_safefree(p)
1211 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1212 #define del_XPVAV(p) my_safefree(p)
1214 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1215 #define del_XPVHV(p) my_safefree(p)
1217 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1218 #define del_XPVMG(p) my_safefree(p)
1220 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1221 #define del_XPVGV(p) my_safefree(p)
1223 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1224 #define del_XPVLV(p) my_safefree(p)
1226 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1227 #define del_XPVBM(p) my_safefree(p)
1231 #define new_XNV() new_body_type(NV, xnv)
1232 #define del_XNV(p) del_body_type(p, NV, xnv)
1234 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1235 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1237 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1238 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1240 #define new_XPVNV() new_body_type(XPVNV, xpvnv)
1241 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1243 #define new_XPVCV() new_body_type(XPVCV, xpvcv)
1244 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1246 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1247 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1249 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1250 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1252 #define new_XPVMG() new_body_type(XPVMG, xpvmg)
1253 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1255 #define new_XPVGV() new_body_type(XPVGV, xpvgv)
1256 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1258 #define new_XPVLV() new_body_type(XPVLV, xpvlv)
1259 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1261 #define new_XPVBM() new_body_type(XPVBM, xpvbm)
1262 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1266 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1267 #define del_XPVFM(p) my_safefree(p)
1269 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1270 #define del_XPVIO(p) my_safefree(p)
1273 =for apidoc sv_upgrade
1275 Upgrade an SV to a more complex form. Generally adds a new body type to the
1276 SV, then copies across as much information as possible from the old body.
1277 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1283 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1285 void** old_body_arena;
1286 size_t old_body_offset;
1287 size_t old_body_length; /* Well, the length to copy. */
1289 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1290 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1292 bool zero_nv = TRUE;
1295 size_t new_body_length;
1296 size_t new_body_offset;
1297 void** new_body_arena;
1298 void** new_body_arenaroot;
1299 const U32 old_type = SvTYPE(sv);
1301 if (mt != SVt_PV && SvIsCOW(sv)) {
1302 sv_force_normal_flags(sv, 0);
1305 if (SvTYPE(sv) == mt)
1308 if (SvTYPE(sv) > mt)
1309 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1310 (int)SvTYPE(sv), (int)mt);
1313 old_body = SvANY(sv);
1315 old_body_offset = 0;
1316 old_body_length = 0;
1317 new_body_offset = 0;
1318 new_body_length = ~0;
1320 /* Copying structures onto other structures that have been neatly zeroed
1321 has a subtle gotcha. Consider XPVMG
1323 +------+------+------+------+------+-------+-------+
1324 | NV | CUR | LEN | IV | MAGIC | STASH |
1325 +------+------+------+------+------+-------+-------+
1326 0 4 8 12 16 20 24 28
1328 where NVs are aligned to 8 bytes, so that sizeof that structure is
1329 actually 32 bytes long, with 4 bytes of padding at the end:
1331 +------+------+------+------+------+-------+-------+------+
1332 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1333 +------+------+------+------+------+-------+-------+------+
1334 0 4 8 12 16 20 24 28 32
1336 so what happens if you allocate memory for this structure:
1338 +------+------+------+------+------+-------+-------+------+------+...
1339 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1340 +------+------+------+------+------+-------+-------+------+------+...
1341 0 4 8 12 16 20 24 28 32 36
1343 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1344 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1345 started out as zero once, but it's quite possible that it isn't. So now,
1346 rather than a nicely zeroed GP, you have it pointing somewhere random.
1349 (In fact, GP ends up pointing at a previous GP structure, because the
1350 principle cause of the padding in XPVMG getting garbage is a copy of
1351 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1353 So we are careful and work out the size of used parts of all the
1356 switch (SvTYPE(sv)) {
1362 else if (mt < SVt_PVIV)
1364 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1365 old_body_length = sizeof(IV);
1368 old_body_arena = (void **) &PL_xnv_root;
1369 old_body_length = sizeof(NV);
1370 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1379 old_body_arena = (void **) &PL_xpv_root;
1380 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1381 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1382 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1383 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1387 else if (mt == SVt_NV)
1391 old_body_arena = (void **) &PL_xpviv_root;
1392 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1393 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1394 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1395 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1399 old_body_arena = (void **) &PL_xpvnv_root;
1400 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1401 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1402 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1407 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1408 there's no way that it can be safely upgraded, because perl.c
1409 expects to Safefree(SvANY(PL_mess_sv)) */
1410 assert(sv != PL_mess_sv);
1411 /* This flag bit is used to mean other things in other scalar types.
1412 Given that it only has meaning inside the pad, it shouldn't be set
1413 on anything that can get upgraded. */
1414 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1415 old_body_arena = (void **) &PL_xpvmg_root;
1416 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1417 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1418 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1423 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1426 SvFLAGS(sv) &= ~SVTYPEMASK;
1431 Perl_croak(aTHX_ "Can't upgrade to undef");
1433 assert(old_type == SVt_NULL);
1434 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1438 assert(old_type == SVt_NULL);
1439 SvANY(sv) = new_XNV();
1443 assert(old_type == SVt_NULL);
1444 SvANY(sv) = &sv->sv_u.svu_rv;
1448 SvANY(sv) = new_XPVHV();
1451 HvTOTALKEYS(sv) = 0;
1456 SvANY(sv) = new_XPVAV();
1463 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1464 The target created by newSVrv also is, and it can have magic.
1465 However, it never has SvPVX set.
1467 if (old_type >= SVt_RV) {
1468 assert(SvPVX_const(sv) == 0);
1471 /* Could put this in the else clause below, as PVMG must have SvPVX
1472 0 already (the assertion above) */
1473 SvPV_set(sv, (char*)0);
1475 if (old_type >= SVt_PVMG) {
1476 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1477 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1485 new_body = new_XPVIO();
1486 new_body_length = sizeof(XPVIO);
1489 new_body = new_XPVFM();
1490 new_body_length = sizeof(XPVFM);
1494 new_body_length = sizeof(XPVBM);
1495 new_body_arena = (void **) &PL_xpvbm_root;
1496 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1499 new_body_length = sizeof(XPVGV);
1500 new_body_arena = (void **) &PL_xpvgv_root;
1501 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1504 new_body_length = sizeof(XPVCV);
1505 new_body_arena = (void **) &PL_xpvcv_root;
1506 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1509 new_body_length = sizeof(XPVLV);
1510 new_body_arena = (void **) &PL_xpvlv_root;
1511 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1514 new_body_length = sizeof(XPVMG);
1515 new_body_arena = (void **) &PL_xpvmg_root;
1516 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1519 new_body_length = sizeof(XPVNV);
1520 new_body_arena = (void **) &PL_xpvnv_root;
1521 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1524 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1525 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1526 new_body_length = sizeof(XPVIV) - new_body_offset;
1527 new_body_arena = (void **) &PL_xpviv_root;
1528 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1529 /* XXX Is this still needed? Was it ever needed? Surely as there is
1530 no route from NV to PVIV, NOK can never be true */
1534 goto new_body_no_NV;
1536 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1537 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1538 new_body_length = sizeof(XPV) - new_body_offset;
1539 new_body_arena = (void **) &PL_xpv_root;
1540 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1542 /* PV and PVIV don't have an NV slot. */
1543 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1548 assert(new_body_length);
1550 /* This points to the start of the allocated area. */
1551 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
1554 /* We always allocated the full length item with PURIFY */
1555 new_body_length += new_body_offset;
1556 new_body_offset = 0;
1557 new_body = my_safemalloc(new_body_length);
1561 Zero(new_body, new_body_length, char);
1562 new_body = ((char *)new_body) - new_body_offset;
1563 SvANY(sv) = new_body;
1565 if (old_body_length) {
1566 Copy((char *)old_body + old_body_offset,
1567 (char *)new_body + old_body_offset,
1568 old_body_length, char);
1571 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1577 IoPAGE_LEN(sv) = 60;
1578 if (old_type < SVt_RV)
1582 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1586 if (old_body_arena) {
1588 my_safefree(old_body);
1590 del_body((void*)((char*)old_body + old_body_offset),
1597 =for apidoc sv_backoff
1599 Remove any string offset. You should normally use the C<SvOOK_off> macro
1606 Perl_sv_backoff(pTHX_ register SV *sv)
1609 assert(SvTYPE(sv) != SVt_PVHV);
1610 assert(SvTYPE(sv) != SVt_PVAV);
1612 const char * const s = SvPVX_const(sv);
1613 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1614 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1616 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1618 SvFLAGS(sv) &= ~SVf_OOK;
1625 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1626 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1627 Use the C<SvGROW> wrapper instead.
1633 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1637 #ifdef HAS_64K_LIMIT
1638 if (newlen >= 0x10000) {
1639 PerlIO_printf(Perl_debug_log,
1640 "Allocation too large: %"UVxf"\n", (UV)newlen);
1643 #endif /* HAS_64K_LIMIT */
1646 if (SvTYPE(sv) < SVt_PV) {
1647 sv_upgrade(sv, SVt_PV);
1648 s = SvPVX_mutable(sv);
1650 else if (SvOOK(sv)) { /* pv is offset? */
1652 s = SvPVX_mutable(sv);
1653 if (newlen > SvLEN(sv))
1654 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1655 #ifdef HAS_64K_LIMIT
1656 if (newlen >= 0x10000)
1661 s = SvPVX_mutable(sv);
1663 if (newlen > SvLEN(sv)) { /* need more room? */
1664 newlen = PERL_STRLEN_ROUNDUP(newlen);
1665 if (SvLEN(sv) && s) {
1667 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1673 s = saferealloc(s, newlen);
1676 s = safemalloc(newlen);
1677 if (SvPVX_const(sv) && SvCUR(sv)) {
1678 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1682 SvLEN_set(sv, newlen);
1688 =for apidoc sv_setiv
1690 Copies an integer into the given SV, upgrading first if necessary.
1691 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1697 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1699 SV_CHECK_THINKFIRST_COW_DROP(sv);
1700 switch (SvTYPE(sv)) {
1702 sv_upgrade(sv, SVt_IV);
1705 sv_upgrade(sv, SVt_PVNV);
1709 sv_upgrade(sv, SVt_PVIV);
1718 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1721 (void)SvIOK_only(sv); /* validate number */
1727 =for apidoc sv_setiv_mg
1729 Like C<sv_setiv>, but also handles 'set' magic.
1735 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1742 =for apidoc sv_setuv
1744 Copies an unsigned integer into the given SV, upgrading first if necessary.
1745 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1751 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1753 /* With these two if statements:
1754 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1757 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1759 If you wish to remove them, please benchmark to see what the effect is
1761 if (u <= (UV)IV_MAX) {
1762 sv_setiv(sv, (IV)u);
1771 =for apidoc sv_setuv_mg
1773 Like C<sv_setuv>, but also handles 'set' magic.
1779 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1788 =for apidoc sv_setnv
1790 Copies a double into the given SV, upgrading first if necessary.
1791 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1797 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1799 SV_CHECK_THINKFIRST_COW_DROP(sv);
1800 switch (SvTYPE(sv)) {
1803 sv_upgrade(sv, SVt_NV);
1808 sv_upgrade(sv, SVt_PVNV);
1817 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1821 (void)SvNOK_only(sv); /* validate number */
1826 =for apidoc sv_setnv_mg
1828 Like C<sv_setnv>, but also handles 'set' magic.
1834 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1840 /* Print an "isn't numeric" warning, using a cleaned-up,
1841 * printable version of the offending string
1845 S_not_a_number(pTHX_ SV *sv)
1852 dsv = sv_2mortal(newSVpvn("", 0));
1853 pv = sv_uni_display(dsv, sv, 10, 0);
1856 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1857 /* each *s can expand to 4 chars + "...\0",
1858 i.e. need room for 8 chars */
1860 const char *s, *end;
1861 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1864 if (ch & 128 && !isPRINT_LC(ch)) {
1873 else if (ch == '\r') {
1877 else if (ch == '\f') {
1881 else if (ch == '\\') {
1885 else if (ch == '\0') {
1889 else if (isPRINT_LC(ch))
1906 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1907 "Argument \"%s\" isn't numeric in %s", pv,
1910 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1911 "Argument \"%s\" isn't numeric", pv);
1915 =for apidoc looks_like_number
1917 Test if the content of an SV looks like a number (or is a number).
1918 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1919 non-numeric warning), even if your atof() doesn't grok them.
1925 Perl_looks_like_number(pTHX_ SV *sv)
1927 register const char *sbegin;
1931 sbegin = SvPVX_const(sv);
1934 else if (SvPOKp(sv))
1935 sbegin = SvPV_const(sv, len);
1937 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1938 return grok_number(sbegin, len, NULL);
1941 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1942 until proven guilty, assume that things are not that bad... */
1947 As 64 bit platforms often have an NV that doesn't preserve all bits of
1948 an IV (an assumption perl has been based on to date) it becomes necessary
1949 to remove the assumption that the NV always carries enough precision to
1950 recreate the IV whenever needed, and that the NV is the canonical form.
1951 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1952 precision as a side effect of conversion (which would lead to insanity
1953 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1954 1) to distinguish between IV/UV/NV slots that have cached a valid
1955 conversion where precision was lost and IV/UV/NV slots that have a
1956 valid conversion which has lost no precision
1957 2) to ensure that if a numeric conversion to one form is requested that
1958 would lose precision, the precise conversion (or differently
1959 imprecise conversion) is also performed and cached, to prevent
1960 requests for different numeric formats on the same SV causing
1961 lossy conversion chains. (lossless conversion chains are perfectly
1966 SvIOKp is true if the IV slot contains a valid value
1967 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1968 SvNOKp is true if the NV slot contains a valid value
1969 SvNOK is true only if the NV value is accurate
1972 while converting from PV to NV, check to see if converting that NV to an
1973 IV(or UV) would lose accuracy over a direct conversion from PV to
1974 IV(or UV). If it would, cache both conversions, return NV, but mark
1975 SV as IOK NOKp (ie not NOK).
1977 While converting from PV to IV, check to see if converting that IV to an
1978 NV would lose accuracy over a direct conversion from PV to NV. If it
1979 would, cache both conversions, flag similarly.
1981 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1982 correctly because if IV & NV were set NV *always* overruled.
1983 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1984 changes - now IV and NV together means that the two are interchangeable:
1985 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1987 The benefit of this is that operations such as pp_add know that if
1988 SvIOK is true for both left and right operands, then integer addition
1989 can be used instead of floating point (for cases where the result won't
1990 overflow). Before, floating point was always used, which could lead to
1991 loss of precision compared with integer addition.
1993 * making IV and NV equal status should make maths accurate on 64 bit
1995 * may speed up maths somewhat if pp_add and friends start to use
1996 integers when possible instead of fp. (Hopefully the overhead in
1997 looking for SvIOK and checking for overflow will not outweigh the
1998 fp to integer speedup)
1999 * will slow down integer operations (callers of SvIV) on "inaccurate"
2000 values, as the change from SvIOK to SvIOKp will cause a call into
2001 sv_2iv each time rather than a macro access direct to the IV slot
2002 * should speed up number->string conversion on integers as IV is
2003 favoured when IV and NV are equally accurate
2005 ####################################################################
2006 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2007 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2008 On the other hand, SvUOK is true iff UV.
2009 ####################################################################
2011 Your mileage will vary depending your CPU's relative fp to integer
2015 #ifndef NV_PRESERVES_UV
2016 # define IS_NUMBER_UNDERFLOW_IV 1
2017 # define IS_NUMBER_UNDERFLOW_UV 2
2018 # define IS_NUMBER_IV_AND_UV 2
2019 # define IS_NUMBER_OVERFLOW_IV 4
2020 # define IS_NUMBER_OVERFLOW_UV 5
2022 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2024 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2026 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2028 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));
2029 if (SvNVX(sv) < (NV)IV_MIN) {
2030 (void)SvIOKp_on(sv);
2032 SvIV_set(sv, IV_MIN);
2033 return IS_NUMBER_UNDERFLOW_IV;
2035 if (SvNVX(sv) > (NV)UV_MAX) {
2036 (void)SvIOKp_on(sv);
2039 SvUV_set(sv, UV_MAX);
2040 return IS_NUMBER_OVERFLOW_UV;
2042 (void)SvIOKp_on(sv);
2044 /* Can't use strtol etc to convert this string. (See truth table in
2046 if (SvNVX(sv) <= (UV)IV_MAX) {
2047 SvIV_set(sv, I_V(SvNVX(sv)));
2048 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2049 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2051 /* Integer is imprecise. NOK, IOKp */
2053 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2056 SvUV_set(sv, U_V(SvNVX(sv)));
2057 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2058 if (SvUVX(sv) == UV_MAX) {
2059 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2060 possibly be preserved by NV. Hence, it must be overflow.
2062 return IS_NUMBER_OVERFLOW_UV;
2064 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2066 /* Integer is imprecise. NOK, IOKp */
2068 return IS_NUMBER_OVERFLOW_IV;
2070 #endif /* !NV_PRESERVES_UV*/
2072 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2073 * this function provided for binary compatibility only
2077 Perl_sv_2iv(pTHX_ register SV *sv)
2079 return sv_2iv_flags(sv, SV_GMAGIC);
2083 =for apidoc sv_2iv_flags
2085 Return the integer value of an SV, doing any necessary string
2086 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2087 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2093 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2097 if (SvGMAGICAL(sv)) {
2098 if (flags & SV_GMAGIC)
2103 return I_V(SvNVX(sv));
2105 if (SvPOKp(sv) && SvLEN(sv))
2108 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2109 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2115 if (SvTHINKFIRST(sv)) {
2118 SV * const tmpstr=AMG_CALLun(sv,numer);
2119 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2120 return SvIV(tmpstr);
2123 return PTR2IV(SvRV(sv));
2126 sv_force_normal_flags(sv, 0);
2128 if (SvREADONLY(sv) && !SvOK(sv)) {
2129 if (ckWARN(WARN_UNINITIALIZED))
2136 return (IV)(SvUVX(sv));
2143 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2144 * without also getting a cached IV/UV from it at the same time
2145 * (ie PV->NV conversion should detect loss of accuracy and cache
2146 * IV or UV at same time to avoid this. NWC */
2148 if (SvTYPE(sv) == SVt_NV)
2149 sv_upgrade(sv, SVt_PVNV);
2151 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2152 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2153 certainly cast into the IV range at IV_MAX, whereas the correct
2154 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2156 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2157 SvIV_set(sv, I_V(SvNVX(sv)));
2158 if (SvNVX(sv) == (NV) SvIVX(sv)
2159 #ifndef NV_PRESERVES_UV
2160 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2161 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2162 /* Don't flag it as "accurately an integer" if the number
2163 came from a (by definition imprecise) NV operation, and
2164 we're outside the range of NV integer precision */
2167 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2168 DEBUG_c(PerlIO_printf(Perl_debug_log,
2169 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2175 /* IV not precise. No need to convert from PV, as NV
2176 conversion would already have cached IV if it detected
2177 that PV->IV would be better than PV->NV->IV
2178 flags already correct - don't set public IOK. */
2179 DEBUG_c(PerlIO_printf(Perl_debug_log,
2180 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2185 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2186 but the cast (NV)IV_MIN rounds to a the value less (more
2187 negative) than IV_MIN which happens to be equal to SvNVX ??
2188 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2189 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2190 (NV)UVX == NVX are both true, but the values differ. :-(
2191 Hopefully for 2s complement IV_MIN is something like
2192 0x8000000000000000 which will be exact. NWC */
2195 SvUV_set(sv, U_V(SvNVX(sv)));
2197 (SvNVX(sv) == (NV) SvUVX(sv))
2198 #ifndef NV_PRESERVES_UV
2199 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2200 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2201 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2202 /* Don't flag it as "accurately an integer" if the number
2203 came from a (by definition imprecise) NV operation, and
2204 we're outside the range of NV integer precision */
2210 DEBUG_c(PerlIO_printf(Perl_debug_log,
2211 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2215 return (IV)SvUVX(sv);
2218 else if (SvPOKp(sv) && SvLEN(sv)) {
2220 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2221 /* We want to avoid a possible problem when we cache an IV which
2222 may be later translated to an NV, and the resulting NV is not
2223 the same as the direct translation of the initial string
2224 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2225 be careful to ensure that the value with the .456 is around if the
2226 NV value is requested in the future).
2228 This means that if we cache such an IV, we need to cache the
2229 NV as well. Moreover, we trade speed for space, and do not
2230 cache the NV if we are sure it's not needed.
2233 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2234 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2235 == IS_NUMBER_IN_UV) {
2236 /* It's definitely an integer, only upgrade to PVIV */
2237 if (SvTYPE(sv) < SVt_PVIV)
2238 sv_upgrade(sv, SVt_PVIV);
2240 } else if (SvTYPE(sv) < SVt_PVNV)
2241 sv_upgrade(sv, SVt_PVNV);
2243 /* If NV preserves UV then we only use the UV value if we know that
2244 we aren't going to call atof() below. If NVs don't preserve UVs
2245 then the value returned may have more precision than atof() will
2246 return, even though value isn't perfectly accurate. */
2247 if ((numtype & (IS_NUMBER_IN_UV
2248 #ifdef NV_PRESERVES_UV
2251 )) == IS_NUMBER_IN_UV) {
2252 /* This won't turn off the public IOK flag if it was set above */
2253 (void)SvIOKp_on(sv);
2255 if (!(numtype & IS_NUMBER_NEG)) {
2257 if (value <= (UV)IV_MAX) {
2258 SvIV_set(sv, (IV)value);
2260 SvUV_set(sv, value);
2264 /* 2s complement assumption */
2265 if (value <= (UV)IV_MIN) {
2266 SvIV_set(sv, -(IV)value);
2268 /* Too negative for an IV. This is a double upgrade, but
2269 I'm assuming it will be rare. */
2270 if (SvTYPE(sv) < SVt_PVNV)
2271 sv_upgrade(sv, SVt_PVNV);
2275 SvNV_set(sv, -(NV)value);
2276 SvIV_set(sv, IV_MIN);
2280 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2281 will be in the previous block to set the IV slot, and the next
2282 block to set the NV slot. So no else here. */
2284 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2285 != IS_NUMBER_IN_UV) {
2286 /* It wasn't an (integer that doesn't overflow the UV). */
2287 SvNV_set(sv, Atof(SvPVX_const(sv)));
2289 if (! numtype && ckWARN(WARN_NUMERIC))
2292 #if defined(USE_LONG_DOUBLE)
2293 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2294 PTR2UV(sv), SvNVX(sv)));
2296 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2297 PTR2UV(sv), SvNVX(sv)));
2301 #ifdef NV_PRESERVES_UV
2302 (void)SvIOKp_on(sv);
2304 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2305 SvIV_set(sv, I_V(SvNVX(sv)));
2306 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2309 /* Integer is imprecise. NOK, IOKp */
2311 /* UV will not work better than IV */
2313 if (SvNVX(sv) > (NV)UV_MAX) {
2315 /* Integer is inaccurate. NOK, IOKp, is UV */
2316 SvUV_set(sv, UV_MAX);
2319 SvUV_set(sv, U_V(SvNVX(sv)));
2320 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2321 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2325 /* Integer is imprecise. NOK, IOKp, is UV */
2331 #else /* NV_PRESERVES_UV */
2332 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2333 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2334 /* The IV slot will have been set from value returned by
2335 grok_number above. The NV slot has just been set using
2338 assert (SvIOKp(sv));
2340 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2341 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2342 /* Small enough to preserve all bits. */
2343 (void)SvIOKp_on(sv);
2345 SvIV_set(sv, I_V(SvNVX(sv)));
2346 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2348 /* Assumption: first non-preserved integer is < IV_MAX,
2349 this NV is in the preserved range, therefore: */
2350 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2352 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);
2356 0 0 already failed to read UV.
2357 0 1 already failed to read UV.
2358 1 0 you won't get here in this case. IV/UV
2359 slot set, public IOK, Atof() unneeded.
2360 1 1 already read UV.
2361 so there's no point in sv_2iuv_non_preserve() attempting
2362 to use atol, strtol, strtoul etc. */
2363 if (sv_2iuv_non_preserve (sv, numtype)
2364 >= IS_NUMBER_OVERFLOW_IV)
2368 #endif /* NV_PRESERVES_UV */
2371 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2373 if (SvTYPE(sv) < SVt_IV)
2374 /* Typically the caller expects that sv_any is not NULL now. */
2375 sv_upgrade(sv, SVt_IV);
2378 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2379 PTR2UV(sv),SvIVX(sv)));
2380 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2383 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2384 * this function provided for binary compatibility only
2388 Perl_sv_2uv(pTHX_ register SV *sv)
2390 return sv_2uv_flags(sv, SV_GMAGIC);
2394 =for apidoc sv_2uv_flags
2396 Return the unsigned integer value of an SV, doing any necessary string
2397 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2398 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2404 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2408 if (SvGMAGICAL(sv)) {
2409 if (flags & SV_GMAGIC)
2414 return U_V(SvNVX(sv));
2415 if (SvPOKp(sv) && SvLEN(sv))
2418 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2419 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2425 if (SvTHINKFIRST(sv)) {
2428 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2429 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2430 return SvUV(tmpstr);
2431 return PTR2UV(SvRV(sv));
2434 sv_force_normal_flags(sv, 0);
2436 if (SvREADONLY(sv) && !SvOK(sv)) {
2437 if (ckWARN(WARN_UNINITIALIZED))
2447 return (UV)SvIVX(sv);
2451 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2452 * without also getting a cached IV/UV from it at the same time
2453 * (ie PV->NV conversion should detect loss of accuracy and cache
2454 * IV or UV at same time to avoid this. */
2455 /* IV-over-UV optimisation - choose to cache IV if possible */
2457 if (SvTYPE(sv) == SVt_NV)
2458 sv_upgrade(sv, SVt_PVNV);
2460 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2461 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2462 SvIV_set(sv, I_V(SvNVX(sv)));
2463 if (SvNVX(sv) == (NV) SvIVX(sv)
2464 #ifndef NV_PRESERVES_UV
2465 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2466 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2467 /* Don't flag it as "accurately an integer" if the number
2468 came from a (by definition imprecise) NV operation, and
2469 we're outside the range of NV integer precision */
2472 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2473 DEBUG_c(PerlIO_printf(Perl_debug_log,
2474 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2480 /* IV not precise. No need to convert from PV, as NV
2481 conversion would already have cached IV if it detected
2482 that PV->IV would be better than PV->NV->IV
2483 flags already correct - don't set public IOK. */
2484 DEBUG_c(PerlIO_printf(Perl_debug_log,
2485 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2490 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2491 but the cast (NV)IV_MIN rounds to a the value less (more
2492 negative) than IV_MIN which happens to be equal to SvNVX ??
2493 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2494 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2495 (NV)UVX == NVX are both true, but the values differ. :-(
2496 Hopefully for 2s complement IV_MIN is something like
2497 0x8000000000000000 which will be exact. NWC */
2500 SvUV_set(sv, U_V(SvNVX(sv)));
2502 (SvNVX(sv) == (NV) SvUVX(sv))
2503 #ifndef NV_PRESERVES_UV
2504 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2505 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2506 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2507 /* Don't flag it as "accurately an integer" if the number
2508 came from a (by definition imprecise) NV operation, and
2509 we're outside the range of NV integer precision */
2514 DEBUG_c(PerlIO_printf(Perl_debug_log,
2515 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2521 else if (SvPOKp(sv) && SvLEN(sv)) {
2523 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2525 /* We want to avoid a possible problem when we cache a UV which
2526 may be later translated to an NV, and the resulting NV is not
2527 the translation of the initial data.
2529 This means that if we cache such a UV, we need to cache the
2530 NV as well. Moreover, we trade speed for space, and do not
2531 cache the NV if not needed.
2534 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2535 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2536 == IS_NUMBER_IN_UV) {
2537 /* It's definitely an integer, only upgrade to PVIV */
2538 if (SvTYPE(sv) < SVt_PVIV)
2539 sv_upgrade(sv, SVt_PVIV);
2541 } else if (SvTYPE(sv) < SVt_PVNV)
2542 sv_upgrade(sv, SVt_PVNV);
2544 /* If NV preserves UV then we only use the UV value if we know that
2545 we aren't going to call atof() below. If NVs don't preserve UVs
2546 then the value returned may have more precision than atof() will
2547 return, even though it isn't accurate. */
2548 if ((numtype & (IS_NUMBER_IN_UV
2549 #ifdef NV_PRESERVES_UV
2552 )) == IS_NUMBER_IN_UV) {
2553 /* This won't turn off the public IOK flag if it was set above */
2554 (void)SvIOKp_on(sv);
2556 if (!(numtype & IS_NUMBER_NEG)) {
2558 if (value <= (UV)IV_MAX) {
2559 SvIV_set(sv, (IV)value);
2561 /* it didn't overflow, and it was positive. */
2562 SvUV_set(sv, value);
2566 /* 2s complement assumption */
2567 if (value <= (UV)IV_MIN) {
2568 SvIV_set(sv, -(IV)value);
2570 /* Too negative for an IV. This is a double upgrade, but
2571 I'm assuming it will be rare. */
2572 if (SvTYPE(sv) < SVt_PVNV)
2573 sv_upgrade(sv, SVt_PVNV);
2577 SvNV_set(sv, -(NV)value);
2578 SvIV_set(sv, IV_MIN);
2583 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2584 != IS_NUMBER_IN_UV) {
2585 /* It wasn't an integer, or it overflowed the UV. */
2586 SvNV_set(sv, Atof(SvPVX_const(sv)));
2588 if (! numtype && ckWARN(WARN_NUMERIC))
2591 #if defined(USE_LONG_DOUBLE)
2592 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2593 PTR2UV(sv), SvNVX(sv)));
2595 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2596 PTR2UV(sv), SvNVX(sv)));
2599 #ifdef NV_PRESERVES_UV
2600 (void)SvIOKp_on(sv);
2602 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2603 SvIV_set(sv, I_V(SvNVX(sv)));
2604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2607 /* Integer is imprecise. NOK, IOKp */
2609 /* UV will not work better than IV */
2611 if (SvNVX(sv) > (NV)UV_MAX) {
2613 /* Integer is inaccurate. NOK, IOKp, is UV */
2614 SvUV_set(sv, UV_MAX);
2617 SvUV_set(sv, U_V(SvNVX(sv)));
2618 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2619 NV preservse UV so can do correct comparison. */
2620 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2624 /* Integer is imprecise. NOK, IOKp, is UV */
2629 #else /* NV_PRESERVES_UV */
2630 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2631 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2632 /* The UV slot will have been set from value returned by
2633 grok_number above. The NV slot has just been set using
2636 assert (SvIOKp(sv));
2638 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2639 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2640 /* Small enough to preserve all bits. */
2641 (void)SvIOKp_on(sv);
2643 SvIV_set(sv, I_V(SvNVX(sv)));
2644 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2646 /* Assumption: first non-preserved integer is < IV_MAX,
2647 this NV is in the preserved range, therefore: */
2648 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2650 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);
2653 sv_2iuv_non_preserve (sv, numtype);
2655 #endif /* NV_PRESERVES_UV */
2659 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2660 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2663 if (SvTYPE(sv) < SVt_IV)
2664 /* Typically the caller expects that sv_any is not NULL now. */
2665 sv_upgrade(sv, SVt_IV);
2669 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2670 PTR2UV(sv),SvUVX(sv)));
2671 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2677 Return the num value of an SV, doing any necessary string or integer
2678 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2685 Perl_sv_2nv(pTHX_ register SV *sv)
2689 if (SvGMAGICAL(sv)) {
2693 if (SvPOKp(sv) && SvLEN(sv)) {
2694 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2695 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2697 return Atof(SvPVX_const(sv));
2701 return (NV)SvUVX(sv);
2703 return (NV)SvIVX(sv);
2706 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2707 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2713 if (SvTHINKFIRST(sv)) {
2716 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2717 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2718 return SvNV(tmpstr);
2719 return PTR2NV(SvRV(sv));
2722 sv_force_normal_flags(sv, 0);
2724 if (SvREADONLY(sv) && !SvOK(sv)) {
2725 if (ckWARN(WARN_UNINITIALIZED))
2730 if (SvTYPE(sv) < SVt_NV) {
2731 if (SvTYPE(sv) == SVt_IV)
2732 sv_upgrade(sv, SVt_PVNV);
2734 sv_upgrade(sv, SVt_NV);
2735 #ifdef USE_LONG_DOUBLE
2737 STORE_NUMERIC_LOCAL_SET_STANDARD();
2738 PerlIO_printf(Perl_debug_log,
2739 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2740 PTR2UV(sv), SvNVX(sv));
2741 RESTORE_NUMERIC_LOCAL();
2745 STORE_NUMERIC_LOCAL_SET_STANDARD();
2746 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2747 PTR2UV(sv), SvNVX(sv));
2748 RESTORE_NUMERIC_LOCAL();
2752 else if (SvTYPE(sv) < SVt_PVNV)
2753 sv_upgrade(sv, SVt_PVNV);
2758 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2759 #ifdef NV_PRESERVES_UV
2762 /* Only set the public NV OK flag if this NV preserves the IV */
2763 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2764 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2765 : (SvIVX(sv) == I_V(SvNVX(sv))))
2771 else if (SvPOKp(sv) && SvLEN(sv)) {
2773 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2774 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2776 #ifdef NV_PRESERVES_UV
2777 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2778 == IS_NUMBER_IN_UV) {
2779 /* It's definitely an integer */
2780 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2782 SvNV_set(sv, Atof(SvPVX_const(sv)));
2785 SvNV_set(sv, Atof(SvPVX_const(sv)));
2786 /* Only set the public NV OK flag if this NV preserves the value in
2787 the PV at least as well as an IV/UV would.
2788 Not sure how to do this 100% reliably. */
2789 /* if that shift count is out of range then Configure's test is
2790 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2792 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2793 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2794 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2795 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2796 /* Can't use strtol etc to convert this string, so don't try.
2797 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2800 /* value has been set. It may not be precise. */
2801 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2802 /* 2s complement assumption for (UV)IV_MIN */
2803 SvNOK_on(sv); /* Integer is too negative. */
2808 if (numtype & IS_NUMBER_NEG) {
2809 SvIV_set(sv, -(IV)value);
2810 } else if (value <= (UV)IV_MAX) {
2811 SvIV_set(sv, (IV)value);
2813 SvUV_set(sv, value);
2817 if (numtype & IS_NUMBER_NOT_INT) {
2818 /* I believe that even if the original PV had decimals,
2819 they are lost beyond the limit of the FP precision.
2820 However, neither is canonical, so both only get p
2821 flags. NWC, 2000/11/25 */
2822 /* Both already have p flags, so do nothing */
2824 const NV nv = SvNVX(sv);
2825 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2826 if (SvIVX(sv) == I_V(nv)) {
2831 /* It had no "." so it must be integer. */
2834 /* between IV_MAX and NV(UV_MAX).
2835 Could be slightly > UV_MAX */
2837 if (numtype & IS_NUMBER_NOT_INT) {
2838 /* UV and NV both imprecise. */
2840 const UV nv_as_uv = U_V(nv);
2842 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2853 #endif /* NV_PRESERVES_UV */
2856 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2858 if (SvTYPE(sv) < SVt_NV)
2859 /* Typically the caller expects that sv_any is not NULL now. */
2860 /* XXX Ilya implies that this is a bug in callers that assume this
2861 and ideally should be fixed. */
2862 sv_upgrade(sv, SVt_NV);
2865 #if defined(USE_LONG_DOUBLE)
2867 STORE_NUMERIC_LOCAL_SET_STANDARD();
2868 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2869 PTR2UV(sv), SvNVX(sv));
2870 RESTORE_NUMERIC_LOCAL();
2874 STORE_NUMERIC_LOCAL_SET_STANDARD();
2875 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2876 PTR2UV(sv), SvNVX(sv));
2877 RESTORE_NUMERIC_LOCAL();
2883 /* asIV(): extract an integer from the string value of an SV.
2884 * Caller must validate PVX */
2887 S_asIV(pTHX_ SV *sv)
2890 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2892 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2893 == IS_NUMBER_IN_UV) {
2894 /* It's definitely an integer */
2895 if (numtype & IS_NUMBER_NEG) {
2896 if (value < (UV)IV_MIN)
2899 if (value < (UV)IV_MAX)
2904 if (ckWARN(WARN_NUMERIC))
2907 return I_V(Atof(SvPVX_const(sv)));
2910 /* asUV(): extract an unsigned integer from the string value of an SV
2911 * Caller must validate PVX */
2914 S_asUV(pTHX_ SV *sv)
2917 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2919 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2920 == IS_NUMBER_IN_UV) {
2921 /* It's definitely an integer */
2922 if (!(numtype & IS_NUMBER_NEG))
2926 if (ckWARN(WARN_NUMERIC))
2929 return U_V(Atof(SvPVX_const(sv)));
2933 =for apidoc sv_2pv_nolen
2935 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2936 use the macro wrapper C<SvPV_nolen(sv)> instead.
2941 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2943 return sv_2pv(sv, 0);
2946 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2947 * UV as a string towards the end of buf, and return pointers to start and
2950 * We assume that buf is at least TYPE_CHARS(UV) long.
2954 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2956 char *ptr = buf + TYPE_CHARS(UV);
2957 char * const ebuf = ptr;
2970 *--ptr = '0' + (char)(uv % 10);
2978 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2979 * this function provided for binary compatibility only
2983 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2985 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2989 =for apidoc sv_2pv_flags
2991 Returns a pointer to the string value of an SV, and sets *lp to its length.
2992 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2994 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2995 usually end up here too.
3001 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3006 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3007 char *tmpbuf = tbuf;
3014 if (SvGMAGICAL(sv)) {
3015 if (flags & SV_GMAGIC)
3020 if (flags & SV_MUTABLE_RETURN)
3021 return SvPVX_mutable(sv);
3022 if (flags & SV_CONST_RETURN)
3023 return (char *)SvPVX_const(sv);
3028 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3030 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3035 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3040 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3041 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
3049 if (SvTHINKFIRST(sv)) {
3052 register const char *typestr;
3053 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3054 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3056 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3059 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3060 if (flags & SV_CONST_RETURN) {
3061 pv = (char *) SvPVX_const(tmpstr);
3063 pv = (flags & SV_MUTABLE_RETURN)
3064 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3067 *lp = SvCUR(tmpstr);
3069 pv = sv_2pv_flags(tmpstr, lp, flags);
3080 typestr = "NULLREF";
3084 switch (SvTYPE(sv)) {
3086 if ( ((SvFLAGS(sv) &
3087 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3088 == (SVs_OBJECT|SVs_SMG))
3089 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3090 const regexp *re = (regexp *)mg->mg_obj;
3093 const char *fptr = "msix";
3098 char need_newline = 0;
3099 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3101 while((ch = *fptr++)) {
3103 reflags[left++] = ch;
3106 reflags[right--] = ch;
3111 reflags[left] = '-';
3115 mg->mg_len = re->prelen + 4 + left;
3117 * If /x was used, we have to worry about a regex
3118 * ending with a comment later being embedded
3119 * within another regex. If so, we don't want this
3120 * regex's "commentization" to leak out to the
3121 * right part of the enclosing regex, we must cap
3122 * it with a newline.
3124 * So, if /x was used, we scan backwards from the
3125 * end of the regex. If we find a '#' before we
3126 * find a newline, we need to add a newline
3127 * ourself. If we find a '\n' first (or if we
3128 * don't find '#' or '\n'), we don't need to add
3129 * anything. -jfriedl
3131 if (PMf_EXTENDED & re->reganch)
3133 const char *endptr = re->precomp + re->prelen;
3134 while (endptr >= re->precomp)
3136 const char c = *(endptr--);
3138 break; /* don't need another */
3140 /* we end while in a comment, so we
3142 mg->mg_len++; /* save space for it */
3143 need_newline = 1; /* note to add it */
3149 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3150 Copy("(?", mg->mg_ptr, 2, char);
3151 Copy(reflags, mg->mg_ptr+2, left, char);
3152 Copy(":", mg->mg_ptr+left+2, 1, char);
3153 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3155 mg->mg_ptr[mg->mg_len - 2] = '\n';
3156 mg->mg_ptr[mg->mg_len - 1] = ')';
3157 mg->mg_ptr[mg->mg_len] = 0;
3159 PL_reginterp_cnt += re->program[0].next_off;
3161 if (re->reganch & ROPT_UTF8)
3177 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3178 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3179 /* tied lvalues should appear to be
3180 * scalars for backwards compatitbility */
3181 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3182 ? "SCALAR" : "LVALUE"; break;
3183 case SVt_PVAV: typestr = "ARRAY"; break;
3184 case SVt_PVHV: typestr = "HASH"; break;
3185 case SVt_PVCV: typestr = "CODE"; break;
3186 case SVt_PVGV: typestr = "GLOB"; break;
3187 case SVt_PVFM: typestr = "FORMAT"; break;
3188 case SVt_PVIO: typestr = "IO"; break;
3189 default: typestr = "UNKNOWN"; break;
3193 const char *name = HvNAME_get(SvSTASH(sv));
3194 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3195 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3198 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3202 *lp = strlen(typestr);
3203 return (char *)typestr;
3205 if (SvREADONLY(sv) && !SvOK(sv)) {
3206 if (ckWARN(WARN_UNINITIALIZED))
3213 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3214 /* I'm assuming that if both IV and NV are equally valid then
3215 converting the IV is going to be more efficient */
3216 const U32 isIOK = SvIOK(sv);
3217 const U32 isUIOK = SvIsUV(sv);
3218 char buf[TYPE_CHARS(UV)];
3221 if (SvTYPE(sv) < SVt_PVIV)
3222 sv_upgrade(sv, SVt_PVIV);
3224 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3226 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3227 /* inlined from sv_setpvn */
3228 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3229 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3230 SvCUR_set(sv, ebuf - ptr);
3240 else if (SvNOKp(sv)) {
3241 if (SvTYPE(sv) < SVt_PVNV)
3242 sv_upgrade(sv, SVt_PVNV);
3243 /* The +20 is pure guesswork. Configure test needed. --jhi */
3244 s = SvGROW_mutable(sv, NV_DIG + 20);
3245 olderrno = errno; /* some Xenix systems wipe out errno here */
3247 if (SvNVX(sv) == 0.0)
3248 (void)strcpy(s,"0");
3252 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3255 #ifdef FIXNEGATIVEZERO
3256 if (*s == '-' && s[1] == '0' && !s[2])
3266 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3270 if (SvTYPE(sv) < SVt_PV)
3271 /* Typically the caller expects that sv_any is not NULL now. */
3272 sv_upgrade(sv, SVt_PV);
3276 const STRLEN len = s - SvPVX_const(sv);
3282 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3283 PTR2UV(sv),SvPVX_const(sv)));
3284 if (flags & SV_CONST_RETURN)
3285 return (char *)SvPVX_const(sv);
3286 if (flags & SV_MUTABLE_RETURN)
3287 return SvPVX_mutable(sv);
3291 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3292 /* Sneaky stuff here */
3296 tsv = newSVpv(tmpbuf, 0);
3309 t = SvPVX_const(tsv);
3314 len = strlen(tmpbuf);
3316 #ifdef FIXNEGATIVEZERO
3317 if (len == 2 && t[0] == '-' && t[1] == '0') {
3322 SvUPGRADE(sv, SVt_PV);
3325 s = SvGROW_mutable(sv, len + 1);
3328 return memcpy(s, t, len + 1);
3333 =for apidoc sv_copypv
3335 Copies a stringified representation of the source SV into the
3336 destination SV. Automatically performs any necessary mg_get and
3337 coercion of numeric values into strings. Guaranteed to preserve
3338 UTF-8 flag even from overloaded objects. Similar in nature to
3339 sv_2pv[_flags] but operates directly on an SV instead of just the
3340 string. Mostly uses sv_2pv_flags to do its work, except when that
3341 would lose the UTF-8'ness of the PV.
3347 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3350 const char * const s = SvPV_const(ssv,len);
3351 sv_setpvn(dsv,s,len);
3359 =for apidoc sv_2pvbyte_nolen
3361 Return a pointer to the byte-encoded representation of the SV.
3362 May cause the SV to be downgraded from UTF-8 as a side-effect.
3364 Usually accessed via the C<SvPVbyte_nolen> macro.
3370 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3372 return sv_2pvbyte(sv, 0);
3376 =for apidoc sv_2pvbyte
3378 Return a pointer to the byte-encoded representation of the SV, and set *lp
3379 to its length. May cause the SV to be downgraded from UTF-8 as a
3382 Usually accessed via the C<SvPVbyte> macro.
3388 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3390 sv_utf8_downgrade(sv,0);
3391 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3395 =for apidoc sv_2pvutf8_nolen
3397 Return a pointer to the UTF-8-encoded representation of the SV.
3398 May cause the SV to be upgraded to UTF-8 as a side-effect.
3400 Usually accessed via the C<SvPVutf8_nolen> macro.
3406 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3408 return sv_2pvutf8(sv, 0);
3412 =for apidoc sv_2pvutf8
3414 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3415 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3417 Usually accessed via the C<SvPVutf8> macro.
3423 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3425 sv_utf8_upgrade(sv);
3426 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3430 =for apidoc sv_2bool
3432 This function is only called on magical items, and is only used by
3433 sv_true() or its macro equivalent.
3439 Perl_sv_2bool(pTHX_ register SV *sv)
3447 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3448 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3449 return (bool)SvTRUE(tmpsv);
3450 return SvRV(sv) != 0;
3453 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3455 (*sv->sv_u.svu_pv > '0' ||
3456 Xpvtmp->xpv_cur > 1 ||
3457 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3464 return SvIVX(sv) != 0;
3467 return SvNVX(sv) != 0.0;
3474 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3475 * this function provided for binary compatibility only
3480 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3482 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3486 =for apidoc sv_utf8_upgrade
3488 Converts the PV of an SV to its UTF-8-encoded form.
3489 Forces the SV to string form if it is not already.
3490 Always sets the SvUTF8 flag to avoid future validity checks even
3491 if all the bytes have hibit clear.
3493 This is not as a general purpose byte encoding to Unicode interface:
3494 use the Encode extension for that.
3496 =for apidoc sv_utf8_upgrade_flags
3498 Converts the PV of an SV to its UTF-8-encoded form.
3499 Forces the SV to string form if it is not already.
3500 Always sets the SvUTF8 flag to avoid future validity checks even
3501 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3502 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3503 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3505 This is not as a general purpose byte encoding to Unicode interface:
3506 use the Encode extension for that.
3512 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3514 if (sv == &PL_sv_undef)
3518 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3519 (void) sv_2pv_flags(sv,&len, flags);
3523 (void) SvPV_force(sv,len);
3532 sv_force_normal_flags(sv, 0);
3535 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3536 sv_recode_to_utf8(sv, PL_encoding);
3537 else { /* Assume Latin-1/EBCDIC */
3538 /* This function could be much more efficient if we
3539 * had a FLAG in SVs to signal if there are any hibit
3540 * chars in the PV. Given that there isn't such a flag
3541 * make the loop as fast as possible. */
3542 const U8 *s = (U8 *) SvPVX_const(sv);
3543 const U8 *e = (U8 *) SvEND(sv);
3549 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3553 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3554 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3556 SvPV_free(sv); /* No longer using what was there before. */
3558 SvPV_set(sv, (char*)recoded);
3559 SvCUR_set(sv, len - 1);
3560 SvLEN_set(sv, len); /* No longer know the real size. */
3562 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3569 =for apidoc sv_utf8_downgrade
3571 Attempts to convert the PV of an SV from characters to bytes.
3572 If the PV contains a character beyond byte, this conversion will fail;
3573 in this case, either returns false or, if C<fail_ok> is not
3576 This is not as a general purpose Unicode to byte encoding interface:
3577 use the Encode extension for that.
3583 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3585 if (SvPOKp(sv) && SvUTF8(sv)) {
3591 sv_force_normal_flags(sv, 0);
3593 s = (U8 *) SvPV(sv, len);
3594 if (!utf8_to_bytes(s, &len)) {
3599 Perl_croak(aTHX_ "Wide character in %s",
3602 Perl_croak(aTHX_ "Wide character");
3613 =for apidoc sv_utf8_encode
3615 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3616 flag off so that it looks like octets again.
3622 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3624 (void) sv_utf8_upgrade(sv);
3626 sv_force_normal_flags(sv, 0);
3628 if (SvREADONLY(sv)) {
3629 Perl_croak(aTHX_ PL_no_modify);
3635 =for apidoc sv_utf8_decode
3637 If the PV of the SV is an octet sequence in UTF-8
3638 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3639 so that it looks like a character. If the PV contains only single-byte
3640 characters, the C<SvUTF8> flag stays being off.
3641 Scans PV for validity and returns false if the PV is invalid UTF-8.
3647 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3653 /* The octets may have got themselves encoded - get them back as
3656 if (!sv_utf8_downgrade(sv, TRUE))
3659 /* it is actually just a matter of turning the utf8 flag on, but
3660 * we want to make sure everything inside is valid utf8 first.
3662 c = (const U8 *) SvPVX_const(sv);
3663 if (!is_utf8_string(c, SvCUR(sv)+1))
3665 e = (const U8 *) SvEND(sv);
3668 if (!UTF8_IS_INVARIANT(ch)) {
3677 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3678 * this function provided for binary compatibility only
3682 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3684 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3688 =for apidoc sv_setsv
3690 Copies the contents of the source SV C<ssv> into the destination SV
3691 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3692 function if the source SV needs to be reused. Does not handle 'set' magic.
3693 Loosely speaking, it performs a copy-by-value, obliterating any previous
3694 content of the destination.
3696 You probably want to use one of the assortment of wrappers, such as
3697 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3698 C<SvSetMagicSV_nosteal>.
3700 =for apidoc sv_setsv_flags
3702 Copies the contents of the source SV C<ssv> into the destination SV
3703 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3704 function if the source SV needs to be reused. Does not handle 'set' magic.
3705 Loosely speaking, it performs a copy-by-value, obliterating any previous
3706 content of the destination.
3707 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3708 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3709 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3710 and C<sv_setsv_nomg> are implemented in terms of this function.
3712 You probably want to use one of the assortment of wrappers, such as
3713 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3714 C<SvSetMagicSV_nosteal>.
3716 This is the primary function for copying scalars, and most other
3717 copy-ish functions and macros use this underneath.
3723 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3725 register U32 sflags;
3731 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3733 sstr = &PL_sv_undef;
3734 stype = SvTYPE(sstr);
3735 dtype = SvTYPE(dstr);
3740 /* need to nuke the magic */
3742 SvRMAGICAL_off(dstr);
3745 /* There's a lot of redundancy below but we're going for speed here */
3750 if (dtype != SVt_PVGV) {
3751 (void)SvOK_off(dstr);
3759 sv_upgrade(dstr, SVt_IV);
3762 sv_upgrade(dstr, SVt_PVNV);
3766 sv_upgrade(dstr, SVt_PVIV);
3769 (void)SvIOK_only(dstr);
3770 SvIV_set(dstr, SvIVX(sstr));
3773 if (SvTAINTED(sstr))
3784 sv_upgrade(dstr, SVt_NV);
3789 sv_upgrade(dstr, SVt_PVNV);
3792 SvNV_set(dstr, SvNVX(sstr));
3793 (void)SvNOK_only(dstr);
3794 if (SvTAINTED(sstr))
3802 sv_upgrade(dstr, SVt_RV);
3803 else if (dtype == SVt_PVGV &&
3804 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3807 if (GvIMPORTED(dstr) != GVf_IMPORTED
3808 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3810 GvIMPORTED_on(dstr);
3819 #ifdef PERL_OLD_COPY_ON_WRITE
3820 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3821 if (dtype < SVt_PVIV)
3822 sv_upgrade(dstr, SVt_PVIV);
3829 sv_upgrade(dstr, SVt_PV);
3832 if (dtype < SVt_PVIV)
3833 sv_upgrade(dstr, SVt_PVIV);
3836 if (dtype < SVt_PVNV)
3837 sv_upgrade(dstr, SVt_PVNV);
3844 const char * const type = sv_reftype(sstr,0);
3846 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3848 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3853 if (dtype <= SVt_PVGV) {
3855 if (dtype != SVt_PVGV) {
3856 const char * const name = GvNAME(sstr);
3857 const STRLEN len = GvNAMELEN(sstr);
3858 /* don't upgrade SVt_PVLV: it can hold a glob */
3859 if (dtype != SVt_PVLV)
3860 sv_upgrade(dstr, SVt_PVGV);
3861 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3862 GvSTASH(dstr) = GvSTASH(sstr);
3864 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3865 GvNAME(dstr) = savepvn(name, len);
3866 GvNAMELEN(dstr) = len;
3867 SvFAKE_on(dstr); /* can coerce to non-glob */
3869 /* ahem, death to those who redefine active sort subs */
3870 else if (PL_curstackinfo->si_type == PERLSI_SORT
3871 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3872 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3875 #ifdef GV_UNIQUE_CHECK
3876 if (GvUNIQUE((GV*)dstr)) {
3877 Perl_croak(aTHX_ PL_no_modify);
3881 (void)SvOK_off(dstr);
3882 GvINTRO_off(dstr); /* one-shot flag */
3884 GvGP(dstr) = gp_ref(GvGP(sstr));
3885 if (SvTAINTED(sstr))
3887 if (GvIMPORTED(dstr) != GVf_IMPORTED
3888 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3890 GvIMPORTED_on(dstr);
3898 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3900 if ((int)SvTYPE(sstr) != stype) {
3901 stype = SvTYPE(sstr);
3902 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3906 if (stype == SVt_PVLV)
3907 SvUPGRADE(dstr, SVt_PVNV);
3909 SvUPGRADE(dstr, (U32)stype);
3912 sflags = SvFLAGS(sstr);
3914 if (sflags & SVf_ROK) {
3915 if (dtype >= SVt_PV) {
3916 if (dtype == SVt_PVGV) {
3917 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3919 const int intro = GvINTRO(dstr);
3921 #ifdef GV_UNIQUE_CHECK
3922 if (GvUNIQUE((GV*)dstr)) {
3923 Perl_croak(aTHX_ PL_no_modify);
3928 GvINTRO_off(dstr); /* one-shot flag */
3929 GvLINE(dstr) = CopLINE(PL_curcop);
3930 GvEGV(dstr) = (GV*)dstr;
3933 switch (SvTYPE(sref)) {
3936 SAVEGENERICSV(GvAV(dstr));
3938 dref = (SV*)GvAV(dstr);
3939 GvAV(dstr) = (AV*)sref;
3940 if (!GvIMPORTED_AV(dstr)
3941 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3943 GvIMPORTED_AV_on(dstr);
3948 SAVEGENERICSV(GvHV(dstr));
3950 dref = (SV*)GvHV(dstr);
3951 GvHV(dstr) = (HV*)sref;
3952 if (!GvIMPORTED_HV(dstr)
3953 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3955 GvIMPORTED_HV_on(dstr);
3960 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3961 SvREFCNT_dec(GvCV(dstr));
3962 GvCV(dstr) = Nullcv;
3963 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3964 PL_sub_generation++;
3966 SAVEGENERICSV(GvCV(dstr));
3969 dref = (SV*)GvCV(dstr);
3970 if (GvCV(dstr) != (CV*)sref) {
3971 CV* const cv = GvCV(dstr);
3973 if (!GvCVGEN((GV*)dstr) &&
3974 (CvROOT(cv) || CvXSUB(cv)))
3976 /* ahem, death to those who redefine
3977 * active sort subs */
3978 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3979 PL_sortcop == CvSTART(cv))
3981 "Can't redefine active sort subroutine %s",
3982 GvENAME((GV*)dstr));
3983 /* Redefining a sub - warning is mandatory if
3984 it was a const and its value changed. */
3985 if (ckWARN(WARN_REDEFINE)
3987 && (!CvCONST((CV*)sref)
3988 || sv_cmp(cv_const_sv(cv),
3989 cv_const_sv((CV*)sref)))))
3991 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3993 ? "Constant subroutine %s::%s redefined"
3994 : "Subroutine %s::%s redefined",
3995 HvNAME_get(GvSTASH((GV*)dstr)),
3996 GvENAME((GV*)dstr));
4000 cv_ckproto(cv, (GV*)dstr,
4002 ? SvPVX_const(sref) : Nullch);
4004 GvCV(dstr) = (CV*)sref;
4005 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4006 GvASSUMECV_on(dstr);
4007 PL_sub_generation++;
4009 if (!GvIMPORTED_CV(dstr)
4010 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4012 GvIMPORTED_CV_on(dstr);
4017 SAVEGENERICSV(GvIOp(dstr));
4019 dref = (SV*)GvIOp(dstr);
4020 GvIOp(dstr) = (IO*)sref;
4024 SAVEGENERICSV(GvFORM(dstr));
4026 dref = (SV*)GvFORM(dstr);
4027 GvFORM(dstr) = (CV*)sref;
4031 SAVEGENERICSV(GvSV(dstr));
4033 dref = (SV*)GvSV(dstr);
4035 if (!GvIMPORTED_SV(dstr)
4036 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4038 GvIMPORTED_SV_on(dstr);
4044 if (SvTAINTED(sstr))
4048 if (SvPVX_const(dstr)) {
4054 (void)SvOK_off(dstr);
4055 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4057 if (sflags & SVp_NOK) {
4059 /* Only set the public OK flag if the source has public OK. */
4060 if (sflags & SVf_NOK)
4061 SvFLAGS(dstr) |= SVf_NOK;
4062 SvNV_set(dstr, SvNVX(sstr));
4064 if (sflags & SVp_IOK) {
4065 (void)SvIOKp_on(dstr);
4066 if (sflags & SVf_IOK)
4067 SvFLAGS(dstr) |= SVf_IOK;
4068 if (sflags & SVf_IVisUV)
4070 SvIV_set(dstr, SvIVX(sstr));
4072 if (SvAMAGIC(sstr)) {
4076 else if (sflags & SVp_POK) {
4080 * Check to see if we can just swipe the string. If so, it's a
4081 * possible small lose on short strings, but a big win on long ones.
4082 * It might even be a win on short strings if SvPVX_const(dstr)
4083 * has to be allocated and SvPVX_const(sstr) has to be freed.
4086 /* Whichever path we take through the next code, we want this true,
4087 and doing it now facilitates the COW check. */
4088 (void)SvPOK_only(dstr);
4091 /* We're not already COW */
4092 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4093 #ifndef PERL_OLD_COPY_ON_WRITE
4094 /* or we are, but dstr isn't a suitable target. */
4095 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4100 (sflags & SVs_TEMP) && /* slated for free anyway? */
4101 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4102 (!(flags & SV_NOSTEAL)) &&
4103 /* and we're allowed to steal temps */
4104 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4105 SvLEN(sstr) && /* and really is a string */
4106 /* and won't be needed again, potentially */
4107 !(PL_op && PL_op->op_type == OP_AASSIGN))
4108 #ifdef PERL_OLD_COPY_ON_WRITE
4109 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4110 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4111 && SvTYPE(sstr) >= SVt_PVIV)
4114 /* Failed the swipe test, and it's not a shared hash key either.
4115 Have to copy the string. */
4116 STRLEN len = SvCUR(sstr);
4117 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4118 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4119 SvCUR_set(dstr, len);
4120 *SvEND(dstr) = '\0';
4122 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4124 /* Either it's a shared hash key, or it's suitable for
4125 copy-on-write or we can swipe the string. */
4127 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4131 #ifdef PERL_OLD_COPY_ON_WRITE
4133 /* I believe I should acquire a global SV mutex if
4134 it's a COW sv (not a shared hash key) to stop
4135 it going un copy-on-write.
4136 If the source SV has gone un copy on write between up there
4137 and down here, then (assert() that) it is of the correct
4138 form to make it copy on write again */
4139 if ((sflags & (SVf_FAKE | SVf_READONLY))
4140 != (SVf_FAKE | SVf_READONLY)) {
4141 SvREADONLY_on(sstr);
4143 /* Make the source SV into a loop of 1.
4144 (about to become 2) */
4145 SV_COW_NEXT_SV_SET(sstr, sstr);
4149 /* Initial code is common. */
4150 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4155 /* making another shared SV. */
4156 STRLEN cur = SvCUR(sstr);
4157 STRLEN len = SvLEN(sstr);
4158 #ifdef PERL_OLD_COPY_ON_WRITE
4160 assert (SvTYPE(dstr) >= SVt_PVIV);
4161 /* SvIsCOW_normal */
4162 /* splice us in between source and next-after-source. */
4163 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4164 SV_COW_NEXT_SV_SET(sstr, dstr);
4165 SvPV_set(dstr, SvPVX_mutable(sstr));
4169 /* SvIsCOW_shared_hash */
4170 DEBUG_C(PerlIO_printf(Perl_debug_log,
4171 "Copy on write: Sharing hash\n"));
4173 assert (SvTYPE(dstr) >= SVt_PV);
4175 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4177 SvLEN_set(dstr, len);
4178 SvCUR_set(dstr, cur);
4179 SvREADONLY_on(dstr);
4181 /* Relesase a global SV mutex. */
4184 { /* Passes the swipe test. */
4185 SvPV_set(dstr, SvPVX_mutable(sstr));
4186 SvLEN_set(dstr, SvLEN(sstr));
4187 SvCUR_set(dstr, SvCUR(sstr));
4190 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4191 SvPV_set(sstr, Nullch);
4197 if (sflags & SVf_UTF8)
4199 if (sflags & SVp_NOK) {
4201 if (sflags & SVf_NOK)
4202 SvFLAGS(dstr) |= SVf_NOK;
4203 SvNV_set(dstr, SvNVX(sstr));
4205 if (sflags & SVp_IOK) {
4206 (void)SvIOKp_on(dstr);
4207 if (sflags & SVf_IOK)
4208 SvFLAGS(dstr) |= SVf_IOK;
4209 if (sflags & SVf_IVisUV)
4211 SvIV_set(dstr, SvIVX(sstr));
4214 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4215 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4216 smg->mg_ptr, smg->mg_len);
4217 SvRMAGICAL_on(dstr);
4220 else if (sflags & SVp_IOK) {
4221 if (sflags & SVf_IOK)
4222 (void)SvIOK_only(dstr);
4224 (void)SvOK_off(dstr);
4225 (void)SvIOKp_on(dstr);
4227 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4228 if (sflags & SVf_IVisUV)
4230 SvIV_set(dstr, SvIVX(sstr));
4231 if (sflags & SVp_NOK) {
4232 if (sflags & SVf_NOK)
4233 (void)SvNOK_on(dstr);
4235 (void)SvNOKp_on(dstr);
4236 SvNV_set(dstr, SvNVX(sstr));
4239 else if (sflags & SVp_NOK) {
4240 if (sflags & SVf_NOK)
4241 (void)SvNOK_only(dstr);
4243 (void)SvOK_off(dstr);
4246 SvNV_set(dstr, SvNVX(sstr));
4249 if (dtype == SVt_PVGV) {
4250 if (ckWARN(WARN_MISC))
4251 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4254 (void)SvOK_off(dstr);
4256 if (SvTAINTED(sstr))
4261 =for apidoc sv_setsv_mg
4263 Like C<sv_setsv>, but also handles 'set' magic.
4269 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4271 sv_setsv(dstr,sstr);
4275 #ifdef PERL_OLD_COPY_ON_WRITE
4277 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4279 STRLEN cur = SvCUR(sstr);
4280 STRLEN len = SvLEN(sstr);
4281 register char *new_pv;
4284 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4292 if (SvTHINKFIRST(dstr))
4293 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4294 else if (SvPVX_const(dstr))
4295 Safefree(SvPVX_const(dstr));
4299 SvUPGRADE(dstr, SVt_PVIV);
4301 assert (SvPOK(sstr));
4302 assert (SvPOKp(sstr));
4303 assert (!SvIOK(sstr));
4304 assert (!SvIOKp(sstr));
4305 assert (!SvNOK(sstr));
4306 assert (!SvNOKp(sstr));
4308 if (SvIsCOW(sstr)) {
4310 if (SvLEN(sstr) == 0) {
4311 /* source is a COW shared hash key. */
4312 DEBUG_C(PerlIO_printf(Perl_debug_log,
4313 "Fast copy on write: Sharing hash\n"));
4314 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4317 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4319 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4320 SvUPGRADE(sstr, SVt_PVIV);
4321 SvREADONLY_on(sstr);
4323 DEBUG_C(PerlIO_printf(Perl_debug_log,
4324 "Fast copy on write: Converting sstr to COW\n"));
4325 SV_COW_NEXT_SV_SET(dstr, sstr);
4327 SV_COW_NEXT_SV_SET(sstr, dstr);
4328 new_pv = SvPVX_mutable(sstr);
4331 SvPV_set(dstr, new_pv);
4332 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4335 SvLEN_set(dstr, len);
4336 SvCUR_set(dstr, cur);
4345 =for apidoc sv_setpvn
4347 Copies a string into an SV. The C<len> parameter indicates the number of
4348 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4349 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4355 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4357 register char *dptr;
4359 SV_CHECK_THINKFIRST_COW_DROP(sv);
4365 /* len is STRLEN which is unsigned, need to copy to signed */
4368 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4370 SvUPGRADE(sv, SVt_PV);
4372 dptr = SvGROW(sv, len + 1);
4373 Move(ptr,dptr,len,char);
4376 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4381 =for apidoc sv_setpvn_mg
4383 Like C<sv_setpvn>, but also handles 'set' magic.
4389 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4391 sv_setpvn(sv,ptr,len);
4396 =for apidoc sv_setpv
4398 Copies a string into an SV. The string must be null-terminated. Does not
4399 handle 'set' magic. See C<sv_setpv_mg>.
4405 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4407 register STRLEN len;
4409 SV_CHECK_THINKFIRST_COW_DROP(sv);
4415 SvUPGRADE(sv, SVt_PV);
4417 SvGROW(sv, len + 1);
4418 Move(ptr,SvPVX(sv),len+1,char);
4420 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4425 =for apidoc sv_setpv_mg
4427 Like C<sv_setpv>, but also handles 'set' magic.
4433 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4440 =for apidoc sv_usepvn
4442 Tells an SV to use C<ptr> to find its string value. Normally the string is
4443 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4444 The C<ptr> should point to memory that was allocated by C<malloc>. The
4445 string length, C<len>, must be supplied. This function will realloc the
4446 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4447 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4448 See C<sv_usepvn_mg>.
4454 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4457 SV_CHECK_THINKFIRST_COW_DROP(sv);
4458 SvUPGRADE(sv, SVt_PV);
4463 if (SvPVX_const(sv))
4466 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4467 ptr = saferealloc (ptr, allocate);
4470 SvLEN_set(sv, allocate);
4472 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4477 =for apidoc sv_usepvn_mg
4479 Like C<sv_usepvn>, but also handles 'set' magic.
4485 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4487 sv_usepvn(sv,ptr,len);
4491 #ifdef PERL_OLD_COPY_ON_WRITE
4492 /* Need to do this *after* making the SV normal, as we need the buffer
4493 pointer to remain valid until after we've copied it. If we let go too early,
4494 another thread could invalidate it by unsharing last of the same hash key
4495 (which it can do by means other than releasing copy-on-write Svs)
4496 or by changing the other copy-on-write SVs in the loop. */
4498 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4500 if (len) { /* this SV was SvIsCOW_normal(sv) */
4501 /* we need to find the SV pointing to us. */
4502 SV * const current = SV_COW_NEXT_SV(after);
4504 if (current == sv) {
4505 /* The SV we point to points back to us (there were only two of us
4507 Hence other SV is no longer copy on write either. */
4509 SvREADONLY_off(after);
4511 /* We need to follow the pointers around the loop. */
4513 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4516 /* don't loop forever if the structure is bust, and we have
4517 a pointer into a closed loop. */
4518 assert (current != after);
4519 assert (SvPVX_const(current) == pvx);
4521 /* Make the SV before us point to the SV after us. */
4522 SV_COW_NEXT_SV_SET(current, after);
4525 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4530 Perl_sv_release_IVX(pTHX_ register SV *sv)
4533 sv_force_normal_flags(sv, 0);
4539 =for apidoc sv_force_normal_flags
4541 Undo various types of fakery on an SV: if the PV is a shared string, make
4542 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4543 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4544 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4545 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4546 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4547 set to some other value.) In addition, the C<flags> parameter gets passed to
4548 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4549 with flags set to 0.
4555 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4557 #ifdef PERL_OLD_COPY_ON_WRITE
4558 if (SvREADONLY(sv)) {
4559 /* At this point I believe I should acquire a global SV mutex. */
4561 const char * const pvx = SvPVX_const(sv);
4562 const STRLEN len = SvLEN(sv);
4563 const STRLEN cur = SvCUR(sv);
4564 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4566 PerlIO_printf(Perl_debug_log,
4567 "Copy on write: Force normal %ld\n",
4573 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4574 SvPV_set(sv, (char*)0);
4576 if (flags & SV_COW_DROP_PV) {
4577 /* OK, so we don't need to copy our buffer. */
4580 SvGROW(sv, cur + 1);
4581 Move(pvx,SvPVX(sv),cur,char);
4585 sv_release_COW(sv, pvx, len, next);
4590 else if (IN_PERL_RUNTIME)
4591 Perl_croak(aTHX_ PL_no_modify);
4592 /* At this point I believe that I can drop the global SV mutex. */
4595 if (SvREADONLY(sv)) {
4597 const char * const pvx = SvPVX_const(sv);
4598 const STRLEN len = SvCUR(sv);
4601 SvPV_set(sv, Nullch);
4603 SvGROW(sv, len + 1);
4604 Move(pvx,SvPVX(sv),len,char);
4606 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4608 else if (IN_PERL_RUNTIME)
4609 Perl_croak(aTHX_ PL_no_modify);
4613 sv_unref_flags(sv, flags);
4614 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4619 =for apidoc sv_force_normal
4621 Undo various types of fakery on an SV: if the PV is a shared string, make
4622 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4623 an xpvmg. See also C<sv_force_normal_flags>.
4629 Perl_sv_force_normal(pTHX_ register SV *sv)
4631 sv_force_normal_flags(sv, 0);
4637 Efficient removal of characters from the beginning of the string buffer.
4638 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4639 the string buffer. The C<ptr> becomes the first character of the adjusted
4640 string. Uses the "OOK hack".
4641 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4642 refer to the same chunk of data.
4648 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4650 register STRLEN delta;
4651 if (!ptr || !SvPOKp(sv))
4653 delta = ptr - SvPVX_const(sv);
4654 SV_CHECK_THINKFIRST(sv);
4655 if (SvTYPE(sv) < SVt_PVIV)
4656 sv_upgrade(sv,SVt_PVIV);
4659 if (!SvLEN(sv)) { /* make copy of shared string */
4660 const char *pvx = SvPVX_const(sv);
4661 const STRLEN len = SvCUR(sv);
4662 SvGROW(sv, len + 1);
4663 Move(pvx,SvPVX(sv),len,char);
4667 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4668 and we do that anyway inside the SvNIOK_off
4670 SvFLAGS(sv) |= SVf_OOK;
4673 SvLEN_set(sv, SvLEN(sv) - delta);
4674 SvCUR_set(sv, SvCUR(sv) - delta);
4675 SvPV_set(sv, SvPVX(sv) + delta);
4676 SvIV_set(sv, SvIVX(sv) + delta);
4679 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4680 * this function provided for binary compatibility only
4684 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4686 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4690 =for apidoc sv_catpvn
4692 Concatenates the string onto the end of the string which is in the SV. The
4693 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4694 status set, then the bytes appended should be valid UTF-8.
4695 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4697 =for apidoc sv_catpvn_flags
4699 Concatenates the string onto the end of the string which is in the SV. The
4700 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4701 status set, then the bytes appended should be valid UTF-8.
4702 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4703 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4704 in terms of this function.
4710 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4713 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4715 SvGROW(dsv, dlen + slen + 1);
4717 sstr = SvPVX_const(dsv);
4718 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4719 SvCUR_set(dsv, SvCUR(dsv) + slen);
4721 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4726 =for apidoc sv_catpvn_mg
4728 Like C<sv_catpvn>, but also handles 'set' magic.
4734 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4736 sv_catpvn(sv,ptr,len);
4740 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4741 * this function provided for binary compatibility only
4745 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4747 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4751 =for apidoc sv_catsv
4753 Concatenates the string from SV C<ssv> onto the end of the string in
4754 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4755 not 'set' magic. See C<sv_catsv_mg>.
4757 =for apidoc sv_catsv_flags
4759 Concatenates the string from SV C<ssv> onto the end of the string in
4760 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4761 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4762 and C<sv_catsv_nomg> are implemented in terms of this function.
4767 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4773 if ((spv = SvPV_const(ssv, slen))) {
4774 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4775 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4776 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4777 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4778 dsv->sv_flags doesn't have that bit set.
4779 Andy Dougherty 12 Oct 2001
4781 const I32 sutf8 = DO_UTF8(ssv);
4784 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4786 dutf8 = DO_UTF8(dsv);
4788 if (dutf8 != sutf8) {
4790 /* Not modifying source SV, so taking a temporary copy. */
4791 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4793 sv_utf8_upgrade(csv);
4794 spv = SvPV_const(csv, slen);
4797 sv_utf8_upgrade_nomg(dsv);
4799 sv_catpvn_nomg(dsv, spv, slen);
4804 =for apidoc sv_catsv_mg
4806 Like C<sv_catsv>, but also handles 'set' magic.
4812 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4819 =for apidoc sv_catpv
4821 Concatenates the string onto the end of the string which is in the SV.
4822 If the SV has the UTF-8 status set, then the bytes appended should be
4823 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4828 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4830 register STRLEN len;
4836 junk = SvPV_force(sv, tlen);
4838 SvGROW(sv, tlen + len + 1);
4840 ptr = SvPVX_const(sv);
4841 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4842 SvCUR_set(sv, SvCUR(sv) + len);
4843 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4848 =for apidoc sv_catpv_mg
4850 Like C<sv_catpv>, but also handles 'set' magic.
4856 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4865 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4866 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4873 Perl_newSV(pTHX_ STRLEN len)
4879 sv_upgrade(sv, SVt_PV);
4880 SvGROW(sv, len + 1);
4885 =for apidoc sv_magicext
4887 Adds magic to an SV, upgrading it if necessary. Applies the
4888 supplied vtable and returns a pointer to the magic added.
4890 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4891 In particular, you can add magic to SvREADONLY SVs, and add more than
4892 one instance of the same 'how'.
4894 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4895 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4896 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4897 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4899 (This is now used as a subroutine by C<sv_magic>.)
4904 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4905 const char* name, I32 namlen)
4909 if (SvTYPE(sv) < SVt_PVMG) {
4910 SvUPGRADE(sv, SVt_PVMG);
4912 Newxz(mg, 1, MAGIC);
4913 mg->mg_moremagic = SvMAGIC(sv);
4914 SvMAGIC_set(sv, mg);
4916 /* Sometimes a magic contains a reference loop, where the sv and
4917 object refer to each other. To prevent a reference loop that
4918 would prevent such objects being freed, we look for such loops
4919 and if we find one we avoid incrementing the object refcount.
4921 Note we cannot do this to avoid self-tie loops as intervening RV must
4922 have its REFCNT incremented to keep it in existence.
4925 if (!obj || obj == sv ||
4926 how == PERL_MAGIC_arylen ||
4927 how == PERL_MAGIC_qr ||
4928 how == PERL_MAGIC_symtab ||
4929 (SvTYPE(obj) == SVt_PVGV &&
4930 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4931 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4932 GvFORM(obj) == (CV*)sv)))
4937 mg->mg_obj = SvREFCNT_inc(obj);
4938 mg->mg_flags |= MGf_REFCOUNTED;
4941 /* Normal self-ties simply pass a null object, and instead of
4942 using mg_obj directly, use the SvTIED_obj macro to produce a
4943 new RV as needed. For glob "self-ties", we are tieing the PVIO
4944 with an RV obj pointing to the glob containing the PVIO. In
4945 this case, to avoid a reference loop, we need to weaken the
4949 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4950 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4956 mg->mg_len = namlen;
4959 mg->mg_ptr = savepvn(name, namlen);
4960 else if (namlen == HEf_SVKEY)
4961 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4963 mg->mg_ptr = (char *) name;
4965 mg->mg_virtual = vtable;
4969 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4974 =for apidoc sv_magic
4976 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4977 then adds a new magic item of type C<how> to the head of the magic list.
4979 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4980 handling of the C<name> and C<namlen> arguments.
4982 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4983 to add more than one instance of the same 'how'.
4989 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4991 const MGVTBL *vtable;
4994 #ifdef PERL_OLD_COPY_ON_WRITE
4996 sv_force_normal_flags(sv, 0);
4998 if (SvREADONLY(sv)) {
5000 /* its okay to attach magic to shared strings; the subsequent
5001 * upgrade to PVMG will unshare the string */
5002 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5005 && how != PERL_MAGIC_regex_global
5006 && how != PERL_MAGIC_bm
5007 && how != PERL_MAGIC_fm
5008 && how != PERL_MAGIC_sv
5009 && how != PERL_MAGIC_backref
5012 Perl_croak(aTHX_ PL_no_modify);
5015 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5016 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5017 /* sv_magic() refuses to add a magic of the same 'how' as an
5020 if (how == PERL_MAGIC_taint)
5028 vtable = &PL_vtbl_sv;
5030 case PERL_MAGIC_overload:
5031 vtable = &PL_vtbl_amagic;
5033 case PERL_MAGIC_overload_elem:
5034 vtable = &PL_vtbl_amagicelem;
5036 case PERL_MAGIC_overload_table:
5037 vtable = &PL_vtbl_ovrld;
5040 vtable = &PL_vtbl_bm;
5042 case PERL_MAGIC_regdata:
5043 vtable = &PL_vtbl_regdata;
5045 case PERL_MAGIC_regdatum:
5046 vtable = &PL_vtbl_regdatum;
5048 case PERL_MAGIC_env:
5049 vtable = &PL_vtbl_env;
5052 vtable = &PL_vtbl_fm;
5054 case PERL_MAGIC_envelem:
5055 vtable = &PL_vtbl_envelem;
5057 case PERL_MAGIC_regex_global:
5058 vtable = &PL_vtbl_mglob;
5060 case PERL_MAGIC_isa:
5061 vtable = &PL_vtbl_isa;
5063 case PERL_MAGIC_isaelem:
5064 vtable = &PL_vtbl_isaelem;
5066 case PERL_MAGIC_nkeys:
5067 vtable = &PL_vtbl_nkeys;
5069 case PERL_MAGIC_dbfile:
5072 case PERL_MAGIC_dbline:
5073 vtable = &PL_vtbl_dbline;
5075 #ifdef USE_LOCALE_COLLATE
5076 case PERL_MAGIC_collxfrm:
5077 vtable = &PL_vtbl_collxfrm;
5079 #endif /* USE_LOCALE_COLLATE */
5080 case PERL_MAGIC_tied:
5081 vtable = &PL_vtbl_pack;
5083 case PERL_MAGIC_tiedelem:
5084 case PERL_MAGIC_tiedscalar:
5085 vtable = &PL_vtbl_packelem;
5088 vtable = &PL_vtbl_regexp;
5090 case PERL_MAGIC_sig:
5091 vtable = &PL_vtbl_sig;
5093 case PERL_MAGIC_sigelem:
5094 vtable = &PL_vtbl_sigelem;
5096 case PERL_MAGIC_taint:
5097 vtable = &PL_vtbl_taint;
5099 case PERL_MAGIC_uvar:
5100 vtable = &PL_vtbl_uvar;
5102 case PERL_MAGIC_vec:
5103 vtable = &PL_vtbl_vec;
5105 case PERL_MAGIC_arylen_p:
5106 case PERL_MAGIC_rhash:
5107 case PERL_MAGIC_symtab:
5108 case PERL_MAGIC_vstring:
5111 case PERL_MAGIC_utf8:
5112 vtable = &PL_vtbl_utf8;
5114 case PERL_MAGIC_substr:
5115 vtable = &PL_vtbl_substr;
5117 case PERL_MAGIC_defelem:
5118 vtable = &PL_vtbl_defelem;
5120 case PERL_MAGIC_glob:
5121 vtable = &PL_vtbl_glob;
5123 case PERL_MAGIC_arylen:
5124 vtable = &PL_vtbl_arylen;
5126 case PERL_MAGIC_pos:
5127 vtable = &PL_vtbl_pos;
5129 case PERL_MAGIC_backref:
5130 vtable = &PL_vtbl_backref;
5132 case PERL_MAGIC_ext:
5133 /* Reserved for use by extensions not perl internals. */
5134 /* Useful for attaching extension internal data to perl vars. */
5135 /* Note that multiple extensions may clash if magical scalars */
5136 /* etc holding private data from one are passed to another. */
5140 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5143 /* Rest of work is done else where */
5144 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5147 case PERL_MAGIC_taint:
5150 case PERL_MAGIC_ext:
5151 case PERL_MAGIC_dbfile:
5158 =for apidoc sv_unmagic
5160 Removes all magic of type C<type> from an SV.
5166 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5170 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5173 for (mg = *mgp; mg; mg = *mgp) {
5174 if (mg->mg_type == type) {
5175 const MGVTBL* const vtbl = mg->mg_virtual;
5176 *mgp = mg->mg_moremagic;
5177 if (vtbl && vtbl->svt_free)
5178 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5179 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5181 Safefree(mg->mg_ptr);
5182 else if (mg->mg_len == HEf_SVKEY)
5183 SvREFCNT_dec((SV*)mg->mg_ptr);
5184 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5185 Safefree(mg->mg_ptr);
5187 if (mg->mg_flags & MGf_REFCOUNTED)
5188 SvREFCNT_dec(mg->mg_obj);
5192 mgp = &mg->mg_moremagic;
5196 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5203 =for apidoc sv_rvweaken
5205 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5206 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5207 push a back-reference to this RV onto the array of backreferences
5208 associated with that magic.
5214 Perl_sv_rvweaken(pTHX_ SV *sv)
5217 if (!SvOK(sv)) /* let undefs pass */
5220 Perl_croak(aTHX_ "Can't weaken a nonreference");
5221 else if (SvWEAKREF(sv)) {
5222 if (ckWARN(WARN_MISC))
5223 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5227 Perl_sv_add_backref(aTHX_ tsv, sv);
5233 /* Give tsv backref magic if it hasn't already got it, then push a
5234 * back-reference to sv onto the array associated with the backref magic.
5238 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5242 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5243 av = (AV*)mg->mg_obj;
5246 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5247 /* av now has a refcnt of 2, which avoids it getting freed
5248 * before us during global cleanup. The extra ref is removed
5249 * by magic_killbackrefs() when tsv is being freed */
5251 if (AvFILLp(av) >= AvMAX(av)) {
5252 av_extend(av, AvFILLp(av)+1);
5254 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5257 /* delete a back-reference to ourselves from the backref magic associated
5258 * with the SV we point to.
5262 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5268 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5269 if (PL_in_clean_all)
5272 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5273 Perl_croak(aTHX_ "panic: del_backref");
5274 av = (AV *)mg->mg_obj;
5276 /* We shouldn't be in here more than once, but for paranoia reasons lets
5278 for (i = AvFILLp(av); i >= 0; i--) {
5280 const SSize_t fill = AvFILLp(av);
5282 /* We weren't the last entry.
5283 An unordered list has this property that you can take the
5284 last element off the end to fill the hole, and it's still
5285 an unordered list :-)
5290 AvFILLp(av) = fill - 1;
5296 =for apidoc sv_insert
5298 Inserts a string at the specified offset/length within the SV. Similar to
5299 the Perl substr() function.
5305 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5309 register char *midend;
5310 register char *bigend;
5316 Perl_croak(aTHX_ "Can't modify non-existent substring");
5317 SvPV_force(bigstr, curlen);
5318 (void)SvPOK_only_UTF8(bigstr);
5319 if (offset + len > curlen) {
5320 SvGROW(bigstr, offset+len+1);
5321 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5322 SvCUR_set(bigstr, offset+len);
5326 i = littlelen - len;
5327 if (i > 0) { /* string might grow */
5328 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5329 mid = big + offset + len;
5330 midend = bigend = big + SvCUR(bigstr);
5333 while (midend > mid) /* shove everything down */
5334 *--bigend = *--midend;
5335 Move(little,big+offset,littlelen,char);
5336 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5341 Move(little,SvPVX(bigstr)+offset,len,char);
5346 big = SvPVX(bigstr);
5349 bigend = big + SvCUR(bigstr);
5351 if (midend > bigend)
5352 Perl_croak(aTHX_ "panic: sv_insert");
5354 if (mid - big > bigend - midend) { /* faster to shorten from end */
5356 Move(little, mid, littlelen,char);
5359 i = bigend - midend;
5361 Move(midend, mid, i,char);
5365 SvCUR_set(bigstr, mid - big);
5367 else if ((i = mid - big)) { /* faster from front */
5368 midend -= littlelen;
5370 sv_chop(bigstr,midend-i);
5375 Move(little, mid, littlelen,char);
5377 else if (littlelen) {
5378 midend -= littlelen;
5379 sv_chop(bigstr,midend);
5380 Move(little,midend,littlelen,char);
5383 sv_chop(bigstr,midend);
5389 =for apidoc sv_replace
5391 Make the first argument a copy of the second, then delete the original.
5392 The target SV physically takes over ownership of the body of the source SV
5393 and inherits its flags; however, the target keeps any magic it owns,
5394 and any magic in the source is discarded.
5395 Note that this is a rather specialist SV copying operation; most of the
5396 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5402 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5404 const U32 refcnt = SvREFCNT(sv);
5405 SV_CHECK_THINKFIRST_COW_DROP(sv);
5406 if (SvREFCNT(nsv) != 1) {
5407 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5408 UVuf " != 1)", (UV) SvREFCNT(nsv));
5410 if (SvMAGICAL(sv)) {
5414 sv_upgrade(nsv, SVt_PVMG);
5415 SvMAGIC_set(nsv, SvMAGIC(sv));
5416 SvFLAGS(nsv) |= SvMAGICAL(sv);
5418 SvMAGIC_set(sv, NULL);
5422 assert(!SvREFCNT(sv));
5423 #ifdef DEBUG_LEAKING_SCALARS
5424 sv->sv_flags = nsv->sv_flags;
5425 sv->sv_any = nsv->sv_any;
5426 sv->sv_refcnt = nsv->sv_refcnt;
5427 sv->sv_u = nsv->sv_u;
5429 StructCopy(nsv,sv,SV);
5431 /* Currently could join these into one piece of pointer arithmetic, but
5432 it would be unclear. */
5433 if(SvTYPE(sv) == SVt_IV)
5435 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5436 else if (SvTYPE(sv) == SVt_RV) {
5437 SvANY(sv) = &sv->sv_u.svu_rv;
5441 #ifdef PERL_OLD_COPY_ON_WRITE
5442 if (SvIsCOW_normal(nsv)) {
5443 /* We need to follow the pointers around the loop to make the
5444 previous SV point to sv, rather than nsv. */
5447 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5450 assert(SvPVX_const(current) == SvPVX_const(nsv));
5452 /* Make the SV before us point to the SV after us. */
5454 PerlIO_printf(Perl_debug_log, "previous is\n");
5456 PerlIO_printf(Perl_debug_log,
5457 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5458 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5460 SV_COW_NEXT_SV_SET(current, sv);
5463 SvREFCNT(sv) = refcnt;
5464 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5470 =for apidoc sv_clear
5472 Clear an SV: call any destructors, free up any memory used by the body,
5473 and free the body itself. The SV's head is I<not> freed, although
5474 its type is set to all 1's so that it won't inadvertently be assumed
5475 to be live during global destruction etc.
5476 This function should only be called when REFCNT is zero. Most of the time
5477 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5484 Perl_sv_clear(pTHX_ register SV *sv)
5487 void** old_body_arena;
5488 size_t old_body_offset;
5489 const U32 type = SvTYPE(sv);
5492 assert(SvREFCNT(sv) == 0);
5498 old_body_offset = 0;
5501 if (PL_defstash) { /* Still have a symbol table? */
5506 stash = SvSTASH(sv);
5507 destructor = StashHANDLER(stash,DESTROY);
5509 SV* const tmpref = newRV(sv);
5510 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5512 PUSHSTACKi(PERLSI_DESTROY);
5517 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5523 if(SvREFCNT(tmpref) < 2) {
5524 /* tmpref is not kept alive! */
5526 SvRV_set(tmpref, NULL);
5529 SvREFCNT_dec(tmpref);
5531 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5535 if (PL_in_clean_objs)
5536 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5538 /* DESTROY gave object new lease on life */
5544 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5545 SvOBJECT_off(sv); /* Curse the object. */
5546 if (type != SVt_PVIO)
5547 --PL_sv_objcount; /* XXX Might want something more general */
5550 if (type >= SVt_PVMG) {
5553 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5554 SvREFCNT_dec(SvSTASH(sv));
5559 IoIFP(sv) != PerlIO_stdin() &&
5560 IoIFP(sv) != PerlIO_stdout() &&
5561 IoIFP(sv) != PerlIO_stderr())
5563 io_close((IO*)sv, FALSE);
5565 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5566 PerlDir_close(IoDIRP(sv));
5567 IoDIRP(sv) = (DIR*)NULL;
5568 Safefree(IoTOP_NAME(sv));
5569 Safefree(IoFMT_NAME(sv));
5570 Safefree(IoBOTTOM_NAME(sv));
5571 /* PVIOs aren't from arenas */
5574 old_body_arena = (void **) &PL_xpvbm_root;
5577 old_body_arena = (void **) &PL_xpvcv_root;
5579 /* PVFMs aren't from arenas */
5584 old_body_arena = (void **) &PL_xpvhv_root;
5585 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5589 old_body_arena = (void **) &PL_xpvav_root;
5590 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5593 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5594 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5595 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5596 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5598 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5599 SvREFCNT_dec(LvTARG(sv));
5600 old_body_arena = (void **) &PL_xpvlv_root;
5604 Safefree(GvNAME(sv));
5605 /* If we're in a stash, we don't own a reference to it. However it does
5606 have a back reference to us, which needs to be cleared. */
5608 sv_del_backref((SV*)GvSTASH(sv), sv);
5609 old_body_arena = (void **) &PL_xpvgv_root;
5612 old_body_arena = (void **) &PL_xpvmg_root;
5615 old_body_arena = (void **) &PL_xpvnv_root;
5618 old_body_arena = (void **) &PL_xpviv_root;
5619 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5621 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5623 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5624 /* Don't even bother with turning off the OOK flag. */
5628 old_body_arena = (void **) &PL_xpv_root;
5629 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5633 SV *target = SvRV(sv);
5635 sv_del_backref(target, sv);
5637 SvREFCNT_dec(target);
5639 #ifdef PERL_OLD_COPY_ON_WRITE
5640 else if (SvPVX_const(sv)) {
5642 /* I believe I need to grab the global SV mutex here and
5643 then recheck the COW status. */
5645 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5648 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5649 SV_COW_NEXT_SV(sv));
5650 /* And drop it here. */
5652 } else if (SvLEN(sv)) {
5653 Safefree(SvPVX_const(sv));
5657 else if (SvPVX_const(sv) && SvLEN(sv))
5658 Safefree(SvPVX_mutable(sv));
5659 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5660 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5666 old_body_arena = (void **) &PL_xnv_root;
5670 SvFLAGS(sv) &= SVf_BREAK;
5671 SvFLAGS(sv) |= SVTYPEMASK;
5674 if (old_body_arena) {
5675 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5679 if (type > SVt_RV) {
5680 my_safefree(SvANY(sv));
5685 =for apidoc sv_newref
5687 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5694 Perl_sv_newref(pTHX_ SV *sv)
5704 Decrement an SV's reference count, and if it drops to zero, call
5705 C<sv_clear> to invoke destructors and free up any memory used by
5706 the body; finally, deallocate the SV's head itself.
5707 Normally called via a wrapper macro C<SvREFCNT_dec>.
5713 Perl_sv_free(pTHX_ SV *sv)
5718 if (SvREFCNT(sv) == 0) {
5719 if (SvFLAGS(sv) & SVf_BREAK)
5720 /* this SV's refcnt has been artificially decremented to
5721 * trigger cleanup */
5723 if (PL_in_clean_all) /* All is fair */
5725 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5726 /* make sure SvREFCNT(sv)==0 happens very seldom */
5727 SvREFCNT(sv) = (~(U32)0)/2;
5730 if (ckWARN_d(WARN_INTERNAL)) {
5731 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5732 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5733 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5734 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5735 Perl_dump_sv_child(aTHX_ sv);
5740 if (--(SvREFCNT(sv)) > 0)
5742 Perl_sv_free2(aTHX_ sv);
5746 Perl_sv_free2(pTHX_ SV *sv)
5751 if (ckWARN_d(WARN_DEBUGGING))
5752 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5753 "Attempt to free temp prematurely: SV 0x%"UVxf
5754 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5758 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5759 /* make sure SvREFCNT(sv)==0 happens very seldom */
5760 SvREFCNT(sv) = (~(U32)0)/2;
5771 Returns the length of the string in the SV. Handles magic and type
5772 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5778 Perl_sv_len(pTHX_ register SV *sv)
5786 len = mg_length(sv);
5788 (void)SvPV_const(sv, len);
5793 =for apidoc sv_len_utf8
5795 Returns the number of characters in the string in an SV, counting wide
5796 UTF-8 bytes as a single character. Handles magic and type coercion.
5802 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5803 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5804 * (Note that the mg_len is not the length of the mg_ptr field.)
5809 Perl_sv_len_utf8(pTHX_ register SV *sv)
5815 return mg_length(sv);
5819 const U8 *s = (U8*)SvPV_const(sv, len);
5820 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5822 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5824 #ifdef PERL_UTF8_CACHE_ASSERT
5825 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5829 ulen = Perl_utf8_length(aTHX_ s, s + len);
5830 if (!mg && !SvREADONLY(sv)) {
5831 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5832 mg = mg_find(sv, PERL_MAGIC_utf8);
5842 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5843 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5844 * between UTF-8 and byte offsets. There are two (substr offset and substr
5845 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5846 * and byte offset) cache positions.
5848 * The mg_len field is used by sv_len_utf8(), see its comments.
5849 * Note that the mg_len is not the length of the mg_ptr field.
5853 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5854 I32 offsetp, const U8 *s, const U8 *start)
5858 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5860 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5864 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5866 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5867 (*mgp)->mg_ptr = (char *) *cachep;
5871 (*cachep)[i] = offsetp;
5872 (*cachep)[i+1] = s - start;
5880 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5881 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5882 * between UTF-8 and byte offsets. See also the comments of
5883 * S_utf8_mg_pos_init().
5887 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5891 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5893 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5894 if (*mgp && (*mgp)->mg_ptr) {
5895 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5896 ASSERT_UTF8_CACHE(*cachep);
5897 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5899 else { /* We will skip to the right spot. */
5904 /* The assumption is that going backward is half
5905 * the speed of going forward (that's where the
5906 * 2 * backw in the below comes from). (The real
5907 * figure of course depends on the UTF-8 data.) */
5909 if ((*cachep)[i] > (STRLEN)uoff) {
5911 backw = (*cachep)[i] - (STRLEN)uoff;
5913 if (forw < 2 * backw)
5916 p = start + (*cachep)[i+1];
5918 /* Try this only for the substr offset (i == 0),
5919 * not for the substr length (i == 2). */
5920 else if (i == 0) { /* (*cachep)[i] < uoff */
5921 const STRLEN ulen = sv_len_utf8(sv);
5923 if ((STRLEN)uoff < ulen) {
5924 forw = (STRLEN)uoff - (*cachep)[i];
5925 backw = ulen - (STRLEN)uoff;
5927 if (forw < 2 * backw)
5928 p = start + (*cachep)[i+1];
5933 /* If the string is not long enough for uoff,
5934 * we could extend it, but not at this low a level. */
5938 if (forw < 2 * backw) {
5945 while (UTF8_IS_CONTINUATION(*p))
5950 /* Update the cache. */
5951 (*cachep)[i] = (STRLEN)uoff;
5952 (*cachep)[i+1] = p - start;
5954 /* Drop the stale "length" cache */
5963 if (found) { /* Setup the return values. */
5964 *offsetp = (*cachep)[i+1];
5965 *sp = start + *offsetp;
5968 *offsetp = send - start;
5970 else if (*sp < start) {
5976 #ifdef PERL_UTF8_CACHE_ASSERT
5981 while (n-- && s < send)
5985 assert(*offsetp == s - start);
5986 assert((*cachep)[0] == (STRLEN)uoff);
5987 assert((*cachep)[1] == *offsetp);
5989 ASSERT_UTF8_CACHE(*cachep);
5998 =for apidoc sv_pos_u2b
6000 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6001 the start of the string, to a count of the equivalent number of bytes; if
6002 lenp is non-zero, it does the same to lenp, but this time starting from
6003 the offset, rather than from the start of the string. Handles magic and
6010 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6011 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6012 * byte offsets. See also the comments of S_utf8_mg_pos().
6017 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6025 start = (U8*)SvPV_const(sv, len);
6029 const U8 *s = start;
6030 I32 uoffset = *offsetp;
6031 const U8 * const send = s + len;
6035 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6037 if (!found && uoffset > 0) {
6038 while (s < send && uoffset--)
6042 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6044 *offsetp = s - start;
6049 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6053 if (!found && *lenp > 0) {
6056 while (s < send && ulen--)
6060 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6064 ASSERT_UTF8_CACHE(cache);
6076 =for apidoc sv_pos_b2u
6078 Converts the value pointed to by offsetp from a count of bytes from the
6079 start of the string, to a count of the equivalent number of UTF-8 chars.
6080 Handles magic and type coercion.
6086 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6087 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6088 * byte offsets. See also the comments of S_utf8_mg_pos().
6093 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6101 s = (const U8*)SvPV_const(sv, len);
6102 if ((I32)len < *offsetp)
6103 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6105 const U8* send = s + *offsetp;
6107 STRLEN *cache = NULL;
6111 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6112 mg = mg_find(sv, PERL_MAGIC_utf8);
6113 if (mg && mg->mg_ptr) {
6114 cache = (STRLEN *) mg->mg_ptr;
6115 if (cache[1] == (STRLEN)*offsetp) {
6116 /* An exact match. */
6117 *offsetp = cache[0];
6121 else if (cache[1] < (STRLEN)*offsetp) {
6122 /* We already know part of the way. */
6125 /* Let the below loop do the rest. */
6127 else { /* cache[1] > *offsetp */
6128 /* We already know all of the way, now we may
6129 * be able to walk back. The same assumption
6130 * is made as in S_utf8_mg_pos(), namely that
6131 * walking backward is twice slower than
6132 * walking forward. */
6133 const STRLEN forw = *offsetp;
6134 STRLEN backw = cache[1] - *offsetp;
6136 if (!(forw < 2 * backw)) {
6137 const U8 *p = s + cache[1];
6144 while (UTF8_IS_CONTINUATION(*p)) {
6152 *offsetp = cache[0];
6154 /* Drop the stale "length" cache */
6162 ASSERT_UTF8_CACHE(cache);
6168 /* Call utf8n_to_uvchr() to validate the sequence
6169 * (unless a simple non-UTF character) */
6170 if (!UTF8_IS_INVARIANT(*s))
6171 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6180 if (!SvREADONLY(sv)) {
6182 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6183 mg = mg_find(sv, PERL_MAGIC_utf8);
6188 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6189 mg->mg_ptr = (char *) cache;
6194 cache[1] = *offsetp;
6195 /* Drop the stale "length" cache */
6208 Returns a boolean indicating whether the strings in the two SVs are
6209 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6210 coerce its args to strings if necessary.
6216 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6224 SV* svrecode = Nullsv;
6231 pv1 = SvPV_const(sv1, cur1);
6238 pv2 = SvPV_const(sv2, cur2);
6240 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6241 /* Differing utf8ness.
6242 * Do not UTF8size the comparands as a side-effect. */
6245 svrecode = newSVpvn(pv2, cur2);
6246 sv_recode_to_utf8(svrecode, PL_encoding);
6247 pv2 = SvPV_const(svrecode, cur2);
6250 svrecode = newSVpvn(pv1, cur1);
6251 sv_recode_to_utf8(svrecode, PL_encoding);
6252 pv1 = SvPV_const(svrecode, cur1);
6254 /* Now both are in UTF-8. */
6256 SvREFCNT_dec(svrecode);
6261 bool is_utf8 = TRUE;
6264 /* sv1 is the UTF-8 one,
6265 * if is equal it must be downgrade-able */
6266 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6272 /* sv2 is the UTF-8 one,
6273 * if is equal it must be downgrade-able */
6274 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6280 /* Downgrade not possible - cannot be eq */
6288 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6291 SvREFCNT_dec(svrecode);
6302 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6303 string in C<sv1> is less than, equal to, or greater than the string in
6304 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6305 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6311 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6314 const char *pv1, *pv2;
6317 SV *svrecode = Nullsv;
6324 pv1 = SvPV_const(sv1, cur1);
6331 pv2 = SvPV_const(sv2, cur2);
6333 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6334 /* Differing utf8ness.
6335 * Do not UTF8size the comparands as a side-effect. */
6338 svrecode = newSVpvn(pv2, cur2);
6339 sv_recode_to_utf8(svrecode, PL_encoding);
6340 pv2 = SvPV_const(svrecode, cur2);
6343 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6348 svrecode = newSVpvn(pv1, cur1);
6349 sv_recode_to_utf8(svrecode, PL_encoding);
6350 pv1 = SvPV_const(svrecode, cur1);
6353 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6359 cmp = cur2 ? -1 : 0;
6363 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6366 cmp = retval < 0 ? -1 : 1;
6367 } else if (cur1 == cur2) {
6370 cmp = cur1 < cur2 ? -1 : 1;
6375 SvREFCNT_dec(svrecode);
6384 =for apidoc sv_cmp_locale
6386 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6387 'use bytes' aware, handles get magic, and will coerce its args to strings
6388 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6394 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6396 #ifdef USE_LOCALE_COLLATE
6402 if (PL_collation_standard)
6406 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6408 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6410 if (!pv1 || !len1) {
6421 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6424 return retval < 0 ? -1 : 1;
6427 * When the result of collation is equality, that doesn't mean
6428 * that there are no differences -- some locales exclude some
6429 * characters from consideration. So to avoid false equalities,
6430 * we use the raw string as a tiebreaker.
6436 #endif /* USE_LOCALE_COLLATE */
6438 return sv_cmp(sv1, sv2);
6442 #ifdef USE_LOCALE_COLLATE
6445 =for apidoc sv_collxfrm
6447 Add Collate Transform magic to an SV if it doesn't already have it.
6449 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6450 scalar data of the variable, but transformed to such a format that a normal
6451 memory comparison can be used to compare the data according to the locale
6458 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6462 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6463 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6469 Safefree(mg->mg_ptr);
6470 s = SvPV_const(sv, len);
6471 if ((xf = mem_collxfrm(s, len, &xlen))) {
6472 if (SvREADONLY(sv)) {
6475 return xf + sizeof(PL_collation_ix);
6478 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6479 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6492 if (mg && mg->mg_ptr) {
6494 return mg->mg_ptr + sizeof(PL_collation_ix);
6502 #endif /* USE_LOCALE_COLLATE */
6507 Get a line from the filehandle and store it into the SV, optionally
6508 appending to the currently-stored string.
6514 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6518 register STDCHAR rslast;
6519 register STDCHAR *bp;
6525 if (SvTHINKFIRST(sv))
6526 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6527 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6529 However, perlbench says it's slower, because the existing swipe code
6530 is faster than copy on write.
6531 Swings and roundabouts. */
6532 SvUPGRADE(sv, SVt_PV);
6537 if (PerlIO_isutf8(fp)) {
6539 sv_utf8_upgrade_nomg(sv);
6540 sv_pos_u2b(sv,&append,0);
6542 } else if (SvUTF8(sv)) {
6543 SV * const tsv = NEWSV(0,0);
6544 sv_gets(tsv, fp, 0);
6545 sv_utf8_upgrade_nomg(tsv);
6546 SvCUR_set(sv,append);
6549 goto return_string_or_null;
6554 if (PerlIO_isutf8(fp))
6557 if (IN_PERL_COMPILETIME) {
6558 /* we always read code in line mode */
6562 else if (RsSNARF(PL_rs)) {
6563 /* If it is a regular disk file use size from stat() as estimate
6564 of amount we are going to read - may result in malloc-ing
6565 more memory than we realy need if layers bellow reduce
6566 size we read (e.g. CRLF or a gzip layer)
6569 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6570 const Off_t offset = PerlIO_tell(fp);
6571 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6572 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6578 else if (RsRECORD(PL_rs)) {
6582 /* Grab the size of the record we're getting */
6583 recsize = SvIV(SvRV(PL_rs));
6584 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6587 /* VMS wants read instead of fread, because fread doesn't respect */
6588 /* RMS record boundaries. This is not necessarily a good thing to be */
6589 /* doing, but we've got no other real choice - except avoid stdio
6590 as implementation - perhaps write a :vms layer ?
6592 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6594 bytesread = PerlIO_read(fp, buffer, recsize);
6598 SvCUR_set(sv, bytesread += append);
6599 buffer[bytesread] = '\0';
6600 goto return_string_or_null;
6602 else if (RsPARA(PL_rs)) {
6608 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6609 if (PerlIO_isutf8(fp)) {
6610 rsptr = SvPVutf8(PL_rs, rslen);
6613 if (SvUTF8(PL_rs)) {
6614 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6615 Perl_croak(aTHX_ "Wide character in $/");
6618 rsptr = SvPV_const(PL_rs, rslen);
6622 rslast = rslen ? rsptr[rslen - 1] : '\0';
6624 if (rspara) { /* have to do this both before and after */
6625 do { /* to make sure file boundaries work right */
6628 i = PerlIO_getc(fp);
6632 PerlIO_ungetc(fp,i);
6638 /* See if we know enough about I/O mechanism to cheat it ! */
6640 /* This used to be #ifdef test - it is made run-time test for ease
6641 of abstracting out stdio interface. One call should be cheap
6642 enough here - and may even be a macro allowing compile
6646 if (PerlIO_fast_gets(fp)) {
6649 * We're going to steal some values from the stdio struct
6650 * and put EVERYTHING in the innermost loop into registers.
6652 register STDCHAR *ptr;
6656 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6657 /* An ungetc()d char is handled separately from the regular
6658 * buffer, so we getc() it back out and stuff it in the buffer.
6660 i = PerlIO_getc(fp);
6661 if (i == EOF) return 0;
6662 *(--((*fp)->_ptr)) = (unsigned char) i;
6666 /* Here is some breathtakingly efficient cheating */
6668 cnt = PerlIO_get_cnt(fp); /* get count into register */
6669 /* make sure we have the room */
6670 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6671 /* Not room for all of it
6672 if we are looking for a separator and room for some
6674 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6675 /* just process what we have room for */
6676 shortbuffered = cnt - SvLEN(sv) + append + 1;
6677 cnt -= shortbuffered;
6681 /* remember that cnt can be negative */
6682 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6687 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6688 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6689 DEBUG_P(PerlIO_printf(Perl_debug_log,
6690 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6691 DEBUG_P(PerlIO_printf(Perl_debug_log,
6692 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6693 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6694 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6699 while (cnt > 0) { /* this | eat */
6701 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6702 goto thats_all_folks; /* screams | sed :-) */
6706 Copy(ptr, bp, cnt, char); /* this | eat */
6707 bp += cnt; /* screams | dust */
6708 ptr += cnt; /* louder | sed :-) */
6713 if (shortbuffered) { /* oh well, must extend */
6714 cnt = shortbuffered;
6716 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6718 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6719 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6723 DEBUG_P(PerlIO_printf(Perl_debug_log,
6724 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6725 PTR2UV(ptr),(long)cnt));
6726 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6728 DEBUG_P(PerlIO_printf(Perl_debug_log,
6729 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6730 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6731 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6733 /* This used to call 'filbuf' in stdio form, but as that behaves like
6734 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6735 another abstraction. */
6736 i = PerlIO_getc(fp); /* get more characters */
6738 DEBUG_P(PerlIO_printf(Perl_debug_log,
6739 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6740 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6741 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6743 cnt = PerlIO_get_cnt(fp);
6744 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6745 DEBUG_P(PerlIO_printf(Perl_debug_log,
6746 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6748 if (i == EOF) /* all done for ever? */
6749 goto thats_really_all_folks;
6751 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6753 SvGROW(sv, bpx + cnt + 2);
6754 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6756 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6758 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6759 goto thats_all_folks;
6763 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6764 memNE((char*)bp - rslen, rsptr, rslen))
6765 goto screamer; /* go back to the fray */
6766 thats_really_all_folks:
6768 cnt += shortbuffered;
6769 DEBUG_P(PerlIO_printf(Perl_debug_log,
6770 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6771 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6772 DEBUG_P(PerlIO_printf(Perl_debug_log,
6773 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6774 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6775 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6777 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6778 DEBUG_P(PerlIO_printf(Perl_debug_log,
6779 "Screamer: done, len=%ld, string=|%.*s|\n",
6780 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6784 /*The big, slow, and stupid way. */
6785 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6787 Newx(buf, 8192, STDCHAR);
6795 register const STDCHAR *bpe = buf + sizeof(buf);
6797 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6798 ; /* keep reading */
6802 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6803 /* Accomodate broken VAXC compiler, which applies U8 cast to
6804 * both args of ?: operator, causing EOF to change into 255
6807 i = (U8)buf[cnt - 1];
6813 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6815 sv_catpvn(sv, (char *) buf, cnt);
6817 sv_setpvn(sv, (char *) buf, cnt);
6819 if (i != EOF && /* joy */
6821 SvCUR(sv) < rslen ||
6822 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6826 * If we're reading from a TTY and we get a short read,
6827 * indicating that the user hit his EOF character, we need
6828 * to notice it now, because if we try to read from the TTY
6829 * again, the EOF condition will disappear.
6831 * The comparison of cnt to sizeof(buf) is an optimization
6832 * that prevents unnecessary calls to feof().
6836 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6840 #ifdef USE_HEAP_INSTEAD_OF_STACK
6845 if (rspara) { /* have to do this both before and after */
6846 while (i != EOF) { /* to make sure file boundaries work right */
6847 i = PerlIO_getc(fp);
6849 PerlIO_ungetc(fp,i);
6855 return_string_or_null:
6856 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6862 Auto-increment of the value in the SV, doing string to numeric conversion
6863 if necessary. Handles 'get' magic.
6869 Perl_sv_inc(pTHX_ register SV *sv)
6877 if (SvTHINKFIRST(sv)) {
6879 sv_force_normal_flags(sv, 0);
6880 if (SvREADONLY(sv)) {
6881 if (IN_PERL_RUNTIME)
6882 Perl_croak(aTHX_ PL_no_modify);
6886 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6888 i = PTR2IV(SvRV(sv));
6893 flags = SvFLAGS(sv);
6894 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6895 /* It's (privately or publicly) a float, but not tested as an
6896 integer, so test it to see. */
6898 flags = SvFLAGS(sv);
6900 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6901 /* It's publicly an integer, or privately an integer-not-float */
6902 #ifdef PERL_PRESERVE_IVUV
6906 if (SvUVX(sv) == UV_MAX)
6907 sv_setnv(sv, UV_MAX_P1);
6909 (void)SvIOK_only_UV(sv);
6910 SvUV_set(sv, SvUVX(sv) + 1);
6912 if (SvIVX(sv) == IV_MAX)
6913 sv_setuv(sv, (UV)IV_MAX + 1);
6915 (void)SvIOK_only(sv);
6916 SvIV_set(sv, SvIVX(sv) + 1);
6921 if (flags & SVp_NOK) {
6922 (void)SvNOK_only(sv);
6923 SvNV_set(sv, SvNVX(sv) + 1.0);
6927 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6928 if ((flags & SVTYPEMASK) < SVt_PVIV)
6929 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6930 (void)SvIOK_only(sv);
6935 while (isALPHA(*d)) d++;
6936 while (isDIGIT(*d)) d++;
6938 #ifdef PERL_PRESERVE_IVUV
6939 /* Got to punt this as an integer if needs be, but we don't issue
6940 warnings. Probably ought to make the sv_iv_please() that does
6941 the conversion if possible, and silently. */
6942 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6943 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6944 /* Need to try really hard to see if it's an integer.
6945 9.22337203685478e+18 is an integer.
6946 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6947 so $a="9.22337203685478e+18"; $a+0; $a++
6948 needs to be the same as $a="9.22337203685478e+18"; $a++
6955 /* sv_2iv *should* have made this an NV */
6956 if (flags & SVp_NOK) {
6957 (void)SvNOK_only(sv);
6958 SvNV_set(sv, SvNVX(sv) + 1.0);
6961 /* I don't think we can get here. Maybe I should assert this
6962 And if we do get here I suspect that sv_setnv will croak. NWC
6964 #if defined(USE_LONG_DOUBLE)
6965 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",
6966 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6968 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6969 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6972 #endif /* PERL_PRESERVE_IVUV */
6973 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6977 while (d >= SvPVX_const(sv)) {
6985 /* MKS: The original code here died if letters weren't consecutive.
6986 * at least it didn't have to worry about non-C locales. The
6987 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6988 * arranged in order (although not consecutively) and that only
6989 * [A-Za-z] are accepted by isALPHA in the C locale.
6991 if (*d != 'z' && *d != 'Z') {
6992 do { ++*d; } while (!isALPHA(*d));
6995 *(d--) -= 'z' - 'a';
7000 *(d--) -= 'z' - 'a' + 1;
7004 /* oh,oh, the number grew */
7005 SvGROW(sv, SvCUR(sv) + 2);
7006 SvCUR_set(sv, SvCUR(sv) + 1);
7007 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7018 Auto-decrement of the value in the SV, doing string to numeric conversion
7019 if necessary. Handles 'get' magic.
7025 Perl_sv_dec(pTHX_ register SV *sv)
7032 if (SvTHINKFIRST(sv)) {
7034 sv_force_normal_flags(sv, 0);
7035 if (SvREADONLY(sv)) {
7036 if (IN_PERL_RUNTIME)
7037 Perl_croak(aTHX_ PL_no_modify);
7041 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7043 i = PTR2IV(SvRV(sv));
7048 /* Unlike sv_inc we don't have to worry about string-never-numbers
7049 and keeping them magic. But we mustn't warn on punting */
7050 flags = SvFLAGS(sv);
7051 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7052 /* It's publicly an integer, or privately an integer-not-float */
7053 #ifdef PERL_PRESERVE_IVUV
7057 if (SvUVX(sv) == 0) {
7058 (void)SvIOK_only(sv);
7062 (void)SvIOK_only_UV(sv);
7063 SvUV_set(sv, SvUVX(sv) - 1);
7066 if (SvIVX(sv) == IV_MIN)
7067 sv_setnv(sv, (NV)IV_MIN - 1.0);
7069 (void)SvIOK_only(sv);
7070 SvIV_set(sv, SvIVX(sv) - 1);
7075 if (flags & SVp_NOK) {
7076 SvNV_set(sv, SvNVX(sv) - 1.0);
7077 (void)SvNOK_only(sv);
7080 if (!(flags & SVp_POK)) {
7081 if ((flags & SVTYPEMASK) < SVt_PVIV)
7082 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7084 (void)SvIOK_only(sv);
7087 #ifdef PERL_PRESERVE_IVUV
7089 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7090 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7091 /* Need to try really hard to see if it's an integer.
7092 9.22337203685478e+18 is an integer.
7093 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7094 so $a="9.22337203685478e+18"; $a+0; $a--
7095 needs to be the same as $a="9.22337203685478e+18"; $a--
7102 /* sv_2iv *should* have made this an NV */
7103 if (flags & SVp_NOK) {
7104 (void)SvNOK_only(sv);
7105 SvNV_set(sv, SvNVX(sv) - 1.0);
7108 /* I don't think we can get here. Maybe I should assert this
7109 And if we do get here I suspect that sv_setnv will croak. NWC
7111 #if defined(USE_LONG_DOUBLE)
7112 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",
7113 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7115 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7116 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7120 #endif /* PERL_PRESERVE_IVUV */
7121 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7125 =for apidoc sv_mortalcopy
7127 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7128 The new SV is marked as mortal. It will be destroyed "soon", either by an
7129 explicit call to FREETMPS, or by an implicit call at places such as
7130 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7135 /* Make a string that will exist for the duration of the expression
7136 * evaluation. Actually, it may have to last longer than that, but
7137 * hopefully we won't free it until it has been assigned to a
7138 * permanent location. */
7141 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7146 sv_setsv(sv,oldstr);
7148 PL_tmps_stack[++PL_tmps_ix] = sv;
7154 =for apidoc sv_newmortal
7156 Creates a new null SV which is mortal. The reference count of the SV is
7157 set to 1. It will be destroyed "soon", either by an explicit call to
7158 FREETMPS, or by an implicit call at places such as statement boundaries.
7159 See also C<sv_mortalcopy> and C<sv_2mortal>.
7165 Perl_sv_newmortal(pTHX)
7170 SvFLAGS(sv) = SVs_TEMP;
7172 PL_tmps_stack[++PL_tmps_ix] = sv;
7177 =for apidoc sv_2mortal
7179 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7180 by an explicit call to FREETMPS, or by an implicit call at places such as
7181 statement boundaries. SvTEMP() is turned on which means that the SV's
7182 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7183 and C<sv_mortalcopy>.
7189 Perl_sv_2mortal(pTHX_ register SV *sv)
7194 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7197 PL_tmps_stack[++PL_tmps_ix] = sv;
7205 Creates a new SV and copies a string into it. The reference count for the
7206 SV is set to 1. If C<len> is zero, Perl will compute the length using
7207 strlen(). For efficiency, consider using C<newSVpvn> instead.
7213 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7218 sv_setpvn(sv,s,len ? len : strlen(s));
7223 =for apidoc newSVpvn
7225 Creates a new SV and copies a string into it. The reference count for the
7226 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7227 string. You are responsible for ensuring that the source string is at least
7228 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7234 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7239 sv_setpvn(sv,s,len);
7245 =for apidoc newSVhek
7247 Creates a new SV from the hash key structure. It will generate scalars that
7248 point to the shared string table where possible. Returns a new (undefined)
7249 SV if the hek is NULL.
7255 Perl_newSVhek(pTHX_ const HEK *hek)
7264 if (HEK_LEN(hek) == HEf_SVKEY) {
7265 return newSVsv(*(SV**)HEK_KEY(hek));
7267 const int flags = HEK_FLAGS(hek);
7268 if (flags & HVhek_WASUTF8) {
7270 Andreas would like keys he put in as utf8 to come back as utf8
7272 STRLEN utf8_len = HEK_LEN(hek);
7273 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7274 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7277 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7279 } else if (flags & HVhek_REHASH) {
7280 /* We don't have a pointer to the hv, so we have to replicate the
7281 flag into every HEK. This hv is using custom a hasing
7282 algorithm. Hence we can't return a shared string scalar, as
7283 that would contain the (wrong) hash value, and might get passed
7284 into an hv routine with a regular hash */
7286 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7291 /* This will be overwhelminly the most common case. */
7292 return newSVpvn_share(HEK_KEY(hek),
7293 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7299 =for apidoc newSVpvn_share
7301 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7302 table. If the string does not already exist in the table, it is created
7303 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7304 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7305 otherwise the hash is computed. The idea here is that as the string table
7306 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7307 hash lookup will avoid string compare.
7313 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7316 bool is_utf8 = FALSE;
7318 STRLEN tmplen = -len;
7320 /* See the note in hv.c:hv_fetch() --jhi */
7321 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7325 PERL_HASH(hash, src, len);
7327 sv_upgrade(sv, SVt_PV);
7328 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7340 #if defined(PERL_IMPLICIT_CONTEXT)
7342 /* pTHX_ magic can't cope with varargs, so this is a no-context
7343 * version of the main function, (which may itself be aliased to us).
7344 * Don't access this version directly.
7348 Perl_newSVpvf_nocontext(const char* pat, ...)
7353 va_start(args, pat);
7354 sv = vnewSVpvf(pat, &args);
7361 =for apidoc newSVpvf
7363 Creates a new SV and initializes it with the string formatted like
7370 Perl_newSVpvf(pTHX_ const char* pat, ...)
7374 va_start(args, pat);
7375 sv = vnewSVpvf(pat, &args);
7380 /* backend for newSVpvf() and newSVpvf_nocontext() */
7383 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7387 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7394 Creates a new SV and copies a floating point value into it.
7395 The reference count for the SV is set to 1.
7401 Perl_newSVnv(pTHX_ NV n)
7413 Creates a new SV and copies an integer into it. The reference count for the
7420 Perl_newSViv(pTHX_ IV i)
7432 Creates a new SV and copies an unsigned integer into it.
7433 The reference count for the SV is set to 1.
7439 Perl_newSVuv(pTHX_ UV u)
7449 =for apidoc newRV_noinc
7451 Creates an RV wrapper for an SV. The reference count for the original
7452 SV is B<not> incremented.
7458 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7463 sv_upgrade(sv, SVt_RV);
7465 SvRV_set(sv, tmpRef);
7470 /* newRV_inc is the official function name to use now.
7471 * newRV_inc is in fact #defined to newRV in sv.h
7475 Perl_newRV(pTHX_ SV *tmpRef)
7477 return newRV_noinc(SvREFCNT_inc(tmpRef));
7483 Creates a new SV which is an exact duplicate of the original SV.
7490 Perl_newSVsv(pTHX_ register SV *old)
7496 if (SvTYPE(old) == SVTYPEMASK) {
7497 if (ckWARN_d(WARN_INTERNAL))
7498 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7502 /* SV_GMAGIC is the default for sv_setv()
7503 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7504 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7505 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7510 =for apidoc sv_reset
7512 Underlying implementation for the C<reset> Perl function.
7513 Note that the perl-level function is vaguely deprecated.
7519 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7522 char todo[PERL_UCHAR_MAX+1];
7527 if (!*s) { /* reset ?? searches */
7528 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7530 PMOP *pm = (PMOP *) mg->mg_obj;
7532 pm->op_pmdynflags &= ~PMdf_USED;
7539 /* reset variables */
7541 if (!HvARRAY(stash))
7544 Zero(todo, 256, char);
7547 I32 i = (unsigned char)*s;
7551 max = (unsigned char)*s++;
7552 for ( ; i <= max; i++) {
7555 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7557 for (entry = HvARRAY(stash)[i];
7559 entry = HeNEXT(entry))
7564 if (!todo[(U8)*HeKEY(entry)])
7566 gv = (GV*)HeVAL(entry);
7569 if (SvTHINKFIRST(sv)) {
7570 if (!SvREADONLY(sv) && SvROK(sv))
7572 /* XXX Is this continue a bug? Why should THINKFIRST
7573 exempt us from resetting arrays and hashes? */
7577 if (SvTYPE(sv) >= SVt_PV) {
7579 if (SvPVX_const(sv) != Nullch)
7587 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7590 #ifdef USE_ENVIRON_ARRAY
7592 # ifdef USE_ITHREADS
7593 && PL_curinterp == aTHX
7597 environ[0] = Nullch;
7600 #endif /* !PERL_MICRO */
7610 Using various gambits, try to get an IO from an SV: the IO slot if its a
7611 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7612 named after the PV if we're a string.
7618 Perl_sv_2io(pTHX_ SV *sv)
7623 switch (SvTYPE(sv)) {
7631 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7635 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7637 return sv_2io(SvRV(sv));
7638 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7644 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7653 Using various gambits, try to get a CV from an SV; in addition, try if
7654 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7660 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7667 return *gvp = Nullgv, Nullcv;
7668 switch (SvTYPE(sv)) {
7686 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7687 tryAMAGICunDEREF(to_cv);
7690 if (SvTYPE(sv) == SVt_PVCV) {
7699 Perl_croak(aTHX_ "Not a subroutine reference");
7704 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7710 if (lref && !GvCVu(gv)) {
7713 tmpsv = NEWSV(704,0);
7714 gv_efullname3(tmpsv, gv, Nullch);
7715 /* XXX this is probably not what they think they're getting.
7716 * It has the same effect as "sub name;", i.e. just a forward
7718 newSUB(start_subparse(FALSE, 0),
7719 newSVOP(OP_CONST, 0, tmpsv),
7724 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7734 Returns true if the SV has a true value by Perl's rules.
7735 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7736 instead use an in-line version.
7742 Perl_sv_true(pTHX_ register SV *sv)
7747 register const XPV* const tXpv = (XPV*)SvANY(sv);
7749 (tXpv->xpv_cur > 1 ||
7750 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7757 return SvIVX(sv) != 0;
7760 return SvNVX(sv) != 0.0;
7762 return sv_2bool(sv);
7770 A private implementation of the C<SvIVx> macro for compilers which can't
7771 cope with complex macro expressions. Always use the macro instead.
7777 Perl_sv_iv(pTHX_ register SV *sv)
7781 return (IV)SvUVX(sv);
7790 A private implementation of the C<SvUVx> macro for compilers which can't
7791 cope with complex macro expressions. Always use the macro instead.
7797 Perl_sv_uv(pTHX_ register SV *sv)
7802 return (UV)SvIVX(sv);
7810 A private implementation of the C<SvNVx> macro for compilers which can't
7811 cope with complex macro expressions. Always use the macro instead.
7817 Perl_sv_nv(pTHX_ register SV *sv)
7824 /* sv_pv() is now a macro using SvPV_nolen();
7825 * this function provided for binary compatibility only
7829 Perl_sv_pv(pTHX_ SV *sv)
7834 return sv_2pv(sv, 0);
7840 Use the C<SvPV_nolen> macro instead
7844 A private implementation of the C<SvPV> macro for compilers which can't
7845 cope with complex macro expressions. Always use the macro instead.
7851 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7857 return sv_2pv(sv, lp);
7862 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7868 return sv_2pv_flags(sv, lp, 0);
7871 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7872 * this function provided for binary compatibility only
7876 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7878 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7882 =for apidoc sv_pvn_force
7884 Get a sensible string out of the SV somehow.
7885 A private implementation of the C<SvPV_force> macro for compilers which
7886 can't cope with complex macro expressions. Always use the macro instead.
7888 =for apidoc sv_pvn_force_flags
7890 Get a sensible string out of the SV somehow.
7891 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7892 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7893 implemented in terms of this function.
7894 You normally want to use the various wrapper macros instead: see
7895 C<SvPV_force> and C<SvPV_force_nomg>
7901 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7904 if (SvTHINKFIRST(sv) && !SvROK(sv))
7905 sv_force_normal_flags(sv, 0);
7915 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7916 const char * const ref = sv_reftype(sv,0);
7918 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7919 ref, OP_NAME(PL_op));
7921 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7923 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7924 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7926 s = sv_2pv_flags(sv, &len, flags);
7930 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7933 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7934 SvGROW(sv, len + 1);
7935 Move(s,SvPVX(sv),len,char);
7940 SvPOK_on(sv); /* validate pointer */
7942 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7943 PTR2UV(sv),SvPVX_const(sv)));
7946 return SvPVX_mutable(sv);
7949 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7950 * this function provided for binary compatibility only
7954 Perl_sv_pvbyte(pTHX_ SV *sv)
7956 sv_utf8_downgrade(sv,0);
7961 =for apidoc sv_pvbyte
7963 Use C<SvPVbyte_nolen> instead.
7965 =for apidoc sv_pvbyten
7967 A private implementation of the C<SvPVbyte> macro for compilers
7968 which can't cope with complex macro expressions. Always use the macro
7975 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7977 sv_utf8_downgrade(sv,0);
7978 return sv_pvn(sv,lp);
7982 =for apidoc sv_pvbyten_force
7984 A private implementation of the C<SvPVbytex_force> macro for compilers
7985 which can't cope with complex macro expressions. Always use the macro
7992 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7994 sv_pvn_force(sv,lp);
7995 sv_utf8_downgrade(sv,0);
8000 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8001 * this function provided for binary compatibility only
8005 Perl_sv_pvutf8(pTHX_ SV *sv)
8007 sv_utf8_upgrade(sv);
8012 =for apidoc sv_pvutf8
8014 Use the C<SvPVutf8_nolen> macro instead
8016 =for apidoc sv_pvutf8n
8018 A private implementation of the C<SvPVutf8> macro for compilers
8019 which can't cope with complex macro expressions. Always use the macro
8026 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8028 sv_utf8_upgrade(sv);
8029 return sv_pvn(sv,lp);
8033 =for apidoc sv_pvutf8n_force
8035 A private implementation of the C<SvPVutf8_force> macro for compilers
8036 which can't cope with complex macro expressions. Always use the macro
8043 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8045 sv_pvn_force(sv,lp);
8046 sv_utf8_upgrade(sv);
8052 =for apidoc sv_reftype
8054 Returns a string describing what the SV is a reference to.
8060 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8062 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8063 inside return suggests a const propagation bug in g++. */
8064 if (ob && SvOBJECT(sv)) {
8065 char * const name = HvNAME_get(SvSTASH(sv));
8066 return name ? name : (char *) "__ANON__";
8069 switch (SvTYPE(sv)) {
8086 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8087 /* tied lvalues should appear to be
8088 * scalars for backwards compatitbility */
8089 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8090 ? "SCALAR" : "LVALUE");
8091 case SVt_PVAV: return "ARRAY";
8092 case SVt_PVHV: return "HASH";
8093 case SVt_PVCV: return "CODE";
8094 case SVt_PVGV: return "GLOB";
8095 case SVt_PVFM: return "FORMAT";
8096 case SVt_PVIO: return "IO";
8097 default: return "UNKNOWN";
8103 =for apidoc sv_isobject
8105 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8106 object. If the SV is not an RV, or if the object is not blessed, then this
8113 Perl_sv_isobject(pTHX_ SV *sv)
8129 Returns a boolean indicating whether the SV is blessed into the specified
8130 class. This does not check for subtypes; use C<sv_derived_from> to verify
8131 an inheritance relationship.
8137 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8148 hvname = HvNAME_get(SvSTASH(sv));
8152 return strEQ(hvname, name);
8158 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8159 it will be upgraded to one. If C<classname> is non-null then the new SV will
8160 be blessed in the specified package. The new SV is returned and its
8161 reference count is 1.
8167 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8173 SV_CHECK_THINKFIRST_COW_DROP(rv);
8176 if (SvTYPE(rv) >= SVt_PVMG) {
8177 const U32 refcnt = SvREFCNT(rv);
8181 SvREFCNT(rv) = refcnt;
8184 if (SvTYPE(rv) < SVt_RV)
8185 sv_upgrade(rv, SVt_RV);
8186 else if (SvTYPE(rv) > SVt_RV) {
8197 HV* const stash = gv_stashpv(classname, TRUE);
8198 (void)sv_bless(rv, stash);
8204 =for apidoc sv_setref_pv
8206 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8207 argument will be upgraded to an RV. That RV will be modified to point to
8208 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8209 into the SV. The C<classname> argument indicates the package for the
8210 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8211 will have a reference count of 1, and the RV will be returned.
8213 Do not use with other Perl types such as HV, AV, SV, CV, because those
8214 objects will become corrupted by the pointer copy process.
8216 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8222 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8225 sv_setsv(rv, &PL_sv_undef);
8229 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8234 =for apidoc sv_setref_iv
8236 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8237 argument will be upgraded to an RV. That RV will be modified to point to
8238 the new SV. The C<classname> argument indicates the package for the
8239 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8240 will have a reference count of 1, and the RV will be returned.
8246 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8248 sv_setiv(newSVrv(rv,classname), iv);
8253 =for apidoc sv_setref_uv
8255 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8256 argument will be upgraded to an RV. That RV will be modified to point to
8257 the new SV. The C<classname> argument indicates the package for the
8258 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8259 will have a reference count of 1, and the RV will be returned.
8265 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8267 sv_setuv(newSVrv(rv,classname), uv);
8272 =for apidoc sv_setref_nv
8274 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8275 argument will be upgraded to an RV. That RV will be modified to point to
8276 the new SV. The C<classname> argument indicates the package for the
8277 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8278 will have a reference count of 1, and the RV will be returned.
8284 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8286 sv_setnv(newSVrv(rv,classname), nv);
8291 =for apidoc sv_setref_pvn
8293 Copies a string into a new SV, optionally blessing the SV. The length of the
8294 string must be specified with C<n>. The C<rv> argument will be upgraded to
8295 an RV. That RV will be modified to point to the new SV. The C<classname>
8296 argument indicates the package for the blessing. Set C<classname> to
8297 C<Nullch> to avoid the blessing. The new SV will have a reference count
8298 of 1, and the RV will be returned.
8300 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8306 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8308 sv_setpvn(newSVrv(rv,classname), pv, n);
8313 =for apidoc sv_bless
8315 Blesses an SV into a specified package. The SV must be an RV. The package
8316 must be designated by its stash (see C<gv_stashpv()>). The reference count
8317 of the SV is unaffected.
8323 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8327 Perl_croak(aTHX_ "Can't bless non-reference value");
8329 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8330 if (SvREADONLY(tmpRef))
8331 Perl_croak(aTHX_ PL_no_modify);
8332 if (SvOBJECT(tmpRef)) {
8333 if (SvTYPE(tmpRef) != SVt_PVIO)
8335 SvREFCNT_dec(SvSTASH(tmpRef));
8338 SvOBJECT_on(tmpRef);
8339 if (SvTYPE(tmpRef) != SVt_PVIO)
8341 SvUPGRADE(tmpRef, SVt_PVMG);
8342 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8349 if(SvSMAGICAL(tmpRef))
8350 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8358 /* Downgrades a PVGV to a PVMG.
8362 S_sv_unglob(pTHX_ SV *sv)
8366 assert(SvTYPE(sv) == SVt_PVGV);
8371 sv_del_backref((SV*)GvSTASH(sv), sv);
8372 GvSTASH(sv) = Nullhv;
8374 sv_unmagic(sv, PERL_MAGIC_glob);
8375 Safefree(GvNAME(sv));
8378 /* need to keep SvANY(sv) in the right arena */
8379 xpvmg = new_XPVMG();
8380 StructCopy(SvANY(sv), xpvmg, XPVMG);
8381 del_XPVGV(SvANY(sv));
8384 SvFLAGS(sv) &= ~SVTYPEMASK;
8385 SvFLAGS(sv) |= SVt_PVMG;
8389 =for apidoc sv_unref_flags
8391 Unsets the RV status of the SV, and decrements the reference count of
8392 whatever was being referenced by the RV. This can almost be thought of
8393 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8394 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8395 (otherwise the decrementing is conditional on the reference count being
8396 different from one or the reference being a readonly SV).
8403 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8405 SV* const target = SvRV(ref);
8407 if (SvWEAKREF(ref)) {
8408 sv_del_backref(target, ref);
8410 SvRV_set(ref, NULL);
8413 SvRV_set(ref, NULL);
8415 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8416 assigned to as BEGIN {$a = \"Foo"} will fail. */
8417 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8418 SvREFCNT_dec(target);
8419 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8420 sv_2mortal(target); /* Schedule for freeing later */
8424 =for apidoc sv_unref
8426 Unsets the RV status of the SV, and decrements the reference count of
8427 whatever was being referenced by the RV. This can almost be thought of
8428 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8429 being zero. See C<SvROK_off>.
8435 Perl_sv_unref(pTHX_ SV *sv)
8437 sv_unref_flags(sv, 0);
8441 =for apidoc sv_taint
8443 Taint an SV. Use C<SvTAINTED_on> instead.
8448 Perl_sv_taint(pTHX_ SV *sv)
8450 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8454 =for apidoc sv_untaint
8456 Untaint an SV. Use C<SvTAINTED_off> instead.
8461 Perl_sv_untaint(pTHX_ SV *sv)
8463 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8464 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8471 =for apidoc sv_tainted
8473 Test an SV for taintedness. Use C<SvTAINTED> instead.
8478 Perl_sv_tainted(pTHX_ SV *sv)
8480 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8481 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8482 if (mg && (mg->mg_len & 1) )
8489 =for apidoc sv_setpviv
8491 Copies an integer into the given SV, also updating its string value.
8492 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8498 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8500 char buf[TYPE_CHARS(UV)];
8502 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8504 sv_setpvn(sv, ptr, ebuf - ptr);
8508 =for apidoc sv_setpviv_mg
8510 Like C<sv_setpviv>, but also handles 'set' magic.
8516 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8518 char buf[TYPE_CHARS(UV)];
8520 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8522 sv_setpvn(sv, ptr, ebuf - ptr);
8526 #if defined(PERL_IMPLICIT_CONTEXT)
8528 /* pTHX_ magic can't cope with varargs, so this is a no-context
8529 * version of the main function, (which may itself be aliased to us).
8530 * Don't access this version directly.
8534 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8538 va_start(args, pat);
8539 sv_vsetpvf(sv, pat, &args);
8543 /* pTHX_ magic can't cope with varargs, so this is a no-context
8544 * version of the main function, (which may itself be aliased to us).
8545 * Don't access this version directly.
8549 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8553 va_start(args, pat);
8554 sv_vsetpvf_mg(sv, pat, &args);
8560 =for apidoc sv_setpvf
8562 Works like C<sv_catpvf> but copies the text into the SV instead of
8563 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8569 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8572 va_start(args, pat);
8573 sv_vsetpvf(sv, pat, &args);
8578 =for apidoc sv_vsetpvf
8580 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8581 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8583 Usually used via its frontend C<sv_setpvf>.
8589 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8591 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8595 =for apidoc sv_setpvf_mg
8597 Like C<sv_setpvf>, but also handles 'set' magic.
8603 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8606 va_start(args, pat);
8607 sv_vsetpvf_mg(sv, pat, &args);
8612 =for apidoc sv_vsetpvf_mg
8614 Like C<sv_vsetpvf>, but also handles 'set' magic.
8616 Usually used via its frontend C<sv_setpvf_mg>.
8622 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8624 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8628 #if defined(PERL_IMPLICIT_CONTEXT)
8630 /* pTHX_ magic can't cope with varargs, so this is a no-context
8631 * version of the main function, (which may itself be aliased to us).
8632 * Don't access this version directly.
8636 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8640 va_start(args, pat);
8641 sv_vcatpvf(sv, pat, &args);
8645 /* pTHX_ magic can't cope with varargs, so this is a no-context
8646 * version of the main function, (which may itself be aliased to us).
8647 * Don't access this version directly.
8651 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8655 va_start(args, pat);
8656 sv_vcatpvf_mg(sv, pat, &args);
8662 =for apidoc sv_catpvf
8664 Processes its arguments like C<sprintf> and appends the formatted
8665 output to an SV. If the appended data contains "wide" characters
8666 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8667 and characters >255 formatted with %c), the original SV might get
8668 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8669 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8670 valid UTF-8; if the original SV was bytes, the pattern should be too.
8675 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8678 va_start(args, pat);
8679 sv_vcatpvf(sv, pat, &args);
8684 =for apidoc sv_vcatpvf
8686 Processes its arguments like C<vsprintf> and appends the formatted output
8687 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8689 Usually used via its frontend C<sv_catpvf>.
8695 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8697 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8701 =for apidoc sv_catpvf_mg
8703 Like C<sv_catpvf>, but also handles 'set' magic.
8709 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8712 va_start(args, pat);
8713 sv_vcatpvf_mg(sv, pat, &args);
8718 =for apidoc sv_vcatpvf_mg
8720 Like C<sv_vcatpvf>, but also handles 'set' magic.
8722 Usually used via its frontend C<sv_catpvf_mg>.
8728 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8730 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8735 =for apidoc sv_vsetpvfn
8737 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8740 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8746 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8748 sv_setpvn(sv, "", 0);
8749 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8752 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8755 S_expect_number(pTHX_ char** pattern)
8758 switch (**pattern) {
8759 case '1': case '2': case '3':
8760 case '4': case '5': case '6':
8761 case '7': case '8': case '9':
8762 while (isDIGIT(**pattern))
8763 var = var * 10 + (*(*pattern)++ - '0');
8767 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8770 F0convert(NV nv, char *endbuf, STRLEN *len)
8772 const int neg = nv < 0;
8781 if (uv & 1 && uv == nv)
8782 uv--; /* Round to even */
8784 const unsigned dig = uv % 10;
8797 =for apidoc sv_vcatpvfn
8799 Processes its arguments like C<vsprintf> and appends the formatted output
8800 to an SV. Uses an array of SVs if the C style variable argument list is
8801 missing (NULL). When running with taint checks enabled, indicates via
8802 C<maybe_tainted> if results are untrustworthy (often due to the use of
8805 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8811 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8812 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8813 vec_utf8 = DO_UTF8(vecsv);
8815 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8818 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8825 static const char nullstr[] = "(null)";
8827 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8828 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8830 /* Times 4: a decimal digit takes more than 3 binary digits.
8831 * NV_DIG: mantissa takes than many decimal digits.
8832 * Plus 32: Playing safe. */
8833 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8834 /* large enough for "%#.#f" --chip */
8835 /* what about long double NVs? --jhi */
8837 PERL_UNUSED_ARG(maybe_tainted);
8839 /* no matter what, this is a string now */
8840 (void)SvPV_force(sv, origlen);
8842 /* special-case "", "%s", and "%-p" (SVf - see below) */
8845 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8847 const char * const s = va_arg(*args, char*);
8848 sv_catpv(sv, s ? s : nullstr);
8850 else if (svix < svmax) {
8851 sv_catsv(sv, *svargs);
8852 if (DO_UTF8(*svargs))
8857 if (args && patlen == 3 && pat[0] == '%' &&
8858 pat[1] == '-' && pat[2] == 'p') {
8859 argsv = va_arg(*args, SV*);
8860 sv_catsv(sv, argsv);
8866 #ifndef USE_LONG_DOUBLE
8867 /* special-case "%.<number>[gf]" */
8868 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8869 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8870 unsigned digits = 0;
8874 while (*pp >= '0' && *pp <= '9')
8875 digits = 10 * digits + (*pp++ - '0');
8876 if (pp - pat == (int)patlen - 1) {
8884 /* Add check for digits != 0 because it seems that some
8885 gconverts are buggy in this case, and we don't yet have
8886 a Configure test for this. */
8887 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8888 /* 0, point, slack */
8889 Gconvert(nv, (int)digits, 0, ebuf);
8891 if (*ebuf) /* May return an empty string for digits==0 */
8894 } else if (!digits) {
8897 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8898 sv_catpvn(sv, p, l);
8904 #endif /* !USE_LONG_DOUBLE */
8906 if (!args && svix < svmax && DO_UTF8(*svargs))
8909 patend = (char*)pat + patlen;
8910 for (p = (char*)pat; p < patend; p = q) {
8913 bool vectorize = FALSE;
8914 bool vectorarg = FALSE;
8915 bool vec_utf8 = FALSE;
8921 bool has_precis = FALSE;
8924 bool is_utf8 = FALSE; /* is this item utf8? */
8925 #ifdef HAS_LDBL_SPRINTF_BUG
8926 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8927 with sfio - Allen <allens@cpan.org> */
8928 bool fix_ldbl_sprintf_bug = FALSE;
8932 U8 utf8buf[UTF8_MAXBYTES+1];
8933 STRLEN esignlen = 0;
8935 const char *eptr = Nullch;
8938 const U8 *vecstr = Null(U8*);
8945 /* we need a long double target in case HAS_LONG_DOUBLE but
8948 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8956 const char *dotstr = ".";
8957 STRLEN dotstrlen = 1;
8958 I32 efix = 0; /* explicit format parameter index */
8959 I32 ewix = 0; /* explicit width index */
8960 I32 epix = 0; /* explicit precision index */
8961 I32 evix = 0; /* explicit vector index */
8962 bool asterisk = FALSE;
8964 /* echo everything up to the next format specification */
8965 for (q = p; q < patend && *q != '%'; ++q) ;
8967 if (has_utf8 && !pat_utf8)
8968 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8970 sv_catpvn(sv, p, q - p);
8977 We allow format specification elements in this order:
8978 \d+\$ explicit format parameter index
8980 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8981 0 flag (as above): repeated to allow "v02"
8982 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8983 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8985 [%bcdefginopsuxDFOUX] format (mandatory)
8990 As of perl5.9.3, printf format checking is on by default.
8991 Internally, perl uses %p formats to provide an escape to
8992 some extended formatting. This block deals with those
8993 extensions: if it does not match, (char*)q is reset and
8994 the normal format processing code is used.
8996 Currently defined extensions are:
8997 %p include pointer address (standard)
8998 %-p (SVf) include an SV (previously %_)
8999 %-<num>p include an SV with precision <num>
9000 %1p (VDf) include a v-string (as %vd)
9001 %<num>p reserved for future extensions
9003 Robin Barker 2005-07-14
9010 EXPECT_NUMBER(q, n);
9017 argsv = va_arg(*args, SV*);
9018 eptr = SvPVx_const(argsv, elen);
9024 else if (n == vdNUMBER) { /* VDf */
9031 if (ckWARN_d(WARN_INTERNAL))
9032 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9033 "internal %%<num>p might conflict with future printf extensions");
9039 if (EXPECT_NUMBER(q, width)) {
9080 if (EXPECT_NUMBER(q, ewix))
9089 if ((vectorarg = asterisk)) {
9102 EXPECT_NUMBER(q, width);
9108 vecsv = va_arg(*args, SV*);
9110 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9111 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9112 dotstr = SvPV_const(vecsv, dotstrlen);
9119 else if (efix ? efix <= svmax : svix < svmax) {
9120 vecsv = svargs[efix ? efix-1 : svix++];
9121 vecstr = (U8*)SvPV_const(vecsv,veclen);
9122 vec_utf8 = DO_UTF8(vecsv);
9123 /* if this is a version object, we need to return the
9124 * stringified representation (which the SvPVX_const has
9125 * already done for us), but not vectorize the args
9127 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9129 q++; /* skip past the rest of the %vd format */
9130 eptr = (const char *) vecstr;
9131 elen = strlen(eptr);
9144 i = va_arg(*args, int);
9146 i = (ewix ? ewix <= svmax : svix < svmax) ?
9147 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9149 width = (i < 0) ? -i : i;
9159 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9161 /* XXX: todo, support specified precision parameter */
9165 i = va_arg(*args, int);
9167 i = (ewix ? ewix <= svmax : svix < svmax)
9168 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9169 precis = (i < 0) ? 0 : i;
9174 precis = precis * 10 + (*q++ - '0');
9183 case 'I': /* Ix, I32x, and I64x */
9185 if (q[1] == '6' && q[2] == '4') {
9191 if (q[1] == '3' && q[2] == '2') {
9201 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9212 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9213 if (*(q + 1) == 'l') { /* lld, llf */
9238 argsv = (efix ? efix <= svmax : svix < svmax) ?
9239 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9246 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9248 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9250 eptr = (char*)utf8buf;
9251 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9262 if (args && !vectorize) {
9263 eptr = va_arg(*args, char*);
9265 #ifdef MACOS_TRADITIONAL
9266 /* On MacOS, %#s format is used for Pascal strings */
9271 elen = strlen(eptr);
9273 eptr = (char *)nullstr;
9274 elen = sizeof nullstr - 1;
9278 eptr = SvPVx_const(argsv, elen);
9279 if (DO_UTF8(argsv)) {
9280 if (has_precis && precis < elen) {
9282 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9285 if (width) { /* fudge width (can't fudge elen) */
9286 width += elen - sv_len_utf8(argsv);
9294 if (has_precis && elen > precis)
9301 if (alt || vectorize)
9303 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9324 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9333 esignbuf[esignlen++] = plus;
9337 case 'h': iv = (short)va_arg(*args, int); break;
9338 case 'l': iv = va_arg(*args, long); break;
9339 case 'V': iv = va_arg(*args, IV); break;
9340 default: iv = va_arg(*args, int); break;
9342 case 'q': iv = va_arg(*args, Quad_t); break;
9347 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9349 case 'h': iv = (short)tiv; break;
9350 case 'l': iv = (long)tiv; break;
9352 default: iv = tiv; break;
9354 case 'q': iv = (Quad_t)tiv; break;
9358 if ( !vectorize ) /* we already set uv above */
9363 esignbuf[esignlen++] = plus;
9367 esignbuf[esignlen++] = '-';
9410 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9421 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9422 case 'l': uv = va_arg(*args, unsigned long); break;
9423 case 'V': uv = va_arg(*args, UV); break;
9424 default: uv = va_arg(*args, unsigned); break;
9426 case 'q': uv = va_arg(*args, Uquad_t); break;
9431 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9433 case 'h': uv = (unsigned short)tuv; break;
9434 case 'l': uv = (unsigned long)tuv; break;
9436 default: uv = tuv; break;
9438 case 'q': uv = (Uquad_t)tuv; break;
9445 char *ptr = ebuf + sizeof ebuf;
9451 p = (char*)((c == 'X')
9452 ? "0123456789ABCDEF" : "0123456789abcdef");
9458 esignbuf[esignlen++] = '0';
9459 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9467 if (alt && *ptr != '0')
9476 esignbuf[esignlen++] = '0';
9477 esignbuf[esignlen++] = 'b';
9480 default: /* it had better be ten or less */
9484 } while (uv /= base);
9487 elen = (ebuf + sizeof ebuf) - ptr;
9491 zeros = precis - elen;
9492 else if (precis == 0 && elen == 1 && *eptr == '0')
9498 /* FLOATING POINT */
9501 c = 'f'; /* maybe %F isn't supported here */
9507 /* This is evil, but floating point is even more evil */
9509 /* for SV-style calling, we can only get NV
9510 for C-style calling, we assume %f is double;
9511 for simplicity we allow any of %Lf, %llf, %qf for long double
9515 #if defined(USE_LONG_DOUBLE)
9519 /* [perl #20339] - we should accept and ignore %lf rather than die */
9523 #if defined(USE_LONG_DOUBLE)
9524 intsize = args ? 0 : 'q';
9528 #if defined(HAS_LONG_DOUBLE)
9537 /* now we need (long double) if intsize == 'q', else (double) */
9538 nv = (args && !vectorize) ?
9539 #if LONG_DOUBLESIZE > DOUBLESIZE
9541 va_arg(*args, long double) :
9542 va_arg(*args, double)
9544 va_arg(*args, double)
9550 if (c != 'e' && c != 'E') {
9552 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9553 will cast our (long double) to (double) */
9554 (void)Perl_frexp(nv, &i);
9555 if (i == PERL_INT_MIN)
9556 Perl_die(aTHX_ "panic: frexp");
9558 need = BIT_DIGITS(i);
9560 need += has_precis ? precis : 6; /* known default */
9565 #ifdef HAS_LDBL_SPRINTF_BUG
9566 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9567 with sfio - Allen <allens@cpan.org> */
9570 # define MY_DBL_MAX DBL_MAX
9571 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9572 # if DOUBLESIZE >= 8
9573 # define MY_DBL_MAX 1.7976931348623157E+308L
9575 # define MY_DBL_MAX 3.40282347E+38L
9579 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9580 # define MY_DBL_MAX_BUG 1L
9582 # define MY_DBL_MAX_BUG MY_DBL_MAX
9586 # define MY_DBL_MIN DBL_MIN
9587 # else /* XXX guessing! -Allen */
9588 # if DOUBLESIZE >= 8
9589 # define MY_DBL_MIN 2.2250738585072014E-308L
9591 # define MY_DBL_MIN 1.17549435E-38L
9595 if ((intsize == 'q') && (c == 'f') &&
9596 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9598 /* it's going to be short enough that
9599 * long double precision is not needed */
9601 if ((nv <= 0L) && (nv >= -0L))
9602 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9604 /* would use Perl_fp_class as a double-check but not
9605 * functional on IRIX - see perl.h comments */
9607 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9608 /* It's within the range that a double can represent */
9609 #if defined(DBL_MAX) && !defined(DBL_MIN)
9610 if ((nv >= ((long double)1/DBL_MAX)) ||
9611 (nv <= (-(long double)1/DBL_MAX)))
9613 fix_ldbl_sprintf_bug = TRUE;
9616 if (fix_ldbl_sprintf_bug == TRUE) {
9626 # undef MY_DBL_MAX_BUG
9629 #endif /* HAS_LDBL_SPRINTF_BUG */
9631 need += 20; /* fudge factor */
9632 if (PL_efloatsize < need) {
9633 Safefree(PL_efloatbuf);
9634 PL_efloatsize = need + 20; /* more fudge */
9635 Newx(PL_efloatbuf, PL_efloatsize, char);
9636 PL_efloatbuf[0] = '\0';
9639 if ( !(width || left || plus || alt) && fill != '0'
9640 && has_precis && intsize != 'q' ) { /* Shortcuts */
9641 /* See earlier comment about buggy Gconvert when digits,
9643 if ( c == 'g' && precis) {
9644 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9645 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9646 goto float_converted;
9647 } else if ( c == 'f' && !precis) {
9648 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9653 char *ptr = ebuf + sizeof ebuf;
9656 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9657 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9658 if (intsize == 'q') {
9659 /* Copy the one or more characters in a long double
9660 * format before the 'base' ([efgEFG]) character to
9661 * the format string. */
9662 static char const prifldbl[] = PERL_PRIfldbl;
9663 char const *p = prifldbl + sizeof(prifldbl) - 3;
9664 while (p >= prifldbl) { *--ptr = *p--; }
9669 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9674 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9686 /* No taint. Otherwise we are in the strange situation
9687 * where printf() taints but print($float) doesn't.
9689 #if defined(HAS_LONG_DOUBLE)
9691 (void)sprintf(PL_efloatbuf, ptr, nv);
9693 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9695 (void)sprintf(PL_efloatbuf, ptr, nv);
9699 eptr = PL_efloatbuf;
9700 elen = strlen(PL_efloatbuf);
9706 i = SvCUR(sv) - origlen;
9707 if (args && !vectorize) {
9709 case 'h': *(va_arg(*args, short*)) = i; break;
9710 default: *(va_arg(*args, int*)) = i; break;
9711 case 'l': *(va_arg(*args, long*)) = i; break;
9712 case 'V': *(va_arg(*args, IV*)) = i; break;
9714 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9719 sv_setuv_mg(argsv, (UV)i);
9721 continue; /* not "break" */
9728 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9729 && ckWARN(WARN_PRINTF))
9731 SV *msg = sv_newmortal();
9732 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9733 (PL_op->op_type == OP_PRTF) ? "" : "s");
9736 Perl_sv_catpvf(aTHX_ msg,
9737 "\"%%%c\"", c & 0xFF);
9739 Perl_sv_catpvf(aTHX_ msg,
9740 "\"%%\\%03"UVof"\"",
9743 sv_catpv(msg, "end of string");
9744 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9747 /* output mangled stuff ... */
9753 /* ... right here, because formatting flags should not apply */
9754 SvGROW(sv, SvCUR(sv) + elen + 1);
9756 Copy(eptr, p, elen, char);
9759 SvCUR_set(sv, p - SvPVX_const(sv));
9761 continue; /* not "break" */
9764 /* calculate width before utf8_upgrade changes it */
9765 have = esignlen + zeros + elen;
9767 if (is_utf8 != has_utf8) {
9770 sv_utf8_upgrade(sv);
9773 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9774 sv_utf8_upgrade(nsv);
9775 eptr = SvPVX_const(nsv);
9778 SvGROW(sv, SvCUR(sv) + elen + 1);
9783 need = (have > width ? have : width);
9786 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9788 if (esignlen && fill == '0') {
9790 for (i = 0; i < (int)esignlen; i++)
9794 memset(p, fill, gap);
9797 if (esignlen && fill != '0') {
9799 for (i = 0; i < (int)esignlen; i++)
9804 for (i = zeros; i; i--)
9808 Copy(eptr, p, elen, char);
9812 memset(p, ' ', gap);
9817 Copy(dotstr, p, dotstrlen, char);
9821 vectorize = FALSE; /* done iterating over vecstr */
9828 SvCUR_set(sv, p - SvPVX_const(sv));
9836 /* =========================================================================
9838 =head1 Cloning an interpreter
9840 All the macros and functions in this section are for the private use of
9841 the main function, perl_clone().
9843 The foo_dup() functions make an exact copy of an existing foo thinngy.
9844 During the course of a cloning, a hash table is used to map old addresses
9845 to new addresses. The table is created and manipulated with the
9846 ptr_table_* functions.
9850 ============================================================================*/
9853 #if defined(USE_ITHREADS)
9855 #ifndef GpREFCNT_inc
9856 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9860 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9861 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9862 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9863 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9864 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9865 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9866 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9867 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9868 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9869 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9870 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9871 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9872 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9875 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9876 regcomp.c. AMS 20010712 */
9879 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9884 struct reg_substr_datum *s;
9887 return (REGEXP *)NULL;
9889 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9892 len = r->offsets[0];
9893 npar = r->nparens+1;
9895 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9896 Copy(r->program, ret->program, len+1, regnode);
9898 Newx(ret->startp, npar, I32);
9899 Copy(r->startp, ret->startp, npar, I32);
9900 Newx(ret->endp, npar, I32);
9901 Copy(r->startp, ret->startp, npar, I32);
9903 Newx(ret->substrs, 1, struct reg_substr_data);
9904 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9905 s->min_offset = r->substrs->data[i].min_offset;
9906 s->max_offset = r->substrs->data[i].max_offset;
9907 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9908 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9911 ret->regstclass = NULL;
9914 const int count = r->data->count;
9917 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9918 char, struct reg_data);
9919 Newx(d->what, count, U8);
9922 for (i = 0; i < count; i++) {
9923 d->what[i] = r->data->what[i];
9924 switch (d->what[i]) {
9925 /* legal options are one of: sfpont
9926 see also regcomp.h and pregfree() */
9928 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9931 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9934 /* This is cheating. */
9935 Newx(d->data[i], 1, struct regnode_charclass_class);
9936 StructCopy(r->data->data[i], d->data[i],
9937 struct regnode_charclass_class);
9938 ret->regstclass = (regnode*)d->data[i];
9941 /* Compiled op trees are readonly, and can thus be
9942 shared without duplication. */
9944 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9948 d->data[i] = r->data->data[i];
9951 d->data[i] = r->data->data[i];
9953 ((reg_trie_data*)d->data[i])->refcount++;
9957 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9966 Newx(ret->offsets, 2*len+1, U32);
9967 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9969 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9970 ret->refcnt = r->refcnt;
9971 ret->minlen = r->minlen;
9972 ret->prelen = r->prelen;
9973 ret->nparens = r->nparens;
9974 ret->lastparen = r->lastparen;
9975 ret->lastcloseparen = r->lastcloseparen;
9976 ret->reganch = r->reganch;
9978 ret->sublen = r->sublen;
9980 if (RX_MATCH_COPIED(ret))
9981 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9983 ret->subbeg = Nullch;
9984 #ifdef PERL_OLD_COPY_ON_WRITE
9985 ret->saved_copy = Nullsv;
9988 ptr_table_store(PL_ptr_table, r, ret);
9992 /* duplicate a file handle */
9995 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9999 PERL_UNUSED_ARG(type);
10002 return (PerlIO*)NULL;
10004 /* look for it in the table first */
10005 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10009 /* create anew and remember what it is */
10010 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10011 ptr_table_store(PL_ptr_table, fp, ret);
10015 /* duplicate a directory handle */
10018 Perl_dirp_dup(pTHX_ DIR *dp)
10026 /* duplicate a typeglob */
10029 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10034 /* look for it in the table first */
10035 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10039 /* create anew and remember what it is */
10041 ptr_table_store(PL_ptr_table, gp, ret);
10044 ret->gp_refcnt = 0; /* must be before any other dups! */
10045 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10046 ret->gp_io = io_dup_inc(gp->gp_io, param);
10047 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10048 ret->gp_av = av_dup_inc(gp->gp_av, param);
10049 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10050 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10051 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10052 ret->gp_cvgen = gp->gp_cvgen;
10053 ret->gp_line = gp->gp_line;
10054 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10058 /* duplicate a chain of magic */
10061 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10063 MAGIC *mgprev = (MAGIC*)NULL;
10066 return (MAGIC*)NULL;
10067 /* look for it in the table first */
10068 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10072 for (; mg; mg = mg->mg_moremagic) {
10074 Newxz(nmg, 1, MAGIC);
10076 mgprev->mg_moremagic = nmg;
10079 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10080 nmg->mg_private = mg->mg_private;
10081 nmg->mg_type = mg->mg_type;
10082 nmg->mg_flags = mg->mg_flags;
10083 if (mg->mg_type == PERL_MAGIC_qr) {
10084 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10086 else if(mg->mg_type == PERL_MAGIC_backref) {
10087 const AV * const av = (AV*) mg->mg_obj;
10090 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10092 for (i = AvFILLp(av); i >= 0; i--) {
10093 if (!svp[i]) continue;
10094 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10097 else if (mg->mg_type == PERL_MAGIC_symtab) {
10098 nmg->mg_obj = mg->mg_obj;
10101 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10102 ? sv_dup_inc(mg->mg_obj, param)
10103 : sv_dup(mg->mg_obj, param);
10105 nmg->mg_len = mg->mg_len;
10106 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10107 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10108 if (mg->mg_len > 0) {
10109 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10110 if (mg->mg_type == PERL_MAGIC_overload_table &&
10111 AMT_AMAGIC((AMT*)mg->mg_ptr))
10113 AMT *amtp = (AMT*)mg->mg_ptr;
10114 AMT *namtp = (AMT*)nmg->mg_ptr;
10116 for (i = 1; i < NofAMmeth; i++) {
10117 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10121 else if (mg->mg_len == HEf_SVKEY)
10122 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10124 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10125 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10132 /* create a new pointer-mapping table */
10135 Perl_ptr_table_new(pTHX)
10138 Newxz(tbl, 1, PTR_TBL_t);
10139 tbl->tbl_max = 511;
10140 tbl->tbl_items = 0;
10141 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10146 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10148 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10151 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
10153 /* map an existing pointer using a table */
10156 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10158 PTR_TBL_ENT_t *tblent;
10159 const UV hash = PTR_TABLE_HASH(sv);
10161 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10162 for (; tblent; tblent = tblent->next) {
10163 if (tblent->oldval == sv)
10164 return tblent->newval;
10166 return (void*)NULL;
10169 /* add a new entry to a pointer-mapping table */
10172 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10174 PTR_TBL_ENT_t *tblent, **otblent;
10175 /* XXX this may be pessimal on platforms where pointers aren't good
10176 * hash values e.g. if they grow faster in the most significant
10178 const UV hash = PTR_TABLE_HASH(oldsv);
10182 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10183 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10184 if (tblent->oldval == oldsv) {
10185 tblent->newval = newsv;
10189 new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
10190 sizeof(struct ptr_tbl_ent));
10191 tblent->oldval = oldsv;
10192 tblent->newval = newsv;
10193 tblent->next = *otblent;
10196 if (!empty && tbl->tbl_items > tbl->tbl_max)
10197 ptr_table_split(tbl);
10200 /* double the hash bucket size of an existing ptr table */
10203 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10205 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10206 const UV oldsize = tbl->tbl_max + 1;
10207 UV newsize = oldsize * 2;
10210 Renew(ary, newsize, PTR_TBL_ENT_t*);
10211 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10212 tbl->tbl_max = --newsize;
10213 tbl->tbl_ary = ary;
10214 for (i=0; i < oldsize; i++, ary++) {
10215 PTR_TBL_ENT_t **curentp, **entp, *ent;
10218 curentp = ary + oldsize;
10219 for (entp = ary, ent = *ary; ent; ent = *entp) {
10220 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10222 ent->next = *curentp;
10232 /* remove all the entries from a ptr table */
10235 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10237 register PTR_TBL_ENT_t **array;
10238 register PTR_TBL_ENT_t *entry;
10242 if (!tbl || !tbl->tbl_items) {
10246 array = tbl->tbl_ary;
10248 max = tbl->tbl_max;
10252 PTR_TBL_ENT_t *oentry = entry;
10253 entry = entry->next;
10257 if (++riter > max) {
10260 entry = array[riter];
10264 tbl->tbl_items = 0;
10267 /* clear and free a ptr table */
10270 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10275 ptr_table_clear(tbl);
10276 Safefree(tbl->tbl_ary);
10282 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10285 SvRV_set(dstr, SvWEAKREF(sstr)
10286 ? sv_dup(SvRV(sstr), param)
10287 : sv_dup_inc(SvRV(sstr), param));
10290 else if (SvPVX_const(sstr)) {
10291 /* Has something there */
10293 /* Normal PV - clone whole allocated space */
10294 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10295 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10296 /* Not that normal - actually sstr is copy on write.
10297 But we are a true, independant SV, so: */
10298 SvREADONLY_off(dstr);
10303 /* Special case - not normally malloced for some reason */
10304 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10305 /* A "shared" PV - clone it as "shared" PV */
10307 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10311 /* Some other special case - random pointer */
10312 SvPV_set(dstr, SvPVX(sstr));
10317 /* Copy the Null */
10318 if (SvTYPE(dstr) == SVt_RV)
10319 SvRV_set(dstr, NULL);
10325 /* duplicate an SV of any type (including AV, HV etc) */
10328 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10333 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10335 /* look for it in the table first */
10336 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10340 if(param->flags & CLONEf_JOIN_IN) {
10341 /** We are joining here so we don't want do clone
10342 something that is bad **/
10343 const char *hvname;
10345 if(SvTYPE(sstr) == SVt_PVHV &&
10346 (hvname = HvNAME_get(sstr))) {
10347 /** don't clone stashes if they already exist **/
10348 return (SV*)gv_stashpv(hvname,0);
10352 /* create anew and remember what it is */
10355 #ifdef DEBUG_LEAKING_SCALARS
10356 dstr->sv_debug_optype = sstr->sv_debug_optype;
10357 dstr->sv_debug_line = sstr->sv_debug_line;
10358 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10359 dstr->sv_debug_cloned = 1;
10361 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10363 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10367 ptr_table_store(PL_ptr_table, sstr, dstr);
10370 SvFLAGS(dstr) = SvFLAGS(sstr);
10371 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10372 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10375 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10376 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10377 PL_watch_pvx, SvPVX_const(sstr));
10380 /* don't clone objects whose class has asked us not to */
10381 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10382 SvFLAGS(dstr) &= ~SVTYPEMASK;
10383 SvOBJECT_off(dstr);
10387 switch (SvTYPE(sstr)) {
10389 SvANY(dstr) = NULL;
10392 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10393 SvIV_set(dstr, SvIVX(sstr));
10396 SvANY(dstr) = new_XNV();
10397 SvNV_set(dstr, SvNVX(sstr));
10400 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10401 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10405 /* These are all the types that need complex bodies allocating. */
10406 size_t new_body_length;
10407 size_t new_body_offset = 0;
10408 void **new_body_arena;
10409 void **new_body_arenaroot;
10412 switch (SvTYPE(sstr)) {
10414 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10419 new_body = new_XPVIO();
10420 new_body_length = sizeof(XPVIO);
10423 new_body = new_XPVFM();
10424 new_body_length = sizeof(XPVFM);
10428 new_body_arena = (void **) &PL_xpvhv_root;
10429 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10430 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10431 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10432 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10433 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10437 new_body_arena = (void **) &PL_xpvav_root;
10438 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10439 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10440 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10441 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10442 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10446 new_body_length = sizeof(XPVBM);
10447 new_body_arena = (void **) &PL_xpvbm_root;
10448 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10451 if (GvUNIQUE((GV*)sstr)) {
10452 /* Do sharing here. */
10454 new_body_length = sizeof(XPVGV);
10455 new_body_arena = (void **) &PL_xpvgv_root;
10456 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10459 new_body_length = sizeof(XPVCV);
10460 new_body_arena = (void **) &PL_xpvcv_root;
10461 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10464 new_body_length = sizeof(XPVLV);
10465 new_body_arena = (void **) &PL_xpvlv_root;
10466 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10469 new_body_length = sizeof(XPVMG);
10470 new_body_arena = (void **) &PL_xpvmg_root;
10471 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10474 new_body_length = sizeof(XPVNV);
10475 new_body_arena = (void **) &PL_xpvnv_root;
10476 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10479 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10480 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10481 new_body_length = sizeof(XPVIV) - new_body_offset;
10482 new_body_arena = (void **) &PL_xpviv_root;
10483 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10486 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10487 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10488 new_body_length = sizeof(XPV) - new_body_offset;
10489 new_body_arena = (void **) &PL_xpv_root;
10490 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10492 assert(new_body_length);
10494 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10496 new_body = (void*)((char*)new_body - new_body_offset);
10498 /* We always allocated the full length item with PURIFY */
10499 new_body_length += new_body_offset;
10500 new_body_offset = 0;
10501 new_body = my_safemalloc(new_body_length);
10505 SvANY(dstr) = new_body;
10507 Copy(((char*)SvANY(sstr)) + new_body_offset,
10508 ((char*)SvANY(dstr)) + new_body_offset,
10509 new_body_length, char);
10511 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10512 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10514 /* The Copy above means that all the source (unduplicated) pointers
10515 are now in the destination. We can check the flags and the
10516 pointers in either, but it's possible that there's less cache
10517 missing by always going for the destination.
10518 FIXME - instrument and check that assumption */
10519 if (SvTYPE(sstr) >= SVt_PVMG) {
10521 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10523 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10526 switch (SvTYPE(sstr)) {
10538 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10539 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10540 LvTARG(dstr) = dstr;
10541 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10542 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10544 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10547 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10548 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10549 /* Don't call sv_add_backref here as it's going to be created
10550 as part of the magic cloning of the symbol table. */
10551 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10552 (void)GpREFCNT_inc(GvGP(dstr));
10555 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10556 if (IoOFP(dstr) == IoIFP(sstr))
10557 IoOFP(dstr) = IoIFP(dstr);
10559 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10560 /* PL_rsfp_filters entries have fake IoDIRP() */
10561 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10562 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10563 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10564 /* I have no idea why fake dirp (rsfps)
10565 should be treated differently but otherwise
10566 we end up with leaks -- sky*/
10567 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10568 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10569 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10571 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10572 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10573 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10575 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10576 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10577 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10580 if (AvARRAY((AV*)sstr)) {
10581 SV **dst_ary, **src_ary;
10582 SSize_t items = AvFILLp((AV*)sstr) + 1;
10584 src_ary = AvARRAY((AV*)sstr);
10585 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10586 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10587 SvPV_set(dstr, (char*)dst_ary);
10588 AvALLOC((AV*)dstr) = dst_ary;
10589 if (AvREAL((AV*)sstr)) {
10590 while (items-- > 0)
10591 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10594 while (items-- > 0)
10595 *dst_ary++ = sv_dup(*src_ary++, param);
10597 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10598 while (items-- > 0) {
10599 *dst_ary++ = &PL_sv_undef;
10603 SvPV_set(dstr, Nullch);
10604 AvALLOC((AV*)dstr) = (SV**)NULL;
10611 if (HvARRAY((HV*)sstr)) {
10613 const bool sharekeys = !!HvSHAREKEYS(sstr);
10614 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10615 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10617 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10618 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10620 HvARRAY(dstr) = (HE**)darray;
10621 while (i <= sxhv->xhv_max) {
10622 const HE *source = HvARRAY(sstr)[i];
10623 HvARRAY(dstr)[i] = source
10624 ? he_dup(source, sharekeys, param) : 0;
10628 struct xpvhv_aux *saux = HvAUX(sstr);
10629 struct xpvhv_aux *daux = HvAUX(dstr);
10630 /* This flag isn't copied. */
10631 /* SvOOK_on(hv) attacks the IV flags. */
10632 SvFLAGS(dstr) |= SVf_OOK;
10634 hvname = saux->xhv_name;
10636 = hvname ? hek_dup(hvname, param) : hvname;
10638 daux->xhv_riter = saux->xhv_riter;
10639 daux->xhv_eiter = saux->xhv_eiter
10640 ? he_dup(saux->xhv_eiter,
10641 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10645 SvPV_set(dstr, Nullch);
10647 /* Record stashes for possible cloning in Perl_clone(). */
10649 av_push(param->stashes, dstr);
10654 /* NOTE: not refcounted */
10655 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10657 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10659 if (CvCONST(dstr)) {
10660 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10661 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10662 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10664 /* don't dup if copying back - CvGV isn't refcounted, so the
10665 * duped GV may never be freed. A bit of a hack! DAPM */
10666 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10667 Nullgv : gv_dup(CvGV(dstr), param) ;
10668 if (!(param->flags & CLONEf_COPY_STACKS)) {
10671 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10673 CvWEAKOUTSIDE(sstr)
10674 ? cv_dup( CvOUTSIDE(dstr), param)
10675 : cv_dup_inc(CvOUTSIDE(dstr), param);
10677 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10683 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10689 /* duplicate a context */
10692 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10694 PERL_CONTEXT *ncxs;
10697 return (PERL_CONTEXT*)NULL;
10699 /* look for it in the table first */
10700 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10704 /* create anew and remember what it is */
10705 Newxz(ncxs, max + 1, PERL_CONTEXT);
10706 ptr_table_store(PL_ptr_table, cxs, ncxs);
10709 PERL_CONTEXT *cx = &cxs[ix];
10710 PERL_CONTEXT *ncx = &ncxs[ix];
10711 ncx->cx_type = cx->cx_type;
10712 if (CxTYPE(cx) == CXt_SUBST) {
10713 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10716 ncx->blk_oldsp = cx->blk_oldsp;
10717 ncx->blk_oldcop = cx->blk_oldcop;
10718 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10719 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10720 ncx->blk_oldpm = cx->blk_oldpm;
10721 ncx->blk_gimme = cx->blk_gimme;
10722 switch (CxTYPE(cx)) {
10724 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10725 ? cv_dup_inc(cx->blk_sub.cv, param)
10726 : cv_dup(cx->blk_sub.cv,param));
10727 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10728 ? av_dup_inc(cx->blk_sub.argarray, param)
10730 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10731 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10732 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10733 ncx->blk_sub.lval = cx->blk_sub.lval;
10734 ncx->blk_sub.retop = cx->blk_sub.retop;
10737 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10738 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10739 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10740 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10741 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10742 ncx->blk_eval.retop = cx->blk_eval.retop;
10745 ncx->blk_loop.label = cx->blk_loop.label;
10746 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10747 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10748 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10749 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10750 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10751 ? cx->blk_loop.iterdata
10752 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10753 ncx->blk_loop.oldcomppad
10754 = (PAD*)ptr_table_fetch(PL_ptr_table,
10755 cx->blk_loop.oldcomppad);
10756 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10757 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10758 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10759 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10760 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10763 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10764 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10765 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10766 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10767 ncx->blk_sub.retop = cx->blk_sub.retop;
10779 /* duplicate a stack info structure */
10782 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10787 return (PERL_SI*)NULL;
10789 /* look for it in the table first */
10790 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10794 /* create anew and remember what it is */
10795 Newxz(nsi, 1, PERL_SI);
10796 ptr_table_store(PL_ptr_table, si, nsi);
10798 nsi->si_stack = av_dup_inc(si->si_stack, param);
10799 nsi->si_cxix = si->si_cxix;
10800 nsi->si_cxmax = si->si_cxmax;
10801 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10802 nsi->si_type = si->si_type;
10803 nsi->si_prev = si_dup(si->si_prev, param);
10804 nsi->si_next = si_dup(si->si_next, param);
10805 nsi->si_markoff = si->si_markoff;
10810 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10811 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10812 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10813 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10814 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10815 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10816 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10817 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10818 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10819 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10820 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10821 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10822 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10823 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10826 #define pv_dup_inc(p) SAVEPV(p)
10827 #define pv_dup(p) SAVEPV(p)
10828 #define svp_dup_inc(p,pp) any_dup(p,pp)
10830 /* map any object to the new equivent - either something in the
10831 * ptr table, or something in the interpreter structure
10835 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10840 return (void*)NULL;
10842 /* look for it in the table first */
10843 ret = ptr_table_fetch(PL_ptr_table, v);
10847 /* see if it is part of the interpreter structure */
10848 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10849 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10857 /* duplicate the save stack */
10860 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10862 ANY * const ss = proto_perl->Tsavestack;
10863 const I32 max = proto_perl->Tsavestack_max;
10864 I32 ix = proto_perl->Tsavestack_ix;
10876 void (*dptr) (void*);
10877 void (*dxptr) (pTHX_ void*);
10879 Newxz(nss, max, ANY);
10882 I32 i = POPINT(ss,ix);
10883 TOPINT(nss,ix) = i;
10885 case SAVEt_ITEM: /* normal string */
10886 sv = (SV*)POPPTR(ss,ix);
10887 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10888 sv = (SV*)POPPTR(ss,ix);
10889 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10891 case SAVEt_SV: /* scalar reference */
10892 sv = (SV*)POPPTR(ss,ix);
10893 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10894 gv = (GV*)POPPTR(ss,ix);
10895 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10897 case SAVEt_GENERIC_PVREF: /* generic char* */
10898 c = (char*)POPPTR(ss,ix);
10899 TOPPTR(nss,ix) = pv_dup(c);
10900 ptr = POPPTR(ss,ix);
10901 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10903 case SAVEt_SHARED_PVREF: /* char* in shared space */
10904 c = (char*)POPPTR(ss,ix);
10905 TOPPTR(nss,ix) = savesharedpv(c);
10906 ptr = POPPTR(ss,ix);
10907 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10909 case SAVEt_GENERIC_SVREF: /* generic sv */
10910 case SAVEt_SVREF: /* scalar reference */
10911 sv = (SV*)POPPTR(ss,ix);
10912 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10913 ptr = POPPTR(ss,ix);
10914 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10916 case SAVEt_AV: /* array reference */
10917 av = (AV*)POPPTR(ss,ix);
10918 TOPPTR(nss,ix) = av_dup_inc(av, param);
10919 gv = (GV*)POPPTR(ss,ix);
10920 TOPPTR(nss,ix) = gv_dup(gv, param);
10922 case SAVEt_HV: /* hash reference */
10923 hv = (HV*)POPPTR(ss,ix);
10924 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10925 gv = (GV*)POPPTR(ss,ix);
10926 TOPPTR(nss,ix) = gv_dup(gv, param);
10928 case SAVEt_INT: /* int reference */
10929 ptr = POPPTR(ss,ix);
10930 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10931 intval = (int)POPINT(ss,ix);
10932 TOPINT(nss,ix) = intval;
10934 case SAVEt_LONG: /* long reference */
10935 ptr = POPPTR(ss,ix);
10936 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10937 longval = (long)POPLONG(ss,ix);
10938 TOPLONG(nss,ix) = longval;
10940 case SAVEt_I32: /* I32 reference */
10941 case SAVEt_I16: /* I16 reference */
10942 case SAVEt_I8: /* I8 reference */
10943 ptr = POPPTR(ss,ix);
10944 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10946 TOPINT(nss,ix) = i;
10948 case SAVEt_IV: /* IV reference */
10949 ptr = POPPTR(ss,ix);
10950 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10952 TOPIV(nss,ix) = iv;
10954 case SAVEt_SPTR: /* SV* reference */
10955 ptr = POPPTR(ss,ix);
10956 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10957 sv = (SV*)POPPTR(ss,ix);
10958 TOPPTR(nss,ix) = sv_dup(sv, param);
10960 case SAVEt_VPTR: /* random* reference */
10961 ptr = POPPTR(ss,ix);
10962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10963 ptr = POPPTR(ss,ix);
10964 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10966 case SAVEt_PPTR: /* char* reference */
10967 ptr = POPPTR(ss,ix);
10968 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10969 c = (char*)POPPTR(ss,ix);
10970 TOPPTR(nss,ix) = pv_dup(c);
10972 case SAVEt_HPTR: /* HV* reference */
10973 ptr = POPPTR(ss,ix);
10974 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10975 hv = (HV*)POPPTR(ss,ix);
10976 TOPPTR(nss,ix) = hv_dup(hv, param);
10978 case SAVEt_APTR: /* AV* reference */
10979 ptr = POPPTR(ss,ix);
10980 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10981 av = (AV*)POPPTR(ss,ix);
10982 TOPPTR(nss,ix) = av_dup(av, param);
10985 gv = (GV*)POPPTR(ss,ix);
10986 TOPPTR(nss,ix) = gv_dup(gv, param);
10988 case SAVEt_GP: /* scalar reference */
10989 gp = (GP*)POPPTR(ss,ix);
10990 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10991 (void)GpREFCNT_inc(gp);
10992 gv = (GV*)POPPTR(ss,ix);
10993 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10994 c = (char*)POPPTR(ss,ix);
10995 TOPPTR(nss,ix) = pv_dup(c);
10997 TOPIV(nss,ix) = iv;
10999 TOPIV(nss,ix) = iv;
11002 case SAVEt_MORTALIZESV:
11003 sv = (SV*)POPPTR(ss,ix);
11004 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11007 ptr = POPPTR(ss,ix);
11008 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11009 /* these are assumed to be refcounted properly */
11011 switch (((OP*)ptr)->op_type) {
11013 case OP_LEAVESUBLV:
11017 case OP_LEAVEWRITE:
11018 TOPPTR(nss,ix) = ptr;
11023 TOPPTR(nss,ix) = Nullop;
11028 TOPPTR(nss,ix) = Nullop;
11031 c = (char*)POPPTR(ss,ix);
11032 TOPPTR(nss,ix) = pv_dup_inc(c);
11034 case SAVEt_CLEARSV:
11035 longval = POPLONG(ss,ix);
11036 TOPLONG(nss,ix) = longval;
11039 hv = (HV*)POPPTR(ss,ix);
11040 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11041 c = (char*)POPPTR(ss,ix);
11042 TOPPTR(nss,ix) = pv_dup_inc(c);
11044 TOPINT(nss,ix) = i;
11046 case SAVEt_DESTRUCTOR:
11047 ptr = POPPTR(ss,ix);
11048 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11049 dptr = POPDPTR(ss,ix);
11050 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11051 any_dup(FPTR2DPTR(void *, dptr),
11054 case SAVEt_DESTRUCTOR_X:
11055 ptr = POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11057 dxptr = POPDXPTR(ss,ix);
11058 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11059 any_dup(FPTR2DPTR(void *, dxptr),
11062 case SAVEt_REGCONTEXT:
11065 TOPINT(nss,ix) = i;
11068 case SAVEt_STACK_POS: /* Position on Perl stack */
11070 TOPINT(nss,ix) = i;
11072 case SAVEt_AELEM: /* array element */
11073 sv = (SV*)POPPTR(ss,ix);
11074 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11076 TOPINT(nss,ix) = i;
11077 av = (AV*)POPPTR(ss,ix);
11078 TOPPTR(nss,ix) = av_dup_inc(av, param);
11080 case SAVEt_HELEM: /* hash element */
11081 sv = (SV*)POPPTR(ss,ix);
11082 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11083 sv = (SV*)POPPTR(ss,ix);
11084 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11085 hv = (HV*)POPPTR(ss,ix);
11086 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11089 ptr = POPPTR(ss,ix);
11090 TOPPTR(nss,ix) = ptr;
11094 TOPINT(nss,ix) = i;
11096 case SAVEt_COMPPAD:
11097 av = (AV*)POPPTR(ss,ix);
11098 TOPPTR(nss,ix) = av_dup(av, param);
11101 longval = (long)POPLONG(ss,ix);
11102 TOPLONG(nss,ix) = longval;
11103 ptr = POPPTR(ss,ix);
11104 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11105 sv = (SV*)POPPTR(ss,ix);
11106 TOPPTR(nss,ix) = sv_dup(sv, param);
11109 ptr = POPPTR(ss,ix);
11110 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11111 longval = (long)POPBOOL(ss,ix);
11112 TOPBOOL(nss,ix) = (bool)longval;
11114 case SAVEt_SET_SVFLAGS:
11116 TOPINT(nss,ix) = i;
11118 TOPINT(nss,ix) = i;
11119 sv = (SV*)POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = sv_dup(sv, param);
11123 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11131 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11132 * flag to the result. This is done for each stash before cloning starts,
11133 * so we know which stashes want their objects cloned */
11136 do_mark_cloneable_stash(pTHX_ SV *sv)
11138 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11140 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11141 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11142 if (cloner && GvCV(cloner)) {
11149 XPUSHs(sv_2mortal(newSVhek(hvname)));
11151 call_sv((SV*)GvCV(cloner), G_SCALAR);
11158 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11166 =for apidoc perl_clone
11168 Create and return a new interpreter by cloning the current one.
11170 perl_clone takes these flags as parameters:
11172 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11173 without it we only clone the data and zero the stacks,
11174 with it we copy the stacks and the new perl interpreter is
11175 ready to run at the exact same point as the previous one.
11176 The pseudo-fork code uses COPY_STACKS while the
11177 threads->new doesn't.
11179 CLONEf_KEEP_PTR_TABLE
11180 perl_clone keeps a ptr_table with the pointer of the old
11181 variable as a key and the new variable as a value,
11182 this allows it to check if something has been cloned and not
11183 clone it again but rather just use the value and increase the
11184 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11185 the ptr_table using the function
11186 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11187 reason to keep it around is if you want to dup some of your own
11188 variable who are outside the graph perl scans, example of this
11189 code is in threads.xs create
11192 This is a win32 thing, it is ignored on unix, it tells perls
11193 win32host code (which is c++) to clone itself, this is needed on
11194 win32 if you want to run two threads at the same time,
11195 if you just want to do some stuff in a separate perl interpreter
11196 and then throw it away and return to the original one,
11197 you don't need to do anything.
11202 /* XXX the above needs expanding by someone who actually understands it ! */
11203 EXTERN_C PerlInterpreter *
11204 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11207 perl_clone(PerlInterpreter *proto_perl, UV flags)
11210 #ifdef PERL_IMPLICIT_SYS
11212 /* perlhost.h so we need to call into it
11213 to clone the host, CPerlHost should have a c interface, sky */
11215 if (flags & CLONEf_CLONE_HOST) {
11216 return perl_clone_host(proto_perl,flags);
11218 return perl_clone_using(proto_perl, flags,
11220 proto_perl->IMemShared,
11221 proto_perl->IMemParse,
11223 proto_perl->IStdIO,
11227 proto_perl->IProc);
11231 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11232 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11233 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11234 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11235 struct IPerlDir* ipD, struct IPerlSock* ipS,
11236 struct IPerlProc* ipP)
11238 /* XXX many of the string copies here can be optimized if they're
11239 * constants; they need to be allocated as common memory and just
11240 * their pointers copied. */
11243 CLONE_PARAMS clone_params;
11244 CLONE_PARAMS* param = &clone_params;
11246 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11247 /* for each stash, determine whether its objects should be cloned */
11248 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11249 PERL_SET_THX(my_perl);
11252 Poison(my_perl, 1, PerlInterpreter);
11254 PL_curcop = (COP *)Nullop;
11258 PL_savestack_ix = 0;
11259 PL_savestack_max = -1;
11260 PL_sig_pending = 0;
11261 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11262 # else /* !DEBUGGING */
11263 Zero(my_perl, 1, PerlInterpreter);
11264 # endif /* DEBUGGING */
11266 /* host pointers */
11268 PL_MemShared = ipMS;
11269 PL_MemParse = ipMP;
11276 #else /* !PERL_IMPLICIT_SYS */
11278 CLONE_PARAMS clone_params;
11279 CLONE_PARAMS* param = &clone_params;
11280 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11281 /* for each stash, determine whether its objects should be cloned */
11282 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11283 PERL_SET_THX(my_perl);
11286 Poison(my_perl, 1, PerlInterpreter);
11288 PL_curcop = (COP *)Nullop;
11292 PL_savestack_ix = 0;
11293 PL_savestack_max = -1;
11294 PL_sig_pending = 0;
11295 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11296 # else /* !DEBUGGING */
11297 Zero(my_perl, 1, PerlInterpreter);
11298 # endif /* DEBUGGING */
11299 #endif /* PERL_IMPLICIT_SYS */
11300 param->flags = flags;
11301 param->proto_perl = proto_perl;
11304 PL_xnv_arenaroot = NULL;
11305 PL_xnv_root = NULL;
11306 PL_xpv_arenaroot = NULL;
11307 PL_xpv_root = NULL;
11308 PL_xpviv_arenaroot = NULL;
11309 PL_xpviv_root = NULL;
11310 PL_xpvnv_arenaroot = NULL;
11311 PL_xpvnv_root = NULL;
11312 PL_xpvcv_arenaroot = NULL;
11313 PL_xpvcv_root = NULL;
11314 PL_xpvav_arenaroot = NULL;
11315 PL_xpvav_root = NULL;
11316 PL_xpvhv_arenaroot = NULL;
11317 PL_xpvhv_root = NULL;
11318 PL_xpvmg_arenaroot = NULL;
11319 PL_xpvmg_root = NULL;
11320 PL_xpvgv_arenaroot = NULL;
11321 PL_xpvgv_root = NULL;
11322 PL_xpvlv_arenaroot = NULL;
11323 PL_xpvlv_root = NULL;
11324 PL_xpvbm_arenaroot = NULL;
11325 PL_xpvbm_root = NULL;
11326 PL_he_arenaroot = NULL;
11328 #if defined(USE_ITHREADS)
11329 PL_pte_arenaroot = NULL;
11330 PL_pte_root = NULL;
11332 PL_nice_chunk = NULL;
11333 PL_nice_chunk_size = 0;
11335 PL_sv_objcount = 0;
11336 PL_sv_root = Nullsv;
11337 PL_sv_arenaroot = Nullsv;
11339 PL_debug = proto_perl->Idebug;
11341 PL_hash_seed = proto_perl->Ihash_seed;
11342 PL_rehash_seed = proto_perl->Irehash_seed;
11344 #ifdef USE_REENTRANT_API
11345 /* XXX: things like -Dm will segfault here in perlio, but doing
11346 * PERL_SET_CONTEXT(proto_perl);
11347 * breaks too many other things
11349 Perl_reentrant_init(aTHX);
11352 /* create SV map for pointer relocation */
11353 PL_ptr_table = ptr_table_new();
11355 /* initialize these special pointers as early as possible */
11356 SvANY(&PL_sv_undef) = NULL;
11357 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11358 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11359 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11361 SvANY(&PL_sv_no) = new_XPVNV();
11362 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11363 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11364 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11365 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11366 SvCUR_set(&PL_sv_no, 0);
11367 SvLEN_set(&PL_sv_no, 1);
11368 SvIV_set(&PL_sv_no, 0);
11369 SvNV_set(&PL_sv_no, 0);
11370 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11372 SvANY(&PL_sv_yes) = new_XPVNV();
11373 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11374 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11375 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11376 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11377 SvCUR_set(&PL_sv_yes, 1);
11378 SvLEN_set(&PL_sv_yes, 2);
11379 SvIV_set(&PL_sv_yes, 1);
11380 SvNV_set(&PL_sv_yes, 1);
11381 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11383 /* create (a non-shared!) shared string table */
11384 PL_strtab = newHV();
11385 HvSHAREKEYS_off(PL_strtab);
11386 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11387 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11389 PL_compiling = proto_perl->Icompiling;
11391 /* These two PVs will be free'd special way so must set them same way op.c does */
11392 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11393 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11395 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11396 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11398 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11399 if (!specialWARN(PL_compiling.cop_warnings))
11400 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11401 if (!specialCopIO(PL_compiling.cop_io))
11402 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11403 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11405 /* pseudo environmental stuff */
11406 PL_origargc = proto_perl->Iorigargc;
11407 PL_origargv = proto_perl->Iorigargv;
11409 param->stashes = newAV(); /* Setup array of objects to call clone on */
11411 /* Set tainting stuff before PerlIO_debug can possibly get called */
11412 PL_tainting = proto_perl->Itainting;
11413 PL_taint_warn = proto_perl->Itaint_warn;
11415 #ifdef PERLIO_LAYERS
11416 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11417 PerlIO_clone(aTHX_ proto_perl, param);
11420 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11421 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11422 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11423 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11424 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11425 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11428 PL_minus_c = proto_perl->Iminus_c;
11429 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11430 PL_localpatches = proto_perl->Ilocalpatches;
11431 PL_splitstr = proto_perl->Isplitstr;
11432 PL_preprocess = proto_perl->Ipreprocess;
11433 PL_minus_n = proto_perl->Iminus_n;
11434 PL_minus_p = proto_perl->Iminus_p;
11435 PL_minus_l = proto_perl->Iminus_l;
11436 PL_minus_a = proto_perl->Iminus_a;
11437 PL_minus_F = proto_perl->Iminus_F;
11438 PL_doswitches = proto_perl->Idoswitches;
11439 PL_dowarn = proto_perl->Idowarn;
11440 PL_doextract = proto_perl->Idoextract;
11441 PL_sawampersand = proto_perl->Isawampersand;
11442 PL_unsafe = proto_perl->Iunsafe;
11443 PL_inplace = SAVEPV(proto_perl->Iinplace);
11444 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11445 PL_perldb = proto_perl->Iperldb;
11446 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11447 PL_exit_flags = proto_perl->Iexit_flags;
11449 /* magical thingies */
11450 /* XXX time(&PL_basetime) when asked for? */
11451 PL_basetime = proto_perl->Ibasetime;
11452 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11454 PL_maxsysfd = proto_perl->Imaxsysfd;
11455 PL_multiline = proto_perl->Imultiline;
11456 PL_statusvalue = proto_perl->Istatusvalue;
11458 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11460 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11462 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11464 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11465 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11466 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11468 /* Clone the regex array */
11469 PL_regex_padav = newAV();
11471 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11472 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11474 av_push(PL_regex_padav,
11475 sv_dup_inc(regexen[0],param));
11476 for(i = 1; i <= len; i++) {
11477 if(SvREPADTMP(regexen[i])) {
11478 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11480 av_push(PL_regex_padav,
11482 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11483 SvIVX(regexen[i])), param)))
11488 PL_regex_pad = AvARRAY(PL_regex_padav);
11490 /* shortcuts to various I/O objects */
11491 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11492 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11493 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11494 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11495 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11496 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11498 /* shortcuts to regexp stuff */
11499 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11501 /* shortcuts to misc objects */
11502 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11504 /* shortcuts to debugging objects */
11505 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11506 PL_DBline = gv_dup(proto_perl->IDBline, param);
11507 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11508 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11509 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11510 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11511 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11512 PL_lineary = av_dup(proto_perl->Ilineary, param);
11513 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11515 /* symbol tables */
11516 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11517 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11518 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11519 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11520 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11522 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11523 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11524 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11525 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11526 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11527 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11529 PL_sub_generation = proto_perl->Isub_generation;
11531 /* funky return mechanisms */
11532 PL_forkprocess = proto_perl->Iforkprocess;
11534 /* subprocess state */
11535 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11537 /* internal state */
11538 PL_maxo = proto_perl->Imaxo;
11539 if (proto_perl->Iop_mask)
11540 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11542 PL_op_mask = Nullch;
11543 /* PL_asserting = proto_perl->Iasserting; */
11545 /* current interpreter roots */
11546 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11547 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11548 PL_main_start = proto_perl->Imain_start;
11549 PL_eval_root = proto_perl->Ieval_root;
11550 PL_eval_start = proto_perl->Ieval_start;
11552 /* runtime control stuff */
11553 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11554 PL_copline = proto_perl->Icopline;
11556 PL_filemode = proto_perl->Ifilemode;
11557 PL_lastfd = proto_perl->Ilastfd;
11558 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11561 PL_gensym = proto_perl->Igensym;
11562 PL_preambled = proto_perl->Ipreambled;
11563 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11564 PL_laststatval = proto_perl->Ilaststatval;
11565 PL_laststype = proto_perl->Ilaststype;
11566 PL_mess_sv = Nullsv;
11568 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11570 /* interpreter atexit processing */
11571 PL_exitlistlen = proto_perl->Iexitlistlen;
11572 if (PL_exitlistlen) {
11573 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11574 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11577 PL_exitlist = (PerlExitListEntry*)NULL;
11578 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11579 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11580 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11582 PL_profiledata = NULL;
11583 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11584 /* PL_rsfp_filters entries have fake IoDIRP() */
11585 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11587 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11589 PAD_CLONE_VARS(proto_perl, param);
11591 #ifdef HAVE_INTERP_INTERN
11592 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11595 /* more statics moved here */
11596 PL_generation = proto_perl->Igeneration;
11597 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11599 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11600 PL_in_clean_all = proto_perl->Iin_clean_all;
11602 PL_uid = proto_perl->Iuid;
11603 PL_euid = proto_perl->Ieuid;
11604 PL_gid = proto_perl->Igid;
11605 PL_egid = proto_perl->Iegid;
11606 PL_nomemok = proto_perl->Inomemok;
11607 PL_an = proto_perl->Ian;
11608 PL_evalseq = proto_perl->Ievalseq;
11609 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11610 PL_origalen = proto_perl->Iorigalen;
11611 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11612 PL_osname = SAVEPV(proto_perl->Iosname);
11613 PL_sighandlerp = proto_perl->Isighandlerp;
11615 PL_runops = proto_perl->Irunops;
11617 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11620 PL_cshlen = proto_perl->Icshlen;
11621 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11624 PL_lex_state = proto_perl->Ilex_state;
11625 PL_lex_defer = proto_perl->Ilex_defer;
11626 PL_lex_expect = proto_perl->Ilex_expect;
11627 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11628 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11629 PL_lex_starts = proto_perl->Ilex_starts;
11630 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11631 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11632 PL_lex_op = proto_perl->Ilex_op;
11633 PL_lex_inpat = proto_perl->Ilex_inpat;
11634 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11635 PL_lex_brackets = proto_perl->Ilex_brackets;
11636 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11637 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11638 PL_lex_casemods = proto_perl->Ilex_casemods;
11639 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11640 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11642 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11643 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11644 PL_nexttoke = proto_perl->Inexttoke;
11646 /* XXX This is probably masking the deeper issue of why
11647 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11648 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11649 * (A little debugging with a watchpoint on it may help.)
11651 if (SvANY(proto_perl->Ilinestr)) {
11652 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11653 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11654 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11655 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11656 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11657 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11658 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11659 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11660 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11663 PL_linestr = NEWSV(65,79);
11664 sv_upgrade(PL_linestr,SVt_PVIV);
11665 sv_setpvn(PL_linestr,"",0);
11666 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11668 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11669 PL_pending_ident = proto_perl->Ipending_ident;
11670 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11672 PL_expect = proto_perl->Iexpect;
11674 PL_multi_start = proto_perl->Imulti_start;
11675 PL_multi_end = proto_perl->Imulti_end;
11676 PL_multi_open = proto_perl->Imulti_open;
11677 PL_multi_close = proto_perl->Imulti_close;
11679 PL_error_count = proto_perl->Ierror_count;
11680 PL_subline = proto_perl->Isubline;
11681 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11683 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11684 if (SvANY(proto_perl->Ilinestr)) {
11685 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11686 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11687 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11688 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11689 PL_last_lop_op = proto_perl->Ilast_lop_op;
11692 PL_last_uni = SvPVX(PL_linestr);
11693 PL_last_lop = SvPVX(PL_linestr);
11694 PL_last_lop_op = 0;
11696 PL_in_my = proto_perl->Iin_my;
11697 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11699 PL_cryptseen = proto_perl->Icryptseen;
11702 PL_hints = proto_perl->Ihints;
11704 PL_amagic_generation = proto_perl->Iamagic_generation;
11706 #ifdef USE_LOCALE_COLLATE
11707 PL_collation_ix = proto_perl->Icollation_ix;
11708 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11709 PL_collation_standard = proto_perl->Icollation_standard;
11710 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11711 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11712 #endif /* USE_LOCALE_COLLATE */
11714 #ifdef USE_LOCALE_NUMERIC
11715 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11716 PL_numeric_standard = proto_perl->Inumeric_standard;
11717 PL_numeric_local = proto_perl->Inumeric_local;
11718 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11719 #endif /* !USE_LOCALE_NUMERIC */
11721 /* utf8 character classes */
11722 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11723 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11724 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11725 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11726 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11727 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11728 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11729 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11730 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11731 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11732 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11733 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11734 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11735 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11736 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11737 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11738 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11739 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11740 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11741 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11743 /* Did the locale setup indicate UTF-8? */
11744 PL_utf8locale = proto_perl->Iutf8locale;
11745 /* Unicode features (see perlrun/-C) */
11746 PL_unicode = proto_perl->Iunicode;
11748 /* Pre-5.8 signals control */
11749 PL_signals = proto_perl->Isignals;
11751 /* times() ticks per second */
11752 PL_clocktick = proto_perl->Iclocktick;
11754 /* Recursion stopper for PerlIO_find_layer */
11755 PL_in_load_module = proto_perl->Iin_load_module;
11757 /* sort() routine */
11758 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11760 /* Not really needed/useful since the reenrant_retint is "volatile",
11761 * but do it for consistency's sake. */
11762 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11764 /* Hooks to shared SVs and locks. */
11765 PL_sharehook = proto_perl->Isharehook;
11766 PL_lockhook = proto_perl->Ilockhook;
11767 PL_unlockhook = proto_perl->Iunlockhook;
11768 PL_threadhook = proto_perl->Ithreadhook;
11770 PL_runops_std = proto_perl->Irunops_std;
11771 PL_runops_dbg = proto_perl->Irunops_dbg;
11773 #ifdef THREADS_HAVE_PIDS
11774 PL_ppid = proto_perl->Ippid;
11778 PL_last_swash_hv = Nullhv; /* reinits on demand */
11779 PL_last_swash_klen = 0;
11780 PL_last_swash_key[0]= '\0';
11781 PL_last_swash_tmps = (U8*)NULL;
11782 PL_last_swash_slen = 0;
11784 PL_glob_index = proto_perl->Iglob_index;
11785 PL_srand_called = proto_perl->Isrand_called;
11786 PL_uudmap['M'] = 0; /* reinits on demand */
11787 PL_bitcount = Nullch; /* reinits on demand */
11789 if (proto_perl->Ipsig_pend) {
11790 Newxz(PL_psig_pend, SIG_SIZE, int);
11793 PL_psig_pend = (int*)NULL;
11796 if (proto_perl->Ipsig_ptr) {
11797 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11798 Newxz(PL_psig_name, SIG_SIZE, SV*);
11799 for (i = 1; i < SIG_SIZE; i++) {
11800 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11801 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11805 PL_psig_ptr = (SV**)NULL;
11806 PL_psig_name = (SV**)NULL;
11809 /* thrdvar.h stuff */
11811 if (flags & CLONEf_COPY_STACKS) {
11812 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11813 PL_tmps_ix = proto_perl->Ttmps_ix;
11814 PL_tmps_max = proto_perl->Ttmps_max;
11815 PL_tmps_floor = proto_perl->Ttmps_floor;
11816 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11818 while (i <= PL_tmps_ix) {
11819 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11823 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11824 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11825 Newxz(PL_markstack, i, I32);
11826 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11827 - proto_perl->Tmarkstack);
11828 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11829 - proto_perl->Tmarkstack);
11830 Copy(proto_perl->Tmarkstack, PL_markstack,
11831 PL_markstack_ptr - PL_markstack + 1, I32);
11833 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11834 * NOTE: unlike the others! */
11835 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11836 PL_scopestack_max = proto_perl->Tscopestack_max;
11837 Newxz(PL_scopestack, PL_scopestack_max, I32);
11838 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11840 /* NOTE: si_dup() looks at PL_markstack */
11841 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11843 /* PL_curstack = PL_curstackinfo->si_stack; */
11844 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11845 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11847 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11848 PL_stack_base = AvARRAY(PL_curstack);
11849 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11850 - proto_perl->Tstack_base);
11851 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11853 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11854 * NOTE: unlike the others! */
11855 PL_savestack_ix = proto_perl->Tsavestack_ix;
11856 PL_savestack_max = proto_perl->Tsavestack_max;
11857 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11858 PL_savestack = ss_dup(proto_perl, param);
11862 ENTER; /* perl_destruct() wants to LEAVE; */
11865 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11866 PL_top_env = &PL_start_env;
11868 PL_op = proto_perl->Top;
11871 PL_Xpv = (XPV*)NULL;
11872 PL_na = proto_perl->Tna;
11874 PL_statbuf = proto_perl->Tstatbuf;
11875 PL_statcache = proto_perl->Tstatcache;
11876 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11877 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11879 PL_timesbuf = proto_perl->Ttimesbuf;
11882 PL_tainted = proto_perl->Ttainted;
11883 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11884 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11885 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11886 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11887 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11888 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11889 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11890 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11891 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11893 PL_restartop = proto_perl->Trestartop;
11894 PL_in_eval = proto_perl->Tin_eval;
11895 PL_delaymagic = proto_perl->Tdelaymagic;
11896 PL_dirty = proto_perl->Tdirty;
11897 PL_localizing = proto_perl->Tlocalizing;
11899 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11900 PL_hv_fetch_ent_mh = Nullhe;
11901 PL_modcount = proto_perl->Tmodcount;
11902 PL_lastgotoprobe = Nullop;
11903 PL_dumpindent = proto_perl->Tdumpindent;
11905 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11906 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11907 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11908 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11909 PL_sortcxix = proto_perl->Tsortcxix;
11910 PL_efloatbuf = Nullch; /* reinits on demand */
11911 PL_efloatsize = 0; /* reinits on demand */
11915 PL_screamfirst = NULL;
11916 PL_screamnext = NULL;
11917 PL_maxscream = -1; /* reinits on demand */
11918 PL_lastscream = Nullsv;
11920 PL_watchaddr = NULL;
11921 PL_watchok = Nullch;
11923 PL_regdummy = proto_perl->Tregdummy;
11924 PL_regprecomp = Nullch;
11927 PL_colorset = 0; /* reinits PL_colors[] */
11928 /*PL_colors[6] = {0,0,0,0,0,0};*/
11929 PL_reginput = Nullch;
11930 PL_regbol = Nullch;
11931 PL_regeol = Nullch;
11932 PL_regstartp = (I32*)NULL;
11933 PL_regendp = (I32*)NULL;
11934 PL_reglastparen = (U32*)NULL;
11935 PL_reglastcloseparen = (U32*)NULL;
11936 PL_regtill = Nullch;
11937 PL_reg_start_tmp = (char**)NULL;
11938 PL_reg_start_tmpl = 0;
11939 PL_regdata = (struct reg_data*)NULL;
11942 PL_reg_eval_set = 0;
11944 PL_regprogram = (regnode*)NULL;
11946 PL_regcc = (CURCUR*)NULL;
11947 PL_reg_call_cc = (struct re_cc_state*)NULL;
11948 PL_reg_re = (regexp*)NULL;
11949 PL_reg_ganch = Nullch;
11950 PL_reg_sv = Nullsv;
11951 PL_reg_match_utf8 = FALSE;
11952 PL_reg_magic = (MAGIC*)NULL;
11954 PL_reg_oldcurpm = (PMOP*)NULL;
11955 PL_reg_curpm = (PMOP*)NULL;
11956 PL_reg_oldsaved = Nullch;
11957 PL_reg_oldsavedlen = 0;
11958 #ifdef PERL_OLD_COPY_ON_WRITE
11961 PL_reg_maxiter = 0;
11962 PL_reg_leftiter = 0;
11963 PL_reg_poscache = Nullch;
11964 PL_reg_poscache_size= 0;
11966 /* RE engine - function pointers */
11967 PL_regcompp = proto_perl->Tregcompp;
11968 PL_regexecp = proto_perl->Tregexecp;
11969 PL_regint_start = proto_perl->Tregint_start;
11970 PL_regint_string = proto_perl->Tregint_string;
11971 PL_regfree = proto_perl->Tregfree;
11973 PL_reginterp_cnt = 0;
11974 PL_reg_starttry = 0;
11976 /* Pluggable optimizer */
11977 PL_peepp = proto_perl->Tpeepp;
11979 PL_stashcache = newHV();
11981 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11982 ptr_table_free(PL_ptr_table);
11983 PL_ptr_table = NULL;
11986 /* Call the ->CLONE method, if it exists, for each of the stashes
11987 identified by sv_dup() above.
11989 while(av_len(param->stashes) != -1) {
11990 HV* const stash = (HV*) av_shift(param->stashes);
11991 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11992 if (cloner && GvCV(cloner)) {
11997 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11999 call_sv((SV*)GvCV(cloner), G_DISCARD);
12005 SvREFCNT_dec(param->stashes);
12007 /* orphaned? eg threads->new inside BEGIN or use */
12008 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12009 (void)SvREFCNT_inc(PL_compcv);
12010 SAVEFREESV(PL_compcv);
12016 #endif /* USE_ITHREADS */
12019 =head1 Unicode Support
12021 =for apidoc sv_recode_to_utf8
12023 The encoding is assumed to be an Encode object, on entry the PV
12024 of the sv is assumed to be octets in that encoding, and the sv
12025 will be converted into Unicode (and UTF-8).
12027 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12028 is not a reference, nothing is done to the sv. If the encoding is not
12029 an C<Encode::XS> Encoding object, bad things will happen.
12030 (See F<lib/encoding.pm> and L<Encode>).
12032 The PV of the sv is returned.
12037 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12040 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12054 Passing sv_yes is wrong - it needs to be or'ed set of constants
12055 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12056 remove converted chars from source.
12058 Both will default the value - let them.
12060 XPUSHs(&PL_sv_yes);
12063 call_method("decode", G_SCALAR);
12067 s = SvPV_const(uni, len);
12068 if (s != SvPVX_const(sv)) {
12069 SvGROW(sv, len + 1);
12070 Move(s, SvPVX(sv), len + 1, char);
12071 SvCUR_set(sv, len);
12078 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12082 =for apidoc sv_cat_decode
12084 The encoding is assumed to be an Encode object, the PV of the ssv is
12085 assumed to be octets in that encoding and decoding the input starts
12086 from the position which (PV + *offset) pointed to. The dsv will be
12087 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12088 when the string tstr appears in decoding output or the input ends on
12089 the PV of the ssv. The value which the offset points will be modified
12090 to the last input position on the ssv.
12092 Returns TRUE if the terminator was found, else returns FALSE.
12097 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12098 SV *ssv, int *offset, char *tstr, int tlen)
12102 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12113 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12114 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12116 call_method("cat_decode", G_SCALAR);
12118 ret = SvTRUE(TOPs);
12119 *offset = SvIV(offsv);
12125 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12131 * c-indentation-style: bsd
12132 * c-basic-offset: 4
12133 * indent-tabs-mode: t
12136 * ex: set ts=8 sts=4 sw=4 noet: