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