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 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
289 const SV * const sv = sva + 1;
290 const SV * const svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register const SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 S_free_arena(pTHX_ void **root) {
515 void **next = *(void **)root;
522 =for apidoc sv_free_arenas
524 Deallocate the memory used by all arenas. Note that all the individual SV
525 heads and bodies within the arenas must already have been freed.
530 #define free_arena(name) \
532 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
533 PL_ ## name ## _arenaroot = 0; \
534 PL_ ## name ## _root = 0; \
538 Perl_sv_free_arenas(pTHX)
543 /* Free arenas here, but be careful about fake ones. (We assume
544 contiguity of the fake ones with the corresponding real ones.) */
546 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
547 svanext = (SV*) SvANY(sva);
548 while (svanext && SvFAKE(svanext))
549 svanext = (SV*) SvANY(svanext);
567 #if defined(USE_ITHREADS)
572 Safefree(PL_nice_chunk);
573 PL_nice_chunk = Nullch;
574 PL_nice_chunk_size = 0;
579 /* ---------------------------------------------------------------------
581 * support functions for report_uninit()
584 /* the maxiumum size of array or hash where we will scan looking
585 * for the undefined element that triggered the warning */
587 #define FUV_MAX_SEARCH_SIZE 1000
589 /* Look for an entry in the hash whose value has the same SV as val;
590 * If so, return a mortal copy of the key. */
593 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
599 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
600 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
605 for (i=HvMAX(hv); i>0; i--) {
607 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
608 if (HeVAL(entry) != val)
610 if ( HeVAL(entry) == &PL_sv_undef ||
611 HeVAL(entry) == &PL_sv_placeholder)
615 if (HeKLEN(entry) == HEf_SVKEY)
616 return sv_mortalcopy(HeKEY_sv(entry));
617 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
623 /* Look for an entry in the array whose value has the same SV as val;
624 * If so, return the index, otherwise return -1. */
627 S_find_array_subscript(pTHX_ AV *av, SV* val)
631 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
632 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
636 for (i=AvFILLp(av); i>=0; i--) {
637 if (svp[i] == val && svp[i] != &PL_sv_undef)
643 /* S_varname(): return the name of a variable, optionally with a subscript.
644 * If gv is non-zero, use the name of that global, along with gvtype (one
645 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
646 * targ. Depending on the value of the subscript_type flag, return:
649 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
650 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
651 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
652 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
655 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
656 SV* keyname, I32 aindex, int subscript_type)
659 SV * const name = sv_newmortal();
662 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
663 * XXX get rid of all this if gv_fullnameX() ever supports this
667 HV * const hv = GvSTASH(gv);
668 sv_setpv(name, gvtype);
671 else if (!(p=HvNAME_get(hv)))
673 if (strNE(p, "main")) {
675 sv_catpvn(name,"::", 2);
677 if (GvNAMELEN(gv)>= 1 &&
678 ((unsigned int)*GvNAME(gv)) <= 26)
680 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
681 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
684 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
688 CV * const cv = find_runcv(&unused);
692 if (!cv || !CvPADLIST(cv))
694 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
695 sv = *av_fetch(av, targ, FALSE);
696 /* SvLEN in a pad name is not to be trusted */
697 sv_setpv(name, SvPV_nolen_const(sv));
700 if (subscript_type == FUV_SUBSCRIPT_HASH) {
704 Perl_sv_catpvf(aTHX_ name, "{%s}",
705 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
708 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
710 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
712 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
713 sv_insert(name, 0, 0, "within ", 7);
720 =for apidoc find_uninit_var
722 Find the name of the undefined variable (if any) that caused the operator o
723 to issue a "Use of uninitialized value" warning.
724 If match is true, only return a name if it's value matches uninit_sv.
725 So roughly speaking, if a unary operator (such as OP_COS) generates a
726 warning, then following the direct child of the op may yield an
727 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
728 other hand, with OP_ADD there are two branches to follow, so we only print
729 the variable name if we get an exact match.
731 The name is returned as a mortal SV.
733 Assumes that PL_op is the op that originally triggered the error, and that
734 PL_comppad/PL_curpad points to the currently executing pad.
740 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
749 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
750 uninit_sv == &PL_sv_placeholder)))
753 switch (obase->op_type) {
760 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
761 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
764 int subscript_type = FUV_SUBSCRIPT_WITHIN;
766 if (pad) { /* @lex, %lex */
767 sv = PAD_SVl(obase->op_targ);
771 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
772 /* @global, %global */
773 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
776 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
778 else /* @{expr}, %{expr} */
779 return find_uninit_var(cUNOPx(obase)->op_first,
783 /* attempt to find a match within the aggregate */
785 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
787 subscript_type = FUV_SUBSCRIPT_HASH;
790 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
792 subscript_type = FUV_SUBSCRIPT_ARRAY;
795 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
798 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
799 keysv, index, subscript_type);
803 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
805 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
806 Nullsv, 0, FUV_SUBSCRIPT_NONE);
809 gv = cGVOPx_gv(obase);
810 if (!gv || (match && GvSV(gv) != uninit_sv))
812 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
815 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
817 av = (AV*)PAD_SV(obase->op_targ);
818 if (!av || SvRMAGICAL(av))
820 svp = av_fetch(av, (I32)obase->op_private, FALSE);
821 if (!svp || *svp != uninit_sv)
824 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
825 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
828 gv = cGVOPx_gv(obase);
833 if (!av || SvRMAGICAL(av))
835 svp = av_fetch(av, (I32)obase->op_private, FALSE);
836 if (!svp || *svp != uninit_sv)
839 return S_varname(aTHX_ gv, "$", 0,
840 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
845 o = cUNOPx(obase)->op_first;
846 if (!o || o->op_type != OP_NULL ||
847 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
849 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
854 /* $a[uninit_expr] or $h{uninit_expr} */
855 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
858 o = cBINOPx(obase)->op_first;
859 kid = cBINOPx(obase)->op_last;
861 /* get the av or hv, and optionally the gv */
863 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
864 sv = PAD_SV(o->op_targ);
866 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
867 && cUNOPo->op_first->op_type == OP_GV)
869 gv = cGVOPx_gv(cUNOPo->op_first);
872 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
877 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
878 /* index is constant */
882 if (obase->op_type == OP_HELEM) {
883 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
884 if (!he || HeVAL(he) != uninit_sv)
888 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
889 if (!svp || *svp != uninit_sv)
893 if (obase->op_type == OP_HELEM)
894 return S_varname(aTHX_ gv, "%", o->op_targ,
895 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
897 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
898 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
902 /* index is an expression;
903 * attempt to find a match within the aggregate */
904 if (obase->op_type == OP_HELEM) {
905 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
907 return S_varname(aTHX_ gv, "%", o->op_targ,
908 keysv, 0, FUV_SUBSCRIPT_HASH);
911 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
913 return S_varname(aTHX_ gv, "@", o->op_targ,
914 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
918 return S_varname(aTHX_ gv,
919 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
921 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
927 /* only examine RHS */
928 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
931 o = cUNOPx(obase)->op_first;
932 if (o->op_type == OP_PUSHMARK)
935 if (!o->op_sibling) {
936 /* one-arg version of open is highly magical */
938 if (o->op_type == OP_GV) { /* open FOO; */
940 if (match && GvSV(gv) != uninit_sv)
942 return S_varname(aTHX_ gv, "$", 0,
943 Nullsv, 0, FUV_SUBSCRIPT_NONE);
945 /* other possibilities not handled are:
946 * open $x; or open my $x; should return '${*$x}'
947 * open expr; should return '$'.expr ideally
953 /* ops where $_ may be an implicit arg */
957 if ( !(obase->op_flags & OPf_STACKED)) {
958 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
959 ? PAD_SVl(obase->op_targ)
963 sv_setpvn(sv, "$_", 2);
971 /* skip filehandle as it can't produce 'undef' warning */
972 o = cUNOPx(obase)->op_first;
973 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
974 o = o->op_sibling->op_sibling;
981 match = 1; /* XS or custom code could trigger random warnings */
986 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
987 return sv_2mortal(newSVpv("${$/}", 0));
992 if (!(obase->op_flags & OPf_KIDS))
994 o = cUNOPx(obase)->op_first;
1000 /* if all except one arg are constant, or have no side-effects,
1001 * or are optimized away, then it's unambiguous */
1003 for (kid=o; kid; kid = kid->op_sibling) {
1005 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1006 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1007 || (kid->op_type == OP_PUSHMARK)
1011 if (o2) { /* more than one found */
1018 return find_uninit_var(o2, uninit_sv, match);
1022 sv = find_uninit_var(o, uninit_sv, 1);
1034 =for apidoc report_uninit
1036 Print appropriate "Use of uninitialized variable" warning
1042 Perl_report_uninit(pTHX_ SV* uninit_sv)
1045 SV* varname = Nullsv;
1047 varname = find_uninit_var(PL_op, uninit_sv,0);
1049 sv_insert(varname, 0, 0, " ", 1);
1051 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1052 varname ? SvPV_nolen_const(varname) : "",
1053 " in ", OP_DESC(PL_op));
1056 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1061 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1065 const size_t count = PERL_ARENA_SIZE/size;
1066 New(0, start, count*size, char);
1067 *((void **) start) = *arena_root;
1068 *arena_root = (void *)start;
1070 end = start + (count-1) * size;
1072 /* The initial slot is used to link the arenas together, so it isn't to be
1073 linked into the list of ready-to-use bodies. */
1077 *root = (void *)start;
1079 while (start < end) {
1080 char * const next = start + size;
1081 *(void**) start = (void *)next;
1084 *(void **)start = 0;
1089 /* grab a new thing from the free list, allocating more if necessary */
1092 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1096 xpv = *root ? *root : S_more_bodies(aTHX_ arena_root, root, size);
1097 *root = *(void**)xpv;
1102 /* return a thing to the free list */
1104 #define del_body(thing, root) \
1107 *(void **)thing = *root; \
1108 *root = (void*)thing; \
1112 /* Conventionally we simply malloc() a big block of memory, then divide it
1113 up into lots of the thing that we're allocating.
1115 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1118 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1119 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1122 #define new_body(TYPE,lctype) \
1123 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1124 (void**)&PL_ ## lctype ## _root, \
1127 #define del_body_type(p,TYPE,lctype) \
1128 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1130 /* But for some types, we cheat. The type starts with some members that are
1131 never accessed. So we allocate the substructure, starting at the first used
1132 member, then adjust the pointer back in memory by the size of the bit not
1133 allocated, so it's as if we allocated the full structure.
1134 (But things will all go boom if you write to the part that is "not there",
1135 because you'll be overwriting the last members of the preceding structure
1138 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1139 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1140 and the pointer is unchanged. If the allocated structure is smaller (no
1141 initial NV actually allocated) then the net effect is to subtract the size
1142 of the NV from the pointer, to return a new pointer as if an initial NV were
1145 This is the same trick as was used for NV and IV bodies. Ironically it
1146 doesn't need to be used for NV bodies any more, because NV is now at the
1147 start of the structure. IV bodies don't need it either, because they are
1148 no longer allocated. */
1150 #define new_body_allocated(TYPE,lctype,member) \
1151 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1152 (void**)&PL_ ## lctype ## _root, \
1153 sizeof(lctype ## _allocated)) - \
1154 STRUCT_OFFSET(TYPE, member) \
1155 + STRUCT_OFFSET(lctype ## _allocated, member))
1158 #define del_body_allocated(p,TYPE,lctype,member) \
1159 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1160 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1161 (void**)&PL_ ## lctype ## _root)
1163 #define my_safemalloc(s) (void*)safemalloc(s)
1164 #define my_safefree(p) safefree((char*)p)
1168 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1169 #define del_XNV(p) my_safefree(p)
1171 #define new_XPV() my_safemalloc(sizeof(XPV))
1172 #define del_XPV(p) my_safefree(p)
1174 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1175 #define del_XPVIV(p) my_safefree(p)
1177 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1178 #define del_XPVNV(p) my_safefree(p)
1180 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1181 #define del_XPVCV(p) my_safefree(p)
1183 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1184 #define del_XPVAV(p) my_safefree(p)
1186 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1187 #define del_XPVHV(p) my_safefree(p)
1189 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1190 #define del_XPVMG(p) my_safefree(p)
1192 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1193 #define del_XPVGV(p) my_safefree(p)
1195 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1196 #define del_XPVLV(p) my_safefree(p)
1198 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1199 #define del_XPVBM(p) my_safefree(p)
1203 #define new_XNV() new_body(NV, xnv)
1204 #define del_XNV(p) del_body_type(p, NV, xnv)
1206 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1207 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1209 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1210 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1212 #define new_XPVNV() new_body(XPVNV, xpvnv)
1213 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1215 #define new_XPVCV() new_body(XPVCV, xpvcv)
1216 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1218 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1219 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1221 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1222 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1224 #define new_XPVMG() new_body(XPVMG, xpvmg)
1225 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1227 #define new_XPVGV() new_body(XPVGV, xpvgv)
1228 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1230 #define new_XPVLV() new_body(XPVLV, xpvlv)
1231 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1233 #define new_XPVBM() new_body(XPVBM, xpvbm)
1234 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1238 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1239 #define del_XPVFM(p) my_safefree(p)
1241 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1242 #define del_XPVIO(p) my_safefree(p)
1245 =for apidoc sv_upgrade
1247 Upgrade an SV to a more complex form. Generally adds a new body type to the
1248 SV, then copies across as much information as possible from the old body.
1249 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1255 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1257 void** old_body_arena;
1258 size_t old_body_offset;
1259 size_t old_body_length; /* Well, the length to copy. */
1261 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1262 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1264 bool zero_nv = TRUE;
1267 size_t new_body_length;
1268 size_t new_body_offset;
1269 void** new_body_arena;
1270 void** new_body_arenaroot;
1271 const U32 old_type = SvTYPE(sv);
1273 if (mt != SVt_PV && SvIsCOW(sv)) {
1274 sv_force_normal_flags(sv, 0);
1277 if (SvTYPE(sv) == mt)
1280 if (SvTYPE(sv) > mt)
1281 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1282 (int)SvTYPE(sv), (int)mt);
1285 old_body = SvANY(sv);
1287 old_body_offset = 0;
1288 old_body_length = 0;
1289 new_body_offset = 0;
1290 new_body_length = ~0;
1292 /* Copying structures onto other structures that have been neatly zeroed
1293 has a subtle gotcha. Consider XPVMG
1295 +------+------+------+------+------+-------+-------+
1296 | NV | CUR | LEN | IV | MAGIC | STASH |
1297 +------+------+------+------+------+-------+-------+
1298 0 4 8 12 16 20 24 28
1300 where NVs are aligned to 8 bytes, so that sizeof that structure is
1301 actually 32 bytes long, with 4 bytes of padding at the end:
1303 +------+------+------+------+------+-------+-------+------+
1304 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1305 +------+------+------+------+------+-------+-------+------+
1306 0 4 8 12 16 20 24 28 32
1308 so what happens if you allocate memory for this structure:
1310 +------+------+------+------+------+-------+-------+------+------+...
1311 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1312 +------+------+------+------+------+-------+-------+------+------+...
1313 0 4 8 12 16 20 24 28 32 36
1315 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1316 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1317 started out as zero once, but it's quite possible that it isn't. So now,
1318 rather than a nicely zeroed GP, you have it pointing somewhere random.
1321 (In fact, GP ends up pointing at a previous GP structure, because the
1322 principle cause of the padding in XPVMG getting garbage is a copy of
1323 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1325 So we are careful and work out the size of used parts of all the
1328 switch (SvTYPE(sv)) {
1334 else if (mt < SVt_PVIV)
1336 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1337 old_body_length = sizeof(IV);
1340 old_body_arena = (void **) &PL_xnv_root;
1341 old_body_length = sizeof(NV);
1342 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1351 old_body_arena = (void **) &PL_xpv_root;
1352 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1353 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1354 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1355 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1359 else if (mt == SVt_NV)
1363 old_body_arena = (void **) &PL_xpviv_root;
1364 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1365 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1366 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1367 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1371 old_body_arena = (void **) &PL_xpvnv_root;
1372 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1373 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1374 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1379 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1380 there's no way that it can be safely upgraded, because perl.c
1381 expects to Safefree(SvANY(PL_mess_sv)) */
1382 assert(sv != PL_mess_sv);
1383 /* This flag bit is used to mean other things in other scalar types.
1384 Given that it only has meaning inside the pad, it shouldn't be set
1385 on anything that can get upgraded. */
1386 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1387 old_body_arena = (void **) &PL_xpvmg_root;
1388 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1389 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1390 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1395 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1398 SvFLAGS(sv) &= ~SVTYPEMASK;
1403 Perl_croak(aTHX_ "Can't upgrade to undef");
1405 assert(old_type == SVt_NULL);
1406 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1410 assert(old_type == SVt_NULL);
1411 SvANY(sv) = new_XNV();
1415 assert(old_type == SVt_NULL);
1416 SvANY(sv) = &sv->sv_u.svu_rv;
1420 SvANY(sv) = new_XPVHV();
1423 HvTOTALKEYS(sv) = 0;
1428 SvANY(sv) = new_XPVAV();
1435 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1436 The target created by newSVrv also is, and it can have magic.
1437 However, it never has SvPVX set.
1439 if (old_type >= SVt_RV) {
1440 assert(SvPVX_const(sv) == 0);
1443 /* Could put this in the else clause below, as PVMG must have SvPVX
1444 0 already (the assertion above) */
1445 SvPV_set(sv, (char*)0);
1447 if (old_type >= SVt_PVMG) {
1448 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1449 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1457 new_body = new_XPVIO();
1458 new_body_length = sizeof(XPVIO);
1461 new_body = new_XPVFM();
1462 new_body_length = sizeof(XPVFM);
1466 new_body_length = sizeof(XPVBM);
1467 new_body_arena = (void **) &PL_xpvbm_root;
1468 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1471 new_body_length = sizeof(XPVGV);
1472 new_body_arena = (void **) &PL_xpvgv_root;
1473 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1476 new_body_length = sizeof(XPVCV);
1477 new_body_arena = (void **) &PL_xpvcv_root;
1478 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1481 new_body_length = sizeof(XPVLV);
1482 new_body_arena = (void **) &PL_xpvlv_root;
1483 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1486 new_body_length = sizeof(XPVMG);
1487 new_body_arena = (void **) &PL_xpvmg_root;
1488 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1491 new_body_length = sizeof(XPVNV);
1492 new_body_arena = (void **) &PL_xpvnv_root;
1493 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1496 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1497 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1498 new_body_length = sizeof(XPVIV) - new_body_offset;
1499 new_body_arena = (void **) &PL_xpviv_root;
1500 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1501 /* XXX Is this still needed? Was it ever needed? Surely as there is
1502 no route from NV to PVIV, NOK can never be true */
1506 goto new_body_no_NV;
1508 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1509 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1510 new_body_length = sizeof(XPV) - new_body_offset;
1511 new_body_arena = (void **) &PL_xpv_root;
1512 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1514 /* PV and PVIV don't have an NV slot. */
1515 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1520 assert(new_body_length);
1522 /* This points to the start of the allocated area. */
1523 new_body = S_new_body(aTHX_ new_body_arenaroot, new_body_arena,
1526 /* We always allocated the full length item with PURIFY */
1527 new_body_length += new_body_offset;
1528 new_body_offset = 0;
1529 new_body = my_safemalloc(new_body_length);
1533 Zero(new_body, new_body_length, char);
1534 new_body = ((char *)new_body) - new_body_offset;
1535 SvANY(sv) = new_body;
1537 if (old_body_length) {
1538 Copy((char *)old_body + old_body_offset,
1539 (char *)new_body + old_body_offset,
1540 old_body_length, char);
1543 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1549 IoPAGE_LEN(sv) = 60;
1550 if (old_type < SVt_RV)
1554 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1558 if (old_body_arena) {
1560 my_safefree(old_body);
1562 del_body((void*)((char*)old_body + old_body_offset),
1569 =for apidoc sv_backoff
1571 Remove any string offset. You should normally use the C<SvOOK_off> macro
1578 Perl_sv_backoff(pTHX_ register SV *sv)
1581 assert(SvTYPE(sv) != SVt_PVHV);
1582 assert(SvTYPE(sv) != SVt_PVAV);
1584 const char * const s = SvPVX_const(sv);
1585 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1586 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1588 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1590 SvFLAGS(sv) &= ~SVf_OOK;
1597 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1598 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1599 Use the C<SvGROW> wrapper instead.
1605 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1609 #ifdef HAS_64K_LIMIT
1610 if (newlen >= 0x10000) {
1611 PerlIO_printf(Perl_debug_log,
1612 "Allocation too large: %"UVxf"\n", (UV)newlen);
1615 #endif /* HAS_64K_LIMIT */
1618 if (SvTYPE(sv) < SVt_PV) {
1619 sv_upgrade(sv, SVt_PV);
1620 s = SvPVX_mutable(sv);
1622 else if (SvOOK(sv)) { /* pv is offset? */
1624 s = SvPVX_mutable(sv);
1625 if (newlen > SvLEN(sv))
1626 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1627 #ifdef HAS_64K_LIMIT
1628 if (newlen >= 0x10000)
1633 s = SvPVX_mutable(sv);
1635 if (newlen > SvLEN(sv)) { /* need more room? */
1636 newlen = PERL_STRLEN_ROUNDUP(newlen);
1637 if (SvLEN(sv) && s) {
1639 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1645 s = saferealloc(s, newlen);
1648 s = safemalloc(newlen);
1649 if (SvPVX_const(sv) && SvCUR(sv)) {
1650 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1654 SvLEN_set(sv, newlen);
1660 =for apidoc sv_setiv
1662 Copies an integer into the given SV, upgrading first if necessary.
1663 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1669 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1671 SV_CHECK_THINKFIRST_COW_DROP(sv);
1672 switch (SvTYPE(sv)) {
1674 sv_upgrade(sv, SVt_IV);
1677 sv_upgrade(sv, SVt_PVNV);
1681 sv_upgrade(sv, SVt_PVIV);
1690 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1693 (void)SvIOK_only(sv); /* validate number */
1699 =for apidoc sv_setiv_mg
1701 Like C<sv_setiv>, but also handles 'set' magic.
1707 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1714 =for apidoc sv_setuv
1716 Copies an unsigned integer into the given SV, upgrading first if necessary.
1717 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1723 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1725 /* With these two if statements:
1726 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1729 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1731 If you wish to remove them, please benchmark to see what the effect is
1733 if (u <= (UV)IV_MAX) {
1734 sv_setiv(sv, (IV)u);
1743 =for apidoc sv_setuv_mg
1745 Like C<sv_setuv>, but also handles 'set' magic.
1751 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1753 /* With these two if statements:
1754 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1757 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1759 If you wish to remove them, please benchmark to see what the effect is
1761 if (u <= (UV)IV_MAX) {
1762 sv_setiv(sv, (IV)u);
1772 =for apidoc sv_setnv
1774 Copies a double into the given SV, upgrading first if necessary.
1775 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1781 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1783 SV_CHECK_THINKFIRST_COW_DROP(sv);
1784 switch (SvTYPE(sv)) {
1787 sv_upgrade(sv, SVt_NV);
1792 sv_upgrade(sv, SVt_PVNV);
1801 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1805 (void)SvNOK_only(sv); /* validate number */
1810 =for apidoc sv_setnv_mg
1812 Like C<sv_setnv>, but also handles 'set' magic.
1818 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1824 /* Print an "isn't numeric" warning, using a cleaned-up,
1825 * printable version of the offending string
1829 S_not_a_number(pTHX_ SV *sv)
1836 dsv = sv_2mortal(newSVpv("", 0));
1837 pv = sv_uni_display(dsv, sv, 10, 0);
1840 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1841 /* each *s can expand to 4 chars + "...\0",
1842 i.e. need room for 8 chars */
1844 const char *s, *end;
1845 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1848 if (ch & 128 && !isPRINT_LC(ch)) {
1857 else if (ch == '\r') {
1861 else if (ch == '\f') {
1865 else if (ch == '\\') {
1869 else if (ch == '\0') {
1873 else if (isPRINT_LC(ch))
1890 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1891 "Argument \"%s\" isn't numeric in %s", pv,
1894 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1895 "Argument \"%s\" isn't numeric", pv);
1899 =for apidoc looks_like_number
1901 Test if the content of an SV looks like a number (or is a number).
1902 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1903 non-numeric warning), even if your atof() doesn't grok them.
1909 Perl_looks_like_number(pTHX_ SV *sv)
1911 register const char *sbegin;
1915 sbegin = SvPVX_const(sv);
1918 else if (SvPOKp(sv))
1919 sbegin = SvPV_const(sv, len);
1921 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1922 return grok_number(sbegin, len, NULL);
1925 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1926 until proven guilty, assume that things are not that bad... */
1931 As 64 bit platforms often have an NV that doesn't preserve all bits of
1932 an IV (an assumption perl has been based on to date) it becomes necessary
1933 to remove the assumption that the NV always carries enough precision to
1934 recreate the IV whenever needed, and that the NV is the canonical form.
1935 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1936 precision as a side effect of conversion (which would lead to insanity
1937 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1938 1) to distinguish between IV/UV/NV slots that have cached a valid
1939 conversion where precision was lost and IV/UV/NV slots that have a
1940 valid conversion which has lost no precision
1941 2) to ensure that if a numeric conversion to one form is requested that
1942 would lose precision, the precise conversion (or differently
1943 imprecise conversion) is also performed and cached, to prevent
1944 requests for different numeric formats on the same SV causing
1945 lossy conversion chains. (lossless conversion chains are perfectly
1950 SvIOKp is true if the IV slot contains a valid value
1951 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1952 SvNOKp is true if the NV slot contains a valid value
1953 SvNOK is true only if the NV value is accurate
1956 while converting from PV to NV, check to see if converting that NV to an
1957 IV(or UV) would lose accuracy over a direct conversion from PV to
1958 IV(or UV). If it would, cache both conversions, return NV, but mark
1959 SV as IOK NOKp (ie not NOK).
1961 While converting from PV to IV, check to see if converting that IV to an
1962 NV would lose accuracy over a direct conversion from PV to NV. If it
1963 would, cache both conversions, flag similarly.
1965 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1966 correctly because if IV & NV were set NV *always* overruled.
1967 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1968 changes - now IV and NV together means that the two are interchangeable:
1969 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1971 The benefit of this is that operations such as pp_add know that if
1972 SvIOK is true for both left and right operands, then integer addition
1973 can be used instead of floating point (for cases where the result won't
1974 overflow). Before, floating point was always used, which could lead to
1975 loss of precision compared with integer addition.
1977 * making IV and NV equal status should make maths accurate on 64 bit
1979 * may speed up maths somewhat if pp_add and friends start to use
1980 integers when possible instead of fp. (Hopefully the overhead in
1981 looking for SvIOK and checking for overflow will not outweigh the
1982 fp to integer speedup)
1983 * will slow down integer operations (callers of SvIV) on "inaccurate"
1984 values, as the change from SvIOK to SvIOKp will cause a call into
1985 sv_2iv each time rather than a macro access direct to the IV slot
1986 * should speed up number->string conversion on integers as IV is
1987 favoured when IV and NV are equally accurate
1989 ####################################################################
1990 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1991 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1992 On the other hand, SvUOK is true iff UV.
1993 ####################################################################
1995 Your mileage will vary depending your CPU's relative fp to integer
1999 #ifndef NV_PRESERVES_UV
2000 # define IS_NUMBER_UNDERFLOW_IV 1
2001 # define IS_NUMBER_UNDERFLOW_UV 2
2002 # define IS_NUMBER_IV_AND_UV 2
2003 # define IS_NUMBER_OVERFLOW_IV 4
2004 # define IS_NUMBER_OVERFLOW_UV 5
2006 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2008 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2010 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2012 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));
2013 if (SvNVX(sv) < (NV)IV_MIN) {
2014 (void)SvIOKp_on(sv);
2016 SvIV_set(sv, IV_MIN);
2017 return IS_NUMBER_UNDERFLOW_IV;
2019 if (SvNVX(sv) > (NV)UV_MAX) {
2020 (void)SvIOKp_on(sv);
2023 SvUV_set(sv, UV_MAX);
2024 return IS_NUMBER_OVERFLOW_UV;
2026 (void)SvIOKp_on(sv);
2028 /* Can't use strtol etc to convert this string. (See truth table in
2030 if (SvNVX(sv) <= (UV)IV_MAX) {
2031 SvIV_set(sv, I_V(SvNVX(sv)));
2032 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2033 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2035 /* Integer is imprecise. NOK, IOKp */
2037 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2040 SvUV_set(sv, U_V(SvNVX(sv)));
2041 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2042 if (SvUVX(sv) == UV_MAX) {
2043 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2044 possibly be preserved by NV. Hence, it must be overflow.
2046 return IS_NUMBER_OVERFLOW_UV;
2048 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2050 /* Integer is imprecise. NOK, IOKp */
2052 return IS_NUMBER_OVERFLOW_IV;
2054 #endif /* !NV_PRESERVES_UV*/
2056 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2057 * this function provided for binary compatibility only
2061 Perl_sv_2iv(pTHX_ register SV *sv)
2063 return sv_2iv_flags(sv, SV_GMAGIC);
2067 =for apidoc sv_2iv_flags
2069 Return the integer value of an SV, doing any necessary string
2070 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2071 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2077 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2081 if (SvGMAGICAL(sv)) {
2082 if (flags & SV_GMAGIC)
2087 return I_V(SvNVX(sv));
2089 if (SvPOKp(sv) && SvLEN(sv))
2092 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2093 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2099 if (SvTHINKFIRST(sv)) {
2102 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2103 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2104 return SvIV(tmpstr);
2105 return PTR2IV(SvRV(sv));
2108 sv_force_normal_flags(sv, 0);
2110 if (SvREADONLY(sv) && !SvOK(sv)) {
2111 if (ckWARN(WARN_UNINITIALIZED))
2118 return (IV)(SvUVX(sv));
2125 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2126 * without also getting a cached IV/UV from it at the same time
2127 * (ie PV->NV conversion should detect loss of accuracy and cache
2128 * IV or UV at same time to avoid this. NWC */
2130 if (SvTYPE(sv) == SVt_NV)
2131 sv_upgrade(sv, SVt_PVNV);
2133 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2134 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2135 certainly cast into the IV range at IV_MAX, whereas the correct
2136 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2138 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2139 SvIV_set(sv, I_V(SvNVX(sv)));
2140 if (SvNVX(sv) == (NV) SvIVX(sv)
2141 #ifndef NV_PRESERVES_UV
2142 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2143 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2144 /* Don't flag it as "accurately an integer" if the number
2145 came from a (by definition imprecise) NV operation, and
2146 we're outside the range of NV integer precision */
2149 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2150 DEBUG_c(PerlIO_printf(Perl_debug_log,
2151 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2157 /* IV not precise. No need to convert from PV, as NV
2158 conversion would already have cached IV if it detected
2159 that PV->IV would be better than PV->NV->IV
2160 flags already correct - don't set public IOK. */
2161 DEBUG_c(PerlIO_printf(Perl_debug_log,
2162 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2167 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2168 but the cast (NV)IV_MIN rounds to a the value less (more
2169 negative) than IV_MIN which happens to be equal to SvNVX ??
2170 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2171 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2172 (NV)UVX == NVX are both true, but the values differ. :-(
2173 Hopefully for 2s complement IV_MIN is something like
2174 0x8000000000000000 which will be exact. NWC */
2177 SvUV_set(sv, U_V(SvNVX(sv)));
2179 (SvNVX(sv) == (NV) SvUVX(sv))
2180 #ifndef NV_PRESERVES_UV
2181 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2182 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2183 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2184 /* Don't flag it as "accurately an integer" if the number
2185 came from a (by definition imprecise) NV operation, and
2186 we're outside the range of NV integer precision */
2192 DEBUG_c(PerlIO_printf(Perl_debug_log,
2193 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2197 return (IV)SvUVX(sv);
2200 else if (SvPOKp(sv) && SvLEN(sv)) {
2202 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2203 /* We want to avoid a possible problem when we cache an IV which
2204 may be later translated to an NV, and the resulting NV is not
2205 the same as the direct translation of the initial string
2206 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2207 be careful to ensure that the value with the .456 is around if the
2208 NV value is requested in the future).
2210 This means that if we cache such an IV, we need to cache the
2211 NV as well. Moreover, we trade speed for space, and do not
2212 cache the NV if we are sure it's not needed.
2215 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2216 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2217 == IS_NUMBER_IN_UV) {
2218 /* It's definitely an integer, only upgrade to PVIV */
2219 if (SvTYPE(sv) < SVt_PVIV)
2220 sv_upgrade(sv, SVt_PVIV);
2222 } else if (SvTYPE(sv) < SVt_PVNV)
2223 sv_upgrade(sv, SVt_PVNV);
2225 /* If NV preserves UV then we only use the UV value if we know that
2226 we aren't going to call atof() below. If NVs don't preserve UVs
2227 then the value returned may have more precision than atof() will
2228 return, even though value isn't perfectly accurate. */
2229 if ((numtype & (IS_NUMBER_IN_UV
2230 #ifdef NV_PRESERVES_UV
2233 )) == IS_NUMBER_IN_UV) {
2234 /* This won't turn off the public IOK flag if it was set above */
2235 (void)SvIOKp_on(sv);
2237 if (!(numtype & IS_NUMBER_NEG)) {
2239 if (value <= (UV)IV_MAX) {
2240 SvIV_set(sv, (IV)value);
2242 SvUV_set(sv, value);
2246 /* 2s complement assumption */
2247 if (value <= (UV)IV_MIN) {
2248 SvIV_set(sv, -(IV)value);
2250 /* Too negative for an IV. This is a double upgrade, but
2251 I'm assuming it will be rare. */
2252 if (SvTYPE(sv) < SVt_PVNV)
2253 sv_upgrade(sv, SVt_PVNV);
2257 SvNV_set(sv, -(NV)value);
2258 SvIV_set(sv, IV_MIN);
2262 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2263 will be in the previous block to set the IV slot, and the next
2264 block to set the NV slot. So no else here. */
2266 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2267 != IS_NUMBER_IN_UV) {
2268 /* It wasn't an (integer that doesn't overflow the UV). */
2269 SvNV_set(sv, Atof(SvPVX_const(sv)));
2271 if (! numtype && ckWARN(WARN_NUMERIC))
2274 #if defined(USE_LONG_DOUBLE)
2275 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2276 PTR2UV(sv), SvNVX(sv)));
2278 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2279 PTR2UV(sv), SvNVX(sv)));
2283 #ifdef NV_PRESERVES_UV
2284 (void)SvIOKp_on(sv);
2286 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2287 SvIV_set(sv, I_V(SvNVX(sv)));
2288 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2291 /* Integer is imprecise. NOK, IOKp */
2293 /* UV will not work better than IV */
2295 if (SvNVX(sv) > (NV)UV_MAX) {
2297 /* Integer is inaccurate. NOK, IOKp, is UV */
2298 SvUV_set(sv, UV_MAX);
2301 SvUV_set(sv, U_V(SvNVX(sv)));
2302 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2303 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2307 /* Integer is imprecise. NOK, IOKp, is UV */
2313 #else /* NV_PRESERVES_UV */
2314 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2315 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2316 /* The IV slot will have been set from value returned by
2317 grok_number above. The NV slot has just been set using
2320 assert (SvIOKp(sv));
2322 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2323 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2324 /* Small enough to preserve all bits. */
2325 (void)SvIOKp_on(sv);
2327 SvIV_set(sv, I_V(SvNVX(sv)));
2328 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2330 /* Assumption: first non-preserved integer is < IV_MAX,
2331 this NV is in the preserved range, therefore: */
2332 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2334 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);
2338 0 0 already failed to read UV.
2339 0 1 already failed to read UV.
2340 1 0 you won't get here in this case. IV/UV
2341 slot set, public IOK, Atof() unneeded.
2342 1 1 already read UV.
2343 so there's no point in sv_2iuv_non_preserve() attempting
2344 to use atol, strtol, strtoul etc. */
2345 if (sv_2iuv_non_preserve (sv, numtype)
2346 >= IS_NUMBER_OVERFLOW_IV)
2350 #endif /* NV_PRESERVES_UV */
2353 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2355 if (SvTYPE(sv) < SVt_IV)
2356 /* Typically the caller expects that sv_any is not NULL now. */
2357 sv_upgrade(sv, SVt_IV);
2360 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2361 PTR2UV(sv),SvIVX(sv)));
2362 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2365 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2366 * this function provided for binary compatibility only
2370 Perl_sv_2uv(pTHX_ register SV *sv)
2372 return sv_2uv_flags(sv, SV_GMAGIC);
2376 =for apidoc sv_2uv_flags
2378 Return the unsigned integer value of an SV, doing any necessary string
2379 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2380 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2386 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2390 if (SvGMAGICAL(sv)) {
2391 if (flags & SV_GMAGIC)
2396 return U_V(SvNVX(sv));
2397 if (SvPOKp(sv) && SvLEN(sv))
2400 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2401 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2407 if (SvTHINKFIRST(sv)) {
2410 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2411 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2412 return SvUV(tmpstr);
2413 return PTR2UV(SvRV(sv));
2416 sv_force_normal_flags(sv, 0);
2418 if (SvREADONLY(sv) && !SvOK(sv)) {
2419 if (ckWARN(WARN_UNINITIALIZED))
2429 return (UV)SvIVX(sv);
2433 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2434 * without also getting a cached IV/UV from it at the same time
2435 * (ie PV->NV conversion should detect loss of accuracy and cache
2436 * IV or UV at same time to avoid this. */
2437 /* IV-over-UV optimisation - choose to cache IV if possible */
2439 if (SvTYPE(sv) == SVt_NV)
2440 sv_upgrade(sv, SVt_PVNV);
2442 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2443 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2444 SvIV_set(sv, I_V(SvNVX(sv)));
2445 if (SvNVX(sv) == (NV) SvIVX(sv)
2446 #ifndef NV_PRESERVES_UV
2447 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2448 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2449 /* Don't flag it as "accurately an integer" if the number
2450 came from a (by definition imprecise) NV operation, and
2451 we're outside the range of NV integer precision */
2454 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2455 DEBUG_c(PerlIO_printf(Perl_debug_log,
2456 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2462 /* IV not precise. No need to convert from PV, as NV
2463 conversion would already have cached IV if it detected
2464 that PV->IV would be better than PV->NV->IV
2465 flags already correct - don't set public IOK. */
2466 DEBUG_c(PerlIO_printf(Perl_debug_log,
2467 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2472 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2473 but the cast (NV)IV_MIN rounds to a the value less (more
2474 negative) than IV_MIN which happens to be equal to SvNVX ??
2475 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2476 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2477 (NV)UVX == NVX are both true, but the values differ. :-(
2478 Hopefully for 2s complement IV_MIN is something like
2479 0x8000000000000000 which will be exact. NWC */
2482 SvUV_set(sv, U_V(SvNVX(sv)));
2484 (SvNVX(sv) == (NV) SvUVX(sv))
2485 #ifndef NV_PRESERVES_UV
2486 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2487 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2488 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2489 /* Don't flag it as "accurately an integer" if the number
2490 came from a (by definition imprecise) NV operation, and
2491 we're outside the range of NV integer precision */
2496 DEBUG_c(PerlIO_printf(Perl_debug_log,
2497 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2503 else if (SvPOKp(sv) && SvLEN(sv)) {
2505 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2507 /* We want to avoid a possible problem when we cache a UV which
2508 may be later translated to an NV, and the resulting NV is not
2509 the translation of the initial data.
2511 This means that if we cache such a UV, we need to cache the
2512 NV as well. Moreover, we trade speed for space, and do not
2513 cache the NV if not needed.
2516 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2517 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2518 == IS_NUMBER_IN_UV) {
2519 /* It's definitely an integer, only upgrade to PVIV */
2520 if (SvTYPE(sv) < SVt_PVIV)
2521 sv_upgrade(sv, SVt_PVIV);
2523 } else if (SvTYPE(sv) < SVt_PVNV)
2524 sv_upgrade(sv, SVt_PVNV);
2526 /* If NV preserves UV then we only use the UV value if we know that
2527 we aren't going to call atof() below. If NVs don't preserve UVs
2528 then the value returned may have more precision than atof() will
2529 return, even though it isn't accurate. */
2530 if ((numtype & (IS_NUMBER_IN_UV
2531 #ifdef NV_PRESERVES_UV
2534 )) == IS_NUMBER_IN_UV) {
2535 /* This won't turn off the public IOK flag if it was set above */
2536 (void)SvIOKp_on(sv);
2538 if (!(numtype & IS_NUMBER_NEG)) {
2540 if (value <= (UV)IV_MAX) {
2541 SvIV_set(sv, (IV)value);
2543 /* it didn't overflow, and it was positive. */
2544 SvUV_set(sv, value);
2548 /* 2s complement assumption */
2549 if (value <= (UV)IV_MIN) {
2550 SvIV_set(sv, -(IV)value);
2552 /* Too negative for an IV. This is a double upgrade, but
2553 I'm assuming it will be rare. */
2554 if (SvTYPE(sv) < SVt_PVNV)
2555 sv_upgrade(sv, SVt_PVNV);
2559 SvNV_set(sv, -(NV)value);
2560 SvIV_set(sv, IV_MIN);
2565 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2566 != IS_NUMBER_IN_UV) {
2567 /* It wasn't an integer, or it overflowed the UV. */
2568 SvNV_set(sv, Atof(SvPVX_const(sv)));
2570 if (! numtype && ckWARN(WARN_NUMERIC))
2573 #if defined(USE_LONG_DOUBLE)
2574 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2575 PTR2UV(sv), SvNVX(sv)));
2577 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2578 PTR2UV(sv), SvNVX(sv)));
2581 #ifdef NV_PRESERVES_UV
2582 (void)SvIOKp_on(sv);
2584 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2585 SvIV_set(sv, I_V(SvNVX(sv)));
2586 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2589 /* Integer is imprecise. NOK, IOKp */
2591 /* UV will not work better than IV */
2593 if (SvNVX(sv) > (NV)UV_MAX) {
2595 /* Integer is inaccurate. NOK, IOKp, is UV */
2596 SvUV_set(sv, UV_MAX);
2599 SvUV_set(sv, U_V(SvNVX(sv)));
2600 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2601 NV preservse UV so can do correct comparison. */
2602 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2606 /* Integer is imprecise. NOK, IOKp, is UV */
2611 #else /* NV_PRESERVES_UV */
2612 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2613 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2614 /* The UV slot will have been set from value returned by
2615 grok_number above. The NV slot has just been set using
2618 assert (SvIOKp(sv));
2620 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2621 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2622 /* Small enough to preserve all bits. */
2623 (void)SvIOKp_on(sv);
2625 SvIV_set(sv, I_V(SvNVX(sv)));
2626 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2628 /* Assumption: first non-preserved integer is < IV_MAX,
2629 this NV is in the preserved range, therefore: */
2630 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2632 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);
2635 sv_2iuv_non_preserve (sv, numtype);
2637 #endif /* NV_PRESERVES_UV */
2641 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2642 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2645 if (SvTYPE(sv) < SVt_IV)
2646 /* Typically the caller expects that sv_any is not NULL now. */
2647 sv_upgrade(sv, SVt_IV);
2651 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2652 PTR2UV(sv),SvUVX(sv)));
2653 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2659 Return the num value of an SV, doing any necessary string or integer
2660 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2667 Perl_sv_2nv(pTHX_ register SV *sv)
2671 if (SvGMAGICAL(sv)) {
2675 if (SvPOKp(sv) && SvLEN(sv)) {
2676 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2677 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2679 return Atof(SvPVX_const(sv));
2683 return (NV)SvUVX(sv);
2685 return (NV)SvIVX(sv);
2688 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2689 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2695 if (SvTHINKFIRST(sv)) {
2698 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2699 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2700 return SvNV(tmpstr);
2701 return PTR2NV(SvRV(sv));
2704 sv_force_normal_flags(sv, 0);
2706 if (SvREADONLY(sv) && !SvOK(sv)) {
2707 if (ckWARN(WARN_UNINITIALIZED))
2712 if (SvTYPE(sv) < SVt_NV) {
2713 if (SvTYPE(sv) == SVt_IV)
2714 sv_upgrade(sv, SVt_PVNV);
2716 sv_upgrade(sv, SVt_NV);
2717 #ifdef USE_LONG_DOUBLE
2719 STORE_NUMERIC_LOCAL_SET_STANDARD();
2720 PerlIO_printf(Perl_debug_log,
2721 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2722 PTR2UV(sv), SvNVX(sv));
2723 RESTORE_NUMERIC_LOCAL();
2727 STORE_NUMERIC_LOCAL_SET_STANDARD();
2728 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2729 PTR2UV(sv), SvNVX(sv));
2730 RESTORE_NUMERIC_LOCAL();
2734 else if (SvTYPE(sv) < SVt_PVNV)
2735 sv_upgrade(sv, SVt_PVNV);
2740 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2741 #ifdef NV_PRESERVES_UV
2744 /* Only set the public NV OK flag if this NV preserves the IV */
2745 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2746 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2747 : (SvIVX(sv) == I_V(SvNVX(sv))))
2753 else if (SvPOKp(sv) && SvLEN(sv)) {
2755 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2756 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2758 #ifdef NV_PRESERVES_UV
2759 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2760 == IS_NUMBER_IN_UV) {
2761 /* It's definitely an integer */
2762 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2764 SvNV_set(sv, Atof(SvPVX_const(sv)));
2767 SvNV_set(sv, Atof(SvPVX_const(sv)));
2768 /* Only set the public NV OK flag if this NV preserves the value in
2769 the PV at least as well as an IV/UV would.
2770 Not sure how to do this 100% reliably. */
2771 /* if that shift count is out of range then Configure's test is
2772 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2774 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2775 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2776 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2777 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2778 /* Can't use strtol etc to convert this string, so don't try.
2779 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2782 /* value has been set. It may not be precise. */
2783 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2784 /* 2s complement assumption for (UV)IV_MIN */
2785 SvNOK_on(sv); /* Integer is too negative. */
2790 if (numtype & IS_NUMBER_NEG) {
2791 SvIV_set(sv, -(IV)value);
2792 } else if (value <= (UV)IV_MAX) {
2793 SvIV_set(sv, (IV)value);
2795 SvUV_set(sv, value);
2799 if (numtype & IS_NUMBER_NOT_INT) {
2800 /* I believe that even if the original PV had decimals,
2801 they are lost beyond the limit of the FP precision.
2802 However, neither is canonical, so both only get p
2803 flags. NWC, 2000/11/25 */
2804 /* Both already have p flags, so do nothing */
2806 const NV nv = SvNVX(sv);
2807 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2808 if (SvIVX(sv) == I_V(nv)) {
2813 /* It had no "." so it must be integer. */
2816 /* between IV_MAX and NV(UV_MAX).
2817 Could be slightly > UV_MAX */
2819 if (numtype & IS_NUMBER_NOT_INT) {
2820 /* UV and NV both imprecise. */
2822 const UV nv_as_uv = U_V(nv);
2824 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2835 #endif /* NV_PRESERVES_UV */
2838 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2840 if (SvTYPE(sv) < SVt_NV)
2841 /* Typically the caller expects that sv_any is not NULL now. */
2842 /* XXX Ilya implies that this is a bug in callers that assume this
2843 and ideally should be fixed. */
2844 sv_upgrade(sv, SVt_NV);
2847 #if defined(USE_LONG_DOUBLE)
2849 STORE_NUMERIC_LOCAL_SET_STANDARD();
2850 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2851 PTR2UV(sv), SvNVX(sv));
2852 RESTORE_NUMERIC_LOCAL();
2856 STORE_NUMERIC_LOCAL_SET_STANDARD();
2857 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2858 PTR2UV(sv), SvNVX(sv));
2859 RESTORE_NUMERIC_LOCAL();
2865 /* asIV(): extract an integer from the string value of an SV.
2866 * Caller must validate PVX */
2869 S_asIV(pTHX_ SV *sv)
2872 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2874 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2875 == IS_NUMBER_IN_UV) {
2876 /* It's definitely an integer */
2877 if (numtype & IS_NUMBER_NEG) {
2878 if (value < (UV)IV_MIN)
2881 if (value < (UV)IV_MAX)
2886 if (ckWARN(WARN_NUMERIC))
2889 return I_V(Atof(SvPVX_const(sv)));
2892 /* asUV(): extract an unsigned integer from the string value of an SV
2893 * Caller must validate PVX */
2896 S_asUV(pTHX_ SV *sv)
2899 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2901 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2902 == IS_NUMBER_IN_UV) {
2903 /* It's definitely an integer */
2904 if (!(numtype & IS_NUMBER_NEG))
2908 if (ckWARN(WARN_NUMERIC))
2911 return U_V(Atof(SvPVX_const(sv)));
2915 =for apidoc sv_2pv_nolen
2917 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2918 use the macro wrapper C<SvPV_nolen(sv)> instead.
2923 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2925 return sv_2pv(sv, 0);
2928 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2929 * UV as a string towards the end of buf, and return pointers to start and
2932 * We assume that buf is at least TYPE_CHARS(UV) long.
2936 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2938 char *ptr = buf + TYPE_CHARS(UV);
2952 *--ptr = '0' + (char)(uv % 10);
2960 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2961 * this function provided for binary compatibility only
2965 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2967 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2971 =for apidoc sv_2pv_flags
2973 Returns a pointer to the string value of an SV, and sets *lp to its length.
2974 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2976 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2977 usually end up here too.
2983 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2988 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2989 char *tmpbuf = tbuf;
2996 if (SvGMAGICAL(sv)) {
2997 if (flags & SV_GMAGIC)
3002 if (flags & SV_MUTABLE_RETURN)
3003 return SvPVX_mutable(sv);
3004 if (flags & SV_CONST_RETURN)
3005 return (char *)SvPVX_const(sv);
3010 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3012 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3017 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3022 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3023 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3031 if (SvTHINKFIRST(sv)) {
3034 register const char *typestr;
3035 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3036 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3038 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3041 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3042 if (flags & SV_CONST_RETURN) {
3043 pv = (char *) SvPVX_const(tmpstr);
3045 pv = (flags & SV_MUTABLE_RETURN)
3046 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3049 *lp = SvCUR(tmpstr);
3051 pv = sv_2pv_flags(tmpstr, lp, flags);
3062 typestr = "NULLREF";
3066 switch (SvTYPE(sv)) {
3068 if ( ((SvFLAGS(sv) &
3069 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3070 == (SVs_OBJECT|SVs_SMG))
3071 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3072 const regexp *re = (regexp *)mg->mg_obj;
3075 const char *fptr = "msix";
3080 char need_newline = 0;
3081 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3083 while((ch = *fptr++)) {
3085 reflags[left++] = ch;
3088 reflags[right--] = ch;
3093 reflags[left] = '-';
3097 mg->mg_len = re->prelen + 4 + left;
3099 * If /x was used, we have to worry about a regex
3100 * ending with a comment later being embedded
3101 * within another regex. If so, we don't want this
3102 * regex's "commentization" to leak out to the
3103 * right part of the enclosing regex, we must cap
3104 * it with a newline.
3106 * So, if /x was used, we scan backwards from the
3107 * end of the regex. If we find a '#' before we
3108 * find a newline, we need to add a newline
3109 * ourself. If we find a '\n' first (or if we
3110 * don't find '#' or '\n'), we don't need to add
3111 * anything. -jfriedl
3113 if (PMf_EXTENDED & re->reganch)
3115 const char *endptr = re->precomp + re->prelen;
3116 while (endptr >= re->precomp)
3118 const char c = *(endptr--);
3120 break; /* don't need another */
3122 /* we end while in a comment, so we
3124 mg->mg_len++; /* save space for it */
3125 need_newline = 1; /* note to add it */
3131 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3132 Copy("(?", mg->mg_ptr, 2, char);
3133 Copy(reflags, mg->mg_ptr+2, left, char);
3134 Copy(":", mg->mg_ptr+left+2, 1, char);
3135 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3137 mg->mg_ptr[mg->mg_len - 2] = '\n';
3138 mg->mg_ptr[mg->mg_len - 1] = ')';
3139 mg->mg_ptr[mg->mg_len] = 0;
3141 PL_reginterp_cnt += re->program[0].next_off;
3143 if (re->reganch & ROPT_UTF8)
3159 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3160 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3161 /* tied lvalues should appear to be
3162 * scalars for backwards compatitbility */
3163 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3164 ? "SCALAR" : "LVALUE"; break;
3165 case SVt_PVAV: typestr = "ARRAY"; break;
3166 case SVt_PVHV: typestr = "HASH"; break;
3167 case SVt_PVCV: typestr = "CODE"; break;
3168 case SVt_PVGV: typestr = "GLOB"; break;
3169 case SVt_PVFM: typestr = "FORMAT"; break;
3170 case SVt_PVIO: typestr = "IO"; break;
3171 default: typestr = "UNKNOWN"; break;
3175 const char *name = HvNAME_get(SvSTASH(sv));
3176 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3177 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3180 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3184 *lp = strlen(typestr);
3185 return (char *)typestr;
3187 if (SvREADONLY(sv) && !SvOK(sv)) {
3188 if (ckWARN(WARN_UNINITIALIZED))
3195 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3196 /* I'm assuming that if both IV and NV are equally valid then
3197 converting the IV is going to be more efficient */
3198 const U32 isIOK = SvIOK(sv);
3199 const U32 isUIOK = SvIsUV(sv);
3200 char buf[TYPE_CHARS(UV)];
3203 if (SvTYPE(sv) < SVt_PVIV)
3204 sv_upgrade(sv, SVt_PVIV);
3206 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3208 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3209 /* inlined from sv_setpvn */
3210 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3211 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3212 SvCUR_set(sv, ebuf - ptr);
3222 else if (SvNOKp(sv)) {
3223 if (SvTYPE(sv) < SVt_PVNV)
3224 sv_upgrade(sv, SVt_PVNV);
3225 /* The +20 is pure guesswork. Configure test needed. --jhi */
3226 s = SvGROW_mutable(sv, NV_DIG + 20);
3227 olderrno = errno; /* some Xenix systems wipe out errno here */
3229 if (SvNVX(sv) == 0.0)
3230 (void)strcpy(s,"0");
3234 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3237 #ifdef FIXNEGATIVEZERO
3238 if (*s == '-' && s[1] == '0' && !s[2])
3248 if (ckWARN(WARN_UNINITIALIZED)
3249 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3253 if (SvTYPE(sv) < SVt_PV)
3254 /* Typically the caller expects that sv_any is not NULL now. */
3255 sv_upgrade(sv, SVt_PV);
3259 STRLEN len = s - SvPVX_const(sv);
3265 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3266 PTR2UV(sv),SvPVX_const(sv)));
3267 if (flags & SV_CONST_RETURN)
3268 return (char *)SvPVX_const(sv);
3269 if (flags & SV_MUTABLE_RETURN)
3270 return SvPVX_mutable(sv);
3274 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3275 /* Sneaky stuff here */
3279 tsv = newSVpv(tmpbuf, 0);
3292 t = SvPVX_const(tsv);
3297 len = strlen(tmpbuf);
3299 #ifdef FIXNEGATIVEZERO
3300 if (len == 2 && t[0] == '-' && t[1] == '0') {
3305 SvUPGRADE(sv, SVt_PV);
3308 s = SvGROW_mutable(sv, len + 1);
3311 return strcpy(s, t);
3316 =for apidoc sv_copypv
3318 Copies a stringified representation of the source SV into the
3319 destination SV. Automatically performs any necessary mg_get and
3320 coercion of numeric values into strings. Guaranteed to preserve
3321 UTF-8 flag even from overloaded objects. Similar in nature to
3322 sv_2pv[_flags] but operates directly on an SV instead of just the
3323 string. Mostly uses sv_2pv_flags to do its work, except when that
3324 would lose the UTF-8'ness of the PV.
3330 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3333 const char * const s = SvPV_const(ssv,len);
3334 sv_setpvn(dsv,s,len);
3342 =for apidoc sv_2pvbyte_nolen
3344 Return a pointer to the byte-encoded representation of the SV.
3345 May cause the SV to be downgraded from UTF-8 as a side-effect.
3347 Usually accessed via the C<SvPVbyte_nolen> macro.
3353 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3355 return sv_2pvbyte(sv, 0);
3359 =for apidoc sv_2pvbyte
3361 Return a pointer to the byte-encoded representation of the SV, and set *lp
3362 to its length. May cause the SV to be downgraded from UTF-8 as a
3365 Usually accessed via the C<SvPVbyte> macro.
3371 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3373 sv_utf8_downgrade(sv,0);
3374 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3378 =for apidoc sv_2pvutf8_nolen
3380 Return a pointer to the UTF-8-encoded representation of the SV.
3381 May cause the SV to be upgraded to UTF-8 as a side-effect.
3383 Usually accessed via the C<SvPVutf8_nolen> macro.
3389 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3391 return sv_2pvutf8(sv, 0);
3395 =for apidoc sv_2pvutf8
3397 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3398 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3400 Usually accessed via the C<SvPVutf8> macro.
3406 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3408 sv_utf8_upgrade(sv);
3409 return SvPV(sv,*lp);
3413 =for apidoc sv_2bool
3415 This function is only called on magical items, and is only used by
3416 sv_true() or its macro equivalent.
3422 Perl_sv_2bool(pTHX_ register SV *sv)
3431 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3432 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3433 return (bool)SvTRUE(tmpsv);
3434 return SvRV(sv) != 0;
3437 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3439 (*sv->sv_u.svu_pv > '0' ||
3440 Xpvtmp->xpv_cur > 1 ||
3441 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3448 return SvIVX(sv) != 0;
3451 return SvNVX(sv) != 0.0;
3458 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3459 * this function provided for binary compatibility only
3464 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3466 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3470 =for apidoc sv_utf8_upgrade
3472 Converts the PV of an SV to its UTF-8-encoded form.
3473 Forces the SV to string form if it is not already.
3474 Always sets the SvUTF8 flag to avoid future validity checks even
3475 if all the bytes have hibit clear.
3477 This is not as a general purpose byte encoding to Unicode interface:
3478 use the Encode extension for that.
3480 =for apidoc sv_utf8_upgrade_flags
3482 Converts the PV of an SV to its UTF-8-encoded form.
3483 Forces the SV to string form if it is not already.
3484 Always sets the SvUTF8 flag to avoid future validity checks even
3485 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3486 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3487 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3489 This is not as a general purpose byte encoding to Unicode interface:
3490 use the Encode extension for that.
3496 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3498 if (sv == &PL_sv_undef)
3502 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3503 (void) sv_2pv_flags(sv,&len, flags);
3507 (void) SvPV_force(sv,len);
3516 sv_force_normal_flags(sv, 0);
3519 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3520 sv_recode_to_utf8(sv, PL_encoding);
3521 else { /* Assume Latin-1/EBCDIC */
3522 /* This function could be much more efficient if we
3523 * had a FLAG in SVs to signal if there are any hibit
3524 * chars in the PV. Given that there isn't such a flag
3525 * make the loop as fast as possible. */
3526 const U8 *s = (U8 *) SvPVX_const(sv);
3527 const U8 *e = (U8 *) SvEND(sv);
3533 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3537 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3538 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3540 SvPV_free(sv); /* No longer using what was there before. */
3542 SvPV_set(sv, (char*)recoded);
3543 SvCUR_set(sv, len - 1);
3544 SvLEN_set(sv, len); /* No longer know the real size. */
3546 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3553 =for apidoc sv_utf8_downgrade
3555 Attempts to convert the PV of an SV from characters to bytes.
3556 If the PV contains a character beyond byte, this conversion will fail;
3557 in this case, either returns false or, if C<fail_ok> is not
3560 This is not as a general purpose Unicode to byte encoding interface:
3561 use the Encode extension for that.
3567 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3569 if (SvPOKp(sv) && SvUTF8(sv)) {
3575 sv_force_normal_flags(sv, 0);
3577 s = (U8 *) SvPV(sv, len);
3578 if (!utf8_to_bytes(s, &len)) {
3583 Perl_croak(aTHX_ "Wide character in %s",
3586 Perl_croak(aTHX_ "Wide character");
3597 =for apidoc sv_utf8_encode
3599 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3600 flag off so that it looks like octets again.
3606 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3608 (void) sv_utf8_upgrade(sv);
3610 sv_force_normal_flags(sv, 0);
3612 if (SvREADONLY(sv)) {
3613 Perl_croak(aTHX_ PL_no_modify);
3619 =for apidoc sv_utf8_decode
3621 If the PV of the SV is an octet sequence in UTF-8
3622 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3623 so that it looks like a character. If the PV contains only single-byte
3624 characters, the C<SvUTF8> flag stays being off.
3625 Scans PV for validity and returns false if the PV is invalid UTF-8.
3631 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3637 /* The octets may have got themselves encoded - get them back as
3640 if (!sv_utf8_downgrade(sv, TRUE))
3643 /* it is actually just a matter of turning the utf8 flag on, but
3644 * we want to make sure everything inside is valid utf8 first.
3646 c = (const U8 *) SvPVX_const(sv);
3647 if (!is_utf8_string(c, SvCUR(sv)+1))
3649 e = (const U8 *) SvEND(sv);
3652 if (!UTF8_IS_INVARIANT(ch)) {
3661 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3662 * this function provided for binary compatibility only
3666 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3668 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3672 =for apidoc sv_setsv
3674 Copies the contents of the source SV C<ssv> into the destination SV
3675 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3676 function if the source SV needs to be reused. Does not handle 'set' magic.
3677 Loosely speaking, it performs a copy-by-value, obliterating any previous
3678 content of the destination.
3680 You probably want to use one of the assortment of wrappers, such as
3681 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3682 C<SvSetMagicSV_nosteal>.
3684 =for apidoc sv_setsv_flags
3686 Copies the contents of the source SV C<ssv> into the destination SV
3687 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3688 function if the source SV needs to be reused. Does not handle 'set' magic.
3689 Loosely speaking, it performs a copy-by-value, obliterating any previous
3690 content of the destination.
3691 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3692 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3693 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3694 and C<sv_setsv_nomg> are implemented in terms of this function.
3696 You probably want to use one of the assortment of wrappers, such as
3697 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3698 C<SvSetMagicSV_nosteal>.
3700 This is the primary function for copying scalars, and most other
3701 copy-ish functions and macros use this underneath.
3707 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3709 register U32 sflags;
3715 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3717 sstr = &PL_sv_undef;
3718 stype = SvTYPE(sstr);
3719 dtype = SvTYPE(dstr);
3724 /* need to nuke the magic */
3726 SvRMAGICAL_off(dstr);
3729 /* There's a lot of redundancy below but we're going for speed here */
3734 if (dtype != SVt_PVGV) {
3735 (void)SvOK_off(dstr);
3743 sv_upgrade(dstr, SVt_IV);
3746 sv_upgrade(dstr, SVt_PVNV);
3750 sv_upgrade(dstr, SVt_PVIV);
3753 (void)SvIOK_only(dstr);
3754 SvIV_set(dstr, SvIVX(sstr));
3757 if (SvTAINTED(sstr))
3768 sv_upgrade(dstr, SVt_NV);
3773 sv_upgrade(dstr, SVt_PVNV);
3776 SvNV_set(dstr, SvNVX(sstr));
3777 (void)SvNOK_only(dstr);
3778 if (SvTAINTED(sstr))
3786 sv_upgrade(dstr, SVt_RV);
3787 else if (dtype == SVt_PVGV &&
3788 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3791 if (GvIMPORTED(dstr) != GVf_IMPORTED
3792 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3794 GvIMPORTED_on(dstr);
3803 #ifdef PERL_OLD_COPY_ON_WRITE
3804 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3805 if (dtype < SVt_PVIV)
3806 sv_upgrade(dstr, SVt_PVIV);
3813 sv_upgrade(dstr, SVt_PV);
3816 if (dtype < SVt_PVIV)
3817 sv_upgrade(dstr, SVt_PVIV);
3820 if (dtype < SVt_PVNV)
3821 sv_upgrade(dstr, SVt_PVNV);
3828 const char * const type = sv_reftype(sstr,0);
3830 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3832 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3837 if (dtype <= SVt_PVGV) {
3839 if (dtype != SVt_PVGV) {
3840 const char * const name = GvNAME(sstr);
3841 const STRLEN len = GvNAMELEN(sstr);
3842 /* don't upgrade SVt_PVLV: it can hold a glob */
3843 if (dtype != SVt_PVLV)
3844 sv_upgrade(dstr, SVt_PVGV);
3845 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3846 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3847 GvNAME(dstr) = savepvn(name, len);
3848 GvNAMELEN(dstr) = len;
3849 SvFAKE_on(dstr); /* can coerce to non-glob */
3851 /* ahem, death to those who redefine active sort subs */
3852 else if (PL_curstackinfo->si_type == PERLSI_SORT
3853 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3854 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3857 #ifdef GV_UNIQUE_CHECK
3858 if (GvUNIQUE((GV*)dstr)) {
3859 Perl_croak(aTHX_ PL_no_modify);
3863 (void)SvOK_off(dstr);
3864 GvINTRO_off(dstr); /* one-shot flag */
3866 GvGP(dstr) = gp_ref(GvGP(sstr));
3867 if (SvTAINTED(sstr))
3869 if (GvIMPORTED(dstr) != GVf_IMPORTED
3870 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3872 GvIMPORTED_on(dstr);
3880 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3882 if ((int)SvTYPE(sstr) != stype) {
3883 stype = SvTYPE(sstr);
3884 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3888 if (stype == SVt_PVLV)
3889 SvUPGRADE(dstr, SVt_PVNV);
3891 SvUPGRADE(dstr, (U32)stype);
3894 sflags = SvFLAGS(sstr);
3896 if (sflags & SVf_ROK) {
3897 if (dtype >= SVt_PV) {
3898 if (dtype == SVt_PVGV) {
3899 SV *sref = SvREFCNT_inc(SvRV(sstr));
3901 const int intro = GvINTRO(dstr);
3903 #ifdef GV_UNIQUE_CHECK
3904 if (GvUNIQUE((GV*)dstr)) {
3905 Perl_croak(aTHX_ PL_no_modify);
3910 GvINTRO_off(dstr); /* one-shot flag */
3911 GvLINE(dstr) = CopLINE(PL_curcop);
3912 GvEGV(dstr) = (GV*)dstr;
3915 switch (SvTYPE(sref)) {
3918 SAVEGENERICSV(GvAV(dstr));
3920 dref = (SV*)GvAV(dstr);
3921 GvAV(dstr) = (AV*)sref;
3922 if (!GvIMPORTED_AV(dstr)
3923 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3925 GvIMPORTED_AV_on(dstr);
3930 SAVEGENERICSV(GvHV(dstr));
3932 dref = (SV*)GvHV(dstr);
3933 GvHV(dstr) = (HV*)sref;
3934 if (!GvIMPORTED_HV(dstr)
3935 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3937 GvIMPORTED_HV_on(dstr);
3942 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3943 SvREFCNT_dec(GvCV(dstr));
3944 GvCV(dstr) = Nullcv;
3945 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3946 PL_sub_generation++;
3948 SAVEGENERICSV(GvCV(dstr));
3951 dref = (SV*)GvCV(dstr);
3952 if (GvCV(dstr) != (CV*)sref) {
3953 CV* cv = GvCV(dstr);
3955 if (!GvCVGEN((GV*)dstr) &&
3956 (CvROOT(cv) || CvXSUB(cv)))
3958 /* ahem, death to those who redefine
3959 * active sort subs */
3960 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3961 PL_sortcop == CvSTART(cv))
3963 "Can't redefine active sort subroutine %s",
3964 GvENAME((GV*)dstr));
3965 /* Redefining a sub - warning is mandatory if
3966 it was a const and its value changed. */
3967 if (ckWARN(WARN_REDEFINE)
3969 && (!CvCONST((CV*)sref)
3970 || sv_cmp(cv_const_sv(cv),
3971 cv_const_sv((CV*)sref)))))
3973 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3975 ? "Constant subroutine %s::%s redefined"
3976 : "Subroutine %s::%s redefined",
3977 HvNAME_get(GvSTASH((GV*)dstr)),
3978 GvENAME((GV*)dstr));
3982 cv_ckproto(cv, (GV*)dstr,
3984 ? SvPVX_const(sref) : Nullch);
3986 GvCV(dstr) = (CV*)sref;
3987 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3988 GvASSUMECV_on(dstr);
3989 PL_sub_generation++;
3991 if (!GvIMPORTED_CV(dstr)
3992 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3994 GvIMPORTED_CV_on(dstr);
3999 SAVEGENERICSV(GvIOp(dstr));
4001 dref = (SV*)GvIOp(dstr);
4002 GvIOp(dstr) = (IO*)sref;
4006 SAVEGENERICSV(GvFORM(dstr));
4008 dref = (SV*)GvFORM(dstr);
4009 GvFORM(dstr) = (CV*)sref;
4013 SAVEGENERICSV(GvSV(dstr));
4015 dref = (SV*)GvSV(dstr);
4017 if (!GvIMPORTED_SV(dstr)
4018 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4020 GvIMPORTED_SV_on(dstr);
4026 if (SvTAINTED(sstr))
4030 if (SvPVX_const(dstr)) {
4036 (void)SvOK_off(dstr);
4037 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4039 if (sflags & SVp_NOK) {
4041 /* Only set the public OK flag if the source has public OK. */
4042 if (sflags & SVf_NOK)
4043 SvFLAGS(dstr) |= SVf_NOK;
4044 SvNV_set(dstr, SvNVX(sstr));
4046 if (sflags & SVp_IOK) {
4047 (void)SvIOKp_on(dstr);
4048 if (sflags & SVf_IOK)
4049 SvFLAGS(dstr) |= SVf_IOK;
4050 if (sflags & SVf_IVisUV)
4052 SvIV_set(dstr, SvIVX(sstr));
4054 if (SvAMAGIC(sstr)) {
4058 else if (sflags & SVp_POK) {
4062 * Check to see if we can just swipe the string. If so, it's a
4063 * possible small lose on short strings, but a big win on long ones.
4064 * It might even be a win on short strings if SvPVX_const(dstr)
4065 * has to be allocated and SvPVX_const(sstr) has to be freed.
4068 /* Whichever path we take through the next code, we want this true,
4069 and doing it now facilitates the COW check. */
4070 (void)SvPOK_only(dstr);
4073 /* We're not already COW */
4074 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4075 #ifndef PERL_OLD_COPY_ON_WRITE
4076 /* or we are, but dstr isn't a suitable target. */
4077 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4082 (sflags & SVs_TEMP) && /* slated for free anyway? */
4083 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4084 (!(flags & SV_NOSTEAL)) &&
4085 /* and we're allowed to steal temps */
4086 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4087 SvLEN(sstr) && /* and really is a string */
4088 /* and won't be needed again, potentially */
4089 !(PL_op && PL_op->op_type == OP_AASSIGN))
4090 #ifdef PERL_OLD_COPY_ON_WRITE
4091 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4092 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4093 && SvTYPE(sstr) >= SVt_PVIV)
4096 /* Failed the swipe test, and it's not a shared hash key either.
4097 Have to copy the string. */
4098 STRLEN len = SvCUR(sstr);
4099 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4100 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4101 SvCUR_set(dstr, len);
4102 *SvEND(dstr) = '\0';
4104 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4106 /* Either it's a shared hash key, or it's suitable for
4107 copy-on-write or we can swipe the string. */
4109 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4113 #ifdef PERL_OLD_COPY_ON_WRITE
4115 /* I believe I should acquire a global SV mutex if
4116 it's a COW sv (not a shared hash key) to stop
4117 it going un copy-on-write.
4118 If the source SV has gone un copy on write between up there
4119 and down here, then (assert() that) it is of the correct
4120 form to make it copy on write again */
4121 if ((sflags & (SVf_FAKE | SVf_READONLY))
4122 != (SVf_FAKE | SVf_READONLY)) {
4123 SvREADONLY_on(sstr);
4125 /* Make the source SV into a loop of 1.
4126 (about to become 2) */
4127 SV_COW_NEXT_SV_SET(sstr, sstr);
4131 /* Initial code is common. */
4132 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4134 SvFLAGS(dstr) &= ~SVf_OOK;
4135 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4137 else if (SvLEN(dstr))
4138 Safefree(SvPVX_const(dstr));
4142 /* making another shared SV. */
4143 STRLEN cur = SvCUR(sstr);
4144 STRLEN len = SvLEN(sstr);
4145 #ifdef PERL_OLD_COPY_ON_WRITE
4147 assert (SvTYPE(dstr) >= SVt_PVIV);
4148 /* SvIsCOW_normal */
4149 /* splice us in between source and next-after-source. */
4150 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4151 SV_COW_NEXT_SV_SET(sstr, dstr);
4152 SvPV_set(dstr, SvPVX_mutable(sstr));
4156 /* SvIsCOW_shared_hash */
4157 DEBUG_C(PerlIO_printf(Perl_debug_log,
4158 "Copy on write: Sharing hash\n"));
4160 assert (SvTYPE(dstr) >= SVt_PV);
4162 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4164 SvLEN_set(dstr, len);
4165 SvCUR_set(dstr, cur);
4166 SvREADONLY_on(dstr);
4168 /* Relesase a global SV mutex. */
4171 { /* Passes the swipe test. */
4172 SvPV_set(dstr, SvPVX_mutable(sstr));
4173 SvLEN_set(dstr, SvLEN(sstr));
4174 SvCUR_set(dstr, SvCUR(sstr));
4177 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4178 SvPV_set(sstr, Nullch);
4184 if (sflags & SVf_UTF8)
4186 if (sflags & SVp_NOK) {
4188 if (sflags & SVf_NOK)
4189 SvFLAGS(dstr) |= SVf_NOK;
4190 SvNV_set(dstr, SvNVX(sstr));
4192 if (sflags & SVp_IOK) {
4193 (void)SvIOKp_on(dstr);
4194 if (sflags & SVf_IOK)
4195 SvFLAGS(dstr) |= SVf_IOK;
4196 if (sflags & SVf_IVisUV)
4198 SvIV_set(dstr, SvIVX(sstr));
4201 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4202 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4203 smg->mg_ptr, smg->mg_len);
4204 SvRMAGICAL_on(dstr);
4207 else if (sflags & SVp_IOK) {
4208 if (sflags & SVf_IOK)
4209 (void)SvIOK_only(dstr);
4211 (void)SvOK_off(dstr);
4212 (void)SvIOKp_on(dstr);
4214 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4215 if (sflags & SVf_IVisUV)
4217 SvIV_set(dstr, SvIVX(sstr));
4218 if (sflags & SVp_NOK) {
4219 if (sflags & SVf_NOK)
4220 (void)SvNOK_on(dstr);
4222 (void)SvNOKp_on(dstr);
4223 SvNV_set(dstr, SvNVX(sstr));
4226 else if (sflags & SVp_NOK) {
4227 if (sflags & SVf_NOK)
4228 (void)SvNOK_only(dstr);
4230 (void)SvOK_off(dstr);
4233 SvNV_set(dstr, SvNVX(sstr));
4236 if (dtype == SVt_PVGV) {
4237 if (ckWARN(WARN_MISC))
4238 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4241 (void)SvOK_off(dstr);
4243 if (SvTAINTED(sstr))
4248 =for apidoc sv_setsv_mg
4250 Like C<sv_setsv>, but also handles 'set' magic.
4256 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4258 sv_setsv(dstr,sstr);
4262 #ifdef PERL_OLD_COPY_ON_WRITE
4264 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4266 STRLEN cur = SvCUR(sstr);
4267 STRLEN len = SvLEN(sstr);
4268 register char *new_pv;
4271 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4279 if (SvTHINKFIRST(dstr))
4280 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4281 else if (SvPVX_const(dstr))
4282 Safefree(SvPVX_const(dstr));
4286 SvUPGRADE(dstr, SVt_PVIV);
4288 assert (SvPOK(sstr));
4289 assert (SvPOKp(sstr));
4290 assert (!SvIOK(sstr));
4291 assert (!SvIOKp(sstr));
4292 assert (!SvNOK(sstr));
4293 assert (!SvNOKp(sstr));
4295 if (SvIsCOW(sstr)) {
4297 if (SvLEN(sstr) == 0) {
4298 /* source is a COW shared hash key. */
4299 DEBUG_C(PerlIO_printf(Perl_debug_log,
4300 "Fast copy on write: Sharing hash\n"));
4301 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4304 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4306 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4307 SvUPGRADE(sstr, SVt_PVIV);
4308 SvREADONLY_on(sstr);
4310 DEBUG_C(PerlIO_printf(Perl_debug_log,
4311 "Fast copy on write: Converting sstr to COW\n"));
4312 SV_COW_NEXT_SV_SET(dstr, sstr);
4314 SV_COW_NEXT_SV_SET(sstr, dstr);
4315 new_pv = SvPVX_mutable(sstr);
4318 SvPV_set(dstr, new_pv);
4319 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4322 SvLEN_set(dstr, len);
4323 SvCUR_set(dstr, cur);
4332 =for apidoc sv_setpvn
4334 Copies a string into an SV. The C<len> parameter indicates the number of
4335 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4336 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4342 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4344 register char *dptr;
4346 SV_CHECK_THINKFIRST_COW_DROP(sv);
4352 /* len is STRLEN which is unsigned, need to copy to signed */
4355 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4357 SvUPGRADE(sv, SVt_PV);
4359 dptr = SvGROW(sv, len + 1);
4360 Move(ptr,dptr,len,char);
4363 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4368 =for apidoc sv_setpvn_mg
4370 Like C<sv_setpvn>, but also handles 'set' magic.
4376 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4378 sv_setpvn(sv,ptr,len);
4383 =for apidoc sv_setpv
4385 Copies a string into an SV. The string must be null-terminated. Does not
4386 handle 'set' magic. See C<sv_setpv_mg>.
4392 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4394 register STRLEN len;
4396 SV_CHECK_THINKFIRST_COW_DROP(sv);
4402 SvUPGRADE(sv, SVt_PV);
4404 SvGROW(sv, len + 1);
4405 Move(ptr,SvPVX(sv),len+1,char);
4407 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4412 =for apidoc sv_setpv_mg
4414 Like C<sv_setpv>, but also handles 'set' magic.
4420 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4427 =for apidoc sv_usepvn
4429 Tells an SV to use C<ptr> to find its string value. Normally the string is
4430 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4431 The C<ptr> should point to memory that was allocated by C<malloc>. The
4432 string length, C<len>, must be supplied. This function will realloc the
4433 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4434 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4435 See C<sv_usepvn_mg>.
4441 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4444 SV_CHECK_THINKFIRST_COW_DROP(sv);
4445 SvUPGRADE(sv, SVt_PV);
4450 if (SvPVX_const(sv))
4453 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4454 ptr = saferealloc (ptr, allocate);
4457 SvLEN_set(sv, allocate);
4459 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4464 =for apidoc sv_usepvn_mg
4466 Like C<sv_usepvn>, but also handles 'set' magic.
4472 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4474 sv_usepvn(sv,ptr,len);
4478 #ifdef PERL_OLD_COPY_ON_WRITE
4479 /* Need to do this *after* making the SV normal, as we need the buffer
4480 pointer to remain valid until after we've copied it. If we let go too early,
4481 another thread could invalidate it by unsharing last of the same hash key
4482 (which it can do by means other than releasing copy-on-write Svs)
4483 or by changing the other copy-on-write SVs in the loop. */
4485 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4487 if (len) { /* this SV was SvIsCOW_normal(sv) */
4488 /* we need to find the SV pointing to us. */
4489 SV *current = SV_COW_NEXT_SV(after);
4491 if (current == sv) {
4492 /* The SV we point to points back to us (there were only two of us
4494 Hence other SV is no longer copy on write either. */
4496 SvREADONLY_off(after);
4498 /* We need to follow the pointers around the loop. */
4500 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4503 /* don't loop forever if the structure is bust, and we have
4504 a pointer into a closed loop. */
4505 assert (current != after);
4506 assert (SvPVX_const(current) == pvx);
4508 /* Make the SV before us point to the SV after us. */
4509 SV_COW_NEXT_SV_SET(current, after);
4512 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4517 Perl_sv_release_IVX(pTHX_ register SV *sv)
4520 sv_force_normal_flags(sv, 0);
4526 =for apidoc sv_force_normal_flags
4528 Undo various types of fakery on an SV: if the PV is a shared string, make
4529 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4530 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4531 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4532 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4533 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4534 set to some other value.) In addition, the C<flags> parameter gets passed to
4535 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4536 with flags set to 0.
4542 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4544 #ifdef PERL_OLD_COPY_ON_WRITE
4545 if (SvREADONLY(sv)) {
4546 /* At this point I believe I should acquire a global SV mutex. */
4548 const char *pvx = SvPVX_const(sv);
4549 const STRLEN len = SvLEN(sv);
4550 const STRLEN cur = SvCUR(sv);
4551 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4553 PerlIO_printf(Perl_debug_log,
4554 "Copy on write: Force normal %ld\n",
4560 /* This SV doesn't own the buffer, so need to New() a new one: */
4561 SvPV_set(sv, (char*)0);
4563 if (flags & SV_COW_DROP_PV) {
4564 /* OK, so we don't need to copy our buffer. */
4567 SvGROW(sv, cur + 1);
4568 Move(pvx,SvPVX(sv),cur,char);
4572 sv_release_COW(sv, pvx, len, next);
4577 else if (IN_PERL_RUNTIME)
4578 Perl_croak(aTHX_ PL_no_modify);
4579 /* At this point I believe that I can drop the global SV mutex. */
4582 if (SvREADONLY(sv)) {
4584 const char *pvx = SvPVX_const(sv);
4585 const STRLEN len = SvCUR(sv);
4588 SvPV_set(sv, Nullch);
4590 SvGROW(sv, len + 1);
4591 Move(pvx,SvPVX_const(sv),len,char);
4593 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4595 else if (IN_PERL_RUNTIME)
4596 Perl_croak(aTHX_ PL_no_modify);
4600 sv_unref_flags(sv, flags);
4601 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4606 =for apidoc sv_force_normal
4608 Undo various types of fakery on an SV: if the PV is a shared string, make
4609 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4610 an xpvmg. See also C<sv_force_normal_flags>.
4616 Perl_sv_force_normal(pTHX_ register SV *sv)
4618 sv_force_normal_flags(sv, 0);
4624 Efficient removal of characters from the beginning of the string buffer.
4625 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4626 the string buffer. The C<ptr> becomes the first character of the adjusted
4627 string. Uses the "OOK hack".
4628 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4629 refer to the same chunk of data.
4635 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4637 register STRLEN delta;
4638 if (!ptr || !SvPOKp(sv))
4640 delta = ptr - SvPVX_const(sv);
4641 SV_CHECK_THINKFIRST(sv);
4642 if (SvTYPE(sv) < SVt_PVIV)
4643 sv_upgrade(sv,SVt_PVIV);
4646 if (!SvLEN(sv)) { /* make copy of shared string */
4647 const char *pvx = SvPVX_const(sv);
4648 const STRLEN len = SvCUR(sv);
4649 SvGROW(sv, len + 1);
4650 Move(pvx,SvPVX_const(sv),len,char);
4654 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4655 and we do that anyway inside the SvNIOK_off
4657 SvFLAGS(sv) |= SVf_OOK;
4660 SvLEN_set(sv, SvLEN(sv) - delta);
4661 SvCUR_set(sv, SvCUR(sv) - delta);
4662 SvPV_set(sv, SvPVX(sv) + delta);
4663 SvIV_set(sv, SvIVX(sv) + delta);
4666 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4667 * this function provided for binary compatibility only
4671 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4673 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4677 =for apidoc sv_catpvn
4679 Concatenates the string onto the end of the string which is in the SV. The
4680 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4681 status set, then the bytes appended should be valid UTF-8.
4682 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4684 =for apidoc sv_catpvn_flags
4686 Concatenates the string onto the end of the string which is in the SV. The
4687 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4688 status set, then the bytes appended should be valid UTF-8.
4689 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4690 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4691 in terms of this function.
4697 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4700 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4702 SvGROW(dsv, dlen + slen + 1);
4704 sstr = SvPVX_const(dsv);
4705 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4706 SvCUR_set(dsv, SvCUR(dsv) + slen);
4708 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4713 =for apidoc sv_catpvn_mg
4715 Like C<sv_catpvn>, but also handles 'set' magic.
4721 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4723 sv_catpvn(sv,ptr,len);
4727 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4728 * this function provided for binary compatibility only
4732 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4734 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4738 =for apidoc sv_catsv
4740 Concatenates the string from SV C<ssv> onto the end of the string in
4741 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4742 not 'set' magic. See C<sv_catsv_mg>.
4744 =for apidoc sv_catsv_flags
4746 Concatenates the string from SV C<ssv> onto the end of the string in
4747 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4748 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4749 and C<sv_catsv_nomg> are implemented in terms of this function.
4754 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4760 if ((spv = SvPV_const(ssv, slen))) {
4761 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4762 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4763 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4764 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4765 dsv->sv_flags doesn't have that bit set.
4766 Andy Dougherty 12 Oct 2001
4768 const I32 sutf8 = DO_UTF8(ssv);
4771 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4773 dutf8 = DO_UTF8(dsv);
4775 if (dutf8 != sutf8) {
4777 /* Not modifying source SV, so taking a temporary copy. */
4778 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4780 sv_utf8_upgrade(csv);
4781 spv = SvPV_const(csv, slen);
4784 sv_utf8_upgrade_nomg(dsv);
4786 sv_catpvn_nomg(dsv, spv, slen);
4791 =for apidoc sv_catsv_mg
4793 Like C<sv_catsv>, but also handles 'set' magic.
4799 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4806 =for apidoc sv_catpv
4808 Concatenates the string onto the end of the string which is in the SV.
4809 If the SV has the UTF-8 status set, then the bytes appended should be
4810 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4815 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4817 register STRLEN len;
4823 junk = SvPV_force(sv, tlen);
4825 SvGROW(sv, tlen + len + 1);
4827 ptr = SvPVX_const(sv);
4828 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4829 SvCUR_set(sv, SvCUR(sv) + len);
4830 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4835 =for apidoc sv_catpv_mg
4837 Like C<sv_catpv>, but also handles 'set' magic.
4843 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4852 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4853 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4860 Perl_newSV(pTHX_ STRLEN len)
4866 sv_upgrade(sv, SVt_PV);
4867 SvGROW(sv, len + 1);
4872 =for apidoc sv_magicext
4874 Adds magic to an SV, upgrading it if necessary. Applies the
4875 supplied vtable and returns a pointer to the magic added.
4877 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4878 In particular, you can add magic to SvREADONLY SVs, and add more than
4879 one instance of the same 'how'.
4881 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4882 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4883 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4884 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4886 (This is now used as a subroutine by C<sv_magic>.)
4891 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4892 const char* name, I32 namlen)
4896 if (SvTYPE(sv) < SVt_PVMG) {
4897 SvUPGRADE(sv, SVt_PVMG);
4899 Newz(702,mg, 1, MAGIC);
4900 mg->mg_moremagic = SvMAGIC(sv);
4901 SvMAGIC_set(sv, mg);
4903 /* Sometimes a magic contains a reference loop, where the sv and
4904 object refer to each other. To prevent a reference loop that
4905 would prevent such objects being freed, we look for such loops
4906 and if we find one we avoid incrementing the object refcount.
4908 Note we cannot do this to avoid self-tie loops as intervening RV must
4909 have its REFCNT incremented to keep it in existence.
4912 if (!obj || obj == sv ||
4913 how == PERL_MAGIC_arylen ||
4914 how == PERL_MAGIC_qr ||
4915 how == PERL_MAGIC_symtab ||
4916 (SvTYPE(obj) == SVt_PVGV &&
4917 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4918 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4919 GvFORM(obj) == (CV*)sv)))
4924 mg->mg_obj = SvREFCNT_inc(obj);
4925 mg->mg_flags |= MGf_REFCOUNTED;
4928 /* Normal self-ties simply pass a null object, and instead of
4929 using mg_obj directly, use the SvTIED_obj macro to produce a
4930 new RV as needed. For glob "self-ties", we are tieing the PVIO
4931 with an RV obj pointing to the glob containing the PVIO. In
4932 this case, to avoid a reference loop, we need to weaken the
4936 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4937 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4943 mg->mg_len = namlen;
4946 mg->mg_ptr = savepvn(name, namlen);
4947 else if (namlen == HEf_SVKEY)
4948 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4950 mg->mg_ptr = (char *) name;
4952 mg->mg_virtual = vtable;
4956 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4961 =for apidoc sv_magic
4963 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4964 then adds a new magic item of type C<how> to the head of the magic list.
4966 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4967 handling of the C<name> and C<namlen> arguments.
4969 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4970 to add more than one instance of the same 'how'.
4976 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4978 const MGVTBL *vtable = 0;
4981 #ifdef PERL_OLD_COPY_ON_WRITE
4983 sv_force_normal_flags(sv, 0);
4985 if (SvREADONLY(sv)) {
4987 && how != PERL_MAGIC_regex_global
4988 && how != PERL_MAGIC_bm
4989 && how != PERL_MAGIC_fm
4990 && how != PERL_MAGIC_sv
4991 && how != PERL_MAGIC_backref
4994 Perl_croak(aTHX_ PL_no_modify);
4997 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4998 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4999 /* sv_magic() refuses to add a magic of the same 'how' as an
5002 if (how == PERL_MAGIC_taint)
5010 vtable = &PL_vtbl_sv;
5012 case PERL_MAGIC_overload:
5013 vtable = &PL_vtbl_amagic;
5015 case PERL_MAGIC_overload_elem:
5016 vtable = &PL_vtbl_amagicelem;
5018 case PERL_MAGIC_overload_table:
5019 vtable = &PL_vtbl_ovrld;
5022 vtable = &PL_vtbl_bm;
5024 case PERL_MAGIC_regdata:
5025 vtable = &PL_vtbl_regdata;
5027 case PERL_MAGIC_regdatum:
5028 vtable = &PL_vtbl_regdatum;
5030 case PERL_MAGIC_env:
5031 vtable = &PL_vtbl_env;
5034 vtable = &PL_vtbl_fm;
5036 case PERL_MAGIC_envelem:
5037 vtable = &PL_vtbl_envelem;
5039 case PERL_MAGIC_regex_global:
5040 vtable = &PL_vtbl_mglob;
5042 case PERL_MAGIC_isa:
5043 vtable = &PL_vtbl_isa;
5045 case PERL_MAGIC_isaelem:
5046 vtable = &PL_vtbl_isaelem;
5048 case PERL_MAGIC_nkeys:
5049 vtable = &PL_vtbl_nkeys;
5051 case PERL_MAGIC_dbfile:
5054 case PERL_MAGIC_dbline:
5055 vtable = &PL_vtbl_dbline;
5057 #ifdef USE_LOCALE_COLLATE
5058 case PERL_MAGIC_collxfrm:
5059 vtable = &PL_vtbl_collxfrm;
5061 #endif /* USE_LOCALE_COLLATE */
5062 case PERL_MAGIC_tied:
5063 vtable = &PL_vtbl_pack;
5065 case PERL_MAGIC_tiedelem:
5066 case PERL_MAGIC_tiedscalar:
5067 vtable = &PL_vtbl_packelem;
5070 vtable = &PL_vtbl_regexp;
5072 case PERL_MAGIC_sig:
5073 vtable = &PL_vtbl_sig;
5075 case PERL_MAGIC_sigelem:
5076 vtable = &PL_vtbl_sigelem;
5078 case PERL_MAGIC_taint:
5079 vtable = &PL_vtbl_taint;
5081 case PERL_MAGIC_uvar:
5082 vtable = &PL_vtbl_uvar;
5084 case PERL_MAGIC_vec:
5085 vtable = &PL_vtbl_vec;
5087 case PERL_MAGIC_arylen_p:
5088 case PERL_MAGIC_rhash:
5089 case PERL_MAGIC_symtab:
5090 case PERL_MAGIC_vstring:
5093 case PERL_MAGIC_utf8:
5094 vtable = &PL_vtbl_utf8;
5096 case PERL_MAGIC_substr:
5097 vtable = &PL_vtbl_substr;
5099 case PERL_MAGIC_defelem:
5100 vtable = &PL_vtbl_defelem;
5102 case PERL_MAGIC_glob:
5103 vtable = &PL_vtbl_glob;
5105 case PERL_MAGIC_arylen:
5106 vtable = &PL_vtbl_arylen;
5108 case PERL_MAGIC_pos:
5109 vtable = &PL_vtbl_pos;
5111 case PERL_MAGIC_backref:
5112 vtable = &PL_vtbl_backref;
5114 case PERL_MAGIC_ext:
5115 /* Reserved for use by extensions not perl internals. */
5116 /* Useful for attaching extension internal data to perl vars. */
5117 /* Note that multiple extensions may clash if magical scalars */
5118 /* etc holding private data from one are passed to another. */
5121 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5124 /* Rest of work is done else where */
5125 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5128 case PERL_MAGIC_taint:
5131 case PERL_MAGIC_ext:
5132 case PERL_MAGIC_dbfile:
5139 =for apidoc sv_unmagic
5141 Removes all magic of type C<type> from an SV.
5147 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5151 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5154 for (mg = *mgp; mg; mg = *mgp) {
5155 if (mg->mg_type == type) {
5156 const MGVTBL* const vtbl = mg->mg_virtual;
5157 *mgp = mg->mg_moremagic;
5158 if (vtbl && vtbl->svt_free)
5159 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5160 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5162 Safefree(mg->mg_ptr);
5163 else if (mg->mg_len == HEf_SVKEY)
5164 SvREFCNT_dec((SV*)mg->mg_ptr);
5165 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5166 Safefree(mg->mg_ptr);
5168 if (mg->mg_flags & MGf_REFCOUNTED)
5169 SvREFCNT_dec(mg->mg_obj);
5173 mgp = &mg->mg_moremagic;
5177 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5184 =for apidoc sv_rvweaken
5186 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5187 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5188 push a back-reference to this RV onto the array of backreferences
5189 associated with that magic.
5195 Perl_sv_rvweaken(pTHX_ SV *sv)
5198 if (!SvOK(sv)) /* let undefs pass */
5201 Perl_croak(aTHX_ "Can't weaken a nonreference");
5202 else if (SvWEAKREF(sv)) {
5203 if (ckWARN(WARN_MISC))
5204 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5208 sv_add_backref(tsv, sv);
5214 /* Give tsv backref magic if it hasn't already got it, then push a
5215 * back-reference to sv onto the array associated with the backref magic.
5219 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5223 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5224 av = (AV*)mg->mg_obj;
5227 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5228 /* av now has a refcnt of 2, which avoids it getting freed
5229 * before us during global cleanup. The extra ref is removed
5230 * by magic_killbackrefs() when tsv is being freed */
5232 if (AvFILLp(av) >= AvMAX(av)) {
5233 av_extend(av, AvFILLp(av)+1);
5235 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5238 /* delete a back-reference to ourselves from the backref magic associated
5239 * with the SV we point to.
5243 S_sv_del_backref(pTHX_ SV *sv)
5250 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5251 Perl_croak(aTHX_ "panic: del_backref");
5252 av = (AV *)mg->mg_obj;
5254 /* We shouldn't be in here more than once, but for paranoia reasons lets
5256 for (i = AvFILLp(av); i >= 0; i--) {
5258 const SSize_t fill = AvFILLp(av);
5260 /* We weren't the last entry.
5261 An unordered list has this property that you can take the
5262 last element off the end to fill the hole, and it's still
5263 an unordered list :-)
5268 AvFILLp(av) = fill - 1;
5274 =for apidoc sv_insert
5276 Inserts a string at the specified offset/length within the SV. Similar to
5277 the Perl substr() function.
5283 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5287 register char *midend;
5288 register char *bigend;
5294 Perl_croak(aTHX_ "Can't modify non-existent substring");
5295 SvPV_force(bigstr, curlen);
5296 (void)SvPOK_only_UTF8(bigstr);
5297 if (offset + len > curlen) {
5298 SvGROW(bigstr, offset+len+1);
5299 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5300 SvCUR_set(bigstr, offset+len);
5304 i = littlelen - len;
5305 if (i > 0) { /* string might grow */
5306 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5307 mid = big + offset + len;
5308 midend = bigend = big + SvCUR(bigstr);
5311 while (midend > mid) /* shove everything down */
5312 *--bigend = *--midend;
5313 Move(little,big+offset,littlelen,char);
5314 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5319 Move(little,SvPVX(bigstr)+offset,len,char);
5324 big = SvPVX(bigstr);
5327 bigend = big + SvCUR(bigstr);
5329 if (midend > bigend)
5330 Perl_croak(aTHX_ "panic: sv_insert");
5332 if (mid - big > bigend - midend) { /* faster to shorten from end */
5334 Move(little, mid, littlelen,char);
5337 i = bigend - midend;
5339 Move(midend, mid, i,char);
5343 SvCUR_set(bigstr, mid - big);
5345 else if ((i = mid - big)) { /* faster from front */
5346 midend -= littlelen;
5348 sv_chop(bigstr,midend-i);
5353 Move(little, mid, littlelen,char);
5355 else if (littlelen) {
5356 midend -= littlelen;
5357 sv_chop(bigstr,midend);
5358 Move(little,midend,littlelen,char);
5361 sv_chop(bigstr,midend);
5367 =for apidoc sv_replace
5369 Make the first argument a copy of the second, then delete the original.
5370 The target SV physically takes over ownership of the body of the source SV
5371 and inherits its flags; however, the target keeps any magic it owns,
5372 and any magic in the source is discarded.
5373 Note that this is a rather specialist SV copying operation; most of the
5374 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5380 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5382 const U32 refcnt = SvREFCNT(sv);
5383 SV_CHECK_THINKFIRST_COW_DROP(sv);
5384 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5385 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5386 if (SvMAGICAL(sv)) {
5390 sv_upgrade(nsv, SVt_PVMG);
5391 SvMAGIC_set(nsv, SvMAGIC(sv));
5392 SvFLAGS(nsv) |= SvMAGICAL(sv);
5394 SvMAGIC_set(sv, NULL);
5398 assert(!SvREFCNT(sv));
5399 #ifdef DEBUG_LEAKING_SCALARS
5400 sv->sv_flags = nsv->sv_flags;
5401 sv->sv_any = nsv->sv_any;
5402 sv->sv_refcnt = nsv->sv_refcnt;
5403 sv->sv_u = nsv->sv_u;
5405 StructCopy(nsv,sv,SV);
5407 /* Currently could join these into one piece of pointer arithmetic, but
5408 it would be unclear. */
5409 if(SvTYPE(sv) == SVt_IV)
5411 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5412 else if (SvTYPE(sv) == SVt_RV) {
5413 SvANY(sv) = &sv->sv_u.svu_rv;
5417 #ifdef PERL_OLD_COPY_ON_WRITE
5418 if (SvIsCOW_normal(nsv)) {
5419 /* We need to follow the pointers around the loop to make the
5420 previous SV point to sv, rather than nsv. */
5423 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5426 assert(SvPVX_const(current) == SvPVX_const(nsv));
5428 /* Make the SV before us point to the SV after us. */
5430 PerlIO_printf(Perl_debug_log, "previous is\n");
5432 PerlIO_printf(Perl_debug_log,
5433 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5434 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5436 SV_COW_NEXT_SV_SET(current, sv);
5439 SvREFCNT(sv) = refcnt;
5440 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5446 =for apidoc sv_clear
5448 Clear an SV: call any destructors, free up any memory used by the body,
5449 and free the body itself. The SV's head is I<not> freed, although
5450 its type is set to all 1's so that it won't inadvertently be assumed
5451 to be live during global destruction etc.
5452 This function should only be called when REFCNT is zero. Most of the time
5453 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5460 Perl_sv_clear(pTHX_ register SV *sv)
5465 assert(SvREFCNT(sv) == 0);
5468 if (PL_defstash) { /* Still have a symbol table? */
5472 stash = SvSTASH(sv);
5473 destructor = StashHANDLER(stash,DESTROY);
5475 SV* tmpref = newRV(sv);
5476 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5478 PUSHSTACKi(PERLSI_DESTROY);
5483 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5489 if(SvREFCNT(tmpref) < 2) {
5490 /* tmpref is not kept alive! */
5492 SvRV_set(tmpref, NULL);
5495 SvREFCNT_dec(tmpref);
5497 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5501 if (PL_in_clean_objs)
5502 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5504 /* DESTROY gave object new lease on life */
5510 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5511 SvOBJECT_off(sv); /* Curse the object. */
5512 if (SvTYPE(sv) != SVt_PVIO)
5513 --PL_sv_objcount; /* XXX Might want something more general */
5516 if (SvTYPE(sv) >= SVt_PVMG) {
5519 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5520 SvREFCNT_dec(SvSTASH(sv));
5523 switch (SvTYPE(sv)) {
5526 IoIFP(sv) != PerlIO_stdin() &&
5527 IoIFP(sv) != PerlIO_stdout() &&
5528 IoIFP(sv) != PerlIO_stderr())
5530 io_close((IO*)sv, FALSE);
5532 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5533 PerlDir_close(IoDIRP(sv));
5534 IoDIRP(sv) = (DIR*)NULL;
5535 Safefree(IoTOP_NAME(sv));
5536 Safefree(IoFMT_NAME(sv));
5537 Safefree(IoBOTTOM_NAME(sv));
5552 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5553 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5554 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5555 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5557 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5558 SvREFCNT_dec(LvTARG(sv));
5562 Safefree(GvNAME(sv));
5563 /* cannot decrease stash refcount yet, as we might recursively delete
5564 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5565 of stash until current sv is completely gone.
5566 -- JohnPC, 27 Mar 1998 */
5567 stash = GvSTASH(sv);
5573 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5575 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5576 /* Don't even bother with turning off the OOK flag. */
5585 SvREFCNT_dec(SvRV(sv));
5587 #ifdef PERL_OLD_COPY_ON_WRITE
5588 else if (SvPVX_const(sv)) {
5590 /* I believe I need to grab the global SV mutex here and
5591 then recheck the COW status. */
5593 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5596 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5597 SV_COW_NEXT_SV(sv));
5598 /* And drop it here. */
5600 } else if (SvLEN(sv)) {
5601 Safefree(SvPVX_const(sv));
5605 else if (SvPVX_const(sv) && SvLEN(sv))
5606 Safefree(SvPVX_const(sv));
5607 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5608 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5621 switch (SvTYPE(sv)) {
5635 del_XPVIV(SvANY(sv));
5638 del_XPVNV(SvANY(sv));
5641 del_XPVMG(SvANY(sv));
5644 del_XPVLV(SvANY(sv));
5647 del_XPVAV(SvANY(sv));
5650 del_XPVHV(SvANY(sv));
5653 del_XPVCV(SvANY(sv));
5656 del_XPVGV(SvANY(sv));
5657 /* code duplication for increased performance. */
5658 SvFLAGS(sv) &= SVf_BREAK;
5659 SvFLAGS(sv) |= SVTYPEMASK;
5660 /* decrease refcount of the stash that owns this GV, if any */
5662 SvREFCNT_dec(stash);
5663 return; /* not break, SvFLAGS reset already happened */
5665 del_XPVBM(SvANY(sv));
5668 del_XPVFM(SvANY(sv));
5671 del_XPVIO(SvANY(sv));
5674 SvFLAGS(sv) &= SVf_BREAK;
5675 SvFLAGS(sv) |= SVTYPEMASK;
5679 =for apidoc sv_newref
5681 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5688 Perl_sv_newref(pTHX_ SV *sv)
5698 Decrement an SV's reference count, and if it drops to zero, call
5699 C<sv_clear> to invoke destructors and free up any memory used by
5700 the body; finally, deallocate the SV's head itself.
5701 Normally called via a wrapper macro C<SvREFCNT_dec>.
5707 Perl_sv_free(pTHX_ SV *sv)
5712 if (SvREFCNT(sv) == 0) {
5713 if (SvFLAGS(sv) & SVf_BREAK)
5714 /* this SV's refcnt has been artificially decremented to
5715 * trigger cleanup */
5717 if (PL_in_clean_all) /* All is fair */
5719 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5720 /* make sure SvREFCNT(sv)==0 happens very seldom */
5721 SvREFCNT(sv) = (~(U32)0)/2;
5724 if (ckWARN_d(WARN_INTERNAL))
5725 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5726 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5727 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5730 if (--(SvREFCNT(sv)) > 0)
5732 Perl_sv_free2(aTHX_ sv);
5736 Perl_sv_free2(pTHX_ SV *sv)
5741 if (ckWARN_d(WARN_DEBUGGING))
5742 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5743 "Attempt to free temp prematurely: SV 0x%"UVxf
5744 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5748 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5749 /* make sure SvREFCNT(sv)==0 happens very seldom */
5750 SvREFCNT(sv) = (~(U32)0)/2;
5761 Returns the length of the string in the SV. Handles magic and type
5762 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5768 Perl_sv_len(pTHX_ register SV *sv)
5776 len = mg_length(sv);
5778 (void)SvPV_const(sv, len);
5783 =for apidoc sv_len_utf8
5785 Returns the number of characters in the string in an SV, counting wide
5786 UTF-8 bytes as a single character. Handles magic and type coercion.
5792 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5793 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5794 * (Note that the mg_len is not the length of the mg_ptr field.)
5799 Perl_sv_len_utf8(pTHX_ register SV *sv)
5805 return mg_length(sv);
5809 const U8 *s = (U8*)SvPV_const(sv, len);
5810 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5812 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5814 #ifdef PERL_UTF8_CACHE_ASSERT
5815 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5819 ulen = Perl_utf8_length(aTHX_ s, s + len);
5820 if (!mg && !SvREADONLY(sv)) {
5821 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5822 mg = mg_find(sv, PERL_MAGIC_utf8);
5832 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5833 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5834 * between UTF-8 and byte offsets. There are two (substr offset and substr
5835 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5836 * and byte offset) cache positions.
5838 * The mg_len field is used by sv_len_utf8(), see its comments.
5839 * Note that the mg_len is not the length of the mg_ptr field.
5843 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5844 I32 offsetp, const U8 *s, const U8 *start)
5848 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5850 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5854 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5856 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5857 (*mgp)->mg_ptr = (char *) *cachep;
5861 (*cachep)[i] = offsetp;
5862 (*cachep)[i+1] = s - start;
5870 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5871 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5872 * between UTF-8 and byte offsets. See also the comments of
5873 * S_utf8_mg_pos_init().
5877 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)
5881 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5883 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5884 if (*mgp && (*mgp)->mg_ptr) {
5885 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5886 ASSERT_UTF8_CACHE(*cachep);
5887 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5889 else { /* We will skip to the right spot. */
5894 /* The assumption is that going backward is half
5895 * the speed of going forward (that's where the
5896 * 2 * backw in the below comes from). (The real
5897 * figure of course depends on the UTF-8 data.) */
5899 if ((*cachep)[i] > (STRLEN)uoff) {
5901 backw = (*cachep)[i] - (STRLEN)uoff;
5903 if (forw < 2 * backw)
5906 p = start + (*cachep)[i+1];
5908 /* Try this only for the substr offset (i == 0),
5909 * not for the substr length (i == 2). */
5910 else if (i == 0) { /* (*cachep)[i] < uoff */
5911 const STRLEN ulen = sv_len_utf8(sv);
5913 if ((STRLEN)uoff < ulen) {
5914 forw = (STRLEN)uoff - (*cachep)[i];
5915 backw = ulen - (STRLEN)uoff;
5917 if (forw < 2 * backw)
5918 p = start + (*cachep)[i+1];
5923 /* If the string is not long enough for uoff,
5924 * we could extend it, but not at this low a level. */
5928 if (forw < 2 * backw) {
5935 while (UTF8_IS_CONTINUATION(*p))
5940 /* Update the cache. */
5941 (*cachep)[i] = (STRLEN)uoff;
5942 (*cachep)[i+1] = p - start;
5944 /* Drop the stale "length" cache */
5953 if (found) { /* Setup the return values. */
5954 *offsetp = (*cachep)[i+1];
5955 *sp = start + *offsetp;
5958 *offsetp = send - start;
5960 else if (*sp < start) {
5966 #ifdef PERL_UTF8_CACHE_ASSERT
5971 while (n-- && s < send)
5975 assert(*offsetp == s - start);
5976 assert((*cachep)[0] == (STRLEN)uoff);
5977 assert((*cachep)[1] == *offsetp);
5979 ASSERT_UTF8_CACHE(*cachep);
5988 =for apidoc sv_pos_u2b
5990 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5991 the start of the string, to a count of the equivalent number of bytes; if
5992 lenp is non-zero, it does the same to lenp, but this time starting from
5993 the offset, rather than from the start of the string. Handles magic and
6000 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6001 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6002 * byte offsets. See also the comments of S_utf8_mg_pos().
6007 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6015 start = (U8*)SvPV_const(sv, len);
6019 const U8 *s = start;
6020 I32 uoffset = *offsetp;
6021 const U8 *send = s + len;
6025 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6027 if (!found && uoffset > 0) {
6028 while (s < send && uoffset--)
6032 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6034 *offsetp = s - start;
6039 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6043 if (!found && *lenp > 0) {
6046 while (s < send && ulen--)
6050 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6054 ASSERT_UTF8_CACHE(cache);
6066 =for apidoc sv_pos_b2u
6068 Converts the value pointed to by offsetp from a count of bytes from the
6069 start of the string, to a count of the equivalent number of UTF-8 chars.
6070 Handles magic and type coercion.
6076 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6077 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6078 * byte offsets. See also the comments of S_utf8_mg_pos().
6083 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6091 s = (const U8*)SvPV_const(sv, len);
6092 if ((I32)len < *offsetp)
6093 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6095 const U8* send = s + *offsetp;
6097 STRLEN *cache = NULL;
6101 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6102 mg = mg_find(sv, PERL_MAGIC_utf8);
6103 if (mg && mg->mg_ptr) {
6104 cache = (STRLEN *) mg->mg_ptr;
6105 if (cache[1] == (STRLEN)*offsetp) {
6106 /* An exact match. */
6107 *offsetp = cache[0];
6111 else if (cache[1] < (STRLEN)*offsetp) {
6112 /* We already know part of the way. */
6115 /* Let the below loop do the rest. */
6117 else { /* cache[1] > *offsetp */
6118 /* We already know all of the way, now we may
6119 * be able to walk back. The same assumption
6120 * is made as in S_utf8_mg_pos(), namely that
6121 * walking backward is twice slower than
6122 * walking forward. */
6123 STRLEN forw = *offsetp;
6124 STRLEN backw = cache[1] - *offsetp;
6126 if (!(forw < 2 * backw)) {
6127 const U8 *p = s + cache[1];
6134 while (UTF8_IS_CONTINUATION(*p)) {
6142 *offsetp = cache[0];
6144 /* Drop the stale "length" cache */
6152 ASSERT_UTF8_CACHE(cache);
6158 /* Call utf8n_to_uvchr() to validate the sequence
6159 * (unless a simple non-UTF character) */
6160 if (!UTF8_IS_INVARIANT(*s))
6161 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6170 if (!SvREADONLY(sv)) {
6172 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6173 mg = mg_find(sv, PERL_MAGIC_utf8);
6178 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6179 mg->mg_ptr = (char *) cache;
6184 cache[1] = *offsetp;
6185 /* Drop the stale "length" cache */
6198 Returns a boolean indicating whether the strings in the two SVs are
6199 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6200 coerce its args to strings if necessary.
6206 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6214 SV* svrecode = Nullsv;
6221 pv1 = SvPV_const(sv1, cur1);
6228 pv2 = SvPV_const(sv2, cur2);
6230 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6231 /* Differing utf8ness.
6232 * Do not UTF8size the comparands as a side-effect. */
6235 svrecode = newSVpvn(pv2, cur2);
6236 sv_recode_to_utf8(svrecode, PL_encoding);
6237 pv2 = SvPV_const(svrecode, cur2);
6240 svrecode = newSVpvn(pv1, cur1);
6241 sv_recode_to_utf8(svrecode, PL_encoding);
6242 pv1 = SvPV_const(svrecode, cur1);
6244 /* Now both are in UTF-8. */
6246 SvREFCNT_dec(svrecode);
6251 bool is_utf8 = TRUE;
6254 /* sv1 is the UTF-8 one,
6255 * if is equal it must be downgrade-able */
6256 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6262 /* sv2 is the UTF-8 one,
6263 * if is equal it must be downgrade-able */
6264 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6270 /* Downgrade not possible - cannot be eq */
6278 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6281 SvREFCNT_dec(svrecode);
6292 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6293 string in C<sv1> is less than, equal to, or greater than the string in
6294 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6295 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6301 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6304 const char *pv1, *pv2;
6307 SV *svrecode = Nullsv;
6314 pv1 = SvPV_const(sv1, cur1);
6321 pv2 = SvPV_const(sv2, cur2);
6323 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6324 /* Differing utf8ness.
6325 * Do not UTF8size the comparands as a side-effect. */
6328 svrecode = newSVpvn(pv2, cur2);
6329 sv_recode_to_utf8(svrecode, PL_encoding);
6330 pv2 = SvPV_const(svrecode, cur2);
6333 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6338 svrecode = newSVpvn(pv1, cur1);
6339 sv_recode_to_utf8(svrecode, PL_encoding);
6340 pv1 = SvPV_const(svrecode, cur1);
6343 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6349 cmp = cur2 ? -1 : 0;
6353 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6356 cmp = retval < 0 ? -1 : 1;
6357 } else if (cur1 == cur2) {
6360 cmp = cur1 < cur2 ? -1 : 1;
6365 SvREFCNT_dec(svrecode);
6374 =for apidoc sv_cmp_locale
6376 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6377 'use bytes' aware, handles get magic, and will coerce its args to strings
6378 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6384 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6386 #ifdef USE_LOCALE_COLLATE
6392 if (PL_collation_standard)
6396 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6398 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6400 if (!pv1 || !len1) {
6411 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6414 return retval < 0 ? -1 : 1;
6417 * When the result of collation is equality, that doesn't mean
6418 * that there are no differences -- some locales exclude some
6419 * characters from consideration. So to avoid false equalities,
6420 * we use the raw string as a tiebreaker.
6426 #endif /* USE_LOCALE_COLLATE */
6428 return sv_cmp(sv1, sv2);
6432 #ifdef USE_LOCALE_COLLATE
6435 =for apidoc sv_collxfrm
6437 Add Collate Transform magic to an SV if it doesn't already have it.
6439 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6440 scalar data of the variable, but transformed to such a format that a normal
6441 memory comparison can be used to compare the data according to the locale
6448 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6452 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6453 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6459 Safefree(mg->mg_ptr);
6460 s = SvPV_const(sv, len);
6461 if ((xf = mem_collxfrm(s, len, &xlen))) {
6462 if (SvREADONLY(sv)) {
6465 return xf + sizeof(PL_collation_ix);
6468 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6469 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6482 if (mg && mg->mg_ptr) {
6484 return mg->mg_ptr + sizeof(PL_collation_ix);
6492 #endif /* USE_LOCALE_COLLATE */
6497 Get a line from the filehandle and store it into the SV, optionally
6498 appending to the currently-stored string.
6504 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6508 register STDCHAR rslast;
6509 register STDCHAR *bp;
6515 if (SvTHINKFIRST(sv))
6516 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6517 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6519 However, perlbench says it's slower, because the existing swipe code
6520 is faster than copy on write.
6521 Swings and roundabouts. */
6522 SvUPGRADE(sv, SVt_PV);
6527 if (PerlIO_isutf8(fp)) {
6529 sv_utf8_upgrade_nomg(sv);
6530 sv_pos_u2b(sv,&append,0);
6532 } else if (SvUTF8(sv)) {
6533 SV *tsv = NEWSV(0,0);
6534 sv_gets(tsv, fp, 0);
6535 sv_utf8_upgrade_nomg(tsv);
6536 SvCUR_set(sv,append);
6539 goto return_string_or_null;
6544 if (PerlIO_isutf8(fp))
6547 if (IN_PERL_COMPILETIME) {
6548 /* we always read code in line mode */
6552 else if (RsSNARF(PL_rs)) {
6553 /* If it is a regular disk file use size from stat() as estimate
6554 of amount we are going to read - may result in malloc-ing
6555 more memory than we realy need if layers bellow reduce
6556 size we read (e.g. CRLF or a gzip layer)
6559 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6560 const Off_t offset = PerlIO_tell(fp);
6561 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6562 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6568 else if (RsRECORD(PL_rs)) {
6572 /* Grab the size of the record we're getting */
6573 recsize = SvIV(SvRV(PL_rs));
6574 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6577 /* VMS wants read instead of fread, because fread doesn't respect */
6578 /* RMS record boundaries. This is not necessarily a good thing to be */
6579 /* doing, but we've got no other real choice - except avoid stdio
6580 as implementation - perhaps write a :vms layer ?
6582 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6584 bytesread = PerlIO_read(fp, buffer, recsize);
6588 SvCUR_set(sv, bytesread += append);
6589 buffer[bytesread] = '\0';
6590 goto return_string_or_null;
6592 else if (RsPARA(PL_rs)) {
6598 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6599 if (PerlIO_isutf8(fp)) {
6600 rsptr = SvPVutf8(PL_rs, rslen);
6603 if (SvUTF8(PL_rs)) {
6604 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6605 Perl_croak(aTHX_ "Wide character in $/");
6608 rsptr = SvPV_const(PL_rs, rslen);
6612 rslast = rslen ? rsptr[rslen - 1] : '\0';
6614 if (rspara) { /* have to do this both before and after */
6615 do { /* to make sure file boundaries work right */
6618 i = PerlIO_getc(fp);
6622 PerlIO_ungetc(fp,i);
6628 /* See if we know enough about I/O mechanism to cheat it ! */
6630 /* This used to be #ifdef test - it is made run-time test for ease
6631 of abstracting out stdio interface. One call should be cheap
6632 enough here - and may even be a macro allowing compile
6636 if (PerlIO_fast_gets(fp)) {
6639 * We're going to steal some values from the stdio struct
6640 * and put EVERYTHING in the innermost loop into registers.
6642 register STDCHAR *ptr;
6646 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6647 /* An ungetc()d char is handled separately from the regular
6648 * buffer, so we getc() it back out and stuff it in the buffer.
6650 i = PerlIO_getc(fp);
6651 if (i == EOF) return 0;
6652 *(--((*fp)->_ptr)) = (unsigned char) i;
6656 /* Here is some breathtakingly efficient cheating */
6658 cnt = PerlIO_get_cnt(fp); /* get count into register */
6659 /* make sure we have the room */
6660 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6661 /* Not room for all of it
6662 if we are looking for a separator and room for some
6664 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6665 /* just process what we have room for */
6666 shortbuffered = cnt - SvLEN(sv) + append + 1;
6667 cnt -= shortbuffered;
6671 /* remember that cnt can be negative */
6672 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6677 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6678 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6679 DEBUG_P(PerlIO_printf(Perl_debug_log,
6680 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6681 DEBUG_P(PerlIO_printf(Perl_debug_log,
6682 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6683 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6684 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6689 while (cnt > 0) { /* this | eat */
6691 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6692 goto thats_all_folks; /* screams | sed :-) */
6696 Copy(ptr, bp, cnt, char); /* this | eat */
6697 bp += cnt; /* screams | dust */
6698 ptr += cnt; /* louder | sed :-) */
6703 if (shortbuffered) { /* oh well, must extend */
6704 cnt = shortbuffered;
6706 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6708 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6709 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6713 DEBUG_P(PerlIO_printf(Perl_debug_log,
6714 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6715 PTR2UV(ptr),(long)cnt));
6716 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6718 DEBUG_P(PerlIO_printf(Perl_debug_log,
6719 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6720 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6721 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6723 /* This used to call 'filbuf' in stdio form, but as that behaves like
6724 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6725 another abstraction. */
6726 i = PerlIO_getc(fp); /* get more characters */
6728 DEBUG_P(PerlIO_printf(Perl_debug_log,
6729 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6730 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6731 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6733 cnt = PerlIO_get_cnt(fp);
6734 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6735 DEBUG_P(PerlIO_printf(Perl_debug_log,
6736 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6738 if (i == EOF) /* all done for ever? */
6739 goto thats_really_all_folks;
6741 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6743 SvGROW(sv, bpx + cnt + 2);
6744 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6746 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6748 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6749 goto thats_all_folks;
6753 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6754 memNE((char*)bp - rslen, rsptr, rslen))
6755 goto screamer; /* go back to the fray */
6756 thats_really_all_folks:
6758 cnt += shortbuffered;
6759 DEBUG_P(PerlIO_printf(Perl_debug_log,
6760 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6761 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6762 DEBUG_P(PerlIO_printf(Perl_debug_log,
6763 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6764 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6765 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6767 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6768 DEBUG_P(PerlIO_printf(Perl_debug_log,
6769 "Screamer: done, len=%ld, string=|%.*s|\n",
6770 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6774 /*The big, slow, and stupid way. */
6775 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6777 New(0, buf, 8192, STDCHAR);
6785 const register STDCHAR *bpe = buf + sizeof(buf);
6787 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6788 ; /* keep reading */
6792 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6793 /* Accomodate broken VAXC compiler, which applies U8 cast to
6794 * both args of ?: operator, causing EOF to change into 255
6797 i = (U8)buf[cnt - 1];
6803 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6805 sv_catpvn(sv, (char *) buf, cnt);
6807 sv_setpvn(sv, (char *) buf, cnt);
6809 if (i != EOF && /* joy */
6811 SvCUR(sv) < rslen ||
6812 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6816 * If we're reading from a TTY and we get a short read,
6817 * indicating that the user hit his EOF character, we need
6818 * to notice it now, because if we try to read from the TTY
6819 * again, the EOF condition will disappear.
6821 * The comparison of cnt to sizeof(buf) is an optimization
6822 * that prevents unnecessary calls to feof().
6826 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6830 #ifdef USE_HEAP_INSTEAD_OF_STACK
6835 if (rspara) { /* have to do this both before and after */
6836 while (i != EOF) { /* to make sure file boundaries work right */
6837 i = PerlIO_getc(fp);
6839 PerlIO_ungetc(fp,i);
6845 return_string_or_null:
6846 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6852 Auto-increment of the value in the SV, doing string to numeric conversion
6853 if necessary. Handles 'get' magic.
6859 Perl_sv_inc(pTHX_ register SV *sv)
6868 if (SvTHINKFIRST(sv)) {
6870 sv_force_normal_flags(sv, 0);
6871 if (SvREADONLY(sv)) {
6872 if (IN_PERL_RUNTIME)
6873 Perl_croak(aTHX_ PL_no_modify);
6877 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6879 i = PTR2IV(SvRV(sv));
6884 flags = SvFLAGS(sv);
6885 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6886 /* It's (privately or publicly) a float, but not tested as an
6887 integer, so test it to see. */
6889 flags = SvFLAGS(sv);
6891 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6892 /* It's publicly an integer, or privately an integer-not-float */
6893 #ifdef PERL_PRESERVE_IVUV
6897 if (SvUVX(sv) == UV_MAX)
6898 sv_setnv(sv, UV_MAX_P1);
6900 (void)SvIOK_only_UV(sv);
6901 SvUV_set(sv, SvUVX(sv) + 1);
6903 if (SvIVX(sv) == IV_MAX)
6904 sv_setuv(sv, (UV)IV_MAX + 1);
6906 (void)SvIOK_only(sv);
6907 SvIV_set(sv, SvIVX(sv) + 1);
6912 if (flags & SVp_NOK) {
6913 (void)SvNOK_only(sv);
6914 SvNV_set(sv, SvNVX(sv) + 1.0);
6918 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6919 if ((flags & SVTYPEMASK) < SVt_PVIV)
6920 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6921 (void)SvIOK_only(sv);
6926 while (isALPHA(*d)) d++;
6927 while (isDIGIT(*d)) d++;
6929 #ifdef PERL_PRESERVE_IVUV
6930 /* Got to punt this as an integer if needs be, but we don't issue
6931 warnings. Probably ought to make the sv_iv_please() that does
6932 the conversion if possible, and silently. */
6933 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6934 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6935 /* Need to try really hard to see if it's an integer.
6936 9.22337203685478e+18 is an integer.
6937 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6938 so $a="9.22337203685478e+18"; $a+0; $a++
6939 needs to be the same as $a="9.22337203685478e+18"; $a++
6946 /* sv_2iv *should* have made this an NV */
6947 if (flags & SVp_NOK) {
6948 (void)SvNOK_only(sv);
6949 SvNV_set(sv, SvNVX(sv) + 1.0);
6952 /* I don't think we can get here. Maybe I should assert this
6953 And if we do get here I suspect that sv_setnv will croak. NWC
6955 #if defined(USE_LONG_DOUBLE)
6956 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",
6957 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6959 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6960 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6963 #endif /* PERL_PRESERVE_IVUV */
6964 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6968 while (d >= SvPVX_const(sv)) {
6976 /* MKS: The original code here died if letters weren't consecutive.
6977 * at least it didn't have to worry about non-C locales. The
6978 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6979 * arranged in order (although not consecutively) and that only
6980 * [A-Za-z] are accepted by isALPHA in the C locale.
6982 if (*d != 'z' && *d != 'Z') {
6983 do { ++*d; } while (!isALPHA(*d));
6986 *(d--) -= 'z' - 'a';
6991 *(d--) -= 'z' - 'a' + 1;
6995 /* oh,oh, the number grew */
6996 SvGROW(sv, SvCUR(sv) + 2);
6997 SvCUR_set(sv, SvCUR(sv) + 1);
6998 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7009 Auto-decrement of the value in the SV, doing string to numeric conversion
7010 if necessary. Handles 'get' magic.
7016 Perl_sv_dec(pTHX_ register SV *sv)
7024 if (SvTHINKFIRST(sv)) {
7026 sv_force_normal_flags(sv, 0);
7027 if (SvREADONLY(sv)) {
7028 if (IN_PERL_RUNTIME)
7029 Perl_croak(aTHX_ PL_no_modify);
7033 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7035 i = PTR2IV(SvRV(sv));
7040 /* Unlike sv_inc we don't have to worry about string-never-numbers
7041 and keeping them magic. But we mustn't warn on punting */
7042 flags = SvFLAGS(sv);
7043 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7044 /* It's publicly an integer, or privately an integer-not-float */
7045 #ifdef PERL_PRESERVE_IVUV
7049 if (SvUVX(sv) == 0) {
7050 (void)SvIOK_only(sv);
7054 (void)SvIOK_only_UV(sv);
7055 SvUV_set(sv, SvUVX(sv) + 1);
7058 if (SvIVX(sv) == IV_MIN)
7059 sv_setnv(sv, (NV)IV_MIN - 1.0);
7061 (void)SvIOK_only(sv);
7062 SvIV_set(sv, SvIVX(sv) - 1);
7067 if (flags & SVp_NOK) {
7068 SvNV_set(sv, SvNVX(sv) - 1.0);
7069 (void)SvNOK_only(sv);
7072 if (!(flags & SVp_POK)) {
7073 if ((flags & SVTYPEMASK) < SVt_PVNV)
7074 sv_upgrade(sv, SVt_NV);
7076 (void)SvNOK_only(sv);
7079 #ifdef PERL_PRESERVE_IVUV
7081 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7082 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7083 /* Need to try really hard to see if it's an integer.
7084 9.22337203685478e+18 is an integer.
7085 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7086 so $a="9.22337203685478e+18"; $a+0; $a--
7087 needs to be the same as $a="9.22337203685478e+18"; $a--
7094 /* sv_2iv *should* have made this an NV */
7095 if (flags & SVp_NOK) {
7096 (void)SvNOK_only(sv);
7097 SvNV_set(sv, SvNVX(sv) - 1.0);
7100 /* I don't think we can get here. Maybe I should assert this
7101 And if we do get here I suspect that sv_setnv will croak. NWC
7103 #if defined(USE_LONG_DOUBLE)
7104 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",
7105 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7107 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7108 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7112 #endif /* PERL_PRESERVE_IVUV */
7113 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7117 =for apidoc sv_mortalcopy
7119 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7120 The new SV is marked as mortal. It will be destroyed "soon", either by an
7121 explicit call to FREETMPS, or by an implicit call at places such as
7122 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7127 /* Make a string that will exist for the duration of the expression
7128 * evaluation. Actually, it may have to last longer than that, but
7129 * hopefully we won't free it until it has been assigned to a
7130 * permanent location. */
7133 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7138 sv_setsv(sv,oldstr);
7140 PL_tmps_stack[++PL_tmps_ix] = sv;
7146 =for apidoc sv_newmortal
7148 Creates a new null SV which is mortal. The reference count of the SV is
7149 set to 1. It will be destroyed "soon", either by an explicit call to
7150 FREETMPS, or by an implicit call at places such as statement boundaries.
7151 See also C<sv_mortalcopy> and C<sv_2mortal>.
7157 Perl_sv_newmortal(pTHX)
7162 SvFLAGS(sv) = SVs_TEMP;
7164 PL_tmps_stack[++PL_tmps_ix] = sv;
7169 =for apidoc sv_2mortal
7171 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7172 by an explicit call to FREETMPS, or by an implicit call at places such as
7173 statement boundaries. SvTEMP() is turned on which means that the SV's
7174 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7175 and C<sv_mortalcopy>.
7181 Perl_sv_2mortal(pTHX_ register SV *sv)
7186 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7189 PL_tmps_stack[++PL_tmps_ix] = sv;
7197 Creates a new SV and copies a string into it. The reference count for the
7198 SV is set to 1. If C<len> is zero, Perl will compute the length using
7199 strlen(). For efficiency, consider using C<newSVpvn> instead.
7205 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7210 sv_setpvn(sv,s,len ? len : strlen(s));
7215 =for apidoc newSVpvn
7217 Creates a new SV and copies a string into it. The reference count for the
7218 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7219 string. You are responsible for ensuring that the source string is at least
7220 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7226 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7231 sv_setpvn(sv,s,len);
7237 =for apidoc newSVhek
7239 Creates a new SV from the hash key structure. It will generate scalars that
7240 point to the shared string table where possible. Returns a new (undefined)
7241 SV if the hek is NULL.
7247 Perl_newSVhek(pTHX_ const HEK *hek)
7256 if (HEK_LEN(hek) == HEf_SVKEY) {
7257 return newSVsv(*(SV**)HEK_KEY(hek));
7259 const int flags = HEK_FLAGS(hek);
7260 if (flags & HVhek_WASUTF8) {
7262 Andreas would like keys he put in as utf8 to come back as utf8
7264 STRLEN utf8_len = HEK_LEN(hek);
7265 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7266 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7269 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7271 } else if (flags & HVhek_REHASH) {
7272 /* We don't have a pointer to the hv, so we have to replicate the
7273 flag into every HEK. This hv is using custom a hasing
7274 algorithm. Hence we can't return a shared string scalar, as
7275 that would contain the (wrong) hash value, and might get passed
7276 into an hv routine with a regular hash */
7278 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7283 /* This will be overwhelminly the most common case. */
7284 return newSVpvn_share(HEK_KEY(hek),
7285 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7291 =for apidoc newSVpvn_share
7293 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7294 table. If the string does not already exist in the table, it is created
7295 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7296 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7297 otherwise the hash is computed. The idea here is that as the string table
7298 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7299 hash lookup will avoid string compare.
7305 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7308 bool is_utf8 = FALSE;
7310 STRLEN tmplen = -len;
7312 /* See the note in hv.c:hv_fetch() --jhi */
7313 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7317 PERL_HASH(hash, src, len);
7319 sv_upgrade(sv, SVt_PV);
7320 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7332 #if defined(PERL_IMPLICIT_CONTEXT)
7334 /* pTHX_ magic can't cope with varargs, so this is a no-context
7335 * version of the main function, (which may itself be aliased to us).
7336 * Don't access this version directly.
7340 Perl_newSVpvf_nocontext(const char* pat, ...)
7345 va_start(args, pat);
7346 sv = vnewSVpvf(pat, &args);
7353 =for apidoc newSVpvf
7355 Creates a new SV and initializes it with the string formatted like
7362 Perl_newSVpvf(pTHX_ const char* pat, ...)
7366 va_start(args, pat);
7367 sv = vnewSVpvf(pat, &args);
7372 /* backend for newSVpvf() and newSVpvf_nocontext() */
7375 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7379 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7386 Creates a new SV and copies a floating point value into it.
7387 The reference count for the SV is set to 1.
7393 Perl_newSVnv(pTHX_ NV n)
7405 Creates a new SV and copies an integer into it. The reference count for the
7412 Perl_newSViv(pTHX_ IV i)
7424 Creates a new SV and copies an unsigned integer into it.
7425 The reference count for the SV is set to 1.
7431 Perl_newSVuv(pTHX_ UV u)
7441 =for apidoc newRV_noinc
7443 Creates an RV wrapper for an SV. The reference count for the original
7444 SV is B<not> incremented.
7450 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7455 sv_upgrade(sv, SVt_RV);
7457 SvRV_set(sv, tmpRef);
7462 /* newRV_inc is the official function name to use now.
7463 * newRV_inc is in fact #defined to newRV in sv.h
7467 Perl_newRV(pTHX_ SV *tmpRef)
7469 return newRV_noinc(SvREFCNT_inc(tmpRef));
7475 Creates a new SV which is an exact duplicate of the original SV.
7482 Perl_newSVsv(pTHX_ register SV *old)
7488 if (SvTYPE(old) == SVTYPEMASK) {
7489 if (ckWARN_d(WARN_INTERNAL))
7490 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7494 /* SV_GMAGIC is the default for sv_setv()
7495 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7496 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7497 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7502 =for apidoc sv_reset
7504 Underlying implementation for the C<reset> Perl function.
7505 Note that the perl-level function is vaguely deprecated.
7511 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7514 char todo[PERL_UCHAR_MAX+1];
7519 if (!*s) { /* reset ?? searches */
7520 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7522 PMOP *pm = (PMOP *) mg->mg_obj;
7524 pm->op_pmdynflags &= ~PMdf_USED;
7531 /* reset variables */
7533 if (!HvARRAY(stash))
7536 Zero(todo, 256, char);
7539 I32 i = (unsigned char)*s;
7543 max = (unsigned char)*s++;
7544 for ( ; i <= max; i++) {
7547 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7549 for (entry = HvARRAY(stash)[i];
7551 entry = HeNEXT(entry))
7556 if (!todo[(U8)*HeKEY(entry)])
7558 gv = (GV*)HeVAL(entry);
7560 if (SvTHINKFIRST(sv)) {
7561 if (!SvREADONLY(sv) && SvROK(sv))
7566 if (SvTYPE(sv) >= SVt_PV) {
7568 if (SvPVX_const(sv) != Nullch)
7575 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7578 #ifdef USE_ENVIRON_ARRAY
7580 # ifdef USE_ITHREADS
7581 && PL_curinterp == aTHX
7585 environ[0] = Nullch;
7588 #endif /* !PERL_MICRO */
7598 Using various gambits, try to get an IO from an SV: the IO slot if its a
7599 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7600 named after the PV if we're a string.
7606 Perl_sv_2io(pTHX_ SV *sv)
7611 switch (SvTYPE(sv)) {
7619 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7623 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7625 return sv_2io(SvRV(sv));
7626 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7632 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7641 Using various gambits, try to get a CV from an SV; in addition, try if
7642 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7648 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7655 return *gvp = Nullgv, Nullcv;
7656 switch (SvTYPE(sv)) {
7675 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7676 tryAMAGICunDEREF(to_cv);
7679 if (SvTYPE(sv) == SVt_PVCV) {
7688 Perl_croak(aTHX_ "Not a subroutine reference");
7693 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7699 if (lref && !GvCVu(gv)) {
7702 tmpsv = NEWSV(704,0);
7703 gv_efullname3(tmpsv, gv, Nullch);
7704 /* XXX this is probably not what they think they're getting.
7705 * It has the same effect as "sub name;", i.e. just a forward
7707 newSUB(start_subparse(FALSE, 0),
7708 newSVOP(OP_CONST, 0, tmpsv),
7713 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7723 Returns true if the SV has a true value by Perl's rules.
7724 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7725 instead use an in-line version.
7731 Perl_sv_true(pTHX_ register SV *sv)
7736 const register XPV* tXpv;
7737 if ((tXpv = (XPV*)SvANY(sv)) &&
7738 (tXpv->xpv_cur > 1 ||
7739 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7746 return SvIVX(sv) != 0;
7749 return SvNVX(sv) != 0.0;
7751 return sv_2bool(sv);
7759 A private implementation of the C<SvIVx> macro for compilers which can't
7760 cope with complex macro expressions. Always use the macro instead.
7766 Perl_sv_iv(pTHX_ register SV *sv)
7770 return (IV)SvUVX(sv);
7779 A private implementation of the C<SvUVx> macro for compilers which can't
7780 cope with complex macro expressions. Always use the macro instead.
7786 Perl_sv_uv(pTHX_ register SV *sv)
7791 return (UV)SvIVX(sv);
7799 A private implementation of the C<SvNVx> macro for compilers which can't
7800 cope with complex macro expressions. Always use the macro instead.
7806 Perl_sv_nv(pTHX_ register SV *sv)
7813 /* sv_pv() is now a macro using SvPV_nolen();
7814 * this function provided for binary compatibility only
7818 Perl_sv_pv(pTHX_ SV *sv)
7823 return sv_2pv(sv, 0);
7829 Use the C<SvPV_nolen> macro instead
7833 A private implementation of the C<SvPV> macro for compilers which can't
7834 cope with complex macro expressions. Always use the macro instead.
7840 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7846 return sv_2pv(sv, lp);
7851 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7857 return sv_2pv_flags(sv, lp, 0);
7860 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7861 * this function provided for binary compatibility only
7865 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7867 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7871 =for apidoc sv_pvn_force
7873 Get a sensible string out of the SV somehow.
7874 A private implementation of the C<SvPV_force> macro for compilers which
7875 can't cope with complex macro expressions. Always use the macro instead.
7877 =for apidoc sv_pvn_force_flags
7879 Get a sensible string out of the SV somehow.
7880 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7881 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7882 implemented in terms of this function.
7883 You normally want to use the various wrapper macros instead: see
7884 C<SvPV_force> and C<SvPV_force_nomg>
7890 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7893 if (SvTHINKFIRST(sv) && !SvROK(sv))
7894 sv_force_normal_flags(sv, 0);
7904 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7906 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7907 sv_reftype(sv,0), OP_NAME(PL_op));
7909 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
7912 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7913 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7917 s = sv_2pv_flags(sv, &len, flags);
7921 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7924 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7925 SvGROW(sv, len + 1);
7926 Move(s,SvPVX_const(sv),len,char);
7931 SvPOK_on(sv); /* validate pointer */
7933 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7934 PTR2UV(sv),SvPVX_const(sv)));
7937 return SvPVX_mutable(sv);
7940 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7941 * this function provided for binary compatibility only
7945 Perl_sv_pvbyte(pTHX_ SV *sv)
7947 sv_utf8_downgrade(sv,0);
7952 =for apidoc sv_pvbyte
7954 Use C<SvPVbyte_nolen> instead.
7956 =for apidoc sv_pvbyten
7958 A private implementation of the C<SvPVbyte> macro for compilers
7959 which can't cope with complex macro expressions. Always use the macro
7966 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7968 sv_utf8_downgrade(sv,0);
7969 return sv_pvn(sv,lp);
7973 =for apidoc sv_pvbyten_force
7975 A private implementation of the C<SvPVbytex_force> macro for compilers
7976 which can't cope with complex macro expressions. Always use the macro
7983 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7985 sv_pvn_force(sv,lp);
7986 sv_utf8_downgrade(sv,0);
7991 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7992 * this function provided for binary compatibility only
7996 Perl_sv_pvutf8(pTHX_ SV *sv)
7998 sv_utf8_upgrade(sv);
8003 =for apidoc sv_pvutf8
8005 Use the C<SvPVutf8_nolen> macro instead
8007 =for apidoc sv_pvutf8n
8009 A private implementation of the C<SvPVutf8> macro for compilers
8010 which can't cope with complex macro expressions. Always use the macro
8017 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8019 sv_utf8_upgrade(sv);
8020 return sv_pvn(sv,lp);
8024 =for apidoc sv_pvutf8n_force
8026 A private implementation of the C<SvPVutf8_force> macro for compilers
8027 which can't cope with complex macro expressions. Always use the macro
8034 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8036 sv_pvn_force(sv,lp);
8037 sv_utf8_upgrade(sv);
8043 =for apidoc sv_reftype
8045 Returns a string describing what the SV is a reference to.
8051 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8053 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8054 inside return suggests a const propagation bug in g++. */
8055 if (ob && SvOBJECT(sv)) {
8056 char *name = HvNAME_get(SvSTASH(sv));
8057 return name ? name : (char *) "__ANON__";
8060 switch (SvTYPE(sv)) {
8077 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8078 /* tied lvalues should appear to be
8079 * scalars for backwards compatitbility */
8080 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8081 ? "SCALAR" : "LVALUE");
8082 case SVt_PVAV: return "ARRAY";
8083 case SVt_PVHV: return "HASH";
8084 case SVt_PVCV: return "CODE";
8085 case SVt_PVGV: return "GLOB";
8086 case SVt_PVFM: return "FORMAT";
8087 case SVt_PVIO: return "IO";
8088 default: return "UNKNOWN";
8094 =for apidoc sv_isobject
8096 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8097 object. If the SV is not an RV, or if the object is not blessed, then this
8104 Perl_sv_isobject(pTHX_ SV *sv)
8121 Returns a boolean indicating whether the SV is blessed into the specified
8122 class. This does not check for subtypes; use C<sv_derived_from> to verify
8123 an inheritance relationship.
8129 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8141 hvname = HvNAME_get(SvSTASH(sv));
8145 return strEQ(hvname, name);
8151 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8152 it will be upgraded to one. If C<classname> is non-null then the new SV will
8153 be blessed in the specified package. The new SV is returned and its
8154 reference count is 1.
8160 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8166 SV_CHECK_THINKFIRST_COW_DROP(rv);
8169 if (SvTYPE(rv) >= SVt_PVMG) {
8170 const U32 refcnt = SvREFCNT(rv);
8174 SvREFCNT(rv) = refcnt;
8177 if (SvTYPE(rv) < SVt_RV)
8178 sv_upgrade(rv, SVt_RV);
8179 else if (SvTYPE(rv) > SVt_RV) {
8190 HV* stash = gv_stashpv(classname, TRUE);
8191 (void)sv_bless(rv, stash);
8197 =for apidoc sv_setref_pv
8199 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8200 argument will be upgraded to an RV. That RV will be modified to point to
8201 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8202 into the SV. The C<classname> argument indicates the package for the
8203 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8204 will have a reference count of 1, and the RV will be returned.
8206 Do not use with other Perl types such as HV, AV, SV, CV, because those
8207 objects will become corrupted by the pointer copy process.
8209 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8215 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8218 sv_setsv(rv, &PL_sv_undef);
8222 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8227 =for apidoc sv_setref_iv
8229 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8230 argument will be upgraded to an RV. That RV will be modified to point to
8231 the new SV. The C<classname> argument indicates the package for the
8232 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8233 will have a reference count of 1, and the RV will be returned.
8239 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8241 sv_setiv(newSVrv(rv,classname), iv);
8246 =for apidoc sv_setref_uv
8248 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8249 argument will be upgraded to an RV. That RV will be modified to point to
8250 the new SV. The C<classname> argument indicates the package for the
8251 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8252 will have a reference count of 1, and the RV will be returned.
8258 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8260 sv_setuv(newSVrv(rv,classname), uv);
8265 =for apidoc sv_setref_nv
8267 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8268 argument will be upgraded to an RV. That RV will be modified to point to
8269 the new SV. The C<classname> argument indicates the package for the
8270 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8271 will have a reference count of 1, and the RV will be returned.
8277 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8279 sv_setnv(newSVrv(rv,classname), nv);
8284 =for apidoc sv_setref_pvn
8286 Copies a string into a new SV, optionally blessing the SV. The length of the
8287 string must be specified with C<n>. The C<rv> argument will be upgraded to
8288 an RV. That RV will be modified to point to the new SV. The C<classname>
8289 argument indicates the package for the blessing. Set C<classname> to
8290 C<Nullch> to avoid the blessing. The new SV will have a reference count
8291 of 1, and the RV will be returned.
8293 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8299 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8301 sv_setpvn(newSVrv(rv,classname), pv, n);
8306 =for apidoc sv_bless
8308 Blesses an SV into a specified package. The SV must be an RV. The package
8309 must be designated by its stash (see C<gv_stashpv()>). The reference count
8310 of the SV is unaffected.
8316 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8320 Perl_croak(aTHX_ "Can't bless non-reference value");
8322 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8323 if (SvREADONLY(tmpRef))
8324 Perl_croak(aTHX_ PL_no_modify);
8325 if (SvOBJECT(tmpRef)) {
8326 if (SvTYPE(tmpRef) != SVt_PVIO)
8328 SvREFCNT_dec(SvSTASH(tmpRef));
8331 SvOBJECT_on(tmpRef);
8332 if (SvTYPE(tmpRef) != SVt_PVIO)
8334 SvUPGRADE(tmpRef, SVt_PVMG);
8335 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8342 if(SvSMAGICAL(tmpRef))
8343 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8351 /* Downgrades a PVGV to a PVMG.
8355 S_sv_unglob(pTHX_ SV *sv)
8359 assert(SvTYPE(sv) == SVt_PVGV);
8364 SvREFCNT_dec(GvSTASH(sv));
8365 GvSTASH(sv) = Nullhv;
8367 sv_unmagic(sv, PERL_MAGIC_glob);
8368 Safefree(GvNAME(sv));
8371 /* need to keep SvANY(sv) in the right arena */
8372 xpvmg = new_XPVMG();
8373 StructCopy(SvANY(sv), xpvmg, XPVMG);
8374 del_XPVGV(SvANY(sv));
8377 SvFLAGS(sv) &= ~SVTYPEMASK;
8378 SvFLAGS(sv) |= SVt_PVMG;
8382 =for apidoc sv_unref_flags
8384 Unsets the RV status of the SV, and decrements the reference count of
8385 whatever was being referenced by the RV. This can almost be thought of
8386 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8387 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8388 (otherwise the decrementing is conditional on the reference count being
8389 different from one or the reference being a readonly SV).
8396 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8400 if (SvWEAKREF(sv)) {
8408 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8409 assigned to as BEGIN {$a = \"Foo"} will fail. */
8410 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8412 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8413 sv_2mortal(rv); /* Schedule for freeing later */
8417 =for apidoc sv_unref
8419 Unsets the RV status of the SV, and decrements the reference count of
8420 whatever was being referenced by the RV. This can almost be thought of
8421 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8422 being zero. See C<SvROK_off>.
8428 Perl_sv_unref(pTHX_ SV *sv)
8430 sv_unref_flags(sv, 0);
8434 =for apidoc sv_taint
8436 Taint an SV. Use C<SvTAINTED_on> instead.
8441 Perl_sv_taint(pTHX_ SV *sv)
8443 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8447 =for apidoc sv_untaint
8449 Untaint an SV. Use C<SvTAINTED_off> instead.
8454 Perl_sv_untaint(pTHX_ SV *sv)
8456 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8457 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8464 =for apidoc sv_tainted
8466 Test an SV for taintedness. Use C<SvTAINTED> instead.
8471 Perl_sv_tainted(pTHX_ SV *sv)
8473 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8474 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8475 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8482 =for apidoc sv_setpviv
8484 Copies an integer into the given SV, also updating its string value.
8485 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8491 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8493 char buf[TYPE_CHARS(UV)];
8495 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8497 sv_setpvn(sv, ptr, ebuf - ptr);
8501 =for apidoc sv_setpviv_mg
8503 Like C<sv_setpviv>, but also handles 'set' magic.
8509 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8511 char buf[TYPE_CHARS(UV)];
8513 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8515 sv_setpvn(sv, ptr, ebuf - ptr);
8519 #if defined(PERL_IMPLICIT_CONTEXT)
8521 /* pTHX_ magic can't cope with varargs, so this is a no-context
8522 * version of the main function, (which may itself be aliased to us).
8523 * Don't access this version directly.
8527 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8531 va_start(args, pat);
8532 sv_vsetpvf(sv, pat, &args);
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_mg_nocontext(SV *sv, const char* pat, ...)
8546 va_start(args, pat);
8547 sv_vsetpvf_mg(sv, pat, &args);
8553 =for apidoc sv_setpvf
8555 Works like C<sv_catpvf> but copies the text into the SV instead of
8556 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8562 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8565 va_start(args, pat);
8566 sv_vsetpvf(sv, pat, &args);
8571 =for apidoc sv_vsetpvf
8573 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8574 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8576 Usually used via its frontend C<sv_setpvf>.
8582 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8584 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8588 =for apidoc sv_setpvf_mg
8590 Like C<sv_setpvf>, but also handles 'set' magic.
8596 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8599 va_start(args, pat);
8600 sv_vsetpvf_mg(sv, pat, &args);
8605 =for apidoc sv_vsetpvf_mg
8607 Like C<sv_vsetpvf>, but also handles 'set' magic.
8609 Usually used via its frontend C<sv_setpvf_mg>.
8615 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8617 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8621 #if defined(PERL_IMPLICIT_CONTEXT)
8623 /* pTHX_ magic can't cope with varargs, so this is a no-context
8624 * version of the main function, (which may itself be aliased to us).
8625 * Don't access this version directly.
8629 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8633 va_start(args, pat);
8634 sv_vcatpvf(sv, pat, &args);
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_mg_nocontext(SV *sv, const char* pat, ...)
8648 va_start(args, pat);
8649 sv_vcatpvf_mg(sv, pat, &args);
8655 =for apidoc sv_catpvf
8657 Processes its arguments like C<sprintf> and appends the formatted
8658 output to an SV. If the appended data contains "wide" characters
8659 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8660 and characters >255 formatted with %c), the original SV might get
8661 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8662 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8663 valid UTF-8; if the original SV was bytes, the pattern should be too.
8668 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8671 va_start(args, pat);
8672 sv_vcatpvf(sv, pat, &args);
8677 =for apidoc sv_vcatpvf
8679 Processes its arguments like C<vsprintf> and appends the formatted output
8680 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8682 Usually used via its frontend C<sv_catpvf>.
8688 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8690 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8694 =for apidoc sv_catpvf_mg
8696 Like C<sv_catpvf>, but also handles 'set' magic.
8702 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8705 va_start(args, pat);
8706 sv_vcatpvf_mg(sv, pat, &args);
8711 =for apidoc sv_vcatpvf_mg
8713 Like C<sv_vcatpvf>, but also handles 'set' magic.
8715 Usually used via its frontend C<sv_catpvf_mg>.
8721 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8723 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8728 =for apidoc sv_vsetpvfn
8730 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8733 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8739 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8741 sv_setpvn(sv, "", 0);
8742 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8745 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8748 S_expect_number(pTHX_ char** pattern)
8751 switch (**pattern) {
8752 case '1': case '2': case '3':
8753 case '4': case '5': case '6':
8754 case '7': case '8': case '9':
8755 while (isDIGIT(**pattern))
8756 var = var * 10 + (*(*pattern)++ - '0');
8760 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8763 F0convert(NV nv, char *endbuf, STRLEN *len)
8765 const int neg = nv < 0;
8774 if (uv & 1 && uv == nv)
8775 uv--; /* Round to even */
8777 const unsigned dig = uv % 10;
8790 =for apidoc sv_vcatpvfn
8792 Processes its arguments like C<vsprintf> and appends the formatted output
8793 to an SV. Uses an array of SVs if the C style variable argument list is
8794 missing (NULL). When running with taint checks enabled, indicates via
8795 C<maybe_tainted> if results are untrustworthy (often due to the use of
8798 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8803 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8806 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8813 static const char nullstr[] = "(null)";
8815 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8816 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8818 /* Times 4: a decimal digit takes more than 3 binary digits.
8819 * NV_DIG: mantissa takes than many decimal digits.
8820 * Plus 32: Playing safe. */
8821 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8822 /* large enough for "%#.#f" --chip */
8823 /* what about long double NVs? --jhi */
8825 PERL_UNUSED_ARG(maybe_tainted);
8827 /* no matter what, this is a string now */
8828 (void)SvPV_force(sv, origlen);
8830 /* special-case "", "%s", and "%-p" (SVf) */
8833 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8835 const char * const s = va_arg(*args, char*);
8836 sv_catpv(sv, s ? s : nullstr);
8838 else if (svix < svmax) {
8839 sv_catsv(sv, *svargs);
8840 if (DO_UTF8(*svargs))
8845 if (patlen == 3 && pat[0] == '%' &&
8846 pat[1] == '-' && pat[2] == 'p') {
8848 argsv = va_arg(*args, SV*);
8849 sv_catsv(sv, argsv);
8856 #ifndef USE_LONG_DOUBLE
8857 /* special-case "%.<number>[gf]" */
8858 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8859 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8860 unsigned digits = 0;
8864 while (*pp >= '0' && *pp <= '9')
8865 digits = 10 * digits + (*pp++ - '0');
8866 if (pp - pat == (int)patlen - 1) {
8874 /* Add check for digits != 0 because it seems that some
8875 gconverts are buggy in this case, and we don't yet have
8876 a Configure test for this. */
8877 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8878 /* 0, point, slack */
8879 Gconvert(nv, (int)digits, 0, ebuf);
8881 if (*ebuf) /* May return an empty string for digits==0 */
8884 } else if (!digits) {
8887 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8888 sv_catpvn(sv, p, l);
8894 #endif /* !USE_LONG_DOUBLE */
8896 if (!args && svix < svmax && DO_UTF8(*svargs))
8899 patend = (char*)pat + patlen;
8900 for (p = (char*)pat; p < patend; p = q) {
8903 bool vectorize = FALSE;
8904 bool vectorarg = FALSE;
8905 bool vec_utf8 = FALSE;
8911 bool has_precis = FALSE;
8914 bool is_utf8 = FALSE; /* is this item utf8? */
8915 #ifdef HAS_LDBL_SPRINTF_BUG
8916 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8917 with sfio - Allen <allens@cpan.org> */
8918 bool fix_ldbl_sprintf_bug = FALSE;
8922 U8 utf8buf[UTF8_MAXBYTES+1];
8923 STRLEN esignlen = 0;
8925 const char *eptr = Nullch;
8928 const U8 *vecstr = Null(U8*);
8935 /* we need a long double target in case HAS_LONG_DOUBLE but
8938 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8946 const char *dotstr = ".";
8947 STRLEN dotstrlen = 1;
8948 I32 efix = 0; /* explicit format parameter index */
8949 I32 ewix = 0; /* explicit width index */
8950 I32 epix = 0; /* explicit precision index */
8951 I32 evix = 0; /* explicit vector index */
8952 bool asterisk = FALSE;
8954 /* echo everything up to the next format specification */
8955 for (q = p; q < patend && *q != '%'; ++q) ;
8957 if (has_utf8 && !pat_utf8)
8958 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8960 sv_catpvn(sv, p, q - p);
8967 We allow format specification elements in this order:
8968 \d+\$ explicit format parameter index
8970 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8971 0 flag (as above): repeated to allow "v02"
8972 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8973 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8975 [%bcdefginopsux_DFOUX] format (mandatory)
8977 if (EXPECT_NUMBER(q, width)) {
9018 if (EXPECT_NUMBER(q, ewix))
9027 if ((vectorarg = asterisk)) {
9039 EXPECT_NUMBER(q, width);
9044 vecsv = va_arg(*args, SV*);
9046 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9047 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9048 dotstr = SvPV_const(vecsv, dotstrlen);
9053 vecsv = va_arg(*args, SV*);
9054 vecstr = (U8*)SvPV_const(vecsv,veclen);
9055 vec_utf8 = DO_UTF8(vecsv);
9057 else if (efix ? efix <= svmax : svix < svmax) {
9058 vecsv = svargs[efix ? efix-1 : svix++];
9059 vecstr = (U8*)SvPV_const(vecsv,veclen);
9060 vec_utf8 = DO_UTF8(vecsv);
9061 /* if this is a version object, we need to return the
9062 * stringified representation (which the SvPVX_const has
9063 * already done for us), but not vectorize the args
9065 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9067 q++; /* skip past the rest of the %vd format */
9068 eptr = (const char *) vecstr;
9069 elen = strlen(eptr);
9082 i = va_arg(*args, int);
9084 i = (ewix ? ewix <= svmax : svix < svmax) ?
9085 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9087 width = (i < 0) ? -i : i;
9097 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9099 /* XXX: todo, support specified precision parameter */
9103 i = va_arg(*args, int);
9105 i = (ewix ? ewix <= svmax : svix < svmax)
9106 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9107 precis = (i < 0) ? 0 : i;
9112 precis = precis * 10 + (*q++ - '0');
9121 case 'I': /* Ix, I32x, and I64x */
9123 if (q[1] == '6' && q[2] == '4') {
9129 if (q[1] == '3' && q[2] == '2') {
9139 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9150 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9151 if (*(q + 1) == 'l') { /* lld, llf */
9176 argsv = (efix ? efix <= svmax : svix < svmax) ?
9177 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9184 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9186 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9188 eptr = (char*)utf8buf;
9189 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9200 if (args && !vectorize) {
9201 eptr = va_arg(*args, char*);
9203 #ifdef MACOS_TRADITIONAL
9204 /* On MacOS, %#s format is used for Pascal strings */
9209 elen = strlen(eptr);
9211 eptr = (char *)nullstr;
9212 elen = sizeof nullstr - 1;
9216 eptr = SvPVx_const(argsv, elen);
9217 if (DO_UTF8(argsv)) {
9218 if (has_precis && precis < elen) {
9220 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9223 if (width) { /* fudge width (can't fudge elen) */
9224 width += elen - sv_len_utf8(argsv);
9232 if (has_precis && elen > precis)
9239 if (left && args) { /* SVf */
9248 argsv = va_arg(*args, SV*);
9249 eptr = SvPVx_const(argsv, elen);
9254 if (alt || vectorize)
9256 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9274 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9283 esignbuf[esignlen++] = plus;
9287 case 'h': iv = (short)va_arg(*args, int); break;
9288 case 'l': iv = va_arg(*args, long); break;
9289 case 'V': iv = va_arg(*args, IV); break;
9290 default: iv = va_arg(*args, int); break;
9292 case 'q': iv = va_arg(*args, Quad_t); break;
9297 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9299 case 'h': iv = (short)tiv; break;
9300 case 'l': iv = (long)tiv; break;
9302 default: iv = tiv; break;
9304 case 'q': iv = (Quad_t)tiv; break;
9308 if ( !vectorize ) /* we already set uv above */
9313 esignbuf[esignlen++] = plus;
9317 esignbuf[esignlen++] = '-';
9360 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9371 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9372 case 'l': uv = va_arg(*args, unsigned long); break;
9373 case 'V': uv = va_arg(*args, UV); break;
9374 default: uv = va_arg(*args, unsigned); break;
9376 case 'q': uv = va_arg(*args, Uquad_t); break;
9381 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9383 case 'h': uv = (unsigned short)tuv; break;
9384 case 'l': uv = (unsigned long)tuv; break;
9386 default: uv = tuv; break;
9388 case 'q': uv = (Uquad_t)tuv; break;
9395 char *ptr = ebuf + sizeof ebuf;
9401 p = (char*)((c == 'X')
9402 ? "0123456789ABCDEF" : "0123456789abcdef");
9408 esignbuf[esignlen++] = '0';
9409 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9417 if (alt && *ptr != '0')
9426 esignbuf[esignlen++] = '0';
9427 esignbuf[esignlen++] = 'b';
9430 default: /* it had better be ten or less */
9434 } while (uv /= base);
9437 elen = (ebuf + sizeof ebuf) - ptr;
9441 zeros = precis - elen;
9442 else if (precis == 0 && elen == 1 && *eptr == '0')
9448 /* FLOATING POINT */
9451 c = 'f'; /* maybe %F isn't supported here */
9457 /* This is evil, but floating point is even more evil */
9459 /* for SV-style calling, we can only get NV
9460 for C-style calling, we assume %f is double;
9461 for simplicity we allow any of %Lf, %llf, %qf for long double
9465 #if defined(USE_LONG_DOUBLE)
9469 /* [perl #20339] - we should accept and ignore %lf rather than die */
9473 #if defined(USE_LONG_DOUBLE)
9474 intsize = args ? 0 : 'q';
9478 #if defined(HAS_LONG_DOUBLE)
9487 /* now we need (long double) if intsize == 'q', else (double) */
9488 nv = (args && !vectorize) ?
9489 #if LONG_DOUBLESIZE > DOUBLESIZE
9491 va_arg(*args, long double) :
9492 va_arg(*args, double)
9494 va_arg(*args, double)
9500 if (c != 'e' && c != 'E') {
9502 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9503 will cast our (long double) to (double) */
9504 (void)Perl_frexp(nv, &i);
9505 if (i == PERL_INT_MIN)
9506 Perl_die(aTHX_ "panic: frexp");
9508 need = BIT_DIGITS(i);
9510 need += has_precis ? precis : 6; /* known default */
9515 #ifdef HAS_LDBL_SPRINTF_BUG
9516 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9517 with sfio - Allen <allens@cpan.org> */
9520 # define MY_DBL_MAX DBL_MAX
9521 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9522 # if DOUBLESIZE >= 8
9523 # define MY_DBL_MAX 1.7976931348623157E+308L
9525 # define MY_DBL_MAX 3.40282347E+38L
9529 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9530 # define MY_DBL_MAX_BUG 1L
9532 # define MY_DBL_MAX_BUG MY_DBL_MAX
9536 # define MY_DBL_MIN DBL_MIN
9537 # else /* XXX guessing! -Allen */
9538 # if DOUBLESIZE >= 8
9539 # define MY_DBL_MIN 2.2250738585072014E-308L
9541 # define MY_DBL_MIN 1.17549435E-38L
9545 if ((intsize == 'q') && (c == 'f') &&
9546 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9548 /* it's going to be short enough that
9549 * long double precision is not needed */
9551 if ((nv <= 0L) && (nv >= -0L))
9552 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9554 /* would use Perl_fp_class as a double-check but not
9555 * functional on IRIX - see perl.h comments */
9557 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9558 /* It's within the range that a double can represent */
9559 #if defined(DBL_MAX) && !defined(DBL_MIN)
9560 if ((nv >= ((long double)1/DBL_MAX)) ||
9561 (nv <= (-(long double)1/DBL_MAX)))
9563 fix_ldbl_sprintf_bug = TRUE;
9566 if (fix_ldbl_sprintf_bug == TRUE) {
9576 # undef MY_DBL_MAX_BUG
9579 #endif /* HAS_LDBL_SPRINTF_BUG */
9581 need += 20; /* fudge factor */
9582 if (PL_efloatsize < need) {
9583 Safefree(PL_efloatbuf);
9584 PL_efloatsize = need + 20; /* more fudge */
9585 New(906, PL_efloatbuf, PL_efloatsize, char);
9586 PL_efloatbuf[0] = '\0';
9589 if ( !(width || left || plus || alt) && fill != '0'
9590 && has_precis && intsize != 'q' ) { /* Shortcuts */
9591 /* See earlier comment about buggy Gconvert when digits,
9593 if ( c == 'g' && precis) {
9594 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9595 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9596 goto float_converted;
9597 } else if ( c == 'f' && !precis) {
9598 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9603 char *ptr = ebuf + sizeof ebuf;
9606 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9607 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9608 if (intsize == 'q') {
9609 /* Copy the one or more characters in a long double
9610 * format before the 'base' ([efgEFG]) character to
9611 * the format string. */
9612 static char const prifldbl[] = PERL_PRIfldbl;
9613 char const *p = prifldbl + sizeof(prifldbl) - 3;
9614 while (p >= prifldbl) { *--ptr = *p--; }
9619 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9624 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9636 /* No taint. Otherwise we are in the strange situation
9637 * where printf() taints but print($float) doesn't.
9639 #if defined(HAS_LONG_DOUBLE)
9641 (void)sprintf(PL_efloatbuf, ptr, nv);
9643 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9645 (void)sprintf(PL_efloatbuf, ptr, nv);
9649 eptr = PL_efloatbuf;
9650 elen = strlen(PL_efloatbuf);
9656 i = SvCUR(sv) - origlen;
9657 if (args && !vectorize) {
9659 case 'h': *(va_arg(*args, short*)) = i; break;
9660 default: *(va_arg(*args, int*)) = i; break;
9661 case 'l': *(va_arg(*args, long*)) = i; break;
9662 case 'V': *(va_arg(*args, IV*)) = i; break;
9664 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9669 sv_setuv_mg(argsv, (UV)i);
9671 continue; /* not "break" */
9677 if (!args && ckWARN(WARN_PRINTF) &&
9678 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9679 SV *msg = sv_newmortal();
9680 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9681 (PL_op->op_type == OP_PRTF) ? "" : "s");
9684 Perl_sv_catpvf(aTHX_ msg,
9685 "\"%%%c\"", c & 0xFF);
9687 Perl_sv_catpvf(aTHX_ msg,
9688 "\"%%\\%03"UVof"\"",
9691 sv_catpv(msg, "end of string");
9692 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9695 /* output mangled stuff ... */
9701 /* ... right here, because formatting flags should not apply */
9702 SvGROW(sv, SvCUR(sv) + elen + 1);
9704 Copy(eptr, p, elen, char);
9707 SvCUR_set(sv, p - SvPVX_const(sv));
9709 continue; /* not "break" */
9712 /* calculate width before utf8_upgrade changes it */
9713 have = esignlen + zeros + elen;
9715 if (is_utf8 != has_utf8) {
9718 sv_utf8_upgrade(sv);
9721 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9722 sv_utf8_upgrade(nsv);
9723 eptr = SvPVX_const(nsv);
9726 SvGROW(sv, SvCUR(sv) + elen + 1);
9731 need = (have > width ? have : width);
9734 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9736 if (esignlen && fill == '0') {
9738 for (i = 0; i < (int)esignlen; i++)
9742 memset(p, fill, gap);
9745 if (esignlen && fill != '0') {
9747 for (i = 0; i < (int)esignlen; i++)
9752 for (i = zeros; i; i--)
9756 Copy(eptr, p, elen, char);
9760 memset(p, ' ', gap);
9765 Copy(dotstr, p, dotstrlen, char);
9769 vectorize = FALSE; /* done iterating over vecstr */
9776 SvCUR_set(sv, p - SvPVX_const(sv));
9784 /* =========================================================================
9786 =head1 Cloning an interpreter
9788 All the macros and functions in this section are for the private use of
9789 the main function, perl_clone().
9791 The foo_dup() functions make an exact copy of an existing foo thinngy.
9792 During the course of a cloning, a hash table is used to map old addresses
9793 to new addresses. The table is created and manipulated with the
9794 ptr_table_* functions.
9798 ============================================================================*/
9801 #if defined(USE_ITHREADS)
9803 #ifndef GpREFCNT_inc
9804 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9808 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9809 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9810 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9811 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9812 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9813 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9814 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9815 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9816 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9817 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9818 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9819 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9820 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9823 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9824 regcomp.c. AMS 20010712 */
9827 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9832 struct reg_substr_datum *s;
9835 return (REGEXP *)NULL;
9837 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9840 len = r->offsets[0];
9841 npar = r->nparens+1;
9843 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9844 Copy(r->program, ret->program, len+1, regnode);
9846 New(0, ret->startp, npar, I32);
9847 Copy(r->startp, ret->startp, npar, I32);
9848 New(0, ret->endp, npar, I32);
9849 Copy(r->startp, ret->startp, npar, I32);
9851 New(0, ret->substrs, 1, struct reg_substr_data);
9852 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9853 s->min_offset = r->substrs->data[i].min_offset;
9854 s->max_offset = r->substrs->data[i].max_offset;
9855 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9856 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9859 ret->regstclass = NULL;
9862 const int count = r->data->count;
9865 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9866 char, struct reg_data);
9867 New(0, d->what, count, U8);
9870 for (i = 0; i < count; i++) {
9871 d->what[i] = r->data->what[i];
9872 switch (d->what[i]) {
9873 /* legal options are one of: sfpont
9874 see also regcomp.h and pregfree() */
9876 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9879 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9882 /* This is cheating. */
9883 New(0, d->data[i], 1, struct regnode_charclass_class);
9884 StructCopy(r->data->data[i], d->data[i],
9885 struct regnode_charclass_class);
9886 ret->regstclass = (regnode*)d->data[i];
9889 /* Compiled op trees are readonly, and can thus be
9890 shared without duplication. */
9892 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9896 d->data[i] = r->data->data[i];
9899 d->data[i] = r->data->data[i];
9901 ((reg_trie_data*)d->data[i])->refcount++;
9905 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9914 New(0, ret->offsets, 2*len+1, U32);
9915 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9917 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9918 ret->refcnt = r->refcnt;
9919 ret->minlen = r->minlen;
9920 ret->prelen = r->prelen;
9921 ret->nparens = r->nparens;
9922 ret->lastparen = r->lastparen;
9923 ret->lastcloseparen = r->lastcloseparen;
9924 ret->reganch = r->reganch;
9926 ret->sublen = r->sublen;
9928 if (RX_MATCH_COPIED(ret))
9929 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9931 ret->subbeg = Nullch;
9932 #ifdef PERL_OLD_COPY_ON_WRITE
9933 ret->saved_copy = Nullsv;
9936 ptr_table_store(PL_ptr_table, r, ret);
9940 /* duplicate a file handle */
9943 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9947 PERL_UNUSED_ARG(type);
9950 return (PerlIO*)NULL;
9952 /* look for it in the table first */
9953 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9957 /* create anew and remember what it is */
9958 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9959 ptr_table_store(PL_ptr_table, fp, ret);
9963 /* duplicate a directory handle */
9966 Perl_dirp_dup(pTHX_ DIR *dp)
9974 /* duplicate a typeglob */
9977 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9982 /* look for it in the table first */
9983 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9987 /* create anew and remember what it is */
9988 Newz(0, ret, 1, GP);
9989 ptr_table_store(PL_ptr_table, gp, ret);
9992 ret->gp_refcnt = 0; /* must be before any other dups! */
9993 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9994 ret->gp_io = io_dup_inc(gp->gp_io, param);
9995 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9996 ret->gp_av = av_dup_inc(gp->gp_av, param);
9997 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9998 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9999 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10000 ret->gp_cvgen = gp->gp_cvgen;
10001 ret->gp_flags = gp->gp_flags;
10002 ret->gp_line = gp->gp_line;
10003 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10007 /* duplicate a chain of magic */
10010 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10012 MAGIC *mgprev = (MAGIC*)NULL;
10015 return (MAGIC*)NULL;
10016 /* look for it in the table first */
10017 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10021 for (; mg; mg = mg->mg_moremagic) {
10023 Newz(0, nmg, 1, MAGIC);
10025 mgprev->mg_moremagic = nmg;
10028 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10029 nmg->mg_private = mg->mg_private;
10030 nmg->mg_type = mg->mg_type;
10031 nmg->mg_flags = mg->mg_flags;
10032 if (mg->mg_type == PERL_MAGIC_qr) {
10033 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10035 else if(mg->mg_type == PERL_MAGIC_backref) {
10036 const AV * const av = (AV*) mg->mg_obj;
10039 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10041 for (i = AvFILLp(av); i >= 0; i--) {
10042 if (!svp[i]) continue;
10043 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10046 else if (mg->mg_type == PERL_MAGIC_symtab) {
10047 nmg->mg_obj = mg->mg_obj;
10050 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10051 ? sv_dup_inc(mg->mg_obj, param)
10052 : sv_dup(mg->mg_obj, param);
10054 nmg->mg_len = mg->mg_len;
10055 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10056 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10057 if (mg->mg_len > 0) {
10058 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10059 if (mg->mg_type == PERL_MAGIC_overload_table &&
10060 AMT_AMAGIC((AMT*)mg->mg_ptr))
10062 AMT *amtp = (AMT*)mg->mg_ptr;
10063 AMT *namtp = (AMT*)nmg->mg_ptr;
10065 for (i = 1; i < NofAMmeth; i++) {
10066 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10070 else if (mg->mg_len == HEf_SVKEY)
10071 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10073 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10074 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10081 /* create a new pointer-mapping table */
10084 Perl_ptr_table_new(pTHX)
10087 Newz(0, tbl, 1, PTR_TBL_t);
10088 tbl->tbl_max = 511;
10089 tbl->tbl_items = 0;
10090 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10095 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10097 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10100 #define new_pte() new_body(struct ptr_tbl_ent, pte)
10101 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
10103 /* map an existing pointer using a table */
10106 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10108 PTR_TBL_ENT_t *tblent;
10109 const UV hash = PTR_TABLE_HASH(sv);
10111 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10112 for (; tblent; tblent = tblent->next) {
10113 if (tblent->oldval == sv)
10114 return tblent->newval;
10116 return (void*)NULL;
10119 /* add a new entry to a pointer-mapping table */
10122 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldv, void *newv)
10124 PTR_TBL_ENT_t *tblent, **otblent;
10125 /* XXX this may be pessimal on platforms where pointers aren't good
10126 * hash values e.g. if they grow faster in the most significant
10128 const UV hash = PTR_TABLE_HASH(oldv);
10132 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10133 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10134 if (tblent->oldval == oldv) {
10135 tblent->newval = newv;
10139 tblent = new_pte();
10140 tblent->oldval = oldv;
10141 tblent->newval = newv;
10142 tblent->next = *otblent;
10145 if (!empty && tbl->tbl_items > tbl->tbl_max)
10146 ptr_table_split(tbl);
10149 /* double the hash bucket size of an existing ptr table */
10152 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10154 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10155 const UV oldsize = tbl->tbl_max + 1;
10156 UV newsize = oldsize * 2;
10159 Renew(ary, newsize, PTR_TBL_ENT_t*);
10160 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10161 tbl->tbl_max = --newsize;
10162 tbl->tbl_ary = ary;
10163 for (i=0; i < oldsize; i++, ary++) {
10164 PTR_TBL_ENT_t **curentp, **entp, *ent;
10167 curentp = ary + oldsize;
10168 for (entp = ary, ent = *ary; ent; ent = *entp) {
10169 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10171 ent->next = *curentp;
10181 /* remove all the entries from a ptr table */
10184 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10186 register PTR_TBL_ENT_t **array;
10187 register PTR_TBL_ENT_t *entry;
10191 if (!tbl || !tbl->tbl_items) {
10195 array = tbl->tbl_ary;
10197 max = tbl->tbl_max;
10201 PTR_TBL_ENT_t *oentry = entry;
10202 entry = entry->next;
10206 if (++riter > max) {
10209 entry = array[riter];
10213 tbl->tbl_items = 0;
10216 /* clear and free a ptr table */
10219 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10224 ptr_table_clear(tbl);
10225 Safefree(tbl->tbl_ary);
10229 /* attempt to make everything in the typeglob readonly */
10232 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10234 GV *gv = (GV*)sstr;
10235 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10237 if (GvIO(gv) || GvFORM(gv)) {
10238 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10240 else if (!GvCV(gv)) {
10241 GvCV(gv) = (CV*)sv;
10244 /* CvPADLISTs cannot be shared */
10245 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10250 if (!GvUNIQUE(gv)) {
10252 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10253 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10259 * write attempts will die with
10260 * "Modification of a read-only value attempted"
10266 SvREADONLY_on(GvSV(gv));
10270 GvAV(gv) = (AV*)sv;
10273 SvREADONLY_on(GvAV(gv));
10277 GvHV(gv) = (HV*)sv;
10280 SvREADONLY_on(GvHV(gv));
10283 return sstr; /* he_dup() will SvREFCNT_inc() */
10287 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10290 SvRV_set(dstr, SvWEAKREF(sstr)
10291 ? sv_dup(SvRV(sstr), param)
10292 : sv_dup_inc(SvRV(sstr), param));
10295 else if (SvPVX_const(sstr)) {
10296 /* Has something there */
10298 /* Normal PV - clone whole allocated space */
10299 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10300 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10301 /* Not that normal - actually sstr is copy on write.
10302 But we are a true, independant SV, so: */
10303 SvREADONLY_off(dstr);
10308 /* Special case - not normally malloced for some reason */
10309 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10310 /* A "shared" PV - clone it as "shared" PV */
10312 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10316 /* Some other special case - random pointer */
10317 SvPV_set(dstr, SvPVX(sstr));
10322 /* Copy the Null */
10323 if (SvTYPE(dstr) == SVt_RV)
10324 SvRV_set(dstr, NULL);
10330 /* duplicate an SV of any type (including AV, HV etc) */
10333 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10338 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10340 /* look for it in the table first */
10341 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10345 if(param->flags & CLONEf_JOIN_IN) {
10346 /** We are joining here so we don't want do clone
10347 something that is bad **/
10348 const char *hvname;
10350 if(SvTYPE(sstr) == SVt_PVHV &&
10351 (hvname = HvNAME_get(sstr))) {
10352 /** don't clone stashes if they already exist **/
10353 HV* old_stash = gv_stashpv(hvname,0);
10354 return (SV*) old_stash;
10358 /* create anew and remember what it is */
10361 #ifdef DEBUG_LEAKING_SCALARS
10362 dstr->sv_debug_optype = sstr->sv_debug_optype;
10363 dstr->sv_debug_line = sstr->sv_debug_line;
10364 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10365 dstr->sv_debug_cloned = 1;
10367 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10369 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10373 ptr_table_store(PL_ptr_table, sstr, dstr);
10376 SvFLAGS(dstr) = SvFLAGS(sstr);
10377 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10378 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10381 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10382 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10383 PL_watch_pvx, SvPVX_const(sstr));
10386 /* don't clone objects whose class has asked us not to */
10387 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10388 SvFLAGS(dstr) &= ~SVTYPEMASK;
10389 SvOBJECT_off(dstr);
10393 switch (SvTYPE(sstr)) {
10395 SvANY(dstr) = NULL;
10398 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10399 SvIV_set(dstr, SvIVX(sstr));
10402 SvANY(dstr) = new_XNV();
10403 SvNV_set(dstr, SvNVX(sstr));
10406 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10407 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10411 /* These are all the types that need complex bodies allocating. */
10412 size_t new_body_length;
10413 size_t new_body_offset = 0;
10414 void **new_body_arena;
10415 void **new_body_arenaroot;
10418 switch (SvTYPE(sstr)) {
10420 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10425 new_body = new_XPVIO();
10426 new_body_length = sizeof(XPVIO);
10429 new_body = new_XPVFM();
10430 new_body_length = sizeof(XPVFM);
10434 new_body_arena = (void **) &PL_xpvhv_root;
10435 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10436 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10437 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10438 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10439 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10443 new_body_arena = (void **) &PL_xpvav_root;
10444 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10445 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10446 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10447 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10448 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10452 new_body_length = sizeof(XPVBM);
10453 new_body_arena = (void **) &PL_xpvbm_root;
10454 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10457 if (GvUNIQUE((GV*)sstr)) {
10459 if ((share = gv_share(sstr, param))) {
10462 ptr_table_store(PL_ptr_table, sstr, dstr);
10464 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10465 HvNAME_get(GvSTASH(share)), GvNAME(share));
10470 new_body_length = sizeof(XPVGV);
10471 new_body_arena = (void **) &PL_xpvgv_root;
10472 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10475 new_body_length = sizeof(XPVCV);
10476 new_body_arena = (void **) &PL_xpvcv_root;
10477 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10480 new_body_length = sizeof(XPVLV);
10481 new_body_arena = (void **) &PL_xpvlv_root;
10482 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10485 new_body_length = sizeof(XPVMG);
10486 new_body_arena = (void **) &PL_xpvmg_root;
10487 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10490 new_body_length = sizeof(XPVNV);
10491 new_body_arena = (void **) &PL_xpvnv_root;
10492 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10495 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10496 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10497 new_body_length = sizeof(XPVIV) - new_body_offset;
10498 new_body_arena = (void **) &PL_xpviv_root;
10499 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10502 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10503 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10504 new_body_length = sizeof(XPV) - new_body_offset;
10505 new_body_arena = (void **) &PL_xpv_root;
10506 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10508 assert(new_body_length);
10510 new_body = (void*)((char*)S_new_body(aTHX_ new_body_arenaroot,
10513 - new_body_offset);
10515 /* We always allocated the full length item with PURIFY */
10516 new_body_length += new_body_offset;
10517 new_body_offset = 0;
10518 new_body = my_safemalloc(new_body_length);
10522 SvANY(dstr) = new_body;
10524 Copy(((char*)SvANY(sstr)) + new_body_offset,
10525 ((char*)SvANY(dstr)) + new_body_offset,
10526 new_body_length, char);
10528 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10529 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10531 /* The Copy above means that all the source (unduplicated) pointers
10532 are now in the destination. We can check the flags and the
10533 pointers in either, but it's possible that there's less cache
10534 missing by always going for the destination.
10535 FIXME - instrument and check that assumption */
10536 if (SvTYPE(sstr) >= SVt_PVMG) {
10538 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10540 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10543 switch (SvTYPE(sstr)) {
10555 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10556 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10557 LvTARG(dstr) = dstr;
10558 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10559 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10561 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10564 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10565 GvSTASH(dstr) = hv_dup_inc(GvSTASH(dstr), param);
10566 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10567 (void)GpREFCNT_inc(GvGP(dstr));
10570 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10571 if (IoOFP(dstr) == IoIFP(sstr))
10572 IoOFP(dstr) = IoIFP(dstr);
10574 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10575 /* PL_rsfp_filters entries have fake IoDIRP() */
10576 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10577 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10578 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10579 /* I have no idea why fake dirp (rsfps)
10580 should be treated differently but otherwise
10581 we end up with leaks -- sky*/
10582 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10583 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10584 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10586 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10587 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10588 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10590 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10591 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10592 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10595 if (AvARRAY((AV*)sstr)) {
10596 SV **dst_ary, **src_ary;
10597 SSize_t items = AvFILLp((AV*)sstr) + 1;
10599 src_ary = AvARRAY((AV*)sstr);
10600 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10601 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10602 SvPV_set(dstr, (char*)dst_ary);
10603 AvALLOC((AV*)dstr) = dst_ary;
10604 if (AvREAL((AV*)sstr)) {
10605 while (items-- > 0)
10606 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10609 while (items-- > 0)
10610 *dst_ary++ = sv_dup(*src_ary++, param);
10612 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10613 while (items-- > 0) {
10614 *dst_ary++ = &PL_sv_undef;
10618 SvPV_set(dstr, Nullch);
10619 AvALLOC((AV*)dstr) = (SV**)NULL;
10626 if (HvARRAY((HV*)sstr)) {
10628 const bool sharekeys = !!HvSHAREKEYS(sstr);
10629 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10630 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10633 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10634 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10636 HvARRAY(dstr) = (HE**)darray;
10637 while (i <= sxhv->xhv_max) {
10638 HE *source = HvARRAY(sstr)[i];
10639 HvARRAY(dstr)[i] = source
10640 ? he_dup(source, sharekeys, param) : 0;
10644 struct xpvhv_aux *saux = HvAUX(sstr);
10645 struct xpvhv_aux *daux = HvAUX(dstr);
10646 /* This flag isn't copied. */
10647 /* SvOOK_on(hv) attacks the IV flags. */
10648 SvFLAGS(dstr) |= SVf_OOK;
10650 hvname = saux->xhv_name;
10652 = hvname ? hek_dup(hvname, param) : hvname;
10654 daux->xhv_riter = saux->xhv_riter;
10655 daux->xhv_eiter = saux->xhv_eiter
10656 ? he_dup(saux->xhv_eiter,
10657 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10661 SvPV_set(dstr, Nullch);
10663 /* Record stashes for possible cloning in Perl_clone(). */
10665 av_push(param->stashes, dstr);
10670 /* NOTE: not refcounted */
10671 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10673 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10675 if (CvCONST(dstr)) {
10676 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10677 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10678 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10680 /* don't dup if copying back - CvGV isn't refcounted, so the
10681 * duped GV may never be freed. A bit of a hack! DAPM */
10682 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10683 Nullgv : gv_dup(CvGV(dstr), param) ;
10684 if (!(param->flags & CLONEf_COPY_STACKS)) {
10687 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10689 CvWEAKOUTSIDE(sstr)
10690 ? cv_dup( CvOUTSIDE(dstr), param)
10691 : cv_dup_inc(CvOUTSIDE(dstr), param);
10693 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10700 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10706 /* duplicate a context */
10709 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10711 PERL_CONTEXT *ncxs;
10714 return (PERL_CONTEXT*)NULL;
10716 /* look for it in the table first */
10717 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10721 /* create anew and remember what it is */
10722 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10723 ptr_table_store(PL_ptr_table, cxs, ncxs);
10726 PERL_CONTEXT *cx = &cxs[ix];
10727 PERL_CONTEXT *ncx = &ncxs[ix];
10728 ncx->cx_type = cx->cx_type;
10729 if (CxTYPE(cx) == CXt_SUBST) {
10730 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10733 ncx->blk_oldsp = cx->blk_oldsp;
10734 ncx->blk_oldcop = cx->blk_oldcop;
10735 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10736 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10737 ncx->blk_oldpm = cx->blk_oldpm;
10738 ncx->blk_gimme = cx->blk_gimme;
10739 switch (CxTYPE(cx)) {
10741 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10742 ? cv_dup_inc(cx->blk_sub.cv, param)
10743 : cv_dup(cx->blk_sub.cv,param));
10744 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10745 ? av_dup_inc(cx->blk_sub.argarray, param)
10747 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10748 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10749 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10750 ncx->blk_sub.lval = cx->blk_sub.lval;
10751 ncx->blk_sub.retop = cx->blk_sub.retop;
10754 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10755 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10756 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10757 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10758 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10759 ncx->blk_eval.retop = cx->blk_eval.retop;
10762 ncx->blk_loop.label = cx->blk_loop.label;
10763 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10764 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10765 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10766 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10767 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10768 ? cx->blk_loop.iterdata
10769 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10770 ncx->blk_loop.oldcomppad
10771 = (PAD*)ptr_table_fetch(PL_ptr_table,
10772 cx->blk_loop.oldcomppad);
10773 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10774 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10775 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10776 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10777 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10780 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10781 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10782 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10783 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10784 ncx->blk_sub.retop = cx->blk_sub.retop;
10796 /* duplicate a stack info structure */
10799 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10804 return (PERL_SI*)NULL;
10806 /* look for it in the table first */
10807 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10811 /* create anew and remember what it is */
10812 Newz(56, nsi, 1, PERL_SI);
10813 ptr_table_store(PL_ptr_table, si, nsi);
10815 nsi->si_stack = av_dup_inc(si->si_stack, param);
10816 nsi->si_cxix = si->si_cxix;
10817 nsi->si_cxmax = si->si_cxmax;
10818 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10819 nsi->si_type = si->si_type;
10820 nsi->si_prev = si_dup(si->si_prev, param);
10821 nsi->si_next = si_dup(si->si_next, param);
10822 nsi->si_markoff = si->si_markoff;
10827 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10828 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10829 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10830 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10831 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10832 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10833 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10834 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10835 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10836 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10837 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10838 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10839 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10840 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10843 #define pv_dup_inc(p) SAVEPV(p)
10844 #define pv_dup(p) SAVEPV(p)
10845 #define svp_dup_inc(p,pp) any_dup(p,pp)
10847 /* map any object to the new equivent - either something in the
10848 * ptr table, or something in the interpreter structure
10852 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10857 return (void*)NULL;
10859 /* look for it in the table first */
10860 ret = ptr_table_fetch(PL_ptr_table, v);
10864 /* see if it is part of the interpreter structure */
10865 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10866 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10874 /* duplicate the save stack */
10877 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10879 ANY * const ss = proto_perl->Tsavestack;
10880 const I32 max = proto_perl->Tsavestack_max;
10881 I32 ix = proto_perl->Tsavestack_ix;
10893 void (*dptr) (void*);
10894 void (*dxptr) (pTHX_ void*);
10896 Newz(54, nss, max, ANY);
10899 I32 i = POPINT(ss,ix);
10900 TOPINT(nss,ix) = i;
10902 case SAVEt_ITEM: /* normal string */
10903 sv = (SV*)POPPTR(ss,ix);
10904 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10905 sv = (SV*)POPPTR(ss,ix);
10906 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10908 case SAVEt_SV: /* scalar reference */
10909 sv = (SV*)POPPTR(ss,ix);
10910 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10911 gv = (GV*)POPPTR(ss,ix);
10912 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10914 case SAVEt_GENERIC_PVREF: /* generic char* */
10915 c = (char*)POPPTR(ss,ix);
10916 TOPPTR(nss,ix) = pv_dup(c);
10917 ptr = POPPTR(ss,ix);
10918 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10920 case SAVEt_SHARED_PVREF: /* char* in shared space */
10921 c = (char*)POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = savesharedpv(c);
10923 ptr = POPPTR(ss,ix);
10924 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10926 case SAVEt_GENERIC_SVREF: /* generic sv */
10927 case SAVEt_SVREF: /* scalar reference */
10928 sv = (SV*)POPPTR(ss,ix);
10929 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10930 ptr = POPPTR(ss,ix);
10931 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10933 case SAVEt_AV: /* array reference */
10934 av = (AV*)POPPTR(ss,ix);
10935 TOPPTR(nss,ix) = av_dup_inc(av, param);
10936 gv = (GV*)POPPTR(ss,ix);
10937 TOPPTR(nss,ix) = gv_dup(gv, param);
10939 case SAVEt_HV: /* hash reference */
10940 hv = (HV*)POPPTR(ss,ix);
10941 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10942 gv = (GV*)POPPTR(ss,ix);
10943 TOPPTR(nss,ix) = gv_dup(gv, param);
10945 case SAVEt_INT: /* int reference */
10946 ptr = POPPTR(ss,ix);
10947 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10948 intval = (int)POPINT(ss,ix);
10949 TOPINT(nss,ix) = intval;
10951 case SAVEt_LONG: /* long reference */
10952 ptr = POPPTR(ss,ix);
10953 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10954 longval = (long)POPLONG(ss,ix);
10955 TOPLONG(nss,ix) = longval;
10957 case SAVEt_I32: /* I32 reference */
10958 case SAVEt_I16: /* I16 reference */
10959 case SAVEt_I8: /* I8 reference */
10960 ptr = POPPTR(ss,ix);
10961 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10963 TOPINT(nss,ix) = i;
10965 case SAVEt_IV: /* IV reference */
10966 ptr = POPPTR(ss,ix);
10967 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10969 TOPIV(nss,ix) = iv;
10971 case SAVEt_SPTR: /* SV* reference */
10972 ptr = POPPTR(ss,ix);
10973 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10974 sv = (SV*)POPPTR(ss,ix);
10975 TOPPTR(nss,ix) = sv_dup(sv, param);
10977 case SAVEt_VPTR: /* random* reference */
10978 ptr = POPPTR(ss,ix);
10979 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10980 ptr = POPPTR(ss,ix);
10981 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10983 case SAVEt_PPTR: /* char* reference */
10984 ptr = POPPTR(ss,ix);
10985 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10986 c = (char*)POPPTR(ss,ix);
10987 TOPPTR(nss,ix) = pv_dup(c);
10989 case SAVEt_HPTR: /* HV* reference */
10990 ptr = POPPTR(ss,ix);
10991 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10992 hv = (HV*)POPPTR(ss,ix);
10993 TOPPTR(nss,ix) = hv_dup(hv, param);
10995 case SAVEt_APTR: /* AV* reference */
10996 ptr = POPPTR(ss,ix);
10997 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10998 av = (AV*)POPPTR(ss,ix);
10999 TOPPTR(nss,ix) = av_dup(av, param);
11002 gv = (GV*)POPPTR(ss,ix);
11003 TOPPTR(nss,ix) = gv_dup(gv, param);
11005 case SAVEt_GP: /* scalar reference */
11006 gp = (GP*)POPPTR(ss,ix);
11007 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11008 (void)GpREFCNT_inc(gp);
11009 gv = (GV*)POPPTR(ss,ix);
11010 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11011 c = (char*)POPPTR(ss,ix);
11012 TOPPTR(nss,ix) = pv_dup(c);
11014 TOPIV(nss,ix) = iv;
11016 TOPIV(nss,ix) = iv;
11019 case SAVEt_MORTALIZESV:
11020 sv = (SV*)POPPTR(ss,ix);
11021 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11024 ptr = POPPTR(ss,ix);
11025 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11026 /* these are assumed to be refcounted properly */
11028 switch (((OP*)ptr)->op_type) {
11030 case OP_LEAVESUBLV:
11034 case OP_LEAVEWRITE:
11035 TOPPTR(nss,ix) = ptr;
11040 TOPPTR(nss,ix) = Nullop;
11045 TOPPTR(nss,ix) = Nullop;
11048 c = (char*)POPPTR(ss,ix);
11049 TOPPTR(nss,ix) = pv_dup_inc(c);
11051 case SAVEt_CLEARSV:
11052 longval = POPLONG(ss,ix);
11053 TOPLONG(nss,ix) = longval;
11056 hv = (HV*)POPPTR(ss,ix);
11057 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11058 c = (char*)POPPTR(ss,ix);
11059 TOPPTR(nss,ix) = pv_dup_inc(c);
11061 TOPINT(nss,ix) = i;
11063 case SAVEt_DESTRUCTOR:
11064 ptr = POPPTR(ss,ix);
11065 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11066 dptr = POPDPTR(ss,ix);
11067 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11068 any_dup(FPTR2DPTR(void *, dptr),
11071 case SAVEt_DESTRUCTOR_X:
11072 ptr = POPPTR(ss,ix);
11073 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11074 dxptr = POPDXPTR(ss,ix);
11075 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11076 any_dup(FPTR2DPTR(void *, dxptr),
11079 case SAVEt_REGCONTEXT:
11082 TOPINT(nss,ix) = i;
11085 case SAVEt_STACK_POS: /* Position on Perl stack */
11087 TOPINT(nss,ix) = i;
11089 case SAVEt_AELEM: /* array element */
11090 sv = (SV*)POPPTR(ss,ix);
11091 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11093 TOPINT(nss,ix) = i;
11094 av = (AV*)POPPTR(ss,ix);
11095 TOPPTR(nss,ix) = av_dup_inc(av, param);
11097 case SAVEt_HELEM: /* hash element */
11098 sv = (SV*)POPPTR(ss,ix);
11099 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11100 sv = (SV*)POPPTR(ss,ix);
11101 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11102 hv = (HV*)POPPTR(ss,ix);
11103 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11106 ptr = POPPTR(ss,ix);
11107 TOPPTR(nss,ix) = ptr;
11111 TOPINT(nss,ix) = i;
11113 case SAVEt_COMPPAD:
11114 av = (AV*)POPPTR(ss,ix);
11115 TOPPTR(nss,ix) = av_dup(av, param);
11118 longval = (long)POPLONG(ss,ix);
11119 TOPLONG(nss,ix) = longval;
11120 ptr = POPPTR(ss,ix);
11121 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11122 sv = (SV*)POPPTR(ss,ix);
11123 TOPPTR(nss,ix) = sv_dup(sv, param);
11126 ptr = POPPTR(ss,ix);
11127 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11128 longval = (long)POPBOOL(ss,ix);
11129 TOPBOOL(nss,ix) = (bool)longval;
11131 case SAVEt_SET_SVFLAGS:
11133 TOPINT(nss,ix) = i;
11135 TOPINT(nss,ix) = i;
11136 sv = (SV*)POPPTR(ss,ix);
11137 TOPPTR(nss,ix) = sv_dup(sv, param);
11140 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11148 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11149 * flag to the result. This is done for each stash before cloning starts,
11150 * so we know which stashes want their objects cloned */
11153 do_mark_cloneable_stash(pTHX_ SV *sv)
11155 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11157 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11158 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11159 if (cloner && GvCV(cloner)) {
11166 XPUSHs(sv_2mortal(newSVhek(hvname)));
11168 call_sv((SV*)GvCV(cloner), G_SCALAR);
11175 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11183 =for apidoc perl_clone
11185 Create and return a new interpreter by cloning the current one.
11187 perl_clone takes these flags as parameters:
11189 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11190 without it we only clone the data and zero the stacks,
11191 with it we copy the stacks and the new perl interpreter is
11192 ready to run at the exact same point as the previous one.
11193 The pseudo-fork code uses COPY_STACKS while the
11194 threads->new doesn't.
11196 CLONEf_KEEP_PTR_TABLE
11197 perl_clone keeps a ptr_table with the pointer of the old
11198 variable as a key and the new variable as a value,
11199 this allows it to check if something has been cloned and not
11200 clone it again but rather just use the value and increase the
11201 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11202 the ptr_table using the function
11203 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11204 reason to keep it around is if you want to dup some of your own
11205 variable who are outside the graph perl scans, example of this
11206 code is in threads.xs create
11209 This is a win32 thing, it is ignored on unix, it tells perls
11210 win32host code (which is c++) to clone itself, this is needed on
11211 win32 if you want to run two threads at the same time,
11212 if you just want to do some stuff in a separate perl interpreter
11213 and then throw it away and return to the original one,
11214 you don't need to do anything.
11219 /* XXX the above needs expanding by someone who actually understands it ! */
11220 EXTERN_C PerlInterpreter *
11221 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11224 perl_clone(PerlInterpreter *proto_perl, UV flags)
11227 #ifdef PERL_IMPLICIT_SYS
11229 /* perlhost.h so we need to call into it
11230 to clone the host, CPerlHost should have a c interface, sky */
11232 if (flags & CLONEf_CLONE_HOST) {
11233 return perl_clone_host(proto_perl,flags);
11235 return perl_clone_using(proto_perl, flags,
11237 proto_perl->IMemShared,
11238 proto_perl->IMemParse,
11240 proto_perl->IStdIO,
11244 proto_perl->IProc);
11248 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11249 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11250 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11251 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11252 struct IPerlDir* ipD, struct IPerlSock* ipS,
11253 struct IPerlProc* ipP)
11255 /* XXX many of the string copies here can be optimized if they're
11256 * constants; they need to be allocated as common memory and just
11257 * their pointers copied. */
11260 CLONE_PARAMS clone_params;
11261 CLONE_PARAMS* param = &clone_params;
11263 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11264 /* for each stash, determine whether its objects should be cloned */
11265 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11266 PERL_SET_THX(my_perl);
11269 Poison(my_perl, 1, PerlInterpreter);
11271 PL_curcop = (COP *)Nullop;
11275 PL_savestack_ix = 0;
11276 PL_savestack_max = -1;
11277 PL_sig_pending = 0;
11278 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11279 # else /* !DEBUGGING */
11280 Zero(my_perl, 1, PerlInterpreter);
11281 # endif /* DEBUGGING */
11283 /* host pointers */
11285 PL_MemShared = ipMS;
11286 PL_MemParse = ipMP;
11293 #else /* !PERL_IMPLICIT_SYS */
11295 CLONE_PARAMS clone_params;
11296 CLONE_PARAMS* param = &clone_params;
11297 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11298 /* for each stash, determine whether its objects should be cloned */
11299 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11300 PERL_SET_THX(my_perl);
11303 Poison(my_perl, 1, PerlInterpreter);
11305 PL_curcop = (COP *)Nullop;
11309 PL_savestack_ix = 0;
11310 PL_savestack_max = -1;
11311 PL_sig_pending = 0;
11312 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11313 # else /* !DEBUGGING */
11314 Zero(my_perl, 1, PerlInterpreter);
11315 # endif /* DEBUGGING */
11316 #endif /* PERL_IMPLICIT_SYS */
11317 param->flags = flags;
11318 param->proto_perl = proto_perl;
11321 PL_xnv_arenaroot = NULL;
11322 PL_xnv_root = NULL;
11323 PL_xpv_arenaroot = NULL;
11324 PL_xpv_root = NULL;
11325 PL_xpviv_arenaroot = NULL;
11326 PL_xpviv_root = NULL;
11327 PL_xpvnv_arenaroot = NULL;
11328 PL_xpvnv_root = NULL;
11329 PL_xpvcv_arenaroot = NULL;
11330 PL_xpvcv_root = NULL;
11331 PL_xpvav_arenaroot = NULL;
11332 PL_xpvav_root = NULL;
11333 PL_xpvhv_arenaroot = NULL;
11334 PL_xpvhv_root = NULL;
11335 PL_xpvmg_arenaroot = NULL;
11336 PL_xpvmg_root = NULL;
11337 PL_xpvgv_arenaroot = NULL;
11338 PL_xpvgv_root = NULL;
11339 PL_xpvlv_arenaroot = NULL;
11340 PL_xpvlv_root = NULL;
11341 PL_xpvbm_arenaroot = NULL;
11342 PL_xpvbm_root = NULL;
11343 PL_he_arenaroot = NULL;
11345 #if defined(USE_ITHREADS)
11346 PL_pte_arenaroot = NULL;
11347 PL_pte_root = NULL;
11349 PL_nice_chunk = NULL;
11350 PL_nice_chunk_size = 0;
11352 PL_sv_objcount = 0;
11353 PL_sv_root = Nullsv;
11354 PL_sv_arenaroot = Nullsv;
11356 PL_debug = proto_perl->Idebug;
11358 PL_hash_seed = proto_perl->Ihash_seed;
11359 PL_rehash_seed = proto_perl->Irehash_seed;
11361 #ifdef USE_REENTRANT_API
11362 /* XXX: things like -Dm will segfault here in perlio, but doing
11363 * PERL_SET_CONTEXT(proto_perl);
11364 * breaks too many other things
11366 Perl_reentrant_init(aTHX);
11369 /* create SV map for pointer relocation */
11370 PL_ptr_table = ptr_table_new();
11372 /* initialize these special pointers as early as possible */
11373 SvANY(&PL_sv_undef) = NULL;
11374 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11375 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11376 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11378 SvANY(&PL_sv_no) = new_XPVNV();
11379 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11380 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11381 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11382 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11383 SvCUR_set(&PL_sv_no, 0);
11384 SvLEN_set(&PL_sv_no, 1);
11385 SvIV_set(&PL_sv_no, 0);
11386 SvNV_set(&PL_sv_no, 0);
11387 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11389 SvANY(&PL_sv_yes) = new_XPVNV();
11390 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11391 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11392 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11393 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11394 SvCUR_set(&PL_sv_yes, 1);
11395 SvLEN_set(&PL_sv_yes, 2);
11396 SvIV_set(&PL_sv_yes, 1);
11397 SvNV_set(&PL_sv_yes, 1);
11398 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11400 /* create (a non-shared!) shared string table */
11401 PL_strtab = newHV();
11402 HvSHAREKEYS_off(PL_strtab);
11403 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11404 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11406 PL_compiling = proto_perl->Icompiling;
11408 /* These two PVs will be free'd special way so must set them same way op.c does */
11409 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11410 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11412 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11413 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11415 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11416 if (!specialWARN(PL_compiling.cop_warnings))
11417 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11418 if (!specialCopIO(PL_compiling.cop_io))
11419 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11420 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11422 /* pseudo environmental stuff */
11423 PL_origargc = proto_perl->Iorigargc;
11424 PL_origargv = proto_perl->Iorigargv;
11426 param->stashes = newAV(); /* Setup array of objects to call clone on */
11428 #ifdef PERLIO_LAYERS
11429 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11430 PerlIO_clone(aTHX_ proto_perl, param);
11433 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11434 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11435 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11436 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11437 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11438 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11441 PL_minus_c = proto_perl->Iminus_c;
11442 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11443 PL_localpatches = proto_perl->Ilocalpatches;
11444 PL_splitstr = proto_perl->Isplitstr;
11445 PL_preprocess = proto_perl->Ipreprocess;
11446 PL_minus_n = proto_perl->Iminus_n;
11447 PL_minus_p = proto_perl->Iminus_p;
11448 PL_minus_l = proto_perl->Iminus_l;
11449 PL_minus_a = proto_perl->Iminus_a;
11450 PL_minus_F = proto_perl->Iminus_F;
11451 PL_doswitches = proto_perl->Idoswitches;
11452 PL_dowarn = proto_perl->Idowarn;
11453 PL_doextract = proto_perl->Idoextract;
11454 PL_sawampersand = proto_perl->Isawampersand;
11455 PL_unsafe = proto_perl->Iunsafe;
11456 PL_inplace = SAVEPV(proto_perl->Iinplace);
11457 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11458 PL_perldb = proto_perl->Iperldb;
11459 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11460 PL_exit_flags = proto_perl->Iexit_flags;
11462 /* magical thingies */
11463 /* XXX time(&PL_basetime) when asked for? */
11464 PL_basetime = proto_perl->Ibasetime;
11465 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11467 PL_maxsysfd = proto_perl->Imaxsysfd;
11468 PL_multiline = proto_perl->Imultiline;
11469 PL_statusvalue = proto_perl->Istatusvalue;
11471 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11473 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11475 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11476 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11477 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11479 /* Clone the regex array */
11480 PL_regex_padav = newAV();
11482 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11483 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11485 av_push(PL_regex_padav,
11486 sv_dup_inc(regexen[0],param));
11487 for(i = 1; i <= len; i++) {
11488 if(SvREPADTMP(regexen[i])) {
11489 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11491 av_push(PL_regex_padav,
11493 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11494 SvIVX(regexen[i])), param)))
11499 PL_regex_pad = AvARRAY(PL_regex_padav);
11501 /* shortcuts to various I/O objects */
11502 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11503 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11504 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11505 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11506 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11507 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11509 /* shortcuts to regexp stuff */
11510 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11512 /* shortcuts to misc objects */
11513 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11515 /* shortcuts to debugging objects */
11516 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11517 PL_DBline = gv_dup(proto_perl->IDBline, param);
11518 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11519 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11520 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11521 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11522 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11523 PL_lineary = av_dup(proto_perl->Ilineary, param);
11524 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11526 /* symbol tables */
11527 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11528 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11529 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11530 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11531 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11533 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11534 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11535 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11536 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11537 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11538 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11540 PL_sub_generation = proto_perl->Isub_generation;
11542 /* funky return mechanisms */
11543 PL_forkprocess = proto_perl->Iforkprocess;
11545 /* subprocess state */
11546 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11548 /* internal state */
11549 PL_tainting = proto_perl->Itainting;
11550 PL_taint_warn = proto_perl->Itaint_warn;
11551 PL_maxo = proto_perl->Imaxo;
11552 if (proto_perl->Iop_mask)
11553 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11555 PL_op_mask = Nullch;
11556 /* PL_asserting = proto_perl->Iasserting; */
11558 /* current interpreter roots */
11559 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11560 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11561 PL_main_start = proto_perl->Imain_start;
11562 PL_eval_root = proto_perl->Ieval_root;
11563 PL_eval_start = proto_perl->Ieval_start;
11565 /* runtime control stuff */
11566 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11567 PL_copline = proto_perl->Icopline;
11569 PL_filemode = proto_perl->Ifilemode;
11570 PL_lastfd = proto_perl->Ilastfd;
11571 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11574 PL_gensym = proto_perl->Igensym;
11575 PL_preambled = proto_perl->Ipreambled;
11576 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11577 PL_laststatval = proto_perl->Ilaststatval;
11578 PL_laststype = proto_perl->Ilaststype;
11579 PL_mess_sv = Nullsv;
11581 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11583 /* interpreter atexit processing */
11584 PL_exitlistlen = proto_perl->Iexitlistlen;
11585 if (PL_exitlistlen) {
11586 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11587 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11590 PL_exitlist = (PerlExitListEntry*)NULL;
11591 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11592 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11593 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11595 PL_profiledata = NULL;
11596 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11597 /* PL_rsfp_filters entries have fake IoDIRP() */
11598 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11600 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11602 PAD_CLONE_VARS(proto_perl, param);
11604 #ifdef HAVE_INTERP_INTERN
11605 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11608 /* more statics moved here */
11609 PL_generation = proto_perl->Igeneration;
11610 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11612 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11613 PL_in_clean_all = proto_perl->Iin_clean_all;
11615 PL_uid = proto_perl->Iuid;
11616 PL_euid = proto_perl->Ieuid;
11617 PL_gid = proto_perl->Igid;
11618 PL_egid = proto_perl->Iegid;
11619 PL_nomemok = proto_perl->Inomemok;
11620 PL_an = proto_perl->Ian;
11621 PL_evalseq = proto_perl->Ievalseq;
11622 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11623 PL_origalen = proto_perl->Iorigalen;
11624 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11625 PL_osname = SAVEPV(proto_perl->Iosname);
11626 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11627 PL_sighandlerp = proto_perl->Isighandlerp;
11630 PL_runops = proto_perl->Irunops;
11632 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11635 PL_cshlen = proto_perl->Icshlen;
11636 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11639 PL_lex_state = proto_perl->Ilex_state;
11640 PL_lex_defer = proto_perl->Ilex_defer;
11641 PL_lex_expect = proto_perl->Ilex_expect;
11642 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11643 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11644 PL_lex_starts = proto_perl->Ilex_starts;
11645 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11646 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11647 PL_lex_op = proto_perl->Ilex_op;
11648 PL_lex_inpat = proto_perl->Ilex_inpat;
11649 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11650 PL_lex_brackets = proto_perl->Ilex_brackets;
11651 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11652 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11653 PL_lex_casemods = proto_perl->Ilex_casemods;
11654 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11655 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11657 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11658 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11659 PL_nexttoke = proto_perl->Inexttoke;
11661 /* XXX This is probably masking the deeper issue of why
11662 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11663 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11664 * (A little debugging with a watchpoint on it may help.)
11666 if (SvANY(proto_perl->Ilinestr)) {
11667 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11668 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11669 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11670 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11671 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11672 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11673 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11674 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11675 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11678 PL_linestr = NEWSV(65,79);
11679 sv_upgrade(PL_linestr,SVt_PVIV);
11680 sv_setpvn(PL_linestr,"",0);
11681 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11683 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11684 PL_pending_ident = proto_perl->Ipending_ident;
11685 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11687 PL_expect = proto_perl->Iexpect;
11689 PL_multi_start = proto_perl->Imulti_start;
11690 PL_multi_end = proto_perl->Imulti_end;
11691 PL_multi_open = proto_perl->Imulti_open;
11692 PL_multi_close = proto_perl->Imulti_close;
11694 PL_error_count = proto_perl->Ierror_count;
11695 PL_subline = proto_perl->Isubline;
11696 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11698 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11699 if (SvANY(proto_perl->Ilinestr)) {
11700 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11701 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11702 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11703 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11704 PL_last_lop_op = proto_perl->Ilast_lop_op;
11707 PL_last_uni = SvPVX(PL_linestr);
11708 PL_last_lop = SvPVX(PL_linestr);
11709 PL_last_lop_op = 0;
11711 PL_in_my = proto_perl->Iin_my;
11712 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11714 PL_cryptseen = proto_perl->Icryptseen;
11717 PL_hints = proto_perl->Ihints;
11719 PL_amagic_generation = proto_perl->Iamagic_generation;
11721 #ifdef USE_LOCALE_COLLATE
11722 PL_collation_ix = proto_perl->Icollation_ix;
11723 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11724 PL_collation_standard = proto_perl->Icollation_standard;
11725 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11726 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11727 #endif /* USE_LOCALE_COLLATE */
11729 #ifdef USE_LOCALE_NUMERIC
11730 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11731 PL_numeric_standard = proto_perl->Inumeric_standard;
11732 PL_numeric_local = proto_perl->Inumeric_local;
11733 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11734 #endif /* !USE_LOCALE_NUMERIC */
11736 /* utf8 character classes */
11737 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11738 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11739 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11740 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11741 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11742 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11743 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11744 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11745 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11746 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11747 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11748 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11749 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11750 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11751 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11752 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11753 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11754 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11755 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11756 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11758 /* Did the locale setup indicate UTF-8? */
11759 PL_utf8locale = proto_perl->Iutf8locale;
11760 /* Unicode features (see perlrun/-C) */
11761 PL_unicode = proto_perl->Iunicode;
11763 /* Pre-5.8 signals control */
11764 PL_signals = proto_perl->Isignals;
11766 /* times() ticks per second */
11767 PL_clocktick = proto_perl->Iclocktick;
11769 /* Recursion stopper for PerlIO_find_layer */
11770 PL_in_load_module = proto_perl->Iin_load_module;
11772 /* sort() routine */
11773 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11775 /* Not really needed/useful since the reenrant_retint is "volatile",
11776 * but do it for consistency's sake. */
11777 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11779 /* Hooks to shared SVs and locks. */
11780 PL_sharehook = proto_perl->Isharehook;
11781 PL_lockhook = proto_perl->Ilockhook;
11782 PL_unlockhook = proto_perl->Iunlockhook;
11783 PL_threadhook = proto_perl->Ithreadhook;
11785 PL_runops_std = proto_perl->Irunops_std;
11786 PL_runops_dbg = proto_perl->Irunops_dbg;
11788 #ifdef THREADS_HAVE_PIDS
11789 PL_ppid = proto_perl->Ippid;
11793 PL_last_swash_hv = Nullhv; /* reinits on demand */
11794 PL_last_swash_klen = 0;
11795 PL_last_swash_key[0]= '\0';
11796 PL_last_swash_tmps = (U8*)NULL;
11797 PL_last_swash_slen = 0;
11799 PL_glob_index = proto_perl->Iglob_index;
11800 PL_srand_called = proto_perl->Isrand_called;
11801 PL_uudmap['M'] = 0; /* reinits on demand */
11802 PL_bitcount = Nullch; /* reinits on demand */
11804 if (proto_perl->Ipsig_pend) {
11805 Newz(0, PL_psig_pend, SIG_SIZE, int);
11808 PL_psig_pend = (int*)NULL;
11811 if (proto_perl->Ipsig_ptr) {
11812 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11813 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11814 for (i = 1; i < SIG_SIZE; i++) {
11815 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11816 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11820 PL_psig_ptr = (SV**)NULL;
11821 PL_psig_name = (SV**)NULL;
11824 /* thrdvar.h stuff */
11826 if (flags & CLONEf_COPY_STACKS) {
11827 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11828 PL_tmps_ix = proto_perl->Ttmps_ix;
11829 PL_tmps_max = proto_perl->Ttmps_max;
11830 PL_tmps_floor = proto_perl->Ttmps_floor;
11831 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11833 while (i <= PL_tmps_ix) {
11834 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11838 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11839 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11840 Newz(54, PL_markstack, i, I32);
11841 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11842 - proto_perl->Tmarkstack);
11843 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11844 - proto_perl->Tmarkstack);
11845 Copy(proto_perl->Tmarkstack, PL_markstack,
11846 PL_markstack_ptr - PL_markstack + 1, I32);
11848 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11849 * NOTE: unlike the others! */
11850 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11851 PL_scopestack_max = proto_perl->Tscopestack_max;
11852 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11853 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11855 /* NOTE: si_dup() looks at PL_markstack */
11856 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11858 /* PL_curstack = PL_curstackinfo->si_stack; */
11859 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11860 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11862 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11863 PL_stack_base = AvARRAY(PL_curstack);
11864 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11865 - proto_perl->Tstack_base);
11866 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11868 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11869 * NOTE: unlike the others! */
11870 PL_savestack_ix = proto_perl->Tsavestack_ix;
11871 PL_savestack_max = proto_perl->Tsavestack_max;
11872 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11873 PL_savestack = ss_dup(proto_perl, param);
11877 ENTER; /* perl_destruct() wants to LEAVE; */
11880 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11881 PL_top_env = &PL_start_env;
11883 PL_op = proto_perl->Top;
11886 PL_Xpv = (XPV*)NULL;
11887 PL_na = proto_perl->Tna;
11889 PL_statbuf = proto_perl->Tstatbuf;
11890 PL_statcache = proto_perl->Tstatcache;
11891 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11892 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11894 PL_timesbuf = proto_perl->Ttimesbuf;
11897 PL_tainted = proto_perl->Ttainted;
11898 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11899 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11900 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11901 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11902 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11903 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11904 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11905 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11906 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11908 PL_restartop = proto_perl->Trestartop;
11909 PL_in_eval = proto_perl->Tin_eval;
11910 PL_delaymagic = proto_perl->Tdelaymagic;
11911 PL_dirty = proto_perl->Tdirty;
11912 PL_localizing = proto_perl->Tlocalizing;
11914 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11915 PL_hv_fetch_ent_mh = Nullhe;
11916 PL_modcount = proto_perl->Tmodcount;
11917 PL_lastgotoprobe = Nullop;
11918 PL_dumpindent = proto_perl->Tdumpindent;
11920 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11921 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11922 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11923 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11924 PL_sortcxix = proto_perl->Tsortcxix;
11925 PL_efloatbuf = Nullch; /* reinits on demand */
11926 PL_efloatsize = 0; /* reinits on demand */
11930 PL_screamfirst = NULL;
11931 PL_screamnext = NULL;
11932 PL_maxscream = -1; /* reinits on demand */
11933 PL_lastscream = Nullsv;
11935 PL_watchaddr = NULL;
11936 PL_watchok = Nullch;
11938 PL_regdummy = proto_perl->Tregdummy;
11939 PL_regprecomp = Nullch;
11942 PL_colorset = 0; /* reinits PL_colors[] */
11943 /*PL_colors[6] = {0,0,0,0,0,0};*/
11944 PL_reginput = Nullch;
11945 PL_regbol = Nullch;
11946 PL_regeol = Nullch;
11947 PL_regstartp = (I32*)NULL;
11948 PL_regendp = (I32*)NULL;
11949 PL_reglastparen = (U32*)NULL;
11950 PL_reglastcloseparen = (U32*)NULL;
11951 PL_regtill = Nullch;
11952 PL_reg_start_tmp = (char**)NULL;
11953 PL_reg_start_tmpl = 0;
11954 PL_regdata = (struct reg_data*)NULL;
11957 PL_reg_eval_set = 0;
11959 PL_regprogram = (regnode*)NULL;
11961 PL_regcc = (CURCUR*)NULL;
11962 PL_reg_call_cc = (struct re_cc_state*)NULL;
11963 PL_reg_re = (regexp*)NULL;
11964 PL_reg_ganch = Nullch;
11965 PL_reg_sv = Nullsv;
11966 PL_reg_match_utf8 = FALSE;
11967 PL_reg_magic = (MAGIC*)NULL;
11969 PL_reg_oldcurpm = (PMOP*)NULL;
11970 PL_reg_curpm = (PMOP*)NULL;
11971 PL_reg_oldsaved = Nullch;
11972 PL_reg_oldsavedlen = 0;
11973 #ifdef PERL_OLD_COPY_ON_WRITE
11976 PL_reg_maxiter = 0;
11977 PL_reg_leftiter = 0;
11978 PL_reg_poscache = Nullch;
11979 PL_reg_poscache_size= 0;
11981 /* RE engine - function pointers */
11982 PL_regcompp = proto_perl->Tregcompp;
11983 PL_regexecp = proto_perl->Tregexecp;
11984 PL_regint_start = proto_perl->Tregint_start;
11985 PL_regint_string = proto_perl->Tregint_string;
11986 PL_regfree = proto_perl->Tregfree;
11988 PL_reginterp_cnt = 0;
11989 PL_reg_starttry = 0;
11991 /* Pluggable optimizer */
11992 PL_peepp = proto_perl->Tpeepp;
11994 PL_stashcache = newHV();
11996 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11997 ptr_table_free(PL_ptr_table);
11998 PL_ptr_table = NULL;
12001 /* Call the ->CLONE method, if it exists, for each of the stashes
12002 identified by sv_dup() above.
12004 while(av_len(param->stashes) != -1) {
12005 HV* const stash = (HV*) av_shift(param->stashes);
12006 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12007 if (cloner && GvCV(cloner)) {
12012 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12014 call_sv((SV*)GvCV(cloner), G_DISCARD);
12020 SvREFCNT_dec(param->stashes);
12022 /* orphaned? eg threads->new inside BEGIN or use */
12023 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12024 (void)SvREFCNT_inc(PL_compcv);
12025 SAVEFREESV(PL_compcv);
12031 #endif /* USE_ITHREADS */
12034 =head1 Unicode Support
12036 =for apidoc sv_recode_to_utf8
12038 The encoding is assumed to be an Encode object, on entry the PV
12039 of the sv is assumed to be octets in that encoding, and the sv
12040 will be converted into Unicode (and UTF-8).
12042 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12043 is not a reference, nothing is done to the sv. If the encoding is not
12044 an C<Encode::XS> Encoding object, bad things will happen.
12045 (See F<lib/encoding.pm> and L<Encode>).
12047 The PV of the sv is returned.
12052 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12055 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12069 Passing sv_yes is wrong - it needs to be or'ed set of constants
12070 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12071 remove converted chars from source.
12073 Both will default the value - let them.
12075 XPUSHs(&PL_sv_yes);
12078 call_method("decode", G_SCALAR);
12082 s = SvPV_const(uni, len);
12083 if (s != SvPVX_const(sv)) {
12084 SvGROW(sv, len + 1);
12085 Move(s, SvPVX(sv), len + 1, char);
12086 SvCUR_set(sv, len);
12093 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12097 =for apidoc sv_cat_decode
12099 The encoding is assumed to be an Encode object, the PV of the ssv is
12100 assumed to be octets in that encoding and decoding the input starts
12101 from the position which (PV + *offset) pointed to. The dsv will be
12102 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12103 when the string tstr appears in decoding output or the input ends on
12104 the PV of the ssv. The value which the offset points will be modified
12105 to the last input position on the ssv.
12107 Returns TRUE if the terminator was found, else returns FALSE.
12112 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12113 SV *ssv, int *offset, char *tstr, int tlen)
12117 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12128 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12129 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12131 call_method("cat_decode", G_SCALAR);
12133 ret = SvTRUE(TOPs);
12134 *offset = SvIV(offsv);
12140 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12146 * c-indentation-style: bsd
12147 * c-basic-offset: 4
12148 * indent-tabs-mode: t
12151 * ex: set ts=8 sts=4 sw=4 noet: