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_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(sv));
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
773 pv_display(sv,SvPVX(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();
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(varname) : "",
1121 " in ", OP_DESC(PL_op));
1124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1128 /* allocate another arena's worth of NV bodies */
1136 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1137 *((void **) ptr) = (void *)PL_xnv_arenaroot;
1138 PL_xnv_arenaroot = ptr;
1141 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1142 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1144 while (xnv < xnvend) {
1145 *(NV**)xnv = (NV*)(xnv + 1);
1151 /* allocate another arena's worth of struct xpv */
1157 xpv_allocated* xpvend;
1158 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1159 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
1160 PL_xpv_arenaroot = xpv;
1162 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
1163 PL_xpv_root = ++xpv;
1164 while (xpv < xpvend) {
1165 *((xpv_allocated**)xpv) = xpv + 1;
1168 *((xpv_allocated**)xpv) = 0;
1171 /* allocate another arena's worth of struct xpviv */
1176 xpviv_allocated* xpviv;
1177 xpviv_allocated* xpvivend;
1178 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1179 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
1180 PL_xpviv_arenaroot = xpviv;
1182 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
1183 PL_xpviv_root = ++xpviv;
1184 while (xpviv < xpvivend) {
1185 *((xpviv_allocated**)xpviv) = xpviv + 1;
1188 *((xpviv_allocated**)xpviv) = 0;
1191 /* allocate another arena's worth of struct xpvnv */
1198 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1199 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
1200 PL_xpvnv_arenaroot = xpvnv;
1202 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1203 PL_xpvnv_root = ++xpvnv;
1204 while (xpvnv < xpvnvend) {
1205 *((XPVNV**)xpvnv) = xpvnv + 1;
1208 *((XPVNV**)xpvnv) = 0;
1211 /* allocate another arena's worth of struct xpvcv */
1218 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1219 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
1220 PL_xpvcv_arenaroot = xpvcv;
1222 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1223 PL_xpvcv_root = ++xpvcv;
1224 while (xpvcv < xpvcvend) {
1225 *((XPVCV**)xpvcv) = xpvcv + 1;
1228 *((XPVCV**)xpvcv) = 0;
1231 /* allocate another arena's worth of struct xpvav */
1236 xpvav_allocated* xpvav;
1237 xpvav_allocated* xpvavend;
1238 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1240 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
1241 PL_xpvav_arenaroot = xpvav;
1243 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
1244 PL_xpvav_root = ++xpvav;
1245 while (xpvav < xpvavend) {
1246 *((xpvav_allocated**)xpvav) = xpvav + 1;
1249 *((xpvav_allocated**)xpvav) = 0;
1252 /* allocate another arena's worth of struct xpvhv */
1257 xpvhv_allocated* xpvhv;
1258 xpvhv_allocated* xpvhvend;
1259 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1261 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
1262 PL_xpvhv_arenaroot = xpvhv;
1264 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
1265 PL_xpvhv_root = ++xpvhv;
1266 while (xpvhv < xpvhvend) {
1267 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
1270 *((xpvhv_allocated**)xpvhv) = 0;
1273 /* allocate another arena's worth of struct xpvmg */
1280 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1281 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1282 PL_xpvmg_arenaroot = xpvmg;
1284 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1285 PL_xpvmg_root = ++xpvmg;
1286 while (xpvmg < xpvmgend) {
1287 *((XPVMG**)xpvmg) = xpvmg + 1;
1290 *((XPVMG**)xpvmg) = 0;
1293 /* allocate another arena's worth of struct xpvgv */
1300 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1301 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1302 PL_xpvgv_arenaroot = xpvgv;
1304 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1305 PL_xpvgv_root = ++xpvgv;
1306 while (xpvgv < xpvgvend) {
1307 *((XPVGV**)xpvgv) = xpvgv + 1;
1310 *((XPVGV**)xpvgv) = 0;
1313 /* allocate another arena's worth of struct xpvlv */
1320 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1321 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1322 PL_xpvlv_arenaroot = xpvlv;
1324 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1325 PL_xpvlv_root = ++xpvlv;
1326 while (xpvlv < xpvlvend) {
1327 *((XPVLV**)xpvlv) = xpvlv + 1;
1330 *((XPVLV**)xpvlv) = 0;
1333 /* allocate another arena's worth of struct xpvbm */
1340 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1341 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1342 PL_xpvbm_arenaroot = xpvbm;
1344 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1345 PL_xpvbm_root = ++xpvbm;
1346 while (xpvbm < xpvbmend) {
1347 *((XPVBM**)xpvbm) = xpvbm + 1;
1350 *((XPVBM**)xpvbm) = 0;
1353 /* grab a new NV body from the free list, allocating more if necessary */
1363 PL_xnv_root = *(NV**)xnv;
1365 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1368 /* return an NV body to the free list */
1371 S_del_xnv(pTHX_ XPVNV *p)
1373 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1375 *(NV**)xnv = PL_xnv_root;
1380 /* grab a new struct xpv from the free list, allocating more if necessary */
1390 PL_xpv_root = *(xpv_allocated**)xpv;
1392 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1393 sum to zero, and the pointer is unchanged. If the allocated structure
1394 is smaller (no initial IV actually allocated) then the net effect is
1395 to subtract the size of the IV from the pointer, to return a new pointer
1396 as if an initial IV were actually allocated. */
1397 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1398 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
1401 /* return a struct xpv to the free list */
1404 S_del_xpv(pTHX_ XPV *p)
1407 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1408 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
1410 *(xpv_allocated**)xpv = PL_xpv_root;
1415 /* grab a new struct xpviv from the free list, allocating more if necessary */
1420 xpviv_allocated* xpviv;
1424 xpviv = PL_xpviv_root;
1425 PL_xpviv_root = *(xpviv_allocated**)xpviv;
1427 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1428 sum to zero, and the pointer is unchanged. If the allocated structure
1429 is smaller (no initial IV actually allocated) then the net effect is
1430 to subtract the size of the IV from the pointer, to return a new pointer
1431 as if an initial IV were actually allocated. */
1432 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1433 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1436 /* return a struct xpviv to the free list */
1439 S_del_xpviv(pTHX_ XPVIV *p)
1441 xpviv_allocated* xpviv
1442 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1443 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1445 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1446 PL_xpviv_root = xpviv;
1450 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1459 xpvnv = PL_xpvnv_root;
1460 PL_xpvnv_root = *(XPVNV**)xpvnv;
1465 /* return a struct xpvnv to the free list */
1468 S_del_xpvnv(pTHX_ XPVNV *p)
1471 *(XPVNV**)p = PL_xpvnv_root;
1476 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1485 xpvcv = PL_xpvcv_root;
1486 PL_xpvcv_root = *(XPVCV**)xpvcv;
1491 /* return a struct xpvcv to the free list */
1494 S_del_xpvcv(pTHX_ XPVCV *p)
1497 *(XPVCV**)p = PL_xpvcv_root;
1502 /* grab a new struct xpvav from the free list, allocating more if necessary */
1507 xpvav_allocated* xpvav;
1511 xpvav = PL_xpvav_root;
1512 PL_xpvav_root = *(xpvav_allocated**)xpvav;
1514 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1515 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
1518 /* return a struct xpvav to the free list */
1521 S_del_xpvav(pTHX_ XPVAV *p)
1523 xpvav_allocated* xpvav
1524 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1525 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
1527 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1528 PL_xpvav_root = xpvav;
1532 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1537 xpvhv_allocated* xpvhv;
1541 xpvhv = PL_xpvhv_root;
1542 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
1544 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1545 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1548 /* return a struct xpvhv to the free list */
1551 S_del_xpvhv(pTHX_ XPVHV *p)
1553 xpvhv_allocated* xpvhv
1554 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1555 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1557 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1558 PL_xpvhv_root = xpvhv;
1562 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1571 xpvmg = PL_xpvmg_root;
1572 PL_xpvmg_root = *(XPVMG**)xpvmg;
1577 /* return a struct xpvmg to the free list */
1580 S_del_xpvmg(pTHX_ XPVMG *p)
1583 *(XPVMG**)p = PL_xpvmg_root;
1588 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1597 xpvgv = PL_xpvgv_root;
1598 PL_xpvgv_root = *(XPVGV**)xpvgv;
1603 /* return a struct xpvgv to the free list */
1606 S_del_xpvgv(pTHX_ XPVGV *p)
1609 *(XPVGV**)p = PL_xpvgv_root;
1614 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1623 xpvlv = PL_xpvlv_root;
1624 PL_xpvlv_root = *(XPVLV**)xpvlv;
1629 /* return a struct xpvlv to the free list */
1632 S_del_xpvlv(pTHX_ XPVLV *p)
1635 *(XPVLV**)p = PL_xpvlv_root;
1640 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1649 xpvbm = PL_xpvbm_root;
1650 PL_xpvbm_root = *(XPVBM**)xpvbm;
1655 /* return a struct xpvbm to the free list */
1658 S_del_xpvbm(pTHX_ XPVBM *p)
1661 *(XPVBM**)p = PL_xpvbm_root;
1666 #define my_safemalloc(s) (void*)safemalloc(s)
1667 #define my_safefree(p) safefree((char*)p)
1671 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1672 #define del_XNV(p) my_safefree(p)
1674 #define new_XPV() my_safemalloc(sizeof(XPV))
1675 #define del_XPV(p) my_safefree(p)
1677 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1678 #define del_XPVIV(p) my_safefree(p)
1680 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1681 #define del_XPVNV(p) my_safefree(p)
1683 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1684 #define del_XPVCV(p) my_safefree(p)
1686 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1687 #define del_XPVAV(p) my_safefree(p)
1689 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1690 #define del_XPVHV(p) my_safefree(p)
1692 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1693 #define del_XPVMG(p) my_safefree(p)
1695 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1696 #define del_XPVGV(p) my_safefree(p)
1698 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1699 #define del_XPVLV(p) my_safefree(p)
1701 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1702 #define del_XPVBM(p) my_safefree(p)
1706 #define new_XNV() (void*)new_xnv()
1707 #define del_XNV(p) del_xnv((XPVNV*) p)
1709 #define new_XPV() (void*)new_xpv()
1710 #define del_XPV(p) del_xpv((XPV *)p)
1712 #define new_XPVIV() (void*)new_xpviv()
1713 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1715 #define new_XPVNV() (void*)new_xpvnv()
1716 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1718 #define new_XPVCV() (void*)new_xpvcv()
1719 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1721 #define new_XPVAV() (void*)new_xpvav()
1722 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1724 #define new_XPVHV() (void*)new_xpvhv()
1725 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1727 #define new_XPVMG() (void*)new_xpvmg()
1728 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1730 #define new_XPVGV() (void*)new_xpvgv()
1731 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1733 #define new_XPVLV() (void*)new_xpvlv()
1734 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1736 #define new_XPVBM() (void*)new_xpvbm()
1737 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1741 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1742 #define del_XPVFM(p) my_safefree(p)
1744 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1745 #define del_XPVIO(p) my_safefree(p)
1748 =for apidoc sv_upgrade
1750 Upgrade an SV to a more complex form. Generally adds a new body type to the
1751 SV, then copies across as much information as possible from the old body.
1752 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1758 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1769 if (mt != SVt_PV && SvIsCOW(sv)) {
1770 sv_force_normal_flags(sv, 0);
1773 if (SvTYPE(sv) == mt)
1784 switch (SvTYPE(sv)) {
1791 else if (mt < SVt_PVIV)
1801 pv = (char*)SvRV(sv);
1810 else if (mt == SVt_NV)
1818 del_XPVIV(SvANY(sv));
1826 del_XPVNV(SvANY(sv));
1829 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1830 there's no way that it can be safely upgraded, because perl.c
1831 expects to Safefree(SvANY(PL_mess_sv)) */
1832 assert(sv != PL_mess_sv);
1833 /* This flag bit is used to mean other things in other scalar types.
1834 Given that it only has meaning inside the pad, it shouldn't be set
1835 on anything that can get upgraded. */
1836 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1842 magic = SvMAGIC(sv);
1843 stash = SvSTASH(sv);
1844 del_XPVMG(SvANY(sv));
1847 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1850 SvFLAGS(sv) &= ~SVTYPEMASK;
1855 Perl_croak(aTHX_ "Can't upgrade to undef");
1857 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1861 SvANY(sv) = new_XNV();
1865 SvANY(sv) = &sv->sv_u.svu_rv;
1866 SvRV_set(sv, (SV*)pv);
1869 SvANY(sv) = new_XPVHV();
1872 HvTOTALKEYS(sv) = 0;
1874 /* Fall through... */
1877 SvANY(sv) = new_XPVAV();
1884 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1886 /* FIXME. Should be able to remove all this if()... if the above
1887 assertion is genuinely always true. */
1890 SvFLAGS(sv) &= ~SVf_OOK;
1893 SvPV_set(sv, (char*)0);
1894 SvMAGIC_set(sv, magic);
1895 SvSTASH_set(sv, stash);
1899 SvANY(sv) = new_XPVIO();
1900 Zero(SvANY(sv), 1, XPVIO);
1901 IoPAGE_LEN(sv) = 60;
1902 goto set_magic_common;
1904 SvANY(sv) = new_XPVFM();
1905 Zero(SvANY(sv), 1, XPVFM);
1906 goto set_magic_common;
1908 SvANY(sv) = new_XPVBM();
1912 goto set_magic_common;
1914 SvANY(sv) = new_XPVGV();
1920 goto set_magic_common;
1922 SvANY(sv) = new_XPVCV();
1923 Zero(SvANY(sv), 1, XPVCV);
1924 goto set_magic_common;
1926 SvANY(sv) = new_XPVLV();
1939 SvANY(sv) = new_XPVMG();
1942 SvMAGIC_set(sv, magic);
1943 SvSTASH_set(sv, stash);
1947 SvANY(sv) = new_XPVNV();
1953 SvANY(sv) = new_XPVIV();
1962 SvANY(sv) = new_XPV();
1973 =for apidoc sv_backoff
1975 Remove any string offset. You should normally use the C<SvOOK_off> macro
1982 Perl_sv_backoff(pTHX_ register SV *sv)
1985 assert(SvTYPE(sv) != SVt_PVHV);
1986 assert(SvTYPE(sv) != SVt_PVAV);
1988 char *s = SvPVX(sv);
1989 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1990 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1992 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1994 SvFLAGS(sv) &= ~SVf_OOK;
2001 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2002 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2003 Use the C<SvGROW> wrapper instead.
2009 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2013 #ifdef HAS_64K_LIMIT
2014 if (newlen >= 0x10000) {
2015 PerlIO_printf(Perl_debug_log,
2016 "Allocation too large: %"UVxf"\n", (UV)newlen);
2019 #endif /* HAS_64K_LIMIT */
2022 if (SvTYPE(sv) < SVt_PV) {
2023 sv_upgrade(sv, SVt_PV);
2026 else if (SvOOK(sv)) { /* pv is offset? */
2029 if (newlen > SvLEN(sv))
2030 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2031 #ifdef HAS_64K_LIMIT
2032 if (newlen >= 0x10000)
2039 if (newlen > SvLEN(sv)) { /* need more room? */
2040 if (SvLEN(sv) && s) {
2041 newlen = PERL_STRLEN_ROUNDUP(newlen);
2043 const STRLEN l = malloced_size((void*)SvPVX(sv));
2049 s = saferealloc(s, newlen);
2052 newlen = PERL_STRLEN_ROUNDUP(newlen);
2053 s = safemalloc(newlen);
2054 if (SvPVX(sv) && SvCUR(sv)) {
2055 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2059 SvLEN_set(sv, newlen);
2065 =for apidoc sv_setiv
2067 Copies an integer into the given SV, upgrading first if necessary.
2068 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2074 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2076 SV_CHECK_THINKFIRST_COW_DROP(sv);
2077 switch (SvTYPE(sv)) {
2079 sv_upgrade(sv, SVt_IV);
2082 sv_upgrade(sv, SVt_PVNV);
2086 sv_upgrade(sv, SVt_PVIV);
2095 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2098 (void)SvIOK_only(sv); /* validate number */
2104 =for apidoc sv_setiv_mg
2106 Like C<sv_setiv>, but also handles 'set' magic.
2112 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2119 =for apidoc sv_setuv
2121 Copies an unsigned integer into the given SV, upgrading first if necessary.
2122 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2128 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2130 /* With these two if statements:
2131 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2134 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2136 If you wish to remove them, please benchmark to see what the effect is
2138 if (u <= (UV)IV_MAX) {
2139 sv_setiv(sv, (IV)u);
2148 =for apidoc sv_setuv_mg
2150 Like C<sv_setuv>, but also handles 'set' magic.
2156 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2158 /* With these two if statements:
2159 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2162 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2164 If you wish to remove them, please benchmark to see what the effect is
2166 if (u <= (UV)IV_MAX) {
2167 sv_setiv(sv, (IV)u);
2177 =for apidoc sv_setnv
2179 Copies a double into the given SV, upgrading first if necessary.
2180 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2186 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2188 SV_CHECK_THINKFIRST_COW_DROP(sv);
2189 switch (SvTYPE(sv)) {
2192 sv_upgrade(sv, SVt_NV);
2197 sv_upgrade(sv, SVt_PVNV);
2206 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2210 (void)SvNOK_only(sv); /* validate number */
2215 =for apidoc sv_setnv_mg
2217 Like C<sv_setnv>, but also handles 'set' magic.
2223 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2229 /* Print an "isn't numeric" warning, using a cleaned-up,
2230 * printable version of the offending string
2234 S_not_a_number(pTHX_ SV *sv)
2241 dsv = sv_2mortal(newSVpv("", 0));
2242 pv = sv_uni_display(dsv, sv, 10, 0);
2245 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2246 /* each *s can expand to 4 chars + "...\0",
2247 i.e. need room for 8 chars */
2250 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2252 if (ch & 128 && !isPRINT_LC(ch)) {
2261 else if (ch == '\r') {
2265 else if (ch == '\f') {
2269 else if (ch == '\\') {
2273 else if (ch == '\0') {
2277 else if (isPRINT_LC(ch))
2294 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2295 "Argument \"%s\" isn't numeric in %s", pv,
2298 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2299 "Argument \"%s\" isn't numeric", pv);
2303 =for apidoc looks_like_number
2305 Test if the content of an SV looks like a number (or is a number).
2306 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2307 non-numeric warning), even if your atof() doesn't grok them.
2313 Perl_looks_like_number(pTHX_ SV *sv)
2315 register const char *sbegin;
2322 else if (SvPOKp(sv))
2323 sbegin = SvPV(sv, len);
2325 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2326 return grok_number(sbegin, len, NULL);
2329 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2330 until proven guilty, assume that things are not that bad... */
2335 As 64 bit platforms often have an NV that doesn't preserve all bits of
2336 an IV (an assumption perl has been based on to date) it becomes necessary
2337 to remove the assumption that the NV always carries enough precision to
2338 recreate the IV whenever needed, and that the NV is the canonical form.
2339 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2340 precision as a side effect of conversion (which would lead to insanity
2341 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2342 1) to distinguish between IV/UV/NV slots that have cached a valid
2343 conversion where precision was lost and IV/UV/NV slots that have a
2344 valid conversion which has lost no precision
2345 2) to ensure that if a numeric conversion to one form is requested that
2346 would lose precision, the precise conversion (or differently
2347 imprecise conversion) is also performed and cached, to prevent
2348 requests for different numeric formats on the same SV causing
2349 lossy conversion chains. (lossless conversion chains are perfectly
2354 SvIOKp is true if the IV slot contains a valid value
2355 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2356 SvNOKp is true if the NV slot contains a valid value
2357 SvNOK is true only if the NV value is accurate
2360 while converting from PV to NV, check to see if converting that NV to an
2361 IV(or UV) would lose accuracy over a direct conversion from PV to
2362 IV(or UV). If it would, cache both conversions, return NV, but mark
2363 SV as IOK NOKp (ie not NOK).
2365 While converting from PV to IV, check to see if converting that IV to an
2366 NV would lose accuracy over a direct conversion from PV to NV. If it
2367 would, cache both conversions, flag similarly.
2369 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2370 correctly because if IV & NV were set NV *always* overruled.
2371 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2372 changes - now IV and NV together means that the two are interchangeable:
2373 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2375 The benefit of this is that operations such as pp_add know that if
2376 SvIOK is true for both left and right operands, then integer addition
2377 can be used instead of floating point (for cases where the result won't
2378 overflow). Before, floating point was always used, which could lead to
2379 loss of precision compared with integer addition.
2381 * making IV and NV equal status should make maths accurate on 64 bit
2383 * may speed up maths somewhat if pp_add and friends start to use
2384 integers when possible instead of fp. (Hopefully the overhead in
2385 looking for SvIOK and checking for overflow will not outweigh the
2386 fp to integer speedup)
2387 * will slow down integer operations (callers of SvIV) on "inaccurate"
2388 values, as the change from SvIOK to SvIOKp will cause a call into
2389 sv_2iv each time rather than a macro access direct to the IV slot
2390 * should speed up number->string conversion on integers as IV is
2391 favoured when IV and NV are equally accurate
2393 ####################################################################
2394 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2395 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2396 On the other hand, SvUOK is true iff UV.
2397 ####################################################################
2399 Your mileage will vary depending your CPU's relative fp to integer
2403 #ifndef NV_PRESERVES_UV
2404 # define IS_NUMBER_UNDERFLOW_IV 1
2405 # define IS_NUMBER_UNDERFLOW_UV 2
2406 # define IS_NUMBER_IV_AND_UV 2
2407 # define IS_NUMBER_OVERFLOW_IV 4
2408 # define IS_NUMBER_OVERFLOW_UV 5
2410 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2412 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2414 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2416 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2417 if (SvNVX(sv) < (NV)IV_MIN) {
2418 (void)SvIOKp_on(sv);
2420 SvIV_set(sv, IV_MIN);
2421 return IS_NUMBER_UNDERFLOW_IV;
2423 if (SvNVX(sv) > (NV)UV_MAX) {
2424 (void)SvIOKp_on(sv);
2427 SvUV_set(sv, UV_MAX);
2428 return IS_NUMBER_OVERFLOW_UV;
2430 (void)SvIOKp_on(sv);
2432 /* Can't use strtol etc to convert this string. (See truth table in
2434 if (SvNVX(sv) <= (UV)IV_MAX) {
2435 SvIV_set(sv, I_V(SvNVX(sv)));
2436 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2437 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2439 /* Integer is imprecise. NOK, IOKp */
2441 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2444 SvUV_set(sv, U_V(SvNVX(sv)));
2445 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2446 if (SvUVX(sv) == UV_MAX) {
2447 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2448 possibly be preserved by NV. Hence, it must be overflow.
2450 return IS_NUMBER_OVERFLOW_UV;
2452 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2454 /* Integer is imprecise. NOK, IOKp */
2456 return IS_NUMBER_OVERFLOW_IV;
2458 #endif /* !NV_PRESERVES_UV*/
2460 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2461 * this function provided for binary compatibility only
2465 Perl_sv_2iv(pTHX_ register SV *sv)
2467 return sv_2iv_flags(sv, SV_GMAGIC);
2471 =for apidoc sv_2iv_flags
2473 Return the integer value of an SV, doing any necessary string
2474 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2475 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2481 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2485 if (SvGMAGICAL(sv)) {
2486 if (flags & SV_GMAGIC)
2491 return I_V(SvNVX(sv));
2493 if (SvPOKp(sv) && SvLEN(sv))
2496 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2497 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2503 if (SvTHINKFIRST(sv)) {
2506 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2507 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2508 return SvIV(tmpstr);
2509 return PTR2IV(SvRV(sv));
2512 sv_force_normal_flags(sv, 0);
2514 if (SvREADONLY(sv) && !SvOK(sv)) {
2515 if (ckWARN(WARN_UNINITIALIZED))
2522 return (IV)(SvUVX(sv));
2529 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2530 * without also getting a cached IV/UV from it at the same time
2531 * (ie PV->NV conversion should detect loss of accuracy and cache
2532 * IV or UV at same time to avoid this. NWC */
2534 if (SvTYPE(sv) == SVt_NV)
2535 sv_upgrade(sv, SVt_PVNV);
2537 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2538 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2539 certainly cast into the IV range at IV_MAX, whereas the correct
2540 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2542 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2543 SvIV_set(sv, I_V(SvNVX(sv)));
2544 if (SvNVX(sv) == (NV) SvIVX(sv)
2545 #ifndef NV_PRESERVES_UV
2546 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2547 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2548 /* Don't flag it as "accurately an integer" if the number
2549 came from a (by definition imprecise) NV operation, and
2550 we're outside the range of NV integer precision */
2553 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2554 DEBUG_c(PerlIO_printf(Perl_debug_log,
2555 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2561 /* IV not precise. No need to convert from PV, as NV
2562 conversion would already have cached IV if it detected
2563 that PV->IV would be better than PV->NV->IV
2564 flags already correct - don't set public IOK. */
2565 DEBUG_c(PerlIO_printf(Perl_debug_log,
2566 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2571 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2572 but the cast (NV)IV_MIN rounds to a the value less (more
2573 negative) than IV_MIN which happens to be equal to SvNVX ??
2574 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2575 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2576 (NV)UVX == NVX are both true, but the values differ. :-(
2577 Hopefully for 2s complement IV_MIN is something like
2578 0x8000000000000000 which will be exact. NWC */
2581 SvUV_set(sv, U_V(SvNVX(sv)));
2583 (SvNVX(sv) == (NV) SvUVX(sv))
2584 #ifndef NV_PRESERVES_UV
2585 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2586 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2587 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2588 /* Don't flag it as "accurately an integer" if the number
2589 came from a (by definition imprecise) NV operation, and
2590 we're outside the range of NV integer precision */
2596 DEBUG_c(PerlIO_printf(Perl_debug_log,
2597 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2601 return (IV)SvUVX(sv);
2604 else if (SvPOKp(sv) && SvLEN(sv)) {
2606 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2607 /* We want to avoid a possible problem when we cache an IV which
2608 may be later translated to an NV, and the resulting NV is not
2609 the same as the direct translation of the initial string
2610 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2611 be careful to ensure that the value with the .456 is around if the
2612 NV value is requested in the future).
2614 This means that if we cache such an IV, we need to cache the
2615 NV as well. Moreover, we trade speed for space, and do not
2616 cache the NV if we are sure it's not needed.
2619 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2620 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2621 == IS_NUMBER_IN_UV) {
2622 /* It's definitely an integer, only upgrade to PVIV */
2623 if (SvTYPE(sv) < SVt_PVIV)
2624 sv_upgrade(sv, SVt_PVIV);
2626 } else if (SvTYPE(sv) < SVt_PVNV)
2627 sv_upgrade(sv, SVt_PVNV);
2629 /* If NV preserves UV then we only use the UV value if we know that
2630 we aren't going to call atof() below. If NVs don't preserve UVs
2631 then the value returned may have more precision than atof() will
2632 return, even though value isn't perfectly accurate. */
2633 if ((numtype & (IS_NUMBER_IN_UV
2634 #ifdef NV_PRESERVES_UV
2637 )) == IS_NUMBER_IN_UV) {
2638 /* This won't turn off the public IOK flag if it was set above */
2639 (void)SvIOKp_on(sv);
2641 if (!(numtype & IS_NUMBER_NEG)) {
2643 if (value <= (UV)IV_MAX) {
2644 SvIV_set(sv, (IV)value);
2646 SvUV_set(sv, value);
2650 /* 2s complement assumption */
2651 if (value <= (UV)IV_MIN) {
2652 SvIV_set(sv, -(IV)value);
2654 /* Too negative for an IV. This is a double upgrade, but
2655 I'm assuming it will be rare. */
2656 if (SvTYPE(sv) < SVt_PVNV)
2657 sv_upgrade(sv, SVt_PVNV);
2661 SvNV_set(sv, -(NV)value);
2662 SvIV_set(sv, IV_MIN);
2666 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2667 will be in the previous block to set the IV slot, and the next
2668 block to set the NV slot. So no else here. */
2670 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2671 != IS_NUMBER_IN_UV) {
2672 /* It wasn't an (integer that doesn't overflow the UV). */
2673 SvNV_set(sv, Atof(SvPVX(sv)));
2675 if (! numtype && ckWARN(WARN_NUMERIC))
2678 #if defined(USE_LONG_DOUBLE)
2679 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2680 PTR2UV(sv), SvNVX(sv)));
2682 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2683 PTR2UV(sv), SvNVX(sv)));
2687 #ifdef NV_PRESERVES_UV
2688 (void)SvIOKp_on(sv);
2690 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2691 SvIV_set(sv, I_V(SvNVX(sv)));
2692 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2695 /* Integer is imprecise. NOK, IOKp */
2697 /* UV will not work better than IV */
2699 if (SvNVX(sv) > (NV)UV_MAX) {
2701 /* Integer is inaccurate. NOK, IOKp, is UV */
2702 SvUV_set(sv, UV_MAX);
2705 SvUV_set(sv, U_V(SvNVX(sv)));
2706 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2707 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2711 /* Integer is imprecise. NOK, IOKp, is UV */
2717 #else /* NV_PRESERVES_UV */
2718 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2719 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2720 /* The IV slot will have been set from value returned by
2721 grok_number above. The NV slot has just been set using
2724 assert (SvIOKp(sv));
2726 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2727 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2728 /* Small enough to preserve all bits. */
2729 (void)SvIOKp_on(sv);
2731 SvIV_set(sv, I_V(SvNVX(sv)));
2732 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2734 /* Assumption: first non-preserved integer is < IV_MAX,
2735 this NV is in the preserved range, therefore: */
2736 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2738 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);
2742 0 0 already failed to read UV.
2743 0 1 already failed to read UV.
2744 1 0 you won't get here in this case. IV/UV
2745 slot set, public IOK, Atof() unneeded.
2746 1 1 already read UV.
2747 so there's no point in sv_2iuv_non_preserve() attempting
2748 to use atol, strtol, strtoul etc. */
2749 if (sv_2iuv_non_preserve (sv, numtype)
2750 >= IS_NUMBER_OVERFLOW_IV)
2754 #endif /* NV_PRESERVES_UV */
2757 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2759 if (SvTYPE(sv) < SVt_IV)
2760 /* Typically the caller expects that sv_any is not NULL now. */
2761 sv_upgrade(sv, SVt_IV);
2764 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2765 PTR2UV(sv),SvIVX(sv)));
2766 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2769 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2770 * this function provided for binary compatibility only
2774 Perl_sv_2uv(pTHX_ register SV *sv)
2776 return sv_2uv_flags(sv, SV_GMAGIC);
2780 =for apidoc sv_2uv_flags
2782 Return the unsigned integer value of an SV, doing any necessary string
2783 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2784 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2790 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2794 if (SvGMAGICAL(sv)) {
2795 if (flags & SV_GMAGIC)
2800 return U_V(SvNVX(sv));
2801 if (SvPOKp(sv) && SvLEN(sv))
2804 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2805 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2811 if (SvTHINKFIRST(sv)) {
2814 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2815 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2816 return SvUV(tmpstr);
2817 return PTR2UV(SvRV(sv));
2820 sv_force_normal_flags(sv, 0);
2822 if (SvREADONLY(sv) && !SvOK(sv)) {
2823 if (ckWARN(WARN_UNINITIALIZED))
2833 return (UV)SvIVX(sv);
2837 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2838 * without also getting a cached IV/UV from it at the same time
2839 * (ie PV->NV conversion should detect loss of accuracy and cache
2840 * IV or UV at same time to avoid this. */
2841 /* IV-over-UV optimisation - choose to cache IV if possible */
2843 if (SvTYPE(sv) == SVt_NV)
2844 sv_upgrade(sv, SVt_PVNV);
2846 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2847 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2848 SvIV_set(sv, I_V(SvNVX(sv)));
2849 if (SvNVX(sv) == (NV) SvIVX(sv)
2850 #ifndef NV_PRESERVES_UV
2851 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2852 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2853 /* Don't flag it as "accurately an integer" if the number
2854 came from a (by definition imprecise) NV operation, and
2855 we're outside the range of NV integer precision */
2858 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2859 DEBUG_c(PerlIO_printf(Perl_debug_log,
2860 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2866 /* IV not precise. No need to convert from PV, as NV
2867 conversion would already have cached IV if it detected
2868 that PV->IV would be better than PV->NV->IV
2869 flags already correct - don't set public IOK. */
2870 DEBUG_c(PerlIO_printf(Perl_debug_log,
2871 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2876 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2877 but the cast (NV)IV_MIN rounds to a the value less (more
2878 negative) than IV_MIN which happens to be equal to SvNVX ??
2879 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2880 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2881 (NV)UVX == NVX are both true, but the values differ. :-(
2882 Hopefully for 2s complement IV_MIN is something like
2883 0x8000000000000000 which will be exact. NWC */
2886 SvUV_set(sv, U_V(SvNVX(sv)));
2888 (SvNVX(sv) == (NV) SvUVX(sv))
2889 #ifndef NV_PRESERVES_UV
2890 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2891 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2892 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2893 /* Don't flag it as "accurately an integer" if the number
2894 came from a (by definition imprecise) NV operation, and
2895 we're outside the range of NV integer precision */
2900 DEBUG_c(PerlIO_printf(Perl_debug_log,
2901 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2907 else if (SvPOKp(sv) && SvLEN(sv)) {
2909 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2911 /* We want to avoid a possible problem when we cache a UV which
2912 may be later translated to an NV, and the resulting NV is not
2913 the translation of the initial data.
2915 This means that if we cache such a UV, we need to cache the
2916 NV as well. Moreover, we trade speed for space, and do not
2917 cache the NV if not needed.
2920 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2921 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2922 == IS_NUMBER_IN_UV) {
2923 /* It's definitely an integer, only upgrade to PVIV */
2924 if (SvTYPE(sv) < SVt_PVIV)
2925 sv_upgrade(sv, SVt_PVIV);
2927 } else if (SvTYPE(sv) < SVt_PVNV)
2928 sv_upgrade(sv, SVt_PVNV);
2930 /* If NV preserves UV then we only use the UV value if we know that
2931 we aren't going to call atof() below. If NVs don't preserve UVs
2932 then the value returned may have more precision than atof() will
2933 return, even though it isn't accurate. */
2934 if ((numtype & (IS_NUMBER_IN_UV
2935 #ifdef NV_PRESERVES_UV
2938 )) == IS_NUMBER_IN_UV) {
2939 /* This won't turn off the public IOK flag if it was set above */
2940 (void)SvIOKp_on(sv);
2942 if (!(numtype & IS_NUMBER_NEG)) {
2944 if (value <= (UV)IV_MAX) {
2945 SvIV_set(sv, (IV)value);
2947 /* it didn't overflow, and it was positive. */
2948 SvUV_set(sv, value);
2952 /* 2s complement assumption */
2953 if (value <= (UV)IV_MIN) {
2954 SvIV_set(sv, -(IV)value);
2956 /* Too negative for an IV. This is a double upgrade, but
2957 I'm assuming it will be rare. */
2958 if (SvTYPE(sv) < SVt_PVNV)
2959 sv_upgrade(sv, SVt_PVNV);
2963 SvNV_set(sv, -(NV)value);
2964 SvIV_set(sv, IV_MIN);
2969 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2970 != IS_NUMBER_IN_UV) {
2971 /* It wasn't an integer, or it overflowed the UV. */
2972 SvNV_set(sv, Atof(SvPVX(sv)));
2974 if (! numtype && ckWARN(WARN_NUMERIC))
2977 #if defined(USE_LONG_DOUBLE)
2978 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2979 PTR2UV(sv), SvNVX(sv)));
2981 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2982 PTR2UV(sv), SvNVX(sv)));
2985 #ifdef NV_PRESERVES_UV
2986 (void)SvIOKp_on(sv);
2988 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2989 SvIV_set(sv, I_V(SvNVX(sv)));
2990 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2993 /* Integer is imprecise. NOK, IOKp */
2995 /* UV will not work better than IV */
2997 if (SvNVX(sv) > (NV)UV_MAX) {
2999 /* Integer is inaccurate. NOK, IOKp, is UV */
3000 SvUV_set(sv, UV_MAX);
3003 SvUV_set(sv, U_V(SvNVX(sv)));
3004 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3005 NV preservse UV so can do correct comparison. */
3006 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3010 /* Integer is imprecise. NOK, IOKp, is UV */
3015 #else /* NV_PRESERVES_UV */
3016 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3017 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3018 /* The UV slot will have been set from value returned by
3019 grok_number above. The NV slot has just been set using
3022 assert (SvIOKp(sv));
3024 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3025 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3026 /* Small enough to preserve all bits. */
3027 (void)SvIOKp_on(sv);
3029 SvIV_set(sv, I_V(SvNVX(sv)));
3030 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3032 /* Assumption: first non-preserved integer is < IV_MAX,
3033 this NV is in the preserved range, therefore: */
3034 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3036 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);
3039 sv_2iuv_non_preserve (sv, numtype);
3041 #endif /* NV_PRESERVES_UV */
3045 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3046 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3049 if (SvTYPE(sv) < SVt_IV)
3050 /* Typically the caller expects that sv_any is not NULL now. */
3051 sv_upgrade(sv, SVt_IV);
3055 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3056 PTR2UV(sv),SvUVX(sv)));
3057 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3063 Return the num value of an SV, doing any necessary string or integer
3064 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3071 Perl_sv_2nv(pTHX_ register SV *sv)
3075 if (SvGMAGICAL(sv)) {
3079 if (SvPOKp(sv) && SvLEN(sv)) {
3080 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3081 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3083 return Atof(SvPVX(sv));
3087 return (NV)SvUVX(sv);
3089 return (NV)SvIVX(sv);
3092 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3093 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3099 if (SvTHINKFIRST(sv)) {
3102 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3103 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3104 return SvNV(tmpstr);
3105 return PTR2NV(SvRV(sv));
3108 sv_force_normal_flags(sv, 0);
3110 if (SvREADONLY(sv) && !SvOK(sv)) {
3111 if (ckWARN(WARN_UNINITIALIZED))
3116 if (SvTYPE(sv) < SVt_NV) {
3117 if (SvTYPE(sv) == SVt_IV)
3118 sv_upgrade(sv, SVt_PVNV);
3120 sv_upgrade(sv, SVt_NV);
3121 #ifdef USE_LONG_DOUBLE
3123 STORE_NUMERIC_LOCAL_SET_STANDARD();
3124 PerlIO_printf(Perl_debug_log,
3125 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3126 PTR2UV(sv), SvNVX(sv));
3127 RESTORE_NUMERIC_LOCAL();
3131 STORE_NUMERIC_LOCAL_SET_STANDARD();
3132 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3133 PTR2UV(sv), SvNVX(sv));
3134 RESTORE_NUMERIC_LOCAL();
3138 else if (SvTYPE(sv) < SVt_PVNV)
3139 sv_upgrade(sv, SVt_PVNV);
3144 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3145 #ifdef NV_PRESERVES_UV
3148 /* Only set the public NV OK flag if this NV preserves the IV */
3149 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3150 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3151 : (SvIVX(sv) == I_V(SvNVX(sv))))
3157 else if (SvPOKp(sv) && SvLEN(sv)) {
3159 const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3160 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3162 #ifdef NV_PRESERVES_UV
3163 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3164 == IS_NUMBER_IN_UV) {
3165 /* It's definitely an integer */
3166 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3168 SvNV_set(sv, Atof(SvPVX(sv)));
3171 SvNV_set(sv, Atof(SvPVX(sv)));
3172 /* Only set the public NV OK flag if this NV preserves the value in
3173 the PV at least as well as an IV/UV would.
3174 Not sure how to do this 100% reliably. */
3175 /* if that shift count is out of range then Configure's test is
3176 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3178 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3179 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3180 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3181 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3182 /* Can't use strtol etc to convert this string, so don't try.
3183 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3186 /* value has been set. It may not be precise. */
3187 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3188 /* 2s complement assumption for (UV)IV_MIN */
3189 SvNOK_on(sv); /* Integer is too negative. */
3194 if (numtype & IS_NUMBER_NEG) {
3195 SvIV_set(sv, -(IV)value);
3196 } else if (value <= (UV)IV_MAX) {
3197 SvIV_set(sv, (IV)value);
3199 SvUV_set(sv, value);
3203 if (numtype & IS_NUMBER_NOT_INT) {
3204 /* I believe that even if the original PV had decimals,
3205 they are lost beyond the limit of the FP precision.
3206 However, neither is canonical, so both only get p
3207 flags. NWC, 2000/11/25 */
3208 /* Both already have p flags, so do nothing */
3211 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3212 if (SvIVX(sv) == I_V(nv)) {
3217 /* It had no "." so it must be integer. */
3220 /* between IV_MAX and NV(UV_MAX).
3221 Could be slightly > UV_MAX */
3223 if (numtype & IS_NUMBER_NOT_INT) {
3224 /* UV and NV both imprecise. */
3226 UV nv_as_uv = U_V(nv);
3228 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3239 #endif /* NV_PRESERVES_UV */
3242 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3244 if (SvTYPE(sv) < SVt_NV)
3245 /* Typically the caller expects that sv_any is not NULL now. */
3246 /* XXX Ilya implies that this is a bug in callers that assume this
3247 and ideally should be fixed. */
3248 sv_upgrade(sv, SVt_NV);
3251 #if defined(USE_LONG_DOUBLE)
3253 STORE_NUMERIC_LOCAL_SET_STANDARD();
3254 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3255 PTR2UV(sv), SvNVX(sv));
3256 RESTORE_NUMERIC_LOCAL();
3260 STORE_NUMERIC_LOCAL_SET_STANDARD();
3261 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3262 PTR2UV(sv), SvNVX(sv));
3263 RESTORE_NUMERIC_LOCAL();
3269 /* asIV(): extract an integer from the string value of an SV.
3270 * Caller must validate PVX */
3273 S_asIV(pTHX_ SV *sv)
3276 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3278 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3279 == IS_NUMBER_IN_UV) {
3280 /* It's definitely an integer */
3281 if (numtype & IS_NUMBER_NEG) {
3282 if (value < (UV)IV_MIN)
3285 if (value < (UV)IV_MAX)
3290 if (ckWARN(WARN_NUMERIC))
3293 return I_V(Atof(SvPVX(sv)));
3296 /* asUV(): extract an unsigned integer from the string value of an SV
3297 * Caller must validate PVX */
3300 S_asUV(pTHX_ SV *sv)
3303 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3305 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3306 == IS_NUMBER_IN_UV) {
3307 /* It's definitely an integer */
3308 if (!(numtype & IS_NUMBER_NEG))
3312 if (ckWARN(WARN_NUMERIC))
3315 return U_V(Atof(SvPVX(sv)));
3319 =for apidoc sv_2pv_nolen
3321 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3322 use the macro wrapper C<SvPV_nolen(sv)> instead.
3327 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3330 return sv_2pv(sv, &n_a);
3333 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3334 * UV as a string towards the end of buf, and return pointers to start and
3337 * We assume that buf is at least TYPE_CHARS(UV) long.
3341 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3343 char *ptr = buf + TYPE_CHARS(UV);
3357 *--ptr = '0' + (char)(uv % 10);
3365 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3366 * this function provided for binary compatibility only
3370 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3372 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3376 =for apidoc sv_2pv_flags
3378 Returns a pointer to the string value of an SV, and sets *lp to its length.
3379 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3381 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3382 usually end up here too.
3388 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3393 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3394 char *tmpbuf = tbuf;
3400 if (SvGMAGICAL(sv)) {
3401 if (flags & SV_GMAGIC)
3409 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3411 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3416 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3421 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3422 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3429 if (SvTHINKFIRST(sv)) {
3432 register const char *typestr;
3433 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3434 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3435 char *pv = SvPV(tmpstr, *lp);
3445 typestr = "NULLREF";
3449 switch (SvTYPE(sv)) {
3451 if ( ((SvFLAGS(sv) &
3452 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3453 == (SVs_OBJECT|SVs_SMG))
3454 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3455 const regexp *re = (regexp *)mg->mg_obj;
3458 const char *fptr = "msix";
3463 char need_newline = 0;
3464 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3466 while((ch = *fptr++)) {
3468 reflags[left++] = ch;
3471 reflags[right--] = ch;
3476 reflags[left] = '-';
3480 mg->mg_len = re->prelen + 4 + left;
3482 * If /x was used, we have to worry about a regex
3483 * ending with a comment later being embedded
3484 * within another regex. If so, we don't want this
3485 * regex's "commentization" to leak out to the
3486 * right part of the enclosing regex, we must cap
3487 * it with a newline.
3489 * So, if /x was used, we scan backwards from the
3490 * end of the regex. If we find a '#' before we
3491 * find a newline, we need to add a newline
3492 * ourself. If we find a '\n' first (or if we
3493 * don't find '#' or '\n'), we don't need to add
3494 * anything. -jfriedl
3496 if (PMf_EXTENDED & re->reganch)
3498 const char *endptr = re->precomp + re->prelen;
3499 while (endptr >= re->precomp)
3501 const char c = *(endptr--);
3503 break; /* don't need another */
3505 /* we end while in a comment, so we
3507 mg->mg_len++; /* save space for it */
3508 need_newline = 1; /* note to add it */
3514 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3515 Copy("(?", mg->mg_ptr, 2, char);
3516 Copy(reflags, mg->mg_ptr+2, left, char);
3517 Copy(":", mg->mg_ptr+left+2, 1, char);
3518 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3520 mg->mg_ptr[mg->mg_len - 2] = '\n';
3521 mg->mg_ptr[mg->mg_len - 1] = ')';
3522 mg->mg_ptr[mg->mg_len] = 0;
3524 PL_reginterp_cnt += re->program[0].next_off;
3526 if (re->reganch & ROPT_UTF8)
3541 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3542 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3543 /* tied lvalues should appear to be
3544 * scalars for backwards compatitbility */
3545 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3546 ? "SCALAR" : "LVALUE"; break;
3547 case SVt_PVAV: typestr = "ARRAY"; break;
3548 case SVt_PVHV: typestr = "HASH"; break;
3549 case SVt_PVCV: typestr = "CODE"; break;
3550 case SVt_PVGV: typestr = "GLOB"; break;
3551 case SVt_PVFM: typestr = "FORMAT"; break;
3552 case SVt_PVIO: typestr = "IO"; break;
3553 default: typestr = "UNKNOWN"; break;
3557 const char *name = HvNAME_get(SvSTASH(sv));
3558 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3559 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3562 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3565 *lp = strlen(typestr);
3566 return (char *)typestr;
3568 if (SvREADONLY(sv) && !SvOK(sv)) {
3569 if (ckWARN(WARN_UNINITIALIZED))
3575 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3576 /* I'm assuming that if both IV and NV are equally valid then
3577 converting the IV is going to be more efficient */
3578 const U32 isIOK = SvIOK(sv);
3579 const U32 isUIOK = SvIsUV(sv);
3580 char buf[TYPE_CHARS(UV)];
3583 if (SvTYPE(sv) < SVt_PVIV)
3584 sv_upgrade(sv, SVt_PVIV);
3586 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3588 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3589 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3590 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3591 SvCUR_set(sv, ebuf - ptr);
3601 else if (SvNOKp(sv)) {
3602 if (SvTYPE(sv) < SVt_PVNV)
3603 sv_upgrade(sv, SVt_PVNV);
3604 /* The +20 is pure guesswork. Configure test needed. --jhi */
3605 SvGROW(sv, NV_DIG + 20);
3607 olderrno = errno; /* some Xenix systems wipe out errno here */
3609 if (SvNVX(sv) == 0.0)
3610 (void)strcpy(s,"0");
3614 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3617 #ifdef FIXNEGATIVEZERO
3618 if (*s == '-' && s[1] == '0' && !s[2])
3628 if (ckWARN(WARN_UNINITIALIZED)
3629 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3632 if (SvTYPE(sv) < SVt_PV)
3633 /* Typically the caller expects that sv_any is not NULL now. */
3634 sv_upgrade(sv, SVt_PV);
3637 *lp = s - SvPVX(sv);
3640 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3641 PTR2UV(sv),SvPVX(sv)));
3645 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3646 /* Sneaky stuff here */
3650 tsv = newSVpv(tmpbuf, 0);
3667 len = strlen(tmpbuf);
3669 #ifdef FIXNEGATIVEZERO
3670 if (len == 2 && t[0] == '-' && t[1] == '0') {
3675 (void)SvUPGRADE(sv, SVt_PV);
3677 s = SvGROW(sv, len + 1);
3680 return strcpy(s, t);
3685 =for apidoc sv_copypv
3687 Copies a stringified representation of the source SV into the
3688 destination SV. Automatically performs any necessary mg_get and
3689 coercion of numeric values into strings. Guaranteed to preserve
3690 UTF-8 flag even from overloaded objects. Similar in nature to
3691 sv_2pv[_flags] but operates directly on an SV instead of just the
3692 string. Mostly uses sv_2pv_flags to do its work, except when that
3693 would lose the UTF-8'ness of the PV.
3699 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3704 sv_setpvn(dsv,s,len);
3712 =for apidoc sv_2pvbyte_nolen
3714 Return a pointer to the byte-encoded representation of the SV.
3715 May cause the SV to be downgraded from UTF-8 as a side-effect.
3717 Usually accessed via the C<SvPVbyte_nolen> macro.
3723 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3726 return sv_2pvbyte(sv, &n_a);
3730 =for apidoc sv_2pvbyte
3732 Return a pointer to the byte-encoded representation of the SV, and set *lp
3733 to its length. May cause the SV to be downgraded from UTF-8 as a
3736 Usually accessed via the C<SvPVbyte> macro.
3742 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3744 sv_utf8_downgrade(sv,0);
3745 return SvPV(sv,*lp);
3749 =for apidoc sv_2pvutf8_nolen
3751 Return a pointer to the UTF-8-encoded representation of the SV.
3752 May cause the SV to be upgraded to UTF-8 as a side-effect.
3754 Usually accessed via the C<SvPVutf8_nolen> macro.
3760 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3763 return sv_2pvutf8(sv, &n_a);
3767 =for apidoc sv_2pvutf8
3769 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3770 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3772 Usually accessed via the C<SvPVutf8> macro.
3778 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3780 sv_utf8_upgrade(sv);
3781 return SvPV(sv,*lp);
3785 =for apidoc sv_2bool
3787 This function is only called on magical items, and is only used by
3788 sv_true() or its macro equivalent.
3794 Perl_sv_2bool(pTHX_ register SV *sv)
3803 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3804 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3805 return (bool)SvTRUE(tmpsv);
3806 return SvRV(sv) != 0;
3809 register XPV* Xpvtmp;
3810 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3811 (*sv->sv_u.svu_pv > '0' ||
3812 Xpvtmp->xpv_cur > 1 ||
3813 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3820 return SvIVX(sv) != 0;
3823 return SvNVX(sv) != 0.0;
3830 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3831 * this function provided for binary compatibility only
3836 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3838 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3842 =for apidoc sv_utf8_upgrade
3844 Converts the PV of an SV to its UTF-8-encoded form.
3845 Forces the SV to string form if it is not already.
3846 Always sets the SvUTF8 flag to avoid future validity checks even
3847 if all the bytes have hibit clear.
3849 This is not as a general purpose byte encoding to Unicode interface:
3850 use the Encode extension for that.
3852 =for apidoc sv_utf8_upgrade_flags
3854 Converts the PV of an SV to its UTF-8-encoded form.
3855 Forces the SV to string form if it is not already.
3856 Always sets the SvUTF8 flag to avoid future validity checks even
3857 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3858 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3859 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3861 This is not as a general purpose byte encoding to Unicode interface:
3862 use the Encode extension for that.
3868 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3870 if (sv == &PL_sv_undef)
3874 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3875 (void) sv_2pv_flags(sv,&len, flags);
3879 (void) SvPV_force(sv,len);
3888 sv_force_normal_flags(sv, 0);
3891 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3892 sv_recode_to_utf8(sv, PL_encoding);
3893 else { /* Assume Latin-1/EBCDIC */
3894 /* This function could be much more efficient if we
3895 * had a FLAG in SVs to signal if there are any hibit
3896 * chars in the PV. Given that there isn't such a flag
3897 * make the loop as fast as possible. */
3898 U8 *s = (U8 *) SvPVX(sv);
3899 U8 *e = (U8 *) SvEND(sv);
3905 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3909 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3910 s = bytes_to_utf8((U8*)s, &len);
3912 SvPV_free(sv); /* No longer using what was there before. */
3914 SvPV_set(sv, (char*)s);
3915 SvCUR_set(sv, len - 1);
3916 SvLEN_set(sv, len); /* No longer know the real size. */
3918 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3925 =for apidoc sv_utf8_downgrade
3927 Attempts to convert the PV of an SV from characters to bytes.
3928 If the PV contains a character beyond byte, this conversion will fail;
3929 in this case, either returns false or, if C<fail_ok> is not
3932 This is not as a general purpose Unicode to byte encoding interface:
3933 use the Encode extension for that.
3939 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3941 if (SvPOKp(sv) && SvUTF8(sv)) {
3947 sv_force_normal_flags(sv, 0);
3949 s = (U8 *) SvPV(sv, len);
3950 if (!utf8_to_bytes(s, &len)) {
3955 Perl_croak(aTHX_ "Wide character in %s",
3958 Perl_croak(aTHX_ "Wide character");
3969 =for apidoc sv_utf8_encode
3971 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3972 flag off so that it looks like octets again.
3978 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3980 (void) sv_utf8_upgrade(sv);
3982 sv_force_normal_flags(sv, 0);
3984 if (SvREADONLY(sv)) {
3985 Perl_croak(aTHX_ PL_no_modify);
3991 =for apidoc sv_utf8_decode
3993 If the PV of the SV is an octet sequence in UTF-8
3994 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3995 so that it looks like a character. If the PV contains only single-byte
3996 characters, the C<SvUTF8> flag stays being off.
3997 Scans PV for validity and returns false if the PV is invalid UTF-8.
4003 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4009 /* The octets may have got themselves encoded - get them back as
4012 if (!sv_utf8_downgrade(sv, TRUE))
4015 /* it is actually just a matter of turning the utf8 flag on, but
4016 * we want to make sure everything inside is valid utf8 first.
4018 c = (U8 *) SvPVX(sv);
4019 if (!is_utf8_string(c, SvCUR(sv)+1))
4021 e = (U8 *) SvEND(sv);
4024 if (!UTF8_IS_INVARIANT(ch)) {
4033 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4034 * this function provided for binary compatibility only
4038 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4040 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4044 =for apidoc sv_setsv
4046 Copies the contents of the source SV C<ssv> into the destination SV
4047 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4048 function if the source SV needs to be reused. Does not handle 'set' magic.
4049 Loosely speaking, it performs a copy-by-value, obliterating any previous
4050 content of the destination.
4052 You probably want to use one of the assortment of wrappers, such as
4053 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4054 C<SvSetMagicSV_nosteal>.
4056 =for apidoc sv_setsv_flags
4058 Copies the contents of the source SV C<ssv> into the destination SV
4059 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4060 function if the source SV needs to be reused. Does not handle 'set' magic.
4061 Loosely speaking, it performs a copy-by-value, obliterating any previous
4062 content of the destination.
4063 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4064 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4065 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4066 and C<sv_setsv_nomg> are implemented in terms of this function.
4068 You probably want to use one of the assortment of wrappers, such as
4069 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4070 C<SvSetMagicSV_nosteal>.
4072 This is the primary function for copying scalars, and most other
4073 copy-ish functions and macros use this underneath.
4079 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4081 register U32 sflags;
4087 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4089 sstr = &PL_sv_undef;
4090 stype = SvTYPE(sstr);
4091 dtype = SvTYPE(dstr);
4096 /* need to nuke the magic */
4098 SvRMAGICAL_off(dstr);
4101 /* There's a lot of redundancy below but we're going for speed here */
4106 if (dtype != SVt_PVGV) {
4107 (void)SvOK_off(dstr);
4115 sv_upgrade(dstr, SVt_IV);
4118 sv_upgrade(dstr, SVt_PVNV);
4122 sv_upgrade(dstr, SVt_PVIV);
4125 (void)SvIOK_only(dstr);
4126 SvIV_set(dstr, SvIVX(sstr));
4129 if (SvTAINTED(sstr))
4140 sv_upgrade(dstr, SVt_NV);
4145 sv_upgrade(dstr, SVt_PVNV);
4148 SvNV_set(dstr, SvNVX(sstr));
4149 (void)SvNOK_only(dstr);
4150 if (SvTAINTED(sstr))
4158 sv_upgrade(dstr, SVt_RV);
4159 else if (dtype == SVt_PVGV &&
4160 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4163 if (GvIMPORTED(dstr) != GVf_IMPORTED
4164 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4166 GvIMPORTED_on(dstr);
4175 #ifdef PERL_COPY_ON_WRITE
4176 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4177 if (dtype < SVt_PVIV)
4178 sv_upgrade(dstr, SVt_PVIV);
4185 sv_upgrade(dstr, SVt_PV);
4188 if (dtype < SVt_PVIV)
4189 sv_upgrade(dstr, SVt_PVIV);
4192 if (dtype < SVt_PVNV)
4193 sv_upgrade(dstr, SVt_PVNV);
4200 const char * const type = sv_reftype(sstr,0);
4202 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4204 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4209 if (dtype <= SVt_PVGV) {
4211 if (dtype != SVt_PVGV) {
4212 const char * const name = GvNAME(sstr);
4213 const STRLEN len = GvNAMELEN(sstr);
4214 /* don't upgrade SVt_PVLV: it can hold a glob */
4215 if (dtype != SVt_PVLV)
4216 sv_upgrade(dstr, SVt_PVGV);
4217 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4218 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4219 GvNAME(dstr) = savepvn(name, len);
4220 GvNAMELEN(dstr) = len;
4221 SvFAKE_on(dstr); /* can coerce to non-glob */
4223 /* ahem, death to those who redefine active sort subs */
4224 else if (PL_curstackinfo->si_type == PERLSI_SORT
4225 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4226 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4229 #ifdef GV_UNIQUE_CHECK
4230 if (GvUNIQUE((GV*)dstr)) {
4231 Perl_croak(aTHX_ PL_no_modify);
4235 (void)SvOK_off(dstr);
4236 GvINTRO_off(dstr); /* one-shot flag */
4238 GvGP(dstr) = gp_ref(GvGP(sstr));
4239 if (SvTAINTED(sstr))
4241 if (GvIMPORTED(dstr) != GVf_IMPORTED
4242 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4244 GvIMPORTED_on(dstr);
4252 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4254 if ((int)SvTYPE(sstr) != stype) {
4255 stype = SvTYPE(sstr);
4256 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4260 if (stype == SVt_PVLV)
4261 (void)SvUPGRADE(dstr, SVt_PVNV);
4263 (void)SvUPGRADE(dstr, (U32)stype);
4266 sflags = SvFLAGS(sstr);
4268 if (sflags & SVf_ROK) {
4269 if (dtype >= SVt_PV) {
4270 if (dtype == SVt_PVGV) {
4271 SV *sref = SvREFCNT_inc(SvRV(sstr));
4273 const int intro = GvINTRO(dstr);
4275 #ifdef GV_UNIQUE_CHECK
4276 if (GvUNIQUE((GV*)dstr)) {
4277 Perl_croak(aTHX_ PL_no_modify);
4282 GvINTRO_off(dstr); /* one-shot flag */
4283 GvLINE(dstr) = CopLINE(PL_curcop);
4284 GvEGV(dstr) = (GV*)dstr;
4287 switch (SvTYPE(sref)) {
4290 SAVEGENERICSV(GvAV(dstr));
4292 dref = (SV*)GvAV(dstr);
4293 GvAV(dstr) = (AV*)sref;
4294 if (!GvIMPORTED_AV(dstr)
4295 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4297 GvIMPORTED_AV_on(dstr);
4302 SAVEGENERICSV(GvHV(dstr));
4304 dref = (SV*)GvHV(dstr);
4305 GvHV(dstr) = (HV*)sref;
4306 if (!GvIMPORTED_HV(dstr)
4307 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4309 GvIMPORTED_HV_on(dstr);
4314 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4315 SvREFCNT_dec(GvCV(dstr));
4316 GvCV(dstr) = Nullcv;
4317 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4318 PL_sub_generation++;
4320 SAVEGENERICSV(GvCV(dstr));
4323 dref = (SV*)GvCV(dstr);
4324 if (GvCV(dstr) != (CV*)sref) {
4325 CV* cv = GvCV(dstr);
4327 if (!GvCVGEN((GV*)dstr) &&
4328 (CvROOT(cv) || CvXSUB(cv)))
4330 /* ahem, death to those who redefine
4331 * active sort subs */
4332 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4333 PL_sortcop == CvSTART(cv))
4335 "Can't redefine active sort subroutine %s",
4336 GvENAME((GV*)dstr));
4337 /* Redefining a sub - warning is mandatory if
4338 it was a const and its value changed. */
4339 if (ckWARN(WARN_REDEFINE)
4341 && (!CvCONST((CV*)sref)
4342 || sv_cmp(cv_const_sv(cv),
4343 cv_const_sv((CV*)sref)))))
4345 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4347 ? "Constant subroutine %s::%s redefined"
4348 : "Subroutine %s::%s redefined",
4349 HvNAME_get(GvSTASH((GV*)dstr)),
4350 GvENAME((GV*)dstr));
4354 cv_ckproto(cv, (GV*)dstr,
4355 SvPOK(sref) ? SvPVX(sref) : Nullch);
4357 GvCV(dstr) = (CV*)sref;
4358 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4359 GvASSUMECV_on(dstr);
4360 PL_sub_generation++;
4362 if (!GvIMPORTED_CV(dstr)
4363 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4365 GvIMPORTED_CV_on(dstr);
4370 SAVEGENERICSV(GvIOp(dstr));
4372 dref = (SV*)GvIOp(dstr);
4373 GvIOp(dstr) = (IO*)sref;
4377 SAVEGENERICSV(GvFORM(dstr));
4379 dref = (SV*)GvFORM(dstr);
4380 GvFORM(dstr) = (CV*)sref;
4384 SAVEGENERICSV(GvSV(dstr));
4386 dref = (SV*)GvSV(dstr);
4388 if (!GvIMPORTED_SV(dstr)
4389 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4391 GvIMPORTED_SV_on(dstr);
4397 if (SvTAINTED(sstr))
4407 (void)SvOK_off(dstr);
4408 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4410 if (sflags & SVp_NOK) {
4412 /* Only set the public OK flag if the source has public OK. */
4413 if (sflags & SVf_NOK)
4414 SvFLAGS(dstr) |= SVf_NOK;
4415 SvNV_set(dstr, SvNVX(sstr));
4417 if (sflags & SVp_IOK) {
4418 (void)SvIOKp_on(dstr);
4419 if (sflags & SVf_IOK)
4420 SvFLAGS(dstr) |= SVf_IOK;
4421 if (sflags & SVf_IVisUV)
4423 SvIV_set(dstr, SvIVX(sstr));
4425 if (SvAMAGIC(sstr)) {
4429 else if (sflags & SVp_POK) {
4433 * Check to see if we can just swipe the string. If so, it's a
4434 * possible small lose on short strings, but a big win on long ones.
4435 * It might even be a win on short strings if SvPVX(dstr)
4436 * has to be allocated and SvPVX(sstr) has to be freed.
4439 /* Whichever path we take through the next code, we want this true,
4440 and doing it now facilitates the COW check. */
4441 (void)SvPOK_only(dstr);
4444 #ifdef PERL_COPY_ON_WRITE
4445 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4449 (sflags & SVs_TEMP) && /* slated for free anyway? */
4450 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4451 (!(flags & SV_NOSTEAL)) &&
4452 /* and we're allowed to steal temps */
4453 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4454 SvLEN(sstr) && /* and really is a string */
4455 /* and won't be needed again, potentially */
4456 !(PL_op && PL_op->op_type == OP_AASSIGN))
4457 #ifdef PERL_COPY_ON_WRITE
4458 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4459 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4460 && SvTYPE(sstr) >= SVt_PVIV)
4463 /* Failed the swipe test, and it's not a shared hash key either.
4464 Have to copy the string. */
4465 STRLEN len = SvCUR(sstr);
4466 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4467 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4468 SvCUR_set(dstr, len);
4469 *SvEND(dstr) = '\0';
4471 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4473 #ifdef PERL_COPY_ON_WRITE
4474 /* Either it's a shared hash key, or it's suitable for
4475 copy-on-write or we can swipe the string. */
4477 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4482 /* I believe I should acquire a global SV mutex if
4483 it's a COW sv (not a shared hash key) to stop
4484 it going un copy-on-write.
4485 If the source SV has gone un copy on write between up there
4486 and down here, then (assert() that) it is of the correct
4487 form to make it copy on write again */
4488 if ((sflags & (SVf_FAKE | SVf_READONLY))
4489 != (SVf_FAKE | SVf_READONLY)) {
4490 SvREADONLY_on(sstr);
4492 /* Make the source SV into a loop of 1.
4493 (about to become 2) */
4494 SV_COW_NEXT_SV_SET(sstr, sstr);
4498 /* Initial code is common. */
4499 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4501 SvFLAGS(dstr) &= ~SVf_OOK;
4502 Safefree(SvPVX(dstr) - SvIVX(dstr));
4504 else if (SvLEN(dstr))
4505 Safefree(SvPVX(dstr));
4508 #ifdef PERL_COPY_ON_WRITE
4510 /* making another shared SV. */
4511 STRLEN cur = SvCUR(sstr);
4512 STRLEN len = SvLEN(sstr);
4513 assert (SvTYPE(dstr) >= SVt_PVIV);
4515 /* SvIsCOW_normal */
4516 /* splice us in between source and next-after-source. */
4517 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4518 SV_COW_NEXT_SV_SET(sstr, dstr);
4519 SvPV_set(dstr, SvPVX(sstr));
4521 /* SvIsCOW_shared_hash */
4522 UV hash = SvUVX(sstr);
4523 DEBUG_C(PerlIO_printf(Perl_debug_log,
4524 "Copy on write: Sharing hash\n"));
4526 sharepvn(SvPVX(sstr),
4527 (sflags & SVf_UTF8?-cur:cur), hash));
4528 SvUV_set(dstr, hash);
4530 SvLEN_set(dstr, len);
4531 SvCUR_set(dstr, cur);
4532 SvREADONLY_on(dstr);
4534 /* Relesase a global SV mutex. */
4538 { /* Passes the swipe test. */
4539 SvPV_set(dstr, SvPVX(sstr));
4540 SvLEN_set(dstr, SvLEN(sstr));
4541 SvCUR_set(dstr, SvCUR(sstr));
4544 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4545 SvPV_set(sstr, Nullch);
4551 if (sflags & SVf_UTF8)
4554 if (sflags & SVp_NOK) {
4556 if (sflags & SVf_NOK)
4557 SvFLAGS(dstr) |= SVf_NOK;
4558 SvNV_set(dstr, SvNVX(sstr));
4560 if (sflags & SVp_IOK) {
4561 (void)SvIOKp_on(dstr);
4562 if (sflags & SVf_IOK)
4563 SvFLAGS(dstr) |= SVf_IOK;
4564 if (sflags & SVf_IVisUV)
4566 SvIV_set(dstr, SvIVX(sstr));
4569 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4570 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4571 smg->mg_ptr, smg->mg_len);
4572 SvRMAGICAL_on(dstr);
4575 else if (sflags & SVp_IOK) {
4576 if (sflags & SVf_IOK)
4577 (void)SvIOK_only(dstr);
4579 (void)SvOK_off(dstr);
4580 (void)SvIOKp_on(dstr);
4582 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4583 if (sflags & SVf_IVisUV)
4585 SvIV_set(dstr, SvIVX(sstr));
4586 if (sflags & SVp_NOK) {
4587 if (sflags & SVf_NOK)
4588 (void)SvNOK_on(dstr);
4590 (void)SvNOKp_on(dstr);
4591 SvNV_set(dstr, SvNVX(sstr));
4594 else if (sflags & SVp_NOK) {
4595 if (sflags & SVf_NOK)
4596 (void)SvNOK_only(dstr);
4598 (void)SvOK_off(dstr);
4601 SvNV_set(dstr, SvNVX(sstr));
4604 if (dtype == SVt_PVGV) {
4605 if (ckWARN(WARN_MISC))
4606 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4609 (void)SvOK_off(dstr);
4611 if (SvTAINTED(sstr))
4616 =for apidoc sv_setsv_mg
4618 Like C<sv_setsv>, but also handles 'set' magic.
4624 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4626 sv_setsv(dstr,sstr);
4630 #ifdef PERL_COPY_ON_WRITE
4632 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4634 STRLEN cur = SvCUR(sstr);
4635 STRLEN len = SvLEN(sstr);
4636 register char *new_pv;
4639 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4647 if (SvTHINKFIRST(dstr))
4648 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4649 else if (SvPVX(dstr))
4650 Safefree(SvPVX(dstr));
4654 (void)SvUPGRADE (dstr, SVt_PVIV);
4656 assert (SvPOK(sstr));
4657 assert (SvPOKp(sstr));
4658 assert (!SvIOK(sstr));
4659 assert (!SvIOKp(sstr));
4660 assert (!SvNOK(sstr));
4661 assert (!SvNOKp(sstr));
4663 if (SvIsCOW(sstr)) {
4665 if (SvLEN(sstr) == 0) {
4666 /* source is a COW shared hash key. */
4667 UV hash = SvUVX(sstr);
4668 DEBUG_C(PerlIO_printf(Perl_debug_log,
4669 "Fast copy on write: Sharing hash\n"));
4670 SvUV_set(dstr, hash);
4671 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4674 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4676 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4677 (void)SvUPGRADE (sstr, SVt_PVIV);
4678 SvREADONLY_on(sstr);
4680 DEBUG_C(PerlIO_printf(Perl_debug_log,
4681 "Fast copy on write: Converting sstr to COW\n"));
4682 SV_COW_NEXT_SV_SET(dstr, sstr);
4684 SV_COW_NEXT_SV_SET(sstr, dstr);
4685 new_pv = SvPVX(sstr);
4688 SvPV_set(dstr, new_pv);
4689 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4692 SvLEN_set(dstr, len);
4693 SvCUR_set(dstr, cur);
4702 =for apidoc sv_setpvn
4704 Copies a string into an SV. The C<len> parameter indicates the number of
4705 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4706 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4712 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4714 register char *dptr;
4716 SV_CHECK_THINKFIRST_COW_DROP(sv);
4722 /* len is STRLEN which is unsigned, need to copy to signed */
4725 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4727 (void)SvUPGRADE(sv, SVt_PV);
4729 SvGROW(sv, len + 1);
4731 Move(ptr,dptr,len,char);
4734 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4739 =for apidoc sv_setpvn_mg
4741 Like C<sv_setpvn>, but also handles 'set' magic.
4747 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4749 sv_setpvn(sv,ptr,len);
4754 =for apidoc sv_setpv
4756 Copies a string into an SV. The string must be null-terminated. Does not
4757 handle 'set' magic. See C<sv_setpv_mg>.
4763 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4765 register STRLEN len;
4767 SV_CHECK_THINKFIRST_COW_DROP(sv);
4773 (void)SvUPGRADE(sv, SVt_PV);
4775 SvGROW(sv, len + 1);
4776 Move(ptr,SvPVX(sv),len+1,char);
4778 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4783 =for apidoc sv_setpv_mg
4785 Like C<sv_setpv>, but also handles 'set' magic.
4791 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4798 =for apidoc sv_usepvn
4800 Tells an SV to use C<ptr> to find its string value. Normally the string is
4801 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4802 The C<ptr> should point to memory that was allocated by C<malloc>. The
4803 string length, C<len>, must be supplied. This function will realloc the
4804 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4805 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4806 See C<sv_usepvn_mg>.
4812 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4815 SV_CHECK_THINKFIRST_COW_DROP(sv);
4816 (void)SvUPGRADE(sv, SVt_PV);
4824 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4825 ptr = safesysrealloc (ptr, allocate);
4828 SvLEN_set(sv, allocate);
4830 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4835 =for apidoc sv_usepvn_mg
4837 Like C<sv_usepvn>, but also handles 'set' magic.
4843 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4845 sv_usepvn(sv,ptr,len);
4849 #ifdef PERL_COPY_ON_WRITE
4850 /* Need to do this *after* making the SV normal, as we need the buffer
4851 pointer to remain valid until after we've copied it. If we let go too early,
4852 another thread could invalidate it by unsharing last of the same hash key
4853 (which it can do by means other than releasing copy-on-write Svs)
4854 or by changing the other copy-on-write SVs in the loop. */
4856 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4857 U32 hash, SV *after)
4859 if (len) { /* this SV was SvIsCOW_normal(sv) */
4860 /* we need to find the SV pointing to us. */
4861 SV *current = SV_COW_NEXT_SV(after);
4863 if (current == sv) {
4864 /* The SV we point to points back to us (there were only two of us
4866 Hence other SV is no longer copy on write either. */
4868 SvREADONLY_off(after);
4870 /* We need to follow the pointers around the loop. */
4872 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4875 /* don't loop forever if the structure is bust, and we have
4876 a pointer into a closed loop. */
4877 assert (current != after);
4878 assert (SvPVX(current) == pvx);
4880 /* Make the SV before us point to the SV after us. */
4881 SV_COW_NEXT_SV_SET(current, after);
4884 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4889 Perl_sv_release_IVX(pTHX_ register SV *sv)
4892 sv_force_normal_flags(sv, 0);
4898 =for apidoc sv_force_normal_flags
4900 Undo various types of fakery on an SV: if the PV is a shared string, make
4901 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4902 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4903 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4904 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4905 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4906 set to some other value.) In addition, the C<flags> parameter gets passed to
4907 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4908 with flags set to 0.
4914 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4916 #ifdef PERL_COPY_ON_WRITE
4917 if (SvREADONLY(sv)) {
4918 /* At this point I believe I should acquire a global SV mutex. */
4920 char *pvx = SvPVX(sv);
4921 STRLEN len = SvLEN(sv);
4922 STRLEN cur = SvCUR(sv);
4923 U32 hash = SvUVX(sv);
4924 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4926 PerlIO_printf(Perl_debug_log,
4927 "Copy on write: Force normal %ld\n",
4933 /* This SV doesn't own the buffer, so need to New() a new one: */
4934 SvPV_set(sv, (char*)0);
4936 if (flags & SV_COW_DROP_PV) {
4937 /* OK, so we don't need to copy our buffer. */
4940 SvGROW(sv, cur + 1);
4941 Move(pvx,SvPVX(sv),cur,char);
4945 sv_release_COW(sv, pvx, cur, len, hash, next);
4950 else if (IN_PERL_RUNTIME)
4951 Perl_croak(aTHX_ PL_no_modify);
4952 /* At this point I believe that I can drop the global SV mutex. */
4955 if (SvREADONLY(sv)) {
4957 char *pvx = SvPVX(sv);
4958 const int is_utf8 = SvUTF8(sv);
4959 STRLEN len = SvCUR(sv);
4960 U32 hash = SvUVX(sv);
4963 SvPV_set(sv, (char*)0);
4965 SvGROW(sv, len + 1);
4966 Move(pvx,SvPVX(sv),len,char);
4968 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4970 else if (IN_PERL_RUNTIME)
4971 Perl_croak(aTHX_ PL_no_modify);
4975 sv_unref_flags(sv, flags);
4976 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4981 =for apidoc sv_force_normal
4983 Undo various types of fakery on an SV: if the PV is a shared string, make
4984 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4985 an xpvmg. See also C<sv_force_normal_flags>.
4991 Perl_sv_force_normal(pTHX_ register SV *sv)
4993 sv_force_normal_flags(sv, 0);
4999 Efficient removal of characters from the beginning of the string buffer.
5000 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5001 the string buffer. The C<ptr> becomes the first character of the adjusted
5002 string. Uses the "OOK hack".
5003 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5004 refer to the same chunk of data.
5010 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5012 register STRLEN delta;
5013 if (!ptr || !SvPOKp(sv))
5015 delta = ptr - SvPVX(sv);
5016 SV_CHECK_THINKFIRST(sv);
5017 if (SvTYPE(sv) < SVt_PVIV)
5018 sv_upgrade(sv,SVt_PVIV);
5021 if (!SvLEN(sv)) { /* make copy of shared string */
5022 const char *pvx = SvPVX(sv);
5023 STRLEN len = SvCUR(sv);
5024 SvGROW(sv, len + 1);
5025 Move(pvx,SvPVX(sv),len,char);
5029 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5030 and we do that anyway inside the SvNIOK_off
5032 SvFLAGS(sv) |= SVf_OOK;
5035 SvLEN_set(sv, SvLEN(sv) - delta);
5036 SvCUR_set(sv, SvCUR(sv) - delta);
5037 SvPV_set(sv, SvPVX(sv) + delta);
5038 SvIV_set(sv, SvIVX(sv) + delta);
5041 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5042 * this function provided for binary compatibility only
5046 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5048 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5052 =for apidoc sv_catpvn
5054 Concatenates the string onto the end of the string which is in the SV. The
5055 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5056 status set, then the bytes appended should be valid UTF-8.
5057 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5059 =for apidoc sv_catpvn_flags
5061 Concatenates the string onto the end of the string which is in the SV. The
5062 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5063 status set, then the bytes appended should be valid UTF-8.
5064 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5065 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5066 in terms of this function.
5072 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5075 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5077 SvGROW(dsv, dlen + slen + 1);
5080 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5081 SvCUR_set(dsv, SvCUR(dsv) + slen);
5083 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5088 =for apidoc sv_catpvn_mg
5090 Like C<sv_catpvn>, but also handles 'set' magic.
5096 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5098 sv_catpvn(sv,ptr,len);
5102 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5103 * this function provided for binary compatibility only
5107 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5109 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5113 =for apidoc sv_catsv
5115 Concatenates the string from SV C<ssv> onto the end of the string in
5116 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5117 not 'set' magic. See C<sv_catsv_mg>.
5119 =for apidoc sv_catsv_flags
5121 Concatenates the string from SV C<ssv> onto the end of the string in
5122 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5123 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5124 and C<sv_catsv_nomg> are implemented in terms of this function.
5129 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5135 if ((spv = SvPV(ssv, slen))) {
5136 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5137 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5138 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5139 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5140 dsv->sv_flags doesn't have that bit set.
5141 Andy Dougherty 12 Oct 2001
5143 I32 sutf8 = DO_UTF8(ssv);
5146 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5148 dutf8 = DO_UTF8(dsv);
5150 if (dutf8 != sutf8) {
5152 /* Not modifying source SV, so taking a temporary copy. */
5153 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5155 sv_utf8_upgrade(csv);
5156 spv = SvPV(csv, slen);
5159 sv_utf8_upgrade_nomg(dsv);
5161 sv_catpvn_nomg(dsv, spv, slen);
5166 =for apidoc sv_catsv_mg
5168 Like C<sv_catsv>, but also handles 'set' magic.
5174 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5181 =for apidoc sv_catpv
5183 Concatenates the string onto the end of the string which is in the SV.
5184 If the SV has the UTF-8 status set, then the bytes appended should be
5185 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5190 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5192 register STRLEN len;
5198 junk = SvPV_force(sv, tlen);
5200 SvGROW(sv, tlen + len + 1);
5203 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5204 SvCUR_set(sv, SvCUR(sv) + len);
5205 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5210 =for apidoc sv_catpv_mg
5212 Like C<sv_catpv>, but also handles 'set' magic.
5218 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5227 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5228 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5235 Perl_newSV(pTHX_ STRLEN len)
5241 sv_upgrade(sv, SVt_PV);
5242 SvGROW(sv, len + 1);
5247 =for apidoc sv_magicext
5249 Adds magic to an SV, upgrading it if necessary. Applies the
5250 supplied vtable and returns a pointer to the magic added.
5252 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5253 In particular, you can add magic to SvREADONLY SVs, and add more than
5254 one instance of the same 'how'.
5256 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5257 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5258 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5259 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5261 (This is now used as a subroutine by C<sv_magic>.)
5266 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5267 const char* name, I32 namlen)
5271 if (SvTYPE(sv) < SVt_PVMG) {
5272 (void)SvUPGRADE(sv, SVt_PVMG);
5274 Newz(702,mg, 1, MAGIC);
5275 mg->mg_moremagic = SvMAGIC(sv);
5276 SvMAGIC_set(sv, mg);
5278 /* Sometimes a magic contains a reference loop, where the sv and
5279 object refer to each other. To prevent a reference loop that
5280 would prevent such objects being freed, we look for such loops
5281 and if we find one we avoid incrementing the object refcount.
5283 Note we cannot do this to avoid self-tie loops as intervening RV must
5284 have its REFCNT incremented to keep it in existence.
5287 if (!obj || obj == sv ||
5288 how == PERL_MAGIC_arylen ||
5289 how == PERL_MAGIC_qr ||
5290 how == PERL_MAGIC_symtab ||
5291 (SvTYPE(obj) == SVt_PVGV &&
5292 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5293 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5294 GvFORM(obj) == (CV*)sv)))
5299 mg->mg_obj = SvREFCNT_inc(obj);
5300 mg->mg_flags |= MGf_REFCOUNTED;
5303 /* Normal self-ties simply pass a null object, and instead of
5304 using mg_obj directly, use the SvTIED_obj macro to produce a
5305 new RV as needed. For glob "self-ties", we are tieing the PVIO
5306 with an RV obj pointing to the glob containing the PVIO. In
5307 this case, to avoid a reference loop, we need to weaken the
5311 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5312 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5318 mg->mg_len = namlen;
5321 mg->mg_ptr = savepvn(name, namlen);
5322 else if (namlen == HEf_SVKEY)
5323 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5325 mg->mg_ptr = (char *) name;
5327 mg->mg_virtual = vtable;
5331 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5336 =for apidoc sv_magic
5338 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5339 then adds a new magic item of type C<how> to the head of the magic list.
5341 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5342 handling of the C<name> and C<namlen> arguments.
5344 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5345 to add more than one instance of the same 'how'.
5351 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5353 const MGVTBL *vtable = 0;
5356 #ifdef PERL_COPY_ON_WRITE
5358 sv_force_normal_flags(sv, 0);
5360 if (SvREADONLY(sv)) {
5362 && how != PERL_MAGIC_regex_global
5363 && how != PERL_MAGIC_bm
5364 && how != PERL_MAGIC_fm
5365 && how != PERL_MAGIC_sv
5366 && how != PERL_MAGIC_backref
5369 Perl_croak(aTHX_ PL_no_modify);
5372 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5373 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5374 /* sv_magic() refuses to add a magic of the same 'how' as an
5377 if (how == PERL_MAGIC_taint)
5385 vtable = &PL_vtbl_sv;
5387 case PERL_MAGIC_overload:
5388 vtable = &PL_vtbl_amagic;
5390 case PERL_MAGIC_overload_elem:
5391 vtable = &PL_vtbl_amagicelem;
5393 case PERL_MAGIC_overload_table:
5394 vtable = &PL_vtbl_ovrld;
5397 vtable = &PL_vtbl_bm;
5399 case PERL_MAGIC_regdata:
5400 vtable = &PL_vtbl_regdata;
5402 case PERL_MAGIC_regdatum:
5403 vtable = &PL_vtbl_regdatum;
5405 case PERL_MAGIC_env:
5406 vtable = &PL_vtbl_env;
5409 vtable = &PL_vtbl_fm;
5411 case PERL_MAGIC_envelem:
5412 vtable = &PL_vtbl_envelem;
5414 case PERL_MAGIC_regex_global:
5415 vtable = &PL_vtbl_mglob;
5417 case PERL_MAGIC_isa:
5418 vtable = &PL_vtbl_isa;
5420 case PERL_MAGIC_isaelem:
5421 vtable = &PL_vtbl_isaelem;
5423 case PERL_MAGIC_nkeys:
5424 vtable = &PL_vtbl_nkeys;
5426 case PERL_MAGIC_dbfile:
5429 case PERL_MAGIC_dbline:
5430 vtable = &PL_vtbl_dbline;
5432 #ifdef USE_LOCALE_COLLATE
5433 case PERL_MAGIC_collxfrm:
5434 vtable = &PL_vtbl_collxfrm;
5436 #endif /* USE_LOCALE_COLLATE */
5437 case PERL_MAGIC_tied:
5438 vtable = &PL_vtbl_pack;
5440 case PERL_MAGIC_tiedelem:
5441 case PERL_MAGIC_tiedscalar:
5442 vtable = &PL_vtbl_packelem;
5445 vtable = &PL_vtbl_regexp;
5447 case PERL_MAGIC_sig:
5448 vtable = &PL_vtbl_sig;
5450 case PERL_MAGIC_sigelem:
5451 vtable = &PL_vtbl_sigelem;
5453 case PERL_MAGIC_taint:
5454 vtable = &PL_vtbl_taint;
5456 case PERL_MAGIC_uvar:
5457 vtable = &PL_vtbl_uvar;
5459 case PERL_MAGIC_vec:
5460 vtable = &PL_vtbl_vec;
5462 case PERL_MAGIC_arylen_p:
5463 case PERL_MAGIC_rhash:
5464 case PERL_MAGIC_symtab:
5465 case PERL_MAGIC_vstring:
5468 case PERL_MAGIC_utf8:
5469 vtable = &PL_vtbl_utf8;
5471 case PERL_MAGIC_substr:
5472 vtable = &PL_vtbl_substr;
5474 case PERL_MAGIC_defelem:
5475 vtable = &PL_vtbl_defelem;
5477 case PERL_MAGIC_glob:
5478 vtable = &PL_vtbl_glob;
5480 case PERL_MAGIC_arylen:
5481 vtable = &PL_vtbl_arylen;
5483 case PERL_MAGIC_pos:
5484 vtable = &PL_vtbl_pos;
5486 case PERL_MAGIC_backref:
5487 vtable = &PL_vtbl_backref;
5489 case PERL_MAGIC_ext:
5490 /* Reserved for use by extensions not perl internals. */
5491 /* Useful for attaching extension internal data to perl vars. */
5492 /* Note that multiple extensions may clash if magical scalars */
5493 /* etc holding private data from one are passed to another. */
5496 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5499 /* Rest of work is done else where */
5500 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5503 case PERL_MAGIC_taint:
5506 case PERL_MAGIC_ext:
5507 case PERL_MAGIC_dbfile:
5514 =for apidoc sv_unmagic
5516 Removes all magic of type C<type> from an SV.
5522 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5526 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5529 for (mg = *mgp; mg; mg = *mgp) {
5530 if (mg->mg_type == type) {
5531 const MGVTBL* const vtbl = mg->mg_virtual;
5532 *mgp = mg->mg_moremagic;
5533 if (vtbl && vtbl->svt_free)
5534 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5535 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5537 Safefree(mg->mg_ptr);
5538 else if (mg->mg_len == HEf_SVKEY)
5539 SvREFCNT_dec((SV*)mg->mg_ptr);
5540 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5541 Safefree(mg->mg_ptr);
5543 if (mg->mg_flags & MGf_REFCOUNTED)
5544 SvREFCNT_dec(mg->mg_obj);
5548 mgp = &mg->mg_moremagic;
5552 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5559 =for apidoc sv_rvweaken
5561 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5562 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5563 push a back-reference to this RV onto the array of backreferences
5564 associated with that magic.
5570 Perl_sv_rvweaken(pTHX_ SV *sv)
5573 if (!SvOK(sv)) /* let undefs pass */
5576 Perl_croak(aTHX_ "Can't weaken a nonreference");
5577 else if (SvWEAKREF(sv)) {
5578 if (ckWARN(WARN_MISC))
5579 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5583 sv_add_backref(tsv, sv);
5589 /* Give tsv backref magic if it hasn't already got it, then push a
5590 * back-reference to sv onto the array associated with the backref magic.
5594 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5598 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5599 av = (AV*)mg->mg_obj;
5602 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5603 /* av now has a refcnt of 2, which avoids it getting freed
5604 * before us during global cleanup. The extra ref is removed
5605 * by magic_killbackrefs() when tsv is being freed */
5607 if (AvFILLp(av) >= AvMAX(av)) {
5609 SV **svp = AvARRAY(av);
5610 for (i = AvFILLp(av); i >= 0; i--)
5612 svp[i] = sv; /* reuse the slot */
5615 av_extend(av, AvFILLp(av)+1);
5617 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5620 /* delete a back-reference to ourselves from the backref magic associated
5621 * with the SV we point to.
5625 S_sv_del_backref(pTHX_ SV *sv)
5632 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5633 Perl_croak(aTHX_ "panic: del_backref");
5634 av = (AV *)mg->mg_obj;
5636 for (i = AvFILLp(av); i >= 0; i--)
5637 if (svp[i] == sv) svp[i] = Nullsv;
5641 =for apidoc sv_insert
5643 Inserts a string at the specified offset/length within the SV. Similar to
5644 the Perl substr() function.
5650 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5654 register char *midend;
5655 register char *bigend;
5661 Perl_croak(aTHX_ "Can't modify non-existent substring");
5662 SvPV_force(bigstr, curlen);
5663 (void)SvPOK_only_UTF8(bigstr);
5664 if (offset + len > curlen) {
5665 SvGROW(bigstr, offset+len+1);
5666 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5667 SvCUR_set(bigstr, offset+len);
5671 i = littlelen - len;
5672 if (i > 0) { /* string might grow */
5673 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5674 mid = big + offset + len;
5675 midend = bigend = big + SvCUR(bigstr);
5678 while (midend > mid) /* shove everything down */
5679 *--bigend = *--midend;
5680 Move(little,big+offset,littlelen,char);
5681 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5686 Move(little,SvPVX(bigstr)+offset,len,char);
5691 big = SvPVX(bigstr);
5694 bigend = big + SvCUR(bigstr);
5696 if (midend > bigend)
5697 Perl_croak(aTHX_ "panic: sv_insert");
5699 if (mid - big > bigend - midend) { /* faster to shorten from end */
5701 Move(little, mid, littlelen,char);
5704 i = bigend - midend;
5706 Move(midend, mid, i,char);
5710 SvCUR_set(bigstr, mid - big);
5713 else if ((i = mid - big)) { /* faster from front */
5714 midend -= littlelen;
5716 sv_chop(bigstr,midend-i);
5721 Move(little, mid, littlelen,char);
5723 else if (littlelen) {
5724 midend -= littlelen;
5725 sv_chop(bigstr,midend);
5726 Move(little,midend,littlelen,char);
5729 sv_chop(bigstr,midend);
5735 =for apidoc sv_replace
5737 Make the first argument a copy of the second, then delete the original.
5738 The target SV physically takes over ownership of the body of the source SV
5739 and inherits its flags; however, the target keeps any magic it owns,
5740 and any magic in the source is discarded.
5741 Note that this is a rather specialist SV copying operation; most of the
5742 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5748 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5750 const U32 refcnt = SvREFCNT(sv);
5751 SV_CHECK_THINKFIRST_COW_DROP(sv);
5752 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5753 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5754 if (SvMAGICAL(sv)) {
5758 sv_upgrade(nsv, SVt_PVMG);
5759 SvMAGIC_set(nsv, SvMAGIC(sv));
5760 SvFLAGS(nsv) |= SvMAGICAL(sv);
5762 SvMAGIC_set(sv, NULL);
5766 assert(!SvREFCNT(sv));
5767 #ifdef DEBUG_LEAKING_SCALARS
5768 sv->sv_flags = nsv->sv_flags;
5769 sv->sv_any = nsv->sv_any;
5770 sv->sv_refcnt = nsv->sv_refcnt;
5772 StructCopy(nsv,sv,SV);
5774 /* Currently could join these into one piece of pointer arithmetic, but
5775 it would be unclear. */
5776 if(SvTYPE(sv) == SVt_IV)
5778 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5779 else if (SvTYPE(sv) == SVt_RV) {
5780 SvANY(sv) = &sv->sv_u.svu_rv;
5784 #ifdef PERL_COPY_ON_WRITE
5785 if (SvIsCOW_normal(nsv)) {
5786 /* We need to follow the pointers around the loop to make the
5787 previous SV point to sv, rather than nsv. */
5790 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5793 assert(SvPVX(current) == SvPVX(nsv));
5795 /* Make the SV before us point to the SV after us. */
5797 PerlIO_printf(Perl_debug_log, "previous is\n");
5799 PerlIO_printf(Perl_debug_log,
5800 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5801 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5803 SV_COW_NEXT_SV_SET(current, sv);
5806 SvREFCNT(sv) = refcnt;
5807 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5813 =for apidoc sv_clear
5815 Clear an SV: call any destructors, free up any memory used by the body,
5816 and free the body itself. The SV's head is I<not> freed, although
5817 its type is set to all 1's so that it won't inadvertently be assumed
5818 to be live during global destruction etc.
5819 This function should only be called when REFCNT is zero. Most of the time
5820 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5827 Perl_sv_clear(pTHX_ register SV *sv)
5832 assert(SvREFCNT(sv) == 0);
5835 if (PL_defstash) { /* Still have a symbol table? */
5842 stash = SvSTASH(sv);
5843 destructor = StashHANDLER(stash,DESTROY);
5845 SV* tmpref = newRV(sv);
5846 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5848 PUSHSTACKi(PERLSI_DESTROY);
5853 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5859 if(SvREFCNT(tmpref) < 2) {
5860 /* tmpref is not kept alive! */
5862 SvRV_set(tmpref, NULL);
5865 SvREFCNT_dec(tmpref);
5867 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5871 if (PL_in_clean_objs)
5872 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5874 /* DESTROY gave object new lease on life */
5880 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5881 SvOBJECT_off(sv); /* Curse the object. */
5882 if (SvTYPE(sv) != SVt_PVIO)
5883 --PL_sv_objcount; /* XXX Might want something more general */
5886 if (SvTYPE(sv) >= SVt_PVMG) {
5889 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5890 SvREFCNT_dec(SvSTASH(sv));
5893 switch (SvTYPE(sv)) {
5896 IoIFP(sv) != PerlIO_stdin() &&
5897 IoIFP(sv) != PerlIO_stdout() &&
5898 IoIFP(sv) != PerlIO_stderr())
5900 io_close((IO*)sv, FALSE);
5902 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5903 PerlDir_close(IoDIRP(sv));
5904 IoDIRP(sv) = (DIR*)NULL;
5905 Safefree(IoTOP_NAME(sv));
5906 Safefree(IoFMT_NAME(sv));
5907 Safefree(IoBOTTOM_NAME(sv));
5922 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5923 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5924 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5925 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5927 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5928 SvREFCNT_dec(LvTARG(sv));
5932 Safefree(GvNAME(sv));
5933 /* cannot decrease stash refcount yet, as we might recursively delete
5934 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5935 of stash until current sv is completely gone.
5936 -- JohnPC, 27 Mar 1998 */
5937 stash = GvSTASH(sv);
5943 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5945 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5946 /* Don't even bother with turning off the OOK flag. */
5955 SvREFCNT_dec(SvRV(sv));
5957 #ifdef PERL_COPY_ON_WRITE
5958 else if (SvPVX(sv)) {
5960 /* I believe I need to grab the global SV mutex here and
5961 then recheck the COW status. */
5963 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5966 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5967 SvUVX(sv), SV_COW_NEXT_SV(sv));
5968 /* And drop it here. */
5970 } else if (SvLEN(sv)) {
5971 Safefree(SvPVX(sv));
5975 else if (SvPVX(sv) && SvLEN(sv))
5976 Safefree(SvPVX(sv));
5977 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5978 unsharepvn(SvPVX(sv),
5979 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5993 switch (SvTYPE(sv)) {
6007 del_XPVIV(SvANY(sv));
6010 del_XPVNV(SvANY(sv));
6013 del_XPVMG(SvANY(sv));
6016 del_XPVLV(SvANY(sv));
6019 del_XPVAV(SvANY(sv));
6022 del_XPVHV(SvANY(sv));
6025 del_XPVCV(SvANY(sv));
6028 del_XPVGV(SvANY(sv));
6029 /* code duplication for increased performance. */
6030 SvFLAGS(sv) &= SVf_BREAK;
6031 SvFLAGS(sv) |= SVTYPEMASK;
6032 /* decrease refcount of the stash that owns this GV, if any */
6034 SvREFCNT_dec(stash);
6035 return; /* not break, SvFLAGS reset already happened */
6037 del_XPVBM(SvANY(sv));
6040 del_XPVFM(SvANY(sv));
6043 del_XPVIO(SvANY(sv));
6046 SvFLAGS(sv) &= SVf_BREAK;
6047 SvFLAGS(sv) |= SVTYPEMASK;
6051 =for apidoc sv_newref
6053 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6060 Perl_sv_newref(pTHX_ SV *sv)
6070 Decrement an SV's reference count, and if it drops to zero, call
6071 C<sv_clear> to invoke destructors and free up any memory used by
6072 the body; finally, deallocate the SV's head itself.
6073 Normally called via a wrapper macro C<SvREFCNT_dec>.
6079 Perl_sv_free(pTHX_ SV *sv)
6084 if (SvREFCNT(sv) == 0) {
6085 if (SvFLAGS(sv) & SVf_BREAK)
6086 /* this SV's refcnt has been artificially decremented to
6087 * trigger cleanup */
6089 if (PL_in_clean_all) /* All is fair */
6091 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6092 /* make sure SvREFCNT(sv)==0 happens very seldom */
6093 SvREFCNT(sv) = (~(U32)0)/2;
6096 if (ckWARN_d(WARN_INTERNAL))
6097 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6098 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6099 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6102 if (--(SvREFCNT(sv)) > 0)
6104 Perl_sv_free2(aTHX_ sv);
6108 Perl_sv_free2(pTHX_ SV *sv)
6113 if (ckWARN_d(WARN_DEBUGGING))
6114 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6115 "Attempt to free temp prematurely: SV 0x%"UVxf
6116 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6120 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6121 /* make sure SvREFCNT(sv)==0 happens very seldom */
6122 SvREFCNT(sv) = (~(U32)0)/2;
6133 Returns the length of the string in the SV. Handles magic and type
6134 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6140 Perl_sv_len(pTHX_ register SV *sv)
6148 len = mg_length(sv);
6150 (void)SvPV(sv, len);
6155 =for apidoc sv_len_utf8
6157 Returns the number of characters in the string in an SV, counting wide
6158 UTF-8 bytes as a single character. Handles magic and type coercion.
6164 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6165 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6166 * (Note that the mg_len is not the length of the mg_ptr field.)
6171 Perl_sv_len_utf8(pTHX_ register SV *sv)
6177 return mg_length(sv);
6181 const U8 *s = (U8*)SvPV(sv, len);
6182 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6184 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6186 #ifdef PERL_UTF8_CACHE_ASSERT
6187 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6191 ulen = Perl_utf8_length(aTHX_ s, s + len);
6192 if (!mg && !SvREADONLY(sv)) {
6193 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6194 mg = mg_find(sv, PERL_MAGIC_utf8);
6204 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6205 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6206 * between UTF-8 and byte offsets. There are two (substr offset and substr
6207 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6208 * and byte offset) cache positions.
6210 * The mg_len field is used by sv_len_utf8(), see its comments.
6211 * Note that the mg_len is not the length of the mg_ptr field.
6215 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
6219 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6221 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6225 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6227 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6228 (*mgp)->mg_ptr = (char *) *cachep;
6232 (*cachep)[i] = offsetp;
6233 (*cachep)[i+1] = s - start;
6241 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6242 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6243 * between UTF-8 and byte offsets. See also the comments of
6244 * S_utf8_mg_pos_init().
6248 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6252 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6254 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6255 if (*mgp && (*mgp)->mg_ptr) {
6256 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6257 ASSERT_UTF8_CACHE(*cachep);
6258 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6260 else { /* We will skip to the right spot. */
6265 /* The assumption is that going backward is half
6266 * the speed of going forward (that's where the
6267 * 2 * backw in the below comes from). (The real
6268 * figure of course depends on the UTF-8 data.) */
6270 if ((*cachep)[i] > (STRLEN)uoff) {
6272 backw = (*cachep)[i] - (STRLEN)uoff;
6274 if (forw < 2 * backw)
6277 p = start + (*cachep)[i+1];
6279 /* Try this only for the substr offset (i == 0),
6280 * not for the substr length (i == 2). */
6281 else if (i == 0) { /* (*cachep)[i] < uoff */
6282 const STRLEN ulen = sv_len_utf8(sv);
6284 if ((STRLEN)uoff < ulen) {
6285 forw = (STRLEN)uoff - (*cachep)[i];
6286 backw = ulen - (STRLEN)uoff;
6288 if (forw < 2 * backw)
6289 p = start + (*cachep)[i+1];
6294 /* If the string is not long enough for uoff,
6295 * we could extend it, but not at this low a level. */
6299 if (forw < 2 * backw) {
6306 while (UTF8_IS_CONTINUATION(*p))
6311 /* Update the cache. */
6312 (*cachep)[i] = (STRLEN)uoff;
6313 (*cachep)[i+1] = p - start;
6315 /* Drop the stale "length" cache */
6324 if (found) { /* Setup the return values. */
6325 *offsetp = (*cachep)[i+1];
6326 *sp = start + *offsetp;
6329 *offsetp = send - start;
6331 else if (*sp < start) {
6337 #ifdef PERL_UTF8_CACHE_ASSERT
6342 while (n-- && s < send)
6346 assert(*offsetp == s - start);
6347 assert((*cachep)[0] == (STRLEN)uoff);
6348 assert((*cachep)[1] == *offsetp);
6350 ASSERT_UTF8_CACHE(*cachep);
6359 =for apidoc sv_pos_u2b
6361 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6362 the start of the string, to a count of the equivalent number of bytes; if
6363 lenp is non-zero, it does the same to lenp, but this time starting from
6364 the offset, rather than from the start of the string. Handles magic and
6371 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6372 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6373 * byte offsets. See also the comments of S_utf8_mg_pos().
6378 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6389 start = s = (U8*)SvPV(sv, len);
6391 I32 uoffset = *offsetp;
6396 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6398 if (!found && uoffset > 0) {
6399 while (s < send && uoffset--)
6403 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6405 *offsetp = s - start;
6410 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6414 if (!found && *lenp > 0) {
6417 while (s < send && ulen--)
6421 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6425 ASSERT_UTF8_CACHE(cache);
6437 =for apidoc sv_pos_b2u
6439 Converts the value pointed to by offsetp from a count of bytes from the
6440 start of the string, to a count of the equivalent number of UTF-8 chars.
6441 Handles magic and type coercion.
6447 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6448 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6449 * byte offsets. See also the comments of S_utf8_mg_pos().
6454 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6462 s = (U8*)SvPV(sv, len);
6463 if ((I32)len < *offsetp)
6464 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6466 U8* send = s + *offsetp;
6468 STRLEN *cache = NULL;
6472 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6473 mg = mg_find(sv, PERL_MAGIC_utf8);
6474 if (mg && mg->mg_ptr) {
6475 cache = (STRLEN *) mg->mg_ptr;
6476 if (cache[1] == (STRLEN)*offsetp) {
6477 /* An exact match. */
6478 *offsetp = cache[0];
6482 else if (cache[1] < (STRLEN)*offsetp) {
6483 /* We already know part of the way. */
6486 /* Let the below loop do the rest. */
6488 else { /* cache[1] > *offsetp */
6489 /* We already know all of the way, now we may
6490 * be able to walk back. The same assumption
6491 * is made as in S_utf8_mg_pos(), namely that
6492 * walking backward is twice slower than
6493 * walking forward. */
6494 STRLEN forw = *offsetp;
6495 STRLEN backw = cache[1] - *offsetp;
6497 if (!(forw < 2 * backw)) {
6498 U8 *p = s + cache[1];
6505 while (UTF8_IS_CONTINUATION(*p)) {
6513 *offsetp = cache[0];
6515 /* Drop the stale "length" cache */
6523 ASSERT_UTF8_CACHE(cache);
6529 /* Call utf8n_to_uvchr() to validate the sequence
6530 * (unless a simple non-UTF character) */
6531 if (!UTF8_IS_INVARIANT(*s))
6532 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6541 if (!SvREADONLY(sv)) {
6543 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6544 mg = mg_find(sv, PERL_MAGIC_utf8);
6549 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6550 mg->mg_ptr = (char *) cache;
6555 cache[1] = *offsetp;
6556 /* Drop the stale "length" cache */
6569 Returns a boolean indicating whether the strings in the two SVs are
6570 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6571 coerce its args to strings if necessary.
6577 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6585 SV* svrecode = Nullsv;
6592 pv1 = SvPV(sv1, cur1);
6599 pv2 = SvPV(sv2, cur2);
6601 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6602 /* Differing utf8ness.
6603 * Do not UTF8size the comparands as a side-effect. */
6606 svrecode = newSVpvn(pv2, cur2);
6607 sv_recode_to_utf8(svrecode, PL_encoding);
6608 pv2 = SvPV(svrecode, cur2);
6611 svrecode = newSVpvn(pv1, cur1);
6612 sv_recode_to_utf8(svrecode, PL_encoding);
6613 pv1 = SvPV(svrecode, cur1);
6615 /* Now both are in UTF-8. */
6617 SvREFCNT_dec(svrecode);
6622 bool is_utf8 = TRUE;
6625 /* sv1 is the UTF-8 one,
6626 * if is equal it must be downgrade-able */
6627 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6633 /* sv2 is the UTF-8 one,
6634 * if is equal it must be downgrade-able */
6635 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6641 /* Downgrade not possible - cannot be eq */
6649 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6652 SvREFCNT_dec(svrecode);
6663 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6664 string in C<sv1> is less than, equal to, or greater than the string in
6665 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6666 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6672 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6675 const char *pv1, *pv2;
6678 SV *svrecode = Nullsv;
6685 pv1 = SvPV(sv1, cur1);
6692 pv2 = SvPV(sv2, cur2);
6694 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6695 /* Differing utf8ness.
6696 * Do not UTF8size the comparands as a side-effect. */
6699 svrecode = newSVpvn(pv2, cur2);
6700 sv_recode_to_utf8(svrecode, PL_encoding);
6701 pv2 = SvPV(svrecode, cur2);
6704 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6709 svrecode = newSVpvn(pv1, cur1);
6710 sv_recode_to_utf8(svrecode, PL_encoding);
6711 pv1 = SvPV(svrecode, cur1);
6714 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6720 cmp = cur2 ? -1 : 0;
6724 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6727 cmp = retval < 0 ? -1 : 1;
6728 } else if (cur1 == cur2) {
6731 cmp = cur1 < cur2 ? -1 : 1;
6736 SvREFCNT_dec(svrecode);
6745 =for apidoc sv_cmp_locale
6747 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6748 'use bytes' aware, handles get magic, and will coerce its args to strings
6749 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6755 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6757 #ifdef USE_LOCALE_COLLATE
6763 if (PL_collation_standard)
6767 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6769 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6771 if (!pv1 || !len1) {
6782 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6785 return retval < 0 ? -1 : 1;
6788 * When the result of collation is equality, that doesn't mean
6789 * that there are no differences -- some locales exclude some
6790 * characters from consideration. So to avoid false equalities,
6791 * we use the raw string as a tiebreaker.
6797 #endif /* USE_LOCALE_COLLATE */
6799 return sv_cmp(sv1, sv2);
6803 #ifdef USE_LOCALE_COLLATE
6806 =for apidoc sv_collxfrm
6808 Add Collate Transform magic to an SV if it doesn't already have it.
6810 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6811 scalar data of the variable, but transformed to such a format that a normal
6812 memory comparison can be used to compare the data according to the locale
6819 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6823 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6824 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6829 Safefree(mg->mg_ptr);
6831 if ((xf = mem_collxfrm(s, len, &xlen))) {
6832 if (SvREADONLY(sv)) {
6835 return xf + sizeof(PL_collation_ix);
6838 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6839 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6852 if (mg && mg->mg_ptr) {
6854 return mg->mg_ptr + sizeof(PL_collation_ix);
6862 #endif /* USE_LOCALE_COLLATE */
6867 Get a line from the filehandle and store it into the SV, optionally
6868 appending to the currently-stored string.
6874 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6878 register STDCHAR rslast;
6879 register STDCHAR *bp;
6885 if (SvTHINKFIRST(sv))
6886 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6887 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6889 However, perlbench says it's slower, because the existing swipe code
6890 is faster than copy on write.
6891 Swings and roundabouts. */
6892 (void)SvUPGRADE(sv, SVt_PV);
6897 if (PerlIO_isutf8(fp)) {
6899 sv_utf8_upgrade_nomg(sv);
6900 sv_pos_u2b(sv,&append,0);
6902 } else if (SvUTF8(sv)) {
6903 SV *tsv = NEWSV(0,0);
6904 sv_gets(tsv, fp, 0);
6905 sv_utf8_upgrade_nomg(tsv);
6906 SvCUR_set(sv,append);
6909 goto return_string_or_null;
6914 if (PerlIO_isutf8(fp))
6917 if (IN_PERL_COMPILETIME) {
6918 /* we always read code in line mode */
6922 else if (RsSNARF(PL_rs)) {
6923 /* If it is a regular disk file use size from stat() as estimate
6924 of amount we are going to read - may result in malloc-ing
6925 more memory than we realy need if layers bellow reduce
6926 size we read (e.g. CRLF or a gzip layer)
6929 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6930 const Off_t offset = PerlIO_tell(fp);
6931 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6932 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6938 else if (RsRECORD(PL_rs)) {
6942 /* Grab the size of the record we're getting */
6943 recsize = SvIV(SvRV(PL_rs));
6944 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6947 /* VMS wants read instead of fread, because fread doesn't respect */
6948 /* RMS record boundaries. This is not necessarily a good thing to be */
6949 /* doing, but we've got no other real choice - except avoid stdio
6950 as implementation - perhaps write a :vms layer ?
6952 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6954 bytesread = PerlIO_read(fp, buffer, recsize);
6958 SvCUR_set(sv, bytesread += append);
6959 buffer[bytesread] = '\0';
6960 goto return_string_or_null;
6962 else if (RsPARA(PL_rs)) {
6968 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6969 if (PerlIO_isutf8(fp)) {
6970 rsptr = SvPVutf8(PL_rs, rslen);
6973 if (SvUTF8(PL_rs)) {
6974 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6975 Perl_croak(aTHX_ "Wide character in $/");
6978 rsptr = SvPV(PL_rs, rslen);
6982 rslast = rslen ? rsptr[rslen - 1] : '\0';
6984 if (rspara) { /* have to do this both before and after */
6985 do { /* to make sure file boundaries work right */
6988 i = PerlIO_getc(fp);
6992 PerlIO_ungetc(fp,i);
6998 /* See if we know enough about I/O mechanism to cheat it ! */
7000 /* This used to be #ifdef test - it is made run-time test for ease
7001 of abstracting out stdio interface. One call should be cheap
7002 enough here - and may even be a macro allowing compile
7006 if (PerlIO_fast_gets(fp)) {
7009 * We're going to steal some values from the stdio struct
7010 * and put EVERYTHING in the innermost loop into registers.
7012 register STDCHAR *ptr;
7016 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7017 /* An ungetc()d char is handled separately from the regular
7018 * buffer, so we getc() it back out and stuff it in the buffer.
7020 i = PerlIO_getc(fp);
7021 if (i == EOF) return 0;
7022 *(--((*fp)->_ptr)) = (unsigned char) i;
7026 /* Here is some breathtakingly efficient cheating */
7028 cnt = PerlIO_get_cnt(fp); /* get count into register */
7029 /* make sure we have the room */
7030 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7031 /* Not room for all of it
7032 if we are looking for a separator and room for some
7034 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7035 /* just process what we have room for */
7036 shortbuffered = cnt - SvLEN(sv) + append + 1;
7037 cnt -= shortbuffered;
7041 /* remember that cnt can be negative */
7042 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7047 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7048 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7049 DEBUG_P(PerlIO_printf(Perl_debug_log,
7050 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7051 DEBUG_P(PerlIO_printf(Perl_debug_log,
7052 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7053 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7054 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7059 while (cnt > 0) { /* this | eat */
7061 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7062 goto thats_all_folks; /* screams | sed :-) */
7066 Copy(ptr, bp, cnt, char); /* this | eat */
7067 bp += cnt; /* screams | dust */
7068 ptr += cnt; /* louder | sed :-) */
7073 if (shortbuffered) { /* oh well, must extend */
7074 cnt = shortbuffered;
7076 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7078 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7079 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7083 DEBUG_P(PerlIO_printf(Perl_debug_log,
7084 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7085 PTR2UV(ptr),(long)cnt));
7086 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7088 DEBUG_P(PerlIO_printf(Perl_debug_log,
7089 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7090 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7091 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7093 /* This used to call 'filbuf' in stdio form, but as that behaves like
7094 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7095 another abstraction. */
7096 i = PerlIO_getc(fp); /* get more characters */
7098 DEBUG_P(PerlIO_printf(Perl_debug_log,
7099 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7100 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7101 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7103 cnt = PerlIO_get_cnt(fp);
7104 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7105 DEBUG_P(PerlIO_printf(Perl_debug_log,
7106 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7108 if (i == EOF) /* all done for ever? */
7109 goto thats_really_all_folks;
7111 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7113 SvGROW(sv, bpx + cnt + 2);
7114 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7116 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7118 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7119 goto thats_all_folks;
7123 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7124 memNE((char*)bp - rslen, rsptr, rslen))
7125 goto screamer; /* go back to the fray */
7126 thats_really_all_folks:
7128 cnt += shortbuffered;
7129 DEBUG_P(PerlIO_printf(Perl_debug_log,
7130 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7131 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7132 DEBUG_P(PerlIO_printf(Perl_debug_log,
7133 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7134 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7135 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7137 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7138 DEBUG_P(PerlIO_printf(Perl_debug_log,
7139 "Screamer: done, len=%ld, string=|%.*s|\n",
7140 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7144 /*The big, slow, and stupid way. */
7145 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7147 New(0, buf, 8192, STDCHAR);
7155 const register STDCHAR *bpe = buf + sizeof(buf);
7157 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7158 ; /* keep reading */
7162 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7163 /* Accomodate broken VAXC compiler, which applies U8 cast to
7164 * both args of ?: operator, causing EOF to change into 255
7167 i = (U8)buf[cnt - 1];
7173 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7175 sv_catpvn(sv, (char *) buf, cnt);
7177 sv_setpvn(sv, (char *) buf, cnt);
7179 if (i != EOF && /* joy */
7181 SvCUR(sv) < rslen ||
7182 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7186 * If we're reading from a TTY and we get a short read,
7187 * indicating that the user hit his EOF character, we need
7188 * to notice it now, because if we try to read from the TTY
7189 * again, the EOF condition will disappear.
7191 * The comparison of cnt to sizeof(buf) is an optimization
7192 * that prevents unnecessary calls to feof().
7196 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7200 #ifdef USE_HEAP_INSTEAD_OF_STACK
7205 if (rspara) { /* have to do this both before and after */
7206 while (i != EOF) { /* to make sure file boundaries work right */
7207 i = PerlIO_getc(fp);
7209 PerlIO_ungetc(fp,i);
7215 return_string_or_null:
7216 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7222 Auto-increment of the value in the SV, doing string to numeric conversion
7223 if necessary. Handles 'get' magic.
7229 Perl_sv_inc(pTHX_ register SV *sv)
7238 if (SvTHINKFIRST(sv)) {
7240 sv_force_normal_flags(sv, 0);
7241 if (SvREADONLY(sv)) {
7242 if (IN_PERL_RUNTIME)
7243 Perl_croak(aTHX_ PL_no_modify);
7247 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7249 i = PTR2IV(SvRV(sv));
7254 flags = SvFLAGS(sv);
7255 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7256 /* It's (privately or publicly) a float, but not tested as an
7257 integer, so test it to see. */
7259 flags = SvFLAGS(sv);
7261 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7262 /* It's publicly an integer, or privately an integer-not-float */
7263 #ifdef PERL_PRESERVE_IVUV
7267 if (SvUVX(sv) == UV_MAX)
7268 sv_setnv(sv, UV_MAX_P1);
7270 (void)SvIOK_only_UV(sv);
7271 SvUV_set(sv, SvUVX(sv) + 1);
7273 if (SvIVX(sv) == IV_MAX)
7274 sv_setuv(sv, (UV)IV_MAX + 1);
7276 (void)SvIOK_only(sv);
7277 SvIV_set(sv, SvIVX(sv) + 1);
7282 if (flags & SVp_NOK) {
7283 (void)SvNOK_only(sv);
7284 SvNV_set(sv, SvNVX(sv) + 1.0);
7288 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7289 if ((flags & SVTYPEMASK) < SVt_PVIV)
7290 sv_upgrade(sv, SVt_IV);
7291 (void)SvIOK_only(sv);
7296 while (isALPHA(*d)) d++;
7297 while (isDIGIT(*d)) d++;
7299 #ifdef PERL_PRESERVE_IVUV
7300 /* Got to punt this as an integer if needs be, but we don't issue
7301 warnings. Probably ought to make the sv_iv_please() that does
7302 the conversion if possible, and silently. */
7303 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7304 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7305 /* Need to try really hard to see if it's an integer.
7306 9.22337203685478e+18 is an integer.
7307 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7308 so $a="9.22337203685478e+18"; $a+0; $a++
7309 needs to be the same as $a="9.22337203685478e+18"; $a++
7316 /* sv_2iv *should* have made this an NV */
7317 if (flags & SVp_NOK) {
7318 (void)SvNOK_only(sv);
7319 SvNV_set(sv, SvNVX(sv) + 1.0);
7322 /* I don't think we can get here. Maybe I should assert this
7323 And if we do get here I suspect that sv_setnv will croak. NWC
7325 #if defined(USE_LONG_DOUBLE)
7326 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",
7327 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7329 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7330 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7333 #endif /* PERL_PRESERVE_IVUV */
7334 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7338 while (d >= SvPVX(sv)) {
7346 /* MKS: The original code here died if letters weren't consecutive.
7347 * at least it didn't have to worry about non-C locales. The
7348 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7349 * arranged in order (although not consecutively) and that only
7350 * [A-Za-z] are accepted by isALPHA in the C locale.
7352 if (*d != 'z' && *d != 'Z') {
7353 do { ++*d; } while (!isALPHA(*d));
7356 *(d--) -= 'z' - 'a';
7361 *(d--) -= 'z' - 'a' + 1;
7365 /* oh,oh, the number grew */
7366 SvGROW(sv, SvCUR(sv) + 2);
7367 SvCUR_set(sv, SvCUR(sv) + 1);
7368 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7379 Auto-decrement of the value in the SV, doing string to numeric conversion
7380 if necessary. Handles 'get' magic.
7386 Perl_sv_dec(pTHX_ register SV *sv)
7394 if (SvTHINKFIRST(sv)) {
7396 sv_force_normal_flags(sv, 0);
7397 if (SvREADONLY(sv)) {
7398 if (IN_PERL_RUNTIME)
7399 Perl_croak(aTHX_ PL_no_modify);
7403 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7405 i = PTR2IV(SvRV(sv));
7410 /* Unlike sv_inc we don't have to worry about string-never-numbers
7411 and keeping them magic. But we mustn't warn on punting */
7412 flags = SvFLAGS(sv);
7413 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7414 /* It's publicly an integer, or privately an integer-not-float */
7415 #ifdef PERL_PRESERVE_IVUV
7419 if (SvUVX(sv) == 0) {
7420 (void)SvIOK_only(sv);
7424 (void)SvIOK_only_UV(sv);
7425 SvUV_set(sv, SvUVX(sv) + 1);
7428 if (SvIVX(sv) == IV_MIN)
7429 sv_setnv(sv, (NV)IV_MIN - 1.0);
7431 (void)SvIOK_only(sv);
7432 SvIV_set(sv, SvIVX(sv) - 1);
7437 if (flags & SVp_NOK) {
7438 SvNV_set(sv, SvNVX(sv) - 1.0);
7439 (void)SvNOK_only(sv);
7442 if (!(flags & SVp_POK)) {
7443 if ((flags & SVTYPEMASK) < SVt_PVNV)
7444 sv_upgrade(sv, SVt_NV);
7446 (void)SvNOK_only(sv);
7449 #ifdef PERL_PRESERVE_IVUV
7451 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7452 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7453 /* Need to try really hard to see if it's an integer.
7454 9.22337203685478e+18 is an integer.
7455 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7456 so $a="9.22337203685478e+18"; $a+0; $a--
7457 needs to be the same as $a="9.22337203685478e+18"; $a--
7464 /* sv_2iv *should* have made this an NV */
7465 if (flags & SVp_NOK) {
7466 (void)SvNOK_only(sv);
7467 SvNV_set(sv, SvNVX(sv) - 1.0);
7470 /* I don't think we can get here. Maybe I should assert this
7471 And if we do get here I suspect that sv_setnv will croak. NWC
7473 #if defined(USE_LONG_DOUBLE)
7474 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",
7475 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7477 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7478 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7482 #endif /* PERL_PRESERVE_IVUV */
7483 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7487 =for apidoc sv_mortalcopy
7489 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7490 The new SV is marked as mortal. It will be destroyed "soon", either by an
7491 explicit call to FREETMPS, or by an implicit call at places such as
7492 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7497 /* Make a string that will exist for the duration of the expression
7498 * evaluation. Actually, it may have to last longer than that, but
7499 * hopefully we won't free it until it has been assigned to a
7500 * permanent location. */
7503 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7508 sv_setsv(sv,oldstr);
7510 PL_tmps_stack[++PL_tmps_ix] = sv;
7516 =for apidoc sv_newmortal
7518 Creates a new null SV which is mortal. The reference count of the SV is
7519 set to 1. It will be destroyed "soon", either by an explicit call to
7520 FREETMPS, or by an implicit call at places such as statement boundaries.
7521 See also C<sv_mortalcopy> and C<sv_2mortal>.
7527 Perl_sv_newmortal(pTHX)
7532 SvFLAGS(sv) = SVs_TEMP;
7534 PL_tmps_stack[++PL_tmps_ix] = sv;
7539 =for apidoc sv_2mortal
7541 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7542 by an explicit call to FREETMPS, or by an implicit call at places such as
7543 statement boundaries. SvTEMP() is turned on which means that the SV's
7544 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7545 and C<sv_mortalcopy>.
7551 Perl_sv_2mortal(pTHX_ register SV *sv)
7556 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7559 PL_tmps_stack[++PL_tmps_ix] = sv;
7567 Creates a new SV and copies a string into it. The reference count for the
7568 SV is set to 1. If C<len> is zero, Perl will compute the length using
7569 strlen(). For efficiency, consider using C<newSVpvn> instead.
7575 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7582 sv_setpvn(sv,s,len);
7587 =for apidoc newSVpvn
7589 Creates a new SV and copies a string into it. The reference count for the
7590 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7591 string. You are responsible for ensuring that the source string is at least
7592 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7598 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7603 sv_setpvn(sv,s,len);
7608 =for apidoc newSVpvn_share
7610 Creates a new SV with its SvPVX pointing to a shared string in the string
7611 table. If the string does not already exist in the table, it is created
7612 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7613 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7614 otherwise the hash is computed. The idea here is that as the string table
7615 is used for shared hash keys these strings will have SvPVX == HeKEY and
7616 hash lookup will avoid string compare.
7622 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7625 bool is_utf8 = FALSE;
7627 STRLEN tmplen = -len;
7629 /* See the note in hv.c:hv_fetch() --jhi */
7630 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7634 PERL_HASH(hash, src, len);
7636 sv_upgrade(sv, SVt_PVIV);
7637 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7650 #if defined(PERL_IMPLICIT_CONTEXT)
7652 /* pTHX_ magic can't cope with varargs, so this is a no-context
7653 * version of the main function, (which may itself be aliased to us).
7654 * Don't access this version directly.
7658 Perl_newSVpvf_nocontext(const char* pat, ...)
7663 va_start(args, pat);
7664 sv = vnewSVpvf(pat, &args);
7671 =for apidoc newSVpvf
7673 Creates a new SV and initializes it with the string formatted like
7680 Perl_newSVpvf(pTHX_ const char* pat, ...)
7684 va_start(args, pat);
7685 sv = vnewSVpvf(pat, &args);
7690 /* backend for newSVpvf() and newSVpvf_nocontext() */
7693 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7697 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7704 Creates a new SV and copies a floating point value into it.
7705 The reference count for the SV is set to 1.
7711 Perl_newSVnv(pTHX_ NV n)
7723 Creates a new SV and copies an integer into it. The reference count for the
7730 Perl_newSViv(pTHX_ IV i)
7742 Creates a new SV and copies an unsigned integer into it.
7743 The reference count for the SV is set to 1.
7749 Perl_newSVuv(pTHX_ UV u)
7759 =for apidoc newRV_noinc
7761 Creates an RV wrapper for an SV. The reference count for the original
7762 SV is B<not> incremented.
7768 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7773 sv_upgrade(sv, SVt_RV);
7775 SvRV_set(sv, tmpRef);
7780 /* newRV_inc is the official function name to use now.
7781 * newRV_inc is in fact #defined to newRV in sv.h
7785 Perl_newRV(pTHX_ SV *tmpRef)
7787 return newRV_noinc(SvREFCNT_inc(tmpRef));
7793 Creates a new SV which is an exact duplicate of the original SV.
7800 Perl_newSVsv(pTHX_ register SV *old)
7806 if (SvTYPE(old) == SVTYPEMASK) {
7807 if (ckWARN_d(WARN_INTERNAL))
7808 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7812 /* SV_GMAGIC is the default for sv_setv()
7813 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7814 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7815 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7820 =for apidoc sv_reset
7822 Underlying implementation for the C<reset> Perl function.
7823 Note that the perl-level function is vaguely deprecated.
7829 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7837 char todo[PERL_UCHAR_MAX+1];
7842 if (!*s) { /* reset ?? searches */
7843 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7845 PMOP *pm = (PMOP *) mg->mg_obj;
7847 pm->op_pmdynflags &= ~PMdf_USED;
7854 /* reset variables */
7856 if (!HvARRAY(stash))
7859 Zero(todo, 256, char);
7861 i = (unsigned char)*s;
7865 max = (unsigned char)*s++;
7866 for ( ; i <= max; i++) {
7869 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7870 for (entry = HvARRAY(stash)[i];
7872 entry = HeNEXT(entry))
7874 if (!todo[(U8)*HeKEY(entry)])
7876 gv = (GV*)HeVAL(entry);
7878 if (SvTHINKFIRST(sv)) {
7879 if (!SvREADONLY(sv) && SvROK(sv))
7884 if (SvTYPE(sv) >= SVt_PV) {
7886 if (SvPVX(sv) != Nullch)
7893 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7896 #ifdef USE_ENVIRON_ARRAY
7898 # ifdef USE_ITHREADS
7899 && PL_curinterp == aTHX
7903 environ[0] = Nullch;
7906 #endif /* !PERL_MICRO */
7916 Using various gambits, try to get an IO from an SV: the IO slot if its a
7917 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7918 named after the PV if we're a string.
7924 Perl_sv_2io(pTHX_ SV *sv)
7929 switch (SvTYPE(sv)) {
7937 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7941 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7943 return sv_2io(SvRV(sv));
7944 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7950 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7959 Using various gambits, try to get a CV from an SV; in addition, try if
7960 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7966 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7973 return *gvp = Nullgv, Nullcv;
7974 switch (SvTYPE(sv)) {
7993 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7994 tryAMAGICunDEREF(to_cv);
7997 if (SvTYPE(sv) == SVt_PVCV) {
8006 Perl_croak(aTHX_ "Not a subroutine reference");
8011 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8017 if (lref && !GvCVu(gv)) {
8020 tmpsv = NEWSV(704,0);
8021 gv_efullname3(tmpsv, gv, Nullch);
8022 /* XXX this is probably not what they think they're getting.
8023 * It has the same effect as "sub name;", i.e. just a forward
8025 newSUB(start_subparse(FALSE, 0),
8026 newSVOP(OP_CONST, 0, tmpsv),
8031 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8041 Returns true if the SV has a true value by Perl's rules.
8042 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8043 instead use an in-line version.
8049 Perl_sv_true(pTHX_ register SV *sv)
8054 const register XPV* tXpv;
8055 if ((tXpv = (XPV*)SvANY(sv)) &&
8056 (tXpv->xpv_cur > 1 ||
8057 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8064 return SvIVX(sv) != 0;
8067 return SvNVX(sv) != 0.0;
8069 return sv_2bool(sv);
8077 A private implementation of the C<SvIVx> macro for compilers which can't
8078 cope with complex macro expressions. Always use the macro instead.
8084 Perl_sv_iv(pTHX_ register SV *sv)
8088 return (IV)SvUVX(sv);
8097 A private implementation of the C<SvUVx> macro for compilers which can't
8098 cope with complex macro expressions. Always use the macro instead.
8104 Perl_sv_uv(pTHX_ register SV *sv)
8109 return (UV)SvIVX(sv);
8117 A private implementation of the C<SvNVx> macro for compilers which can't
8118 cope with complex macro expressions. Always use the macro instead.
8124 Perl_sv_nv(pTHX_ register SV *sv)
8131 /* sv_pv() is now a macro using SvPV_nolen();
8132 * this function provided for binary compatibility only
8136 Perl_sv_pv(pTHX_ SV *sv)
8143 return sv_2pv(sv, &n_a);
8149 Use the C<SvPV_nolen> macro instead
8153 A private implementation of the C<SvPV> macro for compilers which can't
8154 cope with complex macro expressions. Always use the macro instead.
8160 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8166 return sv_2pv(sv, lp);
8171 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8177 return sv_2pv_flags(sv, lp, 0);
8180 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8181 * this function provided for binary compatibility only
8185 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8187 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8191 =for apidoc sv_pvn_force
8193 Get a sensible string out of the SV somehow.
8194 A private implementation of the C<SvPV_force> macro for compilers which
8195 can't cope with complex macro expressions. Always use the macro instead.
8197 =for apidoc sv_pvn_force_flags
8199 Get a sensible string out of the SV somehow.
8200 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8201 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8202 implemented in terms of this function.
8203 You normally want to use the various wrapper macros instead: see
8204 C<SvPV_force> and C<SvPV_force_nomg>
8210 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8213 if (SvTHINKFIRST(sv) && !SvROK(sv))
8214 sv_force_normal_flags(sv, 0);
8221 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8222 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8226 s = sv_2pv_flags(sv, lp, flags);
8227 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8228 const STRLEN len = *lp;
8232 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8233 SvGROW(sv, len + 1);
8234 Move(s,SvPVX(sv),len,char);
8239 SvPOK_on(sv); /* validate pointer */
8241 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8242 PTR2UV(sv),SvPVX(sv)));
8248 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8249 * this function provided for binary compatibility only
8253 Perl_sv_pvbyte(pTHX_ SV *sv)
8255 sv_utf8_downgrade(sv,0);
8260 =for apidoc sv_pvbyte
8262 Use C<SvPVbyte_nolen> instead.
8264 =for apidoc sv_pvbyten
8266 A private implementation of the C<SvPVbyte> macro for compilers
8267 which can't cope with complex macro expressions. Always use the macro
8274 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8276 sv_utf8_downgrade(sv,0);
8277 return sv_pvn(sv,lp);
8281 =for apidoc sv_pvbyten_force
8283 A private implementation of the C<SvPVbytex_force> macro for compilers
8284 which can't cope with complex macro expressions. Always use the macro
8291 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8293 sv_pvn_force(sv,lp);
8294 sv_utf8_downgrade(sv,0);
8299 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8300 * this function provided for binary compatibility only
8304 Perl_sv_pvutf8(pTHX_ SV *sv)
8306 sv_utf8_upgrade(sv);
8311 =for apidoc sv_pvutf8
8313 Use the C<SvPVutf8_nolen> macro instead
8315 =for apidoc sv_pvutf8n
8317 A private implementation of the C<SvPVutf8> macro for compilers
8318 which can't cope with complex macro expressions. Always use the macro
8325 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8327 sv_utf8_upgrade(sv);
8328 return sv_pvn(sv,lp);
8332 =for apidoc sv_pvutf8n_force
8334 A private implementation of the C<SvPVutf8_force> macro for compilers
8335 which can't cope with complex macro expressions. Always use the macro
8342 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8344 sv_pvn_force(sv,lp);
8345 sv_utf8_upgrade(sv);
8351 =for apidoc sv_reftype
8353 Returns a string describing what the SV is a reference to.
8359 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8361 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8362 inside return suggests a const propagation bug in g++. */
8363 if (ob && SvOBJECT(sv)) {
8364 char *name = HvNAME_get(SvSTASH(sv));
8365 return name ? name : (char *) "__ANON__";
8368 switch (SvTYPE(sv)) {
8385 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8386 /* tied lvalues should appear to be
8387 * scalars for backwards compatitbility */
8388 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8389 ? "SCALAR" : "LVALUE");
8390 case SVt_PVAV: return "ARRAY";
8391 case SVt_PVHV: return "HASH";
8392 case SVt_PVCV: return "CODE";
8393 case SVt_PVGV: return "GLOB";
8394 case SVt_PVFM: return "FORMAT";
8395 case SVt_PVIO: return "IO";
8396 default: return "UNKNOWN";
8402 =for apidoc sv_isobject
8404 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8405 object. If the SV is not an RV, or if the object is not blessed, then this
8412 Perl_sv_isobject(pTHX_ SV *sv)
8429 Returns a boolean indicating whether the SV is blessed into the specified
8430 class. This does not check for subtypes; use C<sv_derived_from> to verify
8431 an inheritance relationship.
8437 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8449 hvname = HvNAME_get(SvSTASH(sv));
8453 return strEQ(hvname, name);
8459 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8460 it will be upgraded to one. If C<classname> is non-null then the new SV will
8461 be blessed in the specified package. The new SV is returned and its
8462 reference count is 1.
8468 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8474 SV_CHECK_THINKFIRST_COW_DROP(rv);
8477 if (SvTYPE(rv) >= SVt_PVMG) {
8478 const U32 refcnt = SvREFCNT(rv);
8482 SvREFCNT(rv) = refcnt;
8485 if (SvTYPE(rv) < SVt_RV)
8486 sv_upgrade(rv, SVt_RV);
8487 else if (SvTYPE(rv) > SVt_RV) {
8498 HV* stash = gv_stashpv(classname, TRUE);
8499 (void)sv_bless(rv, stash);
8505 =for apidoc sv_setref_pv
8507 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8508 argument will be upgraded to an RV. That RV will be modified to point to
8509 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8510 into the SV. The C<classname> argument indicates the package for the
8511 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8512 will have a reference count of 1, and the RV will be returned.
8514 Do not use with other Perl types such as HV, AV, SV, CV, because those
8515 objects will become corrupted by the pointer copy process.
8517 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8523 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8526 sv_setsv(rv, &PL_sv_undef);
8530 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8535 =for apidoc sv_setref_iv
8537 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8538 argument will be upgraded to an RV. That RV will be modified to point to
8539 the new SV. The C<classname> argument indicates the package for the
8540 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8541 will have a reference count of 1, and the RV will be returned.
8547 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8549 sv_setiv(newSVrv(rv,classname), iv);
8554 =for apidoc sv_setref_uv
8556 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8557 argument will be upgraded to an RV. That RV will be modified to point to
8558 the new SV. The C<classname> argument indicates the package for the
8559 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8560 will have a reference count of 1, and the RV will be returned.
8566 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8568 sv_setuv(newSVrv(rv,classname), uv);
8573 =for apidoc sv_setref_nv
8575 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8576 argument will be upgraded to an RV. That RV will be modified to point to
8577 the new SV. The C<classname> argument indicates the package for the
8578 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8579 will have a reference count of 1, and the RV will be returned.
8585 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8587 sv_setnv(newSVrv(rv,classname), nv);
8592 =for apidoc sv_setref_pvn
8594 Copies a string into a new SV, optionally blessing the SV. The length of the
8595 string must be specified with C<n>. The C<rv> argument will be upgraded to
8596 an RV. That RV will be modified to point to the new SV. The C<classname>
8597 argument indicates the package for the blessing. Set C<classname> to
8598 C<Nullch> to avoid the blessing. The new SV will have a reference count
8599 of 1, and the RV will be returned.
8601 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8607 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8609 sv_setpvn(newSVrv(rv,classname), pv, n);
8614 =for apidoc sv_bless
8616 Blesses an SV into a specified package. The SV must be an RV. The package
8617 must be designated by its stash (see C<gv_stashpv()>). The reference count
8618 of the SV is unaffected.
8624 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8628 Perl_croak(aTHX_ "Can't bless non-reference value");
8630 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8631 if (SvREADONLY(tmpRef))
8632 Perl_croak(aTHX_ PL_no_modify);
8633 if (SvOBJECT(tmpRef)) {
8634 if (SvTYPE(tmpRef) != SVt_PVIO)
8636 SvREFCNT_dec(SvSTASH(tmpRef));
8639 SvOBJECT_on(tmpRef);
8640 if (SvTYPE(tmpRef) != SVt_PVIO)
8642 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8643 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8650 if(SvSMAGICAL(tmpRef))
8651 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8659 /* Downgrades a PVGV to a PVMG.
8663 S_sv_unglob(pTHX_ SV *sv)
8667 assert(SvTYPE(sv) == SVt_PVGV);
8672 SvREFCNT_dec(GvSTASH(sv));
8673 GvSTASH(sv) = Nullhv;
8675 sv_unmagic(sv, PERL_MAGIC_glob);
8676 Safefree(GvNAME(sv));
8679 /* need to keep SvANY(sv) in the right arena */
8680 xpvmg = new_XPVMG();
8681 StructCopy(SvANY(sv), xpvmg, XPVMG);
8682 del_XPVGV(SvANY(sv));
8685 SvFLAGS(sv) &= ~SVTYPEMASK;
8686 SvFLAGS(sv) |= SVt_PVMG;
8690 =for apidoc sv_unref_flags
8692 Unsets the RV status of the SV, and decrements the reference count of
8693 whatever was being referenced by the RV. This can almost be thought of
8694 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8695 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8696 (otherwise the decrementing is conditional on the reference count being
8697 different from one or the reference being a readonly SV).
8704 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8708 if (SvWEAKREF(sv)) {
8716 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8717 assigned to as BEGIN {$a = \"Foo"} will fail. */
8718 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8720 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8721 sv_2mortal(rv); /* Schedule for freeing later */
8725 =for apidoc sv_unref
8727 Unsets the RV status of the SV, and decrements the reference count of
8728 whatever was being referenced by the RV. This can almost be thought of
8729 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8730 being zero. See C<SvROK_off>.
8736 Perl_sv_unref(pTHX_ SV *sv)
8738 sv_unref_flags(sv, 0);
8742 =for apidoc sv_taint
8744 Taint an SV. Use C<SvTAINTED_on> instead.
8749 Perl_sv_taint(pTHX_ SV *sv)
8751 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8755 =for apidoc sv_untaint
8757 Untaint an SV. Use C<SvTAINTED_off> instead.
8762 Perl_sv_untaint(pTHX_ SV *sv)
8764 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8765 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8772 =for apidoc sv_tainted
8774 Test an SV for taintedness. Use C<SvTAINTED> instead.
8779 Perl_sv_tainted(pTHX_ SV *sv)
8781 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8782 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8783 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8790 =for apidoc sv_setpviv
8792 Copies an integer into the given SV, also updating its string value.
8793 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8799 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8801 char buf[TYPE_CHARS(UV)];
8803 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8805 sv_setpvn(sv, ptr, ebuf - ptr);
8809 =for apidoc sv_setpviv_mg
8811 Like C<sv_setpviv>, but also handles 'set' magic.
8817 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8819 char buf[TYPE_CHARS(UV)];
8821 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8823 sv_setpvn(sv, ptr, ebuf - ptr);
8827 #if defined(PERL_IMPLICIT_CONTEXT)
8829 /* pTHX_ magic can't cope with varargs, so this is a no-context
8830 * version of the main function, (which may itself be aliased to us).
8831 * Don't access this version directly.
8835 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8839 va_start(args, pat);
8840 sv_vsetpvf(sv, pat, &args);
8844 /* pTHX_ magic can't cope with varargs, so this is a no-context
8845 * version of the main function, (which may itself be aliased to us).
8846 * Don't access this version directly.
8850 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8854 va_start(args, pat);
8855 sv_vsetpvf_mg(sv, pat, &args);
8861 =for apidoc sv_setpvf
8863 Works like C<sv_catpvf> but copies the text into the SV instead of
8864 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8870 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8873 va_start(args, pat);
8874 sv_vsetpvf(sv, pat, &args);
8879 =for apidoc sv_vsetpvf
8881 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8882 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8884 Usually used via its frontend C<sv_setpvf>.
8890 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8892 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8896 =for apidoc sv_setpvf_mg
8898 Like C<sv_setpvf>, but also handles 'set' magic.
8904 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8907 va_start(args, pat);
8908 sv_vsetpvf_mg(sv, pat, &args);
8913 =for apidoc sv_vsetpvf_mg
8915 Like C<sv_vsetpvf>, but also handles 'set' magic.
8917 Usually used via its frontend C<sv_setpvf_mg>.
8923 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8925 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8929 #if defined(PERL_IMPLICIT_CONTEXT)
8931 /* pTHX_ magic can't cope with varargs, so this is a no-context
8932 * version of the main function, (which may itself be aliased to us).
8933 * Don't access this version directly.
8937 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8941 va_start(args, pat);
8942 sv_vcatpvf(sv, pat, &args);
8946 /* pTHX_ magic can't cope with varargs, so this is a no-context
8947 * version of the main function, (which may itself be aliased to us).
8948 * Don't access this version directly.
8952 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8956 va_start(args, pat);
8957 sv_vcatpvf_mg(sv, pat, &args);
8963 =for apidoc sv_catpvf
8965 Processes its arguments like C<sprintf> and appends the formatted
8966 output to an SV. If the appended data contains "wide" characters
8967 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8968 and characters >255 formatted with %c), the original SV might get
8969 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8970 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8971 valid UTF-8; if the original SV was bytes, the pattern should be too.
8976 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8979 va_start(args, pat);
8980 sv_vcatpvf(sv, pat, &args);
8985 =for apidoc sv_vcatpvf
8987 Processes its arguments like C<vsprintf> and appends the formatted output
8988 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8990 Usually used via its frontend C<sv_catpvf>.
8996 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8998 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9002 =for apidoc sv_catpvf_mg
9004 Like C<sv_catpvf>, but also handles 'set' magic.
9010 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9013 va_start(args, pat);
9014 sv_vcatpvf_mg(sv, pat, &args);
9019 =for apidoc sv_vcatpvf_mg
9021 Like C<sv_vcatpvf>, but also handles 'set' magic.
9023 Usually used via its frontend C<sv_catpvf_mg>.
9029 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9031 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9036 =for apidoc sv_vsetpvfn
9038 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9041 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9047 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9049 sv_setpvn(sv, "", 0);
9050 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9053 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9056 S_expect_number(pTHX_ char** pattern)
9059 switch (**pattern) {
9060 case '1': case '2': case '3':
9061 case '4': case '5': case '6':
9062 case '7': case '8': case '9':
9063 while (isDIGIT(**pattern))
9064 var = var * 10 + (*(*pattern)++ - '0');
9068 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9071 F0convert(NV nv, char *endbuf, STRLEN *len)
9073 const int neg = nv < 0;
9082 if (uv & 1 && uv == nv)
9083 uv--; /* Round to even */
9085 const unsigned dig = uv % 10;
9098 =for apidoc sv_vcatpvfn
9100 Processes its arguments like C<vsprintf> and appends the formatted output
9101 to an SV. Uses an array of SVs if the C style variable argument list is
9102 missing (NULL). When running with taint checks enabled, indicates via
9103 C<maybe_tainted> if results are untrustworthy (often due to the use of
9106 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9111 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9114 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9121 static const char nullstr[] = "(null)";
9123 bool has_utf8; /* has the result utf8? */
9124 bool pat_utf8; /* the pattern is in utf8? */
9126 /* Times 4: a decimal digit takes more than 3 binary digits.
9127 * NV_DIG: mantissa takes than many decimal digits.
9128 * Plus 32: Playing safe. */
9129 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9130 /* large enough for "%#.#f" --chip */
9131 /* what about long double NVs? --jhi */
9133 has_utf8 = pat_utf8 = DO_UTF8(sv);
9135 /* no matter what, this is a string now */
9136 (void)SvPV_force(sv, origlen);
9138 /* special-case "", "%s", and "%-p" (SVf) */
9141 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9143 const char *s = va_arg(*args, char*);
9144 sv_catpv(sv, s ? s : nullstr);
9146 else if (svix < svmax) {
9147 sv_catsv(sv, *svargs);
9148 if (DO_UTF8(*svargs))
9153 if (patlen == 3 && pat[0] == '%' &&
9154 pat[1] == '-' && pat[2] == 'p') {
9156 argsv = va_arg(*args, SV*);
9157 sv_catsv(sv, argsv);
9164 #ifndef USE_LONG_DOUBLE
9165 /* special-case "%.<number>[gf]" */
9166 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9167 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9168 unsigned digits = 0;
9172 while (*pp >= '0' && *pp <= '9')
9173 digits = 10 * digits + (*pp++ - '0');
9174 if (pp - pat == (int)patlen - 1) {
9178 nv = (NV)va_arg(*args, double);
9179 else if (svix < svmax)
9184 /* Add check for digits != 0 because it seems that some
9185 gconverts are buggy in this case, and we don't yet have
9186 a Configure test for this. */
9187 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9188 /* 0, point, slack */
9189 Gconvert(nv, (int)digits, 0, ebuf);
9191 if (*ebuf) /* May return an empty string for digits==0 */
9194 } else if (!digits) {
9197 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9198 sv_catpvn(sv, p, l);
9204 #endif /* !USE_LONG_DOUBLE */
9206 if (!args && svix < svmax && DO_UTF8(*svargs))
9209 patend = (char*)pat + patlen;
9210 for (p = (char*)pat; p < patend; p = q) {
9213 bool vectorize = FALSE;
9214 bool vectorarg = FALSE;
9215 bool vec_utf8 = FALSE;
9221 bool has_precis = FALSE;
9224 bool is_utf8 = FALSE; /* is this item utf8? */
9225 #ifdef HAS_LDBL_SPRINTF_BUG
9226 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9227 with sfio - Allen <allens@cpan.org> */
9228 bool fix_ldbl_sprintf_bug = FALSE;
9232 U8 utf8buf[UTF8_MAXBYTES+1];
9233 STRLEN esignlen = 0;
9235 char *eptr = Nullch;
9238 U8 *vecstr = Null(U8*);
9245 /* we need a long double target in case HAS_LONG_DOUBLE but
9248 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9256 const char *dotstr = ".";
9257 STRLEN dotstrlen = 1;
9258 I32 efix = 0; /* explicit format parameter index */
9259 I32 ewix = 0; /* explicit width index */
9260 I32 epix = 0; /* explicit precision index */
9261 I32 evix = 0; /* explicit vector index */
9262 bool asterisk = FALSE;
9264 /* echo everything up to the next format specification */
9265 for (q = p; q < patend && *q != '%'; ++q) ;
9267 if (has_utf8 && !pat_utf8)
9268 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9270 sv_catpvn(sv, p, q - p);
9277 We allow format specification elements in this order:
9278 \d+\$ explicit format parameter index
9280 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9281 0 flag (as above): repeated to allow "v02"
9282 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9283 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9285 [%bcdefginopsux_DFOUX] format (mandatory)
9287 if (EXPECT_NUMBER(q, width)) {
9328 if (EXPECT_NUMBER(q, ewix))
9337 if ((vectorarg = asterisk)) {
9349 EXPECT_NUMBER(q, width);
9354 vecsv = va_arg(*args, SV*);
9356 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9357 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9358 dotstr = SvPVx(vecsv, dotstrlen);
9363 vecsv = va_arg(*args, SV*);
9364 vecstr = (U8*)SvPVx(vecsv,veclen);
9365 vec_utf8 = DO_UTF8(vecsv);
9367 else if (efix ? efix <= svmax : svix < svmax) {
9368 vecsv = svargs[efix ? efix-1 : svix++];
9369 vecstr = (U8*)SvPVx(vecsv,veclen);
9370 vec_utf8 = DO_UTF8(vecsv);
9371 /* if this is a version object, we need to return the
9372 * stringified representation (which the SvPVX has
9373 * already done for us), but not vectorize the args
9375 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9377 q++; /* skip past the rest of the %vd format */
9378 eptr = (char *) vecstr;
9379 elen = strlen(eptr);
9392 i = va_arg(*args, int);
9394 i = (ewix ? ewix <= svmax : svix < svmax) ?
9395 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9397 width = (i < 0) ? -i : i;
9407 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9409 /* XXX: todo, support specified precision parameter */
9413 i = va_arg(*args, int);
9415 i = (ewix ? ewix <= svmax : svix < svmax)
9416 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9417 precis = (i < 0) ? 0 : i;
9422 precis = precis * 10 + (*q++ - '0');
9431 case 'I': /* Ix, I32x, and I64x */
9433 if (q[1] == '6' && q[2] == '4') {
9439 if (q[1] == '3' && q[2] == '2') {
9449 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9460 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9461 if (*(q + 1) == 'l') { /* lld, llf */
9486 argsv = (efix ? efix <= svmax : svix < svmax) ?
9487 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9494 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9496 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9498 eptr = (char*)utf8buf;
9499 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9510 if (args && !vectorize) {
9511 eptr = va_arg(*args, char*);
9513 #ifdef MACOS_TRADITIONAL
9514 /* On MacOS, %#s format is used for Pascal strings */
9519 elen = strlen(eptr);
9521 eptr = (char *)nullstr;
9522 elen = sizeof nullstr - 1;
9526 eptr = SvPVx(argsv, elen);
9527 if (DO_UTF8(argsv)) {
9528 if (has_precis && precis < elen) {
9530 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9533 if (width) { /* fudge width (can't fudge elen) */
9534 width += elen - sv_len_utf8(argsv);
9542 if (has_precis && elen > precis)
9549 if (left && args) { /* SVf */
9558 argsv = va_arg(*args, SV*);
9559 eptr = SvPVx(argsv, elen);
9564 if (alt || vectorize)
9566 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9584 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9593 esignbuf[esignlen++] = plus;
9597 case 'h': iv = (short)va_arg(*args, int); break;
9598 case 'l': iv = va_arg(*args, long); break;
9599 case 'V': iv = va_arg(*args, IV); break;
9600 default: iv = va_arg(*args, int); break;
9602 case 'q': iv = va_arg(*args, Quad_t); break;
9607 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9609 case 'h': iv = (short)tiv; break;
9610 case 'l': iv = (long)tiv; break;
9612 default: iv = tiv; break;
9614 case 'q': iv = (Quad_t)tiv; break;
9618 if ( !vectorize ) /* we already set uv above */
9623 esignbuf[esignlen++] = plus;
9627 esignbuf[esignlen++] = '-';
9670 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9681 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9682 case 'l': uv = va_arg(*args, unsigned long); break;
9683 case 'V': uv = va_arg(*args, UV); break;
9684 default: uv = va_arg(*args, unsigned); break;
9686 case 'q': uv = va_arg(*args, Uquad_t); break;
9691 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9693 case 'h': uv = (unsigned short)tuv; break;
9694 case 'l': uv = (unsigned long)tuv; break;
9696 default: uv = tuv; break;
9698 case 'q': uv = (Uquad_t)tuv; break;
9704 eptr = ebuf + sizeof ebuf;
9710 p = (char*)((c == 'X')
9711 ? "0123456789ABCDEF" : "0123456789abcdef");
9717 esignbuf[esignlen++] = '0';
9718 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9724 *--eptr = '0' + dig;
9726 if (alt && *eptr != '0')
9732 *--eptr = '0' + dig;
9735 esignbuf[esignlen++] = '0';
9736 esignbuf[esignlen++] = 'b';
9739 default: /* it had better be ten or less */
9742 *--eptr = '0' + dig;
9743 } while (uv /= base);
9746 elen = (ebuf + sizeof ebuf) - eptr;
9749 zeros = precis - elen;
9750 else if (precis == 0 && elen == 1 && *eptr == '0')
9755 /* FLOATING POINT */
9758 c = 'f'; /* maybe %F isn't supported here */
9764 /* This is evil, but floating point is even more evil */
9766 /* for SV-style calling, we can only get NV
9767 for C-style calling, we assume %f is double;
9768 for simplicity we allow any of %Lf, %llf, %qf for long double
9772 #if defined(USE_LONG_DOUBLE)
9776 /* [perl #20339] - we should accept and ignore %lf rather than die */
9780 #if defined(USE_LONG_DOUBLE)
9781 intsize = args ? 0 : 'q';
9785 #if defined(HAS_LONG_DOUBLE)
9794 /* now we need (long double) if intsize == 'q', else (double) */
9795 nv = (args && !vectorize) ?
9796 #if LONG_DOUBLESIZE > DOUBLESIZE
9798 va_arg(*args, long double) :
9799 va_arg(*args, double)
9801 va_arg(*args, double)
9807 if (c != 'e' && c != 'E') {
9809 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9810 will cast our (long double) to (double) */
9811 (void)Perl_frexp(nv, &i);
9812 if (i == PERL_INT_MIN)
9813 Perl_die(aTHX_ "panic: frexp");
9815 need = BIT_DIGITS(i);
9817 need += has_precis ? precis : 6; /* known default */
9822 #ifdef HAS_LDBL_SPRINTF_BUG
9823 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9824 with sfio - Allen <allens@cpan.org> */
9827 # define MY_DBL_MAX DBL_MAX
9828 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9829 # if DOUBLESIZE >= 8
9830 # define MY_DBL_MAX 1.7976931348623157E+308L
9832 # define MY_DBL_MAX 3.40282347E+38L
9836 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9837 # define MY_DBL_MAX_BUG 1L
9839 # define MY_DBL_MAX_BUG MY_DBL_MAX
9843 # define MY_DBL_MIN DBL_MIN
9844 # else /* XXX guessing! -Allen */
9845 # if DOUBLESIZE >= 8
9846 # define MY_DBL_MIN 2.2250738585072014E-308L
9848 # define MY_DBL_MIN 1.17549435E-38L
9852 if ((intsize == 'q') && (c == 'f') &&
9853 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9855 /* it's going to be short enough that
9856 * long double precision is not needed */
9858 if ((nv <= 0L) && (nv >= -0L))
9859 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9861 /* would use Perl_fp_class as a double-check but not
9862 * functional on IRIX - see perl.h comments */
9864 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9865 /* It's within the range that a double can represent */
9866 #if defined(DBL_MAX) && !defined(DBL_MIN)
9867 if ((nv >= ((long double)1/DBL_MAX)) ||
9868 (nv <= (-(long double)1/DBL_MAX)))
9870 fix_ldbl_sprintf_bug = TRUE;
9873 if (fix_ldbl_sprintf_bug == TRUE) {
9883 # undef MY_DBL_MAX_BUG
9886 #endif /* HAS_LDBL_SPRINTF_BUG */
9888 need += 20; /* fudge factor */
9889 if (PL_efloatsize < need) {
9890 Safefree(PL_efloatbuf);
9891 PL_efloatsize = need + 20; /* more fudge */
9892 New(906, PL_efloatbuf, PL_efloatsize, char);
9893 PL_efloatbuf[0] = '\0';
9896 if ( !(width || left || plus || alt) && fill != '0'
9897 && has_precis && intsize != 'q' ) { /* Shortcuts */
9898 /* See earlier comment about buggy Gconvert when digits,
9900 if ( c == 'g' && precis) {
9901 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9902 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9903 goto float_converted;
9904 } else if ( c == 'f' && !precis) {
9905 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9909 eptr = ebuf + sizeof ebuf;
9912 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9913 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9914 if (intsize == 'q') {
9915 /* Copy the one or more characters in a long double
9916 * format before the 'base' ([efgEFG]) character to
9917 * the format string. */
9918 static char const prifldbl[] = PERL_PRIfldbl;
9919 char const *p = prifldbl + sizeof(prifldbl) - 3;
9920 while (p >= prifldbl) { *--eptr = *p--; }
9925 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9930 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9942 /* No taint. Otherwise we are in the strange situation
9943 * where printf() taints but print($float) doesn't.
9945 #if defined(HAS_LONG_DOUBLE)
9947 (void)sprintf(PL_efloatbuf, eptr, nv);
9949 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9951 (void)sprintf(PL_efloatbuf, eptr, nv);
9954 eptr = PL_efloatbuf;
9955 elen = strlen(PL_efloatbuf);
9961 i = SvCUR(sv) - origlen;
9962 if (args && !vectorize) {
9964 case 'h': *(va_arg(*args, short*)) = i; break;
9965 default: *(va_arg(*args, int*)) = i; break;
9966 case 'l': *(va_arg(*args, long*)) = i; break;
9967 case 'V': *(va_arg(*args, IV*)) = i; break;
9969 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9974 sv_setuv_mg(argsv, (UV)i);
9976 continue; /* not "break" */
9982 if (!args && ckWARN(WARN_PRINTF) &&
9983 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9984 SV *msg = sv_newmortal();
9985 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9986 (PL_op->op_type == OP_PRTF) ? "" : "s");
9989 Perl_sv_catpvf(aTHX_ msg,
9990 "\"%%%c\"", c & 0xFF);
9992 Perl_sv_catpvf(aTHX_ msg,
9993 "\"%%\\%03"UVof"\"",
9996 sv_catpv(msg, "end of string");
9997 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10000 /* output mangled stuff ... */
10006 /* ... right here, because formatting flags should not apply */
10007 SvGROW(sv, SvCUR(sv) + elen + 1);
10009 Copy(eptr, p, elen, char);
10012 SvCUR_set(sv, p - SvPVX(sv));
10014 continue; /* not "break" */
10017 /* calculate width before utf8_upgrade changes it */
10018 have = esignlen + zeros + elen;
10020 if (is_utf8 != has_utf8) {
10023 sv_utf8_upgrade(sv);
10026 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10027 sv_utf8_upgrade(nsv);
10031 SvGROW(sv, SvCUR(sv) + elen + 1);
10036 need = (have > width ? have : width);
10039 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10041 if (esignlen && fill == '0') {
10042 for (i = 0; i < (int)esignlen; i++)
10043 *p++ = esignbuf[i];
10045 if (gap && !left) {
10046 memset(p, fill, gap);
10049 if (esignlen && fill != '0') {
10050 for (i = 0; i < (int)esignlen; i++)
10051 *p++ = esignbuf[i];
10054 for (i = zeros; i; i--)
10058 Copy(eptr, p, elen, char);
10062 memset(p, ' ', gap);
10067 Copy(dotstr, p, dotstrlen, char);
10071 vectorize = FALSE; /* done iterating over vecstr */
10078 SvCUR_set(sv, p - SvPVX(sv));
10086 /* =========================================================================
10088 =head1 Cloning an interpreter
10090 All the macros and functions in this section are for the private use of
10091 the main function, perl_clone().
10093 The foo_dup() functions make an exact copy of an existing foo thinngy.
10094 During the course of a cloning, a hash table is used to map old addresses
10095 to new addresses. The table is created and manipulated with the
10096 ptr_table_* functions.
10100 ============================================================================*/
10103 #if defined(USE_ITHREADS)
10105 #ifndef GpREFCNT_inc
10106 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10110 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10111 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10112 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10113 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10114 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10115 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10116 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10117 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10118 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10119 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10120 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10121 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10122 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10125 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10126 regcomp.c. AMS 20010712 */
10129 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10134 struct reg_substr_datum *s;
10137 return (REGEXP *)NULL;
10139 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10142 len = r->offsets[0];
10143 npar = r->nparens+1;
10145 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10146 Copy(r->program, ret->program, len+1, regnode);
10148 New(0, ret->startp, npar, I32);
10149 Copy(r->startp, ret->startp, npar, I32);
10150 New(0, ret->endp, npar, I32);
10151 Copy(r->startp, ret->startp, npar, I32);
10153 New(0, ret->substrs, 1, struct reg_substr_data);
10154 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10155 s->min_offset = r->substrs->data[i].min_offset;
10156 s->max_offset = r->substrs->data[i].max_offset;
10157 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10158 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10161 ret->regstclass = NULL;
10163 struct reg_data *d;
10164 const int count = r->data->count;
10166 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10167 char, struct reg_data);
10168 New(0, d->what, count, U8);
10171 for (i = 0; i < count; i++) {
10172 d->what[i] = r->data->what[i];
10173 switch (d->what[i]) {
10174 /* legal options are one of: sfpont
10175 see also regcomp.h and pregfree() */
10177 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10180 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10183 /* This is cheating. */
10184 New(0, d->data[i], 1, struct regnode_charclass_class);
10185 StructCopy(r->data->data[i], d->data[i],
10186 struct regnode_charclass_class);
10187 ret->regstclass = (regnode*)d->data[i];
10190 /* Compiled op trees are readonly, and can thus be
10191 shared without duplication. */
10193 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10197 d->data[i] = r->data->data[i];
10200 d->data[i] = r->data->data[i];
10202 ((reg_trie_data*)d->data[i])->refcount++;
10206 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10215 New(0, ret->offsets, 2*len+1, U32);
10216 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10218 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10219 ret->refcnt = r->refcnt;
10220 ret->minlen = r->minlen;
10221 ret->prelen = r->prelen;
10222 ret->nparens = r->nparens;
10223 ret->lastparen = r->lastparen;
10224 ret->lastcloseparen = r->lastcloseparen;
10225 ret->reganch = r->reganch;
10227 ret->sublen = r->sublen;
10229 if (RX_MATCH_COPIED(ret))
10230 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10232 ret->subbeg = Nullch;
10233 #ifdef PERL_COPY_ON_WRITE
10234 ret->saved_copy = Nullsv;
10237 ptr_table_store(PL_ptr_table, r, ret);
10241 /* duplicate a file handle */
10244 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10250 return (PerlIO*)NULL;
10252 /* look for it in the table first */
10253 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10257 /* create anew and remember what it is */
10258 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10259 ptr_table_store(PL_ptr_table, fp, ret);
10263 /* duplicate a directory handle */
10266 Perl_dirp_dup(pTHX_ DIR *dp)
10274 /* duplicate a typeglob */
10277 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10282 /* look for it in the table first */
10283 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10287 /* create anew and remember what it is */
10288 Newz(0, ret, 1, GP);
10289 ptr_table_store(PL_ptr_table, gp, ret);
10292 ret->gp_refcnt = 0; /* must be before any other dups! */
10293 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10294 ret->gp_io = io_dup_inc(gp->gp_io, param);
10295 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10296 ret->gp_av = av_dup_inc(gp->gp_av, param);
10297 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10298 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10299 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10300 ret->gp_cvgen = gp->gp_cvgen;
10301 ret->gp_flags = gp->gp_flags;
10302 ret->gp_line = gp->gp_line;
10303 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10307 /* duplicate a chain of magic */
10310 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10312 MAGIC *mgprev = (MAGIC*)NULL;
10315 return (MAGIC*)NULL;
10316 /* look for it in the table first */
10317 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10321 for (; mg; mg = mg->mg_moremagic) {
10323 Newz(0, nmg, 1, MAGIC);
10325 mgprev->mg_moremagic = nmg;
10328 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10329 nmg->mg_private = mg->mg_private;
10330 nmg->mg_type = mg->mg_type;
10331 nmg->mg_flags = mg->mg_flags;
10332 if (mg->mg_type == PERL_MAGIC_qr) {
10333 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10335 else if(mg->mg_type == PERL_MAGIC_backref) {
10336 const AV * const av = (AV*) mg->mg_obj;
10339 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10341 for (i = AvFILLp(av); i >= 0; i--) {
10342 if (!svp[i]) continue;
10343 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10346 else if (mg->mg_type == PERL_MAGIC_symtab) {
10347 nmg->mg_obj = mg->mg_obj;
10350 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10351 ? sv_dup_inc(mg->mg_obj, param)
10352 : sv_dup(mg->mg_obj, param);
10354 nmg->mg_len = mg->mg_len;
10355 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10356 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10357 if (mg->mg_len > 0) {
10358 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10359 if (mg->mg_type == PERL_MAGIC_overload_table &&
10360 AMT_AMAGIC((AMT*)mg->mg_ptr))
10362 AMT *amtp = (AMT*)mg->mg_ptr;
10363 AMT *namtp = (AMT*)nmg->mg_ptr;
10365 for (i = 1; i < NofAMmeth; i++) {
10366 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10370 else if (mg->mg_len == HEf_SVKEY)
10371 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10373 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10374 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10381 /* create a new pointer-mapping table */
10384 Perl_ptr_table_new(pTHX)
10387 Newz(0, tbl, 1, PTR_TBL_t);
10388 tbl->tbl_max = 511;
10389 tbl->tbl_items = 0;
10390 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10395 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10397 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10405 struct ptr_tbl_ent* pte;
10406 struct ptr_tbl_ent* pteend;
10407 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10408 pte->next = PL_pte_arenaroot;
10409 PL_pte_arenaroot = pte;
10411 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10412 PL_pte_root = ++pte;
10413 while (pte < pteend) {
10414 pte->next = pte + 1;
10420 STATIC struct ptr_tbl_ent*
10423 struct ptr_tbl_ent* pte;
10427 PL_pte_root = pte->next;
10432 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10434 p->next = PL_pte_root;
10438 /* map an existing pointer using a table */
10441 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10443 PTR_TBL_ENT_t *tblent;
10444 const UV hash = PTR_TABLE_HASH(sv);
10446 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10447 for (; tblent; tblent = tblent->next) {
10448 if (tblent->oldval == sv)
10449 return tblent->newval;
10451 return (void*)NULL;
10454 /* add a new entry to a pointer-mapping table */
10457 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10459 PTR_TBL_ENT_t *tblent, **otblent;
10460 /* XXX this may be pessimal on platforms where pointers aren't good
10461 * hash values e.g. if they grow faster in the most significant
10463 const UV hash = PTR_TABLE_HASH(oldv);
10467 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10468 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10469 if (tblent->oldval == oldv) {
10470 tblent->newval = newv;
10474 tblent = S_new_pte(aTHX);
10475 tblent->oldval = oldv;
10476 tblent->newval = newv;
10477 tblent->next = *otblent;
10480 if (!empty && tbl->tbl_items > tbl->tbl_max)
10481 ptr_table_split(tbl);
10484 /* double the hash bucket size of an existing ptr table */
10487 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10489 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10490 const UV oldsize = tbl->tbl_max + 1;
10491 UV newsize = oldsize * 2;
10494 Renew(ary, newsize, PTR_TBL_ENT_t*);
10495 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10496 tbl->tbl_max = --newsize;
10497 tbl->tbl_ary = ary;
10498 for (i=0; i < oldsize; i++, ary++) {
10499 PTR_TBL_ENT_t **curentp, **entp, *ent;
10502 curentp = ary + oldsize;
10503 for (entp = ary, ent = *ary; ent; ent = *entp) {
10504 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10506 ent->next = *curentp;
10516 /* remove all the entries from a ptr table */
10519 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10521 register PTR_TBL_ENT_t **array;
10522 register PTR_TBL_ENT_t *entry;
10526 if (!tbl || !tbl->tbl_items) {
10530 array = tbl->tbl_ary;
10532 max = tbl->tbl_max;
10536 PTR_TBL_ENT_t *oentry = entry;
10537 entry = entry->next;
10538 S_del_pte(aTHX_ oentry);
10541 if (++riter > max) {
10544 entry = array[riter];
10548 tbl->tbl_items = 0;
10551 /* clear and free a ptr table */
10554 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10559 ptr_table_clear(tbl);
10560 Safefree(tbl->tbl_ary);
10564 /* attempt to make everything in the typeglob readonly */
10567 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10569 GV *gv = (GV*)sstr;
10570 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10572 if (GvIO(gv) || GvFORM(gv)) {
10573 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10575 else if (!GvCV(gv)) {
10576 GvCV(gv) = (CV*)sv;
10579 /* CvPADLISTs cannot be shared */
10580 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10585 if (!GvUNIQUE(gv)) {
10587 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10588 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10594 * write attempts will die with
10595 * "Modification of a read-only value attempted"
10601 SvREADONLY_on(GvSV(gv));
10605 GvAV(gv) = (AV*)sv;
10608 SvREADONLY_on(GvAV(gv));
10612 GvHV(gv) = (HV*)sv;
10615 SvREADONLY_on(GvHV(gv));
10618 return sstr; /* he_dup() will SvREFCNT_inc() */
10621 /* duplicate an SV of any type (including AV, HV etc) */
10624 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10627 SvRV_set(dstr, SvWEAKREF(sstr)
10628 ? sv_dup(SvRV(sstr), param)
10629 : sv_dup_inc(SvRV(sstr), param));
10632 else if (SvPVX(sstr)) {
10633 /* Has something there */
10635 /* Normal PV - clone whole allocated space */
10636 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1));
10637 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10638 /* Not that normal - actually sstr is copy on write.
10639 But we are a true, independant SV, so: */
10640 SvREADONLY_off(dstr);
10645 /* Special case - not normally malloced for some reason */
10646 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10647 /* A "shared" PV - clone it as unshared string */
10648 if(SvPADTMP(sstr)) {
10649 /* However, some of them live in the pad
10650 and they should not have these flags
10653 SvPV_set(dstr, sharepvn(SvPVX(sstr), SvCUR(sstr),
10655 SvUV_set(dstr, SvUVX(sstr));
10658 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvCUR(sstr)));
10660 SvREADONLY_off(dstr);
10664 /* Some other special case - random pointer */
10665 SvPV_set(dstr, SvPVX(sstr));
10670 /* Copy the Null */
10671 if (SvTYPE(dstr) == SVt_RV)
10672 SvRV_set(dstr, NULL);
10679 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10684 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10686 /* look for it in the table first */
10687 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10691 if(param->flags & CLONEf_JOIN_IN) {
10692 /** We are joining here so we don't want do clone
10693 something that is bad **/
10694 const char *hvname;
10696 if(SvTYPE(sstr) == SVt_PVHV &&
10697 (hvname = HvNAME_get(sstr))) {
10698 /** don't clone stashes if they already exist **/
10699 HV* old_stash = gv_stashpv(hvname,0);
10700 return (SV*) old_stash;
10704 /* create anew and remember what it is */
10707 #ifdef DEBUG_LEAKING_SCALARS
10708 dstr->sv_debug_optype = sstr->sv_debug_optype;
10709 dstr->sv_debug_line = sstr->sv_debug_line;
10710 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10711 dstr->sv_debug_cloned = 1;
10713 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10715 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10719 ptr_table_store(PL_ptr_table, sstr, dstr);
10722 SvFLAGS(dstr) = SvFLAGS(sstr);
10723 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10724 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10727 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10728 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10729 PL_watch_pvx, SvPVX(sstr));
10732 /* don't clone objects whose class has asked us not to */
10733 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10734 SvFLAGS(dstr) &= ~SVTYPEMASK;
10735 SvOBJECT_off(dstr);
10739 switch (SvTYPE(sstr)) {
10741 SvANY(dstr) = NULL;
10744 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10745 SvIV_set(dstr, SvIVX(sstr));
10748 SvANY(dstr) = new_XNV();
10749 SvNV_set(dstr, SvNVX(sstr));
10752 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10753 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10756 SvANY(dstr) = new_XPV();
10757 SvCUR_set(dstr, SvCUR(sstr));
10758 SvLEN_set(dstr, SvLEN(sstr));
10759 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10762 SvANY(dstr) = new_XPVIV();
10763 SvCUR_set(dstr, SvCUR(sstr));
10764 SvLEN_set(dstr, SvLEN(sstr));
10765 SvIV_set(dstr, SvIVX(sstr));
10766 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10769 SvANY(dstr) = new_XPVNV();
10770 SvCUR_set(dstr, SvCUR(sstr));
10771 SvLEN_set(dstr, SvLEN(sstr));
10772 SvIV_set(dstr, SvIVX(sstr));
10773 SvNV_set(dstr, SvNVX(sstr));
10774 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10777 SvANY(dstr) = new_XPVMG();
10778 SvCUR_set(dstr, SvCUR(sstr));
10779 SvLEN_set(dstr, SvLEN(sstr));
10780 SvIV_set(dstr, SvIVX(sstr));
10781 SvNV_set(dstr, SvNVX(sstr));
10782 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10783 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10784 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10787 SvANY(dstr) = new_XPVBM();
10788 SvCUR_set(dstr, SvCUR(sstr));
10789 SvLEN_set(dstr, SvLEN(sstr));
10790 SvIV_set(dstr, SvIVX(sstr));
10791 SvNV_set(dstr, SvNVX(sstr));
10792 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10793 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10794 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10795 BmRARE(dstr) = BmRARE(sstr);
10796 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10797 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10800 SvANY(dstr) = new_XPVLV();
10801 SvCUR_set(dstr, SvCUR(sstr));
10802 SvLEN_set(dstr, SvLEN(sstr));
10803 SvIV_set(dstr, SvIVX(sstr));
10804 SvNV_set(dstr, SvNVX(sstr));
10805 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10806 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10807 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10808 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10809 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10810 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10811 LvTARG(dstr) = dstr;
10812 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10813 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10815 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10816 LvTYPE(dstr) = LvTYPE(sstr);
10819 if (GvUNIQUE((GV*)sstr)) {
10821 if ((share = gv_share(sstr, param))) {
10824 ptr_table_store(PL_ptr_table, sstr, dstr);
10826 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10827 HvNAME_get(GvSTASH(share)), GvNAME(share));
10832 SvANY(dstr) = new_XPVGV();
10833 SvCUR_set(dstr, SvCUR(sstr));
10834 SvLEN_set(dstr, SvLEN(sstr));
10835 SvIV_set(dstr, SvIVX(sstr));
10836 SvNV_set(dstr, SvNVX(sstr));
10837 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10838 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10839 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10840 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10841 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10842 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10843 GvFLAGS(dstr) = GvFLAGS(sstr);
10844 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10845 (void)GpREFCNT_inc(GvGP(dstr));
10848 SvANY(dstr) = new_XPVIO();
10849 SvCUR_set(dstr, SvCUR(sstr));
10850 SvLEN_set(dstr, SvLEN(sstr));
10851 SvIV_set(dstr, SvIVX(sstr));
10852 SvNV_set(dstr, SvNVX(sstr));
10853 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10854 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10855 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10856 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10857 if (IoOFP(sstr) == IoIFP(sstr))
10858 IoOFP(dstr) = IoIFP(dstr);
10860 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10861 /* PL_rsfp_filters entries have fake IoDIRP() */
10862 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10863 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10865 IoDIRP(dstr) = IoDIRP(sstr);
10866 IoLINES(dstr) = IoLINES(sstr);
10867 IoPAGE(dstr) = IoPAGE(sstr);
10868 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10869 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10870 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10871 /* I have no idea why fake dirp (rsfps)
10872 should be treaded differently but otherwise
10873 we end up with leaks -- sky*/
10874 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10875 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10876 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10878 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10879 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10880 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10882 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10883 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10884 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10885 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10886 IoTYPE(dstr) = IoTYPE(sstr);
10887 IoFLAGS(dstr) = IoFLAGS(sstr);
10890 SvANY(dstr) = new_XPVAV();
10891 SvCUR_set(dstr, SvCUR(sstr));
10892 SvLEN_set(dstr, SvLEN(sstr));
10893 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10894 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10895 if (AvARRAY((AV*)sstr)) {
10896 SV **dst_ary, **src_ary;
10897 SSize_t items = AvFILLp((AV*)sstr) + 1;
10899 src_ary = AvARRAY((AV*)sstr);
10900 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10901 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10902 SvPV_set(dstr, (char*)dst_ary);
10903 AvALLOC((AV*)dstr) = dst_ary;
10904 if (AvREAL((AV*)sstr)) {
10905 while (items-- > 0)
10906 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10909 while (items-- > 0)
10910 *dst_ary++ = sv_dup(*src_ary++, param);
10912 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10913 while (items-- > 0) {
10914 *dst_ary++ = &PL_sv_undef;
10918 SvPV_set(dstr, Nullch);
10919 AvALLOC((AV*)dstr) = (SV**)NULL;
10923 SvANY(dstr) = new_XPVHV();
10924 SvCUR_set(dstr, SvCUR(sstr));
10925 SvLEN_set(dstr, SvLEN(sstr));
10926 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
10927 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10928 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10932 if (HvARRAY((HV*)sstr)) {
10934 bool sharekeys = !!HvSHAREKEYS(sstr);
10935 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10936 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10939 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10940 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
10941 HvARRAY(dstr) = (HE**)darray;
10942 while (i <= sxhv->xhv_max) {
10943 HE *source = HvARRAY(sstr)[i];
10945 = source ? he_dup(source, sharekeys, param) : 0;
10949 struct xpvhv_aux *saux = HvAUX(sstr);
10950 struct xpvhv_aux *daux = HvAUX(dstr);
10951 /* This flag isn't copied. */
10952 /* SvOOK_on(hv) attacks the IV flags. */
10953 SvFLAGS(dstr) |= SVf_OOK;
10955 hvname = saux->xhv_name;
10956 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10958 daux->xhv_riter = saux->xhv_riter;
10959 daux->xhv_eiter = saux->xhv_eiter
10960 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
10965 SvPV_set(dstr, Nullch);
10967 /* Record stashes for possible cloning in Perl_clone(). */
10969 av_push(param->stashes, dstr);
10973 SvANY(dstr) = new_XPVFM();
10974 FmLINES(dstr) = FmLINES(sstr);
10978 SvANY(dstr) = new_XPVCV();
10980 SvCUR_set(dstr, SvCUR(sstr));
10981 SvLEN_set(dstr, SvLEN(sstr));
10982 SvIV_set(dstr, SvIVX(sstr));
10983 SvNV_set(dstr, SvNVX(sstr));
10984 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10985 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10986 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10987 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10988 CvSTART(dstr) = CvSTART(sstr);
10990 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10992 CvXSUB(dstr) = CvXSUB(sstr);
10993 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10994 if (CvCONST(sstr)) {
10995 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10996 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10997 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
10999 /* don't dup if copying back - CvGV isn't refcounted, so the
11000 * duped GV may never be freed. A bit of a hack! DAPM */
11001 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11002 Nullgv : gv_dup(CvGV(sstr), param) ;
11003 if (param->flags & CLONEf_COPY_STACKS) {
11004 CvDEPTH(dstr) = CvDEPTH(sstr);
11008 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11009 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11011 CvWEAKOUTSIDE(sstr)
11012 ? cv_dup( CvOUTSIDE(sstr), param)
11013 : cv_dup_inc(CvOUTSIDE(sstr), param);
11014 CvFLAGS(dstr) = CvFLAGS(sstr);
11015 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11018 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11022 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11028 /* duplicate a context */
11031 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11033 PERL_CONTEXT *ncxs;
11036 return (PERL_CONTEXT*)NULL;
11038 /* look for it in the table first */
11039 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11043 /* create anew and remember what it is */
11044 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11045 ptr_table_store(PL_ptr_table, cxs, ncxs);
11048 PERL_CONTEXT *cx = &cxs[ix];
11049 PERL_CONTEXT *ncx = &ncxs[ix];
11050 ncx->cx_type = cx->cx_type;
11051 if (CxTYPE(cx) == CXt_SUBST) {
11052 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11055 ncx->blk_oldsp = cx->blk_oldsp;
11056 ncx->blk_oldcop = cx->blk_oldcop;
11057 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11058 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11059 ncx->blk_oldpm = cx->blk_oldpm;
11060 ncx->blk_gimme = cx->blk_gimme;
11061 switch (CxTYPE(cx)) {
11063 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11064 ? cv_dup_inc(cx->blk_sub.cv, param)
11065 : cv_dup(cx->blk_sub.cv,param));
11066 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11067 ? av_dup_inc(cx->blk_sub.argarray, param)
11069 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11070 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11071 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11072 ncx->blk_sub.lval = cx->blk_sub.lval;
11073 ncx->blk_sub.retop = cx->blk_sub.retop;
11076 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11077 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11078 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11079 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11080 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11081 ncx->blk_eval.retop = cx->blk_eval.retop;
11084 ncx->blk_loop.label = cx->blk_loop.label;
11085 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11086 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11087 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11088 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11089 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11090 ? cx->blk_loop.iterdata
11091 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11092 ncx->blk_loop.oldcomppad
11093 = (PAD*)ptr_table_fetch(PL_ptr_table,
11094 cx->blk_loop.oldcomppad);
11095 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11096 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11097 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11098 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11099 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11102 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11103 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11104 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11105 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11106 ncx->blk_sub.retop = cx->blk_sub.retop;
11118 /* duplicate a stack info structure */
11121 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11126 return (PERL_SI*)NULL;
11128 /* look for it in the table first */
11129 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11133 /* create anew and remember what it is */
11134 Newz(56, nsi, 1, PERL_SI);
11135 ptr_table_store(PL_ptr_table, si, nsi);
11137 nsi->si_stack = av_dup_inc(si->si_stack, param);
11138 nsi->si_cxix = si->si_cxix;
11139 nsi->si_cxmax = si->si_cxmax;
11140 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11141 nsi->si_type = si->si_type;
11142 nsi->si_prev = si_dup(si->si_prev, param);
11143 nsi->si_next = si_dup(si->si_next, param);
11144 nsi->si_markoff = si->si_markoff;
11149 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11150 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11151 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11152 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11153 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11154 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11155 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11156 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11157 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11158 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11159 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11160 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11161 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11162 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11165 #define pv_dup_inc(p) SAVEPV(p)
11166 #define pv_dup(p) SAVEPV(p)
11167 #define svp_dup_inc(p,pp) any_dup(p,pp)
11169 /* map any object to the new equivent - either something in the
11170 * ptr table, or something in the interpreter structure
11174 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11179 return (void*)NULL;
11181 /* look for it in the table first */
11182 ret = ptr_table_fetch(PL_ptr_table, v);
11186 /* see if it is part of the interpreter structure */
11187 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11188 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11196 /* duplicate the save stack */
11199 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11201 ANY *ss = proto_perl->Tsavestack;
11202 I32 ix = proto_perl->Tsavestack_ix;
11203 I32 max = proto_perl->Tsavestack_max;
11216 void (*dptr) (void*);
11217 void (*dxptr) (pTHX_ void*);
11219 /* Unions for circumventing strict ANSI C89 casting rules. */
11220 union { void *vptr; void (*dptr)(void*); } u1, u2;
11221 union { void *vptr; void (*dxptr)(pTHX_ void*); } u3, u4;
11223 Newz(54, nss, max, ANY);
11227 TOPINT(nss,ix) = i;
11229 case SAVEt_ITEM: /* normal string */
11230 sv = (SV*)POPPTR(ss,ix);
11231 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11232 sv = (SV*)POPPTR(ss,ix);
11233 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11235 case SAVEt_SV: /* scalar reference */
11236 sv = (SV*)POPPTR(ss,ix);
11237 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11238 gv = (GV*)POPPTR(ss,ix);
11239 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11241 case SAVEt_GENERIC_PVREF: /* generic char* */
11242 c = (char*)POPPTR(ss,ix);
11243 TOPPTR(nss,ix) = pv_dup(c);
11244 ptr = POPPTR(ss,ix);
11245 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11247 case SAVEt_SHARED_PVREF: /* char* in shared space */
11248 c = (char*)POPPTR(ss,ix);
11249 TOPPTR(nss,ix) = savesharedpv(c);
11250 ptr = POPPTR(ss,ix);
11251 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11253 case SAVEt_GENERIC_SVREF: /* generic sv */
11254 case SAVEt_SVREF: /* scalar reference */
11255 sv = (SV*)POPPTR(ss,ix);
11256 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11257 ptr = POPPTR(ss,ix);
11258 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11260 case SAVEt_AV: /* array reference */
11261 av = (AV*)POPPTR(ss,ix);
11262 TOPPTR(nss,ix) = av_dup_inc(av, param);
11263 gv = (GV*)POPPTR(ss,ix);
11264 TOPPTR(nss,ix) = gv_dup(gv, param);
11266 case SAVEt_HV: /* hash reference */
11267 hv = (HV*)POPPTR(ss,ix);
11268 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11269 gv = (GV*)POPPTR(ss,ix);
11270 TOPPTR(nss,ix) = gv_dup(gv, param);
11272 case SAVEt_INT: /* int reference */
11273 ptr = POPPTR(ss,ix);
11274 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11275 intval = (int)POPINT(ss,ix);
11276 TOPINT(nss,ix) = intval;
11278 case SAVEt_LONG: /* long reference */
11279 ptr = POPPTR(ss,ix);
11280 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11281 longval = (long)POPLONG(ss,ix);
11282 TOPLONG(nss,ix) = longval;
11284 case SAVEt_I32: /* I32 reference */
11285 case SAVEt_I16: /* I16 reference */
11286 case SAVEt_I8: /* I8 reference */
11287 ptr = POPPTR(ss,ix);
11288 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11290 TOPINT(nss,ix) = i;
11292 case SAVEt_IV: /* IV reference */
11293 ptr = POPPTR(ss,ix);
11294 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11296 TOPIV(nss,ix) = iv;
11298 case SAVEt_SPTR: /* SV* reference */
11299 ptr = POPPTR(ss,ix);
11300 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11301 sv = (SV*)POPPTR(ss,ix);
11302 TOPPTR(nss,ix) = sv_dup(sv, param);
11304 case SAVEt_VPTR: /* random* reference */
11305 ptr = POPPTR(ss,ix);
11306 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11307 ptr = POPPTR(ss,ix);
11308 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11310 case SAVEt_PPTR: /* char* reference */
11311 ptr = POPPTR(ss,ix);
11312 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11313 c = (char*)POPPTR(ss,ix);
11314 TOPPTR(nss,ix) = pv_dup(c);
11316 case SAVEt_HPTR: /* HV* reference */
11317 ptr = POPPTR(ss,ix);
11318 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11319 hv = (HV*)POPPTR(ss,ix);
11320 TOPPTR(nss,ix) = hv_dup(hv, param);
11322 case SAVEt_APTR: /* AV* reference */
11323 ptr = POPPTR(ss,ix);
11324 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11325 av = (AV*)POPPTR(ss,ix);
11326 TOPPTR(nss,ix) = av_dup(av, param);
11329 gv = (GV*)POPPTR(ss,ix);
11330 TOPPTR(nss,ix) = gv_dup(gv, param);
11332 case SAVEt_GP: /* scalar reference */
11333 gp = (GP*)POPPTR(ss,ix);
11334 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11335 (void)GpREFCNT_inc(gp);
11336 gv = (GV*)POPPTR(ss,ix);
11337 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11338 c = (char*)POPPTR(ss,ix);
11339 TOPPTR(nss,ix) = pv_dup(c);
11341 TOPIV(nss,ix) = iv;
11343 TOPIV(nss,ix) = iv;
11346 case SAVEt_MORTALIZESV:
11347 sv = (SV*)POPPTR(ss,ix);
11348 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11351 ptr = POPPTR(ss,ix);
11352 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11353 /* these are assumed to be refcounted properly */
11354 switch (((OP*)ptr)->op_type) {
11356 case OP_LEAVESUBLV:
11360 case OP_LEAVEWRITE:
11361 TOPPTR(nss,ix) = ptr;
11366 TOPPTR(nss,ix) = Nullop;
11371 TOPPTR(nss,ix) = Nullop;
11374 c = (char*)POPPTR(ss,ix);
11375 TOPPTR(nss,ix) = pv_dup_inc(c);
11377 case SAVEt_CLEARSV:
11378 longval = POPLONG(ss,ix);
11379 TOPLONG(nss,ix) = longval;
11382 hv = (HV*)POPPTR(ss,ix);
11383 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11384 c = (char*)POPPTR(ss,ix);
11385 TOPPTR(nss,ix) = pv_dup_inc(c);
11387 TOPINT(nss,ix) = i;
11389 case SAVEt_DESTRUCTOR:
11390 ptr = POPPTR(ss,ix);
11391 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11392 dptr = POPDPTR(ss,ix);
11394 u2.vptr = any_dup(u1.vptr, proto_perl);
11395 TOPDPTR(nss,ix) = u2.dptr;
11397 case SAVEt_DESTRUCTOR_X:
11398 ptr = POPPTR(ss,ix);
11399 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11400 dxptr = POPDXPTR(ss,ix);
11402 u4.vptr = any_dup(u3.vptr, proto_perl);;
11403 TOPDXPTR(nss,ix) = u4.dxptr;
11405 case SAVEt_REGCONTEXT:
11408 TOPINT(nss,ix) = i;
11411 case SAVEt_STACK_POS: /* Position on Perl stack */
11413 TOPINT(nss,ix) = i;
11415 case SAVEt_AELEM: /* array element */
11416 sv = (SV*)POPPTR(ss,ix);
11417 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11419 TOPINT(nss,ix) = i;
11420 av = (AV*)POPPTR(ss,ix);
11421 TOPPTR(nss,ix) = av_dup_inc(av, param);
11423 case SAVEt_HELEM: /* hash element */
11424 sv = (SV*)POPPTR(ss,ix);
11425 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11426 sv = (SV*)POPPTR(ss,ix);
11427 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11428 hv = (HV*)POPPTR(ss,ix);
11429 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11432 ptr = POPPTR(ss,ix);
11433 TOPPTR(nss,ix) = ptr;
11437 TOPINT(nss,ix) = i;
11439 case SAVEt_COMPPAD:
11440 av = (AV*)POPPTR(ss,ix);
11441 TOPPTR(nss,ix) = av_dup(av, param);
11444 longval = (long)POPLONG(ss,ix);
11445 TOPLONG(nss,ix) = longval;
11446 ptr = POPPTR(ss,ix);
11447 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11448 sv = (SV*)POPPTR(ss,ix);
11449 TOPPTR(nss,ix) = sv_dup(sv, param);
11452 ptr = POPPTR(ss,ix);
11453 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11454 longval = (long)POPBOOL(ss,ix);
11455 TOPBOOL(nss,ix) = (bool)longval;
11457 case SAVEt_SET_SVFLAGS:
11459 TOPINT(nss,ix) = i;
11461 TOPINT(nss,ix) = i;
11462 sv = (SV*)POPPTR(ss,ix);
11463 TOPPTR(nss,ix) = sv_dup(sv, param);
11466 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11474 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11475 * flag to the result. This is done for each stash before cloning starts,
11476 * so we know which stashes want their objects cloned */
11479 do_mark_cloneable_stash(pTHX_ SV *sv)
11481 const char *hvname = HvNAME_get((HV*)sv);
11483 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11484 STRLEN len = HvNAMELEN_get((HV*)sv);
11485 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11486 if (cloner && GvCV(cloner)) {
11493 XPUSHs(sv_2mortal(newSVpvn(hvname, len)));
11495 call_sv((SV*)GvCV(cloner), G_SCALAR);
11502 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11510 =for apidoc perl_clone
11512 Create and return a new interpreter by cloning the current one.
11514 perl_clone takes these flags as parameters:
11516 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11517 without it we only clone the data and zero the stacks,
11518 with it we copy the stacks and the new perl interpreter is
11519 ready to run at the exact same point as the previous one.
11520 The pseudo-fork code uses COPY_STACKS while the
11521 threads->new doesn't.
11523 CLONEf_KEEP_PTR_TABLE
11524 perl_clone keeps a ptr_table with the pointer of the old
11525 variable as a key and the new variable as a value,
11526 this allows it to check if something has been cloned and not
11527 clone it again but rather just use the value and increase the
11528 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11529 the ptr_table using the function
11530 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11531 reason to keep it around is if you want to dup some of your own
11532 variable who are outside the graph perl scans, example of this
11533 code is in threads.xs create
11536 This is a win32 thing, it is ignored on unix, it tells perls
11537 win32host code (which is c++) to clone itself, this is needed on
11538 win32 if you want to run two threads at the same time,
11539 if you just want to do some stuff in a separate perl interpreter
11540 and then throw it away and return to the original one,
11541 you don't need to do anything.
11546 /* XXX the above needs expanding by someone who actually understands it ! */
11547 EXTERN_C PerlInterpreter *
11548 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11551 perl_clone(PerlInterpreter *proto_perl, UV flags)
11554 #ifdef PERL_IMPLICIT_SYS
11556 /* perlhost.h so we need to call into it
11557 to clone the host, CPerlHost should have a c interface, sky */
11559 if (flags & CLONEf_CLONE_HOST) {
11560 return perl_clone_host(proto_perl,flags);
11562 return perl_clone_using(proto_perl, flags,
11564 proto_perl->IMemShared,
11565 proto_perl->IMemParse,
11567 proto_perl->IStdIO,
11571 proto_perl->IProc);
11575 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11576 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11577 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11578 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11579 struct IPerlDir* ipD, struct IPerlSock* ipS,
11580 struct IPerlProc* ipP)
11582 /* XXX many of the string copies here can be optimized if they're
11583 * constants; they need to be allocated as common memory and just
11584 * their pointers copied. */
11587 CLONE_PARAMS clone_params;
11588 CLONE_PARAMS* param = &clone_params;
11590 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11591 /* for each stash, determine whether its objects should be cloned */
11592 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11593 PERL_SET_THX(my_perl);
11596 Poison(my_perl, 1, PerlInterpreter);
11598 PL_curcop = (COP *)Nullop;
11602 PL_savestack_ix = 0;
11603 PL_savestack_max = -1;
11604 PL_sig_pending = 0;
11605 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11606 # else /* !DEBUGGING */
11607 Zero(my_perl, 1, PerlInterpreter);
11608 # endif /* DEBUGGING */
11610 /* host pointers */
11612 PL_MemShared = ipMS;
11613 PL_MemParse = ipMP;
11620 #else /* !PERL_IMPLICIT_SYS */
11622 CLONE_PARAMS clone_params;
11623 CLONE_PARAMS* param = &clone_params;
11624 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11625 /* for each stash, determine whether its objects should be cloned */
11626 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11627 PERL_SET_THX(my_perl);
11630 Poison(my_perl, 1, PerlInterpreter);
11632 PL_curcop = (COP *)Nullop;
11636 PL_savestack_ix = 0;
11637 PL_savestack_max = -1;
11638 PL_sig_pending = 0;
11639 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11640 # else /* !DEBUGGING */
11641 Zero(my_perl, 1, PerlInterpreter);
11642 # endif /* DEBUGGING */
11643 #endif /* PERL_IMPLICIT_SYS */
11644 param->flags = flags;
11645 param->proto_perl = proto_perl;
11648 PL_xnv_arenaroot = NULL;
11649 PL_xnv_root = NULL;
11650 PL_xpv_arenaroot = NULL;
11651 PL_xpv_root = NULL;
11652 PL_xpviv_arenaroot = NULL;
11653 PL_xpviv_root = NULL;
11654 PL_xpvnv_arenaroot = NULL;
11655 PL_xpvnv_root = NULL;
11656 PL_xpvcv_arenaroot = NULL;
11657 PL_xpvcv_root = NULL;
11658 PL_xpvav_arenaroot = NULL;
11659 PL_xpvav_root = NULL;
11660 PL_xpvhv_arenaroot = NULL;
11661 PL_xpvhv_root = NULL;
11662 PL_xpvmg_arenaroot = NULL;
11663 PL_xpvmg_root = NULL;
11664 PL_xpvgv_arenaroot = NULL;
11665 PL_xpvgv_root = NULL;
11666 PL_xpvlv_arenaroot = NULL;
11667 PL_xpvlv_root = NULL;
11668 PL_xpvbm_arenaroot = NULL;
11669 PL_xpvbm_root = NULL;
11670 PL_he_arenaroot = NULL;
11672 #if defined(USE_ITHREADS)
11673 PL_pte_arenaroot = NULL;
11674 PL_pte_root = NULL;
11676 PL_nice_chunk = NULL;
11677 PL_nice_chunk_size = 0;
11679 PL_sv_objcount = 0;
11680 PL_sv_root = Nullsv;
11681 PL_sv_arenaroot = Nullsv;
11683 PL_debug = proto_perl->Idebug;
11685 PL_hash_seed = proto_perl->Ihash_seed;
11686 PL_rehash_seed = proto_perl->Irehash_seed;
11688 #ifdef USE_REENTRANT_API
11689 /* XXX: things like -Dm will segfault here in perlio, but doing
11690 * PERL_SET_CONTEXT(proto_perl);
11691 * breaks too many other things
11693 Perl_reentrant_init(aTHX);
11696 /* create SV map for pointer relocation */
11697 PL_ptr_table = ptr_table_new();
11698 /* and one for finding shared hash keys quickly */
11699 PL_shared_hek_table = ptr_table_new();
11701 /* initialize these special pointers as early as possible */
11702 SvANY(&PL_sv_undef) = NULL;
11703 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11704 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11705 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11707 SvANY(&PL_sv_no) = new_XPVNV();
11708 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11709 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11710 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11711 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11712 SvCUR_set(&PL_sv_no, 0);
11713 SvLEN_set(&PL_sv_no, 1);
11714 SvIV_set(&PL_sv_no, 0);
11715 SvNV_set(&PL_sv_no, 0);
11716 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11718 SvANY(&PL_sv_yes) = new_XPVNV();
11719 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11720 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11721 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11722 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11723 SvCUR_set(&PL_sv_yes, 1);
11724 SvLEN_set(&PL_sv_yes, 2);
11725 SvIV_set(&PL_sv_yes, 1);
11726 SvNV_set(&PL_sv_yes, 1);
11727 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11729 /* create (a non-shared!) shared string table */
11730 PL_strtab = newHV();
11731 HvSHAREKEYS_off(PL_strtab);
11732 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11733 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11735 PL_compiling = proto_perl->Icompiling;
11737 /* These two PVs will be free'd special way so must set them same way op.c does */
11738 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11739 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11741 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11742 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11744 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11745 if (!specialWARN(PL_compiling.cop_warnings))
11746 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11747 if (!specialCopIO(PL_compiling.cop_io))
11748 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11749 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11751 /* pseudo environmental stuff */
11752 PL_origargc = proto_perl->Iorigargc;
11753 PL_origargv = proto_perl->Iorigargv;
11755 param->stashes = newAV(); /* Setup array of objects to call clone on */
11757 #ifdef PERLIO_LAYERS
11758 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11759 PerlIO_clone(aTHX_ proto_perl, param);
11762 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11763 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11764 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11765 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11766 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11767 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11770 PL_minus_c = proto_perl->Iminus_c;
11771 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11772 PL_localpatches = proto_perl->Ilocalpatches;
11773 PL_splitstr = proto_perl->Isplitstr;
11774 PL_preprocess = proto_perl->Ipreprocess;
11775 PL_minus_n = proto_perl->Iminus_n;
11776 PL_minus_p = proto_perl->Iminus_p;
11777 PL_minus_l = proto_perl->Iminus_l;
11778 PL_minus_a = proto_perl->Iminus_a;
11779 PL_minus_F = proto_perl->Iminus_F;
11780 PL_doswitches = proto_perl->Idoswitches;
11781 PL_dowarn = proto_perl->Idowarn;
11782 PL_doextract = proto_perl->Idoextract;
11783 PL_sawampersand = proto_perl->Isawampersand;
11784 PL_unsafe = proto_perl->Iunsafe;
11785 PL_inplace = SAVEPV(proto_perl->Iinplace);
11786 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11787 PL_perldb = proto_perl->Iperldb;
11788 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11789 PL_exit_flags = proto_perl->Iexit_flags;
11791 /* magical thingies */
11792 /* XXX time(&PL_basetime) when asked for? */
11793 PL_basetime = proto_perl->Ibasetime;
11794 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11796 PL_maxsysfd = proto_perl->Imaxsysfd;
11797 PL_multiline = proto_perl->Imultiline;
11798 PL_statusvalue = proto_perl->Istatusvalue;
11800 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11802 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11804 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11805 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11806 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11808 /* Clone the regex array */
11809 PL_regex_padav = newAV();
11811 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11812 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11813 av_push(PL_regex_padav,
11814 sv_dup_inc(regexen[0],param));
11815 for(i = 1; i <= len; i++) {
11816 if(SvREPADTMP(regexen[i])) {
11817 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11819 av_push(PL_regex_padav,
11821 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11822 SvIVX(regexen[i])), param)))
11827 PL_regex_pad = AvARRAY(PL_regex_padav);
11829 /* shortcuts to various I/O objects */
11830 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11831 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11832 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11833 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11834 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11835 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11837 /* shortcuts to regexp stuff */
11838 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11840 /* shortcuts to misc objects */
11841 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11843 /* shortcuts to debugging objects */
11844 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11845 PL_DBline = gv_dup(proto_perl->IDBline, param);
11846 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11847 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11848 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11849 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11850 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11851 PL_lineary = av_dup(proto_perl->Ilineary, param);
11852 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11854 /* symbol tables */
11855 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11856 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11857 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11858 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11859 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11861 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11862 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11863 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11864 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11865 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11866 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11868 PL_sub_generation = proto_perl->Isub_generation;
11870 /* funky return mechanisms */
11871 PL_forkprocess = proto_perl->Iforkprocess;
11873 /* subprocess state */
11874 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11876 /* internal state */
11877 PL_tainting = proto_perl->Itainting;
11878 PL_taint_warn = proto_perl->Itaint_warn;
11879 PL_maxo = proto_perl->Imaxo;
11880 if (proto_perl->Iop_mask)
11881 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11883 PL_op_mask = Nullch;
11884 /* PL_asserting = proto_perl->Iasserting; */
11886 /* current interpreter roots */
11887 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11888 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11889 PL_main_start = proto_perl->Imain_start;
11890 PL_eval_root = proto_perl->Ieval_root;
11891 PL_eval_start = proto_perl->Ieval_start;
11893 /* runtime control stuff */
11894 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11895 PL_copline = proto_perl->Icopline;
11897 PL_filemode = proto_perl->Ifilemode;
11898 PL_lastfd = proto_perl->Ilastfd;
11899 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11902 PL_gensym = proto_perl->Igensym;
11903 PL_preambled = proto_perl->Ipreambled;
11904 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11905 PL_laststatval = proto_perl->Ilaststatval;
11906 PL_laststype = proto_perl->Ilaststype;
11907 PL_mess_sv = Nullsv;
11909 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11910 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11912 /* interpreter atexit processing */
11913 PL_exitlistlen = proto_perl->Iexitlistlen;
11914 if (PL_exitlistlen) {
11915 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11916 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11919 PL_exitlist = (PerlExitListEntry*)NULL;
11920 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11921 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11922 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11924 PL_profiledata = NULL;
11925 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11926 /* PL_rsfp_filters entries have fake IoDIRP() */
11927 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11929 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11931 PAD_CLONE_VARS(proto_perl, param);
11933 #ifdef HAVE_INTERP_INTERN
11934 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11937 /* more statics moved here */
11938 PL_generation = proto_perl->Igeneration;
11939 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11941 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11942 PL_in_clean_all = proto_perl->Iin_clean_all;
11944 PL_uid = proto_perl->Iuid;
11945 PL_euid = proto_perl->Ieuid;
11946 PL_gid = proto_perl->Igid;
11947 PL_egid = proto_perl->Iegid;
11948 PL_nomemok = proto_perl->Inomemok;
11949 PL_an = proto_perl->Ian;
11950 PL_evalseq = proto_perl->Ievalseq;
11951 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11952 PL_origalen = proto_perl->Iorigalen;
11953 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11954 PL_osname = SAVEPV(proto_perl->Iosname);
11955 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11956 PL_sighandlerp = proto_perl->Isighandlerp;
11959 PL_runops = proto_perl->Irunops;
11961 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11964 PL_cshlen = proto_perl->Icshlen;
11965 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11968 PL_lex_state = proto_perl->Ilex_state;
11969 PL_lex_defer = proto_perl->Ilex_defer;
11970 PL_lex_expect = proto_perl->Ilex_expect;
11971 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11972 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11973 PL_lex_starts = proto_perl->Ilex_starts;
11974 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11975 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11976 PL_lex_op = proto_perl->Ilex_op;
11977 PL_lex_inpat = proto_perl->Ilex_inpat;
11978 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11979 PL_lex_brackets = proto_perl->Ilex_brackets;
11980 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11981 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11982 PL_lex_casemods = proto_perl->Ilex_casemods;
11983 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11984 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11986 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11987 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11988 PL_nexttoke = proto_perl->Inexttoke;
11990 /* XXX This is probably masking the deeper issue of why
11991 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11992 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11993 * (A little debugging with a watchpoint on it may help.)
11995 if (SvANY(proto_perl->Ilinestr)) {
11996 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11997 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11998 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11999 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
12000 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12001 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
12002 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12003 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
12004 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12007 PL_linestr = NEWSV(65,79);
12008 sv_upgrade(PL_linestr,SVt_PVIV);
12009 sv_setpvn(PL_linestr,"",0);
12010 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12012 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12013 PL_pending_ident = proto_perl->Ipending_ident;
12014 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12016 PL_expect = proto_perl->Iexpect;
12018 PL_multi_start = proto_perl->Imulti_start;
12019 PL_multi_end = proto_perl->Imulti_end;
12020 PL_multi_open = proto_perl->Imulti_open;
12021 PL_multi_close = proto_perl->Imulti_close;
12023 PL_error_count = proto_perl->Ierror_count;
12024 PL_subline = proto_perl->Isubline;
12025 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12027 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12028 if (SvANY(proto_perl->Ilinestr)) {
12029 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
12030 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12031 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
12032 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12033 PL_last_lop_op = proto_perl->Ilast_lop_op;
12036 PL_last_uni = SvPVX(PL_linestr);
12037 PL_last_lop = SvPVX(PL_linestr);
12038 PL_last_lop_op = 0;
12040 PL_in_my = proto_perl->Iin_my;
12041 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12043 PL_cryptseen = proto_perl->Icryptseen;
12046 PL_hints = proto_perl->Ihints;
12048 PL_amagic_generation = proto_perl->Iamagic_generation;
12050 #ifdef USE_LOCALE_COLLATE
12051 PL_collation_ix = proto_perl->Icollation_ix;
12052 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12053 PL_collation_standard = proto_perl->Icollation_standard;
12054 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12055 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12056 #endif /* USE_LOCALE_COLLATE */
12058 #ifdef USE_LOCALE_NUMERIC
12059 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12060 PL_numeric_standard = proto_perl->Inumeric_standard;
12061 PL_numeric_local = proto_perl->Inumeric_local;
12062 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12063 #endif /* !USE_LOCALE_NUMERIC */
12065 /* utf8 character classes */
12066 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12067 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12068 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12069 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12070 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12071 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12072 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12073 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12074 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12075 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12076 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12077 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12078 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12079 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12080 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12081 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12082 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12083 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12084 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12085 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12087 /* Did the locale setup indicate UTF-8? */
12088 PL_utf8locale = proto_perl->Iutf8locale;
12089 /* Unicode features (see perlrun/-C) */
12090 PL_unicode = proto_perl->Iunicode;
12092 /* Pre-5.8 signals control */
12093 PL_signals = proto_perl->Isignals;
12095 /* times() ticks per second */
12096 PL_clocktick = proto_perl->Iclocktick;
12098 /* Recursion stopper for PerlIO_find_layer */
12099 PL_in_load_module = proto_perl->Iin_load_module;
12101 /* sort() routine */
12102 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12104 /* Not really needed/useful since the reenrant_retint is "volatile",
12105 * but do it for consistency's sake. */
12106 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12108 /* Hooks to shared SVs and locks. */
12109 PL_sharehook = proto_perl->Isharehook;
12110 PL_lockhook = proto_perl->Ilockhook;
12111 PL_unlockhook = proto_perl->Iunlockhook;
12112 PL_threadhook = proto_perl->Ithreadhook;
12114 PL_runops_std = proto_perl->Irunops_std;
12115 PL_runops_dbg = proto_perl->Irunops_dbg;
12117 #ifdef THREADS_HAVE_PIDS
12118 PL_ppid = proto_perl->Ippid;
12122 PL_last_swash_hv = Nullhv; /* reinits on demand */
12123 PL_last_swash_klen = 0;
12124 PL_last_swash_key[0]= '\0';
12125 PL_last_swash_tmps = (U8*)NULL;
12126 PL_last_swash_slen = 0;
12128 PL_glob_index = proto_perl->Iglob_index;
12129 PL_srand_called = proto_perl->Isrand_called;
12130 PL_uudmap['M'] = 0; /* reinits on demand */
12131 PL_bitcount = Nullch; /* reinits on demand */
12133 if (proto_perl->Ipsig_pend) {
12134 Newz(0, PL_psig_pend, SIG_SIZE, int);
12137 PL_psig_pend = (int*)NULL;
12140 if (proto_perl->Ipsig_ptr) {
12141 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12142 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12143 for (i = 1; i < SIG_SIZE; i++) {
12144 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12145 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12149 PL_psig_ptr = (SV**)NULL;
12150 PL_psig_name = (SV**)NULL;
12153 /* thrdvar.h stuff */
12155 if (flags & CLONEf_COPY_STACKS) {
12156 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12157 PL_tmps_ix = proto_perl->Ttmps_ix;
12158 PL_tmps_max = proto_perl->Ttmps_max;
12159 PL_tmps_floor = proto_perl->Ttmps_floor;
12160 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12162 while (i <= PL_tmps_ix) {
12163 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12167 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12168 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12169 Newz(54, PL_markstack, i, I32);
12170 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12171 - proto_perl->Tmarkstack);
12172 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12173 - proto_perl->Tmarkstack);
12174 Copy(proto_perl->Tmarkstack, PL_markstack,
12175 PL_markstack_ptr - PL_markstack + 1, I32);
12177 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12178 * NOTE: unlike the others! */
12179 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12180 PL_scopestack_max = proto_perl->Tscopestack_max;
12181 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12182 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12184 /* NOTE: si_dup() looks at PL_markstack */
12185 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12187 /* PL_curstack = PL_curstackinfo->si_stack; */
12188 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12189 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12191 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12192 PL_stack_base = AvARRAY(PL_curstack);
12193 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12194 - proto_perl->Tstack_base);
12195 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12197 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12198 * NOTE: unlike the others! */
12199 PL_savestack_ix = proto_perl->Tsavestack_ix;
12200 PL_savestack_max = proto_perl->Tsavestack_max;
12201 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12202 PL_savestack = ss_dup(proto_perl, param);
12206 ENTER; /* perl_destruct() wants to LEAVE; */
12209 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12210 PL_top_env = &PL_start_env;
12212 PL_op = proto_perl->Top;
12215 PL_Xpv = (XPV*)NULL;
12216 PL_na = proto_perl->Tna;
12218 PL_statbuf = proto_perl->Tstatbuf;
12219 PL_statcache = proto_perl->Tstatcache;
12220 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12221 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12223 PL_timesbuf = proto_perl->Ttimesbuf;
12226 PL_tainted = proto_perl->Ttainted;
12227 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12228 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12229 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12230 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12231 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12232 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12233 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12234 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12235 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12237 PL_restartop = proto_perl->Trestartop;
12238 PL_in_eval = proto_perl->Tin_eval;
12239 PL_delaymagic = proto_perl->Tdelaymagic;
12240 PL_dirty = proto_perl->Tdirty;
12241 PL_localizing = proto_perl->Tlocalizing;
12243 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12244 PL_hv_fetch_ent_mh = Nullhe;
12245 PL_modcount = proto_perl->Tmodcount;
12246 PL_lastgotoprobe = Nullop;
12247 PL_dumpindent = proto_perl->Tdumpindent;
12249 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12250 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12251 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12252 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12253 PL_sortcxix = proto_perl->Tsortcxix;
12254 PL_efloatbuf = Nullch; /* reinits on demand */
12255 PL_efloatsize = 0; /* reinits on demand */
12259 PL_screamfirst = NULL;
12260 PL_screamnext = NULL;
12261 PL_maxscream = -1; /* reinits on demand */
12262 PL_lastscream = Nullsv;
12264 PL_watchaddr = NULL;
12265 PL_watchok = Nullch;
12267 PL_regdummy = proto_perl->Tregdummy;
12268 PL_regprecomp = Nullch;
12271 PL_colorset = 0; /* reinits PL_colors[] */
12272 /*PL_colors[6] = {0,0,0,0,0,0};*/
12273 PL_reginput = Nullch;
12274 PL_regbol = Nullch;
12275 PL_regeol = Nullch;
12276 PL_regstartp = (I32*)NULL;
12277 PL_regendp = (I32*)NULL;
12278 PL_reglastparen = (U32*)NULL;
12279 PL_reglastcloseparen = (U32*)NULL;
12280 PL_regtill = Nullch;
12281 PL_reg_start_tmp = (char**)NULL;
12282 PL_reg_start_tmpl = 0;
12283 PL_regdata = (struct reg_data*)NULL;
12286 PL_reg_eval_set = 0;
12288 PL_regprogram = (regnode*)NULL;
12290 PL_regcc = (CURCUR*)NULL;
12291 PL_reg_call_cc = (struct re_cc_state*)NULL;
12292 PL_reg_re = (regexp*)NULL;
12293 PL_reg_ganch = Nullch;
12294 PL_reg_sv = Nullsv;
12295 PL_reg_match_utf8 = FALSE;
12296 PL_reg_magic = (MAGIC*)NULL;
12298 PL_reg_oldcurpm = (PMOP*)NULL;
12299 PL_reg_curpm = (PMOP*)NULL;
12300 PL_reg_oldsaved = Nullch;
12301 PL_reg_oldsavedlen = 0;
12302 #ifdef PERL_COPY_ON_WRITE
12305 PL_reg_maxiter = 0;
12306 PL_reg_leftiter = 0;
12307 PL_reg_poscache = Nullch;
12308 PL_reg_poscache_size= 0;
12310 /* RE engine - function pointers */
12311 PL_regcompp = proto_perl->Tregcompp;
12312 PL_regexecp = proto_perl->Tregexecp;
12313 PL_regint_start = proto_perl->Tregint_start;
12314 PL_regint_string = proto_perl->Tregint_string;
12315 PL_regfree = proto_perl->Tregfree;
12317 PL_reginterp_cnt = 0;
12318 PL_reg_starttry = 0;
12320 /* Pluggable optimizer */
12321 PL_peepp = proto_perl->Tpeepp;
12323 PL_stashcache = newHV();
12325 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12326 ptr_table_free(PL_ptr_table);
12327 PL_ptr_table = NULL;
12328 ptr_table_free(PL_shared_hek_table);
12329 PL_shared_hek_table = NULL;
12332 /* Call the ->CLONE method, if it exists, for each of the stashes
12333 identified by sv_dup() above.
12335 while(av_len(param->stashes) != -1) {
12336 HV* stash = (HV*) av_shift(param->stashes);
12337 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12338 if (cloner && GvCV(cloner)) {
12343 XPUSHs(sv_2mortal(newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash))));
12345 call_sv((SV*)GvCV(cloner), G_DISCARD);
12351 SvREFCNT_dec(param->stashes);
12353 /* orphaned? eg threads->new inside BEGIN or use */
12354 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12355 (void)SvREFCNT_inc(PL_compcv);
12356 SAVEFREESV(PL_compcv);
12362 #endif /* USE_ITHREADS */
12365 =head1 Unicode Support
12367 =for apidoc sv_recode_to_utf8
12369 The encoding is assumed to be an Encode object, on entry the PV
12370 of the sv is assumed to be octets in that encoding, and the sv
12371 will be converted into Unicode (and UTF-8).
12373 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12374 is not a reference, nothing is done to the sv. If the encoding is not
12375 an C<Encode::XS> Encoding object, bad things will happen.
12376 (See F<lib/encoding.pm> and L<Encode>).
12378 The PV of the sv is returned.
12383 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12386 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12400 Passing sv_yes is wrong - it needs to be or'ed set of constants
12401 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12402 remove converted chars from source.
12404 Both will default the value - let them.
12406 XPUSHs(&PL_sv_yes);
12409 call_method("decode", G_SCALAR);
12413 s = SvPV(uni, len);
12414 if (s != SvPVX(sv)) {
12415 SvGROW(sv, len + 1);
12416 Move(s, SvPVX(sv), len, char);
12417 SvCUR_set(sv, len);
12418 SvPVX(sv)[len] = 0;
12425 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12429 =for apidoc sv_cat_decode
12431 The encoding is assumed to be an Encode object, the PV of the ssv is
12432 assumed to be octets in that encoding and decoding the input starts
12433 from the position which (PV + *offset) pointed to. The dsv will be
12434 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12435 when the string tstr appears in decoding output or the input ends on
12436 the PV of the ssv. The value which the offset points will be modified
12437 to the last input position on the ssv.
12439 Returns TRUE if the terminator was found, else returns FALSE.
12444 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12445 SV *ssv, int *offset, char *tstr, int tlen)
12449 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12460 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12461 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12463 call_method("cat_decode", G_SCALAR);
12465 ret = SvTRUE(TOPs);
12466 *offset = SvIV(offsv);
12472 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12478 * c-indentation-style: bsd
12479 * c-basic-offset: 4
12480 * indent-tabs-mode: t
12483 * ex: set ts=8 sts=4 sw=4 noet: