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