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