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