Fix for "UTF-8 bug with s///" from Hugo.
[p5sagit/p5-mst-13.2.git] / sv.c
1 /*    sv.c
2  *
3  *    Copyright (c) 1991-2002, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  * "I wonder what the Entish is for 'yes' and 'no'," he thought.
9  *
10  *
11  * This file contains the code that creates, manipulates and destroys
12  * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
13  * structure of an SV, so their creation and destruction is handled
14  * here; higher-level functions are in av.c, hv.c, and so on. Opcode
15  * level functions (eg. substr, split, join) for each of the types are
16  * in the pp*.c files.
17  */
18
19 #include "EXTERN.h"
20 #define PERL_IN_SV_C
21 #include "perl.h"
22 #include "regcomp.h"
23
24 #define FCALL *f
25 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) sv_force_normal(sv)
26
27
28 /* ============================================================================
29
30 =head1 Allocation and deallocation of SVs.
31
32 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
33 av, hv...) contains type and reference count information, as well as a
34 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
35 specific to each type.
36
37 Normally, this allocation is done using arenas, which are approximately
38 1K chunks of memory parcelled up into N heads or bodies. The first slot
39 in each arena is reserved, and is used to hold a link to the next arena.
40 In the case of heads, the unused first slot also contains some flags and
41 a note of the number of slots.  Snaked through each arena chain is a
42 linked list of free items; when this becomes empty, an extra arena is
43 allocated and divided up into N items which are threaded into the free
44 list.
45
46 The following global variables are associated with arenas:
47
48     PL_sv_arenaroot     pointer to list of SV arenas
49     PL_sv_root          pointer to list of free SV structures
50
51     PL_foo_arenaroot    pointer to list of foo arenas,
52     PL_foo_root         pointer to list of free foo bodies
53                             ... for foo in xiv, xnv, xrv, xpv etc.
54
55 Note that some of the larger and more rarely used body types (eg xpvio)
56 are not allocated using arenas, but are instead just malloc()/free()ed as
57 required. Also, if PURIFY is defined, arenas are abandoned altogether,
58 with all items individually malloc()ed. In addition, a few SV heads are
59 not allocated from an arena, but are instead directly created as static
60 or auto variables, eg PL_sv_undef.
61
62 The SV arena serves the secondary purpose of allowing still-live SVs
63 to be located and destroyed during final cleanup.
64
65 At the lowest level, the macros new_SV() and del_SV() grab and free
66 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
67 to return the SV to the free list with error checking.) new_SV() calls
68 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
69 SVs in the free list have their SvTYPE field set to all ones.
70
71 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
72 that allocate and return individual body types. Normally these are mapped
73 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
74 instead mapped directly to malloc()/free() if PURIFY is defined. The
75 new/del functions remove from, or add to, the appropriate PL_foo_root
76 list, and call more_xiv() etc to add a new arena if the list is empty.
77
78 At the time of very final cleanup, sv_free_arenas() is called from
79 perl_destruct() to physically free all the arenas allocated since the
80 start of the interpreter.  Note that this also clears PL_he_arenaroot,
81 which is otherwise dealt with in hv.c.
82
83 Manipulation of any of the PL_*root pointers is protected by enclosing
84 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
85 if threads are enabled.
86
87 The function visit() scans the SV arenas list, and calls a specified
88 function for each SV it finds which is still live - ie which has an SvTYPE
89 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
90 following functions (specified as [function that calls visit()] / [function
91 called by visit() for each SV]):
92
93     sv_report_used() / do_report_used()
94                         dump all remaining SVs (debugging aid)
95
96     sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
97                         Attempt to free all objects pointed to by RVs,
98                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
99                         try to do the same for all objects indirectly
100                         referenced by typeglobs too.  Called once from
101                         perl_destruct(), prior to calling sv_clean_all()
102                         below.
103
104     sv_clean_all() / do_clean_all()
105                         SvREFCNT_dec(sv) each remaining SV, possibly
106                         triggering an sv_free(). It also sets the
107                         SVf_BREAK flag on the SV to indicate that the
108                         refcnt has been artificially lowered, and thus
109                         stopping sv_free() from giving spurious warnings
110                         about SVs which unexpectedly have a refcnt
111                         of zero.  called repeatedly from perl_destruct()
112                         until there are no SVs left.
113
114 =head2 Summary
115
116 Private API to rest of sv.c
117
118     new_SV(),  del_SV(),
119
120     new_XIV(), del_XIV(),
121     new_XNV(), del_XNV(),
122     etc
123
124 Public API:
125
126     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
127
128
129 =cut
130
131 ============================================================================ */
132
133
134
135 /*
136  * "A time to plant, and a time to uproot what was planted..."
137  */
138
139 #define plant_SV(p) \
140     STMT_START {                                        \
141         SvANY(p) = (void *)PL_sv_root;                  \
142         SvFLAGS(p) = SVTYPEMASK;                        \
143         PL_sv_root = (p);                               \
144         --PL_sv_count;                                  \
145     } STMT_END
146
147 /* sv_mutex must be held while calling uproot_SV() */
148 #define uproot_SV(p) \
149     STMT_START {                                        \
150         (p) = PL_sv_root;                               \
151         PL_sv_root = (SV*)SvANY(p);                     \
152         ++PL_sv_count;                                  \
153     } STMT_END
154
155
156 /* new_SV(): return a new, empty SV head */
157
158 #define new_SV(p) \
159     STMT_START {                                        \
160         LOCK_SV_MUTEX;                                  \
161         if (PL_sv_root)                                 \
162             uproot_SV(p);                               \
163         else                                            \
164             (p) = more_sv();                            \
165         UNLOCK_SV_MUTEX;                                \
166         SvANY(p) = 0;                                   \
167         SvREFCNT(p) = 1;                                \
168         SvFLAGS(p) = 0;                                 \
169     } STMT_END
170
171
172 /* del_SV(): return an empty SV head to the free list */
173
174 #ifdef DEBUGGING
175
176 #define del_SV(p) \
177     STMT_START {                                        \
178         LOCK_SV_MUTEX;                                  \
179         if (DEBUG_D_TEST)                               \
180             del_sv(p);                                  \
181         else                                            \
182             plant_SV(p);                                \
183         UNLOCK_SV_MUTEX;                                \
184     } STMT_END
185
186 STATIC void
187 S_del_sv(pTHX_ SV *p)
188 {
189     if (DEBUG_D_TEST) {
190         SV* sva;
191         SV* sv;
192         SV* svend;
193         int ok = 0;
194         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
195             sv = sva + 1;
196             svend = &sva[SvREFCNT(sva)];
197             if (p >= sv && p < svend)
198                 ok = 1;
199         }
200         if (!ok) {
201             if (ckWARN_d(WARN_INTERNAL))        
202                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
203                             "Attempt to free non-arena SV: 0x%"UVxf,
204                             PTR2UV(p));
205             return;
206         }
207     }
208     plant_SV(p);
209 }
210
211 #else /* ! DEBUGGING */
212
213 #define del_SV(p)   plant_SV(p)
214
215 #endif /* DEBUGGING */
216
217
218 /*
219 =head1 SV Manipulation Functions
220
221 =for apidoc sv_add_arena
222
223 Given a chunk of memory, link it to the head of the list of arenas,
224 and split it into a list of free SVs.
225
226 =cut
227 */
228
229 void
230 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
231 {
232     SV* sva = (SV*)ptr;
233     register SV* sv;
234     register SV* svend;
235     Zero(ptr, size, char);
236
237     /* The first SV in an arena isn't an SV. */
238     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
239     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
240     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
241
242     PL_sv_arenaroot = sva;
243     PL_sv_root = sva + 1;
244
245     svend = &sva[SvREFCNT(sva) - 1];
246     sv = sva + 1;
247     while (sv < svend) {
248         SvANY(sv) = (void *)(SV*)(sv + 1);
249         SvFLAGS(sv) = SVTYPEMASK;
250         sv++;
251     }
252     SvANY(sv) = 0;
253     SvFLAGS(sv) = SVTYPEMASK;
254 }
255
256 /* make some more SVs by adding another arena */
257
258 /* sv_mutex must be held while calling more_sv() */
259 STATIC SV*
260 S_more_sv(pTHX)
261 {
262     register SV* sv;
263
264     if (PL_nice_chunk) {
265         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
266         PL_nice_chunk = Nullch;
267         PL_nice_chunk_size = 0;
268     }
269     else {
270         char *chunk;                /* must use New here to match call to */
271         New(704,chunk,1008,char);   /* Safefree() in sv_free_arenas()     */
272         sv_add_arena(chunk, 1008, 0);
273     }
274     uproot_SV(sv);
275     return sv;
276 }
277
278 /* visit(): call the named function for each non-free SV in the arenas. */
279
280 STATIC I32
281 S_visit(pTHX_ SVFUNC_t f)
282 {
283     SV* sva;
284     SV* sv;
285     register SV* svend;
286     I32 visited = 0;
287
288     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
289         svend = &sva[SvREFCNT(sva)];
290         for (sv = sva + 1; sv < svend; ++sv) {
291             if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
292                 (FCALL)(aTHX_ sv);
293                 ++visited;
294             }
295         }
296     }
297     return visited;
298 }
299
300 #ifdef DEBUGGING
301
302 /* called by sv_report_used() for each live SV */
303
304 static void
305 do_report_used(pTHX_ SV *sv)
306 {
307     if (SvTYPE(sv) != SVTYPEMASK) {
308         PerlIO_printf(Perl_debug_log, "****\n");
309         sv_dump(sv);
310     }
311 }
312 #endif
313
314 /*
315 =for apidoc sv_report_used
316
317 Dump the contents of all SVs not yet freed. (Debugging aid).
318
319 =cut
320 */
321
322 void
323 Perl_sv_report_used(pTHX)
324 {
325 #ifdef DEBUGGING
326     visit(do_report_used);
327 #endif
328 }
329
330 /* called by sv_clean_objs() for each live SV */
331
332 static void
333 do_clean_objs(pTHX_ SV *sv)
334 {
335     SV* rv;
336
337     if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
338         DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
339         if (SvWEAKREF(sv)) {
340             sv_del_backref(sv);
341             SvWEAKREF_off(sv);
342             SvRV(sv) = 0;
343         } else {
344             SvROK_off(sv);
345             SvRV(sv) = 0;
346             SvREFCNT_dec(rv);
347         }
348     }
349
350     /* XXX Might want to check arrays, etc. */
351 }
352
353 /* called by sv_clean_objs() for each live SV */
354
355 #ifndef DISABLE_DESTRUCTOR_KLUDGE
356 static void
357 do_clean_named_objs(pTHX_ SV *sv)
358 {
359     if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
360         if ( SvOBJECT(GvSV(sv)) ||
361              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
362              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
363              (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
364              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
365         {
366             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
367             SvREFCNT_dec(sv);
368         }
369     }
370 }
371 #endif
372
373 /*
374 =for apidoc sv_clean_objs
375
376 Attempt to destroy all objects not yet freed
377
378 =cut
379 */
380
381 void
382 Perl_sv_clean_objs(pTHX)
383 {
384     PL_in_clean_objs = TRUE;
385     visit(do_clean_objs);
386 #ifndef DISABLE_DESTRUCTOR_KLUDGE
387     /* some barnacles may yet remain, clinging to typeglobs */
388     visit(do_clean_named_objs);
389 #endif
390     PL_in_clean_objs = FALSE;
391 }
392
393 /* called by sv_clean_all() for each live SV */
394
395 static void
396 do_clean_all(pTHX_ SV *sv)
397 {
398     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
399     SvFLAGS(sv) |= SVf_BREAK;
400     SvREFCNT_dec(sv);
401 }
402
403 /*
404 =for apidoc sv_clean_all
405
406 Decrement the refcnt of each remaining SV, possibly triggering a
407 cleanup. This function may have to be called multiple times to free
408 SVs which are in complex self-referential hierarchies.
409
410 =cut
411 */
412
413 I32
414 Perl_sv_clean_all(pTHX)
415 {
416     I32 cleaned;
417     PL_in_clean_all = TRUE;
418     cleaned = visit(do_clean_all);
419     PL_in_clean_all = FALSE;
420     return cleaned;
421 }
422
423 /*
424 =for apidoc sv_free_arenas
425
426 Deallocate the memory used by all arenas. Note that all the individual SV
427 heads and bodies within the arenas must already have been freed.
428
429 =cut
430 */
431
432 void
433 Perl_sv_free_arenas(pTHX)
434 {
435     SV* sva;
436     SV* svanext;
437     XPV *arena, *arenanext;
438
439     /* Free arenas here, but be careful about fake ones.  (We assume
440        contiguity of the fake ones with the corresponding real ones.) */
441
442     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
443         svanext = (SV*) SvANY(sva);
444         while (svanext && SvFAKE(svanext))
445             svanext = (SV*) SvANY(svanext);
446
447         if (!SvFAKE(sva))
448             Safefree((void *)sva);
449     }
450
451     for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
452         arenanext = (XPV*)arena->xpv_pv;
453         Safefree(arena);
454     }
455     PL_xiv_arenaroot = 0;
456
457     for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
458         arenanext = (XPV*)arena->xpv_pv;
459         Safefree(arena);
460     }
461     PL_xnv_arenaroot = 0;
462
463     for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
464         arenanext = (XPV*)arena->xpv_pv;
465         Safefree(arena);
466     }
467     PL_xrv_arenaroot = 0;
468
469     for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
470         arenanext = (XPV*)arena->xpv_pv;
471         Safefree(arena);
472     }
473     PL_xpv_arenaroot = 0;
474
475     for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
476         arenanext = (XPV*)arena->xpv_pv;
477         Safefree(arena);
478     }
479     PL_xpviv_arenaroot = 0;
480
481     for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
482         arenanext = (XPV*)arena->xpv_pv;
483         Safefree(arena);
484     }
485     PL_xpvnv_arenaroot = 0;
486
487     for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
488         arenanext = (XPV*)arena->xpv_pv;
489         Safefree(arena);
490     }
491     PL_xpvcv_arenaroot = 0;
492
493     for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
494         arenanext = (XPV*)arena->xpv_pv;
495         Safefree(arena);
496     }
497     PL_xpvav_arenaroot = 0;
498
499     for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
500         arenanext = (XPV*)arena->xpv_pv;
501         Safefree(arena);
502     }
503     PL_xpvhv_arenaroot = 0;
504
505     for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
506         arenanext = (XPV*)arena->xpv_pv;
507         Safefree(arena);
508     }
509     PL_xpvmg_arenaroot = 0;
510
511     for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
512         arenanext = (XPV*)arena->xpv_pv;
513         Safefree(arena);
514     }
515     PL_xpvlv_arenaroot = 0;
516
517     for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
518         arenanext = (XPV*)arena->xpv_pv;
519         Safefree(arena);
520     }
521     PL_xpvbm_arenaroot = 0;
522
523     for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
524         arenanext = (XPV*)arena->xpv_pv;
525         Safefree(arena);
526     }
527     PL_he_arenaroot = 0;
528
529     if (PL_nice_chunk)
530         Safefree(PL_nice_chunk);
531     PL_nice_chunk = Nullch;
532     PL_nice_chunk_size = 0;
533     PL_sv_arenaroot = 0;
534     PL_sv_root = 0;
535 }
536
537 /*
538 =for apidoc report_uninit
539
540 Print appropriate "Use of uninitialized variable" warning
541
542 =cut
543 */
544
545 void
546 Perl_report_uninit(pTHX)
547 {
548     if (PL_op)
549         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
550                     " in ", OP_DESC(PL_op));
551     else
552         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
553 }
554
555 /* grab a new IV body from the free list, allocating more if necessary */
556
557 STATIC XPVIV*
558 S_new_xiv(pTHX)
559 {
560     IV* xiv;
561     LOCK_SV_MUTEX;
562     if (!PL_xiv_root)
563         more_xiv();
564     xiv = PL_xiv_root;
565     /*
566      * See comment in more_xiv() -- RAM.
567      */
568     PL_xiv_root = *(IV**)xiv;
569     UNLOCK_SV_MUTEX;
570     return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
571 }
572
573 /* return an IV body to the free list */
574
575 STATIC void
576 S_del_xiv(pTHX_ XPVIV *p)
577 {
578     IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
579     LOCK_SV_MUTEX;
580     *(IV**)xiv = PL_xiv_root;
581     PL_xiv_root = xiv;
582     UNLOCK_SV_MUTEX;
583 }
584
585 /* allocate another arena's worth of IV bodies */
586
587 STATIC void
588 S_more_xiv(pTHX)
589 {
590     register IV* xiv;
591     register IV* xivend;
592     XPV* ptr;
593     New(705, ptr, 1008/sizeof(XPV), XPV);
594     ptr->xpv_pv = (char*)PL_xiv_arenaroot;      /* linked list of xiv arenas */
595     PL_xiv_arenaroot = ptr;                     /* to keep Purify happy */
596
597     xiv = (IV*) ptr;
598     xivend = &xiv[1008 / sizeof(IV) - 1];
599     xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1;  /* fudge by size of XPV */
600     PL_xiv_root = xiv;
601     while (xiv < xivend) {
602         *(IV**)xiv = (IV *)(xiv + 1);
603         xiv++;
604     }
605     *(IV**)xiv = 0;
606 }
607
608 /* grab a new NV body from the free list, allocating more if necessary */
609
610 STATIC XPVNV*
611 S_new_xnv(pTHX)
612 {
613     NV* xnv;
614     LOCK_SV_MUTEX;
615     if (!PL_xnv_root)
616         more_xnv();
617     xnv = PL_xnv_root;
618     PL_xnv_root = *(NV**)xnv;
619     UNLOCK_SV_MUTEX;
620     return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
621 }
622
623 /* return an NV body to the free list */
624
625 STATIC void
626 S_del_xnv(pTHX_ XPVNV *p)
627 {
628     NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
629     LOCK_SV_MUTEX;
630     *(NV**)xnv = PL_xnv_root;
631     PL_xnv_root = xnv;
632     UNLOCK_SV_MUTEX;
633 }
634
635 /* allocate another arena's worth of NV bodies */
636
637 STATIC void
638 S_more_xnv(pTHX)
639 {
640     register NV* xnv;
641     register NV* xnvend;
642     XPV *ptr;
643     New(711, ptr, 1008/sizeof(XPV), XPV);
644     ptr->xpv_pv = (char*)PL_xnv_arenaroot;
645     PL_xnv_arenaroot = ptr;
646
647     xnv = (NV*) ptr;
648     xnvend = &xnv[1008 / sizeof(NV) - 1];
649     xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
650     PL_xnv_root = xnv;
651     while (xnv < xnvend) {
652         *(NV**)xnv = (NV*)(xnv + 1);
653         xnv++;
654     }
655     *(NV**)xnv = 0;
656 }
657
658 /* grab a new struct xrv from the free list, allocating more if necessary */
659
660 STATIC XRV*
661 S_new_xrv(pTHX)
662 {
663     XRV* xrv;
664     LOCK_SV_MUTEX;
665     if (!PL_xrv_root)
666         more_xrv();
667     xrv = PL_xrv_root;
668     PL_xrv_root = (XRV*)xrv->xrv_rv;
669     UNLOCK_SV_MUTEX;
670     return xrv;
671 }
672
673 /* return a struct xrv to the free list */
674
675 STATIC void
676 S_del_xrv(pTHX_ XRV *p)
677 {
678     LOCK_SV_MUTEX;
679     p->xrv_rv = (SV*)PL_xrv_root;
680     PL_xrv_root = p;
681     UNLOCK_SV_MUTEX;
682 }
683
684 /* allocate another arena's worth of struct xrv */
685
686 STATIC void
687 S_more_xrv(pTHX)
688 {
689     register XRV* xrv;
690     register XRV* xrvend;
691     XPV *ptr;
692     New(712, ptr, 1008/sizeof(XPV), XPV);
693     ptr->xpv_pv = (char*)PL_xrv_arenaroot;
694     PL_xrv_arenaroot = ptr;
695
696     xrv = (XRV*) ptr;
697     xrvend = &xrv[1008 / sizeof(XRV) - 1];
698     xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
699     PL_xrv_root = xrv;
700     while (xrv < xrvend) {
701         xrv->xrv_rv = (SV*)(xrv + 1);
702         xrv++;
703     }
704     xrv->xrv_rv = 0;
705 }
706
707 /* grab a new struct xpv from the free list, allocating more if necessary */
708
709 STATIC XPV*
710 S_new_xpv(pTHX)
711 {
712     XPV* xpv;
713     LOCK_SV_MUTEX;
714     if (!PL_xpv_root)
715         more_xpv();
716     xpv = PL_xpv_root;
717     PL_xpv_root = (XPV*)xpv->xpv_pv;
718     UNLOCK_SV_MUTEX;
719     return xpv;
720 }
721
722 /* return a struct xpv to the free list */
723
724 STATIC void
725 S_del_xpv(pTHX_ XPV *p)
726 {
727     LOCK_SV_MUTEX;
728     p->xpv_pv = (char*)PL_xpv_root;
729     PL_xpv_root = p;
730     UNLOCK_SV_MUTEX;
731 }
732
733 /* allocate another arena's worth of struct xpv */
734
735 STATIC void
736 S_more_xpv(pTHX)
737 {
738     register XPV* xpv;
739     register XPV* xpvend;
740     New(713, xpv, 1008/sizeof(XPV), XPV);
741     xpv->xpv_pv = (char*)PL_xpv_arenaroot;
742     PL_xpv_arenaroot = xpv;
743
744     xpvend = &xpv[1008 / sizeof(XPV) - 1];
745     PL_xpv_root = ++xpv;
746     while (xpv < xpvend) {
747         xpv->xpv_pv = (char*)(xpv + 1);
748         xpv++;
749     }
750     xpv->xpv_pv = 0;
751 }
752
753 /* grab a new struct xpviv from the free list, allocating more if necessary */
754
755 STATIC XPVIV*
756 S_new_xpviv(pTHX)
757 {
758     XPVIV* xpviv;
759     LOCK_SV_MUTEX;
760     if (!PL_xpviv_root)
761         more_xpviv();
762     xpviv = PL_xpviv_root;
763     PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
764     UNLOCK_SV_MUTEX;
765     return xpviv;
766 }
767
768 /* return a struct xpviv to the free list */
769
770 STATIC void
771 S_del_xpviv(pTHX_ XPVIV *p)
772 {
773     LOCK_SV_MUTEX;
774     p->xpv_pv = (char*)PL_xpviv_root;
775     PL_xpviv_root = p;
776     UNLOCK_SV_MUTEX;
777 }
778
779 /* allocate another arena's worth of struct xpviv */
780
781 STATIC void
782 S_more_xpviv(pTHX)
783 {
784     register XPVIV* xpviv;
785     register XPVIV* xpvivend;
786     New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
787     xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
788     PL_xpviv_arenaroot = xpviv;
789
790     xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
791     PL_xpviv_root = ++xpviv;
792     while (xpviv < xpvivend) {
793         xpviv->xpv_pv = (char*)(xpviv + 1);
794         xpviv++;
795     }
796     xpviv->xpv_pv = 0;
797 }
798
799 /* grab a new struct xpvnv from the free list, allocating more if necessary */
800
801 STATIC XPVNV*
802 S_new_xpvnv(pTHX)
803 {
804     XPVNV* xpvnv;
805     LOCK_SV_MUTEX;
806     if (!PL_xpvnv_root)
807         more_xpvnv();
808     xpvnv = PL_xpvnv_root;
809     PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
810     UNLOCK_SV_MUTEX;
811     return xpvnv;
812 }
813
814 /* return a struct xpvnv to the free list */
815
816 STATIC void
817 S_del_xpvnv(pTHX_ XPVNV *p)
818 {
819     LOCK_SV_MUTEX;
820     p->xpv_pv = (char*)PL_xpvnv_root;
821     PL_xpvnv_root = p;
822     UNLOCK_SV_MUTEX;
823 }
824
825 /* allocate another arena's worth of struct xpvnv */
826
827 STATIC void
828 S_more_xpvnv(pTHX)
829 {
830     register XPVNV* xpvnv;
831     register XPVNV* xpvnvend;
832     New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
833     xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
834     PL_xpvnv_arenaroot = xpvnv;
835
836     xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
837     PL_xpvnv_root = ++xpvnv;
838     while (xpvnv < xpvnvend) {
839         xpvnv->xpv_pv = (char*)(xpvnv + 1);
840         xpvnv++;
841     }
842     xpvnv->xpv_pv = 0;
843 }
844
845 /* grab a new struct xpvcv from the free list, allocating more if necessary */
846
847 STATIC XPVCV*
848 S_new_xpvcv(pTHX)
849 {
850     XPVCV* xpvcv;
851     LOCK_SV_MUTEX;
852     if (!PL_xpvcv_root)
853         more_xpvcv();
854     xpvcv = PL_xpvcv_root;
855     PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
856     UNLOCK_SV_MUTEX;
857     return xpvcv;
858 }
859
860 /* return a struct xpvcv to the free list */
861
862 STATIC void
863 S_del_xpvcv(pTHX_ XPVCV *p)
864 {
865     LOCK_SV_MUTEX;
866     p->xpv_pv = (char*)PL_xpvcv_root;
867     PL_xpvcv_root = p;
868     UNLOCK_SV_MUTEX;
869 }
870
871 /* allocate another arena's worth of struct xpvcv */
872
873 STATIC void
874 S_more_xpvcv(pTHX)
875 {
876     register XPVCV* xpvcv;
877     register XPVCV* xpvcvend;
878     New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
879     xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
880     PL_xpvcv_arenaroot = xpvcv;
881
882     xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
883     PL_xpvcv_root = ++xpvcv;
884     while (xpvcv < xpvcvend) {
885         xpvcv->xpv_pv = (char*)(xpvcv + 1);
886         xpvcv++;
887     }
888     xpvcv->xpv_pv = 0;
889 }
890
891 /* grab a new struct xpvav from the free list, allocating more if necessary */
892
893 STATIC XPVAV*
894 S_new_xpvav(pTHX)
895 {
896     XPVAV* xpvav;
897     LOCK_SV_MUTEX;
898     if (!PL_xpvav_root)
899         more_xpvav();
900     xpvav = PL_xpvav_root;
901     PL_xpvav_root = (XPVAV*)xpvav->xav_array;
902     UNLOCK_SV_MUTEX;
903     return xpvav;
904 }
905
906 /* return a struct xpvav to the free list */
907
908 STATIC void
909 S_del_xpvav(pTHX_ XPVAV *p)
910 {
911     LOCK_SV_MUTEX;
912     p->xav_array = (char*)PL_xpvav_root;
913     PL_xpvav_root = p;
914     UNLOCK_SV_MUTEX;
915 }
916
917 /* allocate another arena's worth of struct xpvav */
918
919 STATIC void
920 S_more_xpvav(pTHX)
921 {
922     register XPVAV* xpvav;
923     register XPVAV* xpvavend;
924     New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
925     xpvav->xav_array = (char*)PL_xpvav_arenaroot;
926     PL_xpvav_arenaroot = xpvav;
927
928     xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
929     PL_xpvav_root = ++xpvav;
930     while (xpvav < xpvavend) {
931         xpvav->xav_array = (char*)(xpvav + 1);
932         xpvav++;
933     }
934     xpvav->xav_array = 0;
935 }
936
937 /* grab a new struct xpvhv from the free list, allocating more if necessary */
938
939 STATIC XPVHV*
940 S_new_xpvhv(pTHX)
941 {
942     XPVHV* xpvhv;
943     LOCK_SV_MUTEX;
944     if (!PL_xpvhv_root)
945         more_xpvhv();
946     xpvhv = PL_xpvhv_root;
947     PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
948     UNLOCK_SV_MUTEX;
949     return xpvhv;
950 }
951
952 /* return a struct xpvhv to the free list */
953
954 STATIC void
955 S_del_xpvhv(pTHX_ XPVHV *p)
956 {
957     LOCK_SV_MUTEX;
958     p->xhv_array = (char*)PL_xpvhv_root;
959     PL_xpvhv_root = p;
960     UNLOCK_SV_MUTEX;
961 }
962
963 /* allocate another arena's worth of struct xpvhv */
964
965 STATIC void
966 S_more_xpvhv(pTHX)
967 {
968     register XPVHV* xpvhv;
969     register XPVHV* xpvhvend;
970     New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
971     xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
972     PL_xpvhv_arenaroot = xpvhv;
973
974     xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
975     PL_xpvhv_root = ++xpvhv;
976     while (xpvhv < xpvhvend) {
977         xpvhv->xhv_array = (char*)(xpvhv + 1);
978         xpvhv++;
979     }
980     xpvhv->xhv_array = 0;
981 }
982
983 /* grab a new struct xpvmg from the free list, allocating more if necessary */
984
985 STATIC XPVMG*
986 S_new_xpvmg(pTHX)
987 {
988     XPVMG* xpvmg;
989     LOCK_SV_MUTEX;
990     if (!PL_xpvmg_root)
991         more_xpvmg();
992     xpvmg = PL_xpvmg_root;
993     PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
994     UNLOCK_SV_MUTEX;
995     return xpvmg;
996 }
997
998 /* return a struct xpvmg to the free list */
999
1000 STATIC void
1001 S_del_xpvmg(pTHX_ XPVMG *p)
1002 {
1003     LOCK_SV_MUTEX;
1004     p->xpv_pv = (char*)PL_xpvmg_root;
1005     PL_xpvmg_root = p;
1006     UNLOCK_SV_MUTEX;
1007 }
1008
1009 /* allocate another arena's worth of struct xpvmg */
1010
1011 STATIC void
1012 S_more_xpvmg(pTHX)
1013 {
1014     register XPVMG* xpvmg;
1015     register XPVMG* xpvmgend;
1016     New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1017     xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1018     PL_xpvmg_arenaroot = xpvmg;
1019
1020     xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1021     PL_xpvmg_root = ++xpvmg;
1022     while (xpvmg < xpvmgend) {
1023         xpvmg->xpv_pv = (char*)(xpvmg + 1);
1024         xpvmg++;
1025     }
1026     xpvmg->xpv_pv = 0;
1027 }
1028
1029 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1030
1031 STATIC XPVLV*
1032 S_new_xpvlv(pTHX)
1033 {
1034     XPVLV* xpvlv;
1035     LOCK_SV_MUTEX;
1036     if (!PL_xpvlv_root)
1037         more_xpvlv();
1038     xpvlv = PL_xpvlv_root;
1039     PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1040     UNLOCK_SV_MUTEX;
1041     return xpvlv;
1042 }
1043
1044 /* return a struct xpvlv to the free list */
1045
1046 STATIC void
1047 S_del_xpvlv(pTHX_ XPVLV *p)
1048 {
1049     LOCK_SV_MUTEX;
1050     p->xpv_pv = (char*)PL_xpvlv_root;
1051     PL_xpvlv_root = p;
1052     UNLOCK_SV_MUTEX;
1053 }
1054
1055 /* allocate another arena's worth of struct xpvlv */
1056
1057 STATIC void
1058 S_more_xpvlv(pTHX)
1059 {
1060     register XPVLV* xpvlv;
1061     register XPVLV* xpvlvend;
1062     New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1063     xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1064     PL_xpvlv_arenaroot = xpvlv;
1065
1066     xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1067     PL_xpvlv_root = ++xpvlv;
1068     while (xpvlv < xpvlvend) {
1069         xpvlv->xpv_pv = (char*)(xpvlv + 1);
1070         xpvlv++;
1071     }
1072     xpvlv->xpv_pv = 0;
1073 }
1074
1075 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1076
1077 STATIC XPVBM*
1078 S_new_xpvbm(pTHX)
1079 {
1080     XPVBM* xpvbm;
1081     LOCK_SV_MUTEX;
1082     if (!PL_xpvbm_root)
1083         more_xpvbm();
1084     xpvbm = PL_xpvbm_root;
1085     PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1086     UNLOCK_SV_MUTEX;
1087     return xpvbm;
1088 }
1089
1090 /* return a struct xpvbm to the free list */
1091
1092 STATIC void
1093 S_del_xpvbm(pTHX_ XPVBM *p)
1094 {
1095     LOCK_SV_MUTEX;
1096     p->xpv_pv = (char*)PL_xpvbm_root;
1097     PL_xpvbm_root = p;
1098     UNLOCK_SV_MUTEX;
1099 }
1100
1101 /* allocate another arena's worth of struct xpvbm */
1102
1103 STATIC void
1104 S_more_xpvbm(pTHX)
1105 {
1106     register XPVBM* xpvbm;
1107     register XPVBM* xpvbmend;
1108     New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1109     xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1110     PL_xpvbm_arenaroot = xpvbm;
1111
1112     xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1113     PL_xpvbm_root = ++xpvbm;
1114     while (xpvbm < xpvbmend) {
1115         xpvbm->xpv_pv = (char*)(xpvbm + 1);
1116         xpvbm++;
1117     }
1118     xpvbm->xpv_pv = 0;
1119 }
1120
1121 #ifdef LEAKTEST
1122 #  define my_safemalloc(s)      (void*)safexmalloc(717,s)
1123 #  define my_safefree(p)        safexfree((char*)p)
1124 #else
1125 #  define my_safemalloc(s)      (void*)safemalloc(s)
1126 #  define my_safefree(p)        safefree((char*)p)
1127 #endif
1128
1129 #ifdef PURIFY
1130
1131 #define new_XIV()       my_safemalloc(sizeof(XPVIV))
1132 #define del_XIV(p)      my_safefree(p)
1133
1134 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
1135 #define del_XNV(p)      my_safefree(p)
1136
1137 #define new_XRV()       my_safemalloc(sizeof(XRV))
1138 #define del_XRV(p)      my_safefree(p)
1139
1140 #define new_XPV()       my_safemalloc(sizeof(XPV))
1141 #define del_XPV(p)      my_safefree(p)
1142
1143 #define new_XPVIV()     my_safemalloc(sizeof(XPVIV))
1144 #define del_XPVIV(p)    my_safefree(p)
1145
1146 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
1147 #define del_XPVNV(p)    my_safefree(p)
1148
1149 #define new_XPVCV()     my_safemalloc(sizeof(XPVCV))
1150 #define del_XPVCV(p)    my_safefree(p)
1151
1152 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
1153 #define del_XPVAV(p)    my_safefree(p)
1154
1155 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
1156 #define del_XPVHV(p)    my_safefree(p)
1157
1158 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
1159 #define del_XPVMG(p)    my_safefree(p)
1160
1161 #define new_XPVLV()     my_safemalloc(sizeof(XPVLV))
1162 #define del_XPVLV(p)    my_safefree(p)
1163
1164 #define new_XPVBM()     my_safemalloc(sizeof(XPVBM))
1165 #define del_XPVBM(p)    my_safefree(p)
1166
1167 #else /* !PURIFY */
1168
1169 #define new_XIV()       (void*)new_xiv()
1170 #define del_XIV(p)      del_xiv((XPVIV*) p)
1171
1172 #define new_XNV()       (void*)new_xnv()
1173 #define del_XNV(p)      del_xnv((XPVNV*) p)
1174
1175 #define new_XRV()       (void*)new_xrv()
1176 #define del_XRV(p)      del_xrv((XRV*) p)
1177
1178 #define new_XPV()       (void*)new_xpv()
1179 #define del_XPV(p)      del_xpv((XPV *)p)
1180
1181 #define new_XPVIV()     (void*)new_xpviv()
1182 #define del_XPVIV(p)    del_xpviv((XPVIV *)p)
1183
1184 #define new_XPVNV()     (void*)new_xpvnv()
1185 #define del_XPVNV(p)    del_xpvnv((XPVNV *)p)
1186
1187 #define new_XPVCV()     (void*)new_xpvcv()
1188 #define del_XPVCV(p)    del_xpvcv((XPVCV *)p)
1189
1190 #define new_XPVAV()     (void*)new_xpvav()
1191 #define del_XPVAV(p)    del_xpvav((XPVAV *)p)
1192
1193 #define new_XPVHV()     (void*)new_xpvhv()
1194 #define del_XPVHV(p)    del_xpvhv((XPVHV *)p)
1195
1196 #define new_XPVMG()     (void*)new_xpvmg()
1197 #define del_XPVMG(p)    del_xpvmg((XPVMG *)p)
1198
1199 #define new_XPVLV()     (void*)new_xpvlv()
1200 #define del_XPVLV(p)    del_xpvlv((XPVLV *)p)
1201
1202 #define new_XPVBM()     (void*)new_xpvbm()
1203 #define del_XPVBM(p)    del_xpvbm((XPVBM *)p)
1204
1205 #endif /* PURIFY */
1206
1207 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
1208 #define del_XPVGV(p)    my_safefree(p)
1209
1210 #define new_XPVFM()     my_safemalloc(sizeof(XPVFM))
1211 #define del_XPVFM(p)    my_safefree(p)
1212
1213 #define new_XPVIO()     my_safemalloc(sizeof(XPVIO))
1214 #define del_XPVIO(p)    my_safefree(p)
1215
1216 /*
1217 =for apidoc sv_upgrade
1218
1219 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1220 SV, then copies across as much information as possible from the old body.
1221 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1222
1223 =cut
1224 */
1225
1226 bool
1227 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1228 {
1229     char*       pv = NULL;
1230     U32         cur = 0;
1231     U32         len = 0;
1232     IV          iv = 0;
1233     NV          nv = 0.0;
1234     MAGIC*      magic = NULL;
1235     HV*         stash = Nullhv;
1236
1237     if (mt != SVt_PV && SvREADONLY(sv) && SvFAKE(sv)) {
1238         sv_force_normal(sv);
1239     }
1240
1241     if (SvTYPE(sv) == mt)
1242         return TRUE;
1243
1244     if (mt < SVt_PVIV)
1245         (void)SvOOK_off(sv);
1246
1247     switch (SvTYPE(sv)) {
1248     case SVt_NULL:
1249         pv      = 0;
1250         cur     = 0;
1251         len     = 0;
1252         iv      = 0;
1253         nv      = 0.0;
1254         magic   = 0;
1255         stash   = 0;
1256         break;
1257     case SVt_IV:
1258         pv      = 0;
1259         cur     = 0;
1260         len     = 0;
1261         iv      = SvIVX(sv);
1262         nv      = (NV)SvIVX(sv);
1263         del_XIV(SvANY(sv));
1264         magic   = 0;
1265         stash   = 0;
1266         if (mt == SVt_NV)
1267             mt = SVt_PVNV;
1268         else if (mt < SVt_PVIV)
1269             mt = SVt_PVIV;
1270         break;
1271     case SVt_NV:
1272         pv      = 0;
1273         cur     = 0;
1274         len     = 0;
1275         nv      = SvNVX(sv);
1276         iv      = I_V(nv);
1277         magic   = 0;
1278         stash   = 0;
1279         del_XNV(SvANY(sv));
1280         SvANY(sv) = 0;
1281         if (mt < SVt_PVNV)
1282             mt = SVt_PVNV;
1283         break;
1284     case SVt_RV:
1285         pv      = (char*)SvRV(sv);
1286         cur     = 0;
1287         len     = 0;
1288         iv      = PTR2IV(pv);
1289         nv      = PTR2NV(pv);
1290         del_XRV(SvANY(sv));
1291         magic   = 0;
1292         stash   = 0;
1293         break;
1294     case SVt_PV:
1295         pv      = SvPVX(sv);
1296         cur     = SvCUR(sv);
1297         len     = SvLEN(sv);
1298         iv      = 0;
1299         nv      = 0.0;
1300         magic   = 0;
1301         stash   = 0;
1302         del_XPV(SvANY(sv));
1303         if (mt <= SVt_IV)
1304             mt = SVt_PVIV;
1305         else if (mt == SVt_NV)
1306             mt = SVt_PVNV;
1307         break;
1308     case SVt_PVIV:
1309         pv      = SvPVX(sv);
1310         cur     = SvCUR(sv);
1311         len     = SvLEN(sv);
1312         iv      = SvIVX(sv);
1313         nv      = 0.0;
1314         magic   = 0;
1315         stash   = 0;
1316         del_XPVIV(SvANY(sv));
1317         break;
1318     case SVt_PVNV:
1319         pv      = SvPVX(sv);
1320         cur     = SvCUR(sv);
1321         len     = SvLEN(sv);
1322         iv      = SvIVX(sv);
1323         nv      = SvNVX(sv);
1324         magic   = 0;
1325         stash   = 0;
1326         del_XPVNV(SvANY(sv));
1327         break;
1328     case SVt_PVMG:
1329         pv      = SvPVX(sv);
1330         cur     = SvCUR(sv);
1331         len     = SvLEN(sv);
1332         iv      = SvIVX(sv);
1333         nv      = SvNVX(sv);
1334         magic   = SvMAGIC(sv);
1335         stash   = SvSTASH(sv);
1336         del_XPVMG(SvANY(sv));
1337         break;
1338     default:
1339         Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1340     }
1341
1342     switch (mt) {
1343     case SVt_NULL:
1344         Perl_croak(aTHX_ "Can't upgrade to undef");
1345     case SVt_IV:
1346         SvANY(sv) = new_XIV();
1347         SvIVX(sv)       = iv;
1348         break;
1349     case SVt_NV:
1350         SvANY(sv) = new_XNV();
1351         SvNVX(sv)       = nv;
1352         break;
1353     case SVt_RV:
1354         SvANY(sv) = new_XRV();
1355         SvRV(sv) = (SV*)pv;
1356         break;
1357     case SVt_PV:
1358         SvANY(sv) = new_XPV();
1359         SvPVX(sv)       = pv;
1360         SvCUR(sv)       = cur;
1361         SvLEN(sv)       = len;
1362         break;
1363     case SVt_PVIV:
1364         SvANY(sv) = new_XPVIV();
1365         SvPVX(sv)       = pv;
1366         SvCUR(sv)       = cur;
1367         SvLEN(sv)       = len;
1368         SvIVX(sv)       = iv;
1369         if (SvNIOK(sv))
1370             (void)SvIOK_on(sv);
1371         SvNOK_off(sv);
1372         break;
1373     case SVt_PVNV:
1374         SvANY(sv) = new_XPVNV();
1375         SvPVX(sv)       = pv;
1376         SvCUR(sv)       = cur;
1377         SvLEN(sv)       = len;
1378         SvIVX(sv)       = iv;
1379         SvNVX(sv)       = nv;
1380         break;
1381     case SVt_PVMG:
1382         SvANY(sv) = new_XPVMG();
1383         SvPVX(sv)       = pv;
1384         SvCUR(sv)       = cur;
1385         SvLEN(sv)       = len;
1386         SvIVX(sv)       = iv;
1387         SvNVX(sv)       = nv;
1388         SvMAGIC(sv)     = magic;
1389         SvSTASH(sv)     = stash;
1390         break;
1391     case SVt_PVLV:
1392         SvANY(sv) = new_XPVLV();
1393         SvPVX(sv)       = pv;
1394         SvCUR(sv)       = cur;
1395         SvLEN(sv)       = len;
1396         SvIVX(sv)       = iv;
1397         SvNVX(sv)       = nv;
1398         SvMAGIC(sv)     = magic;
1399         SvSTASH(sv)     = stash;
1400         LvTARGOFF(sv)   = 0;
1401         LvTARGLEN(sv)   = 0;
1402         LvTARG(sv)      = 0;
1403         LvTYPE(sv)      = 0;
1404         break;
1405     case SVt_PVAV:
1406         SvANY(sv) = new_XPVAV();
1407         if (pv)
1408             Safefree(pv);
1409         SvPVX(sv)       = 0;
1410         AvMAX(sv)       = -1;
1411         AvFILLp(sv)     = -1;
1412         SvIVX(sv)       = 0;
1413         SvNVX(sv)       = 0.0;
1414         SvMAGIC(sv)     = magic;
1415         SvSTASH(sv)     = stash;
1416         AvALLOC(sv)     = 0;
1417         AvARYLEN(sv)    = 0;
1418         AvFLAGS(sv)     = 0;
1419         break;
1420     case SVt_PVHV:
1421         SvANY(sv) = new_XPVHV();
1422         if (pv)
1423             Safefree(pv);
1424         SvPVX(sv)       = 0;
1425         HvFILL(sv)      = 0;
1426         HvMAX(sv)       = 0;
1427         HvTOTALKEYS(sv) = 0;
1428         HvPLACEHOLDERS(sv) = 0;
1429         SvMAGIC(sv)     = magic;
1430         SvSTASH(sv)     = stash;
1431         HvRITER(sv)     = 0;
1432         HvEITER(sv)     = 0;
1433         HvPMROOT(sv)    = 0;
1434         HvNAME(sv)      = 0;
1435         break;
1436     case SVt_PVCV:
1437         SvANY(sv) = new_XPVCV();
1438         Zero(SvANY(sv), 1, XPVCV);
1439         SvPVX(sv)       = pv;
1440         SvCUR(sv)       = cur;
1441         SvLEN(sv)       = len;
1442         SvIVX(sv)       = iv;
1443         SvNVX(sv)       = nv;
1444         SvMAGIC(sv)     = magic;
1445         SvSTASH(sv)     = stash;
1446         break;
1447     case SVt_PVGV:
1448         SvANY(sv) = new_XPVGV();
1449         SvPVX(sv)       = pv;
1450         SvCUR(sv)       = cur;
1451         SvLEN(sv)       = len;
1452         SvIVX(sv)       = iv;
1453         SvNVX(sv)       = nv;
1454         SvMAGIC(sv)     = magic;
1455         SvSTASH(sv)     = stash;
1456         GvGP(sv)        = 0;
1457         GvNAME(sv)      = 0;
1458         GvNAMELEN(sv)   = 0;
1459         GvSTASH(sv)     = 0;
1460         GvFLAGS(sv)     = 0;
1461         break;
1462     case SVt_PVBM:
1463         SvANY(sv) = new_XPVBM();
1464         SvPVX(sv)       = pv;
1465         SvCUR(sv)       = cur;
1466         SvLEN(sv)       = len;
1467         SvIVX(sv)       = iv;
1468         SvNVX(sv)       = nv;
1469         SvMAGIC(sv)     = magic;
1470         SvSTASH(sv)     = stash;
1471         BmRARE(sv)      = 0;
1472         BmUSEFUL(sv)    = 0;
1473         BmPREVIOUS(sv)  = 0;
1474         break;
1475     case SVt_PVFM:
1476         SvANY(sv) = new_XPVFM();
1477         Zero(SvANY(sv), 1, XPVFM);
1478         SvPVX(sv)       = pv;
1479         SvCUR(sv)       = cur;
1480         SvLEN(sv)       = len;
1481         SvIVX(sv)       = iv;
1482         SvNVX(sv)       = nv;
1483         SvMAGIC(sv)     = magic;
1484         SvSTASH(sv)     = stash;
1485         break;
1486     case SVt_PVIO:
1487         SvANY(sv) = new_XPVIO();
1488         Zero(SvANY(sv), 1, XPVIO);
1489         SvPVX(sv)       = pv;
1490         SvCUR(sv)       = cur;
1491         SvLEN(sv)       = len;
1492         SvIVX(sv)       = iv;
1493         SvNVX(sv)       = nv;
1494         SvMAGIC(sv)     = magic;
1495         SvSTASH(sv)     = stash;
1496         IoPAGE_LEN(sv)  = 60;
1497         break;
1498     }
1499     SvFLAGS(sv) &= ~SVTYPEMASK;
1500     SvFLAGS(sv) |= mt;
1501     return TRUE;
1502 }
1503
1504 /*
1505 =for apidoc sv_backoff
1506
1507 Remove any string offset. You should normally use the C<SvOOK_off> macro
1508 wrapper instead.
1509
1510 =cut
1511 */
1512
1513 int
1514 Perl_sv_backoff(pTHX_ register SV *sv)
1515 {
1516     assert(SvOOK(sv));
1517     if (SvIVX(sv)) {
1518         char *s = SvPVX(sv);
1519         SvLEN(sv) += SvIVX(sv);
1520         SvPVX(sv) -= SvIVX(sv);
1521         SvIV_set(sv, 0);
1522         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1523     }
1524     SvFLAGS(sv) &= ~SVf_OOK;
1525     return 0;
1526 }
1527
1528 /*
1529 =for apidoc sv_grow
1530
1531 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1532 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1533 Use the C<SvGROW> wrapper instead.
1534
1535 =cut
1536 */
1537
1538 char *
1539 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1540 {
1541     register char *s;
1542
1543
1544
1545 #ifdef HAS_64K_LIMIT
1546     if (newlen >= 0x10000) {
1547         PerlIO_printf(Perl_debug_log,
1548                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1549         my_exit(1);
1550     }
1551 #endif /* HAS_64K_LIMIT */
1552     if (SvROK(sv))
1553         sv_unref(sv);
1554     if (SvTYPE(sv) < SVt_PV) {
1555         sv_upgrade(sv, SVt_PV);
1556         s = SvPVX(sv);
1557     }
1558     else if (SvOOK(sv)) {       /* pv is offset? */
1559         sv_backoff(sv);
1560         s = SvPVX(sv);
1561         if (newlen > SvLEN(sv))
1562             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1563 #ifdef HAS_64K_LIMIT
1564         if (newlen >= 0x10000)
1565             newlen = 0xFFFF;
1566 #endif
1567     }
1568     else
1569         s = SvPVX(sv);
1570
1571     if (newlen > SvLEN(sv)) {           /* need more room? */
1572         if (SvLEN(sv) && s) {
1573 #if defined(MYMALLOC) && !defined(LEAKTEST)
1574             STRLEN l = malloced_size((void*)SvPVX(sv));
1575             if (newlen <= l) {
1576                 SvLEN_set(sv, l);
1577                 return s;
1578             } else
1579 #endif
1580             Renew(s,newlen,char);
1581         }
1582         else {
1583             /* sv_force_normal_flags() must not try to unshare the new
1584                PVX we allocate below. AMS 20010713 */
1585             if (SvREADONLY(sv) && SvFAKE(sv)) {
1586                 SvFAKE_off(sv);
1587                 SvREADONLY_off(sv);
1588             }
1589             New(703, s, newlen, char);
1590             if (SvPVX(sv) && SvCUR(sv)) {
1591                 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1592             }
1593         }
1594         SvPV_set(sv, s);
1595         SvLEN_set(sv, newlen);
1596     }
1597     return s;
1598 }
1599
1600 /*
1601 =for apidoc sv_setiv
1602
1603 Copies an integer into the given SV, upgrading first if necessary.
1604 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1605
1606 =cut
1607 */
1608
1609 void
1610 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1611 {
1612     SV_CHECK_THINKFIRST(sv);
1613     switch (SvTYPE(sv)) {
1614     case SVt_NULL:
1615         sv_upgrade(sv, SVt_IV);
1616         break;
1617     case SVt_NV:
1618         sv_upgrade(sv, SVt_PVNV);
1619         break;
1620     case SVt_RV:
1621     case SVt_PV:
1622         sv_upgrade(sv, SVt_PVIV);
1623         break;
1624
1625     case SVt_PVGV:
1626     case SVt_PVAV:
1627     case SVt_PVHV:
1628     case SVt_PVCV:
1629     case SVt_PVFM:
1630     case SVt_PVIO:
1631         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1632                    OP_DESC(PL_op));
1633     }
1634     (void)SvIOK_only(sv);                       /* validate number */
1635     SvIVX(sv) = i;
1636     SvTAINT(sv);
1637 }
1638
1639 /*
1640 =for apidoc sv_setiv_mg
1641
1642 Like C<sv_setiv>, but also handles 'set' magic.
1643
1644 =cut
1645 */
1646
1647 void
1648 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1649 {
1650     sv_setiv(sv,i);
1651     SvSETMAGIC(sv);
1652 }
1653
1654 /*
1655 =for apidoc sv_setuv
1656
1657 Copies an unsigned integer into the given SV, upgrading first if necessary.
1658 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1659
1660 =cut
1661 */
1662
1663 void
1664 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1665 {
1666     /* With these two if statements:
1667        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1668
1669        without
1670        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1671
1672        If you wish to remove them, please benchmark to see what the effect is
1673     */
1674     if (u <= (UV)IV_MAX) {
1675        sv_setiv(sv, (IV)u);
1676        return;
1677     }
1678     sv_setiv(sv, 0);
1679     SvIsUV_on(sv);
1680     SvUVX(sv) = u;
1681 }
1682
1683 /*
1684 =for apidoc sv_setuv_mg
1685
1686 Like C<sv_setuv>, but also handles 'set' magic.
1687
1688 =cut
1689 */
1690
1691 void
1692 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1693 {
1694     /* With these two if statements:
1695        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1696
1697        without
1698        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1699
1700        If you wish to remove them, please benchmark to see what the effect is
1701     */
1702     if (u <= (UV)IV_MAX) {
1703        sv_setiv(sv, (IV)u);
1704     } else {
1705        sv_setiv(sv, 0);
1706        SvIsUV_on(sv);
1707        sv_setuv(sv,u);
1708     }
1709     SvSETMAGIC(sv);
1710 }
1711
1712 /*
1713 =for apidoc sv_setnv
1714
1715 Copies a double into the given SV, upgrading first if necessary.
1716 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1717
1718 =cut
1719 */
1720
1721 void
1722 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1723 {
1724     SV_CHECK_THINKFIRST(sv);
1725     switch (SvTYPE(sv)) {
1726     case SVt_NULL:
1727     case SVt_IV:
1728         sv_upgrade(sv, SVt_NV);
1729         break;
1730     case SVt_RV:
1731     case SVt_PV:
1732     case SVt_PVIV:
1733         sv_upgrade(sv, SVt_PVNV);
1734         break;
1735
1736     case SVt_PVGV:
1737     case SVt_PVAV:
1738     case SVt_PVHV:
1739     case SVt_PVCV:
1740     case SVt_PVFM:
1741     case SVt_PVIO:
1742         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1743                    OP_NAME(PL_op));
1744     }
1745     SvNVX(sv) = num;
1746     (void)SvNOK_only(sv);                       /* validate number */
1747     SvTAINT(sv);
1748 }
1749
1750 /*
1751 =for apidoc sv_setnv_mg
1752
1753 Like C<sv_setnv>, but also handles 'set' magic.
1754
1755 =cut
1756 */
1757
1758 void
1759 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1760 {
1761     sv_setnv(sv,num);
1762     SvSETMAGIC(sv);
1763 }
1764
1765 /* Print an "isn't numeric" warning, using a cleaned-up,
1766  * printable version of the offending string
1767  */
1768
1769 STATIC void
1770 S_not_a_number(pTHX_ SV *sv)
1771 {
1772      SV *dsv;
1773      char tmpbuf[64];
1774      char *pv;
1775
1776      if (DO_UTF8(sv)) {
1777           dsv = sv_2mortal(newSVpv("", 0));
1778           pv = sv_uni_display(dsv, sv, 10, 0);
1779      } else {
1780           char *d = tmpbuf;
1781           char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1782           /* each *s can expand to 4 chars + "...\0",
1783              i.e. need room for 8 chars */
1784         
1785           char *s, *end;
1786           for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1787                int ch = *s & 0xFF;
1788                if (ch & 128 && !isPRINT_LC(ch)) {
1789                     *d++ = 'M';
1790                     *d++ = '-';
1791                     ch &= 127;
1792                }
1793                if (ch == '\n') {
1794                     *d++ = '\\';
1795                     *d++ = 'n';
1796                }
1797                else if (ch == '\r') {
1798                     *d++ = '\\';
1799                     *d++ = 'r';
1800                }
1801                else if (ch == '\f') {
1802                     *d++ = '\\';
1803                     *d++ = 'f';
1804                }
1805                else if (ch == '\\') {
1806                     *d++ = '\\';
1807                     *d++ = '\\';
1808                }
1809                else if (ch == '\0') {
1810                     *d++ = '\\';
1811                     *d++ = '0';
1812                }
1813                else if (isPRINT_LC(ch))
1814                     *d++ = ch;
1815                else {
1816                     *d++ = '^';
1817                     *d++ = toCTRL(ch);
1818                }
1819           }
1820           if (s < end) {
1821                *d++ = '.';
1822                *d++ = '.';
1823                *d++ = '.';
1824           }
1825           *d = '\0';
1826           pv = tmpbuf;
1827     }
1828
1829     if (PL_op)
1830         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1831                     "Argument \"%s\" isn't numeric in %s", pv,
1832                     OP_DESC(PL_op));
1833     else
1834         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1835                     "Argument \"%s\" isn't numeric", pv);
1836 }
1837
1838 /*
1839 =for apidoc looks_like_number
1840
1841 Test if the content of an SV looks like a number (or is a number).
1842 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1843 non-numeric warning), even if your atof() doesn't grok them.
1844
1845 =cut
1846 */
1847
1848 I32
1849 Perl_looks_like_number(pTHX_ SV *sv)
1850 {
1851     register char *sbegin;
1852     STRLEN len;
1853
1854     if (SvPOK(sv)) {
1855         sbegin = SvPVX(sv);
1856         len = SvCUR(sv);
1857     }
1858     else if (SvPOKp(sv))
1859         sbegin = SvPV(sv, len);
1860     else
1861         return 1; /* Historic.  Wrong?  */
1862     return grok_number(sbegin, len, NULL);
1863 }
1864
1865 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1866    until proven guilty, assume that things are not that bad... */
1867
1868 /*
1869    NV_PRESERVES_UV:
1870
1871    As 64 bit platforms often have an NV that doesn't preserve all bits of
1872    an IV (an assumption perl has been based on to date) it becomes necessary
1873    to remove the assumption that the NV always carries enough precision to
1874    recreate the IV whenever needed, and that the NV is the canonical form.
1875    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1876    precision as a side effect of conversion (which would lead to insanity
1877    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1878    1) to distinguish between IV/UV/NV slots that have cached a valid
1879       conversion where precision was lost and IV/UV/NV slots that have a
1880       valid conversion which has lost no precision
1881    2) to ensure that if a numeric conversion to one form is requested that
1882       would lose precision, the precise conversion (or differently
1883       imprecise conversion) is also performed and cached, to prevent
1884       requests for different numeric formats on the same SV causing
1885       lossy conversion chains. (lossless conversion chains are perfectly
1886       acceptable (still))
1887
1888
1889    flags are used:
1890    SvIOKp is true if the IV slot contains a valid value
1891    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1892    SvNOKp is true if the NV slot contains a valid value
1893    SvNOK  is true only if the NV value is accurate
1894
1895    so
1896    while converting from PV to NV, check to see if converting that NV to an
1897    IV(or UV) would lose accuracy over a direct conversion from PV to
1898    IV(or UV). If it would, cache both conversions, return NV, but mark
1899    SV as IOK NOKp (ie not NOK).
1900
1901    While converting from PV to IV, check to see if converting that IV to an
1902    NV would lose accuracy over a direct conversion from PV to NV. If it
1903    would, cache both conversions, flag similarly.
1904
1905    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1906    correctly because if IV & NV were set NV *always* overruled.
1907    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1908    changes - now IV and NV together means that the two are interchangeable:
1909    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1910
1911    The benefit of this is that operations such as pp_add know that if
1912    SvIOK is true for both left and right operands, then integer addition
1913    can be used instead of floating point (for cases where the result won't
1914    overflow). Before, floating point was always used, which could lead to
1915    loss of precision compared with integer addition.
1916
1917    * making IV and NV equal status should make maths accurate on 64 bit
1918      platforms
1919    * may speed up maths somewhat if pp_add and friends start to use
1920      integers when possible instead of fp. (Hopefully the overhead in
1921      looking for SvIOK and checking for overflow will not outweigh the
1922      fp to integer speedup)
1923    * will slow down integer operations (callers of SvIV) on "inaccurate"
1924      values, as the change from SvIOK to SvIOKp will cause a call into
1925      sv_2iv each time rather than a macro access direct to the IV slot
1926    * should speed up number->string conversion on integers as IV is
1927      favoured when IV and NV are equally accurate
1928
1929    ####################################################################
1930    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1931    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1932    On the other hand, SvUOK is true iff UV.
1933    ####################################################################
1934
1935    Your mileage will vary depending your CPU's relative fp to integer
1936    performance ratio.
1937 */
1938
1939 #ifndef NV_PRESERVES_UV
1940 #  define IS_NUMBER_UNDERFLOW_IV 1
1941 #  define IS_NUMBER_UNDERFLOW_UV 2
1942 #  define IS_NUMBER_IV_AND_UV    2
1943 #  define IS_NUMBER_OVERFLOW_IV  4
1944 #  define IS_NUMBER_OVERFLOW_UV  5
1945
1946 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1947
1948 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1949 STATIC int
1950 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1951 {
1952     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));
1953     if (SvNVX(sv) < (NV)IV_MIN) {
1954         (void)SvIOKp_on(sv);
1955         (void)SvNOK_on(sv);
1956         SvIVX(sv) = IV_MIN;
1957         return IS_NUMBER_UNDERFLOW_IV;
1958     }
1959     if (SvNVX(sv) > (NV)UV_MAX) {
1960         (void)SvIOKp_on(sv);
1961         (void)SvNOK_on(sv);
1962         SvIsUV_on(sv);
1963         SvUVX(sv) = UV_MAX;
1964         return IS_NUMBER_OVERFLOW_UV;
1965     }
1966     (void)SvIOKp_on(sv);
1967     (void)SvNOK_on(sv);
1968     /* Can't use strtol etc to convert this string.  (See truth table in
1969        sv_2iv  */
1970     if (SvNVX(sv) <= (UV)IV_MAX) {
1971         SvIVX(sv) = I_V(SvNVX(sv));
1972         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1973             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1974         } else {
1975             /* Integer is imprecise. NOK, IOKp */
1976         }
1977         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1978     }
1979     SvIsUV_on(sv);
1980     SvUVX(sv) = U_V(SvNVX(sv));
1981     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1982         if (SvUVX(sv) == UV_MAX) {
1983             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1984                possibly be preserved by NV. Hence, it must be overflow.
1985                NOK, IOKp */
1986             return IS_NUMBER_OVERFLOW_UV;
1987         }
1988         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1989     } else {
1990         /* Integer is imprecise. NOK, IOKp */
1991     }
1992     return IS_NUMBER_OVERFLOW_IV;
1993 }
1994 #endif /* !NV_PRESERVES_UV*/
1995
1996 /*
1997 =for apidoc sv_2iv
1998
1999 Return the integer value of an SV, doing any necessary string conversion,
2000 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2001
2002 =cut
2003 */
2004
2005 IV
2006 Perl_sv_2iv(pTHX_ register SV *sv)
2007 {
2008     if (!sv)
2009         return 0;
2010     if (SvGMAGICAL(sv)) {
2011         mg_get(sv);
2012         if (SvIOKp(sv))
2013             return SvIVX(sv);
2014         if (SvNOKp(sv)) {
2015             return I_V(SvNVX(sv));
2016         }
2017         if (SvPOKp(sv) && SvLEN(sv))
2018             return asIV(sv);
2019         if (!SvROK(sv)) {
2020             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2021                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2022                     report_uninit();
2023             }
2024             return 0;
2025         }
2026     }
2027     if (SvTHINKFIRST(sv)) {
2028         if (SvROK(sv)) {
2029           SV* tmpstr;
2030           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2031                 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2032               return SvIV(tmpstr);
2033           return PTR2IV(SvRV(sv));
2034         }
2035         if (SvREADONLY(sv) && SvFAKE(sv)) {
2036             sv_force_normal(sv);
2037         }
2038         if (SvREADONLY(sv) && !SvOK(sv)) {
2039             if (ckWARN(WARN_UNINITIALIZED))
2040                 report_uninit();
2041             return 0;
2042         }
2043     }
2044     if (SvIOKp(sv)) {
2045         if (SvIsUV(sv)) {
2046             return (IV)(SvUVX(sv));
2047         }
2048         else {
2049             return SvIVX(sv);
2050         }
2051     }
2052     if (SvNOKp(sv)) {
2053         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2054          * without also getting a cached IV/UV from it at the same time
2055          * (ie PV->NV conversion should detect loss of accuracy and cache
2056          * IV or UV at same time to avoid this.  NWC */
2057
2058         if (SvTYPE(sv) == SVt_NV)
2059             sv_upgrade(sv, SVt_PVNV);
2060
2061         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2062         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2063            certainly cast into the IV range at IV_MAX, whereas the correct
2064            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2065            cases go to UV */
2066         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2067             SvIVX(sv) = I_V(SvNVX(sv));
2068             if (SvNVX(sv) == (NV) SvIVX(sv)
2069 #ifndef NV_PRESERVES_UV
2070                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2071                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2072                 /* Don't flag it as "accurately an integer" if the number
2073                    came from a (by definition imprecise) NV operation, and
2074                    we're outside the range of NV integer precision */
2075 #endif
2076                 ) {
2077                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2078                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2079                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2080                                       PTR2UV(sv),
2081                                       SvNVX(sv),
2082                                       SvIVX(sv)));
2083
2084             } else {
2085                 /* IV not precise.  No need to convert from PV, as NV
2086                    conversion would already have cached IV if it detected
2087                    that PV->IV would be better than PV->NV->IV
2088                    flags already correct - don't set public IOK.  */
2089                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2090                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2091                                       PTR2UV(sv),
2092                                       SvNVX(sv),
2093                                       SvIVX(sv)));
2094             }
2095             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2096                but the cast (NV)IV_MIN rounds to a the value less (more
2097                negative) than IV_MIN which happens to be equal to SvNVX ??
2098                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2099                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2100                (NV)UVX == NVX are both true, but the values differ. :-(
2101                Hopefully for 2s complement IV_MIN is something like
2102                0x8000000000000000 which will be exact. NWC */
2103         }
2104         else {
2105             SvUVX(sv) = U_V(SvNVX(sv));
2106             if (
2107                 (SvNVX(sv) == (NV) SvUVX(sv))
2108 #ifndef  NV_PRESERVES_UV
2109                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2110                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2111                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2112                 /* Don't flag it as "accurately an integer" if the number
2113                    came from a (by definition imprecise) NV operation, and
2114                    we're outside the range of NV integer precision */
2115 #endif
2116                 )
2117                 SvIOK_on(sv);
2118             SvIsUV_on(sv);
2119           ret_iv_max:
2120             DEBUG_c(PerlIO_printf(Perl_debug_log,
2121                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2122                                   PTR2UV(sv),
2123                                   SvUVX(sv),
2124                                   SvUVX(sv)));
2125             return (IV)SvUVX(sv);
2126         }
2127     }
2128     else if (SvPOKp(sv) && SvLEN(sv)) {
2129         UV value;
2130         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2131         /* We want to avoid a possible problem when we cache an IV which
2132            may be later translated to an NV, and the resulting NV is not
2133            the same as the direct translation of the initial string
2134            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2135            be careful to ensure that the value with the .456 is around if the
2136            NV value is requested in the future).
2137         
2138            This means that if we cache such an IV, we need to cache the
2139            NV as well.  Moreover, we trade speed for space, and do not
2140            cache the NV if we are sure it's not needed.
2141          */
2142
2143         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2144         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2145              == IS_NUMBER_IN_UV) {
2146             /* It's definitely an integer, only upgrade to PVIV */
2147             if (SvTYPE(sv) < SVt_PVIV)
2148                 sv_upgrade(sv, SVt_PVIV);
2149             (void)SvIOK_on(sv);
2150         } else if (SvTYPE(sv) < SVt_PVNV)
2151             sv_upgrade(sv, SVt_PVNV);
2152
2153         /* If NV preserves UV then we only use the UV value if we know that
2154            we aren't going to call atof() below. If NVs don't preserve UVs
2155            then the value returned may have more precision than atof() will
2156            return, even though value isn't perfectly accurate.  */
2157         if ((numtype & (IS_NUMBER_IN_UV
2158 #ifdef NV_PRESERVES_UV
2159                         | IS_NUMBER_NOT_INT
2160 #endif
2161             )) == IS_NUMBER_IN_UV) {
2162             /* This won't turn off the public IOK flag if it was set above  */
2163             (void)SvIOKp_on(sv);
2164
2165             if (!(numtype & IS_NUMBER_NEG)) {
2166                 /* positive */;
2167                 if (value <= (UV)IV_MAX) {
2168                     SvIVX(sv) = (IV)value;
2169                 } else {
2170                     SvUVX(sv) = value;
2171                     SvIsUV_on(sv);
2172                 }
2173             } else {
2174                 /* 2s complement assumption  */
2175                 if (value <= (UV)IV_MIN) {
2176                     SvIVX(sv) = -(IV)value;
2177                 } else {
2178                     /* Too negative for an IV.  This is a double upgrade, but
2179                        I'm assuming it will be rare.  */
2180                     if (SvTYPE(sv) < SVt_PVNV)
2181                         sv_upgrade(sv, SVt_PVNV);
2182                     SvNOK_on(sv);
2183                     SvIOK_off(sv);
2184                     SvIOKp_on(sv);
2185                     SvNVX(sv) = -(NV)value;
2186                     SvIVX(sv) = IV_MIN;
2187                 }
2188             }
2189         }
2190         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2191            will be in the previous block to set the IV slot, and the next
2192            block to set the NV slot.  So no else here.  */
2193         
2194         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2195             != IS_NUMBER_IN_UV) {
2196             /* It wasn't an (integer that doesn't overflow the UV). */
2197             SvNVX(sv) = Atof(SvPVX(sv));
2198
2199             if (! numtype && ckWARN(WARN_NUMERIC))
2200                 not_a_number(sv);
2201
2202 #if defined(USE_LONG_DOUBLE)
2203             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2204                                   PTR2UV(sv), SvNVX(sv)));
2205 #else
2206             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2207                                   PTR2UV(sv), SvNVX(sv)));
2208 #endif
2209
2210
2211 #ifdef NV_PRESERVES_UV
2212             (void)SvIOKp_on(sv);
2213             (void)SvNOK_on(sv);
2214             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2215                 SvIVX(sv) = I_V(SvNVX(sv));
2216                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2217                     SvIOK_on(sv);
2218                 } else {
2219                     /* Integer is imprecise. NOK, IOKp */
2220                 }
2221                 /* UV will not work better than IV */
2222             } else {
2223                 if (SvNVX(sv) > (NV)UV_MAX) {
2224                     SvIsUV_on(sv);
2225                     /* Integer is inaccurate. NOK, IOKp, is UV */
2226                     SvUVX(sv) = UV_MAX;
2227                     SvIsUV_on(sv);
2228                 } else {
2229                     SvUVX(sv) = U_V(SvNVX(sv));
2230                     /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2231                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2232                         SvIOK_on(sv);
2233                         SvIsUV_on(sv);
2234                     } else {
2235                         /* Integer is imprecise. NOK, IOKp, is UV */
2236                         SvIsUV_on(sv);
2237                     }
2238                 }
2239                 goto ret_iv_max;
2240             }
2241 #else /* NV_PRESERVES_UV */
2242             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2243                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2244                 /* The IV slot will have been set from value returned by
2245                    grok_number above.  The NV slot has just been set using
2246                    Atof.  */
2247                 SvNOK_on(sv);
2248                 assert (SvIOKp(sv));
2249             } else {
2250                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2251                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2252                     /* Small enough to preserve all bits. */
2253                     (void)SvIOKp_on(sv);
2254                     SvNOK_on(sv);
2255                     SvIVX(sv) = I_V(SvNVX(sv));
2256                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2257                         SvIOK_on(sv);
2258                     /* Assumption: first non-preserved integer is < IV_MAX,
2259                        this NV is in the preserved range, therefore: */
2260                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2261                           < (UV)IV_MAX)) {
2262                         Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs(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);
2263                     }
2264                 } else {
2265                     /* IN_UV NOT_INT
2266                          0      0       already failed to read UV.
2267                          0      1       already failed to read UV.
2268                          1      0       you won't get here in this case. IV/UV
2269                                         slot set, public IOK, Atof() unneeded.
2270                          1      1       already read UV.
2271                        so there's no point in sv_2iuv_non_preserve() attempting
2272                        to use atol, strtol, strtoul etc.  */
2273                     if (sv_2iuv_non_preserve (sv, numtype)
2274                         >= IS_NUMBER_OVERFLOW_IV)
2275                     goto ret_iv_max;
2276                 }
2277             }
2278 #endif /* NV_PRESERVES_UV */
2279         }
2280     } else  {
2281         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2282             report_uninit();
2283         if (SvTYPE(sv) < SVt_IV)
2284             /* Typically the caller expects that sv_any is not NULL now.  */
2285             sv_upgrade(sv, SVt_IV);
2286         return 0;
2287     }
2288     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2289         PTR2UV(sv),SvIVX(sv)));
2290     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2291 }
2292
2293 /*
2294 =for apidoc sv_2uv
2295
2296 Return the unsigned integer value of an SV, doing any necessary string
2297 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2298 macros.
2299
2300 =cut
2301 */
2302
2303 UV
2304 Perl_sv_2uv(pTHX_ register SV *sv)
2305 {
2306     if (!sv)
2307         return 0;
2308     if (SvGMAGICAL(sv)) {
2309         mg_get(sv);
2310         if (SvIOKp(sv))
2311             return SvUVX(sv);
2312         if (SvNOKp(sv))
2313             return U_V(SvNVX(sv));
2314         if (SvPOKp(sv) && SvLEN(sv))
2315             return asUV(sv);
2316         if (!SvROK(sv)) {
2317             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2318                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2319                     report_uninit();
2320             }
2321             return 0;
2322         }
2323     }
2324     if (SvTHINKFIRST(sv)) {
2325         if (SvROK(sv)) {
2326           SV* tmpstr;
2327           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2328                 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2329               return SvUV(tmpstr);
2330           return PTR2UV(SvRV(sv));
2331         }
2332         if (SvREADONLY(sv) && SvFAKE(sv)) {
2333             sv_force_normal(sv);
2334         }
2335         if (SvREADONLY(sv) && !SvOK(sv)) {
2336             if (ckWARN(WARN_UNINITIALIZED))
2337                 report_uninit();
2338             return 0;
2339         }
2340     }
2341     if (SvIOKp(sv)) {
2342         if (SvIsUV(sv)) {
2343             return SvUVX(sv);
2344         }
2345         else {
2346             return (UV)SvIVX(sv);
2347         }
2348     }
2349     if (SvNOKp(sv)) {
2350         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2351          * without also getting a cached IV/UV from it at the same time
2352          * (ie PV->NV conversion should detect loss of accuracy and cache
2353          * IV or UV at same time to avoid this. */
2354         /* IV-over-UV optimisation - choose to cache IV if possible */
2355
2356         if (SvTYPE(sv) == SVt_NV)
2357             sv_upgrade(sv, SVt_PVNV);
2358
2359         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2360         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2361             SvIVX(sv) = I_V(SvNVX(sv));
2362             if (SvNVX(sv) == (NV) SvIVX(sv)
2363 #ifndef NV_PRESERVES_UV
2364                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2365                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2366                 /* Don't flag it as "accurately an integer" if the number
2367                    came from a (by definition imprecise) NV operation, and
2368                    we're outside the range of NV integer precision */
2369 #endif
2370                 ) {
2371                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2372                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2373                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2374                                       PTR2UV(sv),
2375                                       SvNVX(sv),
2376                                       SvIVX(sv)));
2377
2378             } else {
2379                 /* IV not precise.  No need to convert from PV, as NV
2380                    conversion would already have cached IV if it detected
2381                    that PV->IV would be better than PV->NV->IV
2382                    flags already correct - don't set public IOK.  */
2383                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2384                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2385                                       PTR2UV(sv),
2386                                       SvNVX(sv),
2387                                       SvIVX(sv)));
2388             }
2389             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2390                but the cast (NV)IV_MIN rounds to a the value less (more
2391                negative) than IV_MIN which happens to be equal to SvNVX ??
2392                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2393                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2394                (NV)UVX == NVX are both true, but the values differ. :-(
2395                Hopefully for 2s complement IV_MIN is something like
2396                0x8000000000000000 which will be exact. NWC */
2397         }
2398         else {
2399             SvUVX(sv) = U_V(SvNVX(sv));
2400             if (
2401                 (SvNVX(sv) == (NV) SvUVX(sv))
2402 #ifndef  NV_PRESERVES_UV
2403                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2404                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2405                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2406                 /* Don't flag it as "accurately an integer" if the number
2407                    came from a (by definition imprecise) NV operation, and
2408                    we're outside the range of NV integer precision */
2409 #endif
2410                 )
2411                 SvIOK_on(sv);
2412             SvIsUV_on(sv);
2413             DEBUG_c(PerlIO_printf(Perl_debug_log,
2414                                   "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2415                                   PTR2UV(sv),
2416                                   SvUVX(sv),
2417                                   SvUVX(sv)));
2418         }
2419     }
2420     else if (SvPOKp(sv) && SvLEN(sv)) {
2421         UV value;
2422         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2423
2424         /* We want to avoid a possible problem when we cache a UV which
2425            may be later translated to an NV, and the resulting NV is not
2426            the translation of the initial data.
2427         
2428            This means that if we cache such a UV, we need to cache the
2429            NV as well.  Moreover, we trade speed for space, and do not
2430            cache the NV if not needed.
2431          */
2432
2433         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2434         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2435              == IS_NUMBER_IN_UV) {
2436             /* It's definitely an integer, only upgrade to PVIV */
2437             if (SvTYPE(sv) < SVt_PVIV)
2438                 sv_upgrade(sv, SVt_PVIV);
2439             (void)SvIOK_on(sv);
2440         } else if (SvTYPE(sv) < SVt_PVNV)
2441             sv_upgrade(sv, SVt_PVNV);
2442
2443         /* If NV preserves UV then we only use the UV value if we know that
2444            we aren't going to call atof() below. If NVs don't preserve UVs
2445            then the value returned may have more precision than atof() will
2446            return, even though it isn't accurate.  */
2447         if ((numtype & (IS_NUMBER_IN_UV
2448 #ifdef NV_PRESERVES_UV
2449                         | IS_NUMBER_NOT_INT
2450 #endif
2451             )) == IS_NUMBER_IN_UV) {
2452             /* This won't turn off the public IOK flag if it was set above  */
2453             (void)SvIOKp_on(sv);
2454
2455             if (!(numtype & IS_NUMBER_NEG)) {
2456                 /* positive */;
2457                 if (value <= (UV)IV_MAX) {
2458                     SvIVX(sv) = (IV)value;
2459                 } else {
2460                     /* it didn't overflow, and it was positive. */
2461                     SvUVX(sv) = value;
2462                     SvIsUV_on(sv);
2463                 }
2464             } else {
2465                 /* 2s complement assumption  */
2466                 if (value <= (UV)IV_MIN) {
2467                     SvIVX(sv) = -(IV)value;
2468                 } else {
2469                     /* Too negative for an IV.  This is a double upgrade, but
2470                        I'm assuming it will be rare.  */
2471                     if (SvTYPE(sv) < SVt_PVNV)
2472                         sv_upgrade(sv, SVt_PVNV);
2473                     SvNOK_on(sv);
2474                     SvIOK_off(sv);
2475                     SvIOKp_on(sv);
2476                     SvNVX(sv) = -(NV)value;
2477                     SvIVX(sv) = IV_MIN;
2478                 }
2479             }
2480         }
2481         
2482         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2483             != IS_NUMBER_IN_UV) {
2484             /* It wasn't an integer, or it overflowed the UV. */
2485             SvNVX(sv) = Atof(SvPVX(sv));
2486
2487             if (! numtype && ckWARN(WARN_NUMERIC))
2488                     not_a_number(sv);
2489
2490 #if defined(USE_LONG_DOUBLE)
2491             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2492                                   PTR2UV(sv), SvNVX(sv)));
2493 #else
2494             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2495                                   PTR2UV(sv), SvNVX(sv)));
2496 #endif
2497
2498 #ifdef NV_PRESERVES_UV
2499             (void)SvIOKp_on(sv);
2500             (void)SvNOK_on(sv);
2501             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2502                 SvIVX(sv) = I_V(SvNVX(sv));
2503                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2504                     SvIOK_on(sv);
2505                 } else {
2506                     /* Integer is imprecise. NOK, IOKp */
2507                 }
2508                 /* UV will not work better than IV */
2509             } else {
2510                 if (SvNVX(sv) > (NV)UV_MAX) {
2511                     SvIsUV_on(sv);
2512                     /* Integer is inaccurate. NOK, IOKp, is UV */
2513                     SvUVX(sv) = UV_MAX;
2514                     SvIsUV_on(sv);
2515                 } else {
2516                     SvUVX(sv) = U_V(SvNVX(sv));
2517                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2518                        NV preservse UV so can do correct comparison.  */
2519                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2520                         SvIOK_on(sv);
2521                         SvIsUV_on(sv);
2522                     } else {
2523                         /* Integer is imprecise. NOK, IOKp, is UV */
2524                         SvIsUV_on(sv);
2525                     }
2526                 }
2527             }
2528 #else /* NV_PRESERVES_UV */
2529             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2530                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2531                 /* The UV slot will have been set from value returned by
2532                    grok_number above.  The NV slot has just been set using
2533                    Atof.  */
2534                 SvNOK_on(sv);
2535                 assert (SvIOKp(sv));
2536             } else {
2537                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2538                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2539                     /* Small enough to preserve all bits. */
2540                     (void)SvIOKp_on(sv);
2541                     SvNOK_on(sv);
2542                     SvIVX(sv) = I_V(SvNVX(sv));
2543                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2544                         SvIOK_on(sv);
2545                     /* Assumption: first non-preserved integer is < IV_MAX,
2546                        this NV is in the preserved range, therefore: */
2547                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2548                           < (UV)IV_MAX)) {
2549                         Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs(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);
2550                     }
2551                 } else
2552                     sv_2iuv_non_preserve (sv, numtype);
2553             }
2554 #endif /* NV_PRESERVES_UV */
2555         }
2556     }
2557     else  {
2558         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2559             if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2560                 report_uninit();
2561         }
2562         if (SvTYPE(sv) < SVt_IV)
2563             /* Typically the caller expects that sv_any is not NULL now.  */
2564             sv_upgrade(sv, SVt_IV);
2565         return 0;
2566     }
2567
2568     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2569                           PTR2UV(sv),SvUVX(sv)));
2570     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2571 }
2572
2573 /*
2574 =for apidoc sv_2nv
2575
2576 Return the num value of an SV, doing any necessary string or integer
2577 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2578 macros.
2579
2580 =cut
2581 */
2582
2583 NV
2584 Perl_sv_2nv(pTHX_ register SV *sv)
2585 {
2586     if (!sv)
2587         return 0.0;
2588     if (SvGMAGICAL(sv)) {
2589         mg_get(sv);
2590         if (SvNOKp(sv))
2591             return SvNVX(sv);
2592         if (SvPOKp(sv) && SvLEN(sv)) {
2593             if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2594                 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2595                 not_a_number(sv);
2596             return Atof(SvPVX(sv));
2597         }
2598         if (SvIOKp(sv)) {
2599             if (SvIsUV(sv))
2600                 return (NV)SvUVX(sv);
2601             else
2602                 return (NV)SvIVX(sv);
2603         }       
2604         if (!SvROK(sv)) {
2605             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2606                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2607                     report_uninit();
2608             }
2609             return 0;
2610         }
2611     }
2612     if (SvTHINKFIRST(sv)) {
2613         if (SvROK(sv)) {
2614           SV* tmpstr;
2615           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2616                 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2617               return SvNV(tmpstr);
2618           return PTR2NV(SvRV(sv));
2619         }
2620         if (SvREADONLY(sv) && SvFAKE(sv)) {
2621             sv_force_normal(sv);
2622         }
2623         if (SvREADONLY(sv) && !SvOK(sv)) {
2624             if (ckWARN(WARN_UNINITIALIZED))
2625                 report_uninit();
2626             return 0.0;
2627         }
2628     }
2629     if (SvTYPE(sv) < SVt_NV) {
2630         if (SvTYPE(sv) == SVt_IV)
2631             sv_upgrade(sv, SVt_PVNV);
2632         else
2633             sv_upgrade(sv, SVt_NV);
2634 #ifdef USE_LONG_DOUBLE
2635         DEBUG_c({
2636             STORE_NUMERIC_LOCAL_SET_STANDARD();
2637             PerlIO_printf(Perl_debug_log,
2638                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2639                           PTR2UV(sv), SvNVX(sv));
2640             RESTORE_NUMERIC_LOCAL();
2641         });
2642 #else
2643         DEBUG_c({
2644             STORE_NUMERIC_LOCAL_SET_STANDARD();
2645             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2646                           PTR2UV(sv), SvNVX(sv));
2647             RESTORE_NUMERIC_LOCAL();
2648         });
2649 #endif
2650     }
2651     else if (SvTYPE(sv) < SVt_PVNV)
2652         sv_upgrade(sv, SVt_PVNV);
2653     if (SvNOKp(sv)) {
2654         return SvNVX(sv);
2655     }
2656     if (SvIOKp(sv)) {
2657         SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2658 #ifdef NV_PRESERVES_UV
2659         SvNOK_on(sv);
2660 #else
2661         /* Only set the public NV OK flag if this NV preserves the IV  */
2662         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2663         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2664                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2665             SvNOK_on(sv);
2666         else
2667             SvNOKp_on(sv);
2668 #endif
2669     }
2670     else if (SvPOKp(sv) && SvLEN(sv)) {
2671         UV value;
2672         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2673         if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2674             not_a_number(sv);
2675 #ifdef NV_PRESERVES_UV
2676         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2677             == IS_NUMBER_IN_UV) {
2678             /* It's definitely an integer */
2679             SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2680         } else
2681             SvNVX(sv) = Atof(SvPVX(sv));
2682         SvNOK_on(sv);
2683 #else
2684         SvNVX(sv) = Atof(SvPVX(sv));
2685         /* Only set the public NV OK flag if this NV preserves the value in
2686            the PV at least as well as an IV/UV would.
2687            Not sure how to do this 100% reliably. */
2688         /* if that shift count is out of range then Configure's test is
2689            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2690            UV_BITS */
2691         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2692             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2693             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2694         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2695             /* Can't use strtol etc to convert this string, so don't try.
2696                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2697             SvNOK_on(sv);
2698         } else {
2699             /* value has been set.  It may not be precise.  */
2700             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2701                 /* 2s complement assumption for (UV)IV_MIN  */
2702                 SvNOK_on(sv); /* Integer is too negative.  */
2703             } else {
2704                 SvNOKp_on(sv);
2705                 SvIOKp_on(sv);
2706
2707                 if (numtype & IS_NUMBER_NEG) {
2708                     SvIVX(sv) = -(IV)value;
2709                 } else if (value <= (UV)IV_MAX) {
2710                     SvIVX(sv) = (IV)value;
2711                 } else {
2712                     SvUVX(sv) = value;
2713                     SvIsUV_on(sv);
2714                 }
2715
2716                 if (numtype & IS_NUMBER_NOT_INT) {
2717                     /* I believe that even if the original PV had decimals,
2718                        they are lost beyond the limit of the FP precision.
2719                        However, neither is canonical, so both only get p
2720                        flags.  NWC, 2000/11/25 */
2721                     /* Both already have p flags, so do nothing */
2722                 } else {
2723                     NV nv = SvNVX(sv);
2724                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2725                         if (SvIVX(sv) == I_V(nv)) {
2726                             SvNOK_on(sv);
2727                             SvIOK_on(sv);
2728                         } else {
2729                             SvIOK_on(sv);
2730                             /* It had no "." so it must be integer.  */
2731                         }
2732                     } else {
2733                         /* between IV_MAX and NV(UV_MAX).
2734                            Could be slightly > UV_MAX */
2735
2736                         if (numtype & IS_NUMBER_NOT_INT) {
2737                             /* UV and NV both imprecise.  */
2738                         } else {
2739                             UV nv_as_uv = U_V(nv);
2740
2741                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2742                                 SvNOK_on(sv);
2743                                 SvIOK_on(sv);
2744                             } else {
2745                                 SvIOK_on(sv);
2746                             }
2747                         }
2748                     }
2749                 }
2750             }
2751         }
2752 #endif /* NV_PRESERVES_UV */
2753     }
2754     else  {
2755         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2756             report_uninit();
2757         if (SvTYPE(sv) < SVt_NV)
2758             /* Typically the caller expects that sv_any is not NULL now.  */
2759             /* XXX Ilya implies that this is a bug in callers that assume this
2760                and ideally should be fixed.  */
2761             sv_upgrade(sv, SVt_NV);
2762         return 0.0;
2763     }
2764 #if defined(USE_LONG_DOUBLE)
2765     DEBUG_c({
2766         STORE_NUMERIC_LOCAL_SET_STANDARD();
2767         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2768                       PTR2UV(sv), SvNVX(sv));
2769         RESTORE_NUMERIC_LOCAL();
2770     });
2771 #else
2772     DEBUG_c({
2773         STORE_NUMERIC_LOCAL_SET_STANDARD();
2774         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2775                       PTR2UV(sv), SvNVX(sv));
2776         RESTORE_NUMERIC_LOCAL();
2777     });
2778 #endif
2779     return SvNVX(sv);
2780 }
2781
2782 /* asIV(): extract an integer from the string value of an SV.
2783  * Caller must validate PVX  */
2784
2785 STATIC IV
2786 S_asIV(pTHX_ SV *sv)
2787 {
2788     UV value;
2789     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2790
2791     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2792         == IS_NUMBER_IN_UV) {
2793         /* It's definitely an integer */
2794         if (numtype & IS_NUMBER_NEG) {
2795             if (value < (UV)IV_MIN)
2796                 return -(IV)value;
2797         } else {
2798             if (value < (UV)IV_MAX)
2799                 return (IV)value;
2800         }
2801     }
2802     if (!numtype) {
2803         if (ckWARN(WARN_NUMERIC))
2804             not_a_number(sv);
2805     }
2806     return I_V(Atof(SvPVX(sv)));
2807 }
2808
2809 /* asUV(): extract an unsigned integer from the string value of an SV
2810  * Caller must validate PVX  */
2811
2812 STATIC UV
2813 S_asUV(pTHX_ SV *sv)
2814 {
2815     UV value;
2816     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2817
2818     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2819         == IS_NUMBER_IN_UV) {
2820         /* It's definitely an integer */
2821         if (!(numtype & IS_NUMBER_NEG))
2822             return value;
2823     }
2824     if (!numtype) {
2825         if (ckWARN(WARN_NUMERIC))
2826             not_a_number(sv);
2827     }
2828     return U_V(Atof(SvPVX(sv)));
2829 }
2830
2831 /*
2832 =for apidoc sv_2pv_nolen
2833
2834 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2835 use the macro wrapper C<SvPV_nolen(sv)> instead.
2836 =cut
2837 */
2838
2839 char *
2840 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2841 {
2842     STRLEN n_a;
2843     return sv_2pv(sv, &n_a);
2844 }
2845
2846 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2847  * UV as a string towards the end of buf, and return pointers to start and
2848  * end of it.
2849  *
2850  * We assume that buf is at least TYPE_CHARS(UV) long.
2851  */
2852
2853 static char *
2854 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2855 {
2856     char *ptr = buf + TYPE_CHARS(UV);
2857     char *ebuf = ptr;
2858     int sign;
2859
2860     if (is_uv)
2861         sign = 0;
2862     else if (iv >= 0) {
2863         uv = iv;
2864         sign = 0;
2865     } else {
2866         uv = -iv;
2867         sign = 1;
2868     }
2869     do {
2870         *--ptr = '0' + (uv % 10);
2871     } while (uv /= 10);
2872     if (sign)
2873         *--ptr = '-';
2874     *peob = ebuf;
2875     return ptr;
2876 }
2877
2878 /* For backwards-compatibility only. sv_2pv() is normally #def'ed to
2879  * C<sv_2pv_macro()>. See also C<sv_2pv_flags()>.
2880  */
2881
2882 char *
2883 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2884 {
2885     return sv_2pv_flags(sv, lp, SV_GMAGIC);
2886 }
2887
2888 /*
2889 =for apidoc sv_2pv_flags
2890
2891 Returns a pointer to the string value of an SV, and sets *lp to its length.
2892 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2893 if necessary.
2894 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2895 usually end up here too.
2896
2897 =cut
2898 */
2899
2900 char *
2901 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2902 {
2903     register char *s;
2904     int olderrno;
2905     SV *tsv;
2906     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
2907     char *tmpbuf = tbuf;
2908
2909     if (!sv) {
2910         *lp = 0;
2911         return "";
2912     }
2913     if (SvGMAGICAL(sv)) {
2914         if (flags & SV_GMAGIC)
2915             mg_get(sv);
2916         if (SvPOKp(sv)) {
2917             *lp = SvCUR(sv);
2918             return SvPVX(sv);
2919         }
2920         if (SvIOKp(sv)) {
2921             if (SvIsUV(sv))
2922                 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2923             else
2924                 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2925             tsv = Nullsv;
2926             goto tokensave;
2927         }
2928         if (SvNOKp(sv)) {
2929             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2930             tsv = Nullsv;
2931             goto tokensave;
2932         }
2933         if (!SvROK(sv)) {
2934             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2935                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2936                     report_uninit();
2937             }
2938             *lp = 0;
2939             return "";
2940         }
2941     }
2942     if (SvTHINKFIRST(sv)) {
2943         if (SvROK(sv)) {
2944             SV* tmpstr;
2945             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2946                 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2947                 return SvPV(tmpstr,*lp);
2948             sv = (SV*)SvRV(sv);
2949             if (!sv)
2950                 s = "NULLREF";
2951             else {
2952                 MAGIC *mg;
2953                 
2954                 switch (SvTYPE(sv)) {
2955                 case SVt_PVMG:
2956                     if ( ((SvFLAGS(sv) &
2957                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2958                           == (SVs_OBJECT|SVs_RMG))
2959                          && strEQ(s=HvNAME(SvSTASH(sv)), "Regexp")
2960                          && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2961                         regexp *re = (regexp *)mg->mg_obj;
2962
2963                         if (!mg->mg_ptr) {
2964                             char *fptr = "msix";
2965                             char reflags[6];
2966                             char ch;
2967                             int left = 0;
2968                             int right = 4;
2969                             U16 reganch = (re->reganch & PMf_COMPILETIME) >> 12;
2970
2971                             while((ch = *fptr++)) {
2972                                 if(reganch & 1) {
2973                                     reflags[left++] = ch;
2974                                 }
2975                                 else {
2976                                     reflags[right--] = ch;
2977                                 }
2978                                 reganch >>= 1;
2979                             }
2980                             if(left != 4) {
2981                                 reflags[left] = '-';
2982                                 left = 5;
2983                             }
2984
2985                             mg->mg_len = re->prelen + 4 + left;
2986                             New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
2987                             Copy("(?", mg->mg_ptr, 2, char);
2988                             Copy(reflags, mg->mg_ptr+2, left, char);
2989                             Copy(":", mg->mg_ptr+left+2, 1, char);
2990                             Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2991                             mg->mg_ptr[mg->mg_len - 1] = ')';
2992                             mg->mg_ptr[mg->mg_len] = 0;
2993                         }
2994                         PL_reginterp_cnt += re->program[0].next_off;
2995                         *lp = mg->mg_len;
2996                         return mg->mg_ptr;
2997                     }
2998                                         /* Fall through */
2999                 case SVt_NULL:
3000                 case SVt_IV:
3001                 case SVt_NV:
3002                 case SVt_RV:
3003                 case SVt_PV:
3004                 case SVt_PVIV:
3005                 case SVt_PVNV:
3006                 case SVt_PVBM:  if (SvROK(sv))
3007                                     s = "REF";
3008                                 else
3009                                     s = "SCALAR";               break;
3010                 case SVt_PVLV:  s = "LVALUE";                   break;
3011                 case SVt_PVAV:  s = "ARRAY";                    break;
3012                 case SVt_PVHV:  s = "HASH";                     break;
3013                 case SVt_PVCV:  s = "CODE";                     break;
3014                 case SVt_PVGV:  s = "GLOB";                     break;
3015                 case SVt_PVFM:  s = "FORMAT";                   break;
3016                 case SVt_PVIO:  s = "IO";                       break;
3017                 default:        s = "UNKNOWN";                  break;
3018                 }
3019                 tsv = NEWSV(0,0);
3020                 if (SvOBJECT(sv)) {
3021                     HV *svs = SvSTASH(sv);
3022                     Perl_sv_setpvf(
3023                         aTHX_ tsv, "%s=%s",
3024                         /* [20011101.072] This bandaid for C<package;>
3025                            should eventually be removed. AMS 20011103 */
3026                         (svs ? HvNAME(svs) : "<none>"), s
3027                     );
3028                 }
3029                 else
3030                     sv_setpv(tsv, s);
3031                 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3032                 goto tokensaveref;
3033             }
3034             *lp = strlen(s);
3035             return s;
3036         }
3037         if (SvREADONLY(sv) && !SvOK(sv)) {
3038             if (ckWARN(WARN_UNINITIALIZED))
3039                 report_uninit();
3040             *lp = 0;
3041             return "";
3042         }
3043     }
3044     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3045         /* I'm assuming that if both IV and NV are equally valid then
3046            converting the IV is going to be more efficient */
3047         U32 isIOK = SvIOK(sv);
3048         U32 isUIOK = SvIsUV(sv);
3049         char buf[TYPE_CHARS(UV)];
3050         char *ebuf, *ptr;
3051
3052         if (SvTYPE(sv) < SVt_PVIV)
3053             sv_upgrade(sv, SVt_PVIV);
3054         if (isUIOK)
3055             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3056         else
3057             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3058         SvGROW(sv, ebuf - ptr + 1);     /* inlined from sv_setpvn */
3059         Move(ptr,SvPVX(sv),ebuf - ptr,char);
3060         SvCUR_set(sv, ebuf - ptr);
3061         s = SvEND(sv);
3062         *s = '\0';
3063         if (isIOK)
3064             SvIOK_on(sv);
3065         else
3066             SvIOKp_on(sv);
3067         if (isUIOK)
3068             SvIsUV_on(sv);
3069     }
3070     else if (SvNOKp(sv)) {
3071         if (SvTYPE(sv) < SVt_PVNV)
3072             sv_upgrade(sv, SVt_PVNV);
3073         /* The +20 is pure guesswork.  Configure test needed. --jhi */
3074         SvGROW(sv, NV_DIG + 20);
3075         s = SvPVX(sv);
3076         olderrno = errno;       /* some Xenix systems wipe out errno here */
3077 #ifdef apollo
3078         if (SvNVX(sv) == 0.0)
3079             (void)strcpy(s,"0");
3080         else
3081 #endif /*apollo*/
3082         {
3083             Gconvert(SvNVX(sv), NV_DIG, 0, s);
3084         }
3085         errno = olderrno;
3086 #ifdef FIXNEGATIVEZERO
3087         if (*s == '-' && s[1] == '0' && !s[2])
3088             strcpy(s,"0");
3089 #endif
3090         while (*s) s++;
3091 #ifdef hcx
3092         if (s[-1] == '.')
3093             *--s = '\0';
3094 #endif
3095     }
3096     else {
3097         if (ckWARN(WARN_UNINITIALIZED)
3098             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3099             report_uninit();
3100         *lp = 0;
3101         if (SvTYPE(sv) < SVt_PV)
3102             /* Typically the caller expects that sv_any is not NULL now.  */
3103             sv_upgrade(sv, SVt_PV);
3104         return "";
3105     }
3106     *lp = s - SvPVX(sv);
3107     SvCUR_set(sv, *lp);
3108     SvPOK_on(sv);
3109     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3110                           PTR2UV(sv),SvPVX(sv)));
3111     return SvPVX(sv);
3112
3113   tokensave:
3114     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
3115         /* Sneaky stuff here */
3116
3117       tokensaveref:
3118         if (!tsv)
3119             tsv = newSVpv(tmpbuf, 0);
3120         sv_2mortal(tsv);
3121         *lp = SvCUR(tsv);
3122         return SvPVX(tsv);
3123     }
3124     else {
3125         STRLEN len;
3126         char *t;
3127
3128         if (tsv) {
3129             sv_2mortal(tsv);
3130             t = SvPVX(tsv);
3131             len = SvCUR(tsv);
3132         }
3133         else {
3134             t = tmpbuf;
3135             len = strlen(tmpbuf);
3136         }
3137 #ifdef FIXNEGATIVEZERO
3138         if (len == 2 && t[0] == '-' && t[1] == '0') {
3139             t = "0";
3140             len = 1;
3141         }
3142 #endif
3143         (void)SvUPGRADE(sv, SVt_PV);
3144         *lp = len;
3145         s = SvGROW(sv, len + 1);
3146         SvCUR_set(sv, len);
3147         (void)strcpy(s, t);
3148         SvPOKp_on(sv);
3149         return s;
3150     }
3151 }
3152
3153 /*
3154 =for apidoc sv_copypv
3155
3156 Copies a stringified representation of the source SV into the
3157 destination SV.  Automatically performs any necessary mg_get and
3158 coercion of numeric values into strings.  Guaranteed to preserve
3159 UTF-8 flag even from overloaded objects.  Similar in nature to
3160 sv_2pv[_flags] but operates directly on an SV instead of just the
3161 string.  Mostly uses sv_2pv_flags to do its work, except when that
3162 would lose the UTF-8'ness of the PV.
3163
3164 =cut
3165 */
3166
3167 void
3168 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3169 {
3170     SV *tmpsv = sv_newmortal();
3171
3172     if ( SvTHINKFIRST(ssv) && SvROK(ssv) && SvAMAGIC(ssv) ) {
3173         tmpsv = AMG_CALLun(ssv,string);
3174         if (SvTYPE(tmpsv) != SVt_RV || (SvRV(tmpsv) != SvRV(ssv))) {
3175             SvSetSV(dsv,tmpsv);
3176             return;
3177         }
3178     }
3179     {
3180         STRLEN len;
3181         char *s;
3182         s = SvPV(ssv,len);
3183         sv_setpvn(tmpsv,s,len);
3184         if (SvUTF8(ssv))
3185             SvUTF8_on(tmpsv);
3186         else
3187             SvUTF8_off(tmpsv);
3188         SvSetSV(dsv,tmpsv);
3189     }
3190 }
3191
3192 /*
3193 =for apidoc sv_2pvbyte_nolen
3194
3195 Return a pointer to the byte-encoded representation of the SV.
3196 May cause the SV to be downgraded from UTF8 as a side-effect.
3197
3198 Usually accessed via the C<SvPVbyte_nolen> macro.
3199
3200 =cut
3201 */
3202
3203 char *
3204 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3205 {
3206     STRLEN n_a;
3207     return sv_2pvbyte(sv, &n_a);
3208 }
3209
3210 /*
3211 =for apidoc sv_2pvbyte
3212
3213 Return a pointer to the byte-encoded representation of the SV, and set *lp
3214 to its length.  May cause the SV to be downgraded from UTF8 as a
3215 side-effect.
3216
3217 Usually accessed via the C<SvPVbyte> macro.
3218
3219 =cut
3220 */
3221
3222 char *
3223 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3224 {
3225     sv_utf8_downgrade(sv,0);
3226     return SvPV(sv,*lp);
3227 }
3228
3229 /*
3230 =for apidoc sv_2pvutf8_nolen
3231
3232 Return a pointer to the UTF8-encoded representation of the SV.
3233 May cause the SV to be upgraded to UTF8 as a side-effect.
3234
3235 Usually accessed via the C<SvPVutf8_nolen> macro.
3236
3237 =cut
3238 */
3239
3240 char *
3241 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3242 {
3243     STRLEN n_a;
3244     return sv_2pvutf8(sv, &n_a);
3245 }
3246
3247 /*
3248 =for apidoc sv_2pvutf8
3249
3250 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3251 to its length.  May cause the SV to be upgraded to UTF8 as a side-effect.
3252
3253 Usually accessed via the C<SvPVutf8> macro.
3254
3255 =cut
3256 */
3257
3258 char *
3259 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3260 {
3261     sv_utf8_upgrade(sv);
3262     return SvPV(sv,*lp);
3263 }
3264
3265 /*
3266 =for apidoc sv_2bool
3267
3268 This function is only called on magical items, and is only used by
3269 sv_true() or its macro equivalent.
3270
3271 =cut
3272 */
3273
3274 bool
3275 Perl_sv_2bool(pTHX_ register SV *sv)
3276 {
3277     if (SvGMAGICAL(sv))
3278         mg_get(sv);
3279
3280     if (!SvOK(sv))
3281         return 0;
3282     if (SvROK(sv)) {
3283         SV* tmpsv;
3284         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3285                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3286             return SvTRUE(tmpsv);
3287       return SvRV(sv) != 0;
3288     }
3289     if (SvPOKp(sv)) {
3290         register XPV* Xpvtmp;
3291         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3292                 (*Xpvtmp->xpv_pv > '0' ||
3293                 Xpvtmp->xpv_cur > 1 ||
3294                 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3295             return 1;
3296         else
3297             return 0;
3298     }
3299     else {
3300         if (SvIOKp(sv))
3301             return SvIVX(sv) != 0;
3302         else {
3303             if (SvNOKp(sv))
3304                 return SvNVX(sv) != 0.0;
3305             else
3306                 return FALSE;
3307         }
3308     }
3309 }
3310
3311 /*
3312 =for apidoc sv_utf8_upgrade
3313
3314 Convert the PV of an SV to its UTF8-encoded form.
3315 Forces the SV to string form if it is not already.
3316 Always sets the SvUTF8 flag to avoid future validity checks even
3317 if all the bytes have hibit clear.
3318
3319 This is not as a general purpose byte encoding to Unicode interface:
3320 use the Encode extension for that.
3321
3322 =cut
3323 */
3324
3325 STRLEN
3326 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3327 {
3328     return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3329 }
3330
3331 /*
3332 =for apidoc sv_utf8_upgrade_flags
3333
3334 Convert the PV of an SV to its UTF8-encoded form.
3335 Forces the SV to string form if it is not already.
3336 Always sets the SvUTF8 flag to avoid future validity checks even
3337 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3338 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3339 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3340
3341 This is not as a general purpose byte encoding to Unicode interface:
3342 use the Encode extension for that.
3343
3344 =cut
3345 */
3346
3347 STRLEN
3348 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3349 {
3350     U8 *s, *t, *e;
3351     int  hibit = 0;
3352
3353     if (!sv)
3354         return 0;
3355
3356     if (!SvPOK(sv)) {
3357         STRLEN len = 0;
3358         (void) sv_2pv_flags(sv,&len, flags);
3359         if (!SvPOK(sv))
3360              return len;
3361     }
3362
3363     if (SvUTF8(sv))
3364         return SvCUR(sv);
3365
3366     if (SvREADONLY(sv) && SvFAKE(sv)) {
3367         sv_force_normal(sv);
3368     }
3369
3370     if (PL_encoding)
3371         sv_recode_to_utf8(sv, PL_encoding);
3372     else { /* Assume Latin-1/EBCDIC */
3373          /* This function could be much more efficient if we
3374           * had a FLAG in SVs to signal if there are any hibit
3375           * chars in the PV.  Given that there isn't such a flag
3376           * make the loop as fast as possible. */
3377          s = (U8 *) SvPVX(sv);
3378          e = (U8 *) SvEND(sv);
3379          t = s;
3380          while (t < e) {
3381               U8 ch = *t++;
3382               if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3383                    break;
3384          }
3385          if (hibit) {
3386               STRLEN len;
3387         
3388               len = SvCUR(sv) + 1; /* Plus the \0 */
3389               SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3390               SvCUR(sv) = len - 1;
3391               if (SvLEN(sv) != 0)
3392                    Safefree(s); /* No longer using what was there before. */
3393               SvLEN(sv) = len; /* No longer know the real size. */
3394          }
3395          /* Mark as UTF-8 even if no hibit - saves scanning loop */
3396          SvUTF8_on(sv);
3397     }
3398     return SvCUR(sv);
3399 }
3400
3401 /*
3402 =for apidoc sv_utf8_downgrade
3403
3404 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3405 This may not be possible if the PV contains non-byte encoding characters;
3406 if this is the case, either returns false or, if C<fail_ok> is not
3407 true, croaks.
3408
3409 This is not as a general purpose Unicode to byte encoding interface:
3410 use the Encode extension for that.
3411
3412 =cut
3413 */
3414
3415 bool
3416 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3417 {
3418     if (SvPOK(sv) && SvUTF8(sv)) {
3419         if (SvCUR(sv)) {
3420             U8 *s;
3421             STRLEN len;
3422
3423             if (SvREADONLY(sv) && SvFAKE(sv))
3424                 sv_force_normal(sv);
3425             s = (U8 *) SvPV(sv, len);
3426             if (!utf8_to_bytes(s, &len)) {
3427                 if (fail_ok)
3428                     return FALSE;
3429                 else {
3430                     if (PL_op)
3431                         Perl_croak(aTHX_ "Wide character in %s",
3432                                    OP_DESC(PL_op));
3433                     else
3434                         Perl_croak(aTHX_ "Wide character");
3435                 }
3436             }
3437             SvCUR(sv) = len;
3438         }
3439     }
3440     SvUTF8_off(sv);
3441     return TRUE;
3442 }
3443
3444 /*
3445 =for apidoc sv_utf8_encode
3446
3447 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3448 flag so that it looks like octets again. Used as a building block
3449 for encode_utf8 in Encode.xs
3450
3451 =cut
3452 */
3453
3454 void
3455 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3456 {
3457     (void) sv_utf8_upgrade(sv);
3458     SvUTF8_off(sv);
3459 }
3460
3461 /*
3462 =for apidoc sv_utf8_decode
3463
3464 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3465 turn off SvUTF8 if needed so that we see characters. Used as a building block
3466 for decode_utf8 in Encode.xs
3467
3468 =cut
3469 */
3470
3471 bool
3472 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3473 {
3474     if (SvPOK(sv)) {
3475         U8 *c;
3476         U8 *e;
3477
3478         /* The octets may have got themselves encoded - get them back as
3479          * bytes
3480          */
3481         if (!sv_utf8_downgrade(sv, TRUE))
3482             return FALSE;
3483
3484         /* it is actually just a matter of turning the utf8 flag on, but
3485          * we want to make sure everything inside is valid utf8 first.
3486          */
3487         c = (U8 *) SvPVX(sv);
3488         if (!is_utf8_string(c, SvCUR(sv)+1))
3489             return FALSE;
3490         e = (U8 *) SvEND(sv);
3491         while (c < e) {
3492             U8 ch = *c++;
3493             if (!UTF8_IS_INVARIANT(ch)) {
3494                 SvUTF8_on(sv);
3495                 break;
3496             }
3497         }
3498     }
3499     return TRUE;
3500 }
3501
3502 /*
3503 =for apidoc sv_setsv
3504
3505 Copies the contents of the source SV C<ssv> into the destination SV
3506 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3507 function if the source SV needs to be reused. Does not handle 'set' magic.
3508 Loosely speaking, it performs a copy-by-value, obliterating any previous
3509 content of the destination.
3510
3511 You probably want to use one of the assortment of wrappers, such as
3512 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3513 C<SvSetMagicSV_nosteal>.
3514
3515
3516 =cut
3517 */
3518
3519 /* sv_setsv() is aliased to Perl_sv_setsv_macro; this function provided
3520    for binary compatibility only
3521 */
3522 void
3523 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3524 {
3525     sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3526 }
3527
3528 /*
3529 =for apidoc sv_setsv_flags
3530
3531 Copies the contents of the source SV C<ssv> into the destination SV
3532 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3533 function if the source SV needs to be reused. Does not handle 'set' magic.
3534 Loosely speaking, it performs a copy-by-value, obliterating any previous
3535 content of the destination.
3536 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3537 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3538 implemented in terms of this function.
3539
3540 You probably want to use one of the assortment of wrappers, such as
3541 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3542 C<SvSetMagicSV_nosteal>.
3543
3544 This is the primary function for copying scalars, and most other
3545 copy-ish functions and macros use this underneath.
3546
3547 =cut
3548 */
3549
3550 void
3551 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3552 {
3553     register U32 sflags;
3554     register int dtype;
3555     register int stype;
3556
3557     if (sstr == dstr)
3558         return;
3559     SV_CHECK_THINKFIRST(dstr);
3560     if (!sstr)
3561         sstr = &PL_sv_undef;
3562     stype = SvTYPE(sstr);
3563     dtype = SvTYPE(dstr);
3564
3565     SvAMAGIC_off(dstr);
3566
3567     /* There's a lot of redundancy below but we're going for speed here */
3568
3569     switch (stype) {
3570     case SVt_NULL:
3571       undef_sstr:
3572         if (dtype != SVt_PVGV) {
3573             (void)SvOK_off(dstr);
3574             return;
3575         }
3576         break;
3577     case SVt_IV:
3578         if (SvIOK(sstr)) {
3579             switch (dtype) {
3580             case SVt_NULL:
3581                 sv_upgrade(dstr, SVt_IV);
3582                 break;
3583             case SVt_NV:
3584                 sv_upgrade(dstr, SVt_PVNV);
3585                 break;
3586             case SVt_RV:
3587             case SVt_PV:
3588                 sv_upgrade(dstr, SVt_PVIV);
3589                 break;
3590             }
3591             (void)SvIOK_only(dstr);
3592             SvIVX(dstr) = SvIVX(sstr);
3593             if (SvIsUV(sstr))
3594                 SvIsUV_on(dstr);
3595             if (SvTAINTED(sstr))
3596                 SvTAINT(dstr);
3597             return;
3598         }
3599         goto undef_sstr;
3600
3601     case SVt_NV:
3602         if (SvNOK(sstr)) {
3603             switch (dtype) {
3604             case SVt_NULL:
3605             case SVt_IV:
3606                 sv_upgrade(dstr, SVt_NV);
3607                 break;
3608             case SVt_RV:
3609             case SVt_PV:
3610             case SVt_PVIV:
3611                 sv_upgrade(dstr, SVt_PVNV);
3612                 break;
3613             }
3614             SvNVX(dstr) = SvNVX(sstr);
3615             (void)SvNOK_only(dstr);
3616             if (SvTAINTED(sstr))
3617                 SvTAINT(dstr);
3618             return;
3619         }
3620         goto undef_sstr;
3621
3622     case SVt_RV:
3623         if (dtype < SVt_RV)
3624             sv_upgrade(dstr, SVt_RV);
3625         else if (dtype == SVt_PVGV &&
3626                  SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3627             sstr = SvRV(sstr);
3628             if (sstr == dstr) {
3629                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3630                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3631                 {
3632                     GvIMPORTED_on(dstr);
3633                 }
3634                 GvMULTI_on(dstr);
3635                 return;
3636             }
3637             goto glob_assign;
3638         }
3639         break;
3640     case SVt_PV:
3641     case SVt_PVFM:
3642         if (dtype < SVt_PV)
3643             sv_upgrade(dstr, SVt_PV);
3644         break;
3645     case SVt_PVIV:
3646         if (dtype < SVt_PVIV)
3647             sv_upgrade(dstr, SVt_PVIV);
3648         break;
3649     case SVt_PVNV:
3650         if (dtype < SVt_PVNV)
3651             sv_upgrade(dstr, SVt_PVNV);
3652         break;
3653     case SVt_PVAV:
3654     case SVt_PVHV:
3655     case SVt_PVCV:
3656     case SVt_PVIO:
3657         if (PL_op)
3658             Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3659                 OP_NAME(PL_op));
3660         else
3661             Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3662         break;
3663
3664     case SVt_PVGV:
3665         if (dtype <= SVt_PVGV) {
3666   glob_assign:
3667             if (dtype != SVt_PVGV) {
3668                 char *name = GvNAME(sstr);
3669                 STRLEN len = GvNAMELEN(sstr);
3670                 sv_upgrade(dstr, SVt_PVGV);
3671                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3672                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3673                 GvNAME(dstr) = savepvn(name, len);
3674                 GvNAMELEN(dstr) = len;
3675                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3676             }
3677             /* ahem, death to those who redefine active sort subs */
3678             else if (PL_curstackinfo->si_type == PERLSI_SORT
3679                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3680                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3681                       GvNAME(dstr));
3682
3683 #ifdef GV_UNIQUE_CHECK
3684                 if (GvUNIQUE((GV*)dstr)) {
3685                     Perl_croak(aTHX_ PL_no_modify);
3686                 }
3687 #endif
3688
3689             (void)SvOK_off(dstr);
3690             GvINTRO_off(dstr);          /* one-shot flag */
3691             gp_free((GV*)dstr);
3692             GvGP(dstr) = gp_ref(GvGP(sstr));
3693             if (SvTAINTED(sstr))
3694                 SvTAINT(dstr);
3695             if (GvIMPORTED(dstr) != GVf_IMPORTED
3696                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3697             {
3698                 GvIMPORTED_on(dstr);
3699             }
3700             GvMULTI_on(dstr);
3701             return;
3702         }
3703         /* FALL THROUGH */
3704
3705     default:
3706         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3707             mg_get(sstr);
3708             if (SvTYPE(sstr) != stype) {
3709                 stype = SvTYPE(sstr);
3710                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3711                     goto glob_assign;
3712             }
3713         }
3714         if (stype == SVt_PVLV)
3715             (void)SvUPGRADE(dstr, SVt_PVNV);
3716         else
3717             (void)SvUPGRADE(dstr, stype);
3718     }
3719
3720     sflags = SvFLAGS(sstr);
3721
3722     if (sflags & SVf_ROK) {
3723         if (dtype >= SVt_PV) {
3724             if (dtype == SVt_PVGV) {
3725                 SV *sref = SvREFCNT_inc(SvRV(sstr));
3726                 SV *dref = 0;
3727                 int intro = GvINTRO(dstr);
3728
3729 #ifdef GV_UNIQUE_CHECK
3730                 if (GvUNIQUE((GV*)dstr)) {
3731                     Perl_croak(aTHX_ PL_no_modify);
3732                 }
3733 #endif
3734
3735                 if (intro) {
3736                     GvINTRO_off(dstr);  /* one-shot flag */
3737                     GvLINE(dstr) = CopLINE(PL_curcop);
3738                     GvEGV(dstr) = (GV*)dstr;
3739                 }
3740                 GvMULTI_on(dstr);
3741                 switch (SvTYPE(sref)) {
3742                 case SVt_PVAV:
3743                     if (intro)
3744                         SAVESPTR(GvAV(dstr));
3745                     else
3746                         dref = (SV*)GvAV(dstr);
3747                     GvAV(dstr) = (AV*)sref;
3748                     if (!GvIMPORTED_AV(dstr)
3749                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3750                     {
3751                         GvIMPORTED_AV_on(dstr);
3752                     }
3753                     break;
3754                 case SVt_PVHV:
3755                     if (intro)
3756                         SAVESPTR(GvHV(dstr));
3757                     else
3758                         dref = (SV*)GvHV(dstr);
3759                     GvHV(dstr) = (HV*)sref;
3760                     if (!GvIMPORTED_HV(dstr)
3761                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3762                     {
3763                         GvIMPORTED_HV_on(dstr);
3764                     }
3765                     break;
3766                 case SVt_PVCV:
3767                     if (intro) {
3768                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3769                             SvREFCNT_dec(GvCV(dstr));
3770                             GvCV(dstr) = Nullcv;
3771                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3772                             PL_sub_generation++;
3773                         }
3774                         SAVESPTR(GvCV(dstr));
3775                     }
3776                     else
3777                         dref = (SV*)GvCV(dstr);
3778                     if (GvCV(dstr) != (CV*)sref) {
3779                         CV* cv = GvCV(dstr);
3780                         if (cv) {
3781                             if (!GvCVGEN((GV*)dstr) &&
3782                                 (CvROOT(cv) || CvXSUB(cv)))
3783                             {
3784                                 /* ahem, death to those who redefine
3785                                  * active sort subs */
3786                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3787                                       PL_sortcop == CvSTART(cv))
3788                                     Perl_croak(aTHX_
3789                                     "Can't redefine active sort subroutine %s",
3790                                           GvENAME((GV*)dstr));
3791                                 /* Redefining a sub - warning is mandatory if
3792                                    it was a const and its value changed. */
3793                                 if (ckWARN(WARN_REDEFINE)
3794                                     || (CvCONST(cv)
3795                                         && (!CvCONST((CV*)sref)
3796                                             || sv_cmp(cv_const_sv(cv),
3797                                                       cv_const_sv((CV*)sref)))))
3798                                 {
3799                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3800                                         CvCONST(cv)
3801                                         ? "Constant subroutine %s redefined"
3802                                         : "Subroutine %s redefined",
3803                                         GvENAME((GV*)dstr));
3804                                 }
3805                             }
3806                             if (!intro)
3807                                 cv_ckproto(cv, (GV*)dstr,
3808                                         SvPOK(sref) ? SvPVX(sref) : Nullch);
3809                         }
3810                         GvCV(dstr) = (CV*)sref;
3811                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3812                         GvASSUMECV_on(dstr);
3813                         PL_sub_generation++;
3814                     }
3815                     if (!GvIMPORTED_CV(dstr)
3816                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3817                     {
3818                         GvIMPORTED_CV_on(dstr);
3819                     }
3820                     break;
3821                 case SVt_PVIO:
3822                     if (intro)
3823                         SAVESPTR(GvIOp(dstr));
3824                     else
3825                         dref = (SV*)GvIOp(dstr);
3826                     GvIOp(dstr) = (IO*)sref;
3827                     break;
3828                 case SVt_PVFM:
3829                     if (intro)
3830                         SAVESPTR(GvFORM(dstr));
3831                     else
3832                         dref = (SV*)GvFORM(dstr);
3833                     GvFORM(dstr) = (CV*)sref;
3834                     break;
3835                 default:
3836                     if (intro)
3837                         SAVESPTR(GvSV(dstr));
3838                     else
3839                         dref = (SV*)GvSV(dstr);
3840                     GvSV(dstr) = sref;
3841                     if (!GvIMPORTED_SV(dstr)
3842                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3843                     {
3844                         GvIMPORTED_SV_on(dstr);
3845                     }
3846                     break;
3847                 }
3848                 if (dref)
3849                     SvREFCNT_dec(dref);
3850                 if (intro)
3851                     SAVEFREESV(sref);
3852                 if (SvTAINTED(sstr))
3853                     SvTAINT(dstr);
3854                 return;
3855             }
3856             if (SvPVX(dstr)) {
3857                 (void)SvOOK_off(dstr);          /* backoff */
3858                 if (SvLEN(dstr))
3859                     Safefree(SvPVX(dstr));
3860                 SvLEN(dstr)=SvCUR(dstr)=0;
3861             }
3862         }
3863         (void)SvOK_off(dstr);
3864         SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3865         SvROK_on(dstr);
3866         if (sflags & SVp_NOK) {
3867             SvNOKp_on(dstr);
3868             /* Only set the public OK flag if the source has public OK.  */
3869             if (sflags & SVf_NOK)
3870                 SvFLAGS(dstr) |= SVf_NOK;
3871             SvNVX(dstr) = SvNVX(sstr);
3872         }
3873         if (sflags & SVp_IOK) {
3874             (void)SvIOKp_on(dstr);
3875             if (sflags & SVf_IOK)
3876                 SvFLAGS(dstr) |= SVf_IOK;
3877             if (sflags & SVf_IVisUV)
3878                 SvIsUV_on(dstr);
3879             SvIVX(dstr) = SvIVX(sstr);
3880         }
3881         if (SvAMAGIC(sstr)) {
3882             SvAMAGIC_on(dstr);
3883         }
3884     }
3885     else if (sflags & SVp_POK) {
3886
3887         /*
3888          * Check to see if we can just swipe the string.  If so, it's a
3889          * possible small lose on short strings, but a big win on long ones.
3890          * It might even be a win on short strings if SvPVX(dstr)
3891          * has to be allocated and SvPVX(sstr) has to be freed.
3892          */
3893
3894         if (SvTEMP(sstr) &&             /* slated for free anyway? */
3895             SvREFCNT(sstr) == 1 &&      /* and no other references to it? */
3896             !(sflags & SVf_OOK) &&      /* and not involved in OOK hack? */
3897             SvLEN(sstr)         &&      /* and really is a string */
3898                                 /* and won't be needed again, potentially */
3899             !(PL_op && PL_op->op_type == OP_AASSIGN))
3900         {
3901             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
3902                 if (SvOOK(dstr)) {
3903                     SvFLAGS(dstr) &= ~SVf_OOK;
3904                     Safefree(SvPVX(dstr) - SvIVX(dstr));
3905                 }
3906                 else if (SvLEN(dstr))
3907                     Safefree(SvPVX(dstr));
3908             }
3909             (void)SvPOK_only(dstr);
3910             SvPV_set(dstr, SvPVX(sstr));
3911             SvLEN_set(dstr, SvLEN(sstr));
3912             SvCUR_set(dstr, SvCUR(sstr));
3913
3914             SvTEMP_off(dstr);
3915             (void)SvOK_off(sstr);       /* NOTE: nukes most SvFLAGS on sstr */
3916             SvPV_set(sstr, Nullch);
3917             SvLEN_set(sstr, 0);
3918             SvCUR_set(sstr, 0);
3919             SvTEMP_off(sstr);
3920         }
3921         else {                          /* have to copy actual string */
3922             STRLEN len = SvCUR(sstr);
3923             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3924             Move(SvPVX(sstr),SvPVX(dstr),len,char);
3925             SvCUR_set(dstr, len);
3926             *SvEND(dstr) = '\0';
3927             (void)SvPOK_only(dstr);
3928         }
3929         if (sflags & SVf_UTF8)
3930             SvUTF8_on(dstr);
3931         /*SUPPRESS 560*/
3932         if (sflags & SVp_NOK) {
3933             SvNOKp_on(dstr);
3934             if (sflags & SVf_NOK)
3935                 SvFLAGS(dstr) |= SVf_NOK;
3936             SvNVX(dstr) = SvNVX(sstr);
3937         }
3938         if (sflags & SVp_IOK) {
3939             (void)SvIOKp_on(dstr);
3940             if (sflags & SVf_IOK)
3941                 SvFLAGS(dstr) |= SVf_IOK;
3942             if (sflags & SVf_IVisUV)
3943                 SvIsUV_on(dstr);
3944             SvIVX(dstr) = SvIVX(sstr);
3945         }
3946     }
3947     else if (sflags & SVp_IOK) {
3948         if (sflags & SVf_IOK)
3949             (void)SvIOK_only(dstr);
3950         else {
3951             (void)SvOK_off(dstr);
3952             (void)SvIOKp_on(dstr);
3953         }
3954         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3955         if (sflags & SVf_IVisUV)
3956             SvIsUV_on(dstr);
3957         SvIVX(dstr) = SvIVX(sstr);
3958         if (sflags & SVp_NOK) {
3959             if (sflags & SVf_NOK)
3960                 (void)SvNOK_on(dstr);
3961             else
3962                 (void)SvNOKp_on(dstr);
3963             SvNVX(dstr) = SvNVX(sstr);
3964         }
3965     }
3966     else if (sflags & SVp_NOK) {
3967         if (sflags & SVf_NOK)
3968             (void)SvNOK_only(dstr);
3969         else {
3970             (void)SvOK_off(dstr);
3971             SvNOKp_on(dstr);
3972         }
3973         SvNVX(dstr) = SvNVX(sstr);
3974     }
3975     else {
3976         if (dtype == SVt_PVGV) {
3977             if (ckWARN(WARN_MISC))
3978                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3979         }
3980         else
3981             (void)SvOK_off(dstr);
3982     }
3983     if (SvTAINTED(sstr))
3984         SvTAINT(dstr);
3985 }
3986
3987 /*
3988 =for apidoc sv_setsv_mg
3989
3990 Like C<sv_setsv>, but also handles 'set' magic.
3991
3992 =cut
3993 */
3994
3995 void
3996 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3997 {
3998     sv_setsv(dstr,sstr);
3999     SvSETMAGIC(dstr);
4000 }
4001
4002 /*
4003 =for apidoc sv_setpvn
4004
4005 Copies a string into an SV.  The C<len> parameter indicates the number of
4006 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4007
4008 =cut
4009 */
4010
4011 void
4012 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4013 {
4014     register char *dptr;
4015
4016     SV_CHECK_THINKFIRST(sv);
4017     if (!ptr) {
4018         (void)SvOK_off(sv);
4019         return;
4020     }
4021     else {
4022         /* len is STRLEN which is unsigned, need to copy to signed */
4023         IV iv = len;
4024         if (iv < 0)
4025             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4026     }
4027     (void)SvUPGRADE(sv, SVt_PV);
4028
4029     SvGROW(sv, len + 1);
4030     dptr = SvPVX(sv);
4031     Move(ptr,dptr,len,char);
4032     dptr[len] = '\0';
4033     SvCUR_set(sv, len);
4034     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4035     SvTAINT(sv);
4036 }
4037
4038 /*
4039 =for apidoc sv_setpvn_mg
4040
4041 Like C<sv_setpvn>, but also handles 'set' magic.
4042
4043 =cut
4044 */
4045
4046 void
4047 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4048 {
4049     sv_setpvn(sv,ptr,len);
4050     SvSETMAGIC(sv);
4051 }
4052
4053 /*
4054 =for apidoc sv_setpv
4055
4056 Copies a string into an SV.  The string must be null-terminated.  Does not
4057 handle 'set' magic.  See C<sv_setpv_mg>.
4058
4059 =cut
4060 */
4061
4062 void
4063 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4064 {
4065     register STRLEN len;
4066
4067     SV_CHECK_THINKFIRST(sv);
4068     if (!ptr) {
4069         (void)SvOK_off(sv);
4070         return;
4071     }
4072     len = strlen(ptr);
4073     (void)SvUPGRADE(sv, SVt_PV);
4074
4075     SvGROW(sv, len + 1);
4076     Move(ptr,SvPVX(sv),len+1,char);
4077     SvCUR_set(sv, len);
4078     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4079     SvTAINT(sv);
4080 }
4081
4082 /*
4083 =for apidoc sv_setpv_mg
4084
4085 Like C<sv_setpv>, but also handles 'set' magic.
4086
4087 =cut
4088 */
4089
4090 void
4091 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4092 {
4093     sv_setpv(sv,ptr);
4094     SvSETMAGIC(sv);
4095 }
4096
4097 /*
4098 =for apidoc sv_usepvn
4099
4100 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4101 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4102 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4103 string length, C<len>, must be supplied.  This function will realloc the
4104 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4105 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4106 See C<sv_usepvn_mg>.
4107
4108 =cut
4109 */
4110
4111 void
4112 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4113 {
4114     SV_CHECK_THINKFIRST(sv);
4115     (void)SvUPGRADE(sv, SVt_PV);
4116     if (!ptr) {
4117         (void)SvOK_off(sv);
4118         return;
4119     }
4120     (void)SvOOK_off(sv);
4121     if (SvPVX(sv) && SvLEN(sv))
4122         Safefree(SvPVX(sv));
4123     Renew(ptr, len+1, char);
4124     SvPVX(sv) = ptr;
4125     SvCUR_set(sv, len);
4126     SvLEN_set(sv, len+1);
4127     *SvEND(sv) = '\0';
4128     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4129     SvTAINT(sv);
4130 }
4131
4132 /*
4133 =for apidoc sv_usepvn_mg
4134
4135 Like C<sv_usepvn>, but also handles 'set' magic.
4136
4137 =cut
4138 */
4139
4140 void
4141 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4142 {
4143     sv_usepvn(sv,ptr,len);
4144     SvSETMAGIC(sv);
4145 }
4146
4147 /*
4148 =for apidoc sv_force_normal_flags
4149
4150 Undo various types of fakery on an SV: if the PV is a shared string, make
4151 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4152 an xpvmg. The C<flags> parameter gets passed to  C<sv_unref_flags()>
4153 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
4154
4155 =cut
4156 */
4157
4158 void
4159 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4160 {
4161     if (SvREADONLY(sv)) {
4162         if (SvFAKE(sv)) {
4163             char *pvx = SvPVX(sv);
4164             STRLEN len = SvCUR(sv);
4165             U32 hash   = SvUVX(sv);
4166             SvGROW(sv, len + 1);
4167             Move(pvx,SvPVX(sv),len,char);
4168             *SvEND(sv) = '\0';
4169             SvFAKE_off(sv);
4170             SvREADONLY_off(sv);
4171             unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4172         }
4173         else if (PL_curcop != &PL_compiling)
4174             Perl_croak(aTHX_ PL_no_modify);
4175     }
4176     if (SvROK(sv))
4177         sv_unref_flags(sv, flags);
4178     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4179         sv_unglob(sv);
4180 }
4181
4182 /*
4183 =for apidoc sv_force_normal
4184
4185 Undo various types of fakery on an SV: if the PV is a shared string, make
4186 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4187 an xpvmg. See also C<sv_force_normal_flags>.
4188
4189 =cut
4190 */
4191
4192 void
4193 Perl_sv_force_normal(pTHX_ register SV *sv)
4194 {
4195     sv_force_normal_flags(sv, 0);
4196 }
4197
4198 /*
4199 =for apidoc sv_chop
4200
4201 Efficient removal of characters from the beginning of the string buffer.
4202 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4203 the string buffer.  The C<ptr> becomes the first character of the adjusted
4204 string. Uses the "OOK hack".
4205
4206 =cut
4207 */
4208
4209 void
4210 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4211 {
4212     register STRLEN delta;
4213
4214     if (!ptr || !SvPOKp(sv))
4215         return;
4216     SV_CHECK_THINKFIRST(sv);
4217     if (SvTYPE(sv) < SVt_PVIV)
4218         sv_upgrade(sv,SVt_PVIV);
4219
4220     if (!SvOOK(sv)) {
4221         if (!SvLEN(sv)) { /* make copy of shared string */
4222             char *pvx = SvPVX(sv);
4223             STRLEN len = SvCUR(sv);
4224             SvGROW(sv, len + 1);
4225             Move(pvx,SvPVX(sv),len,char);
4226             *SvEND(sv) = '\0';
4227         }
4228         SvIVX(sv) = 0;
4229         SvFLAGS(sv) |= SVf_OOK;
4230     }
4231     SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
4232     delta = ptr - SvPVX(sv);
4233     SvLEN(sv) -= delta;
4234     SvCUR(sv) -= delta;
4235     SvPVX(sv) += delta;
4236     SvIVX(sv) += delta;
4237 }
4238
4239 /*
4240 =for apidoc sv_catpvn
4241
4242 Concatenates the string onto the end of the string which is in the SV.  The
4243 C<len> indicates number of bytes to copy.  If the SV has the UTF8
4244 status set, then the bytes appended should be valid UTF8.
4245 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4246
4247 =cut
4248 */
4249
4250 /* sv_catpvn() is aliased to Perl_sv_catpvn_macro; this function provided
4251    for binary compatibility only
4252 */
4253 void
4254 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4255 {
4256     sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4257 }
4258
4259 /*
4260 =for apidoc sv_catpvn_flags
4261
4262 Concatenates the string onto the end of the string which is in the SV.  The
4263 C<len> indicates number of bytes to copy.  If the SV has the UTF8
4264 status set, then the bytes appended should be valid UTF8.
4265 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4266 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4267 in terms of this function.
4268
4269 =cut
4270 */
4271
4272 void
4273 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4274 {
4275     STRLEN dlen;
4276     char *dstr;
4277
4278     dstr = SvPV_force_flags(dsv, dlen, flags);
4279     SvGROW(dsv, dlen + slen + 1);
4280     if (sstr == dstr)
4281         sstr = SvPVX(dsv);
4282     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4283     SvCUR(dsv) += slen;
4284     *SvEND(dsv) = '\0';
4285     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4286     SvTAINT(dsv);
4287 }
4288
4289 /*
4290 =for apidoc sv_catpvn_mg
4291
4292 Like C<sv_catpvn>, but also handles 'set' magic.
4293
4294 =cut
4295 */
4296
4297 void
4298 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4299 {
4300     sv_catpvn(sv,ptr,len);
4301     SvSETMAGIC(sv);
4302 }
4303
4304 /*
4305 =for apidoc sv_catsv
4306
4307 Concatenates the string from SV C<ssv> onto the end of the string in
4308 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4309 not 'set' magic.  See C<sv_catsv_mg>.
4310
4311 =cut */
4312
4313 /* sv_catsv() is aliased to Perl_sv_catsv_macro; this function provided
4314    for binary compatibility only
4315 */
4316 void
4317 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4318 {
4319     sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4320 }
4321
4322 /*
4323 =for apidoc sv_catsv_flags
4324
4325 Concatenates the string from SV C<ssv> onto the end of the string in
4326 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4327 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4328 and C<sv_catsv_nomg> are implemented in terms of this function.
4329
4330 =cut */
4331
4332 void
4333 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4334 {
4335     char *spv;
4336     STRLEN slen;
4337     if (!ssv)
4338         return;
4339     if ((spv = SvPV(ssv, slen))) {
4340         /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4341             gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4342             Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4343             get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4344             dsv->sv_flags doesn't have that bit set.
4345                 Andy Dougherty  12 Oct 2001
4346         */
4347         I32 sutf8 = DO_UTF8(ssv);
4348         I32 dutf8;
4349
4350         if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4351             mg_get(dsv);
4352         dutf8 = DO_UTF8(dsv);
4353
4354         if (dutf8 != sutf8) {
4355             if (dutf8) {
4356                 /* Not modifying source SV, so taking a temporary copy. */
4357                 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4358
4359                 sv_utf8_upgrade(csv);
4360                 spv = SvPV(csv, slen);
4361             }
4362             else
4363                 sv_utf8_upgrade_nomg(dsv);
4364         }
4365         sv_catpvn_nomg(dsv, spv, slen);
4366     }
4367 }
4368
4369 /*
4370 =for apidoc sv_catsv_mg
4371
4372 Like C<sv_catsv>, but also handles 'set' magic.
4373
4374 =cut
4375 */
4376
4377 void
4378 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4379 {
4380     sv_catsv(dsv,ssv);
4381     SvSETMAGIC(dsv);
4382 }
4383
4384 /*
4385 =for apidoc sv_catpv
4386
4387 Concatenates the string onto the end of the string which is in the SV.
4388 If the SV has the UTF8 status set, then the bytes appended should be
4389 valid UTF8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4390
4391 =cut */
4392
4393 void
4394 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4395 {
4396     register STRLEN len;
4397     STRLEN tlen;
4398     char *junk;
4399
4400     if (!ptr)
4401         return;
4402     junk = SvPV_force(sv, tlen);
4403     len = strlen(ptr);
4404     SvGROW(sv, tlen + len + 1);
4405     if (ptr == junk)
4406         ptr = SvPVX(sv);
4407     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4408     SvCUR(sv) += len;
4409     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4410     SvTAINT(sv);
4411 }
4412
4413 /*
4414 =for apidoc sv_catpv_mg
4415
4416 Like C<sv_catpv>, but also handles 'set' magic.
4417
4418 =cut
4419 */
4420
4421 void
4422 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4423 {
4424     sv_catpv(sv,ptr);
4425     SvSETMAGIC(sv);
4426 }
4427
4428 /*
4429 =for apidoc newSV
4430
4431 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4432 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4433 macro.
4434
4435 =cut
4436 */
4437
4438 SV *
4439 Perl_newSV(pTHX_ STRLEN len)
4440 {
4441     register SV *sv;
4442
4443     new_SV(sv);
4444     if (len) {
4445         sv_upgrade(sv, SVt_PV);
4446         SvGROW(sv, len + 1);
4447     }
4448     return sv;
4449 }
4450 /*
4451 =for apidoc sv_magicext
4452
4453 Adds magic to an SV, upgrading it if necessary. Applies the
4454 supplied vtable and returns pointer to the magic added.
4455
4456 Note that sv_magicext will allow things that sv_magic will not.
4457 In particular you can add magic to SvREADONLY SVs and and more than
4458 one instance of the same 'how'
4459
4460 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4461 if C<namelen> is zero then C<name> is stored as-is and - as another special
4462 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4463 an C<SV*> and has its REFCNT incremented
4464
4465 (This is now used as a subroutine by sv_magic.)
4466
4467 =cut
4468 */
4469 MAGIC * 
4470 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4471                  const char* name, I32 namlen)
4472 {
4473     MAGIC* mg;
4474
4475     if (SvTYPE(sv) < SVt_PVMG) {
4476         (void)SvUPGRADE(sv, SVt_PVMG);
4477     }
4478     Newz(702,mg, 1, MAGIC);
4479     mg->mg_moremagic = SvMAGIC(sv);
4480     SvMAGIC(sv) = mg;
4481
4482     /* Some magic sontains a reference loop, where the sv and object refer to
4483        each other.  To prevent a reference loop that would prevent such
4484        objects being freed, we look for such loops and if we find one we
4485        avoid incrementing the object refcount. */
4486     if (!obj || obj == sv ||
4487         how == PERL_MAGIC_arylen ||
4488         how == PERL_MAGIC_qr ||
4489         (SvTYPE(obj) == SVt_PVGV &&
4490             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4491             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4492             GvFORM(obj) == (CV*)sv)))
4493     {
4494         mg->mg_obj = obj;
4495     }
4496     else {
4497         mg->mg_obj = SvREFCNT_inc(obj);
4498         mg->mg_flags |= MGf_REFCOUNTED;
4499     }
4500     mg->mg_type = how;
4501     mg->mg_len = namlen;
4502     if (name) {
4503         if (namlen > 0)
4504             mg->mg_ptr = savepvn(name, namlen);
4505         else if (namlen == HEf_SVKEY)
4506             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4507         else
4508             mg->mg_ptr = (char *) name;
4509     }
4510     mg->mg_virtual = vtable;
4511
4512     mg_magical(sv);
4513     if (SvGMAGICAL(sv))
4514         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4515     return mg;
4516 }
4517
4518 /*
4519 =for apidoc sv_magic
4520
4521 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4522 then adds a new magic item of type C<how> to the head of the magic list.
4523
4524 =cut
4525 */
4526
4527 void
4528 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4529 {
4530     MAGIC* mg;
4531     MGVTBL *vtable = 0;
4532
4533     if (SvREADONLY(sv)) {
4534         if (PL_curcop != &PL_compiling
4535             && how != PERL_MAGIC_regex_global
4536             && how != PERL_MAGIC_bm
4537             && how != PERL_MAGIC_fm
4538             && how != PERL_MAGIC_sv
4539            )
4540         {
4541             Perl_croak(aTHX_ PL_no_modify);
4542         }
4543     }
4544     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4545         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4546             /* sv_magic() refuses to add a magic of the same 'how' as an
4547                existing one
4548              */
4549             if (how == PERL_MAGIC_taint)
4550                 mg->mg_len |= 1;
4551             return;
4552         }
4553     }
4554
4555     switch (how) {
4556     case PERL_MAGIC_sv:
4557         vtable = &PL_vtbl_sv;
4558         break;
4559     case PERL_MAGIC_overload:
4560         vtable = &PL_vtbl_amagic;
4561         break;
4562     case PERL_MAGIC_overload_elem:
4563         vtable = &PL_vtbl_amagicelem;
4564         break;
4565     case PERL_MAGIC_overload_table:
4566         vtable = &PL_vtbl_ovrld;
4567         break;
4568     case PERL_MAGIC_bm:
4569         vtable = &PL_vtbl_bm;
4570         break;
4571     case PERL_MAGIC_regdata:
4572         vtable = &PL_vtbl_regdata;
4573         break;
4574     case PERL_MAGIC_regdatum:
4575         vtable = &PL_vtbl_regdatum;
4576         break;
4577     case PERL_MAGIC_env:
4578         vtable = &PL_vtbl_env;
4579         break;
4580     case PERL_MAGIC_fm:
4581         vtable = &PL_vtbl_fm;
4582         break;
4583     case PERL_MAGIC_envelem:
4584         vtable = &PL_vtbl_envelem;
4585         break;
4586     case PERL_MAGIC_regex_global:
4587         vtable = &PL_vtbl_mglob;
4588         break;
4589     case PERL_MAGIC_isa:
4590         vtable = &PL_vtbl_isa;
4591         break;
4592     case PERL_MAGIC_isaelem:
4593         vtable = &PL_vtbl_isaelem;
4594         break;
4595     case PERL_MAGIC_nkeys:
4596         vtable = &PL_vtbl_nkeys;
4597         break;
4598     case PERL_MAGIC_dbfile:
4599         vtable = 0;
4600         break;
4601     case PERL_MAGIC_dbline:
4602         vtable = &PL_vtbl_dbline;
4603         break;
4604 #ifdef USE_5005THREADS
4605     case PERL_MAGIC_mutex:
4606         vtable = &PL_vtbl_mutex;
4607         break;
4608 #endif /* USE_5005THREADS */
4609 #ifdef USE_LOCALE_COLLATE
4610     case PERL_MAGIC_collxfrm:
4611         vtable = &PL_vtbl_collxfrm;
4612         break;
4613 #endif /* USE_LOCALE_COLLATE */
4614     case PERL_MAGIC_tied:
4615         vtable = &PL_vtbl_pack;
4616         break;
4617     case PERL_MAGIC_tiedelem:
4618     case PERL_MAGIC_tiedscalar:
4619         vtable = &PL_vtbl_packelem;
4620         break;
4621     case PERL_MAGIC_qr:
4622         vtable = &PL_vtbl_regexp;
4623         break;
4624     case PERL_MAGIC_sig:
4625         vtable = &PL_vtbl_sig;
4626         break;
4627     case PERL_MAGIC_sigelem:
4628         vtable = &PL_vtbl_sigelem;
4629         break;
4630     case PERL_MAGIC_taint:
4631         vtable = &PL_vtbl_taint;
4632         break;
4633     case PERL_MAGIC_uvar:
4634         vtable = &PL_vtbl_uvar;
4635         break;
4636     case PERL_MAGIC_vec:
4637         vtable = &PL_vtbl_vec;
4638         break;
4639     case PERL_MAGIC_substr:
4640         vtable = &PL_vtbl_substr;
4641         break;
4642     case PERL_MAGIC_defelem:
4643         vtable = &PL_vtbl_defelem;
4644         break;
4645     case PERL_MAGIC_glob:
4646         vtable = &PL_vtbl_glob;
4647         break;
4648     case PERL_MAGIC_arylen:
4649         vtable = &PL_vtbl_arylen;
4650         break;
4651     case PERL_MAGIC_pos:
4652         vtable = &PL_vtbl_pos;
4653         break;
4654     case PERL_MAGIC_backref:
4655         vtable = &PL_vtbl_backref;
4656         break;
4657     case PERL_MAGIC_ext:
4658         /* Reserved for use by extensions not perl internals.           */
4659         /* Useful for attaching extension internal data to perl vars.   */
4660         /* Note that multiple extensions may clash if magical scalars   */
4661         /* etc holding private data from one are passed to another.     */
4662         break;
4663     default:
4664         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4665     }
4666
4667     /* Rest of work is done else where */
4668     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4669
4670     switch (how) {
4671     case PERL_MAGIC_taint:
4672         mg->mg_len = 1;
4673         break;
4674     case PERL_MAGIC_ext:
4675     case PERL_MAGIC_dbfile:
4676         SvRMAGICAL_on(sv);
4677         break;
4678     }
4679 }
4680
4681 /*
4682 =for apidoc sv_unmagic
4683
4684 Removes all magic of type C<type> from an SV.
4685
4686 =cut
4687 */
4688
4689 int
4690 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4691 {
4692     MAGIC* mg;
4693     MAGIC** mgp;
4694     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4695         return 0;
4696     mgp = &SvMAGIC(sv);
4697     for (mg = *mgp; mg; mg = *mgp) {
4698         if (mg->mg_type == type) {
4699             MGVTBL* vtbl = mg->mg_virtual;
4700             *mgp = mg->mg_moremagic;
4701             if (vtbl && vtbl->svt_free)
4702                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4703             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4704                 if (mg->mg_len > 0)
4705                     Safefree(mg->mg_ptr);
4706                 else if (mg->mg_len == HEf_SVKEY)
4707                     SvREFCNT_dec((SV*)mg->mg_ptr);
4708             }
4709             if (mg->mg_flags & MGf_REFCOUNTED)
4710                 SvREFCNT_dec(mg->mg_obj);
4711             Safefree(mg);
4712         }
4713         else
4714             mgp = &mg->mg_moremagic;
4715     }
4716     if (!SvMAGIC(sv)) {
4717         SvMAGICAL_off(sv);
4718        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4719     }
4720
4721     return 0;
4722 }
4723
4724 /*
4725 =for apidoc sv_rvweaken
4726
4727 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4728 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4729 push a back-reference to this RV onto the array of backreferences
4730 associated with that magic.
4731
4732 =cut
4733 */
4734
4735 SV *
4736 Perl_sv_rvweaken(pTHX_ SV *sv)
4737 {
4738     SV *tsv;
4739     if (!SvOK(sv))  /* let undefs pass */
4740         return sv;
4741     if (!SvROK(sv))
4742         Perl_croak(aTHX_ "Can't weaken a nonreference");
4743     else if (SvWEAKREF(sv)) {
4744         if (ckWARN(WARN_MISC))
4745             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4746         return sv;
4747     }
4748     tsv = SvRV(sv);
4749     sv_add_backref(tsv, sv);
4750     SvWEAKREF_on(sv);
4751     SvREFCNT_dec(tsv);
4752     return sv;
4753 }
4754
4755 /* Give tsv backref magic if it hasn't already got it, then push a
4756  * back-reference to sv onto the array associated with the backref magic.
4757  */
4758
4759 STATIC void
4760 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4761 {
4762     AV *av;
4763     MAGIC *mg;
4764     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4765         av = (AV*)mg->mg_obj;
4766     else {
4767         av = newAV();
4768         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4769         SvREFCNT_dec(av);           /* for sv_magic */
4770     }
4771     av_push(av,sv);
4772 }
4773
4774 /* delete a back-reference to ourselves from the backref magic associated
4775  * with the SV we point to.
4776  */
4777
4778 STATIC void
4779 S_sv_del_backref(pTHX_ SV *sv)
4780 {
4781     AV *av;
4782     SV **svp;
4783     I32 i;
4784     SV *tsv = SvRV(sv);
4785     MAGIC *mg = NULL;
4786     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4787         Perl_croak(aTHX_ "panic: del_backref");
4788     av = (AV *)mg->mg_obj;
4789     svp = AvARRAY(av);
4790     i = AvFILLp(av);
4791     while (i >= 0) {
4792         if (svp[i] == sv) {
4793             svp[i] = &PL_sv_undef; /* XXX */
4794         }
4795         i--;
4796     }
4797 }
4798
4799 /*
4800 =for apidoc sv_insert
4801
4802 Inserts a string at the specified offset/length within the SV. Similar to
4803 the Perl substr() function.
4804
4805 =cut
4806 */
4807
4808 void
4809 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4810 {
4811     register char *big;
4812     register char *mid;
4813     register char *midend;
4814     register char *bigend;
4815     register I32 i;
4816     STRLEN curlen;
4817
4818
4819     if (!bigstr)
4820         Perl_croak(aTHX_ "Can't modify non-existent substring");
4821     SvPV_force(bigstr, curlen);
4822     (void)SvPOK_only_UTF8(bigstr);
4823     if (offset + len > curlen) {
4824         SvGROW(bigstr, offset+len+1);
4825         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4826         SvCUR_set(bigstr, offset+len);
4827     }
4828
4829     SvTAINT(bigstr);
4830     i = littlelen - len;
4831     if (i > 0) {                        /* string might grow */
4832         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4833         mid = big + offset + len;
4834         midend = bigend = big + SvCUR(bigstr);
4835         bigend += i;
4836         *bigend = '\0';
4837         while (midend > mid)            /* shove everything down */
4838             *--bigend = *--midend;
4839         Move(little,big+offset,littlelen,char);
4840         SvCUR(bigstr) += i;
4841         SvSETMAGIC(bigstr);
4842         return;
4843     }
4844     else if (i == 0) {
4845         Move(little,SvPVX(bigstr)+offset,len,char);
4846         SvSETMAGIC(bigstr);
4847         return;
4848     }
4849
4850     big = SvPVX(bigstr);
4851     mid = big + offset;
4852     midend = mid + len;
4853     bigend = big + SvCUR(bigstr);
4854
4855     if (midend > bigend)
4856         Perl_croak(aTHX_ "panic: sv_insert");
4857
4858     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4859         if (littlelen) {
4860             Move(little, mid, littlelen,char);
4861             mid += littlelen;
4862         }
4863         i = bigend - midend;
4864         if (i > 0) {
4865             Move(midend, mid, i,char);
4866             mid += i;
4867         }
4868         *mid = '\0';
4869         SvCUR_set(bigstr, mid - big);
4870     }
4871     /*SUPPRESS 560*/
4872     else if ((i = mid - big)) { /* faster from front */
4873         midend -= littlelen;
4874         mid = midend;
4875         sv_chop(bigstr,midend-i);
4876         big += i;
4877         while (i--)
4878             *--midend = *--big;
4879         if (littlelen)
4880             Move(little, mid, littlelen,char);
4881     }
4882     else if (littlelen) {
4883         midend -= littlelen;
4884         sv_chop(bigstr,midend);
4885         Move(little,midend,littlelen,char);
4886     }
4887     else {
4888         sv_chop(bigstr,midend);
4889     }
4890     SvSETMAGIC(bigstr);
4891 }
4892
4893 /*
4894 =for apidoc sv_replace
4895
4896 Make the first argument a copy of the second, then delete the original.
4897 The target SV physically takes over ownership of the body of the source SV
4898 and inherits its flags; however, the target keeps any magic it owns,
4899 and any magic in the source is discarded.
4900 Note that this is a rather specialist SV copying operation; most of the
4901 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4902
4903 =cut
4904 */
4905
4906 void
4907 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4908 {
4909     U32 refcnt = SvREFCNT(sv);
4910     SV_CHECK_THINKFIRST(sv);
4911     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4912         Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
4913     if (SvMAGICAL(sv)) {
4914         if (SvMAGICAL(nsv))
4915             mg_free(nsv);
4916         else
4917             sv_upgrade(nsv, SVt_PVMG);
4918         SvMAGIC(nsv) = SvMAGIC(sv);
4919         SvFLAGS(nsv) |= SvMAGICAL(sv);
4920         SvMAGICAL_off(sv);
4921         SvMAGIC(sv) = 0;
4922     }
4923     SvREFCNT(sv) = 0;
4924     sv_clear(sv);
4925     assert(!SvREFCNT(sv));
4926     StructCopy(nsv,sv,SV);
4927     SvREFCNT(sv) = refcnt;
4928     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
4929     del_SV(nsv);
4930 }
4931
4932 /*
4933 =for apidoc sv_clear
4934
4935 Clear an SV: call any destructors, free up any memory used by the body,
4936 and free the body itself. The SV's head is I<not> freed, although
4937 its type is set to all 1's so that it won't inadvertently be assumed
4938 to be live during global destruction etc.
4939 This function should only be called when REFCNT is zero. Most of the time
4940 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4941 instead.
4942
4943 =cut
4944 */
4945
4946 void
4947 Perl_sv_clear(pTHX_ register SV *sv)
4948 {
4949     HV* stash;
4950     assert(sv);
4951     assert(SvREFCNT(sv) == 0);
4952
4953     if (SvOBJECT(sv)) {
4954         if (PL_defstash) {              /* Still have a symbol table? */
4955             dSP;
4956             CV* destructor;
4957             SV tmpref;
4958
4959             Zero(&tmpref, 1, SV);
4960             sv_upgrade(&tmpref, SVt_RV);
4961             SvROK_on(&tmpref);
4962             SvREADONLY_on(&tmpref);     /* DESTROY() could be naughty */
4963             SvREFCNT(&tmpref) = 1;
4964
4965             do {        
4966                 stash = SvSTASH(sv);
4967                 destructor = StashHANDLER(stash,DESTROY);
4968                 if (destructor) {
4969                     ENTER;
4970                     PUSHSTACKi(PERLSI_DESTROY);
4971                     SvRV(&tmpref) = SvREFCNT_inc(sv);
4972                     EXTEND(SP, 2);
4973                     PUSHMARK(SP);
4974                     PUSHs(&tmpref);
4975                     PUTBACK;
4976                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4977                     SvREFCNT(sv)--;
4978                     POPSTACK;
4979                     SPAGAIN;
4980                     LEAVE;
4981                 }
4982             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4983
4984             del_XRV(SvANY(&tmpref));
4985
4986             if (SvREFCNT(sv)) {
4987                 if (PL_in_clean_objs)
4988                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4989                           HvNAME(stash));
4990                 /* DESTROY gave object new lease on life */
4991                 return;
4992             }
4993         }
4994
4995         if (SvOBJECT(sv)) {
4996             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
4997             SvOBJECT_off(sv);   /* Curse the object. */
4998             if (SvTYPE(sv) != SVt_PVIO)
4999                 --PL_sv_objcount;       /* XXX Might want something more general */
5000         }
5001     }
5002     if (SvTYPE(sv) >= SVt_PVMG) {
5003         if (SvMAGIC(sv))
5004             mg_free(sv);
5005         if (SvFLAGS(sv) & SVpad_TYPED)
5006             SvREFCNT_dec(SvSTASH(sv));
5007     }
5008     stash = NULL;
5009     switch (SvTYPE(sv)) {
5010     case SVt_PVIO:
5011         if (IoIFP(sv) &&
5012             IoIFP(sv) != PerlIO_stdin() &&
5013             IoIFP(sv) != PerlIO_stdout() &&
5014             IoIFP(sv) != PerlIO_stderr())
5015         {
5016             io_close((IO*)sv, FALSE);
5017         }
5018         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5019             PerlDir_close(IoDIRP(sv));
5020         IoDIRP(sv) = (DIR*)NULL;
5021         Safefree(IoTOP_NAME(sv));
5022         Safefree(IoFMT_NAME(sv));
5023         Safefree(IoBOTTOM_NAME(sv));
5024         /* FALL THROUGH */
5025     case SVt_PVBM:
5026         goto freescalar;
5027     case SVt_PVCV:
5028     case SVt_PVFM:
5029         cv_undef((CV*)sv);
5030         goto freescalar;
5031     case SVt_PVHV:
5032         hv_undef((HV*)sv);
5033         break;
5034     case SVt_PVAV:
5035         av_undef((AV*)sv);
5036         break;
5037     case SVt_PVLV:
5038         SvREFCNT_dec(LvTARG(sv));
5039         goto freescalar;
5040     case SVt_PVGV:
5041         gp_free((GV*)sv);
5042         Safefree(GvNAME(sv));
5043         /* cannot decrease stash refcount yet, as we might recursively delete
5044            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5045            of stash until current sv is completely gone.
5046            -- JohnPC, 27 Mar 1998 */
5047         stash = GvSTASH(sv);
5048         /* FALL THROUGH */
5049     case SVt_PVMG:
5050     case SVt_PVNV:
5051     case SVt_PVIV:
5052       freescalar:
5053         (void)SvOOK_off(sv);
5054         /* FALL THROUGH */
5055     case SVt_PV:
5056     case SVt_RV:
5057         if (SvROK(sv)) {
5058             if (SvWEAKREF(sv))
5059                 sv_del_backref(sv);
5060             else
5061                 SvREFCNT_dec(SvRV(sv));
5062         }
5063         else if (SvPVX(sv) && SvLEN(sv))
5064             Safefree(SvPVX(sv));
5065         else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5066             unsharepvn(SvPVX(sv),
5067                        SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5068                        SvUVX(sv));
5069             SvFAKE_off(sv);
5070         }
5071         break;
5072 /*
5073     case SVt_NV:
5074     case SVt_IV:
5075     case SVt_NULL:
5076         break;
5077 */
5078     }
5079
5080     switch (SvTYPE(sv)) {
5081     case SVt_NULL:
5082         break;
5083     case SVt_IV:
5084         del_XIV(SvANY(sv));
5085         break;
5086     case SVt_NV:
5087         del_XNV(SvANY(sv));
5088         break;
5089     case SVt_RV:
5090         del_XRV(SvANY(sv));
5091         break;
5092     case SVt_PV:
5093         del_XPV(SvANY(sv));
5094         break;
5095     case SVt_PVIV:
5096         del_XPVIV(SvANY(sv));
5097         break;
5098     case SVt_PVNV:
5099         del_XPVNV(SvANY(sv));
5100         break;
5101     case SVt_PVMG:
5102         del_XPVMG(SvANY(sv));
5103         break;
5104     case SVt_PVLV:
5105         del_XPVLV(SvANY(sv));
5106         break;
5107     case SVt_PVAV:
5108         del_XPVAV(SvANY(sv));
5109         break;
5110     case SVt_PVHV:
5111         del_XPVHV(SvANY(sv));
5112         break;
5113     case SVt_PVCV:
5114         del_XPVCV(SvANY(sv));
5115         break;
5116     case SVt_PVGV:
5117         del_XPVGV(SvANY(sv));
5118         /* code duplication for increased performance. */
5119         SvFLAGS(sv) &= SVf_BREAK;
5120         SvFLAGS(sv) |= SVTYPEMASK;
5121         /* decrease refcount of the stash that owns this GV, if any */
5122         if (stash)
5123             SvREFCNT_dec(stash);
5124         return; /* not break, SvFLAGS reset already happened */
5125     case SVt_PVBM:
5126         del_XPVBM(SvANY(sv));
5127         break;
5128     case SVt_PVFM:
5129         del_XPVFM(SvANY(sv));
5130         break;
5131     case SVt_PVIO:
5132         del_XPVIO(SvANY(sv));
5133         break;
5134     }
5135     SvFLAGS(sv) &= SVf_BREAK;
5136     SvFLAGS(sv) |= SVTYPEMASK;
5137 }
5138
5139 /*
5140 =for apidoc sv_newref
5141
5142 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5143 instead.
5144
5145 =cut
5146 */
5147
5148 SV *
5149 Perl_sv_newref(pTHX_ SV *sv)
5150 {
5151     if (sv)
5152         ATOMIC_INC(SvREFCNT(sv));
5153     return sv;
5154 }
5155
5156 /*
5157 =for apidoc sv_free
5158
5159 Decrement an SV's reference count, and if it drops to zero, call
5160 C<sv_clear> to invoke destructors and free up any memory used by
5161 the body; finally, deallocate the SV's head itself.
5162 Normally called via a wrapper macro C<SvREFCNT_dec>.
5163
5164 =cut
5165 */
5166
5167 void
5168 Perl_sv_free(pTHX_ SV *sv)
5169 {
5170     int refcount_is_zero;
5171
5172     if (!sv)
5173         return;
5174     if (SvREFCNT(sv) == 0) {
5175         if (SvFLAGS(sv) & SVf_BREAK)
5176             /* this SV's refcnt has been artificially decremented to
5177              * trigger cleanup */
5178             return;
5179         if (PL_in_clean_all) /* All is fair */
5180             return;
5181         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5182             /* make sure SvREFCNT(sv)==0 happens very seldom */
5183             SvREFCNT(sv) = (~(U32)0)/2;
5184             return;
5185         }
5186         if (ckWARN_d(WARN_INTERNAL))
5187             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5188         return;
5189     }
5190     ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5191     if (!refcount_is_zero)
5192         return;
5193 #ifdef DEBUGGING
5194     if (SvTEMP(sv)) {
5195         if (ckWARN_d(WARN_DEBUGGING))
5196             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5197                         "Attempt to free temp prematurely: SV 0x%"UVxf,
5198                         PTR2UV(sv));
5199         return;
5200     }
5201 #endif
5202     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5203         /* make sure SvREFCNT(sv)==0 happens very seldom */
5204         SvREFCNT(sv) = (~(U32)0)/2;
5205         return;
5206     }
5207     sv_clear(sv);
5208     if (! SvREFCNT(sv))
5209         del_SV(sv);
5210 }
5211
5212 /*
5213 =for apidoc sv_len
5214
5215 Returns the length of the string in the SV. Handles magic and type
5216 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5217
5218 =cut
5219 */
5220
5221 STRLEN
5222 Perl_sv_len(pTHX_ register SV *sv)
5223 {
5224     STRLEN len;
5225
5226     if (!sv)
5227         return 0;
5228
5229     if (SvGMAGICAL(sv))
5230         len = mg_length(sv);
5231     else
5232         (void)SvPV(sv, len);
5233     return len;
5234 }
5235
5236 /*
5237 =for apidoc sv_len_utf8
5238
5239 Returns the number of characters in the string in an SV, counting wide
5240 UTF8 bytes as a single character. Handles magic and type coercion.
5241
5242 =cut
5243 */
5244
5245 STRLEN
5246 Perl_sv_len_utf8(pTHX_ register SV *sv)
5247 {
5248     if (!sv)
5249         return 0;
5250
5251     if (SvGMAGICAL(sv))
5252         return mg_length(sv);
5253     else
5254     {
5255         STRLEN len;
5256         U8 *s = (U8*)SvPV(sv, len);
5257
5258         return Perl_utf8_length(aTHX_ s, s + len);
5259     }
5260 }
5261
5262 /*
5263 =for apidoc sv_pos_u2b
5264
5265 Converts the value pointed to by offsetp from a count of UTF8 chars from
5266 the start of the string, to a count of the equivalent number of bytes; if
5267 lenp is non-zero, it does the same to lenp, but this time starting from
5268 the offset, rather than from the start of the string. Handles magic and
5269 type coercion.
5270
5271 =cut
5272 */
5273
5274 void
5275 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5276 {
5277     U8 *start;
5278     U8 *s;
5279     U8 *send;
5280     I32 uoffset = *offsetp;
5281     STRLEN len;
5282
5283     if (!sv)
5284         return;
5285
5286     start = s = (U8*)SvPV(sv, len);
5287     send = s + len;
5288     while (s < send && uoffset--)
5289         s += UTF8SKIP(s);
5290     if (s >= send)
5291         s = send;
5292     *offsetp = s - start;
5293     if (lenp) {
5294         I32 ulen = *lenp;
5295         start = s;
5296         while (s < send && ulen--)
5297             s += UTF8SKIP(s);
5298         if (s >= send)
5299             s = send;
5300         *lenp = s - start;
5301     }
5302     return;
5303 }
5304
5305 /*
5306 =for apidoc sv_pos_b2u
5307
5308 Converts the value pointed to by offsetp from a count of bytes from the
5309 start of the string, to a count of the equivalent number of UTF8 chars.
5310 Handles magic and type coercion.
5311
5312 =cut
5313 */
5314
5315 void
5316 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
5317 {
5318     U8 *s;
5319     U8 *send;
5320     STRLEN len;
5321
5322     if (!sv)
5323         return;
5324
5325     s = (U8*)SvPV(sv, len);
5326     if (len < *offsetp)
5327         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5328     send = s + *offsetp;
5329     len = 0;
5330     while (s < send) {
5331         STRLEN n;
5332         /* Call utf8n_to_uvchr() to validate the sequence */
5333         utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5334         if (n > 0) {
5335             s += n;
5336             len++;
5337         }
5338         else
5339             break;
5340     }
5341     *offsetp = len;
5342     return;
5343 }
5344
5345 /*
5346 =for apidoc sv_eq
5347
5348 Returns a boolean indicating whether the strings in the two SVs are
5349 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5350 coerce its args to strings if necessary.
5351
5352 =cut
5353 */
5354
5355 I32
5356 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5357 {
5358     char *pv1;
5359     STRLEN cur1;
5360     char *pv2;
5361     STRLEN cur2;
5362     I32  eq     = 0;
5363     char *tpv   = Nullch;
5364     SV* svrecode = Nullsv;
5365
5366     if (!sv1) {
5367         pv1 = "";
5368         cur1 = 0;
5369     }
5370     else
5371         pv1 = SvPV(sv1, cur1);
5372
5373     if (!sv2){
5374         pv2 = "";
5375         cur2 = 0;
5376     }
5377     else
5378         pv2 = SvPV(sv2, cur2);
5379
5380     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5381         /* Differing utf8ness.
5382          * Do not UTF8size the comparands as a side-effect. */
5383          if (PL_encoding) {
5384               if (SvUTF8(sv1)) {
5385                    svrecode = newSVpvn(pv2, cur2);
5386                    sv_recode_to_utf8(svrecode, PL_encoding);
5387                    pv2 = SvPV(svrecode, cur2);
5388               }
5389               else {
5390                    svrecode = newSVpvn(pv1, cur1);
5391                    sv_recode_to_utf8(svrecode, PL_encoding);
5392                    pv1 = SvPV(svrecode, cur1);
5393               }
5394               /* Now both are in UTF-8. */
5395               if (cur1 != cur2)
5396                    return FALSE;
5397          }
5398          else {
5399               bool is_utf8 = TRUE;
5400
5401               if (SvUTF8(sv1)) {
5402                    /* sv1 is the UTF-8 one,
5403                     * if is equal it must be downgrade-able */
5404                    char *pv = (char*)bytes_from_utf8((U8*)pv1,
5405                                                      &cur1, &is_utf8);
5406                    if (pv != pv1)
5407                         pv1 = tpv = pv;
5408               }
5409               else {
5410                    /* sv2 is the UTF-8 one,
5411                     * if is equal it must be downgrade-able */
5412                    char *pv = (char *)bytes_from_utf8((U8*)pv2,
5413                                                       &cur2, &is_utf8);
5414                    if (pv != pv2)
5415                         pv2 = tpv = pv;
5416               }
5417               if (is_utf8) {
5418                    /* Downgrade not possible - cannot be eq */
5419                    return FALSE;
5420               }
5421          }
5422     }
5423
5424     if (cur1 == cur2)
5425         eq = memEQ(pv1, pv2, cur1);
5426         
5427     if (svrecode)
5428          SvREFCNT_dec(svrecode);
5429
5430     if (tpv)
5431         Safefree(tpv);
5432
5433     return eq;
5434 }
5435
5436 /*
5437 =for apidoc sv_cmp
5438
5439 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
5440 string in C<sv1> is less than, equal to, or greater than the string in
5441 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5442 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
5443
5444 =cut
5445 */
5446
5447 I32
5448 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5449 {
5450     STRLEN cur1, cur2;
5451     char *pv1, *pv2, *tpv = Nullch;
5452     I32  cmp;
5453     SV *svrecode = Nullsv;
5454
5455     if (!sv1) {
5456         pv1 = "";
5457         cur1 = 0;
5458     }
5459     else
5460         pv1 = SvPV(sv1, cur1);
5461
5462     if (!sv2) {
5463         pv2 = "";
5464         cur2 = 0;
5465     }
5466     else
5467         pv2 = SvPV(sv2, cur2);
5468
5469     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5470         /* Differing utf8ness.
5471          * Do not UTF8size the comparands as a side-effect. */
5472         if (SvUTF8(sv1)) {
5473             if (PL_encoding) {
5474                  svrecode = newSVpvn(pv2, cur2);
5475                  sv_recode_to_utf8(svrecode, PL_encoding);
5476                  pv2 = SvPV(svrecode, cur2);
5477             }
5478             else {
5479                  pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5480             }
5481         }
5482         else {
5483             if (PL_encoding) {
5484                  svrecode = newSVpvn(pv1, cur1);
5485                  sv_recode_to_utf8(svrecode, PL_encoding);
5486                  pv1 = SvPV(svrecode, cur1);
5487             }
5488             else {
5489                  pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5490             }
5491         }
5492     }
5493
5494     if (!cur1) {
5495         cmp = cur2 ? -1 : 0;
5496     } else if (!cur2) {
5497         cmp = 1;
5498     } else {
5499         I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
5500
5501         if (retval) {
5502             cmp = retval < 0 ? -1 : 1;
5503         } else if (cur1 == cur2) {
5504             cmp = 0;
5505         } else {
5506             cmp = cur1 < cur2 ? -1 : 1;
5507         }
5508     }
5509
5510     if (svrecode)
5511          SvREFCNT_dec(svrecode);
5512
5513     if (tpv)
5514         Safefree(tpv);
5515
5516     return cmp;
5517 }
5518
5519 /*
5520 =for apidoc sv_cmp_locale
5521
5522 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5523 'use bytes' aware, handles get magic, and will coerce its args to strings
5524 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
5525
5526 =cut
5527 */
5528
5529 I32
5530 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5531 {
5532 #ifdef USE_LOCALE_COLLATE
5533
5534     char *pv1, *pv2;
5535     STRLEN len1, len2;
5536     I32 retval;
5537
5538     if (PL_collation_standard)
5539         goto raw_compare;
5540
5541     len1 = 0;
5542     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5543     len2 = 0;
5544     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5545
5546     if (!pv1 || !len1) {
5547         if (pv2 && len2)
5548             return -1;
5549         else
5550             goto raw_compare;
5551     }
5552     else {
5553         if (!pv2 || !len2)
5554             return 1;
5555     }
5556
5557     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5558
5559     if (retval)
5560         return retval < 0 ? -1 : 1;
5561
5562     /*
5563      * When the result of collation is equality, that doesn't mean
5564      * that there are no differences -- some locales exclude some
5565      * characters from consideration.  So to avoid false equalities,
5566      * we use the raw string as a tiebreaker.
5567      */
5568
5569   raw_compare:
5570     /* FALL THROUGH */
5571
5572 #endif /* USE_LOCALE_COLLATE */
5573
5574     return sv_cmp(sv1, sv2);
5575 }
5576
5577
5578 #ifdef USE_LOCALE_COLLATE
5579
5580 /*
5581 =for apidoc sv_collxfrm
5582
5583 Add Collate Transform magic to an SV if it doesn't already have it.
5584
5585 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5586 scalar data of the variable, but transformed to such a format that a normal
5587 memory comparison can be used to compare the data according to the locale
5588 settings.
5589
5590 =cut
5591 */
5592
5593 char *
5594 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5595 {
5596     MAGIC *mg;
5597
5598     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5599     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5600         char *s, *xf;
5601         STRLEN len, xlen;
5602
5603         if (mg)
5604             Safefree(mg->mg_ptr);
5605         s = SvPV(sv, len);
5606         if ((xf = mem_collxfrm(s, len, &xlen))) {
5607             if (SvREADONLY(sv)) {
5608                 SAVEFREEPV(xf);
5609                 *nxp = xlen;
5610                 return xf + sizeof(PL_collation_ix);
5611             }
5612             if (! mg) {
5613                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5614                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5615                 assert(mg);
5616             }
5617             mg->mg_ptr = xf;
5618             mg->mg_len = xlen;
5619         }
5620         else {
5621             if (mg) {
5622                 mg->mg_ptr = NULL;
5623                 mg->mg_len = -1;
5624             }
5625         }
5626     }
5627     if (mg && mg->mg_ptr) {
5628         *nxp = mg->mg_len;
5629         return mg->mg_ptr + sizeof(PL_collation_ix);
5630     }
5631     else {
5632         *nxp = 0;
5633         return NULL;
5634     }
5635 }
5636
5637 #endif /* USE_LOCALE_COLLATE */
5638
5639 /*
5640 =for apidoc sv_gets
5641
5642 Get a line from the filehandle and store it into the SV, optionally
5643 appending to the currently-stored string.
5644
5645 =cut
5646 */
5647
5648 char *
5649 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5650 {
5651     char *rsptr;
5652     STRLEN rslen;
5653     register STDCHAR rslast;
5654     register STDCHAR *bp;
5655     register I32 cnt;
5656     I32 i = 0;
5657     I32 rspara = 0;
5658
5659     SV_CHECK_THINKFIRST(sv);
5660     (void)SvUPGRADE(sv, SVt_PV);
5661
5662     SvSCREAM_off(sv);
5663
5664     if (PL_curcop == &PL_compiling) {
5665         /* we always read code in line mode */
5666         rsptr = "\n";
5667         rslen = 1;
5668     }
5669     else if (RsSNARF(PL_rs)) {
5670         rsptr = NULL;
5671         rslen = 0;
5672     }
5673     else if (RsRECORD(PL_rs)) {
5674       I32 recsize, bytesread;
5675       char *buffer;
5676
5677       /* Grab the size of the record we're getting */
5678       recsize = SvIV(SvRV(PL_rs));
5679       (void)SvPOK_only(sv);    /* Validate pointer */
5680       buffer = SvGROW(sv, recsize + 1);
5681       /* Go yank in */
5682 #ifdef VMS
5683       /* VMS wants read instead of fread, because fread doesn't respect */
5684       /* RMS record boundaries. This is not necessarily a good thing to be */
5685       /* doing, but we've got no other real choice */
5686       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5687 #else
5688       bytesread = PerlIO_read(fp, buffer, recsize);
5689 #endif
5690       SvCUR_set(sv, bytesread);
5691       buffer[bytesread] = '\0';
5692       if (PerlIO_isutf8(fp))
5693         SvUTF8_on(sv);
5694       else
5695         SvUTF8_off(sv);
5696       return(SvCUR(sv) ? SvPVX(sv) : Nullch);
5697     }
5698     else if (RsPARA(PL_rs)) {
5699         rsptr = "\n\n";
5700         rslen = 2;
5701         rspara = 1;
5702     }
5703     else {
5704         /* Get $/ i.e. PL_rs into same encoding as stream wants */
5705         if (PerlIO_isutf8(fp)) {
5706             rsptr = SvPVutf8(PL_rs, rslen);
5707         }
5708         else {
5709             if (SvUTF8(PL_rs)) {
5710                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5711                     Perl_croak(aTHX_ "Wide character in $/");
5712                 }
5713             }
5714             rsptr = SvPV(PL_rs, rslen);
5715         }
5716     }
5717
5718     rslast = rslen ? rsptr[rslen - 1] : '\0';
5719
5720     if (rspara) {               /* have to do this both before and after */
5721         do {                    /* to make sure file boundaries work right */
5722             if (PerlIO_eof(fp))
5723                 return 0;
5724             i = PerlIO_getc(fp);
5725             if (i != '\n') {
5726                 if (i == -1)
5727                     return 0;
5728                 PerlIO_ungetc(fp,i);
5729                 break;
5730             }
5731         } while (i != EOF);
5732     }
5733
5734     /* See if we know enough about I/O mechanism to cheat it ! */
5735
5736     /* This used to be #ifdef test - it is made run-time test for ease
5737        of abstracting out stdio interface. One call should be cheap
5738        enough here - and may even be a macro allowing compile
5739        time optimization.
5740      */
5741
5742     if (PerlIO_fast_gets(fp)) {
5743
5744     /*
5745      * We're going to steal some values from the stdio struct
5746      * and put EVERYTHING in the innermost loop into registers.
5747      */
5748     register STDCHAR *ptr;
5749     STRLEN bpx;
5750     I32 shortbuffered;
5751
5752 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5753     /* An ungetc()d char is handled separately from the regular
5754      * buffer, so we getc() it back out and stuff it in the buffer.
5755      */
5756     i = PerlIO_getc(fp);
5757     if (i == EOF) return 0;
5758     *(--((*fp)->_ptr)) = (unsigned char) i;
5759     (*fp)->_cnt++;
5760 #endif
5761
5762     /* Here is some breathtakingly efficient cheating */
5763
5764     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
5765     (void)SvPOK_only(sv);               /* validate pointer */
5766     if (SvLEN(sv) - append <= cnt + 1) { /* make sure we have the room */
5767         if (cnt > 80 && SvLEN(sv) > append) {
5768             shortbuffered = cnt - SvLEN(sv) + append + 1;
5769             cnt -= shortbuffered;
5770         }
5771         else {
5772             shortbuffered = 0;
5773             /* remember that cnt can be negative */
5774             SvGROW(sv, append + (cnt <= 0 ? 2 : (cnt + 1)));
5775         }
5776     }
5777     else
5778         shortbuffered = 0;
5779     bp = (STDCHAR*)SvPVX(sv) + append;  /* move these two too to registers */
5780     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5781     DEBUG_P(PerlIO_printf(Perl_debug_log,
5782         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5783     DEBUG_P(PerlIO_printf(Perl_debug_log,
5784         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5785                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5786                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5787     for (;;) {
5788       screamer:
5789         if (cnt > 0) {
5790             if (rslen) {
5791                 while (cnt > 0) {                    /* this     |  eat */
5792                     cnt--;
5793                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
5794                         goto thats_all_folks;        /* screams  |  sed :-) */
5795                 }
5796             }
5797             else {
5798                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
5799                 bp += cnt;                           /* screams  |  dust */
5800                 ptr += cnt;                          /* louder   |  sed :-) */
5801                 cnt = 0;
5802             }
5803         }
5804         
5805         if (shortbuffered) {            /* oh well, must extend */
5806             cnt = shortbuffered;
5807             shortbuffered = 0;
5808             bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5809             SvCUR_set(sv, bpx);
5810             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5811             bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5812             continue;
5813         }
5814
5815         DEBUG_P(PerlIO_printf(Perl_debug_log,
5816                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5817                               PTR2UV(ptr),(long)cnt));
5818         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5819 #if 0
5820         DEBUG_P(PerlIO_printf(Perl_debug_log,
5821             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5822             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5823             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5824 #endif
5825         /* This used to call 'filbuf' in stdio form, but as that behaves like
5826            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5827            another abstraction.  */
5828         i   = PerlIO_getc(fp);          /* get more characters */
5829 #if 0
5830         DEBUG_P(PerlIO_printf(Perl_debug_log,
5831             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5832             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5833             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5834 #endif
5835         cnt = PerlIO_get_cnt(fp);
5836         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
5837         DEBUG_P(PerlIO_printf(Perl_debug_log,
5838             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5839
5840         if (i == EOF)                   /* all done for ever? */
5841             goto thats_really_all_folks;
5842
5843         bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5844         SvCUR_set(sv, bpx);
5845         SvGROW(sv, bpx + cnt + 2);
5846         bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5847
5848         *bp++ = i;                      /* store character from PerlIO_getc */
5849
5850         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
5851             goto thats_all_folks;
5852     }
5853
5854 thats_all_folks:
5855     if ((rslen > 1 && (bp - (STDCHAR*)SvPVX(sv) < rslen)) ||
5856           memNE((char*)bp - rslen, rsptr, rslen))
5857         goto screamer;                          /* go back to the fray */
5858 thats_really_all_folks:
5859     if (shortbuffered)
5860         cnt += shortbuffered;
5861         DEBUG_P(PerlIO_printf(Perl_debug_log,
5862             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5863     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
5864     DEBUG_P(PerlIO_printf(Perl_debug_log,
5865         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5866         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5867         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5868     *bp = '\0';
5869     SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv));    /* set length */
5870     DEBUG_P(PerlIO_printf(Perl_debug_log,
5871         "Screamer: done, len=%ld, string=|%.*s|\n",
5872         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
5873     }
5874    else
5875     {
5876 #ifndef EPOC
5877        /*The big, slow, and stupid way */
5878         STDCHAR buf[8192];
5879 #else
5880         /* Need to work around EPOC SDK features          */
5881         /* On WINS: MS VC5 generates calls to _chkstk,    */
5882         /* if a `large' stack frame is allocated          */
5883         /* gcc on MARM does not generate calls like these */
5884         STDCHAR buf[1024];
5885 #endif
5886
5887 screamer2:
5888         if (rslen) {
5889             register STDCHAR *bpe = buf + sizeof(buf);
5890             bp = buf;
5891             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = i) != rslast && bp < bpe)
5892                 ; /* keep reading */
5893             cnt = bp - buf;
5894         }
5895         else {
5896             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5897             /* Accomodate broken VAXC compiler, which applies U8 cast to
5898              * both args of ?: operator, causing EOF to change into 255
5899              */
5900             if (cnt) { i = (U8)buf[cnt - 1]; } else { i = EOF; }
5901         }
5902
5903         if (append)
5904             sv_catpvn(sv, (char *) buf, cnt);
5905         else
5906             sv_setpvn(sv, (char *) buf, cnt);
5907
5908         if (i != EOF &&                 /* joy */
5909             (!rslen ||
5910              SvCUR(sv) < rslen ||
5911              memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5912         {
5913             append = -1;
5914             /*
5915              * If we're reading from a TTY and we get a short read,
5916              * indicating that the user hit his EOF character, we need
5917              * to notice it now, because if we try to read from the TTY
5918              * again, the EOF condition will disappear.
5919              *
5920              * The comparison of cnt to sizeof(buf) is an optimization
5921              * that prevents unnecessary calls to feof().
5922              *
5923              * - jik 9/25/96
5924              */
5925             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5926                 goto screamer2;
5927         }
5928     }
5929
5930     if (rspara) {               /* have to do this both before and after */
5931         while (i != EOF) {      /* to make sure file boundaries work right */
5932             i = PerlIO_getc(fp);
5933             if (i != '\n') {
5934                 PerlIO_ungetc(fp,i);
5935                 break;
5936             }
5937         }
5938     }
5939
5940     if (PerlIO_isutf8(fp))
5941         SvUTF8_on(sv);
5942     else
5943         SvUTF8_off(sv);
5944
5945     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5946 }
5947
5948 /*
5949 =for apidoc sv_inc
5950
5951 Auto-increment of the value in the SV, doing string to numeric conversion
5952 if necessary. Handles 'get' magic.
5953
5954 =cut
5955 */
5956
5957 void
5958 Perl_sv_inc(pTHX_ register SV *sv)
5959 {
5960     register char *d;
5961     int flags;
5962
5963     if (!sv)
5964         return;
5965     if (SvGMAGICAL(sv))
5966         mg_get(sv);
5967     if (SvTHINKFIRST(sv)) {
5968         if (SvREADONLY(sv) && SvFAKE(sv))
5969             sv_force_normal(sv);
5970         if (SvREADONLY(sv)) {
5971             if (PL_curcop != &PL_compiling)
5972                 Perl_croak(aTHX_ PL_no_modify);
5973         }
5974         if (SvROK(sv)) {
5975             IV i;
5976             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5977                 return;
5978             i = PTR2IV(SvRV(sv));
5979             sv_unref(sv);
5980             sv_setiv(sv, i);
5981         }
5982     }
5983     flags = SvFLAGS(sv);
5984     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5985         /* It's (privately or publicly) a float, but not tested as an
5986            integer, so test it to see. */
5987         (void) SvIV(sv);
5988         flags = SvFLAGS(sv);
5989     }
5990     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5991         /* It's publicly an integer, or privately an integer-not-float */
5992 #ifdef PERL_PRESERVE_IVUV
5993       oops_its_int:
5994 #endif
5995         if (SvIsUV(sv)) {
5996             if (SvUVX(sv) == UV_MAX)
5997                 sv_setnv(sv, UV_MAX_P1);
5998             else
5999                 (void)SvIOK_only_UV(sv);
6000                 ++SvUVX(sv);
6001         } else {
6002             if (SvIVX(sv) == IV_MAX)
6003                 sv_setuv(sv, (UV)IV_MAX + 1);
6004             else {
6005                 (void)SvIOK_only(sv);
6006                 ++SvIVX(sv);
6007             }   
6008         }
6009         return;
6010     }
6011     if (flags & SVp_NOK) {
6012         (void)SvNOK_only(sv);
6013         SvNVX(sv) += 1.0;
6014         return;
6015     }
6016
6017     if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6018         if ((flags & SVTYPEMASK) < SVt_PVIV)
6019             sv_upgrade(sv, SVt_IV);
6020         (void)SvIOK_only(sv);
6021         SvIVX(sv) = 1;
6022         return;
6023     }
6024     d = SvPVX(sv);
6025     while (isALPHA(*d)) d++;
6026     while (isDIGIT(*d)) d++;
6027     if (*d) {
6028 #ifdef PERL_PRESERVE_IVUV
6029         /* Got to punt this as an integer if needs be, but we don't issue
6030            warnings. Probably ought to make the sv_iv_please() that does
6031            the conversion if possible, and silently.  */
6032         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6033         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6034             /* Need to try really hard to see if it's an integer.
6035                9.22337203685478e+18 is an integer.
6036                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6037                so $a="9.22337203685478e+18"; $a+0; $a++
6038                needs to be the same as $a="9.22337203685478e+18"; $a++
6039                or we go insane. */
6040         
6041             (void) sv_2iv(sv);
6042             if (SvIOK(sv))
6043                 goto oops_its_int;
6044
6045             /* sv_2iv *should* have made this an NV */
6046             if (flags & SVp_NOK) {
6047                 (void)SvNOK_only(sv);
6048                 SvNVX(sv) += 1.0;
6049                 return;
6050             }
6051             /* I don't think we can get here. Maybe I should assert this
6052                And if we do get here I suspect that sv_setnv will croak. NWC
6053                Fall through. */
6054 #if defined(USE_LONG_DOUBLE)
6055             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6056                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6057 #else
6058             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6059                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6060 #endif
6061         }
6062 #endif /* PERL_PRESERVE_IVUV */
6063         sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6064         return;
6065     }
6066     d--;
6067     while (d >= SvPVX(sv)) {
6068         if (isDIGIT(*d)) {
6069             if (++*d <= '9')
6070                 return;
6071             *(d--) = '0';
6072         }
6073         else {
6074 #ifdef EBCDIC
6075             /* MKS: The original code here died if letters weren't consecutive.
6076              * at least it didn't have to worry about non-C locales.  The
6077              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6078              * arranged in order (although not consecutively) and that only
6079              * [A-Za-z] are accepted by isALPHA in the C locale.
6080              */
6081             if (*d != 'z' && *d != 'Z') {
6082                 do { ++*d; } while (!isALPHA(*d));
6083                 return;
6084             }
6085             *(d--) -= 'z' - 'a';
6086 #else
6087             ++*d;
6088             if (isALPHA(*d))
6089                 return;
6090             *(d--) -= 'z' - 'a' + 1;
6091 #endif
6092         }
6093     }
6094     /* oh,oh, the number grew */
6095     SvGROW(sv, SvCUR(sv) + 2);
6096     SvCUR(sv)++;
6097     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6098         *d = d[-1];
6099     if (isDIGIT(d[1]))
6100         *d = '1';
6101     else
6102         *d = d[1];
6103 }
6104
6105 /*
6106 =for apidoc sv_dec
6107
6108 Auto-decrement of the value in the SV, doing string to numeric conversion
6109 if necessary. Handles 'get' magic.
6110
6111 =cut
6112 */
6113
6114 void
6115 Perl_sv_dec(pTHX_ register SV *sv)
6116 {
6117     int flags;
6118
6119     if (!sv)
6120         return;
6121     if (SvGMAGICAL(sv))
6122         mg_get(sv);
6123     if (SvTHINKFIRST(sv)) {
6124         if (SvREADONLY(sv) && SvFAKE(sv))
6125             sv_force_normal(sv);
6126         if (SvREADONLY(sv)) {
6127             if (PL_curcop != &PL_compiling)
6128                 Perl_croak(aTHX_ PL_no_modify);
6129         }
6130         if (SvROK(sv)) {
6131             IV i;
6132             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6133                 return;
6134             i = PTR2IV(SvRV(sv));
6135             sv_unref(sv);
6136             sv_setiv(sv, i);
6137         }
6138     }
6139     /* Unlike sv_inc we don't have to worry about string-never-numbers
6140        and keeping them magic. But we mustn't warn on punting */
6141     flags = SvFLAGS(sv);
6142     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6143         /* It's publicly an integer, or privately an integer-not-float */
6144 #ifdef PERL_PRESERVE_IVUV
6145       oops_its_int:
6146 #endif
6147         if (SvIsUV(sv)) {
6148             if (SvUVX(sv) == 0) {
6149                 (void)SvIOK_only(sv);
6150                 SvIVX(sv) = -1;
6151             }
6152             else {
6153                 (void)SvIOK_only_UV(sv);
6154                 --SvUVX(sv);
6155             }   
6156         } else {
6157             if (SvIVX(sv) == IV_MIN)
6158                 sv_setnv(sv, (NV)IV_MIN - 1.0);
6159             else {
6160                 (void)SvIOK_only(sv);
6161                 --SvIVX(sv);
6162             }   
6163         }
6164         return;
6165     }
6166     if (flags & SVp_NOK) {
6167         SvNVX(sv) -= 1.0;
6168         (void)SvNOK_only(sv);
6169         return;
6170     }
6171     if (!(flags & SVp_POK)) {
6172         if ((flags & SVTYPEMASK) < SVt_PVNV)
6173             sv_upgrade(sv, SVt_NV);
6174         SvNVX(sv) = -1.0;
6175         (void)SvNOK_only(sv);
6176         return;
6177     }
6178 #ifdef PERL_PRESERVE_IVUV
6179     {
6180         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6181         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6182             /* Need to try really hard to see if it's an integer.
6183                9.22337203685478e+18 is an integer.
6184                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6185                so $a="9.22337203685478e+18"; $a+0; $a--
6186                needs to be the same as $a="9.22337203685478e+18"; $a--
6187                or we go insane. */
6188         
6189             (void) sv_2iv(sv);
6190             if (SvIOK(sv))
6191                 goto oops_its_int;
6192
6193             /* sv_2iv *should* have made this an NV */
6194             if (flags & SVp_NOK) {
6195                 (void)SvNOK_only(sv);
6196                 SvNVX(sv) -= 1.0;
6197                 return;
6198             }
6199             /* I don't think we can get here. Maybe I should assert this
6200                And if we do get here I suspect that sv_setnv will croak. NWC
6201                Fall through. */
6202 #if defined(USE_LONG_DOUBLE)
6203             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6204                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6205 #else
6206             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6207                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6208 #endif
6209         }
6210     }
6211 #endif /* PERL_PRESERVE_IVUV */
6212     sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6213 }
6214
6215 /*
6216 =for apidoc sv_mortalcopy
6217
6218 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6219 The new SV is marked as mortal. It will be destroyed "soon", either by an
6220 explicit call to FREETMPS, or by an implicit call at places such as
6221 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
6222
6223 =cut
6224 */
6225
6226 /* Make a string that will exist for the duration of the expression
6227  * evaluation.  Actually, it may have to last longer than that, but
6228  * hopefully we won't free it until it has been assigned to a
6229  * permanent location. */
6230
6231 SV *
6232 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6233 {
6234     register SV *sv;
6235
6236     new_SV(sv);
6237     sv_setsv(sv,oldstr);
6238     EXTEND_MORTAL(1);
6239     PL_tmps_stack[++PL_tmps_ix] = sv;
6240     SvTEMP_on(sv);
6241     return sv;
6242 }
6243
6244 /*
6245 =for apidoc sv_newmortal
6246
6247 Creates a new null SV which is mortal.  The reference count of the SV is
6248 set to 1. It will be destroyed "soon", either by an explicit call to
6249 FREETMPS, or by an implicit call at places such as statement boundaries.
6250 See also C<sv_mortalcopy> and C<sv_2mortal>.
6251
6252 =cut
6253 */
6254
6255 SV *
6256 Perl_sv_newmortal(pTHX)
6257 {
6258     register SV *sv;
6259
6260     new_SV(sv);
6261     SvFLAGS(sv) = SVs_TEMP;
6262     EXTEND_MORTAL(1);
6263     PL_tmps_stack[++PL_tmps_ix] = sv;
6264     return sv;
6265 }
6266
6267 /*
6268 =for apidoc sv_2mortal
6269
6270 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
6271 by an explicit call to FREETMPS, or by an implicit call at places such as
6272 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
6273
6274 =cut
6275 */
6276
6277 SV *
6278 Perl_sv_2mortal(pTHX_ register SV *sv)
6279 {
6280     if (!sv)
6281         return sv;
6282     if (SvREADONLY(sv) && SvIMMORTAL(sv))
6283         return sv;
6284     EXTEND_MORTAL(1);
6285     PL_tmps_stack[++PL_tmps_ix] = sv;
6286     SvTEMP_on(sv);
6287     return sv;
6288 }
6289
6290 /*
6291 =for apidoc newSVpv
6292
6293 Creates a new SV and copies a string into it.  The reference count for the
6294 SV is set to 1.  If C<len> is zero, Perl will compute the length using
6295 strlen().  For efficiency, consider using C<newSVpvn> instead.
6296
6297 =cut
6298 */
6299
6300 SV *
6301 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6302 {
6303     register SV *sv;
6304
6305     new_SV(sv);
6306     if (!len)
6307         len = strlen(s);
6308     sv_setpvn(sv,s,len);
6309     return sv;
6310 }
6311
6312 /*
6313 =for apidoc newSVpvn
6314
6315 Creates a new SV and copies a string into it.  The reference count for the
6316 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
6317 string.  You are responsible for ensuring that the source string is at least
6318 C<len> bytes long.
6319
6320 =cut
6321 */
6322
6323 SV *
6324 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6325 {
6326     register SV *sv;
6327
6328     new_SV(sv);
6329     sv_setpvn(sv,s,len);
6330     return sv;
6331 }
6332
6333 /*
6334 =for apidoc newSVpvn_share
6335
6336 Creates a new SV with its SvPVX pointing to a shared string in the string
6337 table. If the string does not already exist in the table, it is created
6338 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
6339 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6340 otherwise the hash is computed.  The idea here is that as the string table
6341 is used for shared hash keys these strings will have SvPVX == HeKEY and
6342 hash lookup will avoid string compare.
6343
6344 =cut
6345 */
6346
6347 SV *
6348 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6349 {
6350     register SV *sv;
6351     bool is_utf8 = FALSE;
6352     if (len < 0) {
6353         STRLEN tmplen = -len;
6354         is_utf8 = TRUE;
6355         /* See the note in hv.c:hv_fetch() --jhi */
6356         src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6357         len = tmplen;
6358     }
6359     if (!hash)
6360         PERL_HASH(hash, src, len);
6361     new_SV(sv);
6362     sv_upgrade(sv, SVt_PVIV);
6363     SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6364     SvCUR(sv) = len;
6365     SvUVX(sv) = hash;
6366     SvLEN(sv) = 0;
6367     SvREADONLY_on(sv);
6368     SvFAKE_on(sv);
6369     SvPOK_on(sv);
6370     if (is_utf8)
6371         SvUTF8_on(sv);
6372     return sv;
6373 }
6374
6375
6376 #if defined(PERL_IMPLICIT_CONTEXT)
6377
6378 /* pTHX_ magic can't cope with varargs, so this is a no-context
6379  * version of the main function, (which may itself be aliased to us).
6380  * Don't access this version directly.
6381  */
6382
6383 SV *
6384 Perl_newSVpvf_nocontext(const char* pat, ...)
6385 {
6386     dTHX;
6387     register SV *sv;
6388     va_list args;
6389     va_start(args, pat);
6390     sv = vnewSVpvf(pat, &args);
6391     va_end(args);
6392     return sv;
6393 }
6394 #endif
6395
6396 /*
6397 =for apidoc newSVpvf
6398
6399 Creates a new SV and initializes it with the string formatted like
6400 C<sprintf>.
6401
6402 =cut
6403 */
6404
6405 SV *
6406 Perl_newSVpvf(pTHX_ const char* pat, ...)
6407 {
6408     register SV *sv;
6409     va_list args;
6410     va_start(args, pat);
6411     sv = vnewSVpvf(pat, &args);
6412     va_end(args);
6413     return sv;
6414 }
6415
6416 /* backend for newSVpvf() and newSVpvf_nocontext() */
6417
6418 SV *
6419 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6420 {
6421     register SV *sv;
6422     new_SV(sv);
6423     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6424     return sv;
6425 }
6426
6427 /*
6428 =for apidoc newSVnv
6429
6430 Creates a new SV and copies a floating point value into it.
6431 The reference count for the SV is set to 1.
6432
6433 =cut
6434 */
6435
6436 SV *
6437 Perl_newSVnv(pTHX_ NV n)
6438 {
6439     register SV *sv;
6440
6441     new_SV(sv);
6442     sv_setnv(sv,n);
6443     return sv;
6444 }
6445
6446 /*
6447 =for apidoc newSViv
6448
6449 Creates a new SV and copies an integer into it.  The reference count for the
6450 SV is set to 1.
6451
6452 =cut
6453 */
6454
6455 SV *
6456 Perl_newSViv(pTHX_ IV i)
6457 {
6458     register SV *sv;
6459
6460     new_SV(sv);
6461     sv_setiv(sv,i);
6462     return sv;
6463 }
6464
6465 /*
6466 =for apidoc newSVuv
6467
6468 Creates a new SV and copies an unsigned integer into it.
6469 The reference count for the SV is set to 1.
6470
6471 =cut
6472 */
6473
6474 SV *
6475 Perl_newSVuv(pTHX_ UV u)
6476 {
6477     register SV *sv;
6478
6479     new_SV(sv);
6480     sv_setuv(sv,u);
6481     return sv;
6482 }
6483
6484 /*
6485 =for apidoc newRV_noinc
6486
6487 Creates an RV wrapper for an SV.  The reference count for the original
6488 SV is B<not> incremented.
6489
6490 =cut
6491 */
6492
6493 SV *
6494 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6495 {
6496     register SV *sv;
6497
6498     new_SV(sv);
6499     sv_upgrade(sv, SVt_RV);
6500     SvTEMP_off(tmpRef);
6501     SvRV(sv) = tmpRef;
6502     SvROK_on(sv);
6503     return sv;
6504 }
6505
6506 /* newRV_inc is the official function name to use now.
6507  * newRV_inc is in fact #defined to newRV in sv.h
6508  */
6509
6510 SV *
6511 Perl_newRV(pTHX_ SV *tmpRef)
6512 {
6513     return newRV_noinc(SvREFCNT_inc(tmpRef));
6514 }
6515
6516 /*
6517 =for apidoc newSVsv
6518
6519 Creates a new SV which is an exact duplicate of the original SV.
6520 (Uses C<sv_setsv>).
6521
6522 =cut
6523 */
6524
6525 SV *
6526 Perl_newSVsv(pTHX_ register SV *old)
6527 {
6528     register SV *sv;
6529
6530     if (!old)
6531         return Nullsv;
6532     if (SvTYPE(old) == SVTYPEMASK) {
6533         if (ckWARN_d(WARN_INTERNAL))
6534             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6535         return Nullsv;
6536     }
6537     new_SV(sv);
6538     if (SvTEMP(old)) {
6539         SvTEMP_off(old);
6540         sv_setsv(sv,old);
6541         SvTEMP_on(old);
6542     }
6543     else
6544         sv_setsv(sv,old);
6545     return sv;
6546 }
6547
6548 /*
6549 =for apidoc sv_reset
6550
6551 Underlying implementation for the C<reset> Perl function.
6552 Note that the perl-level function is vaguely deprecated.
6553
6554 =cut
6555 */
6556
6557 void
6558 Perl_sv_reset(pTHX_ register char *s, HV *stash)
6559 {
6560     register HE *entry;
6561     register GV *gv;
6562     register SV *sv;
6563     register I32 i;
6564     register PMOP *pm;
6565     register I32 max;
6566     char todo[PERL_UCHAR_MAX+1];
6567
6568     if (!stash)
6569         return;
6570
6571     if (!*s) {          /* reset ?? searches */
6572         for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
6573             pm->op_pmdynflags &= ~PMdf_USED;
6574         }
6575         return;
6576     }
6577
6578     /* reset variables */
6579
6580     if (!HvARRAY(stash))
6581         return;
6582
6583     Zero(todo, 256, char);
6584     while (*s) {
6585         i = (unsigned char)*s;
6586         if (s[1] == '-') {
6587             s += 2;
6588         }
6589         max = (unsigned char)*s++;
6590         for ( ; i <= max; i++) {
6591             todo[i] = 1;
6592         }
6593         for (i = 0; i <= (I32) HvMAX(stash); i++) {
6594             for (entry = HvARRAY(stash)[i];
6595                  entry;
6596                  entry = HeNEXT(entry))
6597             {
6598                 if (!todo[(U8)*HeKEY(entry)])
6599                     continue;
6600                 gv = (GV*)HeVAL(entry);
6601                 sv = GvSV(gv);
6602                 if (SvTHINKFIRST(sv)) {
6603                     if (!SvREADONLY(sv) && SvROK(sv))
6604                         sv_unref(sv);
6605                     continue;
6606                 }
6607                 (void)SvOK_off(sv);
6608                 if (SvTYPE(sv) >= SVt_PV) {
6609                     SvCUR_set(sv, 0);
6610                     if (SvPVX(sv) != Nullch)
6611                         *SvPVX(sv) = '\0';
6612                     SvTAINT(sv);
6613                 }
6614                 if (GvAV(gv)) {
6615                     av_clear(GvAV(gv));
6616                 }
6617                 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
6618                     hv_clear(GvHV(gv));
6619 #ifdef USE_ENVIRON_ARRAY
6620                     if (gv == PL_envgv)
6621                         environ[0] = Nullch;
6622 #endif
6623                 }
6624             }
6625         }
6626     }
6627 }
6628
6629 /*
6630 =for apidoc sv_2io
6631
6632 Using various gambits, try to get an IO from an SV: the IO slot if its a
6633 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6634 named after the PV if we're a string.
6635
6636 =cut
6637 */
6638
6639 IO*
6640 Perl_sv_2io(pTHX_ SV *sv)
6641 {
6642     IO* io;
6643     GV* gv;
6644     STRLEN n_a;
6645
6646     switch (SvTYPE(sv)) {
6647     case SVt_PVIO:
6648         io = (IO*)sv;
6649         break;
6650     case SVt_PVGV:
6651         gv = (GV*)sv;
6652         io = GvIO(gv);
6653         if (!io)
6654             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6655         break;
6656     default:
6657         if (!SvOK(sv))
6658             Perl_croak(aTHX_ PL_no_usym, "filehandle");
6659         if (SvROK(sv))
6660             return sv_2io(SvRV(sv));
6661         gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
6662         if (gv)
6663             io = GvIO(gv);
6664         else
6665             io = 0;
6666         if (!io)
6667             Perl_croak(aTHX_ "Bad filehandle: %s", SvPV(sv,n_a));
6668         break;
6669     }
6670     return io;
6671 }
6672
6673 /*
6674 =for apidoc sv_2cv
6675
6676 Using various gambits, try to get a CV from an SV; in addition, try if
6677 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6678
6679 =cut
6680 */
6681
6682 CV *
6683 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6684 {
6685     GV *gv = Nullgv;
6686     CV *cv = Nullcv;
6687     STRLEN n_a;
6688
6689     if (!sv)
6690         return *gvp = Nullgv, Nullcv;
6691     switch (SvTYPE(sv)) {
6692     case SVt_PVCV:
6693         *st = CvSTASH(sv);
6694         *gvp = Nullgv;
6695         return (CV*)sv;
6696     case SVt_PVHV:
6697     case SVt_PVAV:
6698         *gvp = Nullgv;
6699         return Nullcv;
6700     case SVt_PVGV:
6701         gv = (GV*)sv;
6702         *gvp = gv;
6703         *st = GvESTASH(gv);
6704         goto fix_gv;
6705
6706     default:
6707         if (SvGMAGICAL(sv))
6708             mg_get(sv);
6709         if (SvROK(sv)) {
6710             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
6711             tryAMAGICunDEREF(to_cv);
6712
6713             sv = SvRV(sv);
6714             if (SvTYPE(sv) == SVt_PVCV) {
6715                 cv = (CV*)sv;
6716                 *gvp = Nullgv;
6717                 *st = CvSTASH(cv);
6718                 return cv;
6719             }
6720             else if(isGV(sv))
6721                 gv = (GV*)sv;
6722             else
6723                 Perl_croak(aTHX_ "Not a subroutine reference");
6724         }
6725         else if (isGV(sv))
6726             gv = (GV*)sv;
6727         else
6728             gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
6729         *gvp = gv;
6730         if (!gv)
6731             return Nullcv;
6732         *st = GvESTASH(gv);
6733     fix_gv:
6734         if (lref && !GvCVu(gv)) {
6735             SV *tmpsv;
6736             ENTER;
6737             tmpsv = NEWSV(704,0);
6738             gv_efullname3(tmpsv, gv, Nullch);
6739             /* XXX this is probably not what they think they're getting.
6740              * It has the same effect as "sub name;", i.e. just a forward
6741              * declaration! */
6742             newSUB(start_subparse(FALSE, 0),
6743                    newSVOP(OP_CONST, 0, tmpsv),
6744                    Nullop,
6745                    Nullop);
6746             LEAVE;
6747             if (!GvCVu(gv))
6748                 Perl_croak(aTHX_ "Unable to create sub named \"%s\"", SvPV(sv,n_a));
6749         }
6750         return GvCVu(gv);
6751     }
6752 }
6753
6754 /*
6755 =for apidoc sv_true
6756
6757 Returns true if the SV has a true value by Perl's rules.
6758 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6759 instead use an in-line version.
6760
6761 =cut
6762 */
6763
6764 I32
6765 Perl_sv_true(pTHX_ register SV *sv)
6766 {
6767     if (!sv)
6768         return 0;
6769     if (SvPOK(sv)) {
6770         register XPV* tXpv;
6771         if ((tXpv = (XPV*)SvANY(sv)) &&
6772                 (tXpv->xpv_cur > 1 ||
6773                 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
6774             return 1;
6775         else
6776             return 0;
6777     }
6778     else {
6779         if (SvIOK(sv))
6780             return SvIVX(sv) != 0;
6781         else {
6782             if (SvNOK(sv))
6783                 return SvNVX(sv) != 0.0;
6784             else
6785                 return sv_2bool(sv);
6786         }
6787     }
6788 }
6789
6790 /*
6791 =for apidoc sv_iv
6792
6793 A private implementation of the C<SvIVx> macro for compilers which can't
6794 cope with complex macro expressions. Always use the macro instead.
6795
6796 =cut
6797 */
6798
6799 IV
6800 Perl_sv_iv(pTHX_ register SV *sv)
6801 {
6802     if (SvIOK(sv)) {
6803         if (SvIsUV(sv))
6804             return (IV)SvUVX(sv);
6805         return SvIVX(sv);
6806     }
6807     return sv_2iv(sv);
6808 }
6809
6810 /*
6811 =for apidoc sv_uv
6812
6813 A private implementation of the C<SvUVx> macro for compilers which can't
6814 cope with complex macro expressions. Always use the macro instead.
6815
6816 =cut
6817 */
6818
6819 UV
6820 Perl_sv_uv(pTHX_ register SV *sv)
6821 {
6822     if (SvIOK(sv)) {
6823         if (SvIsUV(sv))
6824             return SvUVX(sv);
6825         return (UV)SvIVX(sv);
6826     }
6827     return sv_2uv(sv);
6828 }
6829
6830 /*
6831 =for apidoc sv_nv
6832
6833 A private implementation of the C<SvNVx> macro for compilers which can't
6834 cope with complex macro expressions. Always use the macro instead.
6835
6836 =cut
6837 */
6838
6839 NV
6840 Perl_sv_nv(pTHX_ register SV *sv)
6841 {
6842     if (SvNOK(sv))
6843         return SvNVX(sv);
6844     return sv_2nv(sv);
6845 }
6846
6847 /*
6848 =for apidoc sv_pv
6849
6850 A private implementation of the C<SvPV_nolen> macro for compilers which can't
6851 cope with complex macro expressions. Always use the macro instead.
6852
6853 =cut
6854 */
6855
6856 char *
6857 Perl_sv_pv(pTHX_ SV *sv)
6858 {
6859     STRLEN n_a;
6860
6861     if (SvPOK(sv))
6862         return SvPVX(sv);
6863
6864     return sv_2pv(sv, &n_a);
6865 }
6866
6867 /*
6868 =for apidoc sv_pvn
6869
6870 A private implementation of the C<SvPV> macro for compilers which can't
6871 cope with complex macro expressions. Always use the macro instead.
6872
6873 =cut
6874 */
6875
6876 char *
6877 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
6878 {
6879     if (SvPOK(sv)) {
6880         *lp = SvCUR(sv);
6881         return SvPVX(sv);
6882     }
6883     return sv_2pv(sv, lp);
6884 }
6885
6886 /* For -DCRIPPLED_CC only. See also C<sv_2pv_flags()>.
6887  */
6888
6889 char *
6890 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
6891 {
6892     if (SvPOK(sv)) {
6893         *lp = SvCUR(sv);
6894         return SvPVX(sv);
6895     }
6896     return sv_2pv_flags(sv, lp, 0);
6897 }
6898
6899 /*
6900 =for apidoc sv_pvn_force
6901
6902 Get a sensible string out of the SV somehow.
6903 A private implementation of the C<SvPV_force> macro for compilers which
6904 can't cope with complex macro expressions. Always use the macro instead.
6905
6906 =cut
6907 */
6908
6909 char *
6910 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
6911 {
6912     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
6913 }
6914
6915 /*
6916 =for apidoc sv_pvn_force_flags
6917
6918 Get a sensible string out of the SV somehow.
6919 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6920 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6921 implemented in terms of this function.
6922 You normally want to use the various wrapper macros instead: see
6923 C<SvPV_force> and C<SvPV_force_nomg>
6924
6925 =cut
6926 */
6927
6928 char *
6929 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6930 {
6931     char *s = NULL;
6932
6933     if (SvTHINKFIRST(sv) && !SvROK(sv))
6934         sv_force_normal(sv);
6935
6936     if (SvPOK(sv)) {
6937         *lp = SvCUR(sv);
6938     }
6939     else {
6940         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
6941             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6942                 OP_NAME(PL_op));
6943         }
6944         else
6945             s = sv_2pv_flags(sv, lp, flags);
6946         if (s != SvPVX(sv)) {   /* Almost, but not quite, sv_setpvn() */
6947             STRLEN len = *lp;
6948         
6949             if (SvROK(sv))
6950                 sv_unref(sv);
6951             (void)SvUPGRADE(sv, SVt_PV);                /* Never FALSE */
6952             SvGROW(sv, len + 1);
6953             Move(s,SvPVX(sv),len,char);
6954             SvCUR_set(sv, len);
6955             *SvEND(sv) = '\0';
6956         }
6957         if (!SvPOK(sv)) {
6958             SvPOK_on(sv);               /* validate pointer */
6959             SvTAINT(sv);
6960             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6961                                   PTR2UV(sv),SvPVX(sv)));
6962         }
6963     }
6964     return SvPVX(sv);
6965 }
6966
6967 /*
6968 =for apidoc sv_pvbyte
6969
6970 A private implementation of the C<SvPVbyte_nolen> macro for compilers
6971 which can't cope with complex macro expressions. Always use the macro
6972 instead.
6973
6974 =cut
6975 */
6976
6977 char *
6978 Perl_sv_pvbyte(pTHX_ SV *sv)
6979 {
6980     sv_utf8_downgrade(sv,0);
6981     return sv_pv(sv);
6982 }
6983
6984 /*
6985 =for apidoc sv_pvbyten
6986
6987 A private implementation of the C<SvPVbyte> macro for compilers
6988 which can't cope with complex macro expressions. Always use the macro
6989 instead.
6990
6991 =cut
6992 */
6993
6994 char *
6995 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
6996 {
6997     sv_utf8_downgrade(sv,0);
6998     return sv_pvn(sv,lp);
6999 }
7000
7001 /*
7002 =for apidoc sv_pvbyten_force
7003
7004 A private implementation of the C<SvPVbytex_force> macro for compilers
7005 which can't cope with complex macro expressions. Always use the macro
7006 instead.
7007
7008 =cut
7009 */
7010
7011 char *
7012 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7013 {
7014     sv_utf8_downgrade(sv,0);
7015     return sv_pvn_force(sv,lp);
7016 }
7017
7018 /*
7019 =for apidoc sv_pvutf8
7020
7021 A private implementation of the C<SvPVutf8_nolen> macro for compilers
7022 which can't cope with complex macro expressions. Always use the macro
7023 instead.
7024
7025 =cut
7026 */
7027
7028 char *
7029 Perl_sv_pvutf8(pTHX_ SV *sv)
7030 {
7031     sv_utf8_upgrade(sv);
7032     return sv_pv(sv);
7033 }
7034
7035 /*
7036 =for apidoc sv_pvutf8n
7037
7038 A private implementation of the C<SvPVutf8> macro for compilers
7039 which can't cope with complex macro expressions. Always use the macro
7040 instead.
7041
7042 =cut
7043 */
7044
7045 char *
7046 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7047 {
7048     sv_utf8_upgrade(sv);
7049     return sv_pvn(sv,lp);
7050 }
7051
7052 /*
7053 =for apidoc sv_pvutf8n_force
7054
7055 A private implementation of the C<SvPVutf8_force> macro for compilers
7056 which can't cope with complex macro expressions. Always use the macro
7057 instead.
7058
7059 =cut
7060 */
7061
7062 char *
7063 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7064 {
7065     sv_utf8_upgrade(sv);
7066     return sv_pvn_force(sv,lp);
7067 }
7068
7069 /*
7070 =for apidoc sv_reftype
7071
7072 Returns a string describing what the SV is a reference to.
7073
7074 =cut
7075 */
7076
7077 char *
7078 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7079 {
7080     if (ob && SvOBJECT(sv)) {
7081         HV *svs = SvSTASH(sv);
7082         /* [20011101.072] This bandaid for C<package;> should eventually
7083            be removed. AMS 20011103 */
7084         return (svs ? HvNAME(svs) : "<none>");
7085     }
7086     else {
7087         switch (SvTYPE(sv)) {
7088         case SVt_NULL:
7089         case SVt_IV:
7090         case SVt_NV:
7091         case SVt_RV:
7092         case SVt_PV:
7093         case SVt_PVIV:
7094         case SVt_PVNV:
7095         case SVt_PVMG:
7096         case SVt_PVBM:
7097                                 if (SvROK(sv))
7098                                     return "REF";
7099                                 else
7100                                     return "SCALAR";
7101         case SVt_PVLV:          return "LVALUE";
7102         case SVt_PVAV:          return "ARRAY";
7103         case SVt_PVHV:          return "HASH";
7104         case SVt_PVCV:          return "CODE";
7105         case SVt_PVGV:          return "GLOB";
7106         case SVt_PVFM:          return "FORMAT";
7107         case SVt_PVIO:          return "IO";
7108         default:                return "UNKNOWN";
7109         }
7110     }
7111 }
7112
7113 /*
7114 =for apidoc sv_isobject
7115
7116 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7117 object.  If the SV is not an RV, or if the object is not blessed, then this
7118 will return false.
7119
7120 =cut
7121 */
7122
7123 int
7124 Perl_sv_isobject(pTHX_ SV *sv)
7125 {
7126     if (!sv)
7127         return 0;
7128     if (SvGMAGICAL(sv))
7129         mg_get(sv);
7130     if (!SvROK(sv))
7131         return 0;
7132     sv = (SV*)SvRV(sv);
7133     if (!SvOBJECT(sv))
7134         return 0;
7135     return 1;
7136 }
7137
7138 /*
7139 =for apidoc sv_isa
7140
7141 Returns a boolean indicating whether the SV is blessed into the specified
7142 class.  This does not check for subtypes; use C<sv_derived_from> to verify
7143 an inheritance relationship.
7144
7145 =cut
7146 */
7147
7148 int
7149 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7150 {
7151     if (!sv)
7152         return 0;
7153     if (SvGMAGICAL(sv))
7154         mg_get(sv);
7155     if (!SvROK(sv))
7156         return 0;
7157     sv = (SV*)SvRV(sv);
7158     if (!SvOBJECT(sv))
7159         return 0;
7160
7161     return strEQ(HvNAME(SvSTASH(sv)), name);
7162 }
7163
7164 /*
7165 =for apidoc newSVrv
7166
7167 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
7168 it will be upgraded to one.  If C<classname> is non-null then the new SV will
7169 be blessed in the specified package.  The new SV is returned and its
7170 reference count is 1.
7171
7172 =cut
7173 */
7174
7175 SV*
7176 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7177 {
7178     SV *sv;
7179
7180     new_SV(sv);
7181
7182     SV_CHECK_THINKFIRST(rv);
7183     SvAMAGIC_off(rv);
7184
7185     if (SvTYPE(rv) >= SVt_PVMG) {
7186         U32 refcnt = SvREFCNT(rv);
7187         SvREFCNT(rv) = 0;
7188         sv_clear(rv);
7189         SvFLAGS(rv) = 0;
7190         SvREFCNT(rv) = refcnt;
7191     }
7192
7193     if (SvTYPE(rv) < SVt_RV)
7194         sv_upgrade(rv, SVt_RV);
7195     else if (SvTYPE(rv) > SVt_RV) {
7196         (void)SvOOK_off(rv);
7197         if (SvPVX(rv) && SvLEN(rv))
7198             Safefree(SvPVX(rv));
7199         SvCUR_set(rv, 0);
7200         SvLEN_set(rv, 0);
7201     }
7202
7203     (void)SvOK_off(rv);
7204     SvRV(rv) = sv;
7205     SvROK_on(rv);
7206
7207     if (classname) {
7208         HV* stash = gv_stashpv(classname, TRUE);
7209         (void)sv_bless(rv, stash);
7210     }
7211     return sv;
7212 }
7213
7214 /*
7215 =for apidoc sv_setref_pv
7216
7217 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
7218 argument will be upgraded to an RV.  That RV will be modified to point to
7219 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7220 into the SV.  The C<classname> argument indicates the package for the
7221 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7222 will be returned and will have a reference count of 1.
7223
7224 Do not use with other Perl types such as HV, AV, SV, CV, because those
7225 objects will become corrupted by the pointer copy process.
7226
7227 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7228
7229 =cut
7230 */
7231
7232 SV*
7233 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7234 {
7235     if (!pv) {
7236         sv_setsv(rv, &PL_sv_undef);
7237         SvSETMAGIC(rv);
7238     }
7239     else
7240         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7241     return rv;
7242 }
7243
7244 /*
7245 =for apidoc sv_setref_iv
7246
7247 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
7248 argument will be upgraded to an RV.  That RV will be modified to point to
7249 the new SV.  The C<classname> argument indicates the package for the
7250 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7251 will be returned and will have a reference count of 1.
7252
7253 =cut
7254 */
7255
7256 SV*
7257 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7258 {
7259     sv_setiv(newSVrv(rv,classname), iv);
7260     return rv;
7261 }
7262
7263 /*
7264 =for apidoc sv_setref_uv
7265
7266 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
7267 argument will be upgraded to an RV.  That RV will be modified to point to
7268 the new SV.  The C<classname> argument indicates the package for the
7269 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7270 will be returned and will have a reference count of 1.
7271
7272 =cut
7273 */
7274
7275 SV*
7276 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7277 {
7278     sv_setuv(newSVrv(rv,classname), uv);
7279     return rv;
7280 }
7281
7282 /*
7283 =for apidoc sv_setref_nv
7284
7285 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
7286 argument will be upgraded to an RV.  That RV will be modified to point to
7287 the new SV.  The C<classname> argument indicates the package for the
7288 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7289 will be returned and will have a reference count of 1.
7290
7291 =cut
7292 */
7293
7294 SV*
7295 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7296 {
7297     sv_setnv(newSVrv(rv,classname), nv);
7298     return rv;
7299 }
7300
7301 /*
7302 =for apidoc sv_setref_pvn
7303
7304 Copies a string into a new SV, optionally blessing the SV.  The length of the
7305 string must be specified with C<n>.  The C<rv> argument will be upgraded to
7306 an RV.  That RV will be modified to point to the new SV.  The C<classname>
7307 argument indicates the package for the blessing.  Set C<classname> to
7308 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
7309 a reference count of 1.
7310
7311 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7312
7313 =cut
7314 */
7315
7316 SV*
7317 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7318 {
7319     sv_setpvn(newSVrv(rv,classname), pv, n);
7320     return rv;
7321 }
7322
7323 /*
7324 =for apidoc sv_bless
7325
7326 Blesses an SV into a specified package.  The SV must be an RV.  The package
7327 must be designated by its stash (see C<gv_stashpv()>).  The reference count
7328 of the SV is unaffected.
7329
7330 =cut
7331 */
7332
7333 SV*
7334 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7335 {
7336     SV *tmpRef;
7337     if (!SvROK(sv))
7338         Perl_croak(aTHX_ "Can't bless non-reference value");
7339     tmpRef = SvRV(sv);
7340     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7341         if (SvREADONLY(tmpRef))
7342             Perl_croak(aTHX_ PL_no_modify);
7343         if (SvOBJECT(tmpRef)) {
7344             if (SvTYPE(tmpRef) != SVt_PVIO)
7345                 --PL_sv_objcount;
7346             SvREFCNT_dec(SvSTASH(tmpRef));
7347         }
7348     }
7349     SvOBJECT_on(tmpRef);
7350     if (SvTYPE(tmpRef) != SVt_PVIO)
7351         ++PL_sv_objcount;
7352     (void)SvUPGRADE(tmpRef, SVt_PVMG);
7353     SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7354
7355     if (Gv_AMG(stash))
7356         SvAMAGIC_on(sv);
7357     else
7358         SvAMAGIC_off(sv);
7359
7360     if(SvSMAGICAL(tmpRef))
7361         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7362             mg_set(tmpRef);
7363
7364
7365
7366     return sv;
7367 }
7368
7369 /* Downgrades a PVGV to a PVMG.
7370  *
7371  * XXX This function doesn't actually appear to be used anywhere
7372  * DAPM 15-Jun-01
7373  */
7374
7375 STATIC void
7376 S_sv_unglob(pTHX_ SV *sv)
7377 {
7378     void *xpvmg;
7379
7380     assert(SvTYPE(sv) == SVt_PVGV);
7381     SvFAKE_off(sv);
7382     if (GvGP(sv))
7383         gp_free((GV*)sv);
7384     if (GvSTASH(sv)) {
7385         SvREFCNT_dec(GvSTASH(sv));
7386         GvSTASH(sv) = Nullhv;
7387     }
7388     sv_unmagic(sv, PERL_MAGIC_glob);
7389     Safefree(GvNAME(sv));
7390     GvMULTI_off(sv);
7391
7392     /* need to keep SvANY(sv) in the right arena */
7393     xpvmg = new_XPVMG();
7394     StructCopy(SvANY(sv), xpvmg, XPVMG);
7395     del_XPVGV(SvANY(sv));
7396     SvANY(sv) = xpvmg;
7397
7398     SvFLAGS(sv) &= ~SVTYPEMASK;
7399     SvFLAGS(sv) |= SVt_PVMG;
7400 }
7401
7402 /*
7403 =for apidoc sv_unref_flags
7404
7405 Unsets the RV status of the SV, and decrements the reference count of
7406 whatever was being referenced by the RV.  This can almost be thought of
7407 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
7408 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7409 (otherwise the decrementing is conditional on the reference count being
7410 different from one or the reference being a readonly SV).
7411 See C<SvROK_off>.
7412
7413 =cut
7414 */
7415
7416 void
7417 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7418 {
7419     SV* rv = SvRV(sv);
7420
7421     if (SvWEAKREF(sv)) {
7422         sv_del_backref(sv);
7423         SvWEAKREF_off(sv);
7424         SvRV(sv) = 0;
7425         return;
7426     }
7427     SvRV(sv) = 0;
7428     SvROK_off(sv);
7429     if (SvREFCNT(rv) != 1 || SvREADONLY(rv) || flags) /* SV_IMMEDIATE_UNREF */
7430         SvREFCNT_dec(rv);
7431     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7432         sv_2mortal(rv);         /* Schedule for freeing later */
7433 }
7434
7435 /*
7436 =for apidoc sv_unref
7437
7438 Unsets the RV status of the SV, and decrements the reference count of
7439 whatever was being referenced by the RV.  This can almost be thought of
7440 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
7441 being zero.  See C<SvROK_off>.
7442
7443 =cut
7444 */
7445
7446 void
7447 Perl_sv_unref(pTHX_ SV *sv)
7448 {
7449     sv_unref_flags(sv, 0);
7450 }
7451
7452 /*
7453 =for apidoc sv_taint
7454
7455 Taint an SV. Use C<SvTAINTED_on> instead.
7456 =cut
7457 */
7458
7459 void
7460 Perl_sv_taint(pTHX_ SV *sv)
7461 {
7462     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7463 }
7464
7465 /*
7466 =for apidoc sv_untaint
7467
7468 Untaint an SV. Use C<SvTAINTED_off> instead.
7469 =cut
7470 */
7471
7472 void
7473 Perl_sv_untaint(pTHX_ SV *sv)
7474 {
7475     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7476         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7477         if (mg)
7478             mg->mg_len &= ~1;
7479     }
7480 }
7481
7482 /*
7483 =for apidoc sv_tainted
7484
7485 Test an SV for taintedness. Use C<SvTAINTED> instead.
7486 =cut
7487 */
7488
7489 bool
7490 Perl_sv_tainted(pTHX_ SV *sv)
7491 {
7492     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7493         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7494         if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7495             return TRUE;
7496     }
7497     return FALSE;
7498 }
7499
7500 /*
7501 =for apidoc sv_setpviv
7502
7503 Copies an integer into the given SV, also updating its string value.
7504 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
7505
7506 =cut
7507 */
7508
7509 void
7510 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7511 {
7512     char buf[TYPE_CHARS(UV)];
7513     char *ebuf;
7514     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7515
7516     sv_setpvn(sv, ptr, ebuf - ptr);
7517 }
7518
7519 /*
7520 =for apidoc sv_setpviv_mg
7521
7522 Like C<sv_setpviv>, but also handles 'set' magic.
7523
7524 =cut
7525 */
7526
7527 void
7528 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7529 {
7530     char buf[TYPE_CHARS(UV)];
7531     char *ebuf;
7532     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7533
7534     sv_setpvn(sv, ptr, ebuf - ptr);
7535     SvSETMAGIC(sv);
7536 }
7537
7538 #if defined(PERL_IMPLICIT_CONTEXT)
7539
7540 /* pTHX_ magic can't cope with varargs, so this is a no-context
7541  * version of the main function, (which may itself be aliased to us).
7542  * Don't access this version directly.
7543  */
7544
7545 void
7546 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7547 {
7548     dTHX;
7549     va_list args;
7550     va_start(args, pat);
7551     sv_vsetpvf(sv, pat, &args);
7552     va_end(args);
7553 }
7554
7555 /* pTHX_ magic can't cope with varargs, so this is a no-context
7556  * version of the main function, (which may itself be aliased to us).
7557  * Don't access this version directly.
7558  */
7559
7560 void
7561 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7562 {
7563     dTHX;
7564     va_list args;
7565     va_start(args, pat);
7566     sv_vsetpvf_mg(sv, pat, &args);
7567     va_end(args);
7568 }
7569 #endif
7570
7571 /*
7572 =for apidoc sv_setpvf
7573
7574 Processes its arguments like C<sprintf> and sets an SV to the formatted
7575 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
7576
7577 =cut
7578 */
7579
7580 void
7581 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7582 {
7583     va_list args;
7584     va_start(args, pat);
7585     sv_vsetpvf(sv, pat, &args);
7586     va_end(args);
7587 }
7588
7589 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
7590
7591 void
7592 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7593 {
7594     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7595 }
7596
7597 /*
7598 =for apidoc sv_setpvf_mg
7599
7600 Like C<sv_setpvf>, but also handles 'set' magic.
7601
7602 =cut
7603 */
7604
7605 void
7606 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7607 {
7608     va_list args;
7609     va_start(args, pat);
7610     sv_vsetpvf_mg(sv, pat, &args);
7611     va_end(args);
7612 }
7613
7614 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
7615
7616 void
7617 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7618 {
7619     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7620     SvSETMAGIC(sv);
7621 }
7622
7623 #if defined(PERL_IMPLICIT_CONTEXT)
7624
7625 /* pTHX_ magic can't cope with varargs, so this is a no-context
7626  * version of the main function, (which may itself be aliased to us).
7627  * Don't access this version directly.
7628  */
7629
7630 void
7631 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7632 {
7633     dTHX;
7634     va_list args;
7635     va_start(args, pat);
7636     sv_vcatpvf(sv, pat, &args);
7637     va_end(args);
7638 }
7639
7640 /* pTHX_ magic can't cope with varargs, so this is a no-context
7641  * version of the main function, (which may itself be aliased to us).
7642  * Don't access this version directly.
7643  */
7644
7645 void
7646 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7647 {
7648     dTHX;
7649     va_list args;
7650     va_start(args, pat);
7651     sv_vcatpvf_mg(sv, pat, &args);
7652     va_end(args);
7653 }
7654 #endif
7655
7656 /*
7657 =for apidoc sv_catpvf
7658
7659 Processes its arguments like C<sprintf> and appends the formatted
7660 output to an SV.  If the appended data contains "wide" characters
7661 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7662 and characters >255 formatted with %c), the original SV might get
7663 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
7664 C<SvSETMAGIC()> must typically be called after calling this function
7665 to handle 'set' magic.
7666
7667 =cut */
7668
7669 void
7670 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7671 {
7672     va_list args;
7673     va_start(args, pat);
7674     sv_vcatpvf(sv, pat, &args);
7675     va_end(args);
7676 }
7677
7678 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
7679
7680 void
7681 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7682 {
7683     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7684 }
7685
7686 /*
7687 =for apidoc sv_catpvf_mg
7688
7689 Like C<sv_catpvf>, but also handles 'set' magic.
7690
7691 =cut
7692 */
7693
7694 void
7695 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7696 {
7697     va_list args;
7698     va_start(args, pat);
7699     sv_vcatpvf_mg(sv, pat, &args);
7700     va_end(args);
7701 }
7702
7703 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
7704
7705 void
7706 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7707 {
7708     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7709     SvSETMAGIC(sv);
7710 }
7711
7712 /*
7713 =for apidoc sv_vsetpvfn
7714
7715 Works like C<vcatpvfn> but copies the text into the SV instead of
7716 appending it.
7717
7718 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
7719
7720 =cut
7721 */
7722
7723 void
7724 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7725 {
7726     sv_setpvn(sv, "", 0);
7727     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7728 }
7729
7730 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7731
7732 STATIC I32
7733 S_expect_number(pTHX_ char** pattern)
7734 {
7735     I32 var = 0;
7736     switch (**pattern) {
7737     case '1': case '2': case '3':
7738     case '4': case '5': case '6':
7739     case '7': case '8': case '9':
7740         while (isDIGIT(**pattern))
7741             var = var * 10 + (*(*pattern)++ - '0');
7742     }
7743     return var;
7744 }
7745 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7746
7747 /*
7748 =for apidoc sv_vcatpvfn
7749
7750 Processes its arguments like C<vsprintf> and appends the formatted output
7751 to an SV.  Uses an array of SVs if the C style variable argument list is
7752 missing (NULL).  When running with taint checks enabled, indicates via
7753 C<maybe_tainted> if results are untrustworthy (often due to the use of
7754 locales).
7755
7756 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
7757
7758 =cut
7759 */
7760
7761 void
7762 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7763 {
7764     char *p;
7765     char *q;
7766     char *patend;
7767     STRLEN origlen;
7768     I32 svix = 0;
7769     static char nullstr[] = "(null)";
7770     SV *argsv = Nullsv;
7771     bool has_utf8 = FALSE; /* has the result utf8? */
7772
7773     /* no matter what, this is a string now */
7774     (void)SvPV_force(sv, origlen);
7775
7776     /* special-case "", "%s", and "%_" */
7777     if (patlen == 0)
7778         return;
7779     if (patlen == 2 && pat[0] == '%') {
7780         switch (pat[1]) {
7781         case 's':
7782             if (args) {
7783                 char *s = va_arg(*args, char*);
7784                 sv_catpv(sv, s ? s : nullstr);
7785             }
7786             else if (svix < svmax) {
7787                 sv_catsv(sv, *svargs);
7788                 if (DO_UTF8(*svargs))
7789                     SvUTF8_on(sv);
7790             }
7791             return;
7792         case '_':
7793             if (args) {
7794                 argsv = va_arg(*args, SV*);
7795                 sv_catsv(sv, argsv);
7796                 if (DO_UTF8(argsv))
7797                     SvUTF8_on(sv);
7798                 return;
7799             }
7800             /* See comment on '_' below */
7801             break;
7802         }
7803     }
7804
7805     if (!args && svix < svmax && DO_UTF8(*svargs))
7806         has_utf8 = TRUE;
7807
7808     patend = (char*)pat + patlen;
7809     for (p = (char*)pat; p < patend; p = q) {
7810         bool alt = FALSE;
7811         bool left = FALSE;
7812         bool vectorize = FALSE;
7813         bool vectorarg = FALSE;
7814         bool vec_utf8 = FALSE;
7815         char fill = ' ';
7816         char plus = 0;
7817         char intsize = 0;
7818         STRLEN width = 0;
7819         STRLEN zeros = 0;
7820         bool has_precis = FALSE;
7821         STRLEN precis = 0;
7822         bool is_utf8 = FALSE;  /* is this item utf8?   */
7823         
7824         char esignbuf[4];
7825         U8 utf8buf[UTF8_MAXLEN+1];
7826         STRLEN esignlen = 0;
7827
7828         char *eptr = Nullch;
7829         STRLEN elen = 0;
7830         /* Times 4: a decimal digit takes more than 3 binary digits.
7831          * NV_DIG: mantissa takes than many decimal digits.
7832          * Plus 32: Playing safe. */
7833         char ebuf[IV_DIG * 4 + NV_DIG + 32];
7834         /* large enough for "%#.#f" --chip */
7835         /* what about long double NVs? --jhi */
7836
7837         SV *vecsv;
7838         U8 *vecstr = Null(U8*);
7839         STRLEN veclen = 0;
7840         char c;
7841         int i;
7842         unsigned base = 0;
7843         IV iv = 0;
7844         UV uv = 0;
7845         NV nv;
7846         STRLEN have;
7847         STRLEN need;
7848         STRLEN gap;
7849         char *dotstr = ".";
7850         STRLEN dotstrlen = 1;
7851         I32 efix = 0; /* explicit format parameter index */
7852         I32 ewix = 0; /* explicit width index */
7853         I32 epix = 0; /* explicit precision index */
7854         I32 evix = 0; /* explicit vector index */
7855         bool asterisk = FALSE;
7856
7857         /* echo everything up to the next format specification */
7858         for (q = p; q < patend && *q != '%'; ++q) ;
7859         if (q > p) {
7860             sv_catpvn(sv, p, q - p);
7861             p = q;
7862         }
7863         if (q++ >= patend)
7864             break;
7865
7866 /*
7867     We allow format specification elements in this order:
7868         \d+\$              explicit format parameter index
7869         [-+ 0#]+           flags
7870         \*?(\d+\$)?v       vector with optional (optionally specified) arg
7871         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
7872         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7873         [hlqLV]            size
7874     [%bcdefginopsux_DFOUX] format (mandatory)
7875 */
7876         if (EXPECT_NUMBER(q, width)) {
7877             if (*q == '$') {
7878                 ++q;
7879                 efix = width;
7880             } else {
7881                 goto gotwidth;
7882             }
7883         }
7884
7885         /* FLAGS */
7886
7887         while (*q) {
7888             switch (*q) {
7889             case ' ':
7890             case '+':
7891                 plus = *q++;
7892                 continue;
7893
7894             case '-':
7895                 left = TRUE;
7896                 q++;
7897                 continue;
7898
7899             case '0':
7900                 fill = *q++;
7901                 continue;
7902
7903             case '#':
7904                 alt = TRUE;
7905                 q++;
7906                 continue;
7907
7908             default:
7909                 break;
7910             }
7911             break;
7912         }
7913
7914       tryasterisk:
7915         if (*q == '*') {
7916             q++;
7917             if (EXPECT_NUMBER(q, ewix))
7918                 if (*q++ != '$')
7919                     goto unknown;
7920             asterisk = TRUE;
7921         }
7922         if (*q == 'v') {
7923             q++;
7924             if (vectorize)
7925                 goto unknown;
7926             if ((vectorarg = asterisk)) {
7927                 evix = ewix;
7928                 ewix = 0;
7929                 asterisk = FALSE;
7930             }
7931             vectorize = TRUE;
7932             goto tryasterisk;
7933         }
7934
7935         if (!asterisk)
7936             EXPECT_NUMBER(q, width);
7937
7938         if (vectorize) {
7939             if (vectorarg) {
7940                 if (args)
7941                     vecsv = va_arg(*args, SV*);
7942                 else
7943                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
7944                         svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
7945                 dotstr = SvPVx(vecsv, dotstrlen);
7946                 if (DO_UTF8(vecsv))
7947                     is_utf8 = TRUE;
7948             }
7949             if (args) {
7950                 vecsv = va_arg(*args, SV*);
7951                 vecstr = (U8*)SvPVx(vecsv,veclen);
7952                 vec_utf8 = DO_UTF8(vecsv);
7953             }
7954             else if (efix ? efix <= svmax : svix < svmax) {
7955                 vecsv = svargs[efix ? efix-1 : svix++];
7956                 vecstr = (U8*)SvPVx(vecsv,veclen);
7957                 vec_utf8 = DO_UTF8(vecsv);
7958             }
7959             else {
7960                 vecstr = (U8*)"";
7961                 veclen = 0;
7962             }
7963         }
7964
7965         if (asterisk) {
7966             if (args)
7967                 i = va_arg(*args, int);
7968             else
7969                 i = (ewix ? ewix <= svmax : svix < svmax) ?
7970                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7971             left |= (i < 0);
7972             width = (i < 0) ? -i : i;
7973         }
7974       gotwidth:
7975
7976         /* PRECISION */
7977
7978         if (*q == '.') {
7979             q++;
7980             if (*q == '*') {
7981                 q++;
7982                 if (EXPECT_NUMBER(q, epix) && *q++ != '$') /* epix currently unused */
7983                     goto unknown;
7984                 if (args)
7985                     i = va_arg(*args, int);
7986                 else
7987                     i = (ewix ? ewix <= svmax : svix < svmax)
7988                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7989                 precis = (i < 0) ? 0 : i;
7990             }
7991             else {
7992                 precis = 0;
7993                 while (isDIGIT(*q))
7994                     precis = precis * 10 + (*q++ - '0');
7995             }
7996             has_precis = TRUE;
7997         }
7998
7999         /* SIZE */
8000
8001         switch (*q) {
8002 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
8003         case 'L':                       /* Ld */
8004             /* FALL THROUGH */
8005 #endif
8006 #ifdef HAS_QUAD
8007         case 'q':                       /* qd */
8008             intsize = 'q';
8009             q++;
8010             break;
8011 #endif
8012         case 'l':
8013 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
8014              if (*(q + 1) == 'l') {     /* lld, llf */
8015                 intsize = 'q';
8016                 q += 2;
8017                 break;
8018              }
8019 #endif
8020             /* FALL THROUGH */
8021         case 'h':
8022             /* FALL THROUGH */
8023         case 'V':
8024             intsize = *q++;
8025             break;
8026         }
8027
8028         /* CONVERSION */
8029
8030         if (*q == '%') {
8031             eptr = q++;
8032             elen = 1;
8033             goto string;
8034         }
8035
8036         if (!args)
8037             argsv = (efix ? efix <= svmax : svix < svmax) ?
8038                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8039
8040         switch (c = *q++) {
8041
8042             /* STRINGS */
8043
8044         case 'c':
8045             uv = args ? va_arg(*args, int) : SvIVx(argsv);
8046             if ((uv > 255 ||
8047                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8048                 && !IN_BYTES) {
8049                 eptr = (char*)utf8buf;
8050                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8051                 is_utf8 = TRUE;
8052             }
8053             else {
8054                 c = (char)uv;
8055                 eptr = &c;
8056                 elen = 1;
8057             }
8058             goto string;
8059
8060         case 's':
8061             if (args) {
8062                 eptr = va_arg(*args, char*);
8063                 if (eptr)
8064 #ifdef MACOS_TRADITIONAL
8065                   /* On MacOS, %#s format is used for Pascal strings */
8066                   if (alt)
8067                     elen = *eptr++;
8068                   else
8069 #endif
8070                     elen = strlen(eptr);
8071                 else {
8072                     eptr = nullstr;
8073                     elen = sizeof nullstr - 1;
8074                 }
8075             }
8076             else {
8077                 eptr = SvPVx(argsv, elen);
8078                 if (DO_UTF8(argsv)) {
8079                     if (has_precis && precis < elen) {
8080                         I32 p = precis;
8081                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8082                         precis = p;
8083                     }
8084                     if (width) { /* fudge width (can't fudge elen) */
8085                         width += elen - sv_len_utf8(argsv);
8086                     }
8087                     is_utf8 = TRUE;
8088                 }
8089             }
8090             goto string;
8091
8092         case '_':
8093             /*
8094              * The "%_" hack might have to be changed someday,
8095              * if ISO or ANSI decide to use '_' for something.
8096              * So we keep it hidden from users' code.
8097              */
8098             if (!args)
8099                 goto unknown;
8100             argsv = va_arg(*args, SV*);
8101             eptr = SvPVx(argsv, elen);
8102             if (DO_UTF8(argsv))
8103                 is_utf8 = TRUE;
8104
8105         string:
8106             vectorize = FALSE;
8107             if (has_precis && elen > precis)
8108                 elen = precis;
8109             break;
8110
8111             /* INTEGERS */
8112
8113         case 'p':
8114             if (alt)
8115                 goto unknown;
8116             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8117             base = 16;
8118             goto integer;
8119
8120         case 'D':
8121 #ifdef IV_IS_QUAD
8122             intsize = 'q';
8123 #else
8124             intsize = 'l';
8125 #endif
8126             /* FALL THROUGH */
8127         case 'd':
8128         case 'i':
8129             if (vectorize) {
8130                 STRLEN ulen;
8131                 if (!veclen)
8132                     continue;
8133                 if (vec_utf8)
8134                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8135                                         UTF8_ALLOW_ANYUV);
8136                 else {
8137                     uv = *vecstr;
8138                     ulen = 1;
8139                 }
8140                 vecstr += ulen;
8141                 veclen -= ulen;
8142                 if (plus)
8143                      esignbuf[esignlen++] = plus;
8144             }
8145             else if (args) {
8146                 switch (intsize) {
8147                 case 'h':       iv = (short)va_arg(*args, int); break;
8148                 default:        iv = va_arg(*args, int); break;
8149                 case 'l':       iv = va_arg(*args, long); break;
8150                 case 'V':       iv = va_arg(*args, IV); break;
8151 #ifdef HAS_QUAD
8152                 case 'q':       iv = va_arg(*args, Quad_t); break;
8153 #endif
8154                 }
8155             }
8156             else {
8157                 iv = SvIVx(argsv);
8158                 switch (intsize) {
8159                 case 'h':       iv = (short)iv; break;
8160                 default:        break;
8161                 case 'l':       iv = (long)iv; break;
8162                 case 'V':       break;
8163 #ifdef HAS_QUAD
8164                 case 'q':       iv = (Quad_t)iv; break;
8165 #endif
8166                 }
8167             }
8168             if ( !vectorize )   /* we already set uv above */
8169             {
8170                 if (iv >= 0) {
8171                     uv = iv;
8172                     if (plus)
8173                         esignbuf[esignlen++] = plus;
8174                 }
8175                 else {
8176                     uv = -iv;
8177                     esignbuf[esignlen++] = '-';
8178                 }
8179             }
8180             base = 10;
8181             goto integer;
8182
8183         case 'U':
8184 #ifdef IV_IS_QUAD
8185             intsize = 'q';
8186 #else
8187             intsize = 'l';
8188 #endif
8189             /* FALL THROUGH */
8190         case 'u':
8191             base = 10;
8192             goto uns_integer;
8193
8194         case 'b':
8195             base = 2;
8196             goto uns_integer;
8197
8198         case 'O':
8199 #ifdef IV_IS_QUAD
8200             intsize = 'q';
8201 #else
8202             intsize = 'l';
8203 #endif
8204             /* FALL THROUGH */
8205         case 'o':
8206             base = 8;
8207             goto uns_integer;
8208
8209         case 'X':
8210         case 'x':
8211             base = 16;
8212
8213         uns_integer:
8214             if (vectorize) {
8215                 STRLEN ulen;
8216         vector:
8217                 if (!veclen)
8218                     continue;
8219                 if (vec_utf8)
8220                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8221                                         UTF8_ALLOW_ANYUV);
8222                 else {
8223                     uv = *vecstr;
8224                     ulen = 1;
8225                 }
8226                 vecstr += ulen;
8227                 veclen -= ulen;
8228             }
8229             else if (args) {
8230                 switch (intsize) {
8231                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
8232                 default:   uv = va_arg(*args, unsigned); break;
8233                 case 'l':  uv = va_arg(*args, unsigned long); break;
8234                 case 'V':  uv = va_arg(*args, UV); break;
8235 #ifdef HAS_QUAD
8236                 case 'q':  uv = va_arg(*args, Quad_t); break;
8237 #endif
8238                 }
8239             }
8240             else {
8241                 uv = SvUVx(argsv);
8242                 switch (intsize) {
8243                 case 'h':       uv = (unsigned short)uv; break;
8244                 default:        break;
8245                 case 'l':       uv = (unsigned long)uv; break;
8246                 case 'V':       break;
8247 #ifdef HAS_QUAD
8248                 case 'q':       uv = (Quad_t)uv; break;
8249 #endif
8250                 }
8251             }
8252
8253         integer:
8254             eptr = ebuf + sizeof ebuf;
8255             switch (base) {
8256                 unsigned dig;
8257             case 16:
8258                 if (!uv)
8259                     alt = FALSE;
8260                 p = (char*)((c == 'X')
8261                             ? "0123456789ABCDEF" : "0123456789abcdef");
8262                 do {
8263                     dig = uv & 15;
8264                     *--eptr = p[dig];
8265                 } while (uv >>= 4);
8266                 if (alt) {
8267                     esignbuf[esignlen++] = '0';
8268                     esignbuf[esignlen++] = c;  /* 'x' or 'X' */
8269                 }
8270                 break;
8271             case 8:
8272                 do {
8273                     dig = uv & 7;
8274                     *--eptr = '0' + dig;
8275                 } while (uv >>= 3);
8276                 if (alt && *eptr != '0')
8277                     *--eptr = '0';
8278                 break;
8279             case 2:
8280                 do {
8281                     dig = uv & 1;
8282                     *--eptr = '0' + dig;
8283                 } while (uv >>= 1);
8284                 if (alt) {
8285                     esignbuf[esignlen++] = '0';
8286                     esignbuf[esignlen++] = 'b';
8287                 }
8288                 break;
8289             default:            /* it had better be ten or less */
8290 #if defined(PERL_Y2KWARN)
8291                 if (ckWARN(WARN_Y2K)) {
8292                     STRLEN n;
8293                     char *s = SvPV(sv,n);
8294                     if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8295                         && (n == 2 || !isDIGIT(s[n-3])))
8296                     {
8297                         Perl_warner(aTHX_ packWARN(WARN_Y2K),
8298                                     "Possible Y2K bug: %%%c %s",
8299                                     c, "format string following '19'");
8300                     }
8301                 }
8302 #endif
8303                 do {
8304                     dig = uv % base;
8305                     *--eptr = '0' + dig;
8306                 } while (uv /= base);
8307                 break;
8308             }
8309             elen = (ebuf + sizeof ebuf) - eptr;
8310             if (has_precis) {
8311                 if (precis > elen)
8312                     zeros = precis - elen;
8313                 else if (precis == 0 && elen == 1 && *eptr == '0')
8314                     elen = 0;
8315             }
8316             break;
8317
8318             /* FLOATING POINT */
8319
8320         case 'F':
8321             c = 'f';            /* maybe %F isn't supported here */
8322             /* FALL THROUGH */
8323         case 'e': case 'E':
8324         case 'f':
8325         case 'g': case 'G':
8326
8327             /* This is evil, but floating point is even more evil */
8328
8329             vectorize = FALSE;
8330             nv = args ? va_arg(*args, NV) : SvNVx(argsv);
8331
8332             need = 0;
8333             if (c != 'e' && c != 'E') {
8334                 i = PERL_INT_MIN;
8335                 (void)Perl_frexp(nv, &i);
8336                 if (i == PERL_INT_MIN)
8337                     Perl_die(aTHX_ "panic: frexp");
8338                 if (i > 0)
8339                     need = BIT_DIGITS(i);
8340             }
8341             need += has_precis ? precis : 6; /* known default */
8342             if (need < width)
8343                 need = width;
8344
8345             need += 20; /* fudge factor */
8346             if (PL_efloatsize < need) {
8347                 Safefree(PL_efloatbuf);
8348                 PL_efloatsize = need + 20; /* more fudge */
8349                 New(906, PL_efloatbuf, PL_efloatsize, char);
8350                 PL_efloatbuf[0] = '\0';
8351             }
8352
8353             eptr = ebuf + sizeof ebuf;
8354             *--eptr = '\0';
8355             *--eptr = c;
8356 #if defined(USE_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8357             {
8358                 /* Copy the one or more characters in a long double
8359                  * format before the 'base' ([efgEFG]) character to
8360                  * the format string. */
8361                 static char const prifldbl[] = PERL_PRIfldbl;
8362                 char const *p = prifldbl + sizeof(prifldbl) - 3;
8363                 while (p >= prifldbl) { *--eptr = *p--; }
8364             }
8365 #endif
8366             if (has_precis) {
8367                 base = precis;
8368                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8369                 *--eptr = '.';
8370             }
8371             if (width) {
8372                 base = width;
8373                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8374             }
8375             if (fill == '0')
8376                 *--eptr = fill;
8377             if (left)
8378                 *--eptr = '-';
8379             if (plus)
8380                 *--eptr = plus;
8381             if (alt)
8382                 *--eptr = '#';
8383             *--eptr = '%';
8384
8385             /* No taint.  Otherwise we are in the strange situation
8386              * where printf() taints but print($float) doesn't.
8387              * --jhi */
8388             (void)sprintf(PL_efloatbuf, eptr, nv);
8389
8390             eptr = PL_efloatbuf;
8391             elen = strlen(PL_efloatbuf);
8392             break;
8393
8394             /* SPECIAL */
8395
8396         case 'n':
8397             vectorize = FALSE;
8398             i = SvCUR(sv) - origlen;
8399             if (args) {
8400                 switch (intsize) {
8401                 case 'h':       *(va_arg(*args, short*)) = i; break;
8402                 default:        *(va_arg(*args, int*)) = i; break;
8403                 case 'l':       *(va_arg(*args, long*)) = i; break;
8404                 case 'V':       *(va_arg(*args, IV*)) = i; break;
8405 #ifdef HAS_QUAD
8406                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
8407 #endif
8408                 }
8409             }
8410             else
8411                 sv_setuv_mg(argsv, (UV)i);
8412             continue;   /* not "break" */
8413
8414             /* UNKNOWN */
8415
8416         default:
8417       unknown:
8418             vectorize = FALSE;
8419             if (!args && ckWARN(WARN_PRINTF) &&
8420                   (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8421                 SV *msg = sv_newmortal();
8422                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %s: ",
8423                           (PL_op->op_type == OP_PRTF) ? "printf" : "sprintf");
8424                 if (c) {
8425                     if (isPRINT(c))
8426                         Perl_sv_catpvf(aTHX_ msg,
8427                                        "\"%%%c\"", c & 0xFF);
8428                     else
8429                         Perl_sv_catpvf(aTHX_ msg,
8430                                        "\"%%\\%03"UVof"\"",
8431                                        (UV)c & 0xFF);
8432                 } else
8433                     sv_catpv(msg, "end of string");
8434                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8435             }
8436
8437             /* output mangled stuff ... */
8438             if (c == '\0')
8439                 --q;
8440             eptr = p;
8441             elen = q - p;
8442
8443             /* ... right here, because formatting flags should not apply */
8444             SvGROW(sv, SvCUR(sv) + elen + 1);
8445             p = SvEND(sv);
8446             Copy(eptr, p, elen, char);
8447             p += elen;
8448             *p = '\0';
8449             SvCUR(sv) = p - SvPVX(sv);
8450             continue;   /* not "break" */
8451         }
8452
8453         if (is_utf8 != has_utf8) {
8454              if (is_utf8) {
8455                   if (SvCUR(sv))
8456                        sv_utf8_upgrade(sv);
8457              }
8458              else {
8459                   SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
8460                   sv_utf8_upgrade(nsv);
8461                   eptr = SvPVX(nsv);
8462                   elen = SvCUR(nsv);
8463              }
8464              SvGROW(sv, SvCUR(sv) + elen + 1);
8465              p = SvEND(sv);
8466              *p = '\0';
8467         }
8468         
8469         have = esignlen + zeros + elen;
8470         need = (have > width ? have : width);
8471         gap = need - have;
8472
8473         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8474         p = SvEND(sv);
8475         if (esignlen && fill == '0') {
8476             for (i = 0; i < esignlen; i++)
8477                 *p++ = esignbuf[i];
8478         }
8479         if (gap && !left) {
8480             memset(p, fill, gap);
8481             p += gap;
8482         }
8483         if (esignlen && fill != '0') {
8484             for (i = 0; i < esignlen; i++)
8485                 *p++ = esignbuf[i];
8486         }
8487         if (zeros) {
8488             for (i = zeros; i; i--)
8489                 *p++ = '0';
8490         }
8491         if (elen) {
8492             Copy(eptr, p, elen, char);
8493             p += elen;
8494         }
8495         if (gap && left) {
8496             memset(p, ' ', gap);
8497             p += gap;
8498         }
8499         if (vectorize) {
8500             if (veclen) {
8501                 Copy(dotstr, p, dotstrlen, char);
8502                 p += dotstrlen;
8503             }
8504             else
8505                 vectorize = FALSE;              /* done iterating over vecstr */
8506         }
8507         if (is_utf8)
8508             has_utf8 = TRUE;
8509         if (has_utf8)
8510             SvUTF8_on(sv);
8511         *p = '\0';
8512         SvCUR(sv) = p - SvPVX(sv);
8513         if (vectorize) {
8514             esignlen = 0;
8515             goto vector;
8516         }
8517     }
8518 }
8519
8520 /* =========================================================================
8521
8522 =head1 Cloning an interpreter
8523
8524 All the macros and functions in this section are for the private use of
8525 the main function, perl_clone().
8526
8527 The foo_dup() functions make an exact copy of an existing foo thinngy.
8528 During the course of a cloning, a hash table is used to map old addresses
8529 to new addresses. The table is created and manipulated with the
8530 ptr_table_* functions.
8531
8532 =cut
8533
8534 ============================================================================*/
8535
8536
8537 #if defined(USE_ITHREADS)
8538
8539 #if defined(USE_5005THREADS)
8540 #  include "error: USE_5005THREADS and USE_ITHREADS are incompatible"
8541 #endif
8542
8543 #ifndef GpREFCNT_inc
8544 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8545 #endif
8546
8547
8548 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8549 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
8550 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8551 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
8552 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8553 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
8554 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8555 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
8556 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8557 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
8558 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8559 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
8560 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
8561
8562
8563 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8564    regcomp.c. AMS 20010712 */
8565
8566 REGEXP *
8567 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
8568 {
8569     REGEXP *ret;
8570     int i, len, npar;
8571     struct reg_substr_datum *s;
8572
8573     if (!r)
8574         return (REGEXP *)NULL;
8575
8576     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8577         return ret;
8578
8579     len = r->offsets[0];
8580     npar = r->nparens+1;
8581
8582     Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8583     Copy(r->program, ret->program, len+1, regnode);
8584
8585     New(0, ret->startp, npar, I32);
8586     Copy(r->startp, ret->startp, npar, I32);
8587     New(0, ret->endp, npar, I32);
8588     Copy(r->startp, ret->startp, npar, I32);
8589
8590     New(0, ret->substrs, 1, struct reg_substr_data);
8591     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8592         s->min_offset = r->substrs->data[i].min_offset;
8593         s->max_offset = r->substrs->data[i].max_offset;
8594         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
8595         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8596     }
8597
8598     ret->regstclass = NULL;
8599     if (r->data) {
8600         struct reg_data *d;
8601         int count = r->data->count;
8602
8603         Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
8604                 char, struct reg_data);
8605         New(0, d->what, count, U8);
8606
8607         d->count = count;
8608         for (i = 0; i < count; i++) {
8609             d->what[i] = r->data->what[i];
8610             switch (d->what[i]) {
8611             case 's':
8612                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8613                 break;
8614             case 'p':
8615                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8616                 break;
8617             case 'f':
8618                 /* This is cheating. */
8619                 New(0, d->data[i], 1, struct regnode_charclass_class);
8620                 StructCopy(r->data->data[i], d->data[i],
8621                             struct regnode_charclass_class);
8622                 ret->regstclass = (regnode*)d->data[i];
8623                 break;
8624             case 'o':
8625                 /* Compiled op trees are readonly, and can thus be
8626                    shared without duplication. */
8627                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8628                 break;
8629             case 'n':
8630                 d->data[i] = r->data->data[i];
8631                 break;
8632             }
8633         }
8634
8635         ret->data = d;
8636     }
8637     else
8638         ret->data = NULL;
8639
8640     New(0, ret->offsets, 2*len+1, U32);
8641     Copy(r->offsets, ret->offsets, 2*len+1, U32);
8642
8643     ret->precomp        = SAVEPV(r->precomp);
8644     ret->refcnt         = r->refcnt;
8645     ret->minlen         = r->minlen;
8646     ret->prelen         = r->prelen;
8647     ret->nparens        = r->nparens;
8648     ret->lastparen      = r->lastparen;
8649     ret->lastcloseparen = r->lastcloseparen;
8650     ret->reganch        = r->reganch;
8651
8652     ret->sublen         = r->sublen;
8653
8654     if (RX_MATCH_COPIED(ret))
8655         ret->subbeg  = SAVEPV(r->subbeg);
8656     else
8657         ret->subbeg = Nullch;
8658
8659     ptr_table_store(PL_ptr_table, r, ret);
8660     return ret;
8661 }
8662
8663 /* duplicate a file handle */
8664
8665 PerlIO *
8666 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8667 {
8668     PerlIO *ret;
8669     if (!fp)
8670         return (PerlIO*)NULL;
8671
8672     /* look for it in the table first */
8673     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8674     if (ret)
8675         return ret;
8676
8677     /* create anew and remember what it is */
8678     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8679     ptr_table_store(PL_ptr_table, fp, ret);
8680     return ret;
8681 }
8682
8683 /* duplicate a directory handle */
8684
8685 DIR *
8686 Perl_dirp_dup(pTHX_ DIR *dp)
8687 {
8688     if (!dp)
8689         return (DIR*)NULL;
8690     /* XXX TODO */
8691     return dp;
8692 }
8693
8694 /* duplicate a typeglob */
8695
8696 GP *
8697 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8698 {
8699     GP *ret;
8700     if (!gp)
8701         return (GP*)NULL;
8702     /* look for it in the table first */
8703     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8704     if (ret)
8705         return ret;
8706
8707     /* create anew and remember what it is */
8708     Newz(0, ret, 1, GP);
8709     ptr_table_store(PL_ptr_table, gp, ret);
8710
8711     /* clone */
8712     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
8713     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
8714     ret->gp_io          = io_dup_inc(gp->gp_io, param);
8715     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
8716     ret->gp_av          = av_dup_inc(gp->gp_av, param);
8717     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
8718     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8719     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
8720     ret->gp_cvgen       = gp->gp_cvgen;
8721     ret->gp_flags       = gp->gp_flags;
8722     ret->gp_line        = gp->gp_line;
8723     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
8724     return ret;
8725 }
8726
8727 /* duplicate a chain of magic */
8728
8729 MAGIC *
8730 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8731 {
8732     MAGIC *mgprev = (MAGIC*)NULL;
8733     MAGIC *mgret;
8734     if (!mg)
8735         return (MAGIC*)NULL;
8736     /* look for it in the table first */
8737     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8738     if (mgret)
8739         return mgret;
8740
8741     for (; mg; mg = mg->mg_moremagic) {
8742         MAGIC *nmg;
8743         Newz(0, nmg, 1, MAGIC);
8744         if (mgprev)
8745             mgprev->mg_moremagic = nmg;
8746         else
8747             mgret = nmg;
8748         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
8749         nmg->mg_private = mg->mg_private;
8750         nmg->mg_type    = mg->mg_type;
8751         nmg->mg_flags   = mg->mg_flags;
8752         if (mg->mg_type == PERL_MAGIC_qr) {
8753             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8754         }
8755         else if(mg->mg_type == PERL_MAGIC_backref) {
8756              AV *av = (AV*) mg->mg_obj;
8757              SV **svp;
8758              I32 i;
8759              nmg->mg_obj = (SV*)newAV();
8760              svp = AvARRAY(av);
8761              i = AvFILLp(av);
8762              while (i >= 0) {
8763                   av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8764                   i--;
8765              }
8766         }
8767         else {
8768             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8769                               ? sv_dup_inc(mg->mg_obj, param)
8770                               : sv_dup(mg->mg_obj, param);
8771         }
8772         nmg->mg_len     = mg->mg_len;
8773         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
8774         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8775             if (mg->mg_len > 0) {
8776                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
8777                 if (mg->mg_type == PERL_MAGIC_overload_table &&
8778                         AMT_AMAGIC((AMT*)mg->mg_ptr))
8779                 {
8780                     AMT *amtp = (AMT*)mg->mg_ptr;
8781                     AMT *namtp = (AMT*)nmg->mg_ptr;
8782                     I32 i;
8783                     for (i = 1; i < NofAMmeth; i++) {
8784                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
8785                     }
8786                 }
8787             }
8788             else if (mg->mg_len == HEf_SVKEY)
8789                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
8790         }
8791         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
8792             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
8793         }
8794         mgprev = nmg;
8795     }
8796     return mgret;
8797 }
8798
8799 /* create a new pointer-mapping table */
8800
8801 PTR_TBL_t *
8802 Perl_ptr_table_new(pTHX)
8803 {
8804     PTR_TBL_t *tbl;
8805     Newz(0, tbl, 1, PTR_TBL_t);
8806     tbl->tbl_max        = 511;
8807     tbl->tbl_items      = 0;
8808     Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
8809     return tbl;
8810 }
8811
8812 /* map an existing pointer using a table */
8813
8814 void *
8815 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
8816 {
8817     PTR_TBL_ENT_t *tblent;
8818     UV hash = PTR2UV(sv);
8819     assert(tbl);
8820     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
8821     for (; tblent; tblent = tblent->next) {
8822         if (tblent->oldval == sv)
8823             return tblent->newval;
8824     }
8825     return (void*)NULL;
8826 }
8827
8828 /* add a new entry to a pointer-mapping table */
8829
8830 void
8831 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
8832 {
8833     PTR_TBL_ENT_t *tblent, **otblent;
8834     /* XXX this may be pessimal on platforms where pointers aren't good
8835      * hash values e.g. if they grow faster in the most significant
8836      * bits */
8837     UV hash = PTR2UV(oldv);
8838     bool i = 1;
8839
8840     assert(tbl);
8841     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
8842     for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
8843         if (tblent->oldval == oldv) {
8844             tblent->newval = newv;
8845             tbl->tbl_items++;
8846             return;
8847         }
8848     }
8849     Newz(0, tblent, 1, PTR_TBL_ENT_t);
8850     tblent->oldval = oldv;
8851     tblent->newval = newv;
8852     tblent->next = *otblent;
8853     *otblent = tblent;
8854     tbl->tbl_items++;
8855     if (i && tbl->tbl_items > tbl->tbl_max)
8856         ptr_table_split(tbl);
8857 }
8858
8859 /* double the hash bucket size of an existing ptr table */
8860
8861 void
8862 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
8863 {
8864     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
8865     UV oldsize = tbl->tbl_max + 1;
8866     UV newsize = oldsize * 2;
8867     UV i;
8868
8869     Renew(ary, newsize, PTR_TBL_ENT_t*);
8870     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
8871     tbl->tbl_max = --newsize;
8872     tbl->tbl_ary = ary;
8873     for (i=0; i < oldsize; i++, ary++) {
8874         PTR_TBL_ENT_t **curentp, **entp, *ent;
8875         if (!*ary)
8876             continue;
8877         curentp = ary + oldsize;
8878         for (entp = ary, ent = *ary; ent; ent = *entp) {
8879             if ((newsize & PTR2UV(ent->oldval)) != i) {
8880                 *entp = ent->next;
8881                 ent->next = *curentp;
8882                 *curentp = ent;
8883                 continue;
8884             }
8885             else
8886                 entp = &ent->next;
8887         }
8888     }
8889 }
8890
8891 /* remove all the entries from a ptr table */
8892
8893 void
8894 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
8895 {
8896     register PTR_TBL_ENT_t **array;
8897     register PTR_TBL_ENT_t *entry;
8898     register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
8899     UV riter = 0;
8900     UV max;
8901
8902     if (!tbl || !tbl->tbl_items) {
8903         return;
8904     }
8905
8906     array = tbl->tbl_ary;
8907     entry = array[0];
8908     max = tbl->tbl_max;
8909
8910     for (;;) {
8911         if (entry) {
8912             oentry = entry;
8913             entry = entry->next;
8914             Safefree(oentry);
8915         }
8916         if (!entry) {
8917             if (++riter > max) {
8918                 break;
8919             }
8920             entry = array[riter];
8921         }
8922     }
8923
8924     tbl->tbl_items = 0;
8925 }
8926
8927 /* clear and free a ptr table */
8928
8929 void
8930 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
8931 {
8932     if (!tbl) {
8933         return;
8934     }
8935     ptr_table_clear(tbl);
8936     Safefree(tbl->tbl_ary);
8937     Safefree(tbl);
8938 }
8939
8940 #ifdef DEBUGGING
8941 char *PL_watch_pvx;
8942 #endif
8943
8944 /* attempt to make everything in the typeglob readonly */
8945
8946 STATIC SV *
8947 S_gv_share(pTHX_ SV *sstr)
8948 {
8949     GV *gv = (GV*)sstr;
8950     SV *sv = &PL_sv_no; /* just need SvREADONLY-ness */
8951
8952     if (GvIO(gv) || GvFORM(gv)) {
8953         GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
8954     }
8955     else if (!GvCV(gv)) {
8956         GvCV(gv) = (CV*)sv;
8957     }
8958     else {
8959         /* CvPADLISTs cannot be shared */
8960         if (!CvXSUB(GvCV(gv))) {
8961             GvUNIQUE_off(gv);
8962         }
8963     }
8964
8965     if (!GvUNIQUE(gv)) {
8966 #if 0
8967         PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
8968                       HvNAME(GvSTASH(gv)), GvNAME(gv));
8969 #endif
8970         return Nullsv;
8971     }
8972
8973     /*
8974      * write attempts will die with
8975      * "Modification of a read-only value attempted"
8976      */
8977     if (!GvSV(gv)) {
8978         GvSV(gv) = sv;
8979     }
8980     else {
8981         SvREADONLY_on(GvSV(gv));
8982     }
8983
8984     if (!GvAV(gv)) {
8985         GvAV(gv) = (AV*)sv;
8986     }
8987     else {
8988         SvREADONLY_on(GvAV(gv));
8989     }
8990
8991     if (!GvHV(gv)) {
8992         GvHV(gv) = (HV*)sv;
8993     }
8994     else {
8995         SvREADONLY_on(GvAV(gv));
8996     }
8997
8998     return sstr; /* he_dup() will SvREFCNT_inc() */
8999 }
9000
9001 /* duplicate an SV of any type (including AV, HV etc) */
9002
9003 void
9004 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9005 {
9006     if (SvROK(sstr)) {
9007         SvRV(dstr) = SvWEAKREF(sstr)
9008                      ? sv_dup(SvRV(sstr), param)
9009                      : sv_dup_inc(SvRV(sstr), param);
9010     }
9011     else if (SvPVX(sstr)) {
9012         /* Has something there */
9013         if (SvLEN(sstr)) {
9014             /* Normal PV - clone whole allocated space */
9015             SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9016         }
9017         else {
9018             /* Special case - not normally malloced for some reason */
9019             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9020                 /* A "shared" PV - clone it as unshared string */
9021                 SvFAKE_off(dstr);
9022                 SvREADONLY_off(dstr);
9023                 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9024             }
9025             else {
9026                 /* Some other special case - random pointer */
9027                 SvPVX(dstr) = SvPVX(sstr);              
9028             }
9029         }
9030     }
9031     else {
9032         /* Copy the Null */
9033         SvPVX(dstr) = SvPVX(sstr);
9034     }
9035 }
9036
9037 SV *
9038 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9039 {
9040     SV *dstr;
9041
9042     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9043         return Nullsv;
9044     /* look for it in the table first */
9045     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9046     if (dstr)
9047         return dstr;
9048
9049     /* create anew and remember what it is */
9050     new_SV(dstr);
9051     ptr_table_store(PL_ptr_table, sstr, dstr);
9052
9053     /* clone */
9054     SvFLAGS(dstr)       = SvFLAGS(sstr);
9055     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
9056     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
9057
9058 #ifdef DEBUGGING
9059     if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9060         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9061                       PL_watch_pvx, SvPVX(sstr));
9062 #endif
9063
9064     switch (SvTYPE(sstr)) {
9065     case SVt_NULL:
9066         SvANY(dstr)     = NULL;
9067         break;
9068     case SVt_IV:
9069         SvANY(dstr)     = new_XIV();
9070         SvIVX(dstr)     = SvIVX(sstr);
9071         break;
9072     case SVt_NV:
9073         SvANY(dstr)     = new_XNV();
9074         SvNVX(dstr)     = SvNVX(sstr);
9075         break;
9076     case SVt_RV:
9077         SvANY(dstr)     = new_XRV();
9078         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9079         break;
9080     case SVt_PV:
9081         SvANY(dstr)     = new_XPV();
9082         SvCUR(dstr)     = SvCUR(sstr);
9083         SvLEN(dstr)     = SvLEN(sstr);
9084         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9085         break;
9086     case SVt_PVIV:
9087         SvANY(dstr)     = new_XPVIV();
9088         SvCUR(dstr)     = SvCUR(sstr);
9089         SvLEN(dstr)     = SvLEN(sstr);
9090         SvIVX(dstr)     = SvIVX(sstr);
9091         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9092         break;
9093     case SVt_PVNV:
9094         SvANY(dstr)     = new_XPVNV();
9095         SvCUR(dstr)     = SvCUR(sstr);
9096         SvLEN(dstr)     = SvLEN(sstr);
9097         SvIVX(dstr)     = SvIVX(sstr);
9098         SvNVX(dstr)     = SvNVX(sstr);
9099         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9100         break;
9101     case SVt_PVMG:
9102         SvANY(dstr)     = new_XPVMG();
9103         SvCUR(dstr)     = SvCUR(sstr);
9104         SvLEN(dstr)     = SvLEN(sstr);
9105         SvIVX(dstr)     = SvIVX(sstr);
9106         SvNVX(dstr)     = SvNVX(sstr);
9107         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9108         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9109         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9110         break;
9111     case SVt_PVBM:
9112         SvANY(dstr)     = new_XPVBM();
9113         SvCUR(dstr)     = SvCUR(sstr);
9114         SvLEN(dstr)     = SvLEN(sstr);
9115         SvIVX(dstr)     = SvIVX(sstr);
9116         SvNVX(dstr)     = SvNVX(sstr);
9117         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9118         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9119         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9120         BmRARE(dstr)    = BmRARE(sstr);
9121         BmUSEFUL(dstr)  = BmUSEFUL(sstr);
9122         BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9123         break;
9124     case SVt_PVLV:
9125         SvANY(dstr)     = new_XPVLV();
9126         SvCUR(dstr)     = SvCUR(sstr);
9127         SvLEN(dstr)     = SvLEN(sstr);
9128         SvIVX(dstr)     = SvIVX(sstr);
9129         SvNVX(dstr)     = SvNVX(sstr);
9130         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9131         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9132         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9133         LvTARGOFF(dstr) = LvTARGOFF(sstr);      /* XXX sometimes holds PMOP* when DEBUGGING */
9134         LvTARGLEN(dstr) = LvTARGLEN(sstr);
9135         LvTARG(dstr)    = sv_dup_inc(LvTARG(sstr), param);
9136         LvTYPE(dstr)    = LvTYPE(sstr);
9137         break;
9138     case SVt_PVGV:
9139         if (GvUNIQUE((GV*)sstr)) {
9140             SV *share;
9141             if ((share = gv_share(sstr))) {
9142                 del_SV(dstr);
9143                 dstr = share;
9144 #if 0
9145                 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9146                               HvNAME(GvSTASH(share)), GvNAME(share));
9147 #endif
9148                 break;
9149             }
9150         }
9151         SvANY(dstr)     = new_XPVGV();
9152         SvCUR(dstr)     = SvCUR(sstr);
9153         SvLEN(dstr)     = SvLEN(sstr);
9154         SvIVX(dstr)     = SvIVX(sstr);
9155         SvNVX(dstr)     = SvNVX(sstr);
9156         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9157         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9158         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9159         GvNAMELEN(dstr) = GvNAMELEN(sstr);
9160         GvNAME(dstr)    = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9161         GvSTASH(dstr)   = hv_dup_inc(GvSTASH(sstr), param);
9162         GvFLAGS(dstr)   = GvFLAGS(sstr);
9163         GvGP(dstr)      = gp_dup(GvGP(sstr), param);
9164         (void)GpREFCNT_inc(GvGP(dstr));
9165         break;
9166     case SVt_PVIO:
9167         SvANY(dstr)     = new_XPVIO();
9168         SvCUR(dstr)     = SvCUR(sstr);
9169         SvLEN(dstr)     = SvLEN(sstr);
9170         SvIVX(dstr)     = SvIVX(sstr);
9171         SvNVX(dstr)     = SvNVX(sstr);
9172         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9173         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9174         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9175         IoIFP(dstr)     = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9176         if (IoOFP(sstr) == IoIFP(sstr))
9177             IoOFP(dstr) = IoIFP(dstr);
9178         else
9179             IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9180         /* PL_rsfp_filters entries have fake IoDIRP() */
9181         if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9182             IoDIRP(dstr)        = dirp_dup(IoDIRP(sstr));
9183         else
9184             IoDIRP(dstr)        = IoDIRP(sstr);
9185         IoLINES(dstr)           = IoLINES(sstr);
9186         IoPAGE(dstr)            = IoPAGE(sstr);
9187         IoPAGE_LEN(dstr)        = IoPAGE_LEN(sstr);
9188         IoLINES_LEFT(dstr)      = IoLINES_LEFT(sstr);
9189         IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(sstr));
9190         IoTOP_GV(dstr)          = gv_dup(IoTOP_GV(sstr), param);
9191         IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(sstr));
9192         IoFMT_GV(dstr)          = gv_dup(IoFMT_GV(sstr), param);
9193         IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(sstr));
9194         IoBOTTOM_GV(dstr)       = gv_dup(IoBOTTOM_GV(sstr), param);
9195         IoSUBPROCESS(dstr)      = IoSUBPROCESS(sstr);
9196         IoTYPE(dstr)            = IoTYPE(sstr);
9197         IoFLAGS(dstr)           = IoFLAGS(sstr);
9198         break;
9199     case SVt_PVAV:
9200         SvANY(dstr)     = new_XPVAV();
9201         SvCUR(dstr)     = SvCUR(sstr);
9202         SvLEN(dstr)     = SvLEN(sstr);
9203         SvIVX(dstr)     = SvIVX(sstr);
9204         SvNVX(dstr)     = SvNVX(sstr);
9205         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9206         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9207         AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9208         AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9209         if (AvARRAY((AV*)sstr)) {
9210             SV **dst_ary, **src_ary;
9211             SSize_t items = AvFILLp((AV*)sstr) + 1;
9212
9213             src_ary = AvARRAY((AV*)sstr);
9214             Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9215             ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9216             SvPVX(dstr) = (char*)dst_ary;
9217             AvALLOC((AV*)dstr) = dst_ary;
9218             if (AvREAL((AV*)sstr)) {
9219                 while (items-- > 0)
9220                     *dst_ary++ = sv_dup_inc(*src_ary++, param);
9221             }
9222             else {
9223                 while (items-- > 0)
9224                     *dst_ary++ = sv_dup(*src_ary++, param);
9225             }
9226             items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9227             while (items-- > 0) {
9228                 *dst_ary++ = &PL_sv_undef;
9229             }
9230         }
9231         else {
9232             SvPVX(dstr)         = Nullch;
9233             AvALLOC((AV*)dstr)  = (SV**)NULL;
9234         }
9235         break;
9236     case SVt_PVHV:
9237         SvANY(dstr)     = new_XPVHV();
9238         SvCUR(dstr)     = SvCUR(sstr);
9239         SvLEN(dstr)     = SvLEN(sstr);
9240         SvIVX(dstr)     = SvIVX(sstr);
9241         SvNVX(dstr)     = SvNVX(sstr);
9242         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9243         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9244         HvRITER((HV*)dstr)      = HvRITER((HV*)sstr);
9245         if (HvARRAY((HV*)sstr)) {
9246             STRLEN i = 0;
9247             XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9248             XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9249             Newz(0, dxhv->xhv_array,
9250                  PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9251             while (i <= sxhv->xhv_max) {
9252                 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9253                                                     !!HvSHAREKEYS(sstr), param);
9254                 ++i;
9255             }
9256             dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter, !!HvSHAREKEYS(sstr), param);
9257         }
9258         else {
9259             SvPVX(dstr)         = Nullch;
9260             HvEITER((HV*)dstr)  = (HE*)NULL;
9261         }
9262         HvPMROOT((HV*)dstr)     = HvPMROOT((HV*)sstr);          /* XXX */
9263         HvNAME((HV*)dstr)       = SAVEPV(HvNAME((HV*)sstr));
9264     /* Record stashes for possible cloning in Perl_clone(). */
9265         if(HvNAME((HV*)dstr))
9266             av_push(param->stashes, dstr);
9267         break;
9268     case SVt_PVFM:
9269         SvANY(dstr)     = new_XPVFM();
9270         FmLINES(dstr)   = FmLINES(sstr);
9271         goto dup_pvcv;
9272         /* NOTREACHED */
9273     case SVt_PVCV:
9274         SvANY(dstr)     = new_XPVCV();
9275         dup_pvcv:
9276         SvCUR(dstr)     = SvCUR(sstr);
9277         SvLEN(dstr)     = SvLEN(sstr);
9278         SvIVX(dstr)     = SvIVX(sstr);
9279         SvNVX(dstr)     = SvNVX(sstr);
9280         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9281         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9282         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9283         CvSTASH(dstr)   = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9284         CvSTART(dstr)   = CvSTART(sstr);
9285         CvROOT(dstr)    = OpREFCNT_inc(CvROOT(sstr));
9286         CvXSUB(dstr)    = CvXSUB(sstr);
9287         CvXSUBANY(dstr) = CvXSUBANY(sstr);
9288         if (CvCONST(sstr)) {
9289             CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9290                 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9291                 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9292         }
9293         CvGV(dstr)      = gv_dup(CvGV(sstr), param);
9294         if (param->flags & CLONEf_COPY_STACKS) {
9295           CvDEPTH(dstr) = CvDEPTH(sstr);
9296         } else {
9297           CvDEPTH(dstr) = 0;
9298         }
9299         if (CvPADLIST(sstr) && !AvREAL(CvPADLIST(sstr))) {
9300             /* XXX padlists are real, but pretend to be not */
9301             AvREAL_on(CvPADLIST(sstr));
9302             CvPADLIST(dstr)     = av_dup_inc(CvPADLIST(sstr), param);
9303             AvREAL_off(CvPADLIST(sstr));
9304             AvREAL_off(CvPADLIST(dstr));
9305         }
9306         else
9307             CvPADLIST(dstr)     = av_dup_inc(CvPADLIST(sstr), param);
9308         if (!CvANON(sstr) || CvCLONED(sstr))
9309             CvOUTSIDE(dstr)     = cv_dup_inc(CvOUTSIDE(sstr), param);
9310         else
9311             CvOUTSIDE(dstr)     = cv_dup(CvOUTSIDE(sstr), param);
9312         CvFLAGS(dstr)   = CvFLAGS(sstr);
9313         CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9314         break;
9315     default:
9316         Perl_croak(aTHX_ "Bizarre SvTYPE [%d]", SvTYPE(sstr));
9317         break;
9318     }
9319
9320     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9321         ++PL_sv_objcount;
9322
9323     return dstr;
9324  }
9325
9326 /* duplicate a context */
9327
9328 PERL_CONTEXT *
9329 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9330 {
9331     PERL_CONTEXT *ncxs;
9332
9333     if (!cxs)
9334         return (PERL_CONTEXT*)NULL;
9335
9336     /* look for it in the table first */
9337     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9338     if (ncxs)
9339         return ncxs;
9340
9341     /* create anew and remember what it is */
9342     Newz(56, ncxs, max + 1, PERL_CONTEXT);
9343     ptr_table_store(PL_ptr_table, cxs, ncxs);
9344
9345     while (ix >= 0) {
9346         PERL_CONTEXT *cx = &cxs[ix];
9347         PERL_CONTEXT *ncx = &ncxs[ix];
9348         ncx->cx_type    = cx->cx_type;
9349         if (CxTYPE(cx) == CXt_SUBST) {
9350             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9351         }
9352         else {
9353             ncx->blk_oldsp      = cx->blk_oldsp;
9354             ncx->blk_oldcop     = cx->blk_oldcop;
9355             ncx->blk_oldretsp   = cx->blk_oldretsp;
9356             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
9357             ncx->blk_oldscopesp = cx->blk_oldscopesp;
9358             ncx->blk_oldpm      = cx->blk_oldpm;
9359             ncx->blk_gimme      = cx->blk_gimme;
9360             switch (CxTYPE(cx)) {
9361             case CXt_SUB:
9362                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
9363                                            ? cv_dup_inc(cx->blk_sub.cv, param)
9364                                            : cv_dup(cx->blk_sub.cv,param));
9365                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
9366                                            ? av_dup_inc(cx->blk_sub.argarray, param)
9367                                            : Nullav);
9368                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
9369                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
9370                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
9371                 ncx->blk_sub.lval       = cx->blk_sub.lval;
9372                 break;
9373             case CXt_EVAL:
9374                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9375                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9376                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);;
9377                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9378                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
9379                 break;
9380             case CXt_LOOP:
9381                 ncx->blk_loop.label     = cx->blk_loop.label;
9382                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
9383                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
9384                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
9385                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
9386                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
9387                                            ? cx->blk_loop.iterdata
9388                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
9389                 ncx->blk_loop.oldcurpad
9390                     = (SV**)ptr_table_fetch(PL_ptr_table,
9391                                             cx->blk_loop.oldcurpad);
9392                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
9393                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
9394                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
9395                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
9396                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
9397                 break;
9398             case CXt_FORMAT:
9399                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
9400                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
9401                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9402                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
9403                 break;
9404             case CXt_BLOCK:
9405             case CXt_NULL:
9406                 break;
9407             }
9408         }
9409         --ix;
9410     }
9411     return ncxs;
9412 }
9413
9414 /* duplicate a stack info structure */
9415
9416 PERL_SI *
9417 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9418 {
9419     PERL_SI *nsi;
9420
9421     if (!si)
9422         return (PERL_SI*)NULL;
9423
9424     /* look for it in the table first */
9425     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9426     if (nsi)
9427         return nsi;
9428
9429     /* create anew and remember what it is */
9430     Newz(56, nsi, 1, PERL_SI);
9431     ptr_table_store(PL_ptr_table, si, nsi);
9432
9433     nsi->si_stack       = av_dup_inc(si->si_stack, param);
9434     nsi->si_cxix        = si->si_cxix;
9435     nsi->si_cxmax       = si->si_cxmax;
9436     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9437     nsi->si_type        = si->si_type;
9438     nsi->si_prev        = si_dup(si->si_prev, param);
9439     nsi->si_next        = si_dup(si->si_next, param);
9440     nsi->si_markoff     = si->si_markoff;
9441
9442     return nsi;
9443 }
9444
9445 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
9446 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
9447 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
9448 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
9449 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
9450 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
9451 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
9452 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
9453 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
9454 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
9455 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9456 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9457
9458 /* XXXXX todo */
9459 #define pv_dup_inc(p)   SAVEPV(p)
9460 #define pv_dup(p)       SAVEPV(p)
9461 #define svp_dup_inc(p,pp)       any_dup(p,pp)
9462
9463 /* map any object to the new equivent - either something in the
9464  * ptr table, or something in the interpreter structure
9465  */
9466
9467 void *
9468 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
9469 {
9470     void *ret;
9471
9472     if (!v)
9473         return (void*)NULL;
9474
9475     /* look for it in the table first */
9476     ret = ptr_table_fetch(PL_ptr_table, v);
9477     if (ret)
9478         return ret;
9479
9480     /* see if it is part of the interpreter structure */
9481     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9482         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9483     else {
9484         ret = v;
9485     }
9486
9487     return ret;
9488 }
9489
9490 /* duplicate the save stack */
9491
9492 ANY *
9493 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9494 {
9495     ANY *ss     = proto_perl->Tsavestack;
9496     I32 ix      = proto_perl->Tsavestack_ix;
9497     I32 max     = proto_perl->Tsavestack_max;
9498     ANY *nss;
9499     SV *sv;
9500     GV *gv;
9501     AV *av;
9502     HV *hv;
9503     void* ptr;
9504     int intval;
9505     long longval;
9506     GP *gp;
9507     IV iv;
9508     I32 i;
9509     char *c = NULL;
9510     void (*dptr) (void*);
9511     void (*dxptr) (pTHX_ void*);
9512     OP *o;
9513
9514     Newz(54, nss, max, ANY);
9515
9516     while (ix > 0) {
9517         i = POPINT(ss,ix);
9518         TOPINT(nss,ix) = i;
9519         switch (i) {
9520         case SAVEt_ITEM:                        /* normal string */
9521             sv = (SV*)POPPTR(ss,ix);
9522             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9523             sv = (SV*)POPPTR(ss,ix);
9524             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9525             break;
9526         case SAVEt_SV:                          /* scalar reference */
9527             sv = (SV*)POPPTR(ss,ix);
9528             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9529             gv = (GV*)POPPTR(ss,ix);
9530             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9531             break;
9532         case SAVEt_GENERIC_PVREF:               /* generic char* */
9533             c = (char*)POPPTR(ss,ix);
9534             TOPPTR(nss,ix) = pv_dup(c);
9535             ptr = POPPTR(ss,ix);
9536             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9537             break;
9538         case SAVEt_SHARED_PVREF:                /* char* in shared space */
9539             c = (char*)POPPTR(ss,ix);
9540             TOPPTR(nss,ix) = savesharedpv(c);
9541             ptr = POPPTR(ss,ix);
9542             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9543             break;
9544         case SAVEt_GENERIC_SVREF:               /* generic sv */
9545         case SAVEt_SVREF:                       /* scalar reference */
9546             sv = (SV*)POPPTR(ss,ix);
9547             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9548             ptr = POPPTR(ss,ix);
9549             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9550             break;
9551         case SAVEt_AV:                          /* array reference */
9552             av = (AV*)POPPTR(ss,ix);
9553             TOPPTR(nss,ix) = av_dup_inc(av, param);
9554             gv = (GV*)POPPTR(ss,ix);
9555             TOPPTR(nss,ix) = gv_dup(gv, param);
9556             break;
9557         case SAVEt_HV:                          /* hash reference */
9558             hv = (HV*)POPPTR(ss,ix);
9559             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9560             gv = (GV*)POPPTR(ss,ix);
9561             TOPPTR(nss,ix) = gv_dup(gv, param);
9562             break;
9563         case SAVEt_INT:                         /* int reference */
9564             ptr = POPPTR(ss,ix);
9565             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9566             intval = (int)POPINT(ss,ix);
9567             TOPINT(nss,ix) = intval;
9568             break;
9569         case SAVEt_LONG:                        /* long reference */
9570             ptr = POPPTR(ss,ix);
9571             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9572             longval = (long)POPLONG(ss,ix);
9573             TOPLONG(nss,ix) = longval;
9574             break;
9575         case SAVEt_I32:                         /* I32 reference */
9576         case SAVEt_I16:                         /* I16 reference */
9577         case SAVEt_I8:                          /* I8 reference */
9578             ptr = POPPTR(ss,ix);
9579             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9580             i = POPINT(ss,ix);
9581             TOPINT(nss,ix) = i;
9582             break;
9583         case SAVEt_IV:                          /* IV reference */
9584             ptr = POPPTR(ss,ix);
9585             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9586             iv = POPIV(ss,ix);
9587             TOPIV(nss,ix) = iv;
9588             break;
9589         case SAVEt_SPTR:                        /* SV* reference */
9590             ptr = POPPTR(ss,ix);
9591             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9592             sv = (SV*)POPPTR(ss,ix);
9593             TOPPTR(nss,ix) = sv_dup(sv, param);
9594             break;
9595         case SAVEt_VPTR:                        /* random* reference */
9596             ptr = POPPTR(ss,ix);
9597             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9598             ptr = POPPTR(ss,ix);
9599             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9600             break;
9601         case SAVEt_PPTR:                        /* char* reference */
9602             ptr = POPPTR(ss,ix);
9603             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9604             c = (char*)POPPTR(ss,ix);
9605             TOPPTR(nss,ix) = pv_dup(c);
9606             break;
9607         case SAVEt_HPTR:                        /* HV* reference */
9608             ptr = POPPTR(ss,ix);
9609             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9610             hv = (HV*)POPPTR(ss,ix);
9611             TOPPTR(nss,ix) = hv_dup(hv, param);
9612             break;
9613         case SAVEt_APTR:                        /* AV* reference */
9614             ptr = POPPTR(ss,ix);
9615             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9616             av = (AV*)POPPTR(ss,ix);
9617             TOPPTR(nss,ix) = av_dup(av, param);
9618             break;
9619         case SAVEt_NSTAB:
9620             gv = (GV*)POPPTR(ss,ix);
9621             TOPPTR(nss,ix) = gv_dup(gv, param);
9622             break;
9623         case SAVEt_GP:                          /* scalar reference */
9624             gp = (GP*)POPPTR(ss,ix);
9625             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9626             (void)GpREFCNT_inc(gp);
9627             gv = (GV*)POPPTR(ss,ix);
9628             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9629             c = (char*)POPPTR(ss,ix);
9630             TOPPTR(nss,ix) = pv_dup(c);
9631             iv = POPIV(ss,ix);
9632             TOPIV(nss,ix) = iv;
9633             iv = POPIV(ss,ix);
9634             TOPIV(nss,ix) = iv;
9635             break;
9636         case SAVEt_FREESV:
9637         case SAVEt_MORTALIZESV:
9638             sv = (SV*)POPPTR(ss,ix);
9639             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9640             break;
9641         case SAVEt_FREEOP:
9642             ptr = POPPTR(ss,ix);
9643             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9644                 /* these are assumed to be refcounted properly */
9645                 switch (((OP*)ptr)->op_type) {
9646                 case OP_LEAVESUB:
9647                 case OP_LEAVESUBLV:
9648                 case OP_LEAVEEVAL:
9649                 case OP_LEAVE:
9650                 case OP_SCOPE:
9651                 case OP_LEAVEWRITE:
9652                     TOPPTR(nss,ix) = ptr;
9653                     o = (OP*)ptr;
9654                     OpREFCNT_inc(o);
9655                     break;
9656                 default:
9657                     TOPPTR(nss,ix) = Nullop;
9658                     break;
9659                 }
9660             }
9661             else
9662                 TOPPTR(nss,ix) = Nullop;
9663             break;
9664         case SAVEt_FREEPV:
9665             c = (char*)POPPTR(ss,ix);
9666             TOPPTR(nss,ix) = pv_dup_inc(c);
9667             break;
9668         case SAVEt_CLEARSV:
9669             longval = POPLONG(ss,ix);
9670             TOPLONG(nss,ix) = longval;
9671             break;
9672         case SAVEt_DELETE:
9673             hv = (HV*)POPPTR(ss,ix);
9674             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9675             c = (char*)POPPTR(ss,ix);
9676             TOPPTR(nss,ix) = pv_dup_inc(c);
9677             i = POPINT(ss,ix);
9678             TOPINT(nss,ix) = i;
9679             break;
9680         case SAVEt_DESTRUCTOR:
9681             ptr = POPPTR(ss,ix);
9682             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
9683             dptr = POPDPTR(ss,ix);
9684             TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
9685             break;
9686         case SAVEt_DESTRUCTOR_X:
9687             ptr = POPPTR(ss,ix);
9688             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
9689             dxptr = POPDXPTR(ss,ix);
9690             TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
9691             break;
9692         case SAVEt_REGCONTEXT:
9693         case SAVEt_ALLOC:
9694             i = POPINT(ss,ix);
9695             TOPINT(nss,ix) = i;
9696             ix -= i;
9697             break;
9698         case SAVEt_STACK_POS:           /* Position on Perl stack */
9699             i = POPINT(ss,ix);
9700             TOPINT(nss,ix) = i;
9701             break;
9702         case SAVEt_AELEM:               /* array element */
9703             sv = (SV*)POPPTR(ss,ix);
9704             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9705             i = POPINT(ss,ix);
9706             TOPINT(nss,ix) = i;
9707             av = (AV*)POPPTR(ss,ix);
9708             TOPPTR(nss,ix) = av_dup_inc(av, param);
9709             break;
9710         case SAVEt_HELEM:               /* hash element */
9711             sv = (SV*)POPPTR(ss,ix);
9712             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9713             sv = (SV*)POPPTR(ss,ix);
9714             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9715             hv = (HV*)POPPTR(ss,ix);
9716             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9717             break;
9718         case SAVEt_OP:
9719             ptr = POPPTR(ss,ix);
9720             TOPPTR(nss,ix) = ptr;
9721             break;
9722         case SAVEt_HINTS:
9723             i = POPINT(ss,ix);
9724             TOPINT(nss,ix) = i;
9725             break;
9726         case SAVEt_COMPPAD:
9727             av = (AV*)POPPTR(ss,ix);
9728             TOPPTR(nss,ix) = av_dup(av, param);
9729             break;
9730         case SAVEt_PADSV:
9731             longval = (long)POPLONG(ss,ix);
9732             TOPLONG(nss,ix) = longval;
9733             ptr = POPPTR(ss,ix);
9734             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9735             sv = (SV*)POPPTR(ss,ix);
9736             TOPPTR(nss,ix) = sv_dup(sv, param);
9737             break;
9738         default:
9739             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9740         }
9741     }
9742
9743     return nss;
9744 }
9745
9746 /*
9747 =for apidoc perl_clone
9748
9749 Create and return a new interpreter by cloning the current one.
9750
9751 =cut
9752 */
9753
9754 /* XXX the above needs expanding by someone who actually understands it ! */
9755 EXTERN_C PerlInterpreter *
9756 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
9757
9758 PerlInterpreter *
9759 perl_clone(PerlInterpreter *proto_perl, UV flags)
9760 {
9761 #ifdef PERL_IMPLICIT_SYS
9762
9763    /* perlhost.h so we need to call into it
9764    to clone the host, CPerlHost should have a c interface, sky */
9765
9766    if (flags & CLONEf_CLONE_HOST) {
9767        return perl_clone_host(proto_perl,flags);
9768    }
9769    return perl_clone_using(proto_perl, flags,
9770                             proto_perl->IMem,
9771                             proto_perl->IMemShared,
9772                             proto_perl->IMemParse,
9773                             proto_perl->IEnv,
9774                             proto_perl->IStdIO,
9775                             proto_perl->ILIO,
9776                             proto_perl->IDir,
9777                             proto_perl->ISock,
9778                             proto_perl->IProc);
9779 }
9780
9781 PerlInterpreter *
9782 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
9783                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
9784                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
9785                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
9786                  struct IPerlDir* ipD, struct IPerlSock* ipS,
9787                  struct IPerlProc* ipP)
9788 {
9789     /* XXX many of the string copies here can be optimized if they're
9790      * constants; they need to be allocated as common memory and just
9791      * their pointers copied. */
9792
9793     IV i;
9794     CLONE_PARAMS clone_params;
9795     CLONE_PARAMS* param = &clone_params;
9796
9797     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9798     PERL_SET_THX(my_perl);
9799
9800 #  ifdef DEBUGGING
9801     memset(my_perl, 0xab, sizeof(PerlInterpreter));
9802     PL_markstack = 0;
9803     PL_scopestack = 0;
9804     PL_savestack = 0;
9805     PL_retstack = 0;
9806     PL_sig_pending = 0;
9807     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9808 #  else /* !DEBUGGING */
9809     Zero(my_perl, 1, PerlInterpreter);
9810 #  endif        /* DEBUGGING */
9811
9812     /* host pointers */
9813     PL_Mem              = ipM;
9814     PL_MemShared        = ipMS;
9815     PL_MemParse         = ipMP;
9816     PL_Env              = ipE;
9817     PL_StdIO            = ipStd;
9818     PL_LIO              = ipLIO;
9819     PL_Dir              = ipD;
9820     PL_Sock             = ipS;
9821     PL_Proc             = ipP;
9822 #else           /* !PERL_IMPLICIT_SYS */
9823     IV i;
9824     CLONE_PARAMS clone_params;
9825     CLONE_PARAMS* param = &clone_params;
9826     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9827     PERL_SET_THX(my_perl);
9828
9829
9830
9831 #    ifdef DEBUGGING
9832     memset(my_perl, 0xab, sizeof(PerlInterpreter));
9833     PL_markstack = 0;
9834     PL_scopestack = 0;
9835     PL_savestack = 0;
9836     PL_retstack = 0;
9837     PL_sig_pending = 0;
9838     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9839 #    else       /* !DEBUGGING */
9840     Zero(my_perl, 1, PerlInterpreter);
9841 #    endif      /* DEBUGGING */
9842 #endif          /* PERL_IMPLICIT_SYS */
9843     param->flags = flags;
9844
9845     /* arena roots */
9846     PL_xiv_arenaroot    = NULL;
9847     PL_xiv_root         = NULL;
9848     PL_xnv_arenaroot    = NULL;
9849     PL_xnv_root         = NULL;
9850     PL_xrv_arenaroot    = NULL;
9851     PL_xrv_root         = NULL;
9852     PL_xpv_arenaroot    = NULL;
9853     PL_xpv_root         = NULL;
9854     PL_xpviv_arenaroot  = NULL;
9855     PL_xpviv_root       = NULL;
9856     PL_xpvnv_arenaroot  = NULL;
9857     PL_xpvnv_root       = NULL;
9858     PL_xpvcv_arenaroot  = NULL;
9859     PL_xpvcv_root       = NULL;
9860     PL_xpvav_arenaroot  = NULL;
9861     PL_xpvav_root       = NULL;
9862     PL_xpvhv_arenaroot  = NULL;
9863     PL_xpvhv_root       = NULL;
9864     PL_xpvmg_arenaroot  = NULL;
9865     PL_xpvmg_root       = NULL;
9866     PL_xpvlv_arenaroot  = NULL;
9867     PL_xpvlv_root       = NULL;
9868     PL_xpvbm_arenaroot  = NULL;
9869     PL_xpvbm_root       = NULL;
9870     PL_he_arenaroot     = NULL;
9871     PL_he_root          = NULL;
9872     PL_nice_chunk       = NULL;
9873     PL_nice_chunk_size  = 0;
9874     PL_sv_count         = 0;
9875     PL_sv_objcount      = 0;
9876     PL_sv_root          = Nullsv;
9877     PL_sv_arenaroot     = Nullsv;
9878
9879     PL_debug            = proto_perl->Idebug;
9880
9881 #ifdef USE_REENTRANT_API
9882     Perl_reentrant_init(aTHX);
9883 #endif
9884
9885     /* create SV map for pointer relocation */
9886     PL_ptr_table = ptr_table_new();
9887
9888     /* initialize these special pointers as early as possible */
9889     SvANY(&PL_sv_undef)         = NULL;
9890     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
9891     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
9892     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
9893
9894     SvANY(&PL_sv_no)            = new_XPVNV();
9895     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
9896     SvFLAGS(&PL_sv_no)          = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9897     SvPVX(&PL_sv_no)            = SAVEPVN(PL_No, 0);
9898     SvCUR(&PL_sv_no)            = 0;
9899     SvLEN(&PL_sv_no)            = 1;
9900     SvNVX(&PL_sv_no)            = 0;
9901     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
9902
9903     SvANY(&PL_sv_yes)           = new_XPVNV();
9904     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
9905     SvFLAGS(&PL_sv_yes)         = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9906     SvPVX(&PL_sv_yes)           = SAVEPVN(PL_Yes, 1);
9907     SvCUR(&PL_sv_yes)           = 1;
9908     SvLEN(&PL_sv_yes)           = 2;
9909     SvNVX(&PL_sv_yes)           = 1;
9910     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
9911
9912     /* create (a non-shared!) shared string table */
9913     PL_strtab           = newHV();
9914     HvSHAREKEYS_off(PL_strtab);
9915     hv_ksplit(PL_strtab, 512);
9916     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
9917
9918     PL_compiling = proto_perl->Icompiling;
9919
9920     /* These two PVs will be free'd special way so must set them same way op.c does */
9921     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
9922     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
9923
9924     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
9925     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
9926
9927     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
9928     if (!specialWARN(PL_compiling.cop_warnings))
9929         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
9930     if (!specialCopIO(PL_compiling.cop_io))
9931         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
9932     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
9933
9934     /* pseudo environmental stuff */
9935     PL_origargc         = proto_perl->Iorigargc;
9936     i = PL_origargc;
9937     New(0, PL_origargv, i+1, char*);
9938     PL_origargv[i] = '\0';
9939     while (i-- > 0) {
9940         PL_origargv[i]  = SAVEPV(proto_perl->Iorigargv[i]);
9941     }
9942
9943     param->stashes      = newAV();  /* Setup array of objects to call clone on */
9944
9945 #ifdef PERLIO_LAYERS
9946     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
9947     PerlIO_clone(aTHX_ proto_perl, param);
9948 #endif
9949
9950     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
9951     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
9952     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
9953     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
9954     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
9955     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
9956
9957     /* switches */
9958     PL_minus_c          = proto_perl->Iminus_c;
9959     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
9960     PL_localpatches     = proto_perl->Ilocalpatches;
9961     PL_splitstr         = proto_perl->Isplitstr;
9962     PL_preprocess       = proto_perl->Ipreprocess;
9963     PL_minus_n          = proto_perl->Iminus_n;
9964     PL_minus_p          = proto_perl->Iminus_p;
9965     PL_minus_l          = proto_perl->Iminus_l;
9966     PL_minus_a          = proto_perl->Iminus_a;
9967     PL_minus_F          = proto_perl->Iminus_F;
9968     PL_doswitches       = proto_perl->Idoswitches;
9969     PL_dowarn           = proto_perl->Idowarn;
9970     PL_doextract        = proto_perl->Idoextract;
9971     PL_sawampersand     = proto_perl->Isawampersand;
9972     PL_unsafe           = proto_perl->Iunsafe;
9973     PL_inplace          = SAVEPV(proto_perl->Iinplace);
9974     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
9975     PL_perldb           = proto_perl->Iperldb;
9976     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
9977     PL_exit_flags       = proto_perl->Iexit_flags;
9978
9979     /* magical thingies */
9980     /* XXX time(&PL_basetime) when asked for? */
9981     PL_basetime         = proto_perl->Ibasetime;
9982     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
9983
9984     PL_maxsysfd         = proto_perl->Imaxsysfd;
9985     PL_multiline        = proto_perl->Imultiline;
9986     PL_statusvalue      = proto_perl->Istatusvalue;
9987 #ifdef VMS
9988     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
9989 #endif
9990     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
9991
9992 #ifdef DEBUGGING
9993     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
9994     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);
9995     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);
9996 #endif
9997
9998     /* Clone the regex array */
9999     PL_regex_padav = newAV();
10000     {
10001         I32 len = av_len((AV*)proto_perl->Iregex_padav);
10002         SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10003         av_push(PL_regex_padav,
10004                 sv_dup_inc(regexen[0],param));
10005         for(i = 1; i <= len; i++) {
10006             if(SvREPADTMP(regexen[i])) {
10007               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10008             } else {
10009                 av_push(PL_regex_padav,
10010                     SvREFCNT_inc(
10011                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10012                              SvIVX(regexen[i])), param)))
10013                        ));
10014             }
10015         }
10016     }
10017     PL_regex_pad = AvARRAY(PL_regex_padav);
10018
10019     /* shortcuts to various I/O objects */
10020     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
10021     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
10022     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
10023     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
10024     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
10025     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
10026
10027     /* shortcuts to regexp stuff */
10028     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
10029
10030     /* shortcuts to misc objects */
10031     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
10032
10033     /* shortcuts to debugging objects */
10034     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
10035     PL_DBline           = gv_dup(proto_perl->IDBline, param);
10036     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
10037     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
10038     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
10039     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
10040     PL_lineary          = av_dup(proto_perl->Ilineary, param);
10041     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
10042
10043     /* symbol tables */
10044     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
10045     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
10046     PL_nullstash       = hv_dup(proto_perl->Inullstash, param);
10047     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
10048     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
10049     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
10050
10051     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
10052     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
10053     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
10054     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
10055     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
10056
10057     PL_sub_generation   = proto_perl->Isub_generation;
10058
10059     /* funky return mechanisms */
10060     PL_forkprocess      = proto_perl->Iforkprocess;
10061
10062     /* subprocess state */
10063     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
10064
10065     /* internal state */
10066     PL_tainting         = proto_perl->Itainting;
10067     PL_maxo             = proto_perl->Imaxo;
10068     if (proto_perl->Iop_mask)
10069         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10070     else
10071         PL_op_mask      = Nullch;
10072
10073     /* current interpreter roots */
10074     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
10075     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
10076     PL_main_start       = proto_perl->Imain_start;
10077     PL_eval_root        = proto_perl->Ieval_root;
10078     PL_eval_start       = proto_perl->Ieval_start;
10079
10080     /* runtime control stuff */
10081     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10082     PL_copline          = proto_perl->Icopline;
10083
10084     PL_filemode         = proto_perl->Ifilemode;
10085     PL_lastfd           = proto_perl->Ilastfd;
10086     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
10087     PL_Argv             = NULL;
10088     PL_Cmd              = Nullch;
10089     PL_gensym           = proto_perl->Igensym;
10090     PL_preambled        = proto_perl->Ipreambled;
10091     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
10092     PL_laststatval      = proto_perl->Ilaststatval;
10093     PL_laststype        = proto_perl->Ilaststype;
10094     PL_mess_sv          = Nullsv;
10095
10096     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
10097     PL_ofmt             = SAVEPV(proto_perl->Iofmt);
10098
10099     /* interpreter atexit processing */
10100     PL_exitlistlen      = proto_perl->Iexitlistlen;
10101     if (PL_exitlistlen) {
10102         New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10103         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10104     }
10105     else
10106         PL_exitlist     = (PerlExitListEntry*)NULL;
10107     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
10108     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
10109     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10110
10111     PL_profiledata      = NULL;
10112     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
10113     /* PL_rsfp_filters entries have fake IoDIRP() */
10114     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
10115
10116     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
10117     PL_comppad                  = av_dup(proto_perl->Icomppad, param);
10118     PL_comppad_name             = av_dup(proto_perl->Icomppad_name, param);
10119     PL_comppad_name_fill        = proto_perl->Icomppad_name_fill;
10120     PL_comppad_name_floor       = proto_perl->Icomppad_name_floor;
10121     PL_curpad                   = (SV**)ptr_table_fetch(PL_ptr_table,
10122                                                         proto_perl->Tcurpad);
10123
10124 #ifdef HAVE_INTERP_INTERN
10125     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10126 #endif
10127
10128     /* more statics moved here */
10129     PL_generation       = proto_perl->Igeneration;
10130     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
10131
10132     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
10133     PL_in_clean_all     = proto_perl->Iin_clean_all;
10134
10135     PL_uid              = proto_perl->Iuid;
10136     PL_euid             = proto_perl->Ieuid;
10137     PL_gid              = proto_perl->Igid;
10138     PL_egid             = proto_perl->Iegid;
10139     PL_nomemok          = proto_perl->Inomemok;
10140     PL_an               = proto_perl->Ian;
10141     PL_cop_seqmax       = proto_perl->Icop_seqmax;
10142     PL_op_seqmax        = proto_perl->Iop_seqmax;
10143     PL_evalseq          = proto_perl->Ievalseq;
10144     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
10145     PL_origalen         = proto_perl->Iorigalen;
10146     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
10147     PL_osname           = SAVEPV(proto_perl->Iosname);
10148     PL_sh_path          = proto_perl->Ish_path; /* XXX never deallocated */
10149     PL_sighandlerp      = proto_perl->Isighandlerp;
10150
10151
10152     PL_runops           = proto_perl->Irunops;
10153
10154     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10155
10156 #ifdef CSH
10157     PL_cshlen           = proto_perl->Icshlen;
10158     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
10159 #endif
10160
10161     PL_lex_state        = proto_perl->Ilex_state;
10162     PL_lex_defer        = proto_perl->Ilex_defer;
10163     PL_lex_expect       = proto_perl->Ilex_expect;
10164     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
10165     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
10166     PL_lex_starts       = proto_perl->Ilex_starts;
10167     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
10168     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
10169     PL_lex_op           = proto_perl->Ilex_op;
10170     PL_lex_inpat        = proto_perl->Ilex_inpat;
10171     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
10172     PL_lex_brackets     = proto_perl->Ilex_brackets;
10173     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10174     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
10175     PL_lex_casemods     = proto_perl->Ilex_casemods;
10176     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10177     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
10178
10179     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10180     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10181     PL_nexttoke         = proto_perl->Inexttoke;
10182
10183     PL_linestr          = sv_dup_inc(proto_perl->Ilinestr, param);
10184     i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10185     PL_bufptr           = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10186     i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10187     PL_oldbufptr        = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10188     i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10189     PL_oldoldbufptr     = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10190     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10191     i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10192     PL_linestart        = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10193     PL_pending_ident    = proto_perl->Ipending_ident;
10194     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
10195
10196     PL_expect           = proto_perl->Iexpect;
10197
10198     PL_multi_start      = proto_perl->Imulti_start;
10199     PL_multi_end        = proto_perl->Imulti_end;
10200     PL_multi_open       = proto_perl->Imulti_open;
10201     PL_multi_close      = proto_perl->Imulti_close;
10202
10203     PL_error_count      = proto_perl->Ierror_count;
10204     PL_subline          = proto_perl->Isubline;
10205     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
10206
10207     PL_min_intro_pending        = proto_perl->Imin_intro_pending;
10208     PL_max_intro_pending        = proto_perl->Imax_intro_pending;
10209     PL_padix                    = proto_perl->Ipadix;
10210     PL_padix_floor              = proto_perl->Ipadix_floor;
10211     PL_pad_reset_pending        = proto_perl->Ipad_reset_pending;
10212
10213     i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10214     PL_last_uni         = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10215     i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10216     PL_last_lop         = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10217     PL_last_lop_op      = proto_perl->Ilast_lop_op;
10218     PL_in_my            = proto_perl->Iin_my;
10219     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
10220 #ifdef FCRYPT
10221     PL_cryptseen        = proto_perl->Icryptseen;
10222 #endif
10223
10224     PL_hints            = proto_perl->Ihints;
10225
10226     PL_amagic_generation        = proto_perl->Iamagic_generation;
10227
10228 #ifdef USE_LOCALE_COLLATE
10229     PL_collation_ix     = proto_perl->Icollation_ix;
10230     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
10231     PL_collation_standard       = proto_perl->Icollation_standard;
10232     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
10233     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
10234 #endif /* USE_LOCALE_COLLATE */
10235
10236 #ifdef USE_LOCALE_NUMERIC
10237     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
10238     PL_numeric_standard = proto_perl->Inumeric_standard;
10239     PL_numeric_local    = proto_perl->Inumeric_local;
10240     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10241 #endif /* !USE_LOCALE_NUMERIC */
10242
10243     /* utf8 character classes */
10244     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10245     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10246     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10247     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10248     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
10249     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10250     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
10251     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
10252     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
10253     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
10254     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
10255     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
10256     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10257     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
10258     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10259     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10260     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10261     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10262
10263     /* swatch cache */
10264     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
10265     PL_last_swash_klen  = 0;
10266     PL_last_swash_key[0]= '\0';
10267     PL_last_swash_tmps  = (U8*)NULL;
10268     PL_last_swash_slen  = 0;
10269
10270     /* perly.c globals */
10271     PL_yydebug          = proto_perl->Iyydebug;
10272     PL_yynerrs          = proto_perl->Iyynerrs;
10273     PL_yyerrflag        = proto_perl->Iyyerrflag;
10274     PL_yychar           = proto_perl->Iyychar;
10275     PL_yyval            = proto_perl->Iyyval;
10276     PL_yylval           = proto_perl->Iyylval;
10277
10278     PL_glob_index       = proto_perl->Iglob_index;
10279     PL_srand_called     = proto_perl->Isrand_called;
10280     PL_uudmap['M']      = 0;            /* reinits on demand */
10281     PL_bitcount         = Nullch;       /* reinits on demand */
10282
10283     if (proto_perl->Ipsig_pend) {
10284         Newz(0, PL_psig_pend, SIG_SIZE, int);
10285     }
10286     else {
10287         PL_psig_pend    = (int*)NULL;
10288     }
10289
10290     if (proto_perl->Ipsig_ptr) {
10291         Newz(0, PL_psig_ptr,  SIG_SIZE, SV*);
10292         Newz(0, PL_psig_name, SIG_SIZE, SV*);
10293         for (i = 1; i < SIG_SIZE; i++) {
10294             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10295             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10296         }
10297     }
10298     else {
10299         PL_psig_ptr     = (SV**)NULL;
10300         PL_psig_name    = (SV**)NULL;
10301     }
10302
10303     /* thrdvar.h stuff */
10304
10305     if (flags & CLONEf_COPY_STACKS) {
10306         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10307         PL_tmps_ix              = proto_perl->Ttmps_ix;
10308         PL_tmps_max             = proto_perl->Ttmps_max;
10309         PL_tmps_floor           = proto_perl->Ttmps_floor;
10310         Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10311         i = 0;
10312         while (i <= PL_tmps_ix) {
10313             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10314             ++i;
10315         }
10316
10317         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10318         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10319         Newz(54, PL_markstack, i, I32);
10320         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
10321                                                   - proto_perl->Tmarkstack);
10322         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
10323                                                   - proto_perl->Tmarkstack);
10324         Copy(proto_perl->Tmarkstack, PL_markstack,
10325              PL_markstack_ptr - PL_markstack + 1, I32);
10326
10327         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10328          * NOTE: unlike the others! */
10329         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
10330         PL_scopestack_max       = proto_perl->Tscopestack_max;
10331         Newz(54, PL_scopestack, PL_scopestack_max, I32);
10332         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10333
10334         /* next push_return() sets PL_retstack[PL_retstack_ix]
10335          * NOTE: unlike the others! */
10336         PL_retstack_ix          = proto_perl->Tretstack_ix;
10337         PL_retstack_max         = proto_perl->Tretstack_max;
10338         Newz(54, PL_retstack, PL_retstack_max, OP*);
10339         Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, I32);
10340
10341         /* NOTE: si_dup() looks at PL_markstack */
10342         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
10343
10344         /* PL_curstack          = PL_curstackinfo->si_stack; */
10345         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
10346         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
10347
10348         /* next PUSHs() etc. set *(PL_stack_sp+1) */
10349         PL_stack_base           = AvARRAY(PL_curstack);
10350         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
10351                                                    - proto_perl->Tstack_base);
10352         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
10353
10354         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10355          * NOTE: unlike the others! */
10356         PL_savestack_ix         = proto_perl->Tsavestack_ix;
10357         PL_savestack_max        = proto_perl->Tsavestack_max;
10358         /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10359         PL_savestack            = ss_dup(proto_perl, param);
10360     }
10361     else {
10362         init_stacks();
10363         ENTER;                  /* perl_destruct() wants to LEAVE; */
10364     }
10365
10366     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
10367     PL_top_env          = &PL_start_env;
10368
10369     PL_op               = proto_perl->Top;
10370
10371     PL_Sv               = Nullsv;
10372     PL_Xpv              = (XPV*)NULL;
10373     PL_na               = proto_perl->Tna;
10374
10375     PL_statbuf          = proto_perl->Tstatbuf;
10376     PL_statcache        = proto_perl->Tstatcache;
10377     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
10378     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
10379 #ifdef HAS_TIMES
10380     PL_timesbuf         = proto_perl->Ttimesbuf;
10381 #endif
10382
10383     PL_tainted          = proto_perl->Ttainted;
10384     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
10385     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
10386     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
10387     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
10388     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
10389     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
10390     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
10391     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
10392     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
10393
10394     PL_restartop        = proto_perl->Trestartop;
10395     PL_in_eval          = proto_perl->Tin_eval;
10396     PL_delaymagic       = proto_perl->Tdelaymagic;
10397     PL_dirty            = proto_perl->Tdirty;
10398     PL_localizing       = proto_perl->Tlocalizing;
10399
10400 #ifdef PERL_FLEXIBLE_EXCEPTIONS
10401     PL_protect          = proto_perl->Tprotect;
10402 #endif
10403     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
10404     PL_av_fetch_sv      = Nullsv;
10405     PL_hv_fetch_sv      = Nullsv;
10406     Zero(&PL_hv_fetch_ent_mh, 1, HE);                   /* XXX */
10407     PL_modcount         = proto_perl->Tmodcount;
10408     PL_lastgotoprobe    = Nullop;
10409     PL_dumpindent       = proto_perl->Tdumpindent;
10410
10411     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10412     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
10413     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
10414     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
10415     PL_sortcxix         = proto_perl->Tsortcxix;
10416     PL_efloatbuf        = Nullch;               /* reinits on demand */
10417     PL_efloatsize       = 0;                    /* reinits on demand */
10418
10419     /* regex stuff */
10420
10421     PL_screamfirst      = NULL;
10422     PL_screamnext       = NULL;
10423     PL_maxscream        = -1;                   /* reinits on demand */
10424     PL_lastscream       = Nullsv;
10425
10426     PL_watchaddr        = NULL;
10427     PL_watchok          = Nullch;
10428
10429     PL_regdummy         = proto_perl->Tregdummy;
10430     PL_regcomp_parse    = Nullch;
10431     PL_regxend          = Nullch;
10432     PL_regcode          = (regnode*)NULL;
10433     PL_regnaughty       = 0;
10434     PL_regsawback       = 0;
10435     PL_regprecomp       = Nullch;
10436     PL_regnpar          = 0;
10437     PL_regsize          = 0;
10438     PL_regflags         = 0;
10439     PL_regseen          = 0;
10440     PL_seen_zerolen     = 0;
10441     PL_seen_evals       = 0;
10442     PL_regcomp_rx       = (regexp*)NULL;
10443     PL_extralen         = 0;
10444     PL_colorset         = 0;            /* reinits PL_colors[] */
10445     /*PL_colors[6]      = {0,0,0,0,0,0};*/
10446     PL_reg_whilem_seen  = 0;
10447     PL_reginput         = Nullch;
10448     PL_regbol           = Nullch;
10449     PL_regeol           = Nullch;
10450     PL_regstartp        = (I32*)NULL;
10451     PL_regendp          = (I32*)NULL;
10452     PL_reglastparen     = (U32*)NULL;
10453     PL_regtill          = Nullch;
10454     PL_reg_start_tmp    = (char**)NULL;
10455     PL_reg_start_tmpl   = 0;
10456     PL_regdata          = (struct reg_data*)NULL;
10457     PL_bostr            = Nullch;
10458     PL_reg_flags        = 0;
10459     PL_reg_eval_set     = 0;
10460     PL_regnarrate       = 0;
10461     PL_regprogram       = (regnode*)NULL;
10462     PL_regindent        = 0;
10463     PL_regcc            = (CURCUR*)NULL;
10464     PL_reg_call_cc      = (struct re_cc_state*)NULL;
10465     PL_reg_re           = (regexp*)NULL;
10466     PL_reg_ganch        = Nullch;
10467     PL_reg_sv           = Nullsv;
10468     PL_reg_match_utf8   = FALSE;
10469     PL_reg_magic        = (MAGIC*)NULL;
10470     PL_reg_oldpos       = 0;
10471     PL_reg_oldcurpm     = (PMOP*)NULL;
10472     PL_reg_curpm        = (PMOP*)NULL;
10473     PL_reg_oldsaved     = Nullch;
10474     PL_reg_oldsavedlen  = 0;
10475     PL_reg_maxiter      = 0;
10476     PL_reg_leftiter     = 0;
10477     PL_reg_poscache     = Nullch;
10478     PL_reg_poscache_size= 0;
10479
10480     /* RE engine - function pointers */
10481     PL_regcompp         = proto_perl->Tregcompp;
10482     PL_regexecp         = proto_perl->Tregexecp;
10483     PL_regint_start     = proto_perl->Tregint_start;
10484     PL_regint_string    = proto_perl->Tregint_string;
10485     PL_regfree          = proto_perl->Tregfree;
10486
10487     PL_reginterp_cnt    = 0;
10488     PL_reg_starttry     = 0;
10489
10490     /* Pluggable optimizer */
10491     PL_peepp            = proto_perl->Tpeepp;
10492
10493     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10494         ptr_table_free(PL_ptr_table);
10495         PL_ptr_table = NULL;
10496     }
10497
10498     /* Call the ->CLONE method, if it exists, for each of the stashes
10499        identified by sv_dup() above.
10500     */
10501     while(av_len(param->stashes) != -1) {
10502         HV* stash = (HV*) av_shift(param->stashes);
10503         GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10504         if (cloner && GvCV(cloner)) {
10505             dSP;
10506             ENTER;
10507             SAVETMPS;
10508             PUSHMARK(SP);
10509            XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
10510             PUTBACK;
10511             call_sv((SV*)GvCV(cloner), G_DISCARD);
10512             FREETMPS;
10513             LEAVE;
10514         }
10515     }
10516
10517     SvREFCNT_dec(param->stashes);
10518
10519     return my_perl;
10520 }
10521
10522 #endif /* USE_ITHREADS */
10523
10524 /*
10525 =head1 Unicode Support
10526
10527 =for apidoc sv_recode_to_utf8
10528
10529 The encoding is assumed to be an Encode object, on entry the PV
10530 of the sv is assumed to be octets in that encoding, and the sv
10531 will be converted into Unicode (and UTF-8).
10532
10533 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10534 is not a reference, nothing is done to the sv.  If the encoding is not
10535 an C<Encode::XS> Encoding object, bad things will happen.
10536 (See F<lib/encoding.pm> and L<Encode>).
10537
10538 The PV of the sv is returned.
10539
10540 =cut */
10541
10542 char *
10543 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10544 {
10545      if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
10546           SV *uni;
10547           STRLEN len;
10548           char *s;
10549           dSP;
10550           ENTER;
10551           SAVETMPS;
10552           PUSHMARK(sp);
10553           EXTEND(SP, 3);
10554           XPUSHs(encoding);
10555           XPUSHs(sv);
10556           XPUSHs(&PL_sv_yes);
10557           PUTBACK;
10558           call_method("decode", G_SCALAR);
10559           SPAGAIN;
10560           uni = POPs;
10561           PUTBACK;
10562           s = SvPV(uni, len);
10563           if (s != SvPVX(sv)) {
10564                SvGROW(sv, len);
10565                Move(s, SvPVX(sv), len, char);
10566                SvCUR_set(sv, len);
10567           }
10568           FREETMPS;
10569           LEAVE;
10570           SvUTF8_on(sv);
10571      }
10572      return SvPVX(sv);
10573 }
10574
10575