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