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
192 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
194 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
197 # define FREE_SV_DEBUG_FILE(sv)
200 #define plant_SV(p) \
202 FREE_SV_DEBUG_FILE(p); \
203 SvANY(p) = (void *)PL_sv_root; \
204 SvFLAGS(p) = SVTYPEMASK; \
209 /* sv_mutex must be held while calling uproot_SV() */
210 #define uproot_SV(p) \
213 PL_sv_root = (SV*)SvANY(p); \
218 /* make some more SVs by adding another arena */
220 /* sv_mutex must be held while calling more_sv() */
227 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
228 PL_nice_chunk = Nullch;
229 PL_nice_chunk_size = 0;
232 char *chunk; /* must use New here to match call to */
233 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
234 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
240 /* new_SV(): return a new, empty SV head */
242 #ifdef DEBUG_LEAKING_SCALARS
243 /* provide a real function for a debugger to play with */
253 sv = S_more_sv(aTHX);
258 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
259 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
260 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
261 sv->sv_debug_inpad = 0;
262 sv->sv_debug_cloned = 0;
264 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
266 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
309 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
310 const SV * const sv = sva + 1;
311 const SV * const svend = &sva[SvREFCNT(sva)];
312 if (p >= sv && p < svend) {
318 if (ckWARN_d(WARN_INTERNAL))
319 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
320 "Attempt to free non-arena SV: 0x%"UVxf
321 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
328 #else /* ! DEBUGGING */
330 #define del_SV(p) plant_SV(p)
332 #endif /* DEBUGGING */
336 =head1 SV Manipulation Functions
338 =for apidoc sv_add_arena
340 Given a chunk of memory, link it to the head of the list of arenas,
341 and split it into a list of free SVs.
347 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
353 /* The first SV in an arena isn't an SV. */
354 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
355 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
356 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
358 PL_sv_arenaroot = sva;
359 PL_sv_root = sva + 1;
361 svend = &sva[SvREFCNT(sva) - 1];
364 SvANY(sv) = (void *)(SV*)(sv + 1);
368 /* Must always set typemask because it's awlays checked in on cleanup
369 when the arenas are walked looking for objects. */
370 SvFLAGS(sv) = SVTYPEMASK;
377 SvFLAGS(sv) = SVTYPEMASK;
380 /* visit(): call the named function for each non-free SV in the arenas
381 * whose flags field matches the flags/mask args. */
384 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
389 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
390 register const SV * const svend = &sva[SvREFCNT(sva)];
392 for (sv = sva + 1; sv < svend; ++sv) {
393 if (SvTYPE(sv) != SVTYPEMASK
394 && (sv->sv_flags & mask) == flags
407 /* called by sv_report_used() for each live SV */
410 do_report_used(pTHX_ SV *sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
435 /* called by sv_clean_objs() for each live SV */
438 do_clean_objs(pTHX_ SV *ref)
442 if (SvROK(ref) && SvOBJECT(target = SvRV(ref))) {
443 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
444 if (SvWEAKREF(ref)) {
445 sv_del_backref(target, ref);
451 SvREFCNT_dec(target);
455 /* XXX Might want to check arrays, etc. */
458 /* called by sv_clean_objs() for each live SV */
460 #ifndef DISABLE_DESTRUCTOR_KLUDGE
462 do_clean_named_objs(pTHX_ SV *sv)
464 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
466 #ifdef PERL_DONT_CREATE_GVSV
469 SvOBJECT(GvSV(sv))) ||
470 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
471 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
472 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
473 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
475 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
476 SvFLAGS(sv) |= SVf_BREAK;
484 =for apidoc sv_clean_objs
486 Attempt to destroy all objects not yet freed
492 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
508 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
509 SvFLAGS(sv) |= SVf_BREAK;
510 if (PL_comppad == (AV*)sv) {
512 PL_curpad = Null(SV**);
518 =for apidoc sv_clean_all
520 Decrement the refcnt of each remaining SV, possibly triggering a
521 cleanup. This function may have to be called multiple times to free
522 SVs which are in complex self-referential hierarchies.
528 Perl_sv_clean_all(pTHX)
531 PL_in_clean_all = TRUE;
532 cleaned = visit(do_clean_all, 0,0);
533 PL_in_clean_all = FALSE;
538 S_free_arena(pTHX_ void **root) {
540 void ** const next = *(void **)root;
547 =for apidoc sv_free_arenas
549 Deallocate the memory used by all arenas. Note that all the individual SV
550 heads and bodies within the arenas must already have been freed.
555 #define free_arena(name) \
557 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
558 PL_ ## name ## _arenaroot = 0; \
559 PL_ ## name ## _root = 0; \
563 Perl_sv_free_arenas(pTHX)
568 /* Free arenas here, but be careful about fake ones. (We assume
569 contiguity of the fake ones with the corresponding real ones.) */
571 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
572 svanext = (SV*) SvANY(sva);
573 while (svanext && SvFAKE(svanext))
574 svanext = (SV*) SvANY(svanext);
592 #if defined(USE_ITHREADS)
596 Safefree(PL_nice_chunk);
597 PL_nice_chunk = Nullch;
598 PL_nice_chunk_size = 0;
603 /* ---------------------------------------------------------------------
605 * support functions for report_uninit()
608 /* the maxiumum size of array or hash where we will scan looking
609 * for the undefined element that triggered the warning */
611 #define FUV_MAX_SEARCH_SIZE 1000
613 /* Look for an entry in the hash whose value has the same SV as val;
614 * If so, return a mortal copy of the key. */
617 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
623 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
624 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
629 for (i=HvMAX(hv); i>0; i--) {
631 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
632 if (HeVAL(entry) != val)
634 if ( HeVAL(entry) == &PL_sv_undef ||
635 HeVAL(entry) == &PL_sv_placeholder)
639 if (HeKLEN(entry) == HEf_SVKEY)
640 return sv_mortalcopy(HeKEY_sv(entry));
641 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
647 /* Look for an entry in the array whose value has the same SV as val;
648 * If so, return the index, otherwise return -1. */
651 S_find_array_subscript(pTHX_ AV *av, SV* val)
655 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
656 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
660 for (i=AvFILLp(av); i>=0; i--) {
661 if (svp[i] == val && svp[i] != &PL_sv_undef)
667 /* S_varname(): return the name of a variable, optionally with a subscript.
668 * If gv is non-zero, use the name of that global, along with gvtype (one
669 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
670 * targ. Depending on the value of the subscript_type flag, return:
673 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
674 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
675 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
676 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
679 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
680 SV* keyname, I32 aindex, int subscript_type)
683 SV * const name = sv_newmortal();
686 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
687 * XXX get rid of all this if gv_fullnameX() ever supports this
691 HV * const hv = GvSTASH(gv);
694 else if (!(p=HvNAME_get(hv)))
696 if (strEQ(p, "main"))
697 sv_setpvn(name, &gvtype, 1);
699 Perl_sv_setpvf(aTHX_ name, "%c%s::", gvtype, p);
701 if (GvNAMELEN(gv)>= 1 &&
702 ((unsigned int)*GvNAME(gv)) <= 26)
704 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
705 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
708 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
712 CV * const cv = find_runcv(&unused);
716 if (!cv || !CvPADLIST(cv))
718 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
719 sv = *av_fetch(av, targ, FALSE);
720 /* SvLEN in a pad name is not to be trusted */
721 sv_setpv(name, SvPV_nolen_const(sv));
724 if (subscript_type == FUV_SUBSCRIPT_HASH) {
725 SV * const sv = NEWSV(0,0);
727 Perl_sv_catpvf(aTHX_ name, "{%s}",
728 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
731 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
733 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
735 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
736 sv_insert(name, 0, 0, "within ", 7);
743 =for apidoc find_uninit_var
745 Find the name of the undefined variable (if any) that caused the operator o
746 to issue a "Use of uninitialized value" warning.
747 If match is true, only return a name if it's value matches uninit_sv.
748 So roughly speaking, if a unary operator (such as OP_COS) generates a
749 warning, then following the direct child of the op may yield an
750 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
751 other hand, with OP_ADD there are two branches to follow, so we only print
752 the variable name if we get an exact match.
754 The name is returned as a mortal SV.
756 Assumes that PL_op is the op that originally triggered the error, and that
757 PL_comppad/PL_curpad points to the currently executing pad.
763 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
771 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
772 uninit_sv == &PL_sv_placeholder)))
775 switch (obase->op_type) {
782 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
783 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
786 int subscript_type = FUV_SUBSCRIPT_WITHIN;
788 if (pad) { /* @lex, %lex */
789 sv = PAD_SVl(obase->op_targ);
793 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
794 /* @global, %global */
795 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
798 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
800 else /* @{expr}, %{expr} */
801 return find_uninit_var(cUNOPx(obase)->op_first,
805 /* attempt to find a match within the aggregate */
807 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
809 subscript_type = FUV_SUBSCRIPT_HASH;
812 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
814 subscript_type = FUV_SUBSCRIPT_ARRAY;
817 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
820 return varname(gv, hash ? '%' : '@', obase->op_targ,
821 keysv, index, subscript_type);
825 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
827 return varname(Nullgv, '$', obase->op_targ,
828 Nullsv, 0, FUV_SUBSCRIPT_NONE);
831 gv = cGVOPx_gv(obase);
832 if (!gv || (match && GvSV(gv) != uninit_sv))
834 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
837 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
840 av = (AV*)PAD_SV(obase->op_targ);
841 if (!av || SvRMAGICAL(av))
843 svp = av_fetch(av, (I32)obase->op_private, FALSE);
844 if (!svp || *svp != uninit_sv)
847 return varname(Nullgv, '$', obase->op_targ,
848 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
851 gv = cGVOPx_gv(obase);
857 if (!av || SvRMAGICAL(av))
859 svp = av_fetch(av, (I32)obase->op_private, FALSE);
860 if (!svp || *svp != uninit_sv)
863 return varname(gv, '$', 0,
864 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
869 o = cUNOPx(obase)->op_first;
870 if (!o || o->op_type != OP_NULL ||
871 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
873 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
878 /* $a[uninit_expr] or $h{uninit_expr} */
879 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
882 o = cBINOPx(obase)->op_first;
883 kid = cBINOPx(obase)->op_last;
885 /* get the av or hv, and optionally the gv */
887 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
888 sv = PAD_SV(o->op_targ);
890 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
891 && cUNOPo->op_first->op_type == OP_GV)
893 gv = cGVOPx_gv(cUNOPo->op_first);
896 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
901 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
902 /* index is constant */
906 if (obase->op_type == OP_HELEM) {
907 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
908 if (!he || HeVAL(he) != uninit_sv)
912 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
913 if (!svp || *svp != uninit_sv)
917 if (obase->op_type == OP_HELEM)
918 return varname(gv, '%', o->op_targ,
919 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
921 return varname(gv, '@', o->op_targ, Nullsv,
922 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
926 /* index is an expression;
927 * attempt to find a match within the aggregate */
928 if (obase->op_type == OP_HELEM) {
929 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
931 return varname(gv, '%', o->op_targ,
932 keysv, 0, FUV_SUBSCRIPT_HASH);
935 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
937 return varname(gv, '@', o->op_targ,
938 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
943 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
945 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
951 /* only examine RHS */
952 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
955 o = cUNOPx(obase)->op_first;
956 if (o->op_type == OP_PUSHMARK)
959 if (!o->op_sibling) {
960 /* one-arg version of open is highly magical */
962 if (o->op_type == OP_GV) { /* open FOO; */
964 if (match && GvSV(gv) != uninit_sv)
966 return varname(gv, '$', 0,
967 Nullsv, 0, FUV_SUBSCRIPT_NONE);
969 /* other possibilities not handled are:
970 * open $x; or open my $x; should return '${*$x}'
971 * open expr; should return '$'.expr ideally
977 /* ops where $_ may be an implicit arg */
981 if ( !(obase->op_flags & OPf_STACKED)) {
982 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
983 ? PAD_SVl(obase->op_targ)
987 sv_setpvn(sv, "$_", 2);
995 /* skip filehandle as it can't produce 'undef' warning */
996 o = cUNOPx(obase)->op_first;
997 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
998 o = o->op_sibling->op_sibling;
1005 match = 1; /* XS or custom code could trigger random warnings */
1010 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1011 return sv_2mortal(newSVpvn("${$/}", 5));
1016 if (!(obase->op_flags & OPf_KIDS))
1018 o = cUNOPx(obase)->op_first;
1024 /* if all except one arg are constant, or have no side-effects,
1025 * or are optimized away, then it's unambiguous */
1027 for (kid=o; kid; kid = kid->op_sibling) {
1029 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1030 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1031 || (kid->op_type == OP_PUSHMARK)
1035 if (o2) { /* more than one found */
1042 return find_uninit_var(o2, uninit_sv, match);
1046 sv = find_uninit_var(o, uninit_sv, 1);
1058 =for apidoc report_uninit
1060 Print appropriate "Use of uninitialized variable" warning
1066 Perl_report_uninit(pTHX_ SV* uninit_sv)
1069 SV* varname = Nullsv;
1071 varname = find_uninit_var(PL_op, uninit_sv,0);
1073 sv_insert(varname, 0, 0, " ", 1);
1075 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1076 varname ? SvPV_nolen_const(varname) : "",
1077 " in ", OP_DESC(PL_op));
1080 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1085 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1089 const size_t count = PERL_ARENA_SIZE/size;
1090 Newx(start, count*size, char);
1091 *((void **) start) = *arena_root;
1092 *arena_root = (void *)start;
1094 end = start + (count-1) * size;
1096 /* The initial slot is used to link the arenas together, so it isn't to be
1097 linked into the list of ready-to-use bodies. */
1101 *root = (void *)start;
1103 while (start < end) {
1104 char * const next = start + size;
1105 *(void**) start = (void *)next;
1108 *(void **)start = 0;
1113 /* grab a new thing from the free list, allocating more if necessary */
1115 /* 1st, the inline version */
1117 #define new_body_inline(xpv, arena_root, root, size) \
1120 xpv = *((void **)(root)) \
1121 ? *((void **)(root)) : S_more_bodies(aTHX_ arena_root, root, size); \
1122 *(root) = *(void**)(xpv); \
1126 /* now use the inline version in the proper function */
1129 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1132 new_body_inline(xpv, arena_root, root, size);
1136 /* return a thing to the free list */
1138 #define del_body(thing, root) \
1140 void **thing_copy = (void **)thing; \
1142 *thing_copy = *root; \
1143 *root = (void*)thing_copy; \
1147 /* Conventionally we simply malloc() a big block of memory, then divide it
1148 up into lots of the thing that we're allocating.
1150 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1153 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1154 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1157 #define new_body_type(TYPE,lctype) \
1158 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1159 (void**)&PL_ ## lctype ## _root, \
1162 #define del_body_type(p,TYPE,lctype) \
1163 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1165 /* But for some types, we cheat. The type starts with some members that are
1166 never accessed. So we allocate the substructure, starting at the first used
1167 member, then adjust the pointer back in memory by the size of the bit not
1168 allocated, so it's as if we allocated the full structure.
1169 (But things will all go boom if you write to the part that is "not there",
1170 because you'll be overwriting the last members of the preceding structure
1173 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1174 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1175 and the pointer is unchanged. If the allocated structure is smaller (no
1176 initial NV actually allocated) then the net effect is to subtract the size
1177 of the NV from the pointer, to return a new pointer as if an initial NV were
1180 This is the same trick as was used for NV and IV bodies. Ironically it
1181 doesn't need to be used for NV bodies any more, because NV is now at the
1182 start of the structure. IV bodies don't need it either, because they are
1183 no longer allocated. */
1185 #define new_body_allocated(TYPE,lctype,member) \
1186 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1187 (void**)&PL_ ## lctype ## _root, \
1188 sizeof(lctype ## _allocated)) - \
1189 STRUCT_OFFSET(TYPE, member) \
1190 + STRUCT_OFFSET(lctype ## _allocated, member))
1193 #define del_body_allocated(p,TYPE,lctype,member) \
1194 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1195 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1196 (void**)&PL_ ## lctype ## _root)
1198 #define my_safemalloc(s) (void*)safemalloc(s)
1199 #define my_safefree(p) safefree((char*)p)
1203 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1204 #define del_XNV(p) my_safefree(p)
1206 #define new_XPV() my_safemalloc(sizeof(XPV))
1207 #define del_XPV(p) my_safefree(p)
1209 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1210 #define del_XPVIV(p) my_safefree(p)
1212 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1213 #define del_XPVNV(p) my_safefree(p)
1215 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1216 #define del_XPVCV(p) my_safefree(p)
1218 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1219 #define del_XPVAV(p) my_safefree(p)
1221 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1222 #define del_XPVHV(p) my_safefree(p)
1224 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1225 #define del_XPVMG(p) my_safefree(p)
1227 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1228 #define del_XPVGV(p) my_safefree(p)
1230 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1231 #define del_XPVLV(p) my_safefree(p)
1233 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1234 #define del_XPVBM(p) my_safefree(p)
1238 #define new_XNV() new_body_type(NV, xnv)
1239 #define del_XNV(p) del_body_type(p, NV, xnv)
1241 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1242 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1244 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1245 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1247 #define new_XPVNV() new_body_type(XPVNV, xpvnv)
1248 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1250 #define new_XPVCV() new_body_type(XPVCV, xpvcv)
1251 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1253 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1254 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1256 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1257 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1259 #define new_XPVMG() new_body_type(XPVMG, xpvmg)
1260 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1262 #define new_XPVGV() new_body_type(XPVGV, xpvgv)
1263 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1265 #define new_XPVLV() new_body_type(XPVLV, xpvlv)
1266 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1268 #define new_XPVBM() new_body_type(XPVBM, xpvbm)
1269 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1273 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1274 #define del_XPVFM(p) my_safefree(p)
1276 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1277 #define del_XPVIO(p) my_safefree(p)
1280 =for apidoc sv_upgrade
1282 Upgrade an SV to a more complex form. Generally adds a new body type to the
1283 SV, then copies across as much information as possible from the old body.
1284 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1290 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1292 void** old_body_arena;
1293 size_t old_body_offset;
1294 size_t old_body_length; /* Well, the length to copy. */
1296 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1297 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1299 bool zero_nv = TRUE;
1302 size_t new_body_length;
1303 size_t new_body_offset;
1304 void** new_body_arena;
1305 void** new_body_arenaroot;
1306 const U32 old_type = SvTYPE(sv);
1308 if (mt != SVt_PV && SvIsCOW(sv)) {
1309 sv_force_normal_flags(sv, 0);
1312 if (SvTYPE(sv) == mt)
1315 if (SvTYPE(sv) > mt)
1316 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1317 (int)SvTYPE(sv), (int)mt);
1320 old_body = SvANY(sv);
1322 old_body_offset = 0;
1323 old_body_length = 0;
1324 new_body_offset = 0;
1325 new_body_length = ~0;
1327 /* Copying structures onto other structures that have been neatly zeroed
1328 has a subtle gotcha. Consider XPVMG
1330 +------+------+------+------+------+-------+-------+
1331 | NV | CUR | LEN | IV | MAGIC | STASH |
1332 +------+------+------+------+------+-------+-------+
1333 0 4 8 12 16 20 24 28
1335 where NVs are aligned to 8 bytes, so that sizeof that structure is
1336 actually 32 bytes long, with 4 bytes of padding at the end:
1338 +------+------+------+------+------+-------+-------+------+
1339 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1340 +------+------+------+------+------+-------+-------+------+
1341 0 4 8 12 16 20 24 28 32
1343 so what happens if you allocate memory for this structure:
1345 +------+------+------+------+------+-------+-------+------+------+...
1346 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1347 +------+------+------+------+------+-------+-------+------+------+...
1348 0 4 8 12 16 20 24 28 32 36
1350 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1351 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1352 started out as zero once, but it's quite possible that it isn't. So now,
1353 rather than a nicely zeroed GP, you have it pointing somewhere random.
1356 (In fact, GP ends up pointing at a previous GP structure, because the
1357 principle cause of the padding in XPVMG getting garbage is a copy of
1358 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1360 So we are careful and work out the size of used parts of all the
1363 switch (SvTYPE(sv)) {
1369 else if (mt < SVt_PVIV)
1371 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1372 old_body_length = sizeof(IV);
1375 old_body_arena = (void **) &PL_xnv_root;
1376 old_body_length = sizeof(NV);
1377 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1386 old_body_arena = (void **) &PL_xpv_root;
1387 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1388 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1389 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1390 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1394 else if (mt == SVt_NV)
1398 old_body_arena = (void **) &PL_xpviv_root;
1399 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1400 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1401 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1402 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1406 old_body_arena = (void **) &PL_xpvnv_root;
1407 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1408 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1409 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1414 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1415 there's no way that it can be safely upgraded, because perl.c
1416 expects to Safefree(SvANY(PL_mess_sv)) */
1417 assert(sv != PL_mess_sv);
1418 /* This flag bit is used to mean other things in other scalar types.
1419 Given that it only has meaning inside the pad, it shouldn't be set
1420 on anything that can get upgraded. */
1421 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1422 old_body_arena = (void **) &PL_xpvmg_root;
1423 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1424 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1425 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1430 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1433 SvFLAGS(sv) &= ~SVTYPEMASK;
1438 Perl_croak(aTHX_ "Can't upgrade to undef");
1440 assert(old_type == SVt_NULL);
1441 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1445 assert(old_type == SVt_NULL);
1446 SvANY(sv) = new_XNV();
1450 assert(old_type == SVt_NULL);
1451 SvANY(sv) = &sv->sv_u.svu_rv;
1455 SvANY(sv) = new_XPVHV();
1458 HvTOTALKEYS(sv) = 0;
1463 SvANY(sv) = new_XPVAV();
1470 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1471 The target created by newSVrv also is, and it can have magic.
1472 However, it never has SvPVX set.
1474 if (old_type >= SVt_RV) {
1475 assert(SvPVX_const(sv) == 0);
1478 /* Could put this in the else clause below, as PVMG must have SvPVX
1479 0 already (the assertion above) */
1480 SvPV_set(sv, (char*)0);
1482 if (old_type >= SVt_PVMG) {
1483 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1484 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1492 new_body = new_XPVIO();
1493 new_body_length = sizeof(XPVIO);
1496 new_body = new_XPVFM();
1497 new_body_length = sizeof(XPVFM);
1501 new_body_length = sizeof(XPVBM);
1502 new_body_arena = (void **) &PL_xpvbm_root;
1503 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1506 new_body_length = sizeof(XPVGV);
1507 new_body_arena = (void **) &PL_xpvgv_root;
1508 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1511 new_body_length = sizeof(XPVCV);
1512 new_body_arena = (void **) &PL_xpvcv_root;
1513 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1516 new_body_length = sizeof(XPVLV);
1517 new_body_arena = (void **) &PL_xpvlv_root;
1518 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1521 new_body_length = sizeof(XPVMG);
1522 new_body_arena = (void **) &PL_xpvmg_root;
1523 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1526 new_body_length = sizeof(XPVNV);
1527 new_body_arena = (void **) &PL_xpvnv_root;
1528 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1531 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1532 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1533 new_body_length = sizeof(XPVIV) - new_body_offset;
1534 new_body_arena = (void **) &PL_xpviv_root;
1535 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1536 /* XXX Is this still needed? Was it ever needed? Surely as there is
1537 no route from NV to PVIV, NOK can never be true */
1541 goto new_body_no_NV;
1543 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1544 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1545 new_body_length = sizeof(XPV) - new_body_offset;
1546 new_body_arena = (void **) &PL_xpv_root;
1547 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1549 /* PV and PVIV don't have an NV slot. */
1550 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1555 assert(new_body_length);
1557 /* This points to the start of the allocated area. */
1558 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
1561 /* We always allocated the full length item with PURIFY */
1562 new_body_length += new_body_offset;
1563 new_body_offset = 0;
1564 new_body = my_safemalloc(new_body_length);
1568 Zero(new_body, new_body_length, char);
1569 new_body = ((char *)new_body) - new_body_offset;
1570 SvANY(sv) = new_body;
1572 if (old_body_length) {
1573 Copy((char *)old_body + old_body_offset,
1574 (char *)new_body + old_body_offset,
1575 old_body_length, char);
1578 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1584 IoPAGE_LEN(sv) = 60;
1585 if (old_type < SVt_RV)
1589 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1593 if (old_body_arena) {
1595 my_safefree(old_body);
1597 del_body((void*)((char*)old_body + old_body_offset),
1604 =for apidoc sv_backoff
1606 Remove any string offset. You should normally use the C<SvOOK_off> macro
1613 Perl_sv_backoff(pTHX_ register SV *sv)
1616 assert(SvTYPE(sv) != SVt_PVHV);
1617 assert(SvTYPE(sv) != SVt_PVAV);
1619 const char * const s = SvPVX_const(sv);
1620 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1621 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1623 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1625 SvFLAGS(sv) &= ~SVf_OOK;
1632 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1633 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1634 Use the C<SvGROW> wrapper instead.
1640 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1644 #ifdef HAS_64K_LIMIT
1645 if (newlen >= 0x10000) {
1646 PerlIO_printf(Perl_debug_log,
1647 "Allocation too large: %"UVxf"\n", (UV)newlen);
1650 #endif /* HAS_64K_LIMIT */
1653 if (SvTYPE(sv) < SVt_PV) {
1654 sv_upgrade(sv, SVt_PV);
1655 s = SvPVX_mutable(sv);
1657 else if (SvOOK(sv)) { /* pv is offset? */
1659 s = SvPVX_mutable(sv);
1660 if (newlen > SvLEN(sv))
1661 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1662 #ifdef HAS_64K_LIMIT
1663 if (newlen >= 0x10000)
1668 s = SvPVX_mutable(sv);
1670 if (newlen > SvLEN(sv)) { /* need more room? */
1671 newlen = PERL_STRLEN_ROUNDUP(newlen);
1672 if (SvLEN(sv) && s) {
1674 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1680 s = saferealloc(s, newlen);
1683 s = safemalloc(newlen);
1684 if (SvPVX_const(sv) && SvCUR(sv)) {
1685 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1689 SvLEN_set(sv, newlen);
1695 =for apidoc sv_setiv
1697 Copies an integer into the given SV, upgrading first if necessary.
1698 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1704 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1706 SV_CHECK_THINKFIRST_COW_DROP(sv);
1707 switch (SvTYPE(sv)) {
1709 sv_upgrade(sv, SVt_IV);
1712 sv_upgrade(sv, SVt_PVNV);
1716 sv_upgrade(sv, SVt_PVIV);
1725 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1728 (void)SvIOK_only(sv); /* validate number */
1734 =for apidoc sv_setiv_mg
1736 Like C<sv_setiv>, but also handles 'set' magic.
1742 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1749 =for apidoc sv_setuv
1751 Copies an unsigned integer into the given SV, upgrading first if necessary.
1752 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1758 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1760 /* With these two if statements:
1761 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1764 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1766 If you wish to remove them, please benchmark to see what the effect is
1768 if (u <= (UV)IV_MAX) {
1769 sv_setiv(sv, (IV)u);
1778 =for apidoc sv_setuv_mg
1780 Like C<sv_setuv>, but also handles 'set' magic.
1786 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1795 =for apidoc sv_setnv
1797 Copies a double into the given SV, upgrading first if necessary.
1798 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1804 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1806 SV_CHECK_THINKFIRST_COW_DROP(sv);
1807 switch (SvTYPE(sv)) {
1810 sv_upgrade(sv, SVt_NV);
1815 sv_upgrade(sv, SVt_PVNV);
1824 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1828 (void)SvNOK_only(sv); /* validate number */
1833 =for apidoc sv_setnv_mg
1835 Like C<sv_setnv>, but also handles 'set' magic.
1841 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1847 /* Print an "isn't numeric" warning, using a cleaned-up,
1848 * printable version of the offending string
1852 S_not_a_number(pTHX_ SV *sv)
1859 dsv = sv_2mortal(newSVpvn("", 0));
1860 pv = sv_uni_display(dsv, sv, 10, 0);
1863 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1864 /* each *s can expand to 4 chars + "...\0",
1865 i.e. need room for 8 chars */
1867 const char *s, *end;
1868 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1871 if (ch & 128 && !isPRINT_LC(ch)) {
1880 else if (ch == '\r') {
1884 else if (ch == '\f') {
1888 else if (ch == '\\') {
1892 else if (ch == '\0') {
1896 else if (isPRINT_LC(ch))
1913 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1914 "Argument \"%s\" isn't numeric in %s", pv,
1917 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1918 "Argument \"%s\" isn't numeric", pv);
1922 =for apidoc looks_like_number
1924 Test if the content of an SV looks like a number (or is a number).
1925 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1926 non-numeric warning), even if your atof() doesn't grok them.
1932 Perl_looks_like_number(pTHX_ SV *sv)
1934 register const char *sbegin;
1938 sbegin = SvPVX_const(sv);
1941 else if (SvPOKp(sv))
1942 sbegin = SvPV_const(sv, len);
1944 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1945 return grok_number(sbegin, len, NULL);
1948 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1949 until proven guilty, assume that things are not that bad... */
1954 As 64 bit platforms often have an NV that doesn't preserve all bits of
1955 an IV (an assumption perl has been based on to date) it becomes necessary
1956 to remove the assumption that the NV always carries enough precision to
1957 recreate the IV whenever needed, and that the NV is the canonical form.
1958 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1959 precision as a side effect of conversion (which would lead to insanity
1960 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1961 1) to distinguish between IV/UV/NV slots that have cached a valid
1962 conversion where precision was lost and IV/UV/NV slots that have a
1963 valid conversion which has lost no precision
1964 2) to ensure that if a numeric conversion to one form is requested that
1965 would lose precision, the precise conversion (or differently
1966 imprecise conversion) is also performed and cached, to prevent
1967 requests for different numeric formats on the same SV causing
1968 lossy conversion chains. (lossless conversion chains are perfectly
1973 SvIOKp is true if the IV slot contains a valid value
1974 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1975 SvNOKp is true if the NV slot contains a valid value
1976 SvNOK is true only if the NV value is accurate
1979 while converting from PV to NV, check to see if converting that NV to an
1980 IV(or UV) would lose accuracy over a direct conversion from PV to
1981 IV(or UV). If it would, cache both conversions, return NV, but mark
1982 SV as IOK NOKp (ie not NOK).
1984 While converting from PV to IV, check to see if converting that IV to an
1985 NV would lose accuracy over a direct conversion from PV to NV. If it
1986 would, cache both conversions, flag similarly.
1988 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1989 correctly because if IV & NV were set NV *always* overruled.
1990 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1991 changes - now IV and NV together means that the two are interchangeable:
1992 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1994 The benefit of this is that operations such as pp_add know that if
1995 SvIOK is true for both left and right operands, then integer addition
1996 can be used instead of floating point (for cases where the result won't
1997 overflow). Before, floating point was always used, which could lead to
1998 loss of precision compared with integer addition.
2000 * making IV and NV equal status should make maths accurate on 64 bit
2002 * may speed up maths somewhat if pp_add and friends start to use
2003 integers when possible instead of fp. (Hopefully the overhead in
2004 looking for SvIOK and checking for overflow will not outweigh the
2005 fp to integer speedup)
2006 * will slow down integer operations (callers of SvIV) on "inaccurate"
2007 values, as the change from SvIOK to SvIOKp will cause a call into
2008 sv_2iv each time rather than a macro access direct to the IV slot
2009 * should speed up number->string conversion on integers as IV is
2010 favoured when IV and NV are equally accurate
2012 ####################################################################
2013 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2014 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2015 On the other hand, SvUOK is true iff UV.
2016 ####################################################################
2018 Your mileage will vary depending your CPU's relative fp to integer
2022 #ifndef NV_PRESERVES_UV
2023 # define IS_NUMBER_UNDERFLOW_IV 1
2024 # define IS_NUMBER_UNDERFLOW_UV 2
2025 # define IS_NUMBER_IV_AND_UV 2
2026 # define IS_NUMBER_OVERFLOW_IV 4
2027 # define IS_NUMBER_OVERFLOW_UV 5
2029 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2031 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2033 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2035 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));
2036 if (SvNVX(sv) < (NV)IV_MIN) {
2037 (void)SvIOKp_on(sv);
2039 SvIV_set(sv, IV_MIN);
2040 return IS_NUMBER_UNDERFLOW_IV;
2042 if (SvNVX(sv) > (NV)UV_MAX) {
2043 (void)SvIOKp_on(sv);
2046 SvUV_set(sv, UV_MAX);
2047 return IS_NUMBER_OVERFLOW_UV;
2049 (void)SvIOKp_on(sv);
2051 /* Can't use strtol etc to convert this string. (See truth table in
2053 if (SvNVX(sv) <= (UV)IV_MAX) {
2054 SvIV_set(sv, I_V(SvNVX(sv)));
2055 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2056 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2058 /* Integer is imprecise. NOK, IOKp */
2060 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2063 SvUV_set(sv, U_V(SvNVX(sv)));
2064 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2065 if (SvUVX(sv) == UV_MAX) {
2066 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2067 possibly be preserved by NV. Hence, it must be overflow.
2069 return IS_NUMBER_OVERFLOW_UV;
2071 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2073 /* Integer is imprecise. NOK, IOKp */
2075 return IS_NUMBER_OVERFLOW_IV;
2077 #endif /* !NV_PRESERVES_UV*/
2079 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2080 * this function provided for binary compatibility only
2084 Perl_sv_2iv(pTHX_ register SV *sv)
2086 return sv_2iv_flags(sv, SV_GMAGIC);
2090 =for apidoc sv_2iv_flags
2092 Return the integer value of an SV, doing any necessary string
2093 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2094 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2100 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2104 if (SvGMAGICAL(sv)) {
2105 if (flags & SV_GMAGIC)
2110 return I_V(SvNVX(sv));
2112 if (SvPOKp(sv) && SvLEN(sv))
2115 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2116 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2122 if (SvTHINKFIRST(sv)) {
2125 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2126 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2127 return SvIV(tmpstr);
2128 return PTR2IV(SvRV(sv));
2131 sv_force_normal_flags(sv, 0);
2133 if (SvREADONLY(sv) && !SvOK(sv)) {
2134 if (ckWARN(WARN_UNINITIALIZED))
2141 return (IV)(SvUVX(sv));
2148 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2149 * without also getting a cached IV/UV from it at the same time
2150 * (ie PV->NV conversion should detect loss of accuracy and cache
2151 * IV or UV at same time to avoid this. NWC */
2153 if (SvTYPE(sv) == SVt_NV)
2154 sv_upgrade(sv, SVt_PVNV);
2156 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2157 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2158 certainly cast into the IV range at IV_MAX, whereas the correct
2159 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2161 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2162 SvIV_set(sv, I_V(SvNVX(sv)));
2163 if (SvNVX(sv) == (NV) SvIVX(sv)
2164 #ifndef NV_PRESERVES_UV
2165 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2166 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2167 /* Don't flag it as "accurately an integer" if the number
2168 came from a (by definition imprecise) NV operation, and
2169 we're outside the range of NV integer precision */
2172 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2173 DEBUG_c(PerlIO_printf(Perl_debug_log,
2174 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2180 /* IV not precise. No need to convert from PV, as NV
2181 conversion would already have cached IV if it detected
2182 that PV->IV would be better than PV->NV->IV
2183 flags already correct - don't set public IOK. */
2184 DEBUG_c(PerlIO_printf(Perl_debug_log,
2185 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2190 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2191 but the cast (NV)IV_MIN rounds to a the value less (more
2192 negative) than IV_MIN which happens to be equal to SvNVX ??
2193 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2194 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2195 (NV)UVX == NVX are both true, but the values differ. :-(
2196 Hopefully for 2s complement IV_MIN is something like
2197 0x8000000000000000 which will be exact. NWC */
2200 SvUV_set(sv, U_V(SvNVX(sv)));
2202 (SvNVX(sv) == (NV) SvUVX(sv))
2203 #ifndef NV_PRESERVES_UV
2204 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2205 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2206 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2207 /* Don't flag it as "accurately an integer" if the number
2208 came from a (by definition imprecise) NV operation, and
2209 we're outside the range of NV integer precision */
2215 DEBUG_c(PerlIO_printf(Perl_debug_log,
2216 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2220 return (IV)SvUVX(sv);
2223 else if (SvPOKp(sv) && SvLEN(sv)) {
2225 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2226 /* We want to avoid a possible problem when we cache an IV which
2227 may be later translated to an NV, and the resulting NV is not
2228 the same as the direct translation of the initial string
2229 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2230 be careful to ensure that the value with the .456 is around if the
2231 NV value is requested in the future).
2233 This means that if we cache such an IV, we need to cache the
2234 NV as well. Moreover, we trade speed for space, and do not
2235 cache the NV if we are sure it's not needed.
2238 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2239 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2240 == IS_NUMBER_IN_UV) {
2241 /* It's definitely an integer, only upgrade to PVIV */
2242 if (SvTYPE(sv) < SVt_PVIV)
2243 sv_upgrade(sv, SVt_PVIV);
2245 } else if (SvTYPE(sv) < SVt_PVNV)
2246 sv_upgrade(sv, SVt_PVNV);
2248 /* If NV preserves UV then we only use the UV value if we know that
2249 we aren't going to call atof() below. If NVs don't preserve UVs
2250 then the value returned may have more precision than atof() will
2251 return, even though value isn't perfectly accurate. */
2252 if ((numtype & (IS_NUMBER_IN_UV
2253 #ifdef NV_PRESERVES_UV
2256 )) == IS_NUMBER_IN_UV) {
2257 /* This won't turn off the public IOK flag if it was set above */
2258 (void)SvIOKp_on(sv);
2260 if (!(numtype & IS_NUMBER_NEG)) {
2262 if (value <= (UV)IV_MAX) {
2263 SvIV_set(sv, (IV)value);
2265 SvUV_set(sv, value);
2269 /* 2s complement assumption */
2270 if (value <= (UV)IV_MIN) {
2271 SvIV_set(sv, -(IV)value);
2273 /* Too negative for an IV. This is a double upgrade, but
2274 I'm assuming it will be rare. */
2275 if (SvTYPE(sv) < SVt_PVNV)
2276 sv_upgrade(sv, SVt_PVNV);
2280 SvNV_set(sv, -(NV)value);
2281 SvIV_set(sv, IV_MIN);
2285 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2286 will be in the previous block to set the IV slot, and the next
2287 block to set the NV slot. So no else here. */
2289 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290 != IS_NUMBER_IN_UV) {
2291 /* It wasn't an (integer that doesn't overflow the UV). */
2292 SvNV_set(sv, Atof(SvPVX_const(sv)));
2294 if (! numtype && ckWARN(WARN_NUMERIC))
2297 #if defined(USE_LONG_DOUBLE)
2298 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2299 PTR2UV(sv), SvNVX(sv)));
2301 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2302 PTR2UV(sv), SvNVX(sv)));
2306 #ifdef NV_PRESERVES_UV
2307 (void)SvIOKp_on(sv);
2309 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2310 SvIV_set(sv, I_V(SvNVX(sv)));
2311 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2314 /* Integer is imprecise. NOK, IOKp */
2316 /* UV will not work better than IV */
2318 if (SvNVX(sv) > (NV)UV_MAX) {
2320 /* Integer is inaccurate. NOK, IOKp, is UV */
2321 SvUV_set(sv, UV_MAX);
2324 SvUV_set(sv, U_V(SvNVX(sv)));
2325 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2326 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2330 /* Integer is imprecise. NOK, IOKp, is UV */
2336 #else /* NV_PRESERVES_UV */
2337 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2338 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2339 /* The IV slot will have been set from value returned by
2340 grok_number above. The NV slot has just been set using
2343 assert (SvIOKp(sv));
2345 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2346 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2347 /* Small enough to preserve all bits. */
2348 (void)SvIOKp_on(sv);
2350 SvIV_set(sv, I_V(SvNVX(sv)));
2351 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2353 /* Assumption: first non-preserved integer is < IV_MAX,
2354 this NV is in the preserved range, therefore: */
2355 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2357 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);
2361 0 0 already failed to read UV.
2362 0 1 already failed to read UV.
2363 1 0 you won't get here in this case. IV/UV
2364 slot set, public IOK, Atof() unneeded.
2365 1 1 already read UV.
2366 so there's no point in sv_2iuv_non_preserve() attempting
2367 to use atol, strtol, strtoul etc. */
2368 if (sv_2iuv_non_preserve (sv, numtype)
2369 >= IS_NUMBER_OVERFLOW_IV)
2373 #endif /* NV_PRESERVES_UV */
2376 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2378 if (SvTYPE(sv) < SVt_IV)
2379 /* Typically the caller expects that sv_any is not NULL now. */
2380 sv_upgrade(sv, SVt_IV);
2383 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2384 PTR2UV(sv),SvIVX(sv)));
2385 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2388 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2389 * this function provided for binary compatibility only
2393 Perl_sv_2uv(pTHX_ register SV *sv)
2395 return sv_2uv_flags(sv, SV_GMAGIC);
2399 =for apidoc sv_2uv_flags
2401 Return the unsigned integer value of an SV, doing any necessary string
2402 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2403 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2409 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2413 if (SvGMAGICAL(sv)) {
2414 if (flags & SV_GMAGIC)
2419 return U_V(SvNVX(sv));
2420 if (SvPOKp(sv) && SvLEN(sv))
2423 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2424 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2430 if (SvTHINKFIRST(sv)) {
2433 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2434 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2435 return SvUV(tmpstr);
2436 return PTR2UV(SvRV(sv));
2439 sv_force_normal_flags(sv, 0);
2441 if (SvREADONLY(sv) && !SvOK(sv)) {
2442 if (ckWARN(WARN_UNINITIALIZED))
2452 return (UV)SvIVX(sv);
2456 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2457 * without also getting a cached IV/UV from it at the same time
2458 * (ie PV->NV conversion should detect loss of accuracy and cache
2459 * IV or UV at same time to avoid this. */
2460 /* IV-over-UV optimisation - choose to cache IV if possible */
2462 if (SvTYPE(sv) == SVt_NV)
2463 sv_upgrade(sv, SVt_PVNV);
2465 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2466 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2467 SvIV_set(sv, I_V(SvNVX(sv)));
2468 if (SvNVX(sv) == (NV) SvIVX(sv)
2469 #ifndef NV_PRESERVES_UV
2470 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2471 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2472 /* Don't flag it as "accurately an integer" if the number
2473 came from a (by definition imprecise) NV operation, and
2474 we're outside the range of NV integer precision */
2477 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2478 DEBUG_c(PerlIO_printf(Perl_debug_log,
2479 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2485 /* IV not precise. No need to convert from PV, as NV
2486 conversion would already have cached IV if it detected
2487 that PV->IV would be better than PV->NV->IV
2488 flags already correct - don't set public IOK. */
2489 DEBUG_c(PerlIO_printf(Perl_debug_log,
2490 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2495 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2496 but the cast (NV)IV_MIN rounds to a the value less (more
2497 negative) than IV_MIN which happens to be equal to SvNVX ??
2498 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2499 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2500 (NV)UVX == NVX are both true, but the values differ. :-(
2501 Hopefully for 2s complement IV_MIN is something like
2502 0x8000000000000000 which will be exact. NWC */
2505 SvUV_set(sv, U_V(SvNVX(sv)));
2507 (SvNVX(sv) == (NV) SvUVX(sv))
2508 #ifndef NV_PRESERVES_UV
2509 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2510 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2511 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2512 /* Don't flag it as "accurately an integer" if the number
2513 came from a (by definition imprecise) NV operation, and
2514 we're outside the range of NV integer precision */
2519 DEBUG_c(PerlIO_printf(Perl_debug_log,
2520 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2526 else if (SvPOKp(sv) && SvLEN(sv)) {
2528 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2530 /* We want to avoid a possible problem when we cache a UV which
2531 may be later translated to an NV, and the resulting NV is not
2532 the translation of the initial data.
2534 This means that if we cache such a UV, we need to cache the
2535 NV as well. Moreover, we trade speed for space, and do not
2536 cache the NV if not needed.
2539 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2540 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2541 == IS_NUMBER_IN_UV) {
2542 /* It's definitely an integer, only upgrade to PVIV */
2543 if (SvTYPE(sv) < SVt_PVIV)
2544 sv_upgrade(sv, SVt_PVIV);
2546 } else if (SvTYPE(sv) < SVt_PVNV)
2547 sv_upgrade(sv, SVt_PVNV);
2549 /* If NV preserves UV then we only use the UV value if we know that
2550 we aren't going to call atof() below. If NVs don't preserve UVs
2551 then the value returned may have more precision than atof() will
2552 return, even though it isn't accurate. */
2553 if ((numtype & (IS_NUMBER_IN_UV
2554 #ifdef NV_PRESERVES_UV
2557 )) == IS_NUMBER_IN_UV) {
2558 /* This won't turn off the public IOK flag if it was set above */
2559 (void)SvIOKp_on(sv);
2561 if (!(numtype & IS_NUMBER_NEG)) {
2563 if (value <= (UV)IV_MAX) {
2564 SvIV_set(sv, (IV)value);
2566 /* it didn't overflow, and it was positive. */
2567 SvUV_set(sv, value);
2571 /* 2s complement assumption */
2572 if (value <= (UV)IV_MIN) {
2573 SvIV_set(sv, -(IV)value);
2575 /* Too negative for an IV. This is a double upgrade, but
2576 I'm assuming it will be rare. */
2577 if (SvTYPE(sv) < SVt_PVNV)
2578 sv_upgrade(sv, SVt_PVNV);
2582 SvNV_set(sv, -(NV)value);
2583 SvIV_set(sv, IV_MIN);
2588 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2589 != IS_NUMBER_IN_UV) {
2590 /* It wasn't an integer, or it overflowed the UV. */
2591 SvNV_set(sv, Atof(SvPVX_const(sv)));
2593 if (! numtype && ckWARN(WARN_NUMERIC))
2596 #if defined(USE_LONG_DOUBLE)
2597 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2598 PTR2UV(sv), SvNVX(sv)));
2600 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2601 PTR2UV(sv), SvNVX(sv)));
2604 #ifdef NV_PRESERVES_UV
2605 (void)SvIOKp_on(sv);
2607 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2608 SvIV_set(sv, I_V(SvNVX(sv)));
2609 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2612 /* Integer is imprecise. NOK, IOKp */
2614 /* UV will not work better than IV */
2616 if (SvNVX(sv) > (NV)UV_MAX) {
2618 /* Integer is inaccurate. NOK, IOKp, is UV */
2619 SvUV_set(sv, UV_MAX);
2622 SvUV_set(sv, U_V(SvNVX(sv)));
2623 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2624 NV preservse UV so can do correct comparison. */
2625 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2629 /* Integer is imprecise. NOK, IOKp, is UV */
2634 #else /* NV_PRESERVES_UV */
2635 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2636 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2637 /* The UV slot will have been set from value returned by
2638 grok_number above. The NV slot has just been set using
2641 assert (SvIOKp(sv));
2643 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2644 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2645 /* Small enough to preserve all bits. */
2646 (void)SvIOKp_on(sv);
2648 SvIV_set(sv, I_V(SvNVX(sv)));
2649 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2651 /* Assumption: first non-preserved integer is < IV_MAX,
2652 this NV is in the preserved range, therefore: */
2653 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2655 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);
2658 sv_2iuv_non_preserve (sv, numtype);
2660 #endif /* NV_PRESERVES_UV */
2664 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2665 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2668 if (SvTYPE(sv) < SVt_IV)
2669 /* Typically the caller expects that sv_any is not NULL now. */
2670 sv_upgrade(sv, SVt_IV);
2674 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2675 PTR2UV(sv),SvUVX(sv)));
2676 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2682 Return the num value of an SV, doing any necessary string or integer
2683 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2690 Perl_sv_2nv(pTHX_ register SV *sv)
2694 if (SvGMAGICAL(sv)) {
2698 if (SvPOKp(sv) && SvLEN(sv)) {
2699 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2700 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2702 return Atof(SvPVX_const(sv));
2706 return (NV)SvUVX(sv);
2708 return (NV)SvIVX(sv);
2711 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2712 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2718 if (SvTHINKFIRST(sv)) {
2721 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2722 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2723 return SvNV(tmpstr);
2724 return PTR2NV(SvRV(sv));
2727 sv_force_normal_flags(sv, 0);
2729 if (SvREADONLY(sv) && !SvOK(sv)) {
2730 if (ckWARN(WARN_UNINITIALIZED))
2735 if (SvTYPE(sv) < SVt_NV) {
2736 if (SvTYPE(sv) == SVt_IV)
2737 sv_upgrade(sv, SVt_PVNV);
2739 sv_upgrade(sv, SVt_NV);
2740 #ifdef USE_LONG_DOUBLE
2742 STORE_NUMERIC_LOCAL_SET_STANDARD();
2743 PerlIO_printf(Perl_debug_log,
2744 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2745 PTR2UV(sv), SvNVX(sv));
2746 RESTORE_NUMERIC_LOCAL();
2750 STORE_NUMERIC_LOCAL_SET_STANDARD();
2751 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2752 PTR2UV(sv), SvNVX(sv));
2753 RESTORE_NUMERIC_LOCAL();
2757 else if (SvTYPE(sv) < SVt_PVNV)
2758 sv_upgrade(sv, SVt_PVNV);
2763 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2764 #ifdef NV_PRESERVES_UV
2767 /* Only set the public NV OK flag if this NV preserves the IV */
2768 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2769 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2770 : (SvIVX(sv) == I_V(SvNVX(sv))))
2776 else if (SvPOKp(sv) && SvLEN(sv)) {
2778 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2779 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2781 #ifdef NV_PRESERVES_UV
2782 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2783 == IS_NUMBER_IN_UV) {
2784 /* It's definitely an integer */
2785 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2787 SvNV_set(sv, Atof(SvPVX_const(sv)));
2790 SvNV_set(sv, Atof(SvPVX_const(sv)));
2791 /* Only set the public NV OK flag if this NV preserves the value in
2792 the PV at least as well as an IV/UV would.
2793 Not sure how to do this 100% reliably. */
2794 /* if that shift count is out of range then Configure's test is
2795 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2797 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2798 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2799 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2800 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2801 /* Can't use strtol etc to convert this string, so don't try.
2802 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2805 /* value has been set. It may not be precise. */
2806 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2807 /* 2s complement assumption for (UV)IV_MIN */
2808 SvNOK_on(sv); /* Integer is too negative. */
2813 if (numtype & IS_NUMBER_NEG) {
2814 SvIV_set(sv, -(IV)value);
2815 } else if (value <= (UV)IV_MAX) {
2816 SvIV_set(sv, (IV)value);
2818 SvUV_set(sv, value);
2822 if (numtype & IS_NUMBER_NOT_INT) {
2823 /* I believe that even if the original PV had decimals,
2824 they are lost beyond the limit of the FP precision.
2825 However, neither is canonical, so both only get p
2826 flags. NWC, 2000/11/25 */
2827 /* Both already have p flags, so do nothing */
2829 const NV nv = SvNVX(sv);
2830 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2831 if (SvIVX(sv) == I_V(nv)) {
2836 /* It had no "." so it must be integer. */
2839 /* between IV_MAX and NV(UV_MAX).
2840 Could be slightly > UV_MAX */
2842 if (numtype & IS_NUMBER_NOT_INT) {
2843 /* UV and NV both imprecise. */
2845 const UV nv_as_uv = U_V(nv);
2847 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2858 #endif /* NV_PRESERVES_UV */
2861 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2863 if (SvTYPE(sv) < SVt_NV)
2864 /* Typically the caller expects that sv_any is not NULL now. */
2865 /* XXX Ilya implies that this is a bug in callers that assume this
2866 and ideally should be fixed. */
2867 sv_upgrade(sv, SVt_NV);
2870 #if defined(USE_LONG_DOUBLE)
2872 STORE_NUMERIC_LOCAL_SET_STANDARD();
2873 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2874 PTR2UV(sv), SvNVX(sv));
2875 RESTORE_NUMERIC_LOCAL();
2879 STORE_NUMERIC_LOCAL_SET_STANDARD();
2880 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2881 PTR2UV(sv), SvNVX(sv));
2882 RESTORE_NUMERIC_LOCAL();
2888 /* asIV(): extract an integer from the string value of an SV.
2889 * Caller must validate PVX */
2892 S_asIV(pTHX_ SV *sv)
2895 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2897 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2898 == IS_NUMBER_IN_UV) {
2899 /* It's definitely an integer */
2900 if (numtype & IS_NUMBER_NEG) {
2901 if (value < (UV)IV_MIN)
2904 if (value < (UV)IV_MAX)
2909 if (ckWARN(WARN_NUMERIC))
2912 return I_V(Atof(SvPVX_const(sv)));
2915 /* asUV(): extract an unsigned integer from the string value of an SV
2916 * Caller must validate PVX */
2919 S_asUV(pTHX_ SV *sv)
2922 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2924 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2925 == IS_NUMBER_IN_UV) {
2926 /* It's definitely an integer */
2927 if (!(numtype & IS_NUMBER_NEG))
2931 if (ckWARN(WARN_NUMERIC))
2934 return U_V(Atof(SvPVX_const(sv)));
2938 =for apidoc sv_2pv_nolen
2940 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2941 use the macro wrapper C<SvPV_nolen(sv)> instead.
2946 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2948 return sv_2pv(sv, 0);
2951 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2952 * UV as a string towards the end of buf, and return pointers to start and
2955 * We assume that buf is at least TYPE_CHARS(UV) long.
2959 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2961 char *ptr = buf + TYPE_CHARS(UV);
2975 *--ptr = '0' + (char)(uv % 10);
2983 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2984 * this function provided for binary compatibility only
2988 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2990 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2994 =for apidoc sv_2pv_flags
2996 Returns a pointer to the string value of an SV, and sets *lp to its length.
2997 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2999 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3000 usually end up here too.
3006 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3011 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3012 char *tmpbuf = tbuf;
3019 if (SvGMAGICAL(sv)) {
3020 if (flags & SV_GMAGIC)
3025 if (flags & SV_MUTABLE_RETURN)
3026 return SvPVX_mutable(sv);
3027 if (flags & SV_CONST_RETURN)
3028 return (char *)SvPVX_const(sv);
3033 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3035 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3040 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3045 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3046 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
3054 if (SvTHINKFIRST(sv)) {
3057 register const char *typestr;
3058 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3059 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3061 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3064 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3065 if (flags & SV_CONST_RETURN) {
3066 pv = (char *) SvPVX_const(tmpstr);
3068 pv = (flags & SV_MUTABLE_RETURN)
3069 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3072 *lp = SvCUR(tmpstr);
3074 pv = sv_2pv_flags(tmpstr, lp, flags);
3085 typestr = "NULLREF";
3089 switch (SvTYPE(sv)) {
3091 if ( ((SvFLAGS(sv) &
3092 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3093 == (SVs_OBJECT|SVs_SMG))
3094 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3095 const regexp *re = (regexp *)mg->mg_obj;
3098 const char *fptr = "msix";
3103 char need_newline = 0;
3104 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3106 while((ch = *fptr++)) {
3108 reflags[left++] = ch;
3111 reflags[right--] = ch;
3116 reflags[left] = '-';
3120 mg->mg_len = re->prelen + 4 + left;
3122 * If /x was used, we have to worry about a regex
3123 * ending with a comment later being embedded
3124 * within another regex. If so, we don't want this
3125 * regex's "commentization" to leak out to the
3126 * right part of the enclosing regex, we must cap
3127 * it with a newline.
3129 * So, if /x was used, we scan backwards from the
3130 * end of the regex. If we find a '#' before we
3131 * find a newline, we need to add a newline
3132 * ourself. If we find a '\n' first (or if we
3133 * don't find '#' or '\n'), we don't need to add
3134 * anything. -jfriedl
3136 if (PMf_EXTENDED & re->reganch)
3138 const char *endptr = re->precomp + re->prelen;
3139 while (endptr >= re->precomp)
3141 const char c = *(endptr--);
3143 break; /* don't need another */
3145 /* we end while in a comment, so we
3147 mg->mg_len++; /* save space for it */
3148 need_newline = 1; /* note to add it */
3154 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3155 Copy("(?", mg->mg_ptr, 2, char);
3156 Copy(reflags, mg->mg_ptr+2, left, char);
3157 Copy(":", mg->mg_ptr+left+2, 1, char);
3158 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3160 mg->mg_ptr[mg->mg_len - 2] = '\n';
3161 mg->mg_ptr[mg->mg_len - 1] = ')';
3162 mg->mg_ptr[mg->mg_len] = 0;
3164 PL_reginterp_cnt += re->program[0].next_off;
3166 if (re->reganch & ROPT_UTF8)
3182 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3183 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3184 /* tied lvalues should appear to be
3185 * scalars for backwards compatitbility */
3186 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3187 ? "SCALAR" : "LVALUE"; break;
3188 case SVt_PVAV: typestr = "ARRAY"; break;
3189 case SVt_PVHV: typestr = "HASH"; break;
3190 case SVt_PVCV: typestr = "CODE"; break;
3191 case SVt_PVGV: typestr = "GLOB"; break;
3192 case SVt_PVFM: typestr = "FORMAT"; break;
3193 case SVt_PVIO: typestr = "IO"; break;
3194 default: typestr = "UNKNOWN"; break;
3198 const char *name = HvNAME_get(SvSTASH(sv));
3199 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3200 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3203 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3207 *lp = strlen(typestr);
3208 return (char *)typestr;
3210 if (SvREADONLY(sv) && !SvOK(sv)) {
3211 if (ckWARN(WARN_UNINITIALIZED))
3218 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3219 /* I'm assuming that if both IV and NV are equally valid then
3220 converting the IV is going to be more efficient */
3221 const U32 isIOK = SvIOK(sv);
3222 const U32 isUIOK = SvIsUV(sv);
3223 char buf[TYPE_CHARS(UV)];
3226 if (SvTYPE(sv) < SVt_PVIV)
3227 sv_upgrade(sv, SVt_PVIV);
3229 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3231 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3232 /* inlined from sv_setpvn */
3233 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3234 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3235 SvCUR_set(sv, ebuf - ptr);
3245 else if (SvNOKp(sv)) {
3246 if (SvTYPE(sv) < SVt_PVNV)
3247 sv_upgrade(sv, SVt_PVNV);
3248 /* The +20 is pure guesswork. Configure test needed. --jhi */
3249 s = SvGROW_mutable(sv, NV_DIG + 20);
3250 olderrno = errno; /* some Xenix systems wipe out errno here */
3252 if (SvNVX(sv) == 0.0)
3253 (void)strcpy(s,"0");
3257 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3260 #ifdef FIXNEGATIVEZERO
3261 if (*s == '-' && s[1] == '0' && !s[2])
3271 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3275 if (SvTYPE(sv) < SVt_PV)
3276 /* Typically the caller expects that sv_any is not NULL now. */
3277 sv_upgrade(sv, SVt_PV);
3281 STRLEN len = s - SvPVX_const(sv);
3287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3288 PTR2UV(sv),SvPVX_const(sv)));
3289 if (flags & SV_CONST_RETURN)
3290 return (char *)SvPVX_const(sv);
3291 if (flags & SV_MUTABLE_RETURN)
3292 return SvPVX_mutable(sv);
3296 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3297 /* Sneaky stuff here */
3301 tsv = newSVpv(tmpbuf, 0);
3314 t = SvPVX_const(tsv);
3319 len = strlen(tmpbuf);
3321 #ifdef FIXNEGATIVEZERO
3322 if (len == 2 && t[0] == '-' && t[1] == '0') {
3327 SvUPGRADE(sv, SVt_PV);
3330 s = SvGROW_mutable(sv, len + 1);
3333 return memcpy(s, t, len + 1);
3338 =for apidoc sv_copypv
3340 Copies a stringified representation of the source SV into the
3341 destination SV. Automatically performs any necessary mg_get and
3342 coercion of numeric values into strings. Guaranteed to preserve
3343 UTF-8 flag even from overloaded objects. Similar in nature to
3344 sv_2pv[_flags] but operates directly on an SV instead of just the
3345 string. Mostly uses sv_2pv_flags to do its work, except when that
3346 would lose the UTF-8'ness of the PV.
3352 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3355 const char * const s = SvPV_const(ssv,len);
3356 sv_setpvn(dsv,s,len);
3364 =for apidoc sv_2pvbyte_nolen
3366 Return a pointer to the byte-encoded representation of the SV.
3367 May cause the SV to be downgraded from UTF-8 as a side-effect.
3369 Usually accessed via the C<SvPVbyte_nolen> macro.
3375 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3377 return sv_2pvbyte(sv, 0);
3381 =for apidoc sv_2pvbyte
3383 Return a pointer to the byte-encoded representation of the SV, and set *lp
3384 to its length. May cause the SV to be downgraded from UTF-8 as a
3387 Usually accessed via the C<SvPVbyte> macro.
3393 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3395 sv_utf8_downgrade(sv,0);
3396 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3400 =for apidoc sv_2pvutf8_nolen
3402 Return a pointer to the UTF-8-encoded representation of the SV.
3403 May cause the SV to be upgraded to UTF-8 as a side-effect.
3405 Usually accessed via the C<SvPVutf8_nolen> macro.
3411 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3413 return sv_2pvutf8(sv, 0);
3417 =for apidoc sv_2pvutf8
3419 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3420 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3422 Usually accessed via the C<SvPVutf8> macro.
3428 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3430 sv_utf8_upgrade(sv);
3431 return SvPV(sv,*lp);
3435 =for apidoc sv_2bool
3437 This function is only called on magical items, and is only used by
3438 sv_true() or its macro equivalent.
3444 Perl_sv_2bool(pTHX_ register SV *sv)
3453 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3454 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3455 return (bool)SvTRUE(tmpsv);
3456 return SvRV(sv) != 0;
3459 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3461 (*sv->sv_u.svu_pv > '0' ||
3462 Xpvtmp->xpv_cur > 1 ||
3463 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3470 return SvIVX(sv) != 0;
3473 return SvNVX(sv) != 0.0;
3480 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3481 * this function provided for binary compatibility only
3486 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3488 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3492 =for apidoc sv_utf8_upgrade
3494 Converts the PV of an SV to its UTF-8-encoded form.
3495 Forces the SV to string form if it is not already.
3496 Always sets the SvUTF8 flag to avoid future validity checks even
3497 if all the bytes have hibit clear.
3499 This is not as a general purpose byte encoding to Unicode interface:
3500 use the Encode extension for that.
3502 =for apidoc sv_utf8_upgrade_flags
3504 Converts the PV of an SV to its UTF-8-encoded form.
3505 Forces the SV to string form if it is not already.
3506 Always sets the SvUTF8 flag to avoid future validity checks even
3507 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3508 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3509 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3511 This is not as a general purpose byte encoding to Unicode interface:
3512 use the Encode extension for that.
3518 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3520 if (sv == &PL_sv_undef)
3524 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3525 (void) sv_2pv_flags(sv,&len, flags);
3529 (void) SvPV_force(sv,len);
3538 sv_force_normal_flags(sv, 0);
3541 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3542 sv_recode_to_utf8(sv, PL_encoding);
3543 else { /* Assume Latin-1/EBCDIC */
3544 /* This function could be much more efficient if we
3545 * had a FLAG in SVs to signal if there are any hibit
3546 * chars in the PV. Given that there isn't such a flag
3547 * make the loop as fast as possible. */
3548 const U8 *s = (U8 *) SvPVX_const(sv);
3549 const U8 *e = (U8 *) SvEND(sv);
3555 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3559 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3560 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3562 SvPV_free(sv); /* No longer using what was there before. */
3564 SvPV_set(sv, (char*)recoded);
3565 SvCUR_set(sv, len - 1);
3566 SvLEN_set(sv, len); /* No longer know the real size. */
3568 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3575 =for apidoc sv_utf8_downgrade
3577 Attempts to convert the PV of an SV from characters to bytes.
3578 If the PV contains a character beyond byte, this conversion will fail;
3579 in this case, either returns false or, if C<fail_ok> is not
3582 This is not as a general purpose Unicode to byte encoding interface:
3583 use the Encode extension for that.
3589 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3591 if (SvPOKp(sv) && SvUTF8(sv)) {
3597 sv_force_normal_flags(sv, 0);
3599 s = (U8 *) SvPV(sv, len);
3600 if (!utf8_to_bytes(s, &len)) {
3605 Perl_croak(aTHX_ "Wide character in %s",
3608 Perl_croak(aTHX_ "Wide character");
3619 =for apidoc sv_utf8_encode
3621 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3622 flag off so that it looks like octets again.
3628 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3630 (void) sv_utf8_upgrade(sv);
3632 sv_force_normal_flags(sv, 0);
3634 if (SvREADONLY(sv)) {
3635 Perl_croak(aTHX_ PL_no_modify);
3641 =for apidoc sv_utf8_decode
3643 If the PV of the SV is an octet sequence in UTF-8
3644 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3645 so that it looks like a character. If the PV contains only single-byte
3646 characters, the C<SvUTF8> flag stays being off.
3647 Scans PV for validity and returns false if the PV is invalid UTF-8.
3653 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3659 /* The octets may have got themselves encoded - get them back as
3662 if (!sv_utf8_downgrade(sv, TRUE))
3665 /* it is actually just a matter of turning the utf8 flag on, but
3666 * we want to make sure everything inside is valid utf8 first.
3668 c = (const U8 *) SvPVX_const(sv);
3669 if (!is_utf8_string(c, SvCUR(sv)+1))
3671 e = (const U8 *) SvEND(sv);
3674 if (!UTF8_IS_INVARIANT(ch)) {
3683 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3684 * this function provided for binary compatibility only
3688 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3690 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3694 =for apidoc sv_setsv
3696 Copies the contents of the source SV C<ssv> into the destination SV
3697 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3698 function if the source SV needs to be reused. Does not handle 'set' magic.
3699 Loosely speaking, it performs a copy-by-value, obliterating any previous
3700 content of the destination.
3702 You probably want to use one of the assortment of wrappers, such as
3703 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3704 C<SvSetMagicSV_nosteal>.
3706 =for apidoc sv_setsv_flags
3708 Copies the contents of the source SV C<ssv> into the destination SV
3709 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3710 function if the source SV needs to be reused. Does not handle 'set' magic.
3711 Loosely speaking, it performs a copy-by-value, obliterating any previous
3712 content of the destination.
3713 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3714 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3715 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3716 and C<sv_setsv_nomg> are implemented in terms of this function.
3718 You probably want to use one of the assortment of wrappers, such as
3719 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3720 C<SvSetMagicSV_nosteal>.
3722 This is the primary function for copying scalars, and most other
3723 copy-ish functions and macros use this underneath.
3729 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3731 register U32 sflags;
3737 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3739 sstr = &PL_sv_undef;
3740 stype = SvTYPE(sstr);
3741 dtype = SvTYPE(dstr);
3746 /* need to nuke the magic */
3748 SvRMAGICAL_off(dstr);
3751 /* There's a lot of redundancy below but we're going for speed here */
3756 if (dtype != SVt_PVGV) {
3757 (void)SvOK_off(dstr);
3765 sv_upgrade(dstr, SVt_IV);
3768 sv_upgrade(dstr, SVt_PVNV);
3772 sv_upgrade(dstr, SVt_PVIV);
3775 (void)SvIOK_only(dstr);
3776 SvIV_set(dstr, SvIVX(sstr));
3779 if (SvTAINTED(sstr))
3790 sv_upgrade(dstr, SVt_NV);
3795 sv_upgrade(dstr, SVt_PVNV);
3798 SvNV_set(dstr, SvNVX(sstr));
3799 (void)SvNOK_only(dstr);
3800 if (SvTAINTED(sstr))
3808 sv_upgrade(dstr, SVt_RV);
3809 else if (dtype == SVt_PVGV &&
3810 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3813 if (GvIMPORTED(dstr) != GVf_IMPORTED
3814 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3816 GvIMPORTED_on(dstr);
3825 #ifdef PERL_OLD_COPY_ON_WRITE
3826 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3827 if (dtype < SVt_PVIV)
3828 sv_upgrade(dstr, SVt_PVIV);
3835 sv_upgrade(dstr, SVt_PV);
3838 if (dtype < SVt_PVIV)
3839 sv_upgrade(dstr, SVt_PVIV);
3842 if (dtype < SVt_PVNV)
3843 sv_upgrade(dstr, SVt_PVNV);
3850 const char * const type = sv_reftype(sstr,0);
3852 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3854 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3859 if (dtype <= SVt_PVGV) {
3861 if (dtype != SVt_PVGV) {
3862 const char * const name = GvNAME(sstr);
3863 const STRLEN len = GvNAMELEN(sstr);
3864 /* don't upgrade SVt_PVLV: it can hold a glob */
3865 if (dtype != SVt_PVLV)
3866 sv_upgrade(dstr, SVt_PVGV);
3867 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3868 GvSTASH(dstr) = GvSTASH(sstr);
3870 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3871 GvNAME(dstr) = savepvn(name, len);
3872 GvNAMELEN(dstr) = len;
3873 SvFAKE_on(dstr); /* can coerce to non-glob */
3875 /* ahem, death to those who redefine active sort subs */
3876 else if (PL_curstackinfo->si_type == PERLSI_SORT
3877 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3878 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3881 #ifdef GV_UNIQUE_CHECK
3882 if (GvUNIQUE((GV*)dstr)) {
3883 Perl_croak(aTHX_ PL_no_modify);
3887 (void)SvOK_off(dstr);
3888 GvINTRO_off(dstr); /* one-shot flag */
3890 GvGP(dstr) = gp_ref(GvGP(sstr));
3891 if (SvTAINTED(sstr))
3893 if (GvIMPORTED(dstr) != GVf_IMPORTED
3894 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3896 GvIMPORTED_on(dstr);
3904 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3906 if ((int)SvTYPE(sstr) != stype) {
3907 stype = SvTYPE(sstr);
3908 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3912 if (stype == SVt_PVLV)
3913 SvUPGRADE(dstr, SVt_PVNV);
3915 SvUPGRADE(dstr, (U32)stype);
3918 sflags = SvFLAGS(sstr);
3920 if (sflags & SVf_ROK) {
3921 if (dtype >= SVt_PV) {
3922 if (dtype == SVt_PVGV) {
3923 SV *sref = SvREFCNT_inc(SvRV(sstr));
3925 const int intro = GvINTRO(dstr);
3927 #ifdef GV_UNIQUE_CHECK
3928 if (GvUNIQUE((GV*)dstr)) {
3929 Perl_croak(aTHX_ PL_no_modify);
3934 GvINTRO_off(dstr); /* one-shot flag */
3935 GvLINE(dstr) = CopLINE(PL_curcop);
3936 GvEGV(dstr) = (GV*)dstr;
3939 switch (SvTYPE(sref)) {
3942 SAVEGENERICSV(GvAV(dstr));
3944 dref = (SV*)GvAV(dstr);
3945 GvAV(dstr) = (AV*)sref;
3946 if (!GvIMPORTED_AV(dstr)
3947 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3949 GvIMPORTED_AV_on(dstr);
3954 SAVEGENERICSV(GvHV(dstr));
3956 dref = (SV*)GvHV(dstr);
3957 GvHV(dstr) = (HV*)sref;
3958 if (!GvIMPORTED_HV(dstr)
3959 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3961 GvIMPORTED_HV_on(dstr);
3966 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3967 SvREFCNT_dec(GvCV(dstr));
3968 GvCV(dstr) = Nullcv;
3969 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3970 PL_sub_generation++;
3972 SAVEGENERICSV(GvCV(dstr));
3975 dref = (SV*)GvCV(dstr);
3976 if (GvCV(dstr) != (CV*)sref) {
3977 CV* cv = GvCV(dstr);
3979 if (!GvCVGEN((GV*)dstr) &&
3980 (CvROOT(cv) || CvXSUB(cv)))
3982 /* ahem, death to those who redefine
3983 * active sort subs */
3984 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3985 PL_sortcop == CvSTART(cv))
3987 "Can't redefine active sort subroutine %s",
3988 GvENAME((GV*)dstr));
3989 /* Redefining a sub - warning is mandatory if
3990 it was a const and its value changed. */
3991 if (ckWARN(WARN_REDEFINE)
3993 && (!CvCONST((CV*)sref)
3994 || sv_cmp(cv_const_sv(cv),
3995 cv_const_sv((CV*)sref)))))
3997 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3999 ? "Constant subroutine %s::%s redefined"
4000 : "Subroutine %s::%s redefined",
4001 HvNAME_get(GvSTASH((GV*)dstr)),
4002 GvENAME((GV*)dstr));
4006 cv_ckproto(cv, (GV*)dstr,
4008 ? SvPVX_const(sref) : Nullch);
4010 GvCV(dstr) = (CV*)sref;
4011 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4012 GvASSUMECV_on(dstr);
4013 PL_sub_generation++;
4015 if (!GvIMPORTED_CV(dstr)
4016 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4018 GvIMPORTED_CV_on(dstr);
4023 SAVEGENERICSV(GvIOp(dstr));
4025 dref = (SV*)GvIOp(dstr);
4026 GvIOp(dstr) = (IO*)sref;
4030 SAVEGENERICSV(GvFORM(dstr));
4032 dref = (SV*)GvFORM(dstr);
4033 GvFORM(dstr) = (CV*)sref;
4037 SAVEGENERICSV(GvSV(dstr));
4039 dref = (SV*)GvSV(dstr);
4041 if (!GvIMPORTED_SV(dstr)
4042 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4044 GvIMPORTED_SV_on(dstr);
4050 if (SvTAINTED(sstr))
4054 if (SvPVX_const(dstr)) {
4060 (void)SvOK_off(dstr);
4061 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4063 if (sflags & SVp_NOK) {
4065 /* Only set the public OK flag if the source has public OK. */
4066 if (sflags & SVf_NOK)
4067 SvFLAGS(dstr) |= SVf_NOK;
4068 SvNV_set(dstr, SvNVX(sstr));
4070 if (sflags & SVp_IOK) {
4071 (void)SvIOKp_on(dstr);
4072 if (sflags & SVf_IOK)
4073 SvFLAGS(dstr) |= SVf_IOK;
4074 if (sflags & SVf_IVisUV)
4076 SvIV_set(dstr, SvIVX(sstr));
4078 if (SvAMAGIC(sstr)) {
4082 else if (sflags & SVp_POK) {
4086 * Check to see if we can just swipe the string. If so, it's a
4087 * possible small lose on short strings, but a big win on long ones.
4088 * It might even be a win on short strings if SvPVX_const(dstr)
4089 * has to be allocated and SvPVX_const(sstr) has to be freed.
4092 /* Whichever path we take through the next code, we want this true,
4093 and doing it now facilitates the COW check. */
4094 (void)SvPOK_only(dstr);
4097 /* We're not already COW */
4098 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4099 #ifndef PERL_OLD_COPY_ON_WRITE
4100 /* or we are, but dstr isn't a suitable target. */
4101 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4106 (sflags & SVs_TEMP) && /* slated for free anyway? */
4107 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4108 (!(flags & SV_NOSTEAL)) &&
4109 /* and we're allowed to steal temps */
4110 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4111 SvLEN(sstr) && /* and really is a string */
4112 /* and won't be needed again, potentially */
4113 !(PL_op && PL_op->op_type == OP_AASSIGN))
4114 #ifdef PERL_OLD_COPY_ON_WRITE
4115 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4116 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4117 && SvTYPE(sstr) >= SVt_PVIV)
4120 /* Failed the swipe test, and it's not a shared hash key either.
4121 Have to copy the string. */
4122 STRLEN len = SvCUR(sstr);
4123 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4124 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4125 SvCUR_set(dstr, len);
4126 *SvEND(dstr) = '\0';
4128 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4130 /* Either it's a shared hash key, or it's suitable for
4131 copy-on-write or we can swipe the string. */
4133 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4137 #ifdef PERL_OLD_COPY_ON_WRITE
4139 /* I believe I should acquire a global SV mutex if
4140 it's a COW sv (not a shared hash key) to stop
4141 it going un copy-on-write.
4142 If the source SV has gone un copy on write between up there
4143 and down here, then (assert() that) it is of the correct
4144 form to make it copy on write again */
4145 if ((sflags & (SVf_FAKE | SVf_READONLY))
4146 != (SVf_FAKE | SVf_READONLY)) {
4147 SvREADONLY_on(sstr);
4149 /* Make the source SV into a loop of 1.
4150 (about to become 2) */
4151 SV_COW_NEXT_SV_SET(sstr, sstr);
4155 /* Initial code is common. */
4156 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4161 /* making another shared SV. */
4162 STRLEN cur = SvCUR(sstr);
4163 STRLEN len = SvLEN(sstr);
4164 #ifdef PERL_OLD_COPY_ON_WRITE
4166 assert (SvTYPE(dstr) >= SVt_PVIV);
4167 /* SvIsCOW_normal */
4168 /* splice us in between source and next-after-source. */
4169 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4170 SV_COW_NEXT_SV_SET(sstr, dstr);
4171 SvPV_set(dstr, SvPVX_mutable(sstr));
4175 /* SvIsCOW_shared_hash */
4176 DEBUG_C(PerlIO_printf(Perl_debug_log,
4177 "Copy on write: Sharing hash\n"));
4179 assert (SvTYPE(dstr) >= SVt_PV);
4181 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4183 SvLEN_set(dstr, len);
4184 SvCUR_set(dstr, cur);
4185 SvREADONLY_on(dstr);
4187 /* Relesase a global SV mutex. */
4190 { /* Passes the swipe test. */
4191 SvPV_set(dstr, SvPVX_mutable(sstr));
4192 SvLEN_set(dstr, SvLEN(sstr));
4193 SvCUR_set(dstr, SvCUR(sstr));
4196 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4197 SvPV_set(sstr, Nullch);
4203 if (sflags & SVf_UTF8)
4205 if (sflags & SVp_NOK) {
4207 if (sflags & SVf_NOK)
4208 SvFLAGS(dstr) |= SVf_NOK;
4209 SvNV_set(dstr, SvNVX(sstr));
4211 if (sflags & SVp_IOK) {
4212 (void)SvIOKp_on(dstr);
4213 if (sflags & SVf_IOK)
4214 SvFLAGS(dstr) |= SVf_IOK;
4215 if (sflags & SVf_IVisUV)
4217 SvIV_set(dstr, SvIVX(sstr));
4220 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4221 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4222 smg->mg_ptr, smg->mg_len);
4223 SvRMAGICAL_on(dstr);
4226 else if (sflags & SVp_IOK) {
4227 if (sflags & SVf_IOK)
4228 (void)SvIOK_only(dstr);
4230 (void)SvOK_off(dstr);
4231 (void)SvIOKp_on(dstr);
4233 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4234 if (sflags & SVf_IVisUV)
4236 SvIV_set(dstr, SvIVX(sstr));
4237 if (sflags & SVp_NOK) {
4238 if (sflags & SVf_NOK)
4239 (void)SvNOK_on(dstr);
4241 (void)SvNOKp_on(dstr);
4242 SvNV_set(dstr, SvNVX(sstr));
4245 else if (sflags & SVp_NOK) {
4246 if (sflags & SVf_NOK)
4247 (void)SvNOK_only(dstr);
4249 (void)SvOK_off(dstr);
4252 SvNV_set(dstr, SvNVX(sstr));
4255 if (dtype == SVt_PVGV) {
4256 if (ckWARN(WARN_MISC))
4257 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4260 (void)SvOK_off(dstr);
4262 if (SvTAINTED(sstr))
4267 =for apidoc sv_setsv_mg
4269 Like C<sv_setsv>, but also handles 'set' magic.
4275 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4277 sv_setsv(dstr,sstr);
4281 #ifdef PERL_OLD_COPY_ON_WRITE
4283 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4285 STRLEN cur = SvCUR(sstr);
4286 STRLEN len = SvLEN(sstr);
4287 register char *new_pv;
4290 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4298 if (SvTHINKFIRST(dstr))
4299 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4300 else if (SvPVX_const(dstr))
4301 Safefree(SvPVX_const(dstr));
4305 SvUPGRADE(dstr, SVt_PVIV);
4307 assert (SvPOK(sstr));
4308 assert (SvPOKp(sstr));
4309 assert (!SvIOK(sstr));
4310 assert (!SvIOKp(sstr));
4311 assert (!SvNOK(sstr));
4312 assert (!SvNOKp(sstr));
4314 if (SvIsCOW(sstr)) {
4316 if (SvLEN(sstr) == 0) {
4317 /* source is a COW shared hash key. */
4318 DEBUG_C(PerlIO_printf(Perl_debug_log,
4319 "Fast copy on write: Sharing hash\n"));
4320 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4323 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4325 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4326 SvUPGRADE(sstr, SVt_PVIV);
4327 SvREADONLY_on(sstr);
4329 DEBUG_C(PerlIO_printf(Perl_debug_log,
4330 "Fast copy on write: Converting sstr to COW\n"));
4331 SV_COW_NEXT_SV_SET(dstr, sstr);
4333 SV_COW_NEXT_SV_SET(sstr, dstr);
4334 new_pv = SvPVX_mutable(sstr);
4337 SvPV_set(dstr, new_pv);
4338 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4341 SvLEN_set(dstr, len);
4342 SvCUR_set(dstr, cur);
4351 =for apidoc sv_setpvn
4353 Copies a string into an SV. The C<len> parameter indicates the number of
4354 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4355 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4361 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4363 register char *dptr;
4365 SV_CHECK_THINKFIRST_COW_DROP(sv);
4371 /* len is STRLEN which is unsigned, need to copy to signed */
4374 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4376 SvUPGRADE(sv, SVt_PV);
4378 dptr = SvGROW(sv, len + 1);
4379 Move(ptr,dptr,len,char);
4382 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4387 =for apidoc sv_setpvn_mg
4389 Like C<sv_setpvn>, but also handles 'set' magic.
4395 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4397 sv_setpvn(sv,ptr,len);
4402 =for apidoc sv_setpv
4404 Copies a string into an SV. The string must be null-terminated. Does not
4405 handle 'set' magic. See C<sv_setpv_mg>.
4411 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4413 register STRLEN len;
4415 SV_CHECK_THINKFIRST_COW_DROP(sv);
4421 SvUPGRADE(sv, SVt_PV);
4423 SvGROW(sv, len + 1);
4424 Move(ptr,SvPVX(sv),len+1,char);
4426 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4431 =for apidoc sv_setpv_mg
4433 Like C<sv_setpv>, but also handles 'set' magic.
4439 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4446 =for apidoc sv_usepvn
4448 Tells an SV to use C<ptr> to find its string value. Normally the string is
4449 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4450 The C<ptr> should point to memory that was allocated by C<malloc>. The
4451 string length, C<len>, must be supplied. This function will realloc the
4452 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4453 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4454 See C<sv_usepvn_mg>.
4460 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4463 SV_CHECK_THINKFIRST_COW_DROP(sv);
4464 SvUPGRADE(sv, SVt_PV);
4469 if (SvPVX_const(sv))
4472 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4473 ptr = saferealloc (ptr, allocate);
4476 SvLEN_set(sv, allocate);
4478 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4483 =for apidoc sv_usepvn_mg
4485 Like C<sv_usepvn>, but also handles 'set' magic.
4491 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4493 sv_usepvn(sv,ptr,len);
4497 #ifdef PERL_OLD_COPY_ON_WRITE
4498 /* Need to do this *after* making the SV normal, as we need the buffer
4499 pointer to remain valid until after we've copied it. If we let go too early,
4500 another thread could invalidate it by unsharing last of the same hash key
4501 (which it can do by means other than releasing copy-on-write Svs)
4502 or by changing the other copy-on-write SVs in the loop. */
4504 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4506 if (len) { /* this SV was SvIsCOW_normal(sv) */
4507 /* we need to find the SV pointing to us. */
4508 SV * const current = SV_COW_NEXT_SV(after);
4510 if (current == sv) {
4511 /* The SV we point to points back to us (there were only two of us
4513 Hence other SV is no longer copy on write either. */
4515 SvREADONLY_off(after);
4517 /* We need to follow the pointers around the loop. */
4519 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4522 /* don't loop forever if the structure is bust, and we have
4523 a pointer into a closed loop. */
4524 assert (current != after);
4525 assert (SvPVX_const(current) == pvx);
4527 /* Make the SV before us point to the SV after us. */
4528 SV_COW_NEXT_SV_SET(current, after);
4531 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4536 Perl_sv_release_IVX(pTHX_ register SV *sv)
4539 sv_force_normal_flags(sv, 0);
4545 =for apidoc sv_force_normal_flags
4547 Undo various types of fakery on an SV: if the PV is a shared string, make
4548 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4549 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4550 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4551 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4552 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4553 set to some other value.) In addition, the C<flags> parameter gets passed to
4554 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4555 with flags set to 0.
4561 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4563 #ifdef PERL_OLD_COPY_ON_WRITE
4564 if (SvREADONLY(sv)) {
4565 /* At this point I believe I should acquire a global SV mutex. */
4567 const char * const pvx = SvPVX_const(sv);
4568 const STRLEN len = SvLEN(sv);
4569 const STRLEN cur = SvCUR(sv);
4570 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4572 PerlIO_printf(Perl_debug_log,
4573 "Copy on write: Force normal %ld\n",
4579 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4580 SvPV_set(sv, (char*)0);
4582 if (flags & SV_COW_DROP_PV) {
4583 /* OK, so we don't need to copy our buffer. */
4586 SvGROW(sv, cur + 1);
4587 Move(pvx,SvPVX(sv),cur,char);
4591 sv_release_COW(sv, pvx, len, next);
4596 else if (IN_PERL_RUNTIME)
4597 Perl_croak(aTHX_ PL_no_modify);
4598 /* At this point I believe that I can drop the global SV mutex. */
4601 if (SvREADONLY(sv)) {
4603 const char * const pvx = SvPVX_const(sv);
4604 const STRLEN len = SvCUR(sv);
4607 SvPV_set(sv, Nullch);
4609 SvGROW(sv, len + 1);
4610 Move(pvx,SvPVX_const(sv),len,char);
4612 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4614 else if (IN_PERL_RUNTIME)
4615 Perl_croak(aTHX_ PL_no_modify);
4619 sv_unref_flags(sv, flags);
4620 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4625 =for apidoc sv_force_normal
4627 Undo various types of fakery on an SV: if the PV is a shared string, make
4628 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4629 an xpvmg. See also C<sv_force_normal_flags>.
4635 Perl_sv_force_normal(pTHX_ register SV *sv)
4637 sv_force_normal_flags(sv, 0);
4643 Efficient removal of characters from the beginning of the string buffer.
4644 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4645 the string buffer. The C<ptr> becomes the first character of the adjusted
4646 string. Uses the "OOK hack".
4647 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4648 refer to the same chunk of data.
4654 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4656 register STRLEN delta;
4657 if (!ptr || !SvPOKp(sv))
4659 delta = ptr - SvPVX_const(sv);
4660 SV_CHECK_THINKFIRST(sv);
4661 if (SvTYPE(sv) < SVt_PVIV)
4662 sv_upgrade(sv,SVt_PVIV);
4665 if (!SvLEN(sv)) { /* make copy of shared string */
4666 const char *pvx = SvPVX_const(sv);
4667 const STRLEN len = SvCUR(sv);
4668 SvGROW(sv, len + 1);
4669 Move(pvx,SvPVX_const(sv),len,char);
4673 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4674 and we do that anyway inside the SvNIOK_off
4676 SvFLAGS(sv) |= SVf_OOK;
4679 SvLEN_set(sv, SvLEN(sv) - delta);
4680 SvCUR_set(sv, SvCUR(sv) - delta);
4681 SvPV_set(sv, SvPVX(sv) + delta);
4682 SvIV_set(sv, SvIVX(sv) + delta);
4685 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4686 * this function provided for binary compatibility only
4690 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4692 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4696 =for apidoc sv_catpvn
4698 Concatenates the string onto the end of the string which is in the SV. The
4699 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4700 status set, then the bytes appended should be valid UTF-8.
4701 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4703 =for apidoc sv_catpvn_flags
4705 Concatenates the string onto the end of the string which is in the SV. The
4706 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4707 status set, then the bytes appended should be valid UTF-8.
4708 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4709 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4710 in terms of this function.
4716 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4719 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4721 SvGROW(dsv, dlen + slen + 1);
4723 sstr = SvPVX_const(dsv);
4724 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4725 SvCUR_set(dsv, SvCUR(dsv) + slen);
4727 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4732 =for apidoc sv_catpvn_mg
4734 Like C<sv_catpvn>, but also handles 'set' magic.
4740 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4742 sv_catpvn(sv,ptr,len);
4746 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4747 * this function provided for binary compatibility only
4751 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4753 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4757 =for apidoc sv_catsv
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>. Handles 'get' magic, but
4761 not 'set' magic. See C<sv_catsv_mg>.
4763 =for apidoc sv_catsv_flags
4765 Concatenates the string from SV C<ssv> onto the end of the string in
4766 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4767 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4768 and C<sv_catsv_nomg> are implemented in terms of this function.
4773 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4779 if ((spv = SvPV_const(ssv, slen))) {
4780 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4781 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4782 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4783 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4784 dsv->sv_flags doesn't have that bit set.
4785 Andy Dougherty 12 Oct 2001
4787 const I32 sutf8 = DO_UTF8(ssv);
4790 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4792 dutf8 = DO_UTF8(dsv);
4794 if (dutf8 != sutf8) {
4796 /* Not modifying source SV, so taking a temporary copy. */
4797 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4799 sv_utf8_upgrade(csv);
4800 spv = SvPV_const(csv, slen);
4803 sv_utf8_upgrade_nomg(dsv);
4805 sv_catpvn_nomg(dsv, spv, slen);
4810 =for apidoc sv_catsv_mg
4812 Like C<sv_catsv>, but also handles 'set' magic.
4818 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4825 =for apidoc sv_catpv
4827 Concatenates the string onto the end of the string which is in the SV.
4828 If the SV has the UTF-8 status set, then the bytes appended should be
4829 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4834 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4836 register STRLEN len;
4842 junk = SvPV_force(sv, tlen);
4844 SvGROW(sv, tlen + len + 1);
4846 ptr = SvPVX_const(sv);
4847 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4848 SvCUR_set(sv, SvCUR(sv) + len);
4849 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4854 =for apidoc sv_catpv_mg
4856 Like C<sv_catpv>, but also handles 'set' magic.
4862 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4871 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4872 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4879 Perl_newSV(pTHX_ STRLEN len)
4885 sv_upgrade(sv, SVt_PV);
4886 SvGROW(sv, len + 1);
4891 =for apidoc sv_magicext
4893 Adds magic to an SV, upgrading it if necessary. Applies the
4894 supplied vtable and returns a pointer to the magic added.
4896 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4897 In particular, you can add magic to SvREADONLY SVs, and add more than
4898 one instance of the same 'how'.
4900 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4901 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4902 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4903 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4905 (This is now used as a subroutine by C<sv_magic>.)
4910 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4911 const char* name, I32 namlen)
4915 if (SvTYPE(sv) < SVt_PVMG) {
4916 SvUPGRADE(sv, SVt_PVMG);
4918 Newxz(mg, 1, MAGIC);
4919 mg->mg_moremagic = SvMAGIC(sv);
4920 SvMAGIC_set(sv, mg);
4922 /* Sometimes a magic contains a reference loop, where the sv and
4923 object refer to each other. To prevent a reference loop that
4924 would prevent such objects being freed, we look for such loops
4925 and if we find one we avoid incrementing the object refcount.
4927 Note we cannot do this to avoid self-tie loops as intervening RV must
4928 have its REFCNT incremented to keep it in existence.
4931 if (!obj || obj == sv ||
4932 how == PERL_MAGIC_arylen ||
4933 how == PERL_MAGIC_qr ||
4934 how == PERL_MAGIC_symtab ||
4935 (SvTYPE(obj) == SVt_PVGV &&
4936 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4937 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4938 GvFORM(obj) == (CV*)sv)))
4943 mg->mg_obj = SvREFCNT_inc(obj);
4944 mg->mg_flags |= MGf_REFCOUNTED;
4947 /* Normal self-ties simply pass a null object, and instead of
4948 using mg_obj directly, use the SvTIED_obj macro to produce a
4949 new RV as needed. For glob "self-ties", we are tieing the PVIO
4950 with an RV obj pointing to the glob containing the PVIO. In
4951 this case, to avoid a reference loop, we need to weaken the
4955 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4956 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4962 mg->mg_len = namlen;
4965 mg->mg_ptr = savepvn(name, namlen);
4966 else if (namlen == HEf_SVKEY)
4967 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4969 mg->mg_ptr = (char *) name;
4971 mg->mg_virtual = vtable;
4975 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4980 =for apidoc sv_magic
4982 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4983 then adds a new magic item of type C<how> to the head of the magic list.
4985 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4986 handling of the C<name> and C<namlen> arguments.
4988 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4989 to add more than one instance of the same 'how'.
4995 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4997 const MGVTBL *vtable;
5000 #ifdef PERL_OLD_COPY_ON_WRITE
5002 sv_force_normal_flags(sv, 0);
5004 if (SvREADONLY(sv)) {
5006 /* its okay to attach magic to shared strings; the subsequent
5007 * upgrade to PVMG will unshare the string */
5008 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5011 && how != PERL_MAGIC_regex_global
5012 && how != PERL_MAGIC_bm
5013 && how != PERL_MAGIC_fm
5014 && how != PERL_MAGIC_sv
5015 && how != PERL_MAGIC_backref
5018 Perl_croak(aTHX_ PL_no_modify);
5021 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5022 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5023 /* sv_magic() refuses to add a magic of the same 'how' as an
5026 if (how == PERL_MAGIC_taint)
5034 vtable = &PL_vtbl_sv;
5036 case PERL_MAGIC_overload:
5037 vtable = &PL_vtbl_amagic;
5039 case PERL_MAGIC_overload_elem:
5040 vtable = &PL_vtbl_amagicelem;
5042 case PERL_MAGIC_overload_table:
5043 vtable = &PL_vtbl_ovrld;
5046 vtable = &PL_vtbl_bm;
5048 case PERL_MAGIC_regdata:
5049 vtable = &PL_vtbl_regdata;
5051 case PERL_MAGIC_regdatum:
5052 vtable = &PL_vtbl_regdatum;
5054 case PERL_MAGIC_env:
5055 vtable = &PL_vtbl_env;
5058 vtable = &PL_vtbl_fm;
5060 case PERL_MAGIC_envelem:
5061 vtable = &PL_vtbl_envelem;
5063 case PERL_MAGIC_regex_global:
5064 vtable = &PL_vtbl_mglob;
5066 case PERL_MAGIC_isa:
5067 vtable = &PL_vtbl_isa;
5069 case PERL_MAGIC_isaelem:
5070 vtable = &PL_vtbl_isaelem;
5072 case PERL_MAGIC_nkeys:
5073 vtable = &PL_vtbl_nkeys;
5075 case PERL_MAGIC_dbfile:
5078 case PERL_MAGIC_dbline:
5079 vtable = &PL_vtbl_dbline;
5081 #ifdef USE_LOCALE_COLLATE
5082 case PERL_MAGIC_collxfrm:
5083 vtable = &PL_vtbl_collxfrm;
5085 #endif /* USE_LOCALE_COLLATE */
5086 case PERL_MAGIC_tied:
5087 vtable = &PL_vtbl_pack;
5089 case PERL_MAGIC_tiedelem:
5090 case PERL_MAGIC_tiedscalar:
5091 vtable = &PL_vtbl_packelem;
5094 vtable = &PL_vtbl_regexp;
5096 case PERL_MAGIC_sig:
5097 vtable = &PL_vtbl_sig;
5099 case PERL_MAGIC_sigelem:
5100 vtable = &PL_vtbl_sigelem;
5102 case PERL_MAGIC_taint:
5103 vtable = &PL_vtbl_taint;
5105 case PERL_MAGIC_uvar:
5106 vtable = &PL_vtbl_uvar;
5108 case PERL_MAGIC_vec:
5109 vtable = &PL_vtbl_vec;
5111 case PERL_MAGIC_arylen_p:
5112 case PERL_MAGIC_rhash:
5113 case PERL_MAGIC_symtab:
5114 case PERL_MAGIC_vstring:
5117 case PERL_MAGIC_utf8:
5118 vtable = &PL_vtbl_utf8;
5120 case PERL_MAGIC_substr:
5121 vtable = &PL_vtbl_substr;
5123 case PERL_MAGIC_defelem:
5124 vtable = &PL_vtbl_defelem;
5126 case PERL_MAGIC_glob:
5127 vtable = &PL_vtbl_glob;
5129 case PERL_MAGIC_arylen:
5130 vtable = &PL_vtbl_arylen;
5132 case PERL_MAGIC_pos:
5133 vtable = &PL_vtbl_pos;
5135 case PERL_MAGIC_backref:
5136 vtable = &PL_vtbl_backref;
5138 case PERL_MAGIC_ext:
5139 /* Reserved for use by extensions not perl internals. */
5140 /* Useful for attaching extension internal data to perl vars. */
5141 /* Note that multiple extensions may clash if magical scalars */
5142 /* etc holding private data from one are passed to another. */
5146 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5149 /* Rest of work is done else where */
5150 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5153 case PERL_MAGIC_taint:
5156 case PERL_MAGIC_ext:
5157 case PERL_MAGIC_dbfile:
5164 =for apidoc sv_unmagic
5166 Removes all magic of type C<type> from an SV.
5172 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5176 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5179 for (mg = *mgp; mg; mg = *mgp) {
5180 if (mg->mg_type == type) {
5181 const MGVTBL* const vtbl = mg->mg_virtual;
5182 *mgp = mg->mg_moremagic;
5183 if (vtbl && vtbl->svt_free)
5184 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5185 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5187 Safefree(mg->mg_ptr);
5188 else if (mg->mg_len == HEf_SVKEY)
5189 SvREFCNT_dec((SV*)mg->mg_ptr);
5190 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5191 Safefree(mg->mg_ptr);
5193 if (mg->mg_flags & MGf_REFCOUNTED)
5194 SvREFCNT_dec(mg->mg_obj);
5198 mgp = &mg->mg_moremagic;
5202 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5209 =for apidoc sv_rvweaken
5211 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5212 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5213 push a back-reference to this RV onto the array of backreferences
5214 associated with that magic.
5220 Perl_sv_rvweaken(pTHX_ SV *sv)
5223 if (!SvOK(sv)) /* let undefs pass */
5226 Perl_croak(aTHX_ "Can't weaken a nonreference");
5227 else if (SvWEAKREF(sv)) {
5228 if (ckWARN(WARN_MISC))
5229 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5233 Perl_sv_add_backref(aTHX_ tsv, sv);
5239 /* Give tsv backref magic if it hasn't already got it, then push a
5240 * back-reference to sv onto the array associated with the backref magic.
5244 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5248 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5249 av = (AV*)mg->mg_obj;
5252 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5253 /* av now has a refcnt of 2, which avoids it getting freed
5254 * before us during global cleanup. The extra ref is removed
5255 * by magic_killbackrefs() when tsv is being freed */
5257 if (AvFILLp(av) >= AvMAX(av)) {
5258 av_extend(av, AvFILLp(av)+1);
5260 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5263 /* delete a back-reference to ourselves from the backref magic associated
5264 * with the SV we point to.
5268 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5274 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5275 if (PL_in_clean_all)
5278 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5279 Perl_croak(aTHX_ "panic: del_backref");
5280 av = (AV *)mg->mg_obj;
5282 /* We shouldn't be in here more than once, but for paranoia reasons lets
5284 for (i = AvFILLp(av); i >= 0; i--) {
5286 const SSize_t fill = AvFILLp(av);
5288 /* We weren't the last entry.
5289 An unordered list has this property that you can take the
5290 last element off the end to fill the hole, and it's still
5291 an unordered list :-)
5296 AvFILLp(av) = fill - 1;
5302 =for apidoc sv_insert
5304 Inserts a string at the specified offset/length within the SV. Similar to
5305 the Perl substr() function.
5311 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5315 register char *midend;
5316 register char *bigend;
5322 Perl_croak(aTHX_ "Can't modify non-existent substring");
5323 SvPV_force(bigstr, curlen);
5324 (void)SvPOK_only_UTF8(bigstr);
5325 if (offset + len > curlen) {
5326 SvGROW(bigstr, offset+len+1);
5327 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5328 SvCUR_set(bigstr, offset+len);
5332 i = littlelen - len;
5333 if (i > 0) { /* string might grow */
5334 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5335 mid = big + offset + len;
5336 midend = bigend = big + SvCUR(bigstr);
5339 while (midend > mid) /* shove everything down */
5340 *--bigend = *--midend;
5341 Move(little,big+offset,littlelen,char);
5342 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5347 Move(little,SvPVX(bigstr)+offset,len,char);
5352 big = SvPVX(bigstr);
5355 bigend = big + SvCUR(bigstr);
5357 if (midend > bigend)
5358 Perl_croak(aTHX_ "panic: sv_insert");
5360 if (mid - big > bigend - midend) { /* faster to shorten from end */
5362 Move(little, mid, littlelen,char);
5365 i = bigend - midend;
5367 Move(midend, mid, i,char);
5371 SvCUR_set(bigstr, mid - big);
5373 else if ((i = mid - big)) { /* faster from front */
5374 midend -= littlelen;
5376 sv_chop(bigstr,midend-i);
5381 Move(little, mid, littlelen,char);
5383 else if (littlelen) {
5384 midend -= littlelen;
5385 sv_chop(bigstr,midend);
5386 Move(little,midend,littlelen,char);
5389 sv_chop(bigstr,midend);
5395 =for apidoc sv_replace
5397 Make the first argument a copy of the second, then delete the original.
5398 The target SV physically takes over ownership of the body of the source SV
5399 and inherits its flags; however, the target keeps any magic it owns,
5400 and any magic in the source is discarded.
5401 Note that this is a rather specialist SV copying operation; most of the
5402 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5408 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5410 const U32 refcnt = SvREFCNT(sv);
5411 SV_CHECK_THINKFIRST_COW_DROP(sv);
5412 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5413 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5414 if (SvMAGICAL(sv)) {
5418 sv_upgrade(nsv, SVt_PVMG);
5419 SvMAGIC_set(nsv, SvMAGIC(sv));
5420 SvFLAGS(nsv) |= SvMAGICAL(sv);
5422 SvMAGIC_set(sv, NULL);
5426 assert(!SvREFCNT(sv));
5427 #ifdef DEBUG_LEAKING_SCALARS
5428 sv->sv_flags = nsv->sv_flags;
5429 sv->sv_any = nsv->sv_any;
5430 sv->sv_refcnt = nsv->sv_refcnt;
5431 sv->sv_u = nsv->sv_u;
5433 StructCopy(nsv,sv,SV);
5435 /* Currently could join these into one piece of pointer arithmetic, but
5436 it would be unclear. */
5437 if(SvTYPE(sv) == SVt_IV)
5439 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5440 else if (SvTYPE(sv) == SVt_RV) {
5441 SvANY(sv) = &sv->sv_u.svu_rv;
5445 #ifdef PERL_OLD_COPY_ON_WRITE
5446 if (SvIsCOW_normal(nsv)) {
5447 /* We need to follow the pointers around the loop to make the
5448 previous SV point to sv, rather than nsv. */
5451 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5454 assert(SvPVX_const(current) == SvPVX_const(nsv));
5456 /* Make the SV before us point to the SV after us. */
5458 PerlIO_printf(Perl_debug_log, "previous is\n");
5460 PerlIO_printf(Perl_debug_log,
5461 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5462 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5464 SV_COW_NEXT_SV_SET(current, sv);
5467 SvREFCNT(sv) = refcnt;
5468 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5474 =for apidoc sv_clear
5476 Clear an SV: call any destructors, free up any memory used by the body,
5477 and free the body itself. The SV's head is I<not> freed, although
5478 its type is set to all 1's so that it won't inadvertently be assumed
5479 to be live during global destruction etc.
5480 This function should only be called when REFCNT is zero. Most of the time
5481 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5488 Perl_sv_clear(pTHX_ register SV *sv)
5491 void** old_body_arena;
5492 size_t old_body_offset;
5493 const U32 type = SvTYPE(sv);
5496 assert(SvREFCNT(sv) == 0);
5502 old_body_offset = 0;
5505 if (PL_defstash) { /* Still have a symbol table? */
5510 stash = SvSTASH(sv);
5511 destructor = StashHANDLER(stash,DESTROY);
5513 SV* const tmpref = newRV(sv);
5514 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5516 PUSHSTACKi(PERLSI_DESTROY);
5521 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5527 if(SvREFCNT(tmpref) < 2) {
5528 /* tmpref is not kept alive! */
5530 SvRV_set(tmpref, NULL);
5533 SvREFCNT_dec(tmpref);
5535 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5539 if (PL_in_clean_objs)
5540 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5542 /* DESTROY gave object new lease on life */
5548 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5549 SvOBJECT_off(sv); /* Curse the object. */
5550 if (type != SVt_PVIO)
5551 --PL_sv_objcount; /* XXX Might want something more general */
5554 if (type >= SVt_PVMG) {
5557 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5558 SvREFCNT_dec(SvSTASH(sv));
5563 IoIFP(sv) != PerlIO_stdin() &&
5564 IoIFP(sv) != PerlIO_stdout() &&
5565 IoIFP(sv) != PerlIO_stderr())
5567 io_close((IO*)sv, FALSE);
5569 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5570 PerlDir_close(IoDIRP(sv));
5571 IoDIRP(sv) = (DIR*)NULL;
5572 Safefree(IoTOP_NAME(sv));
5573 Safefree(IoFMT_NAME(sv));
5574 Safefree(IoBOTTOM_NAME(sv));
5575 /* PVIOs aren't from arenas */
5578 old_body_arena = (void **) &PL_xpvbm_root;
5581 old_body_arena = (void **) &PL_xpvcv_root;
5583 /* PVFMs aren't from arenas */
5588 old_body_arena = (void **) &PL_xpvhv_root;
5589 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5593 old_body_arena = (void **) &PL_xpvav_root;
5594 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5597 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5598 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5599 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5600 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5602 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5603 SvREFCNT_dec(LvTARG(sv));
5604 old_body_arena = (void **) &PL_xpvlv_root;
5608 Safefree(GvNAME(sv));
5609 /* If we're in a stash, we don't own a reference to it. However it does
5610 have a back reference to us, which needs to be cleared. */
5612 sv_del_backref((SV*)GvSTASH(sv), sv);
5613 old_body_arena = (void **) &PL_xpvgv_root;
5616 old_body_arena = (void **) &PL_xpvmg_root;
5619 old_body_arena = (void **) &PL_xpvnv_root;
5622 old_body_arena = (void **) &PL_xpviv_root;
5623 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5625 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5627 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5628 /* Don't even bother with turning off the OOK flag. */
5632 old_body_arena = (void **) &PL_xpv_root;
5633 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5637 SV *target = SvRV(sv);
5639 sv_del_backref(target, sv);
5641 SvREFCNT_dec(target);
5643 #ifdef PERL_OLD_COPY_ON_WRITE
5644 else if (SvPVX_const(sv)) {
5646 /* I believe I need to grab the global SV mutex here and
5647 then recheck the COW status. */
5649 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5652 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5653 SV_COW_NEXT_SV(sv));
5654 /* And drop it here. */
5656 } else if (SvLEN(sv)) {
5657 Safefree(SvPVX_const(sv));
5661 else if (SvPVX_const(sv) && SvLEN(sv))
5662 Safefree(SvPVX_mutable(sv));
5663 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5664 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5670 old_body_arena = (void **) &PL_xnv_root;
5674 SvFLAGS(sv) &= SVf_BREAK;
5675 SvFLAGS(sv) |= SVTYPEMASK;
5678 if (old_body_arena) {
5679 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5683 if (type > SVt_RV) {
5684 my_safefree(SvANY(sv));
5689 =for apidoc sv_newref
5691 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5698 Perl_sv_newref(pTHX_ SV *sv)
5708 Decrement an SV's reference count, and if it drops to zero, call
5709 C<sv_clear> to invoke destructors and free up any memory used by
5710 the body; finally, deallocate the SV's head itself.
5711 Normally called via a wrapper macro C<SvREFCNT_dec>.
5717 Perl_sv_free(pTHX_ SV *sv)
5722 if (SvREFCNT(sv) == 0) {
5723 if (SvFLAGS(sv) & SVf_BREAK)
5724 /* this SV's refcnt has been artificially decremented to
5725 * trigger cleanup */
5727 if (PL_in_clean_all) /* All is fair */
5729 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5730 /* make sure SvREFCNT(sv)==0 happens very seldom */
5731 SvREFCNT(sv) = (~(U32)0)/2;
5734 if (ckWARN_d(WARN_INTERNAL)) {
5735 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5736 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5737 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5738 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5739 Perl_dump_sv_child(aTHX_ sv);
5744 if (--(SvREFCNT(sv)) > 0)
5746 Perl_sv_free2(aTHX_ sv);
5750 Perl_sv_free2(pTHX_ SV *sv)
5755 if (ckWARN_d(WARN_DEBUGGING))
5756 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5757 "Attempt to free temp prematurely: SV 0x%"UVxf
5758 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5762 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5763 /* make sure SvREFCNT(sv)==0 happens very seldom */
5764 SvREFCNT(sv) = (~(U32)0)/2;
5775 Returns the length of the string in the SV. Handles magic and type
5776 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5782 Perl_sv_len(pTHX_ register SV *sv)
5790 len = mg_length(sv);
5792 (void)SvPV_const(sv, len);
5797 =for apidoc sv_len_utf8
5799 Returns the number of characters in the string in an SV, counting wide
5800 UTF-8 bytes as a single character. Handles magic and type coercion.
5806 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5807 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5808 * (Note that the mg_len is not the length of the mg_ptr field.)
5813 Perl_sv_len_utf8(pTHX_ register SV *sv)
5819 return mg_length(sv);
5823 const U8 *s = (U8*)SvPV_const(sv, len);
5824 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5826 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5828 #ifdef PERL_UTF8_CACHE_ASSERT
5829 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5833 ulen = Perl_utf8_length(aTHX_ s, s + len);
5834 if (!mg && !SvREADONLY(sv)) {
5835 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5836 mg = mg_find(sv, PERL_MAGIC_utf8);
5846 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5847 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5848 * between UTF-8 and byte offsets. There are two (substr offset and substr
5849 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5850 * and byte offset) cache positions.
5852 * The mg_len field is used by sv_len_utf8(), see its comments.
5853 * Note that the mg_len is not the length of the mg_ptr field.
5857 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5858 I32 offsetp, const U8 *s, const U8 *start)
5862 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5864 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5868 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5870 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5871 (*mgp)->mg_ptr = (char *) *cachep;
5875 (*cachep)[i] = offsetp;
5876 (*cachep)[i+1] = s - start;
5884 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5885 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5886 * between UTF-8 and byte offsets. See also the comments of
5887 * S_utf8_mg_pos_init().
5891 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)
5895 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5897 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5898 if (*mgp && (*mgp)->mg_ptr) {
5899 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5900 ASSERT_UTF8_CACHE(*cachep);
5901 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5903 else { /* We will skip to the right spot. */
5908 /* The assumption is that going backward is half
5909 * the speed of going forward (that's where the
5910 * 2 * backw in the below comes from). (The real
5911 * figure of course depends on the UTF-8 data.) */
5913 if ((*cachep)[i] > (STRLEN)uoff) {
5915 backw = (*cachep)[i] - (STRLEN)uoff;
5917 if (forw < 2 * backw)
5920 p = start + (*cachep)[i+1];
5922 /* Try this only for the substr offset (i == 0),
5923 * not for the substr length (i == 2). */
5924 else if (i == 0) { /* (*cachep)[i] < uoff */
5925 const STRLEN ulen = sv_len_utf8(sv);
5927 if ((STRLEN)uoff < ulen) {
5928 forw = (STRLEN)uoff - (*cachep)[i];
5929 backw = ulen - (STRLEN)uoff;
5931 if (forw < 2 * backw)
5932 p = start + (*cachep)[i+1];
5937 /* If the string is not long enough for uoff,
5938 * we could extend it, but not at this low a level. */
5942 if (forw < 2 * backw) {
5949 while (UTF8_IS_CONTINUATION(*p))
5954 /* Update the cache. */
5955 (*cachep)[i] = (STRLEN)uoff;
5956 (*cachep)[i+1] = p - start;
5958 /* Drop the stale "length" cache */
5967 if (found) { /* Setup the return values. */
5968 *offsetp = (*cachep)[i+1];
5969 *sp = start + *offsetp;
5972 *offsetp = send - start;
5974 else if (*sp < start) {
5980 #ifdef PERL_UTF8_CACHE_ASSERT
5985 while (n-- && s < send)
5989 assert(*offsetp == s - start);
5990 assert((*cachep)[0] == (STRLEN)uoff);
5991 assert((*cachep)[1] == *offsetp);
5993 ASSERT_UTF8_CACHE(*cachep);
6002 =for apidoc sv_pos_u2b
6004 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6005 the start of the string, to a count of the equivalent number of bytes; if
6006 lenp is non-zero, it does the same to lenp, but this time starting from
6007 the offset, rather than from the start of the string. Handles magic and
6014 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6015 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6016 * byte offsets. See also the comments of S_utf8_mg_pos().
6021 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6029 start = (U8*)SvPV_const(sv, len);
6033 const U8 *s = start;
6034 I32 uoffset = *offsetp;
6035 const U8 * const send = s + len;
6039 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6041 if (!found && uoffset > 0) {
6042 while (s < send && uoffset--)
6046 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6048 *offsetp = s - start;
6053 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6057 if (!found && *lenp > 0) {
6060 while (s < send && ulen--)
6064 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6068 ASSERT_UTF8_CACHE(cache);
6080 =for apidoc sv_pos_b2u
6082 Converts the value pointed to by offsetp from a count of bytes from the
6083 start of the string, to a count of the equivalent number of UTF-8 chars.
6084 Handles magic and type coercion.
6090 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6091 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6092 * byte offsets. See also the comments of S_utf8_mg_pos().
6097 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6105 s = (const U8*)SvPV_const(sv, len);
6106 if ((I32)len < *offsetp)
6107 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6109 const U8* send = s + *offsetp;
6111 STRLEN *cache = NULL;
6115 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6116 mg = mg_find(sv, PERL_MAGIC_utf8);
6117 if (mg && mg->mg_ptr) {
6118 cache = (STRLEN *) mg->mg_ptr;
6119 if (cache[1] == (STRLEN)*offsetp) {
6120 /* An exact match. */
6121 *offsetp = cache[0];
6125 else if (cache[1] < (STRLEN)*offsetp) {
6126 /* We already know part of the way. */
6129 /* Let the below loop do the rest. */
6131 else { /* cache[1] > *offsetp */
6132 /* We already know all of the way, now we may
6133 * be able to walk back. The same assumption
6134 * is made as in S_utf8_mg_pos(), namely that
6135 * walking backward is twice slower than
6136 * walking forward. */
6137 const STRLEN forw = *offsetp;
6138 STRLEN backw = cache[1] - *offsetp;
6140 if (!(forw < 2 * backw)) {
6141 const U8 *p = s + cache[1];
6148 while (UTF8_IS_CONTINUATION(*p)) {
6156 *offsetp = cache[0];
6158 /* Drop the stale "length" cache */
6166 ASSERT_UTF8_CACHE(cache);
6172 /* Call utf8n_to_uvchr() to validate the sequence
6173 * (unless a simple non-UTF character) */
6174 if (!UTF8_IS_INVARIANT(*s))
6175 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6184 if (!SvREADONLY(sv)) {
6186 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6187 mg = mg_find(sv, PERL_MAGIC_utf8);
6192 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6193 mg->mg_ptr = (char *) cache;
6198 cache[1] = *offsetp;
6199 /* Drop the stale "length" cache */
6212 Returns a boolean indicating whether the strings in the two SVs are
6213 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6214 coerce its args to strings if necessary.
6220 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6228 SV* svrecode = Nullsv;
6235 pv1 = SvPV_const(sv1, cur1);
6242 pv2 = SvPV_const(sv2, cur2);
6244 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6245 /* Differing utf8ness.
6246 * Do not UTF8size the comparands as a side-effect. */
6249 svrecode = newSVpvn(pv2, cur2);
6250 sv_recode_to_utf8(svrecode, PL_encoding);
6251 pv2 = SvPV_const(svrecode, cur2);
6254 svrecode = newSVpvn(pv1, cur1);
6255 sv_recode_to_utf8(svrecode, PL_encoding);
6256 pv1 = SvPV_const(svrecode, cur1);
6258 /* Now both are in UTF-8. */
6260 SvREFCNT_dec(svrecode);
6265 bool is_utf8 = TRUE;
6268 /* sv1 is the UTF-8 one,
6269 * if is equal it must be downgrade-able */
6270 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6276 /* sv2 is the UTF-8 one,
6277 * if is equal it must be downgrade-able */
6278 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6284 /* Downgrade not possible - cannot be eq */
6292 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6295 SvREFCNT_dec(svrecode);
6306 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6307 string in C<sv1> is less than, equal to, or greater than the string in
6308 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6309 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6315 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6318 const char *pv1, *pv2;
6321 SV *svrecode = Nullsv;
6328 pv1 = SvPV_const(sv1, cur1);
6335 pv2 = SvPV_const(sv2, cur2);
6337 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6338 /* Differing utf8ness.
6339 * Do not UTF8size the comparands as a side-effect. */
6342 svrecode = newSVpvn(pv2, cur2);
6343 sv_recode_to_utf8(svrecode, PL_encoding);
6344 pv2 = SvPV_const(svrecode, cur2);
6347 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6352 svrecode = newSVpvn(pv1, cur1);
6353 sv_recode_to_utf8(svrecode, PL_encoding);
6354 pv1 = SvPV_const(svrecode, cur1);
6357 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6363 cmp = cur2 ? -1 : 0;
6367 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6370 cmp = retval < 0 ? -1 : 1;
6371 } else if (cur1 == cur2) {
6374 cmp = cur1 < cur2 ? -1 : 1;
6379 SvREFCNT_dec(svrecode);
6388 =for apidoc sv_cmp_locale
6390 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6391 'use bytes' aware, handles get magic, and will coerce its args to strings
6392 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6398 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6400 #ifdef USE_LOCALE_COLLATE
6406 if (PL_collation_standard)
6410 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6412 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6414 if (!pv1 || !len1) {
6425 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6428 return retval < 0 ? -1 : 1;
6431 * When the result of collation is equality, that doesn't mean
6432 * that there are no differences -- some locales exclude some
6433 * characters from consideration. So to avoid false equalities,
6434 * we use the raw string as a tiebreaker.
6440 #endif /* USE_LOCALE_COLLATE */
6442 return sv_cmp(sv1, sv2);
6446 #ifdef USE_LOCALE_COLLATE
6449 =for apidoc sv_collxfrm
6451 Add Collate Transform magic to an SV if it doesn't already have it.
6453 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6454 scalar data of the variable, but transformed to such a format that a normal
6455 memory comparison can be used to compare the data according to the locale
6462 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6466 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6467 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6473 Safefree(mg->mg_ptr);
6474 s = SvPV_const(sv, len);
6475 if ((xf = mem_collxfrm(s, len, &xlen))) {
6476 if (SvREADONLY(sv)) {
6479 return xf + sizeof(PL_collation_ix);
6482 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6483 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6496 if (mg && mg->mg_ptr) {
6498 return mg->mg_ptr + sizeof(PL_collation_ix);
6506 #endif /* USE_LOCALE_COLLATE */
6511 Get a line from the filehandle and store it into the SV, optionally
6512 appending to the currently-stored string.
6518 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6522 register STDCHAR rslast;
6523 register STDCHAR *bp;
6529 if (SvTHINKFIRST(sv))
6530 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6531 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6533 However, perlbench says it's slower, because the existing swipe code
6534 is faster than copy on write.
6535 Swings and roundabouts. */
6536 SvUPGRADE(sv, SVt_PV);
6541 if (PerlIO_isutf8(fp)) {
6543 sv_utf8_upgrade_nomg(sv);
6544 sv_pos_u2b(sv,&append,0);
6546 } else if (SvUTF8(sv)) {
6547 SV * const tsv = NEWSV(0,0);
6548 sv_gets(tsv, fp, 0);
6549 sv_utf8_upgrade_nomg(tsv);
6550 SvCUR_set(sv,append);
6553 goto return_string_or_null;
6558 if (PerlIO_isutf8(fp))
6561 if (IN_PERL_COMPILETIME) {
6562 /* we always read code in line mode */
6566 else if (RsSNARF(PL_rs)) {
6567 /* If it is a regular disk file use size from stat() as estimate
6568 of amount we are going to read - may result in malloc-ing
6569 more memory than we realy need if layers bellow reduce
6570 size we read (e.g. CRLF or a gzip layer)
6573 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6574 const Off_t offset = PerlIO_tell(fp);
6575 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6576 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6582 else if (RsRECORD(PL_rs)) {
6586 /* Grab the size of the record we're getting */
6587 recsize = SvIV(SvRV(PL_rs));
6588 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6591 /* VMS wants read instead of fread, because fread doesn't respect */
6592 /* RMS record boundaries. This is not necessarily a good thing to be */
6593 /* doing, but we've got no other real choice - except avoid stdio
6594 as implementation - perhaps write a :vms layer ?
6596 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6598 bytesread = PerlIO_read(fp, buffer, recsize);
6602 SvCUR_set(sv, bytesread += append);
6603 buffer[bytesread] = '\0';
6604 goto return_string_or_null;
6606 else if (RsPARA(PL_rs)) {
6612 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6613 if (PerlIO_isutf8(fp)) {
6614 rsptr = SvPVutf8(PL_rs, rslen);
6617 if (SvUTF8(PL_rs)) {
6618 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6619 Perl_croak(aTHX_ "Wide character in $/");
6622 rsptr = SvPV_const(PL_rs, rslen);
6626 rslast = rslen ? rsptr[rslen - 1] : '\0';
6628 if (rspara) { /* have to do this both before and after */
6629 do { /* to make sure file boundaries work right */
6632 i = PerlIO_getc(fp);
6636 PerlIO_ungetc(fp,i);
6642 /* See if we know enough about I/O mechanism to cheat it ! */
6644 /* This used to be #ifdef test - it is made run-time test for ease
6645 of abstracting out stdio interface. One call should be cheap
6646 enough here - and may even be a macro allowing compile
6650 if (PerlIO_fast_gets(fp)) {
6653 * We're going to steal some values from the stdio struct
6654 * and put EVERYTHING in the innermost loop into registers.
6656 register STDCHAR *ptr;
6660 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6661 /* An ungetc()d char is handled separately from the regular
6662 * buffer, so we getc() it back out and stuff it in the buffer.
6664 i = PerlIO_getc(fp);
6665 if (i == EOF) return 0;
6666 *(--((*fp)->_ptr)) = (unsigned char) i;
6670 /* Here is some breathtakingly efficient cheating */
6672 cnt = PerlIO_get_cnt(fp); /* get count into register */
6673 /* make sure we have the room */
6674 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6675 /* Not room for all of it
6676 if we are looking for a separator and room for some
6678 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6679 /* just process what we have room for */
6680 shortbuffered = cnt - SvLEN(sv) + append + 1;
6681 cnt -= shortbuffered;
6685 /* remember that cnt can be negative */
6686 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6691 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6692 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6693 DEBUG_P(PerlIO_printf(Perl_debug_log,
6694 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6695 DEBUG_P(PerlIO_printf(Perl_debug_log,
6696 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6697 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6698 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6703 while (cnt > 0) { /* this | eat */
6705 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6706 goto thats_all_folks; /* screams | sed :-) */
6710 Copy(ptr, bp, cnt, char); /* this | eat */
6711 bp += cnt; /* screams | dust */
6712 ptr += cnt; /* louder | sed :-) */
6717 if (shortbuffered) { /* oh well, must extend */
6718 cnt = shortbuffered;
6720 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6722 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6723 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6727 DEBUG_P(PerlIO_printf(Perl_debug_log,
6728 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6729 PTR2UV(ptr),(long)cnt));
6730 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6732 DEBUG_P(PerlIO_printf(Perl_debug_log,
6733 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6734 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6735 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6737 /* This used to call 'filbuf' in stdio form, but as that behaves like
6738 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6739 another abstraction. */
6740 i = PerlIO_getc(fp); /* get more characters */
6742 DEBUG_P(PerlIO_printf(Perl_debug_log,
6743 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6744 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6745 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6747 cnt = PerlIO_get_cnt(fp);
6748 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6749 DEBUG_P(PerlIO_printf(Perl_debug_log,
6750 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6752 if (i == EOF) /* all done for ever? */
6753 goto thats_really_all_folks;
6755 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6757 SvGROW(sv, bpx + cnt + 2);
6758 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6760 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6762 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6763 goto thats_all_folks;
6767 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6768 memNE((char*)bp - rslen, rsptr, rslen))
6769 goto screamer; /* go back to the fray */
6770 thats_really_all_folks:
6772 cnt += shortbuffered;
6773 DEBUG_P(PerlIO_printf(Perl_debug_log,
6774 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6775 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6776 DEBUG_P(PerlIO_printf(Perl_debug_log,
6777 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6778 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6779 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6781 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6782 DEBUG_P(PerlIO_printf(Perl_debug_log,
6783 "Screamer: done, len=%ld, string=|%.*s|\n",
6784 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6788 /*The big, slow, and stupid way. */
6789 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6791 Newx(buf, 8192, STDCHAR);
6799 const register STDCHAR *bpe = buf + sizeof(buf);
6801 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6802 ; /* keep reading */
6806 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6807 /* Accomodate broken VAXC compiler, which applies U8 cast to
6808 * both args of ?: operator, causing EOF to change into 255
6811 i = (U8)buf[cnt - 1];
6817 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6819 sv_catpvn(sv, (char *) buf, cnt);
6821 sv_setpvn(sv, (char *) buf, cnt);
6823 if (i != EOF && /* joy */
6825 SvCUR(sv) < rslen ||
6826 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6830 * If we're reading from a TTY and we get a short read,
6831 * indicating that the user hit his EOF character, we need
6832 * to notice it now, because if we try to read from the TTY
6833 * again, the EOF condition will disappear.
6835 * The comparison of cnt to sizeof(buf) is an optimization
6836 * that prevents unnecessary calls to feof().
6840 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6844 #ifdef USE_HEAP_INSTEAD_OF_STACK
6849 if (rspara) { /* have to do this both before and after */
6850 while (i != EOF) { /* to make sure file boundaries work right */
6851 i = PerlIO_getc(fp);
6853 PerlIO_ungetc(fp,i);
6859 return_string_or_null:
6860 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6866 Auto-increment of the value in the SV, doing string to numeric conversion
6867 if necessary. Handles 'get' magic.
6873 Perl_sv_inc(pTHX_ register SV *sv)
6882 if (SvTHINKFIRST(sv)) {
6884 sv_force_normal_flags(sv, 0);
6885 if (SvREADONLY(sv)) {
6886 if (IN_PERL_RUNTIME)
6887 Perl_croak(aTHX_ PL_no_modify);
6891 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6893 i = PTR2IV(SvRV(sv));
6898 flags = SvFLAGS(sv);
6899 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6900 /* It's (privately or publicly) a float, but not tested as an
6901 integer, so test it to see. */
6903 flags = SvFLAGS(sv);
6905 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6906 /* It's publicly an integer, or privately an integer-not-float */
6907 #ifdef PERL_PRESERVE_IVUV
6911 if (SvUVX(sv) == UV_MAX)
6912 sv_setnv(sv, UV_MAX_P1);
6914 (void)SvIOK_only_UV(sv);
6915 SvUV_set(sv, SvUVX(sv) + 1);
6917 if (SvIVX(sv) == IV_MAX)
6918 sv_setuv(sv, (UV)IV_MAX + 1);
6920 (void)SvIOK_only(sv);
6921 SvIV_set(sv, SvIVX(sv) + 1);
6926 if (flags & SVp_NOK) {
6927 (void)SvNOK_only(sv);
6928 SvNV_set(sv, SvNVX(sv) + 1.0);
6932 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6933 if ((flags & SVTYPEMASK) < SVt_PVIV)
6934 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6935 (void)SvIOK_only(sv);
6940 while (isALPHA(*d)) d++;
6941 while (isDIGIT(*d)) d++;
6943 #ifdef PERL_PRESERVE_IVUV
6944 /* Got to punt this as an integer if needs be, but we don't issue
6945 warnings. Probably ought to make the sv_iv_please() that does
6946 the conversion if possible, and silently. */
6947 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6948 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6949 /* Need to try really hard to see if it's an integer.
6950 9.22337203685478e+18 is an integer.
6951 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6952 so $a="9.22337203685478e+18"; $a+0; $a++
6953 needs to be the same as $a="9.22337203685478e+18"; $a++
6960 /* sv_2iv *should* have made this an NV */
6961 if (flags & SVp_NOK) {
6962 (void)SvNOK_only(sv);
6963 SvNV_set(sv, SvNVX(sv) + 1.0);
6966 /* I don't think we can get here. Maybe I should assert this
6967 And if we do get here I suspect that sv_setnv will croak. NWC
6969 #if defined(USE_LONG_DOUBLE)
6970 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",
6971 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6973 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6974 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6977 #endif /* PERL_PRESERVE_IVUV */
6978 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6982 while (d >= SvPVX_const(sv)) {
6990 /* MKS: The original code here died if letters weren't consecutive.
6991 * at least it didn't have to worry about non-C locales. The
6992 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6993 * arranged in order (although not consecutively) and that only
6994 * [A-Za-z] are accepted by isALPHA in the C locale.
6996 if (*d != 'z' && *d != 'Z') {
6997 do { ++*d; } while (!isALPHA(*d));
7000 *(d--) -= 'z' - 'a';
7005 *(d--) -= 'z' - 'a' + 1;
7009 /* oh,oh, the number grew */
7010 SvGROW(sv, SvCUR(sv) + 2);
7011 SvCUR_set(sv, SvCUR(sv) + 1);
7012 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7023 Auto-decrement of the value in the SV, doing string to numeric conversion
7024 if necessary. Handles 'get' magic.
7030 Perl_sv_dec(pTHX_ register SV *sv)
7038 if (SvTHINKFIRST(sv)) {
7040 sv_force_normal_flags(sv, 0);
7041 if (SvREADONLY(sv)) {
7042 if (IN_PERL_RUNTIME)
7043 Perl_croak(aTHX_ PL_no_modify);
7047 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7049 i = PTR2IV(SvRV(sv));
7054 /* Unlike sv_inc we don't have to worry about string-never-numbers
7055 and keeping them magic. But we mustn't warn on punting */
7056 flags = SvFLAGS(sv);
7057 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7058 /* It's publicly an integer, or privately an integer-not-float */
7059 #ifdef PERL_PRESERVE_IVUV
7063 if (SvUVX(sv) == 0) {
7064 (void)SvIOK_only(sv);
7068 (void)SvIOK_only_UV(sv);
7069 SvUV_set(sv, SvUVX(sv) - 1);
7072 if (SvIVX(sv) == IV_MIN)
7073 sv_setnv(sv, (NV)IV_MIN - 1.0);
7075 (void)SvIOK_only(sv);
7076 SvIV_set(sv, SvIVX(sv) - 1);
7081 if (flags & SVp_NOK) {
7082 SvNV_set(sv, SvNVX(sv) - 1.0);
7083 (void)SvNOK_only(sv);
7086 if (!(flags & SVp_POK)) {
7087 if ((flags & SVTYPEMASK) < SVt_PVIV)
7088 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7090 (void)SvIOK_only(sv);
7093 #ifdef PERL_PRESERVE_IVUV
7095 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7096 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7097 /* Need to try really hard to see if it's an integer.
7098 9.22337203685478e+18 is an integer.
7099 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7100 so $a="9.22337203685478e+18"; $a+0; $a--
7101 needs to be the same as $a="9.22337203685478e+18"; $a--
7108 /* sv_2iv *should* have made this an NV */
7109 if (flags & SVp_NOK) {
7110 (void)SvNOK_only(sv);
7111 SvNV_set(sv, SvNVX(sv) - 1.0);
7114 /* I don't think we can get here. Maybe I should assert this
7115 And if we do get here I suspect that sv_setnv will croak. NWC
7117 #if defined(USE_LONG_DOUBLE)
7118 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",
7119 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7121 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7122 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7126 #endif /* PERL_PRESERVE_IVUV */
7127 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7131 =for apidoc sv_mortalcopy
7133 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7134 The new SV is marked as mortal. It will be destroyed "soon", either by an
7135 explicit call to FREETMPS, or by an implicit call at places such as
7136 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7141 /* Make a string that will exist for the duration of the expression
7142 * evaluation. Actually, it may have to last longer than that, but
7143 * hopefully we won't free it until it has been assigned to a
7144 * permanent location. */
7147 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7152 sv_setsv(sv,oldstr);
7154 PL_tmps_stack[++PL_tmps_ix] = sv;
7160 =for apidoc sv_newmortal
7162 Creates a new null SV which is mortal. The reference count of the SV is
7163 set to 1. It will be destroyed "soon", either by an explicit call to
7164 FREETMPS, or by an implicit call at places such as statement boundaries.
7165 See also C<sv_mortalcopy> and C<sv_2mortal>.
7171 Perl_sv_newmortal(pTHX)
7176 SvFLAGS(sv) = SVs_TEMP;
7178 PL_tmps_stack[++PL_tmps_ix] = sv;
7183 =for apidoc sv_2mortal
7185 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7186 by an explicit call to FREETMPS, or by an implicit call at places such as
7187 statement boundaries. SvTEMP() is turned on which means that the SV's
7188 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7189 and C<sv_mortalcopy>.
7195 Perl_sv_2mortal(pTHX_ register SV *sv)
7200 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7203 PL_tmps_stack[++PL_tmps_ix] = sv;
7211 Creates a new SV and copies a string into it. The reference count for the
7212 SV is set to 1. If C<len> is zero, Perl will compute the length using
7213 strlen(). For efficiency, consider using C<newSVpvn> instead.
7219 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7224 sv_setpvn(sv,s,len ? len : strlen(s));
7229 =for apidoc newSVpvn
7231 Creates a new SV and copies a string into it. The reference count for the
7232 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7233 string. You are responsible for ensuring that the source string is at least
7234 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7240 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7245 sv_setpvn(sv,s,len);
7251 =for apidoc newSVhek
7253 Creates a new SV from the hash key structure. It will generate scalars that
7254 point to the shared string table where possible. Returns a new (undefined)
7255 SV if the hek is NULL.
7261 Perl_newSVhek(pTHX_ const HEK *hek)
7270 if (HEK_LEN(hek) == HEf_SVKEY) {
7271 return newSVsv(*(SV**)HEK_KEY(hek));
7273 const int flags = HEK_FLAGS(hek);
7274 if (flags & HVhek_WASUTF8) {
7276 Andreas would like keys he put in as utf8 to come back as utf8
7278 STRLEN utf8_len = HEK_LEN(hek);
7279 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7280 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7283 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7285 } else if (flags & HVhek_REHASH) {
7286 /* We don't have a pointer to the hv, so we have to replicate the
7287 flag into every HEK. This hv is using custom a hasing
7288 algorithm. Hence we can't return a shared string scalar, as
7289 that would contain the (wrong) hash value, and might get passed
7290 into an hv routine with a regular hash */
7292 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7297 /* This will be overwhelminly the most common case. */
7298 return newSVpvn_share(HEK_KEY(hek),
7299 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7305 =for apidoc newSVpvn_share
7307 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7308 table. If the string does not already exist in the table, it is created
7309 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7310 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7311 otherwise the hash is computed. The idea here is that as the string table
7312 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7313 hash lookup will avoid string compare.
7319 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7322 bool is_utf8 = FALSE;
7324 STRLEN tmplen = -len;
7326 /* See the note in hv.c:hv_fetch() --jhi */
7327 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7331 PERL_HASH(hash, src, len);
7333 sv_upgrade(sv, SVt_PV);
7334 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7346 #if defined(PERL_IMPLICIT_CONTEXT)
7348 /* pTHX_ magic can't cope with varargs, so this is a no-context
7349 * version of the main function, (which may itself be aliased to us).
7350 * Don't access this version directly.
7354 Perl_newSVpvf_nocontext(const char* pat, ...)
7359 va_start(args, pat);
7360 sv = vnewSVpvf(pat, &args);
7367 =for apidoc newSVpvf
7369 Creates a new SV and initializes it with the string formatted like
7376 Perl_newSVpvf(pTHX_ const char* pat, ...)
7380 va_start(args, pat);
7381 sv = vnewSVpvf(pat, &args);
7386 /* backend for newSVpvf() and newSVpvf_nocontext() */
7389 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7393 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7400 Creates a new SV and copies a floating point value into it.
7401 The reference count for the SV is set to 1.
7407 Perl_newSVnv(pTHX_ NV n)
7419 Creates a new SV and copies an integer into it. The reference count for the
7426 Perl_newSViv(pTHX_ IV i)
7438 Creates a new SV and copies an unsigned integer into it.
7439 The reference count for the SV is set to 1.
7445 Perl_newSVuv(pTHX_ UV u)
7455 =for apidoc newRV_noinc
7457 Creates an RV wrapper for an SV. The reference count for the original
7458 SV is B<not> incremented.
7464 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7469 sv_upgrade(sv, SVt_RV);
7471 SvRV_set(sv, tmpRef);
7476 /* newRV_inc is the official function name to use now.
7477 * newRV_inc is in fact #defined to newRV in sv.h
7481 Perl_newRV(pTHX_ SV *tmpRef)
7483 return newRV_noinc(SvREFCNT_inc(tmpRef));
7489 Creates a new SV which is an exact duplicate of the original SV.
7496 Perl_newSVsv(pTHX_ register SV *old)
7502 if (SvTYPE(old) == SVTYPEMASK) {
7503 if (ckWARN_d(WARN_INTERNAL))
7504 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7508 /* SV_GMAGIC is the default for sv_setv()
7509 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7510 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7511 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7516 =for apidoc sv_reset
7518 Underlying implementation for the C<reset> Perl function.
7519 Note that the perl-level function is vaguely deprecated.
7525 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7528 char todo[PERL_UCHAR_MAX+1];
7533 if (!*s) { /* reset ?? searches */
7534 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7536 PMOP *pm = (PMOP *) mg->mg_obj;
7538 pm->op_pmdynflags &= ~PMdf_USED;
7545 /* reset variables */
7547 if (!HvARRAY(stash))
7550 Zero(todo, 256, char);
7553 I32 i = (unsigned char)*s;
7557 max = (unsigned char)*s++;
7558 for ( ; i <= max; i++) {
7561 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7563 for (entry = HvARRAY(stash)[i];
7565 entry = HeNEXT(entry))
7570 if (!todo[(U8)*HeKEY(entry)])
7572 gv = (GV*)HeVAL(entry);
7575 if (SvTHINKFIRST(sv)) {
7576 if (!SvREADONLY(sv) && SvROK(sv))
7578 /* XXX Is this continue a bug? Why should THINKFIRST
7579 exempt us from resetting arrays and hashes? */
7583 if (SvTYPE(sv) >= SVt_PV) {
7585 if (SvPVX_const(sv) != Nullch)
7593 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7596 #ifdef USE_ENVIRON_ARRAY
7598 # ifdef USE_ITHREADS
7599 && PL_curinterp == aTHX
7603 environ[0] = Nullch;
7606 #endif /* !PERL_MICRO */
7616 Using various gambits, try to get an IO from an SV: the IO slot if its a
7617 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7618 named after the PV if we're a string.
7624 Perl_sv_2io(pTHX_ SV *sv)
7629 switch (SvTYPE(sv)) {
7637 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7641 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7643 return sv_2io(SvRV(sv));
7644 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7650 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7659 Using various gambits, try to get a CV from an SV; in addition, try if
7660 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7666 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7673 return *gvp = Nullgv, Nullcv;
7674 switch (SvTYPE(sv)) {
7693 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7694 tryAMAGICunDEREF(to_cv);
7697 if (SvTYPE(sv) == SVt_PVCV) {
7706 Perl_croak(aTHX_ "Not a subroutine reference");
7711 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7717 if (lref && !GvCVu(gv)) {
7720 tmpsv = NEWSV(704,0);
7721 gv_efullname3(tmpsv, gv, Nullch);
7722 /* XXX this is probably not what they think they're getting.
7723 * It has the same effect as "sub name;", i.e. just a forward
7725 newSUB(start_subparse(FALSE, 0),
7726 newSVOP(OP_CONST, 0, tmpsv),
7731 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7741 Returns true if the SV has a true value by Perl's rules.
7742 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7743 instead use an in-line version.
7749 Perl_sv_true(pTHX_ register SV *sv)
7754 const register XPV* tXpv;
7755 if ((tXpv = (XPV*)SvANY(sv)) &&
7756 (tXpv->xpv_cur > 1 ||
7757 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7764 return SvIVX(sv) != 0;
7767 return SvNVX(sv) != 0.0;
7769 return sv_2bool(sv);
7777 A private implementation of the C<SvIVx> macro for compilers which can't
7778 cope with complex macro expressions. Always use the macro instead.
7784 Perl_sv_iv(pTHX_ register SV *sv)
7788 return (IV)SvUVX(sv);
7797 A private implementation of the C<SvUVx> macro for compilers which can't
7798 cope with complex macro expressions. Always use the macro instead.
7804 Perl_sv_uv(pTHX_ register SV *sv)
7809 return (UV)SvIVX(sv);
7817 A private implementation of the C<SvNVx> macro for compilers which can't
7818 cope with complex macro expressions. Always use the macro instead.
7824 Perl_sv_nv(pTHX_ register SV *sv)
7831 /* sv_pv() is now a macro using SvPV_nolen();
7832 * this function provided for binary compatibility only
7836 Perl_sv_pv(pTHX_ SV *sv)
7841 return sv_2pv(sv, 0);
7847 Use the C<SvPV_nolen> macro instead
7851 A private implementation of the C<SvPV> macro for compilers which can't
7852 cope with complex macro expressions. Always use the macro instead.
7858 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7864 return sv_2pv(sv, lp);
7869 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7875 return sv_2pv_flags(sv, lp, 0);
7878 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7879 * this function provided for binary compatibility only
7883 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7885 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7889 =for apidoc sv_pvn_force
7891 Get a sensible string out of the SV somehow.
7892 A private implementation of the C<SvPV_force> macro for compilers which
7893 can't cope with complex macro expressions. Always use the macro instead.
7895 =for apidoc sv_pvn_force_flags
7897 Get a sensible string out of the SV somehow.
7898 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7899 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7900 implemented in terms of this function.
7901 You normally want to use the various wrapper macros instead: see
7902 C<SvPV_force> and C<SvPV_force_nomg>
7908 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7911 if (SvTHINKFIRST(sv) && !SvROK(sv))
7912 sv_force_normal_flags(sv, 0);
7922 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7923 const char * const ref = sv_reftype(sv,0);
7925 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7926 ref, OP_NAME(PL_op));
7928 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7930 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7931 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7933 s = sv_2pv_flags(sv, &len, flags);
7937 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7940 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7941 SvGROW(sv, len + 1);
7942 Move(s,SvPVX_const(sv),len,char);
7947 SvPOK_on(sv); /* validate pointer */
7949 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7950 PTR2UV(sv),SvPVX_const(sv)));
7953 return SvPVX_mutable(sv);
7956 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7957 * this function provided for binary compatibility only
7961 Perl_sv_pvbyte(pTHX_ SV *sv)
7963 sv_utf8_downgrade(sv,0);
7968 =for apidoc sv_pvbyte
7970 Use C<SvPVbyte_nolen> instead.
7972 =for apidoc sv_pvbyten
7974 A private implementation of the C<SvPVbyte> macro for compilers
7975 which can't cope with complex macro expressions. Always use the macro
7982 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7984 sv_utf8_downgrade(sv,0);
7985 return sv_pvn(sv,lp);
7989 =for apidoc sv_pvbyten_force
7991 A private implementation of the C<SvPVbytex_force> macro for compilers
7992 which can't cope with complex macro expressions. Always use the macro
7999 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8001 sv_pvn_force(sv,lp);
8002 sv_utf8_downgrade(sv,0);
8007 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8008 * this function provided for binary compatibility only
8012 Perl_sv_pvutf8(pTHX_ SV *sv)
8014 sv_utf8_upgrade(sv);
8019 =for apidoc sv_pvutf8
8021 Use the C<SvPVutf8_nolen> macro instead
8023 =for apidoc sv_pvutf8n
8025 A private implementation of the C<SvPVutf8> macro for compilers
8026 which can't cope with complex macro expressions. Always use the macro
8033 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8035 sv_utf8_upgrade(sv);
8036 return sv_pvn(sv,lp);
8040 =for apidoc sv_pvutf8n_force
8042 A private implementation of the C<SvPVutf8_force> macro for compilers
8043 which can't cope with complex macro expressions. Always use the macro
8050 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8052 sv_pvn_force(sv,lp);
8053 sv_utf8_upgrade(sv);
8059 =for apidoc sv_reftype
8061 Returns a string describing what the SV is a reference to.
8067 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8069 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8070 inside return suggests a const propagation bug in g++. */
8071 if (ob && SvOBJECT(sv)) {
8072 char * const name = HvNAME_get(SvSTASH(sv));
8073 return name ? name : (char *) "__ANON__";
8076 switch (SvTYPE(sv)) {
8093 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8094 /* tied lvalues should appear to be
8095 * scalars for backwards compatitbility */
8096 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8097 ? "SCALAR" : "LVALUE");
8098 case SVt_PVAV: return "ARRAY";
8099 case SVt_PVHV: return "HASH";
8100 case SVt_PVCV: return "CODE";
8101 case SVt_PVGV: return "GLOB";
8102 case SVt_PVFM: return "FORMAT";
8103 case SVt_PVIO: return "IO";
8104 default: return "UNKNOWN";
8110 =for apidoc sv_isobject
8112 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8113 object. If the SV is not an RV, or if the object is not blessed, then this
8120 Perl_sv_isobject(pTHX_ SV *sv)
8137 Returns a boolean indicating whether the SV is blessed into the specified
8138 class. This does not check for subtypes; use C<sv_derived_from> to verify
8139 an inheritance relationship.
8145 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8157 hvname = HvNAME_get(SvSTASH(sv));
8161 return strEQ(hvname, name);
8167 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8168 it will be upgraded to one. If C<classname> is non-null then the new SV will
8169 be blessed in the specified package. The new SV is returned and its
8170 reference count is 1.
8176 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8182 SV_CHECK_THINKFIRST_COW_DROP(rv);
8185 if (SvTYPE(rv) >= SVt_PVMG) {
8186 const U32 refcnt = SvREFCNT(rv);
8190 SvREFCNT(rv) = refcnt;
8193 if (SvTYPE(rv) < SVt_RV)
8194 sv_upgrade(rv, SVt_RV);
8195 else if (SvTYPE(rv) > SVt_RV) {
8206 HV* const stash = gv_stashpv(classname, TRUE);
8207 (void)sv_bless(rv, stash);
8213 =for apidoc sv_setref_pv
8215 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8216 argument will be upgraded to an RV. That RV will be modified to point to
8217 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8218 into the SV. The C<classname> argument indicates the package for the
8219 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8220 will have a reference count of 1, and the RV will be returned.
8222 Do not use with other Perl types such as HV, AV, SV, CV, because those
8223 objects will become corrupted by the pointer copy process.
8225 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8231 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8234 sv_setsv(rv, &PL_sv_undef);
8238 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8243 =for apidoc sv_setref_iv
8245 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8246 argument will be upgraded to an RV. That RV will be modified to point to
8247 the new SV. The C<classname> argument indicates the package for the
8248 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8249 will have a reference count of 1, and the RV will be returned.
8255 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8257 sv_setiv(newSVrv(rv,classname), iv);
8262 =for apidoc sv_setref_uv
8264 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8265 argument will be upgraded to an RV. That RV will be modified to point to
8266 the new SV. The C<classname> argument indicates the package for the
8267 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8268 will have a reference count of 1, and the RV will be returned.
8274 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8276 sv_setuv(newSVrv(rv,classname), uv);
8281 =for apidoc sv_setref_nv
8283 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8284 argument will be upgraded to an RV. That RV will be modified to point to
8285 the new SV. The C<classname> argument indicates the package for the
8286 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8287 will have a reference count of 1, and the RV will be returned.
8293 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8295 sv_setnv(newSVrv(rv,classname), nv);
8300 =for apidoc sv_setref_pvn
8302 Copies a string into a new SV, optionally blessing the SV. The length of the
8303 string must be specified with C<n>. The C<rv> argument will be upgraded to
8304 an RV. That RV will be modified to point to the new SV. The C<classname>
8305 argument indicates the package for the blessing. Set C<classname> to
8306 C<Nullch> to avoid the blessing. The new SV will have a reference count
8307 of 1, and the RV will be returned.
8309 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8315 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8317 sv_setpvn(newSVrv(rv,classname), pv, n);
8322 =for apidoc sv_bless
8324 Blesses an SV into a specified package. The SV must be an RV. The package
8325 must be designated by its stash (see C<gv_stashpv()>). The reference count
8326 of the SV is unaffected.
8332 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8336 Perl_croak(aTHX_ "Can't bless non-reference value");
8338 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8339 if (SvREADONLY(tmpRef))
8340 Perl_croak(aTHX_ PL_no_modify);
8341 if (SvOBJECT(tmpRef)) {
8342 if (SvTYPE(tmpRef) != SVt_PVIO)
8344 SvREFCNT_dec(SvSTASH(tmpRef));
8347 SvOBJECT_on(tmpRef);
8348 if (SvTYPE(tmpRef) != SVt_PVIO)
8350 SvUPGRADE(tmpRef, SVt_PVMG);
8351 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8358 if(SvSMAGICAL(tmpRef))
8359 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8367 /* Downgrades a PVGV to a PVMG.
8371 S_sv_unglob(pTHX_ SV *sv)
8375 assert(SvTYPE(sv) == SVt_PVGV);
8380 sv_del_backref((SV*)GvSTASH(sv), sv);
8381 GvSTASH(sv) = Nullhv;
8383 sv_unmagic(sv, PERL_MAGIC_glob);
8384 Safefree(GvNAME(sv));
8387 /* need to keep SvANY(sv) in the right arena */
8388 xpvmg = new_XPVMG();
8389 StructCopy(SvANY(sv), xpvmg, XPVMG);
8390 del_XPVGV(SvANY(sv));
8393 SvFLAGS(sv) &= ~SVTYPEMASK;
8394 SvFLAGS(sv) |= SVt_PVMG;
8398 =for apidoc sv_unref_flags
8400 Unsets the RV status of the SV, and decrements the reference count of
8401 whatever was being referenced by the RV. This can almost be thought of
8402 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8403 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8404 (otherwise the decrementing is conditional on the reference count being
8405 different from one or the reference being a readonly SV).
8412 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8414 SV* const target = SvRV(ref);
8416 if (SvWEAKREF(ref)) {
8417 sv_del_backref(target, ref);
8419 SvRV_set(ref, NULL);
8422 SvRV_set(ref, NULL);
8424 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8425 assigned to as BEGIN {$a = \"Foo"} will fail. */
8426 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8427 SvREFCNT_dec(target);
8428 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8429 sv_2mortal(target); /* Schedule for freeing later */
8433 =for apidoc sv_unref
8435 Unsets the RV status of the SV, and decrements the reference count of
8436 whatever was being referenced by the RV. This can almost be thought of
8437 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8438 being zero. See C<SvROK_off>.
8444 Perl_sv_unref(pTHX_ SV *sv)
8446 sv_unref_flags(sv, 0);
8450 =for apidoc sv_taint
8452 Taint an SV. Use C<SvTAINTED_on> instead.
8457 Perl_sv_taint(pTHX_ SV *sv)
8459 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8463 =for apidoc sv_untaint
8465 Untaint an SV. Use C<SvTAINTED_off> instead.
8470 Perl_sv_untaint(pTHX_ SV *sv)
8472 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8473 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8480 =for apidoc sv_tainted
8482 Test an SV for taintedness. Use C<SvTAINTED> instead.
8487 Perl_sv_tainted(pTHX_ SV *sv)
8489 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8490 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8491 if (mg && (mg->mg_len & 1) )
8498 =for apidoc sv_setpviv
8500 Copies an integer into the given SV, also updating its string value.
8501 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8507 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8509 char buf[TYPE_CHARS(UV)];
8511 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8513 sv_setpvn(sv, ptr, ebuf - ptr);
8517 =for apidoc sv_setpviv_mg
8519 Like C<sv_setpviv>, but also handles 'set' magic.
8525 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8527 char buf[TYPE_CHARS(UV)];
8529 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8531 sv_setpvn(sv, ptr, ebuf - ptr);
8535 #if defined(PERL_IMPLICIT_CONTEXT)
8537 /* pTHX_ magic can't cope with varargs, so this is a no-context
8538 * version of the main function, (which may itself be aliased to us).
8539 * Don't access this version directly.
8543 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8547 va_start(args, pat);
8548 sv_vsetpvf(sv, pat, &args);
8552 /* pTHX_ magic can't cope with varargs, so this is a no-context
8553 * version of the main function, (which may itself be aliased to us).
8554 * Don't access this version directly.
8558 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8562 va_start(args, pat);
8563 sv_vsetpvf_mg(sv, pat, &args);
8569 =for apidoc sv_setpvf
8571 Works like C<sv_catpvf> but copies the text into the SV instead of
8572 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8578 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8581 va_start(args, pat);
8582 sv_vsetpvf(sv, pat, &args);
8587 =for apidoc sv_vsetpvf
8589 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8590 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8592 Usually used via its frontend C<sv_setpvf>.
8598 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8600 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8604 =for apidoc sv_setpvf_mg
8606 Like C<sv_setpvf>, but also handles 'set' magic.
8612 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8615 va_start(args, pat);
8616 sv_vsetpvf_mg(sv, pat, &args);
8621 =for apidoc sv_vsetpvf_mg
8623 Like C<sv_vsetpvf>, but also handles 'set' magic.
8625 Usually used via its frontend C<sv_setpvf_mg>.
8631 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8633 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8637 #if defined(PERL_IMPLICIT_CONTEXT)
8639 /* pTHX_ magic can't cope with varargs, so this is a no-context
8640 * version of the main function, (which may itself be aliased to us).
8641 * Don't access this version directly.
8645 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8649 va_start(args, pat);
8650 sv_vcatpvf(sv, pat, &args);
8654 /* pTHX_ magic can't cope with varargs, so this is a no-context
8655 * version of the main function, (which may itself be aliased to us).
8656 * Don't access this version directly.
8660 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8664 va_start(args, pat);
8665 sv_vcatpvf_mg(sv, pat, &args);
8671 =for apidoc sv_catpvf
8673 Processes its arguments like C<sprintf> and appends the formatted
8674 output to an SV. If the appended data contains "wide" characters
8675 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8676 and characters >255 formatted with %c), the original SV might get
8677 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8678 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8679 valid UTF-8; if the original SV was bytes, the pattern should be too.
8684 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8687 va_start(args, pat);
8688 sv_vcatpvf(sv, pat, &args);
8693 =for apidoc sv_vcatpvf
8695 Processes its arguments like C<vsprintf> and appends the formatted output
8696 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8698 Usually used via its frontend C<sv_catpvf>.
8704 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8706 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8710 =for apidoc sv_catpvf_mg
8712 Like C<sv_catpvf>, but also handles 'set' magic.
8718 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8721 va_start(args, pat);
8722 sv_vcatpvf_mg(sv, pat, &args);
8727 =for apidoc sv_vcatpvf_mg
8729 Like C<sv_vcatpvf>, but also handles 'set' magic.
8731 Usually used via its frontend C<sv_catpvf_mg>.
8737 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8739 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8744 =for apidoc sv_vsetpvfn
8746 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8749 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8755 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8757 sv_setpvn(sv, "", 0);
8758 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8761 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8764 S_expect_number(pTHX_ char** pattern)
8767 switch (**pattern) {
8768 case '1': case '2': case '3':
8769 case '4': case '5': case '6':
8770 case '7': case '8': case '9':
8771 while (isDIGIT(**pattern))
8772 var = var * 10 + (*(*pattern)++ - '0');
8776 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8779 F0convert(NV nv, char *endbuf, STRLEN *len)
8781 const int neg = nv < 0;
8790 if (uv & 1 && uv == nv)
8791 uv--; /* Round to even */
8793 const unsigned dig = uv % 10;
8806 =for apidoc sv_vcatpvfn
8808 Processes its arguments like C<vsprintf> and appends the formatted output
8809 to an SV. Uses an array of SVs if the C style variable argument list is
8810 missing (NULL). When running with taint checks enabled, indicates via
8811 C<maybe_tainted> if results are untrustworthy (often due to the use of
8814 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8820 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8821 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8822 vec_utf8 = DO_UTF8(vecsv);
8824 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8827 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8834 static const char nullstr[] = "(null)";
8836 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8837 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8839 /* Times 4: a decimal digit takes more than 3 binary digits.
8840 * NV_DIG: mantissa takes than many decimal digits.
8841 * Plus 32: Playing safe. */
8842 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8843 /* large enough for "%#.#f" --chip */
8844 /* what about long double NVs? --jhi */
8846 PERL_UNUSED_ARG(maybe_tainted);
8848 /* no matter what, this is a string now */
8849 (void)SvPV_force(sv, origlen);
8851 /* special-case "", "%s", and "%-p" (SVf - see below) */
8854 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8856 const char * const s = va_arg(*args, char*);
8857 sv_catpv(sv, s ? s : nullstr);
8859 else if (svix < svmax) {
8860 sv_catsv(sv, *svargs);
8861 if (DO_UTF8(*svargs))
8866 if (args && patlen == 3 && pat[0] == '%' &&
8867 pat[1] == '-' && pat[2] == 'p') {
8868 argsv = va_arg(*args, SV*);
8869 sv_catsv(sv, argsv);
8875 #ifndef USE_LONG_DOUBLE
8876 /* special-case "%.<number>[gf]" */
8877 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8878 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8879 unsigned digits = 0;
8883 while (*pp >= '0' && *pp <= '9')
8884 digits = 10 * digits + (*pp++ - '0');
8885 if (pp - pat == (int)patlen - 1) {
8893 /* Add check for digits != 0 because it seems that some
8894 gconverts are buggy in this case, and we don't yet have
8895 a Configure test for this. */
8896 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8897 /* 0, point, slack */
8898 Gconvert(nv, (int)digits, 0, ebuf);
8900 if (*ebuf) /* May return an empty string for digits==0 */
8903 } else if (!digits) {
8906 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8907 sv_catpvn(sv, p, l);
8913 #endif /* !USE_LONG_DOUBLE */
8915 if (!args && svix < svmax && DO_UTF8(*svargs))
8918 patend = (char*)pat + patlen;
8919 for (p = (char*)pat; p < patend; p = q) {
8922 bool vectorize = FALSE;
8923 bool vectorarg = FALSE;
8924 bool vec_utf8 = FALSE;
8930 bool has_precis = FALSE;
8933 bool is_utf8 = FALSE; /* is this item utf8? */
8934 #ifdef HAS_LDBL_SPRINTF_BUG
8935 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8936 with sfio - Allen <allens@cpan.org> */
8937 bool fix_ldbl_sprintf_bug = FALSE;
8941 U8 utf8buf[UTF8_MAXBYTES+1];
8942 STRLEN esignlen = 0;
8944 const char *eptr = Nullch;
8947 const U8 *vecstr = Null(U8*);
8954 /* we need a long double target in case HAS_LONG_DOUBLE but
8957 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8965 const char *dotstr = ".";
8966 STRLEN dotstrlen = 1;
8967 I32 efix = 0; /* explicit format parameter index */
8968 I32 ewix = 0; /* explicit width index */
8969 I32 epix = 0; /* explicit precision index */
8970 I32 evix = 0; /* explicit vector index */
8971 bool asterisk = FALSE;
8973 /* echo everything up to the next format specification */
8974 for (q = p; q < patend && *q != '%'; ++q) ;
8976 if (has_utf8 && !pat_utf8)
8977 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8979 sv_catpvn(sv, p, q - p);
8986 We allow format specification elements in this order:
8987 \d+\$ explicit format parameter index
8989 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8990 0 flag (as above): repeated to allow "v02"
8991 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8992 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8994 [%bcdefginopsuxDFOUX] format (mandatory)
8999 As of perl5.9.3, printf format checking is on by default.
9000 Internally, perl uses %p formats to provide an escape to
9001 some extended formatting. This block deals with those
9002 extensions: if it does not match, (char*)q is reset and
9003 the normal format processing code is used.
9005 Currently defined extensions are:
9006 %p include pointer address (standard)
9007 %-p (SVf) include an SV (previously %_)
9008 %-<num>p include an SV with precision <num>
9009 %1p (VDf) include a v-string (as %vd)
9010 %<num>p reserved for future extensions
9012 Robin Barker 2005-07-14
9019 EXPECT_NUMBER(q, n);
9026 argsv = va_arg(*args, SV*);
9027 eptr = SvPVx_const(argsv, elen);
9033 else if (n == vdNUMBER) { /* VDf */
9040 if (ckWARN_d(WARN_INTERNAL))
9041 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9042 "internal %%<num>p might conflict with future printf extensions");
9048 if (EXPECT_NUMBER(q, width)) {
9089 if (EXPECT_NUMBER(q, ewix))
9098 if ((vectorarg = asterisk)) {
9111 EXPECT_NUMBER(q, width);
9117 vecsv = va_arg(*args, SV*);
9119 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9120 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9121 dotstr = SvPV_const(vecsv, dotstrlen);
9128 else if (efix ? efix <= svmax : svix < svmax) {
9129 vecsv = svargs[efix ? efix-1 : svix++];
9130 vecstr = (U8*)SvPV_const(vecsv,veclen);
9131 vec_utf8 = DO_UTF8(vecsv);
9132 /* if this is a version object, we need to return the
9133 * stringified representation (which the SvPVX_const has
9134 * already done for us), but not vectorize the args
9136 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9138 q++; /* skip past the rest of the %vd format */
9139 eptr = (const char *) vecstr;
9140 elen = strlen(eptr);
9153 i = va_arg(*args, int);
9155 i = (ewix ? ewix <= svmax : svix < svmax) ?
9156 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9158 width = (i < 0) ? -i : i;
9168 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9170 /* XXX: todo, support specified precision parameter */
9174 i = va_arg(*args, int);
9176 i = (ewix ? ewix <= svmax : svix < svmax)
9177 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9178 precis = (i < 0) ? 0 : i;
9183 precis = precis * 10 + (*q++ - '0');
9192 case 'I': /* Ix, I32x, and I64x */
9194 if (q[1] == '6' && q[2] == '4') {
9200 if (q[1] == '3' && q[2] == '2') {
9210 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9221 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9222 if (*(q + 1) == 'l') { /* lld, llf */
9247 argsv = (efix ? efix <= svmax : svix < svmax) ?
9248 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9255 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9257 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9259 eptr = (char*)utf8buf;
9260 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9271 if (args && !vectorize) {
9272 eptr = va_arg(*args, char*);
9274 #ifdef MACOS_TRADITIONAL
9275 /* On MacOS, %#s format is used for Pascal strings */
9280 elen = strlen(eptr);
9282 eptr = (char *)nullstr;
9283 elen = sizeof nullstr - 1;
9287 eptr = SvPVx_const(argsv, elen);
9288 if (DO_UTF8(argsv)) {
9289 if (has_precis && precis < elen) {
9291 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9294 if (width) { /* fudge width (can't fudge elen) */
9295 width += elen - sv_len_utf8(argsv);
9303 if (has_precis && elen > precis)
9310 if (alt || vectorize)
9312 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9333 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9342 esignbuf[esignlen++] = plus;
9346 case 'h': iv = (short)va_arg(*args, int); break;
9347 case 'l': iv = va_arg(*args, long); break;
9348 case 'V': iv = va_arg(*args, IV); break;
9349 default: iv = va_arg(*args, int); break;
9351 case 'q': iv = va_arg(*args, Quad_t); break;
9356 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9358 case 'h': iv = (short)tiv; break;
9359 case 'l': iv = (long)tiv; break;
9361 default: iv = tiv; break;
9363 case 'q': iv = (Quad_t)tiv; break;
9367 if ( !vectorize ) /* we already set uv above */
9372 esignbuf[esignlen++] = plus;
9376 esignbuf[esignlen++] = '-';
9419 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9430 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9431 case 'l': uv = va_arg(*args, unsigned long); break;
9432 case 'V': uv = va_arg(*args, UV); break;
9433 default: uv = va_arg(*args, unsigned); break;
9435 case 'q': uv = va_arg(*args, Uquad_t); break;
9440 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9442 case 'h': uv = (unsigned short)tuv; break;
9443 case 'l': uv = (unsigned long)tuv; break;
9445 default: uv = tuv; break;
9447 case 'q': uv = (Uquad_t)tuv; break;
9454 char *ptr = ebuf + sizeof ebuf;
9460 p = (char*)((c == 'X')
9461 ? "0123456789ABCDEF" : "0123456789abcdef");
9467 esignbuf[esignlen++] = '0';
9468 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9476 if (alt && *ptr != '0')
9485 esignbuf[esignlen++] = '0';
9486 esignbuf[esignlen++] = 'b';
9489 default: /* it had better be ten or less */
9493 } while (uv /= base);
9496 elen = (ebuf + sizeof ebuf) - ptr;
9500 zeros = precis - elen;
9501 else if (precis == 0 && elen == 1 && *eptr == '0')
9507 /* FLOATING POINT */
9510 c = 'f'; /* maybe %F isn't supported here */
9516 /* This is evil, but floating point is even more evil */
9518 /* for SV-style calling, we can only get NV
9519 for C-style calling, we assume %f is double;
9520 for simplicity we allow any of %Lf, %llf, %qf for long double
9524 #if defined(USE_LONG_DOUBLE)
9528 /* [perl #20339] - we should accept and ignore %lf rather than die */
9532 #if defined(USE_LONG_DOUBLE)
9533 intsize = args ? 0 : 'q';
9537 #if defined(HAS_LONG_DOUBLE)
9546 /* now we need (long double) if intsize == 'q', else (double) */
9547 nv = (args && !vectorize) ?
9548 #if LONG_DOUBLESIZE > DOUBLESIZE
9550 va_arg(*args, long double) :
9551 va_arg(*args, double)
9553 va_arg(*args, double)
9559 if (c != 'e' && c != 'E') {
9561 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9562 will cast our (long double) to (double) */
9563 (void)Perl_frexp(nv, &i);
9564 if (i == PERL_INT_MIN)
9565 Perl_die(aTHX_ "panic: frexp");
9567 need = BIT_DIGITS(i);
9569 need += has_precis ? precis : 6; /* known default */
9574 #ifdef HAS_LDBL_SPRINTF_BUG
9575 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9576 with sfio - Allen <allens@cpan.org> */
9579 # define MY_DBL_MAX DBL_MAX
9580 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9581 # if DOUBLESIZE >= 8
9582 # define MY_DBL_MAX 1.7976931348623157E+308L
9584 # define MY_DBL_MAX 3.40282347E+38L
9588 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9589 # define MY_DBL_MAX_BUG 1L
9591 # define MY_DBL_MAX_BUG MY_DBL_MAX
9595 # define MY_DBL_MIN DBL_MIN
9596 # else /* XXX guessing! -Allen */
9597 # if DOUBLESIZE >= 8
9598 # define MY_DBL_MIN 2.2250738585072014E-308L
9600 # define MY_DBL_MIN 1.17549435E-38L
9604 if ((intsize == 'q') && (c == 'f') &&
9605 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9607 /* it's going to be short enough that
9608 * long double precision is not needed */
9610 if ((nv <= 0L) && (nv >= -0L))
9611 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9613 /* would use Perl_fp_class as a double-check but not
9614 * functional on IRIX - see perl.h comments */
9616 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9617 /* It's within the range that a double can represent */
9618 #if defined(DBL_MAX) && !defined(DBL_MIN)
9619 if ((nv >= ((long double)1/DBL_MAX)) ||
9620 (nv <= (-(long double)1/DBL_MAX)))
9622 fix_ldbl_sprintf_bug = TRUE;
9625 if (fix_ldbl_sprintf_bug == TRUE) {
9635 # undef MY_DBL_MAX_BUG
9638 #endif /* HAS_LDBL_SPRINTF_BUG */
9640 need += 20; /* fudge factor */
9641 if (PL_efloatsize < need) {
9642 Safefree(PL_efloatbuf);
9643 PL_efloatsize = need + 20; /* more fudge */
9644 Newx(PL_efloatbuf, PL_efloatsize, char);
9645 PL_efloatbuf[0] = '\0';
9648 if ( !(width || left || plus || alt) && fill != '0'
9649 && has_precis && intsize != 'q' ) { /* Shortcuts */
9650 /* See earlier comment about buggy Gconvert when digits,
9652 if ( c == 'g' && precis) {
9653 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9654 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9655 goto float_converted;
9656 } else if ( c == 'f' && !precis) {
9657 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9662 char *ptr = ebuf + sizeof ebuf;
9665 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9666 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9667 if (intsize == 'q') {
9668 /* Copy the one or more characters in a long double
9669 * format before the 'base' ([efgEFG]) character to
9670 * the format string. */
9671 static char const prifldbl[] = PERL_PRIfldbl;
9672 char const *p = prifldbl + sizeof(prifldbl) - 3;
9673 while (p >= prifldbl) { *--ptr = *p--; }
9678 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9683 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9695 /* No taint. Otherwise we are in the strange situation
9696 * where printf() taints but print($float) doesn't.
9698 #if defined(HAS_LONG_DOUBLE)
9700 (void)sprintf(PL_efloatbuf, ptr, nv);
9702 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9704 (void)sprintf(PL_efloatbuf, ptr, nv);
9708 eptr = PL_efloatbuf;
9709 elen = strlen(PL_efloatbuf);
9715 i = SvCUR(sv) - origlen;
9716 if (args && !vectorize) {
9718 case 'h': *(va_arg(*args, short*)) = i; break;
9719 default: *(va_arg(*args, int*)) = i; break;
9720 case 'l': *(va_arg(*args, long*)) = i; break;
9721 case 'V': *(va_arg(*args, IV*)) = i; break;
9723 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9728 sv_setuv_mg(argsv, (UV)i);
9730 continue; /* not "break" */
9737 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9738 && ckWARN(WARN_PRINTF))
9740 SV *msg = sv_newmortal();
9741 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9742 (PL_op->op_type == OP_PRTF) ? "" : "s");
9745 Perl_sv_catpvf(aTHX_ msg,
9746 "\"%%%c\"", c & 0xFF);
9748 Perl_sv_catpvf(aTHX_ msg,
9749 "\"%%\\%03"UVof"\"",
9752 sv_catpv(msg, "end of string");
9753 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9756 /* output mangled stuff ... */
9762 /* ... right here, because formatting flags should not apply */
9763 SvGROW(sv, SvCUR(sv) + elen + 1);
9765 Copy(eptr, p, elen, char);
9768 SvCUR_set(sv, p - SvPVX_const(sv));
9770 continue; /* not "break" */
9773 /* calculate width before utf8_upgrade changes it */
9774 have = esignlen + zeros + elen;
9776 if (is_utf8 != has_utf8) {
9779 sv_utf8_upgrade(sv);
9782 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9783 sv_utf8_upgrade(nsv);
9784 eptr = SvPVX_const(nsv);
9787 SvGROW(sv, SvCUR(sv) + elen + 1);
9792 need = (have > width ? have : width);
9795 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9797 if (esignlen && fill == '0') {
9799 for (i = 0; i < (int)esignlen; i++)
9803 memset(p, fill, gap);
9806 if (esignlen && fill != '0') {
9808 for (i = 0; i < (int)esignlen; i++)
9813 for (i = zeros; i; i--)
9817 Copy(eptr, p, elen, char);
9821 memset(p, ' ', gap);
9826 Copy(dotstr, p, dotstrlen, char);
9830 vectorize = FALSE; /* done iterating over vecstr */
9837 SvCUR_set(sv, p - SvPVX_const(sv));
9845 /* =========================================================================
9847 =head1 Cloning an interpreter
9849 All the macros and functions in this section are for the private use of
9850 the main function, perl_clone().
9852 The foo_dup() functions make an exact copy of an existing foo thinngy.
9853 During the course of a cloning, a hash table is used to map old addresses
9854 to new addresses. The table is created and manipulated with the
9855 ptr_table_* functions.
9859 ============================================================================*/
9862 #if defined(USE_ITHREADS)
9864 #ifndef GpREFCNT_inc
9865 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9869 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9870 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9871 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9872 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9873 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9874 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9875 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9876 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9877 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9878 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9879 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9880 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9881 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9884 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9885 regcomp.c. AMS 20010712 */
9888 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9893 struct reg_substr_datum *s;
9896 return (REGEXP *)NULL;
9898 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9901 len = r->offsets[0];
9902 npar = r->nparens+1;
9904 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9905 Copy(r->program, ret->program, len+1, regnode);
9907 Newx(ret->startp, npar, I32);
9908 Copy(r->startp, ret->startp, npar, I32);
9909 Newx(ret->endp, npar, I32);
9910 Copy(r->startp, ret->startp, npar, I32);
9912 Newx(ret->substrs, 1, struct reg_substr_data);
9913 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9914 s->min_offset = r->substrs->data[i].min_offset;
9915 s->max_offset = r->substrs->data[i].max_offset;
9916 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9917 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9920 ret->regstclass = NULL;
9923 const int count = r->data->count;
9926 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9927 char, struct reg_data);
9928 Newx(d->what, count, U8);
9931 for (i = 0; i < count; i++) {
9932 d->what[i] = r->data->what[i];
9933 switch (d->what[i]) {
9934 /* legal options are one of: sfpont
9935 see also regcomp.h and pregfree() */
9937 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9940 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9943 /* This is cheating. */
9944 Newx(d->data[i], 1, struct regnode_charclass_class);
9945 StructCopy(r->data->data[i], d->data[i],
9946 struct regnode_charclass_class);
9947 ret->regstclass = (regnode*)d->data[i];
9950 /* Compiled op trees are readonly, and can thus be
9951 shared without duplication. */
9953 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9957 d->data[i] = r->data->data[i];
9960 d->data[i] = r->data->data[i];
9962 ((reg_trie_data*)d->data[i])->refcount++;
9966 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9975 Newx(ret->offsets, 2*len+1, U32);
9976 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9978 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9979 ret->refcnt = r->refcnt;
9980 ret->minlen = r->minlen;
9981 ret->prelen = r->prelen;
9982 ret->nparens = r->nparens;
9983 ret->lastparen = r->lastparen;
9984 ret->lastcloseparen = r->lastcloseparen;
9985 ret->reganch = r->reganch;
9987 ret->sublen = r->sublen;
9989 if (RX_MATCH_COPIED(ret))
9990 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9992 ret->subbeg = Nullch;
9993 #ifdef PERL_OLD_COPY_ON_WRITE
9994 ret->saved_copy = Nullsv;
9997 ptr_table_store(PL_ptr_table, r, ret);
10001 /* duplicate a file handle */
10004 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10008 PERL_UNUSED_ARG(type);
10011 return (PerlIO*)NULL;
10013 /* look for it in the table first */
10014 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10018 /* create anew and remember what it is */
10019 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10020 ptr_table_store(PL_ptr_table, fp, ret);
10024 /* duplicate a directory handle */
10027 Perl_dirp_dup(pTHX_ DIR *dp)
10035 /* duplicate a typeglob */
10038 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10043 /* look for it in the table first */
10044 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10048 /* create anew and remember what it is */
10050 ptr_table_store(PL_ptr_table, gp, ret);
10053 ret->gp_refcnt = 0; /* must be before any other dups! */
10054 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10055 ret->gp_io = io_dup_inc(gp->gp_io, param);
10056 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10057 ret->gp_av = av_dup_inc(gp->gp_av, param);
10058 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10059 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10060 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10061 ret->gp_cvgen = gp->gp_cvgen;
10062 ret->gp_line = gp->gp_line;
10063 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10067 /* duplicate a chain of magic */
10070 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10072 MAGIC *mgprev = (MAGIC*)NULL;
10075 return (MAGIC*)NULL;
10076 /* look for it in the table first */
10077 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10081 for (; mg; mg = mg->mg_moremagic) {
10083 Newxz(nmg, 1, MAGIC);
10085 mgprev->mg_moremagic = nmg;
10088 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10089 nmg->mg_private = mg->mg_private;
10090 nmg->mg_type = mg->mg_type;
10091 nmg->mg_flags = mg->mg_flags;
10092 if (mg->mg_type == PERL_MAGIC_qr) {
10093 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10095 else if(mg->mg_type == PERL_MAGIC_backref) {
10096 const AV * const av = (AV*) mg->mg_obj;
10099 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10101 for (i = AvFILLp(av); i >= 0; i--) {
10102 if (!svp[i]) continue;
10103 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10106 else if (mg->mg_type == PERL_MAGIC_symtab) {
10107 nmg->mg_obj = mg->mg_obj;
10110 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10111 ? sv_dup_inc(mg->mg_obj, param)
10112 : sv_dup(mg->mg_obj, param);
10114 nmg->mg_len = mg->mg_len;
10115 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10116 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10117 if (mg->mg_len > 0) {
10118 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10119 if (mg->mg_type == PERL_MAGIC_overload_table &&
10120 AMT_AMAGIC((AMT*)mg->mg_ptr))
10122 AMT *amtp = (AMT*)mg->mg_ptr;
10123 AMT *namtp = (AMT*)nmg->mg_ptr;
10125 for (i = 1; i < NofAMmeth; i++) {
10126 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10130 else if (mg->mg_len == HEf_SVKEY)
10131 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10133 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10134 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10141 /* create a new pointer-mapping table */
10144 Perl_ptr_table_new(pTHX)
10147 Newxz(tbl, 1, PTR_TBL_t);
10148 tbl->tbl_max = 511;
10149 tbl->tbl_items = 0;
10150 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10155 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10157 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10160 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
10162 /* map an existing pointer using a table */
10165 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10167 PTR_TBL_ENT_t *tblent;
10168 const UV hash = PTR_TABLE_HASH(sv);
10170 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10171 for (; tblent; tblent = tblent->next) {
10172 if (tblent->oldval == sv)
10173 return tblent->newval;
10175 return (void*)NULL;
10178 /* add a new entry to a pointer-mapping table */
10181 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldv, void *newv)
10183 PTR_TBL_ENT_t *tblent, **otblent;
10184 /* XXX this may be pessimal on platforms where pointers aren't good
10185 * hash values e.g. if they grow faster in the most significant
10187 const UV hash = PTR_TABLE_HASH(oldv);
10191 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10192 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10193 if (tblent->oldval == oldv) {
10194 tblent->newval = newv;
10198 new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
10199 sizeof(struct ptr_tbl_ent));
10200 tblent->oldval = oldv;
10201 tblent->newval = newv;
10202 tblent->next = *otblent;
10205 if (!empty && tbl->tbl_items > tbl->tbl_max)
10206 ptr_table_split(tbl);
10209 /* double the hash bucket size of an existing ptr table */
10212 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10214 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10215 const UV oldsize = tbl->tbl_max + 1;
10216 UV newsize = oldsize * 2;
10219 Renew(ary, newsize, PTR_TBL_ENT_t*);
10220 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10221 tbl->tbl_max = --newsize;
10222 tbl->tbl_ary = ary;
10223 for (i=0; i < oldsize; i++, ary++) {
10224 PTR_TBL_ENT_t **curentp, **entp, *ent;
10227 curentp = ary + oldsize;
10228 for (entp = ary, ent = *ary; ent; ent = *entp) {
10229 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10231 ent->next = *curentp;
10241 /* remove all the entries from a ptr table */
10244 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10246 register PTR_TBL_ENT_t **array;
10247 register PTR_TBL_ENT_t *entry;
10251 if (!tbl || !tbl->tbl_items) {
10255 array = tbl->tbl_ary;
10257 max = tbl->tbl_max;
10261 PTR_TBL_ENT_t *oentry = entry;
10262 entry = entry->next;
10266 if (++riter > max) {
10269 entry = array[riter];
10273 tbl->tbl_items = 0;
10276 /* clear and free a ptr table */
10279 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10284 ptr_table_clear(tbl);
10285 Safefree(tbl->tbl_ary);
10291 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10294 SvRV_set(dstr, SvWEAKREF(sstr)
10295 ? sv_dup(SvRV(sstr), param)
10296 : sv_dup_inc(SvRV(sstr), param));
10299 else if (SvPVX_const(sstr)) {
10300 /* Has something there */
10302 /* Normal PV - clone whole allocated space */
10303 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10304 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10305 /* Not that normal - actually sstr is copy on write.
10306 But we are a true, independant SV, so: */
10307 SvREADONLY_off(dstr);
10312 /* Special case - not normally malloced for some reason */
10313 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10314 /* A "shared" PV - clone it as "shared" PV */
10316 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10320 /* Some other special case - random pointer */
10321 SvPV_set(dstr, SvPVX(sstr));
10326 /* Copy the Null */
10327 if (SvTYPE(dstr) == SVt_RV)
10328 SvRV_set(dstr, NULL);
10334 /* duplicate an SV of any type (including AV, HV etc) */
10337 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10342 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10344 /* look for it in the table first */
10345 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10349 if(param->flags & CLONEf_JOIN_IN) {
10350 /** We are joining here so we don't want do clone
10351 something that is bad **/
10352 const char *hvname;
10354 if(SvTYPE(sstr) == SVt_PVHV &&
10355 (hvname = HvNAME_get(sstr))) {
10356 /** don't clone stashes if they already exist **/
10357 HV* old_stash = gv_stashpv(hvname,0);
10358 return (SV*) old_stash;
10362 /* create anew and remember what it is */
10365 #ifdef DEBUG_LEAKING_SCALARS
10366 dstr->sv_debug_optype = sstr->sv_debug_optype;
10367 dstr->sv_debug_line = sstr->sv_debug_line;
10368 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10369 dstr->sv_debug_cloned = 1;
10371 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10373 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10377 ptr_table_store(PL_ptr_table, sstr, dstr);
10380 SvFLAGS(dstr) = SvFLAGS(sstr);
10381 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10382 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10385 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10386 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10387 PL_watch_pvx, SvPVX_const(sstr));
10390 /* don't clone objects whose class has asked us not to */
10391 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10392 SvFLAGS(dstr) &= ~SVTYPEMASK;
10393 SvOBJECT_off(dstr);
10397 switch (SvTYPE(sstr)) {
10399 SvANY(dstr) = NULL;
10402 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10403 SvIV_set(dstr, SvIVX(sstr));
10406 SvANY(dstr) = new_XNV();
10407 SvNV_set(dstr, SvNVX(sstr));
10410 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10411 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10415 /* These are all the types that need complex bodies allocating. */
10416 size_t new_body_length;
10417 size_t new_body_offset = 0;
10418 void **new_body_arena;
10419 void **new_body_arenaroot;
10422 switch (SvTYPE(sstr)) {
10424 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10429 new_body = new_XPVIO();
10430 new_body_length = sizeof(XPVIO);
10433 new_body = new_XPVFM();
10434 new_body_length = sizeof(XPVFM);
10438 new_body_arena = (void **) &PL_xpvhv_root;
10439 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10440 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10441 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10442 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10443 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10447 new_body_arena = (void **) &PL_xpvav_root;
10448 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10449 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10450 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10451 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10452 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10456 new_body_length = sizeof(XPVBM);
10457 new_body_arena = (void **) &PL_xpvbm_root;
10458 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10461 if (GvUNIQUE((GV*)sstr)) {
10462 /* Do sharing here. */
10464 new_body_length = sizeof(XPVGV);
10465 new_body_arena = (void **) &PL_xpvgv_root;
10466 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10469 new_body_length = sizeof(XPVCV);
10470 new_body_arena = (void **) &PL_xpvcv_root;
10471 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10474 new_body_length = sizeof(XPVLV);
10475 new_body_arena = (void **) &PL_xpvlv_root;
10476 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10479 new_body_length = sizeof(XPVMG);
10480 new_body_arena = (void **) &PL_xpvmg_root;
10481 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10484 new_body_length = sizeof(XPVNV);
10485 new_body_arena = (void **) &PL_xpvnv_root;
10486 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10489 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10490 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10491 new_body_length = sizeof(XPVIV) - new_body_offset;
10492 new_body_arena = (void **) &PL_xpviv_root;
10493 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10496 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10497 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10498 new_body_length = sizeof(XPV) - new_body_offset;
10499 new_body_arena = (void **) &PL_xpv_root;
10500 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10502 assert(new_body_length);
10504 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10506 new_body = (void*)((char*)new_body - new_body_offset);
10508 /* We always allocated the full length item with PURIFY */
10509 new_body_length += new_body_offset;
10510 new_body_offset = 0;
10511 new_body = my_safemalloc(new_body_length);
10515 SvANY(dstr) = new_body;
10517 Copy(((char*)SvANY(sstr)) + new_body_offset,
10518 ((char*)SvANY(dstr)) + new_body_offset,
10519 new_body_length, char);
10521 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10522 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10524 /* The Copy above means that all the source (unduplicated) pointers
10525 are now in the destination. We can check the flags and the
10526 pointers in either, but it's possible that there's less cache
10527 missing by always going for the destination.
10528 FIXME - instrument and check that assumption */
10529 if (SvTYPE(sstr) >= SVt_PVMG) {
10531 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10533 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10536 switch (SvTYPE(sstr)) {
10548 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10549 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10550 LvTARG(dstr) = dstr;
10551 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10552 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10554 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10557 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10558 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10559 /* Don't call sv_add_backref here as it's going to be created
10560 as part of the magic cloning of the symbol table. */
10561 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10562 (void)GpREFCNT_inc(GvGP(dstr));
10565 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10566 if (IoOFP(dstr) == IoIFP(sstr))
10567 IoOFP(dstr) = IoIFP(dstr);
10569 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10570 /* PL_rsfp_filters entries have fake IoDIRP() */
10571 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10572 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10573 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10574 /* I have no idea why fake dirp (rsfps)
10575 should be treated differently but otherwise
10576 we end up with leaks -- sky*/
10577 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10578 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10579 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10581 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10582 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10583 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10585 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10586 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10587 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10590 if (AvARRAY((AV*)sstr)) {
10591 SV **dst_ary, **src_ary;
10592 SSize_t items = AvFILLp((AV*)sstr) + 1;
10594 src_ary = AvARRAY((AV*)sstr);
10595 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10596 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10597 SvPV_set(dstr, (char*)dst_ary);
10598 AvALLOC((AV*)dstr) = dst_ary;
10599 if (AvREAL((AV*)sstr)) {
10600 while (items-- > 0)
10601 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10604 while (items-- > 0)
10605 *dst_ary++ = sv_dup(*src_ary++, param);
10607 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10608 while (items-- > 0) {
10609 *dst_ary++ = &PL_sv_undef;
10613 SvPV_set(dstr, Nullch);
10614 AvALLOC((AV*)dstr) = (SV**)NULL;
10621 if (HvARRAY((HV*)sstr)) {
10623 const bool sharekeys = !!HvSHAREKEYS(sstr);
10624 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10625 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10627 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10628 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10630 HvARRAY(dstr) = (HE**)darray;
10631 while (i <= sxhv->xhv_max) {
10632 HE *source = HvARRAY(sstr)[i];
10633 HvARRAY(dstr)[i] = source
10634 ? he_dup(source, sharekeys, param) : 0;
10638 struct xpvhv_aux *saux = HvAUX(sstr);
10639 struct xpvhv_aux *daux = HvAUX(dstr);
10640 /* This flag isn't copied. */
10641 /* SvOOK_on(hv) attacks the IV flags. */
10642 SvFLAGS(dstr) |= SVf_OOK;
10644 hvname = saux->xhv_name;
10646 = hvname ? hek_dup(hvname, param) : hvname;
10648 daux->xhv_riter = saux->xhv_riter;
10649 daux->xhv_eiter = saux->xhv_eiter
10650 ? he_dup(saux->xhv_eiter,
10651 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10655 SvPV_set(dstr, Nullch);
10657 /* Record stashes for possible cloning in Perl_clone(). */
10659 av_push(param->stashes, dstr);
10664 /* NOTE: not refcounted */
10665 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10667 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10669 if (CvCONST(dstr)) {
10670 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10671 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10672 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10674 /* don't dup if copying back - CvGV isn't refcounted, so the
10675 * duped GV may never be freed. A bit of a hack! DAPM */
10676 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10677 Nullgv : gv_dup(CvGV(dstr), param) ;
10678 if (!(param->flags & CLONEf_COPY_STACKS)) {
10681 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10683 CvWEAKOUTSIDE(sstr)
10684 ? cv_dup( CvOUTSIDE(dstr), param)
10685 : cv_dup_inc(CvOUTSIDE(dstr), param);
10687 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10693 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10699 /* duplicate a context */
10702 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10704 PERL_CONTEXT *ncxs;
10707 return (PERL_CONTEXT*)NULL;
10709 /* look for it in the table first */
10710 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10714 /* create anew and remember what it is */
10715 Newxz(ncxs, max + 1, PERL_CONTEXT);
10716 ptr_table_store(PL_ptr_table, cxs, ncxs);
10719 PERL_CONTEXT *cx = &cxs[ix];
10720 PERL_CONTEXT *ncx = &ncxs[ix];
10721 ncx->cx_type = cx->cx_type;
10722 if (CxTYPE(cx) == CXt_SUBST) {
10723 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10726 ncx->blk_oldsp = cx->blk_oldsp;
10727 ncx->blk_oldcop = cx->blk_oldcop;
10728 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10729 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10730 ncx->blk_oldpm = cx->blk_oldpm;
10731 ncx->blk_gimme = cx->blk_gimme;
10732 switch (CxTYPE(cx)) {
10734 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10735 ? cv_dup_inc(cx->blk_sub.cv, param)
10736 : cv_dup(cx->blk_sub.cv,param));
10737 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10738 ? av_dup_inc(cx->blk_sub.argarray, param)
10740 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10741 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10742 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10743 ncx->blk_sub.lval = cx->blk_sub.lval;
10744 ncx->blk_sub.retop = cx->blk_sub.retop;
10747 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10748 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10749 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10750 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10751 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10752 ncx->blk_eval.retop = cx->blk_eval.retop;
10755 ncx->blk_loop.label = cx->blk_loop.label;
10756 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10757 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10758 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10759 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10760 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10761 ? cx->blk_loop.iterdata
10762 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10763 ncx->blk_loop.oldcomppad
10764 = (PAD*)ptr_table_fetch(PL_ptr_table,
10765 cx->blk_loop.oldcomppad);
10766 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10767 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10768 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10769 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10770 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10773 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10774 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10775 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10776 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10777 ncx->blk_sub.retop = cx->blk_sub.retop;
10789 /* duplicate a stack info structure */
10792 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10797 return (PERL_SI*)NULL;
10799 /* look for it in the table first */
10800 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10804 /* create anew and remember what it is */
10805 Newxz(nsi, 1, PERL_SI);
10806 ptr_table_store(PL_ptr_table, si, nsi);
10808 nsi->si_stack = av_dup_inc(si->si_stack, param);
10809 nsi->si_cxix = si->si_cxix;
10810 nsi->si_cxmax = si->si_cxmax;
10811 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10812 nsi->si_type = si->si_type;
10813 nsi->si_prev = si_dup(si->si_prev, param);
10814 nsi->si_next = si_dup(si->si_next, param);
10815 nsi->si_markoff = si->si_markoff;
10820 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10821 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10822 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10823 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10824 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10825 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10826 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10827 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10828 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10829 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10830 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10831 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10832 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10833 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10836 #define pv_dup_inc(p) SAVEPV(p)
10837 #define pv_dup(p) SAVEPV(p)
10838 #define svp_dup_inc(p,pp) any_dup(p,pp)
10840 /* map any object to the new equivent - either something in the
10841 * ptr table, or something in the interpreter structure
10845 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10850 return (void*)NULL;
10852 /* look for it in the table first */
10853 ret = ptr_table_fetch(PL_ptr_table, v);
10857 /* see if it is part of the interpreter structure */
10858 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10859 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10867 /* duplicate the save stack */
10870 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10872 ANY * const ss = proto_perl->Tsavestack;
10873 const I32 max = proto_perl->Tsavestack_max;
10874 I32 ix = proto_perl->Tsavestack_ix;
10886 void (*dptr) (void*);
10887 void (*dxptr) (pTHX_ void*);
10889 Newxz(nss, max, ANY);
10892 I32 i = POPINT(ss,ix);
10893 TOPINT(nss,ix) = i;
10895 case SAVEt_ITEM: /* normal string */
10896 sv = (SV*)POPPTR(ss,ix);
10897 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10898 sv = (SV*)POPPTR(ss,ix);
10899 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10901 case SAVEt_SV: /* scalar reference */
10902 sv = (SV*)POPPTR(ss,ix);
10903 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10904 gv = (GV*)POPPTR(ss,ix);
10905 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10907 case SAVEt_GENERIC_PVREF: /* generic char* */
10908 c = (char*)POPPTR(ss,ix);
10909 TOPPTR(nss,ix) = pv_dup(c);
10910 ptr = POPPTR(ss,ix);
10911 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10913 case SAVEt_SHARED_PVREF: /* char* in shared space */
10914 c = (char*)POPPTR(ss,ix);
10915 TOPPTR(nss,ix) = savesharedpv(c);
10916 ptr = POPPTR(ss,ix);
10917 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10919 case SAVEt_GENERIC_SVREF: /* generic sv */
10920 case SAVEt_SVREF: /* scalar reference */
10921 sv = (SV*)POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10923 ptr = POPPTR(ss,ix);
10924 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10926 case SAVEt_AV: /* array reference */
10927 av = (AV*)POPPTR(ss,ix);
10928 TOPPTR(nss,ix) = av_dup_inc(av, param);
10929 gv = (GV*)POPPTR(ss,ix);
10930 TOPPTR(nss,ix) = gv_dup(gv, param);
10932 case SAVEt_HV: /* hash reference */
10933 hv = (HV*)POPPTR(ss,ix);
10934 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10935 gv = (GV*)POPPTR(ss,ix);
10936 TOPPTR(nss,ix) = gv_dup(gv, param);
10938 case SAVEt_INT: /* int reference */
10939 ptr = POPPTR(ss,ix);
10940 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10941 intval = (int)POPINT(ss,ix);
10942 TOPINT(nss,ix) = intval;
10944 case SAVEt_LONG: /* long reference */
10945 ptr = POPPTR(ss,ix);
10946 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10947 longval = (long)POPLONG(ss,ix);
10948 TOPLONG(nss,ix) = longval;
10950 case SAVEt_I32: /* I32 reference */
10951 case SAVEt_I16: /* I16 reference */
10952 case SAVEt_I8: /* I8 reference */
10953 ptr = POPPTR(ss,ix);
10954 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10956 TOPINT(nss,ix) = i;
10958 case SAVEt_IV: /* IV reference */
10959 ptr = POPPTR(ss,ix);
10960 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10962 TOPIV(nss,ix) = iv;
10964 case SAVEt_SPTR: /* SV* reference */
10965 ptr = POPPTR(ss,ix);
10966 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10967 sv = (SV*)POPPTR(ss,ix);
10968 TOPPTR(nss,ix) = sv_dup(sv, param);
10970 case SAVEt_VPTR: /* random* reference */
10971 ptr = POPPTR(ss,ix);
10972 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10973 ptr = POPPTR(ss,ix);
10974 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10976 case SAVEt_PPTR: /* char* reference */
10977 ptr = POPPTR(ss,ix);
10978 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10979 c = (char*)POPPTR(ss,ix);
10980 TOPPTR(nss,ix) = pv_dup(c);
10982 case SAVEt_HPTR: /* HV* reference */
10983 ptr = POPPTR(ss,ix);
10984 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10985 hv = (HV*)POPPTR(ss,ix);
10986 TOPPTR(nss,ix) = hv_dup(hv, param);
10988 case SAVEt_APTR: /* AV* reference */
10989 ptr = POPPTR(ss,ix);
10990 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10991 av = (AV*)POPPTR(ss,ix);
10992 TOPPTR(nss,ix) = av_dup(av, param);
10995 gv = (GV*)POPPTR(ss,ix);
10996 TOPPTR(nss,ix) = gv_dup(gv, param);
10998 case SAVEt_GP: /* scalar reference */
10999 gp = (GP*)POPPTR(ss,ix);
11000 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11001 (void)GpREFCNT_inc(gp);
11002 gv = (GV*)POPPTR(ss,ix);
11003 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11004 c = (char*)POPPTR(ss,ix);
11005 TOPPTR(nss,ix) = pv_dup(c);
11007 TOPIV(nss,ix) = iv;
11009 TOPIV(nss,ix) = iv;
11012 case SAVEt_MORTALIZESV:
11013 sv = (SV*)POPPTR(ss,ix);
11014 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11017 ptr = POPPTR(ss,ix);
11018 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11019 /* these are assumed to be refcounted properly */
11021 switch (((OP*)ptr)->op_type) {
11023 case OP_LEAVESUBLV:
11027 case OP_LEAVEWRITE:
11028 TOPPTR(nss,ix) = ptr;
11033 TOPPTR(nss,ix) = Nullop;
11038 TOPPTR(nss,ix) = Nullop;
11041 c = (char*)POPPTR(ss,ix);
11042 TOPPTR(nss,ix) = pv_dup_inc(c);
11044 case SAVEt_CLEARSV:
11045 longval = POPLONG(ss,ix);
11046 TOPLONG(nss,ix) = longval;
11049 hv = (HV*)POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11051 c = (char*)POPPTR(ss,ix);
11052 TOPPTR(nss,ix) = pv_dup_inc(c);
11054 TOPINT(nss,ix) = i;
11056 case SAVEt_DESTRUCTOR:
11057 ptr = POPPTR(ss,ix);
11058 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11059 dptr = POPDPTR(ss,ix);
11060 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11061 any_dup(FPTR2DPTR(void *, dptr),
11064 case SAVEt_DESTRUCTOR_X:
11065 ptr = POPPTR(ss,ix);
11066 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11067 dxptr = POPDXPTR(ss,ix);
11068 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11069 any_dup(FPTR2DPTR(void *, dxptr),
11072 case SAVEt_REGCONTEXT:
11075 TOPINT(nss,ix) = i;
11078 case SAVEt_STACK_POS: /* Position on Perl stack */
11080 TOPINT(nss,ix) = i;
11082 case SAVEt_AELEM: /* array element */
11083 sv = (SV*)POPPTR(ss,ix);
11084 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11086 TOPINT(nss,ix) = i;
11087 av = (AV*)POPPTR(ss,ix);
11088 TOPPTR(nss,ix) = av_dup_inc(av, param);
11090 case SAVEt_HELEM: /* hash element */
11091 sv = (SV*)POPPTR(ss,ix);
11092 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11093 sv = (SV*)POPPTR(ss,ix);
11094 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11095 hv = (HV*)POPPTR(ss,ix);
11096 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11099 ptr = POPPTR(ss,ix);
11100 TOPPTR(nss,ix) = ptr;
11104 TOPINT(nss,ix) = i;
11106 case SAVEt_COMPPAD:
11107 av = (AV*)POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = av_dup(av, param);
11111 longval = (long)POPLONG(ss,ix);
11112 TOPLONG(nss,ix) = longval;
11113 ptr = POPPTR(ss,ix);
11114 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11115 sv = (SV*)POPPTR(ss,ix);
11116 TOPPTR(nss,ix) = sv_dup(sv, param);
11119 ptr = POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11121 longval = (long)POPBOOL(ss,ix);
11122 TOPBOOL(nss,ix) = (bool)longval;
11124 case SAVEt_SET_SVFLAGS:
11126 TOPINT(nss,ix) = i;
11128 TOPINT(nss,ix) = i;
11129 sv = (SV*)POPPTR(ss,ix);
11130 TOPPTR(nss,ix) = sv_dup(sv, param);
11133 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11141 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11142 * flag to the result. This is done for each stash before cloning starts,
11143 * so we know which stashes want their objects cloned */
11146 do_mark_cloneable_stash(pTHX_ SV *sv)
11148 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11150 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11151 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11152 if (cloner && GvCV(cloner)) {
11159 XPUSHs(sv_2mortal(newSVhek(hvname)));
11161 call_sv((SV*)GvCV(cloner), G_SCALAR);
11168 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11176 =for apidoc perl_clone
11178 Create and return a new interpreter by cloning the current one.
11180 perl_clone takes these flags as parameters:
11182 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11183 without it we only clone the data and zero the stacks,
11184 with it we copy the stacks and the new perl interpreter is
11185 ready to run at the exact same point as the previous one.
11186 The pseudo-fork code uses COPY_STACKS while the
11187 threads->new doesn't.
11189 CLONEf_KEEP_PTR_TABLE
11190 perl_clone keeps a ptr_table with the pointer of the old
11191 variable as a key and the new variable as a value,
11192 this allows it to check if something has been cloned and not
11193 clone it again but rather just use the value and increase the
11194 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11195 the ptr_table using the function
11196 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11197 reason to keep it around is if you want to dup some of your own
11198 variable who are outside the graph perl scans, example of this
11199 code is in threads.xs create
11202 This is a win32 thing, it is ignored on unix, it tells perls
11203 win32host code (which is c++) to clone itself, this is needed on
11204 win32 if you want to run two threads at the same time,
11205 if you just want to do some stuff in a separate perl interpreter
11206 and then throw it away and return to the original one,
11207 you don't need to do anything.
11212 /* XXX the above needs expanding by someone who actually understands it ! */
11213 EXTERN_C PerlInterpreter *
11214 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11217 perl_clone(PerlInterpreter *proto_perl, UV flags)
11220 #ifdef PERL_IMPLICIT_SYS
11222 /* perlhost.h so we need to call into it
11223 to clone the host, CPerlHost should have a c interface, sky */
11225 if (flags & CLONEf_CLONE_HOST) {
11226 return perl_clone_host(proto_perl,flags);
11228 return perl_clone_using(proto_perl, flags,
11230 proto_perl->IMemShared,
11231 proto_perl->IMemParse,
11233 proto_perl->IStdIO,
11237 proto_perl->IProc);
11241 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11242 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11243 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11244 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11245 struct IPerlDir* ipD, struct IPerlSock* ipS,
11246 struct IPerlProc* ipP)
11248 /* XXX many of the string copies here can be optimized if they're
11249 * constants; they need to be allocated as common memory and just
11250 * their pointers copied. */
11253 CLONE_PARAMS clone_params;
11254 CLONE_PARAMS* param = &clone_params;
11256 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11257 /* for each stash, determine whether its objects should be cloned */
11258 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11259 PERL_SET_THX(my_perl);
11262 Poison(my_perl, 1, PerlInterpreter);
11264 PL_curcop = (COP *)Nullop;
11268 PL_savestack_ix = 0;
11269 PL_savestack_max = -1;
11270 PL_sig_pending = 0;
11271 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11272 # else /* !DEBUGGING */
11273 Zero(my_perl, 1, PerlInterpreter);
11274 # endif /* DEBUGGING */
11276 /* host pointers */
11278 PL_MemShared = ipMS;
11279 PL_MemParse = ipMP;
11286 #else /* !PERL_IMPLICIT_SYS */
11288 CLONE_PARAMS clone_params;
11289 CLONE_PARAMS* param = &clone_params;
11290 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11291 /* for each stash, determine whether its objects should be cloned */
11292 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11293 PERL_SET_THX(my_perl);
11296 Poison(my_perl, 1, PerlInterpreter);
11298 PL_curcop = (COP *)Nullop;
11302 PL_savestack_ix = 0;
11303 PL_savestack_max = -1;
11304 PL_sig_pending = 0;
11305 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11306 # else /* !DEBUGGING */
11307 Zero(my_perl, 1, PerlInterpreter);
11308 # endif /* DEBUGGING */
11309 #endif /* PERL_IMPLICIT_SYS */
11310 param->flags = flags;
11311 param->proto_perl = proto_perl;
11314 PL_xnv_arenaroot = NULL;
11315 PL_xnv_root = NULL;
11316 PL_xpv_arenaroot = NULL;
11317 PL_xpv_root = NULL;
11318 PL_xpviv_arenaroot = NULL;
11319 PL_xpviv_root = NULL;
11320 PL_xpvnv_arenaroot = NULL;
11321 PL_xpvnv_root = NULL;
11322 PL_xpvcv_arenaroot = NULL;
11323 PL_xpvcv_root = NULL;
11324 PL_xpvav_arenaroot = NULL;
11325 PL_xpvav_root = NULL;
11326 PL_xpvhv_arenaroot = NULL;
11327 PL_xpvhv_root = NULL;
11328 PL_xpvmg_arenaroot = NULL;
11329 PL_xpvmg_root = NULL;
11330 PL_xpvgv_arenaroot = NULL;
11331 PL_xpvgv_root = NULL;
11332 PL_xpvlv_arenaroot = NULL;
11333 PL_xpvlv_root = NULL;
11334 PL_xpvbm_arenaroot = NULL;
11335 PL_xpvbm_root = NULL;
11336 PL_he_arenaroot = NULL;
11338 #if defined(USE_ITHREADS)
11339 PL_pte_arenaroot = NULL;
11340 PL_pte_root = NULL;
11342 PL_nice_chunk = NULL;
11343 PL_nice_chunk_size = 0;
11345 PL_sv_objcount = 0;
11346 PL_sv_root = Nullsv;
11347 PL_sv_arenaroot = Nullsv;
11349 PL_debug = proto_perl->Idebug;
11351 PL_hash_seed = proto_perl->Ihash_seed;
11352 PL_rehash_seed = proto_perl->Irehash_seed;
11354 #ifdef USE_REENTRANT_API
11355 /* XXX: things like -Dm will segfault here in perlio, but doing
11356 * PERL_SET_CONTEXT(proto_perl);
11357 * breaks too many other things
11359 Perl_reentrant_init(aTHX);
11362 /* create SV map for pointer relocation */
11363 PL_ptr_table = ptr_table_new();
11365 /* initialize these special pointers as early as possible */
11366 SvANY(&PL_sv_undef) = NULL;
11367 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11368 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11369 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11371 SvANY(&PL_sv_no) = new_XPVNV();
11372 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11373 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11374 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11375 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11376 SvCUR_set(&PL_sv_no, 0);
11377 SvLEN_set(&PL_sv_no, 1);
11378 SvIV_set(&PL_sv_no, 0);
11379 SvNV_set(&PL_sv_no, 0);
11380 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11382 SvANY(&PL_sv_yes) = new_XPVNV();
11383 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11384 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11385 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11386 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11387 SvCUR_set(&PL_sv_yes, 1);
11388 SvLEN_set(&PL_sv_yes, 2);
11389 SvIV_set(&PL_sv_yes, 1);
11390 SvNV_set(&PL_sv_yes, 1);
11391 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11393 /* create (a non-shared!) shared string table */
11394 PL_strtab = newHV();
11395 HvSHAREKEYS_off(PL_strtab);
11396 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11397 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11399 PL_compiling = proto_perl->Icompiling;
11401 /* These two PVs will be free'd special way so must set them same way op.c does */
11402 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11403 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11405 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11406 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11408 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11409 if (!specialWARN(PL_compiling.cop_warnings))
11410 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11411 if (!specialCopIO(PL_compiling.cop_io))
11412 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11413 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11415 /* pseudo environmental stuff */
11416 PL_origargc = proto_perl->Iorigargc;
11417 PL_origargv = proto_perl->Iorigargv;
11419 param->stashes = newAV(); /* Setup array of objects to call clone on */
11421 /* Set tainting stuff before PerlIO_debug can possibly get called */
11422 PL_tainting = proto_perl->Itainting;
11423 PL_taint_warn = proto_perl->Itaint_warn;
11425 #ifdef PERLIO_LAYERS
11426 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11427 PerlIO_clone(aTHX_ proto_perl, param);
11430 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11431 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11432 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11433 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11434 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11435 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11438 PL_minus_c = proto_perl->Iminus_c;
11439 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11440 PL_localpatches = proto_perl->Ilocalpatches;
11441 PL_splitstr = proto_perl->Isplitstr;
11442 PL_preprocess = proto_perl->Ipreprocess;
11443 PL_minus_n = proto_perl->Iminus_n;
11444 PL_minus_p = proto_perl->Iminus_p;
11445 PL_minus_l = proto_perl->Iminus_l;
11446 PL_minus_a = proto_perl->Iminus_a;
11447 PL_minus_F = proto_perl->Iminus_F;
11448 PL_doswitches = proto_perl->Idoswitches;
11449 PL_dowarn = proto_perl->Idowarn;
11450 PL_doextract = proto_perl->Idoextract;
11451 PL_sawampersand = proto_perl->Isawampersand;
11452 PL_unsafe = proto_perl->Iunsafe;
11453 PL_inplace = SAVEPV(proto_perl->Iinplace);
11454 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11455 PL_perldb = proto_perl->Iperldb;
11456 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11457 PL_exit_flags = proto_perl->Iexit_flags;
11459 /* magical thingies */
11460 /* XXX time(&PL_basetime) when asked for? */
11461 PL_basetime = proto_perl->Ibasetime;
11462 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11464 PL_maxsysfd = proto_perl->Imaxsysfd;
11465 PL_multiline = proto_perl->Imultiline;
11466 PL_statusvalue = proto_perl->Istatusvalue;
11468 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11470 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11472 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11473 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11474 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11476 /* Clone the regex array */
11477 PL_regex_padav = newAV();
11479 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11480 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11482 av_push(PL_regex_padav,
11483 sv_dup_inc(regexen[0],param));
11484 for(i = 1; i <= len; i++) {
11485 if(SvREPADTMP(regexen[i])) {
11486 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11488 av_push(PL_regex_padav,
11490 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11491 SvIVX(regexen[i])), param)))
11496 PL_regex_pad = AvARRAY(PL_regex_padav);
11498 /* shortcuts to various I/O objects */
11499 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11500 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11501 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11502 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11503 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11504 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11506 /* shortcuts to regexp stuff */
11507 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11509 /* shortcuts to misc objects */
11510 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11512 /* shortcuts to debugging objects */
11513 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11514 PL_DBline = gv_dup(proto_perl->IDBline, param);
11515 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11516 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11517 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11518 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11519 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11520 PL_lineary = av_dup(proto_perl->Ilineary, param);
11521 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11523 /* symbol tables */
11524 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11525 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11526 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11527 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11528 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11530 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11531 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11532 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11533 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11534 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11535 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11537 PL_sub_generation = proto_perl->Isub_generation;
11539 /* funky return mechanisms */
11540 PL_forkprocess = proto_perl->Iforkprocess;
11542 /* subprocess state */
11543 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11545 /* internal state */
11546 PL_maxo = proto_perl->Imaxo;
11547 if (proto_perl->Iop_mask)
11548 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11550 PL_op_mask = Nullch;
11551 /* PL_asserting = proto_perl->Iasserting; */
11553 /* current interpreter roots */
11554 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11555 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11556 PL_main_start = proto_perl->Imain_start;
11557 PL_eval_root = proto_perl->Ieval_root;
11558 PL_eval_start = proto_perl->Ieval_start;
11560 /* runtime control stuff */
11561 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11562 PL_copline = proto_perl->Icopline;
11564 PL_filemode = proto_perl->Ifilemode;
11565 PL_lastfd = proto_perl->Ilastfd;
11566 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11569 PL_gensym = proto_perl->Igensym;
11570 PL_preambled = proto_perl->Ipreambled;
11571 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11572 PL_laststatval = proto_perl->Ilaststatval;
11573 PL_laststype = proto_perl->Ilaststype;
11574 PL_mess_sv = Nullsv;
11576 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11578 /* interpreter atexit processing */
11579 PL_exitlistlen = proto_perl->Iexitlistlen;
11580 if (PL_exitlistlen) {
11581 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11582 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11585 PL_exitlist = (PerlExitListEntry*)NULL;
11586 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11587 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11588 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11590 PL_profiledata = NULL;
11591 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11592 /* PL_rsfp_filters entries have fake IoDIRP() */
11593 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11595 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11597 PAD_CLONE_VARS(proto_perl, param);
11599 #ifdef HAVE_INTERP_INTERN
11600 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11603 /* more statics moved here */
11604 PL_generation = proto_perl->Igeneration;
11605 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11607 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11608 PL_in_clean_all = proto_perl->Iin_clean_all;
11610 PL_uid = proto_perl->Iuid;
11611 PL_euid = proto_perl->Ieuid;
11612 PL_gid = proto_perl->Igid;
11613 PL_egid = proto_perl->Iegid;
11614 PL_nomemok = proto_perl->Inomemok;
11615 PL_an = proto_perl->Ian;
11616 PL_evalseq = proto_perl->Ievalseq;
11617 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11618 PL_origalen = proto_perl->Iorigalen;
11619 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11620 PL_osname = SAVEPV(proto_perl->Iosname);
11621 PL_sighandlerp = proto_perl->Isighandlerp;
11623 PL_runops = proto_perl->Irunops;
11625 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11628 PL_cshlen = proto_perl->Icshlen;
11629 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11632 PL_lex_state = proto_perl->Ilex_state;
11633 PL_lex_defer = proto_perl->Ilex_defer;
11634 PL_lex_expect = proto_perl->Ilex_expect;
11635 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11636 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11637 PL_lex_starts = proto_perl->Ilex_starts;
11638 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11639 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11640 PL_lex_op = proto_perl->Ilex_op;
11641 PL_lex_inpat = proto_perl->Ilex_inpat;
11642 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11643 PL_lex_brackets = proto_perl->Ilex_brackets;
11644 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11645 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11646 PL_lex_casemods = proto_perl->Ilex_casemods;
11647 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11648 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11650 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11651 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11652 PL_nexttoke = proto_perl->Inexttoke;
11654 /* XXX This is probably masking the deeper issue of why
11655 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11656 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11657 * (A little debugging with a watchpoint on it may help.)
11659 if (SvANY(proto_perl->Ilinestr)) {
11660 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11661 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11662 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11663 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11664 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11665 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11666 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11667 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11668 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11671 PL_linestr = NEWSV(65,79);
11672 sv_upgrade(PL_linestr,SVt_PVIV);
11673 sv_setpvn(PL_linestr,"",0);
11674 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11676 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11677 PL_pending_ident = proto_perl->Ipending_ident;
11678 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11680 PL_expect = proto_perl->Iexpect;
11682 PL_multi_start = proto_perl->Imulti_start;
11683 PL_multi_end = proto_perl->Imulti_end;
11684 PL_multi_open = proto_perl->Imulti_open;
11685 PL_multi_close = proto_perl->Imulti_close;
11687 PL_error_count = proto_perl->Ierror_count;
11688 PL_subline = proto_perl->Isubline;
11689 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11691 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11692 if (SvANY(proto_perl->Ilinestr)) {
11693 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11694 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11695 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11696 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11697 PL_last_lop_op = proto_perl->Ilast_lop_op;
11700 PL_last_uni = SvPVX(PL_linestr);
11701 PL_last_lop = SvPVX(PL_linestr);
11702 PL_last_lop_op = 0;
11704 PL_in_my = proto_perl->Iin_my;
11705 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11707 PL_cryptseen = proto_perl->Icryptseen;
11710 PL_hints = proto_perl->Ihints;
11712 PL_amagic_generation = proto_perl->Iamagic_generation;
11714 #ifdef USE_LOCALE_COLLATE
11715 PL_collation_ix = proto_perl->Icollation_ix;
11716 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11717 PL_collation_standard = proto_perl->Icollation_standard;
11718 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11719 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11720 #endif /* USE_LOCALE_COLLATE */
11722 #ifdef USE_LOCALE_NUMERIC
11723 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11724 PL_numeric_standard = proto_perl->Inumeric_standard;
11725 PL_numeric_local = proto_perl->Inumeric_local;
11726 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11727 #endif /* !USE_LOCALE_NUMERIC */
11729 /* utf8 character classes */
11730 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11731 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11732 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11733 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11734 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11735 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11736 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11737 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11738 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11739 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11740 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11741 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11742 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11743 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11744 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11745 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11746 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11747 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11748 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11749 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11751 /* Did the locale setup indicate UTF-8? */
11752 PL_utf8locale = proto_perl->Iutf8locale;
11753 /* Unicode features (see perlrun/-C) */
11754 PL_unicode = proto_perl->Iunicode;
11756 /* Pre-5.8 signals control */
11757 PL_signals = proto_perl->Isignals;
11759 /* times() ticks per second */
11760 PL_clocktick = proto_perl->Iclocktick;
11762 /* Recursion stopper for PerlIO_find_layer */
11763 PL_in_load_module = proto_perl->Iin_load_module;
11765 /* sort() routine */
11766 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11768 /* Not really needed/useful since the reenrant_retint is "volatile",
11769 * but do it for consistency's sake. */
11770 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11772 /* Hooks to shared SVs and locks. */
11773 PL_sharehook = proto_perl->Isharehook;
11774 PL_lockhook = proto_perl->Ilockhook;
11775 PL_unlockhook = proto_perl->Iunlockhook;
11776 PL_threadhook = proto_perl->Ithreadhook;
11778 PL_runops_std = proto_perl->Irunops_std;
11779 PL_runops_dbg = proto_perl->Irunops_dbg;
11781 #ifdef THREADS_HAVE_PIDS
11782 PL_ppid = proto_perl->Ippid;
11786 PL_last_swash_hv = Nullhv; /* reinits on demand */
11787 PL_last_swash_klen = 0;
11788 PL_last_swash_key[0]= '\0';
11789 PL_last_swash_tmps = (U8*)NULL;
11790 PL_last_swash_slen = 0;
11792 PL_glob_index = proto_perl->Iglob_index;
11793 PL_srand_called = proto_perl->Isrand_called;
11794 PL_uudmap['M'] = 0; /* reinits on demand */
11795 PL_bitcount = Nullch; /* reinits on demand */
11797 if (proto_perl->Ipsig_pend) {
11798 Newxz(PL_psig_pend, SIG_SIZE, int);
11801 PL_psig_pend = (int*)NULL;
11804 if (proto_perl->Ipsig_ptr) {
11805 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11806 Newxz(PL_psig_name, SIG_SIZE, SV*);
11807 for (i = 1; i < SIG_SIZE; i++) {
11808 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11809 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11813 PL_psig_ptr = (SV**)NULL;
11814 PL_psig_name = (SV**)NULL;
11817 /* thrdvar.h stuff */
11819 if (flags & CLONEf_COPY_STACKS) {
11820 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11821 PL_tmps_ix = proto_perl->Ttmps_ix;
11822 PL_tmps_max = proto_perl->Ttmps_max;
11823 PL_tmps_floor = proto_perl->Ttmps_floor;
11824 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11826 while (i <= PL_tmps_ix) {
11827 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11831 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11832 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11833 Newxz(PL_markstack, i, I32);
11834 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11835 - proto_perl->Tmarkstack);
11836 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11837 - proto_perl->Tmarkstack);
11838 Copy(proto_perl->Tmarkstack, PL_markstack,
11839 PL_markstack_ptr - PL_markstack + 1, I32);
11841 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11842 * NOTE: unlike the others! */
11843 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11844 PL_scopestack_max = proto_perl->Tscopestack_max;
11845 Newxz(PL_scopestack, PL_scopestack_max, I32);
11846 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11848 /* NOTE: si_dup() looks at PL_markstack */
11849 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11851 /* PL_curstack = PL_curstackinfo->si_stack; */
11852 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11853 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11855 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11856 PL_stack_base = AvARRAY(PL_curstack);
11857 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11858 - proto_perl->Tstack_base);
11859 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11861 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11862 * NOTE: unlike the others! */
11863 PL_savestack_ix = proto_perl->Tsavestack_ix;
11864 PL_savestack_max = proto_perl->Tsavestack_max;
11865 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11866 PL_savestack = ss_dup(proto_perl, param);
11870 ENTER; /* perl_destruct() wants to LEAVE; */
11873 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11874 PL_top_env = &PL_start_env;
11876 PL_op = proto_perl->Top;
11879 PL_Xpv = (XPV*)NULL;
11880 PL_na = proto_perl->Tna;
11882 PL_statbuf = proto_perl->Tstatbuf;
11883 PL_statcache = proto_perl->Tstatcache;
11884 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11885 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11887 PL_timesbuf = proto_perl->Ttimesbuf;
11890 PL_tainted = proto_perl->Ttainted;
11891 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11892 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11893 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11894 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11895 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11896 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11897 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11898 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11899 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11901 PL_restartop = proto_perl->Trestartop;
11902 PL_in_eval = proto_perl->Tin_eval;
11903 PL_delaymagic = proto_perl->Tdelaymagic;
11904 PL_dirty = proto_perl->Tdirty;
11905 PL_localizing = proto_perl->Tlocalizing;
11907 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11908 PL_hv_fetch_ent_mh = Nullhe;
11909 PL_modcount = proto_perl->Tmodcount;
11910 PL_lastgotoprobe = Nullop;
11911 PL_dumpindent = proto_perl->Tdumpindent;
11913 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11914 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11915 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11916 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11917 PL_sortcxix = proto_perl->Tsortcxix;
11918 PL_efloatbuf = Nullch; /* reinits on demand */
11919 PL_efloatsize = 0; /* reinits on demand */
11923 PL_screamfirst = NULL;
11924 PL_screamnext = NULL;
11925 PL_maxscream = -1; /* reinits on demand */
11926 PL_lastscream = Nullsv;
11928 PL_watchaddr = NULL;
11929 PL_watchok = Nullch;
11931 PL_regdummy = proto_perl->Tregdummy;
11932 PL_regprecomp = Nullch;
11935 PL_colorset = 0; /* reinits PL_colors[] */
11936 /*PL_colors[6] = {0,0,0,0,0,0};*/
11937 PL_reginput = Nullch;
11938 PL_regbol = Nullch;
11939 PL_regeol = Nullch;
11940 PL_regstartp = (I32*)NULL;
11941 PL_regendp = (I32*)NULL;
11942 PL_reglastparen = (U32*)NULL;
11943 PL_reglastcloseparen = (U32*)NULL;
11944 PL_regtill = Nullch;
11945 PL_reg_start_tmp = (char**)NULL;
11946 PL_reg_start_tmpl = 0;
11947 PL_regdata = (struct reg_data*)NULL;
11950 PL_reg_eval_set = 0;
11952 PL_regprogram = (regnode*)NULL;
11954 PL_regcc = (CURCUR*)NULL;
11955 PL_reg_call_cc = (struct re_cc_state*)NULL;
11956 PL_reg_re = (regexp*)NULL;
11957 PL_reg_ganch = Nullch;
11958 PL_reg_sv = Nullsv;
11959 PL_reg_match_utf8 = FALSE;
11960 PL_reg_magic = (MAGIC*)NULL;
11962 PL_reg_oldcurpm = (PMOP*)NULL;
11963 PL_reg_curpm = (PMOP*)NULL;
11964 PL_reg_oldsaved = Nullch;
11965 PL_reg_oldsavedlen = 0;
11966 #ifdef PERL_OLD_COPY_ON_WRITE
11969 PL_reg_maxiter = 0;
11970 PL_reg_leftiter = 0;
11971 PL_reg_poscache = Nullch;
11972 PL_reg_poscache_size= 0;
11974 /* RE engine - function pointers */
11975 PL_regcompp = proto_perl->Tregcompp;
11976 PL_regexecp = proto_perl->Tregexecp;
11977 PL_regint_start = proto_perl->Tregint_start;
11978 PL_regint_string = proto_perl->Tregint_string;
11979 PL_regfree = proto_perl->Tregfree;
11981 PL_reginterp_cnt = 0;
11982 PL_reg_starttry = 0;
11984 /* Pluggable optimizer */
11985 PL_peepp = proto_perl->Tpeepp;
11987 PL_stashcache = newHV();
11989 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11990 ptr_table_free(PL_ptr_table);
11991 PL_ptr_table = NULL;
11994 /* Call the ->CLONE method, if it exists, for each of the stashes
11995 identified by sv_dup() above.
11997 while(av_len(param->stashes) != -1) {
11998 HV* const stash = (HV*) av_shift(param->stashes);
11999 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12000 if (cloner && GvCV(cloner)) {
12005 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12007 call_sv((SV*)GvCV(cloner), G_DISCARD);
12013 SvREFCNT_dec(param->stashes);
12015 /* orphaned? eg threads->new inside BEGIN or use */
12016 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12017 (void)SvREFCNT_inc(PL_compcv);
12018 SAVEFREESV(PL_compcv);
12024 #endif /* USE_ITHREADS */
12027 =head1 Unicode Support
12029 =for apidoc sv_recode_to_utf8
12031 The encoding is assumed to be an Encode object, on entry the PV
12032 of the sv is assumed to be octets in that encoding, and the sv
12033 will be converted into Unicode (and UTF-8).
12035 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12036 is not a reference, nothing is done to the sv. If the encoding is not
12037 an C<Encode::XS> Encoding object, bad things will happen.
12038 (See F<lib/encoding.pm> and L<Encode>).
12040 The PV of the sv is returned.
12045 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12048 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12062 Passing sv_yes is wrong - it needs to be or'ed set of constants
12063 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12064 remove converted chars from source.
12066 Both will default the value - let them.
12068 XPUSHs(&PL_sv_yes);
12071 call_method("decode", G_SCALAR);
12075 s = SvPV_const(uni, len);
12076 if (s != SvPVX_const(sv)) {
12077 SvGROW(sv, len + 1);
12078 Move(s, SvPVX(sv), len + 1, char);
12079 SvCUR_set(sv, len);
12086 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12090 =for apidoc sv_cat_decode
12092 The encoding is assumed to be an Encode object, the PV of the ssv is
12093 assumed to be octets in that encoding and decoding the input starts
12094 from the position which (PV + *offset) pointed to. The dsv will be
12095 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12096 when the string tstr appears in decoding output or the input ends on
12097 the PV of the ssv. The value which the offset points will be modified
12098 to the last input position on the ssv.
12100 Returns TRUE if the terminator was found, else returns FALSE.
12105 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12106 SV *ssv, int *offset, char *tstr, int tlen)
12110 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12121 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12122 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12124 call_method("cat_decode", G_SCALAR);
12126 ret = SvTRUE(TOPs);
12127 *offset = SvIV(offsv);
12133 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12139 * c-indentation-style: bsd
12140 * c-basic-offset: 4
12141 * indent-tabs-mode: t
12144 * ex: set ts=8 sts=4 sw=4 noet: