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