assert() that the sv_unmagic() in S_regmatch() is unneeded.
[p5sagit/p5-mst-13.2.git] / sv.c
1 /*    sv.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
5  *
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.
8  *
9  * "I wonder what the Entish is for 'yes' and 'no'," he thought.
10  *
11  *
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
17  * in the pp*.c files.
18  */
19
20 #include "EXTERN.h"
21 #define PERL_IN_SV_C
22 #include "perl.h"
23 #include "regcomp.h"
24
25 #define FCALL *f
26
27 #ifdef __Lynx__
28 /* Missing proto on LynxOS */
29   char *gconvert(double, int, int,  char *);
30 #endif
31
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35  *   lib/utf8.t lib/Unicode/Collate/t/index.t
36  * --jhi
37  */
38 #   define ASSERT_UTF8_CACHE(cache) \
39     STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40                               assert((cache)[2] <= (cache)[3]); \
41                               assert((cache)[3] <= (cache)[1]);} \
42                               } STMT_END
43 #else
44 #   define ASSERT_UTF8_CACHE(cache) NOOP
45 #endif
46
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
51    on-write.  */
52 #endif
53
54 /* ============================================================================
55
56 =head1 Allocation and deallocation of SVs.
57
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type.  Some types store all they need
62 in the head, so don't have a body.
63
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
69
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
75
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena.  SV-bodies are further described later.
79
80 The following global variables are associated with arenas:
81
82     PL_sv_arenaroot     pointer to list of SV arenas
83     PL_sv_root          pointer to list of free SV structures
84
85     PL_body_arenas      head of linked-list of body arenas
86     PL_body_roots[]     array of pointers to list of free bodies of svtype
87                         arrays are indexed by the svtype needed
88
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
93
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
96
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
102
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
106
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
112
113     sv_report_used() / do_report_used()
114                         dump all remaining SVs (debugging aid)
115
116     sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117                         Attempt to free all objects pointed to by RVs,
118                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119                         try to do the same for all objects indirectly
120                         referenced by typeglobs too.  Called once from
121                         perl_destruct(), prior to calling sv_clean_all()
122                         below.
123
124     sv_clean_all() / do_clean_all()
125                         SvREFCNT_dec(sv) each remaining SV, possibly
126                         triggering an sv_free(). It also sets the
127                         SVf_BREAK flag on the SV to indicate that the
128                         refcnt has been artificially lowered, and thus
129                         stopping sv_free() from giving spurious warnings
130                         about SVs which unexpectedly have a refcnt
131                         of zero.  called repeatedly from perl_destruct()
132                         until there are no SVs left.
133
134 =head2 Arena allocator API Summary
135
136 Private API to rest of sv.c
137
138     new_SV(),  del_SV(),
139
140     new_XIV(), del_XIV(),
141     new_XNV(), del_XNV(),
142     etc
143
144 Public API:
145
146     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
147
148 =cut
149
150 ============================================================================ */
151
152 /*
153  * "A time to plant, and a time to uproot what was planted..."
154  */
155
156 void
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
158 {
159     dVAR;
160     void *new_chunk;
161     U32 new_chunk_size;
162     new_chunk = (void *)(chunk);
163     new_chunk_size = (chunk_size);
164     if (new_chunk_size > PL_nice_chunk_size) {
165         Safefree(PL_nice_chunk);
166         PL_nice_chunk = (char *) new_chunk;
167         PL_nice_chunk_size = new_chunk_size;
168     } else {
169         Safefree(chunk);
170     }
171 }
172
173 #ifdef DEBUG_LEAKING_SCALARS
174 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
175 #else
176 #  define FREE_SV_DEBUG_FILE(sv)
177 #endif
178
179 #ifdef PERL_POISON
180 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
182    unreferenced scalars
183 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
184 */
185 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
186                                 PoisonNew(&SvREFCNT(sv), 1, U32)
187 #else
188 #  define SvARENA_CHAIN(sv)     SvANY(sv)
189 #  define POSION_SV_HEAD(sv)
190 #endif
191
192 #define plant_SV(p) \
193     STMT_START {                                        \
194         FREE_SV_DEBUG_FILE(p);                          \
195         POSION_SV_HEAD(p);                              \
196         SvARENA_CHAIN(p) = (void *)PL_sv_root;          \
197         SvFLAGS(p) = SVTYPEMASK;                        \
198         PL_sv_root = (p);                               \
199         --PL_sv_count;                                  \
200     } STMT_END
201
202 #define uproot_SV(p) \
203     STMT_START {                                        \
204         (p) = PL_sv_root;                               \
205         PL_sv_root = (SV*)SvARENA_CHAIN(p);             \
206         ++PL_sv_count;                                  \
207     } STMT_END
208
209
210 /* make some more SVs by adding another arena */
211
212 STATIC SV*
213 S_more_sv(pTHX)
214 {
215     dVAR;
216     SV* sv;
217
218     if (PL_nice_chunk) {
219         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220         PL_nice_chunk = NULL;
221         PL_nice_chunk_size = 0;
222     }
223     else {
224         char *chunk;                /* must use New here to match call to */
225         Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
226         sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
227     }
228     uproot_SV(sv);
229     return sv;
230 }
231
232 /* new_SV(): return a new, empty SV head */
233
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
236 STATIC SV*
237 S_new_SV(pTHX)
238 {
239     SV* sv;
240
241     if (PL_sv_root)
242         uproot_SV(sv);
243     else
244         sv = S_more_sv(aTHX);
245     SvANY(sv) = 0;
246     SvREFCNT(sv) = 1;
247     SvFLAGS(sv) = 0;
248     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249     sv->sv_debug_line = (U16) (PL_parser
250             ?  PL_parser->copline == NOLINE
251                 ?  PL_curcop
252                     ? CopLINE(PL_curcop)
253                     : 0
254                 : PL_parser->copline
255             : 0);
256     sv->sv_debug_inpad = 0;
257     sv->sv_debug_cloned = 0;
258     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
259     
260     return sv;
261 }
262 #  define new_SV(p) (p)=S_new_SV(aTHX)
263
264 #else
265 #  define new_SV(p) \
266     STMT_START {                                        \
267         if (PL_sv_root)                                 \
268             uproot_SV(p);                               \
269         else                                            \
270             (p) = S_more_sv(aTHX);                      \
271         SvANY(p) = 0;                                   \
272         SvREFCNT(p) = 1;                                \
273         SvFLAGS(p) = 0;                                 \
274     } STMT_END
275 #endif
276
277
278 /* del_SV(): return an empty SV head to the free list */
279
280 #ifdef DEBUGGING
281
282 #define del_SV(p) \
283     STMT_START {                                        \
284         if (DEBUG_D_TEST)                               \
285             del_sv(p);                                  \
286         else                                            \
287             plant_SV(p);                                \
288     } STMT_END
289
290 STATIC void
291 S_del_sv(pTHX_ SV *p)
292 {
293     dVAR;
294     if (DEBUG_D_TEST) {
295         SV* sva;
296         bool ok = 0;
297         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298             const SV * const sv = sva + 1;
299             const SV * const svend = &sva[SvREFCNT(sva)];
300             if (p >= sv && p < svend) {
301                 ok = 1;
302                 break;
303             }
304         }
305         if (!ok) {
306             if (ckWARN_d(WARN_INTERNAL))        
307                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308                             "Attempt to free non-arena SV: 0x%"UVxf
309                             pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
310             return;
311         }
312     }
313     plant_SV(p);
314 }
315
316 #else /* ! DEBUGGING */
317
318 #define del_SV(p)   plant_SV(p)
319
320 #endif /* DEBUGGING */
321
322
323 /*
324 =head1 SV Manipulation Functions
325
326 =for apidoc sv_add_arena
327
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
330
331 =cut
332 */
333
334 void
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
336 {
337     dVAR;
338     SV* const sva = (SV*)ptr;
339     register SV* sv;
340     register SV* svend;
341
342     /* The first SV in an arena isn't an SV. */
343     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
344     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
345     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
346
347     PL_sv_arenaroot = sva;
348     PL_sv_root = sva + 1;
349
350     svend = &sva[SvREFCNT(sva) - 1];
351     sv = sva + 1;
352     while (sv < svend) {
353         SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
354 #ifdef DEBUGGING
355         SvREFCNT(sv) = 0;
356 #endif
357         /* Must always set typemask because it's always checked in on cleanup
358            when the arenas are walked looking for objects.  */
359         SvFLAGS(sv) = SVTYPEMASK;
360         sv++;
361     }
362     SvARENA_CHAIN(sv) = 0;
363 #ifdef DEBUGGING
364     SvREFCNT(sv) = 0;
365 #endif
366     SvFLAGS(sv) = SVTYPEMASK;
367 }
368
369 /* visit(): call the named function for each non-free SV in the arenas
370  * whose flags field matches the flags/mask args. */
371
372 STATIC I32
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
374 {
375     dVAR;
376     SV* sva;
377     I32 visited = 0;
378
379     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380         register const SV * const svend = &sva[SvREFCNT(sva)];
381         register SV* sv;
382         for (sv = sva + 1; sv < svend; ++sv) {
383             if (SvTYPE(sv) != SVTYPEMASK
384                     && (sv->sv_flags & mask) == flags
385                     && SvREFCNT(sv))
386             {
387                 (FCALL)(aTHX_ sv);
388                 ++visited;
389             }
390         }
391     }
392     return visited;
393 }
394
395 #ifdef DEBUGGING
396
397 /* called by sv_report_used() for each live SV */
398
399 static void
400 do_report_used(pTHX_ SV *sv)
401 {
402     if (SvTYPE(sv) != SVTYPEMASK) {
403         PerlIO_printf(Perl_debug_log, "****\n");
404         sv_dump(sv);
405     }
406 }
407 #endif
408
409 /*
410 =for apidoc sv_report_used
411
412 Dump the contents of all SVs not yet freed. (Debugging aid).
413
414 =cut
415 */
416
417 void
418 Perl_sv_report_used(pTHX)
419 {
420 #ifdef DEBUGGING
421     visit(do_report_used, 0, 0);
422 #else
423     PERL_UNUSED_CONTEXT;
424 #endif
425 }
426
427 /* called by sv_clean_objs() for each live SV */
428
429 static void
430 do_clean_objs(pTHX_ SV *ref)
431 {
432     dVAR;
433     assert (SvROK(ref));
434     {
435         SV * const target = SvRV(ref);
436         if (SvOBJECT(target)) {
437             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438             if (SvWEAKREF(ref)) {
439                 sv_del_backref(target, ref);
440                 SvWEAKREF_off(ref);
441                 SvRV_set(ref, NULL);
442             } else {
443                 SvROK_off(ref);
444                 SvRV_set(ref, NULL);
445                 SvREFCNT_dec(target);
446             }
447         }
448     }
449
450     /* XXX Might want to check arrays, etc. */
451 }
452
453 /* called by sv_clean_objs() for each live SV */
454
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
456 static void
457 do_clean_named_objs(pTHX_ SV *sv)
458 {
459     dVAR;
460     assert(SvTYPE(sv) == SVt_PVGV);
461     assert(isGV_with_GP(sv));
462     if (GvGP(sv)) {
463         if ((
464 #ifdef PERL_DONT_CREATE_GVSV
465              GvSV(sv) &&
466 #endif
467              SvOBJECT(GvSV(sv))) ||
468              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470              /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471              (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
473         {
474             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475             SvFLAGS(sv) |= SVf_BREAK;
476             SvREFCNT_dec(sv);
477         }
478     }
479 }
480 #endif
481
482 /*
483 =for apidoc sv_clean_objs
484
485 Attempt to destroy all objects not yet freed
486
487 =cut
488 */
489
490 void
491 Perl_sv_clean_objs(pTHX)
492 {
493     dVAR;
494     PL_in_clean_objs = TRUE;
495     visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497     /* some barnacles may yet remain, clinging to typeglobs */
498     visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
499 #endif
500     PL_in_clean_objs = FALSE;
501 }
502
503 /* called by sv_clean_all() for each live SV */
504
505 static void
506 do_clean_all(pTHX_ SV *sv)
507 {
508     dVAR;
509     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510     SvFLAGS(sv) |= SVf_BREAK;
511     SvREFCNT_dec(sv);
512 }
513
514 /*
515 =for apidoc sv_clean_all
516
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
520
521 =cut
522 */
523
524 I32
525 Perl_sv_clean_all(pTHX)
526 {
527     dVAR;
528     I32 cleaned;
529     PL_in_clean_all = TRUE;
530     cleaned = visit(do_clean_all, 0,0);
531     PL_in_clean_all = FALSE;
532     return cleaned;
533 }
534
535 /*
536   ARENASETS: a meta-arena implementation which separates arena-info
537   into struct arena_set, which contains an array of struct
538   arena_descs, each holding info for a single arena.  By separating
539   the meta-info from the arena, we recover the 1st slot, formerly
540   borrowed for list management.  The arena_set is about the size of an
541   arena, avoiding the needless malloc overhead of a naive linked-list.
542
543   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544   memory in the last arena-set (1/2 on average).  In trade, we get
545   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546   smaller types).  The recovery of the wasted space allows use of
547   small arenas for large, rare body types, by changing array* fields
548   in body_details_by_type[] below.
549 */
550 struct arena_desc {
551     char       *arena;          /* the raw storage, allocated aligned */
552     size_t      size;           /* its size ~4k typ */
553     U32         misc;           /* type, and in future other things. */
554 };
555
556 struct arena_set;
557
558 /* Get the maximum number of elements in set[] such that struct arena_set
559    will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560    therefore likely to be 1 aligned memory page.  */
561
562 #define ARENAS_PER_SET  ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563                           - 2 * sizeof(int)) / sizeof (struct arena_desc))
564
565 struct arena_set {
566     struct arena_set* next;
567     unsigned int   set_size;    /* ie ARENAS_PER_SET */
568     unsigned int   curr;        /* index of next available arena-desc */
569     struct arena_desc set[ARENAS_PER_SET];
570 };
571
572 /*
573 =for apidoc sv_free_arenas
574
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
577
578 =cut
579 */
580 void
581 Perl_sv_free_arenas(pTHX)
582 {
583     dVAR;
584     SV* sva;
585     SV* svanext;
586     unsigned int i;
587
588     /* Free arenas here, but be careful about fake ones.  (We assume
589        contiguity of the fake ones with the corresponding real ones.) */
590
591     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592         svanext = (SV*) SvANY(sva);
593         while (svanext && SvFAKE(svanext))
594             svanext = (SV*) SvANY(svanext);
595
596         if (!SvFAKE(sva))
597             Safefree(sva);
598     }
599
600     {
601         struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
602
603         while (aroot) {
604             struct arena_set *current = aroot;
605             i = aroot->curr;
606             while (i--) {
607                 assert(aroot->set[i].arena);
608                 Safefree(aroot->set[i].arena);
609             }
610             aroot = aroot->next;
611             Safefree(current);
612         }
613     }
614     PL_body_arenas = 0;
615
616     i = PERL_ARENA_ROOTS_SIZE;
617     while (i--)
618         PL_body_roots[i] = 0;
619
620     Safefree(PL_nice_chunk);
621     PL_nice_chunk = NULL;
622     PL_nice_chunk_size = 0;
623     PL_sv_arenaroot = 0;
624     PL_sv_root = 0;
625 }
626
627 /*
628   Here are mid-level routines that manage the allocation of bodies out
629   of the various arenas.  There are 5 kinds of arenas:
630
631   1. SV-head arenas, which are discussed and handled above
632   2. regular body arenas
633   3. arenas for reduced-size bodies
634   4. Hash-Entry arenas
635   5. pte arenas (thread related)
636
637   Arena types 2 & 3 are chained by body-type off an array of
638   arena-root pointers, which is indexed by svtype.  Some of the
639   larger/less used body types are malloced singly, since a large
640   unused block of them is wasteful.  Also, several svtypes dont have
641   bodies; the data fits into the sv-head itself.  The arena-root
642   pointer thus has a few unused root-pointers (which may be hijacked
643   later for arena types 4,5)
644
645   3 differs from 2 as an optimization; some body types have several
646   unused fields in the front of the structure (which are kept in-place
647   for consistency).  These bodies can be allocated in smaller chunks,
648   because the leading fields arent accessed.  Pointers to such bodies
649   are decremented to point at the unused 'ghost' memory, knowing that
650   the pointers are used with offsets to the real memory.
651
652   HE, HEK arenas are managed separately, with separate code, but may
653   be merge-able later..
654
655   PTE arenas are not sv-bodies, but they share these mid-level
656   mechanics, so are considered here.  The new mid-level mechanics rely
657   on the sv_type of the body being allocated, so we just reserve one
658   of the unused body-slots for PTEs, then use it in those (2) PTE
659   contexts below (line ~10k)
660 */
661
662 /* get_arena(size): this creates custom-sized arenas
663    TBD: export properly for hv.c: S_more_he().
664 */
665 void*
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
667 {
668     dVAR;
669     struct arena_desc* adesc;
670     struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
671     unsigned int curr;
672
673     /* shouldnt need this
674     if (!arena_size)    arena_size = PERL_ARENA_SIZE;
675     */
676
677     /* may need new arena-set to hold new arena */
678     if (!aroot || aroot->curr >= aroot->set_size) {
679         struct arena_set *newroot;
680         Newxz(newroot, 1, struct arena_set);
681         newroot->set_size = ARENAS_PER_SET;
682         newroot->next = aroot;
683         aroot = newroot;
684         PL_body_arenas = (void *) newroot;
685         DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
686     }
687
688     /* ok, now have arena-set with at least 1 empty/available arena-desc */
689     curr = aroot->curr++;
690     adesc = &(aroot->set[curr]);
691     assert(!adesc->arena);
692     
693     Newx(adesc->arena, arena_size, char);
694     adesc->size = arena_size;
695     adesc->misc = misc;
696     DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n", 
697                           curr, (void*)adesc->arena, (UV)arena_size));
698
699     return adesc->arena;
700 }
701
702
703 /* return a thing to the free list */
704
705 #define del_body(thing, root)                   \
706     STMT_START {                                \
707         void ** const thing_copy = (void **)thing;\
708         *thing_copy = *root;                    \
709         *root = (void*)thing_copy;              \
710     } STMT_END
711
712 /* 
713
714 =head1 SV-Body Allocation
715
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
719 SV detection.
720
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type.  These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type.  Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
726
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist.  They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods.  The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
732
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure.  (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
740
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
747
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
752
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list.  Then the lock is released, and
757 the body is returned.
758
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list.  It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
763
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
766
767 */
768
769 /* 
770
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
773
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are.  PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
777
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena.  Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
781
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade().  The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven.  All fields
785 are used for this, except for arena_size.
786
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded.  In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
792 available in hv.c.
793
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics.  At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot.  This choice has no
799 consequence at this time.
800
801 */
802
803 struct body_details {
804     U8 body_size;       /* Size to allocate  */
805     U8 copy;            /* Size of structure to copy (may be shorter)  */
806     U8 offset;
807     unsigned int type : 4;          /* We have space for a sanity check.  */
808     unsigned int cant_upgrade : 1;  /* Cannot upgrade this type */
809     unsigned int zero_nv : 1;       /* zero the NV when upgrading from this */
810     unsigned int arena : 1;         /* Allocated from an arena */
811     size_t arena_size;              /* Size of arena to allocate */
812 };
813
814 #define HADNV FALSE
815 #define NONV TRUE
816
817
818 #ifdef PURIFY
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820    This seems a rather elegant way to simplify some of the code below.  */
821 #define HASARENA FALSE
822 #else
823 #define HASARENA TRUE
824 #endif
825 #define NOARENA FALSE
826
827 /* Size the arenas to exactly fit a given number of bodies.  A count
828    of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829    simplifying the default.  If count > 0, the arena is sized to fit
830    only that many bodies, allowing arenas to be used for large, rare
831    bodies (XPVFM, XPVIO) without undue waste.  The arena size is
832    limited by PERL_ARENA_SIZE, so we can safely oversize the
833    declarations.
834  */
835 #define FIT_ARENA0(body_size)                           \
836     ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size)                     \
838     ( count * body_size <= PERL_ARENA_SIZE)             \
839     ? count * body_size                                 \
840     : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size)                      \
842     count                                               \
843     ? FIT_ARENAn (count, body_size)                     \
844     : FIT_ARENA0 (body_size)
845
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
847
848 typedef struct {
849     STRLEN      xpv_cur;
850     STRLEN      xpv_len;
851 } xpv_allocated;
852
853 to make its members accessible via a pointer to (say)
854
855 struct xpv {
856     NV          xnv_nv;
857     STRLEN      xpv_cur;
858     STRLEN      xpv_len;
859 };
860
861 */
862
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864     (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
865
866 /* Calculate the length to copy. Specifically work out the length less any
867    final padding the compiler needed to add.  See the comment in sv_upgrade
868    for why copying the padding proved to be a bug.  */
869
870 #define copy_length(type, last_member) \
871         STRUCT_OFFSET(type, last_member) \
872         + sizeof (((type*)SvANY((SV*)0))->last_member)
873
874 static const struct body_details bodies_by_type[] = {
875     { sizeof(HE), 0, 0, SVt_NULL,
876       FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
877
878     /* The bind placeholder pretends to be an RV for now.
879        Also it's marked as "can't upgrade" to stop anyone using it before it's
880        implemented.  */
881     { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
882
883     /* IVs are in the head, so the allocation size is 0.
884        However, the slot is overloaded for PTEs.  */
885     { sizeof(struct ptr_tbl_ent), /* This is used for PTEs.  */
886       sizeof(IV), /* This is used to copy out the IV body.  */
887       STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888       NOARENA /* IVS don't need an arena  */,
889       /* But PTEs need to know the size of their arena  */
890       FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
891     },
892
893     /* 8 bytes on most ILP32 with IEEE doubles */
894     { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895       FIT_ARENA(0, sizeof(NV)) },
896
897     /* 8 bytes on most ILP32 with IEEE doubles */
898     { sizeof(xpv_allocated),
899       copy_length(XPV, xpv_len)
900       - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901       + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902       SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
903
904     /* 12 */
905     { sizeof(xpviv_allocated),
906       copy_length(XPVIV, xiv_u)
907       - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908       + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909       SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
910
911     /* 20 */
912     { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913       HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
914
915     /* 28 */
916     { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
918
919     /* 28 */
920     { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_ORANGE, FALSE, HADNV,
921       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
922
923     /* 48 */
924     { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
925       HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
926     
927     /* 64 */
928     { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
929       HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
930
931     { sizeof(xpvav_allocated),
932       copy_length(XPVAV, xmg_stash)
933       - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
934       + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
935       SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
936
937     { sizeof(xpvhv_allocated),
938       copy_length(XPVHV, xmg_stash)
939       - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
940       + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
941       SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
942
943     /* 56 */
944     { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
945       + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
946       SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
947
948     { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
949       + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
950       SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
951
952     /* XPVIO is 84 bytes, fits 48x */
953     { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
954       HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
955 };
956
957 #define new_body_type(sv_type)          \
958     (void *)((char *)S_new_body(aTHX_ sv_type))
959
960 #define del_body_type(p, sv_type)       \
961     del_body(p, &PL_body_roots[sv_type])
962
963
964 #define new_body_allocated(sv_type)             \
965     (void *)((char *)S_new_body(aTHX_ sv_type)  \
966              - bodies_by_type[sv_type].offset)
967
968 #define del_body_allocated(p, sv_type)          \
969     del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
970
971
972 #define my_safemalloc(s)        (void*)safemalloc(s)
973 #define my_safecalloc(s)        (void*)safecalloc(s, 1)
974 #define my_safefree(p)  safefree((char*)p)
975
976 #ifdef PURIFY
977
978 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
979 #define del_XNV(p)      my_safefree(p)
980
981 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
982 #define del_XPVNV(p)    my_safefree(p)
983
984 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
985 #define del_XPVAV(p)    my_safefree(p)
986
987 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
988 #define del_XPVHV(p)    my_safefree(p)
989
990 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
991 #define del_XPVMG(p)    my_safefree(p)
992
993 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
994 #define del_XPVGV(p)    my_safefree(p)
995
996 #else /* !PURIFY */
997
998 #define new_XNV()       new_body_type(SVt_NV)
999 #define del_XNV(p)      del_body_type(p, SVt_NV)
1000
1001 #define new_XPVNV()     new_body_type(SVt_PVNV)
1002 #define del_XPVNV(p)    del_body_type(p, SVt_PVNV)
1003
1004 #define new_XPVAV()     new_body_allocated(SVt_PVAV)
1005 #define del_XPVAV(p)    del_body_allocated(p, SVt_PVAV)
1006
1007 #define new_XPVHV()     new_body_allocated(SVt_PVHV)
1008 #define del_XPVHV(p)    del_body_allocated(p, SVt_PVHV)
1009
1010 #define new_XPVMG()     new_body_type(SVt_PVMG)
1011 #define del_XPVMG(p)    del_body_type(p, SVt_PVMG)
1012
1013 #define new_XPVGV()     new_body_type(SVt_PVGV)
1014 #define del_XPVGV(p)    del_body_type(p, SVt_PVGV)
1015
1016 #endif /* PURIFY */
1017
1018 /* no arena for you! */
1019
1020 #define new_NOARENA(details) \
1021         my_safemalloc((details)->body_size + (details)->offset)
1022 #define new_NOARENAZ(details) \
1023         my_safecalloc((details)->body_size + (details)->offset)
1024
1025 STATIC void *
1026 S_more_bodies (pTHX_ svtype sv_type)
1027 {
1028     dVAR;
1029     void ** const root = &PL_body_roots[sv_type];
1030     const struct body_details * const bdp = &bodies_by_type[sv_type];
1031     const size_t body_size = bdp->body_size;
1032     char *start;
1033     const char *end;
1034 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1035     static bool done_sanity_check;
1036
1037     /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1038      * variables like done_sanity_check. */
1039     if (!done_sanity_check) {
1040         unsigned int i = SVt_LAST;
1041
1042         done_sanity_check = TRUE;
1043
1044         while (i--)
1045             assert (bodies_by_type[i].type == i);
1046     }
1047 #endif
1048
1049     assert(bdp->arena_size);
1050
1051     start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1052
1053     end = start + bdp->arena_size - body_size;
1054
1055     /* computed count doesnt reflect the 1st slot reservation */
1056     DEBUG_m(PerlIO_printf(Perl_debug_log,
1057                           "arena %p end %p arena-size %d type %d size %d ct %d\n",
1058                           (void*)start, (void*)end,
1059                           (int)bdp->arena_size, sv_type, (int)body_size,
1060                           (int)bdp->arena_size / (int)body_size));
1061
1062     *root = (void *)start;
1063
1064     while (start < end) {
1065         char * const next = start + body_size;
1066         *(void**) start = (void *)next;
1067         start = next;
1068     }
1069     *(void **)start = 0;
1070
1071     return *root;
1072 }
1073
1074 /* grab a new thing from the free list, allocating more if necessary.
1075    The inline version is used for speed in hot routines, and the
1076    function using it serves the rest (unless PURIFY).
1077 */
1078 #define new_body_inline(xpv, sv_type) \
1079     STMT_START { \
1080         void ** const r3wt = &PL_body_roots[sv_type]; \
1081         xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt))      \
1082           ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1083         *(r3wt) = *(void**)(xpv); \
1084     } STMT_END
1085
1086 #ifndef PURIFY
1087
1088 STATIC void *
1089 S_new_body(pTHX_ svtype sv_type)
1090 {
1091     dVAR;
1092     void *xpv;
1093     new_body_inline(xpv, sv_type);
1094     return xpv;
1095 }
1096
1097 #endif
1098
1099 static const struct body_details fake_rv =
1100     { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1101
1102 /*
1103 =for apidoc sv_upgrade
1104
1105 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1106 SV, then copies across as much information as possible from the old body.
1107 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1108
1109 =cut
1110 */
1111
1112 void
1113 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1114 {
1115     dVAR;
1116     void*       old_body;
1117     void*       new_body;
1118     const svtype old_type = SvTYPE(sv);
1119     const struct body_details *new_type_details;
1120     const struct body_details *old_type_details
1121         = bodies_by_type + old_type;
1122     SV *referant = NULL;
1123
1124     if (new_type != SVt_PV && SvIsCOW(sv)) {
1125         sv_force_normal_flags(sv, 0);
1126     }
1127
1128     if (old_type == new_type)
1129         return;
1130
1131     old_body = SvANY(sv);
1132
1133     /* Copying structures onto other structures that have been neatly zeroed
1134        has a subtle gotcha. Consider XPVMG
1135
1136        +------+------+------+------+------+-------+-------+
1137        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |
1138        +------+------+------+------+------+-------+-------+
1139        0      4      8     12     16     20      24      28
1140
1141        where NVs are aligned to 8 bytes, so that sizeof that structure is
1142        actually 32 bytes long, with 4 bytes of padding at the end:
1143
1144        +------+------+------+------+------+-------+-------+------+
1145        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH | ???  |
1146        +------+------+------+------+------+-------+-------+------+
1147        0      4      8     12     16     20      24      28     32
1148
1149        so what happens if you allocate memory for this structure:
1150
1151        +------+------+------+------+------+-------+-------+------+------+...
1152        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |  GP  | NAME |
1153        +------+------+------+------+------+-------+-------+------+------+...
1154        0      4      8     12     16     20      24      28     32     36
1155
1156        zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1157        expect, because you copy the area marked ??? onto GP. Now, ??? may have
1158        started out as zero once, but it's quite possible that it isn't. So now,
1159        rather than a nicely zeroed GP, you have it pointing somewhere random.
1160        Bugs ensue.
1161
1162        (In fact, GP ends up pointing at a previous GP structure, because the
1163        principle cause of the padding in XPVMG getting garbage is a copy of
1164        sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1165        this happens to be moot because XPVGV has been re-ordered, with GP
1166        no longer after STASH)
1167
1168        So we are careful and work out the size of used parts of all the
1169        structures.  */
1170
1171     switch (old_type) {
1172     case SVt_NULL:
1173         break;
1174     case SVt_IV:
1175         if (SvROK(sv)) {
1176             referant = SvRV(sv);
1177             old_type_details = &fake_rv;
1178             if (new_type == SVt_NV)
1179                 new_type = SVt_PVNV;
1180         } else {
1181             if (new_type < SVt_PVIV) {
1182                 new_type = (new_type == SVt_NV)
1183                     ? SVt_PVNV : SVt_PVIV;
1184             }
1185         }
1186         break;
1187     case SVt_NV:
1188         if (new_type < SVt_PVNV) {
1189             new_type = SVt_PVNV;
1190         }
1191         break;
1192     case SVt_PV:
1193         assert(new_type > SVt_PV);
1194         assert(SVt_IV < SVt_PV);
1195         assert(SVt_NV < SVt_PV);
1196         break;
1197     case SVt_PVIV:
1198         break;
1199     case SVt_PVNV:
1200         break;
1201     case SVt_PVMG:
1202         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1203            there's no way that it can be safely upgraded, because perl.c
1204            expects to Safefree(SvANY(PL_mess_sv))  */
1205         assert(sv != PL_mess_sv);
1206         /* This flag bit is used to mean other things in other scalar types.
1207            Given that it only has meaning inside the pad, it shouldn't be set
1208            on anything that can get upgraded.  */
1209         assert(!SvPAD_TYPED(sv));
1210         break;
1211     default:
1212         if (old_type_details->cant_upgrade)
1213             Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1214                        sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1215     }
1216
1217     if (old_type > new_type)
1218         Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1219                 (int)old_type, (int)new_type);
1220
1221     new_type_details = bodies_by_type + new_type;
1222
1223     SvFLAGS(sv) &= ~SVTYPEMASK;
1224     SvFLAGS(sv) |= new_type;
1225
1226     /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1227        the return statements above will have triggered.  */
1228     assert (new_type != SVt_NULL);
1229     switch (new_type) {
1230     case SVt_IV:
1231         assert(old_type == SVt_NULL);
1232         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1233         SvIV_set(sv, 0);
1234         return;
1235     case SVt_NV:
1236         assert(old_type == SVt_NULL);
1237         SvANY(sv) = new_XNV();
1238         SvNV_set(sv, 0);
1239         return;
1240     case SVt_PVHV:
1241     case SVt_PVAV:
1242         assert(new_type_details->body_size);
1243
1244 #ifndef PURIFY  
1245         assert(new_type_details->arena);
1246         assert(new_type_details->arena_size);
1247         /* This points to the start of the allocated area.  */
1248         new_body_inline(new_body, new_type);
1249         Zero(new_body, new_type_details->body_size, char);
1250         new_body = ((char *)new_body) - new_type_details->offset;
1251 #else
1252         /* We always allocated the full length item with PURIFY. To do this
1253            we fake things so that arena is false for all 16 types..  */
1254         new_body = new_NOARENAZ(new_type_details);
1255 #endif
1256         SvANY(sv) = new_body;
1257         if (new_type == SVt_PVAV) {
1258             AvMAX(sv)   = -1;
1259             AvFILLp(sv) = -1;
1260             AvREAL_only(sv);
1261             if (old_type_details->body_size) {
1262                 AvALLOC(sv) = 0;
1263             } else {
1264                 /* It will have been zeroed when the new body was allocated.
1265                    Lets not write to it, in case it confuses a write-back
1266                    cache.  */
1267             }
1268         } else {
1269             assert(!SvOK(sv));
1270             SvOK_off(sv);
1271 #ifndef NODEFAULT_SHAREKEYS
1272             HvSHAREKEYS_on(sv);         /* key-sharing on by default */
1273 #endif
1274             HvMAX(sv) = 7; /* (start with 8 buckets) */
1275             if (old_type_details->body_size) {
1276                 HvFILL(sv) = 0;
1277             } else {
1278                 /* It will have been zeroed when the new body was allocated.
1279                    Lets not write to it, in case it confuses a write-back
1280                    cache.  */
1281             }
1282         }
1283
1284         /* SVt_NULL isn't the only thing upgraded to AV or HV.
1285            The target created by newSVrv also is, and it can have magic.
1286            However, it never has SvPVX set.
1287         */
1288         if (old_type == SVt_IV) {
1289             assert(!SvROK(sv));
1290         } else if (old_type >= SVt_PV) {
1291             assert(SvPVX_const(sv) == 0);
1292         }
1293
1294         if (old_type >= SVt_PVMG) {
1295             SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1296             SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1297         } else {
1298             sv->sv_u.svu_array = NULL; /* or svu_hash  */
1299         }
1300         break;
1301
1302
1303     case SVt_PVIV:
1304         /* XXX Is this still needed?  Was it ever needed?   Surely as there is
1305            no route from NV to PVIV, NOK can never be true  */
1306         assert(!SvNOKp(sv));
1307         assert(!SvNOK(sv));
1308     case SVt_PVIO:
1309     case SVt_PVFM:
1310     case SVt_PVGV:
1311     case SVt_PVCV:
1312     case SVt_PVLV:
1313     case SVt_ORANGE:
1314     case SVt_PVMG:
1315     case SVt_PVNV:
1316     case SVt_PV:
1317
1318         assert(new_type_details->body_size);
1319         /* We always allocated the full length item with PURIFY. To do this
1320            we fake things so that arena is false for all 16 types..  */
1321         if(new_type_details->arena) {
1322             /* This points to the start of the allocated area.  */
1323             new_body_inline(new_body, new_type);
1324             Zero(new_body, new_type_details->body_size, char);
1325             new_body = ((char *)new_body) - new_type_details->offset;
1326         } else {
1327             new_body = new_NOARENAZ(new_type_details);
1328         }
1329         SvANY(sv) = new_body;
1330
1331         if (old_type_details->copy) {
1332             /* There is now the potential for an upgrade from something without
1333                an offset (PVNV or PVMG) to something with one (PVCV, PVFM)  */
1334             int offset = old_type_details->offset;
1335             int length = old_type_details->copy;
1336
1337             if (new_type_details->offset > old_type_details->offset) {
1338                 const int difference
1339                     = new_type_details->offset - old_type_details->offset;
1340                 offset += difference;
1341                 length -= difference;
1342             }
1343             assert (length >= 0);
1344                 
1345             Copy((char *)old_body + offset, (char *)new_body + offset, length,
1346                  char);
1347         }
1348
1349 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1350         /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1351          * correct 0.0 for us.  Otherwise, if the old body didn't have an
1352          * NV slot, but the new one does, then we need to initialise the
1353          * freshly created NV slot with whatever the correct bit pattern is
1354          * for 0.0  */
1355         if (old_type_details->zero_nv && !new_type_details->zero_nv
1356             && !isGV_with_GP(sv))
1357             SvNV_set(sv, 0);
1358 #endif
1359
1360         if (new_type == SVt_PVIO)
1361             IoPAGE_LEN(sv) = 60;
1362         if (old_type < SVt_PV) {
1363             /* referant will be NULL unless the old type was SVt_IV emulating
1364                SVt_RV */
1365             sv->sv_u.svu_rv = referant;
1366         }
1367         break;
1368     default:
1369         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1370                    (unsigned long)new_type);
1371     }
1372
1373     if (old_type_details->arena) {
1374         /* If there was an old body, then we need to free it.
1375            Note that there is an assumption that all bodies of types that
1376            can be upgraded came from arenas. Only the more complex non-
1377            upgradable types are allowed to be directly malloc()ed.  */
1378 #ifdef PURIFY
1379         my_safefree(old_body);
1380 #else
1381         del_body((void*)((char*)old_body + old_type_details->offset),
1382                  &PL_body_roots[old_type]);
1383 #endif
1384     }
1385 }
1386
1387 /*
1388 =for apidoc sv_backoff
1389
1390 Remove any string offset. You should normally use the C<SvOOK_off> macro
1391 wrapper instead.
1392
1393 =cut
1394 */
1395
1396 int
1397 Perl_sv_backoff(pTHX_ register SV *sv)
1398 {
1399     PERL_UNUSED_CONTEXT;
1400     assert(SvOOK(sv));
1401     assert(SvTYPE(sv) != SVt_PVHV);
1402     assert(SvTYPE(sv) != SVt_PVAV);
1403     if (SvIVX(sv)) {
1404         const char * const s = SvPVX_const(sv);
1405         SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1406         SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1407         SvIV_set(sv, 0);
1408         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1409     }
1410     SvFLAGS(sv) &= ~SVf_OOK;
1411     return 0;
1412 }
1413
1414 /*
1415 =for apidoc sv_grow
1416
1417 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1418 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1419 Use the C<SvGROW> wrapper instead.
1420
1421 =cut
1422 */
1423
1424 char *
1425 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1426 {
1427     register char *s;
1428
1429     if (PL_madskills && newlen >= 0x100000) {
1430         PerlIO_printf(Perl_debug_log,
1431                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1432     }
1433 #ifdef HAS_64K_LIMIT
1434     if (newlen >= 0x10000) {
1435         PerlIO_printf(Perl_debug_log,
1436                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1437         my_exit(1);
1438     }
1439 #endif /* HAS_64K_LIMIT */
1440     if (SvROK(sv))
1441         sv_unref(sv);
1442     if (SvTYPE(sv) < SVt_PV) {
1443         sv_upgrade(sv, SVt_PV);
1444         s = SvPVX_mutable(sv);
1445     }
1446     else if (SvOOK(sv)) {       /* pv is offset? */
1447         sv_backoff(sv);
1448         s = SvPVX_mutable(sv);
1449         if (newlen > SvLEN(sv))
1450             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1451 #ifdef HAS_64K_LIMIT
1452         if (newlen >= 0x10000)
1453             newlen = 0xFFFF;
1454 #endif
1455     }
1456     else
1457         s = SvPVX_mutable(sv);
1458
1459     if (newlen > SvLEN(sv)) {           /* need more room? */
1460         newlen = PERL_STRLEN_ROUNDUP(newlen);
1461         if (SvLEN(sv) && s) {
1462 #ifdef MYMALLOC
1463             const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1464             if (newlen <= l) {
1465                 SvLEN_set(sv, l);
1466                 return s;
1467             } else
1468 #endif
1469             s = (char*)saferealloc(s, newlen);
1470         }
1471         else {
1472             s = (char*)safemalloc(newlen);
1473             if (SvPVX_const(sv) && SvCUR(sv)) {
1474                 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1475             }
1476         }
1477         SvPV_set(sv, s);
1478         SvLEN_set(sv, newlen);
1479     }
1480     return s;
1481 }
1482
1483 /*
1484 =for apidoc sv_setiv
1485
1486 Copies an integer into the given SV, upgrading first if necessary.
1487 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1488
1489 =cut
1490 */
1491
1492 void
1493 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1494 {
1495     dVAR;
1496     SV_CHECK_THINKFIRST_COW_DROP(sv);
1497     switch (SvTYPE(sv)) {
1498     case SVt_NULL:
1499     case SVt_NV:
1500         sv_upgrade(sv, SVt_IV);
1501         break;
1502     case SVt_PV:
1503         sv_upgrade(sv, SVt_PVIV);
1504         break;
1505
1506     case SVt_PVGV:
1507     case SVt_PVAV:
1508     case SVt_PVHV:
1509     case SVt_PVCV:
1510     case SVt_PVFM:
1511     case SVt_PVIO:
1512         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1513                    OP_DESC(PL_op));
1514     default: NOOP;
1515     }
1516     (void)SvIOK_only(sv);                       /* validate number */
1517     SvIV_set(sv, i);
1518     SvTAINT(sv);
1519 }
1520
1521 /*
1522 =for apidoc sv_setiv_mg
1523
1524 Like C<sv_setiv>, but also handles 'set' magic.
1525
1526 =cut
1527 */
1528
1529 void
1530 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1531 {
1532     sv_setiv(sv,i);
1533     SvSETMAGIC(sv);
1534 }
1535
1536 /*
1537 =for apidoc sv_setuv
1538
1539 Copies an unsigned integer into the given SV, upgrading first if necessary.
1540 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1541
1542 =cut
1543 */
1544
1545 void
1546 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1547 {
1548     /* With these two if statements:
1549        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1550
1551        without
1552        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1553
1554        If you wish to remove them, please benchmark to see what the effect is
1555     */
1556     if (u <= (UV)IV_MAX) {
1557        sv_setiv(sv, (IV)u);
1558        return;
1559     }
1560     sv_setiv(sv, 0);
1561     SvIsUV_on(sv);
1562     SvUV_set(sv, u);
1563 }
1564
1565 /*
1566 =for apidoc sv_setuv_mg
1567
1568 Like C<sv_setuv>, but also handles 'set' magic.
1569
1570 =cut
1571 */
1572
1573 void
1574 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1575 {
1576     sv_setuv(sv,u);
1577     SvSETMAGIC(sv);
1578 }
1579
1580 /*
1581 =for apidoc sv_setnv
1582
1583 Copies a double into the given SV, upgrading first if necessary.
1584 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1585
1586 =cut
1587 */
1588
1589 void
1590 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1591 {
1592     dVAR;
1593     SV_CHECK_THINKFIRST_COW_DROP(sv);
1594     switch (SvTYPE(sv)) {
1595     case SVt_NULL:
1596     case SVt_IV:
1597         sv_upgrade(sv, SVt_NV);
1598         break;
1599     case SVt_PV:
1600     case SVt_PVIV:
1601         sv_upgrade(sv, SVt_PVNV);
1602         break;
1603
1604     case SVt_PVGV:
1605     case SVt_PVAV:
1606     case SVt_PVHV:
1607     case SVt_PVCV:
1608     case SVt_PVFM:
1609     case SVt_PVIO:
1610         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1611                    OP_NAME(PL_op));
1612     default: NOOP;
1613     }
1614     SvNV_set(sv, num);
1615     (void)SvNOK_only(sv);                       /* validate number */
1616     SvTAINT(sv);
1617 }
1618
1619 /*
1620 =for apidoc sv_setnv_mg
1621
1622 Like C<sv_setnv>, but also handles 'set' magic.
1623
1624 =cut
1625 */
1626
1627 void
1628 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1629 {
1630     sv_setnv(sv,num);
1631     SvSETMAGIC(sv);
1632 }
1633
1634 /* Print an "isn't numeric" warning, using a cleaned-up,
1635  * printable version of the offending string
1636  */
1637
1638 STATIC void
1639 S_not_a_number(pTHX_ SV *sv)
1640 {
1641      dVAR;
1642      SV *dsv;
1643      char tmpbuf[64];
1644      const char *pv;
1645
1646      if (DO_UTF8(sv)) {
1647           dsv = sv_2mortal(newSVpvs(""));
1648           pv = sv_uni_display(dsv, sv, 10, 0);
1649      } else {
1650           char *d = tmpbuf;
1651           const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1652           /* each *s can expand to 4 chars + "...\0",
1653              i.e. need room for 8 chars */
1654         
1655           const char *s = SvPVX_const(sv);
1656           const char * const end = s + SvCUR(sv);
1657           for ( ; s < end && d < limit; s++ ) {
1658                int ch = *s & 0xFF;
1659                if (ch & 128 && !isPRINT_LC(ch)) {
1660                     *d++ = 'M';
1661                     *d++ = '-';
1662                     ch &= 127;
1663                }
1664                if (ch == '\n') {
1665                     *d++ = '\\';
1666                     *d++ = 'n';
1667                }
1668                else if (ch == '\r') {
1669                     *d++ = '\\';
1670                     *d++ = 'r';
1671                }
1672                else if (ch == '\f') {
1673                     *d++ = '\\';
1674                     *d++ = 'f';
1675                }
1676                else if (ch == '\\') {
1677                     *d++ = '\\';
1678                     *d++ = '\\';
1679                }
1680                else if (ch == '\0') {
1681                     *d++ = '\\';
1682                     *d++ = '0';
1683                }
1684                else if (isPRINT_LC(ch))
1685                     *d++ = ch;
1686                else {
1687                     *d++ = '^';
1688                     *d++ = toCTRL(ch);
1689                }
1690           }
1691           if (s < end) {
1692                *d++ = '.';
1693                *d++ = '.';
1694                *d++ = '.';
1695           }
1696           *d = '\0';
1697           pv = tmpbuf;
1698     }
1699
1700     if (PL_op)
1701         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1702                     "Argument \"%s\" isn't numeric in %s", pv,
1703                     OP_DESC(PL_op));
1704     else
1705         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706                     "Argument \"%s\" isn't numeric", pv);
1707 }
1708
1709 /*
1710 =for apidoc looks_like_number
1711
1712 Test if the content of an SV looks like a number (or is a number).
1713 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1714 non-numeric warning), even if your atof() doesn't grok them.
1715
1716 =cut
1717 */
1718
1719 I32
1720 Perl_looks_like_number(pTHX_ SV *sv)
1721 {
1722     register const char *sbegin;
1723     STRLEN len;
1724
1725     if (SvPOK(sv)) {
1726         sbegin = SvPVX_const(sv);
1727         len = SvCUR(sv);
1728     }
1729     else if (SvPOKp(sv))
1730         sbegin = SvPV_const(sv, len);
1731     else
1732         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1733     return grok_number(sbegin, len, NULL);
1734 }
1735
1736 STATIC bool
1737 S_glob_2number(pTHX_ GV * const gv)
1738 {
1739     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1740     SV *const buffer = sv_newmortal();
1741
1742     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1743        is on.  */
1744     SvFAKE_off(gv);
1745     gv_efullname3(buffer, gv, "*");
1746     SvFLAGS(gv) |= wasfake;
1747
1748     /* We know that all GVs stringify to something that is not-a-number,
1749         so no need to test that.  */
1750     if (ckWARN(WARN_NUMERIC))
1751         not_a_number(buffer);
1752     /* We just want something true to return, so that S_sv_2iuv_common
1753         can tail call us and return true.  */
1754     return TRUE;
1755 }
1756
1757 STATIC char *
1758 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1759 {
1760     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1761     SV *const buffer = sv_newmortal();
1762
1763     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1764        is on.  */
1765     SvFAKE_off(gv);
1766     gv_efullname3(buffer, gv, "*");
1767     SvFLAGS(gv) |= wasfake;
1768
1769     assert(SvPOK(buffer));
1770     if (len) {
1771         *len = SvCUR(buffer);
1772     }
1773     return SvPVX(buffer);
1774 }
1775
1776 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1777    until proven guilty, assume that things are not that bad... */
1778
1779 /*
1780    NV_PRESERVES_UV:
1781
1782    As 64 bit platforms often have an NV that doesn't preserve all bits of
1783    an IV (an assumption perl has been based on to date) it becomes necessary
1784    to remove the assumption that the NV always carries enough precision to
1785    recreate the IV whenever needed, and that the NV is the canonical form.
1786    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1787    precision as a side effect of conversion (which would lead to insanity
1788    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1789    1) to distinguish between IV/UV/NV slots that have cached a valid
1790       conversion where precision was lost and IV/UV/NV slots that have a
1791       valid conversion which has lost no precision
1792    2) to ensure that if a numeric conversion to one form is requested that
1793       would lose precision, the precise conversion (or differently
1794       imprecise conversion) is also performed and cached, to prevent
1795       requests for different numeric formats on the same SV causing
1796       lossy conversion chains. (lossless conversion chains are perfectly
1797       acceptable (still))
1798
1799
1800    flags are used:
1801    SvIOKp is true if the IV slot contains a valid value
1802    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1803    SvNOKp is true if the NV slot contains a valid value
1804    SvNOK  is true only if the NV value is accurate
1805
1806    so
1807    while converting from PV to NV, check to see if converting that NV to an
1808    IV(or UV) would lose accuracy over a direct conversion from PV to
1809    IV(or UV). If it would, cache both conversions, return NV, but mark
1810    SV as IOK NOKp (ie not NOK).
1811
1812    While converting from PV to IV, check to see if converting that IV to an
1813    NV would lose accuracy over a direct conversion from PV to NV. If it
1814    would, cache both conversions, flag similarly.
1815
1816    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1817    correctly because if IV & NV were set NV *always* overruled.
1818    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1819    changes - now IV and NV together means that the two are interchangeable:
1820    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1821
1822    The benefit of this is that operations such as pp_add know that if
1823    SvIOK is true for both left and right operands, then integer addition
1824    can be used instead of floating point (for cases where the result won't
1825    overflow). Before, floating point was always used, which could lead to
1826    loss of precision compared with integer addition.
1827
1828    * making IV and NV equal status should make maths accurate on 64 bit
1829      platforms
1830    * may speed up maths somewhat if pp_add and friends start to use
1831      integers when possible instead of fp. (Hopefully the overhead in
1832      looking for SvIOK and checking for overflow will not outweigh the
1833      fp to integer speedup)
1834    * will slow down integer operations (callers of SvIV) on "inaccurate"
1835      values, as the change from SvIOK to SvIOKp will cause a call into
1836      sv_2iv each time rather than a macro access direct to the IV slot
1837    * should speed up number->string conversion on integers as IV is
1838      favoured when IV and NV are equally accurate
1839
1840    ####################################################################
1841    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1842    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1843    On the other hand, SvUOK is true iff UV.
1844    ####################################################################
1845
1846    Your mileage will vary depending your CPU's relative fp to integer
1847    performance ratio.
1848 */
1849
1850 #ifndef NV_PRESERVES_UV
1851 #  define IS_NUMBER_UNDERFLOW_IV 1
1852 #  define IS_NUMBER_UNDERFLOW_UV 2
1853 #  define IS_NUMBER_IV_AND_UV    2
1854 #  define IS_NUMBER_OVERFLOW_IV  4
1855 #  define IS_NUMBER_OVERFLOW_UV  5
1856
1857 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1858
1859 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1860 STATIC int
1861 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1862 {
1863     dVAR;
1864     PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1865     DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1866     if (SvNVX(sv) < (NV)IV_MIN) {
1867         (void)SvIOKp_on(sv);
1868         (void)SvNOK_on(sv);
1869         SvIV_set(sv, IV_MIN);
1870         return IS_NUMBER_UNDERFLOW_IV;
1871     }
1872     if (SvNVX(sv) > (NV)UV_MAX) {
1873         (void)SvIOKp_on(sv);
1874         (void)SvNOK_on(sv);
1875         SvIsUV_on(sv);
1876         SvUV_set(sv, UV_MAX);
1877         return IS_NUMBER_OVERFLOW_UV;
1878     }
1879     (void)SvIOKp_on(sv);
1880     (void)SvNOK_on(sv);
1881     /* Can't use strtol etc to convert this string.  (See truth table in
1882        sv_2iv  */
1883     if (SvNVX(sv) <= (UV)IV_MAX) {
1884         SvIV_set(sv, I_V(SvNVX(sv)));
1885         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1886             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1887         } else {
1888             /* Integer is imprecise. NOK, IOKp */
1889         }
1890         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1891     }
1892     SvIsUV_on(sv);
1893     SvUV_set(sv, U_V(SvNVX(sv)));
1894     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1895         if (SvUVX(sv) == UV_MAX) {
1896             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1897                possibly be preserved by NV. Hence, it must be overflow.
1898                NOK, IOKp */
1899             return IS_NUMBER_OVERFLOW_UV;
1900         }
1901         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1902     } else {
1903         /* Integer is imprecise. NOK, IOKp */
1904     }
1905     return IS_NUMBER_OVERFLOW_IV;
1906 }
1907 #endif /* !NV_PRESERVES_UV*/
1908
1909 STATIC bool
1910 S_sv_2iuv_common(pTHX_ SV *sv) {
1911     dVAR;
1912     if (SvNOKp(sv)) {
1913         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1914          * without also getting a cached IV/UV from it at the same time
1915          * (ie PV->NV conversion should detect loss of accuracy and cache
1916          * IV or UV at same time to avoid this. */
1917         /* IV-over-UV optimisation - choose to cache IV if possible */
1918
1919         if (SvTYPE(sv) == SVt_NV)
1920             sv_upgrade(sv, SVt_PVNV);
1921
1922         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1923         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1924            certainly cast into the IV range at IV_MAX, whereas the correct
1925            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1926            cases go to UV */
1927 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1928         if (Perl_isnan(SvNVX(sv))) {
1929             SvUV_set(sv, 0);
1930             SvIsUV_on(sv);
1931             return FALSE;
1932         }
1933 #endif
1934         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1935             SvIV_set(sv, I_V(SvNVX(sv)));
1936             if (SvNVX(sv) == (NV) SvIVX(sv)
1937 #ifndef NV_PRESERVES_UV
1938                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1939                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1940                 /* Don't flag it as "accurately an integer" if the number
1941                    came from a (by definition imprecise) NV operation, and
1942                    we're outside the range of NV integer precision */
1943 #endif
1944                 ) {
1945                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
1946                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1947                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1948                                       PTR2UV(sv),
1949                                       SvNVX(sv),
1950                                       SvIVX(sv)));
1951
1952             } else {
1953                 /* IV not precise.  No need to convert from PV, as NV
1954                    conversion would already have cached IV if it detected
1955                    that PV->IV would be better than PV->NV->IV
1956                    flags already correct - don't set public IOK.  */
1957                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1958                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1959                                       PTR2UV(sv),
1960                                       SvNVX(sv),
1961                                       SvIVX(sv)));
1962             }
1963             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1964                but the cast (NV)IV_MIN rounds to a the value less (more
1965                negative) than IV_MIN which happens to be equal to SvNVX ??
1966                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1967                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1968                (NV)UVX == NVX are both true, but the values differ. :-(
1969                Hopefully for 2s complement IV_MIN is something like
1970                0x8000000000000000 which will be exact. NWC */
1971         }
1972         else {
1973             SvUV_set(sv, U_V(SvNVX(sv)));
1974             if (
1975                 (SvNVX(sv) == (NV) SvUVX(sv))
1976 #ifndef  NV_PRESERVES_UV
1977                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1978                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1979                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1980                 /* Don't flag it as "accurately an integer" if the number
1981                    came from a (by definition imprecise) NV operation, and
1982                    we're outside the range of NV integer precision */
1983 #endif
1984                 )
1985                 SvIOK_on(sv);
1986             SvIsUV_on(sv);
1987             DEBUG_c(PerlIO_printf(Perl_debug_log,
1988                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1989                                   PTR2UV(sv),
1990                                   SvUVX(sv),
1991                                   SvUVX(sv)));
1992         }
1993     }
1994     else if (SvPOKp(sv) && SvLEN(sv)) {
1995         UV value;
1996         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1997         /* We want to avoid a possible problem when we cache an IV/ a UV which
1998            may be later translated to an NV, and the resulting NV is not
1999            the same as the direct translation of the initial string
2000            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2001            be careful to ensure that the value with the .456 is around if the
2002            NV value is requested in the future).
2003         
2004            This means that if we cache such an IV/a UV, we need to cache the
2005            NV as well.  Moreover, we trade speed for space, and do not
2006            cache the NV if we are sure it's not needed.
2007          */
2008
2009         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2010         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2011              == IS_NUMBER_IN_UV) {
2012             /* It's definitely an integer, only upgrade to PVIV */
2013             if (SvTYPE(sv) < SVt_PVIV)
2014                 sv_upgrade(sv, SVt_PVIV);
2015             (void)SvIOK_on(sv);
2016         } else if (SvTYPE(sv) < SVt_PVNV)
2017             sv_upgrade(sv, SVt_PVNV);
2018
2019         /* If NVs preserve UVs then we only use the UV value if we know that
2020            we aren't going to call atof() below. If NVs don't preserve UVs
2021            then the value returned may have more precision than atof() will
2022            return, even though value isn't perfectly accurate.  */
2023         if ((numtype & (IS_NUMBER_IN_UV
2024 #ifdef NV_PRESERVES_UV
2025                         | IS_NUMBER_NOT_INT
2026 #endif
2027             )) == IS_NUMBER_IN_UV) {
2028             /* This won't turn off the public IOK flag if it was set above  */
2029             (void)SvIOKp_on(sv);
2030
2031             if (!(numtype & IS_NUMBER_NEG)) {
2032                 /* positive */;
2033                 if (value <= (UV)IV_MAX) {
2034                     SvIV_set(sv, (IV)value);
2035                 } else {
2036                     /* it didn't overflow, and it was positive. */
2037                     SvUV_set(sv, value);
2038                     SvIsUV_on(sv);
2039                 }
2040             } else {
2041                 /* 2s complement assumption  */
2042                 if (value <= (UV)IV_MIN) {
2043                     SvIV_set(sv, -(IV)value);
2044                 } else {
2045                     /* Too negative for an IV.  This is a double upgrade, but
2046                        I'm assuming it will be rare.  */
2047                     if (SvTYPE(sv) < SVt_PVNV)
2048                         sv_upgrade(sv, SVt_PVNV);
2049                     SvNOK_on(sv);
2050                     SvIOK_off(sv);
2051                     SvIOKp_on(sv);
2052                     SvNV_set(sv, -(NV)value);
2053                     SvIV_set(sv, IV_MIN);
2054                 }
2055             }
2056         }
2057         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2058            will be in the previous block to set the IV slot, and the next
2059            block to set the NV slot.  So no else here.  */
2060         
2061         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2062             != IS_NUMBER_IN_UV) {
2063             /* It wasn't an (integer that doesn't overflow the UV). */
2064             SvNV_set(sv, Atof(SvPVX_const(sv)));
2065
2066             if (! numtype && ckWARN(WARN_NUMERIC))
2067                 not_a_number(sv);
2068
2069 #if defined(USE_LONG_DOUBLE)
2070             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2071                                   PTR2UV(sv), SvNVX(sv)));
2072 #else
2073             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2074                                   PTR2UV(sv), SvNVX(sv)));
2075 #endif
2076
2077 #ifdef NV_PRESERVES_UV
2078             (void)SvIOKp_on(sv);
2079             (void)SvNOK_on(sv);
2080             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2081                 SvIV_set(sv, I_V(SvNVX(sv)));
2082                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2083                     SvIOK_on(sv);
2084                 } else {
2085                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2086                 }
2087                 /* UV will not work better than IV */
2088             } else {
2089                 if (SvNVX(sv) > (NV)UV_MAX) {
2090                     SvIsUV_on(sv);
2091                     /* Integer is inaccurate. NOK, IOKp, is UV */
2092                     SvUV_set(sv, UV_MAX);
2093                 } else {
2094                     SvUV_set(sv, U_V(SvNVX(sv)));
2095                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2096                        NV preservse UV so can do correct comparison.  */
2097                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2098                         SvIOK_on(sv);
2099                     } else {
2100                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2101                     }
2102                 }
2103                 SvIsUV_on(sv);
2104             }
2105 #else /* NV_PRESERVES_UV */
2106             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2107                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2108                 /* The IV/UV slot will have been set from value returned by
2109                    grok_number above.  The NV slot has just been set using
2110                    Atof.  */
2111                 SvNOK_on(sv);
2112                 assert (SvIOKp(sv));
2113             } else {
2114                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2115                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2116                     /* Small enough to preserve all bits. */
2117                     (void)SvIOKp_on(sv);
2118                     SvNOK_on(sv);
2119                     SvIV_set(sv, I_V(SvNVX(sv)));
2120                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2121                         SvIOK_on(sv);
2122                     /* Assumption: first non-preserved integer is < IV_MAX,
2123                        this NV is in the preserved range, therefore: */
2124                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2125                           < (UV)IV_MAX)) {
2126                         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);
2127                     }
2128                 } else {
2129                     /* IN_UV NOT_INT
2130                          0      0       already failed to read UV.
2131                          0      1       already failed to read UV.
2132                          1      0       you won't get here in this case. IV/UV
2133                                         slot set, public IOK, Atof() unneeded.
2134                          1      1       already read UV.
2135                        so there's no point in sv_2iuv_non_preserve() attempting
2136                        to use atol, strtol, strtoul etc.  */
2137                     sv_2iuv_non_preserve (sv, numtype);
2138                 }
2139             }
2140 #endif /* NV_PRESERVES_UV */
2141         }
2142     }
2143     else  {
2144         if (isGV_with_GP(sv))
2145             return glob_2number((GV *)sv);
2146
2147         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2148             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2149                 report_uninit(sv);
2150         }
2151         if (SvTYPE(sv) < SVt_IV)
2152             /* Typically the caller expects that sv_any is not NULL now.  */
2153             sv_upgrade(sv, SVt_IV);
2154         /* Return 0 from the caller.  */
2155         return TRUE;
2156     }
2157     return FALSE;
2158 }
2159
2160 /*
2161 =for apidoc sv_2iv_flags
2162
2163 Return the integer value of an SV, doing any necessary string
2164 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2165 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2166
2167 =cut
2168 */
2169
2170 IV
2171 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2172 {
2173     dVAR;
2174     if (!sv)
2175         return 0;
2176     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2177         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2178            cache IVs just in case. In practice it seems that they never
2179            actually anywhere accessible by user Perl code, let alone get used
2180            in anything other than a string context.  */
2181         if (flags & SV_GMAGIC)
2182             mg_get(sv);
2183         if (SvIOKp(sv))
2184             return SvIVX(sv);
2185         if (SvNOKp(sv)) {
2186             return I_V(SvNVX(sv));
2187         }
2188         if (SvPOKp(sv) && SvLEN(sv)) {
2189             UV value;
2190             const int numtype
2191                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2192
2193             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2194                 == IS_NUMBER_IN_UV) {
2195                 /* It's definitely an integer */
2196                 if (numtype & IS_NUMBER_NEG) {
2197                     if (value < (UV)IV_MIN)
2198                         return -(IV)value;
2199                 } else {
2200                     if (value < (UV)IV_MAX)
2201                         return (IV)value;
2202                 }
2203             }
2204             if (!numtype) {
2205                 if (ckWARN(WARN_NUMERIC))
2206                     not_a_number(sv);
2207             }
2208             return I_V(Atof(SvPVX_const(sv)));
2209         }
2210         if (SvROK(sv)) {
2211             goto return_rok;
2212         }
2213         assert(SvTYPE(sv) >= SVt_PVMG);
2214         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2215     } else if (SvTHINKFIRST(sv)) {
2216         if (SvROK(sv)) {
2217         return_rok:
2218             if (SvAMAGIC(sv)) {
2219                 SV * const tmpstr=AMG_CALLun(sv,numer);
2220                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2221                     return SvIV(tmpstr);
2222                 }
2223             }
2224             return PTR2IV(SvRV(sv));
2225         }
2226         if (SvIsCOW(sv)) {
2227             sv_force_normal_flags(sv, 0);
2228         }
2229         if (SvREADONLY(sv) && !SvOK(sv)) {
2230             if (ckWARN(WARN_UNINITIALIZED))
2231                 report_uninit(sv);
2232             return 0;
2233         }
2234     }
2235     if (!SvIOKp(sv)) {
2236         if (S_sv_2iuv_common(aTHX_ sv))
2237             return 0;
2238     }
2239     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2240         PTR2UV(sv),SvIVX(sv)));
2241     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2242 }
2243
2244 /*
2245 =for apidoc sv_2uv_flags
2246
2247 Return the unsigned integer value of an SV, doing any necessary string
2248 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2249 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2250
2251 =cut
2252 */
2253
2254 UV
2255 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2256 {
2257     dVAR;
2258     if (!sv)
2259         return 0;
2260     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2261         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2262            cache IVs just in case.  */
2263         if (flags & SV_GMAGIC)
2264             mg_get(sv);
2265         if (SvIOKp(sv))
2266             return SvUVX(sv);
2267         if (SvNOKp(sv))
2268             return U_V(SvNVX(sv));
2269         if (SvPOKp(sv) && SvLEN(sv)) {
2270             UV value;
2271             const int numtype
2272                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2273
2274             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2275                 == IS_NUMBER_IN_UV) {
2276                 /* It's definitely an integer */
2277                 if (!(numtype & IS_NUMBER_NEG))
2278                     return value;
2279             }
2280             if (!numtype) {
2281                 if (ckWARN(WARN_NUMERIC))
2282                     not_a_number(sv);
2283             }
2284             return U_V(Atof(SvPVX_const(sv)));
2285         }
2286         if (SvROK(sv)) {
2287             goto return_rok;
2288         }
2289         assert(SvTYPE(sv) >= SVt_PVMG);
2290         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2291     } else if (SvTHINKFIRST(sv)) {
2292         if (SvROK(sv)) {
2293         return_rok:
2294             if (SvAMAGIC(sv)) {
2295                 SV *const tmpstr = AMG_CALLun(sv,numer);
2296                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2297                     return SvUV(tmpstr);
2298                 }
2299             }
2300             return PTR2UV(SvRV(sv));
2301         }
2302         if (SvIsCOW(sv)) {
2303             sv_force_normal_flags(sv, 0);
2304         }
2305         if (SvREADONLY(sv) && !SvOK(sv)) {
2306             if (ckWARN(WARN_UNINITIALIZED))
2307                 report_uninit(sv);
2308             return 0;
2309         }
2310     }
2311     if (!SvIOKp(sv)) {
2312         if (S_sv_2iuv_common(aTHX_ sv))
2313             return 0;
2314     }
2315
2316     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2317                           PTR2UV(sv),SvUVX(sv)));
2318     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2319 }
2320
2321 /*
2322 =for apidoc sv_2nv
2323
2324 Return the num value of an SV, doing any necessary string or integer
2325 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2326 macros.
2327
2328 =cut
2329 */
2330
2331 NV
2332 Perl_sv_2nv(pTHX_ register SV *sv)
2333 {
2334     dVAR;
2335     if (!sv)
2336         return 0.0;
2337     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2338         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2339            cache IVs just in case.  */
2340         mg_get(sv);
2341         if (SvNOKp(sv))
2342             return SvNVX(sv);
2343         if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2344             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2345                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2346                 not_a_number(sv);
2347             return Atof(SvPVX_const(sv));
2348         }
2349         if (SvIOKp(sv)) {
2350             if (SvIsUV(sv))
2351                 return (NV)SvUVX(sv);
2352             else
2353                 return (NV)SvIVX(sv);
2354         }
2355         if (SvROK(sv)) {
2356             goto return_rok;
2357         }
2358         assert(SvTYPE(sv) >= SVt_PVMG);
2359         /* This falls through to the report_uninit near the end of the
2360            function. */
2361     } else if (SvTHINKFIRST(sv)) {
2362         if (SvROK(sv)) {
2363         return_rok:
2364             if (SvAMAGIC(sv)) {
2365                 SV *const tmpstr = AMG_CALLun(sv,numer);
2366                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2367                     return SvNV(tmpstr);
2368                 }
2369             }
2370             return PTR2NV(SvRV(sv));
2371         }
2372         if (SvIsCOW(sv)) {
2373             sv_force_normal_flags(sv, 0);
2374         }
2375         if (SvREADONLY(sv) && !SvOK(sv)) {
2376             if (ckWARN(WARN_UNINITIALIZED))
2377                 report_uninit(sv);
2378             return 0.0;
2379         }
2380     }
2381     if (SvTYPE(sv) < SVt_NV) {
2382         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2383         sv_upgrade(sv, SVt_NV);
2384 #ifdef USE_LONG_DOUBLE
2385         DEBUG_c({
2386             STORE_NUMERIC_LOCAL_SET_STANDARD();
2387             PerlIO_printf(Perl_debug_log,
2388                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2389                           PTR2UV(sv), SvNVX(sv));
2390             RESTORE_NUMERIC_LOCAL();
2391         });
2392 #else
2393         DEBUG_c({
2394             STORE_NUMERIC_LOCAL_SET_STANDARD();
2395             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2396                           PTR2UV(sv), SvNVX(sv));
2397             RESTORE_NUMERIC_LOCAL();
2398         });
2399 #endif
2400     }
2401     else if (SvTYPE(sv) < SVt_PVNV)
2402         sv_upgrade(sv, SVt_PVNV);
2403     if (SvNOKp(sv)) {
2404         return SvNVX(sv);
2405     }
2406     if (SvIOKp(sv)) {
2407         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2408 #ifdef NV_PRESERVES_UV
2409         SvNOK_on(sv);
2410 #else
2411         /* Only set the public NV OK flag if this NV preserves the IV  */
2412         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2413         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2414                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2415             SvNOK_on(sv);
2416         else
2417             SvNOKp_on(sv);
2418 #endif
2419     }
2420     else if (SvPOKp(sv) && SvLEN(sv)) {
2421         UV value;
2422         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2423         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2424             not_a_number(sv);
2425 #ifdef NV_PRESERVES_UV
2426         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2427             == IS_NUMBER_IN_UV) {
2428             /* It's definitely an integer */
2429             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2430         } else
2431             SvNV_set(sv, Atof(SvPVX_const(sv)));
2432         SvNOK_on(sv);
2433 #else
2434         SvNV_set(sv, Atof(SvPVX_const(sv)));
2435         /* Only set the public NV OK flag if this NV preserves the value in
2436            the PV at least as well as an IV/UV would.
2437            Not sure how to do this 100% reliably. */
2438         /* if that shift count is out of range then Configure's test is
2439            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2440            UV_BITS */
2441         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2442             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2443             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2444         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2445             /* Can't use strtol etc to convert this string, so don't try.
2446                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2447             SvNOK_on(sv);
2448         } else {
2449             /* value has been set.  It may not be precise.  */
2450             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2451                 /* 2s complement assumption for (UV)IV_MIN  */
2452                 SvNOK_on(sv); /* Integer is too negative.  */
2453             } else {
2454                 SvNOKp_on(sv);
2455                 SvIOKp_on(sv);
2456
2457                 if (numtype & IS_NUMBER_NEG) {
2458                     SvIV_set(sv, -(IV)value);
2459                 } else if (value <= (UV)IV_MAX) {
2460                     SvIV_set(sv, (IV)value);
2461                 } else {
2462                     SvUV_set(sv, value);
2463                     SvIsUV_on(sv);
2464                 }
2465
2466                 if (numtype & IS_NUMBER_NOT_INT) {
2467                     /* I believe that even if the original PV had decimals,
2468                        they are lost beyond the limit of the FP precision.
2469                        However, neither is canonical, so both only get p
2470                        flags.  NWC, 2000/11/25 */
2471                     /* Both already have p flags, so do nothing */
2472                 } else {
2473                     const NV nv = SvNVX(sv);
2474                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2475                         if (SvIVX(sv) == I_V(nv)) {
2476                             SvNOK_on(sv);
2477                         } else {
2478                             /* It had no "." so it must be integer.  */
2479                         }
2480                         SvIOK_on(sv);
2481                     } else {
2482                         /* between IV_MAX and NV(UV_MAX).
2483                            Could be slightly > UV_MAX */
2484
2485                         if (numtype & IS_NUMBER_NOT_INT) {
2486                             /* UV and NV both imprecise.  */
2487                         } else {
2488                             const UV nv_as_uv = U_V(nv);
2489
2490                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2491                                 SvNOK_on(sv);
2492                             }
2493                             SvIOK_on(sv);
2494                         }
2495                     }
2496                 }
2497             }
2498         }
2499 #endif /* NV_PRESERVES_UV */
2500     }
2501     else  {
2502         if (isGV_with_GP(sv)) {
2503             glob_2number((GV *)sv);
2504             return 0.0;
2505         }
2506
2507         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2508             report_uninit(sv);
2509         assert (SvTYPE(sv) >= SVt_NV);
2510         /* Typically the caller expects that sv_any is not NULL now.  */
2511         /* XXX Ilya implies that this is a bug in callers that assume this
2512            and ideally should be fixed.  */
2513         return 0.0;
2514     }
2515 #if defined(USE_LONG_DOUBLE)
2516     DEBUG_c({
2517         STORE_NUMERIC_LOCAL_SET_STANDARD();
2518         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2519                       PTR2UV(sv), SvNVX(sv));
2520         RESTORE_NUMERIC_LOCAL();
2521     });
2522 #else
2523     DEBUG_c({
2524         STORE_NUMERIC_LOCAL_SET_STANDARD();
2525         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2526                       PTR2UV(sv), SvNVX(sv));
2527         RESTORE_NUMERIC_LOCAL();
2528     });
2529 #endif
2530     return SvNVX(sv);
2531 }
2532
2533 /*
2534 =for apidoc sv_2num
2535
2536 Return an SV with the numeric value of the source SV, doing any necessary
2537 reference or overload conversion.  You must use the C<SvNUM(sv)> macro to
2538 access this function.
2539
2540 =cut
2541 */
2542
2543 SV *
2544 Perl_sv_2num(pTHX_ register SV *sv)
2545 {
2546     if (!SvROK(sv))
2547         return sv;
2548     if (SvAMAGIC(sv)) {
2549         SV * const tmpsv = AMG_CALLun(sv,numer);
2550         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2551             return sv_2num(tmpsv);
2552     }
2553     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2554 }
2555
2556 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2557  * UV as a string towards the end of buf, and return pointers to start and
2558  * end of it.
2559  *
2560  * We assume that buf is at least TYPE_CHARS(UV) long.
2561  */
2562
2563 static char *
2564 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2565 {
2566     char *ptr = buf + TYPE_CHARS(UV);
2567     char * const ebuf = ptr;
2568     int sign;
2569
2570     if (is_uv)
2571         sign = 0;
2572     else if (iv >= 0) {
2573         uv = iv;
2574         sign = 0;
2575     } else {
2576         uv = -iv;
2577         sign = 1;
2578     }
2579     do {
2580         *--ptr = '0' + (char)(uv % 10);
2581     } while (uv /= 10);
2582     if (sign)
2583         *--ptr = '-';
2584     *peob = ebuf;
2585     return ptr;
2586 }
2587
2588 /*
2589 =for apidoc sv_2pv_flags
2590
2591 Returns a pointer to the string value of an SV, and sets *lp to its length.
2592 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2593 if necessary.
2594 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2595 usually end up here too.
2596
2597 =cut
2598 */
2599
2600 char *
2601 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2602 {
2603     dVAR;
2604     register char *s;
2605
2606     if (!sv) {
2607         if (lp)
2608             *lp = 0;
2609         return (char *)"";
2610     }
2611     if (SvGMAGICAL(sv)) {
2612         if (flags & SV_GMAGIC)
2613             mg_get(sv);
2614         if (SvPOKp(sv)) {
2615             if (lp)
2616                 *lp = SvCUR(sv);
2617             if (flags & SV_MUTABLE_RETURN)
2618                 return SvPVX_mutable(sv);
2619             if (flags & SV_CONST_RETURN)
2620                 return (char *)SvPVX_const(sv);
2621             return SvPVX(sv);
2622         }
2623         if (SvIOKp(sv) || SvNOKp(sv)) {
2624             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2625             STRLEN len;
2626
2627             if (SvIOKp(sv)) {
2628                 len = SvIsUV(sv)
2629                     ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2630                     : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2631             } else {
2632                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2633                 len = strlen(tbuf);
2634             }
2635             assert(!SvROK(sv));
2636             {
2637                 dVAR;
2638
2639 #ifdef FIXNEGATIVEZERO
2640                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2641                     tbuf[0] = '0';
2642                     tbuf[1] = 0;
2643                     len = 1;
2644                 }
2645 #endif
2646                 SvUPGRADE(sv, SVt_PV);
2647                 if (lp)
2648                     *lp = len;
2649                 s = SvGROW_mutable(sv, len + 1);
2650                 SvCUR_set(sv, len);
2651                 SvPOKp_on(sv);
2652                 return (char*)memcpy(s, tbuf, len + 1);
2653             }
2654         }
2655         if (SvROK(sv)) {
2656             goto return_rok;
2657         }
2658         assert(SvTYPE(sv) >= SVt_PVMG);
2659         /* This falls through to the report_uninit near the end of the
2660            function. */
2661     } else if (SvTHINKFIRST(sv)) {
2662         if (SvROK(sv)) {
2663         return_rok:
2664             if (SvAMAGIC(sv)) {
2665                 SV *const tmpstr = AMG_CALLun(sv,string);
2666                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2667                     /* Unwrap this:  */
2668                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2669                      */
2670
2671                     char *pv;
2672                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2673                         if (flags & SV_CONST_RETURN) {
2674                             pv = (char *) SvPVX_const(tmpstr);
2675                         } else {
2676                             pv = (flags & SV_MUTABLE_RETURN)
2677                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2678                         }
2679                         if (lp)
2680                             *lp = SvCUR(tmpstr);
2681                     } else {
2682                         pv = sv_2pv_flags(tmpstr, lp, flags);
2683                     }
2684                     if (SvUTF8(tmpstr))
2685                         SvUTF8_on(sv);
2686                     else
2687                         SvUTF8_off(sv);
2688                     return pv;
2689                 }
2690             }
2691             {
2692                 STRLEN len;
2693                 char *retval;
2694                 char *buffer;
2695                 MAGIC *mg;
2696                 const SV *const referent = (SV*)SvRV(sv);
2697
2698                 if (!referent) {
2699                     len = 7;
2700                     retval = buffer = savepvn("NULLREF", len);
2701                 } else if (SvTYPE(referent) == SVt_ORANGE
2702                            && ((SvFLAGS(referent) &
2703                                 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2704                                == (SVs_OBJECT|SVs_SMG))
2705                            && (mg = mg_find(referent, PERL_MAGIC_qr)))
2706                 {
2707                     char *str = NULL;
2708                     I32 haseval = 0;
2709                     U32 flags = 0;
2710                     (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2711                     if (flags & 1)
2712                         SvUTF8_on(sv);
2713                     else
2714                         SvUTF8_off(sv);
2715                     PL_reginterp_cnt += haseval;
2716                     return str;
2717                 } else {
2718                     const char *const typestr = sv_reftype(referent, 0);
2719                     const STRLEN typelen = strlen(typestr);
2720                     UV addr = PTR2UV(referent);
2721                     const char *stashname = NULL;
2722                     STRLEN stashnamelen = 0; /* hush, gcc */
2723                     const char *buffer_end;
2724
2725                     if (SvOBJECT(referent)) {
2726                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2727
2728                         if (name) {
2729                             stashname = HEK_KEY(name);
2730                             stashnamelen = HEK_LEN(name);
2731
2732                             if (HEK_UTF8(name)) {
2733                                 SvUTF8_on(sv);
2734                             } else {
2735                                 SvUTF8_off(sv);
2736                             }
2737                         } else {
2738                             stashname = "__ANON__";
2739                             stashnamelen = 8;
2740                         }
2741                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2742                             + 2 * sizeof(UV) + 2 /* )\0 */;
2743                     } else {
2744                         len = typelen + 3 /* (0x */
2745                             + 2 * sizeof(UV) + 2 /* )\0 */;
2746                     }
2747
2748                     Newx(buffer, len, char);
2749                     buffer_end = retval = buffer + len;
2750
2751                     /* Working backwards  */
2752                     *--retval = '\0';
2753                     *--retval = ')';
2754                     do {
2755                         *--retval = PL_hexdigit[addr & 15];
2756                     } while (addr >>= 4);
2757                     *--retval = 'x';
2758                     *--retval = '0';
2759                     *--retval = '(';
2760
2761                     retval -= typelen;
2762                     memcpy(retval, typestr, typelen);
2763
2764                     if (stashname) {
2765                         *--retval = '=';
2766                         retval -= stashnamelen;
2767                         memcpy(retval, stashname, stashnamelen);
2768                     }
2769                     /* retval may not neccesarily have reached the start of the
2770                        buffer here.  */
2771                     assert (retval >= buffer);
2772
2773                     len = buffer_end - retval - 1; /* -1 for that \0  */
2774                 }
2775                 if (lp)
2776                     *lp = len;
2777                 SAVEFREEPV(buffer);
2778                 return retval;
2779             }
2780         }
2781         if (SvREADONLY(sv) && !SvOK(sv)) {
2782             if (ckWARN(WARN_UNINITIALIZED))
2783                 report_uninit(sv);
2784             if (lp)
2785                 *lp = 0;
2786             return (char *)"";
2787         }
2788     }
2789     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2790         /* I'm assuming that if both IV and NV are equally valid then
2791            converting the IV is going to be more efficient */
2792         const U32 isUIOK = SvIsUV(sv);
2793         char buf[TYPE_CHARS(UV)];
2794         char *ebuf, *ptr;
2795         STRLEN len;
2796
2797         if (SvTYPE(sv) < SVt_PVIV)
2798             sv_upgrade(sv, SVt_PVIV);
2799         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2800         len = ebuf - ptr;
2801         /* inlined from sv_setpvn */
2802         s = SvGROW_mutable(sv, len + 1);
2803         Move(ptr, s, len, char);
2804         s += len;
2805         *s = '\0';
2806     }
2807     else if (SvNOKp(sv)) {
2808         const int olderrno = errno;
2809         if (SvTYPE(sv) < SVt_PVNV)
2810             sv_upgrade(sv, SVt_PVNV);
2811         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2812         s = SvGROW_mutable(sv, NV_DIG + 20);
2813         /* some Xenix systems wipe out errno here */
2814 #ifdef apollo
2815         if (SvNVX(sv) == 0.0)
2816             my_strlcpy(s, "0", SvLEN(sv));
2817         else
2818 #endif /*apollo*/
2819         {
2820             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2821         }
2822         errno = olderrno;
2823 #ifdef FIXNEGATIVEZERO
2824         if (*s == '-' && s[1] == '0' && !s[2]) {
2825             s[0] = '0';
2826             s[1] = 0;
2827         }
2828 #endif
2829         while (*s) s++;
2830 #ifdef hcx
2831         if (s[-1] == '.')
2832             *--s = '\0';
2833 #endif
2834     }
2835     else {
2836         if (isGV_with_GP(sv))
2837             return glob_2pv((GV *)sv, lp);
2838
2839         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2840             report_uninit(sv);
2841         if (lp)
2842             *lp = 0;
2843         if (SvTYPE(sv) < SVt_PV)
2844             /* Typically the caller expects that sv_any is not NULL now.  */
2845             sv_upgrade(sv, SVt_PV);
2846         return (char *)"";
2847     }
2848     {
2849         const STRLEN len = s - SvPVX_const(sv);
2850         if (lp) 
2851             *lp = len;
2852         SvCUR_set(sv, len);
2853     }
2854     SvPOK_on(sv);
2855     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2856                           PTR2UV(sv),SvPVX_const(sv)));
2857     if (flags & SV_CONST_RETURN)
2858         return (char *)SvPVX_const(sv);
2859     if (flags & SV_MUTABLE_RETURN)
2860         return SvPVX_mutable(sv);
2861     return SvPVX(sv);
2862 }
2863
2864 /*
2865 =for apidoc sv_copypv
2866
2867 Copies a stringified representation of the source SV into the
2868 destination SV.  Automatically performs any necessary mg_get and
2869 coercion of numeric values into strings.  Guaranteed to preserve
2870 UTF8 flag even from overloaded objects.  Similar in nature to
2871 sv_2pv[_flags] but operates directly on an SV instead of just the
2872 string.  Mostly uses sv_2pv_flags to do its work, except when that
2873 would lose the UTF-8'ness of the PV.
2874
2875 =cut
2876 */
2877
2878 void
2879 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2880 {
2881     STRLEN len;
2882     const char * const s = SvPV_const(ssv,len);
2883     sv_setpvn(dsv,s,len);
2884     if (SvUTF8(ssv))
2885         SvUTF8_on(dsv);
2886     else
2887         SvUTF8_off(dsv);
2888 }
2889
2890 /*
2891 =for apidoc sv_2pvbyte
2892
2893 Return a pointer to the byte-encoded representation of the SV, and set *lp
2894 to its length.  May cause the SV to be downgraded from UTF-8 as a
2895 side-effect.
2896
2897 Usually accessed via the C<SvPVbyte> macro.
2898
2899 =cut
2900 */
2901
2902 char *
2903 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2904 {
2905     sv_utf8_downgrade(sv,0);
2906     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2907 }
2908
2909 /*
2910 =for apidoc sv_2pvutf8
2911
2912 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2913 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2914
2915 Usually accessed via the C<SvPVutf8> macro.
2916
2917 =cut
2918 */
2919
2920 char *
2921 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2922 {
2923     sv_utf8_upgrade(sv);
2924     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2925 }
2926
2927
2928 /*
2929 =for apidoc sv_2bool
2930
2931 This function is only called on magical items, and is only used by
2932 sv_true() or its macro equivalent.
2933
2934 =cut
2935 */
2936
2937 bool
2938 Perl_sv_2bool(pTHX_ register SV *sv)
2939 {
2940     dVAR;
2941     SvGETMAGIC(sv);
2942
2943     if (!SvOK(sv))
2944         return 0;
2945     if (SvROK(sv)) {
2946         if (SvAMAGIC(sv)) {
2947             SV * const tmpsv = AMG_CALLun(sv,bool_);
2948             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2949                 return (bool)SvTRUE(tmpsv);
2950         }
2951         return SvRV(sv) != 0;
2952     }
2953     if (SvPOKp(sv)) {
2954         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2955         if (Xpvtmp &&
2956                 (*sv->sv_u.svu_pv > '0' ||
2957                 Xpvtmp->xpv_cur > 1 ||
2958                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2959             return 1;
2960         else
2961             return 0;
2962     }
2963     else {
2964         if (SvIOKp(sv))
2965             return SvIVX(sv) != 0;
2966         else {
2967             if (SvNOKp(sv))
2968                 return SvNVX(sv) != 0.0;
2969             else {
2970                 if (isGV_with_GP(sv))
2971                     return TRUE;
2972                 else
2973                     return FALSE;
2974             }
2975         }
2976     }
2977 }
2978
2979 /*
2980 =for apidoc sv_utf8_upgrade
2981
2982 Converts the PV of an SV to its UTF-8-encoded form.
2983 Forces the SV to string form if it is not already.
2984 Always sets the SvUTF8 flag to avoid future validity checks even
2985 if all the bytes have hibit clear.
2986
2987 This is not as a general purpose byte encoding to Unicode interface:
2988 use the Encode extension for that.
2989
2990 =for apidoc sv_utf8_upgrade_flags
2991
2992 Converts the PV of an SV to its UTF-8-encoded form.
2993 Forces the SV to string form if it is not already.
2994 Always sets the SvUTF8 flag to avoid future validity checks even
2995 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2996 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2997 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2998
2999 This is not as a general purpose byte encoding to Unicode interface:
3000 use the Encode extension for that.
3001
3002 =cut
3003 */
3004
3005 STRLEN
3006 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3007 {
3008     dVAR;
3009     if (sv == &PL_sv_undef)
3010         return 0;
3011     if (!SvPOK(sv)) {
3012         STRLEN len = 0;
3013         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3014             (void) sv_2pv_flags(sv,&len, flags);
3015             if (SvUTF8(sv))
3016                 return len;
3017         } else {
3018             (void) SvPV_force(sv,len);
3019         }
3020     }
3021
3022     if (SvUTF8(sv)) {
3023         return SvCUR(sv);
3024     }
3025
3026     if (SvIsCOW(sv)) {
3027         sv_force_normal_flags(sv, 0);
3028     }
3029
3030     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3031         sv_recode_to_utf8(sv, PL_encoding);
3032     else { /* Assume Latin-1/EBCDIC */
3033         /* This function could be much more efficient if we
3034          * had a FLAG in SVs to signal if there are any hibit
3035          * chars in the PV.  Given that there isn't such a flag
3036          * make the loop as fast as possible. */
3037         const U8 * const s = (U8 *) SvPVX_const(sv);
3038         const U8 * const e = (U8 *) SvEND(sv);
3039         const U8 *t = s;
3040         
3041         while (t < e) {
3042             const U8 ch = *t++;
3043             /* Check for hi bit */
3044             if (!NATIVE_IS_INVARIANT(ch)) {
3045                 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3046                 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3047
3048                 SvPV_free(sv); /* No longer using what was there before. */
3049                 SvPV_set(sv, (char*)recoded);
3050                 SvCUR_set(sv, len - 1);
3051                 SvLEN_set(sv, len); /* No longer know the real size. */
3052                 break;
3053             }
3054         }
3055         /* Mark as UTF-8 even if no hibit - saves scanning loop */
3056         SvUTF8_on(sv);
3057     }
3058     return SvCUR(sv);
3059 }
3060
3061 /*
3062 =for apidoc sv_utf8_downgrade
3063
3064 Attempts to convert the PV of an SV from characters to bytes.
3065 If the PV contains a character beyond byte, this conversion will fail;
3066 in this case, either returns false or, if C<fail_ok> is not
3067 true, croaks.
3068
3069 This is not as a general purpose Unicode to byte encoding interface:
3070 use the Encode extension for that.
3071
3072 =cut
3073 */
3074
3075 bool
3076 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3077 {
3078     dVAR;
3079     if (SvPOKp(sv) && SvUTF8(sv)) {
3080         if (SvCUR(sv)) {
3081             U8 *s;
3082             STRLEN len;
3083
3084             if (SvIsCOW(sv)) {
3085                 sv_force_normal_flags(sv, 0);
3086             }
3087             s = (U8 *) SvPV(sv, len);
3088             if (!utf8_to_bytes(s, &len)) {
3089                 if (fail_ok)
3090                     return FALSE;
3091                 else {
3092                     if (PL_op)
3093                         Perl_croak(aTHX_ "Wide character in %s",
3094                                    OP_DESC(PL_op));
3095                     else
3096                         Perl_croak(aTHX_ "Wide character");
3097                 }
3098             }
3099             SvCUR_set(sv, len);
3100         }
3101     }
3102     SvUTF8_off(sv);
3103     return TRUE;
3104 }
3105
3106 /*
3107 =for apidoc sv_utf8_encode
3108
3109 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3110 flag off so that it looks like octets again.
3111
3112 =cut
3113 */
3114
3115 void
3116 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3117 {
3118     if (SvIsCOW(sv)) {
3119         sv_force_normal_flags(sv, 0);
3120     }
3121     if (SvREADONLY(sv)) {
3122         Perl_croak(aTHX_ PL_no_modify);
3123     }
3124     (void) sv_utf8_upgrade(sv);
3125     SvUTF8_off(sv);
3126 }
3127
3128 /*
3129 =for apidoc sv_utf8_decode
3130
3131 If the PV of the SV is an octet sequence in UTF-8
3132 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3133 so that it looks like a character. If the PV contains only single-byte
3134 characters, the C<SvUTF8> flag stays being off.
3135 Scans PV for validity and returns false if the PV is invalid UTF-8.
3136
3137 =cut
3138 */
3139
3140 bool
3141 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3142 {
3143     if (SvPOKp(sv)) {
3144         const U8 *c;
3145         const U8 *e;
3146
3147         /* The octets may have got themselves encoded - get them back as
3148          * bytes
3149          */
3150         if (!sv_utf8_downgrade(sv, TRUE))
3151             return FALSE;
3152
3153         /* it is actually just a matter of turning the utf8 flag on, but
3154          * we want to make sure everything inside is valid utf8 first.
3155          */
3156         c = (const U8 *) SvPVX_const(sv);
3157         if (!is_utf8_string(c, SvCUR(sv)+1))
3158             return FALSE;
3159         e = (const U8 *) SvEND(sv);
3160         while (c < e) {
3161             const U8 ch = *c++;
3162             if (!UTF8_IS_INVARIANT(ch)) {
3163                 SvUTF8_on(sv);
3164                 break;
3165             }
3166         }
3167     }
3168     return TRUE;
3169 }
3170
3171 /*
3172 =for apidoc sv_setsv
3173
3174 Copies the contents of the source SV C<ssv> into the destination SV
3175 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3176 function if the source SV needs to be reused. Does not handle 'set' magic.
3177 Loosely speaking, it performs a copy-by-value, obliterating any previous
3178 content of the destination.
3179
3180 You probably want to use one of the assortment of wrappers, such as
3181 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3182 C<SvSetMagicSV_nosteal>.
3183
3184 =for apidoc sv_setsv_flags
3185
3186 Copies the contents of the source SV C<ssv> into the destination SV
3187 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3188 function if the source SV needs to be reused. Does not handle 'set' magic.
3189 Loosely speaking, it performs a copy-by-value, obliterating any previous
3190 content of the destination.
3191 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3192 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3193 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3194 and C<sv_setsv_nomg> are implemented in terms of this function.
3195
3196 You probably want to use one of the assortment of wrappers, such as
3197 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3198 C<SvSetMagicSV_nosteal>.
3199
3200 This is the primary function for copying scalars, and most other
3201 copy-ish functions and macros use this underneath.
3202
3203 =cut
3204 */
3205
3206 static void
3207 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3208 {
3209     I32 mro_changes = 0; /* 1 = method, 2 = isa */
3210
3211     if (dtype != SVt_PVGV) {
3212         const char * const name = GvNAME(sstr);
3213         const STRLEN len = GvNAMELEN(sstr);
3214         {
3215             if (dtype >= SVt_PV) {
3216                 SvPV_free(dstr);
3217                 SvPV_set(dstr, 0);
3218                 SvLEN_set(dstr, 0);
3219                 SvCUR_set(dstr, 0);
3220             }
3221             SvUPGRADE(dstr, SVt_PVGV);
3222             (void)SvOK_off(dstr);
3223             /* FIXME - why are we doing this, then turning it off and on again
3224                below?  */
3225             isGV_with_GP_on(dstr);
3226         }
3227         GvSTASH(dstr) = GvSTASH(sstr);
3228         if (GvSTASH(dstr))
3229             Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3230         gv_name_set((GV *)dstr, name, len, GV_ADD);
3231         SvFAKE_on(dstr);        /* can coerce to non-glob */
3232     }
3233
3234 #ifdef GV_UNIQUE_CHECK
3235     if (GvUNIQUE((GV*)dstr)) {
3236         Perl_croak(aTHX_ PL_no_modify);
3237     }
3238 #endif
3239
3240     if(GvGP((GV*)sstr)) {
3241         /* If source has method cache entry, clear it */
3242         if(GvCVGEN(sstr)) {
3243             SvREFCNT_dec(GvCV(sstr));
3244             GvCV(sstr) = NULL;
3245             GvCVGEN(sstr) = 0;
3246         }
3247         /* If source has a real method, then a method is
3248            going to change */
3249         else if(GvCV((GV*)sstr)) {
3250             mro_changes = 1;
3251         }
3252     }
3253
3254     /* If dest already had a real method, that's a change as well */
3255     if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3256         mro_changes = 1;
3257     }
3258
3259     if(strEQ(GvNAME((GV*)dstr),"ISA"))
3260         mro_changes = 2;
3261
3262     gp_free((GV*)dstr);
3263     isGV_with_GP_off(dstr);
3264     (void)SvOK_off(dstr);
3265     isGV_with_GP_on(dstr);
3266     GvINTRO_off(dstr);          /* one-shot flag */
3267     GvGP(dstr) = gp_ref(GvGP(sstr));
3268     if (SvTAINTED(sstr))
3269         SvTAINT(dstr);
3270     if (GvIMPORTED(dstr) != GVf_IMPORTED
3271         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3272         {
3273             GvIMPORTED_on(dstr);
3274         }
3275     GvMULTI_on(dstr);
3276     if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3277     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3278     return;
3279 }
3280
3281 static void
3282 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3283     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3284     SV *dref = NULL;
3285     const int intro = GvINTRO(dstr);
3286     SV **location;
3287     U8 import_flag = 0;
3288     const U32 stype = SvTYPE(sref);
3289
3290
3291 #ifdef GV_UNIQUE_CHECK
3292     if (GvUNIQUE((GV*)dstr)) {
3293         Perl_croak(aTHX_ PL_no_modify);
3294     }
3295 #endif
3296
3297     if (intro) {
3298         GvINTRO_off(dstr);      /* one-shot flag */
3299         GvLINE(dstr) = CopLINE(PL_curcop);
3300         GvEGV(dstr) = (GV*)dstr;
3301     }
3302     GvMULTI_on(dstr);
3303     switch (stype) {
3304     case SVt_PVCV:
3305         location = (SV **) &GvCV(dstr);
3306         import_flag = GVf_IMPORTED_CV;
3307         goto common;
3308     case SVt_PVHV:
3309         location = (SV **) &GvHV(dstr);
3310         import_flag = GVf_IMPORTED_HV;
3311         goto common;
3312     case SVt_PVAV:
3313         location = (SV **) &GvAV(dstr);
3314         import_flag = GVf_IMPORTED_AV;
3315         goto common;
3316     case SVt_PVIO:
3317         location = (SV **) &GvIOp(dstr);
3318         goto common;
3319     case SVt_PVFM:
3320         location = (SV **) &GvFORM(dstr);
3321     default:
3322         location = &GvSV(dstr);
3323         import_flag = GVf_IMPORTED_SV;
3324     common:
3325         if (intro) {
3326             if (stype == SVt_PVCV) {
3327                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3328                 if (GvCVGEN(dstr)) {
3329                     SvREFCNT_dec(GvCV(dstr));
3330                     GvCV(dstr) = NULL;
3331                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3332                 }
3333             }
3334             SAVEGENERICSV(*location);
3335         }
3336         else
3337             dref = *location;
3338         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3339             CV* const cv = (CV*)*location;
3340             if (cv) {
3341                 if (!GvCVGEN((GV*)dstr) &&
3342                     (CvROOT(cv) || CvXSUB(cv)))
3343                     {
3344                         /* Redefining a sub - warning is mandatory if
3345                            it was a const and its value changed. */
3346                         if (CvCONST(cv) && CvCONST((CV*)sref)
3347                             && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3348                             NOOP;
3349                             /* They are 2 constant subroutines generated from
3350                                the same constant. This probably means that
3351                                they are really the "same" proxy subroutine
3352                                instantiated in 2 places. Most likely this is
3353                                when a constant is exported twice.  Don't warn.
3354                             */
3355                         }
3356                         else if (ckWARN(WARN_REDEFINE)
3357                                  || (CvCONST(cv)
3358                                      && (!CvCONST((CV*)sref)
3359                                          || sv_cmp(cv_const_sv(cv),
3360                                                    cv_const_sv((CV*)sref))))) {
3361                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3362                                         (const char *)
3363                                         (CvCONST(cv)
3364                                          ? "Constant subroutine %s::%s redefined"
3365                                          : "Subroutine %s::%s redefined"),
3366                                         HvNAME_get(GvSTASH((GV*)dstr)),
3367                                         GvENAME((GV*)dstr));
3368                         }
3369                     }
3370                 if (!intro)
3371                     cv_ckproto_len(cv, (GV*)dstr,
3372                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3373                                    SvPOK(sref) ? SvCUR(sref) : 0);
3374             }
3375             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3376             GvASSUMECV_on(dstr);
3377             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3378         }
3379         *location = sref;
3380         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3381             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3382             GvFLAGS(dstr) |= import_flag;
3383         }
3384         break;
3385     }
3386     SvREFCNT_dec(dref);
3387     if (SvTAINTED(sstr))
3388         SvTAINT(dstr);
3389     return;
3390 }
3391
3392 void
3393 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3394 {
3395     dVAR;
3396     register U32 sflags;
3397     register int dtype;
3398     register svtype stype;
3399
3400     if (sstr == dstr)
3401         return;
3402
3403     if (SvIS_FREED(dstr)) {
3404         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3405                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3406     }
3407     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3408     if (!sstr)
3409         sstr = &PL_sv_undef;
3410     if (SvIS_FREED(sstr)) {
3411         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3412                    (void*)sstr, (void*)dstr);
3413     }
3414     stype = SvTYPE(sstr);
3415     dtype = SvTYPE(dstr);
3416
3417     (void)SvAMAGIC_off(dstr);
3418     if ( SvVOK(dstr) )
3419     {
3420         /* need to nuke the magic */
3421         mg_free(dstr);
3422         SvRMAGICAL_off(dstr);
3423     }
3424
3425     /* There's a lot of redundancy below but we're going for speed here */
3426
3427     switch (stype) {
3428     case SVt_NULL:
3429       undef_sstr:
3430         if (dtype != SVt_PVGV) {
3431             (void)SvOK_off(dstr);
3432             return;
3433         }
3434         break;
3435     case SVt_IV:
3436         if (SvIOK(sstr)) {
3437             switch (dtype) {
3438             case SVt_NULL:
3439                 sv_upgrade(dstr, SVt_IV);
3440                 break;
3441             case SVt_NV:
3442             case SVt_PV:
3443                 sv_upgrade(dstr, SVt_PVIV);
3444                 break;
3445             case SVt_PVGV:
3446                 goto end_of_first_switch;
3447             }
3448             (void)SvIOK_only(dstr);
3449             SvIV_set(dstr,  SvIVX(sstr));
3450             if (SvIsUV(sstr))
3451                 SvIsUV_on(dstr);
3452             /* SvTAINTED can only be true if the SV has taint magic, which in
3453                turn means that the SV type is PVMG (or greater). This is the
3454                case statement for SVt_IV, so this cannot be true (whatever gcov
3455                may say).  */
3456             assert(!SvTAINTED(sstr));
3457             return;
3458         }
3459         if (!SvROK(sstr))
3460             goto undef_sstr;
3461         if (dtype < SVt_PV && dtype != SVt_IV)
3462             sv_upgrade(dstr, SVt_IV);
3463         break;
3464
3465     case SVt_NV:
3466         if (SvNOK(sstr)) {
3467             switch (dtype) {
3468             case SVt_NULL:
3469             case SVt_IV:
3470                 sv_upgrade(dstr, SVt_NV);
3471                 break;
3472             case SVt_PV:
3473             case SVt_PVIV:
3474                 sv_upgrade(dstr, SVt_PVNV);
3475                 break;
3476             case SVt_PVGV:
3477                 goto end_of_first_switch;
3478             }
3479             SvNV_set(dstr, SvNVX(sstr));
3480             (void)SvNOK_only(dstr);
3481             /* SvTAINTED can only be true if the SV has taint magic, which in
3482                turn means that the SV type is PVMG (or greater). This is the
3483                case statement for SVt_NV, so this cannot be true (whatever gcov
3484                may say).  */
3485             assert(!SvTAINTED(sstr));
3486             return;
3487         }
3488         goto undef_sstr;
3489
3490     case SVt_PVFM:
3491 #ifdef PERL_OLD_COPY_ON_WRITE
3492         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3493             if (dtype < SVt_PVIV)
3494                 sv_upgrade(dstr, SVt_PVIV);
3495             break;
3496         }
3497         /* Fall through */
3498 #endif
3499     case SVt_PV:
3500         if (dtype < SVt_PV)
3501             sv_upgrade(dstr, SVt_PV);
3502         break;
3503     case SVt_PVIV:
3504         if (dtype < SVt_PVIV)
3505             sv_upgrade(dstr, SVt_PVIV);
3506         break;
3507     case SVt_PVNV:
3508         if (dtype < SVt_PVNV)
3509             sv_upgrade(dstr, SVt_PVNV);
3510         break;
3511     default:
3512         {
3513         const char * const type = sv_reftype(sstr,0);
3514         if (PL_op)
3515             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3516         else
3517             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3518         }
3519         break;
3520
3521         /* case SVt_BIND: */
3522     case SVt_PVLV:
3523     case SVt_PVGV:
3524         if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3525             glob_assign_glob(dstr, sstr, dtype);
3526             return;
3527         }
3528         /* SvVALID means that this PVGV is playing at being an FBM.  */
3529         /*FALLTHROUGH*/
3530
3531     case SVt_PVMG:
3532         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3533             mg_get(sstr);
3534             if (SvTYPE(sstr) != stype) {
3535                 stype = SvTYPE(sstr);
3536                 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3537                     glob_assign_glob(dstr, sstr, dtype);
3538                     return;
3539                 }
3540             }
3541         }
3542         if (stype == SVt_PVLV)
3543             SvUPGRADE(dstr, SVt_PVNV);
3544         else
3545             SvUPGRADE(dstr, (svtype)stype);
3546     }
3547  end_of_first_switch:
3548
3549     /* dstr may have been upgraded.  */
3550     dtype = SvTYPE(dstr);
3551     sflags = SvFLAGS(sstr);
3552
3553     if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3554         /* Assigning to a subroutine sets the prototype.  */
3555         if (SvOK(sstr)) {
3556             STRLEN len;
3557             const char *const ptr = SvPV_const(sstr, len);
3558
3559             SvGROW(dstr, len + 1);
3560             Copy(ptr, SvPVX(dstr), len + 1, char);
3561             SvCUR_set(dstr, len);
3562             SvPOK_only(dstr);
3563             SvFLAGS(dstr) |= sflags & SVf_UTF8;
3564         } else {
3565             SvOK_off(dstr);
3566         }
3567     } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3568         const char * const type = sv_reftype(dstr,0);
3569         if (PL_op)
3570             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3571         else
3572             Perl_croak(aTHX_ "Cannot copy to %s", type);
3573     } else if (sflags & SVf_ROK) {
3574         if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3575             && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3576             sstr = SvRV(sstr);
3577             if (sstr == dstr) {
3578                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3579                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3580                 {
3581                     GvIMPORTED_on(dstr);
3582                 }
3583                 GvMULTI_on(dstr);
3584                 return;
3585             }
3586             glob_assign_glob(dstr, sstr, dtype);
3587             return;
3588         }
3589
3590         if (dtype >= SVt_PV) {
3591             if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3592                 glob_assign_ref(dstr, sstr);
3593                 return;
3594             }
3595             if (SvPVX_const(dstr)) {
3596                 SvPV_free(dstr);
3597                 SvLEN_set(dstr, 0);
3598                 SvCUR_set(dstr, 0);
3599             }
3600         }
3601         (void)SvOK_off(dstr);
3602         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3603         SvFLAGS(dstr) |= sflags & SVf_ROK;
3604         assert(!(sflags & SVp_NOK));
3605         assert(!(sflags & SVp_IOK));
3606         assert(!(sflags & SVf_NOK));
3607         assert(!(sflags & SVf_IOK));
3608     }
3609     else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3610         if (!(sflags & SVf_OK)) {
3611             if (ckWARN(WARN_MISC))
3612                 Perl_warner(aTHX_ packWARN(WARN_MISC),
3613                             "Undefined value assigned to typeglob");
3614         }
3615         else {
3616             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3617             if (dstr != (SV*)gv) {
3618                 if (GvGP(dstr))
3619                     gp_free((GV*)dstr);
3620                 GvGP(dstr) = gp_ref(GvGP(gv));
3621             }
3622         }
3623     }
3624     else if (sflags & SVp_POK) {
3625         bool isSwipe = 0;
3626
3627         /*
3628          * Check to see if we can just swipe the string.  If so, it's a
3629          * possible small lose on short strings, but a big win on long ones.
3630          * It might even be a win on short strings if SvPVX_const(dstr)
3631          * has to be allocated and SvPVX_const(sstr) has to be freed.
3632          * Likewise if we can set up COW rather than doing an actual copy, we
3633          * drop to the else clause, as the swipe code and the COW setup code
3634          * have much in common.
3635          */
3636
3637         /* Whichever path we take through the next code, we want this true,
3638            and doing it now facilitates the COW check.  */
3639         (void)SvPOK_only(dstr);
3640
3641         if (
3642             /* If we're already COW then this clause is not true, and if COW
3643                is allowed then we drop down to the else and make dest COW 
3644                with us.  If caller hasn't said that we're allowed to COW
3645                shared hash keys then we don't do the COW setup, even if the
3646                source scalar is a shared hash key scalar.  */
3647             (((flags & SV_COW_SHARED_HASH_KEYS)
3648                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3649                : 1 /* If making a COW copy is forbidden then the behaviour we
3650                        desire is as if the source SV isn't actually already
3651                        COW, even if it is.  So we act as if the source flags
3652                        are not COW, rather than actually testing them.  */
3653               )
3654 #ifndef PERL_OLD_COPY_ON_WRITE
3655              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3656                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3657                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3658                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3659                 but in turn, it's somewhat dead code, never expected to go
3660                 live, but more kept as a placeholder on how to do it better
3661                 in a newer implementation.  */
3662              /* If we are COW and dstr is a suitable target then we drop down
3663                 into the else and make dest a COW of us.  */
3664              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3665 #endif
3666              )
3667             &&
3668             !(isSwipe =
3669                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3670                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3671                  (!(flags & SV_NOSTEAL)) &&
3672                                         /* and we're allowed to steal temps */
3673                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3674                  SvLEN(sstr)    &&        /* and really is a string */
3675                                 /* and won't be needed again, potentially */
3676               !(PL_op && PL_op->op_type == OP_AASSIGN))
3677 #ifdef PERL_OLD_COPY_ON_WRITE
3678             && ((flags & SV_COW_SHARED_HASH_KEYS)
3679                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3680                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3681                      && SvTYPE(sstr) >= SVt_PVIV))
3682                 : 1)
3683 #endif
3684             ) {
3685             /* Failed the swipe test, and it's not a shared hash key either.
3686                Have to copy the string.  */
3687             STRLEN len = SvCUR(sstr);
3688             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3689             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3690             SvCUR_set(dstr, len);
3691             *SvEND(dstr) = '\0';
3692         } else {
3693             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3694                be true in here.  */
3695             /* Either it's a shared hash key, or it's suitable for
3696                copy-on-write or we can swipe the string.  */
3697             if (DEBUG_C_TEST) {
3698                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3699                 sv_dump(sstr);
3700                 sv_dump(dstr);
3701             }
3702 #ifdef PERL_OLD_COPY_ON_WRITE
3703             if (!isSwipe) {
3704                 /* I believe I should acquire a global SV mutex if
3705                    it's a COW sv (not a shared hash key) to stop
3706                    it going un copy-on-write.
3707                    If the source SV has gone un copy on write between up there
3708                    and down here, then (assert() that) it is of the correct
3709                    form to make it copy on write again */
3710                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3711                     != (SVf_FAKE | SVf_READONLY)) {
3712                     SvREADONLY_on(sstr);
3713                     SvFAKE_on(sstr);
3714                     /* Make the source SV into a loop of 1.
3715                        (about to become 2) */
3716                     SV_COW_NEXT_SV_SET(sstr, sstr);
3717                 }
3718             }
3719 #endif
3720             /* Initial code is common.  */
3721             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3722                 SvPV_free(dstr);
3723             }
3724
3725             if (!isSwipe) {
3726                 /* making another shared SV.  */
3727                 STRLEN cur = SvCUR(sstr);
3728                 STRLEN len = SvLEN(sstr);
3729 #ifdef PERL_OLD_COPY_ON_WRITE
3730                 if (len) {
3731                     assert (SvTYPE(dstr) >= SVt_PVIV);
3732                     /* SvIsCOW_normal */
3733                     /* splice us in between source and next-after-source.  */
3734                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3735                     SV_COW_NEXT_SV_SET(sstr, dstr);
3736                     SvPV_set(dstr, SvPVX_mutable(sstr));
3737                 } else
3738 #endif
3739                 {
3740                     /* SvIsCOW_shared_hash */
3741                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3742                                           "Copy on write: Sharing hash\n"));
3743
3744                     assert (SvTYPE(dstr) >= SVt_PV);
3745                     SvPV_set(dstr,
3746                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3747                 }
3748                 SvLEN_set(dstr, len);
3749                 SvCUR_set(dstr, cur);
3750                 SvREADONLY_on(dstr);
3751                 SvFAKE_on(dstr);
3752                 /* Relesase a global SV mutex.  */
3753             }
3754             else
3755                 {       /* Passes the swipe test.  */
3756                 SvPV_set(dstr, SvPVX_mutable(sstr));
3757                 SvLEN_set(dstr, SvLEN(sstr));
3758                 SvCUR_set(dstr, SvCUR(sstr));
3759
3760                 SvTEMP_off(dstr);
3761                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3762                 SvPV_set(sstr, NULL);
3763                 SvLEN_set(sstr, 0);
3764                 SvCUR_set(sstr, 0);
3765                 SvTEMP_off(sstr);
3766             }
3767         }
3768         if (sflags & SVp_NOK) {
3769             SvNV_set(dstr, SvNVX(sstr));
3770         }
3771         if (sflags & SVp_IOK) {
3772             SvOOK_off(dstr);
3773             SvIV_set(dstr, SvIVX(sstr));
3774             /* Must do this otherwise some other overloaded use of 0x80000000
3775                gets confused. I guess SVpbm_VALID */
3776             if (sflags & SVf_IVisUV)
3777                 SvIsUV_on(dstr);
3778         }
3779         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3780         {
3781             const MAGIC * const smg = SvVSTRING_mg(sstr);
3782             if (smg) {
3783                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3784                          smg->mg_ptr, smg->mg_len);
3785                 SvRMAGICAL_on(dstr);
3786             }
3787         }
3788     }
3789     else if (sflags & (SVp_IOK|SVp_NOK)) {
3790         (void)SvOK_off(dstr);
3791         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3792         if (sflags & SVp_IOK) {
3793             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3794             SvIV_set(dstr, SvIVX(sstr));
3795         }
3796         if (sflags & SVp_NOK) {
3797             SvNV_set(dstr, SvNVX(sstr));
3798         }
3799     }
3800     else {
3801         if (isGV_with_GP(sstr)) {
3802             /* This stringification rule for globs is spread in 3 places.
3803                This feels bad. FIXME.  */
3804             const U32 wasfake = sflags & SVf_FAKE;
3805
3806             /* FAKE globs can get coerced, so need to turn this off
3807                temporarily if it is on.  */
3808             SvFAKE_off(sstr);
3809             gv_efullname3(dstr, (GV *)sstr, "*");
3810             SvFLAGS(sstr) |= wasfake;
3811         }
3812         else
3813             (void)SvOK_off(dstr);
3814     }
3815     if (SvTAINTED(sstr))
3816         SvTAINT(dstr);
3817 }
3818
3819 /*
3820 =for apidoc sv_setsv_mg
3821
3822 Like C<sv_setsv>, but also handles 'set' magic.
3823
3824 =cut
3825 */
3826
3827 void
3828 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3829 {
3830     sv_setsv(dstr,sstr);
3831     SvSETMAGIC(dstr);
3832 }
3833
3834 #ifdef PERL_OLD_COPY_ON_WRITE
3835 SV *
3836 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3837 {
3838     STRLEN cur = SvCUR(sstr);
3839     STRLEN len = SvLEN(sstr);
3840     register char *new_pv;
3841
3842     if (DEBUG_C_TEST) {
3843         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3844                       (void*)sstr, (void*)dstr);
3845         sv_dump(sstr);
3846         if (dstr)
3847                     sv_dump(dstr);
3848     }
3849
3850     if (dstr) {
3851         if (SvTHINKFIRST(dstr))
3852             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3853         else if (SvPVX_const(dstr))
3854             Safefree(SvPVX_const(dstr));
3855     }
3856     else
3857         new_SV(dstr);
3858     SvUPGRADE(dstr, SVt_PVIV);
3859
3860     assert (SvPOK(sstr));
3861     assert (SvPOKp(sstr));
3862     assert (!SvIOK(sstr));
3863     assert (!SvIOKp(sstr));
3864     assert (!SvNOK(sstr));
3865     assert (!SvNOKp(sstr));
3866
3867     if (SvIsCOW(sstr)) {
3868
3869         if (SvLEN(sstr) == 0) {
3870             /* source is a COW shared hash key.  */
3871             DEBUG_C(PerlIO_printf(Perl_debug_log,
3872                                   "Fast copy on write: Sharing hash\n"));
3873             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3874             goto common_exit;
3875         }
3876         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3877     } else {
3878         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3879         SvUPGRADE(sstr, SVt_PVIV);
3880         SvREADONLY_on(sstr);
3881         SvFAKE_on(sstr);
3882         DEBUG_C(PerlIO_printf(Perl_debug_log,
3883                               "Fast copy on write: Converting sstr to COW\n"));
3884         SV_COW_NEXT_SV_SET(dstr, sstr);
3885     }
3886     SV_COW_NEXT_SV_SET(sstr, dstr);
3887     new_pv = SvPVX_mutable(sstr);
3888
3889   common_exit:
3890     SvPV_set(dstr, new_pv);
3891     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3892     if (SvUTF8(sstr))
3893         SvUTF8_on(dstr);
3894     SvLEN_set(dstr, len);
3895     SvCUR_set(dstr, cur);
3896     if (DEBUG_C_TEST) {
3897         sv_dump(dstr);
3898     }
3899     return dstr;
3900 }
3901 #endif
3902
3903 /*
3904 =for apidoc sv_setpvn
3905
3906 Copies a string into an SV.  The C<len> parameter indicates the number of
3907 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3908 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3909
3910 =cut
3911 */
3912
3913 void
3914 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3915 {
3916     dVAR;
3917     register char *dptr;
3918
3919     SV_CHECK_THINKFIRST_COW_DROP(sv);
3920     if (!ptr) {
3921         (void)SvOK_off(sv);
3922         return;
3923     }
3924     else {
3925         /* len is STRLEN which is unsigned, need to copy to signed */
3926         const IV iv = len;
3927         if (iv < 0)
3928             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3929     }
3930     SvUPGRADE(sv, SVt_PV);
3931
3932     dptr = SvGROW(sv, len + 1);
3933     Move(ptr,dptr,len,char);
3934     dptr[len] = '\0';
3935     SvCUR_set(sv, len);
3936     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3937     SvTAINT(sv);
3938 }
3939
3940 /*
3941 =for apidoc sv_setpvn_mg
3942
3943 Like C<sv_setpvn>, but also handles 'set' magic.
3944
3945 =cut
3946 */
3947
3948 void
3949 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3950 {
3951     sv_setpvn(sv,ptr,len);
3952     SvSETMAGIC(sv);
3953 }
3954
3955 /*
3956 =for apidoc sv_setpv
3957
3958 Copies a string into an SV.  The string must be null-terminated.  Does not
3959 handle 'set' magic.  See C<sv_setpv_mg>.
3960
3961 =cut
3962 */
3963
3964 void
3965 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3966 {
3967     dVAR;
3968     register STRLEN len;
3969
3970     SV_CHECK_THINKFIRST_COW_DROP(sv);
3971     if (!ptr) {
3972         (void)SvOK_off(sv);
3973         return;
3974     }
3975     len = strlen(ptr);
3976     SvUPGRADE(sv, SVt_PV);
3977
3978     SvGROW(sv, len + 1);
3979     Move(ptr,SvPVX(sv),len+1,char);
3980     SvCUR_set(sv, len);
3981     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3982     SvTAINT(sv);
3983 }
3984
3985 /*
3986 =for apidoc sv_setpv_mg
3987
3988 Like C<sv_setpv>, but also handles 'set' magic.
3989
3990 =cut
3991 */
3992
3993 void
3994 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3995 {
3996     sv_setpv(sv,ptr);
3997     SvSETMAGIC(sv);
3998 }
3999
4000 /*
4001 =for apidoc sv_usepvn_flags
4002
4003 Tells an SV to use C<ptr> to find its string value.  Normally the
4004 string is stored inside the SV but sv_usepvn allows the SV to use an
4005 outside string.  The C<ptr> should point to memory that was allocated
4006 by C<malloc>.  The string length, C<len>, must be supplied.  By default
4007 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4008 so that pointer should not be freed or used by the programmer after
4009 giving it to sv_usepvn, and neither should any pointers from "behind"
4010 that pointer (e.g. ptr + 1) be used.
4011
4012 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4013 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4014 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4015 C<len>, and already meets the requirements for storing in C<SvPVX>)
4016
4017 =cut
4018 */
4019
4020 void
4021 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4022 {
4023     dVAR;
4024     STRLEN allocate;
4025     SV_CHECK_THINKFIRST_COW_DROP(sv);
4026     SvUPGRADE(sv, SVt_PV);
4027     if (!ptr) {
4028         (void)SvOK_off(sv);
4029         if (flags & SV_SMAGIC)
4030             SvSETMAGIC(sv);
4031         return;
4032     }
4033     if (SvPVX_const(sv))
4034         SvPV_free(sv);
4035
4036 #ifdef DEBUGGING
4037     if (flags & SV_HAS_TRAILING_NUL)
4038         assert(ptr[len] == '\0');
4039 #endif
4040
4041     allocate = (flags & SV_HAS_TRAILING_NUL)
4042         ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4043     if (flags & SV_HAS_TRAILING_NUL) {
4044         /* It's long enough - do nothing.
4045            Specfically Perl_newCONSTSUB is relying on this.  */
4046     } else {
4047 #ifdef DEBUGGING
4048         /* Force a move to shake out bugs in callers.  */
4049         char *new_ptr = (char*)safemalloc(allocate);
4050         Copy(ptr, new_ptr, len, char);
4051         PoisonFree(ptr,len,char);
4052         Safefree(ptr);
4053         ptr = new_ptr;
4054 #else
4055         ptr = (char*) saferealloc (ptr, allocate);
4056 #endif
4057     }
4058     SvPV_set(sv, ptr);
4059     SvCUR_set(sv, len);
4060     SvLEN_set(sv, allocate);
4061     if (!(flags & SV_HAS_TRAILING_NUL)) {
4062         ptr[len] = '\0';
4063     }
4064     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4065     SvTAINT(sv);
4066     if (flags & SV_SMAGIC)
4067         SvSETMAGIC(sv);
4068 }
4069
4070 #ifdef PERL_OLD_COPY_ON_WRITE
4071 /* Need to do this *after* making the SV normal, as we need the buffer
4072    pointer to remain valid until after we've copied it.  If we let go too early,
4073    another thread could invalidate it by unsharing last of the same hash key
4074    (which it can do by means other than releasing copy-on-write Svs)
4075    or by changing the other copy-on-write SVs in the loop.  */
4076 STATIC void
4077 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4078 {
4079     { /* this SV was SvIsCOW_normal(sv) */
4080          /* we need to find the SV pointing to us.  */
4081         SV *current = SV_COW_NEXT_SV(after);
4082
4083         if (current == sv) {
4084             /* The SV we point to points back to us (there were only two of us
4085                in the loop.)
4086                Hence other SV is no longer copy on write either.  */
4087             SvFAKE_off(after);
4088             SvREADONLY_off(after);
4089         } else {
4090             /* We need to follow the pointers around the loop.  */
4091             SV *next;
4092             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4093                 assert (next);
4094                 current = next;
4095                  /* don't loop forever if the structure is bust, and we have
4096                     a pointer into a closed loop.  */
4097                 assert (current != after);
4098                 assert (SvPVX_const(current) == pvx);
4099             }
4100             /* Make the SV before us point to the SV after us.  */
4101             SV_COW_NEXT_SV_SET(current, after);
4102         }
4103     }
4104 }
4105 #endif
4106 /*
4107 =for apidoc sv_force_normal_flags
4108
4109 Undo various types of fakery on an SV: if the PV is a shared string, make
4110 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4111 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4112 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4113 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4114 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4115 set to some other value.) In addition, the C<flags> parameter gets passed to
4116 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4117 with flags set to 0.
4118
4119 =cut
4120 */
4121
4122 void
4123 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4124 {
4125     dVAR;
4126 #ifdef PERL_OLD_COPY_ON_WRITE
4127     if (SvREADONLY(sv)) {
4128         /* At this point I believe I should acquire a global SV mutex.  */
4129         if (SvFAKE(sv)) {
4130             const char * const pvx = SvPVX_const(sv);
4131             const STRLEN len = SvLEN(sv);
4132             const STRLEN cur = SvCUR(sv);
4133             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4134                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4135                we'll fail an assertion.  */
4136             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4137
4138             if (DEBUG_C_TEST) {
4139                 PerlIO_printf(Perl_debug_log,
4140                               "Copy on write: Force normal %ld\n",
4141                               (long) flags);
4142                 sv_dump(sv);
4143             }
4144             SvFAKE_off(sv);
4145             SvREADONLY_off(sv);
4146             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4147             SvPV_set(sv, NULL);
4148             SvLEN_set(sv, 0);
4149             if (flags & SV_COW_DROP_PV) {
4150                 /* OK, so we don't need to copy our buffer.  */
4151                 SvPOK_off(sv);
4152             } else {
4153                 SvGROW(sv, cur + 1);
4154                 Move(pvx,SvPVX(sv),cur,char);
4155                 SvCUR_set(sv, cur);
4156                 *SvEND(sv) = '\0';
4157             }
4158             if (len) {
4159                 sv_release_COW(sv, pvx, next);
4160             } else {
4161                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4162             }
4163             if (DEBUG_C_TEST) {
4164                 sv_dump(sv);
4165             }
4166         }
4167         else if (IN_PERL_RUNTIME)
4168             Perl_croak(aTHX_ PL_no_modify);
4169         /* At this point I believe that I can drop the global SV mutex.  */
4170     }
4171 #else
4172     if (SvREADONLY(sv)) {
4173         if (SvFAKE(sv)) {
4174             const char * const pvx = SvPVX_const(sv);
4175             const STRLEN len = SvCUR(sv);
4176             SvFAKE_off(sv);
4177             SvREADONLY_off(sv);
4178             SvPV_set(sv, NULL);
4179             SvLEN_set(sv, 0);
4180             SvGROW(sv, len + 1);
4181             Move(pvx,SvPVX(sv),len,char);
4182             *SvEND(sv) = '\0';
4183             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4184         }
4185         else if (IN_PERL_RUNTIME)
4186             Perl_croak(aTHX_ PL_no_modify);
4187     }
4188 #endif
4189     if (SvROK(sv))
4190         sv_unref_flags(sv, flags);
4191     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4192         sv_unglob(sv);
4193 }
4194
4195 /*
4196 =for apidoc sv_chop
4197
4198 Efficient removal of characters from the beginning of the string buffer.
4199 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4200 the string buffer.  The C<ptr> becomes the first character of the adjusted
4201 string. Uses the "OOK hack".
4202 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4203 refer to the same chunk of data.
4204
4205 =cut
4206 */
4207
4208 void
4209 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4210 {
4211     register STRLEN delta;
4212     if (!ptr || !SvPOKp(sv))
4213         return;
4214     delta = ptr - SvPVX_const(sv);
4215     SV_CHECK_THINKFIRST(sv);
4216     if (SvTYPE(sv) < SVt_PVIV)
4217         sv_upgrade(sv,SVt_PVIV);
4218
4219     if (!SvOOK(sv)) {
4220         if (!SvLEN(sv)) { /* make copy of shared string */
4221             const char *pvx = SvPVX_const(sv);
4222             const STRLEN len = SvCUR(sv);
4223             SvGROW(sv, len + 1);
4224             Move(pvx,SvPVX(sv),len,char);
4225             *SvEND(sv) = '\0';
4226         }
4227         SvIV_set(sv, 0);
4228         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4229            and we do that anyway inside the SvNIOK_off
4230         */
4231         SvFLAGS(sv) |= SVf_OOK;
4232     }
4233     SvNIOK_off(sv);
4234     SvLEN_set(sv, SvLEN(sv) - delta);
4235     SvCUR_set(sv, SvCUR(sv) - delta);
4236     SvPV_set(sv, SvPVX(sv) + delta);
4237     SvIV_set(sv, SvIVX(sv) + delta);
4238 }
4239
4240 /*
4241 =for apidoc sv_catpvn
4242
4243 Concatenates the string onto the end of the string which is in the SV.  The
4244 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4245 status set, then the bytes appended should be valid UTF-8.
4246 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4247
4248 =for apidoc sv_catpvn_flags
4249
4250 Concatenates the string onto the end of the string which is in the SV.  The
4251 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4252 status set, then the bytes appended should be valid UTF-8.
4253 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4254 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4255 in terms of this function.
4256
4257 =cut
4258 */
4259
4260 void
4261 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4262 {
4263     dVAR;
4264     STRLEN dlen;
4265     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4266
4267     SvGROW(dsv, dlen + slen + 1);
4268     if (sstr == dstr)
4269         sstr = SvPVX_const(dsv);
4270     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4271     SvCUR_set(dsv, SvCUR(dsv) + slen);
4272     *SvEND(dsv) = '\0';
4273     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4274     SvTAINT(dsv);
4275     if (flags & SV_SMAGIC)
4276         SvSETMAGIC(dsv);
4277 }
4278
4279 /*
4280 =for apidoc sv_catsv
4281
4282 Concatenates the string from SV C<ssv> onto the end of the string in
4283 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4284 not 'set' magic.  See C<sv_catsv_mg>.
4285
4286 =for apidoc sv_catsv_flags
4287
4288 Concatenates the string from SV C<ssv> onto the end of the string in
4289 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4290 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4291 and C<sv_catsv_nomg> are implemented in terms of this function.
4292
4293 =cut */
4294
4295 void
4296 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4297 {
4298     dVAR;
4299     if (ssv) {
4300         STRLEN slen;
4301         const char *spv = SvPV_const(ssv, slen);
4302         if (spv) {
4303             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4304                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4305                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4306                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4307                 dsv->sv_flags doesn't have that bit set.
4308                 Andy Dougherty  12 Oct 2001
4309             */
4310             const I32 sutf8 = DO_UTF8(ssv);
4311             I32 dutf8;
4312
4313             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4314                 mg_get(dsv);
4315             dutf8 = DO_UTF8(dsv);
4316
4317             if (dutf8 != sutf8) {
4318                 if (dutf8) {
4319                     /* Not modifying source SV, so taking a temporary copy. */
4320                     SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4321
4322                     sv_utf8_upgrade(csv);
4323                     spv = SvPV_const(csv, slen);
4324                 }
4325                 else
4326                     sv_utf8_upgrade_nomg(dsv);
4327             }
4328             sv_catpvn_nomg(dsv, spv, slen);
4329         }
4330     }
4331     if (flags & SV_SMAGIC)
4332         SvSETMAGIC(dsv);
4333 }
4334
4335 /*
4336 =for apidoc sv_catpv
4337
4338 Concatenates the string onto the end of the string which is in the SV.
4339 If the SV has the UTF-8 status set, then the bytes appended should be
4340 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4341
4342 =cut */
4343
4344 void
4345 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4346 {
4347     dVAR;
4348     register STRLEN len;
4349     STRLEN tlen;
4350     char *junk;
4351
4352     if (!ptr)
4353         return;
4354     junk = SvPV_force(sv, tlen);
4355     len = strlen(ptr);
4356     SvGROW(sv, tlen + len + 1);
4357     if (ptr == junk)
4358         ptr = SvPVX_const(sv);
4359     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4360     SvCUR_set(sv, SvCUR(sv) + len);
4361     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4362     SvTAINT(sv);
4363 }
4364
4365 /*
4366 =for apidoc sv_catpv_mg
4367
4368 Like C<sv_catpv>, but also handles 'set' magic.
4369
4370 =cut
4371 */
4372
4373 void
4374 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4375 {
4376     sv_catpv(sv,ptr);
4377     SvSETMAGIC(sv);
4378 }
4379
4380 /*
4381 =for apidoc newSV
4382
4383 Creates a new SV.  A non-zero C<len> parameter indicates the number of
4384 bytes of preallocated string space the SV should have.  An extra byte for a
4385 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
4386 space is allocated.)  The reference count for the new SV is set to 1.
4387
4388 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4389 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4390 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4391 L<perlhack/PERL_MEM_LOG>).  The older API is still there for use in XS
4392 modules supporting older perls.
4393
4394 =cut
4395 */
4396
4397 SV *
4398 Perl_newSV(pTHX_ STRLEN len)
4399 {
4400     dVAR;
4401     register SV *sv;
4402
4403     new_SV(sv);
4404     if (len) {
4405         sv_upgrade(sv, SVt_PV);
4406         SvGROW(sv, len + 1);
4407     }
4408     return sv;
4409 }
4410 /*
4411 =for apidoc sv_magicext
4412
4413 Adds magic to an SV, upgrading it if necessary. Applies the
4414 supplied vtable and returns a pointer to the magic added.
4415
4416 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4417 In particular, you can add magic to SvREADONLY SVs, and add more than
4418 one instance of the same 'how'.
4419
4420 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4421 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4422 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4423 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4424
4425 (This is now used as a subroutine by C<sv_magic>.)
4426
4427 =cut
4428 */
4429 MAGIC * 
4430 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4431                  const char* name, I32 namlen)
4432 {
4433     dVAR;
4434     MAGIC* mg;
4435
4436     SvUPGRADE(sv, SVt_PVMG);
4437     Newxz(mg, 1, MAGIC);
4438     mg->mg_moremagic = SvMAGIC(sv);
4439     SvMAGIC_set(sv, mg);
4440
4441     /* Sometimes a magic contains a reference loop, where the sv and
4442        object refer to each other.  To prevent a reference loop that
4443        would prevent such objects being freed, we look for such loops
4444        and if we find one we avoid incrementing the object refcount.
4445
4446        Note we cannot do this to avoid self-tie loops as intervening RV must
4447        have its REFCNT incremented to keep it in existence.
4448
4449     */
4450     if (!obj || obj == sv ||
4451         how == PERL_MAGIC_arylen ||
4452         how == PERL_MAGIC_qr ||
4453         how == PERL_MAGIC_symtab ||
4454         (SvTYPE(obj) == SVt_PVGV &&
4455             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4456             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4457             GvFORM(obj) == (CV*)sv)))
4458     {
4459         mg->mg_obj = obj;
4460     }
4461     else {
4462         mg->mg_obj = SvREFCNT_inc_simple(obj);
4463         mg->mg_flags |= MGf_REFCOUNTED;
4464     }
4465
4466     /* Normal self-ties simply pass a null object, and instead of
4467        using mg_obj directly, use the SvTIED_obj macro to produce a
4468        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4469        with an RV obj pointing to the glob containing the PVIO.  In
4470        this case, to avoid a reference loop, we need to weaken the
4471        reference.
4472     */
4473
4474     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4475         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4476     {
4477       sv_rvweaken(obj);
4478     }
4479
4480     mg->mg_type = how;
4481     mg->mg_len = namlen;
4482     if (name) {
4483         if (namlen > 0)
4484             mg->mg_ptr = savepvn(name, namlen);
4485         else if (namlen == HEf_SVKEY)
4486             mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4487         else
4488             mg->mg_ptr = (char *) name;
4489     }
4490     mg->mg_virtual = (MGVTBL *) vtable;
4491
4492     mg_magical(sv);
4493     if (SvGMAGICAL(sv))
4494         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4495     return mg;
4496 }
4497
4498 /*
4499 =for apidoc sv_magic
4500
4501 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4502 then adds a new magic item of type C<how> to the head of the magic list.
4503
4504 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4505 handling of the C<name> and C<namlen> arguments.
4506
4507 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4508 to add more than one instance of the same 'how'.
4509
4510 =cut
4511 */
4512
4513 void
4514 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4515 {
4516     dVAR;
4517     const MGVTBL *vtable;
4518     MAGIC* mg;
4519
4520 #ifdef PERL_OLD_COPY_ON_WRITE
4521     if (SvIsCOW(sv))
4522         sv_force_normal_flags(sv, 0);
4523 #endif
4524     if (SvREADONLY(sv)) {
4525         if (
4526             /* its okay to attach magic to shared strings; the subsequent
4527              * upgrade to PVMG will unshare the string */
4528             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4529
4530             && IN_PERL_RUNTIME
4531             && how != PERL_MAGIC_regex_global
4532             && how != PERL_MAGIC_bm
4533             && how != PERL_MAGIC_fm
4534             && how != PERL_MAGIC_sv
4535             && how != PERL_MAGIC_backref
4536            )
4537         {
4538             Perl_croak(aTHX_ PL_no_modify);
4539         }
4540     }
4541     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4542         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4543             /* sv_magic() refuses to add a magic of the same 'how' as an
4544                existing one
4545              */
4546             if (how == PERL_MAGIC_taint) {
4547                 mg->mg_len |= 1;
4548                 /* Any scalar which already had taint magic on which someone
4549                    (erroneously?) did SvIOK_on() or similar will now be
4550                    incorrectly sporting public "OK" flags.  */
4551                 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4552             }
4553             return;
4554         }
4555     }
4556
4557     switch (how) {
4558     case PERL_MAGIC_sv:
4559         vtable = &PL_vtbl_sv;
4560         break;
4561     case PERL_MAGIC_overload:
4562         vtable = &PL_vtbl_amagic;
4563         break;
4564     case PERL_MAGIC_overload_elem:
4565         vtable = &PL_vtbl_amagicelem;
4566         break;
4567     case PERL_MAGIC_overload_table:
4568         vtable = &PL_vtbl_ovrld;
4569         break;
4570     case PERL_MAGIC_bm:
4571         vtable = &PL_vtbl_bm;
4572         break;
4573     case PERL_MAGIC_regdata:
4574         vtable = &PL_vtbl_regdata;
4575         break;
4576     case PERL_MAGIC_regdatum:
4577         vtable = &PL_vtbl_regdatum;
4578         break;
4579     case PERL_MAGIC_env:
4580         vtable = &PL_vtbl_env;
4581         break;
4582     case PERL_MAGIC_fm:
4583         vtable = &PL_vtbl_fm;
4584         break;
4585     case PERL_MAGIC_envelem:
4586         vtable = &PL_vtbl_envelem;
4587         break;
4588     case PERL_MAGIC_regex_global:
4589         vtable = &PL_vtbl_mglob;
4590         break;
4591     case PERL_MAGIC_isa:
4592         vtable = &PL_vtbl_isa;
4593         break;
4594     case PERL_MAGIC_isaelem:
4595         vtable = &PL_vtbl_isaelem;
4596         break;
4597     case PERL_MAGIC_nkeys:
4598         vtable = &PL_vtbl_nkeys;
4599         break;
4600     case PERL_MAGIC_dbfile:
4601         vtable = NULL;
4602         break;
4603     case PERL_MAGIC_dbline:
4604         vtable = &PL_vtbl_dbline;
4605         break;
4606 #ifdef USE_LOCALE_COLLATE
4607     case PERL_MAGIC_collxfrm:
4608         vtable = &PL_vtbl_collxfrm;
4609         break;
4610 #endif /* USE_LOCALE_COLLATE */
4611     case PERL_MAGIC_tied:
4612         vtable = &PL_vtbl_pack;
4613         break;
4614     case PERL_MAGIC_tiedelem:
4615     case PERL_MAGIC_tiedscalar:
4616         vtable = &PL_vtbl_packelem;
4617         break;
4618     case PERL_MAGIC_qr:
4619         vtable = &PL_vtbl_regexp;
4620         break;
4621     case PERL_MAGIC_hints:
4622         /* As this vtable is all NULL, we can reuse it.  */
4623     case PERL_MAGIC_sig:
4624         vtable = &PL_vtbl_sig;
4625         break;
4626     case PERL_MAGIC_sigelem:
4627         vtable = &PL_vtbl_sigelem;
4628         break;
4629     case PERL_MAGIC_taint:
4630         vtable = &PL_vtbl_taint;
4631         break;
4632     case PERL_MAGIC_uvar:
4633         vtable = &PL_vtbl_uvar;
4634         break;
4635     case PERL_MAGIC_vec:
4636         vtable = &PL_vtbl_vec;
4637         break;
4638     case PERL_MAGIC_arylen_p:
4639     case PERL_MAGIC_rhash:
4640     case PERL_MAGIC_symtab:
4641     case PERL_MAGIC_vstring:
4642         vtable = NULL;
4643         break;
4644     case PERL_MAGIC_utf8:
4645         vtable = &PL_vtbl_utf8;
4646         break;
4647     case PERL_MAGIC_substr:
4648         vtable = &PL_vtbl_substr;
4649         break;
4650     case PERL_MAGIC_defelem:
4651         vtable = &PL_vtbl_defelem;
4652         break;
4653     case PERL_MAGIC_arylen:
4654         vtable = &PL_vtbl_arylen;
4655         break;
4656     case PERL_MAGIC_pos:
4657         vtable = &PL_vtbl_pos;
4658         break;
4659     case PERL_MAGIC_backref:
4660         vtable = &PL_vtbl_backref;
4661         break;
4662     case PERL_MAGIC_hintselem:
4663         vtable = &PL_vtbl_hintselem;
4664         break;
4665     case PERL_MAGIC_ext:
4666         /* Reserved for use by extensions not perl internals.           */
4667         /* Useful for attaching extension internal data to perl vars.   */
4668         /* Note that multiple extensions may clash if magical scalars   */
4669         /* etc holding private data from one are passed to another.     */
4670         vtable = NULL;
4671         break;
4672     default:
4673         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4674     }
4675
4676     /* Rest of work is done else where */
4677     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4678
4679     switch (how) {
4680     case PERL_MAGIC_taint:
4681         mg->mg_len = 1;
4682         break;
4683     case PERL_MAGIC_ext:
4684     case PERL_MAGIC_dbfile:
4685         SvRMAGICAL_on(sv);
4686         break;
4687     }
4688 }
4689
4690 /*
4691 =for apidoc sv_unmagic
4692
4693 Removes all magic of type C<type> from an SV.
4694
4695 =cut
4696 */
4697
4698 int
4699 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4700 {
4701     MAGIC* mg;
4702     MAGIC** mgp;
4703     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4704         return 0;
4705     mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4706     for (mg = *mgp; mg; mg = *mgp) {
4707         if (mg->mg_type == type) {
4708             const MGVTBL* const vtbl = mg->mg_virtual;
4709             *mgp = mg->mg_moremagic;
4710             if (vtbl && vtbl->svt_free)
4711                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4712             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4713                 if (mg->mg_len > 0)
4714                     Safefree(mg->mg_ptr);
4715                 else if (mg->mg_len == HEf_SVKEY)
4716                     SvREFCNT_dec((SV*)mg->mg_ptr);
4717                 else if (mg->mg_type == PERL_MAGIC_utf8)
4718                     Safefree(mg->mg_ptr);
4719             }
4720             if (mg->mg_flags & MGf_REFCOUNTED)
4721                 SvREFCNT_dec(mg->mg_obj);
4722             Safefree(mg);
4723         }
4724         else
4725             mgp = &mg->mg_moremagic;
4726     }
4727     if (!SvMAGIC(sv)) {
4728         SvMAGICAL_off(sv);
4729         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4730         SvMAGIC_set(sv, NULL);
4731     }
4732
4733     return 0;
4734 }
4735
4736 /*
4737 =for apidoc sv_rvweaken
4738
4739 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4740 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4741 push a back-reference to this RV onto the array of backreferences
4742 associated with that magic. If the RV is magical, set magic will be
4743 called after the RV is cleared.
4744
4745 =cut
4746 */
4747
4748 SV *
4749 Perl_sv_rvweaken(pTHX_ SV *sv)
4750 {
4751     SV *tsv;
4752     if (!SvOK(sv))  /* let undefs pass */
4753         return sv;
4754     if (!SvROK(sv))
4755         Perl_croak(aTHX_ "Can't weaken a nonreference");
4756     else if (SvWEAKREF(sv)) {
4757         if (ckWARN(WARN_MISC))
4758             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4759         return sv;
4760     }
4761     tsv = SvRV(sv);
4762     Perl_sv_add_backref(aTHX_ tsv, sv);
4763     SvWEAKREF_on(sv);
4764     SvREFCNT_dec(tsv);
4765     return sv;
4766 }
4767
4768 /* Give tsv backref magic if it hasn't already got it, then push a
4769  * back-reference to sv onto the array associated with the backref magic.
4770  */
4771
4772 void
4773 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4774 {
4775     dVAR;
4776     AV *av;
4777
4778     if (SvTYPE(tsv) == SVt_PVHV) {
4779         AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4780
4781         av = *avp;
4782         if (!av) {
4783             /* There is no AV in the offical place - try a fixup.  */
4784             MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4785
4786             if (mg) {
4787                 /* Aha. They've got it stowed in magic.  Bring it back.  */
4788                 av = (AV*)mg->mg_obj;
4789                 /* Stop mg_free decreasing the refernce count.  */
4790                 mg->mg_obj = NULL;
4791                 /* Stop mg_free even calling the destructor, given that
4792                    there's no AV to free up.  */
4793                 mg->mg_virtual = 0;
4794                 sv_unmagic(tsv, PERL_MAGIC_backref);
4795             } else {
4796                 av = newAV();
4797                 AvREAL_off(av);
4798                 SvREFCNT_inc_simple_void(av);
4799             }
4800             *avp = av;
4801         }
4802     } else {
4803         const MAGIC *const mg
4804             = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4805         if (mg)
4806             av = (AV*)mg->mg_obj;
4807         else {
4808             av = newAV();
4809             AvREAL_off(av);
4810             sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4811             /* av now has a refcnt of 2, which avoids it getting freed
4812              * before us during global cleanup. The extra ref is removed
4813              * by magic_killbackrefs() when tsv is being freed */
4814         }
4815     }
4816     if (AvFILLp(av) >= AvMAX(av)) {
4817         av_extend(av, AvFILLp(av)+1);
4818     }
4819     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4820 }
4821
4822 /* delete a back-reference to ourselves from the backref magic associated
4823  * with the SV we point to.
4824  */
4825
4826 STATIC void
4827 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4828 {
4829     dVAR;
4830     AV *av = NULL;
4831     SV **svp;
4832     I32 i;
4833
4834     if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4835         av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4836         /* We mustn't attempt to "fix up" the hash here by moving the
4837            backreference array back to the hv_aux structure, as that is stored
4838            in the main HvARRAY(), and hfreentries assumes that no-one
4839            reallocates HvARRAY() while it is running.  */
4840     }
4841     if (!av) {
4842         const MAGIC *const mg
4843             = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4844         if (mg)
4845             av = (AV *)mg->mg_obj;
4846     }
4847     if (!av) {
4848         if (PL_in_clean_all)
4849             return;
4850         Perl_croak(aTHX_ "panic: del_backref");
4851     }
4852
4853     if (SvIS_FREED(av))
4854         return;
4855
4856     svp = AvARRAY(av);
4857     /* We shouldn't be in here more than once, but for paranoia reasons lets
4858        not assume this.  */
4859     for (i = AvFILLp(av); i >= 0; i--) {
4860         if (svp[i] == sv) {
4861             const SSize_t fill = AvFILLp(av);
4862             if (i != fill) {
4863                 /* We weren't the last entry.
4864                    An unordered list has this property that you can take the
4865                    last element off the end to fill the hole, and it's still
4866                    an unordered list :-)
4867                 */
4868                 svp[i] = svp[fill];
4869             }
4870             svp[fill] = NULL;
4871             AvFILLp(av) = fill - 1;
4872         }
4873     }
4874 }
4875
4876 int
4877 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4878 {
4879     SV **svp = AvARRAY(av);
4880
4881     PERL_UNUSED_ARG(sv);
4882
4883     /* Not sure why the av can get freed ahead of its sv, but somehow it does
4884        in ext/B/t/bytecode.t test 15 (involving print <DATA>)  */
4885     if (svp && !SvIS_FREED(av)) {
4886         SV *const *const last = svp + AvFILLp(av);
4887
4888         while (svp <= last) {
4889             if (*svp) {
4890                 SV *const referrer = *svp;
4891                 if (SvWEAKREF(referrer)) {
4892                     /* XXX Should we check that it hasn't changed? */
4893                     SvRV_set(referrer, 0);
4894                     SvOK_off(referrer);
4895                     SvWEAKREF_off(referrer);
4896                     SvSETMAGIC(referrer);
4897                 } else if (SvTYPE(referrer) == SVt_PVGV ||
4898                            SvTYPE(referrer) == SVt_PVLV) {
4899                     /* You lookin' at me?  */
4900                     assert(GvSTASH(referrer));
4901                     assert(GvSTASH(referrer) == (HV*)sv);
4902                     GvSTASH(referrer) = 0;
4903                 } else {
4904                     Perl_croak(aTHX_
4905                                "panic: magic_killbackrefs (flags=%"UVxf")",
4906                                (UV)SvFLAGS(referrer));
4907                 }
4908
4909                 *svp = NULL;
4910             }
4911             svp++;
4912         }
4913     }
4914     SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4915     return 0;
4916 }
4917
4918 /*
4919 =for apidoc sv_insert
4920
4921 Inserts a string at the specified offset/length within the SV. Similar to
4922 the Perl substr() function.
4923
4924 =cut
4925 */
4926
4927 void
4928 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4929 {
4930     dVAR;
4931     register char *big;
4932     register char *mid;
4933     register char *midend;
4934     register char *bigend;
4935     register I32 i;
4936     STRLEN curlen;
4937
4938
4939     if (!bigstr)
4940         Perl_croak(aTHX_ "Can't modify non-existent substring");
4941     SvPV_force(bigstr, curlen);
4942     (void)SvPOK_only_UTF8(bigstr);
4943     if (offset + len > curlen) {
4944         SvGROW(bigstr, offset+len+1);
4945         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4946         SvCUR_set(bigstr, offset+len);
4947     }
4948
4949     SvTAINT(bigstr);
4950     i = littlelen - len;
4951     if (i > 0) {                        /* string might grow */
4952         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4953         mid = big + offset + len;
4954         midend = bigend = big + SvCUR(bigstr);
4955         bigend += i;
4956         *bigend = '\0';
4957         while (midend > mid)            /* shove everything down */
4958             *--bigend = *--midend;
4959         Move(little,big+offset,littlelen,char);
4960         SvCUR_set(bigstr, SvCUR(bigstr) + i);
4961         SvSETMAGIC(bigstr);
4962         return;
4963     }
4964     else if (i == 0) {
4965         Move(little,SvPVX(bigstr)+offset,len,char);
4966         SvSETMAGIC(bigstr);
4967         return;
4968     }
4969
4970     big = SvPVX(bigstr);
4971     mid = big + offset;
4972     midend = mid + len;
4973     bigend = big + SvCUR(bigstr);
4974
4975     if (midend > bigend)
4976         Perl_croak(aTHX_ "panic: sv_insert");
4977
4978     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4979         if (littlelen) {
4980             Move(little, mid, littlelen,char);
4981             mid += littlelen;
4982         }
4983         i = bigend - midend;
4984         if (i > 0) {
4985             Move(midend, mid, i,char);
4986             mid += i;
4987         }
4988         *mid = '\0';
4989         SvCUR_set(bigstr, mid - big);
4990     }
4991     else if ((i = mid - big)) { /* faster from front */
4992         midend -= littlelen;
4993         mid = midend;
4994         sv_chop(bigstr,midend-i);
4995         big += i;
4996         while (i--)
4997             *--midend = *--big;
4998         if (littlelen)
4999             Move(little, mid, littlelen,char);
5000     }
5001     else if (littlelen) {
5002         midend -= littlelen;
5003         sv_chop(bigstr,midend);
5004         Move(little,midend,littlelen,char);
5005     }
5006     else {
5007         sv_chop(bigstr,midend);
5008     }
5009     SvSETMAGIC(bigstr);
5010 }
5011
5012 /*
5013 =for apidoc sv_replace
5014
5015 Make the first argument a copy of the second, then delete the original.
5016 The target SV physically takes over ownership of the body of the source SV
5017 and inherits its flags; however, the target keeps any magic it owns,
5018 and any magic in the source is discarded.
5019 Note that this is a rather specialist SV copying operation; most of the
5020 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5021
5022 =cut
5023 */
5024
5025 void
5026 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5027 {
5028     dVAR;
5029     const U32 refcnt = SvREFCNT(sv);
5030     SV_CHECK_THINKFIRST_COW_DROP(sv);
5031     if (SvREFCNT(nsv) != 1) {
5032         Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5033                    UVuf " != 1)", (UV) SvREFCNT(nsv));
5034     }
5035     if (SvMAGICAL(sv)) {
5036         if (SvMAGICAL(nsv))
5037             mg_free(nsv);
5038         else
5039             sv_upgrade(nsv, SVt_PVMG);
5040         SvMAGIC_set(nsv, SvMAGIC(sv));
5041         SvFLAGS(nsv) |= SvMAGICAL(sv);
5042         SvMAGICAL_off(sv);
5043         SvMAGIC_set(sv, NULL);
5044     }
5045     SvREFCNT(sv) = 0;
5046     sv_clear(sv);
5047     assert(!SvREFCNT(sv));
5048 #ifdef DEBUG_LEAKING_SCALARS
5049     sv->sv_flags  = nsv->sv_flags;
5050     sv->sv_any    = nsv->sv_any;
5051     sv->sv_refcnt = nsv->sv_refcnt;
5052     sv->sv_u      = nsv->sv_u;
5053 #else
5054     StructCopy(nsv,sv,SV);
5055 #endif
5056     if(SvTYPE(sv) == SVt_IV) {
5057         SvANY(sv)
5058             = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5059     }
5060         
5061
5062 #ifdef PERL_OLD_COPY_ON_WRITE
5063     if (SvIsCOW_normal(nsv)) {
5064         /* We need to follow the pointers around the loop to make the
5065            previous SV point to sv, rather than nsv.  */
5066         SV *next;
5067         SV *current = nsv;
5068         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5069             assert(next);
5070             current = next;
5071             assert(SvPVX_const(current) == SvPVX_const(nsv));
5072         }
5073         /* Make the SV before us point to the SV after us.  */
5074         if (DEBUG_C_TEST) {
5075             PerlIO_printf(Perl_debug_log, "previous is\n");
5076             sv_dump(current);
5077             PerlIO_printf(Perl_debug_log,
5078                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5079                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5080         }
5081         SV_COW_NEXT_SV_SET(current, sv);
5082     }
5083 #endif
5084     SvREFCNT(sv) = refcnt;
5085     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5086     SvREFCNT(nsv) = 0;
5087     del_SV(nsv);
5088 }
5089
5090 /*
5091 =for apidoc sv_clear
5092
5093 Clear an SV: call any destructors, free up any memory used by the body,
5094 and free the body itself. The SV's head is I<not> freed, although
5095 its type is set to all 1's so that it won't inadvertently be assumed
5096 to be live during global destruction etc.
5097 This function should only be called when REFCNT is zero. Most of the time
5098 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5099 instead.
5100
5101 =cut
5102 */
5103
5104 void
5105 Perl_sv_clear(pTHX_ register SV *sv)
5106 {
5107     dVAR;
5108     const U32 type = SvTYPE(sv);
5109     const struct body_details *const sv_type_details
5110         = bodies_by_type + type;
5111     HV *stash;
5112
5113     assert(sv);
5114     assert(SvREFCNT(sv) == 0);
5115
5116     if (type <= SVt_IV) {
5117         /* See the comment in sv.h about the collusion between this early
5118            return and the overloading of the NULL and IV slots in the size
5119            table.  */
5120         if (SvROK(sv)) {
5121             SV * const target = SvRV(sv);
5122             if (SvWEAKREF(sv))
5123                 sv_del_backref(target, sv);
5124             else
5125                 SvREFCNT_dec(target);
5126         }
5127         SvFLAGS(sv) &= SVf_BREAK;
5128         SvFLAGS(sv) |= SVTYPEMASK;
5129         return;
5130     }
5131
5132     if (SvOBJECT(sv)) {
5133         if (PL_defstash &&      /* Still have a symbol table? */
5134             SvDESTROYABLE(sv))
5135         {
5136             dSP;
5137             HV* stash;
5138             do {        
5139                 CV* destructor;
5140                 stash = SvSTASH(sv);
5141                 destructor = StashHANDLER(stash,DESTROY);
5142                 if (destructor) {
5143                     SV* const tmpref = newRV(sv);
5144                     SvREADONLY_on(tmpref);   /* DESTROY() could be naughty */
5145                     ENTER;
5146                     PUSHSTACKi(PERLSI_DESTROY);
5147                     EXTEND(SP, 2);
5148                     PUSHMARK(SP);
5149                     PUSHs(tmpref);
5150                     PUTBACK;
5151                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5152                 
5153                 
5154                     POPSTACK;
5155                     SPAGAIN;
5156                     LEAVE;
5157                     if(SvREFCNT(tmpref) < 2) {
5158                         /* tmpref is not kept alive! */
5159                         SvREFCNT(sv)--;
5160                         SvRV_set(tmpref, NULL);
5161                         SvROK_off(tmpref);
5162                     }
5163                     SvREFCNT_dec(tmpref);
5164                 }
5165             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5166
5167
5168             if (SvREFCNT(sv)) {
5169                 if (PL_in_clean_objs)
5170                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5171                           HvNAME_get(stash));
5172                 /* DESTROY gave object new lease on life */
5173                 return;
5174             }
5175         }
5176
5177         if (SvOBJECT(sv)) {
5178             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
5179             SvOBJECT_off(sv);   /* Curse the object. */
5180             if (type != SVt_PVIO)
5181                 --PL_sv_objcount;       /* XXX Might want something more general */
5182         }
5183     }
5184     if (type >= SVt_PVMG) {
5185         if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5186             SvREFCNT_dec(SvOURSTASH(sv));
5187         } else if (SvMAGIC(sv))
5188             mg_free(sv);
5189         if (type == SVt_PVMG && SvPAD_TYPED(sv))
5190             SvREFCNT_dec(SvSTASH(sv));
5191     }
5192     switch (type) {
5193         /* case SVt_BIND: */
5194     case SVt_PVIO:
5195         if (IoIFP(sv) &&
5196             IoIFP(sv) != PerlIO_stdin() &&
5197             IoIFP(sv) != PerlIO_stdout() &&
5198             IoIFP(sv) != PerlIO_stderr())
5199         {
5200             io_close((IO*)sv, FALSE);
5201         }
5202         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5203             PerlDir_close(IoDIRP(sv));
5204         IoDIRP(sv) = (DIR*)NULL;
5205         Safefree(IoTOP_NAME(sv));
5206         Safefree(IoFMT_NAME(sv));
5207         Safefree(IoBOTTOM_NAME(sv));
5208         goto freescalar;
5209     case SVt_PVCV:
5210     case SVt_PVFM:
5211         cv_undef((CV*)sv);
5212         goto freescalar;
5213     case SVt_PVHV:
5214         Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5215         hv_undef((HV*)sv);
5216         break;
5217     case SVt_PVAV:
5218         if (PL_comppad == (AV*)sv) {
5219             PL_comppad = NULL;
5220             PL_curpad = NULL;
5221         }
5222         av_undef((AV*)sv);
5223         break;
5224     case SVt_PVLV:
5225         if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5226             SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5227             HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5228             PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5229         }
5230         else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
5231             SvREFCNT_dec(LvTARG(sv));
5232     case SVt_PVGV:
5233         if (isGV_with_GP(sv)) {
5234             if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5235                 mro_method_changed_in(stash);
5236             gp_free((GV*)sv);
5237             if (GvNAME_HEK(sv))
5238                 unshare_hek(GvNAME_HEK(sv));
5239             /* If we're in a stash, we don't own a reference to it. However it does
5240                have a back reference to us, which needs to be cleared.  */
5241             if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5242                     sv_del_backref((SV*)stash, sv);
5243         }
5244         /* FIXME. There are probably more unreferenced pointers to SVs in the
5245            interpreter struct that we should check and tidy in a similar
5246            fashion to this:  */
5247         if ((GV*)sv == PL_last_in_gv)
5248             PL_last_in_gv = NULL;
5249     case SVt_PVMG:
5250     case SVt_PVNV:
5251     case SVt_PVIV:
5252       freescalar:
5253         /* Don't bother with SvOOK_off(sv); as we're only going to free it.  */
5254         if (SvOOK(sv)) {
5255             SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5256             /* Don't even bother with turning off the OOK flag.  */
5257         }
5258     case SVt_PV:
5259         if (SvROK(sv)) {
5260             SV * const target = SvRV(sv);
5261             if (SvWEAKREF(sv))
5262                 sv_del_backref(target, sv);
5263             else
5264                 SvREFCNT_dec(target);
5265         }
5266 #ifdef PERL_OLD_COPY_ON_WRITE
5267         else if (SvPVX_const(sv)) {
5268             if (SvIsCOW(sv)) {
5269                 /* I believe I need to grab the global SV mutex here and
5270                    then recheck the COW status.  */
5271                 if (DEBUG_C_TEST) {
5272                     PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5273                     sv_dump(sv);
5274                 }
5275                 if (SvLEN(sv)) {
5276                     sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5277                 } else {
5278                     unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5279                 }
5280
5281                 /* And drop it here.  */
5282                 SvFAKE_off(sv);
5283             } else if (SvLEN(sv)) {
5284                 Safefree(SvPVX_const(sv));
5285             }
5286         }
5287 #else
5288         else if (SvPVX_const(sv) && SvLEN(sv))
5289             Safefree(SvPVX_mutable(sv));
5290         else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5291             unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5292             SvFAKE_off(sv);
5293         }
5294 #endif
5295         break;
5296     case SVt_NV:
5297         break;
5298     }
5299
5300     SvFLAGS(sv) &= SVf_BREAK;
5301     SvFLAGS(sv) |= SVTYPEMASK;
5302
5303     if (sv_type_details->arena) {
5304         del_body(((char *)SvANY(sv) + sv_type_details->offset),
5305                  &PL_body_roots[type]);
5306     }
5307     else if (sv_type_details->body_size) {
5308         my_safefree(SvANY(sv));
5309     }
5310 }
5311
5312 /*
5313 =for apidoc sv_newref
5314
5315 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5316 instead.
5317
5318 =cut
5319 */
5320
5321 SV *
5322 Perl_sv_newref(pTHX_ SV *sv)
5323 {
5324     PERL_UNUSED_CONTEXT;
5325     if (sv)
5326         (SvREFCNT(sv))++;
5327     return sv;
5328 }
5329
5330 /*
5331 =for apidoc sv_free
5332
5333 Decrement an SV's reference count, and if it drops to zero, call
5334 C<sv_clear> to invoke destructors and free up any memory used by
5335 the body; finally, deallocate the SV's head itself.
5336 Normally called via a wrapper macro C<SvREFCNT_dec>.
5337
5338 =cut
5339 */
5340
5341 void
5342 Perl_sv_free(pTHX_ SV *sv)
5343 {
5344     dVAR;
5345     if (!sv)
5346         return;
5347     if (SvREFCNT(sv) == 0) {
5348         if (SvFLAGS(sv) & SVf_BREAK)
5349             /* this SV's refcnt has been artificially decremented to
5350              * trigger cleanup */
5351             return;
5352         if (PL_in_clean_all) /* All is fair */
5353             return;
5354         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5355             /* make sure SvREFCNT(sv)==0 happens very seldom */
5356             SvREFCNT(sv) = (~(U32)0)/2;
5357             return;
5358         }
5359         if (ckWARN_d(WARN_INTERNAL)) {
5360             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5361                         "Attempt to free unreferenced scalar: SV 0x%"UVxf
5362                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5363 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5364             Perl_dump_sv_child(aTHX_ sv);
5365 #else
5366   #ifdef DEBUG_LEAKING_SCALARS
5367         sv_dump(sv);
5368   #endif
5369 #endif
5370         }
5371         return;
5372     }
5373     if (--(SvREFCNT(sv)) > 0)
5374         return;
5375     Perl_sv_free2(aTHX_ sv);
5376 }
5377
5378 void
5379 Perl_sv_free2(pTHX_ SV *sv)
5380 {
5381     dVAR;
5382 #ifdef DEBUGGING
5383     if (SvTEMP(sv)) {
5384         if (ckWARN_d(WARN_DEBUGGING))
5385             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5386                         "Attempt to free temp prematurely: SV 0x%"UVxf
5387                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5388         return;
5389     }
5390 #endif
5391     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5392         /* make sure SvREFCNT(sv)==0 happens very seldom */
5393         SvREFCNT(sv) = (~(U32)0)/2;
5394         return;
5395     }
5396     sv_clear(sv);
5397     if (! SvREFCNT(sv))
5398         del_SV(sv);
5399 }
5400
5401 /*
5402 =for apidoc sv_len
5403
5404 Returns the length of the string in the SV. Handles magic and type
5405 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5406
5407 =cut
5408 */
5409
5410 STRLEN
5411 Perl_sv_len(pTHX_ register SV *sv)
5412 {
5413     STRLEN len;
5414
5415     if (!sv)
5416         return 0;
5417
5418     if (SvGMAGICAL(sv))
5419         len = mg_length(sv);
5420     else
5421         (void)SvPV_const(sv, len);
5422     return len;
5423 }
5424
5425 /*
5426 =for apidoc sv_len_utf8
5427
5428 Returns the number of characters in the string in an SV, counting wide
5429 UTF-8 bytes as a single character. Handles magic and type coercion.
5430
5431 =cut
5432 */
5433
5434 /*
5435  * The length is cached in PERL_UTF8_magic, in the mg_len field.  Also the
5436  * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5437  * (Note that the mg_len is not the length of the mg_ptr field.
5438  * This allows the cache to store the character length of the string without
5439  * needing to malloc() extra storage to attach to the mg_ptr.)
5440  *
5441  */
5442
5443 STRLEN
5444 Perl_sv_len_utf8(pTHX_ register SV *sv)
5445 {
5446     if (!sv)
5447         return 0;
5448
5449     if (SvGMAGICAL(sv))
5450         return mg_length(sv);
5451     else
5452     {
5453         STRLEN len;
5454         const U8 *s = (U8*)SvPV_const(sv, len);
5455
5456         if (PL_utf8cache) {
5457             STRLEN ulen;
5458             MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5459
5460             if (mg && mg->mg_len != -1) {
5461                 ulen = mg->mg_len;
5462                 if (PL_utf8cache < 0) {
5463                     const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5464                     if (real != ulen) {
5465                         /* Need to turn the assertions off otherwise we may
5466                            recurse infinitely while printing error messages.
5467                         */
5468                         SAVEI8(PL_utf8cache);
5469                         PL_utf8cache = 0;
5470                         Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5471                                    " real %"UVuf" for %"SVf,
5472                                    (UV) ulen, (UV) real, SVfARG(sv));
5473                     }
5474                 }
5475             }
5476             else {
5477                 ulen = Perl_utf8_length(aTHX_ s, s + len);
5478                 if (!SvREADONLY(sv)) {
5479                     if (!mg) {
5480                         mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5481                                          &PL_vtbl_utf8, 0, 0);
5482                     }
5483                     assert(mg);
5484                     mg->mg_len = ulen;
5485                 }
5486             }
5487             return ulen;
5488         }
5489         return Perl_utf8_length(aTHX_ s, s + len);
5490     }
5491 }
5492
5493 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5494    offset.  */
5495 static STRLEN
5496 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5497                       STRLEN uoffset)
5498 {
5499     const U8 *s = start;
5500
5501     while (s < send && uoffset--)
5502         s += UTF8SKIP(s);
5503     if (s > send) {
5504         /* This is the existing behaviour. Possibly it should be a croak, as
5505            it's actually a bounds error  */
5506         s = send;
5507     }
5508     return s - start;
5509 }
5510
5511 /* Given the length of the string in both bytes and UTF-8 characters, decide
5512    whether to walk forwards or backwards to find the byte corresponding to
5513    the passed in UTF-8 offset.  */
5514 static STRLEN
5515 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5516                       STRLEN uoffset, STRLEN uend)
5517 {
5518     STRLEN backw = uend - uoffset;
5519     if (uoffset < 2 * backw) {
5520         /* The assumption is that going forwards is twice the speed of going
5521            forward (that's where the 2 * backw comes from).
5522            (The real figure of course depends on the UTF-8 data.)  */
5523         return sv_pos_u2b_forwards(start, send, uoffset);
5524     }
5525
5526     while (backw--) {
5527         send--;
5528         while (UTF8_IS_CONTINUATION(*send))
5529             send--;
5530     }
5531     return send - start;
5532 }
5533
5534 /* For the string representation of the given scalar, find the byte
5535    corresponding to the passed in UTF-8 offset.  uoffset0 and boffset0
5536    give another position in the string, *before* the sought offset, which
5537    (which is always true, as 0, 0 is a valid pair of positions), which should
5538    help reduce the amount of linear searching.
5539    If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5540    will be used to reduce the amount of linear searching. The cache will be
5541    created if necessary, and the found value offered to it for update.  */
5542 static STRLEN
5543 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5544                     const U8 *const send, STRLEN uoffset,
5545                     STRLEN uoffset0, STRLEN boffset0) {
5546     STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy.  */
5547     bool found = FALSE;
5548
5549     assert (uoffset >= uoffset0);
5550
5551     if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5552         && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5553         if ((*mgp)->mg_ptr) {
5554             STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5555             if (cache[0] == uoffset) {
5556                 /* An exact match. */
5557                 return cache[1];
5558             }
5559             if (cache[2] == uoffset) {
5560                 /* An exact match. */
5561                 return cache[3];
5562             }
5563
5564             if (cache[0] < uoffset) {
5565                 /* The cache already knows part of the way.   */
5566                 if (cache[0] > uoffset0) {
5567                     /* The cache knows more than the passed in pair  */
5568                     uoffset0 = cache[0];
5569                     boffset0 = cache[1];
5570                 }
5571                 if ((*mgp)->mg_len != -1) {
5572                     /* And we know the end too.  */
5573                     boffset = boffset0
5574                         + sv_pos_u2b_midway(start + boffset0, send,
5575                                               uoffset - uoffset0,
5576                                               (*mgp)->mg_len - uoffset0);
5577                 } else {
5578                     boffset = boffset0
5579                         + sv_pos_u2b_forwards(start + boffset0,
5580                                                 send, uoffset - uoffset0);
5581                 }
5582             }
5583             else if (cache[2] < uoffset) {
5584                 /* We're between the two cache entries.  */
5585                 if (cache[2] > uoffset0) {
5586                     /* and the cache knows more than the passed in pair  */
5587                     uoffset0 = cache[2];
5588                     boffset0 = cache[3];
5589                 }
5590
5591                 boffset = boffset0
5592                     + sv_pos_u2b_midway(start + boffset0,
5593                                           start + cache[1],
5594                                           uoffset - uoffset0,
5595                                           cache[0] - uoffset0);
5596             } else {
5597                 boffset = boffset0
5598                     + sv_pos_u2b_midway(start + boffset0,
5599                                           start + cache[3],
5600                                           uoffset - uoffset0,
5601                                           cache[2] - uoffset0);
5602             }
5603             found = TRUE;
5604         }
5605         else if ((*mgp)->mg_len != -1) {
5606             /* If we can take advantage of a passed in offset, do so.  */
5607             /* In fact, offset0 is either 0, or less than offset, so don't
5608                need to worry about the other possibility.  */
5609             boffset = boffset0
5610                 + sv_pos_u2b_midway(start + boffset0, send,
5611                                       uoffset - uoffset0,
5612                                       (*mgp)->mg_len - uoffset0);
5613             found = TRUE;
5614         }
5615     }
5616
5617     if (!found || PL_utf8cache < 0) {
5618         const STRLEN real_boffset
5619             = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5620                                                send, uoffset - uoffset0);
5621
5622         if (found && PL_utf8cache < 0) {
5623             if (real_boffset != boffset) {
5624                 /* Need to turn the assertions off otherwise we may recurse
5625                    infinitely while printing error messages.  */
5626                 SAVEI8(PL_utf8cache);
5627                 PL_utf8cache = 0;
5628                 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5629                            " real %"UVuf" for %"SVf,
5630                            (UV) boffset, (UV) real_boffset, SVfARG(sv));
5631             }
5632         }
5633         boffset = real_boffset;
5634     }
5635
5636     S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5637     return boffset;
5638 }
5639
5640
5641 /*
5642 =for apidoc sv_pos_u2b
5643
5644 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5645 the start of the string, to a count of the equivalent number of bytes; if
5646 lenp is non-zero, it does the same to lenp, but this time starting from
5647 the offset, rather than from the start of the string. Handles magic and
5648 type coercion.
5649
5650 =cut
5651 */
5652
5653 /*
5654  * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5655  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5656  * byte offsets.  See also the comments of S_utf8_mg_pos_cache_update().
5657  *
5658  */
5659
5660 void
5661 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5662 {
5663     const U8 *start;
5664     STRLEN len;
5665
5666     if (!sv)
5667         return;
5668
5669     start = (U8*)SvPV_const(sv, len);
5670     if (len) {
5671         STRLEN uoffset = (STRLEN) *offsetp;
5672         const U8 * const send = start + len;
5673         MAGIC *mg = NULL;
5674         const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5675                                              uoffset, 0, 0);
5676
5677         *offsetp = (I32) boffset;
5678
5679         if (lenp) {
5680             /* Convert the relative offset to absolute.  */
5681             const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5682             const STRLEN boffset2
5683                 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5684                                       uoffset, boffset) - boffset;
5685
5686             *lenp = boffset2;
5687         }
5688     }
5689     else {
5690          *offsetp = 0;
5691          if (lenp)
5692               *lenp = 0;
5693     }
5694
5695     return;
5696 }
5697
5698 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5699    byte length pairing. The (byte) length of the total SV is passed in too,
5700    as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5701    may not have updated SvCUR, so we can't rely on reading it directly.
5702
5703    The proffered utf8/byte length pairing isn't used if the cache already has
5704    two pairs, and swapping either for the proffered pair would increase the
5705    RMS of the intervals between known byte offsets.
5706
5707    The cache itself consists of 4 STRLEN values
5708    0: larger UTF-8 offset
5709    1: corresponding byte offset
5710    2: smaller UTF-8 offset
5711    3: corresponding byte offset
5712
5713    Unused cache pairs have the value 0, 0.
5714    Keeping the cache "backwards" means that the invariant of
5715    cache[0] >= cache[2] is maintained even with empty slots, which means that
5716    the code that uses it doesn't need to worry if only 1 entry has actually
5717    been set to non-zero.  It also makes the "position beyond the end of the
5718    cache" logic much simpler, as the first slot is always the one to start
5719    from.   
5720 */
5721 static void
5722 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5723                            STRLEN blen)
5724 {
5725     STRLEN *cache;
5726     if (SvREADONLY(sv))
5727         return;
5728
5729     if (!*mgp) {
5730         *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5731                            0);
5732         (*mgp)->mg_len = -1;
5733     }
5734     assert(*mgp);
5735
5736     if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5737         Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5738         (*mgp)->mg_ptr = (char *) cache;
5739     }
5740     assert(cache);
5741
5742     if (PL_utf8cache < 0) {
5743         const U8 *start = (const U8 *) SvPVX_const(sv);
5744         const STRLEN realutf8 = utf8_length(start, start + byte);
5745
5746         if (realutf8 != utf8) {
5747             /* Need to turn the assertions off otherwise we may recurse
5748                infinitely while printing error messages.  */
5749             SAVEI8(PL_utf8cache);
5750             PL_utf8cache = 0;
5751             Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5752                        " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5753         }
5754     }
5755
5756     /* Cache is held with the later position first, to simplify the code
5757        that deals with unbounded ends.  */
5758        
5759     ASSERT_UTF8_CACHE(cache);
5760     if (cache[1] == 0) {
5761         /* Cache is totally empty  */
5762         cache[0] = utf8;
5763         cache[1] = byte;
5764     } else if (cache[3] == 0) {
5765         if (byte > cache[1]) {
5766             /* New one is larger, so goes first.  */
5767             cache[2] = cache[0];
5768             cache[3] = cache[1];
5769             cache[0] = utf8;
5770             cache[1] = byte;
5771         } else {
5772             cache[2] = utf8;
5773             cache[3] = byte;
5774         }
5775     } else {
5776 #define THREEWAY_SQUARE(a,b,c,d) \
5777             ((float)((d) - (c))) * ((float)((d) - (c))) \
5778             + ((float)((c) - (b))) * ((float)((c) - (b))) \
5779                + ((float)((b) - (a))) * ((float)((b) - (a)))
5780
5781         /* Cache has 2 slots in use, and we know three potential pairs.
5782            Keep the two that give the lowest RMS distance. Do the
5783            calcualation in bytes simply because we always know the byte
5784            length.  squareroot has the same ordering as the positive value,
5785            so don't bother with the actual square root.  */
5786         const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5787         if (byte > cache[1]) {
5788             /* New position is after the existing pair of pairs.  */
5789             const float keep_earlier
5790                 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5791             const float keep_later
5792                 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5793
5794             if (keep_later < keep_earlier) {
5795                 if (keep_later < existing) {
5796                     cache[2] = cache[0];
5797                     cache[3] = cache[1];
5798                     cache[0] = utf8;
5799                     cache[1] = byte;
5800                 }
5801             }
5802             else {
5803                 if (keep_earlier < existing) {
5804                     cache[0] = utf8;
5805                     cache[1] = byte;
5806                 }
5807             }
5808         }
5809         else if (byte > cache[3]) {
5810             /* New position is between the existing pair of pairs.  */
5811             const float keep_earlier
5812                 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5813             const float keep_later
5814                 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5815
5816             if (keep_later < keep_earlier) {
5817                 if (keep_later < existing) {
5818                     cache[2] = utf8;
5819                     cache[3] = byte;
5820                 }
5821             }
5822             else {
5823                 if (keep_earlier < existing) {
5824                     cache[0] = utf8;
5825                     cache[1] = byte;
5826                 }
5827             }
5828         }
5829         else {
5830             /* New position is before the existing pair of pairs.  */
5831             const float keep_earlier
5832                 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5833             const float keep_later
5834                 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5835
5836             if (keep_later < keep_earlier) {
5837                 if (keep_later < existing) {
5838                     cache[2] = utf8;
5839                     cache[3] = byte;
5840                 }
5841             }
5842             else {
5843                 if (keep_earlier < existing) {
5844                     cache[0] = cache[2];
5845                     cache[1] = cache[3];
5846                     cache[2] = utf8;
5847                     cache[3] = byte;
5848                 }
5849             }
5850         }
5851     }
5852     ASSERT_UTF8_CACHE(cache);
5853 }
5854
5855 /* We already know all of the way, now we may be able to walk back.  The same
5856    assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5857    backward is half the speed of walking forward. */
5858 static STRLEN
5859 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5860                     STRLEN endu)
5861 {
5862     const STRLEN forw = target - s;
5863     STRLEN backw = end - target;
5864
5865     if (forw < 2 * backw) {
5866         return utf8_length(s, target);
5867     }
5868
5869     while (end > target) {
5870         end--;
5871         while (UTF8_IS_CONTINUATION(*end)) {
5872             end--;
5873         }
5874         endu--;
5875     }
5876     return endu;
5877 }
5878
5879 /*
5880 =for apidoc sv_pos_b2u
5881
5882 Converts the value pointed to by offsetp from a count of bytes from the
5883 start of the string, to a count of the equivalent number of UTF-8 chars.
5884 Handles magic and type coercion.
5885
5886 =cut
5887 */
5888
5889 /*
5890  * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5891  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5892  * byte offsets.
5893  *
5894  */
5895 void
5896 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5897 {
5898     const U8* s;
5899     const STRLEN byte = *offsetp;
5900     STRLEN len = 0; /* Actually always set, but let's keep gcc happy.  */
5901     STRLEN blen;
5902     MAGIC* mg = NULL;
5903     const U8* send;
5904     bool found = FALSE;
5905
5906     if (!sv)
5907         return;
5908
5909     s = (const U8*)SvPV_const(sv, blen);
5910
5911     if (blen < byte)
5912         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5913
5914     send = s + byte;
5915
5916     if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5917         && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5918         if (mg->mg_ptr) {
5919             STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5920             if (cache[1] == byte) {
5921                 /* An exact match. */
5922                 *offsetp = cache[0];
5923                 return;
5924             }
5925             if (cache[3] == byte) {
5926                 /* An exact match. */
5927                 *offsetp = cache[2];
5928                 return;
5929             }
5930
5931             if (cache[1] < byte) {
5932                 /* We already know part of the way. */
5933                 if (mg->mg_len != -1) {
5934                     /* Actually, we know the end too.  */
5935                     len = cache[0]
5936                         + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5937                                               s + blen, mg->mg_len - cache[0]);
5938                 } else {
5939                     len = cache[0] + utf8_length(s + cache[1], send);
5940                 }
5941             }
5942             else if (cache[3] < byte) {
5943                 /* We're between the two cached pairs, so we do the calculation
5944                    offset by the byte/utf-8 positions for the earlier pair,
5945                    then add the utf-8 characters from the string start to
5946                    there.  */
5947                 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5948                                           s + cache[1], cache[0] - cache[2])
5949                     + cache[2];
5950
5951             }
5952             else { /* cache[3] > byte */
5953                 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5954                                           cache[2]);
5955
5956             }
5957             ASSERT_UTF8_CACHE(cache);
5958             found = TRUE;
5959         } else if (mg->mg_len != -1) {
5960             len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5961             found = TRUE;
5962         }
5963     }
5964     if (!found || PL_utf8cache < 0) {
5965         const STRLEN real_len = utf8_length(s, send);
5966
5967         if (found && PL_utf8cache < 0) {
5968             if (len != real_len) {
5969                 /* Need to turn the assertions off otherwise we may recurse
5970                    infinitely while printing error messages.  */
5971                 SAVEI8(PL_utf8cache);
5972                 PL_utf8cache = 0;
5973                 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5974                            " real %"UVuf" for %"SVf,
5975                            (UV) len, (UV) real_len, SVfARG(sv));
5976             }
5977         }
5978         len = real_len;
5979     }
5980     *offsetp = len;
5981
5982     S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5983 }
5984
5985 /*
5986 =for apidoc sv_eq
5987
5988 Returns a boolean indicating whether the strings in the two SVs are
5989 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5990 coerce its args to strings if necessary.
5991
5992 =cut
5993 */
5994
5995 I32
5996 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5997 {
5998     dVAR;
5999     const char *pv1;
6000     STRLEN cur1;
6001     const char *pv2;
6002     STRLEN cur2;
6003     I32  eq     = 0;
6004     char *tpv   = NULL;
6005     SV* svrecode = NULL;
6006
6007     if (!sv1) {
6008         pv1 = "";
6009         cur1 = 0;
6010     }
6011     else {
6012         /* if pv1 and pv2 are the same, second SvPV_const call may
6013          * invalidate pv1, so we may need to make a copy */
6014         if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6015             pv1 = SvPV_const(sv1, cur1);
6016             sv1 = sv_2mortal(newSVpvn(pv1, cur1));
6017             if (SvUTF8(sv2)) SvUTF8_on(sv1);
6018         }
6019         pv1 = SvPV_const(sv1, cur1);
6020     }
6021
6022     if (!sv2){
6023         pv2 = "";
6024         cur2 = 0;
6025     }
6026     else
6027         pv2 = SvPV_const(sv2, cur2);
6028
6029     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6030         /* Differing utf8ness.
6031          * Do not UTF8size the comparands as a side-effect. */
6032          if (PL_encoding) {
6033               if (SvUTF8(sv1)) {
6034                    svrecode = newSVpvn(pv2, cur2);
6035                    sv_recode_to_utf8(svrecode, PL_encoding);
6036                    pv2 = SvPV_const(svrecode, cur2);
6037               }
6038               else {
6039                    svrecode = newSVpvn(pv1, cur1);
6040                    sv_recode_to_utf8(svrecode, PL_encoding);
6041                    pv1 = SvPV_const(svrecode, cur1);
6042               }
6043               /* Now both are in UTF-8. */
6044               if (cur1 != cur2) {
6045                    SvREFCNT_dec(svrecode);
6046                    return FALSE;
6047               }
6048          }
6049          else {
6050               bool is_utf8 = TRUE;
6051
6052               if (SvUTF8(sv1)) {
6053                    /* sv1 is the UTF-8 one,
6054                     * if is equal it must be downgrade-able */
6055                    char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6056                                                      &cur1, &is_utf8);
6057                    if (pv != pv1)
6058                         pv1 = tpv = pv;
6059               }
6060               else {
6061                    /* sv2 is the UTF-8 one,
6062                     * if is equal it must be downgrade-able */
6063                    char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6064                                                       &cur2, &is_utf8);
6065                    if (pv != pv2)
6066                         pv2 = tpv = pv;
6067               }
6068               if (is_utf8) {
6069                    /* Downgrade not possible - cannot be eq */
6070                    assert (tpv == 0);
6071                    return FALSE;
6072               }
6073          }
6074     }
6075
6076     if (cur1 == cur2)
6077         eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6078         
6079     SvREFCNT_dec(svrecode);
6080     if (tpv)
6081         Safefree(tpv);
6082
6083     return eq;
6084 }
6085
6086 /*
6087 =for apidoc sv_cmp
6088
6089 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
6090 string in C<sv1> is less than, equal to, or greater than the string in
6091 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6092 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
6093
6094 =cut
6095 */
6096
6097 I32
6098 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6099 {
6100     dVAR;
6101     STRLEN cur1, cur2;
6102     const char *pv1, *pv2;
6103     char *tpv = NULL;
6104     I32  cmp;
6105     SV *svrecode = NULL;
6106
6107     if (!sv1) {
6108         pv1 = "";
6109         cur1 = 0;
6110     }
6111     else
6112         pv1 = SvPV_const(sv1, cur1);
6113
6114     if (!sv2) {
6115         pv2 = "";
6116         cur2 = 0;
6117     }
6118     else
6119         pv2 = SvPV_const(sv2, cur2);
6120
6121     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6122         /* Differing utf8ness.
6123          * Do not UTF8size the comparands as a side-effect. */
6124         if (SvUTF8(sv1)) {
6125             if (PL_encoding) {
6126                  svrecode = newSVpvn(pv2, cur2);
6127                  sv_recode_to_utf8(svrecode, PL_encoding);
6128                  pv2 = SvPV_const(svrecode, cur2);
6129             }
6130             else {
6131                  pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6132             }
6133         }
6134         else {
6135             if (PL_encoding) {
6136                  svrecode = newSVpvn(pv1, cur1);
6137                  sv_recode_to_utf8(svrecode, PL_encoding);
6138                  pv1 = SvPV_const(svrecode, cur1);
6139             }
6140             else {
6141                  pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6142             }
6143         }
6144     }
6145
6146     if (!cur1) {
6147         cmp = cur2 ? -1 : 0;
6148     } else if (!cur2) {
6149         cmp = 1;
6150     } else {
6151         const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6152
6153         if (retval) {
6154             cmp = retval < 0 ? -1 : 1;
6155         } else if (cur1 == cur2) {
6156             cmp = 0;
6157         } else {
6158             cmp = cur1 < cur2 ? -1 : 1;
6159         }
6160     }
6161
6162     SvREFCNT_dec(svrecode);
6163     if (tpv)
6164         Safefree(tpv);
6165
6166     return cmp;
6167 }
6168
6169 /*
6170 =for apidoc sv_cmp_locale
6171
6172 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6173 'use bytes' aware, handles get magic, and will coerce its args to strings
6174 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
6175
6176 =cut
6177 */
6178
6179 I32
6180 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6181 {
6182     dVAR;
6183 #ifdef USE_LOCALE_COLLATE
6184
6185     char *pv1, *pv2;
6186     STRLEN len1, len2;
6187     I32 retval;
6188
6189     if (PL_collation_standard)
6190         goto raw_compare;
6191
6192     len1 = 0;
6193     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6194     len2 = 0;
6195     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6196
6197     if (!pv1 || !len1) {
6198         if (pv2 && len2)
6199             return -1;
6200         else
6201             goto raw_compare;
6202     }
6203     else {
6204         if (!pv2 || !len2)
6205             return 1;
6206     }
6207
6208     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6209
6210     if (retval)
6211         return retval < 0 ? -1 : 1;
6212
6213     /*
6214      * When the result of collation is equality, that doesn't mean
6215      * that there are no differences -- some locales exclude some
6216      * characters from consideration.  So to avoid false equalities,
6217      * we use the raw string as a tiebreaker.
6218      */
6219
6220   raw_compare:
6221     /*FALLTHROUGH*/
6222
6223 #endif /* USE_LOCALE_COLLATE */
6224
6225     return sv_cmp(sv1, sv2);
6226 }
6227
6228
6229 #ifdef USE_LOCALE_COLLATE
6230
6231 /*
6232 =for apidoc sv_collxfrm
6233
6234 Add Collate Transform magic to an SV if it doesn't already have it.
6235
6236 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6237 scalar data of the variable, but transformed to such a format that a normal
6238 memory comparison can be used to compare the data according to the locale
6239 settings.
6240
6241 =cut
6242 */
6243
6244 char *
6245 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6246 {
6247     dVAR;
6248     MAGIC *mg;
6249
6250     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6251     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6252         const char *s;
6253         char *xf;
6254         STRLEN len, xlen;
6255
6256         if (mg)
6257             Safefree(mg->mg_ptr);
6258         s = SvPV_const(sv, len);
6259         if ((xf = mem_collxfrm(s, len, &xlen))) {
6260             if (SvREADONLY(sv)) {
6261                 SAVEFREEPV(xf);
6262                 *nxp = xlen;
6263                 return xf + sizeof(PL_collation_ix);
6264             }
6265             if (! mg) {
6266 #ifdef PERL_OLD_COPY_ON_WRITE
6267                 if (SvIsCOW(sv))
6268                     sv_force_normal_flags(sv, 0);
6269 #endif
6270                 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6271                                  0, 0);
6272                 assert(mg);
6273             }
6274             mg->mg_ptr = xf;
6275             mg->mg_len = xlen;
6276         }
6277         else {
6278             if (mg) {
6279                 mg->mg_ptr = NULL;
6280                 mg->mg_len = -1;
6281             }
6282         }
6283     }
6284     if (mg && mg->mg_ptr) {
6285         *nxp = mg->mg_len;
6286         return mg->mg_ptr + sizeof(PL_collation_ix);
6287     }
6288     else {
6289         *nxp = 0;
6290         return NULL;
6291     }
6292 }
6293
6294 #endif /* USE_LOCALE_COLLATE */
6295
6296 /*
6297 =for apidoc sv_gets
6298
6299 Get a line from the filehandle and store it into the SV, optionally
6300 appending to the currently-stored string.
6301
6302 =cut
6303 */
6304
6305 char *
6306 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6307 {
6308     dVAR;
6309     const char *rsptr;
6310     STRLEN rslen;
6311     register STDCHAR rslast;
6312     register STDCHAR *bp;
6313     register I32 cnt;
6314     I32 i = 0;
6315     I32 rspara = 0;
6316
6317     if (SvTHINKFIRST(sv))
6318         sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6319     /* XXX. If you make this PVIV, then copy on write can copy scalars read
6320        from <>.
6321        However, perlbench says it's slower, because the existing swipe code
6322        is faster than copy on write.
6323        Swings and roundabouts.  */
6324     SvUPGRADE(sv, SVt_PV);
6325
6326     SvSCREAM_off(sv);
6327
6328     if (append) {
6329         if (PerlIO_isutf8(fp)) {
6330             if (!SvUTF8(sv)) {
6331                 sv_utf8_upgrade_nomg(sv);
6332                 sv_pos_u2b(sv,&append,0);
6333             }
6334         } else if (SvUTF8(sv)) {
6335             SV * const tsv = newSV(0);
6336             sv_gets(tsv, fp, 0);
6337             sv_utf8_upgrade_nomg(tsv);
6338             SvCUR_set(sv,append);
6339             sv_catsv(sv,tsv);
6340             sv_free(tsv);
6341             goto return_string_or_null;
6342         }
6343     }
6344
6345     SvPOK_only(sv);
6346     if (PerlIO_isutf8(fp))
6347         SvUTF8_on(sv);
6348
6349     if (IN_PERL_COMPILETIME) {
6350         /* we always read code in line mode */
6351         rsptr = "\n";
6352         rslen = 1;
6353     }
6354     else if (RsSNARF(PL_rs)) {
6355         /* If it is a regular disk file use size from stat() as estimate
6356            of amount we are going to read -- may result in mallocing
6357            more memory than we really need if the layers below reduce
6358            the size we read (e.g. CRLF or a gzip layer).
6359          */
6360         Stat_t st;
6361         if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode))  {
6362             const Off_t offset = PerlIO_tell(fp);
6363             if (offset != (Off_t) -1 && st.st_size + append > offset) {
6364                 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6365             }
6366         }
6367         rsptr = NULL;
6368         rslen = 0;
6369     }
6370     else if (RsRECORD(PL_rs)) {
6371       I32 bytesread;
6372       char *buffer;
6373       U32 recsize;
6374
6375       /* Grab the size of the record we're getting */
6376       recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6377       buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6378       /* Go yank in */
6379 #ifdef VMS
6380       /* VMS wants read instead of fread, because fread doesn't respect */
6381       /* RMS record boundaries. This is not necessarily a good thing to be */
6382       /* doing, but we've got no other real choice - except avoid stdio
6383          as implementation - perhaps write a :vms layer ?
6384        */
6385       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6386 #else
6387       bytesread = PerlIO_read(fp, buffer, recsize);
6388 #endif
6389       if (bytesread < 0)
6390           bytesread = 0;
6391       SvCUR_set(sv, bytesread += append);
6392       buffer[bytesread] = '\0';
6393       goto return_string_or_null;
6394     }
6395     else if (RsPARA(PL_rs)) {
6396         rsptr = "\n\n";
6397         rslen = 2;
6398         rspara = 1;
6399     }
6400     else {
6401         /* Get $/ i.e. PL_rs into same encoding as stream wants */
6402         if (PerlIO_isutf8(fp)) {
6403             rsptr = SvPVutf8(PL_rs, rslen);
6404         }
6405         else {
6406             if (SvUTF8(PL_rs)) {
6407                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6408                     Perl_croak(aTHX_ "Wide character in $/");
6409                 }
6410             }
6411             rsptr = SvPV_const(PL_rs, rslen);
6412         }
6413     }
6414
6415     rslast = rslen ? rsptr[rslen - 1] : '\0';
6416
6417     if (rspara) {               /* have to do this both before and after */
6418         do {                    /* to make sure file boundaries work right */
6419             if (PerlIO_eof(fp))
6420                 return 0;
6421             i = PerlIO_getc(fp);
6422             if (i != '\n') {
6423                 if (i == -1)
6424                     return 0;
6425                 PerlIO_ungetc(fp,i);
6426                 break;
6427             }
6428         } while (i != EOF);
6429     }
6430
6431     /* See if we know enough about I/O mechanism to cheat it ! */
6432
6433     /* This used to be #ifdef test - it is made run-time test for ease
6434        of abstracting out stdio interface. One call should be cheap
6435        enough here - and may even be a macro allowing compile
6436        time optimization.
6437      */
6438
6439     if (PerlIO_fast_gets(fp)) {
6440
6441     /*
6442      * We're going to steal some values from the stdio struct
6443      * and put EVERYTHING in the innermost loop into registers.
6444      */
6445     register STDCHAR *ptr;
6446     STRLEN bpx;
6447     I32 shortbuffered;
6448
6449 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6450     /* An ungetc()d char is handled separately from the regular
6451      * buffer, so we getc() it back out and stuff it in the buffer.
6452      */
6453     i = PerlIO_getc(fp);
6454     if (i == EOF) return 0;
6455     *(--((*fp)->_ptr)) = (unsigned char) i;
6456     (*fp)->_cnt++;
6457 #endif
6458
6459     /* Here is some breathtakingly efficient cheating */
6460
6461     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
6462     /* make sure we have the room */
6463     if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6464         /* Not room for all of it
6465            if we are looking for a separator and room for some
6466          */
6467         if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6468             /* just process what we have room for */
6469             shortbuffered = cnt - SvLEN(sv) + append + 1;
6470             cnt -= shortbuffered;
6471         }
6472         else {
6473             shortbuffered = 0;
6474             /* remember that cnt can be negative */
6475             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6476         }
6477     }
6478     else
6479         shortbuffered = 0;
6480     bp = (STDCHAR*)SvPVX_const(sv) + append;  /* move these two too to registers */
6481     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6482     DEBUG_P(PerlIO_printf(Perl_debug_log,
6483         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6484     DEBUG_P(PerlIO_printf(Perl_debug_log,
6485         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6486                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6487                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6488     for (;;) {
6489       screamer:
6490         if (cnt > 0) {
6491             if (rslen) {
6492                 while (cnt > 0) {                    /* this     |  eat */
6493                     cnt--;
6494                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
6495                         goto thats_all_folks;        /* screams  |  sed :-) */
6496                 }
6497             }
6498             else {
6499                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
6500                 bp += cnt;                           /* screams  |  dust */
6501                 ptr += cnt;                          /* louder   |  sed :-) */
6502                 cnt = 0;
6503             }
6504         }
6505         
6506         if (shortbuffered) {            /* oh well, must extend */
6507             cnt = shortbuffered;
6508             shortbuffered = 0;
6509             bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6510             SvCUR_set(sv, bpx);
6511             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6512             bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6513             continue;
6514         }
6515
6516         DEBUG_P(PerlIO_printf(Perl_debug_log,
6517                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6518                               PTR2UV(ptr),(long)cnt));
6519         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6520 #if 0
6521         DEBUG_P(PerlIO_printf(Perl_debug_log,
6522             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6523             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6524             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6525 #endif
6526         /* This used to call 'filbuf' in stdio form, but as that behaves like
6527            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6528            another abstraction.  */
6529         i   = PerlIO_getc(fp);          /* get more characters */
6530 #if 0
6531         DEBUG_P(PerlIO_printf(Perl_debug_log,
6532             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6533             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6534             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6535 #endif
6536         cnt = PerlIO_get_cnt(fp);
6537         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
6538         DEBUG_P(PerlIO_printf(Perl_debug_log,
6539             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6540
6541         if (i == EOF)                   /* all done for ever? */
6542             goto thats_really_all_folks;
6543
6544         bpx = bp - (STDCHAR*)SvPVX_const(sv);   /* box up before relocation */
6545         SvCUR_set(sv, bpx);
6546         SvGROW(sv, bpx + cnt + 2);
6547         bp = (STDCHAR*)SvPVX_const(sv) + bpx;   /* unbox after relocation */
6548
6549         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
6550
6551         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
6552             goto thats_all_folks;
6553     }
6554
6555 thats_all_folks:
6556     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6557           memNE((char*)bp - rslen, rsptr, rslen))
6558         goto screamer;                          /* go back to the fray */
6559 thats_really_all_folks:
6560     if (shortbuffered)
6561         cnt += shortbuffered;
6562         DEBUG_P(PerlIO_printf(Perl_debug_log,
6563             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6564     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
6565     DEBUG_P(PerlIO_printf(Perl_debug_log,
6566         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6567         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6568         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6569     *bp = '\0';
6570     SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv));      /* set length */
6571     DEBUG_P(PerlIO_printf(Perl_debug_log,
6572         "Screamer: done, len=%ld, string=|%.*s|\n",
6573         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6574     }
6575    else
6576     {
6577        /*The big, slow, and stupid way. */
6578 #ifdef USE_HEAP_INSTEAD_OF_STACK        /* Even slower way. */
6579         STDCHAR *buf = NULL;
6580         Newx(buf, 8192, STDCHAR);
6581         assert(buf);
6582 #else
6583         STDCHAR buf[8192];
6584 #endif
6585
6586 screamer2:
6587         if (rslen) {
6588             register const STDCHAR * const bpe = buf + sizeof(buf);
6589             bp = buf;
6590             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6591                 ; /* keep reading */
6592             cnt = bp - buf;
6593         }
6594         else {
6595             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6596             /* Accomodate broken VAXC compiler, which applies U8 cast to
6597              * both args of ?: operator, causing EOF to change into 255
6598              */
6599             if (cnt > 0)
6600                  i = (U8)buf[cnt - 1];
6601             else
6602                  i = EOF;
6603         }
6604
6605         if (cnt < 0)
6606             cnt = 0;  /* we do need to re-set the sv even when cnt <= 0 */
6607         if (append)
6608              sv_catpvn(sv, (char *) buf, cnt);
6609         else
6610              sv_setpvn(sv, (char *) buf, cnt);
6611
6612         if (i != EOF &&                 /* joy */
6613             (!rslen ||
6614              SvCUR(sv) < rslen ||
6615              memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6616         {
6617             append = -1;
6618             /*
6619              * If we're reading from a TTY and we get a short read,
6620              * indicating that the user hit his EOF character, we need
6621              * to notice it now, because if we try to read from the TTY
6622              * again, the EOF condition will disappear.
6623              *
6624              * The comparison of cnt to sizeof(buf) is an optimization
6625              * that prevents unnecessary calls to feof().
6626              *
6627              * - jik 9/25/96
6628              */
6629             if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6630                 goto screamer2;
6631         }
6632
6633 #ifdef USE_HEAP_INSTEAD_OF_STACK
6634         Safefree(buf);
6635 #endif
6636     }
6637
6638     if (rspara) {               /* have to do this both before and after */
6639         while (i != EOF) {      /* to make sure file boundaries work right */
6640             i = PerlIO_getc(fp);
6641             if (i != '\n') {
6642                 PerlIO_ungetc(fp,i);
6643                 break;
6644             }
6645         }
6646     }
6647
6648 return_string_or_null:
6649     return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6650 }
6651
6652 /*
6653 =for apidoc sv_inc
6654
6655 Auto-increment of the value in the SV, doing string to numeric conversion
6656 if necessary. Handles 'get' magic.
6657
6658 =cut
6659 */
6660
6661 void
6662 Perl_sv_inc(pTHX_ register SV *sv)
6663 {
6664     dVAR;
6665     register char *d;
6666     int flags;
6667
6668     if (!sv)
6669         return;
6670     SvGETMAGIC(sv);
6671     if (SvTHINKFIRST(sv)) {
6672         if (SvIsCOW(sv))
6673             sv_force_normal_flags(sv, 0);
6674         if (SvREADONLY(sv)) {
6675             if (IN_PERL_RUNTIME)
6676                 Perl_croak(aTHX_ PL_no_modify);
6677         }
6678         if (SvROK(sv)) {
6679             IV i;
6680             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6681                 return;
6682             i = PTR2IV(SvRV(sv));
6683             sv_unref(sv);
6684             sv_setiv(sv, i);
6685         }
6686     }
6687     flags = SvFLAGS(sv);
6688     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6689         /* It's (privately or publicly) a float, but not tested as an
6690            integer, so test it to see. */
6691         (void) SvIV(sv);
6692         flags = SvFLAGS(sv);
6693     }
6694     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6695         /* It's publicly an integer, or privately an integer-not-float */
6696 #ifdef PERL_PRESERVE_IVUV
6697       oops_its_int:
6698 #endif
6699         if (SvIsUV(sv)) {
6700             if (SvUVX(sv) == UV_MAX)
6701                 sv_setnv(sv, UV_MAX_P1);
6702             else
6703                 (void)SvIOK_only_UV(sv);
6704                 SvUV_set(sv, SvUVX(sv) + 1);
6705         } else {
6706             if (SvIVX(sv) == IV_MAX)
6707                 sv_setuv(sv, (UV)IV_MAX + 1);
6708             else {
6709                 (void)SvIOK_only(sv);
6710                 SvIV_set(sv, SvIVX(sv) + 1);
6711             }   
6712         }
6713         return;
6714     }
6715     if (flags & SVp_NOK) {
6716         (void)SvNOK_only(sv);
6717         SvNV_set(sv, SvNVX(sv) + 1.0);
6718         return;
6719     }
6720
6721     if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6722         if ((flags & SVTYPEMASK) < SVt_PVIV)
6723             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6724         (void)SvIOK_only(sv);
6725         SvIV_set(sv, 1);
6726         return;
6727     }
6728     d = SvPVX(sv);
6729     while (isALPHA(*d)) d++;
6730     while (isDIGIT(*d)) d++;
6731     if (*d) {
6732 #ifdef PERL_PRESERVE_IVUV
6733         /* Got to punt this as an integer if needs be, but we don't issue
6734            warnings. Probably ought to make the sv_iv_please() that does
6735            the conversion if possible, and silently.  */
6736         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6737         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6738             /* Need to try really hard to see if it's an integer.
6739                9.22337203685478e+18 is an integer.
6740                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6741                so $a="9.22337203685478e+18"; $a+0; $a++
6742                needs to be the same as $a="9.22337203685478e+18"; $a++
6743                or we go insane. */
6744         
6745             (void) sv_2iv(sv);
6746             if (SvIOK(sv))
6747                 goto oops_its_int;
6748
6749             /* sv_2iv *should* have made this an NV */
6750             if (flags & SVp_NOK) {
6751                 (void)SvNOK_only(sv);
6752                 SvNV_set(sv, SvNVX(sv) + 1.0);
6753                 return;
6754             }
6755             /* I don't think we can get here. Maybe I should assert this
6756                And if we do get here I suspect that sv_setnv will croak. NWC
6757                Fall through. */
6758 #if defined(USE_LONG_DOUBLE)
6759             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",
6760                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6761 #else
6762             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6763                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6764 #endif
6765         }
6766 #endif /* PERL_PRESERVE_IVUV */
6767         sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6768         return;
6769     }
6770     d--;
6771     while (d >= SvPVX_const(sv)) {
6772         if (isDIGIT(*d)) {
6773             if (++*d <= '9')
6774                 return;
6775             *(d--) = '0';
6776         }
6777         else {
6778 #ifdef EBCDIC
6779             /* MKS: The original code here died if letters weren't consecutive.
6780              * at least it didn't have to worry about non-C locales.  The
6781              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6782              * arranged in order (although not consecutively) and that only
6783              * [A-Za-z] are accepted by isALPHA in the C locale.
6784              */
6785             if (*d != 'z' && *d != 'Z') {
6786                 do { ++*d; } while (!isALPHA(*d));
6787                 return;
6788             }
6789             *(d--) -= 'z' - 'a';
6790 #else
6791             ++*d;
6792             if (isALPHA(*d))
6793                 return;
6794             *(d--) -= 'z' - 'a' + 1;
6795 #endif
6796         }
6797     }
6798     /* oh,oh, the number grew */
6799     SvGROW(sv, SvCUR(sv) + 2);
6800     SvCUR_set(sv, SvCUR(sv) + 1);
6801     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6802         *d = d[-1];
6803     if (isDIGIT(d[1]))
6804         *d = '1';
6805     else
6806         *d = d[1];
6807 }
6808
6809 /*
6810 =for apidoc sv_dec
6811
6812 Auto-decrement of the value in the SV, doing string to numeric conversion
6813 if necessary. Handles 'get' magic.
6814
6815 =cut
6816 */
6817
6818 void
6819 Perl_sv_dec(pTHX_ register SV *sv)
6820 {
6821     dVAR;
6822     int flags;
6823
6824     if (!sv)
6825         return;
6826     SvGETMAGIC(sv);
6827     if (SvTHINKFIRST(sv)) {
6828         if (SvIsCOW(sv))
6829             sv_force_normal_flags(sv, 0);
6830         if (SvREADONLY(sv)) {
6831             if (IN_PERL_RUNTIME)
6832                 Perl_croak(aTHX_ PL_no_modify);
6833         }
6834         if (SvROK(sv)) {
6835             IV i;
6836             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6837                 return;
6838             i = PTR2IV(SvRV(sv));
6839             sv_unref(sv);
6840             sv_setiv(sv, i);
6841         }
6842     }
6843     /* Unlike sv_inc we don't have to worry about string-never-numbers
6844        and keeping them magic. But we mustn't warn on punting */
6845     flags = SvFLAGS(sv);
6846     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6847         /* It's publicly an integer, or privately an integer-not-float */
6848 #ifdef PERL_PRESERVE_IVUV
6849       oops_its_int:
6850 #endif
6851         if (SvIsUV(sv)) {
6852             if (SvUVX(sv) == 0) {
6853                 (void)SvIOK_only(sv);
6854                 SvIV_set(sv, -1);
6855             }
6856             else {
6857                 (void)SvIOK_only_UV(sv);
6858                 SvUV_set(sv, SvUVX(sv) - 1);
6859             }   
6860         } else {
6861             if (SvIVX(sv) == IV_MIN)
6862                 sv_setnv(sv, (NV)IV_MIN - 1.0);
6863             else {
6864                 (void)SvIOK_only(sv);
6865                 SvIV_set(sv, SvIVX(sv) - 1);
6866             }   
6867         }
6868         return;
6869     }
6870     if (flags & SVp_NOK) {
6871         SvNV_set(sv, SvNVX(sv) - 1.0);
6872         (void)SvNOK_only(sv);
6873         return;
6874     }
6875     if (!(flags & SVp_POK)) {
6876         if ((flags & SVTYPEMASK) < SVt_PVIV)
6877             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6878         SvIV_set(sv, -1);
6879         (void)SvIOK_only(sv);
6880         return;
6881     }
6882 #ifdef PERL_PRESERVE_IVUV
6883     {
6884         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6885         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6886             /* Need to try really hard to see if it's an integer.
6887                9.22337203685478e+18 is an integer.
6888                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6889                so $a="9.22337203685478e+18"; $a+0; $a--
6890                needs to be the same as $a="9.22337203685478e+18"; $a--
6891                or we go insane. */
6892         
6893             (void) sv_2iv(sv);
6894             if (SvIOK(sv))
6895                 goto oops_its_int;
6896
6897             /* sv_2iv *should* have made this an NV */
6898             if (flags & SVp_NOK) {
6899                 (void)SvNOK_only(sv);
6900                 SvNV_set(sv, SvNVX(sv) - 1.0);
6901                 return;
6902             }
6903             /* I don't think we can get here. Maybe I should assert this
6904                And if we do get here I suspect that sv_setnv will croak. NWC
6905                Fall through. */
6906 #if defined(USE_LONG_DOUBLE)
6907             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",
6908                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6909 #else
6910             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6911                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6912 #endif
6913         }
6914     }
6915 #endif /* PERL_PRESERVE_IVUV */
6916     sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0);   /* punt */
6917 }
6918
6919 /*
6920 =for apidoc sv_mortalcopy
6921
6922 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6923 The new SV is marked as mortal. It will be destroyed "soon", either by an
6924 explicit call to FREETMPS, or by an implicit call at places such as
6925 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
6926
6927 =cut
6928 */
6929
6930 /* Make a string that will exist for the duration of the expression
6931  * evaluation.  Actually, it may have to last longer than that, but
6932  * hopefully we won't free it until it has been assigned to a
6933  * permanent location. */
6934
6935 SV *
6936 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6937 {
6938     dVAR;
6939     register SV *sv;
6940
6941     new_SV(sv);
6942     sv_setsv(sv,oldstr);
6943     EXTEND_MORTAL(1);
6944     PL_tmps_stack[++PL_tmps_ix] = sv;
6945     SvTEMP_on(sv);
6946     return sv;
6947 }
6948
6949 /*
6950 =for apidoc sv_newmortal
6951
6952 Creates a new null SV which is mortal.  The reference count of the SV is
6953 set to 1. It will be destroyed "soon", either by an explicit call to
6954 FREETMPS, or by an implicit call at places such as statement boundaries.
6955 See also C<sv_mortalcopy> and C<sv_2mortal>.
6956
6957 =cut
6958 */
6959
6960 SV *
6961 Perl_sv_newmortal(pTHX)
6962 {
6963     dVAR;
6964     register SV *sv;
6965
6966     new_SV(sv);
6967     SvFLAGS(sv) = SVs_TEMP;
6968     EXTEND_MORTAL(1);
6969     PL_tmps_stack[++PL_tmps_ix] = sv;
6970     return sv;
6971 }
6972
6973 /*
6974 =for apidoc sv_2mortal
6975
6976 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
6977 by an explicit call to FREETMPS, or by an implicit call at places such as
6978 statement boundaries.  SvTEMP() is turned on which means that the SV's
6979 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6980 and C<sv_mortalcopy>.
6981
6982 =cut
6983 */
6984
6985 SV *
6986 Perl_sv_2mortal(pTHX_ register SV *sv)
6987 {
6988     dVAR;
6989     if (!sv)
6990         return NULL;
6991     if (SvREADONLY(sv) && SvIMMORTAL(sv))
6992         return sv;
6993     EXTEND_MORTAL(1);
6994     PL_tmps_stack[++PL_tmps_ix] = sv;
6995     SvTEMP_on(sv);
6996     return sv;
6997 }
6998
6999 /*
7000 =for apidoc newSVpv
7001
7002 Creates a new SV and copies a string into it.  The reference count for the
7003 SV is set to 1.  If C<len> is zero, Perl will compute the length using
7004 strlen().  For efficiency, consider using C<newSVpvn> instead.
7005
7006 =cut
7007 */
7008
7009 SV *
7010 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7011 {
7012     dVAR;
7013     register SV *sv;
7014
7015     new_SV(sv);
7016     sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7017     return sv;
7018 }
7019
7020 /*
7021 =for apidoc newSVpvn
7022
7023 Creates a new SV and copies a string into it.  The reference count for the
7024 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
7025 string.  You are responsible for ensuring that the source string is at least
7026 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
7027
7028 =cut
7029 */
7030
7031 SV *
7032 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7033 {
7034     dVAR;
7035     register SV *sv;
7036
7037     new_SV(sv);
7038     sv_setpvn(sv,s,len);
7039     return sv;
7040 }
7041
7042
7043 /*
7044 =for apidoc newSVhek
7045
7046 Creates a new SV from the hash key structure.  It will generate scalars that
7047 point to the shared string table where possible. Returns a new (undefined)
7048 SV if the hek is NULL.
7049
7050 =cut
7051 */
7052
7053 SV *
7054 Perl_newSVhek(pTHX_ const HEK *hek)
7055 {
7056     dVAR;
7057     if (!hek) {
7058         SV *sv;
7059
7060         new_SV(sv);
7061         return sv;
7062     }
7063
7064     if (HEK_LEN(hek) == HEf_SVKEY) {
7065         return newSVsv(*(SV**)HEK_KEY(hek));
7066     } else {
7067         const int flags = HEK_FLAGS(hek);
7068         if (flags & HVhek_WASUTF8) {
7069             /* Trouble :-)
7070                Andreas would like keys he put in as utf8 to come back as utf8
7071             */
7072             STRLEN utf8_len = HEK_LEN(hek);
7073             const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7074             SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7075
7076             SvUTF8_on (sv);
7077             Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7078             return sv;
7079         } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7080             /* We don't have a pointer to the hv, so we have to replicate the
7081                flag into every HEK. This hv is using custom a hasing
7082                algorithm. Hence we can't return a shared string scalar, as
7083                that would contain the (wrong) hash value, and might get passed
7084                into an hv routine with a regular hash.
7085                Similarly, a hash that isn't using shared hash keys has to have
7086                the flag in every key so that we know not to try to call
7087                share_hek_kek on it.  */
7088
7089             SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7090             if (HEK_UTF8(hek))
7091                 SvUTF8_on (sv);
7092             return sv;
7093         }
7094         /* This will be overwhelminly the most common case.  */
7095         {
7096             /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7097                more efficient than sharepvn().  */
7098             SV *sv;
7099
7100             new_SV(sv);
7101             sv_upgrade(sv, SVt_PV);
7102             SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7103             SvCUR_set(sv, HEK_LEN(hek));
7104             SvLEN_set(sv, 0);
7105             SvREADONLY_on(sv);
7106             SvFAKE_on(sv);
7107             SvPOK_on(sv);
7108             if (HEK_UTF8(hek))
7109                 SvUTF8_on(sv);
7110             return sv;
7111         }
7112     }
7113 }
7114
7115 /*
7116 =for apidoc newSVpvn_share
7117
7118 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7119 table. If the string does not already exist in the table, it is created
7120 first.  Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7121 value is used; otherwise the hash is computed. The string's hash can be later
7122 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7123 that as the string table is used for shared hash keys these strings will have
7124 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7125
7126 =cut
7127 */
7128
7129 SV *
7130 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7131 {
7132     dVAR;
7133     register SV *sv;
7134     bool is_utf8 = FALSE;
7135     const char *const orig_src = src;
7136
7137     if (len < 0) {
7138         STRLEN tmplen = -len;
7139         is_utf8 = TRUE;
7140         /* See the note in hv.c:hv_fetch() --jhi */
7141         src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7142         len = tmplen;
7143     }
7144     if (!hash)
7145         PERL_HASH(hash, src, len);
7146     new_SV(sv);
7147     sv_upgrade(sv, SVt_PV);
7148     SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7149     SvCUR_set(sv, len);
7150     SvLEN_set(sv, 0);
7151     SvREADONLY_on(sv);
7152     SvFAKE_on(sv);
7153     SvPOK_on(sv);
7154     if (is_utf8)
7155         SvUTF8_on(sv);
7156     if (src != orig_src)
7157         Safefree(src);
7158     return sv;
7159 }
7160
7161
7162 #if defined(PERL_IMPLICIT_CONTEXT)
7163
7164 /* pTHX_ magic can't cope with varargs, so this is a no-context
7165  * version of the main function, (which may itself be aliased to us).
7166  * Don't access this version directly.
7167  */
7168
7169 SV *
7170 Perl_newSVpvf_nocontext(const char* pat, ...)
7171 {
7172     dTHX;
7173     register SV *sv;
7174     va_list args;
7175     va_start(args, pat);
7176     sv = vnewSVpvf(pat, &args);
7177     va_end(args);
7178     return sv;
7179 }
7180 #endif
7181
7182 /*
7183 =for apidoc newSVpvf
7184
7185 Creates a new SV and initializes it with the string formatted like
7186 C<sprintf>.
7187
7188 =cut
7189 */
7190
7191 SV *
7192 Perl_newSVpvf(pTHX_ const char* pat, ...)
7193 {
7194     register SV *sv;
7195     va_list args;
7196     va_start(args, pat);
7197     sv = vnewSVpvf(pat, &args);
7198     va_end(args);
7199     return sv;
7200 }
7201
7202 /* backend for newSVpvf() and newSVpvf_nocontext() */
7203
7204 SV *
7205 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7206 {
7207     dVAR;
7208     register SV *sv;
7209     new_SV(sv);
7210     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7211     return sv;
7212 }
7213
7214 /*
7215 =for apidoc newSVnv
7216
7217 Creates a new SV and copies a floating point value into it.
7218 The reference count for the SV is set to 1.
7219
7220 =cut
7221 */
7222
7223 SV *
7224 Perl_newSVnv(pTHX_ NV n)
7225 {
7226     dVAR;
7227     register SV *sv;
7228
7229     new_SV(sv);
7230     sv_setnv(sv,n);
7231     return sv;
7232 }
7233
7234 /*
7235 =for apidoc newSViv
7236
7237 Creates a new SV and copies an integer into it.  The reference count for the
7238 SV is set to 1.
7239
7240 =cut
7241 */
7242
7243 SV *
7244 Perl_newSViv(pTHX_ IV i)
7245 {
7246     dVAR;
7247     register SV *sv;
7248
7249     new_SV(sv);
7250     sv_setiv(sv,i);
7251     return sv;
7252 }
7253
7254 /*
7255 =for apidoc newSVuv
7256
7257 Creates a new SV and copies an unsigned integer into it.
7258 The reference count for the SV is set to 1.
7259
7260 =cut
7261 */
7262
7263 SV *
7264 Perl_newSVuv(pTHX_ UV u)
7265 {
7266     dVAR;
7267     register SV *sv;
7268
7269     new_SV(sv);
7270     sv_setuv(sv,u);
7271     return sv;
7272 }
7273
7274 /*
7275 =for apidoc newSV_type
7276
7277 Creates a new SV, of the type specified.  The reference count for the new SV
7278 is set to 1.
7279
7280 =cut
7281 */
7282
7283 SV *
7284 Perl_newSV_type(pTHX_ svtype type)
7285 {
7286     register SV *sv;
7287
7288     new_SV(sv);
7289     sv_upgrade(sv, type);
7290     return sv;
7291 }
7292
7293 /*
7294 =for apidoc newRV_noinc
7295
7296 Creates an RV wrapper for an SV.  The reference count for the original
7297 SV is B<not> incremented.
7298
7299 =cut
7300 */
7301
7302 SV *
7303 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7304 {
7305     dVAR;
7306     register SV *sv = newSV_type(SVt_IV);
7307     SvTEMP_off(tmpRef);
7308     SvRV_set(sv, tmpRef);
7309     SvROK_on(sv);
7310     return sv;
7311 }
7312
7313 /* newRV_inc is the official function name to use now.
7314  * newRV_inc is in fact #defined to newRV in sv.h
7315  */
7316
7317 SV *
7318 Perl_newRV(pTHX_ SV *sv)
7319 {
7320     dVAR;
7321     return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7322 }
7323
7324 /*
7325 =for apidoc newSVsv
7326
7327 Creates a new SV which is an exact duplicate of the original SV.
7328 (Uses C<sv_setsv>).
7329
7330 =cut
7331 */
7332
7333 SV *
7334 Perl_newSVsv(pTHX_ register SV *old)
7335 {
7336     dVAR;
7337     register SV *sv;
7338
7339     if (!old)
7340         return NULL;
7341     if (SvTYPE(old) == SVTYPEMASK) {
7342         if (ckWARN_d(WARN_INTERNAL))
7343             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7344         return NULL;
7345     }
7346     new_SV(sv);
7347     /* SV_GMAGIC is the default for sv_setv()
7348        SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7349        with SvTEMP_off and SvTEMP_on round a call to sv_setsv.  */
7350     sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7351     return sv;
7352 }
7353
7354 /*
7355 =for apidoc sv_reset
7356
7357 Underlying implementation for the C<reset> Perl function.
7358 Note that the perl-level function is vaguely deprecated.
7359
7360 =cut
7361 */
7362
7363 void
7364 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7365 {
7366     dVAR;
7367     char todo[PERL_UCHAR_MAX+1];
7368
7369     if (!stash)
7370         return;
7371
7372     if (!*s) {          /* reset ?? searches */
7373         MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7374         if (mg) {
7375             const U32 count = mg->mg_len / sizeof(PMOP**);
7376             PMOP **pmp = (PMOP**) mg->mg_ptr;
7377             PMOP *const *const end = pmp + count;
7378
7379             while (pmp < end) {
7380 #ifdef USE_ITHREADS
7381                 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7382 #else
7383                 (*pmp)->op_pmflags &= ~PMf_USED;
7384 #endif
7385                 ++pmp;
7386             }
7387         }
7388         return;
7389     }
7390
7391     /* reset variables */
7392
7393     if (!HvARRAY(stash))
7394         return;
7395
7396     Zero(todo, 256, char);
7397     while (*s) {
7398         I32 max;
7399         I32 i = (unsigned char)*s;
7400         if (s[1] == '-') {
7401             s += 2;
7402         }
7403         max = (unsigned char)*s++;
7404         for ( ; i <= max; i++) {
7405             todo[i] = 1;
7406         }
7407         for (i = 0; i <= (I32) HvMAX(stash); i++) {
7408             HE *entry;
7409             for (entry = HvARRAY(stash)[i];
7410                  entry;
7411                  entry = HeNEXT(entry))
7412             {
7413                 register GV *gv;
7414                 register SV *sv;
7415
7416                 if (!todo[(U8)*HeKEY(entry)])
7417                     continue;
7418                 gv = (GV*)HeVAL(entry);
7419                 sv = GvSV(gv);
7420                 if (sv) {
7421                     if (SvTHINKFIRST(sv)) {
7422                         if (!SvREADONLY(sv) && SvROK(sv))
7423                             sv_unref(sv);
7424                         /* XXX Is this continue a bug? Why should THINKFIRST
7425                            exempt us from resetting arrays and hashes?  */
7426                         continue;
7427                     }
7428                     SvOK_off(sv);
7429                     if (SvTYPE(sv) >= SVt_PV) {
7430                         SvCUR_set(sv, 0);
7431                         if (SvPVX_const(sv) != NULL)
7432                             *SvPVX(sv) = '\0';
7433                         SvTAINT(sv);
7434                     }
7435                 }
7436                 if (GvAV(gv)) {
7437                     av_clear(GvAV(gv));
7438                 }
7439                 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7440 #if defined(VMS)
7441                     Perl_die(aTHX_ "Can't reset %%ENV on this system");
7442 #else /* ! VMS */
7443                     hv_clear(GvHV(gv));
7444 #  if defined(USE_ENVIRON_ARRAY)
7445                     if (gv == PL_envgv)
7446                         my_clearenv();
7447 #  endif /* USE_ENVIRON_ARRAY */
7448 #endif /* VMS */
7449                 }
7450             }
7451         }
7452     }
7453 }
7454
7455 /*
7456 =for apidoc sv_2io
7457
7458 Using various gambits, try to get an IO from an SV: the IO slot if its a
7459 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7460 named after the PV if we're a string.
7461
7462 =cut
7463 */
7464
7465 IO*
7466 Perl_sv_2io(pTHX_ SV *sv)
7467 {
7468     IO* io;
7469     GV* gv;
7470
7471     switch (SvTYPE(sv)) {
7472     case SVt_PVIO:
7473         io = (IO*)sv;
7474         break;
7475     case SVt_PVGV:
7476         gv = (GV*)sv;
7477         io = GvIO(gv);
7478         if (!io)
7479             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7480         break;
7481     default:
7482         if (!SvOK(sv))
7483             Perl_croak(aTHX_ PL_no_usym, "filehandle");
7484         if (SvROK(sv))
7485             return sv_2io(SvRV(sv));
7486         gv = gv_fetchsv(sv, 0, SVt_PVIO);
7487         if (gv)
7488             io = GvIO(gv);
7489         else
7490             io = 0;
7491         if (!io)
7492             Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7493         break;
7494     }
7495     return io;
7496 }
7497
7498 /*
7499 =for apidoc sv_2cv
7500
7501 Using various gambits, try to get a CV from an SV; in addition, try if
7502 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7503 The flags in C<lref> are passed to sv_fetchsv.
7504
7505 =cut
7506 */
7507
7508 CV *
7509 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7510 {
7511     dVAR;
7512     GV *gv = NULL;
7513     CV *cv = NULL;
7514
7515     if (!sv) {
7516         *st = NULL;
7517         *gvp = NULL;
7518         return NULL;
7519     }
7520     switch (SvTYPE(sv)) {
7521     case SVt_PVCV:
7522         *st = CvSTASH(sv);
7523         *gvp = NULL;
7524         return (CV*)sv;
7525     case SVt_PVHV:
7526     case SVt_PVAV:
7527         *st = NULL;
7528         *gvp = NULL;
7529         return NULL;
7530     case SVt_PVGV:
7531         gv = (GV*)sv;
7532         *gvp = gv;
7533         *st = GvESTASH(gv);
7534         goto fix_gv;
7535
7536     default:
7537         SvGETMAGIC(sv);
7538         if (SvROK(sv)) {
7539             SV * const *sp = &sv;       /* Used in tryAMAGICunDEREF macro. */
7540             tryAMAGICunDEREF(to_cv);
7541
7542             sv = SvRV(sv);
7543             if (SvTYPE(sv) == SVt_PVCV) {
7544                 cv = (CV*)sv;
7545                 *gvp = NULL;
7546                 *st = CvSTASH(cv);
7547                 return cv;
7548             }
7549             else if(isGV(sv))
7550                 gv = (GV*)sv;
7551             else
7552                 Perl_croak(aTHX_ "Not a subroutine reference");
7553         }
7554         else if (isGV(sv))
7555             gv = (GV*)sv;
7556         else
7557             gv = gv_fetchsv(sv, lref, SVt_PVCV);
7558         *gvp = gv;
7559         if (!gv) {
7560             *st = NULL;
7561             return NULL;
7562         }
7563         /* Some flags to gv_fetchsv mean don't really create the GV  */
7564         if (SvTYPE(gv) != SVt_PVGV) {
7565             *st = NULL;
7566             return NULL;
7567         }
7568         *st = GvESTASH(gv);
7569     fix_gv:
7570         if (lref && !GvCVu(gv)) {
7571             SV *tmpsv;
7572             ENTER;
7573             tmpsv = newSV(0);
7574             gv_efullname3(tmpsv, gv, NULL);
7575             /* XXX this is probably not what they think they're getting.
7576              * It has the same effect as "sub name;", i.e. just a forward
7577              * declaration! */
7578             newSUB(start_subparse(FALSE, 0),
7579                    newSVOP(OP_CONST, 0, tmpsv),
7580                    NULL, NULL);
7581             LEAVE;
7582             if (!GvCVu(gv))
7583                 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7584                            SVfARG(sv));
7585         }
7586         return GvCVu(gv);
7587     }
7588 }
7589
7590 /*
7591 =for apidoc sv_true
7592
7593 Returns true if the SV has a true value by Perl's rules.
7594 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7595 instead use an in-line version.
7596
7597 =cut
7598 */
7599
7600 I32
7601 Perl_sv_true(pTHX_ register SV *sv)
7602 {
7603     if (!sv)
7604         return 0;
7605     if (SvPOK(sv)) {
7606         register const XPV* const tXpv = (XPV*)SvANY(sv);
7607         if (tXpv &&
7608                 (tXpv->xpv_cur > 1 ||
7609                 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7610             return 1;
7611         else
7612             return 0;
7613     }
7614     else {
7615         if (SvIOK(sv))
7616             return SvIVX(sv) != 0;
7617         else {
7618             if (SvNOK(sv))
7619                 return SvNVX(sv) != 0.0;
7620             else
7621                 return sv_2bool(sv);
7622         }
7623     }
7624 }
7625
7626 /*
7627 =for apidoc sv_pvn_force
7628
7629 Get a sensible string out of the SV somehow.
7630 A private implementation of the C<SvPV_force> macro for compilers which
7631 can't cope with complex macro expressions. Always use the macro instead.
7632
7633 =for apidoc sv_pvn_force_flags
7634
7635 Get a sensible string out of the SV somehow.
7636 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7637 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7638 implemented in terms of this function.
7639 You normally want to use the various wrapper macros instead: see
7640 C<SvPV_force> and C<SvPV_force_nomg>
7641
7642 =cut
7643 */
7644
7645 char *
7646 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7647 {
7648     dVAR;
7649     if (SvTHINKFIRST(sv) && !SvROK(sv))
7650         sv_force_normal_flags(sv, 0);
7651
7652     if (SvPOK(sv)) {
7653         if (lp)
7654             *lp = SvCUR(sv);
7655     }
7656     else {
7657         char *s;
7658         STRLEN len;
7659  
7660         if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7661             const char * const ref = sv_reftype(sv,0);
7662             if (PL_op)
7663                 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7664                            ref, OP_NAME(PL_op));
7665             else
7666                 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7667         }
7668         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7669             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7670                 OP_NAME(PL_op));
7671         s = sv_2pv_flags(sv, &len, flags);
7672         if (lp)
7673             *lp = len;
7674
7675         if (s != SvPVX_const(sv)) {     /* Almost, but not quite, sv_setpvn() */
7676             if (SvROK(sv))
7677                 sv_unref(sv);
7678             SvUPGRADE(sv, SVt_PV);              /* Never FALSE */
7679             SvGROW(sv, len + 1);
7680             Move(s,SvPVX(sv),len,char);
7681             SvCUR_set(sv, len);
7682             SvPVX(sv)[len] = '\0';
7683         }
7684         if (!SvPOK(sv)) {
7685             SvPOK_on(sv);               /* validate pointer */
7686             SvTAINT(sv);
7687             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7688                                   PTR2UV(sv),SvPVX_const(sv)));
7689         }
7690     }
7691     return SvPVX_mutable(sv);
7692 }
7693
7694 /*
7695 =for apidoc sv_pvbyten_force
7696
7697 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7698
7699 =cut
7700 */
7701
7702 char *
7703 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7704 {
7705     sv_pvn_force(sv,lp);
7706     sv_utf8_downgrade(sv,0);
7707     *lp = SvCUR(sv);
7708     return SvPVX(sv);
7709 }
7710
7711 /*
7712 =for apidoc sv_pvutf8n_force
7713
7714 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7715
7716 =cut
7717 */
7718
7719 char *
7720 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7721 {
7722     sv_pvn_force(sv,lp);
7723     sv_utf8_upgrade(sv);
7724     *lp = SvCUR(sv);
7725     return SvPVX(sv);
7726 }
7727
7728 /*
7729 =for apidoc sv_reftype
7730
7731 Returns a string describing what the SV is a reference to.
7732
7733 =cut
7734 */
7735
7736 const char *
7737 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7738 {
7739     /* The fact that I don't need to downcast to char * everywhere, only in ?:
7740        inside return suggests a const propagation bug in g++.  */
7741     if (ob && SvOBJECT(sv)) {
7742         char * const name = HvNAME_get(SvSTASH(sv));
7743         return name ? name : (char *) "__ANON__";
7744     }
7745     else {
7746         switch (SvTYPE(sv)) {
7747         case SVt_NULL:
7748         case SVt_IV:
7749         case SVt_NV:
7750         case SVt_PV:
7751         case SVt_PVIV:
7752         case SVt_PVNV:
7753         case SVt_PVMG:
7754                                 if (SvVOK(sv))
7755                                     return "VSTRING";
7756                                 if (SvROK(sv))
7757                                     return "REF";
7758                                 else
7759                                     return "SCALAR";
7760
7761         case SVt_PVLV:          return (char *)  (SvROK(sv) ? "REF"
7762                                 /* tied lvalues should appear to be
7763                                  * scalars for backwards compatitbility */
7764                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7765                                     ? "SCALAR" : "LVALUE");
7766         case SVt_PVAV:          return "ARRAY";
7767         case SVt_PVHV:          return "HASH";
7768         case SVt_PVCV:          return "CODE";
7769         case SVt_PVGV:          return "GLOB";
7770         case SVt_PVFM:          return "FORMAT";
7771         case SVt_PVIO:          return "IO";
7772         case SVt_BIND:          return "BIND";
7773         case SVt_ORANGE:        return "ORANGE";
7774         default:                return "UNKNOWN";
7775         }
7776     }
7777 }
7778
7779 /*
7780 =for apidoc sv_isobject
7781
7782 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7783 object.  If the SV is not an RV, or if the object is not blessed, then this
7784 will return false.
7785
7786 =cut
7787 */
7788
7789 int
7790 Perl_sv_isobject(pTHX_ SV *sv)
7791 {
7792     if (!sv)
7793         return 0;
7794     SvGETMAGIC(sv);
7795     if (!SvROK(sv))
7796         return 0;
7797     sv = (SV*)SvRV(sv);
7798     if (!SvOBJECT(sv))
7799         return 0;
7800     return 1;
7801 }
7802
7803 /*
7804 =for apidoc sv_isa
7805
7806 Returns a boolean indicating whether the SV is blessed into the specified
7807 class.  This does not check for subtypes; use C<sv_derived_from> to verify
7808 an inheritance relationship.
7809
7810 =cut
7811 */
7812
7813 int
7814 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7815 {
7816     const char *hvname;
7817     if (!sv)
7818         return 0;
7819     SvGETMAGIC(sv);
7820     if (!SvROK(sv))
7821         return 0;
7822     sv = (SV*)SvRV(sv);
7823     if (!SvOBJECT(sv))
7824         return 0;
7825     hvname = HvNAME_get(SvSTASH(sv));
7826     if (!hvname)
7827         return 0;
7828
7829     return strEQ(hvname, name);
7830 }
7831
7832 /*
7833 =for apidoc newSVrv
7834
7835 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
7836 it will be upgraded to one.  If C<classname> is non-null then the new SV will
7837 be blessed in the specified package.  The new SV is returned and its
7838 reference count is 1.
7839
7840 =cut
7841 */
7842
7843 SV*
7844 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7845 {
7846     dVAR;
7847     SV *sv;
7848
7849     new_SV(sv);
7850
7851     SV_CHECK_THINKFIRST_COW_DROP(rv);
7852     (void)SvAMAGIC_off(rv);
7853
7854     if (SvTYPE(rv) >= SVt_PVMG) {
7855         const U32 refcnt = SvREFCNT(rv);
7856         SvREFCNT(rv) = 0;
7857         sv_clear(rv);
7858         SvFLAGS(rv) = 0;
7859         SvREFCNT(rv) = refcnt;
7860
7861         sv_upgrade(rv, SVt_IV);
7862     } else if (SvROK(rv)) {
7863         SvREFCNT_dec(SvRV(rv));
7864     } else {
7865         prepare_SV_for_RV(rv);
7866     }
7867
7868     SvOK_off(rv);
7869     SvRV_set(rv, sv);
7870     SvROK_on(rv);
7871
7872     if (classname) {
7873         HV* const stash = gv_stashpv(classname, GV_ADD);
7874         (void)sv_bless(rv, stash);
7875     }
7876     return sv;
7877 }
7878
7879 /*
7880 =for apidoc sv_setref_pv
7881
7882 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
7883 argument will be upgraded to an RV.  That RV will be modified to point to
7884 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7885 into the SV.  The C<classname> argument indicates the package for the
7886 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
7887 will have a reference count of 1, and the RV will be returned.
7888
7889 Do not use with other Perl types such as HV, AV, SV, CV, because those
7890 objects will become corrupted by the pointer copy process.
7891
7892 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7893
7894 =cut
7895 */
7896
7897 SV*
7898 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7899 {
7900     dVAR;
7901     if (!pv) {
7902         sv_setsv(rv, &PL_sv_undef);
7903         SvSETMAGIC(rv);
7904     }
7905     else
7906         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7907     return rv;
7908 }
7909
7910 /*
7911 =for apidoc sv_setref_iv
7912
7913 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
7914 argument will be upgraded to an RV.  That RV will be modified to point to
7915 the new SV.  The C<classname> argument indicates the package for the
7916 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
7917 will have a reference count of 1, and the RV will be returned.
7918
7919 =cut
7920 */
7921
7922 SV*
7923 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7924 {
7925     sv_setiv(newSVrv(rv,classname), iv);
7926     return rv;
7927 }
7928
7929 /*
7930 =for apidoc sv_setref_uv
7931
7932 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
7933 argument will be upgraded to an RV.  That RV will be modified to point to
7934 the new SV.  The C<classname> argument indicates the package for the
7935 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
7936 will have a reference count of 1, and the RV will be returned.
7937
7938 =cut
7939 */
7940
7941 SV*
7942 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7943 {
7944     sv_setuv(newSVrv(rv,classname), uv);
7945     return rv;
7946 }
7947
7948 /*
7949 =for apidoc sv_setref_nv
7950
7951 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
7952 argument will be upgraded to an RV.  That RV will be modified to point to
7953 the new SV.  The C<classname> argument indicates the package for the
7954 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
7955 will have a reference count of 1, and the RV will be returned.
7956
7957 =cut
7958 */
7959
7960 SV*
7961 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7962 {
7963     sv_setnv(newSVrv(rv,classname), nv);
7964     return rv;
7965 }
7966
7967 /*
7968 =for apidoc sv_setref_pvn
7969
7970 Copies a string into a new SV, optionally blessing the SV.  The length of the
7971 string must be specified with C<n>.  The C<rv> argument will be upgraded to
7972 an RV.  That RV will be modified to point to the new SV.  The C<classname>
7973 argument indicates the package for the blessing.  Set C<classname> to
7974 C<NULL> to avoid the blessing.  The new SV will have a reference count
7975 of 1, and the RV will be returned.
7976
7977 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7978
7979 =cut
7980 */
7981
7982 SV*
7983 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7984 {
7985     sv_setpvn(newSVrv(rv,classname), pv, n);
7986     return rv;
7987 }
7988
7989 /*
7990 =for apidoc sv_bless
7991
7992 Blesses an SV into a specified package.  The SV must be an RV.  The package
7993 must be designated by its stash (see C<gv_stashpv()>).  The reference count
7994 of the SV is unaffected.
7995
7996 =cut
7997 */
7998
7999 SV*
8000 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8001 {
8002     dVAR;
8003     SV *tmpRef;
8004     if (!SvROK(sv))
8005         Perl_croak(aTHX_ "Can't bless non-reference value");
8006     tmpRef = SvRV(sv);
8007     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8008         if (SvIsCOW(tmpRef))
8009             sv_force_normal_flags(tmpRef, 0);
8010         if (SvREADONLY(tmpRef))
8011             Perl_croak(aTHX_ PL_no_modify);
8012         if (SvOBJECT(tmpRef)) {
8013             if (SvTYPE(tmpRef) != SVt_PVIO)
8014                 --PL_sv_objcount;
8015             SvREFCNT_dec(SvSTASH(tmpRef));
8016         }
8017     }
8018     SvOBJECT_on(tmpRef);
8019     if (SvTYPE(tmpRef) != SVt_PVIO)
8020         ++PL_sv_objcount;
8021     SvUPGRADE(tmpRef, SVt_PVMG);
8022     SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8023
8024     if (Gv_AMG(stash))
8025         SvAMAGIC_on(sv);
8026     else
8027         (void)SvAMAGIC_off(sv);
8028
8029     if(SvSMAGICAL(tmpRef))
8030         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8031             mg_set(tmpRef);
8032
8033
8034
8035     return sv;
8036 }
8037
8038 /* Downgrades a PVGV to a PVMG.
8039  */
8040
8041 STATIC void
8042 S_sv_unglob(pTHX_ SV *sv)
8043 {
8044     dVAR;
8045     void *xpvmg;
8046     HV *stash;
8047     SV * const temp = sv_newmortal();
8048
8049     assert(SvTYPE(sv) == SVt_PVGV);
8050     SvFAKE_off(sv);
8051     gv_efullname3(temp, (GV *) sv, "*");
8052
8053     if (GvGP(sv)) {
8054         if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8055             mro_method_changed_in(stash);
8056         gp_free((GV*)sv);
8057     }
8058     if (GvSTASH(sv)) {
8059         sv_del_backref((SV*)GvSTASH(sv), sv);
8060         GvSTASH(sv) = NULL;
8061     }
8062     GvMULTI_off(sv);
8063     if (GvNAME_HEK(sv)) {
8064         unshare_hek(GvNAME_HEK(sv));
8065     }
8066     isGV_with_GP_off(sv);
8067
8068     /* need to keep SvANY(sv) in the right arena */
8069     xpvmg = new_XPVMG();
8070     StructCopy(SvANY(sv), xpvmg, XPVMG);
8071     del_XPVGV(SvANY(sv));
8072     SvANY(sv) = xpvmg;
8073
8074     SvFLAGS(sv) &= ~SVTYPEMASK;
8075     SvFLAGS(sv) |= SVt_PVMG;
8076
8077     /* Intentionally not calling any local SET magic, as this isn't so much a
8078        set operation as merely an internal storage change.  */
8079     sv_setsv_flags(sv, temp, 0);
8080 }
8081
8082 /*
8083 =for apidoc sv_unref_flags
8084
8085 Unsets the RV status of the SV, and decrements the reference count of
8086 whatever was being referenced by the RV.  This can almost be thought of
8087 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
8088 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8089 (otherwise the decrementing is conditional on the reference count being
8090 different from one or the reference being a readonly SV).
8091 See C<SvROK_off>.
8092
8093 =cut
8094 */
8095
8096 void
8097 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8098 {
8099     SV* const target = SvRV(ref);
8100
8101     if (SvWEAKREF(ref)) {
8102         sv_del_backref(target, ref);
8103         SvWEAKREF_off(ref);
8104         SvRV_set(ref, NULL);
8105         return;
8106     }
8107     SvRV_set(ref, NULL);
8108     SvROK_off(ref);
8109     /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8110        assigned to as BEGIN {$a = \"Foo"} will fail.  */
8111     if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8112         SvREFCNT_dec(target);
8113     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8114         sv_2mortal(target);     /* Schedule for freeing later */
8115 }
8116
8117 /*
8118 =for apidoc sv_untaint
8119
8120 Untaint an SV. Use C<SvTAINTED_off> instead.
8121 =cut
8122 */
8123
8124 void
8125 Perl_sv_untaint(pTHX_ SV *sv)
8126 {
8127     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8128         MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8129         if (mg)
8130             mg->mg_len &= ~1;
8131     }
8132 }
8133
8134 /*
8135 =for apidoc sv_tainted
8136
8137 Test an SV for taintedness. Use C<SvTAINTED> instead.
8138 =cut
8139 */
8140
8141 bool
8142 Perl_sv_tainted(pTHX_ SV *sv)
8143 {
8144     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8145         const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8146         if (mg && (mg->mg_len & 1) )
8147             return TRUE;
8148     }
8149     return FALSE;
8150 }
8151
8152 /*
8153 =for apidoc sv_setpviv
8154
8155 Copies an integer into the given SV, also updating its string value.
8156 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
8157
8158 =cut
8159 */
8160
8161 void
8162 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8163 {
8164     char buf[TYPE_CHARS(UV)];
8165     char *ebuf;
8166     char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8167
8168     sv_setpvn(sv, ptr, ebuf - ptr);
8169 }
8170
8171 /*
8172 =for apidoc sv_setpviv_mg
8173
8174 Like C<sv_setpviv>, but also handles 'set' magic.
8175
8176 =cut
8177 */
8178
8179 void
8180 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8181 {
8182     sv_setpviv(sv, iv);
8183     SvSETMAGIC(sv);
8184 }
8185
8186 #if defined(PERL_IMPLICIT_CONTEXT)
8187
8188 /* pTHX_ magic can't cope with varargs, so this is a no-context
8189  * version of the main function, (which may itself be aliased to us).
8190  * Don't access this version directly.
8191  */
8192
8193 void
8194 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8195 {
8196     dTHX;
8197     va_list args;
8198     va_start(args, pat);
8199     sv_vsetpvf(sv, pat, &args);
8200     va_end(args);
8201 }
8202
8203 /* pTHX_ magic can't cope with varargs, so this is a no-context
8204  * version of the main function, (which may itself be aliased to us).
8205  * Don't access this version directly.
8206  */
8207
8208 void
8209 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8210 {
8211     dTHX;
8212     va_list args;
8213     va_start(args, pat);
8214     sv_vsetpvf_mg(sv, pat, &args);
8215     va_end(args);
8216 }
8217 #endif
8218
8219 /*
8220 =for apidoc sv_setpvf
8221
8222 Works like C<sv_catpvf> but copies the text into the SV instead of
8223 appending it.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
8224
8225 =cut
8226 */
8227
8228 void
8229 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8230 {
8231     va_list args;
8232     va_start(args, pat);
8233     sv_vsetpvf(sv, pat, &args);
8234     va_end(args);
8235 }
8236
8237 /*
8238 =for apidoc sv_vsetpvf
8239
8240 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8241 appending it.  Does not handle 'set' magic.  See C<sv_vsetpvf_mg>.
8242
8243 Usually used via its frontend C<sv_setpvf>.
8244
8245 =cut
8246 */
8247
8248 void
8249 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8250 {
8251     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8252 }
8253
8254 /*
8255 =for apidoc sv_setpvf_mg
8256
8257 Like C<sv_setpvf>, but also handles 'set' magic.
8258
8259 =cut
8260 */
8261
8262 void
8263 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8264 {
8265     va_list args;
8266     va_start(args, pat);
8267     sv_vsetpvf_mg(sv, pat, &args);
8268     va_end(args);
8269 }
8270
8271 /*
8272 =for apidoc sv_vsetpvf_mg
8273
8274 Like C<sv_vsetpvf>, but also handles 'set' magic.
8275
8276 Usually used via its frontend C<sv_setpvf_mg>.
8277
8278 =cut
8279 */
8280
8281 void
8282 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8283 {
8284     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8285     SvSETMAGIC(sv);
8286 }
8287
8288 #if defined(PERL_IMPLICIT_CONTEXT)
8289
8290 /* pTHX_ magic can't cope with varargs, so this is a no-context
8291  * version of the main function, (which may itself be aliased to us).
8292  * Don't access this version directly.
8293  */
8294
8295 void
8296 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8297 {
8298     dTHX;
8299     va_list args;
8300     va_start(args, pat);
8301     sv_vcatpvf(sv, pat, &args);
8302     va_end(args);
8303 }
8304
8305 /* pTHX_ magic can't cope with varargs, so this is a no-context
8306  * version of the main function, (which may itself be aliased to us).
8307  * Don't access this version directly.
8308  */
8309
8310 void
8311 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8312 {
8313     dTHX;
8314     va_list args;
8315     va_start(args, pat);
8316     sv_vcatpvf_mg(sv, pat, &args);
8317     va_end(args);
8318 }
8319 #endif
8320
8321 /*
8322 =for apidoc sv_catpvf
8323
8324 Processes its arguments like C<sprintf> and appends the formatted
8325 output to an SV.  If the appended data contains "wide" characters
8326 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8327 and characters >255 formatted with %c), the original SV might get
8328 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.  See
8329 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8330 valid UTF-8; if the original SV was bytes, the pattern should be too.
8331
8332 =cut */
8333
8334 void
8335 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8336 {
8337     va_list args;
8338     va_start(args, pat);
8339     sv_vcatpvf(sv, pat, &args);
8340     va_end(args);
8341 }
8342
8343 /*
8344 =for apidoc sv_vcatpvf
8345
8346 Processes its arguments like C<vsprintf> and appends the formatted output
8347 to an SV.  Does not handle 'set' magic.  See C<sv_vcatpvf_mg>.
8348
8349 Usually used via its frontend C<sv_catpvf>.
8350
8351 =cut
8352 */
8353
8354 void
8355 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8356 {
8357     sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8358 }
8359
8360 /*
8361 =for apidoc sv_catpvf_mg
8362
8363 Like C<sv_catpvf>, but also handles 'set' magic.
8364
8365 =cut
8366 */
8367
8368 void
8369 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8370 {
8371     va_list args;
8372     va_start(args, pat);
8373     sv_vcatpvf_mg(sv, pat, &args);
8374     va_end(args);
8375 }
8376
8377 /*
8378 =for apidoc sv_vcatpvf_mg
8379
8380 Like C<sv_vcatpvf>, but also handles 'set' magic.
8381
8382 Usually used via its frontend C<sv_catpvf_mg>.
8383
8384 =cut
8385 */
8386
8387 void
8388 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8389 {
8390     sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8391     SvSETMAGIC(sv);
8392 }
8393
8394 /*
8395 =for apidoc sv_vsetpvfn
8396
8397 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8398 appending it.
8399
8400 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8401
8402 =cut
8403 */
8404
8405 void
8406 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8407 {
8408     sv_setpvn(sv, "", 0);
8409     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8410 }
8411
8412 STATIC I32
8413 S_expect_number(pTHX_ char** pattern)
8414 {
8415     dVAR;
8416     I32 var = 0;
8417     switch (**pattern) {
8418     case '1': case '2': case '3':
8419     case '4': case '5': case '6':
8420     case '7': case '8': case '9':
8421         var = *(*pattern)++ - '0';
8422         while (isDIGIT(**pattern)) {
8423             const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8424             if (tmp < var)
8425                 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8426             var = tmp;
8427         }
8428     }
8429     return var;
8430 }
8431
8432 STATIC char *
8433 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8434 {
8435     const int neg = nv < 0;
8436     UV uv;
8437
8438     if (neg)
8439         nv = -nv;
8440     if (nv < UV_MAX) {
8441         char *p = endbuf;
8442         nv += 0.5;
8443         uv = (UV)nv;
8444         if (uv & 1 && uv == nv)
8445             uv--;                       /* Round to even */
8446         do {
8447             const unsigned dig = uv % 10;
8448             *--p = '0' + dig;
8449         } while (uv /= 10);
8450         if (neg)
8451             *--p = '-';
8452         *len = endbuf - p;
8453         return p;
8454     }
8455     return NULL;
8456 }
8457
8458
8459 /*
8460 =for apidoc sv_vcatpvfn
8461
8462 Processes its arguments like C<vsprintf> and appends the formatted output
8463 to an SV.  Uses an array of SVs if the C style variable argument list is
8464 missing (NULL).  When running with taint checks enabled, indicates via
8465 C<maybe_tainted> if results are untrustworthy (often due to the use of
8466 locales).
8467
8468 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8469
8470 =cut
8471 */
8472
8473
8474 #define VECTORIZE_ARGS  vecsv = va_arg(*args, SV*);\
8475                         vecstr = (U8*)SvPV_const(vecsv,veclen);\
8476                         vec_utf8 = DO_UTF8(vecsv);
8477
8478 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8479
8480 void
8481 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8482 {
8483     dVAR;
8484     char *p;
8485     char *q;
8486     const char *patend;
8487     STRLEN origlen;
8488     I32 svix = 0;
8489     static const char nullstr[] = "(null)";
8490     SV *argsv = NULL;
8491     bool has_utf8 = DO_UTF8(sv);    /* has the result utf8? */
8492     const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8493     SV *nsv = NULL;
8494     /* Times 4: a decimal digit takes more than 3 binary digits.
8495      * NV_DIG: mantissa takes than many decimal digits.
8496      * Plus 32: Playing safe. */
8497     char ebuf[IV_DIG * 4 + NV_DIG + 32];
8498     /* large enough for "%#.#f" --chip */
8499     /* what about long double NVs? --jhi */
8500
8501     PERL_UNUSED_ARG(maybe_tainted);
8502
8503     /* no matter what, this is a string now */
8504     (void)SvPV_force(sv, origlen);
8505
8506     /* special-case "", "%s", and "%-p" (SVf - see below) */
8507     if (patlen == 0)
8508         return;
8509     if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8510         if (args) {
8511             const char * const s = va_arg(*args, char*);
8512             sv_catpv(sv, s ? s : nullstr);
8513         }
8514         else if (svix < svmax) {
8515             sv_catsv(sv, *svargs);
8516         }
8517         return;
8518     }
8519     if (args && patlen == 3 && pat[0] == '%' &&
8520                 pat[1] == '-' && pat[2] == 'p') {
8521         argsv = (SV*)va_arg(*args, void*);
8522         sv_catsv(sv, argsv);
8523         return;
8524     }
8525
8526 #ifndef USE_LONG_DOUBLE
8527     /* special-case "%.<number>[gf]" */
8528     if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8529          && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8530         unsigned digits = 0;
8531         const char *pp;
8532
8533         pp = pat + 2;
8534         while (*pp >= '0' && *pp <= '9')
8535             digits = 10 * digits + (*pp++ - '0');
8536         if (pp - pat == (int)patlen - 1) {
8537             NV nv;
8538
8539             if (svix < svmax)
8540                 nv = SvNV(*svargs);
8541             else
8542                 return;
8543             if (*pp == 'g') {
8544                 /* Add check for digits != 0 because it seems that some
8545                    gconverts are buggy in this case, and we don't yet have
8546                    a Configure test for this.  */
8547                 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8548                      /* 0, point, slack */
8549                     Gconvert(nv, (int)digits, 0, ebuf);
8550                     sv_catpv(sv, ebuf);
8551                     if (*ebuf)  /* May return an empty string for digits==0 */
8552                         return;
8553                 }
8554             } else if (!digits) {
8555                 STRLEN l;
8556
8557                 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8558                     sv_catpvn(sv, p, l);
8559                     return;
8560                 }
8561             }
8562         }
8563     }
8564 #endif /* !USE_LONG_DOUBLE */
8565
8566     if (!args && svix < svmax && DO_UTF8(*svargs))
8567         has_utf8 = TRUE;
8568
8569     patend = (char*)pat + patlen;
8570     for (p = (char*)pat; p < patend; p = q) {
8571         bool alt = FALSE;
8572         bool left = FALSE;
8573         bool vectorize = FALSE;
8574         bool vectorarg = FALSE;
8575         bool vec_utf8 = FALSE;
8576         char fill = ' ';
8577         char plus = 0;
8578         char intsize = 0;
8579         STRLEN width = 0;
8580         STRLEN zeros = 0;
8581         bool has_precis = FALSE;
8582         STRLEN precis = 0;
8583         const I32 osvix = svix;
8584         bool is_utf8 = FALSE;  /* is this item utf8?   */
8585 #ifdef HAS_LDBL_SPRINTF_BUG
8586         /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8587            with sfio - Allen <allens@cpan.org> */
8588         bool fix_ldbl_sprintf_bug = FALSE;
8589 #endif
8590
8591         char esignbuf[4];
8592         U8 utf8buf[UTF8_MAXBYTES+1];
8593         STRLEN esignlen = 0;
8594
8595         const char *eptr = NULL;
8596         STRLEN elen = 0;
8597         SV *vecsv = NULL;
8598         const U8 *vecstr = NULL;
8599         STRLEN veclen = 0;
8600         char c = 0;
8601         int i;
8602         unsigned base = 0;
8603         IV iv = 0;
8604         UV uv = 0;
8605         /* we need a long double target in case HAS_LONG_DOUBLE but
8606            not USE_LONG_DOUBLE
8607         */
8608 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8609         long double nv;
8610 #else
8611         NV nv;
8612 #endif
8613         STRLEN have;
8614         STRLEN need;
8615         STRLEN gap;
8616         const char *dotstr = ".";
8617         STRLEN dotstrlen = 1;
8618         I32 efix = 0; /* explicit format parameter index */
8619         I32 ewix = 0; /* explicit width index */
8620         I32 epix = 0; /* explicit precision index */
8621         I32 evix = 0; /* explicit vector index */
8622         bool asterisk = FALSE;
8623
8624         /* echo everything up to the next format specification */
8625         for (q = p; q < patend && *q != '%'; ++q) ;
8626         if (q > p) {
8627             if (has_utf8 && !pat_utf8)
8628                 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8629             else
8630                 sv_catpvn(sv, p, q - p);
8631             p = q;
8632         }
8633         if (q++ >= patend)
8634             break;
8635
8636 /*
8637     We allow format specification elements in this order:
8638         \d+\$              explicit format parameter index
8639         [-+ 0#]+           flags
8640         v|\*(\d+\$)?v      vector with optional (optionally specified) arg
8641         0                  flag (as above): repeated to allow "v02"     
8642         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
8643         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8644         [hlqLV]            size
8645     [%bcdefginopsuxDFOUX] format (mandatory)
8646 */
8647
8648         if (args) {
8649 /*  
8650         As of perl5.9.3, printf format checking is on by default.
8651         Internally, perl uses %p formats to provide an escape to
8652         some extended formatting.  This block deals with those
8653         extensions: if it does not match, (char*)q is reset and
8654         the normal format processing code is used.
8655
8656         Currently defined extensions are:
8657                 %p              include pointer address (standard)      
8658                 %-p     (SVf)   include an SV (previously %_)
8659                 %-<num>p        include an SV with precision <num>      
8660                 %<num>p         reserved for future extensions
8661
8662         Robin Barker 2005-07-14
8663
8664                 %1p     (VDf)   removed.  RMB 2007-10-19
8665 */
8666             char* r = q; 
8667             bool sv = FALSE;    
8668             STRLEN n = 0;
8669             if (*q == '-')
8670                 sv = *q++;
8671             n = expect_number(&q);
8672             if (*q++ == 'p') {
8673                 if (sv) {                       /* SVf */
8674                     if (n) {
8675                         precis = n;
8676                         has_precis = TRUE;
8677                     }
8678                     argsv = (SV*)va_arg(*args, void*);
8679                     eptr = SvPV_const(argsv, elen);
8680                     if (DO_UTF8(argsv))
8681                         is_utf8 = TRUE;
8682                     goto string;
8683                 }
8684                 else if (n) {
8685                     if (ckWARN_d(WARN_INTERNAL))
8686                         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8687                         "internal %%<num>p might conflict with future printf extensions");
8688                 }
8689             }
8690             q = r; 
8691         }
8692
8693         if ( (width = expect_number(&q)) ) {
8694             if (*q == '$') {
8695                 ++q;
8696                 efix = width;
8697             } else {
8698                 goto gotwidth;
8699             }
8700         }
8701
8702         /* FLAGS */
8703
8704         while (*q) {
8705             switch (*q) {
8706             case ' ':
8707             case '+':
8708                 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8709                     q++;
8710                 else
8711                     plus = *q++;
8712                 continue;
8713
8714             case '-':
8715                 left = TRUE;
8716                 q++;
8717                 continue;
8718
8719             case '0':
8720                 fill = *q++;
8721                 continue;
8722
8723             case '#':
8724                 alt = TRUE;
8725                 q++;
8726                 continue;
8727
8728             default:
8729                 break;
8730             }
8731             break;
8732         }
8733
8734       tryasterisk:
8735         if (*q == '*') {
8736             q++;
8737             if ( (ewix = expect_number(&q)) )
8738                 if (*q++ != '$')
8739                     goto unknown;
8740             asterisk = TRUE;
8741         }
8742         if (*q == 'v') {
8743             q++;
8744             if (vectorize)
8745                 goto unknown;
8746             if ((vectorarg = asterisk)) {
8747                 evix = ewix;
8748                 ewix = 0;
8749                 asterisk = FALSE;
8750             }
8751             vectorize = TRUE;
8752             goto tryasterisk;
8753         }
8754
8755         if (!asterisk)
8756         {
8757             if( *q == '0' )
8758                 fill = *q++;
8759             width = expect_number(&q);
8760         }
8761
8762         if (vectorize) {
8763             if (vectorarg) {
8764                 if (args)
8765                     vecsv = va_arg(*args, SV*);
8766                 else if (evix) {
8767                     vecsv = (evix > 0 && evix <= svmax)
8768                         ? svargs[evix-1] : &PL_sv_undef;
8769                 } else {
8770                     vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8771                 }
8772                 dotstr = SvPV_const(vecsv, dotstrlen);
8773                 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8774                    bad with tied or overloaded values that return UTF8.  */
8775                 if (DO_UTF8(vecsv))
8776                     is_utf8 = TRUE;
8777                 else if (has_utf8) {
8778                     vecsv = sv_mortalcopy(vecsv);
8779                     sv_utf8_upgrade(vecsv);
8780                     dotstr = SvPV_const(vecsv, dotstrlen);
8781                     is_utf8 = TRUE;
8782                 }                   
8783             }
8784             if (args) {
8785                 VECTORIZE_ARGS
8786             }
8787             else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8788                 vecsv = svargs[efix ? efix-1 : svix++];
8789                 vecstr = (U8*)SvPV_const(vecsv,veclen);
8790                 vec_utf8 = DO_UTF8(vecsv);
8791
8792                 /* if this is a version object, we need to convert
8793                  * back into v-string notation and then let the
8794                  * vectorize happen normally
8795                  */
8796                 if (sv_derived_from(vecsv, "version")) {
8797                     char *version = savesvpv(vecsv);
8798                     if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8799                         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8800                         "vector argument not supported with alpha versions");
8801                         goto unknown;
8802                     }
8803                     vecsv = sv_newmortal();
8804                     scan_vstring(version, version + veclen, vecsv);
8805                     vecstr = (U8*)SvPV_const(vecsv, veclen);
8806                     vec_utf8 = DO_UTF8(vecsv);
8807                     Safefree(version);
8808                 }
8809             }
8810             else {
8811                 vecstr = (U8*)"";
8812                 veclen = 0;
8813             }
8814         }
8815
8816         if (asterisk) {
8817             if (args)
8818                 i = va_arg(*args, int);
8819             else
8820                 i = (ewix ? ewix <= svmax : svix < svmax) ?
8821                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8822             left |= (i < 0);
8823             width = (i < 0) ? -i : i;
8824         }
8825       gotwidth:
8826
8827         /* PRECISION */
8828
8829         if (*q == '.') {
8830             q++;
8831             if (*q == '*') {
8832                 q++;
8833                 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8834                     goto unknown;
8835                 /* XXX: todo, support specified precision parameter */
8836                 if (epix)
8837                     goto unknown;
8838                 if (args)
8839                     i = va_arg(*args, int);
8840                 else
8841                     i = (ewix ? ewix <= svmax : svix < svmax)
8842                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8843                 precis = i;
8844                 has_precis = !(i < 0);
8845             }
8846             else {
8847                 precis = 0;
8848                 while (isDIGIT(*q))
8849                     precis = precis * 10 + (*q++ - '0');
8850                 has_precis = TRUE;
8851             }
8852         }
8853
8854         /* SIZE */
8855
8856         switch (*q) {
8857 #ifdef WIN32
8858         case 'I':                       /* Ix, I32x, and I64x */
8859 #  ifdef WIN64
8860             if (q[1] == '6' && q[2] == '4') {
8861                 q += 3;
8862                 intsize = 'q';
8863                 break;
8864             }
8865 #  endif
8866             if (q[1] == '3' && q[2] == '2') {
8867                 q += 3;
8868                 break;
8869             }
8870 #  ifdef WIN64
8871             intsize = 'q';
8872 #  endif
8873             q++;
8874             break;
8875 #endif
8876 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8877         case 'L':                       /* Ld */
8878             /*FALLTHROUGH*/
8879 #ifdef HAS_QUAD
8880         case 'q':                       /* qd */
8881 #endif
8882             intsize = 'q';
8883             q++;
8884             break;
8885 #endif
8886         case 'l':
8887 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8888             if (*(q + 1) == 'l') {      /* lld, llf */
8889                 intsize = 'q';
8890                 q += 2;
8891                 break;
8892              }
8893 #endif
8894             /*FALLTHROUGH*/
8895         case 'h':
8896             /*FALLTHROUGH*/
8897         case 'V':
8898             intsize = *q++;
8899             break;
8900         }
8901
8902         /* CONVERSION */
8903
8904         if (*q == '%') {
8905             eptr = q++;
8906             elen = 1;
8907             if (vectorize) {
8908                 c = '%';
8909                 goto unknown;
8910             }
8911             goto string;
8912         }
8913
8914         if (!vectorize && !args) {
8915             if (efix) {
8916                 const I32 i = efix-1;
8917                 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8918             } else {
8919                 argsv = (svix >= 0 && svix < svmax)
8920                     ? svargs[svix++] : &PL_sv_undef;
8921             }
8922         }
8923
8924         switch (c = *q++) {
8925
8926             /* STRINGS */
8927
8928         case 'c':
8929             if (vectorize)
8930                 goto unknown;
8931             uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8932             if ((uv > 255 ||
8933                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8934                 && !IN_BYTES) {
8935                 eptr = (char*)utf8buf;
8936                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8937                 is_utf8 = TRUE;
8938             }
8939             else {
8940                 c = (char)uv;
8941                 eptr = &c;
8942                 elen = 1;
8943             }
8944             goto string;
8945
8946         case 's':
8947             if (vectorize)
8948                 goto unknown;
8949             if (args) {
8950                 eptr = va_arg(*args, char*);
8951                 if (eptr)
8952 #ifdef MACOS_TRADITIONAL
8953                   /* On MacOS, %#s format is used for Pascal strings */
8954                   if (alt)
8955                     elen = *eptr++;
8956                   else
8957 #endif
8958                     elen = strlen(eptr);
8959                 else {
8960                     eptr = (char *)nullstr;
8961                     elen = sizeof nullstr - 1;
8962                 }
8963             }
8964             else {
8965                 eptr = SvPV_const(argsv, elen);
8966                 if (DO_UTF8(argsv)) {
8967                     I32 old_precis = precis;
8968                     if (has_precis && precis < elen) {
8969                         I32 p = precis;
8970                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8971                         precis = p;
8972                     }
8973                     if (width) { /* fudge width (can't fudge elen) */
8974                         if (has_precis && precis < elen)
8975                             width += precis - old_precis;
8976                         else
8977                             width += elen - sv_len_utf8(argsv);
8978                     }
8979                     is_utf8 = TRUE;
8980                 }
8981             }
8982
8983         string:
8984             if (has_precis && elen > precis)
8985                 elen = precis;
8986             break;
8987
8988             /* INTEGERS */
8989
8990         case 'p':
8991             if (alt || vectorize)
8992                 goto unknown;
8993             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8994             base = 16;
8995             goto integer;
8996
8997         case 'D':
8998 #ifdef IV_IS_QUAD
8999             intsize = 'q';
9000 #else
9001             intsize = 'l';
9002 #endif
9003             /*FALLTHROUGH*/
9004         case 'd':
9005         case 'i':
9006 #if vdNUMBER
9007         format_vd:
9008 #endif
9009             if (vectorize) {
9010                 STRLEN ulen;
9011                 if (!veclen)
9012                     continue;
9013                 if (vec_utf8)
9014                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9015                                         UTF8_ALLOW_ANYUV);
9016                 else {
9017                     uv = *vecstr;
9018                     ulen = 1;
9019                 }
9020                 vecstr += ulen;
9021                 veclen -= ulen;
9022                 if (plus)
9023                      esignbuf[esignlen++] = plus;
9024             }
9025             else if (args) {
9026                 switch (intsize) {
9027                 case 'h':       iv = (short)va_arg(*args, int); break;
9028                 case 'l':       iv = va_arg(*args, long); break;
9029                 case 'V':       iv = va_arg(*args, IV); break;
9030                 default:        iv = va_arg(*args, int); break;
9031 #ifdef HAS_QUAD
9032                 case 'q':       iv = va_arg(*args, Quad_t); break;
9033 #endif
9034                 }
9035             }
9036             else {
9037                 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9038                 switch (intsize) {
9039                 case 'h':       iv = (short)tiv; break;
9040                 case 'l':       iv = (long)tiv; break;
9041                 case 'V':
9042                 default:        iv = tiv; break;
9043 #ifdef HAS_QUAD
9044                 case 'q':       iv = (Quad_t)tiv; break;
9045 #endif
9046                 }
9047             }
9048             if ( !vectorize )   /* we already set uv above */
9049             {
9050                 if (iv >= 0) {
9051                     uv = iv;
9052                     if (plus)
9053                         esignbuf[esignlen++] = plus;
9054                 }
9055                 else {
9056                     uv = -iv;
9057                     esignbuf[esignlen++] = '-';
9058                 }
9059             }
9060             base = 10;
9061             goto integer;
9062
9063         case 'U':
9064 #ifdef IV_IS_QUAD
9065             intsize = 'q';
9066 #else
9067             intsize = 'l';
9068 #endif
9069             /*FALLTHROUGH*/
9070         case 'u':
9071             base = 10;
9072             goto uns_integer;
9073
9074         case 'B':
9075         case 'b':
9076             base = 2;
9077             goto uns_integer;
9078
9079         case 'O':
9080 #ifdef IV_IS_QUAD
9081             intsize = 'q';
9082 #else
9083             intsize = 'l';
9084 #endif
9085             /*FALLTHROUGH*/
9086         case 'o':
9087             base = 8;
9088             goto uns_integer;
9089
9090         case 'X':
9091         case 'x':
9092             base = 16;
9093
9094         uns_integer:
9095             if (vectorize) {
9096                 STRLEN ulen;
9097         vector:
9098                 if (!veclen)
9099                     continue;
9100                 if (vec_utf8)
9101                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9102                                         UTF8_ALLOW_ANYUV);
9103                 else {
9104                     uv = *vecstr;
9105                     ulen = 1;
9106                 }
9107                 vecstr += ulen;
9108                 veclen -= ulen;
9109             }
9110             else if (args) {
9111                 switch (intsize) {
9112                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
9113                 case 'l':  uv = va_arg(*args, unsigned long); break;
9114                 case 'V':  uv = va_arg(*args, UV); break;
9115                 default:   uv = va_arg(*args, unsigned); break;
9116 #ifdef HAS_QUAD
9117                 case 'q':  uv = va_arg(*args, Uquad_t); break;
9118 #endif
9119                 }
9120             }
9121             else {
9122                 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9123                 switch (intsize) {
9124                 case 'h':       uv = (unsigned short)tuv; break;
9125                 case 'l':       uv = (unsigned long)tuv; break;
9126                 case 'V':
9127                 default:        uv = tuv; break;
9128 #ifdef HAS_QUAD
9129                 case 'q':       uv = (Uquad_t)tuv; break;
9130 #endif
9131                 }
9132             }
9133
9134         integer:
9135             {
9136                 char *ptr = ebuf + sizeof ebuf;
9137                 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9138                 zeros = 0;
9139
9140                 switch (base) {
9141                     unsigned dig;
9142                 case 16:
9143                     p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9144                     do {
9145                         dig = uv & 15;
9146                         *--ptr = p[dig];
9147                     } while (uv >>= 4);
9148                     if (tempalt) {
9149                         esignbuf[esignlen++] = '0';
9150                         esignbuf[esignlen++] = c;  /* 'x' or 'X' */
9151                     }
9152                     break;
9153                 case 8:
9154                     do {
9155                         dig = uv & 7;
9156                         *--ptr = '0' + dig;
9157                     } while (uv >>= 3);
9158                     if (alt && *ptr != '0')
9159                         *--ptr = '0';
9160                     break;
9161                 case 2:
9162                     do {
9163                         dig = uv & 1;
9164                         *--ptr = '0' + dig;
9165                     } while (uv >>= 1);
9166                     if (tempalt) {
9167                         esignbuf[esignlen++] = '0';
9168                         esignbuf[esignlen++] = c;
9169                     }
9170                     break;
9171                 default:                /* it had better be ten or less */
9172                     do {
9173                         dig = uv % base;
9174                         *--ptr = '0' + dig;
9175                     } while (uv /= base);
9176                     break;
9177                 }
9178                 elen = (ebuf + sizeof ebuf) - ptr;
9179                 eptr = ptr;
9180                 if (has_precis) {
9181                     if (precis > elen)
9182                         zeros = precis - elen;
9183                     else if (precis == 0 && elen == 1 && *eptr == '0'
9184                              && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9185                         elen = 0;
9186
9187                 /* a precision nullifies the 0 flag. */
9188                     if (fill == '0')
9189                         fill = ' ';
9190                 }
9191             }
9192             break;
9193
9194             /* FLOATING POINT */
9195
9196         case 'F':
9197             c = 'f';            /* maybe %F isn't supported here */
9198             /*FALLTHROUGH*/
9199         case 'e': case 'E':
9200         case 'f':
9201         case 'g': case 'G':
9202             if (vectorize)
9203                 goto unknown;
9204
9205             /* This is evil, but floating point is even more evil */
9206
9207             /* for SV-style calling, we can only get NV
9208                for C-style calling, we assume %f is double;
9209                for simplicity we allow any of %Lf, %llf, %qf for long double
9210             */
9211             switch (intsize) {
9212             case 'V':
9213 #if defined(USE_LONG_DOUBLE)
9214                 intsize = 'q';
9215 #endif
9216                 break;
9217 /* [perl #20339] - we should accept and ignore %lf rather than die */
9218             case 'l':
9219                 /*FALLTHROUGH*/
9220             default:
9221 #if defined(USE_LONG_DOUBLE)
9222                 intsize = args ? 0 : 'q';
9223 #endif
9224                 break;
9225             case 'q':
9226 #if defined(HAS_LONG_DOUBLE)
9227                 break;
9228 #else
9229                 /*FALLTHROUGH*/
9230 #endif
9231             case 'h':
9232                 goto unknown;
9233             }
9234
9235             /* now we need (long double) if intsize == 'q', else (double) */
9236             nv = (args) ?
9237 #if LONG_DOUBLESIZE > DOUBLESIZE
9238                 intsize == 'q' ?
9239                     va_arg(*args, long double) :
9240                     va_arg(*args, double)
9241 #else
9242                     va_arg(*args, double)
9243 #endif
9244                 : SvNV(argsv);
9245
9246             need = 0;
9247             /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9248                else. frexp() has some unspecified behaviour for those three */
9249             if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9250                 i = PERL_INT_MIN;
9251                 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9252                    will cast our (long double) to (double) */
9253                 (void)Perl_frexp(nv, &i);
9254                 if (i == PERL_INT_MIN)
9255                     Perl_die(aTHX_ "panic: frexp");
9256                 if (i > 0)
9257                     need = BIT_DIGITS(i);
9258             }
9259             need += has_precis ? precis : 6; /* known default */
9260
9261             if (need < width)
9262                 need = width;
9263
9264 #ifdef HAS_LDBL_SPRINTF_BUG
9265             /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9266                with sfio - Allen <allens@cpan.org> */
9267
9268 #  ifdef DBL_MAX
9269 #    define MY_DBL_MAX DBL_MAX
9270 #  else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9271 #    if DOUBLESIZE >= 8
9272 #      define MY_DBL_MAX 1.7976931348623157E+308L
9273 #    else
9274 #      define MY_DBL_MAX 3.40282347E+38L
9275 #    endif
9276 #  endif
9277
9278 #  ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9279 #    define MY_DBL_MAX_BUG 1L
9280 #  else
9281 #    define MY_DBL_MAX_BUG MY_DBL_MAX
9282 #  endif
9283
9284 #  ifdef DBL_MIN
9285 #    define MY_DBL_MIN DBL_MIN
9286 #  else  /* XXX guessing! -Allen */
9287 #    if DOUBLESIZE >= 8
9288 #      define MY_DBL_MIN 2.2250738585072014E-308L
9289 #    else
9290 #      define MY_DBL_MIN 1.17549435E-38L
9291 #    endif
9292 #  endif
9293
9294             if ((intsize == 'q') && (c == 'f') &&
9295                 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9296                 (need < DBL_DIG)) {
9297                 /* it's going to be short enough that
9298                  * long double precision is not needed */
9299
9300                 if ((nv <= 0L) && (nv >= -0L))
9301                     fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9302                 else {
9303                     /* would use Perl_fp_class as a double-check but not
9304                      * functional on IRIX - see perl.h comments */
9305
9306                     if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9307                         /* It's within the range that a double can represent */
9308 #if defined(DBL_MAX) && !defined(DBL_MIN)
9309                         if ((nv >= ((long double)1/DBL_MAX)) ||
9310                             (nv <= (-(long double)1/DBL_MAX)))
9311 #endif
9312                         fix_ldbl_sprintf_bug = TRUE;
9313                     }
9314                 }
9315                 if (fix_ldbl_sprintf_bug == TRUE) {
9316                     double temp;
9317
9318                     intsize = 0;
9319                     temp = (double)nv;
9320                     nv = (NV)temp;
9321                 }
9322             }
9323
9324 #  undef MY_DBL_MAX
9325 #  undef MY_DBL_MAX_BUG
9326 #  undef MY_DBL_MIN
9327
9328 #endif /* HAS_LDBL_SPRINTF_BUG */
9329
9330             need += 20; /* fudge factor */
9331             if (PL_efloatsize < need) {
9332                 Safefree(PL_efloatbuf);
9333                 PL_efloatsize = need + 20; /* more fudge */
9334                 Newx(PL_efloatbuf, PL_efloatsize, char);
9335                 PL_efloatbuf[0] = '\0';
9336             }
9337
9338             if ( !(width || left || plus || alt) && fill != '0'
9339                  && has_precis && intsize != 'q' ) {    /* Shortcuts */
9340                 /* See earlier comment about buggy Gconvert when digits,
9341                    aka precis is 0  */
9342                 if ( c == 'g' && precis) {
9343                     Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9344                     /* May return an empty string for digits==0 */
9345                     if (*PL_efloatbuf) {
9346                         elen = strlen(PL_efloatbuf);
9347                         goto float_converted;
9348                     }
9349                 } else if ( c == 'f' && !precis) {
9350                     if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9351                         break;
9352                 }
9353             }
9354             {
9355                 char *ptr = ebuf + sizeof ebuf;
9356                 *--ptr = '\0';
9357                 *--ptr = c;
9358                 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9359 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9360                 if (intsize == 'q') {
9361                     /* Copy the one or more characters in a long double
9362                      * format before the 'base' ([efgEFG]) character to
9363                      * the format string. */
9364                     static char const prifldbl[] = PERL_PRIfldbl;
9365                     char const *p = prifldbl + sizeof(prifldbl) - 3;
9366                     while (p >= prifldbl) { *--ptr = *p--; }
9367                 }
9368 #endif
9369                 if (has_precis) {
9370                     base = precis;
9371                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
9372                     *--ptr = '.';
9373                 }
9374                 if (width) {
9375                     base = width;
9376                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
9377                 }
9378                 if (fill == '0')
9379                     *--ptr = fill;
9380                 if (left)
9381                     *--ptr = '-';
9382                 if (plus)
9383                     *--ptr = plus;
9384                 if (alt)
9385                     *--ptr = '#';
9386                 *--ptr = '%';
9387
9388                 /* No taint.  Otherwise we are in the strange situation
9389                  * where printf() taints but print($float) doesn't.
9390                  * --jhi */
9391 #if defined(HAS_LONG_DOUBLE)
9392                 elen = ((intsize == 'q')
9393                         ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9394                         : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9395 #else
9396                 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9397 #endif
9398             }
9399         float_converted:
9400             eptr = PL_efloatbuf;
9401             break;
9402
9403             /* SPECIAL */
9404
9405         case 'n':
9406             if (vectorize)
9407                 goto unknown;
9408             i = SvCUR(sv) - origlen;
9409             if (args) {
9410                 switch (intsize) {
9411                 case 'h':       *(va_arg(*args, short*)) = i; break;
9412                 default:        *(va_arg(*args, int*)) = i; break;
9413                 case 'l':       *(va_arg(*args, long*)) = i; break;
9414                 case 'V':       *(va_arg(*args, IV*)) = i; break;
9415 #ifdef HAS_QUAD
9416                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
9417 #endif
9418                 }
9419             }
9420             else
9421                 sv_setuv_mg(argsv, (UV)i);
9422             continue;   /* not "break" */
9423
9424             /* UNKNOWN */
9425
9426         default:
9427       unknown:
9428             if (!args
9429                 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9430                 && ckWARN(WARN_PRINTF))
9431             {
9432                 SV * const msg = sv_newmortal();
9433                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9434                           (PL_op->op_type == OP_PRTF) ? "" : "s");
9435                 if (c) {
9436                     if (isPRINT(c))
9437                         Perl_sv_catpvf(aTHX_ msg,
9438                                        "\"%%%c\"", c & 0xFF);
9439                     else
9440                         Perl_sv_catpvf(aTHX_ msg,
9441                                        "\"%%\\%03"UVof"\"",
9442                                        (UV)c & 0xFF);
9443                 } else
9444                     sv_catpvs(msg, "end of string");
9445                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9446             }
9447
9448             /* output mangled stuff ... */
9449             if (c == '\0')
9450                 --q;
9451             eptr = p;
9452             elen = q - p;
9453
9454             /* ... right here, because formatting flags should not apply */
9455             SvGROW(sv, SvCUR(sv) + elen + 1);
9456             p = SvEND(sv);
9457             Copy(eptr, p, elen, char);
9458             p += elen;
9459             *p = '\0';
9460             SvCUR_set(sv, p - SvPVX_const(sv));
9461             svix = osvix;
9462             continue;   /* not "break" */
9463         }
9464
9465         if (is_utf8 != has_utf8) {
9466             if (is_utf8) {
9467                 if (SvCUR(sv))
9468                     sv_utf8_upgrade(sv);
9469             }
9470             else {
9471                 const STRLEN old_elen = elen;
9472                 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9473                 sv_utf8_upgrade(nsv);
9474                 eptr = SvPVX_const(nsv);
9475                 elen = SvCUR(nsv);
9476
9477                 if (width) { /* fudge width (can't fudge elen) */
9478                     width += elen - old_elen;
9479                 }
9480                 is_utf8 = TRUE;
9481             }
9482         }
9483
9484         have = esignlen + zeros + elen;
9485         if (have < zeros)
9486             Perl_croak_nocontext(PL_memory_wrap);
9487
9488         need = (have > width ? have : width);
9489         gap = need - have;
9490
9491         if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9492             Perl_croak_nocontext(PL_memory_wrap);
9493         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9494         p = SvEND(sv);
9495         if (esignlen && fill == '0') {
9496             int i;
9497             for (i = 0; i < (int)esignlen; i++)
9498                 *p++ = esignbuf[i];
9499         }
9500         if (gap && !left) {
9501             memset(p, fill, gap);
9502             p += gap;
9503         }
9504         if (esignlen && fill != '0') {
9505             int i;
9506             for (i = 0; i < (int)esignlen; i++)
9507                 *p++ = esignbuf[i];
9508         }
9509         if (zeros) {
9510             int i;
9511             for (i = zeros; i; i--)
9512                 *p++ = '0';
9513         }
9514         if (elen) {
9515             Copy(eptr, p, elen, char);
9516             p += elen;
9517         }
9518         if (gap && left) {
9519             memset(p, ' ', gap);
9520             p += gap;
9521         }
9522         if (vectorize) {
9523             if (veclen) {
9524                 Copy(dotstr, p, dotstrlen, char);
9525                 p += dotstrlen;
9526             }
9527             else
9528                 vectorize = FALSE;              /* done iterating over vecstr */
9529         }
9530         if (is_utf8)
9531             has_utf8 = TRUE;
9532         if (has_utf8)
9533             SvUTF8_on(sv);
9534         *p = '\0';
9535         SvCUR_set(sv, p - SvPVX_const(sv));
9536         if (vectorize) {
9537             esignlen = 0;
9538             goto vector;
9539         }
9540     }
9541 }
9542
9543 /* =========================================================================
9544
9545 =head1 Cloning an interpreter
9546
9547 All the macros and functions in this section are for the private use of
9548 the main function, perl_clone().
9549
9550 The foo_dup() functions make an exact copy of an existing foo thingy.
9551 During the course of a cloning, a hash table is used to map old addresses
9552 to new addresses. The table is created and manipulated with the
9553 ptr_table_* functions.
9554
9555 =cut
9556
9557 ============================================================================*/
9558
9559
9560 #if defined(USE_ITHREADS)
9561
9562 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9563 #ifndef GpREFCNT_inc
9564 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9565 #endif
9566
9567
9568 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9569    that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9570    If this changes, please unmerge ss_dup.  */
9571 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9572 #define sv_dup_inc_NN(s,t)      SvREFCNT_inc_NN(sv_dup(s,t))
9573 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
9574 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9575 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
9576 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9577 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
9578 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9579 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
9580 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9581 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
9582 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9583 #define SAVEPV(p)       ((p) ? savepv(p) : NULL)
9584 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
9585
9586 /* clone a parser */
9587
9588 yy_parser *
9589 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9590 {
9591     yy_parser *parser;
9592
9593     if (!proto)
9594         return NULL;
9595
9596     /* look for it in the table first */
9597     parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9598     if (parser)
9599         return parser;
9600
9601     /* create anew and remember what it is */
9602     Newxz(parser, 1, yy_parser);
9603     ptr_table_store(PL_ptr_table, proto, parser);
9604
9605     parser->yyerrstatus = 0;
9606     parser->yychar = YYEMPTY;           /* Cause a token to be read.  */
9607
9608     /* XXX these not yet duped */
9609     parser->old_parser = NULL;
9610     parser->stack = NULL;
9611     parser->ps = NULL;
9612     parser->stack_size = 0;
9613     /* XXX parser->stack->state = 0; */
9614
9615     /* XXX eventually, just Copy() most of the parser struct ? */
9616
9617     parser->lex_brackets = proto->lex_brackets;
9618     parser->lex_casemods = proto->lex_casemods;
9619     parser->lex_brackstack = savepvn(proto->lex_brackstack,
9620                     (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9621     parser->lex_casestack = savepvn(proto->lex_casestack,
9622                     (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9623     parser->lex_defer   = proto->lex_defer;
9624     parser->lex_dojoin  = proto->lex_dojoin;
9625     parser->lex_expect  = proto->lex_expect;
9626     parser->lex_formbrack = proto->lex_formbrack;
9627     parser->lex_inpat   = proto->lex_inpat;
9628     parser->lex_inwhat  = proto->lex_inwhat;
9629     parser->lex_op      = proto->lex_op;
9630     parser->lex_repl    = sv_dup_inc(proto->lex_repl, param);
9631     parser->lex_starts  = proto->lex_starts;
9632     parser->lex_stuff   = sv_dup_inc(proto->lex_stuff, param);
9633     parser->multi_close = proto->multi_close;
9634     parser->multi_open  = proto->multi_open;
9635     parser->multi_start = proto->multi_start;
9636     parser->multi_end   = proto->multi_end;
9637     parser->pending_ident = proto->pending_ident;
9638     parser->preambled   = proto->preambled;
9639     parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9640     parser->linestr     = sv_dup_inc(proto->linestr, param);
9641     parser->expect      = proto->expect;
9642     parser->copline     = proto->copline;
9643     parser->last_lop_op = proto->last_lop_op;
9644     parser->lex_state   = proto->lex_state;
9645     parser->rsfp        = fp_dup(proto->rsfp, '<', param);
9646     /* rsfp_filters entries have fake IoDIRP() */
9647     parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9648     parser->in_my       = proto->in_my;
9649     parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9650     parser->error_count = proto->error_count;
9651
9652
9653     parser->linestr     = sv_dup_inc(proto->linestr, param);
9654
9655     {
9656         char * const ols = SvPVX(proto->linestr);
9657         char * const ls  = SvPVX(parser->linestr);
9658
9659         parser->bufptr      = ls + (proto->bufptr >= ols ?
9660                                     proto->bufptr -  ols : 0);
9661         parser->oldbufptr   = ls + (proto->oldbufptr >= ols ?
9662                                     proto->oldbufptr -  ols : 0);
9663         parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9664                                     proto->oldoldbufptr -  ols : 0);
9665         parser->linestart   = ls + (proto->linestart >= ols ?
9666                                     proto->linestart -  ols : 0);
9667         parser->last_uni    = ls + (proto->last_uni >= ols ?
9668                                     proto->last_uni -  ols : 0);
9669         parser->last_lop    = ls + (proto->last_lop >= ols ?
9670                                     proto->last_lop -  ols : 0);
9671
9672         parser->bufend      = ls + SvCUR(parser->linestr);
9673     }
9674
9675     Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9676
9677
9678 #ifdef PERL_MAD
9679     parser->endwhite    = proto->endwhite;
9680     parser->faketokens  = proto->faketokens;
9681     parser->lasttoke    = proto->lasttoke;
9682     parser->nextwhite   = proto->nextwhite;
9683     parser->realtokenstart = proto->realtokenstart;
9684     parser->skipwhite   = proto->skipwhite;
9685     parser->thisclose   = proto->thisclose;
9686     parser->thismad     = proto->thismad;
9687     parser->thisopen    = proto->thisopen;
9688     parser->thisstuff   = proto->thisstuff;
9689     parser->thistoken   = proto->thistoken;
9690     parser->thiswhite   = proto->thiswhite;
9691
9692     Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9693     parser->curforce    = proto->curforce;
9694 #else
9695     Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9696     Copy(proto->nexttype, parser->nexttype, 5,  I32);
9697     parser->nexttoke    = proto->nexttoke;
9698 #endif
9699     return parser;
9700 }
9701
9702
9703 /* duplicate a file handle */
9704
9705 PerlIO *
9706 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9707 {
9708     PerlIO *ret;
9709
9710     PERL_UNUSED_ARG(type);
9711
9712     if (!fp)
9713         return (PerlIO*)NULL;
9714
9715     /* look for it in the table first */
9716     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9717     if (ret)
9718         return ret;
9719
9720     /* create anew and remember what it is */
9721     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9722     ptr_table_store(PL_ptr_table, fp, ret);
9723     return ret;
9724 }
9725
9726 /* duplicate a directory handle */
9727
9728 DIR *
9729 Perl_dirp_dup(pTHX_ DIR *dp)
9730 {
9731     PERL_UNUSED_CONTEXT;
9732     if (!dp)
9733         return (DIR*)NULL;
9734     /* XXX TODO */
9735     return dp;
9736 }
9737
9738 /* duplicate a typeglob */
9739
9740 GP *
9741 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9742 {
9743     GP *ret;
9744
9745     if (!gp)
9746         return (GP*)NULL;
9747     /* look for it in the table first */
9748     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9749     if (ret)
9750         return ret;
9751
9752     /* create anew and remember what it is */
9753     Newxz(ret, 1, GP);
9754     ptr_table_store(PL_ptr_table, gp, ret);
9755
9756     /* clone */
9757     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
9758     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
9759     ret->gp_io          = io_dup_inc(gp->gp_io, param);
9760     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
9761     ret->gp_av          = av_dup_inc(gp->gp_av, param);
9762     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
9763     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9764     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
9765     ret->gp_cvgen       = gp->gp_cvgen;
9766     ret->gp_line        = gp->gp_line;
9767     ret->gp_file_hek    = hek_dup(gp->gp_file_hek, param);
9768     return ret;
9769 }
9770
9771 /* duplicate a chain of magic */
9772
9773 MAGIC *
9774 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9775 {
9776     MAGIC *mgprev = (MAGIC*)NULL;
9777     MAGIC *mgret;
9778     if (!mg)
9779         return (MAGIC*)NULL;
9780     /* look for it in the table first */
9781     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9782     if (mgret)
9783         return mgret;
9784
9785     for (; mg; mg = mg->mg_moremagic) {
9786         MAGIC *nmg;
9787         Newxz(nmg, 1, MAGIC);
9788         if (mgprev)
9789             mgprev->mg_moremagic = nmg;
9790         else
9791             mgret = nmg;
9792         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
9793         nmg->mg_private = mg->mg_private;
9794         nmg->mg_type    = mg->mg_type;
9795         nmg->mg_flags   = mg->mg_flags;
9796         if (mg->mg_type == PERL_MAGIC_qr) {
9797             nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9798         }
9799         else if(mg->mg_type == PERL_MAGIC_backref) {
9800             /* The backref AV has its reference count deliberately bumped by
9801                1.  */
9802             nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9803         }
9804         else {
9805             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9806                               ? sv_dup_inc(mg->mg_obj, param)
9807                               : sv_dup(mg->mg_obj, param);
9808         }
9809         nmg->mg_len     = mg->mg_len;
9810         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
9811         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9812             if (mg->mg_len > 0) {
9813                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
9814                 if (mg->mg_type == PERL_MAGIC_overload_table &&
9815                         AMT_AMAGIC((AMT*)mg->mg_ptr))
9816                 {
9817                     const AMT * const amtp = (AMT*)mg->mg_ptr;
9818                     AMT * const namtp = (AMT*)nmg->mg_ptr;
9819                     I32 i;
9820                     for (i = 1; i < NofAMmeth; i++) {
9821                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9822                     }
9823                 }
9824             }
9825             else if (mg->mg_len == HEf_SVKEY)
9826                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9827         }
9828         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9829             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9830         }
9831         mgprev = nmg;
9832     }
9833     return mgret;
9834 }
9835
9836 #endif /* USE_ITHREADS */
9837
9838 /* create a new pointer-mapping table */
9839
9840 PTR_TBL_t *
9841 Perl_ptr_table_new(pTHX)
9842 {
9843     PTR_TBL_t *tbl;
9844     PERL_UNUSED_CONTEXT;
9845
9846     Newxz(tbl, 1, PTR_TBL_t);
9847     tbl->tbl_max        = 511;
9848     tbl->tbl_items      = 0;
9849     Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9850     return tbl;
9851 }
9852
9853 #define PTR_TABLE_HASH(ptr) \
9854   ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9855
9856 /* 
9857    we use the PTE_SVSLOT 'reservation' made above, both here (in the
9858    following define) and at call to new_body_inline made below in 
9859    Perl_ptr_table_store()
9860  */
9861
9862 #define del_pte(p)     del_body_type(p, PTE_SVSLOT)
9863
9864 /* map an existing pointer using a table */
9865
9866 STATIC PTR_TBL_ENT_t *
9867 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9868     PTR_TBL_ENT_t *tblent;
9869     const UV hash = PTR_TABLE_HASH(sv);
9870     assert(tbl);
9871     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9872     for (; tblent; tblent = tblent->next) {
9873         if (tblent->oldval == sv)
9874             return tblent;
9875     }
9876     return NULL;
9877 }
9878
9879 void *
9880 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9881 {
9882     PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9883     PERL_UNUSED_CONTEXT;
9884     return tblent ? tblent->newval : NULL;
9885 }
9886
9887 /* add a new entry to a pointer-mapping table */
9888
9889 void
9890 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9891 {
9892     PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9893     PERL_UNUSED_CONTEXT;
9894
9895     if (tblent) {
9896         tblent->newval = newsv;
9897     } else {
9898         const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9899
9900         new_body_inline(tblent, PTE_SVSLOT);
9901
9902         tblent->oldval = oldsv;
9903         tblent->newval = newsv;
9904         tblent->next = tbl->tbl_ary[entry];
9905         tbl->tbl_ary[entry] = tblent;
9906         tbl->tbl_items++;
9907         if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9908             ptr_table_split(tbl);
9909     }
9910 }
9911
9912 /* double the hash bucket size of an existing ptr table */
9913
9914 void
9915 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9916 {
9917     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9918     const UV oldsize = tbl->tbl_max + 1;
9919     UV newsize = oldsize * 2;
9920     UV i;
9921     PERL_UNUSED_CONTEXT;
9922
9923     Renew(ary, newsize, PTR_TBL_ENT_t*);
9924     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9925     tbl->tbl_max = --newsize;
9926     tbl->tbl_ary = ary;
9927     for (i=0; i < oldsize; i++, ary++) {
9928         PTR_TBL_ENT_t **curentp, **entp, *ent;
9929         if (!*ary)
9930             continue;
9931         curentp = ary + oldsize;
9932         for (entp = ary, ent = *ary; ent; ent = *entp) {
9933             if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9934                 *entp = ent->next;
9935                 ent->next = *curentp;
9936                 *curentp = ent;
9937                 continue;
9938             }
9939             else
9940                 entp = &ent->next;
9941         }
9942     }
9943 }
9944
9945 /* remove all the entries from a ptr table */
9946
9947 void
9948 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9949 {
9950     if (tbl && tbl->tbl_items) {
9951         register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9952         UV riter = tbl->tbl_max;
9953
9954         do {
9955             PTR_TBL_ENT_t *entry = array[riter];
9956
9957             while (entry) {
9958                 PTR_TBL_ENT_t * const oentry = entry;
9959                 entry = entry->next;
9960                 del_pte(oentry);
9961             }
9962         } while (riter--);
9963
9964         tbl->tbl_items = 0;
9965     }
9966 }
9967
9968 /* clear and free a ptr table */
9969
9970 void
9971 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9972 {
9973     if (!tbl) {
9974         return;
9975     }
9976     ptr_table_clear(tbl);
9977     Safefree(tbl->tbl_ary);
9978     Safefree(tbl);
9979 }
9980
9981 #if defined(USE_ITHREADS)
9982
9983 void
9984 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9985 {
9986     if (SvROK(sstr)) {
9987         SvRV_set(dstr, SvWEAKREF(sstr)
9988                        ? sv_dup(SvRV(sstr), param)
9989                        : sv_dup_inc(SvRV(sstr), param));
9990
9991     }
9992     else if (SvPVX_const(sstr)) {
9993         /* Has something there */
9994         if (SvLEN(sstr)) {
9995             /* Normal PV - clone whole allocated space */
9996             SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9997             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9998                 /* Not that normal - actually sstr is copy on write.
9999                    But we are a true, independant SV, so:  */
10000                 SvREADONLY_off(dstr);
10001                 SvFAKE_off(dstr);
10002             }
10003         }
10004         else {
10005             /* Special case - not normally malloced for some reason */
10006             if (isGV_with_GP(sstr)) {
10007                 /* Don't need to do anything here.  */
10008             }
10009             else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10010                 /* A "shared" PV - clone it as "shared" PV */
10011                 SvPV_set(dstr,
10012                          HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10013                                          param)));
10014             }
10015             else {
10016                 /* Some other special case - random pointer */
10017                 SvPV_set(dstr, SvPVX(sstr));            
10018             }
10019         }
10020     }
10021     else {
10022         /* Copy the NULL */
10023         SvPV_set(dstr, NULL);
10024     }
10025 }
10026
10027 /* duplicate an SV of any type (including AV, HV etc) */
10028
10029 SV *
10030 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10031 {
10032     dVAR;
10033     SV *dstr;
10034
10035     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10036         return NULL;
10037     /* look for it in the table first */
10038     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10039     if (dstr)
10040         return dstr;
10041
10042     if(param->flags & CLONEf_JOIN_IN) {
10043         /** We are joining here so we don't want do clone
10044             something that is bad **/
10045         if (SvTYPE(sstr) == SVt_PVHV) {
10046             const HEK * const hvname = HvNAME_HEK(sstr);
10047             if (hvname)
10048                 /** don't clone stashes if they already exist **/
10049                 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10050         }
10051     }
10052
10053     /* create anew and remember what it is */
10054     new_SV(dstr);
10055
10056 #ifdef DEBUG_LEAKING_SCALARS
10057     dstr->sv_debug_optype = sstr->sv_debug_optype;
10058     dstr->sv_debug_line = sstr->sv_debug_line;
10059     dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10060     dstr->sv_debug_cloned = 1;
10061     dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10062 #endif
10063
10064     ptr_table_store(PL_ptr_table, sstr, dstr);
10065
10066     /* clone */
10067     SvFLAGS(dstr)       = SvFLAGS(sstr);
10068     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
10069     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
10070
10071 #ifdef DEBUGGING
10072     if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10073         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10074                       (void*)PL_watch_pvx, SvPVX_const(sstr));
10075 #endif
10076
10077     /* don't clone objects whose class has asked us not to */
10078     if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10079         SvFLAGS(dstr) = 0;
10080         return dstr;
10081     }
10082
10083     switch (SvTYPE(sstr)) {
10084     case SVt_NULL:
10085         SvANY(dstr)     = NULL;
10086         break;
10087     case SVt_IV:
10088         SvANY(dstr)     = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10089         if(SvROK(sstr)) {
10090             Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10091         } else {
10092             SvIV_set(dstr, SvIVX(sstr));
10093         }
10094         break;
10095     case SVt_NV:
10096         SvANY(dstr)     = new_XNV();
10097         SvNV_set(dstr, SvNVX(sstr));
10098         break;
10099         /* case SVt_BIND: */
10100     default:
10101         {
10102             /* These are all the types that need complex bodies allocating.  */
10103             void *new_body;
10104             const svtype sv_type = SvTYPE(sstr);
10105             const struct body_details *const sv_type_details
10106                 = bodies_by_type + sv_type;
10107
10108             switch (sv_type) {
10109             default:
10110                 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10111                 break;
10112
10113             case SVt_PVGV:
10114                 if (GvUNIQUE((GV*)sstr)) {
10115                     NOOP;   /* Do sharing here, and fall through */
10116                 }
10117             case SVt_PVIO:
10118             case SVt_PVFM:
10119             case SVt_PVHV:
10120             case SVt_PVAV:
10121             case SVt_PVCV:
10122             case SVt_PVLV:
10123             case SVt_PVMG:
10124             case SVt_PVNV:
10125             case SVt_PVIV:
10126             case SVt_PV:
10127                 assert(sv_type_details->body_size);
10128                 if (sv_type_details->arena) {
10129                     new_body_inline(new_body, sv_type);
10130                     new_body
10131                         = (void*)((char*)new_body - sv_type_details->offset);
10132                 } else {
10133                     new_body = new_NOARENA(sv_type_details);
10134                 }
10135             }
10136             assert(new_body);
10137             SvANY(dstr) = new_body;
10138
10139 #ifndef PURIFY
10140             Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10141                  ((char*)SvANY(dstr)) + sv_type_details->offset,
10142                  sv_type_details->copy, char);
10143 #else
10144             Copy(((char*)SvANY(sstr)),
10145                  ((char*)SvANY(dstr)),
10146                  sv_type_details->body_size + sv_type_details->offset, char);
10147 #endif
10148
10149             if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10150                 && !isGV_with_GP(dstr))
10151                 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10152
10153             /* The Copy above means that all the source (unduplicated) pointers
10154                are now in the destination.  We can check the flags and the
10155                pointers in either, but it's possible that there's less cache
10156                missing by always going for the destination.
10157                FIXME - instrument and check that assumption  */
10158             if (sv_type >= SVt_PVMG) {
10159                 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10160                     SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10161                 } else if (SvMAGIC(dstr))
10162                     SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10163                 if (SvSTASH(dstr))
10164                     SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10165             }
10166
10167             /* The cast silences a GCC warning about unhandled types.  */
10168             switch ((int)sv_type) {
10169             case SVt_PV:
10170                 break;
10171             case SVt_PVIV:
10172                 break;
10173             case SVt_PVNV:
10174                 break;
10175             case SVt_PVMG:
10176                 break;
10177             case SVt_PVLV:
10178                 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10179                 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10180                     LvTARG(dstr) = dstr;
10181                 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10182                     LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10183                 else
10184                     LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10185             case SVt_PVGV:
10186                 if(isGV_with_GP(sstr)) {
10187                     if (GvNAME_HEK(dstr))
10188                         GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10189                     /* Don't call sv_add_backref here as it's going to be
10190                        created as part of the magic cloning of the symbol
10191                        table.  */
10192                     /* Danger Will Robinson - GvGP(dstr) isn't initialised
10193                        at the point of this comment.  */
10194                     GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10195                     GvGP(dstr)  = gp_dup(GvGP(sstr), param);
10196                     (void)GpREFCNT_inc(GvGP(dstr));
10197                 } else
10198                     Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10199                 break;
10200             case SVt_PVIO:
10201                 IoIFP(dstr)     = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10202                 if (IoOFP(dstr) == IoIFP(sstr))
10203                     IoOFP(dstr) = IoIFP(dstr);
10204                 else
10205                     IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10206                 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10207                 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10208                     /* I have no idea why fake dirp (rsfps)
10209                        should be treated differently but otherwise
10210                        we end up with leaks -- sky*/
10211                     IoTOP_GV(dstr)      = gv_dup_inc(IoTOP_GV(dstr), param);
10212                     IoFMT_GV(dstr)      = gv_dup_inc(IoFMT_GV(dstr), param);
10213                     IoBOTTOM_GV(dstr)   = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10214                 } else {
10215                     IoTOP_GV(dstr)      = gv_dup(IoTOP_GV(dstr), param);
10216                     IoFMT_GV(dstr)      = gv_dup(IoFMT_GV(dstr), param);
10217                     IoBOTTOM_GV(dstr)   = gv_dup(IoBOTTOM_GV(dstr), param);
10218                     if (IoDIRP(dstr)) {
10219                         IoDIRP(dstr)    = dirp_dup(IoDIRP(dstr));
10220                     } else {
10221                         NOOP;
10222                         /* IoDIRP(dstr) is already a copy of IoDIRP(sstr)  */
10223                     }
10224                 }
10225                 IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(dstr));
10226                 IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(dstr));
10227                 IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(dstr));
10228                 break;
10229             case SVt_PVAV:
10230                 if (AvARRAY((AV*)sstr)) {
10231                     SV **dst_ary, **src_ary;
10232                     SSize_t items = AvFILLp((AV*)sstr) + 1;
10233
10234                     src_ary = AvARRAY((AV*)sstr);
10235                     Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10236                     ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10237                     AvARRAY((AV*)dstr) = dst_ary;
10238                     AvALLOC((AV*)dstr) = dst_ary;
10239                     if (AvREAL((AV*)sstr)) {
10240                         while (items-- > 0)
10241                             *dst_ary++ = sv_dup_inc(*src_ary++, param);
10242                     }
10243                     else {
10244                         while (items-- > 0)
10245                             *dst_ary++ = sv_dup(*src_ary++, param);
10246                     }
10247                     items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10248                     while (items-- > 0) {
10249                         *dst_ary++ = &PL_sv_undef;
10250                     }
10251                 }
10252                 else {
10253                     AvARRAY((AV*)dstr)  = NULL;
10254                     AvALLOC((AV*)dstr)  = (SV**)NULL;
10255                 }
10256                 break;
10257             case SVt_PVHV:
10258                 if (HvARRAY((HV*)sstr)) {
10259                     STRLEN i = 0;
10260                     const bool sharekeys = !!HvSHAREKEYS(sstr);
10261                     XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10262                     XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10263                     char *darray;
10264                     Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10265                         + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10266                         char);
10267                     HvARRAY(dstr) = (HE**)darray;
10268                     while (i <= sxhv->xhv_max) {
10269                         const HE * const source = HvARRAY(sstr)[i];
10270                         HvARRAY(dstr)[i] = source
10271                             ? he_dup(source, sharekeys, param) : 0;
10272                         ++i;
10273                     }
10274                     if (SvOOK(sstr)) {
10275                         HEK *hvname;
10276                         const struct xpvhv_aux * const saux = HvAUX(sstr);
10277                         struct xpvhv_aux * const daux = HvAUX(dstr);
10278                         /* This flag isn't copied.  */
10279                         /* SvOOK_on(hv) attacks the IV flags.  */
10280                         SvFLAGS(dstr) |= SVf_OOK;
10281
10282                         hvname = saux->xhv_name;
10283                         daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10284
10285                         daux->xhv_riter = saux->xhv_riter;
10286                         daux->xhv_eiter = saux->xhv_eiter
10287                             ? he_dup(saux->xhv_eiter,
10288                                         (bool)!!HvSHAREKEYS(sstr), param) : 0;
10289                         daux->xhv_backreferences =
10290                             saux->xhv_backreferences
10291                                 ? (AV*) SvREFCNT_inc(
10292                                         sv_dup((SV*)saux->xhv_backreferences, param))
10293                                 : 0;
10294
10295                         daux->xhv_mro_meta = saux->xhv_mro_meta
10296                             ? mro_meta_dup(saux->xhv_mro_meta, param)
10297                             : 0;
10298
10299                         /* Record stashes for possible cloning in Perl_clone(). */
10300                         if (hvname)
10301                             av_push(param->stashes, dstr);
10302                     }
10303                 }
10304                 else
10305                     HvARRAY((HV*)dstr) = NULL;
10306                 break;
10307             case SVt_PVCV:
10308                 if (!(param->flags & CLONEf_COPY_STACKS)) {
10309                     CvDEPTH(dstr) = 0;
10310                 }
10311             case SVt_PVFM:
10312                 /* NOTE: not refcounted */
10313                 CvSTASH(dstr)   = hv_dup(CvSTASH(dstr), param);
10314                 OP_REFCNT_LOCK;
10315                 if (!CvISXSUB(dstr))
10316                     CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10317                 OP_REFCNT_UNLOCK;
10318                 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10319                     CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10320                         SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10321                         sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10322                 }
10323                 /* don't dup if copying back - CvGV isn't refcounted, so the
10324                  * duped GV may never be freed. A bit of a hack! DAPM */
10325                 CvGV(dstr)      = (param->flags & CLONEf_JOIN_IN) ?
10326                     NULL : gv_dup(CvGV(dstr), param) ;
10327                 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10328                 CvOUTSIDE(dstr) =
10329                     CvWEAKOUTSIDE(sstr)
10330                     ? cv_dup(    CvOUTSIDE(dstr), param)
10331                     : cv_dup_inc(CvOUTSIDE(dstr), param);
10332                 if (!CvISXSUB(dstr))
10333                     CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10334                 break;
10335             }
10336         }
10337     }
10338
10339     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10340         ++PL_sv_objcount;
10341
10342     return dstr;
10343  }
10344
10345 /* duplicate a context */
10346
10347 PERL_CONTEXT *
10348 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10349 {
10350     PERL_CONTEXT *ncxs;
10351
10352     if (!cxs)
10353         return (PERL_CONTEXT*)NULL;
10354
10355     /* look for it in the table first */
10356     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10357     if (ncxs)
10358         return ncxs;
10359
10360     /* create anew and remember what it is */
10361     Newxz(ncxs, max + 1, PERL_CONTEXT);
10362     ptr_table_store(PL_ptr_table, cxs, ncxs);
10363
10364     while (ix >= 0) {
10365         PERL_CONTEXT * const cx = &cxs[ix];
10366         PERL_CONTEXT * const ncx = &ncxs[ix];
10367         ncx->cx_type    = cx->cx_type;
10368         if (CxTYPE(cx) == CXt_SUBST) {
10369             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10370         }
10371         else {
10372             ncx->blk_oldsp      = cx->blk_oldsp;
10373             ncx->blk_oldcop     = cx->blk_oldcop;
10374             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
10375             ncx->blk_oldscopesp = cx->blk_oldscopesp;
10376             ncx->blk_oldpm      = cx->blk_oldpm;
10377             ncx->blk_gimme      = cx->blk_gimme;
10378             switch (CxTYPE(cx)) {
10379             case CXt_SUB:
10380                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
10381                                            ? cv_dup_inc(cx->blk_sub.cv, param)
10382                                            : cv_dup(cx->blk_sub.cv,param));
10383                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
10384                                            ? av_dup_inc(cx->blk_sub.argarray, param)
10385                                            : NULL);
10386                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
10387                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
10388                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10389                 ncx->blk_sub.lval       = cx->blk_sub.lval;
10390                 ncx->blk_sub.retop      = cx->blk_sub.retop;
10391                 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10392                                            cx->blk_sub.oldcomppad);
10393                 break;
10394             case CXt_EVAL:
10395                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10396                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10397                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10398                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10399                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
10400                 ncx->blk_eval.retop = cx->blk_eval.retop;
10401                 break;
10402             case CXt_LOOP:
10403                 ncx->blk_loop.label     = cx->blk_loop.label;
10404                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
10405                 ncx->blk_loop.my_op     = cx->blk_loop.my_op;
10406                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
10407                                            ? cx->blk_loop.iterdata
10408                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
10409                 ncx->blk_loop.oldcomppad
10410                     = (PAD*)ptr_table_fetch(PL_ptr_table,
10411                                             cx->blk_loop.oldcomppad);
10412                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
10413                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
10414                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
10415                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
10416                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
10417                 break;
10418             case CXt_FORMAT:
10419                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
10420                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
10421                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10422                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10423                 ncx->blk_sub.retop      = cx->blk_sub.retop;
10424                 break;
10425             case CXt_BLOCK:
10426             case CXt_NULL:
10427                 break;
10428             }
10429         }
10430         --ix;
10431     }
10432     return ncxs;
10433 }
10434
10435 /* duplicate a stack info structure */
10436
10437 PERL_SI *
10438 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10439 {
10440     PERL_SI *nsi;
10441
10442     if (!si)
10443         return (PERL_SI*)NULL;
10444
10445     /* look for it in the table first */
10446     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10447     if (nsi)
10448         return nsi;
10449
10450     /* create anew and remember what it is */
10451     Newxz(nsi, 1, PERL_SI);
10452     ptr_table_store(PL_ptr_table, si, nsi);
10453
10454     nsi->si_stack       = av_dup_inc(si->si_stack, param);
10455     nsi->si_cxix        = si->si_cxix;
10456     nsi->si_cxmax       = si->si_cxmax;
10457     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10458     nsi->si_type        = si->si_type;
10459     nsi->si_prev        = si_dup(si->si_prev, param);
10460     nsi->si_next        = si_dup(si->si_next, param);
10461     nsi->si_markoff     = si->si_markoff;
10462
10463     return nsi;
10464 }
10465
10466 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
10467 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
10468 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
10469 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
10470 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
10471 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
10472 #define POPBOOL(ss,ix)  ((ss)[--(ix)].any_bool)
10473 #define TOPBOOL(ss,ix)  ((ss)[ix].any_bool)
10474 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
10475 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
10476 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
10477 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
10478 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10479 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10480
10481 /* XXXXX todo */
10482 #define pv_dup_inc(p)   SAVEPV(p)
10483 #define pv_dup(p)       SAVEPV(p)
10484 #define svp_dup_inc(p,pp)       any_dup(p,pp)
10485
10486 /* map any object to the new equivent - either something in the
10487  * ptr table, or something in the interpreter structure
10488  */
10489
10490 void *
10491 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10492 {
10493     void *ret;
10494
10495     if (!v)
10496         return (void*)NULL;
10497
10498     /* look for it in the table first */
10499     ret = ptr_table_fetch(PL_ptr_table, v);
10500     if (ret)
10501         return ret;
10502
10503     /* see if it is part of the interpreter structure */
10504     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10505         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10506     else {
10507         ret = v;
10508     }
10509
10510     return ret;
10511 }
10512
10513 /* duplicate the save stack */
10514
10515 ANY *
10516 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10517 {
10518     dVAR;
10519     ANY * const ss      = proto_perl->Isavestack;
10520     const I32 max       = proto_perl->Isavestack_max;
10521     I32 ix              = proto_perl->Isavestack_ix;
10522     ANY *nss;
10523     SV *sv;
10524     GV *gv;
10525     AV *av;
10526     HV *hv;
10527     void* ptr;
10528     int intval;
10529     long longval;
10530     GP *gp;
10531     IV iv;
10532     I32 i;
10533     char *c = NULL;
10534     void (*dptr) (void*);
10535     void (*dxptr) (pTHX_ void*);
10536
10537     Newxz(nss, max, ANY);
10538
10539     while (ix > 0) {
10540         const I32 type = POPINT(ss,ix);
10541         TOPINT(nss,ix) = type;
10542         switch (type) {
10543         case SAVEt_HELEM:               /* hash element */
10544             sv = (SV*)POPPTR(ss,ix);
10545             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10546             /* fall through */
10547         case SAVEt_ITEM:                        /* normal string */
10548         case SAVEt_SV:                          /* scalar reference */
10549             sv = (SV*)POPPTR(ss,ix);
10550             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10551             /* fall through */
10552         case SAVEt_FREESV:
10553         case SAVEt_MORTALIZESV:
10554             sv = (SV*)POPPTR(ss,ix);
10555             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10556             break;
10557         case SAVEt_SHARED_PVREF:                /* char* in shared space */
10558             c = (char*)POPPTR(ss,ix);
10559             TOPPTR(nss,ix) = savesharedpv(c);
10560             ptr = POPPTR(ss,ix);
10561             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10562             break;
10563         case SAVEt_GENERIC_SVREF:               /* generic sv */
10564         case SAVEt_SVREF:                       /* scalar reference */
10565             sv = (SV*)POPPTR(ss,ix);
10566             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10567             ptr = POPPTR(ss,ix);
10568             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10569             break;
10570         case SAVEt_HV:                          /* hash reference */
10571         case SAVEt_AV:                          /* array reference */
10572             sv = (SV*) POPPTR(ss,ix);
10573             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10574             /* fall through */
10575         case SAVEt_COMPPAD:
10576         case SAVEt_NSTAB:
10577             sv = (SV*) POPPTR(ss,ix);
10578             TOPPTR(nss,ix) = sv_dup(sv, param);
10579             break;
10580         case SAVEt_INT:                         /* int reference */
10581             ptr = POPPTR(ss,ix);
10582             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10583             intval = (int)POPINT(ss,ix);
10584             TOPINT(nss,ix) = intval;
10585             break;
10586         case SAVEt_LONG:                        /* long reference */
10587             ptr = POPPTR(ss,ix);
10588             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10589             /* fall through */
10590         case SAVEt_CLEARSV:
10591             longval = (long)POPLONG(ss,ix);
10592             TOPLONG(nss,ix) = longval;
10593             break;
10594         case SAVEt_I32:                         /* I32 reference */
10595         case SAVEt_I16:                         /* I16 reference */
10596         case SAVEt_I8:                          /* I8 reference */
10597         case SAVEt_COP_ARYBASE:                 /* call CopARYBASE_set */
10598             ptr = POPPTR(ss,ix);
10599             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10600             i = POPINT(ss,ix);
10601             TOPINT(nss,ix) = i;
10602             break;
10603         case SAVEt_IV:                          /* IV reference */
10604             ptr = POPPTR(ss,ix);
10605             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10606             iv = POPIV(ss,ix);
10607             TOPIV(nss,ix) = iv;
10608             break;
10609         case SAVEt_HPTR:                        /* HV* reference */
10610         case SAVEt_APTR:                        /* AV* reference */
10611         case SAVEt_SPTR:                        /* SV* reference */
10612             ptr = POPPTR(ss,ix);
10613             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10614             sv = (SV*)POPPTR(ss,ix);
10615             TOPPTR(nss,ix) = sv_dup(sv, param);
10616             break;
10617         case SAVEt_VPTR:                        /* random* reference */
10618             ptr = POPPTR(ss,ix);
10619             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10620             ptr = POPPTR(ss,ix);
10621             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10622             break;
10623         case SAVEt_GENERIC_PVREF:               /* generic char* */
10624         case SAVEt_PPTR:                        /* char* reference */
10625             ptr = POPPTR(ss,ix);
10626             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10627             c = (char*)POPPTR(ss,ix);
10628             TOPPTR(nss,ix) = pv_dup(c);
10629             break;
10630         case SAVEt_GP:                          /* scalar reference */
10631             gp = (GP*)POPPTR(ss,ix);
10632             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10633             (void)GpREFCNT_inc(gp);
10634             gv = (GV*)POPPTR(ss,ix);
10635             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10636             break;
10637         case SAVEt_FREEOP:
10638             ptr = POPPTR(ss,ix);
10639             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10640                 /* these are assumed to be refcounted properly */
10641                 OP *o;
10642                 switch (((OP*)ptr)->op_type) {
10643                 case OP_LEAVESUB:
10644                 case OP_LEAVESUBLV:
10645                 case OP_LEAVEEVAL:
10646                 case OP_LEAVE:
10647                 case OP_SCOPE:
10648                 case OP_LEAVEWRITE:
10649                     TOPPTR(nss,ix) = ptr;
10650                     o = (OP*)ptr;
10651                     OP_REFCNT_LOCK;
10652                     (void) OpREFCNT_inc(o);
10653                     OP_REFCNT_UNLOCK;
10654                     break;
10655                 default:
10656                     TOPPTR(nss,ix) = NULL;
10657                     break;
10658                 }
10659             }
10660             else
10661                 TOPPTR(nss,ix) = NULL;
10662             break;
10663         case SAVEt_FREEPV:
10664             c = (char*)POPPTR(ss,ix);
10665             TOPPTR(nss,ix) = pv_dup_inc(c);
10666             break;
10667         case SAVEt_DELETE:
10668             hv = (HV*)POPPTR(ss,ix);
10669             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10670             c = (char*)POPPTR(ss,ix);
10671             TOPPTR(nss,ix) = pv_dup_inc(c);
10672             /* fall through */
10673         case SAVEt_STACK_POS:           /* Position on Perl stack */
10674             i = POPINT(ss,ix);
10675             TOPINT(nss,ix) = i;
10676             break;
10677         case SAVEt_DESTRUCTOR:
10678             ptr = POPPTR(ss,ix);
10679             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
10680             dptr = POPDPTR(ss,ix);
10681             TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10682                                         any_dup(FPTR2DPTR(void *, dptr),
10683                                                 proto_perl));
10684             break;
10685         case SAVEt_DESTRUCTOR_X:
10686             ptr = POPPTR(ss,ix);
10687             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
10688             dxptr = POPDXPTR(ss,ix);
10689             TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10690                                          any_dup(FPTR2DPTR(void *, dxptr),
10691                                                  proto_perl));
10692             break;
10693         case SAVEt_REGCONTEXT:
10694         case SAVEt_ALLOC:
10695             i = POPINT(ss,ix);
10696             TOPINT(nss,ix) = i;
10697             ix -= i;
10698             break;
10699         case SAVEt_AELEM:               /* array element */
10700             sv = (SV*)POPPTR(ss,ix);
10701             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10702             i = POPINT(ss,ix);
10703             TOPINT(nss,ix) = i;
10704             av = (AV*)POPPTR(ss,ix);
10705             TOPPTR(nss,ix) = av_dup_inc(av, param);
10706             break;
10707         case SAVEt_OP:
10708             ptr = POPPTR(ss,ix);
10709             TOPPTR(nss,ix) = ptr;
10710             break;
10711         case SAVEt_HINTS:
10712             i = POPINT(ss,ix);
10713             TOPINT(nss,ix) = i;
10714             ptr = POPPTR(ss,ix);
10715             if (ptr) {
10716                 HINTS_REFCNT_LOCK;
10717                 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10718                 HINTS_REFCNT_UNLOCK;
10719             }
10720             TOPPTR(nss,ix) = ptr;
10721             if (i & HINT_LOCALIZE_HH) {
10722                 hv = (HV*)POPPTR(ss,ix);
10723                 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10724             }
10725             break;
10726         case SAVEt_PADSV:
10727             longval = (long)POPLONG(ss,ix);
10728             TOPLONG(nss,ix) = longval;
10729             ptr = POPPTR(ss,ix);
10730             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10731             sv = (SV*)POPPTR(ss,ix);
10732             TOPPTR(nss,ix) = sv_dup(sv, param);
10733             break;
10734         case SAVEt_BOOL:
10735             ptr = POPPTR(ss,ix);
10736             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10737             longval = (long)POPBOOL(ss,ix);
10738             TOPBOOL(nss,ix) = (bool)longval;
10739             break;
10740         case SAVEt_SET_SVFLAGS:
10741             i = POPINT(ss,ix);
10742             TOPINT(nss,ix) = i;
10743             i = POPINT(ss,ix);
10744             TOPINT(nss,ix) = i;
10745             sv = (SV*)POPPTR(ss,ix);
10746             TOPPTR(nss,ix) = sv_dup(sv, param);
10747             break;
10748         case SAVEt_RE_STATE:
10749             {
10750                 const struct re_save_state *const old_state
10751                     = (struct re_save_state *)
10752                     (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10753                 struct re_save_state *const new_state
10754                     = (struct re_save_state *)
10755                     (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10756
10757                 Copy(old_state, new_state, 1, struct re_save_state);
10758                 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10759
10760                 new_state->re_state_bostr
10761                     = pv_dup(old_state->re_state_bostr);
10762                 new_state->re_state_reginput
10763                     = pv_dup(old_state->re_state_reginput);
10764                 new_state->re_state_regeol
10765                     = pv_dup(old_state->re_state_regeol);
10766                 new_state->re_state_regoffs
10767                     = (regexp_paren_pair*)
10768                         any_dup(old_state->re_state_regoffs, proto_perl);
10769                 new_state->re_state_reglastparen
10770                     = (U32*) any_dup(old_state->re_state_reglastparen, 
10771                               proto_perl);
10772                 new_state->re_state_reglastcloseparen
10773                     = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10774                               proto_perl);
10775                 /* XXX This just has to be broken. The old save_re_context
10776                    code did SAVEGENERICPV(PL_reg_start_tmp);
10777                    PL_reg_start_tmp is char **.
10778                    Look above to what the dup code does for
10779                    SAVEt_GENERIC_PVREF
10780                    It can never have worked.
10781                    So this is merely a faithful copy of the exiting bug:  */
10782                 new_state->re_state_reg_start_tmp
10783                     = (char **) pv_dup((char *)
10784                                       old_state->re_state_reg_start_tmp);
10785                 /* I assume that it only ever "worked" because no-one called
10786                    (pseudo)fork while the regexp engine had re-entered itself.
10787                 */
10788 #ifdef PERL_OLD_COPY_ON_WRITE
10789                 new_state->re_state_nrs
10790                     = sv_dup(old_state->re_state_nrs, param);
10791 #endif
10792                 new_state->re_state_reg_magic
10793                     = (MAGIC*) any_dup(old_state->re_state_reg_magic, 
10794                                proto_perl);
10795                 new_state->re_state_reg_oldcurpm
10796                     = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm, 
10797                               proto_perl);
10798                 new_state->re_state_reg_curpm
10799                     = (PMOP*)  any_dup(old_state->re_state_reg_curpm, 
10800                                proto_perl);
10801                 new_state->re_state_reg_oldsaved
10802                     = pv_dup(old_state->re_state_reg_oldsaved);
10803                 new_state->re_state_reg_poscache
10804                     = pv_dup(old_state->re_state_reg_poscache);
10805                 new_state->re_state_reg_starttry
10806                     = pv_dup(old_state->re_state_reg_starttry);
10807                 break;
10808             }
10809         case SAVEt_COMPILE_WARNINGS:
10810             ptr = POPPTR(ss,ix);
10811             TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10812             break;
10813         case SAVEt_PARSER:
10814             ptr = POPPTR(ss,ix);
10815             TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10816             break;
10817         default:
10818             Perl_croak(aTHX_
10819                        "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10820         }
10821     }
10822
10823     return nss;
10824 }
10825
10826
10827 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10828  * flag to the result. This is done for each stash before cloning starts,
10829  * so we know which stashes want their objects cloned */
10830
10831 static void
10832 do_mark_cloneable_stash(pTHX_ SV *sv)
10833 {
10834     const HEK * const hvname = HvNAME_HEK((HV*)sv);
10835     if (hvname) {
10836         GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10837         SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10838         if (cloner && GvCV(cloner)) {
10839             dSP;
10840             UV status;
10841
10842             ENTER;
10843             SAVETMPS;
10844             PUSHMARK(SP);
10845             XPUSHs(sv_2mortal(newSVhek(hvname)));
10846             PUTBACK;
10847             call_sv((SV*)GvCV(cloner), G_SCALAR);
10848             SPAGAIN;
10849             status = POPu;
10850             PUTBACK;
10851             FREETMPS;
10852             LEAVE;
10853             if (status)
10854                 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10855         }
10856     }
10857 }
10858
10859
10860
10861 /*
10862 =for apidoc perl_clone
10863
10864 Create and return a new interpreter by cloning the current one.
10865
10866 perl_clone takes these flags as parameters:
10867
10868 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10869 without it we only clone the data and zero the stacks,
10870 with it we copy the stacks and the new perl interpreter is
10871 ready to run at the exact same point as the previous one.
10872 The pseudo-fork code uses COPY_STACKS while the
10873 threads->create doesn't.
10874
10875 CLONEf_KEEP_PTR_TABLE
10876 perl_clone keeps a ptr_table with the pointer of the old
10877 variable as a key and the new variable as a value,
10878 this allows it to check if something has been cloned and not
10879 clone it again but rather just use the value and increase the
10880 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10881 the ptr_table using the function
10882 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10883 reason to keep it around is if you want to dup some of your own
10884 variable who are outside the graph perl scans, example of this
10885 code is in threads.xs create
10886
10887 CLONEf_CLONE_HOST
10888 This is a win32 thing, it is ignored on unix, it tells perls
10889 win32host code (which is c++) to clone itself, this is needed on
10890 win32 if you want to run two threads at the same time,
10891 if you just want to do some stuff in a separate perl interpreter
10892 and then throw it away and return to the original one,
10893 you don't need to do anything.
10894
10895 =cut
10896 */
10897
10898 /* XXX the above needs expanding by someone who actually understands it ! */
10899 EXTERN_C PerlInterpreter *
10900 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10901
10902 PerlInterpreter *
10903 perl_clone(PerlInterpreter *proto_perl, UV flags)
10904 {
10905    dVAR;
10906 #ifdef PERL_IMPLICIT_SYS
10907
10908    /* perlhost.h so we need to call into it
10909    to clone the host, CPerlHost should have a c interface, sky */
10910
10911    if (flags & CLONEf_CLONE_HOST) {
10912        return perl_clone_host(proto_perl,flags);
10913    }
10914    return perl_clone_using(proto_perl, flags,
10915                             proto_perl->IMem,
10916                             proto_perl->IMemShared,
10917                             proto_perl->IMemParse,
10918                             proto_perl->IEnv,
10919                             proto_perl->IStdIO,
10920                             proto_perl->ILIO,
10921                             proto_perl->IDir,
10922                             proto_perl->ISock,
10923                             proto_perl->IProc);
10924 }
10925
10926 PerlInterpreter *
10927 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10928                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
10929                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10930                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10931                  struct IPerlDir* ipD, struct IPerlSock* ipS,
10932                  struct IPerlProc* ipP)
10933 {
10934     /* XXX many of the string copies here can be optimized if they're
10935      * constants; they need to be allocated as common memory and just
10936      * their pointers copied. */
10937
10938     IV i;
10939     CLONE_PARAMS clone_params;
10940     CLONE_PARAMS* const param = &clone_params;
10941
10942     PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10943     /* for each stash, determine whether its objects should be cloned */
10944     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10945     PERL_SET_THX(my_perl);
10946
10947 #  ifdef DEBUGGING
10948     PoisonNew(my_perl, 1, PerlInterpreter);
10949     PL_op = NULL;
10950     PL_curcop = NULL;
10951     PL_markstack = 0;
10952     PL_scopestack = 0;
10953     PL_savestack = 0;
10954     PL_savestack_ix = 0;
10955     PL_savestack_max = -1;
10956     PL_sig_pending = 0;
10957     PL_parser = NULL;
10958     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10959 #  else /* !DEBUGGING */
10960     Zero(my_perl, 1, PerlInterpreter);
10961 #  endif        /* DEBUGGING */
10962
10963     /* host pointers */
10964     PL_Mem              = ipM;
10965     PL_MemShared        = ipMS;
10966     PL_MemParse         = ipMP;
10967     PL_Env              = ipE;
10968     PL_StdIO            = ipStd;
10969     PL_LIO              = ipLIO;
10970     PL_Dir              = ipD;
10971     PL_Sock             = ipS;
10972     PL_Proc             = ipP;
10973 #else           /* !PERL_IMPLICIT_SYS */
10974     IV i;
10975     CLONE_PARAMS clone_params;
10976     CLONE_PARAMS* param = &clone_params;
10977     PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10978     /* for each stash, determine whether its objects should be cloned */
10979     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10980     PERL_SET_THX(my_perl);
10981
10982 #    ifdef DEBUGGING
10983     PoisonNew(my_perl, 1, PerlInterpreter);
10984     PL_op = NULL;
10985     PL_curcop = NULL;
10986     PL_markstack = 0;
10987     PL_scopestack = 0;
10988     PL_savestack = 0;
10989     PL_savestack_ix = 0;
10990     PL_savestack_max = -1;
10991     PL_sig_pending = 0;
10992     PL_parser = NULL;
10993     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10994 #    else       /* !DEBUGGING */
10995     Zero(my_perl, 1, PerlInterpreter);
10996 #    endif      /* DEBUGGING */
10997 #endif          /* PERL_IMPLICIT_SYS */
10998     param->flags = flags;
10999     param->proto_perl = proto_perl;
11000
11001     INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11002
11003     PL_body_arenas = NULL;
11004     Zero(&PL_body_roots, 1, PL_body_roots);
11005     
11006     PL_nice_chunk       = NULL;
11007     PL_nice_chunk_size  = 0;
11008     PL_sv_count         = 0;
11009     PL_sv_objcount      = 0;
11010     PL_sv_root          = NULL;
11011     PL_sv_arenaroot     = NULL;
11012
11013     PL_debug            = proto_perl->Idebug;
11014
11015     PL_hash_seed        = proto_perl->Ihash_seed;
11016     PL_rehash_seed      = proto_perl->Irehash_seed;
11017
11018 #ifdef USE_REENTRANT_API
11019     /* XXX: things like -Dm will segfault here in perlio, but doing
11020      *  PERL_SET_CONTEXT(proto_perl);
11021      * breaks too many other things
11022      */
11023     Perl_reentrant_init(aTHX);
11024 #endif
11025
11026     /* create SV map for pointer relocation */
11027     PL_ptr_table = ptr_table_new();
11028
11029     /* initialize these special pointers as early as possible */
11030     SvANY(&PL_sv_undef)         = NULL;
11031     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
11032     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
11033     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11034
11035     SvANY(&PL_sv_no)            = new_XPVNV();
11036     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
11037     SvFLAGS(&PL_sv_no)          = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11038                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11039     SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11040     SvCUR_set(&PL_sv_no, 0);
11041     SvLEN_set(&PL_sv_no, 1);
11042     SvIV_set(&PL_sv_no, 0);
11043     SvNV_set(&PL_sv_no, 0);
11044     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11045
11046     SvANY(&PL_sv_yes)           = new_XPVNV();
11047     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
11048     SvFLAGS(&PL_sv_yes)         = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11049                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11050     SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11051     SvCUR_set(&PL_sv_yes, 1);
11052     SvLEN_set(&PL_sv_yes, 2);
11053     SvIV_set(&PL_sv_yes, 1);
11054     SvNV_set(&PL_sv_yes, 1);
11055     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11056
11057     /* create (a non-shared!) shared string table */
11058     PL_strtab           = newHV();
11059     HvSHAREKEYS_off(PL_strtab);
11060     hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11061     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11062
11063     PL_compiling = proto_perl->Icompiling;
11064
11065     /* These two PVs will be free'd special way so must set them same way op.c does */
11066     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11067     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11068
11069     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
11070     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11071
11072     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11073     PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11074     if (PL_compiling.cop_hints_hash) {
11075         HINTS_REFCNT_LOCK;
11076         PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11077         HINTS_REFCNT_UNLOCK;
11078     }
11079     PL_curcop           = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11080 #ifdef PERL_DEBUG_READONLY_OPS
11081     PL_slabs = NULL;
11082     PL_slab_count = 0;
11083 #endif
11084
11085     /* pseudo environmental stuff */
11086     PL_origargc         = proto_perl->Iorigargc;
11087     PL_origargv         = proto_perl->Iorigargv;
11088
11089     param->stashes      = newAV();  /* Setup array of objects to call clone on */
11090
11091     /* Set tainting stuff before PerlIO_debug can possibly get called */
11092     PL_tainting         = proto_perl->Itainting;
11093     PL_taint_warn       = proto_perl->Itaint_warn;
11094
11095 #ifdef PERLIO_LAYERS
11096     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11097     PerlIO_clone(aTHX_ proto_perl, param);
11098 #endif
11099
11100     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
11101     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
11102     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
11103     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
11104     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
11105     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
11106
11107     /* switches */
11108     PL_minus_c          = proto_perl->Iminus_c;
11109     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
11110     PL_localpatches     = proto_perl->Ilocalpatches;
11111     PL_splitstr         = proto_perl->Isplitstr;
11112     PL_preprocess       = proto_perl->Ipreprocess;
11113     PL_minus_n          = proto_perl->Iminus_n;
11114     PL_minus_p          = proto_perl->Iminus_p;
11115     PL_minus_l          = proto_perl->Iminus_l;
11116     PL_minus_a          = proto_perl->Iminus_a;
11117     PL_minus_E          = proto_perl->Iminus_E;
11118     PL_minus_F          = proto_perl->Iminus_F;
11119     PL_doswitches       = proto_perl->Idoswitches;
11120     PL_dowarn           = proto_perl->Idowarn;
11121     PL_doextract        = proto_perl->Idoextract;
11122     PL_sawampersand     = proto_perl->Isawampersand;
11123     PL_unsafe           = proto_perl->Iunsafe;
11124     PL_inplace          = SAVEPV(proto_perl->Iinplace);
11125     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
11126     PL_perldb           = proto_perl->Iperldb;
11127     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11128     PL_exit_flags       = proto_perl->Iexit_flags;
11129
11130     /* magical thingies */
11131     /* XXX time(&PL_basetime) when asked for? */
11132     PL_basetime         = proto_perl->Ibasetime;
11133     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
11134
11135     PL_maxsysfd         = proto_perl->Imaxsysfd;
11136     PL_statusvalue      = proto_perl->Istatusvalue;
11137 #ifdef VMS
11138     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
11139 #else
11140     PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11141 #endif
11142     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
11143
11144     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
11145     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
11146     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
11147
11148    
11149     /* RE engine related */
11150     Zero(&PL_reg_state, 1, struct re_save_state);
11151     PL_reginterp_cnt    = 0;
11152     PL_regmatch_slab    = NULL;
11153     
11154     /* Clone the regex array */
11155     PL_regex_padav = newAV();
11156     {
11157         const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11158         SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11159         IV i;
11160         av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11161         for(i = 1; i <= len; i++) {
11162             const SV * const regex = regexen[i];
11163             SV * const sv =
11164                 SvREPADTMP(regex)
11165                     ? sv_dup_inc(regex, param)
11166                     : SvREFCNT_inc(
11167                         newSViv(PTR2IV(CALLREGDUPE(
11168                                 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11169                 ;
11170             if (SvFLAGS(regex) & SVf_BREAK)
11171                 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11172             av_push(PL_regex_padav, sv);
11173         }
11174     }
11175     PL_regex_pad = AvARRAY(PL_regex_padav);
11176
11177     /* shortcuts to various I/O objects */
11178     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
11179     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
11180     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
11181     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
11182     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
11183     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
11184
11185     /* shortcuts to regexp stuff */
11186     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
11187
11188     /* shortcuts to misc objects */
11189     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
11190
11191     /* shortcuts to debugging objects */
11192     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
11193     PL_DBline           = gv_dup(proto_perl->IDBline, param);
11194     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
11195     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
11196     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
11197     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
11198     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
11199
11200     /* symbol tables */
11201     PL_defstash         = hv_dup_inc(proto_perl->Idefstash, param);
11202     PL_curstash         = hv_dup(proto_perl->Icurstash, param);
11203     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
11204     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
11205     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
11206
11207     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
11208     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
11209     PL_checkav_save     = av_dup_inc(proto_perl->Icheckav_save, param);
11210     PL_unitcheckav      = av_dup_inc(proto_perl->Iunitcheckav, param);
11211     PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11212     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
11213     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
11214     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
11215
11216     PL_sub_generation   = proto_perl->Isub_generation;
11217     PL_isarev           = hv_dup_inc(proto_perl->Iisarev, param);
11218
11219     /* funky return mechanisms */
11220     PL_forkprocess      = proto_perl->Iforkprocess;
11221
11222     /* subprocess state */
11223     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
11224
11225     /* internal state */
11226     PL_maxo             = proto_perl->Imaxo;
11227     if (proto_perl->Iop_mask)
11228         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11229     else
11230         PL_op_mask      = NULL;
11231     /* PL_asserting        = proto_perl->Iasserting; */
11232
11233     /* current interpreter roots */
11234     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
11235     OP_REFCNT_LOCK;
11236     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
11237     OP_REFCNT_UNLOCK;
11238     PL_main_start       = proto_perl->Imain_start;
11239     PL_eval_root        = proto_perl->Ieval_root;
11240     PL_eval_start       = proto_perl->Ieval_start;
11241
11242     /* runtime control stuff */
11243     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11244
11245     PL_filemode         = proto_perl->Ifilemode;
11246     PL_lastfd           = proto_perl->Ilastfd;
11247     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
11248     PL_Argv             = NULL;
11249     PL_Cmd              = NULL;
11250     PL_gensym           = proto_perl->Igensym;
11251     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
11252     PL_laststatval      = proto_perl->Ilaststatval;
11253     PL_laststype        = proto_perl->Ilaststype;
11254     PL_mess_sv          = NULL;
11255
11256     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
11257
11258     /* interpreter atexit processing */
11259     PL_exitlistlen      = proto_perl->Iexitlistlen;
11260     if (PL_exitlistlen) {
11261         Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11262         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11263     }
11264     else
11265         PL_exitlist     = (PerlExitListEntry*)NULL;
11266
11267     PL_my_cxt_size = proto_perl->Imy_cxt_size;
11268     if (PL_my_cxt_size) {
11269         Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11270         Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11271 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11272         Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11273         Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11274 #endif
11275     }
11276     else {
11277         PL_my_cxt_list  = (void**)NULL;
11278 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11279         PL_my_cxt_keys  = (const char**)NULL;
11280 #endif
11281     }
11282     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
11283     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
11284     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11285
11286     PL_profiledata      = NULL;
11287
11288     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
11289
11290     PAD_CLONE_VARS(proto_perl, param);
11291
11292 #ifdef HAVE_INTERP_INTERN
11293     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11294 #endif
11295
11296     /* more statics moved here */
11297     PL_generation       = proto_perl->Igeneration;
11298     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
11299
11300     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
11301     PL_in_clean_all     = proto_perl->Iin_clean_all;
11302
11303     PL_uid              = proto_perl->Iuid;
11304     PL_euid             = proto_perl->Ieuid;
11305     PL_gid              = proto_perl->Igid;
11306     PL_egid             = proto_perl->Iegid;
11307     PL_nomemok          = proto_perl->Inomemok;
11308     PL_an               = proto_perl->Ian;
11309     PL_evalseq          = proto_perl->Ievalseq;
11310     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
11311     PL_origalen         = proto_perl->Iorigalen;
11312 #ifdef PERL_USES_PL_PIDSTATUS
11313     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
11314 #endif
11315     PL_osname           = SAVEPV(proto_perl->Iosname);
11316     PL_sighandlerp      = proto_perl->Isighandlerp;
11317
11318     PL_runops           = proto_perl->Irunops;
11319
11320     PL_parser           = parser_dup(proto_perl->Iparser, param);
11321
11322     PL_subline          = proto_perl->Isubline;
11323     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
11324
11325 #ifdef FCRYPT
11326     PL_cryptseen        = proto_perl->Icryptseen;
11327 #endif
11328
11329     PL_hints            = proto_perl->Ihints;
11330
11331     PL_amagic_generation        = proto_perl->Iamagic_generation;
11332
11333 #ifdef USE_LOCALE_COLLATE
11334     PL_collation_ix     = proto_perl->Icollation_ix;
11335     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
11336     PL_collation_standard       = proto_perl->Icollation_standard;
11337     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
11338     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
11339 #endif /* USE_LOCALE_COLLATE */
11340
11341 #ifdef USE_LOCALE_NUMERIC
11342     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
11343     PL_numeric_standard = proto_perl->Inumeric_standard;
11344     PL_numeric_local    = proto_perl->Inumeric_local;
11345     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11346 #endif /* !USE_LOCALE_NUMERIC */
11347
11348     /* utf8 character classes */
11349     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11350     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11351     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11352     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11353     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
11354     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11355     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
11356     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
11357     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
11358     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
11359     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
11360     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
11361     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11362     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
11363     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11364     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11365     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11366     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11367     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11368     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11369
11370     /* Did the locale setup indicate UTF-8? */
11371     PL_utf8locale       = proto_perl->Iutf8locale;
11372     /* Unicode features (see perlrun/-C) */
11373     PL_unicode          = proto_perl->Iunicode;
11374
11375     /* Pre-5.8 signals control */
11376     PL_signals          = proto_perl->Isignals;
11377
11378     /* times() ticks per second */
11379     PL_clocktick        = proto_perl->Iclocktick;
11380
11381     /* Recursion stopper for PerlIO_find_layer */
11382     PL_in_load_module   = proto_perl->Iin_load_module;
11383
11384     /* sort() routine */
11385     PL_sort_RealCmp     = proto_perl->Isort_RealCmp;
11386
11387     /* Not really needed/useful since the reenrant_retint is "volatile",
11388      * but do it for consistency's sake. */
11389     PL_reentrant_retint = proto_perl->Ireentrant_retint;
11390
11391     /* Hooks to shared SVs and locks. */
11392     PL_sharehook        = proto_perl->Isharehook;
11393     PL_lockhook         = proto_perl->Ilockhook;
11394     PL_unlockhook       = proto_perl->Iunlockhook;
11395     PL_threadhook       = proto_perl->Ithreadhook;
11396     PL_destroyhook      = proto_perl->Idestroyhook;
11397
11398 #ifdef THREADS_HAVE_PIDS
11399     PL_ppid             = proto_perl->Ippid;
11400 #endif
11401
11402     /* swatch cache */
11403     PL_last_swash_hv    = NULL; /* reinits on demand */
11404     PL_last_swash_klen  = 0;
11405     PL_last_swash_key[0]= '\0';
11406     PL_last_swash_tmps  = (U8*)NULL;
11407     PL_last_swash_slen  = 0;
11408
11409     PL_glob_index       = proto_perl->Iglob_index;
11410     PL_srand_called     = proto_perl->Isrand_called;
11411     PL_bitcount         = NULL; /* reinits on demand */
11412
11413     if (proto_perl->Ipsig_pend) {
11414         Newxz(PL_psig_pend, SIG_SIZE, int);
11415     }
11416     else {
11417         PL_psig_pend    = (int*)NULL;
11418     }
11419
11420     if (proto_perl->Ipsig_ptr) {
11421         Newxz(PL_psig_ptr,  SIG_SIZE, SV*);
11422         Newxz(PL_psig_name, SIG_SIZE, SV*);
11423         for (i = 1; i < SIG_SIZE; i++) {
11424             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11425             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11426         }
11427     }
11428     else {
11429         PL_psig_ptr     = (SV**)NULL;
11430         PL_psig_name    = (SV**)NULL;
11431     }
11432
11433     /* intrpvar.h stuff */
11434
11435     if (flags & CLONEf_COPY_STACKS) {
11436         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11437         PL_tmps_ix              = proto_perl->Itmps_ix;
11438         PL_tmps_max             = proto_perl->Itmps_max;
11439         PL_tmps_floor           = proto_perl->Itmps_floor;
11440         Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11441         i = 0;
11442         while (i <= PL_tmps_ix) {
11443             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11444             ++i;
11445         }
11446
11447         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11448         i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11449         Newxz(PL_markstack, i, I32);
11450         PL_markstack_max        = PL_markstack + (proto_perl->Imarkstack_max
11451                                                   - proto_perl->Imarkstack);
11452         PL_markstack_ptr        = PL_markstack + (proto_perl->Imarkstack_ptr
11453                                                   - proto_perl->Imarkstack);
11454         Copy(proto_perl->Imarkstack, PL_markstack,
11455              PL_markstack_ptr - PL_markstack + 1, I32);
11456
11457         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11458          * NOTE: unlike the others! */
11459         PL_scopestack_ix        = proto_perl->Iscopestack_ix;
11460         PL_scopestack_max       = proto_perl->Iscopestack_max;
11461         Newxz(PL_scopestack, PL_scopestack_max, I32);
11462         Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11463
11464         /* NOTE: si_dup() looks at PL_markstack */
11465         PL_curstackinfo         = si_dup(proto_perl->Icurstackinfo, param);
11466
11467         /* PL_curstack          = PL_curstackinfo->si_stack; */
11468         PL_curstack             = av_dup(proto_perl->Icurstack, param);
11469         PL_mainstack            = av_dup(proto_perl->Imainstack, param);
11470
11471         /* next PUSHs() etc. set *(PL_stack_sp+1) */
11472         PL_stack_base           = AvARRAY(PL_curstack);
11473         PL_stack_sp             = PL_stack_base + (proto_perl->Istack_sp
11474                                                    - proto_perl->Istack_base);
11475         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
11476
11477         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11478          * NOTE: unlike the others! */
11479         PL_savestack_ix         = proto_perl->Isavestack_ix;
11480         PL_savestack_max        = proto_perl->Isavestack_max;
11481         /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11482         PL_savestack            = ss_dup(proto_perl, param);
11483     }
11484     else {
11485         init_stacks();
11486         ENTER;                  /* perl_destruct() wants to LEAVE; */
11487
11488         /* although we're not duplicating the tmps stack, we should still
11489          * add entries for any SVs on the tmps stack that got cloned by a
11490          * non-refcount means (eg a temp in @_); otherwise they will be
11491          * orphaned
11492          */
11493         for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11494             SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11495                     proto_perl->Itmps_stack[i]);
11496             if (nsv && !SvREFCNT(nsv)) {
11497                 EXTEND_MORTAL(1);
11498                 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11499             }
11500         }
11501     }
11502
11503     PL_start_env        = proto_perl->Istart_env;       /* XXXXXX */
11504     PL_top_env          = &PL_start_env;
11505
11506     PL_op               = proto_perl->Iop;
11507
11508     PL_Sv               = NULL;
11509     PL_Xpv              = (XPV*)NULL;
11510     my_perl->Ina        = proto_perl->Ina;
11511
11512     PL_statbuf          = proto_perl->Istatbuf;
11513     PL_statcache        = proto_perl->Istatcache;
11514     PL_statgv           = gv_dup(proto_perl->Istatgv, param);
11515     PL_statname         = sv_dup_inc(proto_perl->Istatname, param);
11516 #ifdef HAS_TIMES
11517     PL_timesbuf         = proto_perl->Itimesbuf;
11518 #endif
11519
11520     PL_tainted          = proto_perl->Itainted;
11521     PL_curpm            = proto_perl->Icurpm;   /* XXX No PMOP ref count */
11522     PL_rs               = sv_dup_inc(proto_perl->Irs, param);
11523     PL_last_in_gv       = gv_dup(proto_perl->Ilast_in_gv, param);
11524     PL_ofs_sv           = sv_dup_inc(proto_perl->Iofs_sv, param);
11525     PL_defoutgv         = gv_dup_inc(proto_perl->Idefoutgv, param);
11526     PL_chopset          = proto_perl->Ichopset; /* XXX never deallocated */
11527     PL_toptarget        = sv_dup_inc(proto_perl->Itoptarget, param);
11528     PL_bodytarget       = sv_dup_inc(proto_perl->Ibodytarget, param);
11529     PL_formtarget       = sv_dup(proto_perl->Iformtarget, param);
11530
11531     PL_restartop        = proto_perl->Irestartop;
11532     PL_in_eval          = proto_perl->Iin_eval;
11533     PL_delaymagic       = proto_perl->Idelaymagic;
11534     PL_dirty            = proto_perl->Idirty;
11535     PL_localizing       = proto_perl->Ilocalizing;
11536
11537     PL_errors           = sv_dup_inc(proto_perl->Ierrors, param);
11538     PL_hv_fetch_ent_mh  = NULL;
11539     PL_modcount         = proto_perl->Imodcount;
11540     PL_lastgotoprobe    = NULL;
11541     PL_dumpindent       = proto_perl->Idumpindent;
11542
11543     PL_sortcop          = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11544     PL_sortstash        = hv_dup(proto_perl->Isortstash, param);
11545     PL_firstgv          = gv_dup(proto_perl->Ifirstgv, param);
11546     PL_secondgv         = gv_dup(proto_perl->Isecondgv, param);
11547     PL_efloatbuf        = NULL;         /* reinits on demand */
11548     PL_efloatsize       = 0;                    /* reinits on demand */
11549
11550     /* regex stuff */
11551
11552     PL_screamfirst      = NULL;
11553     PL_screamnext       = NULL;
11554     PL_maxscream        = -1;                   /* reinits on demand */
11555     PL_lastscream       = NULL;
11556
11557
11558     PL_regdummy         = proto_perl->Iregdummy;
11559     PL_colorset         = 0;            /* reinits PL_colors[] */
11560     /*PL_colors[6]      = {0,0,0,0,0,0};*/
11561
11562
11563
11564     /* Pluggable optimizer */
11565     PL_peepp            = proto_perl->Ipeepp;
11566
11567     PL_stashcache       = newHV();
11568
11569     PL_watchaddr        = (char **) ptr_table_fetch(PL_ptr_table,
11570                                             proto_perl->Iwatchaddr);
11571     PL_watchok          = PL_watchaddr ? * PL_watchaddr : NULL;
11572     if (PL_debug && PL_watchaddr) {
11573         PerlIO_printf(Perl_debug_log,
11574           "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11575           PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11576           PTR2UV(PL_watchok));
11577     }
11578
11579     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11580         ptr_table_free(PL_ptr_table);
11581         PL_ptr_table = NULL;
11582     }
11583
11584     /* Call the ->CLONE method, if it exists, for each of the stashes
11585        identified by sv_dup() above.
11586     */
11587     while(av_len(param->stashes) != -1) {
11588         HV* const stash = (HV*) av_shift(param->stashes);
11589         GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11590         if (cloner && GvCV(cloner)) {
11591             dSP;
11592             ENTER;
11593             SAVETMPS;
11594             PUSHMARK(SP);
11595             XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11596             PUTBACK;
11597             call_sv((SV*)GvCV(cloner), G_DISCARD);
11598             FREETMPS;
11599             LEAVE;
11600         }
11601     }
11602
11603     SvREFCNT_dec(param->stashes);
11604
11605     /* orphaned? eg threads->new inside BEGIN or use */
11606     if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11607         SvREFCNT_inc_simple_void(PL_compcv);
11608         SAVEFREESV(PL_compcv);
11609     }
11610
11611     return my_perl;
11612 }
11613
11614 #endif /* USE_ITHREADS */
11615
11616 /*
11617 =head1 Unicode Support
11618
11619 =for apidoc sv_recode_to_utf8
11620
11621 The encoding is assumed to be an Encode object, on entry the PV
11622 of the sv is assumed to be octets in that encoding, and the sv
11623 will be converted into Unicode (and UTF-8).
11624
11625 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11626 is not a reference, nothing is done to the sv.  If the encoding is not
11627 an C<Encode::XS> Encoding object, bad things will happen.
11628 (See F<lib/encoding.pm> and L<Encode>).
11629
11630 The PV of the sv is returned.
11631
11632 =cut */
11633
11634 char *
11635 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11636 {
11637     dVAR;
11638     if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11639         SV *uni;
11640         STRLEN len;
11641         const char *s;
11642         dSP;
11643         ENTER;
11644         SAVETMPS;
11645         save_re_context();
11646         PUSHMARK(sp);
11647         EXTEND(SP, 3);
11648         XPUSHs(encoding);
11649         XPUSHs(sv);
11650 /*
11651   NI-S 2002/07/09
11652   Passing sv_yes is wrong - it needs to be or'ed set of constants
11653   for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11654   remove converted chars from source.
11655
11656   Both will default the value - let them.
11657
11658         XPUSHs(&PL_sv_yes);
11659 */
11660         PUTBACK;
11661         call_method("decode", G_SCALAR);
11662         SPAGAIN;
11663         uni = POPs;
11664         PUTBACK;
11665         s = SvPV_const(uni, len);
11666         if (s != SvPVX_const(sv)) {
11667             SvGROW(sv, len + 1);
11668             Move(s, SvPVX(sv), len + 1, char);
11669             SvCUR_set(sv, len);
11670         }
11671         FREETMPS;
11672         LEAVE;
11673         SvUTF8_on(sv);
11674         return SvPVX(sv);
11675     }
11676     return SvPOKp(sv) ? SvPVX(sv) : NULL;
11677 }
11678
11679 /*
11680 =for apidoc sv_cat_decode
11681
11682 The encoding is assumed to be an Encode object, the PV of the ssv is
11683 assumed to be octets in that encoding and decoding the input starts
11684 from the position which (PV + *offset) pointed to.  The dsv will be
11685 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
11686 when the string tstr appears in decoding output or the input ends on
11687 the PV of the ssv. The value which the offset points will be modified
11688 to the last input position on the ssv.
11689
11690 Returns TRUE if the terminator was found, else returns FALSE.
11691
11692 =cut */
11693
11694 bool
11695 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11696                    SV *ssv, int *offset, char *tstr, int tlen)
11697 {
11698     dVAR;
11699     bool ret = FALSE;
11700     if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11701         SV *offsv;
11702         dSP;
11703         ENTER;
11704         SAVETMPS;
11705         save_re_context();
11706         PUSHMARK(sp);
11707         EXTEND(SP, 6);
11708         XPUSHs(encoding);
11709         XPUSHs(dsv);
11710         XPUSHs(ssv);
11711         XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11712         XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11713         PUTBACK;
11714         call_method("cat_decode", G_SCALAR);
11715         SPAGAIN;
11716         ret = SvTRUE(TOPs);
11717         *offset = SvIV(offsv);
11718         PUTBACK;
11719         FREETMPS;
11720         LEAVE;
11721     }
11722     else
11723         Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11724     return ret;
11725
11726 }
11727
11728 /* ---------------------------------------------------------------------
11729  *
11730  * support functions for report_uninit()
11731  */
11732
11733 /* the maxiumum size of array or hash where we will scan looking
11734  * for the undefined element that triggered the warning */
11735
11736 #define FUV_MAX_SEARCH_SIZE 1000
11737
11738 /* Look for an entry in the hash whose value has the same SV as val;
11739  * If so, return a mortal copy of the key. */
11740
11741 STATIC SV*
11742 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11743 {
11744     dVAR;
11745     register HE **array;
11746     I32 i;
11747
11748     if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11749                         (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11750         return NULL;
11751
11752     array = HvARRAY(hv);
11753
11754     for (i=HvMAX(hv); i>0; i--) {
11755         register HE *entry;
11756         for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11757             if (HeVAL(entry) != val)
11758                 continue;
11759             if (    HeVAL(entry) == &PL_sv_undef ||
11760                     HeVAL(entry) == &PL_sv_placeholder)
11761                 continue;
11762             if (!HeKEY(entry))
11763                 return NULL;
11764             if (HeKLEN(entry) == HEf_SVKEY)
11765                 return sv_mortalcopy(HeKEY_sv(entry));
11766             return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11767         }
11768     }
11769     return NULL;
11770 }
11771
11772 /* Look for an entry in the array whose value has the same SV as val;
11773  * If so, return the index, otherwise return -1. */
11774
11775 STATIC I32
11776 S_find_array_subscript(pTHX_ AV *av, SV* val)
11777 {
11778     dVAR;
11779     if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11780                         (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11781         return -1;
11782
11783     if (val != &PL_sv_undef) {
11784         SV ** const svp = AvARRAY(av);
11785         I32 i;
11786
11787         for (i=AvFILLp(av); i>=0; i--)
11788             if (svp[i] == val)
11789                 return i;
11790     }
11791     return -1;
11792 }
11793
11794 /* S_varname(): return the name of a variable, optionally with a subscript.
11795  * If gv is non-zero, use the name of that global, along with gvtype (one
11796  * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11797  * targ.  Depending on the value of the subscript_type flag, return:
11798  */
11799
11800 #define FUV_SUBSCRIPT_NONE      1       /* "@foo"          */
11801 #define FUV_SUBSCRIPT_ARRAY     2       /* "$foo[aindex]"  */
11802 #define FUV_SUBSCRIPT_HASH      3       /* "$foo{keyname}" */
11803 #define FUV_SUBSCRIPT_WITHIN    4       /* "within @foo"   */
11804
11805 STATIC SV*
11806 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11807         SV* keyname, I32 aindex, int subscript_type)
11808 {
11809
11810     SV * const name = sv_newmortal();
11811     if (gv) {
11812         char buffer[2];
11813         buffer[0] = gvtype;
11814         buffer[1] = 0;
11815
11816         /* as gv_fullname4(), but add literal '^' for $^FOO names  */
11817
11818         gv_fullname4(name, gv, buffer, 0);
11819
11820         if ((unsigned int)SvPVX(name)[1] <= 26) {
11821             buffer[0] = '^';
11822             buffer[1] = SvPVX(name)[1] + 'A' - 1;
11823
11824             /* Swap the 1 unprintable control character for the 2 byte pretty
11825                version - ie substr($name, 1, 1) = $buffer; */
11826             sv_insert(name, 1, 1, buffer, 2);
11827         }
11828     }
11829     else {
11830         CV * const cv = find_runcv(NULL);
11831         SV *sv;
11832         AV *av;
11833
11834         if (!cv || !CvPADLIST(cv))
11835             return NULL;
11836         av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11837         sv = *av_fetch(av, targ, FALSE);
11838         sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11839     }
11840
11841     if (subscript_type == FUV_SUBSCRIPT_HASH) {
11842         SV * const sv = newSV(0);
11843         *SvPVX(name) = '$';
11844         Perl_sv_catpvf(aTHX_ name, "{%s}",
11845             pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11846         SvREFCNT_dec(sv);
11847     }
11848     else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11849         *SvPVX(name) = '$';
11850         Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11851     }
11852     else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11853         Perl_sv_insert(aTHX_ name, 0, 0,  STR_WITH_LEN("within "));
11854
11855     return name;
11856 }
11857
11858
11859 /*
11860 =for apidoc find_uninit_var
11861
11862 Find the name of the undefined variable (if any) that caused the operator o
11863 to issue a "Use of uninitialized value" warning.
11864 If match is true, only return a name if it's value matches uninit_sv.
11865 So roughly speaking, if a unary operator (such as OP_COS) generates a
11866 warning, then following the direct child of the op may yield an
11867 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11868 other hand, with OP_ADD there are two branches to follow, so we only print
11869 the variable name if we get an exact match.
11870
11871 The name is returned as a mortal SV.
11872
11873 Assumes that PL_op is the op that originally triggered the error, and that
11874 PL_comppad/PL_curpad points to the currently executing pad.
11875
11876 =cut
11877 */
11878
11879 STATIC SV *
11880 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11881 {
11882     dVAR;
11883     SV *sv;
11884     AV *av;
11885     GV *gv;
11886     OP *o, *o2, *kid;
11887
11888     if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11889                             uninit_sv == &PL_sv_placeholder)))
11890         return NULL;
11891
11892     switch (obase->op_type) {
11893
11894     case OP_RV2AV:
11895     case OP_RV2HV:
11896     case OP_PADAV:
11897     case OP_PADHV:
11898       {
11899         const bool pad  = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11900         const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11901         I32 index = 0;
11902         SV *keysv = NULL;
11903         int subscript_type = FUV_SUBSCRIPT_WITHIN;
11904
11905         if (pad) { /* @lex, %lex */
11906             sv = PAD_SVl(obase->op_targ);
11907             gv = NULL;
11908         }
11909         else {
11910             if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11911             /* @global, %global */
11912                 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11913                 if (!gv)
11914                     break;
11915                 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11916             }
11917             else /* @{expr}, %{expr} */
11918                 return find_uninit_var(cUNOPx(obase)->op_first,
11919                                                     uninit_sv, match);
11920         }
11921
11922         /* attempt to find a match within the aggregate */
11923         if (hash) {
11924             keysv = find_hash_subscript((HV*)sv, uninit_sv);
11925             if (keysv)
11926                 subscript_type = FUV_SUBSCRIPT_HASH;
11927         }
11928         else {
11929             index = find_array_subscript((AV*)sv, uninit_sv);
11930             if (index >= 0)
11931                 subscript_type = FUV_SUBSCRIPT_ARRAY;
11932         }
11933
11934         if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11935             break;
11936
11937         return varname(gv, hash ? '%' : '@', obase->op_targ,
11938                                     keysv, index, subscript_type);
11939       }
11940
11941     case OP_PADSV:
11942         if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11943             break;
11944         return varname(NULL, '$', obase->op_targ,
11945                                     NULL, 0, FUV_SUBSCRIPT_NONE);
11946
11947     case OP_GVSV:
11948         gv = cGVOPx_gv(obase);
11949         if (!gv || (match && GvSV(gv) != uninit_sv))
11950             break;
11951         return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11952
11953     case OP_AELEMFAST:
11954         if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11955             if (match) {
11956                 SV **svp;
11957                 av = (AV*)PAD_SV(obase->op_targ);
11958                 if (!av || SvRMAGICAL(av))
11959                     break;
11960                 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11961                 if (!svp || *svp != uninit_sv)
11962                     break;
11963             }
11964             return varname(NULL, '$', obase->op_targ,
11965                     NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11966         }
11967         else {
11968             gv = cGVOPx_gv(obase);
11969             if (!gv)
11970                 break;
11971             if (match) {
11972                 SV **svp;
11973                 av = GvAV(gv);
11974                 if (!av || SvRMAGICAL(av))
11975                     break;
11976                 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11977                 if (!svp || *svp != uninit_sv)
11978                     break;
11979             }
11980             return varname(gv, '$', 0,
11981                     NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11982         }
11983         break;
11984
11985     case OP_EXISTS:
11986         o = cUNOPx(obase)->op_first;
11987         if (!o || o->op_type != OP_NULL ||
11988                 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11989             break;
11990         return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11991
11992     case OP_AELEM:
11993     case OP_HELEM:
11994         if (PL_op == obase)
11995             /* $a[uninit_expr] or $h{uninit_expr} */
11996             return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11997
11998         gv = NULL;
11999         o = cBINOPx(obase)->op_first;
12000         kid = cBINOPx(obase)->op_last;
12001
12002         /* get the av or hv, and optionally the gv */
12003         sv = NULL;
12004         if  (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12005             sv = PAD_SV(o->op_targ);
12006         }
12007         else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12008                 && cUNOPo->op_first->op_type == OP_GV)
12009         {
12010             gv = cGVOPx_gv(cUNOPo->op_first);
12011             if (!gv)
12012                 break;
12013             sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12014         }
12015         if (!sv)
12016             break;
12017
12018         if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12019             /* index is constant */
12020             if (match) {
12021                 if (SvMAGICAL(sv))
12022                     break;
12023                 if (obase->op_type == OP_HELEM) {
12024                     HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12025                     if (!he || HeVAL(he) != uninit_sv)
12026                         break;
12027                 }
12028                 else {
12029                     SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12030                     if (!svp || *svp != uninit_sv)
12031                         break;
12032                 }
12033             }
12034             if (obase->op_type == OP_HELEM)
12035                 return varname(gv, '%', o->op_targ,
12036                             cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12037             else
12038                 return varname(gv, '@', o->op_targ, NULL,
12039                             SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12040         }
12041         else  {
12042             /* index is an expression;
12043              * attempt to find a match within the aggregate */
12044             if (obase->op_type == OP_HELEM) {
12045                 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12046                 if (keysv)
12047                     return varname(gv, '%', o->op_targ,
12048                                                 keysv, 0, FUV_SUBSCRIPT_HASH);
12049             }
12050             else {
12051                 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12052                 if (index >= 0)
12053                     return varname(gv, '@', o->op_targ,
12054                                         NULL, index, FUV_SUBSCRIPT_ARRAY);
12055             }
12056             if (match)
12057                 break;
12058             return varname(gv,
12059                 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12060                 ? '@' : '%',
12061                 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12062         }
12063         break;
12064
12065     case OP_AASSIGN:
12066         /* only examine RHS */
12067         return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12068
12069     case OP_OPEN:
12070         o = cUNOPx(obase)->op_first;
12071         if (o->op_type == OP_PUSHMARK)
12072             o = o->op_sibling;
12073
12074         if (!o->op_sibling) {
12075             /* one-arg version of open is highly magical */
12076
12077             if (o->op_type == OP_GV) { /* open FOO; */
12078                 gv = cGVOPx_gv(o);
12079                 if (match && GvSV(gv) != uninit_sv)
12080                     break;
12081                 return varname(gv, '$', 0,
12082                             NULL, 0, FUV_SUBSCRIPT_NONE);
12083             }
12084             /* other possibilities not handled are:
12085              * open $x; or open my $x;  should return '${*$x}'
12086              * open expr;               should return '$'.expr ideally
12087              */
12088              break;
12089         }
12090         goto do_op;
12091
12092     /* ops where $_ may be an implicit arg */
12093     case OP_TRANS:
12094     case OP_SUBST:
12095     case OP_MATCH:
12096         if ( !(obase->op_flags & OPf_STACKED)) {
12097             if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12098                                  ? PAD_SVl(obase->op_targ)
12099                                  : DEFSV))
12100             {
12101                 sv = sv_newmortal();
12102                 sv_setpvn(sv, "$_", 2);
12103                 return sv;
12104             }
12105         }
12106         goto do_op;
12107
12108     case OP_PRTF:
12109     case OP_PRINT:
12110     case OP_SAY:
12111         /* skip filehandle as it can't produce 'undef' warning  */
12112         o = cUNOPx(obase)->op_first;
12113         if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12114             o = o->op_sibling->op_sibling;
12115         goto do_op2;
12116
12117
12118     case OP_RV2SV:
12119     case OP_CUSTOM:
12120         match = 1; /* XS or custom code could trigger random warnings */
12121         goto do_op;
12122
12123     case OP_ENTERSUB:
12124     case OP_GOTO:
12125         /* XXX tmp hack: these two may call an XS sub, and currently
12126           XS subs don't have a SUB entry on the context stack, so CV and
12127           pad determination goes wrong, and BAD things happen. So, just
12128           don't try to determine the value under those circumstances.
12129           Need a better fix at dome point. DAPM 11/2007 */
12130         break;
12131
12132     case OP_POS:
12133         /* def-ness of rval pos() is independent of the def-ness of its arg */
12134         if ( !(obase->op_flags & OPf_MOD))
12135             break;
12136
12137     case OP_SCHOMP:
12138     case OP_CHOMP:
12139         if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12140             return sv_2mortal(newSVpvs("${$/}"));
12141         /*FALLTHROUGH*/
12142
12143     default:
12144     do_op:
12145         if (!(obase->op_flags & OPf_KIDS))
12146             break;
12147         o = cUNOPx(obase)->op_first;
12148         
12149     do_op2:
12150         if (!o)
12151             break;
12152
12153         /* if all except one arg are constant, or have no side-effects,
12154          * or are optimized away, then it's unambiguous */
12155         o2 = NULL;
12156         for (kid=o; kid; kid = kid->op_sibling) {
12157             if (kid) {
12158                 const OPCODE type = kid->op_type;
12159                 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12160                   || (type == OP_NULL  && ! (kid->op_flags & OPf_KIDS))
12161                   || (type == OP_PUSHMARK)
12162                 )
12163                 continue;
12164             }
12165             if (o2) { /* more than one found */
12166                 o2 = NULL;
12167                 break;
12168             }
12169             o2 = kid;
12170         }
12171         if (o2)
12172             return find_uninit_var(o2, uninit_sv, match);
12173
12174         /* scan all args */
12175         while (o) {
12176             sv = find_uninit_var(o, uninit_sv, 1);
12177             if (sv)
12178                 return sv;
12179             o = o->op_sibling;
12180         }
12181         break;
12182     }
12183     return NULL;
12184 }
12185
12186
12187 /*
12188 =for apidoc report_uninit
12189
12190 Print appropriate "Use of uninitialized variable" warning
12191
12192 =cut
12193 */
12194
12195 void
12196 Perl_report_uninit(pTHX_ SV* uninit_sv)
12197 {
12198     dVAR;
12199     if (PL_op) {
12200         SV* varname = NULL;
12201         if (uninit_sv) {
12202             varname = find_uninit_var(PL_op, uninit_sv,0);
12203             if (varname)
12204                 sv_insert(varname, 0, 0, " ", 1);
12205         }
12206         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12207                 varname ? SvPV_nolen_const(varname) : "",
12208                 " in ", OP_DESC(PL_op));
12209     }
12210     else
12211         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12212                     "", "", "");
12213 }
12214
12215 /*
12216  * Local variables:
12217  * c-indentation-style: bsd
12218  * c-basic-offset: 4
12219  * indent-tabs-mode: t
12220  * End:
12221  *
12222  * ex: set ts=8 sts=4 sw=4 noet:
12223  */