3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
289 const SV * const sv = sva + 1;
290 const SV * const svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register const SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =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)
678 SV * const name = sv_newmortal();
681 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
682 * XXX get rid of all this if gv_fullnameX() ever supports this
686 HV * const hv = GvSTASH(gv);
687 sv_setpv(name, gvtype);
690 else if (!(p=HvNAME_get(hv)))
692 if (strNE(p, "main")) {
694 sv_catpvn(name,"::", 2);
696 if (GvNAMELEN(gv)>= 1 &&
697 ((unsigned int)*GvNAME(gv)) <= 26)
699 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
700 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
703 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
707 CV * const cv = find_runcv(&unused);
711 if (!cv || !CvPADLIST(cv))
713 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
714 sv = *av_fetch(av, targ, FALSE);
715 /* SvLEN in a pad name is not to be trusted */
716 sv_setpv(name, SvPV_nolen_const(sv));
719 if (subscript_type == FUV_SUBSCRIPT_HASH) {
723 Perl_sv_catpvf(aTHX_ name, "{%s}",
724 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
727 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
729 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
731 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
732 sv_insert(name, 0, 0, "within ", 7);
739 =for apidoc find_uninit_var
741 Find the name of the undefined variable (if any) that caused the operator o
742 to issue a "Use of uninitialized value" warning.
743 If match is true, only return a name if it's value matches uninit_sv.
744 So roughly speaking, if a unary operator (such as OP_COS) generates a
745 warning, then following the direct child of the op may yield an
746 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
747 other hand, with OP_ADD there are two branches to follow, so we only print
748 the variable name if we get an exact match.
750 The name is returned as a mortal SV.
752 Assumes that PL_op is the op that originally triggered the error, and that
753 PL_comppad/PL_curpad points to the currently executing pad.
759 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
768 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
769 uninit_sv == &PL_sv_placeholder)))
772 switch (obase->op_type) {
779 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
780 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
783 int subscript_type = FUV_SUBSCRIPT_WITHIN;
785 if (pad) { /* @lex, %lex */
786 sv = PAD_SVl(obase->op_targ);
790 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
791 /* @global, %global */
792 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
795 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
797 else /* @{expr}, %{expr} */
798 return find_uninit_var(cUNOPx(obase)->op_first,
802 /* attempt to find a match within the aggregate */
804 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
806 subscript_type = FUV_SUBSCRIPT_HASH;
809 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
811 subscript_type = FUV_SUBSCRIPT_ARRAY;
814 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
817 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
818 keysv, index, subscript_type);
822 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
824 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
825 Nullsv, 0, FUV_SUBSCRIPT_NONE);
828 gv = cGVOPx_gv(obase);
829 if (!gv || (match && GvSV(gv) != uninit_sv))
831 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
834 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
836 av = (AV*)PAD_SV(obase->op_targ);
837 if (!av || SvRMAGICAL(av))
839 svp = av_fetch(av, (I32)obase->op_private, FALSE);
840 if (!svp || *svp != uninit_sv)
843 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
844 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
847 gv = cGVOPx_gv(obase);
852 if (!av || SvRMAGICAL(av))
854 svp = av_fetch(av, (I32)obase->op_private, FALSE);
855 if (!svp || *svp != uninit_sv)
858 return S_varname(aTHX_ gv, "$", 0,
859 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
864 o = cUNOPx(obase)->op_first;
865 if (!o || o->op_type != OP_NULL ||
866 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
868 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
873 /* $a[uninit_expr] or $h{uninit_expr} */
874 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
877 o = cBINOPx(obase)->op_first;
878 kid = cBINOPx(obase)->op_last;
880 /* get the av or hv, and optionally the gv */
882 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
883 sv = PAD_SV(o->op_targ);
885 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
886 && cUNOPo->op_first->op_type == OP_GV)
888 gv = cGVOPx_gv(cUNOPo->op_first);
891 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
896 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
897 /* index is constant */
901 if (obase->op_type == OP_HELEM) {
902 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
903 if (!he || HeVAL(he) != uninit_sv)
907 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
908 if (!svp || *svp != uninit_sv)
912 if (obase->op_type == OP_HELEM)
913 return S_varname(aTHX_ gv, "%", o->op_targ,
914 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
916 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
917 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
921 /* index is an expression;
922 * attempt to find a match within the aggregate */
923 if (obase->op_type == OP_HELEM) {
924 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
926 return S_varname(aTHX_ gv, "%", o->op_targ,
927 keysv, 0, FUV_SUBSCRIPT_HASH);
930 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
932 return S_varname(aTHX_ gv, "@", o->op_targ,
933 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
937 return S_varname(aTHX_ gv,
938 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
940 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
946 /* only examine RHS */
947 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
950 o = cUNOPx(obase)->op_first;
951 if (o->op_type == OP_PUSHMARK)
954 if (!o->op_sibling) {
955 /* one-arg version of open is highly magical */
957 if (o->op_type == OP_GV) { /* open FOO; */
959 if (match && GvSV(gv) != uninit_sv)
961 return S_varname(aTHX_ gv, "$", 0,
962 Nullsv, 0, FUV_SUBSCRIPT_NONE);
964 /* other possibilities not handled are:
965 * open $x; or open my $x; should return '${*$x}'
966 * open expr; should return '$'.expr ideally
972 /* ops where $_ may be an implicit arg */
976 if ( !(obase->op_flags & OPf_STACKED)) {
977 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
978 ? PAD_SVl(obase->op_targ)
982 sv_setpvn(sv, "$_", 2);
990 /* skip filehandle as it can't produce 'undef' warning */
991 o = cUNOPx(obase)->op_first;
992 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
993 o = o->op_sibling->op_sibling;
1000 match = 1; /* XS or custom code could trigger random warnings */
1005 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1006 return sv_2mortal(newSVpv("${$/}", 0));
1011 if (!(obase->op_flags & OPf_KIDS))
1013 o = cUNOPx(obase)->op_first;
1019 /* if all except one arg are constant, or have no side-effects,
1020 * or are optimized away, then it's unambiguous */
1022 for (kid=o; kid; kid = kid->op_sibling) {
1024 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1025 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1026 || (kid->op_type == OP_PUSHMARK)
1030 if (o2) { /* more than one found */
1037 return find_uninit_var(o2, uninit_sv, match);
1041 sv = find_uninit_var(o, uninit_sv, 1);
1053 =for apidoc report_uninit
1055 Print appropriate "Use of uninitialized variable" warning
1061 Perl_report_uninit(pTHX_ SV* uninit_sv)
1064 SV* varname = Nullsv;
1066 varname = find_uninit_var(PL_op, uninit_sv,0);
1068 sv_insert(varname, 0, 0, " ", 1);
1070 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1071 varname ? SvPV_nolen_const(varname) : "",
1072 " in ", OP_DESC(PL_op));
1075 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1080 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1084 const size_t count = PERL_ARENA_SIZE/size;
1085 New(0, start, count*size, char);
1086 *((void **) start) = *arena_root;
1087 *arena_root = (void *)start;
1089 end = start + (count-1) * size;
1091 /* The initial slot is used to link the arenas together, so it isn't to be
1092 linked into the list of ready-to-use bodies. */
1096 *root = (void *)start;
1098 while (start < end) {
1099 char * const next = start + size;
1100 *(void**) start = (void *)next;
1103 *(void **)start = 0;
1108 /* grab a new thing from the free list, allocating more if necessary */
1111 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1115 xpv = *root ? *root : S_more_bodies(aTHX_ arena_root, root, size);
1116 *root = *(void**)xpv;
1121 /* return a thing to the free list */
1123 #define del_body(thing, root) \
1126 *(void **)thing = *root; \
1127 *root = (void*)thing; \
1131 /* Conventionally we simply malloc() a big block of memory, then divide it
1132 up into lots of the thing that we're allocating.
1134 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1137 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1138 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1141 #define new_body(TYPE,lctype) \
1142 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1143 (void**)&PL_ ## lctype ## _root, \
1146 #define del_body_type(p,TYPE,lctype) \
1147 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1149 /* But for some types, we cheat. The type starts with some members that are
1150 never accessed. So we allocate the substructure, starting at the first used
1151 member, then adjust the pointer back in memory by the size of the bit not
1152 allocated, so it's as if we allocated the full structure.
1153 (But things will all go boom if you write to the part that is "not there",
1154 because you'll be overwriting the last members of the preceding structure
1157 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1158 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1159 and the pointer is unchanged. If the allocated structure is smaller (no
1160 initial NV actually allocated) then the net effect is to subtract the size
1161 of the NV from the pointer, to return a new pointer as if an initial NV were
1164 This is the same trick as was used for NV and IV bodies. Ironically it
1165 doesn't need to be used for NV bodies any more, because NV is now at the
1166 start of the structure. IV bodies don't need it either, because they are
1167 no longer allocated. */
1169 #define new_body_allocated(TYPE,lctype,member) \
1170 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1171 (void**)&PL_ ## lctype ## _root, \
1172 sizeof(lctype ## _allocated)) - \
1173 STRUCT_OFFSET(TYPE, member) \
1174 + STRUCT_OFFSET(lctype ## _allocated, member))
1177 #define del_body_allocated(p,TYPE,lctype,member) \
1178 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1179 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1180 (void**)&PL_ ## lctype ## _root)
1182 #define my_safemalloc(s) (void*)safemalloc(s)
1183 #define my_safefree(p) safefree((char*)p)
1187 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1188 #define del_XNV(p) my_safefree(p)
1190 #define new_XPV() my_safemalloc(sizeof(XPV))
1191 #define del_XPV(p) my_safefree(p)
1193 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1194 #define del_XPVIV(p) my_safefree(p)
1196 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1197 #define del_XPVNV(p) my_safefree(p)
1199 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1200 #define del_XPVCV(p) my_safefree(p)
1202 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1203 #define del_XPVAV(p) my_safefree(p)
1205 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1206 #define del_XPVHV(p) my_safefree(p)
1208 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1209 #define del_XPVMG(p) my_safefree(p)
1211 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1212 #define del_XPVGV(p) my_safefree(p)
1214 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1215 #define del_XPVLV(p) my_safefree(p)
1217 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1218 #define del_XPVBM(p) my_safefree(p)
1222 #define new_XNV() new_body(NV, xnv)
1223 #define del_XNV(p) del_body_type(p, NV, xnv)
1225 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1226 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1228 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1229 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1231 #define new_XPVNV() new_body(XPVNV, xpvnv)
1232 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1234 #define new_XPVCV() new_body(XPVCV, xpvcv)
1235 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1237 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1238 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1240 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1241 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1243 #define new_XPVMG() new_body(XPVMG, xpvmg)
1244 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1246 #define new_XPVGV() new_body(XPVGV, xpvgv)
1247 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1249 #define new_XPVLV() new_body(XPVLV, xpvlv)
1250 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1252 #define new_XPVBM() new_body(XPVBM, xpvbm)
1253 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1257 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1258 #define del_XPVFM(p) my_safefree(p)
1260 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1261 #define del_XPVIO(p) my_safefree(p)
1264 =for apidoc sv_upgrade
1266 Upgrade an SV to a more complex form. Generally adds a new body type to the
1267 SV, then copies across as much information as possible from the old body.
1268 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1274 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1276 void** old_body_arena;
1277 size_t old_body_offset;
1278 size_t old_body_length; /* Well, the length to copy. */
1280 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1281 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1283 bool zero_nv = TRUE;
1286 size_t new_body_length;
1287 size_t new_body_offset;
1288 void** new_body_arena;
1289 void** new_body_arenaroot;
1290 const U32 old_type = SvTYPE(sv);
1292 if (mt != SVt_PV && SvIsCOW(sv)) {
1293 sv_force_normal_flags(sv, 0);
1296 if (SvTYPE(sv) == mt)
1299 if (SvTYPE(sv) > mt)
1300 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1301 (int)SvTYPE(sv), (int)mt);
1304 old_body = SvANY(sv);
1306 old_body_offset = 0;
1307 old_body_length = 0;
1308 new_body_offset = 0;
1309 new_body_length = ~0;
1311 /* Copying structures onto other structures that have been neatly zeroed
1312 has a subtle gotcha. Consider XPVMG
1314 +------+------+------+------+------+-------+-------+
1315 | NV | CUR | LEN | IV | MAGIC | STASH |
1316 +------+------+------+------+------+-------+-------+
1317 0 4 8 12 16 20 24 28
1319 where NVs are aligned to 8 bytes, so that sizeof that structure is
1320 actually 32 bytes long, with 4 bytes of padding at the end:
1322 +------+------+------+------+------+-------+-------+------+
1323 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1324 +------+------+------+------+------+-------+-------+------+
1325 0 4 8 12 16 20 24 28 32
1327 so what happens if you allocate memory for this structure:
1329 +------+------+------+------+------+-------+-------+------+------+...
1330 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1331 +------+------+------+------+------+-------+-------+------+------+...
1332 0 4 8 12 16 20 24 28 32 36
1334 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1335 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1336 started out as zero once, but it's quite possible that it isn't. So now,
1337 rather than a nicely zeroed GP, you have it pointing somewhere random.
1340 (In fact, GP ends up pointing at a previous GP structure, because the
1341 principle cause of the padding in XPVMG getting garbage is a copy of
1342 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1344 So we are careful and work out the size of used parts of all the
1347 switch (SvTYPE(sv)) {
1353 else if (mt < SVt_PVIV)
1355 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1356 old_body_length = sizeof(IV);
1359 old_body_arena = (void **) &PL_xnv_root;
1360 old_body_length = sizeof(NV);
1361 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1370 old_body_arena = (void **) &PL_xpv_root;
1371 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1372 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1373 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1374 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1378 else if (mt == SVt_NV)
1382 old_body_arena = (void **) &PL_xpviv_root;
1383 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1384 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1385 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1386 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1390 old_body_arena = (void **) &PL_xpvnv_root;
1391 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1392 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1393 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1398 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1399 there's no way that it can be safely upgraded, because perl.c
1400 expects to Safefree(SvANY(PL_mess_sv)) */
1401 assert(sv != PL_mess_sv);
1402 /* This flag bit is used to mean other things in other scalar types.
1403 Given that it only has meaning inside the pad, it shouldn't be set
1404 on anything that can get upgraded. */
1405 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1406 old_body_arena = (void **) &PL_xpvmg_root;
1407 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1408 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1409 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1414 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1417 SvFLAGS(sv) &= ~SVTYPEMASK;
1422 Perl_croak(aTHX_ "Can't upgrade to undef");
1424 assert(old_type == SVt_NULL);
1425 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1429 assert(old_type == SVt_NULL);
1430 SvANY(sv) = new_XNV();
1434 assert(old_type == SVt_NULL);
1435 SvANY(sv) = &sv->sv_u.svu_rv;
1439 SvANY(sv) = new_XPVHV();
1442 HvTOTALKEYS(sv) = 0;
1447 SvANY(sv) = new_XPVAV();
1454 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1455 The target created by newSVrv also is, and it can have magic.
1456 However, it never has SvPVX set.
1458 if (old_type >= SVt_RV) {
1459 assert(SvPVX_const(sv) == 0);
1462 /* Could put this in the else clause below, as PVMG must have SvPVX
1463 0 already (the assertion above) */
1464 SvPV_set(sv, (char*)0);
1466 if (old_type >= SVt_PVMG) {
1467 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1468 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1476 new_body = new_XPVIO();
1477 new_body_length = sizeof(XPVIO);
1480 new_body = new_XPVFM();
1481 new_body_length = sizeof(XPVFM);
1485 new_body_length = sizeof(XPVBM);
1486 new_body_arena = (void **) &PL_xpvbm_root;
1487 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1490 new_body_length = sizeof(XPVGV);
1491 new_body_arena = (void **) &PL_xpvgv_root;
1492 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1495 new_body_length = sizeof(XPVCV);
1496 new_body_arena = (void **) &PL_xpvcv_root;
1497 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1500 new_body_length = sizeof(XPVLV);
1501 new_body_arena = (void **) &PL_xpvlv_root;
1502 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1505 new_body_length = sizeof(XPVMG);
1506 new_body_arena = (void **) &PL_xpvmg_root;
1507 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1510 new_body_length = sizeof(XPVNV);
1511 new_body_arena = (void **) &PL_xpvnv_root;
1512 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1515 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1516 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1517 new_body_length = sizeof(XPVIV) - new_body_offset;
1518 new_body_arena = (void **) &PL_xpviv_root;
1519 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1520 /* XXX Is this still needed? Was it ever needed? Surely as there is
1521 no route from NV to PVIV, NOK can never be true */
1525 goto new_body_no_NV;
1527 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1528 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1529 new_body_length = sizeof(XPV) - new_body_offset;
1530 new_body_arena = (void **) &PL_xpv_root;
1531 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1533 /* PV and PVIV don't have an NV slot. */
1534 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1539 assert(new_body_length);
1541 /* This points to the start of the allocated area. */
1542 new_body = S_new_body(aTHX_ new_body_arenaroot, new_body_arena,
1545 /* We always allocated the full length item with PURIFY */
1546 new_body_length += new_body_offset;
1547 new_body_offset = 0;
1548 new_body = my_safemalloc(new_body_length);
1552 Zero(new_body, new_body_length, char);
1553 new_body = ((char *)new_body) - new_body_offset;
1554 SvANY(sv) = new_body;
1556 if (old_body_length) {
1557 Copy((char *)old_body + old_body_offset,
1558 (char *)new_body + old_body_offset,
1559 old_body_length, char);
1562 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1568 IoPAGE_LEN(sv) = 60;
1569 if (old_type < SVt_RV)
1573 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1577 if (old_body_arena) {
1579 my_safefree(old_body);
1581 del_body((void*)((char*)old_body + old_body_offset),
1588 =for apidoc sv_backoff
1590 Remove any string offset. You should normally use the C<SvOOK_off> macro
1597 Perl_sv_backoff(pTHX_ register SV *sv)
1600 assert(SvTYPE(sv) != SVt_PVHV);
1601 assert(SvTYPE(sv) != SVt_PVAV);
1603 const char * const s = SvPVX_const(sv);
1604 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1605 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1607 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1609 SvFLAGS(sv) &= ~SVf_OOK;
1616 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1617 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1618 Use the C<SvGROW> wrapper instead.
1624 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1628 #ifdef HAS_64K_LIMIT
1629 if (newlen >= 0x10000) {
1630 PerlIO_printf(Perl_debug_log,
1631 "Allocation too large: %"UVxf"\n", (UV)newlen);
1634 #endif /* HAS_64K_LIMIT */
1637 if (SvTYPE(sv) < SVt_PV) {
1638 sv_upgrade(sv, SVt_PV);
1639 s = SvPVX_mutable(sv);
1641 else if (SvOOK(sv)) { /* pv is offset? */
1643 s = SvPVX_mutable(sv);
1644 if (newlen > SvLEN(sv))
1645 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1646 #ifdef HAS_64K_LIMIT
1647 if (newlen >= 0x10000)
1652 s = SvPVX_mutable(sv);
1654 if (newlen > SvLEN(sv)) { /* need more room? */
1655 newlen = PERL_STRLEN_ROUNDUP(newlen);
1656 if (SvLEN(sv) && s) {
1658 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1664 s = saferealloc(s, newlen);
1667 s = safemalloc(newlen);
1668 if (SvPVX_const(sv) && SvCUR(sv)) {
1669 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1673 SvLEN_set(sv, newlen);
1679 =for apidoc sv_setiv
1681 Copies an integer into the given SV, upgrading first if necessary.
1682 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1688 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1690 SV_CHECK_THINKFIRST_COW_DROP(sv);
1691 switch (SvTYPE(sv)) {
1693 sv_upgrade(sv, SVt_IV);
1696 sv_upgrade(sv, SVt_PVNV);
1700 sv_upgrade(sv, SVt_PVIV);
1709 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1712 (void)SvIOK_only(sv); /* validate number */
1718 =for apidoc sv_setiv_mg
1720 Like C<sv_setiv>, but also handles 'set' magic.
1726 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1733 =for apidoc sv_setuv
1735 Copies an unsigned integer into the given SV, upgrading first if necessary.
1736 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1742 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1744 /* With these two if statements:
1745 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1748 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1750 If you wish to remove them, please benchmark to see what the effect is
1752 if (u <= (UV)IV_MAX) {
1753 sv_setiv(sv, (IV)u);
1762 =for apidoc sv_setuv_mg
1764 Like C<sv_setuv>, but also handles 'set' magic.
1770 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1772 /* With these two if statements:
1773 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1776 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1778 If you wish to remove them, please benchmark to see what the effect is
1780 if (u <= (UV)IV_MAX) {
1781 sv_setiv(sv, (IV)u);
1791 =for apidoc sv_setnv
1793 Copies a double into the given SV, upgrading first if necessary.
1794 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1800 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1802 SV_CHECK_THINKFIRST_COW_DROP(sv);
1803 switch (SvTYPE(sv)) {
1806 sv_upgrade(sv, SVt_NV);
1811 sv_upgrade(sv, SVt_PVNV);
1820 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1824 (void)SvNOK_only(sv); /* validate number */
1829 =for apidoc sv_setnv_mg
1831 Like C<sv_setnv>, but also handles 'set' magic.
1837 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1843 /* Print an "isn't numeric" warning, using a cleaned-up,
1844 * printable version of the offending string
1848 S_not_a_number(pTHX_ SV *sv)
1855 dsv = sv_2mortal(newSVpv("", 0));
1856 pv = sv_uni_display(dsv, sv, 10, 0);
1859 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1860 /* each *s can expand to 4 chars + "...\0",
1861 i.e. need room for 8 chars */
1863 const char *s, *end;
1864 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1867 if (ch & 128 && !isPRINT_LC(ch)) {
1876 else if (ch == '\r') {
1880 else if (ch == '\f') {
1884 else if (ch == '\\') {
1888 else if (ch == '\0') {
1892 else if (isPRINT_LC(ch))
1909 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1910 "Argument \"%s\" isn't numeric in %s", pv,
1913 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1914 "Argument \"%s\" isn't numeric", pv);
1918 =for apidoc looks_like_number
1920 Test if the content of an SV looks like a number (or is a number).
1921 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1922 non-numeric warning), even if your atof() doesn't grok them.
1928 Perl_looks_like_number(pTHX_ SV *sv)
1930 register const char *sbegin;
1934 sbegin = SvPVX_const(sv);
1937 else if (SvPOKp(sv))
1938 sbegin = SvPV_const(sv, len);
1940 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1941 return grok_number(sbegin, len, NULL);
1944 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1945 until proven guilty, assume that things are not that bad... */
1950 As 64 bit platforms often have an NV that doesn't preserve all bits of
1951 an IV (an assumption perl has been based on to date) it becomes necessary
1952 to remove the assumption that the NV always carries enough precision to
1953 recreate the IV whenever needed, and that the NV is the canonical form.
1954 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1955 precision as a side effect of conversion (which would lead to insanity
1956 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1957 1) to distinguish between IV/UV/NV slots that have cached a valid
1958 conversion where precision was lost and IV/UV/NV slots that have a
1959 valid conversion which has lost no precision
1960 2) to ensure that if a numeric conversion to one form is requested that
1961 would lose precision, the precise conversion (or differently
1962 imprecise conversion) is also performed and cached, to prevent
1963 requests for different numeric formats on the same SV causing
1964 lossy conversion chains. (lossless conversion chains are perfectly
1969 SvIOKp is true if the IV slot contains a valid value
1970 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1971 SvNOKp is true if the NV slot contains a valid value
1972 SvNOK is true only if the NV value is accurate
1975 while converting from PV to NV, check to see if converting that NV to an
1976 IV(or UV) would lose accuracy over a direct conversion from PV to
1977 IV(or UV). If it would, cache both conversions, return NV, but mark
1978 SV as IOK NOKp (ie not NOK).
1980 While converting from PV to IV, check to see if converting that IV to an
1981 NV would lose accuracy over a direct conversion from PV to NV. If it
1982 would, cache both conversions, flag similarly.
1984 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1985 correctly because if IV & NV were set NV *always* overruled.
1986 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1987 changes - now IV and NV together means that the two are interchangeable:
1988 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1990 The benefit of this is that operations such as pp_add know that if
1991 SvIOK is true for both left and right operands, then integer addition
1992 can be used instead of floating point (for cases where the result won't
1993 overflow). Before, floating point was always used, which could lead to
1994 loss of precision compared with integer addition.
1996 * making IV and NV equal status should make maths accurate on 64 bit
1998 * may speed up maths somewhat if pp_add and friends start to use
1999 integers when possible instead of fp. (Hopefully the overhead in
2000 looking for SvIOK and checking for overflow will not outweigh the
2001 fp to integer speedup)
2002 * will slow down integer operations (callers of SvIV) on "inaccurate"
2003 values, as the change from SvIOK to SvIOKp will cause a call into
2004 sv_2iv each time rather than a macro access direct to the IV slot
2005 * should speed up number->string conversion on integers as IV is
2006 favoured when IV and NV are equally accurate
2008 ####################################################################
2009 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2010 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2011 On the other hand, SvUOK is true iff UV.
2012 ####################################################################
2014 Your mileage will vary depending your CPU's relative fp to integer
2018 #ifndef NV_PRESERVES_UV
2019 # define IS_NUMBER_UNDERFLOW_IV 1
2020 # define IS_NUMBER_UNDERFLOW_UV 2
2021 # define IS_NUMBER_IV_AND_UV 2
2022 # define IS_NUMBER_OVERFLOW_IV 4
2023 # define IS_NUMBER_OVERFLOW_UV 5
2025 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2027 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2029 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2031 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));
2032 if (SvNVX(sv) < (NV)IV_MIN) {
2033 (void)SvIOKp_on(sv);
2035 SvIV_set(sv, IV_MIN);
2036 return IS_NUMBER_UNDERFLOW_IV;
2038 if (SvNVX(sv) > (NV)UV_MAX) {
2039 (void)SvIOKp_on(sv);
2042 SvUV_set(sv, UV_MAX);
2043 return IS_NUMBER_OVERFLOW_UV;
2045 (void)SvIOKp_on(sv);
2047 /* Can't use strtol etc to convert this string. (See truth table in
2049 if (SvNVX(sv) <= (UV)IV_MAX) {
2050 SvIV_set(sv, I_V(SvNVX(sv)));
2051 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2052 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2054 /* Integer is imprecise. NOK, IOKp */
2056 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2059 SvUV_set(sv, U_V(SvNVX(sv)));
2060 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2061 if (SvUVX(sv) == UV_MAX) {
2062 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2063 possibly be preserved by NV. Hence, it must be overflow.
2065 return IS_NUMBER_OVERFLOW_UV;
2067 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2069 /* Integer is imprecise. NOK, IOKp */
2071 return IS_NUMBER_OVERFLOW_IV;
2073 #endif /* !NV_PRESERVES_UV*/
2075 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2076 * this function provided for binary compatibility only
2080 Perl_sv_2iv(pTHX_ register SV *sv)
2082 return sv_2iv_flags(sv, SV_GMAGIC);
2086 =for apidoc sv_2iv_flags
2088 Return the integer value of an SV, doing any necessary string
2089 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2090 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2096 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2100 if (SvGMAGICAL(sv)) {
2101 if (flags & SV_GMAGIC)
2106 return I_V(SvNVX(sv));
2108 if (SvPOKp(sv) && SvLEN(sv))
2111 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2112 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2118 if (SvTHINKFIRST(sv)) {
2121 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2122 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2123 return SvIV(tmpstr);
2124 return PTR2IV(SvRV(sv));
2127 sv_force_normal_flags(sv, 0);
2129 if (SvREADONLY(sv) && !SvOK(sv)) {
2130 if (ckWARN(WARN_UNINITIALIZED))
2137 return (IV)(SvUVX(sv));
2144 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2145 * without also getting a cached IV/UV from it at the same time
2146 * (ie PV->NV conversion should detect loss of accuracy and cache
2147 * IV or UV at same time to avoid this. NWC */
2149 if (SvTYPE(sv) == SVt_NV)
2150 sv_upgrade(sv, SVt_PVNV);
2152 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2153 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2154 certainly cast into the IV range at IV_MAX, whereas the correct
2155 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2157 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2158 SvIV_set(sv, I_V(SvNVX(sv)));
2159 if (SvNVX(sv) == (NV) SvIVX(sv)
2160 #ifndef NV_PRESERVES_UV
2161 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2162 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2163 /* Don't flag it as "accurately an integer" if the number
2164 came from a (by definition imprecise) NV operation, and
2165 we're outside the range of NV integer precision */
2168 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2169 DEBUG_c(PerlIO_printf(Perl_debug_log,
2170 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2176 /* IV not precise. No need to convert from PV, as NV
2177 conversion would already have cached IV if it detected
2178 that PV->IV would be better than PV->NV->IV
2179 flags already correct - don't set public IOK. */
2180 DEBUG_c(PerlIO_printf(Perl_debug_log,
2181 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2186 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2187 but the cast (NV)IV_MIN rounds to a the value less (more
2188 negative) than IV_MIN which happens to be equal to SvNVX ??
2189 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2190 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2191 (NV)UVX == NVX are both true, but the values differ. :-(
2192 Hopefully for 2s complement IV_MIN is something like
2193 0x8000000000000000 which will be exact. NWC */
2196 SvUV_set(sv, U_V(SvNVX(sv)));
2198 (SvNVX(sv) == (NV) SvUVX(sv))
2199 #ifndef NV_PRESERVES_UV
2200 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2201 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2202 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2203 /* Don't flag it as "accurately an integer" if the number
2204 came from a (by definition imprecise) NV operation, and
2205 we're outside the range of NV integer precision */
2211 DEBUG_c(PerlIO_printf(Perl_debug_log,
2212 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2216 return (IV)SvUVX(sv);
2219 else if (SvPOKp(sv) && SvLEN(sv)) {
2221 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2222 /* We want to avoid a possible problem when we cache an IV which
2223 may be later translated to an NV, and the resulting NV is not
2224 the same as the direct translation of the initial string
2225 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2226 be careful to ensure that the value with the .456 is around if the
2227 NV value is requested in the future).
2229 This means that if we cache such an IV, we need to cache the
2230 NV as well. Moreover, we trade speed for space, and do not
2231 cache the NV if we are sure it's not needed.
2234 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2235 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2236 == IS_NUMBER_IN_UV) {
2237 /* It's definitely an integer, only upgrade to PVIV */
2238 if (SvTYPE(sv) < SVt_PVIV)
2239 sv_upgrade(sv, SVt_PVIV);
2241 } else if (SvTYPE(sv) < SVt_PVNV)
2242 sv_upgrade(sv, SVt_PVNV);
2244 /* If NV preserves UV then we only use the UV value if we know that
2245 we aren't going to call atof() below. If NVs don't preserve UVs
2246 then the value returned may have more precision than atof() will
2247 return, even though value isn't perfectly accurate. */
2248 if ((numtype & (IS_NUMBER_IN_UV
2249 #ifdef NV_PRESERVES_UV
2252 )) == IS_NUMBER_IN_UV) {
2253 /* This won't turn off the public IOK flag if it was set above */
2254 (void)SvIOKp_on(sv);
2256 if (!(numtype & IS_NUMBER_NEG)) {
2258 if (value <= (UV)IV_MAX) {
2259 SvIV_set(sv, (IV)value);
2261 SvUV_set(sv, value);
2265 /* 2s complement assumption */
2266 if (value <= (UV)IV_MIN) {
2267 SvIV_set(sv, -(IV)value);
2269 /* Too negative for an IV. This is a double upgrade, but
2270 I'm assuming it will be rare. */
2271 if (SvTYPE(sv) < SVt_PVNV)
2272 sv_upgrade(sv, SVt_PVNV);
2276 SvNV_set(sv, -(NV)value);
2277 SvIV_set(sv, IV_MIN);
2281 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2282 will be in the previous block to set the IV slot, and the next
2283 block to set the NV slot. So no else here. */
2285 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2286 != IS_NUMBER_IN_UV) {
2287 /* It wasn't an (integer that doesn't overflow the UV). */
2288 SvNV_set(sv, Atof(SvPVX_const(sv)));
2290 if (! numtype && ckWARN(WARN_NUMERIC))
2293 #if defined(USE_LONG_DOUBLE)
2294 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2295 PTR2UV(sv), SvNVX(sv)));
2297 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2298 PTR2UV(sv), SvNVX(sv)));
2302 #ifdef NV_PRESERVES_UV
2303 (void)SvIOKp_on(sv);
2305 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2306 SvIV_set(sv, I_V(SvNVX(sv)));
2307 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2310 /* Integer is imprecise. NOK, IOKp */
2312 /* UV will not work better than IV */
2314 if (SvNVX(sv) > (NV)UV_MAX) {
2316 /* Integer is inaccurate. NOK, IOKp, is UV */
2317 SvUV_set(sv, UV_MAX);
2320 SvUV_set(sv, U_V(SvNVX(sv)));
2321 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2322 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2326 /* Integer is imprecise. NOK, IOKp, is UV */
2332 #else /* NV_PRESERVES_UV */
2333 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2334 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2335 /* The IV slot will have been set from value returned by
2336 grok_number above. The NV slot has just been set using
2339 assert (SvIOKp(sv));
2341 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2342 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2343 /* Small enough to preserve all bits. */
2344 (void)SvIOKp_on(sv);
2346 SvIV_set(sv, I_V(SvNVX(sv)));
2347 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2349 /* Assumption: first non-preserved integer is < IV_MAX,
2350 this NV is in the preserved range, therefore: */
2351 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2353 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);
2357 0 0 already failed to read UV.
2358 0 1 already failed to read UV.
2359 1 0 you won't get here in this case. IV/UV
2360 slot set, public IOK, Atof() unneeded.
2361 1 1 already read UV.
2362 so there's no point in sv_2iuv_non_preserve() attempting
2363 to use atol, strtol, strtoul etc. */
2364 if (sv_2iuv_non_preserve (sv, numtype)
2365 >= IS_NUMBER_OVERFLOW_IV)
2369 #endif /* NV_PRESERVES_UV */
2372 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2374 if (SvTYPE(sv) < SVt_IV)
2375 /* Typically the caller expects that sv_any is not NULL now. */
2376 sv_upgrade(sv, SVt_IV);
2379 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2380 PTR2UV(sv),SvIVX(sv)));
2381 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2384 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2385 * this function provided for binary compatibility only
2389 Perl_sv_2uv(pTHX_ register SV *sv)
2391 return sv_2uv_flags(sv, SV_GMAGIC);
2395 =for apidoc sv_2uv_flags
2397 Return the unsigned integer value of an SV, doing any necessary string
2398 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2399 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2405 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2409 if (SvGMAGICAL(sv)) {
2410 if (flags & SV_GMAGIC)
2415 return U_V(SvNVX(sv));
2416 if (SvPOKp(sv) && SvLEN(sv))
2419 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2420 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2426 if (SvTHINKFIRST(sv)) {
2429 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2430 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2431 return SvUV(tmpstr);
2432 return PTR2UV(SvRV(sv));
2435 sv_force_normal_flags(sv, 0);
2437 if (SvREADONLY(sv) && !SvOK(sv)) {
2438 if (ckWARN(WARN_UNINITIALIZED))
2448 return (UV)SvIVX(sv);
2452 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2453 * without also getting a cached IV/UV from it at the same time
2454 * (ie PV->NV conversion should detect loss of accuracy and cache
2455 * IV or UV at same time to avoid this. */
2456 /* IV-over-UV optimisation - choose to cache IV if possible */
2458 if (SvTYPE(sv) == SVt_NV)
2459 sv_upgrade(sv, SVt_PVNV);
2461 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2462 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2463 SvIV_set(sv, I_V(SvNVX(sv)));
2464 if (SvNVX(sv) == (NV) SvIVX(sv)
2465 #ifndef NV_PRESERVES_UV
2466 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2467 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2468 /* Don't flag it as "accurately an integer" if the number
2469 came from a (by definition imprecise) NV operation, and
2470 we're outside the range of NV integer precision */
2473 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2474 DEBUG_c(PerlIO_printf(Perl_debug_log,
2475 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2481 /* IV not precise. No need to convert from PV, as NV
2482 conversion would already have cached IV if it detected
2483 that PV->IV would be better than PV->NV->IV
2484 flags already correct - don't set public IOK. */
2485 DEBUG_c(PerlIO_printf(Perl_debug_log,
2486 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2491 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2492 but the cast (NV)IV_MIN rounds to a the value less (more
2493 negative) than IV_MIN which happens to be equal to SvNVX ??
2494 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2495 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2496 (NV)UVX == NVX are both true, but the values differ. :-(
2497 Hopefully for 2s complement IV_MIN is something like
2498 0x8000000000000000 which will be exact. NWC */
2501 SvUV_set(sv, U_V(SvNVX(sv)));
2503 (SvNVX(sv) == (NV) SvUVX(sv))
2504 #ifndef NV_PRESERVES_UV
2505 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2506 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2507 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2508 /* Don't flag it as "accurately an integer" if the number
2509 came from a (by definition imprecise) NV operation, and
2510 we're outside the range of NV integer precision */
2515 DEBUG_c(PerlIO_printf(Perl_debug_log,
2516 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2522 else if (SvPOKp(sv) && SvLEN(sv)) {
2524 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2526 /* We want to avoid a possible problem when we cache a UV which
2527 may be later translated to an NV, and the resulting NV is not
2528 the translation of the initial data.
2530 This means that if we cache such a UV, we need to cache the
2531 NV as well. Moreover, we trade speed for space, and do not
2532 cache the NV if not needed.
2535 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2536 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2537 == IS_NUMBER_IN_UV) {
2538 /* It's definitely an integer, only upgrade to PVIV */
2539 if (SvTYPE(sv) < SVt_PVIV)
2540 sv_upgrade(sv, SVt_PVIV);
2542 } else if (SvTYPE(sv) < SVt_PVNV)
2543 sv_upgrade(sv, SVt_PVNV);
2545 /* If NV preserves UV then we only use the UV value if we know that
2546 we aren't going to call atof() below. If NVs don't preserve UVs
2547 then the value returned may have more precision than atof() will
2548 return, even though it isn't accurate. */
2549 if ((numtype & (IS_NUMBER_IN_UV
2550 #ifdef NV_PRESERVES_UV
2553 )) == IS_NUMBER_IN_UV) {
2554 /* This won't turn off the public IOK flag if it was set above */
2555 (void)SvIOKp_on(sv);
2557 if (!(numtype & IS_NUMBER_NEG)) {
2559 if (value <= (UV)IV_MAX) {
2560 SvIV_set(sv, (IV)value);
2562 /* it didn't overflow, and it was positive. */
2563 SvUV_set(sv, value);
2567 /* 2s complement assumption */
2568 if (value <= (UV)IV_MIN) {
2569 SvIV_set(sv, -(IV)value);
2571 /* Too negative for an IV. This is a double upgrade, but
2572 I'm assuming it will be rare. */
2573 if (SvTYPE(sv) < SVt_PVNV)
2574 sv_upgrade(sv, SVt_PVNV);
2578 SvNV_set(sv, -(NV)value);
2579 SvIV_set(sv, IV_MIN);
2584 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2585 != IS_NUMBER_IN_UV) {
2586 /* It wasn't an integer, or it overflowed the UV. */
2587 SvNV_set(sv, Atof(SvPVX_const(sv)));
2589 if (! numtype && ckWARN(WARN_NUMERIC))
2592 #if defined(USE_LONG_DOUBLE)
2593 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2594 PTR2UV(sv), SvNVX(sv)));
2596 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2597 PTR2UV(sv), SvNVX(sv)));
2600 #ifdef NV_PRESERVES_UV
2601 (void)SvIOKp_on(sv);
2603 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2604 SvIV_set(sv, I_V(SvNVX(sv)));
2605 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2608 /* Integer is imprecise. NOK, IOKp */
2610 /* UV will not work better than IV */
2612 if (SvNVX(sv) > (NV)UV_MAX) {
2614 /* Integer is inaccurate. NOK, IOKp, is UV */
2615 SvUV_set(sv, UV_MAX);
2618 SvUV_set(sv, U_V(SvNVX(sv)));
2619 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2620 NV preservse UV so can do correct comparison. */
2621 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2625 /* Integer is imprecise. NOK, IOKp, is UV */
2630 #else /* NV_PRESERVES_UV */
2631 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2632 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2633 /* The UV slot will have been set from value returned by
2634 grok_number above. The NV slot has just been set using
2637 assert (SvIOKp(sv));
2639 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2640 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2641 /* Small enough to preserve all bits. */
2642 (void)SvIOKp_on(sv);
2644 SvIV_set(sv, I_V(SvNVX(sv)));
2645 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2647 /* Assumption: first non-preserved integer is < IV_MAX,
2648 this NV is in the preserved range, therefore: */
2649 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2651 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);
2654 sv_2iuv_non_preserve (sv, numtype);
2656 #endif /* NV_PRESERVES_UV */
2660 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2661 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2664 if (SvTYPE(sv) < SVt_IV)
2665 /* Typically the caller expects that sv_any is not NULL now. */
2666 sv_upgrade(sv, SVt_IV);
2670 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2671 PTR2UV(sv),SvUVX(sv)));
2672 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2678 Return the num value of an SV, doing any necessary string or integer
2679 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2686 Perl_sv_2nv(pTHX_ register SV *sv)
2690 if (SvGMAGICAL(sv)) {
2694 if (SvPOKp(sv) && SvLEN(sv)) {
2695 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2696 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2698 return Atof(SvPVX_const(sv));
2702 return (NV)SvUVX(sv);
2704 return (NV)SvIVX(sv);
2707 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2708 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2714 if (SvTHINKFIRST(sv)) {
2717 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2718 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2719 return SvNV(tmpstr);
2720 return PTR2NV(SvRV(sv));
2723 sv_force_normal_flags(sv, 0);
2725 if (SvREADONLY(sv) && !SvOK(sv)) {
2726 if (ckWARN(WARN_UNINITIALIZED))
2731 if (SvTYPE(sv) < SVt_NV) {
2732 if (SvTYPE(sv) == SVt_IV)
2733 sv_upgrade(sv, SVt_PVNV);
2735 sv_upgrade(sv, SVt_NV);
2736 #ifdef USE_LONG_DOUBLE
2738 STORE_NUMERIC_LOCAL_SET_STANDARD();
2739 PerlIO_printf(Perl_debug_log,
2740 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2741 PTR2UV(sv), SvNVX(sv));
2742 RESTORE_NUMERIC_LOCAL();
2746 STORE_NUMERIC_LOCAL_SET_STANDARD();
2747 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2748 PTR2UV(sv), SvNVX(sv));
2749 RESTORE_NUMERIC_LOCAL();
2753 else if (SvTYPE(sv) < SVt_PVNV)
2754 sv_upgrade(sv, SVt_PVNV);
2759 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2760 #ifdef NV_PRESERVES_UV
2763 /* Only set the public NV OK flag if this NV preserves the IV */
2764 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2765 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2766 : (SvIVX(sv) == I_V(SvNVX(sv))))
2772 else if (SvPOKp(sv) && SvLEN(sv)) {
2774 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2775 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2777 #ifdef NV_PRESERVES_UV
2778 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2779 == IS_NUMBER_IN_UV) {
2780 /* It's definitely an integer */
2781 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2783 SvNV_set(sv, Atof(SvPVX_const(sv)));
2786 SvNV_set(sv, Atof(SvPVX_const(sv)));
2787 /* Only set the public NV OK flag if this NV preserves the value in
2788 the PV at least as well as an IV/UV would.
2789 Not sure how to do this 100% reliably. */
2790 /* if that shift count is out of range then Configure's test is
2791 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2793 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2794 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2795 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2796 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2797 /* Can't use strtol etc to convert this string, so don't try.
2798 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2801 /* value has been set. It may not be precise. */
2802 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2803 /* 2s complement assumption for (UV)IV_MIN */
2804 SvNOK_on(sv); /* Integer is too negative. */
2809 if (numtype & IS_NUMBER_NEG) {
2810 SvIV_set(sv, -(IV)value);
2811 } else if (value <= (UV)IV_MAX) {
2812 SvIV_set(sv, (IV)value);
2814 SvUV_set(sv, value);
2818 if (numtype & IS_NUMBER_NOT_INT) {
2819 /* I believe that even if the original PV had decimals,
2820 they are lost beyond the limit of the FP precision.
2821 However, neither is canonical, so both only get p
2822 flags. NWC, 2000/11/25 */
2823 /* Both already have p flags, so do nothing */
2825 const NV nv = SvNVX(sv);
2826 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2827 if (SvIVX(sv) == I_V(nv)) {
2832 /* It had no "." so it must be integer. */
2835 /* between IV_MAX and NV(UV_MAX).
2836 Could be slightly > UV_MAX */
2838 if (numtype & IS_NUMBER_NOT_INT) {
2839 /* UV and NV both imprecise. */
2841 const UV nv_as_uv = U_V(nv);
2843 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2854 #endif /* NV_PRESERVES_UV */
2857 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2859 if (SvTYPE(sv) < SVt_NV)
2860 /* Typically the caller expects that sv_any is not NULL now. */
2861 /* XXX Ilya implies that this is a bug in callers that assume this
2862 and ideally should be fixed. */
2863 sv_upgrade(sv, SVt_NV);
2866 #if defined(USE_LONG_DOUBLE)
2868 STORE_NUMERIC_LOCAL_SET_STANDARD();
2869 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2870 PTR2UV(sv), SvNVX(sv));
2871 RESTORE_NUMERIC_LOCAL();
2875 STORE_NUMERIC_LOCAL_SET_STANDARD();
2876 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2877 PTR2UV(sv), SvNVX(sv));
2878 RESTORE_NUMERIC_LOCAL();
2884 /* asIV(): extract an integer from the string value of an SV.
2885 * Caller must validate PVX */
2888 S_asIV(pTHX_ SV *sv)
2891 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2893 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2894 == IS_NUMBER_IN_UV) {
2895 /* It's definitely an integer */
2896 if (numtype & IS_NUMBER_NEG) {
2897 if (value < (UV)IV_MIN)
2900 if (value < (UV)IV_MAX)
2905 if (ckWARN(WARN_NUMERIC))
2908 return I_V(Atof(SvPVX_const(sv)));
2911 /* asUV(): extract an unsigned integer from the string value of an SV
2912 * Caller must validate PVX */
2915 S_asUV(pTHX_ SV *sv)
2918 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2921 == IS_NUMBER_IN_UV) {
2922 /* It's definitely an integer */
2923 if (!(numtype & IS_NUMBER_NEG))
2927 if (ckWARN(WARN_NUMERIC))
2930 return U_V(Atof(SvPVX_const(sv)));
2934 =for apidoc sv_2pv_nolen
2936 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2937 use the macro wrapper C<SvPV_nolen(sv)> instead.
2942 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2944 return sv_2pv(sv, 0);
2947 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2948 * UV as a string towards the end of buf, and return pointers to start and
2951 * We assume that buf is at least TYPE_CHARS(UV) long.
2955 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2957 char *ptr = buf + TYPE_CHARS(UV);
2971 *--ptr = '0' + (char)(uv % 10);
2979 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2980 * this function provided for binary compatibility only
2984 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2986 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2990 =for apidoc sv_2pv_flags
2992 Returns a pointer to the string value of an SV, and sets *lp to its length.
2993 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2995 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2996 usually end up here too.
3002 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3007 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3008 char *tmpbuf = tbuf;
3015 if (SvGMAGICAL(sv)) {
3016 if (flags & SV_GMAGIC)
3021 if (flags & SV_MUTABLE_RETURN)
3022 return SvPVX_mutable(sv);
3023 if (flags & SV_CONST_RETURN)
3024 return (char *)SvPVX_const(sv);
3029 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3031 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3036 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3041 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3042 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3050 if (SvTHINKFIRST(sv)) {
3053 register const char *typestr;
3054 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3055 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3057 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3060 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3061 if (flags & SV_CONST_RETURN) {
3062 pv = (char *) SvPVX_const(tmpstr);
3064 pv = (flags & SV_MUTABLE_RETURN)
3065 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3068 *lp = SvCUR(tmpstr);
3070 pv = sv_2pv_flags(tmpstr, lp, flags);
3081 typestr = "NULLREF";
3085 switch (SvTYPE(sv)) {
3087 if ( ((SvFLAGS(sv) &
3088 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3089 == (SVs_OBJECT|SVs_SMG))
3090 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3091 const regexp *re = (regexp *)mg->mg_obj;
3094 const char *fptr = "msix";
3099 char need_newline = 0;
3100 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3102 while((ch = *fptr++)) {
3104 reflags[left++] = ch;
3107 reflags[right--] = ch;
3112 reflags[left] = '-';
3116 mg->mg_len = re->prelen + 4 + left;
3118 * If /x was used, we have to worry about a regex
3119 * ending with a comment later being embedded
3120 * within another regex. If so, we don't want this
3121 * regex's "commentization" to leak out to the
3122 * right part of the enclosing regex, we must cap
3123 * it with a newline.
3125 * So, if /x was used, we scan backwards from the
3126 * end of the regex. If we find a '#' before we
3127 * find a newline, we need to add a newline
3128 * ourself. If we find a '\n' first (or if we
3129 * don't find '#' or '\n'), we don't need to add
3130 * anything. -jfriedl
3132 if (PMf_EXTENDED & re->reganch)
3134 const char *endptr = re->precomp + re->prelen;
3135 while (endptr >= re->precomp)
3137 const char c = *(endptr--);
3139 break; /* don't need another */
3141 /* we end while in a comment, so we
3143 mg->mg_len++; /* save space for it */
3144 need_newline = 1; /* note to add it */
3150 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3151 Copy("(?", mg->mg_ptr, 2, char);
3152 Copy(reflags, mg->mg_ptr+2, left, char);
3153 Copy(":", mg->mg_ptr+left+2, 1, char);
3154 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3156 mg->mg_ptr[mg->mg_len - 2] = '\n';
3157 mg->mg_ptr[mg->mg_len - 1] = ')';
3158 mg->mg_ptr[mg->mg_len] = 0;
3160 PL_reginterp_cnt += re->program[0].next_off;
3162 if (re->reganch & ROPT_UTF8)
3178 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3179 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3180 /* tied lvalues should appear to be
3181 * scalars for backwards compatitbility */
3182 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3183 ? "SCALAR" : "LVALUE"; break;
3184 case SVt_PVAV: typestr = "ARRAY"; break;
3185 case SVt_PVHV: typestr = "HASH"; break;
3186 case SVt_PVCV: typestr = "CODE"; break;
3187 case SVt_PVGV: typestr = "GLOB"; break;
3188 case SVt_PVFM: typestr = "FORMAT"; break;
3189 case SVt_PVIO: typestr = "IO"; break;
3190 default: typestr = "UNKNOWN"; break;
3194 const char *name = HvNAME_get(SvSTASH(sv));
3195 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3196 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3199 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3203 *lp = strlen(typestr);
3204 return (char *)typestr;
3206 if (SvREADONLY(sv) && !SvOK(sv)) {
3207 if (ckWARN(WARN_UNINITIALIZED))
3214 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3215 /* I'm assuming that if both IV and NV are equally valid then
3216 converting the IV is going to be more efficient */
3217 const U32 isIOK = SvIOK(sv);
3218 const U32 isUIOK = SvIsUV(sv);
3219 char buf[TYPE_CHARS(UV)];
3222 if (SvTYPE(sv) < SVt_PVIV)
3223 sv_upgrade(sv, SVt_PVIV);
3225 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3227 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3228 /* inlined from sv_setpvn */
3229 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3230 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3231 SvCUR_set(sv, ebuf - ptr);
3241 else if (SvNOKp(sv)) {
3242 if (SvTYPE(sv) < SVt_PVNV)
3243 sv_upgrade(sv, SVt_PVNV);
3244 /* The +20 is pure guesswork. Configure test needed. --jhi */
3245 s = SvGROW_mutable(sv, NV_DIG + 20);
3246 olderrno = errno; /* some Xenix systems wipe out errno here */
3248 if (SvNVX(sv) == 0.0)
3249 (void)strcpy(s,"0");
3253 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3256 #ifdef FIXNEGATIVEZERO
3257 if (*s == '-' && s[1] == '0' && !s[2])
3267 if (ckWARN(WARN_UNINITIALIZED)
3268 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3272 if (SvTYPE(sv) < SVt_PV)
3273 /* Typically the caller expects that sv_any is not NULL now. */
3274 sv_upgrade(sv, SVt_PV);
3278 STRLEN len = s - SvPVX_const(sv);
3284 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3285 PTR2UV(sv),SvPVX_const(sv)));
3286 if (flags & SV_CONST_RETURN)
3287 return (char *)SvPVX_const(sv);
3288 if (flags & SV_MUTABLE_RETURN)
3289 return SvPVX_mutable(sv);
3293 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3294 /* Sneaky stuff here */
3298 tsv = newSVpv(tmpbuf, 0);
3311 t = SvPVX_const(tsv);
3316 len = strlen(tmpbuf);
3318 #ifdef FIXNEGATIVEZERO
3319 if (len == 2 && t[0] == '-' && t[1] == '0') {
3324 SvUPGRADE(sv, SVt_PV);
3327 s = SvGROW_mutable(sv, len + 1);
3330 return strcpy(s, t);
3335 =for apidoc sv_copypv
3337 Copies a stringified representation of the source SV into the
3338 destination SV. Automatically performs any necessary mg_get and
3339 coercion of numeric values into strings. Guaranteed to preserve
3340 UTF-8 flag even from overloaded objects. Similar in nature to
3341 sv_2pv[_flags] but operates directly on an SV instead of just the
3342 string. Mostly uses sv_2pv_flags to do its work, except when that
3343 would lose the UTF-8'ness of the PV.
3349 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3352 const char * const s = SvPV_const(ssv,len);
3353 sv_setpvn(dsv,s,len);
3361 =for apidoc sv_2pvbyte_nolen
3363 Return a pointer to the byte-encoded representation of the SV.
3364 May cause the SV to be downgraded from UTF-8 as a side-effect.
3366 Usually accessed via the C<SvPVbyte_nolen> macro.
3372 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3374 return sv_2pvbyte(sv, 0);
3378 =for apidoc sv_2pvbyte
3380 Return a pointer to the byte-encoded representation of the SV, and set *lp
3381 to its length. May cause the SV to be downgraded from UTF-8 as a
3384 Usually accessed via the C<SvPVbyte> macro.
3390 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3392 sv_utf8_downgrade(sv,0);
3393 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3397 =for apidoc sv_2pvutf8_nolen
3399 Return a pointer to the UTF-8-encoded representation of the SV.
3400 May cause the SV to be upgraded to UTF-8 as a side-effect.
3402 Usually accessed via the C<SvPVutf8_nolen> macro.
3408 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3410 return sv_2pvutf8(sv, 0);
3414 =for apidoc sv_2pvutf8
3416 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3417 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3419 Usually accessed via the C<SvPVutf8> macro.
3425 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3427 sv_utf8_upgrade(sv);
3428 return SvPV(sv,*lp);
3432 =for apidoc sv_2bool
3434 This function is only called on magical items, and is only used by
3435 sv_true() or its macro equivalent.
3441 Perl_sv_2bool(pTHX_ register SV *sv)
3450 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3451 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3452 return (bool)SvTRUE(tmpsv);
3453 return SvRV(sv) != 0;
3456 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3458 (*sv->sv_u.svu_pv > '0' ||
3459 Xpvtmp->xpv_cur > 1 ||
3460 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3467 return SvIVX(sv) != 0;
3470 return SvNVX(sv) != 0.0;
3477 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3478 * this function provided for binary compatibility only
3483 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3485 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3489 =for apidoc sv_utf8_upgrade
3491 Converts the PV of an SV to its UTF-8-encoded form.
3492 Forces the SV to string form if it is not already.
3493 Always sets the SvUTF8 flag to avoid future validity checks even
3494 if all the bytes have hibit clear.
3496 This is not as a general purpose byte encoding to Unicode interface:
3497 use the Encode extension for that.
3499 =for apidoc sv_utf8_upgrade_flags
3501 Converts the PV of an SV to its UTF-8-encoded form.
3502 Forces the SV to string form if it is not already.
3503 Always sets the SvUTF8 flag to avoid future validity checks even
3504 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3505 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3506 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3508 This is not as a general purpose byte encoding to Unicode interface:
3509 use the Encode extension for that.
3515 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3517 if (sv == &PL_sv_undef)
3521 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3522 (void) sv_2pv_flags(sv,&len, flags);
3526 (void) SvPV_force(sv,len);
3535 sv_force_normal_flags(sv, 0);
3538 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3539 sv_recode_to_utf8(sv, PL_encoding);
3540 else { /* Assume Latin-1/EBCDIC */
3541 /* This function could be much more efficient if we
3542 * had a FLAG in SVs to signal if there are any hibit
3543 * chars in the PV. Given that there isn't such a flag
3544 * make the loop as fast as possible. */
3545 const U8 *s = (U8 *) SvPVX_const(sv);
3546 const U8 *e = (U8 *) SvEND(sv);
3552 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3556 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3557 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3559 SvPV_free(sv); /* No longer using what was there before. */
3561 SvPV_set(sv, (char*)recoded);
3562 SvCUR_set(sv, len - 1);
3563 SvLEN_set(sv, len); /* No longer know the real size. */
3565 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3572 =for apidoc sv_utf8_downgrade
3574 Attempts to convert the PV of an SV from characters to bytes.
3575 If the PV contains a character beyond byte, this conversion will fail;
3576 in this case, either returns false or, if C<fail_ok> is not
3579 This is not as a general purpose Unicode to byte encoding interface:
3580 use the Encode extension for that.
3586 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3588 if (SvPOKp(sv) && SvUTF8(sv)) {
3594 sv_force_normal_flags(sv, 0);
3596 s = (U8 *) SvPV(sv, len);
3597 if (!utf8_to_bytes(s, &len)) {
3602 Perl_croak(aTHX_ "Wide character in %s",
3605 Perl_croak(aTHX_ "Wide character");
3616 =for apidoc sv_utf8_encode
3618 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3619 flag off so that it looks like octets again.
3625 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3627 (void) sv_utf8_upgrade(sv);
3629 sv_force_normal_flags(sv, 0);
3631 if (SvREADONLY(sv)) {
3632 Perl_croak(aTHX_ PL_no_modify);
3638 =for apidoc sv_utf8_decode
3640 If the PV of the SV is an octet sequence in UTF-8
3641 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3642 so that it looks like a character. If the PV contains only single-byte
3643 characters, the C<SvUTF8> flag stays being off.
3644 Scans PV for validity and returns false if the PV is invalid UTF-8.
3650 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3656 /* The octets may have got themselves encoded - get them back as
3659 if (!sv_utf8_downgrade(sv, TRUE))
3662 /* it is actually just a matter of turning the utf8 flag on, but
3663 * we want to make sure everything inside is valid utf8 first.
3665 c = (const U8 *) SvPVX_const(sv);
3666 if (!is_utf8_string(c, SvCUR(sv)+1))
3668 e = (const U8 *) SvEND(sv);
3671 if (!UTF8_IS_INVARIANT(ch)) {
3680 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3681 * this function provided for binary compatibility only
3685 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3687 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3691 =for apidoc sv_setsv
3693 Copies the contents of the source SV C<ssv> into the destination SV
3694 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3695 function if the source SV needs to be reused. Does not handle 'set' magic.
3696 Loosely speaking, it performs a copy-by-value, obliterating any previous
3697 content of the destination.
3699 You probably want to use one of the assortment of wrappers, such as
3700 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3701 C<SvSetMagicSV_nosteal>.
3703 =for apidoc sv_setsv_flags
3705 Copies the contents of the source SV C<ssv> into the destination SV
3706 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3707 function if the source SV needs to be reused. Does not handle 'set' magic.
3708 Loosely speaking, it performs a copy-by-value, obliterating any previous
3709 content of the destination.
3710 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3711 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3712 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3713 and C<sv_setsv_nomg> are implemented in terms of this function.
3715 You probably want to use one of the assortment of wrappers, such as
3716 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3717 C<SvSetMagicSV_nosteal>.
3719 This is the primary function for copying scalars, and most other
3720 copy-ish functions and macros use this underneath.
3726 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3728 register U32 sflags;
3734 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3736 sstr = &PL_sv_undef;
3737 stype = SvTYPE(sstr);
3738 dtype = SvTYPE(dstr);
3743 /* need to nuke the magic */
3745 SvRMAGICAL_off(dstr);
3748 /* There's a lot of redundancy below but we're going for speed here */
3753 if (dtype != SVt_PVGV) {
3754 (void)SvOK_off(dstr);
3762 sv_upgrade(dstr, SVt_IV);
3765 sv_upgrade(dstr, SVt_PVNV);
3769 sv_upgrade(dstr, SVt_PVIV);
3772 (void)SvIOK_only(dstr);
3773 SvIV_set(dstr, SvIVX(sstr));
3776 if (SvTAINTED(sstr))
3787 sv_upgrade(dstr, SVt_NV);
3792 sv_upgrade(dstr, SVt_PVNV);
3795 SvNV_set(dstr, SvNVX(sstr));
3796 (void)SvNOK_only(dstr);
3797 if (SvTAINTED(sstr))
3805 sv_upgrade(dstr, SVt_RV);
3806 else if (dtype == SVt_PVGV &&
3807 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3810 if (GvIMPORTED(dstr) != GVf_IMPORTED
3811 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3813 GvIMPORTED_on(dstr);
3822 #ifdef PERL_OLD_COPY_ON_WRITE
3823 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3824 if (dtype < SVt_PVIV)
3825 sv_upgrade(dstr, SVt_PVIV);
3832 sv_upgrade(dstr, SVt_PV);
3835 if (dtype < SVt_PVIV)
3836 sv_upgrade(dstr, SVt_PVIV);
3839 if (dtype < SVt_PVNV)
3840 sv_upgrade(dstr, SVt_PVNV);
3847 const char * const type = sv_reftype(sstr,0);
3849 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3851 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3856 if (dtype <= SVt_PVGV) {
3858 if (dtype != SVt_PVGV) {
3859 const char * const name = GvNAME(sstr);
3860 const STRLEN len = GvNAMELEN(sstr);
3861 /* don't upgrade SVt_PVLV: it can hold a glob */
3862 if (dtype != SVt_PVLV)
3863 sv_upgrade(dstr, SVt_PVGV);
3864 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3865 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3866 GvNAME(dstr) = savepvn(name, len);
3867 GvNAMELEN(dstr) = len;
3868 SvFAKE_on(dstr); /* can coerce to non-glob */
3870 /* ahem, death to those who redefine active sort subs */
3871 else if (PL_curstackinfo->si_type == PERLSI_SORT
3872 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3873 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3876 #ifdef GV_UNIQUE_CHECK
3877 if (GvUNIQUE((GV*)dstr)) {
3878 Perl_croak(aTHX_ PL_no_modify);
3882 (void)SvOK_off(dstr);
3883 GvINTRO_off(dstr); /* one-shot flag */
3885 GvGP(dstr) = gp_ref(GvGP(sstr));
3886 if (SvTAINTED(sstr))
3888 if (GvIMPORTED(dstr) != GVf_IMPORTED
3889 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3891 GvIMPORTED_on(dstr);
3899 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3901 if ((int)SvTYPE(sstr) != stype) {
3902 stype = SvTYPE(sstr);
3903 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3907 if (stype == SVt_PVLV)
3908 SvUPGRADE(dstr, SVt_PVNV);
3910 SvUPGRADE(dstr, (U32)stype);
3913 sflags = SvFLAGS(sstr);
3915 if (sflags & SVf_ROK) {
3916 if (dtype >= SVt_PV) {
3917 if (dtype == SVt_PVGV) {
3918 SV *sref = SvREFCNT_inc(SvRV(sstr));
3920 const int intro = GvINTRO(dstr);
3922 #ifdef GV_UNIQUE_CHECK
3923 if (GvUNIQUE((GV*)dstr)) {
3924 Perl_croak(aTHX_ PL_no_modify);
3929 GvINTRO_off(dstr); /* one-shot flag */
3930 GvLINE(dstr) = CopLINE(PL_curcop);
3931 GvEGV(dstr) = (GV*)dstr;
3934 switch (SvTYPE(sref)) {
3937 SAVEGENERICSV(GvAV(dstr));
3939 dref = (SV*)GvAV(dstr);
3940 GvAV(dstr) = (AV*)sref;
3941 if (!GvIMPORTED_AV(dstr)
3942 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3944 GvIMPORTED_AV_on(dstr);
3949 SAVEGENERICSV(GvHV(dstr));
3951 dref = (SV*)GvHV(dstr);
3952 GvHV(dstr) = (HV*)sref;
3953 if (!GvIMPORTED_HV(dstr)
3954 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3956 GvIMPORTED_HV_on(dstr);
3961 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3962 SvREFCNT_dec(GvCV(dstr));
3963 GvCV(dstr) = Nullcv;
3964 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3965 PL_sub_generation++;
3967 SAVEGENERICSV(GvCV(dstr));
3970 dref = (SV*)GvCV(dstr);
3971 if (GvCV(dstr) != (CV*)sref) {
3972 CV* cv = GvCV(dstr);
3974 if (!GvCVGEN((GV*)dstr) &&
3975 (CvROOT(cv) || CvXSUB(cv)))
3977 /* ahem, death to those who redefine
3978 * active sort subs */
3979 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3980 PL_sortcop == CvSTART(cv))
3982 "Can't redefine active sort subroutine %s",
3983 GvENAME((GV*)dstr));
3984 /* Redefining a sub - warning is mandatory if
3985 it was a const and its value changed. */
3986 if (ckWARN(WARN_REDEFINE)
3988 && (!CvCONST((CV*)sref)
3989 || sv_cmp(cv_const_sv(cv),
3990 cv_const_sv((CV*)sref)))))
3992 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3994 ? "Constant subroutine %s::%s redefined"
3995 : "Subroutine %s::%s redefined",
3996 HvNAME_get(GvSTASH((GV*)dstr)),
3997 GvENAME((GV*)dstr));
4001 cv_ckproto(cv, (GV*)dstr,
4003 ? SvPVX_const(sref) : Nullch);
4005 GvCV(dstr) = (CV*)sref;
4006 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4007 GvASSUMECV_on(dstr);
4008 PL_sub_generation++;
4010 if (!GvIMPORTED_CV(dstr)
4011 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4013 GvIMPORTED_CV_on(dstr);
4018 SAVEGENERICSV(GvIOp(dstr));
4020 dref = (SV*)GvIOp(dstr);
4021 GvIOp(dstr) = (IO*)sref;
4025 SAVEGENERICSV(GvFORM(dstr));
4027 dref = (SV*)GvFORM(dstr);
4028 GvFORM(dstr) = (CV*)sref;
4032 SAVEGENERICSV(GvSV(dstr));
4034 dref = (SV*)GvSV(dstr);
4036 if (!GvIMPORTED_SV(dstr)
4037 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4039 GvIMPORTED_SV_on(dstr);
4045 if (SvTAINTED(sstr))
4049 if (SvPVX_const(dstr)) {
4055 (void)SvOK_off(dstr);
4056 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4058 if (sflags & SVp_NOK) {
4060 /* Only set the public OK flag if the source has public OK. */
4061 if (sflags & SVf_NOK)
4062 SvFLAGS(dstr) |= SVf_NOK;
4063 SvNV_set(dstr, SvNVX(sstr));
4065 if (sflags & SVp_IOK) {
4066 (void)SvIOKp_on(dstr);
4067 if (sflags & SVf_IOK)
4068 SvFLAGS(dstr) |= SVf_IOK;
4069 if (sflags & SVf_IVisUV)
4071 SvIV_set(dstr, SvIVX(sstr));
4073 if (SvAMAGIC(sstr)) {
4077 else if (sflags & SVp_POK) {
4081 * Check to see if we can just swipe the string. If so, it's a
4082 * possible small lose on short strings, but a big win on long ones.
4083 * It might even be a win on short strings if SvPVX_const(dstr)
4084 * has to be allocated and SvPVX_const(sstr) has to be freed.
4087 /* Whichever path we take through the next code, we want this true,
4088 and doing it now facilitates the COW check. */
4089 (void)SvPOK_only(dstr);
4092 /* We're not already COW */
4093 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4094 #ifndef PERL_OLD_COPY_ON_WRITE
4095 /* or we are, but dstr isn't a suitable target. */
4096 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4101 (sflags & SVs_TEMP) && /* slated for free anyway? */
4102 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4103 (!(flags & SV_NOSTEAL)) &&
4104 /* and we're allowed to steal temps */
4105 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4106 SvLEN(sstr) && /* and really is a string */
4107 /* and won't be needed again, potentially */
4108 !(PL_op && PL_op->op_type == OP_AASSIGN))
4109 #ifdef PERL_OLD_COPY_ON_WRITE
4110 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4111 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4112 && SvTYPE(sstr) >= SVt_PVIV)
4115 /* Failed the swipe test, and it's not a shared hash key either.
4116 Have to copy the string. */
4117 STRLEN len = SvCUR(sstr);
4118 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4119 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4120 SvCUR_set(dstr, len);
4121 *SvEND(dstr) = '\0';
4123 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4125 /* Either it's a shared hash key, or it's suitable for
4126 copy-on-write or we can swipe the string. */
4128 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4132 #ifdef PERL_OLD_COPY_ON_WRITE
4134 /* I believe I should acquire a global SV mutex if
4135 it's a COW sv (not a shared hash key) to stop
4136 it going un copy-on-write.
4137 If the source SV has gone un copy on write between up there
4138 and down here, then (assert() that) it is of the correct
4139 form to make it copy on write again */
4140 if ((sflags & (SVf_FAKE | SVf_READONLY))
4141 != (SVf_FAKE | SVf_READONLY)) {
4142 SvREADONLY_on(sstr);
4144 /* Make the source SV into a loop of 1.
4145 (about to become 2) */
4146 SV_COW_NEXT_SV_SET(sstr, sstr);
4150 /* Initial code is common. */
4151 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4153 SvFLAGS(dstr) &= ~SVf_OOK;
4154 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4156 else if (SvLEN(dstr))
4157 Safefree(SvPVX_const(dstr));
4161 /* making another shared SV. */
4162 STRLEN cur = SvCUR(sstr);
4163 STRLEN len = SvLEN(sstr);
4164 #ifdef PERL_OLD_COPY_ON_WRITE
4166 assert (SvTYPE(dstr) >= SVt_PVIV);
4167 /* SvIsCOW_normal */
4168 /* splice us in between source and next-after-source. */
4169 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4170 SV_COW_NEXT_SV_SET(sstr, dstr);
4171 SvPV_set(dstr, SvPVX_mutable(sstr));
4175 /* SvIsCOW_shared_hash */
4176 DEBUG_C(PerlIO_printf(Perl_debug_log,
4177 "Copy on write: Sharing hash\n"));
4179 assert (SvTYPE(dstr) >= SVt_PV);
4181 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4183 SvLEN_set(dstr, len);
4184 SvCUR_set(dstr, cur);
4185 SvREADONLY_on(dstr);
4187 /* Relesase a global SV mutex. */
4190 { /* Passes the swipe test. */
4191 SvPV_set(dstr, SvPVX_mutable(sstr));
4192 SvLEN_set(dstr, SvLEN(sstr));
4193 SvCUR_set(dstr, SvCUR(sstr));
4196 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4197 SvPV_set(sstr, Nullch);
4203 if (sflags & SVf_UTF8)
4205 if (sflags & SVp_NOK) {
4207 if (sflags & SVf_NOK)
4208 SvFLAGS(dstr) |= SVf_NOK;
4209 SvNV_set(dstr, SvNVX(sstr));
4211 if (sflags & SVp_IOK) {
4212 (void)SvIOKp_on(dstr);
4213 if (sflags & SVf_IOK)
4214 SvFLAGS(dstr) |= SVf_IOK;
4215 if (sflags & SVf_IVisUV)
4217 SvIV_set(dstr, SvIVX(sstr));
4220 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4221 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4222 smg->mg_ptr, smg->mg_len);
4223 SvRMAGICAL_on(dstr);
4226 else if (sflags & SVp_IOK) {
4227 if (sflags & SVf_IOK)
4228 (void)SvIOK_only(dstr);
4230 (void)SvOK_off(dstr);
4231 (void)SvIOKp_on(dstr);
4233 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4234 if (sflags & SVf_IVisUV)
4236 SvIV_set(dstr, SvIVX(sstr));
4237 if (sflags & SVp_NOK) {
4238 if (sflags & SVf_NOK)
4239 (void)SvNOK_on(dstr);
4241 (void)SvNOKp_on(dstr);
4242 SvNV_set(dstr, SvNVX(sstr));
4245 else if (sflags & SVp_NOK) {
4246 if (sflags & SVf_NOK)
4247 (void)SvNOK_only(dstr);
4249 (void)SvOK_off(dstr);
4252 SvNV_set(dstr, SvNVX(sstr));
4255 if (dtype == SVt_PVGV) {
4256 if (ckWARN(WARN_MISC))
4257 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4260 (void)SvOK_off(dstr);
4262 if (SvTAINTED(sstr))
4267 =for apidoc sv_setsv_mg
4269 Like C<sv_setsv>, but also handles 'set' magic.
4275 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4277 sv_setsv(dstr,sstr);
4281 #ifdef PERL_OLD_COPY_ON_WRITE
4283 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4285 STRLEN cur = SvCUR(sstr);
4286 STRLEN len = SvLEN(sstr);
4287 register char *new_pv;
4290 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4298 if (SvTHINKFIRST(dstr))
4299 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4300 else if (SvPVX_const(dstr))
4301 Safefree(SvPVX_const(dstr));
4305 SvUPGRADE(dstr, SVt_PVIV);
4307 assert (SvPOK(sstr));
4308 assert (SvPOKp(sstr));
4309 assert (!SvIOK(sstr));
4310 assert (!SvIOKp(sstr));
4311 assert (!SvNOK(sstr));
4312 assert (!SvNOKp(sstr));
4314 if (SvIsCOW(sstr)) {
4316 if (SvLEN(sstr) == 0) {
4317 /* source is a COW shared hash key. */
4318 DEBUG_C(PerlIO_printf(Perl_debug_log,
4319 "Fast copy on write: Sharing hash\n"));
4320 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4323 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4325 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4326 SvUPGRADE(sstr, SVt_PVIV);
4327 SvREADONLY_on(sstr);
4329 DEBUG_C(PerlIO_printf(Perl_debug_log,
4330 "Fast copy on write: Converting sstr to COW\n"));
4331 SV_COW_NEXT_SV_SET(dstr, sstr);
4333 SV_COW_NEXT_SV_SET(sstr, dstr);
4334 new_pv = SvPVX_mutable(sstr);
4337 SvPV_set(dstr, new_pv);
4338 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4341 SvLEN_set(dstr, len);
4342 SvCUR_set(dstr, cur);
4351 =for apidoc sv_setpvn
4353 Copies a string into an SV. The C<len> parameter indicates the number of
4354 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4355 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4361 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4363 register char *dptr;
4365 SV_CHECK_THINKFIRST_COW_DROP(sv);
4371 /* len is STRLEN which is unsigned, need to copy to signed */
4374 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4376 SvUPGRADE(sv, SVt_PV);
4378 dptr = SvGROW(sv, len + 1);
4379 Move(ptr,dptr,len,char);
4382 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4387 =for apidoc sv_setpvn_mg
4389 Like C<sv_setpvn>, but also handles 'set' magic.
4395 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4397 sv_setpvn(sv,ptr,len);
4402 =for apidoc sv_setpv
4404 Copies a string into an SV. The string must be null-terminated. Does not
4405 handle 'set' magic. See C<sv_setpv_mg>.
4411 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4413 register STRLEN len;
4415 SV_CHECK_THINKFIRST_COW_DROP(sv);
4421 SvUPGRADE(sv, SVt_PV);
4423 SvGROW(sv, len + 1);
4424 Move(ptr,SvPVX(sv),len+1,char);
4426 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4431 =for apidoc sv_setpv_mg
4433 Like C<sv_setpv>, but also handles 'set' magic.
4439 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4446 =for apidoc sv_usepvn
4448 Tells an SV to use C<ptr> to find its string value. Normally the string is
4449 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4450 The C<ptr> should point to memory that was allocated by C<malloc>. The
4451 string length, C<len>, must be supplied. This function will realloc the
4452 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4453 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4454 See C<sv_usepvn_mg>.
4460 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4463 SV_CHECK_THINKFIRST_COW_DROP(sv);
4464 SvUPGRADE(sv, SVt_PV);
4469 if (SvPVX_const(sv))
4472 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4473 ptr = saferealloc (ptr, allocate);
4476 SvLEN_set(sv, allocate);
4478 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4483 =for apidoc sv_usepvn_mg
4485 Like C<sv_usepvn>, but also handles 'set' magic.
4491 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4493 sv_usepvn(sv,ptr,len);
4497 #ifdef PERL_OLD_COPY_ON_WRITE
4498 /* Need to do this *after* making the SV normal, as we need the buffer
4499 pointer to remain valid until after we've copied it. If we let go too early,
4500 another thread could invalidate it by unsharing last of the same hash key
4501 (which it can do by means other than releasing copy-on-write Svs)
4502 or by changing the other copy-on-write SVs in the loop. */
4504 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4506 if (len) { /* this SV was SvIsCOW_normal(sv) */
4507 /* we need to find the SV pointing to us. */
4508 SV *current = SV_COW_NEXT_SV(after);
4510 if (current == sv) {
4511 /* The SV we point to points back to us (there were only two of us
4513 Hence other SV is no longer copy on write either. */
4515 SvREADONLY_off(after);
4517 /* We need to follow the pointers around the loop. */
4519 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4522 /* don't loop forever if the structure is bust, and we have
4523 a pointer into a closed loop. */
4524 assert (current != after);
4525 assert (SvPVX_const(current) == pvx);
4527 /* Make the SV before us point to the SV after us. */
4528 SV_COW_NEXT_SV_SET(current, after);
4531 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4536 Perl_sv_release_IVX(pTHX_ register SV *sv)
4539 sv_force_normal_flags(sv, 0);
4545 =for apidoc sv_force_normal_flags
4547 Undo various types of fakery on an SV: if the PV is a shared string, make
4548 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4549 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4550 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4551 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4552 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4553 set to some other value.) In addition, the C<flags> parameter gets passed to
4554 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4555 with flags set to 0.
4561 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4563 #ifdef PERL_OLD_COPY_ON_WRITE
4564 if (SvREADONLY(sv)) {
4565 /* At this point I believe I should acquire a global SV mutex. */
4567 const char *pvx = SvPVX_const(sv);
4568 const STRLEN len = SvLEN(sv);
4569 const STRLEN cur = SvCUR(sv);
4570 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4572 PerlIO_printf(Perl_debug_log,
4573 "Copy on write: Force normal %ld\n",
4579 /* This SV doesn't own the buffer, so need to New() a new one: */
4580 SvPV_set(sv, (char*)0);
4582 if (flags & SV_COW_DROP_PV) {
4583 /* OK, so we don't need to copy our buffer. */
4586 SvGROW(sv, cur + 1);
4587 Move(pvx,SvPVX(sv),cur,char);
4591 sv_release_COW(sv, pvx, len, next);
4596 else if (IN_PERL_RUNTIME)
4597 Perl_croak(aTHX_ PL_no_modify);
4598 /* At this point I believe that I can drop the global SV mutex. */
4601 if (SvREADONLY(sv)) {
4603 const char *pvx = SvPVX_const(sv);
4604 const STRLEN len = SvCUR(sv);
4607 SvPV_set(sv, Nullch);
4609 SvGROW(sv, len + 1);
4610 Move(pvx,SvPVX_const(sv),len,char);
4612 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4614 else if (IN_PERL_RUNTIME)
4615 Perl_croak(aTHX_ PL_no_modify);
4619 sv_unref_flags(sv, flags);
4620 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4625 =for apidoc sv_force_normal
4627 Undo various types of fakery on an SV: if the PV is a shared string, make
4628 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4629 an xpvmg. See also C<sv_force_normal_flags>.
4635 Perl_sv_force_normal(pTHX_ register SV *sv)
4637 sv_force_normal_flags(sv, 0);
4643 Efficient removal of characters from the beginning of the string buffer.
4644 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4645 the string buffer. The C<ptr> becomes the first character of the adjusted
4646 string. Uses the "OOK hack".
4647 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4648 refer to the same chunk of data.
4654 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4656 register STRLEN delta;
4657 if (!ptr || !SvPOKp(sv))
4659 delta = ptr - SvPVX_const(sv);
4660 SV_CHECK_THINKFIRST(sv);
4661 if (SvTYPE(sv) < SVt_PVIV)
4662 sv_upgrade(sv,SVt_PVIV);
4665 if (!SvLEN(sv)) { /* make copy of shared string */
4666 const char *pvx = SvPVX_const(sv);
4667 const STRLEN len = SvCUR(sv);
4668 SvGROW(sv, len + 1);
4669 Move(pvx,SvPVX_const(sv),len,char);
4673 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4674 and we do that anyway inside the SvNIOK_off
4676 SvFLAGS(sv) |= SVf_OOK;
4679 SvLEN_set(sv, SvLEN(sv) - delta);
4680 SvCUR_set(sv, SvCUR(sv) - delta);
4681 SvPV_set(sv, SvPVX(sv) + delta);
4682 SvIV_set(sv, SvIVX(sv) + delta);
4685 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4686 * this function provided for binary compatibility only
4690 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4692 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4696 =for apidoc sv_catpvn
4698 Concatenates the string onto the end of the string which is in the SV. The
4699 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4700 status set, then the bytes appended should be valid UTF-8.
4701 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4703 =for apidoc sv_catpvn_flags
4705 Concatenates the string onto the end of the string which is in the SV. The
4706 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4707 status set, then the bytes appended should be valid UTF-8.
4708 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4709 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4710 in terms of this function.
4716 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4719 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4721 SvGROW(dsv, dlen + slen + 1);
4723 sstr = SvPVX_const(dsv);
4724 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4725 SvCUR_set(dsv, SvCUR(dsv) + slen);
4727 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4732 =for apidoc sv_catpvn_mg
4734 Like C<sv_catpvn>, but also handles 'set' magic.
4740 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4742 sv_catpvn(sv,ptr,len);
4746 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4747 * this function provided for binary compatibility only
4751 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4753 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4757 =for apidoc sv_catsv
4759 Concatenates the string from SV C<ssv> onto the end of the string in
4760 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4761 not 'set' magic. See C<sv_catsv_mg>.
4763 =for apidoc sv_catsv_flags
4765 Concatenates the string from SV C<ssv> onto the end of the string in
4766 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4767 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4768 and C<sv_catsv_nomg> are implemented in terms of this function.
4773 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4779 if ((spv = SvPV_const(ssv, slen))) {
4780 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4781 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4782 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4783 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4784 dsv->sv_flags doesn't have that bit set.
4785 Andy Dougherty 12 Oct 2001
4787 const I32 sutf8 = DO_UTF8(ssv);
4790 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4792 dutf8 = DO_UTF8(dsv);
4794 if (dutf8 != sutf8) {
4796 /* Not modifying source SV, so taking a temporary copy. */
4797 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4799 sv_utf8_upgrade(csv);
4800 spv = SvPV_const(csv, slen);
4803 sv_utf8_upgrade_nomg(dsv);
4805 sv_catpvn_nomg(dsv, spv, slen);
4810 =for apidoc sv_catsv_mg
4812 Like C<sv_catsv>, but also handles 'set' magic.
4818 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4825 =for apidoc sv_catpv
4827 Concatenates the string onto the end of the string which is in the SV.
4828 If the SV has the UTF-8 status set, then the bytes appended should be
4829 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4834 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4836 register STRLEN len;
4842 junk = SvPV_force(sv, tlen);
4844 SvGROW(sv, tlen + len + 1);
4846 ptr = SvPVX_const(sv);
4847 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4848 SvCUR_set(sv, SvCUR(sv) + len);
4849 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4854 =for apidoc sv_catpv_mg
4856 Like C<sv_catpv>, but also handles 'set' magic.
4862 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4871 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4872 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4879 Perl_newSV(pTHX_ STRLEN len)
4885 sv_upgrade(sv, SVt_PV);
4886 SvGROW(sv, len + 1);
4891 =for apidoc sv_magicext
4893 Adds magic to an SV, upgrading it if necessary. Applies the
4894 supplied vtable and returns a pointer to the magic added.
4896 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4897 In particular, you can add magic to SvREADONLY SVs, and add more than
4898 one instance of the same 'how'.
4900 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4901 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4902 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4903 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4905 (This is now used as a subroutine by C<sv_magic>.)
4910 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4911 const char* name, I32 namlen)
4915 if (SvTYPE(sv) < SVt_PVMG) {
4916 SvUPGRADE(sv, SVt_PVMG);
4918 Newz(702,mg, 1, MAGIC);
4919 mg->mg_moremagic = SvMAGIC(sv);
4920 SvMAGIC_set(sv, mg);
4922 /* Sometimes a magic contains a reference loop, where the sv and
4923 object refer to each other. To prevent a reference loop that
4924 would prevent such objects being freed, we look for such loops
4925 and if we find one we avoid incrementing the object refcount.
4927 Note we cannot do this to avoid self-tie loops as intervening RV must
4928 have its REFCNT incremented to keep it in existence.
4931 if (!obj || obj == sv ||
4932 how == PERL_MAGIC_arylen ||
4933 how == PERL_MAGIC_qr ||
4934 how == PERL_MAGIC_symtab ||
4935 (SvTYPE(obj) == SVt_PVGV &&
4936 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4937 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4938 GvFORM(obj) == (CV*)sv)))
4943 mg->mg_obj = SvREFCNT_inc(obj);
4944 mg->mg_flags |= MGf_REFCOUNTED;
4947 /* Normal self-ties simply pass a null object, and instead of
4948 using mg_obj directly, use the SvTIED_obj macro to produce a
4949 new RV as needed. For glob "self-ties", we are tieing the PVIO
4950 with an RV obj pointing to the glob containing the PVIO. In
4951 this case, to avoid a reference loop, we need to weaken the
4955 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4956 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4962 mg->mg_len = namlen;
4965 mg->mg_ptr = savepvn(name, namlen);
4966 else if (namlen == HEf_SVKEY)
4967 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4969 mg->mg_ptr = (char *) name;
4971 mg->mg_virtual = vtable;
4975 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4980 =for apidoc sv_magic
4982 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4983 then adds a new magic item of type C<how> to the head of the magic list.
4985 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4986 handling of the C<name> and C<namlen> arguments.
4988 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4989 to add more than one instance of the same 'how'.
4995 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4997 const MGVTBL *vtable = 0;
5000 #ifdef PERL_OLD_COPY_ON_WRITE
5002 sv_force_normal_flags(sv, 0);
5004 if (SvREADONLY(sv)) {
5006 && how != PERL_MAGIC_regex_global
5007 && how != PERL_MAGIC_bm
5008 && how != PERL_MAGIC_fm
5009 && how != PERL_MAGIC_sv
5010 && how != PERL_MAGIC_backref
5013 Perl_croak(aTHX_ PL_no_modify);
5016 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5017 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5018 /* sv_magic() refuses to add a magic of the same 'how' as an
5021 if (how == PERL_MAGIC_taint)
5029 vtable = &PL_vtbl_sv;
5031 case PERL_MAGIC_overload:
5032 vtable = &PL_vtbl_amagic;
5034 case PERL_MAGIC_overload_elem:
5035 vtable = &PL_vtbl_amagicelem;
5037 case PERL_MAGIC_overload_table:
5038 vtable = &PL_vtbl_ovrld;
5041 vtable = &PL_vtbl_bm;
5043 case PERL_MAGIC_regdata:
5044 vtable = &PL_vtbl_regdata;
5046 case PERL_MAGIC_regdatum:
5047 vtable = &PL_vtbl_regdatum;
5049 case PERL_MAGIC_env:
5050 vtable = &PL_vtbl_env;
5053 vtable = &PL_vtbl_fm;
5055 case PERL_MAGIC_envelem:
5056 vtable = &PL_vtbl_envelem;
5058 case PERL_MAGIC_regex_global:
5059 vtable = &PL_vtbl_mglob;
5061 case PERL_MAGIC_isa:
5062 vtable = &PL_vtbl_isa;
5064 case PERL_MAGIC_isaelem:
5065 vtable = &PL_vtbl_isaelem;
5067 case PERL_MAGIC_nkeys:
5068 vtable = &PL_vtbl_nkeys;
5070 case PERL_MAGIC_dbfile:
5073 case PERL_MAGIC_dbline:
5074 vtable = &PL_vtbl_dbline;
5076 #ifdef USE_LOCALE_COLLATE
5077 case PERL_MAGIC_collxfrm:
5078 vtable = &PL_vtbl_collxfrm;
5080 #endif /* USE_LOCALE_COLLATE */
5081 case PERL_MAGIC_tied:
5082 vtable = &PL_vtbl_pack;
5084 case PERL_MAGIC_tiedelem:
5085 case PERL_MAGIC_tiedscalar:
5086 vtable = &PL_vtbl_packelem;
5089 vtable = &PL_vtbl_regexp;
5091 case PERL_MAGIC_sig:
5092 vtable = &PL_vtbl_sig;
5094 case PERL_MAGIC_sigelem:
5095 vtable = &PL_vtbl_sigelem;
5097 case PERL_MAGIC_taint:
5098 vtable = &PL_vtbl_taint;
5100 case PERL_MAGIC_uvar:
5101 vtable = &PL_vtbl_uvar;
5103 case PERL_MAGIC_vec:
5104 vtable = &PL_vtbl_vec;
5106 case PERL_MAGIC_arylen_p:
5107 case PERL_MAGIC_rhash:
5108 case PERL_MAGIC_symtab:
5109 case PERL_MAGIC_vstring:
5112 case PERL_MAGIC_utf8:
5113 vtable = &PL_vtbl_utf8;
5115 case PERL_MAGIC_substr:
5116 vtable = &PL_vtbl_substr;
5118 case PERL_MAGIC_defelem:
5119 vtable = &PL_vtbl_defelem;
5121 case PERL_MAGIC_glob:
5122 vtable = &PL_vtbl_glob;
5124 case PERL_MAGIC_arylen:
5125 vtable = &PL_vtbl_arylen;
5127 case PERL_MAGIC_pos:
5128 vtable = &PL_vtbl_pos;
5130 case PERL_MAGIC_backref:
5131 vtable = &PL_vtbl_backref;
5133 case PERL_MAGIC_ext:
5134 /* Reserved for use by extensions not perl internals. */
5135 /* Useful for attaching extension internal data to perl vars. */
5136 /* Note that multiple extensions may clash if magical scalars */
5137 /* etc holding private data from one are passed to another. */
5140 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5143 /* Rest of work is done else where */
5144 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5147 case PERL_MAGIC_taint:
5150 case PERL_MAGIC_ext:
5151 case PERL_MAGIC_dbfile:
5158 =for apidoc sv_unmagic
5160 Removes all magic of type C<type> from an SV.
5166 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5170 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5173 for (mg = *mgp; mg; mg = *mgp) {
5174 if (mg->mg_type == type) {
5175 const MGVTBL* const vtbl = mg->mg_virtual;
5176 *mgp = mg->mg_moremagic;
5177 if (vtbl && vtbl->svt_free)
5178 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5179 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5181 Safefree(mg->mg_ptr);
5182 else if (mg->mg_len == HEf_SVKEY)
5183 SvREFCNT_dec((SV*)mg->mg_ptr);
5184 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5185 Safefree(mg->mg_ptr);
5187 if (mg->mg_flags & MGf_REFCOUNTED)
5188 SvREFCNT_dec(mg->mg_obj);
5192 mgp = &mg->mg_moremagic;
5196 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5203 =for apidoc sv_rvweaken
5205 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5206 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5207 push a back-reference to this RV onto the array of backreferences
5208 associated with that magic.
5214 Perl_sv_rvweaken(pTHX_ SV *sv)
5217 if (!SvOK(sv)) /* let undefs pass */
5220 Perl_croak(aTHX_ "Can't weaken a nonreference");
5221 else if (SvWEAKREF(sv)) {
5222 if (ckWARN(WARN_MISC))
5223 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5227 sv_add_backref(tsv, sv);
5233 /* Give tsv backref magic if it hasn't already got it, then push a
5234 * back-reference to sv onto the array associated with the backref magic.
5238 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5242 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5243 av = (AV*)mg->mg_obj;
5246 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5247 /* av now has a refcnt of 2, which avoids it getting freed
5248 * before us during global cleanup. The extra ref is removed
5249 * by magic_killbackrefs() when tsv is being freed */
5251 if (AvFILLp(av) >= AvMAX(av)) {
5253 SV **svp = AvARRAY(av);
5254 for (i = AvFILLp(av); i >= 0; i--)
5256 svp[i] = sv; /* reuse the slot */
5259 av_extend(av, AvFILLp(av)+1);
5261 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5264 /* delete a back-reference to ourselves from the backref magic associated
5265 * with the SV we point to.
5269 S_sv_del_backref(pTHX_ SV *sv)
5276 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5277 Perl_croak(aTHX_ "panic: del_backref");
5278 av = (AV *)mg->mg_obj;
5280 for (i = AvFILLp(av); i >= 0; i--)
5281 if (svp[i] == sv) svp[i] = Nullsv;
5285 =for apidoc sv_insert
5287 Inserts a string at the specified offset/length within the SV. Similar to
5288 the Perl substr() function.
5294 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5298 register char *midend;
5299 register char *bigend;
5305 Perl_croak(aTHX_ "Can't modify non-existent substring");
5306 SvPV_force(bigstr, curlen);
5307 (void)SvPOK_only_UTF8(bigstr);
5308 if (offset + len > curlen) {
5309 SvGROW(bigstr, offset+len+1);
5310 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5311 SvCUR_set(bigstr, offset+len);
5315 i = littlelen - len;
5316 if (i > 0) { /* string might grow */
5317 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5318 mid = big + offset + len;
5319 midend = bigend = big + SvCUR(bigstr);
5322 while (midend > mid) /* shove everything down */
5323 *--bigend = *--midend;
5324 Move(little,big+offset,littlelen,char);
5325 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5330 Move(little,SvPVX(bigstr)+offset,len,char);
5335 big = SvPVX(bigstr);
5338 bigend = big + SvCUR(bigstr);
5340 if (midend > bigend)
5341 Perl_croak(aTHX_ "panic: sv_insert");
5343 if (mid - big > bigend - midend) { /* faster to shorten from end */
5345 Move(little, mid, littlelen,char);
5348 i = bigend - midend;
5350 Move(midend, mid, i,char);
5354 SvCUR_set(bigstr, mid - big);
5356 else if ((i = mid - big)) { /* faster from front */
5357 midend -= littlelen;
5359 sv_chop(bigstr,midend-i);
5364 Move(little, mid, littlelen,char);
5366 else if (littlelen) {
5367 midend -= littlelen;
5368 sv_chop(bigstr,midend);
5369 Move(little,midend,littlelen,char);
5372 sv_chop(bigstr,midend);
5378 =for apidoc sv_replace
5380 Make the first argument a copy of the second, then delete the original.
5381 The target SV physically takes over ownership of the body of the source SV
5382 and inherits its flags; however, the target keeps any magic it owns,
5383 and any magic in the source is discarded.
5384 Note that this is a rather specialist SV copying operation; most of the
5385 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5391 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5393 const U32 refcnt = SvREFCNT(sv);
5394 SV_CHECK_THINKFIRST_COW_DROP(sv);
5395 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5396 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5397 if (SvMAGICAL(sv)) {
5401 sv_upgrade(nsv, SVt_PVMG);
5402 SvMAGIC_set(nsv, SvMAGIC(sv));
5403 SvFLAGS(nsv) |= SvMAGICAL(sv);
5405 SvMAGIC_set(sv, NULL);
5409 assert(!SvREFCNT(sv));
5410 #ifdef DEBUG_LEAKING_SCALARS
5411 sv->sv_flags = nsv->sv_flags;
5412 sv->sv_any = nsv->sv_any;
5413 sv->sv_refcnt = nsv->sv_refcnt;
5414 sv->sv_u = nsv->sv_u;
5416 StructCopy(nsv,sv,SV);
5418 /* Currently could join these into one piece of pointer arithmetic, but
5419 it would be unclear. */
5420 if(SvTYPE(sv) == SVt_IV)
5422 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5423 else if (SvTYPE(sv) == SVt_RV) {
5424 SvANY(sv) = &sv->sv_u.svu_rv;
5428 #ifdef PERL_OLD_COPY_ON_WRITE
5429 if (SvIsCOW_normal(nsv)) {
5430 /* We need to follow the pointers around the loop to make the
5431 previous SV point to sv, rather than nsv. */
5434 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5437 assert(SvPVX_const(current) == SvPVX_const(nsv));
5439 /* Make the SV before us point to the SV after us. */
5441 PerlIO_printf(Perl_debug_log, "previous is\n");
5443 PerlIO_printf(Perl_debug_log,
5444 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5445 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5447 SV_COW_NEXT_SV_SET(current, sv);
5450 SvREFCNT(sv) = refcnt;
5451 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5457 =for apidoc sv_clear
5459 Clear an SV: call any destructors, free up any memory used by the body,
5460 and free the body itself. The SV's head is I<not> freed, although
5461 its type is set to all 1's so that it won't inadvertently be assumed
5462 to be live during global destruction etc.
5463 This function should only be called when REFCNT is zero. Most of the time
5464 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5471 Perl_sv_clear(pTHX_ register SV *sv)
5476 assert(SvREFCNT(sv) == 0);
5479 if (PL_defstash) { /* Still have a symbol table? */
5483 stash = SvSTASH(sv);
5484 destructor = StashHANDLER(stash,DESTROY);
5486 SV* tmpref = newRV(sv);
5487 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5489 PUSHSTACKi(PERLSI_DESTROY);
5494 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5500 if(SvREFCNT(tmpref) < 2) {
5501 /* tmpref is not kept alive! */
5503 SvRV_set(tmpref, NULL);
5506 SvREFCNT_dec(tmpref);
5508 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5512 if (PL_in_clean_objs)
5513 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5515 /* DESTROY gave object new lease on life */
5521 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5522 SvOBJECT_off(sv); /* Curse the object. */
5523 if (SvTYPE(sv) != SVt_PVIO)
5524 --PL_sv_objcount; /* XXX Might want something more general */
5527 if (SvTYPE(sv) >= SVt_PVMG) {
5530 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5531 SvREFCNT_dec(SvSTASH(sv));
5534 switch (SvTYPE(sv)) {
5537 IoIFP(sv) != PerlIO_stdin() &&
5538 IoIFP(sv) != PerlIO_stdout() &&
5539 IoIFP(sv) != PerlIO_stderr())
5541 io_close((IO*)sv, FALSE);
5543 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5544 PerlDir_close(IoDIRP(sv));
5545 IoDIRP(sv) = (DIR*)NULL;
5546 Safefree(IoTOP_NAME(sv));
5547 Safefree(IoFMT_NAME(sv));
5548 Safefree(IoBOTTOM_NAME(sv));
5563 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5564 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5565 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5566 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5568 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5569 SvREFCNT_dec(LvTARG(sv));
5573 Safefree(GvNAME(sv));
5574 /* cannot decrease stash refcount yet, as we might recursively delete
5575 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5576 of stash until current sv is completely gone.
5577 -- JohnPC, 27 Mar 1998 */
5578 stash = GvSTASH(sv);
5584 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5586 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5587 /* Don't even bother with turning off the OOK flag. */
5596 SvREFCNT_dec(SvRV(sv));
5598 #ifdef PERL_OLD_COPY_ON_WRITE
5599 else if (SvPVX_const(sv)) {
5601 /* I believe I need to grab the global SV mutex here and
5602 then recheck the COW status. */
5604 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5607 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5608 SV_COW_NEXT_SV(sv));
5609 /* And drop it here. */
5611 } else if (SvLEN(sv)) {
5612 Safefree(SvPVX_const(sv));
5616 else if (SvPVX_const(sv) && SvLEN(sv))
5617 Safefree(SvPVX_const(sv));
5618 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5619 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5632 switch (SvTYPE(sv)) {
5646 del_XPVIV(SvANY(sv));
5649 del_XPVNV(SvANY(sv));
5652 del_XPVMG(SvANY(sv));
5655 del_XPVLV(SvANY(sv));
5658 del_XPVAV(SvANY(sv));
5661 del_XPVHV(SvANY(sv));
5664 del_XPVCV(SvANY(sv));
5667 del_XPVGV(SvANY(sv));
5668 /* code duplication for increased performance. */
5669 SvFLAGS(sv) &= SVf_BREAK;
5670 SvFLAGS(sv) |= SVTYPEMASK;
5671 /* decrease refcount of the stash that owns this GV, if any */
5673 SvREFCNT_dec(stash);
5674 return; /* not break, SvFLAGS reset already happened */
5676 del_XPVBM(SvANY(sv));
5679 del_XPVFM(SvANY(sv));
5682 del_XPVIO(SvANY(sv));
5685 SvFLAGS(sv) &= SVf_BREAK;
5686 SvFLAGS(sv) |= SVTYPEMASK;
5690 =for apidoc sv_newref
5692 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5699 Perl_sv_newref(pTHX_ SV *sv)
5709 Decrement an SV's reference count, and if it drops to zero, call
5710 C<sv_clear> to invoke destructors and free up any memory used by
5711 the body; finally, deallocate the SV's head itself.
5712 Normally called via a wrapper macro C<SvREFCNT_dec>.
5718 Perl_sv_free(pTHX_ SV *sv)
5723 if (SvREFCNT(sv) == 0) {
5724 if (SvFLAGS(sv) & SVf_BREAK)
5725 /* this SV's refcnt has been artificially decremented to
5726 * trigger cleanup */
5728 if (PL_in_clean_all) /* All is fair */
5730 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5731 /* make sure SvREFCNT(sv)==0 happens very seldom */
5732 SvREFCNT(sv) = (~(U32)0)/2;
5735 if (ckWARN_d(WARN_INTERNAL))
5736 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5737 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5738 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5741 if (--(SvREFCNT(sv)) > 0)
5743 Perl_sv_free2(aTHX_ sv);
5747 Perl_sv_free2(pTHX_ SV *sv)
5752 if (ckWARN_d(WARN_DEBUGGING))
5753 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5754 "Attempt to free temp prematurely: SV 0x%"UVxf
5755 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5759 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5760 /* make sure SvREFCNT(sv)==0 happens very seldom */
5761 SvREFCNT(sv) = (~(U32)0)/2;
5772 Returns the length of the string in the SV. Handles magic and type
5773 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5779 Perl_sv_len(pTHX_ register SV *sv)
5787 len = mg_length(sv);
5789 (void)SvPV_const(sv, len);
5794 =for apidoc sv_len_utf8
5796 Returns the number of characters in the string in an SV, counting wide
5797 UTF-8 bytes as a single character. Handles magic and type coercion.
5803 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5804 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5805 * (Note that the mg_len is not the length of the mg_ptr field.)
5810 Perl_sv_len_utf8(pTHX_ register SV *sv)
5816 return mg_length(sv);
5820 const U8 *s = (U8*)SvPV_const(sv, len);
5821 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5823 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5825 #ifdef PERL_UTF8_CACHE_ASSERT
5826 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5830 ulen = Perl_utf8_length(aTHX_ s, s + len);
5831 if (!mg && !SvREADONLY(sv)) {
5832 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5833 mg = mg_find(sv, PERL_MAGIC_utf8);
5843 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5844 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5845 * between UTF-8 and byte offsets. There are two (substr offset and substr
5846 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5847 * and byte offset) cache positions.
5849 * The mg_len field is used by sv_len_utf8(), see its comments.
5850 * Note that the mg_len is not the length of the mg_ptr field.
5854 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5855 I32 offsetp, const U8 *s, const U8 *start)
5859 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5861 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5865 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5867 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5868 (*mgp)->mg_ptr = (char *) *cachep;
5872 (*cachep)[i] = offsetp;
5873 (*cachep)[i+1] = s - start;
5881 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5882 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5883 * between UTF-8 and byte offsets. See also the comments of
5884 * S_utf8_mg_pos_init().
5888 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)
5892 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5894 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5895 if (*mgp && (*mgp)->mg_ptr) {
5896 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5897 ASSERT_UTF8_CACHE(*cachep);
5898 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5900 else { /* We will skip to the right spot. */
5905 /* The assumption is that going backward is half
5906 * the speed of going forward (that's where the
5907 * 2 * backw in the below comes from). (The real
5908 * figure of course depends on the UTF-8 data.) */
5910 if ((*cachep)[i] > (STRLEN)uoff) {
5912 backw = (*cachep)[i] - (STRLEN)uoff;
5914 if (forw < 2 * backw)
5917 p = start + (*cachep)[i+1];
5919 /* Try this only for the substr offset (i == 0),
5920 * not for the substr length (i == 2). */
5921 else if (i == 0) { /* (*cachep)[i] < uoff */
5922 const STRLEN ulen = sv_len_utf8(sv);
5924 if ((STRLEN)uoff < ulen) {
5925 forw = (STRLEN)uoff - (*cachep)[i];
5926 backw = ulen - (STRLEN)uoff;
5928 if (forw < 2 * backw)
5929 p = start + (*cachep)[i+1];
5934 /* If the string is not long enough for uoff,
5935 * we could extend it, but not at this low a level. */
5939 if (forw < 2 * backw) {
5946 while (UTF8_IS_CONTINUATION(*p))
5951 /* Update the cache. */
5952 (*cachep)[i] = (STRLEN)uoff;
5953 (*cachep)[i+1] = p - start;
5955 /* Drop the stale "length" cache */
5964 if (found) { /* Setup the return values. */
5965 *offsetp = (*cachep)[i+1];
5966 *sp = start + *offsetp;
5969 *offsetp = send - start;
5971 else if (*sp < start) {
5977 #ifdef PERL_UTF8_CACHE_ASSERT
5982 while (n-- && s < send)
5986 assert(*offsetp == s - start);
5987 assert((*cachep)[0] == (STRLEN)uoff);
5988 assert((*cachep)[1] == *offsetp);
5990 ASSERT_UTF8_CACHE(*cachep);
5999 =for apidoc sv_pos_u2b
6001 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6002 the start of the string, to a count of the equivalent number of bytes; if
6003 lenp is non-zero, it does the same to lenp, but this time starting from
6004 the offset, rather than from the start of the string. Handles magic and
6011 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6012 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6013 * byte offsets. See also the comments of S_utf8_mg_pos().
6018 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6026 start = (U8*)SvPV_const(sv, len);
6030 const U8 *s = start;
6031 I32 uoffset = *offsetp;
6032 const U8 *send = s + len;
6036 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6038 if (!found && uoffset > 0) {
6039 while (s < send && uoffset--)
6043 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6045 *offsetp = s - start;
6050 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6054 if (!found && *lenp > 0) {
6057 while (s < send && ulen--)
6061 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6065 ASSERT_UTF8_CACHE(cache);
6077 =for apidoc sv_pos_b2u
6079 Converts the value pointed to by offsetp from a count of bytes from the
6080 start of the string, to a count of the equivalent number of UTF-8 chars.
6081 Handles magic and type coercion.
6087 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6088 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6089 * byte offsets. See also the comments of S_utf8_mg_pos().
6094 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6102 s = (const U8*)SvPV_const(sv, len);
6103 if ((I32)len < *offsetp)
6104 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6106 const U8* send = s + *offsetp;
6108 STRLEN *cache = NULL;
6112 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6113 mg = mg_find(sv, PERL_MAGIC_utf8);
6114 if (mg && mg->mg_ptr) {
6115 cache = (STRLEN *) mg->mg_ptr;
6116 if (cache[1] == (STRLEN)*offsetp) {
6117 /* An exact match. */
6118 *offsetp = cache[0];
6122 else if (cache[1] < (STRLEN)*offsetp) {
6123 /* We already know part of the way. */
6126 /* Let the below loop do the rest. */
6128 else { /* cache[1] > *offsetp */
6129 /* We already know all of the way, now we may
6130 * be able to walk back. The same assumption
6131 * is made as in S_utf8_mg_pos(), namely that
6132 * walking backward is twice slower than
6133 * walking forward. */
6134 STRLEN forw = *offsetp;
6135 STRLEN backw = cache[1] - *offsetp;
6137 if (!(forw < 2 * backw)) {
6138 const U8 *p = s + cache[1];
6145 while (UTF8_IS_CONTINUATION(*p)) {
6153 *offsetp = cache[0];
6155 /* Drop the stale "length" cache */
6163 ASSERT_UTF8_CACHE(cache);
6169 /* Call utf8n_to_uvchr() to validate the sequence
6170 * (unless a simple non-UTF character) */
6171 if (!UTF8_IS_INVARIANT(*s))
6172 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6181 if (!SvREADONLY(sv)) {
6183 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6184 mg = mg_find(sv, PERL_MAGIC_utf8);
6189 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6190 mg->mg_ptr = (char *) cache;
6195 cache[1] = *offsetp;
6196 /* Drop the stale "length" cache */
6209 Returns a boolean indicating whether the strings in the two SVs are
6210 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6211 coerce its args to strings if necessary.
6217 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6225 SV* svrecode = Nullsv;
6232 pv1 = SvPV_const(sv1, cur1);
6239 pv2 = SvPV_const(sv2, cur2);
6241 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6242 /* Differing utf8ness.
6243 * Do not UTF8size the comparands as a side-effect. */
6246 svrecode = newSVpvn(pv2, cur2);
6247 sv_recode_to_utf8(svrecode, PL_encoding);
6248 pv2 = SvPV_const(svrecode, cur2);
6251 svrecode = newSVpvn(pv1, cur1);
6252 sv_recode_to_utf8(svrecode, PL_encoding);
6253 pv1 = SvPV_const(svrecode, cur1);
6255 /* Now both are in UTF-8. */
6257 SvREFCNT_dec(svrecode);
6262 bool is_utf8 = TRUE;
6265 /* sv1 is the UTF-8 one,
6266 * if is equal it must be downgrade-able */
6267 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6273 /* sv2 is the UTF-8 one,
6274 * if is equal it must be downgrade-able */
6275 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6281 /* Downgrade not possible - cannot be eq */
6289 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6292 SvREFCNT_dec(svrecode);
6303 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6304 string in C<sv1> is less than, equal to, or greater than the string in
6305 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6306 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6312 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6315 const char *pv1, *pv2;
6318 SV *svrecode = Nullsv;
6325 pv1 = SvPV_const(sv1, cur1);
6332 pv2 = SvPV_const(sv2, cur2);
6334 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6335 /* Differing utf8ness.
6336 * Do not UTF8size the comparands as a side-effect. */
6339 svrecode = newSVpvn(pv2, cur2);
6340 sv_recode_to_utf8(svrecode, PL_encoding);
6341 pv2 = SvPV_const(svrecode, cur2);
6344 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6349 svrecode = newSVpvn(pv1, cur1);
6350 sv_recode_to_utf8(svrecode, PL_encoding);
6351 pv1 = SvPV_const(svrecode, cur1);
6354 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6360 cmp = cur2 ? -1 : 0;
6364 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6367 cmp = retval < 0 ? -1 : 1;
6368 } else if (cur1 == cur2) {
6371 cmp = cur1 < cur2 ? -1 : 1;
6376 SvREFCNT_dec(svrecode);
6385 =for apidoc sv_cmp_locale
6387 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6388 'use bytes' aware, handles get magic, and will coerce its args to strings
6389 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6395 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6397 #ifdef USE_LOCALE_COLLATE
6403 if (PL_collation_standard)
6407 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6409 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6411 if (!pv1 || !len1) {
6422 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6425 return retval < 0 ? -1 : 1;
6428 * When the result of collation is equality, that doesn't mean
6429 * that there are no differences -- some locales exclude some
6430 * characters from consideration. So to avoid false equalities,
6431 * we use the raw string as a tiebreaker.
6437 #endif /* USE_LOCALE_COLLATE */
6439 return sv_cmp(sv1, sv2);
6443 #ifdef USE_LOCALE_COLLATE
6446 =for apidoc sv_collxfrm
6448 Add Collate Transform magic to an SV if it doesn't already have it.
6450 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6451 scalar data of the variable, but transformed to such a format that a normal
6452 memory comparison can be used to compare the data according to the locale
6459 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6463 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6464 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6470 Safefree(mg->mg_ptr);
6471 s = SvPV_const(sv, len);
6472 if ((xf = mem_collxfrm(s, len, &xlen))) {
6473 if (SvREADONLY(sv)) {
6476 return xf + sizeof(PL_collation_ix);
6479 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6480 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6493 if (mg && mg->mg_ptr) {
6495 return mg->mg_ptr + sizeof(PL_collation_ix);
6503 #endif /* USE_LOCALE_COLLATE */
6508 Get a line from the filehandle and store it into the SV, optionally
6509 appending to the currently-stored string.
6515 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6519 register STDCHAR rslast;
6520 register STDCHAR *bp;
6526 if (SvTHINKFIRST(sv))
6527 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6528 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6530 However, perlbench says it's slower, because the existing swipe code
6531 is faster than copy on write.
6532 Swings and roundabouts. */
6533 SvUPGRADE(sv, SVt_PV);
6538 if (PerlIO_isutf8(fp)) {
6540 sv_utf8_upgrade_nomg(sv);
6541 sv_pos_u2b(sv,&append,0);
6543 } else if (SvUTF8(sv)) {
6544 SV *tsv = NEWSV(0,0);
6545 sv_gets(tsv, fp, 0);
6546 sv_utf8_upgrade_nomg(tsv);
6547 SvCUR_set(sv,append);
6550 goto return_string_or_null;
6555 if (PerlIO_isutf8(fp))
6558 if (IN_PERL_COMPILETIME) {
6559 /* we always read code in line mode */
6563 else if (RsSNARF(PL_rs)) {
6564 /* If it is a regular disk file use size from stat() as estimate
6565 of amount we are going to read - may result in malloc-ing
6566 more memory than we realy need if layers bellow reduce
6567 size we read (e.g. CRLF or a gzip layer)
6570 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6571 const Off_t offset = PerlIO_tell(fp);
6572 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6573 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6579 else if (RsRECORD(PL_rs)) {
6583 /* Grab the size of the record we're getting */
6584 recsize = SvIV(SvRV(PL_rs));
6585 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6588 /* VMS wants read instead of fread, because fread doesn't respect */
6589 /* RMS record boundaries. This is not necessarily a good thing to be */
6590 /* doing, but we've got no other real choice - except avoid stdio
6591 as implementation - perhaps write a :vms layer ?
6593 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6595 bytesread = PerlIO_read(fp, buffer, recsize);
6599 SvCUR_set(sv, bytesread += append);
6600 buffer[bytesread] = '\0';
6601 goto return_string_or_null;
6603 else if (RsPARA(PL_rs)) {
6609 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6610 if (PerlIO_isutf8(fp)) {
6611 rsptr = SvPVutf8(PL_rs, rslen);
6614 if (SvUTF8(PL_rs)) {
6615 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6616 Perl_croak(aTHX_ "Wide character in $/");
6619 rsptr = SvPV_const(PL_rs, rslen);
6623 rslast = rslen ? rsptr[rslen - 1] : '\0';
6625 if (rspara) { /* have to do this both before and after */
6626 do { /* to make sure file boundaries work right */
6629 i = PerlIO_getc(fp);
6633 PerlIO_ungetc(fp,i);
6639 /* See if we know enough about I/O mechanism to cheat it ! */
6641 /* This used to be #ifdef test - it is made run-time test for ease
6642 of abstracting out stdio interface. One call should be cheap
6643 enough here - and may even be a macro allowing compile
6647 if (PerlIO_fast_gets(fp)) {
6650 * We're going to steal some values from the stdio struct
6651 * and put EVERYTHING in the innermost loop into registers.
6653 register STDCHAR *ptr;
6657 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6658 /* An ungetc()d char is handled separately from the regular
6659 * buffer, so we getc() it back out and stuff it in the buffer.
6661 i = PerlIO_getc(fp);
6662 if (i == EOF) return 0;
6663 *(--((*fp)->_ptr)) = (unsigned char) i;
6667 /* Here is some breathtakingly efficient cheating */
6669 cnt = PerlIO_get_cnt(fp); /* get count into register */
6670 /* make sure we have the room */
6671 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6672 /* Not room for all of it
6673 if we are looking for a separator and room for some
6675 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6676 /* just process what we have room for */
6677 shortbuffered = cnt - SvLEN(sv) + append + 1;
6678 cnt -= shortbuffered;
6682 /* remember that cnt can be negative */
6683 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6688 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6689 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6690 DEBUG_P(PerlIO_printf(Perl_debug_log,
6691 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6692 DEBUG_P(PerlIO_printf(Perl_debug_log,
6693 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6694 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6695 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6700 while (cnt > 0) { /* this | eat */
6702 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6703 goto thats_all_folks; /* screams | sed :-) */
6707 Copy(ptr, bp, cnt, char); /* this | eat */
6708 bp += cnt; /* screams | dust */
6709 ptr += cnt; /* louder | sed :-) */
6714 if (shortbuffered) { /* oh well, must extend */
6715 cnt = shortbuffered;
6717 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6719 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6720 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6724 DEBUG_P(PerlIO_printf(Perl_debug_log,
6725 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6726 PTR2UV(ptr),(long)cnt));
6727 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6729 DEBUG_P(PerlIO_printf(Perl_debug_log,
6730 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6731 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6732 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6734 /* This used to call 'filbuf' in stdio form, but as that behaves like
6735 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6736 another abstraction. */
6737 i = PerlIO_getc(fp); /* get more characters */
6739 DEBUG_P(PerlIO_printf(Perl_debug_log,
6740 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6741 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6742 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6744 cnt = PerlIO_get_cnt(fp);
6745 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6746 DEBUG_P(PerlIO_printf(Perl_debug_log,
6747 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6749 if (i == EOF) /* all done for ever? */
6750 goto thats_really_all_folks;
6752 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6754 SvGROW(sv, bpx + cnt + 2);
6755 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6757 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6759 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6760 goto thats_all_folks;
6764 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6765 memNE((char*)bp - rslen, rsptr, rslen))
6766 goto screamer; /* go back to the fray */
6767 thats_really_all_folks:
6769 cnt += shortbuffered;
6770 DEBUG_P(PerlIO_printf(Perl_debug_log,
6771 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6772 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6773 DEBUG_P(PerlIO_printf(Perl_debug_log,
6774 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6775 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6776 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6778 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6779 DEBUG_P(PerlIO_printf(Perl_debug_log,
6780 "Screamer: done, len=%ld, string=|%.*s|\n",
6781 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6785 /*The big, slow, and stupid way. */
6786 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6788 New(0, buf, 8192, STDCHAR);
6796 const register STDCHAR *bpe = buf + sizeof(buf);
6798 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6799 ; /* keep reading */
6803 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6804 /* Accomodate broken VAXC compiler, which applies U8 cast to
6805 * both args of ?: operator, causing EOF to change into 255
6808 i = (U8)buf[cnt - 1];
6814 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6816 sv_catpvn(sv, (char *) buf, cnt);
6818 sv_setpvn(sv, (char *) buf, cnt);
6820 if (i != EOF && /* joy */
6822 SvCUR(sv) < rslen ||
6823 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6827 * If we're reading from a TTY and we get a short read,
6828 * indicating that the user hit his EOF character, we need
6829 * to notice it now, because if we try to read from the TTY
6830 * again, the EOF condition will disappear.
6832 * The comparison of cnt to sizeof(buf) is an optimization
6833 * that prevents unnecessary calls to feof().
6837 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6841 #ifdef USE_HEAP_INSTEAD_OF_STACK
6846 if (rspara) { /* have to do this both before and after */
6847 while (i != EOF) { /* to make sure file boundaries work right */
6848 i = PerlIO_getc(fp);
6850 PerlIO_ungetc(fp,i);
6856 return_string_or_null:
6857 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6863 Auto-increment of the value in the SV, doing string to numeric conversion
6864 if necessary. Handles 'get' magic.
6870 Perl_sv_inc(pTHX_ register SV *sv)
6879 if (SvTHINKFIRST(sv)) {
6881 sv_force_normal_flags(sv, 0);
6882 if (SvREADONLY(sv)) {
6883 if (IN_PERL_RUNTIME)
6884 Perl_croak(aTHX_ PL_no_modify);
6888 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6890 i = PTR2IV(SvRV(sv));
6895 flags = SvFLAGS(sv);
6896 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6897 /* It's (privately or publicly) a float, but not tested as an
6898 integer, so test it to see. */
6900 flags = SvFLAGS(sv);
6902 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6903 /* It's publicly an integer, or privately an integer-not-float */
6904 #ifdef PERL_PRESERVE_IVUV
6908 if (SvUVX(sv) == UV_MAX)
6909 sv_setnv(sv, UV_MAX_P1);
6911 (void)SvIOK_only_UV(sv);
6912 SvUV_set(sv, SvUVX(sv) + 1);
6914 if (SvIVX(sv) == IV_MAX)
6915 sv_setuv(sv, (UV)IV_MAX + 1);
6917 (void)SvIOK_only(sv);
6918 SvIV_set(sv, SvIVX(sv) + 1);
6923 if (flags & SVp_NOK) {
6924 (void)SvNOK_only(sv);
6925 SvNV_set(sv, SvNVX(sv) + 1.0);
6929 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6930 if ((flags & SVTYPEMASK) < SVt_PVIV)
6931 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6932 (void)SvIOK_only(sv);
6937 while (isALPHA(*d)) d++;
6938 while (isDIGIT(*d)) d++;
6940 #ifdef PERL_PRESERVE_IVUV
6941 /* Got to punt this as an integer if needs be, but we don't issue
6942 warnings. Probably ought to make the sv_iv_please() that does
6943 the conversion if possible, and silently. */
6944 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6945 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6946 /* Need to try really hard to see if it's an integer.
6947 9.22337203685478e+18 is an integer.
6948 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6949 so $a="9.22337203685478e+18"; $a+0; $a++
6950 needs to be the same as $a="9.22337203685478e+18"; $a++
6957 /* sv_2iv *should* have made this an NV */
6958 if (flags & SVp_NOK) {
6959 (void)SvNOK_only(sv);
6960 SvNV_set(sv, SvNVX(sv) + 1.0);
6963 /* I don't think we can get here. Maybe I should assert this
6964 And if we do get here I suspect that sv_setnv will croak. NWC
6966 #if defined(USE_LONG_DOUBLE)
6967 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",
6968 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6970 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6971 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6974 #endif /* PERL_PRESERVE_IVUV */
6975 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6979 while (d >= SvPVX_const(sv)) {
6987 /* MKS: The original code here died if letters weren't consecutive.
6988 * at least it didn't have to worry about non-C locales. The
6989 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6990 * arranged in order (although not consecutively) and that only
6991 * [A-Za-z] are accepted by isALPHA in the C locale.
6993 if (*d != 'z' && *d != 'Z') {
6994 do { ++*d; } while (!isALPHA(*d));
6997 *(d--) -= 'z' - 'a';
7002 *(d--) -= 'z' - 'a' + 1;
7006 /* oh,oh, the number grew */
7007 SvGROW(sv, SvCUR(sv) + 2);
7008 SvCUR_set(sv, SvCUR(sv) + 1);
7009 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7020 Auto-decrement of the value in the SV, doing string to numeric conversion
7021 if necessary. Handles 'get' magic.
7027 Perl_sv_dec(pTHX_ register SV *sv)
7035 if (SvTHINKFIRST(sv)) {
7037 sv_force_normal_flags(sv, 0);
7038 if (SvREADONLY(sv)) {
7039 if (IN_PERL_RUNTIME)
7040 Perl_croak(aTHX_ PL_no_modify);
7044 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7046 i = PTR2IV(SvRV(sv));
7051 /* Unlike sv_inc we don't have to worry about string-never-numbers
7052 and keeping them magic. But we mustn't warn on punting */
7053 flags = SvFLAGS(sv);
7054 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7055 /* It's publicly an integer, or privately an integer-not-float */
7056 #ifdef PERL_PRESERVE_IVUV
7060 if (SvUVX(sv) == 0) {
7061 (void)SvIOK_only(sv);
7065 (void)SvIOK_only_UV(sv);
7066 SvUV_set(sv, SvUVX(sv) + 1);
7069 if (SvIVX(sv) == IV_MIN)
7070 sv_setnv(sv, (NV)IV_MIN - 1.0);
7072 (void)SvIOK_only(sv);
7073 SvIV_set(sv, SvIVX(sv) - 1);
7078 if (flags & SVp_NOK) {
7079 SvNV_set(sv, SvNVX(sv) - 1.0);
7080 (void)SvNOK_only(sv);
7083 if (!(flags & SVp_POK)) {
7084 if ((flags & SVTYPEMASK) < SVt_PVNV)
7085 sv_upgrade(sv, SVt_NV);
7087 (void)SvNOK_only(sv);
7090 #ifdef PERL_PRESERVE_IVUV
7092 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7093 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7094 /* Need to try really hard to see if it's an integer.
7095 9.22337203685478e+18 is an integer.
7096 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7097 so $a="9.22337203685478e+18"; $a+0; $a--
7098 needs to be the same as $a="9.22337203685478e+18"; $a--
7105 /* sv_2iv *should* have made this an NV */
7106 if (flags & SVp_NOK) {
7107 (void)SvNOK_only(sv);
7108 SvNV_set(sv, SvNVX(sv) - 1.0);
7111 /* I don't think we can get here. Maybe I should assert this
7112 And if we do get here I suspect that sv_setnv will croak. NWC
7114 #if defined(USE_LONG_DOUBLE)
7115 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",
7116 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7118 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7119 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7123 #endif /* PERL_PRESERVE_IVUV */
7124 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7128 =for apidoc sv_mortalcopy
7130 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7131 The new SV is marked as mortal. It will be destroyed "soon", either by an
7132 explicit call to FREETMPS, or by an implicit call at places such as
7133 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7138 /* Make a string that will exist for the duration of the expression
7139 * evaluation. Actually, it may have to last longer than that, but
7140 * hopefully we won't free it until it has been assigned to a
7141 * permanent location. */
7144 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7149 sv_setsv(sv,oldstr);
7151 PL_tmps_stack[++PL_tmps_ix] = sv;
7157 =for apidoc sv_newmortal
7159 Creates a new null SV which is mortal. The reference count of the SV is
7160 set to 1. It will be destroyed "soon", either by an explicit call to
7161 FREETMPS, or by an implicit call at places such as statement boundaries.
7162 See also C<sv_mortalcopy> and C<sv_2mortal>.
7168 Perl_sv_newmortal(pTHX)
7173 SvFLAGS(sv) = SVs_TEMP;
7175 PL_tmps_stack[++PL_tmps_ix] = sv;
7180 =for apidoc sv_2mortal
7182 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7183 by an explicit call to FREETMPS, or by an implicit call at places such as
7184 statement boundaries. SvTEMP() is turned on which means that the SV's
7185 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7186 and C<sv_mortalcopy>.
7192 Perl_sv_2mortal(pTHX_ register SV *sv)
7197 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7200 PL_tmps_stack[++PL_tmps_ix] = sv;
7208 Creates a new SV and copies a string into it. The reference count for the
7209 SV is set to 1. If C<len> is zero, Perl will compute the length using
7210 strlen(). For efficiency, consider using C<newSVpvn> instead.
7216 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7221 sv_setpvn(sv,s,len ? len : strlen(s));
7226 =for apidoc newSVpvn
7228 Creates a new SV and copies a string into it. The reference count for the
7229 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7230 string. You are responsible for ensuring that the source string is at least
7231 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7237 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7242 sv_setpvn(sv,s,len);
7248 =for apidoc newSVhek
7250 Creates a new SV from the hash key structure. It will generate scalars that
7251 point to the shared string table where possible. Returns a new (undefined)
7252 SV if the hek is NULL.
7258 Perl_newSVhek(pTHX_ const HEK *hek)
7267 if (HEK_LEN(hek) == HEf_SVKEY) {
7268 return newSVsv(*(SV**)HEK_KEY(hek));
7270 const int flags = HEK_FLAGS(hek);
7271 if (flags & HVhek_WASUTF8) {
7273 Andreas would like keys he put in as utf8 to come back as utf8
7275 STRLEN utf8_len = HEK_LEN(hek);
7276 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7277 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7280 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7282 } else if (flags & HVhek_REHASH) {
7283 /* We don't have a pointer to the hv, so we have to replicate the
7284 flag into every HEK. This hv is using custom a hasing
7285 algorithm. Hence we can't return a shared string scalar, as
7286 that would contain the (wrong) hash value, and might get passed
7287 into an hv routine with a regular hash */
7289 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7294 /* This will be overwhelminly the most common case. */
7295 return newSVpvn_share(HEK_KEY(hek),
7296 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7302 =for apidoc newSVpvn_share
7304 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7305 table. If the string does not already exist in the table, it is created
7306 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7307 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7308 otherwise the hash is computed. The idea here is that as the string table
7309 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7310 hash lookup will avoid string compare.
7316 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7319 bool is_utf8 = FALSE;
7321 STRLEN tmplen = -len;
7323 /* See the note in hv.c:hv_fetch() --jhi */
7324 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7328 PERL_HASH(hash, src, len);
7330 sv_upgrade(sv, SVt_PV);
7331 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7343 #if defined(PERL_IMPLICIT_CONTEXT)
7345 /* pTHX_ magic can't cope with varargs, so this is a no-context
7346 * version of the main function, (which may itself be aliased to us).
7347 * Don't access this version directly.
7351 Perl_newSVpvf_nocontext(const char* pat, ...)
7356 va_start(args, pat);
7357 sv = vnewSVpvf(pat, &args);
7364 =for apidoc newSVpvf
7366 Creates a new SV and initializes it with the string formatted like
7373 Perl_newSVpvf(pTHX_ const char* pat, ...)
7377 va_start(args, pat);
7378 sv = vnewSVpvf(pat, &args);
7383 /* backend for newSVpvf() and newSVpvf_nocontext() */
7386 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7390 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7397 Creates a new SV and copies a floating point value into it.
7398 The reference count for the SV is set to 1.
7404 Perl_newSVnv(pTHX_ NV n)
7416 Creates a new SV and copies an integer into it. The reference count for the
7423 Perl_newSViv(pTHX_ IV i)
7435 Creates a new SV and copies an unsigned integer into it.
7436 The reference count for the SV is set to 1.
7442 Perl_newSVuv(pTHX_ UV u)
7452 =for apidoc newRV_noinc
7454 Creates an RV wrapper for an SV. The reference count for the original
7455 SV is B<not> incremented.
7461 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7466 sv_upgrade(sv, SVt_RV);
7468 SvRV_set(sv, tmpRef);
7473 /* newRV_inc is the official function name to use now.
7474 * newRV_inc is in fact #defined to newRV in sv.h
7478 Perl_newRV(pTHX_ SV *tmpRef)
7480 return newRV_noinc(SvREFCNT_inc(tmpRef));
7486 Creates a new SV which is an exact duplicate of the original SV.
7493 Perl_newSVsv(pTHX_ register SV *old)
7499 if (SvTYPE(old) == SVTYPEMASK) {
7500 if (ckWARN_d(WARN_INTERNAL))
7501 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7505 /* SV_GMAGIC is the default for sv_setv()
7506 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7507 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7508 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7513 =for apidoc sv_reset
7515 Underlying implementation for the C<reset> Perl function.
7516 Note that the perl-level function is vaguely deprecated.
7522 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7525 char todo[PERL_UCHAR_MAX+1];
7530 if (!*s) { /* reset ?? searches */
7531 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7533 PMOP *pm = (PMOP *) mg->mg_obj;
7535 pm->op_pmdynflags &= ~PMdf_USED;
7542 /* reset variables */
7544 if (!HvARRAY(stash))
7547 Zero(todo, 256, char);
7550 I32 i = (unsigned char)*s;
7554 max = (unsigned char)*s++;
7555 for ( ; i <= max; i++) {
7558 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7560 for (entry = HvARRAY(stash)[i];
7562 entry = HeNEXT(entry))
7567 if (!todo[(U8)*HeKEY(entry)])
7569 gv = (GV*)HeVAL(entry);
7571 if (SvTHINKFIRST(sv)) {
7572 if (!SvREADONLY(sv) && SvROK(sv))
7577 if (SvTYPE(sv) >= SVt_PV) {
7579 if (SvPVX_const(sv) != Nullch)
7586 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7589 #ifdef USE_ENVIRON_ARRAY
7591 # ifdef USE_ITHREADS
7592 && PL_curinterp == aTHX
7596 environ[0] = Nullch;
7599 #endif /* !PERL_MICRO */
7609 Using various gambits, try to get an IO from an SV: the IO slot if its a
7610 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7611 named after the PV if we're a string.
7617 Perl_sv_2io(pTHX_ SV *sv)
7622 switch (SvTYPE(sv)) {
7630 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7634 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7636 return sv_2io(SvRV(sv));
7637 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7643 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7652 Using various gambits, try to get a CV from an SV; in addition, try if
7653 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7659 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7666 return *gvp = Nullgv, Nullcv;
7667 switch (SvTYPE(sv)) {
7686 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7687 tryAMAGICunDEREF(to_cv);
7690 if (SvTYPE(sv) == SVt_PVCV) {
7699 Perl_croak(aTHX_ "Not a subroutine reference");
7704 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7710 if (lref && !GvCVu(gv)) {
7713 tmpsv = NEWSV(704,0);
7714 gv_efullname3(tmpsv, gv, Nullch);
7715 /* XXX this is probably not what they think they're getting.
7716 * It has the same effect as "sub name;", i.e. just a forward
7718 newSUB(start_subparse(FALSE, 0),
7719 newSVOP(OP_CONST, 0, tmpsv),
7724 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7734 Returns true if the SV has a true value by Perl's rules.
7735 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7736 instead use an in-line version.
7742 Perl_sv_true(pTHX_ register SV *sv)
7747 const register XPV* tXpv;
7748 if ((tXpv = (XPV*)SvANY(sv)) &&
7749 (tXpv->xpv_cur > 1 ||
7750 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7757 return SvIVX(sv) != 0;
7760 return SvNVX(sv) != 0.0;
7762 return sv_2bool(sv);
7770 A private implementation of the C<SvIVx> macro for compilers which can't
7771 cope with complex macro expressions. Always use the macro instead.
7777 Perl_sv_iv(pTHX_ register SV *sv)
7781 return (IV)SvUVX(sv);
7790 A private implementation of the C<SvUVx> macro for compilers which can't
7791 cope with complex macro expressions. Always use the macro instead.
7797 Perl_sv_uv(pTHX_ register SV *sv)
7802 return (UV)SvIVX(sv);
7810 A private implementation of the C<SvNVx> macro for compilers which can't
7811 cope with complex macro expressions. Always use the macro instead.
7817 Perl_sv_nv(pTHX_ register SV *sv)
7824 /* sv_pv() is now a macro using SvPV_nolen();
7825 * this function provided for binary compatibility only
7829 Perl_sv_pv(pTHX_ SV *sv)
7834 return sv_2pv(sv, 0);
7840 Use the C<SvPV_nolen> macro instead
7844 A private implementation of the C<SvPV> macro for compilers which can't
7845 cope with complex macro expressions. Always use the macro instead.
7851 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7857 return sv_2pv(sv, lp);
7862 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7868 return sv_2pv_flags(sv, lp, 0);
7871 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7872 * this function provided for binary compatibility only
7876 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7878 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7882 =for apidoc sv_pvn_force
7884 Get a sensible string out of the SV somehow.
7885 A private implementation of the C<SvPV_force> macro for compilers which
7886 can't cope with complex macro expressions. Always use the macro instead.
7888 =for apidoc sv_pvn_force_flags
7890 Get a sensible string out of the SV somehow.
7891 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7892 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7893 implemented in terms of this function.
7894 You normally want to use the various wrapper macros instead: see
7895 C<SvPV_force> and C<SvPV_force_nomg>
7901 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7904 if (SvTHINKFIRST(sv) && !SvROK(sv))
7905 sv_force_normal_flags(sv, 0);
7915 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7917 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7918 sv_reftype(sv,0), OP_NAME(PL_op));
7920 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
7923 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7924 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7928 s = sv_2pv_flags(sv, &len, flags);
7932 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7935 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7936 SvGROW(sv, len + 1);
7937 Move(s,SvPVX_const(sv),len,char);
7942 SvPOK_on(sv); /* validate pointer */
7944 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7945 PTR2UV(sv),SvPVX_const(sv)));
7948 return SvPVX_mutable(sv);
7951 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7952 * this function provided for binary compatibility only
7956 Perl_sv_pvbyte(pTHX_ SV *sv)
7958 sv_utf8_downgrade(sv,0);
7963 =for apidoc sv_pvbyte
7965 Use C<SvPVbyte_nolen> instead.
7967 =for apidoc sv_pvbyten
7969 A private implementation of the C<SvPVbyte> macro for compilers
7970 which can't cope with complex macro expressions. Always use the macro
7977 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7979 sv_utf8_downgrade(sv,0);
7980 return sv_pvn(sv,lp);
7984 =for apidoc sv_pvbyten_force
7986 A private implementation of the C<SvPVbytex_force> macro for compilers
7987 which can't cope with complex macro expressions. Always use the macro
7994 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7996 sv_pvn_force(sv,lp);
7997 sv_utf8_downgrade(sv,0);
8002 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8003 * this function provided for binary compatibility only
8007 Perl_sv_pvutf8(pTHX_ SV *sv)
8009 sv_utf8_upgrade(sv);
8014 =for apidoc sv_pvutf8
8016 Use the C<SvPVutf8_nolen> macro instead
8018 =for apidoc sv_pvutf8n
8020 A private implementation of the C<SvPVutf8> macro for compilers
8021 which can't cope with complex macro expressions. Always use the macro
8028 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8030 sv_utf8_upgrade(sv);
8031 return sv_pvn(sv,lp);
8035 =for apidoc sv_pvutf8n_force
8037 A private implementation of the C<SvPVutf8_force> macro for compilers
8038 which can't cope with complex macro expressions. Always use the macro
8045 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8047 sv_pvn_force(sv,lp);
8048 sv_utf8_upgrade(sv);
8054 =for apidoc sv_reftype
8056 Returns a string describing what the SV is a reference to.
8062 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8064 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8065 inside return suggests a const propagation bug in g++. */
8066 if (ob && SvOBJECT(sv)) {
8067 char *name = HvNAME_get(SvSTASH(sv));
8068 return name ? name : (char *) "__ANON__";
8071 switch (SvTYPE(sv)) {
8088 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8089 /* tied lvalues should appear to be
8090 * scalars for backwards compatitbility */
8091 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8092 ? "SCALAR" : "LVALUE");
8093 case SVt_PVAV: return "ARRAY";
8094 case SVt_PVHV: return "HASH";
8095 case SVt_PVCV: return "CODE";
8096 case SVt_PVGV: return "GLOB";
8097 case SVt_PVFM: return "FORMAT";
8098 case SVt_PVIO: return "IO";
8099 default: return "UNKNOWN";
8105 =for apidoc sv_isobject
8107 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8108 object. If the SV is not an RV, or if the object is not blessed, then this
8115 Perl_sv_isobject(pTHX_ SV *sv)
8132 Returns a boolean indicating whether the SV is blessed into the specified
8133 class. This does not check for subtypes; use C<sv_derived_from> to verify
8134 an inheritance relationship.
8140 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8152 hvname = HvNAME_get(SvSTASH(sv));
8156 return strEQ(hvname, name);
8162 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8163 it will be upgraded to one. If C<classname> is non-null then the new SV will
8164 be blessed in the specified package. The new SV is returned and its
8165 reference count is 1.
8171 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8177 SV_CHECK_THINKFIRST_COW_DROP(rv);
8180 if (SvTYPE(rv) >= SVt_PVMG) {
8181 const U32 refcnt = SvREFCNT(rv);
8185 SvREFCNT(rv) = refcnt;
8188 if (SvTYPE(rv) < SVt_RV)
8189 sv_upgrade(rv, SVt_RV);
8190 else if (SvTYPE(rv) > SVt_RV) {
8201 HV* stash = gv_stashpv(classname, TRUE);
8202 (void)sv_bless(rv, stash);
8208 =for apidoc sv_setref_pv
8210 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8211 argument will be upgraded to an RV. That RV will be modified to point to
8212 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8213 into the SV. The C<classname> argument indicates the package for the
8214 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8215 will have a reference count of 1, and the RV will be returned.
8217 Do not use with other Perl types such as HV, AV, SV, CV, because those
8218 objects will become corrupted by the pointer copy process.
8220 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8226 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8229 sv_setsv(rv, &PL_sv_undef);
8233 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8238 =for apidoc sv_setref_iv
8240 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8241 argument will be upgraded to an RV. That RV will be modified to point to
8242 the new SV. The C<classname> argument indicates the package for the
8243 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8244 will have a reference count of 1, and the RV will be returned.
8250 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8252 sv_setiv(newSVrv(rv,classname), iv);
8257 =for apidoc sv_setref_uv
8259 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8260 argument will be upgraded to an RV. That RV will be modified to point to
8261 the new SV. The C<classname> argument indicates the package for the
8262 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8263 will have a reference count of 1, and the RV will be returned.
8269 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8271 sv_setuv(newSVrv(rv,classname), uv);
8276 =for apidoc sv_setref_nv
8278 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8279 argument will be upgraded to an RV. That RV will be modified to point to
8280 the new SV. The C<classname> argument indicates the package for the
8281 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8282 will have a reference count of 1, and the RV will be returned.
8288 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8290 sv_setnv(newSVrv(rv,classname), nv);
8295 =for apidoc sv_setref_pvn
8297 Copies a string into a new SV, optionally blessing the SV. The length of the
8298 string must be specified with C<n>. The C<rv> argument will be upgraded to
8299 an RV. That RV will be modified to point to the new SV. The C<classname>
8300 argument indicates the package for the blessing. Set C<classname> to
8301 C<Nullch> to avoid the blessing. The new SV will have a reference count
8302 of 1, and the RV will be returned.
8304 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8310 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8312 sv_setpvn(newSVrv(rv,classname), pv, n);
8317 =for apidoc sv_bless
8319 Blesses an SV into a specified package. The SV must be an RV. The package
8320 must be designated by its stash (see C<gv_stashpv()>). The reference count
8321 of the SV is unaffected.
8327 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8331 Perl_croak(aTHX_ "Can't bless non-reference value");
8333 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8334 if (SvREADONLY(tmpRef))
8335 Perl_croak(aTHX_ PL_no_modify);
8336 if (SvOBJECT(tmpRef)) {
8337 if (SvTYPE(tmpRef) != SVt_PVIO)
8339 SvREFCNT_dec(SvSTASH(tmpRef));
8342 SvOBJECT_on(tmpRef);
8343 if (SvTYPE(tmpRef) != SVt_PVIO)
8345 SvUPGRADE(tmpRef, SVt_PVMG);
8346 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8353 if(SvSMAGICAL(tmpRef))
8354 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8362 /* Downgrades a PVGV to a PVMG.
8366 S_sv_unglob(pTHX_ SV *sv)
8370 assert(SvTYPE(sv) == SVt_PVGV);
8375 SvREFCNT_dec(GvSTASH(sv));
8376 GvSTASH(sv) = Nullhv;
8378 sv_unmagic(sv, PERL_MAGIC_glob);
8379 Safefree(GvNAME(sv));
8382 /* need to keep SvANY(sv) in the right arena */
8383 xpvmg = new_XPVMG();
8384 StructCopy(SvANY(sv), xpvmg, XPVMG);
8385 del_XPVGV(SvANY(sv));
8388 SvFLAGS(sv) &= ~SVTYPEMASK;
8389 SvFLAGS(sv) |= SVt_PVMG;
8393 =for apidoc sv_unref_flags
8395 Unsets the RV status of the SV, and decrements the reference count of
8396 whatever was being referenced by the RV. This can almost be thought of
8397 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8398 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8399 (otherwise the decrementing is conditional on the reference count being
8400 different from one or the reference being a readonly SV).
8407 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8411 if (SvWEAKREF(sv)) {
8419 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8420 assigned to as BEGIN {$a = \"Foo"} will fail. */
8421 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8423 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8424 sv_2mortal(rv); /* Schedule for freeing later */
8428 =for apidoc sv_unref
8430 Unsets the RV status of the SV, and decrements the reference count of
8431 whatever was being referenced by the RV. This can almost be thought of
8432 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8433 being zero. See C<SvROK_off>.
8439 Perl_sv_unref(pTHX_ SV *sv)
8441 sv_unref_flags(sv, 0);
8445 =for apidoc sv_taint
8447 Taint an SV. Use C<SvTAINTED_on> instead.
8452 Perl_sv_taint(pTHX_ SV *sv)
8454 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8458 =for apidoc sv_untaint
8460 Untaint an SV. Use C<SvTAINTED_off> instead.
8465 Perl_sv_untaint(pTHX_ SV *sv)
8467 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8468 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8475 =for apidoc sv_tainted
8477 Test an SV for taintedness. Use C<SvTAINTED> instead.
8482 Perl_sv_tainted(pTHX_ SV *sv)
8484 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8485 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8486 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8493 =for apidoc sv_setpviv
8495 Copies an integer into the given SV, also updating its string value.
8496 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8502 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8504 char buf[TYPE_CHARS(UV)];
8506 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8508 sv_setpvn(sv, ptr, ebuf - ptr);
8512 =for apidoc sv_setpviv_mg
8514 Like C<sv_setpviv>, but also handles 'set' magic.
8520 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8522 char buf[TYPE_CHARS(UV)];
8524 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8526 sv_setpvn(sv, ptr, ebuf - ptr);
8530 #if defined(PERL_IMPLICIT_CONTEXT)
8532 /* pTHX_ magic can't cope with varargs, so this is a no-context
8533 * version of the main function, (which may itself be aliased to us).
8534 * Don't access this version directly.
8538 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8542 va_start(args, pat);
8543 sv_vsetpvf(sv, pat, &args);
8547 /* pTHX_ magic can't cope with varargs, so this is a no-context
8548 * version of the main function, (which may itself be aliased to us).
8549 * Don't access this version directly.
8553 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8557 va_start(args, pat);
8558 sv_vsetpvf_mg(sv, pat, &args);
8564 =for apidoc sv_setpvf
8566 Works like C<sv_catpvf> but copies the text into the SV instead of
8567 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8573 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8576 va_start(args, pat);
8577 sv_vsetpvf(sv, pat, &args);
8582 =for apidoc sv_vsetpvf
8584 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8585 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8587 Usually used via its frontend C<sv_setpvf>.
8593 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8595 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8599 =for apidoc sv_setpvf_mg
8601 Like C<sv_setpvf>, but also handles 'set' magic.
8607 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8610 va_start(args, pat);
8611 sv_vsetpvf_mg(sv, pat, &args);
8616 =for apidoc sv_vsetpvf_mg
8618 Like C<sv_vsetpvf>, but also handles 'set' magic.
8620 Usually used via its frontend C<sv_setpvf_mg>.
8626 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8628 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8632 #if defined(PERL_IMPLICIT_CONTEXT)
8634 /* pTHX_ magic can't cope with varargs, so this is a no-context
8635 * version of the main function, (which may itself be aliased to us).
8636 * Don't access this version directly.
8640 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8644 va_start(args, pat);
8645 sv_vcatpvf(sv, pat, &args);
8649 /* pTHX_ magic can't cope with varargs, so this is a no-context
8650 * version of the main function, (which may itself be aliased to us).
8651 * Don't access this version directly.
8655 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8659 va_start(args, pat);
8660 sv_vcatpvf_mg(sv, pat, &args);
8666 =for apidoc sv_catpvf
8668 Processes its arguments like C<sprintf> and appends the formatted
8669 output to an SV. If the appended data contains "wide" characters
8670 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8671 and characters >255 formatted with %c), the original SV might get
8672 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8673 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8674 valid UTF-8; if the original SV was bytes, the pattern should be too.
8679 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8682 va_start(args, pat);
8683 sv_vcatpvf(sv, pat, &args);
8688 =for apidoc sv_vcatpvf
8690 Processes its arguments like C<vsprintf> and appends the formatted output
8691 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8693 Usually used via its frontend C<sv_catpvf>.
8699 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8701 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8705 =for apidoc sv_catpvf_mg
8707 Like C<sv_catpvf>, but also handles 'set' magic.
8713 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8716 va_start(args, pat);
8717 sv_vcatpvf_mg(sv, pat, &args);
8722 =for apidoc sv_vcatpvf_mg
8724 Like C<sv_vcatpvf>, but also handles 'set' magic.
8726 Usually used via its frontend C<sv_catpvf_mg>.
8732 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8734 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8739 =for apidoc sv_vsetpvfn
8741 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8744 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8750 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8752 sv_setpvn(sv, "", 0);
8753 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8756 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8759 S_expect_number(pTHX_ char** pattern)
8762 switch (**pattern) {
8763 case '1': case '2': case '3':
8764 case '4': case '5': case '6':
8765 case '7': case '8': case '9':
8766 while (isDIGIT(**pattern))
8767 var = var * 10 + (*(*pattern)++ - '0');
8771 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8774 F0convert(NV nv, char *endbuf, STRLEN *len)
8776 const int neg = nv < 0;
8785 if (uv & 1 && uv == nv)
8786 uv--; /* Round to even */
8788 const unsigned dig = uv % 10;
8801 =for apidoc sv_vcatpvfn
8803 Processes its arguments like C<vsprintf> and appends the formatted output
8804 to an SV. Uses an array of SVs if the C style variable argument list is
8805 missing (NULL). When running with taint checks enabled, indicates via
8806 C<maybe_tainted> if results are untrustworthy (often due to the use of
8809 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8814 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8817 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8824 static const char nullstr[] = "(null)";
8826 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8827 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8829 /* Times 4: a decimal digit takes more than 3 binary digits.
8830 * NV_DIG: mantissa takes than many decimal digits.
8831 * Plus 32: Playing safe. */
8832 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8833 /* large enough for "%#.#f" --chip */
8834 /* what about long double NVs? --jhi */
8836 PERL_UNUSED_ARG(maybe_tainted);
8838 /* no matter what, this is a string now */
8839 (void)SvPV_force(sv, origlen);
8841 /* special-case "", "%s", and "%-p" (SVf) */
8844 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8846 const char * const s = va_arg(*args, char*);
8847 sv_catpv(sv, s ? s : nullstr);
8849 else if (svix < svmax) {
8850 sv_catsv(sv, *svargs);
8851 if (DO_UTF8(*svargs))
8856 if (patlen == 3 && pat[0] == '%' &&
8857 pat[1] == '-' && pat[2] == 'p') {
8859 argsv = va_arg(*args, SV*);
8860 sv_catsv(sv, argsv);
8867 #ifndef USE_LONG_DOUBLE
8868 /* special-case "%.<number>[gf]" */
8869 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8870 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8871 unsigned digits = 0;
8875 while (*pp >= '0' && *pp <= '9')
8876 digits = 10 * digits + (*pp++ - '0');
8877 if (pp - pat == (int)patlen - 1) {
8881 nv = (NV)va_arg(*args, double);
8882 else if (svix < svmax)
8887 /* Add check for digits != 0 because it seems that some
8888 gconverts are buggy in this case, and we don't yet have
8889 a Configure test for this. */
8890 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8891 /* 0, point, slack */
8892 Gconvert(nv, (int)digits, 0, ebuf);
8894 if (*ebuf) /* May return an empty string for digits==0 */
8897 } else if (!digits) {
8900 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8901 sv_catpvn(sv, p, l);
8907 #endif /* !USE_LONG_DOUBLE */
8909 if (!args && svix < svmax && DO_UTF8(*svargs))
8912 patend = (char*)pat + patlen;
8913 for (p = (char*)pat; p < patend; p = q) {
8916 bool vectorize = FALSE;
8917 bool vectorarg = FALSE;
8918 bool vec_utf8 = FALSE;
8924 bool has_precis = FALSE;
8927 bool is_utf8 = FALSE; /* is this item utf8? */
8928 #ifdef HAS_LDBL_SPRINTF_BUG
8929 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8930 with sfio - Allen <allens@cpan.org> */
8931 bool fix_ldbl_sprintf_bug = FALSE;
8935 U8 utf8buf[UTF8_MAXBYTES+1];
8936 STRLEN esignlen = 0;
8938 const char *eptr = Nullch;
8941 const U8 *vecstr = Null(U8*);
8948 /* we need a long double target in case HAS_LONG_DOUBLE but
8951 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8959 const char *dotstr = ".";
8960 STRLEN dotstrlen = 1;
8961 I32 efix = 0; /* explicit format parameter index */
8962 I32 ewix = 0; /* explicit width index */
8963 I32 epix = 0; /* explicit precision index */
8964 I32 evix = 0; /* explicit vector index */
8965 bool asterisk = FALSE;
8967 /* echo everything up to the next format specification */
8968 for (q = p; q < patend && *q != '%'; ++q) ;
8970 if (has_utf8 && !pat_utf8)
8971 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8973 sv_catpvn(sv, p, q - p);
8980 We allow format specification elements in this order:
8981 \d+\$ explicit format parameter index
8983 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8984 0 flag (as above): repeated to allow "v02"
8985 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8986 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8988 [%bcdefginopsux_DFOUX] format (mandatory)
8990 if (EXPECT_NUMBER(q, width)) {
9031 if (EXPECT_NUMBER(q, ewix))
9040 if ((vectorarg = asterisk)) {
9052 EXPECT_NUMBER(q, width);
9057 vecsv = va_arg(*args, SV*);
9059 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9060 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9061 dotstr = SvPV_const(vecsv, dotstrlen);
9066 vecsv = va_arg(*args, SV*);
9067 vecstr = (U8*)SvPV_const(vecsv,veclen);
9068 vec_utf8 = DO_UTF8(vecsv);
9070 else if (efix ? efix <= svmax : svix < svmax) {
9071 vecsv = svargs[efix ? efix-1 : svix++];
9072 vecstr = (U8*)SvPV_const(vecsv,veclen);
9073 vec_utf8 = DO_UTF8(vecsv);
9074 /* if this is a version object, we need to return the
9075 * stringified representation (which the SvPVX_const has
9076 * already done for us), but not vectorize the args
9078 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9080 q++; /* skip past the rest of the %vd format */
9081 eptr = (const char *) vecstr;
9082 elen = strlen(eptr);
9095 i = va_arg(*args, int);
9097 i = (ewix ? ewix <= svmax : svix < svmax) ?
9098 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9100 width = (i < 0) ? -i : i;
9110 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9112 /* XXX: todo, support specified precision parameter */
9116 i = va_arg(*args, int);
9118 i = (ewix ? ewix <= svmax : svix < svmax)
9119 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9120 precis = (i < 0) ? 0 : i;
9125 precis = precis * 10 + (*q++ - '0');
9134 case 'I': /* Ix, I32x, and I64x */
9136 if (q[1] == '6' && q[2] == '4') {
9142 if (q[1] == '3' && q[2] == '2') {
9152 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9163 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9164 if (*(q + 1) == 'l') { /* lld, llf */
9189 argsv = (efix ? efix <= svmax : svix < svmax) ?
9190 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9197 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9199 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9201 eptr = (char*)utf8buf;
9202 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9213 if (args && !vectorize) {
9214 eptr = va_arg(*args, char*);
9216 #ifdef MACOS_TRADITIONAL
9217 /* On MacOS, %#s format is used for Pascal strings */
9222 elen = strlen(eptr);
9224 eptr = (char *)nullstr;
9225 elen = sizeof nullstr - 1;
9229 eptr = SvPVx_const(argsv, elen);
9230 if (DO_UTF8(argsv)) {
9231 if (has_precis && precis < elen) {
9233 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9236 if (width) { /* fudge width (can't fudge elen) */
9237 width += elen - sv_len_utf8(argsv);
9245 if (has_precis && elen > precis)
9252 if (left && args) { /* SVf */
9261 argsv = va_arg(*args, SV*);
9262 eptr = SvPVx_const(argsv, elen);
9267 if (alt || vectorize)
9269 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9287 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9296 esignbuf[esignlen++] = plus;
9300 case 'h': iv = (short)va_arg(*args, int); break;
9301 case 'l': iv = va_arg(*args, long); break;
9302 case 'V': iv = va_arg(*args, IV); break;
9303 default: iv = va_arg(*args, int); break;
9305 case 'q': iv = va_arg(*args, Quad_t); break;
9310 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9312 case 'h': iv = (short)tiv; break;
9313 case 'l': iv = (long)tiv; break;
9315 default: iv = tiv; break;
9317 case 'q': iv = (Quad_t)tiv; break;
9321 if ( !vectorize ) /* we already set uv above */
9326 esignbuf[esignlen++] = plus;
9330 esignbuf[esignlen++] = '-';
9373 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9384 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9385 case 'l': uv = va_arg(*args, unsigned long); break;
9386 case 'V': uv = va_arg(*args, UV); break;
9387 default: uv = va_arg(*args, unsigned); break;
9389 case 'q': uv = va_arg(*args, Uquad_t); break;
9394 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9396 case 'h': uv = (unsigned short)tuv; break;
9397 case 'l': uv = (unsigned long)tuv; break;
9399 default: uv = tuv; break;
9401 case 'q': uv = (Uquad_t)tuv; break;
9408 char *ptr = ebuf + sizeof ebuf;
9414 p = (char*)((c == 'X')
9415 ? "0123456789ABCDEF" : "0123456789abcdef");
9421 esignbuf[esignlen++] = '0';
9422 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9430 if (alt && *ptr != '0')
9439 esignbuf[esignlen++] = '0';
9440 esignbuf[esignlen++] = 'b';
9443 default: /* it had better be ten or less */
9447 } while (uv /= base);
9450 elen = (ebuf + sizeof ebuf) - ptr;
9454 zeros = precis - elen;
9455 else if (precis == 0 && elen == 1 && *eptr == '0')
9461 /* FLOATING POINT */
9464 c = 'f'; /* maybe %F isn't supported here */
9470 /* This is evil, but floating point is even more evil */
9472 /* for SV-style calling, we can only get NV
9473 for C-style calling, we assume %f is double;
9474 for simplicity we allow any of %Lf, %llf, %qf for long double
9478 #if defined(USE_LONG_DOUBLE)
9482 /* [perl #20339] - we should accept and ignore %lf rather than die */
9486 #if defined(USE_LONG_DOUBLE)
9487 intsize = args ? 0 : 'q';
9491 #if defined(HAS_LONG_DOUBLE)
9500 /* now we need (long double) if intsize == 'q', else (double) */
9501 nv = (args && !vectorize) ?
9502 #if LONG_DOUBLESIZE > DOUBLESIZE
9504 va_arg(*args, long double) :
9505 va_arg(*args, double)
9507 va_arg(*args, double)
9513 if (c != 'e' && c != 'E') {
9515 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9516 will cast our (long double) to (double) */
9517 (void)Perl_frexp(nv, &i);
9518 if (i == PERL_INT_MIN)
9519 Perl_die(aTHX_ "panic: frexp");
9521 need = BIT_DIGITS(i);
9523 need += has_precis ? precis : 6; /* known default */
9528 #ifdef HAS_LDBL_SPRINTF_BUG
9529 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9530 with sfio - Allen <allens@cpan.org> */
9533 # define MY_DBL_MAX DBL_MAX
9534 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9535 # if DOUBLESIZE >= 8
9536 # define MY_DBL_MAX 1.7976931348623157E+308L
9538 # define MY_DBL_MAX 3.40282347E+38L
9542 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9543 # define MY_DBL_MAX_BUG 1L
9545 # define MY_DBL_MAX_BUG MY_DBL_MAX
9549 # define MY_DBL_MIN DBL_MIN
9550 # else /* XXX guessing! -Allen */
9551 # if DOUBLESIZE >= 8
9552 # define MY_DBL_MIN 2.2250738585072014E-308L
9554 # define MY_DBL_MIN 1.17549435E-38L
9558 if ((intsize == 'q') && (c == 'f') &&
9559 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9561 /* it's going to be short enough that
9562 * long double precision is not needed */
9564 if ((nv <= 0L) && (nv >= -0L))
9565 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9567 /* would use Perl_fp_class as a double-check but not
9568 * functional on IRIX - see perl.h comments */
9570 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9571 /* It's within the range that a double can represent */
9572 #if defined(DBL_MAX) && !defined(DBL_MIN)
9573 if ((nv >= ((long double)1/DBL_MAX)) ||
9574 (nv <= (-(long double)1/DBL_MAX)))
9576 fix_ldbl_sprintf_bug = TRUE;
9579 if (fix_ldbl_sprintf_bug == TRUE) {
9589 # undef MY_DBL_MAX_BUG
9592 #endif /* HAS_LDBL_SPRINTF_BUG */
9594 need += 20; /* fudge factor */
9595 if (PL_efloatsize < need) {
9596 Safefree(PL_efloatbuf);
9597 PL_efloatsize = need + 20; /* more fudge */
9598 New(906, PL_efloatbuf, PL_efloatsize, char);
9599 PL_efloatbuf[0] = '\0';
9602 if ( !(width || left || plus || alt) && fill != '0'
9603 && has_precis && intsize != 'q' ) { /* Shortcuts */
9604 /* See earlier comment about buggy Gconvert when digits,
9606 if ( c == 'g' && precis) {
9607 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9608 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9609 goto float_converted;
9610 } else if ( c == 'f' && !precis) {
9611 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9616 char *ptr = ebuf + sizeof ebuf;
9619 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9620 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9621 if (intsize == 'q') {
9622 /* Copy the one or more characters in a long double
9623 * format before the 'base' ([efgEFG]) character to
9624 * the format string. */
9625 static char const prifldbl[] = PERL_PRIfldbl;
9626 char const *p = prifldbl + sizeof(prifldbl) - 3;
9627 while (p >= prifldbl) { *--ptr = *p--; }
9632 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9637 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9649 /* No taint. Otherwise we are in the strange situation
9650 * where printf() taints but print($float) doesn't.
9652 #if defined(HAS_LONG_DOUBLE)
9654 (void)sprintf(PL_efloatbuf, ptr, nv);
9656 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9658 (void)sprintf(PL_efloatbuf, ptr, nv);
9662 eptr = PL_efloatbuf;
9663 elen = strlen(PL_efloatbuf);
9669 i = SvCUR(sv) - origlen;
9670 if (args && !vectorize) {
9672 case 'h': *(va_arg(*args, short*)) = i; break;
9673 default: *(va_arg(*args, int*)) = i; break;
9674 case 'l': *(va_arg(*args, long*)) = i; break;
9675 case 'V': *(va_arg(*args, IV*)) = i; break;
9677 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9682 sv_setuv_mg(argsv, (UV)i);
9684 continue; /* not "break" */
9690 if (!args && ckWARN(WARN_PRINTF) &&
9691 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9692 SV *msg = sv_newmortal();
9693 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9694 (PL_op->op_type == OP_PRTF) ? "" : "s");
9697 Perl_sv_catpvf(aTHX_ msg,
9698 "\"%%%c\"", c & 0xFF);
9700 Perl_sv_catpvf(aTHX_ msg,
9701 "\"%%\\%03"UVof"\"",
9704 sv_catpv(msg, "end of string");
9705 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9708 /* output mangled stuff ... */
9714 /* ... right here, because formatting flags should not apply */
9715 SvGROW(sv, SvCUR(sv) + elen + 1);
9717 Copy(eptr, p, elen, char);
9720 SvCUR_set(sv, p - SvPVX_const(sv));
9722 continue; /* not "break" */
9725 /* calculate width before utf8_upgrade changes it */
9726 have = esignlen + zeros + elen;
9728 if (is_utf8 != has_utf8) {
9731 sv_utf8_upgrade(sv);
9734 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9735 sv_utf8_upgrade(nsv);
9736 eptr = SvPVX_const(nsv);
9739 SvGROW(sv, SvCUR(sv) + elen + 1);
9744 need = (have > width ? have : width);
9747 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9749 if (esignlen && fill == '0') {
9751 for (i = 0; i < (int)esignlen; i++)
9755 memset(p, fill, gap);
9758 if (esignlen && fill != '0') {
9760 for (i = 0; i < (int)esignlen; i++)
9765 for (i = zeros; i; i--)
9769 Copy(eptr, p, elen, char);
9773 memset(p, ' ', gap);
9778 Copy(dotstr, p, dotstrlen, char);
9782 vectorize = FALSE; /* done iterating over vecstr */
9789 SvCUR_set(sv, p - SvPVX_const(sv));
9797 /* =========================================================================
9799 =head1 Cloning an interpreter
9801 All the macros and functions in this section are for the private use of
9802 the main function, perl_clone().
9804 The foo_dup() functions make an exact copy of an existing foo thinngy.
9805 During the course of a cloning, a hash table is used to map old addresses
9806 to new addresses. The table is created and manipulated with the
9807 ptr_table_* functions.
9811 ============================================================================*/
9814 #if defined(USE_ITHREADS)
9816 #ifndef GpREFCNT_inc
9817 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9821 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9822 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9823 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9824 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9825 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9826 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9827 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9828 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9829 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9830 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9831 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9832 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9833 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9836 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9837 regcomp.c. AMS 20010712 */
9840 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9845 struct reg_substr_datum *s;
9848 return (REGEXP *)NULL;
9850 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9853 len = r->offsets[0];
9854 npar = r->nparens+1;
9856 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9857 Copy(r->program, ret->program, len+1, regnode);
9859 New(0, ret->startp, npar, I32);
9860 Copy(r->startp, ret->startp, npar, I32);
9861 New(0, ret->endp, npar, I32);
9862 Copy(r->startp, ret->startp, npar, I32);
9864 New(0, ret->substrs, 1, struct reg_substr_data);
9865 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9866 s->min_offset = r->substrs->data[i].min_offset;
9867 s->max_offset = r->substrs->data[i].max_offset;
9868 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9869 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9872 ret->regstclass = NULL;
9875 const int count = r->data->count;
9878 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9879 char, struct reg_data);
9880 New(0, d->what, count, U8);
9883 for (i = 0; i < count; i++) {
9884 d->what[i] = r->data->what[i];
9885 switch (d->what[i]) {
9886 /* legal options are one of: sfpont
9887 see also regcomp.h and pregfree() */
9889 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9892 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9895 /* This is cheating. */
9896 New(0, d->data[i], 1, struct regnode_charclass_class);
9897 StructCopy(r->data->data[i], d->data[i],
9898 struct regnode_charclass_class);
9899 ret->regstclass = (regnode*)d->data[i];
9902 /* Compiled op trees are readonly, and can thus be
9903 shared without duplication. */
9905 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9909 d->data[i] = r->data->data[i];
9912 d->data[i] = r->data->data[i];
9914 ((reg_trie_data*)d->data[i])->refcount++;
9918 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9927 New(0, ret->offsets, 2*len+1, U32);
9928 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9930 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9931 ret->refcnt = r->refcnt;
9932 ret->minlen = r->minlen;
9933 ret->prelen = r->prelen;
9934 ret->nparens = r->nparens;
9935 ret->lastparen = r->lastparen;
9936 ret->lastcloseparen = r->lastcloseparen;
9937 ret->reganch = r->reganch;
9939 ret->sublen = r->sublen;
9941 if (RX_MATCH_COPIED(ret))
9942 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9944 ret->subbeg = Nullch;
9945 #ifdef PERL_OLD_COPY_ON_WRITE
9946 ret->saved_copy = Nullsv;
9949 ptr_table_store(PL_ptr_table, r, ret);
9953 /* duplicate a file handle */
9956 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9960 PERL_UNUSED_ARG(type);
9963 return (PerlIO*)NULL;
9965 /* look for it in the table first */
9966 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9970 /* create anew and remember what it is */
9971 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9972 ptr_table_store(PL_ptr_table, fp, ret);
9976 /* duplicate a directory handle */
9979 Perl_dirp_dup(pTHX_ DIR *dp)
9987 /* duplicate a typeglob */
9990 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9995 /* look for it in the table first */
9996 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10000 /* create anew and remember what it is */
10001 Newz(0, ret, 1, GP);
10002 ptr_table_store(PL_ptr_table, gp, ret);
10005 ret->gp_refcnt = 0; /* must be before any other dups! */
10006 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10007 ret->gp_io = io_dup_inc(gp->gp_io, param);
10008 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10009 ret->gp_av = av_dup_inc(gp->gp_av, param);
10010 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10011 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10012 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10013 ret->gp_cvgen = gp->gp_cvgen;
10014 ret->gp_flags = gp->gp_flags;
10015 ret->gp_line = gp->gp_line;
10016 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10020 /* duplicate a chain of magic */
10023 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10025 MAGIC *mgprev = (MAGIC*)NULL;
10028 return (MAGIC*)NULL;
10029 /* look for it in the table first */
10030 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10034 for (; mg; mg = mg->mg_moremagic) {
10036 Newz(0, nmg, 1, MAGIC);
10038 mgprev->mg_moremagic = nmg;
10041 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10042 nmg->mg_private = mg->mg_private;
10043 nmg->mg_type = mg->mg_type;
10044 nmg->mg_flags = mg->mg_flags;
10045 if (mg->mg_type == PERL_MAGIC_qr) {
10046 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10048 else if(mg->mg_type == PERL_MAGIC_backref) {
10049 const AV * const av = (AV*) mg->mg_obj;
10052 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10054 for (i = AvFILLp(av); i >= 0; i--) {
10055 if (!svp[i]) continue;
10056 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10059 else if (mg->mg_type == PERL_MAGIC_symtab) {
10060 nmg->mg_obj = mg->mg_obj;
10063 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10064 ? sv_dup_inc(mg->mg_obj, param)
10065 : sv_dup(mg->mg_obj, param);
10067 nmg->mg_len = mg->mg_len;
10068 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10069 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10070 if (mg->mg_len > 0) {
10071 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10072 if (mg->mg_type == PERL_MAGIC_overload_table &&
10073 AMT_AMAGIC((AMT*)mg->mg_ptr))
10075 AMT *amtp = (AMT*)mg->mg_ptr;
10076 AMT *namtp = (AMT*)nmg->mg_ptr;
10078 for (i = 1; i < NofAMmeth; i++) {
10079 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10083 else if (mg->mg_len == HEf_SVKEY)
10084 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10086 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10087 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10094 /* create a new pointer-mapping table */
10097 Perl_ptr_table_new(pTHX)
10100 Newz(0, tbl, 1, PTR_TBL_t);
10101 tbl->tbl_max = 511;
10102 tbl->tbl_items = 0;
10103 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10108 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10110 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10113 #define new_pte() new_body(struct ptr_tbl_ent, pte)
10114 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
10116 /* map an existing pointer using a table */
10119 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10121 PTR_TBL_ENT_t *tblent;
10122 const UV hash = PTR_TABLE_HASH(sv);
10124 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10125 for (; tblent; tblent = tblent->next) {
10126 if (tblent->oldval == sv)
10127 return tblent->newval;
10129 return (void*)NULL;
10132 /* add a new entry to a pointer-mapping table */
10135 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldv, void *newv)
10137 PTR_TBL_ENT_t *tblent, **otblent;
10138 /* XXX this may be pessimal on platforms where pointers aren't good
10139 * hash values e.g. if they grow faster in the most significant
10141 const UV hash = PTR_TABLE_HASH(oldv);
10145 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10146 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10147 if (tblent->oldval == oldv) {
10148 tblent->newval = newv;
10152 tblent = new_pte();
10153 tblent->oldval = oldv;
10154 tblent->newval = newv;
10155 tblent->next = *otblent;
10158 if (!empty && tbl->tbl_items > tbl->tbl_max)
10159 ptr_table_split(tbl);
10162 /* double the hash bucket size of an existing ptr table */
10165 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10167 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10168 const UV oldsize = tbl->tbl_max + 1;
10169 UV newsize = oldsize * 2;
10172 Renew(ary, newsize, PTR_TBL_ENT_t*);
10173 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10174 tbl->tbl_max = --newsize;
10175 tbl->tbl_ary = ary;
10176 for (i=0; i < oldsize; i++, ary++) {
10177 PTR_TBL_ENT_t **curentp, **entp, *ent;
10180 curentp = ary + oldsize;
10181 for (entp = ary, ent = *ary; ent; ent = *entp) {
10182 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10184 ent->next = *curentp;
10194 /* remove all the entries from a ptr table */
10197 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10199 register PTR_TBL_ENT_t **array;
10200 register PTR_TBL_ENT_t *entry;
10204 if (!tbl || !tbl->tbl_items) {
10208 array = tbl->tbl_ary;
10210 max = tbl->tbl_max;
10214 PTR_TBL_ENT_t *oentry = entry;
10215 entry = entry->next;
10219 if (++riter > max) {
10222 entry = array[riter];
10226 tbl->tbl_items = 0;
10229 /* clear and free a ptr table */
10232 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10237 ptr_table_clear(tbl);
10238 Safefree(tbl->tbl_ary);
10242 /* attempt to make everything in the typeglob readonly */
10245 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10247 GV *gv = (GV*)sstr;
10248 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10250 if (GvIO(gv) || GvFORM(gv)) {
10251 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10253 else if (!GvCV(gv)) {
10254 GvCV(gv) = (CV*)sv;
10257 /* CvPADLISTs cannot be shared */
10258 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10263 if (!GvUNIQUE(gv)) {
10265 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10266 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10272 * write attempts will die with
10273 * "Modification of a read-only value attempted"
10279 SvREADONLY_on(GvSV(gv));
10283 GvAV(gv) = (AV*)sv;
10286 SvREADONLY_on(GvAV(gv));
10290 GvHV(gv) = (HV*)sv;
10293 SvREADONLY_on(GvHV(gv));
10296 return sstr; /* he_dup() will SvREFCNT_inc() */
10300 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10303 SvRV_set(dstr, SvWEAKREF(sstr)
10304 ? sv_dup(SvRV(sstr), param)
10305 : sv_dup_inc(SvRV(sstr), param));
10308 else if (SvPVX_const(sstr)) {
10309 /* Has something there */
10311 /* Normal PV - clone whole allocated space */
10312 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10313 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10314 /* Not that normal - actually sstr is copy on write.
10315 But we are a true, independant SV, so: */
10316 SvREADONLY_off(dstr);
10321 /* Special case - not normally malloced for some reason */
10322 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10323 /* A "shared" PV - clone it as "shared" PV */
10325 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10329 /* Some other special case - random pointer */
10330 SvPV_set(dstr, SvPVX(sstr));
10335 /* Copy the Null */
10336 if (SvTYPE(dstr) == SVt_RV)
10337 SvRV_set(dstr, NULL);
10343 /* duplicate an SV of any type (including AV, HV etc) */
10346 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10351 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10353 /* look for it in the table first */
10354 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10358 if(param->flags & CLONEf_JOIN_IN) {
10359 /** We are joining here so we don't want do clone
10360 something that is bad **/
10361 const char *hvname;
10363 if(SvTYPE(sstr) == SVt_PVHV &&
10364 (hvname = HvNAME_get(sstr))) {
10365 /** don't clone stashes if they already exist **/
10366 HV* old_stash = gv_stashpv(hvname,0);
10367 return (SV*) old_stash;
10371 /* create anew and remember what it is */
10374 #ifdef DEBUG_LEAKING_SCALARS
10375 dstr->sv_debug_optype = sstr->sv_debug_optype;
10376 dstr->sv_debug_line = sstr->sv_debug_line;
10377 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10378 dstr->sv_debug_cloned = 1;
10380 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10382 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10386 ptr_table_store(PL_ptr_table, sstr, dstr);
10389 SvFLAGS(dstr) = SvFLAGS(sstr);
10390 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10391 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10394 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10395 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10396 PL_watch_pvx, SvPVX_const(sstr));
10399 /* don't clone objects whose class has asked us not to */
10400 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10401 SvFLAGS(dstr) &= ~SVTYPEMASK;
10402 SvOBJECT_off(dstr);
10406 switch (SvTYPE(sstr)) {
10408 SvANY(dstr) = NULL;
10411 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10412 SvIV_set(dstr, SvIVX(sstr));
10415 SvANY(dstr) = new_XNV();
10416 SvNV_set(dstr, SvNVX(sstr));
10419 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10420 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10424 /* These are all the types that need complex bodies allocating. */
10425 size_t new_body_length;
10426 size_t new_body_offset = 0;
10427 void **new_body_arena;
10428 void **new_body_arenaroot;
10431 switch (SvTYPE(sstr)) {
10433 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10438 new_body = new_XPVIO();
10439 new_body_length = sizeof(XPVIO);
10442 new_body = new_XPVFM();
10443 new_body_length = sizeof(XPVFM);
10447 new_body_arena = (void **) &PL_xpvhv_root;
10448 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10449 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10450 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10451 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10452 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10456 new_body_arena = (void **) &PL_xpvav_root;
10457 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10458 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10459 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10460 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10461 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10465 new_body_length = sizeof(XPVBM);
10466 new_body_arena = (void **) &PL_xpvbm_root;
10467 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10470 if (GvUNIQUE((GV*)sstr)) {
10472 if ((share = gv_share(sstr, param))) {
10475 ptr_table_store(PL_ptr_table, sstr, dstr);
10477 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10478 HvNAME_get(GvSTASH(share)), GvNAME(share));
10483 new_body_length = sizeof(XPVGV);
10484 new_body_arena = (void **) &PL_xpvgv_root;
10485 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10488 new_body_length = sizeof(XPVCV);
10489 new_body_arena = (void **) &PL_xpvcv_root;
10490 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10493 new_body_length = sizeof(XPVLV);
10494 new_body_arena = (void **) &PL_xpvlv_root;
10495 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10498 new_body_length = sizeof(XPVMG);
10499 new_body_arena = (void **) &PL_xpvmg_root;
10500 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10503 new_body_length = sizeof(XPVNV);
10504 new_body_arena = (void **) &PL_xpvnv_root;
10505 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10508 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10509 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10510 new_body_length = sizeof(XPVIV) - new_body_offset;
10511 new_body_arena = (void **) &PL_xpviv_root;
10512 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10515 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10516 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10517 new_body_length = sizeof(XPV) - new_body_offset;
10518 new_body_arena = (void **) &PL_xpv_root;
10519 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10521 assert(new_body_length);
10523 new_body = (void*)((char*)S_new_body(aTHX_ new_body_arenaroot,
10526 - new_body_offset);
10528 /* We always allocated the full length item with PURIFY */
10529 new_body_length += new_body_offset;
10530 new_body_offset = 0;
10531 new_body = my_safemalloc(new_body_length);
10535 SvANY(dstr) = new_body;
10537 Copy(((char*)SvANY(sstr)) + new_body_offset,
10538 ((char*)SvANY(dstr)) + new_body_offset,
10539 new_body_length, char);
10541 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10542 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10544 /* The Copy above means that all the source (unduplicated) pointers
10545 are now in the destination. We can check the flags and the
10546 pointers in either, but it's possible that there's less cache
10547 missing by always going for the destination.
10548 FIXME - instrument and check that assumption */
10549 if (SvTYPE(sstr) >= SVt_PVMG) {
10551 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10553 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10556 switch (SvTYPE(sstr)) {
10568 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10569 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10570 LvTARG(dstr) = dstr;
10571 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10572 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10574 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10577 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10578 GvSTASH(dstr) = hv_dup_inc(GvSTASH(dstr), param);
10579 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10580 (void)GpREFCNT_inc(GvGP(dstr));
10583 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10584 if (IoOFP(dstr) == IoIFP(sstr))
10585 IoOFP(dstr) = IoIFP(dstr);
10587 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10588 /* PL_rsfp_filters entries have fake IoDIRP() */
10589 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10590 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10591 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10592 /* I have no idea why fake dirp (rsfps)
10593 should be treated differently but otherwise
10594 we end up with leaks -- sky*/
10595 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10596 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10597 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10599 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10600 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10601 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10603 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10604 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10605 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10608 if (AvARRAY((AV*)sstr)) {
10609 SV **dst_ary, **src_ary;
10610 SSize_t items = AvFILLp((AV*)sstr) + 1;
10612 src_ary = AvARRAY((AV*)sstr);
10613 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10614 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10615 SvPV_set(dstr, (char*)dst_ary);
10616 AvALLOC((AV*)dstr) = dst_ary;
10617 if (AvREAL((AV*)sstr)) {
10618 while (items-- > 0)
10619 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10622 while (items-- > 0)
10623 *dst_ary++ = sv_dup(*src_ary++, param);
10625 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10626 while (items-- > 0) {
10627 *dst_ary++ = &PL_sv_undef;
10631 SvPV_set(dstr, Nullch);
10632 AvALLOC((AV*)dstr) = (SV**)NULL;
10639 if (HvARRAY((HV*)sstr)) {
10641 const bool sharekeys = !!HvSHAREKEYS(sstr);
10642 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10643 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10646 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10647 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10649 HvARRAY(dstr) = (HE**)darray;
10650 while (i <= sxhv->xhv_max) {
10651 HE *source = HvARRAY(sstr)[i];
10652 HvARRAY(dstr)[i] = source
10653 ? he_dup(source, sharekeys, param) : 0;
10657 struct xpvhv_aux *saux = HvAUX(sstr);
10658 struct xpvhv_aux *daux = HvAUX(dstr);
10659 /* This flag isn't copied. */
10660 /* SvOOK_on(hv) attacks the IV flags. */
10661 SvFLAGS(dstr) |= SVf_OOK;
10663 hvname = saux->xhv_name;
10665 = hvname ? hek_dup(hvname, param) : hvname;
10667 daux->xhv_riter = saux->xhv_riter;
10668 daux->xhv_eiter = saux->xhv_eiter
10669 ? he_dup(saux->xhv_eiter,
10670 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10674 SvPV_set(dstr, Nullch);
10676 /* Record stashes for possible cloning in Perl_clone(). */
10678 av_push(param->stashes, dstr);
10683 /* NOTE: not refcounted */
10684 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10686 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10688 if (CvCONST(dstr)) {
10689 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10690 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10691 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10693 /* don't dup if copying back - CvGV isn't refcounted, so the
10694 * duped GV may never be freed. A bit of a hack! DAPM */
10695 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10696 Nullgv : gv_dup(CvGV(dstr), param) ;
10697 if (!(param->flags & CLONEf_COPY_STACKS)) {
10700 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10702 CvWEAKOUTSIDE(sstr)
10703 ? cv_dup( CvOUTSIDE(dstr), param)
10704 : cv_dup_inc(CvOUTSIDE(dstr), param);
10706 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10713 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10719 /* duplicate a context */
10722 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10724 PERL_CONTEXT *ncxs;
10727 return (PERL_CONTEXT*)NULL;
10729 /* look for it in the table first */
10730 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10734 /* create anew and remember what it is */
10735 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10736 ptr_table_store(PL_ptr_table, cxs, ncxs);
10739 PERL_CONTEXT *cx = &cxs[ix];
10740 PERL_CONTEXT *ncx = &ncxs[ix];
10741 ncx->cx_type = cx->cx_type;
10742 if (CxTYPE(cx) == CXt_SUBST) {
10743 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10746 ncx->blk_oldsp = cx->blk_oldsp;
10747 ncx->blk_oldcop = cx->blk_oldcop;
10748 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10749 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10750 ncx->blk_oldpm = cx->blk_oldpm;
10751 ncx->blk_gimme = cx->blk_gimme;
10752 switch (CxTYPE(cx)) {
10754 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10755 ? cv_dup_inc(cx->blk_sub.cv, param)
10756 : cv_dup(cx->blk_sub.cv,param));
10757 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10758 ? av_dup_inc(cx->blk_sub.argarray, param)
10760 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10761 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10762 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10763 ncx->blk_sub.lval = cx->blk_sub.lval;
10764 ncx->blk_sub.retop = cx->blk_sub.retop;
10767 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10768 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10769 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10770 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10771 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10772 ncx->blk_eval.retop = cx->blk_eval.retop;
10775 ncx->blk_loop.label = cx->blk_loop.label;
10776 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10777 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10778 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10779 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10780 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10781 ? cx->blk_loop.iterdata
10782 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10783 ncx->blk_loop.oldcomppad
10784 = (PAD*)ptr_table_fetch(PL_ptr_table,
10785 cx->blk_loop.oldcomppad);
10786 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10787 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10788 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10789 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10790 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10793 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10794 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10795 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10796 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10797 ncx->blk_sub.retop = cx->blk_sub.retop;
10809 /* duplicate a stack info structure */
10812 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10817 return (PERL_SI*)NULL;
10819 /* look for it in the table first */
10820 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10824 /* create anew and remember what it is */
10825 Newz(56, nsi, 1, PERL_SI);
10826 ptr_table_store(PL_ptr_table, si, nsi);
10828 nsi->si_stack = av_dup_inc(si->si_stack, param);
10829 nsi->si_cxix = si->si_cxix;
10830 nsi->si_cxmax = si->si_cxmax;
10831 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10832 nsi->si_type = si->si_type;
10833 nsi->si_prev = si_dup(si->si_prev, param);
10834 nsi->si_next = si_dup(si->si_next, param);
10835 nsi->si_markoff = si->si_markoff;
10840 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10841 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10842 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10843 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10844 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10845 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10846 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10847 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10848 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10849 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10850 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10851 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10852 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10853 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10856 #define pv_dup_inc(p) SAVEPV(p)
10857 #define pv_dup(p) SAVEPV(p)
10858 #define svp_dup_inc(p,pp) any_dup(p,pp)
10860 /* map any object to the new equivent - either something in the
10861 * ptr table, or something in the interpreter structure
10865 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10870 return (void*)NULL;
10872 /* look for it in the table first */
10873 ret = ptr_table_fetch(PL_ptr_table, v);
10877 /* see if it is part of the interpreter structure */
10878 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10879 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10887 /* duplicate the save stack */
10890 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10892 ANY * const ss = proto_perl->Tsavestack;
10893 const I32 max = proto_perl->Tsavestack_max;
10894 I32 ix = proto_perl->Tsavestack_ix;
10906 void (*dptr) (void*);
10907 void (*dxptr) (pTHX_ void*);
10909 Newz(54, nss, max, ANY);
10912 I32 i = POPINT(ss,ix);
10913 TOPINT(nss,ix) = i;
10915 case SAVEt_ITEM: /* normal string */
10916 sv = (SV*)POPPTR(ss,ix);
10917 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10918 sv = (SV*)POPPTR(ss,ix);
10919 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10921 case SAVEt_SV: /* scalar reference */
10922 sv = (SV*)POPPTR(ss,ix);
10923 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10924 gv = (GV*)POPPTR(ss,ix);
10925 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10927 case SAVEt_GENERIC_PVREF: /* generic char* */
10928 c = (char*)POPPTR(ss,ix);
10929 TOPPTR(nss,ix) = pv_dup(c);
10930 ptr = POPPTR(ss,ix);
10931 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10933 case SAVEt_SHARED_PVREF: /* char* in shared space */
10934 c = (char*)POPPTR(ss,ix);
10935 TOPPTR(nss,ix) = savesharedpv(c);
10936 ptr = POPPTR(ss,ix);
10937 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10939 case SAVEt_GENERIC_SVREF: /* generic sv */
10940 case SAVEt_SVREF: /* scalar reference */
10941 sv = (SV*)POPPTR(ss,ix);
10942 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10943 ptr = POPPTR(ss,ix);
10944 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10946 case SAVEt_AV: /* array reference */
10947 av = (AV*)POPPTR(ss,ix);
10948 TOPPTR(nss,ix) = av_dup_inc(av, param);
10949 gv = (GV*)POPPTR(ss,ix);
10950 TOPPTR(nss,ix) = gv_dup(gv, param);
10952 case SAVEt_HV: /* hash reference */
10953 hv = (HV*)POPPTR(ss,ix);
10954 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10955 gv = (GV*)POPPTR(ss,ix);
10956 TOPPTR(nss,ix) = gv_dup(gv, param);
10958 case SAVEt_INT: /* int reference */
10959 ptr = POPPTR(ss,ix);
10960 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10961 intval = (int)POPINT(ss,ix);
10962 TOPINT(nss,ix) = intval;
10964 case SAVEt_LONG: /* long reference */
10965 ptr = POPPTR(ss,ix);
10966 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10967 longval = (long)POPLONG(ss,ix);
10968 TOPLONG(nss,ix) = longval;
10970 case SAVEt_I32: /* I32 reference */
10971 case SAVEt_I16: /* I16 reference */
10972 case SAVEt_I8: /* I8 reference */
10973 ptr = POPPTR(ss,ix);
10974 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10976 TOPINT(nss,ix) = i;
10978 case SAVEt_IV: /* IV reference */
10979 ptr = POPPTR(ss,ix);
10980 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10982 TOPIV(nss,ix) = iv;
10984 case SAVEt_SPTR: /* SV* reference */
10985 ptr = POPPTR(ss,ix);
10986 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10987 sv = (SV*)POPPTR(ss,ix);
10988 TOPPTR(nss,ix) = sv_dup(sv, param);
10990 case SAVEt_VPTR: /* random* reference */
10991 ptr = POPPTR(ss,ix);
10992 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10993 ptr = POPPTR(ss,ix);
10994 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10996 case SAVEt_PPTR: /* char* reference */
10997 ptr = POPPTR(ss,ix);
10998 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10999 c = (char*)POPPTR(ss,ix);
11000 TOPPTR(nss,ix) = pv_dup(c);
11002 case SAVEt_HPTR: /* HV* reference */
11003 ptr = POPPTR(ss,ix);
11004 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11005 hv = (HV*)POPPTR(ss,ix);
11006 TOPPTR(nss,ix) = hv_dup(hv, param);
11008 case SAVEt_APTR: /* AV* reference */
11009 ptr = POPPTR(ss,ix);
11010 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11011 av = (AV*)POPPTR(ss,ix);
11012 TOPPTR(nss,ix) = av_dup(av, param);
11015 gv = (GV*)POPPTR(ss,ix);
11016 TOPPTR(nss,ix) = gv_dup(gv, param);
11018 case SAVEt_GP: /* scalar reference */
11019 gp = (GP*)POPPTR(ss,ix);
11020 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11021 (void)GpREFCNT_inc(gp);
11022 gv = (GV*)POPPTR(ss,ix);
11023 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11024 c = (char*)POPPTR(ss,ix);
11025 TOPPTR(nss,ix) = pv_dup(c);
11027 TOPIV(nss,ix) = iv;
11029 TOPIV(nss,ix) = iv;
11032 case SAVEt_MORTALIZESV:
11033 sv = (SV*)POPPTR(ss,ix);
11034 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11037 ptr = POPPTR(ss,ix);
11038 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11039 /* these are assumed to be refcounted properly */
11041 switch (((OP*)ptr)->op_type) {
11043 case OP_LEAVESUBLV:
11047 case OP_LEAVEWRITE:
11048 TOPPTR(nss,ix) = ptr;
11053 TOPPTR(nss,ix) = Nullop;
11058 TOPPTR(nss,ix) = Nullop;
11061 c = (char*)POPPTR(ss,ix);
11062 TOPPTR(nss,ix) = pv_dup_inc(c);
11064 case SAVEt_CLEARSV:
11065 longval = POPLONG(ss,ix);
11066 TOPLONG(nss,ix) = longval;
11069 hv = (HV*)POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11071 c = (char*)POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = pv_dup_inc(c);
11074 TOPINT(nss,ix) = i;
11076 case SAVEt_DESTRUCTOR:
11077 ptr = POPPTR(ss,ix);
11078 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11079 dptr = POPDPTR(ss,ix);
11080 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11081 any_dup(FPTR2DPTR(void *, dptr),
11084 case SAVEt_DESTRUCTOR_X:
11085 ptr = POPPTR(ss,ix);
11086 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11087 dxptr = POPDXPTR(ss,ix);
11088 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11089 any_dup(FPTR2DPTR(void *, dxptr),
11092 case SAVEt_REGCONTEXT:
11095 TOPINT(nss,ix) = i;
11098 case SAVEt_STACK_POS: /* Position on Perl stack */
11100 TOPINT(nss,ix) = i;
11102 case SAVEt_AELEM: /* array element */
11103 sv = (SV*)POPPTR(ss,ix);
11104 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11106 TOPINT(nss,ix) = i;
11107 av = (AV*)POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = av_dup_inc(av, param);
11110 case SAVEt_HELEM: /* hash element */
11111 sv = (SV*)POPPTR(ss,ix);
11112 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11113 sv = (SV*)POPPTR(ss,ix);
11114 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11115 hv = (HV*)POPPTR(ss,ix);
11116 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11119 ptr = POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = ptr;
11124 TOPINT(nss,ix) = i;
11126 case SAVEt_COMPPAD:
11127 av = (AV*)POPPTR(ss,ix);
11128 TOPPTR(nss,ix) = av_dup(av, param);
11131 longval = (long)POPLONG(ss,ix);
11132 TOPLONG(nss,ix) = longval;
11133 ptr = POPPTR(ss,ix);
11134 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11135 sv = (SV*)POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = sv_dup(sv, param);
11139 ptr = POPPTR(ss,ix);
11140 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11141 longval = (long)POPBOOL(ss,ix);
11142 TOPBOOL(nss,ix) = (bool)longval;
11144 case SAVEt_SET_SVFLAGS:
11146 TOPINT(nss,ix) = i;
11148 TOPINT(nss,ix) = i;
11149 sv = (SV*)POPPTR(ss,ix);
11150 TOPPTR(nss,ix) = sv_dup(sv, param);
11153 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11161 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11162 * flag to the result. This is done for each stash before cloning starts,
11163 * so we know which stashes want their objects cloned */
11166 do_mark_cloneable_stash(pTHX_ SV *sv)
11168 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11170 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11171 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11172 if (cloner && GvCV(cloner)) {
11179 XPUSHs(sv_2mortal(newSVhek(hvname)));
11181 call_sv((SV*)GvCV(cloner), G_SCALAR);
11188 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11196 =for apidoc perl_clone
11198 Create and return a new interpreter by cloning the current one.
11200 perl_clone takes these flags as parameters:
11202 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11203 without it we only clone the data and zero the stacks,
11204 with it we copy the stacks and the new perl interpreter is
11205 ready to run at the exact same point as the previous one.
11206 The pseudo-fork code uses COPY_STACKS while the
11207 threads->new doesn't.
11209 CLONEf_KEEP_PTR_TABLE
11210 perl_clone keeps a ptr_table with the pointer of the old
11211 variable as a key and the new variable as a value,
11212 this allows it to check if something has been cloned and not
11213 clone it again but rather just use the value and increase the
11214 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11215 the ptr_table using the function
11216 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11217 reason to keep it around is if you want to dup some of your own
11218 variable who are outside the graph perl scans, example of this
11219 code is in threads.xs create
11222 This is a win32 thing, it is ignored on unix, it tells perls
11223 win32host code (which is c++) to clone itself, this is needed on
11224 win32 if you want to run two threads at the same time,
11225 if you just want to do some stuff in a separate perl interpreter
11226 and then throw it away and return to the original one,
11227 you don't need to do anything.
11232 /* XXX the above needs expanding by someone who actually understands it ! */
11233 EXTERN_C PerlInterpreter *
11234 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11237 perl_clone(PerlInterpreter *proto_perl, UV flags)
11240 #ifdef PERL_IMPLICIT_SYS
11242 /* perlhost.h so we need to call into it
11243 to clone the host, CPerlHost should have a c interface, sky */
11245 if (flags & CLONEf_CLONE_HOST) {
11246 return perl_clone_host(proto_perl,flags);
11248 return perl_clone_using(proto_perl, flags,
11250 proto_perl->IMemShared,
11251 proto_perl->IMemParse,
11253 proto_perl->IStdIO,
11257 proto_perl->IProc);
11261 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11262 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11263 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11264 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11265 struct IPerlDir* ipD, struct IPerlSock* ipS,
11266 struct IPerlProc* ipP)
11268 /* XXX many of the string copies here can be optimized if they're
11269 * constants; they need to be allocated as common memory and just
11270 * their pointers copied. */
11273 CLONE_PARAMS clone_params;
11274 CLONE_PARAMS* param = &clone_params;
11276 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11277 /* for each stash, determine whether its objects should be cloned */
11278 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11279 PERL_SET_THX(my_perl);
11282 Poison(my_perl, 1, PerlInterpreter);
11284 PL_curcop = (COP *)Nullop;
11288 PL_savestack_ix = 0;
11289 PL_savestack_max = -1;
11290 PL_sig_pending = 0;
11291 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11292 # else /* !DEBUGGING */
11293 Zero(my_perl, 1, PerlInterpreter);
11294 # endif /* DEBUGGING */
11296 /* host pointers */
11298 PL_MemShared = ipMS;
11299 PL_MemParse = ipMP;
11306 #else /* !PERL_IMPLICIT_SYS */
11308 CLONE_PARAMS clone_params;
11309 CLONE_PARAMS* param = &clone_params;
11310 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11311 /* for each stash, determine whether its objects should be cloned */
11312 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11313 PERL_SET_THX(my_perl);
11316 Poison(my_perl, 1, PerlInterpreter);
11318 PL_curcop = (COP *)Nullop;
11322 PL_savestack_ix = 0;
11323 PL_savestack_max = -1;
11324 PL_sig_pending = 0;
11325 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11326 # else /* !DEBUGGING */
11327 Zero(my_perl, 1, PerlInterpreter);
11328 # endif /* DEBUGGING */
11329 #endif /* PERL_IMPLICIT_SYS */
11330 param->flags = flags;
11331 param->proto_perl = proto_perl;
11334 PL_xnv_arenaroot = NULL;
11335 PL_xnv_root = NULL;
11336 PL_xpv_arenaroot = NULL;
11337 PL_xpv_root = NULL;
11338 PL_xpviv_arenaroot = NULL;
11339 PL_xpviv_root = NULL;
11340 PL_xpvnv_arenaroot = NULL;
11341 PL_xpvnv_root = NULL;
11342 PL_xpvcv_arenaroot = NULL;
11343 PL_xpvcv_root = NULL;
11344 PL_xpvav_arenaroot = NULL;
11345 PL_xpvav_root = NULL;
11346 PL_xpvhv_arenaroot = NULL;
11347 PL_xpvhv_root = NULL;
11348 PL_xpvmg_arenaroot = NULL;
11349 PL_xpvmg_root = NULL;
11350 PL_xpvgv_arenaroot = NULL;
11351 PL_xpvgv_root = NULL;
11352 PL_xpvlv_arenaroot = NULL;
11353 PL_xpvlv_root = NULL;
11354 PL_xpvbm_arenaroot = NULL;
11355 PL_xpvbm_root = NULL;
11356 PL_he_arenaroot = NULL;
11358 #if defined(USE_ITHREADS)
11359 PL_pte_arenaroot = NULL;
11360 PL_pte_root = NULL;
11362 PL_nice_chunk = NULL;
11363 PL_nice_chunk_size = 0;
11365 PL_sv_objcount = 0;
11366 PL_sv_root = Nullsv;
11367 PL_sv_arenaroot = Nullsv;
11369 PL_debug = proto_perl->Idebug;
11371 PL_hash_seed = proto_perl->Ihash_seed;
11372 PL_rehash_seed = proto_perl->Irehash_seed;
11374 #ifdef USE_REENTRANT_API
11375 /* XXX: things like -Dm will segfault here in perlio, but doing
11376 * PERL_SET_CONTEXT(proto_perl);
11377 * breaks too many other things
11379 Perl_reentrant_init(aTHX);
11382 /* create SV map for pointer relocation */
11383 PL_ptr_table = ptr_table_new();
11385 /* initialize these special pointers as early as possible */
11386 SvANY(&PL_sv_undef) = NULL;
11387 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11388 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11389 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11391 SvANY(&PL_sv_no) = new_XPVNV();
11392 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11393 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11394 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11395 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11396 SvCUR_set(&PL_sv_no, 0);
11397 SvLEN_set(&PL_sv_no, 1);
11398 SvIV_set(&PL_sv_no, 0);
11399 SvNV_set(&PL_sv_no, 0);
11400 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11402 SvANY(&PL_sv_yes) = new_XPVNV();
11403 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11404 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11405 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11406 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11407 SvCUR_set(&PL_sv_yes, 1);
11408 SvLEN_set(&PL_sv_yes, 2);
11409 SvIV_set(&PL_sv_yes, 1);
11410 SvNV_set(&PL_sv_yes, 1);
11411 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11413 /* create (a non-shared!) shared string table */
11414 PL_strtab = newHV();
11415 HvSHAREKEYS_off(PL_strtab);
11416 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11417 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11419 PL_compiling = proto_perl->Icompiling;
11421 /* These two PVs will be free'd special way so must set them same way op.c does */
11422 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11423 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11425 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11426 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11428 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11429 if (!specialWARN(PL_compiling.cop_warnings))
11430 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11431 if (!specialCopIO(PL_compiling.cop_io))
11432 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11433 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11435 /* pseudo environmental stuff */
11436 PL_origargc = proto_perl->Iorigargc;
11437 PL_origargv = proto_perl->Iorigargv;
11439 param->stashes = newAV(); /* Setup array of objects to call clone on */
11441 #ifdef PERLIO_LAYERS
11442 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11443 PerlIO_clone(aTHX_ proto_perl, param);
11446 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11447 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11448 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11449 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11450 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11451 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11454 PL_minus_c = proto_perl->Iminus_c;
11455 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11456 PL_localpatches = proto_perl->Ilocalpatches;
11457 PL_splitstr = proto_perl->Isplitstr;
11458 PL_preprocess = proto_perl->Ipreprocess;
11459 PL_minus_n = proto_perl->Iminus_n;
11460 PL_minus_p = proto_perl->Iminus_p;
11461 PL_minus_l = proto_perl->Iminus_l;
11462 PL_minus_a = proto_perl->Iminus_a;
11463 PL_minus_F = proto_perl->Iminus_F;
11464 PL_doswitches = proto_perl->Idoswitches;
11465 PL_dowarn = proto_perl->Idowarn;
11466 PL_doextract = proto_perl->Idoextract;
11467 PL_sawampersand = proto_perl->Isawampersand;
11468 PL_unsafe = proto_perl->Iunsafe;
11469 PL_inplace = SAVEPV(proto_perl->Iinplace);
11470 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11471 PL_perldb = proto_perl->Iperldb;
11472 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11473 PL_exit_flags = proto_perl->Iexit_flags;
11475 /* magical thingies */
11476 /* XXX time(&PL_basetime) when asked for? */
11477 PL_basetime = proto_perl->Ibasetime;
11478 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11480 PL_maxsysfd = proto_perl->Imaxsysfd;
11481 PL_multiline = proto_perl->Imultiline;
11482 PL_statusvalue = proto_perl->Istatusvalue;
11484 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11486 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11488 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11489 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11490 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11492 /* Clone the regex array */
11493 PL_regex_padav = newAV();
11495 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11496 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11498 av_push(PL_regex_padav,
11499 sv_dup_inc(regexen[0],param));
11500 for(i = 1; i <= len; i++) {
11501 if(SvREPADTMP(regexen[i])) {
11502 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11504 av_push(PL_regex_padav,
11506 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11507 SvIVX(regexen[i])), param)))
11512 PL_regex_pad = AvARRAY(PL_regex_padav);
11514 /* shortcuts to various I/O objects */
11515 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11516 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11517 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11518 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11519 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11520 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11522 /* shortcuts to regexp stuff */
11523 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11525 /* shortcuts to misc objects */
11526 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11528 /* shortcuts to debugging objects */
11529 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11530 PL_DBline = gv_dup(proto_perl->IDBline, param);
11531 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11532 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11533 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11534 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11535 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11536 PL_lineary = av_dup(proto_perl->Ilineary, param);
11537 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11539 /* symbol tables */
11540 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11541 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11542 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11543 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11544 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11546 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11547 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11548 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11549 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11550 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11551 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11553 PL_sub_generation = proto_perl->Isub_generation;
11555 /* funky return mechanisms */
11556 PL_forkprocess = proto_perl->Iforkprocess;
11558 /* subprocess state */
11559 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11561 /* internal state */
11562 PL_tainting = proto_perl->Itainting;
11563 PL_taint_warn = proto_perl->Itaint_warn;
11564 PL_maxo = proto_perl->Imaxo;
11565 if (proto_perl->Iop_mask)
11566 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11568 PL_op_mask = Nullch;
11569 /* PL_asserting = proto_perl->Iasserting; */
11571 /* current interpreter roots */
11572 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11573 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11574 PL_main_start = proto_perl->Imain_start;
11575 PL_eval_root = proto_perl->Ieval_root;
11576 PL_eval_start = proto_perl->Ieval_start;
11578 /* runtime control stuff */
11579 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11580 PL_copline = proto_perl->Icopline;
11582 PL_filemode = proto_perl->Ifilemode;
11583 PL_lastfd = proto_perl->Ilastfd;
11584 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11587 PL_gensym = proto_perl->Igensym;
11588 PL_preambled = proto_perl->Ipreambled;
11589 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11590 PL_laststatval = proto_perl->Ilaststatval;
11591 PL_laststype = proto_perl->Ilaststype;
11592 PL_mess_sv = Nullsv;
11594 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11596 /* interpreter atexit processing */
11597 PL_exitlistlen = proto_perl->Iexitlistlen;
11598 if (PL_exitlistlen) {
11599 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11600 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11603 PL_exitlist = (PerlExitListEntry*)NULL;
11604 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11605 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11606 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11608 PL_profiledata = NULL;
11609 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11610 /* PL_rsfp_filters entries have fake IoDIRP() */
11611 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11613 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11615 PAD_CLONE_VARS(proto_perl, param);
11617 #ifdef HAVE_INTERP_INTERN
11618 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11621 /* more statics moved here */
11622 PL_generation = proto_perl->Igeneration;
11623 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11625 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11626 PL_in_clean_all = proto_perl->Iin_clean_all;
11628 PL_uid = proto_perl->Iuid;
11629 PL_euid = proto_perl->Ieuid;
11630 PL_gid = proto_perl->Igid;
11631 PL_egid = proto_perl->Iegid;
11632 PL_nomemok = proto_perl->Inomemok;
11633 PL_an = proto_perl->Ian;
11634 PL_evalseq = proto_perl->Ievalseq;
11635 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11636 PL_origalen = proto_perl->Iorigalen;
11637 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11638 PL_osname = SAVEPV(proto_perl->Iosname);
11639 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11640 PL_sighandlerp = proto_perl->Isighandlerp;
11643 PL_runops = proto_perl->Irunops;
11645 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11648 PL_cshlen = proto_perl->Icshlen;
11649 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11652 PL_lex_state = proto_perl->Ilex_state;
11653 PL_lex_defer = proto_perl->Ilex_defer;
11654 PL_lex_expect = proto_perl->Ilex_expect;
11655 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11656 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11657 PL_lex_starts = proto_perl->Ilex_starts;
11658 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11659 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11660 PL_lex_op = proto_perl->Ilex_op;
11661 PL_lex_inpat = proto_perl->Ilex_inpat;
11662 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11663 PL_lex_brackets = proto_perl->Ilex_brackets;
11664 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11665 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11666 PL_lex_casemods = proto_perl->Ilex_casemods;
11667 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11668 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11670 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11671 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11672 PL_nexttoke = proto_perl->Inexttoke;
11674 /* XXX This is probably masking the deeper issue of why
11675 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11676 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11677 * (A little debugging with a watchpoint on it may help.)
11679 if (SvANY(proto_perl->Ilinestr)) {
11680 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11681 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11682 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11683 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11684 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11685 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11686 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11687 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11688 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11691 PL_linestr = NEWSV(65,79);
11692 sv_upgrade(PL_linestr,SVt_PVIV);
11693 sv_setpvn(PL_linestr,"",0);
11694 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11696 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11697 PL_pending_ident = proto_perl->Ipending_ident;
11698 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11700 PL_expect = proto_perl->Iexpect;
11702 PL_multi_start = proto_perl->Imulti_start;
11703 PL_multi_end = proto_perl->Imulti_end;
11704 PL_multi_open = proto_perl->Imulti_open;
11705 PL_multi_close = proto_perl->Imulti_close;
11707 PL_error_count = proto_perl->Ierror_count;
11708 PL_subline = proto_perl->Isubline;
11709 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11711 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11712 if (SvANY(proto_perl->Ilinestr)) {
11713 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11714 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11715 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11716 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11717 PL_last_lop_op = proto_perl->Ilast_lop_op;
11720 PL_last_uni = SvPVX(PL_linestr);
11721 PL_last_lop = SvPVX(PL_linestr);
11722 PL_last_lop_op = 0;
11724 PL_in_my = proto_perl->Iin_my;
11725 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11727 PL_cryptseen = proto_perl->Icryptseen;
11730 PL_hints = proto_perl->Ihints;
11732 PL_amagic_generation = proto_perl->Iamagic_generation;
11734 #ifdef USE_LOCALE_COLLATE
11735 PL_collation_ix = proto_perl->Icollation_ix;
11736 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11737 PL_collation_standard = proto_perl->Icollation_standard;
11738 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11739 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11740 #endif /* USE_LOCALE_COLLATE */
11742 #ifdef USE_LOCALE_NUMERIC
11743 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11744 PL_numeric_standard = proto_perl->Inumeric_standard;
11745 PL_numeric_local = proto_perl->Inumeric_local;
11746 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11747 #endif /* !USE_LOCALE_NUMERIC */
11749 /* utf8 character classes */
11750 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11751 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11752 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11753 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11754 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11755 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11756 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11757 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11758 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11759 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11760 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11761 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11762 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11763 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11764 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11765 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11766 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11767 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11768 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11769 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11771 /* Did the locale setup indicate UTF-8? */
11772 PL_utf8locale = proto_perl->Iutf8locale;
11773 /* Unicode features (see perlrun/-C) */
11774 PL_unicode = proto_perl->Iunicode;
11776 /* Pre-5.8 signals control */
11777 PL_signals = proto_perl->Isignals;
11779 /* times() ticks per second */
11780 PL_clocktick = proto_perl->Iclocktick;
11782 /* Recursion stopper for PerlIO_find_layer */
11783 PL_in_load_module = proto_perl->Iin_load_module;
11785 /* sort() routine */
11786 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11788 /* Not really needed/useful since the reenrant_retint is "volatile",
11789 * but do it for consistency's sake. */
11790 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11792 /* Hooks to shared SVs and locks. */
11793 PL_sharehook = proto_perl->Isharehook;
11794 PL_lockhook = proto_perl->Ilockhook;
11795 PL_unlockhook = proto_perl->Iunlockhook;
11796 PL_threadhook = proto_perl->Ithreadhook;
11798 PL_runops_std = proto_perl->Irunops_std;
11799 PL_runops_dbg = proto_perl->Irunops_dbg;
11801 #ifdef THREADS_HAVE_PIDS
11802 PL_ppid = proto_perl->Ippid;
11806 PL_last_swash_hv = Nullhv; /* reinits on demand */
11807 PL_last_swash_klen = 0;
11808 PL_last_swash_key[0]= '\0';
11809 PL_last_swash_tmps = (U8*)NULL;
11810 PL_last_swash_slen = 0;
11812 PL_glob_index = proto_perl->Iglob_index;
11813 PL_srand_called = proto_perl->Isrand_called;
11814 PL_uudmap['M'] = 0; /* reinits on demand */
11815 PL_bitcount = Nullch; /* reinits on demand */
11817 if (proto_perl->Ipsig_pend) {
11818 Newz(0, PL_psig_pend, SIG_SIZE, int);
11821 PL_psig_pend = (int*)NULL;
11824 if (proto_perl->Ipsig_ptr) {
11825 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11826 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11827 for (i = 1; i < SIG_SIZE; i++) {
11828 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11829 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11833 PL_psig_ptr = (SV**)NULL;
11834 PL_psig_name = (SV**)NULL;
11837 /* thrdvar.h stuff */
11839 if (flags & CLONEf_COPY_STACKS) {
11840 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11841 PL_tmps_ix = proto_perl->Ttmps_ix;
11842 PL_tmps_max = proto_perl->Ttmps_max;
11843 PL_tmps_floor = proto_perl->Ttmps_floor;
11844 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11846 while (i <= PL_tmps_ix) {
11847 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11851 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11852 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11853 Newz(54, PL_markstack, i, I32);
11854 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11855 - proto_perl->Tmarkstack);
11856 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11857 - proto_perl->Tmarkstack);
11858 Copy(proto_perl->Tmarkstack, PL_markstack,
11859 PL_markstack_ptr - PL_markstack + 1, I32);
11861 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11862 * NOTE: unlike the others! */
11863 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11864 PL_scopestack_max = proto_perl->Tscopestack_max;
11865 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11866 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11868 /* NOTE: si_dup() looks at PL_markstack */
11869 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11871 /* PL_curstack = PL_curstackinfo->si_stack; */
11872 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11873 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11875 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11876 PL_stack_base = AvARRAY(PL_curstack);
11877 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11878 - proto_perl->Tstack_base);
11879 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11881 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11882 * NOTE: unlike the others! */
11883 PL_savestack_ix = proto_perl->Tsavestack_ix;
11884 PL_savestack_max = proto_perl->Tsavestack_max;
11885 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11886 PL_savestack = ss_dup(proto_perl, param);
11890 ENTER; /* perl_destruct() wants to LEAVE; */
11893 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11894 PL_top_env = &PL_start_env;
11896 PL_op = proto_perl->Top;
11899 PL_Xpv = (XPV*)NULL;
11900 PL_na = proto_perl->Tna;
11902 PL_statbuf = proto_perl->Tstatbuf;
11903 PL_statcache = proto_perl->Tstatcache;
11904 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11905 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11907 PL_timesbuf = proto_perl->Ttimesbuf;
11910 PL_tainted = proto_perl->Ttainted;
11911 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11912 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11913 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11914 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11915 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11916 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11917 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11918 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11919 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11921 PL_restartop = proto_perl->Trestartop;
11922 PL_in_eval = proto_perl->Tin_eval;
11923 PL_delaymagic = proto_perl->Tdelaymagic;
11924 PL_dirty = proto_perl->Tdirty;
11925 PL_localizing = proto_perl->Tlocalizing;
11927 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11928 PL_hv_fetch_ent_mh = Nullhe;
11929 PL_modcount = proto_perl->Tmodcount;
11930 PL_lastgotoprobe = Nullop;
11931 PL_dumpindent = proto_perl->Tdumpindent;
11933 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11934 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11935 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11936 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11937 PL_sortcxix = proto_perl->Tsortcxix;
11938 PL_efloatbuf = Nullch; /* reinits on demand */
11939 PL_efloatsize = 0; /* reinits on demand */
11943 PL_screamfirst = NULL;
11944 PL_screamnext = NULL;
11945 PL_maxscream = -1; /* reinits on demand */
11946 PL_lastscream = Nullsv;
11948 PL_watchaddr = NULL;
11949 PL_watchok = Nullch;
11951 PL_regdummy = proto_perl->Tregdummy;
11952 PL_regprecomp = Nullch;
11955 PL_colorset = 0; /* reinits PL_colors[] */
11956 /*PL_colors[6] = {0,0,0,0,0,0};*/
11957 PL_reginput = Nullch;
11958 PL_regbol = Nullch;
11959 PL_regeol = Nullch;
11960 PL_regstartp = (I32*)NULL;
11961 PL_regendp = (I32*)NULL;
11962 PL_reglastparen = (U32*)NULL;
11963 PL_reglastcloseparen = (U32*)NULL;
11964 PL_regtill = Nullch;
11965 PL_reg_start_tmp = (char**)NULL;
11966 PL_reg_start_tmpl = 0;
11967 PL_regdata = (struct reg_data*)NULL;
11970 PL_reg_eval_set = 0;
11972 PL_regprogram = (regnode*)NULL;
11974 PL_regcc = (CURCUR*)NULL;
11975 PL_reg_call_cc = (struct re_cc_state*)NULL;
11976 PL_reg_re = (regexp*)NULL;
11977 PL_reg_ganch = Nullch;
11978 PL_reg_sv = Nullsv;
11979 PL_reg_match_utf8 = FALSE;
11980 PL_reg_magic = (MAGIC*)NULL;
11982 PL_reg_oldcurpm = (PMOP*)NULL;
11983 PL_reg_curpm = (PMOP*)NULL;
11984 PL_reg_oldsaved = Nullch;
11985 PL_reg_oldsavedlen = 0;
11986 #ifdef PERL_OLD_COPY_ON_WRITE
11989 PL_reg_maxiter = 0;
11990 PL_reg_leftiter = 0;
11991 PL_reg_poscache = Nullch;
11992 PL_reg_poscache_size= 0;
11994 /* RE engine - function pointers */
11995 PL_regcompp = proto_perl->Tregcompp;
11996 PL_regexecp = proto_perl->Tregexecp;
11997 PL_regint_start = proto_perl->Tregint_start;
11998 PL_regint_string = proto_perl->Tregint_string;
11999 PL_regfree = proto_perl->Tregfree;
12001 PL_reginterp_cnt = 0;
12002 PL_reg_starttry = 0;
12004 /* Pluggable optimizer */
12005 PL_peepp = proto_perl->Tpeepp;
12007 PL_stashcache = newHV();
12009 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12010 ptr_table_free(PL_ptr_table);
12011 PL_ptr_table = NULL;
12014 /* Call the ->CLONE method, if it exists, for each of the stashes
12015 identified by sv_dup() above.
12017 while(av_len(param->stashes) != -1) {
12018 HV* const stash = (HV*) av_shift(param->stashes);
12019 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12020 if (cloner && GvCV(cloner)) {
12025 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12027 call_sv((SV*)GvCV(cloner), G_DISCARD);
12033 SvREFCNT_dec(param->stashes);
12035 /* orphaned? eg threads->new inside BEGIN or use */
12036 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12037 (void)SvREFCNT_inc(PL_compcv);
12038 SAVEFREESV(PL_compcv);
12044 #endif /* USE_ITHREADS */
12047 =head1 Unicode Support
12049 =for apidoc sv_recode_to_utf8
12051 The encoding is assumed to be an Encode object, on entry the PV
12052 of the sv is assumed to be octets in that encoding, and the sv
12053 will be converted into Unicode (and UTF-8).
12055 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12056 is not a reference, nothing is done to the sv. If the encoding is not
12057 an C<Encode::XS> Encoding object, bad things will happen.
12058 (See F<lib/encoding.pm> and L<Encode>).
12060 The PV of the sv is returned.
12065 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12068 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12082 Passing sv_yes is wrong - it needs to be or'ed set of constants
12083 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12084 remove converted chars from source.
12086 Both will default the value - let them.
12088 XPUSHs(&PL_sv_yes);
12091 call_method("decode", G_SCALAR);
12095 s = SvPV_const(uni, len);
12096 if (s != SvPVX_const(sv)) {
12097 SvGROW(sv, len + 1);
12098 Move(s, SvPVX(sv), len + 1, char);
12099 SvCUR_set(sv, len);
12106 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12110 =for apidoc sv_cat_decode
12112 The encoding is assumed to be an Encode object, the PV of the ssv is
12113 assumed to be octets in that encoding and decoding the input starts
12114 from the position which (PV + *offset) pointed to. The dsv will be
12115 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12116 when the string tstr appears in decoding output or the input ends on
12117 the PV of the ssv. The value which the offset points will be modified
12118 to the last input position on the ssv.
12120 Returns TRUE if the terminator was found, else returns FALSE.
12125 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12126 SV *ssv, int *offset, char *tstr, int tlen)
12130 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12141 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12142 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12144 call_method("cat_decode", G_SCALAR);
12146 ret = SvTRUE(TOPs);
12147 *offset = SvIV(offsv);
12153 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12159 * c-indentation-style: bsd
12160 * c-basic-offset: 4
12161 * indent-tabs-mode: t
12164 * ex: set ts=8 sts=4 sw=4 noet: