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