use svtype
[perl.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 *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&nbs