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