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