This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
25f14412aa92f8f6594274c26341ed1676b30731
[perl5.git] / sv.c
1 /*    sv.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  * "I wonder what the Entish is for 'yes' and 'no'," he thought.
10  *
11  *
12  * This file contains the code that creates, manipulates and destroys
13  * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14  * structure of an SV, so their creation and destruction is handled
15  * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16  * level functions (eg. substr, split, join) for each of the types are
17  * in the pp*.c files.
18  */
19
20 #include "EXTERN.h"
21 #define PERL_IN_SV_C
22 #include "perl.h"
23 #include "regcomp.h"
24
25 #define FCALL *f
26
27 #ifdef __Lynx__
28 /* Missing proto on LynxOS */
29   char *gconvert(double, int, int,  char *);
30 #endif
31
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35  *   lib/utf8.t lib/Unicode/Collate/t/index.t
36  * --jhi
37  */
38 #   define ASSERT_UTF8_CACHE(cache) \
39     STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40                               assert((cache)[2] <= (cache)[3]); \
41                               assert((cache)[3] <= (cache)[1]);} \
42                               } STMT_END
43 #else
44 #   define ASSERT_UTF8_CACHE(cache) NOOP
45 #endif
46
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
51    on-write.  */
52 #endif
53
54 /* ============================================================================
55
56 =head1 Allocation and deallocation of SVs.
57
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type.  Some types store all they need
62 in the head, so don't have a body.
63
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
69
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
75
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena.  SV-bodies are further described later.
79
80 The following global variables are associated with arenas:
81
82     PL_sv_arenaroot     pointer to list of SV arenas
83     PL_sv_root          pointer to list of free SV structures
84
85     PL_body_arenas      head of linked-list of body arenas
86     PL_body_roots[]     array of pointers to list of free bodies of svtype
87                         arrays are indexed by the svtype needed
88
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
93
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
96
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
102
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
106
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
112
113     sv_report_used() / do_report_used()
114                         dump all remaining SVs (debugging aid)
115
116     sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117                         Attempt to free all objects pointed to by RVs,
118                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119                         try to do the same for all objects indirectly
120                         referenced by typeglobs too.  Called once from
121                         perl_destruct(), prior to calling sv_clean_all()
122                         below.
123
124     sv_clean_all() / do_clean_all()
125                         SvREFCNT_dec(sv) each remaining SV, possibly
126                         triggering an sv_free(). It also sets the
127                         SVf_BREAK flag on the SV to indicate that the
128                         refcnt has been artificially lowered, and thus
129                         stopping sv_free() from giving spurious warnings
130                         about SVs which unexpectedly have a refcnt
131                         of zero.  called repeatedly from perl_destruct()
132                         until there are no SVs left.
133
134 =head2 Arena allocator API Summary
135
136 Private API to rest of sv.c
137
138     new_SV(),  del_SV(),
139
140     new_XIV(), del_XIV(),
141     new_XNV(), del_XNV(),
142     etc
143
144 Public API:
145
146     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
147
148 =cut
149
150 ============================================================================ */
151
152 /*
153  * "A time to plant, and a time to uproot what was planted..."
154  */
155
156 void
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
158 {
159     dVAR;
160     void *new_chunk;
161     U32 new_chunk_size;
162     new_chunk = (void *)(chunk);
163     new_chunk_size = (chunk_size);
164     if (new_chunk_size > PL_nice_chunk_size) {
165         Safefree(PL_nice_chunk);
166         PL_nice_chunk = (char *) new_chunk;
167         PL_nice_chunk_size = new_chunk_size;
168     } else {
169         Safefree(chunk);
170     }
171 }
172
173 #ifdef DEBUG_LEAKING_SCALARS
174 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
175 #else
176 #  define FREE_SV_DEBUG_FILE(sv)
177 #endif
178
179 #ifdef PERL_POISON
180 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
182    unreferenced scalars
183 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
184 */
185 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
186                                 PoisonNew(&SvREFCNT(sv), 1, U32)
187 #else
188 #  define SvARENA_CHAIN(sv)     SvANY(sv)
189 #  define POSION_SV_HEAD(sv)
190 #endif
191
192 #define plant_SV(p) \
193     STMT_START {                                        \
194         FREE_SV_DEBUG_FILE(p);                          \
195         POSION_SV_HEAD(p);                              \
196         SvARENA_CHAIN(p) = (void *)PL_sv_root;          \
197         SvFLAGS(p) = SVTYPEMASK;                        \
198         PL_sv_root = (p);                               \
199         --PL_sv_count;                                  \
200     } STMT_END
201
202 #define uproot_SV(p) \
203     STMT_START {                                        \
204         (p) = PL_sv_root;                               \
205         PL_sv_root = (SV*)SvARENA_CHAIN(p);             \
206         ++PL_sv_count;                                  \
207     } STMT_END
208
209
210 /* make some more SVs by adding another arena */
211
212 STATIC SV*
213 S_more_sv(pTHX)
214 {
215     dVAR;
216     SV* sv;
217
218     if (PL_nice_chunk) {
219         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220         PL_nice_chunk = NULL;
221         PL_nice_chunk_size = 0;
222     }
223     else {
224         char *chunk;                /* must use New here to match call to */
225         Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
226         sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
227     }
228     uproot_SV(sv);
229     return sv;
230 }
231
232 /* new_SV(): return a new, empty SV head */
233
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
236 STATIC SV*
237 S_new_SV(pTHX)
238 {
239     SV* sv;
240
241     if (PL_sv_root)
242         uproot_SV(sv);
243     else
244         sv = S_more_sv(aTHX);
245     SvANY(sv) = 0;
246     SvREFCNT(sv) = 1;
247     SvFLAGS(sv) = 0;
248     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249     sv->sv_debug_line = (U16) (PL_parser
250             ?  PL_parser->copline == NOLINE
251                 ?  PL_curcop
252                     ? CopLINE(PL_curcop)
253                     : 0
254                 : PL_parser->copline
255             : 0);
256     sv->sv_debug_inpad = 0;
257     sv->sv_debug_cloned = 0;
258     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
259     
260     return sv;
261 }
262 #  define new_SV(p) (p)=S_new_SV(aTHX)
263
264 #else
265 #  define new_SV(p) \
266     STMT_START {                                        \
267         if (PL_sv_root)                                 \
268             uproot_SV(p);                               \
269         else                                            \
270             (p) = S_more_sv(aTHX);                      \
271         SvANY(p) = 0;                                   \
272         SvREFCNT(p) = 1;                                \
273         SvFLAGS(p) = 0;                                 \
274     } STMT_END
275 #endif
276
277
278 /* del_SV(): return an empty SV head to the free list */
279
280 #ifdef DEBUGGING
281
282 #define del_SV(p) \
283     STMT_START {                                        \
284         if (DEBUG_D_TEST)                               \
285             del_sv(p);                                  \
286         else                                            \
287             plant_SV(p);                                \
288     } STMT_END
289
290 STATIC void
291 S_del_sv(pTHX_ SV *p)
292 {
293     dVAR;
294     if (DEBUG_D_TEST) {
295         SV* sva;
296         bool ok = 0;
297         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298             const SV * const sv = sva + 1;
299             const SV * const svend = &sva[SvREFCNT(sva)];
300             if (p >= sv && p < svend) {
301                 ok = 1;
302                 break;
303             }
304         }
305         if (!ok) {
306             if (ckWARN_d(WARN_INTERNAL))        
307                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308                             "Attempt to free non-arena SV: 0x%"UVxf
309                             pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
310             return;
311         }
312     }
313     plant_SV(p);
314 }
315
316 #else /* ! DEBUGGING */
317
318 #define del_SV(p)   plant_SV(p)
319
320 #endif /* DEBUGGING */
321
322
323 /*
324 =head1 SV Manipulation Functions
325
326 =for apidoc sv_add_arena
327
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
330
331 =cut
332 */
333
334 void
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
336 {
337     dVAR;
338     SV* const sva = (SV*)ptr;
339     register SV* sv;
340     register SV* svend;
341
342     /* The first SV in an arena isn't an SV. */
343     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
344     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
345     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
346
347     PL_sv_arenaroot = sva;
348     PL_sv_root = sva + 1;
349
350     svend = &sva[SvREFCNT(sva) - 1];
351     sv = sva + 1;
352     while (sv < svend) {
353         SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
354 #ifdef DEBUGGING
355         SvREFCNT(sv) = 0;
356 #endif
357         /* Must always set typemask because it's always checked in on cleanup
358            when the arenas are walked looking for objects.  */
359         SvFLAGS(sv) = SVTYPEMASK;
360         sv++;
361     }
362     SvARENA_CHAIN(sv) = 0;
363 #ifdef DEBUGGING
364     SvREFCNT(sv) = 0;
365 #endif
366     SvFLAGS(sv) = SVTYPEMASK;
367 }
368
369 /* visit(): call the named function for each non-free SV in the arenas
370  * whose flags field matches the flags/mask args. */
371
372 STATIC I32
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
374 {
375     dVAR;
376     SV* sva;
377     I32 visited = 0;
378
379     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380         register const SV * const svend = &sva[SvREFCNT(sva)];
381         register SV* sv;
382         for (sv = sva + 1; sv < svend; ++sv) {
383             if (SvTYPE(sv) != SVTYPEMASK
384                     && (sv->sv_flags & mask) == flags
385                     && SvREFCNT(sv))
386             {
387                 (FCALL)(aTHX_ sv);
388                 ++visited;
389             }
390         }
391     }
392     return visited;
393 }
394
395 #ifdef DEBUGGING
396
397 /* called by sv_report_used() for each live SV */
398
399 static void
400 do_report_used(pTHX_ SV *sv)
401 {
402     if (SvTYPE(sv) != SVTYPEMASK) {
403         PerlIO_printf(Perl_debug_log, "****\n");
404         sv_dump(sv);
405     }
406 }
407 #endif
408
409 /*
410 =for apidoc sv_report_used
411
412 Dump the contents of all SVs not yet freed. (Debugging aid).
413
414 =cut
415 */
416
417 void
418 Perl_sv_report_used(pTHX)
419 {
420 #ifdef DEBUGGING
421     visit(do_report_used, 0, 0);
422 #else
423     PERL_UNUSED_CONTEXT;
424 #endif
425 }
426
427 /* called by sv_clean_objs() for each live SV */
428
429 static void
430 do_clean_objs(pTHX_ SV *ref)
431 {
432     dVAR;
433     assert (SvROK(ref));
434     {
435         SV * const target = SvRV(ref);
436         if (SvOBJECT(target)) {
437             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438             if (SvWEAKREF(ref)) {
439                 sv_del_backref(target, ref);
440                 SvWEAKREF_off(ref);
441                 SvRV_set(ref, NULL);
442             } else {
443                 SvROK_off(ref);
444                 SvRV_set(ref, NULL);
445                 SvREFCNT_dec(target);
446             }
447         }
448     }
449
450     /* XXX Might want to check arrays, etc. */
451 }
452
453 /* called by sv_clean_objs() for each live SV */
454
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
456 static void
457 do_clean_named_objs(pTHX_ SV *sv)
458 {
459     dVAR;
460     assert(SvTYPE(sv) == SVt_PVGV);
461     assert(isGV_with_GP(sv));
462     if (GvGP(sv)) {
463         if ((
464 #ifdef PERL_DONT_CREATE_GVSV
465              GvSV(sv) &&
466 #endif
467              SvOBJECT(GvSV(sv))) ||
468              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470              /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471              (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
473         {
474             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475             SvFLAGS(sv) |= SVf_BREAK;
476             SvREFCNT_dec(sv);
477         }
478     }
479 }
480 #endif
481
482 /*
483 =for apidoc sv_clean_objs
484
485 Attempt to destroy all objects not yet freed
486
487 =cut
488 */
489
490 void
491 Perl_sv_clean_objs(pTHX)
492 {
493     dVAR;
494     PL_in_clean_objs = TRUE;
495     visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497     /* some barnacles may yet remain, clinging to typeglobs */
498     visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
499 #endif
500     PL_in_clean_objs = FALSE;
501 }
502
503 /* called by sv_clean_all() for each live SV */
504
505 static void
506 do_clean_all(pTHX_ SV *sv)
507 {
508     dVAR;
509     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510     SvFLAGS(sv) |= SVf_BREAK;
511     SvREFCNT_dec(sv);
512 }
513
514 /*
515 =for apidoc sv_clean_all
516
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
520
521 =cut
522 */
523
524 I32
525 Perl_sv_clean_all(pTHX)
526 {
527     dVAR;
528     I32 cleaned;
529     PL_in_clean_all = TRUE;
530     cleaned = visit(do_clean_all, 0,0);
531     PL_in_clean_all = FALSE;
532     return cleaned;
533 }
534
535 /*
536   ARENASETS: a meta-arena implementation which separates arena-info
537   into struct arena_set, which contains an array of struct
538   arena_descs, each holding info for a single arena.  By separating
539   the meta-info from the arena, we recover the 1st slot, formerly
540   borrowed for list management.  The arena_set is about the size of an
541   arena, avoiding the needless malloc overhead of a naive linked-list.
542
543   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544   memory in the last arena-set (1/2 on average).  In trade, we get
545   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546   smaller types).  The recovery of the wasted space allows use of
547   small arenas for large, rare body types,
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 /*
2505 =for apidoc sv_2num
2506
2507 Return an SV with the numeric value of the source SV, doing any necessary
2508 reference or overload conversion.  You must use the C<SvNUM(sv)> macro to
2509 access this function.
2510
2511 =cut
2512 */
2513
2514 SV *
2515 Perl_sv_2num(pTHX_ register SV *sv)
2516 {
2517     if (SvAMAGIC(sv)) {
2518         SV * const tmpsv = AMG_CALLun(sv,numer);
2519         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2520             return sv_2num(tmpsv);
2521     }
2522     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2523 }
2524
2525 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2526  * UV as a string towards the end of buf, and return pointers to start and
2527  * end of it.
2528  *
2529  * We assume that buf is at least TYPE_CHARS(UV) long.
2530  */
2531
2532 static char *
2533 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2534 {
2535     char *ptr = buf + TYPE_CHARS(UV);
2536     char * const ebuf = ptr;
2537     int sign;
2538
2539     if (is_uv)
2540         sign = 0;
2541     else if (iv >= 0) {
2542         uv = iv;
2543         sign = 0;
2544     } else {
2545         uv = -iv;
2546         sign = 1;
2547     }
2548     do {
2549         *--ptr = '0' + (char)(uv % 10);
2550     } while (uv /= 10);
2551     if (sign)
2552         *--ptr = '-';
2553     *peob = ebuf;
2554     return ptr;
2555 }
2556
2557 /*
2558 =for apidoc sv_2pv_flags
2559
2560 Returns a pointer to the string value of an SV, and sets *lp to its length.
2561 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2562 if necessary.
2563 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2564 usually end up here too.
2565
2566 =cut
2567 */
2568
2569 char *
2570 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2571 {
2572     dVAR;
2573     register char *s;
2574
2575     if (!sv) {
2576         if (lp)
2577             *lp = 0;
2578         return (char *)"";
2579     }
2580     if (SvGMAGICAL(sv)) {
2581         if (flags & SV_GMAGIC)
2582             mg_get(sv);
2583         if (SvPOKp(sv)) {
2584             if (lp)
2585                 *lp = SvCUR(sv);
2586             if (flags & SV_MUTABLE_RETURN)
2587                 return SvPVX_mutable(sv);
2588             if (flags & SV_CONST_RETURN)
2589                 return (char *)SvPVX_const(sv);
2590             return SvPVX(sv);
2591         }
2592         if (SvIOKp(sv) || SvNOKp(sv)) {
2593             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2594             STRLEN len;
2595
2596             if (SvIOKp(sv)) {
2597                 len = SvIsUV(sv)
2598                     ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2599                     : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2600             } else {
2601                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2602                 len = strlen(tbuf);
2603             }
2604             assert(!SvROK(sv));
2605             {
2606                 dVAR;
2607
2608 #ifdef FIXNEGATIVEZERO
2609                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2610                     tbuf[0] = '0';
2611                     tbuf[1] = 0;
2612                     len = 1;
2613                 }
2614 #endif
2615                 SvUPGRADE(sv, SVt_PV);
2616                 if (lp)
2617                     *lp = len;
2618                 s = SvGROW_mutable(sv, len + 1);
2619                 SvCUR_set(sv, len);
2620                 SvPOKp_on(sv);
2621                 return (char*)memcpy(s, tbuf, len + 1);
2622             }
2623         }
2624         if (SvROK(sv)) {
2625             goto return_rok;
2626         }
2627         assert(SvTYPE(sv) >= SVt_PVMG);
2628         /* This falls through to the report_uninit near the end of the
2629            function. */
2630     } else if (SvTHINKFIRST(sv)) {
2631         if (SvROK(sv)) {
2632         return_rok:
2633             if (SvAMAGIC(sv)) {
2634                 SV *const tmpstr = AMG_CALLun(sv,string);
2635                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2636                     /* Unwrap this:  */
2637                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2638                      */
2639
2640                     char *pv;
2641                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2642                         if (flags & SV_CONST_RETURN) {
2643                             pv = (char *) SvPVX_const(tmpstr);
2644                         } else {
2645                             pv = (flags & SV_MUTABLE_RETURN)
2646                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2647                         }
2648                         if (lp)
2649                             *lp = SvCUR(tmpstr);
2650                     } else {
2651                         pv = sv_2pv_flags(tmpstr, lp, flags);
2652                     }
2653                     if (SvUTF8(tmpstr))
2654                         SvUTF8_on(sv);
2655                     else
2656                         SvUTF8_off(sv);
2657                     return pv;
2658                 }
2659             }
2660             {
2661                 STRLEN len;
2662                 char *retval;
2663                 char *buffer;
2664                 MAGIC *mg;
2665                 const SV *const referent = (SV*)SvRV(sv);
2666
2667                 if (!referent) {
2668                     len = 7;
2669                     retval = buffer = savepvn("NULLREF", len);
2670                 } else if (SvTYPE(referent) == SVt_PVMG
2671                            && ((SvFLAGS(referent) &
2672                                 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2673                                == (SVs_OBJECT|SVs_SMG))
2674                            && (mg = mg_find(referent, PERL_MAGIC_qr)))
2675                 {
2676                     char *str = NULL;
2677                     I32 haseval = 0;
2678                     U32 flags = 0;
2679                     (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2680                     if (flags & 1)
2681                         SvUTF8_on(sv);
2682                     else
2683                         SvUTF8_off(sv);
2684                     PL_reginterp_cnt += haseval;
2685                     return str;
2686                 } else {
2687                     const char *const typestr = sv_reftype(referent, 0);
2688                     const STRLEN typelen = strlen(typestr);
2689                     UV addr = PTR2UV(referent);
2690                     const char *stashname = NULL;
2691                     STRLEN stashnamelen = 0; /* hush, gcc */
2692                     const char *buffer_end;
2693
2694                     if (SvOBJECT(referent)) {
2695                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2696
2697                         if (name) {
2698                             stashname = HEK_KEY(name);
2699                             stashnamelen = HEK_LEN(name);
2700
2701                             if (HEK_UTF8(name)) {
2702                                 SvUTF8_on(sv);
2703                             } else {
2704                                 SvUTF8_off(sv);
2705                             }
2706                         } else {
2707                             stashname = "__ANON__";
2708                             stashnamelen = 8;
2709                         }
2710                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2711                             + 2 * sizeof(UV) + 2 /* )\0 */;
2712                     } else {
2713                         len = typelen + 3 /* (0x */
2714                             + 2 * sizeof(UV) + 2 /* )\0 */;
2715                     }
2716
2717                     Newx(buffer, len, char);
2718                     buffer_end = retval = buffer + len;
2719
2720                     /* Working backwards  */
2721                     *--retval = '\0';
2722                     *--retval = ')';
2723                     do {
2724                         *--retval = PL_hexdigit[addr & 15];
2725                     } while (addr >>= 4);
2726                     *--retval = 'x';
2727                     *--retval = '0';
2728                     *--retval = '(';
2729
2730                     retval -= typelen;
2731                     memcpy(retval, typestr, typelen);
2732
2733                     if (stashname) {
2734                         *--retval = '=';
2735                         retval -= stashnamelen;
2736                         memcpy(retval, stashname, stashnamelen);
2737                     }
2738                     /* retval may not neccesarily have reached the start of the
2739                        buffer here.  */
2740                     assert (retval >= buffer);
2741
2742                     len = buffer_end - retval - 1; /* -1 for that \0  */
2743                 }
2744                 if (lp)
2745                     *lp = len;
2746                 SAVEFREEPV(buffer);
2747                 return retval;
2748             }
2749         }
2750         if (SvREADONLY(sv) && !SvOK(sv)) {
2751             if (ckWARN(WARN_UNINITIALIZED))
2752                 report_uninit(sv);
2753             if (lp)
2754                 *lp = 0;
2755             return (char *)"";
2756         }
2757     }
2758     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2759         /* I'm assuming that if both IV and NV are equally valid then
2760            converting the IV is going to be more efficient */
2761         const U32 isUIOK = SvIsUV(sv);
2762         char buf[TYPE_CHARS(UV)];
2763         char *ebuf, *ptr;
2764         STRLEN len;
2765
2766         if (SvTYPE(sv) < SVt_PVIV)
2767             sv_upgrade(sv, SVt_PVIV);
2768         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2769         len = ebuf - ptr;
2770         /* inlined from sv_setpvn */
2771         s = SvGROW_mutable(sv, len + 1);
2772         Move(ptr, s, len, char);
2773         s += len;
2774         *s = '\0';
2775     }
2776     else if (SvNOKp(sv)) {
2777         const int olderrno = errno;
2778         if (SvTYPE(sv) < SVt_PVNV)
2779             sv_upgrade(sv, SVt_PVNV);
2780         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2781         s = SvGROW_mutable(sv, NV_DIG + 20);
2782         /* some Xenix systems wipe out errno here */
2783 #ifdef apollo
2784         if (SvNVX(sv) == 0.0)
2785             my_strlcpy(s, "0", SvLEN(sv));
2786         else
2787 #endif /*apollo*/
2788         {
2789             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2790         }
2791         errno = olderrno;
2792 #ifdef FIXNEGATIVEZERO
2793         if (*s == '-' && s[1] == '0' && !s[2]) {
2794             s[0] = '0';
2795             s[1] = 0;
2796         }
2797 #endif
2798         while (*s) s++;
2799 #ifdef hcx
2800         if (s[-1] == '.')
2801             *--s = '\0';
2802 #endif
2803     }
2804     else {
2805         if (isGV_with_GP(sv))
2806             return glob_2pv((GV *)sv, lp);
2807
2808         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2809             report_uninit(sv);
2810         if (lp)
2811             *lp = 0;
2812         if (SvTYPE(sv) < SVt_PV)
2813             /* Typically the caller expects that sv_any is not NULL now.  */
2814             sv_upgrade(sv, SVt_PV);
2815         return (char *)"";
2816     }
2817     {
2818         const STRLEN len = s - SvPVX_const(sv);
2819         if (lp) 
2820             *lp = len;
2821         SvCUR_set(sv, len);
2822     }
2823     SvPOK_on(sv);
2824     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2825                           PTR2UV(sv),SvPVX_const(sv)));
2826     if (flags & SV_CONST_RETURN)
2827         return (char *)SvPVX_const(sv);
2828     if (flags & SV_MUTABLE_RETURN)
2829         return SvPVX_mutable(sv);
2830     return SvPVX(sv);
2831 }
2832
2833 /*
2834 =for apidoc sv_copypv
2835
2836 Copies a stringified representation of the source SV into the
2837 destination SV.  Automatically performs any necessary mg_get and
2838 coercion of numeric values into strings.  Guaranteed to preserve
2839 UTF8 flag even from overloaded objects.  Similar in nature to
2840 sv_2pv[_flags] but operates directly on an SV instead of just the
2841 string.  Mostly uses sv_2pv_flags to do its work, except when that
2842 would lose the UTF-8'ness of the PV.
2843
2844 =cut
2845 */
2846
2847 void
2848 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2849 {
2850     STRLEN len;
2851     const char * const s = SvPV_const(ssv,len);
2852     sv_setpvn(dsv,s,len);
2853     if (SvUTF8(ssv))
2854         SvUTF8_on(dsv);
2855     else
2856         SvUTF8_off(dsv);
2857 }
2858
2859 /*
2860 =for apidoc sv_2pvbyte
2861
2862 Return a pointer to the byte-encoded representation of the SV, and set *lp
2863 to its length.  May cause the SV to be downgraded from UTF-8 as a
2864 side-effect.
2865
2866 Usually accessed via the C<SvPVbyte> macro.
2867
2868 =cut
2869 */
2870
2871 char *
2872 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2873 {
2874     sv_utf8_downgrade(sv,0);
2875     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2876 }
2877
2878 /*
2879 =for apidoc sv_2pvutf8
2880
2881 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2882 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2883
2884 Usually accessed via the C<SvPVutf8> macro.
2885
2886 =cut
2887 */
2888
2889 char *
2890 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2891 {
2892     sv_utf8_upgrade(sv);
2893     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2894 }
2895
2896
2897 /*
2898 =for apidoc sv_2bool
2899
2900 This function is only called on magical items, and is only used by
2901 sv_true() or its macro equivalent.
2902
2903 =cut
2904 */
2905
2906 bool
2907 Perl_sv_2bool(pTHX_ register SV *sv)
2908 {
2909     dVAR;
2910     SvGETMAGIC(sv);
2911
2912     if (!SvOK(sv))
2913         return 0;
2914     if (SvROK(sv)) {
2915         if (SvAMAGIC(sv)) {
2916             SV * const tmpsv = AMG_CALLun(sv,bool_);
2917             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2918                 return (bool)SvTRUE(tmpsv);
2919         }
2920         return SvRV(sv) != 0;
2921     }
2922     if (SvPOKp(sv)) {
2923         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2924         if (Xpvtmp &&
2925                 (*sv->sv_u.svu_pv > '0' ||
2926                 Xpvtmp->xpv_cur > 1 ||
2927                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2928             return 1;
2929         else
2930             return 0;
2931     }
2932     else {
2933         if (SvIOKp(sv))
2934             return SvIVX(sv) != 0;
2935         else {
2936             if (SvNOKp(sv))
2937                 return SvNVX(sv) != 0.0;
2938             else {
2939                 if (isGV_with_GP(sv))
2940                     return TRUE;
2941                 else
2942                     return FALSE;
2943             }
2944         }
2945     }
2946 }
2947
2948 /*
2949 =for apidoc sv_utf8_upgrade
2950
2951 Converts the PV of an SV to its UTF-8-encoded form.
2952 Forces the SV to string form if it is not already.
2953 Always sets the SvUTF8 flag to avoid future validity checks even
2954 if all the bytes have hibit clear.
2955
2956 This is not as a general purpose byte encoding to Unicode interface:
2957 use the Encode extension for that.
2958
2959 =for apidoc sv_utf8_upgrade_flags
2960
2961 Converts the PV of an SV to its UTF-8-encoded form.
2962 Forces the SV to string form if it is not already.
2963 Always sets the SvUTF8 flag to avoid future validity checks even
2964 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2965 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2966 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2967
2968 This is not as a general purpose byte encoding to Unicode interface:
2969 use the Encode extension for that.
2970
2971 =cut
2972 */
2973
2974 STRLEN
2975 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2976 {
2977     dVAR;
2978     if (sv == &PL_sv_undef)
2979         return 0;
2980     if (!SvPOK(sv)) {
2981         STRLEN len = 0;
2982         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2983             (void) sv_2pv_flags(sv,&len, flags);
2984             if (SvUTF8(sv))
2985                 return len;
2986         } else {
2987             (void) SvPV_force(sv,len);
2988         }
2989     }
2990
2991     if (SvUTF8(sv)) {
2992         return SvCUR(sv);
2993     }
2994
2995     if (SvIsCOW(sv)) {
2996         sv_force_normal_flags(sv, 0);
2997     }
2998
2999     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3000         sv_recode_to_utf8(sv, PL_encoding);
3001     else { /* Assume Latin-1/EBCDIC */
3002         /* This function could be much more efficient if we
3003          * had a FLAG in SVs to signal if there are any hibit
3004          * chars in the PV.  Given that there isn't such a flag
3005          * make the loop as fast as possible. */
3006         const U8 * const s = (U8 *) SvPVX_const(sv);
3007         const U8 * const e = (U8 *) SvEND(sv);
3008         const U8 *t = s;
3009         
3010         while (t < e) {
3011             const U8 ch = *t++;
3012             /* Check for hi bit */
3013             if (!NATIVE_IS_INVARIANT(ch)) {
3014                 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3015                 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3016
3017                 SvPV_free(sv); /* No longer using what was there before. */
3018                 SvPV_set(sv, (char*)recoded);
3019                 SvCUR_set(sv, len - 1);
3020                 SvLEN_set(sv, len); /* No longer know the real size. */
3021                 break;
3022             }
3023         }
3024         /* Mark as UTF-8 even if no hibit - saves scanning loop */
3025         SvUTF8_on(sv);
3026     }
3027     return SvCUR(sv);
3028 }
3029
3030 /*
3031 =for apidoc sv_utf8_downgrade
3032
3033 Attempts to convert the PV of an SV from characters to bytes.
3034 If the PV contains a character beyond byte, this conversion will fail;
3035 in this case, either returns false or, if C<fail_ok> is not
3036 true, croaks.
3037
3038 This is not as a general purpose Unicode to byte encoding interface:
3039 use the Encode extension for that.
3040
3041 =cut
3042 */
3043
3044 bool
3045 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3046 {
3047     dVAR;
3048     if (SvPOKp(sv) && SvUTF8(sv)) {
3049         if (SvCUR(sv)) {
3050             U8 *s;
3051             STRLEN len;
3052
3053             if (SvIsCOW(sv)) {
3054                 sv_force_normal_flags(sv, 0);
3055             }
3056             s = (U8 *) SvPV(sv, len);
3057             if (!utf8_to_bytes(s, &len)) {
3058                 if (fail_ok)
3059                     return FALSE;
3060                 else {
3061                     if (PL_op)
3062                         Perl_croak(aTHX_ "Wide character in %s",
3063                                    OP_DESC(PL_op));
3064                     else
3065                         Perl_croak(aTHX_ "Wide character");
3066                 }
3067             }
3068             SvCUR_set(sv, len);
3069         }
3070     }
3071     SvUTF8_off(sv);
3072     return TRUE;
3073 }
3074
3075 /*
3076 =for apidoc sv_utf8_encode
3077
3078 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3079 flag off so that it looks like octets again.
3080
3081 =cut
3082 */
3083
3084 void
3085 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3086 {
3087     if (SvIsCOW(sv)) {
3088         sv_force_normal_flags(sv, 0);
3089     }
3090     if (SvREADONLY(sv)) {
3091         Perl_croak(aTHX_ PL_no_modify);
3092     }
3093     (void) sv_utf8_upgrade(sv);
3094     SvUTF8_off(sv);
3095 }
3096
3097 /*
3098 =for apidoc sv_utf8_decode
3099
3100 If the PV of the SV is an octet sequence in UTF-8
3101 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3102 so that it looks like a character. If the PV contains only single-byte
3103 characters, the C<SvUTF8> flag stays being off.
3104 Scans PV for validity and returns false if the PV is invalid UTF-8.
3105
3106 =cut
3107 */
3108
3109 bool
3110 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3111 {
3112     if (SvPOKp(sv)) {
3113         const U8 *c;
3114         const U8 *e;
3115
3116         /* The octets may have got themselves encoded - get them back as
3117          * bytes
3118          */
3119         if (!sv_utf8_downgrade(sv, TRUE))
3120             return FALSE;
3121
3122         /* it is actually just a matter of turning the utf8 flag on, but
3123          * we want to make sure everything inside is valid utf8 first.
3124          */
3125         c = (const U8 *) SvPVX_const(sv);
3126         if (!is_utf8_string(c, SvCUR(sv)+1))
3127             return FALSE;
3128         e = (const U8 *) SvEND(sv);
3129         while (c < e) {
3130             const U8 ch = *c++;
3131             if (!UTF8_IS_INVARIANT(ch)) {
3132                 SvUTF8_on(sv);
3133                 break;
3134             }
3135         }
3136     }
3137     return TRUE;
3138 }
3139
3140 /*
3141 =for apidoc sv_setsv
3142
3143 Copies the contents of the source SV C<ssv> into the destination SV
3144 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3145 function if the source SV needs to be reused. Does not handle 'set' magic.
3146 Loosely speaking, it performs a copy-by-value, obliterating any previous
3147 content of the destination.
3148
3149 You probably want to use one of the assortment of wrappers, such as
3150 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3151 C<SvSetMagicSV_nosteal>.
3152
3153 =for apidoc sv_setsv_flags
3154
3155 Copies the contents of the source SV C<ssv> into the destination SV
3156 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3157 function if the source SV needs to be reused. Does not handle 'set' magic.
3158 Loosely speaking, it performs a copy-by-value, obliterating any previous
3159 content of the destination.
3160 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3161 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3162 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3163 and C<sv_setsv_nomg> are implemented in terms of this function.
3164
3165 You probably want to use one of the assortment of wrappers, such as
3166 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3167 C<SvSetMagicSV_nosteal>.
3168
3169 This is the primary function for copying scalars, and most other
3170 copy-ish functions and macros use this underneath.
3171
3172 =cut
3173 */
3174
3175 static void
3176 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3177 {
3178     I32 mro_changes = 0; /* 1 = method, 2 = isa */
3179
3180     if (dtype != SVt_PVGV) {
3181         const char * const name = GvNAME(sstr);
3182         const STRLEN len = GvNAMELEN(sstr);
3183         {
3184             if (dtype >= SVt_PV) {
3185                 SvPV_free(dstr);
3186                 SvPV_set(dstr, 0);
3187                 SvLEN_set(dstr, 0);
3188                 SvCUR_set(dstr, 0);
3189             }
3190             SvUPGRADE(dstr, SVt_PVGV);
3191             (void)SvOK_off(dstr);
3192             /* FIXME - why are we doing this, then turning it off and on again
3193                below?  */
3194             isGV_with_GP_on(dstr);
3195         }
3196         GvSTASH(dstr) = GvSTASH(sstr);
3197         if (GvSTASH(dstr))
3198             Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3199         gv_name_set((GV *)dstr, name, len, GV_ADD);
3200         SvFAKE_on(dstr);        /* can coerce to non-glob */
3201     }
3202
3203 #ifdef GV_UNIQUE_CHECK
3204     if (GvUNIQUE((GV*)dstr)) {
3205         Perl_croak(aTHX_ PL_no_modify);
3206     }
3207 #endif
3208
3209     if(GvGP((GV*)sstr)) {
3210         /* If source has method cache entry, clear it */
3211         if(GvCVGEN(sstr)) {
3212             SvREFCNT_dec(GvCV(sstr));
3213             GvCV(sstr) = NULL;
3214             GvCVGEN(sstr) = 0;
3215         }
3216         /* If source has a real method, then a method is
3217            going to change */
3218         else if(GvCV((GV*)sstr)) {
3219             mro_changes = 1;
3220         }
3221     }
3222
3223     /* If dest already had a real method, that's a change as well */
3224     if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3225         mro_changes = 1;
3226     }
3227
3228     if(strEQ(GvNAME((GV*)dstr),"ISA"))
3229         mro_changes = 2;
3230
3231     gp_free((GV*)dstr);
3232     isGV_with_GP_off(dstr);
3233     (void)SvOK_off(dstr);
3234     isGV_with_GP_on(dstr);
3235     GvINTRO_off(dstr);          /* one-shot flag */
3236     GvGP(dstr) = gp_ref(GvGP(sstr));
3237     if (SvTAINTED(sstr))
3238         SvTAINT(dstr);
3239     if (GvIMPORTED(dstr) != GVf_IMPORTED
3240         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3241         {
3242             GvIMPORTED_on(dstr);
3243         }
3244     GvMULTI_on(dstr);
3245     if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3246     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3247     return;
3248 }
3249
3250 static void
3251 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3252     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3253     SV *dref = NULL;
3254     const int intro = GvINTRO(dstr);
3255     SV **location;
3256     U8 import_flag = 0;
3257     const U32 stype = SvTYPE(sref);
3258
3259
3260 #ifdef GV_UNIQUE_CHECK
3261     if (GvUNIQUE((GV*)dstr)) {
3262         Perl_croak(aTHX_ PL_no_modify);
3263     }
3264 #endif
3265
3266     if (intro) {
3267         GvINTRO_off(dstr);      /* one-shot flag */
3268         GvLINE(dstr) = CopLINE(PL_curcop);
3269         GvEGV(dstr) = (GV*)dstr;
3270     }
3271     GvMULTI_on(dstr);
3272     switch (stype) {
3273     case SVt_PVCV:
3274         location = (SV **) &GvCV(dstr);
3275         import_flag = GVf_IMPORTED_CV;
3276         goto common;
3277     case SVt_PVHV:
3278         location = (SV **) &GvHV(dstr);
3279         import_flag = GVf_IMPORTED_HV;
3280         goto common;
3281     case SVt_PVAV:
3282         location = (SV **) &GvAV(dstr);
3283         import_flag = GVf_IMPORTED_AV;
3284         goto common;
3285     case SVt_PVIO:
3286         location = (SV **) &GvIOp(dstr);
3287         goto common;
3288     case SVt_PVFM:
3289         location = (SV **) &GvFORM(dstr);
3290     default:
3291         location = &GvSV(dstr);
3292         import_flag = GVf_IMPORTED_SV;
3293     common:
3294         if (intro) {
3295             if (stype == SVt_PVCV) {
3296                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3297                 if (GvCVGEN(dstr)) {
3298                     SvREFCNT_dec(GvCV(dstr));
3299                     GvCV(dstr) = NULL;
3300                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3301                 }
3302             }
3303             SAVEGENERICSV(*location);
3304         }
3305         else
3306             dref = *location;
3307         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3308             CV* const cv = (CV*)*location;
3309             if (cv) {
3310                 if (!GvCVGEN((GV*)dstr) &&
3311                     (CvROOT(cv) || CvXSUB(cv)))
3312                     {
3313                         /* Redefining a sub - warning is mandatory if
3314                            it was a const and its value changed. */
3315                         if (CvCONST(cv) && CvCONST((CV*)sref)
3316                             && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3317                             NOOP;
3318                             /* They are 2 constant subroutines generated from
3319                                the same constant. This probably means that
3320                                they are really the "same" proxy subroutine
3321                                instantiated in 2 places. Most likely this is
3322                                when a constant is exported twice.  Don't warn.
3323                             */
3324                         }
3325                         else if (ckWARN(WARN_REDEFINE)
3326                                  || (CvCONST(cv)
3327                                      && (!CvCONST((CV*)sref)
3328                                          || sv_cmp(cv_const_sv(cv),
3329                                                    cv_const_sv((CV*)sref))))) {
3330                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3331                                         (const char *)
3332                                         (CvCONST(cv)
3333                                          ? "Constant subroutine %s::%s redefined"
3334                                          : "Subroutine %s::%s redefined"),
3335                                         HvNAME_get(GvSTASH((GV*)dstr)),
3336                                         GvENAME((GV*)dstr));
3337                         }
3338                     }
3339                 if (!intro)
3340                     cv_ckproto_len(cv, (GV*)dstr,
3341                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3342                                    SvPOK(sref) ? SvCUR(sref) : 0);
3343             }
3344             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3345             GvASSUMECV_on(dstr);
3346             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3347         }
3348         *location = sref;
3349         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3350             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3351             GvFLAGS(dstr) |= import_flag;
3352         }
3353         break;
3354     }
3355     SvREFCNT_dec(dref);
3356     if (SvTAINTED(sstr))
3357         SvTAINT(dstr);
3358     return;
3359 }
3360
3361 void
3362 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3363 {
3364     dVAR;
3365     register U32 sflags;
3366     register int dtype;
3367     register svtype stype;
3368
3369     if (sstr == dstr)
3370         return;
3371
3372     if (SvIS_FREED(dstr)) {
3373         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3374                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3375     }
3376     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3377     if (!sstr)
3378         sstr = &PL_sv_undef;
3379     if (SvIS_FREED(sstr)) {
3380         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3381                    (void*)sstr, (void*)dstr);
3382     }
3383     stype = SvTYPE(sstr);
3384     dtype = SvTYPE(dstr);
3385
3386     (void)SvAMAGIC_off(dstr);
3387     if ( SvVOK(dstr) )
3388     {
3389         /* need to nuke the magic */
3390         mg_free(dstr);
3391         SvRMAGICAL_off(dstr);
3392     }
3393
3394     /* There's a lot of redundancy below but we're going for speed here */
3395
3396     switch (stype) {
3397     case SVt_NULL:
3398       undef_sstr:
3399         if (dtype != SVt_PVGV) {
3400             (void)SvOK_off(dstr);
3401             return;
3402         }
3403         break;
3404     case SVt_IV:
3405         if (SvIOK(sstr)) {
3406             switch (dtype) {
3407             case SVt_NULL:
3408                 sv_upgrade(dstr, SVt_IV);
3409                 break;
3410             case SVt_NV:
3411             case SVt_RV:
3412             case SVt_PV:
3413                 sv_upgrade(dstr, SVt_PVIV);
3414                 break;
3415             case SVt_PVGV:
3416                 goto end_of_first_switch;
3417             }
3418             (void)SvIOK_only(dstr);
3419             SvIV_set(dstr,  SvIVX(sstr));
3420             if (SvIsUV(sstr))
3421                 SvIsUV_on(dstr);
3422             /* SvTAINTED can only be true if the SV has taint magic, which in
3423                turn means that the SV type is PVMG (or greater). This is the
3424                case statement for SVt_IV, so this cannot be true (whatever gcov
3425                may say).  */
3426             assert(!SvTAINTED(sstr));
3427             return;
3428         }
3429         goto undef_sstr;
3430
3431     case SVt_NV:
3432         if (SvNOK(sstr)) {
3433             switch (dtype) {
3434             case SVt_NULL:
3435             case SVt_IV:
3436                 sv_upgrade(dstr, SVt_NV);
3437                 break;
3438             case SVt_RV:
3439             case SVt_PV:
3440             case SVt_PVIV:
3441                 sv_upgrade(dstr, SVt_PVNV);
3442                 break;
3443             case SVt_PVGV:
3444                 goto end_of_first_switch;
3445             }
3446             SvNV_set(dstr, SvNVX(sstr));
3447             (void)SvNOK_only(dstr);
3448             /* SvTAINTED can only be true if the SV has taint magic, which in
3449                turn means that the SV type is PVMG (or greater). This is the
3450                case statement for SVt_NV, so this cannot be true (whatever gcov
3451                may say).  */
3452             assert(!SvTAINTED(sstr));
3453             return;
3454         }
3455         goto undef_sstr;
3456
3457     case SVt_RV:
3458         if (dtype < SVt_RV)
3459             sv_upgrade(dstr, SVt_RV);
3460         break;
3461     case SVt_PVFM:
3462 #ifdef PERL_OLD_COPY_ON_WRITE
3463         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3464             if (dtype < SVt_PVIV)
3465                 sv_upgrade(dstr, SVt_PVIV);
3466             break;
3467         }
3468         /* Fall through */
3469 #endif
3470     case SVt_PV:
3471         if (dtype < SVt_PV)
3472             sv_upgrade(dstr, SVt_PV);
3473         break;
3474     case SVt_PVIV:
3475         if (dtype < SVt_PVIV)
3476             sv_upgrade(dstr, SVt_PVIV);
3477         break;
3478     case SVt_PVNV:
3479         if (dtype < SVt_PVNV)
3480             sv_upgrade(dstr, SVt_PVNV);
3481         break;
3482     default:
3483         {
3484         const char * const type = sv_reftype(sstr,0);
3485         if (PL_op)
3486             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3487         else
3488             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3489         }
3490         break;
3491
3492         /* case SVt_BIND: */
3493     case SVt_PVLV:
3494     case SVt_PVGV:
3495         if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3496             glob_assign_glob(dstr, sstr, dtype);
3497             return;
3498         }
3499         /* SvVALID means that this PVGV is playing at being an FBM.  */
3500         /*FALLTHROUGH*/
3501
3502     case SVt_PVMG:
3503         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3504             mg_get(sstr);
3505             if (SvTYPE(sstr) != stype) {
3506                 stype = SvTYPE(sstr);
3507                 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3508                     glob_assign_glob(dstr, sstr, dtype);
3509                     return;
3510                 }
3511             }
3512         }
3513         if (stype == SVt_PVLV)
3514             SvUPGRADE(dstr, SVt_PVNV);
3515         else
3516             SvUPGRADE(dstr, (svtype)stype);
3517     }
3518  end_of_first_switch:
3519
3520     /* dstr may have been upgraded.  */
3521     dtype = SvTYPE(dstr);
3522     sflags = SvFLAGS(sstr);
3523
3524     if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3525         /* Assigning to a subroutine sets the prototype.  */
3526         if (SvOK(sstr)) {
3527             STRLEN len;
3528             const char *const ptr = SvPV_const(sstr, len);
3529
3530             SvGROW(dstr, len + 1);
3531             Copy(ptr, SvPVX(dstr), len + 1, char);
3532             SvCUR_set(dstr, len);
3533             SvPOK_only(dstr);
3534             SvFLAGS(dstr) |= sflags & SVf_UTF8;
3535         } else {
3536             SvOK_off(dstr);
3537         }
3538     } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3539         const char * const type = sv_reftype(dstr,0);
3540         if (PL_op)
3541             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3542         else
3543             Perl_croak(aTHX_ "Cannot copy to %s", type);
3544     } else if (sflags & SVf_ROK) {
3545         if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3546             && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3547             sstr = SvRV(sstr);
3548             if (sstr == dstr) {
3549                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3550                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3551                 {
3552                     GvIMPORTED_on(dstr);
3553                 }
3554                 GvMULTI_on(dstr);
3555                 return;
3556             }
3557             glob_assign_glob(dstr, sstr, dtype);
3558             return;
3559         }
3560
3561         if (dtype >= SVt_PV) {
3562             if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3563                 glob_assign_ref(dstr, sstr);
3564                 return;
3565             }
3566             if (SvPVX_const(dstr)) {
3567                 SvPV_free(dstr);
3568                 SvLEN_set(dstr, 0);
3569                 SvCUR_set(dstr, 0);
3570             }
3571         }
3572         (void)SvOK_off(dstr);
3573         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3574         SvFLAGS(dstr) |= sflags & SVf_ROK;
3575         assert(!(sflags & SVp_NOK));
3576         assert(!(sflags & SVp_IOK));
3577         assert(!(sflags & SVf_NOK));
3578         assert(!(sflags & SVf_IOK));
3579     }
3580     else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3581         if (!(sflags & SVf_OK)) {
3582             if (ckWARN(WARN_MISC))
3583                 Perl_warner(aTHX_ packWARN(WARN_MISC),
3584                             "Undefined value assigned to typeglob");
3585         }
3586         else {
3587             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3588             if (dstr != (SV*)gv) {
3589                 if (GvGP(dstr))
3590                     gp_free((GV*)dstr);
3591                 GvGP(dstr) = gp_ref(GvGP(gv));
3592             }
3593         }
3594     }
3595     else if (sflags & SVp_POK) {
3596         bool isSwipe = 0;
3597
3598         /*
3599          * Check to see if we can just swipe the string.  If so, it's a
3600          * possible small lose on short strings, but a big win on long ones.
3601          * It might even be a win on short strings if SvPVX_const(dstr)
3602          * has to be allocated and SvPVX_const(sstr) has to be freed.
3603          * Likewise if we can set up COW rather than doing an actual copy, we
3604          * drop to the else clause, as the swipe code and the COW setup code
3605          * have much in common.
3606          */
3607
3608         /* Whichever path we take through the next code, we want this true,
3609            and doing it now facilitates the COW check.  */
3610         (void)SvPOK_only(dstr);
3611
3612         if (
3613             /* If we're already COW then this clause is not true, and if COW
3614                is allowed then we drop down to the else and make dest COW 
3615                with us.  If caller hasn't said that we're allowed to COW
3616                shared hash keys then we don't do the COW setup, even if the
3617                source scalar is a shared hash key scalar.  */
3618             (((flags & SV_COW_SHARED_HASH_KEYS)
3619                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3620                : 1 /* If making a COW copy is forbidden then the behaviour we
3621                        desire is as if the source SV isn't actually already
3622                        COW, even if it is.  So we act as if the source flags
3623                        are not COW, rather than actually testing them.  */
3624               )
3625 #ifndef PERL_OLD_COPY_ON_WRITE
3626              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3627                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3628                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3629                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3630                 but in turn, it's somewhat dead code, never expected to go
3631                 live, but more kept as a placeholder on how to do it better
3632                 in a newer implementation.  */
3633              /* If we are COW and dstr is a suitable target then we drop down
3634                 into the else and make dest a COW of us.  */
3635              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3636 #endif
3637              )
3638             &&
3639             !(isSwipe =
3640                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3641                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3642                  (!(flags & SV_NOSTEAL)) &&
3643                                         /* and we're allowed to steal temps */
3644                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3645                  SvLEN(sstr)    &&        /* and really is a string */
3646                                 /* and won't be needed again, potentially */
3647               !(PL_op && PL_op->op_type == OP_AASSIGN))
3648 #ifdef PERL_OLD_COPY_ON_WRITE
3649             && ((flags & SV_COW_SHARED_HASH_KEYS)
3650                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3651                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3652                      && SvTYPE(sstr) >= SVt_PVIV))
3653                 : 1)
3654 #endif
3655             ) {
3656             /* Failed the swipe test, and it's not a shared hash key either.
3657                Have to copy the string.  */
3658             STRLEN len = SvCUR(sstr);
3659             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3660             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3661             SvCUR_set(dstr, len);
3662             *SvEND(dstr) = '\0';
3663         } else {
3664             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3665                be true in here.  */
3666             /* Either it's a shared hash key, or it's suitable for
3667                copy-on-write or we can swipe the string.  */
3668             if (DEBUG_C_TEST) {
3669                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3670                 sv_dump(sstr);
3671                 sv_dump(dstr);
3672             }
3673 #ifdef PERL_OLD_COPY_ON_WRITE
3674             if (!isSwipe) {
3675                 /* I believe I should acquire a global SV mutex if
3676                    it's a COW sv (not a shared hash key) to stop
3677                    it going un copy-on-write.
3678                    If the source SV has gone un copy on write between up there
3679                    and down here, then (assert() that) it is of the correct
3680                    form to make it copy on write again */
3681                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3682                     != (SVf_FAKE | SVf_READONLY)) {
3683                     SvREADONLY_on(sstr);
3684                     SvFAKE_on(sstr);
3685                     /* Make the source SV into a loop of 1.
3686                        (about to become 2) */
3687                     SV_COW_NEXT_SV_SET(sstr, sstr);
3688                 }
3689             }
3690 #endif
3691             /* Initial code is common.  */
3692             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3693                 SvPV_free(dstr);
3694             }
3695
3696             if (!isSwipe) {
3697                 /* making another shared SV.  */
3698                 STRLEN cur = SvCUR(sstr);
3699                 STRLEN len = SvLEN(sstr);
3700 #ifdef PERL_OLD_COPY_ON_WRITE
3701                 if (len) {
3702                     assert (SvTYPE(dstr) >= SVt_PVIV);
3703                     /* SvIsCOW_normal */
3704                     /* splice us in between source and next-after-source.  */
3705                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3706                     SV_COW_NEXT_SV_SET(sstr, dstr);
3707                     SvPV_set(dstr, SvPVX_mutable(sstr));
3708                 } else
3709 #endif
3710                 {
3711                     /* SvIsCOW_shared_hash */
3712                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3713                                           "Copy on write: Sharing hash\n"));
3714
3715                     assert (SvTYPE(dstr) >= SVt_PV);
3716                     SvPV_set(dstr,
3717                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3718                 }
3719                 SvLEN_set(dstr, len);
3720                 SvCUR_set(dstr, cur);
3721                 SvREADONLY_on(dstr);
3722                 SvFAKE_on(dstr);
3723                 /* Relesase a global SV mutex.  */
3724             }
3725             else
3726                 {       /* Passes the swipe test.  */
3727                 SvPV_set(dstr, SvPVX_mutable(sstr));
3728                 SvLEN_set(dstr, SvLEN(sstr));
3729                 SvCUR_set(dstr, SvCUR(sstr));
3730
3731                 SvTEMP_off(dstr);
3732                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3733                 SvPV_set(sstr, NULL);
3734                 SvLEN_set(sstr, 0);
3735                 SvCUR_set(sstr, 0);
3736                 SvTEMP_off(sstr);
3737             }
3738         }
3739         if (sflags & SVp_NOK) {
3740             SvNV_set(dstr, SvNVX(sstr));
3741         }
3742         if (sflags & SVp_IOK) {
3743             SvOOK_off(dstr);
3744             SvIV_set(dstr, SvIVX(sstr));
3745             /* Must do this otherwise some other overloaded use of 0x80000000
3746                gets confused. I guess SVpbm_VALID */
3747             if (sflags & SVf_IVisUV)
3748                 SvIsUV_on(dstr);
3749         }
3750         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3751         {
3752             const MAGIC * const smg = SvVSTRING_mg(sstr);
3753             if (smg) {
3754                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3755                          smg->mg_ptr, smg->mg_len);
3756                 SvRMAGICAL_on(dstr);
3757             }
3758         }
3759     }
3760     else if (sflags & (SVp_IOK|SVp_NOK)) {
3761         (void)SvOK_off(dstr);
3762         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3763         if (sflags & SVp_IOK) {
3764             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3765             SvIV_set(dstr, SvIVX(sstr));
3766         }
3767         if (sflags & SVp_NOK) {
3768             SvNV_set(dstr, SvNVX(sstr));
3769         }
3770     }
3771     else {
3772         if (isGV_with_GP(sstr)) {
3773             /* This stringification rule for globs is spread in 3 places.
3774                This feels bad. FIXME.  */
3775             const U32 wasfake = sflags & SVf_FAKE;
3776
3777             /* FAKE globs can get coerced, so need to turn this off
3778                temporarily if it is on.  */
3779             SvFAKE_off(sstr);
3780             gv_efullname3(dstr, (GV *)sstr, "*");
3781             SvFLAGS(sstr) |= wasfake;
3782         }
3783         else
3784             (void)SvOK_off(dstr);
3785     }
3786     if (SvTAINTED(sstr))
3787         SvTAINT(dstr);
3788 }
3789
3790 /*
3791 =for apidoc sv_setsv_mg
3792
3793 Like C<sv_setsv>, but also handles 'set' magic.
3794
3795 =cut
3796 */
3797
3798 void
3799 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3800 {
3801     sv_setsv(dstr,sstr);
3802     SvSETMAGIC(dstr);
3803 }
3804
3805 #ifdef PERL_OLD_COPY_ON_WRITE
3806 SV *
3807 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3808 {
3809     STRLEN cur = SvCUR(sstr);
3810     STRLEN len = SvLEN(sstr);
3811     register char *new_pv;
3812
3813     if (DEBUG_C_TEST) {
3814         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3815                       (void*)sstr, (void*)dstr);
3816         sv_dump(sstr);
3817         if (dstr)
3818                     sv_dump(dstr);
3819     }
3820
3821     if (dstr) {
3822         if (SvTHINKFIRST(dstr))
3823             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3824         else if (SvPVX_const(dstr))
3825             Safefree(SvPVX_const(dstr));
3826     }
3827     else
3828         new_SV(dstr);
3829     SvUPGRADE(dstr, SVt_PVIV);
3830
3831     assert (SvPOK(sstr));
3832     assert (SvPOKp(sstr));
3833     assert (!SvIOK(sstr));
3834     assert (!SvIOKp(sstr));
3835     assert (!SvNOK(sstr));
3836     assert (!SvNOKp(sstr));
3837
3838     if (SvIsCOW(sstr)) {
3839
3840         if (SvLEN(sstr) == 0) {
3841             /* source is a COW shared hash key.  */
3842             DEBUG_C(PerlIO_printf(Perl_debug_log,
3843                                   "Fast copy on write: Sharing hash\n"));
3844             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3845             goto common_exit;
3846         }
3847         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3848     } else {
3849         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3850         SvUPGRADE(sstr, SVt_PVIV);
3851         SvREADONLY_on(sstr);
3852         SvFAKE_on(sstr);
3853         DEBUG_C(PerlIO_printf(Perl_debug_log,
3854                               "Fast copy on write: Converting sstr to COW\n"));
3855         SV_COW_NEXT_SV_SET(dstr, sstr);
3856     }
3857     SV_COW_NEXT_SV_SET(sstr, dstr);
3858     new_pv = SvPVX_mutable(sstr);
3859
3860   common_exit:
3861     SvPV_set(dstr, new_pv);
3862     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3863     if (SvUTF8(sstr))
3864         SvUTF8_on(dstr);
3865     SvLEN_set(dstr, len);
3866     SvCUR_set(dstr, cur);
3867     if (DEBUG_C_TEST) {
3868         sv_dump(dstr);
3869     }
3870     return dstr;
3871 }
3872 #endif
3873
3874 /*
3875 =for apidoc sv_setpvn
3876
3877 Copies a string into an SV.  The C<len> parameter indicates the number of
3878 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3879 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3880
3881 =cut
3882 */
3883
3884 void
3885 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3886 {
3887     dVAR;
3888     register char *dptr;
3889
3890     SV_CHECK_THINKFIRST_COW_DROP(sv);
3891     if (!ptr) {
3892         (void)SvOK_off(sv);
3893         return;
3894     }
3895     else {
3896         /* len is STRLEN which is unsigned, need to copy to signed */
3897         const IV iv = len;
3898         if (iv < 0)
3899             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3900     }
3901     SvUPGRADE(sv, SVt_PV);
3902
3903     dptr = SvGROW(sv, len + 1);
3904     Move(ptr,dptr,len,char);
3905     dptr[len] = '\0';
3906     SvCUR_set(sv, len);
3907     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3908     SvTAINT(sv);
3909 }
3910
3911 /*
3912 =for apidoc sv_setpvn_mg
3913
3914 Like C<sv_setpvn>, but also handles 'set' magic.
3915
3916 =cut
3917 */
3918
3919 void
3920 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3921 {
3922     sv_setpvn(sv,ptr,len);
3923     SvSETMAGIC(sv);
3924 }
3925
3926 /*
3927 =for apidoc sv_setpv
3928
3929 Copies a string into an SV.  The string must be null-terminated.  Does not
3930 handle 'set' magic.  See C<sv_setpv_mg>.
3931
3932 =cut
3933 */
3934
3935 void
3936 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3937 {
3938     dVAR;
3939     register STRLEN len;
3940
3941     SV_CHECK_THINKFIRST_COW_DROP(sv);
3942     if (!ptr) {
3943         (void)SvOK_off(sv);
3944         return;
3945     }
3946     len = strlen(ptr);
3947     SvUPGRADE(sv, SVt_PV);
3948
3949     SvGROW(sv, len + 1);
3950     Move(ptr,SvPVX(sv),len+1,char);
3951     SvCUR_set(sv, len);
3952     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3953     SvTAINT(sv);
3954 }
3955
3956 /*
3957 =for apidoc sv_setpv_mg
3958
3959 Like C<sv_setpv>, but also handles 'set' magic.
3960
3961 =cut
3962 */
3963
3964 void
3965 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3966 {
3967     sv_setpv(sv,ptr);
3968     SvSETMAGIC(sv);
3969 }
3970
3971 /*
3972 =for apidoc sv_usepvn_flags
3973
3974 Tells an SV to use C<ptr> to find its string value.  Normally the
3975 string is stored inside the SV but sv_usepvn allows the SV to use an
3976 outside string.  The C<ptr> should point to memory that was allocated
3977 by C<malloc>.  The string length, C<len>, must be supplied.  By default
3978 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3979 so that pointer should not be freed or used by the programmer after
3980 giving it to sv_usepvn, and neither should any pointers from "behind"
3981 that pointer (e.g. ptr + 1) be used.
3982
3983 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3984 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3985 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3986 C<len>, and already meets the requirements for storing in C<SvPVX>)
3987
3988 =cut
3989 */
3990
3991 void
3992 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3993 {
3994     dVAR;
3995     STRLEN allocate;
3996     SV_CHECK_THINKFIRST_COW_DROP(sv);
3997     SvUPGRADE(sv, SVt_PV);
3998     if (!ptr) {
3999         (void)SvOK_off(sv);
4000         if (flags & SV_SMAGIC)
4001             SvSETMAGIC(sv);
4002         return;
4003     }
4004     if (SvPVX_const(sv))
4005         SvPV_free(sv);
4006
4007 #ifdef DEBUGGING
4008     if (flags & SV_HAS_TRAILING_NUL)
4009         assert(ptr[len] == '\0');
4010 #endif
4011
4012     allocate = (flags & SV_HAS_TRAILING_NUL)
4013         ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4014     if (flags & SV_HAS_TRAILING_NUL) {
4015         /* It's long enough - do nothing.
4016            Specfically Perl_newCONSTSUB is relying on this.  */
4017     } else {
4018 #ifdef DEBUGGING
4019         /* Force a move to shake out bugs in callers.  */
4020         char *new_ptr = (char*)safemalloc(allocate);
4021         Copy(ptr, new_ptr, len, char);
4022         PoisonFree(ptr,len,char);
4023         Safefree(ptr);
4024         ptr = new_ptr;
4025 #else
4026         ptr = (char*) saferealloc (ptr, allocate);
4027 #endif
4028     }
4029     SvPV_set(sv, ptr);
4030     SvCUR_set(sv, len);
4031     SvLEN_set(sv, allocate);
4032     if (!(flags & SV_HAS_TRAILING_NUL)) {
4033         ptr[len] = '\0';
4034     }
4035     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4036     SvTAINT(sv);
4037     if (flags & SV_SMAGIC)
4038         SvSETMAGIC(sv);
4039 }
4040
4041 #ifdef PERL_OLD_COPY_ON_WRITE
4042 /* Need to do this *after* making the SV normal, as we need the buffer
4043    pointer to remain valid until after we've copied it.  If we let go too early,
4044    another thread could invalidate it by unsharing last of the same hash key
4045    (which it can do by means other than releasing copy-on-write Svs)
4046    or by changing the other copy-on-write SVs in the loop.  */
4047 STATIC void
4048 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4049 {
4050     { /* this SV was SvIsCOW_normal(sv) */
4051          /* we need to find the SV pointing to us.  */
4052         SV *current = SV_COW_NEXT_SV(after);
4053
4054         if (current == sv) {
4055             /* The SV we point to points back to us (there were only two of us
4056                in the loop.)
4057                Hence other SV is no longer copy on write either.  */
4058             SvFAKE_off(after);
4059             SvREADONLY_off(after);
4060         } else {
4061             /* We need to follow the pointers around the loop.  */
4062             SV *next;
4063             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4064                 assert (next);
4065                 current = next;
4066                  /* don't loop forever if the structure is bust, and we have
4067                     a pointer into a closed loop.  */
4068                 assert (current != after);
4069                 assert (SvPVX_const(current) == pvx);
4070             }
4071             /* Make the SV before us point to the SV after us.  */
4072             SV_COW_NEXT_SV_SET(current, after);
4073         }
4074     }
4075 }
4076 #endif
4077 /*
4078 =for apidoc sv_force_normal_flags
4079
4080 Undo various types of fakery on an SV: if the PV is a shared string, make
4081 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4082 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4083 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4084 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4085 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4086 set to some other value.) In addition, the C<flags> parameter gets passed to
4087 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4088 with flags set to 0.
4089
4090 =cut
4091 */
4092
4093 void
4094 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4095 {
4096     dVAR;
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4098     if (SvREADONLY(sv)) {
4099         /* At this point I believe I should acquire a global SV mutex.  */
4100         if (SvFAKE(sv)) {
4101             const char * const pvx = SvPVX_const(sv);
4102             const STRLEN len = SvLEN(sv);
4103             const STRLEN cur = SvCUR(sv);
4104             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4105                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4106                we'll fail an assertion.  */
4107             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4108
4109             if (DEBUG_C_TEST) {
4110                 PerlIO_printf(Perl_debug_log,
4111                               "Copy on write: Force normal %ld\n",
4112                               (long) flags);
4113                 sv_dump(sv);
4114             }
4115             SvFAKE_off(sv);
4116             SvREADONLY_off(sv);
4117             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4118             SvPV_set(sv, NULL);
4119             SvLEN_set(sv, 0);
4120             if (flags & SV_COW_DROP_PV) {
4121                 /* OK, so we don't need to copy our buffer.  */
4122                 SvPOK_off(sv);
4123             } else {
4124                 SvGROW(sv, cur + 1);
4125                 Move(pvx,SvPVX(sv),cur,char);
4126                 SvCUR_set(sv, cur);
4127                 *SvEND(sv) = '\0';
4128             }
4129             if (len) {
4130                 sv_release_COW(sv, pvx, next);
4131             } else {
4132                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4133             }
4134             if (DEBUG_C_TEST) {
4135                 sv_dump(sv);
4136             }
4137         }
4138         else if (IN_PERL_RUNTIME)
4139             Perl_croak(aTHX_ PL_no_modify);
4140         /* At this point I believe that I can drop the global SV mutex.  */
4141     }
4142 #else
4143     if (SvREADONLY(sv)) {
4144         if (SvFAKE(sv)) {
4145             const char * const pvx = SvPVX_const(sv);
4146             const STRLEN len = SvCUR(sv);
4147             SvFAKE_off(sv);
4148             SvREADONLY_off(sv);
4149             SvPV_set(sv, NULL);
4150             SvLEN_set(sv, 0);
4151             SvGROW(sv, len + 1);
4152             Move(pvx,SvPVX(sv),len,char);
4153             *SvEND(sv) = '\0';
4154             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4155         }
4156         else if (IN_PERL_RUNTIME)
4157             Perl_croak(aTHX_ PL_no_modify);
4158     }
4159 #endif
4160     if (SvROK(sv))
4161         sv_unref_flags(sv, flags);
4162     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4163         sv_unglob(sv);
4164 }
4165
4166 /*
4167 =for apidoc sv_chop
4168
4169 Efficient removal of characters from the beginning of the string buffer.
4170 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4171 the string buffer.  The C<ptr> becomes the first character of the adjusted
4172 string. Uses the "OOK hack".
4173 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4174 refer to the same chunk of data.
4175
4176 =cut
4177 */
4178
4179 void
4180 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4181 {
4182     register STRLEN delta;
4183     if (!ptr || !SvPOKp(sv))
4184         return;
4185     delta = ptr - SvPVX_const(sv);
4186     SV_CHECK_THINKFIRST(sv);
4187     if (SvTYPE(sv) < SVt_PVIV)
4188         sv_upgrade(sv,SVt_PVIV);
4189
4190     if (!SvOOK(sv)) {
4191         if (!SvLEN(sv)) { /* make copy of shared string */
4192             const char *pvx = SvPVX_const(sv);
4193             const STRLEN len = SvCUR(sv);
4194             SvGROW(sv, len + 1);
4195             Move(pvx,SvPVX(sv),len,char);
4196             *SvEND(sv) = '\0';
4197         }
4198         SvIV_set(sv, 0);
4199         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4200            and we do that anyway inside the SvNIOK_off
4201         */
4202         SvFLAGS(sv) |= SVf_OOK;
4203     }
4204     SvNIOK_off(sv);
4205     SvLEN_set(sv, SvLEN(sv) - delta);
4206     SvCUR_set(sv, SvCUR(sv) - delta);
4207     SvPV_set(sv, SvPVX(sv) + delta);
4208     SvIV_set(sv, SvIVX(sv) + delta);
4209 }
4210
4211 /*
4212 =for apidoc sv_catpvn
4213
4214 Concatenates the string onto the end of the string which is in the SV.  The
4215 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4216 status set, then the bytes appended should be valid UTF-8.
4217 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4218
4219 =for apidoc sv_catpvn_flags
4220
4221 Concatenates the string onto the end of the string which is in the SV.  The
4222 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4223 status set, then the bytes appended should be valid UTF-8.
4224 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4225 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4226 in terms of this function.
4227
4228 =cut
4229 */
4230
4231 void
4232 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4233 {
4234     dVAR;
4235     STRLEN dlen;
4236     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4237
4238     SvGROW(dsv, dlen + slen + 1);
4239     if (sstr == dstr)
4240         sstr = SvPVX_const(dsv);
4241     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4242     SvCUR_set(dsv, SvCUR(dsv) + slen);
4243     *SvEND(dsv) = '\0';
4244     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4245     SvTAINT(dsv);
4246     if (flags & SV_SMAGIC)
4247         SvSETMAGIC(dsv);
4248 }
4249
4250 /*
4251 =for apidoc sv_catsv
4252
4253 Concatenates the string from SV C<ssv> onto the end of the string in
4254 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4255 not 'set' magic.  See C<sv_catsv_mg>.
4256
4257 =for apidoc sv_catsv_flags
4258
4259 Concatenates the string from SV C<ssv> onto the end of the string in
4260 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4261 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4262 and C<sv_catsv_nomg> are implemented in terms of this function.
4263
4264 =cut */
4265
4266 void
4267 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4268 {
4269     dVAR;
4270     if (ssv) {
4271         STRLEN slen;
4272         const char *spv = SvPV_const(ssv, slen);
4273         if (spv) {
4274             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4275                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4276                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4277                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4278                 dsv->sv_flags doesn't have that bit set.
4279                 Andy Dougherty  12 Oct 2001
4280             */
4281             const I32 sutf8 = DO_UTF8(ssv);
4282             I32 dutf8;
4283
4284             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4285                 mg_get(dsv);
4286             dutf8 = DO_UTF8(dsv);
4287
4288             if (dutf8 != sutf8) {
4289                 if (dutf8) {
4290                     /* Not modifying source SV, so taking a temporary copy. */
4291                     SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4292
4293                     sv_utf8_upgrade(csv);
4294                     spv = SvPV_const(csv, slen);
4295                 }
4296                 else
4297                     sv_utf8_upgrade_nomg(dsv);
4298             }
4299             sv_catpvn_nomg(dsv, spv, slen);
4300         }
4301     }
4302     if (flags & SV_SMAGIC)
4303         SvSETMAGIC(dsv);
4304 }
4305
4306 /*
4307 =for apidoc sv_catpv
4308
4309 Concatenates the string onto the end of the string which is in the SV.
4310 If the SV has the UTF-8 status set, then the bytes appended should be
4311 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4312
4313 =cut */
4314
4315 void
4316 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4317 {
4318     dVAR;
4319     register STRLEN len;
4320     STRLEN tlen;
4321     char *junk;
4322
4323     if (!ptr)
4324         return;
4325     junk = SvPV_force(sv, tlen);
4326     len = strlen(ptr);
4327     SvGROW(sv, tlen + len + 1);
4328     if (ptr == junk)
4329         ptr = SvPVX_const(sv);
4330     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4331     SvCUR_set(sv, SvCUR(sv) + len);
4332     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4333     SvTAINT(sv);
4334 }
4335
4336 /*
4337 =for apidoc sv_catpv_mg
4338
4339 Like C<sv_catpv>, but also handles 'set' magic.
4340
4341 =cut
4342 */
4343
4344 void
4345 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4346 {
4347     sv_catpv(sv,ptr);
4348     SvSETMAGIC(sv);
4349 }
4350
4351 /*
4352 =for apidoc newSV
4353
4354 Creates a new SV.  A non-zero C<len> parameter indicates the number of
4355 bytes of preallocated string space the SV should have.  An extra byte for a
4356 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
4357 space is allocated.)  The reference count for the new SV is set to 1.
4358
4359 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4360 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4361 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4362 L<perlhack/PERL_MEM_LOG>).  The older API is still there for use in XS
4363 modules supporting older perls.
4364
4365 =cut
4366 */
4367
4368 SV *
4369 Perl_newSV(pTHX_ STRLEN len)
4370 {
4371     dVAR;
4372     register SV *sv;
4373
4374     new_SV(sv);
4375     if (len) {
4376         sv_upgrade(sv, SVt_PV);
4377         SvGROW(sv, len + 1);
4378     }
4379     return sv;
4380 }
4381 /*
4382 =for apidoc sv_magicext
4383
4384 Adds magic to an SV, upgrading it if necessary. Applies the
4385 supplied vtable and returns a pointer to the magic added.
4386
4387 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4388 In particular, you can add magic to SvREADONLY SVs, and add more than
4389 one instance of the same 'how'.
4390
4391 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4392 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4393 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4394 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4395
4396 (This is now used as a subroutine by C<sv_magic>.)
4397
4398 =cut
4399 */
4400 MAGIC * 
4401 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4402                  const char* name, I32 namlen)
4403 {
4404     dVAR;
4405     MAGIC* mg;
4406
4407     SvUPGRADE(sv, SVt_PVMG);
4408     Newxz(mg, 1, MAGIC);
4409     mg->mg_moremagic = SvMAGIC(sv);
4410     SvMAGIC_set(sv, mg);
4411
4412     /* Sometimes a magic contains a reference loop, where the sv and
4413        object refer to each other.  To prevent a reference loop that
4414        would prevent such objects being freed, we look for such loops
4415        and if we find one we avoid incrementing the object refcount.
4416
4417        Note we cannot do this to avoid self-tie loops as intervening RV must
4418        have its REFCNT incremented to keep it in existence.
4419
4420     */
4421     if (!obj || obj == sv ||
4422         how == PERL_MAGIC_arylen ||
4423         how == PERL_MAGIC_qr ||
4424         how == PERL_MAGIC_symtab ||
4425         (SvTYPE(obj) == SVt_PVGV &&
4426             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4427             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4428             GvFORM(obj) == (CV*)sv)))
4429     {
4430         mg->mg_obj = obj;
4431     }
4432     else {
4433         mg->mg_obj = SvREFCNT_inc_simple(obj);
4434         mg->mg_flags |= MGf_REFCOUNTED;
4435     }
4436
4437     /* Normal self-ties simply pass a null object, and instead of
4438        using mg_obj directly, use the SvTIED_obj macro to produce a
4439        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4440        with an RV obj pointing to the glob containing the PVIO.  In
4441        this case, to avoid a reference loop, we need to weaken the
4442        reference.
4443     */
4444
4445     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4446         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4447     {
4448       sv_rvweaken(obj);
4449     }
4450
4451     mg->mg_type = how;
4452     mg->mg_len = namlen;
4453     if (name) {
4454         if (namlen > 0)
4455             mg->mg_ptr = savepvn(name, namlen);
4456         else if (namlen == HEf_SVKEY)
4457             mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4458         else
4459             mg->mg_ptr = (char *) name;
4460     }
4461     mg->mg_virtual = (MGVTBL *) vtable;
4462
4463     mg_magical(sv);
4464     if (SvGMAGICAL(sv))
4465         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4466     return mg;
4467 }
4468
4469 /*
4470 =for apidoc sv_magic
4471
4472 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4473 then adds a new magic item of type C<how> to the head of the magic list.
4474
4475 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4476 handling of the C<name> and C<namlen> arguments.
4477
4478 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4479 to add more than one instance of the same 'how'.
4480
4481 =cut
4482 */
4483
4484 void
4485 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4486 {
4487     dVAR;
4488     const MGVTBL *vtable;
4489     MAGIC* mg;
4490
4491 #ifdef PERL_OLD_COPY_ON_WRITE
4492     if (SvIsCOW(sv))
4493         sv_force_normal_flags(sv, 0);
4494 #endif
4495     if (SvREADONLY(sv)) {
4496         if (
4497             /* its okay to attach magic to shared strings; the subsequent
4498              * upgrade to PVMG will unshare the string */
4499             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4500
4501             && IN_PERL_RUNTIME
4502             && how != PERL_MAGIC_regex_global
4503             && how != PERL_MAGIC_bm
4504             && how != PERL_MAGIC_fm
4505             && how != PERL_MAGIC_sv
4506             && how != PERL_MAGIC_backref
4507            )
4508         {
4509             Perl_croak(aTHX_ PL_no_modify);
4510         }
4511     }
4512     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4513         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4514             /* sv_magic() refuses to add a magic of the same 'how' as an
4515                existing one
4516              */
4517             if (how == PERL_MAGIC_taint) {
4518                 mg->mg_len |= 1;
4519                 /* Any scalar which already had taint magic on which someone
4520                    (erroneously?) did SvIOK_on() or similar will now be
4521                    incorrectly sporting public "OK" flags.  */
4522                 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4523             }
4524             return;
4525         }
4526     }
4527
4528     switch (how) {
4529     case PERL_MAGIC_sv:
4530         vtable = &PL_vtbl_sv;
4531         break;
4532     case PERL_MAGIC_overload:
4533         vtable = &PL_vtbl_amagic;
4534         break;
4535     case PERL_MAGIC_overload_elem:
4536         vtable = &PL_vtbl_amagicelem;
4537         break;
4538     case PERL_MAGIC_overload_table:
4539         vtable = &PL_vtbl_ovrld;
4540         break;
4541     case PERL_MAGIC_bm:
4542         vtable = &PL_vtbl_bm;
4543         break;
4544     case PERL_MAGIC_regdata:
4545         vtable = &PL_vtbl_regdata;
4546         break;
4547     case PERL_MAGIC_regdatum:
4548         vtable = &PL_vtbl_regdatum;
4549         break;
4550     case PERL_MAGIC_env:
4551         vtable = &PL_vtbl_env;
4552         break;
4553     case PERL_MAGIC_fm:
4554         vtable = &PL_vtbl_fm;
4555         break;
4556     case PERL_MAGIC_envelem:
4557         vtable = &PL_vtbl_envelem;
4558         break;
4559     case PERL_MAGIC_regex_global:
4560         vtable = &PL_vtbl_mglob;
4561         break;
4562     case PERL_MAGIC_isa:
4563         vtable = &PL_vtbl_isa;
4564         break;
4565     case PERL_MAGIC_isaelem:
4566         vtable = &PL_vtbl_isaelem;
4567         break;
4568     case PERL_MAGIC_nkeys:
4569         vtable = &PL_vtbl_nkeys;
4570         break;
4571     case PERL_MAGIC_dbfile:
4572         vtable = NULL;
4573         break;
4574     case PERL_MAGIC_dbline:
4575         vtable = &PL_vtbl_dbline;
4576         break;
4577 #ifdef USE_LOCALE_COLLATE
4578     case PERL_MAGIC_collxfrm:
4579         vtable = &PL_vtbl_collxfrm;
4580         break;
4581 #endif /* USE_LOCALE_COLLATE */
4582     case PERL_MAGIC_tied:
4583         vtable = &PL_vtbl_pack;
4584         break;
4585     case PERL_MAGIC_tiedelem:
4586     case PERL_MAGIC_tiedscalar:
4587         vtable = &PL_vtbl_packelem;
4588         break;
4589     case PERL_MAGIC_qr:
4590         vtable = &PL_vtbl_regexp;
4591         break;
4592     case PERL_MAGIC_hints:
4593         /* As this vtable is all NULL, we can reuse it.  */
4594     case PERL_MAGIC_sig:
4595         vtable = &PL_vtbl_sig;
4596         break;
4597     case PERL_MAGIC_sigelem:
4598         vtable = &PL_vtbl_sigelem;
4599         break;
4600     case PERL_MAGIC_taint:
4601         vtable = &PL_vtbl_taint;
4602         break;
4603     case PERL_MAGIC_uvar:
4604         vtable = &PL_vtbl_uvar;
4605         break;
4606     case PERL_MAGIC_vec:
4607         vtable = &PL_vtbl_vec;
4608         break;
4609     case PERL_MAGIC_arylen_p:
4610     case PERL_MAGIC_rhash:
4611     case PERL_MAGIC_symtab:
4612     case PERL_MAGIC_vstring:
4613         vtable = NULL;
4614         break;
4615     case PERL_MAGIC_utf8:
4616         vtable = &PL_vtbl_utf8;
4617         break;
4618     case PERL_MAGIC_substr:
4619         vtable = &PL_vtbl_substr;
4620         break;
4621     case PERL_MAGIC_defelem:
4622         vtable = &PL_vtbl_defelem;
4623         break;
4624     case PERL_MAGIC_arylen:
4625         vtable = &PL_vtbl_arylen;
4626         break;
4627     case PERL_MAGIC_pos:
4628         vtable = &PL_vtbl_pos;
4629         break;
4630     case PERL_MAGIC_backref:
4631         vtable = &PL_vtbl_backref;
4632         break;
4633     case PERL_MAGIC_hintselem:
4634         vtable = &PL_vtbl_hintselem;
4635         break;
4636     case PERL_MAGIC_ext:
4637         /* Reserved for use by extensions not perl internals.           */
4638         /* Useful for attaching extension internal data to perl vars.   */
4639         /* Note that multiple extensions may clash if magical scalars   */
4640         /* etc holding private data from one are passed to another.     */
4641         vtable = NULL;
4642         break;
4643     default:
4644         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4645     }
4646
4647     /* Rest of work is done else where */
4648     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4649
4650     switch (how) {
4651     case PERL_MAGIC_taint:
4652         mg->mg_len = 1;
4653         break;
4654     case PERL_MAGIC_ext:
4655     case PERL_MAGIC_dbfile:
4656         SvRMAGICAL_on(sv);
4657         break;
4658     }
4659 }
4660
4661 /*
4662 =for apidoc sv_unmagic
4663
4664 Removes all magic of type C<type> from an SV.
4665
4666 =cut
4667 */
4668
4669 int
4670 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4671 {
4672     MAGIC* mg;
4673     MAGIC** mgp;
4674     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4675         return 0;
4676     mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4677     for (mg = *mgp; mg; mg = *mgp) {
4678         if (mg->mg_type == type) {
4679             const MGVTBL* const vtbl = mg->mg_virtual;
4680             *mgp = mg->mg_moremagic;
4681             if (vtbl && vtbl->svt_free)
4682                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4683             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4684                 if (mg->mg_len > 0)
4685                     Safefree(mg->mg_ptr);
4686                 else if (mg->mg_len == HEf_SVKEY)
4687                     SvREFCNT_dec((SV*)mg->mg_ptr);
4688                 else if (mg->mg_type == PERL_MAGIC_utf8)
4689                     Safefree(mg->mg_ptr);
4690             }
4691             if (mg->mg_flags & MGf_REFCOUNTED)
4692                 SvREFCNT_dec(mg->mg_obj);
4693             Safefree(mg);
4694         }
4695         else
4696             mgp = &mg->mg_moremagic;
4697     }
4698     if (!SvMAGIC(sv)) {
4699         SvMAGICAL_off(sv);
4700         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4701         SvMAGIC_set(sv, NULL);
4702     }
4703
4704     return 0;
4705 }
4706
4707 /*
4708 =for apidoc sv_rvweaken
4709
4710 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4711 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4712 push a back-reference to this RV onto the array of backreferences
4713 associated with that magic. If the RV is magical, set magic will be
4714 called after the RV is cleared.
4715
4716 =cut
4717 */
4718
4719 SV *
4720 Perl_sv_rvweaken(pTHX_ SV *sv)
4721 {
4722     SV *tsv;
4723     if (!SvOK(sv))  /* let undefs pass */
4724         return sv;
4725     if (!SvROK(sv))
4726         Perl_croak(aTHX_ "Can't weaken a nonreference");
4727     else if (SvWEAKREF(sv)) {
4728         if (ckWARN(WARN_MISC))
4729             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4730         return sv;
4731     }
4732     tsv = SvRV(sv);
4733     Perl_sv_add_backref(aTHX_ tsv, sv);
4734     SvWEAKREF_on(sv);
4735     SvREFCNT_dec(tsv);
4736     return sv;
4737 }
4738
4739 /* Give tsv backref magic if it hasn't already got it, then push a
4740  * back-reference to sv onto the array associated with the backref magic.
4741  */
4742
4743 void
4744 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4745 {
4746     dVAR;
4747     AV *av;
4748
4749     if (SvTYPE(tsv) == SVt_PVHV) {
4750         AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4751
4752         av = *avp;
4753         if (!av) {