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