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