3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
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 */
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(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);
2029 else if (SvOOK(sv)) { /* pv is offset? */
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(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 */
2252 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2254 if (ch & 128 && !isPRINT_LC(ch)) {
2263 else if (ch == '\r') {
2267 else if (ch == '\f') {
2271 else if (ch == '\\') {
2275 else if (ch == '\0') {
2279 else if (isPRINT_LC(ch))
2296 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2297 "Argument \"%s\" isn't numeric in %s", pv,
2300 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2301 "Argument \"%s\" isn't numeric", pv);
2305 =for apidoc looks_like_number
2307 Test if the content of an SV looks like a number (or is a number).
2308 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2309 non-numeric warning), even if your atof() doesn't grok them.
2315 Perl_looks_like_number(pTHX_ SV *sv)
2317 register const char *sbegin;
2321 sbegin = SvPVX_const(sv);
2324 else if (SvPOKp(sv))
2325 sbegin = SvPV(sv, len);
2327 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2328 return grok_number(sbegin, len, NULL);
2331 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2332 until proven guilty, assume that things are not that bad... */
2337 As 64 bit platforms often have an NV that doesn't preserve all bits of
2338 an IV (an assumption perl has been based on to date) it becomes necessary
2339 to remove the assumption that the NV always carries enough precision to
2340 recreate the IV whenever needed, and that the NV is the canonical form.
2341 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2342 precision as a side effect of conversion (which would lead to insanity
2343 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2344 1) to distinguish between IV/UV/NV slots that have cached a valid
2345 conversion where precision was lost and IV/UV/NV slots that have a
2346 valid conversion which has lost no precision
2347 2) to ensure that if a numeric conversion to one form is requested that
2348 would lose precision, the precise conversion (or differently
2349 imprecise conversion) is also performed and cached, to prevent
2350 requests for different numeric formats on the same SV causing
2351 lossy conversion chains. (lossless conversion chains are perfectly
2356 SvIOKp is true if the IV slot contains a valid value
2357 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2358 SvNOKp is true if the NV slot contains a valid value
2359 SvNOK is true only if the NV value is accurate
2362 while converting from PV to NV, check to see if converting that NV to an
2363 IV(or UV) would lose accuracy over a direct conversion from PV to
2364 IV(or UV). If it would, cache both conversions, return NV, but mark
2365 SV as IOK NOKp (ie not NOK).
2367 While converting from PV to IV, check to see if converting that IV to an
2368 NV would lose accuracy over a direct conversion from PV to NV. If it
2369 would, cache both conversions, flag similarly.
2371 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2372 correctly because if IV & NV were set NV *always* overruled.
2373 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2374 changes - now IV and NV together means that the two are interchangeable:
2375 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2377 The benefit of this is that operations such as pp_add know that if
2378 SvIOK is true for both left and right operands, then integer addition
2379 can be used instead of floating point (for cases where the result won't
2380 overflow). Before, floating point was always used, which could lead to
2381 loss of precision compared with integer addition.
2383 * making IV and NV equal status should make maths accurate on 64 bit
2385 * may speed up maths somewhat if pp_add and friends start to use
2386 integers when possible instead of fp. (Hopefully the overhead in
2387 looking for SvIOK and checking for overflow will not outweigh the
2388 fp to integer speedup)
2389 * will slow down integer operations (callers of SvIV) on "inaccurate"
2390 values, as the change from SvIOK to SvIOKp will cause a call into
2391 sv_2iv each time rather than a macro access direct to the IV slot
2392 * should speed up number->string conversion on integers as IV is
2393 favoured when IV and NV are equally accurate
2395 ####################################################################
2396 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2397 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2398 On the other hand, SvUOK is true iff UV.
2399 ####################################################################
2401 Your mileage will vary depending your CPU's relative fp to integer
2405 #ifndef NV_PRESERVES_UV
2406 # define IS_NUMBER_UNDERFLOW_IV 1
2407 # define IS_NUMBER_UNDERFLOW_UV 2
2408 # define IS_NUMBER_IV_AND_UV 2
2409 # define IS_NUMBER_OVERFLOW_IV 4
2410 # define IS_NUMBER_OVERFLOW_UV 5
2412 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2414 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2416 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2418 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));
2419 if (SvNVX(sv) < (NV)IV_MIN) {
2420 (void)SvIOKp_on(sv);
2422 SvIV_set(sv, IV_MIN);
2423 return IS_NUMBER_UNDERFLOW_IV;
2425 if (SvNVX(sv) > (NV)UV_MAX) {
2426 (void)SvIOKp_on(sv);
2429 SvUV_set(sv, UV_MAX);
2430 return IS_NUMBER_OVERFLOW_UV;
2432 (void)SvIOKp_on(sv);
2434 /* Can't use strtol etc to convert this string. (See truth table in
2436 if (SvNVX(sv) <= (UV)IV_MAX) {
2437 SvIV_set(sv, I_V(SvNVX(sv)));
2438 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2439 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2441 /* Integer is imprecise. NOK, IOKp */
2443 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2446 SvUV_set(sv, U_V(SvNVX(sv)));
2447 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2448 if (SvUVX(sv) == UV_MAX) {
2449 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2450 possibly be preserved by NV. Hence, it must be overflow.
2452 return IS_NUMBER_OVERFLOW_UV;
2454 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2456 /* Integer is imprecise. NOK, IOKp */
2458 return IS_NUMBER_OVERFLOW_IV;
2460 #endif /* !NV_PRESERVES_UV*/
2462 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2463 * this function provided for binary compatibility only
2467 Perl_sv_2iv(pTHX_ register SV *sv)
2469 return sv_2iv_flags(sv, SV_GMAGIC);
2473 =for apidoc sv_2iv_flags
2475 Return the integer value of an SV, doing any necessary string
2476 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2477 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2483 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2487 if (SvGMAGICAL(sv)) {
2488 if (flags & SV_GMAGIC)
2493 return I_V(SvNVX(sv));
2495 if (SvPOKp(sv) && SvLEN(sv))
2498 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2499 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2505 if (SvTHINKFIRST(sv)) {
2508 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2509 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2510 return SvIV(tmpstr);
2511 return PTR2IV(SvRV(sv));
2514 sv_force_normal_flags(sv, 0);
2516 if (SvREADONLY(sv) && !SvOK(sv)) {
2517 if (ckWARN(WARN_UNINITIALIZED))
2524 return (IV)(SvUVX(sv));
2531 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2532 * without also getting a cached IV/UV from it at the same time
2533 * (ie PV->NV conversion should detect loss of accuracy and cache
2534 * IV or UV at same time to avoid this. NWC */
2536 if (SvTYPE(sv) == SVt_NV)
2537 sv_upgrade(sv, SVt_PVNV);
2539 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2540 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2541 certainly cast into the IV range at IV_MAX, whereas the correct
2542 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2544 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2545 SvIV_set(sv, I_V(SvNVX(sv)));
2546 if (SvNVX(sv) == (NV) SvIVX(sv)
2547 #ifndef NV_PRESERVES_UV
2548 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2549 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2550 /* Don't flag it as "accurately an integer" if the number
2551 came from a (by definition imprecise) NV operation, and
2552 we're outside the range of NV integer precision */
2555 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2556 DEBUG_c(PerlIO_printf(Perl_debug_log,
2557 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2563 /* IV not precise. No need to convert from PV, as NV
2564 conversion would already have cached IV if it detected
2565 that PV->IV would be better than PV->NV->IV
2566 flags already correct - don't set public IOK. */
2567 DEBUG_c(PerlIO_printf(Perl_debug_log,
2568 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2573 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2574 but the cast (NV)IV_MIN rounds to a the value less (more
2575 negative) than IV_MIN which happens to be equal to SvNVX ??
2576 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2577 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2578 (NV)UVX == NVX are both true, but the values differ. :-(
2579 Hopefully for 2s complement IV_MIN is something like
2580 0x8000000000000000 which will be exact. NWC */
2583 SvUV_set(sv, U_V(SvNVX(sv)));
2585 (SvNVX(sv) == (NV) SvUVX(sv))
2586 #ifndef NV_PRESERVES_UV
2587 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2588 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2589 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2590 /* Don't flag it as "accurately an integer" if the number
2591 came from a (by definition imprecise) NV operation, and
2592 we're outside the range of NV integer precision */
2598 DEBUG_c(PerlIO_printf(Perl_debug_log,
2599 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2603 return (IV)SvUVX(sv);
2606 else if (SvPOKp(sv) && SvLEN(sv)) {
2608 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2609 /* We want to avoid a possible problem when we cache an IV which
2610 may be later translated to an NV, and the resulting NV is not
2611 the same as the direct translation of the initial string
2612 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2613 be careful to ensure that the value with the .456 is around if the
2614 NV value is requested in the future).
2616 This means that if we cache such an IV, we need to cache the
2617 NV as well. Moreover, we trade speed for space, and do not
2618 cache the NV if we are sure it's not needed.
2621 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2622 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2623 == IS_NUMBER_IN_UV) {
2624 /* It's definitely an integer, only upgrade to PVIV */
2625 if (SvTYPE(sv) < SVt_PVIV)
2626 sv_upgrade(sv, SVt_PVIV);
2628 } else if (SvTYPE(sv) < SVt_PVNV)
2629 sv_upgrade(sv, SVt_PVNV);
2631 /* If NV preserves UV then we only use the UV value if we know that
2632 we aren't going to call atof() below. If NVs don't preserve UVs
2633 then the value returned may have more precision than atof() will
2634 return, even though value isn't perfectly accurate. */
2635 if ((numtype & (IS_NUMBER_IN_UV
2636 #ifdef NV_PRESERVES_UV
2639 )) == IS_NUMBER_IN_UV) {
2640 /* This won't turn off the public IOK flag if it was set above */
2641 (void)SvIOKp_on(sv);
2643 if (!(numtype & IS_NUMBER_NEG)) {
2645 if (value <= (UV)IV_MAX) {
2646 SvIV_set(sv, (IV)value);
2648 SvUV_set(sv, value);
2652 /* 2s complement assumption */
2653 if (value <= (UV)IV_MIN) {
2654 SvIV_set(sv, -(IV)value);
2656 /* Too negative for an IV. This is a double upgrade, but
2657 I'm assuming it will be rare. */
2658 if (SvTYPE(sv) < SVt_PVNV)
2659 sv_upgrade(sv, SVt_PVNV);
2663 SvNV_set(sv, -(NV)value);
2664 SvIV_set(sv, IV_MIN);
2668 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2669 will be in the previous block to set the IV slot, and the next
2670 block to set the NV slot. So no else here. */
2672 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2673 != IS_NUMBER_IN_UV) {
2674 /* It wasn't an (integer that doesn't overflow the UV). */
2675 SvNV_set(sv, Atof(SvPVX_const(sv)));
2677 if (! numtype && ckWARN(WARN_NUMERIC))
2680 #if defined(USE_LONG_DOUBLE)
2681 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2682 PTR2UV(sv), SvNVX(sv)));
2684 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2685 PTR2UV(sv), SvNVX(sv)));
2689 #ifdef NV_PRESERVES_UV
2690 (void)SvIOKp_on(sv);
2692 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2693 SvIV_set(sv, I_V(SvNVX(sv)));
2694 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2697 /* Integer is imprecise. NOK, IOKp */
2699 /* UV will not work better than IV */
2701 if (SvNVX(sv) > (NV)UV_MAX) {
2703 /* Integer is inaccurate. NOK, IOKp, is UV */
2704 SvUV_set(sv, UV_MAX);
2707 SvUV_set(sv, U_V(SvNVX(sv)));
2708 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2709 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2713 /* Integer is imprecise. NOK, IOKp, is UV */
2719 #else /* NV_PRESERVES_UV */
2720 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2721 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2722 /* The IV slot will have been set from value returned by
2723 grok_number above. The NV slot has just been set using
2726 assert (SvIOKp(sv));
2728 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2729 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2730 /* Small enough to preserve all bits. */
2731 (void)SvIOKp_on(sv);
2733 SvIV_set(sv, I_V(SvNVX(sv)));
2734 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2736 /* Assumption: first non-preserved integer is < IV_MAX,
2737 this NV is in the preserved range, therefore: */
2738 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2740 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);
2744 0 0 already failed to read UV.
2745 0 1 already failed to read UV.
2746 1 0 you won't get here in this case. IV/UV
2747 slot set, public IOK, Atof() unneeded.
2748 1 1 already read UV.
2749 so there's no point in sv_2iuv_non_preserve() attempting
2750 to use atol, strtol, strtoul etc. */
2751 if (sv_2iuv_non_preserve (sv, numtype)
2752 >= IS_NUMBER_OVERFLOW_IV)
2756 #endif /* NV_PRESERVES_UV */
2759 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2761 if (SvTYPE(sv) < SVt_IV)
2762 /* Typically the caller expects that sv_any is not NULL now. */
2763 sv_upgrade(sv, SVt_IV);
2766 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2767 PTR2UV(sv),SvIVX(sv)));
2768 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2771 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2772 * this function provided for binary compatibility only
2776 Perl_sv_2uv(pTHX_ register SV *sv)
2778 return sv_2uv_flags(sv, SV_GMAGIC);
2782 =for apidoc sv_2uv_flags
2784 Return the unsigned integer value of an SV, doing any necessary string
2785 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2786 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2792 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2796 if (SvGMAGICAL(sv)) {
2797 if (flags & SV_GMAGIC)
2802 return U_V(SvNVX(sv));
2803 if (SvPOKp(sv) && SvLEN(sv))
2806 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2807 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2813 if (SvTHINKFIRST(sv)) {
2816 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2817 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2818 return SvUV(tmpstr);
2819 return PTR2UV(SvRV(sv));
2822 sv_force_normal_flags(sv, 0);
2824 if (SvREADONLY(sv) && !SvOK(sv)) {
2825 if (ckWARN(WARN_UNINITIALIZED))
2835 return (UV)SvIVX(sv);
2839 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2840 * without also getting a cached IV/UV from it at the same time
2841 * (ie PV->NV conversion should detect loss of accuracy and cache
2842 * IV or UV at same time to avoid this. */
2843 /* IV-over-UV optimisation - choose to cache IV if possible */
2845 if (SvTYPE(sv) == SVt_NV)
2846 sv_upgrade(sv, SVt_PVNV);
2848 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2849 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2850 SvIV_set(sv, I_V(SvNVX(sv)));
2851 if (SvNVX(sv) == (NV) SvIVX(sv)
2852 #ifndef NV_PRESERVES_UV
2853 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2854 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2855 /* Don't flag it as "accurately an integer" if the number
2856 came from a (by definition imprecise) NV operation, and
2857 we're outside the range of NV integer precision */
2860 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2861 DEBUG_c(PerlIO_printf(Perl_debug_log,
2862 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2868 /* IV not precise. No need to convert from PV, as NV
2869 conversion would already have cached IV if it detected
2870 that PV->IV would be better than PV->NV->IV
2871 flags already correct - don't set public IOK. */
2872 DEBUG_c(PerlIO_printf(Perl_debug_log,
2873 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2878 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2879 but the cast (NV)IV_MIN rounds to a the value less (more
2880 negative) than IV_MIN which happens to be equal to SvNVX ??
2881 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2882 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2883 (NV)UVX == NVX are both true, but the values differ. :-(
2884 Hopefully for 2s complement IV_MIN is something like
2885 0x8000000000000000 which will be exact. NWC */
2888 SvUV_set(sv, U_V(SvNVX(sv)));
2890 (SvNVX(sv) == (NV) SvUVX(sv))
2891 #ifndef NV_PRESERVES_UV
2892 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2893 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2894 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2895 /* Don't flag it as "accurately an integer" if the number
2896 came from a (by definition imprecise) NV operation, and
2897 we're outside the range of NV integer precision */
2902 DEBUG_c(PerlIO_printf(Perl_debug_log,
2903 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2909 else if (SvPOKp(sv) && SvLEN(sv)) {
2911 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2913 /* We want to avoid a possible problem when we cache a UV which
2914 may be later translated to an NV, and the resulting NV is not
2915 the translation of the initial data.
2917 This means that if we cache such a UV, we need to cache the
2918 NV as well. Moreover, we trade speed for space, and do not
2919 cache the NV if not needed.
2922 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2923 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2924 == IS_NUMBER_IN_UV) {
2925 /* It's definitely an integer, only upgrade to PVIV */
2926 if (SvTYPE(sv) < SVt_PVIV)
2927 sv_upgrade(sv, SVt_PVIV);
2929 } else if (SvTYPE(sv) < SVt_PVNV)
2930 sv_upgrade(sv, SVt_PVNV);
2932 /* If NV preserves UV then we only use the UV value if we know that
2933 we aren't going to call atof() below. If NVs don't preserve UVs
2934 then the value returned may have more precision than atof() will
2935 return, even though it isn't accurate. */
2936 if ((numtype & (IS_NUMBER_IN_UV
2937 #ifdef NV_PRESERVES_UV
2940 )) == IS_NUMBER_IN_UV) {
2941 /* This won't turn off the public IOK flag if it was set above */
2942 (void)SvIOKp_on(sv);
2944 if (!(numtype & IS_NUMBER_NEG)) {
2946 if (value <= (UV)IV_MAX) {
2947 SvIV_set(sv, (IV)value);
2949 /* it didn't overflow, and it was positive. */
2950 SvUV_set(sv, value);
2954 /* 2s complement assumption */
2955 if (value <= (UV)IV_MIN) {
2956 SvIV_set(sv, -(IV)value);
2958 /* Too negative for an IV. This is a double upgrade, but
2959 I'm assuming it will be rare. */
2960 if (SvTYPE(sv) < SVt_PVNV)
2961 sv_upgrade(sv, SVt_PVNV);
2965 SvNV_set(sv, -(NV)value);
2966 SvIV_set(sv, IV_MIN);
2971 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2972 != IS_NUMBER_IN_UV) {
2973 /* It wasn't an integer, or it overflowed the UV. */
2974 SvNV_set(sv, Atof(SvPVX_const(sv)));
2976 if (! numtype && ckWARN(WARN_NUMERIC))
2979 #if defined(USE_LONG_DOUBLE)
2980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2981 PTR2UV(sv), SvNVX(sv)));
2983 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2984 PTR2UV(sv), SvNVX(sv)));
2987 #ifdef NV_PRESERVES_UV
2988 (void)SvIOKp_on(sv);
2990 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2991 SvIV_set(sv, I_V(SvNVX(sv)));
2992 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2995 /* Integer is imprecise. NOK, IOKp */
2997 /* UV will not work better than IV */
2999 if (SvNVX(sv) > (NV)UV_MAX) {
3001 /* Integer is inaccurate. NOK, IOKp, is UV */
3002 SvUV_set(sv, UV_MAX);
3005 SvUV_set(sv, U_V(SvNVX(sv)));
3006 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3007 NV preservse UV so can do correct comparison. */
3008 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3012 /* Integer is imprecise. NOK, IOKp, is UV */
3017 #else /* NV_PRESERVES_UV */
3018 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3019 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3020 /* The UV slot will have been set from value returned by
3021 grok_number above. The NV slot has just been set using
3024 assert (SvIOKp(sv));
3026 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3027 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3028 /* Small enough to preserve all bits. */
3029 (void)SvIOKp_on(sv);
3031 SvIV_set(sv, I_V(SvNVX(sv)));
3032 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3034 /* Assumption: first non-preserved integer is < IV_MAX,
3035 this NV is in the preserved range, therefore: */
3036 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3038 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);
3041 sv_2iuv_non_preserve (sv, numtype);
3043 #endif /* NV_PRESERVES_UV */
3047 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3048 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3051 if (SvTYPE(sv) < SVt_IV)
3052 /* Typically the caller expects that sv_any is not NULL now. */
3053 sv_upgrade(sv, SVt_IV);
3057 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3058 PTR2UV(sv),SvUVX(sv)));
3059 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3065 Return the num value of an SV, doing any necessary string or integer
3066 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3073 Perl_sv_2nv(pTHX_ register SV *sv)
3077 if (SvGMAGICAL(sv)) {
3081 if (SvPOKp(sv) && SvLEN(sv)) {
3082 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3083 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3085 return Atof(SvPVX_const(sv));
3089 return (NV)SvUVX(sv);
3091 return (NV)SvIVX(sv);
3094 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3095 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3101 if (SvTHINKFIRST(sv)) {
3104 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3105 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3106 return SvNV(tmpstr);
3107 return PTR2NV(SvRV(sv));
3110 sv_force_normal_flags(sv, 0);
3112 if (SvREADONLY(sv) && !SvOK(sv)) {
3113 if (ckWARN(WARN_UNINITIALIZED))
3118 if (SvTYPE(sv) < SVt_NV) {
3119 if (SvTYPE(sv) == SVt_IV)
3120 sv_upgrade(sv, SVt_PVNV);
3122 sv_upgrade(sv, SVt_NV);
3123 #ifdef USE_LONG_DOUBLE
3125 STORE_NUMERIC_LOCAL_SET_STANDARD();
3126 PerlIO_printf(Perl_debug_log,
3127 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3128 PTR2UV(sv), SvNVX(sv));
3129 RESTORE_NUMERIC_LOCAL();
3133 STORE_NUMERIC_LOCAL_SET_STANDARD();
3134 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3135 PTR2UV(sv), SvNVX(sv));
3136 RESTORE_NUMERIC_LOCAL();
3140 else if (SvTYPE(sv) < SVt_PVNV)
3141 sv_upgrade(sv, SVt_PVNV);
3146 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3147 #ifdef NV_PRESERVES_UV
3150 /* Only set the public NV OK flag if this NV preserves the IV */
3151 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3152 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3153 : (SvIVX(sv) == I_V(SvNVX(sv))))
3159 else if (SvPOKp(sv) && SvLEN(sv)) {
3161 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3162 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3164 #ifdef NV_PRESERVES_UV
3165 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3166 == IS_NUMBER_IN_UV) {
3167 /* It's definitely an integer */
3168 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3170 SvNV_set(sv, Atof(SvPVX_const(sv)));
3173 SvNV_set(sv, Atof(SvPVX_const(sv)));
3174 /* Only set the public NV OK flag if this NV preserves the value in
3175 the PV at least as well as an IV/UV would.
3176 Not sure how to do this 100% reliably. */
3177 /* if that shift count is out of range then Configure's test is
3178 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3180 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3181 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3182 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3183 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3184 /* Can't use strtol etc to convert this string, so don't try.
3185 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3188 /* value has been set. It may not be precise. */
3189 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3190 /* 2s complement assumption for (UV)IV_MIN */
3191 SvNOK_on(sv); /* Integer is too negative. */
3196 if (numtype & IS_NUMBER_NEG) {
3197 SvIV_set(sv, -(IV)value);
3198 } else if (value <= (UV)IV_MAX) {
3199 SvIV_set(sv, (IV)value);
3201 SvUV_set(sv, value);
3205 if (numtype & IS_NUMBER_NOT_INT) {
3206 /* I believe that even if the original PV had decimals,
3207 they are lost beyond the limit of the FP precision.
3208 However, neither is canonical, so both only get p
3209 flags. NWC, 2000/11/25 */
3210 /* Both already have p flags, so do nothing */
3213 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3214 if (SvIVX(sv) == I_V(nv)) {
3219 /* It had no "." so it must be integer. */
3222 /* between IV_MAX and NV(UV_MAX).
3223 Could be slightly > UV_MAX */
3225 if (numtype & IS_NUMBER_NOT_INT) {
3226 /* UV and NV both imprecise. */
3228 UV nv_as_uv = U_V(nv);
3230 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3241 #endif /* NV_PRESERVES_UV */
3244 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3246 if (SvTYPE(sv) < SVt_NV)
3247 /* Typically the caller expects that sv_any is not NULL now. */
3248 /* XXX Ilya implies that this is a bug in callers that assume this
3249 and ideally should be fixed. */
3250 sv_upgrade(sv, SVt_NV);
3253 #if defined(USE_LONG_DOUBLE)
3255 STORE_NUMERIC_LOCAL_SET_STANDARD();
3256 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3257 PTR2UV(sv), SvNVX(sv));
3258 RESTORE_NUMERIC_LOCAL();
3262 STORE_NUMERIC_LOCAL_SET_STANDARD();
3263 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3264 PTR2UV(sv), SvNVX(sv));
3265 RESTORE_NUMERIC_LOCAL();
3271 /* asIV(): extract an integer from the string value of an SV.
3272 * Caller must validate PVX */
3275 S_asIV(pTHX_ SV *sv)
3278 int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3281 == IS_NUMBER_IN_UV) {
3282 /* It's definitely an integer */
3283 if (numtype & IS_NUMBER_NEG) {
3284 if (value < (UV)IV_MIN)
3287 if (value < (UV)IV_MAX)
3292 if (ckWARN(WARN_NUMERIC))
3295 return I_V(Atof(SvPVX_const(sv)));
3298 /* asUV(): extract an unsigned integer from the string value of an SV
3299 * Caller must validate PVX */
3302 S_asUV(pTHX_ SV *sv)
3305 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3307 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3308 == IS_NUMBER_IN_UV) {
3309 /* It's definitely an integer */
3310 if (!(numtype & IS_NUMBER_NEG))
3314 if (ckWARN(WARN_NUMERIC))
3317 return U_V(Atof(SvPVX_const(sv)));
3321 =for apidoc sv_2pv_nolen
3323 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3324 use the macro wrapper C<SvPV_nolen(sv)> instead.
3329 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3331 return sv_2pv(sv, 0);
3334 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3335 * UV as a string towards the end of buf, and return pointers to start and
3338 * We assume that buf is at least TYPE_CHARS(UV) long.
3342 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3344 char *ptr = buf + TYPE_CHARS(UV);
3358 *--ptr = '0' + (char)(uv % 10);
3366 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3367 * this function provided for binary compatibility only
3371 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3373 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3377 =for apidoc sv_2pv_flags
3379 Returns a pointer to the string value of an SV, and sets *lp to its length.
3380 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3382 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3383 usually end up here too.
3389 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3394 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3395 char *tmpbuf = tbuf;
3399 /* Saves needing to do lots of if (!lp) checks below */
3407 if (SvGMAGICAL(sv)) {
3408 if (flags & SV_GMAGIC)
3412 if (flags & SV_CONST_RETURN)
3413 return (char *)SvPVX_const(sv);
3418 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3420 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3425 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3430 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3431 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)))) {
3444 char *pv = SvPV(tmpstr, *lp);
3454 typestr = "NULLREF";
3458 switch (SvTYPE(sv)) {
3460 if ( ((SvFLAGS(sv) &
3461 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3462 == (SVs_OBJECT|SVs_SMG))
3463 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3464 const regexp *re = (regexp *)mg->mg_obj;
3467 const char *fptr = "msix";
3472 char need_newline = 0;
3473 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3475 while((ch = *fptr++)) {
3477 reflags[left++] = ch;
3480 reflags[right--] = ch;
3485 reflags[left] = '-';
3489 mg->mg_len = re->prelen + 4 + left;
3491 * If /x was used, we have to worry about a regex
3492 * ending with a comment later being embedded
3493 * within another regex. If so, we don't want this
3494 * regex's "commentization" to leak out to the
3495 * right part of the enclosing regex, we must cap
3496 * it with a newline.
3498 * So, if /x was used, we scan backwards from the
3499 * end of the regex. If we find a '#' before we
3500 * find a newline, we need to add a newline
3501 * ourself. If we find a '\n' first (or if we
3502 * don't find '#' or '\n'), we don't need to add
3503 * anything. -jfriedl
3505 if (PMf_EXTENDED & re->reganch)
3507 const char *endptr = re->precomp + re->prelen;
3508 while (endptr >= re->precomp)
3510 const char c = *(endptr--);
3512 break; /* don't need another */
3514 /* we end while in a comment, so we
3516 mg->mg_len++; /* save space for it */
3517 need_newline = 1; /* note to add it */
3523 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3524 Copy("(?", mg->mg_ptr, 2, char);
3525 Copy(reflags, mg->mg_ptr+2, left, char);
3526 Copy(":", mg->mg_ptr+left+2, 1, char);
3527 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3529 mg->mg_ptr[mg->mg_len - 2] = '\n';
3530 mg->mg_ptr[mg->mg_len - 1] = ')';
3531 mg->mg_ptr[mg->mg_len] = 0;
3533 PL_reginterp_cnt += re->program[0].next_off;
3535 if (re->reganch & ROPT_UTF8)
3550 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3551 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3552 /* tied lvalues should appear to be
3553 * scalars for backwards compatitbility */
3554 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3555 ? "SCALAR" : "LVALUE"; break;
3556 case SVt_PVAV: typestr = "ARRAY"; break;
3557 case SVt_PVHV: typestr = "HASH"; break;
3558 case SVt_PVCV: typestr = "CODE"; break;
3559 case SVt_PVGV: typestr = "GLOB"; break;
3560 case SVt_PVFM: typestr = "FORMAT"; break;
3561 case SVt_PVIO: typestr = "IO"; break;
3562 default: typestr = "UNKNOWN"; break;
3566 const char *name = HvNAME_get(SvSTASH(sv));
3567 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3568 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3571 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3574 *lp = strlen(typestr);
3575 return (char *)typestr;
3577 if (SvREADONLY(sv) && !SvOK(sv)) {
3578 if (ckWARN(WARN_UNINITIALIZED))
3584 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3585 /* I'm assuming that if both IV and NV are equally valid then
3586 converting the IV is going to be more efficient */
3587 const U32 isIOK = SvIOK(sv);
3588 const U32 isUIOK = SvIsUV(sv);
3589 char buf[TYPE_CHARS(UV)];
3592 if (SvTYPE(sv) < SVt_PVIV)
3593 sv_upgrade(sv, SVt_PVIV);
3595 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3597 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3598 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3599 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3600 SvCUR_set(sv, ebuf - ptr);
3610 else if (SvNOKp(sv)) {
3611 if (SvTYPE(sv) < SVt_PVNV)
3612 sv_upgrade(sv, SVt_PVNV);
3613 /* The +20 is pure guesswork. Configure test needed. --jhi */
3614 SvGROW(sv, NV_DIG + 20);
3615 s = SvPVX_mutable(sv);
3616 olderrno = errno; /* some Xenix systems wipe out errno here */
3618 if (SvNVX(sv) == 0.0)
3619 (void)strcpy(s,"0");
3623 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3626 #ifdef FIXNEGATIVEZERO
3627 if (*s == '-' && s[1] == '0' && !s[2])
3637 if (ckWARN(WARN_UNINITIALIZED)
3638 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3641 if (SvTYPE(sv) < SVt_PV)
3642 /* Typically the caller expects that sv_any is not NULL now. */
3643 sv_upgrade(sv, SVt_PV);
3646 *lp = s - SvPVX_const(sv);
3649 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3650 PTR2UV(sv),SvPVX_const(sv)));
3651 if (flags & SV_CONST_RETURN)
3652 return (char *)SvPVX_const(sv);
3656 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3657 /* Sneaky stuff here */
3661 tsv = newSVpv(tmpbuf, 0);
3673 t = SvPVX_const(tsv);
3678 len = strlen(tmpbuf);
3680 #ifdef FIXNEGATIVEZERO
3681 if (len == 2 && t[0] == '-' && t[1] == '0') {
3686 SvUPGRADE(sv, SVt_PV);
3688 s = SvGROW(sv, len + 1);
3691 return strcpy(s, t);
3696 =for apidoc sv_copypv
3698 Copies a stringified representation of the source SV into the
3699 destination SV. Automatically performs any necessary mg_get and
3700 coercion of numeric values into strings. Guaranteed to preserve
3701 UTF-8 flag even from overloaded objects. Similar in nature to
3702 sv_2pv[_flags] but operates directly on an SV instead of just the
3703 string. Mostly uses sv_2pv_flags to do its work, except when that
3704 would lose the UTF-8'ness of the PV.
3710 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3714 s = SvPV_const(ssv,len);
3715 sv_setpvn(dsv,s,len);
3723 =for apidoc sv_2pvbyte_nolen
3725 Return a pointer to the byte-encoded representation of the SV.
3726 May cause the SV to be downgraded from UTF-8 as a side-effect.
3728 Usually accessed via the C<SvPVbyte_nolen> macro.
3734 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3736 return sv_2pvbyte(sv, 0);
3740 =for apidoc sv_2pvbyte
3742 Return a pointer to the byte-encoded representation of the SV, and set *lp
3743 to its length. May cause the SV to be downgraded from UTF-8 as a
3746 Usually accessed via the C<SvPVbyte> macro.
3752 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3754 sv_utf8_downgrade(sv,0);
3755 return SvPV(sv,*lp);
3759 =for apidoc sv_2pvutf8_nolen
3761 Return a pointer to the UTF-8-encoded representation of the SV.
3762 May cause the SV to be upgraded to UTF-8 as a side-effect.
3764 Usually accessed via the C<SvPVutf8_nolen> macro.
3770 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3772 return sv_2pvutf8(sv, 0);
3776 =for apidoc sv_2pvutf8
3778 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3779 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3781 Usually accessed via the C<SvPVutf8> macro.
3787 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3789 sv_utf8_upgrade(sv);
3790 return SvPV(sv,*lp);
3794 =for apidoc sv_2bool
3796 This function is only called on magical items, and is only used by
3797 sv_true() or its macro equivalent.
3803 Perl_sv_2bool(pTHX_ register SV *sv)
3812 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3813 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3814 return (bool)SvTRUE(tmpsv);
3815 return SvRV(sv) != 0;
3818 register XPV* Xpvtmp;
3819 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3820 (*sv->sv_u.svu_pv > '0' ||
3821 Xpvtmp->xpv_cur > 1 ||
3822 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3829 return SvIVX(sv) != 0;
3832 return SvNVX(sv) != 0.0;
3839 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3840 * this function provided for binary compatibility only
3845 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3847 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3851 =for apidoc sv_utf8_upgrade
3853 Converts the PV of an SV to its UTF-8-encoded form.
3854 Forces the SV to string form if it is not already.
3855 Always sets the SvUTF8 flag to avoid future validity checks even
3856 if all the bytes have hibit clear.
3858 This is not as a general purpose byte encoding to Unicode interface:
3859 use the Encode extension for that.
3861 =for apidoc sv_utf8_upgrade_flags
3863 Converts the PV of an SV to its UTF-8-encoded form.
3864 Forces the SV to string form if it is not already.
3865 Always sets the SvUTF8 flag to avoid future validity checks even
3866 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3867 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3868 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3870 This is not as a general purpose byte encoding to Unicode interface:
3871 use the Encode extension for that.
3877 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3879 if (sv == &PL_sv_undef)
3883 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3884 (void) sv_2pv_flags(sv,&len, flags);
3888 (void) SvPV_force(sv,len);
3897 sv_force_normal_flags(sv, 0);
3900 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3901 sv_recode_to_utf8(sv, PL_encoding);
3902 else { /* Assume Latin-1/EBCDIC */
3903 /* This function could be much more efficient if we
3904 * had a FLAG in SVs to signal if there are any hibit
3905 * chars in the PV. Given that there isn't such a flag
3906 * make the loop as fast as possible. */
3907 U8 *s = (U8 *) SvPVX(sv);
3908 U8 *e = (U8 *) SvEND(sv);
3914 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3918 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3919 s = bytes_to_utf8((U8*)s, &len);
3921 SvPV_free(sv); /* No longer using what was there before. */
3923 SvPV_set(sv, (char*)s);
3924 SvCUR_set(sv, len - 1);
3925 SvLEN_set(sv, len); /* No longer know the real size. */
3927 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3934 =for apidoc sv_utf8_downgrade
3936 Attempts to convert the PV of an SV from characters to bytes.
3937 If the PV contains a character beyond byte, this conversion will fail;
3938 in this case, either returns false or, if C<fail_ok> is not
3941 This is not as a general purpose Unicode to byte encoding interface:
3942 use the Encode extension for that.
3948 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3950 if (SvPOKp(sv) && SvUTF8(sv)) {
3956 sv_force_normal_flags(sv, 0);
3958 s = (U8 *) SvPV(sv, len);
3959 if (!utf8_to_bytes(s, &len)) {
3964 Perl_croak(aTHX_ "Wide character in %s",
3967 Perl_croak(aTHX_ "Wide character");
3978 =for apidoc sv_utf8_encode
3980 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3981 flag off so that it looks like octets again.
3987 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3989 (void) sv_utf8_upgrade(sv);
3991 sv_force_normal_flags(sv, 0);
3993 if (SvREADONLY(sv)) {
3994 Perl_croak(aTHX_ PL_no_modify);
4000 =for apidoc sv_utf8_decode
4002 If the PV of the SV is an octet sequence in UTF-8
4003 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4004 so that it looks like a character. If the PV contains only single-byte
4005 characters, the C<SvUTF8> flag stays being off.
4006 Scans PV for validity and returns false if the PV is invalid UTF-8.
4012 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4018 /* The octets may have got themselves encoded - get them back as
4021 if (!sv_utf8_downgrade(sv, TRUE))
4024 /* it is actually just a matter of turning the utf8 flag on, but
4025 * we want to make sure everything inside is valid utf8 first.
4027 c = (U8 *) SvPVX(sv);
4028 if (!is_utf8_string(c, SvCUR(sv)+1))
4030 e = (U8 *) SvEND(sv);
4033 if (!UTF8_IS_INVARIANT(ch)) {
4042 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4043 * this function provided for binary compatibility only
4047 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4049 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4053 =for apidoc sv_setsv
4055 Copies the contents of the source SV C<ssv> into the destination SV
4056 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4057 function if the source SV needs to be reused. Does not handle 'set' magic.
4058 Loosely speaking, it performs a copy-by-value, obliterating any previous
4059 content of the destination.
4061 You probably want to use one of the assortment of wrappers, such as
4062 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4063 C<SvSetMagicSV_nosteal>.
4065 =for apidoc sv_setsv_flags
4067 Copies the contents of the source SV C<ssv> into the destination SV
4068 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4069 function if the source SV needs to be reused. Does not handle 'set' magic.
4070 Loosely speaking, it performs a copy-by-value, obliterating any previous
4071 content of the destination.
4072 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4073 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4074 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4075 and C<sv_setsv_nomg> are implemented in terms of this function.
4077 You probably want to use one of the assortment of wrappers, such as
4078 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4079 C<SvSetMagicSV_nosteal>.
4081 This is the primary function for copying scalars, and most other
4082 copy-ish functions and macros use this underneath.
4088 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4090 register U32 sflags;
4096 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4098 sstr = &PL_sv_undef;
4099 stype = SvTYPE(sstr);
4100 dtype = SvTYPE(dstr);
4105 /* need to nuke the magic */
4107 SvRMAGICAL_off(dstr);
4110 /* There's a lot of redundancy below but we're going for speed here */
4115 if (dtype != SVt_PVGV) {
4116 (void)SvOK_off(dstr);
4124 sv_upgrade(dstr, SVt_IV);
4127 sv_upgrade(dstr, SVt_PVNV);
4131 sv_upgrade(dstr, SVt_PVIV);
4134 (void)SvIOK_only(dstr);
4135 SvIV_set(dstr, SvIVX(sstr));
4138 if (SvTAINTED(sstr))
4149 sv_upgrade(dstr, SVt_NV);
4154 sv_upgrade(dstr, SVt_PVNV);
4157 SvNV_set(dstr, SvNVX(sstr));
4158 (void)SvNOK_only(dstr);
4159 if (SvTAINTED(sstr))
4167 sv_upgrade(dstr, SVt_RV);
4168 else if (dtype == SVt_PVGV &&
4169 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4172 if (GvIMPORTED(dstr) != GVf_IMPORTED
4173 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4175 GvIMPORTED_on(dstr);
4184 #ifdef PERL_COPY_ON_WRITE
4185 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4186 if (dtype < SVt_PVIV)
4187 sv_upgrade(dstr, SVt_PVIV);
4194 sv_upgrade(dstr, SVt_PV);
4197 if (dtype < SVt_PVIV)
4198 sv_upgrade(dstr, SVt_PVIV);
4201 if (dtype < SVt_PVNV)
4202 sv_upgrade(dstr, SVt_PVNV);
4209 const char * const type = sv_reftype(sstr,0);
4211 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4213 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4218 if (dtype <= SVt_PVGV) {
4220 if (dtype != SVt_PVGV) {
4221 const char * const name = GvNAME(sstr);
4222 const STRLEN len = GvNAMELEN(sstr);
4223 /* don't upgrade SVt_PVLV: it can hold a glob */
4224 if (dtype != SVt_PVLV)
4225 sv_upgrade(dstr, SVt_PVGV);
4226 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4227 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4228 GvNAME(dstr) = savepvn(name, len);
4229 GvNAMELEN(dstr) = len;
4230 SvFAKE_on(dstr); /* can coerce to non-glob */
4232 /* ahem, death to those who redefine active sort subs */
4233 else if (PL_curstackinfo->si_type == PERLSI_SORT
4234 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4235 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4238 #ifdef GV_UNIQUE_CHECK
4239 if (GvUNIQUE((GV*)dstr)) {
4240 Perl_croak(aTHX_ PL_no_modify);
4244 (void)SvOK_off(dstr);
4245 GvINTRO_off(dstr); /* one-shot flag */
4247 GvGP(dstr) = gp_ref(GvGP(sstr));
4248 if (SvTAINTED(sstr))
4250 if (GvIMPORTED(dstr) != GVf_IMPORTED
4251 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4253 GvIMPORTED_on(dstr);
4261 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4263 if ((int)SvTYPE(sstr) != stype) {
4264 stype = SvTYPE(sstr);
4265 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4269 if (stype == SVt_PVLV)
4270 SvUPGRADE(dstr, SVt_PVNV);
4272 SvUPGRADE(dstr, (U32)stype);
4275 sflags = SvFLAGS(sstr);
4277 if (sflags & SVf_ROK) {
4278 if (dtype >= SVt_PV) {
4279 if (dtype == SVt_PVGV) {
4280 SV *sref = SvREFCNT_inc(SvRV(sstr));
4282 const int intro = GvINTRO(dstr);
4284 #ifdef GV_UNIQUE_CHECK
4285 if (GvUNIQUE((GV*)dstr)) {
4286 Perl_croak(aTHX_ PL_no_modify);
4291 GvINTRO_off(dstr); /* one-shot flag */
4292 GvLINE(dstr) = CopLINE(PL_curcop);
4293 GvEGV(dstr) = (GV*)dstr;
4296 switch (SvTYPE(sref)) {
4299 SAVEGENERICSV(GvAV(dstr));
4301 dref = (SV*)GvAV(dstr);
4302 GvAV(dstr) = (AV*)sref;
4303 if (!GvIMPORTED_AV(dstr)
4304 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4306 GvIMPORTED_AV_on(dstr);
4311 SAVEGENERICSV(GvHV(dstr));
4313 dref = (SV*)GvHV(dstr);
4314 GvHV(dstr) = (HV*)sref;
4315 if (!GvIMPORTED_HV(dstr)
4316 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4318 GvIMPORTED_HV_on(dstr);
4323 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4324 SvREFCNT_dec(GvCV(dstr));
4325 GvCV(dstr) = Nullcv;
4326 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4327 PL_sub_generation++;
4329 SAVEGENERICSV(GvCV(dstr));
4332 dref = (SV*)GvCV(dstr);
4333 if (GvCV(dstr) != (CV*)sref) {
4334 CV* cv = GvCV(dstr);
4336 if (!GvCVGEN((GV*)dstr) &&
4337 (CvROOT(cv) || CvXSUB(cv)))
4339 /* ahem, death to those who redefine
4340 * active sort subs */
4341 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4342 PL_sortcop == CvSTART(cv))
4344 "Can't redefine active sort subroutine %s",
4345 GvENAME((GV*)dstr));
4346 /* Redefining a sub - warning is mandatory if
4347 it was a const and its value changed. */
4348 if (ckWARN(WARN_REDEFINE)
4350 && (!CvCONST((CV*)sref)
4351 || sv_cmp(cv_const_sv(cv),
4352 cv_const_sv((CV*)sref)))))
4354 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4356 ? "Constant subroutine %s::%s redefined"
4357 : "Subroutine %s::%s redefined",
4358 HvNAME_get(GvSTASH((GV*)dstr)),
4359 GvENAME((GV*)dstr));
4363 cv_ckproto(cv, (GV*)dstr,
4364 SvPOK(sref) ? SvPVX(sref) : Nullch);
4366 GvCV(dstr) = (CV*)sref;
4367 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4368 GvASSUMECV_on(dstr);
4369 PL_sub_generation++;
4371 if (!GvIMPORTED_CV(dstr)
4372 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4374 GvIMPORTED_CV_on(dstr);
4379 SAVEGENERICSV(GvIOp(dstr));
4381 dref = (SV*)GvIOp(dstr);
4382 GvIOp(dstr) = (IO*)sref;
4386 SAVEGENERICSV(GvFORM(dstr));
4388 dref = (SV*)GvFORM(dstr);
4389 GvFORM(dstr) = (CV*)sref;
4393 SAVEGENERICSV(GvSV(dstr));
4395 dref = (SV*)GvSV(dstr);
4397 if (!GvIMPORTED_SV(dstr)
4398 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4400 GvIMPORTED_SV_on(dstr);
4406 if (SvTAINTED(sstr))
4410 if (SvPVX_const(dstr)) {
4416 (void)SvOK_off(dstr);
4417 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4419 if (sflags & SVp_NOK) {
4421 /* Only set the public OK flag if the source has public OK. */
4422 if (sflags & SVf_NOK)
4423 SvFLAGS(dstr) |= SVf_NOK;
4424 SvNV_set(dstr, SvNVX(sstr));
4426 if (sflags & SVp_IOK) {
4427 (void)SvIOKp_on(dstr);
4428 if (sflags & SVf_IOK)
4429 SvFLAGS(dstr) |= SVf_IOK;
4430 if (sflags & SVf_IVisUV)
4432 SvIV_set(dstr, SvIVX(sstr));
4434 if (SvAMAGIC(sstr)) {
4438 else if (sflags & SVp_POK) {
4442 * Check to see if we can just swipe the string. If so, it's a
4443 * possible small lose on short strings, but a big win on long ones.
4444 * It might even be a win on short strings if SvPVX_const(dstr)
4445 * has to be allocated and SvPVX_const(sstr) has to be freed.
4448 /* Whichever path we take through the next code, we want this true,
4449 and doing it now facilitates the COW check. */
4450 (void)SvPOK_only(dstr);
4453 /* We're not already COW */
4454 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4455 #ifndef PERL_COPY_ON_WRITE
4456 /* or we are, but dstr isn't a suitable target. */
4457 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4462 (sflags & SVs_TEMP) && /* slated for free anyway? */
4463 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4464 (!(flags & SV_NOSTEAL)) &&
4465 /* and we're allowed to steal temps */
4466 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4467 SvLEN(sstr) && /* and really is a string */
4468 /* and won't be needed again, potentially */
4469 !(PL_op && PL_op->op_type == OP_AASSIGN))
4470 #ifdef PERL_COPY_ON_WRITE
4471 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4472 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4473 && SvTYPE(sstr) >= SVt_PVIV)
4476 /* Failed the swipe test, and it's not a shared hash key either.
4477 Have to copy the string. */
4478 STRLEN len = SvCUR(sstr);
4479 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4480 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4481 SvCUR_set(dstr, len);
4482 *SvEND(dstr) = '\0';
4484 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4486 /* Either it's a shared hash key, or it's suitable for
4487 copy-on-write or we can swipe the string. */
4489 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4493 #ifdef PERL_COPY_ON_WRITE
4495 /* I believe I should acquire a global SV mutex if
4496 it's a COW sv (not a shared hash key) to stop
4497 it going un copy-on-write.
4498 If the source SV has gone un copy on write between up there
4499 and down here, then (assert() that) it is of the correct
4500 form to make it copy on write again */
4501 if ((sflags & (SVf_FAKE | SVf_READONLY))
4502 != (SVf_FAKE | SVf_READONLY)) {
4503 SvREADONLY_on(sstr);
4505 /* Make the source SV into a loop of 1.
4506 (about to become 2) */
4507 SV_COW_NEXT_SV_SET(sstr, sstr);
4511 /* Initial code is common. */
4512 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4514 SvFLAGS(dstr) &= ~SVf_OOK;
4515 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4517 else if (SvLEN(dstr))
4518 Safefree(SvPVX_const(dstr));
4522 /* making another shared SV. */
4523 STRLEN cur = SvCUR(sstr);
4524 STRLEN len = SvLEN(sstr);
4525 #ifdef PERL_COPY_ON_WRITE
4527 assert (SvTYPE(dstr) >= SVt_PVIV);
4528 /* SvIsCOW_normal */
4529 /* splice us in between source and next-after-source. */
4530 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4531 SV_COW_NEXT_SV_SET(sstr, dstr);
4532 SvPV_set(dstr, SvPVX(sstr));
4536 /* SvIsCOW_shared_hash */
4537 UV hash = SvSHARED_HASH(sstr);
4538 DEBUG_C(PerlIO_printf(Perl_debug_log,
4539 "Copy on write: Sharing hash\n"));
4541 assert (SvTYPE(dstr) >= SVt_PVIV);
4543 sharepvn(SvPVX_const(sstr),
4544 (sflags & SVf_UTF8?-cur:cur), hash));
4545 SvUV_set(dstr, hash);
4547 SvLEN_set(dstr, len);
4548 SvCUR_set(dstr, cur);
4549 SvREADONLY_on(dstr);
4551 /* Relesase a global SV mutex. */
4554 { /* Passes the swipe test. */
4555 SvPV_set(dstr, SvPVX(sstr));
4556 SvLEN_set(dstr, SvLEN(sstr));
4557 SvCUR_set(dstr, SvCUR(sstr));
4560 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4561 SvPV_set(sstr, Nullch);
4567 if (sflags & SVf_UTF8)
4570 if (sflags & SVp_NOK) {
4572 if (sflags & SVf_NOK)
4573 SvFLAGS(dstr) |= SVf_NOK;
4574 SvNV_set(dstr, SvNVX(sstr));
4576 if (sflags & SVp_IOK) {
4577 (void)SvIOKp_on(dstr);
4578 if (sflags & SVf_IOK)
4579 SvFLAGS(dstr) |= SVf_IOK;
4580 if (sflags & SVf_IVisUV)
4582 SvIV_set(dstr, SvIVX(sstr));
4585 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4586 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4587 smg->mg_ptr, smg->mg_len);
4588 SvRMAGICAL_on(dstr);
4591 else if (sflags & SVp_IOK) {
4592 if (sflags & SVf_IOK)
4593 (void)SvIOK_only(dstr);
4595 (void)SvOK_off(dstr);
4596 (void)SvIOKp_on(dstr);
4598 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4599 if (sflags & SVf_IVisUV)
4601 SvIV_set(dstr, SvIVX(sstr));
4602 if (sflags & SVp_NOK) {
4603 if (sflags & SVf_NOK)
4604 (void)SvNOK_on(dstr);
4606 (void)SvNOKp_on(dstr);
4607 SvNV_set(dstr, SvNVX(sstr));
4610 else if (sflags & SVp_NOK) {
4611 if (sflags & SVf_NOK)
4612 (void)SvNOK_only(dstr);
4614 (void)SvOK_off(dstr);
4617 SvNV_set(dstr, SvNVX(sstr));
4620 if (dtype == SVt_PVGV) {
4621 if (ckWARN(WARN_MISC))
4622 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4625 (void)SvOK_off(dstr);
4627 if (SvTAINTED(sstr))
4632 =for apidoc sv_setsv_mg
4634 Like C<sv_setsv>, but also handles 'set' magic.
4640 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4642 sv_setsv(dstr,sstr);
4646 #ifdef PERL_COPY_ON_WRITE
4648 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4650 STRLEN cur = SvCUR(sstr);
4651 STRLEN len = SvLEN(sstr);
4652 register char *new_pv;
4655 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4663 if (SvTHINKFIRST(dstr))
4664 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4665 else if (SvPVX_const(dstr))
4666 Safefree(SvPVX_const(dstr));
4670 SvUPGRADE(dstr, SVt_PVIV);
4672 assert (SvPOK(sstr));
4673 assert (SvPOKp(sstr));
4674 assert (!SvIOK(sstr));
4675 assert (!SvIOKp(sstr));
4676 assert (!SvNOK(sstr));
4677 assert (!SvNOKp(sstr));
4679 if (SvIsCOW(sstr)) {
4681 if (SvLEN(sstr) == 0) {
4682 /* source is a COW shared hash key. */
4683 UV hash = SvSHARED_HASH(sstr);
4684 DEBUG_C(PerlIO_printf(Perl_debug_log,
4685 "Fast copy on write: Sharing hash\n"));
4686 SvUV_set(dstr, hash);
4687 new_pv = sharepvn(SvPVX_const(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4690 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4692 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4693 SvUPGRADE(sstr, SVt_PVIV);
4694 SvREADONLY_on(sstr);
4696 DEBUG_C(PerlIO_printf(Perl_debug_log,
4697 "Fast copy on write: Converting sstr to COW\n"));
4698 SV_COW_NEXT_SV_SET(dstr, sstr);
4700 SV_COW_NEXT_SV_SET(sstr, dstr);
4701 new_pv = SvPVX(sstr);
4704 SvPV_set(dstr, new_pv);
4705 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4708 SvLEN_set(dstr, len);
4709 SvCUR_set(dstr, cur);
4718 =for apidoc sv_setpvn
4720 Copies a string into an SV. The C<len> parameter indicates the number of
4721 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4722 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4728 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4730 register char *dptr;
4732 SV_CHECK_THINKFIRST_COW_DROP(sv);
4738 /* len is STRLEN which is unsigned, need to copy to signed */
4741 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4743 SvUPGRADE(sv, SVt_PV);
4745 SvGROW(sv, len + 1);
4747 Move(ptr,dptr,len,char);
4750 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4755 =for apidoc sv_setpvn_mg
4757 Like C<sv_setpvn>, but also handles 'set' magic.
4763 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4765 sv_setpvn(sv,ptr,len);
4770 =for apidoc sv_setpv
4772 Copies a string into an SV. The string must be null-terminated. Does not
4773 handle 'set' magic. See C<sv_setpv_mg>.
4779 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4781 register STRLEN len;
4783 SV_CHECK_THINKFIRST_COW_DROP(sv);
4789 SvUPGRADE(sv, SVt_PV);
4791 SvGROW(sv, len + 1);
4792 Move(ptr,SvPVX(sv),len+1,char);
4794 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4799 =for apidoc sv_setpv_mg
4801 Like C<sv_setpv>, but also handles 'set' magic.
4807 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4814 =for apidoc sv_usepvn
4816 Tells an SV to use C<ptr> to find its string value. Normally the string is
4817 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4818 The C<ptr> should point to memory that was allocated by C<malloc>. The
4819 string length, C<len>, must be supplied. This function will realloc the
4820 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4821 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4822 See C<sv_usepvn_mg>.
4828 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4831 SV_CHECK_THINKFIRST_COW_DROP(sv);
4832 SvUPGRADE(sv, SVt_PV);
4837 if (SvPVX_const(sv))
4840 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4841 ptr = saferealloc (ptr, allocate);
4844 SvLEN_set(sv, allocate);
4846 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4851 =for apidoc sv_usepvn_mg
4853 Like C<sv_usepvn>, but also handles 'set' magic.
4859 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4861 sv_usepvn(sv,ptr,len);
4865 #ifdef PERL_COPY_ON_WRITE
4866 /* Need to do this *after* making the SV normal, as we need the buffer
4867 pointer to remain valid until after we've copied it. If we let go too early,
4868 another thread could invalidate it by unsharing last of the same hash key
4869 (which it can do by means other than releasing copy-on-write Svs)
4870 or by changing the other copy-on-write SVs in the loop. */
4872 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN cur, STRLEN len,
4873 U32 hash, SV *after)
4875 if (len) { /* this SV was SvIsCOW_normal(sv) */
4876 /* we need to find the SV pointing to us. */
4877 SV *current = SV_COW_NEXT_SV(after);
4879 if (current == sv) {
4880 /* The SV we point to points back to us (there were only two of us
4882 Hence other SV is no longer copy on write either. */
4884 SvREADONLY_off(after);
4886 /* We need to follow the pointers around the loop. */
4888 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4891 /* don't loop forever if the structure is bust, and we have
4892 a pointer into a closed loop. */
4893 assert (current != after);
4894 assert (SvPVX_const(current) == pvx);
4896 /* Make the SV before us point to the SV after us. */
4897 SV_COW_NEXT_SV_SET(current, after);
4900 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4905 Perl_sv_release_IVX(pTHX_ register SV *sv)
4908 sv_force_normal_flags(sv, 0);
4914 =for apidoc sv_force_normal_flags
4916 Undo various types of fakery on an SV: if the PV is a shared string, make
4917 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4918 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4919 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4920 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4921 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4922 set to some other value.) In addition, the C<flags> parameter gets passed to
4923 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4924 with flags set to 0.
4930 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4932 #ifdef PERL_COPY_ON_WRITE
4933 if (SvREADONLY(sv)) {
4934 /* At this point I believe I should acquire a global SV mutex. */
4936 const char *pvx = SvPVX_const(sv);
4937 STRLEN len = SvLEN(sv);
4938 STRLEN cur = SvCUR(sv);
4939 U32 hash = SvSHARED_HASH(sv);
4940 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4942 PerlIO_printf(Perl_debug_log,
4943 "Copy on write: Force normal %ld\n",
4949 /* This SV doesn't own the buffer, so need to New() a new one: */
4950 SvPV_set(sv, (char*)0);
4952 if (flags & SV_COW_DROP_PV) {
4953 /* OK, so we don't need to copy our buffer. */
4956 SvGROW(sv, cur + 1);
4957 Move(pvx,SvPVX(sv),cur,char);
4961 sv_release_COW(sv, pvx, cur, len, hash, next);
4966 else if (IN_PERL_RUNTIME)
4967 Perl_croak(aTHX_ PL_no_modify);
4968 /* At this point I believe that I can drop the global SV mutex. */
4971 if (SvREADONLY(sv)) {
4973 const char *pvx = SvPVX_const(sv);
4974 const int is_utf8 = SvUTF8(sv);
4975 STRLEN len = SvCUR(sv);
4976 U32 hash = SvSHARED_HASH(sv);
4979 SvPV_set(sv, (char*)0);
4981 SvGROW(sv, len + 1);
4982 Move(pvx,SvPVX_const(sv),len,char);
4984 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4986 else if (IN_PERL_RUNTIME)
4987 Perl_croak(aTHX_ PL_no_modify);
4991 sv_unref_flags(sv, flags);
4992 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4997 =for apidoc sv_force_normal
4999 Undo various types of fakery on an SV: if the PV is a shared string, make
5000 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5001 an xpvmg. See also C<sv_force_normal_flags>.
5007 Perl_sv_force_normal(pTHX_ register SV *sv)
5009 sv_force_normal_flags(sv, 0);
5015 Efficient removal of characters from the beginning of the string buffer.
5016 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5017 the string buffer. The C<ptr> becomes the first character of the adjusted
5018 string. Uses the "OOK hack".
5019 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5020 refer to the same chunk of data.
5026 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5028 register STRLEN delta;
5029 if (!ptr || !SvPOKp(sv))
5031 delta = ptr - SvPVX_const(sv);
5032 SV_CHECK_THINKFIRST(sv);
5033 if (SvTYPE(sv) < SVt_PVIV)
5034 sv_upgrade(sv,SVt_PVIV);
5037 if (!SvLEN(sv)) { /* make copy of shared string */
5038 const char *pvx = SvPVX_const(sv);
5039 STRLEN len = SvCUR(sv);
5040 SvGROW(sv, len + 1);
5041 Move(pvx,SvPVX_const(sv),len,char);
5045 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5046 and we do that anyway inside the SvNIOK_off
5048 SvFLAGS(sv) |= SVf_OOK;
5051 SvLEN_set(sv, SvLEN(sv) - delta);
5052 SvCUR_set(sv, SvCUR(sv) - delta);
5053 SvPV_set(sv, SvPVX(sv) + delta);
5054 SvIV_set(sv, SvIVX(sv) + delta);
5057 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5058 * this function provided for binary compatibility only
5062 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5064 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5068 =for apidoc sv_catpvn
5070 Concatenates the string onto the end of the string which is in the SV. The
5071 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5072 status set, then the bytes appended should be valid UTF-8.
5073 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5075 =for apidoc sv_catpvn_flags
5077 Concatenates the string onto the end of the string which is in the SV. The
5078 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5079 status set, then the bytes appended should be valid UTF-8.
5080 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5081 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5082 in terms of this function.
5088 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5091 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5093 SvGROW(dsv, dlen + slen + 1);
5095 sstr = SvPVX_const(dsv);
5096 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5097 SvCUR_set(dsv, SvCUR(dsv) + slen);
5099 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5104 =for apidoc sv_catpvn_mg
5106 Like C<sv_catpvn>, but also handles 'set' magic.
5112 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5114 sv_catpvn(sv,ptr,len);
5118 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5119 * this function provided for binary compatibility only
5123 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5125 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5129 =for apidoc sv_catsv
5131 Concatenates the string from SV C<ssv> onto the end of the string in
5132 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5133 not 'set' magic. See C<sv_catsv_mg>.
5135 =for apidoc sv_catsv_flags
5137 Concatenates the string from SV C<ssv> onto the end of the string in
5138 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5139 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5140 and C<sv_catsv_nomg> are implemented in terms of this function.
5145 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5151 if ((spv = SvPV_const(ssv, slen))) {
5152 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5153 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5154 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5155 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5156 dsv->sv_flags doesn't have that bit set.
5157 Andy Dougherty 12 Oct 2001
5159 const I32 sutf8 = DO_UTF8(ssv);
5162 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5164 dutf8 = DO_UTF8(dsv);
5166 if (dutf8 != sutf8) {
5168 /* Not modifying source SV, so taking a temporary copy. */
5169 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5171 sv_utf8_upgrade(csv);
5172 spv = SvPV(csv, slen);
5175 sv_utf8_upgrade_nomg(dsv);
5177 sv_catpvn_nomg(dsv, spv, slen);
5182 =for apidoc sv_catsv_mg
5184 Like C<sv_catsv>, but also handles 'set' magic.
5190 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5197 =for apidoc sv_catpv
5199 Concatenates the string onto the end of the string which is in the SV.
5200 If the SV has the UTF-8 status set, then the bytes appended should be
5201 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5206 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5208 register STRLEN len;
5214 junk = SvPV_force(sv, tlen);
5216 SvGROW(sv, tlen + len + 1);
5218 ptr = SvPVX_const(sv);
5219 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5220 SvCUR_set(sv, SvCUR(sv) + len);
5221 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5226 =for apidoc sv_catpv_mg
5228 Like C<sv_catpv>, but also handles 'set' magic.
5234 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5243 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5244 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5251 Perl_newSV(pTHX_ STRLEN len)
5257 sv_upgrade(sv, SVt_PV);
5258 SvGROW(sv, len + 1);
5263 =for apidoc sv_magicext
5265 Adds magic to an SV, upgrading it if necessary. Applies the
5266 supplied vtable and returns a pointer to the magic added.
5268 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5269 In particular, you can add magic to SvREADONLY SVs, and add more than
5270 one instance of the same 'how'.
5272 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5273 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5274 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5275 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5277 (This is now used as a subroutine by C<sv_magic>.)
5282 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5283 const char* name, I32 namlen)
5287 if (SvTYPE(sv) < SVt_PVMG) {
5288 SvUPGRADE(sv, SVt_PVMG);
5290 Newz(702,mg, 1, MAGIC);
5291 mg->mg_moremagic = SvMAGIC(sv);
5292 SvMAGIC_set(sv, mg);
5294 /* Sometimes a magic contains a reference loop, where the sv and
5295 object refer to each other. To prevent a reference loop that
5296 would prevent such objects being freed, we look for such loops
5297 and if we find one we avoid incrementing the object refcount.
5299 Note we cannot do this to avoid self-tie loops as intervening RV must
5300 have its REFCNT incremented to keep it in existence.
5303 if (!obj || obj == sv ||
5304 how == PERL_MAGIC_arylen ||
5305 how == PERL_MAGIC_qr ||
5306 how == PERL_MAGIC_symtab ||
5307 (SvTYPE(obj) == SVt_PVGV &&
5308 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5309 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5310 GvFORM(obj) == (CV*)sv)))
5315 mg->mg_obj = SvREFCNT_inc(obj);
5316 mg->mg_flags |= MGf_REFCOUNTED;
5319 /* Normal self-ties simply pass a null object, and instead of
5320 using mg_obj directly, use the SvTIED_obj macro to produce a
5321 new RV as needed. For glob "self-ties", we are tieing the PVIO
5322 with an RV obj pointing to the glob containing the PVIO. In
5323 this case, to avoid a reference loop, we need to weaken the
5327 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5328 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5334 mg->mg_len = namlen;
5337 mg->mg_ptr = savepvn(name, namlen);
5338 else if (namlen == HEf_SVKEY)
5339 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5341 mg->mg_ptr = (char *) name;
5343 mg->mg_virtual = vtable;
5347 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5352 =for apidoc sv_magic
5354 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5355 then adds a new magic item of type C<how> to the head of the magic list.
5357 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5358 handling of the C<name> and C<namlen> arguments.
5360 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5361 to add more than one instance of the same 'how'.
5367 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5369 const MGVTBL *vtable = 0;
5372 #ifdef PERL_COPY_ON_WRITE
5374 sv_force_normal_flags(sv, 0);
5376 if (SvREADONLY(sv)) {
5378 && how != PERL_MAGIC_regex_global
5379 && how != PERL_MAGIC_bm
5380 && how != PERL_MAGIC_fm
5381 && how != PERL_MAGIC_sv
5382 && how != PERL_MAGIC_backref
5385 Perl_croak(aTHX_ PL_no_modify);
5388 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5389 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5390 /* sv_magic() refuses to add a magic of the same 'how' as an
5393 if (how == PERL_MAGIC_taint)
5401 vtable = &PL_vtbl_sv;
5403 case PERL_MAGIC_overload:
5404 vtable = &PL_vtbl_amagic;
5406 case PERL_MAGIC_overload_elem:
5407 vtable = &PL_vtbl_amagicelem;
5409 case PERL_MAGIC_overload_table:
5410 vtable = &PL_vtbl_ovrld;
5413 vtable = &PL_vtbl_bm;
5415 case PERL_MAGIC_regdata:
5416 vtable = &PL_vtbl_regdata;
5418 case PERL_MAGIC_regdatum:
5419 vtable = &PL_vtbl_regdatum;
5421 case PERL_MAGIC_env:
5422 vtable = &PL_vtbl_env;
5425 vtable = &PL_vtbl_fm;
5427 case PERL_MAGIC_envelem:
5428 vtable = &PL_vtbl_envelem;
5430 case PERL_MAGIC_regex_global:
5431 vtable = &PL_vtbl_mglob;
5433 case PERL_MAGIC_isa:
5434 vtable = &PL_vtbl_isa;
5436 case PERL_MAGIC_isaelem:
5437 vtable = &PL_vtbl_isaelem;
5439 case PERL_MAGIC_nkeys:
5440 vtable = &PL_vtbl_nkeys;
5442 case PERL_MAGIC_dbfile:
5445 case PERL_MAGIC_dbline:
5446 vtable = &PL_vtbl_dbline;
5448 #ifdef USE_LOCALE_COLLATE
5449 case PERL_MAGIC_collxfrm:
5450 vtable = &PL_vtbl_collxfrm;
5452 #endif /* USE_LOCALE_COLLATE */
5453 case PERL_MAGIC_tied:
5454 vtable = &PL_vtbl_pack;
5456 case PERL_MAGIC_tiedelem:
5457 case PERL_MAGIC_tiedscalar:
5458 vtable = &PL_vtbl_packelem;
5461 vtable = &PL_vtbl_regexp;
5463 case PERL_MAGIC_sig:
5464 vtable = &PL_vtbl_sig;
5466 case PERL_MAGIC_sigelem:
5467 vtable = &PL_vtbl_sigelem;
5469 case PERL_MAGIC_taint:
5470 vtable = &PL_vtbl_taint;
5472 case PERL_MAGIC_uvar:
5473 vtable = &PL_vtbl_uvar;
5475 case PERL_MAGIC_vec:
5476 vtable = &PL_vtbl_vec;
5478 case PERL_MAGIC_arylen_p:
5479 case PERL_MAGIC_rhash:
5480 case PERL_MAGIC_symtab:
5481 case PERL_MAGIC_vstring:
5484 case PERL_MAGIC_utf8:
5485 vtable = &PL_vtbl_utf8;
5487 case PERL_MAGIC_substr:
5488 vtable = &PL_vtbl_substr;
5490 case PERL_MAGIC_defelem:
5491 vtable = &PL_vtbl_defelem;
5493 case PERL_MAGIC_glob:
5494 vtable = &PL_vtbl_glob;
5496 case PERL_MAGIC_arylen:
5497 vtable = &PL_vtbl_arylen;
5499 case PERL_MAGIC_pos:
5500 vtable = &PL_vtbl_pos;
5502 case PERL_MAGIC_backref:
5503 vtable = &PL_vtbl_backref;
5505 case PERL_MAGIC_ext:
5506 /* Reserved for use by extensions not perl internals. */
5507 /* Useful for attaching extension internal data to perl vars. */
5508 /* Note that multiple extensions may clash if magical scalars */
5509 /* etc holding private data from one are passed to another. */
5512 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5515 /* Rest of work is done else where */
5516 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5519 case PERL_MAGIC_taint:
5522 case PERL_MAGIC_ext:
5523 case PERL_MAGIC_dbfile:
5530 =for apidoc sv_unmagic
5532 Removes all magic of type C<type> from an SV.
5538 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5542 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5545 for (mg = *mgp; mg; mg = *mgp) {
5546 if (mg->mg_type == type) {
5547 const MGVTBL* const vtbl = mg->mg_virtual;
5548 *mgp = mg->mg_moremagic;
5549 if (vtbl && vtbl->svt_free)
5550 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5551 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5553 Safefree(mg->mg_ptr);
5554 else if (mg->mg_len == HEf_SVKEY)
5555 SvREFCNT_dec((SV*)mg->mg_ptr);
5556 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5557 Safefree(mg->mg_ptr);
5559 if (mg->mg_flags & MGf_REFCOUNTED)
5560 SvREFCNT_dec(mg->mg_obj);
5564 mgp = &mg->mg_moremagic;
5568 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5575 =for apidoc sv_rvweaken
5577 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5578 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5579 push a back-reference to this RV onto the array of backreferences
5580 associated with that magic.
5586 Perl_sv_rvweaken(pTHX_ SV *sv)
5589 if (!SvOK(sv)) /* let undefs pass */
5592 Perl_croak(aTHX_ "Can't weaken a nonreference");
5593 else if (SvWEAKREF(sv)) {
5594 if (ckWARN(WARN_MISC))
5595 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5599 sv_add_backref(tsv, sv);
5605 /* Give tsv backref magic if it hasn't already got it, then push a
5606 * back-reference to sv onto the array associated with the backref magic.
5610 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5614 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5615 av = (AV*)mg->mg_obj;
5618 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5619 /* av now has a refcnt of 2, which avoids it getting freed
5620 * before us during global cleanup. The extra ref is removed
5621 * by magic_killbackrefs() when tsv is being freed */
5623 if (AvFILLp(av) >= AvMAX(av)) {
5625 SV **svp = AvARRAY(av);
5626 for (i = AvFILLp(av); i >= 0; i--)
5628 svp[i] = sv; /* reuse the slot */
5631 av_extend(av, AvFILLp(av)+1);
5633 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5636 /* delete a back-reference to ourselves from the backref magic associated
5637 * with the SV we point to.
5641 S_sv_del_backref(pTHX_ SV *sv)
5648 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5649 Perl_croak(aTHX_ "panic: del_backref");
5650 av = (AV *)mg->mg_obj;
5652 for (i = AvFILLp(av); i >= 0; i--)
5653 if (svp[i] == sv) svp[i] = Nullsv;
5657 =for apidoc sv_insert
5659 Inserts a string at the specified offset/length within the SV. Similar to
5660 the Perl substr() function.
5666 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5670 register char *midend;
5671 register char *bigend;
5677 Perl_croak(aTHX_ "Can't modify non-existent substring");
5678 SvPV_force(bigstr, curlen);
5679 (void)SvPOK_only_UTF8(bigstr);
5680 if (offset + len > curlen) {
5681 SvGROW(bigstr, offset+len+1);
5682 Zero(SvPVX_const(bigstr)+curlen, offset+len-curlen, char);
5683 SvCUR_set(bigstr, offset+len);
5687 i = littlelen - len;
5688 if (i > 0) { /* string might grow */
5689 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5690 mid = big + offset + len;
5691 midend = bigend = big + SvCUR(bigstr);
5694 while (midend > mid) /* shove everything down */
5695 *--bigend = *--midend;
5696 Move(little,big+offset,littlelen,char);
5697 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5702 Move(little,SvPVX(bigstr)+offset,len,char);
5707 big = SvPVX(bigstr);
5710 bigend = big + SvCUR(bigstr);
5712 if (midend > bigend)
5713 Perl_croak(aTHX_ "panic: sv_insert");
5715 if (mid - big > bigend - midend) { /* faster to shorten from end */
5717 Move(little, mid, littlelen,char);
5720 i = bigend - midend;
5722 Move(midend, mid, i,char);
5726 SvCUR_set(bigstr, mid - big);
5729 else if ((i = mid - big)) { /* faster from front */
5730 midend -= littlelen;
5732 sv_chop(bigstr,midend-i);
5737 Move(little, mid, littlelen,char);
5739 else if (littlelen) {
5740 midend -= littlelen;
5741 sv_chop(bigstr,midend);
5742 Move(little,midend,littlelen,char);
5745 sv_chop(bigstr,midend);
5751 =for apidoc sv_replace
5753 Make the first argument a copy of the second, then delete the original.
5754 The target SV physically takes over ownership of the body of the source SV
5755 and inherits its flags; however, the target keeps any magic it owns,
5756 and any magic in the source is discarded.
5757 Note that this is a rather specialist SV copying operation; most of the
5758 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5764 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5766 const U32 refcnt = SvREFCNT(sv);
5767 SV_CHECK_THINKFIRST_COW_DROP(sv);
5768 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5769 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5770 if (SvMAGICAL(sv)) {
5774 sv_upgrade(nsv, SVt_PVMG);
5775 SvMAGIC_set(nsv, SvMAGIC(sv));
5776 SvFLAGS(nsv) |= SvMAGICAL(sv);
5778 SvMAGIC_set(sv, NULL);
5782 assert(!SvREFCNT(sv));
5783 #ifdef DEBUG_LEAKING_SCALARS
5784 sv->sv_flags = nsv->sv_flags;
5785 sv->sv_any = nsv->sv_any;
5786 sv->sv_refcnt = nsv->sv_refcnt;
5788 StructCopy(nsv,sv,SV);
5790 /* Currently could join these into one piece of pointer arithmetic, but
5791 it would be unclear. */
5792 if(SvTYPE(sv) == SVt_IV)
5794 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5795 else if (SvTYPE(sv) == SVt_RV) {
5796 SvANY(sv) = &sv->sv_u.svu_rv;
5800 #ifdef PERL_COPY_ON_WRITE
5801 if (SvIsCOW_normal(nsv)) {
5802 /* We need to follow the pointers around the loop to make the
5803 previous SV point to sv, rather than nsv. */
5806 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5809 assert(SvPVX_const(current) == SvPVX_const(nsv));
5811 /* Make the SV before us point to the SV after us. */
5813 PerlIO_printf(Perl_debug_log, "previous is\n");
5815 PerlIO_printf(Perl_debug_log,
5816 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5817 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5819 SV_COW_NEXT_SV_SET(current, sv);
5822 SvREFCNT(sv) = refcnt;
5823 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5829 =for apidoc sv_clear
5831 Clear an SV: call any destructors, free up any memory used by the body,
5832 and free the body itself. The SV's head is I<not> freed, although
5833 its type is set to all 1's so that it won't inadvertently be assumed
5834 to be live during global destruction etc.
5835 This function should only be called when REFCNT is zero. Most of the time
5836 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5843 Perl_sv_clear(pTHX_ register SV *sv)
5848 assert(SvREFCNT(sv) == 0);
5851 if (PL_defstash) { /* Still have a symbol table? */
5855 stash = SvSTASH(sv);
5856 destructor = StashHANDLER(stash,DESTROY);
5858 SV* tmpref = newRV(sv);
5859 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5861 PUSHSTACKi(PERLSI_DESTROY);
5866 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5872 if(SvREFCNT(tmpref) < 2) {
5873 /* tmpref is not kept alive! */
5875 SvRV_set(tmpref, NULL);
5878 SvREFCNT_dec(tmpref);
5880 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5884 if (PL_in_clean_objs)
5885 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5887 /* DESTROY gave object new lease on life */
5893 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5894 SvOBJECT_off(sv); /* Curse the object. */
5895 if (SvTYPE(sv) != SVt_PVIO)
5896 --PL_sv_objcount; /* XXX Might want something more general */
5899 if (SvTYPE(sv) >= SVt_PVMG) {
5902 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5903 SvREFCNT_dec(SvSTASH(sv));
5906 switch (SvTYPE(sv)) {
5909 IoIFP(sv) != PerlIO_stdin() &&
5910 IoIFP(sv) != PerlIO_stdout() &&
5911 IoIFP(sv) != PerlIO_stderr())
5913 io_close((IO*)sv, FALSE);
5915 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5916 PerlDir_close(IoDIRP(sv));
5917 IoDIRP(sv) = (DIR*)NULL;
5918 Safefree(IoTOP_NAME(sv));
5919 Safefree(IoFMT_NAME(sv));
5920 Safefree(IoBOTTOM_NAME(sv));
5935 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5936 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5937 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5938 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5940 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5941 SvREFCNT_dec(LvTARG(sv));
5945 Safefree(GvNAME(sv));
5946 /* cannot decrease stash refcount yet, as we might recursively delete
5947 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5948 of stash until current sv is completely gone.
5949 -- JohnPC, 27 Mar 1998 */
5950 stash = GvSTASH(sv);
5956 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5958 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5959 /* Don't even bother with turning off the OOK flag. */
5968 SvREFCNT_dec(SvRV(sv));
5970 #ifdef PERL_COPY_ON_WRITE
5971 else if (SvPVX_const(sv)) {
5973 /* I believe I need to grab the global SV mutex here and
5974 then recheck the COW status. */
5976 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5979 sv_release_COW(sv, SvPVX_const(sv), SvCUR(sv), SvLEN(sv),
5980 SvUVX(sv), SV_COW_NEXT_SV(sv));
5981 /* And drop it here. */
5983 } else if (SvLEN(sv)) {
5984 Safefree(SvPVX_const(sv));
5988 else if (SvPVX_const(sv) && SvLEN(sv))
5989 Safefree(SvPVX_const(sv));
5990 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5991 unsharepvn(SvPVX_const(sv),
5992 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6006 switch (SvTYPE(sv)) {
6020 del_XPVIV(SvANY(sv));
6023 del_XPVNV(SvANY(sv));
6026 del_XPVMG(SvANY(sv));
6029 del_XPVLV(SvANY(sv));
6032 del_XPVAV(SvANY(sv));
6035 del_XPVHV(SvANY(sv));
6038 del_XPVCV(SvANY(sv));
6041 del_XPVGV(SvANY(sv));
6042 /* code duplication for increased performance. */
6043 SvFLAGS(sv) &= SVf_BREAK;
6044 SvFLAGS(sv) |= SVTYPEMASK;
6045 /* decrease refcount of the stash that owns this GV, if any */
6047 SvREFCNT_dec(stash);
6048 return; /* not break, SvFLAGS reset already happened */
6050 del_XPVBM(SvANY(sv));
6053 del_XPVFM(SvANY(sv));
6056 del_XPVIO(SvANY(sv));
6059 SvFLAGS(sv) &= SVf_BREAK;
6060 SvFLAGS(sv) |= SVTYPEMASK;
6064 =for apidoc sv_newref
6066 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6073 Perl_sv_newref(pTHX_ SV *sv)
6083 Decrement an SV's reference count, and if it drops to zero, call
6084 C<sv_clear> to invoke destructors and free up any memory used by
6085 the body; finally, deallocate the SV's head itself.
6086 Normally called via a wrapper macro C<SvREFCNT_dec>.
6092 Perl_sv_free(pTHX_ SV *sv)
6097 if (SvREFCNT(sv) == 0) {
6098 if (SvFLAGS(sv) & SVf_BREAK)
6099 /* this SV's refcnt has been artificially decremented to
6100 * trigger cleanup */
6102 if (PL_in_clean_all) /* All is fair */
6104 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6105 /* make sure SvREFCNT(sv)==0 happens very seldom */
6106 SvREFCNT(sv) = (~(U32)0)/2;
6109 if (ckWARN_d(WARN_INTERNAL))
6110 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6111 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6112 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6115 if (--(SvREFCNT(sv)) > 0)
6117 Perl_sv_free2(aTHX_ sv);
6121 Perl_sv_free2(pTHX_ SV *sv)
6126 if (ckWARN_d(WARN_DEBUGGING))
6127 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6128 "Attempt to free temp prematurely: SV 0x%"UVxf
6129 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6133 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6134 /* make sure SvREFCNT(sv)==0 happens very seldom */
6135 SvREFCNT(sv) = (~(U32)0)/2;
6146 Returns the length of the string in the SV. Handles magic and type
6147 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6153 Perl_sv_len(pTHX_ register SV *sv)
6161 len = mg_length(sv);
6163 (void)SvPV_const(sv, len);
6168 =for apidoc sv_len_utf8
6170 Returns the number of characters in the string in an SV, counting wide
6171 UTF-8 bytes as a single character. Handles magic and type coercion.
6177 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6178 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6179 * (Note that the mg_len is not the length of the mg_ptr field.)
6184 Perl_sv_len_utf8(pTHX_ register SV *sv)
6190 return mg_length(sv);
6194 const U8 *s = (U8*)SvPV(sv, len);
6195 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6197 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6199 #ifdef PERL_UTF8_CACHE_ASSERT
6200 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6204 ulen = Perl_utf8_length(aTHX_ s, s + len);
6205 if (!mg && !SvREADONLY(sv)) {
6206 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6207 mg = mg_find(sv, PERL_MAGIC_utf8);
6217 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6218 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6219 * between UTF-8 and byte offsets. There are two (substr offset and substr
6220 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6221 * and byte offset) cache positions.
6223 * The mg_len field is used by sv_len_utf8(), see its comments.
6224 * Note that the mg_len is not the length of the mg_ptr field.
6228 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
6232 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6234 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6238 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6240 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6241 (*mgp)->mg_ptr = (char *) *cachep;
6245 (*cachep)[i] = offsetp;
6246 (*cachep)[i+1] = s - start;
6254 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6255 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6256 * between UTF-8 and byte offsets. See also the comments of
6257 * S_utf8_mg_pos_init().
6261 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6265 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6267 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6268 if (*mgp && (*mgp)->mg_ptr) {
6269 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6270 ASSERT_UTF8_CACHE(*cachep);
6271 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6273 else { /* We will skip to the right spot. */
6278 /* The assumption is that going backward is half
6279 * the speed of going forward (that's where the
6280 * 2 * backw in the below comes from). (The real
6281 * figure of course depends on the UTF-8 data.) */
6283 if ((*cachep)[i] > (STRLEN)uoff) {
6285 backw = (*cachep)[i] - (STRLEN)uoff;
6287 if (forw < 2 * backw)
6290 p = start + (*cachep)[i+1];
6292 /* Try this only for the substr offset (i == 0),
6293 * not for the substr length (i == 2). */
6294 else if (i == 0) { /* (*cachep)[i] < uoff */
6295 const STRLEN ulen = sv_len_utf8(sv);
6297 if ((STRLEN)uoff < ulen) {
6298 forw = (STRLEN)uoff - (*cachep)[i];
6299 backw = ulen - (STRLEN)uoff;
6301 if (forw < 2 * backw)
6302 p = start + (*cachep)[i+1];
6307 /* If the string is not long enough for uoff,
6308 * we could extend it, but not at this low a level. */
6312 if (forw < 2 * backw) {
6319 while (UTF8_IS_CONTINUATION(*p))
6324 /* Update the cache. */
6325 (*cachep)[i] = (STRLEN)uoff;
6326 (*cachep)[i+1] = p - start;
6328 /* Drop the stale "length" cache */
6337 if (found) { /* Setup the return values. */
6338 *offsetp = (*cachep)[i+1];
6339 *sp = start + *offsetp;
6342 *offsetp = send - start;
6344 else if (*sp < start) {
6350 #ifdef PERL_UTF8_CACHE_ASSERT
6355 while (n-- && s < send)
6359 assert(*offsetp == s - start);
6360 assert((*cachep)[0] == (STRLEN)uoff);
6361 assert((*cachep)[1] == *offsetp);
6363 ASSERT_UTF8_CACHE(*cachep);
6372 =for apidoc sv_pos_u2b
6374 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6375 the start of the string, to a count of the equivalent number of bytes; if
6376 lenp is non-zero, it does the same to lenp, but this time starting from
6377 the offset, rather than from the start of the string. Handles magic and
6384 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6385 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6386 * byte offsets. See also the comments of S_utf8_mg_pos().
6391 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6399 start = (U8*)SvPV(sv, len);
6404 I32 uoffset = *offsetp;
6409 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6411 if (!found && uoffset > 0) {
6412 while (s < send && uoffset--)
6416 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6418 *offsetp = s - start;
6423 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6427 if (!found && *lenp > 0) {
6430 while (s < send && ulen--)
6434 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6438 ASSERT_UTF8_CACHE(cache);
6450 =for apidoc sv_pos_b2u
6452 Converts the value pointed to by offsetp from a count of bytes from the
6453 start of the string, to a count of the equivalent number of UTF-8 chars.
6454 Handles magic and type coercion.
6460 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6461 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6462 * byte offsets. See also the comments of S_utf8_mg_pos().
6467 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6475 s = (U8*)SvPV(sv, len);
6476 if ((I32)len < *offsetp)
6477 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6479 U8* send = s + *offsetp;
6481 STRLEN *cache = NULL;
6485 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6486 mg = mg_find(sv, PERL_MAGIC_utf8);
6487 if (mg && mg->mg_ptr) {
6488 cache = (STRLEN *) mg->mg_ptr;
6489 if (cache[1] == (STRLEN)*offsetp) {
6490 /* An exact match. */
6491 *offsetp = cache[0];
6495 else if (cache[1] < (STRLEN)*offsetp) {
6496 /* We already know part of the way. */
6499 /* Let the below loop do the rest. */
6501 else { /* cache[1] > *offsetp */
6502 /* We already know all of the way, now we may
6503 * be able to walk back. The same assumption
6504 * is made as in S_utf8_mg_pos(), namely that
6505 * walking backward is twice slower than
6506 * walking forward. */
6507 STRLEN forw = *offsetp;
6508 STRLEN backw = cache[1] - *offsetp;
6510 if (!(forw < 2 * backw)) {
6511 U8 *p = s + cache[1];
6518 while (UTF8_IS_CONTINUATION(*p)) {
6526 *offsetp = cache[0];
6528 /* Drop the stale "length" cache */
6536 ASSERT_UTF8_CACHE(cache);
6542 /* Call utf8n_to_uvchr() to validate the sequence
6543 * (unless a simple non-UTF character) */
6544 if (!UTF8_IS_INVARIANT(*s))
6545 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6554 if (!SvREADONLY(sv)) {
6556 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6557 mg = mg_find(sv, PERL_MAGIC_utf8);
6562 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6563 mg->mg_ptr = (char *) cache;
6568 cache[1] = *offsetp;
6569 /* Drop the stale "length" cache */
6582 Returns a boolean indicating whether the strings in the two SVs are
6583 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6584 coerce its args to strings if necessary.
6590 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6598 SV* svrecode = Nullsv;
6605 pv1 = SvPV_const(sv1, cur1);
6612 pv2 = SvPV_const(sv2, cur2);
6614 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6615 /* Differing utf8ness.
6616 * Do not UTF8size the comparands as a side-effect. */
6619 svrecode = newSVpvn(pv2, cur2);
6620 sv_recode_to_utf8(svrecode, PL_encoding);
6621 pv2 = SvPV(svrecode, cur2);
6624 svrecode = newSVpvn(pv1, cur1);
6625 sv_recode_to_utf8(svrecode, PL_encoding);
6626 pv1 = SvPV(svrecode, cur1);
6628 /* Now both are in UTF-8. */
6630 SvREFCNT_dec(svrecode);
6635 bool is_utf8 = TRUE;
6638 /* sv1 is the UTF-8 one,
6639 * if is equal it must be downgrade-able */
6640 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6646 /* sv2 is the UTF-8 one,
6647 * if is equal it must be downgrade-able */
6648 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6654 /* Downgrade not possible - cannot be eq */
6662 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6665 SvREFCNT_dec(svrecode);
6676 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6677 string in C<sv1> is less than, equal to, or greater than the string in
6678 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6679 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6685 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6688 const char *pv1, *pv2;
6691 SV *svrecode = Nullsv;
6698 pv1 = SvPV_const(sv1, cur1);
6705 pv2 = SvPV_const(sv2, cur2);
6707 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6708 /* Differing utf8ness.
6709 * Do not UTF8size the comparands as a side-effect. */
6712 svrecode = newSVpvn(pv2, cur2);
6713 sv_recode_to_utf8(svrecode, PL_encoding);
6714 pv2 = SvPV(svrecode, cur2);
6717 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6722 svrecode = newSVpvn(pv1, cur1);
6723 sv_recode_to_utf8(svrecode, PL_encoding);
6724 pv1 = SvPV(svrecode, cur1);
6727 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6733 cmp = cur2 ? -1 : 0;
6737 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6740 cmp = retval < 0 ? -1 : 1;
6741 } else if (cur1 == cur2) {
6744 cmp = cur1 < cur2 ? -1 : 1;
6749 SvREFCNT_dec(svrecode);
6758 =for apidoc sv_cmp_locale
6760 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6761 'use bytes' aware, handles get magic, and will coerce its args to strings
6762 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6768 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6770 #ifdef USE_LOCALE_COLLATE
6776 if (PL_collation_standard)
6780 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6782 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6784 if (!pv1 || !len1) {
6795 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6798 return retval < 0 ? -1 : 1;
6801 * When the result of collation is equality, that doesn't mean
6802 * that there are no differences -- some locales exclude some
6803 * characters from consideration. So to avoid false equalities,
6804 * we use the raw string as a tiebreaker.
6810 #endif /* USE_LOCALE_COLLATE */
6812 return sv_cmp(sv1, sv2);
6816 #ifdef USE_LOCALE_COLLATE
6819 =for apidoc sv_collxfrm
6821 Add Collate Transform magic to an SV if it doesn't already have it.
6823 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6824 scalar data of the variable, but transformed to such a format that a normal
6825 memory comparison can be used to compare the data according to the locale
6832 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6836 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6837 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6842 Safefree(mg->mg_ptr);
6844 if ((xf = mem_collxfrm(s, len, &xlen))) {
6845 if (SvREADONLY(sv)) {
6848 return xf + sizeof(PL_collation_ix);
6851 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6852 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6865 if (mg && mg->mg_ptr) {
6867 return mg->mg_ptr + sizeof(PL_collation_ix);
6875 #endif /* USE_LOCALE_COLLATE */
6880 Get a line from the filehandle and store it into the SV, optionally
6881 appending to the currently-stored string.
6887 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6891 register STDCHAR rslast;
6892 register STDCHAR *bp;
6898 if (SvTHINKFIRST(sv))
6899 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6900 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6902 However, perlbench says it's slower, because the existing swipe code
6903 is faster than copy on write.
6904 Swings and roundabouts. */
6905 SvUPGRADE(sv, SVt_PV);
6910 if (PerlIO_isutf8(fp)) {
6912 sv_utf8_upgrade_nomg(sv);
6913 sv_pos_u2b(sv,&append,0);
6915 } else if (SvUTF8(sv)) {
6916 SV *tsv = NEWSV(0,0);
6917 sv_gets(tsv, fp, 0);
6918 sv_utf8_upgrade_nomg(tsv);
6919 SvCUR_set(sv,append);
6922 goto return_string_or_null;
6927 if (PerlIO_isutf8(fp))
6930 if (IN_PERL_COMPILETIME) {
6931 /* we always read code in line mode */
6935 else if (RsSNARF(PL_rs)) {
6936 /* If it is a regular disk file use size from stat() as estimate
6937 of amount we are going to read - may result in malloc-ing
6938 more memory than we realy need if layers bellow reduce
6939 size we read (e.g. CRLF or a gzip layer)
6942 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6943 const Off_t offset = PerlIO_tell(fp);
6944 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6945 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6951 else if (RsRECORD(PL_rs)) {
6955 /* Grab the size of the record we're getting */
6956 recsize = SvIV(SvRV(PL_rs));
6957 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6960 /* VMS wants read instead of fread, because fread doesn't respect */
6961 /* RMS record boundaries. This is not necessarily a good thing to be */
6962 /* doing, but we've got no other real choice - except avoid stdio
6963 as implementation - perhaps write a :vms layer ?
6965 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6967 bytesread = PerlIO_read(fp, buffer, recsize);
6971 SvCUR_set(sv, bytesread += append);
6972 buffer[bytesread] = '\0';
6973 goto return_string_or_null;
6975 else if (RsPARA(PL_rs)) {
6981 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6982 if (PerlIO_isutf8(fp)) {
6983 rsptr = SvPVutf8(PL_rs, rslen);
6986 if (SvUTF8(PL_rs)) {
6987 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6988 Perl_croak(aTHX_ "Wide character in $/");
6991 rsptr = SvPV(PL_rs, rslen);
6995 rslast = rslen ? rsptr[rslen - 1] : '\0';
6997 if (rspara) { /* have to do this both before and after */
6998 do { /* to make sure file boundaries work right */
7001 i = PerlIO_getc(fp);
7005 PerlIO_ungetc(fp,i);
7011 /* See if we know enough about I/O mechanism to cheat it ! */
7013 /* This used to be #ifdef test - it is made run-time test for ease
7014 of abstracting out stdio interface. One call should be cheap
7015 enough here - and may even be a macro allowing compile
7019 if (PerlIO_fast_gets(fp)) {
7022 * We're going to steal some values from the stdio struct
7023 * and put EVERYTHING in the innermost loop into registers.
7025 register STDCHAR *ptr;
7029 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7030 /* An ungetc()d char is handled separately from the regular
7031 * buffer, so we getc() it back out and stuff it in the buffer.
7033 i = PerlIO_getc(fp);
7034 if (i == EOF) return 0;
7035 *(--((*fp)->_ptr)) = (unsigned char) i;
7039 /* Here is some breathtakingly efficient cheating */
7041 cnt = PerlIO_get_cnt(fp); /* get count into register */
7042 /* make sure we have the room */
7043 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7044 /* Not room for all of it
7045 if we are looking for a separator and room for some
7047 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7048 /* just process what we have room for */
7049 shortbuffered = cnt - SvLEN(sv) + append + 1;
7050 cnt -= shortbuffered;
7054 /* remember that cnt can be negative */
7055 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7060 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7061 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7062 DEBUG_P(PerlIO_printf(Perl_debug_log,
7063 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7064 DEBUG_P(PerlIO_printf(Perl_debug_log,
7065 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7066 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7067 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7072 while (cnt > 0) { /* this | eat */
7074 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7075 goto thats_all_folks; /* screams | sed :-) */
7079 Copy(ptr, bp, cnt, char); /* this | eat */
7080 bp += cnt; /* screams | dust */
7081 ptr += cnt; /* louder | sed :-) */
7086 if (shortbuffered) { /* oh well, must extend */
7087 cnt = shortbuffered;
7089 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7091 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7092 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7096 DEBUG_P(PerlIO_printf(Perl_debug_log,
7097 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7098 PTR2UV(ptr),(long)cnt));
7099 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7101 DEBUG_P(PerlIO_printf(Perl_debug_log,
7102 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7103 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7104 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7106 /* This used to call 'filbuf' in stdio form, but as that behaves like
7107 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7108 another abstraction. */
7109 i = PerlIO_getc(fp); /* get more characters */
7111 DEBUG_P(PerlIO_printf(Perl_debug_log,
7112 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7113 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7114 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7116 cnt = PerlIO_get_cnt(fp);
7117 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7118 DEBUG_P(PerlIO_printf(Perl_debug_log,
7119 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7121 if (i == EOF) /* all done for ever? */
7122 goto thats_really_all_folks;
7124 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7126 SvGROW(sv, bpx + cnt + 2);
7127 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7129 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7131 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7132 goto thats_all_folks;
7136 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7137 memNE((char*)bp - rslen, rsptr, rslen))
7138 goto screamer; /* go back to the fray */
7139 thats_really_all_folks:
7141 cnt += shortbuffered;
7142 DEBUG_P(PerlIO_printf(Perl_debug_log,
7143 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7144 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7145 DEBUG_P(PerlIO_printf(Perl_debug_log,
7146 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7147 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7148 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7150 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7151 DEBUG_P(PerlIO_printf(Perl_debug_log,
7152 "Screamer: done, len=%ld, string=|%.*s|\n",
7153 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7157 /*The big, slow, and stupid way. */
7158 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7160 New(0, buf, 8192, STDCHAR);
7168 const register STDCHAR *bpe = buf + sizeof(buf);
7170 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7171 ; /* keep reading */
7175 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7176 /* Accomodate broken VAXC compiler, which applies U8 cast to
7177 * both args of ?: operator, causing EOF to change into 255
7180 i = (U8)buf[cnt - 1];
7186 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7188 sv_catpvn(sv, (char *) buf, cnt);
7190 sv_setpvn(sv, (char *) buf, cnt);
7192 if (i != EOF && /* joy */
7194 SvCUR(sv) < rslen ||
7195 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7199 * If we're reading from a TTY and we get a short read,
7200 * indicating that the user hit his EOF character, we need
7201 * to notice it now, because if we try to read from the TTY
7202 * again, the EOF condition will disappear.
7204 * The comparison of cnt to sizeof(buf) is an optimization
7205 * that prevents unnecessary calls to feof().
7209 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7213 #ifdef USE_HEAP_INSTEAD_OF_STACK
7218 if (rspara) { /* have to do this both before and after */
7219 while (i != EOF) { /* to make sure file boundaries work right */
7220 i = PerlIO_getc(fp);
7222 PerlIO_ungetc(fp,i);
7228 return_string_or_null:
7229 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7235 Auto-increment of the value in the SV, doing string to numeric conversion
7236 if necessary. Handles 'get' magic.
7242 Perl_sv_inc(pTHX_ register SV *sv)
7251 if (SvTHINKFIRST(sv)) {
7253 sv_force_normal_flags(sv, 0);
7254 if (SvREADONLY(sv)) {
7255 if (IN_PERL_RUNTIME)
7256 Perl_croak(aTHX_ PL_no_modify);
7260 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7262 i = PTR2IV(SvRV(sv));
7267 flags = SvFLAGS(sv);
7268 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7269 /* It's (privately or publicly) a float, but not tested as an
7270 integer, so test it to see. */
7272 flags = SvFLAGS(sv);
7274 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7275 /* It's publicly an integer, or privately an integer-not-float */
7276 #ifdef PERL_PRESERVE_IVUV
7280 if (SvUVX(sv) == UV_MAX)
7281 sv_setnv(sv, UV_MAX_P1);
7283 (void)SvIOK_only_UV(sv);
7284 SvUV_set(sv, SvUVX(sv) + 1);
7286 if (SvIVX(sv) == IV_MAX)
7287 sv_setuv(sv, (UV)IV_MAX + 1);
7289 (void)SvIOK_only(sv);
7290 SvIV_set(sv, SvIVX(sv) + 1);
7295 if (flags & SVp_NOK) {
7296 (void)SvNOK_only(sv);
7297 SvNV_set(sv, SvNVX(sv) + 1.0);
7301 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7302 if ((flags & SVTYPEMASK) < SVt_PVIV)
7303 sv_upgrade(sv, SVt_IV);
7304 (void)SvIOK_only(sv);
7309 while (isALPHA(*d)) d++;
7310 while (isDIGIT(*d)) d++;
7312 #ifdef PERL_PRESERVE_IVUV
7313 /* Got to punt this as an integer if needs be, but we don't issue
7314 warnings. Probably ought to make the sv_iv_please() that does
7315 the conversion if possible, and silently. */
7316 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7317 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7318 /* Need to try really hard to see if it's an integer.
7319 9.22337203685478e+18 is an integer.
7320 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7321 so $a="9.22337203685478e+18"; $a+0; $a++
7322 needs to be the same as $a="9.22337203685478e+18"; $a++
7329 /* sv_2iv *should* have made this an NV */
7330 if (flags & SVp_NOK) {
7331 (void)SvNOK_only(sv);
7332 SvNV_set(sv, SvNVX(sv) + 1.0);
7335 /* I don't think we can get here. Maybe I should assert this
7336 And if we do get here I suspect that sv_setnv will croak. NWC
7338 #if defined(USE_LONG_DOUBLE)
7339 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",
7340 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7342 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7343 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7346 #endif /* PERL_PRESERVE_IVUV */
7347 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7351 while (d >= SvPVX_const(sv)) {
7359 /* MKS: The original code here died if letters weren't consecutive.
7360 * at least it didn't have to worry about non-C locales. The
7361 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7362 * arranged in order (although not consecutively) and that only
7363 * [A-Za-z] are accepted by isALPHA in the C locale.
7365 if (*d != 'z' && *d != 'Z') {
7366 do { ++*d; } while (!isALPHA(*d));
7369 *(d--) -= 'z' - 'a';
7374 *(d--) -= 'z' - 'a' + 1;
7378 /* oh,oh, the number grew */
7379 SvGROW(sv, SvCUR(sv) + 2);
7380 SvCUR_set(sv, SvCUR(sv) + 1);
7381 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7392 Auto-decrement of the value in the SV, doing string to numeric conversion
7393 if necessary. Handles 'get' magic.
7399 Perl_sv_dec(pTHX_ register SV *sv)
7407 if (SvTHINKFIRST(sv)) {
7409 sv_force_normal_flags(sv, 0);
7410 if (SvREADONLY(sv)) {
7411 if (IN_PERL_RUNTIME)
7412 Perl_croak(aTHX_ PL_no_modify);
7416 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7418 i = PTR2IV(SvRV(sv));
7423 /* Unlike sv_inc we don't have to worry about string-never-numbers
7424 and keeping them magic. But we mustn't warn on punting */
7425 flags = SvFLAGS(sv);
7426 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7427 /* It's publicly an integer, or privately an integer-not-float */
7428 #ifdef PERL_PRESERVE_IVUV
7432 if (SvUVX(sv) == 0) {
7433 (void)SvIOK_only(sv);
7437 (void)SvIOK_only_UV(sv);
7438 SvUV_set(sv, SvUVX(sv) + 1);
7441 if (SvIVX(sv) == IV_MIN)
7442 sv_setnv(sv, (NV)IV_MIN - 1.0);
7444 (void)SvIOK_only(sv);
7445 SvIV_set(sv, SvIVX(sv) - 1);
7450 if (flags & SVp_NOK) {
7451 SvNV_set(sv, SvNVX(sv) - 1.0);
7452 (void)SvNOK_only(sv);
7455 if (!(flags & SVp_POK)) {
7456 if ((flags & SVTYPEMASK) < SVt_PVNV)
7457 sv_upgrade(sv, SVt_NV);
7459 (void)SvNOK_only(sv);
7462 #ifdef PERL_PRESERVE_IVUV
7464 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7465 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7466 /* Need to try really hard to see if it's an integer.
7467 9.22337203685478e+18 is an integer.
7468 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7469 so $a="9.22337203685478e+18"; $a+0; $a--
7470 needs to be the same as $a="9.22337203685478e+18"; $a--
7477 /* sv_2iv *should* have made this an NV */
7478 if (flags & SVp_NOK) {
7479 (void)SvNOK_only(sv);
7480 SvNV_set(sv, SvNVX(sv) - 1.0);
7483 /* I don't think we can get here. Maybe I should assert this
7484 And if we do get here I suspect that sv_setnv will croak. NWC
7486 #if defined(USE_LONG_DOUBLE)
7487 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",
7488 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7490 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7491 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7495 #endif /* PERL_PRESERVE_IVUV */
7496 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7500 =for apidoc sv_mortalcopy
7502 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7503 The new SV is marked as mortal. It will be destroyed "soon", either by an
7504 explicit call to FREETMPS, or by an implicit call at places such as
7505 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7510 /* Make a string that will exist for the duration of the expression
7511 * evaluation. Actually, it may have to last longer than that, but
7512 * hopefully we won't free it until it has been assigned to a
7513 * permanent location. */
7516 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7521 sv_setsv(sv,oldstr);
7523 PL_tmps_stack[++PL_tmps_ix] = sv;
7529 =for apidoc sv_newmortal
7531 Creates a new null SV which is mortal. The reference count of the SV is
7532 set to 1. It will be destroyed "soon", either by an explicit call to
7533 FREETMPS, or by an implicit call at places such as statement boundaries.
7534 See also C<sv_mortalcopy> and C<sv_2mortal>.
7540 Perl_sv_newmortal(pTHX)
7545 SvFLAGS(sv) = SVs_TEMP;
7547 PL_tmps_stack[++PL_tmps_ix] = sv;
7552 =for apidoc sv_2mortal
7554 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7555 by an explicit call to FREETMPS, or by an implicit call at places such as
7556 statement boundaries. SvTEMP() is turned on which means that the SV's
7557 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7558 and C<sv_mortalcopy>.
7564 Perl_sv_2mortal(pTHX_ register SV *sv)
7569 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7572 PL_tmps_stack[++PL_tmps_ix] = sv;
7580 Creates a new SV and copies a string into it. The reference count for the
7581 SV is set to 1. If C<len> is zero, Perl will compute the length using
7582 strlen(). For efficiency, consider using C<newSVpvn> instead.
7588 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7593 sv_setpvn(sv,s,len ? len : strlen(s));
7598 =for apidoc newSVpvn
7600 Creates a new SV and copies a string into it. The reference count for the
7601 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7602 string. You are responsible for ensuring that the source string is at least
7603 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7609 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7614 sv_setpvn(sv,s,len);
7620 =for apidoc newSVhek
7622 Creates a new SV from the hash key structure. It will generate scalars that
7623 point to the shared string table where possible. Returns a new (undefined)
7624 SV if the hek is NULL.
7630 Perl_newSVhek(pTHX_ const HEK *hek)
7639 if (HEK_LEN(hek) == HEf_SVKEY) {
7640 return newSVsv(*(SV**)HEK_KEY(hek));
7642 const int flags = HEK_FLAGS(hek);
7643 if (flags & HVhek_WASUTF8) {
7645 Andreas would like keys he put in as utf8 to come back as utf8
7647 STRLEN utf8_len = HEK_LEN(hek);
7648 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7649 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7652 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7654 } else if (flags & HVhek_REHASH) {
7655 /* We don't have a pointer to the hv, so we have to replicate the
7656 flag into every HEK. This hv is using custom a hasing
7657 algorithm. Hence we can't return a shared string scalar, as
7658 that would contain the (wrong) hash value, and might get passed
7659 into an hv routine with a regular hash */
7661 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7666 /* This will be overwhelminly the most common case. */
7667 return newSVpvn_share(HEK_KEY(hek),
7668 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7674 =for apidoc newSVpvn_share
7676 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7677 table. If the string does not already exist in the table, it is created
7678 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7679 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7680 otherwise the hash is computed. The idea here is that as the string table
7681 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7682 hash lookup will avoid string compare.
7688 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7691 bool is_utf8 = FALSE;
7693 STRLEN tmplen = -len;
7695 /* See the note in hv.c:hv_fetch() --jhi */
7696 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7700 PERL_HASH(hash, src, len);
7702 sv_upgrade(sv, SVt_PVIV);
7703 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7716 #if defined(PERL_IMPLICIT_CONTEXT)
7718 /* pTHX_ magic can't cope with varargs, so this is a no-context
7719 * version of the main function, (which may itself be aliased to us).
7720 * Don't access this version directly.
7724 Perl_newSVpvf_nocontext(const char* pat, ...)
7729 va_start(args, pat);
7730 sv = vnewSVpvf(pat, &args);
7737 =for apidoc newSVpvf
7739 Creates a new SV and initializes it with the string formatted like
7746 Perl_newSVpvf(pTHX_ const char* pat, ...)
7750 va_start(args, pat);
7751 sv = vnewSVpvf(pat, &args);
7756 /* backend for newSVpvf() and newSVpvf_nocontext() */
7759 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7763 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7770 Creates a new SV and copies a floating point value into it.
7771 The reference count for the SV is set to 1.
7777 Perl_newSVnv(pTHX_ NV n)
7789 Creates a new SV and copies an integer into it. The reference count for the
7796 Perl_newSViv(pTHX_ IV i)
7808 Creates a new SV and copies an unsigned integer into it.
7809 The reference count for the SV is set to 1.
7815 Perl_newSVuv(pTHX_ UV u)
7825 =for apidoc newRV_noinc
7827 Creates an RV wrapper for an SV. The reference count for the original
7828 SV is B<not> incremented.
7834 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7839 sv_upgrade(sv, SVt_RV);
7841 SvRV_set(sv, tmpRef);
7846 /* newRV_inc is the official function name to use now.
7847 * newRV_inc is in fact #defined to newRV in sv.h
7851 Perl_newRV(pTHX_ SV *tmpRef)
7853 return newRV_noinc(SvREFCNT_inc(tmpRef));
7859 Creates a new SV which is an exact duplicate of the original SV.
7866 Perl_newSVsv(pTHX_ register SV *old)
7872 if (SvTYPE(old) == SVTYPEMASK) {
7873 if (ckWARN_d(WARN_INTERNAL))
7874 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7878 /* SV_GMAGIC is the default for sv_setv()
7879 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7880 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7881 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7886 =for apidoc sv_reset
7888 Underlying implementation for the C<reset> Perl function.
7889 Note that the perl-level function is vaguely deprecated.
7895 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7898 char todo[PERL_UCHAR_MAX+1];
7903 if (!*s) { /* reset ?? searches */
7904 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7906 PMOP *pm = (PMOP *) mg->mg_obj;
7908 pm->op_pmdynflags &= ~PMdf_USED;
7915 /* reset variables */
7917 if (!HvARRAY(stash))
7920 Zero(todo, 256, char);
7923 I32 i = (unsigned char)*s;
7927 max = (unsigned char)*s++;
7928 for ( ; i <= max; i++) {
7931 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7933 for (entry = HvARRAY(stash)[i];
7935 entry = HeNEXT(entry))
7940 if (!todo[(U8)*HeKEY(entry)])
7942 gv = (GV*)HeVAL(entry);
7944 if (SvTHINKFIRST(sv)) {
7945 if (!SvREADONLY(sv) && SvROK(sv))
7950 if (SvTYPE(sv) >= SVt_PV) {
7952 if (SvPVX_const(sv) != Nullch)
7959 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7962 #ifdef USE_ENVIRON_ARRAY
7964 # ifdef USE_ITHREADS
7965 && PL_curinterp == aTHX
7969 environ[0] = Nullch;
7972 #endif /* !PERL_MICRO */
7982 Using various gambits, try to get an IO from an SV: the IO slot if its a
7983 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7984 named after the PV if we're a string.
7990 Perl_sv_2io(pTHX_ SV *sv)
7995 switch (SvTYPE(sv)) {
8003 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8007 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8009 return sv_2io(SvRV(sv));
8010 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8016 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8025 Using various gambits, try to get a CV from an SV; in addition, try if
8026 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8032 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8039 return *gvp = Nullgv, Nullcv;
8040 switch (SvTYPE(sv)) {
8059 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8060 tryAMAGICunDEREF(to_cv);
8063 if (SvTYPE(sv) == SVt_PVCV) {
8072 Perl_croak(aTHX_ "Not a subroutine reference");
8077 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8083 if (lref && !GvCVu(gv)) {
8086 tmpsv = NEWSV(704,0);
8087 gv_efullname3(tmpsv, gv, Nullch);
8088 /* XXX this is probably not what they think they're getting.
8089 * It has the same effect as "sub name;", i.e. just a forward
8091 newSUB(start_subparse(FALSE, 0),
8092 newSVOP(OP_CONST, 0, tmpsv),
8097 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8107 Returns true if the SV has a true value by Perl's rules.
8108 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8109 instead use an in-line version.
8115 Perl_sv_true(pTHX_ register SV *sv)
8120 const register XPV* tXpv;
8121 if ((tXpv = (XPV*)SvANY(sv)) &&
8122 (tXpv->xpv_cur > 1 ||
8123 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8130 return SvIVX(sv) != 0;
8133 return SvNVX(sv) != 0.0;
8135 return sv_2bool(sv);
8143 A private implementation of the C<SvIVx> macro for compilers which can't
8144 cope with complex macro expressions. Always use the macro instead.
8150 Perl_sv_iv(pTHX_ register SV *sv)
8154 return (IV)SvUVX(sv);
8163 A private implementation of the C<SvUVx> macro for compilers which can't
8164 cope with complex macro expressions. Always use the macro instead.
8170 Perl_sv_uv(pTHX_ register SV *sv)
8175 return (UV)SvIVX(sv);
8183 A private implementation of the C<SvNVx> macro for compilers which can't
8184 cope with complex macro expressions. Always use the macro instead.
8190 Perl_sv_nv(pTHX_ register SV *sv)
8197 /* sv_pv() is now a macro using SvPV_nolen();
8198 * this function provided for binary compatibility only
8202 Perl_sv_pv(pTHX_ SV *sv)
8209 return sv_2pv(sv, &n_a);
8215 Use the C<SvPV_nolen> macro instead
8219 A private implementation of the C<SvPV> macro for compilers which can't
8220 cope with complex macro expressions. Always use the macro instead.
8226 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8232 return sv_2pv(sv, lp);
8237 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8243 return sv_2pv_flags(sv, lp, 0);
8246 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8247 * this function provided for binary compatibility only
8251 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8253 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8257 =for apidoc sv_pvn_force
8259 Get a sensible string out of the SV somehow.
8260 A private implementation of the C<SvPV_force> macro for compilers which
8261 can't cope with complex macro expressions. Always use the macro instead.
8263 =for apidoc sv_pvn_force_flags
8265 Get a sensible string out of the SV somehow.
8266 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8267 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8268 implemented in terms of this function.
8269 You normally want to use the various wrapper macros instead: see
8270 C<SvPV_force> and C<SvPV_force_nomg>
8276 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8279 if (SvTHINKFIRST(sv) && !SvROK(sv))
8280 sv_force_normal_flags(sv, 0);
8288 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8290 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8291 sv_reftype(sv,0), OP_NAME(PL_op));
8293 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
8296 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8297 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8301 s = sv_2pv_flags(sv, lp, flags);
8302 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8303 const STRLEN len = *lp;
8307 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8308 SvGROW(sv, len + 1);
8309 Move(s,SvPVX_const(sv),len,char);
8314 SvPOK_on(sv); /* validate pointer */
8316 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8317 PTR2UV(sv),SvPVX_const(sv)));
8320 return SvPVX_mutable(sv);
8323 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8324 * this function provided for binary compatibility only
8328 Perl_sv_pvbyte(pTHX_ SV *sv)
8330 sv_utf8_downgrade(sv,0);
8335 =for apidoc sv_pvbyte
8337 Use C<SvPVbyte_nolen> instead.
8339 =for apidoc sv_pvbyten
8341 A private implementation of the C<SvPVbyte> macro for compilers
8342 which can't cope with complex macro expressions. Always use the macro
8349 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8351 sv_utf8_downgrade(sv,0);
8352 return sv_pvn(sv,lp);
8356 =for apidoc sv_pvbyten_force
8358 A private implementation of the C<SvPVbytex_force> macro for compilers
8359 which can't cope with complex macro expressions. Always use the macro
8366 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8368 sv_pvn_force(sv,lp);
8369 sv_utf8_downgrade(sv,0);
8374 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8375 * this function provided for binary compatibility only
8379 Perl_sv_pvutf8(pTHX_ SV *sv)
8381 sv_utf8_upgrade(sv);
8386 =for apidoc sv_pvutf8
8388 Use the C<SvPVutf8_nolen> macro instead
8390 =for apidoc sv_pvutf8n
8392 A private implementation of the C<SvPVutf8> macro for compilers
8393 which can't cope with complex macro expressions. Always use the macro
8400 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8402 sv_utf8_upgrade(sv);
8403 return sv_pvn(sv,lp);
8407 =for apidoc sv_pvutf8n_force
8409 A private implementation of the C<SvPVutf8_force> macro for compilers
8410 which can't cope with complex macro expressions. Always use the macro
8417 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8419 sv_pvn_force(sv,lp);
8420 sv_utf8_upgrade(sv);
8426 =for apidoc sv_reftype
8428 Returns a string describing what the SV is a reference to.
8434 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8436 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8437 inside return suggests a const propagation bug in g++. */
8438 if (ob && SvOBJECT(sv)) {
8439 char *name = HvNAME_get(SvSTASH(sv));
8440 return name ? name : (char *) "__ANON__";
8443 switch (SvTYPE(sv)) {
8460 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8461 /* tied lvalues should appear to be
8462 * scalars for backwards compatitbility */
8463 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8464 ? "SCALAR" : "LVALUE");
8465 case SVt_PVAV: return "ARRAY";
8466 case SVt_PVHV: return "HASH";
8467 case SVt_PVCV: return "CODE";
8468 case SVt_PVGV: return "GLOB";
8469 case SVt_PVFM: return "FORMAT";
8470 case SVt_PVIO: return "IO";
8471 default: return "UNKNOWN";
8477 =for apidoc sv_isobject
8479 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8480 object. If the SV is not an RV, or if the object is not blessed, then this
8487 Perl_sv_isobject(pTHX_ SV *sv)
8504 Returns a boolean indicating whether the SV is blessed into the specified
8505 class. This does not check for subtypes; use C<sv_derived_from> to verify
8506 an inheritance relationship.
8512 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8524 hvname = HvNAME_get(SvSTASH(sv));
8528 return strEQ(hvname, name);
8534 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8535 it will be upgraded to one. If C<classname> is non-null then the new SV will
8536 be blessed in the specified package. The new SV is returned and its
8537 reference count is 1.
8543 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8549 SV_CHECK_THINKFIRST_COW_DROP(rv);
8552 if (SvTYPE(rv) >= SVt_PVMG) {
8553 const U32 refcnt = SvREFCNT(rv);
8557 SvREFCNT(rv) = refcnt;
8560 if (SvTYPE(rv) < SVt_RV)
8561 sv_upgrade(rv, SVt_RV);
8562 else if (SvTYPE(rv) > SVt_RV) {
8573 HV* stash = gv_stashpv(classname, TRUE);
8574 (void)sv_bless(rv, stash);
8580 =for apidoc sv_setref_pv
8582 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8583 argument will be upgraded to an RV. That RV will be modified to point to
8584 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8585 into the SV. The C<classname> argument indicates the package for the
8586 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8587 will have a reference count of 1, and the RV will be returned.
8589 Do not use with other Perl types such as HV, AV, SV, CV, because those
8590 objects will become corrupted by the pointer copy process.
8592 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8598 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8601 sv_setsv(rv, &PL_sv_undef);
8605 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8610 =for apidoc sv_setref_iv
8612 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8613 argument will be upgraded to an RV. That RV will be modified to point to
8614 the new SV. The C<classname> argument indicates the package for the
8615 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8616 will have a reference count of 1, and the RV will be returned.
8622 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8624 sv_setiv(newSVrv(rv,classname), iv);
8629 =for apidoc sv_setref_uv
8631 Copies an unsigned 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_uv(pTHX_ SV *rv, const char *classname, UV uv)
8643 sv_setuv(newSVrv(rv,classname), uv);
8648 =for apidoc sv_setref_nv
8650 Copies a double 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_nv(pTHX_ SV *rv, const char *classname, NV nv)
8662 sv_setnv(newSVrv(rv,classname), nv);
8667 =for apidoc sv_setref_pvn
8669 Copies a string into a new SV, optionally blessing the SV. The length of the
8670 string must be specified with C<n>. The C<rv> argument will be upgraded to
8671 an RV. That RV will be modified to point to the new SV. The C<classname>
8672 argument indicates the package for the blessing. Set C<classname> to
8673 C<Nullch> to avoid the blessing. The new SV will have a reference count
8674 of 1, and the RV will be returned.
8676 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8682 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8684 sv_setpvn(newSVrv(rv,classname), pv, n);
8689 =for apidoc sv_bless
8691 Blesses an SV into a specified package. The SV must be an RV. The package
8692 must be designated by its stash (see C<gv_stashpv()>). The reference count
8693 of the SV is unaffected.
8699 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8703 Perl_croak(aTHX_ "Can't bless non-reference value");
8705 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8706 if (SvREADONLY(tmpRef))
8707 Perl_croak(aTHX_ PL_no_modify);
8708 if (SvOBJECT(tmpRef)) {
8709 if (SvTYPE(tmpRef) != SVt_PVIO)
8711 SvREFCNT_dec(SvSTASH(tmpRef));
8714 SvOBJECT_on(tmpRef);
8715 if (SvTYPE(tmpRef) != SVt_PVIO)
8717 SvUPGRADE(tmpRef, SVt_PVMG);
8718 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8725 if(SvSMAGICAL(tmpRef))
8726 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8734 /* Downgrades a PVGV to a PVMG.
8738 S_sv_unglob(pTHX_ SV *sv)
8742 assert(SvTYPE(sv) == SVt_PVGV);
8747 SvREFCNT_dec(GvSTASH(sv));
8748 GvSTASH(sv) = Nullhv;
8750 sv_unmagic(sv, PERL_MAGIC_glob);
8751 Safefree(GvNAME(sv));
8754 /* need to keep SvANY(sv) in the right arena */
8755 xpvmg = new_XPVMG();
8756 StructCopy(SvANY(sv), xpvmg, XPVMG);
8757 del_XPVGV(SvANY(sv));
8760 SvFLAGS(sv) &= ~SVTYPEMASK;
8761 SvFLAGS(sv) |= SVt_PVMG;
8765 =for apidoc sv_unref_flags
8767 Unsets the RV status of the SV, and decrements the reference count of
8768 whatever was being referenced by the RV. This can almost be thought of
8769 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8770 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8771 (otherwise the decrementing is conditional on the reference count being
8772 different from one or the reference being a readonly SV).
8779 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8783 if (SvWEAKREF(sv)) {
8791 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8792 assigned to as BEGIN {$a = \"Foo"} will fail. */
8793 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8795 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8796 sv_2mortal(rv); /* Schedule for freeing later */
8800 =for apidoc sv_unref
8802 Unsets the RV status of the SV, and decrements the reference count of
8803 whatever was being referenced by the RV. This can almost be thought of
8804 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8805 being zero. See C<SvROK_off>.
8811 Perl_sv_unref(pTHX_ SV *sv)
8813 sv_unref_flags(sv, 0);
8817 =for apidoc sv_taint
8819 Taint an SV. Use C<SvTAINTED_on> instead.
8824 Perl_sv_taint(pTHX_ SV *sv)
8826 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8830 =for apidoc sv_untaint
8832 Untaint an SV. Use C<SvTAINTED_off> instead.
8837 Perl_sv_untaint(pTHX_ SV *sv)
8839 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8840 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8847 =for apidoc sv_tainted
8849 Test an SV for taintedness. Use C<SvTAINTED> instead.
8854 Perl_sv_tainted(pTHX_ SV *sv)
8856 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8857 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8858 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8865 =for apidoc sv_setpviv
8867 Copies an integer into the given SV, also updating its string value.
8868 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8874 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8876 char buf[TYPE_CHARS(UV)];
8878 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8880 sv_setpvn(sv, ptr, ebuf - ptr);
8884 =for apidoc sv_setpviv_mg
8886 Like C<sv_setpviv>, but also handles 'set' magic.
8892 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8894 char buf[TYPE_CHARS(UV)];
8896 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8898 sv_setpvn(sv, ptr, ebuf - ptr);
8902 #if defined(PERL_IMPLICIT_CONTEXT)
8904 /* pTHX_ magic can't cope with varargs, so this is a no-context
8905 * version of the main function, (which may itself be aliased to us).
8906 * Don't access this version directly.
8910 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8914 va_start(args, pat);
8915 sv_vsetpvf(sv, pat, &args);
8919 /* pTHX_ magic can't cope with varargs, so this is a no-context
8920 * version of the main function, (which may itself be aliased to us).
8921 * Don't access this version directly.
8925 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8929 va_start(args, pat);
8930 sv_vsetpvf_mg(sv, pat, &args);
8936 =for apidoc sv_setpvf
8938 Works like C<sv_catpvf> but copies the text into the SV instead of
8939 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8945 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8948 va_start(args, pat);
8949 sv_vsetpvf(sv, pat, &args);
8954 =for apidoc sv_vsetpvf
8956 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8957 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8959 Usually used via its frontend C<sv_setpvf>.
8965 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8967 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8971 =for apidoc sv_setpvf_mg
8973 Like C<sv_setpvf>, but also handles 'set' magic.
8979 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8982 va_start(args, pat);
8983 sv_vsetpvf_mg(sv, pat, &args);
8988 =for apidoc sv_vsetpvf_mg
8990 Like C<sv_vsetpvf>, but also handles 'set' magic.
8992 Usually used via its frontend C<sv_setpvf_mg>.
8998 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9000 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9004 #if defined(PERL_IMPLICIT_CONTEXT)
9006 /* pTHX_ magic can't cope with varargs, so this is a no-context
9007 * version of the main function, (which may itself be aliased to us).
9008 * Don't access this version directly.
9012 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
9016 va_start(args, pat);
9017 sv_vcatpvf(sv, pat, &args);
9021 /* pTHX_ magic can't cope with varargs, so this is a no-context
9022 * version of the main function, (which may itself be aliased to us).
9023 * Don't access this version directly.
9027 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9031 va_start(args, pat);
9032 sv_vcatpvf_mg(sv, pat, &args);
9038 =for apidoc sv_catpvf
9040 Processes its arguments like C<sprintf> and appends the formatted
9041 output to an SV. If the appended data contains "wide" characters
9042 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9043 and characters >255 formatted with %c), the original SV might get
9044 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9045 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9046 valid UTF-8; if the original SV was bytes, the pattern should be too.
9051 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9054 va_start(args, pat);
9055 sv_vcatpvf(sv, pat, &args);
9060 =for apidoc sv_vcatpvf
9062 Processes its arguments like C<vsprintf> and appends the formatted output
9063 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9065 Usually used via its frontend C<sv_catpvf>.
9071 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9073 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9077 =for apidoc sv_catpvf_mg
9079 Like C<sv_catpvf>, but also handles 'set' magic.
9085 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9088 va_start(args, pat);
9089 sv_vcatpvf_mg(sv, pat, &args);
9094 =for apidoc sv_vcatpvf_mg
9096 Like C<sv_vcatpvf>, but also handles 'set' magic.
9098 Usually used via its frontend C<sv_catpvf_mg>.
9104 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9106 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9111 =for apidoc sv_vsetpvfn
9113 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9116 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9122 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9124 sv_setpvn(sv, "", 0);
9125 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9128 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9131 S_expect_number(pTHX_ char** pattern)
9134 switch (**pattern) {
9135 case '1': case '2': case '3':
9136 case '4': case '5': case '6':
9137 case '7': case '8': case '9':
9138 while (isDIGIT(**pattern))
9139 var = var * 10 + (*(*pattern)++ - '0');
9143 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9146 F0convert(NV nv, char *endbuf, STRLEN *len)
9148 const int neg = nv < 0;
9157 if (uv & 1 && uv == nv)
9158 uv--; /* Round to even */
9160 const unsigned dig = uv % 10;
9173 =for apidoc sv_vcatpvfn
9175 Processes its arguments like C<vsprintf> and appends the formatted output
9176 to an SV. Uses an array of SVs if the C style variable argument list is
9177 missing (NULL). When running with taint checks enabled, indicates via
9178 C<maybe_tainted> if results are untrustworthy (often due to the use of
9181 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9186 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9189 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9196 static const char nullstr[] = "(null)";
9198 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9199 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9201 /* Times 4: a decimal digit takes more than 3 binary digits.
9202 * NV_DIG: mantissa takes than many decimal digits.
9203 * Plus 32: Playing safe. */
9204 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9205 /* large enough for "%#.#f" --chip */
9206 /* what about long double NVs? --jhi */
9208 /* no matter what, this is a string now */
9209 (void)SvPV_force(sv, origlen);
9211 /* special-case "", "%s", and "%-p" (SVf) */
9214 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9216 const char *s = va_arg(*args, char*);
9217 sv_catpv(sv, s ? s : nullstr);
9219 else if (svix < svmax) {
9220 sv_catsv(sv, *svargs);
9221 if (DO_UTF8(*svargs))
9226 if (patlen == 3 && pat[0] == '%' &&
9227 pat[1] == '-' && pat[2] == 'p') {
9229 argsv = va_arg(*args, SV*);
9230 sv_catsv(sv, argsv);
9237 #ifndef USE_LONG_DOUBLE
9238 /* special-case "%.<number>[gf]" */
9239 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9240 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9241 unsigned digits = 0;
9245 while (*pp >= '0' && *pp <= '9')
9246 digits = 10 * digits + (*pp++ - '0');
9247 if (pp - pat == (int)patlen - 1) {
9251 nv = (NV)va_arg(*args, double);
9252 else if (svix < svmax)
9257 /* Add check for digits != 0 because it seems that some
9258 gconverts are buggy in this case, and we don't yet have
9259 a Configure test for this. */
9260 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9261 /* 0, point, slack */
9262 Gconvert(nv, (int)digits, 0, ebuf);
9264 if (*ebuf) /* May return an empty string for digits==0 */
9267 } else if (!digits) {
9270 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9271 sv_catpvn(sv, p, l);
9277 #endif /* !USE_LONG_DOUBLE */
9279 if (!args && svix < svmax && DO_UTF8(*svargs))
9282 patend = (char*)pat + patlen;
9283 for (p = (char*)pat; p < patend; p = q) {
9286 bool vectorize = FALSE;
9287 bool vectorarg = FALSE;
9288 bool vec_utf8 = FALSE;
9294 bool has_precis = FALSE;
9297 bool is_utf8 = FALSE; /* is this item utf8? */
9298 #ifdef HAS_LDBL_SPRINTF_BUG
9299 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9300 with sfio - Allen <allens@cpan.org> */
9301 bool fix_ldbl_sprintf_bug = FALSE;
9305 U8 utf8buf[UTF8_MAXBYTES+1];
9306 STRLEN esignlen = 0;
9308 const char *eptr = Nullch;
9311 U8 *vecstr = Null(U8*);
9318 /* we need a long double target in case HAS_LONG_DOUBLE but
9321 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9329 const char *dotstr = ".";
9330 STRLEN dotstrlen = 1;
9331 I32 efix = 0; /* explicit format parameter index */
9332 I32 ewix = 0; /* explicit width index */
9333 I32 epix = 0; /* explicit precision index */
9334 I32 evix = 0; /* explicit vector index */
9335 bool asterisk = FALSE;
9337 /* echo everything up to the next format specification */
9338 for (q = p; q < patend && *q != '%'; ++q) ;
9340 if (has_utf8 && !pat_utf8)
9341 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9343 sv_catpvn(sv, p, q - p);
9350 We allow format specification elements in this order:
9351 \d+\$ explicit format parameter index
9353 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9354 0 flag (as above): repeated to allow "v02"
9355 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9356 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9358 [%bcdefginopsux_DFOUX] format (mandatory)
9360 if (EXPECT_NUMBER(q, width)) {
9401 if (EXPECT_NUMBER(q, ewix))
9410 if ((vectorarg = asterisk)) {
9422 EXPECT_NUMBER(q, width);
9427 vecsv = va_arg(*args, SV*);
9429 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9430 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9431 dotstr = SvPVx(vecsv, dotstrlen);
9436 vecsv = va_arg(*args, SV*);
9437 vecstr = (U8*)SvPVx(vecsv,veclen);
9438 vec_utf8 = DO_UTF8(vecsv);
9440 else if (efix ? efix <= svmax : svix < svmax) {
9441 vecsv = svargs[efix ? efix-1 : svix++];
9442 vecstr = (U8*)SvPVx(vecsv,veclen);
9443 vec_utf8 = DO_UTF8(vecsv);
9444 /* if this is a version object, we need to return the
9445 * stringified representation (which the SvPVX_const has
9446 * already done for us), but not vectorize the args
9448 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9450 q++; /* skip past the rest of the %vd format */
9451 eptr = (char *) vecstr;
9452 elen = strlen(eptr);
9465 i = va_arg(*args, int);
9467 i = (ewix ? ewix <= svmax : svix < svmax) ?
9468 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9470 width = (i < 0) ? -i : i;
9480 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9482 /* XXX: todo, support specified precision parameter */
9486 i = va_arg(*args, int);
9488 i = (ewix ? ewix <= svmax : svix < svmax)
9489 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9490 precis = (i < 0) ? 0 : i;
9495 precis = precis * 10 + (*q++ - '0');
9504 case 'I': /* Ix, I32x, and I64x */
9506 if (q[1] == '6' && q[2] == '4') {
9512 if (q[1] == '3' && q[2] == '2') {
9522 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9533 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9534 if (*(q + 1) == 'l') { /* lld, llf */
9559 argsv = (efix ? efix <= svmax : svix < svmax) ?
9560 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9567 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9569 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9571 eptr = (char*)utf8buf;
9572 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9583 if (args && !vectorize) {
9584 eptr = va_arg(*args, char*);
9586 #ifdef MACOS_TRADITIONAL
9587 /* On MacOS, %#s format is used for Pascal strings */
9592 elen = strlen(eptr);
9594 eptr = (char *)nullstr;
9595 elen = sizeof nullstr - 1;
9599 eptr = SvPVx_const(argsv, elen);
9600 if (DO_UTF8(argsv)) {
9601 if (has_precis && precis < elen) {
9603 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9606 if (width) { /* fudge width (can't fudge elen) */
9607 width += elen - sv_len_utf8(argsv);
9615 if (has_precis && elen > precis)
9622 if (left && args) { /* SVf */
9631 argsv = va_arg(*args, SV*);
9632 eptr = SvPVx_const(argsv, elen);
9637 if (alt || vectorize)
9639 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9657 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9666 esignbuf[esignlen++] = plus;
9670 case 'h': iv = (short)va_arg(*args, int); break;
9671 case 'l': iv = va_arg(*args, long); break;
9672 case 'V': iv = va_arg(*args, IV); break;
9673 default: iv = va_arg(*args, int); break;
9675 case 'q': iv = va_arg(*args, Quad_t); break;
9680 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9682 case 'h': iv = (short)tiv; break;
9683 case 'l': iv = (long)tiv; break;
9685 default: iv = tiv; break;
9687 case 'q': iv = (Quad_t)tiv; break;
9691 if ( !vectorize ) /* we already set uv above */
9696 esignbuf[esignlen++] = plus;
9700 esignbuf[esignlen++] = '-';
9743 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9754 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9755 case 'l': uv = va_arg(*args, unsigned long); break;
9756 case 'V': uv = va_arg(*args, UV); break;
9757 default: uv = va_arg(*args, unsigned); break;
9759 case 'q': uv = va_arg(*args, Uquad_t); break;
9764 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9766 case 'h': uv = (unsigned short)tuv; break;
9767 case 'l': uv = (unsigned long)tuv; break;
9769 default: uv = tuv; break;
9771 case 'q': uv = (Uquad_t)tuv; break;
9778 char *ptr = ebuf + sizeof ebuf;
9784 p = (char*)((c == 'X')
9785 ? "0123456789ABCDEF" : "0123456789abcdef");
9791 esignbuf[esignlen++] = '0';
9792 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9800 if (alt && *ptr != '0')
9809 esignbuf[esignlen++] = '0';
9810 esignbuf[esignlen++] = 'b';
9813 default: /* it had better be ten or less */
9817 } while (uv /= base);
9820 elen = (ebuf + sizeof ebuf) - ptr;
9824 zeros = precis - elen;
9825 else if (precis == 0 && elen == 1 && *eptr == '0')
9831 /* FLOATING POINT */
9834 c = 'f'; /* maybe %F isn't supported here */
9840 /* This is evil, but floating point is even more evil */
9842 /* for SV-style calling, we can only get NV
9843 for C-style calling, we assume %f is double;
9844 for simplicity we allow any of %Lf, %llf, %qf for long double
9848 #if defined(USE_LONG_DOUBLE)
9852 /* [perl #20339] - we should accept and ignore %lf rather than die */
9856 #if defined(USE_LONG_DOUBLE)
9857 intsize = args ? 0 : 'q';
9861 #if defined(HAS_LONG_DOUBLE)
9870 /* now we need (long double) if intsize == 'q', else (double) */
9871 nv = (args && !vectorize) ?
9872 #if LONG_DOUBLESIZE > DOUBLESIZE
9874 va_arg(*args, long double) :
9875 va_arg(*args, double)
9877 va_arg(*args, double)
9883 if (c != 'e' && c != 'E') {
9885 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9886 will cast our (long double) to (double) */
9887 (void)Perl_frexp(nv, &i);
9888 if (i == PERL_INT_MIN)
9889 Perl_die(aTHX_ "panic: frexp");
9891 need = BIT_DIGITS(i);
9893 need += has_precis ? precis : 6; /* known default */
9898 #ifdef HAS_LDBL_SPRINTF_BUG
9899 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9900 with sfio - Allen <allens@cpan.org> */
9903 # define MY_DBL_MAX DBL_MAX
9904 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9905 # if DOUBLESIZE >= 8
9906 # define MY_DBL_MAX 1.7976931348623157E+308L
9908 # define MY_DBL_MAX 3.40282347E+38L
9912 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9913 # define MY_DBL_MAX_BUG 1L
9915 # define MY_DBL_MAX_BUG MY_DBL_MAX
9919 # define MY_DBL_MIN DBL_MIN
9920 # else /* XXX guessing! -Allen */
9921 # if DOUBLESIZE >= 8
9922 # define MY_DBL_MIN 2.2250738585072014E-308L
9924 # define MY_DBL_MIN 1.17549435E-38L
9928 if ((intsize == 'q') && (c == 'f') &&
9929 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9931 /* it's going to be short enough that
9932 * long double precision is not needed */
9934 if ((nv <= 0L) && (nv >= -0L))
9935 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9937 /* would use Perl_fp_class as a double-check but not
9938 * functional on IRIX - see perl.h comments */
9940 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9941 /* It's within the range that a double can represent */
9942 #if defined(DBL_MAX) && !defined(DBL_MIN)
9943 if ((nv >= ((long double)1/DBL_MAX)) ||
9944 (nv <= (-(long double)1/DBL_MAX)))
9946 fix_ldbl_sprintf_bug = TRUE;
9949 if (fix_ldbl_sprintf_bug == TRUE) {
9959 # undef MY_DBL_MAX_BUG
9962 #endif /* HAS_LDBL_SPRINTF_BUG */
9964 need += 20; /* fudge factor */
9965 if (PL_efloatsize < need) {
9966 Safefree(PL_efloatbuf);
9967 PL_efloatsize = need + 20; /* more fudge */
9968 New(906, PL_efloatbuf, PL_efloatsize, char);
9969 PL_efloatbuf[0] = '\0';
9972 if ( !(width || left || plus || alt) && fill != '0'
9973 && has_precis && intsize != 'q' ) { /* Shortcuts */
9974 /* See earlier comment about buggy Gconvert when digits,
9976 if ( c == 'g' && precis) {
9977 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9978 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9979 goto float_converted;
9980 } else if ( c == 'f' && !precis) {
9981 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9986 char *ptr = ebuf + sizeof ebuf;
9989 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9990 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9991 if (intsize == 'q') {
9992 /* Copy the one or more characters in a long double
9993 * format before the 'base' ([efgEFG]) character to
9994 * the format string. */
9995 static char const prifldbl[] = PERL_PRIfldbl;
9996 char const *p = prifldbl + sizeof(prifldbl) - 3;
9997 while (p >= prifldbl) { *--ptr = *p--; }
10002 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10007 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10019 /* No taint. Otherwise we are in the strange situation
10020 * where printf() taints but print($float) doesn't.
10022 #if defined(HAS_LONG_DOUBLE)
10023 if (intsize == 'q')
10024 (void)sprintf(PL_efloatbuf, ptr, nv);
10026 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
10028 (void)sprintf(PL_efloatbuf, ptr, nv);
10032 eptr = PL_efloatbuf;
10033 elen = strlen(PL_efloatbuf);
10039 i = SvCUR(sv) - origlen;
10040 if (args && !vectorize) {
10042 case 'h': *(va_arg(*args, short*)) = i; break;
10043 default: *(va_arg(*args, int*)) = i; break;
10044 case 'l': *(va_arg(*args, long*)) = i; break;
10045 case 'V': *(va_arg(*args, IV*)) = i; break;
10047 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10052 sv_setuv_mg(argsv, (UV)i);
10054 continue; /* not "break" */
10060 if (!args && ckWARN(WARN_PRINTF) &&
10061 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10062 SV *msg = sv_newmortal();
10063 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10064 (PL_op->op_type == OP_PRTF) ? "" : "s");
10067 Perl_sv_catpvf(aTHX_ msg,
10068 "\"%%%c\"", c & 0xFF);
10070 Perl_sv_catpvf(aTHX_ msg,
10071 "\"%%\\%03"UVof"\"",
10074 sv_catpv(msg, "end of string");
10075 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10078 /* output mangled stuff ... */
10084 /* ... right here, because formatting flags should not apply */
10085 SvGROW(sv, SvCUR(sv) + elen + 1);
10087 Copy(eptr, p, elen, char);
10090 SvCUR_set(sv, p - SvPVX_const(sv));
10092 continue; /* not "break" */
10095 /* calculate width before utf8_upgrade changes it */
10096 have = esignlen + zeros + elen;
10098 if (is_utf8 != has_utf8) {
10101 sv_utf8_upgrade(sv);
10104 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10105 sv_utf8_upgrade(nsv);
10109 SvGROW(sv, SvCUR(sv) + elen + 1);
10114 need = (have > width ? have : width);
10117 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10119 if (esignlen && fill == '0') {
10120 for (i = 0; i < (int)esignlen; i++)
10121 *p++ = esignbuf[i];
10123 if (gap && !left) {
10124 memset(p, fill, gap);
10127 if (esignlen && fill != '0') {
10128 for (i = 0; i < (int)esignlen; i++)
10129 *p++ = esignbuf[i];
10132 for (i = zeros; i; i--)
10136 Copy(eptr, p, elen, char);
10140 memset(p, ' ', gap);
10145 Copy(dotstr, p, dotstrlen, char);
10149 vectorize = FALSE; /* done iterating over vecstr */
10156 SvCUR_set(sv, p - SvPVX_const(sv));
10164 /* =========================================================================
10166 =head1 Cloning an interpreter
10168 All the macros and functions in this section are for the private use of
10169 the main function, perl_clone().
10171 The foo_dup() functions make an exact copy of an existing foo thinngy.
10172 During the course of a cloning, a hash table is used to map old addresses
10173 to new addresses. The table is created and manipulated with the
10174 ptr_table_* functions.
10178 ============================================================================*/
10181 #if defined(USE_ITHREADS)
10183 #ifndef GpREFCNT_inc
10184 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10188 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10189 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10190 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10191 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10192 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10193 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10194 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10195 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10196 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10197 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10198 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10199 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10200 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10203 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10204 regcomp.c. AMS 20010712 */
10207 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10212 struct reg_substr_datum *s;
10215 return (REGEXP *)NULL;
10217 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10220 len = r->offsets[0];
10221 npar = r->nparens+1;
10223 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10224 Copy(r->program, ret->program, len+1, regnode);
10226 New(0, ret->startp, npar, I32);
10227 Copy(r->startp, ret->startp, npar, I32);
10228 New(0, ret->endp, npar, I32);
10229 Copy(r->startp, ret->startp, npar, I32);
10231 New(0, ret->substrs, 1, struct reg_substr_data);
10232 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10233 s->min_offset = r->substrs->data[i].min_offset;
10234 s->max_offset = r->substrs->data[i].max_offset;
10235 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10236 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10239 ret->regstclass = NULL;
10241 struct reg_data *d;
10242 const int count = r->data->count;
10244 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10245 char, struct reg_data);
10246 New(0, d->what, count, U8);
10249 for (i = 0; i < count; i++) {
10250 d->what[i] = r->data->what[i];
10251 switch (d->what[i]) {
10252 /* legal options are one of: sfpont
10253 see also regcomp.h and pregfree() */
10255 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10258 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10261 /* This is cheating. */
10262 New(0, d->data[i], 1, struct regnode_charclass_class);
10263 StructCopy(r->data->data[i], d->data[i],
10264 struct regnode_charclass_class);
10265 ret->regstclass = (regnode*)d->data[i];
10268 /* Compiled op trees are readonly, and can thus be
10269 shared without duplication. */
10271 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10275 d->data[i] = r->data->data[i];
10278 d->data[i] = r->data->data[i];
10280 ((reg_trie_data*)d->data[i])->refcount++;
10284 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10293 New(0, ret->offsets, 2*len+1, U32);
10294 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10296 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10297 ret->refcnt = r->refcnt;
10298 ret->minlen = r->minlen;
10299 ret->prelen = r->prelen;
10300 ret->nparens = r->nparens;
10301 ret->lastparen = r->lastparen;
10302 ret->lastcloseparen = r->lastcloseparen;
10303 ret->reganch = r->reganch;
10305 ret->sublen = r->sublen;
10307 if (RX_MATCH_COPIED(ret))
10308 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10310 ret->subbeg = Nullch;
10311 #ifdef PERL_COPY_ON_WRITE
10312 ret->saved_copy = Nullsv;
10315 ptr_table_store(PL_ptr_table, r, ret);
10319 /* duplicate a file handle */
10322 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10328 return (PerlIO*)NULL;
10330 /* look for it in the table first */
10331 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10335 /* create anew and remember what it is */
10336 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10337 ptr_table_store(PL_ptr_table, fp, ret);
10341 /* duplicate a directory handle */
10344 Perl_dirp_dup(pTHX_ DIR *dp)
10352 /* duplicate a typeglob */
10355 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10360 /* look for it in the table first */
10361 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10365 /* create anew and remember what it is */
10366 Newz(0, ret, 1, GP);
10367 ptr_table_store(PL_ptr_table, gp, ret);
10370 ret->gp_refcnt = 0; /* must be before any other dups! */
10371 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10372 ret->gp_io = io_dup_inc(gp->gp_io, param);
10373 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10374 ret->gp_av = av_dup_inc(gp->gp_av, param);
10375 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10376 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10377 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10378 ret->gp_cvgen = gp->gp_cvgen;
10379 ret->gp_flags = gp->gp_flags;
10380 ret->gp_line = gp->gp_line;
10381 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10385 /* duplicate a chain of magic */
10388 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10390 MAGIC *mgprev = (MAGIC*)NULL;
10393 return (MAGIC*)NULL;
10394 /* look for it in the table first */
10395 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10399 for (; mg; mg = mg->mg_moremagic) {
10401 Newz(0, nmg, 1, MAGIC);
10403 mgprev->mg_moremagic = nmg;
10406 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10407 nmg->mg_private = mg->mg_private;
10408 nmg->mg_type = mg->mg_type;
10409 nmg->mg_flags = mg->mg_flags;
10410 if (mg->mg_type == PERL_MAGIC_qr) {
10411 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10413 else if(mg->mg_type == PERL_MAGIC_backref) {
10414 const AV * const av = (AV*) mg->mg_obj;
10417 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10419 for (i = AvFILLp(av); i >= 0; i--) {
10420 if (!svp[i]) continue;
10421 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10424 else if (mg->mg_type == PERL_MAGIC_symtab) {
10425 nmg->mg_obj = mg->mg_obj;
10428 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10429 ? sv_dup_inc(mg->mg_obj, param)
10430 : sv_dup(mg->mg_obj, param);
10432 nmg->mg_len = mg->mg_len;
10433 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10434 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10435 if (mg->mg_len > 0) {
10436 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10437 if (mg->mg_type == PERL_MAGIC_overload_table &&
10438 AMT_AMAGIC((AMT*)mg->mg_ptr))
10440 AMT *amtp = (AMT*)mg->mg_ptr;
10441 AMT *namtp = (AMT*)nmg->mg_ptr;
10443 for (i = 1; i < NofAMmeth; i++) {
10444 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10448 else if (mg->mg_len == HEf_SVKEY)
10449 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10451 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10452 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10459 /* create a new pointer-mapping table */
10462 Perl_ptr_table_new(pTHX)
10465 Newz(0, tbl, 1, PTR_TBL_t);
10466 tbl->tbl_max = 511;
10467 tbl->tbl_items = 0;
10468 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10473 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10475 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10483 struct ptr_tbl_ent* pte;
10484 struct ptr_tbl_ent* pteend;
10485 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10486 pte->next = PL_pte_arenaroot;
10487 PL_pte_arenaroot = pte;
10489 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10490 PL_pte_root = ++pte;
10491 while (pte < pteend) {
10492 pte->next = pte + 1;
10498 STATIC struct ptr_tbl_ent*
10501 struct ptr_tbl_ent* pte;
10505 PL_pte_root = pte->next;
10510 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10512 p->next = PL_pte_root;
10516 /* map an existing pointer using a table */
10519 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10521 PTR_TBL_ENT_t *tblent;
10522 const UV hash = PTR_TABLE_HASH(sv);
10524 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10525 for (; tblent; tblent = tblent->next) {
10526 if (tblent->oldval == sv)
10527 return tblent->newval;
10529 return (void*)NULL;
10532 /* add a new entry to a pointer-mapping table */
10535 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10537 PTR_TBL_ENT_t *tblent, **otblent;
10538 /* XXX this may be pessimal on platforms where pointers aren't good
10539 * hash values e.g. if they grow faster in the most significant
10541 const UV hash = PTR_TABLE_HASH(oldv);
10545 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10546 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10547 if (tblent->oldval == oldv) {
10548 tblent->newval = newv;
10552 tblent = S_new_pte(aTHX);
10553 tblent->oldval = oldv;
10554 tblent->newval = newv;
10555 tblent->next = *otblent;
10558 if (!empty && tbl->tbl_items > tbl->tbl_max)
10559 ptr_table_split(tbl);
10562 /* double the hash bucket size of an existing ptr table */
10565 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10567 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10568 const UV oldsize = tbl->tbl_max + 1;
10569 UV newsize = oldsize * 2;
10572 Renew(ary, newsize, PTR_TBL_ENT_t*);
10573 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10574 tbl->tbl_max = --newsize;
10575 tbl->tbl_ary = ary;
10576 for (i=0; i < oldsize; i++, ary++) {
10577 PTR_TBL_ENT_t **curentp, **entp, *ent;
10580 curentp = ary + oldsize;
10581 for (entp = ary, ent = *ary; ent; ent = *entp) {
10582 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10584 ent->next = *curentp;
10594 /* remove all the entries from a ptr table */
10597 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10599 register PTR_TBL_ENT_t **array;
10600 register PTR_TBL_ENT_t *entry;
10604 if (!tbl || !tbl->tbl_items) {
10608 array = tbl->tbl_ary;
10610 max = tbl->tbl_max;
10614 PTR_TBL_ENT_t *oentry = entry;
10615 entry = entry->next;
10616 S_del_pte(aTHX_ oentry);
10619 if (++riter > max) {
10622 entry = array[riter];
10626 tbl->tbl_items = 0;
10629 /* clear and free a ptr table */
10632 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10637 ptr_table_clear(tbl);
10638 Safefree(tbl->tbl_ary);
10642 /* attempt to make everything in the typeglob readonly */
10645 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10647 GV *gv = (GV*)sstr;
10648 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10650 if (GvIO(gv) || GvFORM(gv)) {
10651 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10653 else if (!GvCV(gv)) {
10654 GvCV(gv) = (CV*)sv;
10657 /* CvPADLISTs cannot be shared */
10658 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10663 if (!GvUNIQUE(gv)) {
10665 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10666 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10672 * write attempts will die with
10673 * "Modification of a read-only value attempted"
10679 SvREADONLY_on(GvSV(gv));
10683 GvAV(gv) = (AV*)sv;
10686 SvREADONLY_on(GvAV(gv));
10690 GvHV(gv) = (HV*)sv;
10693 SvREADONLY_on(GvHV(gv));
10696 return sstr; /* he_dup() will SvREFCNT_inc() */
10699 /* duplicate an SV of any type (including AV, HV etc) */
10702 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10705 SvRV_set(dstr, SvWEAKREF(sstr)
10706 ? sv_dup(SvRV(sstr), param)
10707 : sv_dup_inc(SvRV(sstr), param));
10710 else if (SvPVX_const(sstr)) {
10711 /* Has something there */
10713 /* Normal PV - clone whole allocated space */
10714 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10715 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10716 /* Not that normal - actually sstr is copy on write.
10717 But we are a true, independant SV, so: */
10718 SvREADONLY_off(dstr);
10723 /* Special case - not normally malloced for some reason */
10724 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10725 /* A "shared" PV - clone it as unshared string */
10726 if(SvPADTMP(sstr)) {
10727 /* However, some of them live in the pad
10728 and they should not have these flags
10731 SvPV_set(dstr, sharepvn(SvPVX_const(sstr), SvCUR(sstr),
10733 SvUV_set(dstr, SvUVX(sstr));
10736 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvCUR(sstr)));
10738 SvREADONLY_off(dstr);
10742 /* Some other special case - random pointer */
10743 SvPV_set(dstr, SvPVX(sstr));
10748 /* Copy the Null */
10749 if (SvTYPE(dstr) == SVt_RV)
10750 SvRV_set(dstr, NULL);
10757 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10762 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10764 /* look for it in the table first */
10765 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10769 if(param->flags & CLONEf_JOIN_IN) {
10770 /** We are joining here so we don't want do clone
10771 something that is bad **/
10772 const char *hvname;
10774 if(SvTYPE(sstr) == SVt_PVHV &&
10775 (hvname = HvNAME_get(sstr))) {
10776 /** don't clone stashes if they already exist **/
10777 HV* old_stash = gv_stashpv(hvname,0);
10778 return (SV*) old_stash;
10782 /* create anew and remember what it is */
10785 #ifdef DEBUG_LEAKING_SCALARS
10786 dstr->sv_debug_optype = sstr->sv_debug_optype;
10787 dstr->sv_debug_line = sstr->sv_debug_line;
10788 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10789 dstr->sv_debug_cloned = 1;
10791 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10793 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10797 ptr_table_store(PL_ptr_table, sstr, dstr);
10800 SvFLAGS(dstr) = SvFLAGS(sstr);
10801 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10802 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10805 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10806 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10807 PL_watch_pvx, SvPVX_const(sstr));
10810 /* don't clone objects whose class has asked us not to */
10811 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10812 SvFLAGS(dstr) &= ~SVTYPEMASK;
10813 SvOBJECT_off(dstr);
10817 switch (SvTYPE(sstr)) {
10819 SvANY(dstr) = NULL;
10822 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10823 SvIV_set(dstr, SvIVX(sstr));
10826 SvANY(dstr) = new_XNV();
10827 SvNV_set(dstr, SvNVX(sstr));
10830 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10831 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10834 SvANY(dstr) = new_XPV();
10835 SvCUR_set(dstr, SvCUR(sstr));
10836 SvLEN_set(dstr, SvLEN(sstr));
10837 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10840 SvANY(dstr) = new_XPVIV();
10841 SvCUR_set(dstr, SvCUR(sstr));
10842 SvLEN_set(dstr, SvLEN(sstr));
10843 SvIV_set(dstr, SvIVX(sstr));
10844 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10847 SvANY(dstr) = new_XPVNV();
10848 SvCUR_set(dstr, SvCUR(sstr));
10849 SvLEN_set(dstr, SvLEN(sstr));
10850 SvIV_set(dstr, SvIVX(sstr));
10851 SvNV_set(dstr, SvNVX(sstr));
10852 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10855 SvANY(dstr) = new_XPVMG();
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 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10861 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10862 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10865 SvANY(dstr) = new_XPVBM();
10866 SvCUR_set(dstr, SvCUR(sstr));
10867 SvLEN_set(dstr, SvLEN(sstr));
10868 SvIV_set(dstr, SvIVX(sstr));
10869 SvNV_set(dstr, SvNVX(sstr));
10870 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10871 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10872 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10873 BmRARE(dstr) = BmRARE(sstr);
10874 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10875 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10878 SvANY(dstr) = new_XPVLV();
10879 SvCUR_set(dstr, SvCUR(sstr));
10880 SvLEN_set(dstr, SvLEN(sstr));
10881 SvIV_set(dstr, SvIVX(sstr));
10882 SvNV_set(dstr, SvNVX(sstr));
10883 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10884 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10885 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10886 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10887 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10888 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10889 LvTARG(dstr) = dstr;
10890 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10891 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10893 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10894 LvTYPE(dstr) = LvTYPE(sstr);
10897 if (GvUNIQUE((GV*)sstr)) {
10899 if ((share = gv_share(sstr, param))) {
10902 ptr_table_store(PL_ptr_table, sstr, dstr);
10904 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10905 HvNAME_get(GvSTASH(share)), GvNAME(share));
10910 SvANY(dstr) = new_XPVGV();
10911 SvCUR_set(dstr, SvCUR(sstr));
10912 SvLEN_set(dstr, SvLEN(sstr));
10913 SvIV_set(dstr, SvIVX(sstr));
10914 SvNV_set(dstr, SvNVX(sstr));
10915 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10916 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10917 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10918 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10919 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10920 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10921 GvFLAGS(dstr) = GvFLAGS(sstr);
10922 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10923 (void)GpREFCNT_inc(GvGP(dstr));
10926 SvANY(dstr) = new_XPVIO();
10927 SvCUR_set(dstr, SvCUR(sstr));
10928 SvLEN_set(dstr, SvLEN(sstr));
10929 SvIV_set(dstr, SvIVX(sstr));
10930 SvNV_set(dstr, SvNVX(sstr));
10931 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10932 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10933 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10934 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10935 if (IoOFP(sstr) == IoIFP(sstr))
10936 IoOFP(dstr) = IoIFP(dstr);
10938 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10939 /* PL_rsfp_filters entries have fake IoDIRP() */
10940 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10941 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10943 IoDIRP(dstr) = IoDIRP(sstr);
10944 IoLINES(dstr) = IoLINES(sstr);
10945 IoPAGE(dstr) = IoPAGE(sstr);
10946 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10947 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10948 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10949 /* I have no idea why fake dirp (rsfps)
10950 should be treaded differently but otherwise
10951 we end up with leaks -- sky*/
10952 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10953 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10954 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10956 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10957 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10958 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10960 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10961 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10962 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10963 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10964 IoTYPE(dstr) = IoTYPE(sstr);
10965 IoFLAGS(dstr) = IoFLAGS(sstr);
10968 SvANY(dstr) = new_XPVAV();
10969 SvCUR_set(dstr, SvCUR(sstr));
10970 SvLEN_set(dstr, SvLEN(sstr));
10971 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10972 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10973 if (AvARRAY((AV*)sstr)) {
10974 SV **dst_ary, **src_ary;
10975 SSize_t items = AvFILLp((AV*)sstr) + 1;
10977 src_ary = AvARRAY((AV*)sstr);
10978 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10979 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10980 SvPV_set(dstr, (char*)dst_ary);
10981 AvALLOC((AV*)dstr) = dst_ary;
10982 if (AvREAL((AV*)sstr)) {
10983 while (items-- > 0)
10984 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10987 while (items-- > 0)
10988 *dst_ary++ = sv_dup(*src_ary++, param);
10990 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10991 while (items-- > 0) {
10992 *dst_ary++ = &PL_sv_undef;
10996 SvPV_set(dstr, Nullch);
10997 AvALLOC((AV*)dstr) = (SV**)NULL;
11001 SvANY(dstr) = new_XPVHV();
11002 SvCUR_set(dstr, SvCUR(sstr));
11003 SvLEN_set(dstr, SvLEN(sstr));
11004 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
11005 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11006 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11010 if (HvARRAY((HV*)sstr)) {
11012 const bool sharekeys = !!HvSHAREKEYS(sstr);
11013 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11014 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11017 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11018 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
11019 HvARRAY(dstr) = (HE**)darray;
11020 while (i <= sxhv->xhv_max) {
11021 HE *source = HvARRAY(sstr)[i];
11023 = source ? he_dup(source, sharekeys, param) : 0;
11027 struct xpvhv_aux *saux = HvAUX(sstr);
11028 struct xpvhv_aux *daux = HvAUX(dstr);
11029 /* This flag isn't copied. */
11030 /* SvOOK_on(hv) attacks the IV flags. */
11031 SvFLAGS(dstr) |= SVf_OOK;
11033 hvname = saux->xhv_name;
11034 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11036 daux->xhv_riter = saux->xhv_riter;
11037 daux->xhv_eiter = saux->xhv_eiter
11038 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11043 SvPV_set(dstr, Nullch);
11045 /* Record stashes for possible cloning in Perl_clone(). */
11047 av_push(param->stashes, dstr);
11051 SvANY(dstr) = new_XPVFM();
11052 FmLINES(dstr) = FmLINES(sstr);
11056 SvANY(dstr) = new_XPVCV();
11058 SvCUR_set(dstr, SvCUR(sstr));
11059 SvLEN_set(dstr, SvLEN(sstr));
11060 SvIV_set(dstr, SvIVX(sstr));
11061 SvNV_set(dstr, SvNVX(sstr));
11062 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11063 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11064 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11065 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11066 CvSTART(dstr) = CvSTART(sstr);
11068 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11070 CvXSUB(dstr) = CvXSUB(sstr);
11071 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11072 if (CvCONST(sstr)) {
11073 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11074 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11075 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11077 /* don't dup if copying back - CvGV isn't refcounted, so the
11078 * duped GV may never be freed. A bit of a hack! DAPM */
11079 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11080 Nullgv : gv_dup(CvGV(sstr), param) ;
11081 if (param->flags & CLONEf_COPY_STACKS) {
11082 CvDEPTH(dstr) = CvDEPTH(sstr);
11086 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11087 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11089 CvWEAKOUTSIDE(sstr)
11090 ? cv_dup( CvOUTSIDE(sstr), param)
11091 : cv_dup_inc(CvOUTSIDE(sstr), param);
11092 CvFLAGS(dstr) = CvFLAGS(sstr);
11093 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11096 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11100 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11106 /* duplicate a context */
11109 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11111 PERL_CONTEXT *ncxs;
11114 return (PERL_CONTEXT*)NULL;
11116 /* look for it in the table first */
11117 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11121 /* create anew and remember what it is */
11122 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11123 ptr_table_store(PL_ptr_table, cxs, ncxs);
11126 PERL_CONTEXT *cx = &cxs[ix];
11127 PERL_CONTEXT *ncx = &ncxs[ix];
11128 ncx->cx_type = cx->cx_type;
11129 if (CxTYPE(cx) == CXt_SUBST) {
11130 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11133 ncx->blk_oldsp = cx->blk_oldsp;
11134 ncx->blk_oldcop = cx->blk_oldcop;
11135 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11136 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11137 ncx->blk_oldpm = cx->blk_oldpm;
11138 ncx->blk_gimme = cx->blk_gimme;
11139 switch (CxTYPE(cx)) {
11141 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11142 ? cv_dup_inc(cx->blk_sub.cv, param)
11143 : cv_dup(cx->blk_sub.cv,param));
11144 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11145 ? av_dup_inc(cx->blk_sub.argarray, param)
11147 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11148 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11149 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11150 ncx->blk_sub.lval = cx->blk_sub.lval;
11151 ncx->blk_sub.retop = cx->blk_sub.retop;
11154 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11155 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11156 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11157 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11158 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11159 ncx->blk_eval.retop = cx->blk_eval.retop;
11162 ncx->blk_loop.label = cx->blk_loop.label;
11163 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11164 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11165 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11166 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11167 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11168 ? cx->blk_loop.iterdata
11169 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11170 ncx->blk_loop.oldcomppad
11171 = (PAD*)ptr_table_fetch(PL_ptr_table,
11172 cx->blk_loop.oldcomppad);
11173 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11174 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11175 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11176 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11177 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11180 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11181 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11182 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11183 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11184 ncx->blk_sub.retop = cx->blk_sub.retop;
11196 /* duplicate a stack info structure */
11199 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11204 return (PERL_SI*)NULL;
11206 /* look for it in the table first */
11207 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11211 /* create anew and remember what it is */
11212 Newz(56, nsi, 1, PERL_SI);
11213 ptr_table_store(PL_ptr_table, si, nsi);
11215 nsi->si_stack = av_dup_inc(si->si_stack, param);
11216 nsi->si_cxix = si->si_cxix;
11217 nsi->si_cxmax = si->si_cxmax;
11218 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11219 nsi->si_type = si->si_type;
11220 nsi->si_prev = si_dup(si->si_prev, param);
11221 nsi->si_next = si_dup(si->si_next, param);
11222 nsi->si_markoff = si->si_markoff;
11227 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11228 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11229 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11230 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11231 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11232 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11233 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11234 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11235 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11236 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11237 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11238 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11239 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11240 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11243 #define pv_dup_inc(p) SAVEPV(p)
11244 #define pv_dup(p) SAVEPV(p)
11245 #define svp_dup_inc(p,pp) any_dup(p,pp)
11247 /* map any object to the new equivent - either something in the
11248 * ptr table, or something in the interpreter structure
11252 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11257 return (void*)NULL;
11259 /* look for it in the table first */
11260 ret = ptr_table_fetch(PL_ptr_table, v);
11264 /* see if it is part of the interpreter structure */
11265 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11266 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11274 /* duplicate the save stack */
11277 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11279 ANY *ss = proto_perl->Tsavestack;
11280 I32 ix = proto_perl->Tsavestack_ix;
11281 I32 max = proto_perl->Tsavestack_max;
11293 void (*dptr) (void*);
11294 void (*dxptr) (pTHX_ void*);
11296 /* Unions for circumventing strict ANSI C89 casting rules. */
11297 union { void *vptr; void (*dptr)(void*); } u1, u2;
11298 union { void *vptr; void (*dxptr)(pTHX_ void*); } u3, u4;
11300 Newz(54, nss, max, ANY);
11303 I32 i = POPINT(ss,ix);
11304 TOPINT(nss,ix) = i;
11306 case SAVEt_ITEM: /* normal string */
11307 sv = (SV*)POPPTR(ss,ix);
11308 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11309 sv = (SV*)POPPTR(ss,ix);
11310 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11312 case SAVEt_SV: /* scalar reference */
11313 sv = (SV*)POPPTR(ss,ix);
11314 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11315 gv = (GV*)POPPTR(ss,ix);
11316 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11318 case SAVEt_GENERIC_PVREF: /* generic char* */
11319 c = (char*)POPPTR(ss,ix);
11320 TOPPTR(nss,ix) = pv_dup(c);
11321 ptr = POPPTR(ss,ix);
11322 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11324 case SAVEt_SHARED_PVREF: /* char* in shared space */
11325 c = (char*)POPPTR(ss,ix);
11326 TOPPTR(nss,ix) = savesharedpv(c);
11327 ptr = POPPTR(ss,ix);
11328 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11330 case SAVEt_GENERIC_SVREF: /* generic sv */
11331 case SAVEt_SVREF: /* scalar reference */
11332 sv = (SV*)POPPTR(ss,ix);
11333 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11334 ptr = POPPTR(ss,ix);
11335 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11337 case SAVEt_AV: /* array reference */
11338 av = (AV*)POPPTR(ss,ix);
11339 TOPPTR(nss,ix) = av_dup_inc(av, param);
11340 gv = (GV*)POPPTR(ss,ix);
11341 TOPPTR(nss,ix) = gv_dup(gv, param);
11343 case SAVEt_HV: /* hash reference */
11344 hv = (HV*)POPPTR(ss,ix);
11345 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11346 gv = (GV*)POPPTR(ss,ix);
11347 TOPPTR(nss,ix) = gv_dup(gv, param);
11349 case SAVEt_INT: /* int reference */
11350 ptr = POPPTR(ss,ix);
11351 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11352 intval = (int)POPINT(ss,ix);
11353 TOPINT(nss,ix) = intval;
11355 case SAVEt_LONG: /* long reference */
11356 ptr = POPPTR(ss,ix);
11357 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11358 longval = (long)POPLONG(ss,ix);
11359 TOPLONG(nss,ix) = longval;
11361 case SAVEt_I32: /* I32 reference */
11362 case SAVEt_I16: /* I16 reference */
11363 case SAVEt_I8: /* I8 reference */
11364 ptr = POPPTR(ss,ix);
11365 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11367 TOPINT(nss,ix) = i;
11369 case SAVEt_IV: /* IV reference */
11370 ptr = POPPTR(ss,ix);
11371 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11373 TOPIV(nss,ix) = iv;
11375 case SAVEt_SPTR: /* SV* reference */
11376 ptr = POPPTR(ss,ix);
11377 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11378 sv = (SV*)POPPTR(ss,ix);
11379 TOPPTR(nss,ix) = sv_dup(sv, param);
11381 case SAVEt_VPTR: /* random* reference */
11382 ptr = POPPTR(ss,ix);
11383 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11384 ptr = POPPTR(ss,ix);
11385 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11387 case SAVEt_PPTR: /* char* reference */
11388 ptr = POPPTR(ss,ix);
11389 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11390 c = (char*)POPPTR(ss,ix);
11391 TOPPTR(nss,ix) = pv_dup(c);
11393 case SAVEt_HPTR: /* HV* reference */
11394 ptr = POPPTR(ss,ix);
11395 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11396 hv = (HV*)POPPTR(ss,ix);
11397 TOPPTR(nss,ix) = hv_dup(hv, param);
11399 case SAVEt_APTR: /* AV* reference */
11400 ptr = POPPTR(ss,ix);
11401 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11402 av = (AV*)POPPTR(ss,ix);
11403 TOPPTR(nss,ix) = av_dup(av, param);
11406 gv = (GV*)POPPTR(ss,ix);
11407 TOPPTR(nss,ix) = gv_dup(gv, param);
11409 case SAVEt_GP: /* scalar reference */
11410 gp = (GP*)POPPTR(ss,ix);
11411 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11412 (void)GpREFCNT_inc(gp);
11413 gv = (GV*)POPPTR(ss,ix);
11414 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11415 c = (char*)POPPTR(ss,ix);
11416 TOPPTR(nss,ix) = pv_dup(c);
11418 TOPIV(nss,ix) = iv;
11420 TOPIV(nss,ix) = iv;
11423 case SAVEt_MORTALIZESV:
11424 sv = (SV*)POPPTR(ss,ix);
11425 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11428 ptr = POPPTR(ss,ix);
11429 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11430 /* these are assumed to be refcounted properly */
11431 switch (((OP*)ptr)->op_type) {
11433 case OP_LEAVESUBLV:
11437 case OP_LEAVEWRITE:
11438 TOPPTR(nss,ix) = ptr;
11443 TOPPTR(nss,ix) = Nullop;
11448 TOPPTR(nss,ix) = Nullop;
11451 c = (char*)POPPTR(ss,ix);
11452 TOPPTR(nss,ix) = pv_dup_inc(c);
11454 case SAVEt_CLEARSV:
11455 longval = POPLONG(ss,ix);
11456 TOPLONG(nss,ix) = longval;
11459 hv = (HV*)POPPTR(ss,ix);
11460 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11461 c = (char*)POPPTR(ss,ix);
11462 TOPPTR(nss,ix) = pv_dup_inc(c);
11464 TOPINT(nss,ix) = i;
11466 case SAVEt_DESTRUCTOR:
11467 ptr = POPPTR(ss,ix);
11468 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11469 dptr = POPDPTR(ss,ix);
11471 u2.vptr = any_dup(u1.vptr, proto_perl);
11472 TOPDPTR(nss,ix) = u2.dptr;
11474 case SAVEt_DESTRUCTOR_X:
11475 ptr = POPPTR(ss,ix);
11476 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11477 dxptr = POPDXPTR(ss,ix);
11479 u4.vptr = any_dup(u3.vptr, proto_perl);;
11480 TOPDXPTR(nss,ix) = u4.dxptr;
11482 case SAVEt_REGCONTEXT:
11485 TOPINT(nss,ix) = i;
11488 case SAVEt_STACK_POS: /* Position on Perl stack */
11490 TOPINT(nss,ix) = i;
11492 case SAVEt_AELEM: /* array element */
11493 sv = (SV*)POPPTR(ss,ix);
11494 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11496 TOPINT(nss,ix) = i;
11497 av = (AV*)POPPTR(ss,ix);
11498 TOPPTR(nss,ix) = av_dup_inc(av, param);
11500 case SAVEt_HELEM: /* hash element */
11501 sv = (SV*)POPPTR(ss,ix);
11502 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11503 sv = (SV*)POPPTR(ss,ix);
11504 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11505 hv = (HV*)POPPTR(ss,ix);
11506 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11509 ptr = POPPTR(ss,ix);
11510 TOPPTR(nss,ix) = ptr;
11514 TOPINT(nss,ix) = i;
11516 case SAVEt_COMPPAD:
11517 av = (AV*)POPPTR(ss,ix);
11518 TOPPTR(nss,ix) = av_dup(av, param);
11521 longval = (long)POPLONG(ss,ix);
11522 TOPLONG(nss,ix) = longval;
11523 ptr = POPPTR(ss,ix);
11524 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11525 sv = (SV*)POPPTR(ss,ix);
11526 TOPPTR(nss,ix) = sv_dup(sv, param);
11529 ptr = POPPTR(ss,ix);
11530 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11531 longval = (long)POPBOOL(ss,ix);
11532 TOPBOOL(nss,ix) = (bool)longval;
11534 case SAVEt_SET_SVFLAGS:
11536 TOPINT(nss,ix) = i;
11538 TOPINT(nss,ix) = i;
11539 sv = (SV*)POPPTR(ss,ix);
11540 TOPPTR(nss,ix) = sv_dup(sv, param);
11543 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11551 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11552 * flag to the result. This is done for each stash before cloning starts,
11553 * so we know which stashes want their objects cloned */
11556 do_mark_cloneable_stash(pTHX_ SV *sv)
11558 const HEK *hvname = HvNAME_HEK((HV*)sv);
11560 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11561 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11562 if (cloner && GvCV(cloner)) {
11569 XPUSHs(sv_2mortal(newSVhek(hvname)));
11571 call_sv((SV*)GvCV(cloner), G_SCALAR);
11578 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11586 =for apidoc perl_clone
11588 Create and return a new interpreter by cloning the current one.
11590 perl_clone takes these flags as parameters:
11592 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11593 without it we only clone the data and zero the stacks,
11594 with it we copy the stacks and the new perl interpreter is
11595 ready to run at the exact same point as the previous one.
11596 The pseudo-fork code uses COPY_STACKS while the
11597 threads->new doesn't.
11599 CLONEf_KEEP_PTR_TABLE
11600 perl_clone keeps a ptr_table with the pointer of the old
11601 variable as a key and the new variable as a value,
11602 this allows it to check if something has been cloned and not
11603 clone it again but rather just use the value and increase the
11604 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11605 the ptr_table using the function
11606 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11607 reason to keep it around is if you want to dup some of your own
11608 variable who are outside the graph perl scans, example of this
11609 code is in threads.xs create
11612 This is a win32 thing, it is ignored on unix, it tells perls
11613 win32host code (which is c++) to clone itself, this is needed on
11614 win32 if you want to run two threads at the same time,
11615 if you just want to do some stuff in a separate perl interpreter
11616 and then throw it away and return to the original one,
11617 you don't need to do anything.
11622 /* XXX the above needs expanding by someone who actually understands it ! */
11623 EXTERN_C PerlInterpreter *
11624 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11627 perl_clone(PerlInterpreter *proto_perl, UV flags)
11630 #ifdef PERL_IMPLICIT_SYS
11632 /* perlhost.h so we need to call into it
11633 to clone the host, CPerlHost should have a c interface, sky */
11635 if (flags & CLONEf_CLONE_HOST) {
11636 return perl_clone_host(proto_perl,flags);
11638 return perl_clone_using(proto_perl, flags,
11640 proto_perl->IMemShared,
11641 proto_perl->IMemParse,
11643 proto_perl->IStdIO,
11647 proto_perl->IProc);
11651 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11652 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11653 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11654 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11655 struct IPerlDir* ipD, struct IPerlSock* ipS,
11656 struct IPerlProc* ipP)
11658 /* XXX many of the string copies here can be optimized if they're
11659 * constants; they need to be allocated as common memory and just
11660 * their pointers copied. */
11663 CLONE_PARAMS clone_params;
11664 CLONE_PARAMS* param = &clone_params;
11666 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11667 /* for each stash, determine whether its objects should be cloned */
11668 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11669 PERL_SET_THX(my_perl);
11672 Poison(my_perl, 1, PerlInterpreter);
11674 PL_curcop = (COP *)Nullop;
11678 PL_savestack_ix = 0;
11679 PL_savestack_max = -1;
11680 PL_sig_pending = 0;
11681 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11682 # else /* !DEBUGGING */
11683 Zero(my_perl, 1, PerlInterpreter);
11684 # endif /* DEBUGGING */
11686 /* host pointers */
11688 PL_MemShared = ipMS;
11689 PL_MemParse = ipMP;
11696 #else /* !PERL_IMPLICIT_SYS */
11698 CLONE_PARAMS clone_params;
11699 CLONE_PARAMS* param = &clone_params;
11700 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11701 /* for each stash, determine whether its objects should be cloned */
11702 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11703 PERL_SET_THX(my_perl);
11706 Poison(my_perl, 1, PerlInterpreter);
11708 PL_curcop = (COP *)Nullop;
11712 PL_savestack_ix = 0;
11713 PL_savestack_max = -1;
11714 PL_sig_pending = 0;
11715 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11716 # else /* !DEBUGGING */
11717 Zero(my_perl, 1, PerlInterpreter);
11718 # endif /* DEBUGGING */
11719 #endif /* PERL_IMPLICIT_SYS */
11720 param->flags = flags;
11721 param->proto_perl = proto_perl;
11724 PL_xnv_arenaroot = NULL;
11725 PL_xnv_root = NULL;
11726 PL_xpv_arenaroot = NULL;
11727 PL_xpv_root = NULL;
11728 PL_xpviv_arenaroot = NULL;
11729 PL_xpviv_root = NULL;
11730 PL_xpvnv_arenaroot = NULL;
11731 PL_xpvnv_root = NULL;
11732 PL_xpvcv_arenaroot = NULL;
11733 PL_xpvcv_root = NULL;
11734 PL_xpvav_arenaroot = NULL;
11735 PL_xpvav_root = NULL;
11736 PL_xpvhv_arenaroot = NULL;
11737 PL_xpvhv_root = NULL;
11738 PL_xpvmg_arenaroot = NULL;
11739 PL_xpvmg_root = NULL;
11740 PL_xpvgv_arenaroot = NULL;
11741 PL_xpvgv_root = NULL;
11742 PL_xpvlv_arenaroot = NULL;
11743 PL_xpvlv_root = NULL;
11744 PL_xpvbm_arenaroot = NULL;
11745 PL_xpvbm_root = NULL;
11746 PL_he_arenaroot = NULL;
11748 #if defined(USE_ITHREADS)
11749 PL_pte_arenaroot = NULL;
11750 PL_pte_root = NULL;
11752 PL_nice_chunk = NULL;
11753 PL_nice_chunk_size = 0;
11755 PL_sv_objcount = 0;
11756 PL_sv_root = Nullsv;
11757 PL_sv_arenaroot = Nullsv;
11759 PL_debug = proto_perl->Idebug;
11761 PL_hash_seed = proto_perl->Ihash_seed;
11762 PL_rehash_seed = proto_perl->Irehash_seed;
11764 #ifdef USE_REENTRANT_API
11765 /* XXX: things like -Dm will segfault here in perlio, but doing
11766 * PERL_SET_CONTEXT(proto_perl);
11767 * breaks too many other things
11769 Perl_reentrant_init(aTHX);
11772 /* create SV map for pointer relocation */
11773 PL_ptr_table = ptr_table_new();
11774 /* and one for finding shared hash keys quickly */
11775 PL_shared_hek_table = ptr_table_new();
11777 /* initialize these special pointers as early as possible */
11778 SvANY(&PL_sv_undef) = NULL;
11779 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11780 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11781 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11783 SvANY(&PL_sv_no) = new_XPVNV();
11784 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11785 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11786 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11787 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11788 SvCUR_set(&PL_sv_no, 0);
11789 SvLEN_set(&PL_sv_no, 1);
11790 SvIV_set(&PL_sv_no, 0);
11791 SvNV_set(&PL_sv_no, 0);
11792 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11794 SvANY(&PL_sv_yes) = new_XPVNV();
11795 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11796 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11797 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11798 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11799 SvCUR_set(&PL_sv_yes, 1);
11800 SvLEN_set(&PL_sv_yes, 2);
11801 SvIV_set(&PL_sv_yes, 1);
11802 SvNV_set(&PL_sv_yes, 1);
11803 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11805 /* create (a non-shared!) shared string table */
11806 PL_strtab = newHV();
11807 HvSHAREKEYS_off(PL_strtab);
11808 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11809 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11811 PL_compiling = proto_perl->Icompiling;
11813 /* These two PVs will be free'd special way so must set them same way op.c does */
11814 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11815 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11817 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11818 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11820 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11821 if (!specialWARN(PL_compiling.cop_warnings))
11822 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11823 if (!specialCopIO(PL_compiling.cop_io))
11824 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11825 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11827 /* pseudo environmental stuff */
11828 PL_origargc = proto_perl->Iorigargc;
11829 PL_origargv = proto_perl->Iorigargv;
11831 param->stashes = newAV(); /* Setup array of objects to call clone on */
11833 #ifdef PERLIO_LAYERS
11834 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11835 PerlIO_clone(aTHX_ proto_perl, param);
11838 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11839 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11840 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11841 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11842 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11843 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11846 PL_minus_c = proto_perl->Iminus_c;
11847 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11848 PL_localpatches = proto_perl->Ilocalpatches;
11849 PL_splitstr = proto_perl->Isplitstr;
11850 PL_preprocess = proto_perl->Ipreprocess;
11851 PL_minus_n = proto_perl->Iminus_n;
11852 PL_minus_p = proto_perl->Iminus_p;
11853 PL_minus_l = proto_perl->Iminus_l;
11854 PL_minus_a = proto_perl->Iminus_a;
11855 PL_minus_F = proto_perl->Iminus_F;
11856 PL_doswitches = proto_perl->Idoswitches;
11857 PL_dowarn = proto_perl->Idowarn;
11858 PL_doextract = proto_perl->Idoextract;
11859 PL_sawampersand = proto_perl->Isawampersand;
11860 PL_unsafe = proto_perl->Iunsafe;
11861 PL_inplace = SAVEPV(proto_perl->Iinplace);
11862 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11863 PL_perldb = proto_perl->Iperldb;
11864 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11865 PL_exit_flags = proto_perl->Iexit_flags;
11867 /* magical thingies */
11868 /* XXX time(&PL_basetime) when asked for? */
11869 PL_basetime = proto_perl->Ibasetime;
11870 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11872 PL_maxsysfd = proto_perl->Imaxsysfd;
11873 PL_multiline = proto_perl->Imultiline;
11874 PL_statusvalue = proto_perl->Istatusvalue;
11876 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11878 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11880 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11881 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11882 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11884 /* Clone the regex array */
11885 PL_regex_padav = newAV();
11887 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11888 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11890 av_push(PL_regex_padav,
11891 sv_dup_inc(regexen[0],param));
11892 for(i = 1; i <= len; i++) {
11893 if(SvREPADTMP(regexen[i])) {
11894 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11896 av_push(PL_regex_padav,
11898 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11899 SvIVX(regexen[i])), param)))
11904 PL_regex_pad = AvARRAY(PL_regex_padav);
11906 /* shortcuts to various I/O objects */
11907 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11908 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11909 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11910 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11911 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11912 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11914 /* shortcuts to regexp stuff */
11915 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11917 /* shortcuts to misc objects */
11918 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11920 /* shortcuts to debugging objects */
11921 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11922 PL_DBline = gv_dup(proto_perl->IDBline, param);
11923 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11924 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11925 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11926 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11927 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11928 PL_lineary = av_dup(proto_perl->Ilineary, param);
11929 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11931 /* symbol tables */
11932 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11933 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11934 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11935 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11936 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11938 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11939 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11940 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11941 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11942 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11943 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11945 PL_sub_generation = proto_perl->Isub_generation;
11947 /* funky return mechanisms */
11948 PL_forkprocess = proto_perl->Iforkprocess;
11950 /* subprocess state */
11951 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11953 /* internal state */
11954 PL_tainting = proto_perl->Itainting;
11955 PL_taint_warn = proto_perl->Itaint_warn;
11956 PL_maxo = proto_perl->Imaxo;
11957 if (proto_perl->Iop_mask)
11958 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11960 PL_op_mask = Nullch;
11961 /* PL_asserting = proto_perl->Iasserting; */
11963 /* current interpreter roots */
11964 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11965 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11966 PL_main_start = proto_perl->Imain_start;
11967 PL_eval_root = proto_perl->Ieval_root;
11968 PL_eval_start = proto_perl->Ieval_start;
11970 /* runtime control stuff */
11971 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11972 PL_copline = proto_perl->Icopline;
11974 PL_filemode = proto_perl->Ifilemode;
11975 PL_lastfd = proto_perl->Ilastfd;
11976 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11979 PL_gensym = proto_perl->Igensym;
11980 PL_preambled = proto_perl->Ipreambled;
11981 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11982 PL_laststatval = proto_perl->Ilaststatval;
11983 PL_laststype = proto_perl->Ilaststype;
11984 PL_mess_sv = Nullsv;
11986 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11987 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11989 /* interpreter atexit processing */
11990 PL_exitlistlen = proto_perl->Iexitlistlen;
11991 if (PL_exitlistlen) {
11992 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11993 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11996 PL_exitlist = (PerlExitListEntry*)NULL;
11997 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11998 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11999 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12001 PL_profiledata = NULL;
12002 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
12003 /* PL_rsfp_filters entries have fake IoDIRP() */
12004 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
12006 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12008 PAD_CLONE_VARS(proto_perl, param);
12010 #ifdef HAVE_INTERP_INTERN
12011 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12014 /* more statics moved here */
12015 PL_generation = proto_perl->Igeneration;
12016 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12018 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12019 PL_in_clean_all = proto_perl->Iin_clean_all;
12021 PL_uid = proto_perl->Iuid;
12022 PL_euid = proto_perl->Ieuid;
12023 PL_gid = proto_perl->Igid;
12024 PL_egid = proto_perl->Iegid;
12025 PL_nomemok = proto_perl->Inomemok;
12026 PL_an = proto_perl->Ian;
12027 PL_evalseq = proto_perl->Ievalseq;
12028 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12029 PL_origalen = proto_perl->Iorigalen;
12030 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12031 PL_osname = SAVEPV(proto_perl->Iosname);
12032 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12033 PL_sighandlerp = proto_perl->Isighandlerp;
12036 PL_runops = proto_perl->Irunops;
12038 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12041 PL_cshlen = proto_perl->Icshlen;
12042 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12045 PL_lex_state = proto_perl->Ilex_state;
12046 PL_lex_defer = proto_perl->Ilex_defer;
12047 PL_lex_expect = proto_perl->Ilex_expect;
12048 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12049 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12050 PL_lex_starts = proto_perl->Ilex_starts;
12051 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12052 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12053 PL_lex_op = proto_perl->Ilex_op;
12054 PL_lex_inpat = proto_perl->Ilex_inpat;
12055 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12056 PL_lex_brackets = proto_perl->Ilex_brackets;
12057 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12058 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12059 PL_lex_casemods = proto_perl->Ilex_casemods;
12060 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12061 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12063 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12064 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12065 PL_nexttoke = proto_perl->Inexttoke;
12067 /* XXX This is probably masking the deeper issue of why
12068 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12069 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12070 * (A little debugging with a watchpoint on it may help.)
12072 if (SvANY(proto_perl->Ilinestr)) {
12073 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12074 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12075 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12076 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12077 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12078 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12079 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12080 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12081 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12084 PL_linestr = NEWSV(65,79);
12085 sv_upgrade(PL_linestr,SVt_PVIV);
12086 sv_setpvn(PL_linestr,"",0);
12087 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12089 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12090 PL_pending_ident = proto_perl->Ipending_ident;
12091 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12093 PL_expect = proto_perl->Iexpect;
12095 PL_multi_start = proto_perl->Imulti_start;
12096 PL_multi_end = proto_perl->Imulti_end;
12097 PL_multi_open = proto_perl->Imulti_open;
12098 PL_multi_close = proto_perl->Imulti_close;
12100 PL_error_count = proto_perl->Ierror_count;
12101 PL_subline = proto_perl->Isubline;
12102 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12104 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12105 if (SvANY(proto_perl->Ilinestr)) {
12106 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12107 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12108 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12109 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12110 PL_last_lop_op = proto_perl->Ilast_lop_op;
12113 PL_last_uni = SvPVX(PL_linestr);
12114 PL_last_lop = SvPVX(PL_linestr);
12115 PL_last_lop_op = 0;
12117 PL_in_my = proto_perl->Iin_my;
12118 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12120 PL_cryptseen = proto_perl->Icryptseen;
12123 PL_hints = proto_perl->Ihints;
12125 PL_amagic_generation = proto_perl->Iamagic_generation;
12127 #ifdef USE_LOCALE_COLLATE
12128 PL_collation_ix = proto_perl->Icollation_ix;
12129 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12130 PL_collation_standard = proto_perl->Icollation_standard;
12131 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12132 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12133 #endif /* USE_LOCALE_COLLATE */
12135 #ifdef USE_LOCALE_NUMERIC
12136 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12137 PL_numeric_standard = proto_perl->Inumeric_standard;
12138 PL_numeric_local = proto_perl->Inumeric_local;
12139 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12140 #endif /* !USE_LOCALE_NUMERIC */
12142 /* utf8 character classes */
12143 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12144 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12145 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12146 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12147 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12148 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12149 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12150 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12151 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12152 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12153 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12154 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12155 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12156 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12157 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12158 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12159 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12160 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12161 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12162 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12164 /* Did the locale setup indicate UTF-8? */
12165 PL_utf8locale = proto_perl->Iutf8locale;
12166 /* Unicode features (see perlrun/-C) */
12167 PL_unicode = proto_perl->Iunicode;
12169 /* Pre-5.8 signals control */
12170 PL_signals = proto_perl->Isignals;
12172 /* times() ticks per second */
12173 PL_clocktick = proto_perl->Iclocktick;
12175 /* Recursion stopper for PerlIO_find_layer */
12176 PL_in_load_module = proto_perl->Iin_load_module;
12178 /* sort() routine */
12179 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12181 /* Not really needed/useful since the reenrant_retint is "volatile",
12182 * but do it for consistency's sake. */
12183 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12185 /* Hooks to shared SVs and locks. */
12186 PL_sharehook = proto_perl->Isharehook;
12187 PL_lockhook = proto_perl->Ilockhook;
12188 PL_unlockhook = proto_perl->Iunlockhook;
12189 PL_threadhook = proto_perl->Ithreadhook;
12191 PL_runops_std = proto_perl->Irunops_std;
12192 PL_runops_dbg = proto_perl->Irunops_dbg;
12194 #ifdef THREADS_HAVE_PIDS
12195 PL_ppid = proto_perl->Ippid;
12199 PL_last_swash_hv = Nullhv; /* reinits on demand */
12200 PL_last_swash_klen = 0;
12201 PL_last_swash_key[0]= '\0';
12202 PL_last_swash_tmps = (U8*)NULL;
12203 PL_last_swash_slen = 0;
12205 PL_glob_index = proto_perl->Iglob_index;
12206 PL_srand_called = proto_perl->Isrand_called;
12207 PL_uudmap['M'] = 0; /* reinits on demand */
12208 PL_bitcount = Nullch; /* reinits on demand */
12210 if (proto_perl->Ipsig_pend) {
12211 Newz(0, PL_psig_pend, SIG_SIZE, int);
12214 PL_psig_pend = (int*)NULL;
12217 if (proto_perl->Ipsig_ptr) {
12218 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12219 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12220 for (i = 1; i < SIG_SIZE; i++) {
12221 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12222 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12226 PL_psig_ptr = (SV**)NULL;
12227 PL_psig_name = (SV**)NULL;
12230 /* thrdvar.h stuff */
12232 if (flags & CLONEf_COPY_STACKS) {
12233 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12234 PL_tmps_ix = proto_perl->Ttmps_ix;
12235 PL_tmps_max = proto_perl->Ttmps_max;
12236 PL_tmps_floor = proto_perl->Ttmps_floor;
12237 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12239 while (i <= PL_tmps_ix) {
12240 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12244 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12245 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12246 Newz(54, PL_markstack, i, I32);
12247 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12248 - proto_perl->Tmarkstack);
12249 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12250 - proto_perl->Tmarkstack);
12251 Copy(proto_perl->Tmarkstack, PL_markstack,
12252 PL_markstack_ptr - PL_markstack + 1, I32);
12254 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12255 * NOTE: unlike the others! */
12256 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12257 PL_scopestack_max = proto_perl->Tscopestack_max;
12258 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12259 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12261 /* NOTE: si_dup() looks at PL_markstack */
12262 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12264 /* PL_curstack = PL_curstackinfo->si_stack; */
12265 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12266 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12268 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12269 PL_stack_base = AvARRAY(PL_curstack);
12270 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12271 - proto_perl->Tstack_base);
12272 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12274 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12275 * NOTE: unlike the others! */
12276 PL_savestack_ix = proto_perl->Tsavestack_ix;
12277 PL_savestack_max = proto_perl->Tsavestack_max;
12278 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12279 PL_savestack = ss_dup(proto_perl, param);
12283 ENTER; /* perl_destruct() wants to LEAVE; */
12286 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12287 PL_top_env = &PL_start_env;
12289 PL_op = proto_perl->Top;
12292 PL_Xpv = (XPV*)NULL;
12293 PL_na = proto_perl->Tna;
12295 PL_statbuf = proto_perl->Tstatbuf;
12296 PL_statcache = proto_perl->Tstatcache;
12297 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12298 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12300 PL_timesbuf = proto_perl->Ttimesbuf;
12303 PL_tainted = proto_perl->Ttainted;
12304 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12305 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12306 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12307 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12308 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12309 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12310 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12311 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12312 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12314 PL_restartop = proto_perl->Trestartop;
12315 PL_in_eval = proto_perl->Tin_eval;
12316 PL_delaymagic = proto_perl->Tdelaymagic;
12317 PL_dirty = proto_perl->Tdirty;
12318 PL_localizing = proto_perl->Tlocalizing;
12320 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12321 PL_hv_fetch_ent_mh = Nullhe;
12322 PL_modcount = proto_perl->Tmodcount;
12323 PL_lastgotoprobe = Nullop;
12324 PL_dumpindent = proto_perl->Tdumpindent;
12326 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12327 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12328 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12329 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12330 PL_sortcxix = proto_perl->Tsortcxix;
12331 PL_efloatbuf = Nullch; /* reinits on demand */
12332 PL_efloatsize = 0; /* reinits on demand */
12336 PL_screamfirst = NULL;
12337 PL_screamnext = NULL;
12338 PL_maxscream = -1; /* reinits on demand */
12339 PL_lastscream = Nullsv;
12341 PL_watchaddr = NULL;
12342 PL_watchok = Nullch;
12344 PL_regdummy = proto_perl->Tregdummy;
12345 PL_regprecomp = Nullch;
12348 PL_colorset = 0; /* reinits PL_colors[] */
12349 /*PL_colors[6] = {0,0,0,0,0,0};*/
12350 PL_reginput = Nullch;
12351 PL_regbol = Nullch;
12352 PL_regeol = Nullch;
12353 PL_regstartp = (I32*)NULL;
12354 PL_regendp = (I32*)NULL;
12355 PL_reglastparen = (U32*)NULL;
12356 PL_reglastcloseparen = (U32*)NULL;
12357 PL_regtill = Nullch;
12358 PL_reg_start_tmp = (char**)NULL;
12359 PL_reg_start_tmpl = 0;
12360 PL_regdata = (struct reg_data*)NULL;
12363 PL_reg_eval_set = 0;
12365 PL_regprogram = (regnode*)NULL;
12367 PL_regcc = (CURCUR*)NULL;
12368 PL_reg_call_cc = (struct re_cc_state*)NULL;
12369 PL_reg_re = (regexp*)NULL;
12370 PL_reg_ganch = Nullch;
12371 PL_reg_sv = Nullsv;
12372 PL_reg_match_utf8 = FALSE;
12373 PL_reg_magic = (MAGIC*)NULL;
12375 PL_reg_oldcurpm = (PMOP*)NULL;
12376 PL_reg_curpm = (PMOP*)NULL;
12377 PL_reg_oldsaved = Nullch;
12378 PL_reg_oldsavedlen = 0;
12379 #ifdef PERL_COPY_ON_WRITE
12382 PL_reg_maxiter = 0;
12383 PL_reg_leftiter = 0;
12384 PL_reg_poscache = Nullch;
12385 PL_reg_poscache_size= 0;
12387 /* RE engine - function pointers */
12388 PL_regcompp = proto_perl->Tregcompp;
12389 PL_regexecp = proto_perl->Tregexecp;
12390 PL_regint_start = proto_perl->Tregint_start;
12391 PL_regint_string = proto_perl->Tregint_string;
12392 PL_regfree = proto_perl->Tregfree;
12394 PL_reginterp_cnt = 0;
12395 PL_reg_starttry = 0;
12397 /* Pluggable optimizer */
12398 PL_peepp = proto_perl->Tpeepp;
12400 PL_stashcache = newHV();
12402 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12403 ptr_table_free(PL_ptr_table);
12404 PL_ptr_table = NULL;
12405 ptr_table_free(PL_shared_hek_table);
12406 PL_shared_hek_table = NULL;
12409 /* Call the ->CLONE method, if it exists, for each of the stashes
12410 identified by sv_dup() above.
12412 while(av_len(param->stashes) != -1) {
12413 HV* stash = (HV*) av_shift(param->stashes);
12414 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12415 if (cloner && GvCV(cloner)) {
12420 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12422 call_sv((SV*)GvCV(cloner), G_DISCARD);
12428 SvREFCNT_dec(param->stashes);
12430 /* orphaned? eg threads->new inside BEGIN or use */
12431 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12432 (void)SvREFCNT_inc(PL_compcv);
12433 SAVEFREESV(PL_compcv);
12439 #endif /* USE_ITHREADS */
12442 =head1 Unicode Support
12444 =for apidoc sv_recode_to_utf8
12446 The encoding is assumed to be an Encode object, on entry the PV
12447 of the sv is assumed to be octets in that encoding, and the sv
12448 will be converted into Unicode (and UTF-8).
12450 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12451 is not a reference, nothing is done to the sv. If the encoding is not
12452 an C<Encode::XS> Encoding object, bad things will happen.
12453 (See F<lib/encoding.pm> and L<Encode>).
12455 The PV of the sv is returned.
12460 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12463 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12477 Passing sv_yes is wrong - it needs to be or'ed set of constants
12478 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12479 remove converted chars from source.
12481 Both will default the value - let them.
12483 XPUSHs(&PL_sv_yes);
12486 call_method("decode", G_SCALAR);
12490 s = SvPV(uni, len);
12491 if (s != SvPVX_const(sv)) {
12492 SvGROW(sv, len + 1);
12493 Move(s, SvPVX_const(sv), len, char);
12494 SvCUR_set(sv, len);
12495 SvPVX(sv)[len] = 0;
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: