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