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