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