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