3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
763 if (!cv || !CvPADLIST(cv))
765 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
766 sv = *av_fetch(av, targ, FALSE);
767 /* SvLEN in a pad name is not to be trusted */
768 str = SvPV_const(sv,len);
769 sv_setpvn(name, str, len);
772 if (subscript_type == FUV_SUBSCRIPT_HASH) {
775 Perl_sv_catpvf(aTHX_ name, "{%s}",
776 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
779 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
781 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
783 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
784 sv_insert(name, 0, 0, "within ", 7);
791 =for apidoc find_uninit_var
793 Find the name of the undefined variable (if any) that caused the operator o
794 to issue a "Use of uninitialized value" warning.
795 If match is true, only return a name if it's value matches uninit_sv.
796 So roughly speaking, if a unary operator (such as OP_COS) generates a
797 warning, then following the direct child of the op may yield an
798 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
799 other hand, with OP_ADD there are two branches to follow, so we only print
800 the variable name if we get an exact match.
802 The name is returned as a mortal SV.
804 Assumes that PL_op is the op that originally triggered the error, and that
805 PL_comppad/PL_curpad points to the currently executing pad.
811 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
820 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
821 uninit_sv == &PL_sv_placeholder)))
824 switch (obase->op_type) {
831 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
832 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
835 int subscript_type = FUV_SUBSCRIPT_WITHIN;
837 if (pad) { /* @lex, %lex */
838 sv = PAD_SVl(obase->op_targ);
842 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
843 /* @global, %global */
844 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
847 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
849 else /* @{expr}, %{expr} */
850 return find_uninit_var(cUNOPx(obase)->op_first,
854 /* attempt to find a match within the aggregate */
856 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
858 subscript_type = FUV_SUBSCRIPT_HASH;
861 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
863 subscript_type = FUV_SUBSCRIPT_ARRAY;
866 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
869 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
870 keysv, index, subscript_type);
874 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
876 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
877 Nullsv, 0, FUV_SUBSCRIPT_NONE);
880 gv = cGVOPx_gv(obase);
881 if (!gv || (match && GvSV(gv) != uninit_sv))
883 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
886 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
888 av = (AV*)PAD_SV(obase->op_targ);
889 if (!av || SvRMAGICAL(av))
891 svp = av_fetch(av, (I32)obase->op_private, FALSE);
892 if (!svp || *svp != uninit_sv)
895 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
896 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
899 gv = cGVOPx_gv(obase);
904 if (!av || SvRMAGICAL(av))
906 svp = av_fetch(av, (I32)obase->op_private, FALSE);
907 if (!svp || *svp != uninit_sv)
910 return S_varname(aTHX_ gv, "$", 0,
911 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
916 o = cUNOPx(obase)->op_first;
917 if (!o || o->op_type != OP_NULL ||
918 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
920 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
925 /* $a[uninit_expr] or $h{uninit_expr} */
926 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
929 o = cBINOPx(obase)->op_first;
930 kid = cBINOPx(obase)->op_last;
932 /* get the av or hv, and optionally the gv */
934 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
935 sv = PAD_SV(o->op_targ);
937 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
938 && cUNOPo->op_first->op_type == OP_GV)
940 gv = cGVOPx_gv(cUNOPo->op_first);
943 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
948 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
949 /* index is constant */
953 if (obase->op_type == OP_HELEM) {
954 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
955 if (!he || HeVAL(he) != uninit_sv)
959 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
960 if (!svp || *svp != uninit_sv)
964 if (obase->op_type == OP_HELEM)
965 return S_varname(aTHX_ gv, "%", o->op_targ,
966 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
968 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
969 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
973 /* index is an expression;
974 * attempt to find a match within the aggregate */
975 if (obase->op_type == OP_HELEM) {
976 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
978 return S_varname(aTHX_ gv, "%", o->op_targ,
979 keysv, 0, FUV_SUBSCRIPT_HASH);
982 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
984 return S_varname(aTHX_ gv, "@", o->op_targ,
985 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
989 return S_varname(aTHX_ gv,
990 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
992 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
998 /* only examine RHS */
999 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
1002 o = cUNOPx(obase)->op_first;
1003 if (o->op_type == OP_PUSHMARK)
1006 if (!o->op_sibling) {
1007 /* one-arg version of open is highly magical */
1009 if (o->op_type == OP_GV) { /* open FOO; */
1011 if (match && GvSV(gv) != uninit_sv)
1013 return S_varname(aTHX_ gv, "$", 0,
1014 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1016 /* other possibilities not handled are:
1017 * open $x; or open my $x; should return '${*$x}'
1018 * open expr; should return '$'.expr ideally
1024 /* ops where $_ may be an implicit arg */
1028 if ( !(obase->op_flags & OPf_STACKED)) {
1029 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1030 ? PAD_SVl(obase->op_targ)
1033 sv = sv_newmortal();
1034 sv_setpvn(sv, "$_", 2);
1042 /* skip filehandle as it can't produce 'undef' warning */
1043 o = cUNOPx(obase)->op_first;
1044 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1045 o = o->op_sibling->op_sibling;
1052 match = 1; /* XS or custom code could trigger random warnings */
1057 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1058 return sv_2mortal(newSVpv("${$/}", 0));
1063 if (!(obase->op_flags & OPf_KIDS))
1065 o = cUNOPx(obase)->op_first;
1071 /* if all except one arg are constant, or have no side-effects,
1072 * or are optimized away, then it's unambiguous */
1074 for (kid=o; kid; kid = kid->op_sibling) {
1076 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1077 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1078 || (kid->op_type == OP_PUSHMARK)
1082 if (o2) { /* more than one found */
1089 return find_uninit_var(o2, uninit_sv, match);
1093 sv = find_uninit_var(o, uninit_sv, 1);
1105 =for apidoc report_uninit
1107 Print appropriate "Use of uninitialized variable" warning
1113 Perl_report_uninit(pTHX_ SV* uninit_sv)
1116 SV* varname = Nullsv;
1118 varname = find_uninit_var(PL_op, uninit_sv,0);
1120 sv_insert(varname, 0, 0, " ", 1);
1122 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1123 varname ? SvPV_nolen_const(varname) : "",
1124 " in ", OP_DESC(PL_op));
1127 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1131 /* allocate another arena's worth of NV bodies */
1139 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1140 *((void **) ptr) = (void *)PL_xnv_arenaroot;
1141 PL_xnv_arenaroot = ptr;
1144 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1145 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1147 while (xnv < xnvend) {
1148 *(NV**)xnv = (NV*)(xnv + 1);
1154 /* allocate another arena's worth of struct xpv */
1160 xpv_allocated* xpvend;
1161 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1162 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
1163 PL_xpv_arenaroot = xpv;
1165 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
1166 PL_xpv_root = ++xpv;
1167 while (xpv < xpvend) {
1168 *((xpv_allocated**)xpv) = xpv + 1;
1171 *((xpv_allocated**)xpv) = 0;
1174 /* allocate another arena's worth of struct xpviv */
1179 xpviv_allocated* xpviv;
1180 xpviv_allocated* xpvivend;
1181 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1182 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
1183 PL_xpviv_arenaroot = xpviv;
1185 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
1186 PL_xpviv_root = ++xpviv;
1187 while (xpviv < xpvivend) {
1188 *((xpviv_allocated**)xpviv) = xpviv + 1;
1191 *((xpviv_allocated**)xpviv) = 0;
1194 /* allocate another arena's worth of struct xpvnv */
1201 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1202 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
1203 PL_xpvnv_arenaroot = xpvnv;
1205 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1206 PL_xpvnv_root = ++xpvnv;
1207 while (xpvnv < xpvnvend) {
1208 *((XPVNV**)xpvnv) = xpvnv + 1;
1211 *((XPVNV**)xpvnv) = 0;
1214 /* allocate another arena's worth of struct xpvcv */
1221 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1222 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
1223 PL_xpvcv_arenaroot = xpvcv;
1225 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1226 PL_xpvcv_root = ++xpvcv;
1227 while (xpvcv < xpvcvend) {
1228 *((XPVCV**)xpvcv) = xpvcv + 1;
1231 *((XPVCV**)xpvcv) = 0;
1234 /* allocate another arena's worth of struct xpvav */
1239 xpvav_allocated* xpvav;
1240 xpvav_allocated* xpvavend;
1241 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1243 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
1244 PL_xpvav_arenaroot = xpvav;
1246 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
1247 PL_xpvav_root = ++xpvav;
1248 while (xpvav < xpvavend) {
1249 *((xpvav_allocated**)xpvav) = xpvav + 1;
1252 *((xpvav_allocated**)xpvav) = 0;
1255 /* allocate another arena's worth of struct xpvhv */
1260 xpvhv_allocated* xpvhv;
1261 xpvhv_allocated* xpvhvend;
1262 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1264 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
1265 PL_xpvhv_arenaroot = xpvhv;
1267 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
1268 PL_xpvhv_root = ++xpvhv;
1269 while (xpvhv < xpvhvend) {
1270 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
1273 *((xpvhv_allocated**)xpvhv) = 0;
1276 /* allocate another arena's worth of struct xpvmg */
1283 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1284 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1285 PL_xpvmg_arenaroot = xpvmg;
1287 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1288 PL_xpvmg_root = ++xpvmg;
1289 while (xpvmg < xpvmgend) {
1290 *((XPVMG**)xpvmg) = xpvmg + 1;
1293 *((XPVMG**)xpvmg) = 0;
1296 /* allocate another arena's worth of struct xpvgv */
1303 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1304 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1305 PL_xpvgv_arenaroot = xpvgv;
1307 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1308 PL_xpvgv_root = ++xpvgv;
1309 while (xpvgv < xpvgvend) {
1310 *((XPVGV**)xpvgv) = xpvgv + 1;
1313 *((XPVGV**)xpvgv) = 0;
1316 /* allocate another arena's worth of struct xpvlv */
1323 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1324 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1325 PL_xpvlv_arenaroot = xpvlv;
1327 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1328 PL_xpvlv_root = ++xpvlv;
1329 while (xpvlv < xpvlvend) {
1330 *((XPVLV**)xpvlv) = xpvlv + 1;
1333 *((XPVLV**)xpvlv) = 0;
1336 /* allocate another arena's worth of struct xpvbm */
1343 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1344 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1345 PL_xpvbm_arenaroot = xpvbm;
1347 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1348 PL_xpvbm_root = ++xpvbm;
1349 while (xpvbm < xpvbmend) {
1350 *((XPVBM**)xpvbm) = xpvbm + 1;
1353 *((XPVBM**)xpvbm) = 0;
1356 /* grab a new NV body from the free list, allocating more if necessary */
1366 PL_xnv_root = *(NV**)xnv;
1368 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1371 /* return an NV body to the free list */
1374 S_del_xnv(pTHX_ XPVNV *p)
1376 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1378 *(NV**)xnv = PL_xnv_root;
1383 /* grab a new struct xpv from the free list, allocating more if necessary */
1393 PL_xpv_root = *(xpv_allocated**)xpv;
1395 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1396 sum to zero, and the pointer is unchanged. If the allocated structure
1397 is smaller (no initial IV actually allocated) then the net effect is
1398 to subtract the size of the IV from the pointer, to return a new pointer
1399 as if an initial IV were actually allocated. */
1400 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1401 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
1404 /* return a struct xpv to the free list */
1407 S_del_xpv(pTHX_ XPV *p)
1410 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1411 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
1413 *(xpv_allocated**)xpv = PL_xpv_root;
1418 /* grab a new struct xpviv from the free list, allocating more if necessary */
1423 xpviv_allocated* xpviv;
1427 xpviv = PL_xpviv_root;
1428 PL_xpviv_root = *(xpviv_allocated**)xpviv;
1430 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1431 sum to zero, and the pointer is unchanged. If the allocated structure
1432 is smaller (no initial IV actually allocated) then the net effect is
1433 to subtract the size of the IV from the pointer, to return a new pointer
1434 as if an initial IV were actually allocated. */
1435 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1436 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1439 /* return a struct xpviv to the free list */
1442 S_del_xpviv(pTHX_ XPVIV *p)
1444 xpviv_allocated* xpviv
1445 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1446 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
1448 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1449 PL_xpviv_root = xpviv;
1453 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1462 xpvnv = PL_xpvnv_root;
1463 PL_xpvnv_root = *(XPVNV**)xpvnv;
1468 /* return a struct xpvnv to the free list */
1471 S_del_xpvnv(pTHX_ XPVNV *p)
1474 *(XPVNV**)p = PL_xpvnv_root;
1479 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1488 xpvcv = PL_xpvcv_root;
1489 PL_xpvcv_root = *(XPVCV**)xpvcv;
1494 /* return a struct xpvcv to the free list */
1497 S_del_xpvcv(pTHX_ XPVCV *p)
1500 *(XPVCV**)p = PL_xpvcv_root;
1505 /* grab a new struct xpvav from the free list, allocating more if necessary */
1510 xpvav_allocated* xpvav;
1514 xpvav = PL_xpvav_root;
1515 PL_xpvav_root = *(xpvav_allocated**)xpvav;
1517 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1518 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
1521 /* return a struct xpvav to the free list */
1524 S_del_xpvav(pTHX_ XPVAV *p)
1526 xpvav_allocated* xpvav
1527 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1528 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
1530 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1531 PL_xpvav_root = xpvav;
1535 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1540 xpvhv_allocated* xpvhv;
1544 xpvhv = PL_xpvhv_root;
1545 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
1547 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1548 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1551 /* return a struct xpvhv to the free list */
1554 S_del_xpvhv(pTHX_ XPVHV *p)
1556 xpvhv_allocated* xpvhv
1557 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1558 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
1560 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1561 PL_xpvhv_root = xpvhv;
1565 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1574 xpvmg = PL_xpvmg_root;
1575 PL_xpvmg_root = *(XPVMG**)xpvmg;
1580 /* return a struct xpvmg to the free list */
1583 S_del_xpvmg(pTHX_ XPVMG *p)
1586 *(XPVMG**)p = PL_xpvmg_root;
1591 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1600 xpvgv = PL_xpvgv_root;
1601 PL_xpvgv_root = *(XPVGV**)xpvgv;
1606 /* return a struct xpvgv to the free list */
1609 S_del_xpvgv(pTHX_ XPVGV *p)
1612 *(XPVGV**)p = PL_xpvgv_root;
1617 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1626 xpvlv = PL_xpvlv_root;
1627 PL_xpvlv_root = *(XPVLV**)xpvlv;
1632 /* return a struct xpvlv to the free list */
1635 S_del_xpvlv(pTHX_ XPVLV *p)
1638 *(XPVLV**)p = PL_xpvlv_root;
1643 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1652 xpvbm = PL_xpvbm_root;
1653 PL_xpvbm_root = *(XPVBM**)xpvbm;
1658 /* return a struct xpvbm to the free list */
1661 S_del_xpvbm(pTHX_ XPVBM *p)
1664 *(XPVBM**)p = PL_xpvbm_root;
1669 #define my_safemalloc(s) (void*)safemalloc(s)
1670 #define my_safefree(p) safefree((char*)p)
1674 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1675 #define del_XNV(p) my_safefree(p)
1677 #define new_XPV() my_safemalloc(sizeof(XPV))
1678 #define del_XPV(p) my_safefree(p)
1680 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1681 #define del_XPVIV(p) my_safefree(p)
1683 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1684 #define del_XPVNV(p) my_safefree(p)
1686 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1687 #define del_XPVCV(p) my_safefree(p)
1689 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1690 #define del_XPVAV(p) my_safefree(p)
1692 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1693 #define del_XPVHV(p) my_safefree(p)
1695 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1696 #define del_XPVMG(p) my_safefree(p)
1698 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1699 #define del_XPVGV(p) my_safefree(p)
1701 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1702 #define del_XPVLV(p) my_safefree(p)
1704 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1705 #define del_XPVBM(p) my_safefree(p)
1709 #define new_XNV() (void*)new_xnv()
1710 #define del_XNV(p) del_xnv((XPVNV*) p)
1712 #define new_XPV() (void*)new_xpv()
1713 #define del_XPV(p) del_xpv((XPV *)p)
1715 #define new_XPVIV() (void*)new_xpviv()
1716 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1718 #define new_XPVNV() (void*)new_xpvnv()
1719 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1721 #define new_XPVCV() (void*)new_xpvcv()
1722 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1724 #define new_XPVAV() (void*)new_xpvav()
1725 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1727 #define new_XPVHV() (void*)new_xpvhv()
1728 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1730 #define new_XPVMG() (void*)new_xpvmg()
1731 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1733 #define new_XPVGV() (void*)new_xpvgv()
1734 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1736 #define new_XPVLV() (void*)new_xpvlv()
1737 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1739 #define new_XPVBM() (void*)new_xpvbm()
1740 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1744 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1745 #define del_XPVFM(p) my_safefree(p)
1747 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1748 #define del_XPVIO(p) my_safefree(p)
1751 =for apidoc sv_upgrade
1753 Upgrade an SV to a more complex form. Generally adds a new body type to the
1754 SV, then copies across as much information as possible from the old body.
1755 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1761 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1772 if (mt != SVt_PV && SvIsCOW(sv)) {
1773 sv_force_normal_flags(sv, 0);
1776 if (SvTYPE(sv) == mt)
1787 switch (SvTYPE(sv)) {
1794 else if (mt < SVt_PVIV)
1804 pv = (char*)SvRV(sv);
1807 pv = SvPVX_mutable(sv);
1813 else if (mt == SVt_NV)
1817 pv = SvPVX_mutable(sv);
1821 del_XPVIV(SvANY(sv));
1824 pv = SvPVX_mutable(sv);
1829 del_XPVNV(SvANY(sv));
1832 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1833 there's no way that it can be safely upgraded, because perl.c
1834 expects to Safefree(SvANY(PL_mess_sv)) */
1835 assert(sv != PL_mess_sv);
1836 /* This flag bit is used to mean other things in other scalar types.
1837 Given that it only has meaning inside the pad, it shouldn't be set
1838 on anything that can get upgraded. */
1839 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1840 pv = SvPVX_mutable(sv);
1845 magic = SvMAGIC(sv);
1846 stash = SvSTASH(sv);
1847 del_XPVMG(SvANY(sv));
1850 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1853 SvFLAGS(sv) &= ~SVTYPEMASK;
1858 Perl_croak(aTHX_ "Can't upgrade to undef");
1860 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1864 SvANY(sv) = new_XNV();
1868 SvANY(sv) = &sv->sv_u.svu_rv;
1869 SvRV_set(sv, (SV*)pv);
1872 SvANY(sv) = new_XPVHV();
1875 HvTOTALKEYS(sv) = 0;
1877 /* Fall through... */
1880 SvANY(sv) = new_XPVAV();
1887 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1889 /* FIXME. Should be able to remove all this if()... if the above
1890 assertion is genuinely always true. */
1893 SvFLAGS(sv) &= ~SVf_OOK;
1896 SvPV_set(sv, (char*)0);
1897 SvMAGIC_set(sv, magic);
1898 SvSTASH_set(sv, stash);
1902 SvANY(sv) = new_XPVIO();
1903 Zero(SvANY(sv), 1, XPVIO);
1904 IoPAGE_LEN(sv) = 60;
1905 goto set_magic_common;
1907 SvANY(sv) = new_XPVFM();
1908 Zero(SvANY(sv), 1, XPVFM);
1909 goto set_magic_common;
1911 SvANY(sv) = new_XPVBM();
1915 goto set_magic_common;
1917 SvANY(sv) = new_XPVGV();
1923 goto set_magic_common;
1925 SvANY(sv) = new_XPVCV();
1926 Zero(SvANY(sv), 1, XPVCV);
1927 goto set_magic_common;
1929 SvANY(sv) = new_XPVLV();
1942 SvANY(sv) = new_XPVMG();
1945 SvMAGIC_set(sv, magic);
1946 SvSTASH_set(sv, stash);
1950 SvANY(sv) = new_XPVNV();
1956 SvANY(sv) = new_XPVIV();
1965 SvANY(sv) = new_XPV();
1976 =for apidoc sv_backoff
1978 Remove any string offset. You should normally use the C<SvOOK_off> macro
1985 Perl_sv_backoff(pTHX_ register SV *sv)
1988 assert(SvTYPE(sv) != SVt_PVHV);
1989 assert(SvTYPE(sv) != SVt_PVAV);
1991 const char *s = SvPVX_const(sv);
1992 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1993 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1995 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1997 SvFLAGS(sv) &= ~SVf_OOK;
2004 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2005 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2006 Use the C<SvGROW> wrapper instead.
2012 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2016 #ifdef HAS_64K_LIMIT
2017 if (newlen >= 0x10000) {
2018 PerlIO_printf(Perl_debug_log,
2019 "Allocation too large: %"UVxf"\n", (UV)newlen);
2022 #endif /* HAS_64K_LIMIT */
2025 if (SvTYPE(sv) < SVt_PV) {
2026 sv_upgrade(sv, SVt_PV);
2027 s = SvPVX_mutable(sv);
2029 else if (SvOOK(sv)) { /* pv is offset? */
2031 s = SvPVX_mutable(sv);
2032 if (newlen > SvLEN(sv))
2033 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2034 #ifdef HAS_64K_LIMIT
2035 if (newlen >= 0x10000)
2040 s = SvPVX_mutable(sv);
2042 if (newlen > SvLEN(sv)) { /* need more room? */
2043 newlen = PERL_STRLEN_ROUNDUP(newlen);
2044 if (SvLEN(sv) && s) {
2046 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
2052 s = saferealloc(s, newlen);
2055 s = safemalloc(newlen);
2056 if (SvPVX_const(sv) && SvCUR(sv)) {
2057 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2061 SvLEN_set(sv, newlen);
2067 =for apidoc sv_setiv
2069 Copies an integer into the given SV, upgrading first if necessary.
2070 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2076 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2078 SV_CHECK_THINKFIRST_COW_DROP(sv);
2079 switch (SvTYPE(sv)) {
2081 sv_upgrade(sv, SVt_IV);
2084 sv_upgrade(sv, SVt_PVNV);
2088 sv_upgrade(sv, SVt_PVIV);
2097 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2100 (void)SvIOK_only(sv); /* validate number */
2106 =for apidoc sv_setiv_mg
2108 Like C<sv_setiv>, but also handles 'set' magic.
2114 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2121 =for apidoc sv_setuv
2123 Copies an unsigned integer into the given SV, upgrading first if necessary.
2124 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2130 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2132 /* With these two if statements:
2133 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2136 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2138 If you wish to remove them, please benchmark to see what the effect is
2140 if (u <= (UV)IV_MAX) {
2141 sv_setiv(sv, (IV)u);
2150 =for apidoc sv_setuv_mg
2152 Like C<sv_setuv>, but also handles 'set' magic.
2158 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2160 /* With these two if statements:
2161 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2164 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2166 If you wish to remove them, please benchmark to see what the effect is
2168 if (u <= (UV)IV_MAX) {
2169 sv_setiv(sv, (IV)u);
2179 =for apidoc sv_setnv
2181 Copies a double into the given SV, upgrading first if necessary.
2182 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2188 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2190 SV_CHECK_THINKFIRST_COW_DROP(sv);
2191 switch (SvTYPE(sv)) {
2194 sv_upgrade(sv, SVt_NV);
2199 sv_upgrade(sv, SVt_PVNV);
2208 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2212 (void)SvNOK_only(sv); /* validate number */
2217 =for apidoc sv_setnv_mg
2219 Like C<sv_setnv>, but also handles 'set' magic.
2225 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2231 /* Print an "isn't numeric" warning, using a cleaned-up,
2232 * printable version of the offending string
2236 S_not_a_number(pTHX_ SV *sv)
2243 dsv = sv_2mortal(newSVpv("", 0));
2244 pv = sv_uni_display(dsv, sv, 10, 0);
2247 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2248 /* each *s can expand to 4 chars + "...\0",
2249 i.e. need room for 8 chars */
2251 const char *s, *end;
2252 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
2255 if (ch & 128 && !isPRINT_LC(ch)) {
2264 else if (ch == '\r') {
2268 else if (ch == '\f') {
2272 else if (ch == '\\') {
2276 else if (ch == '\0') {
2280 else if (isPRINT_LC(ch))
2297 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2298 "Argument \"%s\" isn't numeric in %s", pv,
2301 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2302 "Argument \"%s\" isn't numeric", pv);
2306 =for apidoc looks_like_number
2308 Test if the content of an SV looks like a number (or is a number).
2309 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2310 non-numeric warning), even if your atof() doesn't grok them.
2316 Perl_looks_like_number(pTHX_ SV *sv)
2318 register const char *sbegin;
2322 sbegin = SvPVX_const(sv);
2325 else if (SvPOKp(sv))
2326 sbegin = SvPV_const(sv, len);
2328 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2329 return grok_number(sbegin, len, NULL);
2332 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2333 until proven guilty, assume that things are not that bad... */
2338 As 64 bit platforms often have an NV that doesn't preserve all bits of
2339 an IV (an assumption perl has been based on to date) it becomes necessary
2340 to remove the assumption that the NV always carries enough precision to
2341 recreate the IV whenever needed, and that the NV is the canonical form.
2342 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2343 precision as a side effect of conversion (which would lead to insanity
2344 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2345 1) to distinguish between IV/UV/NV slots that have cached a valid
2346 conversion where precision was lost and IV/UV/NV slots that have a
2347 valid conversion which has lost no precision
2348 2) to ensure that if a numeric conversion to one form is requested that
2349 would lose precision, the precise conversion (or differently
2350 imprecise conversion) is also performed and cached, to prevent
2351 requests for different numeric formats on the same SV causing
2352 lossy conversion chains. (lossless conversion chains are perfectly
2357 SvIOKp is true if the IV slot contains a valid value
2358 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2359 SvNOKp is true if the NV slot contains a valid value
2360 SvNOK is true only if the NV value is accurate
2363 while converting from PV to NV, check to see if converting that NV to an
2364 IV(or UV) would lose accuracy over a direct conversion from PV to
2365 IV(or UV). If it would, cache both conversions, return NV, but mark
2366 SV as IOK NOKp (ie not NOK).
2368 While converting from PV to IV, check to see if converting that IV to an
2369 NV would lose accuracy over a direct conversion from PV to NV. If it
2370 would, cache both conversions, flag similarly.
2372 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2373 correctly because if IV & NV were set NV *always* overruled.
2374 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2375 changes - now IV and NV together means that the two are interchangeable:
2376 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2378 The benefit of this is that operations such as pp_add know that if
2379 SvIOK is true for both left and right operands, then integer addition
2380 can be used instead of floating point (for cases where the result won't
2381 overflow). Before, floating point was always used, which could lead to
2382 loss of precision compared with integer addition.
2384 * making IV and NV equal status should make maths accurate on 64 bit
2386 * may speed up maths somewhat if pp_add and friends start to use
2387 integers when possible instead of fp. (Hopefully the overhead in
2388 looking for SvIOK and checking for overflow will not outweigh the
2389 fp to integer speedup)
2390 * will slow down integer operations (callers of SvIV) on "inaccurate"
2391 values, as the change from SvIOK to SvIOKp will cause a call into
2392 sv_2iv each time rather than a macro access direct to the IV slot
2393 * should speed up number->string conversion on integers as IV is
2394 favoured when IV and NV are equally accurate
2396 ####################################################################
2397 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2398 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2399 On the other hand, SvUOK is true iff UV.
2400 ####################################################################
2402 Your mileage will vary depending your CPU's relative fp to integer
2406 #ifndef NV_PRESERVES_UV
2407 # define IS_NUMBER_UNDERFLOW_IV 1
2408 # define IS_NUMBER_UNDERFLOW_UV 2
2409 # define IS_NUMBER_IV_AND_UV 2
2410 # define IS_NUMBER_OVERFLOW_IV 4
2411 # define IS_NUMBER_OVERFLOW_UV 5
2413 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2415 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2417 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2419 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2420 if (SvNVX(sv) < (NV)IV_MIN) {
2421 (void)SvIOKp_on(sv);
2423 SvIV_set(sv, IV_MIN);
2424 return IS_NUMBER_UNDERFLOW_IV;
2426 if (SvNVX(sv) > (NV)UV_MAX) {
2427 (void)SvIOKp_on(sv);
2430 SvUV_set(sv, UV_MAX);
2431 return IS_NUMBER_OVERFLOW_UV;
2433 (void)SvIOKp_on(sv);
2435 /* Can't use strtol etc to convert this string. (See truth table in
2437 if (SvNVX(sv) <= (UV)IV_MAX) {
2438 SvIV_set(sv, I_V(SvNVX(sv)));
2439 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2440 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2442 /* Integer is imprecise. NOK, IOKp */
2444 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2447 SvUV_set(sv, U_V(SvNVX(sv)));
2448 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2449 if (SvUVX(sv) == UV_MAX) {
2450 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2451 possibly be preserved by NV. Hence, it must be overflow.
2453 return IS_NUMBER_OVERFLOW_UV;
2455 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2457 /* Integer is imprecise. NOK, IOKp */
2459 return IS_NUMBER_OVERFLOW_IV;
2461 #endif /* !NV_PRESERVES_UV*/
2463 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2464 * this function provided for binary compatibility only
2468 Perl_sv_2iv(pTHX_ register SV *sv)
2470 return sv_2iv_flags(sv, SV_GMAGIC);
2474 =for apidoc sv_2iv_flags
2476 Return the integer value of an SV, doing any necessary string
2477 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2478 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2484 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2488 if (SvGMAGICAL(sv)) {
2489 if (flags & SV_GMAGIC)
2494 return I_V(SvNVX(sv));
2496 if (SvPOKp(sv) && SvLEN(sv))
2499 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2500 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2506 if (SvTHINKFIRST(sv)) {
2509 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2510 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2511 return SvIV(tmpstr);
2512 return PTR2IV(SvRV(sv));
2515 sv_force_normal_flags(sv, 0);
2517 if (SvREADONLY(sv) && !SvOK(sv)) {
2518 if (ckWARN(WARN_UNINITIALIZED))
2525 return (IV)(SvUVX(sv));
2532 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2533 * without also getting a cached IV/UV from it at the same time
2534 * (ie PV->NV conversion should detect loss of accuracy and cache
2535 * IV or UV at same time to avoid this. NWC */
2537 if (SvTYPE(sv) == SVt_NV)
2538 sv_upgrade(sv, SVt_PVNV);
2540 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2541 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2542 certainly cast into the IV range at IV_MAX, whereas the correct
2543 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2545 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2546 SvIV_set(sv, I_V(SvNVX(sv)));
2547 if (SvNVX(sv) == (NV) SvIVX(sv)
2548 #ifndef NV_PRESERVES_UV
2549 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2550 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2551 /* Don't flag it as "accurately an integer" if the number
2552 came from a (by definition imprecise) NV operation, and
2553 we're outside the range of NV integer precision */
2556 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2557 DEBUG_c(PerlIO_printf(Perl_debug_log,
2558 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2564 /* IV not precise. No need to convert from PV, as NV
2565 conversion would already have cached IV if it detected
2566 that PV->IV would be better than PV->NV->IV
2567 flags already correct - don't set public IOK. */
2568 DEBUG_c(PerlIO_printf(Perl_debug_log,
2569 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2574 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2575 but the cast (NV)IV_MIN rounds to a the value less (more
2576 negative) than IV_MIN which happens to be equal to SvNVX ??
2577 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2578 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2579 (NV)UVX == NVX are both true, but the values differ. :-(
2580 Hopefully for 2s complement IV_MIN is something like
2581 0x8000000000000000 which will be exact. NWC */
2584 SvUV_set(sv, U_V(SvNVX(sv)));
2586 (SvNVX(sv) == (NV) SvUVX(sv))
2587 #ifndef NV_PRESERVES_UV
2588 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2589 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2590 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2591 /* Don't flag it as "accurately an integer" if the number
2592 came from a (by definition imprecise) NV operation, and
2593 we're outside the range of NV integer precision */
2599 DEBUG_c(PerlIO_printf(Perl_debug_log,
2600 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2604 return (IV)SvUVX(sv);
2607 else if (SvPOKp(sv) && SvLEN(sv)) {
2609 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2610 /* We want to avoid a possible problem when we cache an IV which
2611 may be later translated to an NV, and the resulting NV is not
2612 the same as the direct translation of the initial string
2613 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2614 be careful to ensure that the value with the .456 is around if the
2615 NV value is requested in the future).
2617 This means that if we cache such an IV, we need to cache the
2618 NV as well. Moreover, we trade speed for space, and do not
2619 cache the NV if we are sure it's not needed.
2622 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2623 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2624 == IS_NUMBER_IN_UV) {
2625 /* It's definitely an integer, only upgrade to PVIV */
2626 if (SvTYPE(sv) < SVt_PVIV)
2627 sv_upgrade(sv, SVt_PVIV);
2629 } else if (SvTYPE(sv) < SVt_PVNV)
2630 sv_upgrade(sv, SVt_PVNV);
2632 /* If NV preserves UV then we only use the UV value if we know that
2633 we aren't going to call atof() below. If NVs don't preserve UVs
2634 then the value returned may have more precision than atof() will
2635 return, even though value isn't perfectly accurate. */
2636 if ((numtype & (IS_NUMBER_IN_UV
2637 #ifdef NV_PRESERVES_UV
2640 )) == IS_NUMBER_IN_UV) {
2641 /* This won't turn off the public IOK flag if it was set above */
2642 (void)SvIOKp_on(sv);
2644 if (!(numtype & IS_NUMBER_NEG)) {
2646 if (value <= (UV)IV_MAX) {
2647 SvIV_set(sv, (IV)value);
2649 SvUV_set(sv, value);
2653 /* 2s complement assumption */
2654 if (value <= (UV)IV_MIN) {
2655 SvIV_set(sv, -(IV)value);
2657 /* Too negative for an IV. This is a double upgrade, but
2658 I'm assuming it will be rare. */
2659 if (SvTYPE(sv) < SVt_PVNV)
2660 sv_upgrade(sv, SVt_PVNV);
2664 SvNV_set(sv, -(NV)value);
2665 SvIV_set(sv, IV_MIN);
2669 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2670 will be in the previous block to set the IV slot, and the next
2671 block to set the NV slot. So no else here. */
2673 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2674 != IS_NUMBER_IN_UV) {
2675 /* It wasn't an (integer that doesn't overflow the UV). */
2676 SvNV_set(sv, Atof(SvPVX_const(sv)));
2678 if (! numtype && ckWARN(WARN_NUMERIC))
2681 #if defined(USE_LONG_DOUBLE)
2682 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2683 PTR2UV(sv), SvNVX(sv)));
2685 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2686 PTR2UV(sv), SvNVX(sv)));
2690 #ifdef NV_PRESERVES_UV
2691 (void)SvIOKp_on(sv);
2693 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2694 SvIV_set(sv, I_V(SvNVX(sv)));
2695 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2698 /* Integer is imprecise. NOK, IOKp */
2700 /* UV will not work better than IV */
2702 if (SvNVX(sv) > (NV)UV_MAX) {
2704 /* Integer is inaccurate. NOK, IOKp, is UV */
2705 SvUV_set(sv, UV_MAX);
2708 SvUV_set(sv, U_V(SvNVX(sv)));
2709 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2710 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2714 /* Integer is imprecise. NOK, IOKp, is UV */
2720 #else /* NV_PRESERVES_UV */
2721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2722 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2723 /* The IV slot will have been set from value returned by
2724 grok_number above. The NV slot has just been set using
2727 assert (SvIOKp(sv));
2729 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2730 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2731 /* Small enough to preserve all bits. */
2732 (void)SvIOKp_on(sv);
2734 SvIV_set(sv, I_V(SvNVX(sv)));
2735 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2737 /* Assumption: first non-preserved integer is < IV_MAX,
2738 this NV is in the preserved range, therefore: */
2739 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2741 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);
2745 0 0 already failed to read UV.
2746 0 1 already failed to read UV.
2747 1 0 you won't get here in this case. IV/UV
2748 slot set, public IOK, Atof() unneeded.
2749 1 1 already read UV.
2750 so there's no point in sv_2iuv_non_preserve() attempting
2751 to use atol, strtol, strtoul etc. */
2752 if (sv_2iuv_non_preserve (sv, numtype)
2753 >= IS_NUMBER_OVERFLOW_IV)
2757 #endif /* NV_PRESERVES_UV */
2760 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2762 if (SvTYPE(sv) < SVt_IV)
2763 /* Typically the caller expects that sv_any is not NULL now. */
2764 sv_upgrade(sv, SVt_IV);
2767 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2768 PTR2UV(sv),SvIVX(sv)));
2769 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2772 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2773 * this function provided for binary compatibility only
2777 Perl_sv_2uv(pTHX_ register SV *sv)
2779 return sv_2uv_flags(sv, SV_GMAGIC);
2783 =for apidoc sv_2uv_flags
2785 Return the unsigned integer value of an SV, doing any necessary string
2786 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2787 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2793 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2797 if (SvGMAGICAL(sv)) {
2798 if (flags & SV_GMAGIC)
2803 return U_V(SvNVX(sv));
2804 if (SvPOKp(sv) && SvLEN(sv))
2807 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2808 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2814 if (SvTHINKFIRST(sv)) {
2817 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2818 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2819 return SvUV(tmpstr);
2820 return PTR2UV(SvRV(sv));
2823 sv_force_normal_flags(sv, 0);
2825 if (SvREADONLY(sv) && !SvOK(sv)) {
2826 if (ckWARN(WARN_UNINITIALIZED))
2836 return (UV)SvIVX(sv);
2840 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2841 * without also getting a cached IV/UV from it at the same time
2842 * (ie PV->NV conversion should detect loss of accuracy and cache
2843 * IV or UV at same time to avoid this. */
2844 /* IV-over-UV optimisation - choose to cache IV if possible */
2846 if (SvTYPE(sv) == SVt_NV)
2847 sv_upgrade(sv, SVt_PVNV);
2849 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2850 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2851 SvIV_set(sv, I_V(SvNVX(sv)));
2852 if (SvNVX(sv) == (NV) SvIVX(sv)
2853 #ifndef NV_PRESERVES_UV
2854 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2855 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2856 /* Don't flag it as "accurately an integer" if the number
2857 came from a (by definition imprecise) NV operation, and
2858 we're outside the range of NV integer precision */
2861 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2862 DEBUG_c(PerlIO_printf(Perl_debug_log,
2863 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2869 /* IV not precise. No need to convert from PV, as NV
2870 conversion would already have cached IV if it detected
2871 that PV->IV would be better than PV->NV->IV
2872 flags already correct - don't set public IOK. */
2873 DEBUG_c(PerlIO_printf(Perl_debug_log,
2874 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2879 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2880 but the cast (NV)IV_MIN rounds to a the value less (more
2881 negative) than IV_MIN which happens to be equal to SvNVX ??
2882 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2883 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2884 (NV)UVX == NVX are both true, but the values differ. :-(
2885 Hopefully for 2s complement IV_MIN is something like
2886 0x8000000000000000 which will be exact. NWC */
2889 SvUV_set(sv, U_V(SvNVX(sv)));
2891 (SvNVX(sv) == (NV) SvUVX(sv))
2892 #ifndef NV_PRESERVES_UV
2893 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2894 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2895 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2896 /* Don't flag it as "accurately an integer" if the number
2897 came from a (by definition imprecise) NV operation, and
2898 we're outside the range of NV integer precision */
2903 DEBUG_c(PerlIO_printf(Perl_debug_log,
2904 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2910 else if (SvPOKp(sv) && SvLEN(sv)) {
2912 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2914 /* We want to avoid a possible problem when we cache a UV which
2915 may be later translated to an NV, and the resulting NV is not
2916 the translation of the initial data.
2918 This means that if we cache such a UV, we need to cache the
2919 NV as well. Moreover, we trade speed for space, and do not
2920 cache the NV if not needed.
2923 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2924 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2925 == IS_NUMBER_IN_UV) {
2926 /* It's definitely an integer, only upgrade to PVIV */
2927 if (SvTYPE(sv) < SVt_PVIV)
2928 sv_upgrade(sv, SVt_PVIV);
2930 } else if (SvTYPE(sv) < SVt_PVNV)
2931 sv_upgrade(sv, SVt_PVNV);
2933 /* If NV preserves UV then we only use the UV value if we know that
2934 we aren't going to call atof() below. If NVs don't preserve UVs
2935 then the value returned may have more precision than atof() will
2936 return, even though it isn't accurate. */
2937 if ((numtype & (IS_NUMBER_IN_UV
2938 #ifdef NV_PRESERVES_UV
2941 )) == IS_NUMBER_IN_UV) {
2942 /* This won't turn off the public IOK flag if it was set above */
2943 (void)SvIOKp_on(sv);
2945 if (!(numtype & IS_NUMBER_NEG)) {
2947 if (value <= (UV)IV_MAX) {
2948 SvIV_set(sv, (IV)value);
2950 /* it didn't overflow, and it was positive. */
2951 SvUV_set(sv, value);
2955 /* 2s complement assumption */
2956 if (value <= (UV)IV_MIN) {
2957 SvIV_set(sv, -(IV)value);
2959 /* Too negative for an IV. This is a double upgrade, but
2960 I'm assuming it will be rare. */
2961 if (SvTYPE(sv) < SVt_PVNV)
2962 sv_upgrade(sv, SVt_PVNV);
2966 SvNV_set(sv, -(NV)value);
2967 SvIV_set(sv, IV_MIN);
2972 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2973 != IS_NUMBER_IN_UV) {
2974 /* It wasn't an integer, or it overflowed the UV. */
2975 SvNV_set(sv, Atof(SvPVX_const(sv)));
2977 if (! numtype && ckWARN(WARN_NUMERIC))
2980 #if defined(USE_LONG_DOUBLE)
2981 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2982 PTR2UV(sv), SvNVX(sv)));
2984 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2985 PTR2UV(sv), SvNVX(sv)));
2988 #ifdef NV_PRESERVES_UV
2989 (void)SvIOKp_on(sv);
2991 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2992 SvIV_set(sv, I_V(SvNVX(sv)));
2993 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2996 /* Integer is imprecise. NOK, IOKp */
2998 /* UV will not work better than IV */
3000 if (SvNVX(sv) > (NV)UV_MAX) {
3002 /* Integer is inaccurate. NOK, IOKp, is UV */
3003 SvUV_set(sv, UV_MAX);
3006 SvUV_set(sv, U_V(SvNVX(sv)));
3007 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3008 NV preservse UV so can do correct comparison. */
3009 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3013 /* Integer is imprecise. NOK, IOKp, is UV */
3018 #else /* NV_PRESERVES_UV */
3019 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3020 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3021 /* The UV slot will have been set from value returned by
3022 grok_number above. The NV slot has just been set using
3025 assert (SvIOKp(sv));
3027 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3028 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3029 /* Small enough to preserve all bits. */
3030 (void)SvIOKp_on(sv);
3032 SvIV_set(sv, I_V(SvNVX(sv)));
3033 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3035 /* Assumption: first non-preserved integer is < IV_MAX,
3036 this NV is in the preserved range, therefore: */
3037 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3039 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);
3042 sv_2iuv_non_preserve (sv, numtype);
3044 #endif /* NV_PRESERVES_UV */
3048 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3049 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3052 if (SvTYPE(sv) < SVt_IV)
3053 /* Typically the caller expects that sv_any is not NULL now. */
3054 sv_upgrade(sv, SVt_IV);
3058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3059 PTR2UV(sv),SvUVX(sv)));
3060 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3066 Return the num value of an SV, doing any necessary string or integer
3067 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3074 Perl_sv_2nv(pTHX_ register SV *sv)
3078 if (SvGMAGICAL(sv)) {
3082 if (SvPOKp(sv) && SvLEN(sv)) {
3083 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3084 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3086 return Atof(SvPVX_const(sv));
3090 return (NV)SvUVX(sv);
3092 return (NV)SvIVX(sv);
3095 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3096 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3102 if (SvTHINKFIRST(sv)) {
3105 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3106 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3107 return SvNV(tmpstr);
3108 return PTR2NV(SvRV(sv));
3111 sv_force_normal_flags(sv, 0);
3113 if (SvREADONLY(sv) && !SvOK(sv)) {
3114 if (ckWARN(WARN_UNINITIALIZED))
3119 if (SvTYPE(sv) < SVt_NV) {
3120 if (SvTYPE(sv) == SVt_IV)
3121 sv_upgrade(sv, SVt_PVNV);
3123 sv_upgrade(sv, SVt_NV);
3124 #ifdef USE_LONG_DOUBLE
3126 STORE_NUMERIC_LOCAL_SET_STANDARD();
3127 PerlIO_printf(Perl_debug_log,
3128 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3129 PTR2UV(sv), SvNVX(sv));
3130 RESTORE_NUMERIC_LOCAL();
3134 STORE_NUMERIC_LOCAL_SET_STANDARD();
3135 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3136 PTR2UV(sv), SvNVX(sv));
3137 RESTORE_NUMERIC_LOCAL();
3141 else if (SvTYPE(sv) < SVt_PVNV)
3142 sv_upgrade(sv, SVt_PVNV);
3147 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3148 #ifdef NV_PRESERVES_UV
3151 /* Only set the public NV OK flag if this NV preserves the IV */
3152 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3153 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3154 : (SvIVX(sv) == I_V(SvNVX(sv))))
3160 else if (SvPOKp(sv) && SvLEN(sv)) {
3162 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3163 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3165 #ifdef NV_PRESERVES_UV
3166 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3167 == IS_NUMBER_IN_UV) {
3168 /* It's definitely an integer */
3169 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3171 SvNV_set(sv, Atof(SvPVX_const(sv)));
3174 SvNV_set(sv, Atof(SvPVX_const(sv)));
3175 /* Only set the public NV OK flag if this NV preserves the value in
3176 the PV at least as well as an IV/UV would.
3177 Not sure how to do this 100% reliably. */
3178 /* if that shift count is out of range then Configure's test is
3179 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3181 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3182 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3183 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3184 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3185 /* Can't use strtol etc to convert this string, so don't try.
3186 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3189 /* value has been set. It may not be precise. */
3190 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3191 /* 2s complement assumption for (UV)IV_MIN */
3192 SvNOK_on(sv); /* Integer is too negative. */
3197 if (numtype & IS_NUMBER_NEG) {
3198 SvIV_set(sv, -(IV)value);
3199 } else if (value <= (UV)IV_MAX) {
3200 SvIV_set(sv, (IV)value);
3202 SvUV_set(sv, value);
3206 if (numtype & IS_NUMBER_NOT_INT) {
3207 /* I believe that even if the original PV had decimals,
3208 they are lost beyond the limit of the FP precision.
3209 However, neither is canonical, so both only get p
3210 flags. NWC, 2000/11/25 */
3211 /* Both already have p flags, so do nothing */
3213 const NV nv = SvNVX(sv);
3214 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3215 if (SvIVX(sv) == I_V(nv)) {
3220 /* It had no "." so it must be integer. */
3223 /* between IV_MAX and NV(UV_MAX).
3224 Could be slightly > UV_MAX */
3226 if (numtype & IS_NUMBER_NOT_INT) {
3227 /* UV and NV both imprecise. */
3229 const UV nv_as_uv = U_V(nv);
3231 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3242 #endif /* NV_PRESERVES_UV */
3245 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3247 if (SvTYPE(sv) < SVt_NV)
3248 /* Typically the caller expects that sv_any is not NULL now. */
3249 /* XXX Ilya implies that this is a bug in callers that assume this
3250 and ideally should be fixed. */
3251 sv_upgrade(sv, SVt_NV);
3254 #if defined(USE_LONG_DOUBLE)
3256 STORE_NUMERIC_LOCAL_SET_STANDARD();
3257 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3258 PTR2UV(sv), SvNVX(sv));
3259 RESTORE_NUMERIC_LOCAL();
3263 STORE_NUMERIC_LOCAL_SET_STANDARD();
3264 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3265 PTR2UV(sv), SvNVX(sv));
3266 RESTORE_NUMERIC_LOCAL();
3272 /* asIV(): extract an integer from the string value of an SV.
3273 * Caller must validate PVX */
3276 S_asIV(pTHX_ SV *sv)
3279 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3281 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3282 == IS_NUMBER_IN_UV) {
3283 /* It's definitely an integer */
3284 if (numtype & IS_NUMBER_NEG) {
3285 if (value < (UV)IV_MIN)
3288 if (value < (UV)IV_MAX)
3293 if (ckWARN(WARN_NUMERIC))
3296 return I_V(Atof(SvPVX_const(sv)));
3299 /* asUV(): extract an unsigned integer from the string value of an SV
3300 * Caller must validate PVX */
3303 S_asUV(pTHX_ SV *sv)
3306 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3308 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3309 == IS_NUMBER_IN_UV) {
3310 /* It's definitely an integer */
3311 if (!(numtype & IS_NUMBER_NEG))
3315 if (ckWARN(WARN_NUMERIC))
3318 return U_V(Atof(SvPVX_const(sv)));
3322 =for apidoc sv_2pv_nolen
3324 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3325 use the macro wrapper C<SvPV_nolen(sv)> instead.
3330 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3332 return sv_2pv(sv, 0);
3335 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3336 * UV as a string towards the end of buf, and return pointers to start and
3339 * We assume that buf is at least TYPE_CHARS(UV) long.
3343 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3345 char *ptr = buf + TYPE_CHARS(UV);
3359 *--ptr = '0' + (char)(uv % 10);
3367 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3368 * this function provided for binary compatibility only
3372 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3374 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3378 =for apidoc sv_2pv_flags
3380 Returns a pointer to the string value of an SV, and sets *lp to its length.
3381 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3383 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3384 usually end up here too.
3390 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3395 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3396 char *tmpbuf = tbuf;
3403 if (SvGMAGICAL(sv)) {
3404 if (flags & SV_GMAGIC)
3409 if (flags & SV_MUTABLE_RETURN)
3410 return SvPVX_mutable(sv);
3411 if (flags & SV_CONST_RETURN)
3412 return (char *)SvPVX_const(sv);
3417 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3419 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3424 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3429 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3430 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3438 if (SvTHINKFIRST(sv)) {
3441 register const char *typestr;
3442 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3443 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3445 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3448 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3449 if (flags & SV_CONST_RETURN) {
3450 pv = (char *) SvPVX_const(tmpstr);
3452 pv = (flags & SV_MUTABLE_RETURN)
3453 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3456 *lp = SvCUR(tmpstr);
3458 pv = sv_2pv_flags(tmpstr, lp, flags);
3469 typestr = "NULLREF";
3473 switch (SvTYPE(sv)) {
3475 if ( ((SvFLAGS(sv) &
3476 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3477 == (SVs_OBJECT|SVs_SMG))
3478 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3479 const regexp *re = (regexp *)mg->mg_obj;
3482 const char *fptr = "msix";
3487 char need_newline = 0;
3488 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3490 while((ch = *fptr++)) {
3492 reflags[left++] = ch;
3495 reflags[right--] = ch;
3500 reflags[left] = '-';
3504 mg->mg_len = re->prelen + 4 + left;
3506 * If /x was used, we have to worry about a regex
3507 * ending with a comment later being embedded
3508 * within another regex. If so, we don't want this
3509 * regex's "commentization" to leak out to the
3510 * right part of the enclosing regex, we must cap
3511 * it with a newline.
3513 * So, if /x was used, we scan backwards from the
3514 * end of the regex. If we find a '#' before we
3515 * find a newline, we need to add a newline
3516 * ourself. If we find a '\n' first (or if we
3517 * don't find '#' or '\n'), we don't need to add
3518 * anything. -jfriedl
3520 if (PMf_EXTENDED & re->reganch)
3522 const char *endptr = re->precomp + re->prelen;
3523 while (endptr >= re->precomp)
3525 const char c = *(endptr--);
3527 break; /* don't need another */
3529 /* we end while in a comment, so we
3531 mg->mg_len++; /* save space for it */
3532 need_newline = 1; /* note to add it */
3538 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3539 Copy("(?", mg->mg_ptr, 2, char);
3540 Copy(reflags, mg->mg_ptr+2, left, char);
3541 Copy(":", mg->mg_ptr+left+2, 1, char);
3542 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3544 mg->mg_ptr[mg->mg_len - 2] = '\n';
3545 mg->mg_ptr[mg->mg_len - 1] = ')';
3546 mg->mg_ptr[mg->mg_len] = 0;
3548 PL_reginterp_cnt += re->program[0].next_off;
3550 if (re->reganch & ROPT_UTF8)
3566 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3567 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3568 /* tied lvalues should appear to be
3569 * scalars for backwards compatitbility */
3570 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3571 ? "SCALAR" : "LVALUE"; break;
3572 case SVt_PVAV: typestr = "ARRAY"; break;
3573 case SVt_PVHV: typestr = "HASH"; break;
3574 case SVt_PVCV: typestr = "CODE"; break;
3575 case SVt_PVGV: typestr = "GLOB"; break;
3576 case SVt_PVFM: typestr = "FORMAT"; break;
3577 case SVt_PVIO: typestr = "IO"; break;
3578 default: typestr = "UNKNOWN"; break;
3582 const char *name = HvNAME_get(SvSTASH(sv));
3583 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3584 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3587 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3591 *lp = strlen(typestr);
3592 return (char *)typestr;
3594 if (SvREADONLY(sv) && !SvOK(sv)) {
3595 if (ckWARN(WARN_UNINITIALIZED))
3602 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3603 /* I'm assuming that if both IV and NV are equally valid then
3604 converting the IV is going to be more efficient */
3605 const U32 isIOK = SvIOK(sv);
3606 const U32 isUIOK = SvIsUV(sv);
3607 char buf[TYPE_CHARS(UV)];
3610 if (SvTYPE(sv) < SVt_PVIV)
3611 sv_upgrade(sv, SVt_PVIV);
3613 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3615 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3616 /* inlined from sv_setpvn */
3617 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3618 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3619 SvCUR_set(sv, ebuf - ptr);
3629 else if (SvNOKp(sv)) {
3630 if (SvTYPE(sv) < SVt_PVNV)
3631 sv_upgrade(sv, SVt_PVNV);
3632 /* The +20 is pure guesswork. Configure test needed. --jhi */
3633 s = SvGROW_mutable(sv, NV_DIG + 20);
3634 olderrno = errno; /* some Xenix systems wipe out errno here */
3636 if (SvNVX(sv) == 0.0)
3637 (void)strcpy(s,"0");
3641 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3644 #ifdef FIXNEGATIVEZERO
3645 if (*s == '-' && s[1] == '0' && !s[2])
3655 if (ckWARN(WARN_UNINITIALIZED)
3656 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3660 if (SvTYPE(sv) < SVt_PV)
3661 /* Typically the caller expects that sv_any is not NULL now. */
3662 sv_upgrade(sv, SVt_PV);
3666 STRLEN len = s - SvPVX_const(sv);
3672 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3673 PTR2UV(sv),SvPVX_const(sv)));
3674 if (flags & SV_CONST_RETURN)
3675 return (char *)SvPVX_const(sv);
3676 if (flags & SV_MUTABLE_RETURN)
3677 return SvPVX_mutable(sv);
3681 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3682 /* Sneaky stuff here */
3686 tsv = newSVpv(tmpbuf, 0);
3699 t = SvPVX_const(tsv);
3704 len = strlen(tmpbuf);
3706 #ifdef FIXNEGATIVEZERO
3707 if (len == 2 && t[0] == '-' && t[1] == '0') {
3712 SvUPGRADE(sv, SVt_PV);
3715 s = SvGROW_mutable(sv, len + 1);
3718 return strcpy(s, t);
3723 =for apidoc sv_copypv
3725 Copies a stringified representation of the source SV into the
3726 destination SV. Automatically performs any necessary mg_get and
3727 coercion of numeric values into strings. Guaranteed to preserve
3728 UTF-8 flag even from overloaded objects. Similar in nature to
3729 sv_2pv[_flags] but operates directly on an SV instead of just the
3730 string. Mostly uses sv_2pv_flags to do its work, except when that
3731 would lose the UTF-8'ness of the PV.
3737 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3741 s = SvPV_const(ssv,len);
3742 sv_setpvn(dsv,s,len);
3750 =for apidoc sv_2pvbyte_nolen
3752 Return a pointer to the byte-encoded representation of the SV.
3753 May cause the SV to be downgraded from UTF-8 as a side-effect.
3755 Usually accessed via the C<SvPVbyte_nolen> macro.
3761 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3763 return sv_2pvbyte(sv, 0);
3767 =for apidoc sv_2pvbyte
3769 Return a pointer to the byte-encoded representation of the SV, and set *lp
3770 to its length. May cause the SV to be downgraded from UTF-8 as a
3773 Usually accessed via the C<SvPVbyte> macro.
3779 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3781 sv_utf8_downgrade(sv,0);
3782 return SvPV(sv,*lp);
3786 =for apidoc sv_2pvutf8_nolen
3788 Return a pointer to the UTF-8-encoded representation of the SV.
3789 May cause the SV to be upgraded to UTF-8 as a side-effect.
3791 Usually accessed via the C<SvPVutf8_nolen> macro.
3797 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3799 return sv_2pvutf8(sv, 0);
3803 =for apidoc sv_2pvutf8
3805 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3806 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3808 Usually accessed via the C<SvPVutf8> macro.
3814 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3816 sv_utf8_upgrade(sv);
3817 return SvPV(sv,*lp);
3821 =for apidoc sv_2bool
3823 This function is only called on magical items, and is only used by
3824 sv_true() or its macro equivalent.
3830 Perl_sv_2bool(pTHX_ register SV *sv)
3839 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3840 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3841 return (bool)SvTRUE(tmpsv);
3842 return SvRV(sv) != 0;
3845 register XPV* Xpvtmp;
3846 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3847 (*sv->sv_u.svu_pv > '0' ||
3848 Xpvtmp->xpv_cur > 1 ||
3849 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3856 return SvIVX(sv) != 0;
3859 return SvNVX(sv) != 0.0;
3866 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3867 * this function provided for binary compatibility only
3872 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3874 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3878 =for apidoc sv_utf8_upgrade
3880 Converts the PV of an SV to its UTF-8-encoded form.
3881 Forces the SV to string form if it is not already.
3882 Always sets the SvUTF8 flag to avoid future validity checks even
3883 if all the bytes have hibit clear.
3885 This is not as a general purpose byte encoding to Unicode interface:
3886 use the Encode extension for that.
3888 =for apidoc sv_utf8_upgrade_flags
3890 Converts the PV of an SV to its UTF-8-encoded form.
3891 Forces the SV to string form if it is not already.
3892 Always sets the SvUTF8 flag to avoid future validity checks even
3893 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3894 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3895 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3897 This is not as a general purpose byte encoding to Unicode interface:
3898 use the Encode extension for that.
3904 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3906 if (sv == &PL_sv_undef)
3910 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3911 (void) sv_2pv_flags(sv,&len, flags);
3915 (void) SvPV_force(sv,len);
3924 sv_force_normal_flags(sv, 0);
3927 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3928 sv_recode_to_utf8(sv, PL_encoding);
3929 else { /* Assume Latin-1/EBCDIC */
3930 /* This function could be much more efficient if we
3931 * had a FLAG in SVs to signal if there are any hibit
3932 * chars in the PV. Given that there isn't such a flag
3933 * make the loop as fast as possible. */
3934 const U8 *s = (U8 *) SvPVX_const(sv);
3935 const U8 *e = (U8 *) SvEND(sv);
3941 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3945 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3946 char *recoded = bytes_to_utf8((U8*)s, &len);
3948 SvPV_free(sv); /* No longer using what was there before. */
3950 SvPV_set(sv, recoded);
3951 SvCUR_set(sv, len - 1);
3952 SvLEN_set(sv, len); /* No longer know the real size. */
3954 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3961 =for apidoc sv_utf8_downgrade
3963 Attempts to convert the PV of an SV from characters to bytes.
3964 If the PV contains a character beyond byte, this conversion will fail;
3965 in this case, either returns false or, if C<fail_ok> is not
3968 This is not as a general purpose Unicode to byte encoding interface:
3969 use the Encode extension for that.
3975 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3977 if (SvPOKp(sv) && SvUTF8(sv)) {
3983 sv_force_normal_flags(sv, 0);
3985 s = (U8 *) SvPV(sv, len);
3986 if (!utf8_to_bytes(s, &len)) {
3991 Perl_croak(aTHX_ "Wide character in %s",
3994 Perl_croak(aTHX_ "Wide character");
4005 =for apidoc sv_utf8_encode
4007 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4008 flag off so that it looks like octets again.
4014 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4016 (void) sv_utf8_upgrade(sv);
4018 sv_force_normal_flags(sv, 0);
4020 if (SvREADONLY(sv)) {
4021 Perl_croak(aTHX_ PL_no_modify);
4027 =for apidoc sv_utf8_decode
4029 If the PV of the SV is an octet sequence in UTF-8
4030 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4031 so that it looks like a character. If the PV contains only single-byte
4032 characters, the C<SvUTF8> flag stays being off.
4033 Scans PV for validity and returns false if the PV is invalid UTF-8.
4039 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4045 /* The octets may have got themselves encoded - get them back as
4048 if (!sv_utf8_downgrade(sv, TRUE))
4051 /* it is actually just a matter of turning the utf8 flag on, but
4052 * we want to make sure everything inside is valid utf8 first.
4054 c = (const U8 *) SvPVX_const(sv);
4055 if (!is_utf8_string(c, SvCUR(sv)+1))
4057 e = (const U8 *) SvEND(sv);
4060 if (!UTF8_IS_INVARIANT(ch)) {
4069 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4070 * this function provided for binary compatibility only
4074 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4076 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4080 =for apidoc sv_setsv
4082 Copies the contents of the source SV C<ssv> into the destination SV
4083 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4084 function if the source SV needs to be reused. Does not handle 'set' magic.
4085 Loosely speaking, it performs a copy-by-value, obliterating any previous
4086 content of the destination.
4088 You probably want to use one of the assortment of wrappers, such as
4089 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4090 C<SvSetMagicSV_nosteal>.
4092 =for apidoc sv_setsv_flags
4094 Copies the contents of the source SV C<ssv> into the destination SV
4095 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4096 function if the source SV needs to be reused. Does not handle 'set' magic.
4097 Loosely speaking, it performs a copy-by-value, obliterating any previous
4098 content of the destination.
4099 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4100 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4101 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4102 and C<sv_setsv_nomg> are implemented in terms of this function.
4104 You probably want to use one of the assortment of wrappers, such as
4105 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4106 C<SvSetMagicSV_nosteal>.
4108 This is the primary function for copying scalars, and most other
4109 copy-ish functions and macros use this underneath.
4115 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4117 register U32 sflags;
4123 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4125 sstr = &PL_sv_undef;
4126 stype = SvTYPE(sstr);
4127 dtype = SvTYPE(dstr);
4132 /* need to nuke the magic */
4134 SvRMAGICAL_off(dstr);
4137 /* There's a lot of redundancy below but we're going for speed here */
4142 if (dtype != SVt_PVGV) {
4143 (void)SvOK_off(dstr);
4151 sv_upgrade(dstr, SVt_IV);
4154 sv_upgrade(dstr, SVt_PVNV);
4158 sv_upgrade(dstr, SVt_PVIV);
4161 (void)SvIOK_only(dstr);
4162 SvIV_set(dstr, SvIVX(sstr));
4165 if (SvTAINTED(sstr))
4176 sv_upgrade(dstr, SVt_NV);
4181 sv_upgrade(dstr, SVt_PVNV);
4184 SvNV_set(dstr, SvNVX(sstr));
4185 (void)SvNOK_only(dstr);
4186 if (SvTAINTED(sstr))
4194 sv_upgrade(dstr, SVt_RV);
4195 else if (dtype == SVt_PVGV &&
4196 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4199 if (GvIMPORTED(dstr) != GVf_IMPORTED
4200 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4202 GvIMPORTED_on(dstr);
4211 #ifdef PERL_OLD_COPY_ON_WRITE
4212 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4213 if (dtype < SVt_PVIV)
4214 sv_upgrade(dstr, SVt_PVIV);
4221 sv_upgrade(dstr, SVt_PV);
4224 if (dtype < SVt_PVIV)
4225 sv_upgrade(dstr, SVt_PVIV);
4228 if (dtype < SVt_PVNV)
4229 sv_upgrade(dstr, SVt_PVNV);
4236 const char * const type = sv_reftype(sstr,0);
4238 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4240 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4245 if (dtype <= SVt_PVGV) {
4247 if (dtype != SVt_PVGV) {
4248 const char * const name = GvNAME(sstr);
4249 const STRLEN len = GvNAMELEN(sstr);
4250 /* don't upgrade SVt_PVLV: it can hold a glob */
4251 if (dtype != SVt_PVLV)
4252 sv_upgrade(dstr, SVt_PVGV);
4253 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4254 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4255 GvNAME(dstr) = savepvn(name, len);
4256 GvNAMELEN(dstr) = len;
4257 SvFAKE_on(dstr); /* can coerce to non-glob */
4259 /* ahem, death to those who redefine active sort subs */
4260 else if (PL_curstackinfo->si_type == PERLSI_SORT
4261 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4262 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4265 #ifdef GV_UNIQUE_CHECK
4266 if (GvUNIQUE((GV*)dstr)) {
4267 Perl_croak(aTHX_ PL_no_modify);
4271 (void)SvOK_off(dstr);
4272 GvINTRO_off(dstr); /* one-shot flag */
4274 GvGP(dstr) = gp_ref(GvGP(sstr));
4275 if (SvTAINTED(sstr))
4277 if (GvIMPORTED(dstr) != GVf_IMPORTED
4278 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4280 GvIMPORTED_on(dstr);
4288 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4290 if ((int)SvTYPE(sstr) != stype) {
4291 stype = SvTYPE(sstr);
4292 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4296 if (stype == SVt_PVLV)
4297 SvUPGRADE(dstr, SVt_PVNV);
4299 SvUPGRADE(dstr, (U32)stype);
4302 sflags = SvFLAGS(sstr);
4304 if (sflags & SVf_ROK) {
4305 if (dtype >= SVt_PV) {
4306 if (dtype == SVt_PVGV) {
4307 SV *sref = SvREFCNT_inc(SvRV(sstr));
4309 const int intro = GvINTRO(dstr);
4311 #ifdef GV_UNIQUE_CHECK
4312 if (GvUNIQUE((GV*)dstr)) {
4313 Perl_croak(aTHX_ PL_no_modify);
4318 GvINTRO_off(dstr); /* one-shot flag */
4319 GvLINE(dstr) = CopLINE(PL_curcop);
4320 GvEGV(dstr) = (GV*)dstr;
4323 switch (SvTYPE(sref)) {
4326 SAVEGENERICSV(GvAV(dstr));
4328 dref = (SV*)GvAV(dstr);
4329 GvAV(dstr) = (AV*)sref;
4330 if (!GvIMPORTED_AV(dstr)
4331 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4333 GvIMPORTED_AV_on(dstr);
4338 SAVEGENERICSV(GvHV(dstr));
4340 dref = (SV*)GvHV(dstr);
4341 GvHV(dstr) = (HV*)sref;
4342 if (!GvIMPORTED_HV(dstr)
4343 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4345 GvIMPORTED_HV_on(dstr);
4350 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4351 SvREFCNT_dec(GvCV(dstr));
4352 GvCV(dstr) = Nullcv;
4353 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4354 PL_sub_generation++;
4356 SAVEGENERICSV(GvCV(dstr));
4359 dref = (SV*)GvCV(dstr);
4360 if (GvCV(dstr) != (CV*)sref) {
4361 CV* cv = GvCV(dstr);
4363 if (!GvCVGEN((GV*)dstr) &&
4364 (CvROOT(cv) || CvXSUB(cv)))
4366 /* ahem, death to those who redefine
4367 * active sort subs */
4368 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4369 PL_sortcop == CvSTART(cv))
4371 "Can't redefine active sort subroutine %s",
4372 GvENAME((GV*)dstr));
4373 /* Redefining a sub - warning is mandatory if
4374 it was a const and its value changed. */
4375 if (ckWARN(WARN_REDEFINE)
4377 && (!CvCONST((CV*)sref)
4378 || sv_cmp(cv_const_sv(cv),
4379 cv_const_sv((CV*)sref)))))
4381 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4383 ? "Constant subroutine %s::%s redefined"
4384 : "Subroutine %s::%s redefined",
4385 HvNAME_get(GvSTASH((GV*)dstr)),
4386 GvENAME((GV*)dstr));
4390 cv_ckproto(cv, (GV*)dstr,
4392 ? SvPVX_const(sref) : Nullch);
4394 GvCV(dstr) = (CV*)sref;
4395 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4396 GvASSUMECV_on(dstr);
4397 PL_sub_generation++;
4399 if (!GvIMPORTED_CV(dstr)
4400 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4402 GvIMPORTED_CV_on(dstr);
4407 SAVEGENERICSV(GvIOp(dstr));
4409 dref = (SV*)GvIOp(dstr);
4410 GvIOp(dstr) = (IO*)sref;
4414 SAVEGENERICSV(GvFORM(dstr));
4416 dref = (SV*)GvFORM(dstr);
4417 GvFORM(dstr) = (CV*)sref;
4421 SAVEGENERICSV(GvSV(dstr));
4423 dref = (SV*)GvSV(dstr);
4425 if (!GvIMPORTED_SV(dstr)
4426 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4428 GvIMPORTED_SV_on(dstr);
4434 if (SvTAINTED(sstr))
4438 if (SvPVX_const(dstr)) {
4444 (void)SvOK_off(dstr);
4445 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4447 if (sflags & SVp_NOK) {
4449 /* Only set the public OK flag if the source has public OK. */
4450 if (sflags & SVf_NOK)
4451 SvFLAGS(dstr) |= SVf_NOK;
4452 SvNV_set(dstr, SvNVX(sstr));
4454 if (sflags & SVp_IOK) {
4455 (void)SvIOKp_on(dstr);
4456 if (sflags & SVf_IOK)
4457 SvFLAGS(dstr) |= SVf_IOK;
4458 if (sflags & SVf_IVisUV)
4460 SvIV_set(dstr, SvIVX(sstr));
4462 if (SvAMAGIC(sstr)) {
4466 else if (sflags & SVp_POK) {
4470 * Check to see if we can just swipe the string. If so, it's a
4471 * possible small lose on short strings, but a big win on long ones.
4472 * It might even be a win on short strings if SvPVX_const(dstr)
4473 * has to be allocated and SvPVX_const(sstr) has to be freed.
4476 /* Whichever path we take through the next code, we want this true,
4477 and doing it now facilitates the COW check. */
4478 (void)SvPOK_only(dstr);
4481 /* We're not already COW */
4482 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4483 #ifndef PERL_OLD_COPY_ON_WRITE
4484 /* or we are, but dstr isn't a suitable target. */
4485 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4490 (sflags & SVs_TEMP) && /* slated for free anyway? */
4491 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4492 (!(flags & SV_NOSTEAL)) &&
4493 /* and we're allowed to steal temps */
4494 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4495 SvLEN(sstr) && /* and really is a string */
4496 /* and won't be needed again, potentially */
4497 !(PL_op && PL_op->op_type == OP_AASSIGN))
4498 #ifdef PERL_OLD_COPY_ON_WRITE
4499 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4500 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4501 && SvTYPE(sstr) >= SVt_PVIV)
4504 /* Failed the swipe test, and it's not a shared hash key either.
4505 Have to copy the string. */
4506 STRLEN len = SvCUR(sstr);
4507 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4508 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4509 SvCUR_set(dstr, len);
4510 *SvEND(dstr) = '\0';
4512 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4514 /* Either it's a shared hash key, or it's suitable for
4515 copy-on-write or we can swipe the string. */
4517 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4521 #ifdef PERL_OLD_COPY_ON_WRITE
4523 /* I believe I should acquire a global SV mutex if
4524 it's a COW sv (not a shared hash key) to stop
4525 it going un copy-on-write.
4526 If the source SV has gone un copy on write between up there
4527 and down here, then (assert() that) it is of the correct
4528 form to make it copy on write again */
4529 if ((sflags & (SVf_FAKE | SVf_READONLY))
4530 != (SVf_FAKE | SVf_READONLY)) {
4531 SvREADONLY_on(sstr);
4533 /* Make the source SV into a loop of 1.
4534 (about to become 2) */
4535 SV_COW_NEXT_SV_SET(sstr, sstr);
4539 /* Initial code is common. */
4540 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4542 SvFLAGS(dstr) &= ~SVf_OOK;
4543 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4545 else if (SvLEN(dstr))
4546 Safefree(SvPVX_const(dstr));
4550 /* making another shared SV. */
4551 STRLEN cur = SvCUR(sstr);
4552 STRLEN len = SvLEN(sstr);
4553 #ifdef PERL_OLD_COPY_ON_WRITE
4555 assert (SvTYPE(dstr) >= SVt_PVIV);
4556 /* SvIsCOW_normal */
4557 /* splice us in between source and next-after-source. */
4558 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4559 SV_COW_NEXT_SV_SET(sstr, dstr);
4560 SvPV_set(dstr, SvPVX_mutable(sstr));
4564 /* SvIsCOW_shared_hash */
4565 DEBUG_C(PerlIO_printf(Perl_debug_log,
4566 "Copy on write: Sharing hash\n"));
4568 assert (SvTYPE(dstr) >= SVt_PV);
4570 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4572 SvLEN_set(dstr, len);
4573 SvCUR_set(dstr, cur);
4574 SvREADONLY_on(dstr);
4576 /* Relesase a global SV mutex. */
4579 { /* Passes the swipe test. */
4580 SvPV_set(dstr, SvPVX_mutable(sstr));
4581 SvLEN_set(dstr, SvLEN(sstr));
4582 SvCUR_set(dstr, SvCUR(sstr));
4585 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4586 SvPV_set(sstr, Nullch);
4592 if (sflags & SVf_UTF8)
4595 if (sflags & SVp_NOK) {
4597 if (sflags & SVf_NOK)
4598 SvFLAGS(dstr) |= SVf_NOK;
4599 SvNV_set(dstr, SvNVX(sstr));
4601 if (sflags & SVp_IOK) {
4602 (void)SvIOKp_on(dstr);
4603 if (sflags & SVf_IOK)
4604 SvFLAGS(dstr) |= SVf_IOK;
4605 if (sflags & SVf_IVisUV)
4607 SvIV_set(dstr, SvIVX(sstr));
4610 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4611 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4612 smg->mg_ptr, smg->mg_len);
4613 SvRMAGICAL_on(dstr);
4616 else if (sflags & SVp_IOK) {
4617 if (sflags & SVf_IOK)
4618 (void)SvIOK_only(dstr);
4620 (void)SvOK_off(dstr);
4621 (void)SvIOKp_on(dstr);
4623 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4624 if (sflags & SVf_IVisUV)
4626 SvIV_set(dstr, SvIVX(sstr));
4627 if (sflags & SVp_NOK) {
4628 if (sflags & SVf_NOK)
4629 (void)SvNOK_on(dstr);
4631 (void)SvNOKp_on(dstr);
4632 SvNV_set(dstr, SvNVX(sstr));
4635 else if (sflags & SVp_NOK) {
4636 if (sflags & SVf_NOK)
4637 (void)SvNOK_only(dstr);
4639 (void)SvOK_off(dstr);
4642 SvNV_set(dstr, SvNVX(sstr));
4645 if (dtype == SVt_PVGV) {
4646 if (ckWARN(WARN_MISC))
4647 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4650 (void)SvOK_off(dstr);
4652 if (SvTAINTED(sstr))
4657 =for apidoc sv_setsv_mg
4659 Like C<sv_setsv>, but also handles 'set' magic.
4665 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4667 sv_setsv(dstr,sstr);
4671 #ifdef PERL_OLD_COPY_ON_WRITE
4673 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4675 STRLEN cur = SvCUR(sstr);
4676 STRLEN len = SvLEN(sstr);
4677 register char *new_pv;
4680 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4688 if (SvTHINKFIRST(dstr))
4689 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4690 else if (SvPVX_const(dstr))
4691 Safefree(SvPVX_const(dstr));
4695 SvUPGRADE(dstr, SVt_PVIV);
4697 assert (SvPOK(sstr));
4698 assert (SvPOKp(sstr));
4699 assert (!SvIOK(sstr));
4700 assert (!SvIOKp(sstr));
4701 assert (!SvNOK(sstr));
4702 assert (!SvNOKp(sstr));
4704 if (SvIsCOW(sstr)) {
4706 if (SvLEN(sstr) == 0) {
4707 /* source is a COW shared hash key. */
4708 DEBUG_C(PerlIO_printf(Perl_debug_log,
4709 "Fast copy on write: Sharing hash\n"));
4710 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4713 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4715 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4716 SvUPGRADE(sstr, SVt_PVIV);
4717 SvREADONLY_on(sstr);
4719 DEBUG_C(PerlIO_printf(Perl_debug_log,
4720 "Fast copy on write: Converting sstr to COW\n"));
4721 SV_COW_NEXT_SV_SET(dstr, sstr);
4723 SV_COW_NEXT_SV_SET(sstr, dstr);
4724 new_pv = SvPVX_mutable(sstr);
4727 SvPV_set(dstr, new_pv);
4728 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4731 SvLEN_set(dstr, len);
4732 SvCUR_set(dstr, cur);
4741 =for apidoc sv_setpvn
4743 Copies a string into an SV. The C<len> parameter indicates the number of
4744 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4745 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4751 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4753 register char *dptr;
4755 SV_CHECK_THINKFIRST_COW_DROP(sv);
4761 /* len is STRLEN which is unsigned, need to copy to signed */
4764 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4766 SvUPGRADE(sv, SVt_PV);
4768 dptr = SvGROW(sv, len + 1);
4769 Move(ptr,dptr,len,char);
4772 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4777 =for apidoc sv_setpvn_mg
4779 Like C<sv_setpvn>, but also handles 'set' magic.
4785 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4787 sv_setpvn(sv,ptr,len);
4792 =for apidoc sv_setpv
4794 Copies a string into an SV. The string must be null-terminated. Does not
4795 handle 'set' magic. See C<sv_setpv_mg>.
4801 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4803 register STRLEN len;
4805 SV_CHECK_THINKFIRST_COW_DROP(sv);
4811 SvUPGRADE(sv, SVt_PV);
4813 SvGROW(sv, len + 1);
4814 Move(ptr,SvPVX(sv),len+1,char);
4816 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4821 =for apidoc sv_setpv_mg
4823 Like C<sv_setpv>, but also handles 'set' magic.
4829 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4836 =for apidoc sv_usepvn
4838 Tells an SV to use C<ptr> to find its string value. Normally the string is
4839 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4840 The C<ptr> should point to memory that was allocated by C<malloc>. The
4841 string length, C<len>, must be supplied. This function will realloc the
4842 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4843 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4844 See C<sv_usepvn_mg>.
4850 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4853 SV_CHECK_THINKFIRST_COW_DROP(sv);
4854 SvUPGRADE(sv, SVt_PV);
4859 if (SvPVX_const(sv))
4862 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4863 ptr = saferealloc (ptr, allocate);
4866 SvLEN_set(sv, allocate);
4868 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4873 =for apidoc sv_usepvn_mg
4875 Like C<sv_usepvn>, but also handles 'set' magic.
4881 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4883 sv_usepvn(sv,ptr,len);
4887 #ifdef PERL_OLD_COPY_ON_WRITE
4888 /* Need to do this *after* making the SV normal, as we need the buffer
4889 pointer to remain valid until after we've copied it. If we let go too early,
4890 another thread could invalidate it by unsharing last of the same hash key
4891 (which it can do by means other than releasing copy-on-write Svs)
4892 or by changing the other copy-on-write SVs in the loop. */
4894 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4896 if (len) { /* this SV was SvIsCOW_normal(sv) */
4897 /* we need to find the SV pointing to us. */
4898 SV *current = SV_COW_NEXT_SV(after);
4900 if (current == sv) {
4901 /* The SV we point to points back to us (there were only two of us
4903 Hence other SV is no longer copy on write either. */
4905 SvREADONLY_off(after);
4907 /* We need to follow the pointers around the loop. */
4909 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4912 /* don't loop forever if the structure is bust, and we have
4913 a pointer into a closed loop. */
4914 assert (current != after);
4915 assert (SvPVX_const(current) == pvx);
4917 /* Make the SV before us point to the SV after us. */
4918 SV_COW_NEXT_SV_SET(current, after);
4921 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4926 Perl_sv_release_IVX(pTHX_ register SV *sv)
4929 sv_force_normal_flags(sv, 0);
4935 =for apidoc sv_force_normal_flags
4937 Undo various types of fakery on an SV: if the PV is a shared string, make
4938 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4939 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4940 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4941 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4942 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4943 set to some other value.) In addition, the C<flags> parameter gets passed to
4944 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4945 with flags set to 0.
4951 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4953 #ifdef PERL_OLD_COPY_ON_WRITE
4954 if (SvREADONLY(sv)) {
4955 /* At this point I believe I should acquire a global SV mutex. */
4957 const char *pvx = SvPVX_const(sv);
4958 const STRLEN len = SvLEN(sv);
4959 const STRLEN cur = SvCUR(sv);
4960 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4962 PerlIO_printf(Perl_debug_log,
4963 "Copy on write: Force normal %ld\n",
4969 /* This SV doesn't own the buffer, so need to New() a new one: */
4970 SvPV_set(sv, (char*)0);
4972 if (flags & SV_COW_DROP_PV) {
4973 /* OK, so we don't need to copy our buffer. */
4976 SvGROW(sv, cur + 1);
4977 Move(pvx,SvPVX(sv),cur,char);
4981 sv_release_COW(sv, pvx, len, next);
4986 else if (IN_PERL_RUNTIME)
4987 Perl_croak(aTHX_ PL_no_modify);
4988 /* At this point I believe that I can drop the global SV mutex. */
4991 if (SvREADONLY(sv)) {
4993 const char *pvx = SvPVX_const(sv);
4994 const STRLEN len = SvCUR(sv);
4997 SvPV_set(sv, Nullch);
4999 SvGROW(sv, len + 1);
5000 Move(pvx,SvPVX_const(sv),len,char);
5002 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
5004 else if (IN_PERL_RUNTIME)
5005 Perl_croak(aTHX_ PL_no_modify);
5009 sv_unref_flags(sv, flags);
5010 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5015 =for apidoc sv_force_normal
5017 Undo various types of fakery on an SV: if the PV is a shared string, make
5018 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5019 an xpvmg. See also C<sv_force_normal_flags>.
5025 Perl_sv_force_normal(pTHX_ register SV *sv)
5027 sv_force_normal_flags(sv, 0);
5033 Efficient removal of characters from the beginning of the string buffer.
5034 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5035 the string buffer. The C<ptr> becomes the first character of the adjusted
5036 string. Uses the "OOK hack".
5037 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5038 refer to the same chunk of data.
5044 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5046 register STRLEN delta;
5047 if (!ptr || !SvPOKp(sv))
5049 delta = ptr - SvPVX_const(sv);
5050 SV_CHECK_THINKFIRST(sv);
5051 if (SvTYPE(sv) < SVt_PVIV)
5052 sv_upgrade(sv,SVt_PVIV);
5055 if (!SvLEN(sv)) { /* make copy of shared string */
5056 const char *pvx = SvPVX_const(sv);
5057 const STRLEN len = SvCUR(sv);
5058 SvGROW(sv, len + 1);
5059 Move(pvx,SvPVX_const(sv),len,char);
5063 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5064 and we do that anyway inside the SvNIOK_off
5066 SvFLAGS(sv) |= SVf_OOK;
5069 SvLEN_set(sv, SvLEN(sv) - delta);
5070 SvCUR_set(sv, SvCUR(sv) - delta);
5071 SvPV_set(sv, SvPVX(sv) + delta);
5072 SvIV_set(sv, SvIVX(sv) + delta);
5075 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5076 * this function provided for binary compatibility only
5080 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5082 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5086 =for apidoc sv_catpvn
5088 Concatenates the string onto the end of the string which is in the SV. The
5089 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5090 status set, then the bytes appended should be valid UTF-8.
5091 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5093 =for apidoc sv_catpvn_flags
5095 Concatenates the string onto the end of the string which is in the SV. The
5096 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5097 status set, then the bytes appended should be valid UTF-8.
5098 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5099 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5100 in terms of this function.
5106 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5109 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5111 SvGROW(dsv, dlen + slen + 1);
5113 sstr = SvPVX_const(dsv);
5114 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5115 SvCUR_set(dsv, SvCUR(dsv) + slen);
5117 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5122 =for apidoc sv_catpvn_mg
5124 Like C<sv_catpvn>, but also handles 'set' magic.
5130 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5132 sv_catpvn(sv,ptr,len);
5136 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5137 * this function provided for binary compatibility only
5141 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5143 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5147 =for apidoc sv_catsv
5149 Concatenates the string from SV C<ssv> onto the end of the string in
5150 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5151 not 'set' magic. See C<sv_catsv_mg>.
5153 =for apidoc sv_catsv_flags
5155 Concatenates the string from SV C<ssv> onto the end of the string in
5156 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5157 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5158 and C<sv_catsv_nomg> are implemented in terms of this function.
5163 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5169 if ((spv = SvPV_const(ssv, slen))) {
5170 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5171 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5172 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5173 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5174 dsv->sv_flags doesn't have that bit set.
5175 Andy Dougherty 12 Oct 2001
5177 const I32 sutf8 = DO_UTF8(ssv);
5180 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5182 dutf8 = DO_UTF8(dsv);
5184 if (dutf8 != sutf8) {
5186 /* Not modifying source SV, so taking a temporary copy. */
5187 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5189 sv_utf8_upgrade(csv);
5190 spv = SvPV_const(csv, slen);
5193 sv_utf8_upgrade_nomg(dsv);
5195 sv_catpvn_nomg(dsv, spv, slen);
5200 =for apidoc sv_catsv_mg
5202 Like C<sv_catsv>, but also handles 'set' magic.
5208 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5215 =for apidoc sv_catpv
5217 Concatenates the string onto the end of the string which is in the SV.
5218 If the SV has the UTF-8 status set, then the bytes appended should be
5219 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5224 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5226 register STRLEN len;
5232 junk = SvPV_force(sv, tlen);
5234 SvGROW(sv, tlen + len + 1);
5236 ptr = SvPVX_const(sv);
5237 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5238 SvCUR_set(sv, SvCUR(sv) + len);
5239 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5244 =for apidoc sv_catpv_mg
5246 Like C<sv_catpv>, but also handles 'set' magic.
5252 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5261 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5262 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5269 Perl_newSV(pTHX_ STRLEN len)
5275 sv_upgrade(sv, SVt_PV);
5276 SvGROW(sv, len + 1);
5281 =for apidoc sv_magicext
5283 Adds magic to an SV, upgrading it if necessary. Applies the
5284 supplied vtable and returns a pointer to the magic added.
5286 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5287 In particular, you can add magic to SvREADONLY SVs, and add more than
5288 one instance of the same 'how'.
5290 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5291 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5292 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5293 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5295 (This is now used as a subroutine by C<sv_magic>.)
5300 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5301 const char* name, I32 namlen)
5305 if (SvTYPE(sv) < SVt_PVMG) {
5306 SvUPGRADE(sv, SVt_PVMG);
5308 Newz(702,mg, 1, MAGIC);
5309 mg->mg_moremagic = SvMAGIC(sv);
5310 SvMAGIC_set(sv, mg);
5312 /* Sometimes a magic contains a reference loop, where the sv and
5313 object refer to each other. To prevent a reference loop that
5314 would prevent such objects being freed, we look for such loops
5315 and if we find one we avoid incrementing the object refcount.
5317 Note we cannot do this to avoid self-tie loops as intervening RV must
5318 have its REFCNT incremented to keep it in existence.
5321 if (!obj || obj == sv ||
5322 how == PERL_MAGIC_arylen ||
5323 how == PERL_MAGIC_qr ||
5324 how == PERL_MAGIC_symtab ||
5325 (SvTYPE(obj) == SVt_PVGV &&
5326 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5327 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5328 GvFORM(obj) == (CV*)sv)))
5333 mg->mg_obj = SvREFCNT_inc(obj);
5334 mg->mg_flags |= MGf_REFCOUNTED;
5337 /* Normal self-ties simply pass a null object, and instead of
5338 using mg_obj directly, use the SvTIED_obj macro to produce a
5339 new RV as needed. For glob "self-ties", we are tieing the PVIO
5340 with an RV obj pointing to the glob containing the PVIO. In
5341 this case, to avoid a reference loop, we need to weaken the
5345 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5346 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5352 mg->mg_len = namlen;
5355 mg->mg_ptr = savepvn(name, namlen);
5356 else if (namlen == HEf_SVKEY)
5357 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5359 mg->mg_ptr = (char *) name;
5361 mg->mg_virtual = vtable;
5365 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5370 =for apidoc sv_magic
5372 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5373 then adds a new magic item of type C<how> to the head of the magic list.
5375 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5376 handling of the C<name> and C<namlen> arguments.
5378 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5379 to add more than one instance of the same 'how'.
5385 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5387 const MGVTBL *vtable = 0;
5390 #ifdef PERL_OLD_COPY_ON_WRITE
5392 sv_force_normal_flags(sv, 0);
5394 if (SvREADONLY(sv)) {
5396 && how != PERL_MAGIC_regex_global
5397 && how != PERL_MAGIC_bm
5398 && how != PERL_MAGIC_fm
5399 && how != PERL_MAGIC_sv
5400 && how != PERL_MAGIC_backref
5403 Perl_croak(aTHX_ PL_no_modify);
5406 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5407 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5408 /* sv_magic() refuses to add a magic of the same 'how' as an
5411 if (how == PERL_MAGIC_taint)
5419 vtable = &PL_vtbl_sv;
5421 case PERL_MAGIC_overload:
5422 vtable = &PL_vtbl_amagic;
5424 case PERL_MAGIC_overload_elem:
5425 vtable = &PL_vtbl_amagicelem;
5427 case PERL_MAGIC_overload_table:
5428 vtable = &PL_vtbl_ovrld;
5431 vtable = &PL_vtbl_bm;
5433 case PERL_MAGIC_regdata:
5434 vtable = &PL_vtbl_regdata;
5436 case PERL_MAGIC_regdatum:
5437 vtable = &PL_vtbl_regdatum;
5439 case PERL_MAGIC_env:
5440 vtable = &PL_vtbl_env;
5443 vtable = &PL_vtbl_fm;
5445 case PERL_MAGIC_envelem:
5446 vtable = &PL_vtbl_envelem;
5448 case PERL_MAGIC_regex_global:
5449 vtable = &PL_vtbl_mglob;
5451 case PERL_MAGIC_isa:
5452 vtable = &PL_vtbl_isa;
5454 case PERL_MAGIC_isaelem:
5455 vtable = &PL_vtbl_isaelem;
5457 case PERL_MAGIC_nkeys:
5458 vtable = &PL_vtbl_nkeys;
5460 case PERL_MAGIC_dbfile:
5463 case PERL_MAGIC_dbline:
5464 vtable = &PL_vtbl_dbline;
5466 #ifdef USE_LOCALE_COLLATE
5467 case PERL_MAGIC_collxfrm:
5468 vtable = &PL_vtbl_collxfrm;
5470 #endif /* USE_LOCALE_COLLATE */
5471 case PERL_MAGIC_tied:
5472 vtable = &PL_vtbl_pack;
5474 case PERL_MAGIC_tiedelem:
5475 case PERL_MAGIC_tiedscalar:
5476 vtable = &PL_vtbl_packelem;
5479 vtable = &PL_vtbl_regexp;
5481 case PERL_MAGIC_sig:
5482 vtable = &PL_vtbl_sig;
5484 case PERL_MAGIC_sigelem:
5485 vtable = &PL_vtbl_sigelem;
5487 case PERL_MAGIC_taint:
5488 vtable = &PL_vtbl_taint;
5490 case PERL_MAGIC_uvar:
5491 vtable = &PL_vtbl_uvar;
5493 case PERL_MAGIC_vec:
5494 vtable = &PL_vtbl_vec;
5496 case PERL_MAGIC_arylen_p:
5497 case PERL_MAGIC_rhash:
5498 case PERL_MAGIC_symtab:
5499 case PERL_MAGIC_vstring:
5502 case PERL_MAGIC_utf8:
5503 vtable = &PL_vtbl_utf8;
5505 case PERL_MAGIC_substr:
5506 vtable = &PL_vtbl_substr;
5508 case PERL_MAGIC_defelem:
5509 vtable = &PL_vtbl_defelem;
5511 case PERL_MAGIC_glob:
5512 vtable = &PL_vtbl_glob;
5514 case PERL_MAGIC_arylen:
5515 vtable = &PL_vtbl_arylen;
5517 case PERL_MAGIC_pos:
5518 vtable = &PL_vtbl_pos;
5520 case PERL_MAGIC_backref:
5521 vtable = &PL_vtbl_backref;
5523 case PERL_MAGIC_ext:
5524 /* Reserved for use by extensions not perl internals. */
5525 /* Useful for attaching extension internal data to perl vars. */
5526 /* Note that multiple extensions may clash if magical scalars */
5527 /* etc holding private data from one are passed to another. */
5530 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5533 /* Rest of work is done else where */
5534 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5537 case PERL_MAGIC_taint:
5540 case PERL_MAGIC_ext:
5541 case PERL_MAGIC_dbfile:
5548 =for apidoc sv_unmagic
5550 Removes all magic of type C<type> from an SV.
5556 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5560 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5563 for (mg = *mgp; mg; mg = *mgp) {
5564 if (mg->mg_type == type) {
5565 const MGVTBL* const vtbl = mg->mg_virtual;
5566 *mgp = mg->mg_moremagic;
5567 if (vtbl && vtbl->svt_free)
5568 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5569 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5571 Safefree(mg->mg_ptr);
5572 else if (mg->mg_len == HEf_SVKEY)
5573 SvREFCNT_dec((SV*)mg->mg_ptr);
5574 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5575 Safefree(mg->mg_ptr);
5577 if (mg->mg_flags & MGf_REFCOUNTED)
5578 SvREFCNT_dec(mg->mg_obj);
5582 mgp = &mg->mg_moremagic;
5586 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5593 =for apidoc sv_rvweaken
5595 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5596 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5597 push a back-reference to this RV onto the array of backreferences
5598 associated with that magic.
5604 Perl_sv_rvweaken(pTHX_ SV *sv)
5607 if (!SvOK(sv)) /* let undefs pass */
5610 Perl_croak(aTHX_ "Can't weaken a nonreference");
5611 else if (SvWEAKREF(sv)) {
5612 if (ckWARN(WARN_MISC))
5613 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5617 sv_add_backref(tsv, sv);
5623 /* Give tsv backref magic if it hasn't already got it, then push a
5624 * back-reference to sv onto the array associated with the backref magic.
5628 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5632 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5633 av = (AV*)mg->mg_obj;
5636 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5637 /* av now has a refcnt of 2, which avoids it getting freed
5638 * before us during global cleanup. The extra ref is removed
5639 * by magic_killbackrefs() when tsv is being freed */
5641 if (AvFILLp(av) >= AvMAX(av)) {
5643 SV **svp = AvARRAY(av);
5644 for (i = AvFILLp(av); i >= 0; i--)
5646 svp[i] = sv; /* reuse the slot */
5649 av_extend(av, AvFILLp(av)+1);
5651 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5654 /* delete a back-reference to ourselves from the backref magic associated
5655 * with the SV we point to.
5659 S_sv_del_backref(pTHX_ SV *sv)
5666 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5667 Perl_croak(aTHX_ "panic: del_backref");
5668 av = (AV *)mg->mg_obj;
5670 for (i = AvFILLp(av); i >= 0; i--)
5671 if (svp[i] == sv) svp[i] = Nullsv;
5675 =for apidoc sv_insert
5677 Inserts a string at the specified offset/length within the SV. Similar to
5678 the Perl substr() function.
5684 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5688 register char *midend;
5689 register char *bigend;
5695 Perl_croak(aTHX_ "Can't modify non-existent substring");
5696 SvPV_force(bigstr, curlen);
5697 (void)SvPOK_only_UTF8(bigstr);
5698 if (offset + len > curlen) {
5699 SvGROW(bigstr, offset+len+1);
5700 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5701 SvCUR_set(bigstr, offset+len);
5705 i = littlelen - len;
5706 if (i > 0) { /* string might grow */
5707 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5708 mid = big + offset + len;
5709 midend = bigend = big + SvCUR(bigstr);
5712 while (midend > mid) /* shove everything down */
5713 *--bigend = *--midend;
5714 Move(little,big+offset,littlelen,char);
5715 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5720 Move(little,SvPVX(bigstr)+offset,len,char);
5725 big = SvPVX(bigstr);
5728 bigend = big + SvCUR(bigstr);
5730 if (midend > bigend)
5731 Perl_croak(aTHX_ "panic: sv_insert");
5733 if (mid - big > bigend - midend) { /* faster to shorten from end */
5735 Move(little, mid, littlelen,char);
5738 i = bigend - midend;
5740 Move(midend, mid, i,char);
5744 SvCUR_set(bigstr, mid - big);
5747 else if ((i = mid - big)) { /* faster from front */
5748 midend -= littlelen;
5750 sv_chop(bigstr,midend-i);
5755 Move(little, mid, littlelen,char);
5757 else if (littlelen) {
5758 midend -= littlelen;
5759 sv_chop(bigstr,midend);
5760 Move(little,midend,littlelen,char);
5763 sv_chop(bigstr,midend);
5769 =for apidoc sv_replace
5771 Make the first argument a copy of the second, then delete the original.
5772 The target SV physically takes over ownership of the body of the source SV
5773 and inherits its flags; however, the target keeps any magic it owns,
5774 and any magic in the source is discarded.
5775 Note that this is a rather specialist SV copying operation; most of the
5776 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5782 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5784 const U32 refcnt = SvREFCNT(sv);
5785 SV_CHECK_THINKFIRST_COW_DROP(sv);
5786 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5787 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5788 if (SvMAGICAL(sv)) {
5792 sv_upgrade(nsv, SVt_PVMG);
5793 SvMAGIC_set(nsv, SvMAGIC(sv));
5794 SvFLAGS(nsv) |= SvMAGICAL(sv);
5796 SvMAGIC_set(sv, NULL);
5800 assert(!SvREFCNT(sv));
5801 #ifdef DEBUG_LEAKING_SCALARS
5802 sv->sv_flags = nsv->sv_flags;
5803 sv->sv_any = nsv->sv_any;
5804 sv->sv_refcnt = nsv->sv_refcnt;
5805 sv->sv_u = nsv->sv_u;
5807 StructCopy(nsv,sv,SV);
5809 /* Currently could join these into one piece of pointer arithmetic, but
5810 it would be unclear. */
5811 if(SvTYPE(sv) == SVt_IV)
5813 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5814 else if (SvTYPE(sv) == SVt_RV) {
5815 SvANY(sv) = &sv->sv_u.svu_rv;
5819 #ifdef PERL_OLD_COPY_ON_WRITE
5820 if (SvIsCOW_normal(nsv)) {
5821 /* We need to follow the pointers around the loop to make the
5822 previous SV point to sv, rather than nsv. */
5825 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5828 assert(SvPVX_const(current) == SvPVX_const(nsv));
5830 /* Make the SV before us point to the SV after us. */
5832 PerlIO_printf(Perl_debug_log, "previous is\n");
5834 PerlIO_printf(Perl_debug_log,
5835 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5836 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5838 SV_COW_NEXT_SV_SET(current, sv);
5841 SvREFCNT(sv) = refcnt;
5842 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5848 =for apidoc sv_clear
5850 Clear an SV: call any destructors, free up any memory used by the body,
5851 and free the body itself. The SV's head is I<not> freed, although
5852 its type is set to all 1's so that it won't inadvertently be assumed
5853 to be live during global destruction etc.
5854 This function should only be called when REFCNT is zero. Most of the time
5855 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5862 Perl_sv_clear(pTHX_ register SV *sv)
5867 assert(SvREFCNT(sv) == 0);
5870 if (PL_defstash) { /* Still have a symbol table? */
5874 stash = SvSTASH(sv);
5875 destructor = StashHANDLER(stash,DESTROY);
5877 SV* tmpref = newRV(sv);
5878 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5880 PUSHSTACKi(PERLSI_DESTROY);
5885 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5891 if(SvREFCNT(tmpref) < 2) {
5892 /* tmpref is not kept alive! */
5894 SvRV_set(tmpref, NULL);
5897 SvREFCNT_dec(tmpref);
5899 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5903 if (PL_in_clean_objs)
5904 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5906 /* DESTROY gave object new lease on life */
5912 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5913 SvOBJECT_off(sv); /* Curse the object. */
5914 if (SvTYPE(sv) != SVt_PVIO)
5915 --PL_sv_objcount; /* XXX Might want something more general */
5918 if (SvTYPE(sv) >= SVt_PVMG) {
5921 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5922 SvREFCNT_dec(SvSTASH(sv));
5925 switch (SvTYPE(sv)) {
5928 IoIFP(sv) != PerlIO_stdin() &&
5929 IoIFP(sv) != PerlIO_stdout() &&
5930 IoIFP(sv) != PerlIO_stderr())
5932 io_close((IO*)sv, FALSE);
5934 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5935 PerlDir_close(IoDIRP(sv));
5936 IoDIRP(sv) = (DIR*)NULL;
5937 Safefree(IoTOP_NAME(sv));
5938 Safefree(IoFMT_NAME(sv));
5939 Safefree(IoBOTTOM_NAME(sv));
5954 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5955 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5956 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5957 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5959 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5960 SvREFCNT_dec(LvTARG(sv));
5964 Safefree(GvNAME(sv));
5965 /* cannot decrease stash refcount yet, as we might recursively delete
5966 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5967 of stash until current sv is completely gone.
5968 -- JohnPC, 27 Mar 1998 */
5969 stash = GvSTASH(sv);
5975 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5977 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5978 /* Don't even bother with turning off the OOK flag. */
5987 SvREFCNT_dec(SvRV(sv));
5989 #ifdef PERL_OLD_COPY_ON_WRITE
5990 else if (SvPVX_const(sv)) {
5992 /* I believe I need to grab the global SV mutex here and
5993 then recheck the COW status. */
5995 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5998 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5999 SV_COW_NEXT_SV(sv));
6000 /* And drop it here. */
6002 } else if (SvLEN(sv)) {
6003 Safefree(SvPVX_const(sv));
6007 else if (SvPVX_const(sv) && SvLEN(sv))
6008 Safefree(SvPVX_const(sv));
6009 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6010 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6023 switch (SvTYPE(sv)) {
6037 del_XPVIV(SvANY(sv));
6040 del_XPVNV(SvANY(sv));
6043 del_XPVMG(SvANY(sv));
6046 del_XPVLV(SvANY(sv));
6049 del_XPVAV(SvANY(sv));
6052 del_XPVHV(SvANY(sv));
6055 del_XPVCV(SvANY(sv));
6058 del_XPVGV(SvANY(sv));
6059 /* code duplication for increased performance. */
6060 SvFLAGS(sv) &= SVf_BREAK;
6061 SvFLAGS(sv) |= SVTYPEMASK;
6062 /* decrease refcount of the stash that owns this GV, if any */
6064 SvREFCNT_dec(stash);
6065 return; /* not break, SvFLAGS reset already happened */
6067 del_XPVBM(SvANY(sv));
6070 del_XPVFM(SvANY(sv));
6073 del_XPVIO(SvANY(sv));
6076 SvFLAGS(sv) &= SVf_BREAK;
6077 SvFLAGS(sv) |= SVTYPEMASK;
6081 =for apidoc sv_newref
6083 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6090 Perl_sv_newref(pTHX_ SV *sv)
6100 Decrement an SV's reference count, and if it drops to zero, call
6101 C<sv_clear> to invoke destructors and free up any memory used by
6102 the body; finally, deallocate the SV's head itself.
6103 Normally called via a wrapper macro C<SvREFCNT_dec>.
6109 Perl_sv_free(pTHX_ SV *sv)
6114 if (SvREFCNT(sv) == 0) {
6115 if (SvFLAGS(sv) & SVf_BREAK)
6116 /* this SV's refcnt has been artificially decremented to
6117 * trigger cleanup */
6119 if (PL_in_clean_all) /* All is fair */
6121 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6122 /* make sure SvREFCNT(sv)==0 happens very seldom */
6123 SvREFCNT(sv) = (~(U32)0)/2;
6126 if (ckWARN_d(WARN_INTERNAL))
6127 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6128 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6129 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6132 if (--(SvREFCNT(sv)) > 0)
6134 Perl_sv_free2(aTHX_ sv);
6138 Perl_sv_free2(pTHX_ SV *sv)
6143 if (ckWARN_d(WARN_DEBUGGING))
6144 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6145 "Attempt to free temp prematurely: SV 0x%"UVxf
6146 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6150 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6151 /* make sure SvREFCNT(sv)==0 happens very seldom */
6152 SvREFCNT(sv) = (~(U32)0)/2;
6163 Returns the length of the string in the SV. Handles magic and type
6164 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6170 Perl_sv_len(pTHX_ register SV *sv)
6178 len = mg_length(sv);
6180 (void)SvPV_const(sv, len);
6185 =for apidoc sv_len_utf8
6187 Returns the number of characters in the string in an SV, counting wide
6188 UTF-8 bytes as a single character. Handles magic and type coercion.
6194 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6195 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6196 * (Note that the mg_len is not the length of the mg_ptr field.)
6201 Perl_sv_len_utf8(pTHX_ register SV *sv)
6207 return mg_length(sv);
6211 const U8 *s = (U8*)SvPV_const(sv, len);
6212 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6214 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6216 #ifdef PERL_UTF8_CACHE_ASSERT
6217 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6221 ulen = Perl_utf8_length(aTHX_ s, s + len);
6222 if (!mg && !SvREADONLY(sv)) {
6223 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6224 mg = mg_find(sv, PERL_MAGIC_utf8);
6234 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6235 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6236 * between UTF-8 and byte offsets. There are two (substr offset and substr
6237 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6238 * and byte offset) cache positions.
6240 * The mg_len field is used by sv_len_utf8(), see its comments.
6241 * Note that the mg_len is not the length of the mg_ptr field.
6245 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
6246 I32 offsetp, const U8 *s, const U8 *start)
6250 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6252 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6256 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6258 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6259 (*mgp)->mg_ptr = (char *) *cachep;
6263 (*cachep)[i] = offsetp;
6264 (*cachep)[i+1] = s - start;
6272 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6273 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6274 * between UTF-8 and byte offsets. See also the comments of
6275 * S_utf8_mg_pos_init().
6279 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
6283 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6285 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6286 if (*mgp && (*mgp)->mg_ptr) {
6287 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6288 ASSERT_UTF8_CACHE(*cachep);
6289 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6291 else { /* We will skip to the right spot. */
6296 /* The assumption is that going backward is half
6297 * the speed of going forward (that's where the
6298 * 2 * backw in the below comes from). (The real
6299 * figure of course depends on the UTF-8 data.) */
6301 if ((*cachep)[i] > (STRLEN)uoff) {
6303 backw = (*cachep)[i] - (STRLEN)uoff;
6305 if (forw < 2 * backw)
6308 p = start + (*cachep)[i+1];
6310 /* Try this only for the substr offset (i == 0),
6311 * not for the substr length (i == 2). */
6312 else if (i == 0) { /* (*cachep)[i] < uoff */
6313 const STRLEN ulen = sv_len_utf8(sv);
6315 if ((STRLEN)uoff < ulen) {
6316 forw = (STRLEN)uoff - (*cachep)[i];
6317 backw = ulen - (STRLEN)uoff;
6319 if (forw < 2 * backw)
6320 p = start + (*cachep)[i+1];
6325 /* If the string is not long enough for uoff,
6326 * we could extend it, but not at this low a level. */
6330 if (forw < 2 * backw) {
6337 while (UTF8_IS_CONTINUATION(*p))
6342 /* Update the cache. */
6343 (*cachep)[i] = (STRLEN)uoff;
6344 (*cachep)[i+1] = p - start;
6346 /* Drop the stale "length" cache */
6355 if (found) { /* Setup the return values. */
6356 *offsetp = (*cachep)[i+1];
6357 *sp = start + *offsetp;
6360 *offsetp = send - start;
6362 else if (*sp < start) {
6368 #ifdef PERL_UTF8_CACHE_ASSERT
6373 while (n-- && s < send)
6377 assert(*offsetp == s - start);
6378 assert((*cachep)[0] == (STRLEN)uoff);
6379 assert((*cachep)[1] == *offsetp);
6381 ASSERT_UTF8_CACHE(*cachep);
6390 =for apidoc sv_pos_u2b
6392 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6393 the start of the string, to a count of the equivalent number of bytes; if
6394 lenp is non-zero, it does the same to lenp, but this time starting from
6395 the offset, rather than from the start of the string. Handles magic and
6402 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6403 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6404 * byte offsets. See also the comments of S_utf8_mg_pos().
6409 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6417 start = (U8*)SvPV_const(sv, len);
6421 const U8 *s = start;
6422 I32 uoffset = *offsetp;
6423 const U8 *send = s + len;
6427 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6429 if (!found && uoffset > 0) {
6430 while (s < send && uoffset--)
6434 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6436 *offsetp = s - start;
6441 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6445 if (!found && *lenp > 0) {
6448 while (s < send && ulen--)
6452 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6456 ASSERT_UTF8_CACHE(cache);
6468 =for apidoc sv_pos_b2u
6470 Converts the value pointed to by offsetp from a count of bytes from the
6471 start of the string, to a count of the equivalent number of UTF-8 chars.
6472 Handles magic and type coercion.
6478 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6479 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6480 * byte offsets. See also the comments of S_utf8_mg_pos().
6485 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6493 s = (const U8*)SvPV_const(sv, len);
6494 if ((I32)len < *offsetp)
6495 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6497 const U8* send = s + *offsetp;
6499 STRLEN *cache = NULL;
6503 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6504 mg = mg_find(sv, PERL_MAGIC_utf8);
6505 if (mg && mg->mg_ptr) {
6506 cache = (STRLEN *) mg->mg_ptr;
6507 if (cache[1] == (STRLEN)*offsetp) {
6508 /* An exact match. */
6509 *offsetp = cache[0];
6513 else if (cache[1] < (STRLEN)*offsetp) {
6514 /* We already know part of the way. */
6517 /* Let the below loop do the rest. */
6519 else { /* cache[1] > *offsetp */
6520 /* We already know all of the way, now we may
6521 * be able to walk back. The same assumption
6522 * is made as in S_utf8_mg_pos(), namely that
6523 * walking backward is twice slower than
6524 * walking forward. */
6525 STRLEN forw = *offsetp;
6526 STRLEN backw = cache[1] - *offsetp;
6528 if (!(forw < 2 * backw)) {
6529 const U8 *p = s + cache[1];
6536 while (UTF8_IS_CONTINUATION(*p)) {
6544 *offsetp = cache[0];
6546 /* Drop the stale "length" cache */
6554 ASSERT_UTF8_CACHE(cache);
6560 /* Call utf8n_to_uvchr() to validate the sequence
6561 * (unless a simple non-UTF character) */
6562 if (!UTF8_IS_INVARIANT(*s))
6563 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6572 if (!SvREADONLY(sv)) {
6574 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6575 mg = mg_find(sv, PERL_MAGIC_utf8);
6580 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6581 mg->mg_ptr = (char *) cache;
6586 cache[1] = *offsetp;
6587 /* Drop the stale "length" cache */
6600 Returns a boolean indicating whether the strings in the two SVs are
6601 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6602 coerce its args to strings if necessary.
6608 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6616 SV* svrecode = Nullsv;
6623 pv1 = SvPV_const(sv1, cur1);
6630 pv2 = SvPV_const(sv2, cur2);
6632 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6633 /* Differing utf8ness.
6634 * Do not UTF8size the comparands as a side-effect. */
6637 svrecode = newSVpvn(pv2, cur2);
6638 sv_recode_to_utf8(svrecode, PL_encoding);
6639 pv2 = SvPV_const(svrecode, cur2);
6642 svrecode = newSVpvn(pv1, cur1);
6643 sv_recode_to_utf8(svrecode, PL_encoding);
6644 pv1 = SvPV_const(svrecode, cur1);
6646 /* Now both are in UTF-8. */
6648 SvREFCNT_dec(svrecode);
6653 bool is_utf8 = TRUE;
6656 /* sv1 is the UTF-8 one,
6657 * if is equal it must be downgrade-able */
6658 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6664 /* sv2 is the UTF-8 one,
6665 * if is equal it must be downgrade-able */
6666 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6672 /* Downgrade not possible - cannot be eq */
6680 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6683 SvREFCNT_dec(svrecode);
6694 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6695 string in C<sv1> is less than, equal to, or greater than the string in
6696 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6697 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6703 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6706 const char *pv1, *pv2;
6709 SV *svrecode = Nullsv;
6716 pv1 = SvPV_const(sv1, cur1);
6723 pv2 = SvPV_const(sv2, cur2);
6725 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6726 /* Differing utf8ness.
6727 * Do not UTF8size the comparands as a side-effect. */
6730 svrecode = newSVpvn(pv2, cur2);
6731 sv_recode_to_utf8(svrecode, PL_encoding);
6732 pv2 = SvPV_const(svrecode, cur2);
6735 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6740 svrecode = newSVpvn(pv1, cur1);
6741 sv_recode_to_utf8(svrecode, PL_encoding);
6742 pv1 = SvPV_const(svrecode, cur1);
6745 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6751 cmp = cur2 ? -1 : 0;
6755 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6758 cmp = retval < 0 ? -1 : 1;
6759 } else if (cur1 == cur2) {
6762 cmp = cur1 < cur2 ? -1 : 1;
6767 SvREFCNT_dec(svrecode);
6776 =for apidoc sv_cmp_locale
6778 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6779 'use bytes' aware, handles get magic, and will coerce its args to strings
6780 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6786 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6788 #ifdef USE_LOCALE_COLLATE
6794 if (PL_collation_standard)
6798 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6800 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6802 if (!pv1 || !len1) {
6813 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6816 return retval < 0 ? -1 : 1;
6819 * When the result of collation is equality, that doesn't mean
6820 * that there are no differences -- some locales exclude some
6821 * characters from consideration. So to avoid false equalities,
6822 * we use the raw string as a tiebreaker.
6828 #endif /* USE_LOCALE_COLLATE */
6830 return sv_cmp(sv1, sv2);
6834 #ifdef USE_LOCALE_COLLATE
6837 =for apidoc sv_collxfrm
6839 Add Collate Transform magic to an SV if it doesn't already have it.
6841 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6842 scalar data of the variable, but transformed to such a format that a normal
6843 memory comparison can be used to compare the data according to the locale
6850 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6854 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6855 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6861 Safefree(mg->mg_ptr);
6862 s = SvPV_const(sv, len);
6863 if ((xf = mem_collxfrm(s, len, &xlen))) {
6864 if (SvREADONLY(sv)) {
6867 return xf + sizeof(PL_collation_ix);
6870 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6871 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6884 if (mg && mg->mg_ptr) {
6886 return mg->mg_ptr + sizeof(PL_collation_ix);
6894 #endif /* USE_LOCALE_COLLATE */
6899 Get a line from the filehandle and store it into the SV, optionally
6900 appending to the currently-stored string.
6906 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6910 register STDCHAR rslast;
6911 register STDCHAR *bp;
6917 if (SvTHINKFIRST(sv))
6918 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6919 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6921 However, perlbench says it's slower, because the existing swipe code
6922 is faster than copy on write.
6923 Swings and roundabouts. */
6924 SvUPGRADE(sv, SVt_PV);
6929 if (PerlIO_isutf8(fp)) {
6931 sv_utf8_upgrade_nomg(sv);
6932 sv_pos_u2b(sv,&append,0);
6934 } else if (SvUTF8(sv)) {
6935 SV *tsv = NEWSV(0,0);
6936 sv_gets(tsv, fp, 0);
6937 sv_utf8_upgrade_nomg(tsv);
6938 SvCUR_set(sv,append);
6941 goto return_string_or_null;
6946 if (PerlIO_isutf8(fp))
6949 if (IN_PERL_COMPILETIME) {
6950 /* we always read code in line mode */
6954 else if (RsSNARF(PL_rs)) {
6955 /* If it is a regular disk file use size from stat() as estimate
6956 of amount we are going to read - may result in malloc-ing
6957 more memory than we realy need if layers bellow reduce
6958 size we read (e.g. CRLF or a gzip layer)
6961 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6962 const Off_t offset = PerlIO_tell(fp);
6963 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6964 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6970 else if (RsRECORD(PL_rs)) {
6974 /* Grab the size of the record we're getting */
6975 recsize = SvIV(SvRV(PL_rs));
6976 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6979 /* VMS wants read instead of fread, because fread doesn't respect */
6980 /* RMS record boundaries. This is not necessarily a good thing to be */
6981 /* doing, but we've got no other real choice - except avoid stdio
6982 as implementation - perhaps write a :vms layer ?
6984 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6986 bytesread = PerlIO_read(fp, buffer, recsize);
6990 SvCUR_set(sv, bytesread += append);
6991 buffer[bytesread] = '\0';
6992 goto return_string_or_null;
6994 else if (RsPARA(PL_rs)) {
7000 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7001 if (PerlIO_isutf8(fp)) {
7002 rsptr = SvPVutf8(PL_rs, rslen);
7005 if (SvUTF8(PL_rs)) {
7006 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7007 Perl_croak(aTHX_ "Wide character in $/");
7010 rsptr = SvPV_const(PL_rs, rslen);
7014 rslast = rslen ? rsptr[rslen - 1] : '\0';
7016 if (rspara) { /* have to do this both before and after */
7017 do { /* to make sure file boundaries work right */
7020 i = PerlIO_getc(fp);
7024 PerlIO_ungetc(fp,i);
7030 /* See if we know enough about I/O mechanism to cheat it ! */
7032 /* This used to be #ifdef test - it is made run-time test for ease
7033 of abstracting out stdio interface. One call should be cheap
7034 enough here - and may even be a macro allowing compile
7038 if (PerlIO_fast_gets(fp)) {
7041 * We're going to steal some values from the stdio struct
7042 * and put EVERYTHING in the innermost loop into registers.
7044 register STDCHAR *ptr;
7048 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7049 /* An ungetc()d char is handled separately from the regular
7050 * buffer, so we getc() it back out and stuff it in the buffer.
7052 i = PerlIO_getc(fp);
7053 if (i == EOF) return 0;
7054 *(--((*fp)->_ptr)) = (unsigned char) i;
7058 /* Here is some breathtakingly efficient cheating */
7060 cnt = PerlIO_get_cnt(fp); /* get count into register */
7061 /* make sure we have the room */
7062 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7063 /* Not room for all of it
7064 if we are looking for a separator and room for some
7066 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7067 /* just process what we have room for */
7068 shortbuffered = cnt - SvLEN(sv) + append + 1;
7069 cnt -= shortbuffered;
7073 /* remember that cnt can be negative */
7074 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7079 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7080 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7081 DEBUG_P(PerlIO_printf(Perl_debug_log,
7082 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7083 DEBUG_P(PerlIO_printf(Perl_debug_log,
7084 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7085 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7086 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7091 while (cnt > 0) { /* this | eat */
7093 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7094 goto thats_all_folks; /* screams | sed :-) */
7098 Copy(ptr, bp, cnt, char); /* this | eat */
7099 bp += cnt; /* screams | dust */
7100 ptr += cnt; /* louder | sed :-) */
7105 if (shortbuffered) { /* oh well, must extend */
7106 cnt = shortbuffered;
7108 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7110 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7111 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7115 DEBUG_P(PerlIO_printf(Perl_debug_log,
7116 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7117 PTR2UV(ptr),(long)cnt));
7118 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7120 DEBUG_P(PerlIO_printf(Perl_debug_log,
7121 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7122 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7123 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7125 /* This used to call 'filbuf' in stdio form, but as that behaves like
7126 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7127 another abstraction. */
7128 i = PerlIO_getc(fp); /* get more characters */
7130 DEBUG_P(PerlIO_printf(Perl_debug_log,
7131 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7132 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7133 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7135 cnt = PerlIO_get_cnt(fp);
7136 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7137 DEBUG_P(PerlIO_printf(Perl_debug_log,
7138 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7140 if (i == EOF) /* all done for ever? */
7141 goto thats_really_all_folks;
7143 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7145 SvGROW(sv, bpx + cnt + 2);
7146 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7148 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7150 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7151 goto thats_all_folks;
7155 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7156 memNE((char*)bp - rslen, rsptr, rslen))
7157 goto screamer; /* go back to the fray */
7158 thats_really_all_folks:
7160 cnt += shortbuffered;
7161 DEBUG_P(PerlIO_printf(Perl_debug_log,
7162 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7163 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7164 DEBUG_P(PerlIO_printf(Perl_debug_log,
7165 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7166 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7167 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7169 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7170 DEBUG_P(PerlIO_printf(Perl_debug_log,
7171 "Screamer: done, len=%ld, string=|%.*s|\n",
7172 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7176 /*The big, slow, and stupid way. */
7177 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7179 New(0, buf, 8192, STDCHAR);
7187 const register STDCHAR *bpe = buf + sizeof(buf);
7189 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7190 ; /* keep reading */
7194 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7195 /* Accomodate broken VAXC compiler, which applies U8 cast to
7196 * both args of ?: operator, causing EOF to change into 255
7199 i = (U8)buf[cnt - 1];
7205 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7207 sv_catpvn(sv, (char *) buf, cnt);
7209 sv_setpvn(sv, (char *) buf, cnt);
7211 if (i != EOF && /* joy */
7213 SvCUR(sv) < rslen ||
7214 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7218 * If we're reading from a TTY and we get a short read,
7219 * indicating that the user hit his EOF character, we need
7220 * to notice it now, because if we try to read from the TTY
7221 * again, the EOF condition will disappear.
7223 * The comparison of cnt to sizeof(buf) is an optimization
7224 * that prevents unnecessary calls to feof().
7228 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7232 #ifdef USE_HEAP_INSTEAD_OF_STACK
7237 if (rspara) { /* have to do this both before and after */
7238 while (i != EOF) { /* to make sure file boundaries work right */
7239 i = PerlIO_getc(fp);
7241 PerlIO_ungetc(fp,i);
7247 return_string_or_null:
7248 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7254 Auto-increment of the value in the SV, doing string to numeric conversion
7255 if necessary. Handles 'get' magic.
7261 Perl_sv_inc(pTHX_ register SV *sv)
7270 if (SvTHINKFIRST(sv)) {
7272 sv_force_normal_flags(sv, 0);
7273 if (SvREADONLY(sv)) {
7274 if (IN_PERL_RUNTIME)
7275 Perl_croak(aTHX_ PL_no_modify);
7279 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7281 i = PTR2IV(SvRV(sv));
7286 flags = SvFLAGS(sv);
7287 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7288 /* It's (privately or publicly) a float, but not tested as an
7289 integer, so test it to see. */
7291 flags = SvFLAGS(sv);
7293 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7294 /* It's publicly an integer, or privately an integer-not-float */
7295 #ifdef PERL_PRESERVE_IVUV
7299 if (SvUVX(sv) == UV_MAX)
7300 sv_setnv(sv, UV_MAX_P1);
7302 (void)SvIOK_only_UV(sv);
7303 SvUV_set(sv, SvUVX(sv) + 1);
7305 if (SvIVX(sv) == IV_MAX)
7306 sv_setuv(sv, (UV)IV_MAX + 1);
7308 (void)SvIOK_only(sv);
7309 SvIV_set(sv, SvIVX(sv) + 1);
7314 if (flags & SVp_NOK) {
7315 (void)SvNOK_only(sv);
7316 SvNV_set(sv, SvNVX(sv) + 1.0);
7320 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7321 if ((flags & SVTYPEMASK) < SVt_PVIV)
7322 sv_upgrade(sv, SVt_IV);
7323 (void)SvIOK_only(sv);
7328 while (isALPHA(*d)) d++;
7329 while (isDIGIT(*d)) d++;
7331 #ifdef PERL_PRESERVE_IVUV
7332 /* Got to punt this as an integer if needs be, but we don't issue
7333 warnings. Probably ought to make the sv_iv_please() that does
7334 the conversion if possible, and silently. */
7335 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7336 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7337 /* Need to try really hard to see if it's an integer.
7338 9.22337203685478e+18 is an integer.
7339 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7340 so $a="9.22337203685478e+18"; $a+0; $a++
7341 needs to be the same as $a="9.22337203685478e+18"; $a++
7348 /* sv_2iv *should* have made this an NV */
7349 if (flags & SVp_NOK) {
7350 (void)SvNOK_only(sv);
7351 SvNV_set(sv, SvNVX(sv) + 1.0);
7354 /* I don't think we can get here. Maybe I should assert this
7355 And if we do get here I suspect that sv_setnv will croak. NWC
7357 #if defined(USE_LONG_DOUBLE)
7358 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",
7359 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7361 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7362 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7365 #endif /* PERL_PRESERVE_IVUV */
7366 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7370 while (d >= SvPVX_const(sv)) {
7378 /* MKS: The original code here died if letters weren't consecutive.
7379 * at least it didn't have to worry about non-C locales. The
7380 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7381 * arranged in order (although not consecutively) and that only
7382 * [A-Za-z] are accepted by isALPHA in the C locale.
7384 if (*d != 'z' && *d != 'Z') {
7385 do { ++*d; } while (!isALPHA(*d));
7388 *(d--) -= 'z' - 'a';
7393 *(d--) -= 'z' - 'a' + 1;
7397 /* oh,oh, the number grew */
7398 SvGROW(sv, SvCUR(sv) + 2);
7399 SvCUR_set(sv, SvCUR(sv) + 1);
7400 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7411 Auto-decrement of the value in the SV, doing string to numeric conversion
7412 if necessary. Handles 'get' magic.
7418 Perl_sv_dec(pTHX_ register SV *sv)
7426 if (SvTHINKFIRST(sv)) {
7428 sv_force_normal_flags(sv, 0);
7429 if (SvREADONLY(sv)) {
7430 if (IN_PERL_RUNTIME)
7431 Perl_croak(aTHX_ PL_no_modify);
7435 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7437 i = PTR2IV(SvRV(sv));
7442 /* Unlike sv_inc we don't have to worry about string-never-numbers
7443 and keeping them magic. But we mustn't warn on punting */
7444 flags = SvFLAGS(sv);
7445 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7446 /* It's publicly an integer, or privately an integer-not-float */
7447 #ifdef PERL_PRESERVE_IVUV
7451 if (SvUVX(sv) == 0) {
7452 (void)SvIOK_only(sv);
7456 (void)SvIOK_only_UV(sv);
7457 SvUV_set(sv, SvUVX(sv) + 1);
7460 if (SvIVX(sv) == IV_MIN)
7461 sv_setnv(sv, (NV)IV_MIN - 1.0);
7463 (void)SvIOK_only(sv);
7464 SvIV_set(sv, SvIVX(sv) - 1);
7469 if (flags & SVp_NOK) {
7470 SvNV_set(sv, SvNVX(sv) - 1.0);
7471 (void)SvNOK_only(sv);
7474 if (!(flags & SVp_POK)) {
7475 if ((flags & SVTYPEMASK) < SVt_PVNV)
7476 sv_upgrade(sv, SVt_NV);
7478 (void)SvNOK_only(sv);
7481 #ifdef PERL_PRESERVE_IVUV
7483 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7484 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7485 /* Need to try really hard to see if it's an integer.
7486 9.22337203685478e+18 is an integer.
7487 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7488 so $a="9.22337203685478e+18"; $a+0; $a--
7489 needs to be the same as $a="9.22337203685478e+18"; $a--
7496 /* sv_2iv *should* have made this an NV */
7497 if (flags & SVp_NOK) {
7498 (void)SvNOK_only(sv);
7499 SvNV_set(sv, SvNVX(sv) - 1.0);
7502 /* I don't think we can get here. Maybe I should assert this
7503 And if we do get here I suspect that sv_setnv will croak. NWC
7505 #if defined(USE_LONG_DOUBLE)
7506 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",
7507 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7509 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7510 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7514 #endif /* PERL_PRESERVE_IVUV */
7515 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7519 =for apidoc sv_mortalcopy
7521 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7522 The new SV is marked as mortal. It will be destroyed "soon", either by an
7523 explicit call to FREETMPS, or by an implicit call at places such as
7524 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7529 /* Make a string that will exist for the duration of the expression
7530 * evaluation. Actually, it may have to last longer than that, but
7531 * hopefully we won't free it until it has been assigned to a
7532 * permanent location. */
7535 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7540 sv_setsv(sv,oldstr);
7542 PL_tmps_stack[++PL_tmps_ix] = sv;
7548 =for apidoc sv_newmortal
7550 Creates a new null SV which is mortal. The reference count of the SV is
7551 set to 1. It will be destroyed "soon", either by an explicit call to
7552 FREETMPS, or by an implicit call at places such as statement boundaries.
7553 See also C<sv_mortalcopy> and C<sv_2mortal>.
7559 Perl_sv_newmortal(pTHX)
7564 SvFLAGS(sv) = SVs_TEMP;
7566 PL_tmps_stack[++PL_tmps_ix] = sv;
7571 =for apidoc sv_2mortal
7573 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7574 by an explicit call to FREETMPS, or by an implicit call at places such as
7575 statement boundaries. SvTEMP() is turned on which means that the SV's
7576 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7577 and C<sv_mortalcopy>.
7583 Perl_sv_2mortal(pTHX_ register SV *sv)
7588 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7591 PL_tmps_stack[++PL_tmps_ix] = sv;
7599 Creates a new SV and copies a string into it. The reference count for the
7600 SV is set to 1. If C<len> is zero, Perl will compute the length using
7601 strlen(). For efficiency, consider using C<newSVpvn> instead.
7607 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7612 sv_setpvn(sv,s,len ? len : strlen(s));
7617 =for apidoc newSVpvn
7619 Creates a new SV and copies a string into it. The reference count for the
7620 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7621 string. You are responsible for ensuring that the source string is at least
7622 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7628 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7633 sv_setpvn(sv,s,len);
7639 =for apidoc newSVhek
7641 Creates a new SV from the hash key structure. It will generate scalars that
7642 point to the shared string table where possible. Returns a new (undefined)
7643 SV if the hek is NULL.
7649 Perl_newSVhek(pTHX_ const HEK *hek)
7658 if (HEK_LEN(hek) == HEf_SVKEY) {
7659 return newSVsv(*(SV**)HEK_KEY(hek));
7661 const int flags = HEK_FLAGS(hek);
7662 if (flags & HVhek_WASUTF8) {
7664 Andreas would like keys he put in as utf8 to come back as utf8
7666 STRLEN utf8_len = HEK_LEN(hek);
7667 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7668 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7671 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7673 } else if (flags & HVhek_REHASH) {
7674 /* We don't have a pointer to the hv, so we have to replicate the
7675 flag into every HEK. This hv is using custom a hasing
7676 algorithm. Hence we can't return a shared string scalar, as
7677 that would contain the (wrong) hash value, and might get passed
7678 into an hv routine with a regular hash */
7680 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7685 /* This will be overwhelminly the most common case. */
7686 return newSVpvn_share(HEK_KEY(hek),
7687 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7693 =for apidoc newSVpvn_share
7695 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7696 table. If the string does not already exist in the table, it is created
7697 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7698 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7699 otherwise the hash is computed. The idea here is that as the string table
7700 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7701 hash lookup will avoid string compare.
7707 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7710 bool is_utf8 = FALSE;
7712 STRLEN tmplen = -len;
7714 /* See the note in hv.c:hv_fetch() --jhi */
7715 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7719 PERL_HASH(hash, src, len);
7721 sv_upgrade(sv, SVt_PV);
7722 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7734 #if defined(PERL_IMPLICIT_CONTEXT)
7736 /* pTHX_ magic can't cope with varargs, so this is a no-context
7737 * version of the main function, (which may itself be aliased to us).
7738 * Don't access this version directly.
7742 Perl_newSVpvf_nocontext(const char* pat, ...)
7747 va_start(args, pat);
7748 sv = vnewSVpvf(pat, &args);
7755 =for apidoc newSVpvf
7757 Creates a new SV and initializes it with the string formatted like
7764 Perl_newSVpvf(pTHX_ const char* pat, ...)
7768 va_start(args, pat);
7769 sv = vnewSVpvf(pat, &args);
7774 /* backend for newSVpvf() and newSVpvf_nocontext() */
7777 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7781 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7788 Creates a new SV and copies a floating point value into it.
7789 The reference count for the SV is set to 1.
7795 Perl_newSVnv(pTHX_ NV n)
7807 Creates a new SV and copies an integer into it. The reference count for the
7814 Perl_newSViv(pTHX_ IV i)
7826 Creates a new SV and copies an unsigned integer into it.
7827 The reference count for the SV is set to 1.
7833 Perl_newSVuv(pTHX_ UV u)
7843 =for apidoc newRV_noinc
7845 Creates an RV wrapper for an SV. The reference count for the original
7846 SV is B<not> incremented.
7852 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7857 sv_upgrade(sv, SVt_RV);
7859 SvRV_set(sv, tmpRef);
7864 /* newRV_inc is the official function name to use now.
7865 * newRV_inc is in fact #defined to newRV in sv.h
7869 Perl_newRV(pTHX_ SV *tmpRef)
7871 return newRV_noinc(SvREFCNT_inc(tmpRef));
7877 Creates a new SV which is an exact duplicate of the original SV.
7884 Perl_newSVsv(pTHX_ register SV *old)
7890 if (SvTYPE(old) == SVTYPEMASK) {
7891 if (ckWARN_d(WARN_INTERNAL))
7892 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7896 /* SV_GMAGIC is the default for sv_setv()
7897 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7898 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7899 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7904 =for apidoc sv_reset
7906 Underlying implementation for the C<reset> Perl function.
7907 Note that the perl-level function is vaguely deprecated.
7913 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7916 char todo[PERL_UCHAR_MAX+1];
7921 if (!*s) { /* reset ?? searches */
7922 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7924 PMOP *pm = (PMOP *) mg->mg_obj;
7926 pm->op_pmdynflags &= ~PMdf_USED;
7933 /* reset variables */
7935 if (!HvARRAY(stash))
7938 Zero(todo, 256, char);
7941 I32 i = (unsigned char)*s;
7945 max = (unsigned char)*s++;
7946 for ( ; i <= max; i++) {
7949 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7951 for (entry = HvARRAY(stash)[i];
7953 entry = HeNEXT(entry))
7958 if (!todo[(U8)*HeKEY(entry)])
7960 gv = (GV*)HeVAL(entry);
7962 if (SvTHINKFIRST(sv)) {
7963 if (!SvREADONLY(sv) && SvROK(sv))
7968 if (SvTYPE(sv) >= SVt_PV) {
7970 if (SvPVX_const(sv) != Nullch)
7977 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7980 #ifdef USE_ENVIRON_ARRAY
7982 # ifdef USE_ITHREADS
7983 && PL_curinterp == aTHX
7987 environ[0] = Nullch;
7990 #endif /* !PERL_MICRO */
8000 Using various gambits, try to get an IO from an SV: the IO slot if its a
8001 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8002 named after the PV if we're a string.
8008 Perl_sv_2io(pTHX_ SV *sv)
8013 switch (SvTYPE(sv)) {
8021 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8025 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8027 return sv_2io(SvRV(sv));
8028 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8034 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8043 Using various gambits, try to get a CV from an SV; in addition, try if
8044 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8050 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8057 return *gvp = Nullgv, Nullcv;
8058 switch (SvTYPE(sv)) {
8077 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8078 tryAMAGICunDEREF(to_cv);
8081 if (SvTYPE(sv) == SVt_PVCV) {
8090 Perl_croak(aTHX_ "Not a subroutine reference");
8095 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8101 if (lref && !GvCVu(gv)) {
8104 tmpsv = NEWSV(704,0);
8105 gv_efullname3(tmpsv, gv, Nullch);
8106 /* XXX this is probably not what they think they're getting.
8107 * It has the same effect as "sub name;", i.e. just a forward
8109 newSUB(start_subparse(FALSE, 0),
8110 newSVOP(OP_CONST, 0, tmpsv),
8115 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8125 Returns true if the SV has a true value by Perl's rules.
8126 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8127 instead use an in-line version.
8133 Perl_sv_true(pTHX_ register SV *sv)
8138 const register XPV* tXpv;
8139 if ((tXpv = (XPV*)SvANY(sv)) &&
8140 (tXpv->xpv_cur > 1 ||
8141 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8148 return SvIVX(sv) != 0;
8151 return SvNVX(sv) != 0.0;
8153 return sv_2bool(sv);
8161 A private implementation of the C<SvIVx> macro for compilers which can't
8162 cope with complex macro expressions. Always use the macro instead.
8168 Perl_sv_iv(pTHX_ register SV *sv)
8172 return (IV)SvUVX(sv);
8181 A private implementation of the C<SvUVx> macro for compilers which can't
8182 cope with complex macro expressions. Always use the macro instead.
8188 Perl_sv_uv(pTHX_ register SV *sv)
8193 return (UV)SvIVX(sv);
8201 A private implementation of the C<SvNVx> macro for compilers which can't
8202 cope with complex macro expressions. Always use the macro instead.
8208 Perl_sv_nv(pTHX_ register SV *sv)
8215 /* sv_pv() is now a macro using SvPV_nolen();
8216 * this function provided for binary compatibility only
8220 Perl_sv_pv(pTHX_ SV *sv)
8225 return sv_2pv(sv, 0);
8231 Use the C<SvPV_nolen> macro instead
8235 A private implementation of the C<SvPV> macro for compilers which can't
8236 cope with complex macro expressions. Always use the macro instead.
8242 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8248 return sv_2pv(sv, lp);
8253 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8259 return sv_2pv_flags(sv, lp, 0);
8262 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8263 * this function provided for binary compatibility only
8267 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8269 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8273 =for apidoc sv_pvn_force
8275 Get a sensible string out of the SV somehow.
8276 A private implementation of the C<SvPV_force> macro for compilers which
8277 can't cope with complex macro expressions. Always use the macro instead.
8279 =for apidoc sv_pvn_force_flags
8281 Get a sensible string out of the SV somehow.
8282 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8283 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8284 implemented in terms of this function.
8285 You normally want to use the various wrapper macros instead: see
8286 C<SvPV_force> and C<SvPV_force_nomg>
8292 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8295 if (SvTHINKFIRST(sv) && !SvROK(sv))
8296 sv_force_normal_flags(sv, 0);
8306 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8308 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8309 sv_reftype(sv,0), OP_NAME(PL_op));
8311 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
8314 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8315 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8319 s = sv_2pv_flags(sv, &len, flags);
8323 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8326 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8327 SvGROW(sv, len + 1);
8328 Move(s,SvPVX_const(sv),len,char);
8333 SvPOK_on(sv); /* validate pointer */
8335 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8336 PTR2UV(sv),SvPVX_const(sv)));
8339 return SvPVX_mutable(sv);
8342 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8343 * this function provided for binary compatibility only
8347 Perl_sv_pvbyte(pTHX_ SV *sv)
8349 sv_utf8_downgrade(sv,0);
8354 =for apidoc sv_pvbyte
8356 Use C<SvPVbyte_nolen> instead.
8358 =for apidoc sv_pvbyten
8360 A private implementation of the C<SvPVbyte> macro for compilers
8361 which can't cope with complex macro expressions. Always use the macro
8368 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8370 sv_utf8_downgrade(sv,0);
8371 return sv_pvn(sv,lp);
8375 =for apidoc sv_pvbyten_force
8377 A private implementation of the C<SvPVbytex_force> macro for compilers
8378 which can't cope with complex macro expressions. Always use the macro
8385 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8387 sv_pvn_force(sv,lp);
8388 sv_utf8_downgrade(sv,0);
8393 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8394 * this function provided for binary compatibility only
8398 Perl_sv_pvutf8(pTHX_ SV *sv)
8400 sv_utf8_upgrade(sv);
8405 =for apidoc sv_pvutf8
8407 Use the C<SvPVutf8_nolen> macro instead
8409 =for apidoc sv_pvutf8n
8411 A private implementation of the C<SvPVutf8> macro for compilers
8412 which can't cope with complex macro expressions. Always use the macro
8419 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8421 sv_utf8_upgrade(sv);
8422 return sv_pvn(sv,lp);
8426 =for apidoc sv_pvutf8n_force
8428 A private implementation of the C<SvPVutf8_force> macro for compilers
8429 which can't cope with complex macro expressions. Always use the macro
8436 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8438 sv_pvn_force(sv,lp);
8439 sv_utf8_upgrade(sv);
8445 =for apidoc sv_reftype
8447 Returns a string describing what the SV is a reference to.
8453 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8455 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8456 inside return suggests a const propagation bug in g++. */
8457 if (ob && SvOBJECT(sv)) {
8458 char *name = HvNAME_get(SvSTASH(sv));
8459 return name ? name : (char *) "__ANON__";
8462 switch (SvTYPE(sv)) {
8479 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8480 /* tied lvalues should appear to be
8481 * scalars for backwards compatitbility */
8482 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8483 ? "SCALAR" : "LVALUE");
8484 case SVt_PVAV: return "ARRAY";
8485 case SVt_PVHV: return "HASH";
8486 case SVt_PVCV: return "CODE";
8487 case SVt_PVGV: return "GLOB";
8488 case SVt_PVFM: return "FORMAT";
8489 case SVt_PVIO: return "IO";
8490 default: return "UNKNOWN";
8496 =for apidoc sv_isobject
8498 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8499 object. If the SV is not an RV, or if the object is not blessed, then this
8506 Perl_sv_isobject(pTHX_ SV *sv)
8523 Returns a boolean indicating whether the SV is blessed into the specified
8524 class. This does not check for subtypes; use C<sv_derived_from> to verify
8525 an inheritance relationship.
8531 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8543 hvname = HvNAME_get(SvSTASH(sv));
8547 return strEQ(hvname, name);
8553 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8554 it will be upgraded to one. If C<classname> is non-null then the new SV will
8555 be blessed in the specified package. The new SV is returned and its
8556 reference count is 1.
8562 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8568 SV_CHECK_THINKFIRST_COW_DROP(rv);
8571 if (SvTYPE(rv) >= SVt_PVMG) {
8572 const U32 refcnt = SvREFCNT(rv);
8576 SvREFCNT(rv) = refcnt;
8579 if (SvTYPE(rv) < SVt_RV)
8580 sv_upgrade(rv, SVt_RV);
8581 else if (SvTYPE(rv) > SVt_RV) {
8592 HV* stash = gv_stashpv(classname, TRUE);
8593 (void)sv_bless(rv, stash);
8599 =for apidoc sv_setref_pv
8601 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8602 argument will be upgraded to an RV. That RV will be modified to point to
8603 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8604 into the SV. The C<classname> argument indicates the package for the
8605 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8606 will have a reference count of 1, and the RV will be returned.
8608 Do not use with other Perl types such as HV, AV, SV, CV, because those
8609 objects will become corrupted by the pointer copy process.
8611 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8617 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8620 sv_setsv(rv, &PL_sv_undef);
8624 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8629 =for apidoc sv_setref_iv
8631 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8632 argument will be upgraded to an RV. That RV will be modified to point to
8633 the new SV. The C<classname> argument indicates the package for the
8634 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8635 will have a reference count of 1, and the RV will be returned.
8641 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8643 sv_setiv(newSVrv(rv,classname), iv);
8648 =for apidoc sv_setref_uv
8650 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8651 argument will be upgraded to an RV. That RV will be modified to point to
8652 the new SV. The C<classname> argument indicates the package for the
8653 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8654 will have a reference count of 1, and the RV will be returned.
8660 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8662 sv_setuv(newSVrv(rv,classname), uv);
8667 =for apidoc sv_setref_nv
8669 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8670 argument will be upgraded to an RV. That RV will be modified to point to
8671 the new SV. The C<classname> argument indicates the package for the
8672 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8673 will have a reference count of 1, and the RV will be returned.
8679 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8681 sv_setnv(newSVrv(rv,classname), nv);
8686 =for apidoc sv_setref_pvn
8688 Copies a string into a new SV, optionally blessing the SV. The length of the
8689 string must be specified with C<n>. The C<rv> argument will be upgraded to
8690 an RV. That RV will be modified to point to the new SV. The C<classname>
8691 argument indicates the package for the blessing. Set C<classname> to
8692 C<Nullch> to avoid the blessing. The new SV will have a reference count
8693 of 1, and the RV will be returned.
8695 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8701 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8703 sv_setpvn(newSVrv(rv,classname), pv, n);
8708 =for apidoc sv_bless
8710 Blesses an SV into a specified package. The SV must be an RV. The package
8711 must be designated by its stash (see C<gv_stashpv()>). The reference count
8712 of the SV is unaffected.
8718 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8722 Perl_croak(aTHX_ "Can't bless non-reference value");
8724 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8725 if (SvREADONLY(tmpRef))
8726 Perl_croak(aTHX_ PL_no_modify);
8727 if (SvOBJECT(tmpRef)) {
8728 if (SvTYPE(tmpRef) != SVt_PVIO)
8730 SvREFCNT_dec(SvSTASH(tmpRef));
8733 SvOBJECT_on(tmpRef);
8734 if (SvTYPE(tmpRef) != SVt_PVIO)
8736 SvUPGRADE(tmpRef, SVt_PVMG);
8737 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8744 if(SvSMAGICAL(tmpRef))
8745 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8753 /* Downgrades a PVGV to a PVMG.
8757 S_sv_unglob(pTHX_ SV *sv)
8761 assert(SvTYPE(sv) == SVt_PVGV);
8766 SvREFCNT_dec(GvSTASH(sv));
8767 GvSTASH(sv) = Nullhv;
8769 sv_unmagic(sv, PERL_MAGIC_glob);
8770 Safefree(GvNAME(sv));
8773 /* need to keep SvANY(sv) in the right arena */
8774 xpvmg = new_XPVMG();
8775 StructCopy(SvANY(sv), xpvmg, XPVMG);
8776 del_XPVGV(SvANY(sv));
8779 SvFLAGS(sv) &= ~SVTYPEMASK;
8780 SvFLAGS(sv) |= SVt_PVMG;
8784 =for apidoc sv_unref_flags
8786 Unsets the RV status of the SV, and decrements the reference count of
8787 whatever was being referenced by the RV. This can almost be thought of
8788 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8789 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8790 (otherwise the decrementing is conditional on the reference count being
8791 different from one or the reference being a readonly SV).
8798 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8802 if (SvWEAKREF(sv)) {
8810 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8811 assigned to as BEGIN {$a = \"Foo"} will fail. */
8812 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8814 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8815 sv_2mortal(rv); /* Schedule for freeing later */
8819 =for apidoc sv_unref
8821 Unsets the RV status of the SV, and decrements the reference count of
8822 whatever was being referenced by the RV. This can almost be thought of
8823 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8824 being zero. See C<SvROK_off>.
8830 Perl_sv_unref(pTHX_ SV *sv)
8832 sv_unref_flags(sv, 0);
8836 =for apidoc sv_taint
8838 Taint an SV. Use C<SvTAINTED_on> instead.
8843 Perl_sv_taint(pTHX_ SV *sv)
8845 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8849 =for apidoc sv_untaint
8851 Untaint an SV. Use C<SvTAINTED_off> instead.
8856 Perl_sv_untaint(pTHX_ SV *sv)
8858 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8859 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8866 =for apidoc sv_tainted
8868 Test an SV for taintedness. Use C<SvTAINTED> instead.
8873 Perl_sv_tainted(pTHX_ SV *sv)
8875 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8876 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8877 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8884 =for apidoc sv_setpviv
8886 Copies an integer into the given SV, also updating its string value.
8887 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8893 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8895 char buf[TYPE_CHARS(UV)];
8897 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8899 sv_setpvn(sv, ptr, ebuf - ptr);
8903 =for apidoc sv_setpviv_mg
8905 Like C<sv_setpviv>, but also handles 'set' magic.
8911 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8913 char buf[TYPE_CHARS(UV)];
8915 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8917 sv_setpvn(sv, ptr, ebuf - ptr);
8921 #if defined(PERL_IMPLICIT_CONTEXT)
8923 /* pTHX_ magic can't cope with varargs, so this is a no-context
8924 * version of the main function, (which may itself be aliased to us).
8925 * Don't access this version directly.
8929 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8933 va_start(args, pat);
8934 sv_vsetpvf(sv, pat, &args);
8938 /* pTHX_ magic can't cope with varargs, so this is a no-context
8939 * version of the main function, (which may itself be aliased to us).
8940 * Don't access this version directly.
8944 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8948 va_start(args, pat);
8949 sv_vsetpvf_mg(sv, pat, &args);
8955 =for apidoc sv_setpvf
8957 Works like C<sv_catpvf> but copies the text into the SV instead of
8958 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8964 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8967 va_start(args, pat);
8968 sv_vsetpvf(sv, pat, &args);
8973 =for apidoc sv_vsetpvf
8975 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8976 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8978 Usually used via its frontend C<sv_setpvf>.
8984 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8986 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8990 =for apidoc sv_setpvf_mg
8992 Like C<sv_setpvf>, but also handles 'set' magic.
8998 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9001 va_start(args, pat);
9002 sv_vsetpvf_mg(sv, pat, &args);
9007 =for apidoc sv_vsetpvf_mg
9009 Like C<sv_vsetpvf>, but also handles 'set' magic.
9011 Usually used via its frontend C<sv_setpvf_mg>.
9017 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9019 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9023 #if defined(PERL_IMPLICIT_CONTEXT)
9025 /* pTHX_ magic can't cope with varargs, so this is a no-context
9026 * version of the main function, (which may itself be aliased to us).
9027 * Don't access this version directly.
9031 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
9035 va_start(args, pat);
9036 sv_vcatpvf(sv, pat, &args);
9040 /* pTHX_ magic can't cope with varargs, so this is a no-context
9041 * version of the main function, (which may itself be aliased to us).
9042 * Don't access this version directly.
9046 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9050 va_start(args, pat);
9051 sv_vcatpvf_mg(sv, pat, &args);
9057 =for apidoc sv_catpvf
9059 Processes its arguments like C<sprintf> and appends the formatted
9060 output to an SV. If the appended data contains "wide" characters
9061 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9062 and characters >255 formatted with %c), the original SV might get
9063 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9064 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9065 valid UTF-8; if the original SV was bytes, the pattern should be too.
9070 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9073 va_start(args, pat);
9074 sv_vcatpvf(sv, pat, &args);
9079 =for apidoc sv_vcatpvf
9081 Processes its arguments like C<vsprintf> and appends the formatted output
9082 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9084 Usually used via its frontend C<sv_catpvf>.
9090 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9092 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9096 =for apidoc sv_catpvf_mg
9098 Like C<sv_catpvf>, but also handles 'set' magic.
9104 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9107 va_start(args, pat);
9108 sv_vcatpvf_mg(sv, pat, &args);
9113 =for apidoc sv_vcatpvf_mg
9115 Like C<sv_vcatpvf>, but also handles 'set' magic.
9117 Usually used via its frontend C<sv_catpvf_mg>.
9123 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9125 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9130 =for apidoc sv_vsetpvfn
9132 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9135 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9141 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9143 sv_setpvn(sv, "", 0);
9144 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9147 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9150 S_expect_number(pTHX_ char** pattern)
9153 switch (**pattern) {
9154 case '1': case '2': case '3':
9155 case '4': case '5': case '6':
9156 case '7': case '8': case '9':
9157 while (isDIGIT(**pattern))
9158 var = var * 10 + (*(*pattern)++ - '0');
9162 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9165 F0convert(NV nv, char *endbuf, STRLEN *len)
9167 const int neg = nv < 0;
9176 if (uv & 1 && uv == nv)
9177 uv--; /* Round to even */
9179 const unsigned dig = uv % 10;
9192 =for apidoc sv_vcatpvfn
9194 Processes its arguments like C<vsprintf> and appends the formatted output
9195 to an SV. Uses an array of SVs if the C style variable argument list is
9196 missing (NULL). When running with taint checks enabled, indicates via
9197 C<maybe_tainted> if results are untrustworthy (often due to the use of
9200 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9205 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9208 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9215 static const char nullstr[] = "(null)";
9217 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9218 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9220 /* Times 4: a decimal digit takes more than 3 binary digits.
9221 * NV_DIG: mantissa takes than many decimal digits.
9222 * Plus 32: Playing safe. */
9223 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9224 /* large enough for "%#.#f" --chip */
9225 /* what about long double NVs? --jhi */
9227 /* no matter what, this is a string now */
9228 (void)SvPV_force(sv, origlen);
9230 /* special-case "", "%s", and "%-p" (SVf) */
9233 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9235 const char *s = va_arg(*args, char*);
9236 sv_catpv(sv, s ? s : nullstr);
9238 else if (svix < svmax) {
9239 sv_catsv(sv, *svargs);
9240 if (DO_UTF8(*svargs))
9245 if (patlen == 3 && pat[0] == '%' &&
9246 pat[1] == '-' && pat[2] == 'p') {
9248 argsv = va_arg(*args, SV*);
9249 sv_catsv(sv, argsv);
9256 #ifndef USE_LONG_DOUBLE
9257 /* special-case "%.<number>[gf]" */
9258 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9259 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9260 unsigned digits = 0;
9264 while (*pp >= '0' && *pp <= '9')
9265 digits = 10 * digits + (*pp++ - '0');
9266 if (pp - pat == (int)patlen - 1) {
9270 nv = (NV)va_arg(*args, double);
9271 else if (svix < svmax)
9276 /* Add check for digits != 0 because it seems that some
9277 gconverts are buggy in this case, and we don't yet have
9278 a Configure test for this. */
9279 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9280 /* 0, point, slack */
9281 Gconvert(nv, (int)digits, 0, ebuf);
9283 if (*ebuf) /* May return an empty string for digits==0 */
9286 } else if (!digits) {
9289 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9290 sv_catpvn(sv, p, l);
9296 #endif /* !USE_LONG_DOUBLE */
9298 if (!args && svix < svmax && DO_UTF8(*svargs))
9301 patend = (char*)pat + patlen;
9302 for (p = (char*)pat; p < patend; p = q) {
9305 bool vectorize = FALSE;
9306 bool vectorarg = FALSE;
9307 bool vec_utf8 = FALSE;
9313 bool has_precis = FALSE;
9316 bool is_utf8 = FALSE; /* is this item utf8? */
9317 #ifdef HAS_LDBL_SPRINTF_BUG
9318 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9319 with sfio - Allen <allens@cpan.org> */
9320 bool fix_ldbl_sprintf_bug = FALSE;
9324 U8 utf8buf[UTF8_MAXBYTES+1];
9325 STRLEN esignlen = 0;
9327 const char *eptr = Nullch;
9330 const U8 *vecstr = Null(U8*);
9337 /* we need a long double target in case HAS_LONG_DOUBLE but
9340 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9348 const char *dotstr = ".";
9349 STRLEN dotstrlen = 1;
9350 I32 efix = 0; /* explicit format parameter index */
9351 I32 ewix = 0; /* explicit width index */
9352 I32 epix = 0; /* explicit precision index */
9353 I32 evix = 0; /* explicit vector index */
9354 bool asterisk = FALSE;
9356 /* echo everything up to the next format specification */
9357 for (q = p; q < patend && *q != '%'; ++q) ;
9359 if (has_utf8 && !pat_utf8)
9360 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9362 sv_catpvn(sv, p, q - p);
9369 We allow format specification elements in this order:
9370 \d+\$ explicit format parameter index
9372 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9373 0 flag (as above): repeated to allow "v02"
9374 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9375 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9377 [%bcdefginopsux_DFOUX] format (mandatory)
9379 if (EXPECT_NUMBER(q, width)) {
9420 if (EXPECT_NUMBER(q, ewix))
9429 if ((vectorarg = asterisk)) {
9441 EXPECT_NUMBER(q, width);
9446 vecsv = va_arg(*args, SV*);
9448 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9449 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9450 dotstr = SvPV_const(vecsv, dotstrlen);
9455 vecsv = va_arg(*args, SV*);
9456 vecstr = (U8*)SvPV_const(vecsv,veclen);
9457 vec_utf8 = DO_UTF8(vecsv);
9459 else if (efix ? efix <= svmax : svix < svmax) {
9460 vecsv = svargs[efix ? efix-1 : svix++];
9461 vecstr = (U8*)SvPV_const(vecsv,veclen);
9462 vec_utf8 = DO_UTF8(vecsv);
9463 /* if this is a version object, we need to return the
9464 * stringified representation (which the SvPVX_const has
9465 * already done for us), but not vectorize the args
9467 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9469 q++; /* skip past the rest of the %vd format */
9470 eptr = (const char *) vecstr;
9471 elen = strlen(eptr);
9484 i = va_arg(*args, int);
9486 i = (ewix ? ewix <= svmax : svix < svmax) ?
9487 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9489 width = (i < 0) ? -i : i;
9499 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9501 /* XXX: todo, support specified precision parameter */
9505 i = va_arg(*args, int);
9507 i = (ewix ? ewix <= svmax : svix < svmax)
9508 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9509 precis = (i < 0) ? 0 : i;
9514 precis = precis * 10 + (*q++ - '0');
9523 case 'I': /* Ix, I32x, and I64x */
9525 if (q[1] == '6' && q[2] == '4') {
9531 if (q[1] == '3' && q[2] == '2') {
9541 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9552 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9553 if (*(q + 1) == 'l') { /* lld, llf */
9578 argsv = (efix ? efix <= svmax : svix < svmax) ?
9579 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9586 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9588 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9590 eptr = (char*)utf8buf;
9591 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9602 if (args && !vectorize) {
9603 eptr = va_arg(*args, char*);
9605 #ifdef MACOS_TRADITIONAL
9606 /* On MacOS, %#s format is used for Pascal strings */
9611 elen = strlen(eptr);
9613 eptr = (char *)nullstr;
9614 elen = sizeof nullstr - 1;
9618 eptr = SvPVx_const(argsv, elen);
9619 if (DO_UTF8(argsv)) {
9620 if (has_precis && precis < elen) {
9622 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9625 if (width) { /* fudge width (can't fudge elen) */
9626 width += elen - sv_len_utf8(argsv);
9634 if (has_precis && elen > precis)
9641 if (left && args) { /* SVf */
9650 argsv = va_arg(*args, SV*);
9651 eptr = SvPVx_const(argsv, elen);
9656 if (alt || vectorize)
9658 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9676 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9685 esignbuf[esignlen++] = plus;
9689 case 'h': iv = (short)va_arg(*args, int); break;
9690 case 'l': iv = va_arg(*args, long); break;
9691 case 'V': iv = va_arg(*args, IV); break;
9692 default: iv = va_arg(*args, int); break;
9694 case 'q': iv = va_arg(*args, Quad_t); break;
9699 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9701 case 'h': iv = (short)tiv; break;
9702 case 'l': iv = (long)tiv; break;
9704 default: iv = tiv; break;
9706 case 'q': iv = (Quad_t)tiv; break;
9710 if ( !vectorize ) /* we already set uv above */
9715 esignbuf[esignlen++] = plus;
9719 esignbuf[esignlen++] = '-';
9762 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9773 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9774 case 'l': uv = va_arg(*args, unsigned long); break;
9775 case 'V': uv = va_arg(*args, UV); break;
9776 default: uv = va_arg(*args, unsigned); break;
9778 case 'q': uv = va_arg(*args, Uquad_t); break;
9783 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9785 case 'h': uv = (unsigned short)tuv; break;
9786 case 'l': uv = (unsigned long)tuv; break;
9788 default: uv = tuv; break;
9790 case 'q': uv = (Uquad_t)tuv; break;
9797 char *ptr = ebuf + sizeof ebuf;
9803 p = (char*)((c == 'X')
9804 ? "0123456789ABCDEF" : "0123456789abcdef");
9810 esignbuf[esignlen++] = '0';
9811 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9819 if (alt && *ptr != '0')
9828 esignbuf[esignlen++] = '0';
9829 esignbuf[esignlen++] = 'b';
9832 default: /* it had better be ten or less */
9836 } while (uv /= base);
9839 elen = (ebuf + sizeof ebuf) - ptr;
9843 zeros = precis - elen;
9844 else if (precis == 0 && elen == 1 && *eptr == '0')
9850 /* FLOATING POINT */
9853 c = 'f'; /* maybe %F isn't supported here */
9859 /* This is evil, but floating point is even more evil */
9861 /* for SV-style calling, we can only get NV
9862 for C-style calling, we assume %f is double;
9863 for simplicity we allow any of %Lf, %llf, %qf for long double
9867 #if defined(USE_LONG_DOUBLE)
9871 /* [perl #20339] - we should accept and ignore %lf rather than die */
9875 #if defined(USE_LONG_DOUBLE)
9876 intsize = args ? 0 : 'q';
9880 #if defined(HAS_LONG_DOUBLE)
9889 /* now we need (long double) if intsize == 'q', else (double) */
9890 nv = (args && !vectorize) ?
9891 #if LONG_DOUBLESIZE > DOUBLESIZE
9893 va_arg(*args, long double) :
9894 va_arg(*args, double)
9896 va_arg(*args, double)
9902 if (c != 'e' && c != 'E') {
9904 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9905 will cast our (long double) to (double) */
9906 (void)Perl_frexp(nv, &i);
9907 if (i == PERL_INT_MIN)
9908 Perl_die(aTHX_ "panic: frexp");
9910 need = BIT_DIGITS(i);
9912 need += has_precis ? precis : 6; /* known default */
9917 #ifdef HAS_LDBL_SPRINTF_BUG
9918 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9919 with sfio - Allen <allens@cpan.org> */
9922 # define MY_DBL_MAX DBL_MAX
9923 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9924 # if DOUBLESIZE >= 8
9925 # define MY_DBL_MAX 1.7976931348623157E+308L
9927 # define MY_DBL_MAX 3.40282347E+38L
9931 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9932 # define MY_DBL_MAX_BUG 1L
9934 # define MY_DBL_MAX_BUG MY_DBL_MAX
9938 # define MY_DBL_MIN DBL_MIN
9939 # else /* XXX guessing! -Allen */
9940 # if DOUBLESIZE >= 8
9941 # define MY_DBL_MIN 2.2250738585072014E-308L
9943 # define MY_DBL_MIN 1.17549435E-38L
9947 if ((intsize == 'q') && (c == 'f') &&
9948 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9950 /* it's going to be short enough that
9951 * long double precision is not needed */
9953 if ((nv <= 0L) && (nv >= -0L))
9954 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9956 /* would use Perl_fp_class as a double-check but not
9957 * functional on IRIX - see perl.h comments */
9959 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9960 /* It's within the range that a double can represent */
9961 #if defined(DBL_MAX) && !defined(DBL_MIN)
9962 if ((nv >= ((long double)1/DBL_MAX)) ||
9963 (nv <= (-(long double)1/DBL_MAX)))
9965 fix_ldbl_sprintf_bug = TRUE;
9968 if (fix_ldbl_sprintf_bug == TRUE) {
9978 # undef MY_DBL_MAX_BUG
9981 #endif /* HAS_LDBL_SPRINTF_BUG */
9983 need += 20; /* fudge factor */
9984 if (PL_efloatsize < need) {
9985 Safefree(PL_efloatbuf);
9986 PL_efloatsize = need + 20; /* more fudge */
9987 New(906, PL_efloatbuf, PL_efloatsize, char);
9988 PL_efloatbuf[0] = '\0';
9991 if ( !(width || left || plus || alt) && fill != '0'
9992 && has_precis && intsize != 'q' ) { /* Shortcuts */
9993 /* See earlier comment about buggy Gconvert when digits,
9995 if ( c == 'g' && precis) {
9996 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9997 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9998 goto float_converted;
9999 } else if ( c == 'f' && !precis) {
10000 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10005 char *ptr = ebuf + sizeof ebuf;
10008 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10009 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10010 if (intsize == 'q') {
10011 /* Copy the one or more characters in a long double
10012 * format before the 'base' ([efgEFG]) character to
10013 * the format string. */
10014 static char const prifldbl[] = PERL_PRIfldbl;
10015 char const *p = prifldbl + sizeof(prifldbl) - 3;
10016 while (p >= prifldbl) { *--ptr = *p--; }
10021 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10026 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10038 /* No taint. Otherwise we are in the strange situation
10039 * where printf() taints but print($float) doesn't.
10041 #if defined(HAS_LONG_DOUBLE)
10042 if (intsize == 'q')
10043 (void)sprintf(PL_efloatbuf, ptr, nv);
10045 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
10047 (void)sprintf(PL_efloatbuf, ptr, nv);
10051 eptr = PL_efloatbuf;
10052 elen = strlen(PL_efloatbuf);
10058 i = SvCUR(sv) - origlen;
10059 if (args && !vectorize) {
10061 case 'h': *(va_arg(*args, short*)) = i; break;
10062 default: *(va_arg(*args, int*)) = i; break;
10063 case 'l': *(va_arg(*args, long*)) = i; break;
10064 case 'V': *(va_arg(*args, IV*)) = i; break;
10066 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10071 sv_setuv_mg(argsv, (UV)i);
10073 continue; /* not "break" */
10079 if (!args && ckWARN(WARN_PRINTF) &&
10080 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10081 SV *msg = sv_newmortal();
10082 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10083 (PL_op->op_type == OP_PRTF) ? "" : "s");
10086 Perl_sv_catpvf(aTHX_ msg,
10087 "\"%%%c\"", c & 0xFF);
10089 Perl_sv_catpvf(aTHX_ msg,
10090 "\"%%\\%03"UVof"\"",
10093 sv_catpv(msg, "end of string");
10094 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10097 /* output mangled stuff ... */
10103 /* ... right here, because formatting flags should not apply */
10104 SvGROW(sv, SvCUR(sv) + elen + 1);
10106 Copy(eptr, p, elen, char);
10109 SvCUR_set(sv, p - SvPVX_const(sv));
10111 continue; /* not "break" */
10114 /* calculate width before utf8_upgrade changes it */
10115 have = esignlen + zeros + elen;
10117 if (is_utf8 != has_utf8) {
10120 sv_utf8_upgrade(sv);
10123 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10124 sv_utf8_upgrade(nsv);
10125 eptr = SvPVX_const(nsv);
10128 SvGROW(sv, SvCUR(sv) + elen + 1);
10133 need = (have > width ? have : width);
10136 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10138 if (esignlen && fill == '0') {
10139 for (i = 0; i < (int)esignlen; i++)
10140 *p++ = esignbuf[i];
10142 if (gap && !left) {
10143 memset(p, fill, gap);
10146 if (esignlen && fill != '0') {
10147 for (i = 0; i < (int)esignlen; i++)
10148 *p++ = esignbuf[i];
10151 for (i = zeros; i; i--)
10155 Copy(eptr, p, elen, char);
10159 memset(p, ' ', gap);
10164 Copy(dotstr, p, dotstrlen, char);
10168 vectorize = FALSE; /* done iterating over vecstr */
10175 SvCUR_set(sv, p - SvPVX_const(sv));
10183 /* =========================================================================
10185 =head1 Cloning an interpreter
10187 All the macros and functions in this section are for the private use of
10188 the main function, perl_clone().
10190 The foo_dup() functions make an exact copy of an existing foo thinngy.
10191 During the course of a cloning, a hash table is used to map old addresses
10192 to new addresses. The table is created and manipulated with the
10193 ptr_table_* functions.
10197 ============================================================================*/
10200 #if defined(USE_ITHREADS)
10202 #ifndef GpREFCNT_inc
10203 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10207 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10208 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10209 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10210 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10211 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10212 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10213 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10214 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10215 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10216 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10217 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10218 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10219 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10222 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10223 regcomp.c. AMS 20010712 */
10226 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10231 struct reg_substr_datum *s;
10234 return (REGEXP *)NULL;
10236 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10239 len = r->offsets[0];
10240 npar = r->nparens+1;
10242 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10243 Copy(r->program, ret->program, len+1, regnode);
10245 New(0, ret->startp, npar, I32);
10246 Copy(r->startp, ret->startp, npar, I32);
10247 New(0, ret->endp, npar, I32);
10248 Copy(r->startp, ret->startp, npar, I32);
10250 New(0, ret->substrs, 1, struct reg_substr_data);
10251 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10252 s->min_offset = r->substrs->data[i].min_offset;
10253 s->max_offset = r->substrs->data[i].max_offset;
10254 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10255 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10258 ret->regstclass = NULL;
10260 struct reg_data *d;
10261 const int count = r->data->count;
10263 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10264 char, struct reg_data);
10265 New(0, d->what, count, U8);
10268 for (i = 0; i < count; i++) {
10269 d->what[i] = r->data->what[i];
10270 switch (d->what[i]) {
10271 /* legal options are one of: sfpont
10272 see also regcomp.h and pregfree() */
10274 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10277 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10280 /* This is cheating. */
10281 New(0, d->data[i], 1, struct regnode_charclass_class);
10282 StructCopy(r->data->data[i], d->data[i],
10283 struct regnode_charclass_class);
10284 ret->regstclass = (regnode*)d->data[i];
10287 /* Compiled op trees are readonly, and can thus be
10288 shared without duplication. */
10290 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10294 d->data[i] = r->data->data[i];
10297 d->data[i] = r->data->data[i];
10299 ((reg_trie_data*)d->data[i])->refcount++;
10303 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10312 New(0, ret->offsets, 2*len+1, U32);
10313 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10315 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10316 ret->refcnt = r->refcnt;
10317 ret->minlen = r->minlen;
10318 ret->prelen = r->prelen;
10319 ret->nparens = r->nparens;
10320 ret->lastparen = r->lastparen;
10321 ret->lastcloseparen = r->lastcloseparen;
10322 ret->reganch = r->reganch;
10324 ret->sublen = r->sublen;
10326 if (RX_MATCH_COPIED(ret))
10327 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10329 ret->subbeg = Nullch;
10330 #ifdef PERL_OLD_COPY_ON_WRITE
10331 ret->saved_copy = Nullsv;
10334 ptr_table_store(PL_ptr_table, r, ret);
10338 /* duplicate a file handle */
10341 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10347 return (PerlIO*)NULL;
10349 /* look for it in the table first */
10350 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10354 /* create anew and remember what it is */
10355 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10356 ptr_table_store(PL_ptr_table, fp, ret);
10360 /* duplicate a directory handle */
10363 Perl_dirp_dup(pTHX_ DIR *dp)
10371 /* duplicate a typeglob */
10374 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10379 /* look for it in the table first */
10380 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10384 /* create anew and remember what it is */
10385 Newz(0, ret, 1, GP);
10386 ptr_table_store(PL_ptr_table, gp, ret);
10389 ret->gp_refcnt = 0; /* must be before any other dups! */
10390 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10391 ret->gp_io = io_dup_inc(gp->gp_io, param);
10392 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10393 ret->gp_av = av_dup_inc(gp->gp_av, param);
10394 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10395 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10396 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10397 ret->gp_cvgen = gp->gp_cvgen;
10398 ret->gp_flags = gp->gp_flags;
10399 ret->gp_line = gp->gp_line;
10400 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10404 /* duplicate a chain of magic */
10407 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10409 MAGIC *mgprev = (MAGIC*)NULL;
10412 return (MAGIC*)NULL;
10413 /* look for it in the table first */
10414 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10418 for (; mg; mg = mg->mg_moremagic) {
10420 Newz(0, nmg, 1, MAGIC);
10422 mgprev->mg_moremagic = nmg;
10425 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10426 nmg->mg_private = mg->mg_private;
10427 nmg->mg_type = mg->mg_type;
10428 nmg->mg_flags = mg->mg_flags;
10429 if (mg->mg_type == PERL_MAGIC_qr) {
10430 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10432 else if(mg->mg_type == PERL_MAGIC_backref) {
10433 const AV * const av = (AV*) mg->mg_obj;
10436 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10438 for (i = AvFILLp(av); i >= 0; i--) {
10439 if (!svp[i]) continue;
10440 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10443 else if (mg->mg_type == PERL_MAGIC_symtab) {
10444 nmg->mg_obj = mg->mg_obj;
10447 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10448 ? sv_dup_inc(mg->mg_obj, param)
10449 : sv_dup(mg->mg_obj, param);
10451 nmg->mg_len = mg->mg_len;
10452 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10453 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10454 if (mg->mg_len > 0) {
10455 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10456 if (mg->mg_type == PERL_MAGIC_overload_table &&
10457 AMT_AMAGIC((AMT*)mg->mg_ptr))
10459 AMT *amtp = (AMT*)mg->mg_ptr;
10460 AMT *namtp = (AMT*)nmg->mg_ptr;
10462 for (i = 1; i < NofAMmeth; i++) {
10463 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10467 else if (mg->mg_len == HEf_SVKEY)
10468 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10470 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10471 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10478 /* create a new pointer-mapping table */
10481 Perl_ptr_table_new(pTHX)
10484 Newz(0, tbl, 1, PTR_TBL_t);
10485 tbl->tbl_max = 511;
10486 tbl->tbl_items = 0;
10487 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10492 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10494 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10502 struct ptr_tbl_ent* pte;
10503 struct ptr_tbl_ent* pteend;
10504 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10505 pte->next = PL_pte_arenaroot;
10506 PL_pte_arenaroot = pte;
10508 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10509 PL_pte_root = ++pte;
10510 while (pte < pteend) {
10511 pte->next = pte + 1;
10517 STATIC struct ptr_tbl_ent*
10520 struct ptr_tbl_ent* pte;
10524 PL_pte_root = pte->next;
10529 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10531 p->next = PL_pte_root;
10535 /* map an existing pointer using a table */
10538 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10540 PTR_TBL_ENT_t *tblent;
10541 const UV hash = PTR_TABLE_HASH(sv);
10543 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10544 for (; tblent; tblent = tblent->next) {
10545 if (tblent->oldval == sv)
10546 return tblent->newval;
10548 return (void*)NULL;
10551 /* add a new entry to a pointer-mapping table */
10554 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10556 PTR_TBL_ENT_t *tblent, **otblent;
10557 /* XXX this may be pessimal on platforms where pointers aren't good
10558 * hash values e.g. if they grow faster in the most significant
10560 const UV hash = PTR_TABLE_HASH(oldv);
10564 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10565 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10566 if (tblent->oldval == oldv) {
10567 tblent->newval = newv;
10571 tblent = S_new_pte(aTHX);
10572 tblent->oldval = oldv;
10573 tblent->newval = newv;
10574 tblent->next = *otblent;
10577 if (!empty && tbl->tbl_items > tbl->tbl_max)
10578 ptr_table_split(tbl);
10581 /* double the hash bucket size of an existing ptr table */
10584 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10586 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10587 const UV oldsize = tbl->tbl_max + 1;
10588 UV newsize = oldsize * 2;
10591 Renew(ary, newsize, PTR_TBL_ENT_t*);
10592 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10593 tbl->tbl_max = --newsize;
10594 tbl->tbl_ary = ary;
10595 for (i=0; i < oldsize; i++, ary++) {
10596 PTR_TBL_ENT_t **curentp, **entp, *ent;
10599 curentp = ary + oldsize;
10600 for (entp = ary, ent = *ary; ent; ent = *entp) {
10601 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10603 ent->next = *curentp;
10613 /* remove all the entries from a ptr table */
10616 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10618 register PTR_TBL_ENT_t **array;
10619 register PTR_TBL_ENT_t *entry;
10623 if (!tbl || !tbl->tbl_items) {
10627 array = tbl->tbl_ary;
10629 max = tbl->tbl_max;
10633 PTR_TBL_ENT_t *oentry = entry;
10634 entry = entry->next;
10635 S_del_pte(aTHX_ oentry);
10638 if (++riter > max) {
10641 entry = array[riter];
10645 tbl->tbl_items = 0;
10648 /* clear and free a ptr table */
10651 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10656 ptr_table_clear(tbl);
10657 Safefree(tbl->tbl_ary);
10661 /* attempt to make everything in the typeglob readonly */
10664 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10666 GV *gv = (GV*)sstr;
10667 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10669 if (GvIO(gv) || GvFORM(gv)) {
10670 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10672 else if (!GvCV(gv)) {
10673 GvCV(gv) = (CV*)sv;
10676 /* CvPADLISTs cannot be shared */
10677 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10682 if (!GvUNIQUE(gv)) {
10684 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10685 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10691 * write attempts will die with
10692 * "Modification of a read-only value attempted"
10698 SvREADONLY_on(GvSV(gv));
10702 GvAV(gv) = (AV*)sv;
10705 SvREADONLY_on(GvAV(gv));
10709 GvHV(gv) = (HV*)sv;
10712 SvREADONLY_on(GvHV(gv));
10715 return sstr; /* he_dup() will SvREFCNT_inc() */
10718 /* duplicate an SV of any type (including AV, HV etc) */
10721 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10724 SvRV_set(dstr, SvWEAKREF(sstr)
10725 ? sv_dup(SvRV(sstr), param)
10726 : sv_dup_inc(SvRV(sstr), param));
10729 else if (SvPVX_const(sstr)) {
10730 /* Has something there */
10732 /* Normal PV - clone whole allocated space */
10733 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10734 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10735 /* Not that normal - actually sstr is copy on write.
10736 But we are a true, independant SV, so: */
10737 SvREADONLY_off(dstr);
10742 /* Special case - not normally malloced for some reason */
10743 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10744 /* A "shared" PV - clone it as "shared" PV */
10746 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10750 /* Some other special case - random pointer */
10751 SvPV_set(dstr, SvPVX(sstr));
10756 /* Copy the Null */
10757 if (SvTYPE(dstr) == SVt_RV)
10758 SvRV_set(dstr, NULL);
10765 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10770 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10772 /* look for it in the table first */
10773 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10777 if(param->flags & CLONEf_JOIN_IN) {
10778 /** We are joining here so we don't want do clone
10779 something that is bad **/
10780 const char *hvname;
10782 if(SvTYPE(sstr) == SVt_PVHV &&
10783 (hvname = HvNAME_get(sstr))) {
10784 /** don't clone stashes if they already exist **/
10785 HV* old_stash = gv_stashpv(hvname,0);
10786 return (SV*) old_stash;
10790 /* create anew and remember what it is */
10793 #ifdef DEBUG_LEAKING_SCALARS
10794 dstr->sv_debug_optype = sstr->sv_debug_optype;
10795 dstr->sv_debug_line = sstr->sv_debug_line;
10796 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10797 dstr->sv_debug_cloned = 1;
10799 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10801 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10805 ptr_table_store(PL_ptr_table, sstr, dstr);
10808 SvFLAGS(dstr) = SvFLAGS(sstr);
10809 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10810 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10813 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10814 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10815 PL_watch_pvx, SvPVX_const(sstr));
10818 /* don't clone objects whose class has asked us not to */
10819 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10820 SvFLAGS(dstr) &= ~SVTYPEMASK;
10821 SvOBJECT_off(dstr);
10825 switch (SvTYPE(sstr)) {
10827 SvANY(dstr) = NULL;
10830 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10831 SvIV_set(dstr, SvIVX(sstr));
10834 SvANY(dstr) = new_XNV();
10835 SvNV_set(dstr, SvNVX(sstr));
10838 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10839 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10842 SvANY(dstr) = new_XPV();
10843 SvCUR_set(dstr, SvCUR(sstr));
10844 SvLEN_set(dstr, SvLEN(sstr));
10845 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10848 SvANY(dstr) = new_XPVIV();
10849 SvCUR_set(dstr, SvCUR(sstr));
10850 SvLEN_set(dstr, SvLEN(sstr));
10851 SvIV_set(dstr, SvIVX(sstr));
10852 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10855 SvANY(dstr) = new_XPVNV();
10856 SvCUR_set(dstr, SvCUR(sstr));
10857 SvLEN_set(dstr, SvLEN(sstr));
10858 SvIV_set(dstr, SvIVX(sstr));
10859 SvNV_set(dstr, SvNVX(sstr));
10860 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10863 SvANY(dstr) = new_XPVMG();
10864 SvCUR_set(dstr, SvCUR(sstr));
10865 SvLEN_set(dstr, SvLEN(sstr));
10866 SvIV_set(dstr, SvIVX(sstr));
10867 SvNV_set(dstr, SvNVX(sstr));
10868 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10869 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10870 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10873 SvANY(dstr) = new_XPVBM();
10874 SvCUR_set(dstr, SvCUR(sstr));
10875 SvLEN_set(dstr, SvLEN(sstr));
10876 SvIV_set(dstr, SvIVX(sstr));
10877 SvNV_set(dstr, SvNVX(sstr));
10878 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10879 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10880 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10881 BmRARE(dstr) = BmRARE(sstr);
10882 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10883 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10886 SvANY(dstr) = new_XPVLV();
10887 SvCUR_set(dstr, SvCUR(sstr));
10888 SvLEN_set(dstr, SvLEN(sstr));
10889 SvIV_set(dstr, SvIVX(sstr));
10890 SvNV_set(dstr, SvNVX(sstr));
10891 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10892 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10893 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10894 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10895 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10896 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10897 LvTARG(dstr) = dstr;
10898 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10899 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10901 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10902 LvTYPE(dstr) = LvTYPE(sstr);
10905 if (GvUNIQUE((GV*)sstr)) {
10907 if ((share = gv_share(sstr, param))) {
10910 ptr_table_store(PL_ptr_table, sstr, dstr);
10912 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10913 HvNAME_get(GvSTASH(share)), GvNAME(share));
10918 SvANY(dstr) = new_XPVGV();
10919 SvCUR_set(dstr, SvCUR(sstr));
10920 SvLEN_set(dstr, SvLEN(sstr));
10921 SvIV_set(dstr, SvIVX(sstr));
10922 SvNV_set(dstr, SvNVX(sstr));
10923 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10924 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10925 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10926 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10927 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10928 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10929 GvFLAGS(dstr) = GvFLAGS(sstr);
10930 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10931 (void)GpREFCNT_inc(GvGP(dstr));
10934 SvANY(dstr) = new_XPVIO();
10935 SvCUR_set(dstr, SvCUR(sstr));
10936 SvLEN_set(dstr, SvLEN(sstr));
10937 SvIV_set(dstr, SvIVX(sstr));
10938 SvNV_set(dstr, SvNVX(sstr));
10939 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10940 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10941 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10942 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10943 if (IoOFP(sstr) == IoIFP(sstr))
10944 IoOFP(dstr) = IoIFP(dstr);
10946 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10947 /* PL_rsfp_filters entries have fake IoDIRP() */
10948 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10949 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10951 IoDIRP(dstr) = IoDIRP(sstr);
10952 IoLINES(dstr) = IoLINES(sstr);
10953 IoPAGE(dstr) = IoPAGE(sstr);
10954 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10955 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10956 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10957 /* I have no idea why fake dirp (rsfps)
10958 should be treaded differently but otherwise
10959 we end up with leaks -- sky*/
10960 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10961 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10962 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10964 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10965 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10966 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10968 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10969 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10970 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10971 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10972 IoTYPE(dstr) = IoTYPE(sstr);
10973 IoFLAGS(dstr) = IoFLAGS(sstr);
10976 SvANY(dstr) = new_XPVAV();
10977 SvCUR_set(dstr, SvCUR(sstr));
10978 SvLEN_set(dstr, SvLEN(sstr));
10979 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10980 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10981 if (AvARRAY((AV*)sstr)) {
10982 SV **dst_ary, **src_ary;
10983 SSize_t items = AvFILLp((AV*)sstr) + 1;
10985 src_ary = AvARRAY((AV*)sstr);
10986 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10987 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10988 SvPV_set(dstr, (char*)dst_ary);
10989 AvALLOC((AV*)dstr) = dst_ary;
10990 if (AvREAL((AV*)sstr)) {
10991 while (items-- > 0)
10992 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10995 while (items-- > 0)
10996 *dst_ary++ = sv_dup(*src_ary++, param);
10998 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10999 while (items-- > 0) {
11000 *dst_ary++ = &PL_sv_undef;
11004 SvPV_set(dstr, Nullch);
11005 AvALLOC((AV*)dstr) = (SV**)NULL;
11009 SvANY(dstr) = new_XPVHV();
11010 SvCUR_set(dstr, SvCUR(sstr));
11011 SvLEN_set(dstr, SvLEN(sstr));
11012 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
11013 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11014 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11018 if (HvARRAY((HV*)sstr)) {
11020 const bool sharekeys = !!HvSHAREKEYS(sstr);
11021 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11022 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11025 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11026 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
11027 HvARRAY(dstr) = (HE**)darray;
11028 while (i <= sxhv->xhv_max) {
11029 HE *source = HvARRAY(sstr)[i];
11031 = source ? he_dup(source, sharekeys, param) : 0;
11035 struct xpvhv_aux *saux = HvAUX(sstr);
11036 struct xpvhv_aux *daux = HvAUX(dstr);
11037 /* This flag isn't copied. */
11038 /* SvOOK_on(hv) attacks the IV flags. */
11039 SvFLAGS(dstr) |= SVf_OOK;
11041 hvname = saux->xhv_name;
11042 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11044 daux->xhv_riter = saux->xhv_riter;
11045 daux->xhv_eiter = saux->xhv_eiter
11046 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11051 SvPV_set(dstr, Nullch);
11053 /* Record stashes for possible cloning in Perl_clone(). */
11055 av_push(param->stashes, dstr);
11059 SvANY(dstr) = new_XPVFM();
11060 FmLINES(dstr) = FmLINES(sstr);
11064 SvANY(dstr) = new_XPVCV();
11066 SvCUR_set(dstr, SvCUR(sstr));
11067 SvLEN_set(dstr, SvLEN(sstr));
11068 SvIV_set(dstr, SvIVX(sstr));
11069 SvNV_set(dstr, SvNVX(sstr));
11070 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11071 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11072 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11073 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11074 CvSTART(dstr) = CvSTART(sstr);
11076 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11078 CvXSUB(dstr) = CvXSUB(sstr);
11079 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11080 if (CvCONST(sstr)) {
11081 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11082 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11083 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11085 /* don't dup if copying back - CvGV isn't refcounted, so the
11086 * duped GV may never be freed. A bit of a hack! DAPM */
11087 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11088 Nullgv : gv_dup(CvGV(sstr), param) ;
11089 if (param->flags & CLONEf_COPY_STACKS) {
11090 CvDEPTH(dstr) = CvDEPTH(sstr);
11094 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11095 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11097 CvWEAKOUTSIDE(sstr)
11098 ? cv_dup( CvOUTSIDE(sstr), param)
11099 : cv_dup_inc(CvOUTSIDE(sstr), param);
11100 CvFLAGS(dstr) = CvFLAGS(sstr);
11101 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11104 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11108 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11114 /* duplicate a context */
11117 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11119 PERL_CONTEXT *ncxs;
11122 return (PERL_CONTEXT*)NULL;
11124 /* look for it in the table first */
11125 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11129 /* create anew and remember what it is */
11130 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11131 ptr_table_store(PL_ptr_table, cxs, ncxs);
11134 PERL_CONTEXT *cx = &cxs[ix];
11135 PERL_CONTEXT *ncx = &ncxs[ix];
11136 ncx->cx_type = cx->cx_type;
11137 if (CxTYPE(cx) == CXt_SUBST) {
11138 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11141 ncx->blk_oldsp = cx->blk_oldsp;
11142 ncx->blk_oldcop = cx->blk_oldcop;
11143 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11144 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11145 ncx->blk_oldpm = cx->blk_oldpm;
11146 ncx->blk_gimme = cx->blk_gimme;
11147 switch (CxTYPE(cx)) {
11149 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11150 ? cv_dup_inc(cx->blk_sub.cv, param)
11151 : cv_dup(cx->blk_sub.cv,param));
11152 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11153 ? av_dup_inc(cx->blk_sub.argarray, param)
11155 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11156 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11157 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11158 ncx->blk_sub.lval = cx->blk_sub.lval;
11159 ncx->blk_sub.retop = cx->blk_sub.retop;
11162 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11163 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11164 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11165 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11166 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11167 ncx->blk_eval.retop = cx->blk_eval.retop;
11170 ncx->blk_loop.label = cx->blk_loop.label;
11171 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11172 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11173 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11174 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11175 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11176 ? cx->blk_loop.iterdata
11177 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11178 ncx->blk_loop.oldcomppad
11179 = (PAD*)ptr_table_fetch(PL_ptr_table,
11180 cx->blk_loop.oldcomppad);
11181 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11182 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11183 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11184 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11185 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11188 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11189 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11190 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11191 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11192 ncx->blk_sub.retop = cx->blk_sub.retop;
11204 /* duplicate a stack info structure */
11207 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11212 return (PERL_SI*)NULL;
11214 /* look for it in the table first */
11215 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11219 /* create anew and remember what it is */
11220 Newz(56, nsi, 1, PERL_SI);
11221 ptr_table_store(PL_ptr_table, si, nsi);
11223 nsi->si_stack = av_dup_inc(si->si_stack, param);
11224 nsi->si_cxix = si->si_cxix;
11225 nsi->si_cxmax = si->si_cxmax;
11226 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11227 nsi->si_type = si->si_type;
11228 nsi->si_prev = si_dup(si->si_prev, param);
11229 nsi->si_next = si_dup(si->si_next, param);
11230 nsi->si_markoff = si->si_markoff;
11235 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11236 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11237 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11238 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11239 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11240 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11241 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11242 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11243 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11244 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11245 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11246 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11247 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11248 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11251 #define pv_dup_inc(p) SAVEPV(p)
11252 #define pv_dup(p) SAVEPV(p)
11253 #define svp_dup_inc(p,pp) any_dup(p,pp)
11255 /* map any object to the new equivent - either something in the
11256 * ptr table, or something in the interpreter structure
11260 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11265 return (void*)NULL;
11267 /* look for it in the table first */
11268 ret = ptr_table_fetch(PL_ptr_table, v);
11272 /* see if it is part of the interpreter structure */
11273 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11274 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11282 /* duplicate the save stack */
11285 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11287 ANY *ss = proto_perl->Tsavestack;
11288 I32 ix = proto_perl->Tsavestack_ix;
11289 I32 max = proto_perl->Tsavestack_max;
11301 void (*dptr) (void*);
11302 void (*dxptr) (pTHX_ void*);
11305 Newz(54, nss, max, ANY);
11308 I32 i = POPINT(ss,ix);
11309 TOPINT(nss,ix) = i;
11311 case SAVEt_ITEM: /* normal string */
11312 sv = (SV*)POPPTR(ss,ix);
11313 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11314 sv = (SV*)POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11317 case SAVEt_SV: /* scalar reference */
11318 sv = (SV*)POPPTR(ss,ix);
11319 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11320 gv = (GV*)POPPTR(ss,ix);
11321 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11323 case SAVEt_GENERIC_PVREF: /* generic char* */
11324 c = (char*)POPPTR(ss,ix);
11325 TOPPTR(nss,ix) = pv_dup(c);
11326 ptr = POPPTR(ss,ix);
11327 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11329 case SAVEt_SHARED_PVREF: /* char* in shared space */
11330 c = (char*)POPPTR(ss,ix);
11331 TOPPTR(nss,ix) = savesharedpv(c);
11332 ptr = POPPTR(ss,ix);
11333 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11335 case SAVEt_GENERIC_SVREF: /* generic sv */
11336 case SAVEt_SVREF: /* scalar reference */
11337 sv = (SV*)POPPTR(ss,ix);
11338 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11339 ptr = POPPTR(ss,ix);
11340 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11342 case SAVEt_AV: /* array reference */
11343 av = (AV*)POPPTR(ss,ix);
11344 TOPPTR(nss,ix) = av_dup_inc(av, param);
11345 gv = (GV*)POPPTR(ss,ix);
11346 TOPPTR(nss,ix) = gv_dup(gv, param);
11348 case SAVEt_HV: /* hash reference */
11349 hv = (HV*)POPPTR(ss,ix);
11350 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11351 gv = (GV*)POPPTR(ss,ix);
11352 TOPPTR(nss,ix) = gv_dup(gv, param);
11354 case SAVEt_INT: /* int reference */
11355 ptr = POPPTR(ss,ix);
11356 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11357 intval = (int)POPINT(ss,ix);
11358 TOPINT(nss,ix) = intval;
11360 case SAVEt_LONG: /* long reference */
11361 ptr = POPPTR(ss,ix);
11362 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11363 longval = (long)POPLONG(ss,ix);
11364 TOPLONG(nss,ix) = longval;
11366 case SAVEt_I32: /* I32 reference */
11367 case SAVEt_I16: /* I16 reference */
11368 case SAVEt_I8: /* I8 reference */
11369 ptr = POPPTR(ss,ix);
11370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11372 TOPINT(nss,ix) = i;
11374 case SAVEt_IV: /* IV reference */
11375 ptr = POPPTR(ss,ix);
11376 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11378 TOPIV(nss,ix) = iv;
11380 case SAVEt_SPTR: /* SV* reference */
11381 ptr = POPPTR(ss,ix);
11382 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11383 sv = (SV*)POPPTR(ss,ix);
11384 TOPPTR(nss,ix) = sv_dup(sv, param);
11386 case SAVEt_VPTR: /* random* reference */
11387 ptr = POPPTR(ss,ix);
11388 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11389 ptr = POPPTR(ss,ix);
11390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11392 case SAVEt_PPTR: /* char* reference */
11393 ptr = POPPTR(ss,ix);
11394 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11395 c = (char*)POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = pv_dup(c);
11398 case SAVEt_HPTR: /* HV* reference */
11399 ptr = POPPTR(ss,ix);
11400 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11401 hv = (HV*)POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = hv_dup(hv, param);
11404 case SAVEt_APTR: /* AV* reference */
11405 ptr = POPPTR(ss,ix);
11406 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11407 av = (AV*)POPPTR(ss,ix);
11408 TOPPTR(nss,ix) = av_dup(av, param);
11411 gv = (GV*)POPPTR(ss,ix);
11412 TOPPTR(nss,ix) = gv_dup(gv, param);
11414 case SAVEt_GP: /* scalar reference */
11415 gp = (GP*)POPPTR(ss,ix);
11416 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11417 (void)GpREFCNT_inc(gp);
11418 gv = (GV*)POPPTR(ss,ix);
11419 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11420 c = (char*)POPPTR(ss,ix);
11421 TOPPTR(nss,ix) = pv_dup(c);
11423 TOPIV(nss,ix) = iv;
11425 TOPIV(nss,ix) = iv;
11428 case SAVEt_MORTALIZESV:
11429 sv = (SV*)POPPTR(ss,ix);
11430 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11433 ptr = POPPTR(ss,ix);
11434 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11435 /* these are assumed to be refcounted properly */
11436 switch (((OP*)ptr)->op_type) {
11438 case OP_LEAVESUBLV:
11442 case OP_LEAVEWRITE:
11443 TOPPTR(nss,ix) = ptr;
11448 TOPPTR(nss,ix) = Nullop;
11453 TOPPTR(nss,ix) = Nullop;
11456 c = (char*)POPPTR(ss,ix);
11457 TOPPTR(nss,ix) = pv_dup_inc(c);
11459 case SAVEt_CLEARSV:
11460 longval = POPLONG(ss,ix);
11461 TOPLONG(nss,ix) = longval;
11464 hv = (HV*)POPPTR(ss,ix);
11465 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11466 c = (char*)POPPTR(ss,ix);
11467 TOPPTR(nss,ix) = pv_dup_inc(c);
11469 TOPINT(nss,ix) = i;
11471 case SAVEt_DESTRUCTOR:
11472 ptr = POPPTR(ss,ix);
11473 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11474 dptr = POPDPTR(ss,ix);
11475 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11476 any_dup(FPTR2DPTR(void *, dptr),
11479 case SAVEt_DESTRUCTOR_X:
11480 ptr = POPPTR(ss,ix);
11481 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11482 dxptr = POPDXPTR(ss,ix);
11483 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11484 any_dup(FPTR2DPTR(void *, dxptr),
11487 case SAVEt_REGCONTEXT:
11490 TOPINT(nss,ix) = i;
11493 case SAVEt_STACK_POS: /* Position on Perl stack */
11495 TOPINT(nss,ix) = i;
11497 case SAVEt_AELEM: /* array element */
11498 sv = (SV*)POPPTR(ss,ix);
11499 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11501 TOPINT(nss,ix) = i;
11502 av = (AV*)POPPTR(ss,ix);
11503 TOPPTR(nss,ix) = av_dup_inc(av, param);
11505 case SAVEt_HELEM: /* hash element */
11506 sv = (SV*)POPPTR(ss,ix);
11507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11508 sv = (SV*)POPPTR(ss,ix);
11509 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11510 hv = (HV*)POPPTR(ss,ix);
11511 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11514 ptr = POPPTR(ss,ix);
11515 TOPPTR(nss,ix) = ptr;
11519 TOPINT(nss,ix) = i;
11521 case SAVEt_COMPPAD:
11522 av = (AV*)POPPTR(ss,ix);
11523 TOPPTR(nss,ix) = av_dup(av, param);
11526 longval = (long)POPLONG(ss,ix);
11527 TOPLONG(nss,ix) = longval;
11528 ptr = POPPTR(ss,ix);
11529 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11530 sv = (SV*)POPPTR(ss,ix);
11531 TOPPTR(nss,ix) = sv_dup(sv, param);
11534 ptr = POPPTR(ss,ix);
11535 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11536 longval = (long)POPBOOL(ss,ix);
11537 TOPBOOL(nss,ix) = (bool)longval;
11539 case SAVEt_SET_SVFLAGS:
11541 TOPINT(nss,ix) = i;
11543 TOPINT(nss,ix) = i;
11544 sv = (SV*)POPPTR(ss,ix);
11545 TOPPTR(nss,ix) = sv_dup(sv, param);
11548 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11556 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11557 * flag to the result. This is done for each stash before cloning starts,
11558 * so we know which stashes want their objects cloned */
11561 do_mark_cloneable_stash(pTHX_ SV *sv)
11563 const HEK *hvname = HvNAME_HEK((HV*)sv);
11565 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11566 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11567 if (cloner && GvCV(cloner)) {
11574 XPUSHs(sv_2mortal(newSVhek(hvname)));
11576 call_sv((SV*)GvCV(cloner), G_SCALAR);
11583 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11591 =for apidoc perl_clone
11593 Create and return a new interpreter by cloning the current one.
11595 perl_clone takes these flags as parameters:
11597 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11598 without it we only clone the data and zero the stacks,
11599 with it we copy the stacks and the new perl interpreter is
11600 ready to run at the exact same point as the previous one.
11601 The pseudo-fork code uses COPY_STACKS while the
11602 threads->new doesn't.
11604 CLONEf_KEEP_PTR_TABLE
11605 perl_clone keeps a ptr_table with the pointer of the old
11606 variable as a key and the new variable as a value,
11607 this allows it to check if something has been cloned and not
11608 clone it again but rather just use the value and increase the
11609 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11610 the ptr_table using the function
11611 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11612 reason to keep it around is if you want to dup some of your own
11613 variable who are outside the graph perl scans, example of this
11614 code is in threads.xs create
11617 This is a win32 thing, it is ignored on unix, it tells perls
11618 win32host code (which is c++) to clone itself, this is needed on
11619 win32 if you want to run two threads at the same time,
11620 if you just want to do some stuff in a separate perl interpreter
11621 and then throw it away and return to the original one,
11622 you don't need to do anything.
11627 /* XXX the above needs expanding by someone who actually understands it ! */
11628 EXTERN_C PerlInterpreter *
11629 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11632 perl_clone(PerlInterpreter *proto_perl, UV flags)
11635 #ifdef PERL_IMPLICIT_SYS
11637 /* perlhost.h so we need to call into it
11638 to clone the host, CPerlHost should have a c interface, sky */
11640 if (flags & CLONEf_CLONE_HOST) {
11641 return perl_clone_host(proto_perl,flags);
11643 return perl_clone_using(proto_perl, flags,
11645 proto_perl->IMemShared,
11646 proto_perl->IMemParse,
11648 proto_perl->IStdIO,
11652 proto_perl->IProc);
11656 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11657 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11658 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11659 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11660 struct IPerlDir* ipD, struct IPerlSock* ipS,
11661 struct IPerlProc* ipP)
11663 /* XXX many of the string copies here can be optimized if they're
11664 * constants; they need to be allocated as common memory and just
11665 * their pointers copied. */
11668 CLONE_PARAMS clone_params;
11669 CLONE_PARAMS* param = &clone_params;
11671 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11672 /* for each stash, determine whether its objects should be cloned */
11673 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11674 PERL_SET_THX(my_perl);
11677 Poison(my_perl, 1, PerlInterpreter);
11679 PL_curcop = (COP *)Nullop;
11683 PL_savestack_ix = 0;
11684 PL_savestack_max = -1;
11685 PL_sig_pending = 0;
11686 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11687 # else /* !DEBUGGING */
11688 Zero(my_perl, 1, PerlInterpreter);
11689 # endif /* DEBUGGING */
11691 /* host pointers */
11693 PL_MemShared = ipMS;
11694 PL_MemParse = ipMP;
11701 #else /* !PERL_IMPLICIT_SYS */
11703 CLONE_PARAMS clone_params;
11704 CLONE_PARAMS* param = &clone_params;
11705 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11706 /* for each stash, determine whether its objects should be cloned */
11707 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11708 PERL_SET_THX(my_perl);
11711 Poison(my_perl, 1, PerlInterpreter);
11713 PL_curcop = (COP *)Nullop;
11717 PL_savestack_ix = 0;
11718 PL_savestack_max = -1;
11719 PL_sig_pending = 0;
11720 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11721 # else /* !DEBUGGING */
11722 Zero(my_perl, 1, PerlInterpreter);
11723 # endif /* DEBUGGING */
11724 #endif /* PERL_IMPLICIT_SYS */
11725 param->flags = flags;
11726 param->proto_perl = proto_perl;
11729 PL_xnv_arenaroot = NULL;
11730 PL_xnv_root = NULL;
11731 PL_xpv_arenaroot = NULL;
11732 PL_xpv_root = NULL;
11733 PL_xpviv_arenaroot = NULL;
11734 PL_xpviv_root = NULL;
11735 PL_xpvnv_arenaroot = NULL;
11736 PL_xpvnv_root = NULL;
11737 PL_xpvcv_arenaroot = NULL;
11738 PL_xpvcv_root = NULL;
11739 PL_xpvav_arenaroot = NULL;
11740 PL_xpvav_root = NULL;
11741 PL_xpvhv_arenaroot = NULL;
11742 PL_xpvhv_root = NULL;
11743 PL_xpvmg_arenaroot = NULL;
11744 PL_xpvmg_root = NULL;
11745 PL_xpvgv_arenaroot = NULL;
11746 PL_xpvgv_root = NULL;
11747 PL_xpvlv_arenaroot = NULL;
11748 PL_xpvlv_root = NULL;
11749 PL_xpvbm_arenaroot = NULL;
11750 PL_xpvbm_root = NULL;
11751 PL_he_arenaroot = NULL;
11753 #if defined(USE_ITHREADS)
11754 PL_pte_arenaroot = NULL;
11755 PL_pte_root = NULL;
11757 PL_nice_chunk = NULL;
11758 PL_nice_chunk_size = 0;
11760 PL_sv_objcount = 0;
11761 PL_sv_root = Nullsv;
11762 PL_sv_arenaroot = Nullsv;
11764 PL_debug = proto_perl->Idebug;
11766 PL_hash_seed = proto_perl->Ihash_seed;
11767 PL_rehash_seed = proto_perl->Irehash_seed;
11769 #ifdef USE_REENTRANT_API
11770 /* XXX: things like -Dm will segfault here in perlio, but doing
11771 * PERL_SET_CONTEXT(proto_perl);
11772 * breaks too many other things
11774 Perl_reentrant_init(aTHX);
11777 /* create SV map for pointer relocation */
11778 PL_ptr_table = ptr_table_new();
11780 /* initialize these special pointers as early as possible */
11781 SvANY(&PL_sv_undef) = NULL;
11782 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11783 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11784 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11786 SvANY(&PL_sv_no) = new_XPVNV();
11787 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11788 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11789 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11790 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11791 SvCUR_set(&PL_sv_no, 0);
11792 SvLEN_set(&PL_sv_no, 1);
11793 SvIV_set(&PL_sv_no, 0);
11794 SvNV_set(&PL_sv_no, 0);
11795 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11797 SvANY(&PL_sv_yes) = new_XPVNV();
11798 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11799 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11800 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11801 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11802 SvCUR_set(&PL_sv_yes, 1);
11803 SvLEN_set(&PL_sv_yes, 2);
11804 SvIV_set(&PL_sv_yes, 1);
11805 SvNV_set(&PL_sv_yes, 1);
11806 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11808 /* create (a non-shared!) shared string table */
11809 PL_strtab = newHV();
11810 HvSHAREKEYS_off(PL_strtab);
11811 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11812 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11814 PL_compiling = proto_perl->Icompiling;
11816 /* These two PVs will be free'd special way so must set them same way op.c does */
11817 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11818 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11820 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11821 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11823 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11824 if (!specialWARN(PL_compiling.cop_warnings))
11825 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11826 if (!specialCopIO(PL_compiling.cop_io))
11827 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11828 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11830 /* pseudo environmental stuff */
11831 PL_origargc = proto_perl->Iorigargc;
11832 PL_origargv = proto_perl->Iorigargv;
11834 param->stashes = newAV(); /* Setup array of objects to call clone on */
11836 #ifdef PERLIO_LAYERS
11837 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11838 PerlIO_clone(aTHX_ proto_perl, param);
11841 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11842 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11843 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11844 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11845 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11846 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11849 PL_minus_c = proto_perl->Iminus_c;
11850 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11851 PL_localpatches = proto_perl->Ilocalpatches;
11852 PL_splitstr = proto_perl->Isplitstr;
11853 PL_preprocess = proto_perl->Ipreprocess;
11854 PL_minus_n = proto_perl->Iminus_n;
11855 PL_minus_p = proto_perl->Iminus_p;
11856 PL_minus_l = proto_perl->Iminus_l;
11857 PL_minus_a = proto_perl->Iminus_a;
11858 PL_minus_F = proto_perl->Iminus_F;
11859 PL_doswitches = proto_perl->Idoswitches;
11860 PL_dowarn = proto_perl->Idowarn;
11861 PL_doextract = proto_perl->Idoextract;
11862 PL_sawampersand = proto_perl->Isawampersand;
11863 PL_unsafe = proto_perl->Iunsafe;
11864 PL_inplace = SAVEPV(proto_perl->Iinplace);
11865 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11866 PL_perldb = proto_perl->Iperldb;
11867 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11868 PL_exit_flags = proto_perl->Iexit_flags;
11870 /* magical thingies */
11871 /* XXX time(&PL_basetime) when asked for? */
11872 PL_basetime = proto_perl->Ibasetime;
11873 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11875 PL_maxsysfd = proto_perl->Imaxsysfd;
11876 PL_multiline = proto_perl->Imultiline;
11877 PL_statusvalue = proto_perl->Istatusvalue;
11879 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11881 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11883 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11884 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11885 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11887 /* Clone the regex array */
11888 PL_regex_padav = newAV();
11890 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11891 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11893 av_push(PL_regex_padav,
11894 sv_dup_inc(regexen[0],param));
11895 for(i = 1; i <= len; i++) {
11896 if(SvREPADTMP(regexen[i])) {
11897 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11899 av_push(PL_regex_padav,
11901 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11902 SvIVX(regexen[i])), param)))
11907 PL_regex_pad = AvARRAY(PL_regex_padav);
11909 /* shortcuts to various I/O objects */
11910 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11911 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11912 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11913 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11914 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11915 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11917 /* shortcuts to regexp stuff */
11918 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11920 /* shortcuts to misc objects */
11921 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11923 /* shortcuts to debugging objects */
11924 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11925 PL_DBline = gv_dup(proto_perl->IDBline, param);
11926 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11927 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11928 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11929 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11930 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11931 PL_lineary = av_dup(proto_perl->Ilineary, param);
11932 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11934 /* symbol tables */
11935 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11936 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11937 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11938 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11939 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11941 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11942 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11943 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11944 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11945 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11946 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11948 PL_sub_generation = proto_perl->Isub_generation;
11950 /* funky return mechanisms */
11951 PL_forkprocess = proto_perl->Iforkprocess;
11953 /* subprocess state */
11954 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11956 /* internal state */
11957 PL_tainting = proto_perl->Itainting;
11958 PL_taint_warn = proto_perl->Itaint_warn;
11959 PL_maxo = proto_perl->Imaxo;
11960 if (proto_perl->Iop_mask)
11961 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11963 PL_op_mask = Nullch;
11964 /* PL_asserting = proto_perl->Iasserting; */
11966 /* current interpreter roots */
11967 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11968 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11969 PL_main_start = proto_perl->Imain_start;
11970 PL_eval_root = proto_perl->Ieval_root;
11971 PL_eval_start = proto_perl->Ieval_start;
11973 /* runtime control stuff */
11974 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11975 PL_copline = proto_perl->Icopline;
11977 PL_filemode = proto_perl->Ifilemode;
11978 PL_lastfd = proto_perl->Ilastfd;
11979 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11982 PL_gensym = proto_perl->Igensym;
11983 PL_preambled = proto_perl->Ipreambled;
11984 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11985 PL_laststatval = proto_perl->Ilaststatval;
11986 PL_laststype = proto_perl->Ilaststype;
11987 PL_mess_sv = Nullsv;
11989 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11990 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11992 /* interpreter atexit processing */
11993 PL_exitlistlen = proto_perl->Iexitlistlen;
11994 if (PL_exitlistlen) {
11995 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11996 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11999 PL_exitlist = (PerlExitListEntry*)NULL;
12000 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
12001 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
12002 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12004 PL_profiledata = NULL;
12005 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
12006 /* PL_rsfp_filters entries have fake IoDIRP() */
12007 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
12009 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12011 PAD_CLONE_VARS(proto_perl, param);
12013 #ifdef HAVE_INTERP_INTERN
12014 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12017 /* more statics moved here */
12018 PL_generation = proto_perl->Igeneration;
12019 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12021 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12022 PL_in_clean_all = proto_perl->Iin_clean_all;
12024 PL_uid = proto_perl->Iuid;
12025 PL_euid = proto_perl->Ieuid;
12026 PL_gid = proto_perl->Igid;
12027 PL_egid = proto_perl->Iegid;
12028 PL_nomemok = proto_perl->Inomemok;
12029 PL_an = proto_perl->Ian;
12030 PL_evalseq = proto_perl->Ievalseq;
12031 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12032 PL_origalen = proto_perl->Iorigalen;
12033 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12034 PL_osname = SAVEPV(proto_perl->Iosname);
12035 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12036 PL_sighandlerp = proto_perl->Isighandlerp;
12039 PL_runops = proto_perl->Irunops;
12041 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12044 PL_cshlen = proto_perl->Icshlen;
12045 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12048 PL_lex_state = proto_perl->Ilex_state;
12049 PL_lex_defer = proto_perl->Ilex_defer;
12050 PL_lex_expect = proto_perl->Ilex_expect;
12051 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12052 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12053 PL_lex_starts = proto_perl->Ilex_starts;
12054 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12055 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12056 PL_lex_op = proto_perl->Ilex_op;
12057 PL_lex_inpat = proto_perl->Ilex_inpat;
12058 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12059 PL_lex_brackets = proto_perl->Ilex_brackets;
12060 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12061 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12062 PL_lex_casemods = proto_perl->Ilex_casemods;
12063 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12064 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12066 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12067 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12068 PL_nexttoke = proto_perl->Inexttoke;
12070 /* XXX This is probably masking the deeper issue of why
12071 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12072 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12073 * (A little debugging with a watchpoint on it may help.)
12075 if (SvANY(proto_perl->Ilinestr)) {
12076 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12077 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12078 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12079 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12080 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12081 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12082 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12083 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12084 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12087 PL_linestr = NEWSV(65,79);
12088 sv_upgrade(PL_linestr,SVt_PVIV);
12089 sv_setpvn(PL_linestr,"",0);
12090 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12092 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12093 PL_pending_ident = proto_perl->Ipending_ident;
12094 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12096 PL_expect = proto_perl->Iexpect;
12098 PL_multi_start = proto_perl->Imulti_start;
12099 PL_multi_end = proto_perl->Imulti_end;
12100 PL_multi_open = proto_perl->Imulti_open;
12101 PL_multi_close = proto_perl->Imulti_close;
12103 PL_error_count = proto_perl->Ierror_count;
12104 PL_subline = proto_perl->Isubline;
12105 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12107 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12108 if (SvANY(proto_perl->Ilinestr)) {
12109 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12110 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12111 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12112 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12113 PL_last_lop_op = proto_perl->Ilast_lop_op;
12116 PL_last_uni = SvPVX(PL_linestr);
12117 PL_last_lop = SvPVX(PL_linestr);
12118 PL_last_lop_op = 0;
12120 PL_in_my = proto_perl->Iin_my;
12121 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12123 PL_cryptseen = proto_perl->Icryptseen;
12126 PL_hints = proto_perl->Ihints;
12128 PL_amagic_generation = proto_perl->Iamagic_generation;
12130 #ifdef USE_LOCALE_COLLATE
12131 PL_collation_ix = proto_perl->Icollation_ix;
12132 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12133 PL_collation_standard = proto_perl->Icollation_standard;
12134 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12135 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12136 #endif /* USE_LOCALE_COLLATE */
12138 #ifdef USE_LOCALE_NUMERIC
12139 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12140 PL_numeric_standard = proto_perl->Inumeric_standard;
12141 PL_numeric_local = proto_perl->Inumeric_local;
12142 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12143 #endif /* !USE_LOCALE_NUMERIC */
12145 /* utf8 character classes */
12146 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12147 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12148 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12149 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12150 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12151 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12152 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12153 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12154 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12155 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12156 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12157 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12158 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12159 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12160 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12161 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12162 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12163 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12164 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12165 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12167 /* Did the locale setup indicate UTF-8? */
12168 PL_utf8locale = proto_perl->Iutf8locale;
12169 /* Unicode features (see perlrun/-C) */
12170 PL_unicode = proto_perl->Iunicode;
12172 /* Pre-5.8 signals control */
12173 PL_signals = proto_perl->Isignals;
12175 /* times() ticks per second */
12176 PL_clocktick = proto_perl->Iclocktick;
12178 /* Recursion stopper for PerlIO_find_layer */
12179 PL_in_load_module = proto_perl->Iin_load_module;
12181 /* sort() routine */
12182 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12184 /* Not really needed/useful since the reenrant_retint is "volatile",
12185 * but do it for consistency's sake. */
12186 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12188 /* Hooks to shared SVs and locks. */
12189 PL_sharehook = proto_perl->Isharehook;
12190 PL_lockhook = proto_perl->Ilockhook;
12191 PL_unlockhook = proto_perl->Iunlockhook;
12192 PL_threadhook = proto_perl->Ithreadhook;
12194 PL_runops_std = proto_perl->Irunops_std;
12195 PL_runops_dbg = proto_perl->Irunops_dbg;
12197 #ifdef THREADS_HAVE_PIDS
12198 PL_ppid = proto_perl->Ippid;
12202 PL_last_swash_hv = Nullhv; /* reinits on demand */
12203 PL_last_swash_klen = 0;
12204 PL_last_swash_key[0]= '\0';
12205 PL_last_swash_tmps = (U8*)NULL;
12206 PL_last_swash_slen = 0;
12208 PL_glob_index = proto_perl->Iglob_index;
12209 PL_srand_called = proto_perl->Isrand_called;
12210 PL_uudmap['M'] = 0; /* reinits on demand */
12211 PL_bitcount = Nullch; /* reinits on demand */
12213 if (proto_perl->Ipsig_pend) {
12214 Newz(0, PL_psig_pend, SIG_SIZE, int);
12217 PL_psig_pend = (int*)NULL;
12220 if (proto_perl->Ipsig_ptr) {
12221 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12222 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12223 for (i = 1; i < SIG_SIZE; i++) {
12224 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12225 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12229 PL_psig_ptr = (SV**)NULL;
12230 PL_psig_name = (SV**)NULL;
12233 /* thrdvar.h stuff */
12235 if (flags & CLONEf_COPY_STACKS) {
12236 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12237 PL_tmps_ix = proto_perl->Ttmps_ix;
12238 PL_tmps_max = proto_perl->Ttmps_max;
12239 PL_tmps_floor = proto_perl->Ttmps_floor;
12240 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12242 while (i <= PL_tmps_ix) {
12243 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12247 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12248 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12249 Newz(54, PL_markstack, i, I32);
12250 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12251 - proto_perl->Tmarkstack);
12252 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12253 - proto_perl->Tmarkstack);
12254 Copy(proto_perl->Tmarkstack, PL_markstack,
12255 PL_markstack_ptr - PL_markstack + 1, I32);
12257 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12258 * NOTE: unlike the others! */
12259 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12260 PL_scopestack_max = proto_perl->Tscopestack_max;
12261 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12262 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12264 /* NOTE: si_dup() looks at PL_markstack */
12265 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12267 /* PL_curstack = PL_curstackinfo->si_stack; */
12268 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12269 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12271 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12272 PL_stack_base = AvARRAY(PL_curstack);
12273 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12274 - proto_perl->Tstack_base);
12275 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12277 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12278 * NOTE: unlike the others! */
12279 PL_savestack_ix = proto_perl->Tsavestack_ix;
12280 PL_savestack_max = proto_perl->Tsavestack_max;
12281 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12282 PL_savestack = ss_dup(proto_perl, param);
12286 ENTER; /* perl_destruct() wants to LEAVE; */
12289 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12290 PL_top_env = &PL_start_env;
12292 PL_op = proto_perl->Top;
12295 PL_Xpv = (XPV*)NULL;
12296 PL_na = proto_perl->Tna;
12298 PL_statbuf = proto_perl->Tstatbuf;
12299 PL_statcache = proto_perl->Tstatcache;
12300 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12301 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12303 PL_timesbuf = proto_perl->Ttimesbuf;
12306 PL_tainted = proto_perl->Ttainted;
12307 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12308 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12309 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12310 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12311 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12312 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12313 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12314 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12315 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12317 PL_restartop = proto_perl->Trestartop;
12318 PL_in_eval = proto_perl->Tin_eval;
12319 PL_delaymagic = proto_perl->Tdelaymagic;
12320 PL_dirty = proto_perl->Tdirty;
12321 PL_localizing = proto_perl->Tlocalizing;
12323 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12324 PL_hv_fetch_ent_mh = Nullhe;
12325 PL_modcount = proto_perl->Tmodcount;
12326 PL_lastgotoprobe = Nullop;
12327 PL_dumpindent = proto_perl->Tdumpindent;
12329 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12330 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12331 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12332 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12333 PL_sortcxix = proto_perl->Tsortcxix;
12334 PL_efloatbuf = Nullch; /* reinits on demand */
12335 PL_efloatsize = 0; /* reinits on demand */
12339 PL_screamfirst = NULL;
12340 PL_screamnext = NULL;
12341 PL_maxscream = -1; /* reinits on demand */
12342 PL_lastscream = Nullsv;
12344 PL_watchaddr = NULL;
12345 PL_watchok = Nullch;
12347 PL_regdummy = proto_perl->Tregdummy;
12348 PL_regprecomp = Nullch;
12351 PL_colorset = 0; /* reinits PL_colors[] */
12352 /*PL_colors[6] = {0,0,0,0,0,0};*/
12353 PL_reginput = Nullch;
12354 PL_regbol = Nullch;
12355 PL_regeol = Nullch;
12356 PL_regstartp = (I32*)NULL;
12357 PL_regendp = (I32*)NULL;
12358 PL_reglastparen = (U32*)NULL;
12359 PL_reglastcloseparen = (U32*)NULL;
12360 PL_regtill = Nullch;
12361 PL_reg_start_tmp = (char**)NULL;
12362 PL_reg_start_tmpl = 0;
12363 PL_regdata = (struct reg_data*)NULL;
12366 PL_reg_eval_set = 0;
12368 PL_regprogram = (regnode*)NULL;
12370 PL_regcc = (CURCUR*)NULL;
12371 PL_reg_call_cc = (struct re_cc_state*)NULL;
12372 PL_reg_re = (regexp*)NULL;
12373 PL_reg_ganch = Nullch;
12374 PL_reg_sv = Nullsv;
12375 PL_reg_match_utf8 = FALSE;
12376 PL_reg_magic = (MAGIC*)NULL;
12378 PL_reg_oldcurpm = (PMOP*)NULL;
12379 PL_reg_curpm = (PMOP*)NULL;
12380 PL_reg_oldsaved = Nullch;
12381 PL_reg_oldsavedlen = 0;
12382 #ifdef PERL_OLD_COPY_ON_WRITE
12385 PL_reg_maxiter = 0;
12386 PL_reg_leftiter = 0;
12387 PL_reg_poscache = Nullch;
12388 PL_reg_poscache_size= 0;
12390 /* RE engine - function pointers */
12391 PL_regcompp = proto_perl->Tregcompp;
12392 PL_regexecp = proto_perl->Tregexecp;
12393 PL_regint_start = proto_perl->Tregint_start;
12394 PL_regint_string = proto_perl->Tregint_string;
12395 PL_regfree = proto_perl->Tregfree;
12397 PL_reginterp_cnt = 0;
12398 PL_reg_starttry = 0;
12400 /* Pluggable optimizer */
12401 PL_peepp = proto_perl->Tpeepp;
12403 PL_stashcache = newHV();
12405 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12406 ptr_table_free(PL_ptr_table);
12407 PL_ptr_table = NULL;
12410 /* Call the ->CLONE method, if it exists, for each of the stashes
12411 identified by sv_dup() above.
12413 while(av_len(param->stashes) != -1) {
12414 HV* stash = (HV*) av_shift(param->stashes);
12415 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12416 if (cloner && GvCV(cloner)) {
12421 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12423 call_sv((SV*)GvCV(cloner), G_DISCARD);
12429 SvREFCNT_dec(param->stashes);
12431 /* orphaned? eg threads->new inside BEGIN or use */
12432 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12433 (void)SvREFCNT_inc(PL_compcv);
12434 SAVEFREESV(PL_compcv);
12440 #endif /* USE_ITHREADS */
12443 =head1 Unicode Support
12445 =for apidoc sv_recode_to_utf8
12447 The encoding is assumed to be an Encode object, on entry the PV
12448 of the sv is assumed to be octets in that encoding, and the sv
12449 will be converted into Unicode (and UTF-8).
12451 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12452 is not a reference, nothing is done to the sv. If the encoding is not
12453 an C<Encode::XS> Encoding object, bad things will happen.
12454 (See F<lib/encoding.pm> and L<Encode>).
12456 The PV of the sv is returned.
12461 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12464 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12478 Passing sv_yes is wrong - it needs to be or'ed set of constants
12479 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12480 remove converted chars from source.
12482 Both will default the value - let them.
12484 XPUSHs(&PL_sv_yes);
12487 call_method("decode", G_SCALAR);
12491 s = SvPV_const(uni, len);
12492 if (s != SvPVX_const(sv)) {
12493 SvGROW(sv, len + 1);
12494 Move(s, SvPVX(sv), len + 1, char);
12495 SvCUR_set(sv, len);
12502 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12506 =for apidoc sv_cat_decode
12508 The encoding is assumed to be an Encode object, the PV of the ssv is
12509 assumed to be octets in that encoding and decoding the input starts
12510 from the position which (PV + *offset) pointed to. The dsv will be
12511 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12512 when the string tstr appears in decoding output or the input ends on
12513 the PV of the ssv. The value which the offset points will be modified
12514 to the last input position on the ssv.
12516 Returns TRUE if the terminator was found, else returns FALSE.
12521 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12522 SV *ssv, int *offset, char *tstr, int tlen)
12526 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12537 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12538 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12540 call_method("cat_decode", G_SCALAR);
12542 ret = SvTRUE(TOPs);
12543 *offset = SvIV(offsv);
12549 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12555 * c-indentation-style: bsd
12556 * c-basic-offset: 4
12557 * indent-tabs-mode: t
12560 * ex: set ts=8 sts=4 sw=4 noet: