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