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