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