3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 #ifdef DEBUG_LEAKING_SCALARS
171 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
173 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
179 #define plant_SV(p) \
181 FREE_SV_DEBUG_FILE(p); \
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
188 /* sv_mutex must be held while calling uproot_SV() */
189 #define uproot_SV(p) \
192 PL_sv_root = (SV*)SvANY(p); \
197 /* make some more SVs by adding another arena */
199 /* sv_mutex must be held while calling more_sv() */
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
211 char *chunk; /* must use New here to match call to */
212 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, 1008, 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)
290 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
292 svend = &sva[SvREFCNT(sva)];
293 if (p >= sv && p < svend) {
299 if (ckWARN_d(WARN_INTERNAL))
300 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
301 "Attempt to free non-arena SV: 0x%"UVxf
302 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
309 #else /* ! DEBUGGING */
311 #define del_SV(p) plant_SV(p)
313 #endif /* DEBUGGING */
317 =head1 SV Manipulation Functions
319 =for apidoc sv_add_arena
321 Given a chunk of memory, link it to the head of the list of arenas,
322 and split it into a list of free SVs.
328 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
334 /* The first SV in an arena isn't an SV. */
335 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
336 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
337 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
339 PL_sv_arenaroot = sva;
340 PL_sv_root = sva + 1;
342 svend = &sva[SvREFCNT(sva) - 1];
345 SvANY(sv) = (void *)(SV*)(sv + 1);
349 /* Must always set typemask because it's awlays checked in on cleanup
350 when the arenas are walked looking for objects. */
351 SvFLAGS(sv) = SVTYPEMASK;
358 SvFLAGS(sv) = SVTYPEMASK;
361 /* visit(): call the named function for each non-free SV in the arenas
362 * whose flags field matches the flags/mask args. */
365 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
372 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
373 svend = &sva[SvREFCNT(sva)];
374 for (sv = sva + 1; sv < svend; ++sv) {
375 if (SvTYPE(sv) != SVTYPEMASK
376 && (sv->sv_flags & mask) == flags
389 /* called by sv_report_used() for each live SV */
392 do_report_used(pTHX_ SV *sv)
394 if (SvTYPE(sv) != SVTYPEMASK) {
395 PerlIO_printf(Perl_debug_log, "****\n");
402 =for apidoc sv_report_used
404 Dump the contents of all SVs not yet freed. (Debugging aid).
410 Perl_sv_report_used(pTHX)
413 visit(do_report_used, 0, 0);
417 /* called by sv_clean_objs() for each live SV */
420 do_clean_objs(pTHX_ SV *sv)
424 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
425 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
437 /* XXX Might want to check arrays, etc. */
440 /* called by sv_clean_objs() for each live SV */
442 #ifndef DISABLE_DESTRUCTOR_KLUDGE
444 do_clean_named_objs(pTHX_ SV *sv)
446 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
447 if ( SvOBJECT(GvSV(sv)) ||
448 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
449 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
450 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
451 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
453 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
454 SvFLAGS(sv) |= SVf_BREAK;
462 =for apidoc sv_clean_objs
464 Attempt to destroy all objects not yet freed
470 Perl_sv_clean_objs(pTHX)
472 PL_in_clean_objs = TRUE;
473 visit(do_clean_objs, SVf_ROK, SVf_ROK);
474 #ifndef DISABLE_DESTRUCTOR_KLUDGE
475 /* some barnacles may yet remain, clinging to typeglobs */
476 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
478 PL_in_clean_objs = FALSE;
481 /* called by sv_clean_all() for each live SV */
484 do_clean_all(pTHX_ SV *sv)
486 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
487 SvFLAGS(sv) |= SVf_BREAK;
488 if (PL_comppad == (AV*)sv) {
490 PL_curpad = Null(SV**);
496 =for apidoc sv_clean_all
498 Decrement the refcnt of each remaining SV, possibly triggering a
499 cleanup. This function may have to be called multiple times to free
500 SVs which are in complex self-referential hierarchies.
506 Perl_sv_clean_all(pTHX)
509 PL_in_clean_all = TRUE;
510 cleaned = visit(do_clean_all, 0,0);
511 PL_in_clean_all = FALSE;
516 =for apidoc sv_free_arenas
518 Deallocate the memory used by all arenas. Note that all the individual SV
519 heads and bodies within the arenas must already have been freed.
525 Perl_sv_free_arenas(pTHX)
529 XPV *arena, *arenanext;
531 /* Free arenas here, but be careful about fake ones. (We assume
532 contiguity of the fake ones with the corresponding real ones.) */
534 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
535 svanext = (SV*) SvANY(sva);
536 while (svanext && SvFAKE(svanext))
537 svanext = (SV*) SvANY(svanext);
540 Safefree((void *)sva);
543 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
544 arenanext = (XPV*)arena->xpv_pv;
547 PL_xiv_arenaroot = 0;
550 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
551 arenanext = (XPV*)arena->xpv_pv;
554 PL_xnv_arenaroot = 0;
557 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
558 arenanext = (XPV*)arena->xpv_pv;
561 PL_xrv_arenaroot = 0;
564 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
565 arenanext = (XPV*)arena->xpv_pv;
568 PL_xpv_arenaroot = 0;
571 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
572 arenanext = (XPV*)arena->xpv_pv;
575 PL_xpviv_arenaroot = 0;
578 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
579 arenanext = (XPV*)arena->xpv_pv;
582 PL_xpvnv_arenaroot = 0;
585 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
586 arenanext = (XPV*)arena->xpv_pv;
589 PL_xpvcv_arenaroot = 0;
592 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
593 arenanext = (XPV*)arena->xpv_pv;
596 PL_xpvav_arenaroot = 0;
599 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
600 arenanext = (XPV*)arena->xpv_pv;
603 PL_xpvhv_arenaroot = 0;
606 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
607 arenanext = (XPV*)arena->xpv_pv;
610 PL_xpvmg_arenaroot = 0;
613 for (arena = (XPV*)PL_xpvgv_arenaroot; arena; arena = arenanext) {
614 arenanext = (XPV*)arena->xpv_pv;
617 PL_xpvgv_arenaroot = 0;
620 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
621 arenanext = (XPV*)arena->xpv_pv;
624 PL_xpvlv_arenaroot = 0;
627 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
628 arenanext = (XPV*)arena->xpv_pv;
631 PL_xpvbm_arenaroot = 0;
637 for (he = PL_he_arenaroot; he; he = he_next) {
638 he_next = HeNEXT(he);
645 #if defined(USE_ITHREADS)
647 struct ptr_tbl_ent *pte;
648 struct ptr_tbl_ent *pte_next;
649 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
650 pte_next = pte->next;
654 PL_pte_arenaroot = 0;
659 Safefree(PL_nice_chunk);
660 PL_nice_chunk = Nullch;
661 PL_nice_chunk_size = 0;
666 /* ---------------------------------------------------------------------
668 * support functions for report_uninit()
671 /* the maxiumum size of array or hash where we will scan looking
672 * for the undefined element that triggered the warning */
674 #define FUV_MAX_SEARCH_SIZE 1000
676 /* Look for an entry in the hash whose value has the same SV as val;
677 * If so, return a mortal copy of the key. */
680 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
686 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
687 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
692 for (i=HvMAX(hv); i>0; i--) {
694 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
695 if (HeVAL(entry) != val)
697 if ( HeVAL(entry) == &PL_sv_undef ||
698 HeVAL(entry) == &PL_sv_placeholder)
702 if (HeKLEN(entry) == HEf_SVKEY)
703 return sv_mortalcopy(HeKEY_sv(entry));
704 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
710 /* Look for an entry in the array whose value has the same SV as val;
711 * If so, return the index, otherwise return -1. */
714 S_find_array_subscript(pTHX_ AV *av, SV* val)
718 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
719 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
723 for (i=AvFILLp(av); i>=0; i--) {
724 if (svp[i] == val && svp[i] != &PL_sv_undef)
730 /* S_varname(): return the name of a variable, optionally with a subscript.
731 * If gv is non-zero, use the name of that global, along with gvtype (one
732 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
733 * targ. Depending on the value of the subscript_type flag, return:
736 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
737 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
738 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
739 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
742 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
743 SV* keyname, I32 aindex, int subscript_type)
749 name = sv_newmortal();
752 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
753 * XXX get rid of all this if gv_fullnameX() ever supports this
757 HV *hv = GvSTASH(gv);
758 sv_setpv(name, gvtype);
761 else if (!(p=HvNAME(hv)))
763 if (strNE(p, "main")) {
765 sv_catpvn(name,"::", 2);
767 if (GvNAMELEN(gv)>= 1 &&
768 ((unsigned int)*GvNAME(gv)) <= 26)
770 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
771 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
774 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
778 CV *cv = find_runcv(&u);
779 if (!cv || !CvPADLIST(cv))
781 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
782 sv = *av_fetch(av, targ, FALSE);
783 /* SvLEN in a pad name is not to be trusted */
784 sv_setpv(name, SvPV_nolen(sv));
787 if (subscript_type == FUV_SUBSCRIPT_HASH) {
790 Perl_sv_catpvf(aTHX_ name, "{%s}",
791 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
794 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
796 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
798 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
799 sv_insert(name, 0, 0, "within ", 7);
806 =for apidoc find_uninit_var
808 Find the name of the undefined variable (if any) that caused the operator o
809 to issue a "Use of uninitialized value" warning.
810 If match is true, only return a name if it's value matches uninit_sv.
811 So roughly speaking, if a unary operator (such as OP_COS) generates a
812 warning, then following the direct child of the op may yield an
813 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
814 other hand, with OP_ADD there are two branches to follow, so we only print
815 the variable name if we get an exact match.
817 The name is returned as a mortal SV.
819 Assumes that PL_op is the op that originally triggered the error, and that
820 PL_comppad/PL_curpad points to the currently executing pad.
826 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
835 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
836 uninit_sv == &PL_sv_placeholder)))
839 switch (obase->op_type) {
846 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
847 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
850 int subscript_type = FUV_SUBSCRIPT_WITHIN;
852 if (pad) { /* @lex, %lex */
853 sv = PAD_SVl(obase->op_targ);
857 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
858 /* @global, %global */
859 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
862 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
864 else /* @{expr}, %{expr} */
865 return find_uninit_var(cUNOPx(obase)->op_first,
869 /* attempt to find a match within the aggregate */
871 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
873 subscript_type = FUV_SUBSCRIPT_HASH;
876 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
878 subscript_type = FUV_SUBSCRIPT_ARRAY;
881 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
884 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
885 keysv, index, subscript_type);
889 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
891 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
892 Nullsv, 0, FUV_SUBSCRIPT_NONE);
895 gv = cGVOPx_gv(obase);
896 if (!gv || (match && GvSV(gv) != uninit_sv))
898 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
901 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
903 av = (AV*)PAD_SV(obase->op_targ);
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_ Nullgv, "$", obase->op_targ,
911 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
914 gv = cGVOPx_gv(obase);
919 if (!av || SvRMAGICAL(av))
921 svp = av_fetch(av, (I32)obase->op_private, FALSE);
922 if (!svp || *svp != uninit_sv)
925 return S_varname(aTHX_ gv, "$", 0,
926 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
931 o = cUNOPx(obase)->op_first;
932 if (!o || o->op_type != OP_NULL ||
933 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
935 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
940 /* $a[uninit_expr] or $h{uninit_expr} */
941 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
944 o = cBINOPx(obase)->op_first;
945 kid = cBINOPx(obase)->op_last;
947 /* get the av or hv, and optionally the gv */
949 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
950 sv = PAD_SV(o->op_targ);
952 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
953 && cUNOPo->op_first->op_type == OP_GV)
955 gv = cGVOPx_gv(cUNOPo->op_first);
958 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
963 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
964 /* index is constant */
968 if (obase->op_type == OP_HELEM) {
969 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
970 if (!he || HeVAL(he) != uninit_sv)
974 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
975 if (!svp || *svp != uninit_sv)
979 if (obase->op_type == OP_HELEM)
980 return S_varname(aTHX_ gv, "%", o->op_targ,
981 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
983 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
984 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
988 /* index is an expression;
989 * attempt to find a match within the aggregate */
990 if (obase->op_type == OP_HELEM) {
991 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
993 return S_varname(aTHX_ gv, "%", o->op_targ,
994 keysv, 0, FUV_SUBSCRIPT_HASH);
997 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
999 return S_varname(aTHX_ gv, "@", o->op_targ,
1000 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
1004 return S_varname(aTHX_ gv,
1005 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
1007 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
1013 /* only examine RHS */
1014 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
1017 o = cUNOPx(obase)->op_first;
1018 if (o->op_type == OP_PUSHMARK)
1021 if (!o->op_sibling) {
1022 /* one-arg version of open is highly magical */
1024 if (o->op_type == OP_GV) { /* open FOO; */
1026 if (match && GvSV(gv) != uninit_sv)
1028 return S_varname(aTHX_ gv, "$", 0,
1029 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1031 /* other possibilities not handled are:
1032 * open $x; or open my $x; should return '${*$x}'
1033 * open expr; should return '$'.expr ideally
1039 /* ops where $_ may be an implicit arg */
1043 if ( !(obase->op_flags & OPf_STACKED)) {
1044 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1045 ? PAD_SVl(obase->op_targ)
1048 sv = sv_newmortal();
1057 /* skip filehandle as it can't produce 'undef' warning */
1058 o = cUNOPx(obase)->op_first;
1059 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1060 o = o->op_sibling->op_sibling;
1067 match = 1; /* XS or custom code could trigger random warnings */
1072 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1073 return sv_2mortal(newSVpv("${$/}", 0));
1078 if (!(obase->op_flags & OPf_KIDS))
1080 o = cUNOPx(obase)->op_first;
1086 /* if all except one arg are constant, or have no side-effects,
1087 * or are optimized away, then it's unambiguous */
1089 for (kid=o; kid; kid = kid->op_sibling) {
1091 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1092 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1093 || (kid->op_type == OP_PUSHMARK)
1097 if (o2) { /* more than one found */
1104 return find_uninit_var(o2, uninit_sv, match);
1108 sv = find_uninit_var(o, uninit_sv, 1);
1120 =for apidoc report_uninit
1122 Print appropriate "Use of uninitialized variable" warning
1128 Perl_report_uninit(pTHX_ SV* uninit_sv)
1131 SV* varname = Nullsv;
1133 varname = find_uninit_var(PL_op, uninit_sv,0);
1135 sv_insert(varname, 0, 0, " ", 1);
1137 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1138 varname ? SvPV_nolen(varname) : "",
1139 " in ", OP_DESC(PL_op));
1142 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1147 /* allocate another arena's worth of struct xrv */
1155 New(712, ptr, PERL_ARENA_SIZE/sizeof(XPV), XPV);
1156 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1157 PL_xrv_arenaroot = ptr;
1160 xrvend = &xrv[PERL_ARENA_SIZE / sizeof(XRV) - 1];
1161 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1163 while (xrv < xrvend) {
1164 xrv->xrv_rv = (SV*)(xrv + 1);
1170 /* allocate another arena's worth of IV bodies */
1178 New(705, ptr, PERL_ARENA_SIZE/sizeof(XPV), XPV);
1179 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
1180 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
1183 xivend = &xiv[PERL_ARENA_SIZE / sizeof(IV) - 1];
1184 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
1186 while (xiv < xivend) {
1187 *(IV**)xiv = (IV *)(xiv + 1);
1193 /* allocate another arena's worth of NV bodies */
1201 New(711, ptr, PERL_ARENA_SIZE/sizeof(XPV), XPV);
1202 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1203 PL_xnv_arenaroot = ptr;
1206 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
1207 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1209 while (xnv < xnvend) {
1210 *(NV**)xnv = (NV*)(xnv + 1);
1216 /* allocate another arena's worth of struct xpv */
1223 New(713, xpv, PERL_ARENA_SIZE/sizeof(XPV), XPV);
1224 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1225 PL_xpv_arenaroot = xpv;
1227 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(XPV) - 1];
1228 PL_xpv_root = ++xpv;
1229 while (xpv < xpvend) {
1230 xpv->xpv_pv = (char*)(xpv + 1);
1236 /* allocate another arena's worth of struct xpviv */
1243 New(714, xpviv, PERL_ARENA_SIZE/sizeof(XPVIV), XPVIV);
1244 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1245 PL_xpviv_arenaroot = xpviv;
1247 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(XPVIV) - 1];
1248 PL_xpviv_root = ++xpviv;
1249 while (xpviv < xpvivend) {
1250 xpviv->xpv_pv = (char*)(xpviv + 1);
1256 /* allocate another arena's worth of struct xpvnv */
1263 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
1264 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1265 PL_xpvnv_arenaroot = xpvnv;
1267 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1268 PL_xpvnv_root = ++xpvnv;
1269 while (xpvnv < xpvnvend) {
1270 xpvnv->xpv_pv = (char*)(xpvnv + 1);
1276 /* allocate another arena's worth of struct xpvcv */
1283 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
1284 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1285 PL_xpvcv_arenaroot = xpvcv;
1287 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1288 PL_xpvcv_root = ++xpvcv;
1289 while (xpvcv < xpvcvend) {
1290 xpvcv->xpv_pv = (char*)(xpvcv + 1);
1296 /* allocate another arena's worth of struct xpvav */
1303 New(717, xpvav, PERL_ARENA_SIZE/sizeof(XPVAV), XPVAV);
1304 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1305 PL_xpvav_arenaroot = xpvav;
1307 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(XPVAV) - 1];
1308 PL_xpvav_root = ++xpvav;
1309 while (xpvav < xpvavend) {
1310 xpvav->xav_array = (char*)(xpvav + 1);
1313 xpvav->xav_array = 0;
1316 /* allocate another arena's worth of struct xpvhv */
1323 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(XPVHV), XPVHV);
1324 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1325 PL_xpvhv_arenaroot = xpvhv;
1327 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(XPVHV) - 1];
1328 PL_xpvhv_root = ++xpvhv;
1329 while (xpvhv < xpvhvend) {
1330 xpvhv->xhv_array = (char*)(xpvhv + 1);
1333 xpvhv->xhv_array = 0;
1336 /* allocate another arena's worth of struct xpvmg */
1343 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1344 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1345 PL_xpvmg_arenaroot = xpvmg;
1347 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1348 PL_xpvmg_root = ++xpvmg;
1349 while (xpvmg < xpvmgend) {
1350 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1356 /* allocate another arena's worth of struct xpvgv */
1363 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1364 xpvgv->xpv_pv = (char*)PL_xpvgv_arenaroot;
1365 PL_xpvgv_arenaroot = xpvgv;
1367 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1368 PL_xpvgv_root = ++xpvgv;
1369 while (xpvgv < xpvgvend) {
1370 xpvgv->xpv_pv = (char*)(xpvgv + 1);
1376 /* allocate another arena's worth of struct xpvlv */
1383 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1384 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1385 PL_xpvlv_arenaroot = xpvlv;
1387 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1388 PL_xpvlv_root = ++xpvlv;
1389 while (xpvlv < xpvlvend) {
1390 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1396 /* allocate another arena's worth of struct xpvbm */
1403 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1404 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1405 PL_xpvbm_arenaroot = xpvbm;
1407 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1408 PL_xpvbm_root = ++xpvbm;
1409 while (xpvbm < xpvbmend) {
1410 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1416 /* grab a new struct xrv from the free list, allocating more if necessary */
1426 PL_xrv_root = (XRV*)xrv->xrv_rv;
1431 /* return a struct xrv to the free list */
1434 S_del_xrv(pTHX_ XRV *p)
1437 p->xrv_rv = (SV*)PL_xrv_root;
1442 /* grab a new IV body from the free list, allocating more if necessary */
1453 * See comment in more_xiv() -- RAM.
1455 PL_xiv_root = *(IV**)xiv;
1457 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
1460 /* return an IV body to the free list */
1463 S_del_xiv(pTHX_ XPVIV *p)
1465 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
1467 *(IV**)xiv = PL_xiv_root;
1472 /* grab a new NV body from the free list, allocating more if necessary */
1482 PL_xnv_root = *(NV**)xnv;
1484 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1487 /* return an NV body to the free list */
1490 S_del_xnv(pTHX_ XPVNV *p)
1492 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1494 *(NV**)xnv = PL_xnv_root;
1499 /* grab a new struct xpv from the free list, allocating more if necessary */
1509 PL_xpv_root = (XPV*)xpv->xpv_pv;
1514 /* return a struct xpv to the free list */
1517 S_del_xpv(pTHX_ XPV *p)
1520 p->xpv_pv = (char*)PL_xpv_root;
1525 /* grab a new struct xpviv from the free list, allocating more if necessary */
1534 xpviv = PL_xpviv_root;
1535 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1540 /* return a struct xpviv to the free list */
1543 S_del_xpviv(pTHX_ XPVIV *p)
1546 p->xpv_pv = (char*)PL_xpviv_root;
1551 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1560 xpvnv = PL_xpvnv_root;
1561 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1566 /* return a struct xpvnv to the free list */
1569 S_del_xpvnv(pTHX_ XPVNV *p)
1572 p->xpv_pv = (char*)PL_xpvnv_root;
1577 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1586 xpvcv = PL_xpvcv_root;
1587 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1592 /* return a struct xpvcv to the free list */
1595 S_del_xpvcv(pTHX_ XPVCV *p)
1598 p->xpv_pv = (char*)PL_xpvcv_root;
1603 /* grab a new struct xpvav from the free list, allocating more if necessary */
1612 xpvav = PL_xpvav_root;
1613 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1618 /* return a struct xpvav to the free list */
1621 S_del_xpvav(pTHX_ XPVAV *p)
1624 p->xav_array = (char*)PL_xpvav_root;
1629 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1638 xpvhv = PL_xpvhv_root;
1639 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1644 /* return a struct xpvhv to the free list */
1647 S_del_xpvhv(pTHX_ XPVHV *p)
1650 p->xhv_array = (char*)PL_xpvhv_root;
1655 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1664 xpvmg = PL_xpvmg_root;
1665 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1670 /* return a struct xpvmg to the free list */
1673 S_del_xpvmg(pTHX_ XPVMG *p)
1676 p->xpv_pv = (char*)PL_xpvmg_root;
1681 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1690 xpvgv = PL_xpvgv_root;
1691 PL_xpvgv_root = (XPVGV*)xpvgv->xpv_pv;
1696 /* return a struct xpvgv to the free list */
1699 S_del_xpvgv(pTHX_ XPVGV *p)
1702 p->xpv_pv = (char*)PL_xpvgv_root;
1707 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1716 xpvlv = PL_xpvlv_root;
1717 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1722 /* return a struct xpvlv to the free list */
1725 S_del_xpvlv(pTHX_ XPVLV *p)
1728 p->xpv_pv = (char*)PL_xpvlv_root;
1733 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1742 xpvbm = PL_xpvbm_root;
1743 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1748 /* return a struct xpvbm to the free list */
1751 S_del_xpvbm(pTHX_ XPVBM *p)
1754 p->xpv_pv = (char*)PL_xpvbm_root;
1759 #define my_safemalloc(s) (void*)safemalloc(s)
1760 #define my_safefree(p) safefree((char*)p)
1764 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1765 #define del_XIV(p) my_safefree(p)
1767 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1768 #define del_XNV(p) my_safefree(p)
1770 #define new_XRV() my_safemalloc(sizeof(XRV))
1771 #define del_XRV(p) my_safefree(p)
1773 #define new_XPV() my_safemalloc(sizeof(XPV))
1774 #define del_XPV(p) my_safefree(p)
1776 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1777 #define del_XPVIV(p) my_safefree(p)
1779 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1780 #define del_XPVNV(p) my_safefree(p)
1782 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1783 #define del_XPVCV(p) my_safefree(p)
1785 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1786 #define del_XPVAV(p) my_safefree(p)
1788 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1789 #define del_XPVHV(p) my_safefree(p)
1791 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1792 #define del_XPVMG(p) my_safefree(p)
1794 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1795 #define del_XPVGV(p) my_safefree(p)
1797 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1798 #define del_XPVLV(p) my_safefree(p)
1800 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1801 #define del_XPVBM(p) my_safefree(p)
1805 #define new_XIV() (void*)new_xiv()
1806 #define del_XIV(p) del_xiv((XPVIV*) p)
1808 #define new_XNV() (void*)new_xnv()
1809 #define del_XNV(p) del_xnv((XPVNV*) p)
1811 #define new_XRV() (void*)new_xrv()
1812 #define del_XRV(p) del_xrv((XRV*) p)
1814 #define new_XPV() (void*)new_xpv()
1815 #define del_XPV(p) del_xpv((XPV *)p)
1817 #define new_XPVIV() (void*)new_xpviv()
1818 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1820 #define new_XPVNV() (void*)new_xpvnv()
1821 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1823 #define new_XPVCV() (void*)new_xpvcv()
1824 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1826 #define new_XPVAV() (void*)new_xpvav()
1827 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1829 #define new_XPVHV() (void*)new_xpvhv()
1830 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1832 #define new_XPVMG() (void*)new_xpvmg()
1833 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1835 #define new_XPVGV() (void*)new_xpvgv()
1836 #define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1838 #define new_XPVLV() (void*)new_xpvlv()
1839 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1841 #define new_XPVBM() (void*)new_xpvbm()
1842 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1846 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1847 #define del_XPVFM(p) my_safefree(p)
1849 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1850 #define del_XPVIO(p) my_safefree(p)
1853 =for apidoc sv_upgrade
1855 Upgrade an SV to a more complex form. Generally adds a new body type to the
1856 SV, then copies across as much information as possible from the old body.
1857 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1863 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1874 if (mt != SVt_PV && SvIsCOW(sv)) {
1875 sv_force_normal_flags(sv, 0);
1878 if (SvTYPE(sv) == mt)
1889 switch (SvTYPE(sv)) {
1897 else if (mt < SVt_PVIV)
1907 pv = (char*)SvRV(sv);
1917 else if (mt == SVt_NV)
1925 del_XPVIV(SvANY(sv));
1933 del_XPVNV(SvANY(sv));
1936 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1937 there's no way that it can be safely upgraded, because perl.c
1938 expects to Safefree(SvANY(PL_mess_sv)) */
1939 assert(sv != PL_mess_sv);
1945 magic = SvMAGIC(sv);
1946 stash = SvSTASH(sv);
1947 del_XPVMG(SvANY(sv));
1950 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1953 SvFLAGS(sv) &= ~SVTYPEMASK;
1958 Perl_croak(aTHX_ "Can't upgrade to undef");
1960 SvANY(sv) = new_XIV();
1964 SvANY(sv) = new_XNV();
1968 SvANY(sv) = new_XRV();
1969 SvRV_set(sv, (SV*)pv);
1972 SvANY(sv) = new_XPVHV();
1979 HvTOTALKEYS(sv) = 0;
1980 HvPLACEHOLDERS(sv) = 0;
1982 /* Fall through... */
1985 SvANY(sv) = new_XPVAV();
1990 AvFLAGS(sv) = AVf_REAL;
1995 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1997 /* FIXME. Should be able to remove all this if()... if the above
1998 assertion is genuinely always true. */
2001 SvFLAGS(sv) &= ~SVf_OOK;
2004 SvPV_set(sv, (char*)0);
2005 SvMAGIC_set(sv, magic);
2006 SvSTASH_set(sv, stash);
2010 SvANY(sv) = new_XPVIO();
2011 Zero(SvANY(sv), 1, XPVIO);
2012 IoPAGE_LEN(sv) = 60;
2013 goto set_magic_common;
2015 SvANY(sv) = new_XPVFM();
2016 Zero(SvANY(sv), 1, XPVFM);
2017 goto set_magic_common;
2019 SvANY(sv) = new_XPVBM();
2023 goto set_magic_common;
2025 SvANY(sv) = new_XPVGV();
2031 goto set_magic_common;
2033 SvANY(sv) = new_XPVCV();
2034 Zero(SvANY(sv), 1, XPVCV);
2035 goto set_magic_common;
2037 SvANY(sv) = new_XPVLV();
2050 SvANY(sv) = new_XPVMG();
2053 SvMAGIC_set(sv, magic);
2054 SvSTASH_set(sv, stash);
2058 SvANY(sv) = new_XPVNV();
2064 SvANY(sv) = new_XPVIV();
2073 SvANY(sv) = new_XPV();
2084 =for apidoc sv_backoff
2086 Remove any string offset. You should normally use the C<SvOOK_off> macro
2093 Perl_sv_backoff(pTHX_ register SV *sv)
2097 char *s = SvPVX(sv);
2098 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
2099 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
2101 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2103 SvFLAGS(sv) &= ~SVf_OOK;
2110 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2111 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2112 Use the C<SvGROW> wrapper instead.
2118 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2122 #ifdef HAS_64K_LIMIT
2123 if (newlen >= 0x10000) {
2124 PerlIO_printf(Perl_debug_log,
2125 "Allocation too large: %"UVxf"\n", (UV)newlen);
2128 #endif /* HAS_64K_LIMIT */
2131 if (SvTYPE(sv) < SVt_PV) {
2132 sv_upgrade(sv, SVt_PV);
2135 else if (SvOOK(sv)) { /* pv is offset? */
2138 if (newlen > SvLEN(sv))
2139 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2140 #ifdef HAS_64K_LIMIT
2141 if (newlen >= 0x10000)
2148 if (newlen > SvLEN(sv)) { /* need more room? */
2149 if (SvLEN(sv) && s) {
2151 STRLEN l = malloced_size((void*)SvPVX(sv));
2157 Renew(s,newlen,char);
2160 New(703, s, newlen, char);
2161 if (SvPVX(sv) && SvCUR(sv)) {
2162 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2166 SvLEN_set(sv, newlen);
2172 =for apidoc sv_setiv
2174 Copies an integer into the given SV, upgrading first if necessary.
2175 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2181 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2183 SV_CHECK_THINKFIRST_COW_DROP(sv);
2184 switch (SvTYPE(sv)) {
2186 sv_upgrade(sv, SVt_IV);
2189 sv_upgrade(sv, SVt_PVNV);
2193 sv_upgrade(sv, SVt_PVIV);
2202 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2205 (void)SvIOK_only(sv); /* validate number */
2211 =for apidoc sv_setiv_mg
2213 Like C<sv_setiv>, but also handles 'set' magic.
2219 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2226 =for apidoc sv_setuv
2228 Copies an unsigned integer into the given SV, upgrading first if necessary.
2229 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2235 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2237 /* With these two if statements:
2238 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2241 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2243 If you wish to remove them, please benchmark to see what the effect is
2245 if (u <= (UV)IV_MAX) {
2246 sv_setiv(sv, (IV)u);
2255 =for apidoc sv_setuv_mg
2257 Like C<sv_setuv>, but also handles 'set' magic.
2263 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2265 /* With these two if statements:
2266 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2269 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2271 If you wish to remove them, please benchmark to see what the effect is
2273 if (u <= (UV)IV_MAX) {
2274 sv_setiv(sv, (IV)u);
2284 =for apidoc sv_setnv
2286 Copies a double into the given SV, upgrading first if necessary.
2287 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2293 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2295 SV_CHECK_THINKFIRST_COW_DROP(sv);
2296 switch (SvTYPE(sv)) {
2299 sv_upgrade(sv, SVt_NV);
2304 sv_upgrade(sv, SVt_PVNV);
2313 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2317 (void)SvNOK_only(sv); /* validate number */
2322 =for apidoc sv_setnv_mg
2324 Like C<sv_setnv>, but also handles 'set' magic.
2330 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2336 /* Print an "isn't numeric" warning, using a cleaned-up,
2337 * printable version of the offending string
2341 S_not_a_number(pTHX_ SV *sv)
2348 dsv = sv_2mortal(newSVpv("", 0));
2349 pv = sv_uni_display(dsv, sv, 10, 0);
2352 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2353 /* each *s can expand to 4 chars + "...\0",
2354 i.e. need room for 8 chars */
2357 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2359 if (ch & 128 && !isPRINT_LC(ch)) {
2368 else if (ch == '\r') {
2372 else if (ch == '\f') {
2376 else if (ch == '\\') {
2380 else if (ch == '\0') {
2384 else if (isPRINT_LC(ch))
2401 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2402 "Argument \"%s\" isn't numeric in %s", pv,
2405 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2406 "Argument \"%s\" isn't numeric", pv);
2410 =for apidoc looks_like_number
2412 Test if the content of an SV looks like a number (or is a number).
2413 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2414 non-numeric warning), even if your atof() doesn't grok them.
2420 Perl_looks_like_number(pTHX_ SV *sv)
2422 register char *sbegin;
2429 else if (SvPOKp(sv))
2430 sbegin = SvPV(sv, len);
2432 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2433 return grok_number(sbegin, len, NULL);
2436 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2437 until proven guilty, assume that things are not that bad... */
2442 As 64 bit platforms often have an NV that doesn't preserve all bits of
2443 an IV (an assumption perl has been based on to date) it becomes necessary
2444 to remove the assumption that the NV always carries enough precision to
2445 recreate the IV whenever needed, and that the NV is the canonical form.
2446 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2447 precision as a side effect of conversion (which would lead to insanity
2448 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2449 1) to distinguish between IV/UV/NV slots that have cached a valid
2450 conversion where precision was lost and IV/UV/NV slots that have a
2451 valid conversion which has lost no precision
2452 2) to ensure that if a numeric conversion to one form is requested that
2453 would lose precision, the precise conversion (or differently
2454 imprecise conversion) is also performed and cached, to prevent
2455 requests for different numeric formats on the same SV causing
2456 lossy conversion chains. (lossless conversion chains are perfectly
2461 SvIOKp is true if the IV slot contains a valid value
2462 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2463 SvNOKp is true if the NV slot contains a valid value
2464 SvNOK is true only if the NV value is accurate
2467 while converting from PV to NV, check to see if converting that NV to an
2468 IV(or UV) would lose accuracy over a direct conversion from PV to
2469 IV(or UV). If it would, cache both conversions, return NV, but mark
2470 SV as IOK NOKp (ie not NOK).
2472 While converting from PV to IV, check to see if converting that IV to an
2473 NV would lose accuracy over a direct conversion from PV to NV. If it
2474 would, cache both conversions, flag similarly.
2476 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2477 correctly because if IV & NV were set NV *always* overruled.
2478 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2479 changes - now IV and NV together means that the two are interchangeable:
2480 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2482 The benefit of this is that operations such as pp_add know that if
2483 SvIOK is true for both left and right operands, then integer addition
2484 can be used instead of floating point (for cases where the result won't
2485 overflow). Before, floating point was always used, which could lead to
2486 loss of precision compared with integer addition.
2488 * making IV and NV equal status should make maths accurate on 64 bit
2490 * may speed up maths somewhat if pp_add and friends start to use
2491 integers when possible instead of fp. (Hopefully the overhead in
2492 looking for SvIOK and checking for overflow will not outweigh the
2493 fp to integer speedup)
2494 * will slow down integer operations (callers of SvIV) on "inaccurate"
2495 values, as the change from SvIOK to SvIOKp will cause a call into
2496 sv_2iv each time rather than a macro access direct to the IV slot
2497 * should speed up number->string conversion on integers as IV is
2498 favoured when IV and NV are equally accurate
2500 ####################################################################
2501 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2502 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2503 On the other hand, SvUOK is true iff UV.
2504 ####################################################################
2506 Your mileage will vary depending your CPU's relative fp to integer
2510 #ifndef NV_PRESERVES_UV
2511 # define IS_NUMBER_UNDERFLOW_IV 1
2512 # define IS_NUMBER_UNDERFLOW_UV 2
2513 # define IS_NUMBER_IV_AND_UV 2
2514 # define IS_NUMBER_OVERFLOW_IV 4
2515 # define IS_NUMBER_OVERFLOW_UV 5
2517 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2519 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2521 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2523 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2524 if (SvNVX(sv) < (NV)IV_MIN) {
2525 (void)SvIOKp_on(sv);
2527 SvIV_set(sv, IV_MIN);
2528 return IS_NUMBER_UNDERFLOW_IV;
2530 if (SvNVX(sv) > (NV)UV_MAX) {
2531 (void)SvIOKp_on(sv);
2534 SvUV_set(sv, UV_MAX);
2535 return IS_NUMBER_OVERFLOW_UV;
2537 (void)SvIOKp_on(sv);
2539 /* Can't use strtol etc to convert this string. (See truth table in
2541 if (SvNVX(sv) <= (UV)IV_MAX) {
2542 SvIV_set(sv, I_V(SvNVX(sv)));
2543 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2544 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2546 /* Integer is imprecise. NOK, IOKp */
2548 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2551 SvUV_set(sv, U_V(SvNVX(sv)));
2552 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2553 if (SvUVX(sv) == UV_MAX) {
2554 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2555 possibly be preserved by NV. Hence, it must be overflow.
2557 return IS_NUMBER_OVERFLOW_UV;
2559 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2561 /* Integer is imprecise. NOK, IOKp */
2563 return IS_NUMBER_OVERFLOW_IV;
2565 #endif /* !NV_PRESERVES_UV*/
2567 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2568 * this function provided for binary compatibility only
2572 Perl_sv_2iv(pTHX_ register SV *sv)
2574 return sv_2iv_flags(sv, SV_GMAGIC);
2578 =for apidoc sv_2iv_flags
2580 Return the integer value of an SV, doing any necessary string
2581 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2582 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2588 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2592 if (SvGMAGICAL(sv)) {
2593 if (flags & SV_GMAGIC)
2598 return I_V(SvNVX(sv));
2600 if (SvPOKp(sv) && SvLEN(sv))
2603 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2604 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2610 if (SvTHINKFIRST(sv)) {
2613 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2614 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2615 return SvIV(tmpstr);
2616 return PTR2IV(SvRV(sv));
2619 sv_force_normal_flags(sv, 0);
2621 if (SvREADONLY(sv) && !SvOK(sv)) {
2622 if (ckWARN(WARN_UNINITIALIZED))
2629 return (IV)(SvUVX(sv));
2636 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2637 * without also getting a cached IV/UV from it at the same time
2638 * (ie PV->NV conversion should detect loss of accuracy and cache
2639 * IV or UV at same time to avoid this. NWC */
2641 if (SvTYPE(sv) == SVt_NV)
2642 sv_upgrade(sv, SVt_PVNV);
2644 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2645 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2646 certainly cast into the IV range at IV_MAX, whereas the correct
2647 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2649 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2650 SvIV_set(sv, I_V(SvNVX(sv)));
2651 if (SvNVX(sv) == (NV) SvIVX(sv)
2652 #ifndef NV_PRESERVES_UV
2653 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2654 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2655 /* Don't flag it as "accurately an integer" if the number
2656 came from a (by definition imprecise) NV operation, and
2657 we're outside the range of NV integer precision */
2660 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2661 DEBUG_c(PerlIO_printf(Perl_debug_log,
2662 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2668 /* IV not precise. No need to convert from PV, as NV
2669 conversion would already have cached IV if it detected
2670 that PV->IV would be better than PV->NV->IV
2671 flags already correct - don't set public IOK. */
2672 DEBUG_c(PerlIO_printf(Perl_debug_log,
2673 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2678 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2679 but the cast (NV)IV_MIN rounds to a the value less (more
2680 negative) than IV_MIN which happens to be equal to SvNVX ??
2681 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2682 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2683 (NV)UVX == NVX are both true, but the values differ. :-(
2684 Hopefully for 2s complement IV_MIN is something like
2685 0x8000000000000000 which will be exact. NWC */
2688 SvUV_set(sv, U_V(SvNVX(sv)));
2690 (SvNVX(sv) == (NV) SvUVX(sv))
2691 #ifndef NV_PRESERVES_UV
2692 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2693 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2694 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2695 /* Don't flag it as "accurately an integer" if the number
2696 came from a (by definition imprecise) NV operation, and
2697 we're outside the range of NV integer precision */
2703 DEBUG_c(PerlIO_printf(Perl_debug_log,
2704 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2708 return (IV)SvUVX(sv);
2711 else if (SvPOKp(sv) && SvLEN(sv)) {
2713 const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2714 /* We want to avoid a possible problem when we cache an IV which
2715 may be later translated to an NV, and the resulting NV is not
2716 the same as the direct translation of the initial string
2717 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2718 be careful to ensure that the value with the .456 is around if the
2719 NV value is requested in the future).
2721 This means that if we cache such an IV, we need to cache the
2722 NV as well. Moreover, we trade speed for space, and do not
2723 cache the NV if we are sure it's not needed.
2726 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2727 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2728 == IS_NUMBER_IN_UV) {
2729 /* It's definitely an integer, only upgrade to PVIV */
2730 if (SvTYPE(sv) < SVt_PVIV)
2731 sv_upgrade(sv, SVt_PVIV);
2733 } else if (SvTYPE(sv) < SVt_PVNV)
2734 sv_upgrade(sv, SVt_PVNV);
2736 /* If NV preserves UV then we only use the UV value if we know that
2737 we aren't going to call atof() below. If NVs don't preserve UVs
2738 then the value returned may have more precision than atof() will
2739 return, even though value isn't perfectly accurate. */
2740 if ((numtype & (IS_NUMBER_IN_UV
2741 #ifdef NV_PRESERVES_UV
2744 )) == IS_NUMBER_IN_UV) {
2745 /* This won't turn off the public IOK flag if it was set above */
2746 (void)SvIOKp_on(sv);
2748 if (!(numtype & IS_NUMBER_NEG)) {
2750 if (value <= (UV)IV_MAX) {
2751 SvIV_set(sv, (IV)value);
2753 SvUV_set(sv, value);
2757 /* 2s complement assumption */
2758 if (value <= (UV)IV_MIN) {
2759 SvIV_set(sv, -(IV)value);
2761 /* Too negative for an IV. This is a double upgrade, but
2762 I'm assuming it will be rare. */
2763 if (SvTYPE(sv) < SVt_PVNV)
2764 sv_upgrade(sv, SVt_PVNV);
2768 SvNV_set(sv, -(NV)value);
2769 SvIV_set(sv, IV_MIN);
2773 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2774 will be in the previous block to set the IV slot, and the next
2775 block to set the NV slot. So no else here. */
2777 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2778 != IS_NUMBER_IN_UV) {
2779 /* It wasn't an (integer that doesn't overflow the UV). */
2780 SvNV_set(sv, Atof(SvPVX(sv)));
2782 if (! numtype && ckWARN(WARN_NUMERIC))
2785 #if defined(USE_LONG_DOUBLE)
2786 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2787 PTR2UV(sv), SvNVX(sv)));
2789 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2790 PTR2UV(sv), SvNVX(sv)));
2794 #ifdef NV_PRESERVES_UV
2795 (void)SvIOKp_on(sv);
2797 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2798 SvIV_set(sv, I_V(SvNVX(sv)));
2799 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2802 /* Integer is imprecise. NOK, IOKp */
2804 /* UV will not work better than IV */
2806 if (SvNVX(sv) > (NV)UV_MAX) {
2808 /* Integer is inaccurate. NOK, IOKp, is UV */
2809 SvUV_set(sv, UV_MAX);
2812 SvUV_set(sv, U_V(SvNVX(sv)));
2813 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2814 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2818 /* Integer is imprecise. NOK, IOKp, is UV */
2824 #else /* NV_PRESERVES_UV */
2825 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2826 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2827 /* The IV slot will have been set from value returned by
2828 grok_number above. The NV slot has just been set using
2831 assert (SvIOKp(sv));
2833 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2834 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2835 /* Small enough to preserve all bits. */
2836 (void)SvIOKp_on(sv);
2838 SvIV_set(sv, I_V(SvNVX(sv)));
2839 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2841 /* Assumption: first non-preserved integer is < IV_MAX,
2842 this NV is in the preserved range, therefore: */
2843 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2845 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);
2849 0 0 already failed to read UV.
2850 0 1 already failed to read UV.
2851 1 0 you won't get here in this case. IV/UV
2852 slot set, public IOK, Atof() unneeded.
2853 1 1 already read UV.
2854 so there's no point in sv_2iuv_non_preserve() attempting
2855 to use atol, strtol, strtoul etc. */
2856 if (sv_2iuv_non_preserve (sv, numtype)
2857 >= IS_NUMBER_OVERFLOW_IV)
2861 #endif /* NV_PRESERVES_UV */
2864 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2866 if (SvTYPE(sv) < SVt_IV)
2867 /* Typically the caller expects that sv_any is not NULL now. */
2868 sv_upgrade(sv, SVt_IV);
2871 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2872 PTR2UV(sv),SvIVX(sv)));
2873 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2876 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2877 * this function provided for binary compatibility only
2881 Perl_sv_2uv(pTHX_ register SV *sv)
2883 return sv_2uv_flags(sv, SV_GMAGIC);
2887 =for apidoc sv_2uv_flags
2889 Return the unsigned integer value of an SV, doing any necessary string
2890 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2891 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2897 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2901 if (SvGMAGICAL(sv)) {
2902 if (flags & SV_GMAGIC)
2907 return U_V(SvNVX(sv));
2908 if (SvPOKp(sv) && SvLEN(sv))
2911 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2912 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2918 if (SvTHINKFIRST(sv)) {
2921 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2922 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2923 return SvUV(tmpstr);
2924 return PTR2UV(SvRV(sv));
2927 sv_force_normal_flags(sv, 0);
2929 if (SvREADONLY(sv) && !SvOK(sv)) {
2930 if (ckWARN(WARN_UNINITIALIZED))
2940 return (UV)SvIVX(sv);
2944 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2945 * without also getting a cached IV/UV from it at the same time
2946 * (ie PV->NV conversion should detect loss of accuracy and cache
2947 * IV or UV at same time to avoid this. */
2948 /* IV-over-UV optimisation - choose to cache IV if possible */
2950 if (SvTYPE(sv) == SVt_NV)
2951 sv_upgrade(sv, SVt_PVNV);
2953 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2954 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2955 SvIV_set(sv, I_V(SvNVX(sv)));
2956 if (SvNVX(sv) == (NV) SvIVX(sv)
2957 #ifndef NV_PRESERVES_UV
2958 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2959 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2960 /* Don't flag it as "accurately an integer" if the number
2961 came from a (by definition imprecise) NV operation, and
2962 we're outside the range of NV integer precision */
2965 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2966 DEBUG_c(PerlIO_printf(Perl_debug_log,
2967 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2973 /* IV not precise. No need to convert from PV, as NV
2974 conversion would already have cached IV if it detected
2975 that PV->IV would be better than PV->NV->IV
2976 flags already correct - don't set public IOK. */
2977 DEBUG_c(PerlIO_printf(Perl_debug_log,
2978 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2983 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2984 but the cast (NV)IV_MIN rounds to a the value less (more
2985 negative) than IV_MIN which happens to be equal to SvNVX ??
2986 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2987 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2988 (NV)UVX == NVX are both true, but the values differ. :-(
2989 Hopefully for 2s complement IV_MIN is something like
2990 0x8000000000000000 which will be exact. NWC */
2993 SvUV_set(sv, U_V(SvNVX(sv)));
2995 (SvNVX(sv) == (NV) SvUVX(sv))
2996 #ifndef NV_PRESERVES_UV
2997 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2998 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2999 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
3000 /* Don't flag it as "accurately an integer" if the number
3001 came from a (by definition imprecise) NV operation, and
3002 we're outside the range of NV integer precision */
3007 DEBUG_c(PerlIO_printf(Perl_debug_log,
3008 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
3014 else if (SvPOKp(sv) && SvLEN(sv)) {
3016 const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3018 /* We want to avoid a possible problem when we cache a UV which
3019 may be later translated to an NV, and the resulting NV is not
3020 the translation of the initial data.
3022 This means that if we cache such a UV, we need to cache the
3023 NV as well. Moreover, we trade speed for space, and do not
3024 cache the NV if not needed.
3027 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
3028 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3029 == IS_NUMBER_IN_UV) {
3030 /* It's definitely an integer, only upgrade to PVIV */
3031 if (SvTYPE(sv) < SVt_PVIV)
3032 sv_upgrade(sv, SVt_PVIV);
3034 } else if (SvTYPE(sv) < SVt_PVNV)
3035 sv_upgrade(sv, SVt_PVNV);
3037 /* If NV preserves UV then we only use the UV value if we know that
3038 we aren't going to call atof() below. If NVs don't preserve UVs
3039 then the value returned may have more precision than atof() will
3040 return, even though it isn't accurate. */
3041 if ((numtype & (IS_NUMBER_IN_UV
3042 #ifdef NV_PRESERVES_UV
3045 )) == IS_NUMBER_IN_UV) {
3046 /* This won't turn off the public IOK flag if it was set above */
3047 (void)SvIOKp_on(sv);
3049 if (!(numtype & IS_NUMBER_NEG)) {
3051 if (value <= (UV)IV_MAX) {
3052 SvIV_set(sv, (IV)value);
3054 /* it didn't overflow, and it was positive. */
3055 SvUV_set(sv, value);
3059 /* 2s complement assumption */
3060 if (value <= (UV)IV_MIN) {
3061 SvIV_set(sv, -(IV)value);
3063 /* Too negative for an IV. This is a double upgrade, but
3064 I'm assuming it will be rare. */
3065 if (SvTYPE(sv) < SVt_PVNV)
3066 sv_upgrade(sv, SVt_PVNV);
3070 SvNV_set(sv, -(NV)value);
3071 SvIV_set(sv, IV_MIN);
3076 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3077 != IS_NUMBER_IN_UV) {
3078 /* It wasn't an integer, or it overflowed the UV. */
3079 SvNV_set(sv, Atof(SvPVX(sv)));
3081 if (! numtype && ckWARN(WARN_NUMERIC))
3084 #if defined(USE_LONG_DOUBLE)
3085 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3086 PTR2UV(sv), SvNVX(sv)));
3088 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3089 PTR2UV(sv), SvNVX(sv)));
3092 #ifdef NV_PRESERVES_UV
3093 (void)SvIOKp_on(sv);
3095 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3096 SvIV_set(sv, I_V(SvNVX(sv)));
3097 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3100 /* Integer is imprecise. NOK, IOKp */
3102 /* UV will not work better than IV */
3104 if (SvNVX(sv) > (NV)UV_MAX) {
3106 /* Integer is inaccurate. NOK, IOKp, is UV */
3107 SvUV_set(sv, UV_MAX);
3110 SvUV_set(sv, U_V(SvNVX(sv)));
3111 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3112 NV preservse UV so can do correct comparison. */
3113 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3117 /* Integer is imprecise. NOK, IOKp, is UV */
3122 #else /* NV_PRESERVES_UV */
3123 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3124 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3125 /* The UV slot will have been set from value returned by
3126 grok_number above. The NV slot has just been set using
3129 assert (SvIOKp(sv));
3131 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3132 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3133 /* Small enough to preserve all bits. */
3134 (void)SvIOKp_on(sv);
3136 SvIV_set(sv, I_V(SvNVX(sv)));
3137 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3139 /* Assumption: first non-preserved integer is < IV_MAX,
3140 this NV is in the preserved range, therefore: */
3141 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3143 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);
3146 sv_2iuv_non_preserve (sv, numtype);
3148 #endif /* NV_PRESERVES_UV */
3152 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3153 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3156 if (SvTYPE(sv) < SVt_IV)
3157 /* Typically the caller expects that sv_any is not NULL now. */
3158 sv_upgrade(sv, SVt_IV);
3162 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3163 PTR2UV(sv),SvUVX(sv)));
3164 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3170 Return the num value of an SV, doing any necessary string or integer
3171 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3178 Perl_sv_2nv(pTHX_ register SV *sv)
3182 if (SvGMAGICAL(sv)) {
3186 if (SvPOKp(sv) && SvLEN(sv)) {
3187 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3188 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3190 return Atof(SvPVX(sv));
3194 return (NV)SvUVX(sv);
3196 return (NV)SvIVX(sv);
3199 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3200 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3206 if (SvTHINKFIRST(sv)) {
3209 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3210 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3211 return SvNV(tmpstr);
3212 return PTR2NV(SvRV(sv));
3215 sv_force_normal_flags(sv, 0);
3217 if (SvREADONLY(sv) && !SvOK(sv)) {
3218 if (ckWARN(WARN_UNINITIALIZED))
3223 if (SvTYPE(sv) < SVt_NV) {
3224 if (SvTYPE(sv) == SVt_IV)
3225 sv_upgrade(sv, SVt_PVNV);
3227 sv_upgrade(sv, SVt_NV);
3228 #ifdef USE_LONG_DOUBLE
3230 STORE_NUMERIC_LOCAL_SET_STANDARD();
3231 PerlIO_printf(Perl_debug_log,
3232 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3233 PTR2UV(sv), SvNVX(sv));
3234 RESTORE_NUMERIC_LOCAL();
3238 STORE_NUMERIC_LOCAL_SET_STANDARD();
3239 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3240 PTR2UV(sv), SvNVX(sv));
3241 RESTORE_NUMERIC_LOCAL();
3245 else if (SvTYPE(sv) < SVt_PVNV)
3246 sv_upgrade(sv, SVt_PVNV);
3251 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3252 #ifdef NV_PRESERVES_UV
3255 /* Only set the public NV OK flag if this NV preserves the IV */
3256 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3257 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3258 : (SvIVX(sv) == I_V(SvNVX(sv))))
3264 else if (SvPOKp(sv) && SvLEN(sv)) {
3266 const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3267 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3269 #ifdef NV_PRESERVES_UV
3270 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3271 == IS_NUMBER_IN_UV) {
3272 /* It's definitely an integer */
3273 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3275 SvNV_set(sv, Atof(SvPVX(sv)));
3278 SvNV_set(sv, Atof(SvPVX(sv)));
3279 /* Only set the public NV OK flag if this NV preserves the value in
3280 the PV at least as well as an IV/UV would.
3281 Not sure how to do this 100% reliably. */
3282 /* if that shift count is out of range then Configure's test is
3283 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3285 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3286 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3287 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3288 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3289 /* Can't use strtol etc to convert this string, so don't try.
3290 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3293 /* value has been set. It may not be precise. */
3294 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3295 /* 2s complement assumption for (UV)IV_MIN */
3296 SvNOK_on(sv); /* Integer is too negative. */
3301 if (numtype & IS_NUMBER_NEG) {
3302 SvIV_set(sv, -(IV)value);
3303 } else if (value <= (UV)IV_MAX) {
3304 SvIV_set(sv, (IV)value);
3306 SvUV_set(sv, value);
3310 if (numtype & IS_NUMBER_NOT_INT) {
3311 /* I believe that even if the original PV had decimals,
3312 they are lost beyond the limit of the FP precision.
3313 However, neither is canonical, so both only get p
3314 flags. NWC, 2000/11/25 */
3315 /* Both already have p flags, so do nothing */
3318 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3319 if (SvIVX(sv) == I_V(nv)) {
3324 /* It had no "." so it must be integer. */
3327 /* between IV_MAX and NV(UV_MAX).
3328 Could be slightly > UV_MAX */
3330 if (numtype & IS_NUMBER_NOT_INT) {
3331 /* UV and NV both imprecise. */
3333 UV nv_as_uv = U_V(nv);
3335 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3346 #endif /* NV_PRESERVES_UV */
3349 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3351 if (SvTYPE(sv) < SVt_NV)
3352 /* Typically the caller expects that sv_any is not NULL now. */
3353 /* XXX Ilya implies that this is a bug in callers that assume this
3354 and ideally should be fixed. */
3355 sv_upgrade(sv, SVt_NV);
3358 #if defined(USE_LONG_DOUBLE)
3360 STORE_NUMERIC_LOCAL_SET_STANDARD();
3361 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3362 PTR2UV(sv), SvNVX(sv));
3363 RESTORE_NUMERIC_LOCAL();
3367 STORE_NUMERIC_LOCAL_SET_STANDARD();
3368 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3369 PTR2UV(sv), SvNVX(sv));
3370 RESTORE_NUMERIC_LOCAL();
3376 /* asIV(): extract an integer from the string value of an SV.
3377 * Caller must validate PVX */
3380 S_asIV(pTHX_ SV *sv)
3383 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3385 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3386 == IS_NUMBER_IN_UV) {
3387 /* It's definitely an integer */
3388 if (numtype & IS_NUMBER_NEG) {
3389 if (value < (UV)IV_MIN)
3392 if (value < (UV)IV_MAX)
3397 if (ckWARN(WARN_NUMERIC))
3400 return I_V(Atof(SvPVX(sv)));
3403 /* asUV(): extract an unsigned integer from the string value of an SV
3404 * Caller must validate PVX */
3407 S_asUV(pTHX_ SV *sv)
3410 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3412 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3413 == IS_NUMBER_IN_UV) {
3414 /* It's definitely an integer */
3415 if (!(numtype & IS_NUMBER_NEG))
3419 if (ckWARN(WARN_NUMERIC))
3422 return U_V(Atof(SvPVX(sv)));
3426 =for apidoc sv_2pv_nolen
3428 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3429 use the macro wrapper C<SvPV_nolen(sv)> instead.
3434 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3437 return sv_2pv(sv, &n_a);
3440 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3441 * UV as a string towards the end of buf, and return pointers to start and
3444 * We assume that buf is at least TYPE_CHARS(UV) long.
3448 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3450 char *ptr = buf + TYPE_CHARS(UV);
3464 *--ptr = '0' + (char)(uv % 10);
3472 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3473 * this function provided for binary compatibility only
3477 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3479 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3483 =for apidoc sv_2pv_flags
3485 Returns a pointer to the string value of an SV, and sets *lp to its length.
3486 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3488 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3489 usually end up here too.
3495 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3500 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3501 char *tmpbuf = tbuf;
3507 if (SvGMAGICAL(sv)) {
3508 if (flags & SV_GMAGIC)
3516 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3518 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3523 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3528 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3529 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3536 if (SvTHINKFIRST(sv)) {
3539 register const char *typestr;
3540 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3541 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3542 char *pv = SvPV(tmpstr, *lp);
3552 typestr = "NULLREF";
3556 switch (SvTYPE(sv)) {
3558 if ( ((SvFLAGS(sv) &
3559 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3560 == (SVs_OBJECT|SVs_SMG))
3561 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3562 const regexp *re = (regexp *)mg->mg_obj;
3565 const char *fptr = "msix";
3570 char need_newline = 0;
3571 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3573 while((ch = *fptr++)) {
3575 reflags[left++] = ch;
3578 reflags[right--] = ch;
3583 reflags[left] = '-';
3587 mg->mg_len = re->prelen + 4 + left;
3589 * If /x was used, we have to worry about a regex
3590 * ending with a comment later being embedded
3591 * within another regex. If so, we don't want this
3592 * regex's "commentization" to leak out to the
3593 * right part of the enclosing regex, we must cap
3594 * it with a newline.
3596 * So, if /x was used, we scan backwards from the
3597 * end of the regex. If we find a '#' before we
3598 * find a newline, we need to add a newline
3599 * ourself. If we find a '\n' first (or if we
3600 * don't find '#' or '\n'), we don't need to add
3601 * anything. -jfriedl
3603 if (PMf_EXTENDED & re->reganch)
3605 const char *endptr = re->precomp + re->prelen;
3606 while (endptr >= re->precomp)
3608 const char c = *(endptr--);
3610 break; /* don't need another */
3612 /* we end while in a comment, so we
3614 mg->mg_len++; /* save space for it */
3615 need_newline = 1; /* note to add it */
3621 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3622 Copy("(?", mg->mg_ptr, 2, char);
3623 Copy(reflags, mg->mg_ptr+2, left, char);
3624 Copy(":", mg->mg_ptr+left+2, 1, char);
3625 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3627 mg->mg_ptr[mg->mg_len - 2] = '\n';
3628 mg->mg_ptr[mg->mg_len - 1] = ')';
3629 mg->mg_ptr[mg->mg_len] = 0;
3631 PL_reginterp_cnt += re->program[0].next_off;
3633 if (re->reganch & ROPT_UTF8)
3648 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3649 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3650 /* tied lvalues should appear to be
3651 * scalars for backwards compatitbility */
3652 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3653 ? "SCALAR" : "LVALUE"; break;
3654 case SVt_PVAV: typestr = "ARRAY"; break;
3655 case SVt_PVHV: typestr = "HASH"; break;
3656 case SVt_PVCV: typestr = "CODE"; break;
3657 case SVt_PVGV: typestr = "GLOB"; break;
3658 case SVt_PVFM: typestr = "FORMAT"; break;
3659 case SVt_PVIO: typestr = "IO"; break;
3660 default: typestr = "UNKNOWN"; break;
3664 const char *name = HvNAME(SvSTASH(sv));
3665 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3666 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3669 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3672 *lp = strlen(typestr);
3673 return (char *)typestr;
3675 if (SvREADONLY(sv) && !SvOK(sv)) {
3676 if (ckWARN(WARN_UNINITIALIZED))
3682 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3683 /* I'm assuming that if both IV and NV are equally valid then
3684 converting the IV is going to be more efficient */
3685 const U32 isIOK = SvIOK(sv);
3686 const U32 isUIOK = SvIsUV(sv);
3687 char buf[TYPE_CHARS(UV)];
3690 if (SvTYPE(sv) < SVt_PVIV)
3691 sv_upgrade(sv, SVt_PVIV);
3693 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3695 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3696 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3697 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3698 SvCUR_set(sv, ebuf - ptr);
3708 else if (SvNOKp(sv)) {
3709 if (SvTYPE(sv) < SVt_PVNV)
3710 sv_upgrade(sv, SVt_PVNV);
3711 /* The +20 is pure guesswork. Configure test needed. --jhi */
3712 SvGROW(sv, NV_DIG + 20);
3714 olderrno = errno; /* some Xenix systems wipe out errno here */
3716 if (SvNVX(sv) == 0.0)
3717 (void)strcpy(s,"0");
3721 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3724 #ifdef FIXNEGATIVEZERO
3725 if (*s == '-' && s[1] == '0' && !s[2])
3735 if (ckWARN(WARN_UNINITIALIZED)
3736 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3739 if (SvTYPE(sv) < SVt_PV)
3740 /* Typically the caller expects that sv_any is not NULL now. */
3741 sv_upgrade(sv, SVt_PV);
3744 *lp = s - SvPVX(sv);
3747 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3748 PTR2UV(sv),SvPVX(sv)));
3752 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3753 /* Sneaky stuff here */
3757 tsv = newSVpv(tmpbuf, 0);
3774 len = strlen(tmpbuf);
3776 #ifdef FIXNEGATIVEZERO
3777 if (len == 2 && t[0] == '-' && t[1] == '0') {
3782 (void)SvUPGRADE(sv, SVt_PV);
3784 s = SvGROW(sv, len + 1);
3787 return strcpy(s, t);
3792 =for apidoc sv_copypv
3794 Copies a stringified representation of the source SV into the
3795 destination SV. Automatically performs any necessary mg_get and
3796 coercion of numeric values into strings. Guaranteed to preserve
3797 UTF-8 flag even from overloaded objects. Similar in nature to
3798 sv_2pv[_flags] but operates directly on an SV instead of just the
3799 string. Mostly uses sv_2pv_flags to do its work, except when that
3800 would lose the UTF-8'ness of the PV.
3806 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3811 sv_setpvn(dsv,s,len);
3819 =for apidoc sv_2pvbyte_nolen
3821 Return a pointer to the byte-encoded representation of the SV.
3822 May cause the SV to be downgraded from UTF-8 as a side-effect.
3824 Usually accessed via the C<SvPVbyte_nolen> macro.
3830 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3833 return sv_2pvbyte(sv, &n_a);
3837 =for apidoc sv_2pvbyte
3839 Return a pointer to the byte-encoded representation of the SV, and set *lp
3840 to its length. May cause the SV to be downgraded from UTF-8 as a
3843 Usually accessed via the C<SvPVbyte> macro.
3849 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3851 sv_utf8_downgrade(sv,0);
3852 return SvPV(sv,*lp);
3856 =for apidoc sv_2pvutf8_nolen
3858 Return a pointer to the UTF-8-encoded representation of the SV.
3859 May cause the SV to be upgraded to UTF-8 as a side-effect.
3861 Usually accessed via the C<SvPVutf8_nolen> macro.
3867 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3870 return sv_2pvutf8(sv, &n_a);
3874 =for apidoc sv_2pvutf8
3876 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3877 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3879 Usually accessed via the C<SvPVutf8> macro.
3885 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3887 sv_utf8_upgrade(sv);
3888 return SvPV(sv,*lp);
3892 =for apidoc sv_2bool
3894 This function is only called on magical items, and is only used by
3895 sv_true() or its macro equivalent.
3901 Perl_sv_2bool(pTHX_ register SV *sv)
3910 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3911 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3912 return (bool)SvTRUE(tmpsv);
3913 return SvRV(sv) != 0;
3916 register XPV* Xpvtmp;
3917 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3918 (*Xpvtmp->xpv_pv > '0' ||
3919 Xpvtmp->xpv_cur > 1 ||
3920 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3927 return SvIVX(sv) != 0;
3930 return SvNVX(sv) != 0.0;
3937 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3938 * this function provided for binary compatibility only
3943 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3945 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3949 =for apidoc sv_utf8_upgrade
3951 Converts the PV of an SV to its UTF-8-encoded form.
3952 Forces the SV to string form if it is not already.
3953 Always sets the SvUTF8 flag to avoid future validity checks even
3954 if all the bytes have hibit clear.
3956 This is not as a general purpose byte encoding to Unicode interface:
3957 use the Encode extension for that.
3959 =for apidoc sv_utf8_upgrade_flags
3961 Converts the PV of an SV to its UTF-8-encoded form.
3962 Forces the SV to string form if it is not already.
3963 Always sets the SvUTF8 flag to avoid future validity checks even
3964 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3965 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3966 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3968 This is not as a general purpose byte encoding to Unicode interface:
3969 use the Encode extension for that.
3975 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3977 if (sv == &PL_sv_undef)
3981 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3982 (void) sv_2pv_flags(sv,&len, flags);
3986 (void) SvPV_force(sv,len);
3995 sv_force_normal_flags(sv, 0);
3998 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3999 sv_recode_to_utf8(sv, PL_encoding);
4000 else { /* Assume Latin-1/EBCDIC */
4001 /* This function could be much more efficient if we
4002 * had a FLAG in SVs to signal if there are any hibit
4003 * chars in the PV. Given that there isn't such a flag
4004 * make the loop as fast as possible. */
4005 U8 *s = (U8 *) SvPVX(sv);
4006 U8 *e = (U8 *) SvEND(sv);
4012 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
4016 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
4017 s = bytes_to_utf8((U8*)s, &len);
4019 SvPV_free(sv); /* No longer using what was there before. */
4021 SvPV_set(sv, (char*)s);
4022 SvCUR_set(sv, len - 1);
4023 SvLEN_set(sv, len); /* No longer know the real size. */
4025 /* Mark as UTF-8 even if no hibit - saves scanning loop */
4032 =for apidoc sv_utf8_downgrade
4034 Attempts to convert the PV of an SV from characters to bytes.
4035 If the PV contains a character beyond byte, this conversion will fail;
4036 in this case, either returns false or, if C<fail_ok> is not
4039 This is not as a general purpose Unicode to byte encoding interface:
4040 use the Encode extension for that.
4046 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4048 if (SvPOKp(sv) && SvUTF8(sv)) {
4054 sv_force_normal_flags(sv, 0);
4056 s = (U8 *) SvPV(sv, len);
4057 if (!utf8_to_bytes(s, &len)) {
4062 Perl_croak(aTHX_ "Wide character in %s",
4065 Perl_croak(aTHX_ "Wide character");
4076 =for apidoc sv_utf8_encode
4078 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4079 flag off so that it looks like octets again.
4085 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4087 (void) sv_utf8_upgrade(sv);
4089 sv_force_normal_flags(sv, 0);
4091 if (SvREADONLY(sv)) {
4092 Perl_croak(aTHX_ PL_no_modify);
4098 =for apidoc sv_utf8_decode
4100 If the PV of the SV is an octet sequence in UTF-8
4101 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4102 so that it looks like a character. If the PV contains only single-byte
4103 characters, the C<SvUTF8> flag stays being off.
4104 Scans PV for validity and returns false if the PV is invalid UTF-8.
4110 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4116 /* The octets may have got themselves encoded - get them back as
4119 if (!sv_utf8_downgrade(sv, TRUE))
4122 /* it is actually just a matter of turning the utf8 flag on, but
4123 * we want to make sure everything inside is valid utf8 first.
4125 c = (U8 *) SvPVX(sv);
4126 if (!is_utf8_string(c, SvCUR(sv)+1))
4128 e = (U8 *) SvEND(sv);
4131 if (!UTF8_IS_INVARIANT(ch)) {
4140 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4141 * this function provided for binary compatibility only
4145 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4147 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4151 =for apidoc sv_setsv
4153 Copies the contents of the source SV C<ssv> into the destination SV
4154 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4155 function if the source SV needs to be reused. Does not handle 'set' magic.
4156 Loosely speaking, it performs a copy-by-value, obliterating any previous
4157 content of the destination.
4159 You probably want to use one of the assortment of wrappers, such as
4160 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4161 C<SvSetMagicSV_nosteal>.
4163 =for apidoc sv_setsv_flags
4165 Copies the contents of the source SV C<ssv> into the destination SV
4166 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4167 function if the source SV needs to be reused. Does not handle 'set' magic.
4168 Loosely speaking, it performs a copy-by-value, obliterating any previous
4169 content of the destination.
4170 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4171 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4172 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4173 and C<sv_setsv_nomg> are implemented in terms of this function.
4175 You probably want to use one of the assortment of wrappers, such as
4176 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4177 C<SvSetMagicSV_nosteal>.
4179 This is the primary function for copying scalars, and most other
4180 copy-ish functions and macros use this underneath.
4186 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4188 register U32 sflags;
4194 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4196 sstr = &PL_sv_undef;
4197 stype = SvTYPE(sstr);
4198 dtype = SvTYPE(dstr);
4203 /* need to nuke the magic */
4205 SvRMAGICAL_off(dstr);
4208 /* There's a lot of redundancy below but we're going for speed here */
4213 if (dtype != SVt_PVGV) {
4214 (void)SvOK_off(dstr);
4222 sv_upgrade(dstr, SVt_IV);
4225 sv_upgrade(dstr, SVt_PVNV);
4229 sv_upgrade(dstr, SVt_PVIV);
4232 (void)SvIOK_only(dstr);
4233 SvIV_set(dstr, SvIVX(sstr));
4236 if (SvTAINTED(sstr))
4247 sv_upgrade(dstr, SVt_NV);
4252 sv_upgrade(dstr, SVt_PVNV);
4255 SvNV_set(dstr, SvNVX(sstr));
4256 (void)SvNOK_only(dstr);
4257 if (SvTAINTED(sstr))
4265 sv_upgrade(dstr, SVt_RV);
4266 else if (dtype == SVt_PVGV &&
4267 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4270 if (GvIMPORTED(dstr) != GVf_IMPORTED
4271 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4273 GvIMPORTED_on(dstr);
4282 #ifdef PERL_COPY_ON_WRITE
4283 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4284 if (dtype < SVt_PVIV)
4285 sv_upgrade(dstr, SVt_PVIV);
4292 sv_upgrade(dstr, SVt_PV);
4295 if (dtype < SVt_PVIV)
4296 sv_upgrade(dstr, SVt_PVIV);
4299 if (dtype < SVt_PVNV)
4300 sv_upgrade(dstr, SVt_PVNV);
4307 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4310 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4314 if (dtype <= SVt_PVGV) {
4316 if (dtype != SVt_PVGV) {
4317 char *name = GvNAME(sstr);
4318 STRLEN len = GvNAMELEN(sstr);
4319 /* don't upgrade SVt_PVLV: it can hold a glob */
4320 if (dtype != SVt_PVLV)
4321 sv_upgrade(dstr, SVt_PVGV);
4322 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4323 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4324 GvNAME(dstr) = savepvn(name, len);
4325 GvNAMELEN(dstr) = len;
4326 SvFAKE_on(dstr); /* can coerce to non-glob */
4328 /* ahem, death to those who redefine active sort subs */
4329 else if (PL_curstackinfo->si_type == PERLSI_SORT
4330 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4331 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4334 #ifdef GV_UNIQUE_CHECK
4335 if (GvUNIQUE((GV*)dstr)) {
4336 Perl_croak(aTHX_ PL_no_modify);
4340 (void)SvOK_off(dstr);
4341 GvINTRO_off(dstr); /* one-shot flag */
4343 GvGP(dstr) = gp_ref(GvGP(sstr));
4344 if (SvTAINTED(sstr))
4346 if (GvIMPORTED(dstr) != GVf_IMPORTED
4347 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4349 GvIMPORTED_on(dstr);
4357 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4359 if ((int)SvTYPE(sstr) != stype) {
4360 stype = SvTYPE(sstr);
4361 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4365 if (stype == SVt_PVLV)
4366 (void)SvUPGRADE(dstr, SVt_PVNV);
4368 (void)SvUPGRADE(dstr, (U32)stype);
4371 sflags = SvFLAGS(sstr);
4373 if (sflags & SVf_ROK) {
4374 if (dtype >= SVt_PV) {
4375 if (dtype == SVt_PVGV) {
4376 SV *sref = SvREFCNT_inc(SvRV(sstr));
4378 int intro = GvINTRO(dstr);
4380 #ifdef GV_UNIQUE_CHECK
4381 if (GvUNIQUE((GV*)dstr)) {
4382 Perl_croak(aTHX_ PL_no_modify);
4387 GvINTRO_off(dstr); /* one-shot flag */
4388 GvLINE(dstr) = CopLINE(PL_curcop);
4389 GvEGV(dstr) = (GV*)dstr;
4392 switch (SvTYPE(sref)) {
4395 SAVEGENERICSV(GvAV(dstr));
4397 dref = (SV*)GvAV(dstr);
4398 GvAV(dstr) = (AV*)sref;
4399 if (!GvIMPORTED_AV(dstr)
4400 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4402 GvIMPORTED_AV_on(dstr);
4407 SAVEGENERICSV(GvHV(dstr));
4409 dref = (SV*)GvHV(dstr);
4410 GvHV(dstr) = (HV*)sref;
4411 if (!GvIMPORTED_HV(dstr)
4412 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4414 GvIMPORTED_HV_on(dstr);
4419 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4420 SvREFCNT_dec(GvCV(dstr));
4421 GvCV(dstr) = Nullcv;
4422 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4423 PL_sub_generation++;
4425 SAVEGENERICSV(GvCV(dstr));
4428 dref = (SV*)GvCV(dstr);
4429 if (GvCV(dstr) != (CV*)sref) {
4430 CV* cv = GvCV(dstr);
4432 if (!GvCVGEN((GV*)dstr) &&
4433 (CvROOT(cv) || CvXSUB(cv)))
4435 /* ahem, death to those who redefine
4436 * active sort subs */
4437 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4438 PL_sortcop == CvSTART(cv))
4440 "Can't redefine active sort subroutine %s",
4441 GvENAME((GV*)dstr));
4442 /* Redefining a sub - warning is mandatory if
4443 it was a const and its value changed. */
4444 if (ckWARN(WARN_REDEFINE)
4446 && (!CvCONST((CV*)sref)
4447 || sv_cmp(cv_const_sv(cv),
4448 cv_const_sv((CV*)sref)))))
4450 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4452 ? "Constant subroutine %s::%s redefined"
4453 : "Subroutine %s::%s redefined",
4454 HvNAME(GvSTASH((GV*)dstr)),
4455 GvENAME((GV*)dstr));
4459 cv_ckproto(cv, (GV*)dstr,
4460 SvPOK(sref) ? SvPVX(sref) : Nullch);
4462 GvCV(dstr) = (CV*)sref;
4463 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4464 GvASSUMECV_on(dstr);
4465 PL_sub_generation++;
4467 if (!GvIMPORTED_CV(dstr)
4468 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4470 GvIMPORTED_CV_on(dstr);
4475 SAVEGENERICSV(GvIOp(dstr));
4477 dref = (SV*)GvIOp(dstr);
4478 GvIOp(dstr) = (IO*)sref;
4482 SAVEGENERICSV(GvFORM(dstr));
4484 dref = (SV*)GvFORM(dstr);
4485 GvFORM(dstr) = (CV*)sref;
4489 SAVEGENERICSV(GvSV(dstr));
4491 dref = (SV*)GvSV(dstr);
4493 if (!GvIMPORTED_SV(dstr)
4494 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4496 GvIMPORTED_SV_on(dstr);
4502 if (SvTAINTED(sstr))
4512 (void)SvOK_off(dstr);
4513 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4515 if (sflags & SVp_NOK) {
4517 /* Only set the public OK flag if the source has public OK. */
4518 if (sflags & SVf_NOK)
4519 SvFLAGS(dstr) |= SVf_NOK;
4520 SvNV_set(dstr, SvNVX(sstr));
4522 if (sflags & SVp_IOK) {
4523 (void)SvIOKp_on(dstr);
4524 if (sflags & SVf_IOK)
4525 SvFLAGS(dstr) |= SVf_IOK;
4526 if (sflags & SVf_IVisUV)
4528 SvIV_set(dstr, SvIVX(sstr));
4530 if (SvAMAGIC(sstr)) {
4534 else if (sflags & SVp_POK) {
4538 * Check to see if we can just swipe the string. If so, it's a
4539 * possible small lose on short strings, but a big win on long ones.
4540 * It might even be a win on short strings if SvPVX(dstr)
4541 * has to be allocated and SvPVX(sstr) has to be freed.
4544 /* Whichever path we take through the next code, we want this true,
4545 and doing it now facilitates the COW check. */
4546 (void)SvPOK_only(dstr);
4549 #ifdef PERL_COPY_ON_WRITE
4550 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4554 (sflags & SVs_TEMP) && /* slated for free anyway? */
4555 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4556 (!(flags & SV_NOSTEAL)) &&
4557 /* and we're allowed to steal temps */
4558 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4559 SvLEN(sstr) && /* and really is a string */
4560 /* and won't be needed again, potentially */
4561 !(PL_op && PL_op->op_type == OP_AASSIGN))
4562 #ifdef PERL_COPY_ON_WRITE
4563 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4564 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4565 && SvTYPE(sstr) >= SVt_PVIV)
4568 /* Failed the swipe test, and it's not a shared hash key either.
4569 Have to copy the string. */
4570 STRLEN len = SvCUR(sstr);
4571 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4572 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4573 SvCUR_set(dstr, len);
4574 *SvEND(dstr) = '\0';
4576 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4578 #ifdef PERL_COPY_ON_WRITE
4579 /* Either it's a shared hash key, or it's suitable for
4580 copy-on-write or we can swipe the string. */
4582 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4587 /* I believe I should acquire a global SV mutex if
4588 it's a COW sv (not a shared hash key) to stop
4589 it going un copy-on-write.
4590 If the source SV has gone un copy on write between up there
4591 and down here, then (assert() that) it is of the correct
4592 form to make it copy on write again */
4593 if ((sflags & (SVf_FAKE | SVf_READONLY))
4594 != (SVf_FAKE | SVf_READONLY)) {
4595 SvREADONLY_on(sstr);
4597 /* Make the source SV into a loop of 1.
4598 (about to become 2) */
4599 SV_COW_NEXT_SV_SET(sstr, sstr);
4603 /* Initial code is common. */
4604 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4606 SvFLAGS(dstr) &= ~SVf_OOK;
4607 Safefree(SvPVX(dstr) - SvIVX(dstr));
4609 else if (SvLEN(dstr))
4610 Safefree(SvPVX(dstr));
4613 #ifdef PERL_COPY_ON_WRITE
4615 /* making another shared SV. */
4616 STRLEN cur = SvCUR(sstr);
4617 STRLEN len = SvLEN(sstr);
4618 assert (SvTYPE(dstr) >= SVt_PVIV);
4620 /* SvIsCOW_normal */
4621 /* splice us in between source and next-after-source. */
4622 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4623 SV_COW_NEXT_SV_SET(sstr, dstr);
4624 SvPV_set(dstr, SvPVX(sstr));
4626 /* SvIsCOW_shared_hash */
4627 UV hash = SvUVX(sstr);
4628 DEBUG_C(PerlIO_printf(Perl_debug_log,
4629 "Copy on write: Sharing hash\n"));
4631 sharepvn(SvPVX(sstr),
4632 (sflags & SVf_UTF8?-cur:cur), hash));
4633 SvUV_set(dstr, hash);
4635 SvLEN_set(dstr, len);
4636 SvCUR_set(dstr, cur);
4637 SvREADONLY_on(dstr);
4639 /* Relesase a global SV mutex. */
4643 { /* Passes the swipe test. */
4644 SvPV_set(dstr, SvPVX(sstr));
4645 SvLEN_set(dstr, SvLEN(sstr));
4646 SvCUR_set(dstr, SvCUR(sstr));
4649 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4650 SvPV_set(sstr, Nullch);
4656 if (sflags & SVf_UTF8)
4659 if (sflags & SVp_NOK) {
4661 if (sflags & SVf_NOK)
4662 SvFLAGS(dstr) |= SVf_NOK;
4663 SvNV_set(dstr, SvNVX(sstr));
4665 if (sflags & SVp_IOK) {
4666 (void)SvIOKp_on(dstr);
4667 if (sflags & SVf_IOK)
4668 SvFLAGS(dstr) |= SVf_IOK;
4669 if (sflags & SVf_IVisUV)
4671 SvIV_set(dstr, SvIVX(sstr));
4674 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4675 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4676 smg->mg_ptr, smg->mg_len);
4677 SvRMAGICAL_on(dstr);
4680 else if (sflags & SVp_IOK) {
4681 if (sflags & SVf_IOK)
4682 (void)SvIOK_only(dstr);
4684 (void)SvOK_off(dstr);
4685 (void)SvIOKp_on(dstr);
4687 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4688 if (sflags & SVf_IVisUV)
4690 SvIV_set(dstr, SvIVX(sstr));
4691 if (sflags & SVp_NOK) {
4692 if (sflags & SVf_NOK)
4693 (void)SvNOK_on(dstr);
4695 (void)SvNOKp_on(dstr);
4696 SvNV_set(dstr, SvNVX(sstr));
4699 else if (sflags & SVp_NOK) {
4700 if (sflags & SVf_NOK)
4701 (void)SvNOK_only(dstr);
4703 (void)SvOK_off(dstr);
4706 SvNV_set(dstr, SvNVX(sstr));
4709 if (dtype == SVt_PVGV) {
4710 if (ckWARN(WARN_MISC))
4711 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4714 (void)SvOK_off(dstr);
4716 if (SvTAINTED(sstr))
4721 =for apidoc sv_setsv_mg
4723 Like C<sv_setsv>, but also handles 'set' magic.
4729 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4731 sv_setsv(dstr,sstr);
4735 #ifdef PERL_COPY_ON_WRITE
4737 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4739 STRLEN cur = SvCUR(sstr);
4740 STRLEN len = SvLEN(sstr);
4741 register char *new_pv;
4744 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4752 if (SvTHINKFIRST(dstr))
4753 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4754 else if (SvPVX(dstr))
4755 Safefree(SvPVX(dstr));
4759 (void)SvUPGRADE (dstr, SVt_PVIV);
4761 assert (SvPOK(sstr));
4762 assert (SvPOKp(sstr));
4763 assert (!SvIOK(sstr));
4764 assert (!SvIOKp(sstr));
4765 assert (!SvNOK(sstr));
4766 assert (!SvNOKp(sstr));
4768 if (SvIsCOW(sstr)) {
4770 if (SvLEN(sstr) == 0) {
4771 /* source is a COW shared hash key. */
4772 UV hash = SvUVX(sstr);
4773 DEBUG_C(PerlIO_printf(Perl_debug_log,
4774 "Fast copy on write: Sharing hash\n"));
4775 SvUV_set(dstr, hash);
4776 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4779 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4781 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4782 (void)SvUPGRADE (sstr, SVt_PVIV);
4783 SvREADONLY_on(sstr);
4785 DEBUG_C(PerlIO_printf(Perl_debug_log,
4786 "Fast copy on write: Converting sstr to COW\n"));
4787 SV_COW_NEXT_SV_SET(dstr, sstr);
4789 SV_COW_NEXT_SV_SET(sstr, dstr);
4790 new_pv = SvPVX(sstr);
4793 SvPV_set(dstr, new_pv);
4794 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4797 SvLEN_set(dstr, len);
4798 SvCUR_set(dstr, cur);
4807 =for apidoc sv_setpvn
4809 Copies a string into an SV. The C<len> parameter indicates the number of
4810 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4811 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4817 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4819 register char *dptr;
4821 SV_CHECK_THINKFIRST_COW_DROP(sv);
4827 /* len is STRLEN which is unsigned, need to copy to signed */
4830 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4832 (void)SvUPGRADE(sv, SVt_PV);
4834 SvGROW(sv, len + 1);
4836 Move(ptr,dptr,len,char);
4839 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4844 =for apidoc sv_setpvn_mg
4846 Like C<sv_setpvn>, but also handles 'set' magic.
4852 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4854 sv_setpvn(sv,ptr,len);
4859 =for apidoc sv_setpv
4861 Copies a string into an SV. The string must be null-terminated. Does not
4862 handle 'set' magic. See C<sv_setpv_mg>.
4868 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4870 register STRLEN len;
4872 SV_CHECK_THINKFIRST_COW_DROP(sv);
4878 (void)SvUPGRADE(sv, SVt_PV);
4880 SvGROW(sv, len + 1);
4881 Move(ptr,SvPVX(sv),len+1,char);
4883 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4888 =for apidoc sv_setpv_mg
4890 Like C<sv_setpv>, but also handles 'set' magic.
4896 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4903 =for apidoc sv_usepvn
4905 Tells an SV to use C<ptr> to find its string value. Normally the string is
4906 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4907 The C<ptr> should point to memory that was allocated by C<malloc>. The
4908 string length, C<len>, must be supplied. This function will realloc the
4909 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4910 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4911 See C<sv_usepvn_mg>.
4917 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4919 SV_CHECK_THINKFIRST_COW_DROP(sv);
4920 (void)SvUPGRADE(sv, SVt_PV);
4927 Renew(ptr, len+1, char);
4930 SvLEN_set(sv, len+1);
4932 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4937 =for apidoc sv_usepvn_mg
4939 Like C<sv_usepvn>, but also handles 'set' magic.
4945 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4947 sv_usepvn(sv,ptr,len);
4951 #ifdef PERL_COPY_ON_WRITE
4952 /* Need to do this *after* making the SV normal, as we need the buffer
4953 pointer to remain valid until after we've copied it. If we let go too early,
4954 another thread could invalidate it by unsharing last of the same hash key
4955 (which it can do by means other than releasing copy-on-write Svs)
4956 or by changing the other copy-on-write SVs in the loop. */
4958 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4959 U32 hash, SV *after)
4961 if (len) { /* this SV was SvIsCOW_normal(sv) */
4962 /* we need to find the SV pointing to us. */
4963 SV *current = SV_COW_NEXT_SV(after);
4965 if (current == sv) {
4966 /* The SV we point to points back to us (there were only two of us
4968 Hence other SV is no longer copy on write either. */
4970 SvREADONLY_off(after);
4972 /* We need to follow the pointers around the loop. */
4974 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4977 /* don't loop forever if the structure is bust, and we have
4978 a pointer into a closed loop. */
4979 assert (current != after);
4980 assert (SvPVX(current) == pvx);
4982 /* Make the SV before us point to the SV after us. */
4983 SV_COW_NEXT_SV_SET(current, after);
4986 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4991 Perl_sv_release_IVX(pTHX_ register SV *sv)
4994 sv_force_normal_flags(sv, 0);
5000 =for apidoc sv_force_normal_flags
5002 Undo various types of fakery on an SV: if the PV is a shared string, make
5003 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5004 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
5005 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
5006 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5007 SvPOK_off rather than making a copy. (Used where this scalar is about to be
5008 set to some other value.) In addition, the C<flags> parameter gets passed to
5009 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
5010 with flags set to 0.
5016 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
5018 #ifdef PERL_COPY_ON_WRITE
5019 if (SvREADONLY(sv)) {
5020 /* At this point I believe I should acquire a global SV mutex. */
5022 char *pvx = SvPVX(sv);
5023 STRLEN len = SvLEN(sv);
5024 STRLEN cur = SvCUR(sv);
5025 U32 hash = SvUVX(sv);
5026 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
5028 PerlIO_printf(Perl_debug_log,
5029 "Copy on write: Force normal %ld\n",
5035 /* This SV doesn't own the buffer, so need to New() a new one: */
5036 SvPV_set(sv, (char*)0);
5038 if (flags & SV_COW_DROP_PV) {
5039 /* OK, so we don't need to copy our buffer. */
5042 SvGROW(sv, cur + 1);
5043 Move(pvx,SvPVX(sv),cur,char);
5047 sv_release_COW(sv, pvx, cur, len, hash, next);
5052 else if (IN_PERL_RUNTIME)
5053 Perl_croak(aTHX_ PL_no_modify);
5054 /* At this point I believe that I can drop the global SV mutex. */
5057 if (SvREADONLY(sv)) {
5059 char *pvx = SvPVX(sv);
5060 int is_utf8 = SvUTF8(sv);
5061 STRLEN len = SvCUR(sv);
5062 U32 hash = SvUVX(sv);
5065 SvPV_set(sv, (char*)0);
5067 SvGROW(sv, len + 1);
5068 Move(pvx,SvPVX(sv),len,char);
5070 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5072 else if (IN_PERL_RUNTIME)
5073 Perl_croak(aTHX_ PL_no_modify);
5077 sv_unref_flags(sv, flags);
5078 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5083 =for apidoc sv_force_normal
5085 Undo various types of fakery on an SV: if the PV is a shared string, make
5086 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5087 an xpvmg. See also C<sv_force_normal_flags>.
5093 Perl_sv_force_normal(pTHX_ register SV *sv)
5095 sv_force_normal_flags(sv, 0);
5101 Efficient removal of characters from the beginning of the string buffer.
5102 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5103 the string buffer. The C<ptr> becomes the first character of the adjusted
5104 string. Uses the "OOK hack".
5105 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5106 refer to the same chunk of data.
5112 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
5114 register STRLEN delta;
5115 if (!ptr || !SvPOKp(sv))
5117 delta = ptr - SvPVX(sv);
5118 SV_CHECK_THINKFIRST(sv);
5119 if (SvTYPE(sv) < SVt_PVIV)
5120 sv_upgrade(sv,SVt_PVIV);
5123 if (!SvLEN(sv)) { /* make copy of shared string */
5124 const char *pvx = SvPVX(sv);
5125 STRLEN len = SvCUR(sv);
5126 SvGROW(sv, len + 1);
5127 Move(pvx,SvPVX(sv),len,char);
5131 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5132 and we do that anyway inside the SvNIOK_off
5134 SvFLAGS(sv) |= SVf_OOK;
5137 SvLEN_set(sv, SvLEN(sv) - delta);
5138 SvCUR_set(sv, SvCUR(sv) - delta);
5139 SvPV_set(sv, SvPVX(sv) + delta);
5140 SvIV_set(sv, SvIVX(sv) + delta);
5143 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5144 * this function provided for binary compatibility only
5148 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5150 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5154 =for apidoc sv_catpvn
5156 Concatenates the string onto the end of the string which is in the SV. The
5157 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5158 status set, then the bytes appended should be valid UTF-8.
5159 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5161 =for apidoc sv_catpvn_flags
5163 Concatenates the string onto the end of the string which is in the SV. The
5164 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5165 status set, then the bytes appended should be valid UTF-8.
5166 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5167 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5168 in terms of this function.
5174 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5177 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
5179 SvGROW(dsv, dlen + slen + 1);
5182 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5183 SvCUR_set(dsv, SvCUR(dsv) + slen);
5185 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5190 =for apidoc sv_catpvn_mg
5192 Like C<sv_catpvn>, but also handles 'set' magic.
5198 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5200 sv_catpvn(sv,ptr,len);
5204 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5205 * this function provided for binary compatibility only
5209 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5211 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5215 =for apidoc sv_catsv
5217 Concatenates the string from SV C<ssv> onto the end of the string in
5218 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5219 not 'set' magic. See C<sv_catsv_mg>.
5221 =for apidoc sv_catsv_flags
5223 Concatenates the string from SV C<ssv> onto the end of the string in
5224 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5225 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5226 and C<sv_catsv_nomg> are implemented in terms of this function.
5231 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5237 if ((spv = SvPV(ssv, slen))) {
5238 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5239 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5240 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5241 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5242 dsv->sv_flags doesn't have that bit set.
5243 Andy Dougherty 12 Oct 2001
5245 I32 sutf8 = DO_UTF8(ssv);
5248 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5250 dutf8 = DO_UTF8(dsv);
5252 if (dutf8 != sutf8) {
5254 /* Not modifying source SV, so taking a temporary copy. */
5255 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5257 sv_utf8_upgrade(csv);
5258 spv = SvPV(csv, slen);
5261 sv_utf8_upgrade_nomg(dsv);
5263 sv_catpvn_nomg(dsv, spv, slen);
5268 =for apidoc sv_catsv_mg
5270 Like C<sv_catsv>, but also handles 'set' magic.
5276 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5283 =for apidoc sv_catpv
5285 Concatenates the string onto the end of the string which is in the SV.
5286 If the SV has the UTF-8 status set, then the bytes appended should be
5287 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5292 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5294 register STRLEN len;
5300 junk = SvPV_force(sv, tlen);
5302 SvGROW(sv, tlen + len + 1);
5305 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5306 SvCUR_set(sv, SvCUR(sv) + len);
5307 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5312 =for apidoc sv_catpv_mg
5314 Like C<sv_catpv>, but also handles 'set' magic.
5320 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5329 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5330 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5337 Perl_newSV(pTHX_ STRLEN len)
5343 sv_upgrade(sv, SVt_PV);
5344 SvGROW(sv, len + 1);
5349 =for apidoc sv_magicext
5351 Adds magic to an SV, upgrading it if necessary. Applies the
5352 supplied vtable and returns a pointer to the magic added.
5354 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5355 In particular, you can add magic to SvREADONLY SVs, and add more than
5356 one instance of the same 'how'.
5358 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5359 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5360 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5361 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5363 (This is now used as a subroutine by C<sv_magic>.)
5368 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5369 const char* name, I32 namlen)
5373 if (SvTYPE(sv) < SVt_PVMG) {
5374 (void)SvUPGRADE(sv, SVt_PVMG);
5376 Newz(702,mg, 1, MAGIC);
5377 mg->mg_moremagic = SvMAGIC(sv);
5378 SvMAGIC_set(sv, mg);
5380 /* Sometimes a magic contains a reference loop, where the sv and
5381 object refer to each other. To prevent a reference loop that
5382 would prevent such objects being freed, we look for such loops
5383 and if we find one we avoid incrementing the object refcount.
5385 Note we cannot do this to avoid self-tie loops as intervening RV must
5386 have its REFCNT incremented to keep it in existence.
5389 if (!obj || obj == sv ||
5390 how == PERL_MAGIC_arylen ||
5391 how == PERL_MAGIC_qr ||
5392 (SvTYPE(obj) == SVt_PVGV &&
5393 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5394 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5395 GvFORM(obj) == (CV*)sv)))
5400 mg->mg_obj = SvREFCNT_inc(obj);
5401 mg->mg_flags |= MGf_REFCOUNTED;
5404 /* Normal self-ties simply pass a null object, and instead of
5405 using mg_obj directly, use the SvTIED_obj macro to produce a
5406 new RV as needed. For glob "self-ties", we are tieing the PVIO
5407 with an RV obj pointing to the glob containing the PVIO. In
5408 this case, to avoid a reference loop, we need to weaken the
5412 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5413 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5419 mg->mg_len = namlen;
5422 mg->mg_ptr = savepvn(name, namlen);
5423 else if (namlen == HEf_SVKEY)
5424 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5426 mg->mg_ptr = (char *) name;
5428 mg->mg_virtual = vtable;
5432 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5437 =for apidoc sv_magic
5439 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5440 then adds a new magic item of type C<how> to the head of the magic list.
5442 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5443 handling of the C<name> and C<namlen> arguments.
5445 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5446 to add more than one instance of the same 'how'.
5452 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5454 const MGVTBL *vtable = 0;
5457 #ifdef PERL_COPY_ON_WRITE
5459 sv_force_normal_flags(sv, 0);
5461 if (SvREADONLY(sv)) {
5463 && how != PERL_MAGIC_regex_global
5464 && how != PERL_MAGIC_bm
5465 && how != PERL_MAGIC_fm
5466 && how != PERL_MAGIC_sv
5467 && how != PERL_MAGIC_backref
5470 Perl_croak(aTHX_ PL_no_modify);
5473 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5474 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5475 /* sv_magic() refuses to add a magic of the same 'how' as an
5478 if (how == PERL_MAGIC_taint)
5486 vtable = &PL_vtbl_sv;
5488 case PERL_MAGIC_overload:
5489 vtable = &PL_vtbl_amagic;
5491 case PERL_MAGIC_overload_elem:
5492 vtable = &PL_vtbl_amagicelem;
5494 case PERL_MAGIC_overload_table:
5495 vtable = &PL_vtbl_ovrld;
5498 vtable = &PL_vtbl_bm;
5500 case PERL_MAGIC_regdata:
5501 vtable = &PL_vtbl_regdata;
5503 case PERL_MAGIC_regdatum:
5504 vtable = &PL_vtbl_regdatum;
5506 case PERL_MAGIC_env:
5507 vtable = &PL_vtbl_env;
5510 vtable = &PL_vtbl_fm;
5512 case PERL_MAGIC_envelem:
5513 vtable = &PL_vtbl_envelem;
5515 case PERL_MAGIC_regex_global:
5516 vtable = &PL_vtbl_mglob;
5518 case PERL_MAGIC_isa:
5519 vtable = &PL_vtbl_isa;
5521 case PERL_MAGIC_isaelem:
5522 vtable = &PL_vtbl_isaelem;
5524 case PERL_MAGIC_nkeys:
5525 vtable = &PL_vtbl_nkeys;
5527 case PERL_MAGIC_dbfile:
5530 case PERL_MAGIC_dbline:
5531 vtable = &PL_vtbl_dbline;
5533 #ifdef USE_LOCALE_COLLATE
5534 case PERL_MAGIC_collxfrm:
5535 vtable = &PL_vtbl_collxfrm;
5537 #endif /* USE_LOCALE_COLLATE */
5538 case PERL_MAGIC_tied:
5539 vtable = &PL_vtbl_pack;
5541 case PERL_MAGIC_tiedelem:
5542 case PERL_MAGIC_tiedscalar:
5543 vtable = &PL_vtbl_packelem;
5546 vtable = &PL_vtbl_regexp;
5548 case PERL_MAGIC_sig:
5549 vtable = &PL_vtbl_sig;
5551 case PERL_MAGIC_sigelem:
5552 vtable = &PL_vtbl_sigelem;
5554 case PERL_MAGIC_taint:
5555 vtable = &PL_vtbl_taint;
5557 case PERL_MAGIC_uvar:
5558 vtable = &PL_vtbl_uvar;
5560 case PERL_MAGIC_vec:
5561 vtable = &PL_vtbl_vec;
5563 case PERL_MAGIC_vstring:
5566 case PERL_MAGIC_utf8:
5567 vtable = &PL_vtbl_utf8;
5569 case PERL_MAGIC_substr:
5570 vtable = &PL_vtbl_substr;
5572 case PERL_MAGIC_defelem:
5573 vtable = &PL_vtbl_defelem;
5575 case PERL_MAGIC_glob:
5576 vtable = &PL_vtbl_glob;
5578 case PERL_MAGIC_arylen:
5579 vtable = &PL_vtbl_arylen;
5581 case PERL_MAGIC_pos:
5582 vtable = &PL_vtbl_pos;
5584 case PERL_MAGIC_backref:
5585 vtable = &PL_vtbl_backref;
5587 case PERL_MAGIC_ext:
5588 /* Reserved for use by extensions not perl internals. */
5589 /* Useful for attaching extension internal data to perl vars. */
5590 /* Note that multiple extensions may clash if magical scalars */
5591 /* etc holding private data from one are passed to another. */
5594 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5597 /* Rest of work is done else where */
5598 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5601 case PERL_MAGIC_taint:
5604 case PERL_MAGIC_ext:
5605 case PERL_MAGIC_dbfile:
5612 =for apidoc sv_unmagic
5614 Removes all magic of type C<type> from an SV.
5620 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5624 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5627 for (mg = *mgp; mg; mg = *mgp) {
5628 if (mg->mg_type == type) {
5629 const MGVTBL* const vtbl = mg->mg_virtual;
5630 *mgp = mg->mg_moremagic;
5631 if (vtbl && vtbl->svt_free)
5632 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5633 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5635 Safefree(mg->mg_ptr);
5636 else if (mg->mg_len == HEf_SVKEY)
5637 SvREFCNT_dec((SV*)mg->mg_ptr);
5638 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5639 Safefree(mg->mg_ptr);
5641 if (mg->mg_flags & MGf_REFCOUNTED)
5642 SvREFCNT_dec(mg->mg_obj);
5646 mgp = &mg->mg_moremagic;
5650 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5657 =for apidoc sv_rvweaken
5659 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5660 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5661 push a back-reference to this RV onto the array of backreferences
5662 associated with that magic.
5668 Perl_sv_rvweaken(pTHX_ SV *sv)
5671 if (!SvOK(sv)) /* let undefs pass */
5674 Perl_croak(aTHX_ "Can't weaken a nonreference");
5675 else if (SvWEAKREF(sv)) {
5676 if (ckWARN(WARN_MISC))
5677 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5681 sv_add_backref(tsv, sv);
5687 /* Give tsv backref magic if it hasn't already got it, then push a
5688 * back-reference to sv onto the array associated with the backref magic.
5692 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5696 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5697 av = (AV*)mg->mg_obj;
5700 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5701 /* av now has a refcnt of 2, which avoids it getting freed
5702 * before us during global cleanup. The extra ref is removed
5703 * by magic_killbackrefs() when tsv is being freed */
5705 if (AvFILLp(av) >= AvMAX(av)) {
5707 SV **svp = AvARRAY(av);
5708 for (i = AvFILLp(av); i >= 0; i--)
5710 svp[i] = sv; /* reuse the slot */
5713 av_extend(av, AvFILLp(av)+1);
5715 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5718 /* delete a back-reference to ourselves from the backref magic associated
5719 * with the SV we point to.
5723 S_sv_del_backref(pTHX_ SV *sv)
5730 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5731 Perl_croak(aTHX_ "panic: del_backref");
5732 av = (AV *)mg->mg_obj;
5734 for (i = AvFILLp(av); i >= 0; i--)
5735 if (svp[i] == sv) svp[i] = Nullsv;
5739 =for apidoc sv_insert
5741 Inserts a string at the specified offset/length within the SV. Similar to
5742 the Perl substr() function.
5748 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5752 register char *midend;
5753 register char *bigend;
5759 Perl_croak(aTHX_ "Can't modify non-existent substring");
5760 SvPV_force(bigstr, curlen);
5761 (void)SvPOK_only_UTF8(bigstr);
5762 if (offset + len > curlen) {
5763 SvGROW(bigstr, offset+len+1);
5764 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5765 SvCUR_set(bigstr, offset+len);
5769 i = littlelen - len;
5770 if (i > 0) { /* string might grow */
5771 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5772 mid = big + offset + len;
5773 midend = bigend = big + SvCUR(bigstr);
5776 while (midend > mid) /* shove everything down */
5777 *--bigend = *--midend;
5778 Move(little,big+offset,littlelen,char);
5779 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5784 Move(little,SvPVX(bigstr)+offset,len,char);
5789 big = SvPVX(bigstr);
5792 bigend = big + SvCUR(bigstr);
5794 if (midend > bigend)
5795 Perl_croak(aTHX_ "panic: sv_insert");
5797 if (mid - big > bigend - midend) { /* faster to shorten from end */
5799 Move(little, mid, littlelen,char);
5802 i = bigend - midend;
5804 Move(midend, mid, i,char);
5808 SvCUR_set(bigstr, mid - big);
5811 else if ((i = mid - big)) { /* faster from front */
5812 midend -= littlelen;
5814 sv_chop(bigstr,midend-i);
5819 Move(little, mid, littlelen,char);
5821 else if (littlelen) {
5822 midend -= littlelen;
5823 sv_chop(bigstr,midend);
5824 Move(little,midend,littlelen,char);
5827 sv_chop(bigstr,midend);
5833 =for apidoc sv_replace
5835 Make the first argument a copy of the second, then delete the original.
5836 The target SV physically takes over ownership of the body of the source SV
5837 and inherits its flags; however, the target keeps any magic it owns,
5838 and any magic in the source is discarded.
5839 Note that this is a rather specialist SV copying operation; most of the
5840 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5846 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5848 U32 refcnt = SvREFCNT(sv);
5849 SV_CHECK_THINKFIRST_COW_DROP(sv);
5850 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5851 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5852 if (SvMAGICAL(sv)) {
5856 sv_upgrade(nsv, SVt_PVMG);
5857 SvMAGIC_set(nsv, SvMAGIC(sv));
5858 SvFLAGS(nsv) |= SvMAGICAL(sv);
5860 SvMAGIC_set(sv, NULL);
5864 assert(!SvREFCNT(sv));
5865 #ifdef DEBUG_LEAKING_SCALARS
5866 sv->sv_flags = nsv->sv_flags;
5867 sv->sv_any = nsv->sv_any;
5868 sv->sv_refcnt = nsv->sv_refcnt;
5870 StructCopy(nsv,sv,SV);
5873 #ifdef PERL_COPY_ON_WRITE
5874 if (SvIsCOW_normal(nsv)) {
5875 /* We need to follow the pointers around the loop to make the
5876 previous SV point to sv, rather than nsv. */
5879 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5882 assert(SvPVX(current) == SvPVX(nsv));
5884 /* Make the SV before us point to the SV after us. */
5886 PerlIO_printf(Perl_debug_log, "previous is\n");
5888 PerlIO_printf(Perl_debug_log,
5889 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5890 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5892 SV_COW_NEXT_SV_SET(current, sv);
5895 SvREFCNT(sv) = refcnt;
5896 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5902 =for apidoc sv_clear
5904 Clear an SV: call any destructors, free up any memory used by the body,
5905 and free the body itself. The SV's head is I<not> freed, although
5906 its type is set to all 1's so that it won't inadvertently be assumed
5907 to be live during global destruction etc.
5908 This function should only be called when REFCNT is zero. Most of the time
5909 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5916 Perl_sv_clear(pTHX_ register SV *sv)
5921 assert(SvREFCNT(sv) == 0);
5924 if (PL_defstash) { /* Still have a symbol table? */
5931 stash = SvSTASH(sv);
5932 destructor = StashHANDLER(stash,DESTROY);
5934 SV* tmpref = newRV(sv);
5935 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5937 PUSHSTACKi(PERLSI_DESTROY);
5942 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5948 if(SvREFCNT(tmpref) < 2) {
5949 /* tmpref is not kept alive! */
5951 SvRV_set(tmpref, NULL);
5954 SvREFCNT_dec(tmpref);
5956 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5960 if (PL_in_clean_objs)
5961 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5963 /* DESTROY gave object new lease on life */
5969 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5970 SvOBJECT_off(sv); /* Curse the object. */
5971 if (SvTYPE(sv) != SVt_PVIO)
5972 --PL_sv_objcount; /* XXX Might want something more general */
5975 if (SvTYPE(sv) >= SVt_PVMG) {
5978 if (SvFLAGS(sv) & SVpad_TYPED)
5979 SvREFCNT_dec(SvSTASH(sv));
5982 switch (SvTYPE(sv)) {
5985 IoIFP(sv) != PerlIO_stdin() &&
5986 IoIFP(sv) != PerlIO_stdout() &&
5987 IoIFP(sv) != PerlIO_stderr())
5989 io_close((IO*)sv, FALSE);
5991 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5992 PerlDir_close(IoDIRP(sv));
5993 IoDIRP(sv) = (DIR*)NULL;
5994 Safefree(IoTOP_NAME(sv));
5995 Safefree(IoFMT_NAME(sv));
5996 Safefree(IoBOTTOM_NAME(sv));
6011 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6012 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6013 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6014 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6016 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6017 SvREFCNT_dec(LvTARG(sv));
6021 Safefree(GvNAME(sv));
6022 /* cannot decrease stash refcount yet, as we might recursively delete
6023 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
6024 of stash until current sv is completely gone.
6025 -- JohnPC, 27 Mar 1998 */
6026 stash = GvSTASH(sv);
6032 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
6034 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
6035 /* Don't even bother with turning off the OOK flag. */
6044 SvREFCNT_dec(SvRV(sv));
6046 #ifdef PERL_COPY_ON_WRITE
6047 else if (SvPVX(sv)) {
6049 /* I believe I need to grab the global SV mutex here and
6050 then recheck the COW status. */
6052 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6055 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
6056 SvUVX(sv), SV_COW_NEXT_SV(sv));
6057 /* And drop it here. */
6059 } else if (SvLEN(sv)) {
6060 Safefree(SvPVX(sv));
6064 else if (SvPVX(sv) && SvLEN(sv))
6065 Safefree(SvPVX(sv));
6066 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6067 unsharepvn(SvPVX(sv),
6068 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6082 switch (SvTYPE(sv)) {
6098 del_XPVIV(SvANY(sv));
6101 del_XPVNV(SvANY(sv));
6104 del_XPVMG(SvANY(sv));
6107 del_XPVLV(SvANY(sv));
6110 del_XPVAV(SvANY(sv));
6113 del_XPVHV(SvANY(sv));
6116 del_XPVCV(SvANY(sv));
6119 del_XPVGV(SvANY(sv));
6120 /* code duplication for increased performance. */
6121 SvFLAGS(sv) &= SVf_BREAK;
6122 SvFLAGS(sv) |= SVTYPEMASK;
6123 /* decrease refcount of the stash that owns this GV, if any */
6125 SvREFCNT_dec(stash);
6126 return; /* not break, SvFLAGS reset already happened */
6128 del_XPVBM(SvANY(sv));
6131 del_XPVFM(SvANY(sv));
6134 del_XPVIO(SvANY(sv));
6137 SvFLAGS(sv) &= SVf_BREAK;
6138 SvFLAGS(sv) |= SVTYPEMASK;
6142 =for apidoc sv_newref
6144 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6151 Perl_sv_newref(pTHX_ SV *sv)
6161 Decrement an SV's reference count, and if it drops to zero, call
6162 C<sv_clear> to invoke destructors and free up any memory used by
6163 the body; finally, deallocate the SV's head itself.
6164 Normally called via a wrapper macro C<SvREFCNT_dec>.
6170 Perl_sv_free(pTHX_ SV *sv)
6175 if (SvREFCNT(sv) == 0) {
6176 if (SvFLAGS(sv) & SVf_BREAK)
6177 /* this SV's refcnt has been artificially decremented to
6178 * trigger cleanup */
6180 if (PL_in_clean_all) /* All is fair */
6182 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6183 /* make sure SvREFCNT(sv)==0 happens very seldom */
6184 SvREFCNT(sv) = (~(U32)0)/2;
6187 if (ckWARN_d(WARN_INTERNAL))
6188 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6189 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6190 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6193 if (--(SvREFCNT(sv)) > 0)
6195 Perl_sv_free2(aTHX_ sv);
6199 Perl_sv_free2(pTHX_ SV *sv)
6204 if (ckWARN_d(WARN_DEBUGGING))
6205 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6206 "Attempt to free temp prematurely: SV 0x%"UVxf
6207 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6211 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6212 /* make sure SvREFCNT(sv)==0 happens very seldom */
6213 SvREFCNT(sv) = (~(U32)0)/2;
6224 Returns the length of the string in the SV. Handles magic and type
6225 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6231 Perl_sv_len(pTHX_ register SV *sv)
6239 len = mg_length(sv);
6241 (void)SvPV(sv, len);
6246 =for apidoc sv_len_utf8
6248 Returns the number of characters in the string in an SV, counting wide
6249 UTF-8 bytes as a single character. Handles magic and type coercion.
6255 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6256 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6257 * (Note that the mg_len is not the length of the mg_ptr field.)
6262 Perl_sv_len_utf8(pTHX_ register SV *sv)
6268 return mg_length(sv);
6272 U8 *s = (U8*)SvPV(sv, len);
6273 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6275 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6277 #ifdef PERL_UTF8_CACHE_ASSERT
6278 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6282 ulen = Perl_utf8_length(aTHX_ s, s + len);
6283 if (!mg && !SvREADONLY(sv)) {
6284 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6285 mg = mg_find(sv, PERL_MAGIC_utf8);
6295 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6296 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6297 * between UTF-8 and byte offsets. There are two (substr offset and substr
6298 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6299 * and byte offset) cache positions.
6301 * The mg_len field is used by sv_len_utf8(), see its comments.
6302 * Note that the mg_len is not the length of the mg_ptr field.
6306 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6310 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6312 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6316 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6318 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6319 (*mgp)->mg_ptr = (char *) *cachep;
6323 (*cachep)[i] = *offsetp;
6324 (*cachep)[i+1] = s - start;
6332 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6333 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6334 * between UTF-8 and byte offsets. See also the comments of
6335 * S_utf8_mg_pos_init().
6339 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6343 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6345 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6346 if (*mgp && (*mgp)->mg_ptr) {
6347 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6348 ASSERT_UTF8_CACHE(*cachep);
6349 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6351 else { /* We will skip to the right spot. */
6356 /* The assumption is that going backward is half
6357 * the speed of going forward (that's where the
6358 * 2 * backw in the below comes from). (The real
6359 * figure of course depends on the UTF-8 data.) */
6361 if ((*cachep)[i] > (STRLEN)uoff) {
6363 backw = (*cachep)[i] - (STRLEN)uoff;
6365 if (forw < 2 * backw)
6368 p = start + (*cachep)[i+1];
6370 /* Try this only for the substr offset (i == 0),
6371 * not for the substr length (i == 2). */
6372 else if (i == 0) { /* (*cachep)[i] < uoff */
6373 STRLEN ulen = sv_len_utf8(sv);
6375 if ((STRLEN)uoff < ulen) {
6376 forw = (STRLEN)uoff - (*cachep)[i];
6377 backw = ulen - (STRLEN)uoff;
6379 if (forw < 2 * backw)
6380 p = start + (*cachep)[i+1];
6385 /* If the string is not long enough for uoff,
6386 * we could extend it, but not at this low a level. */
6390 if (forw < 2 * backw) {
6397 while (UTF8_IS_CONTINUATION(*p))
6402 /* Update the cache. */
6403 (*cachep)[i] = (STRLEN)uoff;
6404 (*cachep)[i+1] = p - start;
6406 /* Drop the stale "length" cache */
6415 if (found) { /* Setup the return values. */
6416 *offsetp = (*cachep)[i+1];
6417 *sp = start + *offsetp;
6420 *offsetp = send - start;
6422 else if (*sp < start) {
6428 #ifdef PERL_UTF8_CACHE_ASSERT
6433 while (n-- && s < send)
6437 assert(*offsetp == s - start);
6438 assert((*cachep)[0] == (STRLEN)uoff);
6439 assert((*cachep)[1] == *offsetp);
6441 ASSERT_UTF8_CACHE(*cachep);
6450 =for apidoc sv_pos_u2b
6452 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6453 the start of the string, to a count of the equivalent number of bytes; if
6454 lenp is non-zero, it does the same to lenp, but this time starting from
6455 the offset, rather than from the start of the string. Handles magic and
6462 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6463 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6464 * byte offsets. See also the comments of S_utf8_mg_pos().
6469 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6480 start = s = (U8*)SvPV(sv, len);
6482 I32 uoffset = *offsetp;
6487 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6489 if (!found && uoffset > 0) {
6490 while (s < send && uoffset--)
6494 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6496 *offsetp = s - start;
6501 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6505 if (!found && *lenp > 0) {
6508 while (s < send && ulen--)
6512 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6516 ASSERT_UTF8_CACHE(cache);
6528 =for apidoc sv_pos_b2u
6530 Converts the value pointed to by offsetp from a count of bytes from the
6531 start of the string, to a count of the equivalent number of UTF-8 chars.
6532 Handles magic and type coercion.
6538 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6539 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6540 * byte offsets. See also the comments of S_utf8_mg_pos().
6545 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6553 s = (U8*)SvPV(sv, len);
6554 if ((I32)len < *offsetp)
6555 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6557 U8* send = s + *offsetp;
6559 STRLEN *cache = NULL;
6563 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6564 mg = mg_find(sv, PERL_MAGIC_utf8);
6565 if (mg && mg->mg_ptr) {
6566 cache = (STRLEN *) mg->mg_ptr;
6567 if (cache[1] == (STRLEN)*offsetp) {
6568 /* An exact match. */
6569 *offsetp = cache[0];
6573 else if (cache[1] < (STRLEN)*offsetp) {
6574 /* We already know part of the way. */
6577 /* Let the below loop do the rest. */
6579 else { /* cache[1] > *offsetp */
6580 /* We already know all of the way, now we may
6581 * be able to walk back. The same assumption
6582 * is made as in S_utf8_mg_pos(), namely that
6583 * walking backward is twice slower than
6584 * walking forward. */
6585 STRLEN forw = *offsetp;
6586 STRLEN backw = cache[1] - *offsetp;
6588 if (!(forw < 2 * backw)) {
6589 U8 *p = s + cache[1];
6596 while (UTF8_IS_CONTINUATION(*p)) {
6604 *offsetp = cache[0];
6606 /* Drop the stale "length" cache */
6614 ASSERT_UTF8_CACHE(cache);
6620 /* Call utf8n_to_uvchr() to validate the sequence
6621 * (unless a simple non-UTF character) */
6622 if (!UTF8_IS_INVARIANT(*s))
6623 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6632 if (!SvREADONLY(sv)) {
6634 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6635 mg = mg_find(sv, PERL_MAGIC_utf8);
6640 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6641 mg->mg_ptr = (char *) cache;
6646 cache[1] = *offsetp;
6647 /* Drop the stale "length" cache */
6660 Returns a boolean indicating whether the strings in the two SVs are
6661 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6662 coerce its args to strings if necessary.
6668 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6676 SV* svrecode = Nullsv;
6683 pv1 = SvPV(sv1, cur1);
6690 pv2 = SvPV(sv2, cur2);
6692 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6693 /* Differing utf8ness.
6694 * Do not UTF8size the comparands as a side-effect. */
6697 svrecode = newSVpvn(pv2, cur2);
6698 sv_recode_to_utf8(svrecode, PL_encoding);
6699 pv2 = SvPV(svrecode, cur2);
6702 svrecode = newSVpvn(pv1, cur1);
6703 sv_recode_to_utf8(svrecode, PL_encoding);
6704 pv1 = SvPV(svrecode, cur1);
6706 /* Now both are in UTF-8. */
6708 SvREFCNT_dec(svrecode);
6713 bool is_utf8 = TRUE;
6716 /* sv1 is the UTF-8 one,
6717 * if is equal it must be downgrade-able */
6718 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6724 /* sv2 is the UTF-8 one,
6725 * if is equal it must be downgrade-able */
6726 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6732 /* Downgrade not possible - cannot be eq */
6740 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6743 SvREFCNT_dec(svrecode);
6754 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6755 string in C<sv1> is less than, equal to, or greater than the string in
6756 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6757 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6763 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6766 const char *pv1, *pv2;
6769 SV *svrecode = Nullsv;
6776 pv1 = SvPV(sv1, cur1);
6783 pv2 = SvPV(sv2, cur2);
6785 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6786 /* Differing utf8ness.
6787 * Do not UTF8size the comparands as a side-effect. */
6790 svrecode = newSVpvn(pv2, cur2);
6791 sv_recode_to_utf8(svrecode, PL_encoding);
6792 pv2 = SvPV(svrecode, cur2);
6795 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6800 svrecode = newSVpvn(pv1, cur1);
6801 sv_recode_to_utf8(svrecode, PL_encoding);
6802 pv1 = SvPV(svrecode, cur1);
6805 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6811 cmp = cur2 ? -1 : 0;
6815 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6818 cmp = retval < 0 ? -1 : 1;
6819 } else if (cur1 == cur2) {
6822 cmp = cur1 < cur2 ? -1 : 1;
6827 SvREFCNT_dec(svrecode);
6836 =for apidoc sv_cmp_locale
6838 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6839 'use bytes' aware, handles get magic, and will coerce its args to strings
6840 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6846 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6848 #ifdef USE_LOCALE_COLLATE
6854 if (PL_collation_standard)
6858 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6860 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6862 if (!pv1 || !len1) {
6873 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6876 return retval < 0 ? -1 : 1;
6879 * When the result of collation is equality, that doesn't mean
6880 * that there are no differences -- some locales exclude some
6881 * characters from consideration. So to avoid false equalities,
6882 * we use the raw string as a tiebreaker.
6888 #endif /* USE_LOCALE_COLLATE */
6890 return sv_cmp(sv1, sv2);
6894 #ifdef USE_LOCALE_COLLATE
6897 =for apidoc sv_collxfrm
6899 Add Collate Transform magic to an SV if it doesn't already have it.
6901 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6902 scalar data of the variable, but transformed to such a format that a normal
6903 memory comparison can be used to compare the data according to the locale
6910 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6914 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6915 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6920 Safefree(mg->mg_ptr);
6922 if ((xf = mem_collxfrm(s, len, &xlen))) {
6923 if (SvREADONLY(sv)) {
6926 return xf + sizeof(PL_collation_ix);
6929 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6930 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6943 if (mg && mg->mg_ptr) {
6945 return mg->mg_ptr + sizeof(PL_collation_ix);
6953 #endif /* USE_LOCALE_COLLATE */
6958 Get a line from the filehandle and store it into the SV, optionally
6959 appending to the currently-stored string.
6965 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6969 register STDCHAR rslast;
6970 register STDCHAR *bp;
6976 if (SvTHINKFIRST(sv))
6977 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6978 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6980 However, perlbench says it's slower, because the existing swipe code
6981 is faster than copy on write.
6982 Swings and roundabouts. */
6983 (void)SvUPGRADE(sv, SVt_PV);
6988 if (PerlIO_isutf8(fp)) {
6990 sv_utf8_upgrade_nomg(sv);
6991 sv_pos_u2b(sv,&append,0);
6993 } else if (SvUTF8(sv)) {
6994 SV *tsv = NEWSV(0,0);
6995 sv_gets(tsv, fp, 0);
6996 sv_utf8_upgrade_nomg(tsv);
6997 SvCUR_set(sv,append);
7000 goto return_string_or_null;
7005 if (PerlIO_isutf8(fp))
7008 if (IN_PERL_COMPILETIME) {
7009 /* we always read code in line mode */
7013 else if (RsSNARF(PL_rs)) {
7014 /* If it is a regular disk file use size from stat() as estimate
7015 of amount we are going to read - may result in malloc-ing
7016 more memory than we realy need if layers bellow reduce
7017 size we read (e.g. CRLF or a gzip layer)
7020 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7021 const Off_t offset = PerlIO_tell(fp);
7022 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7023 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7029 else if (RsRECORD(PL_rs)) {
7033 /* Grab the size of the record we're getting */
7034 recsize = SvIV(SvRV(PL_rs));
7035 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7038 /* VMS wants read instead of fread, because fread doesn't respect */
7039 /* RMS record boundaries. This is not necessarily a good thing to be */
7040 /* doing, but we've got no other real choice - except avoid stdio
7041 as implementation - perhaps write a :vms layer ?
7043 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
7045 bytesread = PerlIO_read(fp, buffer, recsize);
7049 SvCUR_set(sv, bytesread += append);
7050 buffer[bytesread] = '\0';
7051 goto return_string_or_null;
7053 else if (RsPARA(PL_rs)) {
7059 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7060 if (PerlIO_isutf8(fp)) {
7061 rsptr = SvPVutf8(PL_rs, rslen);
7064 if (SvUTF8(PL_rs)) {
7065 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7066 Perl_croak(aTHX_ "Wide character in $/");
7069 rsptr = SvPV(PL_rs, rslen);
7073 rslast = rslen ? rsptr[rslen - 1] : '\0';
7075 if (rspara) { /* have to do this both before and after */
7076 do { /* to make sure file boundaries work right */
7079 i = PerlIO_getc(fp);
7083 PerlIO_ungetc(fp,i);
7089 /* See if we know enough about I/O mechanism to cheat it ! */
7091 /* This used to be #ifdef test - it is made run-time test for ease
7092 of abstracting out stdio interface. One call should be cheap
7093 enough here - and may even be a macro allowing compile
7097 if (PerlIO_fast_gets(fp)) {
7100 * We're going to steal some values from the stdio struct
7101 * and put EVERYTHING in the innermost loop into registers.
7103 register STDCHAR *ptr;
7107 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7108 /* An ungetc()d char is handled separately from the regular
7109 * buffer, so we getc() it back out and stuff it in the buffer.
7111 i = PerlIO_getc(fp);
7112 if (i == EOF) return 0;
7113 *(--((*fp)->_ptr)) = (unsigned char) i;
7117 /* Here is some breathtakingly efficient cheating */
7119 cnt = PerlIO_get_cnt(fp); /* get count into register */
7120 /* make sure we have the room */
7121 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7122 /* Not room for all of it
7123 if we are looking for a separator and room for some
7125 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7126 /* just process what we have room for */
7127 shortbuffered = cnt - SvLEN(sv) + append + 1;
7128 cnt -= shortbuffered;
7132 /* remember that cnt can be negative */
7133 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7138 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7139 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7140 DEBUG_P(PerlIO_printf(Perl_debug_log,
7141 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7142 DEBUG_P(PerlIO_printf(Perl_debug_log,
7143 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7144 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7145 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7150 while (cnt > 0) { /* this | eat */
7152 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7153 goto thats_all_folks; /* screams | sed :-) */
7157 Copy(ptr, bp, cnt, char); /* this | eat */
7158 bp += cnt; /* screams | dust */
7159 ptr += cnt; /* louder | sed :-) */
7164 if (shortbuffered) { /* oh well, must extend */
7165 cnt = shortbuffered;
7167 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7169 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7170 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7174 DEBUG_P(PerlIO_printf(Perl_debug_log,
7175 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7176 PTR2UV(ptr),(long)cnt));
7177 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7179 DEBUG_P(PerlIO_printf(Perl_debug_log,
7180 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7181 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7182 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7184 /* This used to call 'filbuf' in stdio form, but as that behaves like
7185 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7186 another abstraction. */
7187 i = PerlIO_getc(fp); /* get more characters */
7189 DEBUG_P(PerlIO_printf(Perl_debug_log,
7190 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7191 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7192 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7194 cnt = PerlIO_get_cnt(fp);
7195 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7196 DEBUG_P(PerlIO_printf(Perl_debug_log,
7197 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7199 if (i == EOF) /* all done for ever? */
7200 goto thats_really_all_folks;
7202 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7204 SvGROW(sv, bpx + cnt + 2);
7205 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7207 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7209 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7210 goto thats_all_folks;
7214 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7215 memNE((char*)bp - rslen, rsptr, rslen))
7216 goto screamer; /* go back to the fray */
7217 thats_really_all_folks:
7219 cnt += shortbuffered;
7220 DEBUG_P(PerlIO_printf(Perl_debug_log,
7221 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7222 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7223 DEBUG_P(PerlIO_printf(Perl_debug_log,
7224 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7225 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7226 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7228 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7229 DEBUG_P(PerlIO_printf(Perl_debug_log,
7230 "Screamer: done, len=%ld, string=|%.*s|\n",
7231 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7235 /*The big, slow, and stupid way. */
7236 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7238 New(0, buf, 8192, STDCHAR);
7246 const register STDCHAR *bpe = buf + sizeof(buf);
7248 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7249 ; /* keep reading */
7253 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7254 /* Accomodate broken VAXC compiler, which applies U8 cast to
7255 * both args of ?: operator, causing EOF to change into 255
7258 i = (U8)buf[cnt - 1];
7264 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7266 sv_catpvn(sv, (char *) buf, cnt);
7268 sv_setpvn(sv, (char *) buf, cnt);
7270 if (i != EOF && /* joy */
7272 SvCUR(sv) < rslen ||
7273 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7277 * If we're reading from a TTY and we get a short read,
7278 * indicating that the user hit his EOF character, we need
7279 * to notice it now, because if we try to read from the TTY
7280 * again, the EOF condition will disappear.
7282 * The comparison of cnt to sizeof(buf) is an optimization
7283 * that prevents unnecessary calls to feof().
7287 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7291 #ifdef USE_HEAP_INSTEAD_OF_STACK
7296 if (rspara) { /* have to do this both before and after */
7297 while (i != EOF) { /* to make sure file boundaries work right */
7298 i = PerlIO_getc(fp);
7300 PerlIO_ungetc(fp,i);
7306 return_string_or_null:
7307 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7313 Auto-increment of the value in the SV, doing string to numeric conversion
7314 if necessary. Handles 'get' magic.
7320 Perl_sv_inc(pTHX_ register SV *sv)
7329 if (SvTHINKFIRST(sv)) {
7331 sv_force_normal_flags(sv, 0);
7332 if (SvREADONLY(sv)) {
7333 if (IN_PERL_RUNTIME)
7334 Perl_croak(aTHX_ PL_no_modify);
7338 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7340 i = PTR2IV(SvRV(sv));
7345 flags = SvFLAGS(sv);
7346 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7347 /* It's (privately or publicly) a float, but not tested as an
7348 integer, so test it to see. */
7350 flags = SvFLAGS(sv);
7352 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7353 /* It's publicly an integer, or privately an integer-not-float */
7354 #ifdef PERL_PRESERVE_IVUV
7358 if (SvUVX(sv) == UV_MAX)
7359 sv_setnv(sv, UV_MAX_P1);
7361 (void)SvIOK_only_UV(sv);
7362 SvUV_set(sv, SvUVX(sv) + 1);
7364 if (SvIVX(sv) == IV_MAX)
7365 sv_setuv(sv, (UV)IV_MAX + 1);
7367 (void)SvIOK_only(sv);
7368 SvIV_set(sv, SvIVX(sv) + 1);
7373 if (flags & SVp_NOK) {
7374 (void)SvNOK_only(sv);
7375 SvNV_set(sv, SvNVX(sv) + 1.0);
7379 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7380 if ((flags & SVTYPEMASK) < SVt_PVIV)
7381 sv_upgrade(sv, SVt_IV);
7382 (void)SvIOK_only(sv);
7387 while (isALPHA(*d)) d++;
7388 while (isDIGIT(*d)) d++;
7390 #ifdef PERL_PRESERVE_IVUV
7391 /* Got to punt this as an integer if needs be, but we don't issue
7392 warnings. Probably ought to make the sv_iv_please() that does
7393 the conversion if possible, and silently. */
7394 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7395 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7396 /* Need to try really hard to see if it's an integer.
7397 9.22337203685478e+18 is an integer.
7398 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7399 so $a="9.22337203685478e+18"; $a+0; $a++
7400 needs to be the same as $a="9.22337203685478e+18"; $a++
7407 /* sv_2iv *should* have made this an NV */
7408 if (flags & SVp_NOK) {
7409 (void)SvNOK_only(sv);
7410 SvNV_set(sv, SvNVX(sv) + 1.0);
7413 /* I don't think we can get here. Maybe I should assert this
7414 And if we do get here I suspect that sv_setnv will croak. NWC
7416 #if defined(USE_LONG_DOUBLE)
7417 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",
7418 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7420 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7421 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7424 #endif /* PERL_PRESERVE_IVUV */
7425 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7429 while (d >= SvPVX(sv)) {
7437 /* MKS: The original code here died if letters weren't consecutive.
7438 * at least it didn't have to worry about non-C locales. The
7439 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7440 * arranged in order (although not consecutively) and that only
7441 * [A-Za-z] are accepted by isALPHA in the C locale.
7443 if (*d != 'z' && *d != 'Z') {
7444 do { ++*d; } while (!isALPHA(*d));
7447 *(d--) -= 'z' - 'a';
7452 *(d--) -= 'z' - 'a' + 1;
7456 /* oh,oh, the number grew */
7457 SvGROW(sv, SvCUR(sv) + 2);
7458 SvCUR_set(sv, SvCUR(sv) + 1);
7459 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7470 Auto-decrement of the value in the SV, doing string to numeric conversion
7471 if necessary. Handles 'get' magic.
7477 Perl_sv_dec(pTHX_ register SV *sv)
7485 if (SvTHINKFIRST(sv)) {
7487 sv_force_normal_flags(sv, 0);
7488 if (SvREADONLY(sv)) {
7489 if (IN_PERL_RUNTIME)
7490 Perl_croak(aTHX_ PL_no_modify);
7494 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7496 i = PTR2IV(SvRV(sv));
7501 /* Unlike sv_inc we don't have to worry about string-never-numbers
7502 and keeping them magic. But we mustn't warn on punting */
7503 flags = SvFLAGS(sv);
7504 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7505 /* It's publicly an integer, or privately an integer-not-float */
7506 #ifdef PERL_PRESERVE_IVUV
7510 if (SvUVX(sv) == 0) {
7511 (void)SvIOK_only(sv);
7515 (void)SvIOK_only_UV(sv);
7516 SvUV_set(sv, SvUVX(sv) + 1);
7519 if (SvIVX(sv) == IV_MIN)
7520 sv_setnv(sv, (NV)IV_MIN - 1.0);
7522 (void)SvIOK_only(sv);
7523 SvIV_set(sv, SvIVX(sv) - 1);
7528 if (flags & SVp_NOK) {
7529 SvNV_set(sv, SvNVX(sv) - 1.0);
7530 (void)SvNOK_only(sv);
7533 if (!(flags & SVp_POK)) {
7534 if ((flags & SVTYPEMASK) < SVt_PVNV)
7535 sv_upgrade(sv, SVt_NV);
7537 (void)SvNOK_only(sv);
7540 #ifdef PERL_PRESERVE_IVUV
7542 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7543 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7544 /* Need to try really hard to see if it's an integer.
7545 9.22337203685478e+18 is an integer.
7546 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7547 so $a="9.22337203685478e+18"; $a+0; $a--
7548 needs to be the same as $a="9.22337203685478e+18"; $a--
7555 /* sv_2iv *should* have made this an NV */
7556 if (flags & SVp_NOK) {
7557 (void)SvNOK_only(sv);
7558 SvNV_set(sv, SvNVX(sv) - 1.0);
7561 /* I don't think we can get here. Maybe I should assert this
7562 And if we do get here I suspect that sv_setnv will croak. NWC
7564 #if defined(USE_LONG_DOUBLE)
7565 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",
7566 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7568 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7569 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7573 #endif /* PERL_PRESERVE_IVUV */
7574 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7578 =for apidoc sv_mortalcopy
7580 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7581 The new SV is marked as mortal. It will be destroyed "soon", either by an
7582 explicit call to FREETMPS, or by an implicit call at places such as
7583 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7588 /* Make a string that will exist for the duration of the expression
7589 * evaluation. Actually, it may have to last longer than that, but
7590 * hopefully we won't free it until it has been assigned to a
7591 * permanent location. */
7594 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7599 sv_setsv(sv,oldstr);
7601 PL_tmps_stack[++PL_tmps_ix] = sv;
7607 =for apidoc sv_newmortal
7609 Creates a new null SV which is mortal. The reference count of the SV is
7610 set to 1. It will be destroyed "soon", either by an explicit call to
7611 FREETMPS, or by an implicit call at places such as statement boundaries.
7612 See also C<sv_mortalcopy> and C<sv_2mortal>.
7618 Perl_sv_newmortal(pTHX)
7623 SvFLAGS(sv) = SVs_TEMP;
7625 PL_tmps_stack[++PL_tmps_ix] = sv;
7630 =for apidoc sv_2mortal
7632 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7633 by an explicit call to FREETMPS, or by an implicit call at places such as
7634 statement boundaries. SvTEMP() is turned on which means that the SV's
7635 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7636 and C<sv_mortalcopy>.
7642 Perl_sv_2mortal(pTHX_ register SV *sv)
7647 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7650 PL_tmps_stack[++PL_tmps_ix] = sv;
7658 Creates a new SV and copies a string into it. The reference count for the
7659 SV is set to 1. If C<len> is zero, Perl will compute the length using
7660 strlen(). For efficiency, consider using C<newSVpvn> instead.
7666 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7673 sv_setpvn(sv,s,len);
7678 =for apidoc newSVpvn
7680 Creates a new SV and copies a string into it. The reference count for the
7681 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7682 string. You are responsible for ensuring that the source string is at least
7683 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7689 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7694 sv_setpvn(sv,s,len);
7699 =for apidoc newSVpvn_share
7701 Creates a new SV with its SvPVX pointing to a shared string in the string
7702 table. If the string does not already exist in the table, it is created
7703 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7704 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7705 otherwise the hash is computed. The idea here is that as the string table
7706 is used for shared hash keys these strings will have SvPVX == HeKEY and
7707 hash lookup will avoid string compare.
7713 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7716 bool is_utf8 = FALSE;
7718 STRLEN tmplen = -len;
7720 /* See the note in hv.c:hv_fetch() --jhi */
7721 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7725 PERL_HASH(hash, src, len);
7727 sv_upgrade(sv, SVt_PVIV);
7728 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7741 #if defined(PERL_IMPLICIT_CONTEXT)
7743 /* pTHX_ magic can't cope with varargs, so this is a no-context
7744 * version of the main function, (which may itself be aliased to us).
7745 * Don't access this version directly.
7749 Perl_newSVpvf_nocontext(const char* pat, ...)
7754 va_start(args, pat);
7755 sv = vnewSVpvf(pat, &args);
7762 =for apidoc newSVpvf
7764 Creates a new SV and initializes it with the string formatted like
7771 Perl_newSVpvf(pTHX_ const char* pat, ...)
7775 va_start(args, pat);
7776 sv = vnewSVpvf(pat, &args);
7781 /* backend for newSVpvf() and newSVpvf_nocontext() */
7784 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7788 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7795 Creates a new SV and copies a floating point value into it.
7796 The reference count for the SV is set to 1.
7802 Perl_newSVnv(pTHX_ NV n)
7814 Creates a new SV and copies an integer into it. The reference count for the
7821 Perl_newSViv(pTHX_ IV i)
7833 Creates a new SV and copies an unsigned integer into it.
7834 The reference count for the SV is set to 1.
7840 Perl_newSVuv(pTHX_ UV u)
7850 =for apidoc newRV_noinc
7852 Creates an RV wrapper for an SV. The reference count for the original
7853 SV is B<not> incremented.
7859 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7864 sv_upgrade(sv, SVt_RV);
7866 SvRV_set(sv, tmpRef);
7871 /* newRV_inc is the official function name to use now.
7872 * newRV_inc is in fact #defined to newRV in sv.h
7876 Perl_newRV(pTHX_ SV *tmpRef)
7878 return newRV_noinc(SvREFCNT_inc(tmpRef));
7884 Creates a new SV which is an exact duplicate of the original SV.
7891 Perl_newSVsv(pTHX_ register SV *old)
7897 if (SvTYPE(old) == SVTYPEMASK) {
7898 if (ckWARN_d(WARN_INTERNAL))
7899 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7903 /* SV_GMAGIC is the default for sv_setv()
7904 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7905 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7906 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7911 =for apidoc sv_reset
7913 Underlying implementation for the C<reset> Perl function.
7914 Note that the perl-level function is vaguely deprecated.
7920 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7929 char todo[PERL_UCHAR_MAX+1];
7934 if (!*s) { /* reset ?? searches */
7935 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7936 pm->op_pmdynflags &= ~PMdf_USED;
7941 /* reset variables */
7943 if (!HvARRAY(stash))
7946 Zero(todo, 256, char);
7948 i = (unsigned char)*s;
7952 max = (unsigned char)*s++;
7953 for ( ; i <= max; i++) {
7956 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7957 for (entry = HvARRAY(stash)[i];
7959 entry = HeNEXT(entry))
7961 if (!todo[(U8)*HeKEY(entry)])
7963 gv = (GV*)HeVAL(entry);
7965 if (SvTHINKFIRST(sv)) {
7966 if (!SvREADONLY(sv) && SvROK(sv))
7971 if (SvTYPE(sv) >= SVt_PV) {
7973 if (SvPVX(sv) != Nullch)
7980 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7983 #ifdef USE_ENVIRON_ARRAY
7985 # ifdef USE_ITHREADS
7986 && PL_curinterp == aTHX
7990 environ[0] = Nullch;
7993 #endif /* !PERL_MICRO */
8003 Using various gambits, try to get an IO from an SV: the IO slot if its a
8004 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8005 named after the PV if we're a string.
8011 Perl_sv_2io(pTHX_ SV *sv)
8016 switch (SvTYPE(sv)) {
8024 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8028 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8030 return sv_2io(SvRV(sv));
8031 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
8037 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8046 Using various gambits, try to get a CV from an SV; in addition, try if
8047 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8053 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8060 return *gvp = Nullgv, Nullcv;
8061 switch (SvTYPE(sv)) {
8080 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8081 tryAMAGICunDEREF(to_cv);
8084 if (SvTYPE(sv) == SVt_PVCV) {
8093 Perl_croak(aTHX_ "Not a subroutine reference");
8098 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8104 if (lref && !GvCVu(gv)) {
8107 tmpsv = NEWSV(704,0);
8108 gv_efullname3(tmpsv, gv, Nullch);
8109 /* XXX this is probably not what they think they're getting.
8110 * It has the same effect as "sub name;", i.e. just a forward
8112 newSUB(start_subparse(FALSE, 0),
8113 newSVOP(OP_CONST, 0, tmpsv),
8118 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8128 Returns true if the SV has a true value by Perl's rules.
8129 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8130 instead use an in-line version.
8136 Perl_sv_true(pTHX_ register SV *sv)
8141 const register XPV* tXpv;
8142 if ((tXpv = (XPV*)SvANY(sv)) &&
8143 (tXpv->xpv_cur > 1 ||
8144 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8151 return SvIVX(sv) != 0;
8154 return SvNVX(sv) != 0.0;
8156 return sv_2bool(sv);
8164 A private implementation of the C<SvIVx> macro for compilers which can't
8165 cope with complex macro expressions. Always use the macro instead.
8171 Perl_sv_iv(pTHX_ register SV *sv)
8175 return (IV)SvUVX(sv);
8184 A private implementation of the C<SvUVx> macro for compilers which can't
8185 cope with complex macro expressions. Always use the macro instead.
8191 Perl_sv_uv(pTHX_ register SV *sv)
8196 return (UV)SvIVX(sv);
8204 A private implementation of the C<SvNVx> macro for compilers which can't
8205 cope with complex macro expressions. Always use the macro instead.
8211 Perl_sv_nv(pTHX_ register SV *sv)
8218 /* sv_pv() is now a macro using SvPV_nolen();
8219 * this function provided for binary compatibility only
8223 Perl_sv_pv(pTHX_ SV *sv)
8230 return sv_2pv(sv, &n_a);
8236 Use the C<SvPV_nolen> macro instead
8240 A private implementation of the C<SvPV> macro for compilers which can't
8241 cope with complex macro expressions. Always use the macro instead.
8247 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8253 return sv_2pv(sv, lp);
8258 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8264 return sv_2pv_flags(sv, lp, 0);
8267 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8268 * this function provided for binary compatibility only
8272 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8274 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8278 =for apidoc sv_pvn_force
8280 Get a sensible string out of the SV somehow.
8281 A private implementation of the C<SvPV_force> macro for compilers which
8282 can't cope with complex macro expressions. Always use the macro instead.
8284 =for apidoc sv_pvn_force_flags
8286 Get a sensible string out of the SV somehow.
8287 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8288 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8289 implemented in terms of this function.
8290 You normally want to use the various wrapper macros instead: see
8291 C<SvPV_force> and C<SvPV_force_nomg>
8297 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8301 if (SvTHINKFIRST(sv) && !SvROK(sv))
8302 sv_force_normal_flags(sv, 0);
8308 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8309 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8313 s = sv_2pv_flags(sv, lp, flags);
8314 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8319 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8320 SvGROW(sv, len + 1);
8321 Move(s,SvPVX(sv),len,char);
8326 SvPOK_on(sv); /* validate pointer */
8328 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8329 PTR2UV(sv),SvPVX(sv)));
8335 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8336 * this function provided for binary compatibility only
8340 Perl_sv_pvbyte(pTHX_ SV *sv)
8342 sv_utf8_downgrade(sv,0);
8347 =for apidoc sv_pvbyte
8349 Use C<SvPVbyte_nolen> instead.
8351 =for apidoc sv_pvbyten
8353 A private implementation of the C<SvPVbyte> macro for compilers
8354 which can't cope with complex macro expressions. Always use the macro
8361 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8363 sv_utf8_downgrade(sv,0);
8364 return sv_pvn(sv,lp);
8368 =for apidoc sv_pvbyten_force
8370 A private implementation of the C<SvPVbytex_force> macro for compilers
8371 which can't cope with complex macro expressions. Always use the macro
8378 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8380 sv_pvn_force(sv,lp);
8381 sv_utf8_downgrade(sv,0);
8386 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8387 * this function provided for binary compatibility only
8391 Perl_sv_pvutf8(pTHX_ SV *sv)
8393 sv_utf8_upgrade(sv);
8398 =for apidoc sv_pvutf8
8400 Use the C<SvPVutf8_nolen> macro instead
8402 =for apidoc sv_pvutf8n
8404 A private implementation of the C<SvPVutf8> macro for compilers
8405 which can't cope with complex macro expressions. Always use the macro
8412 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8414 sv_utf8_upgrade(sv);
8415 return sv_pvn(sv,lp);
8419 =for apidoc sv_pvutf8n_force
8421 A private implementation of the C<SvPVutf8_force> macro for compilers
8422 which can't cope with complex macro expressions. Always use the macro
8429 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8431 sv_pvn_force(sv,lp);
8432 sv_utf8_upgrade(sv);
8438 =for apidoc sv_reftype
8440 Returns a string describing what the SV is a reference to.
8446 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8448 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8449 inside return suggests a const propagation bug in g++. */
8450 if (ob && SvOBJECT(sv)) {
8451 char *name = HvNAME(SvSTASH(sv));
8452 return name ? name : (char *) "__ANON__";
8455 switch (SvTYPE(sv)) {
8472 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8473 /* tied lvalues should appear to be
8474 * scalars for backwards compatitbility */
8475 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8476 ? "SCALAR" : "LVALUE");
8477 case SVt_PVAV: return "ARRAY";
8478 case SVt_PVHV: return "HASH";
8479 case SVt_PVCV: return "CODE";
8480 case SVt_PVGV: return "GLOB";
8481 case SVt_PVFM: return "FORMAT";
8482 case SVt_PVIO: return "IO";
8483 default: return "UNKNOWN";
8489 =for apidoc sv_isobject
8491 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8492 object. If the SV is not an RV, or if the object is not blessed, then this
8499 Perl_sv_isobject(pTHX_ SV *sv)
8516 Returns a boolean indicating whether the SV is blessed into the specified
8517 class. This does not check for subtypes; use C<sv_derived_from> to verify
8518 an inheritance relationship.
8524 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8535 if (!HvNAME(SvSTASH(sv)))
8538 return strEQ(HvNAME(SvSTASH(sv)), name);
8544 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8545 it will be upgraded to one. If C<classname> is non-null then the new SV will
8546 be blessed in the specified package. The new SV is returned and its
8547 reference count is 1.
8553 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8559 SV_CHECK_THINKFIRST_COW_DROP(rv);
8562 if (SvTYPE(rv) >= SVt_PVMG) {
8563 U32 refcnt = SvREFCNT(rv);
8567 SvREFCNT(rv) = refcnt;
8570 if (SvTYPE(rv) < SVt_RV)
8571 sv_upgrade(rv, SVt_RV);
8572 else if (SvTYPE(rv) > SVt_RV) {
8583 HV* stash = gv_stashpv(classname, TRUE);
8584 (void)sv_bless(rv, stash);
8590 =for apidoc sv_setref_pv
8592 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8593 argument will be upgraded to an RV. That RV will be modified to point to
8594 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8595 into the SV. The C<classname> argument indicates the package for the
8596 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8597 will have a reference count of 1, and the RV will be returned.
8599 Do not use with other Perl types such as HV, AV, SV, CV, because those
8600 objects will become corrupted by the pointer copy process.
8602 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8608 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8611 sv_setsv(rv, &PL_sv_undef);
8615 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8620 =for apidoc sv_setref_iv
8622 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8623 argument will be upgraded to an RV. That RV will be modified to point to
8624 the new SV. The C<classname> argument indicates the package for the
8625 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8626 will have a reference count of 1, and the RV will be returned.
8632 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8634 sv_setiv(newSVrv(rv,classname), iv);
8639 =for apidoc sv_setref_uv
8641 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8642 argument will be upgraded to an RV. That RV will be modified to point to
8643 the new SV. The C<classname> argument indicates the package for the
8644 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8645 will have a reference count of 1, and the RV will be returned.
8651 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8653 sv_setuv(newSVrv(rv,classname), uv);
8658 =for apidoc sv_setref_nv
8660 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8661 argument will be upgraded to an RV. That RV will be modified to point to
8662 the new SV. The C<classname> argument indicates the package for the
8663 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8664 will have a reference count of 1, and the RV will be returned.
8670 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8672 sv_setnv(newSVrv(rv,classname), nv);
8677 =for apidoc sv_setref_pvn
8679 Copies a string into a new SV, optionally blessing the SV. The length of the
8680 string must be specified with C<n>. The C<rv> argument will be upgraded to
8681 an RV. That RV will be modified to point to the new SV. The C<classname>
8682 argument indicates the package for the blessing. Set C<classname> to
8683 C<Nullch> to avoid the blessing. The new SV will have a reference count
8684 of 1, and the RV will be returned.
8686 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8692 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8694 sv_setpvn(newSVrv(rv,classname), pv, n);
8699 =for apidoc sv_bless
8701 Blesses an SV into a specified package. The SV must be an RV. The package
8702 must be designated by its stash (see C<gv_stashpv()>). The reference count
8703 of the SV is unaffected.
8709 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8713 Perl_croak(aTHX_ "Can't bless non-reference value");
8715 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8716 if (SvREADONLY(tmpRef))
8717 Perl_croak(aTHX_ PL_no_modify);
8718 if (SvOBJECT(tmpRef)) {
8719 if (SvTYPE(tmpRef) != SVt_PVIO)
8721 SvREFCNT_dec(SvSTASH(tmpRef));
8724 SvOBJECT_on(tmpRef);
8725 if (SvTYPE(tmpRef) != SVt_PVIO)
8727 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8728 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8735 if(SvSMAGICAL(tmpRef))
8736 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8744 /* Downgrades a PVGV to a PVMG.
8748 S_sv_unglob(pTHX_ SV *sv)
8752 assert(SvTYPE(sv) == SVt_PVGV);
8757 SvREFCNT_dec(GvSTASH(sv));
8758 GvSTASH(sv) = Nullhv;
8760 sv_unmagic(sv, PERL_MAGIC_glob);
8761 Safefree(GvNAME(sv));
8764 /* need to keep SvANY(sv) in the right arena */
8765 xpvmg = new_XPVMG();
8766 StructCopy(SvANY(sv), xpvmg, XPVMG);
8767 del_XPVGV(SvANY(sv));
8770 SvFLAGS(sv) &= ~SVTYPEMASK;
8771 SvFLAGS(sv) |= SVt_PVMG;
8775 =for apidoc sv_unref_flags
8777 Unsets the RV status of the SV, and decrements the reference count of
8778 whatever was being referenced by the RV. This can almost be thought of
8779 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8780 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8781 (otherwise the decrementing is conditional on the reference count being
8782 different from one or the reference being a readonly SV).
8789 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8793 if (SvWEAKREF(sv)) {
8801 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8802 assigned to as BEGIN {$a = \"Foo"} will fail. */
8803 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8805 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8806 sv_2mortal(rv); /* Schedule for freeing later */
8810 =for apidoc sv_unref
8812 Unsets the RV status of the SV, and decrements the reference count of
8813 whatever was being referenced by the RV. This can almost be thought of
8814 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8815 being zero. See C<SvROK_off>.
8821 Perl_sv_unref(pTHX_ SV *sv)
8823 sv_unref_flags(sv, 0);
8827 =for apidoc sv_taint
8829 Taint an SV. Use C<SvTAINTED_on> instead.
8834 Perl_sv_taint(pTHX_ SV *sv)
8836 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8840 =for apidoc sv_untaint
8842 Untaint an SV. Use C<SvTAINTED_off> instead.
8847 Perl_sv_untaint(pTHX_ SV *sv)
8849 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8850 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8857 =for apidoc sv_tainted
8859 Test an SV for taintedness. Use C<SvTAINTED> instead.
8864 Perl_sv_tainted(pTHX_ SV *sv)
8866 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8867 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8868 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8875 =for apidoc sv_setpviv
8877 Copies an integer into the given SV, also updating its string value.
8878 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8884 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8886 char buf[TYPE_CHARS(UV)];
8888 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8890 sv_setpvn(sv, ptr, ebuf - ptr);
8894 =for apidoc sv_setpviv_mg
8896 Like C<sv_setpviv>, but also handles 'set' magic.
8902 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8904 char buf[TYPE_CHARS(UV)];
8906 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8908 sv_setpvn(sv, ptr, ebuf - ptr);
8912 #if defined(PERL_IMPLICIT_CONTEXT)
8914 /* pTHX_ magic can't cope with varargs, so this is a no-context
8915 * version of the main function, (which may itself be aliased to us).
8916 * Don't access this version directly.
8920 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8924 va_start(args, pat);
8925 sv_vsetpvf(sv, pat, &args);
8929 /* pTHX_ magic can't cope with varargs, so this is a no-context
8930 * version of the main function, (which may itself be aliased to us).
8931 * Don't access this version directly.
8935 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8939 va_start(args, pat);
8940 sv_vsetpvf_mg(sv, pat, &args);
8946 =for apidoc sv_setpvf
8948 Works like C<sv_catpvf> but copies the text into the SV instead of
8949 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8955 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8958 va_start(args, pat);
8959 sv_vsetpvf(sv, pat, &args);
8964 =for apidoc sv_vsetpvf
8966 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8967 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8969 Usually used via its frontend C<sv_setpvf>.
8975 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8977 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8981 =for apidoc sv_setpvf_mg
8983 Like C<sv_setpvf>, but also handles 'set' magic.
8989 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8992 va_start(args, pat);
8993 sv_vsetpvf_mg(sv, pat, &args);
8998 =for apidoc sv_vsetpvf_mg
9000 Like C<sv_vsetpvf>, but also handles 'set' magic.
9002 Usually used via its frontend C<sv_setpvf_mg>.
9008 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9010 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9014 #if defined(PERL_IMPLICIT_CONTEXT)
9016 /* pTHX_ magic can't cope with varargs, so this is a no-context
9017 * version of the main function, (which may itself be aliased to us).
9018 * Don't access this version directly.
9022 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
9026 va_start(args, pat);
9027 sv_vcatpvf(sv, pat, &args);
9031 /* pTHX_ magic can't cope with varargs, so this is a no-context
9032 * version of the main function, (which may itself be aliased to us).
9033 * Don't access this version directly.
9037 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9041 va_start(args, pat);
9042 sv_vcatpvf_mg(sv, pat, &args);
9048 =for apidoc sv_catpvf
9050 Processes its arguments like C<sprintf> and appends the formatted
9051 output to an SV. If the appended data contains "wide" characters
9052 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9053 and characters >255 formatted with %c), the original SV might get
9054 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9055 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9056 valid UTF-8; if the original SV was bytes, the pattern should be too.
9061 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9064 va_start(args, pat);
9065 sv_vcatpvf(sv, pat, &args);
9070 =for apidoc sv_vcatpvf
9072 Processes its arguments like C<vsprintf> and appends the formatted output
9073 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9075 Usually used via its frontend C<sv_catpvf>.
9081 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9083 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9087 =for apidoc sv_catpvf_mg
9089 Like C<sv_catpvf>, but also handles 'set' magic.
9095 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9098 va_start(args, pat);
9099 sv_vcatpvf_mg(sv, pat, &args);
9104 =for apidoc sv_vcatpvf_mg
9106 Like C<sv_vcatpvf>, but also handles 'set' magic.
9108 Usually used via its frontend C<sv_catpvf_mg>.
9114 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9116 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9121 =for apidoc sv_vsetpvfn
9123 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9126 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9132 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9134 sv_setpvn(sv, "", 0);
9135 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9138 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9141 S_expect_number(pTHX_ char** pattern)
9144 switch (**pattern) {
9145 case '1': case '2': case '3':
9146 case '4': case '5': case '6':
9147 case '7': case '8': case '9':
9148 while (isDIGIT(**pattern))
9149 var = var * 10 + (*(*pattern)++ - '0');
9153 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9156 F0convert(NV nv, char *endbuf, STRLEN *len)
9167 if (uv & 1 && uv == nv)
9168 uv--; /* Round to even */
9170 unsigned dig = uv % 10;
9183 =for apidoc sv_vcatpvfn
9185 Processes its arguments like C<vsprintf> and appends the formatted output
9186 to an SV. Uses an array of SVs if the C style variable argument list is
9187 missing (NULL). When running with taint checks enabled, indicates via
9188 C<maybe_tainted> if results are untrustworthy (often due to the use of
9191 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9196 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9199 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9206 static const char nullstr[] = "(null)";
9208 bool has_utf8; /* has the result utf8? */
9209 bool pat_utf8; /* the pattern is in utf8? */
9211 /* Times 4: a decimal digit takes more than 3 binary digits.
9212 * NV_DIG: mantissa takes than many decimal digits.
9213 * Plus 32: Playing safe. */
9214 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9215 /* large enough for "%#.#f" --chip */
9216 /* what about long double NVs? --jhi */
9218 has_utf8 = pat_utf8 = DO_UTF8(sv);
9220 /* no matter what, this is a string now */
9221 (void)SvPV_force(sv, origlen);
9223 /* special-case "", "%s", and "%_" */
9226 if (patlen == 2 && pat[0] == '%') {
9230 const char *s = va_arg(*args, char*);
9231 sv_catpv(sv, s ? s : nullstr);
9233 else if (svix < svmax) {
9234 sv_catsv(sv, *svargs);
9235 if (DO_UTF8(*svargs))
9241 argsv = va_arg(*args, SV*);
9242 sv_catsv(sv, argsv);
9247 /* See comment on '_' below */
9252 #ifndef USE_LONG_DOUBLE
9253 /* special-case "%.<number>[gf]" */
9254 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9255 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9256 unsigned digits = 0;
9260 while (*pp >= '0' && *pp <= '9')
9261 digits = 10 * digits + (*pp++ - '0');
9262 if (pp - pat == (int)patlen - 1) {
9266 nv = (NV)va_arg(*args, double);
9267 else if (svix < svmax)
9272 /* Add check for digits != 0 because it seems that some
9273 gconverts are buggy in this case, and we don't yet have
9274 a Configure test for this. */
9275 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9276 /* 0, point, slack */
9277 Gconvert(nv, (int)digits, 0, ebuf);
9279 if (*ebuf) /* May return an empty string for digits==0 */
9282 } else if (!digits) {
9285 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9286 sv_catpvn(sv, p, l);
9292 #endif /* !USE_LONG_DOUBLE */
9294 if (!args && svix < svmax && DO_UTF8(*svargs))
9297 patend = (char*)pat + patlen;
9298 for (p = (char*)pat; p < patend; p = q) {
9301 bool vectorize = FALSE;
9302 bool vectorarg = FALSE;
9303 bool vec_utf8 = FALSE;
9309 bool has_precis = FALSE;
9312 bool is_utf8 = FALSE; /* is this item utf8? */
9313 #ifdef HAS_LDBL_SPRINTF_BUG
9314 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9315 with sfio - Allen <allens@cpan.org> */
9316 bool fix_ldbl_sprintf_bug = FALSE;
9320 U8 utf8buf[UTF8_MAXBYTES+1];
9321 STRLEN esignlen = 0;
9323 char *eptr = Nullch;
9326 U8 *vecstr = Null(U8*);
9333 /* we need a long double target in case HAS_LONG_DOUBLE but
9336 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9344 const char *dotstr = ".";
9345 STRLEN dotstrlen = 1;
9346 I32 efix = 0; /* explicit format parameter index */
9347 I32 ewix = 0; /* explicit width index */
9348 I32 epix = 0; /* explicit precision index */
9349 I32 evix = 0; /* explicit vector index */
9350 bool asterisk = FALSE;
9352 /* echo everything up to the next format specification */
9353 for (q = p; q < patend && *q != '%'; ++q) ;
9355 if (has_utf8 && !pat_utf8)
9356 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9358 sv_catpvn(sv, p, q - p);
9365 We allow format specification elements in this order:
9366 \d+\$ explicit format parameter index
9368 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9369 0 flag (as above): repeated to allow "v02"
9370 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9371 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9373 [%bcdefginopsux_DFOUX] format (mandatory)
9375 if (EXPECT_NUMBER(q, width)) {
9416 if (EXPECT_NUMBER(q, ewix))
9425 if ((vectorarg = asterisk)) {
9437 EXPECT_NUMBER(q, width);
9442 vecsv = va_arg(*args, SV*);
9444 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9445 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9446 dotstr = SvPVx(vecsv, dotstrlen);
9451 vecsv = va_arg(*args, SV*);
9452 vecstr = (U8*)SvPVx(vecsv,veclen);
9453 vec_utf8 = DO_UTF8(vecsv);
9455 else if (efix ? efix <= svmax : svix < svmax) {
9456 vecsv = svargs[efix ? efix-1 : svix++];
9457 vecstr = (U8*)SvPVx(vecsv,veclen);
9458 vec_utf8 = DO_UTF8(vecsv);
9459 /* if this is a version object, we need to return the
9460 * stringified representation (which the SvPVX has
9461 * already done for us), but not vectorize the args
9463 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9465 q++; /* skip past the rest of the %vd format */
9466 eptr = (char *) vecstr;
9467 elen = strlen(eptr);
9480 i = va_arg(*args, int);
9482 i = (ewix ? ewix <= svmax : svix < svmax) ?
9483 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9485 width = (i < 0) ? -i : i;
9495 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9497 /* XXX: todo, support specified precision parameter */
9501 i = va_arg(*args, int);
9503 i = (ewix ? ewix <= svmax : svix < svmax)
9504 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9505 precis = (i < 0) ? 0 : i;
9510 precis = precis * 10 + (*q++ - '0');
9519 case 'I': /* Ix, I32x, and I64x */
9521 if (q[1] == '6' && q[2] == '4') {
9527 if (q[1] == '3' && q[2] == '2') {
9537 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9548 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9549 if (*(q + 1) == 'l') { /* lld, llf */
9574 argsv = (efix ? efix <= svmax : svix < svmax) ?
9575 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9582 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9584 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9586 eptr = (char*)utf8buf;
9587 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9598 if (args && !vectorize) {
9599 eptr = va_arg(*args, char*);
9601 #ifdef MACOS_TRADITIONAL
9602 /* On MacOS, %#s format is used for Pascal strings */
9607 elen = strlen(eptr);
9609 eptr = (char *)nullstr;
9610 elen = sizeof nullstr - 1;
9614 eptr = SvPVx(argsv, elen);
9615 if (DO_UTF8(argsv)) {
9616 if (has_precis && precis < elen) {
9618 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9621 if (width) { /* fudge width (can't fudge elen) */
9622 width += elen - sv_len_utf8(argsv);
9634 * The "%_" hack might have to be changed someday,
9635 * if ISO or ANSI decide to use '_' for something.
9636 * So we keep it hidden from users' code.
9638 if (!args || vectorize)
9640 argsv = va_arg(*args, SV*);
9641 eptr = SvPVx(argsv, elen);
9647 if (has_precis && elen > precis)
9658 goto format_sv; /* %-p -> %_ */
9662 goto format_sv; /* %-Np -> %.N_ */
9665 if (alt || vectorize)
9667 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9685 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9694 esignbuf[esignlen++] = plus;
9698 case 'h': iv = (short)va_arg(*args, int); break;
9699 case 'l': iv = va_arg(*args, long); break;
9700 case 'V': iv = va_arg(*args, IV); break;
9701 default: iv = va_arg(*args, int); break;
9703 case 'q': iv = va_arg(*args, Quad_t); break;
9708 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9710 case 'h': iv = (short)tiv; break;
9711 case 'l': iv = (long)tiv; break;
9713 default: iv = tiv; break;
9715 case 'q': iv = (Quad_t)tiv; break;
9719 if ( !vectorize ) /* we already set uv above */
9724 esignbuf[esignlen++] = plus;
9728 esignbuf[esignlen++] = '-';
9771 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9782 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9783 case 'l': uv = va_arg(*args, unsigned long); break;
9784 case 'V': uv = va_arg(*args, UV); break;
9785 default: uv = va_arg(*args, unsigned); break;
9787 case 'q': uv = va_arg(*args, Uquad_t); break;
9792 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9794 case 'h': uv = (unsigned short)tuv; break;
9795 case 'l': uv = (unsigned long)tuv; break;
9797 default: uv = tuv; break;
9799 case 'q': uv = (Uquad_t)tuv; break;
9805 eptr = ebuf + sizeof ebuf;
9811 p = (char*)((c == 'X')
9812 ? "0123456789ABCDEF" : "0123456789abcdef");
9818 esignbuf[esignlen++] = '0';
9819 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9825 *--eptr = '0' + dig;
9827 if (alt && *eptr != '0')
9833 *--eptr = '0' + dig;
9836 esignbuf[esignlen++] = '0';
9837 esignbuf[esignlen++] = 'b';
9840 default: /* it had better be ten or less */
9843 *--eptr = '0' + dig;
9844 } while (uv /= base);
9847 elen = (ebuf + sizeof ebuf) - eptr;
9850 zeros = precis - elen;
9851 else if (precis == 0 && elen == 1 && *eptr == '0')
9856 /* FLOATING POINT */
9859 c = 'f'; /* maybe %F isn't supported here */
9865 /* This is evil, but floating point is even more evil */
9867 /* for SV-style calling, we can only get NV
9868 for C-style calling, we assume %f is double;
9869 for simplicity we allow any of %Lf, %llf, %qf for long double
9873 #if defined(USE_LONG_DOUBLE)
9877 /* [perl #20339] - we should accept and ignore %lf rather than die */
9881 #if defined(USE_LONG_DOUBLE)
9882 intsize = args ? 0 : 'q';
9886 #if defined(HAS_LONG_DOUBLE)
9895 /* now we need (long double) if intsize == 'q', else (double) */
9896 nv = (args && !vectorize) ?
9897 #if LONG_DOUBLESIZE > DOUBLESIZE
9899 va_arg(*args, long double) :
9900 va_arg(*args, double)
9902 va_arg(*args, double)
9908 if (c != 'e' && c != 'E') {
9910 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9911 will cast our (long double) to (double) */
9912 (void)Perl_frexp(nv, &i);
9913 if (i == PERL_INT_MIN)
9914 Perl_die(aTHX_ "panic: frexp");
9916 need = BIT_DIGITS(i);
9918 need += has_precis ? precis : 6; /* known default */
9923 #ifdef HAS_LDBL_SPRINTF_BUG
9924 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9925 with sfio - Allen <allens@cpan.org> */
9928 # define MY_DBL_MAX DBL_MAX
9929 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9930 # if DOUBLESIZE >= 8
9931 # define MY_DBL_MAX 1.7976931348623157E+308L
9933 # define MY_DBL_MAX 3.40282347E+38L
9937 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9938 # define MY_DBL_MAX_BUG 1L
9940 # define MY_DBL_MAX_BUG MY_DBL_MAX
9944 # define MY_DBL_MIN DBL_MIN
9945 # else /* XXX guessing! -Allen */
9946 # if DOUBLESIZE >= 8
9947 # define MY_DBL_MIN 2.2250738585072014E-308L
9949 # define MY_DBL_MIN 1.17549435E-38L
9953 if ((intsize == 'q') && (c == 'f') &&
9954 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9956 /* it's going to be short enough that
9957 * long double precision is not needed */
9959 if ((nv <= 0L) && (nv >= -0L))
9960 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9962 /* would use Perl_fp_class as a double-check but not
9963 * functional on IRIX - see perl.h comments */
9965 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9966 /* It's within the range that a double can represent */
9967 #if defined(DBL_MAX) && !defined(DBL_MIN)
9968 if ((nv >= ((long double)1/DBL_MAX)) ||
9969 (nv <= (-(long double)1/DBL_MAX)))
9971 fix_ldbl_sprintf_bug = TRUE;
9974 if (fix_ldbl_sprintf_bug == TRUE) {
9984 # undef MY_DBL_MAX_BUG
9987 #endif /* HAS_LDBL_SPRINTF_BUG */
9989 need += 20; /* fudge factor */
9990 if (PL_efloatsize < need) {
9991 Safefree(PL_efloatbuf);
9992 PL_efloatsize = need + 20; /* more fudge */
9993 New(906, PL_efloatbuf, PL_efloatsize, char);
9994 PL_efloatbuf[0] = '\0';
9997 if ( !(width || left || plus || alt) && fill != '0'
9998 && has_precis && intsize != 'q' ) { /* Shortcuts */
9999 /* See earlier comment about buggy Gconvert when digits,
10001 if ( c == 'g' && precis) {
10002 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10003 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
10004 goto float_converted;
10005 } else if ( c == 'f' && !precis) {
10006 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10010 eptr = ebuf + sizeof ebuf;
10013 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10014 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10015 if (intsize == 'q') {
10016 /* Copy the one or more characters in a long double
10017 * format before the 'base' ([efgEFG]) character to
10018 * the format string. */
10019 static char const prifldbl[] = PERL_PRIfldbl;
10020 char const *p = prifldbl + sizeof(prifldbl) - 3;
10021 while (p >= prifldbl) { *--eptr = *p--; }
10026 do { *--eptr = '0' + (base % 10); } while (base /= 10);
10031 do { *--eptr = '0' + (base % 10); } while (base /= 10);
10043 /* No taint. Otherwise we are in the strange situation
10044 * where printf() taints but print($float) doesn't.
10046 #if defined(HAS_LONG_DOUBLE)
10047 if (intsize == 'q')
10048 (void)sprintf(PL_efloatbuf, eptr, nv);
10050 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10052 (void)sprintf(PL_efloatbuf, eptr, nv);
10055 eptr = PL_efloatbuf;
10056 elen = strlen(PL_efloatbuf);
10062 i = SvCUR(sv) - origlen;
10063 if (args && !vectorize) {
10065 case 'h': *(va_arg(*args, short*)) = i; break;
10066 default: *(va_arg(*args, int*)) = i; break;
10067 case 'l': *(va_arg(*args, long*)) = i; break;
10068 case 'V': *(va_arg(*args, IV*)) = i; break;
10070 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10075 sv_setuv_mg(argsv, (UV)i);
10077 continue; /* not "break" */
10083 if (!args && ckWARN(WARN_PRINTF) &&
10084 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10085 SV *msg = sv_newmortal();
10086 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10087 (PL_op->op_type == OP_PRTF) ? "" : "s");
10090 Perl_sv_catpvf(aTHX_ msg,
10091 "\"%%%c\"", c & 0xFF);
10093 Perl_sv_catpvf(aTHX_ msg,
10094 "\"%%\\%03"UVof"\"",
10097 sv_catpv(msg, "end of string");
10098 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10101 /* output mangled stuff ... */
10107 /* ... right here, because formatting flags should not apply */
10108 SvGROW(sv, SvCUR(sv) + elen + 1);
10110 Copy(eptr, p, elen, char);
10113 SvCUR_set(sv, p - SvPVX(sv));
10115 continue; /* not "break" */
10118 /* calculate width before utf8_upgrade changes it */
10119 have = esignlen + zeros + elen;
10121 if (is_utf8 != has_utf8) {
10124 sv_utf8_upgrade(sv);
10127 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10128 sv_utf8_upgrade(nsv);
10132 SvGROW(sv, SvCUR(sv) + elen + 1);
10137 need = (have > width ? have : width);
10140 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10142 if (esignlen && fill == '0') {
10143 for (i = 0; i < (int)esignlen; i++)
10144 *p++ = esignbuf[i];
10146 if (gap && !left) {
10147 memset(p, fill, gap);
10150 if (esignlen && fill != '0') {
10151 for (i = 0; i < (int)esignlen; i++)
10152 *p++ = esignbuf[i];
10155 for (i = zeros; i; i--)
10159 Copy(eptr, p, elen, char);
10163 memset(p, ' ', gap);
10168 Copy(dotstr, p, dotstrlen, char);
10172 vectorize = FALSE; /* done iterating over vecstr */
10179 SvCUR_set(sv, p - SvPVX(sv));
10187 /* =========================================================================
10189 =head1 Cloning an interpreter
10191 All the macros and functions in this section are for the private use of
10192 the main function, perl_clone().
10194 The foo_dup() functions make an exact copy of an existing foo thinngy.
10195 During the course of a cloning, a hash table is used to map old addresses
10196 to new addresses. The table is created and manipulated with the
10197 ptr_table_* functions.
10201 ============================================================================*/
10204 #if defined(USE_ITHREADS)
10206 #ifndef GpREFCNT_inc
10207 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10211 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10212 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10213 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10214 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10215 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10216 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10217 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10218 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10219 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10220 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10221 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10222 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10223 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10226 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10227 regcomp.c. AMS 20010712 */
10230 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10235 struct reg_substr_datum *s;
10238 return (REGEXP *)NULL;
10240 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10243 len = r->offsets[0];
10244 npar = r->nparens+1;
10246 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10247 Copy(r->program, ret->program, len+1, regnode);
10249 New(0, ret->startp, npar, I32);
10250 Copy(r->startp, ret->startp, npar, I32);
10251 New(0, ret->endp, npar, I32);
10252 Copy(r->startp, ret->startp, npar, I32);
10254 New(0, ret->substrs, 1, struct reg_substr_data);
10255 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10256 s->min_offset = r->substrs->data[i].min_offset;
10257 s->max_offset = r->substrs->data[i].max_offset;
10258 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10259 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10262 ret->regstclass = NULL;
10264 struct reg_data *d;
10265 const int count = r->data->count;
10267 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10268 char, struct reg_data);
10269 New(0, d->what, count, U8);
10272 for (i = 0; i < count; i++) {
10273 d->what[i] = r->data->what[i];
10274 switch (d->what[i]) {
10275 /* legal options are one of: sfpont
10276 see also regcomp.h and pregfree() */
10278 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10281 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10284 /* This is cheating. */
10285 New(0, d->data[i], 1, struct regnode_charclass_class);
10286 StructCopy(r->data->data[i], d->data[i],
10287 struct regnode_charclass_class);
10288 ret->regstclass = (regnode*)d->data[i];
10291 /* Compiled op trees are readonly, and can thus be
10292 shared without duplication. */
10294 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10298 d->data[i] = r->data->data[i];
10301 d->data[i] = r->data->data[i];
10303 ((reg_trie_data*)d->data[i])->refcount++;
10307 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10316 New(0, ret->offsets, 2*len+1, U32);
10317 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10319 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10320 ret->refcnt = r->refcnt;
10321 ret->minlen = r->minlen;
10322 ret->prelen = r->prelen;
10323 ret->nparens = r->nparens;
10324 ret->lastparen = r->lastparen;
10325 ret->lastcloseparen = r->lastcloseparen;
10326 ret->reganch = r->reganch;
10328 ret->sublen = r->sublen;
10330 if (RX_MATCH_COPIED(ret))
10331 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10333 ret->subbeg = Nullch;
10334 #ifdef PERL_COPY_ON_WRITE
10335 ret->saved_copy = Nullsv;
10338 ptr_table_store(PL_ptr_table, r, ret);
10342 /* duplicate a file handle */
10345 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10351 return (PerlIO*)NULL;
10353 /* look for it in the table first */
10354 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10358 /* create anew and remember what it is */
10359 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10360 ptr_table_store(PL_ptr_table, fp, ret);
10364 /* duplicate a directory handle */
10367 Perl_dirp_dup(pTHX_ DIR *dp)
10375 /* duplicate a typeglob */
10378 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10383 /* look for it in the table first */
10384 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10388 /* create anew and remember what it is */
10389 Newz(0, ret, 1, GP);
10390 ptr_table_store(PL_ptr_table, gp, ret);
10393 ret->gp_refcnt = 0; /* must be before any other dups! */
10394 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10395 ret->gp_io = io_dup_inc(gp->gp_io, param);
10396 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10397 ret->gp_av = av_dup_inc(gp->gp_av, param);
10398 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10399 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10400 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10401 ret->gp_cvgen = gp->gp_cvgen;
10402 ret->gp_flags = gp->gp_flags;
10403 ret->gp_line = gp->gp_line;
10404 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10408 /* duplicate a chain of magic */
10411 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10413 MAGIC *mgprev = (MAGIC*)NULL;
10416 return (MAGIC*)NULL;
10417 /* look for it in the table first */
10418 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10422 for (; mg; mg = mg->mg_moremagic) {
10424 Newz(0, nmg, 1, MAGIC);
10426 mgprev->mg_moremagic = nmg;
10429 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10430 nmg->mg_private = mg->mg_private;
10431 nmg->mg_type = mg->mg_type;
10432 nmg->mg_flags = mg->mg_flags;
10433 if (mg->mg_type == PERL_MAGIC_qr) {
10434 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10436 else if(mg->mg_type == PERL_MAGIC_backref) {
10437 const AV * const av = (AV*) mg->mg_obj;
10440 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10442 for (i = AvFILLp(av); i >= 0; i--) {
10443 if (!svp[i]) continue;
10444 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10448 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10449 ? sv_dup_inc(mg->mg_obj, param)
10450 : sv_dup(mg->mg_obj, param);
10452 nmg->mg_len = mg->mg_len;
10453 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10454 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10455 if (mg->mg_len > 0) {
10456 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10457 if (mg->mg_type == PERL_MAGIC_overload_table &&
10458 AMT_AMAGIC((AMT*)mg->mg_ptr))
10460 AMT *amtp = (AMT*)mg->mg_ptr;
10461 AMT *namtp = (AMT*)nmg->mg_ptr;
10463 for (i = 1; i < NofAMmeth; i++) {
10464 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10468 else if (mg->mg_len == HEf_SVKEY)
10469 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10471 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10472 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10479 /* create a new pointer-mapping table */
10482 Perl_ptr_table_new(pTHX)
10485 Newz(0, tbl, 1, PTR_TBL_t);
10486 tbl->tbl_max = 511;
10487 tbl->tbl_items = 0;
10488 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10493 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10495 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10503 struct ptr_tbl_ent* pte;
10504 struct ptr_tbl_ent* pteend;
10505 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10506 pte->next = PL_pte_arenaroot;
10507 PL_pte_arenaroot = pte;
10509 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
10510 PL_pte_root = ++pte;
10511 while (pte < pteend) {
10512 pte->next = pte + 1;
10518 STATIC struct ptr_tbl_ent*
10521 struct ptr_tbl_ent* pte;
10525 PL_pte_root = pte->next;
10530 S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10532 p->next = PL_pte_root;
10536 /* map an existing pointer using a table */
10539 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10541 PTR_TBL_ENT_t *tblent;
10542 const UV hash = PTR_TABLE_HASH(sv);
10544 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10545 for (; tblent; tblent = tblent->next) {
10546 if (tblent->oldval == sv)
10547 return tblent->newval;
10549 return (void*)NULL;
10552 /* add a new entry to a pointer-mapping table */
10555 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10557 PTR_TBL_ENT_t *tblent, **otblent;
10558 /* XXX this may be pessimal on platforms where pointers aren't good
10559 * hash values e.g. if they grow faster in the most significant
10561 const UV hash = PTR_TABLE_HASH(oldv);
10565 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10566 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10567 if (tblent->oldval == oldv) {
10568 tblent->newval = newv;
10572 tblent = S_new_pte(aTHX);
10573 tblent->oldval = oldv;
10574 tblent->newval = newv;
10575 tblent->next = *otblent;
10578 if (!empty && tbl->tbl_items > tbl->tbl_max)
10579 ptr_table_split(tbl);
10582 /* double the hash bucket size of an existing ptr table */
10585 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10587 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10588 const UV oldsize = tbl->tbl_max + 1;
10589 UV newsize = oldsize * 2;
10592 Renew(ary, newsize, PTR_TBL_ENT_t*);
10593 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10594 tbl->tbl_max = --newsize;
10595 tbl->tbl_ary = ary;
10596 for (i=0; i < oldsize; i++, ary++) {
10597 PTR_TBL_ENT_t **curentp, **entp, *ent;
10600 curentp = ary + oldsize;
10601 for (entp = ary, ent = *ary; ent; ent = *entp) {
10602 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10604 ent->next = *curentp;
10614 /* remove all the entries from a ptr table */
10617 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10619 register PTR_TBL_ENT_t **array;
10620 register PTR_TBL_ENT_t *entry;
10624 if (!tbl || !tbl->tbl_items) {
10628 array = tbl->tbl_ary;
10630 max = tbl->tbl_max;
10634 PTR_TBL_ENT_t *oentry = entry;
10635 entry = entry->next;
10636 S_del_pte(aTHX_ oentry);
10639 if (++riter > max) {
10642 entry = array[riter];
10646 tbl->tbl_items = 0;
10649 /* clear and free a ptr table */
10652 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10657 ptr_table_clear(tbl);
10658 Safefree(tbl->tbl_ary);
10662 /* attempt to make everything in the typeglob readonly */
10665 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10667 GV *gv = (GV*)sstr;
10668 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10670 if (GvIO(gv) || GvFORM(gv)) {
10671 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10673 else if (!GvCV(gv)) {
10674 GvCV(gv) = (CV*)sv;
10677 /* CvPADLISTs cannot be shared */
10678 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10683 if (!GvUNIQUE(gv)) {
10685 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10686 HvNAME(GvSTASH(gv)), GvNAME(gv));
10692 * write attempts will die with
10693 * "Modification of a read-only value attempted"
10699 SvREADONLY_on(GvSV(gv));
10703 GvAV(gv) = (AV*)sv;
10706 SvREADONLY_on(GvAV(gv));
10710 GvHV(gv) = (HV*)sv;
10713 SvREADONLY_on(GvHV(gv));
10716 return sstr; /* he_dup() will SvREFCNT_inc() */
10719 /* duplicate an SV of any type (including AV, HV etc) */
10722 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10725 SvRV_set(dstr, SvWEAKREF(sstr)
10726 ? sv_dup(SvRV(sstr), param)
10727 : sv_dup_inc(SvRV(sstr), param));
10730 else if (SvPVX(sstr)) {
10731 /* Has something there */
10733 /* Normal PV - clone whole allocated space */
10734 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1));
10735 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10736 /* Not that normal - actually sstr is copy on write.
10737 But we are a true, independant SV, so: */
10738 SvREADONLY_off(dstr);
10743 /* Special case - not normally malloced for some reason */
10744 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10745 /* A "shared" PV - clone it as unshared string */
10746 if(SvPADTMP(sstr)) {
10747 /* However, some of them live in the pad
10748 and they should not have these flags
10751 SvPV_set(dstr, sharepvn(SvPVX(sstr), SvCUR(sstr),
10753 SvUV_set(dstr, SvUVX(sstr));
10756 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvCUR(sstr)));
10758 SvREADONLY_off(dstr);
10762 /* Some other special case - random pointer */
10763 SvPV_set(dstr, SvPVX(sstr));
10768 /* Copy the Null */
10769 if (SvTYPE(dstr) == SVt_RV)
10770 SvRV_set(dstr, NULL);
10777 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10782 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10784 /* look for it in the table first */
10785 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10789 if(param->flags & CLONEf_JOIN_IN) {
10790 /** We are joining here so we don't want do clone
10791 something that is bad **/
10793 if(SvTYPE(sstr) == SVt_PVHV &&
10795 /** don't clone stashes if they already exist **/
10796 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10797 return (SV*) old_stash;
10801 /* create anew and remember what it is */
10804 #ifdef DEBUG_LEAKING_SCALARS
10805 dstr->sv_debug_optype = sstr->sv_debug_optype;
10806 dstr->sv_debug_line = sstr->sv_debug_line;
10807 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10808 dstr->sv_debug_cloned = 1;
10810 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10812 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10816 ptr_table_store(PL_ptr_table, sstr, dstr);
10819 SvFLAGS(dstr) = SvFLAGS(sstr);
10820 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10821 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10824 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10825 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10826 PL_watch_pvx, SvPVX(sstr));
10829 /* don't clone objects whose class has asked us not to */
10830 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10831 SvFLAGS(dstr) &= ~SVTYPEMASK;
10832 SvOBJECT_off(dstr);
10836 switch (SvTYPE(sstr)) {
10838 SvANY(dstr) = NULL;
10841 SvANY(dstr) = new_XIV();
10842 SvIV_set(dstr, SvIVX(sstr));
10845 SvANY(dstr) = new_XNV();
10846 SvNV_set(dstr, SvNVX(sstr));
10849 SvANY(dstr) = new_XRV();
10850 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10853 SvANY(dstr) = new_XPV();
10854 SvCUR_set(dstr, SvCUR(sstr));
10855 SvLEN_set(dstr, SvLEN(sstr));
10856 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10859 SvANY(dstr) = new_XPVIV();
10860 SvCUR_set(dstr, SvCUR(sstr));
10861 SvLEN_set(dstr, SvLEN(sstr));
10862 SvIV_set(dstr, SvIVX(sstr));
10863 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10866 SvANY(dstr) = new_XPVNV();
10867 SvCUR_set(dstr, SvCUR(sstr));
10868 SvLEN_set(dstr, SvLEN(sstr));
10869 SvIV_set(dstr, SvIVX(sstr));
10870 SvNV_set(dstr, SvNVX(sstr));
10871 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10874 SvANY(dstr) = new_XPVMG();
10875 SvCUR_set(dstr, SvCUR(sstr));
10876 SvLEN_set(dstr, SvLEN(sstr));
10877 SvIV_set(dstr, SvIVX(sstr));
10878 SvNV_set(dstr, SvNVX(sstr));
10879 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10880 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10881 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10884 SvANY(dstr) = new_XPVBM();
10885 SvCUR_set(dstr, SvCUR(sstr));
10886 SvLEN_set(dstr, SvLEN(sstr));
10887 SvIV_set(dstr, SvIVX(sstr));
10888 SvNV_set(dstr, SvNVX(sstr));
10889 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10890 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10891 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10892 BmRARE(dstr) = BmRARE(sstr);
10893 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10894 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10897 SvANY(dstr) = new_XPVLV();
10898 SvCUR_set(dstr, SvCUR(sstr));
10899 SvLEN_set(dstr, SvLEN(sstr));
10900 SvIV_set(dstr, SvIVX(sstr));
10901 SvNV_set(dstr, SvNVX(sstr));
10902 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10903 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10904 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10905 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10906 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10907 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10908 LvTARG(dstr) = dstr;
10909 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10910 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10912 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10913 LvTYPE(dstr) = LvTYPE(sstr);
10916 if (GvUNIQUE((GV*)sstr)) {
10918 if ((share = gv_share(sstr, param))) {
10921 ptr_table_store(PL_ptr_table, sstr, dstr);
10923 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10924 HvNAME(GvSTASH(share)), GvNAME(share));
10929 SvANY(dstr) = new_XPVGV();
10930 SvCUR_set(dstr, SvCUR(sstr));
10931 SvLEN_set(dstr, SvLEN(sstr));
10932 SvIV_set(dstr, SvIVX(sstr));
10933 SvNV_set(dstr, SvNVX(sstr));
10934 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10935 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10936 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10937 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10938 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10939 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10940 GvFLAGS(dstr) = GvFLAGS(sstr);
10941 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10942 (void)GpREFCNT_inc(GvGP(dstr));
10945 SvANY(dstr) = new_XPVIO();
10946 SvCUR_set(dstr, SvCUR(sstr));
10947 SvLEN_set(dstr, SvLEN(sstr));
10948 SvIV_set(dstr, SvIVX(sstr));
10949 SvNV_set(dstr, SvNVX(sstr));
10950 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10951 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10952 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10953 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10954 if (IoOFP(sstr) == IoIFP(sstr))
10955 IoOFP(dstr) = IoIFP(dstr);
10957 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10958 /* PL_rsfp_filters entries have fake IoDIRP() */
10959 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10960 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10962 IoDIRP(dstr) = IoDIRP(sstr);
10963 IoLINES(dstr) = IoLINES(sstr);
10964 IoPAGE(dstr) = IoPAGE(sstr);
10965 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10966 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10967 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10968 /* I have no idea why fake dirp (rsfps)
10969 should be treaded differently but otherwise
10970 we end up with leaks -- sky*/
10971 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10972 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10973 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10975 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10976 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10977 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10979 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10980 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10981 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10982 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10983 IoTYPE(dstr) = IoTYPE(sstr);
10984 IoFLAGS(dstr) = IoFLAGS(sstr);
10987 SvANY(dstr) = new_XPVAV();
10988 SvCUR_set(dstr, SvCUR(sstr));
10989 SvLEN_set(dstr, SvLEN(sstr));
10990 SvIV_set(dstr, SvIVX(sstr));
10991 SvNV_set(dstr, SvNVX(sstr));
10992 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10993 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10994 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10995 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10996 if (AvARRAY((AV*)sstr)) {
10997 SV **dst_ary, **src_ary;
10998 SSize_t items = AvFILLp((AV*)sstr) + 1;
11000 src_ary = AvARRAY((AV*)sstr);
11001 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
11002 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
11003 SvPV_set(dstr, (char*)dst_ary);
11004 AvALLOC((AV*)dstr) = dst_ary;
11005 if (AvREAL((AV*)sstr)) {
11006 while (items-- > 0)
11007 *dst_ary++ = sv_dup_inc(*src_ary++, param);
11010 while (items-- > 0)
11011 *dst_ary++ = sv_dup(*src_ary++, param);
11013 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
11014 while (items-- > 0) {
11015 *dst_ary++ = &PL_sv_undef;
11019 SvPV_set(dstr, Nullch);
11020 AvALLOC((AV*)dstr) = (SV**)NULL;
11024 SvANY(dstr) = new_XPVHV();
11025 SvCUR_set(dstr, SvCUR(sstr));
11026 SvLEN_set(dstr, SvLEN(sstr));
11027 SvIV_set(dstr, SvIVX(sstr));
11028 SvNV_set(dstr, SvNVX(sstr));
11029 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11030 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11031 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
11032 if (HvARRAY((HV*)sstr)) {
11034 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
11035 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
11036 Newz(0, dxhv->xhv_array,
11037 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
11038 while (i <= sxhv->xhv_max) {
11039 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
11040 (bool)!!HvSHAREKEYS(sstr),
11044 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
11045 (bool)!!HvSHAREKEYS(sstr), param);
11048 SvPV_set(dstr, Nullch);
11049 HvEITER((HV*)dstr) = (HE*)NULL;
11051 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
11052 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
11053 /* Record stashes for possible cloning in Perl_clone(). */
11054 if(HvNAME((HV*)dstr))
11055 av_push(param->stashes, dstr);
11058 SvANY(dstr) = new_XPVFM();
11059 FmLINES(dstr) = FmLINES(sstr);
11063 SvANY(dstr) = new_XPVCV();
11065 SvCUR_set(dstr, SvCUR(sstr));
11066 SvLEN_set(dstr, SvLEN(sstr));
11067 SvIV_set(dstr, SvIVX(sstr));
11068 SvNV_set(dstr, SvNVX(sstr));
11069 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11070 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
11071 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11072 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
11073 CvSTART(dstr) = CvSTART(sstr);
11075 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
11077 CvXSUB(dstr) = CvXSUB(sstr);
11078 CvXSUBANY(dstr) = CvXSUBANY(sstr);
11079 if (CvCONST(sstr)) {
11080 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11081 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
11082 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
11084 /* don't dup if copying back - CvGV isn't refcounted, so the
11085 * duped GV may never be freed. A bit of a hack! DAPM */
11086 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11087 Nullgv : gv_dup(CvGV(sstr), param) ;
11088 if (param->flags & CLONEf_COPY_STACKS) {
11089 CvDEPTH(dstr) = CvDEPTH(sstr);
11093 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11094 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11096 CvWEAKOUTSIDE(sstr)
11097 ? cv_dup( CvOUTSIDE(sstr), param)
11098 : cv_dup_inc(CvOUTSIDE(sstr), param);
11099 CvFLAGS(dstr) = CvFLAGS(sstr);
11100 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11103 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11107 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11113 /* duplicate a context */
11116 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11118 PERL_CONTEXT *ncxs;
11121 return (PERL_CONTEXT*)NULL;
11123 /* look for it in the table first */
11124 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11128 /* create anew and remember what it is */
11129 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11130 ptr_table_store(PL_ptr_table, cxs, ncxs);
11133 PERL_CONTEXT *cx = &cxs[ix];
11134 PERL_CONTEXT *ncx = &ncxs[ix];
11135 ncx->cx_type = cx->cx_type;
11136 if (CxTYPE(cx) == CXt_SUBST) {
11137 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11140 ncx->blk_oldsp = cx->blk_oldsp;
11141 ncx->blk_oldcop = cx->blk_oldcop;
11142 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11143 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11144 ncx->blk_oldpm = cx->blk_oldpm;
11145 ncx->blk_gimme = cx->blk_gimme;
11146 switch (CxTYPE(cx)) {
11148 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11149 ? cv_dup_inc(cx->blk_sub.cv, param)
11150 : cv_dup(cx->blk_sub.cv,param));
11151 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11152 ? av_dup_inc(cx->blk_sub.argarray, param)
11154 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11155 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11156 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11157 ncx->blk_sub.lval = cx->blk_sub.lval;
11158 ncx->blk_sub.retop = cx->blk_sub.retop;
11161 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11162 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11163 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11164 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11165 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11166 ncx->blk_eval.retop = cx->blk_eval.retop;
11169 ncx->blk_loop.label = cx->blk_loop.label;
11170 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11171 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11172 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11173 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11174 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11175 ? cx->blk_loop.iterdata
11176 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11177 ncx->blk_loop.oldcomppad
11178 = (PAD*)ptr_table_fetch(PL_ptr_table,
11179 cx->blk_loop.oldcomppad);
11180 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11181 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11182 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11183 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11184 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11187 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11188 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11189 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11190 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11191 ncx->blk_sub.retop = cx->blk_sub.retop;
11203 /* duplicate a stack info structure */
11206 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11211 return (PERL_SI*)NULL;
11213 /* look for it in the table first */
11214 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11218 /* create anew and remember what it is */
11219 Newz(56, nsi, 1, PERL_SI);
11220 ptr_table_store(PL_ptr_table, si, nsi);
11222 nsi->si_stack = av_dup_inc(si->si_stack, param);
11223 nsi->si_cxix = si->si_cxix;
11224 nsi->si_cxmax = si->si_cxmax;
11225 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11226 nsi->si_type = si->si_type;
11227 nsi->si_prev = si_dup(si->si_prev, param);
11228 nsi->si_next = si_dup(si->si_next, param);
11229 nsi->si_markoff = si->si_markoff;
11234 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11235 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11236 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11237 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11238 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11239 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11240 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11241 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11242 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11243 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11244 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11245 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11246 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11247 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11250 #define pv_dup_inc(p) SAVEPV(p)
11251 #define pv_dup(p) SAVEPV(p)
11252 #define svp_dup_inc(p,pp) any_dup(p,pp)
11254 /* map any object to the new equivent - either something in the
11255 * ptr table, or something in the interpreter structure
11259 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11264 return (void*)NULL;
11266 /* look for it in the table first */
11267 ret = ptr_table_fetch(PL_ptr_table, v);
11271 /* see if it is part of the interpreter structure */
11272 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11273 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11281 /* duplicate the save stack */
11284 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11286 ANY *ss = proto_perl->Tsavestack;
11287 I32 ix = proto_perl->Tsavestack_ix;
11288 I32 max = proto_perl->Tsavestack_max;
11301 void (*dptr) (void*);
11302 void (*dxptr) (pTHX_ void*);
11305 Newz(54, nss, max, ANY);
11309 TOPINT(nss,ix) = i;
11311 case SAVEt_ITEM: /* normal string */
11312 sv = (SV*)POPPTR(ss,ix);
11313 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11314 sv = (SV*)POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11317 case SAVEt_SV: /* scalar reference */
11318 sv = (SV*)POPPTR(ss,ix);
11319 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11320 gv = (GV*)POPPTR(ss,ix);
11321 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11323 case SAVEt_GENERIC_PVREF: /* generic char* */
11324 c = (char*)POPPTR(ss,ix);
11325 TOPPTR(nss,ix) = pv_dup(c);
11326 ptr = POPPTR(ss,ix);
11327 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11329 case SAVEt_SHARED_PVREF: /* char* in shared space */
11330 c = (char*)POPPTR(ss,ix);
11331 TOPPTR(nss,ix) = savesharedpv(c);
11332 ptr = POPPTR(ss,ix);
11333 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11335 case SAVEt_GENERIC_SVREF: /* generic sv */
11336 case SAVEt_SVREF: /* scalar reference */
11337 sv = (SV*)POPPTR(ss,ix);
11338 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11339 ptr = POPPTR(ss,ix);
11340 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11342 case SAVEt_AV: /* array reference */
11343 av = (AV*)POPPTR(ss,ix);
11344 TOPPTR(nss,ix) = av_dup_inc(av, param);
11345 gv = (GV*)POPPTR(ss,ix);
11346 TOPPTR(nss,ix) = gv_dup(gv, param);
11348 case SAVEt_HV: /* hash reference */
11349 hv = (HV*)POPPTR(ss,ix);
11350 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11351 gv = (GV*)POPPTR(ss,ix);
11352 TOPPTR(nss,ix) = gv_dup(gv, param);
11354 case SAVEt_INT: /* int reference */
11355 ptr = POPPTR(ss,ix);
11356 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11357 intval = (int)POPINT(ss,ix);
11358 TOPINT(nss,ix) = intval;
11360 case SAVEt_LONG: /* long reference */
11361 ptr = POPPTR(ss,ix);
11362 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11363 longval = (long)POPLONG(ss,ix);
11364 TOPLONG(nss,ix) = longval;
11366 case SAVEt_I32: /* I32 reference */
11367 case SAVEt_I16: /* I16 reference */
11368 case SAVEt_I8: /* I8 reference */
11369 ptr = POPPTR(ss,ix);
11370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11372 TOPINT(nss,ix) = i;
11374 case SAVEt_IV: /* IV reference */
11375 ptr = POPPTR(ss,ix);
11376 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11378 TOPIV(nss,ix) = iv;
11380 case SAVEt_SPTR: /* SV* reference */
11381 ptr = POPPTR(ss,ix);
11382 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11383 sv = (SV*)POPPTR(ss,ix);
11384 TOPPTR(nss,ix) = sv_dup(sv, param);
11386 case SAVEt_VPTR: /* random* reference */
11387 ptr = POPPTR(ss,ix);
11388 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11389 ptr = POPPTR(ss,ix);
11390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11392 case SAVEt_PPTR: /* char* reference */
11393 ptr = POPPTR(ss,ix);
11394 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11395 c = (char*)POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = pv_dup(c);
11398 case SAVEt_HPTR: /* HV* reference */
11399 ptr = POPPTR(ss,ix);
11400 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11401 hv = (HV*)POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = hv_dup(hv, param);
11404 case SAVEt_APTR: /* AV* reference */
11405 ptr = POPPTR(ss,ix);
11406 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11407 av = (AV*)POPPTR(ss,ix);
11408 TOPPTR(nss,ix) = av_dup(av, param);
11411 gv = (GV*)POPPTR(ss,ix);
11412 TOPPTR(nss,ix) = gv_dup(gv, param);
11414 case SAVEt_GP: /* scalar reference */
11415 gp = (GP*)POPPTR(ss,ix);
11416 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11417 (void)GpREFCNT_inc(gp);
11418 gv = (GV*)POPPTR(ss,ix);
11419 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11420 c = (char*)POPPTR(ss,ix);
11421 TOPPTR(nss,ix) = pv_dup(c);
11423 TOPIV(nss,ix) = iv;
11425 TOPIV(nss,ix) = iv;
11428 case SAVEt_MORTALIZESV:
11429 sv = (SV*)POPPTR(ss,ix);
11430 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11433 ptr = POPPTR(ss,ix);
11434 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11435 /* these are assumed to be refcounted properly */
11436 switch (((OP*)ptr)->op_type) {
11438 case OP_LEAVESUBLV:
11442 case OP_LEAVEWRITE:
11443 TOPPTR(nss,ix) = ptr;
11448 TOPPTR(nss,ix) = Nullop;
11453 TOPPTR(nss,ix) = Nullop;
11456 c = (char*)POPPTR(ss,ix);
11457 TOPPTR(nss,ix) = pv_dup_inc(c);
11459 case SAVEt_CLEARSV:
11460 longval = POPLONG(ss,ix);
11461 TOPLONG(nss,ix) = longval;
11464 hv = (HV*)POPPTR(ss,ix);
11465 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11466 c = (char*)POPPTR(ss,ix);
11467 TOPPTR(nss,ix) = pv_dup_inc(c);
11469 TOPINT(nss,ix) = i;
11471 case SAVEt_DESTRUCTOR:
11472 ptr = POPPTR(ss,ix);
11473 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11474 dptr = POPDPTR(ss,ix);
11475 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11477 case SAVEt_DESTRUCTOR_X:
11478 ptr = POPPTR(ss,ix);
11479 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11480 dxptr = POPDXPTR(ss,ix);
11481 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11483 case SAVEt_REGCONTEXT:
11486 TOPINT(nss,ix) = i;
11489 case SAVEt_STACK_POS: /* Position on Perl stack */
11491 TOPINT(nss,ix) = i;
11493 case SAVEt_AELEM: /* array element */
11494 sv = (SV*)POPPTR(ss,ix);
11495 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11497 TOPINT(nss,ix) = i;
11498 av = (AV*)POPPTR(ss,ix);
11499 TOPPTR(nss,ix) = av_dup_inc(av, param);
11501 case SAVEt_HELEM: /* hash element */
11502 sv = (SV*)POPPTR(ss,ix);
11503 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11504 sv = (SV*)POPPTR(ss,ix);
11505 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11506 hv = (HV*)POPPTR(ss,ix);
11507 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11510 ptr = POPPTR(ss,ix);
11511 TOPPTR(nss,ix) = ptr;
11515 TOPINT(nss,ix) = i;
11517 case SAVEt_COMPPAD:
11518 av = (AV*)POPPTR(ss,ix);
11519 TOPPTR(nss,ix) = av_dup(av, param);
11522 longval = (long)POPLONG(ss,ix);
11523 TOPLONG(nss,ix) = longval;
11524 ptr = POPPTR(ss,ix);
11525 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11526 sv = (SV*)POPPTR(ss,ix);
11527 TOPPTR(nss,ix) = sv_dup(sv, param);
11530 ptr = POPPTR(ss,ix);
11531 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11532 longval = (long)POPBOOL(ss,ix);
11533 TOPBOOL(nss,ix) = (bool)longval;
11535 case SAVEt_SET_SVFLAGS:
11537 TOPINT(nss,ix) = i;
11539 TOPINT(nss,ix) = i;
11540 sv = (SV*)POPPTR(ss,ix);
11541 TOPPTR(nss,ix) = sv_dup(sv, param);
11544 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11552 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11553 * flag to the result. This is done for each stash before cloning starts,
11554 * so we know which stashes want their objects cloned */
11557 do_mark_cloneable_stash(pTHX_ SV *sv)
11559 if (HvNAME((HV*)sv)) {
11560 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11561 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11562 if (cloner && GvCV(cloner)) {
11569 XPUSHs(sv_2mortal(newSVpv(HvNAME((HV*)sv), 0)));
11571 call_sv((SV*)GvCV(cloner), G_SCALAR);
11578 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11586 =for apidoc perl_clone
11588 Create and return a new interpreter by cloning the current one.
11590 perl_clone takes these flags as parameters:
11592 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11593 without it we only clone the data and zero the stacks,
11594 with it we copy the stacks and the new perl interpreter is
11595 ready to run at the exact same point as the previous one.
11596 The pseudo-fork code uses COPY_STACKS while the
11597 threads->new doesn't.
11599 CLONEf_KEEP_PTR_TABLE
11600 perl_clone keeps a ptr_table with the pointer of the old
11601 variable as a key and the new variable as a value,
11602 this allows it to check if something has been cloned and not
11603 clone it again but rather just use the value and increase the
11604 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11605 the ptr_table using the function
11606 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11607 reason to keep it around is if you want to dup some of your own
11608 variable who are outside the graph perl scans, example of this
11609 code is in threads.xs create
11612 This is a win32 thing, it is ignored on unix, it tells perls
11613 win32host code (which is c++) to clone itself, this is needed on
11614 win32 if you want to run two threads at the same time,
11615 if you just want to do some stuff in a separate perl interpreter
11616 and then throw it away and return to the original one,
11617 you don't need to do anything.
11622 /* XXX the above needs expanding by someone who actually understands it ! */
11623 EXTERN_C PerlInterpreter *
11624 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11627 perl_clone(PerlInterpreter *proto_perl, UV flags)
11630 #ifdef PERL_IMPLICIT_SYS
11632 /* perlhost.h so we need to call into it
11633 to clone the host, CPerlHost should have a c interface, sky */
11635 if (flags & CLONEf_CLONE_HOST) {
11636 return perl_clone_host(proto_perl,flags);
11638 return perl_clone_using(proto_perl, flags,
11640 proto_perl->IMemShared,
11641 proto_perl->IMemParse,
11643 proto_perl->IStdIO,
11647 proto_perl->IProc);
11651 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11652 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11653 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11654 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11655 struct IPerlDir* ipD, struct IPerlSock* ipS,
11656 struct IPerlProc* ipP)
11658 /* XXX many of the string copies here can be optimized if they're
11659 * constants; they need to be allocated as common memory and just
11660 * their pointers copied. */
11663 CLONE_PARAMS clone_params;
11664 CLONE_PARAMS* param = &clone_params;
11666 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11667 /* for each stash, determine whether its objects should be cloned */
11668 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11669 PERL_SET_THX(my_perl);
11672 Poison(my_perl, 1, PerlInterpreter);
11674 PL_curcop = (COP *)Nullop;
11678 PL_savestack_ix = 0;
11679 PL_savestack_max = -1;
11680 PL_sig_pending = 0;
11681 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11682 # else /* !DEBUGGING */
11683 Zero(my_perl, 1, PerlInterpreter);
11684 # endif /* DEBUGGING */
11686 /* host pointers */
11688 PL_MemShared = ipMS;
11689 PL_MemParse = ipMP;
11696 #else /* !PERL_IMPLICIT_SYS */
11698 CLONE_PARAMS clone_params;
11699 CLONE_PARAMS* param = &clone_params;
11700 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11701 /* for each stash, determine whether its objects should be cloned */
11702 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11703 PERL_SET_THX(my_perl);
11706 Poison(my_perl, 1, PerlInterpreter);
11708 PL_curcop = (COP *)Nullop;
11712 PL_savestack_ix = 0;
11713 PL_savestack_max = -1;
11714 PL_sig_pending = 0;
11715 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11716 # else /* !DEBUGGING */
11717 Zero(my_perl, 1, PerlInterpreter);
11718 # endif /* DEBUGGING */
11719 #endif /* PERL_IMPLICIT_SYS */
11720 param->flags = flags;
11721 param->proto_perl = proto_perl;
11724 PL_xiv_arenaroot = NULL;
11725 PL_xiv_root = NULL;
11726 PL_xnv_arenaroot = NULL;
11727 PL_xnv_root = NULL;
11728 PL_xrv_arenaroot = NULL;
11729 PL_xrv_root = NULL;
11730 PL_xpv_arenaroot = NULL;
11731 PL_xpv_root = NULL;
11732 PL_xpviv_arenaroot = NULL;
11733 PL_xpviv_root = NULL;
11734 PL_xpvnv_arenaroot = NULL;
11735 PL_xpvnv_root = NULL;
11736 PL_xpvcv_arenaroot = NULL;
11737 PL_xpvcv_root = NULL;
11738 PL_xpvav_arenaroot = NULL;
11739 PL_xpvav_root = NULL;
11740 PL_xpvhv_arenaroot = NULL;
11741 PL_xpvhv_root = NULL;
11742 PL_xpvmg_arenaroot = NULL;
11743 PL_xpvmg_root = NULL;
11744 PL_xpvgv_arenaroot = NULL;
11745 PL_xpvgv_root = NULL;
11746 PL_xpvlv_arenaroot = NULL;
11747 PL_xpvlv_root = NULL;
11748 PL_xpvbm_arenaroot = NULL;
11749 PL_xpvbm_root = NULL;
11750 PL_he_arenaroot = NULL;
11752 #if defined(USE_ITHREADS)
11753 PL_pte_arenaroot = NULL;
11754 PL_pte_root = NULL;
11756 PL_nice_chunk = NULL;
11757 PL_nice_chunk_size = 0;
11759 PL_sv_objcount = 0;
11760 PL_sv_root = Nullsv;
11761 PL_sv_arenaroot = Nullsv;
11763 PL_debug = proto_perl->Idebug;
11765 #ifdef USE_REENTRANT_API
11766 /* XXX: things like -Dm will segfault here in perlio, but doing
11767 * PERL_SET_CONTEXT(proto_perl);
11768 * breaks too many other things
11770 Perl_reentrant_init(aTHX);
11773 /* create SV map for pointer relocation */
11774 PL_ptr_table = ptr_table_new();
11776 /* initialize these special pointers as early as possible */
11777 SvANY(&PL_sv_undef) = NULL;
11778 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11779 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11780 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11782 SvANY(&PL_sv_no) = new_XPVNV();
11783 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11784 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11785 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11786 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11787 SvCUR_set(&PL_sv_no, 0);
11788 SvLEN_set(&PL_sv_no, 1);
11789 SvIV_set(&PL_sv_no, 0);
11790 SvNV_set(&PL_sv_no, 0);
11791 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11793 SvANY(&PL_sv_yes) = new_XPVNV();
11794 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11795 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11796 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11797 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11798 SvCUR_set(&PL_sv_yes, 1);
11799 SvLEN_set(&PL_sv_yes, 2);
11800 SvIV_set(&PL_sv_yes, 1);
11801 SvNV_set(&PL_sv_yes, 1);
11802 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11804 /* create (a non-shared!) shared string table */
11805 PL_strtab = newHV();
11806 HvSHAREKEYS_off(PL_strtab);
11807 hv_ksplit(PL_strtab, 512);
11808 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11810 PL_compiling = proto_perl->Icompiling;
11812 /* These two PVs will be free'd special way so must set them same way op.c does */
11813 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11814 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11816 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11817 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11819 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11820 if (!specialWARN(PL_compiling.cop_warnings))
11821 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11822 if (!specialCopIO(PL_compiling.cop_io))
11823 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11824 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11826 /* pseudo environmental stuff */
11827 PL_origargc = proto_perl->Iorigargc;
11828 PL_origargv = proto_perl->Iorigargv;
11830 param->stashes = newAV(); /* Setup array of objects to call clone on */
11832 #ifdef PERLIO_LAYERS
11833 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11834 PerlIO_clone(aTHX_ proto_perl, param);
11837 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11838 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11839 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11840 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11841 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11842 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11845 PL_minus_c = proto_perl->Iminus_c;
11846 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11847 PL_localpatches = proto_perl->Ilocalpatches;
11848 PL_splitstr = proto_perl->Isplitstr;
11849 PL_preprocess = proto_perl->Ipreprocess;
11850 PL_minus_n = proto_perl->Iminus_n;
11851 PL_minus_p = proto_perl->Iminus_p;
11852 PL_minus_l = proto_perl->Iminus_l;
11853 PL_minus_a = proto_perl->Iminus_a;
11854 PL_minus_F = proto_perl->Iminus_F;
11855 PL_doswitches = proto_perl->Idoswitches;
11856 PL_dowarn = proto_perl->Idowarn;
11857 PL_doextract = proto_perl->Idoextract;
11858 PL_sawampersand = proto_perl->Isawampersand;
11859 PL_unsafe = proto_perl->Iunsafe;
11860 PL_inplace = SAVEPV(proto_perl->Iinplace);
11861 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11862 PL_perldb = proto_perl->Iperldb;
11863 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11864 PL_exit_flags = proto_perl->Iexit_flags;
11866 /* magical thingies */
11867 /* XXX time(&PL_basetime) when asked for? */
11868 PL_basetime = proto_perl->Ibasetime;
11869 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11871 PL_maxsysfd = proto_perl->Imaxsysfd;
11872 PL_multiline = proto_perl->Imultiline;
11873 PL_statusvalue = proto_perl->Istatusvalue;
11875 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11877 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11879 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11880 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11881 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11883 /* Clone the regex array */
11884 PL_regex_padav = newAV();
11886 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11887 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11888 av_push(PL_regex_padav,
11889 sv_dup_inc(regexen[0],param));
11890 for(i = 1; i <= len; i++) {
11891 if(SvREPADTMP(regexen[i])) {
11892 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11894 av_push(PL_regex_padav,
11896 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11897 SvIVX(regexen[i])), param)))
11902 PL_regex_pad = AvARRAY(PL_regex_padav);
11904 /* shortcuts to various I/O objects */
11905 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11906 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11907 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11908 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11909 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11910 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11912 /* shortcuts to regexp stuff */
11913 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11915 /* shortcuts to misc objects */
11916 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11918 /* shortcuts to debugging objects */
11919 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11920 PL_DBline = gv_dup(proto_perl->IDBline, param);
11921 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11922 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11923 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11924 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11925 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11926 PL_lineary = av_dup(proto_perl->Ilineary, param);
11927 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11929 /* symbol tables */
11930 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11931 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11932 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11933 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11934 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11936 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11937 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11938 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11939 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11940 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11941 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11943 PL_sub_generation = proto_perl->Isub_generation;
11945 /* funky return mechanisms */
11946 PL_forkprocess = proto_perl->Iforkprocess;
11948 /* subprocess state */
11949 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11951 /* internal state */
11952 PL_tainting = proto_perl->Itainting;
11953 PL_taint_warn = proto_perl->Itaint_warn;
11954 PL_maxo = proto_perl->Imaxo;
11955 if (proto_perl->Iop_mask)
11956 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11958 PL_op_mask = Nullch;
11959 /* PL_asserting = proto_perl->Iasserting; */
11961 /* current interpreter roots */
11962 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11963 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11964 PL_main_start = proto_perl->Imain_start;
11965 PL_eval_root = proto_perl->Ieval_root;
11966 PL_eval_start = proto_perl->Ieval_start;
11968 /* runtime control stuff */
11969 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11970 PL_copline = proto_perl->Icopline;
11972 PL_filemode = proto_perl->Ifilemode;
11973 PL_lastfd = proto_perl->Ilastfd;
11974 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11977 PL_gensym = proto_perl->Igensym;
11978 PL_preambled = proto_perl->Ipreambled;
11979 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11980 PL_laststatval = proto_perl->Ilaststatval;
11981 PL_laststype = proto_perl->Ilaststype;
11982 PL_mess_sv = Nullsv;
11984 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11985 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11987 /* interpreter atexit processing */
11988 PL_exitlistlen = proto_perl->Iexitlistlen;
11989 if (PL_exitlistlen) {
11990 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11991 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11994 PL_exitlist = (PerlExitListEntry*)NULL;
11995 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11996 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11997 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11999 PL_profiledata = NULL;
12000 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
12001 /* PL_rsfp_filters entries have fake IoDIRP() */
12002 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
12004 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12006 PAD_CLONE_VARS(proto_perl, param);
12008 #ifdef HAVE_INTERP_INTERN
12009 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12012 /* more statics moved here */
12013 PL_generation = proto_perl->Igeneration;
12014 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12016 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12017 PL_in_clean_all = proto_perl->Iin_clean_all;
12019 PL_uid = proto_perl->Iuid;
12020 PL_euid = proto_perl->Ieuid;
12021 PL_gid = proto_perl->Igid;
12022 PL_egid = proto_perl->Iegid;
12023 PL_nomemok = proto_perl->Inomemok;
12024 PL_an = proto_perl->Ian;
12025 PL_evalseq = proto_perl->Ievalseq;
12026 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12027 PL_origalen = proto_perl->Iorigalen;
12028 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12029 PL_osname = SAVEPV(proto_perl->Iosname);
12030 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
12031 PL_sighandlerp = proto_perl->Isighandlerp;
12034 PL_runops = proto_perl->Irunops;
12036 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12039 PL_cshlen = proto_perl->Icshlen;
12040 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
12043 PL_lex_state = proto_perl->Ilex_state;
12044 PL_lex_defer = proto_perl->Ilex_defer;
12045 PL_lex_expect = proto_perl->Ilex_expect;
12046 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12047 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12048 PL_lex_starts = proto_perl->Ilex_starts;
12049 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12050 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
12051 PL_lex_op = proto_perl->Ilex_op;
12052 PL_lex_inpat = proto_perl->Ilex_inpat;
12053 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12054 PL_lex_brackets = proto_perl->Ilex_brackets;
12055 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12056 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12057 PL_lex_casemods = proto_perl->Ilex_casemods;
12058 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12059 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12061 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12062 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12063 PL_nexttoke = proto_perl->Inexttoke;
12065 /* XXX This is probably masking the deeper issue of why
12066 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12067 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12068 * (A little debugging with a watchpoint on it may help.)
12070 if (SvANY(proto_perl->Ilinestr)) {
12071 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
12072 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
12073 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12074 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
12075 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12076 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
12077 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12078 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
12079 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12082 PL_linestr = NEWSV(65,79);
12083 sv_upgrade(PL_linestr,SVt_PVIV);
12084 sv_setpvn(PL_linestr,"",0);
12085 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12087 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
12088 PL_pending_ident = proto_perl->Ipending_ident;
12089 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12091 PL_expect = proto_perl->Iexpect;
12093 PL_multi_start = proto_perl->Imulti_start;
12094 PL_multi_end = proto_perl->Imulti_end;
12095 PL_multi_open = proto_perl->Imulti_open;
12096 PL_multi_close = proto_perl->Imulti_close;
12098 PL_error_count = proto_perl->Ierror_count;
12099 PL_subline = proto_perl->Isubline;
12100 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12102 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
12103 if (SvANY(proto_perl->Ilinestr)) {
12104 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
12105 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12106 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
12107 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12108 PL_last_lop_op = proto_perl->Ilast_lop_op;
12111 PL_last_uni = SvPVX(PL_linestr);
12112 PL_last_lop = SvPVX(PL_linestr);
12113 PL_last_lop_op = 0;
12115 PL_in_my = proto_perl->Iin_my;
12116 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
12118 PL_cryptseen = proto_perl->Icryptseen;
12121 PL_hints = proto_perl->Ihints;
12123 PL_amagic_generation = proto_perl->Iamagic_generation;
12125 #ifdef USE_LOCALE_COLLATE
12126 PL_collation_ix = proto_perl->Icollation_ix;
12127 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12128 PL_collation_standard = proto_perl->Icollation_standard;
12129 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12130 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12131 #endif /* USE_LOCALE_COLLATE */
12133 #ifdef USE_LOCALE_NUMERIC
12134 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12135 PL_numeric_standard = proto_perl->Inumeric_standard;
12136 PL_numeric_local = proto_perl->Inumeric_local;
12137 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12138 #endif /* !USE_LOCALE_NUMERIC */
12140 /* utf8 character classes */
12141 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12142 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12143 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12144 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12145 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12146 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12147 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12148 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12149 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12150 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12151 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12152 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12153 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12154 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12155 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12156 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12157 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12158 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12159 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12160 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12162 /* Did the locale setup indicate UTF-8? */
12163 PL_utf8locale = proto_perl->Iutf8locale;
12164 /* Unicode features (see perlrun/-C) */
12165 PL_unicode = proto_perl->Iunicode;
12167 /* Pre-5.8 signals control */
12168 PL_signals = proto_perl->Isignals;
12170 /* times() ticks per second */
12171 PL_clocktick = proto_perl->Iclocktick;
12173 /* Recursion stopper for PerlIO_find_layer */
12174 PL_in_load_module = proto_perl->Iin_load_module;
12176 /* sort() routine */
12177 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12179 /* Not really needed/useful since the reenrant_retint is "volatile",
12180 * but do it for consistency's sake. */
12181 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12183 /* Hooks to shared SVs and locks. */
12184 PL_sharehook = proto_perl->Isharehook;
12185 PL_lockhook = proto_perl->Ilockhook;
12186 PL_unlockhook = proto_perl->Iunlockhook;
12187 PL_threadhook = proto_perl->Ithreadhook;
12189 PL_runops_std = proto_perl->Irunops_std;
12190 PL_runops_dbg = proto_perl->Irunops_dbg;
12192 #ifdef THREADS_HAVE_PIDS
12193 PL_ppid = proto_perl->Ippid;
12197 PL_last_swash_hv = Nullhv; /* reinits on demand */
12198 PL_last_swash_klen = 0;
12199 PL_last_swash_key[0]= '\0';
12200 PL_last_swash_tmps = (U8*)NULL;
12201 PL_last_swash_slen = 0;
12203 PL_glob_index = proto_perl->Iglob_index;
12204 PL_srand_called = proto_perl->Isrand_called;
12205 PL_hash_seed = proto_perl->Ihash_seed;
12206 PL_rehash_seed = proto_perl->Irehash_seed;
12207 PL_uudmap['M'] = 0; /* reinits on demand */
12208 PL_bitcount = Nullch; /* reinits on demand */
12210 if (proto_perl->Ipsig_pend) {
12211 Newz(0, PL_psig_pend, SIG_SIZE, int);
12214 PL_psig_pend = (int*)NULL;
12217 if (proto_perl->Ipsig_ptr) {
12218 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12219 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12220 for (i = 1; i < SIG_SIZE; i++) {
12221 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12222 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12226 PL_psig_ptr = (SV**)NULL;
12227 PL_psig_name = (SV**)NULL;
12230 /* thrdvar.h stuff */
12232 if (flags & CLONEf_COPY_STACKS) {
12233 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12234 PL_tmps_ix = proto_perl->Ttmps_ix;
12235 PL_tmps_max = proto_perl->Ttmps_max;
12236 PL_tmps_floor = proto_perl->Ttmps_floor;
12237 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12239 while (i <= PL_tmps_ix) {
12240 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12244 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12245 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12246 Newz(54, PL_markstack, i, I32);
12247 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12248 - proto_perl->Tmarkstack);
12249 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12250 - proto_perl->Tmarkstack);
12251 Copy(proto_perl->Tmarkstack, PL_markstack,
12252 PL_markstack_ptr - PL_markstack + 1, I32);
12254 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12255 * NOTE: unlike the others! */
12256 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12257 PL_scopestack_max = proto_perl->Tscopestack_max;
12258 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12259 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12261 /* NOTE: si_dup() looks at PL_markstack */
12262 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12264 /* PL_curstack = PL_curstackinfo->si_stack; */
12265 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12266 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12268 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12269 PL_stack_base = AvARRAY(PL_curstack);
12270 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12271 - proto_perl->Tstack_base);
12272 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12274 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12275 * NOTE: unlike the others! */
12276 PL_savestack_ix = proto_perl->Tsavestack_ix;
12277 PL_savestack_max = proto_perl->Tsavestack_max;
12278 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12279 PL_savestack = ss_dup(proto_perl, param);
12283 ENTER; /* perl_destruct() wants to LEAVE; */
12286 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12287 PL_top_env = &PL_start_env;
12289 PL_op = proto_perl->Top;
12292 PL_Xpv = (XPV*)NULL;
12293 PL_na = proto_perl->Tna;
12295 PL_statbuf = proto_perl->Tstatbuf;
12296 PL_statcache = proto_perl->Tstatcache;
12297 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12298 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12300 PL_timesbuf = proto_perl->Ttimesbuf;
12303 PL_tainted = proto_perl->Ttainted;
12304 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12305 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12306 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12307 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12308 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12309 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12310 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12311 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12312 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12314 PL_restartop = proto_perl->Trestartop;
12315 PL_in_eval = proto_perl->Tin_eval;
12316 PL_delaymagic = proto_perl->Tdelaymagic;
12317 PL_dirty = proto_perl->Tdirty;
12318 PL_localizing = proto_perl->Tlocalizing;
12320 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12321 PL_hv_fetch_ent_mh = Nullhe;
12322 PL_modcount = proto_perl->Tmodcount;
12323 PL_lastgotoprobe = Nullop;
12324 PL_dumpindent = proto_perl->Tdumpindent;
12326 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12327 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12328 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12329 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12330 PL_sortcxix = proto_perl->Tsortcxix;
12331 PL_efloatbuf = Nullch; /* reinits on demand */
12332 PL_efloatsize = 0; /* reinits on demand */
12336 PL_screamfirst = NULL;
12337 PL_screamnext = NULL;
12338 PL_maxscream = -1; /* reinits on demand */
12339 PL_lastscream = Nullsv;
12341 PL_watchaddr = NULL;
12342 PL_watchok = Nullch;
12344 PL_regdummy = proto_perl->Tregdummy;
12345 PL_regprecomp = Nullch;
12348 PL_colorset = 0; /* reinits PL_colors[] */
12349 /*PL_colors[6] = {0,0,0,0,0,0};*/
12350 PL_reginput = Nullch;
12351 PL_regbol = Nullch;
12352 PL_regeol = Nullch;
12353 PL_regstartp = (I32*)NULL;
12354 PL_regendp = (I32*)NULL;
12355 PL_reglastparen = (U32*)NULL;
12356 PL_reglastcloseparen = (U32*)NULL;
12357 PL_regtill = Nullch;
12358 PL_reg_start_tmp = (char**)NULL;
12359 PL_reg_start_tmpl = 0;
12360 PL_regdata = (struct reg_data*)NULL;
12363 PL_reg_eval_set = 0;
12365 PL_regprogram = (regnode*)NULL;
12367 PL_regcc = (CURCUR*)NULL;
12368 PL_reg_call_cc = (struct re_cc_state*)NULL;
12369 PL_reg_re = (regexp*)NULL;
12370 PL_reg_ganch = Nullch;
12371 PL_reg_sv = Nullsv;
12372 PL_reg_match_utf8 = FALSE;
12373 PL_reg_magic = (MAGIC*)NULL;
12375 PL_reg_oldcurpm = (PMOP*)NULL;
12376 PL_reg_curpm = (PMOP*)NULL;
12377 PL_reg_oldsaved = Nullch;
12378 PL_reg_oldsavedlen = 0;
12379 #ifdef PERL_COPY_ON_WRITE
12382 PL_reg_maxiter = 0;
12383 PL_reg_leftiter = 0;
12384 PL_reg_poscache = Nullch;
12385 PL_reg_poscache_size= 0;
12387 /* RE engine - function pointers */
12388 PL_regcompp = proto_perl->Tregcompp;
12389 PL_regexecp = proto_perl->Tregexecp;
12390 PL_regint_start = proto_perl->Tregint_start;
12391 PL_regint_string = proto_perl->Tregint_string;
12392 PL_regfree = proto_perl->Tregfree;
12394 PL_reginterp_cnt = 0;
12395 PL_reg_starttry = 0;
12397 /* Pluggable optimizer */
12398 PL_peepp = proto_perl->Tpeepp;
12400 PL_stashcache = newHV();
12402 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12403 ptr_table_free(PL_ptr_table);
12404 PL_ptr_table = NULL;
12407 /* Call the ->CLONE method, if it exists, for each of the stashes
12408 identified by sv_dup() above.
12410 while(av_len(param->stashes) != -1) {
12411 HV* stash = (HV*) av_shift(param->stashes);
12412 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12413 if (cloner && GvCV(cloner)) {
12418 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12420 call_sv((SV*)GvCV(cloner), G_DISCARD);
12426 SvREFCNT_dec(param->stashes);
12428 /* orphaned? eg threads->new inside BEGIN or use */
12429 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12430 SvREFCNT_inc(PL_compcv);
12431 SAVEFREESV(PL_compcv);
12437 #endif /* USE_ITHREADS */
12440 =head1 Unicode Support
12442 =for apidoc sv_recode_to_utf8
12444 The encoding is assumed to be an Encode object, on entry the PV
12445 of the sv is assumed to be octets in that encoding, and the sv
12446 will be converted into Unicode (and UTF-8).
12448 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12449 is not a reference, nothing is done to the sv. If the encoding is not
12450 an C<Encode::XS> Encoding object, bad things will happen.
12451 (See F<lib/encoding.pm> and L<Encode>).
12453 The PV of the sv is returned.
12458 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12461 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12475 Passing sv_yes is wrong - it needs to be or'ed set of constants
12476 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12477 remove converted chars from source.
12479 Both will default the value - let them.
12481 XPUSHs(&PL_sv_yes);
12484 call_method("decode", G_SCALAR);
12488 s = SvPV(uni, len);
12489 if (s != SvPVX(sv)) {
12490 SvGROW(sv, len + 1);
12491 Move(s, SvPVX(sv), len, char);
12492 SvCUR_set(sv, len);
12493 SvPVX(sv)[len] = 0;
12500 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12504 =for apidoc sv_cat_decode
12506 The encoding is assumed to be an Encode object, the PV of the ssv is
12507 assumed to be octets in that encoding and decoding the input starts
12508 from the position which (PV + *offset) pointed to. The dsv will be
12509 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12510 when the string tstr appears in decoding output or the input ends on
12511 the PV of the ssv. The value which the offset points will be modified
12512 to the last input position on the ssv.
12514 Returns TRUE if the terminator was found, else returns FALSE.
12519 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12520 SV *ssv, int *offset, char *tstr, int tlen)
12524 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12535 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12536 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12538 call_method("cat_decode", G_SCALAR);
12540 ret = SvTRUE(TOPs);
12541 *offset = SvIV(offsv);
12547 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12553 * c-indentation-style: bsd
12554 * c-basic-offset: 4
12555 * indent-tabs-mode: t
12558 * ex: set ts=8 sts=4 sw=4 noet: