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