This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
9658505cb713a2ca6f6f6819eda07e64ff9261b2
[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((void *)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* xpv;
1157     XPV* xpvend;
1158     New(713, xpv, PERL_ARENA_SIZE/sizeof(XPV), XPV);
1159     *((XPV**)xpv) = PL_xpv_arenaroot;
1160     PL_xpv_arenaroot = xpv;
1161
1162     xpvend = &xpv[PERL_ARENA_SIZE / sizeof(XPV) - 1];
1163     PL_xpv_root = ++xpv;
1164     while (xpv < xpvend) {
1165         *((XPV**)xpv) = xpv + 1;
1166         xpv++;
1167     }
1168     *((XPV**)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* xpviv;
1177     XPVIV* xpvivend;
1178     New(714, xpviv, PERL_ARENA_SIZE/sizeof(XPVIV), XPVIV);
1179     *((XPVIV**)xpviv) = PL_xpviv_arenaroot;
1180     PL_xpviv_arenaroot = xpviv;
1181
1182     xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(XPVIV) - 1];
1183     PL_xpviv_root = ++xpviv;
1184     while (xpviv < xpvivend) {
1185         *((XPVIV**)xpviv) = xpviv + 1;
1186         xpviv++;
1187     }
1188     *((XPVIV**)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* xpvav;
1237     XPVAV* xpvavend;
1238     New(717, xpvav, PERL_ARENA_SIZE/sizeof(XPVAV), XPVAV);
1239     *((XPVAV**)xpvav) = PL_xpvav_arenaroot;
1240     PL_xpvav_arenaroot = xpvav;
1241
1242     xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(XPVAV) - 1];
1243     PL_xpvav_root = ++xpvav;
1244     while (xpvav < xpvavend) {
1245         *((XPVAV**)xpvav) = xpvav + 1;
1246         xpvav++;
1247     }
1248     *((XPVAV**)xpvav) = 0;
1249 }
1250
1251 /* allocate another arena's worth of struct xpvhv */
1252
1253 STATIC void
1254 S_more_xpvhv(pTHX)
1255 {
1256     XPVHV* xpvhv;
1257     XPVHV* xpvhvend;
1258     New(718, xpvhv, PERL_ARENA_SIZE/sizeof(XPVHV), XPVHV);
1259     *((XPVHV**)xpvhv) = PL_xpvhv_arenaroot;
1260     PL_xpvhv_arenaroot = xpvhv;
1261
1262     xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(XPVHV) - 1];
1263     PL_xpvhv_root = ++xpvhv;
1264     while (xpvhv < xpvhvend) {
1265         *((XPVHV**)xpvhv) = xpvhv + 1;
1266         xpvhv++;
1267     }
1268     *((XPVHV**)xpvhv) = 0;
1269 }
1270
1271 /* allocate another arena's worth of struct xpvmg */
1272
1273 STATIC void
1274 S_more_xpvmg(pTHX)
1275 {
1276     XPVMG* xpvmg;
1277     XPVMG* xpvmgend;
1278     New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
1279     *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
1280     PL_xpvmg_arenaroot = xpvmg;
1281
1282     xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1283     PL_xpvmg_root = ++xpvmg;
1284     while (xpvmg < xpvmgend) {
1285         *((XPVMG**)xpvmg) = xpvmg + 1;
1286         xpvmg++;
1287     }
1288     *((XPVMG**)xpvmg) = 0;
1289 }
1290
1291 /* allocate another arena's worth of struct xpvgv */
1292
1293 STATIC void
1294 S_more_xpvgv(pTHX)
1295 {
1296     XPVGV* xpvgv;
1297     XPVGV* xpvgvend;
1298     New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
1299     *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
1300     PL_xpvgv_arenaroot = xpvgv;
1301
1302     xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1303     PL_xpvgv_root = ++xpvgv;
1304     while (xpvgv < xpvgvend) {
1305         *((XPVGV**)xpvgv) = xpvgv + 1;
1306         xpvgv++;
1307     }
1308     *((XPVGV**)xpvgv) = 0;
1309 }
1310
1311 /* allocate another arena's worth of struct xpvlv */
1312
1313 STATIC void
1314 S_more_xpvlv(pTHX)
1315 {
1316     XPVLV* xpvlv;
1317     XPVLV* xpvlvend;
1318     New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
1319     *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
1320     PL_xpvlv_arenaroot = xpvlv;
1321
1322     xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1323     PL_xpvlv_root = ++xpvlv;
1324     while (xpvlv < xpvlvend) {
1325         *((XPVLV**)xpvlv) = xpvlv + 1;
1326         xpvlv++;
1327     }
1328     *((XPVLV**)xpvlv) = 0;
1329 }
1330
1331 /* allocate another arena's worth of struct xpvbm */
1332
1333 STATIC void
1334 S_more_xpvbm(pTHX)
1335 {
1336     XPVBM* xpvbm;
1337     XPVBM* xpvbmend;
1338     New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
1339     *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
1340     PL_xpvbm_arenaroot = xpvbm;
1341
1342     xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1343     PL_xpvbm_root = ++xpvbm;
1344     while (xpvbm < xpvbmend) {
1345         *((XPVBM**)xpvbm) = xpvbm + 1;
1346         xpvbm++;
1347     }
1348     *((XPVBM**)xpvbm) = 0;
1349 }
1350
1351 /* grab a new NV body from the free list, allocating more if necessary */
1352
1353 STATIC XPVNV*
1354 S_new_xnv(pTHX)
1355 {
1356     NV* xnv;
1357     LOCK_SV_MUTEX;
1358     if (!PL_xnv_root)
1359         S_more_xnv(aTHX);
1360     xnv = PL_xnv_root;
1361     PL_xnv_root = *(NV**)xnv;
1362     UNLOCK_SV_MUTEX;
1363     return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1364 }
1365
1366 /* return an NV body to the free list */
1367
1368 STATIC void
1369 S_del_xnv(pTHX_ XPVNV *p)
1370 {
1371     NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1372     LOCK_SV_MUTEX;
1373     *(NV**)xnv = PL_xnv_root;
1374     PL_xnv_root = xnv;
1375     UNLOCK_SV_MUTEX;
1376 }
1377
1378 /* grab a new struct xpv from the free list, allocating more if necessary */
1379
1380 STATIC XPV*
1381 S_new_xpv(pTHX)
1382 {
1383     XPV* xpv;
1384     LOCK_SV_MUTEX;
1385     if (!PL_xpv_root)
1386         S_more_xpv(aTHX);
1387     xpv = PL_xpv_root;
1388     PL_xpv_root = *(XPV**)xpv;
1389     UNLOCK_SV_MUTEX;
1390     return xpv;
1391 }
1392
1393 /* return a struct xpv to the free list */
1394
1395 STATIC void
1396 S_del_xpv(pTHX_ XPV *p)
1397 {
1398     LOCK_SV_MUTEX;
1399     *(XPV**)p = PL_xpv_root;
1400     PL_xpv_root = p;
1401     UNLOCK_SV_MUTEX;
1402 }
1403
1404 /* grab a new struct xpviv from the free list, allocating more if necessary */
1405
1406 STATIC XPVIV*
1407 S_new_xpviv(pTHX)
1408 {
1409     XPVIV* xpviv;
1410     LOCK_SV_MUTEX;
1411     if (!PL_xpviv_root)
1412         S_more_xpviv(aTHX);
1413     xpviv = PL_xpviv_root;
1414     PL_xpviv_root = *(XPVIV**)xpviv;
1415     UNLOCK_SV_MUTEX;
1416     return xpviv;
1417 }
1418
1419 /* return a struct xpviv to the free list */
1420
1421 STATIC void
1422 S_del_xpviv(pTHX_ XPVIV *p)
1423 {
1424     LOCK_SV_MUTEX;
1425     *(XPVIV**)p = PL_xpviv_root;
1426     PL_xpviv_root = p;
1427     UNLOCK_SV_MUTEX;
1428 }
1429
1430 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1431
1432 STATIC XPVNV*
1433 S_new_xpvnv(pTHX)
1434 {
1435     XPVNV* xpvnv;
1436     LOCK_SV_MUTEX;
1437     if (!PL_xpvnv_root)
1438         S_more_xpvnv(aTHX);
1439     xpvnv = PL_xpvnv_root;
1440     PL_xpvnv_root = *(XPVNV**)xpvnv;
1441     UNLOCK_SV_MUTEX;
1442     return xpvnv;
1443 }
1444
1445 /* return a struct xpvnv to the free list */
1446
1447 STATIC void
1448 S_del_xpvnv(pTHX_ XPVNV *p)
1449 {
1450     LOCK_SV_MUTEX;
1451     *(XPVNV**)p = PL_xpvnv_root;
1452     PL_xpvnv_root = p;
1453     UNLOCK_SV_MUTEX;
1454 }
1455
1456 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1457
1458 STATIC XPVCV*
1459 S_new_xpvcv(pTHX)
1460 {
1461     XPVCV* xpvcv;
1462     LOCK_SV_MUTEX;
1463     if (!PL_xpvcv_root)
1464         S_more_xpvcv(aTHX);
1465     xpvcv = PL_xpvcv_root;
1466     PL_xpvcv_root = *(XPVCV**)xpvcv;
1467     UNLOCK_SV_MUTEX;
1468     return xpvcv;
1469 }
1470
1471 /* return a struct xpvcv to the free list */
1472
1473 STATIC void
1474 S_del_xpvcv(pTHX_ XPVCV *p)
1475 {
1476     LOCK_SV_MUTEX;
1477     *(XPVCV**)p = PL_xpvcv_root;
1478     PL_xpvcv_root = p;
1479     UNLOCK_SV_MUTEX;
1480 }
1481
1482 /* grab a new struct xpvav from the free list, allocating more if necessary */
1483
1484 STATIC XPVAV*
1485 S_new_xpvav(pTHX)
1486 {
1487     XPVAV* xpvav;
1488     LOCK_SV_MUTEX;
1489     if (!PL_xpvav_root)
1490         S_more_xpvav(aTHX);
1491     xpvav = PL_xpvav_root;
1492     PL_xpvav_root = *(XPVAV**)xpvav;
1493     UNLOCK_SV_MUTEX;
1494     return xpvav;
1495 }
1496
1497 /* return a struct xpvav to the free list */
1498
1499 STATIC void
1500 S_del_xpvav(pTHX_ XPVAV *p)
1501 {
1502     LOCK_SV_MUTEX;
1503     *(XPVAV**)p = PL_xpvav_root;
1504     PL_xpvav_root = p;
1505     UNLOCK_SV_MUTEX;
1506 }
1507
1508 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1509
1510 STATIC XPVHV*
1511 S_new_xpvhv(pTHX)
1512 {
1513     XPVHV* xpvhv;
1514     LOCK_SV_MUTEX;
1515     if (!PL_xpvhv_root)
1516         S_more_xpvhv(aTHX);
1517     xpvhv = PL_xpvhv_root;
1518     PL_xpvhv_root = *(XPVHV**)xpvhv;
1519     UNLOCK_SV_MUTEX;
1520     return xpvhv;
1521 }
1522
1523 /* return a struct xpvhv to the free list */
1524
1525 STATIC void
1526 S_del_xpvhv(pTHX_ XPVHV *p)
1527 {
1528     LOCK_SV_MUTEX;
1529     *(XPVHV**)p = PL_xpvhv_root;
1530     PL_xpvhv_root = p;
1531     UNLOCK_SV_MUTEX;
1532 }
1533
1534 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1535
1536 STATIC XPVMG*
1537 S_new_xpvmg(pTHX)
1538 {
1539     XPVMG* xpvmg;
1540     LOCK_SV_MUTEX;
1541     if (!PL_xpvmg_root)
1542         S_more_xpvmg(aTHX);
1543     xpvmg = PL_xpvmg_root;
1544     PL_xpvmg_root = *(XPVMG**)xpvmg;
1545     UNLOCK_SV_MUTEX;
1546     return xpvmg;
1547 }
1548
1549 /* return a struct xpvmg to the free list */
1550
1551 STATIC void
1552 S_del_xpvmg(pTHX_ XPVMG *p)
1553 {
1554     LOCK_SV_MUTEX;
1555     *(XPVMG**)p = PL_xpvmg_root;
1556     PL_xpvmg_root = p;
1557     UNLOCK_SV_MUTEX;
1558 }
1559
1560 /* grab a new struct xpvgv from the free list, allocating more if necessary */
1561
1562 STATIC XPVGV*
1563 S_new_xpvgv(pTHX)
1564 {
1565     XPVGV* xpvgv;
1566     LOCK_SV_MUTEX;
1567     if (!PL_xpvgv_root)
1568         S_more_xpvgv(aTHX);
1569     xpvgv = PL_xpvgv_root;
1570     PL_xpvgv_root = *(XPVGV**)xpvgv;
1571     UNLOCK_SV_MUTEX;
1572     return xpvgv;
1573 }
1574
1575 /* return a struct xpvgv to the free list */
1576
1577 STATIC void
1578 S_del_xpvgv(pTHX_ XPVGV *p)
1579 {
1580     LOCK_SV_MUTEX;
1581     *(XPVGV**)p = PL_xpvgv_root;
1582     PL_xpvgv_root = p;
1583     UNLOCK_SV_MUTEX;
1584 }
1585
1586 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1587
1588 STATIC XPVLV*
1589 S_new_xpvlv(pTHX)
1590 {
1591     XPVLV* xpvlv;
1592     LOCK_SV_MUTEX;
1593     if (!PL_xpvlv_root)
1594         S_more_xpvlv(aTHX);
1595     xpvlv = PL_xpvlv_root;
1596     PL_xpvlv_root = *(XPVLV**)xpvlv;
1597     UNLOCK_SV_MUTEX;
1598     return xpvlv;
1599 }
1600
1601 /* return a struct xpvlv to the free list */
1602
1603 STATIC void
1604 S_del_xpvlv(pTHX_ XPVLV *p)
1605 {
1606     LOCK_SV_MUTEX;
1607     *(XPVLV**)p = PL_xpvlv_root;
1608     PL_xpvlv_root = p;
1609     UNLOCK_SV_MUTEX;
1610 }
1611
1612 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1613
1614 STATIC XPVBM*
1615 S_new_xpvbm(pTHX)
1616 {
1617     XPVBM* xpvbm;
1618     LOCK_SV_MUTEX;
1619     if (!PL_xpvbm_root)
1620         S_more_xpvbm(aTHX);
1621     xpvbm = PL_xpvbm_root;
1622     PL_xpvbm_root = *(XPVBM**)xpvbm;
1623     UNLOCK_SV_MUTEX;
1624     return xpvbm;
1625 }
1626
1627 /* return a struct xpvbm to the free list */
1628
1629 STATIC void
1630 S_del_xpvbm(pTHX_ XPVBM *p)
1631 {
1632     LOCK_SV_MUTEX;
1633     *(XPVBM**)p = PL_xpvbm_root;
1634     PL_xpvbm_root = p;
1635     UNLOCK_SV_MUTEX;
1636 }
1637
1638 #define my_safemalloc(s)        (void*)safemalloc(s)
1639 #define my_safefree(p)  safefree((char*)p)
1640
1641 #ifdef PURIFY
1642
1643 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
1644 #define del_XNV(p)      my_safefree(p)
1645
1646 #define new_XPV()       my_safemalloc(sizeof(XPV))
1647 #define del_XPV(p)      my_safefree(p)
1648
1649 #define new_XPVIV()     my_safemalloc(sizeof(XPVIV))
1650 #define del_XPVIV(p)    my_safefree(p)
1651
1652 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
1653 #define del_XPVNV(p)    my_safefree(p)
1654
1655 #define new_XPVCV()     my_safemalloc(sizeof(XPVCV))
1656 #define del_XPVCV(p)    my_safefree(p)
1657
1658 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
1659 #define del_XPVAV(p)    my_safefree(p)
1660
1661 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
1662 #define del_XPVHV(p)    my_safefree(p)
1663
1664 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
1665 #define del_XPVMG(p)    my_safefree(p)
1666
1667 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
1668 #define del_XPVGV(p)    my_safefree(p)
1669
1670 #define new_XPVLV()     my_safemalloc(sizeof(XPVLV))
1671 #define del_XPVLV(p)    my_safefree(p)
1672
1673 #define new_XPVBM()     my_safemalloc(sizeof(XPVBM))
1674 #define del_XPVBM(p)    my_safefree(p)
1675
1676 #else /* !PURIFY */
1677
1678 #define new_XNV()       (void*)new_xnv()
1679 #define del_XNV(p)      del_xnv((XPVNV*) p)
1680
1681 #define new_XPV()       (void*)new_xpv()
1682 #define del_XPV(p)      del_xpv((XPV *)p)
1683
1684 #define new_XPVIV()     (void*)new_xpviv()
1685 #define del_XPVIV(p)    del_xpviv((XPVIV *)p)
1686
1687 #define new_XPVNV()     (void*)new_xpvnv()
1688 #define del_XPVNV(p)    del_xpvnv((XPVNV *)p)
1689
1690 #define new_XPVCV()     (void*)new_xpvcv()
1691 #define del_XPVCV(p)    del_xpvcv((XPVCV *)p)
1692
1693 #define new_XPVAV()     (void*)new_xpvav()
1694 #define del_XPVAV(p)    del_xpvav((XPVAV *)p)
1695
1696 #define new_XPVHV()     (void*)new_xpvhv()
1697 #define del_XPVHV(p)    del_xpvhv((XPVHV *)p)
1698
1699 #define new_XPVMG()     (void*)new_xpvmg()
1700 #define del_XPVMG(p)    del_xpvmg((XPVMG *)p)
1701
1702 #define new_XPVGV()     (void*)new_xpvgv()
1703 #define del_XPVGV(p)    del_xpvgv((XPVGV *)p)
1704
1705 #define new_XPVLV()     (void*)new_xpvlv()
1706 #define del_XPVLV(p)    del_xpvlv((XPVLV *)p)
1707
1708 #define new_XPVBM()     (void*)new_xpvbm()
1709 #define del_XPVBM(p)    del_xpvbm((XPVBM *)p)
1710
1711 #endif /* PURIFY */
1712
1713 #define new_XPVFM()     my_safemalloc(sizeof(XPVFM))
1714 #define del_XPVFM(p)    my_safefree(p)
1715
1716 #define new_XPVIO()     my_safemalloc(sizeof(XPVIO))
1717 #define del_XPVIO(p)    my_safefree(p)
1718
1719 /*
1720 =for apidoc sv_upgrade
1721
1722 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1723 SV, then copies across as much information as possible from the old body.
1724 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1725
1726 =cut
1727 */
1728
1729 bool
1730 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1731 {
1732
1733     char*       pv;
1734     U32         cur;
1735     U32         len;
1736     IV          iv;
1737     NV          nv;
1738     MAGIC*      magic;
1739     HV*         stash;
1740
1741     if (mt != SVt_PV && SvIsCOW(sv)) {
1742         sv_force_normal_flags(sv, 0);
1743     }
1744
1745     if (SvTYPE(sv) == mt)
1746         return TRUE;
1747
1748     pv = NULL;
1749     cur = 0;
1750     len = 0;
1751     iv = 0;
1752     nv = 0.0;
1753     magic = NULL;
1754     stash = Nullhv;
1755
1756     switch (SvTYPE(sv)) {
1757     case SVt_NULL:
1758         break;
1759     case SVt_IV:
1760         iv      = SvIVX(sv);
1761         if (mt == SVt_NV)
1762             mt = SVt_PVNV;
1763         else if (mt < SVt_PVIV)
1764             mt = SVt_PVIV;
1765         break;
1766     case SVt_NV:
1767         nv      = SvNVX(sv);
1768         del_XNV(SvANY(sv));
1769         if (mt < SVt_PVNV)
1770             mt = SVt_PVNV;
1771         break;
1772     case SVt_RV:
1773         pv      = (char*)SvRV(sv);
1774         break;
1775     case SVt_PV:
1776         pv      = SvPVX(sv);
1777         cur     = SvCUR(sv);
1778         len     = SvLEN(sv);
1779         del_XPV(SvANY(sv));
1780         if (mt <= SVt_IV)
1781             mt = SVt_PVIV;
1782         else if (mt == SVt_NV)
1783             mt = SVt_PVNV;
1784         break;
1785     case SVt_PVIV:
1786         pv      = SvPVX(sv);
1787         cur     = SvCUR(sv);
1788         len     = SvLEN(sv);
1789         iv      = SvIVX(sv);
1790         del_XPVIV(SvANY(sv));
1791         break;
1792     case SVt_PVNV:
1793         pv      = SvPVX(sv);
1794         cur     = SvCUR(sv);
1795         len     = SvLEN(sv);
1796         iv      = SvIVX(sv);
1797         nv      = SvNVX(sv);
1798         del_XPVNV(SvANY(sv));
1799         break;
1800     case SVt_PVMG:
1801         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1802            there's no way that it can be safely upgraded, because perl.c
1803            expects to Safefree(SvANY(PL_mess_sv))  */
1804         assert(sv != PL_mess_sv);
1805         /* This flag bit is used to mean other things in other scalar types.
1806            Given that it only has meaning inside the pad, it shouldn't be set
1807            on anything that can get upgraded.  */
1808         assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1809         pv      = SvPVX(sv);
1810         cur     = SvCUR(sv);
1811         len     = SvLEN(sv);
1812         iv      = SvIVX(sv);
1813         nv      = SvNVX(sv);
1814         magic   = SvMAGIC(sv);
1815         stash   = SvSTASH(sv);
1816         del_XPVMG(SvANY(sv));
1817         break;
1818     default:
1819         Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1820     }
1821
1822     SvFLAGS(sv) &= ~SVTYPEMASK;
1823     SvFLAGS(sv) |= mt;
1824
1825     switch (mt) {
1826     case SVt_NULL:
1827         Perl_croak(aTHX_ "Can't upgrade to undef");
1828     case SVt_IV:
1829         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.sv_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1830         SvIV_set(sv, iv);
1831         break;
1832     case SVt_NV:
1833         SvANY(sv) = new_XNV();
1834         SvNV_set(sv, nv);
1835         break;
1836     case SVt_RV:
1837         SvANY(sv) = &sv->sv_u.sv_rv;
1838         SvRV_set(sv, (SV*)pv);
1839         break;
1840     case SVt_PVHV:
1841         SvANY(sv) = new_XPVHV();
1842         ((XPVHV*) SvANY(sv))->xhv_aux = 0;
1843         HvFILL(sv)      = 0;
1844         HvMAX(sv)       = 0;
1845         HvTOTALKEYS(sv) = 0;
1846
1847         /* Fall through...  */
1848         if (0) {
1849         case SVt_PVAV:
1850             SvANY(sv) = new_XPVAV();
1851             AvMAX(sv)   = -1;
1852             AvFILLp(sv) = -1;
1853             AvALLOC(sv) = 0;
1854             AvARYLEN(sv)= 0;
1855             AvREAL_only(sv);
1856             SvIV_set(sv, 0);
1857             SvNV_set(sv, 0.0);
1858         }
1859         /* to here.  */
1860         /* XXX? Only SVt_NULL is ever upgraded to AV or HV?  */
1861         assert(!pv);
1862         /* FIXME. Should be able to remove all this if()... if the above
1863            assertion is genuinely always true.  */
1864         if(SvOOK(sv)) {
1865             pv -= iv;
1866             SvFLAGS(sv) &= ~SVf_OOK;
1867         }
1868         Safefree(pv);
1869         SvPV_set(sv, (char*)0);
1870         SvMAGIC_set(sv, magic);
1871         SvSTASH_set(sv, stash);
1872         break;
1873
1874     case SVt_PVIO:
1875         SvANY(sv) = new_XPVIO();
1876         Zero(SvANY(sv), 1, XPVIO);
1877         IoPAGE_LEN(sv)  = 60;
1878         goto set_magic_common;
1879     case SVt_PVFM:
1880         SvANY(sv) = new_XPVFM();
1881         Zero(SvANY(sv), 1, XPVFM);
1882         goto set_magic_common;
1883     case SVt_PVBM:
1884         SvANY(sv) = new_XPVBM();
1885         BmRARE(sv)      = 0;
1886         BmUSEFUL(sv)    = 0;
1887         BmPREVIOUS(sv)  = 0;
1888         goto set_magic_common;
1889     case SVt_PVGV:
1890         SvANY(sv) = new_XPVGV();
1891         GvGP(sv)        = 0;
1892         GvNAME(sv)      = 0;
1893         GvNAMELEN(sv)   = 0;
1894         GvSTASH(sv)     = 0;
1895         GvFLAGS(sv)     = 0;
1896         goto set_magic_common;
1897     case SVt_PVCV:
1898         SvANY(sv) = new_XPVCV();
1899         Zero(SvANY(sv), 1, XPVCV);
1900         goto set_magic_common;
1901     case SVt_PVLV:
1902         SvANY(sv) = new_XPVLV();
1903         LvTARGOFF(sv)   = 0;
1904         LvTARGLEN(sv)   = 0;
1905         LvTARG(sv)      = 0;
1906         LvTYPE(sv)      = 0;
1907         GvGP(sv)        = 0;
1908         GvNAME(sv)      = 0;
1909         GvNAMELEN(sv)   = 0;
1910         GvSTASH(sv)     = 0;
1911         GvFLAGS(sv)     = 0;
1912         /* Fall through.  */
1913         if (0) {
1914         case SVt_PVMG:
1915             SvANY(sv) = new_XPVMG();
1916         }
1917     set_magic_common:
1918         SvMAGIC_set(sv, magic);
1919         SvSTASH_set(sv, stash);
1920         /* Fall through.  */
1921         if (0) {
1922         case SVt_PVNV:
1923             SvANY(sv) = new_XPVNV();
1924         }
1925         SvNV_set(sv, nv);
1926         /* Fall through.  */
1927         if (0) {
1928         case SVt_PVIV:
1929             SvANY(sv) = new_XPVIV();
1930             if (SvNIOK(sv))
1931                 (void)SvIOK_on(sv);
1932             SvNOK_off(sv);
1933         }
1934         SvIV_set(sv, iv);
1935         /* Fall through.  */
1936         if (0) {
1937         case SVt_PV:
1938             SvANY(sv) = new_XPV();
1939         }
1940         SvPV_set(sv, pv);
1941         SvCUR_set(sv, cur);
1942         SvLEN_set(sv, len);
1943         break;
1944     }
1945     return TRUE;
1946 }
1947
1948 /*
1949 =for apidoc sv_backoff
1950
1951 Remove any string offset. You should normally use the C<SvOOK_off> macro
1952 wrapper instead.
1953
1954 =cut
1955 */
1956
1957 int
1958 Perl_sv_backoff(pTHX_ register SV *sv)
1959 {
1960     assert(SvOOK(sv));
1961     if (SvIVX(sv)) {
1962         char *s = SvPVX(sv);
1963         SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1964         SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1965         SvIV_set(sv, 0);
1966         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1967     }
1968     SvFLAGS(sv) &= ~SVf_OOK;
1969     return 0;
1970 }
1971
1972 /*
1973 =for apidoc sv_grow
1974
1975 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1976 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1977 Use the C<SvGROW> wrapper instead.
1978
1979 =cut
1980 */
1981
1982 char *
1983 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1984 {
1985     register char *s;
1986
1987 #ifdef HAS_64K_LIMIT
1988     if (newlen >= 0x10000) {
1989         PerlIO_printf(Perl_debug_log,
1990                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1991         my_exit(1);
1992     }
1993 #endif /* HAS_64K_LIMIT */
1994     if (SvROK(sv))
1995         sv_unref(sv);
1996     if (SvTYPE(sv) < SVt_PV) {
1997         sv_upgrade(sv, SVt_PV);
1998         s = SvPVX(sv);
1999     }
2000     else if (SvOOK(sv)) {       /* pv is offset? */
2001         sv_backoff(sv);
2002         s = SvPVX(sv);
2003         if (newlen > SvLEN(sv))
2004             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2005 #ifdef HAS_64K_LIMIT
2006         if (newlen >= 0x10000)
2007             newlen = 0xFFFF;
2008 #endif
2009     }
2010     else
2011         s = SvPVX(sv);
2012
2013     if (newlen > SvLEN(sv)) {           /* need more room? */
2014         if (SvLEN(sv) && s) {
2015 #ifdef MYMALLOC
2016             const STRLEN l = malloced_size((void*)SvPVX(sv));
2017             if (newlen <= l) {
2018                 SvLEN_set(sv, l);
2019                 return s;
2020             } else
2021 #endif
2022             Renew(s,newlen,char);
2023         }
2024         else {
2025             New(703, s, newlen, char);
2026             if (SvPVX(sv) && SvCUR(sv)) {
2027                 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2028             }
2029         }
2030         SvPV_set(sv, s);
2031         SvLEN_set(sv, newlen);
2032     }
2033     return s;
2034 }
2035
2036 /*
2037 =for apidoc sv_setiv
2038
2039 Copies an integer into the given SV, upgrading first if necessary.
2040 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
2041
2042 =cut
2043 */
2044
2045 void
2046 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2047 {
2048     SV_CHECK_THINKFIRST_COW_DROP(sv);
2049     switch (SvTYPE(sv)) {
2050     case SVt_NULL:
2051         sv_upgrade(sv, SVt_IV);
2052         break;
2053     case SVt_NV:
2054         sv_upgrade(sv, SVt_PVNV);
2055         break;
2056     case SVt_RV:
2057     case SVt_PV:
2058         sv_upgrade(sv, SVt_PVIV);
2059         break;
2060
2061     case SVt_PVGV:
2062     case SVt_PVAV:
2063     case SVt_PVHV:
2064     case SVt_PVCV:
2065     case SVt_PVFM:
2066     case SVt_PVIO:
2067         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2068                    OP_DESC(PL_op));
2069     }
2070     (void)SvIOK_only(sv);                       /* validate number */
2071     SvIV_set(sv, i);
2072     SvTAINT(sv);
2073 }
2074
2075 /*
2076 =for apidoc sv_setiv_mg
2077
2078 Like C<sv_setiv>, but also handles 'set' magic.
2079
2080 =cut
2081 */
2082
2083 void
2084 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2085 {
2086     sv_setiv(sv,i);
2087     SvSETMAGIC(sv);
2088 }
2089
2090 /*
2091 =for apidoc sv_setuv
2092
2093 Copies an unsigned integer into the given SV, upgrading first if necessary.
2094 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
2095
2096 =cut
2097 */
2098
2099 void
2100 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2101 {
2102     /* With these two if statements:
2103        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
2104
2105        without
2106        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
2107
2108        If you wish to remove them, please benchmark to see what the effect is
2109     */
2110     if (u <= (UV)IV_MAX) {
2111        sv_setiv(sv, (IV)u);
2112        return;
2113     }
2114     sv_setiv(sv, 0);
2115     SvIsUV_on(sv);
2116     SvUV_set(sv, u);
2117 }
2118
2119 /*
2120 =for apidoc sv_setuv_mg
2121
2122 Like C<sv_setuv>, but also handles 'set' magic.
2123
2124 =cut
2125 */
2126
2127 void
2128 Perl_sv_setuv_mg(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     } else {
2141        sv_setiv(sv, 0);
2142        SvIsUV_on(sv);
2143        sv_setuv(sv,u);
2144     }
2145     SvSETMAGIC(sv);
2146 }
2147
2148 /*
2149 =for apidoc sv_setnv
2150
2151 Copies a double into the given SV, upgrading first if necessary.
2152 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
2153
2154 =cut
2155 */
2156
2157 void
2158 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2159 {
2160     SV_CHECK_THINKFIRST_COW_DROP(sv);
2161     switch (SvTYPE(sv)) {
2162     case SVt_NULL:
2163     case SVt_IV:
2164         sv_upgrade(sv, SVt_NV);
2165         break;
2166     case SVt_RV:
2167     case SVt_PV:
2168     case SVt_PVIV:
2169         sv_upgrade(sv, SVt_PVNV);
2170         break;
2171
2172     case SVt_PVGV:
2173     case SVt_PVAV:
2174     case SVt_PVHV:
2175     case SVt_PVCV:
2176     case SVt_PVFM:
2177     case SVt_PVIO:
2178         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2179                    OP_NAME(PL_op));
2180     }
2181     SvNV_set(sv, num);
2182     (void)SvNOK_only(sv);                       /* validate number */
2183     SvTAINT(sv);
2184 }
2185
2186 /*
2187 =for apidoc sv_setnv_mg
2188
2189 Like C<sv_setnv>, but also handles 'set' magic.
2190
2191 =cut
2192 */
2193
2194 void
2195 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2196 {
2197     sv_setnv(sv,num);
2198     SvSETMAGIC(sv);
2199 }
2200
2201 /* Print an "isn't numeric" warning, using a cleaned-up,
2202  * printable version of the offending string
2203  */
2204
2205 STATIC void
2206 S_not_a_number(pTHX_ SV *sv)
2207 {
2208      SV *dsv;
2209      char tmpbuf[64];
2210      char *pv;
2211
2212      if (DO_UTF8(sv)) {
2213           dsv = sv_2mortal(newSVpv("", 0));
2214           pv = sv_uni_display(dsv, sv, 10, 0);
2215      } else {
2216           char *d = tmpbuf;
2217           char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2218           /* each *s can expand to 4 chars + "...\0",
2219              i.e. need room for 8 chars */
2220         
2221           char *s, *end;
2222           for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2223                int ch = *s & 0xFF;
2224                if (ch & 128 && !isPRINT_LC(ch)) {
2225                     *d++ = 'M';
2226                     *d++ = '-';
2227                     ch &= 127;
2228                }
2229                if (ch == '\n') {
2230                     *d++ = '\\';
2231                     *d++ = 'n';
2232                }
2233                else if (ch == '\r') {
2234                     *d++ = '\\';
2235                     *d++ = 'r';
2236                }
2237                else if (ch == '\f') {
2238                     *d++ = '\\';
2239                     *d++ = 'f';
2240                }
2241                else if (ch == '\\') {
2242                     *d++ = '\\';
2243                     *d++ = '\\';
2244                }
2245                else if (ch == '\0') {
2246                     *d++ = '\\';
2247                     *d++ = '0';
2248                }
2249                else if (isPRINT_LC(ch))
2250                     *d++ = ch;
2251                else {
2252                     *d++ = '^';
2253                     *d++ = toCTRL(ch);
2254                }
2255           }
2256           if (s < end) {
2257                *d++ = '.';
2258                *d++ = '.';
2259                *d++ = '.';
2260           }
2261           *d = '\0';
2262           pv = tmpbuf;
2263     }
2264
2265     if (PL_op)
2266         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2267                     "Argument \"%s\" isn't numeric in %s", pv,
2268                     OP_DESC(PL_op));
2269     else
2270         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2271                     "Argument \"%s\" isn't numeric", pv);
2272 }
2273
2274 /*
2275 =for apidoc looks_like_number
2276
2277 Test if the content of an SV looks like a number (or is a number).
2278 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2279 non-numeric warning), even if your atof() doesn't grok them.
2280
2281 =cut
2282 */
2283
2284 I32
2285 Perl_looks_like_number(pTHX_ SV *sv)
2286 {
2287     register const char *sbegin;
2288     STRLEN len;
2289
2290     if (SvPOK(sv)) {
2291         sbegin = SvPVX(sv);
2292         len = SvCUR(sv);
2293     }
2294     else if (SvPOKp(sv))
2295         sbegin = SvPV(sv, len);
2296     else
2297         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2298     return grok_number(sbegin, len, NULL);
2299 }
2300
2301 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2302    until proven guilty, assume that things are not that bad... */
2303
2304 /*
2305    NV_PRESERVES_UV:
2306
2307    As 64 bit platforms often have an NV that doesn't preserve all bits of
2308    an IV (an assumption perl has been based on to date) it becomes necessary
2309    to remove the assumption that the NV always carries enough precision to
2310    recreate the IV whenever needed, and that the NV is the canonical form.
2311    Instead, IV/UV and NV need to be given equal rights. So as to not lose
2312    precision as a side effect of conversion (which would lead to insanity
2313    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2314    1) to distinguish between IV/UV/NV slots that have cached a valid
2315       conversion where precision was lost and IV/UV/NV slots that have a
2316       valid conversion which has lost no precision
2317    2) to ensure that if a numeric conversion to one form is requested that
2318       would lose precision, the precise conversion (or differently
2319       imprecise conversion) is also performed and cached, to prevent
2320       requests for different numeric formats on the same SV causing
2321       lossy conversion chains. (lossless conversion chains are perfectly
2322       acceptable (still))
2323
2324
2325    flags are used:
2326    SvIOKp is true if the IV slot contains a valid value
2327    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
2328    SvNOKp is true if the NV slot contains a valid value
2329    SvNOK  is true only if the NV value is accurate
2330
2331    so
2332    while converting from PV to NV, check to see if converting that NV to an
2333    IV(or UV) would lose accuracy over a direct conversion from PV to
2334    IV(or UV). If it would, cache both conversions, return NV, but mark
2335    SV as IOK NOKp (ie not NOK).
2336
2337    While converting from PV to IV, check to see if converting that IV to an
2338    NV would lose accuracy over a direct conversion from PV to NV. If it
2339    would, cache both conversions, flag similarly.
2340
2341    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2342    correctly because if IV & NV were set NV *always* overruled.
2343    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2344    changes - now IV and NV together means that the two are interchangeable:
2345    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2346
2347    The benefit of this is that operations such as pp_add know that if
2348    SvIOK is true for both left and right operands, then integer addition
2349    can be used instead of floating point (for cases where the result won't
2350    overflow). Before, floating point was always used, which could lead to
2351    loss of precision compared with integer addition.
2352
2353    * making IV and NV equal status should make maths accurate on 64 bit
2354      platforms
2355    * may speed up maths somewhat if pp_add and friends start to use
2356      integers when possible instead of fp. (Hopefully the overhead in
2357      looking for SvIOK and checking for overflow will not outweigh the
2358      fp to integer speedup)
2359    * will slow down integer operations (callers of SvIV) on "inaccurate"
2360      values, as the change from SvIOK to SvIOKp will cause a call into
2361      sv_2iv each time rather than a macro access direct to the IV slot
2362    * should speed up number->string conversion on integers as IV is
2363      favoured when IV and NV are equally accurate
2364
2365    ####################################################################
2366    You had better be using SvIOK_notUV if you want an IV for arithmetic:
2367    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2368    On the other hand, SvUOK is true iff UV.
2369    ####################################################################
2370
2371    Your mileage will vary depending your CPU's relative fp to integer
2372    performance ratio.
2373 */
2374
2375 #ifndef NV_PRESERVES_UV
2376 #  define IS_NUMBER_UNDERFLOW_IV 1
2377 #  define IS_NUMBER_UNDERFLOW_UV 2
2378 #  define IS_NUMBER_IV_AND_UV    2
2379 #  define IS_NUMBER_OVERFLOW_IV  4
2380 #  define IS_NUMBER_OVERFLOW_UV  5
2381
2382 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2383
2384 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
2385 STATIC int
2386 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2387 {
2388     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));
2389     if (SvNVX(sv) < (NV)IV_MIN) {
2390         (void)SvIOKp_on(sv);
2391         (void)SvNOK_on(sv);
2392         SvIV_set(sv, IV_MIN);
2393         return IS_NUMBER_UNDERFLOW_IV;
2394     }
2395     if (SvNVX(sv) > (NV)UV_MAX) {
2396         (void)SvIOKp_on(sv);
2397         (void)SvNOK_on(sv);
2398         SvIsUV_on(sv);
2399         SvUV_set(sv, UV_MAX);
2400         return IS_NUMBER_OVERFLOW_UV;
2401     }
2402     (void)SvIOKp_on(sv);
2403     (void)SvNOK_on(sv);
2404     /* Can't use strtol etc to convert this string.  (See truth table in
2405        sv_2iv  */
2406     if (SvNVX(sv) <= (UV)IV_MAX) {
2407         SvIV_set(sv, I_V(SvNVX(sv)));
2408         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2409             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2410         } else {
2411             /* Integer is imprecise. NOK, IOKp */
2412         }
2413         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2414     }
2415     SvIsUV_on(sv);
2416     SvUV_set(sv, U_V(SvNVX(sv)));
2417     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2418         if (SvUVX(sv) == UV_MAX) {
2419             /* As we know that NVs don't preserve UVs, UV_MAX cannot
2420                possibly be preserved by NV. Hence, it must be overflow.
2421                NOK, IOKp */
2422             return IS_NUMBER_OVERFLOW_UV;
2423         }
2424         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2425     } else {
2426         /* Integer is imprecise. NOK, IOKp */
2427     }
2428     return IS_NUMBER_OVERFLOW_IV;
2429 }
2430 #endif /* !NV_PRESERVES_UV*/
2431
2432 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2433  * this function provided for binary compatibility only
2434  */
2435
2436 IV
2437 Perl_sv_2iv(pTHX_ register SV *sv)
2438 {
2439     return sv_2iv_flags(sv, SV_GMAGIC);
2440 }
2441
2442 /*
2443 =for apidoc sv_2iv_flags
2444
2445 Return the integer value of an SV, doing any necessary string
2446 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2447 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2448
2449 =cut
2450 */
2451
2452 IV
2453 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2454 {
2455     if (!sv)
2456         return 0;
2457     if (SvGMAGICAL(sv)) {
2458         if (flags & SV_GMAGIC)
2459             mg_get(sv);
2460         if (SvIOKp(sv))
2461             return SvIVX(sv);
2462         if (SvNOKp(sv)) {
2463             return I_V(SvNVX(sv));
2464         }
2465         if (SvPOKp(sv) && SvLEN(sv))
2466             return asIV(sv);
2467         if (!SvROK(sv)) {
2468             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2469                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2470                     report_uninit(sv);
2471             }
2472             return 0;
2473         }
2474     }
2475     if (SvTHINKFIRST(sv)) {
2476         if (SvROK(sv)) {
2477           SV* tmpstr;
2478           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2479                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2480               return SvIV(tmpstr);
2481           return PTR2IV(SvRV(sv));
2482         }
2483         if (SvIsCOW(sv)) {
2484             sv_force_normal_flags(sv, 0);
2485         }
2486         if (SvREADONLY(sv) && !SvOK(sv)) {
2487             if (ckWARN(WARN_UNINITIALIZED))
2488                 report_uninit(sv);
2489             return 0;
2490         }
2491     }
2492     if (SvIOKp(sv)) {
2493         if (SvIsUV(sv)) {
2494             return (IV)(SvUVX(sv));
2495         }
2496         else {
2497             return SvIVX(sv);
2498         }
2499     }
2500     if (SvNOKp(sv)) {
2501         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2502          * without also getting a cached IV/UV from it at the same time
2503          * (ie PV->NV conversion should detect loss of accuracy and cache
2504          * IV or UV at same time to avoid this.  NWC */
2505
2506         if (SvTYPE(sv) == SVt_NV)
2507             sv_upgrade(sv, SVt_PVNV);
2508
2509         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2510         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2511            certainly cast into the IV range at IV_MAX, whereas the correct
2512            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2513            cases go to UV */
2514         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2515             SvIV_set(sv, I_V(SvNVX(sv)));
2516             if (SvNVX(sv) == (NV) SvIVX(sv)
2517 #ifndef NV_PRESERVES_UV
2518                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2519                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2520                 /* Don't flag it as "accurately an integer" if the number
2521                    came from a (by definition imprecise) NV operation, and
2522                    we're outside the range of NV integer precision */
2523 #endif
2524                 ) {
2525                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2526                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2527                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2528                                       PTR2UV(sv),
2529                                       SvNVX(sv),
2530                                       SvIVX(sv)));
2531
2532             } else {
2533                 /* IV not precise.  No need to convert from PV, as NV
2534                    conversion would already have cached IV if it detected
2535                    that PV->IV would be better than PV->NV->IV
2536                    flags already correct - don't set public IOK.  */
2537                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2538                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2539                                       PTR2UV(sv),
2540                                       SvNVX(sv),
2541                                       SvIVX(sv)));
2542             }
2543             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2544                but the cast (NV)IV_MIN rounds to a the value less (more
2545                negative) than IV_MIN which happens to be equal to SvNVX ??
2546                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2547                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2548                (NV)UVX == NVX are both true, but the values differ. :-(
2549                Hopefully for 2s complement IV_MIN is something like
2550                0x8000000000000000 which will be exact. NWC */
2551         }
2552         else {
2553             SvUV_set(sv, U_V(SvNVX(sv)));
2554             if (
2555                 (SvNVX(sv) == (NV) SvUVX(sv))
2556 #ifndef  NV_PRESERVES_UV
2557                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2558                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2559                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2560                 /* Don't flag it as "accurately an integer" if the number
2561                    came from a (by definition imprecise) NV operation, and
2562                    we're outside the range of NV integer precision */
2563 #endif
2564                 )
2565                 SvIOK_on(sv);
2566             SvIsUV_on(sv);
2567           ret_iv_max:
2568             DEBUG_c(PerlIO_printf(Perl_debug_log,
2569                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2570                                   PTR2UV(sv),
2571                                   SvUVX(sv),
2572                                   SvUVX(sv)));
2573             return (IV)SvUVX(sv);
2574         }
2575     }
2576     else if (SvPOKp(sv) && SvLEN(sv)) {
2577         UV value;
2578         const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2579         /* We want to avoid a possible problem when we cache an IV which
2580            may be later translated to an NV, and the resulting NV is not
2581            the same as the direct translation of the initial string
2582            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2583            be careful to ensure that the value with the .456 is around if the
2584            NV value is requested in the future).
2585         
2586            This means that if we cache such an IV, we need to cache the
2587            NV as well.  Moreover, we trade speed for space, and do not
2588            cache the NV if we are sure it's not needed.
2589          */
2590
2591         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2592         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2593              == IS_NUMBER_IN_UV) {
2594             /* It's definitely an integer, only upgrade to PVIV */
2595             if (SvTYPE(sv) < SVt_PVIV)
2596                 sv_upgrade(sv, SVt_PVIV);
2597             (void)SvIOK_on(sv);
2598         } else if (SvTYPE(sv) < SVt_PVNV)
2599             sv_upgrade(sv, SVt_PVNV);
2600
2601         /* If NV preserves UV then we only use the UV value if we know that
2602            we aren't going to call atof() below. If NVs don't preserve UVs
2603            then the value returned may have more precision than atof() will
2604            return, even though value isn't perfectly accurate.  */
2605         if ((numtype & (IS_NUMBER_IN_UV
2606 #ifdef NV_PRESERVES_UV
2607                         | IS_NUMBER_NOT_INT
2608 #endif
2609             )) == IS_NUMBER_IN_UV) {
2610             /* This won't turn off the public IOK flag if it was set above  */
2611             (void)SvIOKp_on(sv);
2612
2613             if (!(numtype & IS_NUMBER_NEG)) {
2614                 /* positive */;
2615                 if (value <= (UV)IV_MAX) {
2616                     SvIV_set(sv, (IV)value);
2617                 } else {
2618                     SvUV_set(sv, value);
2619                     SvIsUV_on(sv);
2620                 }
2621             } else {
2622                 /* 2s complement assumption  */
2623                 if (value <= (UV)IV_MIN) {
2624                     SvIV_set(sv, -(IV)value);
2625                 } else {
2626                     /* Too negative for an IV.  This is a double upgrade, but
2627                        I'm assuming it will be rare.  */
2628                     if (SvTYPE(sv) < SVt_PVNV)
2629                         sv_upgrade(sv, SVt_PVNV);
2630                     SvNOK_on(sv);
2631                     SvIOK_off(sv);
2632                     SvIOKp_on(sv);
2633                     SvNV_set(sv, -(NV)value);
2634                     SvIV_set(sv, IV_MIN);
2635                 }
2636             }
2637         }
2638         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2639            will be in the previous block to set the IV slot, and the next
2640            block to set the NV slot.  So no else here.  */
2641         
2642         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2643             != IS_NUMBER_IN_UV) {
2644             /* It wasn't an (integer that doesn't overflow the UV). */
2645             SvNV_set(sv, Atof(SvPVX(sv)));
2646
2647             if (! numtype && ckWARN(WARN_NUMERIC))
2648                 not_a_number(sv);
2649
2650 #if defined(USE_LONG_DOUBLE)
2651             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2652                                   PTR2UV(sv), SvNVX(sv)));
2653 #else
2654             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2655                                   PTR2UV(sv), SvNVX(sv)));
2656 #endif
2657
2658
2659 #ifdef NV_PRESERVES_UV
2660             (void)SvIOKp_on(sv);
2661             (void)SvNOK_on(sv);
2662             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2663                 SvIV_set(sv, I_V(SvNVX(sv)));
2664                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2665                     SvIOK_on(sv);
2666                 } else {
2667                     /* Integer is imprecise. NOK, IOKp */
2668                 }
2669                 /* UV will not work better than IV */
2670             } else {
2671                 if (SvNVX(sv) > (NV)UV_MAX) {
2672                     SvIsUV_on(sv);
2673                     /* Integer is inaccurate. NOK, IOKp, is UV */
2674                     SvUV_set(sv, UV_MAX);
2675                     SvIsUV_on(sv);
2676                 } else {
2677                     SvUV_set(sv, U_V(SvNVX(sv)));
2678                     /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2679                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2680                         SvIOK_on(sv);
2681                         SvIsUV_on(sv);
2682                     } else {
2683                         /* Integer is imprecise. NOK, IOKp, is UV */
2684                         SvIsUV_on(sv);
2685                     }
2686                 }
2687                 goto ret_iv_max;
2688             }
2689 #else /* NV_PRESERVES_UV */
2690             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2691                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2692                 /* The IV slot will have been set from value returned by
2693                    grok_number above.  The NV slot has just been set using
2694                    Atof.  */
2695                 SvNOK_on(sv);
2696                 assert (SvIOKp(sv));
2697             } else {
2698                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2699                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2700                     /* Small enough to preserve all bits. */
2701                     (void)SvIOKp_on(sv);
2702                     SvNOK_on(sv);
2703                     SvIV_set(sv, I_V(SvNVX(sv)));
2704                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2705                         SvIOK_on(sv);
2706                     /* Assumption: first non-preserved integer is < IV_MAX,
2707                        this NV is in the preserved range, therefore: */
2708                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2709                           < (UV)IV_MAX)) {
2710                         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);
2711                     }
2712                 } else {
2713                     /* IN_UV NOT_INT
2714                          0      0       already failed to read UV.
2715                          0      1       already failed to read UV.
2716                          1      0       you won't get here in this case. IV/UV
2717                                         slot set, public IOK, Atof() unneeded.
2718                          1      1       already read UV.
2719                        so there's no point in sv_2iuv_non_preserve() attempting
2720                        to use atol, strtol, strtoul etc.  */
2721                     if (sv_2iuv_non_preserve (sv, numtype)
2722                         >= IS_NUMBER_OVERFLOW_IV)
2723                     goto ret_iv_max;
2724                 }
2725             }
2726 #endif /* NV_PRESERVES_UV */
2727         }
2728     } else  {
2729         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2730             report_uninit(sv);
2731         if (SvTYPE(sv) < SVt_IV)
2732             /* Typically the caller expects that sv_any is not NULL now.  */
2733             sv_upgrade(sv, SVt_IV);
2734         return 0;
2735     }
2736     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2737         PTR2UV(sv),SvIVX(sv)));
2738     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2739 }
2740
2741 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2742  * this function provided for binary compatibility only
2743  */
2744
2745 UV
2746 Perl_sv_2uv(pTHX_ register SV *sv)
2747 {
2748     return sv_2uv_flags(sv, SV_GMAGIC);
2749 }
2750
2751 /*
2752 =for apidoc sv_2uv_flags
2753
2754 Return the unsigned integer value of an SV, doing any necessary string
2755 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2756 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2757
2758 =cut
2759 */
2760
2761 UV
2762 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2763 {
2764     if (!sv)
2765         return 0;
2766     if (SvGMAGICAL(sv)) {
2767         if (flags & SV_GMAGIC)
2768             mg_get(sv);
2769         if (SvIOKp(sv))
2770             return SvUVX(sv);
2771         if (SvNOKp(sv))
2772             return U_V(SvNVX(sv));
2773         if (SvPOKp(sv) && SvLEN(sv))
2774             return asUV(sv);
2775         if (!SvROK(sv)) {
2776             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2777                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2778                     report_uninit(sv);
2779             }
2780             return 0;
2781         }
2782     }
2783     if (SvTHINKFIRST(sv)) {
2784         if (SvROK(sv)) {
2785           SV* tmpstr;
2786           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2787                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2788               return SvUV(tmpstr);
2789           return PTR2UV(SvRV(sv));
2790         }
2791         if (SvIsCOW(sv)) {
2792             sv_force_normal_flags(sv, 0);
2793         }
2794         if (SvREADONLY(sv) && !SvOK(sv)) {
2795             if (ckWARN(WARN_UNINITIALIZED))
2796                 report_uninit(sv);
2797             return 0;
2798         }
2799     }
2800     if (SvIOKp(sv)) {
2801         if (SvIsUV(sv)) {
2802             return SvUVX(sv);
2803         }
2804         else {
2805             return (UV)SvIVX(sv);
2806         }
2807     }
2808     if (SvNOKp(sv)) {
2809         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2810          * without also getting a cached IV/UV from it at the same time
2811          * (ie PV->NV conversion should detect loss of accuracy and cache
2812          * IV or UV at same time to avoid this. */
2813         /* IV-over-UV optimisation - choose to cache IV if possible */
2814
2815         if (SvTYPE(sv) == SVt_NV)
2816             sv_upgrade(sv, SVt_PVNV);
2817
2818         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2819         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2820             SvIV_set(sv, I_V(SvNVX(sv)));
2821             if (SvNVX(sv) == (NV) SvIVX(sv)
2822 #ifndef NV_PRESERVES_UV
2823                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2824                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2825                 /* Don't flag it as "accurately an integer" if the number
2826                    came from a (by definition imprecise) NV operation, and
2827                    we're outside the range of NV integer precision */
2828 #endif
2829                 ) {
2830                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2831                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2832                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2833                                       PTR2UV(sv),
2834                                       SvNVX(sv),
2835                                       SvIVX(sv)));
2836
2837             } else {
2838                 /* IV not precise.  No need to convert from PV, as NV
2839                    conversion would already have cached IV if it detected
2840                    that PV->IV would be better than PV->NV->IV
2841                    flags already correct - don't set public IOK.  */
2842                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2843                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2844                                       PTR2UV(sv),
2845                                       SvNVX(sv),
2846                                       SvIVX(sv)));
2847             }
2848             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2849                but the cast (NV)IV_MIN rounds to a the value less (more
2850                negative) than IV_MIN which happens to be equal to SvNVX ??
2851                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2852                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2853                (NV)UVX == NVX are both true, but the values differ. :-(
2854                Hopefully for 2s complement IV_MIN is something like
2855                0x8000000000000000 which will be exact. NWC */
2856         }
2857         else {
2858             SvUV_set(sv, U_V(SvNVX(sv)));
2859             if (
2860                 (SvNVX(sv) == (NV) SvUVX(sv))
2861 #ifndef  NV_PRESERVES_UV
2862                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2863                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2864                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2865                 /* Don't flag it as "accurately an integer" if the number
2866                    came from a (by definition imprecise) NV operation, and
2867                    we're outside the range of NV integer precision */
2868 #endif
2869                 )
2870                 SvIOK_on(sv);
2871             SvIsUV_on(sv);
2872             DEBUG_c(PerlIO_printf(Perl_debug_log,
2873                                   "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2874                                   PTR2UV(sv),
2875                                   SvUVX(sv),
2876                                   SvUVX(sv)));
2877         }
2878     }
2879     else if (SvPOKp(sv) && SvLEN(sv)) {
2880         UV value;
2881         const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2882
2883         /* We want to avoid a possible problem when we cache a UV which
2884            may be later translated to an NV, and the resulting NV is not
2885            the translation of the initial data.
2886         
2887            This means that if we cache such a UV, we need to cache the
2888            NV as well.  Moreover, we trade speed for space, and do not
2889            cache the NV if not needed.
2890          */
2891
2892         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2893         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2894              == IS_NUMBER_IN_UV) {
2895             /* It's definitely an integer, only upgrade to PVIV */
2896             if (SvTYPE(sv) < SVt_PVIV)
2897                 sv_upgrade(sv, SVt_PVIV);
2898             (void)SvIOK_on(sv);
2899         } else if (SvTYPE(sv) < SVt_PVNV)
2900             sv_upgrade(sv, SVt_PVNV);
2901
2902         /* If NV preserves UV then we only use the UV value if we know that
2903            we aren't going to call atof() below. If NVs don't preserve UVs
2904            then the value returned may have more precision than atof() will
2905            return, even though it isn't accurate.  */
2906         if ((numtype & (IS_NUMBER_IN_UV
2907 #ifdef NV_PRESERVES_UV
2908                         | IS_NUMBER_NOT_INT
2909 #endif
2910             )) == IS_NUMBER_IN_UV) {
2911             /* This won't turn off the public IOK flag if it was set above  */
2912             (void)SvIOKp_on(sv);
2913
2914             if (!(numtype & IS_NUMBER_NEG)) {
2915                 /* positive */;
2916                 if (value <= (UV)IV_MAX) {
2917                     SvIV_set(sv, (IV)value);
2918                 } else {
2919                     /* it didn't overflow, and it was positive. */
2920                     SvUV_set(sv, value);
2921                     SvIsUV_on(sv);
2922                 }
2923             } else {
2924                 /* 2s complement assumption  */
2925                 if (value <= (UV)IV_MIN) {
2926                     SvIV_set(sv, -(IV)value);
2927                 } else {
2928                     /* Too negative for an IV.  This is a double upgrade, but
2929                        I'm assuming it will be rare.  */
2930                     if (SvTYPE(sv) < SVt_PVNV)
2931                         sv_upgrade(sv, SVt_PVNV);
2932                     SvNOK_on(sv);
2933                     SvIOK_off(sv);
2934                     SvIOKp_on(sv);
2935                     SvNV_set(sv, -(NV)value);
2936                     SvIV_set(sv, IV_MIN);
2937                 }
2938             }
2939         }
2940         
2941         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2942             != IS_NUMBER_IN_UV) {
2943             /* It wasn't an integer, or it overflowed the UV. */
2944             SvNV_set(sv, Atof(SvPVX(sv)));
2945
2946             if (! numtype && ckWARN(WARN_NUMERIC))
2947                     not_a_number(sv);
2948
2949 #if defined(USE_LONG_DOUBLE)
2950             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2951                                   PTR2UV(sv), SvNVX(sv)));
2952 #else
2953             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2954                                   PTR2UV(sv), SvNVX(sv)));
2955 #endif
2956
2957 #ifdef NV_PRESERVES_UV
2958             (void)SvIOKp_on(sv);
2959             (void)SvNOK_on(sv);
2960             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2961                 SvIV_set(sv, I_V(SvNVX(sv)));
2962                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2963                     SvIOK_on(sv);
2964                 } else {
2965                     /* Integer is imprecise. NOK, IOKp */
2966                 }
2967                 /* UV will not work better than IV */
2968             } else {
2969                 if (SvNVX(sv) > (NV)UV_MAX) {
2970                     SvIsUV_on(sv);
2971                     /* Integer is inaccurate. NOK, IOKp, is UV */
2972                     SvUV_set(sv, UV_MAX);
2973                     SvIsUV_on(sv);
2974                 } else {
2975                     SvUV_set(sv, U_V(SvNVX(sv)));
2976                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2977                        NV preservse UV so can do correct comparison.  */
2978                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2979                         SvIOK_on(sv);
2980                         SvIsUV_on(sv);
2981                     } else {
2982                         /* Integer is imprecise. NOK, IOKp, is UV */
2983                         SvIsUV_on(sv);
2984                     }
2985                 }
2986             }
2987 #else /* NV_PRESERVES_UV */
2988             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2989                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2990                 /* The UV slot will have been set from value returned by
2991                    grok_number above.  The NV slot has just been set using
2992                    Atof.  */
2993                 SvNOK_on(sv);
2994                 assert (SvIOKp(sv));
2995             } else {
2996                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2997                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2998                     /* Small enough to preserve all bits. */
2999                     (void)SvIOKp_on(sv);
3000                     SvNOK_on(sv);
3001                     SvIV_set(sv, I_V(SvNVX(sv)));
3002                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
3003                         SvIOK_on(sv);
3004                     /* Assumption: first non-preserved integer is < IV_MAX,
3005                        this NV is in the preserved range, therefore: */
3006                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3007                           < (UV)IV_MAX)) {
3008                         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);
3009                     }
3010                 } else
3011                     sv_2iuv_non_preserve (sv, numtype);
3012             }
3013 #endif /* NV_PRESERVES_UV */
3014         }
3015     }
3016     else  {
3017         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3018             if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3019                 report_uninit(sv);
3020         }
3021         if (SvTYPE(sv) < SVt_IV)
3022             /* Typically the caller expects that sv_any is not NULL now.  */
3023             sv_upgrade(sv, SVt_IV);
3024         return 0;
3025     }
3026
3027     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3028                           PTR2UV(sv),SvUVX(sv)));
3029     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3030 }
3031
3032 /*
3033 =for apidoc sv_2nv
3034
3035 Return the num value of an SV, doing any necessary string or integer
3036 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3037 macros.
3038
3039 =cut
3040 */
3041
3042 NV
3043 Perl_sv_2nv(pTHX_ register SV *sv)
3044 {
3045     if (!sv)
3046         return 0.0;
3047     if (SvGMAGICAL(sv)) {
3048         mg_get(sv);
3049         if (SvNOKp(sv))
3050             return SvNVX(sv);
3051         if (SvPOKp(sv) && SvLEN(sv)) {
3052             if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3053                 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3054                 not_a_number(sv);
3055             return Atof(SvPVX(sv));
3056         }
3057         if (SvIOKp(sv)) {
3058             if (SvIsUV(sv))
3059                 return (NV)SvUVX(sv);
3060             else
3061                 return (NV)SvIVX(sv);
3062         }       
3063         if (!SvROK(sv)) {
3064             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3065                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3066                     report_uninit(sv);
3067             }
3068             return 0;
3069         }
3070     }
3071     if (SvTHINKFIRST(sv)) {
3072         if (SvROK(sv)) {
3073           SV* tmpstr;
3074           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3075                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3076               return SvNV(tmpstr);
3077           return PTR2NV(SvRV(sv));
3078         }
3079         if (SvIsCOW(sv)) {
3080             sv_force_normal_flags(sv, 0);
3081         }
3082         if (SvREADONLY(sv) && !SvOK(sv)) {
3083             if (ckWARN(WARN_UNINITIALIZED))
3084                 report_uninit(sv);
3085             return 0.0;
3086         }
3087     }
3088     if (SvTYPE(sv) < SVt_NV) {
3089         if (SvTYPE(sv) == SVt_IV)
3090             sv_upgrade(sv, SVt_PVNV);
3091         else
3092             sv_upgrade(sv, SVt_NV);
3093 #ifdef USE_LONG_DOUBLE
3094         DEBUG_c({
3095             STORE_NUMERIC_LOCAL_SET_STANDARD();
3096             PerlIO_printf(Perl_debug_log,
3097                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3098                           PTR2UV(sv), SvNVX(sv));
3099             RESTORE_NUMERIC_LOCAL();
3100         });
3101 #else
3102         DEBUG_c({
3103             STORE_NUMERIC_LOCAL_SET_STANDARD();
3104             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3105                           PTR2UV(sv), SvNVX(sv));
3106             RESTORE_NUMERIC_LOCAL();
3107         });
3108 #endif
3109     }
3110     else if (SvTYPE(sv) < SVt_PVNV)
3111         sv_upgrade(sv, SVt_PVNV);
3112     if (SvNOKp(sv)) {
3113         return SvNVX(sv);
3114     }
3115     if (SvIOKp(sv)) {
3116         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3117 #ifdef NV_PRESERVES_UV
3118         SvNOK_on(sv);
3119 #else
3120         /* Only set the public NV OK flag if this NV preserves the IV  */
3121         /* Check it's not 0xFFFFFFFFFFFFFFFF */
3122         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3123                        : (SvIVX(sv) == I_V(SvNVX(sv))))
3124             SvNOK_on(sv);
3125         else
3126             SvNOKp_on(sv);
3127 #endif
3128     }
3129     else if (SvPOKp(sv) && SvLEN(sv)) {
3130         UV value;
3131         const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3132         if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3133             not_a_number(sv);
3134 #ifdef NV_PRESERVES_UV
3135         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3136             == IS_NUMBER_IN_UV) {
3137             /* It's definitely an integer */
3138             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3139         } else
3140             SvNV_set(sv, Atof(SvPVX(sv)));
3141         SvNOK_on(sv);
3142 #else
3143         SvNV_set(sv, Atof(SvPVX(sv)));
3144         /* Only set the public NV OK flag if this NV preserves the value in
3145            the PV at least as well as an IV/UV would.
3146            Not sure how to do this 100% reliably. */
3147         /* if that shift count is out of range then Configure's test is
3148            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3149            UV_BITS */
3150         if (((UV)1 << NV_PRESERVES_UV_BITS) >
3151             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3152             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3153         } else if (!(numtype & IS_NUMBER_IN_UV)) {
3154             /* Can't use strtol etc to convert this string, so don't try.
3155                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
3156             SvNOK_on(sv);
3157         } else {
3158             /* value has been set.  It may not be precise.  */
3159             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3160                 /* 2s complement assumption for (UV)IV_MIN  */
3161                 SvNOK_on(sv); /* Integer is too negative.  */
3162             } else {
3163                 SvNOKp_on(sv);
3164                 SvIOKp_on(sv);
3165
3166                 if (numtype & IS_NUMBER_NEG) {
3167                     SvIV_set(sv, -(IV)value);
3168                 } else if (value <= (UV)IV_MAX) {
3169                     SvIV_set(sv, (IV)value);
3170                 } else {
3171                     SvUV_set(sv, value);
3172                     SvIsUV_on(sv);
3173                 }
3174
3175                 if (numtype & IS_NUMBER_NOT_INT) {
3176                     /* I believe that even if the original PV had decimals,
3177                        they are lost beyond the limit of the FP precision.
3178                        However, neither is canonical, so both only get p
3179                        flags.  NWC, 2000/11/25 */
3180                     /* Both already have p flags, so do nothing */
3181                 } else {
3182                     NV nv = SvNVX(sv);
3183                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3184                         if (SvIVX(sv) == I_V(nv)) {
3185                             SvNOK_on(sv);
3186                             SvIOK_on(sv);
3187                         } else {
3188                             SvIOK_on(sv);
3189                             /* It had no "." so it must be integer.  */
3190                         }
3191                     } else {
3192                         /* between IV_MAX and NV(UV_MAX).
3193                            Could be slightly > UV_MAX */
3194
3195                         if (numtype & IS_NUMBER_NOT_INT) {
3196                             /* UV and NV both imprecise.  */
3197                         } else {
3198                             UV nv_as_uv = U_V(nv);
3199
3200                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3201                                 SvNOK_on(sv);
3202                                 SvIOK_on(sv);
3203                             } else {
3204                                 SvIOK_on(sv);
3205                             }
3206                         }
3207                     }
3208                 }
3209             }
3210         }
3211 #endif /* NV_PRESERVES_UV */
3212     }
3213     else  {
3214         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3215             report_uninit(sv);
3216         if (SvTYPE(sv) < SVt_NV)
3217             /* Typically the caller expects that sv_any is not NULL now.  */
3218             /* XXX Ilya implies that this is a bug in callers that assume this
3219                and ideally should be fixed.  */
3220             sv_upgrade(sv, SVt_NV);
3221         return 0.0;
3222     }
3223 #if defined(USE_LONG_DOUBLE)
3224     DEBUG_c({
3225         STORE_NUMERIC_LOCAL_SET_STANDARD();
3226         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3227                       PTR2UV(sv), SvNVX(sv));
3228         RESTORE_NUMERIC_LOCAL();
3229     });
3230 #else
3231     DEBUG_c({
3232         STORE_NUMERIC_LOCAL_SET_STANDARD();
3233         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3234                       PTR2UV(sv), SvNVX(sv));
3235         RESTORE_NUMERIC_LOCAL();
3236     });
3237 #endif
3238     return SvNVX(sv);
3239 }
3240
3241 /* asIV(): extract an integer from the string value of an SV.
3242  * Caller must validate PVX  */
3243
3244 STATIC IV
3245 S_asIV(pTHX_ SV *sv)
3246 {
3247     UV value;
3248     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3249
3250     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3251         == IS_NUMBER_IN_UV) {
3252         /* It's definitely an integer */
3253         if (numtype & IS_NUMBER_NEG) {
3254             if (value < (UV)IV_MIN)
3255                 return -(IV)value;
3256         } else {
3257             if (value < (UV)IV_MAX)
3258                 return (IV)value;
3259         }
3260     }
3261     if (!numtype) {
3262         if (ckWARN(WARN_NUMERIC))
3263             not_a_number(sv);
3264     }
3265     return I_V(Atof(SvPVX(sv)));
3266 }
3267
3268 /* asUV(): extract an unsigned integer from the string value of an SV
3269  * Caller must validate PVX  */
3270
3271 STATIC UV
3272 S_asUV(pTHX_ SV *sv)
3273 {
3274     UV value;
3275     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3276
3277     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3278         == IS_NUMBER_IN_UV) {
3279         /* It's definitely an integer */
3280         if (!(numtype & IS_NUMBER_NEG))
3281             return value;
3282     }
3283     if (!numtype) {
3284         if (ckWARN(WARN_NUMERIC))
3285             not_a_number(sv);
3286     }
3287     return U_V(Atof(SvPVX(sv)));
3288 }
3289
3290 /*
3291 =for apidoc sv_2pv_nolen
3292
3293 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3294 use the macro wrapper C<SvPV_nolen(sv)> instead.
3295 =cut
3296 */
3297
3298 char *
3299 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3300 {
3301     STRLEN n_a;
3302     return sv_2pv(sv, &n_a);
3303 }
3304
3305 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3306  * UV as a string towards the end of buf, and return pointers to start and
3307  * end of it.
3308  *
3309  * We assume that buf is at least TYPE_CHARS(UV) long.
3310  */
3311
3312 static char *
3313 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3314 {
3315     char *ptr = buf + TYPE_CHARS(UV);
3316     char *ebuf = ptr;
3317     int sign;
3318
3319     if (is_uv)
3320         sign = 0;
3321     else if (iv >= 0) {
3322         uv = iv;
3323         sign = 0;
3324     } else {
3325         uv = -iv;
3326         sign = 1;
3327     }
3328     do {
3329         *--ptr = '0' + (char)(uv % 10);
3330     } while (uv /= 10);
3331     if (sign)
3332         *--ptr = '-';
3333     *peob = ebuf;
3334     return ptr;
3335 }
3336
3337 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3338  * this function provided for binary compatibility only
3339  */
3340
3341 char *
3342 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3343 {
3344     return sv_2pv_flags(sv, lp, SV_GMAGIC);
3345 }
3346
3347 /*
3348 =for apidoc sv_2pv_flags
3349
3350 Returns a pointer to the string value of an SV, and sets *lp to its length.
3351 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3352 if necessary.
3353 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3354 usually end up here too.
3355
3356 =cut
3357 */
3358
3359 char *
3360 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3361 {
3362     register char *s;
3363     int olderrno;
3364     SV *tsv, *origsv;
3365     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
3366     char *tmpbuf = tbuf;
3367
3368     if (!sv) {
3369         *lp = 0;
3370         return (char *)"";
3371     }
3372     if (SvGMAGICAL(sv)) {
3373         if (flags & SV_GMAGIC)
3374             mg_get(sv);
3375         if (SvPOKp(sv)) {
3376             *lp = SvCUR(sv);
3377             return SvPVX(sv);
3378         }
3379         if (SvIOKp(sv)) {
3380             if (SvIsUV(sv))
3381                 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3382             else
3383                 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3384             tsv = Nullsv;
3385             goto tokensave;
3386         }
3387         if (SvNOKp(sv)) {
3388             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3389             tsv = Nullsv;
3390             goto tokensave;
3391         }
3392         if (!SvROK(sv)) {
3393             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3394                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3395                     report_uninit(sv);
3396             }
3397             *lp = 0;
3398             return (char *)"";
3399         }
3400     }
3401     if (SvTHINKFIRST(sv)) {
3402         if (SvROK(sv)) {
3403             SV* tmpstr;
3404             register const char *typestr;
3405             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3406                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3407                 char *pv = SvPV(tmpstr, *lp);
3408                 if (SvUTF8(tmpstr))
3409                     SvUTF8_on(sv);
3410                 else
3411                     SvUTF8_off(sv);
3412                 return pv;
3413             }
3414             origsv = sv;
3415             sv = (SV*)SvRV(sv);
3416             if (!sv)
3417                 typestr = "NULLREF";
3418             else {
3419                 MAGIC *mg;
3420                 
3421                 switch (SvTYPE(sv)) {
3422                 case SVt_PVMG:
3423                     if ( ((SvFLAGS(sv) &
3424                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3425                           == (SVs_OBJECT|SVs_SMG))
3426                          && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3427                         const regexp *re = (regexp *)mg->mg_obj;
3428
3429                         if (!mg->mg_ptr) {
3430                             const char *fptr = "msix";
3431                             char reflags[6];
3432                             char ch;
3433                             int left = 0;
3434                             int right = 4;
3435                             char need_newline = 0;
3436                             U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3437
3438                             while((ch = *fptr++)) {
3439                                 if(reganch & 1) {
3440                                     reflags[left++] = ch;
3441                                 }
3442                                 else {
3443                                     reflags[right--] = ch;
3444                                 }
3445                                 reganch >>= 1;
3446                             }
3447                             if(left != 4) {
3448                                 reflags[left] = '-';
3449                                 left = 5;
3450                             }
3451
3452                             mg->mg_len = re->prelen + 4 + left;
3453                             /*
3454                              * If /x was used, we have to worry about a regex
3455                              * ending with a comment later being embedded
3456                              * within another regex. If so, we don't want this
3457                              * regex's "commentization" to leak out to the
3458                              * right part of the enclosing regex, we must cap
3459                              * it with a newline.
3460                              *
3461                              * So, if /x was used, we scan backwards from the
3462                              * end of the regex. If we find a '#' before we
3463                              * find a newline, we need to add a newline
3464                              * ourself. If we find a '\n' first (or if we
3465                              * don't find '#' or '\n'), we don't need to add
3466                              * anything.  -jfriedl
3467                              */
3468                             if (PMf_EXTENDED & re->reganch)
3469                             {
3470                                 const char *endptr = re->precomp + re->prelen;
3471                                 while (endptr >= re->precomp)
3472                                 {
3473                                     const char c = *(endptr--);
3474                                     if (c == '\n')
3475                                         break; /* don't need another */
3476                                     if (c == '#') {
3477                                         /* we end while in a comment, so we
3478                                            need a newline */
3479                                         mg->mg_len++; /* save space for it */
3480                                         need_newline = 1; /* note to add it */
3481                                         break;
3482                                     }
3483                                 }
3484                             }
3485
3486                             New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3487                             Copy("(?", mg->mg_ptr, 2, char);
3488                             Copy(reflags, mg->mg_ptr+2, left, char);
3489                             Copy(":", mg->mg_ptr+left+2, 1, char);
3490                             Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3491                             if (need_newline)
3492                                 mg->mg_ptr[mg->mg_len - 2] = '\n';
3493                             mg->mg_ptr[mg->mg_len - 1] = ')';
3494                             mg->mg_ptr[mg->mg_len] = 0;
3495                         }
3496                         PL_reginterp_cnt += re->program[0].next_off;
3497
3498                         if (re->reganch & ROPT_UTF8)
3499                             SvUTF8_on(origsv);
3500                         else
3501                             SvUTF8_off(origsv);
3502                         *lp = mg->mg_len;
3503                         return mg->mg_ptr;
3504                     }
3505                                         /* Fall through */
3506                 case SVt_NULL:
3507                 case SVt_IV:
3508                 case SVt_NV:
3509                 case SVt_RV:
3510                 case SVt_PV:
3511                 case SVt_PVIV:
3512                 case SVt_PVNV:
3513                 case SVt_PVBM:  typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3514                 case SVt_PVLV:  typestr = SvROK(sv) ? "REF"
3515                                 /* tied lvalues should appear to be
3516                                  * scalars for backwards compatitbility */
3517                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3518                                     ? "SCALAR" : "LVALUE";      break;
3519                 case SVt_PVAV:  typestr = "ARRAY";      break;
3520                 case SVt_PVHV:  typestr = "HASH";       break;
3521                 case SVt_PVCV:  typestr = "CODE";       break;
3522                 case SVt_PVGV:  typestr = "GLOB";       break;
3523                 case SVt_PVFM:  typestr = "FORMAT";     break;
3524                 case SVt_PVIO:  typestr = "IO";         break;
3525                 default:        typestr = "UNKNOWN";    break;
3526                 }
3527                 tsv = NEWSV(0,0);
3528                 if (SvOBJECT(sv)) {
3529                     const char *name = HvNAME_get(SvSTASH(sv));
3530                     Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3531                                    name ? name : "__ANON__" , typestr, PTR2UV(sv));
3532                 }
3533                 else
3534                     Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3535                 goto tokensaveref;
3536             }
3537             *lp = strlen(typestr);
3538             return (char *)typestr;
3539         }
3540         if (SvREADONLY(sv) && !SvOK(sv)) {
3541             if (ckWARN(WARN_UNINITIALIZED))
3542                 report_uninit(sv);
3543             *lp = 0;
3544             return (char *)"";
3545         }
3546     }
3547     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3548         /* I'm assuming that if both IV and NV are equally valid then
3549            converting the IV is going to be more efficient */
3550         const U32 isIOK = SvIOK(sv);
3551         const U32 isUIOK = SvIsUV(sv);
3552         char buf[TYPE_CHARS(UV)];
3553         char *ebuf, *ptr;
3554
3555         if (SvTYPE(sv) < SVt_PVIV)
3556             sv_upgrade(sv, SVt_PVIV);
3557         if (isUIOK)
3558             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3559         else
3560             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3561         SvGROW(sv, (STRLEN)(ebuf - ptr + 1));   /* inlined from sv_setpvn */
3562         Move(ptr,SvPVX(sv),ebuf - ptr,char);
3563         SvCUR_set(sv, ebuf - ptr);
3564         s = SvEND(sv);
3565         *s = '\0';
3566         if (isIOK)
3567             SvIOK_on(sv);
3568         else
3569             SvIOKp_on(sv);
3570         if (isUIOK)
3571             SvIsUV_on(sv);
3572     }
3573     else if (SvNOKp(sv)) {
3574         if (SvTYPE(sv) < SVt_PVNV)
3575             sv_upgrade(sv, SVt_PVNV);
3576         /* The +20 is pure guesswork.  Configure test needed. --jhi */
3577         SvGROW(sv, NV_DIG + 20);
3578         s = SvPVX(sv);
3579         olderrno = errno;       /* some Xenix systems wipe out errno here */
3580 #ifdef apollo
3581         if (SvNVX(sv) == 0.0)
3582             (void)strcpy(s,"0");
3583         else
3584 #endif /*apollo*/
3585         {
3586             Gconvert(SvNVX(sv), NV_DIG, 0, s);
3587         }
3588         errno = olderrno;
3589 #ifdef FIXNEGATIVEZERO
3590         if (*s == '-' && s[1] == '0' && !s[2])
3591             strcpy(s,"0");
3592 #endif
3593         while (*s) s++;
3594 #ifdef hcx
3595         if (s[-1] == '.')
3596             *--s = '\0';
3597 #endif
3598     }
3599     else {
3600         if (ckWARN(WARN_UNINITIALIZED)
3601             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3602             report_uninit(sv);
3603         *lp = 0;
3604         if (SvTYPE(sv) < SVt_PV)
3605             /* Typically the caller expects that sv_any is not NULL now.  */
3606             sv_upgrade(sv, SVt_PV);
3607         return (char *)"";
3608     }
3609     *lp = s - SvPVX(sv);
3610     SvCUR_set(sv, *lp);
3611     SvPOK_on(sv);
3612     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3613                           PTR2UV(sv),SvPVX(sv)));
3614     return SvPVX(sv);
3615
3616   tokensave:
3617     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
3618         /* Sneaky stuff here */
3619
3620       tokensaveref:
3621         if (!tsv)
3622             tsv = newSVpv(tmpbuf, 0);
3623         sv_2mortal(tsv);
3624         *lp = SvCUR(tsv);
3625         return SvPVX(tsv);
3626     }
3627     else {
3628         dVAR;
3629         STRLEN len;
3630         const char *t;
3631
3632         if (tsv) {
3633             sv_2mortal(tsv);
3634             t = SvPVX(tsv);
3635             len = SvCUR(tsv);
3636         }
3637         else {
3638             t = tmpbuf;
3639             len = strlen(tmpbuf);
3640         }
3641 #ifdef FIXNEGATIVEZERO
3642         if (len == 2 && t[0] == '-' && t[1] == '0') {
3643             t = "0";
3644             len = 1;
3645         }
3646 #endif
3647         (void)SvUPGRADE(sv, SVt_PV);
3648         *lp = len;
3649         s = SvGROW(sv, len + 1);
3650         SvCUR_set(sv, len);
3651         SvPOKp_on(sv);
3652         return strcpy(s, t);
3653     }
3654 }
3655
3656 /*
3657 =for apidoc sv_copypv
3658
3659 Copies a stringified representation of the source SV into the
3660 destination SV.  Automatically performs any necessary mg_get and
3661 coercion of numeric values into strings.  Guaranteed to preserve
3662 UTF-8 flag even from overloaded objects.  Similar in nature to
3663 sv_2pv[_flags] but operates directly on an SV instead of just the
3664 string.  Mostly uses sv_2pv_flags to do its work, except when that
3665 would lose the UTF-8'ness of the PV.
3666
3667 =cut
3668 */
3669
3670 void
3671 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3672 {
3673     STRLEN len;
3674     char *s;
3675     s = SvPV(ssv,len);
3676     sv_setpvn(dsv,s,len);
3677     if (SvUTF8(ssv))
3678         SvUTF8_on(dsv);
3679     else
3680         SvUTF8_off(dsv);
3681 }
3682
3683 /*
3684 =for apidoc sv_2pvbyte_nolen
3685
3686 Return a pointer to the byte-encoded representation of the SV.
3687 May cause the SV to be downgraded from UTF-8 as a side-effect.
3688
3689 Usually accessed via the C<SvPVbyte_nolen> macro.
3690
3691 =cut
3692 */
3693
3694 char *
3695 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3696 {
3697     STRLEN n_a;
3698     return sv_2pvbyte(sv, &n_a);
3699 }
3700
3701 /*
3702 =for apidoc sv_2pvbyte
3703
3704 Return a pointer to the byte-encoded representation of the SV, and set *lp
3705 to its length.  May cause the SV to be downgraded from UTF-8 as a
3706 side-effect.
3707
3708 Usually accessed via the C<SvPVbyte> macro.
3709
3710 =cut
3711 */
3712
3713 char *
3714 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3715 {
3716     sv_utf8_downgrade(sv,0);
3717     return SvPV(sv,*lp);
3718 }
3719
3720 /*
3721 =for apidoc sv_2pvutf8_nolen
3722
3723 Return a pointer to the UTF-8-encoded representation of the SV.
3724 May cause the SV to be upgraded to UTF-8 as a side-effect.
3725
3726 Usually accessed via the C<SvPVutf8_nolen> macro.
3727
3728 =cut
3729 */
3730
3731 char *
3732 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3733 {
3734     STRLEN n_a;
3735     return sv_2pvutf8(sv, &n_a);
3736 }
3737
3738 /*
3739 =for apidoc sv_2pvutf8
3740
3741 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3742 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3743
3744 Usually accessed via the C<SvPVutf8> macro.
3745
3746 =cut
3747 */
3748
3749 char *
3750 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3751 {
3752     sv_utf8_upgrade(sv);
3753     return SvPV(sv,*lp);
3754 }
3755
3756 /*
3757 =for apidoc sv_2bool
3758
3759 This function is only called on magical items, and is only used by
3760 sv_true() or its macro equivalent.
3761
3762 =cut
3763 */
3764
3765 bool
3766 Perl_sv_2bool(pTHX_ register SV *sv)
3767 {
3768     if (SvGMAGICAL(sv))
3769         mg_get(sv);
3770
3771     if (!SvOK(sv))
3772         return 0;
3773     if (SvROK(sv)) {
3774         SV* tmpsv;
3775         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3776                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3777             return (bool)SvTRUE(tmpsv);
3778       return SvRV(sv) != 0;
3779     }
3780     if (SvPOKp(sv)) {
3781         register XPV* Xpvtmp;
3782         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3783                 (*sv->sv_u.sv_pv > '0' ||
3784                 Xpvtmp->xpv_cur > 1 ||
3785                 (Xpvtmp->xpv_cur && *sv->sv_u.sv_pv != '0')))
3786             return 1;
3787         else
3788             return 0;
3789     }
3790     else {
3791         if (SvIOKp(sv))
3792             return SvIVX(sv) != 0;
3793         else {
3794             if (SvNOKp(sv))
3795                 return SvNVX(sv) != 0.0;
3796             else
3797                 return FALSE;
3798         }
3799     }
3800 }
3801
3802 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3803  * this function provided for binary compatibility only
3804  */
3805
3806
3807 STRLEN
3808 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3809 {
3810     return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3811 }
3812
3813 /*
3814 =for apidoc sv_utf8_upgrade
3815
3816 Converts the PV of an SV to its UTF-8-encoded form.
3817 Forces the SV to string form if it is not already.
3818 Always sets the SvUTF8 flag to avoid future validity checks even
3819 if all the bytes have hibit clear.
3820
3821 This is not as a general purpose byte encoding to Unicode interface:
3822 use the Encode extension for that.
3823
3824 =for apidoc sv_utf8_upgrade_flags
3825
3826 Converts the PV of an SV to its UTF-8-encoded form.
3827 Forces the SV to string form if it is not already.
3828 Always sets the SvUTF8 flag to avoid future validity checks even
3829 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3830 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3831 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3832
3833 This is not as a general purpose byte encoding to Unicode interface:
3834 use the Encode extension for that.
3835
3836 =cut
3837 */
3838
3839 STRLEN
3840 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3841 {
3842     if (sv == &PL_sv_undef)
3843         return 0;
3844     if (!SvPOK(sv)) {
3845         STRLEN len = 0;
3846         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3847             (void) sv_2pv_flags(sv,&len, flags);
3848             if (SvUTF8(sv))
3849                 return len;
3850         } else {
3851             (void) SvPV_force(sv,len);
3852         }
3853     }
3854
3855     if (SvUTF8(sv)) {
3856         return SvCUR(sv);
3857     }
3858
3859     if (SvIsCOW(sv)) {
3860         sv_force_normal_flags(sv, 0);
3861     }
3862
3863     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3864         sv_recode_to_utf8(sv, PL_encoding);
3865     else { /* Assume Latin-1/EBCDIC */
3866         /* This function could be much more efficient if we
3867          * had a FLAG in SVs to signal if there are any hibit
3868          * chars in the PV.  Given that there isn't such a flag
3869          * make the loop as fast as possible. */
3870         U8 *s = (U8 *) SvPVX(sv);
3871         U8 *e = (U8 *) SvEND(sv);
3872         U8 *t = s;
3873         int hibit = 0;
3874         
3875         while (t < e) {
3876             U8 ch = *t++;
3877             if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3878                 break;
3879         }
3880         if (hibit) {
3881             STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3882             s = bytes_to_utf8((U8*)s, &len);
3883
3884             SvPV_free(sv); /* No longer using what was there before. */
3885
3886             SvPV_set(sv, (char*)s);
3887             SvCUR_set(sv, len - 1);
3888             SvLEN_set(sv, len); /* No longer know the real size. */
3889         }
3890         /* Mark as UTF-8 even if no hibit - saves scanning loop */
3891         SvUTF8_on(sv);
3892     }
3893     return SvCUR(sv);
3894 }
3895
3896 /*
3897 =for apidoc sv_utf8_downgrade
3898
3899 Attempts to convert the PV of an SV from characters to bytes.
3900 If the PV contains a character beyond byte, this conversion will fail;
3901 in this case, either returns false or, if C<fail_ok> is not
3902 true, croaks.
3903
3904 This is not as a general purpose Unicode to byte encoding interface:
3905 use the Encode extension for that.
3906
3907 =cut
3908 */
3909
3910 bool
3911 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3912 {
3913     if (SvPOKp(sv) && SvUTF8(sv)) {
3914         if (SvCUR(sv)) {
3915             U8 *s;
3916             STRLEN len;
3917
3918             if (SvIsCOW(sv)) {
3919                 sv_force_normal_flags(sv, 0);
3920             }
3921             s = (U8 *) SvPV(sv, len);
3922             if (!utf8_to_bytes(s, &len)) {
3923                 if (fail_ok)
3924                     return FALSE;
3925                 else {
3926                     if (PL_op)
3927                         Perl_croak(aTHX_ "Wide character in %s",
3928                                    OP_DESC(PL_op));
3929                     else
3930                         Perl_croak(aTHX_ "Wide character");
3931                 }
3932             }
3933             SvCUR_set(sv, len);
3934         }
3935     }
3936     SvUTF8_off(sv);
3937     return TRUE;
3938 }
3939
3940 /*
3941 =for apidoc sv_utf8_encode
3942
3943 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3944 flag off so that it looks like octets again.
3945
3946 =cut
3947 */
3948
3949 void
3950 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3951 {
3952     (void) sv_utf8_upgrade(sv);
3953     if (SvIsCOW(sv)) {
3954         sv_force_normal_flags(sv, 0);
3955     }
3956     if (SvREADONLY(sv)) {
3957         Perl_croak(aTHX_ PL_no_modify);
3958     }
3959     SvUTF8_off(sv);
3960 }
3961
3962 /*
3963 =for apidoc sv_utf8_decode
3964
3965 If the PV of the SV is an octet sequence in UTF-8
3966 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3967 so that it looks like a character. If the PV contains only single-byte
3968 characters, the C<SvUTF8> flag stays being off.
3969 Scans PV for validity and returns false if the PV is invalid UTF-8.
3970
3971 =cut
3972 */
3973
3974 bool
3975 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3976 {
3977     if (SvPOKp(sv)) {
3978         U8 *c;
3979         U8 *e;
3980
3981         /* The octets may have got themselves encoded - get them back as
3982          * bytes
3983          */
3984         if (!sv_utf8_downgrade(sv, TRUE))
3985             return FALSE;
3986
3987         /* it is actually just a matter of turning the utf8 flag on, but
3988          * we want to make sure everything inside is valid utf8 first.
3989          */
3990         c = (U8 *) SvPVX(sv);
3991         if (!is_utf8_string(c, SvCUR(sv)+1))
3992             return FALSE;
3993         e = (U8 *) SvEND(sv);
3994         while (c < e) {
3995             U8 ch = *c++;
3996             if (!UTF8_IS_INVARIANT(ch)) {
3997                 SvUTF8_on(sv);
3998                 break;
3999             }
4000         }
4001     }
4002     return TRUE;
4003 }
4004
4005 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4006  * this function provided for binary compatibility only
4007  */
4008
4009 void
4010 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4011 {
4012     sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4013 }
4014
4015 /*
4016 =for apidoc sv_setsv
4017
4018 Copies the contents of the source SV C<ssv> into the destination SV
4019 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
4020 function if the source SV needs to be reused. Does not handle 'set' magic.
4021 Loosely speaking, it performs a copy-by-value, obliterating any previous
4022 content of the destination.
4023
4024 You probably want to use one of the assortment of wrappers, such as
4025 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4026 C<SvSetMagicSV_nosteal>.
4027
4028 =for apidoc sv_setsv_flags
4029
4030 Copies the contents of the source SV C<ssv> into the destination SV
4031 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
4032 function if the source SV needs to be reused. Does not handle 'set' magic.
4033 Loosely speaking, it performs a copy-by-value, obliterating any previous
4034 content of the destination.
4035 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4036 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4037 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4038 and C<sv_setsv_nomg> are implemented in terms of this function.
4039
4040 You probably want to use one of the assortment of wrappers, such as
4041 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4042 C<SvSetMagicSV_nosteal>.
4043
4044 This is the primary function for copying scalars, and most other
4045 copy-ish functions and macros use this underneath.
4046
4047 =cut
4048 */
4049
4050 void
4051 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4052 {
4053     register U32 sflags;
4054     register int dtype;
4055     register int stype;
4056
4057     if (sstr == dstr)
4058         return;
4059     SV_CHECK_THINKFIRST_COW_DROP(dstr);
4060     if (!sstr)
4061         sstr = &PL_sv_undef;
4062     stype = SvTYPE(sstr);
4063     dtype = SvTYPE(dstr);
4064
4065     SvAMAGIC_off(dstr);
4066     if ( SvVOK(dstr) )
4067     {
4068         /* need to nuke the magic */
4069         mg_free(dstr);
4070         SvRMAGICAL_off(dstr);
4071     }
4072
4073     /* There's a lot of redundancy below but we're going for speed here */
4074
4075     switch (stype) {
4076     case SVt_NULL:
4077       undef_sstr:
4078         if (dtype != SVt_PVGV) {
4079             (void)SvOK_off(dstr);
4080             return;
4081         }
4082         break;
4083     case SVt_IV:
4084         if (SvIOK(sstr)) {
4085             switch (dtype) {
4086             case SVt_NULL:
4087                 sv_upgrade(dstr, SVt_IV);
4088                 break;
4089             case SVt_NV:
4090                 sv_upgrade(dstr, SVt_PVNV);
4091                 break;
4092             case SVt_RV:
4093             case SVt_PV:
4094                 sv_upgrade(dstr, SVt_PVIV);
4095                 break;
4096             }
4097             (void)SvIOK_only(dstr);
4098             SvIV_set(dstr,  SvIVX(sstr));
4099             if (SvIsUV(sstr))
4100                 SvIsUV_on(dstr);
4101             if (SvTAINTED(sstr))
4102                 SvTAINT(dstr);
4103             return;
4104         }
4105         goto undef_sstr;
4106
4107     case SVt_NV:
4108         if (SvNOK(sstr)) {
4109             switch (dtype) {
4110             case SVt_NULL:
4111             case SVt_IV:
4112                 sv_upgrade(dstr, SVt_NV);
4113                 break;
4114             case SVt_RV:
4115             case SVt_PV:
4116             case SVt_PVIV:
4117                 sv_upgrade(dstr, SVt_PVNV);
4118                 break;
4119             }
4120             SvNV_set(dstr, SvNVX(sstr));
4121             (void)SvNOK_only(dstr);
4122             if (SvTAINTED(sstr))
4123                 SvTAINT(dstr);
4124             return;
4125         }
4126         goto undef_sstr;
4127
4128     case SVt_RV:
4129         if (dtype < SVt_RV)
4130             sv_upgrade(dstr, SVt_RV);
4131         else if (dtype == SVt_PVGV &&
4132                  SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4133             sstr = SvRV(sstr);
4134             if (sstr == dstr) {
4135                 if (GvIMPORTED(dstr) != GVf_IMPORTED
4136                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4137                 {
4138                     GvIMPORTED_on(dstr);
4139                 }
4140                 GvMULTI_on(dstr);
4141                 return;
4142             }
4143             goto glob_assign;
4144         }
4145         break;
4146     case SVt_PVFM:
4147 #ifdef PERL_COPY_ON_WRITE
4148         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4149             if (dtype < SVt_PVIV)
4150                 sv_upgrade(dstr, SVt_PVIV);
4151             break;
4152         }
4153         /* Fall through */
4154 #endif
4155     case SVt_PV:
4156         if (dtype < SVt_PV)
4157             sv_upgrade(dstr, SVt_PV);
4158         break;
4159     case SVt_PVIV:
4160         if (dtype < SVt_PVIV)
4161             sv_upgrade(dstr, SVt_PVIV);
4162         break;
4163     case SVt_PVNV:
4164         if (dtype < SVt_PVNV)
4165             sv_upgrade(dstr, SVt_PVNV);
4166         break;
4167     case SVt_PVAV:
4168     case SVt_PVHV:
4169     case SVt_PVCV:
4170     case SVt_PVIO:
4171         {
4172         const char * const type = sv_reftype(sstr,0);
4173         if (PL_op)
4174             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4175         else
4176             Perl_croak(aTHX_ "Bizarre copy of %s", type);
4177         }
4178         break;
4179
4180     case SVt_PVGV:
4181         if (dtype <= SVt_PVGV) {
4182   glob_assign:
4183             if (dtype != SVt_PVGV) {
4184                 const char * const name = GvNAME(sstr);
4185                 const STRLEN len = GvNAMELEN(sstr);
4186                 /* don't upgrade SVt_PVLV: it can hold a glob */
4187                 if (dtype != SVt_PVLV)
4188                     sv_upgrade(dstr, SVt_PVGV);
4189                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4190                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4191                 GvNAME(dstr) = savepvn(name, len);
4192                 GvNAMELEN(dstr) = len;
4193                 SvFAKE_on(dstr);        /* can coerce to non-glob */
4194             }
4195             /* ahem, death to those who redefine active sort subs */
4196             else if (PL_curstackinfo->si_type == PERLSI_SORT
4197                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4198                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4199                       GvNAME(dstr));
4200
4201 #ifdef GV_UNIQUE_CHECK
4202                 if (GvUNIQUE((GV*)dstr)) {
4203                     Perl_croak(aTHX_ PL_no_modify);
4204                 }
4205 #endif
4206
4207             (void)SvOK_off(dstr);
4208             GvINTRO_off(dstr);          /* one-shot flag */
4209             gp_free((GV*)dstr);
4210             GvGP(dstr) = gp_ref(GvGP(sstr));
4211             if (SvTAINTED(sstr))
4212                 SvTAINT(dstr);
4213             if (GvIMPORTED(dstr) != GVf_IMPORTED
4214                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4215             {
4216                 GvIMPORTED_on(dstr);
4217             }
4218             GvMULTI_on(dstr);
4219             return;
4220         }
4221         /* FALL THROUGH */
4222
4223     default:
4224         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4225             mg_get(sstr);
4226             if ((int)SvTYPE(sstr) != stype) {
4227                 stype = SvTYPE(sstr);
4228                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4229                     goto glob_assign;
4230             }
4231         }
4232         if (stype == SVt_PVLV)
4233             (void)SvUPGRADE(dstr, SVt_PVNV);
4234         else
4235             (void)SvUPGRADE(dstr, (U32)stype);
4236     }
4237
4238     sflags = SvFLAGS(sstr);
4239
4240     if (sflags & SVf_ROK) {
4241         if (dtype >= SVt_PV) {
4242             if (dtype == SVt_PVGV) {
4243                 SV *sref = SvREFCNT_inc(SvRV(sstr));
4244                 SV *dref = 0;
4245                 const int intro = GvINTRO(dstr);
4246
4247 #ifdef GV_UNIQUE_CHECK
4248                 if (GvUNIQUE((GV*)dstr)) {
4249                     Perl_croak(aTHX_ PL_no_modify);
4250                 }
4251 #endif
4252
4253                 if (intro) {
4254                     GvINTRO_off(dstr);  /* one-shot flag */
4255                     GvLINE(dstr) = CopLINE(PL_curcop);
4256                     GvEGV(dstr) = (GV*)dstr;
4257                 }
4258                 GvMULTI_on(dstr);
4259                 switch (SvTYPE(sref)) {
4260                 case SVt_PVAV:
4261                     if (intro)
4262                         SAVEGENERICSV(GvAV(dstr));
4263                     else
4264                         dref = (SV*)GvAV(dstr);
4265                     GvAV(dstr) = (AV*)sref;
4266                     if (!GvIMPORTED_AV(dstr)
4267                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4268                     {
4269                         GvIMPORTED_AV_on(dstr);
4270                     }
4271                     break;
4272                 case SVt_PVHV:
4273                     if (intro)
4274                         SAVEGENERICSV(GvHV(dstr));
4275                     else
4276                         dref = (SV*)GvHV(dstr);
4277                     GvHV(dstr) = (HV*)sref;
4278                     if (!GvIMPORTED_HV(dstr)
4279                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4280                     {
4281                         GvIMPORTED_HV_on(dstr);
4282                     }
4283                     break;
4284                 case SVt_PVCV:
4285                     if (intro) {
4286                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4287                             SvREFCNT_dec(GvCV(dstr));
4288                             GvCV(dstr) = Nullcv;
4289                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4290                             PL_sub_generation++;
4291                         }
4292                         SAVEGENERICSV(GvCV(dstr));
4293                     }
4294                     else
4295                         dref = (SV*)GvCV(dstr);
4296                     if (GvCV(dstr) != (CV*)sref) {
4297                         CV* cv = GvCV(dstr);
4298                         if (cv) {
4299                             if (!GvCVGEN((GV*)dstr) &&
4300                                 (CvROOT(cv) || CvXSUB(cv)))
4301                             {
4302                                 /* ahem, death to those who redefine
4303                                  * active sort subs */
4304                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4305                                       PL_sortcop == CvSTART(cv))
4306                                     Perl_croak(aTHX_
4307                                     "Can't redefine active sort subroutine %s",
4308                                           GvENAME((GV*)dstr));
4309                                 /* Redefining a sub - warning is mandatory if
4310                                    it was a const and its value changed. */
4311                                 if (ckWARN(WARN_REDEFINE)
4312                                     || (CvCONST(cv)
4313                                         && (!CvCONST((CV*)sref)
4314                                             || sv_cmp(cv_const_sv(cv),
4315                                                       cv_const_sv((CV*)sref)))))
4316                                 {
4317                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4318                                         CvCONST(cv)
4319                                         ? "Constant subroutine %s::%s redefined"
4320                                         : "Subroutine %s::%s redefined",
4321                                         HvNAME_get(GvSTASH((GV*)dstr)),
4322                                         GvENAME((GV*)dstr));
4323                                 }
4324                             }
4325                             if (!intro)
4326                                 cv_ckproto(cv, (GV*)dstr,
4327                                         SvPOK(sref) ? SvPVX(sref) : Nullch);
4328                         }
4329                         GvCV(dstr) = (CV*)sref;
4330                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4331                         GvASSUMECV_on(dstr);
4332                         PL_sub_generation++;
4333                     }
4334                     if (!GvIMPORTED_CV(dstr)
4335                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4336                     {
4337                         GvIMPORTED_CV_on(dstr);
4338                     }
4339                     break;
4340                 case SVt_PVIO:
4341                     if (intro)
4342                         SAVEGENERICSV(GvIOp(dstr));
4343                     else
4344                         dref = (SV*)GvIOp(dstr);
4345                     GvIOp(dstr) = (IO*)sref;
4346                     break;
4347                 case SVt_PVFM:
4348                     if (intro)
4349                         SAVEGENERICSV(GvFORM(dstr));
4350                     else
4351                         dref = (SV*)GvFORM(dstr);
4352                     GvFORM(dstr) = (CV*)sref;
4353                     break;
4354                 default:
4355                     if (intro)
4356                         SAVEGENERICSV(GvSV(dstr));
4357                     else
4358                         dref = (SV*)GvSV(dstr);
4359                     GvSV(dstr) = sref;
4360                     if (!GvIMPORTED_SV(dstr)
4361                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4362                     {
4363                         GvIMPORTED_SV_on(dstr);
4364                     }
4365                     break;
4366                 }
4367                 if (dref)
4368                     SvREFCNT_dec(dref);
4369                 if (SvTAINTED(sstr))
4370                     SvTAINT(dstr);
4371                 return;
4372             }
4373             if (SvPVX(dstr)) {
4374                 SvPV_free(dstr);
4375                 SvLEN_set(dstr, 0);
4376                 SvCUR_set(dstr, 0);
4377             }
4378         }
4379         (void)SvOK_off(dstr);
4380         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4381         SvROK_on(dstr);
4382         if (sflags & SVp_NOK) {
4383             SvNOKp_on(dstr);
4384             /* Only set the public OK flag if the source has public OK.  */
4385             if (sflags & SVf_NOK)
4386                 SvFLAGS(dstr) |= SVf_NOK;
4387             SvNV_set(dstr, SvNVX(sstr));
4388         }
4389         if (sflags & SVp_IOK) {
4390             (void)SvIOKp_on(dstr);
4391             if (sflags & SVf_IOK)
4392                 SvFLAGS(dstr) |= SVf_IOK;
4393             if (sflags & SVf_IVisUV)
4394                 SvIsUV_on(dstr);
4395             SvIV_set(dstr, SvIVX(sstr));
4396         }
4397         if (SvAMAGIC(sstr)) {
4398             SvAMAGIC_on(dstr);
4399         }
4400     }
4401     else if (sflags & SVp_POK) {
4402         bool isSwipe = 0;
4403
4404         /*
4405          * Check to see if we can just swipe the string.  If so, it's a
4406          * possible small lose on short strings, but a big win on long ones.
4407          * It might even be a win on short strings if SvPVX(dstr)
4408          * has to be allocated and SvPVX(sstr) has to be freed.
4409          */
4410
4411         /* Whichever path we take through the next code, we want this true,
4412            and doing it now facilitates the COW check.  */
4413         (void)SvPOK_only(dstr);
4414
4415         if (
4416 #ifdef PERL_COPY_ON_WRITE
4417             (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4418             &&
4419 #endif
4420             !(isSwipe =
4421                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4422                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4423                  (!(flags & SV_NOSTEAL)) &&
4424                                         /* and we're allowed to steal temps */
4425                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4426                  SvLEN(sstr)    &&        /* and really is a string */
4427                                 /* and won't be needed again, potentially */
4428               !(PL_op && PL_op->op_type == OP_AASSIGN))
4429 #ifdef PERL_COPY_ON_WRITE
4430             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4431                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4432                  && SvTYPE(sstr) >= SVt_PVIV)
4433 #endif
4434             ) {
4435             /* Failed the swipe test, and it's not a shared hash key either.
4436                Have to copy the string.  */
4437             STRLEN len = SvCUR(sstr);
4438             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4439             Move(SvPVX(sstr),SvPVX(dstr),len,char);
4440             SvCUR_set(dstr, len);
4441             *SvEND(dstr) = '\0';
4442         } else {
4443             /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4444                be true in here.  */
4445 #ifdef PERL_COPY_ON_WRITE
4446             /* Either it's a shared hash key, or it's suitable for
4447                copy-on-write or we can swipe the string.  */
4448             if (DEBUG_C_TEST) {
4449                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4450                 sv_dump(sstr);
4451                 sv_dump(dstr);
4452             }
4453             if (!isSwipe) {
4454                 /* I believe I should acquire a global SV mutex if
4455                    it's a COW sv (not a shared hash key) to stop
4456                    it going un copy-on-write.
4457                    If the source SV has gone un copy on write between up there
4458                    and down here, then (assert() that) it is of the correct
4459                    form to make it copy on write again */
4460                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4461                     != (SVf_FAKE | SVf_READONLY)) {
4462                     SvREADONLY_on(sstr);
4463                     SvFAKE_on(sstr);
4464                     /* Make the source SV into a loop of 1.
4465                        (about to become 2) */
4466                     SV_COW_NEXT_SV_SET(sstr, sstr);
4467                 }
4468             }
4469 #endif
4470             /* Initial code is common.  */
4471             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
4472                 if (SvOOK(dstr)) {
4473                     SvFLAGS(dstr) &= ~SVf_OOK;
4474                     Safefree(SvPVX(dstr) - SvIVX(dstr));
4475                 }
4476                 else if (SvLEN(dstr))
4477                     Safefree(SvPVX(dstr));
4478             }
4479
4480 #ifdef PERL_COPY_ON_WRITE
4481             if (!isSwipe) {
4482                 /* making another shared SV.  */
4483                 STRLEN cur = SvCUR(sstr);
4484                 STRLEN len = SvLEN(sstr);
4485                 assert (SvTYPE(dstr) >= SVt_PVIV);
4486                 if (len) {
4487                     /* SvIsCOW_normal */
4488                     /* splice us in between source and next-after-source.  */
4489                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4490                     SV_COW_NEXT_SV_SET(sstr, dstr);
4491                     SvPV_set(dstr, SvPVX(sstr));
4492                 } else {
4493                     /* SvIsCOW_shared_hash */
4494                     UV hash = SvUVX(sstr);
4495                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4496                                           "Copy on write: Sharing hash\n"));
4497                     SvPV_set(dstr,
4498                              sharepvn(SvPVX(sstr),
4499                                       (sflags & SVf_UTF8?-cur:cur), hash));
4500                     SvUV_set(dstr, hash);
4501                 }
4502                 SvLEN_set(dstr, len);
4503                 SvCUR_set(dstr, cur);
4504                 SvREADONLY_on(dstr);
4505                 SvFAKE_on(dstr);
4506                 /* Relesase a global SV mutex.  */
4507             }
4508             else
4509 #endif
4510                 {       /* Passes the swipe test.  */
4511                 SvPV_set(dstr, SvPVX(sstr));
4512                 SvLEN_set(dstr, SvLEN(sstr));
4513                 SvCUR_set(dstr, SvCUR(sstr));
4514
4515                 SvTEMP_off(dstr);
4516                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4517                 SvPV_set(sstr, Nullch);
4518                 SvLEN_set(sstr, 0);
4519                 SvCUR_set(sstr, 0);
4520                 SvTEMP_off(sstr);
4521             }
4522         }
4523         if (sflags & SVf_UTF8)
4524             SvUTF8_on(dstr);
4525         /*SUPPRESS 560*/
4526         if (sflags & SVp_NOK) {
4527             SvNOKp_on(dstr);
4528             if (sflags & SVf_NOK)
4529                 SvFLAGS(dstr) |= SVf_NOK;
4530             SvNV_set(dstr, SvNVX(sstr));
4531         }
4532         if (sflags & SVp_IOK) {
4533             (void)SvIOKp_on(dstr);
4534             if (sflags & SVf_IOK)
4535                 SvFLAGS(dstr) |= SVf_IOK;
4536             if (sflags & SVf_IVisUV)
4537                 SvIsUV_on(dstr);
4538             SvIV_set(dstr, SvIVX(sstr));
4539         }
4540         if (SvVOK(sstr)) {
4541             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4542             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4543                         smg->mg_ptr, smg->mg_len);
4544             SvRMAGICAL_on(dstr);
4545         }
4546     }
4547     else if (sflags & SVp_IOK) {
4548         if (sflags & SVf_IOK)
4549             (void)SvIOK_only(dstr);
4550         else {
4551             (void)SvOK_off(dstr);
4552             (void)SvIOKp_on(dstr);
4553         }
4554         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4555         if (sflags & SVf_IVisUV)
4556             SvIsUV_on(dstr);
4557         SvIV_set(dstr, SvIVX(sstr));
4558         if (sflags & SVp_NOK) {
4559             if (sflags & SVf_NOK)
4560                 (void)SvNOK_on(dstr);
4561             else
4562                 (void)SvNOKp_on(dstr);
4563             SvNV_set(dstr, SvNVX(sstr));
4564         }
4565     }
4566     else if (sflags & SVp_NOK) {
4567         if (sflags & SVf_NOK)
4568             (void)SvNOK_only(dstr);
4569         else {
4570             (void)SvOK_off(dstr);
4571             SvNOKp_on(dstr);
4572         }
4573         SvNV_set(dstr, SvNVX(sstr));
4574     }
4575     else {
4576         if (dtype == SVt_PVGV) {
4577             if (ckWARN(WARN_MISC))
4578                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4579         }
4580         else
4581             (void)SvOK_off(dstr);
4582     }
4583     if (SvTAINTED(sstr))
4584         SvTAINT(dstr);
4585 }
4586
4587 /*
4588 =for apidoc sv_setsv_mg
4589
4590 Like C<sv_setsv>, but also handles 'set' magic.
4591
4592 =cut
4593 */
4594
4595 void
4596 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4597 {
4598     sv_setsv(dstr,sstr);
4599     SvSETMAGIC(dstr);
4600 }
4601
4602 #ifdef PERL_COPY_ON_WRITE
4603 SV *
4604 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4605 {
4606     STRLEN cur = SvCUR(sstr);
4607     STRLEN len = SvLEN(sstr);
4608     register char *new_pv;
4609
4610     if (DEBUG_C_TEST) {
4611         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4612                       sstr, dstr);
4613         sv_dump(sstr);
4614         if (dstr)
4615                     sv_dump(dstr);
4616     }
4617
4618     if (dstr) {
4619         if (SvTHINKFIRST(dstr))
4620             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4621         else if (SvPVX(dstr))
4622             Safefree(SvPVX(dstr));
4623     }
4624     else
4625         new_SV(dstr);
4626     (void)SvUPGRADE (dstr, SVt_PVIV);
4627
4628     assert (SvPOK(sstr));
4629     assert (SvPOKp(sstr));
4630     assert (!SvIOK(sstr));
4631     assert (!SvIOKp(sstr));
4632     assert (!SvNOK(sstr));
4633     assert (!SvNOKp(sstr));
4634
4635     if (SvIsCOW(sstr)) {
4636
4637         if (SvLEN(sstr) == 0) {
4638             /* source is a COW shared hash key.  */
4639             UV hash = SvUVX(sstr);
4640             DEBUG_C(PerlIO_printf(Perl_debug_log,
4641                                   "Fast copy on write: Sharing hash\n"));
4642             SvUV_set(dstr, hash);
4643             new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4644             goto common_exit;
4645         }
4646         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4647     } else {
4648         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4649         (void)SvUPGRADE (sstr, SVt_PVIV);
4650         SvREADONLY_on(sstr);
4651         SvFAKE_on(sstr);
4652         DEBUG_C(PerlIO_printf(Perl_debug_log,
4653                               "Fast copy on write: Converting sstr to COW\n"));
4654         SV_COW_NEXT_SV_SET(dstr, sstr);
4655     }
4656     SV_COW_NEXT_SV_SET(sstr, dstr);
4657     new_pv = SvPVX(sstr);
4658
4659   common_exit:
4660     SvPV_set(dstr, new_pv);
4661     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4662     if (SvUTF8(sstr))
4663         SvUTF8_on(dstr);
4664     SvLEN_set(dstr, len);
4665     SvCUR_set(dstr, cur);
4666     if (DEBUG_C_TEST) {
4667         sv_dump(dstr);
4668     }
4669     return dstr;
4670 }
4671 #endif
4672
4673 /*
4674 =for apidoc sv_setpvn
4675
4676 Copies a string into an SV.  The C<len> parameter indicates the number of
4677 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4678 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4679
4680 =cut
4681 */
4682
4683 void
4684 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4685 {
4686     register char *dptr;
4687
4688     SV_CHECK_THINKFIRST_COW_DROP(sv);
4689     if (!ptr) {
4690         (void)SvOK_off(sv);
4691         return;
4692     }
4693     else {
4694         /* len is STRLEN which is unsigned, need to copy to signed */
4695         const IV iv = len;
4696         if (iv < 0)
4697             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4698     }
4699     (void)SvUPGRADE(sv, SVt_PV);
4700
4701     SvGROW(sv, len + 1);
4702     dptr = SvPVX(sv);
4703     Move(ptr,dptr,len,char);
4704     dptr[len] = '\0';
4705     SvCUR_set(sv, len);
4706     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4707     SvTAINT(sv);
4708 }
4709
4710 /*
4711 =for apidoc sv_setpvn_mg
4712
4713 Like C<sv_setpvn>, but also handles 'set' magic.
4714
4715 =cut
4716 */
4717
4718 void
4719 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4720 {
4721     sv_setpvn(sv,ptr,len);
4722     SvSETMAGIC(sv);
4723 }
4724
4725 /*
4726 =for apidoc sv_setpv
4727
4728 Copies a string into an SV.  The string must be null-terminated.  Does not
4729 handle 'set' magic.  See C<sv_setpv_mg>.
4730
4731 =cut
4732 */
4733
4734 void
4735 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4736 {
4737     register STRLEN len;
4738
4739     SV_CHECK_THINKFIRST_COW_DROP(sv);
4740     if (!ptr) {
4741  &nb