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