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