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