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