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)) {
290 SV *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 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 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 void **arenaroots[] = {
529 (void**) &PL_xnv_arenaroot,
530 (void**) &PL_xpv_arenaroot,
531 (void**) &PL_xpviv_arenaroot,
532 (void**) &PL_xpvnv_arenaroot,
533 (void**) &PL_xpvcv_arenaroot,
534 (void**) &PL_xpvav_arenaroot,
535 (void**) &PL_xpvhv_arenaroot,
536 (void**) &PL_xpvmg_arenaroot,
537 (void**) &PL_xpvgv_arenaroot,
538 (void**) &PL_xpvlv_arenaroot,
539 (void**) &PL_xpvbm_arenaroot,
540 (void**) &PL_he_arenaroot,
541 #if defined(USE_ITHREADS)
542 (void**) &PL_pte_arenaroot,
547 (void**) &PL_xnv_root,
548 (void**) &PL_xpv_root,
549 (void**) &PL_xpviv_root,
550 (void**) &PL_xpvnv_root,
551 (void**) &PL_xpvcv_root,
552 (void**) &PL_xpvav_root,
553 (void**) &PL_xpvhv_root,
554 (void**) &PL_xpvmg_root,
555 (void**) &PL_xpvgv_root,
556 (void**) &PL_xpvlv_root,
557 (void**) &PL_xpvbm_root,
558 (void**) &PL_he_root,
559 #if defined(USE_ITHREADS)
560 (void**) &PL_pte_root,
565 /* Free arenas here, but be careful about fake ones. (We assume
566 contiguity of the fake ones with the corresponding real ones.) */
568 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
569 svanext = (SV*) SvANY(sva);
570 while (svanext && SvFAKE(svanext))
571 svanext = (SV*) SvANY(svanext);
577 assert(sizeof(arenaroots) == sizeof(roots));
579 for (i=0; arenaroots[i]; i++) {
581 arena = *arenaroots[i];
582 for (; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
591 Safefree(PL_nice_chunk);
592 PL_nice_chunk = Nullch;
593 PL_nice_chunk_size = 0;
598 /* ---------------------------------------------------------------------
600 * support functions for report_uninit()
603 /* the maxiumum size of array or hash where we will scan looking
604 * for the undefined element that triggered the warning */
606 #define FUV_MAX_SEARCH_SIZE 1000
608 /* Look for an entry in the hash whose value has the same SV as val;
609 * If so, return a mortal copy of the key. */
612 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
618 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
619 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
624 for (i=HvMAX(hv); i>0; i--) {
626 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
627 if (HeVAL(entry) != val)
629 if ( HeVAL(entry) == &PL_sv_undef ||
630 HeVAL(entry) == &PL_sv_placeholder)
634 if (HeKLEN(entry) == HEf_SVKEY)
635 return sv_mortalcopy(HeKEY_sv(entry));
636 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
642 /* Look for an entry in the array whose value has the same SV as val;
643 * If so, return the index, otherwise return -1. */
646 S_find_array_subscript(pTHX_ AV *av, SV* val)
650 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
651 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
655 for (i=AvFILLp(av); i>=0; i--) {
656 if (svp[i] == val && svp[i] != &PL_sv_undef)
662 /* S_varname(): return the name of a variable, optionally with a subscript.
663 * If gv is non-zero, use the name of that global, along with gvtype (one
664 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
665 * targ. Depending on the value of the subscript_type flag, return:
668 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
669 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
670 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
671 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
674 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
675 SV* keyname, I32 aindex, int subscript_type)
680 SV * const name = sv_newmortal();
683 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
684 * XXX get rid of all this if gv_fullnameX() ever supports this
688 HV *hv = GvSTASH(gv);
689 sv_setpv(name, gvtype);
692 else if (!(p=HvNAME_get(hv)))
694 if (strNE(p, "main")) {
696 sv_catpvn(name,"::", 2);
698 if (GvNAMELEN(gv)>= 1 &&
699 ((unsigned int)*GvNAME(gv)) <= 26)
701 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
702 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
705 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
709 CV *cv = find_runcv(&u);
710 if (!cv || !CvPADLIST(cv))
712 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
713 sv = *av_fetch(av, targ, FALSE);
714 /* SvLEN in a pad name is not to be trusted */
715 sv_setpv(name, SvPV_nolen_const(sv));
718 if (subscript_type == FUV_SUBSCRIPT_HASH) {
721 Perl_sv_catpvf(aTHX_ name, "{%s}",
722 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
725 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
727 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
729 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
730 sv_insert(name, 0, 0, "within ", 7);
737 =for apidoc find_uninit_var
739 Find the name of the undefined variable (if any) that caused the operator o
740 to issue a "Use of uninitialized value" warning.
741 If match is true, only return a name if it's value matches uninit_sv.
742 So roughly speaking, if a unary operator (such as OP_COS) generates a
743 warning, then following the direct child of the op may yield an
744 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
745 other hand, with OP_ADD there are two branches to follow, so we only print
746 the variable name if we get an exact match.
748 The name is returned as a mortal SV.
750 Assumes that PL_op is the op that originally triggered the error, and that
751 PL_comppad/PL_curpad points to the currently executing pad.
757 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
766 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
767 uninit_sv == &PL_sv_placeholder)))
770 switch (obase->op_type) {
777 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
778 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
781 int subscript_type = FUV_SUBSCRIPT_WITHIN;
783 if (pad) { /* @lex, %lex */
784 sv = PAD_SVl(obase->op_targ);
788 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
789 /* @global, %global */
790 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
793 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
795 else /* @{expr}, %{expr} */
796 return find_uninit_var(cUNOPx(obase)->op_first,
800 /* attempt to find a match within the aggregate */
802 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
804 subscript_type = FUV_SUBSCRIPT_HASH;
807 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
809 subscript_type = FUV_SUBSCRIPT_ARRAY;
812 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
815 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
816 keysv, index, subscript_type);
820 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
822 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
823 Nullsv, 0, FUV_SUBSCRIPT_NONE);
826 gv = cGVOPx_gv(obase);
827 if (!gv || (match && GvSV(gv) != uninit_sv))
829 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
832 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
834 av = (AV*)PAD_SV(obase->op_targ);
835 if (!av || SvRMAGICAL(av))
837 svp = av_fetch(av, (I32)obase->op_private, FALSE);
838 if (!svp || *svp != uninit_sv)
841 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
842 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
845 gv = cGVOPx_gv(obase);
850 if (!av || SvRMAGICAL(av))
852 svp = av_fetch(av, (I32)obase->op_private, FALSE);
853 if (!svp || *svp != uninit_sv)
856 return S_varname(aTHX_ gv, "$", 0,
857 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
862 o = cUNOPx(obase)->op_first;
863 if (!o || o->op_type != OP_NULL ||
864 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
866 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
871 /* $a[uninit_expr] or $h{uninit_expr} */
872 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
875 o = cBINOPx(obase)->op_first;
876 kid = cBINOPx(obase)->op_last;
878 /* get the av or hv, and optionally the gv */
880 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
881 sv = PAD_SV(o->op_targ);
883 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
884 && cUNOPo->op_first->op_type == OP_GV)
886 gv = cGVOPx_gv(cUNOPo->op_first);
889 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
894 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
895 /* index is constant */
899 if (obase->op_type == OP_HELEM) {
900 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
901 if (!he || HeVAL(he) != uninit_sv)
905 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
906 if (!svp || *svp != uninit_sv)
910 if (obase->op_type == OP_HELEM)
911 return S_varname(aTHX_ gv, "%", o->op_targ,
912 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
914 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
915 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
919 /* index is an expression;
920 * attempt to find a match within the aggregate */
921 if (obase->op_type == OP_HELEM) {
922 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
924 return S_varname(aTHX_ gv, "%", o->op_targ,
925 keysv, 0, FUV_SUBSCRIPT_HASH);
928 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
930 return S_varname(aTHX_ gv, "@", o->op_targ,
931 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
935 return S_varname(aTHX_ gv,
936 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
938 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
944 /* only examine RHS */
945 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
948 o = cUNOPx(obase)->op_first;
949 if (o->op_type == OP_PUSHMARK)
952 if (!o->op_sibling) {
953 /* one-arg version of open is highly magical */
955 if (o->op_type == OP_GV) { /* open FOO; */
957 if (match && GvSV(gv) != uninit_sv)
959 return S_varname(aTHX_ gv, "$", 0,
960 Nullsv, 0, FUV_SUBSCRIPT_NONE);
962 /* other possibilities not handled are:
963 * open $x; or open my $x; should return '${*$x}'
964 * open expr; should return '$'.expr ideally
970 /* ops where $_ may be an implicit arg */
974 if ( !(obase->op_flags & OPf_STACKED)) {
975 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
976 ? PAD_SVl(obase->op_targ)
980 sv_setpvn(sv, "$_", 2);
988 /* skip filehandle as it can't produce 'undef' warning */
989 o = cUNOPx(obase)->op_first;
990 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
991 o = o->op_sibling->op_sibling;
998 match = 1; /* XS or custom code could trigger random warnings */
1003 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1004 return sv_2mortal(newSVpv("${$/}", 0));
1009 if (!(obase->op_flags & OPf_KIDS))
1011 o = cUNOPx(obase)->op_first;
1017 /* if all except one arg are constant, or have no side-effects,
1018 * or are optimized away, then it's unambiguous */
1020 for (kid=o; kid; kid = kid->op_sibling) {
1022 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1023 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1024 || (kid->op_type == OP_PUSHMARK)
1028 if (o2) { /* more than one found */
1035 return find_uninit_var(o2, uninit_sv, match);
1039 sv = find_uninit_var(o, uninit_sv, 1);
1051 =for apidoc report_uninit
1053 Print appropriate "Use of uninitialized variable" warning
1059 Perl_report_uninit(pTHX_ SV* uninit_sv)
1062 SV* varname = Nullsv;
1064 varname = find_uninit_var(PL_op, uninit_sv,0);
1066 sv_insert(varname, 0, 0, " ", 1);
1068 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1069 varname ? SvPV_nolen_const(varname) : "",
1070 " in ", OP_DESC(PL_op));
1073 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1078 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1082 size_t count = PERL_ARENA_SIZE/size;
1083 New(0, start, count*size, char);
1084 *((void **) start) = *arena_root;
1085 *arena_root = (void *)start;
1087 end = start + (count-1) * size;
1089 /* The initial slot is used to link the arenas together, so it isn't to be
1090 linked into the list of ready-to-use bodies. */
1094 *root = (void *)start;
1096 while (start < end) {
1097 char *next = start + size;
1098 *(void**) start = (void *)next;
1101 *(void **)start = 0;
1106 /* grab a new thing from the free list, allocating more if necessary */
1109 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1113 xpv = *root ? *root : S_more_bodies(aTHX_ arena_root, root, size);
1114 *root = *(void**)xpv;
1119 /* return a thing to the free list */
1121 #define del_body(thing, root) \
1124 *(void **)thing = *root; \
1125 *root = (void*)thing; \
1129 /* Conventionally we simply malloc() a big block of memory, then divide it
1130 up into lots of the thing that we're allocating.
1132 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1135 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1136 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1139 #define new_body(TYPE,lctype) \
1140 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1141 (void**)&PL_ ## lctype ## _root, \
1144 #define del_body_type(p,TYPE,lctype) \
1145 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1147 /* But for some types, we cheat. The type starts with some members that are
1148 never accessed. So we allocate the substructure, starting at the first used
1149 member, then adjust the pointer back in memory by the size of the bit not
1150 allocated, so it's as if we allocated the full structure.
1151 (But things will all go boom if you write to the part that is "not there",
1152 because you'll be overwriting the last members of the preceding structure
1155 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1156 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1157 and the pointer is unchanged. If the allocated structure is smaller (no
1158 initial NV actually allocated) then the net effect is to subtract the size
1159 of the NV from the pointer, to return a new pointer as if an initial NV were
1162 This is the same trick as was used for NV and IV bodies. Ironically it
1163 doesn't need to be used for NV bodies any more, because NV is now at the
1164 start of the structure. IV bodies don't need it either, because they are
1165 no longer allocated. */
1167 #define new_body_allocated(TYPE,lctype,member) \
1168 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1169 (void**)&PL_ ## lctype ## _root, \
1170 sizeof(lctype ## _allocated)) - \
1171 STRUCT_OFFSET(TYPE, member) \
1172 + STRUCT_OFFSET(lctype ## _allocated, member))
1175 #define del_body_allocated(p,TYPE,lctype,member) \
1176 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1177 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1178 (void**)&PL_ ## lctype ## _root)
1180 #define my_safemalloc(s) (void*)safemalloc(s)
1181 #define my_safefree(p) safefree((char*)p)
1185 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1186 #define del_XNV(p) my_safefree(p)
1188 #define new_XPV() my_safemalloc(sizeof(XPV))
1189 #define del_XPV(p) my_safefree(p)
1191 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1192 #define del_XPVIV(p) my_safefree(p)
1194 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1195 #define del_XPVNV(p) my_safefree(p)
1197 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1198 #define del_XPVCV(p) my_safefree(p)
1200 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1201 #define del_XPVAV(p) my_safefree(p)
1203 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1204 #define del_XPVHV(p) my_safefree(p)
1206 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1207 #define del_XPVMG(p) my_safefree(p)
1209 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1210 #define del_XPVGV(p) my_safefree(p)
1212 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1213 #define del_XPVLV(p) my_safefree(p)
1215 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1216 #define del_XPVBM(p) my_safefree(p)
1220 #define new_XNV() new_body(NV, xnv)
1221 #define del_XNV(p) del_body_type(p, NV, xnv)
1223 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1224 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1226 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1227 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1229 #define new_XPVNV() new_body(XPVNV, xpvnv)
1230 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1232 #define new_XPVCV() new_body(XPVCV, xpvcv)
1233 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1235 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1236 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1238 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1239 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1241 #define new_XPVMG() new_body(XPVMG, xpvmg)
1242 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1244 #define new_XPVGV() new_body(XPVGV, xpvgv)
1245 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1247 #define new_XPVLV() new_body(XPVLV, xpvlv)
1248 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1250 #define new_XPVBM() new_body(XPVBM, xpvbm)
1251 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1255 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1256 #define del_XPVFM(p) my_safefree(p)
1258 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1259 #define del_XPVIO(p) my_safefree(p)
1262 =for apidoc sv_upgrade
1264 Upgrade an SV to a more complex form. Generally adds a new body type to the
1265 SV, then copies across as much information as possible from the old body.
1266 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1272 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1274 void** old_body_arena;
1275 size_t old_body_offset;
1276 size_t old_body_length; /* Well, the length to copy. */
1278 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1279 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1281 bool zero_nv = TRUE;
1284 size_t new_body_length;
1285 size_t new_body_offset;
1286 void** new_body_arena;
1287 void** new_body_arenaroot;
1288 U32 old_type = SvTYPE(sv);
1290 if (mt != SVt_PV && SvIsCOW(sv)) {
1291 sv_force_normal_flags(sv, 0);
1294 if (SvTYPE(sv) == mt)
1297 if (SvTYPE(sv) > mt)
1298 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1299 (int)SvTYPE(sv), (int)mt);
1302 old_body = SvANY(sv);
1304 old_body_offset = 0;
1305 old_body_length = 0;
1306 new_body_offset = 0;
1307 new_body_length = ~0;
1309 /* Copying structures onto other structures that have been neatly zeroed
1310 has a subtle gotcha. Consider XPVMG
1312 +------+------+------+------+------+-------+-------+
1313 | NV | CUR | LEN | IV | MAGIC | STASH |
1314 +------+------+------+------+------+-------+-------+
1315 0 4 8 12 16 20 24 28
1317 where NVs are aligned to 8 bytes, so that sizeof that structure is
1318 actually 32 bytes long, with 4 bytes of padding at the end:
1320 +------+------+------+------+------+-------+-------+------+
1321 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1322 +------+------+------+------+------+-------+-------+------+
1323 0 4 8 12 16 20 24 28 32
1325 so what happens if you allocate memory for this structure:
1327 +------+------+------+------+------+-------+-------+------+------+...
1328 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1329 +------+------+------+------+------+-------+-------+------+------+...
1330 0 4 8 12 16 20 24 28 32 36
1332 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1333 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1334 started out as zero once, but it's quite possible that it isn't. So now,
1335 rather than a nicely zeroed GP, you have it pointing somewhere random.
1338 (In fact, GP ends up pointing at a previous GP structure, because the
1339 principle cause of the padding in XPVMG getting garbage is a copy of
1340 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1342 So we are careful and work out the size of used parts of all the
1345 switch (SvTYPE(sv)) {
1351 else if (mt < SVt_PVIV)
1353 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1354 old_body_length = sizeof(IV);
1357 old_body_arena = (void **) &PL_xnv_root;
1358 old_body_length = sizeof(NV);
1359 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1368 old_body_arena = (void **) &PL_xpv_root;
1369 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1370 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1371 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1372 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1376 else if (mt == SVt_NV)
1380 old_body_arena = (void **) &PL_xpviv_root;
1381 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1382 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1383 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1384 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1388 old_body_arena = (void **) &PL_xpvnv_root;
1389 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1390 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1391 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1396 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1397 there's no way that it can be safely upgraded, because perl.c
1398 expects to Safefree(SvANY(PL_mess_sv)) */
1399 assert(sv != PL_mess_sv);
1400 /* This flag bit is used to mean other things in other scalar types.
1401 Given that it only has meaning inside the pad, it shouldn't be set
1402 on anything that can get upgraded. */
1403 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1404 old_body_arena = (void **) &PL_xpvmg_root;
1405 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1406 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1407 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1412 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1415 SvFLAGS(sv) &= ~SVTYPEMASK;
1420 Perl_croak(aTHX_ "Can't upgrade to undef");
1422 assert(old_type == SVt_NULL);
1423 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1427 assert(old_type == SVt_NULL);
1428 SvANY(sv) = new_XNV();
1432 assert(old_type == SVt_NULL);
1433 SvANY(sv) = &sv->sv_u.svu_rv;
1437 SvANY(sv) = new_XPVHV();
1440 HvTOTALKEYS(sv) = 0;
1445 SvANY(sv) = new_XPVAV();
1452 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1453 The target created by newSVrv also is, and it can have magic.
1454 However, it never has SvPVX set.
1456 if (old_type >= SVt_RV) {
1457 assert(SvPVX_const(sv) == 0);
1460 /* Could put this in the else clause below, as PVMG must have SvPVX
1461 0 already (the assertion above) */
1462 SvPV_set(sv, (char*)0);
1464 if (old_type >= SVt_PVMG) {
1465 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1466 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1474 new_body = new_XPVIO();
1475 new_body_length = sizeof(XPVIO);
1478 new_body = new_XPVFM();
1479 new_body_length = sizeof(XPVFM);
1483 new_body_length = sizeof(XPVBM);
1484 new_body_arena = (void **) &PL_xpvbm_root;
1485 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1488 new_body_length = sizeof(XPVGV);
1489 new_body_arena = (void **) &PL_xpvgv_root;
1490 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1493 new_body_length = sizeof(XPVCV);
1494 new_body_arena = (void **) &PL_xpvcv_root;
1495 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1498 new_body_length = sizeof(XPVLV);
1499 new_body_arena = (void **) &PL_xpvlv_root;
1500 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1503 new_body_length = sizeof(XPVMG);
1504 new_body_arena = (void **) &PL_xpvmg_root;
1505 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1508 new_body_length = sizeof(XPVNV);
1509 new_body_arena = (void **) &PL_xpvnv_root;
1510 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1513 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1514 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1515 new_body_length = sizeof(XPVIV) - new_body_offset;
1516 new_body_arena = (void **) &PL_xpviv_root;
1517 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1518 /* XXX Is this still needed? Was it ever needed? Surely as there is
1519 no route from NV to PVIV, NOK can never be true */
1523 goto new_body_no_NV;
1525 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1526 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1527 new_body_length = sizeof(XPV) - new_body_offset;
1528 new_body_arena = (void **) &PL_xpv_root;
1529 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1531 /* PV and PVIV don't have an NV slot. */
1532 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1537 assert(new_body_length);
1539 /* This points to the start of the allocated area. */
1540 new_body = S_new_body(aTHX_ new_body_arenaroot, new_body_arena,
1543 /* We always allocated the full length item with PURIFY */
1544 new_body_length += new_body_offset;
1545 new_body_offset = 0;
1546 new_body = my_safemalloc(new_body_length);
1550 Zero(new_body, new_body_length, char);
1551 new_body = ((char *)new_body) - new_body_offset;
1552 SvANY(sv) = new_body;
1554 if (old_body_length) {
1555 Copy((char *)old_body + old_body_offset,
1556 (char *)new_body + old_body_offset,
1557 old_body_length, char);
1560 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1566 IoPAGE_LEN(sv) = 60;
1567 if (old_type < SVt_RV)
1571 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1575 if (old_body_arena) {
1577 my_safefree(old_body);
1579 del_body((void*)((char*)old_body + old_body_offset),
1586 =for apidoc sv_backoff
1588 Remove any string offset. You should normally use the C<SvOOK_off> macro
1595 Perl_sv_backoff(pTHX_ register SV *sv)
1598 assert(SvTYPE(sv) != SVt_PVHV);
1599 assert(SvTYPE(sv) != SVt_PVAV);
1601 const char *s = SvPVX_const(sv);
1602 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1603 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1605 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1607 SvFLAGS(sv) &= ~SVf_OOK;
1614 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1615 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1616 Use the C<SvGROW> wrapper instead.
1622 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1626 #ifdef HAS_64K_LIMIT
1627 if (newlen >= 0x10000) {
1628 PerlIO_printf(Perl_debug_log,
1629 "Allocation too large: %"UVxf"\n", (UV)newlen);
1632 #endif /* HAS_64K_LIMIT */
1635 if (SvTYPE(sv) < SVt_PV) {
1636 sv_upgrade(sv, SVt_PV);
1637 s = SvPVX_mutable(sv);
1639 else if (SvOOK(sv)) { /* pv is offset? */
1641 s = SvPVX_mutable(sv);
1642 if (newlen > SvLEN(sv))
1643 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1644 #ifdef HAS_64K_LIMIT
1645 if (newlen >= 0x10000)
1650 s = SvPVX_mutable(sv);
1652 if (newlen > SvLEN(sv)) { /* need more room? */
1653 newlen = PERL_STRLEN_ROUNDUP(newlen);
1654 if (SvLEN(sv) && s) {
1656 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1662 s = saferealloc(s, newlen);
1665 s = safemalloc(newlen);
1666 if (SvPVX_const(sv) && SvCUR(sv)) {
1667 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1671 SvLEN_set(sv, newlen);
1677 =for apidoc sv_setiv
1679 Copies an integer into the given SV, upgrading first if necessary.
1680 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1686 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1688 SV_CHECK_THINKFIRST_COW_DROP(sv);
1689 switch (SvTYPE(sv)) {
1691 sv_upgrade(sv, SVt_IV);
1694 sv_upgrade(sv, SVt_PVNV);
1698 sv_upgrade(sv, SVt_PVIV);
1707 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1710 (void)SvIOK_only(sv); /* validate number */
1716 =for apidoc sv_setiv_mg
1718 Like C<sv_setiv>, but also handles 'set' magic.
1724 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1731 =for apidoc sv_setuv
1733 Copies an unsigned integer into the given SV, upgrading first if necessary.
1734 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1740 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1742 /* With these two if statements:
1743 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1746 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1748 If you wish to remove them, please benchmark to see what the effect is
1750 if (u <= (UV)IV_MAX) {
1751 sv_setiv(sv, (IV)u);
1760 =for apidoc sv_setuv_mg
1762 Like C<sv_setuv>, but also handles 'set' magic.
1768 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1770 /* With these two if statements:
1771 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1774 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1776 If you wish to remove them, please benchmark to see what the effect is
1778 if (u <= (UV)IV_MAX) {
1779 sv_setiv(sv, (IV)u);
1789 =for apidoc sv_setnv
1791 Copies a double into the given SV, upgrading first if necessary.
1792 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1798 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1800 SV_CHECK_THINKFIRST_COW_DROP(sv);
1801 switch (SvTYPE(sv)) {
1804 sv_upgrade(sv, SVt_NV);
1809 sv_upgrade(sv, SVt_PVNV);
1818 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1822 (void)SvNOK_only(sv); /* validate number */
1827 =for apidoc sv_setnv_mg
1829 Like C<sv_setnv>, but also handles 'set' magic.
1835 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1841 /* Print an "isn't numeric" warning, using a cleaned-up,
1842 * printable version of the offending string
1846 S_not_a_number(pTHX_ SV *sv)
1853 dsv = sv_2mortal(newSVpv("", 0));
1854 pv = sv_uni_display(dsv, sv, 10, 0);
1857 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1858 /* each *s can expand to 4 chars + "...\0",
1859 i.e. need room for 8 chars */
1861 const char *s, *end;
1862 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1865 if (ch & 128 && !isPRINT_LC(ch)) {
1874 else if (ch == '\r') {
1878 else if (ch == '\f') {
1882 else if (ch == '\\') {
1886 else if (ch == '\0') {
1890 else if (isPRINT_LC(ch))
1907 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1908 "Argument \"%s\" isn't numeric in %s", pv,
1911 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1912 "Argument \"%s\" isn't numeric", pv);
1916 =for apidoc looks_like_number
1918 Test if the content of an SV looks like a number (or is a number).
1919 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1920 non-numeric warning), even if your atof() doesn't grok them.
1926 Perl_looks_like_number(pTHX_ SV *sv)
1928 register const char *sbegin;
1932 sbegin = SvPVX_const(sv);
1935 else if (SvPOKp(sv))
1936 sbegin = SvPV_const(sv, len);
1938 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1939 return grok_number(sbegin, len, NULL);
1942 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1943 until proven guilty, assume that things are not that bad... */
1948 As 64 bit platforms often have an NV that doesn't preserve all bits of
1949 an IV (an assumption perl has been based on to date) it becomes necessary
1950 to remove the assumption that the NV always carries enough precision to
1951 recreate the IV whenever needed, and that the NV is the canonical form.
1952 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1953 precision as a side effect of conversion (which would lead to insanity
1954 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1955 1) to distinguish between IV/UV/NV slots that have cached a valid
1956 conversion where precision was lost and IV/UV/NV slots that have a
1957 valid conversion which has lost no precision
1958 2) to ensure that if a numeric conversion to one form is requested that
1959 would lose precision, the precise conversion (or differently
1960 imprecise conversion) is also performed and cached, to prevent
1961 requests for different numeric formats on the same SV causing
1962 lossy conversion chains. (lossless conversion chains are perfectly
1967 SvIOKp is true if the IV slot contains a valid value
1968 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1969 SvNOKp is true if the NV slot contains a valid value
1970 SvNOK is true only if the NV value is accurate
1973 while converting from PV to NV, check to see if converting that NV to an
1974 IV(or UV) would lose accuracy over a direct conversion from PV to
1975 IV(or UV). If it would, cache both conversions, return NV, but mark
1976 SV as IOK NOKp (ie not NOK).
1978 While converting from PV to IV, check to see if converting that IV to an
1979 NV would lose accuracy over a direct conversion from PV to NV. If it
1980 would, cache both conversions, flag similarly.
1982 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1983 correctly because if IV & NV were set NV *always* overruled.
1984 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1985 changes - now IV and NV together means that the two are interchangeable:
1986 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1988 The benefit of this is that operations such as pp_add know that if
1989 SvIOK is true for both left and right operands, then integer addition
1990 can be used instead of floating point (for cases where the result won't
1991 overflow). Before, floating point was always used, which could lead to
1992 loss of precision compared with integer addition.
1994 * making IV and NV equal status should make maths accurate on 64 bit
1996 * may speed up maths somewhat if pp_add and friends start to use
1997 integers when possible instead of fp. (Hopefully the overhead in
1998 looking for SvIOK and checking for overflow will not outweigh the
1999 fp to integer speedup)
2000 * will slow down integer operations (callers of SvIV) on "inaccurate"
2001 values, as the change from SvIOK to SvIOKp will cause a call into
2002 sv_2iv each time rather than a macro access direct to the IV slot
2003 * should speed up number->string conversion on integers as IV is
2004 favoured when IV and NV are equally accurate
2006 ####################################################################
2007 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2008 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2009 On the other hand, SvUOK is true iff UV.
2010 ####################################################################
2012 Your mileage will vary depending your CPU's relative fp to integer
2016 #ifndef NV_PRESERVES_UV
2017 # define IS_NUMBER_UNDERFLOW_IV 1
2018 # define IS_NUMBER_UNDERFLOW_UV 2
2019 # define IS_NUMBER_IV_AND_UV 2
2020 # define IS_NUMBER_OVERFLOW_IV 4
2021 # define IS_NUMBER_OVERFLOW_UV 5
2023 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2025 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2027 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2029 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));
2030 if (SvNVX(sv) < (NV)IV_MIN) {
2031 (void)SvIOKp_on(sv);
2033 SvIV_set(sv, IV_MIN);
2034 return IS_NUMBER_UNDERFLOW_IV;
2036 if (SvNVX(sv) > (NV)UV_MAX) {
2037 (void)SvIOKp_on(sv);
2040 SvUV_set(sv, UV_MAX);
2041 return IS_NUMBER_OVERFLOW_UV;
2043 (void)SvIOKp_on(sv);
2045 /* Can't use strtol etc to convert this string. (See truth table in
2047 if (SvNVX(sv) <= (UV)IV_MAX) {
2048 SvIV_set(sv, I_V(SvNVX(sv)));
2049 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2050 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2052 /* Integer is imprecise. NOK, IOKp */
2054 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2057 SvUV_set(sv, U_V(SvNVX(sv)));
2058 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2059 if (SvUVX(sv) == UV_MAX) {
2060 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2061 possibly be preserved by NV. Hence, it must be overflow.
2063 return IS_NUMBER_OVERFLOW_UV;
2065 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2067 /* Integer is imprecise. NOK, IOKp */
2069 return IS_NUMBER_OVERFLOW_IV;
2071 #endif /* !NV_PRESERVES_UV*/
2073 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2074 * this function provided for binary compatibility only
2078 Perl_sv_2iv(pTHX_ register SV *sv)
2080 return sv_2iv_flags(sv, SV_GMAGIC);
2084 =for apidoc sv_2iv_flags
2086 Return the integer value of an SV, doing any necessary string
2087 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2088 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2094 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2098 if (SvGMAGICAL(sv)) {
2099 if (flags & SV_GMAGIC)
2104 return I_V(SvNVX(sv));
2106 if (SvPOKp(sv) && SvLEN(sv))
2109 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2110 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2116 if (SvTHINKFIRST(sv)) {
2119 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2120 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2121 return SvIV(tmpstr);
2122 return PTR2IV(SvRV(sv));
2125 sv_force_normal_flags(sv, 0);
2127 if (SvREADONLY(sv) && !SvOK(sv)) {
2128 if (ckWARN(WARN_UNINITIALIZED))
2135 return (IV)(SvUVX(sv));
2142 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2143 * without also getting a cached IV/UV from it at the same time
2144 * (ie PV->NV conversion should detect loss of accuracy and cache
2145 * IV or UV at same time to avoid this. NWC */
2147 if (SvTYPE(sv) == SVt_NV)
2148 sv_upgrade(sv, SVt_PVNV);
2150 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2151 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2152 certainly cast into the IV range at IV_MAX, whereas the correct
2153 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2155 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2156 SvIV_set(sv, I_V(SvNVX(sv)));
2157 if (SvNVX(sv) == (NV) SvIVX(sv)
2158 #ifndef NV_PRESERVES_UV
2159 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2160 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2161 /* Don't flag it as "accurately an integer" if the number
2162 came from a (by definition imprecise) NV operation, and
2163 we're outside the range of NV integer precision */
2166 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2167 DEBUG_c(PerlIO_printf(Perl_debug_log,
2168 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2174 /* IV not precise. No need to convert from PV, as NV
2175 conversion would already have cached IV if it detected
2176 that PV->IV would be better than PV->NV->IV
2177 flags already correct - don't set public IOK. */
2178 DEBUG_c(PerlIO_printf(Perl_debug_log,
2179 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2184 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2185 but the cast (NV)IV_MIN rounds to a the value less (more
2186 negative) than IV_MIN which happens to be equal to SvNVX ??
2187 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2188 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2189 (NV)UVX == NVX are both true, but the values differ. :-(
2190 Hopefully for 2s complement IV_MIN is something like
2191 0x8000000000000000 which will be exact. NWC */
2194 SvUV_set(sv, U_V(SvNVX(sv)));
2196 (SvNVX(sv) == (NV) SvUVX(sv))
2197 #ifndef NV_PRESERVES_UV
2198 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2199 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2200 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2201 /* Don't flag it as "accurately an integer" if the number
2202 came from a (by definition imprecise) NV operation, and
2203 we're outside the range of NV integer precision */
2209 DEBUG_c(PerlIO_printf(Perl_debug_log,
2210 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2214 return (IV)SvUVX(sv);
2217 else if (SvPOKp(sv) && SvLEN(sv)) {
2219 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2220 /* We want to avoid a possible problem when we cache an IV which
2221 may be later translated to an NV, and the resulting NV is not
2222 the same as the direct translation of the initial string
2223 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2224 be careful to ensure that the value with the .456 is around if the
2225 NV value is requested in the future).
2227 This means that if we cache such an IV, we need to cache the
2228 NV as well. Moreover, we trade speed for space, and do not
2229 cache the NV if we are sure it's not needed.
2232 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2233 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2234 == IS_NUMBER_IN_UV) {
2235 /* It's definitely an integer, only upgrade to PVIV */
2236 if (SvTYPE(sv) < SVt_PVIV)
2237 sv_upgrade(sv, SVt_PVIV);
2239 } else if (SvTYPE(sv) < SVt_PVNV)
2240 sv_upgrade(sv, SVt_PVNV);
2242 /* If NV preserves UV then we only use the UV value if we know that
2243 we aren't going to call atof() below. If NVs don't preserve UVs
2244 then the value returned may have more precision than atof() will
2245 return, even though value isn't perfectly accurate. */
2246 if ((numtype & (IS_NUMBER_IN_UV
2247 #ifdef NV_PRESERVES_UV
2250 )) == IS_NUMBER_IN_UV) {
2251 /* This won't turn off the public IOK flag if it was set above */
2252 (void)SvIOKp_on(sv);
2254 if (!(numtype & IS_NUMBER_NEG)) {
2256 if (value <= (UV)IV_MAX) {
2257 SvIV_set(sv, (IV)value);
2259 SvUV_set(sv, value);
2263 /* 2s complement assumption */
2264 if (value <= (UV)IV_MIN) {
2265 SvIV_set(sv, -(IV)value);
2267 /* Too negative for an IV. This is a double upgrade, but
2268 I'm assuming it will be rare. */
2269 if (SvTYPE(sv) < SVt_PVNV)
2270 sv_upgrade(sv, SVt_PVNV);
2274 SvNV_set(sv, -(NV)value);
2275 SvIV_set(sv, IV_MIN);
2279 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2280 will be in the previous block to set the IV slot, and the next
2281 block to set the NV slot. So no else here. */
2283 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2284 != IS_NUMBER_IN_UV) {
2285 /* It wasn't an (integer that doesn't overflow the UV). */
2286 SvNV_set(sv, Atof(SvPVX_const(sv)));
2288 if (! numtype && ckWARN(WARN_NUMERIC))
2291 #if defined(USE_LONG_DOUBLE)
2292 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2293 PTR2UV(sv), SvNVX(sv)));
2295 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2296 PTR2UV(sv), SvNVX(sv)));
2300 #ifdef NV_PRESERVES_UV
2301 (void)SvIOKp_on(sv);
2303 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2304 SvIV_set(sv, I_V(SvNVX(sv)));
2305 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2308 /* Integer is imprecise. NOK, IOKp */
2310 /* UV will not work better than IV */
2312 if (SvNVX(sv) > (NV)UV_MAX) {
2314 /* Integer is inaccurate. NOK, IOKp, is UV */
2315 SvUV_set(sv, UV_MAX);
2318 SvUV_set(sv, U_V(SvNVX(sv)));
2319 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2320 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2324 /* Integer is imprecise. NOK, IOKp, is UV */
2330 #else /* NV_PRESERVES_UV */
2331 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2332 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2333 /* The IV slot will have been set from value returned by
2334 grok_number above. The NV slot has just been set using
2337 assert (SvIOKp(sv));
2339 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2340 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2341 /* Small enough to preserve all bits. */
2342 (void)SvIOKp_on(sv);
2344 SvIV_set(sv, I_V(SvNVX(sv)));
2345 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2347 /* Assumption: first non-preserved integer is < IV_MAX,
2348 this NV is in the preserved range, therefore: */
2349 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2351 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);
2355 0 0 already failed to read UV.
2356 0 1 already failed to read UV.
2357 1 0 you won't get here in this case. IV/UV
2358 slot set, public IOK, Atof() unneeded.
2359 1 1 already read UV.
2360 so there's no point in sv_2iuv_non_preserve() attempting
2361 to use atol, strtol, strtoul etc. */
2362 if (sv_2iuv_non_preserve (sv, numtype)
2363 >= IS_NUMBER_OVERFLOW_IV)
2367 #endif /* NV_PRESERVES_UV */
2370 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2372 if (SvTYPE(sv) < SVt_IV)
2373 /* Typically the caller expects that sv_any is not NULL now. */
2374 sv_upgrade(sv, SVt_IV);
2377 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2378 PTR2UV(sv),SvIVX(sv)));
2379 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2382 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2383 * this function provided for binary compatibility only
2387 Perl_sv_2uv(pTHX_ register SV *sv)
2389 return sv_2uv_flags(sv, SV_GMAGIC);
2393 =for apidoc sv_2uv_flags
2395 Return the unsigned integer value of an SV, doing any necessary string
2396 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2397 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2403 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2407 if (SvGMAGICAL(sv)) {
2408 if (flags & SV_GMAGIC)
2413 return U_V(SvNVX(sv));
2414 if (SvPOKp(sv) && SvLEN(sv))
2417 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2418 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2424 if (SvTHINKFIRST(sv)) {
2427 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2428 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2429 return SvUV(tmpstr);
2430 return PTR2UV(SvRV(sv));
2433 sv_force_normal_flags(sv, 0);
2435 if (SvREADONLY(sv) && !SvOK(sv)) {
2436 if (ckWARN(WARN_UNINITIALIZED))
2446 return (UV)SvIVX(sv);
2450 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2451 * without also getting a cached IV/UV from it at the same time
2452 * (ie PV->NV conversion should detect loss of accuracy and cache
2453 * IV or UV at same time to avoid this. */
2454 /* IV-over-UV optimisation - choose to cache IV if possible */
2456 if (SvTYPE(sv) == SVt_NV)
2457 sv_upgrade(sv, SVt_PVNV);
2459 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2460 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2461 SvIV_set(sv, I_V(SvNVX(sv)));
2462 if (SvNVX(sv) == (NV) SvIVX(sv)
2463 #ifndef NV_PRESERVES_UV
2464 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2465 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2466 /* Don't flag it as "accurately an integer" if the number
2467 came from a (by definition imprecise) NV operation, and
2468 we're outside the range of NV integer precision */
2471 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2472 DEBUG_c(PerlIO_printf(Perl_debug_log,
2473 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2479 /* IV not precise. No need to convert from PV, as NV
2480 conversion would already have cached IV if it detected
2481 that PV->IV would be better than PV->NV->IV
2482 flags already correct - don't set public IOK. */
2483 DEBUG_c(PerlIO_printf(Perl_debug_log,
2484 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2489 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2490 but the cast (NV)IV_MIN rounds to a the value less (more
2491 negative) than IV_MIN which happens to be equal to SvNVX ??
2492 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2493 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2494 (NV)UVX == NVX are both true, but the values differ. :-(
2495 Hopefully for 2s complement IV_MIN is something like
2496 0x8000000000000000 which will be exact. NWC */
2499 SvUV_set(sv, U_V(SvNVX(sv)));
2501 (SvNVX(sv) == (NV) SvUVX(sv))
2502 #ifndef NV_PRESERVES_UV
2503 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2504 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2505 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2506 /* Don't flag it as "accurately an integer" if the number
2507 came from a (by definition imprecise) NV operation, and
2508 we're outside the range of NV integer precision */
2513 DEBUG_c(PerlIO_printf(Perl_debug_log,
2514 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2520 else if (SvPOKp(sv) && SvLEN(sv)) {
2522 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2524 /* We want to avoid a possible problem when we cache a UV which
2525 may be later translated to an NV, and the resulting NV is not
2526 the translation of the initial data.
2528 This means that if we cache such a UV, we need to cache the
2529 NV as well. Moreover, we trade speed for space, and do not
2530 cache the NV if not needed.
2533 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2534 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2535 == IS_NUMBER_IN_UV) {
2536 /* It's definitely an integer, only upgrade to PVIV */
2537 if (SvTYPE(sv) < SVt_PVIV)
2538 sv_upgrade(sv, SVt_PVIV);
2540 } else if (SvTYPE(sv) < SVt_PVNV)
2541 sv_upgrade(sv, SVt_PVNV);
2543 /* If NV preserves UV then we only use the UV value if we know that
2544 we aren't going to call atof() below. If NVs don't preserve UVs
2545 then the value returned may have more precision than atof() will
2546 return, even though it isn't accurate. */
2547 if ((numtype & (IS_NUMBER_IN_UV
2548 #ifdef NV_PRESERVES_UV
2551 )) == IS_NUMBER_IN_UV) {
2552 /* This won't turn off the public IOK flag if it was set above */
2553 (void)SvIOKp_on(sv);
2555 if (!(numtype & IS_NUMBER_NEG)) {
2557 if (value <= (UV)IV_MAX) {
2558 SvIV_set(sv, (IV)value);
2560 /* it didn't overflow, and it was positive. */
2561 SvUV_set(sv, value);
2565 /* 2s complement assumption */
2566 if (value <= (UV)IV_MIN) {
2567 SvIV_set(sv, -(IV)value);
2569 /* Too negative for an IV. This is a double upgrade, but
2570 I'm assuming it will be rare. */
2571 if (SvTYPE(sv) < SVt_PVNV)
2572 sv_upgrade(sv, SVt_PVNV);
2576 SvNV_set(sv, -(NV)value);
2577 SvIV_set(sv, IV_MIN);
2582 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2583 != IS_NUMBER_IN_UV) {
2584 /* It wasn't an integer, or it overflowed the UV. */
2585 SvNV_set(sv, Atof(SvPVX_const(sv)));
2587 if (! numtype && ckWARN(WARN_NUMERIC))
2590 #if defined(USE_LONG_DOUBLE)
2591 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2592 PTR2UV(sv), SvNVX(sv)));
2594 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2595 PTR2UV(sv), SvNVX(sv)));
2598 #ifdef NV_PRESERVES_UV
2599 (void)SvIOKp_on(sv);
2601 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2602 SvIV_set(sv, I_V(SvNVX(sv)));
2603 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2606 /* Integer is imprecise. NOK, IOKp */
2608 /* UV will not work better than IV */
2610 if (SvNVX(sv) > (NV)UV_MAX) {
2612 /* Integer is inaccurate. NOK, IOKp, is UV */
2613 SvUV_set(sv, UV_MAX);
2616 SvUV_set(sv, U_V(SvNVX(sv)));
2617 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2618 NV preservse UV so can do correct comparison. */
2619 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2623 /* Integer is imprecise. NOK, IOKp, is UV */
2628 #else /* NV_PRESERVES_UV */
2629 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2630 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2631 /* The UV slot will have been set from value returned by
2632 grok_number above. The NV slot has just been set using
2635 assert (SvIOKp(sv));
2637 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2638 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2639 /* Small enough to preserve all bits. */
2640 (void)SvIOKp_on(sv);
2642 SvIV_set(sv, I_V(SvNVX(sv)));
2643 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2645 /* Assumption: first non-preserved integer is < IV_MAX,
2646 this NV is in the preserved range, therefore: */
2647 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2649 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);
2652 sv_2iuv_non_preserve (sv, numtype);
2654 #endif /* NV_PRESERVES_UV */
2658 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2659 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2662 if (SvTYPE(sv) < SVt_IV)
2663 /* Typically the caller expects that sv_any is not NULL now. */
2664 sv_upgrade(sv, SVt_IV);
2668 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2669 PTR2UV(sv),SvUVX(sv)));
2670 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2676 Return the num value of an SV, doing any necessary string or integer
2677 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2684 Perl_sv_2nv(pTHX_ register SV *sv)
2688 if (SvGMAGICAL(sv)) {
2692 if (SvPOKp(sv) && SvLEN(sv)) {
2693 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2694 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2696 return Atof(SvPVX_const(sv));
2700 return (NV)SvUVX(sv);
2702 return (NV)SvIVX(sv);
2705 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2706 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2712 if (SvTHINKFIRST(sv)) {
2715 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2716 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2717 return SvNV(tmpstr);
2718 return PTR2NV(SvRV(sv));
2721 sv_force_normal_flags(sv, 0);
2723 if (SvREADONLY(sv) && !SvOK(sv)) {
2724 if (ckWARN(WARN_UNINITIALIZED))
2729 if (SvTYPE(sv) < SVt_NV) {
2730 if (SvTYPE(sv) == SVt_IV)
2731 sv_upgrade(sv, SVt_PVNV);
2733 sv_upgrade(sv, SVt_NV);
2734 #ifdef USE_LONG_DOUBLE
2736 STORE_NUMERIC_LOCAL_SET_STANDARD();
2737 PerlIO_printf(Perl_debug_log,
2738 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2739 PTR2UV(sv), SvNVX(sv));
2740 RESTORE_NUMERIC_LOCAL();
2744 STORE_NUMERIC_LOCAL_SET_STANDARD();
2745 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2746 PTR2UV(sv), SvNVX(sv));
2747 RESTORE_NUMERIC_LOCAL();
2751 else if (SvTYPE(sv) < SVt_PVNV)
2752 sv_upgrade(sv, SVt_PVNV);
2757 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2758 #ifdef NV_PRESERVES_UV
2761 /* Only set the public NV OK flag if this NV preserves the IV */
2762 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2763 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2764 : (SvIVX(sv) == I_V(SvNVX(sv))))
2770 else if (SvPOKp(sv) && SvLEN(sv)) {
2772 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2773 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2775 #ifdef NV_PRESERVES_UV
2776 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2777 == IS_NUMBER_IN_UV) {
2778 /* It's definitely an integer */
2779 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2781 SvNV_set(sv, Atof(SvPVX_const(sv)));
2784 SvNV_set(sv, Atof(SvPVX_const(sv)));
2785 /* Only set the public NV OK flag if this NV preserves the value in
2786 the PV at least as well as an IV/UV would.
2787 Not sure how to do this 100% reliably. */
2788 /* if that shift count is out of range then Configure's test is
2789 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2791 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2792 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2793 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2794 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2795 /* Can't use strtol etc to convert this string, so don't try.
2796 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2799 /* value has been set. It may not be precise. */
2800 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2801 /* 2s complement assumption for (UV)IV_MIN */
2802 SvNOK_on(sv); /* Integer is too negative. */
2807 if (numtype & IS_NUMBER_NEG) {
2808 SvIV_set(sv, -(IV)value);
2809 } else if (value <= (UV)IV_MAX) {
2810 SvIV_set(sv, (IV)value);
2812 SvUV_set(sv, value);
2816 if (numtype & IS_NUMBER_NOT_INT) {
2817 /* I believe that even if the original PV had decimals,
2818 they are lost beyond the limit of the FP precision.
2819 However, neither is canonical, so both only get p
2820 flags. NWC, 2000/11/25 */
2821 /* Both already have p flags, so do nothing */
2823 const NV nv = SvNVX(sv);
2824 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2825 if (SvIVX(sv) == I_V(nv)) {
2830 /* It had no "." so it must be integer. */
2833 /* between IV_MAX and NV(UV_MAX).
2834 Could be slightly > UV_MAX */
2836 if (numtype & IS_NUMBER_NOT_INT) {
2837 /* UV and NV both imprecise. */
2839 const UV nv_as_uv = U_V(nv);
2841 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2852 #endif /* NV_PRESERVES_UV */
2855 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2857 if (SvTYPE(sv) < SVt_NV)
2858 /* Typically the caller expects that sv_any is not NULL now. */
2859 /* XXX Ilya implies that this is a bug in callers that assume this
2860 and ideally should be fixed. */
2861 sv_upgrade(sv, SVt_NV);
2864 #if defined(USE_LONG_DOUBLE)
2866 STORE_NUMERIC_LOCAL_SET_STANDARD();
2867 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2868 PTR2UV(sv), SvNVX(sv));
2869 RESTORE_NUMERIC_LOCAL();
2873 STORE_NUMERIC_LOCAL_SET_STANDARD();
2874 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2875 PTR2UV(sv), SvNVX(sv));
2876 RESTORE_NUMERIC_LOCAL();
2882 /* asIV(): extract an integer from the string value of an SV.
2883 * Caller must validate PVX */
2886 S_asIV(pTHX_ SV *sv)
2889 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2891 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2892 == IS_NUMBER_IN_UV) {
2893 /* It's definitely an integer */
2894 if (numtype & IS_NUMBER_NEG) {
2895 if (value < (UV)IV_MIN)
2898 if (value < (UV)IV_MAX)
2903 if (ckWARN(WARN_NUMERIC))
2906 return I_V(Atof(SvPVX_const(sv)));
2909 /* asUV(): extract an unsigned integer from the string value of an SV
2910 * Caller must validate PVX */
2913 S_asUV(pTHX_ SV *sv)
2916 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2918 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2919 == IS_NUMBER_IN_UV) {
2920 /* It's definitely an integer */
2921 if (!(numtype & IS_NUMBER_NEG))
2925 if (ckWARN(WARN_NUMERIC))
2928 return U_V(Atof(SvPVX_const(sv)));
2932 =for apidoc sv_2pv_nolen
2934 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2935 use the macro wrapper C<SvPV_nolen(sv)> instead.
2940 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2942 return sv_2pv(sv, 0);
2945 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2946 * UV as a string towards the end of buf, and return pointers to start and
2949 * We assume that buf is at least TYPE_CHARS(UV) long.
2953 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2955 char *ptr = buf + TYPE_CHARS(UV);
2969 *--ptr = '0' + (char)(uv % 10);
2977 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2978 * this function provided for binary compatibility only
2982 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2984 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2988 =for apidoc sv_2pv_flags
2990 Returns a pointer to the string value of an SV, and sets *lp to its length.
2991 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2993 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2994 usually end up here too.
3000 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3005 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3006 char *tmpbuf = tbuf;
3013 if (SvGMAGICAL(sv)) {
3014 if (flags & SV_GMAGIC)
3019 if (flags & SV_MUTABLE_RETURN)
3020 return SvPVX_mutable(sv);
3021 if (flags & SV_CONST_RETURN)
3022 return (char *)SvPVX_const(sv);
3027 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3029 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3034 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3039 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3040 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3048 if (SvTHINKFIRST(sv)) {
3051 register const char *typestr;
3052 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3053 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3055 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3058 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3059 if (flags & SV_CONST_RETURN) {
3060 pv = (char *) SvPVX_const(tmpstr);
3062 pv = (flags & SV_MUTABLE_RETURN)
3063 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3066 *lp = SvCUR(tmpstr);
3068 pv = sv_2pv_flags(tmpstr, lp, flags);
3079 typestr = "NULLREF";
3083 switch (SvTYPE(sv)) {
3085 if ( ((SvFLAGS(sv) &
3086 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3087 == (SVs_OBJECT|SVs_SMG))
3088 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3089 const regexp *re = (regexp *)mg->mg_obj;
3092 const char *fptr = "msix";
3097 char need_newline = 0;
3098 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3100 while((ch = *fptr++)) {
3102 reflags[left++] = ch;
3105 reflags[right--] = ch;
3110 reflags[left] = '-';
3114 mg->mg_len = re->prelen + 4 + left;
3116 * If /x was used, we have to worry about a regex
3117 * ending with a comment later being embedded
3118 * within another regex. If so, we don't want this
3119 * regex's "commentization" to leak out to the
3120 * right part of the enclosing regex, we must cap
3121 * it with a newline.
3123 * So, if /x was used, we scan backwards from the
3124 * end of the regex. If we find a '#' before we
3125 * find a newline, we need to add a newline
3126 * ourself. If we find a '\n' first (or if we
3127 * don't find '#' or '\n'), we don't need to add
3128 * anything. -jfriedl
3130 if (PMf_EXTENDED & re->reganch)
3132 const char *endptr = re->precomp + re->prelen;
3133 while (endptr >= re->precomp)
3135 const char c = *(endptr--);
3137 break; /* don't need another */
3139 /* we end while in a comment, so we
3141 mg->mg_len++; /* save space for it */
3142 need_newline = 1; /* note to add it */
3148 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3149 Copy("(?", mg->mg_ptr, 2, char);
3150 Copy(reflags, mg->mg_ptr+2, left, char);
3151 Copy(":", mg->mg_ptr+left+2, 1, char);
3152 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3154 mg->mg_ptr[mg->mg_len - 2] = '\n';
3155 mg->mg_ptr[mg->mg_len - 1] = ')';
3156 mg->mg_ptr[mg->mg_len] = 0;
3158 PL_reginterp_cnt += re->program[0].next_off;
3160 if (re->reganch & ROPT_UTF8)
3176 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3177 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3178 /* tied lvalues should appear to be
3179 * scalars for backwards compatitbility */
3180 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3181 ? "SCALAR" : "LVALUE"; break;
3182 case SVt_PVAV: typestr = "ARRAY"; break;
3183 case SVt_PVHV: typestr = "HASH"; break;
3184 case SVt_PVCV: typestr = "CODE"; break;
3185 case SVt_PVGV: typestr = "GLOB"; break;
3186 case SVt_PVFM: typestr = "FORMAT"; break;
3187 case SVt_PVIO: typestr = "IO"; break;
3188 default: typestr = "UNKNOWN"; break;
3192 const char *name = HvNAME_get(SvSTASH(sv));
3193 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3194 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3197 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3201 *lp = strlen(typestr);
3202 return (char *)typestr;
3204 if (SvREADONLY(sv) && !SvOK(sv)) {
3205 if (ckWARN(WARN_UNINITIALIZED))
3212 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3213 /* I'm assuming that if both IV and NV are equally valid then
3214 converting the IV is going to be more efficient */
3215 const U32 isIOK = SvIOK(sv);
3216 const U32 isUIOK = SvIsUV(sv);
3217 char buf[TYPE_CHARS(UV)];
3220 if (SvTYPE(sv) < SVt_PVIV)
3221 sv_upgrade(sv, SVt_PVIV);
3223 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3225 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3226 /* inlined from sv_setpvn */
3227 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3228 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3229 SvCUR_set(sv, ebuf - ptr);
3239 else if (SvNOKp(sv)) {
3240 if (SvTYPE(sv) < SVt_PVNV)
3241 sv_upgrade(sv, SVt_PVNV);
3242 /* The +20 is pure guesswork. Configure test needed. --jhi */
3243 s = SvGROW_mutable(sv, NV_DIG + 20);
3244 olderrno = errno; /* some Xenix systems wipe out errno here */
3246 if (SvNVX(sv) == 0.0)
3247 (void)strcpy(s,"0");
3251 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3254 #ifdef FIXNEGATIVEZERO
3255 if (*s == '-' && s[1] == '0' && !s[2])
3265 if (ckWARN(WARN_UNINITIALIZED)
3266 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3270 if (SvTYPE(sv) < SVt_PV)
3271 /* Typically the caller expects that sv_any is not NULL now. */
3272 sv_upgrade(sv, SVt_PV);
3276 STRLEN len = s - SvPVX_const(sv);
3282 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3283 PTR2UV(sv),SvPVX_const(sv)));
3284 if (flags & SV_CONST_RETURN)
3285 return (char *)SvPVX_const(sv);
3286 if (flags & SV_MUTABLE_RETURN)
3287 return SvPVX_mutable(sv);
3291 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3292 /* Sneaky stuff here */
3296 tsv = newSVpv(tmpbuf, 0);
3309 t = SvPVX_const(tsv);
3314 len = strlen(tmpbuf);
3316 #ifdef FIXNEGATIVEZERO
3317 if (len == 2 && t[0] == '-' && t[1] == '0') {
3322 SvUPGRADE(sv, SVt_PV);
3325 s = SvGROW_mutable(sv, len + 1);
3328 return strcpy(s, t);
3333 =for apidoc sv_copypv
3335 Copies a stringified representation of the source SV into the
3336 destination SV. Automatically performs any necessary mg_get and
3337 coercion of numeric values into strings. Guaranteed to preserve
3338 UTF-8 flag even from overloaded objects. Similar in nature to
3339 sv_2pv[_flags] but operates directly on an SV instead of just the
3340 string. Mostly uses sv_2pv_flags to do its work, except when that
3341 would lose the UTF-8'ness of the PV.
3347 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3351 s = SvPV_const(ssv,len);
3352 sv_setpvn(dsv,s,len);
3360 =for apidoc sv_2pvbyte_nolen
3362 Return a pointer to the byte-encoded representation of the SV.
3363 May cause the SV to be downgraded from UTF-8 as a side-effect.
3365 Usually accessed via the C<SvPVbyte_nolen> macro.
3371 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3373 return sv_2pvbyte(sv, 0);
3377 =for apidoc sv_2pvbyte
3379 Return a pointer to the byte-encoded representation of the SV, and set *lp
3380 to its length. May cause the SV to be downgraded from UTF-8 as a
3383 Usually accessed via the C<SvPVbyte> macro.
3389 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3391 sv_utf8_downgrade(sv,0);
3392 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3396 =for apidoc sv_2pvutf8_nolen
3398 Return a pointer to the UTF-8-encoded representation of the SV.
3399 May cause the SV to be upgraded to UTF-8 as a side-effect.
3401 Usually accessed via the C<SvPVutf8_nolen> macro.
3407 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3409 return sv_2pvutf8(sv, 0);
3413 =for apidoc sv_2pvutf8
3415 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3416 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3418 Usually accessed via the C<SvPVutf8> macro.
3424 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3426 sv_utf8_upgrade(sv);
3427 return SvPV(sv,*lp);
3431 =for apidoc sv_2bool
3433 This function is only called on magical items, and is only used by
3434 sv_true() or its macro equivalent.
3440 Perl_sv_2bool(pTHX_ register SV *sv)
3449 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3450 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3451 return (bool)SvTRUE(tmpsv);
3452 return SvRV(sv) != 0;
3455 register XPV* Xpvtmp;
3456 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3457 (*sv->sv_u.svu_pv > '0' ||
3458 Xpvtmp->xpv_cur > 1 ||
3459 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3466 return SvIVX(sv) != 0;
3469 return SvNVX(sv) != 0.0;
3476 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3477 * this function provided for binary compatibility only
3482 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3484 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3488 =for apidoc sv_utf8_upgrade
3490 Converts the PV of an SV to its UTF-8-encoded form.
3491 Forces the SV to string form if it is not already.
3492 Always sets the SvUTF8 flag to avoid future validity checks even
3493 if all the bytes have hibit clear.
3495 This is not as a general purpose byte encoding to Unicode interface:
3496 use the Encode extension for that.
3498 =for apidoc sv_utf8_upgrade_flags
3500 Converts the PV of an SV to its UTF-8-encoded form.
3501 Forces the SV to string form if it is not already.
3502 Always sets the SvUTF8 flag to avoid future validity checks even
3503 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3504 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3505 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3507 This is not as a general purpose byte encoding to Unicode interface:
3508 use the Encode extension for that.
3514 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3516 if (sv == &PL_sv_undef)
3520 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3521 (void) sv_2pv_flags(sv,&len, flags);
3525 (void) SvPV_force(sv,len);
3534 sv_force_normal_flags(sv, 0);
3537 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3538 sv_recode_to_utf8(sv, PL_encoding);
3539 else { /* Assume Latin-1/EBCDIC */
3540 /* This function could be much more efficient if we
3541 * had a FLAG in SVs to signal if there are any hibit
3542 * chars in the PV. Given that there isn't such a flag
3543 * make the loop as fast as possible. */
3544 const U8 *s = (U8 *) SvPVX_const(sv);
3545 const U8 *e = (U8 *) SvEND(sv);
3551 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3555 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3556 U8 *recoded = bytes_to_utf8((U8*)s, &len);
3558 SvPV_free(sv); /* No longer using what was there before. */
3560 SvPV_set(sv, (char*)recoded);
3561 SvCUR_set(sv, len - 1);
3562 SvLEN_set(sv, len); /* No longer know the real size. */
3564 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3571 =for apidoc sv_utf8_downgrade
3573 Attempts to convert the PV of an SV from characters to bytes.
3574 If the PV contains a character beyond byte, this conversion will fail;
3575 in this case, either returns false or, if C<fail_ok> is not
3578 This is not as a general purpose Unicode to byte encoding interface:
3579 use the Encode extension for that.
3585 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3587 if (SvPOKp(sv) && SvUTF8(sv)) {
3593 sv_force_normal_flags(sv, 0);
3595 s = (U8 *) SvPV(sv, len);
3596 if (!utf8_to_bytes(s, &len)) {
3601 Perl_croak(aTHX_ "Wide character in %s",
3604 Perl_croak(aTHX_ "Wide character");
3615 =for apidoc sv_utf8_encode
3617 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3618 flag off so that it looks like octets again.
3624 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3626 (void) sv_utf8_upgrade(sv);
3628 sv_force_normal_flags(sv, 0);
3630 if (SvREADONLY(sv)) {
3631 Perl_croak(aTHX_ PL_no_modify);
3637 =for apidoc sv_utf8_decode
3639 If the PV of the SV is an octet sequence in UTF-8
3640 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3641 so that it looks like a character. If the PV contains only single-byte
3642 characters, the C<SvUTF8> flag stays being off.
3643 Scans PV for validity and returns false if the PV is invalid UTF-8.
3649 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3655 /* The octets may have got themselves encoded - get them back as
3658 if (!sv_utf8_downgrade(sv, TRUE))
3661 /* it is actually just a matter of turning the utf8 flag on, but
3662 * we want to make sure everything inside is valid utf8 first.
3664 c = (const U8 *) SvPVX_const(sv);
3665 if (!is_utf8_string(c, SvCUR(sv)+1))
3667 e = (const U8 *) SvEND(sv);
3670 if (!UTF8_IS_INVARIANT(ch)) {
3679 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3680 * this function provided for binary compatibility only
3684 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3686 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3690 =for apidoc sv_setsv
3692 Copies the contents of the source SV C<ssv> into the destination SV
3693 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3694 function if the source SV needs to be reused. Does not handle 'set' magic.
3695 Loosely speaking, it performs a copy-by-value, obliterating any previous
3696 content of the destination.
3698 You probably want to use one of the assortment of wrappers, such as
3699 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3700 C<SvSetMagicSV_nosteal>.
3702 =for apidoc sv_setsv_flags
3704 Copies the contents of the source SV C<ssv> into the destination SV
3705 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3706 function if the source SV needs to be reused. Does not handle 'set' magic.
3707 Loosely speaking, it performs a copy-by-value, obliterating any previous
3708 content of the destination.
3709 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3710 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3711 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3712 and C<sv_setsv_nomg> are implemented in terms of this function.
3714 You probably want to use one of the assortment of wrappers, such as
3715 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3716 C<SvSetMagicSV_nosteal>.
3718 This is the primary function for copying scalars, and most other
3719 copy-ish functions and macros use this underneath.
3725 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3727 register U32 sflags;
3733 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3735 sstr = &PL_sv_undef;
3736 stype = SvTYPE(sstr);
3737 dtype = SvTYPE(dstr);
3742 /* need to nuke the magic */
3744 SvRMAGICAL_off(dstr);
3747 /* There's a lot of redundancy below but we're going for speed here */
3752 if (dtype != SVt_PVGV) {
3753 (void)SvOK_off(dstr);
3761 sv_upgrade(dstr, SVt_IV);
3764 sv_upgrade(dstr, SVt_PVNV);
3768 sv_upgrade(dstr, SVt_PVIV);
3771 (void)SvIOK_only(dstr);
3772 SvIV_set(dstr, SvIVX(sstr));
3775 if (SvTAINTED(sstr))
3786 sv_upgrade(dstr, SVt_NV);
3791 sv_upgrade(dstr, SVt_PVNV);
3794 SvNV_set(dstr, SvNVX(sstr));
3795 (void)SvNOK_only(dstr);
3796 if (SvTAINTED(sstr))
3804 sv_upgrade(dstr, SVt_RV);
3805 else if (dtype == SVt_PVGV &&
3806 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3809 if (GvIMPORTED(dstr) != GVf_IMPORTED
3810 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3812 GvIMPORTED_on(dstr);
3821 #ifdef PERL_OLD_COPY_ON_WRITE
3822 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3823 if (dtype < SVt_PVIV)
3824 sv_upgrade(dstr, SVt_PVIV);
3831 sv_upgrade(dstr, SVt_PV);
3834 if (dtype < SVt_PVIV)
3835 sv_upgrade(dstr, SVt_PVIV);
3838 if (dtype < SVt_PVNV)
3839 sv_upgrade(dstr, SVt_PVNV);
3846 const char * const type = sv_reftype(sstr,0);
3848 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3850 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3855 if (dtype <= SVt_PVGV) {
3857 if (dtype != SVt_PVGV) {
3858 const char * const name = GvNAME(sstr);
3859 const STRLEN len = GvNAMELEN(sstr);
3860 /* don't upgrade SVt_PVLV: it can hold a glob */
3861 if (dtype != SVt_PVLV)
3862 sv_upgrade(dstr, SVt_PVGV);
3863 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3864 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3865 GvNAME(dstr) = savepvn(name, len);
3866 GvNAMELEN(dstr) = len;
3867 SvFAKE_on(dstr); /* can coerce to non-glob */
3869 /* ahem, death to those who redefine active sort subs */
3870 else if (PL_curstackinfo->si_type == PERLSI_SORT
3871 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3872 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3875 #ifdef GV_UNIQUE_CHECK
3876 if (GvUNIQUE((GV*)dstr)) {
3877 Perl_croak(aTHX_ PL_no_modify);
3881 (void)SvOK_off(dstr);
3882 GvINTRO_off(dstr); /* one-shot flag */
3884 GvGP(dstr) = gp_ref(GvGP(sstr));
3885 if (SvTAINTED(sstr))
3887 if (GvIMPORTED(dstr) != GVf_IMPORTED
3888 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3890 GvIMPORTED_on(dstr);
3898 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3900 if ((int)SvTYPE(sstr) != stype) {
3901 stype = SvTYPE(sstr);
3902 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3906 if (stype == SVt_PVLV)
3907 SvUPGRADE(dstr, SVt_PVNV);
3909 SvUPGRADE(dstr, (U32)stype);
3912 sflags = SvFLAGS(sstr);
3914 if (sflags & SVf_ROK) {
3915 if (dtype >= SVt_PV) {
3916 if (dtype == SVt_PVGV) {
3917 SV *sref = SvREFCNT_inc(SvRV(sstr));
3919 const int intro = GvINTRO(dstr);
3921 #ifdef GV_UNIQUE_CHECK
3922 if (GvUNIQUE((GV*)dstr)) {
3923 Perl_croak(aTHX_ PL_no_modify);
3928 GvINTRO_off(dstr); /* one-shot flag */
3929 GvLINE(dstr) = CopLINE(PL_curcop);
3930 GvEGV(dstr) = (GV*)dstr;
3933 switch (SvTYPE(sref)) {
3936 SAVEGENERICSV(GvAV(dstr));
3938 dref = (SV*)GvAV(dstr);
3939 GvAV(dstr) = (AV*)sref;
3940 if (!GvIMPORTED_AV(dstr)
3941 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3943 GvIMPORTED_AV_on(dstr);
3948 SAVEGENERICSV(GvHV(dstr));
3950 dref = (SV*)GvHV(dstr);
3951 GvHV(dstr) = (HV*)sref;
3952 if (!GvIMPORTED_HV(dstr)
3953 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3955 GvIMPORTED_HV_on(dstr);
3960 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3961 SvREFCNT_dec(GvCV(dstr));
3962 GvCV(dstr) = Nullcv;
3963 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3964 PL_sub_generation++;
3966 SAVEGENERICSV(GvCV(dstr));
3969 dref = (SV*)GvCV(dstr);
3970 if (GvCV(dstr) != (CV*)sref) {
3971 CV* cv = GvCV(dstr);
3973 if (!GvCVGEN((GV*)dstr) &&
3974 (CvROOT(cv) || CvXSUB(cv)))
3976 /* ahem, death to those who redefine
3977 * active sort subs */
3978 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3979 PL_sortcop == CvSTART(cv))
3981 "Can't redefine active sort subroutine %s",
3982 GvENAME((GV*)dstr));
3983 /* Redefining a sub - warning is mandatory if
3984 it was a const and its value changed. */
3985 if (ckWARN(WARN_REDEFINE)
3987 && (!CvCONST((CV*)sref)
3988 || sv_cmp(cv_const_sv(cv),
3989 cv_const_sv((CV*)sref)))))
3991 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3993 ? "Constant subroutine %s::%s redefined"
3994 : "Subroutine %s::%s redefined",
3995 HvNAME_get(GvSTASH((GV*)dstr)),
3996 GvENAME((GV*)dstr));
4000 cv_ckproto(cv, (GV*)dstr,
4002 ? SvPVX_const(sref) : Nullch);
4004 GvCV(dstr) = (CV*)sref;
4005 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4006 GvASSUMECV_on(dstr);
4007 PL_sub_generation++;
4009 if (!GvIMPORTED_CV(dstr)
4010 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4012 GvIMPORTED_CV_on(dstr);
4017 SAVEGENERICSV(GvIOp(dstr));
4019 dref = (SV*)GvIOp(dstr);
4020 GvIOp(dstr) = (IO*)sref;
4024 SAVEGENERICSV(GvFORM(dstr));
4026 dref = (SV*)GvFORM(dstr);
4027 GvFORM(dstr) = (CV*)sref;
4031 SAVEGENERICSV(GvSV(dstr));
4033 dref = (SV*)GvSV(dstr);
4035 if (!GvIMPORTED_SV(dstr)
4036 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4038 GvIMPORTED_SV_on(dstr);
4044 if (SvTAINTED(sstr))
4048 if (SvPVX_const(dstr)) {
4054 (void)SvOK_off(dstr);
4055 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4057 if (sflags & SVp_NOK) {
4059 /* Only set the public OK flag if the source has public OK. */
4060 if (sflags & SVf_NOK)
4061 SvFLAGS(dstr) |= SVf_NOK;
4062 SvNV_set(dstr, SvNVX(sstr));
4064 if (sflags & SVp_IOK) {
4065 (void)SvIOKp_on(dstr);
4066 if (sflags & SVf_IOK)
4067 SvFLAGS(dstr) |= SVf_IOK;
4068 if (sflags & SVf_IVisUV)
4070 SvIV_set(dstr, SvIVX(sstr));
4072 if (SvAMAGIC(sstr)) {
4076 else if (sflags & SVp_POK) {
4080 * Check to see if we can just swipe the string. If so, it's a
4081 * possible small lose on short strings, but a big win on long ones.
4082 * It might even be a win on short strings if SvPVX_const(dstr)
4083 * has to be allocated and SvPVX_const(sstr) has to be freed.
4086 /* Whichever path we take through the next code, we want this true,
4087 and doing it now facilitates the COW check. */
4088 (void)SvPOK_only(dstr);
4091 /* We're not already COW */
4092 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4093 #ifndef PERL_OLD_COPY_ON_WRITE
4094 /* or we are, but dstr isn't a suitable target. */
4095 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4100 (sflags & SVs_TEMP) && /* slated for free anyway? */
4101 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4102 (!(flags & SV_NOSTEAL)) &&
4103 /* and we're allowed to steal temps */
4104 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4105 SvLEN(sstr) && /* and really is a string */
4106 /* and won't be needed again, potentially */
4107 !(PL_op && PL_op->op_type == OP_AASSIGN))
4108 #ifdef PERL_OLD_COPY_ON_WRITE
4109 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4110 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4111 && SvTYPE(sstr) >= SVt_PVIV)
4114 /* Failed the swipe test, and it's not a shared hash key either.
4115 Have to copy the string. */
4116 STRLEN len = SvCUR(sstr);
4117 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4118 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4119 SvCUR_set(dstr, len);
4120 *SvEND(dstr) = '\0';
4122 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4124 /* Either it's a shared hash key, or it's suitable for
4125 copy-on-write or we can swipe the string. */
4127 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4131 #ifdef PERL_OLD_COPY_ON_WRITE
4133 /* I believe I should acquire a global SV mutex if
4134 it's a COW sv (not a shared hash key) to stop
4135 it going un copy-on-write.
4136 If the source SV has gone un copy on write between up there
4137 and down here, then (assert() that) it is of the correct
4138 form to make it copy on write again */
4139 if ((sflags & (SVf_FAKE | SVf_READONLY))
4140 != (SVf_FAKE | SVf_READONLY)) {
4141 SvREADONLY_on(sstr);
4143 /* Make the source SV into a loop of 1.
4144 (about to become 2) */
4145 SV_COW_NEXT_SV_SET(sstr, sstr);
4149 /* Initial code is common. */
4150 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4152 SvFLAGS(dstr) &= ~SVf_OOK;
4153 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4155 else if (SvLEN(dstr))
4156 Safefree(SvPVX_const(dstr));
4160 /* making another shared SV. */
4161 STRLEN cur = SvCUR(sstr);
4162 STRLEN len = SvLEN(sstr);
4163 #ifdef PERL_OLD_COPY_ON_WRITE
4165 assert (SvTYPE(dstr) >= SVt_PVIV);
4166 /* SvIsCOW_normal */
4167 /* splice us in between source and next-after-source. */
4168 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4169 SV_COW_NEXT_SV_SET(sstr, dstr);
4170 SvPV_set(dstr, SvPVX_mutable(sstr));
4174 /* SvIsCOW_shared_hash */
4175 DEBUG_C(PerlIO_printf(Perl_debug_log,
4176 "Copy on write: Sharing hash\n"));
4178 assert (SvTYPE(dstr) >= SVt_PV);
4180 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4182 SvLEN_set(dstr, len);
4183 SvCUR_set(dstr, cur);
4184 SvREADONLY_on(dstr);
4186 /* Relesase a global SV mutex. */
4189 { /* Passes the swipe test. */
4190 SvPV_set(dstr, SvPVX_mutable(sstr));
4191 SvLEN_set(dstr, SvLEN(sstr));
4192 SvCUR_set(dstr, SvCUR(sstr));
4195 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4196 SvPV_set(sstr, Nullch);
4202 if (sflags & SVf_UTF8)
4204 if (sflags & SVp_NOK) {
4206 if (sflags & SVf_NOK)
4207 SvFLAGS(dstr) |= SVf_NOK;
4208 SvNV_set(dstr, SvNVX(sstr));
4210 if (sflags & SVp_IOK) {
4211 (void)SvIOKp_on(dstr);
4212 if (sflags & SVf_IOK)
4213 SvFLAGS(dstr) |= SVf_IOK;
4214 if (sflags & SVf_IVisUV)
4216 SvIV_set(dstr, SvIVX(sstr));
4219 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4220 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4221 smg->mg_ptr, smg->mg_len);
4222 SvRMAGICAL_on(dstr);
4225 else if (sflags & SVp_IOK) {
4226 if (sflags & SVf_IOK)
4227 (void)SvIOK_only(dstr);
4229 (void)SvOK_off(dstr);
4230 (void)SvIOKp_on(dstr);
4232 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4233 if (sflags & SVf_IVisUV)
4235 SvIV_set(dstr, SvIVX(sstr));
4236 if (sflags & SVp_NOK) {
4237 if (sflags & SVf_NOK)
4238 (void)SvNOK_on(dstr);
4240 (void)SvNOKp_on(dstr);
4241 SvNV_set(dstr, SvNVX(sstr));
4244 else if (sflags & SVp_NOK) {
4245 if (sflags & SVf_NOK)
4246 (void)SvNOK_only(dstr);
4248 (void)SvOK_off(dstr);
4251 SvNV_set(dstr, SvNVX(sstr));
4254 if (dtype == SVt_PVGV) {
4255 if (ckWARN(WARN_MISC))
4256 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4259 (void)SvOK_off(dstr);
4261 if (SvTAINTED(sstr))
4266 =for apidoc sv_setsv_mg
4268 Like C<sv_setsv>, but also handles 'set' magic.
4274 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4276 sv_setsv(dstr,sstr);
4280 #ifdef PERL_OLD_COPY_ON_WRITE
4282 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4284 STRLEN cur = SvCUR(sstr);
4285 STRLEN len = SvLEN(sstr);
4286 register char *new_pv;
4289 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4297 if (SvTHINKFIRST(dstr))
4298 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4299 else if (SvPVX_const(dstr))
4300 Safefree(SvPVX_const(dstr));
4304 SvUPGRADE(dstr, SVt_PVIV);
4306 assert (SvPOK(sstr));
4307 assert (SvPOKp(sstr));
4308 assert (!SvIOK(sstr));
4309 assert (!SvIOKp(sstr));
4310 assert (!SvNOK(sstr));
4311 assert (!SvNOKp(sstr));
4313 if (SvIsCOW(sstr)) {
4315 if (SvLEN(sstr) == 0) {
4316 /* source is a COW shared hash key. */
4317 DEBUG_C(PerlIO_printf(Perl_debug_log,
4318 "Fast copy on write: Sharing hash\n"));
4319 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4322 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4324 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4325 SvUPGRADE(sstr, SVt_PVIV);
4326 SvREADONLY_on(sstr);
4328 DEBUG_C(PerlIO_printf(Perl_debug_log,
4329 "Fast copy on write: Converting sstr to COW\n"));
4330 SV_COW_NEXT_SV_SET(dstr, sstr);
4332 SV_COW_NEXT_SV_SET(sstr, dstr);
4333 new_pv = SvPVX_mutable(sstr);
4336 SvPV_set(dstr, new_pv);
4337 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4340 SvLEN_set(dstr, len);
4341 SvCUR_set(dstr, cur);
4350 =for apidoc sv_setpvn
4352 Copies a string into an SV. The C<len> parameter indicates the number of
4353 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4354 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4360 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4362 register char *dptr;
4364 SV_CHECK_THINKFIRST_COW_DROP(sv);
4370 /* len is STRLEN which is unsigned, need to copy to signed */
4373 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4375 SvUPGRADE(sv, SVt_PV);
4377 dptr = SvGROW(sv, len + 1);
4378 Move(ptr,dptr,len,char);
4381 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4386 =for apidoc sv_setpvn_mg
4388 Like C<sv_setpvn>, but also handles 'set' magic.
4394 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4396 sv_setpvn(sv,ptr,len);
4401 =for apidoc sv_setpv
4403 Copies a string into an SV. The string must be null-terminated. Does not
4404 handle 'set' magic. See C<sv_setpv_mg>.
4410 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4412 register STRLEN len;
4414 SV_CHECK_THINKFIRST_COW_DROP(sv);
4420 SvUPGRADE(sv, SVt_PV);
4422 SvGROW(sv, len + 1);
4423 Move(ptr,SvPVX(sv),len+1,char);
4425 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4430 =for apidoc sv_setpv_mg
4432 Like C<sv_setpv>, but also handles 'set' magic.
4438 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4445 =for apidoc sv_usepvn
4447 Tells an SV to use C<ptr> to find its string value. Normally the string is
4448 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4449 The C<ptr> should point to memory that was allocated by C<malloc>. The
4450 string length, C<len>, must be supplied. This function will realloc the
4451 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4452 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4453 See C<sv_usepvn_mg>.
4459 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4462 SV_CHECK_THINKFIRST_COW_DROP(sv);
4463 SvUPGRADE(sv, SVt_PV);
4468 if (SvPVX_const(sv))
4471 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4472 ptr = saferealloc (ptr, allocate);
4475 SvLEN_set(sv, allocate);
4477 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4482 =for apidoc sv_usepvn_mg
4484 Like C<sv_usepvn>, but also handles 'set' magic.
4490 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4492 sv_usepvn(sv,ptr,len);
4496 #ifdef PERL_OLD_COPY_ON_WRITE
4497 /* Need to do this *after* making the SV normal, as we need the buffer
4498 pointer to remain valid until after we've copied it. If we let go too early,
4499 another thread could invalidate it by unsharing last of the same hash key
4500 (which it can do by means other than releasing copy-on-write Svs)
4501 or by changing the other copy-on-write SVs in the loop. */
4503 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4505 if (len) { /* this SV was SvIsCOW_normal(sv) */
4506 /* we need to find the SV pointing to us. */
4507 SV *current = SV_COW_NEXT_SV(after);
4509 if (current == sv) {
4510 /* The SV we point to points back to us (there were only two of us
4512 Hence other SV is no longer copy on write either. */
4514 SvREADONLY_off(after);
4516 /* We need to follow the pointers around the loop. */
4518 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4521 /* don't loop forever if the structure is bust, and we have
4522 a pointer into a closed loop. */
4523 assert (current != after);
4524 assert (SvPVX_const(current) == pvx);
4526 /* Make the SV before us point to the SV after us. */
4527 SV_COW_NEXT_SV_SET(current, after);
4530 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4535 Perl_sv_release_IVX(pTHX_ register SV *sv)
4538 sv_force_normal_flags(sv, 0);
4544 =for apidoc sv_force_normal_flags
4546 Undo various types of fakery on an SV: if the PV is a shared string, make
4547 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4548 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4549 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4550 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4551 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4552 set to some other value.) In addition, the C<flags> parameter gets passed to
4553 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4554 with flags set to 0.
4560 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4562 #ifdef PERL_OLD_COPY_ON_WRITE
4563 if (SvREADONLY(sv)) {
4564 /* At this point I believe I should acquire a global SV mutex. */
4566 const char *pvx = SvPVX_const(sv);
4567 const STRLEN len = SvLEN(sv);
4568 const STRLEN cur = SvCUR(sv);
4569 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4571 PerlIO_printf(Perl_debug_log,
4572 "Copy on write: Force normal %ld\n",
4578 /* This SV doesn't own the buffer, so need to New() a new one: */
4579 SvPV_set(sv, (char*)0);
4581 if (flags & SV_COW_DROP_PV) {
4582 /* OK, so we don't need to copy our buffer. */
4585 SvGROW(sv, cur + 1);
4586 Move(pvx,SvPVX(sv),cur,char);
4590 sv_release_COW(sv, pvx, len, next);
4595 else if (IN_PERL_RUNTIME)
4596 Perl_croak(aTHX_ PL_no_modify);
4597 /* At this point I believe that I can drop the global SV mutex. */
4600 if (SvREADONLY(sv)) {
4602 const char *pvx = SvPVX_const(sv);
4603 const STRLEN len = SvCUR(sv);
4606 SvPV_set(sv, Nullch);
4608 SvGROW(sv, len + 1);
4609 Move(pvx,SvPVX_const(sv),len,char);
4611 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4613 else if (IN_PERL_RUNTIME)
4614 Perl_croak(aTHX_ PL_no_modify);
4618 sv_unref_flags(sv, flags);
4619 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4624 =for apidoc sv_force_normal
4626 Undo various types of fakery on an SV: if the PV is a shared string, make
4627 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4628 an xpvmg. See also C<sv_force_normal_flags>.
4634 Perl_sv_force_normal(pTHX_ register SV *sv)
4636 sv_force_normal_flags(sv, 0);
4642 Efficient removal of characters from the beginning of the string buffer.
4643 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4644 the string buffer. The C<ptr> becomes the first character of the adjusted
4645 string. Uses the "OOK hack".
4646 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4647 refer to the same chunk of data.
4653 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4655 register STRLEN delta;
4656 if (!ptr || !SvPOKp(sv))
4658 delta = ptr - SvPVX_const(sv);
4659 SV_CHECK_THINKFIRST(sv);
4660 if (SvTYPE(sv) < SVt_PVIV)
4661 sv_upgrade(sv,SVt_PVIV);
4664 if (!SvLEN(sv)) { /* make copy of shared string */
4665 const char *pvx = SvPVX_const(sv);
4666 const STRLEN len = SvCUR(sv);
4667 SvGROW(sv, len + 1);
4668 Move(pvx,SvPVX_const(sv),len,char);
4672 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4673 and we do that anyway inside the SvNIOK_off
4675 SvFLAGS(sv) |= SVf_OOK;
4678 SvLEN_set(sv, SvLEN(sv) - delta);
4679 SvCUR_set(sv, SvCUR(sv) - delta);
4680 SvPV_set(sv, SvPVX(sv) + delta);
4681 SvIV_set(sv, SvIVX(sv) + delta);
4684 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4685 * this function provided for binary compatibility only
4689 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4691 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4695 =for apidoc sv_catpvn
4697 Concatenates the string onto the end of the string which is in the SV. The
4698 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4699 status set, then the bytes appended should be valid UTF-8.
4700 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4702 =for apidoc sv_catpvn_flags
4704 Concatenates the string onto the end of the string which is in the SV. The
4705 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4706 status set, then the bytes appended should be valid UTF-8.
4707 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4708 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4709 in terms of this function.
4715 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4718 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4720 SvGROW(dsv, dlen + slen + 1);
4722 sstr = SvPVX_const(dsv);
4723 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4724 SvCUR_set(dsv, SvCUR(dsv) + slen);
4726 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4731 =for apidoc sv_catpvn_mg
4733 Like C<sv_catpvn>, but also handles 'set' magic.
4739 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4741 sv_catpvn(sv,ptr,len);
4745 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4746 * this function provided for binary compatibility only
4750 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4752 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4756 =for apidoc sv_catsv
4758 Concatenates the string from SV C<ssv> onto the end of the string in
4759 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4760 not 'set' magic. See C<sv_catsv_mg>.
4762 =for apidoc sv_catsv_flags
4764 Concatenates the string from SV C<ssv> onto the end of the string in
4765 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4766 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4767 and C<sv_catsv_nomg> are implemented in terms of this function.
4772 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4778 if ((spv = SvPV_const(ssv, slen))) {
4779 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4780 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4781 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4782 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4783 dsv->sv_flags doesn't have that bit set.
4784 Andy Dougherty 12 Oct 2001
4786 const I32 sutf8 = DO_UTF8(ssv);
4789 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4791 dutf8 = DO_UTF8(dsv);
4793 if (dutf8 != sutf8) {
4795 /* Not modifying source SV, so taking a temporary copy. */
4796 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4798 sv_utf8_upgrade(csv);
4799 spv = SvPV_const(csv, slen);
4802 sv_utf8_upgrade_nomg(dsv);
4804 sv_catpvn_nomg(dsv, spv, slen);
4809 =for apidoc sv_catsv_mg
4811 Like C<sv_catsv>, but also handles 'set' magic.
4817 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4824 =for apidoc sv_catpv
4826 Concatenates the string onto the end of the string which is in the SV.
4827 If the SV has the UTF-8 status set, then the bytes appended should be
4828 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4833 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4835 register STRLEN len;
4841 junk = SvPV_force(sv, tlen);
4843 SvGROW(sv, tlen + len + 1);
4845 ptr = SvPVX_const(sv);
4846 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4847 SvCUR_set(sv, SvCUR(sv) + len);
4848 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4853 =for apidoc sv_catpv_mg
4855 Like C<sv_catpv>, but also handles 'set' magic.
4861 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4870 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4871 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4878 Perl_newSV(pTHX_ STRLEN len)
4884 sv_upgrade(sv, SVt_PV);
4885 SvGROW(sv, len + 1);
4890 =for apidoc sv_magicext
4892 Adds magic to an SV, upgrading it if necessary. Applies the
4893 supplied vtable and returns a pointer to the magic added.
4895 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4896 In particular, you can add magic to SvREADONLY SVs, and add more than
4897 one instance of the same 'how'.
4899 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4900 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4901 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4902 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4904 (This is now used as a subroutine by C<sv_magic>.)
4909 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4910 const char* name, I32 namlen)
4914 if (SvTYPE(sv) < SVt_PVMG) {
4915 SvUPGRADE(sv, SVt_PVMG);
4917 Newz(702,mg, 1, MAGIC);
4918 mg->mg_moremagic = SvMAGIC(sv);
4919 SvMAGIC_set(sv, mg);
4921 /* Sometimes a magic contains a reference loop, where the sv and
4922 object refer to each other. To prevent a reference loop that
4923 would prevent such objects being freed, we look for such loops
4924 and if we find one we avoid incrementing the object refcount.
4926 Note we cannot do this to avoid self-tie loops as intervening RV must
4927 have its REFCNT incremented to keep it in existence.
4930 if (!obj || obj == sv ||
4931 how == PERL_MAGIC_arylen ||
4932 how == PERL_MAGIC_qr ||
4933 how == PERL_MAGIC_symtab ||
4934 (SvTYPE(obj) == SVt_PVGV &&
4935 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4936 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4937 GvFORM(obj) == (CV*)sv)))
4942 mg->mg_obj = SvREFCNT_inc(obj);
4943 mg->mg_flags |= MGf_REFCOUNTED;
4946 /* Normal self-ties simply pass a null object, and instead of
4947 using mg_obj directly, use the SvTIED_obj macro to produce a
4948 new RV as needed. For glob "self-ties", we are tieing the PVIO
4949 with an RV obj pointing to the glob containing the PVIO. In
4950 this case, to avoid a reference loop, we need to weaken the
4954 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4955 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4961 mg->mg_len = namlen;
4964 mg->mg_ptr = savepvn(name, namlen);
4965 else if (namlen == HEf_SVKEY)
4966 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4968 mg->mg_ptr = (char *) name;
4970 mg->mg_virtual = vtable;
4974 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4979 =for apidoc sv_magic
4981 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4982 then adds a new magic item of type C<how> to the head of the magic list.
4984 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4985 handling of the C<name> and C<namlen> arguments.
4987 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4988 to add more than one instance of the same 'how'.
4994 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4996 const MGVTBL *vtable = 0;
4999 #ifdef PERL_OLD_COPY_ON_WRITE
5001 sv_force_normal_flags(sv, 0);
5003 if (SvREADONLY(sv)) {
5005 && how != PERL_MAGIC_regex_global
5006 && how != PERL_MAGIC_bm
5007 && how != PERL_MAGIC_fm
5008 && how != PERL_MAGIC_sv
5009 && how != PERL_MAGIC_backref
5012 Perl_croak(aTHX_ PL_no_modify);
5015 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5016 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5017 /* sv_magic() refuses to add a magic of the same 'how' as an
5020 if (how == PERL_MAGIC_taint)
5028 vtable = &PL_vtbl_sv;
5030 case PERL_MAGIC_overload:
5031 vtable = &PL_vtbl_amagic;
5033 case PERL_MAGIC_overload_elem:
5034 vtable = &PL_vtbl_amagicelem;
5036 case PERL_MAGIC_overload_table:
5037 vtable = &PL_vtbl_ovrld;
5040 vtable = &PL_vtbl_bm;
5042 case PERL_MAGIC_regdata:
5043 vtable = &PL_vtbl_regdata;
5045 case PERL_MAGIC_regdatum:
5046 vtable = &PL_vtbl_regdatum;
5048 case PERL_MAGIC_env:
5049 vtable = &PL_vtbl_env;
5052 vtable = &PL_vtbl_fm;
5054 case PERL_MAGIC_envelem:
5055 vtable = &PL_vtbl_envelem;
5057 case PERL_MAGIC_regex_global:
5058 vtable = &PL_vtbl_mglob;
5060 case PERL_MAGIC_isa:
5061 vtable = &PL_vtbl_isa;
5063 case PERL_MAGIC_isaelem:
5064 vtable = &PL_vtbl_isaelem;
5066 case PERL_MAGIC_nkeys:
5067 vtable = &PL_vtbl_nkeys;
5069 case PERL_MAGIC_dbfile:
5072 case PERL_MAGIC_dbline:
5073 vtable = &PL_vtbl_dbline;
5075 #ifdef USE_LOCALE_COLLATE
5076 case PERL_MAGIC_collxfrm:
5077 vtable = &PL_vtbl_collxfrm;
5079 #endif /* USE_LOCALE_COLLATE */
5080 case PERL_MAGIC_tied:
5081 vtable = &PL_vtbl_pack;
5083 case PERL_MAGIC_tiedelem:
5084 case PERL_MAGIC_tiedscalar:
5085 vtable = &PL_vtbl_packelem;
5088 vtable = &PL_vtbl_regexp;
5090 case PERL_MAGIC_sig:
5091 vtable = &PL_vtbl_sig;
5093 case PERL_MAGIC_sigelem:
5094 vtable = &PL_vtbl_sigelem;
5096 case PERL_MAGIC_taint:
5097 vtable = &PL_vtbl_taint;
5099 case PERL_MAGIC_uvar:
5100 vtable = &PL_vtbl_uvar;
5102 case PERL_MAGIC_vec:
5103 vtable = &PL_vtbl_vec;
5105 case PERL_MAGIC_arylen_p:
5106 case PERL_MAGIC_rhash:
5107 case PERL_MAGIC_symtab:
5108 case PERL_MAGIC_vstring:
5111 case PERL_MAGIC_utf8:
5112 vtable = &PL_vtbl_utf8;
5114 case PERL_MAGIC_substr:
5115 vtable = &PL_vtbl_substr;
5117 case PERL_MAGIC_defelem:
5118 vtable = &PL_vtbl_defelem;
5120 case PERL_MAGIC_glob:
5121 vtable = &PL_vtbl_glob;
5123 case PERL_MAGIC_arylen:
5124 vtable = &PL_vtbl_arylen;
5126 case PERL_MAGIC_pos:
5127 vtable = &PL_vtbl_pos;
5129 case PERL_MAGIC_backref:
5130 vtable = &PL_vtbl_backref;
5132 case PERL_MAGIC_ext:
5133 /* Reserved for use by extensions not perl internals. */
5134 /* Useful for attaching extension internal data to perl vars. */
5135 /* Note that multiple extensions may clash if magical scalars */
5136 /* etc holding private data from one are passed to another. */
5139 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5142 /* Rest of work is done else where */
5143 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5146 case PERL_MAGIC_taint:
5149 case PERL_MAGIC_ext:
5150 case PERL_MAGIC_dbfile:
5157 =for apidoc sv_unmagic
5159 Removes all magic of type C<type> from an SV.
5165 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5169 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5172 for (mg = *mgp; mg; mg = *mgp) {
5173 if (mg->mg_type == type) {
5174 const MGVTBL* const vtbl = mg->mg_virtual;
5175 *mgp = mg->mg_moremagic;
5176 if (vtbl && vtbl->svt_free)
5177 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5178 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5180 Safefree(mg->mg_ptr);
5181 else if (mg->mg_len == HEf_SVKEY)
5182 SvREFCNT_dec((SV*)mg->mg_ptr);
5183 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5184 Safefree(mg->mg_ptr);
5186 if (mg->mg_flags & MGf_REFCOUNTED)
5187 SvREFCNT_dec(mg->mg_obj);
5191 mgp = &mg->mg_moremagic;
5195 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5202 =for apidoc sv_rvweaken
5204 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5205 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5206 push a back-reference to this RV onto the array of backreferences
5207 associated with that magic.
5213 Perl_sv_rvweaken(pTHX_ SV *sv)
5216 if (!SvOK(sv)) /* let undefs pass */
5219 Perl_croak(aTHX_ "Can't weaken a nonreference");
5220 else if (SvWEAKREF(sv)) {
5221 if (ckWARN(WARN_MISC))
5222 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5226 sv_add_backref(tsv, sv);
5232 /* Give tsv backref magic if it hasn't already got it, then push a
5233 * back-reference to sv onto the array associated with the backref magic.
5237 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5241 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5242 av = (AV*)mg->mg_obj;
5245 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5246 /* av now has a refcnt of 2, which avoids it getting freed
5247 * before us during global cleanup. The extra ref is removed
5248 * by magic_killbackrefs() when tsv is being freed */
5250 if (AvFILLp(av) >= AvMAX(av)) {
5252 SV **svp = AvARRAY(av);
5253 for (i = AvFILLp(av); i >= 0; i--)
5255 svp[i] = sv; /* reuse the slot */
5258 av_extend(av, AvFILLp(av)+1);
5260 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5263 /* delete a back-reference to ourselves from the backref magic associated
5264 * with the SV we point to.
5268 S_sv_del_backref(pTHX_ SV *sv)
5275 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5276 Perl_croak(aTHX_ "panic: del_backref");
5277 av = (AV *)mg->mg_obj;
5279 for (i = AvFILLp(av); i >= 0; i--)
5280 if (svp[i] == sv) svp[i] = Nullsv;
5284 =for apidoc sv_insert
5286 Inserts a string at the specified offset/length within the SV. Similar to
5287 the Perl substr() function.
5293 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5297 register char *midend;
5298 register char *bigend;
5304 Perl_croak(aTHX_ "Can't modify non-existent substring");
5305 SvPV_force(bigstr, curlen);
5306 (void)SvPOK_only_UTF8(bigstr);
5307 if (offset + len > curlen) {
5308 SvGROW(bigstr, offset+len+1);
5309 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5310 SvCUR_set(bigstr, offset+len);
5314 i = littlelen - len;
5315 if (i > 0) { /* string might grow */
5316 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5317 mid = big + offset + len;
5318 midend = bigend = big + SvCUR(bigstr);
5321 while (midend > mid) /* shove everything down */
5322 *--bigend = *--midend;
5323 Move(little,big+offset,littlelen,char);
5324 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5329 Move(little,SvPVX(bigstr)+offset,len,char);
5334 big = SvPVX(bigstr);
5337 bigend = big + SvCUR(bigstr);
5339 if (midend > bigend)
5340 Perl_croak(aTHX_ "panic: sv_insert");
5342 if (mid - big > bigend - midend) { /* faster to shorten from end */
5344 Move(little, mid, littlelen,char);
5347 i = bigend - midend;
5349 Move(midend, mid, i,char);
5353 SvCUR_set(bigstr, mid - big);
5355 else if ((i = mid - big)) { /* faster from front */
5356 midend -= littlelen;
5358 sv_chop(bigstr,midend-i);
5363 Move(little, mid, littlelen,char);
5365 else if (littlelen) {
5366 midend -= littlelen;
5367 sv_chop(bigstr,midend);
5368 Move(little,midend,littlelen,char);
5371 sv_chop(bigstr,midend);
5377 =for apidoc sv_replace
5379 Make the first argument a copy of the second, then delete the original.
5380 The target SV physically takes over ownership of the body of the source SV
5381 and inherits its flags; however, the target keeps any magic it owns,
5382 and any magic in the source is discarded.
5383 Note that this is a rather specialist SV copying operation; most of the
5384 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5390 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5392 const U32 refcnt = SvREFCNT(sv);
5393 SV_CHECK_THINKFIRST_COW_DROP(sv);
5394 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5395 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5396 if (SvMAGICAL(sv)) {
5400 sv_upgrade(nsv, SVt_PVMG);
5401 SvMAGIC_set(nsv, SvMAGIC(sv));
5402 SvFLAGS(nsv) |= SvMAGICAL(sv);
5404 SvMAGIC_set(sv, NULL);
5408 assert(!SvREFCNT(sv));
5409 #ifdef DEBUG_LEAKING_SCALARS
5410 sv->sv_flags = nsv->sv_flags;
5411 sv->sv_any = nsv->sv_any;
5412 sv->sv_refcnt = nsv->sv_refcnt;
5413 sv->sv_u = nsv->sv_u;
5415 StructCopy(nsv,sv,SV);
5417 /* Currently could join these into one piece of pointer arithmetic, but
5418 it would be unclear. */
5419 if(SvTYPE(sv) == SVt_IV)
5421 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5422 else if (SvTYPE(sv) == SVt_RV) {
5423 SvANY(sv) = &sv->sv_u.svu_rv;
5427 #ifdef PERL_OLD_COPY_ON_WRITE
5428 if (SvIsCOW_normal(nsv)) {
5429 /* We need to follow the pointers around the loop to make the
5430 previous SV point to sv, rather than nsv. */
5433 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5436 assert(SvPVX_const(current) == SvPVX_const(nsv));
5438 /* Make the SV before us point to the SV after us. */
5440 PerlIO_printf(Perl_debug_log, "previous is\n");
5442 PerlIO_printf(Perl_debug_log,
5443 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5444 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5446 SV_COW_NEXT_SV_SET(current, sv);
5449 SvREFCNT(sv) = refcnt;
5450 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5456 =for apidoc sv_clear
5458 Clear an SV: call any destructors, free up any memory used by the body,
5459 and free the body itself. The SV's head is I<not> freed, although
5460 its type is set to all 1's so that it won't inadvertently be assumed
5461 to be live during global destruction etc.
5462 This function should only be called when REFCNT is zero. Most of the time
5463 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5470 Perl_sv_clear(pTHX_ register SV *sv)
5475 assert(SvREFCNT(sv) == 0);
5478 if (PL_defstash) { /* Still have a symbol table? */
5482 stash = SvSTASH(sv);
5483 destructor = StashHANDLER(stash,DESTROY);
5485 SV* tmpref = newRV(sv);
5486 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5488 PUSHSTACKi(PERLSI_DESTROY);
5493 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5499 if(SvREFCNT(tmpref) < 2) {
5500 /* tmpref is not kept alive! */
5502 SvRV_set(tmpref, NULL);
5505 SvREFCNT_dec(tmpref);
5507 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5511 if (PL_in_clean_objs)
5512 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5514 /* DESTROY gave object new lease on life */
5520 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5521 SvOBJECT_off(sv); /* Curse the object. */
5522 if (SvTYPE(sv) != SVt_PVIO)
5523 --PL_sv_objcount; /* XXX Might want something more general */
5526 if (SvTYPE(sv) >= SVt_PVMG) {
5529 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5530 SvREFCNT_dec(SvSTASH(sv));
5533 switch (SvTYPE(sv)) {
5536 IoIFP(sv) != PerlIO_stdin() &&
5537 IoIFP(sv) != PerlIO_stdout() &&
5538 IoIFP(sv) != PerlIO_stderr())
5540 io_close((IO*)sv, FALSE);
5542 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5543 PerlDir_close(IoDIRP(sv));
5544 IoDIRP(sv) = (DIR*)NULL;
5545 Safefree(IoTOP_NAME(sv));
5546 Safefree(IoFMT_NAME(sv));
5547 Safefree(IoBOTTOM_NAME(sv));
5562 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5563 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5564 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5565 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5567 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5568 SvREFCNT_dec(LvTARG(sv));
5572 Safefree(GvNAME(sv));
5573 /* cannot decrease stash refcount yet, as we might recursively delete
5574 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5575 of stash until current sv is completely gone.
5576 -- JohnPC, 27 Mar 1998 */
5577 stash = GvSTASH(sv);
5583 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5585 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5586 /* Don't even bother with turning off the OOK flag. */
5595 SvREFCNT_dec(SvRV(sv));
5597 #ifdef PERL_OLD_COPY_ON_WRITE
5598 else if (SvPVX_const(sv)) {
5600 /* I believe I need to grab the global SV mutex here and
5601 then recheck the COW status. */
5603 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5606 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5607 SV_COW_NEXT_SV(sv));
5608 /* And drop it here. */
5610 } else if (SvLEN(sv)) {
5611 Safefree(SvPVX_const(sv));
5615 else if (SvPVX_const(sv) && SvLEN(sv))
5616 Safefree(SvPVX_const(sv));
5617 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5618 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5631 switch (SvTYPE(sv)) {
5645 del_XPVIV(SvANY(sv));
5648 del_XPVNV(SvANY(sv));
5651 del_XPVMG(SvANY(sv));
5654 del_XPVLV(SvANY(sv));
5657 del_XPVAV(SvANY(sv));
5660 del_XPVHV(SvANY(sv));
5663 del_XPVCV(SvANY(sv));
5666 del_XPVGV(SvANY(sv));
5667 /* code duplication for increased performance. */
5668 SvFLAGS(sv) &= SVf_BREAK;
5669 SvFLAGS(sv) |= SVTYPEMASK;
5670 /* decrease refcount of the stash that owns this GV, if any */
5672 SvREFCNT_dec(stash);
5673 return; /* not break, SvFLAGS reset already happened */
5675 del_XPVBM(SvANY(sv));
5678 del_XPVFM(SvANY(sv));
5681 del_XPVIO(SvANY(sv));
5684 SvFLAGS(sv) &= SVf_BREAK;
5685 SvFLAGS(sv) |= SVTYPEMASK;
5689 =for apidoc sv_newref
5691 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5698 Perl_sv_newref(pTHX_ SV *sv)
5708 Decrement an SV's reference count, and if it drops to zero, call
5709 C<sv_clear> to invoke destructors and free up any memory used by
5710 the body; finally, deallocate the SV's head itself.
5711 Normally called via a wrapper macro C<SvREFCNT_dec>.
5717 Perl_sv_free(pTHX_ SV *sv)
5722 if (SvREFCNT(sv) == 0) {
5723 if (SvFLAGS(sv) & SVf_BREAK)
5724 /* this SV's refcnt has been artificially decremented to
5725 * trigger cleanup */
5727 if (PL_in_clean_all) /* All is fair */
5729 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5730 /* make sure SvREFCNT(sv)==0 happens very seldom */
5731 SvREFCNT(sv) = (~(U32)0)/2;
5734 if (ckWARN_d(WARN_INTERNAL))
5735 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5736 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5737 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5740 if (--(SvREFCNT(sv)) > 0)
5742 Perl_sv_free2(aTHX_ sv);
5746 Perl_sv_free2(pTHX_ SV *sv)
5751 if (ckWARN_d(WARN_DEBUGGING))
5752 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5753 "Attempt to free temp prematurely: SV 0x%"UVxf
5754 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5758 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5759 /* make sure SvREFCNT(sv)==0 happens very seldom */
5760 SvREFCNT(sv) = (~(U32)0)/2;
5771 Returns the length of the string in the SV. Handles magic and type
5772 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5778 Perl_sv_len(pTHX_ register SV *sv)
5786 len = mg_length(sv);
5788 (void)SvPV_const(sv, len);
5793 =for apidoc sv_len_utf8
5795 Returns the number of characters in the string in an SV, counting wide
5796 UTF-8 bytes as a single character. Handles magic and type coercion.
5802 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5803 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5804 * (Note that the mg_len is not the length of the mg_ptr field.)
5809 Perl_sv_len_utf8(pTHX_ register SV *sv)
5815 return mg_length(sv);
5819 const U8 *s = (U8*)SvPV_const(sv, len);
5820 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5822 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5824 #ifdef PERL_UTF8_CACHE_ASSERT
5825 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5829 ulen = Perl_utf8_length(aTHX_ s, s + len);
5830 if (!mg && !SvREADONLY(sv)) {
5831 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5832 mg = mg_find(sv, PERL_MAGIC_utf8);
5842 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5843 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5844 * between UTF-8 and byte offsets. There are two (substr offset and substr
5845 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5846 * and byte offset) cache positions.
5848 * The mg_len field is used by sv_len_utf8(), see its comments.
5849 * Note that the mg_len is not the length of the mg_ptr field.
5853 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5854 I32 offsetp, const U8 *s, const U8 *start)
5858 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5860 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5864 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5866 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5867 (*mgp)->mg_ptr = (char *) *cachep;
5871 (*cachep)[i] = offsetp;
5872 (*cachep)[i+1] = s - start;
5880 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5881 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5882 * between UTF-8 and byte offsets. See also the comments of
5883 * S_utf8_mg_pos_init().
5887 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5891 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5893 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5894 if (*mgp && (*mgp)->mg_ptr) {
5895 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5896 ASSERT_UTF8_CACHE(*cachep);
5897 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5899 else { /* We will skip to the right spot. */
5904 /* The assumption is that going backward is half
5905 * the speed of going forward (that's where the
5906 * 2 * backw in the below comes from). (The real
5907 * figure of course depends on the UTF-8 data.) */
5909 if ((*cachep)[i] > (STRLEN)uoff) {
5911 backw = (*cachep)[i] - (STRLEN)uoff;
5913 if (forw < 2 * backw)
5916 p = start + (*cachep)[i+1];
5918 /* Try this only for the substr offset (i == 0),
5919 * not for the substr length (i == 2). */
5920 else if (i == 0) { /* (*cachep)[i] < uoff */
5921 const STRLEN ulen = sv_len_utf8(sv);
5923 if ((STRLEN)uoff < ulen) {
5924 forw = (STRLEN)uoff - (*cachep)[i];
5925 backw = ulen - (STRLEN)uoff;
5927 if (forw < 2 * backw)
5928 p = start + (*cachep)[i+1];
5933 /* If the string is not long enough for uoff,
5934 * we could extend it, but not at this low a level. */
5938 if (forw < 2 * backw) {
5945 while (UTF8_IS_CONTINUATION(*p))
5950 /* Update the cache. */
5951 (*cachep)[i] = (STRLEN)uoff;
5952 (*cachep)[i+1] = p - start;
5954 /* Drop the stale "length" cache */
5963 if (found) { /* Setup the return values. */
5964 *offsetp = (*cachep)[i+1];
5965 *sp = start + *offsetp;
5968 *offsetp = send - start;
5970 else if (*sp < start) {
5976 #ifdef PERL_UTF8_CACHE_ASSERT
5981 while (n-- && s < send)
5985 assert(*offsetp == s - start);
5986 assert((*cachep)[0] == (STRLEN)uoff);
5987 assert((*cachep)[1] == *offsetp);
5989 ASSERT_UTF8_CACHE(*cachep);
5998 =for apidoc sv_pos_u2b
6000 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6001 the start of the string, to a count of the equivalent number of bytes; if
6002 lenp is non-zero, it does the same to lenp, but this time starting from
6003 the offset, rather than from the start of the string. Handles magic and
6010 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6011 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6012 * byte offsets. See also the comments of S_utf8_mg_pos().
6017 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6025 start = (U8*)SvPV_const(sv, len);
6029 const U8 *s = start;
6030 I32 uoffset = *offsetp;
6031 const U8 *send = s + len;
6035 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6037 if (!found && uoffset > 0) {
6038 while (s < send && uoffset--)
6042 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6044 *offsetp = s - start;
6049 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6053 if (!found && *lenp > 0) {
6056 while (s < send && ulen--)
6060 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6064 ASSERT_UTF8_CACHE(cache);
6076 =for apidoc sv_pos_b2u
6078 Converts the value pointed to by offsetp from a count of bytes from the
6079 start of the string, to a count of the equivalent number of UTF-8 chars.
6080 Handles magic and type coercion.
6086 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6087 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6088 * byte offsets. See also the comments of S_utf8_mg_pos().
6093 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6101 s = (const U8*)SvPV_const(sv, len);
6102 if ((I32)len < *offsetp)
6103 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6105 const U8* send = s + *offsetp;
6107 STRLEN *cache = NULL;
6111 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6112 mg = mg_find(sv, PERL_MAGIC_utf8);
6113 if (mg && mg->mg_ptr) {
6114 cache = (STRLEN *) mg->mg_ptr;
6115 if (cache[1] == (STRLEN)*offsetp) {
6116 /* An exact match. */
6117 *offsetp = cache[0];
6121 else if (cache[1] < (STRLEN)*offsetp) {
6122 /* We already know part of the way. */
6125 /* Let the below loop do the rest. */
6127 else { /* cache[1] > *offsetp */
6128 /* We already know all of the way, now we may
6129 * be able to walk back. The same assumption
6130 * is made as in S_utf8_mg_pos(), namely that
6131 * walking backward is twice slower than
6132 * walking forward. */
6133 STRLEN forw = *offsetp;
6134 STRLEN backw = cache[1] - *offsetp;
6136 if (!(forw < 2 * backw)) {
6137 const U8 *p = s + cache[1];
6144 while (UTF8_IS_CONTINUATION(*p)) {
6152 *offsetp = cache[0];
6154 /* Drop the stale "length" cache */
6162 ASSERT_UTF8_CACHE(cache);
6168 /* Call utf8n_to_uvchr() to validate the sequence
6169 * (unless a simple non-UTF character) */
6170 if (!UTF8_IS_INVARIANT(*s))
6171 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6180 if (!SvREADONLY(sv)) {
6182 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6183 mg = mg_find(sv, PERL_MAGIC_utf8);
6188 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6189 mg->mg_ptr = (char *) cache;
6194 cache[1] = *offsetp;
6195 /* Drop the stale "length" cache */
6208 Returns a boolean indicating whether the strings in the two SVs are
6209 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6210 coerce its args to strings if necessary.
6216 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6224 SV* svrecode = Nullsv;
6231 pv1 = SvPV_const(sv1, cur1);
6238 pv2 = SvPV_const(sv2, cur2);
6240 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6241 /* Differing utf8ness.
6242 * Do not UTF8size the comparands as a side-effect. */
6245 svrecode = newSVpvn(pv2, cur2);
6246 sv_recode_to_utf8(svrecode, PL_encoding);
6247 pv2 = SvPV_const(svrecode, cur2);
6250 svrecode = newSVpvn(pv1, cur1);
6251 sv_recode_to_utf8(svrecode, PL_encoding);
6252 pv1 = SvPV_const(svrecode, cur1);
6254 /* Now both are in UTF-8. */
6256 SvREFCNT_dec(svrecode);
6261 bool is_utf8 = TRUE;
6264 /* sv1 is the UTF-8 one,
6265 * if is equal it must be downgrade-able */
6266 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6272 /* sv2 is the UTF-8 one,
6273 * if is equal it must be downgrade-able */
6274 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6280 /* Downgrade not possible - cannot be eq */
6288 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6291 SvREFCNT_dec(svrecode);
6302 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6303 string in C<sv1> is less than, equal to, or greater than the string in
6304 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6305 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6311 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6314 const char *pv1, *pv2;
6317 SV *svrecode = Nullsv;
6324 pv1 = SvPV_const(sv1, cur1);
6331 pv2 = SvPV_const(sv2, cur2);
6333 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6334 /* Differing utf8ness.
6335 * Do not UTF8size the comparands as a side-effect. */
6338 svrecode = newSVpvn(pv2, cur2);
6339 sv_recode_to_utf8(svrecode, PL_encoding);
6340 pv2 = SvPV_const(svrecode, cur2);
6343 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6348 svrecode = newSVpvn(pv1, cur1);
6349 sv_recode_to_utf8(svrecode, PL_encoding);
6350 pv1 = SvPV_const(svrecode, cur1);
6353 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6359 cmp = cur2 ? -1 : 0;
6363 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6366 cmp = retval < 0 ? -1 : 1;
6367 } else if (cur1 == cur2) {
6370 cmp = cur1 < cur2 ? -1 : 1;
6375 SvREFCNT_dec(svrecode);
6384 =for apidoc sv_cmp_locale
6386 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6387 'use bytes' aware, handles get magic, and will coerce its args to strings
6388 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6394 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6396 #ifdef USE_LOCALE_COLLATE
6402 if (PL_collation_standard)
6406 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6408 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6410 if (!pv1 || !len1) {
6421 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6424 return retval < 0 ? -1 : 1;
6427 * When the result of collation is equality, that doesn't mean
6428 * that there are no differences -- some locales exclude some
6429 * characters from consideration. So to avoid false equalities,
6430 * we use the raw string as a tiebreaker.
6436 #endif /* USE_LOCALE_COLLATE */
6438 return sv_cmp(sv1, sv2);
6442 #ifdef USE_LOCALE_COLLATE
6445 =for apidoc sv_collxfrm
6447 Add Collate Transform magic to an SV if it doesn't already have it.
6449 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6450 scalar data of the variable, but transformed to such a format that a normal
6451 memory comparison can be used to compare the data according to the locale
6458 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6462 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6463 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6469 Safefree(mg->mg_ptr);
6470 s = SvPV_const(sv, len);
6471 if ((xf = mem_collxfrm(s, len, &xlen))) {
6472 if (SvREADONLY(sv)) {
6475 return xf + sizeof(PL_collation_ix);
6478 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6479 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6492 if (mg && mg->mg_ptr) {
6494 return mg->mg_ptr + sizeof(PL_collation_ix);
6502 #endif /* USE_LOCALE_COLLATE */
6507 Get a line from the filehandle and store it into the SV, optionally
6508 appending to the currently-stored string.
6514 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6518 register STDCHAR rslast;
6519 register STDCHAR *bp;
6525 if (SvTHINKFIRST(sv))
6526 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6527 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6529 However, perlbench says it's slower, because the existing swipe code
6530 is faster than copy on write.
6531 Swings and roundabouts. */
6532 SvUPGRADE(sv, SVt_PV);
6537 if (PerlIO_isutf8(fp)) {
6539 sv_utf8_upgrade_nomg(sv);
6540 sv_pos_u2b(sv,&append,0);
6542 } else if (SvUTF8(sv)) {
6543 SV *tsv = NEWSV(0,0);
6544 sv_gets(tsv, fp, 0);
6545 sv_utf8_upgrade_nomg(tsv);
6546 SvCUR_set(sv,append);
6549 goto return_string_or_null;
6554 if (PerlIO_isutf8(fp))
6557 if (IN_PERL_COMPILETIME) {
6558 /* we always read code in line mode */
6562 else if (RsSNARF(PL_rs)) {
6563 /* If it is a regular disk file use size from stat() as estimate
6564 of amount we are going to read - may result in malloc-ing
6565 more memory than we realy need if layers bellow reduce
6566 size we read (e.g. CRLF or a gzip layer)
6569 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6570 const Off_t offset = PerlIO_tell(fp);
6571 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6572 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6578 else if (RsRECORD(PL_rs)) {
6582 /* Grab the size of the record we're getting */
6583 recsize = SvIV(SvRV(PL_rs));
6584 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6587 /* VMS wants read instead of fread, because fread doesn't respect */
6588 /* RMS record boundaries. This is not necessarily a good thing to be */
6589 /* doing, but we've got no other real choice - except avoid stdio
6590 as implementation - perhaps write a :vms layer ?
6592 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6594 bytesread = PerlIO_read(fp, buffer, recsize);
6598 SvCUR_set(sv, bytesread += append);
6599 buffer[bytesread] = '\0';
6600 goto return_string_or_null;
6602 else if (RsPARA(PL_rs)) {
6608 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6609 if (PerlIO_isutf8(fp)) {
6610 rsptr = SvPVutf8(PL_rs, rslen);
6613 if (SvUTF8(PL_rs)) {
6614 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6615 Perl_croak(aTHX_ "Wide character in $/");
6618 rsptr = SvPV_const(PL_rs, rslen);
6622 rslast = rslen ? rsptr[rslen - 1] : '\0';
6624 if (rspara) { /* have to do this both before and after */
6625 do { /* to make sure file boundaries work right */
6628 i = PerlIO_getc(fp);
6632 PerlIO_ungetc(fp,i);
6638 /* See if we know enough about I/O mechanism to cheat it ! */
6640 /* This used to be #ifdef test - it is made run-time test for ease
6641 of abstracting out stdio interface. One call should be cheap
6642 enough here - and may even be a macro allowing compile
6646 if (PerlIO_fast_gets(fp)) {
6649 * We're going to steal some values from the stdio struct
6650 * and put EVERYTHING in the innermost loop into registers.
6652 register STDCHAR *ptr;
6656 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6657 /* An ungetc()d char is handled separately from the regular
6658 * buffer, so we getc() it back out and stuff it in the buffer.
6660 i = PerlIO_getc(fp);
6661 if (i == EOF) return 0;
6662 *(--((*fp)->_ptr)) = (unsigned char) i;
6666 /* Here is some breathtakingly efficient cheating */
6668 cnt = PerlIO_get_cnt(fp); /* get count into register */
6669 /* make sure we have the room */
6670 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6671 /* Not room for all of it
6672 if we are looking for a separator and room for some
6674 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6675 /* just process what we have room for */
6676 shortbuffered = cnt - SvLEN(sv) + append + 1;
6677 cnt -= shortbuffered;
6681 /* remember that cnt can be negative */
6682 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6687 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6688 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6689 DEBUG_P(PerlIO_printf(Perl_debug_log,
6690 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6691 DEBUG_P(PerlIO_printf(Perl_debug_log,
6692 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6693 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6694 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6699 while (cnt > 0) { /* this | eat */
6701 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6702 goto thats_all_folks; /* screams | sed :-) */
6706 Copy(ptr, bp, cnt, char); /* this | eat */
6707 bp += cnt; /* screams | dust */
6708 ptr += cnt; /* louder | sed :-) */
6713 if (shortbuffered) { /* oh well, must extend */
6714 cnt = shortbuffered;
6716 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6718 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6719 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6723 DEBUG_P(PerlIO_printf(Perl_debug_log,
6724 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6725 PTR2UV(ptr),(long)cnt));
6726 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6728 DEBUG_P(PerlIO_printf(Perl_debug_log,
6729 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6730 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6731 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6733 /* This used to call 'filbuf' in stdio form, but as that behaves like
6734 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6735 another abstraction. */
6736 i = PerlIO_getc(fp); /* get more characters */
6738 DEBUG_P(PerlIO_printf(Perl_debug_log,
6739 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6740 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6741 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6743 cnt = PerlIO_get_cnt(fp);
6744 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6745 DEBUG_P(PerlIO_printf(Perl_debug_log,
6746 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6748 if (i == EOF) /* all done for ever? */
6749 goto thats_really_all_folks;
6751 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6753 SvGROW(sv, bpx + cnt + 2);
6754 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6756 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6758 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6759 goto thats_all_folks;
6763 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6764 memNE((char*)bp - rslen, rsptr, rslen))
6765 goto screamer; /* go back to the fray */
6766 thats_really_all_folks:
6768 cnt += shortbuffered;
6769 DEBUG_P(PerlIO_printf(Perl_debug_log,
6770 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6771 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6772 DEBUG_P(PerlIO_printf(Perl_debug_log,
6773 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6774 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6775 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6777 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6778 DEBUG_P(PerlIO_printf(Perl_debug_log,
6779 "Screamer: done, len=%ld, string=|%.*s|\n",
6780 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6784 /*The big, slow, and stupid way. */
6785 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6787 New(0, buf, 8192, STDCHAR);
6795 const register STDCHAR *bpe = buf + sizeof(buf);
6797 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6798 ; /* keep reading */
6802 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6803 /* Accomodate broken VAXC compiler, which applies U8 cast to
6804 * both args of ?: operator, causing EOF to change into 255
6807 i = (U8)buf[cnt - 1];
6813 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6815 sv_catpvn(sv, (char *) buf, cnt);
6817 sv_setpvn(sv, (char *) buf, cnt);
6819 if (i != EOF && /* joy */
6821 SvCUR(sv) < rslen ||
6822 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6826 * If we're reading from a TTY and we get a short read,
6827 * indicating that the user hit his EOF character, we need
6828 * to notice it now, because if we try to read from the TTY
6829 * again, the EOF condition will disappear.
6831 * The comparison of cnt to sizeof(buf) is an optimization
6832 * that prevents unnecessary calls to feof().
6836 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6840 #ifdef USE_HEAP_INSTEAD_OF_STACK
6845 if (rspara) { /* have to do this both before and after */
6846 while (i != EOF) { /* to make sure file boundaries work right */
6847 i = PerlIO_getc(fp);
6849 PerlIO_ungetc(fp,i);
6855 return_string_or_null:
6856 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6862 Auto-increment of the value in the SV, doing string to numeric conversion
6863 if necessary. Handles 'get' magic.
6869 Perl_sv_inc(pTHX_ register SV *sv)
6878 if (SvTHINKFIRST(sv)) {
6880 sv_force_normal_flags(sv, 0);
6881 if (SvREADONLY(sv)) {
6882 if (IN_PERL_RUNTIME)
6883 Perl_croak(aTHX_ PL_no_modify);
6887 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6889 i = PTR2IV(SvRV(sv));
6894 flags = SvFLAGS(sv);
6895 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6896 /* It's (privately or publicly) a float, but not tested as an
6897 integer, so test it to see. */
6899 flags = SvFLAGS(sv);
6901 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6902 /* It's publicly an integer, or privately an integer-not-float */
6903 #ifdef PERL_PRESERVE_IVUV
6907 if (SvUVX(sv) == UV_MAX)
6908 sv_setnv(sv, UV_MAX_P1);
6910 (void)SvIOK_only_UV(sv);
6911 SvUV_set(sv, SvUVX(sv) + 1);
6913 if (SvIVX(sv) == IV_MAX)
6914 sv_setuv(sv, (UV)IV_MAX + 1);
6916 (void)SvIOK_only(sv);
6917 SvIV_set(sv, SvIVX(sv) + 1);
6922 if (flags & SVp_NOK) {
6923 (void)SvNOK_only(sv);
6924 SvNV_set(sv, SvNVX(sv) + 1.0);
6928 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6929 if ((flags & SVTYPEMASK) < SVt_PVIV)
6930 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6931 (void)SvIOK_only(sv);
6936 while (isALPHA(*d)) d++;
6937 while (isDIGIT(*d)) d++;
6939 #ifdef PERL_PRESERVE_IVUV
6940 /* Got to punt this as an integer if needs be, but we don't issue
6941 warnings. Probably ought to make the sv_iv_please() that does
6942 the conversion if possible, and silently. */
6943 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6944 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6945 /* Need to try really hard to see if it's an integer.
6946 9.22337203685478e+18 is an integer.
6947 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6948 so $a="9.22337203685478e+18"; $a+0; $a++
6949 needs to be the same as $a="9.22337203685478e+18"; $a++
6956 /* sv_2iv *should* have made this an NV */
6957 if (flags & SVp_NOK) {
6958 (void)SvNOK_only(sv);
6959 SvNV_set(sv, SvNVX(sv) + 1.0);
6962 /* I don't think we can get here. Maybe I should assert this
6963 And if we do get here I suspect that sv_setnv will croak. NWC
6965 #if defined(USE_LONG_DOUBLE)
6966 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",
6967 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6969 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6970 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6973 #endif /* PERL_PRESERVE_IVUV */
6974 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6978 while (d >= SvPVX_const(sv)) {
6986 /* MKS: The original code here died if letters weren't consecutive.
6987 * at least it didn't have to worry about non-C locales. The
6988 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6989 * arranged in order (although not consecutively) and that only
6990 * [A-Za-z] are accepted by isALPHA in the C locale.
6992 if (*d != 'z' && *d != 'Z') {
6993 do { ++*d; } while (!isALPHA(*d));
6996 *(d--) -= 'z' - 'a';
7001 *(d--) -= 'z' - 'a' + 1;
7005 /* oh,oh, the number grew */
7006 SvGROW(sv, SvCUR(sv) + 2);
7007 SvCUR_set(sv, SvCUR(sv) + 1);
7008 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7019 Auto-decrement of the value in the SV, doing string to numeric conversion
7020 if necessary. Handles 'get' magic.
7026 Perl_sv_dec(pTHX_ register SV *sv)
7034 if (SvTHINKFIRST(sv)) {
7036 sv_force_normal_flags(sv, 0);
7037 if (SvREADONLY(sv)) {
7038 if (IN_PERL_RUNTIME)
7039 Perl_croak(aTHX_ PL_no_modify);
7043 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7045 i = PTR2IV(SvRV(sv));
7050 /* Unlike sv_inc we don't have to worry about string-never-numbers
7051 and keeping them magic. But we mustn't warn on punting */
7052 flags = SvFLAGS(sv);
7053 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7054 /* It's publicly an integer, or privately an integer-not-float */
7055 #ifdef PERL_PRESERVE_IVUV
7059 if (SvUVX(sv) == 0) {
7060 (void)SvIOK_only(sv);
7064 (void)SvIOK_only_UV(sv);
7065 SvUV_set(sv, SvUVX(sv) + 1);
7068 if (SvIVX(sv) == IV_MIN)
7069 sv_setnv(sv, (NV)IV_MIN - 1.0);
7071 (void)SvIOK_only(sv);
7072 SvIV_set(sv, SvIVX(sv) - 1);
7077 if (flags & SVp_NOK) {
7078 SvNV_set(sv, SvNVX(sv) - 1.0);
7079 (void)SvNOK_only(sv);
7082 if (!(flags & SVp_POK)) {
7083 if ((flags & SVTYPEMASK) < SVt_PVNV)
7084 sv_upgrade(sv, SVt_NV);
7086 (void)SvNOK_only(sv);
7089 #ifdef PERL_PRESERVE_IVUV
7091 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7092 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7093 /* Need to try really hard to see if it's an integer.
7094 9.22337203685478e+18 is an integer.
7095 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7096 so $a="9.22337203685478e+18"; $a+0; $a--
7097 needs to be the same as $a="9.22337203685478e+18"; $a--
7104 /* sv_2iv *should* have made this an NV */
7105 if (flags & SVp_NOK) {
7106 (void)SvNOK_only(sv);
7107 SvNV_set(sv, SvNVX(sv) - 1.0);
7110 /* I don't think we can get here. Maybe I should assert this
7111 And if we do get here I suspect that sv_setnv will croak. NWC
7113 #if defined(USE_LONG_DOUBLE)
7114 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",
7115 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7117 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7118 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7122 #endif /* PERL_PRESERVE_IVUV */
7123 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7127 =for apidoc sv_mortalcopy
7129 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7130 The new SV is marked as mortal. It will be destroyed "soon", either by an
7131 explicit call to FREETMPS, or by an implicit call at places such as
7132 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7137 /* Make a string that will exist for the duration of the expression
7138 * evaluation. Actually, it may have to last longer than that, but
7139 * hopefully we won't free it until it has been assigned to a
7140 * permanent location. */
7143 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7148 sv_setsv(sv,oldstr);
7150 PL_tmps_stack[++PL_tmps_ix] = sv;
7156 =for apidoc sv_newmortal
7158 Creates a new null SV which is mortal. The reference count of the SV is
7159 set to 1. It will be destroyed "soon", either by an explicit call to
7160 FREETMPS, or by an implicit call at places such as statement boundaries.
7161 See also C<sv_mortalcopy> and C<sv_2mortal>.
7167 Perl_sv_newmortal(pTHX)
7172 SvFLAGS(sv) = SVs_TEMP;
7174 PL_tmps_stack[++PL_tmps_ix] = sv;
7179 =for apidoc sv_2mortal
7181 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7182 by an explicit call to FREETMPS, or by an implicit call at places such as
7183 statement boundaries. SvTEMP() is turned on which means that the SV's
7184 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7185 and C<sv_mortalcopy>.
7191 Perl_sv_2mortal(pTHX_ register SV *sv)
7196 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7199 PL_tmps_stack[++PL_tmps_ix] = sv;
7207 Creates a new SV and copies a string into it. The reference count for the
7208 SV is set to 1. If C<len> is zero, Perl will compute the length using
7209 strlen(). For efficiency, consider using C<newSVpvn> instead.
7215 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7220 sv_setpvn(sv,s,len ? len : strlen(s));
7225 =for apidoc newSVpvn
7227 Creates a new SV and copies a string into it. The reference count for the
7228 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7229 string. You are responsible for ensuring that the source string is at least
7230 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7236 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7241 sv_setpvn(sv,s,len);
7247 =for apidoc newSVhek
7249 Creates a new SV from the hash key structure. It will generate scalars that
7250 point to the shared string table where possible. Returns a new (undefined)
7251 SV if the hek is NULL.
7257 Perl_newSVhek(pTHX_ const HEK *hek)
7266 if (HEK_LEN(hek) == HEf_SVKEY) {
7267 return newSVsv(*(SV**)HEK_KEY(hek));
7269 const int flags = HEK_FLAGS(hek);
7270 if (flags & HVhek_WASUTF8) {
7272 Andreas would like keys he put in as utf8 to come back as utf8
7274 STRLEN utf8_len = HEK_LEN(hek);
7275 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7276 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7279 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7281 } else if (flags & HVhek_REHASH) {
7282 /* We don't have a pointer to the hv, so we have to replicate the
7283 flag into every HEK. This hv is using custom a hasing
7284 algorithm. Hence we can't return a shared string scalar, as
7285 that would contain the (wrong) hash value, and might get passed
7286 into an hv routine with a regular hash */
7288 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7293 /* This will be overwhelminly the most common case. */
7294 return newSVpvn_share(HEK_KEY(hek),
7295 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7301 =for apidoc newSVpvn_share
7303 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7304 table. If the string does not already exist in the table, it is created
7305 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7306 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7307 otherwise the hash is computed. The idea here is that as the string table
7308 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7309 hash lookup will avoid string compare.
7315 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7318 bool is_utf8 = FALSE;
7320 STRLEN tmplen = -len;
7322 /* See the note in hv.c:hv_fetch() --jhi */
7323 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7327 PERL_HASH(hash, src, len);
7329 sv_upgrade(sv, SVt_PV);
7330 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7342 #if defined(PERL_IMPLICIT_CONTEXT)
7344 /* pTHX_ magic can't cope with varargs, so this is a no-context
7345 * version of the main function, (which may itself be aliased to us).
7346 * Don't access this version directly.
7350 Perl_newSVpvf_nocontext(const char* pat, ...)
7355 va_start(args, pat);
7356 sv = vnewSVpvf(pat, &args);
7363 =for apidoc newSVpvf
7365 Creates a new SV and initializes it with the string formatted like
7372 Perl_newSVpvf(pTHX_ const char* pat, ...)
7376 va_start(args, pat);
7377 sv = vnewSVpvf(pat, &args);
7382 /* backend for newSVpvf() and newSVpvf_nocontext() */
7385 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7389 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7396 Creates a new SV and copies a floating point value into it.
7397 The reference count for the SV is set to 1.
7403 Perl_newSVnv(pTHX_ NV n)
7415 Creates a new SV and copies an integer into it. The reference count for the
7422 Perl_newSViv(pTHX_ IV i)
7434 Creates a new SV and copies an unsigned integer into it.
7435 The reference count for the SV is set to 1.
7441 Perl_newSVuv(pTHX_ UV u)
7451 =for apidoc newRV_noinc
7453 Creates an RV wrapper for an SV. The reference count for the original
7454 SV is B<not> incremented.
7460 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7465 sv_upgrade(sv, SVt_RV);
7467 SvRV_set(sv, tmpRef);
7472 /* newRV_inc is the official function name to use now.
7473 * newRV_inc is in fact #defined to newRV in sv.h
7477 Perl_newRV(pTHX_ SV *tmpRef)
7479 return newRV_noinc(SvREFCNT_inc(tmpRef));
7485 Creates a new SV which is an exact duplicate of the original SV.
7492 Perl_newSVsv(pTHX_ register SV *old)
7498 if (SvTYPE(old) == SVTYPEMASK) {
7499 if (ckWARN_d(WARN_INTERNAL))
7500 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7504 /* SV_GMAGIC is the default for sv_setv()
7505 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7506 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7507 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7512 =for apidoc sv_reset
7514 Underlying implementation for the C<reset> Perl function.
7515 Note that the perl-level function is vaguely deprecated.
7521 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7524 char todo[PERL_UCHAR_MAX+1];
7529 if (!*s) { /* reset ?? searches */
7530 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7532 PMOP *pm = (PMOP *) mg->mg_obj;
7534 pm->op_pmdynflags &= ~PMdf_USED;
7541 /* reset variables */
7543 if (!HvARRAY(stash))
7546 Zero(todo, 256, char);
7549 I32 i = (unsigned char)*s;
7553 max = (unsigned char)*s++;
7554 for ( ; i <= max; i++) {
7557 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7559 for (entry = HvARRAY(stash)[i];
7561 entry = HeNEXT(entry))
7566 if (!todo[(U8)*HeKEY(entry)])
7568 gv = (GV*)HeVAL(entry);
7570 if (SvTHINKFIRST(sv)) {
7571 if (!SvREADONLY(sv) && SvROK(sv))
7576 if (SvTYPE(sv) >= SVt_PV) {
7578 if (SvPVX_const(sv) != Nullch)
7585 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7588 #ifdef USE_ENVIRON_ARRAY
7590 # ifdef USE_ITHREADS
7591 && PL_curinterp == aTHX
7595 environ[0] = Nullch;
7598 #endif /* !PERL_MICRO */
7608 Using various gambits, try to get an IO from an SV: the IO slot if its a
7609 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7610 named after the PV if we're a string.
7616 Perl_sv_2io(pTHX_ SV *sv)
7621 switch (SvTYPE(sv)) {
7629 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7633 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7635 return sv_2io(SvRV(sv));
7636 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7642 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7651 Using various gambits, try to get a CV from an SV; in addition, try if
7652 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7658 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7665 return *gvp = Nullgv, Nullcv;
7666 switch (SvTYPE(sv)) {
7685 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7686 tryAMAGICunDEREF(to_cv);
7689 if (SvTYPE(sv) == SVt_PVCV) {
7698 Perl_croak(aTHX_ "Not a subroutine reference");
7703 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7709 if (lref && !GvCVu(gv)) {
7712 tmpsv = NEWSV(704,0);
7713 gv_efullname3(tmpsv, gv, Nullch);
7714 /* XXX this is probably not what they think they're getting.
7715 * It has the same effect as "sub name;", i.e. just a forward
7717 newSUB(start_subparse(FALSE, 0),
7718 newSVOP(OP_CONST, 0, tmpsv),
7723 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7733 Returns true if the SV has a true value by Perl's rules.
7734 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7735 instead use an in-line version.
7741 Perl_sv_true(pTHX_ register SV *sv)
7746 const register XPV* tXpv;
7747 if ((tXpv = (XPV*)SvANY(sv)) &&
7748 (tXpv->xpv_cur > 1 ||
7749 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7756 return SvIVX(sv) != 0;
7759 return SvNVX(sv) != 0.0;
7761 return sv_2bool(sv);
7769 A private implementation of the C<SvIVx> macro for compilers which can't
7770 cope with complex macro expressions. Always use the macro instead.
7776 Perl_sv_iv(pTHX_ register SV *sv)
7780 return (IV)SvUVX(sv);
7789 A private implementation of the C<SvUVx> macro for compilers which can't
7790 cope with complex macro expressions. Always use the macro instead.
7796 Perl_sv_uv(pTHX_ register SV *sv)
7801 return (UV)SvIVX(sv);
7809 A private implementation of the C<SvNVx> macro for compilers which can't
7810 cope with complex macro expressions. Always use the macro instead.
7816 Perl_sv_nv(pTHX_ register SV *sv)
7823 /* sv_pv() is now a macro using SvPV_nolen();
7824 * this function provided for binary compatibility only
7828 Perl_sv_pv(pTHX_ SV *sv)
7833 return sv_2pv(sv, 0);
7839 Use the C<SvPV_nolen> macro instead
7843 A private implementation of the C<SvPV> macro for compilers which can't
7844 cope with complex macro expressions. Always use the macro instead.
7850 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7856 return sv_2pv(sv, lp);
7861 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7867 return sv_2pv_flags(sv, lp, 0);
7870 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7871 * this function provided for binary compatibility only
7875 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7877 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7881 =for apidoc sv_pvn_force
7883 Get a sensible string out of the SV somehow.
7884 A private implementation of the C<SvPV_force> macro for compilers which
7885 can't cope with complex macro expressions. Always use the macro instead.
7887 =for apidoc sv_pvn_force_flags
7889 Get a sensible string out of the SV somehow.
7890 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7891 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7892 implemented in terms of this function.
7893 You normally want to use the various wrapper macros instead: see
7894 C<SvPV_force> and C<SvPV_force_nomg>
7900 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7903 if (SvTHINKFIRST(sv) && !SvROK(sv))
7904 sv_force_normal_flags(sv, 0);
7914 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7916 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7917 sv_reftype(sv,0), OP_NAME(PL_op));
7919 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
7922 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7923 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7927 s = sv_2pv_flags(sv, &len, flags);
7931 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7934 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7935 SvGROW(sv, len + 1);
7936 Move(s,SvPVX_const(sv),len,char);
7941 SvPOK_on(sv); /* validate pointer */
7943 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7944 PTR2UV(sv),SvPVX_const(sv)));
7947 return SvPVX_mutable(sv);
7950 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7951 * this function provided for binary compatibility only
7955 Perl_sv_pvbyte(pTHX_ SV *sv)
7957 sv_utf8_downgrade(sv,0);
7962 =for apidoc sv_pvbyte
7964 Use C<SvPVbyte_nolen> instead.
7966 =for apidoc sv_pvbyten
7968 A private implementation of the C<SvPVbyte> macro for compilers
7969 which can't cope with complex macro expressions. Always use the macro
7976 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7978 sv_utf8_downgrade(sv,0);
7979 return sv_pvn(sv,lp);
7983 =for apidoc sv_pvbyten_force
7985 A private implementation of the C<SvPVbytex_force> macro for compilers
7986 which can't cope with complex macro expressions. Always use the macro
7993 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7995 sv_pvn_force(sv,lp);
7996 sv_utf8_downgrade(sv,0);
8001 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8002 * this function provided for binary compatibility only
8006 Perl_sv_pvutf8(pTHX_ SV *sv)
8008 sv_utf8_upgrade(sv);
8013 =for apidoc sv_pvutf8
8015 Use the C<SvPVutf8_nolen> macro instead
8017 =for apidoc sv_pvutf8n
8019 A private implementation of the C<SvPVutf8> macro for compilers
8020 which can't cope with complex macro expressions. Always use the macro
8027 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8029 sv_utf8_upgrade(sv);
8030 return sv_pvn(sv,lp);
8034 =for apidoc sv_pvutf8n_force
8036 A private implementation of the C<SvPVutf8_force> macro for compilers
8037 which can't cope with complex macro expressions. Always use the macro
8044 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8046 sv_pvn_force(sv,lp);
8047 sv_utf8_upgrade(sv);
8053 =for apidoc sv_reftype
8055 Returns a string describing what the SV is a reference to.
8061 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8063 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8064 inside return suggests a const propagation bug in g++. */
8065 if (ob && SvOBJECT(sv)) {
8066 char *name = HvNAME_get(SvSTASH(sv));
8067 return name ? name : (char *) "__ANON__";
8070 switch (SvTYPE(sv)) {
8087 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8088 /* tied lvalues should appear to be
8089 * scalars for backwards compatitbility */
8090 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8091 ? "SCALAR" : "LVALUE");
8092 case SVt_PVAV: return "ARRAY";
8093 case SVt_PVHV: return "HASH";
8094 case SVt_PVCV: return "CODE";
8095 case SVt_PVGV: return "GLOB";
8096 case SVt_PVFM: return "FORMAT";
8097 case SVt_PVIO: return "IO";
8098 default: return "UNKNOWN";
8104 =for apidoc sv_isobject
8106 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8107 object. If the SV is not an RV, or if the object is not blessed, then this
8114 Perl_sv_isobject(pTHX_ SV *sv)
8131 Returns a boolean indicating whether the SV is blessed into the specified
8132 class. This does not check for subtypes; use C<sv_derived_from> to verify
8133 an inheritance relationship.
8139 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8151 hvname = HvNAME_get(SvSTASH(sv));
8155 return strEQ(hvname, name);
8161 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8162 it will be upgraded to one. If C<classname> is non-null then the new SV will
8163 be blessed in the specified package. The new SV is returned and its
8164 reference count is 1.
8170 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8176 SV_CHECK_THINKFIRST_COW_DROP(rv);
8179 if (SvTYPE(rv) >= SVt_PVMG) {
8180 const U32 refcnt = SvREFCNT(rv);
8184 SvREFCNT(rv) = refcnt;
8187 if (SvTYPE(rv) < SVt_RV)
8188 sv_upgrade(rv, SVt_RV);
8189 else if (SvTYPE(rv) > SVt_RV) {
8200 HV* stash = gv_stashpv(classname, TRUE);
8201 (void)sv_bless(rv, stash);
8207 =for apidoc sv_setref_pv
8209 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8210 argument will be upgraded to an RV. That RV will be modified to point to
8211 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8212 into the SV. The C<classname> argument indicates the package for the
8213 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8214 will have a reference count of 1, and the RV will be returned.
8216 Do not use with other Perl types such as HV, AV, SV, CV, because those
8217 objects will become corrupted by the pointer copy process.
8219 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8225 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8228 sv_setsv(rv, &PL_sv_undef);
8232 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8237 =for apidoc sv_setref_iv
8239 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8240 argument will be upgraded to an RV. That RV will be modified to point to
8241 the new SV. The C<classname> argument indicates the package for the
8242 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8243 will have a reference count of 1, and the RV will be returned.
8249 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8251 sv_setiv(newSVrv(rv,classname), iv);
8256 =for apidoc sv_setref_uv
8258 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8259 argument will be upgraded to an RV. That RV will be modified to point to
8260 the new SV. The C<classname> argument indicates the package for the
8261 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8262 will have a reference count of 1, and the RV will be returned.
8268 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8270 sv_setuv(newSVrv(rv,classname), uv);
8275 =for apidoc sv_setref_nv
8277 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8278 argument will be upgraded to an RV. That RV will be modified to point to
8279 the new SV. The C<classname> argument indicates the package for the
8280 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8281 will have a reference count of 1, and the RV will be returned.
8287 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8289 sv_setnv(newSVrv(rv,classname), nv);
8294 =for apidoc sv_setref_pvn
8296 Copies a string into a new SV, optionally blessing the SV. The length of the
8297 string must be specified with C<n>. The C<rv> argument will be upgraded to
8298 an RV. That RV will be modified to point to the new SV. The C<classname>
8299 argument indicates the package for the blessing. Set C<classname> to
8300 C<Nullch> to avoid the blessing. The new SV will have a reference count
8301 of 1, and the RV will be returned.
8303 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8309 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8311 sv_setpvn(newSVrv(rv,classname), pv, n);
8316 =for apidoc sv_bless
8318 Blesses an SV into a specified package. The SV must be an RV. The package
8319 must be designated by its stash (see C<gv_stashpv()>). The reference count
8320 of the SV is unaffected.
8326 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8330 Perl_croak(aTHX_ "Can't bless non-reference value");
8332 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8333 if (SvREADONLY(tmpRef))
8334 Perl_croak(aTHX_ PL_no_modify);
8335 if (SvOBJECT(tmpRef)) {
8336 if (SvTYPE(tmpRef) != SVt_PVIO)
8338 SvREFCNT_dec(SvSTASH(tmpRef));
8341 SvOBJECT_on(tmpRef);
8342 if (SvTYPE(tmpRef) != SVt_PVIO)
8344 SvUPGRADE(tmpRef, SVt_PVMG);
8345 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8352 if(SvSMAGICAL(tmpRef))
8353 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8361 /* Downgrades a PVGV to a PVMG.
8365 S_sv_unglob(pTHX_ SV *sv)
8369 assert(SvTYPE(sv) == SVt_PVGV);
8374 SvREFCNT_dec(GvSTASH(sv));
8375 GvSTASH(sv) = Nullhv;
8377 sv_unmagic(sv, PERL_MAGIC_glob);
8378 Safefree(GvNAME(sv));
8381 /* need to keep SvANY(sv) in the right arena */
8382 xpvmg = new_XPVMG();
8383 StructCopy(SvANY(sv), xpvmg, XPVMG);
8384 del_XPVGV(SvANY(sv));
8387 SvFLAGS(sv) &= ~SVTYPEMASK;
8388 SvFLAGS(sv) |= SVt_PVMG;
8392 =for apidoc sv_unref_flags
8394 Unsets the RV status of the SV, and decrements the reference count of
8395 whatever was being referenced by the RV. This can almost be thought of
8396 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8397 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8398 (otherwise the decrementing is conditional on the reference count being
8399 different from one or the reference being a readonly SV).
8406 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8410 if (SvWEAKREF(sv)) {
8418 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8419 assigned to as BEGIN {$a = \"Foo"} will fail. */
8420 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8422 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8423 sv_2mortal(rv); /* Schedule for freeing later */
8427 =for apidoc sv_unref
8429 Unsets the RV status of the SV, and decrements the reference count of
8430 whatever was being referenced by the RV. This can almost be thought of
8431 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8432 being zero. See C<SvROK_off>.
8438 Perl_sv_unref(pTHX_ SV *sv)
8440 sv_unref_flags(sv, 0);
8444 =for apidoc sv_taint
8446 Taint an SV. Use C<SvTAINTED_on> instead.
8451 Perl_sv_taint(pTHX_ SV *sv)
8453 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8457 =for apidoc sv_untaint
8459 Untaint an SV. Use C<SvTAINTED_off> instead.
8464 Perl_sv_untaint(pTHX_ SV *sv)
8466 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8467 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8474 =for apidoc sv_tainted
8476 Test an SV for taintedness. Use C<SvTAINTED> instead.
8481 Perl_sv_tainted(pTHX_ SV *sv)
8483 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8484 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8485 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8492 =for apidoc sv_setpviv
8494 Copies an integer into the given SV, also updating its string value.
8495 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8501 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8503 char buf[TYPE_CHARS(UV)];
8505 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8507 sv_setpvn(sv, ptr, ebuf - ptr);
8511 =for apidoc sv_setpviv_mg
8513 Like C<sv_setpviv>, but also handles 'set' magic.
8519 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8521 char buf[TYPE_CHARS(UV)];
8523 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8525 sv_setpvn(sv, ptr, ebuf - ptr);
8529 #if defined(PERL_IMPLICIT_CONTEXT)
8531 /* pTHX_ magic can't cope with varargs, so this is a no-context
8532 * version of the main function, (which may itself be aliased to us).
8533 * Don't access this version directly.
8537 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8541 va_start(args, pat);
8542 sv_vsetpvf(sv, pat, &args);
8546 /* pTHX_ magic can't cope with varargs, so this is a no-context
8547 * version of the main function, (which may itself be aliased to us).
8548 * Don't access this version directly.
8552 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8556 va_start(args, pat);
8557 sv_vsetpvf_mg(sv, pat, &args);
8563 =for apidoc sv_setpvf
8565 Works like C<sv_catpvf> but copies the text into the SV instead of
8566 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8572 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8575 va_start(args, pat);
8576 sv_vsetpvf(sv, pat, &args);
8581 =for apidoc sv_vsetpvf
8583 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8584 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8586 Usually used via its frontend C<sv_setpvf>.
8592 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8594 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8598 =for apidoc sv_setpvf_mg
8600 Like C<sv_setpvf>, but also handles 'set' magic.
8606 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8609 va_start(args, pat);
8610 sv_vsetpvf_mg(sv, pat, &args);
8615 =for apidoc sv_vsetpvf_mg
8617 Like C<sv_vsetpvf>, but also handles 'set' magic.
8619 Usually used via its frontend C<sv_setpvf_mg>.
8625 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8627 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8631 #if defined(PERL_IMPLICIT_CONTEXT)
8633 /* pTHX_ magic can't cope with varargs, so this is a no-context
8634 * version of the main function, (which may itself be aliased to us).
8635 * Don't access this version directly.
8639 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8643 va_start(args, pat);
8644 sv_vcatpvf(sv, pat, &args);
8648 /* pTHX_ magic can't cope with varargs, so this is a no-context
8649 * version of the main function, (which may itself be aliased to us).
8650 * Don't access this version directly.
8654 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8658 va_start(args, pat);
8659 sv_vcatpvf_mg(sv, pat, &args);
8665 =for apidoc sv_catpvf
8667 Processes its arguments like C<sprintf> and appends the formatted
8668 output to an SV. If the appended data contains "wide" characters
8669 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8670 and characters >255 formatted with %c), the original SV might get
8671 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8672 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8673 valid UTF-8; if the original SV was bytes, the pattern should be too.
8678 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8681 va_start(args, pat);
8682 sv_vcatpvf(sv, pat, &args);
8687 =for apidoc sv_vcatpvf
8689 Processes its arguments like C<vsprintf> and appends the formatted output
8690 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8692 Usually used via its frontend C<sv_catpvf>.
8698 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8700 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8704 =for apidoc sv_catpvf_mg
8706 Like C<sv_catpvf>, but also handles 'set' magic.
8712 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8715 va_start(args, pat);
8716 sv_vcatpvf_mg(sv, pat, &args);
8721 =for apidoc sv_vcatpvf_mg
8723 Like C<sv_vcatpvf>, but also handles 'set' magic.
8725 Usually used via its frontend C<sv_catpvf_mg>.
8731 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8733 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8738 =for apidoc sv_vsetpvfn
8740 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8743 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8749 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8751 sv_setpvn(sv, "", 0);
8752 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8755 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8758 S_expect_number(pTHX_ char** pattern)
8761 switch (**pattern) {
8762 case '1': case '2': case '3':
8763 case '4': case '5': case '6':
8764 case '7': case '8': case '9':
8765 while (isDIGIT(**pattern))
8766 var = var * 10 + (*(*pattern)++ - '0');
8770 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8773 F0convert(NV nv, char *endbuf, STRLEN *len)
8775 const int neg = nv < 0;
8784 if (uv & 1 && uv == nv)
8785 uv--; /* Round to even */
8787 const unsigned dig = uv % 10;
8800 =for apidoc sv_vcatpvfn
8802 Processes its arguments like C<vsprintf> and appends the formatted output
8803 to an SV. Uses an array of SVs if the C style variable argument list is
8804 missing (NULL). When running with taint checks enabled, indicates via
8805 C<maybe_tainted> if results are untrustworthy (often due to the use of
8808 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8813 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8816 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8823 static const char nullstr[] = "(null)";
8825 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8826 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8828 /* Times 4: a decimal digit takes more than 3 binary digits.
8829 * NV_DIG: mantissa takes than many decimal digits.
8830 * Plus 32: Playing safe. */
8831 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8832 /* large enough for "%#.#f" --chip */
8833 /* what about long double NVs? --jhi */
8835 /* no matter what, this is a string now */
8836 (void)SvPV_force(sv, origlen);
8838 /* special-case "", "%s", and "%-p" (SVf) */
8841 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8843 const char *s = va_arg(*args, char*);
8844 sv_catpv(sv, s ? s : nullstr);
8846 else if (svix < svmax) {
8847 sv_catsv(sv, *svargs);
8848 if (DO_UTF8(*svargs))
8853 if (patlen == 3 && pat[0] == '%' &&
8854 pat[1] == '-' && pat[2] == 'p') {
8856 argsv = va_arg(*args, SV*);
8857 sv_catsv(sv, argsv);
8864 #ifndef USE_LONG_DOUBLE
8865 /* special-case "%.<number>[gf]" */
8866 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8867 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8868 unsigned digits = 0;
8872 while (*pp >= '0' && *pp <= '9')
8873 digits = 10 * digits + (*pp++ - '0');
8874 if (pp - pat == (int)patlen - 1) {
8878 nv = (NV)va_arg(*args, double);
8879 else if (svix < svmax)
8884 /* Add check for digits != 0 because it seems that some
8885 gconverts are buggy in this case, and we don't yet have
8886 a Configure test for this. */
8887 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8888 /* 0, point, slack */
8889 Gconvert(nv, (int)digits, 0, ebuf);
8891 if (*ebuf) /* May return an empty string for digits==0 */
8894 } else if (!digits) {
8897 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8898 sv_catpvn(sv, p, l);
8904 #endif /* !USE_LONG_DOUBLE */
8906 if (!args && svix < svmax && DO_UTF8(*svargs))
8909 patend = (char*)pat + patlen;
8910 for (p = (char*)pat; p < patend; p = q) {
8913 bool vectorize = FALSE;
8914 bool vectorarg = FALSE;
8915 bool vec_utf8 = FALSE;
8921 bool has_precis = FALSE;
8924 bool is_utf8 = FALSE; /* is this item utf8? */
8925 #ifdef HAS_LDBL_SPRINTF_BUG
8926 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8927 with sfio - Allen <allens@cpan.org> */
8928 bool fix_ldbl_sprintf_bug = FALSE;
8932 U8 utf8buf[UTF8_MAXBYTES+1];
8933 STRLEN esignlen = 0;
8935 const char *eptr = Nullch;
8938 const U8 *vecstr = Null(U8*);
8945 /* we need a long double target in case HAS_LONG_DOUBLE but
8948 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8956 const char *dotstr = ".";
8957 STRLEN dotstrlen = 1;
8958 I32 efix = 0; /* explicit format parameter index */
8959 I32 ewix = 0; /* explicit width index */
8960 I32 epix = 0; /* explicit precision index */
8961 I32 evix = 0; /* explicit vector index */
8962 bool asterisk = FALSE;
8964 /* echo everything up to the next format specification */
8965 for (q = p; q < patend && *q != '%'; ++q) ;
8967 if (has_utf8 && !pat_utf8)
8968 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8970 sv_catpvn(sv, p, q - p);
8977 We allow format specification elements in this order:
8978 \d+\$ explicit format parameter index
8980 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8981 0 flag (as above): repeated to allow "v02"
8982 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8983 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8985 [%bcdefginopsux_DFOUX] format (mandatory)
8987 if (EXPECT_NUMBER(q, width)) {
9028 if (EXPECT_NUMBER(q, ewix))
9037 if ((vectorarg = asterisk)) {
9049 EXPECT_NUMBER(q, width);
9054 vecsv = va_arg(*args, SV*);
9056 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9057 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9058 dotstr = SvPV_const(vecsv, dotstrlen);
9063 vecsv = va_arg(*args, SV*);
9064 vecstr = (U8*)SvPV_const(vecsv,veclen);
9065 vec_utf8 = DO_UTF8(vecsv);
9067 else if (efix ? efix <= svmax : svix < svmax) {
9068 vecsv = svargs[efix ? efix-1 : svix++];
9069 vecstr = (U8*)SvPV_const(vecsv,veclen);
9070 vec_utf8 = DO_UTF8(vecsv);
9071 /* if this is a version object, we need to return the
9072 * stringified representation (which the SvPVX_const has
9073 * already done for us), but not vectorize the args
9075 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9077 q++; /* skip past the rest of the %vd format */
9078 eptr = (const char *) vecstr;
9079 elen = strlen(eptr);
9092 i = va_arg(*args, int);
9094 i = (ewix ? ewix <= svmax : svix < svmax) ?
9095 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9097 width = (i < 0) ? -i : i;
9107 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9109 /* XXX: todo, support specified precision parameter */
9113 i = va_arg(*args, int);
9115 i = (ewix ? ewix <= svmax : svix < svmax)
9116 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9117 precis = (i < 0) ? 0 : i;
9122 precis = precis * 10 + (*q++ - '0');
9131 case 'I': /* Ix, I32x, and I64x */
9133 if (q[1] == '6' && q[2] == '4') {
9139 if (q[1] == '3' && q[2] == '2') {
9149 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9160 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9161 if (*(q + 1) == 'l') { /* lld, llf */
9186 argsv = (efix ? efix <= svmax : svix < svmax) ?
9187 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9194 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9196 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9198 eptr = (char*)utf8buf;
9199 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9210 if (args && !vectorize) {
9211 eptr = va_arg(*args, char*);
9213 #ifdef MACOS_TRADITIONAL
9214 /* On MacOS, %#s format is used for Pascal strings */
9219 elen = strlen(eptr);
9221 eptr = (char *)nullstr;
9222 elen = sizeof nullstr - 1;
9226 eptr = SvPVx_const(argsv, elen);
9227 if (DO_UTF8(argsv)) {
9228 if (has_precis && precis < elen) {
9230 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9233 if (width) { /* fudge width (can't fudge elen) */
9234 width += elen - sv_len_utf8(argsv);
9242 if (has_precis && elen > precis)
9249 if (left && args) { /* SVf */
9258 argsv = va_arg(*args, SV*);
9259 eptr = SvPVx_const(argsv, elen);
9264 if (alt || vectorize)
9266 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9284 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9293 esignbuf[esignlen++] = plus;
9297 case 'h': iv = (short)va_arg(*args, int); break;
9298 case 'l': iv = va_arg(*args, long); break;
9299 case 'V': iv = va_arg(*args, IV); break;
9300 default: iv = va_arg(*args, int); break;
9302 case 'q': iv = va_arg(*args, Quad_t); break;
9307 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9309 case 'h': iv = (short)tiv; break;
9310 case 'l': iv = (long)tiv; break;
9312 default: iv = tiv; break;
9314 case 'q': iv = (Quad_t)tiv; break;
9318 if ( !vectorize ) /* we already set uv above */
9323 esignbuf[esignlen++] = plus;
9327 esignbuf[esignlen++] = '-';
9370 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9381 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9382 case 'l': uv = va_arg(*args, unsigned long); break;
9383 case 'V': uv = va_arg(*args, UV); break;
9384 default: uv = va_arg(*args, unsigned); break;
9386 case 'q': uv = va_arg(*args, Uquad_t); break;
9391 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9393 case 'h': uv = (unsigned short)tuv; break;
9394 case 'l': uv = (unsigned long)tuv; break;
9396 default: uv = tuv; break;
9398 case 'q': uv = (Uquad_t)tuv; break;
9405 char *ptr = ebuf + sizeof ebuf;
9411 p = (char*)((c == 'X')
9412 ? "0123456789ABCDEF" : "0123456789abcdef");
9418 esignbuf[esignlen++] = '0';
9419 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9427 if (alt && *ptr != '0')
9436 esignbuf[esignlen++] = '0';
9437 esignbuf[esignlen++] = 'b';
9440 default: /* it had better be ten or less */
9444 } while (uv /= base);
9447 elen = (ebuf + sizeof ebuf) - ptr;
9451 zeros = precis - elen;
9452 else if (precis == 0 && elen == 1 && *eptr == '0')
9458 /* FLOATING POINT */
9461 c = 'f'; /* maybe %F isn't supported here */
9467 /* This is evil, but floating point is even more evil */
9469 /* for SV-style calling, we can only get NV
9470 for C-style calling, we assume %f is double;
9471 for simplicity we allow any of %Lf, %llf, %qf for long double
9475 #if defined(USE_LONG_DOUBLE)
9479 /* [perl #20339] - we should accept and ignore %lf rather than die */
9483 #if defined(USE_LONG_DOUBLE)
9484 intsize = args ? 0 : 'q';
9488 #if defined(HAS_LONG_DOUBLE)
9497 /* now we need (long double) if intsize == 'q', else (double) */
9498 nv = (args && !vectorize) ?
9499 #if LONG_DOUBLESIZE > DOUBLESIZE
9501 va_arg(*args, long double) :
9502 va_arg(*args, double)
9504 va_arg(*args, double)
9510 if (c != 'e' && c != 'E') {
9512 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9513 will cast our (long double) to (double) */
9514 (void)Perl_frexp(nv, &i);
9515 if (i == PERL_INT_MIN)
9516 Perl_die(aTHX_ "panic: frexp");
9518 need = BIT_DIGITS(i);
9520 need += has_precis ? precis : 6; /* known default */
9525 #ifdef HAS_LDBL_SPRINTF_BUG
9526 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9527 with sfio - Allen <allens@cpan.org> */
9530 # define MY_DBL_MAX DBL_MAX
9531 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9532 # if DOUBLESIZE >= 8
9533 # define MY_DBL_MAX 1.7976931348623157E+308L
9535 # define MY_DBL_MAX 3.40282347E+38L
9539 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9540 # define MY_DBL_MAX_BUG 1L
9542 # define MY_DBL_MAX_BUG MY_DBL_MAX
9546 # define MY_DBL_MIN DBL_MIN
9547 # else /* XXX guessing! -Allen */
9548 # if DOUBLESIZE >= 8
9549 # define MY_DBL_MIN 2.2250738585072014E-308L
9551 # define MY_DBL_MIN 1.17549435E-38L
9555 if ((intsize == 'q') && (c == 'f') &&
9556 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9558 /* it's going to be short enough that
9559 * long double precision is not needed */
9561 if ((nv <= 0L) && (nv >= -0L))
9562 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9564 /* would use Perl_fp_class as a double-check but not
9565 * functional on IRIX - see perl.h comments */
9567 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9568 /* It's within the range that a double can represent */
9569 #if defined(DBL_MAX) && !defined(DBL_MIN)
9570 if ((nv >= ((long double)1/DBL_MAX)) ||
9571 (nv <= (-(long double)1/DBL_MAX)))
9573 fix_ldbl_sprintf_bug = TRUE;
9576 if (fix_ldbl_sprintf_bug == TRUE) {
9586 # undef MY_DBL_MAX_BUG
9589 #endif /* HAS_LDBL_SPRINTF_BUG */
9591 need += 20; /* fudge factor */
9592 if (PL_efloatsize < need) {
9593 Safefree(PL_efloatbuf);
9594 PL_efloatsize = need + 20; /* more fudge */
9595 New(906, PL_efloatbuf, PL_efloatsize, char);
9596 PL_efloatbuf[0] = '\0';
9599 if ( !(width || left || plus || alt) && fill != '0'
9600 && has_precis && intsize != 'q' ) { /* Shortcuts */
9601 /* See earlier comment about buggy Gconvert when digits,
9603 if ( c == 'g' && precis) {
9604 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9605 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9606 goto float_converted;
9607 } else if ( c == 'f' && !precis) {
9608 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9613 char *ptr = ebuf + sizeof ebuf;
9616 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9617 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9618 if (intsize == 'q') {
9619 /* Copy the one or more characters in a long double
9620 * format before the 'base' ([efgEFG]) character to
9621 * the format string. */
9622 static char const prifldbl[] = PERL_PRIfldbl;
9623 char const *p = prifldbl + sizeof(prifldbl) - 3;
9624 while (p >= prifldbl) { *--ptr = *p--; }
9629 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9634 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9646 /* No taint. Otherwise we are in the strange situation
9647 * where printf() taints but print($float) doesn't.
9649 #if defined(HAS_LONG_DOUBLE)
9651 (void)sprintf(PL_efloatbuf, ptr, nv);
9653 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9655 (void)sprintf(PL_efloatbuf, ptr, nv);
9659 eptr = PL_efloatbuf;
9660 elen = strlen(PL_efloatbuf);
9666 i = SvCUR(sv) - origlen;
9667 if (args && !vectorize) {
9669 case 'h': *(va_arg(*args, short*)) = i; break;
9670 default: *(va_arg(*args, int*)) = i; break;
9671 case 'l': *(va_arg(*args, long*)) = i; break;
9672 case 'V': *(va_arg(*args, IV*)) = i; break;
9674 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9679 sv_setuv_mg(argsv, (UV)i);
9681 continue; /* not "break" */
9687 if (!args && ckWARN(WARN_PRINTF) &&
9688 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9689 SV *msg = sv_newmortal();
9690 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9691 (PL_op->op_type == OP_PRTF) ? "" : "s");
9694 Perl_sv_catpvf(aTHX_ msg,
9695 "\"%%%c\"", c & 0xFF);
9697 Perl_sv_catpvf(aTHX_ msg,
9698 "\"%%\\%03"UVof"\"",
9701 sv_catpv(msg, "end of string");
9702 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9705 /* output mangled stuff ... */
9711 /* ... right here, because formatting flags should not apply */
9712 SvGROW(sv, SvCUR(sv) + elen + 1);
9714 Copy(eptr, p, elen, char);
9717 SvCUR_set(sv, p - SvPVX_const(sv));
9719 continue; /* not "break" */
9722 /* calculate width before utf8_upgrade changes it */
9723 have = esignlen + zeros + elen;
9725 if (is_utf8 != has_utf8) {
9728 sv_utf8_upgrade(sv);
9731 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9732 sv_utf8_upgrade(nsv);
9733 eptr = SvPVX_const(nsv);
9736 SvGROW(sv, SvCUR(sv) + elen + 1);
9741 need = (have > width ? have : width);
9744 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9746 if (esignlen && fill == '0') {
9747 for (i = 0; i < (int)esignlen; i++)
9751 memset(p, fill, gap);
9754 if (esignlen && fill != '0') {
9755 for (i = 0; i < (int)esignlen; i++)
9759 for (i = zeros; i; i--)
9763 Copy(eptr, p, elen, char);
9767 memset(p, ' ', gap);
9772 Copy(dotstr, p, dotstrlen, char);
9776 vectorize = FALSE; /* done iterating over vecstr */
9783 SvCUR_set(sv, p - SvPVX_const(sv));
9791 /* =========================================================================
9793 =head1 Cloning an interpreter
9795 All the macros and functions in this section are for the private use of
9796 the main function, perl_clone().
9798 The foo_dup() functions make an exact copy of an existing foo thinngy.
9799 During the course of a cloning, a hash table is used to map old addresses
9800 to new addresses. The table is created and manipulated with the
9801 ptr_table_* functions.
9805 ============================================================================*/
9808 #if defined(USE_ITHREADS)
9810 #ifndef GpREFCNT_inc
9811 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9815 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9816 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9817 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9818 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9819 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9820 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9821 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9822 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9823 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9824 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9825 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9826 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9827 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9830 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9831 regcomp.c. AMS 20010712 */
9834 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9839 struct reg_substr_datum *s;
9842 return (REGEXP *)NULL;
9844 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9847 len = r->offsets[0];
9848 npar = r->nparens+1;
9850 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9851 Copy(r->program, ret->program, len+1, regnode);
9853 New(0, ret->startp, npar, I32);
9854 Copy(r->startp, ret->startp, npar, I32);
9855 New(0, ret->endp, npar, I32);
9856 Copy(r->startp, ret->startp, npar, I32);
9858 New(0, ret->substrs, 1, struct reg_substr_data);
9859 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9860 s->min_offset = r->substrs->data[i].min_offset;
9861 s->max_offset = r->substrs->data[i].max_offset;
9862 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9863 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9866 ret->regstclass = NULL;
9869 const int count = r->data->count;
9871 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9872 char, struct reg_data);
9873 New(0, d->what, count, U8);
9876 for (i = 0; i < count; i++) {
9877 d->what[i] = r->data->what[i];
9878 switch (d->what[i]) {
9879 /* legal options are one of: sfpont
9880 see also regcomp.h and pregfree() */
9882 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9885 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9888 /* This is cheating. */
9889 New(0, d->data[i], 1, struct regnode_charclass_class);
9890 StructCopy(r->data->data[i], d->data[i],
9891 struct regnode_charclass_class);
9892 ret->regstclass = (regnode*)d->data[i];
9895 /* Compiled op trees are readonly, and can thus be
9896 shared without duplication. */
9898 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9902 d->data[i] = r->data->data[i];
9905 d->data[i] = r->data->data[i];
9907 ((reg_trie_data*)d->data[i])->refcount++;
9911 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9920 New(0, ret->offsets, 2*len+1, U32);
9921 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9923 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9924 ret->refcnt = r->refcnt;
9925 ret->minlen = r->minlen;
9926 ret->prelen = r->prelen;
9927 ret->nparens = r->nparens;
9928 ret->lastparen = r->lastparen;
9929 ret->lastcloseparen = r->lastcloseparen;
9930 ret->reganch = r->reganch;
9932 ret->sublen = r->sublen;
9934 if (RX_MATCH_COPIED(ret))
9935 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9937 ret->subbeg = Nullch;
9938 #ifdef PERL_OLD_COPY_ON_WRITE
9939 ret->saved_copy = Nullsv;
9942 ptr_table_store(PL_ptr_table, r, ret);
9946 /* duplicate a file handle */
9949 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9955 return (PerlIO*)NULL;
9957 /* look for it in the table first */
9958 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9962 /* create anew and remember what it is */
9963 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9964 ptr_table_store(PL_ptr_table, fp, ret);
9968 /* duplicate a directory handle */
9971 Perl_dirp_dup(pTHX_ DIR *dp)
9979 /* duplicate a typeglob */
9982 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9987 /* look for it in the table first */
9988 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9992 /* create anew and remember what it is */
9993 Newz(0, ret, 1, GP);
9994 ptr_table_store(PL_ptr_table, gp, ret);
9997 ret->gp_refcnt = 0; /* must be before any other dups! */
9998 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9999 ret->gp_io = io_dup_inc(gp->gp_io, param);
10000 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10001 ret->gp_av = av_dup_inc(gp->gp_av, param);
10002 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10003 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10004 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10005 ret->gp_cvgen = gp->gp_cvgen;
10006 ret->gp_flags = gp->gp_flags;
10007 ret->gp_line = gp->gp_line;
10008 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10012 /* duplicate a chain of magic */
10015 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10017 MAGIC *mgprev = (MAGIC*)NULL;
10020 return (MAGIC*)NULL;
10021 /* look for it in the table first */
10022 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10026 for (; mg; mg = mg->mg_moremagic) {
10028 Newz(0, nmg, 1, MAGIC);
10030 mgprev->mg_moremagic = nmg;
10033 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10034 nmg->mg_private = mg->mg_private;
10035 nmg->mg_type = mg->mg_type;
10036 nmg->mg_flags = mg->mg_flags;
10037 if (mg->mg_type == PERL_MAGIC_qr) {
10038 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10040 else if(mg->mg_type == PERL_MAGIC_backref) {
10041 const AV * const av = (AV*) mg->mg_obj;
10044 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10046 for (i = AvFILLp(av); i >= 0; i--) {
10047 if (!svp[i]) continue;
10048 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10051 else if (mg->mg_type == PERL_MAGIC_symtab) {
10052 nmg->mg_obj = mg->mg_obj;
10055 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10056 ? sv_dup_inc(mg->mg_obj, param)
10057 : sv_dup(mg->mg_obj, param);
10059 nmg->mg_len = mg->mg_len;
10060 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10061 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10062 if (mg->mg_len > 0) {
10063 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10064 if (mg->mg_type == PERL_MAGIC_overload_table &&
10065 AMT_AMAGIC((AMT*)mg->mg_ptr))
10067 AMT *amtp = (AMT*)mg->mg_ptr;
10068 AMT *namtp = (AMT*)nmg->mg_ptr;
10070 for (i = 1; i < NofAMmeth; i++) {
10071 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10075 else if (mg->mg_len == HEf_SVKEY)
10076 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10078 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10079 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10086 /* create a new pointer-mapping table */
10089 Perl_ptr_table_new(pTHX)
10092 Newz(0, tbl, 1, PTR_TBL_t);
10093 tbl->tbl_max = 511;
10094 tbl->tbl_items = 0;
10095 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10100 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10102 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10105 #define new_pte() new_body(struct ptr_tbl_ent, pte)
10106 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
10108 /* map an existing pointer using a table */
10111 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10113 PTR_TBL_ENT_t *tblent;
10114 const UV hash = PTR_TABLE_HASH(sv);
10116 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10117 for (; tblent; tblent = tblent->next) {
10118 if (tblent->oldval == sv)
10119 return tblent->newval;
10121 return (void*)NULL;
10124 /* add a new entry to a pointer-mapping table */
10127 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10129 PTR_TBL_ENT_t *tblent, **otblent;
10130 /* XXX this may be pessimal on platforms where pointers aren't good
10131 * hash values e.g. if they grow faster in the most significant
10133 const UV hash = PTR_TABLE_HASH(oldv);
10137 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10138 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10139 if (tblent->oldval == oldv) {
10140 tblent->newval = newv;
10144 tblent = new_pte();
10145 tblent->oldval = oldv;
10146 tblent->newval = newv;
10147 tblent->next = *otblent;
10150 if (!empty && tbl->tbl_items > tbl->tbl_max)
10151 ptr_table_split(tbl);
10154 /* double the hash bucket size of an existing ptr table */
10157 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10159 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10160 const UV oldsize = tbl->tbl_max + 1;
10161 UV newsize = oldsize * 2;
10164 Renew(ary, newsize, PTR_TBL_ENT_t*);
10165 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10166 tbl->tbl_max = --newsize;
10167 tbl->tbl_ary = ary;
10168 for (i=0; i < oldsize; i++, ary++) {
10169 PTR_TBL_ENT_t **curentp, **entp, *ent;
10172 curentp = ary + oldsize;
10173 for (entp = ary, ent = *ary; ent; ent = *entp) {
10174 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10176 ent->next = *curentp;
10186 /* remove all the entries from a ptr table */
10189 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10191 register PTR_TBL_ENT_t **array;
10192 register PTR_TBL_ENT_t *entry;
10196 if (!tbl || !tbl->tbl_items) {
10200 array = tbl->tbl_ary;
10202 max = tbl->tbl_max;
10206 PTR_TBL_ENT_t *oentry = entry;
10207 entry = entry->next;
10211 if (++riter > max) {
10214 entry = array[riter];
10218 tbl->tbl_items = 0;
10221 /* clear and free a ptr table */
10224 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10229 ptr_table_clear(tbl);
10230 Safefree(tbl->tbl_ary);
10234 /* attempt to make everything in the typeglob readonly */
10237 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10239 GV *gv = (GV*)sstr;
10240 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10242 if (GvIO(gv) || GvFORM(gv)) {
10243 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10245 else if (!GvCV(gv)) {
10246 GvCV(gv) = (CV*)sv;
10249 /* CvPADLISTs cannot be shared */
10250 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10255 if (!GvUNIQUE(gv)) {
10257 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10258 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10264 * write attempts will die with
10265 * "Modification of a read-only value attempted"
10271 SvREADONLY_on(GvSV(gv));
10275 GvAV(gv) = (AV*)sv;
10278 SvREADONLY_on(GvAV(gv));
10282 GvHV(gv) = (HV*)sv;
10285 SvREADONLY_on(GvHV(gv));
10288 return sstr; /* he_dup() will SvREFCNT_inc() */
10292 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10295 SvRV_set(dstr, SvWEAKREF(sstr)
10296 ? sv_dup(SvRV(sstr), param)
10297 : sv_dup_inc(SvRV(sstr), param));
10300 else if (SvPVX_const(sstr)) {
10301 /* Has something there */
10303 /* Normal PV - clone whole allocated space */
10304 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10305 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10306 /* Not that normal - actually sstr is copy on write.
10307 But we are a true, independant SV, so: */
10308 SvREADONLY_off(dstr);
10313 /* Special case - not normally malloced for some reason */
10314 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10315 /* A "shared" PV - clone it as "shared" PV */
10317 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10321 /* Some other special case - random pointer */
10322 SvPV_set(dstr, SvPVX(sstr));
10327 /* Copy the Null */
10328 if (SvTYPE(dstr) == SVt_RV)
10329 SvRV_set(dstr, NULL);
10335 /* duplicate an SV of any type (including AV, HV etc) */
10338 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10343 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10345 /* look for it in the table first */
10346 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10350 if(param->flags & CLONEf_JOIN_IN) {
10351 /** We are joining here so we don't want do clone
10352 something that is bad **/
10353 const char *hvname;
10355 if(SvTYPE(sstr) == SVt_PVHV &&
10356 (hvname = HvNAME_get(sstr))) {
10357 /** don't clone stashes if they already exist **/
10358 HV* old_stash = gv_stashpv(hvname,0);
10359 return (SV*) old_stash;
10363 /* create anew and remember what it is */
10366 #ifdef DEBUG_LEAKING_SCALARS
10367 dstr->sv_debug_optype = sstr->sv_debug_optype;
10368 dstr->sv_debug_line = sstr->sv_debug_line;
10369 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10370 dstr->sv_debug_cloned = 1;
10372 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10374 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10378 ptr_table_store(PL_ptr_table, sstr, dstr);
10381 SvFLAGS(dstr) = SvFLAGS(sstr);
10382 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10383 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10386 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10387 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10388 PL_watch_pvx, SvPVX_const(sstr));
10391 /* don't clone objects whose class has asked us not to */
10392 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10393 SvFLAGS(dstr) &= ~SVTYPEMASK;
10394 SvOBJECT_off(dstr);
10398 switch (SvTYPE(sstr)) {
10400 SvANY(dstr) = NULL;
10403 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10404 SvIV_set(dstr, SvIVX(sstr));
10407 SvANY(dstr) = new_XNV();
10408 SvNV_set(dstr, SvNVX(sstr));
10411 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10412 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10416 /* These are all the types that need complex bodies allocating. */
10417 size_t new_body_length;
10418 size_t new_body_offset = 0;
10419 void **new_body_arena;
10420 void **new_body_arenaroot;
10423 switch (SvTYPE(sstr)) {
10425 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10430 new_body = new_XPVIO();
10431 new_body_length = sizeof(XPVIO);
10434 new_body = new_XPVFM();
10435 new_body_length = sizeof(XPVFM);
10439 new_body_arena = (void **) &PL_xpvhv_root;
10440 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10441 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10442 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10443 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10444 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10448 new_body_arena = (void **) &PL_xpvav_root;
10449 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10450 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10451 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10452 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10453 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10457 new_body_length = sizeof(XPVBM);
10458 new_body_arena = (void **) &PL_xpvbm_root;
10459 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10462 if (GvUNIQUE((GV*)sstr)) {
10464 if ((share = gv_share(sstr, param))) {
10467 ptr_table_store(PL_ptr_table, sstr, dstr);
10469 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10470 HvNAME_get(GvSTASH(share)), GvNAME(share));
10475 new_body_length = sizeof(XPVGV);
10476 new_body_arena = (void **) &PL_xpvgv_root;
10477 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10480 new_body_length = sizeof(XPVCV);
10481 new_body_arena = (void **) &PL_xpvcv_root;
10482 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10485 new_body_length = sizeof(XPVLV);
10486 new_body_arena = (void **) &PL_xpvlv_root;
10487 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10490 new_body_length = sizeof(XPVMG);
10491 new_body_arena = (void **) &PL_xpvmg_root;
10492 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10495 new_body_length = sizeof(XPVNV);
10496 new_body_arena = (void **) &PL_xpvnv_root;
10497 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10500 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10501 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10502 new_body_length = sizeof(XPVIV) - new_body_offset;
10503 new_body_arena = (void **) &PL_xpviv_root;
10504 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10507 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10508 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10509 new_body_length = sizeof(XPV) - new_body_offset;
10510 new_body_arena = (void **) &PL_xpv_root;
10511 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10513 assert(new_body_length);
10515 new_body = (void*)((char*)S_new_body(aTHX_ new_body_arenaroot,
10518 - new_body_offset);
10520 /* We always allocated the full length item with PURIFY */
10521 new_body_length += new_body_offset;
10522 new_body_offset = 0;
10523 new_body = my_safemalloc(new_body_length);
10527 SvANY(dstr) = new_body;
10529 Copy(((char*)SvANY(sstr)) + new_body_offset,
10530 ((char*)SvANY(dstr)) + new_body_offset,
10531 new_body_length, char);
10533 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10534 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10536 /* The Copy above means that all the source (unduplicated) pointers
10537 are now in the destination. We can check the flags and the
10538 pointers in either, but it's possible that there's less cache
10539 missing by always going for the destination.
10540 FIXME - instrument and check that assumption */
10541 if (SvTYPE(sstr) >= SVt_PVMG) {
10543 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10545 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10548 switch (SvTYPE(sstr)) {
10560 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10561 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10562 LvTARG(dstr) = dstr;
10563 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10564 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10566 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10569 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10570 GvSTASH(dstr) = hv_dup_inc(GvSTASH(dstr), param);
10571 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10572 (void)GpREFCNT_inc(GvGP(dstr));
10575 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10576 if (IoOFP(dstr) == IoIFP(sstr))
10577 IoOFP(dstr) = IoIFP(dstr);
10579 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10580 /* PL_rsfp_filters entries have fake IoDIRP() */
10581 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10582 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10583 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10584 /* I have no idea why fake dirp (rsfps)
10585 should be treated differently but otherwise
10586 we end up with leaks -- sky*/
10587 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10588 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10589 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10591 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10592 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10593 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10595 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10596 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10597 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10600 if (AvARRAY((AV*)sstr)) {
10601 SV **dst_ary, **src_ary;
10602 SSize_t items = AvFILLp((AV*)sstr) + 1;
10604 src_ary = AvARRAY((AV*)sstr);
10605 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10606 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10607 SvPV_set(dstr, (char*)dst_ary);
10608 AvALLOC((AV*)dstr) = dst_ary;
10609 if (AvREAL((AV*)sstr)) {
10610 while (items-- > 0)
10611 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10614 while (items-- > 0)
10615 *dst_ary++ = sv_dup(*src_ary++, param);
10617 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10618 while (items-- > 0) {
10619 *dst_ary++ = &PL_sv_undef;
10623 SvPV_set(dstr, Nullch);
10624 AvALLOC((AV*)dstr) = (SV**)NULL;
10631 if (HvARRAY((HV*)sstr)) {
10633 const bool sharekeys = !!HvSHAREKEYS(sstr);
10634 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10635 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10638 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10639 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10641 HvARRAY(dstr) = (HE**)darray;
10642 while (i <= sxhv->xhv_max) {
10643 HE *source = HvARRAY(sstr)[i];
10644 HvARRAY(dstr)[i] = source
10645 ? he_dup(source, sharekeys, param) : 0;
10649 struct xpvhv_aux *saux = HvAUX(sstr);
10650 struct xpvhv_aux *daux = HvAUX(dstr);
10651 /* This flag isn't copied. */
10652 /* SvOOK_on(hv) attacks the IV flags. */
10653 SvFLAGS(dstr) |= SVf_OOK;
10655 hvname = saux->xhv_name;
10657 = hvname ? hek_dup(hvname, param) : hvname;
10659 daux->xhv_riter = saux->xhv_riter;
10660 daux->xhv_eiter = saux->xhv_eiter
10661 ? he_dup(saux->xhv_eiter,
10662 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10666 SvPV_set(dstr, Nullch);
10668 /* Record stashes for possible cloning in Perl_clone(). */
10670 av_push(param->stashes, dstr);
10675 /* NOTE: not refcounted */
10676 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10678 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10680 if (CvCONST(dstr)) {
10681 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10682 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10683 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10685 /* don't dup if copying back - CvGV isn't refcounted, so the
10686 * duped GV may never be freed. A bit of a hack! DAPM */
10687 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10688 Nullgv : gv_dup(CvGV(dstr), param) ;
10689 if (!(param->flags & CLONEf_COPY_STACKS)) {
10692 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10694 CvWEAKOUTSIDE(sstr)
10695 ? cv_dup( CvOUTSIDE(dstr), param)
10696 : cv_dup_inc(CvOUTSIDE(dstr), param);
10698 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10705 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10711 /* duplicate a context */
10714 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10716 PERL_CONTEXT *ncxs;
10719 return (PERL_CONTEXT*)NULL;
10721 /* look for it in the table first */
10722 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10726 /* create anew and remember what it is */
10727 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10728 ptr_table_store(PL_ptr_table, cxs, ncxs);
10731 PERL_CONTEXT *cx = &cxs[ix];
10732 PERL_CONTEXT *ncx = &ncxs[ix];
10733 ncx->cx_type = cx->cx_type;
10734 if (CxTYPE(cx) == CXt_SUBST) {
10735 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10738 ncx->blk_oldsp = cx->blk_oldsp;
10739 ncx->blk_oldcop = cx->blk_oldcop;
10740 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10741 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10742 ncx->blk_oldpm = cx->blk_oldpm;
10743 ncx->blk_gimme = cx->blk_gimme;
10744 switch (CxTYPE(cx)) {
10746 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10747 ? cv_dup_inc(cx->blk_sub.cv, param)
10748 : cv_dup(cx->blk_sub.cv,param));
10749 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10750 ? av_dup_inc(cx->blk_sub.argarray, param)
10752 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10753 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10754 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10755 ncx->blk_sub.lval = cx->blk_sub.lval;
10756 ncx->blk_sub.retop = cx->blk_sub.retop;
10759 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10760 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10761 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10762 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10763 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10764 ncx->blk_eval.retop = cx->blk_eval.retop;
10767 ncx->blk_loop.label = cx->blk_loop.label;
10768 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10769 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10770 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10771 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10772 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10773 ? cx->blk_loop.iterdata
10774 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10775 ncx->blk_loop.oldcomppad
10776 = (PAD*)ptr_table_fetch(PL_ptr_table,
10777 cx->blk_loop.oldcomppad);
10778 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10779 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10780 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10781 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10782 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10785 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10786 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10787 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10788 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10789 ncx->blk_sub.retop = cx->blk_sub.retop;
10801 /* duplicate a stack info structure */
10804 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10809 return (PERL_SI*)NULL;
10811 /* look for it in the table first */
10812 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10816 /* create anew and remember what it is */
10817 Newz(56, nsi, 1, PERL_SI);
10818 ptr_table_store(PL_ptr_table, si, nsi);
10820 nsi->si_stack = av_dup_inc(si->si_stack, param);
10821 nsi->si_cxix = si->si_cxix;
10822 nsi->si_cxmax = si->si_cxmax;
10823 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10824 nsi->si_type = si->si_type;
10825 nsi->si_prev = si_dup(si->si_prev, param);
10826 nsi->si_next = si_dup(si->si_next, param);
10827 nsi->si_markoff = si->si_markoff;
10832 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10833 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10834 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10835 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10836 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10837 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10838 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10839 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10840 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10841 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10842 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10843 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10844 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10845 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10848 #define pv_dup_inc(p) SAVEPV(p)
10849 #define pv_dup(p) SAVEPV(p)
10850 #define svp_dup_inc(p,pp) any_dup(p,pp)
10852 /* map any object to the new equivent - either something in the
10853 * ptr table, or something in the interpreter structure
10857 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10862 return (void*)NULL;
10864 /* look for it in the table first */
10865 ret = ptr_table_fetch(PL_ptr_table, v);
10869 /* see if it is part of the interpreter structure */
10870 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10871 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10879 /* duplicate the save stack */
10882 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10884 ANY *ss = proto_perl->Tsavestack;
10885 I32 ix = proto_perl->Tsavestack_ix;
10886 I32 max = proto_perl->Tsavestack_max;
10898 void (*dptr) (void*);
10899 void (*dxptr) (pTHX_ void*);
10902 Newz(54, nss, max, ANY);
10905 I32 i = POPINT(ss,ix);
10906 TOPINT(nss,ix) = i;
10908 case SAVEt_ITEM: /* normal string */
10909 sv = (SV*)POPPTR(ss,ix);
10910 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10911 sv = (SV*)POPPTR(ss,ix);
10912 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10914 case SAVEt_SV: /* scalar reference */
10915 sv = (SV*)POPPTR(ss,ix);
10916 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10917 gv = (GV*)POPPTR(ss,ix);
10918 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10920 case SAVEt_GENERIC_PVREF: /* generic char* */
10921 c = (char*)POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = pv_dup(c);
10923 ptr = POPPTR(ss,ix);
10924 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10926 case SAVEt_SHARED_PVREF: /* char* in shared space */
10927 c = (char*)POPPTR(ss,ix);
10928 TOPPTR(nss,ix) = savesharedpv(c);
10929 ptr = POPPTR(ss,ix);
10930 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10932 case SAVEt_GENERIC_SVREF: /* generic sv */
10933 case SAVEt_SVREF: /* scalar reference */
10934 sv = (SV*)POPPTR(ss,ix);
10935 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10936 ptr = POPPTR(ss,ix);
10937 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10939 case SAVEt_AV: /* array reference */
10940 av = (AV*)POPPTR(ss,ix);
10941 TOPPTR(nss,ix) = av_dup_inc(av, param);
10942 gv = (GV*)POPPTR(ss,ix);
10943 TOPPTR(nss,ix) = gv_dup(gv, param);
10945 case SAVEt_HV: /* hash reference */
10946 hv = (HV*)POPPTR(ss,ix);
10947 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10948 gv = (GV*)POPPTR(ss,ix);
10949 TOPPTR(nss,ix) = gv_dup(gv, param);
10951 case SAVEt_INT: /* int reference */
10952 ptr = POPPTR(ss,ix);
10953 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10954 intval = (int)POPINT(ss,ix);
10955 TOPINT(nss,ix) = intval;
10957 case SAVEt_LONG: /* long reference */
10958 ptr = POPPTR(ss,ix);
10959 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10960 longval = (long)POPLONG(ss,ix);
10961 TOPLONG(nss,ix) = longval;
10963 case SAVEt_I32: /* I32 reference */
10964 case SAVEt_I16: /* I16 reference */
10965 case SAVEt_I8: /* I8 reference */
10966 ptr = POPPTR(ss,ix);
10967 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10969 TOPINT(nss,ix) = i;
10971 case SAVEt_IV: /* IV reference */
10972 ptr = POPPTR(ss,ix);
10973 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10975 TOPIV(nss,ix) = iv;
10977 case SAVEt_SPTR: /* SV* reference */
10978 ptr = POPPTR(ss,ix);
10979 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10980 sv = (SV*)POPPTR(ss,ix);
10981 TOPPTR(nss,ix) = sv_dup(sv, param);
10983 case SAVEt_VPTR: /* random* reference */
10984 ptr = POPPTR(ss,ix);
10985 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10986 ptr = POPPTR(ss,ix);
10987 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10989 case SAVEt_PPTR: /* char* reference */
10990 ptr = POPPTR(ss,ix);
10991 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10992 c = (char*)POPPTR(ss,ix);
10993 TOPPTR(nss,ix) = pv_dup(c);
10995 case SAVEt_HPTR: /* HV* reference */
10996 ptr = POPPTR(ss,ix);
10997 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10998 hv = (HV*)POPPTR(ss,ix);
10999 TOPPTR(nss,ix) = hv_dup(hv, param);
11001 case SAVEt_APTR: /* AV* reference */
11002 ptr = POPPTR(ss,ix);
11003 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11004 av = (AV*)POPPTR(ss,ix);
11005 TOPPTR(nss,ix) = av_dup(av, param);
11008 gv = (GV*)POPPTR(ss,ix);
11009 TOPPTR(nss,ix) = gv_dup(gv, param);
11011 case SAVEt_GP: /* scalar reference */
11012 gp = (GP*)POPPTR(ss,ix);
11013 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11014 (void)GpREFCNT_inc(gp);
11015 gv = (GV*)POPPTR(ss,ix);
11016 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11017 c = (char*)POPPTR(ss,ix);
11018 TOPPTR(nss,ix) = pv_dup(c);
11020 TOPIV(nss,ix) = iv;
11022 TOPIV(nss,ix) = iv;
11025 case SAVEt_MORTALIZESV:
11026 sv = (SV*)POPPTR(ss,ix);
11027 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11030 ptr = POPPTR(ss,ix);
11031 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11032 /* these are assumed to be refcounted properly */
11033 switch (((OP*)ptr)->op_type) {
11035 case OP_LEAVESUBLV:
11039 case OP_LEAVEWRITE:
11040 TOPPTR(nss,ix) = ptr;
11045 TOPPTR(nss,ix) = Nullop;
11050 TOPPTR(nss,ix) = Nullop;
11053 c = (char*)POPPTR(ss,ix);
11054 TOPPTR(nss,ix) = pv_dup_inc(c);
11056 case SAVEt_CLEARSV:
11057 longval = POPLONG(ss,ix);
11058 TOPLONG(nss,ix) = longval;
11061 hv = (HV*)POPPTR(ss,ix);
11062 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11063 c = (char*)POPPTR(ss,ix);
11064 TOPPTR(nss,ix) = pv_dup_inc(c);
11066 TOPINT(nss,ix) = i;
11068 case SAVEt_DESTRUCTOR:
11069 ptr = POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11071 dptr = POPDPTR(ss,ix);
11072 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11073 any_dup(FPTR2DPTR(void *, dptr),
11076 case SAVEt_DESTRUCTOR_X:
11077 ptr = POPPTR(ss,ix);
11078 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11079 dxptr = POPDXPTR(ss,ix);
11080 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11081 any_dup(FPTR2DPTR(void *, dxptr),
11084 case SAVEt_REGCONTEXT:
11087 TOPINT(nss,ix) = i;
11090 case SAVEt_STACK_POS: /* Position on Perl stack */
11092 TOPINT(nss,ix) = i;
11094 case SAVEt_AELEM: /* array element */
11095 sv = (SV*)POPPTR(ss,ix);
11096 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11098 TOPINT(nss,ix) = i;
11099 av = (AV*)POPPTR(ss,ix);
11100 TOPPTR(nss,ix) = av_dup_inc(av, param);
11102 case SAVEt_HELEM: /* hash element */
11103 sv = (SV*)POPPTR(ss,ix);
11104 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11105 sv = (SV*)POPPTR(ss,ix);
11106 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11107 hv = (HV*)POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11111 ptr = POPPTR(ss,ix);
11112 TOPPTR(nss,ix) = ptr;
11116 TOPINT(nss,ix) = i;
11118 case SAVEt_COMPPAD:
11119 av = (AV*)POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = av_dup(av, param);
11123 longval = (long)POPLONG(ss,ix);
11124 TOPLONG(nss,ix) = longval;
11125 ptr = POPPTR(ss,ix);
11126 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11127 sv = (SV*)POPPTR(ss,ix);
11128 TOPPTR(nss,ix) = sv_dup(sv, param);
11131 ptr = POPPTR(ss,ix);
11132 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11133 longval = (long)POPBOOL(ss,ix);
11134 TOPBOOL(nss,ix) = (bool)longval;
11136 case SAVEt_SET_SVFLAGS:
11138 TOPINT(nss,ix) = i;
11140 TOPINT(nss,ix) = i;
11141 sv = (SV*)POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = sv_dup(sv, param);
11145 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11153 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11154 * flag to the result. This is done for each stash before cloning starts,
11155 * so we know which stashes want their objects cloned */
11158 do_mark_cloneable_stash(pTHX_ SV *sv)
11160 const HEK *hvname = HvNAME_HEK((HV*)sv);
11162 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11163 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11164 if (cloner && GvCV(cloner)) {
11171 XPUSHs(sv_2mortal(newSVhek(hvname)));
11173 call_sv((SV*)GvCV(cloner), G_SCALAR);
11180 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11188 =for apidoc perl_clone
11190 Create and return a new interpreter by cloning the current one.
11192 perl_clone takes these flags as parameters:
11194 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11195 without it we only clone the data and zero the stacks,
11196 with it we copy the stacks and the new perl interpreter is
11197 ready to run at the exact same point as the previous one.
11198 The pseudo-fork code uses COPY_STACKS while the
11199 threads->new doesn't.
11201 CLONEf_KEEP_PTR_TABLE
11202 perl_clone keeps a ptr_table with the pointer of the old
11203 variable as a key and the new variable as a value,
11204 this allows it to check if something has been cloned and not
11205 clone it again but rather just use the value and increase the
11206 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11207 the ptr_table using the function
11208 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11209 reason to keep it around is if you want to dup some of your own
11210 variable who are outside the graph perl scans, example of this
11211 code is in threads.xs create
11214 This is a win32 thing, it is ignored on unix, it tells perls
11215 win32host code (which is c++) to clone itself, this is needed on
11216 win32 if you want to run two threads at the same time,
11217 if you just want to do some stuff in a separate perl interpreter
11218 and then throw it away and return to the original one,
11219 you don't need to do anything.
11224 /* XXX the above needs expanding by someone who actually understands it ! */
11225 EXTERN_C PerlInterpreter *
11226 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11229 perl_clone(PerlInterpreter *proto_perl, UV flags)
11232 #ifdef PERL_IMPLICIT_SYS
11234 /* perlhost.h so we need to call into it
11235 to clone the host, CPerlHost should have a c interface, sky */
11237 if (flags & CLONEf_CLONE_HOST) {
11238 return perl_clone_host(proto_perl,flags);
11240 return perl_clone_using(proto_perl, flags,
11242 proto_perl->IMemShared,
11243 proto_perl->IMemParse,
11245 proto_perl->IStdIO,
11249 proto_perl->IProc);
11253 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11254 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11255 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11256 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11257 struct IPerlDir* ipD, struct IPerlSock* ipS,
11258 struct IPerlProc* ipP)
11260 /* XXX many of the string copies here can be optimized if they're
11261 * constants; they need to be allocated as common memory and just
11262 * their pointers copied. */
11265 CLONE_PARAMS clone_params;
11266 CLONE_PARAMS* param = &clone_params;
11268 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11269 /* for each stash, determine whether its objects should be cloned */
11270 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11271 PERL_SET_THX(my_perl);
11274 Poison(my_perl, 1, PerlInterpreter);
11276 PL_curcop = (COP *)Nullop;
11280 PL_savestack_ix = 0;
11281 PL_savestack_max = -1;
11282 PL_sig_pending = 0;
11283 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11284 # else /* !DEBUGGING */
11285 Zero(my_perl, 1, PerlInterpreter);
11286 # endif /* DEBUGGING */
11288 /* host pointers */
11290 PL_MemShared = ipMS;
11291 PL_MemParse = ipMP;
11298 #else /* !PERL_IMPLICIT_SYS */
11300 CLONE_PARAMS clone_params;
11301 CLONE_PARAMS* param = &clone_params;
11302 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11303 /* for each stash, determine whether its objects should be cloned */
11304 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11305 PERL_SET_THX(my_perl);
11308 Poison(my_perl, 1, PerlInterpreter);
11310 PL_curcop = (COP *)Nullop;
11314 PL_savestack_ix = 0;
11315 PL_savestack_max = -1;
11316 PL_sig_pending = 0;
11317 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11318 # else /* !DEBUGGING */
11319 Zero(my_perl, 1, PerlInterpreter);
11320 # endif /* DEBUGGING */
11321 #endif /* PERL_IMPLICIT_SYS */
11322 param->flags = flags;
11323 param->proto_perl = proto_perl;
11326 PL_xnv_arenaroot = NULL;
11327 PL_xnv_root = NULL;
11328 PL_xpv_arenaroot = NULL;
11329 PL_xpv_root = NULL;
11330 PL_xpviv_arenaroot = NULL;
11331 PL_xpviv_root = NULL;
11332 PL_xpvnv_arenaroot = NULL;
11333 PL_xpvnv_root = NULL;
11334 PL_xpvcv_arenaroot = NULL;
11335 PL_xpvcv_root = NULL;
11336 PL_xpvav_arenaroot = NULL;
11337 PL_xpvav_root = NULL;
11338 PL_xpvhv_arenaroot = NULL;
11339 PL_xpvhv_root = NULL;
11340 PL_xpvmg_arenaroot = NULL;
11341 PL_xpvmg_root = NULL;
11342 PL_xpvgv_arenaroot = NULL;
11343 PL_xpvgv_root = NULL;
11344 PL_xpvlv_arenaroot = NULL;
11345 PL_xpvlv_root = NULL;
11346 PL_xpvbm_arenaroot = NULL;
11347 PL_xpvbm_root = NULL;
11348 PL_he_arenaroot = NULL;
11350 #if defined(USE_ITHREADS)
11351 PL_pte_arenaroot = NULL;
11352 PL_pte_root = NULL;
11354 PL_nice_chunk = NULL;
11355 PL_nice_chunk_size = 0;
11357 PL_sv_objcount = 0;
11358 PL_sv_root = Nullsv;
11359 PL_sv_arenaroot = Nullsv;
11361 PL_debug = proto_perl->Idebug;
11363 PL_hash_seed = proto_perl->Ihash_seed;
11364 PL_rehash_seed = proto_perl->Irehash_seed;
11366 #ifdef USE_REENTRANT_API
11367 /* XXX: things like -Dm will segfault here in perlio, but doing
11368 * PERL_SET_CONTEXT(proto_perl);
11369 * breaks too many other things
11371 Perl_reentrant_init(aTHX);
11374 /* create SV map for pointer relocation */
11375 PL_ptr_table = ptr_table_new();
11377 /* initialize these special pointers as early as possible */
11378 SvANY(&PL_sv_undef) = NULL;
11379 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11380 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11381 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11383 SvANY(&PL_sv_no) = new_XPVNV();
11384 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11385 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11386 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11387 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11388 SvCUR_set(&PL_sv_no, 0);
11389 SvLEN_set(&PL_sv_no, 1);
11390 SvIV_set(&PL_sv_no, 0);
11391 SvNV_set(&PL_sv_no, 0);
11392 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11394 SvANY(&PL_sv_yes) = new_XPVNV();
11395 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11396 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11397 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11398 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11399 SvCUR_set(&PL_sv_yes, 1);
11400 SvLEN_set(&PL_sv_yes, 2);
11401 SvIV_set(&PL_sv_yes, 1);
11402 SvNV_set(&PL_sv_yes, 1);
11403 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11405 /* create (a non-shared!) shared string table */
11406 PL_strtab = newHV();
11407 HvSHAREKEYS_off(PL_strtab);
11408 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11409 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11411 PL_compiling = proto_perl->Icompiling;
11413 /* These two PVs will be free'd special way so must set them same way op.c does */
11414 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11415 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11417 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11418 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11420 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11421 if (!specialWARN(PL_compiling.cop_warnings))
11422 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11423 if (!specialCopIO(PL_compiling.cop_io))
11424 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11425 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11427 /* pseudo environmental stuff */
11428 PL_origargc = proto_perl->Iorigargc;
11429 PL_origargv = proto_perl->Iorigargv;
11431 param->stashes = newAV(); /* Setup array of objects to call clone on */
11433 #ifdef PERLIO_LAYERS
11434 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11435 PerlIO_clone(aTHX_ proto_perl, param);
11438 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11439 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11440 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11441 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11442 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11443 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11446 PL_minus_c = proto_perl->Iminus_c;
11447 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11448 PL_localpatches = proto_perl->Ilocalpatches;
11449 PL_splitstr = proto_perl->Isplitstr;
11450 PL_preprocess = proto_perl->Ipreprocess;
11451 PL_minus_n = proto_perl->Iminus_n;
11452 PL_minus_p = proto_perl->Iminus_p;
11453 PL_minus_l = proto_perl->Iminus_l;
11454 PL_minus_a = proto_perl->Iminus_a;
11455 PL_minus_F = proto_perl->Iminus_F;
11456 PL_doswitches = proto_perl->Idoswitches;
11457 PL_dowarn = proto_perl->Idowarn;
11458 PL_doextract = proto_perl->Idoextract;
11459 PL_sawampersand = proto_perl->Isawampersand;
11460 PL_unsafe = proto_perl->Iunsafe;
11461 PL_inplace = SAVEPV(proto_perl->Iinplace);
11462 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11463 PL_perldb = proto_perl->Iperldb;
11464 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11465 PL_exit_flags = proto_perl->Iexit_flags;
11467 /* magical thingies */
11468 /* XXX time(&PL_basetime) when asked for? */
11469 PL_basetime = proto_perl->Ibasetime;
11470 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11472 PL_maxsysfd = proto_perl->Imaxsysfd;
11473 PL_multiline = proto_perl->Imultiline;
11474 PL_statusvalue = proto_perl->Istatusvalue;
11476 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11478 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11480 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11481 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11482 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11484 /* Clone the regex array */
11485 PL_regex_padav = newAV();
11487 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11488 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11490 av_push(PL_regex_padav,
11491 sv_dup_inc(regexen[0],param));
11492 for(i = 1; i <= len; i++) {
11493 if(SvREPADTMP(regexen[i])) {
11494 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11496 av_push(PL_regex_padav,
11498 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11499 SvIVX(regexen[i])), param)))
11504 PL_regex_pad = AvARRAY(PL_regex_padav);
11506 /* shortcuts to various I/O objects */
11507 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11508 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11509 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11510 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11511 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11512 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11514 /* shortcuts to regexp stuff */
11515 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11517 /* shortcuts to misc objects */
11518 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11520 /* shortcuts to debugging objects */
11521 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11522 PL_DBline = gv_dup(proto_perl->IDBline, param);
11523 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11524 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11525 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11526 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11527 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11528 PL_lineary = av_dup(proto_perl->Ilineary, param);
11529 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11531 /* symbol tables */
11532 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11533 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11534 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11535 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11536 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11538 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11539 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11540 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11541 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11542 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11543 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11545 PL_sub_generation = proto_perl->Isub_generation;
11547 /* funky return mechanisms */
11548 PL_forkprocess = proto_perl->Iforkprocess;
11550 /* subprocess state */
11551 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11553 /* internal state */
11554 PL_tainting = proto_perl->Itainting;
11555 PL_taint_warn = proto_perl->Itaint_warn;
11556 PL_maxo = proto_perl->Imaxo;
11557 if (proto_perl->Iop_mask)
11558 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11560 PL_op_mask = Nullch;
11561 /* PL_asserting = proto_perl->Iasserting; */
11563 /* current interpreter roots */
11564 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11565 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11566 PL_main_start = proto_perl->Imain_start;
11567 PL_eval_root = proto_perl->Ieval_root;
11568 PL_eval_start = proto_perl->Ieval_start;
11570 /* runtime control stuff */
11571 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11572 PL_copline = proto_perl->Icopline;
11574 PL_filemode = proto_perl->Ifilemode;
11575 PL_lastfd = proto_perl->Ilastfd;
11576 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11579 PL_gensym = proto_perl->Igensym;
11580 PL_preambled = proto_perl->Ipreambled;
11581 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11582 PL_laststatval = proto_perl->Ilaststatval;
11583 PL_laststype = proto_perl->Ilaststype;
11584 PL_mess_sv = Nullsv;
11586 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11588 /* interpreter atexit processing */
11589 PL_exitlistlen = proto_perl->Iexitlistlen;
11590 if (PL_exitlistlen) {
11591 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11592 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11595 PL_exitlist = (PerlExitListEntry*)NULL;
11596 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11597 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11598 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11600 PL_profiledata = NULL;
11601 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11602 /* PL_rsfp_filters entries have fake IoDIRP() */
11603 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11605 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11607 PAD_CLONE_VARS(proto_perl, param);
11609 #ifdef HAVE_INTERP_INTERN
11610 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11613 /* more statics moved here */
11614 PL_generation = proto_perl->Igeneration;
11615 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11617 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11618 PL_in_clean_all = proto_perl->Iin_clean_all;
11620 PL_uid = proto_perl->Iuid;
11621 PL_euid = proto_perl->Ieuid;
11622 PL_gid = proto_perl->Igid;
11623 PL_egid = proto_perl->Iegid;
11624 PL_nomemok = proto_perl->Inomemok;
11625 PL_an = proto_perl->Ian;
11626 PL_evalseq = proto_perl->Ievalseq;
11627 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11628 PL_origalen = proto_perl->Iorigalen;
11629 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11630 PL_osname = SAVEPV(proto_perl->Iosname);
11631 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11632 PL_sighandlerp = proto_perl->Isighandlerp;
11635 PL_runops = proto_perl->Irunops;
11637 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11640 PL_cshlen = proto_perl->Icshlen;
11641 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11644 PL_lex_state = proto_perl->Ilex_state;
11645 PL_lex_defer = proto_perl->Ilex_defer;
11646 PL_lex_expect = proto_perl->Ilex_expect;
11647 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11648 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11649 PL_lex_starts = proto_perl->Ilex_starts;
11650 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11651 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11652 PL_lex_op = proto_perl->Ilex_op;
11653 PL_lex_inpat = proto_perl->Ilex_inpat;
11654 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11655 PL_lex_brackets = proto_perl->Ilex_brackets;
11656 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11657 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11658 PL_lex_casemods = proto_perl->Ilex_casemods;
11659 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11660 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11662 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11663 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11664 PL_nexttoke = proto_perl->Inexttoke;
11666 /* XXX This is probably masking the deeper issue of why
11667 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11668 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11669 * (A little debugging with a watchpoint on it may help.)
11671 if (SvANY(proto_perl->Ilinestr)) {
11672 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11673 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11674 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11675 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11676 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11677 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11678 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11679 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11680 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11683 PL_linestr = NEWSV(65,79);
11684 sv_upgrade(PL_linestr,SVt_PVIV);
11685 sv_setpvn(PL_linestr,"",0);
11686 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11688 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11689 PL_pending_ident = proto_perl->Ipending_ident;
11690 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11692 PL_expect = proto_perl->Iexpect;
11694 PL_multi_start = proto_perl->Imulti_start;
11695 PL_multi_end = proto_perl->Imulti_end;
11696 PL_multi_open = proto_perl->Imulti_open;
11697 PL_multi_close = proto_perl->Imulti_close;
11699 PL_error_count = proto_perl->Ierror_count;
11700 PL_subline = proto_perl->Isubline;
11701 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11703 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11704 if (SvANY(proto_perl->Ilinestr)) {
11705 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11706 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11707 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11708 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11709 PL_last_lop_op = proto_perl->Ilast_lop_op;
11712 PL_last_uni = SvPVX(PL_linestr);
11713 PL_last_lop = SvPVX(PL_linestr);
11714 PL_last_lop_op = 0;
11716 PL_in_my = proto_perl->Iin_my;
11717 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11719 PL_cryptseen = proto_perl->Icryptseen;
11722 PL_hints = proto_perl->Ihints;
11724 PL_amagic_generation = proto_perl->Iamagic_generation;
11726 #ifdef USE_LOCALE_COLLATE
11727 PL_collation_ix = proto_perl->Icollation_ix;
11728 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11729 PL_collation_standard = proto_perl->Icollation_standard;
11730 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11731 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11732 #endif /* USE_LOCALE_COLLATE */
11734 #ifdef USE_LOCALE_NUMERIC
11735 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11736 PL_numeric_standard = proto_perl->Inumeric_standard;
11737 PL_numeric_local = proto_perl->Inumeric_local;
11738 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11739 #endif /* !USE_LOCALE_NUMERIC */
11741 /* utf8 character classes */
11742 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11743 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11744 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11745 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11746 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11747 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11748 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11749 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11750 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11751 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11752 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11753 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11754 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11755 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11756 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11757 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11758 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11759 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11760 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11761 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11763 /* Did the locale setup indicate UTF-8? */
11764 PL_utf8locale = proto_perl->Iutf8locale;
11765 /* Unicode features (see perlrun/-C) */
11766 PL_unicode = proto_perl->Iunicode;
11768 /* Pre-5.8 signals control */
11769 PL_signals = proto_perl->Isignals;
11771 /* times() ticks per second */
11772 PL_clocktick = proto_perl->Iclocktick;
11774 /* Recursion stopper for PerlIO_find_layer */
11775 PL_in_load_module = proto_perl->Iin_load_module;
11777 /* sort() routine */
11778 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11780 /* Not really needed/useful since the reenrant_retint is "volatile",
11781 * but do it for consistency's sake. */
11782 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11784 /* Hooks to shared SVs and locks. */
11785 PL_sharehook = proto_perl->Isharehook;
11786 PL_lockhook = proto_perl->Ilockhook;
11787 PL_unlockhook = proto_perl->Iunlockhook;
11788 PL_threadhook = proto_perl->Ithreadhook;
11790 PL_runops_std = proto_perl->Irunops_std;
11791 PL_runops_dbg = proto_perl->Irunops_dbg;
11793 #ifdef THREADS_HAVE_PIDS
11794 PL_ppid = proto_perl->Ippid;
11798 PL_last_swash_hv = Nullhv; /* reinits on demand */
11799 PL_last_swash_klen = 0;
11800 PL_last_swash_key[0]= '\0';
11801 PL_last_swash_tmps = (U8*)NULL;
11802 PL_last_swash_slen = 0;
11804 PL_glob_index = proto_perl->Iglob_index;
11805 PL_srand_called = proto_perl->Isrand_called;
11806 PL_uudmap['M'] = 0; /* reinits on demand */
11807 PL_bitcount = Nullch; /* reinits on demand */
11809 if (proto_perl->Ipsig_pend) {
11810 Newz(0, PL_psig_pend, SIG_SIZE, int);
11813 PL_psig_pend = (int*)NULL;
11816 if (proto_perl->Ipsig_ptr) {
11817 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11818 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11819 for (i = 1; i < SIG_SIZE; i++) {
11820 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11821 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11825 PL_psig_ptr = (SV**)NULL;
11826 PL_psig_name = (SV**)NULL;
11829 /* thrdvar.h stuff */
11831 if (flags & CLONEf_COPY_STACKS) {
11832 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11833 PL_tmps_ix = proto_perl->Ttmps_ix;
11834 PL_tmps_max = proto_perl->Ttmps_max;
11835 PL_tmps_floor = proto_perl->Ttmps_floor;
11836 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11838 while (i <= PL_tmps_ix) {
11839 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11843 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11844 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11845 Newz(54, PL_markstack, i, I32);
11846 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11847 - proto_perl->Tmarkstack);
11848 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11849 - proto_perl->Tmarkstack);
11850 Copy(proto_perl->Tmarkstack, PL_markstack,
11851 PL_markstack_ptr - PL_markstack + 1, I32);
11853 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11854 * NOTE: unlike the others! */
11855 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11856 PL_scopestack_max = proto_perl->Tscopestack_max;
11857 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11858 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11860 /* NOTE: si_dup() looks at PL_markstack */
11861 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11863 /* PL_curstack = PL_curstackinfo->si_stack; */
11864 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11865 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11867 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11868 PL_stack_base = AvARRAY(PL_curstack);
11869 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11870 - proto_perl->Tstack_base);
11871 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11873 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11874 * NOTE: unlike the others! */
11875 PL_savestack_ix = proto_perl->Tsavestack_ix;
11876 PL_savestack_max = proto_perl->Tsavestack_max;
11877 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11878 PL_savestack = ss_dup(proto_perl, param);
11882 ENTER; /* perl_destruct() wants to LEAVE; */
11885 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11886 PL_top_env = &PL_start_env;
11888 PL_op = proto_perl->Top;
11891 PL_Xpv = (XPV*)NULL;
11892 PL_na = proto_perl->Tna;
11894 PL_statbuf = proto_perl->Tstatbuf;
11895 PL_statcache = proto_perl->Tstatcache;
11896 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11897 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11899 PL_timesbuf = proto_perl->Ttimesbuf;
11902 PL_tainted = proto_perl->Ttainted;
11903 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11904 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11905 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11906 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11907 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11908 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11909 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11910 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11911 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11913 PL_restartop = proto_perl->Trestartop;
11914 PL_in_eval = proto_perl->Tin_eval;
11915 PL_delaymagic = proto_perl->Tdelaymagic;
11916 PL_dirty = proto_perl->Tdirty;
11917 PL_localizing = proto_perl->Tlocalizing;
11919 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11920 PL_hv_fetch_ent_mh = Nullhe;
11921 PL_modcount = proto_perl->Tmodcount;
11922 PL_lastgotoprobe = Nullop;
11923 PL_dumpindent = proto_perl->Tdumpindent;
11925 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11926 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11927 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11928 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11929 PL_sortcxix = proto_perl->Tsortcxix;
11930 PL_efloatbuf = Nullch; /* reinits on demand */
11931 PL_efloatsize = 0; /* reinits on demand */
11935 PL_screamfirst = NULL;
11936 PL_screamnext = NULL;
11937 PL_maxscream = -1; /* reinits on demand */
11938 PL_lastscream = Nullsv;
11940 PL_watchaddr = NULL;
11941 PL_watchok = Nullch;
11943 PL_regdummy = proto_perl->Tregdummy;
11944 PL_regprecomp = Nullch;
11947 PL_colorset = 0; /* reinits PL_colors[] */
11948 /*PL_colors[6] = {0,0,0,0,0,0};*/
11949 PL_reginput = Nullch;
11950 PL_regbol = Nullch;
11951 PL_regeol = Nullch;
11952 PL_regstartp = (I32*)NULL;
11953 PL_regendp = (I32*)NULL;
11954 PL_reglastparen = (U32*)NULL;
11955 PL_reglastcloseparen = (U32*)NULL;
11956 PL_regtill = Nullch;
11957 PL_reg_start_tmp = (char**)NULL;
11958 PL_reg_start_tmpl = 0;
11959 PL_regdata = (struct reg_data*)NULL;
11962 PL_reg_eval_set = 0;
11964 PL_regprogram = (regnode*)NULL;
11966 PL_regcc = (CURCUR*)NULL;
11967 PL_reg_call_cc = (struct re_cc_state*)NULL;
11968 PL_reg_re = (regexp*)NULL;
11969 PL_reg_ganch = Nullch;
11970 PL_reg_sv = Nullsv;
11971 PL_reg_match_utf8 = FALSE;
11972 PL_reg_magic = (MAGIC*)NULL;
11974 PL_reg_oldcurpm = (PMOP*)NULL;
11975 PL_reg_curpm = (PMOP*)NULL;
11976 PL_reg_oldsaved = Nullch;
11977 PL_reg_oldsavedlen = 0;
11978 #ifdef PERL_OLD_COPY_ON_WRITE
11981 PL_reg_maxiter = 0;
11982 PL_reg_leftiter = 0;
11983 PL_reg_poscache = Nullch;
11984 PL_reg_poscache_size= 0;
11986 /* RE engine - function pointers */
11987 PL_regcompp = proto_perl->Tregcompp;
11988 PL_regexecp = proto_perl->Tregexecp;
11989 PL_regint_start = proto_perl->Tregint_start;
11990 PL_regint_string = proto_perl->Tregint_string;
11991 PL_regfree = proto_perl->Tregfree;
11993 PL_reginterp_cnt = 0;
11994 PL_reg_starttry = 0;
11996 /* Pluggable optimizer */
11997 PL_peepp = proto_perl->Tpeepp;
11999 PL_stashcache = newHV();
12001 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12002 ptr_table_free(PL_ptr_table);
12003 PL_ptr_table = NULL;
12006 /* Call the ->CLONE method, if it exists, for each of the stashes
12007 identified by sv_dup() above.
12009 while(av_len(param->stashes) != -1) {
12010 HV* stash = (HV*) av_shift(param->stashes);
12011 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12012 if (cloner && GvCV(cloner)) {
12017 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12019 call_sv((SV*)GvCV(cloner), G_DISCARD);
12025 SvREFCNT_dec(param->stashes);
12027 /* orphaned? eg threads->new inside BEGIN or use */
12028 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12029 (void)SvREFCNT_inc(PL_compcv);
12030 SAVEFREESV(PL_compcv);
12036 #endif /* USE_ITHREADS */
12039 =head1 Unicode Support
12041 =for apidoc sv_recode_to_utf8
12043 The encoding is assumed to be an Encode object, on entry the PV
12044 of the sv is assumed to be octets in that encoding, and the sv
12045 will be converted into Unicode (and UTF-8).
12047 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12048 is not a reference, nothing is done to the sv. If the encoding is not
12049 an C<Encode::XS> Encoding object, bad things will happen.
12050 (See F<lib/encoding.pm> and L<Encode>).
12052 The PV of the sv is returned.
12057 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12060 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12074 Passing sv_yes is wrong - it needs to be or'ed set of constants
12075 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12076 remove converted chars from source.
12078 Both will default the value - let them.
12080 XPUSHs(&PL_sv_yes);
12083 call_method("decode", G_SCALAR);
12087 s = SvPV_const(uni, len);
12088 if (s != SvPVX_const(sv)) {
12089 SvGROW(sv, len + 1);
12090 Move(s, SvPVX(sv), len + 1, char);
12091 SvCUR_set(sv, len);
12098 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12102 =for apidoc sv_cat_decode
12104 The encoding is assumed to be an Encode object, the PV of the ssv is
12105 assumed to be octets in that encoding and decoding the input starts
12106 from the position which (PV + *offset) pointed to. The dsv will be
12107 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12108 when the string tstr appears in decoding output or the input ends on
12109 the PV of the ssv. The value which the offset points will be modified
12110 to the last input position on the ssv.
12112 Returns TRUE if the terminator was found, else returns FALSE.
12117 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12118 SV *ssv, int *offset, char *tstr, int tlen)
12122 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12133 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12134 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12136 call_method("cat_decode", G_SCALAR);
12138 ret = SvTRUE(TOPs);
12139 *offset = SvIV(offsv);
12145 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12151 * c-indentation-style: bsd
12152 * c-basic-offset: 4
12153 * indent-tabs-mode: t
12156 * ex: set ts=8 sts=4 sw=4 noet: