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 */
1116 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1120 xpv = *root ? *root : S_more_bodies(aTHX_ arena_root, root, size);
1121 *root = *(void**)xpv;
1126 /* and an inline version */
1128 #define new_body_inline(xpv, arena_root, root, size) \
1131 xpv = *((void **)(root)) \
1132 ? *((void **)(root)) : S_more_bodies(aTHX_ arena_root, root, size); \
1133 *(root) = *(void**)(xpv); \
1137 /* return a thing to the free list */
1139 #define del_body(thing, root) \
1141 void **thing_copy = (void **)thing; \
1143 *thing_copy = *root; \
1144 *root = (void*)thing_copy; \
1148 /* Conventionally we simply malloc() a big block of memory, then divide it
1149 up into lots of the thing that we're allocating.
1151 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1154 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1155 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1158 #define new_body_type(TYPE,lctype) \
1159 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1160 (void**)&PL_ ## lctype ## _root, \
1163 #define del_body_type(p,TYPE,lctype) \
1164 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1166 /* But for some types, we cheat. The type starts with some members that are
1167 never accessed. So we allocate the substructure, starting at the first used
1168 member, then adjust the pointer back in memory by the size of the bit not
1169 allocated, so it's as if we allocated the full structure.
1170 (But things will all go boom if you write to the part that is "not there",
1171 because you'll be overwriting the last members of the preceding structure
1174 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1175 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1176 and the pointer is unchanged. If the allocated structure is smaller (no
1177 initial NV actually allocated) then the net effect is to subtract the size
1178 of the NV from the pointer, to return a new pointer as if an initial NV were
1181 This is the same trick as was used for NV and IV bodies. Ironically it
1182 doesn't need to be used for NV bodies any more, because NV is now at the
1183 start of the structure. IV bodies don't need it either, because they are
1184 no longer allocated. */
1186 #define new_body_allocated(TYPE,lctype,member) \
1187 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1188 (void**)&PL_ ## lctype ## _root, \
1189 sizeof(lctype ## _allocated)) - \
1190 STRUCT_OFFSET(TYPE, member) \
1191 + STRUCT_OFFSET(lctype ## _allocated, member))
1194 #define del_body_allocated(p,TYPE,lctype,member) \
1195 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1196 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1197 (void**)&PL_ ## lctype ## _root)
1199 #define my_safemalloc(s) (void*)safemalloc(s)
1200 #define my_safefree(p) safefree((char*)p)
1204 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1205 #define del_XNV(p) my_safefree(p)
1207 #define new_XPV() my_safemalloc(sizeof(XPV))
1208 #define del_XPV(p) my_safefree(p)
1210 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1211 #define del_XPVIV(p) my_safefree(p)
1213 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1214 #define del_XPVNV(p) my_safefree(p)
1216 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1217 #define del_XPVCV(p) my_safefree(p)
1219 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1220 #define del_XPVAV(p) my_safefree(p)
1222 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1223 #define del_XPVHV(p) my_safefree(p)
1225 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1226 #define del_XPVMG(p) my_safefree(p)
1228 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1229 #define del_XPVGV(p) my_safefree(p)
1231 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1232 #define del_XPVLV(p) my_safefree(p)
1234 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1235 #define del_XPVBM(p) my_safefree(p)
1239 #define new_XNV() new_body_type(NV, xnv)
1240 #define del_XNV(p) del_body_type(p, NV, xnv)
1242 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1243 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1245 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1246 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1248 #define new_XPVNV() new_body_type(XPVNV, xpvnv)
1249 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1251 #define new_XPVCV() new_body_type(XPVCV, xpvcv)
1252 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1254 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1255 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1257 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1258 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1260 #define new_XPVMG() new_body_type(XPVMG, xpvmg)
1261 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1263 #define new_XPVGV() new_body_type(XPVGV, xpvgv)
1264 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1266 #define new_XPVLV() new_body_type(XPVLV, xpvlv)
1267 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1269 #define new_XPVBM() new_body_type(XPVBM, xpvbm)
1270 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1274 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1275 #define del_XPVFM(p) my_safefree(p)
1277 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1278 #define del_XPVIO(p) my_safefree(p)
1281 =for apidoc sv_upgrade
1283 Upgrade an SV to a more complex form. Generally adds a new body type to the
1284 SV, then copies across as much information as possible from the old body.
1285 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1291 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1293 void** old_body_arena;
1294 size_t old_body_offset;
1295 size_t old_body_length; /* Well, the length to copy. */
1297 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1298 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1300 bool zero_nv = TRUE;
1303 size_t new_body_length;
1304 size_t new_body_offset;
1305 void** new_body_arena;
1306 void** new_body_arenaroot;
1307 const U32 old_type = SvTYPE(sv);
1309 if (mt != SVt_PV && SvIsCOW(sv)) {
1310 sv_force_normal_flags(sv, 0);
1313 if (SvTYPE(sv) == mt)
1316 if (SvTYPE(sv) > mt)
1317 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1318 (int)SvTYPE(sv), (int)mt);
1321 old_body = SvANY(sv);
1323 old_body_offset = 0;
1324 old_body_length = 0;
1325 new_body_offset = 0;
1326 new_body_length = ~0;
1328 /* Copying structures onto other structures that have been neatly zeroed
1329 has a subtle gotcha. Consider XPVMG
1331 +------+------+------+------+------+-------+-------+
1332 | NV | CUR | LEN | IV | MAGIC | STASH |
1333 +------+------+------+------+------+-------+-------+
1334 0 4 8 12 16 20 24 28
1336 where NVs are aligned to 8 bytes, so that sizeof that structure is
1337 actually 32 bytes long, with 4 bytes of padding at the end:
1339 +------+------+------+------+------+-------+-------+------+
1340 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1341 +------+------+------+------+------+-------+-------+------+
1342 0 4 8 12 16 20 24 28 32
1344 so what happens if you allocate memory for this structure:
1346 +------+------+------+------+------+-------+-------+------+------+...
1347 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1348 +------+------+------+------+------+-------+-------+------+------+...
1349 0 4 8 12 16 20 24 28 32 36
1351 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1352 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1353 started out as zero once, but it's quite possible that it isn't. So now,
1354 rather than a nicely zeroed GP, you have it pointing somewhere random.
1357 (In fact, GP ends up pointing at a previous GP structure, because the
1358 principle cause of the padding in XPVMG getting garbage is a copy of
1359 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1361 So we are careful and work out the size of used parts of all the
1364 switch (SvTYPE(sv)) {
1370 else if (mt < SVt_PVIV)
1372 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1373 old_body_length = sizeof(IV);
1376 old_body_arena = (void **) &PL_xnv_root;
1377 old_body_length = sizeof(NV);
1378 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1387 old_body_arena = (void **) &PL_xpv_root;
1388 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1389 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1390 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1391 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1395 else if (mt == SVt_NV)
1399 old_body_arena = (void **) &PL_xpviv_root;
1400 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1401 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1402 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1403 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1407 old_body_arena = (void **) &PL_xpvnv_root;
1408 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1409 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1410 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1415 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1416 there's no way that it can be safely upgraded, because perl.c
1417 expects to Safefree(SvANY(PL_mess_sv)) */
1418 assert(sv != PL_mess_sv);
1419 /* This flag bit is used to mean other things in other scalar types.
1420 Given that it only has meaning inside the pad, it shouldn't be set
1421 on anything that can get upgraded. */
1422 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1423 old_body_arena = (void **) &PL_xpvmg_root;
1424 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1425 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1426 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1431 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1434 SvFLAGS(sv) &= ~SVTYPEMASK;
1439 Perl_croak(aTHX_ "Can't upgrade to undef");
1441 assert(old_type == SVt_NULL);
1442 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1446 assert(old_type == SVt_NULL);
1447 SvANY(sv) = new_XNV();
1451 assert(old_type == SVt_NULL);
1452 SvANY(sv) = &sv->sv_u.svu_rv;
1456 SvANY(sv) = new_XPVHV();
1459 HvTOTALKEYS(sv) = 0;
1464 SvANY(sv) = new_XPVAV();
1471 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1472 The target created by newSVrv also is, and it can have magic.
1473 However, it never has SvPVX set.
1475 if (old_type >= SVt_RV) {
1476 assert(SvPVX_const(sv) == 0);
1479 /* Could put this in the else clause below, as PVMG must have SvPVX
1480 0 already (the assertion above) */
1481 SvPV_set(sv, (char*)0);
1483 if (old_type >= SVt_PVMG) {
1484 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1485 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1493 new_body = new_XPVIO();
1494 new_body_length = sizeof(XPVIO);
1497 new_body = new_XPVFM();
1498 new_body_length = sizeof(XPVFM);
1502 new_body_length = sizeof(XPVBM);
1503 new_body_arena = (void **) &PL_xpvbm_root;
1504 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1507 new_body_length = sizeof(XPVGV);
1508 new_body_arena = (void **) &PL_xpvgv_root;
1509 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1512 new_body_length = sizeof(XPVCV);
1513 new_body_arena = (void **) &PL_xpvcv_root;
1514 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1517 new_body_length = sizeof(XPVLV);
1518 new_body_arena = (void **) &PL_xpvlv_root;
1519 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1522 new_body_length = sizeof(XPVMG);
1523 new_body_arena = (void **) &PL_xpvmg_root;
1524 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1527 new_body_length = sizeof(XPVNV);
1528 new_body_arena = (void **) &PL_xpvnv_root;
1529 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1532 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1533 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1534 new_body_length = sizeof(XPVIV) - new_body_offset;
1535 new_body_arena = (void **) &PL_xpviv_root;
1536 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1537 /* XXX Is this still needed? Was it ever needed? Surely as there is
1538 no route from NV to PVIV, NOK can never be true */
1542 goto new_body_no_NV;
1544 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1545 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1546 new_body_length = sizeof(XPV) - new_body_offset;
1547 new_body_arena = (void **) &PL_xpv_root;
1548 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1550 /* PV and PVIV don't have an NV slot. */
1551 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1556 assert(new_body_length);
1558 /* This points to the start of the allocated area. */
1559 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
1562 /* We always allocated the full length item with PURIFY */
1563 new_body_length += new_body_offset;
1564 new_body_offset = 0;
1565 new_body = my_safemalloc(new_body_length);
1569 Zero(new_body, new_body_length, char);
1570 new_body = ((char *)new_body) - new_body_offset;
1571 SvANY(sv) = new_body;
1573 if (old_body_length) {
1574 Copy((char *)old_body + old_body_offset,
1575 (char *)new_body + old_body_offset,
1576 old_body_length, char);
1579 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1585 IoPAGE_LEN(sv) = 60;
1586 if (old_type < SVt_RV)
1590 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1594 if (old_body_arena) {
1596 my_safefree(old_body);
1598 del_body((void*)((char*)old_body + old_body_offset),
1605 =for apidoc sv_backoff
1607 Remove any string offset. You should normally use the C<SvOOK_off> macro
1614 Perl_sv_backoff(pTHX_ register SV *sv)
1617 assert(SvTYPE(sv) != SVt_PVHV);
1618 assert(SvTYPE(sv) != SVt_PVAV);
1620 const char * const s = SvPVX_const(sv);
1621 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1622 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1624 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1626 SvFLAGS(sv) &= ~SVf_OOK;
1633 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1634 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1635 Use the C<SvGROW> wrapper instead.
1641 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1645 #ifdef HAS_64K_LIMIT
1646 if (newlen >= 0x10000) {
1647 PerlIO_printf(Perl_debug_log,
1648 "Allocation too large: %"UVxf"\n", (UV)newlen);
1651 #endif /* HAS_64K_LIMIT */
1654 if (SvTYPE(sv) < SVt_PV) {
1655 sv_upgrade(sv, SVt_PV);
1656 s = SvPVX_mutable(sv);
1658 else if (SvOOK(sv)) { /* pv is offset? */
1660 s = SvPVX_mutable(sv);
1661 if (newlen > SvLEN(sv))
1662 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1663 #ifdef HAS_64K_LIMIT
1664 if (newlen >= 0x10000)
1669 s = SvPVX_mutable(sv);
1671 if (newlen > SvLEN(sv)) { /* need more room? */
1672 newlen = PERL_STRLEN_ROUNDUP(newlen);
1673 if (SvLEN(sv) && s) {
1675 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1681 s = saferealloc(s, newlen);
1684 s = safemalloc(newlen);
1685 if (SvPVX_const(sv) && SvCUR(sv)) {
1686 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1690 SvLEN_set(sv, newlen);
1696 =for apidoc sv_setiv
1698 Copies an integer into the given SV, upgrading first if necessary.
1699 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1705 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1707 SV_CHECK_THINKFIRST_COW_DROP(sv);
1708 switch (SvTYPE(sv)) {
1710 sv_upgrade(sv, SVt_IV);
1713 sv_upgrade(sv, SVt_PVNV);
1717 sv_upgrade(sv, SVt_PVIV);
1726 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1729 (void)SvIOK_only(sv); /* validate number */
1735 =for apidoc sv_setiv_mg
1737 Like C<sv_setiv>, but also handles 'set' magic.
1743 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1750 =for apidoc sv_setuv
1752 Copies an unsigned integer into the given SV, upgrading first if necessary.
1753 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1759 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1761 /* With these two if statements:
1762 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1765 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1767 If you wish to remove them, please benchmark to see what the effect is
1769 if (u <= (UV)IV_MAX) {
1770 sv_setiv(sv, (IV)u);
1779 =for apidoc sv_setuv_mg
1781 Like C<sv_setuv>, but also handles 'set' magic.
1787 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1796 =for apidoc sv_setnv
1798 Copies a double into the given SV, upgrading first if necessary.
1799 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1805 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1807 SV_CHECK_THINKFIRST_COW_DROP(sv);
1808 switch (SvTYPE(sv)) {
1811 sv_upgrade(sv, SVt_NV);
1816 sv_upgrade(sv, SVt_PVNV);
1825 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1829 (void)SvNOK_only(sv); /* validate number */
1834 =for apidoc sv_setnv_mg
1836 Like C<sv_setnv>, but also handles 'set' magic.
1842 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1848 /* Print an "isn't numeric" warning, using a cleaned-up,
1849 * printable version of the offending string
1853 S_not_a_number(pTHX_ SV *sv)
1860 dsv = sv_2mortal(newSVpvn("", 0));
1861 pv = sv_uni_display(dsv, sv, 10, 0);
1864 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1865 /* each *s can expand to 4 chars + "...\0",
1866 i.e. need room for 8 chars */
1868 const char *s, *end;
1869 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1872 if (ch & 128 && !isPRINT_LC(ch)) {
1881 else if (ch == '\r') {
1885 else if (ch == '\f') {
1889 else if (ch == '\\') {
1893 else if (ch == '\0') {
1897 else if (isPRINT_LC(ch))
1914 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1915 "Argument \"%s\" isn't numeric in %s", pv,
1918 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1919 "Argument \"%s\" isn't numeric", pv);
1923 =for apidoc looks_like_number
1925 Test if the content of an SV looks like a number (or is a number).
1926 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1927 non-numeric warning), even if your atof() doesn't grok them.
1933 Perl_looks_like_number(pTHX_ SV *sv)
1935 register const char *sbegin;
1939 sbegin = SvPVX_const(sv);
1942 else if (SvPOKp(sv))
1943 sbegin = SvPV_const(sv, len);
1945 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1946 return grok_number(sbegin, len, NULL);
1949 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1950 until proven guilty, assume that things are not that bad... */
1955 As 64 bit platforms often have an NV that doesn't preserve all bits of
1956 an IV (an assumption perl has been based on to date) it becomes necessary
1957 to remove the assumption that the NV always carries enough precision to
1958 recreate the IV whenever needed, and that the NV is the canonical form.
1959 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1960 precision as a side effect of conversion (which would lead to insanity
1961 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1962 1) to distinguish between IV/UV/NV slots that have cached a valid
1963 conversion where precision was lost and IV/UV/NV slots that have a
1964 valid conversion which has lost no precision
1965 2) to ensure that if a numeric conversion to one form is requested that
1966 would lose precision, the precise conversion (or differently
1967 imprecise conversion) is also performed and cached, to prevent
1968 requests for different numeric formats on the same SV causing
1969 lossy conversion chains. (lossless conversion chains are perfectly
1974 SvIOKp is true if the IV slot contains a valid value
1975 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1976 SvNOKp is true if the NV slot contains a valid value
1977 SvNOK is true only if the NV value is accurate
1980 while converting from PV to NV, check to see if converting that NV to an
1981 IV(or UV) would lose accuracy over a direct conversion from PV to
1982 IV(or UV). If it would, cache both conversions, return NV, but mark
1983 SV as IOK NOKp (ie not NOK).
1985 While converting from PV to IV, check to see if converting that IV to an
1986 NV would lose accuracy over a direct conversion from PV to NV. If it
1987 would, cache both conversions, flag similarly.
1989 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1990 correctly because if IV & NV were set NV *always* overruled.
1991 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1992 changes - now IV and NV together means that the two are interchangeable:
1993 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1995 The benefit of this is that operations such as pp_add know that if
1996 SvIOK is true for both left and right operands, then integer addition
1997 can be used instead of floating point (for cases where the result won't
1998 overflow). Before, floating point was always used, which could lead to
1999 loss of precision compared with integer addition.
2001 * making IV and NV equal status should make maths accurate on 64 bit
2003 * may speed up maths somewhat if pp_add and friends start to use
2004 integers when possible instead of fp. (Hopefully the overhead in
2005 looking for SvIOK and checking for overflow will not outweigh the
2006 fp to integer speedup)
2007 * will slow down integer operations (callers of SvIV) on "inaccurate"
2008 values, as the change from SvIOK to SvIOKp will cause a call into
2009 sv_2iv each time rather than a macro access direct to the IV slot
2010 * should speed up number->string conversion on integers as IV is
2011 favoured when IV and NV are equally accurate
2013 ####################################################################
2014 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2015 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2016 On the other hand, SvUOK is true iff UV.
2017 ####################################################################
2019 Your mileage will vary depending your CPU's relative fp to integer
2023 #ifndef NV_PRESERVES_UV
2024 # define IS_NUMBER_UNDERFLOW_IV 1
2025 # define IS_NUMBER_UNDERFLOW_UV 2
2026 # define IS_NUMBER_IV_AND_UV 2
2027 # define IS_NUMBER_OVERFLOW_IV 4
2028 # define IS_NUMBER_OVERFLOW_UV 5
2030 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2032 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2034 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2036 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));
2037 if (SvNVX(sv) < (NV)IV_MIN) {
2038 (void)SvIOKp_on(sv);
2040 SvIV_set(sv, IV_MIN);
2041 return IS_NUMBER_UNDERFLOW_IV;
2043 if (SvNVX(sv) > (NV)UV_MAX) {
2044 (void)SvIOKp_on(sv);
2047 SvUV_set(sv, UV_MAX);
2048 return IS_NUMBER_OVERFLOW_UV;
2050 (void)SvIOKp_on(sv);
2052 /* Can't use strtol etc to convert this string. (See truth table in
2054 if (SvNVX(sv) <= (UV)IV_MAX) {
2055 SvIV_set(sv, I_V(SvNVX(sv)));
2056 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2057 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2059 /* Integer is imprecise. NOK, IOKp */
2061 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2064 SvUV_set(sv, U_V(SvNVX(sv)));
2065 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2066 if (SvUVX(sv) == UV_MAX) {
2067 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2068 possibly be preserved by NV. Hence, it must be overflow.
2070 return IS_NUMBER_OVERFLOW_UV;
2072 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2074 /* Integer is imprecise. NOK, IOKp */
2076 return IS_NUMBER_OVERFLOW_IV;
2078 #endif /* !NV_PRESERVES_UV*/
2080 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2081 * this function provided for binary compatibility only
2085 Perl_sv_2iv(pTHX_ register SV *sv)
2087 return sv_2iv_flags(sv, SV_GMAGIC);
2091 =for apidoc sv_2iv_flags
2093 Return the integer value of an SV, doing any necessary string
2094 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2095 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2101 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2105 if (SvGMAGICAL(sv)) {
2106 if (flags & SV_GMAGIC)
2111 return I_V(SvNVX(sv));
2113 if (SvPOKp(sv) && SvLEN(sv))
2116 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2117 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2123 if (SvTHINKFIRST(sv)) {
2126 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2127 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2128 return SvIV(tmpstr);
2129 return PTR2IV(SvRV(sv));
2132 sv_force_normal_flags(sv, 0);
2134 if (SvREADONLY(sv) && !SvOK(sv)) {
2135 if (ckWARN(WARN_UNINITIALIZED))
2142 return (IV)(SvUVX(sv));
2149 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2150 * without also getting a cached IV/UV from it at the same time
2151 * (ie PV->NV conversion should detect loss of accuracy and cache
2152 * IV or UV at same time to avoid this. NWC */
2154 if (SvTYPE(sv) == SVt_NV)
2155 sv_upgrade(sv, SVt_PVNV);
2157 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2158 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2159 certainly cast into the IV range at IV_MAX, whereas the correct
2160 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2162 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2163 SvIV_set(sv, I_V(SvNVX(sv)));
2164 if (SvNVX(sv) == (NV) SvIVX(sv)
2165 #ifndef NV_PRESERVES_UV
2166 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2167 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2168 /* Don't flag it as "accurately an integer" if the number
2169 came from a (by definition imprecise) NV operation, and
2170 we're outside the range of NV integer precision */
2173 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2174 DEBUG_c(PerlIO_printf(Perl_debug_log,
2175 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2181 /* IV not precise. No need to convert from PV, as NV
2182 conversion would already have cached IV if it detected
2183 that PV->IV would be better than PV->NV->IV
2184 flags already correct - don't set public IOK. */
2185 DEBUG_c(PerlIO_printf(Perl_debug_log,
2186 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2191 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2192 but the cast (NV)IV_MIN rounds to a the value less (more
2193 negative) than IV_MIN which happens to be equal to SvNVX ??
2194 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2195 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2196 (NV)UVX == NVX are both true, but the values differ. :-(
2197 Hopefully for 2s complement IV_MIN is something like
2198 0x8000000000000000 which will be exact. NWC */
2201 SvUV_set(sv, U_V(SvNVX(sv)));
2203 (SvNVX(sv) == (NV) SvUVX(sv))
2204 #ifndef NV_PRESERVES_UV
2205 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2206 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2207 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2208 /* Don't flag it as "accurately an integer" if the number
2209 came from a (by definition imprecise) NV operation, and
2210 we're outside the range of NV integer precision */
2216 DEBUG_c(PerlIO_printf(Perl_debug_log,
2217 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2221 return (IV)SvUVX(sv);
2224 else if (SvPOKp(sv) && SvLEN(sv)) {
2226 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2227 /* We want to avoid a possible problem when we cache an IV which
2228 may be later translated to an NV, and the resulting NV is not
2229 the same as the direct translation of the initial string
2230 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2231 be careful to ensure that the value with the .456 is around if the
2232 NV value is requested in the future).
2234 This means that if we cache such an IV, we need to cache the
2235 NV as well. Moreover, we trade speed for space, and do not
2236 cache the NV if we are sure it's not needed.
2239 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2240 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2241 == IS_NUMBER_IN_UV) {
2242 /* It's definitely an integer, only upgrade to PVIV */
2243 if (SvTYPE(sv) < SVt_PVIV)
2244 sv_upgrade(sv, SVt_PVIV);
2246 } else if (SvTYPE(sv) < SVt_PVNV)
2247 sv_upgrade(sv, SVt_PVNV);
2249 /* If NV preserves UV then we only use the UV value if we know that
2250 we aren't going to call atof() below. If NVs don't preserve UVs
2251 then the value returned may have more precision than atof() will
2252 return, even though value isn't perfectly accurate. */
2253 if ((numtype & (IS_NUMBER_IN_UV
2254 #ifdef NV_PRESERVES_UV
2257 )) == IS_NUMBER_IN_UV) {
2258 /* This won't turn off the public IOK flag if it was set above */
2259 (void)SvIOKp_on(sv);
2261 if (!(numtype & IS_NUMBER_NEG)) {
2263 if (value <= (UV)IV_MAX) {
2264 SvIV_set(sv, (IV)value);
2266 SvUV_set(sv, value);
2270 /* 2s complement assumption */
2271 if (value <= (UV)IV_MIN) {
2272 SvIV_set(sv, -(IV)value);
2274 /* Too negative for an IV. This is a double upgrade, but
2275 I'm assuming it will be rare. */
2276 if (SvTYPE(sv) < SVt_PVNV)
2277 sv_upgrade(sv, SVt_PVNV);
2281 SvNV_set(sv, -(NV)value);
2282 SvIV_set(sv, IV_MIN);
2286 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2287 will be in the previous block to set the IV slot, and the next
2288 block to set the NV slot. So no else here. */
2290 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2291 != IS_NUMBER_IN_UV) {
2292 /* It wasn't an (integer that doesn't overflow the UV). */
2293 SvNV_set(sv, Atof(SvPVX_const(sv)));
2295 if (! numtype && ckWARN(WARN_NUMERIC))
2298 #if defined(USE_LONG_DOUBLE)
2299 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2300 PTR2UV(sv), SvNVX(sv)));
2302 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2303 PTR2UV(sv), SvNVX(sv)));
2307 #ifdef NV_PRESERVES_UV
2308 (void)SvIOKp_on(sv);
2310 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2311 SvIV_set(sv, I_V(SvNVX(sv)));
2312 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2315 /* Integer is imprecise. NOK, IOKp */
2317 /* UV will not work better than IV */
2319 if (SvNVX(sv) > (NV)UV_MAX) {
2321 /* Integer is inaccurate. NOK, IOKp, is UV */
2322 SvUV_set(sv, UV_MAX);
2325 SvUV_set(sv, U_V(SvNVX(sv)));
2326 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2327 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2331 /* Integer is imprecise. NOK, IOKp, is UV */
2337 #else /* NV_PRESERVES_UV */
2338 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2339 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2340 /* The IV slot will have been set from value returned by
2341 grok_number above. The NV slot has just been set using
2344 assert (SvIOKp(sv));
2346 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2347 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2348 /* Small enough to preserve all bits. */
2349 (void)SvIOKp_on(sv);
2351 SvIV_set(sv, I_V(SvNVX(sv)));
2352 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2354 /* Assumption: first non-preserved integer is < IV_MAX,
2355 this NV is in the preserved range, therefore: */
2356 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2358 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);
2362 0 0 already failed to read UV.
2363 0 1 already failed to read UV.
2364 1 0 you won't get here in this case. IV/UV
2365 slot set, public IOK, Atof() unneeded.
2366 1 1 already read UV.
2367 so there's no point in sv_2iuv_non_preserve() attempting
2368 to use atol, strtol, strtoul etc. */
2369 if (sv_2iuv_non_preserve (sv, numtype)
2370 >= IS_NUMBER_OVERFLOW_IV)
2374 #endif /* NV_PRESERVES_UV */
2377 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2379 if (SvTYPE(sv) < SVt_IV)
2380 /* Typically the caller expects that sv_any is not NULL now. */
2381 sv_upgrade(sv, SVt_IV);
2384 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2385 PTR2UV(sv),SvIVX(sv)));
2386 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2389 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2390 * this function provided for binary compatibility only
2394 Perl_sv_2uv(pTHX_ register SV *sv)
2396 return sv_2uv_flags(sv, SV_GMAGIC);
2400 =for apidoc sv_2uv_flags
2402 Return the unsigned integer value of an SV, doing any necessary string
2403 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2404 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2410 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2414 if (SvGMAGICAL(sv)) {
2415 if (flags & SV_GMAGIC)
2420 return U_V(SvNVX(sv));
2421 if (SvPOKp(sv) && SvLEN(sv))
2424 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2425 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2431 if (SvTHINKFIRST(sv)) {
2434 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2435 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2436 return SvUV(tmpstr);
2437 return PTR2UV(SvRV(sv));
2440 sv_force_normal_flags(sv, 0);
2442 if (SvREADONLY(sv) && !SvOK(sv)) {
2443 if (ckWARN(WARN_UNINITIALIZED))
2453 return (UV)SvIVX(sv);
2457 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2458 * without also getting a cached IV/UV from it at the same time
2459 * (ie PV->NV conversion should detect loss of accuracy and cache
2460 * IV or UV at same time to avoid this. */
2461 /* IV-over-UV optimisation - choose to cache IV if possible */
2463 if (SvTYPE(sv) == SVt_NV)
2464 sv_upgrade(sv, SVt_PVNV);
2466 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2467 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2468 SvIV_set(sv, I_V(SvNVX(sv)));
2469 if (SvNVX(sv) == (NV) SvIVX(sv)
2470 #ifndef NV_PRESERVES_UV
2471 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2472 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2473 /* Don't flag it as "accurately an integer" if the number
2474 came from a (by definition imprecise) NV operation, and
2475 we're outside the range of NV integer precision */
2478 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2479 DEBUG_c(PerlIO_printf(Perl_debug_log,
2480 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2486 /* IV not precise. No need to convert from PV, as NV
2487 conversion would already have cached IV if it detected
2488 that PV->IV would be better than PV->NV->IV
2489 flags already correct - don't set public IOK. */
2490 DEBUG_c(PerlIO_printf(Perl_debug_log,
2491 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2496 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2497 but the cast (NV)IV_MIN rounds to a the value less (more
2498 negative) than IV_MIN which happens to be equal to SvNVX ??
2499 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2500 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2501 (NV)UVX == NVX are both true, but the values differ. :-(
2502 Hopefully for 2s complement IV_MIN is something like
2503 0x8000000000000000 which will be exact. NWC */
2506 SvUV_set(sv, U_V(SvNVX(sv)));
2508 (SvNVX(sv) == (NV) SvUVX(sv))
2509 #ifndef NV_PRESERVES_UV
2510 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2511 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2512 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2513 /* Don't flag it as "accurately an integer" if the number
2514 came from a (by definition imprecise) NV operation, and
2515 we're outside the range of NV integer precision */
2520 DEBUG_c(PerlIO_printf(Perl_debug_log,
2521 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2527 else if (SvPOKp(sv) && SvLEN(sv)) {
2529 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2531 /* We want to avoid a possible problem when we cache a UV which
2532 may be later translated to an NV, and the resulting NV is not
2533 the translation of the initial data.
2535 This means that if we cache such a UV, we need to cache the
2536 NV as well. Moreover, we trade speed for space, and do not
2537 cache the NV if not needed.
2540 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2541 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2542 == IS_NUMBER_IN_UV) {
2543 /* It's definitely an integer, only upgrade to PVIV */
2544 if (SvTYPE(sv) < SVt_PVIV)
2545 sv_upgrade(sv, SVt_PVIV);
2547 } else if (SvTYPE(sv) < SVt_PVNV)
2548 sv_upgrade(sv, SVt_PVNV);
2550 /* If NV preserves UV then we only use the UV value if we know that
2551 we aren't going to call atof() below. If NVs don't preserve UVs
2552 then the value returned may have more precision than atof() will
2553 return, even though it isn't accurate. */
2554 if ((numtype & (IS_NUMBER_IN_UV
2555 #ifdef NV_PRESERVES_UV
2558 )) == IS_NUMBER_IN_UV) {
2559 /* This won't turn off the public IOK flag if it was set above */
2560 (void)SvIOKp_on(sv);
2562 if (!(numtype & IS_NUMBER_NEG)) {
2564 if (value <= (UV)IV_MAX) {
2565 SvIV_set(sv, (IV)value);
2567 /* it didn't overflow, and it was positive. */
2568 SvUV_set(sv, value);
2572 /* 2s complement assumption */
2573 if (value <= (UV)IV_MIN) {
2574 SvIV_set(sv, -(IV)value);
2576 /* Too negative for an IV. This is a double upgrade, but
2577 I'm assuming it will be rare. */
2578 if (SvTYPE(sv) < SVt_PVNV)
2579 sv_upgrade(sv, SVt_PVNV);
2583 SvNV_set(sv, -(NV)value);
2584 SvIV_set(sv, IV_MIN);
2589 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2590 != IS_NUMBER_IN_UV) {
2591 /* It wasn't an integer, or it overflowed the UV. */
2592 SvNV_set(sv, Atof(SvPVX_const(sv)));
2594 if (! numtype && ckWARN(WARN_NUMERIC))
2597 #if defined(USE_LONG_DOUBLE)
2598 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2599 PTR2UV(sv), SvNVX(sv)));
2601 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2602 PTR2UV(sv), SvNVX(sv)));
2605 #ifdef NV_PRESERVES_UV
2606 (void)SvIOKp_on(sv);
2608 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2609 SvIV_set(sv, I_V(SvNVX(sv)));
2610 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2613 /* Integer is imprecise. NOK, IOKp */
2615 /* UV will not work better than IV */
2617 if (SvNVX(sv) > (NV)UV_MAX) {
2619 /* Integer is inaccurate. NOK, IOKp, is UV */
2620 SvUV_set(sv, UV_MAX);
2623 SvUV_set(sv, U_V(SvNVX(sv)));
2624 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2625 NV preservse UV so can do correct comparison. */
2626 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2630 /* Integer is imprecise. NOK, IOKp, is UV */
2635 #else /* NV_PRESERVES_UV */
2636 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2637 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2638 /* The UV slot will have been set from value returned by
2639 grok_number above. The NV slot has just been set using
2642 assert (SvIOKp(sv));
2644 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2645 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2646 /* Small enough to preserve all bits. */
2647 (void)SvIOKp_on(sv);
2649 SvIV_set(sv, I_V(SvNVX(sv)));
2650 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2652 /* Assumption: first non-preserved integer is < IV_MAX,
2653 this NV is in the preserved range, therefore: */
2654 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2656 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);
2659 sv_2iuv_non_preserve (sv, numtype);
2661 #endif /* NV_PRESERVES_UV */
2665 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2666 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2669 if (SvTYPE(sv) < SVt_IV)
2670 /* Typically the caller expects that sv_any is not NULL now. */
2671 sv_upgrade(sv, SVt_IV);
2675 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2676 PTR2UV(sv),SvUVX(sv)));
2677 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2683 Return the num value of an SV, doing any necessary string or integer
2684 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2691 Perl_sv_2nv(pTHX_ register SV *sv)
2695 if (SvGMAGICAL(sv)) {
2699 if (SvPOKp(sv) && SvLEN(sv)) {
2700 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2701 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2703 return Atof(SvPVX_const(sv));
2707 return (NV)SvUVX(sv);
2709 return (NV)SvIVX(sv);
2712 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2713 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2719 if (SvTHINKFIRST(sv)) {
2722 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2723 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2724 return SvNV(tmpstr);
2725 return PTR2NV(SvRV(sv));
2728 sv_force_normal_flags(sv, 0);
2730 if (SvREADONLY(sv) && !SvOK(sv)) {
2731 if (ckWARN(WARN_UNINITIALIZED))
2736 if (SvTYPE(sv) < SVt_NV) {
2737 if (SvTYPE(sv) == SVt_IV)
2738 sv_upgrade(sv, SVt_PVNV);
2740 sv_upgrade(sv, SVt_NV);
2741 #ifdef USE_LONG_DOUBLE
2743 STORE_NUMERIC_LOCAL_SET_STANDARD();
2744 PerlIO_printf(Perl_debug_log,
2745 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2746 PTR2UV(sv), SvNVX(sv));
2747 RESTORE_NUMERIC_LOCAL();
2751 STORE_NUMERIC_LOCAL_SET_STANDARD();
2752 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2753 PTR2UV(sv), SvNVX(sv));
2754 RESTORE_NUMERIC_LOCAL();
2758 else if (SvTYPE(sv) < SVt_PVNV)
2759 sv_upgrade(sv, SVt_PVNV);
2764 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2765 #ifdef NV_PRESERVES_UV
2768 /* Only set the public NV OK flag if this NV preserves the IV */
2769 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2770 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2771 : (SvIVX(sv) == I_V(SvNVX(sv))))
2777 else if (SvPOKp(sv) && SvLEN(sv)) {
2779 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2780 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2782 #ifdef NV_PRESERVES_UV
2783 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2784 == IS_NUMBER_IN_UV) {
2785 /* It's definitely an integer */
2786 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2788 SvNV_set(sv, Atof(SvPVX_const(sv)));
2791 SvNV_set(sv, Atof(SvPVX_const(sv)));
2792 /* Only set the public NV OK flag if this NV preserves the value in
2793 the PV at least as well as an IV/UV would.
2794 Not sure how to do this 100% reliably. */
2795 /* if that shift count is out of range then Configure's test is
2796 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2798 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2799 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2800 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2801 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2802 /* Can't use strtol etc to convert this string, so don't try.
2803 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2806 /* value has been set. It may not be precise. */
2807 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2808 /* 2s complement assumption for (UV)IV_MIN */
2809 SvNOK_on(sv); /* Integer is too negative. */
2814 if (numtype & IS_NUMBER_NEG) {
2815 SvIV_set(sv, -(IV)value);
2816 } else if (value <= (UV)IV_MAX) {
2817 SvIV_set(sv, (IV)value);
2819 SvUV_set(sv, value);
2823 if (numtype & IS_NUMBER_NOT_INT) {
2824 /* I believe that even if the original PV had decimals,
2825 they are lost beyond the limit of the FP precision.
2826 However, neither is canonical, so both only get p
2827 flags. NWC, 2000/11/25 */
2828 /* Both already have p flags, so do nothing */
2830 const NV nv = SvNVX(sv);
2831 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2832 if (SvIVX(sv) == I_V(nv)) {
2837 /* It had no "." so it must be integer. */
2840 /* between IV_MAX and NV(UV_MAX).
2841 Could be slightly > UV_MAX */
2843 if (numtype & IS_NUMBER_NOT_INT) {
2844 /* UV and NV both imprecise. */
2846 const UV nv_as_uv = U_V(nv);
2848 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2859 #endif /* NV_PRESERVES_UV */
2862 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2864 if (SvTYPE(sv) < SVt_NV)
2865 /* Typically the caller expects that sv_any is not NULL now. */
2866 /* XXX Ilya implies that this is a bug in callers that assume this
2867 and ideally should be fixed. */
2868 sv_upgrade(sv, SVt_NV);
2871 #if defined(USE_LONG_DOUBLE)
2873 STORE_NUMERIC_LOCAL_SET_STANDARD();
2874 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2875 PTR2UV(sv), SvNVX(sv));
2876 RESTORE_NUMERIC_LOCAL();
2880 STORE_NUMERIC_LOCAL_SET_STANDARD();
2881 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2882 PTR2UV(sv), SvNVX(sv));
2883 RESTORE_NUMERIC_LOCAL();
2889 /* asIV(): extract an integer from the string value of an SV.
2890 * Caller must validate PVX */
2893 S_asIV(pTHX_ SV *sv)
2896 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2898 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2899 == IS_NUMBER_IN_UV) {
2900 /* It's definitely an integer */
2901 if (numtype & IS_NUMBER_NEG) {
2902 if (value < (UV)IV_MIN)
2905 if (value < (UV)IV_MAX)
2910 if (ckWARN(WARN_NUMERIC))
2913 return I_V(Atof(SvPVX_const(sv)));
2916 /* asUV(): extract an unsigned integer from the string value of an SV
2917 * Caller must validate PVX */
2920 S_asUV(pTHX_ SV *sv)
2923 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2925 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2926 == IS_NUMBER_IN_UV) {
2927 /* It's definitely an integer */
2928 if (!(numtype & IS_NUMBER_NEG))
2932 if (ckWARN(WARN_NUMERIC))
2935 return U_V(Atof(SvPVX_const(sv)));
2939 =for apidoc sv_2pv_nolen
2941 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2942 use the macro wrapper C<SvPV_nolen(sv)> instead.
2947 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2949 return sv_2pv(sv, 0);
2952 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2953 * UV as a string towards the end of buf, and return pointers to start and
2956 * We assume that buf is at least TYPE_CHARS(UV) long.
2960 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2962 char *ptr = buf + TYPE_CHARS(UV);
2976 *--ptr = '0' + (char)(uv % 10);
2984 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2985 * this function provided for binary compatibility only
2989 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2991 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2995 =for apidoc sv_2pv_flags
2997 Returns a pointer to the string value of an SV, and sets *lp to its length.
2998 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3000 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3001 usually end up here too.
3007 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3012 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3013 char *tmpbuf = tbuf;
3020 if (SvGMAGICAL(sv)) {
3021 if (flags & SV_GMAGIC)
3026 if (flags & SV_MUTABLE_RETURN)
3027 return SvPVX_mutable(sv);
3028 if (flags & SV_CONST_RETURN)
3029 return (char *)SvPVX_const(sv);
3034 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3036 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3041 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3046 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3047 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3055 if (SvTHINKFIRST(sv)) {
3058 register const char *typestr;
3059 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3060 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3062 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3065 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3066 if (flags & SV_CONST_RETURN) {
3067 pv = (char *) SvPVX_const(tmpstr);
3069 pv = (flags & SV_MUTABLE_RETURN)
3070 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3073 *lp = SvCUR(tmpstr);
3075 pv = sv_2pv_flags(tmpstr, lp, flags);
3086 typestr = "NULLREF";
3090 switch (SvTYPE(sv)) {
3092 if ( ((SvFLAGS(sv) &
3093 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3094 == (SVs_OBJECT|SVs_SMG))
3095 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3096 const regexp *re = (regexp *)mg->mg_obj;
3099 const char *fptr = "msix";
3104 char need_newline = 0;
3105 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3107 while((ch = *fptr++)) {
3109 reflags[left++] = ch;
3112 reflags[right--] = ch;
3117 reflags[left] = '-';
3121 mg->mg_len = re->prelen + 4 + left;
3123 * If /x was used, we have to worry about a regex
3124 * ending with a comment later being embedded
3125 * within another regex. If so, we don't want this
3126 * regex's "commentization" to leak out to the
3127 * right part of the enclosing regex, we must cap
3128 * it with a newline.
3130 * So, if /x was used, we scan backwards from the
3131 * end of the regex. If we find a '#' before we
3132 * find a newline, we need to add a newline
3133 * ourself. If we find a '\n' first (or if we
3134 * don't find '#' or '\n'), we don't need to add
3135 * anything. -jfriedl
3137 if (PMf_EXTENDED & re->reganch)
3139 const char *endptr = re->precomp + re->prelen;
3140 while (endptr >= re->precomp)
3142 const char c = *(endptr--);
3144 break; /* don't need another */
3146 /* we end while in a comment, so we
3148 mg->mg_len++; /* save space for it */
3149 need_newline = 1; /* note to add it */
3155 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3156 Copy("(?", mg->mg_ptr, 2, char);
3157 Copy(reflags, mg->mg_ptr+2, left, char);
3158 Copy(":", mg->mg_ptr+left+2, 1, char);
3159 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3161 mg->mg_ptr[mg->mg_len - 2] = '\n';
3162 mg->mg_ptr[mg->mg_len - 1] = ')';
3163 mg->mg_ptr[mg->mg_len] = 0;
3165 PL_reginterp_cnt += re->program[0].next_off;
3167 if (re->reganch & ROPT_UTF8)
3183 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3184 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3185 /* tied lvalues should appear to be
3186 * scalars for backwards compatitbility */
3187 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3188 ? "SCALAR" : "LVALUE"; break;
3189 case SVt_PVAV: typestr = "ARRAY"; break;
3190 case SVt_PVHV: typestr = "HASH"; break;
3191 case SVt_PVCV: typestr = "CODE"; break;
3192 case SVt_PVGV: typestr = "GLOB"; break;
3193 case SVt_PVFM: typestr = "FORMAT"; break;
3194 case SVt_PVIO: typestr = "IO"; break;
3195 default: typestr = "UNKNOWN"; break;
3199 const char *name = HvNAME_get(SvSTASH(sv));
3200 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3201 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3204 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3208 *lp = strlen(typestr);
3209 return (char *)typestr;
3211 if (SvREADONLY(sv) && !SvOK(sv)) {
3212 if (ckWARN(WARN_UNINITIALIZED))
3219 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3220 /* I'm assuming that if both IV and NV are equally valid then
3221 converting the IV is going to be more efficient */
3222 const U32 isIOK = SvIOK(sv);
3223 const U32 isUIOK = SvIsUV(sv);
3224 char buf[TYPE_CHARS(UV)];
3227 if (SvTYPE(sv) < SVt_PVIV)
3228 sv_upgrade(sv, SVt_PVIV);
3230 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3232 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3233 /* inlined from sv_setpvn */
3234 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3235 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3236 SvCUR_set(sv, ebuf - ptr);
3246 else if (SvNOKp(sv)) {
3247 if (SvTYPE(sv) < SVt_PVNV)
3248 sv_upgrade(sv, SVt_PVNV);
3249 /* The +20 is pure guesswork. Configure test needed. --jhi */
3250 s = SvGROW_mutable(sv, NV_DIG + 20);
3251 olderrno = errno; /* some Xenix systems wipe out errno here */
3253 if (SvNVX(sv) == 0.0)
3254 (void)strcpy(s,"0");
3258 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3261 #ifdef FIXNEGATIVEZERO
3262 if (*s == '-' && s[1] == '0' && !s[2])
3272 if (ckWARN(WARN_UNINITIALIZED)
3273 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3277 if (SvTYPE(sv) < SVt_PV)
3278 /* Typically the caller expects that sv_any is not NULL now. */
3279 sv_upgrade(sv, SVt_PV);
3283 STRLEN len = s - SvPVX_const(sv);
3289 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3290 PTR2UV(sv),SvPVX_const(sv)));
3291 if (flags & SV_CONST_RETURN)
3292 return (char *)SvPVX_const(sv);
3293 if (flags & SV_MUTABLE_RETURN)
3294 return SvPVX_mutable(sv);
3298 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3299 /* Sneaky stuff here */
3303 tsv = newSVpv(tmpbuf, 0);
3316 t = SvPVX_const(tsv);
3321 len = strlen(tmpbuf);
3323 #ifdef FIXNEGATIVEZERO
3324 if (len == 2 && t[0] == '-' && t[1] == '0') {
3329 SvUPGRADE(sv, SVt_PV);
3332 s = SvGROW_mutable(sv, len + 1);
3335 return memcpy(s, t, len + 1);
3340 =for apidoc sv_copypv
3342 Copies a stringified representation of the source SV into the
3343 destination SV. Automatically performs any necessary mg_get and
3344 coercion of numeric values into strings. Guaranteed to preserve
3345 UTF-8 flag even from overloaded objects. Similar in nature to
3346 sv_2pv[_flags] but operates directly on an SV instead of just the
3347 string. Mostly uses sv_2pv_flags to do its work, except when that
3348 would lose the UTF-8'ness of the PV.
3354 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3357 const char * const s = SvPV_const(ssv,len);
3358 sv_setpvn(dsv,s,len);
3366 =for apidoc sv_2pvbyte_nolen
3368 Return a pointer to the byte-encoded representation of the SV.
3369 May cause the SV to be downgraded from UTF-8 as a side-effect.
3371 Usually accessed via the C<SvPVbyte_nolen> macro.
3377 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3379 return sv_2pvbyte(sv, 0);
3383 =for apidoc sv_2pvbyte
3385 Return a pointer to the byte-encoded representation of the SV, and set *lp
3386 to its length. May cause the SV to be downgraded from UTF-8 as a
3389 Usually accessed via the C<SvPVbyte> macro.
3395 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3397 sv_utf8_downgrade(sv,0);
3398 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3402 =for apidoc sv_2pvutf8_nolen
3404 Return a pointer to the UTF-8-encoded representation of the SV.
3405 May cause the SV to be upgraded to UTF-8 as a side-effect.
3407 Usually accessed via the C<SvPVutf8_nolen> macro.
3413 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3415 return sv_2pvutf8(sv, 0);
3419 =for apidoc sv_2pvutf8
3421 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3422 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3424 Usually accessed via the C<SvPVutf8> macro.
3430 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3432 sv_utf8_upgrade(sv);
3433 return SvPV(sv,*lp);
3437 =for apidoc sv_2bool
3439 This function is only called on magical items, and is only used by
3440 sv_true() or its macro equivalent.
3446 Perl_sv_2bool(pTHX_ register SV *sv)
3455 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3456 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3457 return (bool)SvTRUE(tmpsv);
3458 return SvRV(sv) != 0;
3461 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3463 (*sv->sv_u.svu_pv > '0' ||
3464 Xpvtmp->xpv_cur > 1 ||
3465 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3472 return SvIVX(sv) != 0;
3475 return SvNVX(sv) != 0.0;
3482 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3483 * this function provided for binary compatibility only
3488 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3490 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3494 =for apidoc sv_utf8_upgrade
3496 Converts the PV of an SV to its UTF-8-encoded form.
3497 Forces the SV to string form if it is not already.
3498 Always sets the SvUTF8 flag to avoid future validity checks even
3499 if all the bytes have hibit clear.
3501 This is not as a general purpose byte encoding to Unicode interface:
3502 use the Encode extension for that.
3504 =for apidoc sv_utf8_upgrade_flags
3506 Converts the PV of an SV to its UTF-8-encoded form.
3507 Forces the SV to string form if it is not already.
3508 Always sets the SvUTF8 flag to avoid future validity checks even
3509 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3510 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3511 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3513 This is not as a general purpose byte encoding to Unicode interface:
3514 use the Encode extension for that.
3520 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3522 if (sv == &PL_sv_undef)
3526 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3527 (void) sv_2pv_flags(sv,&len, flags);
3531 (void) SvPV_force(sv,len);
3540 sv_force_normal_flags(sv, 0);
3543 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3544 sv_recode_to_utf8(sv, PL_encoding);
3545 else { /* Assume Latin-1/EBCDIC */
3546 /* This function could be much more efficient if we
3547 * had a FLAG in SVs to signal if there are any hibit
3548 * chars in the PV. Given that there isn't such a flag
3549 * make the loop as fast as possible. */
3550 const U8 *s = (U8 *) SvPVX_const(sv);
3551 const U8 *e = (U8 *) SvEND(sv);
3557 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3561 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3562 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3564 SvPV_free(sv); /* No longer using what was there before. */
3566 SvPV_set(sv, (char*)recoded);
3567 SvCUR_set(sv, len - 1);
3568 SvLEN_set(sv, len); /* No longer know the real size. */
3570 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3577 =for apidoc sv_utf8_downgrade
3579 Attempts to convert the PV of an SV from characters to bytes.
3580 If the PV contains a character beyond byte, this conversion will fail;
3581 in this case, either returns false or, if C<fail_ok> is not
3584 This is not as a general purpose Unicode to byte encoding interface:
3585 use the Encode extension for that.
3591 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3593 if (SvPOKp(sv) && SvUTF8(sv)) {
3599 sv_force_normal_flags(sv, 0);
3601 s = (U8 *) SvPV(sv, len);
3602 if (!utf8_to_bytes(s, &len)) {
3607 Perl_croak(aTHX_ "Wide character in %s",
3610 Perl_croak(aTHX_ "Wide character");
3621 =for apidoc sv_utf8_encode
3623 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3624 flag off so that it looks like octets again.
3630 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3632 (void) sv_utf8_upgrade(sv);
3634 sv_force_normal_flags(sv, 0);
3636 if (SvREADONLY(sv)) {
3637 Perl_croak(aTHX_ PL_no_modify);
3643 =for apidoc sv_utf8_decode
3645 If the PV of the SV is an octet sequence in UTF-8
3646 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3647 so that it looks like a character. If the PV contains only single-byte
3648 characters, the C<SvUTF8> flag stays being off.
3649 Scans PV for validity and returns false if the PV is invalid UTF-8.
3655 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3661 /* The octets may have got themselves encoded - get them back as
3664 if (!sv_utf8_downgrade(sv, TRUE))
3667 /* it is actually just a matter of turning the utf8 flag on, but
3668 * we want to make sure everything inside is valid utf8 first.
3670 c = (const U8 *) SvPVX_const(sv);
3671 if (!is_utf8_string(c, SvCUR(sv)+1))
3673 e = (const U8 *) SvEND(sv);
3676 if (!UTF8_IS_INVARIANT(ch)) {
3685 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3686 * this function provided for binary compatibility only
3690 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3692 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3696 =for apidoc sv_setsv
3698 Copies the contents of the source SV C<ssv> into the destination SV
3699 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3700 function if the source SV needs to be reused. Does not handle 'set' magic.
3701 Loosely speaking, it performs a copy-by-value, obliterating any previous
3702 content of the destination.
3704 You probably want to use one of the assortment of wrappers, such as
3705 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3706 C<SvSetMagicSV_nosteal>.
3708 =for apidoc sv_setsv_flags
3710 Copies the contents of the source SV C<ssv> into the destination SV
3711 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3712 function if the source SV needs to be reused. Does not handle 'set' magic.
3713 Loosely speaking, it performs a copy-by-value, obliterating any previous
3714 content of the destination.
3715 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3716 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3717 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3718 and C<sv_setsv_nomg> are implemented in terms of this function.
3720 You probably want to use one of the assortment of wrappers, such as
3721 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3722 C<SvSetMagicSV_nosteal>.
3724 This is the primary function for copying scalars, and most other
3725 copy-ish functions and macros use this underneath.
3731 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3733 register U32 sflags;
3739 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3741 sstr = &PL_sv_undef;
3742 stype = SvTYPE(sstr);
3743 dtype = SvTYPE(dstr);
3748 /* need to nuke the magic */
3750 SvRMAGICAL_off(dstr);
3753 /* There's a lot of redundancy below but we're going for speed here */
3758 if (dtype != SVt_PVGV) {
3759 (void)SvOK_off(dstr);
3767 sv_upgrade(dstr, SVt_IV);
3770 sv_upgrade(dstr, SVt_PVNV);
3774 sv_upgrade(dstr, SVt_PVIV);
3777 (void)SvIOK_only(dstr);
3778 SvIV_set(dstr, SvIVX(sstr));
3781 if (SvTAINTED(sstr))
3792 sv_upgrade(dstr, SVt_NV);
3797 sv_upgrade(dstr, SVt_PVNV);
3800 SvNV_set(dstr, SvNVX(sstr));
3801 (void)SvNOK_only(dstr);
3802 if (SvTAINTED(sstr))
3810 sv_upgrade(dstr, SVt_RV);
3811 else if (dtype == SVt_PVGV &&
3812 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3815 if (GvIMPORTED(dstr) != GVf_IMPORTED
3816 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3818 GvIMPORTED_on(dstr);
3827 #ifdef PERL_OLD_COPY_ON_WRITE
3828 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3829 if (dtype < SVt_PVIV)
3830 sv_upgrade(dstr, SVt_PVIV);
3837 sv_upgrade(dstr, SVt_PV);
3840 if (dtype < SVt_PVIV)
3841 sv_upgrade(dstr, SVt_PVIV);
3844 if (dtype < SVt_PVNV)
3845 sv_upgrade(dstr, SVt_PVNV);
3852 const char * const type = sv_reftype(sstr,0);
3854 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3856 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3861 if (dtype <= SVt_PVGV) {
3863 if (dtype != SVt_PVGV) {
3864 const char * const name = GvNAME(sstr);
3865 const STRLEN len = GvNAMELEN(sstr);
3866 /* don't upgrade SVt_PVLV: it can hold a glob */
3867 if (dtype != SVt_PVLV)
3868 sv_upgrade(dstr, SVt_PVGV);
3869 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3870 GvSTASH(dstr) = GvSTASH(sstr);
3872 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3873 GvNAME(dstr) = savepvn(name, len);
3874 GvNAMELEN(dstr) = len;
3875 SvFAKE_on(dstr); /* can coerce to non-glob */
3877 /* ahem, death to those who redefine active sort subs */
3878 else if (PL_curstackinfo->si_type == PERLSI_SORT
3879 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3880 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3883 #ifdef GV_UNIQUE_CHECK
3884 if (GvUNIQUE((GV*)dstr)) {
3885 Perl_croak(aTHX_ PL_no_modify);
3889 (void)SvOK_off(dstr);
3890 GvINTRO_off(dstr); /* one-shot flag */
3892 GvGP(dstr) = gp_ref(GvGP(sstr));
3893 if (SvTAINTED(sstr))
3895 if (GvIMPORTED(dstr) != GVf_IMPORTED
3896 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3898 GvIMPORTED_on(dstr);
3906 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3908 if ((int)SvTYPE(sstr) != stype) {
3909 stype = SvTYPE(sstr);
3910 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3914 if (stype == SVt_PVLV)
3915 SvUPGRADE(dstr, SVt_PVNV);
3917 SvUPGRADE(dstr, (U32)stype);
3920 sflags = SvFLAGS(sstr);
3922 if (sflags & SVf_ROK) {
3923 if (dtype >= SVt_PV) {
3924 if (dtype == SVt_PVGV) {
3925 SV *sref = SvREFCNT_inc(SvRV(sstr));
3927 const int intro = GvINTRO(dstr);
3929 #ifdef GV_UNIQUE_CHECK
3930 if (GvUNIQUE((GV*)dstr)) {
3931 Perl_croak(aTHX_ PL_no_modify);
3936 GvINTRO_off(dstr); /* one-shot flag */
3937 GvLINE(dstr) = CopLINE(PL_curcop);
3938 GvEGV(dstr) = (GV*)dstr;
3941 switch (SvTYPE(sref)) {
3944 SAVEGENERICSV(GvAV(dstr));
3946 dref = (SV*)GvAV(dstr);
3947 GvAV(dstr) = (AV*)sref;
3948 if (!GvIMPORTED_AV(dstr)
3949 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3951 GvIMPORTED_AV_on(dstr);
3956 SAVEGENERICSV(GvHV(dstr));
3958 dref = (SV*)GvHV(dstr);
3959 GvHV(dstr) = (HV*)sref;
3960 if (!GvIMPORTED_HV(dstr)
3961 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3963 GvIMPORTED_HV_on(dstr);
3968 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3969 SvREFCNT_dec(GvCV(dstr));
3970 GvCV(dstr) = Nullcv;
3971 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3972 PL_sub_generation++;
3974 SAVEGENERICSV(GvCV(dstr));
3977 dref = (SV*)GvCV(dstr);
3978 if (GvCV(dstr) != (CV*)sref) {
3979 CV* cv = GvCV(dstr);
3981 if (!GvCVGEN((GV*)dstr) &&
3982 (CvROOT(cv) || CvXSUB(cv)))
3984 /* ahem, death to those who redefine
3985 * active sort subs */
3986 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3987 PL_sortcop == CvSTART(cv))
3989 "Can't redefine active sort subroutine %s",
3990 GvENAME((GV*)dstr));
3991 /* Redefining a sub - warning is mandatory if
3992 it was a const and its value changed. */
3993 if (ckWARN(WARN_REDEFINE)
3995 && (!CvCONST((CV*)sref)
3996 || sv_cmp(cv_const_sv(cv),
3997 cv_const_sv((CV*)sref)))))
3999 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4001 ? "Constant subroutine %s::%s redefined"
4002 : "Subroutine %s::%s redefined",
4003 HvNAME_get(GvSTASH((GV*)dstr)),
4004 GvENAME((GV*)dstr));
4008 cv_ckproto(cv, (GV*)dstr,
4010 ? SvPVX_const(sref) : Nullch);
4012 GvCV(dstr) = (CV*)sref;
4013 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4014 GvASSUMECV_on(dstr);
4015 PL_sub_generation++;
4017 if (!GvIMPORTED_CV(dstr)
4018 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4020 GvIMPORTED_CV_on(dstr);
4025 SAVEGENERICSV(GvIOp(dstr));
4027 dref = (SV*)GvIOp(dstr);
4028 GvIOp(dstr) = (IO*)sref;
4032 SAVEGENERICSV(GvFORM(dstr));
4034 dref = (SV*)GvFORM(dstr);
4035 GvFORM(dstr) = (CV*)sref;
4039 SAVEGENERICSV(GvSV(dstr));
4041 dref = (SV*)GvSV(dstr);
4043 if (!GvIMPORTED_SV(dstr)
4044 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4046 GvIMPORTED_SV_on(dstr);
4052 if (SvTAINTED(sstr))
4056 if (SvPVX_const(dstr)) {
4062 (void)SvOK_off(dstr);
4063 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4065 if (sflags & SVp_NOK) {
4067 /* Only set the public OK flag if the source has public OK. */
4068 if (sflags & SVf_NOK)
4069 SvFLAGS(dstr) |= SVf_NOK;
4070 SvNV_set(dstr, SvNVX(sstr));
4072 if (sflags & SVp_IOK) {
4073 (void)SvIOKp_on(dstr);
4074 if (sflags & SVf_IOK)
4075 SvFLAGS(dstr) |= SVf_IOK;
4076 if (sflags & SVf_IVisUV)
4078 SvIV_set(dstr, SvIVX(sstr));
4080 if (SvAMAGIC(sstr)) {
4084 else if (sflags & SVp_POK) {
4088 * Check to see if we can just swipe the string. If so, it's a
4089 * possible small lose on short strings, but a big win on long ones.
4090 * It might even be a win on short strings if SvPVX_const(dstr)
4091 * has to be allocated and SvPVX_const(sstr) has to be freed.
4094 /* Whichever path we take through the next code, we want this true,
4095 and doing it now facilitates the COW check. */
4096 (void)SvPOK_only(dstr);
4099 /* We're not already COW */
4100 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4101 #ifndef PERL_OLD_COPY_ON_WRITE
4102 /* or we are, but dstr isn't a suitable target. */
4103 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4108 (sflags & SVs_TEMP) && /* slated for free anyway? */
4109 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4110 (!(flags & SV_NOSTEAL)) &&
4111 /* and we're allowed to steal temps */
4112 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4113 SvLEN(sstr) && /* and really is a string */
4114 /* and won't be needed again, potentially */
4115 !(PL_op && PL_op->op_type == OP_AASSIGN))
4116 #ifdef PERL_OLD_COPY_ON_WRITE
4117 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4118 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4119 && SvTYPE(sstr) >= SVt_PVIV)
4122 /* Failed the swipe test, and it's not a shared hash key either.
4123 Have to copy the string. */
4124 STRLEN len = SvCUR(sstr);
4125 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4126 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4127 SvCUR_set(dstr, len);
4128 *SvEND(dstr) = '\0';
4130 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4132 /* Either it's a shared hash key, or it's suitable for
4133 copy-on-write or we can swipe the string. */
4135 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4139 #ifdef PERL_OLD_COPY_ON_WRITE
4141 /* I believe I should acquire a global SV mutex if
4142 it's a COW sv (not a shared hash key) to stop
4143 it going un copy-on-write.
4144 If the source SV has gone un copy on write between up there
4145 and down here, then (assert() that) it is of the correct
4146 form to make it copy on write again */
4147 if ((sflags & (SVf_FAKE | SVf_READONLY))
4148 != (SVf_FAKE | SVf_READONLY)) {
4149 SvREADONLY_on(sstr);
4151 /* Make the source SV into a loop of 1.
4152 (about to become 2) */
4153 SV_COW_NEXT_SV_SET(sstr, sstr);
4157 /* Initial code is common. */
4158 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4163 /* making another shared SV. */
4164 STRLEN cur = SvCUR(sstr);
4165 STRLEN len = SvLEN(sstr);
4166 #ifdef PERL_OLD_COPY_ON_WRITE
4168 assert (SvTYPE(dstr) >= SVt_PVIV);
4169 /* SvIsCOW_normal */
4170 /* splice us in between source and next-after-source. */
4171 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4172 SV_COW_NEXT_SV_SET(sstr, dstr);
4173 SvPV_set(dstr, SvPVX_mutable(sstr));
4177 /* SvIsCOW_shared_hash */
4178 DEBUG_C(PerlIO_printf(Perl_debug_log,
4179 "Copy on write: Sharing hash\n"));
4181 assert (SvTYPE(dstr) >= SVt_PV);
4183 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4185 SvLEN_set(dstr, len);
4186 SvCUR_set(dstr, cur);
4187 SvREADONLY_on(dstr);
4189 /* Relesase a global SV mutex. */
4192 { /* Passes the swipe test. */
4193 SvPV_set(dstr, SvPVX_mutable(sstr));
4194 SvLEN_set(dstr, SvLEN(sstr));
4195 SvCUR_set(dstr, SvCUR(sstr));
4198 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4199 SvPV_set(sstr, Nullch);
4205 if (sflags & SVf_UTF8)
4207 if (sflags & SVp_NOK) {
4209 if (sflags & SVf_NOK)
4210 SvFLAGS(dstr) |= SVf_NOK;
4211 SvNV_set(dstr, SvNVX(sstr));
4213 if (sflags & SVp_IOK) {
4214 (void)SvIOKp_on(dstr);
4215 if (sflags & SVf_IOK)
4216 SvFLAGS(dstr) |= SVf_IOK;
4217 if (sflags & SVf_IVisUV)
4219 SvIV_set(dstr, SvIVX(sstr));
4222 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4223 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4224 smg->mg_ptr, smg->mg_len);
4225 SvRMAGICAL_on(dstr);
4228 else if (sflags & SVp_IOK) {
4229 if (sflags & SVf_IOK)
4230 (void)SvIOK_only(dstr);
4232 (void)SvOK_off(dstr);
4233 (void)SvIOKp_on(dstr);
4235 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4236 if (sflags & SVf_IVisUV)
4238 SvIV_set(dstr, SvIVX(sstr));
4239 if (sflags & SVp_NOK) {
4240 if (sflags & SVf_NOK)
4241 (void)SvNOK_on(dstr);
4243 (void)SvNOKp_on(dstr);
4244 SvNV_set(dstr, SvNVX(sstr));
4247 else if (sflags & SVp_NOK) {
4248 if (sflags & SVf_NOK)
4249 (void)SvNOK_only(dstr);
4251 (void)SvOK_off(dstr);
4254 SvNV_set(dstr, SvNVX(sstr));
4257 if (dtype == SVt_PVGV) {
4258 if (ckWARN(WARN_MISC))
4259 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4262 (void)SvOK_off(dstr);
4264 if (SvTAINTED(sstr))
4269 =for apidoc sv_setsv_mg
4271 Like C<sv_setsv>, but also handles 'set' magic.
4277 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4279 sv_setsv(dstr,sstr);
4283 #ifdef PERL_OLD_COPY_ON_WRITE
4285 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4287 STRLEN cur = SvCUR(sstr);
4288 STRLEN len = SvLEN(sstr);
4289 register char *new_pv;
4292 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4300 if (SvTHINKFIRST(dstr))
4301 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4302 else if (SvPVX_const(dstr))
4303 Safefree(SvPVX_const(dstr));
4307 SvUPGRADE(dstr, SVt_PVIV);
4309 assert (SvPOK(sstr));
4310 assert (SvPOKp(sstr));
4311 assert (!SvIOK(sstr));
4312 assert (!SvIOKp(sstr));
4313 assert (!SvNOK(sstr));
4314 assert (!SvNOKp(sstr));
4316 if (SvIsCOW(sstr)) {
4318 if (SvLEN(sstr) == 0) {
4319 /* source is a COW shared hash key. */
4320 DEBUG_C(PerlIO_printf(Perl_debug_log,
4321 "Fast copy on write: Sharing hash\n"));
4322 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4325 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4327 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4328 SvUPGRADE(sstr, SVt_PVIV);
4329 SvREADONLY_on(sstr);
4331 DEBUG_C(PerlIO_printf(Perl_debug_log,
4332 "Fast copy on write: Converting sstr to COW\n"));
4333 SV_COW_NEXT_SV_SET(dstr, sstr);
4335 SV_COW_NEXT_SV_SET(sstr, dstr);
4336 new_pv = SvPVX_mutable(sstr);
4339 SvPV_set(dstr, new_pv);
4340 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4343 SvLEN_set(dstr, len);
4344 SvCUR_set(dstr, cur);
4353 =for apidoc sv_setpvn
4355 Copies a string into an SV. The C<len> parameter indicates the number of
4356 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4357 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4363 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4365 register char *dptr;
4367 SV_CHECK_THINKFIRST_COW_DROP(sv);
4373 /* len is STRLEN which is unsigned, need to copy to signed */
4376 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4378 SvUPGRADE(sv, SVt_PV);
4380 dptr = SvGROW(sv, len + 1);
4381 Move(ptr,dptr,len,char);
4384 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4389 =for apidoc sv_setpvn_mg
4391 Like C<sv_setpvn>, but also handles 'set' magic.
4397 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4399 sv_setpvn(sv,ptr,len);
4404 =for apidoc sv_setpv
4406 Copies a string into an SV. The string must be null-terminated. Does not
4407 handle 'set' magic. See C<sv_setpv_mg>.
4413 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4415 register STRLEN len;
4417 SV_CHECK_THINKFIRST_COW_DROP(sv);
4423 SvUPGRADE(sv, SVt_PV);
4425 SvGROW(sv, len + 1);
4426 Move(ptr,SvPVX(sv),len+1,char);
4428 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4433 =for apidoc sv_setpv_mg
4435 Like C<sv_setpv>, but also handles 'set' magic.
4441 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4448 =for apidoc sv_usepvn
4450 Tells an SV to use C<ptr> to find its string value. Normally the string is
4451 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4452 The C<ptr> should point to memory that was allocated by C<malloc>. The
4453 string length, C<len>, must be supplied. This function will realloc the
4454 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4455 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4456 See C<sv_usepvn_mg>.
4462 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4465 SV_CHECK_THINKFIRST_COW_DROP(sv);
4466 SvUPGRADE(sv, SVt_PV);
4471 if (SvPVX_const(sv))
4474 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4475 ptr = saferealloc (ptr, allocate);
4478 SvLEN_set(sv, allocate);
4480 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4485 =for apidoc sv_usepvn_mg
4487 Like C<sv_usepvn>, but also handles 'set' magic.
4493 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4495 sv_usepvn(sv,ptr,len);
4499 #ifdef PERL_OLD_COPY_ON_WRITE
4500 /* Need to do this *after* making the SV normal, as we need the buffer
4501 pointer to remain valid until after we've copied it. If we let go too early,
4502 another thread could invalidate it by unsharing last of the same hash key
4503 (which it can do by means other than releasing copy-on-write Svs)
4504 or by changing the other copy-on-write SVs in the loop. */
4506 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4508 if (len) { /* this SV was SvIsCOW_normal(sv) */
4509 /* we need to find the SV pointing to us. */
4510 SV *current = SV_COW_NEXT_SV(after);
4512 if (current == sv) {
4513 /* The SV we point to points back to us (there were only two of us
4515 Hence other SV is no longer copy on write either. */
4517 SvREADONLY_off(after);
4519 /* We need to follow the pointers around the loop. */
4521 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4524 /* don't loop forever if the structure is bust, and we have
4525 a pointer into a closed loop. */
4526 assert (current != after);
4527 assert (SvPVX_const(current) == pvx);
4529 /* Make the SV before us point to the SV after us. */
4530 SV_COW_NEXT_SV_SET(current, after);
4533 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4538 Perl_sv_release_IVX(pTHX_ register SV *sv)
4541 sv_force_normal_flags(sv, 0);
4547 =for apidoc sv_force_normal_flags
4549 Undo various types of fakery on an SV: if the PV is a shared string, make
4550 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4551 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4552 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4553 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4554 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4555 set to some other value.) In addition, the C<flags> parameter gets passed to
4556 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4557 with flags set to 0.
4563 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4565 #ifdef PERL_OLD_COPY_ON_WRITE
4566 if (SvREADONLY(sv)) {
4567 /* At this point I believe I should acquire a global SV mutex. */
4569 const char * const pvx = SvPVX_const(sv);
4570 const STRLEN len = SvLEN(sv);
4571 const STRLEN cur = SvCUR(sv);
4572 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4574 PerlIO_printf(Perl_debug_log,
4575 "Copy on write: Force normal %ld\n",
4581 /* This SV doesn't own the buffer, so need to New() a new one: */
4582 SvPV_set(sv, (char*)0);
4584 if (flags & SV_COW_DROP_PV) {
4585 /* OK, so we don't need to copy our buffer. */
4588 SvGROW(sv, cur + 1);
4589 Move(pvx,SvPVX(sv),cur,char);
4593 sv_release_COW(sv, pvx, len, next);
4598 else if (IN_PERL_RUNTIME)
4599 Perl_croak(aTHX_ PL_no_modify);
4600 /* At this point I believe that I can drop the global SV mutex. */
4603 if (SvREADONLY(sv)) {
4605 const char * const pvx = SvPVX_const(sv);
4606 const STRLEN len = SvCUR(sv);
4609 SvPV_set(sv, Nullch);
4611 SvGROW(sv, len + 1);
4612 Move(pvx,SvPVX_const(sv),len,char);
4614 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4616 else if (IN_PERL_RUNTIME)
4617 Perl_croak(aTHX_ PL_no_modify);
4621 sv_unref_flags(sv, flags);
4622 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4627 =for apidoc sv_force_normal
4629 Undo various types of fakery on an SV: if the PV is a shared string, make
4630 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4631 an xpvmg. See also C<sv_force_normal_flags>.
4637 Perl_sv_force_normal(pTHX_ register SV *sv)
4639 sv_force_normal_flags(sv, 0);
4645 Efficient removal of characters from the beginning of the string buffer.
4646 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4647 the string buffer. The C<ptr> becomes the first character of the adjusted
4648 string. Uses the "OOK hack".
4649 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4650 refer to the same chunk of data.
4656 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4658 register STRLEN delta;
4659 if (!ptr || !SvPOKp(sv))
4661 delta = ptr - SvPVX_const(sv);
4662 SV_CHECK_THINKFIRST(sv);
4663 if (SvTYPE(sv) < SVt_PVIV)
4664 sv_upgrade(sv,SVt_PVIV);
4667 if (!SvLEN(sv)) { /* make copy of shared string */
4668 const char *pvx = SvPVX_const(sv);
4669 const STRLEN len = SvCUR(sv);
4670 SvGROW(sv, len + 1);
4671 Move(pvx,SvPVX_const(sv),len,char);
4675 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4676 and we do that anyway inside the SvNIOK_off
4678 SvFLAGS(sv) |= SVf_OOK;
4681 SvLEN_set(sv, SvLEN(sv) - delta);
4682 SvCUR_set(sv, SvCUR(sv) - delta);
4683 SvPV_set(sv, SvPVX(sv) + delta);
4684 SvIV_set(sv, SvIVX(sv) + delta);
4687 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4688 * this function provided for binary compatibility only
4692 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4694 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4698 =for apidoc sv_catpvn
4700 Concatenates the string onto the end of the string which is in the SV. The
4701 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4702 status set, then the bytes appended should be valid UTF-8.
4703 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4705 =for apidoc sv_catpvn_flags
4707 Concatenates the string onto the end of the string which is in the SV. The
4708 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4709 status set, then the bytes appended should be valid UTF-8.
4710 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4711 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4712 in terms of this function.
4718 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4721 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4723 SvGROW(dsv, dlen + slen + 1);
4725 sstr = SvPVX_const(dsv);
4726 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4727 SvCUR_set(dsv, SvCUR(dsv) + slen);
4729 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4734 =for apidoc sv_catpvn_mg
4736 Like C<sv_catpvn>, but also handles 'set' magic.
4742 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4744 sv_catpvn(sv,ptr,len);
4748 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4749 * this function provided for binary compatibility only
4753 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4755 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4759 =for apidoc sv_catsv
4761 Concatenates the string from SV C<ssv> onto the end of the string in
4762 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4763 not 'set' magic. See C<sv_catsv_mg>.
4765 =for apidoc sv_catsv_flags
4767 Concatenates the string from SV C<ssv> onto the end of the string in
4768 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4769 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4770 and C<sv_catsv_nomg> are implemented in terms of this function.
4775 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4781 if ((spv = SvPV_const(ssv, slen))) {
4782 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4783 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4784 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4785 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4786 dsv->sv_flags doesn't have that bit set.
4787 Andy Dougherty 12 Oct 2001
4789 const I32 sutf8 = DO_UTF8(ssv);
4792 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4794 dutf8 = DO_UTF8(dsv);
4796 if (dutf8 != sutf8) {
4798 /* Not modifying source SV, so taking a temporary copy. */
4799 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4801 sv_utf8_upgrade(csv);
4802 spv = SvPV_const(csv, slen);
4805 sv_utf8_upgrade_nomg(dsv);
4807 sv_catpvn_nomg(dsv, spv, slen);
4812 =for apidoc sv_catsv_mg
4814 Like C<sv_catsv>, but also handles 'set' magic.
4820 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4827 =for apidoc sv_catpv
4829 Concatenates the string onto the end of the string which is in the SV.
4830 If the SV has the UTF-8 status set, then the bytes appended should be
4831 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4836 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4838 register STRLEN len;
4844 junk = SvPV_force(sv, tlen);
4846 SvGROW(sv, tlen + len + 1);
4848 ptr = SvPVX_const(sv);
4849 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4850 SvCUR_set(sv, SvCUR(sv) + len);
4851 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4856 =for apidoc sv_catpv_mg
4858 Like C<sv_catpv>, but also handles 'set' magic.
4864 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4873 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4874 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4881 Perl_newSV(pTHX_ STRLEN len)
4887 sv_upgrade(sv, SVt_PV);
4888 SvGROW(sv, len + 1);
4893 =for apidoc sv_magicext
4895 Adds magic to an SV, upgrading it if necessary. Applies the
4896 supplied vtable and returns a pointer to the magic added.
4898 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4899 In particular, you can add magic to SvREADONLY SVs, and add more than
4900 one instance of the same 'how'.
4902 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4903 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4904 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4905 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4907 (This is now used as a subroutine by C<sv_magic>.)
4912 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4913 const char* name, I32 namlen)
4917 if (SvTYPE(sv) < SVt_PVMG) {
4918 SvUPGRADE(sv, SVt_PVMG);
4920 Newxz(mg, 1, MAGIC);
4921 mg->mg_moremagic = SvMAGIC(sv);
4922 SvMAGIC_set(sv, mg);
4924 /* Sometimes a magic contains a reference loop, where the sv and
4925 object refer to each other. To prevent a reference loop that
4926 would prevent such objects being freed, we look for such loops
4927 and if we find one we avoid incrementing the object refcount.
4929 Note we cannot do this to avoid self-tie loops as intervening RV must
4930 have its REFCNT incremented to keep it in existence.
4933 if (!obj || obj == sv ||
4934 how == PERL_MAGIC_arylen ||
4935 how == PERL_MAGIC_qr ||
4936 how == PERL_MAGIC_symtab ||
4937 (SvTYPE(obj) == SVt_PVGV &&
4938 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4939 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4940 GvFORM(obj) == (CV*)sv)))
4945 mg->mg_obj = SvREFCNT_inc(obj);
4946 mg->mg_flags |= MGf_REFCOUNTED;
4949 /* Normal self-ties simply pass a null object, and instead of
4950 using mg_obj directly, use the SvTIED_obj macro to produce a
4951 new RV as needed. For glob "self-ties", we are tieing the PVIO
4952 with an RV obj pointing to the glob containing the PVIO. In
4953 this case, to avoid a reference loop, we need to weaken the
4957 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4958 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4964 mg->mg_len = namlen;
4967 mg->mg_ptr = savepvn(name, namlen);
4968 else if (namlen == HEf_SVKEY)
4969 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4971 mg->mg_ptr = (char *) name;
4973 mg->mg_virtual = vtable;
4977 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4982 =for apidoc sv_magic
4984 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4985 then adds a new magic item of type C<how> to the head of the magic list.
4987 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4988 handling of the C<name> and C<namlen> arguments.
4990 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4991 to add more than one instance of the same 'how'.
4997 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4999 const MGVTBL *vtable = 0;
5002 #ifdef PERL_OLD_COPY_ON_WRITE
5004 sv_force_normal_flags(sv, 0);
5006 if (SvREADONLY(sv)) {
5008 /* its okay to attach magic to shared strings; the subsequent
5009 * upgrade to PVMG will unshare the string */
5010 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5013 && how != PERL_MAGIC_regex_global
5014 && how != PERL_MAGIC_bm
5015 && how != PERL_MAGIC_fm
5016 && how != PERL_MAGIC_sv
5017 && how != PERL_MAGIC_backref
5020 Perl_croak(aTHX_ PL_no_modify);
5023 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5024 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5025 /* sv_magic() refuses to add a magic of the same 'how' as an
5028 if (how == PERL_MAGIC_taint)
5036 vtable = &PL_vtbl_sv;
5038 case PERL_MAGIC_overload:
5039 vtable = &PL_vtbl_amagic;
5041 case PERL_MAGIC_overload_elem:
5042 vtable = &PL_vtbl_amagicelem;
5044 case PERL_MAGIC_overload_table:
5045 vtable = &PL_vtbl_ovrld;
5048 vtable = &PL_vtbl_bm;
5050 case PERL_MAGIC_regdata:
5051 vtable = &PL_vtbl_regdata;
5053 case PERL_MAGIC_regdatum:
5054 vtable = &PL_vtbl_regdatum;
5056 case PERL_MAGIC_env:
5057 vtable = &PL_vtbl_env;
5060 vtable = &PL_vtbl_fm;
5062 case PERL_MAGIC_envelem:
5063 vtable = &PL_vtbl_envelem;
5065 case PERL_MAGIC_regex_global:
5066 vtable = &PL_vtbl_mglob;
5068 case PERL_MAGIC_isa:
5069 vtable = &PL_vtbl_isa;
5071 case PERL_MAGIC_isaelem:
5072 vtable = &PL_vtbl_isaelem;
5074 case PERL_MAGIC_nkeys:
5075 vtable = &PL_vtbl_nkeys;
5077 case PERL_MAGIC_dbfile:
5080 case PERL_MAGIC_dbline:
5081 vtable = &PL_vtbl_dbline;
5083 #ifdef USE_LOCALE_COLLATE
5084 case PERL_MAGIC_collxfrm:
5085 vtable = &PL_vtbl_collxfrm;
5087 #endif /* USE_LOCALE_COLLATE */
5088 case PERL_MAGIC_tied:
5089 vtable = &PL_vtbl_pack;
5091 case PERL_MAGIC_tiedelem:
5092 case PERL_MAGIC_tiedscalar:
5093 vtable = &PL_vtbl_packelem;
5096 vtable = &PL_vtbl_regexp;
5098 case PERL_MAGIC_sig:
5099 vtable = &PL_vtbl_sig;
5101 case PERL_MAGIC_sigelem:
5102 vtable = &PL_vtbl_sigelem;
5104 case PERL_MAGIC_taint:
5105 vtable = &PL_vtbl_taint;
5107 case PERL_MAGIC_uvar:
5108 vtable = &PL_vtbl_uvar;
5110 case PERL_MAGIC_vec:
5111 vtable = &PL_vtbl_vec;
5113 case PERL_MAGIC_arylen_p:
5114 case PERL_MAGIC_rhash:
5115 case PERL_MAGIC_symtab:
5116 case PERL_MAGIC_vstring:
5119 case PERL_MAGIC_utf8:
5120 vtable = &PL_vtbl_utf8;
5122 case PERL_MAGIC_substr:
5123 vtable = &PL_vtbl_substr;
5125 case PERL_MAGIC_defelem:
5126 vtable = &PL_vtbl_defelem;
5128 case PERL_MAGIC_glob:
5129 vtable = &PL_vtbl_glob;
5131 case PERL_MAGIC_arylen:
5132 vtable = &PL_vtbl_arylen;
5134 case PERL_MAGIC_pos:
5135 vtable = &PL_vtbl_pos;
5137 case PERL_MAGIC_backref:
5138 vtable = &PL_vtbl_backref;
5140 case PERL_MAGIC_ext:
5141 /* Reserved for use by extensions not perl internals. */
5142 /* Useful for attaching extension internal data to perl vars. */
5143 /* Note that multiple extensions may clash if magical scalars */
5144 /* etc holding private data from one are passed to another. */
5147 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5150 /* Rest of work is done else where */
5151 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5154 case PERL_MAGIC_taint:
5157 case PERL_MAGIC_ext:
5158 case PERL_MAGIC_dbfile:
5165 =for apidoc sv_unmagic
5167 Removes all magic of type C<type> from an SV.
5173 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5177 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5180 for (mg = *mgp; mg; mg = *mgp) {
5181 if (mg->mg_type == type) {
5182 const MGVTBL* const vtbl = mg->mg_virtual;
5183 *mgp = mg->mg_moremagic;
5184 if (vtbl && vtbl->svt_free)
5185 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5186 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5188 Safefree(mg->mg_ptr);
5189 else if (mg->mg_len == HEf_SVKEY)
5190 SvREFCNT_dec((SV*)mg->mg_ptr);
5191 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5192 Safefree(mg->mg_ptr);
5194 if (mg->mg_flags & MGf_REFCOUNTED)
5195 SvREFCNT_dec(mg->mg_obj);
5199 mgp = &mg->mg_moremagic;
5203 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5210 =for apidoc sv_rvweaken
5212 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5213 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5214 push a back-reference to this RV onto the array of backreferences
5215 associated with that magic.
5221 Perl_sv_rvweaken(pTHX_ SV *sv)
5224 if (!SvOK(sv)) /* let undefs pass */
5227 Perl_croak(aTHX_ "Can't weaken a nonreference");
5228 else if (SvWEAKREF(sv)) {
5229 if (ckWARN(WARN_MISC))
5230 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5234 Perl_sv_add_backref(aTHX_ tsv, sv);
5240 /* Give tsv backref magic if it hasn't already got it, then push a
5241 * back-reference to sv onto the array associated with the backref magic.
5245 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5249 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5250 av = (AV*)mg->mg_obj;
5253 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5254 /* av now has a refcnt of 2, which avoids it getting freed
5255 * before us during global cleanup. The extra ref is removed
5256 * by magic_killbackrefs() when tsv is being freed */
5258 if (AvFILLp(av) >= AvMAX(av)) {
5259 av_extend(av, AvFILLp(av)+1);
5261 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5264 /* delete a back-reference to ourselves from the backref magic associated
5265 * with the SV we point to.
5269 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5275 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5276 if (PL_in_clean_all)
5279 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5280 Perl_croak(aTHX_ "panic: del_backref");
5281 av = (AV *)mg->mg_obj;
5283 /* We shouldn't be in here more than once, but for paranoia reasons lets
5285 for (i = AvFILLp(av); i >= 0; i--) {
5287 const SSize_t fill = AvFILLp(av);
5289 /* We weren't the last entry.
5290 An unordered list has this property that you can take the
5291 last element off the end to fill the hole, and it's still
5292 an unordered list :-)
5297 AvFILLp(av) = fill - 1;
5303 =for apidoc sv_insert
5305 Inserts a string at the specified offset/length within the SV. Similar to
5306 the Perl substr() function.
5312 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5316 register char *midend;
5317 register char *bigend;
5323 Perl_croak(aTHX_ "Can't modify non-existent substring");
5324 SvPV_force(bigstr, curlen);
5325 (void)SvPOK_only_UTF8(bigstr);
5326 if (offset + len > curlen) {
5327 SvGROW(bigstr, offset+len+1);
5328 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5329 SvCUR_set(bigstr, offset+len);
5333 i = littlelen - len;
5334 if (i > 0) { /* string might grow */
5335 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5336 mid = big + offset + len;
5337 midend = bigend = big + SvCUR(bigstr);
5340 while (midend > mid) /* shove everything down */
5341 *--bigend = *--midend;
5342 Move(little,big+offset,littlelen,char);
5343 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5348 Move(little,SvPVX(bigstr)+offset,len,char);
5353 big = SvPVX(bigstr);
5356 bigend = big + SvCUR(bigstr);
5358 if (midend > bigend)
5359 Perl_croak(aTHX_ "panic: sv_insert");
5361 if (mid - big > bigend - midend) { /* faster to shorten from end */
5363 Move(little, mid, littlelen,char);
5366 i = bigend - midend;
5368 Move(midend, mid, i,char);
5372 SvCUR_set(bigstr, mid - big);
5374 else if ((i = mid - big)) { /* faster from front */
5375 midend -= littlelen;
5377 sv_chop(bigstr,midend-i);
5382 Move(little, mid, littlelen,char);
5384 else if (littlelen) {
5385 midend -= littlelen;
5386 sv_chop(bigstr,midend);
5387 Move(little,midend,littlelen,char);
5390 sv_chop(bigstr,midend);
5396 =for apidoc sv_replace
5398 Make the first argument a copy of the second, then delete the original.
5399 The target SV physically takes over ownership of the body of the source SV
5400 and inherits its flags; however, the target keeps any magic it owns,
5401 and any magic in the source is discarded.
5402 Note that this is a rather specialist SV copying operation; most of the
5403 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5409 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5411 const U32 refcnt = SvREFCNT(sv);
5412 SV_CHECK_THINKFIRST_COW_DROP(sv);
5413 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5414 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5415 if (SvMAGICAL(sv)) {
5419 sv_upgrade(nsv, SVt_PVMG);
5420 SvMAGIC_set(nsv, SvMAGIC(sv));
5421 SvFLAGS(nsv) |= SvMAGICAL(sv);
5423 SvMAGIC_set(sv, NULL);
5427 assert(!SvREFCNT(sv));
5428 #ifdef DEBUG_LEAKING_SCALARS
5429 sv->sv_flags = nsv->sv_flags;
5430 sv->sv_any = nsv->sv_any;
5431 sv->sv_refcnt = nsv->sv_refcnt;
5432 sv->sv_u = nsv->sv_u;
5434 StructCopy(nsv,sv,SV);
5436 /* Currently could join these into one piece of pointer arithmetic, but
5437 it would be unclear. */
5438 if(SvTYPE(sv) == SVt_IV)
5440 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5441 else if (SvTYPE(sv) == SVt_RV) {
5442 SvANY(sv) = &sv->sv_u.svu_rv;
5446 #ifdef PERL_OLD_COPY_ON_WRITE
5447 if (SvIsCOW_normal(nsv)) {
5448 /* We need to follow the pointers around the loop to make the
5449 previous SV point to sv, rather than nsv. */
5452 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5455 assert(SvPVX_const(current) == SvPVX_const(nsv));
5457 /* Make the SV before us point to the SV after us. */
5459 PerlIO_printf(Perl_debug_log, "previous is\n");
5461 PerlIO_printf(Perl_debug_log,
5462 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5463 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5465 SV_COW_NEXT_SV_SET(current, sv);
5468 SvREFCNT(sv) = refcnt;
5469 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5475 =for apidoc sv_clear
5477 Clear an SV: call any destructors, free up any memory used by the body,
5478 and free the body itself. The SV's head is I<not> freed, although
5479 its type is set to all 1's so that it won't inadvertently be assumed
5480 to be live during global destruction etc.
5481 This function should only be called when REFCNT is zero. Most of the time
5482 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5489 Perl_sv_clear(pTHX_ register SV *sv)
5492 void** old_body_arena;
5493 size_t old_body_offset;
5494 const U32 type = SvTYPE(sv);
5497 assert(SvREFCNT(sv) == 0);
5503 old_body_offset = 0;
5506 if (PL_defstash) { /* Still have a symbol table? */
5511 stash = SvSTASH(sv);
5512 destructor = StashHANDLER(stash,DESTROY);
5514 SV* const tmpref = newRV(sv);
5515 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5517 PUSHSTACKi(PERLSI_DESTROY);
5522 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5528 if(SvREFCNT(tmpref) < 2) {
5529 /* tmpref is not kept alive! */
5531 SvRV_set(tmpref, NULL);
5534 SvREFCNT_dec(tmpref);
5536 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5540 if (PL_in_clean_objs)
5541 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5543 /* DESTROY gave object new lease on life */
5549 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5550 SvOBJECT_off(sv); /* Curse the object. */
5551 if (type != SVt_PVIO)
5552 --PL_sv_objcount; /* XXX Might want something more general */
5555 if (type >= SVt_PVMG) {
5558 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5559 SvREFCNT_dec(SvSTASH(sv));
5564 IoIFP(sv) != PerlIO_stdin() &&
5565 IoIFP(sv) != PerlIO_stdout() &&
5566 IoIFP(sv) != PerlIO_stderr())
5568 io_close((IO*)sv, FALSE);
5570 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5571 PerlDir_close(IoDIRP(sv));
5572 IoDIRP(sv) = (DIR*)NULL;
5573 Safefree(IoTOP_NAME(sv));
5574 Safefree(IoFMT_NAME(sv));
5575 Safefree(IoBOTTOM_NAME(sv));
5576 /* PVIOs aren't from arenas */
5579 old_body_arena = (void **) &PL_xpvbm_root;
5582 old_body_arena = (void **) &PL_xpvcv_root;
5584 /* PVFMs aren't from arenas */
5589 old_body_arena = (void **) &PL_xpvhv_root;
5590 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5594 old_body_arena = (void **) &PL_xpvav_root;
5595 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5598 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5599 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5600 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5601 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5603 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5604 SvREFCNT_dec(LvTARG(sv));
5605 old_body_arena = (void **) &PL_xpvlv_root;
5609 Safefree(GvNAME(sv));
5610 /* If we're in a stash, we don't own a reference to it. However it does
5611 have a back reference to us, which needs to be cleared. */
5613 sv_del_backref((SV*)GvSTASH(sv), sv);
5614 old_body_arena = (void **) &PL_xpvgv_root;
5617 old_body_arena = (void **) &PL_xpvmg_root;
5620 old_body_arena = (void **) &PL_xpvnv_root;
5623 old_body_arena = (void **) &PL_xpviv_root;
5624 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5626 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5628 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5629 /* Don't even bother with turning off the OOK flag. */
5633 old_body_arena = (void **) &PL_xpv_root;
5634 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5638 SV *target = SvRV(sv);
5640 sv_del_backref(target, sv);
5642 SvREFCNT_dec(target);
5644 #ifdef PERL_OLD_COPY_ON_WRITE
5645 else if (SvPVX_const(sv)) {
5647 /* I believe I need to grab the global SV mutex here and
5648 then recheck the COW status. */
5650 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5653 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5654 SV_COW_NEXT_SV(sv));
5655 /* And drop it here. */
5657 } else if (SvLEN(sv)) {
5658 Safefree(SvPVX_const(sv));
5662 else if (SvPVX_const(sv) && SvLEN(sv))
5663 Safefree(SvPVX_mutable(sv));
5664 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5665 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5671 old_body_arena = (void **) &PL_xnv_root;
5675 SvFLAGS(sv) &= SVf_BREAK;
5676 SvFLAGS(sv) |= SVTYPEMASK;
5679 if (old_body_arena) {
5680 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5684 if (type > SVt_RV) {
5685 my_safefree(SvANY(sv));
5690 =for apidoc sv_newref
5692 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5699 Perl_sv_newref(pTHX_ SV *sv)
5709 Decrement an SV's reference count, and if it drops to zero, call
5710 C<sv_clear> to invoke destructors and free up any memory used by
5711 the body; finally, deallocate the SV's head itself.
5712 Normally called via a wrapper macro C<SvREFCNT_dec>.
5718 Perl_sv_free(pTHX_ SV *sv)
5723 if (SvREFCNT(sv) == 0) {
5724 if (SvFLAGS(sv) & SVf_BREAK)
5725 /* this SV's refcnt has been artificially decremented to
5726 * trigger cleanup */
5728 if (PL_in_clean_all) /* All is fair */
5730 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5731 /* make sure SvREFCNT(sv)==0 happens very seldom */
5732 SvREFCNT(sv) = (~(U32)0)/2;
5735 if (ckWARN_d(WARN_INTERNAL)) {
5736 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5737 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5738 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5739 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5740 Perl_dump_sv_child(aTHX_ sv);
5745 if (--(SvREFCNT(sv)) > 0)
5747 Perl_sv_free2(aTHX_ sv);
5751 Perl_sv_free2(pTHX_ SV *sv)
5756 if (ckWARN_d(WARN_DEBUGGING))
5757 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5758 "Attempt to free temp prematurely: SV 0x%"UVxf
5759 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5763 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5764 /* make sure SvREFCNT(sv)==0 happens very seldom */
5765 SvREFCNT(sv) = (~(U32)0)/2;
5776 Returns the length of the string in the SV. Handles magic and type
5777 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5783 Perl_sv_len(pTHX_ register SV *sv)
5791 len = mg_length(sv);
5793 (void)SvPV_const(sv, len);
5798 =for apidoc sv_len_utf8
5800 Returns the number of characters in the string in an SV, counting wide
5801 UTF-8 bytes as a single character. Handles magic and type coercion.
5807 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5808 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5809 * (Note that the mg_len is not the length of the mg_ptr field.)
5814 Perl_sv_len_utf8(pTHX_ register SV *sv)
5820 return mg_length(sv);
5824 const U8 *s = (U8*)SvPV_const(sv, len);
5825 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5827 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5829 #ifdef PERL_UTF8_CACHE_ASSERT
5830 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5834 ulen = Perl_utf8_length(aTHX_ s, s + len);
5835 if (!mg && !SvREADONLY(sv)) {
5836 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5837 mg = mg_find(sv, PERL_MAGIC_utf8);
5847 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5848 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5849 * between UTF-8 and byte offsets. There are two (substr offset and substr
5850 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5851 * and byte offset) cache positions.
5853 * The mg_len field is used by sv_len_utf8(), see its comments.
5854 * Note that the mg_len is not the length of the mg_ptr field.
5858 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5859 I32 offsetp, const U8 *s, const U8 *start)
5863 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5865 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5869 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5871 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5872 (*mgp)->mg_ptr = (char *) *cachep;
5876 (*cachep)[i] = offsetp;
5877 (*cachep)[i+1] = s - start;
5885 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5886 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5887 * between UTF-8 and byte offsets. See also the comments of
5888 * S_utf8_mg_pos_init().
5892 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)
5896 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5898 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5899 if (*mgp && (*mgp)->mg_ptr) {
5900 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5901 ASSERT_UTF8_CACHE(*cachep);
5902 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5904 else { /* We will skip to the right spot. */
5909 /* The assumption is that going backward is half
5910 * the speed of going forward (that's where the
5911 * 2 * backw in the below comes from). (The real
5912 * figure of course depends on the UTF-8 data.) */
5914 if ((*cachep)[i] > (STRLEN)uoff) {
5916 backw = (*cachep)[i] - (STRLEN)uoff;
5918 if (forw < 2 * backw)
5921 p = start + (*cachep)[i+1];
5923 /* Try this only for the substr offset (i == 0),
5924 * not for the substr length (i == 2). */
5925 else if (i == 0) { /* (*cachep)[i] < uoff */
5926 const STRLEN ulen = sv_len_utf8(sv);
5928 if ((STRLEN)uoff < ulen) {
5929 forw = (STRLEN)uoff - (*cachep)[i];
5930 backw = ulen - (STRLEN)uoff;
5932 if (forw < 2 * backw)
5933 p = start + (*cachep)[i+1];
5938 /* If the string is not long enough for uoff,
5939 * we could extend it, but not at this low a level. */
5943 if (forw < 2 * backw) {
5950 while (UTF8_IS_CONTINUATION(*p))
5955 /* Update the cache. */
5956 (*cachep)[i] = (STRLEN)uoff;
5957 (*cachep)[i+1] = p - start;
5959 /* Drop the stale "length" cache */
5968 if (found) { /* Setup the return values. */
5969 *offsetp = (*cachep)[i+1];
5970 *sp = start + *offsetp;
5973 *offsetp = send - start;
5975 else if (*sp < start) {
5981 #ifdef PERL_UTF8_CACHE_ASSERT
5986 while (n-- && s < send)
5990 assert(*offsetp == s - start);
5991 assert((*cachep)[0] == (STRLEN)uoff);
5992 assert((*cachep)[1] == *offsetp);
5994 ASSERT_UTF8_CACHE(*cachep);
6003 =for apidoc sv_pos_u2b
6005 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6006 the start of the string, to a count of the equivalent number of bytes; if
6007 lenp is non-zero, it does the same to lenp, but this time starting from
6008 the offset, rather than from the start of the string. Handles magic and
6015 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6016 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6017 * byte offsets. See also the comments of S_utf8_mg_pos().
6022 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6030 start = (U8*)SvPV_const(sv, len);
6034 const U8 *s = start;
6035 I32 uoffset = *offsetp;
6036 const U8 * const send = s + len;
6040 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6042 if (!found && uoffset > 0) {
6043 while (s < send && uoffset--)
6047 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6049 *offsetp = s - start;
6054 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6058 if (!found && *lenp > 0) {
6061 while (s < send && ulen--)
6065 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6069 ASSERT_UTF8_CACHE(cache);
6081 =for apidoc sv_pos_b2u
6083 Converts the value pointed to by offsetp from a count of bytes from the
6084 start of the string, to a count of the equivalent number of UTF-8 chars.
6085 Handles magic and type coercion.
6091 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6092 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6093 * byte offsets. See also the comments of S_utf8_mg_pos().
6098 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6106 s = (const U8*)SvPV_const(sv, len);
6107 if ((I32)len < *offsetp)
6108 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6110 const U8* send = s + *offsetp;
6112 STRLEN *cache = NULL;
6116 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6117 mg = mg_find(sv, PERL_MAGIC_utf8);
6118 if (mg && mg->mg_ptr) {
6119 cache = (STRLEN *) mg->mg_ptr;
6120 if (cache[1] == (STRLEN)*offsetp) {
6121 /* An exact match. */
6122 *offsetp = cache[0];
6126 else if (cache[1] < (STRLEN)*offsetp) {
6127 /* We already know part of the way. */
6130 /* Let the below loop do the rest. */
6132 else { /* cache[1] > *offsetp */
6133 /* We already know all of the way, now we may
6134 * be able to walk back. The same assumption
6135 * is made as in S_utf8_mg_pos(), namely that
6136 * walking backward is twice slower than
6137 * walking forward. */
6138 const STRLEN forw = *offsetp;
6139 STRLEN backw = cache[1] - *offsetp;
6141 if (!(forw < 2 * backw)) {
6142 const U8 *p = s + cache[1];
6149 while (UTF8_IS_CONTINUATION(*p)) {
6157 *offsetp = cache[0];
6159 /* Drop the stale "length" cache */
6167 ASSERT_UTF8_CACHE(cache);
6173 /* Call utf8n_to_uvchr() to validate the sequence
6174 * (unless a simple non-UTF character) */
6175 if (!UTF8_IS_INVARIANT(*s))
6176 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6185 if (!SvREADONLY(sv)) {
6187 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6188 mg = mg_find(sv, PERL_MAGIC_utf8);
6193 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6194 mg->mg_ptr = (char *) cache;
6199 cache[1] = *offsetp;
6200 /* Drop the stale "length" cache */
6213 Returns a boolean indicating whether the strings in the two SVs are
6214 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6215 coerce its args to strings if necessary.
6221 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6229 SV* svrecode = Nullsv;
6236 pv1 = SvPV_const(sv1, cur1);
6243 pv2 = SvPV_const(sv2, cur2);
6245 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6246 /* Differing utf8ness.
6247 * Do not UTF8size the comparands as a side-effect. */
6250 svrecode = newSVpvn(pv2, cur2);
6251 sv_recode_to_utf8(svrecode, PL_encoding);
6252 pv2 = SvPV_const(svrecode, cur2);
6255 svrecode = newSVpvn(pv1, cur1);
6256 sv_recode_to_utf8(svrecode, PL_encoding);
6257 pv1 = SvPV_const(svrecode, cur1);
6259 /* Now both are in UTF-8. */
6261 SvREFCNT_dec(svrecode);
6266 bool is_utf8 = TRUE;
6269 /* sv1 is the UTF-8 one,
6270 * if is equal it must be downgrade-able */
6271 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6277 /* sv2 is the UTF-8 one,
6278 * if is equal it must be downgrade-able */
6279 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6285 /* Downgrade not possible - cannot be eq */
6293 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6296 SvREFCNT_dec(svrecode);
6307 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6308 string in C<sv1> is less than, equal to, or greater than the string in
6309 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6310 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6316 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6319 const char *pv1, *pv2;
6322 SV *svrecode = Nullsv;
6329 pv1 = SvPV_const(sv1, cur1);
6336 pv2 = SvPV_const(sv2, cur2);
6338 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6339 /* Differing utf8ness.
6340 * Do not UTF8size the comparands as a side-effect. */
6343 svrecode = newSVpvn(pv2, cur2);
6344 sv_recode_to_utf8(svrecode, PL_encoding);
6345 pv2 = SvPV_const(svrecode, cur2);
6348 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6353 svrecode = newSVpvn(pv1, cur1);
6354 sv_recode_to_utf8(svrecode, PL_encoding);
6355 pv1 = SvPV_const(svrecode, cur1);
6358 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6364 cmp = cur2 ? -1 : 0;
6368 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6371 cmp = retval < 0 ? -1 : 1;
6372 } else if (cur1 == cur2) {
6375 cmp = cur1 < cur2 ? -1 : 1;
6380 SvREFCNT_dec(svrecode);
6389 =for apidoc sv_cmp_locale
6391 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6392 'use bytes' aware, handles get magic, and will coerce its args to strings
6393 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6399 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6401 #ifdef USE_LOCALE_COLLATE
6407 if (PL_collation_standard)
6411 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6413 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6415 if (!pv1 || !len1) {
6426 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6429 return retval < 0 ? -1 : 1;
6432 * When the result of collation is equality, that doesn't mean
6433 * that there are no differences -- some locales exclude some
6434 * characters from consideration. So to avoid false equalities,
6435 * we use the raw string as a tiebreaker.
6441 #endif /* USE_LOCALE_COLLATE */
6443 return sv_cmp(sv1, sv2);
6447 #ifdef USE_LOCALE_COLLATE
6450 =for apidoc sv_collxfrm
6452 Add Collate Transform magic to an SV if it doesn't already have it.
6454 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6455 scalar data of the variable, but transformed to such a format that a normal
6456 memory comparison can be used to compare the data according to the locale
6463 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6467 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6468 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6474 Safefree(mg->mg_ptr);
6475 s = SvPV_const(sv, len);
6476 if ((xf = mem_collxfrm(s, len, &xlen))) {
6477 if (SvREADONLY(sv)) {
6480 return xf + sizeof(PL_collation_ix);
6483 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6484 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6497 if (mg && mg->mg_ptr) {
6499 return mg->mg_ptr + sizeof(PL_collation_ix);
6507 #endif /* USE_LOCALE_COLLATE */
6512 Get a line from the filehandle and store it into the SV, optionally
6513 appending to the currently-stored string.
6519 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6523 register STDCHAR rslast;
6524 register STDCHAR *bp;
6530 if (SvTHINKFIRST(sv))
6531 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6532 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6534 However, perlbench says it's slower, because the existing swipe code
6535 is faster than copy on write.
6536 Swings and roundabouts. */
6537 SvUPGRADE(sv, SVt_PV);
6542 if (PerlIO_isutf8(fp)) {
6544 sv_utf8_upgrade_nomg(sv);
6545 sv_pos_u2b(sv,&append,0);
6547 } else if (SvUTF8(sv)) {
6548 SV * const tsv = NEWSV(0,0);
6549 sv_gets(tsv, fp, 0);
6550 sv_utf8_upgrade_nomg(tsv);
6551 SvCUR_set(sv,append);
6554 goto return_string_or_null;
6559 if (PerlIO_isutf8(fp))
6562 if (IN_PERL_COMPILETIME) {
6563 /* we always read code in line mode */
6567 else if (RsSNARF(PL_rs)) {
6568 /* If it is a regular disk file use size from stat() as estimate
6569 of amount we are going to read - may result in malloc-ing
6570 more memory than we realy need if layers bellow reduce
6571 size we read (e.g. CRLF or a gzip layer)
6574 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6575 const Off_t offset = PerlIO_tell(fp);
6576 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6577 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6583 else if (RsRECORD(PL_rs)) {
6587 /* Grab the size of the record we're getting */
6588 recsize = SvIV(SvRV(PL_rs));
6589 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6592 /* VMS wants read instead of fread, because fread doesn't respect */
6593 /* RMS record boundaries. This is not necessarily a good thing to be */
6594 /* doing, but we've got no other real choice - except avoid stdio
6595 as implementation - perhaps write a :vms layer ?
6597 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6599 bytesread = PerlIO_read(fp, buffer, recsize);
6603 SvCUR_set(sv, bytesread += append);
6604 buffer[bytesread] = '\0';
6605 goto return_string_or_null;
6607 else if (RsPARA(PL_rs)) {
6613 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6614 if (PerlIO_isutf8(fp)) {
6615 rsptr = SvPVutf8(PL_rs, rslen);
6618 if (SvUTF8(PL_rs)) {
6619 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6620 Perl_croak(aTHX_ "Wide character in $/");
6623 rsptr = SvPV_const(PL_rs, rslen);
6627 rslast = rslen ? rsptr[rslen - 1] : '\0';
6629 if (rspara) { /* have to do this both before and after */
6630 do { /* to make sure file boundaries work right */
6633 i = PerlIO_getc(fp);
6637 PerlIO_ungetc(fp,i);
6643 /* See if we know enough about I/O mechanism to cheat it ! */
6645 /* This used to be #ifdef test - it is made run-time test for ease
6646 of abstracting out stdio interface. One call should be cheap
6647 enough here - and may even be a macro allowing compile
6651 if (PerlIO_fast_gets(fp)) {
6654 * We're going to steal some values from the stdio struct
6655 * and put EVERYTHING in the innermost loop into registers.
6657 register STDCHAR *ptr;
6661 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6662 /* An ungetc()d char is handled separately from the regular
6663 * buffer, so we getc() it back out and stuff it in the buffer.
6665 i = PerlIO_getc(fp);
6666 if (i == EOF) return 0;
6667 *(--((*fp)->_ptr)) = (unsigned char) i;
6671 /* Here is some breathtakingly efficient cheating */
6673 cnt = PerlIO_get_cnt(fp); /* get count into register */
6674 /* make sure we have the room */
6675 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6676 /* Not room for all of it
6677 if we are looking for a separator and room for some
6679 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6680 /* just process what we have room for */
6681 shortbuffered = cnt - SvLEN(sv) + append + 1;
6682 cnt -= shortbuffered;
6686 /* remember that cnt can be negative */
6687 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6692 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6693 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6694 DEBUG_P(PerlIO_printf(Perl_debug_log,
6695 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6696 DEBUG_P(PerlIO_printf(Perl_debug_log,
6697 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6698 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6699 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6704 while (cnt > 0) { /* this | eat */
6706 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6707 goto thats_all_folks; /* screams | sed :-) */
6711 Copy(ptr, bp, cnt, char); /* this | eat */
6712 bp += cnt; /* screams | dust */
6713 ptr += cnt; /* louder | sed :-) */
6718 if (shortbuffered) { /* oh well, must extend */
6719 cnt = shortbuffered;
6721 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6723 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6724 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6728 DEBUG_P(PerlIO_printf(Perl_debug_log,
6729 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6730 PTR2UV(ptr),(long)cnt));
6731 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6733 DEBUG_P(PerlIO_printf(Perl_debug_log,
6734 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6735 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6736 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6738 /* This used to call 'filbuf' in stdio form, but as that behaves like
6739 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6740 another abstraction. */
6741 i = PerlIO_getc(fp); /* get more characters */
6743 DEBUG_P(PerlIO_printf(Perl_debug_log,
6744 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6745 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6746 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6748 cnt = PerlIO_get_cnt(fp);
6749 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6750 DEBUG_P(PerlIO_printf(Perl_debug_log,
6751 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6753 if (i == EOF) /* all done for ever? */
6754 goto thats_really_all_folks;
6756 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6758 SvGROW(sv, bpx + cnt + 2);
6759 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6761 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6763 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6764 goto thats_all_folks;
6768 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6769 memNE((char*)bp - rslen, rsptr, rslen))
6770 goto screamer; /* go back to the fray */
6771 thats_really_all_folks:
6773 cnt += shortbuffered;
6774 DEBUG_P(PerlIO_printf(Perl_debug_log,
6775 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6776 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6777 DEBUG_P(PerlIO_printf(Perl_debug_log,
6778 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6779 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6780 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6782 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6783 DEBUG_P(PerlIO_printf(Perl_debug_log,
6784 "Screamer: done, len=%ld, string=|%.*s|\n",
6785 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6789 /*The big, slow, and stupid way. */
6790 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6792 Newx(buf, 8192, STDCHAR);
6800 const register STDCHAR *bpe = buf + sizeof(buf);
6802 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6803 ; /* keep reading */
6807 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6808 /* Accomodate broken VAXC compiler, which applies U8 cast to
6809 * both args of ?: operator, causing EOF to change into 255
6812 i = (U8)buf[cnt - 1];
6818 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6820 sv_catpvn(sv, (char *) buf, cnt);
6822 sv_setpvn(sv, (char *) buf, cnt);
6824 if (i != EOF && /* joy */
6826 SvCUR(sv) < rslen ||
6827 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6831 * If we're reading from a TTY and we get a short read,
6832 * indicating that the user hit his EOF character, we need
6833 * to notice it now, because if we try to read from the TTY
6834 * again, the EOF condition will disappear.
6836 * The comparison of cnt to sizeof(buf) is an optimization
6837 * that prevents unnecessary calls to feof().
6841 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6845 #ifdef USE_HEAP_INSTEAD_OF_STACK
6850 if (rspara) { /* have to do this both before and after */
6851 while (i != EOF) { /* to make sure file boundaries work right */
6852 i = PerlIO_getc(fp);
6854 PerlIO_ungetc(fp,i);
6860 return_string_or_null:
6861 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6867 Auto-increment of the value in the SV, doing string to numeric conversion
6868 if necessary. Handles 'get' magic.
6874 Perl_sv_inc(pTHX_ register SV *sv)
6883 if (SvTHINKFIRST(sv)) {
6885 sv_force_normal_flags(sv, 0);
6886 if (SvREADONLY(sv)) {
6887 if (IN_PERL_RUNTIME)
6888 Perl_croak(aTHX_ PL_no_modify);
6892 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6894 i = PTR2IV(SvRV(sv));
6899 flags = SvFLAGS(sv);
6900 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6901 /* It's (privately or publicly) a float, but not tested as an
6902 integer, so test it to see. */
6904 flags = SvFLAGS(sv);
6906 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6907 /* It's publicly an integer, or privately an integer-not-float */
6908 #ifdef PERL_PRESERVE_IVUV
6912 if (SvUVX(sv) == UV_MAX)
6913 sv_setnv(sv, UV_MAX_P1);
6915 (void)SvIOK_only_UV(sv);
6916 SvUV_set(sv, SvUVX(sv) + 1);
6918 if (SvIVX(sv) == IV_MAX)
6919 sv_setuv(sv, (UV)IV_MAX + 1);
6921 (void)SvIOK_only(sv);
6922 SvIV_set(sv, SvIVX(sv) + 1);
6927 if (flags & SVp_NOK) {
6928 (void)SvNOK_only(sv);
6929 SvNV_set(sv, SvNVX(sv) + 1.0);
6933 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6934 if ((flags & SVTYPEMASK) < SVt_PVIV)
6935 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6936 (void)SvIOK_only(sv);
6941 while (isALPHA(*d)) d++;
6942 while (isDIGIT(*d)) d++;
6944 #ifdef PERL_PRESERVE_IVUV
6945 /* Got to punt this as an integer if needs be, but we don't issue
6946 warnings. Probably ought to make the sv_iv_please() that does
6947 the conversion if possible, and silently. */
6948 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6949 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6950 /* Need to try really hard to see if it's an integer.
6951 9.22337203685478e+18 is an integer.
6952 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6953 so $a="9.22337203685478e+18"; $a+0; $a++
6954 needs to be the same as $a="9.22337203685478e+18"; $a++
6961 /* sv_2iv *should* have made this an NV */
6962 if (flags & SVp_NOK) {
6963 (void)SvNOK_only(sv);
6964 SvNV_set(sv, SvNVX(sv) + 1.0);
6967 /* I don't think we can get here. Maybe I should assert this
6968 And if we do get here I suspect that sv_setnv will croak. NWC
6970 #if defined(USE_LONG_DOUBLE)
6971 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",
6972 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6974 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6975 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6978 #endif /* PERL_PRESERVE_IVUV */
6979 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6983 while (d >= SvPVX_const(sv)) {
6991 /* MKS: The original code here died if letters weren't consecutive.
6992 * at least it didn't have to worry about non-C locales. The
6993 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6994 * arranged in order (although not consecutively) and that only
6995 * [A-Za-z] are accepted by isALPHA in the C locale.
6997 if (*d != 'z' && *d != 'Z') {
6998 do { ++*d; } while (!isALPHA(*d));
7001 *(d--) -= 'z' - 'a';
7006 *(d--) -= 'z' - 'a' + 1;
7010 /* oh,oh, the number grew */
7011 SvGROW(sv, SvCUR(sv) + 2);
7012 SvCUR_set(sv, SvCUR(sv) + 1);
7013 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7024 Auto-decrement of the value in the SV, doing string to numeric conversion
7025 if necessary. Handles 'get' magic.
7031 Perl_sv_dec(pTHX_ register SV *sv)
7039 if (SvTHINKFIRST(sv)) {
7041 sv_force_normal_flags(sv, 0);
7042 if (SvREADONLY(sv)) {
7043 if (IN_PERL_RUNTIME)
7044 Perl_croak(aTHX_ PL_no_modify);
7048 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7050 i = PTR2IV(SvRV(sv));
7055 /* Unlike sv_inc we don't have to worry about string-never-numbers
7056 and keeping them magic. But we mustn't warn on punting */
7057 flags = SvFLAGS(sv);
7058 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7059 /* It's publicly an integer, or privately an integer-not-float */
7060 #ifdef PERL_PRESERVE_IVUV
7064 if (SvUVX(sv) == 0) {
7065 (void)SvIOK_only(sv);
7069 (void)SvIOK_only_UV(sv);
7070 SvUV_set(sv, SvUVX(sv) + 1);
7073 if (SvIVX(sv) == IV_MIN)
7074 sv_setnv(sv, (NV)IV_MIN - 1.0);
7076 (void)SvIOK_only(sv);
7077 SvIV_set(sv, SvIVX(sv) - 1);
7082 if (flags & SVp_NOK) {
7083 SvNV_set(sv, SvNVX(sv) - 1.0);
7084 (void)SvNOK_only(sv);
7087 if (!(flags & SVp_POK)) {
7088 if ((flags & SVTYPEMASK) < SVt_PVIV)
7089 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7091 (void)SvIOK_only(sv);
7094 #ifdef PERL_PRESERVE_IVUV
7096 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7097 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7098 /* Need to try really hard to see if it's an integer.
7099 9.22337203685478e+18 is an integer.
7100 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7101 so $a="9.22337203685478e+18"; $a+0; $a--
7102 needs to be the same as $a="9.22337203685478e+18"; $a--
7109 /* sv_2iv *should* have made this an NV */
7110 if (flags & SVp_NOK) {
7111 (void)SvNOK_only(sv);
7112 SvNV_set(sv, SvNVX(sv) - 1.0);
7115 /* I don't think we can get here. Maybe I should assert this
7116 And if we do get here I suspect that sv_setnv will croak. NWC
7118 #if defined(USE_LONG_DOUBLE)
7119 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",
7120 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7122 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7123 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7127 #endif /* PERL_PRESERVE_IVUV */
7128 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7132 =for apidoc sv_mortalcopy
7134 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7135 The new SV is marked as mortal. It will be destroyed "soon", either by an
7136 explicit call to FREETMPS, or by an implicit call at places such as
7137 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7142 /* Make a string that will exist for the duration of the expression
7143 * evaluation. Actually, it may have to last longer than that, but
7144 * hopefully we won't free it until it has been assigned to a
7145 * permanent location. */
7148 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7153 sv_setsv(sv,oldstr);
7155 PL_tmps_stack[++PL_tmps_ix] = sv;
7161 =for apidoc sv_newmortal
7163 Creates a new null SV which is mortal. The reference count of the SV is
7164 set to 1. It will be destroyed "soon", either by an explicit call to
7165 FREETMPS, or by an implicit call at places such as statement boundaries.
7166 See also C<sv_mortalcopy> and C<sv_2mortal>.
7172 Perl_sv_newmortal(pTHX)
7177 SvFLAGS(sv) = SVs_TEMP;
7179 PL_tmps_stack[++PL_tmps_ix] = sv;
7184 =for apidoc sv_2mortal
7186 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7187 by an explicit call to FREETMPS, or by an implicit call at places such as
7188 statement boundaries. SvTEMP() is turned on which means that the SV's
7189 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7190 and C<sv_mortalcopy>.
7196 Perl_sv_2mortal(pTHX_ register SV *sv)
7201 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7204 PL_tmps_stack[++PL_tmps_ix] = sv;
7212 Creates a new SV and copies a string into it. The reference count for the
7213 SV is set to 1. If C<len> is zero, Perl will compute the length using
7214 strlen(). For efficiency, consider using C<newSVpvn> instead.
7220 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7225 sv_setpvn(sv,s,len ? len : strlen(s));
7230 =for apidoc newSVpvn
7232 Creates a new SV and copies a string into it. The reference count for the
7233 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7234 string. You are responsible for ensuring that the source string is at least
7235 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7241 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7246 sv_setpvn(sv,s,len);
7252 =for apidoc newSVhek
7254 Creates a new SV from the hash key structure. It will generate scalars that
7255 point to the shared string table where possible. Returns a new (undefined)
7256 SV if the hek is NULL.
7262 Perl_newSVhek(pTHX_ const HEK *hek)
7271 if (HEK_LEN(hek) == HEf_SVKEY) {
7272 return newSVsv(*(SV**)HEK_KEY(hek));
7274 const int flags = HEK_FLAGS(hek);
7275 if (flags & HVhek_WASUTF8) {
7277 Andreas would like keys he put in as utf8 to come back as utf8
7279 STRLEN utf8_len = HEK_LEN(hek);
7280 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7281 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7284 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7286 } else if (flags & HVhek_REHASH) {
7287 /* We don't have a pointer to the hv, so we have to replicate the
7288 flag into every HEK. This hv is using custom a hasing
7289 algorithm. Hence we can't return a shared string scalar, as
7290 that would contain the (wrong) hash value, and might get passed
7291 into an hv routine with a regular hash */
7293 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7298 /* This will be overwhelminly the most common case. */
7299 return newSVpvn_share(HEK_KEY(hek),
7300 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7306 =for apidoc newSVpvn_share
7308 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7309 table. If the string does not already exist in the table, it is created
7310 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7311 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7312 otherwise the hash is computed. The idea here is that as the string table
7313 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7314 hash lookup will avoid string compare.
7320 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7323 bool is_utf8 = FALSE;
7325 STRLEN tmplen = -len;
7327 /* See the note in hv.c:hv_fetch() --jhi */
7328 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7332 PERL_HASH(hash, src, len);
7334 sv_upgrade(sv, SVt_PV);
7335 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7347 #if defined(PERL_IMPLICIT_CONTEXT)
7349 /* pTHX_ magic can't cope with varargs, so this is a no-context
7350 * version of the main function, (which may itself be aliased to us).
7351 * Don't access this version directly.
7355 Perl_newSVpvf_nocontext(const char* pat, ...)
7360 va_start(args, pat);
7361 sv = vnewSVpvf(pat, &args);
7368 =for apidoc newSVpvf
7370 Creates a new SV and initializes it with the string formatted like
7377 Perl_newSVpvf(pTHX_ const char* pat, ...)
7381 va_start(args, pat);
7382 sv = vnewSVpvf(pat, &args);
7387 /* backend for newSVpvf() and newSVpvf_nocontext() */
7390 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7394 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7401 Creates a new SV and copies a floating point value into it.
7402 The reference count for the SV is set to 1.
7408 Perl_newSVnv(pTHX_ NV n)
7420 Creates a new SV and copies an integer into it. The reference count for the
7427 Perl_newSViv(pTHX_ IV i)
7439 Creates a new SV and copies an unsigned integer into it.
7440 The reference count for the SV is set to 1.
7446 Perl_newSVuv(pTHX_ UV u)
7456 =for apidoc newRV_noinc
7458 Creates an RV wrapper for an SV. The reference count for the original
7459 SV is B<not> incremented.
7465 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7470 sv_upgrade(sv, SVt_RV);
7472 SvRV_set(sv, tmpRef);
7477 /* newRV_inc is the official function name to use now.
7478 * newRV_inc is in fact #defined to newRV in sv.h
7482 Perl_newRV(pTHX_ SV *tmpRef)
7484 return newRV_noinc(SvREFCNT_inc(tmpRef));
7490 Creates a new SV which is an exact duplicate of the original SV.
7497 Perl_newSVsv(pTHX_ register SV *old)
7503 if (SvTYPE(old) == SVTYPEMASK) {
7504 if (ckWARN_d(WARN_INTERNAL))
7505 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7509 /* SV_GMAGIC is the default for sv_setv()
7510 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7511 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7512 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7517 =for apidoc sv_reset
7519 Underlying implementation for the C<reset> Perl function.
7520 Note that the perl-level function is vaguely deprecated.
7526 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7529 char todo[PERL_UCHAR_MAX+1];
7534 if (!*s) { /* reset ?? searches */
7535 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7537 PMOP *pm = (PMOP *) mg->mg_obj;
7539 pm->op_pmdynflags &= ~PMdf_USED;
7546 /* reset variables */
7548 if (!HvARRAY(stash))
7551 Zero(todo, 256, char);
7554 I32 i = (unsigned char)*s;
7558 max = (unsigned char)*s++;
7559 for ( ; i <= max; i++) {
7562 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7564 for (entry = HvARRAY(stash)[i];
7566 entry = HeNEXT(entry))
7571 if (!todo[(U8)*HeKEY(entry)])
7573 gv = (GV*)HeVAL(entry);
7576 if (SvTHINKFIRST(sv)) {
7577 if (!SvREADONLY(sv) && SvROK(sv))
7579 /* XXX Is this continue a bug? Why should THINKFIRST
7580 exempt us from resetting arrays and hashes? */
7584 if (SvTYPE(sv) >= SVt_PV) {
7586 if (SvPVX_const(sv) != Nullch)
7594 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7597 #ifdef USE_ENVIRON_ARRAY
7599 # ifdef USE_ITHREADS
7600 && PL_curinterp == aTHX
7604 environ[0] = Nullch;
7607 #endif /* !PERL_MICRO */
7617 Using various gambits, try to get an IO from an SV: the IO slot if its a
7618 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7619 named after the PV if we're a string.
7625 Perl_sv_2io(pTHX_ SV *sv)
7630 switch (SvTYPE(sv)) {
7638 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7642 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7644 return sv_2io(SvRV(sv));
7645 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7651 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7660 Using various gambits, try to get a CV from an SV; in addition, try if
7661 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7667 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7674 return *gvp = Nullgv, Nullcv;
7675 switch (SvTYPE(sv)) {
7694 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7695 tryAMAGICunDEREF(to_cv);
7698 if (SvTYPE(sv) == SVt_PVCV) {
7707 Perl_croak(aTHX_ "Not a subroutine reference");
7712 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7718 if (lref && !GvCVu(gv)) {
7721 tmpsv = NEWSV(704,0);
7722 gv_efullname3(tmpsv, gv, Nullch);
7723 /* XXX this is probably not what they think they're getting.
7724 * It has the same effect as "sub name;", i.e. just a forward
7726 newSUB(start_subparse(FALSE, 0),
7727 newSVOP(OP_CONST, 0, tmpsv),
7732 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7742 Returns true if the SV has a true value by Perl's rules.
7743 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7744 instead use an in-line version.
7750 Perl_sv_true(pTHX_ register SV *sv)
7755 const register XPV* tXpv;
7756 if ((tXpv = (XPV*)SvANY(sv)) &&
7757 (tXpv->xpv_cur > 1 ||
7758 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7765 return SvIVX(sv) != 0;
7768 return SvNVX(sv) != 0.0;
7770 return sv_2bool(sv);
7778 A private implementation of the C<SvIVx> macro for compilers which can't
7779 cope with complex macro expressions. Always use the macro instead.
7785 Perl_sv_iv(pTHX_ register SV *sv)
7789 return (IV)SvUVX(sv);
7798 A private implementation of the C<SvUVx> macro for compilers which can't
7799 cope with complex macro expressions. Always use the macro instead.
7805 Perl_sv_uv(pTHX_ register SV *sv)
7810 return (UV)SvIVX(sv);
7818 A private implementation of the C<SvNVx> macro for compilers which can't
7819 cope with complex macro expressions. Always use the macro instead.
7825 Perl_sv_nv(pTHX_ register SV *sv)
7832 /* sv_pv() is now a macro using SvPV_nolen();
7833 * this function provided for binary compatibility only
7837 Perl_sv_pv(pTHX_ SV *sv)
7842 return sv_2pv(sv, 0);
7848 Use the C<SvPV_nolen> macro instead
7852 A private implementation of the C<SvPV> macro for compilers which can't
7853 cope with complex macro expressions. Always use the macro instead.
7859 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7865 return sv_2pv(sv, lp);
7870 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7876 return sv_2pv_flags(sv, lp, 0);
7879 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7880 * this function provided for binary compatibility only
7884 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7886 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7890 =for apidoc sv_pvn_force
7892 Get a sensible string out of the SV somehow.
7893 A private implementation of the C<SvPV_force> macro for compilers which
7894 can't cope with complex macro expressions. Always use the macro instead.
7896 =for apidoc sv_pvn_force_flags
7898 Get a sensible string out of the SV somehow.
7899 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7900 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7901 implemented in terms of this function.
7902 You normally want to use the various wrapper macros instead: see
7903 C<SvPV_force> and C<SvPV_force_nomg>
7909 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7912 if (SvTHINKFIRST(sv) && !SvROK(sv))
7913 sv_force_normal_flags(sv, 0);
7923 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7924 const char * const ref = sv_reftype(sv,0);
7926 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7927 ref, OP_NAME(PL_op));
7929 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7931 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7932 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7934 s = sv_2pv_flags(sv, &len, flags);
7938 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7941 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7942 SvGROW(sv, len + 1);
7943 Move(s,SvPVX_const(sv),len,char);
7948 SvPOK_on(sv); /* validate pointer */
7950 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7951 PTR2UV(sv),SvPVX_const(sv)));
7954 return SvPVX_mutable(sv);
7957 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7958 * this function provided for binary compatibility only
7962 Perl_sv_pvbyte(pTHX_ SV *sv)
7964 sv_utf8_downgrade(sv,0);
7969 =for apidoc sv_pvbyte
7971 Use C<SvPVbyte_nolen> instead.
7973 =for apidoc sv_pvbyten
7975 A private implementation of the C<SvPVbyte> macro for compilers
7976 which can't cope with complex macro expressions. Always use the macro
7983 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7985 sv_utf8_downgrade(sv,0);
7986 return sv_pvn(sv,lp);
7990 =for apidoc sv_pvbyten_force
7992 A private implementation of the C<SvPVbytex_force> macro for compilers
7993 which can't cope with complex macro expressions. Always use the macro
8000 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8002 sv_pvn_force(sv,lp);
8003 sv_utf8_downgrade(sv,0);
8008 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8009 * this function provided for binary compatibility only
8013 Perl_sv_pvutf8(pTHX_ SV *sv)
8015 sv_utf8_upgrade(sv);
8020 =for apidoc sv_pvutf8
8022 Use the C<SvPVutf8_nolen> macro instead
8024 =for apidoc sv_pvutf8n
8026 A private implementation of the C<SvPVutf8> macro for compilers
8027 which can't cope with complex macro expressions. Always use the macro
8034 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8036 sv_utf8_upgrade(sv);
8037 return sv_pvn(sv,lp);
8041 =for apidoc sv_pvutf8n_force
8043 A private implementation of the C<SvPVutf8_force> macro for compilers
8044 which can't cope with complex macro expressions. Always use the macro
8051 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8053 sv_pvn_force(sv,lp);
8054 sv_utf8_upgrade(sv);
8060 =for apidoc sv_reftype
8062 Returns a string describing what the SV is a reference to.
8068 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8070 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8071 inside return suggests a const propagation bug in g++. */
8072 if (ob && SvOBJECT(sv)) {
8073 char * const name = HvNAME_get(SvSTASH(sv));
8074 return name ? name : (char *) "__ANON__";
8077 switch (SvTYPE(sv)) {
8094 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8095 /* tied lvalues should appear to be
8096 * scalars for backwards compatitbility */
8097 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8098 ? "SCALAR" : "LVALUE");
8099 case SVt_PVAV: return "ARRAY";
8100 case SVt_PVHV: return "HASH";
8101 case SVt_PVCV: return "CODE";
8102 case SVt_PVGV: return "GLOB";
8103 case SVt_PVFM: return "FORMAT";
8104 case SVt_PVIO: return "IO";
8105 default: return "UNKNOWN";
8111 =for apidoc sv_isobject
8113 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8114 object. If the SV is not an RV, or if the object is not blessed, then this
8121 Perl_sv_isobject(pTHX_ SV *sv)
8138 Returns a boolean indicating whether the SV is blessed into the specified
8139 class. This does not check for subtypes; use C<sv_derived_from> to verify
8140 an inheritance relationship.
8146 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8158 hvname = HvNAME_get(SvSTASH(sv));
8162 return strEQ(hvname, name);
8168 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8169 it will be upgraded to one. If C<classname> is non-null then the new SV will
8170 be blessed in the specified package. The new SV is returned and its
8171 reference count is 1.
8177 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8183 SV_CHECK_THINKFIRST_COW_DROP(rv);
8186 if (SvTYPE(rv) >= SVt_PVMG) {
8187 const U32 refcnt = SvREFCNT(rv);
8191 SvREFCNT(rv) = refcnt;
8194 if (SvTYPE(rv) < SVt_RV)
8195 sv_upgrade(rv, SVt_RV);
8196 else if (SvTYPE(rv) > SVt_RV) {
8207 HV* const stash = gv_stashpv(classname, TRUE);
8208 (void)sv_bless(rv, stash);
8214 =for apidoc sv_setref_pv
8216 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8217 argument will be upgraded to an RV. That RV will be modified to point to
8218 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8219 into the SV. The C<classname> argument indicates the package for the
8220 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8221 will have a reference count of 1, and the RV will be returned.
8223 Do not use with other Perl types such as HV, AV, SV, CV, because those
8224 objects will become corrupted by the pointer copy process.
8226 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8232 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8235 sv_setsv(rv, &PL_sv_undef);
8239 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8244 =for apidoc sv_setref_iv
8246 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8247 argument will be upgraded to an RV. That RV will be modified to point to
8248 the new SV. The C<classname> argument indicates the package for the
8249 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8250 will have a reference count of 1, and the RV will be returned.
8256 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8258 sv_setiv(newSVrv(rv,classname), iv);
8263 =for apidoc sv_setref_uv
8265 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8266 argument will be upgraded to an RV. That RV will be modified to point to
8267 the new SV. The C<classname> argument indicates the package for the
8268 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8269 will have a reference count of 1, and the RV will be returned.
8275 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8277 sv_setuv(newSVrv(rv,classname), uv);
8282 =for apidoc sv_setref_nv
8284 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8285 argument will be upgraded to an RV. That RV will be modified to point to
8286 the new SV. The C<classname> argument indicates the package for the
8287 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8288 will have a reference count of 1, and the RV will be returned.
8294 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8296 sv_setnv(newSVrv(rv,classname), nv);
8301 =for apidoc sv_setref_pvn
8303 Copies a string into a new SV, optionally blessing the SV. The length of the
8304 string must be specified with C<n>. The C<rv> argument will be upgraded to
8305 an RV. That RV will be modified to point to the new SV. The C<classname>
8306 argument indicates the package for the blessing. Set C<classname> to
8307 C<Nullch> to avoid the blessing. The new SV will have a reference count
8308 of 1, and the RV will be returned.
8310 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8316 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8318 sv_setpvn(newSVrv(rv,classname), pv, n);
8323 =for apidoc sv_bless
8325 Blesses an SV into a specified package. The SV must be an RV. The package
8326 must be designated by its stash (see C<gv_stashpv()>). The reference count
8327 of the SV is unaffected.
8333 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8337 Perl_croak(aTHX_ "Can't bless non-reference value");
8339 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8340 if (SvREADONLY(tmpRef))
8341 Perl_croak(aTHX_ PL_no_modify);
8342 if (SvOBJECT(tmpRef)) {
8343 if (SvTYPE(tmpRef) != SVt_PVIO)
8345 SvREFCNT_dec(SvSTASH(tmpRef));
8348 SvOBJECT_on(tmpRef);
8349 if (SvTYPE(tmpRef) != SVt_PVIO)
8351 SvUPGRADE(tmpRef, SVt_PVMG);
8352 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8359 if(SvSMAGICAL(tmpRef))
8360 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8368 /* Downgrades a PVGV to a PVMG.
8372 S_sv_unglob(pTHX_ SV *sv)
8376 assert(SvTYPE(sv) == SVt_PVGV);
8381 sv_del_backref((SV*)GvSTASH(sv), sv);
8382 GvSTASH(sv) = Nullhv;
8384 sv_unmagic(sv, PERL_MAGIC_glob);
8385 Safefree(GvNAME(sv));
8388 /* need to keep SvANY(sv) in the right arena */
8389 xpvmg = new_XPVMG();
8390 StructCopy(SvANY(sv), xpvmg, XPVMG);
8391 del_XPVGV(SvANY(sv));
8394 SvFLAGS(sv) &= ~SVTYPEMASK;
8395 SvFLAGS(sv) |= SVt_PVMG;
8399 =for apidoc sv_unref_flags
8401 Unsets the RV status of the SV, and decrements the reference count of
8402 whatever was being referenced by the RV. This can almost be thought of
8403 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8404 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8405 (otherwise the decrementing is conditional on the reference count being
8406 different from one or the reference being a readonly SV).
8413 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8415 SV* const target = SvRV(ref);
8417 if (SvWEAKREF(ref)) {
8418 sv_del_backref(target, ref);
8420 SvRV_set(ref, NULL);
8423 SvRV_set(ref, NULL);
8425 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8426 assigned to as BEGIN {$a = \"Foo"} will fail. */
8427 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8428 SvREFCNT_dec(target);
8429 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8430 sv_2mortal(target); /* Schedule for freeing later */
8434 =for apidoc sv_unref
8436 Unsets the RV status of the SV, and decrements the reference count of
8437 whatever was being referenced by the RV. This can almost be thought of
8438 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8439 being zero. See C<SvROK_off>.
8445 Perl_sv_unref(pTHX_ SV *sv)
8447 sv_unref_flags(sv, 0);
8451 =for apidoc sv_taint
8453 Taint an SV. Use C<SvTAINTED_on> instead.
8458 Perl_sv_taint(pTHX_ SV *sv)
8460 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8464 =for apidoc sv_untaint
8466 Untaint an SV. Use C<SvTAINTED_off> instead.
8471 Perl_sv_untaint(pTHX_ SV *sv)
8473 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8474 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8481 =for apidoc sv_tainted
8483 Test an SV for taintedness. Use C<SvTAINTED> instead.
8488 Perl_sv_tainted(pTHX_ SV *sv)
8490 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8491 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8492 if (mg && (mg->mg_len & 1) )
8499 =for apidoc sv_setpviv
8501 Copies an integer into the given SV, also updating its string value.
8502 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8508 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8510 char buf[TYPE_CHARS(UV)];
8512 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8514 sv_setpvn(sv, ptr, ebuf - ptr);
8518 =for apidoc sv_setpviv_mg
8520 Like C<sv_setpviv>, but also handles 'set' magic.
8526 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8528 char buf[TYPE_CHARS(UV)];
8530 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8532 sv_setpvn(sv, ptr, ebuf - ptr);
8536 #if defined(PERL_IMPLICIT_CONTEXT)
8538 /* pTHX_ magic can't cope with varargs, so this is a no-context
8539 * version of the main function, (which may itself be aliased to us).
8540 * Don't access this version directly.
8544 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8548 va_start(args, pat);
8549 sv_vsetpvf(sv, pat, &args);
8553 /* pTHX_ magic can't cope with varargs, so this is a no-context
8554 * version of the main function, (which may itself be aliased to us).
8555 * Don't access this version directly.
8559 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8563 va_start(args, pat);
8564 sv_vsetpvf_mg(sv, pat, &args);
8570 =for apidoc sv_setpvf
8572 Works like C<sv_catpvf> but copies the text into the SV instead of
8573 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8579 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8582 va_start(args, pat);
8583 sv_vsetpvf(sv, pat, &args);
8588 =for apidoc sv_vsetpvf
8590 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8591 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8593 Usually used via its frontend C<sv_setpvf>.
8599 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8601 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8605 =for apidoc sv_setpvf_mg
8607 Like C<sv_setpvf>, but also handles 'set' magic.
8613 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8616 va_start(args, pat);
8617 sv_vsetpvf_mg(sv, pat, &args);
8622 =for apidoc sv_vsetpvf_mg
8624 Like C<sv_vsetpvf>, but also handles 'set' magic.
8626 Usually used via its frontend C<sv_setpvf_mg>.
8632 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8634 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8638 #if defined(PERL_IMPLICIT_CONTEXT)
8640 /* pTHX_ magic can't cope with varargs, so this is a no-context
8641 * version of the main function, (which may itself be aliased to us).
8642 * Don't access this version directly.
8646 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8650 va_start(args, pat);
8651 sv_vcatpvf(sv, pat, &args);
8655 /* pTHX_ magic can't cope with varargs, so this is a no-context
8656 * version of the main function, (which may itself be aliased to us).
8657 * Don't access this version directly.
8661 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8665 va_start(args, pat);
8666 sv_vcatpvf_mg(sv, pat, &args);
8672 =for apidoc sv_catpvf
8674 Processes its arguments like C<sprintf> and appends the formatted
8675 output to an SV. If the appended data contains "wide" characters
8676 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8677 and characters >255 formatted with %c), the original SV might get
8678 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8679 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8680 valid UTF-8; if the original SV was bytes, the pattern should be too.
8685 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8688 va_start(args, pat);
8689 sv_vcatpvf(sv, pat, &args);
8694 =for apidoc sv_vcatpvf
8696 Processes its arguments like C<vsprintf> and appends the formatted output
8697 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8699 Usually used via its frontend C<sv_catpvf>.
8705 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8707 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8711 =for apidoc sv_catpvf_mg
8713 Like C<sv_catpvf>, but also handles 'set' magic.
8719 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8722 va_start(args, pat);
8723 sv_vcatpvf_mg(sv, pat, &args);
8728 =for apidoc sv_vcatpvf_mg
8730 Like C<sv_vcatpvf>, but also handles 'set' magic.
8732 Usually used via its frontend C<sv_catpvf_mg>.
8738 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8740 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8745 =for apidoc sv_vsetpvfn
8747 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8750 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8756 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8758 sv_setpvn(sv, "", 0);
8759 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8762 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8765 S_expect_number(pTHX_ char** pattern)
8768 switch (**pattern) {
8769 case '1': case '2': case '3':
8770 case '4': case '5': case '6':
8771 case '7': case '8': case '9':
8772 while (isDIGIT(**pattern))
8773 var = var * 10 + (*(*pattern)++ - '0');
8777 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8780 F0convert(NV nv, char *endbuf, STRLEN *len)
8782 const int neg = nv < 0;
8791 if (uv & 1 && uv == nv)
8792 uv--; /* Round to even */
8794 const unsigned dig = uv % 10;
8807 =for apidoc sv_vcatpvfn
8809 Processes its arguments like C<vsprintf> and appends the formatted output
8810 to an SV. Uses an array of SVs if the C style variable argument list is
8811 missing (NULL). When running with taint checks enabled, indicates via
8812 C<maybe_tainted> if results are untrustworthy (often due to the use of
8815 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8820 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8823 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8830 static const char nullstr[] = "(null)";
8832 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8833 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8835 /* Times 4: a decimal digit takes more than 3 binary digits.
8836 * NV_DIG: mantissa takes than many decimal digits.
8837 * Plus 32: Playing safe. */
8838 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8839 /* large enough for "%#.#f" --chip */
8840 /* what about long double NVs? --jhi */
8842 PERL_UNUSED_ARG(maybe_tainted);
8844 /* no matter what, this is a string now */
8845 (void)SvPV_force(sv, origlen);
8847 /* special-case "", "%s", and "%-p" (SVf) */
8850 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8852 const char * const s = va_arg(*args, char*);
8853 sv_catpv(sv, s ? s : nullstr);
8855 else if (svix < svmax) {
8856 sv_catsv(sv, *svargs);
8857 if (DO_UTF8(*svargs))
8862 if (patlen == 3 && pat[0] == '%' &&
8863 pat[1] == '-' && pat[2] == 'p') {
8865 argsv = va_arg(*args, SV*);
8866 sv_catsv(sv, argsv);
8873 #ifndef USE_LONG_DOUBLE
8874 /* special-case "%.<number>[gf]" */
8875 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8876 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8877 unsigned digits = 0;
8881 while (*pp >= '0' && *pp <= '9')
8882 digits = 10 * digits + (*pp++ - '0');
8883 if (pp - pat == (int)patlen - 1) {
8891 /* Add check for digits != 0 because it seems that some
8892 gconverts are buggy in this case, and we don't yet have
8893 a Configure test for this. */
8894 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8895 /* 0, point, slack */
8896 Gconvert(nv, (int)digits, 0, ebuf);
8898 if (*ebuf) /* May return an empty string for digits==0 */
8901 } else if (!digits) {
8904 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8905 sv_catpvn(sv, p, l);
8911 #endif /* !USE_LONG_DOUBLE */
8913 if (!args && svix < svmax && DO_UTF8(*svargs))
8916 patend = (char*)pat + patlen;
8917 for (p = (char*)pat; p < patend; p = q) {
8920 bool vectorize = FALSE;
8921 bool vectorarg = FALSE;
8922 bool vec_utf8 = FALSE;
8928 bool has_precis = FALSE;
8931 bool is_utf8 = FALSE; /* is this item utf8? */
8932 #ifdef HAS_LDBL_SPRINTF_BUG
8933 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8934 with sfio - Allen <allens@cpan.org> */
8935 bool fix_ldbl_sprintf_bug = FALSE;
8939 U8 utf8buf[UTF8_MAXBYTES+1];
8940 STRLEN esignlen = 0;
8942 const char *eptr = Nullch;
8945 const U8 *vecstr = Null(U8*);
8952 /* we need a long double target in case HAS_LONG_DOUBLE but
8955 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8963 const char *dotstr = ".";
8964 STRLEN dotstrlen = 1;
8965 I32 efix = 0; /* explicit format parameter index */
8966 I32 ewix = 0; /* explicit width index */
8967 I32 epix = 0; /* explicit precision index */
8968 I32 evix = 0; /* explicit vector index */
8969 bool asterisk = FALSE;
8971 /* echo everything up to the next format specification */
8972 for (q = p; q < patend && *q != '%'; ++q) ;
8974 if (has_utf8 && !pat_utf8)
8975 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8977 sv_catpvn(sv, p, q - p);
8984 We allow format specification elements in this order:
8985 \d+\$ explicit format parameter index
8987 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8988 0 flag (as above): repeated to allow "v02"
8989 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8990 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8992 [%bcdefginopsux_DFOUX] format (mandatory)
8994 if (EXPECT_NUMBER(q, width)) {
9035 if (EXPECT_NUMBER(q, ewix))
9044 if ((vectorarg = asterisk)) {
9056 EXPECT_NUMBER(q, width);
9061 vecsv = va_arg(*args, SV*);
9063 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9064 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9065 dotstr = SvPV_const(vecsv, dotstrlen);
9070 vecsv = va_arg(*args, SV*);
9071 vecstr = (U8*)SvPV_const(vecsv,veclen);
9072 vec_utf8 = DO_UTF8(vecsv);
9074 else if (efix ? efix <= svmax : svix < svmax) {
9075 vecsv = svargs[efix ? efix-1 : svix++];
9076 vecstr = (U8*)SvPV_const(vecsv,veclen);
9077 vec_utf8 = DO_UTF8(vecsv);
9078 /* if this is a version object, we need to return the
9079 * stringified representation (which the SvPVX_const has
9080 * already done for us), but not vectorize the args
9082 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9084 q++; /* skip past the rest of the %vd format */
9085 eptr = (const char *) vecstr;
9086 elen = strlen(eptr);
9099 i = va_arg(*args, int);
9101 i = (ewix ? ewix <= svmax : svix < svmax) ?
9102 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9104 width = (i < 0) ? -i : i;
9114 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9116 /* XXX: todo, support specified precision parameter */
9120 i = va_arg(*args, int);
9122 i = (ewix ? ewix <= svmax : svix < svmax)
9123 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9124 precis = (i < 0) ? 0 : i;
9129 precis = precis * 10 + (*q++ - '0');
9138 case 'I': /* Ix, I32x, and I64x */
9140 if (q[1] == '6' && q[2] == '4') {
9146 if (q[1] == '3' && q[2] == '2') {
9156 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9167 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9168 if (*(q + 1) == 'l') { /* lld, llf */
9193 argsv = (efix ? efix <= svmax : svix < svmax) ?
9194 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9201 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9203 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9205 eptr = (char*)utf8buf;
9206 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9217 if (args && !vectorize) {
9218 eptr = va_arg(*args, char*);
9220 #ifdef MACOS_TRADITIONAL
9221 /* On MacOS, %#s format is used for Pascal strings */
9226 elen = strlen(eptr);
9228 eptr = (char *)nullstr;
9229 elen = sizeof nullstr - 1;
9233 eptr = SvPVx_const(argsv, elen);
9234 if (DO_UTF8(argsv)) {
9235 if (has_precis && precis < elen) {
9237 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9240 if (width) { /* fudge width (can't fudge elen) */
9241 width += elen - sv_len_utf8(argsv);
9249 if (has_precis && elen > precis)
9256 if (left && args) { /* SVf */
9265 argsv = va_arg(*args, SV*);
9266 eptr = SvPVx_const(argsv, elen);
9271 if (alt || vectorize)
9273 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9291 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9300 esignbuf[esignlen++] = plus;
9304 case 'h': iv = (short)va_arg(*args, int); break;
9305 case 'l': iv = va_arg(*args, long); break;
9306 case 'V': iv = va_arg(*args, IV); break;
9307 default: iv = va_arg(*args, int); break;
9309 case 'q': iv = va_arg(*args, Quad_t); break;
9314 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9316 case 'h': iv = (short)tiv; break;
9317 case 'l': iv = (long)tiv; break;
9319 default: iv = tiv; break;
9321 case 'q': iv = (Quad_t)tiv; break;
9325 if ( !vectorize ) /* we already set uv above */
9330 esignbuf[esignlen++] = plus;
9334 esignbuf[esignlen++] = '-';
9377 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9388 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9389 case 'l': uv = va_arg(*args, unsigned long); break;
9390 case 'V': uv = va_arg(*args, UV); break;
9391 default: uv = va_arg(*args, unsigned); break;
9393 case 'q': uv = va_arg(*args, Uquad_t); break;
9398 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9400 case 'h': uv = (unsigned short)tuv; break;
9401 case 'l': uv = (unsigned long)tuv; break;
9403 default: uv = tuv; break;
9405 case 'q': uv = (Uquad_t)tuv; break;
9412 char *ptr = ebuf + sizeof ebuf;
9418 p = (char*)((c == 'X')
9419 ? "0123456789ABCDEF" : "0123456789abcdef");
9425 esignbuf[esignlen++] = '0';
9426 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9434 if (alt && *ptr != '0')
9443 esignbuf[esignlen++] = '0';
9444 esignbuf[esignlen++] = 'b';
9447 default: /* it had better be ten or less */
9451 } while (uv /= base);
9454 elen = (ebuf + sizeof ebuf) - ptr;
9458 zeros = precis - elen;
9459 else if (precis == 0 && elen == 1 && *eptr == '0')
9465 /* FLOATING POINT */
9468 c = 'f'; /* maybe %F isn't supported here */
9474 /* This is evil, but floating point is even more evil */
9476 /* for SV-style calling, we can only get NV
9477 for C-style calling, we assume %f is double;
9478 for simplicity we allow any of %Lf, %llf, %qf for long double
9482 #if defined(USE_LONG_DOUBLE)
9486 /* [perl #20339] - we should accept and ignore %lf rather than die */
9490 #if defined(USE_LONG_DOUBLE)
9491 intsize = args ? 0 : 'q';
9495 #if defined(HAS_LONG_DOUBLE)
9504 /* now we need (long double) if intsize == 'q', else (double) */
9505 nv = (args && !vectorize) ?
9506 #if LONG_DOUBLESIZE > DOUBLESIZE
9508 va_arg(*args, long double) :
9509 va_arg(*args, double)
9511 va_arg(*args, double)
9517 if (c != 'e' && c != 'E') {
9519 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9520 will cast our (long double) to (double) */
9521 (void)Perl_frexp(nv, &i);
9522 if (i == PERL_INT_MIN)
9523 Perl_die(aTHX_ "panic: frexp");
9525 need = BIT_DIGITS(i);
9527 need += has_precis ? precis : 6; /* known default */
9532 #ifdef HAS_LDBL_SPRINTF_BUG
9533 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9534 with sfio - Allen <allens@cpan.org> */
9537 # define MY_DBL_MAX DBL_MAX
9538 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9539 # if DOUBLESIZE >= 8
9540 # define MY_DBL_MAX 1.7976931348623157E+308L
9542 # define MY_DBL_MAX 3.40282347E+38L
9546 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9547 # define MY_DBL_MAX_BUG 1L
9549 # define MY_DBL_MAX_BUG MY_DBL_MAX
9553 # define MY_DBL_MIN DBL_MIN
9554 # else /* XXX guessing! -Allen */
9555 # if DOUBLESIZE >= 8
9556 # define MY_DBL_MIN 2.2250738585072014E-308L
9558 # define MY_DBL_MIN 1.17549435E-38L
9562 if ((intsize == 'q') && (c == 'f') &&
9563 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9565 /* it's going to be short enough that
9566 * long double precision is not needed */
9568 if ((nv <= 0L) && (nv >= -0L))
9569 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9571 /* would use Perl_fp_class as a double-check but not
9572 * functional on IRIX - see perl.h comments */
9574 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9575 /* It's within the range that a double can represent */
9576 #if defined(DBL_MAX) && !defined(DBL_MIN)
9577 if ((nv >= ((long double)1/DBL_MAX)) ||
9578 (nv <= (-(long double)1/DBL_MAX)))
9580 fix_ldbl_sprintf_bug = TRUE;
9583 if (fix_ldbl_sprintf_bug == TRUE) {
9593 # undef MY_DBL_MAX_BUG
9596 #endif /* HAS_LDBL_SPRINTF_BUG */
9598 need += 20; /* fudge factor */
9599 if (PL_efloatsize < need) {
9600 Safefree(PL_efloatbuf);
9601 PL_efloatsize = need + 20; /* more fudge */
9602 Newx(PL_efloatbuf, PL_efloatsize, char);
9603 PL_efloatbuf[0] = '\0';
9606 if ( !(width || left || plus || alt) && fill != '0'
9607 && has_precis && intsize != 'q' ) { /* Shortcuts */
9608 /* See earlier comment about buggy Gconvert when digits,
9610 if ( c == 'g' && precis) {
9611 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9612 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9613 goto float_converted;
9614 } else if ( c == 'f' && !precis) {
9615 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9620 char *ptr = ebuf + sizeof ebuf;
9623 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9624 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9625 if (intsize == 'q') {
9626 /* Copy the one or more characters in a long double
9627 * format before the 'base' ([efgEFG]) character to
9628 * the format string. */
9629 static char const prifldbl[] = PERL_PRIfldbl;
9630 char const *p = prifldbl + sizeof(prifldbl) - 3;
9631 while (p >= prifldbl) { *--ptr = *p--; }
9636 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9641 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9653 /* No taint. Otherwise we are in the strange situation
9654 * where printf() taints but print($float) doesn't.
9656 #if defined(HAS_LONG_DOUBLE)
9658 (void)sprintf(PL_efloatbuf, ptr, nv);
9660 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9662 (void)sprintf(PL_efloatbuf, ptr, nv);
9666 eptr = PL_efloatbuf;
9667 elen = strlen(PL_efloatbuf);
9673 i = SvCUR(sv) - origlen;
9674 if (args && !vectorize) {
9676 case 'h': *(va_arg(*args, short*)) = i; break;
9677 default: *(va_arg(*args, int*)) = i; break;
9678 case 'l': *(va_arg(*args, long*)) = i; break;
9679 case 'V': *(va_arg(*args, IV*)) = i; break;
9681 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9686 sv_setuv_mg(argsv, (UV)i);
9688 continue; /* not "break" */
9694 if (!args && ckWARN(WARN_PRINTF) &&
9695 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9696 SV *msg = sv_newmortal();
9697 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9698 (PL_op->op_type == OP_PRTF) ? "" : "s");
9701 Perl_sv_catpvf(aTHX_ msg,
9702 "\"%%%c\"", c & 0xFF);
9704 Perl_sv_catpvf(aTHX_ msg,
9705 "\"%%\\%03"UVof"\"",
9708 sv_catpv(msg, "end of string");
9709 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9712 /* output mangled stuff ... */
9718 /* ... right here, because formatting flags should not apply */
9719 SvGROW(sv, SvCUR(sv) + elen + 1);
9721 Copy(eptr, p, elen, char);
9724 SvCUR_set(sv, p - SvPVX_const(sv));
9726 continue; /* not "break" */
9729 /* calculate width before utf8_upgrade changes it */
9730 have = esignlen + zeros + elen;
9732 if (is_utf8 != has_utf8) {
9735 sv_utf8_upgrade(sv);
9738 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9739 sv_utf8_upgrade(nsv);
9740 eptr = SvPVX_const(nsv);
9743 SvGROW(sv, SvCUR(sv) + elen + 1);
9748 need = (have > width ? have : width);
9751 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9753 if (esignlen && fill == '0') {
9755 for (i = 0; i < (int)esignlen; i++)
9759 memset(p, fill, gap);
9762 if (esignlen && fill != '0') {
9764 for (i = 0; i < (int)esignlen; i++)
9769 for (i = zeros; i; i--)
9773 Copy(eptr, p, elen, char);
9777 memset(p, ' ', gap);
9782 Copy(dotstr, p, dotstrlen, char);
9786 vectorize = FALSE; /* done iterating over vecstr */
9793 SvCUR_set(sv, p - SvPVX_const(sv));
9801 /* =========================================================================
9803 =head1 Cloning an interpreter
9805 All the macros and functions in this section are for the private use of
9806 the main function, perl_clone().
9808 The foo_dup() functions make an exact copy of an existing foo thinngy.
9809 During the course of a cloning, a hash table is used to map old addresses
9810 to new addresses. The table is created and manipulated with the
9811 ptr_table_* functions.
9815 ============================================================================*/
9818 #if defined(USE_ITHREADS)
9820 #ifndef GpREFCNT_inc
9821 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9825 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9826 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9827 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9828 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9829 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9830 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9831 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9832 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9833 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9834 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9835 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9836 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9837 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9840 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9841 regcomp.c. AMS 20010712 */
9844 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9849 struct reg_substr_datum *s;
9852 return (REGEXP *)NULL;
9854 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9857 len = r->offsets[0];
9858 npar = r->nparens+1;
9860 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9861 Copy(r->program, ret->program, len+1, regnode);
9863 Newx(ret->startp, npar, I32);
9864 Copy(r->startp, ret->startp, npar, I32);
9865 Newx(ret->endp, npar, I32);
9866 Copy(r->startp, ret->startp, npar, I32);
9868 Newx(ret->substrs, 1, struct reg_substr_data);
9869 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9870 s->min_offset = r->substrs->data[i].min_offset;
9871 s->max_offset = r->substrs->data[i].max_offset;
9872 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9873 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9876 ret->regstclass = NULL;
9879 const int count = r->data->count;
9882 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9883 char, struct reg_data);
9884 Newx(d->what, count, U8);
9887 for (i = 0; i < count; i++) {
9888 d->what[i] = r->data->what[i];
9889 switch (d->what[i]) {
9890 /* legal options are one of: sfpont
9891 see also regcomp.h and pregfree() */
9893 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9896 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9899 /* This is cheating. */
9900 Newx(d->data[i], 1, struct regnode_charclass_class);
9901 StructCopy(r->data->data[i], d->data[i],
9902 struct regnode_charclass_class);
9903 ret->regstclass = (regnode*)d->data[i];
9906 /* Compiled op trees are readonly, and can thus be
9907 shared without duplication. */
9909 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9913 d->data[i] = r->data->data[i];
9916 d->data[i] = r->data->data[i];
9918 ((reg_trie_data*)d->data[i])->refcount++;
9922 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9931 Newx(ret->offsets, 2*len+1, U32);
9932 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9934 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9935 ret->refcnt = r->refcnt;
9936 ret->minlen = r->minlen;
9937 ret->prelen = r->prelen;
9938 ret->nparens = r->nparens;
9939 ret->lastparen = r->lastparen;
9940 ret->lastcloseparen = r->lastcloseparen;
9941 ret->reganch = r->reganch;
9943 ret->sublen = r->sublen;
9945 if (RX_MATCH_COPIED(ret))
9946 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9948 ret->subbeg = Nullch;
9949 #ifdef PERL_OLD_COPY_ON_WRITE
9950 ret->saved_copy = Nullsv;
9953 ptr_table_store(PL_ptr_table, r, ret);
9957 /* duplicate a file handle */
9960 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9964 PERL_UNUSED_ARG(type);
9967 return (PerlIO*)NULL;
9969 /* look for it in the table first */
9970 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9974 /* create anew and remember what it is */
9975 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9976 ptr_table_store(PL_ptr_table, fp, ret);
9980 /* duplicate a directory handle */
9983 Perl_dirp_dup(pTHX_ DIR *dp)
9991 /* duplicate a typeglob */
9994 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9999 /* look for it in the table first */
10000 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10004 /* create anew and remember what it is */
10006 ptr_table_store(PL_ptr_table, gp, ret);
10009 ret->gp_refcnt = 0; /* must be before any other dups! */
10010 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10011 ret->gp_io = io_dup_inc(gp->gp_io, param);
10012 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10013 ret->gp_av = av_dup_inc(gp->gp_av, param);
10014 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10015 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10016 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10017 ret->gp_cvgen = gp->gp_cvgen;
10018 ret->gp_line = gp->gp_line;
10019 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10023 /* duplicate a chain of magic */
10026 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10028 MAGIC *mgprev = (MAGIC*)NULL;
10031 return (MAGIC*)NULL;
10032 /* look for it in the table first */
10033 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10037 for (; mg; mg = mg->mg_moremagic) {
10039 Newxz(nmg, 1, MAGIC);
10041 mgprev->mg_moremagic = nmg;
10044 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10045 nmg->mg_private = mg->mg_private;
10046 nmg->mg_type = mg->mg_type;
10047 nmg->mg_flags = mg->mg_flags;
10048 if (mg->mg_type == PERL_MAGIC_qr) {
10049 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10051 else if(mg->mg_type == PERL_MAGIC_backref) {
10052 const AV * const av = (AV*) mg->mg_obj;
10055 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10057 for (i = AvFILLp(av); i >= 0; i--) {
10058 if (!svp[i]) continue;
10059 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10062 else if (mg->mg_type == PERL_MAGIC_symtab) {
10063 nmg->mg_obj = mg->mg_obj;
10066 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10067 ? sv_dup_inc(mg->mg_obj, param)
10068 : sv_dup(mg->mg_obj, param);
10070 nmg->mg_len = mg->mg_len;
10071 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10072 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10073 if (mg->mg_len > 0) {
10074 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10075 if (mg->mg_type == PERL_MAGIC_overload_table &&
10076 AMT_AMAGIC((AMT*)mg->mg_ptr))
10078 AMT *amtp = (AMT*)mg->mg_ptr;
10079 AMT *namtp = (AMT*)nmg->mg_ptr;
10081 for (i = 1; i < NofAMmeth; i++) {
10082 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10086 else if (mg->mg_len == HEf_SVKEY)
10087 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10089 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10090 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10097 /* create a new pointer-mapping table */
10100 Perl_ptr_table_new(pTHX)
10103 Newxz(tbl, 1, PTR_TBL_t);
10104 tbl->tbl_max = 511;
10105 tbl->tbl_items = 0;
10106 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10111 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10113 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10116 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
10118 /* map an existing pointer using a table */
10121 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10123 PTR_TBL_ENT_t *tblent;
10124 const UV hash = PTR_TABLE_HASH(sv);
10126 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10127 for (; tblent; tblent = tblent->next) {
10128 if (tblent->oldval == sv)
10129 return tblent->newval;
10131 return (void*)NULL;
10134 /* add a new entry to a pointer-mapping table */
10137 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldv, void *newv)
10139 PTR_TBL_ENT_t *tblent, **otblent;
10140 /* XXX this may be pessimal on platforms where pointers aren't good
10141 * hash values e.g. if they grow faster in the most significant
10143 const UV hash = PTR_TABLE_HASH(oldv);
10147 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10148 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10149 if (tblent->oldval == oldv) {
10150 tblent->newval = newv;
10154 new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
10155 sizeof(struct ptr_tbl_ent));
10156 tblent->oldval = oldv;
10157 tblent->newval = newv;
10158 tblent->next = *otblent;
10161 if (!empty && tbl->tbl_items > tbl->tbl_max)
10162 ptr_table_split(tbl);
10165 /* double the hash bucket size of an existing ptr table */
10168 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10170 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10171 const UV oldsize = tbl->tbl_max + 1;
10172 UV newsize = oldsize * 2;
10175 Renew(ary, newsize, PTR_TBL_ENT_t*);
10176 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10177 tbl->tbl_max = --newsize;
10178 tbl->tbl_ary = ary;
10179 for (i=0; i < oldsize; i++, ary++) {
10180 PTR_TBL_ENT_t **curentp, **entp, *ent;
10183 curentp = ary + oldsize;
10184 for (entp = ary, ent = *ary; ent; ent = *entp) {
10185 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10187 ent->next = *curentp;
10197 /* remove all the entries from a ptr table */
10200 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10202 register PTR_TBL_ENT_t **array;
10203 register PTR_TBL_ENT_t *entry;
10207 if (!tbl || !tbl->tbl_items) {
10211 array = tbl->tbl_ary;
10213 max = tbl->tbl_max;
10217 PTR_TBL_ENT_t *oentry = entry;
10218 entry = entry->next;
10222 if (++riter > max) {
10225 entry = array[riter];
10229 tbl->tbl_items = 0;
10232 /* clear and free a ptr table */
10235 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10240 ptr_table_clear(tbl);
10241 Safefree(tbl->tbl_ary);
10247 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10250 SvRV_set(dstr, SvWEAKREF(sstr)
10251 ? sv_dup(SvRV(sstr), param)
10252 : sv_dup_inc(SvRV(sstr), param));
10255 else if (SvPVX_const(sstr)) {
10256 /* Has something there */
10258 /* Normal PV - clone whole allocated space */
10259 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10260 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10261 /* Not that normal - actually sstr is copy on write.
10262 But we are a true, independant SV, so: */
10263 SvREADONLY_off(dstr);
10268 /* Special case - not normally malloced for some reason */
10269 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10270 /* A "shared" PV - clone it as "shared" PV */
10272 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10276 /* Some other special case - random pointer */
10277 SvPV_set(dstr, SvPVX(sstr));
10282 /* Copy the Null */
10283 if (SvTYPE(dstr) == SVt_RV)
10284 SvRV_set(dstr, NULL);
10290 /* duplicate an SV of any type (including AV, HV etc) */
10293 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10298 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10300 /* look for it in the table first */
10301 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10305 if(param->flags & CLONEf_JOIN_IN) {
10306 /** We are joining here so we don't want do clone
10307 something that is bad **/
10308 const char *hvname;
10310 if(SvTYPE(sstr) == SVt_PVHV &&
10311 (hvname = HvNAME_get(sstr))) {
10312 /** don't clone stashes if they already exist **/
10313 HV* old_stash = gv_stashpv(hvname,0);
10314 return (SV*) old_stash;
10318 /* create anew and remember what it is */
10321 #ifdef DEBUG_LEAKING_SCALARS
10322 dstr->sv_debug_optype = sstr->sv_debug_optype;
10323 dstr->sv_debug_line = sstr->sv_debug_line;
10324 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10325 dstr->sv_debug_cloned = 1;
10327 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10329 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10333 ptr_table_store(PL_ptr_table, sstr, dstr);
10336 SvFLAGS(dstr) = SvFLAGS(sstr);
10337 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10338 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10341 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10342 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10343 PL_watch_pvx, SvPVX_const(sstr));
10346 /* don't clone objects whose class has asked us not to */
10347 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10348 SvFLAGS(dstr) &= ~SVTYPEMASK;
10349 SvOBJECT_off(dstr);
10353 switch (SvTYPE(sstr)) {
10355 SvANY(dstr) = NULL;
10358 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10359 SvIV_set(dstr, SvIVX(sstr));
10362 SvANY(dstr) = new_XNV();
10363 SvNV_set(dstr, SvNVX(sstr));
10366 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10367 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10371 /* These are all the types that need complex bodies allocating. */
10372 size_t new_body_length;
10373 size_t new_body_offset = 0;
10374 void **new_body_arena;
10375 void **new_body_arenaroot;
10378 switch (SvTYPE(sstr)) {
10380 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10385 new_body = new_XPVIO();
10386 new_body_length = sizeof(XPVIO);
10389 new_body = new_XPVFM();
10390 new_body_length = sizeof(XPVFM);
10394 new_body_arena = (void **) &PL_xpvhv_root;
10395 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10396 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10397 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10398 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10399 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10403 new_body_arena = (void **) &PL_xpvav_root;
10404 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10405 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10406 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10407 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10408 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10412 new_body_length = sizeof(XPVBM);
10413 new_body_arena = (void **) &PL_xpvbm_root;
10414 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10417 if (GvUNIQUE((GV*)sstr)) {
10418 /* Do sharing here. */
10420 new_body_length = sizeof(XPVGV);
10421 new_body_arena = (void **) &PL_xpvgv_root;
10422 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10425 new_body_length = sizeof(XPVCV);
10426 new_body_arena = (void **) &PL_xpvcv_root;
10427 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10430 new_body_length = sizeof(XPVLV);
10431 new_body_arena = (void **) &PL_xpvlv_root;
10432 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10435 new_body_length = sizeof(XPVMG);
10436 new_body_arena = (void **) &PL_xpvmg_root;
10437 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10440 new_body_length = sizeof(XPVNV);
10441 new_body_arena = (void **) &PL_xpvnv_root;
10442 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10445 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10446 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10447 new_body_length = sizeof(XPVIV) - new_body_offset;
10448 new_body_arena = (void **) &PL_xpviv_root;
10449 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10452 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10453 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10454 new_body_length = sizeof(XPV) - new_body_offset;
10455 new_body_arena = (void **) &PL_xpv_root;
10456 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10458 assert(new_body_length);
10460 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10462 new_body = (void*)((char*)new_body - new_body_offset);
10464 /* We always allocated the full length item with PURIFY */
10465 new_body_length += new_body_offset;
10466 new_body_offset = 0;
10467 new_body = my_safemalloc(new_body_length);
10471 SvANY(dstr) = new_body;
10473 Copy(((char*)SvANY(sstr)) + new_body_offset,
10474 ((char*)SvANY(dstr)) + new_body_offset,
10475 new_body_length, char);
10477 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10478 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10480 /* The Copy above means that all the source (unduplicated) pointers
10481 are now in the destination. We can check the flags and the
10482 pointers in either, but it's possible that there's less cache
10483 missing by always going for the destination.
10484 FIXME - instrument and check that assumption */
10485 if (SvTYPE(sstr) >= SVt_PVMG) {
10487 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10489 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10492 switch (SvTYPE(sstr)) {
10504 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10505 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10506 LvTARG(dstr) = dstr;
10507 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10508 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10510 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10513 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10514 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10515 /* Don't call sv_add_backref here as it's going to be created
10516 as part of the magic cloning of the symbol table. */
10517 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10518 (void)GpREFCNT_inc(GvGP(dstr));
10521 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10522 if (IoOFP(dstr) == IoIFP(sstr))
10523 IoOFP(dstr) = IoIFP(dstr);
10525 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10526 /* PL_rsfp_filters entries have fake IoDIRP() */
10527 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10528 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10529 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10530 /* I have no idea why fake dirp (rsfps)
10531 should be treated differently but otherwise
10532 we end up with leaks -- sky*/
10533 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10534 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10535 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10537 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10538 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10539 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10541 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10542 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10543 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10546 if (AvARRAY((AV*)sstr)) {
10547 SV **dst_ary, **src_ary;
10548 SSize_t items = AvFILLp((AV*)sstr) + 1;
10550 src_ary = AvARRAY((AV*)sstr);
10551 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10552 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10553 SvPV_set(dstr, (char*)dst_ary);
10554 AvALLOC((AV*)dstr) = dst_ary;
10555 if (AvREAL((AV*)sstr)) {
10556 while (items-- > 0)
10557 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10560 while (items-- > 0)
10561 *dst_ary++ = sv_dup(*src_ary++, param);
10563 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10564 while (items-- > 0) {
10565 *dst_ary++ = &PL_sv_undef;
10569 SvPV_set(dstr, Nullch);
10570 AvALLOC((AV*)dstr) = (SV**)NULL;
10577 if (HvARRAY((HV*)sstr)) {
10579 const bool sharekeys = !!HvSHAREKEYS(sstr);
10580 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10581 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10583 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10584 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10586 HvARRAY(dstr) = (HE**)darray;
10587 while (i <= sxhv->xhv_max) {
10588 HE *source = HvARRAY(sstr)[i];
10589 HvARRAY(dstr)[i] = source
10590 ? he_dup(source, sharekeys, param) : 0;
10594 struct xpvhv_aux *saux = HvAUX(sstr);
10595 struct xpvhv_aux *daux = HvAUX(dstr);
10596 /* This flag isn't copied. */
10597 /* SvOOK_on(hv) attacks the IV flags. */
10598 SvFLAGS(dstr) |= SVf_OOK;
10600 hvname = saux->xhv_name;
10602 = hvname ? hek_dup(hvname, param) : hvname;
10604 daux->xhv_riter = saux->xhv_riter;
10605 daux->xhv_eiter = saux->xhv_eiter
10606 ? he_dup(saux->xhv_eiter,
10607 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10611 SvPV_set(dstr, Nullch);
10613 /* Record stashes for possible cloning in Perl_clone(). */
10615 av_push(param->stashes, dstr);
10620 /* NOTE: not refcounted */
10621 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10623 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10625 if (CvCONST(dstr)) {
10626 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10627 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10628 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10630 /* don't dup if copying back - CvGV isn't refcounted, so the
10631 * duped GV may never be freed. A bit of a hack! DAPM */
10632 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10633 Nullgv : gv_dup(CvGV(dstr), param) ;
10634 if (!(param->flags & CLONEf_COPY_STACKS)) {
10637 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10639 CvWEAKOUTSIDE(sstr)
10640 ? cv_dup( CvOUTSIDE(dstr), param)
10641 : cv_dup_inc(CvOUTSIDE(dstr), param);
10643 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10649 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10655 /* duplicate a context */
10658 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10660 PERL_CONTEXT *ncxs;
10663 return (PERL_CONTEXT*)NULL;
10665 /* look for it in the table first */
10666 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10670 /* create anew and remember what it is */
10671 Newxz(ncxs, max + 1, PERL_CONTEXT);
10672 ptr_table_store(PL_ptr_table, cxs, ncxs);
10675 PERL_CONTEXT *cx = &cxs[ix];
10676 PERL_CONTEXT *ncx = &ncxs[ix];
10677 ncx->cx_type = cx->cx_type;
10678 if (CxTYPE(cx) == CXt_SUBST) {
10679 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10682 ncx->blk_oldsp = cx->blk_oldsp;
10683 ncx->blk_oldcop = cx->blk_oldcop;
10684 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10685 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10686 ncx->blk_oldpm = cx->blk_oldpm;
10687 ncx->blk_gimme = cx->blk_gimme;
10688 switch (CxTYPE(cx)) {
10690 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10691 ? cv_dup_inc(cx->blk_sub.cv, param)
10692 : cv_dup(cx->blk_sub.cv,param));
10693 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10694 ? av_dup_inc(cx->blk_sub.argarray, param)
10696 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10697 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10698 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10699 ncx->blk_sub.lval = cx->blk_sub.lval;
10700 ncx->blk_sub.retop = cx->blk_sub.retop;
10703 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10704 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10705 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10706 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10707 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10708 ncx->blk_eval.retop = cx->blk_eval.retop;
10711 ncx->blk_loop.label = cx->blk_loop.label;
10712 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10713 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10714 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10715 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10716 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10717 ? cx->blk_loop.iterdata
10718 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10719 ncx->blk_loop.oldcomppad
10720 = (PAD*)ptr_table_fetch(PL_ptr_table,
10721 cx->blk_loop.oldcomppad);
10722 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10723 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10724 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10725 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10726 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10729 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10730 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10731 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10732 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10733 ncx->blk_sub.retop = cx->blk_sub.retop;
10745 /* duplicate a stack info structure */
10748 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10753 return (PERL_SI*)NULL;
10755 /* look for it in the table first */
10756 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10760 /* create anew and remember what it is */
10761 Newxz(nsi, 1, PERL_SI);
10762 ptr_table_store(PL_ptr_table, si, nsi);
10764 nsi->si_stack = av_dup_inc(si->si_stack, param);
10765 nsi->si_cxix = si->si_cxix;
10766 nsi->si_cxmax = si->si_cxmax;
10767 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10768 nsi->si_type = si->si_type;
10769 nsi->si_prev = si_dup(si->si_prev, param);
10770 nsi->si_next = si_dup(si->si_next, param);
10771 nsi->si_markoff = si->si_markoff;
10776 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10777 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10778 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10779 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10780 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10781 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10782 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10783 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10784 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10785 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10786 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10787 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10788 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10789 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10792 #define pv_dup_inc(p) SAVEPV(p)
10793 #define pv_dup(p) SAVEPV(p)
10794 #define svp_dup_inc(p,pp) any_dup(p,pp)
10796 /* map any object to the new equivent - either something in the
10797 * ptr table, or something in the interpreter structure
10801 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10806 return (void*)NULL;
10808 /* look for it in the table first */
10809 ret = ptr_table_fetch(PL_ptr_table, v);
10813 /* see if it is part of the interpreter structure */
10814 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10815 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10823 /* duplicate the save stack */
10826 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10828 ANY * const ss = proto_perl->Tsavestack;
10829 const I32 max = proto_perl->Tsavestack_max;
10830 I32 ix = proto_perl->Tsavestack_ix;
10842 void (*dptr) (void*);
10843 void (*dxptr) (pTHX_ void*);
10845 Newxz(nss, max, ANY);
10848 I32 i = POPINT(ss,ix);
10849 TOPINT(nss,ix) = i;
10851 case SAVEt_ITEM: /* normal string */
10852 sv = (SV*)POPPTR(ss,ix);
10853 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10854 sv = (SV*)POPPTR(ss,ix);
10855 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10857 case SAVEt_SV: /* scalar reference */
10858 sv = (SV*)POPPTR(ss,ix);
10859 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10860 gv = (GV*)POPPTR(ss,ix);
10861 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10863 case SAVEt_GENERIC_PVREF: /* generic char* */
10864 c = (char*)POPPTR(ss,ix);
10865 TOPPTR(nss,ix) = pv_dup(c);
10866 ptr = POPPTR(ss,ix);
10867 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10869 case SAVEt_SHARED_PVREF: /* char* in shared space */
10870 c = (char*)POPPTR(ss,ix);
10871 TOPPTR(nss,ix) = savesharedpv(c);
10872 ptr = POPPTR(ss,ix);
10873 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10875 case SAVEt_GENERIC_SVREF: /* generic sv */
10876 case SAVEt_SVREF: /* scalar reference */
10877 sv = (SV*)POPPTR(ss,ix);
10878 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10879 ptr = POPPTR(ss,ix);
10880 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10882 case SAVEt_AV: /* array reference */
10883 av = (AV*)POPPTR(ss,ix);
10884 TOPPTR(nss,ix) = av_dup_inc(av, param);
10885 gv = (GV*)POPPTR(ss,ix);
10886 TOPPTR(nss,ix) = gv_dup(gv, param);
10888 case SAVEt_HV: /* hash reference */
10889 hv = (HV*)POPPTR(ss,ix);
10890 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10891 gv = (GV*)POPPTR(ss,ix);
10892 TOPPTR(nss,ix) = gv_dup(gv, param);
10894 case SAVEt_INT: /* int reference */
10895 ptr = POPPTR(ss,ix);
10896 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10897 intval = (int)POPINT(ss,ix);
10898 TOPINT(nss,ix) = intval;
10900 case SAVEt_LONG: /* long reference */
10901 ptr = POPPTR(ss,ix);
10902 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10903 longval = (long)POPLONG(ss,ix);
10904 TOPLONG(nss,ix) = longval;
10906 case SAVEt_I32: /* I32 reference */
10907 case SAVEt_I16: /* I16 reference */
10908 case SAVEt_I8: /* I8 reference */
10909 ptr = POPPTR(ss,ix);
10910 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10912 TOPINT(nss,ix) = i;
10914 case SAVEt_IV: /* IV reference */
10915 ptr = POPPTR(ss,ix);
10916 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10918 TOPIV(nss,ix) = iv;
10920 case SAVEt_SPTR: /* SV* reference */
10921 ptr = POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10923 sv = (SV*)POPPTR(ss,ix);
10924 TOPPTR(nss,ix) = sv_dup(sv, param);
10926 case SAVEt_VPTR: /* random* reference */
10927 ptr = POPPTR(ss,ix);
10928 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10929 ptr = POPPTR(ss,ix);
10930 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10932 case SAVEt_PPTR: /* char* reference */
10933 ptr = POPPTR(ss,ix);
10934 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10935 c = (char*)POPPTR(ss,ix);
10936 TOPPTR(nss,ix) = pv_dup(c);
10938 case SAVEt_HPTR: /* HV* reference */
10939 ptr = POPPTR(ss,ix);
10940 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10941 hv = (HV*)POPPTR(ss,ix);
10942 TOPPTR(nss,ix) = hv_dup(hv, param);
10944 case SAVEt_APTR: /* AV* reference */
10945 ptr = POPPTR(ss,ix);
10946 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10947 av = (AV*)POPPTR(ss,ix);
10948 TOPPTR(nss,ix) = av_dup(av, param);
10951 gv = (GV*)POPPTR(ss,ix);
10952 TOPPTR(nss,ix) = gv_dup(gv, param);
10954 case SAVEt_GP: /* scalar reference */
10955 gp = (GP*)POPPTR(ss,ix);
10956 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10957 (void)GpREFCNT_inc(gp);
10958 gv = (GV*)POPPTR(ss,ix);
10959 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10960 c = (char*)POPPTR(ss,ix);
10961 TOPPTR(nss,ix) = pv_dup(c);
10963 TOPIV(nss,ix) = iv;
10965 TOPIV(nss,ix) = iv;
10968 case SAVEt_MORTALIZESV:
10969 sv = (SV*)POPPTR(ss,ix);
10970 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10973 ptr = POPPTR(ss,ix);
10974 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10975 /* these are assumed to be refcounted properly */
10977 switch (((OP*)ptr)->op_type) {
10979 case OP_LEAVESUBLV:
10983 case OP_LEAVEWRITE:
10984 TOPPTR(nss,ix) = ptr;
10989 TOPPTR(nss,ix) = Nullop;
10994 TOPPTR(nss,ix) = Nullop;
10997 c = (char*)POPPTR(ss,ix);
10998 TOPPTR(nss,ix) = pv_dup_inc(c);
11000 case SAVEt_CLEARSV:
11001 longval = POPLONG(ss,ix);
11002 TOPLONG(nss,ix) = longval;
11005 hv = (HV*)POPPTR(ss,ix);
11006 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11007 c = (char*)POPPTR(ss,ix);
11008 TOPPTR(nss,ix) = pv_dup_inc(c);
11010 TOPINT(nss,ix) = i;
11012 case SAVEt_DESTRUCTOR:
11013 ptr = POPPTR(ss,ix);
11014 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11015 dptr = POPDPTR(ss,ix);
11016 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11017 any_dup(FPTR2DPTR(void *, dptr),
11020 case SAVEt_DESTRUCTOR_X:
11021 ptr = POPPTR(ss,ix);
11022 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11023 dxptr = POPDXPTR(ss,ix);
11024 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11025 any_dup(FPTR2DPTR(void *, dxptr),
11028 case SAVEt_REGCONTEXT:
11031 TOPINT(nss,ix) = i;
11034 case SAVEt_STACK_POS: /* Position on Perl stack */
11036 TOPINT(nss,ix) = i;
11038 case SAVEt_AELEM: /* array element */
11039 sv = (SV*)POPPTR(ss,ix);
11040 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11042 TOPINT(nss,ix) = i;
11043 av = (AV*)POPPTR(ss,ix);
11044 TOPPTR(nss,ix) = av_dup_inc(av, param);
11046 case SAVEt_HELEM: /* hash element */
11047 sv = (SV*)POPPTR(ss,ix);
11048 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11049 sv = (SV*)POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11051 hv = (HV*)POPPTR(ss,ix);
11052 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11055 ptr = POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = ptr;
11060 TOPINT(nss,ix) = i;
11062 case SAVEt_COMPPAD:
11063 av = (AV*)POPPTR(ss,ix);
11064 TOPPTR(nss,ix) = av_dup(av, param);
11067 longval = (long)POPLONG(ss,ix);
11068 TOPLONG(nss,ix) = longval;
11069 ptr = POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11071 sv = (SV*)POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = sv_dup(sv, param);
11075 ptr = POPPTR(ss,ix);
11076 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11077 longval = (long)POPBOOL(ss,ix);
11078 TOPBOOL(nss,ix) = (bool)longval;
11080 case SAVEt_SET_SVFLAGS:
11082 TOPINT(nss,ix) = i;
11084 TOPINT(nss,ix) = i;
11085 sv = (SV*)POPPTR(ss,ix);
11086 TOPPTR(nss,ix) = sv_dup(sv, param);
11089 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11097 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11098 * flag to the result. This is done for each stash before cloning starts,
11099 * so we know which stashes want their objects cloned */
11102 do_mark_cloneable_stash(pTHX_ SV *sv)
11104 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11106 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11107 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11108 if (cloner && GvCV(cloner)) {
11115 XPUSHs(sv_2mortal(newSVhek(hvname)));
11117 call_sv((SV*)GvCV(cloner), G_SCALAR);
11124 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11132 =for apidoc perl_clone
11134 Create and return a new interpreter by cloning the current one.
11136 perl_clone takes these flags as parameters:
11138 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11139 without it we only clone the data and zero the stacks,
11140 with it we copy the stacks and the new perl interpreter is
11141 ready to run at the exact same point as the previous one.
11142 The pseudo-fork code uses COPY_STACKS while the
11143 threads->new doesn't.
11145 CLONEf_KEEP_PTR_TABLE
11146 perl_clone keeps a ptr_table with the pointer of the old
11147 variable as a key and the new variable as a value,
11148 this allows it to check if something has been cloned and not
11149 clone it again but rather just use the value and increase the
11150 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11151 the ptr_table using the function
11152 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11153 reason to keep it around is if you want to dup some of your own
11154 variable who are outside the graph perl scans, example of this
11155 code is in threads.xs create
11158 This is a win32 thing, it is ignored on unix, it tells perls
11159 win32host code (which is c++) to clone itself, this is needed on
11160 win32 if you want to run two threads at the same time,
11161 if you just want to do some stuff in a separate perl interpreter
11162 and then throw it away and return to the original one,
11163 you don't need to do anything.
11168 /* XXX the above needs expanding by someone who actually understands it ! */
11169 EXTERN_C PerlInterpreter *
11170 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11173 perl_clone(PerlInterpreter *proto_perl, UV flags)
11176 #ifdef PERL_IMPLICIT_SYS
11178 /* perlhost.h so we need to call into it
11179 to clone the host, CPerlHost should have a c interface, sky */
11181 if (flags & CLONEf_CLONE_HOST) {
11182 return perl_clone_host(proto_perl,flags);
11184 return perl_clone_using(proto_perl, flags,
11186 proto_perl->IMemShared,
11187 proto_perl->IMemParse,
11189 proto_perl->IStdIO,
11193 proto_perl->IProc);
11197 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11198 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11199 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11200 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11201 struct IPerlDir* ipD, struct IPerlSock* ipS,
11202 struct IPerlProc* ipP)
11204 /* XXX many of the string copies here can be optimized if they're
11205 * constants; they need to be allocated as common memory and just
11206 * their pointers copied. */
11209 CLONE_PARAMS clone_params;
11210 CLONE_PARAMS* param = &clone_params;
11212 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11213 /* for each stash, determine whether its objects should be cloned */
11214 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11215 PERL_SET_THX(my_perl);
11218 Poison(my_perl, 1, PerlInterpreter);
11220 PL_curcop = (COP *)Nullop;
11224 PL_savestack_ix = 0;
11225 PL_savestack_max = -1;
11226 PL_sig_pending = 0;
11227 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11228 # else /* !DEBUGGING */
11229 Zero(my_perl, 1, PerlInterpreter);
11230 # endif /* DEBUGGING */
11232 /* host pointers */
11234 PL_MemShared = ipMS;
11235 PL_MemParse = ipMP;
11242 #else /* !PERL_IMPLICIT_SYS */
11244 CLONE_PARAMS clone_params;
11245 CLONE_PARAMS* param = &clone_params;
11246 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11247 /* for each stash, determine whether its objects should be cloned */
11248 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11249 PERL_SET_THX(my_perl);
11252 Poison(my_perl, 1, PerlInterpreter);
11254 PL_curcop = (COP *)Nullop;
11258 PL_savestack_ix = 0;
11259 PL_savestack_max = -1;
11260 PL_sig_pending = 0;
11261 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11262 # else /* !DEBUGGING */
11263 Zero(my_perl, 1, PerlInterpreter);
11264 # endif /* DEBUGGING */
11265 #endif /* PERL_IMPLICIT_SYS */
11266 param->flags = flags;
11267 param->proto_perl = proto_perl;
11270 PL_xnv_arenaroot = NULL;
11271 PL_xnv_root = NULL;
11272 PL_xpv_arenaroot = NULL;
11273 PL_xpv_root = NULL;
11274 PL_xpviv_arenaroot = NULL;
11275 PL_xpviv_root = NULL;
11276 PL_xpvnv_arenaroot = NULL;
11277 PL_xpvnv_root = NULL;
11278 PL_xpvcv_arenaroot = NULL;
11279 PL_xpvcv_root = NULL;
11280 PL_xpvav_arenaroot = NULL;
11281 PL_xpvav_root = NULL;
11282 PL_xpvhv_arenaroot = NULL;
11283 PL_xpvhv_root = NULL;
11284 PL_xpvmg_arenaroot = NULL;
11285 PL_xpvmg_root = NULL;
11286 PL_xpvgv_arenaroot = NULL;
11287 PL_xpvgv_root = NULL;
11288 PL_xpvlv_arenaroot = NULL;
11289 PL_xpvlv_root = NULL;
11290 PL_xpvbm_arenaroot = NULL;
11291 PL_xpvbm_root = NULL;
11292 PL_he_arenaroot = NULL;
11294 #if defined(USE_ITHREADS)
11295 PL_pte_arenaroot = NULL;
11296 PL_pte_root = NULL;
11298 PL_nice_chunk = NULL;
11299 PL_nice_chunk_size = 0;
11301 PL_sv_objcount = 0;
11302 PL_sv_root = Nullsv;
11303 PL_sv_arenaroot = Nullsv;
11305 PL_debug = proto_perl->Idebug;
11307 PL_hash_seed = proto_perl->Ihash_seed;
11308 PL_rehash_seed = proto_perl->Irehash_seed;
11310 #ifdef USE_REENTRANT_API
11311 /* XXX: things like -Dm will segfault here in perlio, but doing
11312 * PERL_SET_CONTEXT(proto_perl);
11313 * breaks too many other things
11315 Perl_reentrant_init(aTHX);
11318 /* create SV map for pointer relocation */
11319 PL_ptr_table = ptr_table_new();
11321 /* initialize these special pointers as early as possible */
11322 SvANY(&PL_sv_undef) = NULL;
11323 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11324 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11325 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11327 SvANY(&PL_sv_no) = new_XPVNV();
11328 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11329 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11330 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11331 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11332 SvCUR_set(&PL_sv_no, 0);
11333 SvLEN_set(&PL_sv_no, 1);
11334 SvIV_set(&PL_sv_no, 0);
11335 SvNV_set(&PL_sv_no, 0);
11336 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11338 SvANY(&PL_sv_yes) = new_XPVNV();
11339 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11340 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11341 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11342 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11343 SvCUR_set(&PL_sv_yes, 1);
11344 SvLEN_set(&PL_sv_yes, 2);
11345 SvIV_set(&PL_sv_yes, 1);
11346 SvNV_set(&PL_sv_yes, 1);
11347 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11349 /* create (a non-shared!) shared string table */
11350 PL_strtab = newHV();
11351 HvSHAREKEYS_off(PL_strtab);
11352 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11353 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11355 PL_compiling = proto_perl->Icompiling;
11357 /* These two PVs will be free'd special way so must set them same way op.c does */
11358 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11359 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11361 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11362 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11364 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11365 if (!specialWARN(PL_compiling.cop_warnings))
11366 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11367 if (!specialCopIO(PL_compiling.cop_io))
11368 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11369 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11371 /* pseudo environmental stuff */
11372 PL_origargc = proto_perl->Iorigargc;
11373 PL_origargv = proto_perl->Iorigargv;
11375 param->stashes = newAV(); /* Setup array of objects to call clone on */
11377 #ifdef PERLIO_LAYERS
11378 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11379 PerlIO_clone(aTHX_ proto_perl, param);
11382 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11383 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11384 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11385 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11386 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11387 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11390 PL_minus_c = proto_perl->Iminus_c;
11391 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11392 PL_localpatches = proto_perl->Ilocalpatches;
11393 PL_splitstr = proto_perl->Isplitstr;
11394 PL_preprocess = proto_perl->Ipreprocess;
11395 PL_minus_n = proto_perl->Iminus_n;
11396 PL_minus_p = proto_perl->Iminus_p;
11397 PL_minus_l = proto_perl->Iminus_l;
11398 PL_minus_a = proto_perl->Iminus_a;
11399 PL_minus_F = proto_perl->Iminus_F;
11400 PL_doswitches = proto_perl->Idoswitches;
11401 PL_dowarn = proto_perl->Idowarn;
11402 PL_doextract = proto_perl->Idoextract;
11403 PL_sawampersand = proto_perl->Isawampersand;
11404 PL_unsafe = proto_perl->Iunsafe;
11405 PL_inplace = SAVEPV(proto_perl->Iinplace);
11406 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11407 PL_perldb = proto_perl->Iperldb;
11408 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11409 PL_exit_flags = proto_perl->Iexit_flags;
11411 /* magical thingies */
11412 /* XXX time(&PL_basetime) when asked for? */
11413 PL_basetime = proto_perl->Ibasetime;
11414 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11416 PL_maxsysfd = proto_perl->Imaxsysfd;
11417 PL_multiline = proto_perl->Imultiline;
11418 PL_statusvalue = proto_perl->Istatusvalue;
11420 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11422 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11424 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11425 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11426 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11428 /* Clone the regex array */
11429 PL_regex_padav = newAV();
11431 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11432 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11434 av_push(PL_regex_padav,
11435 sv_dup_inc(regexen[0],param));
11436 for(i = 1; i <= len; i++) {
11437 if(SvREPADTMP(regexen[i])) {
11438 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11440 av_push(PL_regex_padav,
11442 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11443 SvIVX(regexen[i])), param)))
11448 PL_regex_pad = AvARRAY(PL_regex_padav);
11450 /* shortcuts to various I/O objects */
11451 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11452 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11453 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11454 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11455 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11456 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11458 /* shortcuts to regexp stuff */
11459 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11461 /* shortcuts to misc objects */
11462 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11464 /* shortcuts to debugging objects */
11465 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11466 PL_DBline = gv_dup(proto_perl->IDBline, param);
11467 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11468 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11469 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11470 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11471 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11472 PL_lineary = av_dup(proto_perl->Ilineary, param);
11473 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11475 /* symbol tables */
11476 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11477 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11478 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11479 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11480 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11482 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11483 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11484 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11485 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11486 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11487 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11489 PL_sub_generation = proto_perl->Isub_generation;
11491 /* funky return mechanisms */
11492 PL_forkprocess = proto_perl->Iforkprocess;
11494 /* subprocess state */
11495 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11497 /* internal state */
11498 PL_tainting = proto_perl->Itainting;
11499 PL_taint_warn = proto_perl->Itaint_warn;
11500 PL_maxo = proto_perl->Imaxo;
11501 if (proto_perl->Iop_mask)
11502 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11504 PL_op_mask = Nullch;
11505 /* PL_asserting = proto_perl->Iasserting; */
11507 /* current interpreter roots */
11508 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11509 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11510 PL_main_start = proto_perl->Imain_start;
11511 PL_eval_root = proto_perl->Ieval_root;
11512 PL_eval_start = proto_perl->Ieval_start;
11514 /* runtime control stuff */
11515 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11516 PL_copline = proto_perl->Icopline;
11518 PL_filemode = proto_perl->Ifilemode;
11519 PL_lastfd = proto_perl->Ilastfd;
11520 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11523 PL_gensym = proto_perl->Igensym;
11524 PL_preambled = proto_perl->Ipreambled;
11525 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11526 PL_laststatval = proto_perl->Ilaststatval;
11527 PL_laststype = proto_perl->Ilaststype;
11528 PL_mess_sv = Nullsv;
11530 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11532 /* interpreter atexit processing */
11533 PL_exitlistlen = proto_perl->Iexitlistlen;
11534 if (PL_exitlistlen) {
11535 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11536 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11539 PL_exitlist = (PerlExitListEntry*)NULL;
11540 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11541 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11542 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11544 PL_profiledata = NULL;
11545 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11546 /* PL_rsfp_filters entries have fake IoDIRP() */
11547 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11549 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11551 PAD_CLONE_VARS(proto_perl, param);
11553 #ifdef HAVE_INTERP_INTERN
11554 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11557 /* more statics moved here */
11558 PL_generation = proto_perl->Igeneration;
11559 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11561 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11562 PL_in_clean_all = proto_perl->Iin_clean_all;
11564 PL_uid = proto_perl->Iuid;
11565 PL_euid = proto_perl->Ieuid;
11566 PL_gid = proto_perl->Igid;
11567 PL_egid = proto_perl->Iegid;
11568 PL_nomemok = proto_perl->Inomemok;
11569 PL_an = proto_perl->Ian;
11570 PL_evalseq = proto_perl->Ievalseq;
11571 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11572 PL_origalen = proto_perl->Iorigalen;
11573 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11574 PL_osname = SAVEPV(proto_perl->Iosname);
11575 PL_sighandlerp = proto_perl->Isighandlerp;
11577 PL_runops = proto_perl->Irunops;
11579 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11582 PL_cshlen = proto_perl->Icshlen;
11583 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11586 PL_lex_state = proto_perl->Ilex_state;
11587 PL_lex_defer = proto_perl->Ilex_defer;
11588 PL_lex_expect = proto_perl->Ilex_expect;
11589 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11590 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11591 PL_lex_starts = proto_perl->Ilex_starts;
11592 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11593 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11594 PL_lex_op = proto_perl->Ilex_op;
11595 PL_lex_inpat = proto_perl->Ilex_inpat;
11596 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11597 PL_lex_brackets = proto_perl->Ilex_brackets;
11598 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11599 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11600 PL_lex_casemods = proto_perl->Ilex_casemods;
11601 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11602 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11604 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11605 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11606 PL_nexttoke = proto_perl->Inexttoke;
11608 /* XXX This is probably masking the deeper issue of why
11609 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11610 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11611 * (A little debugging with a watchpoint on it may help.)
11613 if (SvANY(proto_perl->Ilinestr)) {
11614 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11615 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11616 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11617 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11618 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11619 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11620 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11621 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11622 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11625 PL_linestr = NEWSV(65,79);
11626 sv_upgrade(PL_linestr,SVt_PVIV);
11627 sv_setpvn(PL_linestr,"",0);
11628 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11630 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11631 PL_pending_ident = proto_perl->Ipending_ident;
11632 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11634 PL_expect = proto_perl->Iexpect;
11636 PL_multi_start = proto_perl->Imulti_start;
11637 PL_multi_end = proto_perl->Imulti_end;
11638 PL_multi_open = proto_perl->Imulti_open;
11639 PL_multi_close = proto_perl->Imulti_close;
11641 PL_error_count = proto_perl->Ierror_count;
11642 PL_subline = proto_perl->Isubline;
11643 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11645 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11646 if (SvANY(proto_perl->Ilinestr)) {
11647 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11648 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11649 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11650 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11651 PL_last_lop_op = proto_perl->Ilast_lop_op;
11654 PL_last_uni = SvPVX(PL_linestr);
11655 PL_last_lop = SvPVX(PL_linestr);
11656 PL_last_lop_op = 0;
11658 PL_in_my = proto_perl->Iin_my;
11659 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11661 PL_cryptseen = proto_perl->Icryptseen;
11664 PL_hints = proto_perl->Ihints;
11666 PL_amagic_generation = proto_perl->Iamagic_generation;
11668 #ifdef USE_LOCALE_COLLATE
11669 PL_collation_ix = proto_perl->Icollation_ix;
11670 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11671 PL_collation_standard = proto_perl->Icollation_standard;
11672 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11673 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11674 #endif /* USE_LOCALE_COLLATE */
11676 #ifdef USE_LOCALE_NUMERIC
11677 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11678 PL_numeric_standard = proto_perl->Inumeric_standard;
11679 PL_numeric_local = proto_perl->Inumeric_local;
11680 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11681 #endif /* !USE_LOCALE_NUMERIC */
11683 /* utf8 character classes */
11684 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11685 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11686 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11687 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11688 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11689 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11690 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11691 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11692 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11693 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11694 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11695 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11696 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11697 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11698 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11699 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11700 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11701 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11702 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11703 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11705 /* Did the locale setup indicate UTF-8? */
11706 PL_utf8locale = proto_perl->Iutf8locale;
11707 /* Unicode features (see perlrun/-C) */
11708 PL_unicode = proto_perl->Iunicode;
11710 /* Pre-5.8 signals control */
11711 PL_signals = proto_perl->Isignals;
11713 /* times() ticks per second */
11714 PL_clocktick = proto_perl->Iclocktick;
11716 /* Recursion stopper for PerlIO_find_layer */
11717 PL_in_load_module = proto_perl->Iin_load_module;
11719 /* sort() routine */
11720 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11722 /* Not really needed/useful since the reenrant_retint is "volatile",
11723 * but do it for consistency's sake. */
11724 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11726 /* Hooks to shared SVs and locks. */
11727 PL_sharehook = proto_perl->Isharehook;
11728 PL_lockhook = proto_perl->Ilockhook;
11729 PL_unlockhook = proto_perl->Iunlockhook;
11730 PL_threadhook = proto_perl->Ithreadhook;
11732 PL_runops_std = proto_perl->Irunops_std;
11733 PL_runops_dbg = proto_perl->Irunops_dbg;
11735 #ifdef THREADS_HAVE_PIDS
11736 PL_ppid = proto_perl->Ippid;
11740 PL_last_swash_hv = Nullhv; /* reinits on demand */
11741 PL_last_swash_klen = 0;
11742 PL_last_swash_key[0]= '\0';
11743 PL_last_swash_tmps = (U8*)NULL;
11744 PL_last_swash_slen = 0;
11746 PL_glob_index = proto_perl->Iglob_index;
11747 PL_srand_called = proto_perl->Isrand_called;
11748 PL_uudmap['M'] = 0; /* reinits on demand */
11749 PL_bitcount = Nullch; /* reinits on demand */
11751 if (proto_perl->Ipsig_pend) {
11752 Newxz(PL_psig_pend, SIG_SIZE, int);
11755 PL_psig_pend = (int*)NULL;
11758 if (proto_perl->Ipsig_ptr) {
11759 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11760 Newxz(PL_psig_name, SIG_SIZE, SV*);
11761 for (i = 1; i < SIG_SIZE; i++) {
11762 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11763 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11767 PL_psig_ptr = (SV**)NULL;
11768 PL_psig_name = (SV**)NULL;
11771 /* thrdvar.h stuff */
11773 if (flags & CLONEf_COPY_STACKS) {
11774 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11775 PL_tmps_ix = proto_perl->Ttmps_ix;
11776 PL_tmps_max = proto_perl->Ttmps_max;
11777 PL_tmps_floor = proto_perl->Ttmps_floor;
11778 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11780 while (i <= PL_tmps_ix) {
11781 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11785 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11786 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11787 Newxz(PL_markstack, i, I32);
11788 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11789 - proto_perl->Tmarkstack);
11790 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11791 - proto_perl->Tmarkstack);
11792 Copy(proto_perl->Tmarkstack, PL_markstack,
11793 PL_markstack_ptr - PL_markstack + 1, I32);
11795 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11796 * NOTE: unlike the others! */
11797 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11798 PL_scopestack_max = proto_perl->Tscopestack_max;
11799 Newxz(PL_scopestack, PL_scopestack_max, I32);
11800 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11802 /* NOTE: si_dup() looks at PL_markstack */
11803 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11805 /* PL_curstack = PL_curstackinfo->si_stack; */
11806 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11807 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11809 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11810 PL_stack_base = AvARRAY(PL_curstack);
11811 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11812 - proto_perl->Tstack_base);
11813 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11815 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11816 * NOTE: unlike the others! */
11817 PL_savestack_ix = proto_perl->Tsavestack_ix;
11818 PL_savestack_max = proto_perl->Tsavestack_max;
11819 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11820 PL_savestack = ss_dup(proto_perl, param);
11824 ENTER; /* perl_destruct() wants to LEAVE; */
11827 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11828 PL_top_env = &PL_start_env;
11830 PL_op = proto_perl->Top;
11833 PL_Xpv = (XPV*)NULL;
11834 PL_na = proto_perl->Tna;
11836 PL_statbuf = proto_perl->Tstatbuf;
11837 PL_statcache = proto_perl->Tstatcache;
11838 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11839 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11841 PL_timesbuf = proto_perl->Ttimesbuf;
11844 PL_tainted = proto_perl->Ttainted;
11845 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11846 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11847 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11848 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11849 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11850 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11851 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11852 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11853 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11855 PL_restartop = proto_perl->Trestartop;
11856 PL_in_eval = proto_perl->Tin_eval;
11857 PL_delaymagic = proto_perl->Tdelaymagic;
11858 PL_dirty = proto_perl->Tdirty;
11859 PL_localizing = proto_perl->Tlocalizing;
11861 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11862 PL_hv_fetch_ent_mh = Nullhe;
11863 PL_modcount = proto_perl->Tmodcount;
11864 PL_lastgotoprobe = Nullop;
11865 PL_dumpindent = proto_perl->Tdumpindent;
11867 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11868 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11869 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11870 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11871 PL_sortcxix = proto_perl->Tsortcxix;
11872 PL_efloatbuf = Nullch; /* reinits on demand */
11873 PL_efloatsize = 0; /* reinits on demand */
11877 PL_screamfirst = NULL;
11878 PL_screamnext = NULL;
11879 PL_maxscream = -1; /* reinits on demand */
11880 PL_lastscream = Nullsv;
11882 PL_watchaddr = NULL;
11883 PL_watchok = Nullch;
11885 PL_regdummy = proto_perl->Tregdummy;
11886 PL_regprecomp = Nullch;
11889 PL_colorset = 0; /* reinits PL_colors[] */
11890 /*PL_colors[6] = {0,0,0,0,0,0};*/
11891 PL_reginput = Nullch;
11892 PL_regbol = Nullch;
11893 PL_regeol = Nullch;
11894 PL_regstartp = (I32*)NULL;
11895 PL_regendp = (I32*)NULL;
11896 PL_reglastparen = (U32*)NULL;
11897 PL_reglastcloseparen = (U32*)NULL;
11898 PL_regtill = Nullch;
11899 PL_reg_start_tmp = (char**)NULL;
11900 PL_reg_start_tmpl = 0;
11901 PL_regdata = (struct reg_data*)NULL;
11904 PL_reg_eval_set = 0;
11906 PL_regprogram = (regnode*)NULL;
11908 PL_regcc = (CURCUR*)NULL;
11909 PL_reg_call_cc = (struct re_cc_state*)NULL;
11910 PL_reg_re = (regexp*)NULL;
11911 PL_reg_ganch = Nullch;
11912 PL_reg_sv = Nullsv;
11913 PL_reg_match_utf8 = FALSE;
11914 PL_reg_magic = (MAGIC*)NULL;
11916 PL_reg_oldcurpm = (PMOP*)NULL;
11917 PL_reg_curpm = (PMOP*)NULL;
11918 PL_reg_oldsaved = Nullch;
11919 PL_reg_oldsavedlen = 0;
11920 #ifdef PERL_OLD_COPY_ON_WRITE
11923 PL_reg_maxiter = 0;
11924 PL_reg_leftiter = 0;
11925 PL_reg_poscache = Nullch;
11926 PL_reg_poscache_size= 0;
11928 /* RE engine - function pointers */
11929 PL_regcompp = proto_perl->Tregcompp;
11930 PL_regexecp = proto_perl->Tregexecp;
11931 PL_regint_start = proto_perl->Tregint_start;
11932 PL_regint_string = proto_perl->Tregint_string;
11933 PL_regfree = proto_perl->Tregfree;
11935 PL_reginterp_cnt = 0;
11936 PL_reg_starttry = 0;
11938 /* Pluggable optimizer */
11939 PL_peepp = proto_perl->Tpeepp;
11941 PL_stashcache = newHV();
11943 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11944 ptr_table_free(PL_ptr_table);
11945 PL_ptr_table = NULL;
11948 /* Call the ->CLONE method, if it exists, for each of the stashes
11949 identified by sv_dup() above.
11951 while(av_len(param->stashes) != -1) {
11952 HV* const stash = (HV*) av_shift(param->stashes);
11953 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11954 if (cloner && GvCV(cloner)) {
11959 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11961 call_sv((SV*)GvCV(cloner), G_DISCARD);
11967 SvREFCNT_dec(param->stashes);
11969 /* orphaned? eg threads->new inside BEGIN or use */
11970 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11971 (void)SvREFCNT_inc(PL_compcv);
11972 SAVEFREESV(PL_compcv);
11978 #endif /* USE_ITHREADS */
11981 =head1 Unicode Support
11983 =for apidoc sv_recode_to_utf8
11985 The encoding is assumed to be an Encode object, on entry the PV
11986 of the sv is assumed to be octets in that encoding, and the sv
11987 will be converted into Unicode (and UTF-8).
11989 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11990 is not a reference, nothing is done to the sv. If the encoding is not
11991 an C<Encode::XS> Encoding object, bad things will happen.
11992 (See F<lib/encoding.pm> and L<Encode>).
11994 The PV of the sv is returned.
11999 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12002 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12016 Passing sv_yes is wrong - it needs to be or'ed set of constants
12017 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12018 remove converted chars from source.
12020 Both will default the value - let them.
12022 XPUSHs(&PL_sv_yes);
12025 call_method("decode", G_SCALAR);
12029 s = SvPV_const(uni, len);
12030 if (s != SvPVX_const(sv)) {
12031 SvGROW(sv, len + 1);
12032 Move(s, SvPVX(sv), len + 1, char);
12033 SvCUR_set(sv, len);
12040 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12044 =for apidoc sv_cat_decode
12046 The encoding is assumed to be an Encode object, the PV of the ssv is
12047 assumed to be octets in that encoding and decoding the input starts
12048 from the position which (PV + *offset) pointed to. The dsv will be
12049 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12050 when the string tstr appears in decoding output or the input ends on
12051 the PV of the ssv. The value which the offset points will be modified
12052 to the last input position on the ssv.
12054 Returns TRUE if the terminator was found, else returns FALSE.
12059 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12060 SV *ssv, int *offset, char *tstr, int tlen)
12064 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12075 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12076 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12078 call_method("cat_decode", G_SCALAR);
12080 ret = SvTRUE(TOPs);
12081 *offset = SvIV(offsv);
12087 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12093 * c-indentation-style: bsd
12094 * c-basic-offset: 4
12095 * indent-tabs-mode: t
12098 * ex: set ts=8 sts=4 sw=4 noet: