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