Add DEBUG_LEAKING_SCALARS_ABORT, to call abort() if any scalars leak,
[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 *chunk, U32 chunk_size)
158 {
159     dVAR;
160     void *new_chunk;
161     U32 new_chunk_size;
162     new_chunk = (void *)(chunk);
163     new_chunk_size = (chunk_size);
164     if (new_chunk_size > PL_nice_chunk_size) {
165         Safefree(PL_nice_chunk);
166         PL_nice_chunk = (char *) new_chunk;
167         PL_nice_chunk_size = new_chunk_size;
168     } else {
169         Safefree(chunk);
170     }
171 }
172
173 #ifdef DEBUG_LEAKING_SCALARS
174 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
175 #else
176 #  define FREE_SV_DEBUG_FILE(sv)
177 #endif
178
179 #ifdef PERL_POISON
180 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
182    unreferenced scalars
183 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
184 */
185 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
186                                 PoisonNew(&SvREFCNT(sv), 1, U32)
187 #else
188 #  define SvARENA_CHAIN(sv)     SvANY(sv)
189 #  define POSION_SV_HEAD(sv)
190 #endif
191
192 #define plant_SV(p) \
193     STMT_START {                                        \
194         FREE_SV_DEBUG_FILE(p);                          \
195         POSION_SV_HEAD(p);                              \
196         SvARENA_CHAIN(p) = (void *)PL_sv_root;          \
197         SvFLAGS(p) = SVTYPEMASK;                        \
198         PL_sv_root = (p);                               \
199         --PL_sv_count;                                  \
200     } STMT_END
201
202 #define uproot_SV(p) \
203     STMT_START {                                        \
204         (p) = PL_sv_root;                               \
205         PL_sv_root = (SV*)SvARENA_CHAIN(p);             \
206         ++PL_sv_count;                                  \
207     } STMT_END
208
209
210 /* make some more SVs by adding another arena */
211
212 STATIC SV*
213 S_more_sv(pTHX)
214 {
215     dVAR;
216     SV* sv;
217
218     if (PL_nice_chunk) {
219         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220         PL_nice_chunk = NULL;
221         PL_nice_chunk_size = 0;
222     }
223     else {
224         char *chunk;                /* must use New here to match call to */
225         Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
226         sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
227     }
228     uproot_SV(sv);
229     return sv;
230 }
231
232 /* new_SV(): return a new, empty SV head */
233
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
236 STATIC SV*
237 S_new_SV(pTHX)
238 {
239     SV* sv;
240
241     if (PL_sv_root)
242         uproot_SV(sv);
243     else
244         sv = S_more_sv(aTHX);
245     SvANY(sv) = 0;
246     SvREFCNT(sv) = 1;
247     SvFLAGS(sv) = 0;
248     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249     sv->sv_debug_line = (U16) (PL_parser
250             ?  PL_parser->copline == NOLINE
251                 ?  PL_curcop
252                     ? CopLINE(PL_curcop)
253                     : 0
254                 : PL_parser->copline
255             : 0);
256     sv->sv_debug_inpad = 0;
257     sv->sv_debug_cloned = 0;
258     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
259     
260     return sv;
261 }
262 #  define new_SV(p) (p)=S_new_SV(aTHX)
263
264 #else
265 #  define new_SV(p) \
266     STMT_START {                                        \
267         if (PL_sv_root)                                 \
268             uproot_SV(p);                               \
269         else                                            \
270             (p) = S_more_sv(aTHX);                      \
271         SvANY(p) = 0;                                   \
272         SvREFCNT(p) = 1;                                \
273         SvFLAGS(p) = 0;                                 \
274     } STMT_END
275 #endif
276
277
278 /* del_SV(): return an empty SV head to the free list */
279
280 #ifdef DEBUGGING
281
282 #define del_SV(p) \
283     STMT_START {                                        \
284         if (DEBUG_D_TEST)                               \
285             del_sv(p);                                  \
286         else                                            \
287             plant_SV(p);                                \
288     } STMT_END
289
290 STATIC void
291 S_del_sv(pTHX_ SV *p)
292 {
293     dVAR;
294     if (DEBUG_D_TEST) {
295         SV* sva;
296         bool ok = 0;
297         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298             const SV * const sv = sva + 1;
299             const SV * const svend = &sva[SvREFCNT(sva)];
300             if (p >= sv && p < svend) {
301                 ok = 1;
302                 break;
303             }
304         }
305         if (!ok) {
306             if (ckWARN_d(WARN_INTERNAL))        
307                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308                             "Attempt to free non-arena SV: 0x%"UVxf
309                             pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
310             return;
311         }
312     }
313     plant_SV(p);
314 }
315
316 #else /* ! DEBUGGING */
317
318 #define del_SV(p)   plant_SV(p)
319
320 #endif /* DEBUGGING */
321
322
323 /*
324 =head1 SV Manipulation Functions
325
326 =for apidoc sv_add_arena
327
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
330
331 =cut
332 */
333
334 void
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
336 {
337     dVAR;
338     SV* const sva = (SV*)ptr;
339     register SV* sv;
340     register SV* svend;
341
342     /* The first SV in an arena isn't an SV. */
343     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
344     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
345     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
346
347     PL_sv_arenaroot = sva;
348     PL_sv_root = sva + 1;
349
350     svend = &sva[SvREFCNT(sva) - 1];
351     sv = sva + 1;
352     while (sv < svend) {
353         SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
354 #ifdef DEBUGGING
355         SvREFCNT(sv) = 0;
356 #endif
357         /* Must always set typemask because it's always checked in on cleanup
358            when the arenas are walked looking for objects.  */
359         SvFLAGS(sv) = SVTYPEMASK;
360         sv++;
361     }
362     SvARENA_CHAIN(sv) = 0;
363 #ifdef DEBUGGING
364     SvREFCNT(sv) = 0;
365 #endif
366     SvFLAGS(sv) = SVTYPEMASK;
367 }
368
369 /* visit(): call the named function for each non-free SV in the arenas
370  * whose flags field matches the flags/mask args. */
371
372 STATIC I32
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
374 {
375     dVAR;
376     SV* sva;
377     I32 visited = 0;
378
379     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380         register const SV * const svend = &sva[SvREFCNT(sva)];
381         register SV* sv;
382         for (sv = sva + 1; sv < svend; ++sv) {
383             if (SvTYPE(sv) != SVTYPEMASK
384                     && (sv->sv_flags & mask) == flags
385                     && SvREFCNT(sv))
386             {
387                 (FCALL)(aTHX_ sv);
388                 ++visited;
389             }
390         }
391     }
392     return visited;
393 }
394
395 #ifdef DEBUGGING
396
397 /* called by sv_report_used() for each live SV */
398
399 static void
400 do_report_used(pTHX_ SV *sv)
401 {
402     if (SvTYPE(sv) != SVTYPEMASK) {
403         PerlIO_printf(Perl_debug_log, "****\n");
404         sv_dump(sv);
405     }
406 }
407 #endif
408
409 /*
410 =for apidoc sv_report_used
411
412 Dump the contents of all SVs not yet freed. (Debugging aid).
413
414 =cut
415 */
416
417 void
418 Perl_sv_report_used(pTHX)
419 {
420 #ifdef DEBUGGING
421     visit(do_report_used, 0, 0);
422 #else
423     PERL_UNUSED_CONTEXT;
424 #endif
425 }
426
427 /* called by sv_clean_objs() for each live SV */
428
429 static void
430 do_clean_objs(pTHX_ SV *ref)
431 {
432     dVAR;
433     assert (SvROK(ref));
434     {
435         SV * const target = SvRV(ref);
436         if (SvOBJECT(target)) {
437             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438             if (SvWEAKREF(ref)) {
439                 sv_del_backref(target, ref);
440                 SvWEAKREF_off(ref);
441                 SvRV_set(ref, NULL);
442             } else {
443                 SvROK_off(ref);
444                 SvRV_set(ref, NULL);
445                 SvREFCNT_dec(target);
446             }
447         }
448     }
449
450     /* XXX Might want to check arrays, etc. */
451 }
452
453 /* called by sv_clean_objs() for each live SV */
454
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
456 static void
457 do_clean_named_objs(pTHX_ SV *sv)
458 {
459     dVAR;
460     assert(SvTYPE(sv) == SVt_PVGV);
461     assert(isGV_with_GP(sv));
462     if (GvGP(sv)) {
463         if ((
464 #ifdef PERL_DONT_CREATE_GVSV
465              GvSV(sv) &&
466 #endif
467              SvOBJECT(GvSV(sv))) ||
468              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470              /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471              (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
473         {
474             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475             SvFLAGS(sv) |= SVf_BREAK;
476             SvREFCNT_dec(sv);
477         }
478     }
479 }
480 #endif
481
482 /*
483 =for apidoc sv_clean_objs
484
485 Attempt to destroy all objects not yet freed
486
487 =cut
488 */
489
490 void
491 Perl_sv_clean_objs(pTHX)
492 {
493     dVAR;
494     PL_in_clean_objs = TRUE;
495     visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497     /* some barnacles may yet remain, clinging to typeglobs */
498     visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
499 #endif
500     PL_in_clean_objs = FALSE;
501 }
502
503 /* called by sv_clean_all() for each live SV */
504
505 static void
506 do_clean_all(pTHX_ SV *sv)
507 {
508     dVAR;
509     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510     SvFLAGS(sv) |= SVf_BREAK;
511     SvREFCNT_dec(sv);
512 }
513
514 /*
515 =for apidoc sv_clean_all
516
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
520
521 =cut
522 */
523
524 I32
525 Perl_sv_clean_all(pTHX)
526 {
527     dVAR;
528     I32 cleaned;
529     PL_in_clean_all = TRUE;
530     cleaned = visit(do_clean_all, 0,0);
531     PL_in_clean_all = FALSE;
532     return cleaned;
533 }
534
535 /*
536   ARENASETS: a meta-arena implementation which separates arena-info
537   into struct arena_set, which contains an array of struct
538   arena_descs, each holding info for a single arena.  By separating
539   the meta-info from the arena, we recover the 1st slot, formerly
540   borrowed for list management.  The arena_set is about the size of an
541   arena, avoiding the needless malloc overhead of a naive linked-list.
542
543   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544   memory in the last arena-set (1/2 on average).  In trade, we get
545   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546   smaller types).  The recovery of the wasted space allows use of
547   small arenas for large, rare body types, by changing array* fields
548   in body_details_by_type[] below.
549 */
550 struct arena_desc {
551     char       *arena;          /* the raw storage, allocated aligned */
552     size_t      size;           /* its size ~4k typ */
553     U32         misc;           /* type, and in future other things. */
554 };
555
556 struct arena_set;
557
558 /* Get the maximum number of elements in set[] such that struct arena_set
559    will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560    therefore likely to be 1 aligned memory page.  */
561
562 #define ARENAS_PER_SET  ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563                           - 2 * sizeof(int)) / sizeof (struct arena_desc))
564
565 struct arena_set {
566     struct arena_set* next;
567     unsigned int   set_size;    /* ie ARENAS_PER_SET */
568     unsigned int   curr;        /* index of next available arena-desc */
569     struct arena_desc set[ARENAS_PER_SET];
570 };
571
572 /*
573 =for apidoc sv_free_arenas
574
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
577
578 =cut
579 */
580 void
581 Perl_sv_free_arenas(pTHX)
582 {
583     dVAR;
584     SV* sva;
585     SV* svanext;
586     unsigned int i;
587
588     /* Free arenas here, but be careful about fake ones.  (We assume
589        contiguity of the fake ones with the corresponding real ones.) */
590
591     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592         svanext = (SV*) SvANY(sva);
593         while (svanext && SvFAKE(svanext))
594             svanext = (SV*) SvANY(svanext);
595
596         if (!SvFAKE(sva))
597             Safefree(sva);
598     }
599
600     {
601         struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
602
603         while (aroot) {
604             struct arena_set *current = aroot;
605             i = aroot->curr;
606             while (i--) {
607                 assert(aroot->set[i].arena);
608                 Safefree(aroot->set[i].arena);
609             }
610             aroot = aroot->next;
611             Safefree(current);
612         }
613     }
614     PL_body_arenas = 0;
615
616     i = PERL_ARENA_ROOTS_SIZE;
617     while (i--)
618         PL_body_roots[i] = 0;
619
620     Safefree(PL_nice_chunk);
621     PL_nice_chunk = NULL;
622     PL_nice_chunk_size = 0;
623     PL_sv_arenaroot = 0;
624     PL_sv_root = 0;
625 }
626
627 /*
628   Here are mid-level routines that manage the allocation of bodies out
629   of the various arenas.  There are 5 kinds of arenas:
630
631   1. SV-head arenas, which are discussed and handled above
632   2. regular body arenas
633   3. arenas for reduced-size bodies
634   4. Hash-Entry arenas
635   5. pte arenas (thread related)
636
637   Arena types 2 & 3 are chained by body-type off an array of
638   arena-root pointers, which is indexed by svtype.  Some of the
639   larger/less used body types are malloced singly, since a large
640   unused block of them is wasteful.  Also, several svtypes dont have
641   bodies; the data fits into the sv-head itself.  The arena-root
642   pointer thus has a few unused root-pointers (which may be hijacked
643   later for arena types 4,5)
644
645   3 differs from 2 as an optimization; some body types have several
646   unused fields in the front of the structure (which are kept in-place
647   for consistency).  These bodies can be allocated in smaller chunks,
648   because the leading fields arent accessed.  Pointers to such bodies
649   are decremented to point at the unused 'ghost' memory, knowing that
650   the pointers are used with offsets to the real memory.
651
652   HE, HEK arenas are managed separately, with separate code, but may
653   be merge-able later..
654
655   PTE arenas are not sv-bodies, but they share these mid-level
656   mechanics, so are considered here.  The new mid-level mechanics rely
657   on the sv_type of the body being allocated, so we just reserve one
658   of the unused body-slots for PTEs, then use it in those (2) PTE
659   contexts below (line ~10k)
660 */
661
662 /* get_arena(size): this creates custom-sized arenas
663    TBD: export properly for hv.c: S_more_he().
664 */
665 void*
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
667 {
668     dVAR;
669     struct arena_desc* adesc;
670     struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
671     unsigned int curr;
672
673     /* shouldnt need this
674     if (!arena_size)    arena_size = PERL_ARENA_SIZE;
675     */
676
677     /* may need new arena-set to hold new arena */
678     if (!aroot || aroot->curr >= aroot->set_size) {
679         struct arena_set *newroot;
680         Newxz(newroot, 1, struct arena_set);
681         newroot->set_size = ARENAS_PER_SET;
682         newroot->next = aroot;
683         aroot = newroot;
684         PL_body_arenas = (void *) newroot;
685         DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
686     }
687
688     /* ok, now have arena-set with at least 1 empty/available arena-desc */
689     curr = aroot->curr++;
690     adesc = &(aroot->set[curr]);
691     assert(!adesc->arena);
692     
693     Newx(adesc->arena, arena_size, char);
694     adesc->size = arena_size;
695     adesc->misc = misc;
696     DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n", 
697                           curr, (void*)adesc->arena, (UV)arena_size));
698
699     return adesc->arena;
700 }
701
702
703 /* return a thing to the free list */
704
705 #define del_body(thing, root)                   \
706     STMT_START {                                \
707         void ** const thing_copy = (void **)thing;\
708         *thing_copy = *root;                    \
709         *root = (void*)thing_copy;              \
710     } STMT_END
711
712 /* 
713
714 =head1 SV-Body Allocation
715
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
719 SV detection.
720
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type.  These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type.  Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
726
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist.  They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods.  The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
732
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure.  (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
740
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
747
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
752
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list.  Then the lock is released, and
757 the body is returned.
758
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list.  It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
763
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
766
767 */
768
769 /* 
770
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
773
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are.  PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
777
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena.  Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
781
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade().  The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven.  All fields
785 are used for this, except for arena_size.
786
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded.  In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
792 available in hv.c.
793
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics.  At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot.  This choice has no
799 consequence at this time.
800
801 */
802
803 struct body_details {
804     U8 body_size;       /* Size to allocate  */
805     U8 copy;            /* Size of structure to copy (may be shorter)  */
806     U8 offset;
807     unsigned int type : 4;          /* We have space for a sanity check.  */
808     unsigned int cant_upgrade : 1;  /* Cannot upgrade this type */
809     unsigned int zero_nv : 1;       /* zero the NV when upgrading from this */
810     unsigned int arena : 1;         /* Allocated from an arena */
811     size_t arena_size;              /* Size of arena to allocate */
812 };
813
814 #define HADNV FALSE
815 #define NONV TRUE
816
817
818 #ifdef PURIFY
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820    This seems a rather elegant way to simplify some of the code below.  */
821 #define HASARENA FALSE
822 #else
823 #define HASARENA TRUE
824 #endif
825 #define NOARENA FALSE
826
827 /* Size the arenas to exactly fit a given number of bodies.  A count
828    of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829    simplifying the default.  If count > 0, the arena is sized to fit
830    only that many bodies, allowing arenas to be used for large, rare
831    bodies (XPVFM, XPVIO) without undue waste.  The arena size is
832    limited by PERL_ARENA_SIZE, so we can safely oversize the
833    declarations.
834  */
835 #define FIT_ARENA0(body_size)                           \
836     ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size)                     \
838     ( count * body_size <= PERL_ARENA_SIZE)             \
839     ? count * body_size                                 \
840     : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size)                      \
842     count                                               \
843     ? FIT_ARENAn (count, body_size)                     \
844     : FIT_ARENA0 (body_size)
845
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
847
848 typedef struct {
849     STRLEN      xpv_cur;
850     STRLEN      xpv_len;
851 } xpv_allocated;
852
853 to make its members accessible via a pointer to (say)
854
855 struct xpv {
856     NV          xnv_nv;
857     STRLEN      xpv_cur;
858     STRLEN      xpv_len;
859 };
860
861 */
862
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864     (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
865
866 /* Calculate the length to copy. Specifically work out the length less any
867    final padding the compiler needed to add.  See the comment in sv_upgrade
868    for why copying the padding proved to be a bug.  */
869
870 #define copy_length(type, last_member) \
871         STRUCT_OFFSET(type, last_member) \
872         + sizeof (((type*)SvANY((SV*)0))->last_member)
873
874 static const struct body_details bodies_by_type[] = {
875     { sizeof(HE), 0, 0, SVt_NULL,
876       FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
877
878     /* The bind placeholder pretends to be an RV for now.
879        Also it's marked as "can't upgrade" to stop anyone using it before it's
880        implemented.  */
881     { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
882
883     /* IVs are in the head, so the allocation size is 0.
884        However, the slot is overloaded for PTEs.  */
885     { sizeof(struct ptr_tbl_ent), /* This is used for PTEs.  */
886       sizeof(IV), /* This is used to copy out the IV body.  */
887       STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888       NOARENA /* IVS don't need an arena  */,
889       /* But PTEs need to know the size of their arena  */
890       FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
891     },
892
893     /* 8 bytes on most ILP32 with IEEE doubles */
894     { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895       FIT_ARENA(0, sizeof(NV)) },
896
897     /* 8 bytes on most ILP32 with IEEE doubles */
898     { sizeof(xpv_allocated),
899       copy_length(XPV, xpv_len)
900       - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901       + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902       SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
903
904     /* 12 */
905     { sizeof(xpviv_allocated),
906       copy_length(XPVIV, xiv_u)
907       - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908       + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909       SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
910
911     /* 20 */
912     { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913       HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
914
915     /* 28 */
916     { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
918
919     /* something big */
920     { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
921       + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
922       SVt_REGEXP, FALSE, NONV, HASARENA,
923       FIT_ARENA(0, sizeof(struct regexp_allocated))
924     },
925
926     /* 48 */
927     { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
928       HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
929     
930     /* 64 */
931     { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932       HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
933
934     { sizeof(xpvav_allocated),
935       copy_length(XPVAV, xmg_stash)
936       - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
937       + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
938       SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
939
940     { sizeof(xpvhv_allocated),
941       copy_length(XPVHV, xmg_stash)
942       - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
943       + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
944       SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
945
946     /* 56 */
947     { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
948       + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
949       SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
950
951     { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
952       + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
953       SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
954
955     /* XPVIO is 84 bytes, fits 48x */
956     { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
957       HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
958 };
959
960 #define new_body_type(sv_type)          \
961     (void *)((char *)S_new_body(aTHX_ sv_type))
962
963 #define del_body_type(p, sv_type)       \
964     del_body(p, &PL_body_roots[sv_type])
965
966
967 #define new_body_allocated(sv_type)             \
968     (void *)((char *)S_new_body(aTHX_ sv_type)  \
969              - bodies_by_type[sv_type].offset)
970
971 #define del_body_allocated(p, sv_type)          \
972     del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
973
974
975 #define my_safemalloc(s)        (void*)safemalloc(s)
976 #define my_safecalloc(s)        (void*)safecalloc(s, 1)
977 #define my_safefree(p)  safefree((char*)p)
978
979 #ifdef PURIFY
980
981 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
982 #define del_XNV(p)      my_safefree(p)
983
984 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
985 #define del_XPVNV(p)    my_safefree(p)
986
987 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
988 #define del_XPVAV(p)    my_safefree(p)
989
990 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
991 #define del_XPVHV(p)    my_safefree(p)
992
993 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
994 #define del_XPVMG(p)    my_safefree(p)
995
996 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
997 #define del_XPVGV(p)    my_safefree(p)
998
999 #else /* !PURIFY */
1000
1001 #define new_XNV()       new_body_type(SVt_NV)
1002 #define del_XNV(p)      del_body_type(p, SVt_NV)
1003
1004 #define new_XPVNV()     new_body_type(SVt_PVNV)
1005 #define del_XPVNV(p)    del_body_type(p, SVt_PVNV)
1006
1007 #define new_XPVAV()     new_body_allocated(SVt_PVAV)
1008 #define del_XPVAV(p)    del_body_allocated(p, SVt_PVAV)
1009
1010 #define new_XPVHV()     new_body_allocated(SVt_PVHV)
1011 #define del_XPVHV(p)    del_body_allocated(p, SVt_PVHV)
1012
1013 #define new_XPVMG()     new_body_type(SVt_PVMG)
1014 #define del_XPVMG(p)    del_body_type(p, SVt_PVMG)
1015
1016 #define new_XPVGV()     new_body_type(SVt_PVGV)
1017 #define del_XPVGV(p)    del_body_type(p, SVt_PVGV)
1018
1019 #endif /* PURIFY */
1020
1021 /* no arena for you! */
1022
1023 #define new_NOARENA(details) \
1024         my_safemalloc((details)->body_size + (details)->offset)
1025 #define new_NOARENAZ(details) \
1026         my_safecalloc((details)->body_size + (details)->offset)
1027
1028 STATIC void *
1029 S_more_bodies (pTHX_ svtype sv_type)
1030 {
1031     dVAR;
1032     void ** const root = &PL_body_roots[sv_type];
1033     const struct body_details * const bdp = &bodies_by_type[sv_type];
1034     const size_t body_size = bdp->body_size;
1035     char *start;
1036     const char *end;
1037 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1038     static bool done_sanity_check;
1039
1040     /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1041      * variables like done_sanity_check. */
1042     if (!done_sanity_check) {
1043         unsigned int i = SVt_LAST;
1044
1045         done_sanity_check = TRUE;
1046
1047         while (i--)
1048             assert (bodies_by_type[i].type == i);
1049     }
1050 #endif
1051
1052     assert(bdp->arena_size);
1053
1054     start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1055
1056     end = start + bdp->arena_size - body_size;
1057
1058     /* computed count doesnt reflect the 1st slot reservation */
1059     DEBUG_m(PerlIO_printf(Perl_debug_log,
1060                           "arena %p end %p arena-size %d type %d size %d ct %d\n",
1061                           (void*)start, (void*)end,
1062                           (int)bdp->arena_size, sv_type, (int)body_size,
1063                           (int)bdp->arena_size / (int)body_size));
1064
1065     *root = (void *)start;
1066
1067     while (start < end) {
1068         char * const next = start + body_size;
1069         *(void**) start = (void *)next;
1070         start = next;
1071     }
1072     *(void **)start = 0;
1073
1074     return *root;
1075 }
1076
1077 /* grab a new thing from the free list, allocating more if necessary.
1078    The inline version is used for speed in hot routines, and the
1079    function using it serves the rest (unless PURIFY).
1080 */
1081 #define new_body_inline(xpv, sv_type) \
1082     STMT_START { \
1083         void ** const r3wt = &PL_body_roots[sv_type]; \
1084         xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt))      \
1085           ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1086         *(r3wt) = *(void**)(xpv); \
1087     } STMT_END
1088
1089 #ifndef PURIFY
1090
1091 STATIC void *
1092 S_new_body(pTHX_ svtype sv_type)
1093 {
1094     dVAR;
1095     void *xpv;
1096     new_body_inline(xpv, sv_type);
1097     return xpv;
1098 }
1099
1100 #endif
1101
1102 static const struct body_details fake_rv =
1103     { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1104
1105 /*
1106 =for apidoc sv_upgrade
1107
1108 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1109 SV, then copies across as much information as possible from the old body.
1110 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1111
1112 =cut
1113 */
1114
1115 void
1116 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1117 {
1118     dVAR;
1119     void*       old_body;
1120     void*       new_body;
1121     const svtype old_type = SvTYPE(sv);
1122     const struct body_details *new_type_details;
1123     const struct body_details *old_type_details
1124         = bodies_by_type + old_type;
1125     SV *referant = NULL;
1126
1127     if (new_type != SVt_PV && SvIsCOW(sv)) {
1128         sv_force_normal_flags(sv, 0);
1129     }
1130
1131     if (old_type == new_type)
1132         return;
1133
1134     old_body = SvANY(sv);
1135
1136     /* Copying structures onto other structures that have been neatly zeroed
1137        has a subtle gotcha. Consider XPVMG
1138
1139        +------+------+------+------+------+-------+-------+
1140        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |
1141        +------+------+------+------+------+-------+-------+
1142        0      4      8     12     16     20      24      28
1143
1144        where NVs are aligned to 8 bytes, so that sizeof that structure is
1145        actually 32 bytes long, with 4 bytes of padding at the end:
1146
1147        +------+------+------+------+------+-------+-------+------+
1148        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH | ???  |
1149        +------+------+------+------+------+-------+-------+------+
1150        0      4      8     12     16     20      24      28     32
1151
1152        so what happens if you allocate memory for this structure:
1153
1154        +------+------+------+------+------+-------+-------+------+------+...
1155        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |  GP  | NAME |
1156        +------+------+------+------+------+-------+-------+------+------+...
1157        0      4      8     12     16     20      24      28     32     36
1158
1159        zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1160        expect, because you copy the area marked ??? onto GP. Now, ??? may have
1161        started out as zero once, but it's quite possible that it isn't. So now,
1162        rather than a nicely zeroed GP, you have it pointing somewhere random.
1163        Bugs ensue.
1164
1165        (In fact, GP ends up pointing at a previous GP structure, because the
1166        principle cause of the padding in XPVMG getting garbage is a copy of
1167        sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1168        this happens to be moot because XPVGV has been re-ordered, with GP
1169        no longer after STASH)
1170
1171        So we are careful and work out the size of used parts of all the
1172        structures.  */
1173
1174     switch (old_type) {
1175     case SVt_NULL:
1176         break;
1177     case SVt_IV:
1178         if (SvROK(sv)) {
1179             referant = SvRV(sv);
1180             old_type_details = &fake_rv;
1181             if (new_type == SVt_NV)
1182                 new_type = SVt_PVNV;
1183         } else {
1184             if (new_type < SVt_PVIV) {
1185                 new_type = (new_type == SVt_NV)
1186                     ? SVt_PVNV : SVt_PVIV;
1187             }
1188         }
1189         break;
1190     case SVt_NV:
1191         if (new_type < SVt_PVNV) {
1192             new_type = SVt_PVNV;
1193         }
1194         break;
1195     case SVt_PV:
1196         assert(new_type > SVt_PV);
1197         assert(SVt_IV < SVt_PV);
1198         assert(SVt_NV < SVt_PV);
1199         break;
1200     case SVt_PVIV:
1201         break;
1202     case SVt_PVNV:
1203         break;
1204     case SVt_PVMG:
1205         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1206            there's no way that it can be safely upgraded, because perl.c
1207            expects to Safefree(SvANY(PL_mess_sv))  */
1208         assert(sv != PL_mess_sv);
1209         /* This flag bit is used to mean other things in other scalar types.
1210            Given that it only has meaning inside the pad, it shouldn't be set
1211            on anything that can get upgraded.  */
1212         assert(!SvPAD_TYPED(sv));
1213         break;
1214     default:
1215         if (old_type_details->cant_upgrade)
1216             Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1217                        sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1218     }
1219
1220     if (old_type > new_type)
1221         Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1222                 (int)old_type, (int)new_type);
1223
1224     new_type_details = bodies_by_type + new_type;
1225
1226     SvFLAGS(sv) &= ~SVTYPEMASK;
1227     SvFLAGS(sv) |= new_type;
1228
1229     /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230        the return statements above will have triggered.  */
1231     assert (new_type != SVt_NULL);
1232     switch (new_type) {
1233     case SVt_IV:
1234         assert(old_type == SVt_NULL);
1235         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1236         SvIV_set(sv, 0);
1237         return;
1238     case SVt_NV:
1239         assert(old_type == SVt_NULL);
1240         SvANY(sv) = new_XNV();
1241         SvNV_set(sv, 0);
1242         return;
1243     case SVt_PVHV:
1244     case SVt_PVAV:
1245         assert(new_type_details->body_size);
1246
1247 #ifndef PURIFY  
1248         assert(new_type_details->arena);
1249         assert(new_type_details->arena_size);
1250         /* This points to the start of the allocated area.  */
1251         new_body_inline(new_body, new_type);
1252         Zero(new_body, new_type_details->body_size, char);
1253         new_body = ((char *)new_body) - new_type_details->offset;
1254 #else
1255         /* We always allocated the full length item with PURIFY. To do this
1256            we fake things so that arena is false for all 16 types..  */
1257         new_body = new_NOARENAZ(new_type_details);
1258 #endif
1259         SvANY(sv) = new_body;
1260         if (new_type == SVt_PVAV) {
1261             AvMAX(sv)   = -1;
1262             AvFILLp(sv) = -1;
1263             AvREAL_only(sv);
1264             if (old_type_details->body_size) {
1265                 AvALLOC(sv) = 0;
1266             } else {
1267                 /* It will have been zeroed when the new body was allocated.
1268                    Lets not write to it, in case it confuses a write-back
1269                    cache.  */
1270             }
1271         } else {
1272             assert(!SvOK(sv));
1273             SvOK_off(sv);
1274 #ifndef NODEFAULT_SHAREKEYS
1275             HvSHAREKEYS_on(sv);         /* key-sharing on by default */
1276 #endif
1277             HvMAX(sv) = 7; /* (start with 8 buckets) */
1278             if (old_type_details->body_size) {
1279                 HvFILL(sv) = 0;
1280             } else {
1281                 /* It will have been zeroed when the new body was allocated.
1282                    Lets not write to it, in case it confuses a write-back
1283                    cache.  */
1284             }
1285         }
1286
1287         /* SVt_NULL isn't the only thing upgraded to AV or HV.
1288            The target created by newSVrv also is, and it can have magic.
1289            However, it never has SvPVX set.
1290         */
1291         if (old_type == SVt_IV) {
1292             assert(!SvROK(sv));
1293         } else if (old_type >= SVt_PV) {
1294             assert(SvPVX_const(sv) == 0);
1295         }
1296
1297         if (old_type >= SVt_PVMG) {
1298             SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1299             SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1300         } else {
1301             sv->sv_u.svu_array = NULL; /* or svu_hash  */
1302         }
1303         break;
1304
1305
1306     case SVt_PVIV:
1307         /* XXX Is this still needed?  Was it ever needed?   Surely as there is
1308            no route from NV to PVIV, NOK can never be true  */
1309         assert(!SvNOKp(sv));
1310         assert(!SvNOK(sv));
1311     case SVt_PVIO:
1312     case SVt_PVFM:
1313     case SVt_PVGV:
1314     case SVt_PVCV:
1315     case SVt_PVLV:
1316     case SVt_REGEXP:
1317     case SVt_PVMG:
1318     case SVt_PVNV:
1319     case SVt_PV:
1320
1321         assert(new_type_details->body_size);
1322         /* We always allocated the full length item with PURIFY. To do this
1323            we fake things so that arena is false for all 16 types..  */
1324         if(new_type_details->arena) {
1325             /* This points to the start of the allocated area.  */
1326             new_body_inline(new_body, new_type);
1327             Zero(new_body, new_type_details->body_size, char);
1328             new_body = ((char *)new_body) - new_type_details->offset;
1329         } else {
1330             new_body = new_NOARENAZ(new_type_details);
1331         }
1332         SvANY(sv) = new_body;
1333
1334         if (old_type_details->copy) {
1335             /* There is now the potential for an upgrade from something without
1336                an offset (PVNV or PVMG) to something with one (PVCV, PVFM)  */
1337             int offset = old_type_details->offset;
1338             int length = old_type_details->copy;
1339
1340             if (new_type_details->offset > old_type_details->offset) {
1341                 const int difference
1342                     = new_type_details->offset - old_type_details->offset;
1343                 offset += difference;
1344                 length -= difference;
1345             }
1346             assert (length >= 0);
1347                 
1348             Copy((char *)old_body + offset, (char *)new_body + offset, length,
1349                  char);
1350         }
1351
1352 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1353         /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1354          * correct 0.0 for us.  Otherwise, if the old body didn't have an
1355          * NV slot, but the new one does, then we need to initialise the
1356          * freshly created NV slot with whatever the correct bit pattern is
1357          * for 0.0  */
1358         if (old_type_details->zero_nv && !new_type_details->zero_nv
1359             && !isGV_with_GP(sv))
1360             SvNV_set(sv, 0);
1361 #endif
1362
1363         if (new_type == SVt_PVIO)
1364             IoPAGE_LEN(sv) = 60;
1365         if (old_type < SVt_PV) {
1366             /* referant will be NULL unless the old type was SVt_IV emulating
1367                SVt_RV */
1368             sv->sv_u.svu_rv = referant;
1369         }
1370         break;
1371     default:
1372         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1373                    (unsigned long)new_type);
1374     }
1375
1376     if (old_type_details->arena) {
1377         /* If there was an old body, then we need to free it.
1378            Note that there is an assumption that all bodies of types that
1379            can be upgraded came from arenas. Only the more complex non-
1380            upgradable types are allowed to be directly malloc()ed.  */
1381 #ifdef PURIFY
1382         my_safefree(old_body);
1383 #else
1384         del_body((void*)((char*)old_body + old_type_details->offset),
1385                  &PL_body_roots[old_type]);
1386 #endif
1387     }
1388 }
1389
1390 /*
1391 =for apidoc sv_backoff
1392
1393 Remove any string offset. You should normally use the C<SvOOK_off> macro
1394 wrapper instead.
1395
1396 =cut
1397 */
1398
1399 int
1400 Perl_sv_backoff(pTHX_ register SV *sv)
1401 {
1402     STRLEN delta;
1403     const char * const s = SvPVX_const(sv);
1404     PERL_UNUSED_CONTEXT;
1405     assert(SvOOK(sv));
1406     assert(SvTYPE(sv) != SVt_PVHV);
1407     assert(SvTYPE(sv) != SVt_PVAV);
1408
1409     SvOOK_offset(sv, delta);
1410     
1411     SvLEN_set(sv, SvLEN(sv) + delta);
1412     SvPV_set(sv, SvPVX(sv) - delta);
1413     Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1414     SvFLAGS(sv) &= ~SVf_OOK;
1415     return 0;
1416 }
1417
1418 /*
1419 =for apidoc sv_grow
1420
1421 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1422 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1423 Use the C<SvGROW> wrapper instead.
1424
1425 =cut
1426 */
1427
1428 char *
1429 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1430 {
1431     register char *s;
1432
1433     if (PL_madskills && newlen >= 0x100000) {
1434         PerlIO_printf(Perl_debug_log,
1435                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1436     }
1437 #ifdef HAS_64K_LIMIT
1438     if (newlen >= 0x10000) {
1439         PerlIO_printf(Perl_debug_log,
1440                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1441         my_exit(1);
1442     }
1443 #endif /* HAS_64K_LIMIT */
1444     if (SvROK(sv))
1445         sv_unref(sv);
1446     if (SvTYPE(sv) < SVt_PV) {
1447         sv_upgrade(sv, SVt_PV);
1448         s = SvPVX_mutable(sv);
1449     }
1450     else if (SvOOK(sv)) {       /* pv is offset? */
1451         sv_backoff(sv);
1452         s = SvPVX_mutable(sv);
1453         if (newlen > SvLEN(sv))
1454             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1455 #ifdef HAS_64K_LIMIT
1456         if (newlen >= 0x10000)
1457             newlen = 0xFFFF;
1458 #endif
1459     }
1460     else
1461         s = SvPVX_mutable(sv);
1462
1463     if (newlen > SvLEN(sv)) {           /* need more room? */
1464         newlen = PERL_STRLEN_ROUNDUP(newlen);
1465         if (SvLEN(sv) && s) {
1466 #ifdef MYMALLOC
1467             const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1468             if (newlen <= l) {
1469                 SvLEN_set(sv, l);
1470                 return s;
1471             } else
1472 #endif
1473             s = (char*)saferealloc(s, newlen);
1474         }
1475         else {
1476             s = (char*)safemalloc(newlen);
1477             if (SvPVX_const(sv) && SvCUR(sv)) {
1478                 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1479             }
1480         }
1481         SvPV_set(sv, s);
1482         SvLEN_set(sv, newlen);
1483     }
1484     return s;
1485 }
1486
1487 /*
1488 =for apidoc sv_setiv
1489
1490 Copies an integer into the given SV, upgrading first if necessary.
1491 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1492
1493 =cut
1494 */
1495
1496 void
1497 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1498 {
1499     dVAR;
1500     SV_CHECK_THINKFIRST_COW_DROP(sv);
1501     switch (SvTYPE(sv)) {
1502     case SVt_NULL:
1503     case SVt_NV:
1504         sv_upgrade(sv, SVt_IV);
1505         break;
1506     case SVt_PV:
1507         sv_upgrade(sv, SVt_PVIV);
1508         break;
1509
1510     case SVt_PVGV:
1511     case SVt_PVAV:
1512     case SVt_PVHV:
1513     case SVt_PVCV:
1514     case SVt_PVFM:
1515     case SVt_PVIO:
1516         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1517                    OP_DESC(PL_op));
1518     default: NOOP;
1519     }
1520     (void)SvIOK_only(sv);                       /* validate number */
1521     SvIV_set(sv, i);
1522     SvTAINT(sv);
1523 }
1524
1525 /*
1526 =for apidoc sv_setiv_mg
1527
1528 Like C<sv_setiv>, but also handles 'set' magic.
1529
1530 =cut
1531 */
1532
1533 void
1534 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1535 {
1536     sv_setiv(sv,i);
1537     SvSETMAGIC(sv);
1538 }
1539
1540 /*
1541 =for apidoc sv_setuv
1542
1543 Copies an unsigned integer into the given SV, upgrading first if necessary.
1544 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1545
1546 =cut
1547 */
1548
1549 void
1550 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1551 {
1552     /* With these two if statements:
1553        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1554
1555        without
1556        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1557
1558        If you wish to remove them, please benchmark to see what the effect is
1559     */
1560     if (u <= (UV)IV_MAX) {
1561        sv_setiv(sv, (IV)u);
1562        return;
1563     }
1564     sv_setiv(sv, 0);
1565     SvIsUV_on(sv);
1566     SvUV_set(sv, u);
1567 }
1568
1569 /*
1570 =for apidoc sv_setuv_mg
1571
1572 Like C<sv_setuv>, but also handles 'set' magic.
1573
1574 =cut
1575 */
1576
1577 void
1578 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1579 {
1580     sv_setuv(sv,u);
1581     SvSETMAGIC(sv);
1582 }
1583
1584 /*
1585 =for apidoc sv_setnv
1586
1587 Copies a double into the given SV, upgrading first if necessary.
1588 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1589
1590 =cut
1591 */
1592
1593 void
1594 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1595 {
1596     dVAR;
1597     SV_CHECK_THINKFIRST_COW_DROP(sv);
1598     switch (SvTYPE(sv)) {
1599     case SVt_NULL:
1600     case SVt_IV:
1601         sv_upgrade(sv, SVt_NV);
1602         break;
1603     case SVt_PV:
1604     case SVt_PVIV:
1605         sv_upgrade(sv, SVt_PVNV);
1606         break;
1607
1608     case SVt_PVGV:
1609     case SVt_PVAV:
1610     case SVt_PVHV:
1611     case SVt_PVCV:
1612     case SVt_PVFM:
1613     case SVt_PVIO:
1614         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1615                    OP_NAME(PL_op));
1616     default: NOOP;
1617     }
1618     SvNV_set(sv, num);
1619     (void)SvNOK_only(sv);                       /* validate number */
1620     SvTAINT(sv);
1621 }
1622
1623 /*
1624 =for apidoc sv_setnv_mg
1625
1626 Like C<sv_setnv>, but also handles 'set' magic.
1627
1628 =cut
1629 */
1630
1631 void
1632 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1633 {
1634     sv_setnv(sv,num);
1635     SvSETMAGIC(sv);
1636 }
1637
1638 /* Print an "isn't numeric" warning, using a cleaned-up,
1639  * printable version of the offending string
1640  */
1641
1642 STATIC void
1643 S_not_a_number(pTHX_ SV *sv)
1644 {
1645      dVAR;
1646      SV *dsv;
1647      char tmpbuf[64];
1648      const char *pv;
1649
1650      if (DO_UTF8(sv)) {
1651           dsv = newSVpvs_flags("", SVs_TEMP);
1652           pv = sv_uni_display(dsv, sv, 10, 0);
1653      } else {
1654           char *d = tmpbuf;
1655           const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1656           /* each *s can expand to 4 chars + "...\0",
1657              i.e. need room for 8 chars */
1658         
1659           const char *s = SvPVX_const(sv);
1660           const char * const end = s + SvCUR(sv);
1661           for ( ; s < end && d < limit; s++ ) {
1662                int ch = *s & 0xFF;
1663                if (ch & 128 && !isPRINT_LC(ch)) {
1664                     *d++ = 'M';
1665                     *d++ = '-';
1666                     ch &= 127;
1667                }
1668                if (ch == '\n') {
1669                     *d++ = '\\';
1670                     *d++ = 'n';
1671                }
1672                else if (ch == '\r') {
1673                     *d++ = '\\';
1674                     *d++ = 'r';
1675                }
1676                else if (ch == '\f') {
1677                     *d++ = '\\';
1678                     *d++ = 'f';
1679                }
1680                else if (ch == '\\') {
1681                     *d++ = '\\';
1682                     *d++ = '\\';
1683                }
1684                else if (ch == '\0') {
1685                     *d++ = '\\';
1686                     *d++ = '0';
1687                }
1688                else if (isPRINT_LC(ch))
1689                     *d++ = ch;
1690                else {
1691                     *d++ = '^';
1692                     *d++ = toCTRL(ch);
1693                }
1694           }
1695           if (s < end) {
1696                *d++ = '.';
1697                *d++ = '.';
1698                *d++ = '.';
1699           }
1700           *d = '\0';
1701           pv = tmpbuf;
1702     }
1703
1704     if (PL_op)
1705         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706                     "Argument \"%s\" isn't numeric in %s", pv,
1707                     OP_DESC(PL_op));
1708     else
1709         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1710                     "Argument \"%s\" isn't numeric", pv);
1711 }
1712
1713 /*
1714 =for apidoc looks_like_number
1715
1716 Test if the content of an SV looks like a number (or is a number).
1717 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1718 non-numeric warning), even if your atof() doesn't grok them.
1719
1720 =cut
1721 */
1722
1723 I32
1724 Perl_looks_like_number(pTHX_ SV *sv)
1725 {
1726     register const char *sbegin;
1727     STRLEN len;
1728
1729     if (SvPOK(sv)) {
1730         sbegin = SvPVX_const(sv);
1731         len = SvCUR(sv);
1732     }
1733     else if (SvPOKp(sv))
1734         sbegin = SvPV_const(sv, len);
1735     else
1736         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1737     return grok_number(sbegin, len, NULL);
1738 }
1739
1740 STATIC bool
1741 S_glob_2number(pTHX_ GV * const gv)
1742 {
1743     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1744     SV *const buffer = sv_newmortal();
1745
1746     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1747        is on.  */
1748     SvFAKE_off(gv);
1749     gv_efullname3(buffer, gv, "*");
1750     SvFLAGS(gv) |= wasfake;
1751
1752     /* We know that all GVs stringify to something that is not-a-number,
1753         so no need to test that.  */
1754     if (ckWARN(WARN_NUMERIC))
1755         not_a_number(buffer);
1756     /* We just want something true to return, so that S_sv_2iuv_common
1757         can tail call us and return true.  */
1758     return TRUE;
1759 }
1760
1761 STATIC char *
1762 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1763 {
1764     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1765     SV *const buffer = sv_newmortal();
1766
1767     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1768        is on.  */
1769     SvFAKE_off(gv);
1770     gv_efullname3(buffer, gv, "*");
1771     SvFLAGS(gv) |= wasfake;
1772
1773     assert(SvPOK(buffer));
1774     if (len) {
1775         *len = SvCUR(buffer);
1776     }
1777     return SvPVX(buffer);
1778 }
1779
1780 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1781    until proven guilty, assume that things are not that bad... */
1782
1783 /*
1784    NV_PRESERVES_UV:
1785
1786    As 64 bit platforms often have an NV that doesn't preserve all bits of
1787    an IV (an assumption perl has been based on to date) it becomes necessary
1788    to remove the assumption that the NV always carries enough precision to
1789    recreate the IV whenever needed, and that the NV is the canonical form.
1790    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1791    precision as a side effect of conversion (which would lead to insanity
1792    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1793    1) to distinguish between IV/UV/NV slots that have cached a valid
1794       conversion where precision was lost and IV/UV/NV slots that have a
1795       valid conversion which has lost no precision
1796    2) to ensure that if a numeric conversion to one form is requested that
1797       would lose precision, the precise conversion (or differently
1798       imprecise conversion) is also performed and cached, to prevent
1799       requests for different numeric formats on the same SV causing
1800       lossy conversion chains. (lossless conversion chains are perfectly
1801       acceptable (still))
1802
1803
1804    flags are used:
1805    SvIOKp is true if the IV slot contains a valid value
1806    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1807    SvNOKp is true if the NV slot contains a valid value
1808    SvNOK  is true only if the NV value is accurate
1809
1810    so
1811    while converting from PV to NV, check to see if converting that NV to an
1812    IV(or UV) would lose accuracy over a direct conversion from PV to
1813    IV(or UV). If it would, cache both conversions, return NV, but mark
1814    SV as IOK NOKp (ie not NOK).
1815
1816    While converting from PV to IV, check to see if converting that IV to an
1817    NV would lose accuracy over a direct conversion from PV to NV. If it
1818    would, cache both conversions, flag similarly.
1819
1820    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1821    correctly because if IV & NV were set NV *always* overruled.
1822    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1823    changes - now IV and NV together means that the two are interchangeable:
1824    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1825
1826    The benefit of this is that operations such as pp_add know that if
1827    SvIOK is true for both left and right operands, then integer addition
1828    can be used instead of floating point (for cases where the result won't
1829    overflow). Before, floating point was always used, which could lead to
1830    loss of precision compared with integer addition.
1831
1832    * making IV and NV equal status should make maths accurate on 64 bit
1833      platforms
1834    * may speed up maths somewhat if pp_add and friends start to use
1835      integers when possible instead of fp. (Hopefully the overhead in
1836      looking for SvIOK and checking for overflow will not outweigh the
1837      fp to integer speedup)
1838    * will slow down integer operations (callers of SvIV) on "inaccurate"
1839      values, as the change from SvIOK to SvIOKp will cause a call into
1840      sv_2iv each time rather than a macro access direct to the IV slot
1841    * should speed up number->string conversion on integers as IV is
1842      favoured when IV and NV are equally accurate
1843
1844    ####################################################################
1845    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1846    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1847    On the other hand, SvUOK is true iff UV.
1848    ####################################################################
1849
1850    Your mileage will vary depending your CPU's relative fp to integer
1851    performance ratio.
1852 */
1853
1854 #ifndef NV_PRESERVES_UV
1855 #  define IS_NUMBER_UNDERFLOW_IV 1
1856 #  define IS_NUMBER_UNDERFLOW_UV 2
1857 #  define IS_NUMBER_IV_AND_UV    2
1858 #  define IS_NUMBER_OVERFLOW_IV  4
1859 #  define IS_NUMBER_OVERFLOW_UV  5
1860
1861 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1862
1863 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1864 STATIC int
1865 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1866 {
1867     dVAR;
1868     PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1869     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));
1870     if (SvNVX(sv) < (NV)IV_MIN) {
1871         (void)SvIOKp_on(sv);
1872         (void)SvNOK_on(sv);
1873         SvIV_set(sv, IV_MIN);
1874         return IS_NUMBER_UNDERFLOW_IV;
1875     }
1876     if (SvNVX(sv) > (NV)UV_MAX) {
1877         (void)SvIOKp_on(sv);
1878         (void)SvNOK_on(sv);
1879         SvIsUV_on(sv);
1880         SvUV_set(sv, UV_MAX);
1881         return IS_NUMBER_OVERFLOW_UV;
1882     }
1883     (void)SvIOKp_on(sv);
1884     (void)SvNOK_on(sv);
1885     /* Can't use strtol etc to convert this string.  (See truth table in
1886        sv_2iv  */
1887     if (SvNVX(sv) <= (UV)IV_MAX) {
1888         SvIV_set(sv, I_V(SvNVX(sv)));
1889         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1890             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1891         } else {
1892             /* Integer is imprecise. NOK, IOKp */
1893         }
1894         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1895     }
1896     SvIsUV_on(sv);
1897     SvUV_set(sv, U_V(SvNVX(sv)));
1898     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1899         if (SvUVX(sv) == UV_MAX) {
1900             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1901                possibly be preserved by NV. Hence, it must be overflow.
1902                NOK, IOKp */
1903             return IS_NUMBER_OVERFLOW_UV;
1904         }
1905         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1906     } else {
1907         /* Integer is imprecise. NOK, IOKp */
1908     }
1909     return IS_NUMBER_OVERFLOW_IV;
1910 }
1911 #endif /* !NV_PRESERVES_UV*/
1912
1913 STATIC bool
1914 S_sv_2iuv_common(pTHX_ SV *sv) {
1915     dVAR;
1916     if (SvNOKp(sv)) {
1917         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1918          * without also getting a cached IV/UV from it at the same time
1919          * (ie PV->NV conversion should detect loss of accuracy and cache
1920          * IV or UV at same time to avoid this. */
1921         /* IV-over-UV optimisation - choose to cache IV if possible */
1922
1923         if (SvTYPE(sv) == SVt_NV)
1924             sv_upgrade(sv, SVt_PVNV);
1925
1926         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1927         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1928            certainly cast into the IV range at IV_MAX, whereas the correct
1929            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1930            cases go to UV */
1931 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1932         if (Perl_isnan(SvNVX(sv))) {
1933             SvUV_set(sv, 0);
1934             SvIsUV_on(sv);
1935             return FALSE;
1936         }
1937 #endif
1938         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1939             SvIV_set(sv, I_V(SvNVX(sv)));
1940             if (SvNVX(sv) == (NV) SvIVX(sv)
1941 #ifndef NV_PRESERVES_UV
1942                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1943                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1944                 /* Don't flag it as "accurately an integer" if the number
1945                    came from a (by definition imprecise) NV operation, and
1946                    we're outside the range of NV integer precision */
1947 #endif
1948                 ) {
1949                 if (SvNOK(sv))
1950                     SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
1951                 else {
1952                     /* scalar has trailing garbage, eg "42a" */
1953                 }
1954                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1955                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1956                                       PTR2UV(sv),
1957                                       SvNVX(sv),
1958                                       SvIVX(sv)));
1959
1960             } else {
1961                 /* IV not precise.  No need to convert from PV, as NV
1962                    conversion would already have cached IV if it detected
1963                    that PV->IV would be better than PV->NV->IV
1964                    flags already correct - don't set public IOK.  */
1965                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1966                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1967                                       PTR2UV(sv),
1968                                       SvNVX(sv),
1969                                       SvIVX(sv)));
1970             }
1971             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1972                but the cast (NV)IV_MIN rounds to a the value less (more
1973                negative) than IV_MIN which happens to be equal to SvNVX ??
1974                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1975                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1976                (NV)UVX == NVX are both true, but the values differ. :-(
1977                Hopefully for 2s complement IV_MIN is something like
1978                0x8000000000000000 which will be exact. NWC */
1979         }
1980         else {
1981             SvUV_set(sv, U_V(SvNVX(sv)));
1982             if (
1983                 (SvNVX(sv) == (NV) SvUVX(sv))
1984 #ifndef  NV_PRESERVES_UV
1985                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1986                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1987                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1988                 /* Don't flag it as "accurately an integer" if the number
1989                    came from a (by definition imprecise) NV operation, and
1990                    we're outside the range of NV integer precision */
1991 #endif
1992                 && SvNOK(sv)
1993                 )
1994                 SvIOK_on(sv);
1995             SvIsUV_on(sv);
1996             DEBUG_c(PerlIO_printf(Perl_debug_log,
1997                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1998                                   PTR2UV(sv),
1999                                   SvUVX(sv),
2000                                   SvUVX(sv)));
2001         }
2002     }
2003     else if (SvPOKp(sv) && SvLEN(sv)) {
2004         UV value;
2005         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2006         /* We want to avoid a possible problem when we cache an IV/ a UV which
2007            may be later translated to an NV, and the resulting NV is not
2008            the same as the direct translation of the initial string
2009            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2010            be careful to ensure that the value with the .456 is around if the
2011            NV value is requested in the future).
2012         
2013            This means that if we cache such an IV/a UV, we need to cache the
2014            NV as well.  Moreover, we trade speed for space, and do not
2015            cache the NV if we are sure it's not needed.
2016          */
2017
2018         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2019         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2020              == IS_NUMBER_IN_UV) {
2021             /* It's definitely an integer, only upgrade to PVIV */
2022             if (SvTYPE(sv) < SVt_PVIV)
2023                 sv_upgrade(sv, SVt_PVIV);
2024             (void)SvIOK_on(sv);
2025         } else if (SvTYPE(sv) < SVt_PVNV)
2026             sv_upgrade(sv, SVt_PVNV);
2027
2028         /* If NVs preserve UVs then we only use the UV value if we know that
2029            we aren't going to call atof() below. If NVs don't preserve UVs
2030            then the value returned may have more precision than atof() will
2031            return, even though value isn't perfectly accurate.  */
2032         if ((numtype & (IS_NUMBER_IN_UV
2033 #ifdef NV_PRESERVES_UV
2034                         | IS_NUMBER_NOT_INT
2035 #endif
2036             )) == IS_NUMBER_IN_UV) {
2037             /* This won't turn off the public IOK flag if it was set above  */
2038             (void)SvIOKp_on(sv);
2039
2040             if (!(numtype & IS_NUMBER_NEG)) {
2041                 /* positive */;
2042                 if (value <= (UV)IV_MAX) {
2043                     SvIV_set(sv, (IV)value);
2044                 } else {
2045                     /* it didn't overflow, and it was positive. */
2046                     SvUV_set(sv, value);
2047                     SvIsUV_on(sv);
2048                 }
2049             } else {
2050                 /* 2s complement assumption  */
2051                 if (value <= (UV)IV_MIN) {
2052                     SvIV_set(sv, -(IV)value);
2053                 } else {
2054                     /* Too negative for an IV.  This is a double upgrade, but
2055                        I'm assuming it will be rare.  */
2056                     if (SvTYPE(sv) < SVt_PVNV)
2057                         sv_upgrade(sv, SVt_PVNV);
2058                     SvNOK_on(sv);
2059                     SvIOK_off(sv);
2060                     SvIOKp_on(sv);
2061                     SvNV_set(sv, -(NV)value);
2062                     SvIV_set(sv, IV_MIN);
2063                 }
2064             }
2065         }
2066         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2067            will be in the previous block to set the IV slot, and the next
2068            block to set the NV slot.  So no else here.  */
2069         
2070         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2071             != IS_NUMBER_IN_UV) {
2072             /* It wasn't an (integer that doesn't overflow the UV). */
2073             SvNV_set(sv, Atof(SvPVX_const(sv)));
2074
2075             if (! numtype && ckWARN(WARN_NUMERIC))
2076                 not_a_number(sv);
2077
2078 #if defined(USE_LONG_DOUBLE)
2079             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2080                                   PTR2UV(sv), SvNVX(sv)));
2081 #else
2082             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2083                                   PTR2UV(sv), SvNVX(sv)));
2084 #endif
2085
2086 #ifdef NV_PRESERVES_UV
2087             (void)SvIOKp_on(sv);
2088             (void)SvNOK_on(sv);
2089             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2090                 SvIV_set(sv, I_V(SvNVX(sv)));
2091                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2092                     SvIOK_on(sv);
2093                 } else {
2094                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2095                 }
2096                 /* UV will not work better than IV */
2097             } else {
2098                 if (SvNVX(sv) > (NV)UV_MAX) {
2099                     SvIsUV_on(sv);
2100                     /* Integer is inaccurate. NOK, IOKp, is UV */
2101                     SvUV_set(sv, UV_MAX);
2102                 } else {
2103                     SvUV_set(sv, U_V(SvNVX(sv)));
2104                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2105                        NV preservse UV so can do correct comparison.  */
2106                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2107                         SvIOK_on(sv);
2108                     } else {
2109                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2110                     }
2111                 }
2112                 SvIsUV_on(sv);
2113             }
2114 #else /* NV_PRESERVES_UV */
2115             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2116                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2117                 /* The IV/UV slot will have been set from value returned by
2118                    grok_number above.  The NV slot has just been set using
2119                    Atof.  */
2120                 SvNOK_on(sv);
2121                 assert (SvIOKp(sv));
2122             } else {
2123                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2124                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2125                     /* Small enough to preserve all bits. */
2126                     (void)SvIOKp_on(sv);
2127                     SvNOK_on(sv);
2128                     SvIV_set(sv, I_V(SvNVX(sv)));
2129                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2130                         SvIOK_on(sv);
2131                     /* Assumption: first non-preserved integer is < IV_MAX,
2132                        this NV is in the preserved range, therefore: */
2133                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2134                           < (UV)IV_MAX)) {
2135                         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);
2136                     }
2137                 } else {
2138                     /* IN_UV NOT_INT
2139                          0      0       already failed to read UV.
2140                          0      1       already failed to read UV.
2141                          1      0       you won't get here in this case. IV/UV
2142                                         slot set, public IOK, Atof() unneeded.
2143                          1      1       already read UV.
2144                        so there's no point in sv_2iuv_non_preserve() attempting
2145                        to use atol, strtol, strtoul etc.  */
2146                     sv_2iuv_non_preserve (sv, numtype);
2147                 }
2148             }
2149 #endif /* NV_PRESERVES_UV */
2150         /* It might be more code efficient to go through the entire logic above
2151            and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2152            gets complex and potentially buggy, so more programmer efficient
2153            to do it this way, by turning off the public flags:  */
2154         if (!numtype)
2155             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2156         }
2157     }
2158     else  {
2159         if (isGV_with_GP(sv))
2160             return glob_2number((GV *)sv);
2161
2162         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2163             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2164                 report_uninit(sv);
2165         }
2166         if (SvTYPE(sv) < SVt_IV)
2167             /* Typically the caller expects that sv_any is not NULL now.  */
2168             sv_upgrade(sv, SVt_IV);
2169         /* Return 0 from the caller.  */
2170         return TRUE;
2171     }
2172     return FALSE;
2173 }
2174
2175 /*
2176 =for apidoc sv_2iv_flags
2177
2178 Return the integer value of an SV, doing any necessary string
2179 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2180 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2181
2182 =cut
2183 */
2184
2185 IV
2186 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2187 {
2188     dVAR;
2189     if (!sv)
2190         return 0;
2191     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2192         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2193            cache IVs just in case. In practice it seems that they never
2194            actually anywhere accessible by user Perl code, let alone get used
2195            in anything other than a string context.  */
2196         if (flags & SV_GMAGIC)
2197             mg_get(sv);
2198         if (SvIOKp(sv))
2199             return SvIVX(sv);
2200         if (SvNOKp(sv)) {
2201             return I_V(SvNVX(sv));
2202         }
2203         if (SvPOKp(sv) && SvLEN(sv)) {
2204             UV value;
2205             const int numtype
2206                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2207
2208             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209                 == IS_NUMBER_IN_UV) {
2210                 /* It's definitely an integer */
2211                 if (numtype & IS_NUMBER_NEG) {
2212                     if (value < (UV)IV_MIN)
2213                         return -(IV)value;
2214                 } else {
2215                     if (value < (UV)IV_MAX)
2216                         return (IV)value;
2217                 }
2218             }
2219             if (!numtype) {
2220                 if (ckWARN(WARN_NUMERIC))
2221                     not_a_number(sv);
2222             }
2223             return I_V(Atof(SvPVX_const(sv)));
2224         }
2225         if (SvROK(sv)) {
2226             goto return_rok;
2227         }
2228         assert(SvTYPE(sv) >= SVt_PVMG);
2229         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2230     } else if (SvTHINKFIRST(sv)) {
2231         if (SvROK(sv)) {
2232         return_rok:
2233             if (SvAMAGIC(sv)) {
2234                 SV * const tmpstr=AMG_CALLun(sv,numer);
2235                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2236                     return SvIV(tmpstr);
2237                 }
2238             }
2239             return PTR2IV(SvRV(sv));
2240         }
2241         if (SvIsCOW(sv)) {
2242             sv_force_normal_flags(sv, 0);
2243         }
2244         if (SvREADONLY(sv) && !SvOK(sv)) {
2245             if (ckWARN(WARN_UNINITIALIZED))
2246                 report_uninit(sv);
2247             return 0;
2248         }
2249     }
2250     if (!SvIOKp(sv)) {
2251         if (S_sv_2iuv_common(aTHX_ sv))
2252             return 0;
2253     }
2254     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2255         PTR2UV(sv),SvIVX(sv)));
2256     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2257 }
2258
2259 /*
2260 =for apidoc sv_2uv_flags
2261
2262 Return the unsigned integer value of an SV, doing any necessary string
2263 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2264 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2265
2266 =cut
2267 */
2268
2269 UV
2270 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2271 {
2272     dVAR;
2273     if (!sv)
2274         return 0;
2275     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2276         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2277            cache IVs just in case.  */
2278         if (flags & SV_GMAGIC)
2279             mg_get(sv);
2280         if (SvIOKp(sv))
2281             return SvUVX(sv);
2282         if (SvNOKp(sv))
2283             return U_V(SvNVX(sv));
2284         if (SvPOKp(sv) && SvLEN(sv)) {
2285             UV value;
2286             const int numtype
2287                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2288
2289             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290                 == IS_NUMBER_IN_UV) {
2291                 /* It's definitely an integer */
2292                 if (!(numtype & IS_NUMBER_NEG))
2293                     return value;
2294             }
2295             if (!numtype) {
2296                 if (ckWARN(WARN_NUMERIC))
2297                     not_a_number(sv);
2298             }
2299             return U_V(Atof(SvPVX_const(sv)));
2300         }
2301         if (SvROK(sv)) {
2302             goto return_rok;
2303         }
2304         assert(SvTYPE(sv) >= SVt_PVMG);
2305         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2306     } else if (SvTHINKFIRST(sv)) {
2307         if (SvROK(sv)) {
2308         return_rok:
2309             if (SvAMAGIC(sv)) {
2310                 SV *const tmpstr = AMG_CALLun(sv,numer);
2311                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2312                     return SvUV(tmpstr);
2313                 }
2314             }
2315             return PTR2UV(SvRV(sv));
2316         }
2317         if (SvIsCOW(sv)) {
2318             sv_force_normal_flags(sv, 0);
2319         }
2320         if (SvREADONLY(sv) && !SvOK(sv)) {
2321             if (ckWARN(WARN_UNINITIALIZED))
2322                 report_uninit(sv);
2323             return 0;
2324         }
2325     }
2326     if (!SvIOKp(sv)) {
2327         if (S_sv_2iuv_common(aTHX_ sv))
2328             return 0;
2329     }
2330
2331     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2332                           PTR2UV(sv),SvUVX(sv)));
2333     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2334 }
2335
2336 /*
2337 =for apidoc sv_2nv
2338
2339 Return the num value of an SV, doing any necessary string or integer
2340 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2341 macros.
2342
2343 =cut
2344 */
2345
2346 NV
2347 Perl_sv_2nv(pTHX_ register SV *sv)
2348 {
2349     dVAR;
2350     if (!sv)
2351         return 0.0;
2352     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2353         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2354            cache IVs just in case.  */
2355         mg_get(sv);
2356         if (SvNOKp(sv))
2357             return SvNVX(sv);
2358         if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2359             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2360                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2361                 not_a_number(sv);
2362             return Atof(SvPVX_const(sv));
2363         }
2364         if (SvIOKp(sv)) {
2365             if (SvIsUV(sv))
2366                 return (NV)SvUVX(sv);
2367             else
2368                 return (NV)SvIVX(sv);
2369         }
2370         if (SvROK(sv)) {
2371             goto return_rok;
2372         }
2373         assert(SvTYPE(sv) >= SVt_PVMG);
2374         /* This falls through to the report_uninit near the end of the
2375            function. */
2376     } else if (SvTHINKFIRST(sv)) {
2377         if (SvROK(sv)) {
2378         return_rok:
2379             if (SvAMAGIC(sv)) {
2380                 SV *const tmpstr = AMG_CALLun(sv,numer);
2381                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2382                     return SvNV(tmpstr);
2383                 }
2384             }
2385             return PTR2NV(SvRV(sv));
2386         }
2387         if (SvIsCOW(sv)) {
2388             sv_force_normal_flags(sv, 0);
2389         }
2390         if (SvREADONLY(sv) && !SvOK(sv)) {
2391             if (ckWARN(WARN_UNINITIALIZED))
2392                 report_uninit(sv);
2393             return 0.0;
2394         }
2395     }
2396     if (SvTYPE(sv) < SVt_NV) {
2397         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2398         sv_upgrade(sv, SVt_NV);
2399 #ifdef USE_LONG_DOUBLE
2400         DEBUG_c({
2401             STORE_NUMERIC_LOCAL_SET_STANDARD();
2402             PerlIO_printf(Perl_debug_log,
2403                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2404                           PTR2UV(sv), SvNVX(sv));
2405             RESTORE_NUMERIC_LOCAL();
2406         });
2407 #else
2408         DEBUG_c({
2409             STORE_NUMERIC_LOCAL_SET_STANDARD();
2410             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2411                           PTR2UV(sv), SvNVX(sv));
2412             RESTORE_NUMERIC_LOCAL();
2413         });
2414 #endif
2415     }
2416     else if (SvTYPE(sv) < SVt_PVNV)
2417         sv_upgrade(sv, SVt_PVNV);
2418     if (SvNOKp(sv)) {
2419         return SvNVX(sv);
2420     }
2421     if (SvIOKp(sv)) {
2422         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2423 #ifdef NV_PRESERVES_UV
2424         if (SvIOK(sv))
2425             SvNOK_on(sv);
2426         else
2427             SvNOKp_on(sv);
2428 #else
2429         /* Only set the public NV OK flag if this NV preserves the IV  */
2430         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2431         if (SvIOK(sv) &&
2432             SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2433                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2434             SvNOK_on(sv);
2435         else
2436             SvNOKp_on(sv);
2437 #endif
2438     }
2439     else if (SvPOKp(sv) && SvLEN(sv)) {
2440         UV value;
2441         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2442         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2443             not_a_number(sv);
2444 #ifdef NV_PRESERVES_UV
2445         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2446             == IS_NUMBER_IN_UV) {
2447             /* It's definitely an integer */
2448             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2449         } else
2450             SvNV_set(sv, Atof(SvPVX_const(sv)));
2451         if (numtype)
2452             SvNOK_on(sv);
2453         else
2454             SvNOKp_on(sv);
2455 #else
2456         SvNV_set(sv, Atof(SvPVX_const(sv)));
2457         /* Only set the public NV OK flag if this NV preserves the value in
2458            the PV at least as well as an IV/UV would.
2459            Not sure how to do this 100% reliably. */
2460         /* if that shift count is out of range then Configure's test is
2461            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2462            UV_BITS */
2463         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2464             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2465             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2466         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2467             /* Can't use strtol etc to convert this string, so don't try.
2468                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2469             SvNOK_on(sv);
2470         } else {
2471             /* value has been set.  It may not be precise.  */
2472             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2473                 /* 2s complement assumption for (UV)IV_MIN  */
2474                 SvNOK_on(sv); /* Integer is too negative.  */
2475             } else {
2476                 SvNOKp_on(sv);
2477                 SvIOKp_on(sv);
2478
2479                 if (numtype & IS_NUMBER_NEG) {
2480                     SvIV_set(sv, -(IV)value);
2481                 } else if (value <= (UV)IV_MAX) {
2482                     SvIV_set(sv, (IV)value);
2483                 } else {
2484                     SvUV_set(sv, value);
2485                     SvIsUV_on(sv);
2486                 }
2487
2488                 if (numtype & IS_NUMBER_NOT_INT) {
2489                     /* I believe that even if the original PV had decimals,
2490                        they are lost beyond the limit of the FP precision.
2491                        However, neither is canonical, so both only get p
2492                        flags.  NWC, 2000/11/25 */
2493                     /* Both already have p flags, so do nothing */
2494                 } else {
2495                     const NV nv = SvNVX(sv);
2496                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2497                         if (SvIVX(sv) == I_V(nv)) {
2498                             SvNOK_on(sv);
2499                         } else {
2500                             /* It had no "." so it must be integer.  */
2501                         }
2502                         SvIOK_on(sv);
2503                     } else {
2504                         /* between IV_MAX and NV(UV_MAX).
2505                            Could be slightly > UV_MAX */
2506
2507                         if (numtype & IS_NUMBER_NOT_INT) {
2508                             /* UV and NV both imprecise.  */
2509                         } else {
2510                             const UV nv_as_uv = U_V(nv);
2511
2512                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2513                                 SvNOK_on(sv);
2514                             }
2515                             SvIOK_on(sv);
2516                         }
2517                     }
2518                 }
2519             }
2520         }
2521         /* It might be more code efficient to go through the entire logic above
2522            and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2523            gets complex and potentially buggy, so more programmer efficient
2524            to do it this way, by turning off the public flags:  */
2525         if (!numtype)
2526             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2527 #endif /* NV_PRESERVES_UV */
2528     }
2529     else  {
2530         if (isGV_with_GP(sv)) {
2531             glob_2number((GV *)sv);
2532             return 0.0;
2533         }
2534
2535         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2536             report_uninit(sv);
2537         assert (SvTYPE(sv) >= SVt_NV);
2538         /* Typically the caller expects that sv_any is not NULL now.  */
2539         /* XXX Ilya implies that this is a bug in callers that assume this
2540            and ideally should be fixed.  */
2541         return 0.0;
2542     }
2543 #if defined(USE_LONG_DOUBLE)
2544     DEBUG_c({
2545         STORE_NUMERIC_LOCAL_SET_STANDARD();
2546         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2547                       PTR2UV(sv), SvNVX(sv));
2548         RESTORE_NUMERIC_LOCAL();
2549     });
2550 #else
2551     DEBUG_c({
2552         STORE_NUMERIC_LOCAL_SET_STANDARD();
2553         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2554                       PTR2UV(sv), SvNVX(sv));
2555         RESTORE_NUMERIC_LOCAL();
2556     });
2557 #endif
2558     return SvNVX(sv);
2559 }
2560
2561 /*
2562 =for apidoc sv_2num
2563
2564 Return an SV with the numeric value of the source SV, doing any necessary
2565 reference or overload conversion.  You must use the C<SvNUM(sv)> macro to
2566 access this function.
2567
2568 =cut
2569 */
2570
2571 SV *
2572 Perl_sv_2num(pTHX_ register SV *sv)
2573 {
2574     if (!SvROK(sv))
2575         return sv;
2576     if (SvAMAGIC(sv)) {
2577         SV * const tmpsv = AMG_CALLun(sv,numer);
2578         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2579             return sv_2num(tmpsv);
2580     }
2581     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2582 }
2583
2584 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2585  * UV as a string towards the end of buf, and return pointers to start and
2586  * end of it.
2587  *
2588  * We assume that buf is at least TYPE_CHARS(UV) long.
2589  */
2590
2591 static char *
2592 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2593 {
2594     char *ptr = buf + TYPE_CHARS(UV);
2595     char * const ebuf = ptr;
2596     int sign;
2597
2598     if (is_uv)
2599         sign = 0;
2600     else if (iv >= 0) {
2601         uv = iv;
2602         sign = 0;
2603     } else {
2604         uv = -iv;
2605         sign = 1;
2606     }
2607     do {
2608         *--ptr = '0' + (char)(uv % 10);
2609     } while (uv /= 10);
2610     if (sign)
2611         *--ptr = '-';
2612     *peob = ebuf;
2613     return ptr;
2614 }
2615
2616 /*
2617 =for apidoc sv_2pv_flags
2618
2619 Returns a pointer to the string value of an SV, and sets *lp to its length.
2620 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2621 if necessary.
2622 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2623 usually end up here too.
2624
2625 =cut
2626 */
2627
2628 char *
2629 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2630 {
2631     dVAR;
2632     register char *s;
2633
2634     if (!sv) {
2635         if (lp)
2636             *lp = 0;
2637         return (char *)"";
2638     }
2639     if (SvGMAGICAL(sv)) {
2640         if (flags & SV_GMAGIC)
2641             mg_get(sv);
2642         if (SvPOKp(sv)) {
2643             if (lp)
2644                 *lp = SvCUR(sv);
2645             if (flags & SV_MUTABLE_RETURN)
2646                 return SvPVX_mutable(sv);
2647             if (flags & SV_CONST_RETURN)
2648                 return (char *)SvPVX_const(sv);
2649             return SvPVX(sv);
2650         }
2651         if (SvIOKp(sv) || SvNOKp(sv)) {
2652             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2653             STRLEN len;
2654
2655             if (SvIOKp(sv)) {
2656                 len = SvIsUV(sv)
2657                     ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2658                     : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2659             } else {
2660                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2661                 len = strlen(tbuf);
2662             }
2663             assert(!SvROK(sv));
2664             {
2665                 dVAR;
2666
2667 #ifdef FIXNEGATIVEZERO
2668                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2669                     tbuf[0] = '0';
2670                     tbuf[1] = 0;
2671                     len = 1;
2672                 }
2673 #endif
2674                 SvUPGRADE(sv, SVt_PV);
2675                 if (lp)
2676                     *lp = len;
2677                 s = SvGROW_mutable(sv, len + 1);
2678                 SvCUR_set(sv, len);
2679                 SvPOKp_on(sv);
2680                 return (char*)memcpy(s, tbuf, len + 1);
2681             }
2682         }
2683         if (SvROK(sv)) {
2684             goto return_rok;
2685         }
2686         assert(SvTYPE(sv) >= SVt_PVMG);
2687         /* This falls through to the report_uninit near the end of the
2688            function. */
2689     } else if (SvTHINKFIRST(sv)) {
2690         if (SvROK(sv)) {
2691         return_rok:
2692             if (SvAMAGIC(sv)) {
2693                 SV *const tmpstr = AMG_CALLun(sv,string);
2694                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2695                     /* Unwrap this:  */
2696                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2697                      */
2698
2699                     char *pv;
2700                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2701                         if (flags & SV_CONST_RETURN) {
2702                             pv = (char *) SvPVX_const(tmpstr);
2703                         } else {
2704                             pv = (flags & SV_MUTABLE_RETURN)
2705                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2706                         }
2707                         if (lp)
2708                             *lp = SvCUR(tmpstr);
2709                     } else {
2710                         pv = sv_2pv_flags(tmpstr, lp, flags);
2711                     }
2712                     if (SvUTF8(tmpstr))
2713                         SvUTF8_on(sv);
2714                     else
2715                         SvUTF8_off(sv);
2716                     return pv;
2717                 }
2718             }
2719             {
2720                 STRLEN len;
2721                 char *retval;
2722                 char *buffer;
2723                 const SV *const referent = (SV*)SvRV(sv);
2724
2725                 if (!referent) {
2726                     len = 7;
2727                     retval = buffer = savepvn("NULLREF", len);
2728                 } else if (SvTYPE(referent) == SVt_REGEXP) {
2729                     char *str = NULL;
2730                     I32 haseval = 0;
2731                     U32 flags = 0;
2732                     struct magic temp;
2733                     /* FIXME - get rid of this cast away of const, or work out
2734                        how to do it better.  */
2735                     temp.mg_obj = (SV *)referent;
2736                     assert(temp.mg_obj);
2737                     (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2738                     if (flags & 1)
2739                         SvUTF8_on(sv);
2740                     else
2741                         SvUTF8_off(sv);
2742                     PL_reginterp_cnt += haseval;
2743                     return str;
2744                 } else {
2745                     const char *const typestr = sv_reftype(referent, 0);
2746                     const STRLEN typelen = strlen(typestr);
2747                     UV addr = PTR2UV(referent);
2748                     const char *stashname = NULL;
2749                     STRLEN stashnamelen = 0; /* hush, gcc */
2750                     const char *buffer_end;
2751
2752                     if (SvOBJECT(referent)) {
2753                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2754
2755                         if (name) {
2756                             stashname = HEK_KEY(name);
2757                             stashnamelen = HEK_LEN(name);
2758
2759                             if (HEK_UTF8(name)) {
2760                                 SvUTF8_on(sv);
2761                             } else {
2762                                 SvUTF8_off(sv);
2763                             }
2764                         } else {
2765                             stashname = "__ANON__";
2766                             stashnamelen = 8;
2767                         }
2768                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2769                             + 2 * sizeof(UV) + 2 /* )\0 */;
2770                     } else {
2771                         len = typelen + 3 /* (0x */
2772                             + 2 * sizeof(UV) + 2 /* )\0 */;
2773                     }
2774
2775                     Newx(buffer, len, char);
2776                     buffer_end = retval = buffer + len;
2777
2778                     /* Working backwards  */
2779                     *--retval = '\0';
2780                     *--retval = ')';
2781                     do {
2782                         *--retval = PL_hexdigit[addr & 15];
2783                     } while (addr >>= 4);
2784                     *--retval = 'x';
2785                     *--retval = '0';
2786                     *--retval = '(';
2787
2788                     retval -= typelen;
2789                     memcpy(retval, typestr, typelen);
2790
2791                     if (stashname) {
2792                         *--retval = '=';
2793                         retval -= stashnamelen;
2794                         memcpy(retval, stashname, stashnamelen);
2795                     }
2796                     /* retval may not neccesarily have reached the start of the
2797                        buffer here.  */
2798                     assert (retval >= buffer);
2799
2800                     len = buffer_end - retval - 1; /* -1 for that \0  */
2801                 }
2802                 if (lp)
2803                     *lp = len;
2804                 SAVEFREEPV(buffer);
2805                 return retval;
2806             }
2807         }
2808         if (SvREADONLY(sv) && !SvOK(sv)) {
2809             if (ckWARN(WARN_UNINITIALIZED))
2810                 report_uninit(sv);
2811             if (lp)
2812                 *lp = 0;
2813             return (char *)"";
2814         }
2815     }
2816     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2817         /* I'm assuming that if both IV and NV are equally valid then
2818            converting the IV is going to be more efficient */
2819         const U32 isUIOK = SvIsUV(sv);
2820         char buf[TYPE_CHARS(UV)];
2821         char *ebuf, *ptr;
2822         STRLEN len;
2823
2824         if (SvTYPE(sv) < SVt_PVIV)
2825             sv_upgrade(sv, SVt_PVIV);
2826         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2827         len = ebuf - ptr;
2828         /* inlined from sv_setpvn */
2829         s = SvGROW_mutable(sv, len + 1);
2830         Move(ptr, s, len, char);
2831         s += len;
2832         *s = '\0';
2833     }
2834     else if (SvNOKp(sv)) {
2835         const int olderrno = errno;
2836         if (SvTYPE(sv) < SVt_PVNV)
2837             sv_upgrade(sv, SVt_PVNV);
2838         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2839         s = SvGROW_mutable(sv, NV_DIG + 20);
2840         /* some Xenix systems wipe out errno here */
2841 #ifdef apollo
2842         if (SvNVX(sv) == 0.0)
2843             my_strlcpy(s, "0", SvLEN(sv));
2844         else
2845 #endif /*apollo*/
2846         {
2847             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2848         }
2849         errno = olderrno;
2850 #ifdef FIXNEGATIVEZERO
2851         if (*s == '-' && s[1] == '0' && !s[2]) {
2852             s[0] = '0';
2853             s[1] = 0;
2854         }
2855 #endif
2856         while (*s) s++;
2857 #ifdef hcx
2858         if (s[-1] == '.')
2859             *--s = '\0';
2860 #endif
2861     }
2862     else {
2863         if (isGV_with_GP(sv))
2864             return glob_2pv((GV *)sv, lp);
2865
2866         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2867             report_uninit(sv);
2868         if (lp)
2869             *lp = 0;
2870         if (SvTYPE(sv) < SVt_PV)
2871             /* Typically the caller expects that sv_any is not NULL now.  */
2872             sv_upgrade(sv, SVt_PV);
2873         return (char *)"";
2874     }
2875     {
2876         const STRLEN len = s - SvPVX_const(sv);
2877         if (lp) 
2878             *lp = len;
2879         SvCUR_set(sv, len);
2880     }
2881     SvPOK_on(sv);
2882     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2883                           PTR2UV(sv),SvPVX_const(sv)));
2884     if (flags & SV_CONST_RETURN)
2885         return (char *)SvPVX_const(sv);
2886     if (flags & SV_MUTABLE_RETURN)
2887         return SvPVX_mutable(sv);
2888     return SvPVX(sv);
2889 }
2890
2891 /*
2892 =for apidoc sv_copypv
2893
2894 Copies a stringified representation of the source SV into the
2895 destination SV.  Automatically performs any necessary mg_get and
2896 coercion of numeric values into strings.  Guaranteed to preserve
2897 UTF8 flag even from overloaded objects.  Similar in nature to
2898 sv_2pv[_flags] but operates directly on an SV instead of just the
2899 string.  Mostly uses sv_2pv_flags to do its work, except when that
2900 would lose the UTF-8'ness of the PV.
2901
2902 =cut
2903 */
2904
2905 void
2906 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2907 {
2908     STRLEN len;
2909     const char * const s = SvPV_const(ssv,len);
2910     sv_setpvn(dsv,s,len);
2911     if (SvUTF8(ssv))
2912         SvUTF8_on(dsv);
2913     else
2914         SvUTF8_off(dsv);
2915 }
2916
2917 /*
2918 =for apidoc sv_2pvbyte
2919
2920 Return a pointer to the byte-encoded representation of the SV, and set *lp
2921 to its length.  May cause the SV to be downgraded from UTF-8 as a
2922 side-effect.
2923
2924 Usually accessed via the C<SvPVbyte> macro.
2925
2926 =cut
2927 */
2928
2929 char *
2930 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2931 {
2932     sv_utf8_downgrade(sv,0);
2933     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2934 }
2935
2936 /*
2937 =for apidoc sv_2pvutf8
2938
2939 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2940 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2941
2942 Usually accessed via the C<SvPVutf8> macro.
2943
2944 =cut
2945 */
2946
2947 char *
2948 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2949 {
2950     sv_utf8_upgrade(sv);
2951     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2952 }
2953
2954
2955 /*
2956 =for apidoc sv_2bool
2957
2958 This function is only called on magical items, and is only used by
2959 sv_true() or its macro equivalent.
2960
2961 =cut
2962 */
2963
2964 bool
2965 Perl_sv_2bool(pTHX_ register SV *sv)
2966 {
2967     dVAR;
2968     SvGETMAGIC(sv);
2969
2970     if (!SvOK(sv))
2971         return 0;
2972     if (SvROK(sv)) {
2973         if (SvAMAGIC(sv)) {
2974             SV * const tmpsv = AMG_CALLun(sv,bool_);
2975             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2976                 return (bool)SvTRUE(tmpsv);
2977         }
2978         return SvRV(sv) != 0;
2979     }
2980     if (SvPOKp(sv)) {
2981         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2982         if (Xpvtmp &&
2983                 (*sv->sv_u.svu_pv > '0' ||
2984                 Xpvtmp->xpv_cur > 1 ||
2985                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2986             return 1;
2987         else
2988             return 0;
2989     }
2990     else {
2991         if (SvIOKp(sv))
2992             return SvIVX(sv) != 0;
2993         else {
2994             if (SvNOKp(sv))
2995                 return SvNVX(sv) != 0.0;
2996             else {
2997                 if (isGV_with_GP(sv))
2998                     return TRUE;
2999                 else
3000                     return FALSE;
3001             }
3002         }
3003     }
3004 }
3005
3006 /*
3007 =for apidoc sv_utf8_upgrade
3008
3009 Converts the PV of an SV to its UTF-8-encoded form.
3010 Forces the SV to string form if it is not already.
3011 Always sets the SvUTF8 flag to avoid future validity checks even
3012 if all the bytes have hibit clear.
3013
3014 This is not as a general purpose byte encoding to Unicode interface:
3015 use the Encode extension for that.
3016
3017 =for apidoc sv_utf8_upgrade_flags
3018
3019 Converts the PV of an SV to its UTF-8-encoded form.
3020 Forces the SV to string form if it is not already.
3021 Always sets the SvUTF8 flag to avoid future validity checks even
3022 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3023 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3024 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3025
3026 This is not as a general purpose byte encoding to Unicode interface:
3027 use the Encode extension for that.
3028
3029 =cut
3030 */
3031
3032 STRLEN
3033 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3034 {
3035     dVAR;
3036     if (sv == &PL_sv_undef)
3037         return 0;
3038     if (!SvPOK(sv)) {
3039         STRLEN len = 0;
3040         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3041             (void) sv_2pv_flags(sv,&len, flags);
3042             if (SvUTF8(sv))
3043                 return len;
3044         } else {
3045             (void) SvPV_force(sv,len);
3046         }
3047     }
3048
3049     if (SvUTF8(sv)) {
3050         return SvCUR(sv);
3051     }
3052
3053     if (SvIsCOW(sv)) {
3054         sv_force_normal_flags(sv, 0);
3055     }
3056
3057     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3058         sv_recode_to_utf8(sv, PL_encoding);
3059     else { /* Assume Latin-1/EBCDIC */
3060         /* This function could be much more efficient if we
3061          * had a FLAG in SVs to signal if there are any hibit
3062          * chars in the PV.  Given that there isn't such a flag
3063          * make the loop as fast as possible. */
3064         const U8 * const s = (U8 *) SvPVX_const(sv);
3065         const U8 * const e = (U8 *) SvEND(sv);
3066         const U8 *t = s;
3067         
3068         while (t < e) {
3069             const U8 ch = *t++;
3070             /* Check for hi bit */
3071             if (!NATIVE_IS_INVARIANT(ch)) {
3072                 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3073                 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3074
3075                 SvPV_free(sv); /* No longer using what was there before. */
3076                 SvPV_set(sv, (char*)recoded);
3077                 SvCUR_set(sv, len - 1);
3078                 SvLEN_set(sv, len); /* No longer know the real size. */
3079                 break;
3080             }
3081         }
3082         /* Mark as UTF-8 even if no hibit - saves scanning loop */
3083         SvUTF8_on(sv);
3084     }
3085     return SvCUR(sv);
3086 }
3087
3088 /*
3089 =for apidoc sv_utf8_downgrade
3090
3091 Attempts to convert the PV of an SV from characters to bytes.
3092 If the PV contains a character beyond byte, this conversion will fail;
3093 in this case, either returns false or, if C<fail_ok> is not
3094 true, croaks.
3095
3096 This is not as a general purpose Unicode to byte encoding interface:
3097 use the Encode extension for that.
3098
3099 =cut
3100 */
3101
3102 bool
3103 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3104 {
3105     dVAR;
3106     if (SvPOKp(sv) && SvUTF8(sv)) {
3107         if (SvCUR(sv)) {
3108             U8 *s;
3109             STRLEN len;
3110
3111             if (SvIsCOW(sv)) {
3112                 sv_force_normal_flags(sv, 0);
3113             }
3114             s = (U8 *) SvPV(sv, len);
3115             if (!utf8_to_bytes(s, &len)) {
3116                 if (fail_ok)
3117                     return FALSE;
3118                 else {
3119                     if (PL_op)
3120                         Perl_croak(aTHX_ "Wide character in %s",
3121                                    OP_DESC(PL_op));
3122                     else
3123                         Perl_croak(aTHX_ "Wide character");
3124                 }
3125             }
3126             SvCUR_set(sv, len);
3127         }
3128     }
3129     SvUTF8_off(sv);
3130     return TRUE;
3131 }
3132
3133 /*
3134 =for apidoc sv_utf8_encode
3135
3136 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3137 flag off so that it looks like octets again.
3138
3139 =cut
3140 */
3141
3142 void
3143 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3144 {
3145     if (SvIsCOW(sv)) {
3146         sv_force_normal_flags(sv, 0);
3147     }
3148     if (SvREADONLY(sv)) {
3149         Perl_croak(aTHX_ PL_no_modify);
3150     }
3151     (void) sv_utf8_upgrade(sv);
3152     SvUTF8_off(sv);
3153 }
3154
3155 /*
3156 =for apidoc sv_utf8_decode
3157
3158 If the PV of the SV is an octet sequence in UTF-8
3159 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3160 so that it looks like a character. If the PV contains only single-byte
3161 characters, the C<SvUTF8> flag stays being off.
3162 Scans PV for validity and returns false if the PV is invalid UTF-8.
3163
3164 =cut
3165 */
3166
3167 bool
3168 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3169 {
3170     if (SvPOKp(sv)) {
3171         const U8 *c;
3172         const U8 *e;
3173
3174         /* The octets may have got themselves encoded - get them back as
3175          * bytes
3176          */
3177         if (!sv_utf8_downgrade(sv, TRUE))
3178             return FALSE;
3179
3180         /* it is actually just a matter of turning the utf8 flag on, but
3181          * we want to make sure everything inside is valid utf8 first.
3182          */
3183         c = (const U8 *) SvPVX_const(sv);
3184         if (!is_utf8_string(c, SvCUR(sv)+1))
3185             return FALSE;
3186         e = (const U8 *) SvEND(sv);
3187         while (c < e) {
3188             const U8 ch = *c++;
3189             if (!UTF8_IS_INVARIANT(ch)) {
3190                 SvUTF8_on(sv);
3191                 break;
3192             }
3193         }
3194     }
3195     return TRUE;
3196 }
3197
3198 /*
3199 =for apidoc sv_setsv
3200
3201 Copies the contents of the source SV C<ssv> into the destination SV
3202 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3203 function if the source SV needs to be reused. Does not handle 'set' magic.
3204 Loosely speaking, it performs a copy-by-value, obliterating any previous
3205 content of the destination.
3206
3207 You probably want to use one of the assortment of wrappers, such as
3208 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3209 C<SvSetMagicSV_nosteal>.
3210
3211 =for apidoc sv_setsv_flags
3212
3213 Copies the contents of the source SV C<ssv> into the destination SV
3214 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3215 function if the source SV needs to be reused. Does not handle 'set' magic.
3216 Loosely speaking, it performs a copy-by-value, obliterating any previous
3217 content of the destination.
3218 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3219 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3220 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3221 and C<sv_setsv_nomg> are implemented in terms of this function.
3222
3223 You probably want to use one of the assortment of wrappers, such as
3224 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3225 C<SvSetMagicSV_nosteal>.
3226
3227 This is the primary function for copying scalars, and most other
3228 copy-ish functions and macros use this underneath.
3229
3230 =cut
3231 */
3232
3233 static void
3234 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3235 {
3236     I32 mro_changes = 0; /* 1 = method, 2 = isa */
3237
3238     if (dtype != SVt_PVGV) {
3239         const char * const name = GvNAME(sstr);
3240         const STRLEN len = GvNAMELEN(sstr);
3241         {
3242             if (dtype >= SVt_PV) {
3243                 SvPV_free(dstr);
3244                 SvPV_set(dstr, 0);
3245                 SvLEN_set(dstr, 0);
3246                 SvCUR_set(dstr, 0);
3247             }
3248             SvUPGRADE(dstr, SVt_PVGV);
3249             (void)SvOK_off(dstr);
3250             /* FIXME - why are we doing this, then turning it off and on again
3251                below?  */
3252             isGV_with_GP_on(dstr);
3253         }
3254         GvSTASH(dstr) = GvSTASH(sstr);
3255         if (GvSTASH(dstr))
3256             Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3257         gv_name_set((GV *)dstr, name, len, GV_ADD);
3258         SvFAKE_on(dstr);        /* can coerce to non-glob */
3259     }
3260
3261 #ifdef GV_UNIQUE_CHECK
3262     if (GvUNIQUE((GV*)dstr)) {
3263         Perl_croak(aTHX_ PL_no_modify);
3264     }
3265 #endif
3266
3267     if(GvGP((GV*)sstr)) {
3268         /* If source has method cache entry, clear it */
3269         if(GvCVGEN(sstr)) {
3270             SvREFCNT_dec(GvCV(sstr));
3271             GvCV(sstr) = NULL;
3272             GvCVGEN(sstr) = 0;
3273         }
3274         /* If source has a real method, then a method is
3275            going to change */
3276         else if(GvCV((GV*)sstr)) {
3277             mro_changes = 1;
3278         }
3279     }
3280
3281     /* If dest already had a real method, that's a change as well */
3282     if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3283         mro_changes = 1;
3284     }
3285
3286     if(strEQ(GvNAME((GV*)dstr),"ISA"))
3287         mro_changes = 2;
3288
3289     gp_free((GV*)dstr);
3290     isGV_with_GP_off(dstr);
3291     (void)SvOK_off(dstr);
3292     isGV_with_GP_on(dstr);
3293     GvINTRO_off(dstr);          /* one-shot flag */
3294     GvGP(dstr) = gp_ref(GvGP(sstr));
3295     if (SvTAINTED(sstr))
3296         SvTAINT(dstr);
3297     if (GvIMPORTED(dstr) != GVf_IMPORTED
3298         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3299         {
3300             GvIMPORTED_on(dstr);
3301         }
3302     GvMULTI_on(dstr);
3303     if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3304     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3305     return;
3306 }
3307
3308 static void
3309 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3310     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3311     SV *dref = NULL;
3312     const int intro = GvINTRO(dstr);
3313     SV **location;
3314     U8 import_flag = 0;
3315     const U32 stype = SvTYPE(sref);
3316
3317
3318 #ifdef GV_UNIQUE_CHECK
3319     if (GvUNIQUE((GV*)dstr)) {
3320         Perl_croak(aTHX_ PL_no_modify);
3321     }
3322 #endif
3323
3324     if (intro) {
3325         GvINTRO_off(dstr);      /* one-shot flag */
3326         GvLINE(dstr) = CopLINE(PL_curcop);
3327         GvEGV(dstr) = (GV*)dstr;
3328     }
3329     GvMULTI_on(dstr);
3330     switch (stype) {
3331     case SVt_PVCV:
3332         location = (SV **) &GvCV(dstr);
3333         import_flag = GVf_IMPORTED_CV;
3334         goto common;
3335     case SVt_PVHV:
3336         location = (SV **) &GvHV(dstr);
3337         import_flag = GVf_IMPORTED_HV;
3338         goto common;
3339     case SVt_PVAV:
3340         location = (SV **) &GvAV(dstr);
3341         import_flag = GVf_IMPORTED_AV;
3342         goto common;
3343     case SVt_PVIO:
3344         location = (SV **) &GvIOp(dstr);
3345         goto common;
3346     case SVt_PVFM:
3347         location = (SV **) &GvFORM(dstr);
3348     default:
3349         location = &GvSV(dstr);
3350         import_flag = GVf_IMPORTED_SV;
3351     common:
3352         if (intro) {
3353             if (stype == SVt_PVCV) {
3354                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3355                 if (GvCVGEN(dstr)) {
3356                     SvREFCNT_dec(GvCV(dstr));
3357                     GvCV(dstr) = NULL;
3358                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3359                 }
3360             }
3361             SAVEGENERICSV(*location);
3362         }
3363         else
3364             dref = *location;
3365         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3366             CV* const cv = (CV*)*location;
3367             if (cv) {
3368                 if (!GvCVGEN((GV*)dstr) &&
3369                     (CvROOT(cv) || CvXSUB(cv)))
3370                     {
3371                         /* Redefining a sub - warning is mandatory if
3372                            it was a const and its value changed. */
3373                         if (CvCONST(cv) && CvCONST((CV*)sref)
3374                             && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3375                             NOOP;
3376                             /* They are 2 constant subroutines generated from
3377                                the same constant. This probably means that
3378                                they are really the "same" proxy subroutine
3379                                instantiated in 2 places. Most likely this is
3380                                when a constant is exported twice.  Don't warn.
3381                             */
3382                         }
3383                         else if (ckWARN(WARN_REDEFINE)
3384                                  || (CvCONST(cv)
3385                                      && (!CvCONST((CV*)sref)
3386                                          || sv_cmp(cv_const_sv(cv),
3387                                                    cv_const_sv((CV*)sref))))) {
3388                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3389                                         (const char *)
3390                                         (CvCONST(cv)
3391                                          ? "Constant subroutine %s::%s redefined"
3392                                          : "Subroutine %s::%s redefined"),
3393                                         HvNAME_get(GvSTASH((GV*)dstr)),
3394                                         GvENAME((GV*)dstr));
3395                         }
3396                     }
3397                 if (!intro)
3398                     cv_ckproto_len(cv, (GV*)dstr,
3399                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3400                                    SvPOK(sref) ? SvCUR(sref) : 0);
3401             }
3402             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3403             GvASSUMECV_on(dstr);
3404             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3405         }
3406         *location = sref;
3407         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3408             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3409             GvFLAGS(dstr) |= import_flag;
3410         }
3411         break;
3412     }
3413     SvREFCNT_dec(dref);
3414     if (SvTAINTED(sstr))
3415         SvTAINT(dstr);
3416     return;
3417 }
3418
3419 void
3420 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3421 {
3422     dVAR;
3423     register U32 sflags;
3424     register int dtype;
3425     register svtype stype;
3426
3427     if (sstr == dstr)
3428         return;
3429
3430     if (SvIS_FREED(dstr)) {
3431         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3432                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3433     }
3434     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3435     if (!sstr)
3436         sstr = &PL_sv_undef;
3437     if (SvIS_FREED(sstr)) {
3438         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3439                    (void*)sstr, (void*)dstr);
3440     }
3441     stype = SvTYPE(sstr);
3442     dtype = SvTYPE(dstr);
3443
3444     (void)SvAMAGIC_off(dstr);
3445     if ( SvVOK(dstr) )
3446     {
3447         /* need to nuke the magic */
3448         mg_free(dstr);
3449         SvRMAGICAL_off(dstr);
3450     }
3451
3452     /* There's a lot of redundancy below but we're going for speed here */
3453
3454     switch (stype) {
3455     case SVt_NULL:
3456       undef_sstr:
3457         if (dtype != SVt_PVGV) {
3458             (void)SvOK_off(dstr);
3459             return;
3460         }
3461         break;
3462     case SVt_IV:
3463         if (SvIOK(sstr)) {
3464             switch (dtype) {
3465             case SVt_NULL:
3466                 sv_upgrade(dstr, SVt_IV);
3467                 break;
3468             case SVt_NV:
3469             case SVt_PV:
3470                 sv_upgrade(dstr, SVt_PVIV);
3471                 break;
3472             case SVt_PVGV:
3473                 goto end_of_first_switch;
3474             }
3475             (void)SvIOK_only(dstr);
3476             SvIV_set(dstr,  SvIVX(sstr));
3477             if (SvIsUV(sstr))
3478                 SvIsUV_on(dstr);
3479             /* SvTAINTED can only be true if the SV has taint magic, which in
3480                turn means that the SV type is PVMG (or greater). This is the
3481                case statement for SVt_IV, so this cannot be true (whatever gcov
3482                may say).  */
3483             assert(!SvTAINTED(sstr));
3484             return;
3485         }
3486         if (!SvROK(sstr))
3487             goto undef_sstr;
3488         if (dtype < SVt_PV && dtype != SVt_IV)
3489             sv_upgrade(dstr, SVt_IV);
3490         break;
3491
3492     case SVt_NV:
3493         if (SvNOK(sstr)) {
3494             switch (dtype) {
3495             case SVt_NULL:
3496             case SVt_IV:
3497                 sv_upgrade(dstr, SVt_NV);
3498                 break;
3499             case SVt_PV:
3500             case SVt_PVIV:
3501                 sv_upgrade(dstr, SVt_PVNV);
3502                 break;
3503             case SVt_PVGV:
3504                 goto end_of_first_switch;
3505             }
3506             SvNV_set(dstr, SvNVX(sstr));
3507             (void)SvNOK_only(dstr);
3508             /* SvTAINTED can only be true if the SV has taint magic, which in
3509                turn means that the SV type is PVMG (or greater). This is the
3510                case statement for SVt_NV, so this cannot be true (whatever gcov
3511                may say).  */
3512             assert(!SvTAINTED(sstr));
3513             return;
3514         }
3515         goto undef_sstr;
3516
3517     case SVt_PVFM:
3518 #ifdef PERL_OLD_COPY_ON_WRITE
3519         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3520             if (dtype < SVt_PVIV)
3521                 sv_upgrade(dstr, SVt_PVIV);
3522             break;
3523         }
3524         /* Fall through */
3525 #endif
3526     case SVt_REGEXP:
3527     case SVt_PV:
3528         if (dtype < SVt_PV)
3529             sv_upgrade(dstr, SVt_PV);
3530         break;
3531     case SVt_PVIV:
3532         if (dtype < SVt_PVIV)
3533             sv_upgrade(dstr, SVt_PVIV);
3534         break;
3535     case SVt_PVNV:
3536         if (dtype < SVt_PVNV)
3537             sv_upgrade(dstr, SVt_PVNV);
3538         break;
3539     default:
3540         {
3541         const char * const type = sv_reftype(sstr,0);
3542         if (PL_op)
3543             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3544         else
3545             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3546         }
3547         break;
3548
3549         /* case SVt_BIND: */
3550     case SVt_PVLV:
3551     case SVt_PVGV:
3552         if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3553             glob_assign_glob(dstr, sstr, dtype);
3554             return;
3555         }
3556         /* SvVALID means that this PVGV is playing at being an FBM.  */
3557         /*FALLTHROUGH*/
3558
3559     case SVt_PVMG:
3560         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3561             mg_get(sstr);
3562             if (SvTYPE(sstr) != stype) {
3563                 stype = SvTYPE(sstr);
3564                 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3565                     glob_assign_glob(dstr, sstr, dtype);
3566                     return;
3567                 }
3568             }
3569         }
3570         if (stype == SVt_PVLV)
3571             SvUPGRADE(dstr, SVt_PVNV);
3572         else
3573             SvUPGRADE(dstr, (svtype)stype);
3574     }
3575  end_of_first_switch:
3576
3577     /* dstr may have been upgraded.  */
3578     dtype = SvTYPE(dstr);
3579     sflags = SvFLAGS(sstr);
3580
3581     if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3582         /* Assigning to a subroutine sets the prototype.  */
3583         if (SvOK(sstr)) {
3584             STRLEN len;
3585             const char *const ptr = SvPV_const(sstr, len);
3586
3587             SvGROW(dstr, len + 1);
3588             Copy(ptr, SvPVX(dstr), len + 1, char);
3589             SvCUR_set(dstr, len);
3590             SvPOK_only(dstr);
3591             SvFLAGS(dstr) |= sflags & SVf_UTF8;
3592         } else {
3593             SvOK_off(dstr);
3594         }
3595     } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3596         const char * const type = sv_reftype(dstr,0);
3597         if (PL_op)
3598             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3599         else
3600             Perl_croak(aTHX_ "Cannot copy to %s", type);
3601     } else if (sflags & SVf_ROK) {
3602         if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3603             && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3604             sstr = SvRV(sstr);
3605             if (sstr == dstr) {
3606                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3607                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3608                 {
3609                     GvIMPORTED_on(dstr);
3610                 }
3611                 GvMULTI_on(dstr);
3612                 return;
3613             }
3614             glob_assign_glob(dstr, sstr, dtype);
3615             return;
3616         }
3617
3618         if (dtype >= SVt_PV) {
3619             if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3620                 glob_assign_ref(dstr, sstr);
3621                 return;
3622             }
3623             if (SvPVX_const(dstr)) {
3624                 SvPV_free(dstr);
3625                 SvLEN_set(dstr, 0);
3626                 SvCUR_set(dstr, 0);
3627             }
3628         }
3629         (void)SvOK_off(dstr);
3630         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3631         SvFLAGS(dstr) |= sflags & SVf_ROK;
3632         assert(!(sflags & SVp_NOK));
3633         assert(!(sflags & SVp_IOK));
3634         assert(!(sflags & SVf_NOK));
3635         assert(!(sflags & SVf_IOK));
3636     }
3637     else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3638         if (!(sflags & SVf_OK)) {
3639             if (ckWARN(WARN_MISC))
3640                 Perl_warner(aTHX_ packWARN(WARN_MISC),
3641                             "Undefined value assigned to typeglob");
3642         }
3643         else {
3644             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3645             if (dstr != (SV*)gv) {
3646                 if (GvGP(dstr))
3647                     gp_free((GV*)dstr);
3648                 GvGP(dstr) = gp_ref(GvGP(gv));
3649             }
3650         }
3651     }
3652     else if (sflags & SVp_POK) {
3653         bool isSwipe = 0;
3654
3655         /*
3656          * Check to see if we can just swipe the string.  If so, it's a
3657          * possible small lose on short strings, but a big win on long ones.
3658          * It might even be a win on short strings if SvPVX_const(dstr)
3659          * has to be allocated and SvPVX_const(sstr) has to be freed.
3660          * Likewise if we can set up COW rather than doing an actual copy, we
3661          * drop to the else clause, as the swipe code and the COW setup code
3662          * have much in common.
3663          */
3664
3665         /* Whichever path we take through the next code, we want this true,
3666            and doing it now facilitates the COW check.  */
3667         (void)SvPOK_only(dstr);
3668
3669         if (
3670             /* If we're already COW then this clause is not true, and if COW
3671                is allowed then we drop down to the else and make dest COW 
3672                with us.  If caller hasn't said that we're allowed to COW
3673                shared hash keys then we don't do the COW setup, even if the
3674                source scalar is a shared hash key scalar.  */
3675             (((flags & SV_COW_SHARED_HASH_KEYS)
3676                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3677                : 1 /* If making a COW copy is forbidden then the behaviour we
3678                        desire is as if the source SV isn't actually already
3679                        COW, even if it is.  So we act as if the source flags
3680                        are not COW, rather than actually testing them.  */
3681               )
3682 #ifndef PERL_OLD_COPY_ON_WRITE
3683              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3684                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3685                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3686                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3687                 but in turn, it's somewhat dead code, never expected to go
3688                 live, but more kept as a placeholder on how to do it better
3689                 in a newer implementation.  */
3690              /* If we are COW and dstr is a suitable target then we drop down
3691                 into the else and make dest a COW of us.  */
3692              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3693 #endif
3694              )
3695             &&
3696             !(isSwipe =
3697                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3698                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3699                  (!(flags & SV_NOSTEAL)) &&
3700                                         /* and we're allowed to steal temps */
3701                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3702                  SvLEN(sstr)    &&        /* and really is a string */
3703                                 /* and won't be needed again, potentially */
3704               !(PL_op && PL_op->op_type == OP_AASSIGN))
3705 #ifdef PERL_OLD_COPY_ON_WRITE
3706             && ((flags & SV_COW_SHARED_HASH_KEYS)
3707                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3708                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3709                      && SvTYPE(sstr) >= SVt_PVIV))
3710                 : 1)
3711 #endif
3712             ) {
3713             /* Failed the swipe test, and it's not a shared hash key either.
3714                Have to copy the string.  */
3715             STRLEN len = SvCUR(sstr);
3716             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3717             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3718             SvCUR_set(dstr, len);
3719             *SvEND(dstr) = '\0';
3720         } else {
3721             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3722                be true in here.  */
3723             /* Either it's a shared hash key, or it's suitable for
3724                copy-on-write or we can swipe the string.  */
3725             if (DEBUG_C_TEST) {
3726                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3727                 sv_dump(sstr);
3728                 sv_dump(dstr);
3729             }
3730 #ifdef PERL_OLD_COPY_ON_WRITE
3731             if (!isSwipe) {
3732                 /* I believe I should acquire a global SV mutex if
3733                    it's a COW sv (not a shared hash key) to stop
3734                    it going un copy-on-write.
3735                    If the source SV has gone un copy on write between up there
3736                    and down here, then (assert() that) it is of the correct
3737                    form to make it copy on write again */
3738                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3739                     != (SVf_FAKE | SVf_READONLY)) {
3740                     SvREADONLY_on(sstr);
3741                     SvFAKE_on(sstr);
3742                     /* Make the source SV into a loop of 1.
3743                        (about to become 2) */
3744                     SV_COW_NEXT_SV_SET(sstr, sstr);
3745                 }
3746             }
3747 #endif
3748             /* Initial code is common.  */
3749             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3750                 SvPV_free(dstr);
3751             }
3752
3753             if (!isSwipe) {
3754                 /* making another shared SV.  */
3755                 STRLEN cur = SvCUR(sstr);
3756                 STRLEN len = SvLEN(sstr);
3757 #ifdef PERL_OLD_COPY_ON_WRITE
3758                 if (len) {
3759                     assert (SvTYPE(dstr) >= SVt_PVIV);
3760                     /* SvIsCOW_normal */
3761                     /* splice us in between source and next-after-source.  */
3762                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3763                     SV_COW_NEXT_SV_SET(sstr, dstr);
3764                     SvPV_set(dstr, SvPVX_mutable(sstr));
3765                 } else
3766 #endif
3767                 {
3768                     /* SvIsCOW_shared_hash */
3769                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3770                                           "Copy on write: Sharing hash\n"));
3771
3772                     assert (SvTYPE(dstr) >= SVt_PV);
3773                     SvPV_set(dstr,
3774                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3775                 }
3776                 SvLEN_set(dstr, len);
3777                 SvCUR_set(dstr, cur);
3778                 SvREADONLY_on(dstr);
3779                 SvFAKE_on(dstr);
3780                 /* Relesase a global SV mutex.  */
3781             }
3782             else
3783                 {       /* Passes the swipe test.  */
3784                 SvPV_set(dstr, SvPVX_mutable(sstr));
3785                 SvLEN_set(dstr, SvLEN(sstr));
3786                 SvCUR_set(dstr, SvCUR(sstr));
3787
3788                 SvTEMP_off(dstr);
3789                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3790                 SvPV_set(sstr, NULL);
3791                 SvLEN_set(sstr, 0);
3792                 SvCUR_set(sstr, 0);
3793                 SvTEMP_off(sstr);
3794             }
3795         }
3796         if (sflags & SVp_NOK) {
3797             SvNV_set(dstr, SvNVX(sstr));
3798         }
3799         if (sflags & SVp_IOK) {
3800             SvIV_set(dstr, SvIVX(sstr));
3801             /* Must do this otherwise some other overloaded use of 0x80000000
3802                gets confused. I guess SVpbm_VALID */
3803             if (sflags & SVf_IVisUV)
3804                 SvIsUV_on(dstr);
3805         }
3806         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3807         {
3808             const MAGIC * const smg = SvVSTRING_mg(sstr);
3809             if (smg) {
3810                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3811                          smg->mg_ptr, smg->mg_len);
3812                 SvRMAGICAL_on(dstr);
3813             }
3814         }
3815     }
3816     else if (sflags & (SVp_IOK|SVp_NOK)) {
3817         (void)SvOK_off(dstr);
3818         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3819         if (sflags & SVp_IOK) {
3820             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3821             SvIV_set(dstr, SvIVX(sstr));
3822         }
3823         if (sflags & SVp_NOK) {
3824             SvNV_set(dstr, SvNVX(sstr));
3825         }
3826     }
3827     else {
3828         if (isGV_with_GP(sstr)) {
3829             /* This stringification rule for globs is spread in 3 places.
3830                This feels bad. FIXME.  */
3831             const U32 wasfake = sflags & SVf_FAKE;
3832
3833             /* FAKE globs can get coerced, so need to turn this off
3834                temporarily if it is on.  */
3835             SvFAKE_off(sstr);
3836             gv_efullname3(dstr, (GV *)sstr, "*");
3837             SvFLAGS(sstr) |= wasfake;
3838         }
3839         else
3840             (void)SvOK_off(dstr);
3841     }
3842     if (SvTAINTED(sstr))
3843         SvTAINT(dstr);
3844 }
3845
3846 /*
3847 =for apidoc sv_setsv_mg
3848
3849 Like C<sv_setsv>, but also handles 'set' magic.
3850
3851 =cut
3852 */
3853
3854 void
3855 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3856 {
3857     sv_setsv(dstr,sstr);
3858     SvSETMAGIC(dstr);
3859 }
3860
3861 #ifdef PERL_OLD_COPY_ON_WRITE
3862 SV *
3863 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3864 {
3865     STRLEN cur = SvCUR(sstr);
3866     STRLEN len = SvLEN(sstr);
3867     register char *new_pv;
3868
3869     if (DEBUG_C_TEST) {
3870         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3871                       (void*)sstr, (void*)dstr);
3872         sv_dump(sstr);
3873         if (dstr)
3874                     sv_dump(dstr);
3875     }
3876
3877     if (dstr) {
3878         if (SvTHINKFIRST(dstr))
3879             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3880         else if (SvPVX_const(dstr))
3881             Safefree(SvPVX_const(dstr));
3882     }
3883     else
3884         new_SV(dstr);
3885     SvUPGRADE(dstr, SVt_PVIV);
3886
3887     assert (SvPOK(sstr));
3888     assert (SvPOKp(sstr));
3889     assert (!SvIOK(sstr));
3890     assert (!SvIOKp(sstr));
3891     assert (!SvNOK(sstr));
3892     assert (!SvNOKp(sstr));
3893
3894     if (SvIsCOW(sstr)) {
3895
3896         if (SvLEN(sstr) == 0) {
3897             /* source is a COW shared hash key.  */
3898             DEBUG_C(PerlIO_printf(Perl_debug_log,
3899                                   "Fast copy on write: Sharing hash\n"));
3900             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3901             goto common_exit;
3902         }
3903         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3904     } else {
3905         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3906         SvUPGRADE(sstr, SVt_PVIV);
3907         SvREADONLY_on(sstr);
3908         SvFAKE_on(sstr);
3909         DEBUG_C(PerlIO_printf(Perl_debug_log,
3910                               "Fast copy on write: Converting sstr to COW\n"));
3911         SV_COW_NEXT_SV_SET(dstr, sstr);
3912     }
3913     SV_COW_NEXT_SV_SET(sstr, dstr);
3914     new_pv = SvPVX_mutable(sstr);
3915
3916   common_exit:
3917     SvPV_set(dstr, new_pv);
3918     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3919     if (SvUTF8(sstr))
3920         SvUTF8_on(dstr);
3921     SvLEN_set(dstr, len);
3922     SvCUR_set(dstr, cur);
3923     if (DEBUG_C_TEST) {
3924         sv_dump(dstr);
3925     }
3926     return dstr;
3927 }
3928 #endif
3929
3930 /*
3931 =for apidoc sv_setpvn
3932
3933 Copies a string into an SV.  The C<len> parameter indicates the number of
3934 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3935 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3936
3937 =cut
3938 */
3939
3940 void
3941 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3942 {
3943     dVAR;
3944     register char *dptr;
3945
3946     SV_CHECK_THINKFIRST_COW_DROP(sv);
3947     if (!ptr) {
3948         (void)SvOK_off(sv);
3949         return;
3950     }
3951     else {
3952         /* len is STRLEN which is unsigned, need to copy to signed */
3953         const IV iv = len;
3954         if (iv < 0)
3955             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3956     }
3957     SvUPGRADE(sv, SVt_PV);
3958
3959     dptr = SvGROW(sv, len + 1);
3960     Move(ptr,dptr,len,char);
3961     dptr[len] = '\0';
3962     SvCUR_set(sv, len);
3963     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3964     SvTAINT(sv);
3965 }
3966
3967 /*
3968 =for apidoc sv_setpvn_mg
3969
3970 Like C<sv_setpvn>, but also handles 'set' magic.
3971
3972 =cut
3973 */
3974
3975 void
3976 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3977 {
3978     sv_setpvn(sv,ptr,len);
3979     SvSETMAGIC(sv);
3980 }
3981
3982 /*
3983 =for apidoc sv_setpv
3984
3985 Copies a string into an SV.  The string must be null-terminated.  Does not
3986 handle 'set' magic.  See C<sv_setpv_mg>.
3987
3988 =cut
3989 */
3990
3991 void
3992 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3993 {
3994     dVAR;
3995     register STRLEN len;
3996
3997     SV_CHECK_THINKFIRST_COW_DROP(sv);
3998     if (!ptr) {
3999         (void)SvOK_off(sv);
4000         return;
4001     }
4002     len = strlen(ptr);
4003     SvUPGRADE(sv, SVt_PV);
4004
4005     SvGROW(sv, len + 1);
4006     Move(ptr,SvPVX(sv),len+1,char);
4007     SvCUR_set(sv, len);
4008     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4009     SvTAINT(sv);
4010 }
4011
4012 /*
4013 =for apidoc sv_setpv_mg
4014
4015 Like C<sv_setpv>, but also handles 'set' magic.
4016
4017 =cut
4018 */
4019
4020 void
4021 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4022 {
4023     sv_setpv(sv,ptr);
4024     SvSETMAGIC(sv);
4025 }
4026
4027 /*
4028 =for apidoc sv_usepvn_flags
4029
4030 Tells an SV to use C<ptr> to find its string value.  Normally the
4031 string is stored inside the SV but sv_usepvn allows the SV to use an
4032 outside string.  The C<ptr> should point to memory that was allocated
4033 by C<malloc>.  The string length, C<len>, must be supplied.  By default
4034 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4035 so that pointer should not be freed or used by the programmer after
4036 giving it to sv_usepvn, and neither should any pointers from "behind"
4037 that pointer (e.g. ptr + 1) be used.
4038
4039 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4040 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4041 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4042 C<len>, and already meets the requirements for storing in C<SvPVX>)
4043
4044 =cut
4045 */
4046
4047 void
4048 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4049 {
4050     dVAR;
4051     STRLEN allocate;
4052     SV_CHECK_THINKFIRST_COW_DROP(sv);
4053     SvUPGRADE(sv, SVt_PV);
4054     if (!ptr) {
4055         (void)SvOK_off(sv);
4056         if (flags & SV_SMAGIC)
4057             SvSETMAGIC(sv);
4058         return;
4059     }
4060     if (SvPVX_const(sv))
4061         SvPV_free(sv);
4062
4063 #ifdef DEBUGGING
4064     if (flags & SV_HAS_TRAILING_NUL)
4065         assert(ptr[len] == '\0');
4066 #endif
4067
4068     allocate = (flags & SV_HAS_TRAILING_NUL)
4069         ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4070     if (flags & SV_HAS_TRAILING_NUL) {
4071         /* It's long enough - do nothing.
4072            Specfically Perl_newCONSTSUB is relying on this.  */
4073     } else {
4074 #ifdef DEBUGGING
4075         /* Force a move to shake out bugs in callers.  */
4076         char *new_ptr = (char*)safemalloc(allocate);
4077         Copy(ptr, new_ptr, len, char);
4078         PoisonFree(ptr,len,char);
4079         Safefree(ptr);
4080         ptr = new_ptr;
4081 #else
4082         ptr = (char*) saferealloc (ptr, allocate);
4083 #endif
4084     }
4085     SvPV_set(sv, ptr);
4086     SvCUR_set(sv, len);
4087     SvLEN_set(sv, allocate);
4088     if (!(flags & SV_HAS_TRAILING_NUL)) {
4089         ptr[len] = '\0';
4090     }
4091     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4092     SvTAINT(sv);
4093     if (flags & SV_SMAGIC)
4094         SvSETMAGIC(sv);
4095 }
4096
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4098 /* Need to do this *after* making the SV normal, as we need the buffer
4099    pointer to remain valid until after we've copied it.  If we let go too early,
4100    another thread could invalidate it by unsharing last of the same hash key
4101    (which it can do by means other than releasing copy-on-write Svs)
4102    or by changing the other copy-on-write SVs in the loop.  */
4103 STATIC void
4104 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4105 {
4106     { /* this SV was SvIsCOW_normal(sv) */
4107          /* we need to find the SV pointing to us.  */
4108         SV *current = SV_COW_NEXT_SV(after);
4109
4110         if (current == sv) {
4111             /* The SV we point to points back to us (there were only two of us
4112                in the loop.)
4113                Hence other SV is no longer copy on write either.  */
4114             SvFAKE_off(after);
4115             SvREADONLY_off(after);
4116         } else {
4117             /* We need to follow the pointers around the loop.  */
4118             SV *next;
4119             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4120                 assert (next);
4121                 current = next;
4122                  /* don't loop forever if the structure is bust, and we have
4123                     a pointer into a closed loop.  */
4124                 assert (current != after);
4125                 assert (SvPVX_const(current) == pvx);
4126             }
4127             /* Make the SV before us point to the SV after us.  */
4128             SV_COW_NEXT_SV_SET(current, after);
4129         }
4130     }
4131 }
4132 #endif
4133 /*
4134 =for apidoc sv_force_normal_flags
4135
4136 Undo various types of fakery on an SV: if the PV is a shared string, make
4137 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4138 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4139 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4140 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4141 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4142 set to some other value.) In addition, the C<flags> parameter gets passed to
4143 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4144 with flags set to 0.
4145
4146 =cut
4147 */
4148
4149 void
4150 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4151 {
4152     dVAR;
4153 #ifdef PERL_OLD_COPY_ON_WRITE
4154     if (SvREADONLY(sv)) {
4155         /* At this point I believe I should acquire a global SV mutex.  */
4156         if (SvFAKE(sv)) {
4157             const char * const pvx = SvPVX_const(sv);
4158             const STRLEN len = SvLEN(sv);
4159             const STRLEN cur = SvCUR(sv);
4160             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4161                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4162                we'll fail an assertion.  */
4163             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4164
4165             if (DEBUG_C_TEST) {
4166                 PerlIO_printf(Perl_debug_log,
4167                               "Copy on write: Force normal %ld\n",
4168                               (long) flags);
4169                 sv_dump(sv);
4170             }
4171             SvFAKE_off(sv);
4172             SvREADONLY_off(sv);
4173             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4174             SvPV_set(sv, NULL);
4175             SvLEN_set(sv, 0);
4176             if (flags & SV_COW_DROP_PV) {
4177                 /* OK, so we don't need to copy our buffer.  */
4178                 SvPOK_off(sv);
4179             } else {
4180                 SvGROW(sv, cur + 1);
4181                 Move(pvx,SvPVX(sv),cur,char);
4182                 SvCUR_set(sv, cur);
4183                 *SvEND(sv) = '\0';
4184             }
4185             if (len) {
4186                 sv_release_COW(sv, pvx, next);
4187             } else {
4188                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4189             }
4190             if (DEBUG_C_TEST) {
4191                 sv_dump(sv);
4192             }
4193         }
4194         else if (IN_PERL_RUNTIME)
4195             Perl_croak(aTHX_ PL_no_modify);
4196         /* At this point I believe that I can drop the global SV mutex.  */
4197     }
4198 #else
4199     if (SvREADONLY(sv)) {
4200         if (SvFAKE(sv)) {
4201             const char * const pvx = SvPVX_const(sv);
4202             const STRLEN len = SvCUR(sv);
4203             SvFAKE_off(sv);
4204             SvREADONLY_off(sv);
4205             SvPV_set(sv, NULL);
4206             SvLEN_set(sv, 0);
4207             SvGROW(sv, len + 1);
4208             Move(pvx,SvPVX(sv),len,char);
4209             *SvEND(sv) = '\0';
4210             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4211         }
4212         else if (IN_PERL_RUNTIME)
4213             Perl_croak(aTHX_ PL_no_modify);
4214     }
4215 #endif
4216     if (SvROK(sv))
4217         sv_unref_flags(sv, flags);
4218     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4219         sv_unglob(sv);
4220 }
4221
4222 /*
4223 =for apidoc sv_chop
4224
4225 Efficient removal of characters from the beginning of the string buffer.
4226 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4227 the string buffer.  The C<ptr> becomes the first character of the adjusted
4228 string. Uses the "OOK hack".
4229 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4230 refer to the same chunk of data.
4231
4232 =cut
4233 */
4234
4235 void
4236 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4237 {
4238     STRLEN delta;
4239     STRLEN old_delta;
4240     U8 *p;
4241 #ifdef DEBUGGING
4242     const U8 *real_start;
4243 #endif
4244
4245     if (!ptr || !SvPOKp(sv))
4246         return;
4247     delta = ptr - SvPVX_const(sv);
4248     if (!delta) {
4249         /* Nothing to do.  */
4250         return;
4251     }
4252     assert(ptr > SvPVX_const(sv));
4253     SV_CHECK_THINKFIRST(sv);
4254
4255     if (!SvOOK(sv)) {
4256         if (!SvLEN(sv)) { /* make copy of shared string */
4257             const char *pvx = SvPVX_const(sv);
4258             const STRLEN len = SvCUR(sv);
4259             SvGROW(sv, len + 1);
4260             Move(pvx,SvPVX(sv),len,char);
4261             *SvEND(sv) = '\0';
4262         }
4263         SvFLAGS(sv) |= SVf_OOK;
4264         old_delta = 0;
4265     } else {
4266         SvOOK_offset(sv, old_delta);
4267     }
4268     SvLEN_set(sv, SvLEN(sv) - delta);
4269     SvCUR_set(sv, SvCUR(sv) - delta);
4270     SvPV_set(sv, SvPVX(sv) + delta);
4271
4272     p = (U8 *)SvPVX_const(sv);
4273
4274     delta += old_delta;
4275
4276 #ifdef DEBUGGING
4277     real_start = p - delta;
4278 #endif
4279
4280     assert(delta);
4281     if (delta < 0x100) {
4282         *--p = (U8) delta;
4283     } else {
4284         *--p = 0;
4285         p -= sizeof(STRLEN);
4286         Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4287     }
4288
4289 #ifdef DEBUGGING
4290     /* Fill the preceding buffer with sentinals to verify that no-one is
4291        using it.  */
4292     while (p > real_start) {
4293         --p;
4294         *p = (U8)PTR2UV(p);
4295     }
4296 #endif
4297 }
4298
4299 /*
4300 =for apidoc sv_catpvn
4301
4302 Concatenates the string onto the end of the string which is in the SV.  The
4303 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4304 status set, then the bytes appended should be valid UTF-8.
4305 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4306
4307 =for apidoc sv_catpvn_flags
4308
4309 Concatenates the string onto the end of the string which is in the SV.  The
4310 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4311 status set, then the bytes appended should be valid UTF-8.
4312 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4313 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4314 in terms of this function.
4315
4316 =cut
4317 */
4318
4319 void
4320 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4321 {
4322     dVAR;
4323     STRLEN dlen;
4324     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4325
4326     SvGROW(dsv, dlen + slen + 1);
4327     if (sstr == dstr)
4328         sstr = SvPVX_const(dsv);
4329     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4330     SvCUR_set(dsv, SvCUR(dsv) + slen);
4331     *SvEND(dsv) = '\0';
4332     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4333     SvTAINT(dsv);
4334     if (flags & SV_SMAGIC)
4335         SvSETMAGIC(dsv);
4336 }
4337
4338 /*
4339 =for apidoc sv_catsv
4340
4341 Concatenates the string from SV C<ssv> onto the end of the string in
4342 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4343 not 'set' magic.  See C<sv_catsv_mg>.
4344
4345 =for apidoc sv_catsv_flags
4346
4347 Concatenates the string from SV C<ssv> onto the end of the string in
4348 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4349 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4350 and C<sv_catsv_nomg> are implemented in terms of this function.
4351
4352 =cut */
4353
4354 void
4355 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4356 {
4357     dVAR;
4358     if (ssv) {
4359         STRLEN slen;
4360         const char *spv = SvPV_const(ssv, slen);
4361         if (spv) {
4362             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4363                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4364                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4365                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4366                 dsv->sv_flags doesn't have that bit set.
4367                 Andy Dougherty  12 Oct 2001
4368             */
4369             const I32 sutf8 = DO_UTF8(ssv);
4370             I32 dutf8;
4371
4372             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4373                 mg_get(dsv);
4374             dutf8 = DO_UTF8(dsv);
4375
4376             if (dutf8 != sutf8) {
4377                 if (dutf8) {
4378                     /* Not modifying source SV, so taking a temporary copy. */
4379                     SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4380
4381                     sv_utf8_upgrade(csv);
4382                     spv = SvPV_const(csv, slen);
4383                 }
4384                 else
4385                     sv_utf8_upgrade_nomg(dsv);
4386             }
4387             sv_catpvn_nomg(dsv, spv, slen);
4388         }
4389     }
4390     if (flags & SV_SMAGIC)
4391         SvSETMAGIC(dsv);
4392 }
4393
4394 /*
4395 =for apidoc sv_catpv
4396
4397 Concatenates the string onto the end of the string which is in the SV.
4398 If the SV has the UTF-8 status set, then the bytes appended should be
4399 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4400
4401 =cut */
4402
4403 void
4404 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4405 {
4406     dVAR;
4407     register STRLEN len;
4408     STRLEN tlen;
4409     char *junk;
4410
4411     if (!ptr)
4412         return;
4413     junk = SvPV_force(sv, tlen);
4414     len = strlen(ptr);
4415     SvGROW(sv, tlen + len + 1);
4416     if (ptr == junk)
4417         ptr = SvPVX_const(sv);
4418     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4419     SvCUR_set(sv, SvCUR(sv) + len);
4420     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4421     SvTAINT(sv);
4422 }
4423
4424 /*
4425 =for apidoc sv_catpv_mg
4426
4427 Like C<sv_catpv>, but also handles 'set' magic.
4428
4429 =cut
4430 */
4431
4432 void
4433 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4434 {
4435     sv_catpv(sv,ptr);
4436     SvSETMAGIC(sv);
4437 }
4438
4439 /*
4440 =for apidoc newSV
4441
4442 Creates a new SV.  A non-zero C<len> parameter indicates the number of
4443 bytes of preallocated string space the SV should have.  An extra byte for a
4444 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
4445 space is allocated.)  The reference count for the new SV is set to 1.
4446
4447 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4448 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4449 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4450 L<perlhack/PERL_MEM_LOG>).  The older API is still there for use in XS
4451 modules supporting older perls.
4452
4453 =cut
4454 */
4455
4456 SV *
4457 Perl_newSV(pTHX_ STRLEN len)
4458 {
4459     dVAR;
4460     register SV *sv;
4461
4462     new_SV(sv);
4463     if (len) {
4464         sv_upgrade(sv, SVt_PV);
4465         SvGROW(sv, len + 1);
4466     }
4467     return sv;
4468 }
4469 /*
4470 =for apidoc sv_magicext
4471
4472 Adds magic to an SV, upgrading it if necessary. Applies the
4473 supplied vtable and returns a pointer to the magic added.
4474
4475 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4476 In particular, you can add magic to SvREADONLY SVs, and add more than
4477 one instance of the same 'how'.
4478
4479 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4480 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4481 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4482 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4483
4484 (This is now used as a subroutine by C<sv_magic>.)
4485
4486 =cut
4487 */
4488 MAGIC * 
4489 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4490                  const char* name, I32 namlen)
4491 {
4492     dVAR;
4493     MAGIC* mg;
4494
4495     SvUPGRADE(sv, SVt_PVMG);
4496     Newxz(mg, 1, MAGIC);
4497     mg->mg_moremagic = SvMAGIC(sv);
4498     SvMAGIC_set(sv, mg);
4499
4500     /* Sometimes a magic contains a reference loop, where the sv and
4501        object refer to each other.  To prevent a reference loop that
4502        would prevent such objects being freed, we look for such loops
4503        and if we find one we avoid incrementing the object refcount.
4504
4505        Note we cannot do this to avoid self-tie loops as intervening RV must
4506        have its REFCNT incremented to keep it in existence.
4507
4508     */
4509     if (!obj || obj == sv ||
4510         how == PERL_MAGIC_arylen ||
4511         how == PERL_MAGIC_symtab ||
4512         (SvTYPE(obj) == SVt_PVGV &&
4513             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4514             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4515             GvFORM(obj) == (CV*)sv)))
4516     {
4517         mg->mg_obj = obj;
4518     }
4519     else {
4520         mg->mg_obj = SvREFCNT_inc_simple(obj);
4521         mg->mg_flags |= MGf_REFCOUNTED;
4522     }
4523
4524     /* Normal self-ties simply pass a null object, and instead of
4525        using mg_obj directly, use the SvTIED_obj macro to produce a
4526        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4527        with an RV obj pointing to the glob containing the PVIO.  In
4528        this case, to avoid a reference loop, we need to weaken the
4529        reference.
4530     */
4531
4532     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4533         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4534     {
4535       sv_rvweaken(obj);
4536     }
4537
4538     mg->mg_type = how;
4539     mg->mg_len = namlen;
4540     if (name) {
4541         if (namlen > 0)
4542             mg->mg_ptr = savepvn(name, namlen);
4543         else if (namlen == HEf_SVKEY)
4544             mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4545         else
4546             mg->mg_ptr = (char *) name;
4547     }
4548     mg->mg_virtual = (MGVTBL *) vtable;
4549
4550     mg_magical(sv);
4551     if (SvGMAGICAL(sv))
4552         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4553     return mg;
4554 }
4555
4556 /*
4557 =for apidoc sv_magic
4558
4559 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4560 then adds a new magic item of type C<how> to the head of the magic list.
4561
4562 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4563 handling of the C<name> and C<namlen> arguments.
4564
4565 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4566 to add more than one instance of the same 'how'.
4567
4568 =cut
4569 */
4570
4571 void
4572 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4573 {
4574     dVAR;
4575     const MGVTBL *vtable;
4576     MAGIC* mg;
4577
4578 #ifdef PERL_OLD_COPY_ON_WRITE
4579     if (SvIsCOW(sv))
4580         sv_force_normal_flags(sv, 0);
4581 #endif
4582     if (SvREADONLY(sv)) {
4583         if (
4584             /* its okay to attach magic to shared strings; the subsequent
4585              * upgrade to PVMG will unshare the string */
4586             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4587
4588             && IN_PERL_RUNTIME
4589             && how != PERL_MAGIC_regex_global
4590             && how != PERL_MAGIC_bm
4591             && how != PERL_MAGIC_fm
4592             && how != PERL_MAGIC_sv
4593             && how != PERL_MAGIC_backref
4594            )
4595         {
4596             Perl_croak(aTHX_ PL_no_modify);
4597         }
4598     }
4599     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4600         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4601             /* sv_magic() refuses to add a magic of the same 'how' as an
4602                existing one
4603              */
4604             if (how == PERL_MAGIC_taint) {
4605                 mg->mg_len |= 1;
4606                 /* Any scalar which already had taint magic on which someone
4607                    (erroneously?) did SvIOK_on() or similar will now be
4608                    incorrectly sporting public "OK" flags.  */
4609                 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4610             }
4611             return;
4612         }
4613     }
4614
4615     switch (how) {
4616     case PERL_MAGIC_sv:
4617         vtable = &PL_vtbl_sv;
4618         break;
4619     case PERL_MAGIC_overload:
4620         vtable = &PL_vtbl_amagic;
4621         break;
4622     case PERL_MAGIC_overload_elem:
4623         vtable = &PL_vtbl_amagicelem;
4624         break;
4625     case PERL_MAGIC_overload_table:
4626         vtable = &PL_vtbl_ovrld;
4627         break;
4628     case PERL_MAGIC_bm:
4629         vtable = &PL_vtbl_bm;
4630         break;
4631     case PERL_MAGIC_regdata:
4632         vtable = &PL_vtbl_regdata;
4633         break;
4634     case PERL_MAGIC_regdatum:
4635         vtable = &PL_vtbl_regdatum;
4636         break;
4637     case PERL_MAGIC_env:
4638         vtable = &PL_vtbl_env;
4639         break;
4640     case PERL_MAGIC_fm:
4641         vtable = &PL_vtbl_fm;
4642         break;
4643     case PERL_MAGIC_envelem:
4644         vtable = &PL_vtbl_envelem;
4645         break;
4646     case PERL_MAGIC_regex_global:
4647         vtable = &PL_vtbl_mglob;
4648         break;
4649     case PERL_MAGIC_isa:
4650         vtable = &PL_vtbl_isa;
4651         break;
4652     case PERL_MAGIC_isaelem:
4653         vtable = &PL_vtbl_isaelem;
4654         break;
4655     case PERL_MAGIC_nkeys:
4656         vtable = &PL_vtbl_nkeys;
4657         break;
4658     case PERL_MAGIC_dbfile:
4659         vtable = NULL;
4660         break;
4661     case PERL_MAGIC_dbline:
4662         vtable = &PL_vtbl_dbline;
4663         break;
4664 #ifdef USE_LOCALE_COLLATE
4665     case PERL_MAGIC_collxfrm:
4666         vtable = &PL_vtbl_collxfrm;
4667         break;
4668 #endif /* USE_LOCALE_COLLATE */
4669     case PERL_MAGIC_tied:
4670         vtable = &PL_vtbl_pack;
4671         break;
4672     case PERL_MAGIC_tiedelem:
4673     case PERL_MAGIC_tiedscalar:
4674         vtable = &PL_vtbl_packelem;
4675         break;
4676     case PERL_MAGIC_qr:
4677         vtable = &PL_vtbl_regexp;
4678         break;
4679     case PERL_MAGIC_hints:
4680         /* As this vtable is all NULL, we can reuse it.  */
4681     case PERL_MAGIC_sig:
4682         vtable = &PL_vtbl_sig;
4683         break;
4684     case PERL_MAGIC_sigelem:
4685         vtable = &PL_vtbl_sigelem;
4686         break;
4687     case PERL_MAGIC_taint:
4688         vtable = &PL_vtbl_taint;
4689         break;
4690     case PERL_MAGIC_uvar:
4691         vtable = &PL_vtbl_uvar;
4692         break;
4693     case PERL_MAGIC_vec:
4694         vtable = &PL_vtbl_vec;
4695         break;
4696     case PERL_MAGIC_arylen_p:
4697     case PERL_MAGIC_rhash:
4698     case PERL_MAGIC_symtab:
4699     case PERL_MAGIC_vstring:
4700         vtable = NULL;
4701         break;
4702     case PERL_MAGIC_utf8:
4703         vtable = &PL_vtbl_utf8;
4704         break;
4705     case PERL_MAGIC_substr:
4706         vtable = &PL_vtbl_substr;
4707         break;
4708     case PERL_MAGIC_defelem:
4709         vtable = &PL_vtbl_defelem;
4710         break;
4711     case PERL_MAGIC_arylen:
4712         vtable = &PL_vtbl_arylen;
4713         break;
4714     case PERL_MAGIC_pos:
4715         vtable = &PL_vtbl_pos;
4716         break;
4717     case PERL_MAGIC_backref:
4718         vtable = &PL_vtbl_backref;
4719         break;
4720     case PERL_MAGIC_hintselem:
4721         vtable = &PL_vtbl_hintselem;
4722         break;
4723     case PERL_MAGIC_ext:
4724         /* Reserved for use by extensions not perl internals.           */
4725         /* Useful for attaching extension internal data to perl vars.   */
4726         /* Note that multiple extensions may clash if magical scalars   */
4727         /* etc holding private data from one are passed to another.     */
4728         vtable = NULL;
4729         break;
4730     default:
4731         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4732     }
4733
4734     /* Rest of work is done else where */
4735     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4736
4737     switch (how) {
4738     case PERL_MAGIC_taint:
4739         mg->mg_len = 1;
4740         break;
4741     case PERL_MAGIC_ext:
4742     case PERL_MAGIC_dbfile:
4743         SvRMAGICAL_on(sv);
4744         break;
4745     }
4746 }
4747
4748 /*
4749 =for apidoc sv_unmagic
4750
4751 Removes all magic of type C<type> from an SV.
4752
4753 =cut
4754 */
4755
4756 int
4757 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4758 {
4759     MAGIC* mg;
4760     MAGIC** mgp;
4761     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4762         return 0;
4763     mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4764     for (mg = *mgp; mg; mg = *mgp) {
4765         if (mg->mg_type == type) {
4766             const MGVTBL* const vtbl = mg->mg_virtual;
4767             *mgp = mg->mg_moremagic;
4768             if (vtbl && vtbl->svt_free)
4769                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4770             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4771                 if (mg->mg_len > 0)
4772                     Safefree(mg->mg_ptr);
4773                 else if (mg->mg_len == HEf_SVKEY)
4774                     SvREFCNT_dec((SV*)mg->mg_ptr);
4775                 else if (mg->mg_type == PERL_MAGIC_utf8)
4776                     Safefree(mg->mg_ptr);
4777             }
4778             if (mg->mg_flags & MGf_REFCOUNTED)
4779                 SvREFCNT_dec(mg->mg_obj);
4780             Safefree(mg);
4781         }
4782         else
4783    &nbs