3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
761 if (!cv || !CvPADLIST(cv))
763 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
764 sv = *av_fetch(av, targ, FALSE);
765 /* SvLEN in a pad name is not to be trusted */
766 sv_setpv(name, SvPV_nolen_const(sv));
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
773 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
776 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
778 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
780 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
781 sv_insert(name, 0, 0, "within ", 7);
788 =for apidoc find_uninit_var
790 Find the name of the undefined variable (if any) that caused the operator o
791 to issue a "Use of uninitialized value" warning.
792 If match is true, only return a name if it's value matches uninit_sv.
793 So roughly speaking, if a unary operator (such as OP_COS) generates a
794 warning, then following the direct child of the op may yield an
795 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
796 other hand, with OP_ADD there are two branches to follow, so we only print
797 the variable name if we get an exact match.
799 The name is returned as a mortal SV.
801 Assumes that PL_op is the op that originally triggered the error, and that
802 PL_comppad/PL_curpad points to the currently executing pad.
808 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
817 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
818 uninit_sv == &PL_sv_placeholder)))
821 switch (obase->op_type) {
828 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
829 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
832 int subscript_type = FUV_SUBSCRIPT_WITHIN;
834 if (pad) { /* @lex, %lex */
835 sv = PAD_SVl(obase->op_targ);
839 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
840 /* @global, %global */
841 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
844 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
846 else /* @{expr}, %{expr} */
847 return find_uninit_var(cUNOPx(obase)->op_first,
851 /* attempt to find a match within the aggregate */
853 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
855 subscript_type = FUV_SUBSCRIPT_HASH;
858 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
860 subscript_type = FUV_SUBSCRIPT_ARRAY;
863 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
866 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
867 keysv, index, subscript_type);
871 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
873 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
874 Nullsv, 0, FUV_SUBSCRIPT_NONE);
877 gv = cGVOPx_gv(obase);
878 if (!gv || (match && GvSV(gv) != uninit_sv))
880 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
883 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
885 av = (AV*)PAD_SV(obase->op_targ);
886 if (!av || SvRMAGICAL(av))
888 svp = av_fetch(av, (I32)obase->op_private, FALSE);
889 if (!svp || *svp != uninit_sv)
892 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
893 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
896 gv = cGVOPx_gv(obase);
901 if (!av || SvRMAGICAL(av))
903 svp = av_fetch(av, (I32)obase->op_private, FALSE);
904 if (!svp || *svp != uninit_sv)
907 return S_varname(aTHX_ gv, "$", 0,
908 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
913 o = cUNOPx(obase)->op_first;
914 if (!o || o->op_type != OP_NULL ||
915 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
917 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
922 /* $a[uninit_expr] or $h{uninit_expr} */
923 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
926 o = cBINOPx(obase)->op_first;
927 kid = cBINOPx(obase)->op_last;
929 /* get the av or hv, and optionally the gv */
931 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
932 sv = PAD_SV(o->op_targ);
934 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
935 && cUNOPo->op_first->op_type == OP_GV)
937 gv = cGVOPx_gv(cUNOPo->op_first);
940 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
945 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
946 /* index is constant */
950 if (obase->op_type == OP_HELEM) {
951 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
952 if (!he || HeVAL(he) != uninit_sv)
956 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
957 if (!svp || *svp != uninit_sv)
961 if (obase->op_type == OP_HELEM)
962 return S_varname(aTHX_ gv, "%", o->op_targ,
963 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
965 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
966 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
970 /* index is an expression;
971 * attempt to find a match within the aggregate */
972 if (obase->op_type == OP_HELEM) {
973 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
975 return S_varname(aTHX_ gv, "%", o->op_targ,
976 keysv, 0, FUV_SUBSCRIPT_HASH);
979 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
981 return S_varname(aTHX_ gv, "@", o->op_targ,
982 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
986 return S_varname(aTHX_ gv,
987 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
989 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
995 /* only examine RHS */
996 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
999 o = cUNOPx(obase)->op_first;
1000 if (o->op_type == OP_PUSHMARK)
1003 if (!o->op_sibling) {
1004 /* one-arg version of open is highly magical */
1006 if (o->op_type == OP_GV) { /* open FOO; */
1008 if (match && GvSV(gv) != uninit_sv)
1010 return S_varname(aTHX_ gv, "$", 0,
1011 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1013 /* other possibilities not handled are:
1014 * open $x; or open my $x; should return '${*$x}'
1015 * open expr; should return '$'.expr ideally
1021 /* ops where $_ may be an implicit arg */
1025 if ( !(obase->op_flags & OPf_STACKED)) {
1026 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1027 ? PAD_SVl(obase->op_targ)
1030 sv = sv_newmortal();
1031 sv_setpvn(sv, "$_", 2);
1039 /* skip filehandle as it can't produce 'undef' warning */
1040 o = cUNOPx(obase)->op_first;
1041 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1042 o = o->op_sibling->op_sibling;
1049 match = 1; /* XS or custom code could trigger random warnings */
1054 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1055 return sv_2mortal(newSVpv("${$/}", 0));
1060 if (!(obase->op_flags & OPf_KIDS))
1062 o = cUNOPx(obase)->op_first;
1068 /* if all except one arg are constant, or have no side-effects,
1069 * or are optimized away, then it's unambiguous */
1071 for (kid=o; kid; kid = kid->op_sibling) {
1073 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1074 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1075 || (kid->op_type == OP_PUSHMARK)
1079 if (o2) { /* more than one found */
1086 return find_uninit_var(o2, uninit_sv, match);
1090 sv = find_uninit_var(o, uninit_sv, 1);
1102 =for apidoc report_uninit
1104 Print appropriate "Use of uninitialized variable" warning
1110 Perl_report_uninit(pTHX_ SV* uninit_sv)
1113 SV* varname = Nullsv;
1115 varname = find_uninit_var(PL_op, uninit_sv,0);
1117 sv_insert(varname, 0, 0, " ", 1);
1119 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1120 varname ? SvPV_nolen_const(varname) : "",
1121 " in ", OP_DESC(PL_op));
1124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1129 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1133 size_t count = PERL_ARENA_SIZE/size;
1134 New(0, start, count*size, char);
1135 *((void **) start) = *arena_root;
1136 *arena_root = (void *)start;
1138 end = start + (count-1) * size;
1140 /* The initial slot is used to link the arenas together, so it isn't to be
1141 linked into the list of ready-to-use bodies. */
1145 *root = (void *)start;
1147 while (start < end) {
1148 char *next = start + size;
1149 *(void**) start = (void *)next;
1152 *(void **)start = 0;
1157 /* grab a new thing from the free list, allocating more if necessary */
1160 S_new_body(pTHX_ void **arena_root, void **root, size_t size, size_t offset)
1164 xpv = *root ? *root : S_more_bodies(aTHX_ arena_root, root, size);
1165 *root = *(void**)xpv;
1167 return (void*)((char*)xpv - offset);
1170 /* return a thing to the free list */
1173 S_del_body(pTHX_ void *thing, void **root, size_t offset)
1175 void **real_thing = (void**)((char *)thing + offset);
1177 *real_thing = *root;
1178 *root = (void*)real_thing;
1182 /* Conventionally we simply malloc() a big block of memory, then divide it
1183 up into lots of the thing that we're allocating.
1185 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1188 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1189 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1192 #define new_body(TYPE,lctype) \
1193 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1194 (void**)&PL_ ## lctype ## _root, \
1198 /* But for some types, we cheat. The type starts with some members that are
1199 never accessed. So we allocate the substructure, starting at the first used
1200 member, then adjust the pointer back in memory by the size of the bit not
1201 allocated, so it's as if we allocated the full structure.
1202 (But things will all go boom if you write to the part that is "not there",
1203 because you'll be overwriting the last members of the preceding structure
1206 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1207 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1208 and the pointer is unchanged. If the allocated structure is smaller (no
1209 initial NV actually allocated) then the net effect is to subtract the size
1210 of the NV from the pointer, to return a new pointer as if an initial NV were
1213 This is the same trick as was used for NV and IV bodies. Ironically it
1214 doesn't need to be used for NV bodies any more, because NV is now at the
1215 start of the structure. IV bodies don't need it either, because they are
1216 no longer allocated. */
1218 #define new_body_allocated(TYPE,lctype,member) \
1219 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1220 (void**)&PL_ ## lctype ## _root, \
1221 sizeof(lctype ## _allocated), \
1222 STRUCT_OFFSET(TYPE, member) \
1223 - STRUCT_OFFSET(lctype ## _allocated, member))
1226 #define del_body(p,TYPE,lctype) \
1227 S_del_body(aTHX_ (void*)p, (void**)&PL_ ## lctype ## _root, 0)
1229 #define del_body_allocated(p,TYPE,lctype,member) \
1230 S_del_body(aTHX_ (void*)p, (void**)&PL_ ## lctype ## _root, \
1231 STRUCT_OFFSET(TYPE, member) \
1232 - STRUCT_OFFSET(lctype ## _allocated, member))
1234 #define my_safemalloc(s) (void*)safemalloc(s)
1235 #define my_safefree(p) safefree((char*)p)
1239 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1240 #define del_XNV(p) my_safefree(p)
1242 #define new_XPV() my_safemalloc(sizeof(XPV))
1243 #define del_XPV(p) my_safefree(p)
1245 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1246 #define del_XPVIV(p) my_safefree(p)
1248 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1249 #define del_XPVNV(p) my_safefree(p)
1251 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1252 #define del_XPVCV(p) my_safefree(p)
1254 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1255 #define del_XPVAV(p) my_safefree(p)
1257 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1258 #define del_XPVHV(p) my_safefree(p)
1260 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1261 #define del_XPVMG(p) my_safefree(p)
1263 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1264 #define del_XPVGV(p) my_safefree(p)
1266 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1267 #define del_XPVLV(p) my_safefree(p)
1269 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1270 #define del_XPVBM(p) my_safefree(p)
1274 #define new_XNV() new_body(NV, xnv)
1275 #define del_XNV(p) del_body(p, NV, xnv)
1277 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1278 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1280 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1281 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1283 #define new_XPVNV() new_body(XPVNV, xpvnv)
1284 #define del_XPVNV(p) del_body(p, XPVNV, xpvnv)
1286 #define new_XPVCV() new_body(XPVCV, xpvcv)
1287 #define del_XPVCV(p) del_body(p, XPVCV, xpvcv)
1289 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1290 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1292 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1293 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1295 #define new_XPVMG() new_body(XPVMG, xpvmg)
1296 #define del_XPVMG(p) del_body(p, XPVMG, xpvmg)
1298 #define new_XPVGV() new_body(XPVGV, xpvgv)
1299 #define del_XPVGV(p) del_body(p, XPVGV, xpvgv)
1301 #define new_XPVLV() new_body(XPVLV, xpvlv)
1302 #define del_XPVLV(p) del_body(p, XPVLV, xpvlv)
1304 #define new_XPVBM() new_body(XPVBM, xpvbm)
1305 #define del_XPVBM(p) del_body(p, XPVBM, xpvbm)
1309 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1310 #define del_XPVFM(p) my_safefree(p)
1312 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1313 #define del_XPVIO(p) my_safefree(p)
1316 =for apidoc sv_upgrade
1318 Upgrade an SV to a more complex form. Generally adds a new body type to the
1319 SV, then copies across as much information as possible from the old body.
1320 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1326 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1337 if (mt != SVt_PV && SvIsCOW(sv)) {
1338 sv_force_normal_flags(sv, 0);
1341 if (SvTYPE(sv) == mt)
1352 switch (SvTYPE(sv)) {
1359 else if (mt < SVt_PVIV)
1369 pv = (char*)SvRV(sv);
1372 pv = SvPVX_mutable(sv);
1378 else if (mt == SVt_NV)
1382 pv = SvPVX_mutable(sv);
1386 del_XPVIV(SvANY(sv));
1389 pv = SvPVX_mutable(sv);
1394 del_XPVNV(SvANY(sv));
1397 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1398 there's no way that it can be safely upgraded, because perl.c
1399 expects to Safefree(SvANY(PL_mess_sv)) */
1400 assert(sv != PL_mess_sv);
1401 /* This flag bit is used to mean other things in other scalar types.
1402 Given that it only has meaning inside the pad, it shouldn't be set
1403 on anything that can get upgraded. */
1404 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1405 pv = SvPVX_mutable(sv);
1410 magic = SvMAGIC(sv);
1411 stash = SvSTASH(sv);
1412 del_XPVMG(SvANY(sv));
1415 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1418 SvFLAGS(sv) &= ~SVTYPEMASK;
1423 Perl_croak(aTHX_ "Can't upgrade to undef");
1425 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1429 SvANY(sv) = new_XNV();
1433 SvANY(sv) = &sv->sv_u.svu_rv;
1434 SvRV_set(sv, (SV*)pv);
1437 SvANY(sv) = new_XPVHV();
1440 HvTOTALKEYS(sv) = 0;
1442 /* Fall through... */
1445 SvANY(sv) = new_XPVAV();
1452 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1454 /* FIXME. Should be able to remove all this if()... if the above
1455 assertion is genuinely always true. */
1458 SvFLAGS(sv) &= ~SVf_OOK;
1461 SvPV_set(sv, (char*)0);
1462 SvMAGIC_set(sv, magic);
1463 SvSTASH_set(sv, stash);
1467 SvANY(sv) = new_XPVIO();
1468 Zero(SvANY(sv), 1, XPVIO);
1469 IoPAGE_LEN(sv) = 60;
1470 goto set_magic_common;
1472 SvANY(sv) = new_XPVFM();
1473 Zero(SvANY(sv), 1, XPVFM);
1474 goto set_magic_common;
1476 SvANY(sv) = new_XPVBM();
1480 goto set_magic_common;
1482 SvANY(sv) = new_XPVGV();
1488 goto set_magic_common;
1490 SvANY(sv) = new_XPVCV();
1491 Zero(SvANY(sv), 1, XPVCV);
1492 goto set_magic_common;
1494 SvANY(sv) = new_XPVLV();
1507 SvANY(sv) = new_XPVMG();
1510 SvMAGIC_set(sv, magic);
1511 SvSTASH_set(sv, stash);
1515 SvANY(sv) = new_XPVNV();
1521 SvANY(sv) = new_XPVIV();
1530 SvANY(sv) = new_XPV();
1540 =for apidoc sv_backoff
1542 Remove any string offset. You should normally use the C<SvOOK_off> macro
1549 Perl_sv_backoff(pTHX_ register SV *sv)
1552 assert(SvTYPE(sv) != SVt_PVHV);
1553 assert(SvTYPE(sv) != SVt_PVAV);
1555 const char *s = SvPVX_const(sv);
1556 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1557 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1559 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1561 SvFLAGS(sv) &= ~SVf_OOK;
1568 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1569 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1570 Use the C<SvGROW> wrapper instead.
1576 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1580 #ifdef HAS_64K_LIMIT
1581 if (newlen >= 0x10000) {
1582 PerlIO_printf(Perl_debug_log,
1583 "Allocation too large: %"UVxf"\n", (UV)newlen);
1586 #endif /* HAS_64K_LIMIT */
1589 if (SvTYPE(sv) < SVt_PV) {
1590 sv_upgrade(sv, SVt_PV);
1591 s = SvPVX_mutable(sv);
1593 else if (SvOOK(sv)) { /* pv is offset? */
1595 s = SvPVX_mutable(sv);
1596 if (newlen > SvLEN(sv))
1597 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1598 #ifdef HAS_64K_LIMIT
1599 if (newlen >= 0x10000)
1604 s = SvPVX_mutable(sv);
1606 if (newlen > SvLEN(sv)) { /* need more room? */
1607 newlen = PERL_STRLEN_ROUNDUP(newlen);
1608 if (SvLEN(sv) && s) {
1610 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1616 s = saferealloc(s, newlen);
1619 s = safemalloc(newlen);
1620 if (SvPVX_const(sv) && SvCUR(sv)) {
1621 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1625 SvLEN_set(sv, newlen);
1631 =for apidoc sv_setiv
1633 Copies an integer into the given SV, upgrading first if necessary.
1634 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1640 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1642 SV_CHECK_THINKFIRST_COW_DROP(sv);
1643 switch (SvTYPE(sv)) {
1645 sv_upgrade(sv, SVt_IV);
1648 sv_upgrade(sv, SVt_PVNV);
1652 sv_upgrade(sv, SVt_PVIV);
1661 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1664 (void)SvIOK_only(sv); /* validate number */
1670 =for apidoc sv_setiv_mg
1672 Like C<sv_setiv>, but also handles 'set' magic.
1678 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1685 =for apidoc sv_setuv
1687 Copies an unsigned integer into the given SV, upgrading first if necessary.
1688 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1694 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1696 /* With these two if statements:
1697 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1700 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1702 If you wish to remove them, please benchmark to see what the effect is
1704 if (u <= (UV)IV_MAX) {
1705 sv_setiv(sv, (IV)u);
1714 =for apidoc sv_setuv_mg
1716 Like C<sv_setuv>, but also handles 'set' magic.
1722 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1724 /* With these two if statements:
1725 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1728 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1730 If you wish to remove them, please benchmark to see what the effect is
1732 if (u <= (UV)IV_MAX) {
1733 sv_setiv(sv, (IV)u);
1743 =for apidoc sv_setnv
1745 Copies a double into the given SV, upgrading first if necessary.
1746 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1752 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1754 SV_CHECK_THINKFIRST_COW_DROP(sv);
1755 switch (SvTYPE(sv)) {
1758 sv_upgrade(sv, SVt_NV);
1763 sv_upgrade(sv, SVt_PVNV);
1772 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1776 (void)SvNOK_only(sv); /* validate number */
1781 =for apidoc sv_setnv_mg
1783 Like C<sv_setnv>, but also handles 'set' magic.
1789 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1795 /* Print an "isn't numeric" warning, using a cleaned-up,
1796 * printable version of the offending string
1800 S_not_a_number(pTHX_ SV *sv)
1807 dsv = sv_2mortal(newSVpv("", 0));
1808 pv = sv_uni_display(dsv, sv, 10, 0);
1811 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1812 /* each *s can expand to 4 chars + "...\0",
1813 i.e. need room for 8 chars */
1815 const char *s, *end;
1816 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1819 if (ch & 128 && !isPRINT_LC(ch)) {
1828 else if (ch == '\r') {
1832 else if (ch == '\f') {
1836 else if (ch == '\\') {
1840 else if (ch == '\0') {
1844 else if (isPRINT_LC(ch))
1861 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1862 "Argument \"%s\" isn't numeric in %s", pv,
1865 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1866 "Argument \"%s\" isn't numeric", pv);
1870 =for apidoc looks_like_number
1872 Test if the content of an SV looks like a number (or is a number).
1873 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1874 non-numeric warning), even if your atof() doesn't grok them.
1880 Perl_looks_like_number(pTHX_ SV *sv)
1882 register const char *sbegin;
1886 sbegin = SvPVX_const(sv);
1889 else if (SvPOKp(sv))
1890 sbegin = SvPV_const(sv, len);
1892 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1893 return grok_number(sbegin, len, NULL);
1896 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1897 until proven guilty, assume that things are not that bad... */
1902 As 64 bit platforms often have an NV that doesn't preserve all bits of
1903 an IV (an assumption perl has been based on to date) it becomes necessary
1904 to remove the assumption that the NV always carries enough precision to
1905 recreate the IV whenever needed, and that the NV is the canonical form.
1906 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1907 precision as a side effect of conversion (which would lead to insanity
1908 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1909 1) to distinguish between IV/UV/NV slots that have cached a valid
1910 conversion where precision was lost and IV/UV/NV slots that have a
1911 valid conversion which has lost no precision
1912 2) to ensure that if a numeric conversion to one form is requested that
1913 would lose precision, the precise conversion (or differently
1914 imprecise conversion) is also performed and cached, to prevent
1915 requests for different numeric formats on the same SV causing
1916 lossy conversion chains. (lossless conversion chains are perfectly
1921 SvIOKp is true if the IV slot contains a valid value
1922 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1923 SvNOKp is true if the NV slot contains a valid value
1924 SvNOK is true only if the NV value is accurate
1927 while converting from PV to NV, check to see if converting that NV to an
1928 IV(or UV) would lose accuracy over a direct conversion from PV to
1929 IV(or UV). If it would, cache both conversions, return NV, but mark
1930 SV as IOK NOKp (ie not NOK).
1932 While converting from PV to IV, check to see if converting that IV to an
1933 NV would lose accuracy over a direct conversion from PV to NV. If it
1934 would, cache both conversions, flag similarly.
1936 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1937 correctly because if IV & NV were set NV *always* overruled.
1938 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1939 changes - now IV and NV together means that the two are interchangeable:
1940 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1942 The benefit of this is that operations such as pp_add know that if
1943 SvIOK is true for both left and right operands, then integer addition
1944 can be used instead of floating point (for cases where the result won't
1945 overflow). Before, floating point was always used, which could lead to
1946 loss of precision compared with integer addition.
1948 * making IV and NV equal status should make maths accurate on 64 bit
1950 * may speed up maths somewhat if pp_add and friends start to use
1951 integers when possible instead of fp. (Hopefully the overhead in
1952 looking for SvIOK and checking for overflow will not outweigh the
1953 fp to integer speedup)
1954 * will slow down integer operations (callers of SvIV) on "inaccurate"
1955 values, as the change from SvIOK to SvIOKp will cause a call into
1956 sv_2iv each time rather than a macro access direct to the IV slot
1957 * should speed up number->string conversion on integers as IV is
1958 favoured when IV and NV are equally accurate
1960 ####################################################################
1961 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1962 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1963 On the other hand, SvUOK is true iff UV.
1964 ####################################################################
1966 Your mileage will vary depending your CPU's relative fp to integer
1970 #ifndef NV_PRESERVES_UV
1971 # define IS_NUMBER_UNDERFLOW_IV 1
1972 # define IS_NUMBER_UNDERFLOW_UV 2
1973 # define IS_NUMBER_IV_AND_UV 2
1974 # define IS_NUMBER_OVERFLOW_IV 4
1975 # define IS_NUMBER_OVERFLOW_UV 5
1977 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1979 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1981 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1983 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));
1984 if (SvNVX(sv) < (NV)IV_MIN) {
1985 (void)SvIOKp_on(sv);
1987 SvIV_set(sv, IV_MIN);
1988 return IS_NUMBER_UNDERFLOW_IV;
1990 if (SvNVX(sv) > (NV)UV_MAX) {
1991 (void)SvIOKp_on(sv);
1994 SvUV_set(sv, UV_MAX);
1995 return IS_NUMBER_OVERFLOW_UV;
1997 (void)SvIOKp_on(sv);
1999 /* Can't use strtol etc to convert this string. (See truth table in
2001 if (SvNVX(sv) <= (UV)IV_MAX) {
2002 SvIV_set(sv, I_V(SvNVX(sv)));
2003 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2004 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2006 /* Integer is imprecise. NOK, IOKp */
2008 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2011 SvUV_set(sv, U_V(SvNVX(sv)));
2012 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2013 if (SvUVX(sv) == UV_MAX) {
2014 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2015 possibly be preserved by NV. Hence, it must be overflow.
2017 return IS_NUMBER_OVERFLOW_UV;
2019 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2021 /* Integer is imprecise. NOK, IOKp */
2023 return IS_NUMBER_OVERFLOW_IV;
2025 #endif /* !NV_PRESERVES_UV*/
2027 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2028 * this function provided for binary compatibility only
2032 Perl_sv_2iv(pTHX_ register SV *sv)
2034 return sv_2iv_flags(sv, SV_GMAGIC);
2038 =for apidoc sv_2iv_flags
2040 Return the integer value of an SV, doing any necessary string
2041 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2042 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2048 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2052 if (SvGMAGICAL(sv)) {
2053 if (flags & SV_GMAGIC)
2058 return I_V(SvNVX(sv));
2060 if (SvPOKp(sv) && SvLEN(sv))
2063 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2064 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2070 if (SvTHINKFIRST(sv)) {
2073 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2074 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2075 return SvIV(tmpstr);
2076 return PTR2IV(SvRV(sv));
2079 sv_force_normal_flags(sv, 0);
2081 if (SvREADONLY(sv) && !SvOK(sv)) {
2082 if (ckWARN(WARN_UNINITIALIZED))
2089 return (IV)(SvUVX(sv));
2096 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2097 * without also getting a cached IV/UV from it at the same time
2098 * (ie PV->NV conversion should detect loss of accuracy and cache
2099 * IV or UV at same time to avoid this. NWC */
2101 if (SvTYPE(sv) == SVt_NV)
2102 sv_upgrade(sv, SVt_PVNV);
2104 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2105 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2106 certainly cast into the IV range at IV_MAX, whereas the correct
2107 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2109 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2110 SvIV_set(sv, I_V(SvNVX(sv)));
2111 if (SvNVX(sv) == (NV) SvIVX(sv)
2112 #ifndef NV_PRESERVES_UV
2113 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2114 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2115 /* Don't flag it as "accurately an integer" if the number
2116 came from a (by definition imprecise) NV operation, and
2117 we're outside the range of NV integer precision */
2120 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2121 DEBUG_c(PerlIO_printf(Perl_debug_log,
2122 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2128 /* IV not precise. No need to convert from PV, as NV
2129 conversion would already have cached IV if it detected
2130 that PV->IV would be better than PV->NV->IV
2131 flags already correct - don't set public IOK. */
2132 DEBUG_c(PerlIO_printf(Perl_debug_log,
2133 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2138 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2139 but the cast (NV)IV_MIN rounds to a the value less (more
2140 negative) than IV_MIN which happens to be equal to SvNVX ??
2141 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2142 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2143 (NV)UVX == NVX are both true, but the values differ. :-(
2144 Hopefully for 2s complement IV_MIN is something like
2145 0x8000000000000000 which will be exact. NWC */
2148 SvUV_set(sv, U_V(SvNVX(sv)));
2150 (SvNVX(sv) == (NV) SvUVX(sv))
2151 #ifndef NV_PRESERVES_UV
2152 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2153 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2154 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2155 /* Don't flag it as "accurately an integer" if the number
2156 came from a (by definition imprecise) NV operation, and
2157 we're outside the range of NV integer precision */
2163 DEBUG_c(PerlIO_printf(Perl_debug_log,
2164 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2168 return (IV)SvUVX(sv);
2171 else if (SvPOKp(sv) && SvLEN(sv)) {
2173 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2174 /* We want to avoid a possible problem when we cache an IV which
2175 may be later translated to an NV, and the resulting NV is not
2176 the same as the direct translation of the initial string
2177 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2178 be careful to ensure that the value with the .456 is around if the
2179 NV value is requested in the future).
2181 This means that if we cache such an IV, we need to cache the
2182 NV as well. Moreover, we trade speed for space, and do not
2183 cache the NV if we are sure it's not needed.
2186 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2187 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2188 == IS_NUMBER_IN_UV) {
2189 /* It's definitely an integer, only upgrade to PVIV */
2190 if (SvTYPE(sv) < SVt_PVIV)
2191 sv_upgrade(sv, SVt_PVIV);
2193 } else if (SvTYPE(sv) < SVt_PVNV)
2194 sv_upgrade(sv, SVt_PVNV);
2196 /* If NV preserves UV then we only use the UV value if we know that
2197 we aren't going to call atof() below. If NVs don't preserve UVs
2198 then the value returned may have more precision than atof() will
2199 return, even though value isn't perfectly accurate. */
2200 if ((numtype & (IS_NUMBER_IN_UV
2201 #ifdef NV_PRESERVES_UV
2204 )) == IS_NUMBER_IN_UV) {
2205 /* This won't turn off the public IOK flag if it was set above */
2206 (void)SvIOKp_on(sv);
2208 if (!(numtype & IS_NUMBER_NEG)) {
2210 if (value <= (UV)IV_MAX) {
2211 SvIV_set(sv, (IV)value);
2213 SvUV_set(sv, value);
2217 /* 2s complement assumption */
2218 if (value <= (UV)IV_MIN) {
2219 SvIV_set(sv, -(IV)value);
2221 /* Too negative for an IV. This is a double upgrade, but
2222 I'm assuming it will be rare. */
2223 if (SvTYPE(sv) < SVt_PVNV)
2224 sv_upgrade(sv, SVt_PVNV);
2228 SvNV_set(sv, -(NV)value);
2229 SvIV_set(sv, IV_MIN);
2233 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2234 will be in the previous block to set the IV slot, and the next
2235 block to set the NV slot. So no else here. */
2237 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2238 != IS_NUMBER_IN_UV) {
2239 /* It wasn't an (integer that doesn't overflow the UV). */
2240 SvNV_set(sv, Atof(SvPVX_const(sv)));
2242 if (! numtype && ckWARN(WARN_NUMERIC))
2245 #if defined(USE_LONG_DOUBLE)
2246 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2247 PTR2UV(sv), SvNVX(sv)));
2249 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2250 PTR2UV(sv), SvNVX(sv)));
2254 #ifdef NV_PRESERVES_UV
2255 (void)SvIOKp_on(sv);
2257 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2258 SvIV_set(sv, I_V(SvNVX(sv)));
2259 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2262 /* Integer is imprecise. NOK, IOKp */
2264 /* UV will not work better than IV */
2266 if (SvNVX(sv) > (NV)UV_MAX) {
2268 /* Integer is inaccurate. NOK, IOKp, is UV */
2269 SvUV_set(sv, UV_MAX);
2272 SvUV_set(sv, U_V(SvNVX(sv)));
2273 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2274 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2278 /* Integer is imprecise. NOK, IOKp, is UV */
2284 #else /* NV_PRESERVES_UV */
2285 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2286 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2287 /* The IV slot will have been set from value returned by
2288 grok_number above. The NV slot has just been set using
2291 assert (SvIOKp(sv));
2293 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2294 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2295 /* Small enough to preserve all bits. */
2296 (void)SvIOKp_on(sv);
2298 SvIV_set(sv, I_V(SvNVX(sv)));
2299 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2301 /* Assumption: first non-preserved integer is < IV_MAX,
2302 this NV is in the preserved range, therefore: */
2303 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2305 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);
2309 0 0 already failed to read UV.
2310 0 1 already failed to read UV.
2311 1 0 you won't get here in this case. IV/UV
2312 slot set, public IOK, Atof() unneeded.
2313 1 1 already read UV.
2314 so there's no point in sv_2iuv_non_preserve() attempting
2315 to use atol, strtol, strtoul etc. */
2316 if (sv_2iuv_non_preserve (sv, numtype)
2317 >= IS_NUMBER_OVERFLOW_IV)
2321 #endif /* NV_PRESERVES_UV */
2324 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2326 if (SvTYPE(sv) < SVt_IV)
2327 /* Typically the caller expects that sv_any is not NULL now. */
2328 sv_upgrade(sv, SVt_IV);
2331 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2332 PTR2UV(sv),SvIVX(sv)));
2333 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2336 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2337 * this function provided for binary compatibility only
2341 Perl_sv_2uv(pTHX_ register SV *sv)
2343 return sv_2uv_flags(sv, SV_GMAGIC);
2347 =for apidoc sv_2uv_flags
2349 Return the unsigned integer value of an SV, doing any necessary string
2350 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2351 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2357 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2361 if (SvGMAGICAL(sv)) {
2362 if (flags & SV_GMAGIC)
2367 return U_V(SvNVX(sv));
2368 if (SvPOKp(sv) && SvLEN(sv))
2371 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2372 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2378 if (SvTHINKFIRST(sv)) {
2381 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2382 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2383 return SvUV(tmpstr);
2384 return PTR2UV(SvRV(sv));
2387 sv_force_normal_flags(sv, 0);
2389 if (SvREADONLY(sv) && !SvOK(sv)) {
2390 if (ckWARN(WARN_UNINITIALIZED))
2400 return (UV)SvIVX(sv);
2404 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2405 * without also getting a cached IV/UV from it at the same time
2406 * (ie PV->NV conversion should detect loss of accuracy and cache
2407 * IV or UV at same time to avoid this. */
2408 /* IV-over-UV optimisation - choose to cache IV if possible */
2410 if (SvTYPE(sv) == SVt_NV)
2411 sv_upgrade(sv, SVt_PVNV);
2413 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2414 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2415 SvIV_set(sv, I_V(SvNVX(sv)));
2416 if (SvNVX(sv) == (NV) SvIVX(sv)
2417 #ifndef NV_PRESERVES_UV
2418 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2419 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2420 /* Don't flag it as "accurately an integer" if the number
2421 came from a (by definition imprecise) NV operation, and
2422 we're outside the range of NV integer precision */
2425 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2426 DEBUG_c(PerlIO_printf(Perl_debug_log,
2427 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2433 /* IV not precise. No need to convert from PV, as NV
2434 conversion would already have cached IV if it detected
2435 that PV->IV would be better than PV->NV->IV
2436 flags already correct - don't set public IOK. */
2437 DEBUG_c(PerlIO_printf(Perl_debug_log,
2438 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2443 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2444 but the cast (NV)IV_MIN rounds to a the value less (more
2445 negative) than IV_MIN which happens to be equal to SvNVX ??
2446 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2447 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2448 (NV)UVX == NVX are both true, but the values differ. :-(
2449 Hopefully for 2s complement IV_MIN is something like
2450 0x8000000000000000 which will be exact. NWC */
2453 SvUV_set(sv, U_V(SvNVX(sv)));
2455 (SvNVX(sv) == (NV) SvUVX(sv))
2456 #ifndef NV_PRESERVES_UV
2457 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2458 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2459 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2460 /* Don't flag it as "accurately an integer" if the number
2461 came from a (by definition imprecise) NV operation, and
2462 we're outside the range of NV integer precision */
2467 DEBUG_c(PerlIO_printf(Perl_debug_log,
2468 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2474 else if (SvPOKp(sv) && SvLEN(sv)) {
2476 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2478 /* We want to avoid a possible problem when we cache a UV which
2479 may be later translated to an NV, and the resulting NV is not
2480 the translation of the initial data.
2482 This means that if we cache such a UV, we need to cache the
2483 NV as well. Moreover, we trade speed for space, and do not
2484 cache the NV if not needed.
2487 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2488 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2489 == IS_NUMBER_IN_UV) {
2490 /* It's definitely an integer, only upgrade to PVIV */
2491 if (SvTYPE(sv) < SVt_PVIV)
2492 sv_upgrade(sv, SVt_PVIV);
2494 } else if (SvTYPE(sv) < SVt_PVNV)
2495 sv_upgrade(sv, SVt_PVNV);
2497 /* If NV preserves UV then we only use the UV value if we know that
2498 we aren't going to call atof() below. If NVs don't preserve UVs
2499 then the value returned may have more precision than atof() will
2500 return, even though it isn't accurate. */
2501 if ((numtype & (IS_NUMBER_IN_UV
2502 #ifdef NV_PRESERVES_UV
2505 )) == IS_NUMBER_IN_UV) {
2506 /* This won't turn off the public IOK flag if it was set above */
2507 (void)SvIOKp_on(sv);
2509 if (!(numtype & IS_NUMBER_NEG)) {
2511 if (value <= (UV)IV_MAX) {
2512 SvIV_set(sv, (IV)value);
2514 /* it didn't overflow, and it was positive. */
2515 SvUV_set(sv, value);
2519 /* 2s complement assumption */
2520 if (value <= (UV)IV_MIN) {
2521 SvIV_set(sv, -(IV)value);
2523 /* Too negative for an IV. This is a double upgrade, but
2524 I'm assuming it will be rare. */
2525 if (SvTYPE(sv) < SVt_PVNV)
2526 sv_upgrade(sv, SVt_PVNV);
2530 SvNV_set(sv, -(NV)value);
2531 SvIV_set(sv, IV_MIN);
2536 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2537 != IS_NUMBER_IN_UV) {
2538 /* It wasn't an integer, or it overflowed the UV. */
2539 SvNV_set(sv, Atof(SvPVX_const(sv)));
2541 if (! numtype && ckWARN(WARN_NUMERIC))
2544 #if defined(USE_LONG_DOUBLE)
2545 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2546 PTR2UV(sv), SvNVX(sv)));
2548 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2549 PTR2UV(sv), SvNVX(sv)));
2552 #ifdef NV_PRESERVES_UV
2553 (void)SvIOKp_on(sv);
2555 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2556 SvIV_set(sv, I_V(SvNVX(sv)));
2557 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2560 /* Integer is imprecise. NOK, IOKp */
2562 /* UV will not work better than IV */
2564 if (SvNVX(sv) > (NV)UV_MAX) {
2566 /* Integer is inaccurate. NOK, IOKp, is UV */
2567 SvUV_set(sv, UV_MAX);
2570 SvUV_set(sv, U_V(SvNVX(sv)));
2571 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2572 NV preservse UV so can do correct comparison. */
2573 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2577 /* Integer is imprecise. NOK, IOKp, is UV */
2582 #else /* NV_PRESERVES_UV */
2583 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2584 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2585 /* The UV slot will have been set from value returned by
2586 grok_number above. The NV slot has just been set using
2589 assert (SvIOKp(sv));
2591 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2592 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2593 /* Small enough to preserve all bits. */
2594 (void)SvIOKp_on(sv);
2596 SvIV_set(sv, I_V(SvNVX(sv)));
2597 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2599 /* Assumption: first non-preserved integer is < IV_MAX,
2600 this NV is in the preserved range, therefore: */
2601 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2603 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);
2606 sv_2iuv_non_preserve (sv, numtype);
2608 #endif /* NV_PRESERVES_UV */
2612 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2613 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2616 if (SvTYPE(sv) < SVt_IV)
2617 /* Typically the caller expects that sv_any is not NULL now. */
2618 sv_upgrade(sv, SVt_IV);
2622 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2623 PTR2UV(sv),SvUVX(sv)));
2624 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2630 Return the num value of an SV, doing any necessary string or integer
2631 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2638 Perl_sv_2nv(pTHX_ register SV *sv)
2642 if (SvGMAGICAL(sv)) {
2646 if (SvPOKp(sv) && SvLEN(sv)) {
2647 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2648 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2650 return Atof(SvPVX_const(sv));
2654 return (NV)SvUVX(sv);
2656 return (NV)SvIVX(sv);
2659 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2660 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2666 if (SvTHINKFIRST(sv)) {
2669 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2670 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2671 return SvNV(tmpstr);
2672 return PTR2NV(SvRV(sv));
2675 sv_force_normal_flags(sv, 0);
2677 if (SvREADONLY(sv) && !SvOK(sv)) {
2678 if (ckWARN(WARN_UNINITIALIZED))
2683 if (SvTYPE(sv) < SVt_NV) {
2684 if (SvTYPE(sv) == SVt_IV)
2685 sv_upgrade(sv, SVt_PVNV);
2687 sv_upgrade(sv, SVt_NV);
2688 #ifdef USE_LONG_DOUBLE
2690 STORE_NUMERIC_LOCAL_SET_STANDARD();
2691 PerlIO_printf(Perl_debug_log,
2692 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2693 PTR2UV(sv), SvNVX(sv));
2694 RESTORE_NUMERIC_LOCAL();
2698 STORE_NUMERIC_LOCAL_SET_STANDARD();
2699 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2700 PTR2UV(sv), SvNVX(sv));
2701 RESTORE_NUMERIC_LOCAL();
2705 else if (SvTYPE(sv) < SVt_PVNV)
2706 sv_upgrade(sv, SVt_PVNV);
2711 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2712 #ifdef NV_PRESERVES_UV
2715 /* Only set the public NV OK flag if this NV preserves the IV */
2716 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2717 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2718 : (SvIVX(sv) == I_V(SvNVX(sv))))
2724 else if (SvPOKp(sv) && SvLEN(sv)) {
2726 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2727 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2729 #ifdef NV_PRESERVES_UV
2730 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2731 == IS_NUMBER_IN_UV) {
2732 /* It's definitely an integer */
2733 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2735 SvNV_set(sv, Atof(SvPVX_const(sv)));
2738 SvNV_set(sv, Atof(SvPVX_const(sv)));
2739 /* Only set the public NV OK flag if this NV preserves the value in
2740 the PV at least as well as an IV/UV would.
2741 Not sure how to do this 100% reliably. */
2742 /* if that shift count is out of range then Configure's test is
2743 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2745 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2746 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2747 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2748 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2749 /* Can't use strtol etc to convert this string, so don't try.
2750 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2753 /* value has been set. It may not be precise. */
2754 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2755 /* 2s complement assumption for (UV)IV_MIN */
2756 SvNOK_on(sv); /* Integer is too negative. */
2761 if (numtype & IS_NUMBER_NEG) {
2762 SvIV_set(sv, -(IV)value);
2763 } else if (value <= (UV)IV_MAX) {
2764 SvIV_set(sv, (IV)value);
2766 SvUV_set(sv, value);
2770 if (numtype & IS_NUMBER_NOT_INT) {
2771 /* I believe that even if the original PV had decimals,
2772 they are lost beyond the limit of the FP precision.
2773 However, neither is canonical, so both only get p
2774 flags. NWC, 2000/11/25 */
2775 /* Both already have p flags, so do nothing */
2777 const NV nv = SvNVX(sv);
2778 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2779 if (SvIVX(sv) == I_V(nv)) {
2784 /* It had no "." so it must be integer. */
2787 /* between IV_MAX and NV(UV_MAX).
2788 Could be slightly > UV_MAX */
2790 if (numtype & IS_NUMBER_NOT_INT) {
2791 /* UV and NV both imprecise. */
2793 const UV nv_as_uv = U_V(nv);
2795 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2806 #endif /* NV_PRESERVES_UV */
2809 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2811 if (SvTYPE(sv) < SVt_NV)
2812 /* Typically the caller expects that sv_any is not NULL now. */
2813 /* XXX Ilya implies that this is a bug in callers that assume this
2814 and ideally should be fixed. */
2815 sv_upgrade(sv, SVt_NV);
2818 #if defined(USE_LONG_DOUBLE)
2820 STORE_NUMERIC_LOCAL_SET_STANDARD();
2821 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2822 PTR2UV(sv), SvNVX(sv));
2823 RESTORE_NUMERIC_LOCAL();
2827 STORE_NUMERIC_LOCAL_SET_STANDARD();
2828 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2829 PTR2UV(sv), SvNVX(sv));
2830 RESTORE_NUMERIC_LOCAL();
2836 /* asIV(): extract an integer from the string value of an SV.
2837 * Caller must validate PVX */
2840 S_asIV(pTHX_ SV *sv)
2843 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2845 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2846 == IS_NUMBER_IN_UV) {
2847 /* It's definitely an integer */
2848 if (numtype & IS_NUMBER_NEG) {
2849 if (value < (UV)IV_MIN)
2852 if (value < (UV)IV_MAX)
2857 if (ckWARN(WARN_NUMERIC))
2860 return I_V(Atof(SvPVX_const(sv)));
2863 /* asUV(): extract an unsigned integer from the string value of an SV
2864 * Caller must validate PVX */
2867 S_asUV(pTHX_ SV *sv)
2870 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2872 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2873 == IS_NUMBER_IN_UV) {
2874 /* It's definitely an integer */
2875 if (!(numtype & IS_NUMBER_NEG))
2879 if (ckWARN(WARN_NUMERIC))
2882 return U_V(Atof(SvPVX_const(sv)));
2886 =for apidoc sv_2pv_nolen
2888 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2889 use the macro wrapper C<SvPV_nolen(sv)> instead.
2894 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2896 return sv_2pv(sv, 0);
2899 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2900 * UV as a string towards the end of buf, and return pointers to start and
2903 * We assume that buf is at least TYPE_CHARS(UV) long.
2907 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2909 char *ptr = buf + TYPE_CHARS(UV);
2923 *--ptr = '0' + (char)(uv % 10);
2931 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2932 * this function provided for binary compatibility only
2936 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2938 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2942 =for apidoc sv_2pv_flags
2944 Returns a pointer to the string value of an SV, and sets *lp to its length.
2945 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2947 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2948 usually end up here too.
2954 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2959 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2960 char *tmpbuf = tbuf;
2967 if (SvGMAGICAL(sv)) {
2968 if (flags & SV_GMAGIC)
2973 if (flags & SV_MUTABLE_RETURN)
2974 return SvPVX_mutable(sv);
2975 if (flags & SV_CONST_RETURN)
2976 return (char *)SvPVX_const(sv);
2981 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2983 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2988 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2993 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2994 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3002 if (SvTHINKFIRST(sv)) {
3005 register const char *typestr;
3006 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3007 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3009 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3012 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3013 if (flags & SV_CONST_RETURN) {
3014 pv = (char *) SvPVX_const(tmpstr);
3016 pv = (flags & SV_MUTABLE_RETURN)
3017 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3020 *lp = SvCUR(tmpstr);
3022 pv = sv_2pv_flags(tmpstr, lp, flags);
3033 typestr = "NULLREF";
3037 switch (SvTYPE(sv)) {
3039 if ( ((SvFLAGS(sv) &
3040 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3041 == (SVs_OBJECT|SVs_SMG))
3042 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3043 const regexp *re = (regexp *)mg->mg_obj;
3046 const char *fptr = "msix";
3051 char need_newline = 0;
3052 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3054 while((ch = *fptr++)) {
3056 reflags[left++] = ch;
3059 reflags[right--] = ch;
3064 reflags[left] = '-';
3068 mg->mg_len = re->prelen + 4 + left;
3070 * If /x was used, we have to worry about a regex
3071 * ending with a comment later being embedded
3072 * within another regex. If so, we don't want this
3073 * regex's "commentization" to leak out to the
3074 * right part of the enclosing regex, we must cap
3075 * it with a newline.
3077 * So, if /x was used, we scan backwards from the
3078 * end of the regex. If we find a '#' before we
3079 * find a newline, we need to add a newline
3080 * ourself. If we find a '\n' first (or if we
3081 * don't find '#' or '\n'), we don't need to add
3082 * anything. -jfriedl
3084 if (PMf_EXTENDED & re->reganch)
3086 const char *endptr = re->precomp + re->prelen;
3087 while (endptr >= re->precomp)
3089 const char c = *(endptr--);
3091 break; /* don't need another */
3093 /* we end while in a comment, so we
3095 mg->mg_len++; /* save space for it */
3096 need_newline = 1; /* note to add it */
3102 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3103 Copy("(?", mg->mg_ptr, 2, char);
3104 Copy(reflags, mg->mg_ptr+2, left, char);
3105 Copy(":", mg->mg_ptr+left+2, 1, char);
3106 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3108 mg->mg_ptr[mg->mg_len - 2] = '\n';
3109 mg->mg_ptr[mg->mg_len - 1] = ')';
3110 mg->mg_ptr[mg->mg_len] = 0;
3112 PL_reginterp_cnt += re->program[0].next_off;
3114 if (re->reganch & ROPT_UTF8)
3130 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3131 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3132 /* tied lvalues should appear to be
3133 * scalars for backwards compatitbility */
3134 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3135 ? "SCALAR" : "LVALUE"; break;
3136 case SVt_PVAV: typestr = "ARRAY"; break;
3137 case SVt_PVHV: typestr = "HASH"; break;
3138 case SVt_PVCV: typestr = "CODE"; break;
3139 case SVt_PVGV: typestr = "GLOB"; break;
3140 case SVt_PVFM: typestr = "FORMAT"; break;
3141 case SVt_PVIO: typestr = "IO"; break;
3142 default: typestr = "UNKNOWN"; break;
3146 const char *name = HvNAME_get(SvSTASH(sv));
3147 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3148 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3151 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3155 *lp = strlen(typestr);
3156 return (char *)typestr;
3158 if (SvREADONLY(sv) && !SvOK(sv)) {
3159 if (ckWARN(WARN_UNINITIALIZED))
3166 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3167 /* I'm assuming that if both IV and NV are equally valid then
3168 converting the IV is going to be more efficient */
3169 const U32 isIOK = SvIOK(sv);
3170 const U32 isUIOK = SvIsUV(sv);
3171 char buf[TYPE_CHARS(UV)];
3174 if (SvTYPE(sv) < SVt_PVIV)
3175 sv_upgrade(sv, SVt_PVIV);
3177 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3179 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3180 /* inlined from sv_setpvn */
3181 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3182 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3183 SvCUR_set(sv, ebuf - ptr);
3193 else if (SvNOKp(sv)) {
3194 if (SvTYPE(sv) < SVt_PVNV)
3195 sv_upgrade(sv, SVt_PVNV);
3196 /* The +20 is pure guesswork. Configure test needed. --jhi */
3197 s = SvGROW_mutable(sv, NV_DIG + 20);
3198 olderrno = errno; /* some Xenix systems wipe out errno here */
3200 if (SvNVX(sv) == 0.0)
3201 (void)strcpy(s,"0");
3205 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3208 #ifdef FIXNEGATIVEZERO
3209 if (*s == '-' && s[1] == '0' && !s[2])
3219 if (ckWARN(WARN_UNINITIALIZED)
3220 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3224 if (SvTYPE(sv) < SVt_PV)
3225 /* Typically the caller expects that sv_any is not NULL now. */
3226 sv_upgrade(sv, SVt_PV);
3230 STRLEN len = s - SvPVX_const(sv);
3236 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3237 PTR2UV(sv),SvPVX_const(sv)));
3238 if (flags & SV_CONST_RETURN)
3239 return (char *)SvPVX_const(sv);
3240 if (flags & SV_MUTABLE_RETURN)
3241 return SvPVX_mutable(sv);
3245 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3246 /* Sneaky stuff here */
3250 tsv = newSVpv(tmpbuf, 0);
3263 t = SvPVX_const(tsv);
3268 len = strlen(tmpbuf);
3270 #ifdef FIXNEGATIVEZERO
3271 if (len == 2 && t[0] == '-' && t[1] == '0') {
3276 SvUPGRADE(sv, SVt_PV);
3279 s = SvGROW_mutable(sv, len + 1);
3282 return strcpy(s, t);
3287 =for apidoc sv_copypv
3289 Copies a stringified representation of the source SV into the
3290 destination SV. Automatically performs any necessary mg_get and
3291 coercion of numeric values into strings. Guaranteed to preserve
3292 UTF-8 flag even from overloaded objects. Similar in nature to
3293 sv_2pv[_flags] but operates directly on an SV instead of just the
3294 string. Mostly uses sv_2pv_flags to do its work, except when that
3295 would lose the UTF-8'ness of the PV.
3301 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3305 s = SvPV_const(ssv,len);
3306 sv_setpvn(dsv,s,len);
3314 =for apidoc sv_2pvbyte_nolen
3316 Return a pointer to the byte-encoded representation of the SV.
3317 May cause the SV to be downgraded from UTF-8 as a side-effect.
3319 Usually accessed via the C<SvPVbyte_nolen> macro.
3325 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3327 return sv_2pvbyte(sv, 0);
3331 =for apidoc sv_2pvbyte
3333 Return a pointer to the byte-encoded representation of the SV, and set *lp
3334 to its length. May cause the SV to be downgraded from UTF-8 as a
3337 Usually accessed via the C<SvPVbyte> macro.
3343 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3345 sv_utf8_downgrade(sv,0);
3346 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3350 =for apidoc sv_2pvutf8_nolen
3352 Return a pointer to the UTF-8-encoded representation of the SV.
3353 May cause the SV to be upgraded to UTF-8 as a side-effect.
3355 Usually accessed via the C<SvPVutf8_nolen> macro.
3361 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3363 return sv_2pvutf8(sv, 0);
3367 =for apidoc sv_2pvutf8
3369 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3370 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3372 Usually accessed via the C<SvPVutf8> macro.
3378 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3380 sv_utf8_upgrade(sv);
3381 return SvPV(sv,*lp);
3385 =for apidoc sv_2bool
3387 This function is only called on magical items, and is only used by
3388 sv_true() or its macro equivalent.
3394 Perl_sv_2bool(pTHX_ register SV *sv)
3403 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3404 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3405 return (bool)SvTRUE(tmpsv);
3406 return SvRV(sv) != 0;
3409 register XPV* Xpvtmp;
3410 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3411 (*sv->sv_u.svu_pv > '0' ||
3412 Xpvtmp->xpv_cur > 1 ||
3413 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3420 return SvIVX(sv) != 0;
3423 return SvNVX(sv) != 0.0;
3430 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3431 * this function provided for binary compatibility only
3436 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3438 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3442 =for apidoc sv_utf8_upgrade
3444 Converts the PV of an SV to its UTF-8-encoded form.
3445 Forces the SV to string form if it is not already.
3446 Always sets the SvUTF8 flag to avoid future validity checks even
3447 if all the bytes have hibit clear.
3449 This is not as a general purpose byte encoding to Unicode interface:
3450 use the Encode extension for that.
3452 =for apidoc sv_utf8_upgrade_flags
3454 Converts the PV of an SV to its UTF-8-encoded form.
3455 Forces the SV to string form if it is not already.
3456 Always sets the SvUTF8 flag to avoid future validity checks even
3457 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3458 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3459 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3461 This is not as a general purpose byte encoding to Unicode interface:
3462 use the Encode extension for that.
3468 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3470 if (sv == &PL_sv_undef)
3474 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3475 (void) sv_2pv_flags(sv,&len, flags);
3479 (void) SvPV_force(sv,len);
3488 sv_force_normal_flags(sv, 0);
3491 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3492 sv_recode_to_utf8(sv, PL_encoding);
3493 else { /* Assume Latin-1/EBCDIC */
3494 /* This function could be much more efficient if we
3495 * had a FLAG in SVs to signal if there are any hibit
3496 * chars in the PV. Given that there isn't such a flag
3497 * make the loop as fast as possible. */
3498 const U8 *s = (U8 *) SvPVX_const(sv);
3499 const U8 *e = (U8 *) SvEND(sv);
3505 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3509 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3510 U8 *recoded = bytes_to_utf8((U8*)s, &len);
3512 SvPV_free(sv); /* No longer using what was there before. */
3514 SvPV_set(sv, (char*)recoded);
3515 SvCUR_set(sv, len - 1);
3516 SvLEN_set(sv, len); /* No longer know the real size. */
3518 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3525 =for apidoc sv_utf8_downgrade
3527 Attempts to convert the PV of an SV from characters to bytes.
3528 If the PV contains a character beyond byte, this conversion will fail;
3529 in this case, either returns false or, if C<fail_ok> is not
3532 This is not as a general purpose Unicode to byte encoding interface:
3533 use the Encode extension for that.
3539 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3541 if (SvPOKp(sv) && SvUTF8(sv)) {
3547 sv_force_normal_flags(sv, 0);
3549 s = (U8 *) SvPV(sv, len);
3550 if (!utf8_to_bytes(s, &len)) {
3555 Perl_croak(aTHX_ "Wide character in %s",
3558 Perl_croak(aTHX_ "Wide character");
3569 =for apidoc sv_utf8_encode
3571 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3572 flag off so that it looks like octets again.
3578 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3580 (void) sv_utf8_upgrade(sv);
3582 sv_force_normal_flags(sv, 0);
3584 if (SvREADONLY(sv)) {
3585 Perl_croak(aTHX_ PL_no_modify);
3591 =for apidoc sv_utf8_decode
3593 If the PV of the SV is an octet sequence in UTF-8
3594 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3595 so that it looks like a character. If the PV contains only single-byte
3596 characters, the C<SvUTF8> flag stays being off.
3597 Scans PV for validity and returns false if the PV is invalid UTF-8.
3603 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3609 /* The octets may have got themselves encoded - get them back as
3612 if (!sv_utf8_downgrade(sv, TRUE))
3615 /* it is actually just a matter of turning the utf8 flag on, but
3616 * we want to make sure everything inside is valid utf8 first.
3618 c = (const U8 *) SvPVX_const(sv);
3619 if (!is_utf8_string(c, SvCUR(sv)+1))
3621 e = (const U8 *) SvEND(sv);
3624 if (!UTF8_IS_INVARIANT(ch)) {
3633 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3634 * this function provided for binary compatibility only
3638 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3640 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3644 =for apidoc sv_setsv
3646 Copies the contents of the source SV C<ssv> into the destination SV
3647 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3648 function if the source SV needs to be reused. Does not handle 'set' magic.
3649 Loosely speaking, it performs a copy-by-value, obliterating any previous
3650 content of the destination.
3652 You probably want to use one of the assortment of wrappers, such as
3653 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3654 C<SvSetMagicSV_nosteal>.
3656 =for apidoc sv_setsv_flags
3658 Copies the contents of the source SV C<ssv> into the destination SV
3659 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3660 function if the source SV needs to be reused. Does not handle 'set' magic.
3661 Loosely speaking, it performs a copy-by-value, obliterating any previous
3662 content of the destination.
3663 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3664 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3665 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3666 and C<sv_setsv_nomg> are implemented in terms of this function.
3668 You probably want to use one of the assortment of wrappers, such as
3669 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3670 C<SvSetMagicSV_nosteal>.
3672 This is the primary function for copying scalars, and most other
3673 copy-ish functions and macros use this underneath.
3679 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3681 register U32 sflags;
3687 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3689 sstr = &PL_sv_undef;
3690 stype = SvTYPE(sstr);
3691 dtype = SvTYPE(dstr);
3696 /* need to nuke the magic */
3698 SvRMAGICAL_off(dstr);
3701 /* There's a lot of redundancy below but we're going for speed here */
3706 if (dtype != SVt_PVGV) {
3707 (void)SvOK_off(dstr);
3715 sv_upgrade(dstr, SVt_IV);
3718 sv_upgrade(dstr, SVt_PVNV);
3722 sv_upgrade(dstr, SVt_PVIV);
3725 (void)SvIOK_only(dstr);
3726 SvIV_set(dstr, SvIVX(sstr));
3729 if (SvTAINTED(sstr))
3740 sv_upgrade(dstr, SVt_NV);
3745 sv_upgrade(dstr, SVt_PVNV);
3748 SvNV_set(dstr, SvNVX(sstr));
3749 (void)SvNOK_only(dstr);
3750 if (SvTAINTED(sstr))
3758 sv_upgrade(dstr, SVt_RV);
3759 else if (dtype == SVt_PVGV &&
3760 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3763 if (GvIMPORTED(dstr) != GVf_IMPORTED
3764 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3766 GvIMPORTED_on(dstr);
3775 #ifdef PERL_OLD_COPY_ON_WRITE
3776 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3777 if (dtype < SVt_PVIV)
3778 sv_upgrade(dstr, SVt_PVIV);
3785 sv_upgrade(dstr, SVt_PV);
3788 if (dtype < SVt_PVIV)
3789 sv_upgrade(dstr, SVt_PVIV);
3792 if (dtype < SVt_PVNV)
3793 sv_upgrade(dstr, SVt_PVNV);
3800 const char * const type = sv_reftype(sstr,0);
3802 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3804 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3809 if (dtype <= SVt_PVGV) {
3811 if (dtype != SVt_PVGV) {
3812 const char * const name = GvNAME(sstr);
3813 const STRLEN len = GvNAMELEN(sstr);
3814 /* don't upgrade SVt_PVLV: it can hold a glob */
3815 if (dtype != SVt_PVLV)
3816 sv_upgrade(dstr, SVt_PVGV);
3817 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3818 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3819 GvNAME(dstr) = savepvn(name, len);
3820 GvNAMELEN(dstr) = len;
3821 SvFAKE_on(dstr); /* can coerce to non-glob */
3823 /* ahem, death to those who redefine active sort subs */
3824 else if (PL_curstackinfo->si_type == PERLSI_SORT
3825 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3826 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3829 #ifdef GV_UNIQUE_CHECK
3830 if (GvUNIQUE((GV*)dstr)) {
3831 Perl_croak(aTHX_ PL_no_modify);
3835 (void)SvOK_off(dstr);
3836 GvINTRO_off(dstr); /* one-shot flag */
3838 GvGP(dstr) = gp_ref(GvGP(sstr));
3839 if (SvTAINTED(sstr))
3841 if (GvIMPORTED(dstr) != GVf_IMPORTED
3842 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3844 GvIMPORTED_on(dstr);
3852 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3854 if ((int)SvTYPE(sstr) != stype) {
3855 stype = SvTYPE(sstr);
3856 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3860 if (stype == SVt_PVLV)
3861 SvUPGRADE(dstr, SVt_PVNV);
3863 SvUPGRADE(dstr, (U32)stype);
3866 sflags = SvFLAGS(sstr);
3868 if (sflags & SVf_ROK) {
3869 if (dtype >= SVt_PV) {
3870 if (dtype == SVt_PVGV) {
3871 SV *sref = SvREFCNT_inc(SvRV(sstr));
3873 const int intro = GvINTRO(dstr);
3875 #ifdef GV_UNIQUE_CHECK
3876 if (GvUNIQUE((GV*)dstr)) {
3877 Perl_croak(aTHX_ PL_no_modify);
3882 GvINTRO_off(dstr); /* one-shot flag */
3883 GvLINE(dstr) = CopLINE(PL_curcop);
3884 GvEGV(dstr) = (GV*)dstr;
3887 switch (SvTYPE(sref)) {
3890 SAVEGENERICSV(GvAV(dstr));
3892 dref = (SV*)GvAV(dstr);
3893 GvAV(dstr) = (AV*)sref;
3894 if (!GvIMPORTED_AV(dstr)
3895 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3897 GvIMPORTED_AV_on(dstr);
3902 SAVEGENERICSV(GvHV(dstr));
3904 dref = (SV*)GvHV(dstr);
3905 GvHV(dstr) = (HV*)sref;
3906 if (!GvIMPORTED_HV(dstr)
3907 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3909 GvIMPORTED_HV_on(dstr);
3914 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3915 SvREFCNT_dec(GvCV(dstr));
3916 GvCV(dstr) = Nullcv;
3917 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3918 PL_sub_generation++;
3920 SAVEGENERICSV(GvCV(dstr));
3923 dref = (SV*)GvCV(dstr);
3924 if (GvCV(dstr) != (CV*)sref) {
3925 CV* cv = GvCV(dstr);
3927 if (!GvCVGEN((GV*)dstr) &&
3928 (CvROOT(cv) || CvXSUB(cv)))
3930 /* ahem, death to those who redefine
3931 * active sort subs */
3932 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3933 PL_sortcop == CvSTART(cv))
3935 "Can't redefine active sort subroutine %s",
3936 GvENAME((GV*)dstr));
3937 /* Redefining a sub - warning is mandatory if
3938 it was a const and its value changed. */
3939 if (ckWARN(WARN_REDEFINE)
3941 && (!CvCONST((CV*)sref)
3942 || sv_cmp(cv_const_sv(cv),
3943 cv_const_sv((CV*)sref)))))
3945 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3947 ? "Constant subroutine %s::%s redefined"
3948 : "Subroutine %s::%s redefined",
3949 HvNAME_get(GvSTASH((GV*)dstr)),
3950 GvENAME((GV*)dstr));
3954 cv_ckproto(cv, (GV*)dstr,
3956 ? SvPVX_const(sref) : Nullch);
3958 GvCV(dstr) = (CV*)sref;
3959 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3960 GvASSUMECV_on(dstr);
3961 PL_sub_generation++;
3963 if (!GvIMPORTED_CV(dstr)
3964 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3966 GvIMPORTED_CV_on(dstr);
3971 SAVEGENERICSV(GvIOp(dstr));
3973 dref = (SV*)GvIOp(dstr);
3974 GvIOp(dstr) = (IO*)sref;
3978 SAVEGENERICSV(GvFORM(dstr));
3980 dref = (SV*)GvFORM(dstr);
3981 GvFORM(dstr) = (CV*)sref;
3985 SAVEGENERICSV(GvSV(dstr));
3987 dref = (SV*)GvSV(dstr);
3989 if (!GvIMPORTED_SV(dstr)
3990 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3992 GvIMPORTED_SV_on(dstr);
3998 if (SvTAINTED(sstr))
4002 if (SvPVX_const(dstr)) {
4008 (void)SvOK_off(dstr);
4009 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4011 if (sflags & SVp_NOK) {
4013 /* Only set the public OK flag if the source has public OK. */
4014 if (sflags & SVf_NOK)
4015 SvFLAGS(dstr) |= SVf_NOK;
4016 SvNV_set(dstr, SvNVX(sstr));
4018 if (sflags & SVp_IOK) {
4019 (void)SvIOKp_on(dstr);
4020 if (sflags & SVf_IOK)
4021 SvFLAGS(dstr) |= SVf_IOK;
4022 if (sflags & SVf_IVisUV)
4024 SvIV_set(dstr, SvIVX(sstr));
4026 if (SvAMAGIC(sstr)) {
4030 else if (sflags & SVp_POK) {
4034 * Check to see if we can just swipe the string. If so, it's a
4035 * possible small lose on short strings, but a big win on long ones.
4036 * It might even be a win on short strings if SvPVX_const(dstr)
4037 * has to be allocated and SvPVX_const(sstr) has to be freed.
4040 /* Whichever path we take through the next code, we want this true,
4041 and doing it now facilitates the COW check. */
4042 (void)SvPOK_only(dstr);
4045 /* We're not already COW */
4046 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4047 #ifndef PERL_OLD_COPY_ON_WRITE
4048 /* or we are, but dstr isn't a suitable target. */
4049 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4054 (sflags & SVs_TEMP) && /* slated for free anyway? */
4055 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4056 (!(flags & SV_NOSTEAL)) &&
4057 /* and we're allowed to steal temps */
4058 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4059 SvLEN(sstr) && /* and really is a string */
4060 /* and won't be needed again, potentially */
4061 !(PL_op && PL_op->op_type == OP_AASSIGN))
4062 #ifdef PERL_OLD_COPY_ON_WRITE
4063 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4064 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4065 && SvTYPE(sstr) >= SVt_PVIV)
4068 /* Failed the swipe test, and it's not a shared hash key either.
4069 Have to copy the string. */
4070 STRLEN len = SvCUR(sstr);
4071 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4072 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4073 SvCUR_set(dstr, len);
4074 *SvEND(dstr) = '\0';
4076 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4078 /* Either it's a shared hash key, or it's suitable for
4079 copy-on-write or we can swipe the string. */
4081 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4085 #ifdef PERL_OLD_COPY_ON_WRITE
4087 /* I believe I should acquire a global SV mutex if
4088 it's a COW sv (not a shared hash key) to stop
4089 it going un copy-on-write.
4090 If the source SV has gone un copy on write between up there
4091 and down here, then (assert() that) it is of the correct
4092 form to make it copy on write again */
4093 if ((sflags & (SVf_FAKE | SVf_READONLY))
4094 != (SVf_FAKE | SVf_READONLY)) {
4095 SvREADONLY_on(sstr);
4097 /* Make the source SV into a loop of 1.
4098 (about to become 2) */
4099 SV_COW_NEXT_SV_SET(sstr, sstr);
4103 /* Initial code is common. */
4104 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4106 SvFLAGS(dstr) &= ~SVf_OOK;
4107 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4109 else if (SvLEN(dstr))
4110 Safefree(SvPVX_const(dstr));
4114 /* making another shared SV. */
4115 STRLEN cur = SvCUR(sstr);
4116 STRLEN len = SvLEN(sstr);
4117 #ifdef PERL_OLD_COPY_ON_WRITE
4119 assert (SvTYPE(dstr) >= SVt_PVIV);
4120 /* SvIsCOW_normal */
4121 /* splice us in between source and next-after-source. */
4122 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4123 SV_COW_NEXT_SV_SET(sstr, dstr);
4124 SvPV_set(dstr, SvPVX_mutable(sstr));
4128 /* SvIsCOW_shared_hash */
4129 DEBUG_C(PerlIO_printf(Perl_debug_log,
4130 "Copy on write: Sharing hash\n"));
4132 assert (SvTYPE(dstr) >= SVt_PV);
4134 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4136 SvLEN_set(dstr, len);
4137 SvCUR_set(dstr, cur);
4138 SvREADONLY_on(dstr);
4140 /* Relesase a global SV mutex. */
4143 { /* Passes the swipe test. */
4144 SvPV_set(dstr, SvPVX_mutable(sstr));
4145 SvLEN_set(dstr, SvLEN(sstr));
4146 SvCUR_set(dstr, SvCUR(sstr));
4149 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4150 SvPV_set(sstr, Nullch);
4156 if (sflags & SVf_UTF8)
4158 if (sflags & SVp_NOK) {
4160 if (sflags & SVf_NOK)
4161 SvFLAGS(dstr) |= SVf_NOK;
4162 SvNV_set(dstr, SvNVX(sstr));
4164 if (sflags & SVp_IOK) {
4165 (void)SvIOKp_on(dstr);
4166 if (sflags & SVf_IOK)
4167 SvFLAGS(dstr) |= SVf_IOK;
4168 if (sflags & SVf_IVisUV)
4170 SvIV_set(dstr, SvIVX(sstr));
4173 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4174 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4175 smg->mg_ptr, smg->mg_len);
4176 SvRMAGICAL_on(dstr);
4179 else if (sflags & SVp_IOK) {
4180 if (sflags & SVf_IOK)
4181 (void)SvIOK_only(dstr);
4183 (void)SvOK_off(dstr);
4184 (void)SvIOKp_on(dstr);
4186 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4187 if (sflags & SVf_IVisUV)
4189 SvIV_set(dstr, SvIVX(sstr));
4190 if (sflags & SVp_NOK) {
4191 if (sflags & SVf_NOK)
4192 (void)SvNOK_on(dstr);
4194 (void)SvNOKp_on(dstr);
4195 SvNV_set(dstr, SvNVX(sstr));
4198 else if (sflags & SVp_NOK) {
4199 if (sflags & SVf_NOK)
4200 (void)SvNOK_only(dstr);
4202 (void)SvOK_off(dstr);
4205 SvNV_set(dstr, SvNVX(sstr));
4208 if (dtype == SVt_PVGV) {
4209 if (ckWARN(WARN_MISC))
4210 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4213 (void)SvOK_off(dstr);
4215 if (SvTAINTED(sstr))
4220 =for apidoc sv_setsv_mg
4222 Like C<sv_setsv>, but also handles 'set' magic.
4228 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4230 sv_setsv(dstr,sstr);
4234 #ifdef PERL_OLD_COPY_ON_WRITE
4236 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4238 STRLEN cur = SvCUR(sstr);
4239 STRLEN len = SvLEN(sstr);
4240 register char *new_pv;
4243 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4251 if (SvTHINKFIRST(dstr))
4252 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4253 else if (SvPVX_const(dstr))
4254 Safefree(SvPVX_const(dstr));
4258 SvUPGRADE(dstr, SVt_PVIV);
4260 assert (SvPOK(sstr));
4261 assert (SvPOKp(sstr));
4262 assert (!SvIOK(sstr));
4263 assert (!SvIOKp(sstr));
4264 assert (!SvNOK(sstr));
4265 assert (!SvNOKp(sstr));
4267 if (SvIsCOW(sstr)) {
4269 if (SvLEN(sstr) == 0) {
4270 /* source is a COW shared hash key. */
4271 DEBUG_C(PerlIO_printf(Perl_debug_log,
4272 "Fast copy on write: Sharing hash\n"));
4273 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4276 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4278 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4279 SvUPGRADE(sstr, SVt_PVIV);
4280 SvREADONLY_on(sstr);
4282 DEBUG_C(PerlIO_printf(Perl_debug_log,
4283 "Fast copy on write: Converting sstr to COW\n"));
4284 SV_COW_NEXT_SV_SET(dstr, sstr);
4286 SV_COW_NEXT_SV_SET(sstr, dstr);
4287 new_pv = SvPVX_mutable(sstr);
4290 SvPV_set(dstr, new_pv);
4291 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4294 SvLEN_set(dstr, len);
4295 SvCUR_set(dstr, cur);
4304 =for apidoc sv_setpvn
4306 Copies a string into an SV. The C<len> parameter indicates the number of
4307 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4308 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4314 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4316 register char *dptr;
4318 SV_CHECK_THINKFIRST_COW_DROP(sv);
4324 /* len is STRLEN which is unsigned, need to copy to signed */
4327 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4329 SvUPGRADE(sv, SVt_PV);
4331 dptr = SvGROW(sv, len + 1);
4332 Move(ptr,dptr,len,char);
4335 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4340 =for apidoc sv_setpvn_mg
4342 Like C<sv_setpvn>, but also handles 'set' magic.
4348 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4350 sv_setpvn(sv,ptr,len);
4355 =for apidoc sv_setpv
4357 Copies a string into an SV. The string must be null-terminated. Does not
4358 handle 'set' magic. See C<sv_setpv_mg>.
4364 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4366 register STRLEN len;
4368 SV_CHECK_THINKFIRST_COW_DROP(sv);
4374 SvUPGRADE(sv, SVt_PV);
4376 SvGROW(sv, len + 1);
4377 Move(ptr,SvPVX(sv),len+1,char);
4379 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4384 =for apidoc sv_setpv_mg
4386 Like C<sv_setpv>, but also handles 'set' magic.
4392 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4399 =for apidoc sv_usepvn
4401 Tells an SV to use C<ptr> to find its string value. Normally the string is
4402 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4403 The C<ptr> should point to memory that was allocated by C<malloc>. The
4404 string length, C<len>, must be supplied. This function will realloc the
4405 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4406 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4407 See C<sv_usepvn_mg>.
4413 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4416 SV_CHECK_THINKFIRST_COW_DROP(sv);
4417 SvUPGRADE(sv, SVt_PV);
4422 if (SvPVX_const(sv))
4425 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4426 ptr = saferealloc (ptr, allocate);
4429 SvLEN_set(sv, allocate);
4431 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4436 =for apidoc sv_usepvn_mg
4438 Like C<sv_usepvn>, but also handles 'set' magic.
4444 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4446 sv_usepvn(sv,ptr,len);
4450 #ifdef PERL_OLD_COPY_ON_WRITE
4451 /* Need to do this *after* making the SV normal, as we need the buffer
4452 pointer to remain valid until after we've copied it. If we let go too early,
4453 another thread could invalidate it by unsharing last of the same hash key
4454 (which it can do by means other than releasing copy-on-write Svs)
4455 or by changing the other copy-on-write SVs in the loop. */
4457 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4459 if (len) { /* this SV was SvIsCOW_normal(sv) */
4460 /* we need to find the SV pointing to us. */
4461 SV *current = SV_COW_NEXT_SV(after);
4463 if (current == sv) {
4464 /* The SV we point to points back to us (there were only two of us
4466 Hence other SV is no longer copy on write either. */
4468 SvREADONLY_off(after);
4470 /* We need to follow the pointers around the loop. */
4472 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4475 /* don't loop forever if the structure is bust, and we have
4476 a pointer into a closed loop. */
4477 assert (current != after);
4478 assert (SvPVX_const(current) == pvx);
4480 /* Make the SV before us point to the SV after us. */
4481 SV_COW_NEXT_SV_SET(current, after);
4484 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4489 Perl_sv_release_IVX(pTHX_ register SV *sv)
4492 sv_force_normal_flags(sv, 0);
4498 =for apidoc sv_force_normal_flags
4500 Undo various types of fakery on an SV: if the PV is a shared string, make
4501 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4502 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4503 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4504 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4505 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4506 set to some other value.) In addition, the C<flags> parameter gets passed to
4507 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4508 with flags set to 0.
4514 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4516 #ifdef PERL_OLD_COPY_ON_WRITE
4517 if (SvREADONLY(sv)) {
4518 /* At this point I believe I should acquire a global SV mutex. */
4520 const char *pvx = SvPVX_const(sv);
4521 const STRLEN len = SvLEN(sv);
4522 const STRLEN cur = SvCUR(sv);
4523 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4525 PerlIO_printf(Perl_debug_log,
4526 "Copy on write: Force normal %ld\n",
4532 /* This SV doesn't own the buffer, so need to New() a new one: */
4533 SvPV_set(sv, (char*)0);
4535 if (flags & SV_COW_DROP_PV) {
4536 /* OK, so we don't need to copy our buffer. */
4539 SvGROW(sv, cur + 1);
4540 Move(pvx,SvPVX(sv),cur,char);
4544 sv_release_COW(sv, pvx, len, next);
4549 else if (IN_PERL_RUNTIME)
4550 Perl_croak(aTHX_ PL_no_modify);
4551 /* At this point I believe that I can drop the global SV mutex. */
4554 if (SvREADONLY(sv)) {
4556 const char *pvx = SvPVX_const(sv);
4557 const STRLEN len = SvCUR(sv);
4560 SvPV_set(sv, Nullch);
4562 SvGROW(sv, len + 1);
4563 Move(pvx,SvPVX_const(sv),len,char);
4565 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4567 else if (IN_PERL_RUNTIME)
4568 Perl_croak(aTHX_ PL_no_modify);
4572 sv_unref_flags(sv, flags);
4573 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4578 =for apidoc sv_force_normal
4580 Undo various types of fakery on an SV: if the PV is a shared string, make
4581 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4582 an xpvmg. See also C<sv_force_normal_flags>.
4588 Perl_sv_force_normal(pTHX_ register SV *sv)
4590 sv_force_normal_flags(sv, 0);
4596 Efficient removal of characters from the beginning of the string buffer.
4597 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4598 the string buffer. The C<ptr> becomes the first character of the adjusted
4599 string. Uses the "OOK hack".
4600 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4601 refer to the same chunk of data.
4607 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4609 register STRLEN delta;
4610 if (!ptr || !SvPOKp(sv))
4612 delta = ptr - SvPVX_const(sv);
4613 SV_CHECK_THINKFIRST(sv);
4614 if (SvTYPE(sv) < SVt_PVIV)
4615 sv_upgrade(sv,SVt_PVIV);
4618 if (!SvLEN(sv)) { /* make copy of shared string */
4619 const char *pvx = SvPVX_const(sv);
4620 const STRLEN len = SvCUR(sv);
4621 SvGROW(sv, len + 1);
4622 Move(pvx,SvPVX_const(sv),len,char);
4626 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4627 and we do that anyway inside the SvNIOK_off
4629 SvFLAGS(sv) |= SVf_OOK;
4632 SvLEN_set(sv, SvLEN(sv) - delta);
4633 SvCUR_set(sv, SvCUR(sv) - delta);
4634 SvPV_set(sv, SvPVX(sv) + delta);
4635 SvIV_set(sv, SvIVX(sv) + delta);
4638 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4639 * this function provided for binary compatibility only
4643 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4645 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4649 =for apidoc sv_catpvn
4651 Concatenates the string onto the end of the string which is in the SV. The
4652 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4653 status set, then the bytes appended should be valid UTF-8.
4654 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4656 =for apidoc sv_catpvn_flags
4658 Concatenates the string onto the end of the string which is in the SV. The
4659 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4660 status set, then the bytes appended should be valid UTF-8.
4661 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4662 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4663 in terms of this function.
4669 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4672 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4674 SvGROW(dsv, dlen + slen + 1);
4676 sstr = SvPVX_const(dsv);
4677 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4678 SvCUR_set(dsv, SvCUR(dsv) + slen);
4680 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4685 =for apidoc sv_catpvn_mg
4687 Like C<sv_catpvn>, but also handles 'set' magic.
4693 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4695 sv_catpvn(sv,ptr,len);
4699 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4700 * this function provided for binary compatibility only
4704 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4706 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4710 =for apidoc sv_catsv
4712 Concatenates the string from SV C<ssv> onto the end of the string in
4713 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4714 not 'set' magic. See C<sv_catsv_mg>.
4716 =for apidoc sv_catsv_flags
4718 Concatenates the string from SV C<ssv> onto the end of the string in
4719 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4720 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4721 and C<sv_catsv_nomg> are implemented in terms of this function.
4726 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4732 if ((spv = SvPV_const(ssv, slen))) {
4733 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4734 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4735 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4736 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4737 dsv->sv_flags doesn't have that bit set.
4738 Andy Dougherty 12 Oct 2001
4740 const I32 sutf8 = DO_UTF8(ssv);
4743 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4745 dutf8 = DO_UTF8(dsv);
4747 if (dutf8 != sutf8) {
4749 /* Not modifying source SV, so taking a temporary copy. */
4750 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4752 sv_utf8_upgrade(csv);
4753 spv = SvPV_const(csv, slen);
4756 sv_utf8_upgrade_nomg(dsv);
4758 sv_catpvn_nomg(dsv, spv, slen);
4763 =for apidoc sv_catsv_mg
4765 Like C<sv_catsv>, but also handles 'set' magic.
4771 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4778 =for apidoc sv_catpv
4780 Concatenates the string onto the end of the string which is in the SV.
4781 If the SV has the UTF-8 status set, then the bytes appended should be
4782 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4787 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4789 register STRLEN len;
4795 junk = SvPV_force(sv, tlen);
4797 SvGROW(sv, tlen + len + 1);
4799 ptr = SvPVX_const(sv);
4800 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4801 SvCUR_set(sv, SvCUR(sv) + len);
4802 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4807 =for apidoc sv_catpv_mg
4809 Like C<sv_catpv>, but also handles 'set' magic.
4815 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4824 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4825 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4832 Perl_newSV(pTHX_ STRLEN len)
4838 sv_upgrade(sv, SVt_PV);
4839 SvGROW(sv, len + 1);
4844 =for apidoc sv_magicext
4846 Adds magic to an SV, upgrading it if necessary. Applies the
4847 supplied vtable and returns a pointer to the magic added.
4849 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4850 In particular, you can add magic to SvREADONLY SVs, and add more than
4851 one instance of the same 'how'.
4853 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4854 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4855 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4856 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4858 (This is now used as a subroutine by C<sv_magic>.)
4863 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4864 const char* name, I32 namlen)
4868 if (SvTYPE(sv) < SVt_PVMG) {
4869 SvUPGRADE(sv, SVt_PVMG);
4871 Newz(702,mg, 1, MAGIC);
4872 mg->mg_moremagic = SvMAGIC(sv);
4873 SvMAGIC_set(sv, mg);
4875 /* Sometimes a magic contains a reference loop, where the sv and
4876 object refer to each other. To prevent a reference loop that
4877 would prevent such objects being freed, we look for such loops
4878 and if we find one we avoid incrementing the object refcount.
4880 Note we cannot do this to avoid self-tie loops as intervening RV must
4881 have its REFCNT incremented to keep it in existence.
4884 if (!obj || obj == sv ||
4885 how == PERL_MAGIC_arylen ||
4886 how == PERL_MAGIC_qr ||
4887 how == PERL_MAGIC_symtab ||
4888 (SvTYPE(obj) == SVt_PVGV &&
4889 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4890 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4891 GvFORM(obj) == (CV*)sv)))
4896 mg->mg_obj = SvREFCNT_inc(obj);
4897 mg->mg_flags |= MGf_REFCOUNTED;
4900 /* Normal self-ties simply pass a null object, and instead of
4901 using mg_obj directly, use the SvTIED_obj macro to produce a
4902 new RV as needed. For glob "self-ties", we are tieing the PVIO
4903 with an RV obj pointing to the glob containing the PVIO. In
4904 this case, to avoid a reference loop, we need to weaken the
4908 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4909 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4915 mg->mg_len = namlen;
4918 mg->mg_ptr = savepvn(name, namlen);
4919 else if (namlen == HEf_SVKEY)
4920 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4922 mg->mg_ptr = (char *) name;
4924 mg->mg_virtual = vtable;
4928 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4933 =for apidoc sv_magic
4935 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4936 then adds a new magic item of type C<how> to the head of the magic list.
4938 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4939 handling of the C<name> and C<namlen> arguments.
4941 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4942 to add more than one instance of the same 'how'.
4948 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4950 const MGVTBL *vtable = 0;
4953 #ifdef PERL_OLD_COPY_ON_WRITE
4955 sv_force_normal_flags(sv, 0);
4957 if (SvREADONLY(sv)) {
4959 && how != PERL_MAGIC_regex_global
4960 && how != PERL_MAGIC_bm
4961 && how != PERL_MAGIC_fm
4962 && how != PERL_MAGIC_sv
4963 && how != PERL_MAGIC_backref
4966 Perl_croak(aTHX_ PL_no_modify);
4969 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4970 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4971 /* sv_magic() refuses to add a magic of the same 'how' as an
4974 if (how == PERL_MAGIC_taint)
4982 vtable = &PL_vtbl_sv;
4984 case PERL_MAGIC_overload:
4985 vtable = &PL_vtbl_amagic;
4987 case PERL_MAGIC_overload_elem:
4988 vtable = &PL_vtbl_amagicelem;
4990 case PERL_MAGIC_overload_table:
4991 vtable = &PL_vtbl_ovrld;
4994 vtable = &PL_vtbl_bm;
4996 case PERL_MAGIC_regdata:
4997 vtable = &PL_vtbl_regdata;
4999 case PERL_MAGIC_regdatum:
5000 vtable = &PL_vtbl_regdatum;
5002 case PERL_MAGIC_env:
5003 vtable = &PL_vtbl_env;
5006 vtable = &PL_vtbl_fm;
5008 case PERL_MAGIC_envelem:
5009 vtable = &PL_vtbl_envelem;
5011 case PERL_MAGIC_regex_global:
5012 vtable = &PL_vtbl_mglob;
5014 case PERL_MAGIC_isa:
5015 vtable = &PL_vtbl_isa;
5017 case PERL_MAGIC_isaelem:
5018 vtable = &PL_vtbl_isaelem;
5020 case PERL_MAGIC_nkeys:
5021 vtable = &PL_vtbl_nkeys;
5023 case PERL_MAGIC_dbfile:
5026 case PERL_MAGIC_dbline:
5027 vtable = &PL_vtbl_dbline;
5029 #ifdef USE_LOCALE_COLLATE
5030 case PERL_MAGIC_collxfrm:
5031 vtable = &PL_vtbl_collxfrm;
5033 #endif /* USE_LOCALE_COLLATE */
5034 case PERL_MAGIC_tied:
5035 vtable = &PL_vtbl_pack;
5037 case PERL_MAGIC_tiedelem:
5038 case PERL_MAGIC_tiedscalar:
5039 vtable = &PL_vtbl_packelem;
5042 vtable = &PL_vtbl_regexp;
5044 case PERL_MAGIC_sig:
5045 vtable = &PL_vtbl_sig;
5047 case PERL_MAGIC_sigelem:
5048 vtable = &PL_vtbl_sigelem;
5050 case PERL_MAGIC_taint:
5051 vtable = &PL_vtbl_taint;
5053 case PERL_MAGIC_uvar:
5054 vtable = &PL_vtbl_uvar;
5056 case PERL_MAGIC_vec:
5057 vtable = &PL_vtbl_vec;
5059 case PERL_MAGIC_arylen_p:
5060 case PERL_MAGIC_rhash:
5061 case PERL_MAGIC_symtab:
5062 case PERL_MAGIC_vstring:
5065 case PERL_MAGIC_utf8:
5066 vtable = &PL_vtbl_utf8;
5068 case PERL_MAGIC_substr:
5069 vtable = &PL_vtbl_substr;
5071 case PERL_MAGIC_defelem:
5072 vtable = &PL_vtbl_defelem;
5074 case PERL_MAGIC_glob:
5075 vtable = &PL_vtbl_glob;
5077 case PERL_MAGIC_arylen:
5078 vtable = &PL_vtbl_arylen;
5080 case PERL_MAGIC_pos:
5081 vtable = &PL_vtbl_pos;
5083 case PERL_MAGIC_backref:
5084 vtable = &PL_vtbl_backref;
5086 case PERL_MAGIC_ext:
5087 /* Reserved for use by extensions not perl internals. */
5088 /* Useful for attaching extension internal data to perl vars. */
5089 /* Note that multiple extensions may clash if magical scalars */
5090 /* etc holding private data from one are passed to another. */
5093 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5096 /* Rest of work is done else where */
5097 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5100 case PERL_MAGIC_taint:
5103 case PERL_MAGIC_ext:
5104 case PERL_MAGIC_dbfile:
5111 =for apidoc sv_unmagic
5113 Removes all magic of type C<type> from an SV.
5119 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5123 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5126 for (mg = *mgp; mg; mg = *mgp) {
5127 if (mg->mg_type == type) {
5128 const MGVTBL* const vtbl = mg->mg_virtual;
5129 *mgp = mg->mg_moremagic;
5130 if (vtbl && vtbl->svt_free)
5131 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5132 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5134 Safefree(mg->mg_ptr);
5135 else if (mg->mg_len == HEf_SVKEY)
5136 SvREFCNT_dec((SV*)mg->mg_ptr);
5137 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5138 Safefree(mg->mg_ptr);
5140 if (mg->mg_flags & MGf_REFCOUNTED)
5141 SvREFCNT_dec(mg->mg_obj);
5145 mgp = &mg->mg_moremagic;
5149 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5156 =for apidoc sv_rvweaken
5158 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5159 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5160 push a back-reference to this RV onto the array of backreferences
5161 associated with that magic.
5167 Perl_sv_rvweaken(pTHX_ SV *sv)
5170 if (!SvOK(sv)) /* let undefs pass */
5173 Perl_croak(aTHX_ "Can't weaken a nonreference");
5174 else if (SvWEAKREF(sv)) {
5175 if (ckWARN(WARN_MISC))
5176 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5180 sv_add_backref(tsv, sv);
5186 /* Give tsv backref magic if it hasn't already got it, then push a
5187 * back-reference to sv onto the array associated with the backref magic.
5191 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5195 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5196 av = (AV*)mg->mg_obj;
5199 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5200 /* av now has a refcnt of 2, which avoids it getting freed
5201 * before us during global cleanup. The extra ref is removed
5202 * by magic_killbackrefs() when tsv is being freed */
5204 if (AvFILLp(av) >= AvMAX(av)) {
5206 SV **svp = AvARRAY(av);
5207 for (i = AvFILLp(av); i >= 0; i--)
5209 svp[i] = sv; /* reuse the slot */
5212 av_extend(av, AvFILLp(av)+1);
5214 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5217 /* delete a back-reference to ourselves from the backref magic associated
5218 * with the SV we point to.
5222 S_sv_del_backref(pTHX_ SV *sv)
5229 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5230 Perl_croak(aTHX_ "panic: del_backref");
5231 av = (AV *)mg->mg_obj;
5233 for (i = AvFILLp(av); i >= 0; i--)
5234 if (svp[i] == sv) svp[i] = Nullsv;
5238 =for apidoc sv_insert
5240 Inserts a string at the specified offset/length within the SV. Similar to
5241 the Perl substr() function.
5247 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5251 register char *midend;
5252 register char *bigend;
5258 Perl_croak(aTHX_ "Can't modify non-existent substring");
5259 SvPV_force(bigstr, curlen);
5260 (void)SvPOK_only_UTF8(bigstr);
5261 if (offset + len > curlen) {
5262 SvGROW(bigstr, offset+len+1);
5263 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5264 SvCUR_set(bigstr, offset+len);
5268 i = littlelen - len;
5269 if (i > 0) { /* string might grow */
5270 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5271 mid = big + offset + len;
5272 midend = bigend = big + SvCUR(bigstr);
5275 while (midend > mid) /* shove everything down */
5276 *--bigend = *--midend;
5277 Move(little,big+offset,littlelen,char);
5278 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5283 Move(little,SvPVX(bigstr)+offset,len,char);
5288 big = SvPVX(bigstr);
5291 bigend = big + SvCUR(bigstr);
5293 if (midend > bigend)
5294 Perl_croak(aTHX_ "panic: sv_insert");
5296 if (mid - big > bigend - midend) { /* faster to shorten from end */
5298 Move(little, mid, littlelen,char);
5301 i = bigend - midend;
5303 Move(midend, mid, i,char);
5307 SvCUR_set(bigstr, mid - big);
5309 else if ((i = mid - big)) { /* faster from front */
5310 midend -= littlelen;
5312 sv_chop(bigstr,midend-i);
5317 Move(little, mid, littlelen,char);
5319 else if (littlelen) {
5320 midend -= littlelen;
5321 sv_chop(bigstr,midend);
5322 Move(little,midend,littlelen,char);
5325 sv_chop(bigstr,midend);
5331 =for apidoc sv_replace
5333 Make the first argument a copy of the second, then delete the original.
5334 The target SV physically takes over ownership of the body of the source SV
5335 and inherits its flags; however, the target keeps any magic it owns,
5336 and any magic in the source is discarded.
5337 Note that this is a rather specialist SV copying operation; most of the
5338 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5344 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5346 const U32 refcnt = SvREFCNT(sv);
5347 SV_CHECK_THINKFIRST_COW_DROP(sv);
5348 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5349 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5350 if (SvMAGICAL(sv)) {
5354 sv_upgrade(nsv, SVt_PVMG);
5355 SvMAGIC_set(nsv, SvMAGIC(sv));
5356 SvFLAGS(nsv) |= SvMAGICAL(sv);
5358 SvMAGIC_set(sv, NULL);
5362 assert(!SvREFCNT(sv));
5363 #ifdef DEBUG_LEAKING_SCALARS
5364 sv->sv_flags = nsv->sv_flags;
5365 sv->sv_any = nsv->sv_any;
5366 sv->sv_refcnt = nsv->sv_refcnt;
5367 sv->sv_u = nsv->sv_u;
5369 StructCopy(nsv,sv,SV);
5371 /* Currently could join these into one piece of pointer arithmetic, but
5372 it would be unclear. */
5373 if(SvTYPE(sv) == SVt_IV)
5375 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5376 else if (SvTYPE(sv) == SVt_RV) {
5377 SvANY(sv) = &sv->sv_u.svu_rv;
5381 #ifdef PERL_OLD_COPY_ON_WRITE
5382 if (SvIsCOW_normal(nsv)) {
5383 /* We need to follow the pointers around the loop to make the
5384 previous SV point to sv, rather than nsv. */
5387 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5390 assert(SvPVX_const(current) == SvPVX_const(nsv));
5392 /* Make the SV before us point to the SV after us. */
5394 PerlIO_printf(Perl_debug_log, "previous is\n");
5396 PerlIO_printf(Perl_debug_log,
5397 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5398 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5400 SV_COW_NEXT_SV_SET(current, sv);
5403 SvREFCNT(sv) = refcnt;
5404 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5410 =for apidoc sv_clear
5412 Clear an SV: call any destructors, free up any memory used by the body,
5413 and free the body itself. The SV's head is I<not> freed, although
5414 its type is set to all 1's so that it won't inadvertently be assumed
5415 to be live during global destruction etc.
5416 This function should only be called when REFCNT is zero. Most of the time
5417 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5424 Perl_sv_clear(pTHX_ register SV *sv)
5429 assert(SvREFCNT(sv) == 0);
5432 if (PL_defstash) { /* Still have a symbol table? */
5436 stash = SvSTASH(sv);
5437 destructor = StashHANDLER(stash,DESTROY);
5439 SV* tmpref = newRV(sv);
5440 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5442 PUSHSTACKi(PERLSI_DESTROY);
5447 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5453 if(SvREFCNT(tmpref) < 2) {
5454 /* tmpref is not kept alive! */
5456 SvRV_set(tmpref, NULL);
5459 SvREFCNT_dec(tmpref);
5461 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5465 if (PL_in_clean_objs)
5466 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5468 /* DESTROY gave object new lease on life */
5474 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5475 SvOBJECT_off(sv); /* Curse the object. */
5476 if (SvTYPE(sv) != SVt_PVIO)
5477 --PL_sv_objcount; /* XXX Might want something more general */
5480 if (SvTYPE(sv) >= SVt_PVMG) {
5483 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5484 SvREFCNT_dec(SvSTASH(sv));
5487 switch (SvTYPE(sv)) {
5490 IoIFP(sv) != PerlIO_stdin() &&
5491 IoIFP(sv) != PerlIO_stdout() &&
5492 IoIFP(sv) != PerlIO_stderr())
5494 io_close((IO*)sv, FALSE);
5496 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5497 PerlDir_close(IoDIRP(sv));
5498 IoDIRP(sv) = (DIR*)NULL;
5499 Safefree(IoTOP_NAME(sv));
5500 Safefree(IoFMT_NAME(sv));
5501 Safefree(IoBOTTOM_NAME(sv));
5516 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5517 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5518 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5519 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5521 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5522 SvREFCNT_dec(LvTARG(sv));
5526 Safefree(GvNAME(sv));
5527 /* cannot decrease stash refcount yet, as we might recursively delete
5528 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5529 of stash until current sv is completely gone.
5530 -- JohnPC, 27 Mar 1998 */
5531 stash = GvSTASH(sv);
5537 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5539 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5540 /* Don't even bother with turning off the OOK flag. */
5549 SvREFCNT_dec(SvRV(sv));
5551 #ifdef PERL_OLD_COPY_ON_WRITE
5552 else if (SvPVX_const(sv)) {
5554 /* I believe I need to grab the global SV mutex here and
5555 then recheck the COW status. */
5557 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5560 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5561 SV_COW_NEXT_SV(sv));
5562 /* And drop it here. */
5564 } else if (SvLEN(sv)) {
5565 Safefree(SvPVX_const(sv));
5569 else if (SvPVX_const(sv) && SvLEN(sv))
5570 Safefree(SvPVX_const(sv));
5571 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5572 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5585 switch (SvTYPE(sv)) {
5599 del_XPVIV(SvANY(sv));
5602 del_XPVNV(SvANY(sv));
5605 del_XPVMG(SvANY(sv));
5608 del_XPVLV(SvANY(sv));
5611 del_XPVAV(SvANY(sv));
5614 del_XPVHV(SvANY(sv));
5617 del_XPVCV(SvANY(sv));
5620 del_XPVGV(SvANY(sv));
5621 /* code duplication for increased performance. */
5622 SvFLAGS(sv) &= SVf_BREAK;
5623 SvFLAGS(sv) |= SVTYPEMASK;
5624 /* decrease refcount of the stash that owns this GV, if any */
5626 SvREFCNT_dec(stash);
5627 return; /* not break, SvFLAGS reset already happened */
5629 del_XPVBM(SvANY(sv));
5632 del_XPVFM(SvANY(sv));
5635 del_XPVIO(SvANY(sv));
5638 SvFLAGS(sv) &= SVf_BREAK;
5639 SvFLAGS(sv) |= SVTYPEMASK;
5643 =for apidoc sv_newref
5645 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5652 Perl_sv_newref(pTHX_ SV *sv)
5662 Decrement an SV's reference count, and if it drops to zero, call
5663 C<sv_clear> to invoke destructors and free up any memory used by
5664 the body; finally, deallocate the SV's head itself.
5665 Normally called via a wrapper macro C<SvREFCNT_dec>.
5671 Perl_sv_free(pTHX_ SV *sv)
5676 if (SvREFCNT(sv) == 0) {
5677 if (SvFLAGS(sv) & SVf_BREAK)
5678 /* this SV's refcnt has been artificially decremented to
5679 * trigger cleanup */
5681 if (PL_in_clean_all) /* All is fair */
5683 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5684 /* make sure SvREFCNT(sv)==0 happens very seldom */
5685 SvREFCNT(sv) = (~(U32)0)/2;
5688 if (ckWARN_d(WARN_INTERNAL))
5689 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5690 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5691 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5694 if (--(SvREFCNT(sv)) > 0)
5696 Perl_sv_free2(aTHX_ sv);
5700 Perl_sv_free2(pTHX_ SV *sv)
5705 if (ckWARN_d(WARN_DEBUGGING))
5706 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5707 "Attempt to free temp prematurely: SV 0x%"UVxf
5708 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5712 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5713 /* make sure SvREFCNT(sv)==0 happens very seldom */
5714 SvREFCNT(sv) = (~(U32)0)/2;
5725 Returns the length of the string in the SV. Handles magic and type
5726 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5732 Perl_sv_len(pTHX_ register SV *sv)
5740 len = mg_length(sv);
5742 (void)SvPV_const(sv, len);
5747 =for apidoc sv_len_utf8
5749 Returns the number of characters in the string in an SV, counting wide
5750 UTF-8 bytes as a single character. Handles magic and type coercion.
5756 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5757 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5758 * (Note that the mg_len is not the length of the mg_ptr field.)
5763 Perl_sv_len_utf8(pTHX_ register SV *sv)
5769 return mg_length(sv);
5773 const U8 *s = (U8*)SvPV_const(sv, len);
5774 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5776 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5778 #ifdef PERL_UTF8_CACHE_ASSERT
5779 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5783 ulen = Perl_utf8_length(aTHX_ s, s + len);
5784 if (!mg && !SvREADONLY(sv)) {
5785 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5786 mg = mg_find(sv, PERL_MAGIC_utf8);
5796 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5797 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5798 * between UTF-8 and byte offsets. There are two (substr offset and substr
5799 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5800 * and byte offset) cache positions.
5802 * The mg_len field is used by sv_len_utf8(), see its comments.
5803 * Note that the mg_len is not the length of the mg_ptr field.
5807 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5808 I32 offsetp, const U8 *s, const U8 *start)
5812 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5814 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5818 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5820 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5821 (*mgp)->mg_ptr = (char *) *cachep;
5825 (*cachep)[i] = offsetp;
5826 (*cachep)[i+1] = s - start;
5834 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5835 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5836 * between UTF-8 and byte offsets. See also the comments of
5837 * S_utf8_mg_pos_init().
5841 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)
5845 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5847 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5848 if (*mgp && (*mgp)->mg_ptr) {
5849 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5850 ASSERT_UTF8_CACHE(*cachep);
5851 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5853 else { /* We will skip to the right spot. */
5858 /* The assumption is that going backward is half
5859 * the speed of going forward (that's where the
5860 * 2 * backw in the below comes from). (The real
5861 * figure of course depends on the UTF-8 data.) */
5863 if ((*cachep)[i] > (STRLEN)uoff) {
5865 backw = (*cachep)[i] - (STRLEN)uoff;
5867 if (forw < 2 * backw)
5870 p = start + (*cachep)[i+1];
5872 /* Try this only for the substr offset (i == 0),
5873 * not for the substr length (i == 2). */
5874 else if (i == 0) { /* (*cachep)[i] < uoff */
5875 const STRLEN ulen = sv_len_utf8(sv);
5877 if ((STRLEN)uoff < ulen) {
5878 forw = (STRLEN)uoff - (*cachep)[i];
5879 backw = ulen - (STRLEN)uoff;
5881 if (forw < 2 * backw)
5882 p = start + (*cachep)[i+1];
5887 /* If the string is not long enough for uoff,
5888 * we could extend it, but not at this low a level. */
5892 if (forw < 2 * backw) {
5899 while (UTF8_IS_CONTINUATION(*p))
5904 /* Update the cache. */
5905 (*cachep)[i] = (STRLEN)uoff;
5906 (*cachep)[i+1] = p - start;
5908 /* Drop the stale "length" cache */
5917 if (found) { /* Setup the return values. */
5918 *offsetp = (*cachep)[i+1];
5919 *sp = start + *offsetp;
5922 *offsetp = send - start;
5924 else if (*sp < start) {
5930 #ifdef PERL_UTF8_CACHE_ASSERT
5935 while (n-- && s < send)
5939 assert(*offsetp == s - start);
5940 assert((*cachep)[0] == (STRLEN)uoff);
5941 assert((*cachep)[1] == *offsetp);
5943 ASSERT_UTF8_CACHE(*cachep);
5952 =for apidoc sv_pos_u2b
5954 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5955 the start of the string, to a count of the equivalent number of bytes; if
5956 lenp is non-zero, it does the same to lenp, but this time starting from
5957 the offset, rather than from the start of the string. Handles magic and
5964 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5965 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5966 * byte offsets. See also the comments of S_utf8_mg_pos().
5971 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5979 start = (U8*)SvPV_const(sv, len);
5983 const U8 *s = start;
5984 I32 uoffset = *offsetp;
5985 const U8 *send = s + len;
5989 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5991 if (!found && uoffset > 0) {
5992 while (s < send && uoffset--)
5996 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5998 *offsetp = s - start;
6003 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6007 if (!found && *lenp > 0) {
6010 while (s < send && ulen--)
6014 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6018 ASSERT_UTF8_CACHE(cache);
6030 =for apidoc sv_pos_b2u
6032 Converts the value pointed to by offsetp from a count of bytes from the
6033 start of the string, to a count of the equivalent number of UTF-8 chars.
6034 Handles magic and type coercion.
6040 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6041 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6042 * byte offsets. See also the comments of S_utf8_mg_pos().
6047 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6055 s = (const U8*)SvPV_const(sv, len);
6056 if ((I32)len < *offsetp)
6057 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6059 const U8* send = s + *offsetp;
6061 STRLEN *cache = NULL;
6065 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6066 mg = mg_find(sv, PERL_MAGIC_utf8);
6067 if (mg && mg->mg_ptr) {
6068 cache = (STRLEN *) mg->mg_ptr;
6069 if (cache[1] == (STRLEN)*offsetp) {
6070 /* An exact match. */
6071 *offsetp = cache[0];
6075 else if (cache[1] < (STRLEN)*offsetp) {
6076 /* We already know part of the way. */
6079 /* Let the below loop do the rest. */
6081 else { /* cache[1] > *offsetp */
6082 /* We already know all of the way, now we may
6083 * be able to walk back. The same assumption
6084 * is made as in S_utf8_mg_pos(), namely that
6085 * walking backward is twice slower than
6086 * walking forward. */
6087 STRLEN forw = *offsetp;
6088 STRLEN backw = cache[1] - *offsetp;
6090 if (!(forw < 2 * backw)) {
6091 const U8 *p = s + cache[1];
6098 while (UTF8_IS_CONTINUATION(*p)) {
6106 *offsetp = cache[0];
6108 /* Drop the stale "length" cache */
6116 ASSERT_UTF8_CACHE(cache);
6122 /* Call utf8n_to_uvchr() to validate the sequence
6123 * (unless a simple non-UTF character) */
6124 if (!UTF8_IS_INVARIANT(*s))
6125 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6134 if (!SvREADONLY(sv)) {
6136 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6137 mg = mg_find(sv, PERL_MAGIC_utf8);
6142 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6143 mg->mg_ptr = (char *) cache;
6148 cache[1] = *offsetp;
6149 /* Drop the stale "length" cache */
6162 Returns a boolean indicating whether the strings in the two SVs are
6163 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6164 coerce its args to strings if necessary.
6170 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6178 SV* svrecode = Nullsv;
6185 pv1 = SvPV_const(sv1, cur1);
6192 pv2 = SvPV_const(sv2, cur2);
6194 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6195 /* Differing utf8ness.
6196 * Do not UTF8size the comparands as a side-effect. */
6199 svrecode = newSVpvn(pv2, cur2);
6200 sv_recode_to_utf8(svrecode, PL_encoding);
6201 pv2 = SvPV_const(svrecode, cur2);
6204 svrecode = newSVpvn(pv1, cur1);
6205 sv_recode_to_utf8(svrecode, PL_encoding);
6206 pv1 = SvPV_const(svrecode, cur1);
6208 /* Now both are in UTF-8. */
6210 SvREFCNT_dec(svrecode);
6215 bool is_utf8 = TRUE;
6218 /* sv1 is the UTF-8 one,
6219 * if is equal it must be downgrade-able */
6220 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6226 /* sv2 is the UTF-8 one,
6227 * if is equal it must be downgrade-able */
6228 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6234 /* Downgrade not possible - cannot be eq */
6242 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6245 SvREFCNT_dec(svrecode);
6256 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6257 string in C<sv1> is less than, equal to, or greater than the string in
6258 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6259 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6265 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6268 const char *pv1, *pv2;
6271 SV *svrecode = Nullsv;
6278 pv1 = SvPV_const(sv1, cur1);
6285 pv2 = SvPV_const(sv2, cur2);
6287 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6288 /* Differing utf8ness.
6289 * Do not UTF8size the comparands as a side-effect. */
6292 svrecode = newSVpvn(pv2, cur2);
6293 sv_recode_to_utf8(svrecode, PL_encoding);
6294 pv2 = SvPV_const(svrecode, cur2);
6297 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6302 svrecode = newSVpvn(pv1, cur1);
6303 sv_recode_to_utf8(svrecode, PL_encoding);
6304 pv1 = SvPV_const(svrecode, cur1);
6307 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6313 cmp = cur2 ? -1 : 0;
6317 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6320 cmp = retval < 0 ? -1 : 1;
6321 } else if (cur1 == cur2) {
6324 cmp = cur1 < cur2 ? -1 : 1;
6329 SvREFCNT_dec(svrecode);
6338 =for apidoc sv_cmp_locale
6340 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6341 'use bytes' aware, handles get magic, and will coerce its args to strings
6342 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6348 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6350 #ifdef USE_LOCALE_COLLATE
6356 if (PL_collation_standard)
6360 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6362 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6364 if (!pv1 || !len1) {
6375 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6378 return retval < 0 ? -1 : 1;
6381 * When the result of collation is equality, that doesn't mean
6382 * that there are no differences -- some locales exclude some
6383 * characters from consideration. So to avoid false equalities,
6384 * we use the raw string as a tiebreaker.
6390 #endif /* USE_LOCALE_COLLATE */
6392 return sv_cmp(sv1, sv2);
6396 #ifdef USE_LOCALE_COLLATE
6399 =for apidoc sv_collxfrm
6401 Add Collate Transform magic to an SV if it doesn't already have it.
6403 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6404 scalar data of the variable, but transformed to such a format that a normal
6405 memory comparison can be used to compare the data according to the locale
6412 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6416 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6417 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6423 Safefree(mg->mg_ptr);
6424 s = SvPV_const(sv, len);
6425 if ((xf = mem_collxfrm(s, len, &xlen))) {
6426 if (SvREADONLY(sv)) {
6429 return xf + sizeof(PL_collation_ix);
6432 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6433 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6446 if (mg && mg->mg_ptr) {
6448 return mg->mg_ptr + sizeof(PL_collation_ix);
6456 #endif /* USE_LOCALE_COLLATE */
6461 Get a line from the filehandle and store it into the SV, optionally
6462 appending to the currently-stored string.
6468 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6472 register STDCHAR rslast;
6473 register STDCHAR *bp;
6479 if (SvTHINKFIRST(sv))
6480 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6481 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6483 However, perlbench says it's slower, because the existing swipe code
6484 is faster than copy on write.
6485 Swings and roundabouts. */
6486 SvUPGRADE(sv, SVt_PV);
6491 if (PerlIO_isutf8(fp)) {
6493 sv_utf8_upgrade_nomg(sv);
6494 sv_pos_u2b(sv,&append,0);
6496 } else if (SvUTF8(sv)) {
6497 SV *tsv = NEWSV(0,0);
6498 sv_gets(tsv, fp, 0);
6499 sv_utf8_upgrade_nomg(tsv);
6500 SvCUR_set(sv,append);
6503 goto return_string_or_null;
6508 if (PerlIO_isutf8(fp))
6511 if (IN_PERL_COMPILETIME) {
6512 /* we always read code in line mode */
6516 else if (RsSNARF(PL_rs)) {
6517 /* If it is a regular disk file use size from stat() as estimate
6518 of amount we are going to read - may result in malloc-ing
6519 more memory than we realy need if layers bellow reduce
6520 size we read (e.g. CRLF or a gzip layer)
6523 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6524 const Off_t offset = PerlIO_tell(fp);
6525 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6526 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6532 else if (RsRECORD(PL_rs)) {
6536 /* Grab the size of the record we're getting */
6537 recsize = SvIV(SvRV(PL_rs));
6538 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6541 /* VMS wants read instead of fread, because fread doesn't respect */
6542 /* RMS record boundaries. This is not necessarily a good thing to be */
6543 /* doing, but we've got no other real choice - except avoid stdio
6544 as implementation - perhaps write a :vms layer ?
6546 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6548 bytesread = PerlIO_read(fp, buffer, recsize);
6552 SvCUR_set(sv, bytesread += append);
6553 buffer[bytesread] = '\0';
6554 goto return_string_or_null;
6556 else if (RsPARA(PL_rs)) {
6562 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6563 if (PerlIO_isutf8(fp)) {
6564 rsptr = SvPVutf8(PL_rs, rslen);
6567 if (SvUTF8(PL_rs)) {
6568 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6569 Perl_croak(aTHX_ "Wide character in $/");
6572 rsptr = SvPV_const(PL_rs, rslen);
6576 rslast = rslen ? rsptr[rslen - 1] : '\0';
6578 if (rspara) { /* have to do this both before and after */
6579 do { /* to make sure file boundaries work right */
6582 i = PerlIO_getc(fp);
6586 PerlIO_ungetc(fp,i);
6592 /* See if we know enough about I/O mechanism to cheat it ! */
6594 /* This used to be #ifdef test - it is made run-time test for ease
6595 of abstracting out stdio interface. One call should be cheap
6596 enough here - and may even be a macro allowing compile
6600 if (PerlIO_fast_gets(fp)) {
6603 * We're going to steal some values from the stdio struct
6604 * and put EVERYTHING in the innermost loop into registers.
6606 register STDCHAR *ptr;
6610 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6611 /* An ungetc()d char is handled separately from the regular
6612 * buffer, so we getc() it back out and stuff it in the buffer.
6614 i = PerlIO_getc(fp);
6615 if (i == EOF) return 0;
6616 *(--((*fp)->_ptr)) = (unsigned char) i;
6620 /* Here is some breathtakingly efficient cheating */
6622 cnt = PerlIO_get_cnt(fp); /* get count into register */
6623 /* make sure we have the room */
6624 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6625 /* Not room for all of it
6626 if we are looking for a separator and room for some
6628 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6629 /* just process what we have room for */
6630 shortbuffered = cnt - SvLEN(sv) + append + 1;
6631 cnt -= shortbuffered;
6635 /* remember that cnt can be negative */
6636 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6641 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6642 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6643 DEBUG_P(PerlIO_printf(Perl_debug_log,
6644 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6645 DEBUG_P(PerlIO_printf(Perl_debug_log,
6646 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6647 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6648 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6653 while (cnt > 0) { /* this | eat */
6655 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6656 goto thats_all_folks; /* screams | sed :-) */
6660 Copy(ptr, bp, cnt, char); /* this | eat */
6661 bp += cnt; /* screams | dust */
6662 ptr += cnt; /* louder | sed :-) */
6667 if (shortbuffered) { /* oh well, must extend */
6668 cnt = shortbuffered;
6670 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6672 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6673 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6677 DEBUG_P(PerlIO_printf(Perl_debug_log,
6678 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6679 PTR2UV(ptr),(long)cnt));
6680 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6682 DEBUG_P(PerlIO_printf(Perl_debug_log,
6683 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6684 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6685 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6687 /* This used to call 'filbuf' in stdio form, but as that behaves like
6688 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6689 another abstraction. */
6690 i = PerlIO_getc(fp); /* get more characters */
6692 DEBUG_P(PerlIO_printf(Perl_debug_log,
6693 "Screamer: post: FILE * 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)));
6697 cnt = PerlIO_get_cnt(fp);
6698 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6699 DEBUG_P(PerlIO_printf(Perl_debug_log,
6700 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6702 if (i == EOF) /* all done for ever? */
6703 goto thats_really_all_folks;
6705 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6707 SvGROW(sv, bpx + cnt + 2);
6708 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6710 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6712 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6713 goto thats_all_folks;
6717 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6718 memNE((char*)bp - rslen, rsptr, rslen))
6719 goto screamer; /* go back to the fray */
6720 thats_really_all_folks:
6722 cnt += shortbuffered;
6723 DEBUG_P(PerlIO_printf(Perl_debug_log,
6724 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6725 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6726 DEBUG_P(PerlIO_printf(Perl_debug_log,
6727 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6728 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6729 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6731 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6732 DEBUG_P(PerlIO_printf(Perl_debug_log,
6733 "Screamer: done, len=%ld, string=|%.*s|\n",
6734 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6738 /*The big, slow, and stupid way. */
6739 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6741 New(0, buf, 8192, STDCHAR);
6749 const register STDCHAR *bpe = buf + sizeof(buf);
6751 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6752 ; /* keep reading */
6756 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6757 /* Accomodate broken VAXC compiler, which applies U8 cast to
6758 * both args of ?: operator, causing EOF to change into 255
6761 i = (U8)buf[cnt - 1];
6767 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6769 sv_catpvn(sv, (char *) buf, cnt);
6771 sv_setpvn(sv, (char *) buf, cnt);
6773 if (i != EOF && /* joy */
6775 SvCUR(sv) < rslen ||
6776 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6780 * If we're reading from a TTY and we get a short read,
6781 * indicating that the user hit his EOF character, we need
6782 * to notice it now, because if we try to read from the TTY
6783 * again, the EOF condition will disappear.
6785 * The comparison of cnt to sizeof(buf) is an optimization
6786 * that prevents unnecessary calls to feof().
6790 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6794 #ifdef USE_HEAP_INSTEAD_OF_STACK
6799 if (rspara) { /* have to do this both before and after */
6800 while (i != EOF) { /* to make sure file boundaries work right */
6801 i = PerlIO_getc(fp);
6803 PerlIO_ungetc(fp,i);
6809 return_string_or_null:
6810 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6816 Auto-increment of the value in the SV, doing string to numeric conversion
6817 if necessary. Handles 'get' magic.
6823 Perl_sv_inc(pTHX_ register SV *sv)
6832 if (SvTHINKFIRST(sv)) {
6834 sv_force_normal_flags(sv, 0);
6835 if (SvREADONLY(sv)) {
6836 if (IN_PERL_RUNTIME)
6837 Perl_croak(aTHX_ PL_no_modify);
6841 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6843 i = PTR2IV(SvRV(sv));
6848 flags = SvFLAGS(sv);
6849 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6850 /* It's (privately or publicly) a float, but not tested as an
6851 integer, so test it to see. */
6853 flags = SvFLAGS(sv);
6855 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6856 /* It's publicly an integer, or privately an integer-not-float */
6857 #ifdef PERL_PRESERVE_IVUV
6861 if (SvUVX(sv) == UV_MAX)
6862 sv_setnv(sv, UV_MAX_P1);
6864 (void)SvIOK_only_UV(sv);
6865 SvUV_set(sv, SvUVX(sv) + 1);
6867 if (SvIVX(sv) == IV_MAX)
6868 sv_setuv(sv, (UV)IV_MAX + 1);
6870 (void)SvIOK_only(sv);
6871 SvIV_set(sv, SvIVX(sv) + 1);
6876 if (flags & SVp_NOK) {
6877 (void)SvNOK_only(sv);
6878 SvNV_set(sv, SvNVX(sv) + 1.0);
6882 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6883 if ((flags & SVTYPEMASK) < SVt_PVIV)
6884 sv_upgrade(sv, SVt_IV);
6885 (void)SvIOK_only(sv);
6890 while (isALPHA(*d)) d++;
6891 while (isDIGIT(*d)) d++;
6893 #ifdef PERL_PRESERVE_IVUV
6894 /* Got to punt this as an integer if needs be, but we don't issue
6895 warnings. Probably ought to make the sv_iv_please() that does
6896 the conversion if possible, and silently. */
6897 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6898 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6899 /* Need to try really hard to see if it's an integer.
6900 9.22337203685478e+18 is an integer.
6901 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6902 so $a="9.22337203685478e+18"; $a+0; $a++
6903 needs to be the same as $a="9.22337203685478e+18"; $a++
6910 /* sv_2iv *should* have made this an NV */
6911 if (flags & SVp_NOK) {
6912 (void)SvNOK_only(sv);
6913 SvNV_set(sv, SvNVX(sv) + 1.0);
6916 /* I don't think we can get here. Maybe I should assert this
6917 And if we do get here I suspect that sv_setnv will croak. NWC
6919 #if defined(USE_LONG_DOUBLE)
6920 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",
6921 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6923 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6924 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6927 #endif /* PERL_PRESERVE_IVUV */
6928 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6932 while (d >= SvPVX_const(sv)) {
6940 /* MKS: The original code here died if letters weren't consecutive.
6941 * at least it didn't have to worry about non-C locales. The
6942 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6943 * arranged in order (although not consecutively) and that only
6944 * [A-Za-z] are accepted by isALPHA in the C locale.
6946 if (*d != 'z' && *d != 'Z') {
6947 do { ++*d; } while (!isALPHA(*d));
6950 *(d--) -= 'z' - 'a';
6955 *(d--) -= 'z' - 'a' + 1;
6959 /* oh,oh, the number grew */
6960 SvGROW(sv, SvCUR(sv) + 2);
6961 SvCUR_set(sv, SvCUR(sv) + 1);
6962 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6973 Auto-decrement of the value in the SV, doing string to numeric conversion
6974 if necessary. Handles 'get' magic.
6980 Perl_sv_dec(pTHX_ register SV *sv)
6988 if (SvTHINKFIRST(sv)) {
6990 sv_force_normal_flags(sv, 0);
6991 if (SvREADONLY(sv)) {
6992 if (IN_PERL_RUNTIME)
6993 Perl_croak(aTHX_ PL_no_modify);
6997 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6999 i = PTR2IV(SvRV(sv));
7004 /* Unlike sv_inc we don't have to worry about string-never-numbers
7005 and keeping them magic. But we mustn't warn on punting */
7006 flags = SvFLAGS(sv);
7007 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7008 /* It's publicly an integer, or privately an integer-not-float */
7009 #ifdef PERL_PRESERVE_IVUV
7013 if (SvUVX(sv) == 0) {
7014 (void)SvIOK_only(sv);
7018 (void)SvIOK_only_UV(sv);
7019 SvUV_set(sv, SvUVX(sv) + 1);
7022 if (SvIVX(sv) == IV_MIN)
7023 sv_setnv(sv, (NV)IV_MIN - 1.0);
7025 (void)SvIOK_only(sv);
7026 SvIV_set(sv, SvIVX(sv) - 1);
7031 if (flags & SVp_NOK) {
7032 SvNV_set(sv, SvNVX(sv) - 1.0);
7033 (void)SvNOK_only(sv);
7036 if (!(flags & SVp_POK)) {
7037 if ((flags & SVTYPEMASK) < SVt_PVNV)
7038 sv_upgrade(sv, SVt_NV);
7040 (void)SvNOK_only(sv);
7043 #ifdef PERL_PRESERVE_IVUV
7045 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7046 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7047 /* Need to try really hard to see if it's an integer.
7048 9.22337203685478e+18 is an integer.
7049 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7050 so $a="9.22337203685478e+18"; $a+0; $a--
7051 needs to be the same as $a="9.22337203685478e+18"; $a--
7058 /* sv_2iv *should* have made this an NV */
7059 if (flags & SVp_NOK) {
7060 (void)SvNOK_only(sv);
7061 SvNV_set(sv, SvNVX(sv) - 1.0);
7064 /* I don't think we can get here. Maybe I should assert this
7065 And if we do get here I suspect that sv_setnv will croak. NWC
7067 #if defined(USE_LONG_DOUBLE)
7068 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",
7069 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7071 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7072 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7076 #endif /* PERL_PRESERVE_IVUV */
7077 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7081 =for apidoc sv_mortalcopy
7083 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7084 The new SV is marked as mortal. It will be destroyed "soon", either by an
7085 explicit call to FREETMPS, or by an implicit call at places such as
7086 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7091 /* Make a string that will exist for the duration of the expression
7092 * evaluation. Actually, it may have to last longer than that, but
7093 * hopefully we won't free it until it has been assigned to a
7094 * permanent location. */
7097 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7102 sv_setsv(sv,oldstr);
7104 PL_tmps_stack[++PL_tmps_ix] = sv;
7110 =for apidoc sv_newmortal
7112 Creates a new null SV which is mortal. The reference count of the SV is
7113 set to 1. It will be destroyed "soon", either by an explicit call to
7114 FREETMPS, or by an implicit call at places such as statement boundaries.
7115 See also C<sv_mortalcopy> and C<sv_2mortal>.
7121 Perl_sv_newmortal(pTHX)
7126 SvFLAGS(sv) = SVs_TEMP;
7128 PL_tmps_stack[++PL_tmps_ix] = sv;
7133 =for apidoc sv_2mortal
7135 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7136 by an explicit call to FREETMPS, or by an implicit call at places such as
7137 statement boundaries. SvTEMP() is turned on which means that the SV's
7138 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7139 and C<sv_mortalcopy>.
7145 Perl_sv_2mortal(pTHX_ register SV *sv)
7150 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7153 PL_tmps_stack[++PL_tmps_ix] = sv;
7161 Creates a new SV and copies a string into it. The reference count for the
7162 SV is set to 1. If C<len> is zero, Perl will compute the length using
7163 strlen(). For efficiency, consider using C<newSVpvn> instead.
7169 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7174 sv_setpvn(sv,s,len ? len : strlen(s));
7179 =for apidoc newSVpvn
7181 Creates a new SV and copies a string into it. The reference count for the
7182 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7183 string. You are responsible for ensuring that the source string is at least
7184 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7190 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7195 sv_setpvn(sv,s,len);
7201 =for apidoc newSVhek
7203 Creates a new SV from the hash key structure. It will generate scalars that
7204 point to the shared string table where possible. Returns a new (undefined)
7205 SV if the hek is NULL.
7211 Perl_newSVhek(pTHX_ const HEK *hek)
7220 if (HEK_LEN(hek) == HEf_SVKEY) {
7221 return newSVsv(*(SV**)HEK_KEY(hek));
7223 const int flags = HEK_FLAGS(hek);
7224 if (flags & HVhek_WASUTF8) {
7226 Andreas would like keys he put in as utf8 to come back as utf8
7228 STRLEN utf8_len = HEK_LEN(hek);
7229 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7230 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7233 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7235 } else if (flags & HVhek_REHASH) {
7236 /* We don't have a pointer to the hv, so we have to replicate the
7237 flag into every HEK. This hv is using custom a hasing
7238 algorithm. Hence we can't return a shared string scalar, as
7239 that would contain the (wrong) hash value, and might get passed
7240 into an hv routine with a regular hash */
7242 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7247 /* This will be overwhelminly the most common case. */
7248 return newSVpvn_share(HEK_KEY(hek),
7249 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7255 =for apidoc newSVpvn_share
7257 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7258 table. If the string does not already exist in the table, it is created
7259 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7260 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7261 otherwise the hash is computed. The idea here is that as the string table
7262 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7263 hash lookup will avoid string compare.
7269 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7272 bool is_utf8 = FALSE;
7274 STRLEN tmplen = -len;
7276 /* See the note in hv.c:hv_fetch() --jhi */
7277 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7281 PERL_HASH(hash, src, len);
7283 sv_upgrade(sv, SVt_PV);
7284 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7296 #if defined(PERL_IMPLICIT_CONTEXT)
7298 /* pTHX_ magic can't cope with varargs, so this is a no-context
7299 * version of the main function, (which may itself be aliased to us).
7300 * Don't access this version directly.
7304 Perl_newSVpvf_nocontext(const char* pat, ...)
7309 va_start(args, pat);
7310 sv = vnewSVpvf(pat, &args);
7317 =for apidoc newSVpvf
7319 Creates a new SV and initializes it with the string formatted like
7326 Perl_newSVpvf(pTHX_ const char* pat, ...)
7330 va_start(args, pat);
7331 sv = vnewSVpvf(pat, &args);
7336 /* backend for newSVpvf() and newSVpvf_nocontext() */
7339 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7343 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7350 Creates a new SV and copies a floating point value into it.
7351 The reference count for the SV is set to 1.
7357 Perl_newSVnv(pTHX_ NV n)
7369 Creates a new SV and copies an integer into it. The reference count for the
7376 Perl_newSViv(pTHX_ IV i)
7388 Creates a new SV and copies an unsigned integer into it.
7389 The reference count for the SV is set to 1.
7395 Perl_newSVuv(pTHX_ UV u)
7405 =for apidoc newRV_noinc
7407 Creates an RV wrapper for an SV. The reference count for the original
7408 SV is B<not> incremented.
7414 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7419 sv_upgrade(sv, SVt_RV);
7421 SvRV_set(sv, tmpRef);
7426 /* newRV_inc is the official function name to use now.
7427 * newRV_inc is in fact #defined to newRV in sv.h
7431 Perl_newRV(pTHX_ SV *tmpRef)
7433 return newRV_noinc(SvREFCNT_inc(tmpRef));
7439 Creates a new SV which is an exact duplicate of the original SV.
7446 Perl_newSVsv(pTHX_ register SV *old)
7452 if (SvTYPE(old) == SVTYPEMASK) {
7453 if (ckWARN_d(WARN_INTERNAL))
7454 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7458 /* SV_GMAGIC is the default for sv_setv()
7459 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7460 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7461 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7466 =for apidoc sv_reset
7468 Underlying implementation for the C<reset> Perl function.
7469 Note that the perl-level function is vaguely deprecated.
7475 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7478 char todo[PERL_UCHAR_MAX+1];
7483 if (!*s) { /* reset ?? searches */
7484 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7486 PMOP *pm = (PMOP *) mg->mg_obj;
7488 pm->op_pmdynflags &= ~PMdf_USED;
7495 /* reset variables */
7497 if (!HvARRAY(stash))
7500 Zero(todo, 256, char);
7503 I32 i = (unsigned char)*s;
7507 max = (unsigned char)*s++;
7508 for ( ; i <= max; i++) {
7511 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7513 for (entry = HvARRAY(stash)[i];
7515 entry = HeNEXT(entry))
7520 if (!todo[(U8)*HeKEY(entry)])
7522 gv = (GV*)HeVAL(entry);
7524 if (SvTHINKFIRST(sv)) {
7525 if (!SvREADONLY(sv) && SvROK(sv))
7530 if (SvTYPE(sv) >= SVt_PV) {
7532 if (SvPVX_const(sv) != Nullch)
7539 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7542 #ifdef USE_ENVIRON_ARRAY
7544 # ifdef USE_ITHREADS
7545 && PL_curinterp == aTHX
7549 environ[0] = Nullch;
7552 #endif /* !PERL_MICRO */
7562 Using various gambits, try to get an IO from an SV: the IO slot if its a
7563 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7564 named after the PV if we're a string.
7570 Perl_sv_2io(pTHX_ SV *sv)
7575 switch (SvTYPE(sv)) {
7583 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7587 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7589 return sv_2io(SvRV(sv));
7590 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7596 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7605 Using various gambits, try to get a CV from an SV; in addition, try if
7606 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7612 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7619 return *gvp = Nullgv, Nullcv;
7620 switch (SvTYPE(sv)) {
7639 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7640 tryAMAGICunDEREF(to_cv);
7643 if (SvTYPE(sv) == SVt_PVCV) {
7652 Perl_croak(aTHX_ "Not a subroutine reference");
7657 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7663 if (lref && !GvCVu(gv)) {
7666 tmpsv = NEWSV(704,0);
7667 gv_efullname3(tmpsv, gv, Nullch);
7668 /* XXX this is probably not what they think they're getting.
7669 * It has the same effect as "sub name;", i.e. just a forward
7671 newSUB(start_subparse(FALSE, 0),
7672 newSVOP(OP_CONST, 0, tmpsv),
7677 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7687 Returns true if the SV has a true value by Perl's rules.
7688 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7689 instead use an in-line version.
7695 Perl_sv_true(pTHX_ register SV *sv)
7700 const register XPV* tXpv;
7701 if ((tXpv = (XPV*)SvANY(sv)) &&
7702 (tXpv->xpv_cur > 1 ||
7703 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7710 return SvIVX(sv) != 0;
7713 return SvNVX(sv) != 0.0;
7715 return sv_2bool(sv);
7723 A private implementation of the C<SvIVx> macro for compilers which can't
7724 cope with complex macro expressions. Always use the macro instead.
7730 Perl_sv_iv(pTHX_ register SV *sv)
7734 return (IV)SvUVX(sv);
7743 A private implementation of the C<SvUVx> macro for compilers which can't
7744 cope with complex macro expressions. Always use the macro instead.
7750 Perl_sv_uv(pTHX_ register SV *sv)
7755 return (UV)SvIVX(sv);
7763 A private implementation of the C<SvNVx> macro for compilers which can't
7764 cope with complex macro expressions. Always use the macro instead.
7770 Perl_sv_nv(pTHX_ register SV *sv)
7777 /* sv_pv() is now a macro using SvPV_nolen();
7778 * this function provided for binary compatibility only
7782 Perl_sv_pv(pTHX_ SV *sv)
7787 return sv_2pv(sv, 0);
7793 Use the C<SvPV_nolen> macro instead
7797 A private implementation of the C<SvPV> macro for compilers which can't
7798 cope with complex macro expressions. Always use the macro instead.
7804 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7810 return sv_2pv(sv, lp);
7815 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7821 return sv_2pv_flags(sv, lp, 0);
7824 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7825 * this function provided for binary compatibility only
7829 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7831 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7835 =for apidoc sv_pvn_force
7837 Get a sensible string out of the SV somehow.
7838 A private implementation of the C<SvPV_force> macro for compilers which
7839 can't cope with complex macro expressions. Always use the macro instead.
7841 =for apidoc sv_pvn_force_flags
7843 Get a sensible string out of the SV somehow.
7844 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7845 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7846 implemented in terms of this function.
7847 You normally want to use the various wrapper macros instead: see
7848 C<SvPV_force> and C<SvPV_force_nomg>
7854 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7857 if (SvTHINKFIRST(sv) && !SvROK(sv))
7858 sv_force_normal_flags(sv, 0);
7868 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7870 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7871 sv_reftype(sv,0), OP_NAME(PL_op));
7873 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
7876 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7877 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7881 s = sv_2pv_flags(sv, &len, flags);
7885 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7888 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7889 SvGROW(sv, len + 1);
7890 Move(s,SvPVX_const(sv),len,char);
7895 SvPOK_on(sv); /* validate pointer */
7897 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7898 PTR2UV(sv),SvPVX_const(sv)));
7901 return SvPVX_mutable(sv);
7904 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7905 * this function provided for binary compatibility only
7909 Perl_sv_pvbyte(pTHX_ SV *sv)
7911 sv_utf8_downgrade(sv,0);
7916 =for apidoc sv_pvbyte
7918 Use C<SvPVbyte_nolen> instead.
7920 =for apidoc sv_pvbyten
7922 A private implementation of the C<SvPVbyte> macro for compilers
7923 which can't cope with complex macro expressions. Always use the macro
7930 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7932 sv_utf8_downgrade(sv,0);
7933 return sv_pvn(sv,lp);
7937 =for apidoc sv_pvbyten_force
7939 A private implementation of the C<SvPVbytex_force> macro for compilers
7940 which can't cope with complex macro expressions. Always use the macro
7947 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7949 sv_pvn_force(sv,lp);
7950 sv_utf8_downgrade(sv,0);
7955 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7956 * this function provided for binary compatibility only
7960 Perl_sv_pvutf8(pTHX_ SV *sv)
7962 sv_utf8_upgrade(sv);
7967 =for apidoc sv_pvutf8
7969 Use the C<SvPVutf8_nolen> macro instead
7971 =for apidoc sv_pvutf8n
7973 A private implementation of the C<SvPVutf8> macro for compilers
7974 which can't cope with complex macro expressions. Always use the macro
7981 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7983 sv_utf8_upgrade(sv);
7984 return sv_pvn(sv,lp);
7988 =for apidoc sv_pvutf8n_force
7990 A private implementation of the C<SvPVutf8_force> macro for compilers
7991 which can't cope with complex macro expressions. Always use the macro
7998 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8000 sv_pvn_force(sv,lp);
8001 sv_utf8_upgrade(sv);
8007 =for apidoc sv_reftype
8009 Returns a string describing what the SV is a reference to.
8015 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8017 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8018 inside return suggests a const propagation bug in g++. */
8019 if (ob && SvOBJECT(sv)) {
8020 char *name = HvNAME_get(SvSTASH(sv));
8021 return name ? name : (char *) "__ANON__";
8024 switch (SvTYPE(sv)) {
8041 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8042 /* tied lvalues should appear to be
8043 * scalars for backwards compatitbility */
8044 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8045 ? "SCALAR" : "LVALUE");
8046 case SVt_PVAV: return "ARRAY";
8047 case SVt_PVHV: return "HASH";
8048 case SVt_PVCV: return "CODE";
8049 case SVt_PVGV: return "GLOB";
8050 case SVt_PVFM: return "FORMAT";
8051 case SVt_PVIO: return "IO";
8052 default: return "UNKNOWN";
8058 =for apidoc sv_isobject
8060 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8061 object. If the SV is not an RV, or if the object is not blessed, then this
8068 Perl_sv_isobject(pTHX_ SV *sv)
8085 Returns a boolean indicating whether the SV is blessed into the specified
8086 class. This does not check for subtypes; use C<sv_derived_from> to verify
8087 an inheritance relationship.
8093 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8105 hvname = HvNAME_get(SvSTASH(sv));
8109 return strEQ(hvname, name);
8115 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8116 it will be upgraded to one. If C<classname> is non-null then the new SV will
8117 be blessed in the specified package. The new SV is returned and its
8118 reference count is 1.
8124 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8130 SV_CHECK_THINKFIRST_COW_DROP(rv);
8133 if (SvTYPE(rv) >= SVt_PVMG) {
8134 const U32 refcnt = SvREFCNT(rv);
8138 SvREFCNT(rv) = refcnt;
8141 if (SvTYPE(rv) < SVt_RV)
8142 sv_upgrade(rv, SVt_RV);
8143 else if (SvTYPE(rv) > SVt_RV) {
8154 HV* stash = gv_stashpv(classname, TRUE);
8155 (void)sv_bless(rv, stash);
8161 =for apidoc sv_setref_pv
8163 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8164 argument will be upgraded to an RV. That RV will be modified to point to
8165 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8166 into the SV. The C<classname> argument indicates the package for the
8167 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8168 will have a reference count of 1, and the RV will be returned.
8170 Do not use with other Perl types such as HV, AV, SV, CV, because those
8171 objects will become corrupted by the pointer copy process.
8173 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8179 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8182 sv_setsv(rv, &PL_sv_undef);
8186 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8191 =for apidoc sv_setref_iv
8193 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8194 argument will be upgraded to an RV. That RV will be modified to point to
8195 the new SV. The C<classname> argument indicates the package for the
8196 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8197 will have a reference count of 1, and the RV will be returned.
8203 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8205 sv_setiv(newSVrv(rv,classname), iv);
8210 =for apidoc sv_setref_uv
8212 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8213 argument will be upgraded to an RV. That RV will be modified to point to
8214 the new SV. The C<classname> argument indicates the package for the
8215 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8216 will have a reference count of 1, and the RV will be returned.
8222 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8224 sv_setuv(newSVrv(rv,classname), uv);
8229 =for apidoc sv_setref_nv
8231 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8232 argument will be upgraded to an RV. That RV will be modified to point to
8233 the new SV. The C<classname> argument indicates the package for the
8234 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8235 will have a reference count of 1, and the RV will be returned.
8241 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8243 sv_setnv(newSVrv(rv,classname), nv);
8248 =for apidoc sv_setref_pvn
8250 Copies a string into a new SV, optionally blessing the SV. The length of the
8251 string must be specified with C<n>. The C<rv> argument will be upgraded to
8252 an RV. That RV will be modified to point to the new SV. The C<classname>
8253 argument indicates the package for the blessing. Set C<classname> to
8254 C<Nullch> to avoid the blessing. The new SV will have a reference count
8255 of 1, and the RV will be returned.
8257 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8263 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8265 sv_setpvn(newSVrv(rv,classname), pv, n);
8270 =for apidoc sv_bless
8272 Blesses an SV into a specified package. The SV must be an RV. The package
8273 must be designated by its stash (see C<gv_stashpv()>). The reference count
8274 of the SV is unaffected.
8280 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8284 Perl_croak(aTHX_ "Can't bless non-reference value");
8286 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8287 if (SvREADONLY(tmpRef))
8288 Perl_croak(aTHX_ PL_no_modify);
8289 if (SvOBJECT(tmpRef)) {
8290 if (SvTYPE(tmpRef) != SVt_PVIO)
8292 SvREFCNT_dec(SvSTASH(tmpRef));
8295 SvOBJECT_on(tmpRef);
8296 if (SvTYPE(tmpRef) != SVt_PVIO)
8298 SvUPGRADE(tmpRef, SVt_PVMG);
8299 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8306 if(SvSMAGICAL(tmpRef))
8307 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8315 /* Downgrades a PVGV to a PVMG.
8319 S_sv_unglob(pTHX_ SV *sv)
8323 assert(SvTYPE(sv) == SVt_PVGV);
8328 SvREFCNT_dec(GvSTASH(sv));
8329 GvSTASH(sv) = Nullhv;
8331 sv_unmagic(sv, PERL_MAGIC_glob);
8332 Safefree(GvNAME(sv));
8335 /* need to keep SvANY(sv) in the right arena */
8336 xpvmg = new_XPVMG();
8337 StructCopy(SvANY(sv), xpvmg, XPVMG);
8338 del_XPVGV(SvANY(sv));
8341 SvFLAGS(sv) &= ~SVTYPEMASK;
8342 SvFLAGS(sv) |= SVt_PVMG;
8346 =for apidoc sv_unref_flags
8348 Unsets the RV status of the SV, and decrements the reference count of
8349 whatever was being referenced by the RV. This can almost be thought of
8350 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8351 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8352 (otherwise the decrementing is conditional on the reference count being
8353 different from one or the reference being a readonly SV).
8360 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8364 if (SvWEAKREF(sv)) {
8372 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8373 assigned to as BEGIN {$a = \"Foo"} will fail. */
8374 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8376 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8377 sv_2mortal(rv); /* Schedule for freeing later */
8381 =for apidoc sv_unref
8383 Unsets the RV status of the SV, and decrements the reference count of
8384 whatever was being referenced by the RV. This can almost be thought of
8385 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8386 being zero. See C<SvROK_off>.
8392 Perl_sv_unref(pTHX_ SV *sv)
8394 sv_unref_flags(sv, 0);
8398 =for apidoc sv_taint
8400 Taint an SV. Use C<SvTAINTED_on> instead.
8405 Perl_sv_taint(pTHX_ SV *sv)
8407 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8411 =for apidoc sv_untaint
8413 Untaint an SV. Use C<SvTAINTED_off> instead.
8418 Perl_sv_untaint(pTHX_ SV *sv)
8420 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8421 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8428 =for apidoc sv_tainted
8430 Test an SV for taintedness. Use C<SvTAINTED> instead.
8435 Perl_sv_tainted(pTHX_ SV *sv)
8437 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8438 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8439 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8446 =for apidoc sv_setpviv
8448 Copies an integer into the given SV, also updating its string value.
8449 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8455 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8457 char buf[TYPE_CHARS(UV)];
8459 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8461 sv_setpvn(sv, ptr, ebuf - ptr);
8465 =for apidoc sv_setpviv_mg
8467 Like C<sv_setpviv>, but also handles 'set' magic.
8473 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8475 char buf[TYPE_CHARS(UV)];
8477 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8479 sv_setpvn(sv, ptr, ebuf - ptr);
8483 #if defined(PERL_IMPLICIT_CONTEXT)
8485 /* pTHX_ magic can't cope with varargs, so this is a no-context
8486 * version of the main function, (which may itself be aliased to us).
8487 * Don't access this version directly.
8491 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8495 va_start(args, pat);
8496 sv_vsetpvf(sv, pat, &args);
8500 /* pTHX_ magic can't cope with varargs, so this is a no-context
8501 * version of the main function, (which may itself be aliased to us).
8502 * Don't access this version directly.
8506 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8510 va_start(args, pat);
8511 sv_vsetpvf_mg(sv, pat, &args);
8517 =for apidoc sv_setpvf
8519 Works like C<sv_catpvf> but copies the text into the SV instead of
8520 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8526 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8529 va_start(args, pat);
8530 sv_vsetpvf(sv, pat, &args);
8535 =for apidoc sv_vsetpvf
8537 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8538 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8540 Usually used via its frontend C<sv_setpvf>.
8546 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8548 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8552 =for apidoc sv_setpvf_mg
8554 Like C<sv_setpvf>, but also handles 'set' magic.
8560 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8563 va_start(args, pat);
8564 sv_vsetpvf_mg(sv, pat, &args);
8569 =for apidoc sv_vsetpvf_mg
8571 Like C<sv_vsetpvf>, but also handles 'set' magic.
8573 Usually used via its frontend C<sv_setpvf_mg>.
8579 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8581 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8585 #if defined(PERL_IMPLICIT_CONTEXT)
8587 /* pTHX_ magic can't cope with varargs, so this is a no-context
8588 * version of the main function, (which may itself be aliased to us).
8589 * Don't access this version directly.
8593 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8597 va_start(args, pat);
8598 sv_vcatpvf(sv, pat, &args);
8602 /* pTHX_ magic can't cope with varargs, so this is a no-context
8603 * version of the main function, (which may itself be aliased to us).
8604 * Don't access this version directly.
8608 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8612 va_start(args, pat);
8613 sv_vcatpvf_mg(sv, pat, &args);
8619 =for apidoc sv_catpvf
8621 Processes its arguments like C<sprintf> and appends the formatted
8622 output to an SV. If the appended data contains "wide" characters
8623 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8624 and characters >255 formatted with %c), the original SV might get
8625 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8626 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8627 valid UTF-8; if the original SV was bytes, the pattern should be too.
8632 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8635 va_start(args, pat);
8636 sv_vcatpvf(sv, pat, &args);
8641 =for apidoc sv_vcatpvf
8643 Processes its arguments like C<vsprintf> and appends the formatted output
8644 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8646 Usually used via its frontend C<sv_catpvf>.
8652 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8654 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8658 =for apidoc sv_catpvf_mg
8660 Like C<sv_catpvf>, but also handles 'set' magic.
8666 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8669 va_start(args, pat);
8670 sv_vcatpvf_mg(sv, pat, &args);
8675 =for apidoc sv_vcatpvf_mg
8677 Like C<sv_vcatpvf>, but also handles 'set' magic.
8679 Usually used via its frontend C<sv_catpvf_mg>.
8685 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8687 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8692 =for apidoc sv_vsetpvfn
8694 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8697 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8703 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8705 sv_setpvn(sv, "", 0);
8706 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8709 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8712 S_expect_number(pTHX_ char** pattern)
8715 switch (**pattern) {
8716 case '1': case '2': case '3':
8717 case '4': case '5': case '6':
8718 case '7': case '8': case '9':
8719 while (isDIGIT(**pattern))
8720 var = var * 10 + (*(*pattern)++ - '0');
8724 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8727 F0convert(NV nv, char *endbuf, STRLEN *len)
8729 const int neg = nv < 0;
8738 if (uv & 1 && uv == nv)
8739 uv--; /* Round to even */
8741 const unsigned dig = uv % 10;
8754 =for apidoc sv_vcatpvfn
8756 Processes its arguments like C<vsprintf> and appends the formatted output
8757 to an SV. Uses an array of SVs if the C style variable argument list is
8758 missing (NULL). When running with taint checks enabled, indicates via
8759 C<maybe_tainted> if results are untrustworthy (often due to the use of
8762 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8767 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8770 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8777 static const char nullstr[] = "(null)";
8779 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8780 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8782 /* Times 4: a decimal digit takes more than 3 binary digits.
8783 * NV_DIG: mantissa takes than many decimal digits.
8784 * Plus 32: Playing safe. */
8785 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8786 /* large enough for "%#.#f" --chip */
8787 /* what about long double NVs? --jhi */
8789 /* no matter what, this is a string now */
8790 (void)SvPV_force(sv, origlen);
8792 /* special-case "", "%s", and "%-p" (SVf) */
8795 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8797 const char *s = va_arg(*args, char*);
8798 sv_catpv(sv, s ? s : nullstr);
8800 else if (svix < svmax) {
8801 sv_catsv(sv, *svargs);
8802 if (DO_UTF8(*svargs))
8807 if (patlen == 3 && pat[0] == '%' &&
8808 pat[1] == '-' && pat[2] == 'p') {
8810 argsv = va_arg(*args, SV*);
8811 sv_catsv(sv, argsv);
8818 #ifndef USE_LONG_DOUBLE
8819 /* special-case "%.<number>[gf]" */
8820 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8821 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8822 unsigned digits = 0;
8826 while (*pp >= '0' && *pp <= '9')
8827 digits = 10 * digits + (*pp++ - '0');
8828 if (pp - pat == (int)patlen - 1) {
8832 nv = (NV)va_arg(*args, double);
8833 else if (svix < svmax)
8838 /* Add check for digits != 0 because it seems that some
8839 gconverts are buggy in this case, and we don't yet have
8840 a Configure test for this. */
8841 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8842 /* 0, point, slack */
8843 Gconvert(nv, (int)digits, 0, ebuf);
8845 if (*ebuf) /* May return an empty string for digits==0 */
8848 } else if (!digits) {
8851 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8852 sv_catpvn(sv, p, l);
8858 #endif /* !USE_LONG_DOUBLE */
8860 if (!args && svix < svmax && DO_UTF8(*svargs))
8863 patend = (char*)pat + patlen;
8864 for (p = (char*)pat; p < patend; p = q) {
8867 bool vectorize = FALSE;
8868 bool vectorarg = FALSE;
8869 bool vec_utf8 = FALSE;
8875 bool has_precis = FALSE;
8878 bool is_utf8 = FALSE; /* is this item utf8? */
8879 #ifdef HAS_LDBL_SPRINTF_BUG
8880 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8881 with sfio - Allen <allens@cpan.org> */
8882 bool fix_ldbl_sprintf_bug = FALSE;
8886 U8 utf8buf[UTF8_MAXBYTES+1];
8887 STRLEN esignlen = 0;
8889 const char *eptr = Nullch;
8892 const U8 *vecstr = Null(U8*);
8899 /* we need a long double target in case HAS_LONG_DOUBLE but
8902 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8910 const char *dotstr = ".";
8911 STRLEN dotstrlen = 1;
8912 I32 efix = 0; /* explicit format parameter index */
8913 I32 ewix = 0; /* explicit width index */
8914 I32 epix = 0; /* explicit precision index */
8915 I32 evix = 0; /* explicit vector index */
8916 bool asterisk = FALSE;
8918 /* echo everything up to the next format specification */
8919 for (q = p; q < patend && *q != '%'; ++q) ;
8921 if (has_utf8 && !pat_utf8)
8922 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8924 sv_catpvn(sv, p, q - p);
8931 We allow format specification elements in this order:
8932 \d+\$ explicit format parameter index
8934 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8935 0 flag (as above): repeated to allow "v02"
8936 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8937 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8939 [%bcdefginopsux_DFOUX] format (mandatory)
8941 if (EXPECT_NUMBER(q, width)) {
8982 if (EXPECT_NUMBER(q, ewix))
8991 if ((vectorarg = asterisk)) {
9003 EXPECT_NUMBER(q, width);
9008 vecsv = va_arg(*args, SV*);
9010 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9011 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9012 dotstr = SvPV_const(vecsv, dotstrlen);
9017 vecsv = va_arg(*args, SV*);
9018 vecstr = (U8*)SvPV_const(vecsv,veclen);
9019 vec_utf8 = DO_UTF8(vecsv);
9021 else if (efix ? efix <= svmax : svix < svmax) {
9022 vecsv = svargs[efix ? efix-1 : svix++];
9023 vecstr = (U8*)SvPV_const(vecsv,veclen);
9024 vec_utf8 = DO_UTF8(vecsv);
9025 /* if this is a version object, we need to return the
9026 * stringified representation (which the SvPVX_const has
9027 * already done for us), but not vectorize the args
9029 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9031 q++; /* skip past the rest of the %vd format */
9032 eptr = (const char *) vecstr;
9033 elen = strlen(eptr);
9046 i = va_arg(*args, int);
9048 i = (ewix ? ewix <= svmax : svix < svmax) ?
9049 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9051 width = (i < 0) ? -i : i;
9061 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9063 /* XXX: todo, support specified precision parameter */
9067 i = va_arg(*args, int);
9069 i = (ewix ? ewix <= svmax : svix < svmax)
9070 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9071 precis = (i < 0) ? 0 : i;
9076 precis = precis * 10 + (*q++ - '0');
9085 case 'I': /* Ix, I32x, and I64x */
9087 if (q[1] == '6' && q[2] == '4') {
9093 if (q[1] == '3' && q[2] == '2') {
9103 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9114 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9115 if (*(q + 1) == 'l') { /* lld, llf */
9140 argsv = (efix ? efix <= svmax : svix < svmax) ?
9141 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9148 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9150 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9152 eptr = (char*)utf8buf;
9153 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9164 if (args && !vectorize) {
9165 eptr = va_arg(*args, char*);
9167 #ifdef MACOS_TRADITIONAL
9168 /* On MacOS, %#s format is used for Pascal strings */
9173 elen = strlen(eptr);
9175 eptr = (char *)nullstr;
9176 elen = sizeof nullstr - 1;
9180 eptr = SvPVx_const(argsv, elen);
9181 if (DO_UTF8(argsv)) {
9182 if (has_precis && precis < elen) {
9184 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9187 if (width) { /* fudge width (can't fudge elen) */
9188 width += elen - sv_len_utf8(argsv);
9196 if (has_precis && elen > precis)
9203 if (left && args) { /* SVf */
9212 argsv = va_arg(*args, SV*);
9213 eptr = SvPVx_const(argsv, elen);
9218 if (alt || vectorize)
9220 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9238 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9247 esignbuf[esignlen++] = plus;
9251 case 'h': iv = (short)va_arg(*args, int); break;
9252 case 'l': iv = va_arg(*args, long); break;
9253 case 'V': iv = va_arg(*args, IV); break;
9254 default: iv = va_arg(*args, int); break;
9256 case 'q': iv = va_arg(*args, Quad_t); break;
9261 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9263 case 'h': iv = (short)tiv; break;
9264 case 'l': iv = (long)tiv; break;
9266 default: iv = tiv; break;
9268 case 'q': iv = (Quad_t)tiv; break;
9272 if ( !vectorize ) /* we already set uv above */
9277 esignbuf[esignlen++] = plus;
9281 esignbuf[esignlen++] = '-';
9324 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9335 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9336 case 'l': uv = va_arg(*args, unsigned long); break;
9337 case 'V': uv = va_arg(*args, UV); break;
9338 default: uv = va_arg(*args, unsigned); break;
9340 case 'q': uv = va_arg(*args, Uquad_t); break;
9345 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9347 case 'h': uv = (unsigned short)tuv; break;
9348 case 'l': uv = (unsigned long)tuv; break;
9350 default: uv = tuv; break;
9352 case 'q': uv = (Uquad_t)tuv; break;
9359 char *ptr = ebuf + sizeof ebuf;
9365 p = (char*)((c == 'X')
9366 ? "0123456789ABCDEF" : "0123456789abcdef");
9372 esignbuf[esignlen++] = '0';
9373 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9381 if (alt && *ptr != '0')
9390 esignbuf[esignlen++] = '0';
9391 esignbuf[esignlen++] = 'b';
9394 default: /* it had better be ten or less */
9398 } while (uv /= base);
9401 elen = (ebuf + sizeof ebuf) - ptr;
9405 zeros = precis - elen;
9406 else if (precis == 0 && elen == 1 && *eptr == '0')
9412 /* FLOATING POINT */
9415 c = 'f'; /* maybe %F isn't supported here */
9421 /* This is evil, but floating point is even more evil */
9423 /* for SV-style calling, we can only get NV
9424 for C-style calling, we assume %f is double;
9425 for simplicity we allow any of %Lf, %llf, %qf for long double
9429 #if defined(USE_LONG_DOUBLE)
9433 /* [perl #20339] - we should accept and ignore %lf rather than die */
9437 #if defined(USE_LONG_DOUBLE)
9438 intsize = args ? 0 : 'q';
9442 #if defined(HAS_LONG_DOUBLE)
9451 /* now we need (long double) if intsize == 'q', else (double) */
9452 nv = (args && !vectorize) ?
9453 #if LONG_DOUBLESIZE > DOUBLESIZE
9455 va_arg(*args, long double) :
9456 va_arg(*args, double)
9458 va_arg(*args, double)
9464 if (c != 'e' && c != 'E') {
9466 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9467 will cast our (long double) to (double) */
9468 (void)Perl_frexp(nv, &i);
9469 if (i == PERL_INT_MIN)
9470 Perl_die(aTHX_ "panic: frexp");
9472 need = BIT_DIGITS(i);
9474 need += has_precis ? precis : 6; /* known default */
9479 #ifdef HAS_LDBL_SPRINTF_BUG
9480 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9481 with sfio - Allen <allens@cpan.org> */
9484 # define MY_DBL_MAX DBL_MAX
9485 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9486 # if DOUBLESIZE >= 8
9487 # define MY_DBL_MAX 1.7976931348623157E+308L
9489 # define MY_DBL_MAX 3.40282347E+38L
9493 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9494 # define MY_DBL_MAX_BUG 1L
9496 # define MY_DBL_MAX_BUG MY_DBL_MAX
9500 # define MY_DBL_MIN DBL_MIN
9501 # else /* XXX guessing! -Allen */
9502 # if DOUBLESIZE >= 8
9503 # define MY_DBL_MIN 2.2250738585072014E-308L
9505 # define MY_DBL_MIN 1.17549435E-38L
9509 if ((intsize == 'q') && (c == 'f') &&
9510 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9512 /* it's going to be short enough that
9513 * long double precision is not needed */
9515 if ((nv <= 0L) && (nv >= -0L))
9516 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9518 /* would use Perl_fp_class as a double-check but not
9519 * functional on IRIX - see perl.h comments */
9521 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9522 /* It's within the range that a double can represent */
9523 #if defined(DBL_MAX) && !defined(DBL_MIN)
9524 if ((nv >= ((long double)1/DBL_MAX)) ||
9525 (nv <= (-(long double)1/DBL_MAX)))
9527 fix_ldbl_sprintf_bug = TRUE;
9530 if (fix_ldbl_sprintf_bug == TRUE) {
9540 # undef MY_DBL_MAX_BUG
9543 #endif /* HAS_LDBL_SPRINTF_BUG */
9545 need += 20; /* fudge factor */
9546 if (PL_efloatsize < need) {
9547 Safefree(PL_efloatbuf);
9548 PL_efloatsize = need + 20; /* more fudge */
9549 New(906, PL_efloatbuf, PL_efloatsize, char);
9550 PL_efloatbuf[0] = '\0';
9553 if ( !(width || left || plus || alt) && fill != '0'
9554 && has_precis && intsize != 'q' ) { /* Shortcuts */
9555 /* See earlier comment about buggy Gconvert when digits,
9557 if ( c == 'g' && precis) {
9558 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9559 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9560 goto float_converted;
9561 } else if ( c == 'f' && !precis) {
9562 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9567 char *ptr = ebuf + sizeof ebuf;
9570 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9571 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9572 if (intsize == 'q') {
9573 /* Copy the one or more characters in a long double
9574 * format before the 'base' ([efgEFG]) character to
9575 * the format string. */
9576 static char const prifldbl[] = PERL_PRIfldbl;
9577 char const *p = prifldbl + sizeof(prifldbl) - 3;
9578 while (p >= prifldbl) { *--ptr = *p--; }
9583 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9588 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9600 /* No taint. Otherwise we are in the strange situation
9601 * where printf() taints but print($float) doesn't.
9603 #if defined(HAS_LONG_DOUBLE)
9605 (void)sprintf(PL_efloatbuf, ptr, nv);
9607 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9609 (void)sprintf(PL_efloatbuf, ptr, nv);
9613 eptr = PL_efloatbuf;
9614 elen = strlen(PL_efloatbuf);
9620 i = SvCUR(sv) - origlen;
9621 if (args && !vectorize) {
9623 case 'h': *(va_arg(*args, short*)) = i; break;
9624 default: *(va_arg(*args, int*)) = i; break;
9625 case 'l': *(va_arg(*args, long*)) = i; break;
9626 case 'V': *(va_arg(*args, IV*)) = i; break;
9628 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9633 sv_setuv_mg(argsv, (UV)i);
9635 continue; /* not "break" */
9641 if (!args && ckWARN(WARN_PRINTF) &&
9642 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9643 SV *msg = sv_newmortal();
9644 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9645 (PL_op->op_type == OP_PRTF) ? "" : "s");
9648 Perl_sv_catpvf(aTHX_ msg,
9649 "\"%%%c\"", c & 0xFF);
9651 Perl_sv_catpvf(aTHX_ msg,
9652 "\"%%\\%03"UVof"\"",
9655 sv_catpv(msg, "end of string");
9656 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9659 /* output mangled stuff ... */
9665 /* ... right here, because formatting flags should not apply */
9666 SvGROW(sv, SvCUR(sv) + elen + 1);
9668 Copy(eptr, p, elen, char);
9671 SvCUR_set(sv, p - SvPVX_const(sv));
9673 continue; /* not "break" */
9676 /* calculate width before utf8_upgrade changes it */
9677 have = esignlen + zeros + elen;
9679 if (is_utf8 != has_utf8) {
9682 sv_utf8_upgrade(sv);
9685 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9686 sv_utf8_upgrade(nsv);
9687 eptr = SvPVX_const(nsv);
9690 SvGROW(sv, SvCUR(sv) + elen + 1);
9695 need = (have > width ? have : width);
9698 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9700 if (esignlen && fill == '0') {
9701 for (i = 0; i < (int)esignlen; i++)
9705 memset(p, fill, gap);
9708 if (esignlen && fill != '0') {
9709 for (i = 0; i < (int)esignlen; i++)
9713 for (i = zeros; i; i--)
9717 Copy(eptr, p, elen, char);
9721 memset(p, ' ', gap);
9726 Copy(dotstr, p, dotstrlen, char);
9730 vectorize = FALSE; /* done iterating over vecstr */
9737 SvCUR_set(sv, p - SvPVX_const(sv));
9745 /* =========================================================================
9747 =head1 Cloning an interpreter
9749 All the macros and functions in this section are for the private use of
9750 the main function, perl_clone().
9752 The foo_dup() functions make an exact copy of an existing foo thinngy.
9753 During the course of a cloning, a hash table is used to map old addresses
9754 to new addresses. The table is created and manipulated with the
9755 ptr_table_* functions.
9759 ============================================================================*/
9762 #if defined(USE_ITHREADS)
9764 #ifndef GpREFCNT_inc
9765 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9769 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9770 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9771 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9772 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9773 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9774 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9775 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9776 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9777 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9778 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9779 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9780 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9781 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9784 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9785 regcomp.c. AMS 20010712 */
9788 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9793 struct reg_substr_datum *s;
9796 return (REGEXP *)NULL;
9798 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9801 len = r->offsets[0];
9802 npar = r->nparens+1;
9804 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9805 Copy(r->program, ret->program, len+1, regnode);
9807 New(0, ret->startp, npar, I32);
9808 Copy(r->startp, ret->startp, npar, I32);
9809 New(0, ret->endp, npar, I32);
9810 Copy(r->startp, ret->startp, npar, I32);
9812 New(0, ret->substrs, 1, struct reg_substr_data);
9813 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9814 s->min_offset = r->substrs->data[i].min_offset;
9815 s->max_offset = r->substrs->data[i].max_offset;
9816 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9817 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9820 ret->regstclass = NULL;
9823 const int count = r->data->count;
9825 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9826 char, struct reg_data);
9827 New(0, d->what, count, U8);
9830 for (i = 0; i < count; i++) {
9831 d->what[i] = r->data->what[i];
9832 switch (d->what[i]) {
9833 /* legal options are one of: sfpont
9834 see also regcomp.h and pregfree() */
9836 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9839 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9842 /* This is cheating. */
9843 New(0, d->data[i], 1, struct regnode_charclass_class);
9844 StructCopy(r->data->data[i], d->data[i],
9845 struct regnode_charclass_class);
9846 ret->regstclass = (regnode*)d->data[i];
9849 /* Compiled op trees are readonly, and can thus be
9850 shared without duplication. */
9852 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9856 d->data[i] = r->data->data[i];
9859 d->data[i] = r->data->data[i];
9861 ((reg_trie_data*)d->data[i])->refcount++;
9865 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9874 New(0, ret->offsets, 2*len+1, U32);
9875 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9877 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9878 ret->refcnt = r->refcnt;
9879 ret->minlen = r->minlen;
9880 ret->prelen = r->prelen;
9881 ret->nparens = r->nparens;
9882 ret->lastparen = r->lastparen;
9883 ret->lastcloseparen = r->lastcloseparen;
9884 ret->reganch = r->reganch;
9886 ret->sublen = r->sublen;
9888 if (RX_MATCH_COPIED(ret))
9889 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9891 ret->subbeg = Nullch;
9892 #ifdef PERL_OLD_COPY_ON_WRITE
9893 ret->saved_copy = Nullsv;
9896 ptr_table_store(PL_ptr_table, r, ret);
9900 /* duplicate a file handle */
9903 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9909 return (PerlIO*)NULL;
9911 /* look for it in the table first */
9912 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9916 /* create anew and remember what it is */
9917 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9918 ptr_table_store(PL_ptr_table, fp, ret);
9922 /* duplicate a directory handle */
9925 Perl_dirp_dup(pTHX_ DIR *dp)
9933 /* duplicate a typeglob */
9936 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9941 /* look for it in the table first */
9942 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9946 /* create anew and remember what it is */
9947 Newz(0, ret, 1, GP);
9948 ptr_table_store(PL_ptr_table, gp, ret);
9951 ret->gp_refcnt = 0; /* must be before any other dups! */
9952 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9953 ret->gp_io = io_dup_inc(gp->gp_io, param);
9954 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9955 ret->gp_av = av_dup_inc(gp->gp_av, param);
9956 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9957 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9958 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9959 ret->gp_cvgen = gp->gp_cvgen;
9960 ret->gp_flags = gp->gp_flags;
9961 ret->gp_line = gp->gp_line;
9962 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9966 /* duplicate a chain of magic */
9969 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9971 MAGIC *mgprev = (MAGIC*)NULL;
9974 return (MAGIC*)NULL;
9975 /* look for it in the table first */
9976 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9980 for (; mg; mg = mg->mg_moremagic) {
9982 Newz(0, nmg, 1, MAGIC);
9984 mgprev->mg_moremagic = nmg;
9987 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9988 nmg->mg_private = mg->mg_private;
9989 nmg->mg_type = mg->mg_type;
9990 nmg->mg_flags = mg->mg_flags;
9991 if (mg->mg_type == PERL_MAGIC_qr) {
9992 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9994 else if(mg->mg_type == PERL_MAGIC_backref) {
9995 const AV * const av = (AV*) mg->mg_obj;
9998 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10000 for (i = AvFILLp(av); i >= 0; i--) {
10001 if (!svp[i]) continue;
10002 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10005 else if (mg->mg_type == PERL_MAGIC_symtab) {
10006 nmg->mg_obj = mg->mg_obj;
10009 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10010 ? sv_dup_inc(mg->mg_obj, param)
10011 : sv_dup(mg->mg_obj, param);
10013 nmg->mg_len = mg->mg_len;
10014 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10015 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10016 if (mg->mg_len > 0) {
10017 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10018 if (mg->mg_type == PERL_MAGIC_overload_table &&
10019 AMT_AMAGIC((AMT*)mg->mg_ptr))
10021 AMT *amtp = (AMT*)mg->mg_ptr;
10022 AMT *namtp = (AMT*)nmg->mg_ptr;
10024 for (i = 1; i < NofAMmeth; i++) {
10025 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10029 else if (mg->mg_len == HEf_SVKEY)
10030 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10032 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10033 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10040 /* create a new pointer-mapping table */
10043 Perl_ptr_table_new(pTHX)
10046 Newz(0, tbl, 1, PTR_TBL_t);
10047 tbl->tbl_max = 511;
10048 tbl->tbl_items = 0;
10049 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10054 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10056 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10064 struct ptr_tbl_ent* pte;
10065 struct ptr_tbl_ent* pteend;
10066 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10067 pte->next = PL_pte_arenaroot;
10068 PL_pte_arenaroot = pte;
10070 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10071 PL_pte_root = ++pte;
10072 while (pte < pteend) {
10073 pte->next = pte + 1;
10079 STATIC struct ptr_tbl_ent*
10082 struct ptr_tbl_ent* pte;
10086 PL_pte_root = pte->next;
10091 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10093 p->next = PL_pte_root;
10097 /* map an existing pointer using a table */
10100 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10102 PTR_TBL_ENT_t *tblent;
10103 const UV hash = PTR_TABLE_HASH(sv);
10105 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10106 for (; tblent; tblent = tblent->next) {
10107 if (tblent->oldval == sv)
10108 return tblent->newval;
10110 return (void*)NULL;
10113 /* add a new entry to a pointer-mapping table */
10116 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10118 PTR_TBL_ENT_t *tblent, **otblent;
10119 /* XXX this may be pessimal on platforms where pointers aren't good
10120 * hash values e.g. if they grow faster in the most significant
10122 const UV hash = PTR_TABLE_HASH(oldv);
10126 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10127 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10128 if (tblent->oldval == oldv) {
10129 tblent->newval = newv;
10133 tblent = S_new_pte(aTHX);
10134 tblent->oldval = oldv;
10135 tblent->newval = newv;
10136 tblent->next = *otblent;
10139 if (!empty && tbl->tbl_items > tbl->tbl_max)
10140 ptr_table_split(tbl);
10143 /* double the hash bucket size of an existing ptr table */
10146 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10148 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10149 const UV oldsize = tbl->tbl_max + 1;
10150 UV newsize = oldsize * 2;
10153 Renew(ary, newsize, PTR_TBL_ENT_t*);
10154 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10155 tbl->tbl_max = --newsize;
10156 tbl->tbl_ary = ary;
10157 for (i=0; i < oldsize; i++, ary++) {
10158 PTR_TBL_ENT_t **curentp, **entp, *ent;
10161 curentp = ary + oldsize;
10162 for (entp = ary, ent = *ary; ent; ent = *entp) {
10163 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10165 ent->next = *curentp;
10175 /* remove all the entries from a ptr table */
10178 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10180 register PTR_TBL_ENT_t **array;
10181 register PTR_TBL_ENT_t *entry;
10185 if (!tbl || !tbl->tbl_items) {
10189 array = tbl->tbl_ary;
10191 max = tbl->tbl_max;
10195 PTR_TBL_ENT_t *oentry = entry;
10196 entry = entry->next;
10197 S_del_pte(aTHX_ oentry);
10200 if (++riter > max) {
10203 entry = array[riter];
10207 tbl->tbl_items = 0;
10210 /* clear and free a ptr table */
10213 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10218 ptr_table_clear(tbl);
10219 Safefree(tbl->tbl_ary);
10223 /* attempt to make everything in the typeglob readonly */
10226 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10228 GV *gv = (GV*)sstr;
10229 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10231 if (GvIO(gv) || GvFORM(gv)) {
10232 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10234 else if (!GvCV(gv)) {
10235 GvCV(gv) = (CV*)sv;
10238 /* CvPADLISTs cannot be shared */
10239 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10244 if (!GvUNIQUE(gv)) {
10246 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10247 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10253 * write attempts will die with
10254 * "Modification of a read-only value attempted"
10260 SvREADONLY_on(GvSV(gv));
10264 GvAV(gv) = (AV*)sv;
10267 SvREADONLY_on(GvAV(gv));
10271 GvHV(gv) = (HV*)sv;
10274 SvREADONLY_on(GvHV(gv));
10277 return sstr; /* he_dup() will SvREFCNT_inc() */
10280 /* duplicate an SV of any type (including AV, HV etc) */
10283 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10286 SvRV_set(dstr, SvWEAKREF(sstr)
10287 ? sv_dup(SvRV(sstr), param)
10288 : sv_dup_inc(SvRV(sstr), param));
10291 else if (SvPVX_const(sstr)) {
10292 /* Has something there */
10294 /* Normal PV - clone whole allocated space */
10295 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10296 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10297 /* Not that normal - actually sstr is copy on write.
10298 But we are a true, independant SV, so: */
10299 SvREADONLY_off(dstr);
10304 /* Special case - not normally malloced for some reason */
10305 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10306 /* A "shared" PV - clone it as "shared" PV */
10308 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10312 /* Some other special case - random pointer */
10313 SvPV_set(dstr, SvPVX(sstr));
10318 /* Copy the Null */
10319 if (SvTYPE(dstr) == SVt_RV)
10320 SvRV_set(dstr, NULL);
10327 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10332 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10334 /* look for it in the table first */
10335 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10339 if(param->flags & CLONEf_JOIN_IN) {
10340 /** We are joining here so we don't want do clone
10341 something that is bad **/
10342 const char *hvname;
10344 if(SvTYPE(sstr) == SVt_PVHV &&
10345 (hvname = HvNAME_get(sstr))) {
10346 /** don't clone stashes if they already exist **/
10347 HV* old_stash = gv_stashpv(hvname,0);
10348 return (SV*) old_stash;
10352 /* create anew and remember what it is */
10355 #ifdef DEBUG_LEAKING_SCALARS
10356 dstr->sv_debug_optype = sstr->sv_debug_optype;
10357 dstr->sv_debug_line = sstr->sv_debug_line;
10358 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10359 dstr->sv_debug_cloned = 1;
10361 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10363 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10367 ptr_table_store(PL_ptr_table, sstr, dstr);
10370 SvFLAGS(dstr) = SvFLAGS(sstr);
10371 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10372 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10375 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10376 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10377 PL_watch_pvx, SvPVX_const(sstr));
10380 /* don't clone objects whose class has asked us not to */
10381 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10382 SvFLAGS(dstr) &= ~SVTYPEMASK;
10383 SvOBJECT_off(dstr);
10387 switch (SvTYPE(sstr)) {
10389 SvANY(dstr) = NULL;
10392 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10393 SvIV_set(dstr, SvIVX(sstr));
10396 SvANY(dstr) = new_XNV();
10397 SvNV_set(dstr, SvNVX(sstr));
10400 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10401 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10404 SvANY(dstr) = new_XPV();
10405 SvCUR_set(dstr, SvCUR(sstr));
10406 SvLEN_set(dstr, SvLEN(sstr));
10407 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10410 SvANY(dstr) = new_XPVIV();
10411 SvCUR_set(dstr, SvCUR(sstr));
10412 SvLEN_set(dstr, SvLEN(sstr));
10413 SvIV_set(dstr, SvIVX(sstr));
10414 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10417 SvANY(dstr) = new_XPVNV();
10418 SvCUR_set(dstr, SvCUR(sstr));
10419 SvLEN_set(dstr, SvLEN(sstr));
10420 SvIV_set(dstr, SvIVX(sstr));
10421 SvNV_set(dstr, SvNVX(sstr));
10422 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10425 SvANY(dstr) = new_XPVMG();
10426 SvCUR_set(dstr, SvCUR(sstr));
10427 SvLEN_set(dstr, SvLEN(sstr));
10428 SvIV_set(dstr, SvIVX(sstr));
10429 SvNV_set(dstr, SvNVX(sstr));
10430 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10431 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10432 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10435 SvANY(dstr) = new_XPVBM();
10436 SvCUR_set(dstr, SvCUR(sstr));
10437 SvLEN_set(dstr, SvLEN(sstr));
10438 SvIV_set(dstr, SvIVX(sstr));
10439 SvNV_set(dstr, SvNVX(sstr));
10440 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10441 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10442 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10443 BmRARE(dstr) = BmRARE(sstr);
10444 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10445 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10448 SvANY(dstr) = new_XPVLV();
10449 SvCUR_set(dstr, SvCUR(sstr));
10450 SvLEN_set(dstr, SvLEN(sstr));
10451 SvIV_set(dstr, SvIVX(sstr));
10452 SvNV_set(dstr, SvNVX(sstr));
10453 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10454 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10455 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10456 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10457 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10458 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10459 LvTARG(dstr) = dstr;
10460 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10461 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10463 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10464 LvTYPE(dstr) = LvTYPE(sstr);
10467 if (GvUNIQUE((GV*)sstr)) {
10469 if ((share = gv_share(sstr, param))) {
10472 ptr_table_store(PL_ptr_table, sstr, dstr);
10474 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10475 HvNAME_get(GvSTASH(share)), GvNAME(share));
10480 SvANY(dstr) = new_XPVGV();
10481 SvCUR_set(dstr, SvCUR(sstr));
10482 SvLEN_set(dstr, SvLEN(sstr));
10483 SvIV_set(dstr, SvIVX(sstr));
10484 SvNV_set(dstr, SvNVX(sstr));
10485 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10486 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10487 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10488 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10489 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10490 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10491 GvFLAGS(dstr) = GvFLAGS(sstr);
10492 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10493 (void)GpREFCNT_inc(GvGP(dstr));
10496 SvANY(dstr) = new_XPVIO();
10497 SvCUR_set(dstr, SvCUR(sstr));
10498 SvLEN_set(dstr, SvLEN(sstr));
10499 SvIV_set(dstr, SvIVX(sstr));
10500 SvNV_set(dstr, SvNVX(sstr));
10501 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10502 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10503 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10504 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10505 if (IoOFP(sstr) == IoIFP(sstr))
10506 IoOFP(dstr) = IoIFP(dstr);
10508 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10509 /* PL_rsfp_filters entries have fake IoDIRP() */
10510 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10511 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10513 IoDIRP(dstr) = IoDIRP(sstr);
10514 IoLINES(dstr) = IoLINES(sstr);
10515 IoPAGE(dstr) = IoPAGE(sstr);
10516 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10517 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10518 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10519 /* I have no idea why fake dirp (rsfps)
10520 should be treaded differently but otherwise
10521 we end up with leaks -- sky*/
10522 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10523 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10524 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10526 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10527 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10528 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10530 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10531 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10532 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10533 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10534 IoTYPE(dstr) = IoTYPE(sstr);
10535 IoFLAGS(dstr) = IoFLAGS(sstr);
10538 SvANY(dstr) = new_XPVAV();
10539 SvCUR_set(dstr, SvCUR(sstr));
10540 SvLEN_set(dstr, SvLEN(sstr));
10541 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10542 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10543 if (AvARRAY((AV*)sstr)) {
10544 SV **dst_ary, **src_ary;
10545 SSize_t items = AvFILLp((AV*)sstr) + 1;
10547 src_ary = AvARRAY((AV*)sstr);
10548 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10549 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10550 SvPV_set(dstr, (char*)dst_ary);
10551 AvALLOC((AV*)dstr) = dst_ary;
10552 if (AvREAL((AV*)sstr)) {
10553 while (items-- > 0)
10554 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10557 while (items-- > 0)
10558 *dst_ary++ = sv_dup(*src_ary++, param);
10560 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10561 while (items-- > 0) {
10562 *dst_ary++ = &PL_sv_undef;
10566 SvPV_set(dstr, Nullch);
10567 AvALLOC((AV*)dstr) = (SV**)NULL;
10571 SvANY(dstr) = new_XPVHV();
10572 SvCUR_set(dstr, SvCUR(sstr));
10573 SvLEN_set(dstr, SvLEN(sstr));
10574 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10575 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10576 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10580 if (HvARRAY((HV*)sstr)) {
10582 const bool sharekeys = !!HvSHAREKEYS(sstr);
10583 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10584 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10587 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10588 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
10589 HvARRAY(dstr) = (HE**)darray;
10590 while (i <= sxhv->xhv_max) {
10591 HE *source = HvARRAY(sstr)[i];
10593 = source ? he_dup(source, sharekeys, param) : 0;
10597 struct xpvhv_aux *saux = HvAUX(sstr);
10598 struct xpvhv_aux *daux = HvAUX(dstr);
10599 /* This flag isn't copied. */
10600 /* SvOOK_on(hv) attacks the IV flags. */
10601 SvFLAGS(dstr) |= SVf_OOK;
10603 hvname = saux->xhv_name;
10604 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10606 daux->xhv_riter = saux->xhv_riter;
10607 daux->xhv_eiter = saux->xhv_eiter
10608 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
10613 SvPV_set(dstr, Nullch);
10615 /* Record stashes for possible cloning in Perl_clone(). */
10617 av_push(param->stashes, dstr);
10621 SvANY(dstr) = new_XPVFM();
10622 FmLINES(dstr) = FmLINES(sstr);
10626 SvANY(dstr) = new_XPVCV();
10628 SvCUR_set(dstr, SvCUR(sstr));
10629 SvLEN_set(dstr, SvLEN(sstr));
10630 SvIV_set(dstr, SvIVX(sstr));
10631 SvNV_set(dstr, SvNVX(sstr));
10632 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10633 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10634 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10635 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10636 CvSTART(dstr) = CvSTART(sstr);
10638 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10640 CvXSUB(dstr) = CvXSUB(sstr);
10641 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10642 if (CvCONST(sstr)) {
10643 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10644 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10645 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
10647 /* don't dup if copying back - CvGV isn't refcounted, so the
10648 * duped GV may never be freed. A bit of a hack! DAPM */
10649 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10650 Nullgv : gv_dup(CvGV(sstr), param) ;
10651 if (param->flags & CLONEf_COPY_STACKS) {
10652 CvDEPTH(dstr) = CvDEPTH(sstr);
10656 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10657 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10659 CvWEAKOUTSIDE(sstr)
10660 ? cv_dup( CvOUTSIDE(sstr), param)
10661 : cv_dup_inc(CvOUTSIDE(sstr), param);
10662 CvFLAGS(dstr) = CvFLAGS(sstr);
10663 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10666 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10670 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10676 /* duplicate a context */
10679 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10681 PERL_CONTEXT *ncxs;
10684 return (PERL_CONTEXT*)NULL;
10686 /* look for it in the table first */
10687 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10691 /* create anew and remember what it is */
10692 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10693 ptr_table_store(PL_ptr_table, cxs, ncxs);
10696 PERL_CONTEXT *cx = &cxs[ix];
10697 PERL_CONTEXT *ncx = &ncxs[ix];
10698 ncx->cx_type = cx->cx_type;
10699 if (CxTYPE(cx) == CXt_SUBST) {
10700 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10703 ncx->blk_oldsp = cx->blk_oldsp;
10704 ncx->blk_oldcop = cx->blk_oldcop;
10705 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10706 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10707 ncx->blk_oldpm = cx->blk_oldpm;
10708 ncx->blk_gimme = cx->blk_gimme;
10709 switch (CxTYPE(cx)) {
10711 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10712 ? cv_dup_inc(cx->blk_sub.cv, param)
10713 : cv_dup(cx->blk_sub.cv,param));
10714 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10715 ? av_dup_inc(cx->blk_sub.argarray, param)
10717 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10718 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10719 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10720 ncx->blk_sub.lval = cx->blk_sub.lval;
10721 ncx->blk_sub.retop = cx->blk_sub.retop;
10724 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10725 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10726 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10727 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10728 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10729 ncx->blk_eval.retop = cx->blk_eval.retop;
10732 ncx->blk_loop.label = cx->blk_loop.label;
10733 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10734 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10735 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10736 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10737 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10738 ? cx->blk_loop.iterdata
10739 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10740 ncx->blk_loop.oldcomppad
10741 = (PAD*)ptr_table_fetch(PL_ptr_table,
10742 cx->blk_loop.oldcomppad);
10743 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10744 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10745 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10746 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10747 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10750 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10751 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10752 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10753 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10754 ncx->blk_sub.retop = cx->blk_sub.retop;
10766 /* duplicate a stack info structure */
10769 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10774 return (PERL_SI*)NULL;
10776 /* look for it in the table first */
10777 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10781 /* create anew and remember what it is */
10782 Newz(56, nsi, 1, PERL_SI);
10783 ptr_table_store(PL_ptr_table, si, nsi);
10785 nsi->si_stack = av_dup_inc(si->si_stack, param);
10786 nsi->si_cxix = si->si_cxix;
10787 nsi->si_cxmax = si->si_cxmax;
10788 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10789 nsi->si_type = si->si_type;
10790 nsi->si_prev = si_dup(si->si_prev, param);
10791 nsi->si_next = si_dup(si->si_next, param);
10792 nsi->si_markoff = si->si_markoff;
10797 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10798 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10799 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10800 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10801 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10802 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10803 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10804 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10805 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10806 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10807 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10808 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10809 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10810 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10813 #define pv_dup_inc(p) SAVEPV(p)
10814 #define pv_dup(p) SAVEPV(p)
10815 #define svp_dup_inc(p,pp) any_dup(p,pp)
10817 /* map any object to the new equivent - either something in the
10818 * ptr table, or something in the interpreter structure
10822 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10827 return (void*)NULL;
10829 /* look for it in the table first */
10830 ret = ptr_table_fetch(PL_ptr_table, v);
10834 /* see if it is part of the interpreter structure */
10835 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10836 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10844 /* duplicate the save stack */
10847 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10849 ANY *ss = proto_perl->Tsavestack;
10850 I32 ix = proto_perl->Tsavestack_ix;
10851 I32 max = proto_perl->Tsavestack_max;
10863 void (*dptr) (void*);
10864 void (*dxptr) (pTHX_ void*);
10867 Newz(54, nss, max, ANY);
10870 I32 i = POPINT(ss,ix);
10871 TOPINT(nss,ix) = i;
10873 case SAVEt_ITEM: /* normal string */
10874 sv = (SV*)POPPTR(ss,ix);
10875 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10876 sv = (SV*)POPPTR(ss,ix);
10877 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10879 case SAVEt_SV: /* scalar reference */
10880 sv = (SV*)POPPTR(ss,ix);
10881 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10882 gv = (GV*)POPPTR(ss,ix);
10883 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10885 case SAVEt_GENERIC_PVREF: /* generic char* */
10886 c = (char*)POPPTR(ss,ix);
10887 TOPPTR(nss,ix) = pv_dup(c);
10888 ptr = POPPTR(ss,ix);
10889 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10891 case SAVEt_SHARED_PVREF: /* char* in shared space */
10892 c = (char*)POPPTR(ss,ix);
10893 TOPPTR(nss,ix) = savesharedpv(c);
10894 ptr = POPPTR(ss,ix);
10895 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10897 case SAVEt_GENERIC_SVREF: /* generic sv */
10898 case SAVEt_SVREF: /* scalar reference */
10899 sv = (SV*)POPPTR(ss,ix);
10900 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10901 ptr = POPPTR(ss,ix);
10902 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10904 case SAVEt_AV: /* array reference */
10905 av = (AV*)POPPTR(ss,ix);
10906 TOPPTR(nss,ix) = av_dup_inc(av, param);
10907 gv = (GV*)POPPTR(ss,ix);
10908 TOPPTR(nss,ix) = gv_dup(gv, param);
10910 case SAVEt_HV: /* hash reference */
10911 hv = (HV*)POPPTR(ss,ix);
10912 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10913 gv = (GV*)POPPTR(ss,ix);
10914 TOPPTR(nss,ix) = gv_dup(gv, param);
10916 case SAVEt_INT: /* int reference */
10917 ptr = POPPTR(ss,ix);
10918 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10919 intval = (int)POPINT(ss,ix);
10920 TOPINT(nss,ix) = intval;
10922 case SAVEt_LONG: /* long reference */
10923 ptr = POPPTR(ss,ix);
10924 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10925 longval = (long)POPLONG(ss,ix);
10926 TOPLONG(nss,ix) = longval;
10928 case SAVEt_I32: /* I32 reference */
10929 case SAVEt_I16: /* I16 reference */
10930 case SAVEt_I8: /* I8 reference */
10931 ptr = POPPTR(ss,ix);
10932 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10934 TOPINT(nss,ix) = i;
10936 case SAVEt_IV: /* IV reference */
10937 ptr = POPPTR(ss,ix);
10938 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10940 TOPIV(nss,ix) = iv;
10942 case SAVEt_SPTR: /* SV* reference */
10943 ptr = POPPTR(ss,ix);
10944 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10945 sv = (SV*)POPPTR(ss,ix);
10946 TOPPTR(nss,ix) = sv_dup(sv, param);
10948 case SAVEt_VPTR: /* random* reference */
10949 ptr = POPPTR(ss,ix);
10950 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10951 ptr = POPPTR(ss,ix);
10952 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10954 case SAVEt_PPTR: /* char* reference */
10955 ptr = POPPTR(ss,ix);
10956 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10957 c = (char*)POPPTR(ss,ix);
10958 TOPPTR(nss,ix) = pv_dup(c);
10960 case SAVEt_HPTR: /* HV* reference */
10961 ptr = POPPTR(ss,ix);
10962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10963 hv = (HV*)POPPTR(ss,ix);
10964 TOPPTR(nss,ix) = hv_dup(hv, param);
10966 case SAVEt_APTR: /* AV* reference */
10967 ptr = POPPTR(ss,ix);
10968 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10969 av = (AV*)POPPTR(ss,ix);
10970 TOPPTR(nss,ix) = av_dup(av, param);
10973 gv = (GV*)POPPTR(ss,ix);
10974 TOPPTR(nss,ix) = gv_dup(gv, param);
10976 case SAVEt_GP: /* scalar reference */
10977 gp = (GP*)POPPTR(ss,ix);
10978 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10979 (void)GpREFCNT_inc(gp);
10980 gv = (GV*)POPPTR(ss,ix);
10981 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10982 c = (char*)POPPTR(ss,ix);
10983 TOPPTR(nss,ix) = pv_dup(c);
10985 TOPIV(nss,ix) = iv;
10987 TOPIV(nss,ix) = iv;
10990 case SAVEt_MORTALIZESV:
10991 sv = (SV*)POPPTR(ss,ix);
10992 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10995 ptr = POPPTR(ss,ix);
10996 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10997 /* these are assumed to be refcounted properly */
10998 switch (((OP*)ptr)->op_type) {
11000 case OP_LEAVESUBLV:
11004 case OP_LEAVEWRITE:
11005 TOPPTR(nss,ix) = ptr;
11010 TOPPTR(nss,ix) = Nullop;
11015 TOPPTR(nss,ix) = Nullop;
11018 c = (char*)POPPTR(ss,ix);
11019 TOPPTR(nss,ix) = pv_dup_inc(c);
11021 case SAVEt_CLEARSV:
11022 longval = POPLONG(ss,ix);
11023 TOPLONG(nss,ix) = longval;
11026 hv = (HV*)POPPTR(ss,ix);
11027 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11028 c = (char*)POPPTR(ss,ix);
11029 TOPPTR(nss,ix) = pv_dup_inc(c);
11031 TOPINT(nss,ix) = i;
11033 case SAVEt_DESTRUCTOR:
11034 ptr = POPPTR(ss,ix);
11035 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11036 dptr = POPDPTR(ss,ix);
11037 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11038 any_dup(FPTR2DPTR(void *, dptr),
11041 case SAVEt_DESTRUCTOR_X:
11042 ptr = POPPTR(ss,ix);
11043 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11044 dxptr = POPDXPTR(ss,ix);
11045 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11046 any_dup(FPTR2DPTR(void *, dxptr),
11049 case SAVEt_REGCONTEXT:
11052 TOPINT(nss,ix) = i;
11055 case SAVEt_STACK_POS: /* Position on Perl stack */
11057 TOPINT(nss,ix) = i;
11059 case SAVEt_AELEM: /* array element */
11060 sv = (SV*)POPPTR(ss,ix);
11061 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11063 TOPINT(nss,ix) = i;
11064 av = (AV*)POPPTR(ss,ix);
11065 TOPPTR(nss,ix) = av_dup_inc(av, param);
11067 case SAVEt_HELEM: /* hash element */
11068 sv = (SV*)POPPTR(ss,ix);
11069 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11070 sv = (SV*)POPPTR(ss,ix);
11071 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11072 hv = (HV*)POPPTR(ss,ix);
11073 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11076 ptr = POPPTR(ss,ix);
11077 TOPPTR(nss,ix) = ptr;
11081 TOPINT(nss,ix) = i;
11083 case SAVEt_COMPPAD:
11084 av = (AV*)POPPTR(ss,ix);
11085 TOPPTR(nss,ix) = av_dup(av, param);
11088 longval = (long)POPLONG(ss,ix);
11089 TOPLONG(nss,ix) = longval;
11090 ptr = POPPTR(ss,ix);
11091 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11092 sv = (SV*)POPPTR(ss,ix);
11093 TOPPTR(nss,ix) = sv_dup(sv, param);
11096 ptr = POPPTR(ss,ix);
11097 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11098 longval = (long)POPBOOL(ss,ix);
11099 TOPBOOL(nss,ix) = (bool)longval;
11101 case SAVEt_SET_SVFLAGS:
11103 TOPINT(nss,ix) = i;
11105 TOPINT(nss,ix) = i;
11106 sv = (SV*)POPPTR(ss,ix);
11107 TOPPTR(nss,ix) = sv_dup(sv, param);
11110 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11118 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11119 * flag to the result. This is done for each stash before cloning starts,
11120 * so we know which stashes want their objects cloned */
11123 do_mark_cloneable_stash(pTHX_ SV *sv)
11125 const HEK *hvname = HvNAME_HEK((HV*)sv);
11127 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11128 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11129 if (cloner && GvCV(cloner)) {
11136 XPUSHs(sv_2mortal(newSVhek(hvname)));
11138 call_sv((SV*)GvCV(cloner), G_SCALAR);
11145 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11153 =for apidoc perl_clone
11155 Create and return a new interpreter by cloning the current one.
11157 perl_clone takes these flags as parameters:
11159 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11160 without it we only clone the data and zero the stacks,
11161 with it we copy the stacks and the new perl interpreter is
11162 ready to run at the exact same point as the previous one.
11163 The pseudo-fork code uses COPY_STACKS while the
11164 threads->new doesn't.
11166 CLONEf_KEEP_PTR_TABLE
11167 perl_clone keeps a ptr_table with the pointer of the old
11168 variable as a key and the new variable as a value,
11169 this allows it to check if something has been cloned and not
11170 clone it again but rather just use the value and increase the
11171 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11172 the ptr_table using the function
11173 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11174 reason to keep it around is if you want to dup some of your own
11175 variable who are outside the graph perl scans, example of this
11176 code is in threads.xs create
11179 This is a win32 thing, it is ignored on unix, it tells perls
11180 win32host code (which is c++) to clone itself, this is needed on
11181 win32 if you want to run two threads at the same time,
11182 if you just want to do some stuff in a separate perl interpreter
11183 and then throw it away and return to the original one,
11184 you don't need to do anything.
11189 /* XXX the above needs expanding by someone who actually understands it ! */
11190 EXTERN_C PerlInterpreter *
11191 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11194 perl_clone(PerlInterpreter *proto_perl, UV flags)
11197 #ifdef PERL_IMPLICIT_SYS
11199 /* perlhost.h so we need to call into it
11200 to clone the host, CPerlHost should have a c interface, sky */
11202 if (flags & CLONEf_CLONE_HOST) {
11203 return perl_clone_host(proto_perl,flags);
11205 return perl_clone_using(proto_perl, flags,
11207 proto_perl->IMemShared,
11208 proto_perl->IMemParse,
11210 proto_perl->IStdIO,
11214 proto_perl->IProc);
11218 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11219 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11220 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11221 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11222 struct IPerlDir* ipD, struct IPerlSock* ipS,
11223 struct IPerlProc* ipP)
11225 /* XXX many of the string copies here can be optimized if they're
11226 * constants; they need to be allocated as common memory and just
11227 * their pointers copied. */
11230 CLONE_PARAMS clone_params;
11231 CLONE_PARAMS* param = &clone_params;
11233 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11234 /* for each stash, determine whether its objects should be cloned */
11235 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11236 PERL_SET_THX(my_perl);
11239 Poison(my_perl, 1, PerlInterpreter);
11241 PL_curcop = (COP *)Nullop;
11245 PL_savestack_ix = 0;
11246 PL_savestack_max = -1;
11247 PL_sig_pending = 0;
11248 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11249 # else /* !DEBUGGING */
11250 Zero(my_perl, 1, PerlInterpreter);
11251 # endif /* DEBUGGING */
11253 /* host pointers */
11255 PL_MemShared = ipMS;
11256 PL_MemParse = ipMP;
11263 #else /* !PERL_IMPLICIT_SYS */
11265 CLONE_PARAMS clone_params;
11266 CLONE_PARAMS* param = &clone_params;
11267 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11268 /* for each stash, determine whether its objects should be cloned */
11269 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11270 PERL_SET_THX(my_perl);
11273 Poison(my_perl, 1, PerlInterpreter);
11275 PL_curcop = (COP *)Nullop;
11279 PL_savestack_ix = 0;
11280 PL_savestack_max = -1;
11281 PL_sig_pending = 0;
11282 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11283 # else /* !DEBUGGING */
11284 Zero(my_perl, 1, PerlInterpreter);
11285 # endif /* DEBUGGING */
11286 #endif /* PERL_IMPLICIT_SYS */
11287 param->flags = flags;
11288 param->proto_perl = proto_perl;
11291 PL_xnv_arenaroot = NULL;
11292 PL_xnv_root = NULL;
11293 PL_xpv_arenaroot = NULL;
11294 PL_xpv_root = NULL;
11295 PL_xpviv_arenaroot = NULL;
11296 PL_xpviv_root = NULL;
11297 PL_xpvnv_arenaroot = NULL;
11298 PL_xpvnv_root = NULL;
11299 PL_xpvcv_arenaroot = NULL;
11300 PL_xpvcv_root = NULL;
11301 PL_xpvav_arenaroot = NULL;
11302 PL_xpvav_root = NULL;
11303 PL_xpvhv_arenaroot = NULL;
11304 PL_xpvhv_root = NULL;
11305 PL_xpvmg_arenaroot = NULL;
11306 PL_xpvmg_root = NULL;
11307 PL_xpvgv_arenaroot = NULL;
11308 PL_xpvgv_root = NULL;
11309 PL_xpvlv_arenaroot = NULL;
11310 PL_xpvlv_root = NULL;
11311 PL_xpvbm_arenaroot = NULL;
11312 PL_xpvbm_root = NULL;
11313 PL_he_arenaroot = NULL;
11315 #if defined(USE_ITHREADS)
11316 PL_pte_arenaroot = NULL;
11317 PL_pte_root = NULL;
11319 PL_nice_chunk = NULL;
11320 PL_nice_chunk_size = 0;
11322 PL_sv_objcount = 0;
11323 PL_sv_root = Nullsv;
11324 PL_sv_arenaroot = Nullsv;
11326 PL_debug = proto_perl->Idebug;
11328 PL_hash_seed = proto_perl->Ihash_seed;
11329 PL_rehash_seed = proto_perl->Irehash_seed;
11331 #ifdef USE_REENTRANT_API
11332 /* XXX: things like -Dm will segfault here in perlio, but doing
11333 * PERL_SET_CONTEXT(proto_perl);
11334 * breaks too many other things
11336 Perl_reentrant_init(aTHX);
11339 /* create SV map for pointer relocation */
11340 PL_ptr_table = ptr_table_new();
11342 /* initialize these special pointers as early as possible */
11343 SvANY(&PL_sv_undef) = NULL;
11344 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11345 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11346 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11348 SvANY(&PL_sv_no) = new_XPVNV();
11349 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11350 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11351 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11352 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11353 SvCUR_set(&PL_sv_no, 0);
11354 SvLEN_set(&PL_sv_no, 1);
11355 SvIV_set(&PL_sv_no, 0);
11356 SvNV_set(&PL_sv_no, 0);
11357 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11359 SvANY(&PL_sv_yes) = new_XPVNV();
11360 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11361 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11362 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11363 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11364 SvCUR_set(&PL_sv_yes, 1);
11365 SvLEN_set(&PL_sv_yes, 2);
11366 SvIV_set(&PL_sv_yes, 1);
11367 SvNV_set(&PL_sv_yes, 1);
11368 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11370 /* create (a non-shared!) shared string table */
11371 PL_strtab = newHV();
11372 HvSHAREKEYS_off(PL_strtab);
11373 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11374 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11376 PL_compiling = proto_perl->Icompiling;
11378 /* These two PVs will be free'd special way so must set them same way op.c does */
11379 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11380 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11382 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11383 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11385 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11386 if (!specialWARN(PL_compiling.cop_warnings))
11387 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11388 if (!specialCopIO(PL_compiling.cop_io))
11389 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11390 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11392 /* pseudo environmental stuff */
11393 PL_origargc = proto_perl->Iorigargc;
11394 PL_origargv = proto_perl->Iorigargv;
11396 param->stashes = newAV(); /* Setup array of objects to call clone on */
11398 #ifdef PERLIO_LAYERS
11399 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11400 PerlIO_clone(aTHX_ proto_perl, param);
11403 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11404 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11405 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11406 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11407 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11408 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11411 PL_minus_c = proto_perl->Iminus_c;
11412 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11413 PL_localpatches = proto_perl->Ilocalpatches;
11414 PL_splitstr = proto_perl->Isplitstr;
11415 PL_preprocess = proto_perl->Ipreprocess;
11416 PL_minus_n = proto_perl->Iminus_n;
11417 PL_minus_p = proto_perl->Iminus_p;
11418 PL_minus_l = proto_perl->Iminus_l;
11419 PL_minus_a = proto_perl->Iminus_a;
11420 PL_minus_F = proto_perl->Iminus_F;
11421 PL_doswitches = proto_perl->Idoswitches;
11422 PL_dowarn = proto_perl->Idowarn;
11423 PL_doextract = proto_perl->Idoextract;
11424 PL_sawampersand = proto_perl->Isawampersand;
11425 PL_unsafe = proto_perl->Iunsafe;
11426 PL_inplace = SAVEPV(proto_perl->Iinplace);
11427 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11428 PL_perldb = proto_perl->Iperldb;
11429 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11430 PL_exit_flags = proto_perl->Iexit_flags;
11432 /* magical thingies */
11433 /* XXX time(&PL_basetime) when asked for? */
11434 PL_basetime = proto_perl->Ibasetime;
11435 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11437 PL_maxsysfd = proto_perl->Imaxsysfd;
11438 PL_multiline = proto_perl->Imultiline;
11439 PL_statusvalue = proto_perl->Istatusvalue;
11441 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11443 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11445 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11446 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11447 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11449 /* Clone the regex array */
11450 PL_regex_padav = newAV();
11452 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11453 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11455 av_push(PL_regex_padav,
11456 sv_dup_inc(regexen[0],param));
11457 for(i = 1; i <= len; i++) {
11458 if(SvREPADTMP(regexen[i])) {
11459 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11461 av_push(PL_regex_padav,
11463 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11464 SvIVX(regexen[i])), param)))
11469 PL_regex_pad = AvARRAY(PL_regex_padav);
11471 /* shortcuts to various I/O objects */
11472 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11473 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11474 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11475 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11476 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11477 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11479 /* shortcuts to regexp stuff */
11480 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11482 /* shortcuts to misc objects */
11483 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11485 /* shortcuts to debugging objects */
11486 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11487 PL_DBline = gv_dup(proto_perl->IDBline, param);
11488 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11489 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11490 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11491 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11492 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11493 PL_lineary = av_dup(proto_perl->Ilineary, param);
11494 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11496 /* symbol tables */
11497 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11498 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11499 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11500 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11501 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11503 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11504 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11505 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11506 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11507 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11508 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11510 PL_sub_generation = proto_perl->Isub_generation;
11512 /* funky return mechanisms */
11513 PL_forkprocess = proto_perl->Iforkprocess;
11515 /* subprocess state */
11516 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11518 /* internal state */
11519 PL_tainting = proto_perl->Itainting;
11520 PL_taint_warn = proto_perl->Itaint_warn;
11521 PL_maxo = proto_perl->Imaxo;
11522 if (proto_perl->Iop_mask)
11523 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11525 PL_op_mask = Nullch;
11526 /* PL_asserting = proto_perl->Iasserting; */
11528 /* current interpreter roots */
11529 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11530 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11531 PL_main_start = proto_perl->Imain_start;
11532 PL_eval_root = proto_perl->Ieval_root;
11533 PL_eval_start = proto_perl->Ieval_start;
11535 /* runtime control stuff */
11536 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11537 PL_copline = proto_perl->Icopline;
11539 PL_filemode = proto_perl->Ifilemode;
11540 PL_lastfd = proto_perl->Ilastfd;
11541 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11544 PL_gensym = proto_perl->Igensym;
11545 PL_preambled = proto_perl->Ipreambled;
11546 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11547 PL_laststatval = proto_perl->Ilaststatval;
11548 PL_laststype = proto_perl->Ilaststype;
11549 PL_mess_sv = Nullsv;
11551 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11552 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11554 /* interpreter atexit processing */
11555 PL_exitlistlen = proto_perl->Iexitlistlen;
11556 if (PL_exitlistlen) {
11557 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11558 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11561 PL_exitlist = (PerlExitListEntry*)NULL;
11562 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11563 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11564 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11566 PL_profiledata = NULL;
11567 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11568 /* PL_rsfp_filters entries have fake IoDIRP() */
11569 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11571 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11573 PAD_CLONE_VARS(proto_perl, param);
11575 #ifdef HAVE_INTERP_INTERN
11576 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11579 /* more statics moved here */
11580 PL_generation = proto_perl->Igeneration;
11581 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11583 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11584 PL_in_clean_all = proto_perl->Iin_clean_all;
11586 PL_uid = proto_perl->Iuid;
11587 PL_euid = proto_perl->Ieuid;
11588 PL_gid = proto_perl->Igid;
11589 PL_egid = proto_perl->Iegid;
11590 PL_nomemok = proto_perl->Inomemok;
11591 PL_an = proto_perl->Ian;
11592 PL_evalseq = proto_perl->Ievalseq;
11593 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11594 PL_origalen = proto_perl->Iorigalen;
11595 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11596 PL_osname = SAVEPV(proto_perl->Iosname);
11597 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11598 PL_sighandlerp = proto_perl->Isighandlerp;
11601 PL_runops = proto_perl->Irunops;
11603 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11606 PL_cshlen = proto_perl->Icshlen;
11607 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11610 PL_lex_state = proto_perl->Ilex_state;
11611 PL_lex_defer = proto_perl->Ilex_defer;
11612 PL_lex_expect = proto_perl->Ilex_expect;
11613 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11614 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11615 PL_lex_starts = proto_perl->Ilex_starts;
11616 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11617 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11618 PL_lex_op = proto_perl->Ilex_op;
11619 PL_lex_inpat = proto_perl->Ilex_inpat;
11620 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11621 PL_lex_brackets = proto_perl->Ilex_brackets;
11622 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11623 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11624 PL_lex_casemods = proto_perl->Ilex_casemods;
11625 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11626 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11628 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11629 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11630 PL_nexttoke = proto_perl->Inexttoke;
11632 /* XXX This is probably masking the deeper issue of why
11633 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11634 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11635 * (A little debugging with a watchpoint on it may help.)
11637 if (SvANY(proto_perl->Ilinestr)) {
11638 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11639 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11640 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11641 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11642 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11643 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11644 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11645 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11646 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11649 PL_linestr = NEWSV(65,79);
11650 sv_upgrade(PL_linestr,SVt_PVIV);
11651 sv_setpvn(PL_linestr,"",0);
11652 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11654 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11655 PL_pending_ident = proto_perl->Ipending_ident;
11656 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11658 PL_expect = proto_perl->Iexpect;
11660 PL_multi_start = proto_perl->Imulti_start;
11661 PL_multi_end = proto_perl->Imulti_end;
11662 PL_multi_open = proto_perl->Imulti_open;
11663 PL_multi_close = proto_perl->Imulti_close;
11665 PL_error_count = proto_perl->Ierror_count;
11666 PL_subline = proto_perl->Isubline;
11667 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11669 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11670 if (SvANY(proto_perl->Ilinestr)) {
11671 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11672 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11673 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11674 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11675 PL_last_lop_op = proto_perl->Ilast_lop_op;
11678 PL_last_uni = SvPVX(PL_linestr);
11679 PL_last_lop = SvPVX(PL_linestr);
11680 PL_last_lop_op = 0;
11682 PL_in_my = proto_perl->Iin_my;
11683 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11685 PL_cryptseen = proto_perl->Icryptseen;
11688 PL_hints = proto_perl->Ihints;
11690 PL_amagic_generation = proto_perl->Iamagic_generation;
11692 #ifdef USE_LOCALE_COLLATE
11693 PL_collation_ix = proto_perl->Icollation_ix;
11694 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11695 PL_collation_standard = proto_perl->Icollation_standard;
11696 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11697 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11698 #endif /* USE_LOCALE_COLLATE */
11700 #ifdef USE_LOCALE_NUMERIC
11701 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11702 PL_numeric_standard = proto_perl->Inumeric_standard;
11703 PL_numeric_local = proto_perl->Inumeric_local;
11704 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11705 #endif /* !USE_LOCALE_NUMERIC */
11707 /* utf8 character classes */
11708 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11709 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11710 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11711 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11712 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11713 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11714 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11715 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11716 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11717 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11718 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11719 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11720 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11721 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11722 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11723 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11724 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11725 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11726 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11727 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11729 /* Did the locale setup indicate UTF-8? */
11730 PL_utf8locale = proto_perl->Iutf8locale;
11731 /* Unicode features (see perlrun/-C) */
11732 PL_unicode = proto_perl->Iunicode;
11734 /* Pre-5.8 signals control */
11735 PL_signals = proto_perl->Isignals;
11737 /* times() ticks per second */
11738 PL_clocktick = proto_perl->Iclocktick;
11740 /* Recursion stopper for PerlIO_find_layer */
11741 PL_in_load_module = proto_perl->Iin_load_module;
11743 /* sort() routine */
11744 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11746 /* Not really needed/useful since the reenrant_retint is "volatile",
11747 * but do it for consistency's sake. */
11748 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11750 /* Hooks to shared SVs and locks. */
11751 PL_sharehook = proto_perl->Isharehook;
11752 PL_lockhook = proto_perl->Ilockhook;
11753 PL_unlockhook = proto_perl->Iunlockhook;
11754 PL_threadhook = proto_perl->Ithreadhook;
11756 PL_runops_std = proto_perl->Irunops_std;
11757 PL_runops_dbg = proto_perl->Irunops_dbg;
11759 #ifdef THREADS_HAVE_PIDS
11760 PL_ppid = proto_perl->Ippid;
11764 PL_last_swash_hv = Nullhv; /* reinits on demand */
11765 PL_last_swash_klen = 0;
11766 PL_last_swash_key[0]= '\0';
11767 PL_last_swash_tmps = (U8*)NULL;
11768 PL_last_swash_slen = 0;
11770 PL_glob_index = proto_perl->Iglob_index;
11771 PL_srand_called = proto_perl->Isrand_called;
11772 PL_uudmap['M'] = 0; /* reinits on demand */
11773 PL_bitcount = Nullch; /* reinits on demand */
11775 if (proto_perl->Ipsig_pend) {
11776 Newz(0, PL_psig_pend, SIG_SIZE, int);
11779 PL_psig_pend = (int*)NULL;
11782 if (proto_perl->Ipsig_ptr) {
11783 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11784 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11785 for (i = 1; i < SIG_SIZE; i++) {
11786 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11787 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11791 PL_psig_ptr = (SV**)NULL;
11792 PL_psig_name = (SV**)NULL;
11795 /* thrdvar.h stuff */
11797 if (flags & CLONEf_COPY_STACKS) {
11798 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11799 PL_tmps_ix = proto_perl->Ttmps_ix;
11800 PL_tmps_max = proto_perl->Ttmps_max;
11801 PL_tmps_floor = proto_perl->Ttmps_floor;
11802 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11804 while (i <= PL_tmps_ix) {
11805 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11809 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11810 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11811 Newz(54, PL_markstack, i, I32);
11812 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11813 - proto_perl->Tmarkstack);
11814 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11815 - proto_perl->Tmarkstack);
11816 Copy(proto_perl->Tmarkstack, PL_markstack,
11817 PL_markstack_ptr - PL_markstack + 1, I32);
11819 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11820 * NOTE: unlike the others! */
11821 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11822 PL_scopestack_max = proto_perl->Tscopestack_max;
11823 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11824 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11826 /* NOTE: si_dup() looks at PL_markstack */
11827 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11829 /* PL_curstack = PL_curstackinfo->si_stack; */
11830 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11831 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11833 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11834 PL_stack_base = AvARRAY(PL_curstack);
11835 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11836 - proto_perl->Tstack_base);
11837 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11839 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11840 * NOTE: unlike the others! */
11841 PL_savestack_ix = proto_perl->Tsavestack_ix;
11842 PL_savestack_max = proto_perl->Tsavestack_max;
11843 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11844 PL_savestack = ss_dup(proto_perl, param);
11848 ENTER; /* perl_destruct() wants to LEAVE; */
11851 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11852 PL_top_env = &PL_start_env;
11854 PL_op = proto_perl->Top;
11857 PL_Xpv = (XPV*)NULL;
11858 PL_na = proto_perl->Tna;
11860 PL_statbuf = proto_perl->Tstatbuf;
11861 PL_statcache = proto_perl->Tstatcache;
11862 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11863 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11865 PL_timesbuf = proto_perl->Ttimesbuf;
11868 PL_tainted = proto_perl->Ttainted;
11869 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11870 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11871 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11872 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11873 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11874 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11875 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11876 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11877 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11879 PL_restartop = proto_perl->Trestartop;
11880 PL_in_eval = proto_perl->Tin_eval;
11881 PL_delaymagic = proto_perl->Tdelaymagic;
11882 PL_dirty = proto_perl->Tdirty;
11883 PL_localizing = proto_perl->Tlocalizing;
11885 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11886 PL_hv_fetch_ent_mh = Nullhe;
11887 PL_modcount = proto_perl->Tmodcount;
11888 PL_lastgotoprobe = Nullop;
11889 PL_dumpindent = proto_perl->Tdumpindent;
11891 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11892 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11893 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11894 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11895 PL_sortcxix = proto_perl->Tsortcxix;
11896 PL_efloatbuf = Nullch; /* reinits on demand */
11897 PL_efloatsize = 0; /* reinits on demand */
11901 PL_screamfirst = NULL;
11902 PL_screamnext = NULL;
11903 PL_maxscream = -1; /* reinits on demand */
11904 PL_lastscream = Nullsv;
11906 PL_watchaddr = NULL;
11907 PL_watchok = Nullch;
11909 PL_regdummy = proto_perl->Tregdummy;
11910 PL_regprecomp = Nullch;
11913 PL_colorset = 0; /* reinits PL_colors[] */
11914 /*PL_colors[6] = {0,0,0,0,0,0};*/
11915 PL_reginput = Nullch;
11916 PL_regbol = Nullch;
11917 PL_regeol = Nullch;
11918 PL_regstartp = (I32*)NULL;
11919 PL_regendp = (I32*)NULL;
11920 PL_reglastparen = (U32*)NULL;
11921 PL_reglastcloseparen = (U32*)NULL;
11922 PL_regtill = Nullch;
11923 PL_reg_start_tmp = (char**)NULL;
11924 PL_reg_start_tmpl = 0;
11925 PL_regdata = (struct reg_data*)NULL;
11928 PL_reg_eval_set = 0;
11930 PL_regprogram = (regnode*)NULL;
11932 PL_regcc = (CURCUR*)NULL;
11933 PL_reg_call_cc = (struct re_cc_state*)NULL;
11934 PL_reg_re = (regexp*)NULL;
11935 PL_reg_ganch = Nullch;
11936 PL_reg_sv = Nullsv;
11937 PL_reg_match_utf8 = FALSE;
11938 PL_reg_magic = (MAGIC*)NULL;
11940 PL_reg_oldcurpm = (PMOP*)NULL;
11941 PL_reg_curpm = (PMOP*)NULL;
11942 PL_reg_oldsaved = Nullch;
11943 PL_reg_oldsavedlen = 0;
11944 #ifdef PERL_OLD_COPY_ON_WRITE
11947 PL_reg_maxiter = 0;
11948 PL_reg_leftiter = 0;
11949 PL_reg_poscache = Nullch;
11950 PL_reg_poscache_size= 0;
11952 /* RE engine - function pointers */
11953 PL_regcompp = proto_perl->Tregcompp;
11954 PL_regexecp = proto_perl->Tregexecp;
11955 PL_regint_start = proto_perl->Tregint_start;
11956 PL_regint_string = proto_perl->Tregint_string;
11957 PL_regfree = proto_perl->Tregfree;
11959 PL_reginterp_cnt = 0;
11960 PL_reg_starttry = 0;
11962 /* Pluggable optimizer */
11963 PL_peepp = proto_perl->Tpeepp;
11965 PL_stashcache = newHV();
11967 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11968 ptr_table_free(PL_ptr_table);
11969 PL_ptr_table = NULL;
11972 /* Call the ->CLONE method, if it exists, for each of the stashes
11973 identified by sv_dup() above.
11975 while(av_len(param->stashes) != -1) {
11976 HV* stash = (HV*) av_shift(param->stashes);
11977 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11978 if (cloner && GvCV(cloner)) {
11983 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11985 call_sv((SV*)GvCV(cloner), G_DISCARD);
11991 SvREFCNT_dec(param->stashes);
11993 /* orphaned? eg threads->new inside BEGIN or use */
11994 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11995 (void)SvREFCNT_inc(PL_compcv);
11996 SAVEFREESV(PL_compcv);
12002 #endif /* USE_ITHREADS */
12005 =head1 Unicode Support
12007 =for apidoc sv_recode_to_utf8
12009 The encoding is assumed to be an Encode object, on entry the PV
12010 of the sv is assumed to be octets in that encoding, and the sv
12011 will be converted into Unicode (and UTF-8).
12013 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12014 is not a reference, nothing is done to the sv. If the encoding is not
12015 an C<Encode::XS> Encoding object, bad things will happen.
12016 (See F<lib/encoding.pm> and L<Encode>).
12018 The PV of the sv is returned.
12023 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12026 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12040 Passing sv_yes is wrong - it needs to be or'ed set of constants
12041 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12042 remove converted chars from source.
12044 Both will default the value - let them.
12046 XPUSHs(&PL_sv_yes);
12049 call_method("decode", G_SCALAR);
12053 s = SvPV_const(uni, len);
12054 if (s != SvPVX_const(sv)) {
12055 SvGROW(sv, len + 1);
12056 Move(s, SvPVX(sv), len + 1, char);
12057 SvCUR_set(sv, len);
12064 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12068 =for apidoc sv_cat_decode
12070 The encoding is assumed to be an Encode object, the PV of the ssv is
12071 assumed to be octets in that encoding and decoding the input starts
12072 from the position which (PV + *offset) pointed to. The dsv will be
12073 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12074 when the string tstr appears in decoding output or the input ends on
12075 the PV of the ssv. The value which the offset points will be modified
12076 to the last input position on the ssv.
12078 Returns TRUE if the terminator was found, else returns FALSE.
12083 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12084 SV *ssv, int *offset, char *tstr, int tlen)
12088 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12099 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12100 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12102 call_method("cat_decode", G_SCALAR);
12104 ret = SvTRUE(TOPs);
12105 *offset = SvIV(offsv);
12111 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12117 * c-indentation-style: bsd
12118 * c-basic-offset: 4
12119 * indent-tabs-mode: t
12122 * ex: set ts=8 sts=4 sw=4 noet: