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