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