3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 * nice_chunk and nice_chunk size need to be set
170 * and queried under the protection of sv_mutex
173 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
178 new_chunk = (void *)(chunk);
179 new_chunk_size = (chunk_size);
180 if (new_chunk_size > PL_nice_chunk_size) {
181 Safefree(PL_nice_chunk);
182 PL_nice_chunk = (char *) new_chunk;
183 PL_nice_chunk_size = new_chunk_size;
190 #ifdef DEBUG_LEAKING_SCALARS
192 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
194 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
197 # define FREE_SV_DEBUG_FILE(sv)
200 #define plant_SV(p) \
202 FREE_SV_DEBUG_FILE(p); \
203 SvANY(p) = (void *)PL_sv_root; \
204 SvFLAGS(p) = SVTYPEMASK; \
209 /* sv_mutex must be held while calling uproot_SV() */
210 #define uproot_SV(p) \
213 PL_sv_root = (SV*)SvANY(p); \
218 /* make some more SVs by adding another arena */
220 /* sv_mutex must be held while calling more_sv() */
227 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
228 PL_nice_chunk = Nullch;
229 PL_nice_chunk_size = 0;
232 char *chunk; /* must use New here to match call to */
233 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
234 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
240 /* new_SV(): return a new, empty SV head */
242 #ifdef DEBUG_LEAKING_SCALARS
243 /* provide a real function for a debugger to play with */
253 sv = S_more_sv(aTHX);
258 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
259 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
260 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
261 sv->sv_debug_inpad = 0;
262 sv->sv_debug_cloned = 0;
264 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
266 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
309 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
310 const SV * const sv = sva + 1;
311 const SV * const svend = &sva[SvREFCNT(sva)];
312 if (p >= sv && p < svend) {
318 if (ckWARN_d(WARN_INTERNAL))
319 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
320 "Attempt to free non-arena SV: 0x%"UVxf
321 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
328 #else /* ! DEBUGGING */
330 #define del_SV(p) plant_SV(p)
332 #endif /* DEBUGGING */
336 =head1 SV Manipulation Functions
338 =for apidoc sv_add_arena
340 Given a chunk of memory, link it to the head of the list of arenas,
341 and split it into a list of free SVs.
347 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
353 /* The first SV in an arena isn't an SV. */
354 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
355 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
356 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
358 PL_sv_arenaroot = sva;
359 PL_sv_root = sva + 1;
361 svend = &sva[SvREFCNT(sva) - 1];
364 SvANY(sv) = (void *)(SV*)(sv + 1);
368 /* Must always set typemask because it's awlays checked in on cleanup
369 when the arenas are walked looking for objects. */
370 SvFLAGS(sv) = SVTYPEMASK;
377 SvFLAGS(sv) = SVTYPEMASK;
380 /* visit(): call the named function for each non-free SV in the arenas
381 * whose flags field matches the flags/mask args. */
384 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
389 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
390 register const SV * const svend = &sva[SvREFCNT(sva)];
392 for (sv = sva + 1; sv < svend; ++sv) {
393 if (SvTYPE(sv) != SVTYPEMASK
394 && (sv->sv_flags & mask) == flags
407 /* called by sv_report_used() for each live SV */
410 do_report_used(pTHX_ SV *sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
435 /* called by sv_clean_objs() for each live SV */
438 do_clean_objs(pTHX_ SV *ref)
442 if (SvROK(ref) && SvOBJECT(target = SvRV(ref))) {
443 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
444 if (SvWEAKREF(ref)) {
445 sv_del_backref(target, ref);
451 SvREFCNT_dec(target);
455 /* XXX Might want to check arrays, etc. */
458 /* called by sv_clean_objs() for each live SV */
460 #ifndef DISABLE_DESTRUCTOR_KLUDGE
462 do_clean_named_objs(pTHX_ SV *sv)
464 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
466 #ifdef PERL_DONT_CREATE_GVSV
469 SvOBJECT(GvSV(sv))) ||
470 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
471 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
472 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
473 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
475 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
476 SvFLAGS(sv) |= SVf_BREAK;
484 =for apidoc sv_clean_objs
486 Attempt to destroy all objects not yet freed
492 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
508 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
509 SvFLAGS(sv) |= SVf_BREAK;
510 if (PL_comppad == (AV*)sv) {
512 PL_curpad = Null(SV**);
518 =for apidoc sv_clean_all
520 Decrement the refcnt of each remaining SV, possibly triggering a
521 cleanup. This function may have to be called multiple times to free
522 SVs which are in complex self-referential hierarchies.
528 Perl_sv_clean_all(pTHX)
531 PL_in_clean_all = TRUE;
532 cleaned = visit(do_clean_all, 0,0);
533 PL_in_clean_all = FALSE;
538 S_free_arena(pTHX_ void **root) {
540 void ** const next = *(void **)root;
547 =for apidoc sv_free_arenas
549 Deallocate the memory used by all arenas. Note that all the individual SV
550 heads and bodies within the arenas must already have been freed.
555 #define free_arena(name) \
557 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
558 PL_ ## name ## _arenaroot = 0; \
559 PL_ ## name ## _root = 0; \
563 Perl_sv_free_arenas(pTHX)
568 /* Free arenas here, but be careful about fake ones. (We assume
569 contiguity of the fake ones with the corresponding real ones.) */
571 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
572 svanext = (SV*) SvANY(sva);
573 while (svanext && SvFAKE(svanext))
574 svanext = (SV*) SvANY(svanext);
592 #if defined(USE_ITHREADS)
596 Safefree(PL_nice_chunk);
597 PL_nice_chunk = Nullch;
598 PL_nice_chunk_size = 0;
603 /* ---------------------------------------------------------------------
605 * support functions for report_uninit()
608 /* the maxiumum size of array or hash where we will scan looking
609 * for the undefined element that triggered the warning */
611 #define FUV_MAX_SEARCH_SIZE 1000
613 /* Look for an entry in the hash whose value has the same SV as val;
614 * If so, return a mortal copy of the key. */
617 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
623 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
624 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
629 for (i=HvMAX(hv); i>0; i--) {
631 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
632 if (HeVAL(entry) != val)
634 if ( HeVAL(entry) == &PL_sv_undef ||
635 HeVAL(entry) == &PL_sv_placeholder)
639 if (HeKLEN(entry) == HEf_SVKEY)
640 return sv_mortalcopy(HeKEY_sv(entry));
641 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
647 /* Look for an entry in the array whose value has the same SV as val;
648 * If so, return the index, otherwise return -1. */
651 S_find_array_subscript(pTHX_ AV *av, SV* val)
655 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
656 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
660 for (i=AvFILLp(av); i>=0; i--) {
661 if (svp[i] == val && svp[i] != &PL_sv_undef)
667 /* S_varname(): return the name of a variable, optionally with a subscript.
668 * If gv is non-zero, use the name of that global, along with gvtype (one
669 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
670 * targ. Depending on the value of the subscript_type flag, return:
673 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
674 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
675 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
676 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
679 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
680 SV* keyname, I32 aindex, int subscript_type)
683 SV * const name = sv_newmortal();
686 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
687 * XXX get rid of all this if gv_fullnameX() ever supports this
691 HV * const hv = GvSTASH(gv);
694 else if (!(p=HvNAME_get(hv)))
696 if (strEQ(p, "main"))
697 sv_setpvn(name, &gvtype, 1);
699 Perl_sv_setpvf(aTHX_ name, "%c%s::", gvtype, p);
701 if (GvNAMELEN(gv)>= 1 &&
702 ((unsigned int)*GvNAME(gv)) <= 26)
704 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
705 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
708 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
712 CV * const cv = find_runcv(&unused);
716 if (!cv || !CvPADLIST(cv))
718 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
719 sv = *av_fetch(av, targ, FALSE);
720 /* SvLEN in a pad name is not to be trusted */
721 sv_setpv(name, SvPV_nolen_const(sv));
724 if (subscript_type == FUV_SUBSCRIPT_HASH) {
725 SV * const sv = NEWSV(0,0);
727 Perl_sv_catpvf(aTHX_ name, "{%s}",
728 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
731 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
733 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
735 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
736 sv_insert(name, 0, 0, "within ", 7);
743 =for apidoc find_uninit_var
745 Find the name of the undefined variable (if any) that caused the operator o
746 to issue a "Use of uninitialized value" warning.
747 If match is true, only return a name if it's value matches uninit_sv.
748 So roughly speaking, if a unary operator (such as OP_COS) generates a
749 warning, then following the direct child of the op may yield an
750 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
751 other hand, with OP_ADD there are two branches to follow, so we only print
752 the variable name if we get an exact match.
754 The name is returned as a mortal SV.
756 Assumes that PL_op is the op that originally triggered the error, and that
757 PL_comppad/PL_curpad points to the currently executing pad.
763 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
771 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
772 uninit_sv == &PL_sv_placeholder)))
775 switch (obase->op_type) {
782 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
783 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
786 int subscript_type = FUV_SUBSCRIPT_WITHIN;
788 if (pad) { /* @lex, %lex */
789 sv = PAD_SVl(obase->op_targ);
793 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
794 /* @global, %global */
795 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
798 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
800 else /* @{expr}, %{expr} */
801 return find_uninit_var(cUNOPx(obase)->op_first,
805 /* attempt to find a match within the aggregate */
807 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
809 subscript_type = FUV_SUBSCRIPT_HASH;
812 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
814 subscript_type = FUV_SUBSCRIPT_ARRAY;
817 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
820 return varname(gv, hash ? '%' : '@', obase->op_targ,
821 keysv, index, subscript_type);
825 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
827 return varname(Nullgv, '$', obase->op_targ,
828 Nullsv, 0, FUV_SUBSCRIPT_NONE);
831 gv = cGVOPx_gv(obase);
832 if (!gv || (match && GvSV(gv) != uninit_sv))
834 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
837 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
840 av = (AV*)PAD_SV(obase->op_targ);
841 if (!av || SvRMAGICAL(av))
843 svp = av_fetch(av, (I32)obase->op_private, FALSE);
844 if (!svp || *svp != uninit_sv)
847 return varname(Nullgv, '$', obase->op_targ,
848 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
851 gv = cGVOPx_gv(obase);
857 if (!av || SvRMAGICAL(av))
859 svp = av_fetch(av, (I32)obase->op_private, FALSE);
860 if (!svp || *svp != uninit_sv)
863 return varname(gv, '$', 0,
864 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
869 o = cUNOPx(obase)->op_first;
870 if (!o || o->op_type != OP_NULL ||
871 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
873 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
878 /* $a[uninit_expr] or $h{uninit_expr} */
879 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
882 o = cBINOPx(obase)->op_first;
883 kid = cBINOPx(obase)->op_last;
885 /* get the av or hv, and optionally the gv */
887 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
888 sv = PAD_SV(o->op_targ);
890 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
891 && cUNOPo->op_first->op_type == OP_GV)
893 gv = cGVOPx_gv(cUNOPo->op_first);
896 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
901 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
902 /* index is constant */
906 if (obase->op_type == OP_HELEM) {
907 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
908 if (!he || HeVAL(he) != uninit_sv)
912 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
913 if (!svp || *svp != uninit_sv)
917 if (obase->op_type == OP_HELEM)
918 return varname(gv, '%', o->op_targ,
919 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
921 return varname(gv, '@', o->op_targ, Nullsv,
922 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
926 /* index is an expression;
927 * attempt to find a match within the aggregate */
928 if (obase->op_type == OP_HELEM) {
929 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
931 return varname(gv, '%', o->op_targ,
932 keysv, 0, FUV_SUBSCRIPT_HASH);
935 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
937 return varname(gv, '@', o->op_targ,
938 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
943 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
945 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
951 /* only examine RHS */
952 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
955 o = cUNOPx(obase)->op_first;
956 if (o->op_type == OP_PUSHMARK)
959 if (!o->op_sibling) {
960 /* one-arg version of open is highly magical */
962 if (o->op_type == OP_GV) { /* open FOO; */
964 if (match && GvSV(gv) != uninit_sv)
966 return varname(gv, '$', 0,
967 Nullsv, 0, FUV_SUBSCRIPT_NONE);
969 /* other possibilities not handled are:
970 * open $x; or open my $x; should return '${*$x}'
971 * open expr; should return '$'.expr ideally
977 /* ops where $_ may be an implicit arg */
981 if ( !(obase->op_flags & OPf_STACKED)) {
982 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
983 ? PAD_SVl(obase->op_targ)
987 sv_setpvn(sv, "$_", 2);
995 /* skip filehandle as it can't produce 'undef' warning */
996 o = cUNOPx(obase)->op_first;
997 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
998 o = o->op_sibling->op_sibling;
1005 match = 1; /* XS or custom code could trigger random warnings */
1010 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1011 return sv_2mortal(newSVpvn("${$/}", 5));
1016 if (!(obase->op_flags & OPf_KIDS))
1018 o = cUNOPx(obase)->op_first;
1024 /* if all except one arg are constant, or have no side-effects,
1025 * or are optimized away, then it's unambiguous */
1027 for (kid=o; kid; kid = kid->op_sibling) {
1029 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1030 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1031 || (kid->op_type == OP_PUSHMARK)
1035 if (o2) { /* more than one found */
1042 return find_uninit_var(o2, uninit_sv, match);
1046 sv = find_uninit_var(o, uninit_sv, 1);
1058 =for apidoc report_uninit
1060 Print appropriate "Use of uninitialized variable" warning
1066 Perl_report_uninit(pTHX_ SV* uninit_sv)
1069 SV* varname = Nullsv;
1071 varname = find_uninit_var(PL_op, uninit_sv,0);
1073 sv_insert(varname, 0, 0, " ", 1);
1075 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1076 varname ? SvPV_nolen_const(varname) : "",
1077 " in ", OP_DESC(PL_op));
1080 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1085 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1089 const size_t count = PERL_ARENA_SIZE/size;
1090 Newx(start, count*size, char);
1091 *((void **) start) = *arena_root;
1092 *arena_root = (void *)start;
1094 end = start + (count-1) * size;
1096 /* The initial slot is used to link the arenas together, so it isn't to be
1097 linked into the list of ready-to-use bodies. */
1101 *root = (void *)start;
1103 while (start < end) {
1104 char * const next = start + size;
1105 *(void**) start = (void *)next;
1108 *(void **)start = 0;
1113 /* grab a new thing from the free list, allocating more if necessary */
1115 /* 1st, the inline version */
1117 #define new_body_inline(xpv, arena_root, root, size) \
1120 xpv = *((void **)(root)) \
1121 ? *((void **)(root)) : S_more_bodies(aTHX_ arena_root, root, size); \
1122 *(root) = *(void**)(xpv); \
1126 /* now use the inline version in the proper function */
1129 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1132 new_body_inline(xpv, arena_root, root, size);
1136 /* return a thing to the free list */
1138 #define del_body(thing, root) \
1140 void **thing_copy = (void **)thing; \
1142 *thing_copy = *root; \
1143 *root = (void*)thing_copy; \
1147 /* Conventionally we simply malloc() a big block of memory, then divide it
1148 up into lots of the thing that we're allocating.
1150 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1153 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1154 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1157 #define new_body_type(TYPE,lctype) \
1158 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1159 (void**)&PL_ ## lctype ## _root, \
1162 #define del_body_type(p,TYPE,lctype) \
1163 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1165 /* But for some types, we cheat. The type starts with some members that are
1166 never accessed. So we allocate the substructure, starting at the first used
1167 member, then adjust the pointer back in memory by the size of the bit not
1168 allocated, so it's as if we allocated the full structure.
1169 (But things will all go boom if you write to the part that is "not there",
1170 because you'll be overwriting the last members of the preceding structure
1173 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1174 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1175 and the pointer is unchanged. If the allocated structure is smaller (no
1176 initial NV actually allocated) then the net effect is to subtract the size
1177 of the NV from the pointer, to return a new pointer as if an initial NV were
1180 This is the same trick as was used for NV and IV bodies. Ironically it
1181 doesn't need to be used for NV bodies any more, because NV is now at the
1182 start of the structure. IV bodies don't need it either, because they are
1183 no longer allocated. */
1185 #define new_body_allocated(TYPE,lctype,member) \
1186 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1187 (void**)&PL_ ## lctype ## _root, \
1188 sizeof(lctype ## _allocated)) - \
1189 STRUCT_OFFSET(TYPE, member) \
1190 + STRUCT_OFFSET(lctype ## _allocated, member))
1193 #define del_body_allocated(p,TYPE,lctype,member) \
1194 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1195 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1196 (void**)&PL_ ## lctype ## _root)
1198 #define my_safemalloc(s) (void*)safemalloc(s)
1199 #define my_safefree(p) safefree((char*)p)
1203 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1204 #define del_XNV(p) my_safefree(p)
1206 #define new_XPV() my_safemalloc(sizeof(XPV))
1207 #define del_XPV(p) my_safefree(p)
1209 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1210 #define del_XPVIV(p) my_safefree(p)
1212 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1213 #define del_XPVNV(p) my_safefree(p)
1215 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1216 #define del_XPVCV(p) my_safefree(p)
1218 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1219 #define del_XPVAV(p) my_safefree(p)
1221 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1222 #define del_XPVHV(p) my_safefree(p)
1224 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1225 #define del_XPVMG(p) my_safefree(p)
1227 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1228 #define del_XPVGV(p) my_safefree(p)
1230 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1231 #define del_XPVLV(p) my_safefree(p)
1233 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1234 #define del_XPVBM(p) my_safefree(p)
1238 #define new_XNV() new_body_type(NV, xnv)
1239 #define del_XNV(p) del_body_type(p, NV, xnv)
1241 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1242 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1244 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1245 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1247 #define new_XPVNV() new_body_type(XPVNV, xpvnv)
1248 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1250 #define new_XPVCV() new_body_type(XPVCV, xpvcv)
1251 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1253 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1254 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1256 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1257 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1259 #define new_XPVMG() new_body_type(XPVMG, xpvmg)
1260 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1262 #define new_XPVGV() new_body_type(XPVGV, xpvgv)
1263 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1265 #define new_XPVLV() new_body_type(XPVLV, xpvlv)
1266 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1268 #define new_XPVBM() new_body_type(XPVBM, xpvbm)
1269 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1273 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1274 #define del_XPVFM(p) my_safefree(p)
1276 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1277 #define del_XPVIO(p) my_safefree(p)
1280 =for apidoc sv_upgrade
1282 Upgrade an SV to a more complex form. Generally adds a new body type to the
1283 SV, then copies across as much information as possible from the old body.
1284 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1290 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1292 void** old_body_arena;
1293 size_t old_body_offset;
1294 size_t old_body_length; /* Well, the length to copy. */
1296 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1297 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1299 bool zero_nv = TRUE;
1302 size_t new_body_length;
1303 size_t new_body_offset;
1304 void** new_body_arena;
1305 void** new_body_arenaroot;
1306 const U32 old_type = SvTYPE(sv);
1308 if (mt != SVt_PV && SvIsCOW(sv)) {
1309 sv_force_normal_flags(sv, 0);
1312 if (SvTYPE(sv) == mt)
1315 if (SvTYPE(sv) > mt)
1316 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1317 (int)SvTYPE(sv), (int)mt);
1320 old_body = SvANY(sv);
1322 old_body_offset = 0;
1323 old_body_length = 0;
1324 new_body_offset = 0;
1325 new_body_length = ~0;
1327 /* Copying structures onto other structures that have been neatly zeroed
1328 has a subtle gotcha. Consider XPVMG
1330 +------+------+------+------+------+-------+-------+
1331 | NV | CUR | LEN | IV | MAGIC | STASH |
1332 +------+------+------+------+------+-------+-------+
1333 0 4 8 12 16 20 24 28
1335 where NVs are aligned to 8 bytes, so that sizeof that structure is
1336 actually 32 bytes long, with 4 bytes of padding at the end:
1338 +------+------+------+------+------+-------+-------+------+
1339 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1340 +------+------+------+------+------+-------+-------+------+
1341 0 4 8 12 16 20 24 28 32
1343 so what happens if you allocate memory for this structure:
1345 +------+------+------+------+------+-------+-------+------+------+...
1346 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1347 +------+------+------+------+------+-------+-------+------+------+...
1348 0 4 8 12 16 20 24 28 32 36
1350 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1351 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1352 started out as zero once, but it's quite possible that it isn't. So now,
1353 rather than a nicely zeroed GP, you have it pointing somewhere random.
1356 (In fact, GP ends up pointing at a previous GP structure, because the
1357 principle cause of the padding in XPVMG getting garbage is a copy of
1358 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1360 So we are careful and work out the size of used parts of all the
1363 switch (SvTYPE(sv)) {
1369 else if (mt < SVt_PVIV)
1371 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1372 old_body_length = sizeof(IV);
1375 old_body_arena = (void **) &PL_xnv_root;
1376 old_body_length = sizeof(NV);
1377 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1386 old_body_arena = (void **) &PL_xpv_root;
1387 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1388 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1389 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1390 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1394 else if (mt == SVt_NV)
1398 old_body_arena = (void **) &PL_xpviv_root;
1399 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1400 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1401 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1402 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1406 old_body_arena = (void **) &PL_xpvnv_root;
1407 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1408 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1409 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1414 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1415 there's no way that it can be safely upgraded, because perl.c
1416 expects to Safefree(SvANY(PL_mess_sv)) */
1417 assert(sv != PL_mess_sv);
1418 /* This flag bit is used to mean other things in other scalar types.
1419 Given that it only has meaning inside the pad, it shouldn't be set
1420 on anything that can get upgraded. */
1421 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1422 old_body_arena = (void **) &PL_xpvmg_root;
1423 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1424 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1425 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1430 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1433 SvFLAGS(sv) &= ~SVTYPEMASK;
1438 Perl_croak(aTHX_ "Can't upgrade to undef");
1440 assert(old_type == SVt_NULL);
1441 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1445 assert(old_type == SVt_NULL);
1446 SvANY(sv) = new_XNV();
1450 assert(old_type == SVt_NULL);
1451 SvANY(sv) = &sv->sv_u.svu_rv;
1455 SvANY(sv) = new_XPVHV();
1458 HvTOTALKEYS(sv) = 0;
1463 SvANY(sv) = new_XPVAV();
1470 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1471 The target created by newSVrv also is, and it can have magic.
1472 However, it never has SvPVX set.
1474 if (old_type >= SVt_RV) {
1475 assert(SvPVX_const(sv) == 0);
1478 /* Could put this in the else clause below, as PVMG must have SvPVX
1479 0 already (the assertion above) */
1480 SvPV_set(sv, (char*)0);
1482 if (old_type >= SVt_PVMG) {
1483 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1484 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1492 new_body = new_XPVIO();
1493 new_body_length = sizeof(XPVIO);
1496 new_body = new_XPVFM();
1497 new_body_length = sizeof(XPVFM);
1501 new_body_length = sizeof(XPVBM);
1502 new_body_arena = (void **) &PL_xpvbm_root;
1503 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1506 new_body_length = sizeof(XPVGV);
1507 new_body_arena = (void **) &PL_xpvgv_root;
1508 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1511 new_body_length = sizeof(XPVCV);
1512 new_body_arena = (void **) &PL_xpvcv_root;
1513 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1516 new_body_length = sizeof(XPVLV);
1517 new_body_arena = (void **) &PL_xpvlv_root;
1518 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1521 new_body_length = sizeof(XPVMG);
1522 new_body_arena = (void **) &PL_xpvmg_root;
1523 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1526 new_body_length = sizeof(XPVNV);
1527 new_body_arena = (void **) &PL_xpvnv_root;
1528 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1531 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1532 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1533 new_body_length = sizeof(XPVIV) - new_body_offset;
1534 new_body_arena = (void **) &PL_xpviv_root;
1535 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1536 /* XXX Is this still needed? Was it ever needed? Surely as there is
1537 no route from NV to PVIV, NOK can never be true */
1541 goto new_body_no_NV;
1543 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1544 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1545 new_body_length = sizeof(XPV) - new_body_offset;
1546 new_body_arena = (void **) &PL_xpv_root;
1547 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1549 /* PV and PVIV don't have an NV slot. */
1550 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1555 assert(new_body_length);
1557 /* This points to the start of the allocated area. */
1558 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
1561 /* We always allocated the full length item with PURIFY */
1562 new_body_length += new_body_offset;
1563 new_body_offset = 0;
1564 new_body = my_safemalloc(new_body_length);
1568 Zero(new_body, new_body_length, char);
1569 new_body = ((char *)new_body) - new_body_offset;
1570 SvANY(sv) = new_body;
1572 if (old_body_length) {
1573 Copy((char *)old_body + old_body_offset,
1574 (char *)new_body + old_body_offset,
1575 old_body_length, char);
1578 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1584 IoPAGE_LEN(sv) = 60;
1585 if (old_type < SVt_RV)
1589 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1593 if (old_body_arena) {
1595 my_safefree(old_body);
1597 del_body((void*)((char*)old_body + old_body_offset),
1604 =for apidoc sv_backoff
1606 Remove any string offset. You should normally use the C<SvOOK_off> macro
1613 Perl_sv_backoff(pTHX_ register SV *sv)
1616 assert(SvTYPE(sv) != SVt_PVHV);
1617 assert(SvTYPE(sv) != SVt_PVAV);
1619 const char * const s = SvPVX_const(sv);
1620 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1621 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1623 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1625 SvFLAGS(sv) &= ~SVf_OOK;
1632 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1633 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1634 Use the C<SvGROW> wrapper instead.
1640 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1644 #ifdef HAS_64K_LIMIT
1645 if (newlen >= 0x10000) {
1646 PerlIO_printf(Perl_debug_log,
1647 "Allocation too large: %"UVxf"\n", (UV)newlen);
1650 #endif /* HAS_64K_LIMIT */
1653 if (SvTYPE(sv) < SVt_PV) {
1654 sv_upgrade(sv, SVt_PV);
1655 s = SvPVX_mutable(sv);
1657 else if (SvOOK(sv)) { /* pv is offset? */
1659 s = SvPVX_mutable(sv);
1660 if (newlen > SvLEN(sv))
1661 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1662 #ifdef HAS_64K_LIMIT
1663 if (newlen >= 0x10000)
1668 s = SvPVX_mutable(sv);
1670 if (newlen > SvLEN(sv)) { /* need more room? */
1671 newlen = PERL_STRLEN_ROUNDUP(newlen);
1672 if (SvLEN(sv) && s) {
1674 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1680 s = saferealloc(s, newlen);
1683 s = safemalloc(newlen);
1684 if (SvPVX_const(sv) && SvCUR(sv)) {
1685 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1689 SvLEN_set(sv, newlen);
1695 =for apidoc sv_setiv
1697 Copies an integer into the given SV, upgrading first if necessary.
1698 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1704 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1706 SV_CHECK_THINKFIRST_COW_DROP(sv);
1707 switch (SvTYPE(sv)) {
1709 sv_upgrade(sv, SVt_IV);
1712 sv_upgrade(sv, SVt_PVNV);
1716 sv_upgrade(sv, SVt_PVIV);
1725 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1728 (void)SvIOK_only(sv); /* validate number */
1734 =for apidoc sv_setiv_mg
1736 Like C<sv_setiv>, but also handles 'set' magic.
1742 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1749 =for apidoc sv_setuv
1751 Copies an unsigned integer into the given SV, upgrading first if necessary.
1752 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1758 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1760 /* With these two if statements:
1761 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1764 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1766 If you wish to remove them, please benchmark to see what the effect is
1768 if (u <= (UV)IV_MAX) {
1769 sv_setiv(sv, (IV)u);
1778 =for apidoc sv_setuv_mg
1780 Like C<sv_setuv>, but also handles 'set' magic.
1786 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1795 =for apidoc sv_setnv
1797 Copies a double into the given SV, upgrading first if necessary.
1798 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1804 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1806 SV_CHECK_THINKFIRST_COW_DROP(sv);
1807 switch (SvTYPE(sv)) {
1810 sv_upgrade(sv, SVt_NV);
1815 sv_upgrade(sv, SVt_PVNV);
1824 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1828 (void)SvNOK_only(sv); /* validate number */
1833 =for apidoc sv_setnv_mg
1835 Like C<sv_setnv>, but also handles 'set' magic.
1841 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1847 /* Print an "isn't numeric" warning, using a cleaned-up,
1848 * printable version of the offending string
1852 S_not_a_number(pTHX_ SV *sv)
1859 dsv = sv_2mortal(newSVpvn("", 0));
1860 pv = sv_uni_display(dsv, sv, 10, 0);
1863 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1864 /* each *s can expand to 4 chars + "...\0",
1865 i.e. need room for 8 chars */
1867 const char *s, *end;
1868 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1871 if (ch & 128 && !isPRINT_LC(ch)) {
1880 else if (ch == '\r') {
1884 else if (ch == '\f') {
1888 else if (ch == '\\') {
1892 else if (ch == '\0') {
1896 else if (isPRINT_LC(ch))
1913 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1914 "Argument \"%s\" isn't numeric in %s", pv,
1917 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1918 "Argument \"%s\" isn't numeric", pv);
1922 =for apidoc looks_like_number
1924 Test if the content of an SV looks like a number (or is a number).
1925 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1926 non-numeric warning), even if your atof() doesn't grok them.
1932 Perl_looks_like_number(pTHX_ SV *sv)
1934 register const char *sbegin;
1938 sbegin = SvPVX_const(sv);
1941 else if (SvPOKp(sv))
1942 sbegin = SvPV_const(sv, len);
1944 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1945 return grok_number(sbegin, len, NULL);
1948 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1949 until proven guilty, assume that things are not that bad... */
1954 As 64 bit platforms often have an NV that doesn't preserve all bits of
1955 an IV (an assumption perl has been based on to date) it becomes necessary
1956 to remove the assumption that the NV always carries enough precision to
1957 recreate the IV whenever needed, and that the NV is the canonical form.
1958 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1959 precision as a side effect of conversion (which would lead to insanity
1960 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1961 1) to distinguish between IV/UV/NV slots that have cached a valid
1962 conversion where precision was lost and IV/UV/NV slots that have a
1963 valid conversion which has lost no precision
1964 2) to ensure that if a numeric conversion to one form is requested that
1965 would lose precision, the precise conversion (or differently
1966 imprecise conversion) is also performed and cached, to prevent
1967 requests for different numeric formats on the same SV causing
1968 lossy conversion chains. (lossless conversion chains are perfectly
1973 SvIOKp is true if the IV slot contains a valid value
1974 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1975 SvNOKp is true if the NV slot contains a valid value
1976 SvNOK is true only if the NV value is accurate
1979 while converting from PV to NV, check to see if converting that NV to an
1980 IV(or UV) would lose accuracy over a direct conversion from PV to
1981 IV(or UV). If it would, cache both conversions, return NV, but mark
1982 SV as IOK NOKp (ie not NOK).
1984 While converting from PV to IV, check to see if converting that IV to an
1985 NV would lose accuracy over a direct conversion from PV to NV. If it
1986 would, cache both conversions, flag similarly.
1988 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1989 correctly because if IV & NV were set NV *always* overruled.
1990 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1991 changes - now IV and NV together means that the two are interchangeable:
1992 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1994 The benefit of this is that operations such as pp_add know that if
1995 SvIOK is true for both left and right operands, then integer addition
1996 can be used instead of floating point (for cases where the result won't
1997 overflow). Before, floating point was always used, which could lead to
1998 loss of precision compared with integer addition.
2000 * making IV and NV equal status should make maths accurate on 64 bit
2002 * may speed up maths somewhat if pp_add and friends start to use
2003 integers when possible instead of fp. (Hopefully the overhead in
2004 looking for SvIOK and checking for overflow will not outweigh the
2005 fp to integer speedup)
2006 * will slow down integer operations (callers of SvIV) on "inaccurate"
2007 values, as the change from SvIOK to SvIOKp will cause a call into
2008 sv_2iv each time rather than a macro access direct to the IV slot
2009 * should speed up number->string conversion on integers as IV is
2010 favoured when IV and NV are equally accurate
2012 ####################################################################
2013 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2014 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2015 On the other hand, SvUOK is true iff UV.
2016 ####################################################################
2018 Your mileage will vary depending your CPU's relative fp to integer
2022 #ifndef NV_PRESERVES_UV
2023 # define IS_NUMBER_UNDERFLOW_IV 1
2024 # define IS_NUMBER_UNDERFLOW_UV 2
2025 # define IS_NUMBER_IV_AND_UV 2
2026 # define IS_NUMBER_OVERFLOW_IV 4
2027 # define IS_NUMBER_OVERFLOW_UV 5
2029 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2031 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2033 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2035 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2036 if (SvNVX(sv) < (NV)IV_MIN) {
2037 (void)SvIOKp_on(sv);
2039 SvIV_set(sv, IV_MIN);
2040 return IS_NUMBER_UNDERFLOW_IV;
2042 if (SvNVX(sv) > (NV)UV_MAX) {
2043 (void)SvIOKp_on(sv);
2046 SvUV_set(sv, UV_MAX);
2047 return IS_NUMBER_OVERFLOW_UV;
2049 (void)SvIOKp_on(sv);
2051 /* Can't use strtol etc to convert this string. (See truth table in
2053 if (SvNVX(sv) <= (UV)IV_MAX) {
2054 SvIV_set(sv, I_V(SvNVX(sv)));
2055 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2056 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2058 /* Integer is imprecise. NOK, IOKp */
2060 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2063 SvUV_set(sv, U_V(SvNVX(sv)));
2064 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2065 if (SvUVX(sv) == UV_MAX) {
2066 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2067 possibly be preserved by NV. Hence, it must be overflow.
2069 return IS_NUMBER_OVERFLOW_UV;
2071 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2073 /* Integer is imprecise. NOK, IOKp */
2075 return IS_NUMBER_OVERFLOW_IV;
2077 #endif /* !NV_PRESERVES_UV*/
2079 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2080 * this function provided for binary compatibility only
2084 Perl_sv_2iv(pTHX_ register SV *sv)
2086 return sv_2iv_flags(sv, SV_GMAGIC);
2090 =for apidoc sv_2iv_flags
2092 Return the integer value of an SV, doing any necessary string
2093 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2094 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2100 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2104 if (SvGMAGICAL(sv)) {
2105 if (flags & SV_GMAGIC)
2110 return I_V(SvNVX(sv));
2112 if (SvPOKp(sv) && SvLEN(sv))
2115 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2116 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2122 if (SvTHINKFIRST(sv)) {
2125 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2126 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2127 return SvIV(tmpstr);
2128 return PTR2IV(SvRV(sv));
2131 sv_force_normal_flags(sv, 0);
2133 if (SvREADONLY(sv) && !SvOK(sv)) {
2134 if (ckWARN(WARN_UNINITIALIZED))
2141 return (IV)(SvUVX(sv));
2148 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2149 * without also getting a cached IV/UV from it at the same time
2150 * (ie PV->NV conversion should detect loss of accuracy and cache
2151 * IV or UV at same time to avoid this. NWC */
2153 if (SvTYPE(sv) == SVt_NV)
2154 sv_upgrade(sv, SVt_PVNV);
2156 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2157 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2158 certainly cast into the IV range at IV_MAX, whereas the correct
2159 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2161 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2162 SvIV_set(sv, I_V(SvNVX(sv)));
2163 if (SvNVX(sv) == (NV) SvIVX(sv)
2164 #ifndef NV_PRESERVES_UV
2165 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2166 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2167 /* Don't flag it as "accurately an integer" if the number
2168 came from a (by definition imprecise) NV operation, and
2169 we're outside the range of NV integer precision */
2172 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2173 DEBUG_c(PerlIO_printf(Perl_debug_log,
2174 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2180 /* IV not precise. No need to convert from PV, as NV
2181 conversion would already have cached IV if it detected
2182 that PV->IV would be better than PV->NV->IV
2183 flags already correct - don't set public IOK. */
2184 DEBUG_c(PerlIO_printf(Perl_debug_log,
2185 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2190 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2191 but the cast (NV)IV_MIN rounds to a the value less (more
2192 negative) than IV_MIN which happens to be equal to SvNVX ??
2193 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2194 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2195 (NV)UVX == NVX are both true, but the values differ. :-(
2196 Hopefully for 2s complement IV_MIN is something like
2197 0x8000000000000000 which will be exact. NWC */
2200 SvUV_set(sv, U_V(SvNVX(sv)));
2202 (SvNVX(sv) == (NV) SvUVX(sv))
2203 #ifndef NV_PRESERVES_UV
2204 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2205 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2206 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2207 /* Don't flag it as "accurately an integer" if the number
2208 came from a (by definition imprecise) NV operation, and
2209 we're outside the range of NV integer precision */
2215 DEBUG_c(PerlIO_printf(Perl_debug_log,
2216 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2220 return (IV)SvUVX(sv);
2223 else if (SvPOKp(sv) && SvLEN(sv)) {
2225 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2226 /* We want to avoid a possible problem when we cache an IV which
2227 may be later translated to an NV, and the resulting NV is not
2228 the same as the direct translation of the initial string
2229 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2230 be careful to ensure that the value with the .456 is around if the
2231 NV value is requested in the future).
2233 This means that if we cache such an IV, we need to cache the
2234 NV as well. Moreover, we trade speed for space, and do not
2235 cache the NV if we are sure it's not needed.
2238 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2239 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2240 == IS_NUMBER_IN_UV) {
2241 /* It's definitely an integer, only upgrade to PVIV */
2242 if (SvTYPE(sv) < SVt_PVIV)
2243 sv_upgrade(sv, SVt_PVIV);
2245 } else if (SvTYPE(sv) < SVt_PVNV)
2246 sv_upgrade(sv, SVt_PVNV);
2248 /* If NV preserves UV then we only use the UV value if we know that
2249 we aren't going to call atof() below. If NVs don't preserve UVs
2250 then the value returned may have more precision than atof() will
2251 return, even though value isn't perfectly accurate. */
2252 if ((numtype & (IS_NUMBER_IN_UV
2253 #ifdef NV_PRESERVES_UV
2256 )) == IS_NUMBER_IN_UV) {
2257 /* This won't turn off the public IOK flag if it was set above */
2258 (void)SvIOKp_on(sv);
2260 if (!(numtype & IS_NUMBER_NEG)) {
2262 if (value <= (UV)IV_MAX) {
2263 SvIV_set(sv, (IV)value);
2265 SvUV_set(sv, value);
2269 /* 2s complement assumption */
2270 if (value <= (UV)IV_MIN) {
2271 SvIV_set(sv, -(IV)value);
2273 /* Too negative for an IV. This is a double upgrade, but
2274 I'm assuming it will be rare. */
2275 if (SvTYPE(sv) < SVt_PVNV)
2276 sv_upgrade(sv, SVt_PVNV);
2280 SvNV_set(sv, -(NV)value);
2281 SvIV_set(sv, IV_MIN);
2285 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2286 will be in the previous block to set the IV slot, and the next
2287 block to set the NV slot. So no else here. */
2289 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290 != IS_NUMBER_IN_UV) {
2291 /* It wasn't an (integer that doesn't overflow the UV). */
2292 SvNV_set(sv, Atof(SvPVX_const(sv)));
2294 if (! numtype && ckWARN(WARN_NUMERIC))
2297 #if defined(USE_LONG_DOUBLE)
2298 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2299 PTR2UV(sv), SvNVX(sv)));
2301 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2302 PTR2UV(sv), SvNVX(sv)));
2306 #ifdef NV_PRESERVES_UV
2307 (void)SvIOKp_on(sv);
2309 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2310 SvIV_set(sv, I_V(SvNVX(sv)));
2311 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2314 /* Integer is imprecise. NOK, IOKp */
2316 /* UV will not work better than IV */
2318 if (SvNVX(sv) > (NV)UV_MAX) {
2320 /* Integer is inaccurate. NOK, IOKp, is UV */
2321 SvUV_set(sv, UV_MAX);
2324 SvUV_set(sv, U_V(SvNVX(sv)));
2325 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2326 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2330 /* Integer is imprecise. NOK, IOKp, is UV */
2336 #else /* NV_PRESERVES_UV */
2337 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2338 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2339 /* The IV slot will have been set from value returned by
2340 grok_number above. The NV slot has just been set using
2343 assert (SvIOKp(sv));
2345 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2346 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2347 /* Small enough to preserve all bits. */
2348 (void)SvIOKp_on(sv);
2350 SvIV_set(sv, I_V(SvNVX(sv)));
2351 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2353 /* Assumption: first non-preserved integer is < IV_MAX,
2354 this NV is in the preserved range, therefore: */
2355 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2357 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2361 0 0 already failed to read UV.
2362 0 1 already failed to read UV.
2363 1 0 you won't get here in this case. IV/UV
2364 slot set, public IOK, Atof() unneeded.
2365 1 1 already read UV.
2366 so there's no point in sv_2iuv_non_preserve() attempting
2367 to use atol, strtol, strtoul etc. */
2368 if (sv_2iuv_non_preserve (sv, numtype)
2369 >= IS_NUMBER_OVERFLOW_IV)
2373 #endif /* NV_PRESERVES_UV */
2376 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2378 if (SvTYPE(sv) < SVt_IV)
2379 /* Typically the caller expects that sv_any is not NULL now. */
2380 sv_upgrade(sv, SVt_IV);
2383 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2384 PTR2UV(sv),SvIVX(sv)));
2385 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2388 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2389 * this function provided for binary compatibility only
2393 Perl_sv_2uv(pTHX_ register SV *sv)
2395 return sv_2uv_flags(sv, SV_GMAGIC);
2399 =for apidoc sv_2uv_flags
2401 Return the unsigned integer value of an SV, doing any necessary string
2402 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2403 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2409 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2413 if (SvGMAGICAL(sv)) {
2414 if (flags & SV_GMAGIC)
2419 return U_V(SvNVX(sv));
2420 if (SvPOKp(sv) && SvLEN(sv))
2423 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2424 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2430 if (SvTHINKFIRST(sv)) {
2433 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2434 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2435 return SvUV(tmpstr);
2436 return PTR2UV(SvRV(sv));
2439 sv_force_normal_flags(sv, 0);
2441 if (SvREADONLY(sv) && !SvOK(sv)) {
2442 if (ckWARN(WARN_UNINITIALIZED))
2452 return (UV)SvIVX(sv);
2456 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2457 * without also getting a cached IV/UV from it at the same time
2458 * (ie PV->NV conversion should detect loss of accuracy and cache
2459 * IV or UV at same time to avoid this. */
2460 /* IV-over-UV optimisation - choose to cache IV if possible */
2462 if (SvTYPE(sv) == SVt_NV)
2463 sv_upgrade(sv, SVt_PVNV);
2465 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2466 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2467 SvIV_set(sv, I_V(SvNVX(sv)));
2468 if (SvNVX(sv) == (NV) SvIVX(sv)
2469 #ifndef NV_PRESERVES_UV
2470 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2471 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2472 /* Don't flag it as "accurately an integer" if the number
2473 came from a (by definition imprecise) NV operation, and
2474 we're outside the range of NV integer precision */
2477 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2478 DEBUG_c(PerlIO_printf(Perl_debug_log,
2479 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2485 /* IV not precise. No need to convert from PV, as NV
2486 conversion would already have cached IV if it detected
2487 that PV->IV would be better than PV->NV->IV
2488 flags already correct - don't set public IOK. */
2489 DEBUG_c(PerlIO_printf(Perl_debug_log,
2490 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2495 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2496 but the cast (NV)IV_MIN rounds to a the value less (more
2497 negative) than IV_MIN which happens to be equal to SvNVX ??
2498 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2499 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2500 (NV)UVX == NVX are both true, but the values differ. :-(
2501 Hopefully for 2s complement IV_MIN is something like
2502 0x8000000000000000 which will be exact. NWC */
2505 SvUV_set(sv, U_V(SvNVX(sv)));
2507 (SvNVX(sv) == (NV) SvUVX(sv))
2508 #ifndef NV_PRESERVES_UV
2509 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2510 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2511 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2512 /* Don't flag it as "accurately an integer" if the number
2513 came from a (by definition imprecise) NV operation, and
2514 we're outside the range of NV integer precision */
2519 DEBUG_c(PerlIO_printf(Perl_debug_log,
2520 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2526 else if (SvPOKp(sv) && SvLEN(sv)) {
2528 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2530 /* We want to avoid a possible problem when we cache a UV which
2531 may be later translated to an NV, and the resulting NV is not
2532 the translation of the initial data.
2534 This means that if we cache such a UV, we need to cache the
2535 NV as well. Moreover, we trade speed for space, and do not
2536 cache the NV if not needed.
2539 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2540 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2541 == IS_NUMBER_IN_UV) {
2542 /* It's definitely an integer, only upgrade to PVIV */
2543 if (SvTYPE(sv) < SVt_PVIV)
2544 sv_upgrade(sv, SVt_PVIV);
2546 } else if (SvTYPE(sv) < SVt_PVNV)
2547 sv_upgrade(sv, SVt_PVNV);
2549 /* If NV preserves UV then we only use the UV value if we know that
2550 we aren't going to call atof() below. If NVs don't preserve UVs
2551 then the value returned may have more precision than atof() will
2552 return, even though it isn't accurate. */
2553 if ((numtype & (IS_NUMBER_IN_UV
2554 #ifdef NV_PRESERVES_UV
2557 )) == IS_NUMBER_IN_UV) {
2558 /* This won't turn off the public IOK flag if it was set above */
2559 (void)SvIOKp_on(sv);
2561 if (!(numtype & IS_NUMBER_NEG)) {
2563 if (value <= (UV)IV_MAX) {
2564 SvIV_set(sv, (IV)value);
2566 /* it didn't overflow, and it was positive. */
2567 SvUV_set(sv, value);
2571 /* 2s complement assumption */
2572 if (value <= (UV)IV_MIN) {
2573 SvIV_set(sv, -(IV)value);
2575 /* Too negative for an IV. This is a double upgrade, but
2576 I'm assuming it will be rare. */
2577 if (SvTYPE(sv) < SVt_PVNV)
2578 sv_upgrade(sv, SVt_PVNV);
2582 SvNV_set(sv, -(NV)value);
2583 SvIV_set(sv, IV_MIN);
2588 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2589 != IS_NUMBER_IN_UV) {
2590 /* It wasn't an integer, or it overflowed the UV. */
2591 SvNV_set(sv, Atof(SvPVX_const(sv)));
2593 if (! numtype && ckWARN(WARN_NUMERIC))
2596 #if defined(USE_LONG_DOUBLE)
2597 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2598 PTR2UV(sv), SvNVX(sv)));
2600 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2601 PTR2UV(sv), SvNVX(sv)));
2604 #ifdef NV_PRESERVES_UV
2605 (void)SvIOKp_on(sv);
2607 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2608 SvIV_set(sv, I_V(SvNVX(sv)));
2609 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2612 /* Integer is imprecise. NOK, IOKp */
2614 /* UV will not work better than IV */
2616 if (SvNVX(sv) > (NV)UV_MAX) {
2618 /* Integer is inaccurate. NOK, IOKp, is UV */
2619 SvUV_set(sv, UV_MAX);
2622 SvUV_set(sv, U_V(SvNVX(sv)));
2623 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2624 NV preservse UV so can do correct comparison. */
2625 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2629 /* Integer is imprecise. NOK, IOKp, is UV */
2634 #else /* NV_PRESERVES_UV */
2635 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2636 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2637 /* The UV slot will have been set from value returned by
2638 grok_number above. The NV slot has just been set using
2641 assert (SvIOKp(sv));
2643 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2644 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2645 /* Small enough to preserve all bits. */
2646 (void)SvIOKp_on(sv);
2648 SvIV_set(sv, I_V(SvNVX(sv)));
2649 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2651 /* Assumption: first non-preserved integer is < IV_MAX,
2652 this NV is in the preserved range, therefore: */
2653 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2655 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2658 sv_2iuv_non_preserve (sv, numtype);
2660 #endif /* NV_PRESERVES_UV */
2664 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2665 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2668 if (SvTYPE(sv) < SVt_IV)
2669 /* Typically the caller expects that sv_any is not NULL now. */
2670 sv_upgrade(sv, SVt_IV);
2674 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2675 PTR2UV(sv),SvUVX(sv)));
2676 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2682 Return the num value of an SV, doing any necessary string or integer
2683 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2690 Perl_sv_2nv(pTHX_ register SV *sv)
2694 if (SvGMAGICAL(sv)) {
2698 if (SvPOKp(sv) && SvLEN(sv)) {
2699 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2700 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2702 return Atof(SvPVX_const(sv));
2706 return (NV)SvUVX(sv);
2708 return (NV)SvIVX(sv);
2711 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2712 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2718 if (SvTHINKFIRST(sv)) {
2721 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2722 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2723 return SvNV(tmpstr);
2724 return PTR2NV(SvRV(sv));
2727 sv_force_normal_flags(sv, 0);
2729 if (SvREADONLY(sv) && !SvOK(sv)) {
2730 if (ckWARN(WARN_UNINITIALIZED))
2735 if (SvTYPE(sv) < SVt_NV) {
2736 if (SvTYPE(sv) == SVt_IV)
2737 sv_upgrade(sv, SVt_PVNV);
2739 sv_upgrade(sv, SVt_NV);
2740 #ifdef USE_LONG_DOUBLE
2742 STORE_NUMERIC_LOCAL_SET_STANDARD();
2743 PerlIO_printf(Perl_debug_log,
2744 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2745 PTR2UV(sv), SvNVX(sv));
2746 RESTORE_NUMERIC_LOCAL();
2750 STORE_NUMERIC_LOCAL_SET_STANDARD();
2751 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2752 PTR2UV(sv), SvNVX(sv));
2753 RESTORE_NUMERIC_LOCAL();
2757 else if (SvTYPE(sv) < SVt_PVNV)
2758 sv_upgrade(sv, SVt_PVNV);
2763 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2764 #ifdef NV_PRESERVES_UV
2767 /* Only set the public NV OK flag if this NV preserves the IV */
2768 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2769 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2770 : (SvIVX(sv) == I_V(SvNVX(sv))))
2776 else if (SvPOKp(sv) && SvLEN(sv)) {
2778 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2779 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2781 #ifdef NV_PRESERVES_UV
2782 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2783 == IS_NUMBER_IN_UV) {
2784 /* It's definitely an integer */
2785 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2787 SvNV_set(sv, Atof(SvPVX_const(sv)));
2790 SvNV_set(sv, Atof(SvPVX_const(sv)));
2791 /* Only set the public NV OK flag if this NV preserves the value in
2792 the PV at least as well as an IV/UV would.
2793 Not sure how to do this 100% reliably. */
2794 /* if that shift count is out of range then Configure's test is
2795 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2797 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2798 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2799 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2800 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2801 /* Can't use strtol etc to convert this string, so don't try.
2802 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2805 /* value has been set. It may not be precise. */
2806 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2807 /* 2s complement assumption for (UV)IV_MIN */
2808 SvNOK_on(sv); /* Integer is too negative. */
2813 if (numtype & IS_NUMBER_NEG) {
2814 SvIV_set(sv, -(IV)value);
2815 } else if (value <= (UV)IV_MAX) {
2816 SvIV_set(sv, (IV)value);
2818 SvUV_set(sv, value);
2822 if (numtype & IS_NUMBER_NOT_INT) {
2823 /* I believe that even if the original PV had decimals,
2824 they are lost beyond the limit of the FP precision.
2825 However, neither is canonical, so both only get p
2826 flags. NWC, 2000/11/25 */
2827 /* Both already have p flags, so do nothing */
2829 const NV nv = SvNVX(sv);
2830 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2831 if (SvIVX(sv) == I_V(nv)) {
2836 /* It had no "." so it must be integer. */
2839 /* between IV_MAX and NV(UV_MAX).
2840 Could be slightly > UV_MAX */
2842 if (numtype & IS_NUMBER_NOT_INT) {
2843 /* UV and NV both imprecise. */
2845 const UV nv_as_uv = U_V(nv);
2847 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2858 #endif /* NV_PRESERVES_UV */
2861 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2863 if (SvTYPE(sv) < SVt_NV)
2864 /* Typically the caller expects that sv_any is not NULL now. */
2865 /* XXX Ilya implies that this is a bug in callers that assume this
2866 and ideally should be fixed. */
2867 sv_upgrade(sv, SVt_NV);
2870 #if defined(USE_LONG_DOUBLE)
2872 STORE_NUMERIC_LOCAL_SET_STANDARD();
2873 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2874 PTR2UV(sv), SvNVX(sv));
2875 RESTORE_NUMERIC_LOCAL();
2879 STORE_NUMERIC_LOCAL_SET_STANDARD();
2880 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2881 PTR2UV(sv), SvNVX(sv));
2882 RESTORE_NUMERIC_LOCAL();
2888 /* asIV(): extract an integer from the string value of an SV.
2889 * Caller must validate PVX */
2892 S_asIV(pTHX_ SV *sv)
2895 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2897 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2898 == IS_NUMBER_IN_UV) {
2899 /* It's definitely an integer */
2900 if (numtype & IS_NUMBER_NEG) {
2901 if (value < (UV)IV_MIN)
2904 if (value < (UV)IV_MAX)
2909 if (ckWARN(WARN_NUMERIC))
2912 return I_V(Atof(SvPVX_const(sv)));
2915 /* asUV(): extract an unsigned integer from the string value of an SV
2916 * Caller must validate PVX */
2919 S_asUV(pTHX_ SV *sv)
2922 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2924 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2925 == IS_NUMBER_IN_UV) {
2926 /* It's definitely an integer */
2927 if (!(numtype & IS_NUMBER_NEG))
2931 if (ckWARN(WARN_NUMERIC))
2934 return U_V(Atof(SvPVX_const(sv)));
2938 =for apidoc sv_2pv_nolen
2940 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2941 use the macro wrapper C<SvPV_nolen(sv)> instead.
2946 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2948 return sv_2pv(sv, 0);
2951 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2952 * UV as a string towards the end of buf, and return pointers to start and
2955 * We assume that buf is at least TYPE_CHARS(UV) long.
2959 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2961 char *ptr = buf + TYPE_CHARS(UV);
2975 *--ptr = '0' + (char)(uv % 10);
2983 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2984 * this function provided for binary compatibility only
2988 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2990 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2994 =for apidoc sv_2pv_flags
2996 Returns a pointer to the string value of an SV, and sets *lp to its length.
2997 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2999 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3000 usually end up here too.
3006 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3011 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3012 char *tmpbuf = tbuf;
3019 if (SvGMAGICAL(sv)) {
3020 if (flags & SV_GMAGIC)
3025 if (flags & SV_MUTABLE_RETURN)
3026 return SvPVX_mutable(sv);
3027 if (flags & SV_CONST_RETURN)
3028 return (char *)SvPVX_const(sv);
3033 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3035 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3040 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3045 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3046 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
3054 if (SvTHINKFIRST(sv)) {
3057 register const char *typestr;
3058 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3059 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3061 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3064 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3065 if (flags & SV_CONST_RETURN) {
3066 pv = (char *) SvPVX_const(tmpstr);
3068 pv = (flags & SV_MUTABLE_RETURN)
3069 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3072 *lp = SvCUR(tmpstr);
3074 pv = sv_2pv_flags(tmpstr, lp, flags);
3085 typestr = "NULLREF";
3089 switch (SvTYPE(sv)) {
3091 if ( ((SvFLAGS(sv) &
3092 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3093 == (SVs_OBJECT|SVs_SMG))
3094 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3095 const regexp *re = (regexp *)mg->mg_obj;
3098 const char *fptr = "msix";
3103 char need_newline = 0;
3104 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3106 while((ch = *fptr++)) {
3108 reflags[left++] = ch;
3111 reflags[right--] = ch;
3116 reflags[left] = '-';
3120 mg->mg_len = re->prelen + 4 + left;
3122 * If /x was used, we have to worry about a regex
3123 * ending with a comment later being embedded
3124 * within another regex. If so, we don't want this
3125 * regex's "commentization" to leak out to the
3126 * right part of the enclosing regex, we must cap
3127 * it with a newline.
3129 * So, if /x was used, we scan backwards from the
3130 * end of the regex. If we find a '#' before we
3131 * find a newline, we need to add a newline
3132 * ourself. If we find a '\n' first (or if we
3133 * don't find '#' or '\n'), we don't need to add
3134 * anything. -jfriedl
3136 if (PMf_EXTENDED & re->reganch)
3138 const char *endptr = re->precomp + re->prelen;
3139 while (endptr >= re->precomp)
3141 const char c = *(endptr--);
3143 break; /* don't need another */
3145 /* we end while in a comment, so we
3147 mg->mg_len++; /* save space for it */
3148 need_newline = 1; /* note to add it */
3154 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3155 Copy("(?", mg->mg_ptr, 2, char);
3156 Copy(reflags, mg->mg_ptr+2, left, char);
3157 Copy(":", mg->mg_ptr+left+2, 1, char);
3158 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3160 mg->mg_ptr[mg->mg_len - 2] = '\n';
3161 mg->mg_ptr[mg->mg_len - 1] = ')';
3162 mg->mg_ptr[mg->mg_len] = 0;
3164 PL_reginterp_cnt += re->program[0].next_off;
3166 if (re->reganch & ROPT_UTF8)
3182 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3183 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3184 /* tied lvalues should appear to be
3185 * scalars for backwards compatitbility */
3186 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3187 ? "SCALAR" : "LVALUE"; break;
3188 case SVt_PVAV: typestr = "ARRAY"; break;
3189 case SVt_PVHV: typestr = "HASH"; break;
3190 case SVt_PVCV: typestr = "CODE"; break;
3191 case SVt_PVGV: typestr = "GLOB"; break;
3192 case SVt_PVFM: typestr = "FORMAT"; break;
3193 case SVt_PVIO: typestr = "IO"; break;
3194 default: typestr = "UNKNOWN"; break;
3198 const char *name = HvNAME_get(SvSTASH(sv));
3199 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3200 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3203 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3207 *lp = strlen(typestr);
3208 return (char *)typestr;
3210 if (SvREADONLY(sv) && !SvOK(sv)) {
3211 if (ckWARN(WARN_UNINITIALIZED))
3218 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3219 /* I'm assuming that if both IV and NV are equally valid then
3220 converting the IV is going to be more efficient */
3221 const U32 isIOK = SvIOK(sv);
3222 const U32 isUIOK = SvIsUV(sv);
3223 char buf[TYPE_CHARS(UV)];
3226 if (SvTYPE(sv) < SVt_PVIV)
3227 sv_upgrade(sv, SVt_PVIV);
3229 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3231 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3232 /* inlined from sv_setpvn */
3233 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3234 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3235 SvCUR_set(sv, ebuf - ptr);
3245 else if (SvNOKp(sv)) {
3246 if (SvTYPE(sv) < SVt_PVNV)
3247 sv_upgrade(sv, SVt_PVNV);
3248 /* The +20 is pure guesswork. Configure test needed. --jhi */
3249 s = SvGROW_mutable(sv, NV_DIG + 20);
3250 olderrno = errno; /* some Xenix systems wipe out errno here */
3252 if (SvNVX(sv) == 0.0)
3253 (void)strcpy(s,"0");
3257 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3260 #ifdef FIXNEGATIVEZERO
3261 if (*s == '-' && s[1] == '0' && !s[2])
3271 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3275 if (SvTYPE(sv) < SVt_PV)
3276 /* Typically the caller expects that sv_any is not NULL now. */
3277 sv_upgrade(sv, SVt_PV);
3281 STRLEN len = s - SvPVX_const(sv);
3287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3288 PTR2UV(sv),SvPVX_const(sv)));
3289 if (flags & SV_CONST_RETURN)
3290 return (char *)SvPVX_const(sv);
3291 if (flags & SV_MUTABLE_RETURN)
3292 return SvPVX_mutable(sv);
3296 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3297 /* Sneaky stuff here */
3301 tsv = newSVpv(tmpbuf, 0);
3314 t = SvPVX_const(tsv);
3319 len = strlen(tmpbuf);
3321 #ifdef FIXNEGATIVEZERO
3322 if (len == 2 && t[0] == '-' && t[1] == '0') {
3327 SvUPGRADE(sv, SVt_PV);
3330 s = SvGROW_mutable(sv, len + 1);
3333 return memcpy(s, t, len + 1);
3338 =for apidoc sv_copypv
3340 Copies a stringified representation of the source SV into the
3341 destination SV. Automatically performs any necessary mg_get and
3342 coercion of numeric values into strings. Guaranteed to preserve
3343 UTF-8 flag even from overloaded objects. Similar in nature to
3344 sv_2pv[_flags] but operates directly on an SV instead of just the
3345 string. Mostly uses sv_2pv_flags to do its work, except when that
3346 would lose the UTF-8'ness of the PV.
3352 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3355 const char * const s = SvPV_const(ssv,len);
3356 sv_setpvn(dsv,s,len);
3364 =for apidoc sv_2pvbyte_nolen
3366 Return a pointer to the byte-encoded representation of the SV.
3367 May cause the SV to be downgraded from UTF-8 as a side-effect.
3369 Usually accessed via the C<SvPVbyte_nolen> macro.
3375 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3377 return sv_2pvbyte(sv, 0);
3381 =for apidoc sv_2pvbyte
3383 Return a pointer to the byte-encoded representation of the SV, and set *lp
3384 to its length. May cause the SV to be downgraded from UTF-8 as a
3387 Usually accessed via the C<SvPVbyte> macro.
3393 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3395 sv_utf8_downgrade(sv,0);
3396 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3400 =for apidoc sv_2pvutf8_nolen
3402 Return a pointer to the UTF-8-encoded representation of the SV.
3403 May cause the SV to be upgraded to UTF-8 as a side-effect.
3405 Usually accessed via the C<SvPVutf8_nolen> macro.
3411 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3413 return sv_2pvutf8(sv, 0);
3417 =for apidoc sv_2pvutf8
3419 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3420 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3422 Usually accessed via the C<SvPVutf8> macro.
3428 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3430 sv_utf8_upgrade(sv);
3431 return SvPV(sv,*lp);
3435 =for apidoc sv_2bool
3437 This function is only called on magical items, and is only used by
3438 sv_true() or its macro equivalent.
3444 Perl_sv_2bool(pTHX_ register SV *sv)
3453 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3454 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3455 return (bool)SvTRUE(tmpsv);
3456 return SvRV(sv) != 0;
3459 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3461 (*sv->sv_u.svu_pv > '0' ||
3462 Xpvtmp->xpv_cur > 1 ||
3463 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3470 return SvIVX(sv) != 0;
3473 return SvNVX(sv) != 0.0;
3480 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3481 * this function provided for binary compatibility only
3486 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3488 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3492 =for apidoc sv_utf8_upgrade
3494 Converts the PV of an SV to its UTF-8-encoded form.
3495 Forces the SV to string form if it is not already.
3496 Always sets the SvUTF8 flag to avoid future validity checks even
3497 if all the bytes have hibit clear.
3499 This is not as a general purpose byte encoding to Unicode interface:
3500 use the Encode extension for that.
3502 =for apidoc sv_utf8_upgrade_flags
3504 Converts the PV of an SV to its UTF-8-encoded form.
3505 Forces the SV to string form if it is not already.
3506 Always sets the SvUTF8 flag to avoid future validity checks even
3507 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3508 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3509 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3511 This is not as a general purpose byte encoding to Unicode interface:
3512 use the Encode extension for that.
3518 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3520 if (sv == &PL_sv_undef)
3524 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3525 (void) sv_2pv_flags(sv,&len, flags);
3529 (void) SvPV_force(sv,len);
3538 sv_force_normal_flags(sv, 0);
3541 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3542 sv_recode_to_utf8(sv, PL_encoding);
3543 else { /* Assume Latin-1/EBCDIC */
3544 /* This function could be much more efficient if we
3545 * had a FLAG in SVs to signal if there are any hibit
3546 * chars in the PV. Given that there isn't such a flag
3547 * make the loop as fast as possible. */
3548 const U8 *s = (U8 *) SvPVX_const(sv);
3549 const U8 *e = (U8 *) SvEND(sv);
3555 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3559 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3560 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3562 SvPV_free(sv); /* No longer using what was there before. */
3564 SvPV_set(sv, (char*)recoded);
3565 SvCUR_set(sv, len - 1);
3566 SvLEN_set(sv, len); /* No longer know the real size. */
3568 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3575 =for apidoc sv_utf8_downgrade
3577 Attempts to convert the PV of an SV from characters to bytes.
3578 If the PV contains a character beyond byte, this conversion will fail;
3579 in this case, either returns false or, if C<fail_ok> is not
3582 This is not as a general purpose Unicode to byte encoding interface:
3583 use the Encode extension for that.
3589 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3591 if (SvPOKp(sv) && SvUTF8(sv)) {
3597 sv_force_normal_flags(sv, 0);
3599 s = (U8 *) SvPV(sv, len);
3600 if (!utf8_to_bytes(s, &len)) {
3605 Perl_croak(aTHX_ "Wide character in %s",
3608 Perl_croak(aTHX_ "Wide character");
3619 =for apidoc sv_utf8_encode
3621 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3622 flag off so that it looks like octets again.
3628 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3630 (void) sv_utf8_upgrade(sv);
3632 sv_force_normal_flags(sv, 0);
3634 if (SvREADONLY(sv)) {
3635 Perl_croak(aTHX_ PL_no_modify);
3641 =for apidoc sv_utf8_decode
3643 If the PV of the SV is an octet sequence in UTF-8
3644 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3645 so that it looks like a character. If the PV contains only single-byte
3646 characters, the C<SvUTF8> flag stays being off.
3647 Scans PV for validity and returns false if the PV is invalid UTF-8.
3653 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3659 /* The octets may have got themselves encoded - get them back as
3662 if (!sv_utf8_downgrade(sv, TRUE))
3665 /* it is actually just a matter of turning the utf8 flag on, but
3666 * we want to make sure everything inside is valid utf8 first.
3668 c = (const U8 *) SvPVX_const(sv);
3669 if (!is_utf8_string(c, SvCUR(sv)+1))
3671 e = (const U8 *) SvEND(sv);
3674 if (!UTF8_IS_INVARIANT(ch)) {
3683 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3684 * this function provided for binary compatibility only
3688 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3690 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3694 =for apidoc sv_setsv
3696 Copies the contents of the source SV C<ssv> into the destination SV
3697 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3698 function if the source SV needs to be reused. Does not handle 'set' magic.
3699 Loosely speaking, it performs a copy-by-value, obliterating any previous
3700 content of the destination.
3702 You probably want to use one of the assortment of wrappers, such as
3703 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3704 C<SvSetMagicSV_nosteal>.
3706 =for apidoc sv_setsv_flags
3708 Copies the contents of the source SV C<ssv> into the destination SV
3709 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3710 function if the source SV needs to be reused. Does not handle 'set' magic.
3711 Loosely speaking, it performs a copy-by-value, obliterating any previous
3712 content of the destination.
3713 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3714 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3715 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3716 and C<sv_setsv_nomg> are implemented in terms of this function.
3718 You probably want to use one of the assortment of wrappers, such as
3719 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3720 C<SvSetMagicSV_nosteal>.
3722 This is the primary function for copying scalars, and most other
3723 copy-ish functions and macros use this underneath.
3729 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3731 register U32 sflags;
3737 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3739 sstr = &PL_sv_undef;
3740 stype = SvTYPE(sstr);
3741 dtype = SvTYPE(dstr);
3746 /* need to nuke the magic */
3748 SvRMAGICAL_off(dstr);
3751 /* There's a lot of redundancy below but we're going for speed here */
3756 if (dtype != SVt_PVGV) {
3757 (void)SvOK_off(dstr);
3765 sv_upgrade(dstr, SVt_IV);
3768 sv_upgrade(dstr, SVt_PVNV);
3772 sv_upgrade(dstr, SVt_PVIV);
3775 (void)SvIOK_only(dstr);
3776 SvIV_set(dstr, SvIVX(sstr));
3779 if (SvTAINTED(sstr))
3790 sv_upgrade(dstr, SVt_NV);
3795 sv_upgrade(dstr, SVt_PVNV);
3798 SvNV_set(dstr, SvNVX(sstr));
3799 (void)SvNOK_only(dstr);
3800 if (SvTAINTED(sstr))
3808 sv_upgrade(dstr, SVt_RV);
3809 else if (dtype == SVt_PVGV &&
3810 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3813 if (GvIMPORTED(dstr) != GVf_IMPORTED
3814 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3816 GvIMPORTED_on(dstr);
3825 #ifdef PERL_OLD_COPY_ON_WRITE
3826 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3827 if (dtype < SVt_PVIV)
3828 sv_upgrade(dstr, SVt_PVIV);
3835 sv_upgrade(dstr, SVt_PV);
3838 if (dtype < SVt_PVIV)
3839 sv_upgrade(dstr, SVt_PVIV);
3842 if (dtype < SVt_PVNV)
3843 sv_upgrade(dstr, SVt_PVNV);
3850 const char * const type = sv_reftype(sstr,0);
3852 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3854 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3859 if (dtype <= SVt_PVGV) {
3861 if (dtype != SVt_PVGV) {
3862 const char * const name = GvNAME(sstr);
3863 const STRLEN len = GvNAMELEN(sstr);
3864 /* don't upgrade SVt_PVLV: it can hold a glob */
3865 if (dtype != SVt_PVLV)
3866 sv_upgrade(dstr, SVt_PVGV);
3867 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3868 GvSTASH(dstr) = GvSTASH(sstr);
3870 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3871 GvNAME(dstr) = savepvn(name, len);
3872 GvNAMELEN(dstr) = len;
3873 SvFAKE_on(dstr); /* can coerce to non-glob */
3875 /* ahem, death to those who redefine active sort subs */
3876 else if (PL_curstackinfo->si_type == PERLSI_SORT
3877 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3878 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3881 #ifdef GV_UNIQUE_CHECK
3882 if (GvUNIQUE((GV*)dstr)) {
3883 Perl_croak(aTHX_ PL_no_modify);
3887 (void)SvOK_off(dstr);
3888 GvINTRO_off(dstr); /* one-shot flag */
3890 GvGP(dstr) = gp_ref(GvGP(sstr));
3891 if (SvTAINTED(sstr))
3893 if (GvIMPORTED(dstr) != GVf_IMPORTED
3894 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3896 GvIMPORTED_on(dstr);
3904 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3906 if ((int)SvTYPE(sstr) != stype) {
3907 stype = SvTYPE(sstr);
3908 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3912 if (stype == SVt_PVLV)
3913 SvUPGRADE(dstr, SVt_PVNV);
3915 SvUPGRADE(dstr, (U32)stype);
3918 sflags = SvFLAGS(sstr);
3920 if (sflags & SVf_ROK) {
3921 if (dtype >= SVt_PV) {
3922 if (dtype == SVt_PVGV) {
3923 SV *sref = SvREFCNT_inc(SvRV(sstr));
3925 const int intro = GvINTRO(dstr);
3927 #ifdef GV_UNIQUE_CHECK
3928 if (GvUNIQUE((GV*)dstr)) {
3929 Perl_croak(aTHX_ PL_no_modify);
3934 GvINTRO_off(dstr); /* one-shot flag */
3935 GvLINE(dstr) = CopLINE(PL_curcop);
3936 GvEGV(dstr) = (GV*)dstr;
3939 switch (SvTYPE(sref)) {
3942 SAVEGENERICSV(GvAV(dstr));
3944 dref = (SV*)GvAV(dstr);
3945 GvAV(dstr) = (AV*)sref;
3946 if (!GvIMPORTED_AV(dstr)
3947 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3949 GvIMPORTED_AV_on(dstr);
3954 SAVEGENERICSV(GvHV(dstr));
3956 dref = (SV*)GvHV(dstr);
3957 GvHV(dstr) = (HV*)sref;
3958 if (!GvIMPORTED_HV(dstr)
3959 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3961 GvIMPORTED_HV_on(dstr);
3966 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3967 SvREFCNT_dec(GvCV(dstr));
3968 GvCV(dstr) = Nullcv;
3969 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3970 PL_sub_generation++;
3972 SAVEGENERICSV(GvCV(dstr));
3975 dref = (SV*)GvCV(dstr);
3976 if (GvCV(dstr) != (CV*)sref) {
3977 CV* cv = GvCV(dstr);
3979 if (!GvCVGEN((GV*)dstr) &&
3980 (CvROOT(cv) || CvXSUB(cv)))
3982 /* ahem, death to those who redefine
3983 * active sort subs */
3984 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3985 PL_sortcop == CvSTART(cv))
3987 "Can't redefine active sort subroutine %s",
3988 GvENAME((GV*)dstr));
3989 /* Redefining a sub - warning is mandatory if
3990 it was a const and its value changed. */
3991 if (ckWARN(WARN_REDEFINE)
3993 && (!CvCONST((CV*)sref)
3994 || sv_cmp(cv_const_sv(cv),
3995 cv_const_sv((CV*)sref)))))
3997 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3999 ? "Constant subroutine %s::%s redefined"
4000 : "Subroutine %s::%s redefined",
4001 HvNAME_get(GvSTASH((GV*)dstr)),
4002 GvENAME((GV*)dstr));
4006 cv_ckproto(cv, (GV*)dstr,
4008 ? SvPVX_const(sref) : Nullch);
4010 GvCV(dstr) = (CV*)sref;
4011 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4012 GvASSUMECV_on(dstr);
4013 PL_sub_generation++;
4015 if (!GvIMPORTED_CV(dstr)
4016 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4018 GvIMPORTED_CV_on(dstr);
4023 SAVEGENERICSV(GvIOp(dstr));
4025 dref = (SV*)GvIOp(dstr);
4026 GvIOp(dstr) = (IO*)sref;
4030 SAVEGENERICSV(GvFORM(dstr));
4032 dref = (SV*)GvFORM(dstr);
4033 GvFORM(dstr) = (CV*)sref;
4037 SAVEGENERICSV(GvSV(dstr));
4039 dref = (SV*)GvSV(dstr);
4041 if (!GvIMPORTED_SV(dstr)
4042 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4044 GvIMPORTED_SV_on(dstr);
4050 if (SvTAINTED(sstr))
4054 if (SvPVX_const(dstr)) {
4060 (void)SvOK_off(dstr);
4061 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4063 if (sflags & SVp_NOK) {
4065 /* Only set the public OK flag if the source has public OK. */
4066 if (sflags & SVf_NOK)
4067 SvFLAGS(dstr) |= SVf_NOK;
4068 SvNV_set(dstr, SvNVX(sstr));
4070 if (sflags & SVp_IOK) {
4071 (void)SvIOKp_on(dstr);
4072 if (sflags & SVf_IOK)
4073 SvFLAGS(dstr) |= SVf_IOK;
4074 if (sflags & SVf_IVisUV)
4076 SvIV_set(dstr, SvIVX(sstr));
4078 if (SvAMAGIC(sstr)) {
4082 else if (sflags & SVp_POK) {
4086 * Check to see if we can just swipe the string. If so, it's a
4087 * possible small lose on short strings, but a big win on long ones.
4088 * It might even be a win on short strings if SvPVX_const(dstr)
4089 * has to be allocated and SvPVX_const(sstr) has to be freed.
4092 /* Whichever path we take through the next code, we want this true,
4093 and doing it now facilitates the COW check. */
4094 (void)SvPOK_only(dstr);
4097 /* We're not already COW */
4098 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4099 #ifndef PERL_OLD_COPY_ON_WRITE
4100 /* or we are, but dstr isn't a suitable target. */
4101 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4106 (sflags & SVs_TEMP) && /* slated for free anyway? */
4107 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4108 (!(flags & SV_NOSTEAL)) &&
4109 /* and we're allowed to steal temps */
4110 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4111 SvLEN(sstr) && /* and really is a string */
4112 /* and won't be needed again, potentially */
4113 !(PL_op && PL_op->op_type == OP_AASSIGN))
4114 #ifdef PERL_OLD_COPY_ON_WRITE
4115 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4116 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4117 && SvTYPE(sstr) >= SVt_PVIV)
4120 /* Failed the swipe test, and it's not a shared hash key either.
4121 Have to copy the string. */
4122 STRLEN len = SvCUR(sstr);
4123 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4124 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4125 SvCUR_set(dstr, len);
4126 *SvEND(dstr) = '\0';
4128 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4130 /* Either it's a shared hash key, or it's suitable for
4131 copy-on-write or we can swipe the string. */
4133 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4137 #ifdef PERL_OLD_COPY_ON_WRITE
4139 /* I believe I should acquire a global SV mutex if
4140 it's a COW sv (not a shared hash key) to stop
4141 it going un copy-on-write.
4142 If the source SV has gone un copy on write between up there
4143 and down here, then (assert() that) it is of the correct
4144 form to make it copy on write again */
4145 if ((sflags & (SVf_FAKE | SVf_READONLY))
4146 != (SVf_FAKE | SVf_READONLY)) {
4147 SvREADONLY_on(sstr);
4149 /* Make the source SV into a loop of 1.
4150 (about to become 2) */
4151 SV_COW_NEXT_SV_SET(sstr, sstr);
4155 /* Initial code is common. */
4156 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4161 /* making another shared SV. */
4162 STRLEN cur = SvCUR(sstr);
4163 STRLEN len = SvLEN(sstr);
4164 #ifdef PERL_OLD_COPY_ON_WRITE
4166 assert (SvTYPE(dstr) >= SVt_PVIV);
4167 /* SvIsCOW_normal */
4168 /* splice us in between source and next-after-source. */
4169 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4170 SV_COW_NEXT_SV_SET(sstr, dstr);
4171 SvPV_set(dstr, SvPVX_mutable(sstr));
4175 /* SvIsCOW_shared_hash */
4176 DEBUG_C(PerlIO_printf(Perl_debug_log,
4177 "Copy on write: Sharing hash\n"));
4179 assert (SvTYPE(dstr) >= SVt_PV);
4181 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4183 SvLEN_set(dstr, len);
4184 SvCUR_set(dstr, cur);
4185 SvREADONLY_on(dstr);
4187 /* Relesase a global SV mutex. */
4190 { /* Passes the swipe test. */
4191 SvPV_set(dstr, SvPVX_mutable(sstr));
4192 SvLEN_set(dstr, SvLEN(sstr));
4193 SvCUR_set(dstr, SvCUR(sstr));
4196 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4197 SvPV_set(sstr, Nullch);
4203 if (sflags & SVf_UTF8)
4205 if (sflags & SVp_NOK) {
4207 if (sflags & SVf_NOK)
4208 SvFLAGS(dstr) |= SVf_NOK;
4209 SvNV_set(dstr, SvNVX(sstr));
4211 if (sflags & SVp_IOK) {
4212 (void)SvIOKp_on(dstr);
4213 if (sflags & SVf_IOK)
4214 SvFLAGS(dstr) |= SVf_IOK;
4215 if (sflags & SVf_IVisUV)
4217 SvIV_set(dstr, SvIVX(sstr));
4220 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4221 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4222 smg->mg_ptr, smg->mg_len);
4223 SvRMAGICAL_on(dstr);
4226 else if (sflags & SVp_IOK) {
4227 if (sflags & SVf_IOK)
4228 (void)SvIOK_only(dstr);
4230 (void)SvOK_off(dstr);
4231 (void)SvIOKp_on(dstr);
4233 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4234 if (sflags & SVf_IVisUV)
4236 SvIV_set(dstr, SvIVX(sstr));
4237 if (sflags & SVp_NOK) {
4238 if (sflags & SVf_NOK)
4239 (void)SvNOK_on(dstr);
4241 (void)SvNOKp_on(dstr);
4242 SvNV_set(dstr, SvNVX(sstr));
4245 else if (sflags & SVp_NOK) {
4246 if (sflags & SVf_NOK)
4247 (void)SvNOK_only(dstr);
4249 (void)SvOK_off(dstr);
4252 SvNV_set(dstr, SvNVX(sstr));
4255 if (dtype == SVt_PVGV) {
4256 if (ckWARN(WARN_MISC))
4257 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4260 (void)SvOK_off(dstr);
4262 if (SvTAINTED(sstr))
4267 =for apidoc sv_setsv_mg
4269 Like C<sv_setsv>, but also handles 'set' magic.
4275 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4277 sv_setsv(dstr,sstr);
4281 #ifdef PERL_OLD_COPY_ON_WRITE
4283 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4285 STRLEN cur = SvCUR(sstr);
4286 STRLEN len = SvLEN(sstr);
4287 register char *new_pv;
4290 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4298 if (SvTHINKFIRST(dstr))
4299 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4300 else if (SvPVX_const(dstr))
4301 Safefree(SvPVX_const(dstr));
4305 SvUPGRADE(dstr, SVt_PVIV);
4307 assert (SvPOK(sstr));
4308 assert (SvPOKp(sstr));
4309 assert (!SvIOK(sstr));
4310 assert (!SvIOKp(sstr));
4311 assert (!SvNOK(sstr));
4312 assert (!SvNOKp(sstr));
4314 if (SvIsCOW(sstr)) {
4316 if (SvLEN(sstr) == 0) {
4317 /* source is a COW shared hash key. */
4318 DEBUG_C(PerlIO_printf(Perl_debug_log,
4319 "Fast copy on write: Sharing hash\n"));
4320 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4323 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4325 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4326 SvUPGRADE(sstr, SVt_PVIV);
4327 SvREADONLY_on(sstr);
4329 DEBUG_C(PerlIO_printf(Perl_debug_log,
4330 "Fast copy on write: Converting sstr to COW\n"));
4331 SV_COW_NEXT_SV_SET(dstr, sstr);
4333 SV_COW_NEXT_SV_SET(sstr, dstr);
4334 new_pv = SvPVX_mutable(sstr);
4337 SvPV_set(dstr, new_pv);
4338 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4341 SvLEN_set(dstr, len);
4342 SvCUR_set(dstr, cur);
4351 =for apidoc sv_setpvn
4353 Copies a string into an SV. The C<len> parameter indicates the number of
4354 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4355 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4361 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4363 register char *dptr;
4365 SV_CHECK_THINKFIRST_COW_DROP(sv);
4371 /* len is STRLEN which is unsigned, need to copy to signed */
4374 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4376 SvUPGRADE(sv, SVt_PV);
4378 dptr = SvGROW(sv, len + 1);
4379 Move(ptr,dptr,len,char);
4382 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4387 =for apidoc sv_setpvn_mg
4389 Like C<sv_setpvn>, but also handles 'set' magic.
4395 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4397 sv_setpvn(sv,ptr,len);
4402 =for apidoc sv_setpv
4404 Copies a string into an SV. The string must be null-terminated. Does not
4405 handle 'set' magic. See C<sv_setpv_mg>.
4411 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4413 register STRLEN len;
4415 SV_CHECK_THINKFIRST_COW_DROP(sv);
4421 SvUPGRADE(sv, SVt_PV);
4423 SvGROW(sv, len + 1);
4424 Move(ptr,SvPVX(sv),len+1,char);
4426 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4431 =for apidoc sv_setpv_mg
4433 Like C<sv_setpv>, but also handles 'set' magic.
4439 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4446 =for apidoc sv_usepvn
4448 Tells an SV to use C<ptr> to find its string value. Normally the string is
4449 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4450 The C<ptr> should point to memory that was allocated by C<malloc>. The
4451 string length, C<len>, must be supplied. This function will realloc the
4452 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4453 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4454 See C<sv_usepvn_mg>.
4460 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4463 SV_CHECK_THINKFIRST_COW_DROP(sv);
4464 SvUPGRADE(sv, SVt_PV);
4469 if (SvPVX_const(sv))
4472 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4473 ptr = saferealloc (ptr, allocate);
4476 SvLEN_set(sv, allocate);
4478 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4483 =for apidoc sv_usepvn_mg
4485 Like C<sv_usepvn>, but also handles 'set' magic.
4491 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4493 sv_usepvn(sv,ptr,len);
4497 #ifdef PERL_OLD_COPY_ON_WRITE
4498 /* Need to do this *after* making the SV normal, as we need the buffer
4499 pointer to remain valid until after we've copied it. If we let go too early,
4500 another thread could invalidate it by unsharing last of the same hash key
4501 (which it can do by means other than releasing copy-on-write Svs)
4502 or by changing the other copy-on-write SVs in the loop. */
4504 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4506 if (len) { /* this SV was SvIsCOW_normal(sv) */
4507 /* we need to find the SV pointing to us. */
4508 SV *current = SV_COW_NEXT_SV(after);
4510 if (current == sv) {
4511 /* The SV we point to points back to us (there were only two of us
4513 Hence other SV is no longer copy on write either. */
4515 SvREADONLY_off(after);
4517 /* We need to follow the pointers around the loop. */
4519 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4522 /* don't loop forever if the structure is bust, and we have
4523 a pointer into a closed loop. */
4524 assert (current != after);
4525 assert (SvPVX_const(current) == pvx);
4527 /* Make the SV before us point to the SV after us. */
4528 SV_COW_NEXT_SV_SET(current, after);
4531 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4536 Perl_sv_release_IVX(pTHX_ register SV *sv)
4539 sv_force_normal_flags(sv, 0);
4545 =for apidoc sv_force_normal_flags
4547 Undo various types of fakery on an SV: if the PV is a shared string, make
4548 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4549 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4550 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4551 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4552 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4553 set to some other value.) In addition, the C<flags> parameter gets passed to
4554 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4555 with flags set to 0.
4561 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4563 #ifdef PERL_OLD_COPY_ON_WRITE
4564 if (SvREADONLY(sv)) {
4565 /* At this point I believe I should acquire a global SV mutex. */
4567 const char * const pvx = SvPVX_const(sv);
4568 const STRLEN len = SvLEN(sv);
4569 const STRLEN cur = SvCUR(sv);
4570 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4572 PerlIO_printf(Perl_debug_log,
4573 "Copy on write: Force normal %ld\n",
4579 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4580 SvPV_set(sv, (char*)0);
4582 if (flags & SV_COW_DROP_PV) {
4583 /* OK, so we don't need to copy our buffer. */
4586 SvGROW(sv, cur + 1);
4587 Move(pvx,SvPVX(sv),cur,char);
4591 sv_release_COW(sv, pvx, len, next);
4596 else if (IN_PERL_RUNTIME)
4597 Perl_croak(aTHX_ PL_no_modify);
4598 /* At this point I believe that I can drop the global SV mutex. */
4601 if (SvREADONLY(sv)) {
4603 const char * const pvx = SvPVX_const(sv);
4604 const STRLEN len = SvCUR(sv);
4607 SvPV_set(sv, Nullch);
4609 SvGROW(sv, len + 1);
4610 Move(pvx,SvPVX_const(sv),len,char);
4612 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4614 else if (IN_PERL_RUNTIME)
4615 Perl_croak(aTHX_ PL_no_modify);
4619 sv_unref_flags(sv, flags);
4620 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4625 =for apidoc sv_force_normal
4627 Undo various types of fakery on an SV: if the PV is a shared string, make
4628 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4629 an xpvmg. See also C<sv_force_normal_flags>.
4635 Perl_sv_force_normal(pTHX_ register SV *sv)
4637 sv_force_normal_flags(sv, 0);
4643 Efficient removal of characters from the beginning of the string buffer.
4644 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4645 the string buffer. The C<ptr> becomes the first character of the adjusted
4646 string. Uses the "OOK hack".
4647 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4648 refer to the same chunk of data.
4654 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4656 register STRLEN delta;
4657 if (!ptr || !SvPOKp(sv))
4659 delta = ptr - SvPVX_const(sv);
4660 SV_CHECK_THINKFIRST(sv);
4661 if (SvTYPE(sv) < SVt_PVIV)
4662 sv_upgrade(sv,SVt_PVIV);
4665 if (!SvLEN(sv)) { /* make copy of shared string */
4666 const char *pvx = SvPVX_const(sv);
4667 const STRLEN len = SvCUR(sv);
4668 SvGROW(sv, len + 1);
4669 Move(pvx,SvPVX_const(sv),len,char);
4673 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4674 and we do that anyway inside the SvNIOK_off
4676 SvFLAGS(sv) |= SVf_OOK;
4679 SvLEN_set(sv, SvLEN(sv) - delta);
4680 SvCUR_set(sv, SvCUR(sv) - delta);
4681 SvPV_set(sv, SvPVX(sv) + delta);
4682 SvIV_set(sv, SvIVX(sv) + delta);
4685 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4686 * this function provided for binary compatibility only
4690 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4692 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4696 =for apidoc sv_catpvn
4698 Concatenates the string onto the end of the string which is in the SV. The
4699 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4700 status set, then the bytes appended should be valid UTF-8.
4701 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4703 =for apidoc sv_catpvn_flags
4705 Concatenates the string onto the end of the string which is in the SV. The
4706 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4707 status set, then the bytes appended should be valid UTF-8.
4708 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4709 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4710 in terms of this function.
4716 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4719 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4721 SvGROW(dsv, dlen + slen + 1);
4723 sstr = SvPVX_const(dsv);
4724 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4725 SvCUR_set(dsv, SvCUR(dsv) + slen);
4727 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4732 =for apidoc sv_catpvn_mg
4734 Like C<sv_catpvn>, but also handles 'set' magic.
4740 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4742 sv_catpvn(sv,ptr,len);
4746 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4747 * this function provided for binary compatibility only
4751 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4753 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4757 =for apidoc sv_catsv
4759 Concatenates the string from SV C<ssv> onto the end of the string in
4760 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4761 not 'set' magic. See C<sv_catsv_mg>.
4763 =for apidoc sv_catsv_flags
4765 Concatenates the string from SV C<ssv> onto the end of the string in
4766 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4767 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4768 and C<sv_catsv_nomg> are implemented in terms of this function.
4773 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4779 if ((spv = SvPV_const(ssv, slen))) {
4780 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4781 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4782 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4783 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4784 dsv->sv_flags doesn't have that bit set.
4785 Andy Dougherty 12 Oct 2001
4787 const I32 sutf8 = DO_UTF8(ssv);
4790 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4792 dutf8 = DO_UTF8(dsv);
4794 if (dutf8 != sutf8) {
4796 /* Not modifying source SV, so taking a temporary copy. */
4797 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4799 sv_utf8_upgrade(csv);
4800 spv = SvPV_const(csv, slen);
4803 sv_utf8_upgrade_nomg(dsv);
4805 sv_catpvn_nomg(dsv, spv, slen);
4810 =for apidoc sv_catsv_mg
4812 Like C<sv_catsv>, but also handles 'set' magic.
4818 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4825 =for apidoc sv_catpv
4827 Concatenates the string onto the end of the string which is in the SV.
4828 If the SV has the UTF-8 status set, then the bytes appended should be
4829 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4834 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4836 register STRLEN len;
4842 junk = SvPV_force(sv, tlen);
4844 SvGROW(sv, tlen + len + 1);
4846 ptr = SvPVX_const(sv);
4847 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4848 SvCUR_set(sv, SvCUR(sv) + len);
4849 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4854 =for apidoc sv_catpv_mg
4856 Like C<sv_catpv>, but also handles 'set' magic.
4862 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4871 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4872 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4879 Perl_newSV(pTHX_ STRLEN len)
4885 sv_upgrade(sv, SVt_PV);
4886 SvGROW(sv, len + 1);
4891 =for apidoc sv_magicext
4893 Adds magic to an SV, upgrading it if necessary. Applies the
4894 supplied vtable and returns a pointer to the magic added.
4896 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4897 In particular, you can add magic to SvREADONLY SVs, and add more than
4898 one instance of the same 'how'.
4900 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4901 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4902 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4903 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4905 (This is now used as a subroutine by C<sv_magic>.)
4910 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4911 const char* name, I32 namlen)
4915 if (SvTYPE(sv) < SVt_PVMG) {
4916 SvUPGRADE(sv, SVt_PVMG);
4918 Newxz(mg, 1, MAGIC);
4919 mg->mg_moremagic = SvMAGIC(sv);
4920 SvMAGIC_set(sv, mg);
4922 /* Sometimes a magic contains a reference loop, where the sv and
4923 object refer to each other. To prevent a reference loop that
4924 would prevent such objects being freed, we look for such loops
4925 and if we find one we avoid incrementing the object refcount.
4927 Note we cannot do this to avoid self-tie loops as intervening RV must
4928 have its REFCNT incremented to keep it in existence.
4931 if (!obj || obj == sv ||
4932 how == PERL_MAGIC_arylen ||
4933 how == PERL_MAGIC_qr ||
4934 how == PERL_MAGIC_symtab ||
4935 (SvTYPE(obj) == SVt_PVGV &&
4936 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4937 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4938 GvFORM(obj) == (CV*)sv)))
4943 mg->mg_obj = SvREFCNT_inc(obj);
4944 mg->mg_flags |= MGf_REFCOUNTED;
4947 /* Normal self-ties simply pass a null object, and instead of
4948 using mg_obj directly, use the SvTIED_obj macro to produce a
4949 new RV as needed. For glob "self-ties", we are tieing the PVIO
4950 with an RV obj pointing to the glob containing the PVIO. In
4951 this case, to avoid a reference loop, we need to weaken the
4955 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4956 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4962 mg->mg_len = namlen;
4965 mg->mg_ptr = savepvn(name, namlen);
4966 else if (namlen == HEf_SVKEY)
4967 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4969 mg->mg_ptr = (char *) name;
4971 mg->mg_virtual = vtable;
4975 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4980 =for apidoc sv_magic
4982 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4983 then adds a new magic item of type C<how> to the head of the magic list.
4985 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4986 handling of the C<name> and C<namlen> arguments.
4988 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4989 to add more than one instance of the same 'how'.
4995 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4997 const MGVTBL *vtable = 0;
5000 #ifdef PERL_OLD_COPY_ON_WRITE
5002 sv_force_normal_flags(sv, 0);
5004 if (SvREADONLY(sv)) {
5006 /* its okay to attach magic to shared strings; the subsequent
5007 * upgrade to PVMG will unshare the string */
5008 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5011 && how != PERL_MAGIC_regex_global
5012 && how != PERL_MAGIC_bm
5013 && how != PERL_MAGIC_fm
5014 && how != PERL_MAGIC_sv
5015 && how != PERL_MAGIC_backref
5018 Perl_croak(aTHX_ PL_no_modify);
5021 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5022 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5023 /* sv_magic() refuses to add a magic of the same 'how' as an
5026 if (how == PERL_MAGIC_taint)
5034 vtable = &PL_vtbl_sv;
5036 case PERL_MAGIC_overload:
5037 vtable = &PL_vtbl_amagic;
5039 case PERL_MAGIC_overload_elem:
5040 vtable = &PL_vtbl_amagicelem;
5042 case PERL_MAGIC_overload_table:
5043 vtable = &PL_vtbl_ovrld;
5046 vtable = &PL_vtbl_bm;
5048 case PERL_MAGIC_regdata:
5049 vtable = &PL_vtbl_regdata;
5051 case PERL_MAGIC_regdatum:
5052 vtable = &PL_vtbl_regdatum;
5054 case PERL_MAGIC_env:
5055 vtable = &PL_vtbl_env;
5058 vtable = &PL_vtbl_fm;
5060 case PERL_MAGIC_envelem:
5061 vtable = &PL_vtbl_envelem;
5063 case PERL_MAGIC_regex_global:
5064 vtable = &PL_vtbl_mglob;
5066 case PERL_MAGIC_isa:
5067 vtable = &PL_vtbl_isa;
5069 case PERL_MAGIC_isaelem:
5070 vtable = &PL_vtbl_isaelem;
5072 case PERL_MAGIC_nkeys:
5073 vtable = &PL_vtbl_nkeys;
5075 case PERL_MAGIC_dbfile:
5078 case PERL_MAGIC_dbline:
5079 vtable = &PL_vtbl_dbline;
5081 #ifdef USE_LOCALE_COLLATE
5082 case PERL_MAGIC_collxfrm:
5083 vtable = &PL_vtbl_collxfrm;
5085 #endif /* USE_LOCALE_COLLATE */
5086 case PERL_MAGIC_tied:
5087 vtable = &PL_vtbl_pack;
5089 case PERL_MAGIC_tiedelem:
5090 case PERL_MAGIC_tiedscalar:
5091 vtable = &PL_vtbl_packelem;
5094 vtable = &PL_vtbl_regexp;
5096 case PERL_MAGIC_sig:
5097 vtable = &PL_vtbl_sig;
5099 case PERL_MAGIC_sigelem:
5100 vtable = &PL_vtbl_sigelem;
5102 case PERL_MAGIC_taint:
5103 vtable = &PL_vtbl_taint;
5105 case PERL_MAGIC_uvar:
5106 vtable = &PL_vtbl_uvar;
5108 case PERL_MAGIC_vec:
5109 vtable = &PL_vtbl_vec;
5111 case PERL_MAGIC_arylen_p:
5112 case PERL_MAGIC_rhash:
5113 case PERL_MAGIC_symtab:
5114 case PERL_MAGIC_vstring:
5117 case PERL_MAGIC_utf8:
5118 vtable = &PL_vtbl_utf8;
5120 case PERL_MAGIC_substr:
5121 vtable = &PL_vtbl_substr;
5123 case PERL_MAGIC_defelem:
5124 vtable = &PL_vtbl_defelem;
5126 case PERL_MAGIC_glob:
5127 vtable = &PL_vtbl_glob;
5129 case PERL_MAGIC_arylen:
5130 vtable = &PL_vtbl_arylen;
5132 case PERL_MAGIC_pos:
5133 vtable = &PL_vtbl_pos;
5135 case PERL_MAGIC_backref:
5136 vtable = &PL_vtbl_backref;
5138 case PERL_MAGIC_ext:
5139 /* Reserved for use by extensions not perl internals. */
5140 /* Useful for attaching extension internal data to perl vars. */
5141 /* Note that multiple extensions may clash if magical scalars */
5142 /* etc holding private data from one are passed to another. */
5145 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5148 /* Rest of work is done else where */
5149 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5152 case PERL_MAGIC_taint:
5155 case PERL_MAGIC_ext:
5156 case PERL_MAGIC_dbfile:
5163 =for apidoc sv_unmagic
5165 Removes all magic of type C<type> from an SV.
5171 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5175 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5178 for (mg = *mgp; mg; mg = *mgp) {
5179 if (mg->mg_type == type) {
5180 const MGVTBL* const vtbl = mg->mg_virtual;
5181 *mgp = mg->mg_moremagic;
5182 if (vtbl && vtbl->svt_free)
5183 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5184 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5186 Safefree(mg->mg_ptr);
5187 else if (mg->mg_len == HEf_SVKEY)
5188 SvREFCNT_dec((SV*)mg->mg_ptr);
5189 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5190 Safefree(mg->mg_ptr);
5192 if (mg->mg_flags & MGf_REFCOUNTED)
5193 SvREFCNT_dec(mg->mg_obj);
5197 mgp = &mg->mg_moremagic;
5201 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5208 =for apidoc sv_rvweaken
5210 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5211 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5212 push a back-reference to this RV onto the array of backreferences
5213 associated with that magic.
5219 Perl_sv_rvweaken(pTHX_ SV *sv)
5222 if (!SvOK(sv)) /* let undefs pass */
5225 Perl_croak(aTHX_ "Can't weaken a nonreference");
5226 else if (SvWEAKREF(sv)) {
5227 if (ckWARN(WARN_MISC))
5228 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5232 Perl_sv_add_backref(aTHX_ tsv, sv);
5238 /* Give tsv backref magic if it hasn't already got it, then push a
5239 * back-reference to sv onto the array associated with the backref magic.
5243 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5247 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5248 av = (AV*)mg->mg_obj;
5251 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5252 /* av now has a refcnt of 2, which avoids it getting freed
5253 * before us during global cleanup. The extra ref is removed
5254 * by magic_killbackrefs() when tsv is being freed */
5256 if (AvFILLp(av) >= AvMAX(av)) {
5257 av_extend(av, AvFILLp(av)+1);
5259 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5262 /* delete a back-reference to ourselves from the backref magic associated
5263 * with the SV we point to.
5267 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5273 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5274 if (PL_in_clean_all)
5277 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5278 Perl_croak(aTHX_ "panic: del_backref");
5279 av = (AV *)mg->mg_obj;
5281 /* We shouldn't be in here more than once, but for paranoia reasons lets
5283 for (i = AvFILLp(av); i >= 0; i--) {
5285 const SSize_t fill = AvFILLp(av);
5287 /* We weren't the last entry.
5288 An unordered list has this property that you can take the
5289 last element off the end to fill the hole, and it's still
5290 an unordered list :-)
5295 AvFILLp(av) = fill - 1;
5301 =for apidoc sv_insert
5303 Inserts a string at the specified offset/length within the SV. Similar to
5304 the Perl substr() function.
5310 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5314 register char *midend;
5315 register char *bigend;
5321 Perl_croak(aTHX_ "Can't modify non-existent substring");
5322 SvPV_force(bigstr, curlen);
5323 (void)SvPOK_only_UTF8(bigstr);
5324 if (offset + len > curlen) {
5325 SvGROW(bigstr, offset+len+1);
5326 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5327 SvCUR_set(bigstr, offset+len);
5331 i = littlelen - len;
5332 if (i > 0) { /* string might grow */
5333 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5334 mid = big + offset + len;
5335 midend = bigend = big + SvCUR(bigstr);
5338 while (midend > mid) /* shove everything down */
5339 *--bigend = *--midend;
5340 Move(little,big+offset,littlelen,char);
5341 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5346 Move(little,SvPVX(bigstr)+offset,len,char);
5351 big = SvPVX(bigstr);
5354 bigend = big + SvCUR(bigstr);
5356 if (midend > bigend)
5357 Perl_croak(aTHX_ "panic: sv_insert");
5359 if (mid - big > bigend - midend) { /* faster to shorten from end */
5361 Move(little, mid, littlelen,char);
5364 i = bigend - midend;
5366 Move(midend, mid, i,char);
5370 SvCUR_set(bigstr, mid - big);
5372 else if ((i = mid - big)) { /* faster from front */
5373 midend -= littlelen;
5375 sv_chop(bigstr,midend-i);
5380 Move(little, mid, littlelen,char);
5382 else if (littlelen) {
5383 midend -= littlelen;
5384 sv_chop(bigstr,midend);
5385 Move(little,midend,littlelen,char);
5388 sv_chop(bigstr,midend);
5394 =for apidoc sv_replace
5396 Make the first argument a copy of the second, then delete the original.
5397 The target SV physically takes over ownership of the body of the source SV
5398 and inherits its flags; however, the target keeps any magic it owns,
5399 and any magic in the source is discarded.
5400 Note that this is a rather specialist SV copying operation; most of the
5401 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5407 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5409 const U32 refcnt = SvREFCNT(sv);
5410 SV_CHECK_THINKFIRST_COW_DROP(sv);
5411 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5412 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5413 if (SvMAGICAL(sv)) {
5417 sv_upgrade(nsv, SVt_PVMG);
5418 SvMAGIC_set(nsv, SvMAGIC(sv));
5419 SvFLAGS(nsv) |= SvMAGICAL(sv);
5421 SvMAGIC_set(sv, NULL);
5425 assert(!SvREFCNT(sv));
5426 #ifdef DEBUG_LEAKING_SCALARS
5427 sv->sv_flags = nsv->sv_flags;
5428 sv->sv_any = nsv->sv_any;
5429 sv->sv_refcnt = nsv->sv_refcnt;
5430 sv->sv_u = nsv->sv_u;
5432 StructCopy(nsv,sv,SV);
5434 /* Currently could join these into one piece of pointer arithmetic, but
5435 it would be unclear. */
5436 if(SvTYPE(sv) == SVt_IV)
5438 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5439 else if (SvTYPE(sv) == SVt_RV) {
5440 SvANY(sv) = &sv->sv_u.svu_rv;
5444 #ifdef PERL_OLD_COPY_ON_WRITE
5445 if (SvIsCOW_normal(nsv)) {
5446 /* We need to follow the pointers around the loop to make the
5447 previous SV point to sv, rather than nsv. */
5450 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5453 assert(SvPVX_const(current) == SvPVX_const(nsv));
5455 /* Make the SV before us point to the SV after us. */
5457 PerlIO_printf(Perl_debug_log, "previous is\n");
5459 PerlIO_printf(Perl_debug_log,
5460 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5461 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5463 SV_COW_NEXT_SV_SET(current, sv);
5466 SvREFCNT(sv) = refcnt;
5467 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5473 =for apidoc sv_clear
5475 Clear an SV: call any destructors, free up any memory used by the body,
5476 and free the body itself. The SV's head is I<not> freed, although
5477 its type is set to all 1's so that it won't inadvertently be assumed
5478 to be live during global destruction etc.
5479 This function should only be called when REFCNT is zero. Most of the time
5480 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5487 Perl_sv_clear(pTHX_ register SV *sv)
5490 void** old_body_arena;
5491 size_t old_body_offset;
5492 const U32 type = SvTYPE(sv);
5495 assert(SvREFCNT(sv) == 0);
5501 old_body_offset = 0;
5504 if (PL_defstash) { /* Still have a symbol table? */
5509 stash = SvSTASH(sv);
5510 destructor = StashHANDLER(stash,DESTROY);
5512 SV* const tmpref = newRV(sv);
5513 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5515 PUSHSTACKi(PERLSI_DESTROY);
5520 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5526 if(SvREFCNT(tmpref) < 2) {
5527 /* tmpref is not kept alive! */
5529 SvRV_set(tmpref, NULL);
5532 SvREFCNT_dec(tmpref);
5534 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5538 if (PL_in_clean_objs)
5539 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5541 /* DESTROY gave object new lease on life */
5547 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5548 SvOBJECT_off(sv); /* Curse the object. */
5549 if (type != SVt_PVIO)
5550 --PL_sv_objcount; /* XXX Might want something more general */
5553 if (type >= SVt_PVMG) {
5556 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5557 SvREFCNT_dec(SvSTASH(sv));
5562 IoIFP(sv) != PerlIO_stdin() &&
5563 IoIFP(sv) != PerlIO_stdout() &&
5564 IoIFP(sv) != PerlIO_stderr())
5566 io_close((IO*)sv, FALSE);
5568 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5569 PerlDir_close(IoDIRP(sv));
5570 IoDIRP(sv) = (DIR*)NULL;
5571 Safefree(IoTOP_NAME(sv));
5572 Safefree(IoFMT_NAME(sv));
5573 Safefree(IoBOTTOM_NAME(sv));
5574 /* PVIOs aren't from arenas */
5577 old_body_arena = (void **) &PL_xpvbm_root;
5580 old_body_arena = (void **) &PL_xpvcv_root;
5582 /* PVFMs aren't from arenas */
5587 old_body_arena = (void **) &PL_xpvhv_root;
5588 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5592 old_body_arena = (void **) &PL_xpvav_root;
5593 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5596 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5597 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5598 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5599 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5601 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5602 SvREFCNT_dec(LvTARG(sv));
5603 old_body_arena = (void **) &PL_xpvlv_root;
5607 Safefree(GvNAME(sv));
5608 /* If we're in a stash, we don't own a reference to it. However it does
5609 have a back reference to us, which needs to be cleared. */
5611 sv_del_backref((SV*)GvSTASH(sv), sv);
5612 old_body_arena = (void **) &PL_xpvgv_root;
5615 old_body_arena = (void **) &PL_xpvmg_root;
5618 old_body_arena = (void **) &PL_xpvnv_root;
5621 old_body_arena = (void **) &PL_xpviv_root;
5622 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5624 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5626 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5627 /* Don't even bother with turning off the OOK flag. */
5631 old_body_arena = (void **) &PL_xpv_root;
5632 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5636 SV *target = SvRV(sv);
5638 sv_del_backref(target, sv);
5640 SvREFCNT_dec(target);
5642 #ifdef PERL_OLD_COPY_ON_WRITE
5643 else if (SvPVX_const(sv)) {
5645 /* I believe I need to grab the global SV mutex here and
5646 then recheck the COW status. */
5648 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5651 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5652 SV_COW_NEXT_SV(sv));
5653 /* And drop it here. */
5655 } else if (SvLEN(sv)) {
5656 Safefree(SvPVX_const(sv));
5660 else if (SvPVX_const(sv) && SvLEN(sv))
5661 Safefree(SvPVX_mutable(sv));
5662 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5663 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5669 old_body_arena = (void **) &PL_xnv_root;
5673 SvFLAGS(sv) &= SVf_BREAK;
5674 SvFLAGS(sv) |= SVTYPEMASK;
5677 if (old_body_arena) {
5678 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5682 if (type > SVt_RV) {
5683 my_safefree(SvANY(sv));
5688 =for apidoc sv_newref
5690 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5697 Perl_sv_newref(pTHX_ SV *sv)
5707 Decrement an SV's reference count, and if it drops to zero, call
5708 C<sv_clear> to invoke destructors and free up any memory used by
5709 the body; finally, deallocate the SV's head itself.
5710 Normally called via a wrapper macro C<SvREFCNT_dec>.
5716 Perl_sv_free(pTHX_ SV *sv)
5721 if (SvREFCNT(sv) == 0) {
5722 if (SvFLAGS(sv) & SVf_BREAK)
5723 /* this SV's refcnt has been artificially decremented to
5724 * trigger cleanup */
5726 if (PL_in_clean_all) /* All is fair */
5728 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5729 /* make sure SvREFCNT(sv)==0 happens very seldom */
5730 SvREFCNT(sv) = (~(U32)0)/2;
5733 if (ckWARN_d(WARN_INTERNAL)) {
5734 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5735 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5736 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5737 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5738 Perl_dump_sv_child(aTHX_ sv);
5743 if (--(SvREFCNT(sv)) > 0)
5745 Perl_sv_free2(aTHX_ sv);
5749 Perl_sv_free2(pTHX_ SV *sv)
5754 if (ckWARN_d(WARN_DEBUGGING))
5755 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5756 "Attempt to free temp prematurely: SV 0x%"UVxf
5757 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5761 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5762 /* make sure SvREFCNT(sv)==0 happens very seldom */
5763 SvREFCNT(sv) = (~(U32)0)/2;
5774 Returns the length of the string in the SV. Handles magic and type
5775 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5781 Perl_sv_len(pTHX_ register SV *sv)
5789 len = mg_length(sv);
5791 (void)SvPV_const(sv, len);
5796 =for apidoc sv_len_utf8
5798 Returns the number of characters in the string in an SV, counting wide
5799 UTF-8 bytes as a single character. Handles magic and type coercion.
5805 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5806 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5807 * (Note that the mg_len is not the length of the mg_ptr field.)
5812 Perl_sv_len_utf8(pTHX_ register SV *sv)
5818 return mg_length(sv);
5822 const U8 *s = (U8*)SvPV_const(sv, len);
5823 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5825 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5827 #ifdef PERL_UTF8_CACHE_ASSERT
5828 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5832 ulen = Perl_utf8_length(aTHX_ s, s + len);
5833 if (!mg && !SvREADONLY(sv)) {
5834 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5835 mg = mg_find(sv, PERL_MAGIC_utf8);
5845 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5846 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5847 * between UTF-8 and byte offsets. There are two (substr offset and substr
5848 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5849 * and byte offset) cache positions.
5851 * The mg_len field is used by sv_len_utf8(), see its comments.
5852 * Note that the mg_len is not the length of the mg_ptr field.
5856 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5857 I32 offsetp, const U8 *s, const U8 *start)
5861 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5863 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5867 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5869 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5870 (*mgp)->mg_ptr = (char *) *cachep;
5874 (*cachep)[i] = offsetp;
5875 (*cachep)[i+1] = s - start;
5883 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5884 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5885 * between UTF-8 and byte offsets. See also the comments of
5886 * S_utf8_mg_pos_init().
5890 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)
5894 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5896 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5897 if (*mgp && (*mgp)->mg_ptr) {
5898 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5899 ASSERT_UTF8_CACHE(*cachep);
5900 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5902 else { /* We will skip to the right spot. */
5907 /* The assumption is that going backward is half
5908 * the speed of going forward (that's where the
5909 * 2 * backw in the below comes from). (The real
5910 * figure of course depends on the UTF-8 data.) */
5912 if ((*cachep)[i] > (STRLEN)uoff) {
5914 backw = (*cachep)[i] - (STRLEN)uoff;
5916 if (forw < 2 * backw)
5919 p = start + (*cachep)[i+1];
5921 /* Try this only for the substr offset (i == 0),
5922 * not for the substr length (i == 2). */
5923 else if (i == 0) { /* (*cachep)[i] < uoff */
5924 const STRLEN ulen = sv_len_utf8(sv);
5926 if ((STRLEN)uoff < ulen) {
5927 forw = (STRLEN)uoff - (*cachep)[i];
5928 backw = ulen - (STRLEN)uoff;
5930 if (forw < 2 * backw)
5931 p = start + (*cachep)[i+1];
5936 /* If the string is not long enough for uoff,
5937 * we could extend it, but not at this low a level. */
5941 if (forw < 2 * backw) {
5948 while (UTF8_IS_CONTINUATION(*p))
5953 /* Update the cache. */
5954 (*cachep)[i] = (STRLEN)uoff;
5955 (*cachep)[i+1] = p - start;
5957 /* Drop the stale "length" cache */
5966 if (found) { /* Setup the return values. */
5967 *offsetp = (*cachep)[i+1];
5968 *sp = start + *offsetp;
5971 *offsetp = send - start;
5973 else if (*sp < start) {
5979 #ifdef PERL_UTF8_CACHE_ASSERT
5984 while (n-- && s < send)
5988 assert(*offsetp == s - start);
5989 assert((*cachep)[0] == (STRLEN)uoff);
5990 assert((*cachep)[1] == *offsetp);
5992 ASSERT_UTF8_CACHE(*cachep);
6001 =for apidoc sv_pos_u2b
6003 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6004 the start of the string, to a count of the equivalent number of bytes; if
6005 lenp is non-zero, it does the same to lenp, but this time starting from
6006 the offset, rather than from the start of the string. Handles magic and
6013 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6014 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6015 * byte offsets. See also the comments of S_utf8_mg_pos().
6020 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6028 start = (U8*)SvPV_const(sv, len);
6032 const U8 *s = start;
6033 I32 uoffset = *offsetp;
6034 const U8 * const send = s + len;
6038 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6040 if (!found && uoffset > 0) {
6041 while (s < send && uoffset--)
6045 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6047 *offsetp = s - start;
6052 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6056 if (!found && *lenp > 0) {
6059 while (s < send && ulen--)
6063 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6067 ASSERT_UTF8_CACHE(cache);
6079 =for apidoc sv_pos_b2u
6081 Converts the value pointed to by offsetp from a count of bytes from the
6082 start of the string, to a count of the equivalent number of UTF-8 chars.
6083 Handles magic and type coercion.
6089 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6090 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6091 * byte offsets. See also the comments of S_utf8_mg_pos().
6096 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6104 s = (const U8*)SvPV_const(sv, len);
6105 if ((I32)len < *offsetp)
6106 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6108 const U8* send = s + *offsetp;
6110 STRLEN *cache = NULL;
6114 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6115 mg = mg_find(sv, PERL_MAGIC_utf8);
6116 if (mg && mg->mg_ptr) {
6117 cache = (STRLEN *) mg->mg_ptr;
6118 if (cache[1] == (STRLEN)*offsetp) {
6119 /* An exact match. */
6120 *offsetp = cache[0];
6124 else if (cache[1] < (STRLEN)*offsetp) {
6125 /* We already know part of the way. */
6128 /* Let the below loop do the rest. */
6130 else { /* cache[1] > *offsetp */
6131 /* We already know all of the way, now we may
6132 * be able to walk back. The same assumption
6133 * is made as in S_utf8_mg_pos(), namely that
6134 * walking backward is twice slower than
6135 * walking forward. */
6136 const STRLEN forw = *offsetp;
6137 STRLEN backw = cache[1] - *offsetp;
6139 if (!(forw < 2 * backw)) {
6140 const U8 *p = s + cache[1];
6147 while (UTF8_IS_CONTINUATION(*p)) {
6155 *offsetp = cache[0];
6157 /* Drop the stale "length" cache */
6165 ASSERT_UTF8_CACHE(cache);
6171 /* Call utf8n_to_uvchr() to validate the sequence
6172 * (unless a simple non-UTF character) */
6173 if (!UTF8_IS_INVARIANT(*s))
6174 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6183 if (!SvREADONLY(sv)) {
6185 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6186 mg = mg_find(sv, PERL_MAGIC_utf8);
6191 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6192 mg->mg_ptr = (char *) cache;
6197 cache[1] = *offsetp;
6198 /* Drop the stale "length" cache */
6211 Returns a boolean indicating whether the strings in the two SVs are
6212 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6213 coerce its args to strings if necessary.
6219 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6227 SV* svrecode = Nullsv;
6234 pv1 = SvPV_const(sv1, cur1);
6241 pv2 = SvPV_const(sv2, cur2);
6243 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6244 /* Differing utf8ness.
6245 * Do not UTF8size the comparands as a side-effect. */
6248 svrecode = newSVpvn(pv2, cur2);
6249 sv_recode_to_utf8(svrecode, PL_encoding);
6250 pv2 = SvPV_const(svrecode, cur2);
6253 svrecode = newSVpvn(pv1, cur1);
6254 sv_recode_to_utf8(svrecode, PL_encoding);
6255 pv1 = SvPV_const(svrecode, cur1);
6257 /* Now both are in UTF-8. */
6259 SvREFCNT_dec(svrecode);
6264 bool is_utf8 = TRUE;
6267 /* sv1 is the UTF-8 one,
6268 * if is equal it must be downgrade-able */
6269 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6275 /* sv2 is the UTF-8 one,
6276 * if is equal it must be downgrade-able */
6277 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6283 /* Downgrade not possible - cannot be eq */
6291 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6294 SvREFCNT_dec(svrecode);
6305 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6306 string in C<sv1> is less than, equal to, or greater than the string in
6307 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6308 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6314 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6317 const char *pv1, *pv2;
6320 SV *svrecode = Nullsv;
6327 pv1 = SvPV_const(sv1, cur1);
6334 pv2 = SvPV_const(sv2, cur2);
6336 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6337 /* Differing utf8ness.
6338 * Do not UTF8size the comparands as a side-effect. */
6341 svrecode = newSVpvn(pv2, cur2);
6342 sv_recode_to_utf8(svrecode, PL_encoding);
6343 pv2 = SvPV_const(svrecode, cur2);
6346 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6351 svrecode = newSVpvn(pv1, cur1);
6352 sv_recode_to_utf8(svrecode, PL_encoding);
6353 pv1 = SvPV_const(svrecode, cur1);
6356 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6362 cmp = cur2 ? -1 : 0;
6366 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6369 cmp = retval < 0 ? -1 : 1;
6370 } else if (cur1 == cur2) {
6373 cmp = cur1 < cur2 ? -1 : 1;
6378 SvREFCNT_dec(svrecode);
6387 =for apidoc sv_cmp_locale
6389 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6390 'use bytes' aware, handles get magic, and will coerce its args to strings
6391 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6397 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6399 #ifdef USE_LOCALE_COLLATE
6405 if (PL_collation_standard)
6409 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6411 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6413 if (!pv1 || !len1) {
6424 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6427 return retval < 0 ? -1 : 1;
6430 * When the result of collation is equality, that doesn't mean
6431 * that there are no differences -- some locales exclude some
6432 * characters from consideration. So to avoid false equalities,
6433 * we use the raw string as a tiebreaker.
6439 #endif /* USE_LOCALE_COLLATE */
6441 return sv_cmp(sv1, sv2);
6445 #ifdef USE_LOCALE_COLLATE
6448 =for apidoc sv_collxfrm
6450 Add Collate Transform magic to an SV if it doesn't already have it.
6452 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6453 scalar data of the variable, but transformed to such a format that a normal
6454 memory comparison can be used to compare the data according to the locale
6461 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6465 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6466 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6472 Safefree(mg->mg_ptr);
6473 s = SvPV_const(sv, len);
6474 if ((xf = mem_collxfrm(s, len, &xlen))) {
6475 if (SvREADONLY(sv)) {
6478 return xf + sizeof(PL_collation_ix);
6481 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6482 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6495 if (mg && mg->mg_ptr) {
6497 return mg->mg_ptr + sizeof(PL_collation_ix);
6505 #endif /* USE_LOCALE_COLLATE */
6510 Get a line from the filehandle and store it into the SV, optionally
6511 appending to the currently-stored string.
6517 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6521 register STDCHAR rslast;
6522 register STDCHAR *bp;
6528 if (SvTHINKFIRST(sv))
6529 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6530 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6532 However, perlbench says it's slower, because the existing swipe code
6533 is faster than copy on write.
6534 Swings and roundabouts. */
6535 SvUPGRADE(sv, SVt_PV);
6540 if (PerlIO_isutf8(fp)) {
6542 sv_utf8_upgrade_nomg(sv);
6543 sv_pos_u2b(sv,&append,0);
6545 } else if (SvUTF8(sv)) {
6546 SV * const tsv = NEWSV(0,0);
6547 sv_gets(tsv, fp, 0);
6548 sv_utf8_upgrade_nomg(tsv);
6549 SvCUR_set(sv,append);
6552 goto return_string_or_null;
6557 if (PerlIO_isutf8(fp))
6560 if (IN_PERL_COMPILETIME) {
6561 /* we always read code in line mode */
6565 else if (RsSNARF(PL_rs)) {
6566 /* If it is a regular disk file use size from stat() as estimate
6567 of amount we are going to read - may result in malloc-ing
6568 more memory than we realy need if layers bellow reduce
6569 size we read (e.g. CRLF or a gzip layer)
6572 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6573 const Off_t offset = PerlIO_tell(fp);
6574 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6575 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6581 else if (RsRECORD(PL_rs)) {
6585 /* Grab the size of the record we're getting */
6586 recsize = SvIV(SvRV(PL_rs));
6587 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6590 /* VMS wants read instead of fread, because fread doesn't respect */
6591 /* RMS record boundaries. This is not necessarily a good thing to be */
6592 /* doing, but we've got no other real choice - except avoid stdio
6593 as implementation - perhaps write a :vms layer ?
6595 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6597 bytesread = PerlIO_read(fp, buffer, recsize);
6601 SvCUR_set(sv, bytesread += append);
6602 buffer[bytesread] = '\0';
6603 goto return_string_or_null;
6605 else if (RsPARA(PL_rs)) {
6611 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6612 if (PerlIO_isutf8(fp)) {
6613 rsptr = SvPVutf8(PL_rs, rslen);
6616 if (SvUTF8(PL_rs)) {
6617 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6618 Perl_croak(aTHX_ "Wide character in $/");
6621 rsptr = SvPV_const(PL_rs, rslen);
6625 rslast = rslen ? rsptr[rslen - 1] : '\0';
6627 if (rspara) { /* have to do this both before and after */
6628 do { /* to make sure file boundaries work right */
6631 i = PerlIO_getc(fp);
6635 PerlIO_ungetc(fp,i);
6641 /* See if we know enough about I/O mechanism to cheat it ! */
6643 /* This used to be #ifdef test - it is made run-time test for ease
6644 of abstracting out stdio interface. One call should be cheap
6645 enough here - and may even be a macro allowing compile
6649 if (PerlIO_fast_gets(fp)) {
6652 * We're going to steal some values from the stdio struct
6653 * and put EVERYTHING in the innermost loop into registers.
6655 register STDCHAR *ptr;
6659 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6660 /* An ungetc()d char is handled separately from the regular
6661 * buffer, so we getc() it back out and stuff it in the buffer.
6663 i = PerlIO_getc(fp);
6664 if (i == EOF) return 0;
6665 *(--((*fp)->_ptr)) = (unsigned char) i;
6669 /* Here is some breathtakingly efficient cheating */
6671 cnt = PerlIO_get_cnt(fp); /* get count into register */
6672 /* make sure we have the room */
6673 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6674 /* Not room for all of it
6675 if we are looking for a separator and room for some
6677 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6678 /* just process what we have room for */
6679 shortbuffered = cnt - SvLEN(sv) + append + 1;
6680 cnt -= shortbuffered;
6684 /* remember that cnt can be negative */
6685 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6690 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6691 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6692 DEBUG_P(PerlIO_printf(Perl_debug_log,
6693 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6694 DEBUG_P(PerlIO_printf(Perl_debug_log,
6695 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6696 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6697 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6702 while (cnt > 0) { /* this | eat */
6704 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6705 goto thats_all_folks; /* screams | sed :-) */
6709 Copy(ptr, bp, cnt, char); /* this | eat */
6710 bp += cnt; /* screams | dust */
6711 ptr += cnt; /* louder | sed :-) */
6716 if (shortbuffered) { /* oh well, must extend */
6717 cnt = shortbuffered;
6719 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6721 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6722 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6726 DEBUG_P(PerlIO_printf(Perl_debug_log,
6727 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6728 PTR2UV(ptr),(long)cnt));
6729 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6731 DEBUG_P(PerlIO_printf(Perl_debug_log,
6732 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6733 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6734 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6736 /* This used to call 'filbuf' in stdio form, but as that behaves like
6737 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6738 another abstraction. */
6739 i = PerlIO_getc(fp); /* get more characters */
6741 DEBUG_P(PerlIO_printf(Perl_debug_log,
6742 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6743 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6744 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6746 cnt = PerlIO_get_cnt(fp);
6747 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6748 DEBUG_P(PerlIO_printf(Perl_debug_log,
6749 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6751 if (i == EOF) /* all done for ever? */
6752 goto thats_really_all_folks;
6754 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6756 SvGROW(sv, bpx + cnt + 2);
6757 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6759 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6761 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6762 goto thats_all_folks;
6766 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6767 memNE((char*)bp - rslen, rsptr, rslen))
6768 goto screamer; /* go back to the fray */
6769 thats_really_all_folks:
6771 cnt += shortbuffered;
6772 DEBUG_P(PerlIO_printf(Perl_debug_log,
6773 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6774 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6775 DEBUG_P(PerlIO_printf(Perl_debug_log,
6776 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6777 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6778 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6780 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6781 DEBUG_P(PerlIO_printf(Perl_debug_log,
6782 "Screamer: done, len=%ld, string=|%.*s|\n",
6783 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6787 /*The big, slow, and stupid way. */
6788 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6790 Newx(buf, 8192, STDCHAR);
6798 const register STDCHAR *bpe = buf + sizeof(buf);
6800 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6801 ; /* keep reading */
6805 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6806 /* Accomodate broken VAXC compiler, which applies U8 cast to
6807 * both args of ?: operator, causing EOF to change into 255
6810 i = (U8)buf[cnt - 1];
6816 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6818 sv_catpvn(sv, (char *) buf, cnt);
6820 sv_setpvn(sv, (char *) buf, cnt);
6822 if (i != EOF && /* joy */
6824 SvCUR(sv) < rslen ||
6825 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6829 * If we're reading from a TTY and we get a short read,
6830 * indicating that the user hit his EOF character, we need
6831 * to notice it now, because if we try to read from the TTY
6832 * again, the EOF condition will disappear.
6834 * The comparison of cnt to sizeof(buf) is an optimization
6835 * that prevents unnecessary calls to feof().
6839 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6843 #ifdef USE_HEAP_INSTEAD_OF_STACK
6848 if (rspara) { /* have to do this both before and after */
6849 while (i != EOF) { /* to make sure file boundaries work right */
6850 i = PerlIO_getc(fp);
6852 PerlIO_ungetc(fp,i);
6858 return_string_or_null:
6859 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6865 Auto-increment of the value in the SV, doing string to numeric conversion
6866 if necessary. Handles 'get' magic.
6872 Perl_sv_inc(pTHX_ register SV *sv)
6881 if (SvTHINKFIRST(sv)) {
6883 sv_force_normal_flags(sv, 0);
6884 if (SvREADONLY(sv)) {
6885 if (IN_PERL_RUNTIME)
6886 Perl_croak(aTHX_ PL_no_modify);
6890 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6892 i = PTR2IV(SvRV(sv));
6897 flags = SvFLAGS(sv);
6898 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6899 /* It's (privately or publicly) a float, but not tested as an
6900 integer, so test it to see. */
6902 flags = SvFLAGS(sv);
6904 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6905 /* It's publicly an integer, or privately an integer-not-float */
6906 #ifdef PERL_PRESERVE_IVUV
6910 if (SvUVX(sv) == UV_MAX)
6911 sv_setnv(sv, UV_MAX_P1);
6913 (void)SvIOK_only_UV(sv);
6914 SvUV_set(sv, SvUVX(sv) + 1);
6916 if (SvIVX(sv) == IV_MAX)
6917 sv_setuv(sv, (UV)IV_MAX + 1);
6919 (void)SvIOK_only(sv);
6920 SvIV_set(sv, SvIVX(sv) + 1);
6925 if (flags & SVp_NOK) {
6926 (void)SvNOK_only(sv);
6927 SvNV_set(sv, SvNVX(sv) + 1.0);
6931 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6932 if ((flags & SVTYPEMASK) < SVt_PVIV)
6933 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6934 (void)SvIOK_only(sv);
6939 while (isALPHA(*d)) d++;
6940 while (isDIGIT(*d)) d++;
6942 #ifdef PERL_PRESERVE_IVUV
6943 /* Got to punt this as an integer if needs be, but we don't issue
6944 warnings. Probably ought to make the sv_iv_please() that does
6945 the conversion if possible, and silently. */
6946 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6947 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6948 /* Need to try really hard to see if it's an integer.
6949 9.22337203685478e+18 is an integer.
6950 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6951 so $a="9.22337203685478e+18"; $a+0; $a++
6952 needs to be the same as $a="9.22337203685478e+18"; $a++
6959 /* sv_2iv *should* have made this an NV */
6960 if (flags & SVp_NOK) {
6961 (void)SvNOK_only(sv);
6962 SvNV_set(sv, SvNVX(sv) + 1.0);
6965 /* I don't think we can get here. Maybe I should assert this
6966 And if we do get here I suspect that sv_setnv will croak. NWC
6968 #if defined(USE_LONG_DOUBLE)
6969 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",
6970 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6972 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6973 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6976 #endif /* PERL_PRESERVE_IVUV */
6977 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6981 while (d >= SvPVX_const(sv)) {
6989 /* MKS: The original code here died if letters weren't consecutive.
6990 * at least it didn't have to worry about non-C locales. The
6991 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6992 * arranged in order (although not consecutively) and that only
6993 * [A-Za-z] are accepted by isALPHA in the C locale.
6995 if (*d != 'z' && *d != 'Z') {
6996 do { ++*d; } while (!isALPHA(*d));
6999 *(d--) -= 'z' - 'a';
7004 *(d--) -= 'z' - 'a' + 1;
7008 /* oh,oh, the number grew */
7009 SvGROW(sv, SvCUR(sv) + 2);
7010 SvCUR_set(sv, SvCUR(sv) + 1);
7011 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7022 Auto-decrement of the value in the SV, doing string to numeric conversion
7023 if necessary. Handles 'get' magic.
7029 Perl_sv_dec(pTHX_ register SV *sv)
7037 if (SvTHINKFIRST(sv)) {
7039 sv_force_normal_flags(sv, 0);
7040 if (SvREADONLY(sv)) {
7041 if (IN_PERL_RUNTIME)
7042 Perl_croak(aTHX_ PL_no_modify);
7046 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7048 i = PTR2IV(SvRV(sv));
7053 /* Unlike sv_inc we don't have to worry about string-never-numbers
7054 and keeping them magic. But we mustn't warn on punting */
7055 flags = SvFLAGS(sv);
7056 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7057 /* It's publicly an integer, or privately an integer-not-float */
7058 #ifdef PERL_PRESERVE_IVUV
7062 if (SvUVX(sv) == 0) {
7063 (void)SvIOK_only(sv);
7067 (void)SvIOK_only_UV(sv);
7068 SvUV_set(sv, SvUVX(sv) - 1);
7071 if (SvIVX(sv) == IV_MIN)
7072 sv_setnv(sv, (NV)IV_MIN - 1.0);
7074 (void)SvIOK_only(sv);
7075 SvIV_set(sv, SvIVX(sv) - 1);
7080 if (flags & SVp_NOK) {
7081 SvNV_set(sv, SvNVX(sv) - 1.0);
7082 (void)SvNOK_only(sv);
7085 if (!(flags & SVp_POK)) {
7086 if ((flags & SVTYPEMASK) < SVt_PVIV)
7087 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7089 (void)SvIOK_only(sv);
7092 #ifdef PERL_PRESERVE_IVUV
7094 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7095 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7096 /* Need to try really hard to see if it's an integer.
7097 9.22337203685478e+18 is an integer.
7098 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7099 so $a="9.22337203685478e+18"; $a+0; $a--
7100 needs to be the same as $a="9.22337203685478e+18"; $a--
7107 /* sv_2iv *should* have made this an NV */
7108 if (flags & SVp_NOK) {
7109 (void)SvNOK_only(sv);
7110 SvNV_set(sv, SvNVX(sv) - 1.0);
7113 /* I don't think we can get here. Maybe I should assert this
7114 And if we do get here I suspect that sv_setnv will croak. NWC
7116 #if defined(USE_LONG_DOUBLE)
7117 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",
7118 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7120 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7121 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7125 #endif /* PERL_PRESERVE_IVUV */
7126 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7130 =for apidoc sv_mortalcopy
7132 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7133 The new SV is marked as mortal. It will be destroyed "soon", either by an
7134 explicit call to FREETMPS, or by an implicit call at places such as
7135 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7140 /* Make a string that will exist for the duration of the expression
7141 * evaluation. Actually, it may have to last longer than that, but
7142 * hopefully we won't free it until it has been assigned to a
7143 * permanent location. */
7146 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7151 sv_setsv(sv,oldstr);
7153 PL_tmps_stack[++PL_tmps_ix] = sv;
7159 =for apidoc sv_newmortal
7161 Creates a new null SV which is mortal. The reference count of the SV is
7162 set to 1. It will be destroyed "soon", either by an explicit call to
7163 FREETMPS, or by an implicit call at places such as statement boundaries.
7164 See also C<sv_mortalcopy> and C<sv_2mortal>.
7170 Perl_sv_newmortal(pTHX)
7175 SvFLAGS(sv) = SVs_TEMP;
7177 PL_tmps_stack[++PL_tmps_ix] = sv;
7182 =for apidoc sv_2mortal
7184 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7185 by an explicit call to FREETMPS, or by an implicit call at places such as
7186 statement boundaries. SvTEMP() is turned on which means that the SV's
7187 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7188 and C<sv_mortalcopy>.
7194 Perl_sv_2mortal(pTHX_ register SV *sv)
7199 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7202 PL_tmps_stack[++PL_tmps_ix] = sv;
7210 Creates a new SV and copies a string into it. The reference count for the
7211 SV is set to 1. If C<len> is zero, Perl will compute the length using
7212 strlen(). For efficiency, consider using C<newSVpvn> instead.
7218 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7223 sv_setpvn(sv,s,len ? len : strlen(s));
7228 =for apidoc newSVpvn
7230 Creates a new SV and copies a string into it. The reference count for the
7231 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7232 string. You are responsible for ensuring that the source string is at least
7233 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7239 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7244 sv_setpvn(sv,s,len);
7250 =for apidoc newSVhek
7252 Creates a new SV from the hash key structure. It will generate scalars that
7253 point to the shared string table where possible. Returns a new (undefined)
7254 SV if the hek is NULL.
7260 Perl_newSVhek(pTHX_ const HEK *hek)
7269 if (HEK_LEN(hek) == HEf_SVKEY) {
7270 return newSVsv(*(SV**)HEK_KEY(hek));
7272 const int flags = HEK_FLAGS(hek);
7273 if (flags & HVhek_WASUTF8) {
7275 Andreas would like keys he put in as utf8 to come back as utf8
7277 STRLEN utf8_len = HEK_LEN(hek);
7278 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7279 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7282 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7284 } else if (flags & HVhek_REHASH) {
7285 /* We don't have a pointer to the hv, so we have to replicate the
7286 flag into every HEK. This hv is using custom a hasing
7287 algorithm. Hence we can't return a shared string scalar, as
7288 that would contain the (wrong) hash value, and might get passed
7289 into an hv routine with a regular hash */
7291 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7296 /* This will be overwhelminly the most common case. */
7297 return newSVpvn_share(HEK_KEY(hek),
7298 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7304 =for apidoc newSVpvn_share
7306 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7307 table. If the string does not already exist in the table, it is created
7308 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7309 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7310 otherwise the hash is computed. The idea here is that as the string table
7311 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7312 hash lookup will avoid string compare.
7318 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7321 bool is_utf8 = FALSE;
7323 STRLEN tmplen = -len;
7325 /* See the note in hv.c:hv_fetch() --jhi */
7326 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7330 PERL_HASH(hash, src, len);
7332 sv_upgrade(sv, SVt_PV);
7333 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7345 #if defined(PERL_IMPLICIT_CONTEXT)
7347 /* pTHX_ magic can't cope with varargs, so this is a no-context
7348 * version of the main function, (which may itself be aliased to us).
7349 * Don't access this version directly.
7353 Perl_newSVpvf_nocontext(const char* pat, ...)
7358 va_start(args, pat);
7359 sv = vnewSVpvf(pat, &args);
7366 =for apidoc newSVpvf
7368 Creates a new SV and initializes it with the string formatted like
7375 Perl_newSVpvf(pTHX_ const char* pat, ...)
7379 va_start(args, pat);
7380 sv = vnewSVpvf(pat, &args);
7385 /* backend for newSVpvf() and newSVpvf_nocontext() */
7388 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7392 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7399 Creates a new SV and copies a floating point value into it.
7400 The reference count for the SV is set to 1.
7406 Perl_newSVnv(pTHX_ NV n)
7418 Creates a new SV and copies an integer into it. The reference count for the
7425 Perl_newSViv(pTHX_ IV i)
7437 Creates a new SV and copies an unsigned integer into it.
7438 The reference count for the SV is set to 1.
7444 Perl_newSVuv(pTHX_ UV u)
7454 =for apidoc newRV_noinc
7456 Creates an RV wrapper for an SV. The reference count for the original
7457 SV is B<not> incremented.
7463 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7468 sv_upgrade(sv, SVt_RV);
7470 SvRV_set(sv, tmpRef);
7475 /* newRV_inc is the official function name to use now.
7476 * newRV_inc is in fact #defined to newRV in sv.h
7480 Perl_newRV(pTHX_ SV *tmpRef)
7482 return newRV_noinc(SvREFCNT_inc(tmpRef));
7488 Creates a new SV which is an exact duplicate of the original SV.
7495 Perl_newSVsv(pTHX_ register SV *old)
7501 if (SvTYPE(old) == SVTYPEMASK) {
7502 if (ckWARN_d(WARN_INTERNAL))
7503 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7507 /* SV_GMAGIC is the default for sv_setv()
7508 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7509 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7510 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7515 =for apidoc sv_reset
7517 Underlying implementation for the C<reset> Perl function.
7518 Note that the perl-level function is vaguely deprecated.
7524 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7527 char todo[PERL_UCHAR_MAX+1];
7532 if (!*s) { /* reset ?? searches */
7533 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7535 PMOP *pm = (PMOP *) mg->mg_obj;
7537 pm->op_pmdynflags &= ~PMdf_USED;
7544 /* reset variables */
7546 if (!HvARRAY(stash))
7549 Zero(todo, 256, char);
7552 I32 i = (unsigned char)*s;
7556 max = (unsigned char)*s++;
7557 for ( ; i <= max; i++) {
7560 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7562 for (entry = HvARRAY(stash)[i];
7564 entry = HeNEXT(entry))
7569 if (!todo[(U8)*HeKEY(entry)])
7571 gv = (GV*)HeVAL(entry);
7574 if (SvTHINKFIRST(sv)) {
7575 if (!SvREADONLY(sv) && SvROK(sv))
7577 /* XXX Is this continue a bug? Why should THINKFIRST
7578 exempt us from resetting arrays and hashes? */
7582 if (SvTYPE(sv) >= SVt_PV) {
7584 if (SvPVX_const(sv) != Nullch)
7592 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7595 #ifdef USE_ENVIRON_ARRAY
7597 # ifdef USE_ITHREADS
7598 && PL_curinterp == aTHX
7602 environ[0] = Nullch;
7605 #endif /* !PERL_MICRO */
7615 Using various gambits, try to get an IO from an SV: the IO slot if its a
7616 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7617 named after the PV if we're a string.
7623 Perl_sv_2io(pTHX_ SV *sv)
7628 switch (SvTYPE(sv)) {
7636 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7640 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7642 return sv_2io(SvRV(sv));
7643 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7649 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7658 Using various gambits, try to get a CV from an SV; in addition, try if
7659 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7665 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7672 return *gvp = Nullgv, Nullcv;
7673 switch (SvTYPE(sv)) {
7692 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7693 tryAMAGICunDEREF(to_cv);
7696 if (SvTYPE(sv) == SVt_PVCV) {
7705 Perl_croak(aTHX_ "Not a subroutine reference");
7710 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7716 if (lref && !GvCVu(gv)) {
7719 tmpsv = NEWSV(704,0);
7720 gv_efullname3(tmpsv, gv, Nullch);
7721 /* XXX this is probably not what they think they're getting.
7722 * It has the same effect as "sub name;", i.e. just a forward
7724 newSUB(start_subparse(FALSE, 0),
7725 newSVOP(OP_CONST, 0, tmpsv),
7730 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7740 Returns true if the SV has a true value by Perl's rules.
7741 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7742 instead use an in-line version.
7748 Perl_sv_true(pTHX_ register SV *sv)
7753 const register XPV* tXpv;
7754 if ((tXpv = (XPV*)SvANY(sv)) &&
7755 (tXpv->xpv_cur > 1 ||
7756 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7763 return SvIVX(sv) != 0;
7766 return SvNVX(sv) != 0.0;
7768 return sv_2bool(sv);
7776 A private implementation of the C<SvIVx> macro for compilers which can't
7777 cope with complex macro expressions. Always use the macro instead.
7783 Perl_sv_iv(pTHX_ register SV *sv)
7787 return (IV)SvUVX(sv);
7796 A private implementation of the C<SvUVx> macro for compilers which can't
7797 cope with complex macro expressions. Always use the macro instead.
7803 Perl_sv_uv(pTHX_ register SV *sv)
7808 return (UV)SvIVX(sv);
7816 A private implementation of the C<SvNVx> macro for compilers which can't
7817 cope with complex macro expressions. Always use the macro instead.
7823 Perl_sv_nv(pTHX_ register SV *sv)
7830 /* sv_pv() is now a macro using SvPV_nolen();
7831 * this function provided for binary compatibility only
7835 Perl_sv_pv(pTHX_ SV *sv)
7840 return sv_2pv(sv, 0);
7846 Use the C<SvPV_nolen> macro instead
7850 A private implementation of the C<SvPV> macro for compilers which can't
7851 cope with complex macro expressions. Always use the macro instead.
7857 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7863 return sv_2pv(sv, lp);
7868 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7874 return sv_2pv_flags(sv, lp, 0);
7877 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7878 * this function provided for binary compatibility only
7882 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7884 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7888 =for apidoc sv_pvn_force
7890 Get a sensible string out of the SV somehow.
7891 A private implementation of the C<SvPV_force> macro for compilers which
7892 can't cope with complex macro expressions. Always use the macro instead.
7894 =for apidoc sv_pvn_force_flags
7896 Get a sensible string out of the SV somehow.
7897 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7898 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7899 implemented in terms of this function.
7900 You normally want to use the various wrapper macros instead: see
7901 C<SvPV_force> and C<SvPV_force_nomg>
7907 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7910 if (SvTHINKFIRST(sv) && !SvROK(sv))
7911 sv_force_normal_flags(sv, 0);
7921 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7922 const char * const ref = sv_reftype(sv,0);
7924 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7925 ref, OP_NAME(PL_op));
7927 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7929 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7930 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7932 s = sv_2pv_flags(sv, &len, flags);
7936 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7939 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7940 SvGROW(sv, len + 1);
7941 Move(s,SvPVX_const(sv),len,char);
7946 SvPOK_on(sv); /* validate pointer */
7948 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7949 PTR2UV(sv),SvPVX_const(sv)));
7952 return SvPVX_mutable(sv);
7955 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7956 * this function provided for binary compatibility only
7960 Perl_sv_pvbyte(pTHX_ SV *sv)
7962 sv_utf8_downgrade(sv,0);
7967 =for apidoc sv_pvbyte
7969 Use C<SvPVbyte_nolen> instead.
7971 =for apidoc sv_pvbyten
7973 A private implementation of the C<SvPVbyte> macro for compilers
7974 which can't cope with complex macro expressions. Always use the macro
7981 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7983 sv_utf8_downgrade(sv,0);
7984 return sv_pvn(sv,lp);
7988 =for apidoc sv_pvbyten_force
7990 A private implementation of the C<SvPVbytex_force> macro for compilers
7991 which can't cope with complex macro expressions. Always use the macro
7998 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8000 sv_pvn_force(sv,lp);
8001 sv_utf8_downgrade(sv,0);
8006 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8007 * this function provided for binary compatibility only
8011 Perl_sv_pvutf8(pTHX_ SV *sv)
8013 sv_utf8_upgrade(sv);
8018 =for apidoc sv_pvutf8
8020 Use the C<SvPVutf8_nolen> macro instead
8022 =for apidoc sv_pvutf8n
8024 A private implementation of the C<SvPVutf8> macro for compilers
8025 which can't cope with complex macro expressions. Always use the macro
8032 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8034 sv_utf8_upgrade(sv);
8035 return sv_pvn(sv,lp);
8039 =for apidoc sv_pvutf8n_force
8041 A private implementation of the C<SvPVutf8_force> macro for compilers
8042 which can't cope with complex macro expressions. Always use the macro
8049 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8051 sv_pvn_force(sv,lp);
8052 sv_utf8_upgrade(sv);
8058 =for apidoc sv_reftype
8060 Returns a string describing what the SV is a reference to.
8066 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8068 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8069 inside return suggests a const propagation bug in g++. */
8070 if (ob && SvOBJECT(sv)) {
8071 char * const name = HvNAME_get(SvSTASH(sv));
8072 return name ? name : (char *) "__ANON__";
8075 switch (SvTYPE(sv)) {
8092 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8093 /* tied lvalues should appear to be
8094 * scalars for backwards compatitbility */
8095 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8096 ? "SCALAR" : "LVALUE");
8097 case SVt_PVAV: return "ARRAY";
8098 case SVt_PVHV: return "HASH";
8099 case SVt_PVCV: return "CODE";
8100 case SVt_PVGV: return "GLOB";
8101 case SVt_PVFM: return "FORMAT";
8102 case SVt_PVIO: return "IO";
8103 default: return "UNKNOWN";
8109 =for apidoc sv_isobject
8111 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8112 object. If the SV is not an RV, or if the object is not blessed, then this
8119 Perl_sv_isobject(pTHX_ SV *sv)
8136 Returns a boolean indicating whether the SV is blessed into the specified
8137 class. This does not check for subtypes; use C<sv_derived_from> to verify
8138 an inheritance relationship.
8144 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8156 hvname = HvNAME_get(SvSTASH(sv));
8160 return strEQ(hvname, name);
8166 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8167 it will be upgraded to one. If C<classname> is non-null then the new SV will
8168 be blessed in the specified package. The new SV is returned and its
8169 reference count is 1.
8175 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8181 SV_CHECK_THINKFIRST_COW_DROP(rv);
8184 if (SvTYPE(rv) >= SVt_PVMG) {
8185 const U32 refcnt = SvREFCNT(rv);
8189 SvREFCNT(rv) = refcnt;
8192 if (SvTYPE(rv) < SVt_RV)
8193 sv_upgrade(rv, SVt_RV);
8194 else if (SvTYPE(rv) > SVt_RV) {
8205 HV* const stash = gv_stashpv(classname, TRUE);
8206 (void)sv_bless(rv, stash);
8212 =for apidoc sv_setref_pv
8214 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8215 argument will be upgraded to an RV. That RV will be modified to point to
8216 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8217 into the SV. The C<classname> argument indicates the package for the
8218 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8219 will have a reference count of 1, and the RV will be returned.
8221 Do not use with other Perl types such as HV, AV, SV, CV, because those
8222 objects will become corrupted by the pointer copy process.
8224 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8230 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8233 sv_setsv(rv, &PL_sv_undef);
8237 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8242 =for apidoc sv_setref_iv
8244 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8245 argument will be upgraded to an RV. That RV will be modified to point to
8246 the new SV. The C<classname> argument indicates the package for the
8247 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8248 will have a reference count of 1, and the RV will be returned.
8254 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8256 sv_setiv(newSVrv(rv,classname), iv);
8261 =for apidoc sv_setref_uv
8263 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8264 argument will be upgraded to an RV. That RV will be modified to point to
8265 the new SV. The C<classname> argument indicates the package for the
8266 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8267 will have a reference count of 1, and the RV will be returned.
8273 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8275 sv_setuv(newSVrv(rv,classname), uv);
8280 =for apidoc sv_setref_nv
8282 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8283 argument will be upgraded to an RV. That RV will be modified to point to
8284 the new SV. The C<classname> argument indicates the package for the
8285 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8286 will have a reference count of 1, and the RV will be returned.
8292 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8294 sv_setnv(newSVrv(rv,classname), nv);
8299 =for apidoc sv_setref_pvn
8301 Copies a string into a new SV, optionally blessing the SV. The length of the
8302 string must be specified with C<n>. The C<rv> argument will be upgraded to
8303 an RV. That RV will be modified to point to the new SV. The C<classname>
8304 argument indicates the package for the blessing. Set C<classname> to
8305 C<Nullch> to avoid the blessing. The new SV will have a reference count
8306 of 1, and the RV will be returned.
8308 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8314 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8316 sv_setpvn(newSVrv(rv,classname), pv, n);
8321 =for apidoc sv_bless
8323 Blesses an SV into a specified package. The SV must be an RV. The package
8324 must be designated by its stash (see C<gv_stashpv()>). The reference count
8325 of the SV is unaffected.
8331 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8335 Perl_croak(aTHX_ "Can't bless non-reference value");
8337 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8338 if (SvREADONLY(tmpRef))
8339 Perl_croak(aTHX_ PL_no_modify);
8340 if (SvOBJECT(tmpRef)) {
8341 if (SvTYPE(tmpRef) != SVt_PVIO)
8343 SvREFCNT_dec(SvSTASH(tmpRef));
8346 SvOBJECT_on(tmpRef);
8347 if (SvTYPE(tmpRef) != SVt_PVIO)
8349 SvUPGRADE(tmpRef, SVt_PVMG);
8350 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8357 if(SvSMAGICAL(tmpRef))
8358 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8366 /* Downgrades a PVGV to a PVMG.
8370 S_sv_unglob(pTHX_ SV *sv)
8374 assert(SvTYPE(sv) == SVt_PVGV);
8379 sv_del_backref((SV*)GvSTASH(sv), sv);
8380 GvSTASH(sv) = Nullhv;
8382 sv_unmagic(sv, PERL_MAGIC_glob);
8383 Safefree(GvNAME(sv));
8386 /* need to keep SvANY(sv) in the right arena */
8387 xpvmg = new_XPVMG();
8388 StructCopy(SvANY(sv), xpvmg, XPVMG);
8389 del_XPVGV(SvANY(sv));
8392 SvFLAGS(sv) &= ~SVTYPEMASK;
8393 SvFLAGS(sv) |= SVt_PVMG;
8397 =for apidoc sv_unref_flags
8399 Unsets the RV status of the SV, and decrements the reference count of
8400 whatever was being referenced by the RV. This can almost be thought of
8401 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8402 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8403 (otherwise the decrementing is conditional on the reference count being
8404 different from one or the reference being a readonly SV).
8411 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8413 SV* const target = SvRV(ref);
8415 if (SvWEAKREF(ref)) {
8416 sv_del_backref(target, ref);
8418 SvRV_set(ref, NULL);
8421 SvRV_set(ref, NULL);
8423 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8424 assigned to as BEGIN {$a = \"Foo"} will fail. */
8425 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8426 SvREFCNT_dec(target);
8427 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8428 sv_2mortal(target); /* Schedule for freeing later */
8432 =for apidoc sv_unref
8434 Unsets the RV status of the SV, and decrements the reference count of
8435 whatever was being referenced by the RV. This can almost be thought of
8436 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8437 being zero. See C<SvROK_off>.
8443 Perl_sv_unref(pTHX_ SV *sv)
8445 sv_unref_flags(sv, 0);
8449 =for apidoc sv_taint
8451 Taint an SV. Use C<SvTAINTED_on> instead.
8456 Perl_sv_taint(pTHX_ SV *sv)
8458 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8462 =for apidoc sv_untaint
8464 Untaint an SV. Use C<SvTAINTED_off> instead.
8469 Perl_sv_untaint(pTHX_ SV *sv)
8471 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8472 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8479 =for apidoc sv_tainted
8481 Test an SV for taintedness. Use C<SvTAINTED> instead.
8486 Perl_sv_tainted(pTHX_ SV *sv)
8488 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8489 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8490 if (mg && (mg->mg_len & 1) )
8497 =for apidoc sv_setpviv
8499 Copies an integer into the given SV, also updating its string value.
8500 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8506 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8508 char buf[TYPE_CHARS(UV)];
8510 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8512 sv_setpvn(sv, ptr, ebuf - ptr);
8516 =for apidoc sv_setpviv_mg
8518 Like C<sv_setpviv>, but also handles 'set' magic.
8524 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8526 char buf[TYPE_CHARS(UV)];
8528 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8530 sv_setpvn(sv, ptr, ebuf - ptr);
8534 #if defined(PERL_IMPLICIT_CONTEXT)
8536 /* pTHX_ magic can't cope with varargs, so this is a no-context
8537 * version of the main function, (which may itself be aliased to us).
8538 * Don't access this version directly.
8542 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8546 va_start(args, pat);
8547 sv_vsetpvf(sv, pat, &args);
8551 /* pTHX_ magic can't cope with varargs, so this is a no-context
8552 * version of the main function, (which may itself be aliased to us).
8553 * Don't access this version directly.
8557 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8561 va_start(args, pat);
8562 sv_vsetpvf_mg(sv, pat, &args);
8568 =for apidoc sv_setpvf
8570 Works like C<sv_catpvf> but copies the text into the SV instead of
8571 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8577 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8580 va_start(args, pat);
8581 sv_vsetpvf(sv, pat, &args);
8586 =for apidoc sv_vsetpvf
8588 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8589 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8591 Usually used via its frontend C<sv_setpvf>.
8597 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8599 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8603 =for apidoc sv_setpvf_mg
8605 Like C<sv_setpvf>, but also handles 'set' magic.
8611 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8614 va_start(args, pat);
8615 sv_vsetpvf_mg(sv, pat, &args);
8620 =for apidoc sv_vsetpvf_mg
8622 Like C<sv_vsetpvf>, but also handles 'set' magic.
8624 Usually used via its frontend C<sv_setpvf_mg>.
8630 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8632 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8636 #if defined(PERL_IMPLICIT_CONTEXT)
8638 /* pTHX_ magic can't cope with varargs, so this is a no-context
8639 * version of the main function, (which may itself be aliased to us).
8640 * Don't access this version directly.
8644 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8648 va_start(args, pat);
8649 sv_vcatpvf(sv, pat, &args);
8653 /* pTHX_ magic can't cope with varargs, so this is a no-context
8654 * version of the main function, (which may itself be aliased to us).
8655 * Don't access this version directly.
8659 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8663 va_start(args, pat);
8664 sv_vcatpvf_mg(sv, pat, &args);
8670 =for apidoc sv_catpvf
8672 Processes its arguments like C<sprintf> and appends the formatted
8673 output to an SV. If the appended data contains "wide" characters
8674 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8675 and characters >255 formatted with %c), the original SV might get
8676 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8677 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8678 valid UTF-8; if the original SV was bytes, the pattern should be too.
8683 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8686 va_start(args, pat);
8687 sv_vcatpvf(sv, pat, &args);
8692 =for apidoc sv_vcatpvf
8694 Processes its arguments like C<vsprintf> and appends the formatted output
8695 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8697 Usually used via its frontend C<sv_catpvf>.
8703 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8705 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8709 =for apidoc sv_catpvf_mg
8711 Like C<sv_catpvf>, but also handles 'set' magic.
8717 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8720 va_start(args, pat);
8721 sv_vcatpvf_mg(sv, pat, &args);
8726 =for apidoc sv_vcatpvf_mg
8728 Like C<sv_vcatpvf>, but also handles 'set' magic.
8730 Usually used via its frontend C<sv_catpvf_mg>.
8736 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8738 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8743 =for apidoc sv_vsetpvfn
8745 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8748 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8754 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8756 sv_setpvn(sv, "", 0);
8757 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8760 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8763 S_expect_number(pTHX_ char** pattern)
8766 switch (**pattern) {
8767 case '1': case '2': case '3':
8768 case '4': case '5': case '6':
8769 case '7': case '8': case '9':
8770 while (isDIGIT(**pattern))
8771 var = var * 10 + (*(*pattern)++ - '0');
8775 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8778 F0convert(NV nv, char *endbuf, STRLEN *len)
8780 const int neg = nv < 0;
8789 if (uv & 1 && uv == nv)
8790 uv--; /* Round to even */
8792 const unsigned dig = uv % 10;
8805 =for apidoc sv_vcatpvfn
8807 Processes its arguments like C<vsprintf> and appends the formatted output
8808 to an SV. Uses an array of SVs if the C style variable argument list is
8809 missing (NULL). When running with taint checks enabled, indicates via
8810 C<maybe_tainted> if results are untrustworthy (often due to the use of
8813 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8818 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8821 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8828 static const char nullstr[] = "(null)";
8830 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8831 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8833 /* Times 4: a decimal digit takes more than 3 binary digits.
8834 * NV_DIG: mantissa takes than many decimal digits.
8835 * Plus 32: Playing safe. */
8836 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8837 /* large enough for "%#.#f" --chip */
8838 /* what about long double NVs? --jhi */
8840 PERL_UNUSED_ARG(maybe_tainted);
8842 /* no matter what, this is a string now */
8843 (void)SvPV_force(sv, origlen);
8845 /* special-case "", "%s", and "%-p" (SVf) */
8848 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8850 const char * const s = va_arg(*args, char*);
8851 sv_catpv(sv, s ? s : nullstr);
8853 else if (svix < svmax) {
8854 sv_catsv(sv, *svargs);
8855 if (DO_UTF8(*svargs))
8860 if (patlen == 3 && pat[0] == '%' &&
8861 pat[1] == '-' && pat[2] == 'p') {
8863 argsv = va_arg(*args, SV*);
8864 sv_catsv(sv, argsv);
8871 #ifndef USE_LONG_DOUBLE
8872 /* special-case "%.<number>[gf]" */
8873 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8874 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8875 unsigned digits = 0;
8879 while (*pp >= '0' && *pp <= '9')
8880 digits = 10 * digits + (*pp++ - '0');
8881 if (pp - pat == (int)patlen - 1) {
8889 /* Add check for digits != 0 because it seems that some
8890 gconverts are buggy in this case, and we don't yet have
8891 a Configure test for this. */
8892 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8893 /* 0, point, slack */
8894 Gconvert(nv, (int)digits, 0, ebuf);
8896 if (*ebuf) /* May return an empty string for digits==0 */
8899 } else if (!digits) {
8902 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8903 sv_catpvn(sv, p, l);
8909 #endif /* !USE_LONG_DOUBLE */
8911 if (!args && svix < svmax && DO_UTF8(*svargs))
8914 patend = (char*)pat + patlen;
8915 for (p = (char*)pat; p < patend; p = q) {
8918 bool vectorize = FALSE;
8919 bool vectorarg = FALSE;
8920 bool vec_utf8 = FALSE;
8926 bool has_precis = FALSE;
8929 bool is_utf8 = FALSE; /* is this item utf8? */
8930 #ifdef HAS_LDBL_SPRINTF_BUG
8931 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8932 with sfio - Allen <allens@cpan.org> */
8933 bool fix_ldbl_sprintf_bug = FALSE;
8937 U8 utf8buf[UTF8_MAXBYTES+1];
8938 STRLEN esignlen = 0;
8940 const char *eptr = Nullch;
8943 const U8 *vecstr = Null(U8*);
8950 /* we need a long double target in case HAS_LONG_DOUBLE but
8953 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8961 const char *dotstr = ".";
8962 STRLEN dotstrlen = 1;
8963 I32 efix = 0; /* explicit format parameter index */
8964 I32 ewix = 0; /* explicit width index */
8965 I32 epix = 0; /* explicit precision index */
8966 I32 evix = 0; /* explicit vector index */
8967 bool asterisk = FALSE;
8969 /* echo everything up to the next format specification */
8970 for (q = p; q < patend && *q != '%'; ++q) ;
8972 if (has_utf8 && !pat_utf8)
8973 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8975 sv_catpvn(sv, p, q - p);
8982 We allow format specification elements in this order:
8983 \d+\$ explicit format parameter index
8985 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8986 0 flag (as above): repeated to allow "v02"
8987 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8988 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8990 [%bcdefginopsux_DFOUX] format (mandatory)
8992 if (EXPECT_NUMBER(q, width)) {
9033 if (EXPECT_NUMBER(q, ewix))
9042 if ((vectorarg = asterisk)) {
9054 EXPECT_NUMBER(q, width);
9059 vecsv = va_arg(*args, SV*);
9061 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9062 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9063 dotstr = SvPV_const(vecsv, dotstrlen);
9068 vecsv = va_arg(*args, SV*);
9069 vecstr = (U8*)SvPV_const(vecsv,veclen);
9070 vec_utf8 = DO_UTF8(vecsv);
9072 else if (efix ? efix <= svmax : svix < svmax) {
9073 vecsv = svargs[efix ? efix-1 : svix++];
9074 vecstr = (U8*)SvPV_const(vecsv,veclen);
9075 vec_utf8 = DO_UTF8(vecsv);
9076 /* if this is a version object, we need to return the
9077 * stringified representation (which the SvPVX_const has
9078 * already done for us), but not vectorize the args
9080 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9082 q++; /* skip past the rest of the %vd format */
9083 eptr = (const char *) vecstr;
9084 elen = strlen(eptr);
9097 i = va_arg(*args, int);
9099 i = (ewix ? ewix <= svmax : svix < svmax) ?
9100 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9102 width = (i < 0) ? -i : i;
9112 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9114 /* XXX: todo, support specified precision parameter */
9118 i = va_arg(*args, int);
9120 i = (ewix ? ewix <= svmax : svix < svmax)
9121 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9122 precis = (i < 0) ? 0 : i;
9127 precis = precis * 10 + (*q++ - '0');
9136 case 'I': /* Ix, I32x, and I64x */
9138 if (q[1] == '6' && q[2] == '4') {
9144 if (q[1] == '3' && q[2] == '2') {
9154 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9165 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9166 if (*(q + 1) == 'l') { /* lld, llf */
9191 argsv = (efix ? efix <= svmax : svix < svmax) ?
9192 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9199 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9201 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9203 eptr = (char*)utf8buf;
9204 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9215 if (args && !vectorize) {
9216 eptr = va_arg(*args, char*);
9218 #ifdef MACOS_TRADITIONAL
9219 /* On MacOS, %#s format is used for Pascal strings */
9224 elen = strlen(eptr);
9226 eptr = (char *)nullstr;
9227 elen = sizeof nullstr - 1;
9231 eptr = SvPVx_const(argsv, elen);
9232 if (DO_UTF8(argsv)) {
9233 if (has_precis && precis < elen) {
9235 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9238 if (width) { /* fudge width (can't fudge elen) */
9239 width += elen - sv_len_utf8(argsv);
9247 if (has_precis && elen > precis)
9254 if (left && args) { /* SVf */
9263 argsv = va_arg(*args, SV*);
9264 eptr = SvPVx_const(argsv, elen);
9269 if (alt || vectorize)
9271 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9289 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9298 esignbuf[esignlen++] = plus;
9302 case 'h': iv = (short)va_arg(*args, int); break;
9303 case 'l': iv = va_arg(*args, long); break;
9304 case 'V': iv = va_arg(*args, IV); break;
9305 default: iv = va_arg(*args, int); break;
9307 case 'q': iv = va_arg(*args, Quad_t); break;
9312 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9314 case 'h': iv = (short)tiv; break;
9315 case 'l': iv = (long)tiv; break;
9317 default: iv = tiv; break;
9319 case 'q': iv = (Quad_t)tiv; break;
9323 if ( !vectorize ) /* we already set uv above */
9328 esignbuf[esignlen++] = plus;
9332 esignbuf[esignlen++] = '-';
9375 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9386 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9387 case 'l': uv = va_arg(*args, unsigned long); break;
9388 case 'V': uv = va_arg(*args, UV); break;
9389 default: uv = va_arg(*args, unsigned); break;
9391 case 'q': uv = va_arg(*args, Uquad_t); break;
9396 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9398 case 'h': uv = (unsigned short)tuv; break;
9399 case 'l': uv = (unsigned long)tuv; break;
9401 default: uv = tuv; break;
9403 case 'q': uv = (Uquad_t)tuv; break;
9410 char *ptr = ebuf + sizeof ebuf;
9416 p = (char*)((c == 'X')
9417 ? "0123456789ABCDEF" : "0123456789abcdef");
9423 esignbuf[esignlen++] = '0';
9424 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9432 if (alt && *ptr != '0')
9441 esignbuf[esignlen++] = '0';
9442 esignbuf[esignlen++] = 'b';
9445 default: /* it had better be ten or less */
9449 } while (uv /= base);
9452 elen = (ebuf + sizeof ebuf) - ptr;
9456 zeros = precis - elen;
9457 else if (precis == 0 && elen == 1 && *eptr == '0')
9463 /* FLOATING POINT */
9466 c = 'f'; /* maybe %F isn't supported here */
9472 /* This is evil, but floating point is even more evil */
9474 /* for SV-style calling, we can only get NV
9475 for C-style calling, we assume %f is double;
9476 for simplicity we allow any of %Lf, %llf, %qf for long double
9480 #if defined(USE_LONG_DOUBLE)
9484 /* [perl #20339] - we should accept and ignore %lf rather than die */
9488 #if defined(USE_LONG_DOUBLE)
9489 intsize = args ? 0 : 'q';
9493 #if defined(HAS_LONG_DOUBLE)
9502 /* now we need (long double) if intsize == 'q', else (double) */
9503 nv = (args && !vectorize) ?
9504 #if LONG_DOUBLESIZE > DOUBLESIZE
9506 va_arg(*args, long double) :
9507 va_arg(*args, double)
9509 va_arg(*args, double)
9515 if (c != 'e' && c != 'E') {
9517 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9518 will cast our (long double) to (double) */
9519 (void)Perl_frexp(nv, &i);
9520 if (i == PERL_INT_MIN)
9521 Perl_die(aTHX_ "panic: frexp");
9523 need = BIT_DIGITS(i);
9525 need += has_precis ? precis : 6; /* known default */
9530 #ifdef HAS_LDBL_SPRINTF_BUG
9531 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9532 with sfio - Allen <allens@cpan.org> */
9535 # define MY_DBL_MAX DBL_MAX
9536 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9537 # if DOUBLESIZE >= 8
9538 # define MY_DBL_MAX 1.7976931348623157E+308L
9540 # define MY_DBL_MAX 3.40282347E+38L
9544 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9545 # define MY_DBL_MAX_BUG 1L
9547 # define MY_DBL_MAX_BUG MY_DBL_MAX
9551 # define MY_DBL_MIN DBL_MIN
9552 # else /* XXX guessing! -Allen */
9553 # if DOUBLESIZE >= 8
9554 # define MY_DBL_MIN 2.2250738585072014E-308L
9556 # define MY_DBL_MIN 1.17549435E-38L
9560 if ((intsize == 'q') && (c == 'f') &&
9561 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9563 /* it's going to be short enough that
9564 * long double precision is not needed */
9566 if ((nv <= 0L) && (nv >= -0L))
9567 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9569 /* would use Perl_fp_class as a double-check but not
9570 * functional on IRIX - see perl.h comments */
9572 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9573 /* It's within the range that a double can represent */
9574 #if defined(DBL_MAX) && !defined(DBL_MIN)
9575 if ((nv >= ((long double)1/DBL_MAX)) ||
9576 (nv <= (-(long double)1/DBL_MAX)))
9578 fix_ldbl_sprintf_bug = TRUE;
9581 if (fix_ldbl_sprintf_bug == TRUE) {
9591 # undef MY_DBL_MAX_BUG
9594 #endif /* HAS_LDBL_SPRINTF_BUG */
9596 need += 20; /* fudge factor */
9597 if (PL_efloatsize < need) {
9598 Safefree(PL_efloatbuf);
9599 PL_efloatsize = need + 20; /* more fudge */
9600 Newx(PL_efloatbuf, PL_efloatsize, char);
9601 PL_efloatbuf[0] = '\0';
9604 if ( !(width || left || plus || alt) && fill != '0'
9605 && has_precis && intsize != 'q' ) { /* Shortcuts */
9606 /* See earlier comment about buggy Gconvert when digits,
9608 if ( c == 'g' && precis) {
9609 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9610 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9611 goto float_converted;
9612 } else if ( c == 'f' && !precis) {
9613 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9618 char *ptr = ebuf + sizeof ebuf;
9621 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9622 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9623 if (intsize == 'q') {
9624 /* Copy the one or more characters in a long double
9625 * format before the 'base' ([efgEFG]) character to
9626 * the format string. */
9627 static char const prifldbl[] = PERL_PRIfldbl;
9628 char const *p = prifldbl + sizeof(prifldbl) - 3;
9629 while (p >= prifldbl) { *--ptr = *p--; }
9634 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9639 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9651 /* No taint. Otherwise we are in the strange situation
9652 * where printf() taints but print($float) doesn't.
9654 #if defined(HAS_LONG_DOUBLE)
9656 (void)sprintf(PL_efloatbuf, ptr, nv);
9658 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9660 (void)sprintf(PL_efloatbuf, ptr, nv);
9664 eptr = PL_efloatbuf;
9665 elen = strlen(PL_efloatbuf);
9671 i = SvCUR(sv) - origlen;
9672 if (args && !vectorize) {
9674 case 'h': *(va_arg(*args, short*)) = i; break;
9675 default: *(va_arg(*args, int*)) = i; break;
9676 case 'l': *(va_arg(*args, long*)) = i; break;
9677 case 'V': *(va_arg(*args, IV*)) = i; break;
9679 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9684 sv_setuv_mg(argsv, (UV)i);
9686 continue; /* not "break" */
9693 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9694 && ckWARN(WARN_PRINTF))
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 /* Set tainting stuff before PerlIO_debug can possibly get called */
11378 PL_tainting = proto_perl->Itainting;
11379 PL_taint_warn = proto_perl->Itaint_warn;
11381 #ifdef PERLIO_LAYERS
11382 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11383 PerlIO_clone(aTHX_ proto_perl, param);
11386 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11387 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11388 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11389 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11390 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11391 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11394 PL_minus_c = proto_perl->Iminus_c;
11395 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11396 PL_localpatches = proto_perl->Ilocalpatches;
11397 PL_splitstr = proto_perl->Isplitstr;
11398 PL_preprocess = proto_perl->Ipreprocess;
11399 PL_minus_n = proto_perl->Iminus_n;
11400 PL_minus_p = proto_perl->Iminus_p;
11401 PL_minus_l = proto_perl->Iminus_l;
11402 PL_minus_a = proto_perl->Iminus_a;
11403 PL_minus_F = proto_perl->Iminus_F;
11404 PL_doswitches = proto_perl->Idoswitches;
11405 PL_dowarn = proto_perl->Idowarn;
11406 PL_doextract = proto_perl->Idoextract;
11407 PL_sawampersand = proto_perl->Isawampersand;
11408 PL_unsafe = proto_perl->Iunsafe;
11409 PL_inplace = SAVEPV(proto_perl->Iinplace);
11410 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11411 PL_perldb = proto_perl->Iperldb;
11412 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11413 PL_exit_flags = proto_perl->Iexit_flags;
11415 /* magical thingies */
11416 /* XXX time(&PL_basetime) when asked for? */
11417 PL_basetime = proto_perl->Ibasetime;
11418 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11420 PL_maxsysfd = proto_perl->Imaxsysfd;
11421 PL_multiline = proto_perl->Imultiline;
11422 PL_statusvalue = proto_perl->Istatusvalue;
11424 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11426 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11428 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11429 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11430 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11432 /* Clone the regex array */
11433 PL_regex_padav = newAV();
11435 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11436 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11438 av_push(PL_regex_padav,
11439 sv_dup_inc(regexen[0],param));
11440 for(i = 1; i <= len; i++) {
11441 if(SvREPADTMP(regexen[i])) {
11442 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11444 av_push(PL_regex_padav,
11446 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11447 SvIVX(regexen[i])), param)))
11452 PL_regex_pad = AvARRAY(PL_regex_padav);
11454 /* shortcuts to various I/O objects */
11455 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11456 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11457 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11458 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11459 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11460 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11462 /* shortcuts to regexp stuff */
11463 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11465 /* shortcuts to misc objects */
11466 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11468 /* shortcuts to debugging objects */
11469 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11470 PL_DBline = gv_dup(proto_perl->IDBline, param);
11471 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11472 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11473 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11474 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11475 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11476 PL_lineary = av_dup(proto_perl->Ilineary, param);
11477 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11479 /* symbol tables */
11480 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11481 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11482 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11483 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11484 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11486 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11487 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11488 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11489 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11490 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11491 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11493 PL_sub_generation = proto_perl->Isub_generation;
11495 /* funky return mechanisms */
11496 PL_forkprocess = proto_perl->Iforkprocess;
11498 /* subprocess state */
11499 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11501 /* internal state */
11502 PL_maxo = proto_perl->Imaxo;
11503 if (proto_perl->Iop_mask)
11504 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11506 PL_op_mask = Nullch;
11507 /* PL_asserting = proto_perl->Iasserting; */
11509 /* current interpreter roots */
11510 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11511 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11512 PL_main_start = proto_perl->Imain_start;
11513 PL_eval_root = proto_perl->Ieval_root;
11514 PL_eval_start = proto_perl->Ieval_start;
11516 /* runtime control stuff */
11517 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11518 PL_copline = proto_perl->Icopline;
11520 PL_filemode = proto_perl->Ifilemode;
11521 PL_lastfd = proto_perl->Ilastfd;
11522 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11525 PL_gensym = proto_perl->Igensym;
11526 PL_preambled = proto_perl->Ipreambled;
11527 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11528 PL_laststatval = proto_perl->Ilaststatval;
11529 PL_laststype = proto_perl->Ilaststype;
11530 PL_mess_sv = Nullsv;
11532 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11534 /* interpreter atexit processing */
11535 PL_exitlistlen = proto_perl->Iexitlistlen;
11536 if (PL_exitlistlen) {
11537 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11538 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11541 PL_exitlist = (PerlExitListEntry*)NULL;
11542 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11543 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11544 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11546 PL_profiledata = NULL;
11547 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11548 /* PL_rsfp_filters entries have fake IoDIRP() */
11549 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11551 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11553 PAD_CLONE_VARS(proto_perl, param);
11555 #ifdef HAVE_INTERP_INTERN
11556 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11559 /* more statics moved here */
11560 PL_generation = proto_perl->Igeneration;
11561 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11563 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11564 PL_in_clean_all = proto_perl->Iin_clean_all;
11566 PL_uid = proto_perl->Iuid;
11567 PL_euid = proto_perl->Ieuid;
11568 PL_gid = proto_perl->Igid;
11569 PL_egid = proto_perl->Iegid;
11570 PL_nomemok = proto_perl->Inomemok;
11571 PL_an = proto_perl->Ian;
11572 PL_evalseq = proto_perl->Ievalseq;
11573 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11574 PL_origalen = proto_perl->Iorigalen;
11575 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11576 PL_osname = SAVEPV(proto_perl->Iosname);
11577 PL_sighandlerp = proto_perl->Isighandlerp;
11579 PL_runops = proto_perl->Irunops;
11581 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11584 PL_cshlen = proto_perl->Icshlen;
11585 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11588 PL_lex_state = proto_perl->Ilex_state;
11589 PL_lex_defer = proto_perl->Ilex_defer;
11590 PL_lex_expect = proto_perl->Ilex_expect;
11591 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11592 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11593 PL_lex_starts = proto_perl->Ilex_starts;
11594 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11595 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11596 PL_lex_op = proto_perl->Ilex_op;
11597 PL_lex_inpat = proto_perl->Ilex_inpat;
11598 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11599 PL_lex_brackets = proto_perl->Ilex_brackets;
11600 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11601 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11602 PL_lex_casemods = proto_perl->Ilex_casemods;
11603 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11604 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11606 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11607 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11608 PL_nexttoke = proto_perl->Inexttoke;
11610 /* XXX This is probably masking the deeper issue of why
11611 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11612 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11613 * (A little debugging with a watchpoint on it may help.)
11615 if (SvANY(proto_perl->Ilinestr)) {
11616 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11617 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11618 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11619 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11620 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11621 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11622 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11623 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11624 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11627 PL_linestr = NEWSV(65,79);
11628 sv_upgrade(PL_linestr,SVt_PVIV);
11629 sv_setpvn(PL_linestr,"",0);
11630 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11632 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11633 PL_pending_ident = proto_perl->Ipending_ident;
11634 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11636 PL_expect = proto_perl->Iexpect;
11638 PL_multi_start = proto_perl->Imulti_start;
11639 PL_multi_end = proto_perl->Imulti_end;
11640 PL_multi_open = proto_perl->Imulti_open;
11641 PL_multi_close = proto_perl->Imulti_close;
11643 PL_error_count = proto_perl->Ierror_count;
11644 PL_subline = proto_perl->Isubline;
11645 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11647 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11648 if (SvANY(proto_perl->Ilinestr)) {
11649 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11650 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11651 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11652 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11653 PL_last_lop_op = proto_perl->Ilast_lop_op;
11656 PL_last_uni = SvPVX(PL_linestr);
11657 PL_last_lop = SvPVX(PL_linestr);
11658 PL_last_lop_op = 0;
11660 PL_in_my = proto_perl->Iin_my;
11661 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11663 PL_cryptseen = proto_perl->Icryptseen;
11666 PL_hints = proto_perl->Ihints;
11668 PL_amagic_generation = proto_perl->Iamagic_generation;
11670 #ifdef USE_LOCALE_COLLATE
11671 PL_collation_ix = proto_perl->Icollation_ix;
11672 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11673 PL_collation_standard = proto_perl->Icollation_standard;
11674 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11675 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11676 #endif /* USE_LOCALE_COLLATE */
11678 #ifdef USE_LOCALE_NUMERIC
11679 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11680 PL_numeric_standard = proto_perl->Inumeric_standard;
11681 PL_numeric_local = proto_perl->Inumeric_local;
11682 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11683 #endif /* !USE_LOCALE_NUMERIC */
11685 /* utf8 character classes */
11686 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11687 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11688 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11689 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11690 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11691 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11692 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11693 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11694 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11695 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11696 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11697 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11698 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11699 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11700 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11701 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11702 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11703 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11704 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11705 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11707 /* Did the locale setup indicate UTF-8? */
11708 PL_utf8locale = proto_perl->Iutf8locale;
11709 /* Unicode features (see perlrun/-C) */
11710 PL_unicode = proto_perl->Iunicode;
11712 /* Pre-5.8 signals control */
11713 PL_signals = proto_perl->Isignals;
11715 /* times() ticks per second */
11716 PL_clocktick = proto_perl->Iclocktick;
11718 /* Recursion stopper for PerlIO_find_layer */
11719 PL_in_load_module = proto_perl->Iin_load_module;
11721 /* sort() routine */
11722 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11724 /* Not really needed/useful since the reenrant_retint is "volatile",
11725 * but do it for consistency's sake. */
11726 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11728 /* Hooks to shared SVs and locks. */
11729 PL_sharehook = proto_perl->Isharehook;
11730 PL_lockhook = proto_perl->Ilockhook;
11731 PL_unlockhook = proto_perl->Iunlockhook;
11732 PL_threadhook = proto_perl->Ithreadhook;
11734 PL_runops_std = proto_perl->Irunops_std;
11735 PL_runops_dbg = proto_perl->Irunops_dbg;
11737 #ifdef THREADS_HAVE_PIDS
11738 PL_ppid = proto_perl->Ippid;
11742 PL_last_swash_hv = Nullhv; /* reinits on demand */
11743 PL_last_swash_klen = 0;
11744 PL_last_swash_key[0]= '\0';
11745 PL_last_swash_tmps = (U8*)NULL;
11746 PL_last_swash_slen = 0;
11748 PL_glob_index = proto_perl->Iglob_index;
11749 PL_srand_called = proto_perl->Isrand_called;
11750 PL_uudmap['M'] = 0; /* reinits on demand */
11751 PL_bitcount = Nullch; /* reinits on demand */
11753 if (proto_perl->Ipsig_pend) {
11754 Newxz(PL_psig_pend, SIG_SIZE, int);
11757 PL_psig_pend = (int*)NULL;
11760 if (proto_perl->Ipsig_ptr) {
11761 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11762 Newxz(PL_psig_name, SIG_SIZE, SV*);
11763 for (i = 1; i < SIG_SIZE; i++) {
11764 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11765 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11769 PL_psig_ptr = (SV**)NULL;
11770 PL_psig_name = (SV**)NULL;
11773 /* thrdvar.h stuff */
11775 if (flags & CLONEf_COPY_STACKS) {
11776 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11777 PL_tmps_ix = proto_perl->Ttmps_ix;
11778 PL_tmps_max = proto_perl->Ttmps_max;
11779 PL_tmps_floor = proto_perl->Ttmps_floor;
11780 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11782 while (i <= PL_tmps_ix) {
11783 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11787 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11788 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11789 Newxz(PL_markstack, i, I32);
11790 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11791 - proto_perl->Tmarkstack);
11792 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11793 - proto_perl->Tmarkstack);
11794 Copy(proto_perl->Tmarkstack, PL_markstack,
11795 PL_markstack_ptr - PL_markstack + 1, I32);
11797 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11798 * NOTE: unlike the others! */
11799 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11800 PL_scopestack_max = proto_perl->Tscopestack_max;
11801 Newxz(PL_scopestack, PL_scopestack_max, I32);
11802 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11804 /* NOTE: si_dup() looks at PL_markstack */
11805 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11807 /* PL_curstack = PL_curstackinfo->si_stack; */
11808 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11809 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11811 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11812 PL_stack_base = AvARRAY(PL_curstack);
11813 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11814 - proto_perl->Tstack_base);
11815 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11817 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11818 * NOTE: unlike the others! */
11819 PL_savestack_ix = proto_perl->Tsavestack_ix;
11820 PL_savestack_max = proto_perl->Tsavestack_max;
11821 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11822 PL_savestack = ss_dup(proto_perl, param);
11826 ENTER; /* perl_destruct() wants to LEAVE; */
11829 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11830 PL_top_env = &PL_start_env;
11832 PL_op = proto_perl->Top;
11835 PL_Xpv = (XPV*)NULL;
11836 PL_na = proto_perl->Tna;
11838 PL_statbuf = proto_perl->Tstatbuf;
11839 PL_statcache = proto_perl->Tstatcache;
11840 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11841 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11843 PL_timesbuf = proto_perl->Ttimesbuf;
11846 PL_tainted = proto_perl->Ttainted;
11847 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11848 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11849 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11850 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11851 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11852 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11853 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11854 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11855 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11857 PL_restartop = proto_perl->Trestartop;
11858 PL_in_eval = proto_perl->Tin_eval;
11859 PL_delaymagic = proto_perl->Tdelaymagic;
11860 PL_dirty = proto_perl->Tdirty;
11861 PL_localizing = proto_perl->Tlocalizing;
11863 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11864 PL_hv_fetch_ent_mh = Nullhe;
11865 PL_modcount = proto_perl->Tmodcount;
11866 PL_lastgotoprobe = Nullop;
11867 PL_dumpindent = proto_perl->Tdumpindent;
11869 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11870 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11871 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11872 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11873 PL_sortcxix = proto_perl->Tsortcxix;
11874 PL_efloatbuf = Nullch; /* reinits on demand */
11875 PL_efloatsize = 0; /* reinits on demand */
11879 PL_screamfirst = NULL;
11880 PL_screamnext = NULL;
11881 PL_maxscream = -1; /* reinits on demand */
11882 PL_lastscream = Nullsv;
11884 PL_watchaddr = NULL;
11885 PL_watchok = Nullch;
11887 PL_regdummy = proto_perl->Tregdummy;
11888 PL_regprecomp = Nullch;
11891 PL_colorset = 0; /* reinits PL_colors[] */
11892 /*PL_colors[6] = {0,0,0,0,0,0};*/
11893 PL_reginput = Nullch;
11894 PL_regbol = Nullch;
11895 PL_regeol = Nullch;
11896 PL_regstartp = (I32*)NULL;
11897 PL_regendp = (I32*)NULL;
11898 PL_reglastparen = (U32*)NULL;
11899 PL_reglastcloseparen = (U32*)NULL;
11900 PL_regtill = Nullch;
11901 PL_reg_start_tmp = (char**)NULL;
11902 PL_reg_start_tmpl = 0;
11903 PL_regdata = (struct reg_data*)NULL;
11906 PL_reg_eval_set = 0;
11908 PL_regprogram = (regnode*)NULL;
11910 PL_regcc = (CURCUR*)NULL;
11911 PL_reg_call_cc = (struct re_cc_state*)NULL;
11912 PL_reg_re = (regexp*)NULL;
11913 PL_reg_ganch = Nullch;
11914 PL_reg_sv = Nullsv;
11915 PL_reg_match_utf8 = FALSE;
11916 PL_reg_magic = (MAGIC*)NULL;
11918 PL_reg_oldcurpm = (PMOP*)NULL;
11919 PL_reg_curpm = (PMOP*)NULL;
11920 PL_reg_oldsaved = Nullch;
11921 PL_reg_oldsavedlen = 0;
11922 #ifdef PERL_OLD_COPY_ON_WRITE
11925 PL_reg_maxiter = 0;
11926 PL_reg_leftiter = 0;
11927 PL_reg_poscache = Nullch;
11928 PL_reg_poscache_size= 0;
11930 /* RE engine - function pointers */
11931 PL_regcompp = proto_perl->Tregcompp;
11932 PL_regexecp = proto_perl->Tregexecp;
11933 PL_regint_start = proto_perl->Tregint_start;
11934 PL_regint_string = proto_perl->Tregint_string;
11935 PL_regfree = proto_perl->Tregfree;
11937 PL_reginterp_cnt = 0;
11938 PL_reg_starttry = 0;
11940 /* Pluggable optimizer */
11941 PL_peepp = proto_perl->Tpeepp;
11943 PL_stashcache = newHV();
11945 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11946 ptr_table_free(PL_ptr_table);
11947 PL_ptr_table = NULL;
11950 /* Call the ->CLONE method, if it exists, for each of the stashes
11951 identified by sv_dup() above.
11953 while(av_len(param->stashes) != -1) {
11954 HV* const stash = (HV*) av_shift(param->stashes);
11955 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11956 if (cloner && GvCV(cloner)) {
11961 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11963 call_sv((SV*)GvCV(cloner), G_DISCARD);
11969 SvREFCNT_dec(param->stashes);
11971 /* orphaned? eg threads->new inside BEGIN or use */
11972 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11973 (void)SvREFCNT_inc(PL_compcv);
11974 SAVEFREESV(PL_compcv);
11980 #endif /* USE_ITHREADS */
11983 =head1 Unicode Support
11985 =for apidoc sv_recode_to_utf8
11987 The encoding is assumed to be an Encode object, on entry the PV
11988 of the sv is assumed to be octets in that encoding, and the sv
11989 will be converted into Unicode (and UTF-8).
11991 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11992 is not a reference, nothing is done to the sv. If the encoding is not
11993 an C<Encode::XS> Encoding object, bad things will happen.
11994 (See F<lib/encoding.pm> and L<Encode>).
11996 The PV of the sv is returned.
12001 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12004 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12018 Passing sv_yes is wrong - it needs to be or'ed set of constants
12019 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12020 remove converted chars from source.
12022 Both will default the value - let them.
12024 XPUSHs(&PL_sv_yes);
12027 call_method("decode", G_SCALAR);
12031 s = SvPV_const(uni, len);
12032 if (s != SvPVX_const(sv)) {
12033 SvGROW(sv, len + 1);
12034 Move(s, SvPVX(sv), len + 1, char);
12035 SvCUR_set(sv, len);
12042 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12046 =for apidoc sv_cat_decode
12048 The encoding is assumed to be an Encode object, the PV of the ssv is
12049 assumed to be octets in that encoding and decoding the input starts
12050 from the position which (PV + *offset) pointed to. The dsv will be
12051 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12052 when the string tstr appears in decoding output or the input ends on
12053 the PV of the ssv. The value which the offset points will be modified
12054 to the last input position on the ssv.
12056 Returns TRUE if the terminator was found, else returns FALSE.
12061 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12062 SV *ssv, int *offset, char *tstr, int tlen)
12066 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12077 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12078 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12080 call_method("cat_decode", G_SCALAR);
12082 ret = SvTRUE(TOPs);
12083 *offset = SvIV(offsv);
12089 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12095 * c-indentation-style: bsd
12096 * c-basic-offset: 4
12097 * indent-tabs-mode: t
12100 * ex: set ts=8 sts=4 sw=4 noet: