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