3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
219 /* new_SV(): return a new, empty SV head */
221 #ifdef DEBUG_LEAKING_SCALARS
222 /* provide a real function for a debugger to play with */
232 sv = S_more_sv(aTHX);
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
250 # define new_SV(p) (p)=S_new_SV(aTHX)
259 (p) = S_more_sv(aTHX); \
268 /* del_SV(): return an empty SV head to the free list */
283 S_del_sv(pTHX_ SV *p)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
290 SV *svend = &sva[SvREFCNT(sva)];
291 if (p >= sv && p < svend) {
297 if (ckWARN_d(WARN_INTERNAL))
298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
307 #else /* ! DEBUGGING */
309 #define del_SV(p) plant_SV(p)
311 #endif /* DEBUGGING */
315 =head1 SV Manipulation Functions
317 =for apidoc sv_add_arena
319 Given a chunk of memory, link it to the head of the list of arenas,
320 and split it into a list of free SVs.
326 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
332 /* The first SV in an arena isn't an SV. */
333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
340 svend = &sva[SvREFCNT(sva) - 1];
343 SvANY(sv) = (void *)(SV*)(sv + 1);
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
349 SvFLAGS(sv) = SVTYPEMASK;
356 SvFLAGS(sv) = SVTYPEMASK;
359 /* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
363 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
369 register SV * const svend = &sva[SvREFCNT(sva)];
371 for (sv = sva + 1; sv < svend; ++sv) {
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
386 /* called by sv_report_used() for each live SV */
389 do_report_used(pTHX_ SV *sv)
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
399 =for apidoc sv_report_used
401 Dump the contents of all SVs not yet freed. (Debugging aid).
407 Perl_sv_report_used(pTHX)
410 visit(do_report_used, 0, 0);
414 /* called by sv_clean_objs() for each live SV */
417 do_clean_objs(pTHX_ SV *sv)
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
434 /* XXX Might want to check arrays, etc. */
437 /* called by sv_clean_objs() for each live SV */
439 #ifndef DISABLE_DESTRUCTOR_KLUDGE
441 do_clean_named_objs(pTHX_ SV *sv)
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
451 SvFLAGS(sv) |= SVf_BREAK;
459 =for apidoc sv_clean_objs
461 Attempt to destroy all objects not yet freed
467 Perl_sv_clean_objs(pTHX)
469 PL_in_clean_objs = TRUE;
470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
471 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 /* some barnacles may yet remain, clinging to typeglobs */
473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
475 PL_in_clean_objs = FALSE;
478 /* called by sv_clean_all() for each live SV */
481 do_clean_all(pTHX_ SV *sv)
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
485 if (PL_comppad == (AV*)sv) {
487 PL_curpad = Null(SV**);
493 =for apidoc sv_clean_all
495 Decrement the refcnt of each remaining SV, possibly triggering a
496 cleanup. This function may have to be called multiple times to free
497 SVs which are in complex self-referential hierarchies.
503 Perl_sv_clean_all(pTHX)
506 PL_in_clean_all = TRUE;
507 cleaned = visit(do_clean_all, 0,0);
508 PL_in_clean_all = FALSE;
513 =for apidoc sv_free_arenas
515 Deallocate the memory used by all arenas. Note that all the individual SV
516 heads and bodies within the arenas must already have been freed.
522 Perl_sv_free_arenas(pTHX)
526 void *arena, *arenanext;
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = *(void **)arena;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
548 arenanext = *(void **)arena;
551 PL_xpv_arenaroot = 0;
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
558 PL_xpviv_arenaroot = 0;
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
565 PL_xpvnv_arenaroot = 0;
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
572 PL_xpvcv_arenaroot = 0;
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
579 PL_xpvav_arenaroot = 0;
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
586 PL_xpvhv_arenaroot = 0;
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
593 PL_xpvmg_arenaroot = 0;
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
600 PL_xpvgv_arenaroot = 0;
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
614 PL_xpvbm_arenaroot = 0;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
628 #if defined(USE_ITHREADS)
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
637 PL_pte_arenaroot = 0;
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
649 /* ---------------------------------------------------------------------
651 * support functions for report_uninit()
654 /* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
657 #define FUV_MAX_SEARCH_SIZE 1000
659 /* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
663 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
675 for (i=HvMAX(hv); i>0; i--) {
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
693 /* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
697 S_find_array_subscript(pTHX_ AV *av, SV* val)
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
713 /* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
719 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
725 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
726 SV* keyname, I32 aindex, int subscript_type)
731 SV * const name = sv_newmortal();
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
743 else if (!(p=HvNAME_get(hv)))
745 if (strNE(p, "main")) {
747 sv_catpvn(name,"::", 2);
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
760 CV *cv = find_runcv(&u);
763 if (!cv || !CvPADLIST(cv))
765 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
766 sv = *av_fetch(av, targ, FALSE);
767 /* SvLEN in a pad name is not to be trusted */
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 */
2251 const char *s, *end;
2252 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
2255 if (ch & 128 && !isPRINT_LC(ch)) {
2264 else if (ch == '\r') {
2268 else if (ch == '\f') {
2272 else if (ch == '\\') {
2276 else if (ch == '\0') {
2280 else if (isPRINT_LC(ch))
2297 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2298 "Argument \"%s\" isn't numeric in %s", pv,
2301 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2302 "Argument \"%s\" isn't numeric", pv);
2306 =for apidoc looks_like_number
2308 Test if the content of an SV looks like a number (or is a number).
2309 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2310 non-numeric warning), even if your atof() doesn't grok them.
2316 Perl_looks_like_number(pTHX_ SV *sv)
2318 register const char *sbegin;
2322 sbegin = SvPVX_const(sv);
2325 else if (SvPOKp(sv))
2326 sbegin = SvPV_const(sv, len);
2328 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2329 return grok_number(sbegin, len, NULL);
2332 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2333 until proven guilty, assume that things are not that bad... */
2338 As 64 bit platforms often have an NV that doesn't preserve all bits of
2339 an IV (an assumption perl has been based on to date) it becomes necessary
2340 to remove the assumption that the NV always carries enough precision to
2341 recreate the IV whenever needed, and that the NV is the canonical form.
2342 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2343 precision as a side effect of conversion (which would lead to insanity
2344 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2345 1) to distinguish between IV/UV/NV slots that have cached a valid
2346 conversion where precision was lost and IV/UV/NV slots that have a
2347 valid conversion which has lost no precision
2348 2) to ensure that if a numeric conversion to one form is requested that
2349 would lose precision, the precise conversion (or differently
2350 imprecise conversion) is also performed and cached, to prevent
2351 requests for different numeric formats on the same SV causing
2352 lossy conversion chains. (lossless conversion chains are perfectly
2357 SvIOKp is true if the IV slot contains a valid value
2358 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2359 SvNOKp is true if the NV slot contains a valid value
2360 SvNOK is true only if the NV value is accurate
2363 while converting from PV to NV, check to see if converting that NV to an
2364 IV(or UV) would lose accuracy over a direct conversion from PV to
2365 IV(or UV). If it would, cache both conversions, return NV, but mark
2366 SV as IOK NOKp (ie not NOK).
2368 While converting from PV to IV, check to see if converting that IV to an
2369 NV would lose accuracy over a direct conversion from PV to NV. If it
2370 would, cache both conversions, flag similarly.
2372 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2373 correctly because if IV & NV were set NV *always* overruled.
2374 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2375 changes - now IV and NV together means that the two are interchangeable:
2376 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2378 The benefit of this is that operations such as pp_add know that if
2379 SvIOK is true for both left and right operands, then integer addition
2380 can be used instead of floating point (for cases where the result won't
2381 overflow). Before, floating point was always used, which could lead to
2382 loss of precision compared with integer addition.
2384 * making IV and NV equal status should make maths accurate on 64 bit
2386 * may speed up maths somewhat if pp_add and friends start to use
2387 integers when possible instead of fp. (Hopefully the overhead in
2388 looking for SvIOK and checking for overflow will not outweigh the
2389 fp to integer speedup)
2390 * will slow down integer operations (callers of SvIV) on "inaccurate"
2391 values, as the change from SvIOK to SvIOKp will cause a call into
2392 sv_2iv each time rather than a macro access direct to the IV slot
2393 * should speed up number->string conversion on integers as IV is
2394 favoured when IV and NV are equally accurate
2396 ####################################################################
2397 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2398 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2399 On the other hand, SvUOK is true iff UV.
2400 ####################################################################
2402 Your mileage will vary depending your CPU's relative fp to integer
2406 #ifndef NV_PRESERVES_UV
2407 # define IS_NUMBER_UNDERFLOW_IV 1
2408 # define IS_NUMBER_UNDERFLOW_UV 2
2409 # define IS_NUMBER_IV_AND_UV 2
2410 # define IS_NUMBER_OVERFLOW_IV 4
2411 # define IS_NUMBER_OVERFLOW_UV 5
2413 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2415 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2417 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2419 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2420 if (SvNVX(sv) < (NV)IV_MIN) {
2421 (void)SvIOKp_on(sv);
2423 SvIV_set(sv, IV_MIN);
2424 return IS_NUMBER_UNDERFLOW_IV;
2426 if (SvNVX(sv) > (NV)UV_MAX) {
2427 (void)SvIOKp_on(sv);
2430 SvUV_set(sv, UV_MAX);
2431 return IS_NUMBER_OVERFLOW_UV;
2433 (void)SvIOKp_on(sv);
2435 /* Can't use strtol etc to convert this string. (See truth table in
2437 if (SvNVX(sv) <= (UV)IV_MAX) {
2438 SvIV_set(sv, I_V(SvNVX(sv)));
2439 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2440 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2442 /* Integer is imprecise. NOK, IOKp */
2444 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2447 SvUV_set(sv, U_V(SvNVX(sv)));
2448 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2449 if (SvUVX(sv) == UV_MAX) {
2450 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2451 possibly be preserved by NV. Hence, it must be overflow.
2453 return IS_NUMBER_OVERFLOW_UV;
2455 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2457 /* Integer is imprecise. NOK, IOKp */
2459 return IS_NUMBER_OVERFLOW_IV;
2461 #endif /* !NV_PRESERVES_UV*/
2463 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2464 * this function provided for binary compatibility only
2468 Perl_sv_2iv(pTHX_ register SV *sv)
2470 return sv_2iv_flags(sv, SV_GMAGIC);
2474 =for apidoc sv_2iv_flags
2476 Return the integer value of an SV, doing any necessary string
2477 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2478 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2484 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2488 if (SvGMAGICAL(sv)) {
2489 if (flags & SV_GMAGIC)
2494 return I_V(SvNVX(sv));
2496 if (SvPOKp(sv) && SvLEN(sv))
2499 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2500 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2506 if (SvTHINKFIRST(sv)) {
2509 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2510 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2511 return SvIV(tmpstr);
2512 return PTR2IV(SvRV(sv));
2515 sv_force_normal_flags(sv, 0);
2517 if (SvREADONLY(sv) && !SvOK(sv)) {
2518 if (ckWARN(WARN_UNINITIALIZED))
2525 return (IV)(SvUVX(sv));
2532 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2533 * without also getting a cached IV/UV from it at the same time
2534 * (ie PV->NV conversion should detect loss of accuracy and cache
2535 * IV or UV at same time to avoid this. NWC */
2537 if (SvTYPE(sv) == SVt_NV)
2538 sv_upgrade(sv, SVt_PVNV);
2540 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2541 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2542 certainly cast into the IV range at IV_MAX, whereas the correct
2543 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2545 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2546 SvIV_set(sv, I_V(SvNVX(sv)));
2547 if (SvNVX(sv) == (NV) SvIVX(sv)
2548 #ifndef NV_PRESERVES_UV
2549 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2550 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2551 /* Don't flag it as "accurately an integer" if the number
2552 came from a (by definition imprecise) NV operation, and
2553 we're outside the range of NV integer precision */
2556 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2557 DEBUG_c(PerlIO_printf(Perl_debug_log,
2558 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2564 /* IV not precise. No need to convert from PV, as NV
2565 conversion would already have cached IV if it detected
2566 that PV->IV would be better than PV->NV->IV
2567 flags already correct - don't set public IOK. */
2568 DEBUG_c(PerlIO_printf(Perl_debug_log,
2569 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2574 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2575 but the cast (NV)IV_MIN rounds to a the value less (more
2576 negative) than IV_MIN which happens to be equal to SvNVX ??
2577 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2578 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2579 (NV)UVX == NVX are both true, but the values differ. :-(
2580 Hopefully for 2s complement IV_MIN is something like
2581 0x8000000000000000 which will be exact. NWC */
2584 SvUV_set(sv, U_V(SvNVX(sv)));
2586 (SvNVX(sv) == (NV) SvUVX(sv))
2587 #ifndef NV_PRESERVES_UV
2588 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2589 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2590 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2591 /* Don't flag it as "accurately an integer" if the number
2592 came from a (by definition imprecise) NV operation, and
2593 we're outside the range of NV integer precision */
2599 DEBUG_c(PerlIO_printf(Perl_debug_log,
2600 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2604 return (IV)SvUVX(sv);
2607 else if (SvPOKp(sv) && SvLEN(sv)) {
2609 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2610 /* We want to avoid a possible problem when we cache an IV which
2611 may be later translated to an NV, and the resulting NV is not
2612 the same as the direct translation of the initial string
2613 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2614 be careful to ensure that the value with the .456 is around if the
2615 NV value is requested in the future).
2617 This means that if we cache such an IV, we need to cache the
2618 NV as well. Moreover, we trade speed for space, and do not
2619 cache the NV if we are sure it's not needed.
2622 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2623 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2624 == IS_NUMBER_IN_UV) {
2625 /* It's definitely an integer, only upgrade to PVIV */
2626 if (SvTYPE(sv) < SVt_PVIV)
2627 sv_upgrade(sv, SVt_PVIV);
2629 } else if (SvTYPE(sv) < SVt_PVNV)
2630 sv_upgrade(sv, SVt_PVNV);
2632 /* If NV preserves UV then we only use the UV value if we know that
2633 we aren't going to call atof() below. If NVs don't preserve UVs
2634 then the value returned may have more precision than atof() will
2635 return, even though value isn't perfectly accurate. */
2636 if ((numtype & (IS_NUMBER_IN_UV
2637 #ifdef NV_PRESERVES_UV
2640 )) == IS_NUMBER_IN_UV) {
2641 /* This won't turn off the public IOK flag if it was set above */
2642 (void)SvIOKp_on(sv);
2644 if (!(numtype & IS_NUMBER_NEG)) {
2646 if (value <= (UV)IV_MAX) {
2647 SvIV_set(sv, (IV)value);
2649 SvUV_set(sv, value);
2653 /* 2s complement assumption */
2654 if (value <= (UV)IV_MIN) {
2655 SvIV_set(sv, -(IV)value);
2657 /* Too negative for an IV. This is a double upgrade, but
2658 I'm assuming it will be rare. */
2659 if (SvTYPE(sv) < SVt_PVNV)
2660 sv_upgrade(sv, SVt_PVNV);
2664 SvNV_set(sv, -(NV)value);
2665 SvIV_set(sv, IV_MIN);
2669 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2670 will be in the previous block to set the IV slot, and the next
2671 block to set the NV slot. So no else here. */
2673 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2674 != IS_NUMBER_IN_UV) {
2675 /* It wasn't an (integer that doesn't overflow the UV). */
2676 SvNV_set(sv, Atof(SvPVX_const(sv)));
2678 if (! numtype && ckWARN(WARN_NUMERIC))
2681 #if defined(USE_LONG_DOUBLE)
2682 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2683 PTR2UV(sv), SvNVX(sv)));
2685 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2686 PTR2UV(sv), SvNVX(sv)));
2690 #ifdef NV_PRESERVES_UV
2691 (void)SvIOKp_on(sv);
2693 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2694 SvIV_set(sv, I_V(SvNVX(sv)));
2695 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2698 /* Integer is imprecise. NOK, IOKp */
2700 /* UV will not work better than IV */
2702 if (SvNVX(sv) > (NV)UV_MAX) {
2704 /* Integer is inaccurate. NOK, IOKp, is UV */
2705 SvUV_set(sv, UV_MAX);
2708 SvUV_set(sv, U_V(SvNVX(sv)));
2709 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2710 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2714 /* Integer is imprecise. NOK, IOKp, is UV */
2720 #else /* NV_PRESERVES_UV */
2721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2722 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2723 /* The IV slot will have been set from value returned by
2724 grok_number above. The NV slot has just been set using
2727 assert (SvIOKp(sv));
2729 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2730 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2731 /* Small enough to preserve all bits. */
2732 (void)SvIOKp_on(sv);
2734 SvIV_set(sv, I_V(SvNVX(sv)));
2735 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2737 /* Assumption: first non-preserved integer is < IV_MAX,
2738 this NV is in the preserved range, therefore: */
2739 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2741 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2745 0 0 already failed to read UV.
2746 0 1 already failed to read UV.
2747 1 0 you won't get here in this case. IV/UV
2748 slot set, public IOK, Atof() unneeded.
2749 1 1 already read UV.
2750 so there's no point in sv_2iuv_non_preserve() attempting
2751 to use atol, strtol, strtoul etc. */
2752 if (sv_2iuv_non_preserve (sv, numtype)
2753 >= IS_NUMBER_OVERFLOW_IV)
2757 #endif /* NV_PRESERVES_UV */
2760 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2762 if (SvTYPE(sv) < SVt_IV)
2763 /* Typically the caller expects that sv_any is not NULL now. */
2764 sv_upgrade(sv, SVt_IV);
2767 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2768 PTR2UV(sv),SvIVX(sv)));
2769 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2772 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2773 * this function provided for binary compatibility only
2777 Perl_sv_2uv(pTHX_ register SV *sv)
2779 return sv_2uv_flags(sv, SV_GMAGIC);
2783 =for apidoc sv_2uv_flags
2785 Return the unsigned integer value of an SV, doing any necessary string
2786 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2787 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2793 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2797 if (SvGMAGICAL(sv)) {
2798 if (flags & SV_GMAGIC)
2803 return U_V(SvNVX(sv));
2804 if (SvPOKp(sv) && SvLEN(sv))
2807 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2808 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2814 if (SvTHINKFIRST(sv)) {
2817 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2818 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2819 return SvUV(tmpstr);
2820 return PTR2UV(SvRV(sv));
2823 sv_force_normal_flags(sv, 0);
2825 if (SvREADONLY(sv) && !SvOK(sv)) {
2826 if (ckWARN(WARN_UNINITIALIZED))
2836 return (UV)SvIVX(sv);
2840 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2841 * without also getting a cached IV/UV from it at the same time
2842 * (ie PV->NV conversion should detect loss of accuracy and cache
2843 * IV or UV at same time to avoid this. */
2844 /* IV-over-UV optimisation - choose to cache IV if possible */
2846 if (SvTYPE(sv) == SVt_NV)
2847 sv_upgrade(sv, SVt_PVNV);
2849 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2850 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2851 SvIV_set(sv, I_V(SvNVX(sv)));
2852 if (SvNVX(sv) == (NV) SvIVX(sv)
2853 #ifndef NV_PRESERVES_UV
2854 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2855 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2856 /* Don't flag it as "accurately an integer" if the number
2857 came from a (by definition imprecise) NV operation, and
2858 we're outside the range of NV integer precision */
2861 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2862 DEBUG_c(PerlIO_printf(Perl_debug_log,
2863 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2869 /* IV not precise. No need to convert from PV, as NV
2870 conversion would already have cached IV if it detected
2871 that PV->IV would be better than PV->NV->IV
2872 flags already correct - don't set public IOK. */
2873 DEBUG_c(PerlIO_printf(Perl_debug_log,
2874 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2879 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2880 but the cast (NV)IV_MIN rounds to a the value less (more
2881 negative) than IV_MIN which happens to be equal to SvNVX ??
2882 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2883 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2884 (NV)UVX == NVX are both true, but the values differ. :-(
2885 Hopefully for 2s complement IV_MIN is something like
2886 0x8000000000000000 which will be exact. NWC */
2889 SvUV_set(sv, U_V(SvNVX(sv)));
2891 (SvNVX(sv) == (NV) SvUVX(sv))
2892 #ifndef NV_PRESERVES_UV
2893 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2894 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2895 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2896 /* Don't flag it as "accurately an integer" if the number
2897 came from a (by definition imprecise) NV operation, and
2898 we're outside the range of NV integer precision */
2903 DEBUG_c(PerlIO_printf(Perl_debug_log,
2904 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2910 else if (SvPOKp(sv) && SvLEN(sv)) {
2912 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2914 /* We want to avoid a possible problem when we cache a UV which
2915 may be later translated to an NV, and the resulting NV is not
2916 the translation of the initial data.
2918 This means that if we cache such a UV, we need to cache the
2919 NV as well. Moreover, we trade speed for space, and do not
2920 cache the NV if not needed.
2923 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2924 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2925 == IS_NUMBER_IN_UV) {
2926 /* It's definitely an integer, only upgrade to PVIV */
2927 if (SvTYPE(sv) < SVt_PVIV)
2928 sv_upgrade(sv, SVt_PVIV);
2930 } else if (SvTYPE(sv) < SVt_PVNV)
2931 sv_upgrade(sv, SVt_PVNV);
2933 /* If NV preserves UV then we only use the UV value if we know that
2934 we aren't going to call atof() below. If NVs don't preserve UVs
2935 then the value returned may have more precision than atof() will
2936 return, even though it isn't accurate. */
2937 if ((numtype & (IS_NUMBER_IN_UV
2938 #ifdef NV_PRESERVES_UV
2941 )) == IS_NUMBER_IN_UV) {
2942 /* This won't turn off the public IOK flag if it was set above */
2943 (void)SvIOKp_on(sv);
2945 if (!(numtype & IS_NUMBER_NEG)) {
2947 if (value <= (UV)IV_MAX) {
2948 SvIV_set(sv, (IV)value);
2950 /* it didn't overflow, and it was positive. */
2951 SvUV_set(sv, value);
2955 /* 2s complement assumption */
2956 if (value <= (UV)IV_MIN) {
2957 SvIV_set(sv, -(IV)value);
2959 /* Too negative for an IV. This is a double upgrade, but
2960 I'm assuming it will be rare. */
2961 if (SvTYPE(sv) < SVt_PVNV)
2962 sv_upgrade(sv, SVt_PVNV);
2966 SvNV_set(sv, -(NV)value);
2967 SvIV_set(sv, IV_MIN);
2972 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2973 != IS_NUMBER_IN_UV) {
2974 /* It wasn't an integer, or it overflowed the UV. */
2975 SvNV_set(sv, Atof(SvPVX_const(sv)));
2977 if (! numtype && ckWARN(WARN_NUMERIC))
2980 #if defined(USE_LONG_DOUBLE)
2981 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2982 PTR2UV(sv), SvNVX(sv)));
2984 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2985 PTR2UV(sv), SvNVX(sv)));
2988 #ifdef NV_PRESERVES_UV
2989 (void)SvIOKp_on(sv);
2991 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2992 SvIV_set(sv, I_V(SvNVX(sv)));
2993 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2996 /* Integer is imprecise. NOK, IOKp */
2998 /* UV will not work better than IV */
3000 if (SvNVX(sv) > (NV)UV_MAX) {
3002 /* Integer is inaccurate. NOK, IOKp, is UV */
3003 SvUV_set(sv, UV_MAX);
3006 SvUV_set(sv, U_V(SvNVX(sv)));
3007 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3008 NV preservse UV so can do correct comparison. */
3009 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3013 /* Integer is imprecise. NOK, IOKp, is UV */
3018 #else /* NV_PRESERVES_UV */
3019 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3020 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3021 /* The UV slot will have been set from value returned by
3022 grok_number above. The NV slot has just been set using
3025 assert (SvIOKp(sv));
3027 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3028 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3029 /* Small enough to preserve all bits. */
3030 (void)SvIOKp_on(sv);
3032 SvIV_set(sv, I_V(SvNVX(sv)));
3033 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3035 /* Assumption: first non-preserved integer is < IV_MAX,
3036 this NV is in the preserved range, therefore: */
3037 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3039 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
3042 sv_2iuv_non_preserve (sv, numtype);
3044 #endif /* NV_PRESERVES_UV */
3048 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3049 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3052 if (SvTYPE(sv) < SVt_IV)
3053 /* Typically the caller expects that sv_any is not NULL now. */
3054 sv_upgrade(sv, SVt_IV);
3058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3059 PTR2UV(sv),SvUVX(sv)));
3060 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3066 Return the num value of an SV, doing any necessary string or integer
3067 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3074 Perl_sv_2nv(pTHX_ register SV *sv)
3078 if (SvGMAGICAL(sv)) {
3082 if (SvPOKp(sv) && SvLEN(sv)) {
3083 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3084 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
3086 return Atof(SvPVX_const(sv));
3090 return (NV)SvUVX(sv);
3092 return (NV)SvIVX(sv);
3095 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3096 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3102 if (SvTHINKFIRST(sv)) {
3105 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3106 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3107 return SvNV(tmpstr);
3108 return PTR2NV(SvRV(sv));
3111 sv_force_normal_flags(sv, 0);
3113 if (SvREADONLY(sv) && !SvOK(sv)) {
3114 if (ckWARN(WARN_UNINITIALIZED))
3119 if (SvTYPE(sv) < SVt_NV) {
3120 if (SvTYPE(sv) == SVt_IV)
3121 sv_upgrade(sv, SVt_PVNV);
3123 sv_upgrade(sv, SVt_NV);
3124 #ifdef USE_LONG_DOUBLE
3126 STORE_NUMERIC_LOCAL_SET_STANDARD();
3127 PerlIO_printf(Perl_debug_log,
3128 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3129 PTR2UV(sv), SvNVX(sv));
3130 RESTORE_NUMERIC_LOCAL();
3134 STORE_NUMERIC_LOCAL_SET_STANDARD();
3135 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3136 PTR2UV(sv), SvNVX(sv));
3137 RESTORE_NUMERIC_LOCAL();
3141 else if (SvTYPE(sv) < SVt_PVNV)
3142 sv_upgrade(sv, SVt_PVNV);
3147 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3148 #ifdef NV_PRESERVES_UV
3151 /* Only set the public NV OK flag if this NV preserves the IV */
3152 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3153 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3154 : (SvIVX(sv) == I_V(SvNVX(sv))))
3160 else if (SvPOKp(sv) && SvLEN(sv)) {
3162 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3163 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3165 #ifdef NV_PRESERVES_UV
3166 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3167 == IS_NUMBER_IN_UV) {
3168 /* It's definitely an integer */
3169 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3171 SvNV_set(sv, Atof(SvPVX_const(sv)));
3174 SvNV_set(sv, Atof(SvPVX_const(sv)));
3175 /* Only set the public NV OK flag if this NV preserves the value in
3176 the PV at least as well as an IV/UV would.
3177 Not sure how to do this 100% reliably. */
3178 /* if that shift count is out of range then Configure's test is
3179 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3181 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3182 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3183 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3184 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3185 /* Can't use strtol etc to convert this string, so don't try.
3186 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3189 /* value has been set. It may not be precise. */
3190 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3191 /* 2s complement assumption for (UV)IV_MIN */
3192 SvNOK_on(sv); /* Integer is too negative. */
3197 if (numtype & IS_NUMBER_NEG) {
3198 SvIV_set(sv, -(IV)value);
3199 } else if (value <= (UV)IV_MAX) {
3200 SvIV_set(sv, (IV)value);
3202 SvUV_set(sv, value);
3206 if (numtype & IS_NUMBER_NOT_INT) {
3207 /* I believe that even if the original PV had decimals,
3208 they are lost beyond the limit of the FP precision.
3209 However, neither is canonical, so both only get p
3210 flags. NWC, 2000/11/25 */
3211 /* Both already have p flags, so do nothing */
3213 const NV nv = SvNVX(sv);
3214 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3215 if (SvIVX(sv) == I_V(nv)) {
3220 /* It had no "." so it must be integer. */
3223 /* between IV_MAX and NV(UV_MAX).
3224 Could be slightly > UV_MAX */
3226 if (numtype & IS_NUMBER_NOT_INT) {
3227 /* UV and NV both imprecise. */
3229 const UV nv_as_uv = U_V(nv);
3231 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3242 #endif /* NV_PRESERVES_UV */
3245 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3247 if (SvTYPE(sv) < SVt_NV)
3248 /* Typically the caller expects that sv_any is not NULL now. */
3249 /* XXX Ilya implies that this is a bug in callers that assume this
3250 and ideally should be fixed. */
3251 sv_upgrade(sv, SVt_NV);
3254 #if defined(USE_LONG_DOUBLE)
3256 STORE_NUMERIC_LOCAL_SET_STANDARD();
3257 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3258 PTR2UV(sv), SvNVX(sv));
3259 RESTORE_NUMERIC_LOCAL();
3263 STORE_NUMERIC_LOCAL_SET_STANDARD();
3264 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3265 PTR2UV(sv), SvNVX(sv));
3266 RESTORE_NUMERIC_LOCAL();
3272 /* asIV(): extract an integer from the string value of an SV.
3273 * Caller must validate PVX */
3276 S_asIV(pTHX_ SV *sv)
3279 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3281 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3282 == IS_NUMBER_IN_UV) {
3283 /* It's definitely an integer */
3284 if (numtype & IS_NUMBER_NEG) {
3285 if (value < (UV)IV_MIN)
3288 if (value < (UV)IV_MAX)
3293 if (ckWARN(WARN_NUMERIC))
3296 return I_V(Atof(SvPVX_const(sv)));
3299 /* asUV(): extract an unsigned integer from the string value of an SV
3300 * Caller must validate PVX */
3303 S_asUV(pTHX_ SV *sv)
3306 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
3308 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3309 == IS_NUMBER_IN_UV) {
3310 /* It's definitely an integer */
3311 if (!(numtype & IS_NUMBER_NEG))
3315 if (ckWARN(WARN_NUMERIC))
3318 return U_V(Atof(SvPVX_const(sv)));
3322 =for apidoc sv_2pv_nolen
3324 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3325 use the macro wrapper C<SvPV_nolen(sv)> instead.
3330 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3332 return sv_2pv(sv, 0);
3335 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3336 * UV as a string towards the end of buf, and return pointers to start and
3339 * We assume that buf is at least TYPE_CHARS(UV) long.
3343 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3345 char *ptr = buf + TYPE_CHARS(UV);
3359 *--ptr = '0' + (char)(uv % 10);
3367 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3368 * this function provided for binary compatibility only
3372 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3374 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3378 =for apidoc sv_2pv_flags
3380 Returns a pointer to the string value of an SV, and sets *lp to its length.
3381 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3383 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3384 usually end up here too.
3390 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3395 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3396 char *tmpbuf = tbuf;
3403 if (SvGMAGICAL(sv)) {
3404 if (flags & SV_GMAGIC)
3409 if (flags & SV_MUTABLE_RETURN)
3410 return SvPVX_mutable(sv);
3411 if (flags & SV_CONST_RETURN)
3412 return (char *)SvPVX_const(sv);
3417 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3419 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3424 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3429 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3430 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3438 if (SvTHINKFIRST(sv)) {
3441 register const char *typestr;
3442 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3443 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3444 char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
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)
3551 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3552 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3553 /* tied lvalues should appear to be
3554 * scalars for backwards compatitbility */
3555 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3556 ? "SCALAR" : "LVALUE"; break;
3557 case SVt_PVAV: typestr = "ARRAY"; break;
3558 case SVt_PVHV: typestr = "HASH"; break;
3559 case SVt_PVCV: typestr = "CODE"; break;
3560 case SVt_PVGV: typestr = "GLOB"; break;
3561 case SVt_PVFM: typestr = "FORMAT"; break;
3562 case SVt_PVIO: typestr = "IO"; break;
3563 default: typestr = "UNKNOWN"; break;
3567 const char *name = HvNAME_get(SvSTASH(sv));
3568 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3569 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3572 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3576 *lp = strlen(typestr);
3577 return (char *)typestr;
3579 if (SvREADONLY(sv) && !SvOK(sv)) {
3580 if (ckWARN(WARN_UNINITIALIZED))
3587 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3588 /* I'm assuming that if both IV and NV are equally valid then
3589 converting the IV is going to be more efficient */
3590 const U32 isIOK = SvIOK(sv);
3591 const U32 isUIOK = SvIsUV(sv);
3592 char buf[TYPE_CHARS(UV)];
3595 if (SvTYPE(sv) < SVt_PVIV)
3596 sv_upgrade(sv, SVt_PVIV);
3598 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3600 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3601 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3602 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3603 SvCUR_set(sv, ebuf - ptr);
3613 else if (SvNOKp(sv)) {
3614 if (SvTYPE(sv) < SVt_PVNV)
3615 sv_upgrade(sv, SVt_PVNV);
3616 /* The +20 is pure guesswork. Configure test needed. --jhi */
3617 SvGROW(sv, NV_DIG + 20);
3618 s = SvPVX_mutable(sv);
3619 olderrno = errno; /* some Xenix systems wipe out errno here */
3621 if (SvNVX(sv) == 0.0)
3622 (void)strcpy(s,"0");
3626 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3629 #ifdef FIXNEGATIVEZERO
3630 if (*s == '-' && s[1] == '0' && !s[2])
3640 if (ckWARN(WARN_UNINITIALIZED)
3641 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3645 if (SvTYPE(sv) < SVt_PV)
3646 /* Typically the caller expects that sv_any is not NULL now. */
3647 sv_upgrade(sv, SVt_PV);
3651 STRLEN len = s - SvPVX_const(sv);
3657 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3658 PTR2UV(sv),SvPVX_const(sv)));
3659 if (flags & SV_CONST_RETURN)
3660 return (char *)SvPVX_const(sv);
3661 if (flags & SV_MUTABLE_RETURN)
3662 return SvPVX_mutable(sv);
3666 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3667 /* Sneaky stuff here */
3671 tsv = newSVpv(tmpbuf, 0);
3684 t = SvPVX_const(tsv);
3689 len = strlen(tmpbuf);
3691 #ifdef FIXNEGATIVEZERO
3692 if (len == 2 && t[0] == '-' && t[1] == '0') {
3697 SvUPGRADE(sv, SVt_PV);
3700 s = SvGROW(sv, len + 1);
3703 return strcpy(s, t);
3708 =for apidoc sv_copypv
3710 Copies a stringified representation of the source SV into the
3711 destination SV. Automatically performs any necessary mg_get and
3712 coercion of numeric values into strings. Guaranteed to preserve
3713 UTF-8 flag even from overloaded objects. Similar in nature to
3714 sv_2pv[_flags] but operates directly on an SV instead of just the
3715 string. Mostly uses sv_2pv_flags to do its work, except when that
3716 would lose the UTF-8'ness of the PV.
3722 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3726 s = SvPV_const(ssv,len);
3727 sv_setpvn(dsv,s,len);
3735 =for apidoc sv_2pvbyte_nolen
3737 Return a pointer to the byte-encoded representation of the SV.
3738 May cause the SV to be downgraded from UTF-8 as a side-effect.
3740 Usually accessed via the C<SvPVbyte_nolen> macro.
3746 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3748 return sv_2pvbyte(sv, 0);
3752 =for apidoc sv_2pvbyte
3754 Return a pointer to the byte-encoded representation of the SV, and set *lp
3755 to its length. May cause the SV to be downgraded from UTF-8 as a
3758 Usually accessed via the C<SvPVbyte> macro.
3764 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3766 sv_utf8_downgrade(sv,0);
3767 return SvPV(sv,*lp);
3771 =for apidoc sv_2pvutf8_nolen
3773 Return a pointer to the UTF-8-encoded representation of the SV.
3774 May cause the SV to be upgraded to UTF-8 as a side-effect.
3776 Usually accessed via the C<SvPVutf8_nolen> macro.
3782 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3784 return sv_2pvutf8(sv, 0);
3788 =for apidoc sv_2pvutf8
3790 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3791 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3793 Usually accessed via the C<SvPVutf8> macro.
3799 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3801 sv_utf8_upgrade(sv);
3802 return SvPV(sv,*lp);
3806 =for apidoc sv_2bool
3808 This function is only called on magical items, and is only used by
3809 sv_true() or its macro equivalent.
3815 Perl_sv_2bool(pTHX_ register SV *sv)
3824 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3825 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3826 return (bool)SvTRUE(tmpsv);
3827 return SvRV(sv) != 0;
3830 register XPV* Xpvtmp;
3831 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3832 (*sv->sv_u.svu_pv > '0' ||
3833 Xpvtmp->xpv_cur > 1 ||
3834 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3841 return SvIVX(sv) != 0;
3844 return SvNVX(sv) != 0.0;
3851 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3852 * this function provided for binary compatibility only
3857 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3859 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3863 =for apidoc sv_utf8_upgrade
3865 Converts the PV of an SV to its UTF-8-encoded form.
3866 Forces the SV to string form if it is not already.
3867 Always sets the SvUTF8 flag to avoid future validity checks even
3868 if all the bytes have hibit clear.
3870 This is not as a general purpose byte encoding to Unicode interface:
3871 use the Encode extension for that.
3873 =for apidoc sv_utf8_upgrade_flags
3875 Converts the PV of an SV to its UTF-8-encoded form.
3876 Forces the SV to string form if it is not already.
3877 Always sets the SvUTF8 flag to avoid future validity checks even
3878 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3879 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3880 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3882 This is not as a general purpose byte encoding to Unicode interface:
3883 use the Encode extension for that.
3889 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3891 if (sv == &PL_sv_undef)
3895 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3896 (void) sv_2pv_flags(sv,&len, flags);
3900 (void) SvPV_force(sv,len);
3909 sv_force_normal_flags(sv, 0);
3912 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3913 sv_recode_to_utf8(sv, PL_encoding);
3914 else { /* Assume Latin-1/EBCDIC */
3915 /* This function could be much more efficient if we
3916 * had a FLAG in SVs to signal if there are any hibit
3917 * chars in the PV. Given that there isn't such a flag
3918 * make the loop as fast as possible. */
3919 U8 *s = (U8 *) SvPVX(sv);
3920 U8 *e = (U8 *) SvEND(sv);
3926 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3930 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3931 s = bytes_to_utf8((U8*)s, &len);
3933 SvPV_free(sv); /* No longer using what was there before. */
3935 SvPV_set(sv, (char*)s);
3936 SvCUR_set(sv, len - 1);
3937 SvLEN_set(sv, len); /* No longer know the real size. */
3939 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3946 =for apidoc sv_utf8_downgrade
3948 Attempts to convert the PV of an SV from characters to bytes.
3949 If the PV contains a character beyond byte, this conversion will fail;
3950 in this case, either returns false or, if C<fail_ok> is not
3953 This is not as a general purpose Unicode to byte encoding interface:
3954 use the Encode extension for that.
3960 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3962 if (SvPOKp(sv) && SvUTF8(sv)) {
3968 sv_force_normal_flags(sv, 0);
3970 s = (U8 *) SvPV(sv, len);
3971 if (!utf8_to_bytes(s, &len)) {
3976 Perl_croak(aTHX_ "Wide character in %s",
3979 Perl_croak(aTHX_ "Wide character");
3990 =for apidoc sv_utf8_encode
3992 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3993 flag off so that it looks like octets again.
3999 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4001 (void) sv_utf8_upgrade(sv);
4003 sv_force_normal_flags(sv, 0);
4005 if (SvREADONLY(sv)) {
4006 Perl_croak(aTHX_ PL_no_modify);
4012 =for apidoc sv_utf8_decode
4014 If the PV of the SV is an octet sequence in UTF-8
4015 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4016 so that it looks like a character. If the PV contains only single-byte
4017 characters, the C<SvUTF8> flag stays being off.
4018 Scans PV for validity and returns false if the PV is invalid UTF-8.
4024 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4030 /* The octets may have got themselves encoded - get them back as
4033 if (!sv_utf8_downgrade(sv, TRUE))
4036 /* it is actually just a matter of turning the utf8 flag on, but
4037 * we want to make sure everything inside is valid utf8 first.
4039 c = (U8 *) SvPVX(sv);
4040 if (!is_utf8_string(c, SvCUR(sv)+1))
4042 e = (U8 *) SvEND(sv);
4045 if (!UTF8_IS_INVARIANT(ch)) {
4054 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4055 * this function provided for binary compatibility only
4059 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4061 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4065 =for apidoc sv_setsv
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.
4073 You probably want to use one of the assortment of wrappers, such as
4074 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4075 C<SvSetMagicSV_nosteal>.
4077 =for apidoc sv_setsv_flags
4079 Copies the contents of the source SV C<ssv> into the destination SV
4080 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4081 function if the source SV needs to be reused. Does not handle 'set' magic.
4082 Loosely speaking, it performs a copy-by-value, obliterating any previous
4083 content of the destination.
4084 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4085 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4086 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4087 and C<sv_setsv_nomg> are implemented in terms of this function.
4089 You probably want to use one of the assortment of wrappers, such as
4090 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4091 C<SvSetMagicSV_nosteal>.
4093 This is the primary function for copying scalars, and most other
4094 copy-ish functions and macros use this underneath.
4100 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4102 register U32 sflags;
4108 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4110 sstr = &PL_sv_undef;
4111 stype = SvTYPE(sstr);
4112 dtype = SvTYPE(dstr);
4117 /* need to nuke the magic */
4119 SvRMAGICAL_off(dstr);
4122 /* There's a lot of redundancy below but we're going for speed here */
4127 if (dtype != SVt_PVGV) {
4128 (void)SvOK_off(dstr);
4136 sv_upgrade(dstr, SVt_IV);
4139 sv_upgrade(dstr, SVt_PVNV);
4143 sv_upgrade(dstr, SVt_PVIV);
4146 (void)SvIOK_only(dstr);
4147 SvIV_set(dstr, SvIVX(sstr));
4150 if (SvTAINTED(sstr))
4161 sv_upgrade(dstr, SVt_NV);
4166 sv_upgrade(dstr, SVt_PVNV);
4169 SvNV_set(dstr, SvNVX(sstr));
4170 (void)SvNOK_only(dstr);
4171 if (SvTAINTED(sstr))
4179 sv_upgrade(dstr, SVt_RV);
4180 else if (dtype == SVt_PVGV &&
4181 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4184 if (GvIMPORTED(dstr) != GVf_IMPORTED
4185 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4187 GvIMPORTED_on(dstr);
4196 #ifdef PERL_OLD_COPY_ON_WRITE
4197 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4198 if (dtype < SVt_PVIV)
4199 sv_upgrade(dstr, SVt_PVIV);
4206 sv_upgrade(dstr, SVt_PV);
4209 if (dtype < SVt_PVIV)
4210 sv_upgrade(dstr, SVt_PVIV);
4213 if (dtype < SVt_PVNV)
4214 sv_upgrade(dstr, SVt_PVNV);
4221 const char * const type = sv_reftype(sstr,0);
4223 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4225 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4230 if (dtype <= SVt_PVGV) {
4232 if (dtype != SVt_PVGV) {
4233 const char * const name = GvNAME(sstr);
4234 const STRLEN len = GvNAMELEN(sstr);
4235 /* don't upgrade SVt_PVLV: it can hold a glob */
4236 if (dtype != SVt_PVLV)
4237 sv_upgrade(dstr, SVt_PVGV);
4238 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4239 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4240 GvNAME(dstr) = savepvn(name, len);
4241 GvNAMELEN(dstr) = len;
4242 SvFAKE_on(dstr); /* can coerce to non-glob */
4244 /* ahem, death to those who redefine active sort subs */
4245 else if (PL_curstackinfo->si_type == PERLSI_SORT
4246 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4247 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4250 #ifdef GV_UNIQUE_CHECK
4251 if (GvUNIQUE((GV*)dstr)) {
4252 Perl_croak(aTHX_ PL_no_modify);
4256 (void)SvOK_off(dstr);
4257 GvINTRO_off(dstr); /* one-shot flag */
4259 GvGP(dstr) = gp_ref(GvGP(sstr));
4260 if (SvTAINTED(sstr))
4262 if (GvIMPORTED(dstr) != GVf_IMPORTED
4263 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4265 GvIMPORTED_on(dstr);
4273 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4275 if ((int)SvTYPE(sstr) != stype) {
4276 stype = SvTYPE(sstr);
4277 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4281 if (stype == SVt_PVLV)
4282 SvUPGRADE(dstr, SVt_PVNV);
4284 SvUPGRADE(dstr, (U32)stype);
4287 sflags = SvFLAGS(sstr);
4289 if (sflags & SVf_ROK) {
4290 if (dtype >= SVt_PV) {
4291 if (dtype == SVt_PVGV) {
4292 SV *sref = SvREFCNT_inc(SvRV(sstr));
4294 const int intro = GvINTRO(dstr);
4296 #ifdef GV_UNIQUE_CHECK
4297 if (GvUNIQUE((GV*)dstr)) {
4298 Perl_croak(aTHX_ PL_no_modify);
4303 GvINTRO_off(dstr); /* one-shot flag */
4304 GvLINE(dstr) = CopLINE(PL_curcop);
4305 GvEGV(dstr) = (GV*)dstr;
4308 switch (SvTYPE(sref)) {
4311 SAVEGENERICSV(GvAV(dstr));
4313 dref = (SV*)GvAV(dstr);
4314 GvAV(dstr) = (AV*)sref;
4315 if (!GvIMPORTED_AV(dstr)
4316 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4318 GvIMPORTED_AV_on(dstr);
4323 SAVEGENERICSV(GvHV(dstr));
4325 dref = (SV*)GvHV(dstr);
4326 GvHV(dstr) = (HV*)sref;
4327 if (!GvIMPORTED_HV(dstr)
4328 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4330 GvIMPORTED_HV_on(dstr);
4335 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4336 SvREFCNT_dec(GvCV(dstr));
4337 GvCV(dstr) = Nullcv;
4338 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4339 PL_sub_generation++;
4341 SAVEGENERICSV(GvCV(dstr));
4344 dref = (SV*)GvCV(dstr);
4345 if (GvCV(dstr) != (CV*)sref) {
4346 CV* cv = GvCV(dstr);
4348 if (!GvCVGEN((GV*)dstr) &&
4349 (CvROOT(cv) || CvXSUB(cv)))
4351 /* ahem, death to those who redefine
4352 * active sort subs */
4353 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4354 PL_sortcop == CvSTART(cv))
4356 "Can't redefine active sort subroutine %s",
4357 GvENAME((GV*)dstr));
4358 /* Redefining a sub - warning is mandatory if
4359 it was a const and its value changed. */
4360 if (ckWARN(WARN_REDEFINE)
4362 && (!CvCONST((CV*)sref)
4363 || sv_cmp(cv_const_sv(cv),
4364 cv_const_sv((CV*)sref)))))
4366 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4368 ? "Constant subroutine %s::%s redefined"
4369 : "Subroutine %s::%s redefined",
4370 HvNAME_get(GvSTASH((GV*)dstr)),
4371 GvENAME((GV*)dstr));
4375 cv_ckproto(cv, (GV*)dstr,
4376 SvPOK(sref) ? SvPVX(sref) : Nullch);
4378 GvCV(dstr) = (CV*)sref;
4379 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4380 GvASSUMECV_on(dstr);
4381 PL_sub_generation++;
4383 if (!GvIMPORTED_CV(dstr)
4384 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4386 GvIMPORTED_CV_on(dstr);
4391 SAVEGENERICSV(GvIOp(dstr));
4393 dref = (SV*)GvIOp(dstr);
4394 GvIOp(dstr) = (IO*)sref;
4398 SAVEGENERICSV(GvFORM(dstr));
4400 dref = (SV*)GvFORM(dstr);
4401 GvFORM(dstr) = (CV*)sref;
4405 SAVEGENERICSV(GvSV(dstr));
4407 dref = (SV*)GvSV(dstr);
4409 if (!GvIMPORTED_SV(dstr)
4410 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4412 GvIMPORTED_SV_on(dstr);
4418 if (SvTAINTED(sstr))
4422 if (SvPVX_const(dstr)) {
4428 (void)SvOK_off(dstr);
4429 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4431 if (sflags & SVp_NOK) {
4433 /* Only set the public OK flag if the source has public OK. */
4434 if (sflags & SVf_NOK)
4435 SvFLAGS(dstr) |= SVf_NOK;
4436 SvNV_set(dstr, SvNVX(sstr));
4438 if (sflags & SVp_IOK) {
4439 (void)SvIOKp_on(dstr);
4440 if (sflags & SVf_IOK)
4441 SvFLAGS(dstr) |= SVf_IOK;
4442 if (sflags & SVf_IVisUV)
4444 SvIV_set(dstr, SvIVX(sstr));
4446 if (SvAMAGIC(sstr)) {
4450 else if (sflags & SVp_POK) {
4454 * Check to see if we can just swipe the string. If so, it's a
4455 * possible small lose on short strings, but a big win on long ones.
4456 * It might even be a win on short strings if SvPVX_const(dstr)
4457 * has to be allocated and SvPVX_const(sstr) has to be freed.
4460 /* Whichever path we take through the next code, we want this true,
4461 and doing it now facilitates the COW check. */
4462 (void)SvPOK_only(dstr);
4465 /* We're not already COW */
4466 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4467 #ifndef PERL_OLD_COPY_ON_WRITE
4468 /* or we are, but dstr isn't a suitable target. */
4469 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4474 (sflags & SVs_TEMP) && /* slated for free anyway? */
4475 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4476 (!(flags & SV_NOSTEAL)) &&
4477 /* and we're allowed to steal temps */
4478 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4479 SvLEN(sstr) && /* and really is a string */
4480 /* and won't be needed again, potentially */
4481 !(PL_op && PL_op->op_type == OP_AASSIGN))
4482 #ifdef PERL_OLD_COPY_ON_WRITE
4483 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4484 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4485 && SvTYPE(sstr) >= SVt_PVIV)
4488 /* Failed the swipe test, and it's not a shared hash key either.
4489 Have to copy the string. */
4490 STRLEN len = SvCUR(sstr);
4491 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4492 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4493 SvCUR_set(dstr, len);
4494 *SvEND(dstr) = '\0';
4496 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4498 /* Either it's a shared hash key, or it's suitable for
4499 copy-on-write or we can swipe the string. */
4501 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4505 #ifdef PERL_OLD_COPY_ON_WRITE
4507 /* I believe I should acquire a global SV mutex if
4508 it's a COW sv (not a shared hash key) to stop
4509 it going un copy-on-write.
4510 If the source SV has gone un copy on write between up there
4511 and down here, then (assert() that) it is of the correct
4512 form to make it copy on write again */
4513 if ((sflags & (SVf_FAKE | SVf_READONLY))
4514 != (SVf_FAKE | SVf_READONLY)) {
4515 SvREADONLY_on(sstr);
4517 /* Make the source SV into a loop of 1.
4518 (about to become 2) */
4519 SV_COW_NEXT_SV_SET(sstr, sstr);
4523 /* Initial code is common. */
4524 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4526 SvFLAGS(dstr) &= ~SVf_OOK;
4527 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
4529 else if (SvLEN(dstr))
4530 Safefree(SvPVX_const(dstr));
4534 /* making another shared SV. */
4535 STRLEN cur = SvCUR(sstr);
4536 STRLEN len = SvLEN(sstr);
4537 #ifdef PERL_OLD_COPY_ON_WRITE
4539 assert (SvTYPE(dstr) >= SVt_PVIV);
4540 /* SvIsCOW_normal */
4541 /* splice us in between source and next-after-source. */
4542 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4543 SV_COW_NEXT_SV_SET(sstr, dstr);
4544 SvPV_set(dstr, SvPVX_mutable(sstr));
4548 /* SvIsCOW_shared_hash */
4549 UV hash = SvSHARED_HASH(sstr);
4550 DEBUG_C(PerlIO_printf(Perl_debug_log,
4551 "Copy on write: Sharing hash\n"));
4553 assert (SvTYPE(dstr) >= SVt_PVIV);
4555 sharepvn(SvPVX_const(sstr),
4556 (sflags & SVf_UTF8?-cur:cur), hash));
4557 SvUV_set(dstr, hash);
4559 SvLEN_set(dstr, len);
4560 SvCUR_set(dstr, cur);
4561 SvREADONLY_on(dstr);
4563 /* Relesase a global SV mutex. */
4566 { /* Passes the swipe test. */
4567 SvPV_set(dstr, SvPVX_mutable(sstr));
4568 SvLEN_set(dstr, SvLEN(sstr));
4569 SvCUR_set(dstr, SvCUR(sstr));
4572 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4573 SvPV_set(sstr, Nullch);
4579 if (sflags & SVf_UTF8)
4582 if (sflags & SVp_NOK) {
4584 if (sflags & SVf_NOK)
4585 SvFLAGS(dstr) |= SVf_NOK;
4586 SvNV_set(dstr, SvNVX(sstr));
4588 if (sflags & SVp_IOK) {
4589 (void)SvIOKp_on(dstr);
4590 if (sflags & SVf_IOK)
4591 SvFLAGS(dstr) |= SVf_IOK;
4592 if (sflags & SVf_IVisUV)
4594 SvIV_set(dstr, SvIVX(sstr));
4597 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4598 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4599 smg->mg_ptr, smg->mg_len);
4600 SvRMAGICAL_on(dstr);
4603 else if (sflags & SVp_IOK) {
4604 if (sflags & SVf_IOK)
4605 (void)SvIOK_only(dstr);
4607 (void)SvOK_off(dstr);
4608 (void)SvIOKp_on(dstr);
4610 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4611 if (sflags & SVf_IVisUV)
4613 SvIV_set(dstr, SvIVX(sstr));
4614 if (sflags & SVp_NOK) {
4615 if (sflags & SVf_NOK)
4616 (void)SvNOK_on(dstr);
4618 (void)SvNOKp_on(dstr);
4619 SvNV_set(dstr, SvNVX(sstr));
4622 else if (sflags & SVp_NOK) {
4623 if (sflags & SVf_NOK)
4624 (void)SvNOK_only(dstr);
4626 (void)SvOK_off(dstr);
4629 SvNV_set(dstr, SvNVX(sstr));
4632 if (dtype == SVt_PVGV) {
4633 if (ckWARN(WARN_MISC))
4634 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4637 (void)SvOK_off(dstr);
4639 if (SvTAINTED(sstr))
4644 =for apidoc sv_setsv_mg
4646 Like C<sv_setsv>, but also handles 'set' magic.
4652 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4654 sv_setsv(dstr,sstr);
4658 #ifdef PERL_OLD_COPY_ON_WRITE
4660 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4662 STRLEN cur = SvCUR(sstr);
4663 STRLEN len = SvLEN(sstr);
4664 register char *new_pv;
4667 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4675 if (SvTHINKFIRST(dstr))
4676 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4677 else if (SvPVX_const(dstr))
4678 Safefree(SvPVX_const(dstr));
4682 SvUPGRADE(dstr, SVt_PVIV);
4684 assert (SvPOK(sstr));
4685 assert (SvPOKp(sstr));
4686 assert (!SvIOK(sstr));
4687 assert (!SvIOKp(sstr));
4688 assert (!SvNOK(sstr));
4689 assert (!SvNOKp(sstr));
4691 if (SvIsCOW(sstr)) {
4693 if (SvLEN(sstr) == 0) {
4694 /* source is a COW shared hash key. */
4695 UV hash = SvSHARED_HASH(sstr);
4696 DEBUG_C(PerlIO_printf(Perl_debug_log,
4697 "Fast copy on write: Sharing hash\n"));
4698 SvUV_set(dstr, hash);
4699 new_pv = sharepvn(SvPVX_const(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4702 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4704 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4705 SvUPGRADE(sstr, SVt_PVIV);
4706 SvREADONLY_on(sstr);
4708 DEBUG_C(PerlIO_printf(Perl_debug_log,
4709 "Fast copy on write: Converting sstr to COW\n"));
4710 SV_COW_NEXT_SV_SET(dstr, sstr);
4712 SV_COW_NEXT_SV_SET(sstr, dstr);
4713 new_pv = SvPVX_mutable(sstr);
4716 SvPV_set(dstr, new_pv);
4717 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4720 SvLEN_set(dstr, len);
4721 SvCUR_set(dstr, cur);
4730 =for apidoc sv_setpvn
4732 Copies a string into an SV. The C<len> parameter indicates the number of
4733 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4734 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4740 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4742 register char *dptr;
4744 SV_CHECK_THINKFIRST_COW_DROP(sv);
4750 /* len is STRLEN which is unsigned, need to copy to signed */
4753 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4755 SvUPGRADE(sv, SVt_PV);
4757 SvGROW(sv, len + 1);
4759 Move(ptr,dptr,len,char);
4762 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4767 =for apidoc sv_setpvn_mg
4769 Like C<sv_setpvn>, but also handles 'set' magic.
4775 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4777 sv_setpvn(sv,ptr,len);
4782 =for apidoc sv_setpv
4784 Copies a string into an SV. The string must be null-terminated. Does not
4785 handle 'set' magic. See C<sv_setpv_mg>.
4791 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4793 register STRLEN len;
4795 SV_CHECK_THINKFIRST_COW_DROP(sv);
4801 SvUPGRADE(sv, SVt_PV);
4803 SvGROW(sv, len + 1);
4804 Move(ptr,SvPVX(sv),len+1,char);
4806 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4811 =for apidoc sv_setpv_mg
4813 Like C<sv_setpv>, but also handles 'set' magic.
4819 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4826 =for apidoc sv_usepvn
4828 Tells an SV to use C<ptr> to find its string value. Normally the string is
4829 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4830 The C<ptr> should point to memory that was allocated by C<malloc>. The
4831 string length, C<len>, must be supplied. This function will realloc the
4832 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4833 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4834 See C<sv_usepvn_mg>.
4840 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4843 SV_CHECK_THINKFIRST_COW_DROP(sv);
4844 SvUPGRADE(sv, SVt_PV);
4849 if (SvPVX_const(sv))
4852 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4853 ptr = saferealloc (ptr, allocate);
4856 SvLEN_set(sv, allocate);
4858 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4863 =for apidoc sv_usepvn_mg
4865 Like C<sv_usepvn>, but also handles 'set' magic.
4871 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4873 sv_usepvn(sv,ptr,len);
4877 #ifdef PERL_OLD_COPY_ON_WRITE
4878 /* Need to do this *after* making the SV normal, as we need the buffer
4879 pointer to remain valid until after we've copied it. If we let go too early,
4880 another thread could invalidate it by unsharing last of the same hash key
4881 (which it can do by means other than releasing copy-on-write Svs)
4882 or by changing the other copy-on-write SVs in the loop. */
4884 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN cur, STRLEN len,
4885 U32 hash, SV *after)
4887 if (len) { /* this SV was SvIsCOW_normal(sv) */
4888 /* we need to find the SV pointing to us. */
4889 SV *current = SV_COW_NEXT_SV(after);
4891 if (current == sv) {
4892 /* The SV we point to points back to us (there were only two of us
4894 Hence other SV is no longer copy on write either. */
4896 SvREADONLY_off(after);
4898 /* We need to follow the pointers around the loop. */
4900 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4903 /* don't loop forever if the structure is bust, and we have
4904 a pointer into a closed loop. */
4905 assert (current != after);
4906 assert (SvPVX_const(current) == pvx);
4908 /* Make the SV before us point to the SV after us. */
4909 SV_COW_NEXT_SV_SET(current, after);
4912 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4917 Perl_sv_release_IVX(pTHX_ register SV *sv)
4920 sv_force_normal_flags(sv, 0);
4926 =for apidoc sv_force_normal_flags
4928 Undo various types of fakery on an SV: if the PV is a shared string, make
4929 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4930 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4931 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4932 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4933 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4934 set to some other value.) In addition, the C<flags> parameter gets passed to
4935 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4936 with flags set to 0.
4942 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4944 #ifdef PERL_OLD_COPY_ON_WRITE
4945 if (SvREADONLY(sv)) {
4946 /* At this point I believe I should acquire a global SV mutex. */
4948 const char *pvx = SvPVX_const(sv);
4949 const STRLEN len = SvLEN(sv);
4950 const STRLEN cur = SvCUR(sv);
4951 const U32 hash = SvSHARED_HASH(sv);
4952 SV *const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4954 PerlIO_printf(Perl_debug_log,
4955 "Copy on write: Force normal %ld\n",
4961 /* This SV doesn't own the buffer, so need to New() a new one: */
4962 SvPV_set(sv, (char*)0);
4964 if (flags & SV_COW_DROP_PV) {
4965 /* OK, so we don't need to copy our buffer. */
4968 SvGROW(sv, cur + 1);
4969 Move(pvx,SvPVX(sv),cur,char);
4973 sv_release_COW(sv, pvx, cur, len, hash, next);
4978 else if (IN_PERL_RUNTIME)
4979 Perl_croak(aTHX_ PL_no_modify);
4980 /* At this point I believe that I can drop the global SV mutex. */
4983 if (SvREADONLY(sv)) {
4985 const char *pvx = SvPVX_const(sv);
4986 const int is_utf8 = SvUTF8(sv);
4987 const STRLEN len = SvCUR(sv);
4988 const U32 hash = SvSHARED_HASH(sv);
4991 SvPV_set(sv, Nullch);
4993 SvGROW(sv, len + 1);
4994 Move(pvx,SvPVX_const(sv),len,char);
4996 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4998 else if (IN_PERL_RUNTIME)
4999 Perl_croak(aTHX_ PL_no_modify);
5003 sv_unref_flags(sv, flags);
5004 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5009 =for apidoc sv_force_normal
5011 Undo various types of fakery on an SV: if the PV is a shared string, make
5012 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5013 an xpvmg. See also C<sv_force_normal_flags>.
5019 Perl_sv_force_normal(pTHX_ register SV *sv)
5021 sv_force_normal_flags(sv, 0);
5027 Efficient removal of characters from the beginning of the string buffer.
5028 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5029 the string buffer. The C<ptr> becomes the first character of the adjusted
5030 string. Uses the "OOK hack".
5031 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5032 refer to the same chunk of data.
5038 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5040 register STRLEN delta;
5041 if (!ptr || !SvPOKp(sv))
5043 delta = ptr - SvPVX_const(sv);
5044 SV_CHECK_THINKFIRST(sv);
5045 if (SvTYPE(sv) < SVt_PVIV)
5046 sv_upgrade(sv,SVt_PVIV);
5049 if (!SvLEN(sv)) { /* make copy of shared string */
5050 const char *pvx = SvPVX_const(sv);
5051 STRLEN len = SvCUR(sv);
5052 SvGROW(sv, len + 1);
5053 Move(pvx,SvPVX_const(sv),len,char);
5057 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5058 and we do that anyway inside the SvNIOK_off
5060 SvFLAGS(sv) |= SVf_OOK;
5063 SvLEN_set(sv, SvLEN(sv) - delta);
5064 SvCUR_set(sv, SvCUR(sv) - delta);
5065 SvPV_set(sv, SvPVX(sv) + delta);
5066 SvIV_set(sv, SvIVX(sv) + delta);
5069 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5070 * this function provided for binary compatibility only
5074 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5076 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5080 =for apidoc sv_catpvn
5082 Concatenates the string onto the end of the string which is in the SV. The
5083 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5084 status set, then the bytes appended should be valid UTF-8.
5085 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5087 =for apidoc sv_catpvn_flags
5089 Concatenates the string onto the end of the string which is in the SV. The
5090 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5091 status set, then the bytes appended should be valid UTF-8.
5092 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5093 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5094 in terms of this function.
5100 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5103 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5105 SvGROW(dsv, dlen + slen + 1);
5107 sstr = SvPVX_const(dsv);
5108 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5109 SvCUR_set(dsv, SvCUR(dsv) + slen);
5111 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5116 =for apidoc sv_catpvn_mg
5118 Like C<sv_catpvn>, but also handles 'set' magic.
5124 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5126 sv_catpvn(sv,ptr,len);
5130 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5131 * this function provided for binary compatibility only
5135 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5137 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5141 =for apidoc sv_catsv
5143 Concatenates the string from SV C<ssv> onto the end of the string in
5144 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5145 not 'set' magic. See C<sv_catsv_mg>.
5147 =for apidoc sv_catsv_flags
5149 Concatenates the string from SV C<ssv> onto the end of the string in
5150 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5151 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5152 and C<sv_catsv_nomg> are implemented in terms of this function.
5157 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5163 if ((spv = SvPV_const(ssv, slen))) {
5164 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5165 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5166 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5167 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5168 dsv->sv_flags doesn't have that bit set.
5169 Andy Dougherty 12 Oct 2001
5171 const I32 sutf8 = DO_UTF8(ssv);
5174 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5176 dutf8 = DO_UTF8(dsv);
5178 if (dutf8 != sutf8) {
5180 /* Not modifying source SV, so taking a temporary copy. */
5181 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5183 sv_utf8_upgrade(csv);
5184 spv = SvPV(csv, slen);
5187 sv_utf8_upgrade_nomg(dsv);
5189 sv_catpvn_nomg(dsv, spv, slen);
5194 =for apidoc sv_catsv_mg
5196 Like C<sv_catsv>, but also handles 'set' magic.
5202 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5209 =for apidoc sv_catpv
5211 Concatenates the string onto the end of the string which is in the SV.
5212 If the SV has the UTF-8 status set, then the bytes appended should be
5213 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5218 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5220 register STRLEN len;
5226 junk = SvPV_force(sv, tlen);
5228 SvGROW(sv, tlen + len + 1);
5230 ptr = SvPVX_const(sv);
5231 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5232 SvCUR_set(sv, SvCUR(sv) + len);
5233 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5238 =for apidoc sv_catpv_mg
5240 Like C<sv_catpv>, but also handles 'set' magic.
5246 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5255 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5256 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5263 Perl_newSV(pTHX_ STRLEN len)
5269 sv_upgrade(sv, SVt_PV);
5270 SvGROW(sv, len + 1);
5275 =for apidoc sv_magicext
5277 Adds magic to an SV, upgrading it if necessary. Applies the
5278 supplied vtable and returns a pointer to the magic added.
5280 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5281 In particular, you can add magic to SvREADONLY SVs, and add more than
5282 one instance of the same 'how'.
5284 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5285 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5286 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5287 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5289 (This is now used as a subroutine by C<sv_magic>.)
5294 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5295 const char* name, I32 namlen)
5299 if (SvTYPE(sv) < SVt_PVMG) {
5300 SvUPGRADE(sv, SVt_PVMG);
5302 Newz(702,mg, 1, MAGIC);
5303 mg->mg_moremagic = SvMAGIC(sv);
5304 SvMAGIC_set(sv, mg);
5306 /* Sometimes a magic contains a reference loop, where the sv and
5307 object refer to each other. To prevent a reference loop that
5308 would prevent such objects being freed, we look for such loops
5309 and if we find one we avoid incrementing the object refcount.
5311 Note we cannot do this to avoid self-tie loops as intervening RV must
5312 have its REFCNT incremented to keep it in existence.
5315 if (!obj || obj == sv ||
5316 how == PERL_MAGIC_arylen ||
5317 how == PERL_MAGIC_qr ||
5318 how == PERL_MAGIC_symtab ||
5319 (SvTYPE(obj) == SVt_PVGV &&
5320 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5321 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5322 GvFORM(obj) == (CV*)sv)))
5327 mg->mg_obj = SvREFCNT_inc(obj);
5328 mg->mg_flags |= MGf_REFCOUNTED;
5331 /* Normal self-ties simply pass a null object, and instead of
5332 using mg_obj directly, use the SvTIED_obj macro to produce a
5333 new RV as needed. For glob "self-ties", we are tieing the PVIO
5334 with an RV obj pointing to the glob containing the PVIO. In
5335 this case, to avoid a reference loop, we need to weaken the
5339 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5340 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5346 mg->mg_len = namlen;
5349 mg->mg_ptr = savepvn(name, namlen);
5350 else if (namlen == HEf_SVKEY)
5351 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5353 mg->mg_ptr = (char *) name;
5355 mg->mg_virtual = vtable;
5359 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5364 =for apidoc sv_magic
5366 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5367 then adds a new magic item of type C<how> to the head of the magic list.
5369 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5370 handling of the C<name> and C<namlen> arguments.
5372 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5373 to add more than one instance of the same 'how'.
5379 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5381 const MGVTBL *vtable = 0;
5384 #ifdef PERL_OLD_COPY_ON_WRITE
5386 sv_force_normal_flags(sv, 0);
5388 if (SvREADONLY(sv)) {
5390 && how != PERL_MAGIC_regex_global
5391 && how != PERL_MAGIC_bm
5392 && how != PERL_MAGIC_fm
5393 && how != PERL_MAGIC_sv
5394 && how != PERL_MAGIC_backref
5397 Perl_croak(aTHX_ PL_no_modify);
5400 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5401 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5402 /* sv_magic() refuses to add a magic of the same 'how' as an
5405 if (how == PERL_MAGIC_taint)
5413 vtable = &PL_vtbl_sv;
5415 case PERL_MAGIC_overload:
5416 vtable = &PL_vtbl_amagic;
5418 case PERL_MAGIC_overload_elem:
5419 vtable = &PL_vtbl_amagicelem;
5421 case PERL_MAGIC_overload_table:
5422 vtable = &PL_vtbl_ovrld;
5425 vtable = &PL_vtbl_bm;
5427 case PERL_MAGIC_regdata:
5428 vtable = &PL_vtbl_regdata;
5430 case PERL_MAGIC_regdatum:
5431 vtable = &PL_vtbl_regdatum;
5433 case PERL_MAGIC_env:
5434 vtable = &PL_vtbl_env;
5437 vtable = &PL_vtbl_fm;
5439 case PERL_MAGIC_envelem:
5440 vtable = &PL_vtbl_envelem;
5442 case PERL_MAGIC_regex_global:
5443 vtable = &PL_vtbl_mglob;
5445 case PERL_MAGIC_isa:
5446 vtable = &PL_vtbl_isa;
5448 case PERL_MAGIC_isaelem:
5449 vtable = &PL_vtbl_isaelem;
5451 case PERL_MAGIC_nkeys:
5452 vtable = &PL_vtbl_nkeys;
5454 case PERL_MAGIC_dbfile:
5457 case PERL_MAGIC_dbline:
5458 vtable = &PL_vtbl_dbline;
5460 #ifdef USE_LOCALE_COLLATE
5461 case PERL_MAGIC_collxfrm:
5462 vtable = &PL_vtbl_collxfrm;
5464 #endif /* USE_LOCALE_COLLATE */
5465 case PERL_MAGIC_tied:
5466 vtable = &PL_vtbl_pack;
5468 case PERL_MAGIC_tiedelem:
5469 case PERL_MAGIC_tiedscalar:
5470 vtable = &PL_vtbl_packelem;
5473 vtable = &PL_vtbl_regexp;
5475 case PERL_MAGIC_sig:
5476 vtable = &PL_vtbl_sig;
5478 case PERL_MAGIC_sigelem:
5479 vtable = &PL_vtbl_sigelem;
5481 case PERL_MAGIC_taint:
5482 vtable = &PL_vtbl_taint;
5484 case PERL_MAGIC_uvar:
5485 vtable = &PL_vtbl_uvar;
5487 case PERL_MAGIC_vec:
5488 vtable = &PL_vtbl_vec;
5490 case PERL_MAGIC_arylen_p:
5491 case PERL_MAGIC_rhash:
5492 case PERL_MAGIC_symtab:
5493 case PERL_MAGIC_vstring:
5496 case PERL_MAGIC_utf8:
5497 vtable = &PL_vtbl_utf8;
5499 case PERL_MAGIC_substr:
5500 vtable = &PL_vtbl_substr;
5502 case PERL_MAGIC_defelem:
5503 vtable = &PL_vtbl_defelem;
5505 case PERL_MAGIC_glob:
5506 vtable = &PL_vtbl_glob;
5508 case PERL_MAGIC_arylen:
5509 vtable = &PL_vtbl_arylen;
5511 case PERL_MAGIC_pos:
5512 vtable = &PL_vtbl_pos;
5514 case PERL_MAGIC_backref:
5515 vtable = &PL_vtbl_backref;
5517 case PERL_MAGIC_ext:
5518 /* Reserved for use by extensions not perl internals. */
5519 /* Useful for attaching extension internal data to perl vars. */
5520 /* Note that multiple extensions may clash if magical scalars */
5521 /* etc holding private data from one are passed to another. */
5524 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5527 /* Rest of work is done else where */
5528 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5531 case PERL_MAGIC_taint:
5534 case PERL_MAGIC_ext:
5535 case PERL_MAGIC_dbfile:
5542 =for apidoc sv_unmagic
5544 Removes all magic of type C<type> from an SV.
5550 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5554 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5557 for (mg = *mgp; mg; mg = *mgp) {
5558 if (mg->mg_type == type) {
5559 const MGVTBL* const vtbl = mg->mg_virtual;
5560 *mgp = mg->mg_moremagic;
5561 if (vtbl && vtbl->svt_free)
5562 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5563 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5565 Safefree(mg->mg_ptr);
5566 else if (mg->mg_len == HEf_SVKEY)
5567 SvREFCNT_dec((SV*)mg->mg_ptr);
5568 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5569 Safefree(mg->mg_ptr);
5571 if (mg->mg_flags & MGf_REFCOUNTED)
5572 SvREFCNT_dec(mg->mg_obj);
5576 mgp = &mg->mg_moremagic;
5580 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5587 =for apidoc sv_rvweaken
5589 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5590 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5591 push a back-reference to this RV onto the array of backreferences
5592 associated with that magic.
5598 Perl_sv_rvweaken(pTHX_ SV *sv)
5601 if (!SvOK(sv)) /* let undefs pass */
5604 Perl_croak(aTHX_ "Can't weaken a nonreference");
5605 else if (SvWEAKREF(sv)) {
5606 if (ckWARN(WARN_MISC))
5607 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5611 sv_add_backref(tsv, sv);
5617 /* Give tsv backref magic if it hasn't already got it, then push a
5618 * back-reference to sv onto the array associated with the backref magic.
5622 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5626 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5627 av = (AV*)mg->mg_obj;
5630 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5631 /* av now has a refcnt of 2, which avoids it getting freed
5632 * before us during global cleanup. The extra ref is removed
5633 * by magic_killbackrefs() when tsv is being freed */
5635 if (AvFILLp(av) >= AvMAX(av)) {
5637 SV **svp = AvARRAY(av);
5638 for (i = AvFILLp(av); i >= 0; i--)
5640 svp[i] = sv; /* reuse the slot */
5643 av_extend(av, AvFILLp(av)+1);
5645 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5648 /* delete a back-reference to ourselves from the backref magic associated
5649 * with the SV we point to.
5653 S_sv_del_backref(pTHX_ SV *sv)
5660 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5661 Perl_croak(aTHX_ "panic: del_backref");
5662 av = (AV *)mg->mg_obj;
5664 for (i = AvFILLp(av); i >= 0; i--)
5665 if (svp[i] == sv) svp[i] = Nullsv;
5669 =for apidoc sv_insert
5671 Inserts a string at the specified offset/length within the SV. Similar to
5672 the Perl substr() function.
5678 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5682 register char *midend;
5683 register char *bigend;
5689 Perl_croak(aTHX_ "Can't modify non-existent substring");
5690 SvPV_force(bigstr, curlen);
5691 (void)SvPOK_only_UTF8(bigstr);
5692 if (offset + len > curlen) {
5693 SvGROW(bigstr, offset+len+1);
5694 Zero(SvPVX_const(bigstr)+curlen, offset+len-curlen, char);
5695 SvCUR_set(bigstr, offset+len);
5699 i = littlelen - len;
5700 if (i > 0) { /* string might grow */
5701 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5702 mid = big + offset + len;
5703 midend = bigend = big + SvCUR(bigstr);
5706 while (midend > mid) /* shove everything down */
5707 *--bigend = *--midend;
5708 Move(little,big+offset,littlelen,char);
5709 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5714 Move(little,SvPVX(bigstr)+offset,len,char);
5719 big = SvPVX(bigstr);
5722 bigend = big + SvCUR(bigstr);
5724 if (midend > bigend)
5725 Perl_croak(aTHX_ "panic: sv_insert");
5727 if (mid - big > bigend - midend) { /* faster to shorten from end */
5729 Move(little, mid, littlelen,char);
5732 i = bigend - midend;
5734 Move(midend, mid, i,char);
5738 SvCUR_set(bigstr, mid - big);
5741 else if ((i = mid - big)) { /* faster from front */
5742 midend -= littlelen;
5744 sv_chop(bigstr,midend-i);
5749 Move(little, mid, littlelen,char);
5751 else if (littlelen) {
5752 midend -= littlelen;
5753 sv_chop(bigstr,midend);
5754 Move(little,midend,littlelen,char);
5757 sv_chop(bigstr,midend);
5763 =for apidoc sv_replace
5765 Make the first argument a copy of the second, then delete the original.
5766 The target SV physically takes over ownership of the body of the source SV
5767 and inherits its flags; however, the target keeps any magic it owns,
5768 and any magic in the source is discarded.
5769 Note that this is a rather specialist SV copying operation; most of the
5770 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5776 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5778 const U32 refcnt = SvREFCNT(sv);
5779 SV_CHECK_THINKFIRST_COW_DROP(sv);
5780 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5781 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5782 if (SvMAGICAL(sv)) {
5786 sv_upgrade(nsv, SVt_PVMG);
5787 SvMAGIC_set(nsv, SvMAGIC(sv));
5788 SvFLAGS(nsv) |= SvMAGICAL(sv);
5790 SvMAGIC_set(sv, NULL);
5794 assert(!SvREFCNT(sv));
5795 #ifdef DEBUG_LEAKING_SCALARS
5796 sv->sv_flags = nsv->sv_flags;
5797 sv->sv_any = nsv->sv_any;
5798 sv->sv_refcnt = nsv->sv_refcnt;
5800 StructCopy(nsv,sv,SV);
5802 /* Currently could join these into one piece of pointer arithmetic, but
5803 it would be unclear. */
5804 if(SvTYPE(sv) == SVt_IV)
5806 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5807 else if (SvTYPE(sv) == SVt_RV) {
5808 SvANY(sv) = &sv->sv_u.svu_rv;
5812 #ifdef PERL_OLD_COPY_ON_WRITE
5813 if (SvIsCOW_normal(nsv)) {
5814 /* We need to follow the pointers around the loop to make the
5815 previous SV point to sv, rather than nsv. */
5818 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5821 assert(SvPVX_const(current) == SvPVX_const(nsv));
5823 /* Make the SV before us point to the SV after us. */
5825 PerlIO_printf(Perl_debug_log, "previous is\n");
5827 PerlIO_printf(Perl_debug_log,
5828 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5829 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5831 SV_COW_NEXT_SV_SET(current, sv);
5834 SvREFCNT(sv) = refcnt;
5835 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5841 =for apidoc sv_clear
5843 Clear an SV: call any destructors, free up any memory used by the body,
5844 and free the body itself. The SV's head is I<not> freed, although
5845 its type is set to all 1's so that it won't inadvertently be assumed
5846 to be live during global destruction etc.
5847 This function should only be called when REFCNT is zero. Most of the time
5848 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5855 Perl_sv_clear(pTHX_ register SV *sv)
5860 assert(SvREFCNT(sv) == 0);
5863 if (PL_defstash) { /* Still have a symbol table? */
5867 stash = SvSTASH(sv);
5868 destructor = StashHANDLER(stash,DESTROY);
5870 SV* tmpref = newRV(sv);
5871 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5873 PUSHSTACKi(PERLSI_DESTROY);
5878 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5884 if(SvREFCNT(tmpref) < 2) {
5885 /* tmpref is not kept alive! */
5887 SvRV_set(tmpref, NULL);
5890 SvREFCNT_dec(tmpref);
5892 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5896 if (PL_in_clean_objs)
5897 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5899 /* DESTROY gave object new lease on life */
5905 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5906 SvOBJECT_off(sv); /* Curse the object. */
5907 if (SvTYPE(sv) != SVt_PVIO)
5908 --PL_sv_objcount; /* XXX Might want something more general */
5911 if (SvTYPE(sv) >= SVt_PVMG) {
5914 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5915 SvREFCNT_dec(SvSTASH(sv));
5918 switch (SvTYPE(sv)) {
5921 IoIFP(sv) != PerlIO_stdin() &&
5922 IoIFP(sv) != PerlIO_stdout() &&
5923 IoIFP(sv) != PerlIO_stderr())
5925 io_close((IO*)sv, FALSE);
5927 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5928 PerlDir_close(IoDIRP(sv));
5929 IoDIRP(sv) = (DIR*)NULL;
5930 Safefree(IoTOP_NAME(sv));
5931 Safefree(IoFMT_NAME(sv));
5932 Safefree(IoBOTTOM_NAME(sv));
5947 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5948 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5949 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5950 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5952 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5953 SvREFCNT_dec(LvTARG(sv));
5957 Safefree(GvNAME(sv));
5958 /* cannot decrease stash refcount yet, as we might recursively delete
5959 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5960 of stash until current sv is completely gone.
5961 -- JohnPC, 27 Mar 1998 */
5962 stash = GvSTASH(sv);
5968 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5970 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5971 /* Don't even bother with turning off the OOK flag. */
5980 SvREFCNT_dec(SvRV(sv));
5982 #ifdef PERL_OLD_COPY_ON_WRITE
5983 else if (SvPVX_const(sv)) {
5985 /* I believe I need to grab the global SV mutex here and
5986 then recheck the COW status. */
5988 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5991 sv_release_COW(sv, SvPVX_const(sv), SvCUR(sv), SvLEN(sv),
5992 SvUVX(sv), SV_COW_NEXT_SV(sv));
5993 /* And drop it here. */
5995 } else if (SvLEN(sv)) {
5996 Safefree(SvPVX_const(sv));
6000 else if (SvPVX_const(sv) && SvLEN(sv))
6001 Safefree(SvPVX_const(sv));
6002 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6003 unsharepvn(SvPVX_const(sv),
6004 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6018 switch (SvTYPE(sv)) {
6032 del_XPVIV(SvANY(sv));
6035 del_XPVNV(SvANY(sv));
6038 del_XPVMG(SvANY(sv));
6041 del_XPVLV(SvANY(sv));
6044 del_XPVAV(SvANY(sv));
6047 del_XPVHV(SvANY(sv));
6050 del_XPVCV(SvANY(sv));
6053 del_XPVGV(SvANY(sv));
6054 /* code duplication for increased performance. */
6055 SvFLAGS(sv) &= SVf_BREAK;
6056 SvFLAGS(sv) |= SVTYPEMASK;
6057 /* decrease refcount of the stash that owns this GV, if any */
6059 SvREFCNT_dec(stash);
6060 return; /* not break, SvFLAGS reset already happened */
6062 del_XPVBM(SvANY(sv));
6065 del_XPVFM(SvANY(sv));
6068 del_XPVIO(SvANY(sv));
6071 SvFLAGS(sv) &= SVf_BREAK;
6072 SvFLAGS(sv) |= SVTYPEMASK;
6076 =for apidoc sv_newref
6078 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6085 Perl_sv_newref(pTHX_ SV *sv)
6095 Decrement an SV's reference count, and if it drops to zero, call
6096 C<sv_clear> to invoke destructors and free up any memory used by
6097 the body; finally, deallocate the SV's head itself.
6098 Normally called via a wrapper macro C<SvREFCNT_dec>.
6104 Perl_sv_free(pTHX_ SV *sv)
6109 if (SvREFCNT(sv) == 0) {
6110 if (SvFLAGS(sv) & SVf_BREAK)
6111 /* this SV's refcnt has been artificially decremented to
6112 * trigger cleanup */
6114 if (PL_in_clean_all) /* All is fair */
6116 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6117 /* make sure SvREFCNT(sv)==0 happens very seldom */
6118 SvREFCNT(sv) = (~(U32)0)/2;
6121 if (ckWARN_d(WARN_INTERNAL))
6122 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6123 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6124 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6127 if (--(SvREFCNT(sv)) > 0)
6129 Perl_sv_free2(aTHX_ sv);
6133 Perl_sv_free2(pTHX_ SV *sv)
6138 if (ckWARN_d(WARN_DEBUGGING))
6139 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6140 "Attempt to free temp prematurely: SV 0x%"UVxf
6141 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6145 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6146 /* make sure SvREFCNT(sv)==0 happens very seldom */
6147 SvREFCNT(sv) = (~(U32)0)/2;
6158 Returns the length of the string in the SV. Handles magic and type
6159 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6165 Perl_sv_len(pTHX_ register SV *sv)
6173 len = mg_length(sv);
6175 (void)SvPV_const(sv, len);
6180 =for apidoc sv_len_utf8
6182 Returns the number of characters in the string in an SV, counting wide
6183 UTF-8 bytes as a single character. Handles magic and type coercion.
6189 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6190 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6191 * (Note that the mg_len is not the length of the mg_ptr field.)
6196 Perl_sv_len_utf8(pTHX_ register SV *sv)
6202 return mg_length(sv);
6206 const U8 *s = (U8*)SvPV_const(sv, len);
6207 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6209 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6211 #ifdef PERL_UTF8_CACHE_ASSERT
6212 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6216 ulen = Perl_utf8_length(aTHX_ s, s + len);
6217 if (!mg && !SvREADONLY(sv)) {
6218 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6219 mg = mg_find(sv, PERL_MAGIC_utf8);
6229 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6230 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6231 * between UTF-8 and byte offsets. There are two (substr offset and substr
6232 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6233 * and byte offset) cache positions.
6235 * The mg_len field is used by sv_len_utf8(), see its comments.
6236 * Note that the mg_len is not the length of the mg_ptr field.
6240 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
6241 I32 offsetp, const U8 *s, const U8 *start)
6245 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6247 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6251 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6253 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6254 (*mgp)->mg_ptr = (char *) *cachep;
6258 (*cachep)[i] = offsetp;
6259 (*cachep)[i+1] = s - start;
6267 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6268 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6269 * between UTF-8 and byte offsets. See also the comments of
6270 * S_utf8_mg_pos_init().
6274 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
6278 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6280 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6281 if (*mgp && (*mgp)->mg_ptr) {
6282 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6283 ASSERT_UTF8_CACHE(*cachep);
6284 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6286 else { /* We will skip to the right spot. */
6291 /* The assumption is that going backward is half
6292 * the speed of going forward (that's where the
6293 * 2 * backw in the below comes from). (The real
6294 * figure of course depends on the UTF-8 data.) */
6296 if ((*cachep)[i] > (STRLEN)uoff) {
6298 backw = (*cachep)[i] - (STRLEN)uoff;
6300 if (forw < 2 * backw)
6303 p = start + (*cachep)[i+1];
6305 /* Try this only for the substr offset (i == 0),
6306 * not for the substr length (i == 2). */
6307 else if (i == 0) { /* (*cachep)[i] < uoff */
6308 const STRLEN ulen = sv_len_utf8(sv);
6310 if ((STRLEN)uoff < ulen) {
6311 forw = (STRLEN)uoff - (*cachep)[i];
6312 backw = ulen - (STRLEN)uoff;
6314 if (forw < 2 * backw)
6315 p = start + (*cachep)[i+1];
6320 /* If the string is not long enough for uoff,
6321 * we could extend it, but not at this low a level. */
6325 if (forw < 2 * backw) {
6332 while (UTF8_IS_CONTINUATION(*p))
6337 /* Update the cache. */
6338 (*cachep)[i] = (STRLEN)uoff;
6339 (*cachep)[i+1] = p - start;
6341 /* Drop the stale "length" cache */
6350 if (found) { /* Setup the return values. */
6351 *offsetp = (*cachep)[i+1];
6352 *sp = start + *offsetp;
6355 *offsetp = send - start;
6357 else if (*sp < start) {
6363 #ifdef PERL_UTF8_CACHE_ASSERT
6368 while (n-- && s < send)
6372 assert(*offsetp == s - start);
6373 assert((*cachep)[0] == (STRLEN)uoff);
6374 assert((*cachep)[1] == *offsetp);
6376 ASSERT_UTF8_CACHE(*cachep);
6385 =for apidoc sv_pos_u2b
6387 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6388 the start of the string, to a count of the equivalent number of bytes; if
6389 lenp is non-zero, it does the same to lenp, but this time starting from
6390 the offset, rather than from the start of the string. Handles magic and
6397 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6398 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6399 * byte offsets. See also the comments of S_utf8_mg_pos().
6404 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6412 start = (U8*)SvPV_const(sv, len);
6416 const U8 *s = start;
6417 I32 uoffset = *offsetp;
6418 const U8 *send = s + len;
6422 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6424 if (!found && uoffset > 0) {
6425 while (s < send && uoffset--)
6429 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6431 *offsetp = s - start;
6436 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6440 if (!found && *lenp > 0) {
6443 while (s < send && ulen--)
6447 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6451 ASSERT_UTF8_CACHE(cache);
6463 =for apidoc sv_pos_b2u
6465 Converts the value pointed to by offsetp from a count of bytes from the
6466 start of the string, to a count of the equivalent number of UTF-8 chars.
6467 Handles magic and type coercion.
6473 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6474 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6475 * byte offsets. See also the comments of S_utf8_mg_pos().
6480 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6488 s = (const U8*)SvPV_const(sv, len);
6489 if ((I32)len < *offsetp)
6490 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6492 const U8* send = s + *offsetp;
6494 STRLEN *cache = NULL;
6498 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6499 mg = mg_find(sv, PERL_MAGIC_utf8);
6500 if (mg && mg->mg_ptr) {
6501 cache = (STRLEN *) mg->mg_ptr;
6502 if (cache[1] == (STRLEN)*offsetp) {
6503 /* An exact match. */
6504 *offsetp = cache[0];
6508 else if (cache[1] < (STRLEN)*offsetp) {
6509 /* We already know part of the way. */
6512 /* Let the below loop do the rest. */
6514 else { /* cache[1] > *offsetp */
6515 /* We already know all of the way, now we may
6516 * be able to walk back. The same assumption
6517 * is made as in S_utf8_mg_pos(), namely that
6518 * walking backward is twice slower than
6519 * walking forward. */
6520 STRLEN forw = *offsetp;
6521 STRLEN backw = cache[1] - *offsetp;
6523 if (!(forw < 2 * backw)) {
6524 const U8 *p = s + cache[1];
6531 while (UTF8_IS_CONTINUATION(*p)) {
6539 *offsetp = cache[0];
6541 /* Drop the stale "length" cache */
6549 ASSERT_UTF8_CACHE(cache);
6555 /* Call utf8n_to_uvchr() to validate the sequence
6556 * (unless a simple non-UTF character) */
6557 if (!UTF8_IS_INVARIANT(*s))
6558 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6567 if (!SvREADONLY(sv)) {
6569 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6570 mg = mg_find(sv, PERL_MAGIC_utf8);
6575 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6576 mg->mg_ptr = (char *) cache;
6581 cache[1] = *offsetp;
6582 /* Drop the stale "length" cache */
6595 Returns a boolean indicating whether the strings in the two SVs are
6596 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6597 coerce its args to strings if necessary.
6603 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6611 SV* svrecode = Nullsv;
6618 pv1 = SvPV_const(sv1, cur1);
6625 pv2 = SvPV_const(sv2, cur2);
6627 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6628 /* Differing utf8ness.
6629 * Do not UTF8size the comparands as a side-effect. */
6632 svrecode = newSVpvn(pv2, cur2);
6633 sv_recode_to_utf8(svrecode, PL_encoding);
6634 pv2 = SvPV(svrecode, cur2);
6637 svrecode = newSVpvn(pv1, cur1);
6638 sv_recode_to_utf8(svrecode, PL_encoding);
6639 pv1 = SvPV(svrecode, cur1);
6641 /* Now both are in UTF-8. */
6643 SvREFCNT_dec(svrecode);
6648 bool is_utf8 = TRUE;
6651 /* sv1 is the UTF-8 one,
6652 * if is equal it must be downgrade-able */
6653 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6659 /* sv2 is the UTF-8 one,
6660 * if is equal it must be downgrade-able */
6661 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6667 /* Downgrade not possible - cannot be eq */
6675 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6678 SvREFCNT_dec(svrecode);
6689 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6690 string in C<sv1> is less than, equal to, or greater than the string in
6691 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6692 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6698 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6701 const char *pv1, *pv2;
6704 SV *svrecode = Nullsv;
6711 pv1 = SvPV_const(sv1, cur1);
6718 pv2 = SvPV_const(sv2, cur2);
6720 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6721 /* Differing utf8ness.
6722 * Do not UTF8size the comparands as a side-effect. */
6725 svrecode = newSVpvn(pv2, cur2);
6726 sv_recode_to_utf8(svrecode, PL_encoding);
6727 pv2 = SvPV(svrecode, cur2);
6730 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6735 svrecode = newSVpvn(pv1, cur1);
6736 sv_recode_to_utf8(svrecode, PL_encoding);
6737 pv1 = SvPV(svrecode, cur1);
6740 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6746 cmp = cur2 ? -1 : 0;
6750 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6753 cmp = retval < 0 ? -1 : 1;
6754 } else if (cur1 == cur2) {
6757 cmp = cur1 < cur2 ? -1 : 1;
6762 SvREFCNT_dec(svrecode);
6771 =for apidoc sv_cmp_locale
6773 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6774 'use bytes' aware, handles get magic, and will coerce its args to strings
6775 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6781 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6783 #ifdef USE_LOCALE_COLLATE
6789 if (PL_collation_standard)
6793 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6795 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6797 if (!pv1 || !len1) {
6808 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6811 return retval < 0 ? -1 : 1;
6814 * When the result of collation is equality, that doesn't mean
6815 * that there are no differences -- some locales exclude some
6816 * characters from consideration. So to avoid false equalities,
6817 * we use the raw string as a tiebreaker.
6823 #endif /* USE_LOCALE_COLLATE */
6825 return sv_cmp(sv1, sv2);
6829 #ifdef USE_LOCALE_COLLATE
6832 =for apidoc sv_collxfrm
6834 Add Collate Transform magic to an SV if it doesn't already have it.
6836 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6837 scalar data of the variable, but transformed to such a format that a normal
6838 memory comparison can be used to compare the data according to the locale
6845 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6849 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6850 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6855 Safefree(mg->mg_ptr);
6857 if ((xf = mem_collxfrm(s, len, &xlen))) {
6858 if (SvREADONLY(sv)) {
6861 return xf + sizeof(PL_collation_ix);
6864 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6865 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6878 if (mg && mg->mg_ptr) {
6880 return mg->mg_ptr + sizeof(PL_collation_ix);
6888 #endif /* USE_LOCALE_COLLATE */
6893 Get a line from the filehandle and store it into the SV, optionally
6894 appending to the currently-stored string.
6900 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6904 register STDCHAR rslast;
6905 register STDCHAR *bp;
6911 if (SvTHINKFIRST(sv))
6912 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6913 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6915 However, perlbench says it's slower, because the existing swipe code
6916 is faster than copy on write.
6917 Swings and roundabouts. */
6918 SvUPGRADE(sv, SVt_PV);
6923 if (PerlIO_isutf8(fp)) {
6925 sv_utf8_upgrade_nomg(sv);
6926 sv_pos_u2b(sv,&append,0);
6928 } else if (SvUTF8(sv)) {
6929 SV *tsv = NEWSV(0,0);
6930 sv_gets(tsv, fp, 0);
6931 sv_utf8_upgrade_nomg(tsv);
6932 SvCUR_set(sv,append);
6935 goto return_string_or_null;
6940 if (PerlIO_isutf8(fp))
6943 if (IN_PERL_COMPILETIME) {
6944 /* we always read code in line mode */
6948 else if (RsSNARF(PL_rs)) {
6949 /* If it is a regular disk file use size from stat() as estimate
6950 of amount we are going to read - may result in malloc-ing
6951 more memory than we realy need if layers bellow reduce
6952 size we read (e.g. CRLF or a gzip layer)
6955 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6956 const Off_t offset = PerlIO_tell(fp);
6957 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6958 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6964 else if (RsRECORD(PL_rs)) {
6968 /* Grab the size of the record we're getting */
6969 recsize = SvIV(SvRV(PL_rs));
6970 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6973 /* VMS wants read instead of fread, because fread doesn't respect */
6974 /* RMS record boundaries. This is not necessarily a good thing to be */
6975 /* doing, but we've got no other real choice - except avoid stdio
6976 as implementation - perhaps write a :vms layer ?
6978 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6980 bytesread = PerlIO_read(fp, buffer, recsize);
6984 SvCUR_set(sv, bytesread += append);
6985 buffer[bytesread] = '\0';
6986 goto return_string_or_null;
6988 else if (RsPARA(PL_rs)) {
6994 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6995 if (PerlIO_isutf8(fp)) {
6996 rsptr = SvPVutf8(PL_rs, rslen);
6999 if (SvUTF8(PL_rs)) {
7000 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7001 Perl_croak(aTHX_ "Wide character in $/");
7004 rsptr = SvPV(PL_rs, rslen);
7008 rslast = rslen ? rsptr[rslen - 1] : '\0';
7010 if (rspara) { /* have to do this both before and after */
7011 do { /* to make sure file boundaries work right */
7014 i = PerlIO_getc(fp);
7018 PerlIO_ungetc(fp,i);
7024 /* See if we know enough about I/O mechanism to cheat it ! */
7026 /* This used to be #ifdef test - it is made run-time test for ease
7027 of abstracting out stdio interface. One call should be cheap
7028 enough here - and may even be a macro allowing compile
7032 if (PerlIO_fast_gets(fp)) {
7035 * We're going to steal some values from the stdio struct
7036 * and put EVERYTHING in the innermost loop into registers.
7038 register STDCHAR *ptr;
7042 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7043 /* An ungetc()d char is handled separately from the regular
7044 * buffer, so we getc() it back out and stuff it in the buffer.
7046 i = PerlIO_getc(fp);
7047 if (i == EOF) return 0;
7048 *(--((*fp)->_ptr)) = (unsigned char) i;
7052 /* Here is some breathtakingly efficient cheating */
7054 cnt = PerlIO_get_cnt(fp); /* get count into register */
7055 /* make sure we have the room */
7056 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7057 /* Not room for all of it
7058 if we are looking for a separator and room for some
7060 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7061 /* just process what we have room for */
7062 shortbuffered = cnt - SvLEN(sv) + append + 1;
7063 cnt -= shortbuffered;
7067 /* remember that cnt can be negative */
7068 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7073 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7074 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7075 DEBUG_P(PerlIO_printf(Perl_debug_log,
7076 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7077 DEBUG_P(PerlIO_printf(Perl_debug_log,
7078 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7079 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7080 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7085 while (cnt > 0) { /* this | eat */
7087 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7088 goto thats_all_folks; /* screams | sed :-) */
7092 Copy(ptr, bp, cnt, char); /* this | eat */
7093 bp += cnt; /* screams | dust */
7094 ptr += cnt; /* louder | sed :-) */
7099 if (shortbuffered) { /* oh well, must extend */
7100 cnt = shortbuffered;
7102 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7104 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7105 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7109 DEBUG_P(PerlIO_printf(Perl_debug_log,
7110 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7111 PTR2UV(ptr),(long)cnt));
7112 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7114 DEBUG_P(PerlIO_printf(Perl_debug_log,
7115 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7116 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7117 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7119 /* This used to call 'filbuf' in stdio form, but as that behaves like
7120 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7121 another abstraction. */
7122 i = PerlIO_getc(fp); /* get more characters */
7124 DEBUG_P(PerlIO_printf(Perl_debug_log,
7125 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7126 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7127 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7129 cnt = PerlIO_get_cnt(fp);
7130 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7131 DEBUG_P(PerlIO_printf(Perl_debug_log,
7132 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7134 if (i == EOF) /* all done for ever? */
7135 goto thats_really_all_folks;
7137 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7139 SvGROW(sv, bpx + cnt + 2);
7140 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7142 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7144 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7145 goto thats_all_folks;
7149 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7150 memNE((char*)bp - rslen, rsptr, rslen))
7151 goto screamer; /* go back to the fray */
7152 thats_really_all_folks:
7154 cnt += shortbuffered;
7155 DEBUG_P(PerlIO_printf(Perl_debug_log,
7156 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7157 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7158 DEBUG_P(PerlIO_printf(Perl_debug_log,
7159 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7160 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7161 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7163 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7164 DEBUG_P(PerlIO_printf(Perl_debug_log,
7165 "Screamer: done, len=%ld, string=|%.*s|\n",
7166 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7170 /*The big, slow, and stupid way. */
7171 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7173 New(0, buf, 8192, STDCHAR);
7181 const register STDCHAR *bpe = buf + sizeof(buf);
7183 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7184 ; /* keep reading */
7188 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7189 /* Accomodate broken VAXC compiler, which applies U8 cast to
7190 * both args of ?: operator, causing EOF to change into 255
7193 i = (U8)buf[cnt - 1];
7199 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7201 sv_catpvn(sv, (char *) buf, cnt);
7203 sv_setpvn(sv, (char *) buf, cnt);
7205 if (i != EOF && /* joy */
7207 SvCUR(sv) < rslen ||
7208 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7212 * If we're reading from a TTY and we get a short read,
7213 * indicating that the user hit his EOF character, we need
7214 * to notice it now, because if we try to read from the TTY
7215 * again, the EOF condition will disappear.
7217 * The comparison of cnt to sizeof(buf) is an optimization
7218 * that prevents unnecessary calls to feof().
7222 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7226 #ifdef USE_HEAP_INSTEAD_OF_STACK
7231 if (rspara) { /* have to do this both before and after */
7232 while (i != EOF) { /* to make sure file boundaries work right */
7233 i = PerlIO_getc(fp);
7235 PerlIO_ungetc(fp,i);
7241 return_string_or_null:
7242 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7248 Auto-increment of the value in the SV, doing string to numeric conversion
7249 if necessary. Handles 'get' magic.
7255 Perl_sv_inc(pTHX_ register SV *sv)
7264 if (SvTHINKFIRST(sv)) {
7266 sv_force_normal_flags(sv, 0);
7267 if (SvREADONLY(sv)) {
7268 if (IN_PERL_RUNTIME)
7269 Perl_croak(aTHX_ PL_no_modify);
7273 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7275 i = PTR2IV(SvRV(sv));
7280 flags = SvFLAGS(sv);
7281 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7282 /* It's (privately or publicly) a float, but not tested as an
7283 integer, so test it to see. */
7285 flags = SvFLAGS(sv);
7287 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7288 /* It's publicly an integer, or privately an integer-not-float */
7289 #ifdef PERL_PRESERVE_IVUV
7293 if (SvUVX(sv) == UV_MAX)
7294 sv_setnv(sv, UV_MAX_P1);
7296 (void)SvIOK_only_UV(sv);
7297 SvUV_set(sv, SvUVX(sv) + 1);
7299 if (SvIVX(sv) == IV_MAX)
7300 sv_setuv(sv, (UV)IV_MAX + 1);
7302 (void)SvIOK_only(sv);
7303 SvIV_set(sv, SvIVX(sv) + 1);
7308 if (flags & SVp_NOK) {
7309 (void)SvNOK_only(sv);
7310 SvNV_set(sv, SvNVX(sv) + 1.0);
7314 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7315 if ((flags & SVTYPEMASK) < SVt_PVIV)
7316 sv_upgrade(sv, SVt_IV);
7317 (void)SvIOK_only(sv);
7322 while (isALPHA(*d)) d++;
7323 while (isDIGIT(*d)) d++;
7325 #ifdef PERL_PRESERVE_IVUV
7326 /* Got to punt this as an integer if needs be, but we don't issue
7327 warnings. Probably ought to make the sv_iv_please() that does
7328 the conversion if possible, and silently. */
7329 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7330 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7331 /* Need to try really hard to see if it's an integer.
7332 9.22337203685478e+18 is an integer.
7333 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7334 so $a="9.22337203685478e+18"; $a+0; $a++
7335 needs to be the same as $a="9.22337203685478e+18"; $a++
7342 /* sv_2iv *should* have made this an NV */
7343 if (flags & SVp_NOK) {
7344 (void)SvNOK_only(sv);
7345 SvNV_set(sv, SvNVX(sv) + 1.0);
7348 /* I don't think we can get here. Maybe I should assert this
7349 And if we do get here I suspect that sv_setnv will croak. NWC
7351 #if defined(USE_LONG_DOUBLE)
7352 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",
7353 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7355 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7356 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7359 #endif /* PERL_PRESERVE_IVUV */
7360 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7364 while (d >= SvPVX_const(sv)) {
7372 /* MKS: The original code here died if letters weren't consecutive.
7373 * at least it didn't have to worry about non-C locales. The
7374 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7375 * arranged in order (although not consecutively) and that only
7376 * [A-Za-z] are accepted by isALPHA in the C locale.
7378 if (*d != 'z' && *d != 'Z') {
7379 do { ++*d; } while (!isALPHA(*d));
7382 *(d--) -= 'z' - 'a';
7387 *(d--) -= 'z' - 'a' + 1;
7391 /* oh,oh, the number grew */
7392 SvGROW(sv, SvCUR(sv) + 2);
7393 SvCUR_set(sv, SvCUR(sv) + 1);
7394 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7405 Auto-decrement of the value in the SV, doing string to numeric conversion
7406 if necessary. Handles 'get' magic.
7412 Perl_sv_dec(pTHX_ register SV *sv)
7420 if (SvTHINKFIRST(sv)) {
7422 sv_force_normal_flags(sv, 0);
7423 if (SvREADONLY(sv)) {
7424 if (IN_PERL_RUNTIME)
7425 Perl_croak(aTHX_ PL_no_modify);
7429 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7431 i = PTR2IV(SvRV(sv));
7436 /* Unlike sv_inc we don't have to worry about string-never-numbers
7437 and keeping them magic. But we mustn't warn on punting */
7438 flags = SvFLAGS(sv);
7439 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7440 /* It's publicly an integer, or privately an integer-not-float */
7441 #ifdef PERL_PRESERVE_IVUV
7445 if (SvUVX(sv) == 0) {
7446 (void)SvIOK_only(sv);
7450 (void)SvIOK_only_UV(sv);
7451 SvUV_set(sv, SvUVX(sv) + 1);
7454 if (SvIVX(sv) == IV_MIN)
7455 sv_setnv(sv, (NV)IV_MIN - 1.0);
7457 (void)SvIOK_only(sv);
7458 SvIV_set(sv, SvIVX(sv) - 1);
7463 if (flags & SVp_NOK) {
7464 SvNV_set(sv, SvNVX(sv) - 1.0);
7465 (void)SvNOK_only(sv);
7468 if (!(flags & SVp_POK)) {
7469 if ((flags & SVTYPEMASK) < SVt_PVNV)
7470 sv_upgrade(sv, SVt_NV);
7472 (void)SvNOK_only(sv);
7475 #ifdef PERL_PRESERVE_IVUV
7477 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7478 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7479 /* Need to try really hard to see if it's an integer.
7480 9.22337203685478e+18 is an integer.
7481 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7482 so $a="9.22337203685478e+18"; $a+0; $a--
7483 needs to be the same as $a="9.22337203685478e+18"; $a--
7490 /* sv_2iv *should* have made this an NV */
7491 if (flags & SVp_NOK) {
7492 (void)SvNOK_only(sv);
7493 SvNV_set(sv, SvNVX(sv) - 1.0);
7496 /* I don't think we can get here. Maybe I should assert this
7497 And if we do get here I suspect that sv_setnv will croak. NWC
7499 #if defined(USE_LONG_DOUBLE)
7500 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",
7501 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7503 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7504 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7508 #endif /* PERL_PRESERVE_IVUV */
7509 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7513 =for apidoc sv_mortalcopy
7515 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7516 The new SV is marked as mortal. It will be destroyed "soon", either by an
7517 explicit call to FREETMPS, or by an implicit call at places such as
7518 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7523 /* Make a string that will exist for the duration of the expression
7524 * evaluation. Actually, it may have to last longer than that, but
7525 * hopefully we won't free it until it has been assigned to a
7526 * permanent location. */
7529 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7534 sv_setsv(sv,oldstr);
7536 PL_tmps_stack[++PL_tmps_ix] = sv;
7542 =for apidoc sv_newmortal
7544 Creates a new null SV which is mortal. The reference count of the SV is
7545 set to 1. It will be destroyed "soon", either by an explicit call to
7546 FREETMPS, or by an implicit call at places such as statement boundaries.
7547 See also C<sv_mortalcopy> and C<sv_2mortal>.
7553 Perl_sv_newmortal(pTHX)
7558 SvFLAGS(sv) = SVs_TEMP;
7560 PL_tmps_stack[++PL_tmps_ix] = sv;
7565 =for apidoc sv_2mortal
7567 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7568 by an explicit call to FREETMPS, or by an implicit call at places such as
7569 statement boundaries. SvTEMP() is turned on which means that the SV's
7570 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7571 and C<sv_mortalcopy>.
7577 Perl_sv_2mortal(pTHX_ register SV *sv)
7582 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7585 PL_tmps_stack[++PL_tmps_ix] = sv;
7593 Creates a new SV and copies a string into it. The reference count for the
7594 SV is set to 1. If C<len> is zero, Perl will compute the length using
7595 strlen(). For efficiency, consider using C<newSVpvn> instead.
7601 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7606 sv_setpvn(sv,s,len ? len : strlen(s));
7611 =for apidoc newSVpvn
7613 Creates a new SV and copies a string into it. The reference count for the
7614 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7615 string. You are responsible for ensuring that the source string is at least
7616 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7622 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7627 sv_setpvn(sv,s,len);
7633 =for apidoc newSVhek
7635 Creates a new SV from the hash key structure. It will generate scalars that
7636 point to the shared string table where possible. Returns a new (undefined)
7637 SV if the hek is NULL.
7643 Perl_newSVhek(pTHX_ const HEK *hek)
7652 if (HEK_LEN(hek) == HEf_SVKEY) {
7653 return newSVsv(*(SV**)HEK_KEY(hek));
7655 const int flags = HEK_FLAGS(hek);
7656 if (flags & HVhek_WASUTF8) {
7658 Andreas would like keys he put in as utf8 to come back as utf8
7660 STRLEN utf8_len = HEK_LEN(hek);
7661 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7662 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7665 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7667 } else if (flags & HVhek_REHASH) {
7668 /* We don't have a pointer to the hv, so we have to replicate the
7669 flag into every HEK. This hv is using custom a hasing
7670 algorithm. Hence we can't return a shared string scalar, as
7671 that would contain the (wrong) hash value, and might get passed
7672 into an hv routine with a regular hash */
7674 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7679 /* This will be overwhelminly the most common case. */
7680 return newSVpvn_share(HEK_KEY(hek),
7681 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7687 =for apidoc newSVpvn_share
7689 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7690 table. If the string does not already exist in the table, it is created
7691 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7692 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7693 otherwise the hash is computed. The idea here is that as the string table
7694 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7695 hash lookup will avoid string compare.
7701 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7704 bool is_utf8 = FALSE;
7706 STRLEN tmplen = -len;
7708 /* See the note in hv.c:hv_fetch() --jhi */
7709 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7713 PERL_HASH(hash, src, len);
7715 sv_upgrade(sv, SVt_PVIV);
7716 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7729 #if defined(PERL_IMPLICIT_CONTEXT)
7731 /* pTHX_ magic can't cope with varargs, so this is a no-context
7732 * version of the main function, (which may itself be aliased to us).
7733 * Don't access this version directly.
7737 Perl_newSVpvf_nocontext(const char* pat, ...)
7742 va_start(args, pat);
7743 sv = vnewSVpvf(pat, &args);
7750 =for apidoc newSVpvf
7752 Creates a new SV and initializes it with the string formatted like
7759 Perl_newSVpvf(pTHX_ const char* pat, ...)
7763 va_start(args, pat);
7764 sv = vnewSVpvf(pat, &args);
7769 /* backend for newSVpvf() and newSVpvf_nocontext() */
7772 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7776 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7783 Creates a new SV and copies a floating point value into it.
7784 The reference count for the SV is set to 1.
7790 Perl_newSVnv(pTHX_ NV n)
7802 Creates a new SV and copies an integer into it. The reference count for the
7809 Perl_newSViv(pTHX_ IV i)
7821 Creates a new SV and copies an unsigned integer into it.
7822 The reference count for the SV is set to 1.
7828 Perl_newSVuv(pTHX_ UV u)
7838 =for apidoc newRV_noinc
7840 Creates an RV wrapper for an SV. The reference count for the original
7841 SV is B<not> incremented.
7847 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7852 sv_upgrade(sv, SVt_RV);
7854 SvRV_set(sv, tmpRef);
7859 /* newRV_inc is the official function name to use now.
7860 * newRV_inc is in fact #defined to newRV in sv.h
7864 Perl_newRV(pTHX_ SV *tmpRef)
7866 return newRV_noinc(SvREFCNT_inc(tmpRef));
7872 Creates a new SV which is an exact duplicate of the original SV.
7879 Perl_newSVsv(pTHX_ register SV *old)
7885 if (SvTYPE(old) == SVTYPEMASK) {
7886 if (ckWARN_d(WARN_INTERNAL))
7887 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7891 /* SV_GMAGIC is the default for sv_setv()
7892 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7893 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7894 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7899 =for apidoc sv_reset
7901 Underlying implementation for the C<reset> Perl function.
7902 Note that the perl-level function is vaguely deprecated.
7908 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7911 char todo[PERL_UCHAR_MAX+1];
7916 if (!*s) { /* reset ?? searches */
7917 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7919 PMOP *pm = (PMOP *) mg->mg_obj;
7921 pm->op_pmdynflags &= ~PMdf_USED;
7928 /* reset variables */
7930 if (!HvARRAY(stash))
7933 Zero(todo, 256, char);
7936 I32 i = (unsigned char)*s;
7940 max = (unsigned char)*s++;
7941 for ( ; i <= max; i++) {
7944 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7946 for (entry = HvARRAY(stash)[i];
7948 entry = HeNEXT(entry))
7953 if (!todo[(U8)*HeKEY(entry)])
7955 gv = (GV*)HeVAL(entry);
7957 if (SvTHINKFIRST(sv)) {
7958 if (!SvREADONLY(sv) && SvROK(sv))
7963 if (SvTYPE(sv) >= SVt_PV) {
7965 if (SvPVX_const(sv) != Nullch)
7972 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7975 #ifdef USE_ENVIRON_ARRAY
7977 # ifdef USE_ITHREADS
7978 && PL_curinterp == aTHX
7982 environ[0] = Nullch;
7985 #endif /* !PERL_MICRO */
7995 Using various gambits, try to get an IO from an SV: the IO slot if its a
7996 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7997 named after the PV if we're a string.
8003 Perl_sv_2io(pTHX_ SV *sv)
8008 switch (SvTYPE(sv)) {
8016 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8020 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8022 return sv_2io(SvRV(sv));
8023 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8029 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8038 Using various gambits, try to get a CV from an SV; in addition, try if
8039 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8045 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8052 return *gvp = Nullgv, Nullcv;
8053 switch (SvTYPE(sv)) {
8072 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8073 tryAMAGICunDEREF(to_cv);
8076 if (SvTYPE(sv) == SVt_PVCV) {
8085 Perl_croak(aTHX_ "Not a subroutine reference");
8090 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8096 if (lref && !GvCVu(gv)) {
8099 tmpsv = NEWSV(704,0);
8100 gv_efullname3(tmpsv, gv, Nullch);
8101 /* XXX this is probably not what they think they're getting.
8102 * It has the same effect as "sub name;", i.e. just a forward
8104 newSUB(start_subparse(FALSE, 0),
8105 newSVOP(OP_CONST, 0, tmpsv),
8110 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8120 Returns true if the SV has a true value by Perl's rules.
8121 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8122 instead use an in-line version.
8128 Perl_sv_true(pTHX_ register SV *sv)
8133 const register XPV* tXpv;
8134 if ((tXpv = (XPV*)SvANY(sv)) &&
8135 (tXpv->xpv_cur > 1 ||
8136 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8143 return SvIVX(sv) != 0;
8146 return SvNVX(sv) != 0.0;
8148 return sv_2bool(sv);
8156 A private implementation of the C<SvIVx> macro for compilers which can't
8157 cope with complex macro expressions. Always use the macro instead.
8163 Perl_sv_iv(pTHX_ register SV *sv)
8167 return (IV)SvUVX(sv);
8176 A private implementation of the C<SvUVx> macro for compilers which can't
8177 cope with complex macro expressions. Always use the macro instead.
8183 Perl_sv_uv(pTHX_ register SV *sv)
8188 return (UV)SvIVX(sv);
8196 A private implementation of the C<SvNVx> macro for compilers which can't
8197 cope with complex macro expressions. Always use the macro instead.
8203 Perl_sv_nv(pTHX_ register SV *sv)
8210 /* sv_pv() is now a macro using SvPV_nolen();
8211 * this function provided for binary compatibility only
8215 Perl_sv_pv(pTHX_ SV *sv)
8222 return sv_2pv(sv, &n_a);
8228 Use the C<SvPV_nolen> macro instead
8232 A private implementation of the C<SvPV> macro for compilers which can't
8233 cope with complex macro expressions. Always use the macro instead.
8239 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8245 return sv_2pv(sv, lp);
8250 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8256 return sv_2pv_flags(sv, lp, 0);
8259 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8260 * this function provided for binary compatibility only
8264 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8266 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8270 =for apidoc sv_pvn_force
8272 Get a sensible string out of the SV somehow.
8273 A private implementation of the C<SvPV_force> macro for compilers which
8274 can't cope with complex macro expressions. Always use the macro instead.
8276 =for apidoc sv_pvn_force_flags
8278 Get a sensible string out of the SV somehow.
8279 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8280 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8281 implemented in terms of this function.
8282 You normally want to use the various wrapper macros instead: see
8283 C<SvPV_force> and C<SvPV_force_nomg>
8289 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8292 if (SvTHINKFIRST(sv) && !SvROK(sv))
8293 sv_force_normal_flags(sv, 0);
8303 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8305 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8306 sv_reftype(sv,0), OP_NAME(PL_op));
8308 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
8311 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8312 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8316 s = sv_2pv_flags(sv, &len, flags);
8320 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8323 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8324 SvGROW(sv, len + 1);
8325 Move(s,SvPVX_const(sv),len,char);
8330 SvPOK_on(sv); /* validate pointer */
8332 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8333 PTR2UV(sv),SvPVX_const(sv)));
8336 return SvPVX_mutable(sv);
8339 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8340 * this function provided for binary compatibility only
8344 Perl_sv_pvbyte(pTHX_ SV *sv)
8346 sv_utf8_downgrade(sv,0);
8351 =for apidoc sv_pvbyte
8353 Use C<SvPVbyte_nolen> instead.
8355 =for apidoc sv_pvbyten
8357 A private implementation of the C<SvPVbyte> macro for compilers
8358 which can't cope with complex macro expressions. Always use the macro
8365 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8367 sv_utf8_downgrade(sv,0);
8368 return sv_pvn(sv,lp);
8372 =for apidoc sv_pvbyten_force
8374 A private implementation of the C<SvPVbytex_force> macro for compilers
8375 which can't cope with complex macro expressions. Always use the macro
8382 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8384 sv_pvn_force(sv,lp);
8385 sv_utf8_downgrade(sv,0);
8390 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8391 * this function provided for binary compatibility only
8395 Perl_sv_pvutf8(pTHX_ SV *sv)
8397 sv_utf8_upgrade(sv);
8402 =for apidoc sv_pvutf8
8404 Use the C<SvPVutf8_nolen> macro instead
8406 =for apidoc sv_pvutf8n
8408 A private implementation of the C<SvPVutf8> macro for compilers
8409 which can't cope with complex macro expressions. Always use the macro
8416 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8418 sv_utf8_upgrade(sv);
8419 return sv_pvn(sv,lp);
8423 =for apidoc sv_pvutf8n_force
8425 A private implementation of the C<SvPVutf8_force> macro for compilers
8426 which can't cope with complex macro expressions. Always use the macro
8433 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8435 sv_pvn_force(sv,lp);
8436 sv_utf8_upgrade(sv);
8442 =for apidoc sv_reftype
8444 Returns a string describing what the SV is a reference to.
8450 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8452 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8453 inside return suggests a const propagation bug in g++. */
8454 if (ob && SvOBJECT(sv)) {
8455 char *name = HvNAME_get(SvSTASH(sv));
8456 return name ? name : (char *) "__ANON__";
8459 switch (SvTYPE(sv)) {
8476 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8477 /* tied lvalues should appear to be
8478 * scalars for backwards compatitbility */
8479 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8480 ? "SCALAR" : "LVALUE");
8481 case SVt_PVAV: return "ARRAY";
8482 case SVt_PVHV: return "HASH";
8483 case SVt_PVCV: return "CODE";
8484 case SVt_PVGV: return "GLOB";
8485 case SVt_PVFM: return "FORMAT";
8486 case SVt_PVIO: return "IO";
8487 default: return "UNKNOWN";
8493 =for apidoc sv_isobject
8495 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8496 object. If the SV is not an RV, or if the object is not blessed, then this
8503 Perl_sv_isobject(pTHX_ SV *sv)
8520 Returns a boolean indicating whether the SV is blessed into the specified
8521 class. This does not check for subtypes; use C<sv_derived_from> to verify
8522 an inheritance relationship.
8528 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8540 hvname = HvNAME_get(SvSTASH(sv));
8544 return strEQ(hvname, name);
8550 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8551 it will be upgraded to one. If C<classname> is non-null then the new SV will
8552 be blessed in the specified package. The new SV is returned and its
8553 reference count is 1.
8559 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8565 SV_CHECK_THINKFIRST_COW_DROP(rv);
8568 if (SvTYPE(rv) >= SVt_PVMG) {
8569 const U32 refcnt = SvREFCNT(rv);
8573 SvREFCNT(rv) = refcnt;
8576 if (SvTYPE(rv) < SVt_RV)
8577 sv_upgrade(rv, SVt_RV);
8578 else if (SvTYPE(rv) > SVt_RV) {
8589 HV* stash = gv_stashpv(classname, TRUE);
8590 (void)sv_bless(rv, stash);
8596 =for apidoc sv_setref_pv
8598 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8599 argument will be upgraded to an RV. That RV will be modified to point to
8600 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8601 into the SV. The C<classname> argument indicates the package for the
8602 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8603 will have a reference count of 1, and the RV will be returned.
8605 Do not use with other Perl types such as HV, AV, SV, CV, because those
8606 objects will become corrupted by the pointer copy process.
8608 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8614 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8617 sv_setsv(rv, &PL_sv_undef);
8621 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8626 =for apidoc sv_setref_iv
8628 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8629 argument will be upgraded to an RV. That RV will be modified to point to
8630 the new SV. The C<classname> argument indicates the package for the
8631 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8632 will have a reference count of 1, and the RV will be returned.
8638 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8640 sv_setiv(newSVrv(rv,classname), iv);
8645 =for apidoc sv_setref_uv
8647 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8648 argument will be upgraded to an RV. That RV will be modified to point to
8649 the new SV. The C<classname> argument indicates the package for the
8650 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8651 will have a reference count of 1, and the RV will be returned.
8657 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8659 sv_setuv(newSVrv(rv,classname), uv);
8664 =for apidoc sv_setref_nv
8666 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8667 argument will be upgraded to an RV. That RV will be modified to point to
8668 the new SV. The C<classname> argument indicates the package for the
8669 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8670 will have a reference count of 1, and the RV will be returned.
8676 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8678 sv_setnv(newSVrv(rv,classname), nv);
8683 =for apidoc sv_setref_pvn
8685 Copies a string into a new SV, optionally blessing the SV. The length of the
8686 string must be specified with C<n>. The C<rv> argument will be upgraded to
8687 an RV. That RV will be modified to point to the new SV. The C<classname>
8688 argument indicates the package for the blessing. Set C<classname> to
8689 C<Nullch> to avoid the blessing. The new SV will have a reference count
8690 of 1, and the RV will be returned.
8692 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8698 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8700 sv_setpvn(newSVrv(rv,classname), pv, n);
8705 =for apidoc sv_bless
8707 Blesses an SV into a specified package. The SV must be an RV. The package
8708 must be designated by its stash (see C<gv_stashpv()>). The reference count
8709 of the SV is unaffected.
8715 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8719 Perl_croak(aTHX_ "Can't bless non-reference value");
8721 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8722 if (SvREADONLY(tmpRef))
8723 Perl_croak(aTHX_ PL_no_modify);
8724 if (SvOBJECT(tmpRef)) {
8725 if (SvTYPE(tmpRef) != SVt_PVIO)
8727 SvREFCNT_dec(SvSTASH(tmpRef));
8730 SvOBJECT_on(tmpRef);
8731 if (SvTYPE(tmpRef) != SVt_PVIO)
8733 SvUPGRADE(tmpRef, SVt_PVMG);
8734 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8741 if(SvSMAGICAL(tmpRef))
8742 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8750 /* Downgrades a PVGV to a PVMG.
8754 S_sv_unglob(pTHX_ SV *sv)
8758 assert(SvTYPE(sv) == SVt_PVGV);
8763 SvREFCNT_dec(GvSTASH(sv));
8764 GvSTASH(sv) = Nullhv;
8766 sv_unmagic(sv, PERL_MAGIC_glob);
8767 Safefree(GvNAME(sv));
8770 /* need to keep SvANY(sv) in the right arena */
8771 xpvmg = new_XPVMG();
8772 StructCopy(SvANY(sv), xpvmg, XPVMG);
8773 del_XPVGV(SvANY(sv));
8776 SvFLAGS(sv) &= ~SVTYPEMASK;
8777 SvFLAGS(sv) |= SVt_PVMG;
8781 =for apidoc sv_unref_flags
8783 Unsets the RV status of the SV, and decrements the reference count of
8784 whatever was being referenced by the RV. This can almost be thought of
8785 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8786 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8787 (otherwise the decrementing is conditional on the reference count being
8788 different from one or the reference being a readonly SV).
8795 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8799 if (SvWEAKREF(sv)) {
8807 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8808 assigned to as BEGIN {$a = \"Foo"} will fail. */
8809 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8811 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8812 sv_2mortal(rv); /* Schedule for freeing later */
8816 =for apidoc sv_unref
8818 Unsets the RV status of the SV, and decrements the reference count of
8819 whatever was being referenced by the RV. This can almost be thought of
8820 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8821 being zero. See C<SvROK_off>.
8827 Perl_sv_unref(pTHX_ SV *sv)
8829 sv_unref_flags(sv, 0);
8833 =for apidoc sv_taint
8835 Taint an SV. Use C<SvTAINTED_on> instead.
8840 Perl_sv_taint(pTHX_ SV *sv)
8842 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8846 =for apidoc sv_untaint
8848 Untaint an SV. Use C<SvTAINTED_off> instead.
8853 Perl_sv_untaint(pTHX_ SV *sv)
8855 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8856 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8863 =for apidoc sv_tainted
8865 Test an SV for taintedness. Use C<SvTAINTED> instead.
8870 Perl_sv_tainted(pTHX_ SV *sv)
8872 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8873 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8874 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8881 =for apidoc sv_setpviv
8883 Copies an integer into the given SV, also updating its string value.
8884 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8890 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8892 char buf[TYPE_CHARS(UV)];
8894 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8896 sv_setpvn(sv, ptr, ebuf - ptr);
8900 =for apidoc sv_setpviv_mg
8902 Like C<sv_setpviv>, but also handles 'set' magic.
8908 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8910 char buf[TYPE_CHARS(UV)];
8912 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8914 sv_setpvn(sv, ptr, ebuf - ptr);
8918 #if defined(PERL_IMPLICIT_CONTEXT)
8920 /* pTHX_ magic can't cope with varargs, so this is a no-context
8921 * version of the main function, (which may itself be aliased to us).
8922 * Don't access this version directly.
8926 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8930 va_start(args, pat);
8931 sv_vsetpvf(sv, pat, &args);
8935 /* pTHX_ magic can't cope with varargs, so this is a no-context
8936 * version of the main function, (which may itself be aliased to us).
8937 * Don't access this version directly.
8941 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8945 va_start(args, pat);
8946 sv_vsetpvf_mg(sv, pat, &args);
8952 =for apidoc sv_setpvf
8954 Works like C<sv_catpvf> but copies the text into the SV instead of
8955 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8961 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8964 va_start(args, pat);
8965 sv_vsetpvf(sv, pat, &args);
8970 =for apidoc sv_vsetpvf
8972 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8973 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8975 Usually used via its frontend C<sv_setpvf>.
8981 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8983 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8987 =for apidoc sv_setpvf_mg
8989 Like C<sv_setpvf>, but also handles 'set' magic.
8995 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8998 va_start(args, pat);
8999 sv_vsetpvf_mg(sv, pat, &args);
9004 =for apidoc sv_vsetpvf_mg
9006 Like C<sv_vsetpvf>, but also handles 'set' magic.
9008 Usually used via its frontend C<sv_setpvf_mg>.
9014 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9016 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9020 #if defined(PERL_IMPLICIT_CONTEXT)
9022 /* pTHX_ magic can't cope with varargs, so this is a no-context
9023 * version of the main function, (which may itself be aliased to us).
9024 * Don't access this version directly.
9028 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
9032 va_start(args, pat);
9033 sv_vcatpvf(sv, pat, &args);
9037 /* pTHX_ magic can't cope with varargs, so this is a no-context
9038 * version of the main function, (which may itself be aliased to us).
9039 * Don't access this version directly.
9043 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9047 va_start(args, pat);
9048 sv_vcatpvf_mg(sv, pat, &args);
9054 =for apidoc sv_catpvf
9056 Processes its arguments like C<sprintf> and appends the formatted
9057 output to an SV. If the appended data contains "wide" characters
9058 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9059 and characters >255 formatted with %c), the original SV might get
9060 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9061 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9062 valid UTF-8; if the original SV was bytes, the pattern should be too.
9067 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9070 va_start(args, pat);
9071 sv_vcatpvf(sv, pat, &args);
9076 =for apidoc sv_vcatpvf
9078 Processes its arguments like C<vsprintf> and appends the formatted output
9079 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9081 Usually used via its frontend C<sv_catpvf>.
9087 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9089 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9093 =for apidoc sv_catpvf_mg
9095 Like C<sv_catpvf>, but also handles 'set' magic.
9101 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9104 va_start(args, pat);
9105 sv_vcatpvf_mg(sv, pat, &args);
9110 =for apidoc sv_vcatpvf_mg
9112 Like C<sv_vcatpvf>, but also handles 'set' magic.
9114 Usually used via its frontend C<sv_catpvf_mg>.
9120 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9122 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9127 =for apidoc sv_vsetpvfn
9129 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9132 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9138 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9140 sv_setpvn(sv, "", 0);
9141 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9144 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9147 S_expect_number(pTHX_ char** pattern)
9150 switch (**pattern) {
9151 case '1': case '2': case '3':
9152 case '4': case '5': case '6':
9153 case '7': case '8': case '9':
9154 while (isDIGIT(**pattern))
9155 var = var * 10 + (*(*pattern)++ - '0');
9159 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9162 F0convert(NV nv, char *endbuf, STRLEN *len)
9164 const int neg = nv < 0;
9173 if (uv & 1 && uv == nv)
9174 uv--; /* Round to even */
9176 const unsigned dig = uv % 10;
9189 =for apidoc sv_vcatpvfn
9191 Processes its arguments like C<vsprintf> and appends the formatted output
9192 to an SV. Uses an array of SVs if the C style variable argument list is
9193 missing (NULL). When running with taint checks enabled, indicates via
9194 C<maybe_tainted> if results are untrustworthy (often due to the use of
9197 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9202 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9205 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9212 static const char nullstr[] = "(null)";
9214 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9215 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9217 /* Times 4: a decimal digit takes more than 3 binary digits.
9218 * NV_DIG: mantissa takes than many decimal digits.
9219 * Plus 32: Playing safe. */
9220 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9221 /* large enough for "%#.#f" --chip */
9222 /* what about long double NVs? --jhi */
9224 /* no matter what, this is a string now */
9225 (void)SvPV_force(sv, origlen);
9227 /* special-case "", "%s", and "%-p" (SVf) */
9230 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9232 const char *s = va_arg(*args, char*);
9233 sv_catpv(sv, s ? s : nullstr);
9235 else if (svix < svmax) {
9236 sv_catsv(sv, *svargs);
9237 if (DO_UTF8(*svargs))
9242 if (patlen == 3 && pat[0] == '%' &&
9243 pat[1] == '-' && pat[2] == 'p') {
9245 argsv = va_arg(*args, SV*);
9246 sv_catsv(sv, argsv);
9253 #ifndef USE_LONG_DOUBLE
9254 /* special-case "%.<number>[gf]" */
9255 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9256 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9257 unsigned digits = 0;
9261 while (*pp >= '0' && *pp <= '9')
9262 digits = 10 * digits + (*pp++ - '0');
9263 if (pp - pat == (int)patlen - 1) {
9267 nv = (NV)va_arg(*args, double);
9268 else if (svix < svmax)
9273 /* Add check for digits != 0 because it seems that some
9274 gconverts are buggy in this case, and we don't yet have
9275 a Configure test for this. */
9276 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9277 /* 0, point, slack */
9278 Gconvert(nv, (int)digits, 0, ebuf);
9280 if (*ebuf) /* May return an empty string for digits==0 */
9283 } else if (!digits) {
9286 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9287 sv_catpvn(sv, p, l);
9293 #endif /* !USE_LONG_DOUBLE */
9295 if (!args && svix < svmax && DO_UTF8(*svargs))
9298 patend = (char*)pat + patlen;
9299 for (p = (char*)pat; p < patend; p = q) {
9302 bool vectorize = FALSE;
9303 bool vectorarg = FALSE;
9304 bool vec_utf8 = FALSE;
9310 bool has_precis = FALSE;
9313 bool is_utf8 = FALSE; /* is this item utf8? */
9314 #ifdef HAS_LDBL_SPRINTF_BUG
9315 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9316 with sfio - Allen <allens@cpan.org> */
9317 bool fix_ldbl_sprintf_bug = FALSE;
9321 U8 utf8buf[UTF8_MAXBYTES+1];
9322 STRLEN esignlen = 0;
9324 const char *eptr = Nullch;
9327 const U8 *vecstr = Null(U8*);
9334 /* we need a long double target in case HAS_LONG_DOUBLE but
9337 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9345 const char *dotstr = ".";
9346 STRLEN dotstrlen = 1;
9347 I32 efix = 0; /* explicit format parameter index */
9348 I32 ewix = 0; /* explicit width index */
9349 I32 epix = 0; /* explicit precision index */
9350 I32 evix = 0; /* explicit vector index */
9351 bool asterisk = FALSE;
9353 /* echo everything up to the next format specification */
9354 for (q = p; q < patend && *q != '%'; ++q) ;
9356 if (has_utf8 && !pat_utf8)
9357 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9359 sv_catpvn(sv, p, q - p);
9366 We allow format specification elements in this order:
9367 \d+\$ explicit format parameter index
9369 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9370 0 flag (as above): repeated to allow "v02"
9371 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9372 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9374 [%bcdefginopsux_DFOUX] format (mandatory)
9376 if (EXPECT_NUMBER(q, width)) {
9417 if (EXPECT_NUMBER(q, ewix))
9426 if ((vectorarg = asterisk)) {
9438 EXPECT_NUMBER(q, width);
9443 vecsv = va_arg(*args, SV*);
9445 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9446 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9447 dotstr = SvPV_const(vecsv, dotstrlen);
9452 vecsv = va_arg(*args, SV*);
9453 vecstr = (U8*)SvPV_const(vecsv,veclen);
9454 vec_utf8 = DO_UTF8(vecsv);
9456 else if (efix ? efix <= svmax : svix < svmax) {
9457 vecsv = svargs[efix ? efix-1 : svix++];
9458 vecstr = (U8*)SvPV_const(vecsv,veclen);
9459 vec_utf8 = DO_UTF8(vecsv);
9460 /* if this is a version object, we need to return the
9461 * stringified representation (which the SvPVX_const has
9462 * already done for us), but not vectorize the args
9464 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9466 q++; /* skip past the rest of the %vd format */
9467 eptr = (const char *) vecstr;
9468 elen = strlen(eptr);
9481 i = va_arg(*args, int);
9483 i = (ewix ? ewix <= svmax : svix < svmax) ?
9484 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9486 width = (i < 0) ? -i : i;
9496 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9498 /* XXX: todo, support specified precision parameter */
9502 i = va_arg(*args, int);
9504 i = (ewix ? ewix <= svmax : svix < svmax)
9505 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9506 precis = (i < 0) ? 0 : i;
9511 precis = precis * 10 + (*q++ - '0');
9520 case 'I': /* Ix, I32x, and I64x */
9522 if (q[1] == '6' && q[2] == '4') {
9528 if (q[1] == '3' && q[2] == '2') {
9538 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9549 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9550 if (*(q + 1) == 'l') { /* lld, llf */
9575 argsv = (efix ? efix <= svmax : svix < svmax) ?
9576 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9583 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9585 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9587 eptr = (char*)utf8buf;
9588 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9599 if (args && !vectorize) {
9600 eptr = va_arg(*args, char*);
9602 #ifdef MACOS_TRADITIONAL
9603 /* On MacOS, %#s format is used for Pascal strings */
9608 elen = strlen(eptr);
9610 eptr = (char *)nullstr;
9611 elen = sizeof nullstr - 1;
9615 eptr = SvPVx_const(argsv, elen);
9616 if (DO_UTF8(argsv)) {
9617 if (has_precis && precis < elen) {
9619 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9622 if (width) { /* fudge width (can't fudge elen) */
9623 width += elen - sv_len_utf8(argsv);
9631 if (has_precis && elen > precis)
9638 if (left && args) { /* SVf */
9647 argsv = va_arg(*args, SV*);
9648 eptr = SvPVx_const(argsv, elen);
9653 if (alt || vectorize)
9655 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9673 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9682 esignbuf[esignlen++] = plus;
9686 case 'h': iv = (short)va_arg(*args, int); break;
9687 case 'l': iv = va_arg(*args, long); break;
9688 case 'V': iv = va_arg(*args, IV); break;
9689 default: iv = va_arg(*args, int); break;
9691 case 'q': iv = va_arg(*args, Quad_t); break;
9696 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9698 case 'h': iv = (short)tiv; break;
9699 case 'l': iv = (long)tiv; break;
9701 default: iv = tiv; break;
9703 case 'q': iv = (Quad_t)tiv; break;
9707 if ( !vectorize ) /* we already set uv above */
9712 esignbuf[esignlen++] = plus;
9716 esignbuf[esignlen++] = '-';
9759 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9770 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9771 case 'l': uv = va_arg(*args, unsigned long); break;
9772 case 'V': uv = va_arg(*args, UV); break;
9773 default: uv = va_arg(*args, unsigned); break;
9775 case 'q': uv = va_arg(*args, Uquad_t); break;
9780 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9782 case 'h': uv = (unsigned short)tuv; break;
9783 case 'l': uv = (unsigned long)tuv; break;
9785 default: uv = tuv; break;
9787 case 'q': uv = (Uquad_t)tuv; break;
9794 char *ptr = ebuf + sizeof ebuf;
9800 p = (char*)((c == 'X')
9801 ? "0123456789ABCDEF" : "0123456789abcdef");
9807 esignbuf[esignlen++] = '0';
9808 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9816 if (alt && *ptr != '0')
9825 esignbuf[esignlen++] = '0';
9826 esignbuf[esignlen++] = 'b';
9829 default: /* it had better be ten or less */
9833 } while (uv /= base);
9836 elen = (ebuf + sizeof ebuf) - ptr;
9840 zeros = precis - elen;
9841 else if (precis == 0 && elen == 1 && *eptr == '0')
9847 /* FLOATING POINT */
9850 c = 'f'; /* maybe %F isn't supported here */
9856 /* This is evil, but floating point is even more evil */
9858 /* for SV-style calling, we can only get NV
9859 for C-style calling, we assume %f is double;
9860 for simplicity we allow any of %Lf, %llf, %qf for long double
9864 #if defined(USE_LONG_DOUBLE)
9868 /* [perl #20339] - we should accept and ignore %lf rather than die */
9872 #if defined(USE_LONG_DOUBLE)
9873 intsize = args ? 0 : 'q';
9877 #if defined(HAS_LONG_DOUBLE)
9886 /* now we need (long double) if intsize == 'q', else (double) */
9887 nv = (args && !vectorize) ?
9888 #if LONG_DOUBLESIZE > DOUBLESIZE
9890 va_arg(*args, long double) :
9891 va_arg(*args, double)
9893 va_arg(*args, double)
9899 if (c != 'e' && c != 'E') {
9901 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9902 will cast our (long double) to (double) */
9903 (void)Perl_frexp(nv, &i);
9904 if (i == PERL_INT_MIN)
9905 Perl_die(aTHX_ "panic: frexp");
9907 need = BIT_DIGITS(i);
9909 need += has_precis ? precis : 6; /* known default */
9914 #ifdef HAS_LDBL_SPRINTF_BUG
9915 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9916 with sfio - Allen <allens@cpan.org> */
9919 # define MY_DBL_MAX DBL_MAX
9920 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9921 # if DOUBLESIZE >= 8
9922 # define MY_DBL_MAX 1.7976931348623157E+308L
9924 # define MY_DBL_MAX 3.40282347E+38L
9928 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9929 # define MY_DBL_MAX_BUG 1L
9931 # define MY_DBL_MAX_BUG MY_DBL_MAX
9935 # define MY_DBL_MIN DBL_MIN
9936 # else /* XXX guessing! -Allen */
9937 # if DOUBLESIZE >= 8
9938 # define MY_DBL_MIN 2.2250738585072014E-308L
9940 # define MY_DBL_MIN 1.17549435E-38L
9944 if ((intsize == 'q') && (c == 'f') &&
9945 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9947 /* it's going to be short enough that
9948 * long double precision is not needed */
9950 if ((nv <= 0L) && (nv >= -0L))
9951 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9953 /* would use Perl_fp_class as a double-check but not
9954 * functional on IRIX - see perl.h comments */
9956 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9957 /* It's within the range that a double can represent */
9958 #if defined(DBL_MAX) && !defined(DBL_MIN)
9959 if ((nv >= ((long double)1/DBL_MAX)) ||
9960 (nv <= (-(long double)1/DBL_MAX)))
9962 fix_ldbl_sprintf_bug = TRUE;
9965 if (fix_ldbl_sprintf_bug == TRUE) {
9975 # undef MY_DBL_MAX_BUG
9978 #endif /* HAS_LDBL_SPRINTF_BUG */
9980 need += 20; /* fudge factor */
9981 if (PL_efloatsize < need) {
9982 Safefree(PL_efloatbuf);
9983 PL_efloatsize = need + 20; /* more fudge */
9984 New(906, PL_efloatbuf, PL_efloatsize, char);
9985 PL_efloatbuf[0] = '\0';
9988 if ( !(width || left || plus || alt) && fill != '0'
9989 && has_precis && intsize != 'q' ) { /* Shortcuts */
9990 /* See earlier comment about buggy Gconvert when digits,
9992 if ( c == 'g' && precis) {
9993 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9994 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9995 goto float_converted;
9996 } else if ( c == 'f' && !precis) {
9997 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10002 char *ptr = ebuf + sizeof ebuf;
10005 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10006 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10007 if (intsize == 'q') {
10008 /* Copy the one or more characters in a long double
10009 * format before the 'base' ([efgEFG]) character to
10010 * the format string. */
10011 static char const prifldbl[] = PERL_PRIfldbl;
10012 char const *p = prifldbl + sizeof(prifldbl) - 3;
10013 while (p >= prifldbl) { *--ptr = *p--; }
10018 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10023 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10035 /* No taint. Otherwise we are in the strange situation
10036 * where printf() taints but print($float) doesn't.
10038 #if defined(HAS_LONG_DOUBLE)
10039 if (intsize == 'q')
10040 (void)sprintf(PL_efloatbuf, ptr, nv);
10042 (void)sprintf(PL_efloatbuf, ptr, (double)nv);
10044 (void)sprintf(PL_efloatbuf, ptr, nv);
10048 eptr = PL_efloatbuf;
10049 elen = strlen(PL_efloatbuf);
10055 i = SvCUR(sv) - origlen;
10056 if (args && !vectorize) {
10058 case 'h': *(va_arg(*args, short*)) = i; break;
10059 default: *(va_arg(*args, int*)) = i; break;
10060 case 'l': *(va_arg(*args, long*)) = i; break;
10061 case 'V': *(va_arg(*args, IV*)) = i; break;
10063 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10068 sv_setuv_mg(argsv, (UV)i);
10070 continue; /* not "break" */
10076 if (!args && ckWARN(WARN_PRINTF) &&
10077 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10078 SV *msg = sv_newmortal();
10079 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10080 (PL_op->op_type == OP_PRTF) ? "" : "s");
10083 Perl_sv_catpvf(aTHX_ msg,
10084 "\"%%%c\"", c & 0xFF);
10086 Perl_sv_catpvf(aTHX_ msg,
10087 "\"%%\\%03"UVof"\"",
10090 sv_catpv(msg, "end of string");
10091 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10094 /* output mangled stuff ... */
10100 /* ... right here, because formatting flags should not apply */
10101 SvGROW(sv, SvCUR(sv) + elen + 1);
10103 Copy(eptr, p, elen, char);
10106 SvCUR_set(sv, p - SvPVX_const(sv));
10108 continue; /* not "break" */
10111 /* calculate width before utf8_upgrade changes it */
10112 have = esignlen + zeros + elen;
10114 if (is_utf8 != has_utf8) {
10117 sv_utf8_upgrade(sv);
10120 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10121 sv_utf8_upgrade(nsv);
10125 SvGROW(sv, SvCUR(sv) + elen + 1);
10130 need = (have > width ? have : width);
10133 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10135 if (esignlen && fill == '0') {
10136 for (i = 0; i < (int)esignlen; i++)
10137 *p++ = esignbuf[i];
10139 if (gap && !left) {
10140 memset(p, fill, gap);
10143 if (esignlen && fill != '0') {
10144 for (i = 0; i < (int)esignlen; i++)
10145 *p++ = esignbuf[i];
10148 for (i = zeros; i; i--)
10152 Copy(eptr, p, elen, char);
10156 memset(p, ' ', gap);
10161 Copy(dotstr, p, dotstrlen, char);
10165 vectorize = FALSE; /* done iterating over vecstr */
10172 SvCUR_set(sv, p - SvPVX_const(sv));
10180 /* =========================================================================
10182 =head1 Cloning an interpreter
10184 All the macros and functions in this section are for the private use of
10185 the main function, perl_clone().
10187 The foo_dup() functions make an exact copy of an existing foo thinngy.
10188 During the course of a cloning, a hash table is used to map old addresses
10189 to new addresses. The table is created and manipulated with the
10190 ptr_table_* functions.
10194 ============================================================================*/
10197 #if defined(USE_ITHREADS)
10199 #ifndef GpREFCNT_inc
10200 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10204 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10205 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10206 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10207 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10208 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10209 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10210 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10211 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10212 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10213 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10214 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10215 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10216 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10219 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10220 regcomp.c. AMS 20010712 */
10223 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10228 struct reg_substr_datum *s;
10231 return (REGEXP *)NULL;
10233 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10236 len = r->offsets[0];
10237 npar = r->nparens+1;
10239 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10240 Copy(r->program, ret->program, len+1, regnode);
10242 New(0, ret->startp, npar, I32);
10243 Copy(r->startp, ret->startp, npar, I32);
10244 New(0, ret->endp, npar, I32);
10245 Copy(r->startp, ret->startp, npar, I32);
10247 New(0, ret->substrs, 1, struct reg_substr_data);
10248 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10249 s->min_offset = r->substrs->data[i].min_offset;
10250 s->max_offset = r->substrs->data[i].max_offset;
10251 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10252 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10255 ret->regstclass = NULL;
10257 struct reg_data *d;
10258 const int count = r->data->count;
10260 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10261 char, struct reg_data);
10262 New(0, d->what, count, U8);
10265 for (i = 0; i < count; i++) {
10266 d->what[i] = r->data->what[i];
10267 switch (d->what[i]) {
10268 /* legal options are one of: sfpont
10269 see also regcomp.h and pregfree() */
10271 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10274 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10277 /* This is cheating. */
10278 New(0, d->data[i], 1, struct regnode_charclass_class);
10279 StructCopy(r->data->data[i], d->data[i],
10280 struct regnode_charclass_class);
10281 ret->regstclass = (regnode*)d->data[i];
10284 /* Compiled op trees are readonly, and can thus be
10285 shared without duplication. */
10287 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10291 d->data[i] = r->data->data[i];
10294 d->data[i] = r->data->data[i];
10296 ((reg_trie_data*)d->data[i])->refcount++;
10300 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10309 New(0, ret->offsets, 2*len+1, U32);
10310 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10312 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10313 ret->refcnt = r->refcnt;
10314 ret->minlen = r->minlen;
10315 ret->prelen = r->prelen;
10316 ret->nparens = r->nparens;
10317 ret->lastparen = r->lastparen;
10318 ret->lastcloseparen = r->lastcloseparen;
10319 ret->reganch = r->reganch;
10321 ret->sublen = r->sublen;
10323 if (RX_MATCH_COPIED(ret))
10324 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10326 ret->subbeg = Nullch;
10327 #ifdef PERL_OLD_COPY_ON_WRITE
10328 ret->saved_copy = Nullsv;
10331 ptr_table_store(PL_ptr_table, r, ret);
10335 /* duplicate a file handle */
10338 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10344 return (PerlIO*)NULL;
10346 /* look for it in the table first */
10347 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10351 /* create anew and remember what it is */
10352 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10353 ptr_table_store(PL_ptr_table, fp, ret);
10357 /* duplicate a directory handle */
10360 Perl_dirp_dup(pTHX_ DIR *dp)
10368 /* duplicate a typeglob */
10371 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10376 /* look for it in the table first */
10377 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10381 /* create anew and remember what it is */
10382 Newz(0, ret, 1, GP);
10383 ptr_table_store(PL_ptr_table, gp, ret);
10386 ret->gp_refcnt = 0; /* must be before any other dups! */
10387 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10388 ret->gp_io = io_dup_inc(gp->gp_io, param);
10389 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10390 ret->gp_av = av_dup_inc(gp->gp_av, param);
10391 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10392 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10393 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10394 ret->gp_cvgen = gp->gp_cvgen;
10395 ret->gp_flags = gp->gp_flags;
10396 ret->gp_line = gp->gp_line;
10397 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10401 /* duplicate a chain of magic */
10404 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10406 MAGIC *mgprev = (MAGIC*)NULL;
10409 return (MAGIC*)NULL;
10410 /* look for it in the table first */
10411 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10415 for (; mg; mg = mg->mg_moremagic) {
10417 Newz(0, nmg, 1, MAGIC);
10419 mgprev->mg_moremagic = nmg;
10422 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10423 nmg->mg_private = mg->mg_private;
10424 nmg->mg_type = mg->mg_type;
10425 nmg->mg_flags = mg->mg_flags;
10426 if (mg->mg_type == PERL_MAGIC_qr) {
10427 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10429 else if(mg->mg_type == PERL_MAGIC_backref) {
10430 const AV * const av = (AV*) mg->mg_obj;
10433 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10435 for (i = AvFILLp(av); i >= 0; i--) {
10436 if (!svp[i]) continue;
10437 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10440 else if (mg->mg_type == PERL_MAGIC_symtab) {
10441 nmg->mg_obj = mg->mg_obj;
10444 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10445 ? sv_dup_inc(mg->mg_obj, param)
10446 : sv_dup(mg->mg_obj, param);
10448 nmg->mg_len = mg->mg_len;
10449 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10450 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10451 if (mg->mg_len > 0) {
10452 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10453 if (mg->mg_type == PERL_MAGIC_overload_table &&
10454 AMT_AMAGIC((AMT*)mg->mg_ptr))
10456 AMT *amtp = (AMT*)mg->mg_ptr;
10457 AMT *namtp = (AMT*)nmg->mg_ptr;
10459 for (i = 1; i < NofAMmeth; i++) {
10460 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10464 else if (mg->mg_len == HEf_SVKEY)
10465 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10467 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10468 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10475 /* create a new pointer-mapping table */
10478 Perl_ptr_table_new(pTHX)
10481 Newz(0, tbl, 1, PTR_TBL_t);
10482 tbl->tbl_max = 511;
10483 tbl->tbl_items = 0;
10484 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10489 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10491 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10499 struct ptr_tbl_ent* pte;
10500 struct ptr_tbl_ent* pteend;
10501 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10502 pte->next = PL_pte_arenaroot;
10503 PL_pte_arenaroot = pte;
10505 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10506 PL_pte_root = ++pte;
10507 while (pte < pteend) {
10508 pte->next = pte + 1;
10514 STATIC struct ptr_tbl_ent*
10517 struct ptr_tbl_ent* pte;
10521 PL_pte_root = pte->next;
10526 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10528 p->next = PL_pte_root;
10532 /* map an existing pointer using a table */
10535 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10537 PTR_TBL_ENT_t *tblent;
10538 const UV hash = PTR_TABLE_HASH(sv);
10540 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10541 for (; tblent; tblent = tblent->next) {
10542 if (tblent->oldval == sv)
10543 return tblent->newval;
10545 return (void*)NULL;
10548 /* add a new entry to a pointer-mapping table */
10551 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10553 PTR_TBL_ENT_t *tblent, **otblent;
10554 /* XXX this may be pessimal on platforms where pointers aren't good
10555 * hash values e.g. if they grow faster in the most significant
10557 const UV hash = PTR_TABLE_HASH(oldv);
10561 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10562 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10563 if (tblent->oldval == oldv) {
10564 tblent->newval = newv;
10568 tblent = S_new_pte(aTHX);
10569 tblent->oldval = oldv;
10570 tblent->newval = newv;
10571 tblent->next = *otblent;
10574 if (!empty && tbl->tbl_items > tbl->tbl_max)
10575 ptr_table_split(tbl);
10578 /* double the hash bucket size of an existing ptr table */
10581 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10583 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10584 const UV oldsize = tbl->tbl_max + 1;
10585 UV newsize = oldsize * 2;
10588 Renew(ary, newsize, PTR_TBL_ENT_t*);
10589 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10590 tbl->tbl_max = --newsize;
10591 tbl->tbl_ary = ary;
10592 for (i=0; i < oldsize; i++, ary++) {
10593 PTR_TBL_ENT_t **curentp, **entp, *ent;
10596 curentp = ary + oldsize;
10597 for (entp = ary, ent = *ary; ent; ent = *entp) {
10598 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10600 ent->next = *curentp;
10610 /* remove all the entries from a ptr table */
10613 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10615 register PTR_TBL_ENT_t **array;
10616 register PTR_TBL_ENT_t *entry;
10620 if (!tbl || !tbl->tbl_items) {
10624 array = tbl->tbl_ary;
10626 max = tbl->tbl_max;
10630 PTR_TBL_ENT_t *oentry = entry;
10631 entry = entry->next;
10632 S_del_pte(aTHX_ oentry);
10635 if (++riter > max) {
10638 entry = array[riter];
10642 tbl->tbl_items = 0;
10645 /* clear and free a ptr table */
10648 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10653 ptr_table_clear(tbl);
10654 Safefree(tbl->tbl_ary);
10658 /* attempt to make everything in the typeglob readonly */
10661 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10663 GV *gv = (GV*)sstr;
10664 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10666 if (GvIO(gv) || GvFORM(gv)) {
10667 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10669 else if (!GvCV(gv)) {
10670 GvCV(gv) = (CV*)sv;
10673 /* CvPADLISTs cannot be shared */
10674 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10679 if (!GvUNIQUE(gv)) {
10681 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10682 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
10688 * write attempts will die with
10689 * "Modification of a read-only value attempted"
10695 SvREADONLY_on(GvSV(gv));
10699 GvAV(gv) = (AV*)sv;
10702 SvREADONLY_on(GvAV(gv));
10706 GvHV(gv) = (HV*)sv;
10709 SvREADONLY_on(GvHV(gv));
10712 return sstr; /* he_dup() will SvREFCNT_inc() */
10715 /* duplicate an SV of any type (including AV, HV etc) */
10718 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10721 SvRV_set(dstr, SvWEAKREF(sstr)
10722 ? sv_dup(SvRV(sstr), param)
10723 : sv_dup_inc(SvRV(sstr), param));
10726 else if (SvPVX_const(sstr)) {
10727 /* Has something there */
10729 /* Normal PV - clone whole allocated space */
10730 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10731 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10732 /* Not that normal - actually sstr is copy on write.
10733 But we are a true, independant SV, so: */
10734 SvREADONLY_off(dstr);
10739 /* Special case - not normally malloced for some reason */
10740 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10741 /* A "shared" PV - clone it as unshared string */
10742 if(SvPADTMP(sstr)) {
10743 /* However, some of them live in the pad
10744 and they should not have these flags
10747 SvPV_set(dstr, sharepvn(SvPVX_const(sstr), SvCUR(sstr),
10749 SvUV_set(dstr, SvUVX(sstr));
10752 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvCUR(sstr)));
10754 SvREADONLY_off(dstr);
10758 /* Some other special case - random pointer */
10759 SvPV_set(dstr, SvPVX(sstr));
10764 /* Copy the Null */
10765 if (SvTYPE(dstr) == SVt_RV)
10766 SvRV_set(dstr, NULL);
10773 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10778 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10780 /* look for it in the table first */
10781 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10785 if(param->flags & CLONEf_JOIN_IN) {
10786 /** We are joining here so we don't want do clone
10787 something that is bad **/
10788 const char *hvname;
10790 if(SvTYPE(sstr) == SVt_PVHV &&
10791 (hvname = HvNAME_get(sstr))) {
10792 /** don't clone stashes if they already exist **/
10793 HV* old_stash = gv_stashpv(hvname,0);
10794 return (SV*) old_stash;
10798 /* create anew and remember what it is */
10801 #ifdef DEBUG_LEAKING_SCALARS
10802 dstr->sv_debug_optype = sstr->sv_debug_optype;
10803 dstr->sv_debug_line = sstr->sv_debug_line;
10804 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10805 dstr->sv_debug_cloned = 1;
10807 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10809 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10813 ptr_table_store(PL_ptr_table, sstr, dstr);
10816 SvFLAGS(dstr) = SvFLAGS(sstr);
10817 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10818 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10821 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10822 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10823 PL_watch_pvx, SvPVX_const(sstr));
10826 /* don't clone objects whose class has asked us not to */
10827 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10828 SvFLAGS(dstr) &= ~SVTYPEMASK;
10829 SvOBJECT_off(dstr);
10833 switch (SvTYPE(sstr)) {
10835 SvANY(dstr) = NULL;
10838 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10839 SvIV_set(dstr, SvIVX(sstr));
10842 SvANY(dstr) = new_XNV();
10843 SvNV_set(dstr, SvNVX(sstr));
10846 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10847 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10850 SvANY(dstr) = new_XPV();
10851 SvCUR_set(dstr, SvCUR(sstr));
10852 SvLEN_set(dstr, SvLEN(sstr));
10853 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10856 SvANY(dstr) = new_XPVIV();
10857 SvCUR_set(dstr, SvCUR(sstr));
10858 SvLEN_set(dstr, SvLEN(sstr));
10859 SvIV_set(dstr, SvIVX(sstr));
10860 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10863 SvANY(dstr) = new_XPVNV();
10864 SvCUR_set(dstr, SvCUR(sstr));
10865 SvLEN_set(dstr, SvLEN(sstr));
10866 SvIV_set(dstr, SvIVX(sstr));
10867 SvNV_set(dstr, SvNVX(sstr));
10868 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10871 SvANY(dstr) = new_XPVMG();
10872 SvCUR_set(dstr, SvCUR(sstr));
10873 SvLEN_set(dstr, SvLEN(sstr));
10874 SvIV_set(dstr, SvIVX(sstr));
10875 SvNV_set(dstr, SvNVX(sstr));
10876 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10877 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10878 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10881 SvANY(dstr) = new_XPVBM();
10882 SvCUR_set(dstr, SvCUR(sstr));
10883 SvLEN_set(dstr, SvLEN(sstr));
10884 SvIV_set(dstr, SvIVX(sstr));
10885 SvNV_set(dstr, SvNVX(sstr));
10886 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10887 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10888 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10889 BmRARE(dstr) = BmRARE(sstr);
10890 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10891 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10894 SvANY(dstr) = new_XPVLV();
10895 SvCUR_set(dstr, SvCUR(sstr));
10896 SvLEN_set(dstr, SvLEN(sstr));
10897 SvIV_set(dstr, SvIVX(sstr));
10898 SvNV_set(dstr, SvNVX(sstr));
10899 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10900 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10901 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10902 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10903 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10904 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10905 LvTARG(dstr) = dstr;
10906 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10907 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10909 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10910 LvTYPE(dstr) = LvTYPE(sstr);
10913 if (GvUNIQUE((GV*)sstr)) {
10915 if ((share = gv_share(sstr, param))) {
10918 ptr_table_store(PL_ptr_table, sstr, dstr);
10920 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10921 HvNAME_get(GvSTASH(share)), GvNAME(share));
10926 SvANY(dstr) = new_XPVGV();
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 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10935 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10936 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10937 GvFLAGS(dstr) = GvFLAGS(sstr);
10938 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10939 (void)GpREFCNT_inc(GvGP(dstr));
10942 SvANY(dstr) = new_XPVIO();
10943 SvCUR_set(dstr, SvCUR(sstr));
10944 SvLEN_set(dstr, SvLEN(sstr));
10945 SvIV_set(dstr, SvIVX(sstr));
10946 SvNV_set(dstr, SvNVX(sstr));
10947 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10948 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10949 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10950 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10951 if (IoOFP(sstr) == IoIFP(sstr))
10952 IoOFP(dstr) = IoIFP(dstr);
10954 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10955 /* PL_rsfp_filters entries have fake IoDIRP() */
10956 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10957 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10959 IoDIRP(dstr) = IoDIRP(sstr);
10960 IoLINES(dstr) = IoLINES(sstr);
10961 IoPAGE(dstr) = IoPAGE(sstr);
10962 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10963 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10964 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10965 /* I have no idea why fake dirp (rsfps)
10966 should be treaded differently but otherwise
10967 we end up with leaks -- sky*/
10968 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10969 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10970 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10972 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10973 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10974 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10976 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10977 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10978 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10979 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10980 IoTYPE(dstr) = IoTYPE(sstr);
10981 IoFLAGS(dstr) = IoFLAGS(sstr);
10984 SvANY(dstr) = new_XPVAV();
10985 SvCUR_set(dstr, SvCUR(sstr));
10986 SvLEN_set(dstr, SvLEN(sstr));
10987 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10988 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10989 if (AvARRAY((AV*)sstr)) {
10990 SV **dst_ary, **src_ary;
10991 SSize_t items = AvFILLp((AV*)sstr) + 1;
10993 src_ary = AvARRAY((AV*)sstr);
10994 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10995 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10996 SvPV_set(dstr, (char*)dst_ary);
10997 AvALLOC((AV*)dstr) = dst_ary;
10998 if (AvREAL((AV*)sstr)) {
10999 while (items-- > 0)
11000 *dst_ary++ = sv_dup_inc(*src_ary++, param);
11003 while (items-- > 0)
11004 *dst_ary++ = sv_dup(*src_ary++, param);
11006 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
11007 while (items-- > 0) {
11008 *dst_ary++ = &PL_sv_undef;
11012 SvPV_set(dstr, Nullch);
11013 AvALLOC((AV*)dstr) = (SV**)NULL;
11017 SvANY(dstr) = new_XPVHV();
11018 SvCUR_set(dstr, SvCUR(sstr));
11019 SvLEN_set(dstr, SvLEN(sstr));
11020 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
11021 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11022 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11026 if (HvARRAY((HV*)sstr)) {
11028 const bool sharekeys = !!HvSHAREKEYS(sstr);
11029 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11030 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11033 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11034 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
11035 HvARRAY(dstr) = (HE**)darray;
11036 while (i <= sxhv->xhv_max) {
11037 HE *source = HvARRAY(sstr)[i];
11039 = source ? he_dup(source, sharekeys, param) : 0;
11043 struct xpvhv_aux *saux = HvAUX(sstr);
11044 struct xpvhv_aux *daux = HvAUX(dstr);
11045 /* This flag isn't copied. */
11046 /* SvOOK_on(hv) attacks the IV flags. */
11047 SvFLAGS(dstr) |= SVf_OOK;
11049 hvname = saux->xhv_name;
11050 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11052 daux->xhv_riter = saux->xhv_riter;
11053 daux->xhv_eiter = saux->xhv_eiter
11054 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11059 SvPV_set(dstr, Nullch);
11061 /* Record stashes for possible cloning in Perl_clone(). */
11063 av_push(param->stashes, dstr);
11067 SvANY(dstr) = new_XPVFM();
11068 FmLINES(dstr) = FmLINES(sstr);
11072 SvANY(dstr) = new_XPVCV();
11074 SvCUR_set(dstr, SvCUR(sstr));
11075 SvLEN_set(dstr, SvLEN(sstr));
11076 SvIV_set(dstr, SvIVX(sstr));
11077 SvNV_set(dstr, SvNVX(sstr));
11078 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11079 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11080 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11081 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11082 CvSTART(dstr) = CvSTART(sstr);
11084 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11086 CvXSUB(dstr) = CvXSUB(sstr);
11087 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11088 if (CvCONST(sstr)) {
11089 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11090 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11091 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11093 /* don't dup if copying back - CvGV isn't refcounted, so the
11094 * duped GV may never be freed. A bit of a hack! DAPM */
11095 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11096 Nullgv : gv_dup(CvGV(sstr), param) ;
11097 if (param->flags & CLONEf_COPY_STACKS) {
11098 CvDEPTH(dstr) = CvDEPTH(sstr);
11102 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11103 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11105 CvWEAKOUTSIDE(sstr)
11106 ? cv_dup( CvOUTSIDE(sstr), param)
11107 : cv_dup_inc(CvOUTSIDE(sstr), param);
11108 CvFLAGS(dstr) = CvFLAGS(sstr);
11109 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11112 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11116 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11122 /* duplicate a context */
11125 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11127 PERL_CONTEXT *ncxs;
11130 return (PERL_CONTEXT*)NULL;
11132 /* look for it in the table first */
11133 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11137 /* create anew and remember what it is */
11138 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11139 ptr_table_store(PL_ptr_table, cxs, ncxs);
11142 PERL_CONTEXT *cx = &cxs[ix];
11143 PERL_CONTEXT *ncx = &ncxs[ix];
11144 ncx->cx_type = cx->cx_type;
11145 if (CxTYPE(cx) == CXt_SUBST) {
11146 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11149 ncx->blk_oldsp = cx->blk_oldsp;
11150 ncx->blk_oldcop = cx->blk_oldcop;
11151 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11152 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11153 ncx->blk_oldpm = cx->blk_oldpm;
11154 ncx->blk_gimme = cx->blk_gimme;
11155 switch (CxTYPE(cx)) {
11157 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11158 ? cv_dup_inc(cx->blk_sub.cv, param)
11159 : cv_dup(cx->blk_sub.cv,param));
11160 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11161 ? av_dup_inc(cx->blk_sub.argarray, param)
11163 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11164 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11165 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11166 ncx->blk_sub.lval = cx->blk_sub.lval;
11167 ncx->blk_sub.retop = cx->blk_sub.retop;
11170 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11171 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11172 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11173 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11174 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11175 ncx->blk_eval.retop = cx->blk_eval.retop;
11178 ncx->blk_loop.label = cx->blk_loop.label;
11179 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11180 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11181 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11182 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11183 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11184 ? cx->blk_loop.iterdata
11185 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11186 ncx->blk_loop.oldcomppad
11187 = (PAD*)ptr_table_fetch(PL_ptr_table,
11188 cx->blk_loop.oldcomppad);
11189 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11190 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11191 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11192 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11193 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11196 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11197 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11198 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11199 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11200 ncx->blk_sub.retop = cx->blk_sub.retop;
11212 /* duplicate a stack info structure */
11215 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11220 return (PERL_SI*)NULL;
11222 /* look for it in the table first */
11223 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11227 /* create anew and remember what it is */
11228 Newz(56, nsi, 1, PERL_SI);
11229 ptr_table_store(PL_ptr_table, si, nsi);
11231 nsi->si_stack = av_dup_inc(si->si_stack, param);
11232 nsi->si_cxix = si->si_cxix;
11233 nsi->si_cxmax = si->si_cxmax;
11234 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11235 nsi->si_type = si->si_type;
11236 nsi->si_prev = si_dup(si->si_prev, param);
11237 nsi->si_next = si_dup(si->si_next, param);
11238 nsi->si_markoff = si->si_markoff;
11243 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11244 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11245 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11246 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11247 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11248 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11249 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11250 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11251 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11252 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11253 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11254 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11255 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11256 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11259 #define pv_dup_inc(p) SAVEPV(p)
11260 #define pv_dup(p) SAVEPV(p)
11261 #define svp_dup_inc(p,pp) any_dup(p,pp)
11263 /* map any object to the new equivent - either something in the
11264 * ptr table, or something in the interpreter structure
11268 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11273 return (void*)NULL;
11275 /* look for it in the table first */
11276 ret = ptr_table_fetch(PL_ptr_table, v);
11280 /* see if it is part of the interpreter structure */
11281 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11282 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11290 /* duplicate the save stack */
11293 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11295 ANY *ss = proto_perl->Tsavestack;
11296 I32 ix = proto_perl->Tsavestack_ix;
11297 I32 max = proto_perl->Tsavestack_max;
11309 void (*dptr) (void*);
11310 void (*dxptr) (pTHX_ void*);
11313 Newz(54, nss, max, ANY);
11316 I32 i = POPINT(ss,ix);
11317 TOPINT(nss,ix) = i;
11319 case SAVEt_ITEM: /* normal string */
11320 sv = (SV*)POPPTR(ss,ix);
11321 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11322 sv = (SV*)POPPTR(ss,ix);
11323 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11325 case SAVEt_SV: /* scalar reference */
11326 sv = (SV*)POPPTR(ss,ix);
11327 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11328 gv = (GV*)POPPTR(ss,ix);
11329 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11331 case SAVEt_GENERIC_PVREF: /* generic char* */
11332 c = (char*)POPPTR(ss,ix);
11333 TOPPTR(nss,ix) = pv_dup(c);
11334 ptr = POPPTR(ss,ix);
11335 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11337 case SAVEt_SHARED_PVREF: /* char* in shared space */
11338 c = (char*)POPPTR(ss,ix);
11339 TOPPTR(nss,ix) = savesharedpv(c);
11340 ptr = POPPTR(ss,ix);
11341 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11343 case SAVEt_GENERIC_SVREF: /* generic sv */
11344 case SAVEt_SVREF: /* scalar reference */
11345 sv = (SV*)POPPTR(ss,ix);
11346 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11347 ptr = POPPTR(ss,ix);
11348 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11350 case SAVEt_AV: /* array reference */
11351 av = (AV*)POPPTR(ss,ix);
11352 TOPPTR(nss,ix) = av_dup_inc(av, param);
11353 gv = (GV*)POPPTR(ss,ix);
11354 TOPPTR(nss,ix) = gv_dup(gv, param);
11356 case SAVEt_HV: /* hash reference */
11357 hv = (HV*)POPPTR(ss,ix);
11358 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11359 gv = (GV*)POPPTR(ss,ix);
11360 TOPPTR(nss,ix) = gv_dup(gv, param);
11362 case SAVEt_INT: /* int reference */
11363 ptr = POPPTR(ss,ix);
11364 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11365 intval = (int)POPINT(ss,ix);
11366 TOPINT(nss,ix) = intval;
11368 case SAVEt_LONG: /* long reference */
11369 ptr = POPPTR(ss,ix);
11370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11371 longval = (long)POPLONG(ss,ix);
11372 TOPLONG(nss,ix) = longval;
11374 case SAVEt_I32: /* I32 reference */
11375 case SAVEt_I16: /* I16 reference */
11376 case SAVEt_I8: /* I8 reference */
11377 ptr = POPPTR(ss,ix);
11378 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11380 TOPINT(nss,ix) = i;
11382 case SAVEt_IV: /* IV reference */
11383 ptr = POPPTR(ss,ix);
11384 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11386 TOPIV(nss,ix) = iv;
11388 case SAVEt_SPTR: /* SV* reference */
11389 ptr = POPPTR(ss,ix);
11390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11391 sv = (SV*)POPPTR(ss,ix);
11392 TOPPTR(nss,ix) = sv_dup(sv, param);
11394 case SAVEt_VPTR: /* random* reference */
11395 ptr = POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11397 ptr = POPPTR(ss,ix);
11398 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11400 case SAVEt_PPTR: /* char* reference */
11401 ptr = POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11403 c = (char*)POPPTR(ss,ix);
11404 TOPPTR(nss,ix) = pv_dup(c);
11406 case SAVEt_HPTR: /* HV* reference */
11407 ptr = POPPTR(ss,ix);
11408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11409 hv = (HV*)POPPTR(ss,ix);
11410 TOPPTR(nss,ix) = hv_dup(hv, param);
11412 case SAVEt_APTR: /* AV* reference */
11413 ptr = POPPTR(ss,ix);
11414 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11415 av = (AV*)POPPTR(ss,ix);
11416 TOPPTR(nss,ix) = av_dup(av, param);
11419 gv = (GV*)POPPTR(ss,ix);
11420 TOPPTR(nss,ix) = gv_dup(gv, param);
11422 case SAVEt_GP: /* scalar reference */
11423 gp = (GP*)POPPTR(ss,ix);
11424 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11425 (void)GpREFCNT_inc(gp);
11426 gv = (GV*)POPPTR(ss,ix);
11427 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11428 c = (char*)POPPTR(ss,ix);
11429 TOPPTR(nss,ix) = pv_dup(c);
11431 TOPIV(nss,ix) = iv;
11433 TOPIV(nss,ix) = iv;
11436 case SAVEt_MORTALIZESV:
11437 sv = (SV*)POPPTR(ss,ix);
11438 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11441 ptr = POPPTR(ss,ix);
11442 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11443 /* these are assumed to be refcounted properly */
11444 switch (((OP*)ptr)->op_type) {
11446 case OP_LEAVESUBLV:
11450 case OP_LEAVEWRITE:
11451 TOPPTR(nss,ix) = ptr;
11456 TOPPTR(nss,ix) = Nullop;
11461 TOPPTR(nss,ix) = Nullop;
11464 c = (char*)POPPTR(ss,ix);
11465 TOPPTR(nss,ix) = pv_dup_inc(c);
11467 case SAVEt_CLEARSV:
11468 longval = POPLONG(ss,ix);
11469 TOPLONG(nss,ix) = longval;
11472 hv = (HV*)POPPTR(ss,ix);
11473 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11474 c = (char*)POPPTR(ss,ix);
11475 TOPPTR(nss,ix) = pv_dup_inc(c);
11477 TOPINT(nss,ix) = i;
11479 case SAVEt_DESTRUCTOR:
11480 ptr = POPPTR(ss,ix);
11481 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11482 dptr = POPDPTR(ss,ix);
11483 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11484 any_dup(FPTR2DPTR(void *, dptr),
11487 case SAVEt_DESTRUCTOR_X:
11488 ptr = POPPTR(ss,ix);
11489 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11490 dxptr = POPDXPTR(ss,ix);
11491 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11492 any_dup(FPTR2DPTR(void *, dxptr),
11495 case SAVEt_REGCONTEXT:
11498 TOPINT(nss,ix) = i;
11501 case SAVEt_STACK_POS: /* Position on Perl stack */
11503 TOPINT(nss,ix) = i;
11505 case SAVEt_AELEM: /* array element */
11506 sv = (SV*)POPPTR(ss,ix);
11507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11509 TOPINT(nss,ix) = i;
11510 av = (AV*)POPPTR(ss,ix);
11511 TOPPTR(nss,ix) = av_dup_inc(av, param);
11513 case SAVEt_HELEM: /* hash element */
11514 sv = (SV*)POPPTR(ss,ix);
11515 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11516 sv = (SV*)POPPTR(ss,ix);
11517 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11518 hv = (HV*)POPPTR(ss,ix);
11519 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11522 ptr = POPPTR(ss,ix);
11523 TOPPTR(nss,ix) = ptr;
11527 TOPINT(nss,ix) = i;
11529 case SAVEt_COMPPAD:
11530 av = (AV*)POPPTR(ss,ix);
11531 TOPPTR(nss,ix) = av_dup(av, param);
11534 longval = (long)POPLONG(ss,ix);
11535 TOPLONG(nss,ix) = longval;
11536 ptr = POPPTR(ss,ix);
11537 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11538 sv = (SV*)POPPTR(ss,ix);
11539 TOPPTR(nss,ix) = sv_dup(sv, param);
11542 ptr = POPPTR(ss,ix);
11543 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11544 longval = (long)POPBOOL(ss,ix);
11545 TOPBOOL(nss,ix) = (bool)longval;
11547 case SAVEt_SET_SVFLAGS:
11549 TOPINT(nss,ix) = i;
11551 TOPINT(nss,ix) = i;
11552 sv = (SV*)POPPTR(ss,ix);
11553 TOPPTR(nss,ix) = sv_dup(sv, param);
11556 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11564 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11565 * flag to the result. This is done for each stash before cloning starts,
11566 * so we know which stashes want their objects cloned */
11569 do_mark_cloneable_stash(pTHX_ SV *sv)
11571 const HEK *hvname = HvNAME_HEK((HV*)sv);
11573 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11574 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11575 if (cloner && GvCV(cloner)) {
11582 XPUSHs(sv_2mortal(newSVhek(hvname)));
11584 call_sv((SV*)GvCV(cloner), G_SCALAR);
11591 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11599 =for apidoc perl_clone
11601 Create and return a new interpreter by cloning the current one.
11603 perl_clone takes these flags as parameters:
11605 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11606 without it we only clone the data and zero the stacks,
11607 with it we copy the stacks and the new perl interpreter is
11608 ready to run at the exact same point as the previous one.
11609 The pseudo-fork code uses COPY_STACKS while the
11610 threads->new doesn't.
11612 CLONEf_KEEP_PTR_TABLE
11613 perl_clone keeps a ptr_table with the pointer of the old
11614 variable as a key and the new variable as a value,
11615 this allows it to check if something has been cloned and not
11616 clone it again but rather just use the value and increase the
11617 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11618 the ptr_table using the function
11619 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11620 reason to keep it around is if you want to dup some of your own
11621 variable who are outside the graph perl scans, example of this
11622 code is in threads.xs create
11625 This is a win32 thing, it is ignored on unix, it tells perls
11626 win32host code (which is c++) to clone itself, this is needed on
11627 win32 if you want to run two threads at the same time,
11628 if you just want to do some stuff in a separate perl interpreter
11629 and then throw it away and return to the original one,
11630 you don't need to do anything.
11635 /* XXX the above needs expanding by someone who actually understands it ! */
11636 EXTERN_C PerlInterpreter *
11637 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11640 perl_clone(PerlInterpreter *proto_perl, UV flags)
11643 #ifdef PERL_IMPLICIT_SYS
11645 /* perlhost.h so we need to call into it
11646 to clone the host, CPerlHost should have a c interface, sky */
11648 if (flags & CLONEf_CLONE_HOST) {
11649 return perl_clone_host(proto_perl,flags);
11651 return perl_clone_using(proto_perl, flags,
11653 proto_perl->IMemShared,
11654 proto_perl->IMemParse,
11656 proto_perl->IStdIO,
11660 proto_perl->IProc);
11664 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11665 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11666 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11667 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11668 struct IPerlDir* ipD, struct IPerlSock* ipS,
11669 struct IPerlProc* ipP)
11671 /* XXX many of the string copies here can be optimized if they're
11672 * constants; they need to be allocated as common memory and just
11673 * their pointers copied. */
11676 CLONE_PARAMS clone_params;
11677 CLONE_PARAMS* param = &clone_params;
11679 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11680 /* for each stash, determine whether its objects should be cloned */
11681 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11682 PERL_SET_THX(my_perl);
11685 Poison(my_perl, 1, PerlInterpreter);
11687 PL_curcop = (COP *)Nullop;
11691 PL_savestack_ix = 0;
11692 PL_savestack_max = -1;
11693 PL_sig_pending = 0;
11694 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11695 # else /* !DEBUGGING */
11696 Zero(my_perl, 1, PerlInterpreter);
11697 # endif /* DEBUGGING */
11699 /* host pointers */
11701 PL_MemShared = ipMS;
11702 PL_MemParse = ipMP;
11709 #else /* !PERL_IMPLICIT_SYS */
11711 CLONE_PARAMS clone_params;
11712 CLONE_PARAMS* param = &clone_params;
11713 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11714 /* for each stash, determine whether its objects should be cloned */
11715 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11716 PERL_SET_THX(my_perl);
11719 Poison(my_perl, 1, PerlInterpreter);
11721 PL_curcop = (COP *)Nullop;
11725 PL_savestack_ix = 0;
11726 PL_savestack_max = -1;
11727 PL_sig_pending = 0;
11728 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11729 # else /* !DEBUGGING */
11730 Zero(my_perl, 1, PerlInterpreter);
11731 # endif /* DEBUGGING */
11732 #endif /* PERL_IMPLICIT_SYS */
11733 param->flags = flags;
11734 param->proto_perl = proto_perl;
11737 PL_xnv_arenaroot = NULL;
11738 PL_xnv_root = NULL;
11739 PL_xpv_arenaroot = NULL;
11740 PL_xpv_root = NULL;
11741 PL_xpviv_arenaroot = NULL;
11742 PL_xpviv_root = NULL;
11743 PL_xpvnv_arenaroot = NULL;
11744 PL_xpvnv_root = NULL;
11745 PL_xpvcv_arenaroot = NULL;
11746 PL_xpvcv_root = NULL;
11747 PL_xpvav_arenaroot = NULL;
11748 PL_xpvav_root = NULL;
11749 PL_xpvhv_arenaroot = NULL;
11750 PL_xpvhv_root = NULL;
11751 PL_xpvmg_arenaroot = NULL;
11752 PL_xpvmg_root = NULL;
11753 PL_xpvgv_arenaroot = NULL;
11754 PL_xpvgv_root = NULL;
11755 PL_xpvlv_arenaroot = NULL;
11756 PL_xpvlv_root = NULL;
11757 PL_xpvbm_arenaroot = NULL;
11758 PL_xpvbm_root = NULL;
11759 PL_he_arenaroot = NULL;
11761 #if defined(USE_ITHREADS)
11762 PL_pte_arenaroot = NULL;
11763 PL_pte_root = NULL;
11765 PL_nice_chunk = NULL;
11766 PL_nice_chunk_size = 0;
11768 PL_sv_objcount = 0;
11769 PL_sv_root = Nullsv;
11770 PL_sv_arenaroot = Nullsv;
11772 PL_debug = proto_perl->Idebug;
11774 PL_hash_seed = proto_perl->Ihash_seed;
11775 PL_rehash_seed = proto_perl->Irehash_seed;
11777 #ifdef USE_REENTRANT_API
11778 /* XXX: things like -Dm will segfault here in perlio, but doing
11779 * PERL_SET_CONTEXT(proto_perl);
11780 * breaks too many other things
11782 Perl_reentrant_init(aTHX);
11785 /* create SV map for pointer relocation */
11786 PL_ptr_table = ptr_table_new();
11787 /* and one for finding shared hash keys quickly */
11788 PL_shared_hek_table = ptr_table_new();
11790 /* initialize these special pointers as early as possible */
11791 SvANY(&PL_sv_undef) = NULL;
11792 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11793 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11794 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11796 SvANY(&PL_sv_no) = new_XPVNV();
11797 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11798 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11799 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11800 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11801 SvCUR_set(&PL_sv_no, 0);
11802 SvLEN_set(&PL_sv_no, 1);
11803 SvIV_set(&PL_sv_no, 0);
11804 SvNV_set(&PL_sv_no, 0);
11805 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11807 SvANY(&PL_sv_yes) = new_XPVNV();
11808 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11809 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11810 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11811 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11812 SvCUR_set(&PL_sv_yes, 1);
11813 SvLEN_set(&PL_sv_yes, 2);
11814 SvIV_set(&PL_sv_yes, 1);
11815 SvNV_set(&PL_sv_yes, 1);
11816 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11818 /* create (a non-shared!) shared string table */
11819 PL_strtab = newHV();
11820 HvSHAREKEYS_off(PL_strtab);
11821 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11822 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11824 PL_compiling = proto_perl->Icompiling;
11826 /* These two PVs will be free'd special way so must set them same way op.c does */
11827 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11828 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11830 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11831 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11833 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11834 if (!specialWARN(PL_compiling.cop_warnings))
11835 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11836 if (!specialCopIO(PL_compiling.cop_io))
11837 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11838 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11840 /* pseudo environmental stuff */
11841 PL_origargc = proto_perl->Iorigargc;
11842 PL_origargv = proto_perl->Iorigargv;
11844 param->stashes = newAV(); /* Setup array of objects to call clone on */
11846 #ifdef PERLIO_LAYERS
11847 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11848 PerlIO_clone(aTHX_ proto_perl, param);
11851 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11852 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11853 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11854 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11855 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11856 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11859 PL_minus_c = proto_perl->Iminus_c;
11860 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11861 PL_localpatches = proto_perl->Ilocalpatches;
11862 PL_splitstr = proto_perl->Isplitstr;
11863 PL_preprocess = proto_perl->Ipreprocess;
11864 PL_minus_n = proto_perl->Iminus_n;
11865 PL_minus_p = proto_perl->Iminus_p;
11866 PL_minus_l = proto_perl->Iminus_l;
11867 PL_minus_a = proto_perl->Iminus_a;
11868 PL_minus_F = proto_perl->Iminus_F;
11869 PL_doswitches = proto_perl->Idoswitches;
11870 PL_dowarn = proto_perl->Idowarn;
11871 PL_doextract = proto_perl->Idoextract;
11872 PL_sawampersand = proto_perl->Isawampersand;
11873 PL_unsafe = proto_perl->Iunsafe;
11874 PL_inplace = SAVEPV(proto_perl->Iinplace);
11875 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11876 PL_perldb = proto_perl->Iperldb;
11877 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11878 PL_exit_flags = proto_perl->Iexit_flags;
11880 /* magical thingies */
11881 /* XXX time(&PL_basetime) when asked for? */
11882 PL_basetime = proto_perl->Ibasetime;
11883 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11885 PL_maxsysfd = proto_perl->Imaxsysfd;
11886 PL_multiline = proto_perl->Imultiline;
11887 PL_statusvalue = proto_perl->Istatusvalue;
11889 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11891 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11893 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11894 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11895 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11897 /* Clone the regex array */
11898 PL_regex_padav = newAV();
11900 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11901 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11903 av_push(PL_regex_padav,
11904 sv_dup_inc(regexen[0],param));
11905 for(i = 1; i <= len; i++) {
11906 if(SvREPADTMP(regexen[i])) {
11907 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11909 av_push(PL_regex_padav,
11911 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11912 SvIVX(regexen[i])), param)))
11917 PL_regex_pad = AvARRAY(PL_regex_padav);
11919 /* shortcuts to various I/O objects */
11920 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11921 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11922 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11923 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11924 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11925 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11927 /* shortcuts to regexp stuff */
11928 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11930 /* shortcuts to misc objects */
11931 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11933 /* shortcuts to debugging objects */
11934 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11935 PL_DBline = gv_dup(proto_perl->IDBline, param);
11936 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11937 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11938 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11939 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11940 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11941 PL_lineary = av_dup(proto_perl->Ilineary, param);
11942 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11944 /* symbol tables */
11945 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11946 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11947 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11948 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11949 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11951 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11952 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11953 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11954 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11955 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11956 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11958 PL_sub_generation = proto_perl->Isub_generation;
11960 /* funky return mechanisms */
11961 PL_forkprocess = proto_perl->Iforkprocess;
11963 /* subprocess state */
11964 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11966 /* internal state */
11967 PL_tainting = proto_perl->Itainting;
11968 PL_taint_warn = proto_perl->Itaint_warn;
11969 PL_maxo = proto_perl->Imaxo;
11970 if (proto_perl->Iop_mask)
11971 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11973 PL_op_mask = Nullch;
11974 /* PL_asserting = proto_perl->Iasserting; */
11976 /* current interpreter roots */
11977 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11978 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11979 PL_main_start = proto_perl->Imain_start;
11980 PL_eval_root = proto_perl->Ieval_root;
11981 PL_eval_start = proto_perl->Ieval_start;
11983 /* runtime control stuff */
11984 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11985 PL_copline = proto_perl->Icopline;
11987 PL_filemode = proto_perl->Ifilemode;
11988 PL_lastfd = proto_perl->Ilastfd;
11989 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11992 PL_gensym = proto_perl->Igensym;
11993 PL_preambled = proto_perl->Ipreambled;
11994 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11995 PL_laststatval = proto_perl->Ilaststatval;
11996 PL_laststype = proto_perl->Ilaststype;
11997 PL_mess_sv = Nullsv;
11999 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
12000 PL_ofmt = SAVEPV(proto_perl->Iofmt);
12002 /* interpreter atexit processing */
12003 PL_exitlistlen = proto_perl->Iexitlistlen;
12004 if (PL_exitlistlen) {
12005 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12006 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12009 PL_exitlist = (PerlExitListEntry*)NULL;
12010 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
12011 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
12012 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12014 PL_profiledata = NULL;
12015 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
12016 /* PL_rsfp_filters entries have fake IoDIRP() */
12017 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
12019 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12021 PAD_CLONE_VARS(proto_perl, param);
12023 #ifdef HAVE_INTERP_INTERN
12024 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12027 /* more statics moved here */
12028 PL_generation = proto_perl->Igeneration;
12029 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12031 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12032 PL_in_clean_all = proto_perl->Iin_clean_all;
12034 PL_uid = proto_perl->Iuid;
12035 PL_euid = proto_perl->Ieuid;
12036 PL_gid = proto_perl->Igid;
12037 PL_egid = proto_perl->Iegid;
12038 PL_nomemok = proto_perl->Inomemok;
12039 PL_an = proto_perl->Ian;
12040 PL_evalseq = proto_perl->Ievalseq;
12041 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12042 PL_origalen = proto_perl->Iorigalen;
12043 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12044 PL_osname = SAVEPV(proto_perl->Iosname);
12045 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12046 PL_sighandlerp = proto_perl->Isighandlerp;
12049 PL_runops = proto_perl->Irunops;
12051 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12054 PL_cshlen = proto_perl->Icshlen;
12055 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12058 PL_lex_state = proto_perl->Ilex_state;
12059 PL_lex_defer = proto_perl->Ilex_defer;
12060 PL_lex_expect = proto_perl->Ilex_expect;
12061 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12062 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12063 PL_lex_starts = proto_perl->Ilex_starts;
12064 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12065 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12066 PL_lex_op = proto_perl->Ilex_op;
12067 PL_lex_inpat = proto_perl->Ilex_inpat;
12068 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12069 PL_lex_brackets = proto_perl->Ilex_brackets;
12070 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12071 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12072 PL_lex_casemods = proto_perl->Ilex_casemods;
12073 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12074 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12076 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12077 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12078 PL_nexttoke = proto_perl->Inexttoke;
12080 /* XXX This is probably masking the deeper issue of why
12081 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12082 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12083 * (A little debugging with a watchpoint on it may help.)
12085 if (SvANY(proto_perl->Ilinestr)) {
12086 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12087 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
12088 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12089 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
12090 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12091 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
12092 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12093 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
12094 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12097 PL_linestr = NEWSV(65,79);
12098 sv_upgrade(PL_linestr,SVt_PVIV);
12099 sv_setpvn(PL_linestr,"",0);
12100 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12102 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12103 PL_pending_ident = proto_perl->Ipending_ident;
12104 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12106 PL_expect = proto_perl->Iexpect;
12108 PL_multi_start = proto_perl->Imulti_start;
12109 PL_multi_end = proto_perl->Imulti_end;
12110 PL_multi_open = proto_perl->Imulti_open;
12111 PL_multi_close = proto_perl->Imulti_close;
12113 PL_error_count = proto_perl->Ierror_count;
12114 PL_subline = proto_perl->Isubline;
12115 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12117 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12118 if (SvANY(proto_perl->Ilinestr)) {
12119 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
12120 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12121 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
12122 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12123 PL_last_lop_op = proto_perl->Ilast_lop_op;
12126 PL_last_uni = SvPVX(PL_linestr);
12127 PL_last_lop = SvPVX(PL_linestr);
12128 PL_last_lop_op = 0;
12130 PL_in_my = proto_perl->Iin_my;
12131 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12133 PL_cryptseen = proto_perl->Icryptseen;
12136 PL_hints = proto_perl->Ihints;
12138 PL_amagic_generation = proto_perl->Iamagic_generation;
12140 #ifdef USE_LOCALE_COLLATE
12141 PL_collation_ix = proto_perl->Icollation_ix;
12142 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12143 PL_collation_standard = proto_perl->Icollation_standard;
12144 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12145 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12146 #endif /* USE_LOCALE_COLLATE */
12148 #ifdef USE_LOCALE_NUMERIC
12149 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12150 PL_numeric_standard = proto_perl->Inumeric_standard;
12151 PL_numeric_local = proto_perl->Inumeric_local;
12152 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12153 #endif /* !USE_LOCALE_NUMERIC */
12155 /* utf8 character classes */
12156 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12157 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12158 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12159 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12160 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12161 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12162 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12163 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12164 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12165 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12166 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12167 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12168 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12169 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12170 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12171 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12172 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12173 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12174 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12175 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12177 /* Did the locale setup indicate UTF-8? */
12178 PL_utf8locale = proto_perl->Iutf8locale;
12179 /* Unicode features (see perlrun/-C) */
12180 PL_unicode = proto_perl->Iunicode;
12182 /* Pre-5.8 signals control */
12183 PL_signals = proto_perl->Isignals;
12185 /* times() ticks per second */
12186 PL_clocktick = proto_perl->Iclocktick;
12188 /* Recursion stopper for PerlIO_find_layer */
12189 PL_in_load_module = proto_perl->Iin_load_module;
12191 /* sort() routine */
12192 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12194 /* Not really needed/useful since the reenrant_retint is "volatile",
12195 * but do it for consistency's sake. */
12196 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12198 /* Hooks to shared SVs and locks. */
12199 PL_sharehook = proto_perl->Isharehook;
12200 PL_lockhook = proto_perl->Ilockhook;
12201 PL_unlockhook = proto_perl->Iunlockhook;
12202 PL_threadhook = proto_perl->Ithreadhook;
12204 PL_runops_std = proto_perl->Irunops_std;
12205 PL_runops_dbg = proto_perl->Irunops_dbg;
12207 #ifdef THREADS_HAVE_PIDS
12208 PL_ppid = proto_perl->Ippid;
12212 PL_last_swash_hv = Nullhv; /* reinits on demand */
12213 PL_last_swash_klen = 0;
12214 PL_last_swash_key[0]= '\0';
12215 PL_last_swash_tmps = (U8*)NULL;
12216 PL_last_swash_slen = 0;
12218 PL_glob_index = proto_perl->Iglob_index;
12219 PL_srand_called = proto_perl->Isrand_called;
12220 PL_uudmap['M'] = 0; /* reinits on demand */
12221 PL_bitcount = Nullch; /* reinits on demand */
12223 if (proto_perl->Ipsig_pend) {
12224 Newz(0, PL_psig_pend, SIG_SIZE, int);
12227 PL_psig_pend = (int*)NULL;
12230 if (proto_perl->Ipsig_ptr) {
12231 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12232 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12233 for (i = 1; i < SIG_SIZE; i++) {
12234 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12235 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12239 PL_psig_ptr = (SV**)NULL;
12240 PL_psig_name = (SV**)NULL;
12243 /* thrdvar.h stuff */
12245 if (flags & CLONEf_COPY_STACKS) {
12246 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12247 PL_tmps_ix = proto_perl->Ttmps_ix;
12248 PL_tmps_max = proto_perl->Ttmps_max;
12249 PL_tmps_floor = proto_perl->Ttmps_floor;
12250 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12252 while (i <= PL_tmps_ix) {
12253 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12257 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12258 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12259 Newz(54, PL_markstack, i, I32);
12260 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12261 - proto_perl->Tmarkstack);
12262 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12263 - proto_perl->Tmarkstack);
12264 Copy(proto_perl->Tmarkstack, PL_markstack,
12265 PL_markstack_ptr - PL_markstack + 1, I32);
12267 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12268 * NOTE: unlike the others! */
12269 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12270 PL_scopestack_max = proto_perl->Tscopestack_max;
12271 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12272 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12274 /* NOTE: si_dup() looks at PL_markstack */
12275 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12277 /* PL_curstack = PL_curstackinfo->si_stack; */
12278 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12279 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12281 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12282 PL_stack_base = AvARRAY(PL_curstack);
12283 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12284 - proto_perl->Tstack_base);
12285 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12287 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12288 * NOTE: unlike the others! */
12289 PL_savestack_ix = proto_perl->Tsavestack_ix;
12290 PL_savestack_max = proto_perl->Tsavestack_max;
12291 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12292 PL_savestack = ss_dup(proto_perl, param);
12296 ENTER; /* perl_destruct() wants to LEAVE; */
12299 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12300 PL_top_env = &PL_start_env;
12302 PL_op = proto_perl->Top;
12305 PL_Xpv = (XPV*)NULL;
12306 PL_na = proto_perl->Tna;
12308 PL_statbuf = proto_perl->Tstatbuf;
12309 PL_statcache = proto_perl->Tstatcache;
12310 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12311 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12313 PL_timesbuf = proto_perl->Ttimesbuf;
12316 PL_tainted = proto_perl->Ttainted;
12317 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12318 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12319 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12320 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12321 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12322 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12323 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12324 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12325 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12327 PL_restartop = proto_perl->Trestartop;
12328 PL_in_eval = proto_perl->Tin_eval;
12329 PL_delaymagic = proto_perl->Tdelaymagic;
12330 PL_dirty = proto_perl->Tdirty;
12331 PL_localizing = proto_perl->Tlocalizing;
12333 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12334 PL_hv_fetch_ent_mh = Nullhe;
12335 PL_modcount = proto_perl->Tmodcount;
12336 PL_lastgotoprobe = Nullop;
12337 PL_dumpindent = proto_perl->Tdumpindent;
12339 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12340 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12341 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12342 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12343 PL_sortcxix = proto_perl->Tsortcxix;
12344 PL_efloatbuf = Nullch; /* reinits on demand */
12345 PL_efloatsize = 0; /* reinits on demand */
12349 PL_screamfirst = NULL;
12350 PL_screamnext = NULL;
12351 PL_maxscream = -1; /* reinits on demand */
12352 PL_lastscream = Nullsv;
12354 PL_watchaddr = NULL;
12355 PL_watchok = Nullch;
12357 PL_regdummy = proto_perl->Tregdummy;
12358 PL_regprecomp = Nullch;
12361 PL_colorset = 0; /* reinits PL_colors[] */
12362 /*PL_colors[6] = {0,0,0,0,0,0};*/
12363 PL_reginput = Nullch;
12364 PL_regbol = Nullch;
12365 PL_regeol = Nullch;
12366 PL_regstartp = (I32*)NULL;
12367 PL_regendp = (I32*)NULL;
12368 PL_reglastparen = (U32*)NULL;
12369 PL_reglastcloseparen = (U32*)NULL;
12370 PL_regtill = Nullch;
12371 PL_reg_start_tmp = (char**)NULL;
12372 PL_reg_start_tmpl = 0;
12373 PL_regdata = (struct reg_data*)NULL;
12376 PL_reg_eval_set = 0;
12378 PL_regprogram = (regnode*)NULL;
12380 PL_regcc = (CURCUR*)NULL;
12381 PL_reg_call_cc = (struct re_cc_state*)NULL;
12382 PL_reg_re = (regexp*)NULL;
12383 PL_reg_ganch = Nullch;
12384 PL_reg_sv = Nullsv;
12385 PL_reg_match_utf8 = FALSE;
12386 PL_reg_magic = (MAGIC*)NULL;
12388 PL_reg_oldcurpm = (PMOP*)NULL;
12389 PL_reg_curpm = (PMOP*)NULL;
12390 PL_reg_oldsaved = Nullch;
12391 PL_reg_oldsavedlen = 0;
12392 #ifdef PERL_OLD_COPY_ON_WRITE
12395 PL_reg_maxiter = 0;
12396 PL_reg_leftiter = 0;
12397 PL_reg_poscache = Nullch;
12398 PL_reg_poscache_size= 0;
12400 /* RE engine - function pointers */
12401 PL_regcompp = proto_perl->Tregcompp;
12402 PL_regexecp = proto_perl->Tregexecp;
12403 PL_regint_start = proto_perl->Tregint_start;
12404 PL_regint_string = proto_perl->Tregint_string;
12405 PL_regfree = proto_perl->Tregfree;
12407 PL_reginterp_cnt = 0;
12408 PL_reg_starttry = 0;
12410 /* Pluggable optimizer */
12411 PL_peepp = proto_perl->Tpeepp;
12413 PL_stashcache = newHV();
12415 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12416 ptr_table_free(PL_ptr_table);
12417 PL_ptr_table = NULL;
12418 ptr_table_free(PL_shared_hek_table);
12419 PL_shared_hek_table = NULL;
12422 /* Call the ->CLONE method, if it exists, for each of the stashes
12423 identified by sv_dup() above.
12425 while(av_len(param->stashes) != -1) {
12426 HV* stash = (HV*) av_shift(param->stashes);
12427 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12428 if (cloner && GvCV(cloner)) {
12433 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
12435 call_sv((SV*)GvCV(cloner), G_DISCARD);
12441 SvREFCNT_dec(param->stashes);
12443 /* orphaned? eg threads->new inside BEGIN or use */
12444 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12445 (void)SvREFCNT_inc(PL_compcv);
12446 SAVEFREESV(PL_compcv);
12452 #endif /* USE_ITHREADS */
12455 =head1 Unicode Support
12457 =for apidoc sv_recode_to_utf8
12459 The encoding is assumed to be an Encode object, on entry the PV
12460 of the sv is assumed to be octets in that encoding, and the sv
12461 will be converted into Unicode (and UTF-8).
12463 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12464 is not a reference, nothing is done to the sv. If the encoding is not
12465 an C<Encode::XS> Encoding object, bad things will happen.
12466 (See F<lib/encoding.pm> and L<Encode>).
12468 The PV of the sv is returned.
12473 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12476 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12490 Passing sv_yes is wrong - it needs to be or'ed set of constants
12491 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12492 remove converted chars from source.
12494 Both will default the value - let them.
12496 XPUSHs(&PL_sv_yes);
12499 call_method("decode", G_SCALAR);
12503 s = SvPV(uni, len);
12504 if (s != SvPVX_const(sv)) {
12505 SvGROW(sv, len + 1);
12506 Move(s, SvPVX_const(sv), len, char);
12507 SvCUR_set(sv, len);
12508 SvPVX(sv)[len] = 0;
12515 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12519 =for apidoc sv_cat_decode
12521 The encoding is assumed to be an Encode object, the PV of the ssv is
12522 assumed to be octets in that encoding and decoding the input starts
12523 from the position which (PV + *offset) pointed to. The dsv will be
12524 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12525 when the string tstr appears in decoding output or the input ends on
12526 the PV of the ssv. The value which the offset points will be modified
12527 to the last input position on the ssv.
12529 Returns TRUE if the terminator was found, else returns FALSE.
12534 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12535 SV *ssv, int *offset, char *tstr, int tlen)
12539 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12550 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12551 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12553 call_method("cat_decode", G_SCALAR);
12555 ret = SvTRUE(TOPs);
12556 *offset = SvIV(offsv);
12562 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12568 * c-indentation-style: bsd
12569 * c-basic-offset: 4
12570 * indent-tabs-mode: t
12573 * ex: set ts=8 sts=4 sw=4 noet: