**** UNSAFE **** partial fix for IO::Scalar and local ties.
[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' + (char)(uv % 10);
2871     } while (uv /= 10);
2872     if (sign)
2873         *--ptr = '-';
2874     *peob = ebuf;
2875     return ptr;
2876 }
2877
2878 /*
2879 =for apidoc sv_2pv_flags
2880
2881 Returns a pointer to the string value of an SV, and sets *lp to its length.
2882 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2883 if necessary.
2884 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2885 usually end up here too.
2886
2887 =cut
2888 */
2889
2890 char *
2891 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2892 {
2893     register char *s;
2894     int olderrno;
2895     SV *tsv;
2896     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
2897     char *tmpbuf = tbuf;
2898
2899     if (!sv) {
2900         *lp = 0;
2901         return "";
2902     }
2903     if (SvGMAGICAL(sv)) {
2904         if (flags & SV_GMAGIC)
2905             mg_get(sv);
2906         if (SvPOKp(sv)) {
2907             *lp = SvCUR(sv);
2908             return SvPVX(sv);
2909         }
2910         if (SvIOKp(sv)) {
2911             if (SvIsUV(sv))
2912                 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2913             else
2914                 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2915             tsv = Nullsv;
2916             goto tokensave;
2917         }
2918         if (SvNOKp(sv)) {
2919             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2920             tsv = Nullsv;
2921             goto tokensave;
2922         }
2923         if (!SvROK(sv)) {
2924             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2925                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2926                     report_uninit();
2927             }
2928             *lp = 0;
2929             return "";
2930         }
2931     }
2932     if (SvTHINKFIRST(sv)) {
2933         if (SvROK(sv)) {
2934             SV* tmpstr;
2935             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2936                 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2937                 return SvPV(tmpstr,*lp);
2938             sv = (SV*)SvRV(sv);
2939             if (!sv)
2940                 s = "NULLREF";
2941             else {
2942                 MAGIC *mg;
2943                 
2944                 switch (SvTYPE(sv)) {
2945                 case SVt_PVMG:
2946                     if ( ((SvFLAGS(sv) &
2947                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2948                           == (SVs_OBJECT|SVs_RMG))
2949                          && strEQ(s=HvNAME(SvSTASH(sv)), "Regexp")
2950                          && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2951                         regexp *re = (regexp *)mg->mg_obj;
2952
2953                         if (!mg->mg_ptr) {
2954                             char *fptr = "msix";
2955                             char reflags[6];
2956                             char ch;
2957                             int left = 0;
2958                             int right = 4;
2959                             char need_newline = 0;
2960                             U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2961
2962                             while((ch = *fptr++)) {
2963                                 if(reganch & 1) {
2964                                     reflags[left++] = ch;
2965                                 }
2966                                 else {
2967                                     reflags[right--] = ch;
2968                                 }
2969                                 reganch >>= 1;
2970                             }
2971                             if(left != 4) {
2972                                 reflags[left] = '-';
2973                                 left = 5;
2974                             }
2975
2976                             mg->mg_len = re->prelen + 4 + left;
2977                             /*
2978                              * If /x was used, we have to worry about a regex
2979                              * ending with a comment later being embedded
2980                              * within another regex. If so, we don't want this
2981                              * regex's "commentization" to leak out to the
2982                              * right part of the enclosing regex, we must cap
2983                              * it with a newline.
2984                              *
2985                              * So, if /x was used, we scan backwards from the
2986                              * end of the regex. If we find a '#' before we
2987                              * find a newline, we need to add a newline
2988                              * ourself. If we find a '\n' first (or if we
2989                              * don't find '#' or '\n'), we don't need to add
2990                              * anything.  -jfriedl
2991                              */
2992                             if (PMf_EXTENDED & re->reganch)
2993                             {
2994                                 char *endptr = re->precomp + re->prelen;
2995                                 while (endptr >= re->precomp)
2996                                 {
2997                                     char c = *(endptr--);
2998                                     if (c == '\n')
2999                                         break; /* don't need another */
3000                                     if (c == '#') {
3001                                         /* we end while in a comment, so we
3002                                            need a newline */
3003                                         mg->mg_len++; /* save space for it */
3004                                         need_newline = 1; /* note to add it */
3005                                     }
3006                                 }
3007                             }
3008
3009                             New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3010                             Copy("(?", mg->mg_ptr, 2, char);
3011                             Copy(reflags, mg->mg_ptr+2, left, char);
3012                             Copy(":", mg->mg_ptr+left+2, 1, char);
3013                             Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3014                             if (need_newline)
3015                                 mg->mg_ptr[mg->mg_len - 2] = '\n';
3016                             mg->mg_ptr[mg->mg_len - 1] = ')';
3017                             mg->mg_ptr[mg->mg_len] = 0;
3018                         }
3019                         PL_reginterp_cnt += re->program[0].next_off;
3020                         *lp = mg->mg_len;
3021                         return mg->mg_ptr;
3022                     }
3023                                         /* Fall through */
3024                 case SVt_NULL:
3025                 case SVt_IV:
3026                 case SVt_NV:
3027                 case SVt_RV:
3028                 case SVt_PV:
3029                 case SVt_PVIV:
3030                 case SVt_PVNV:
3031                 case SVt_PVBM:  if (SvROK(sv))
3032                                     s = "REF";
3033                                 else
3034                                     s = "SCALAR";               break;
3035                 case SVt_PVLV:  s = "LVALUE";                   break;
3036                 case SVt_PVAV:  s = "ARRAY";                    break;
3037                 case SVt_PVHV:  s = "HASH";                     break;
3038                 case SVt_PVCV:  s = "CODE";                     break;
3039                 case SVt_PVGV:  s = "GLOB";                     break;
3040                 case SVt_PVFM:  s = "FORMAT";                   break;
3041                 case SVt_PVIO:  s = "IO";                       break;
3042                 default:        s = "UNKNOWN";                  break;
3043                 }
3044                 tsv = NEWSV(0,0);
3045                 if (SvOBJECT(sv)) {
3046                     HV *svs = SvSTASH(sv);
3047                     Perl_sv_setpvf(
3048                         aTHX_ tsv, "%s=%s",
3049                         /* [20011101.072] This bandaid for C<package;>
3050                            should eventually be removed. AMS 20011103 */
3051                         (svs ? HvNAME(svs) : "<none>"), s
3052                     );
3053                 }
3054                 else
3055                     sv_setpv(tsv, s);
3056                 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3057                 goto tokensaveref;
3058             }
3059             *lp = strlen(s);
3060             return s;
3061         }
3062         if (SvREADONLY(sv) && !SvOK(sv)) {
3063             if (ckWARN(WARN_UNINITIALIZED))
3064                 report_uninit();
3065             *lp = 0;
3066             return "";
3067         }
3068     }
3069     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3070         /* I'm assuming that if both IV and NV are equally valid then
3071            converting the IV is going to be more efficient */
3072         U32 isIOK = SvIOK(sv);
3073         U32 isUIOK = SvIsUV(sv);
3074         char buf[TYPE_CHARS(UV)];
3075         char *ebuf, *ptr;
3076
3077         if (SvTYPE(sv) < SVt_PVIV)
3078             sv_upgrade(sv, SVt_PVIV);
3079         if (isUIOK)
3080             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3081         else
3082             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3083         SvGROW(sv, (STRLEN)(ebuf - ptr + 1));   /* inlined from sv_setpvn */
3084         Move(ptr,SvPVX(sv),ebuf - ptr,char);
3085         SvCUR_set(sv, ebuf - ptr);
3086         s = SvEND(sv);
3087         *s = '\0';
3088         if (isIOK)
3089             SvIOK_on(sv);
3090         else
3091             SvIOKp_on(sv);
3092         if (isUIOK)
3093             SvIsUV_on(sv);
3094     }
3095     else if (SvNOKp(sv)) {
3096         if (SvTYPE(sv) < SVt_PVNV)
3097             sv_upgrade(sv, SVt_PVNV);
3098         /* The +20 is pure guesswork.  Configure test needed. --jhi */
3099         SvGROW(sv, NV_DIG + 20);
3100         s = SvPVX(sv);
3101         olderrno = errno;       /* some Xenix systems wipe out errno here */
3102 #ifdef apollo
3103         if (SvNVX(sv) == 0.0)
3104             (void)strcpy(s,"0");
3105         else
3106 #endif /*apollo*/
3107         {
3108             Gconvert(SvNVX(sv), NV_DIG, 0, s);
3109         }
3110         errno = olderrno;
3111 #ifdef FIXNEGATIVEZERO
3112         if (*s == '-' && s[1] == '0' && !s[2])
3113             strcpy(s,"0");
3114 #endif
3115         while (*s) s++;
3116 #ifdef hcx
3117         if (s[-1] == '.')
3118             *--s = '\0';
3119 #endif
3120     }
3121     else {
3122         if (ckWARN(WARN_UNINITIALIZED)
3123             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3124             report_uninit();
3125         *lp = 0;
3126         if (SvTYPE(sv) < SVt_PV)
3127             /* Typically the caller expects that sv_any is not NULL now.  */
3128             sv_upgrade(sv, SVt_PV);
3129         return "";
3130     }
3131     *lp = s - SvPVX(sv);
3132     SvCUR_set(sv, *lp);
3133     SvPOK_on(sv);
3134     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3135                           PTR2UV(sv),SvPVX(sv)));
3136     return SvPVX(sv);
3137
3138   tokensave:
3139     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
3140         /* Sneaky stuff here */
3141
3142       tokensaveref:
3143         if (!tsv)
3144             tsv = newSVpv(tmpbuf, 0);
3145         sv_2mortal(tsv);
3146         *lp = SvCUR(tsv);
3147         return SvPVX(tsv);
3148     }
3149     else {
3150         STRLEN len;
3151         char *t;
3152
3153         if (tsv) {
3154             sv_2mortal(tsv);
3155             t = SvPVX(tsv);
3156             len = SvCUR(tsv);
3157         }
3158         else {
3159             t = tmpbuf;
3160             len = strlen(tmpbuf);
3161         }
3162 #ifdef FIXNEGATIVEZERO
3163         if (len == 2 && t[0] == '-' && t[1] == '0') {
3164             t = "0";
3165             len = 1;
3166         }
3167 #endif
3168         (void)SvUPGRADE(sv, SVt_PV);
3169         *lp = len;
3170         s = SvGROW(sv, len + 1);
3171         SvCUR_set(sv, len);
3172         (void)strcpy(s, t);
3173         SvPOKp_on(sv);
3174         return s;
3175     }
3176 }
3177
3178 /*
3179 =for apidoc sv_copypv
3180
3181 Copies a stringified representation of the source SV into the
3182 destination SV.  Automatically performs any necessary mg_get and
3183 coercion of numeric values into strings.  Guaranteed to preserve
3184 UTF-8 flag even from overloaded objects.  Similar in nature to
3185 sv_2pv[_flags] but operates directly on an SV instead of just the
3186 string.  Mostly uses sv_2pv_flags to do its work, except when that
3187 would lose the UTF-8'ness of the PV.
3188
3189 =cut
3190 */
3191
3192 void
3193 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3194 {
3195     SV *tmpsv;
3196
3197     if ( SvTHINKFIRST(ssv) && SvROK(ssv) && SvAMAGIC(ssv) &&
3198          (tmpsv = AMG_CALLun(ssv,string))) {
3199         if (SvTYPE(tmpsv) != SVt_RV || (SvRV(tmpsv) != SvRV(ssv))) {
3200             SvSetSV(dsv,tmpsv);
3201             return;
3202         }
3203     } else {
3204         tmpsv = sv_newmortal();
3205     }
3206     {
3207         STRLEN len;
3208         char *s;
3209         s = SvPV(ssv,len);
3210         sv_setpvn(tmpsv,s,len);
3211         if (SvUTF8(ssv))
3212             SvUTF8_on(tmpsv);
3213         else
3214             SvUTF8_off(tmpsv);
3215         SvSetSV(dsv,tmpsv);
3216     }
3217 }
3218
3219 /*
3220 =for apidoc sv_2pvbyte_nolen
3221
3222 Return a pointer to the byte-encoded representation of the SV.
3223 May cause the SV to be downgraded from UTF8 as a side-effect.
3224
3225 Usually accessed via the C<SvPVbyte_nolen> macro.
3226
3227 =cut
3228 */
3229
3230 char *
3231 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3232 {
3233     STRLEN n_a;
3234     return sv_2pvbyte(sv, &n_a);
3235 }
3236
3237 /*
3238 =for apidoc sv_2pvbyte
3239
3240 Return a pointer to the byte-encoded representation of the SV, and set *lp
3241 to its length.  May cause the SV to be downgraded from UTF8 as a
3242 side-effect.
3243
3244 Usually accessed via the C<SvPVbyte> macro.
3245
3246 =cut
3247 */
3248
3249 char *
3250 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3251 {
3252     sv_utf8_downgrade(sv,0);
3253     return SvPV(sv,*lp);
3254 }
3255
3256 /*
3257 =for apidoc sv_2pvutf8_nolen
3258
3259 Return a pointer to the UTF8-encoded representation of the SV.
3260 May cause the SV to be upgraded to UTF8 as a side-effect.
3261
3262 Usually accessed via the C<SvPVutf8_nolen> macro.
3263
3264 =cut
3265 */
3266
3267 char *
3268 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3269 {
3270     STRLEN n_a;
3271     return sv_2pvutf8(sv, &n_a);
3272 }
3273
3274 /*
3275 =for apidoc sv_2pvutf8
3276
3277 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3278 to its length.  May cause the SV to be upgraded to UTF8 as a side-effect.
3279
3280 Usually accessed via the C<SvPVutf8> macro.
3281
3282 =cut
3283 */
3284
3285 char *
3286 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3287 {
3288     sv_utf8_upgrade(sv);
3289     return SvPV(sv,*lp);
3290 }
3291
3292 /*
3293 =for apidoc sv_2bool
3294
3295 This function is only called on magical items, and is only used by
3296 sv_true() or its macro equivalent.
3297
3298 =cut
3299 */
3300
3301 bool
3302 Perl_sv_2bool(pTHX_ register SV *sv)
3303 {
3304     if (SvGMAGICAL(sv))
3305         mg_get(sv);
3306
3307     if (!SvOK(sv))
3308         return 0;
3309     if (SvROK(sv)) {
3310         SV* tmpsv;
3311         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3312                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3313             return (bool)SvTRUE(tmpsv);
3314       return SvRV(sv) != 0;
3315     }
3316     if (SvPOKp(sv)) {
3317         register XPV* Xpvtmp;
3318         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3319                 (*Xpvtmp->xpv_pv > '0' ||
3320                 Xpvtmp->xpv_cur > 1 ||
3321                 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3322             return 1;
3323         else
3324             return 0;
3325     }
3326     else {
3327         if (SvIOKp(sv))
3328             return SvIVX(sv) != 0;
3329         else {
3330             if (SvNOKp(sv))
3331                 return SvNVX(sv) != 0.0;
3332             else
3333                 return FALSE;
3334         }
3335     }
3336 }
3337
3338 /*
3339 =for apidoc sv_utf8_upgrade
3340
3341 Convert the PV of an SV to its UTF8-encoded form.
3342 Forces the SV to string form if it is not already.
3343 Always sets the SvUTF8 flag to avoid future validity checks even
3344 if all the bytes have hibit clear.
3345
3346 This is not as a general purpose byte encoding to Unicode interface:
3347 use the Encode extension for that.
3348
3349 =for apidoc sv_utf8_upgrade_flags
3350
3351 Convert the PV of an SV to its UTF8-encoded form.
3352 Forces the SV to string form if it is not already.
3353 Always sets the SvUTF8 flag to avoid future validity checks even
3354 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3355 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3356 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3357
3358 This is not as a general purpose byte encoding to Unicode interface:
3359 use the Encode extension for that.
3360
3361 =cut
3362 */
3363
3364 STRLEN
3365 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3366 {
3367     U8 *s, *t, *e;
3368     int  hibit = 0;
3369
3370     if (!sv)
3371         return 0;
3372
3373     if (!SvPOK(sv)) {
3374         STRLEN len = 0;
3375         (void) sv_2pv_flags(sv,&len, flags);
3376         if (!SvPOK(sv))
3377              return len;
3378     }
3379
3380     if (SvUTF8(sv))
3381         return SvCUR(sv);
3382
3383     if (SvREADONLY(sv) && SvFAKE(sv)) {
3384         sv_force_normal(sv);
3385     }
3386
3387     if (PL_encoding)
3388         sv_recode_to_utf8(sv, PL_encoding);
3389     else { /* Assume Latin-1/EBCDIC */
3390          /* This function could be much more efficient if we
3391           * had a FLAG in SVs to signal if there are any hibit
3392           * chars in the PV.  Given that there isn't such a flag
3393           * make the loop as fast as possible. */
3394          s = (U8 *) SvPVX(sv);
3395          e = (U8 *) SvEND(sv);
3396          t = s;
3397          while (t < e) {
3398               U8 ch = *t++;
3399               if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3400                    break;
3401          }
3402          if (hibit) {
3403               STRLEN len;
3404         
3405               len = SvCUR(sv) + 1; /* Plus the \0 */
3406               SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3407               SvCUR(sv) = len - 1;
3408               if (SvLEN(sv) != 0)
3409                    Safefree(s); /* No longer using what was there before. */
3410               SvLEN(sv) = len; /* No longer know the real size. */
3411          }
3412          /* Mark as UTF-8 even if no hibit - saves scanning loop */
3413          SvUTF8_on(sv);
3414     }
3415     return SvCUR(sv);
3416 }
3417
3418 /*
3419 =for apidoc sv_utf8_downgrade
3420
3421 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3422 This may not be possible if the PV contains non-byte encoding characters;
3423 if this is the case, either returns false or, if C<fail_ok> is not
3424 true, croaks.
3425
3426 This is not as a general purpose Unicode to byte encoding interface:
3427 use the Encode extension for that.
3428
3429 =cut
3430 */
3431
3432 bool
3433 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3434 {
3435     if (SvPOK(sv) && SvUTF8(sv)) {
3436         if (SvCUR(sv)) {
3437             U8 *s;
3438             STRLEN len;
3439
3440             if (SvREADONLY(sv) && SvFAKE(sv))
3441                 sv_force_normal(sv);
3442             s = (U8 *) SvPV(sv, len);
3443             if (!utf8_to_bytes(s, &len)) {
3444                 if (fail_ok)
3445                     return FALSE;
3446                 else {
3447                     if (PL_op)
3448                         Perl_croak(aTHX_ "Wide character in %s",
3449                                    OP_DESC(PL_op));
3450                     else
3451                         Perl_croak(aTHX_ "Wide character");
3452                 }
3453             }
3454             SvCUR(sv) = len;
3455         }
3456     }
3457     SvUTF8_off(sv);
3458     return TRUE;
3459 }
3460
3461 /*
3462 =for apidoc sv_utf8_encode
3463
3464 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3465 flag so that it looks like octets again. Used as a building block
3466 for encode_utf8 in Encode.xs
3467
3468 =cut
3469 */
3470
3471 void
3472 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3473 {
3474     (void) sv_utf8_upgrade(sv);
3475     SvUTF8_off(sv);
3476 }
3477
3478 /*
3479 =for apidoc sv_utf8_decode
3480
3481 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3482 turn off SvUTF8 if needed so that we see characters. Used as a building block
3483 for decode_utf8 in Encode.xs
3484
3485 =cut
3486 */
3487
3488 bool
3489 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3490 {
3491     if (SvPOK(sv)) {
3492         U8 *c;
3493         U8 *e;
3494
3495         /* The octets may have got themselves encoded - get them back as
3496          * bytes
3497          */
3498         if (!sv_utf8_downgrade(sv, TRUE))
3499             return FALSE;
3500
3501         /* it is actually just a matter of turning the utf8 flag on, but
3502          * we want to make sure everything inside is valid utf8 first.
3503          */
3504         c = (U8 *) SvPVX(sv);
3505         if (!is_utf8_string(c, SvCUR(sv)+1))
3506             return FALSE;
3507         e = (U8 *) SvEND(sv);
3508         while (c < e) {
3509             U8 ch = *c++;
3510             if (!UTF8_IS_INVARIANT(ch)) {
3511                 SvUTF8_on(sv);
3512                 break;
3513             }
3514         }
3515     }
3516     return TRUE;
3517 }
3518
3519 /*
3520 =for apidoc sv_setsv
3521
3522 Copies the contents of the source SV C<ssv> into the destination SV
3523 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3524 function if the source SV needs to be reused. Does not handle 'set' magic.
3525 Loosely speaking, it performs a copy-by-value, obliterating any previous
3526 content of the destination.
3527
3528 You probably want to use one of the assortment of wrappers, such as
3529 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3530 C<SvSetMagicSV_nosteal>.
3531
3532 =for apidoc sv_setsv_flags
3533
3534 Copies the contents of the source SV C<ssv> into the destination SV
3535 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3536 function if the source SV needs to be reused. Does not handle 'set' magic.
3537 Loosely speaking, it performs a copy-by-value, obliterating any previous
3538 content of the destination.
3539 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3540 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3541 implemented in terms of this function.
3542
3543 You probably want to use one of the assortment of wrappers, such as
3544 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3545 C<SvSetMagicSV_nosteal>.
3546
3547 This is the primary function for copying scalars, and most other
3548 copy-ish functions and macros use this underneath.
3549
3550 =cut
3551 */
3552
3553 void
3554 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3555 {
3556     register U32 sflags;
3557     register int dtype;
3558     register int stype;
3559
3560     if (sstr == dstr)
3561         return;
3562     SV_CHECK_THINKFIRST(dstr);
3563     if (!sstr)
3564         sstr = &PL_sv_undef;
3565     stype = SvTYPE(sstr);
3566     dtype = SvTYPE(dstr);
3567
3568     SvAMAGIC_off(dstr);
3569
3570     /* There's a lot of redundancy below but we're going for speed here */
3571
3572     switch (stype) {
3573     case SVt_NULL:
3574       undef_sstr:
3575         if (dtype != SVt_PVGV) {
3576             (void)SvOK_off(dstr);
3577             return;
3578         }
3579         break;
3580     case SVt_IV:
3581         if (SvIOK(sstr)) {
3582             switch (dtype) {
3583             case SVt_NULL:
3584                 sv_upgrade(dstr, SVt_IV);
3585                 break;
3586             case SVt_NV:
3587                 sv_upgrade(dstr, SVt_PVNV);
3588                 break;
3589             case SVt_RV:
3590             case SVt_PV:
3591                 sv_upgrade(dstr, SVt_PVIV);
3592                 break;
3593             }
3594             (void)SvIOK_only(dstr);
3595             SvIVX(dstr) = SvIVX(sstr);
3596             if (SvIsUV(sstr))
3597                 SvIsUV_on(dstr);
3598             if (SvTAINTED(sstr))
3599                 SvTAINT(dstr);
3600             return;
3601         }
3602         goto undef_sstr;
3603
3604     case SVt_NV:
3605         if (SvNOK(sstr)) {
3606             switch (dtype) {
3607             case SVt_NULL:
3608             case SVt_IV:
3609                 sv_upgrade(dstr, SVt_NV);
3610                 break;
3611             case SVt_RV:
3612             case SVt_PV:
3613             case SVt_PVIV:
3614                 sv_upgrade(dstr, SVt_PVNV);
3615                 break;
3616             }
3617             SvNVX(dstr) = SvNVX(sstr);
3618             (void)SvNOK_only(dstr);
3619             if (SvTAINTED(sstr))
3620                 SvTAINT(dstr);
3621             return;
3622         }
3623         goto undef_sstr;
3624
3625     case SVt_RV:
3626         if (dtype < SVt_RV)
3627             sv_upgrade(dstr, SVt_RV);
3628         else if (dtype == SVt_PVGV &&
3629                  SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3630             sstr = SvRV(sstr);
3631             if (sstr == dstr) {
3632                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3633                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3634                 {
3635                     GvIMPORTED_on(dstr);
3636                 }
3637                 GvMULTI_on(dstr);
3638                 return;
3639             }
3640             goto glob_assign;
3641         }
3642         break;
3643     case SVt_PV:
3644     case SVt_PVFM:
3645         if (dtype < SVt_PV)
3646             sv_upgrade(dstr, SVt_PV);
3647         break;
3648     case SVt_PVIV:
3649         if (dtype < SVt_PVIV)
3650             sv_upgrade(dstr, SVt_PVIV);
3651         break;
3652     case SVt_PVNV:
3653         if (dtype < SVt_PVNV)
3654             sv_upgrade(dstr, SVt_PVNV);
3655         break;
3656     case SVt_PVAV:
3657     case SVt_PVHV:
3658     case SVt_PVCV:
3659     case SVt_PVIO:
3660         if (PL_op)
3661             Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3662                 OP_NAME(PL_op));
3663         else
3664             Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3665         break;
3666
3667     case SVt_PVGV:
3668         if (dtype <= SVt_PVGV) {
3669   glob_assign:
3670             if (dtype != SVt_PVGV) {
3671                 char *name = GvNAME(sstr);
3672                 STRLEN len = GvNAMELEN(sstr);
3673                 sv_upgrade(dstr, SVt_PVGV);
3674                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3675                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3676                 GvNAME(dstr) = savepvn(name, len);
3677                 GvNAMELEN(dstr) = len;
3678                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3679             }
3680             /* ahem, death to those who redefine active sort subs */
3681             else if (PL_curstackinfo->si_type == PERLSI_SORT
3682                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3683                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3684                       GvNAME(dstr));
3685
3686 #ifdef GV_UNIQUE_CHECK
3687                 if (GvUNIQUE((GV*)dstr)) {
3688                     Perl_croak(aTHX_ PL_no_modify);
3689                 }
3690 #endif
3691
3692             (void)SvOK_off(dstr);
3693             GvINTRO_off(dstr);          /* one-shot flag */
3694             gp_free((GV*)dstr);
3695             GvGP(dstr) = gp_ref(GvGP(sstr));
3696             if (SvTAINTED(sstr))
3697                 SvTAINT(dstr);
3698             if (GvIMPORTED(dstr) != GVf_IMPORTED
3699                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3700             {
3701                 GvIMPORTED_on(dstr);
3702             }
3703             GvMULTI_on(dstr);
3704             return;
3705         }
3706         /* FALL THROUGH */
3707
3708     default:
3709         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3710             mg_get(sstr);
3711             if ((int)SvTYPE(sstr) != stype) {
3712                 stype = SvTYPE(sstr);
3713                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3714                     goto glob_assign;
3715             }
3716         }
3717         if (stype == SVt_PVLV)
3718             (void)SvUPGRADE(dstr, SVt_PVNV);
3719         else
3720             (void)SvUPGRADE(dstr, (U32)stype);
3721     }
3722
3723     sflags = SvFLAGS(sstr);
3724
3725     if (sflags & SVf_ROK) {
3726         if (dtype >= SVt_PV) {
3727             if (dtype == SVt_PVGV) {
3728                 SV *sref = SvREFCNT_inc(SvRV(sstr));
3729                 SV *dref = 0;
3730                 int intro = GvINTRO(dstr);
3731
3732 #ifdef GV_UNIQUE_CHECK
3733                 if (GvUNIQUE((GV*)dstr)) {
3734                     Perl_croak(aTHX_ PL_no_modify);
3735                 }
3736 #endif
3737
3738                 if (intro) {
3739                     GvINTRO_off(dstr);  /* one-shot flag */
3740                     GvLINE(dstr) = CopLINE(PL_curcop);
3741                     GvEGV(dstr) = (GV*)dstr;
3742                 }
3743                 GvMULTI_on(dstr);
3744                 switch (SvTYPE(sref)) {
3745                 case SVt_PVAV:
3746                     if (intro)
3747                         SAVESPTR(GvAV(dstr));
3748                     else
3749                         dref = (SV*)GvAV(dstr);
3750                     GvAV(dstr) = (AV*)sref;
3751                     if (!GvIMPORTED_AV(dstr)
3752                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3753                     {
3754                         GvIMPORTED_AV_on(dstr);
3755                     }
3756                     break;
3757                 case SVt_PVHV:
3758                     if (intro)
3759                         SAVESPTR(GvHV(dstr));
3760                     else
3761                         dref = (SV*)GvHV(dstr);
3762                     GvHV(dstr) = (HV*)sref;
3763                     if (!GvIMPORTED_HV(dstr)
3764                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3765                     {
3766                         GvIMPORTED_HV_on(dstr);
3767                     }
3768                     break;
3769                 case SVt_PVCV:
3770                     if (intro) {
3771                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3772                             SvREFCNT_dec(GvCV(dstr));
3773                             GvCV(dstr) = Nullcv;
3774                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3775                             PL_sub_generation++;
3776                         }
3777                         SAVESPTR(GvCV(dstr));
3778                     }
3779                     else
3780                         dref = (SV*)GvCV(dstr);
3781                     if (GvCV(dstr) != (CV*)sref) {
3782                         CV* cv = GvCV(dstr);
3783                         if (cv) {
3784                             if (!GvCVGEN((GV*)dstr) &&
3785                                 (CvROOT(cv) || CvXSUB(cv)))
3786                             {
3787                                 /* ahem, death to those who redefine
3788                                  * active sort subs */
3789                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3790                                       PL_sortcop == CvSTART(cv))
3791                                     Perl_croak(aTHX_
3792                                     "Can't redefine active sort subroutine %s",
3793                                           GvENAME((GV*)dstr));
3794                                 /* Redefining a sub - warning is mandatory if
3795                                    it was a const and its value changed. */
3796                                 if (ckWARN(WARN_REDEFINE)
3797                                     || (CvCONST(cv)
3798                                         && (!CvCONST((CV*)sref)
3799                                             || sv_cmp(cv_const_sv(cv),
3800                                                       cv_const_sv((CV*)sref)))))
3801                                 {
3802                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3803                                         CvCONST(cv)
3804                                         ? "Constant subroutine %s::%s redefined"
3805                                         : "Subroutine %s::%s redefined",
3806                                         HvNAME(GvSTASH((GV*)dstr)),
3807                                         GvENAME((GV*)dstr));
3808                                 }
3809                             }
3810                             if (!intro)
3811                                 cv_ckproto(cv, (GV*)dstr,
3812                                         SvPOK(sref) ? SvPVX(sref) : Nullch);
3813                         }
3814                         GvCV(dstr) = (CV*)sref;
3815                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3816                         GvASSUMECV_on(dstr);
3817                         PL_sub_generation++;
3818                     }
3819                     if (!GvIMPORTED_CV(dstr)
3820                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3821                     {
3822                         GvIMPORTED_CV_on(dstr);
3823                     }
3824                     break;
3825                 case SVt_PVIO:
3826                     if (intro)
3827                         SAVESPTR(GvIOp(dstr));
3828                     else
3829                         dref = (SV*)GvIOp(dstr);
3830                     GvIOp(dstr) = (IO*)sref;
3831                     break;
3832                 case SVt_PVFM:
3833                     if (intro)
3834                         SAVESPTR(GvFORM(dstr));
3835                     else
3836                         dref = (SV*)GvFORM(dstr);
3837                     GvFORM(dstr) = (CV*)sref;
3838                     break;
3839                 default:
3840                     if (intro)
3841                         SAVESPTR(GvSV(dstr));
3842                     else
3843                         dref = (SV*)GvSV(dstr);
3844                     GvSV(dstr) = sref;
3845                     if (!GvIMPORTED_SV(dstr)
3846                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3847                     {
3848                         GvIMPORTED_SV_on(dstr);
3849                     }
3850                     break;
3851                 }
3852                 if (dref)
3853                     SvREFCNT_dec(dref);
3854                 if (intro)
3855                     SAVEFREESV(sref);
3856                 if (SvTAINTED(sstr))
3857                     SvTAINT(dstr);
3858                 return;
3859             }
3860             if (SvPVX(dstr)) {
3861                 (void)SvOOK_off(dstr);          /* backoff */
3862                 if (SvLEN(dstr))
3863                     Safefree(SvPVX(dstr));
3864                 SvLEN(dstr)=SvCUR(dstr)=0;
3865             }
3866         }
3867         (void)SvOK_off(dstr);
3868         SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3869         SvROK_on(dstr);
3870         if (sflags & SVp_NOK) {
3871             SvNOKp_on(dstr);
3872             /* Only set the public OK flag if the source has public OK.  */
3873             if (sflags & SVf_NOK)
3874                 SvFLAGS(dstr) |= SVf_NOK;
3875             SvNVX(dstr) = SvNVX(sstr);
3876         }
3877         if (sflags & SVp_IOK) {
3878             (void)SvIOKp_on(dstr);
3879             if (sflags & SVf_IOK)
3880                 SvFLAGS(dstr) |= SVf_IOK;
3881             if (sflags & SVf_IVisUV)
3882                 SvIsUV_on(dstr);
3883             SvIVX(dstr) = SvIVX(sstr);
3884         }
3885         if (SvAMAGIC(sstr)) {
3886             SvAMAGIC_on(dstr);
3887         }
3888     }
3889     else if (sflags & SVp_POK) {
3890
3891         /*
3892          * Check to see if we can just swipe the string.  If so, it's a
3893          * possible small lose on short strings, but a big win on long ones.
3894          * It might even be a win on short strings if SvPVX(dstr)
3895          * has to be allocated and SvPVX(sstr) has to be freed.
3896          */
3897
3898         if (SvTEMP(sstr) &&             /* slated for free anyway? */
3899             SvREFCNT(sstr) == 1 &&      /* and no other references to it? */
3900             !(sflags & SVf_OOK) &&      /* and not involved in OOK hack? */
3901             SvLEN(sstr)         &&      /* and really is a string */
3902                                 /* and won't be needed again, potentially */
3903             !(PL_op && PL_op->op_type == OP_AASSIGN))
3904         {
3905             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
3906                 if (SvOOK(dstr)) {
3907                     SvFLAGS(dstr) &= ~SVf_OOK;
3908                     Safefree(SvPVX(dstr) - SvIVX(dstr));
3909                 }
3910                 else if (SvLEN(dstr))
3911                     Safefree(SvPVX(dstr));
3912             }
3913             (void)SvPOK_only(dstr);
3914             SvPV_set(dstr, SvPVX(sstr));
3915             SvLEN_set(dstr, SvLEN(sstr));
3916             SvCUR_set(dstr, SvCUR(sstr));
3917
3918             SvTEMP_off(dstr);
3919             (void)SvOK_off(sstr);       /* NOTE: nukes most SvFLAGS on sstr */
3920             SvPV_set(sstr, Nullch);
3921             SvLEN_set(sstr, 0);
3922             SvCUR_set(sstr, 0);
3923             SvTEMP_off(sstr);
3924         }
3925         else {                          /* have to copy actual string */
3926             STRLEN len = SvCUR(sstr);
3927             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3928             Move(SvPVX(sstr),SvPVX(dstr),len,char);
3929             SvCUR_set(dstr, len);
3930             *SvEND(dstr) = '\0';
3931             (void)SvPOK_only(dstr);
3932         }
3933         if (sflags & SVf_UTF8)
3934             SvUTF8_on(dstr);
3935         /*SUPPRESS 560*/
3936         if (sflags & SVp_NOK) {
3937             SvNOKp_on(dstr);
3938             if (sflags & SVf_NOK)
3939                 SvFLAGS(dstr) |= SVf_NOK;
3940             SvNVX(dstr) = SvNVX(sstr);
3941         }
3942         if (sflags & SVp_IOK) {
3943             (void)SvIOKp_on(dstr);
3944             if (sflags & SVf_IOK)
3945                 SvFLAGS(dstr) |= SVf_IOK;
3946             if (sflags & SVf_IVisUV)
3947                 SvIsUV_on(dstr);
3948             SvIVX(dstr) = SvIVX(sstr);
3949         }
3950     }
3951     else if (sflags & SVp_IOK) {
3952         if (sflags & SVf_IOK)
3953             (void)SvIOK_only(dstr);
3954         else {
3955             (void)SvOK_off(dstr);
3956             (void)SvIOKp_on(dstr);
3957         }
3958         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3959         if (sflags & SVf_IVisUV)
3960             SvIsUV_on(dstr);
3961         SvIVX(dstr) = SvIVX(sstr);
3962         if (sflags & SVp_NOK) {
3963             if (sflags & SVf_NOK)
3964                 (void)SvNOK_on(dstr);
3965             else
3966                 (void)SvNOKp_on(dstr);
3967             SvNVX(dstr) = SvNVX(sstr);
3968         }
3969     }
3970     else if (sflags & SVp_NOK) {
3971         if (sflags & SVf_NOK)
3972             (void)SvNOK_only(dstr);
3973         else {
3974             (void)SvOK_off(dstr);
3975             SvNOKp_on(dstr);
3976         }
3977         SvNVX(dstr) = SvNVX(sstr);
3978     }
3979     else {
3980         if (dtype == SVt_PVGV) {
3981             if (ckWARN(WARN_MISC))
3982                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3983         }
3984         else
3985             (void)SvOK_off(dstr);
3986     }
3987     if (SvTAINTED(sstr))
3988         SvTAINT(dstr);
3989 }
3990
3991 /*
3992 =for apidoc sv_setsv_mg
3993
3994 Like C<sv_setsv>, but also handles 'set' magic.
3995
3996 =cut
3997 */
3998
3999 void
4000 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4001 {
4002     sv_setsv(dstr,sstr);
4003     SvSETMAGIC(dstr);
4004 }
4005
4006 /*
4007 =for apidoc sv_setpvn
4008
4009 Copies a string into an SV.  The C<len> parameter indicates the number of
4010 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4011
4012 =cut
4013 */
4014
4015 void
4016 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4017 {
4018     register char *dptr;
4019
4020     SV_CHECK_THINKFIRST(sv);
4021     if (!ptr) {
4022         (void)SvOK_off(sv);
4023         return;
4024     }
4025     else {
4026         /* len is STRLEN which is unsigned, need to copy to signed */
4027         IV iv = len;
4028         if (iv < 0)
4029             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4030     }
4031     (void)SvUPGRADE(sv, SVt_PV);
4032
4033     SvGROW(sv, len + 1);
4034     dptr = SvPVX(sv);
4035     Move(ptr,dptr,len,char);
4036     dptr[len] = '\0';
4037     SvCUR_set(sv, len);
4038     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4039     SvTAINT(sv);
4040 }
4041
4042 /*
4043 =for apidoc sv_setpvn_mg
4044
4045 Like C<sv_setpvn>, but also handles 'set' magic.
4046
4047 =cut
4048 */
4049
4050 void
4051 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4052 {
4053     sv_setpvn(sv,ptr,len);
4054     SvSETMAGIC(sv);
4055 }
4056
4057 /*
4058 =for apidoc sv_setpv
4059
4060 Copies a string into an SV.  The string must be null-terminated.  Does not
4061 handle 'set' magic.  See C<sv_setpv_mg>.
4062
4063 =cut
4064 */
4065
4066 void
4067 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4068 {
4069     register STRLEN len;
4070
4071     SV_CHECK_THINKFIRST(sv);
4072     if (!ptr) {
4073         (void)SvOK_off(sv);
4074         return;
4075     }
4076     len = strlen(ptr);
4077     (void)SvUPGRADE(sv, SVt_PV);
4078
4079     SvGROW(sv, len + 1);
4080     Move(ptr,SvPVX(sv),len+1,char);
4081     SvCUR_set(sv, len);
4082     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4083     SvTAINT(sv);
4084 }
4085
4086 /*
4087 =for apidoc sv_setpv_mg
4088
4089 Like C<sv_setpv>, but also handles 'set' magic.
4090
4091 =cut
4092 */
4093
4094 void
4095 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4096 {
4097     sv_setpv(sv,ptr);
4098     SvSETMAGIC(sv);
4099 }
4100
4101 /*
4102 =for apidoc sv_usepvn
4103
4104 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4105 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4106 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4107 string length, C<len>, must be supplied.  This function will realloc the
4108 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4109 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4110 See C<sv_usepvn_mg>.
4111
4112 =cut
4113 */
4114
4115 void
4116 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4117 {
4118     SV_CHECK_THINKFIRST(sv);
4119     (void)SvUPGRADE(sv, SVt_PV);
4120     if (!ptr) {
4121         (void)SvOK_off(sv);
4122         return;
4123     }
4124     (void)SvOOK_off(sv);
4125     if (SvPVX(sv) && SvLEN(sv))
4126         Safefree(SvPVX(sv));
4127     Renew(ptr, len+1, char);
4128     SvPVX(sv) = ptr;
4129     SvCUR_set(sv, len);
4130     SvLEN_set(sv, len+1);
4131     *SvEND(sv) = '\0';
4132     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4133     SvTAINT(sv);
4134 }
4135
4136 /*
4137 =for apidoc sv_usepvn_mg
4138
4139 Like C<sv_usepvn>, but also handles 'set' magic.
4140
4141 =cut
4142 */
4143
4144 void
4145 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4146 {
4147     sv_usepvn(sv,ptr,len);
4148     SvSETMAGIC(sv);
4149 }
4150
4151 /*
4152 =for apidoc sv_force_normal_flags
4153
4154 Undo various types of fakery on an SV: if the PV is a shared string, make
4155 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4156 an xpvmg. The C<flags> parameter gets passed to  C<sv_unref_flags()>
4157 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
4158
4159 =cut
4160 */
4161
4162 void
4163 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4164 {
4165     if (SvREADONLY(sv)) {
4166         if (SvFAKE(sv)) {
4167             char *pvx = SvPVX(sv);
4168             STRLEN len = SvCUR(sv);
4169             U32 hash   = SvUVX(sv);
4170             SvGROW(sv, len + 1);
4171             Move(pvx,SvPVX(sv),len,char);
4172             *SvEND(sv) = '\0';
4173             SvFAKE_off(sv);
4174             SvREADONLY_off(sv);
4175             unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4176         }
4177         else if (PL_curcop != &PL_compiling)
4178             Perl_croak(aTHX_ PL_no_modify);
4179     }
4180     if (SvROK(sv))
4181         sv_unref_flags(sv, flags);
4182     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4183         sv_unglob(sv);
4184 }
4185
4186 /*
4187 =for apidoc sv_force_normal
4188
4189 Undo various types of fakery on an SV: if the PV is a shared string, make
4190 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4191 an xpvmg. See also C<sv_force_normal_flags>.
4192
4193 =cut
4194 */
4195
4196 void
4197 Perl_sv_force_normal(pTHX_ register SV *sv)
4198 {
4199     sv_force_normal_flags(sv, 0);
4200 }
4201
4202 /*
4203 =for apidoc sv_chop
4204
4205 Efficient removal of characters from the beginning of the string buffer.
4206 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4207 the string buffer.  The C<ptr> becomes the first character of the adjusted
4208 string. Uses the "OOK hack".
4209
4210 =cut
4211 */
4212
4213 void
4214 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4215 {
4216     register STRLEN delta;
4217
4218     if (!ptr || !SvPOKp(sv))
4219         return;
4220     SV_CHECK_THINKFIRST(sv);
4221     if (SvTYPE(sv) < SVt_PVIV)
4222         sv_upgrade(sv,SVt_PVIV);
4223
4224     if (!SvOOK(sv)) {
4225         if (!SvLEN(sv)) { /* make copy of shared string */
4226             char *pvx = SvPVX(sv);
4227             STRLEN len = SvCUR(sv);
4228             SvGROW(sv, len + 1);
4229             Move(pvx,SvPVX(sv),len,char);
4230             *SvEND(sv) = '\0';
4231         }
4232         SvIVX(sv) = 0;
4233         SvFLAGS(sv) |= SVf_OOK;
4234     }
4235     SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
4236     delta = ptr - SvPVX(sv);
4237     SvLEN(sv) -= delta;
4238     SvCUR(sv) -= delta;
4239     SvPVX(sv) += delta;
4240     SvIVX(sv) += delta;
4241 }
4242
4243 /*
4244 =for apidoc sv_catpvn
4245
4246 Concatenates the string onto the end of the string which is in the SV.  The
4247 C<len> indicates number of bytes to copy.  If the SV has the UTF8
4248 status set, then the bytes appended should be valid UTF8.
4249 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4250
4251 =for apidoc sv_catpvn_flags
4252
4253 Concatenates the string onto the end of the string which is in the SV.  The
4254 C<len> indicates number of bytes to copy.  If the SV has the UTF8
4255 status set, then the bytes appended should be valid UTF8.
4256 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4257 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4258 in terms of this function.
4259
4260 =cut
4261 */
4262
4263 void
4264 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4265 {
4266     STRLEN dlen;
4267     char *dstr;
4268
4269     dstr = SvPV_force_flags(dsv, dlen, flags);
4270     SvGROW(dsv, dlen + slen + 1);
4271     if (sstr == dstr)
4272         sstr = SvPVX(dsv);
4273     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4274     SvCUR(dsv) += slen;
4275     *SvEND(dsv) = '\0';
4276     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4277     SvTAINT(dsv);
4278 }
4279
4280 /*
4281 =for apidoc sv_catpvn_mg
4282
4283 Like C<sv_catpvn>, but also handles 'set' magic.
4284
4285 =cut
4286 */
4287
4288 void
4289 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4290 {
4291     sv_catpvn(sv,ptr,len);
4292     SvSETMAGIC(sv);
4293 }
4294
4295 /*
4296 =for apidoc sv_catsv
4297
4298 Concatenates the string from SV C<ssv> onto the end of the string in
4299 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4300 not 'set' magic.  See C<sv_catsv_mg>.
4301
4302 =for apidoc sv_catsv_flags
4303
4304 Concatenates the string from SV C<ssv> onto the end of the string in
4305 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4306 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4307 and C<sv_catsv_nomg> are implemented in terms of this function.
4308
4309 =cut */
4310
4311 void
4312 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4313 {
4314     char *spv;
4315     STRLEN slen;
4316     if (!ssv)
4317         return;
4318     if ((spv = SvPV(ssv, slen))) {
4319         /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4320             gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4321             Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4322             get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4323             dsv->sv_flags doesn't have that bit set.
4324                 Andy Dougherty  12 Oct 2001
4325         */
4326         I32 sutf8 = DO_UTF8(ssv);
4327         I32 dutf8;
4328
4329         if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4330             mg_get(dsv);
4331         dutf8 = DO_UTF8(dsv);
4332
4333         if (dutf8 != sutf8) {
4334             if (dutf8) {
4335                 /* Not modifying source SV, so taking a temporary copy. */
4336                 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4337
4338                 sv_utf8_upgrade(csv);
4339                 spv = SvPV(csv, slen);
4340             }
4341             else
4342                 sv_utf8_upgrade_nomg(dsv);
4343         }
4344         sv_catpvn_nomg(dsv, spv, slen);
4345     }
4346 }
4347
4348 /*
4349 =for apidoc sv_catsv_mg
4350
4351 Like C<sv_catsv>, but also handles 'set' magic.
4352
4353 =cut
4354 */
4355
4356 void
4357 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4358 {
4359     sv_catsv(dsv,ssv);
4360     SvSETMAGIC(dsv);
4361 }
4362
4363 /*
4364 =for apidoc sv_catpv
4365
4366 Concatenates the string onto the end of the string which is in the SV.
4367 If the SV has the UTF8 status set, then the bytes appended should be
4368 valid UTF8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4369
4370 =cut */
4371
4372 void
4373 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4374 {
4375     register STRLEN len;
4376     STRLEN tlen;
4377     char *junk;
4378
4379     if (!ptr)
4380         return;
4381     junk = SvPV_force(sv, tlen);
4382     len = strlen(ptr);
4383     SvGROW(sv, tlen + len + 1);
4384     if (ptr == junk)
4385         ptr = SvPVX(sv);
4386     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4387     SvCUR(sv) += len;
4388     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4389     SvTAINT(sv);
4390 }
4391
4392 /*
4393 =for apidoc sv_catpv_mg
4394
4395 Like C<sv_catpv>, but also handles 'set' magic.
4396
4397 =cut
4398 */
4399
4400 void
4401 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4402 {
4403     sv_catpv(sv,ptr);
4404     SvSETMAGIC(sv);
4405 }
4406
4407 /*
4408 =for apidoc newSV
4409
4410 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4411 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4412 macro.
4413
4414 =cut
4415 */
4416
4417 SV *
4418 Perl_newSV(pTHX_ STRLEN len)
4419 {
4420     register SV *sv;
4421
4422     new_SV(sv);
4423     if (len) {
4424         sv_upgrade(sv, SVt_PV);
4425         SvGROW(sv, len + 1);
4426     }
4427     return sv;
4428 }
4429 /*
4430 =for apidoc sv_magicext
4431
4432 Adds magic to an SV, upgrading it if necessary. Applies the
4433 supplied vtable and returns pointer to the magic added.
4434
4435 Note that sv_magicext will allow things that sv_magic will not.
4436 In particular you can add magic to SvREADONLY SVs and and more than
4437 one instance of the same 'how'
4438
4439 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4440 if C<namelen> is zero then C<name> is stored as-is and - as another special
4441 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4442 an C<SV*> and has its REFCNT incremented
4443
4444 (This is now used as a subroutine by sv_magic.)
4445
4446 =cut
4447 */
4448 MAGIC * 
4449 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4450                  const char* name, I32 namlen)
4451 {
4452     MAGIC* mg;
4453
4454     if (SvTYPE(sv) < SVt_PVMG) {
4455         (void)SvUPGRADE(sv, SVt_PVMG);
4456     }
4457     Newz(702,mg, 1, MAGIC);
4458     mg->mg_moremagic = SvMAGIC(sv);
4459     SvMAGIC(sv) = mg;
4460
4461     /* Some magic sontains a reference loop, where the sv and object refer to
4462        each other.  To prevent a reference loop that would prevent such
4463        objects being freed, we look for such loops and if we find one we
4464        avoid incrementing the object refcount.
4465        Note we cannot do this to avoid self-tie loops as intervening RV must
4466        have its REFCNT incremented to keep it in existence - instead special
4467        case them in sv_free().
4468      */
4469     if (!obj || obj == sv ||
4470         how == PERL_MAGIC_arylen ||
4471         how == PERL_MAGIC_qr ||
4472         (SvTYPE(obj) == SVt_PVGV &&
4473             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4474             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4475             GvFORM(obj) == (CV*)sv)))
4476     {
4477         mg->mg_obj = obj;
4478     }
4479     else {
4480         mg->mg_obj = SvREFCNT_inc(obj);
4481         mg->mg_flags |= MGf_REFCOUNTED;
4482     }
4483     mg->mg_type = how;
4484     mg->mg_len = namlen;
4485     if (name) {
4486         if (namlen > 0)
4487             mg->mg_ptr = savepvn(name, namlen);
4488         else if (namlen == HEf_SVKEY)
4489             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4490         else
4491             mg->mg_ptr = (char *) name;
4492     }
4493     mg->mg_virtual = vtable;
4494
4495     mg_magical(sv);
4496     if (SvGMAGICAL(sv))
4497         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4498     return mg;
4499 }
4500
4501 /*
4502 =for apidoc sv_magic
4503
4504 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4505 then adds a new magic item of type C<how> to the head of the magic list.
4506
4507 =cut
4508 */
4509
4510 void
4511 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4512 {
4513     MAGIC* mg;
4514     MGVTBL *vtable = 0;
4515
4516     if (SvREADONLY(sv)) {
4517         if (PL_curcop != &PL_compiling
4518             && how != PERL_MAGIC_regex_global
4519             && how != PERL_MAGIC_bm
4520             && how != PERL_MAGIC_fm
4521             && how != PERL_MAGIC_sv
4522            )
4523         {
4524             Perl_croak(aTHX_ PL_no_modify);
4525         }
4526     }
4527     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4528         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4529             /* sv_magic() refuses to add a magic of the same 'how' as an
4530                existing one
4531              */
4532             if (how == PERL_MAGIC_taint)
4533                 mg->mg_len |= 1;
4534             return;
4535         }
4536     }
4537
4538     switch (how) {
4539     case PERL_MAGIC_sv:
4540         vtable = &PL_vtbl_sv;
4541         break;
4542     case PERL_MAGIC_overload:
4543         vtable = &PL_vtbl_amagic;
4544         break;
4545     case PERL_MAGIC_overload_elem:
4546         vtable = &PL_vtbl_amagicelem;
4547         break;
4548     case PERL_MAGIC_overload_table:
4549         vtable = &PL_vtbl_ovrld;
4550         break;
4551     case PERL_MAGIC_bm:
4552         vtable = &PL_vtbl_bm;
4553         break;
4554     case PERL_MAGIC_regdata:
4555         vtable = &PL_vtbl_regdata;
4556         break;
4557     case PERL_MAGIC_regdatum:
4558         vtable = &PL_vtbl_regdatum;
4559         break;
4560     case PERL_MAGIC_env:
4561         vtable = &PL_vtbl_env;
4562         break;
4563     case PERL_MAGIC_fm:
4564         vtable = &PL_vtbl_fm;
4565         break;
4566     case PERL_MAGIC_envelem:
4567         vtable = &PL_vtbl_envelem;
4568         break;
4569     case PERL_MAGIC_regex_global:
4570         vtable = &PL_vtbl_mglob;
4571         break;
4572     case PERL_MAGIC_isa:
4573         vtable = &PL_vtbl_isa;
4574         break;
4575     case PERL_MAGIC_isaelem:
4576         vtable = &PL_vtbl_isaelem;
4577         break;
4578     case PERL_MAGIC_nkeys:
4579         vtable = &PL_vtbl_nkeys;
4580         break;
4581     case PERL_MAGIC_dbfile:
4582         vtable = 0;
4583         break;
4584     case PERL_MAGIC_dbline:
4585         vtable = &PL_vtbl_dbline;
4586         break;
4587 #ifdef USE_5005THREADS
4588     case PERL_MAGIC_mutex:
4589         vtable = &PL_vtbl_mutex;
4590         break;
4591 #endif /* USE_5005THREADS */
4592 #ifdef USE_LOCALE_COLLATE
4593     case PERL_MAGIC_collxfrm:
4594         vtable = &PL_vtbl_collxfrm;
4595         break;
4596 #endif /* USE_LOCALE_COLLATE */
4597     case PERL_MAGIC_tied:
4598         vtable = &PL_vtbl_pack;
4599         break;
4600     case PERL_MAGIC_tiedelem:
4601     case PERL_MAGIC_tiedscalar:
4602         vtable = &PL_vtbl_packelem;
4603         break;
4604     case PERL_MAGIC_qr:
4605         vtable = &PL_vtbl_regexp;
4606         break;
4607     case PERL_MAGIC_sig:
4608         vtable = &PL_vtbl_sig;
4609         break;
4610     case PERL_MAGIC_sigelem:
4611         vtable = &PL_vtbl_sigelem;
4612         break;
4613     case PERL_MAGIC_taint:
4614         vtable = &PL_vtbl_taint;
4615         break;
4616     case PERL_MAGIC_uvar:
4617         vtable = &PL_vtbl_uvar;
4618         break;
4619     case PERL_MAGIC_vec:
4620         vtable = &PL_vtbl_vec;
4621         break;
4622     case PERL_MAGIC_substr:
4623         vtable = &PL_vtbl_substr;
4624         break;
4625     case PERL_MAGIC_defelem:
4626         vtable = &PL_vtbl_defelem;
4627         break;
4628     case PERL_MAGIC_glob:
4629         vtable = &PL_vtbl_glob;
4630         break;
4631     case PERL_MAGIC_arylen:
4632         vtable = &PL_vtbl_arylen;
4633         break;
4634     case PERL_MAGIC_pos:
4635         vtable = &PL_vtbl_pos;
4636         break;
4637     case PERL_MAGIC_backref:
4638         vtable = &PL_vtbl_backref;
4639         break;
4640     case PERL_MAGIC_ext:
4641         /* Reserved for use by extensions not perl internals.           */
4642         /* Useful for attaching extension internal data to perl vars.   */
4643         /* Note that multiple extensions may clash if magical scalars   */
4644         /* etc holding private data from one are passed to another.     */
4645         break;
4646     default:
4647         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4648     }
4649
4650     /* Rest of work is done else where */
4651     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4652
4653     switch (how) {
4654     case PERL_MAGIC_taint:
4655         mg->mg_len = 1;
4656         break;
4657     case PERL_MAGIC_ext:
4658     case PERL_MAGIC_dbfile:
4659         SvRMAGICAL_on(sv);
4660         break;
4661     }
4662 }
4663
4664 /*
4665 =for apidoc sv_unmagic
4666
4667 Removes all magic of type C<type> from an SV.
4668
4669 =cut
4670 */
4671
4672 int
4673 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4674 {
4675     MAGIC* mg;
4676     MAGIC** mgp;
4677     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4678         return 0;
4679     mgp = &SvMAGIC(sv);
4680     for (mg = *mgp; mg; mg = *mgp) {
4681         if (mg->mg_type == type) {
4682             MGVTBL* vtbl = mg->mg_virtual;
4683             *mgp = mg->mg_moremagic;
4684             if (vtbl && vtbl->svt_free)
4685                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4686             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4687                 if (mg->mg_len > 0)
4688                     Safefree(mg->mg_ptr);
4689                 else if (mg->mg_len == HEf_SVKEY)
4690                     SvREFCNT_dec((SV*)mg->mg_ptr);
4691             }
4692             if (mg->mg_flags & MGf_REFCOUNTED)
4693                 SvREFCNT_dec(mg->mg_obj);
4694             Safefree(mg);
4695         }
4696         else
4697             mgp = &mg->mg_moremagic;
4698     }
4699     if (!SvMAGIC(sv)) {
4700         SvMAGICAL_off(sv);
4701        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4702     }
4703
4704     return 0;
4705 }
4706
4707 /*
4708 =for apidoc sv_rvweaken
4709
4710 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4711 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4712 push a back-reference to this RV onto the array of backreferences
4713 associated with that magic.
4714
4715 =cut
4716 */
4717
4718 SV *
4719 Perl_sv_rvweaken(pTHX_ SV *sv)
4720 {
4721     SV *tsv;
4722     if (!SvOK(sv))  /* let undefs pass */
4723         return sv;
4724     if (!SvROK(sv))
4725         Perl_croak(aTHX_ "Can't weaken a nonreference");
4726     else if (SvWEAKREF(sv)) {
4727         if (ckWARN(WARN_MISC))
4728             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4729         return sv;
4730     }
4731     tsv = SvRV(sv);
4732     sv_add_backref(tsv, sv);
4733     SvWEAKREF_on(sv);
4734     SvREFCNT_dec(tsv);
4735     return sv;
4736 }
4737
4738 /* Give tsv backref magic if it hasn't already got it, then push a
4739  * back-reference to sv onto the array associated with the backref magic.
4740  */
4741
4742 STATIC void
4743 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4744 {
4745     AV *av;
4746     MAGIC *mg;
4747     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4748         av = (AV*)mg->mg_obj;
4749     else {
4750         av = newAV();
4751         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4752         SvREFCNT_dec(av);           /* for sv_magic */
4753     }
4754     av_push(av,sv);
4755 }
4756
4757 /* delete a back-reference to ourselves from the backref magic associated
4758  * with the SV we point to.
4759  */
4760
4761 STATIC void
4762 S_sv_del_backref(pTHX_ SV *sv)
4763 {
4764     AV *av;
4765     SV **svp;
4766     I32 i;
4767     SV *tsv = SvRV(sv);
4768     MAGIC *mg = NULL;
4769     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4770         Perl_croak(aTHX_ "panic: del_backref");
4771     av = (AV *)mg->mg_obj;
4772     svp = AvARRAY(av);
4773     i = AvFILLp(av);
4774     while (i >= 0) {
4775         if (svp[i] == sv) {
4776             svp[i] = &PL_sv_undef; /* XXX */
4777         }
4778         i--;
4779     }
4780 }
4781
4782 /*
4783 =for apidoc sv_insert
4784
4785 Inserts a string at the specified offset/length within the SV. Similar to
4786 the Perl substr() function.
4787
4788 =cut
4789 */
4790
4791 void
4792 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4793 {
4794     register char *big;
4795     register char *mid;
4796     register char *midend;
4797     register char *bigend;
4798     register I32 i;
4799     STRLEN curlen;
4800
4801
4802     if (!bigstr)
4803         Perl_croak(aTHX_ "Can't modify non-existent substring");
4804     SvPV_force(bigstr, curlen);
4805     (void)SvPOK_only_UTF8(bigstr);
4806     if (offset + len > curlen) {
4807         SvGROW(bigstr, offset+len+1);
4808         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4809         SvCUR_set(bigstr, offset+len);
4810     }
4811
4812     SvTAINT(bigstr);
4813     i = littlelen - len;
4814     if (i > 0) {                        /* string might grow */
4815         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4816         mid = big + offset + len;
4817         midend = bigend = big + SvCUR(bigstr);
4818         bigend += i;
4819         *bigend = '\0';
4820         while (midend > mid)            /* shove everything down */
4821             *--bigend = *--midend;
4822         Move(little,big+offset,littlelen,char);
4823         SvCUR(bigstr) += i;
4824         SvSETMAGIC(bigstr);
4825         return;
4826     }
4827     else if (i == 0) {
4828         Move(little,SvPVX(bigstr)+offset,len,char);
4829         SvSETMAGIC(bigstr);
4830         return;
4831     }
4832
4833     big = SvPVX(bigstr);
4834     mid = big + offset;
4835     midend = mid + len;
4836     bigend = big + SvCUR(bigstr);
4837
4838     if (midend > bigend)
4839         Perl_croak(aTHX_ "panic: sv_insert");
4840
4841     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4842         if (littlelen) {
4843             Move(little, mid, littlelen,char);
4844             mid += littlelen;
4845         }
4846         i = bigend - midend;
4847         if (i > 0) {
4848             Move(midend, mid, i,char);
4849             mid += i;
4850         }
4851         *mid = '\0';
4852         SvCUR_set(bigstr, mid - big);
4853     }
4854     /*SUPPRESS 560*/
4855     else if ((i = mid - big)) { /* faster from front */
4856         midend -= littlelen;
4857         mid = midend;
4858         sv_chop(bigstr,midend-i);
4859         big += i;
4860         while (i--)
4861             *--midend = *--big;
4862         if (littlelen)
4863             Move(little, mid, littlelen,char);
4864     }
4865     else if (littlelen) {
4866         midend -= littlelen;
4867         sv_chop(bigstr,midend);
4868         Move(little,midend,littlelen,char);
4869     }
4870     else {
4871         sv_chop(bigstr,midend);
4872     }
4873     SvSETMAGIC(bigstr);
4874 }
4875
4876 /*
4877 =for apidoc sv_replace
4878
4879 Make the first argument a copy of the second, then delete the original.
4880 The target SV physically takes over ownership of the body of the source SV
4881 and inherits its flags; however, the target keeps any magic it owns,
4882 and any magic in the source is discarded.
4883 Note that this is a rather specialist SV copying operation; most of the
4884 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4885
4886 =cut
4887 */
4888
4889 void
4890 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4891 {
4892     U32 refcnt = SvREFCNT(sv);
4893     SV_CHECK_THINKFIRST(sv);
4894     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4895         Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
4896     if (SvMAGICAL(sv)) {
4897         if (SvMAGICAL(nsv))
4898             mg_free(nsv);
4899         else
4900             sv_upgrade(nsv, SVt_PVMG);
4901         SvMAGIC(nsv) = SvMAGIC(sv);
4902         SvFLAGS(nsv) |= SvMAGICAL(sv);
4903         SvMAGICAL_off(sv);
4904         SvMAGIC(sv) = 0;
4905     }
4906     SvREFCNT(sv) = 0;
4907     sv_clear(sv);
4908     assert(!SvREFCNT(sv));
4909     StructCopy(nsv,sv,SV);
4910     SvREFCNT(sv) = refcnt;
4911     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
4912     del_SV(nsv);
4913 }
4914
4915 /*
4916 =for apidoc sv_clear
4917
4918 Clear an SV: call any destructors, free up any memory used by the body,
4919 and free the body itself. The SV's head is I<not> freed, although
4920 its type is set to all 1's so that it won't inadvertently be assumed
4921 to be live during global destruction etc.
4922 This function should only be called when REFCNT is zero. Most of the time
4923 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4924 instead.
4925
4926 =cut
4927 */
4928
4929 void
4930 Perl_sv_clear(pTHX_ register SV *sv)
4931 {
4932     HV* stash;
4933     assert(sv);
4934     assert(SvREFCNT(sv) == 0);
4935
4936     if (SvOBJECT(sv)) {
4937         if (PL_defstash) {              /* Still have a symbol table? */
4938             dSP;
4939             CV* destructor;
4940             SV tmpref;
4941
4942             Zero(&tmpref, 1, SV);
4943             sv_upgrade(&tmpref, SVt_RV);
4944             SvROK_on(&tmpref);
4945             SvREADONLY_on(&tmpref);     /* DESTROY() could be naughty */
4946             SvREFCNT(&tmpref) = 1;
4947
4948             do {        
4949                 stash = SvSTASH(sv);
4950                 destructor = StashHANDLER(stash,DESTROY);
4951                 if (destructor) {
4952                     ENTER;
4953                     PUSHSTACKi(PERLSI_DESTROY);
4954                     SvRV(&tmpref) = SvREFCNT_inc(sv);
4955                     EXTEND(SP, 2);
4956                     PUSHMARK(SP);
4957                     PUSHs(&tmpref);
4958                     PUTBACK;
4959                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4960                     SvREFCNT(sv)--;
4961                     POPSTACK;
4962                     SPAGAIN;
4963                     LEAVE;
4964                 }
4965             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4966
4967             del_XRV(SvANY(&tmpref));
4968
4969             if (SvREFCNT(sv)) {
4970                 if (PL_in_clean_objs)
4971                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4972                           HvNAME(stash));
4973                 /* DESTROY gave object new lease on life */
4974                 return;
4975             }
4976         }
4977
4978         if (SvOBJECT(sv)) {
4979             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
4980             SvOBJECT_off(sv);   /* Curse the object. */
4981             if (SvTYPE(sv) != SVt_PVIO)
4982                 --PL_sv_objcount;       /* XXX Might want something more general */
4983         }
4984     }
4985     if (SvTYPE(sv) >= SVt_PVMG) {
4986         if (SvMAGIC(sv))
4987             mg_free(sv);
4988         if (SvFLAGS(sv) & SVpad_TYPED)
4989             SvREFCNT_dec(SvSTASH(sv));
4990     }
4991     stash = NULL;
4992     switch (SvTYPE(sv)) {
4993     case SVt_PVIO:
4994         if (IoIFP(sv) &&
4995             IoIFP(sv) != PerlIO_stdin() &&
4996             IoIFP(sv) != PerlIO_stdout() &&
4997             IoIFP(sv) != PerlIO_stderr())
4998         {
4999             io_close((IO*)sv, FALSE);
5000         }
5001         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5002             PerlDir_close(IoDIRP(sv));
5003         IoDIRP(sv) = (DIR*)NULL;
5004         Safefree(IoTOP_NAME(sv));
5005         Safefree(IoFMT_NAME(sv));
5006         Safefree(IoBOTTOM_NAME(sv));
5007         /* FALL THROUGH */
5008     case SVt_PVBM:
5009         goto freescalar;
5010     case SVt_PVCV:
5011     case SVt_PVFM:
5012         cv_undef((CV*)sv);
5013         goto freescalar;
5014     case SVt_PVHV:
5015         hv_undef((HV*)sv);
5016         break;
5017     case SVt_PVAV:
5018         av_undef((AV*)sv);
5019         break;
5020     case SVt_PVLV:
5021         SvREFCNT_dec(LvTARG(sv));
5022         goto freescalar;
5023     case SVt_PVGV:
5024         gp_free((GV*)sv);
5025         Safefree(GvNAME(sv));
5026         /* cannot decrease stash refcount yet, as we might recursively delete
5027            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5028            of stash until current sv is completely gone.
5029            -- JohnPC, 27 Mar 1998 */
5030         stash = GvSTASH(sv);
5031         /* FALL THROUGH */
5032     case SVt_PVMG:
5033     case SVt_PVNV:
5034     case SVt_PVIV:
5035       freescalar:
5036         (void)SvOOK_off(sv);
5037         /* FALL THROUGH */
5038     case SVt_PV:
5039     case SVt_RV:
5040         if (SvROK(sv)) {
5041             if (SvWEAKREF(sv))
5042                 sv_del_backref(sv);
5043             else
5044                 SvREFCNT_dec(SvRV(sv));
5045         }
5046         else if (SvPVX(sv) && SvLEN(sv))
5047             Safefree(SvPVX(sv));
5048         else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5049             unsharepvn(SvPVX(sv),
5050                        SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5051                        SvUVX(sv));
5052             SvFAKE_off(sv);
5053         }
5054         break;
5055 /*
5056     case SVt_NV:
5057     case SVt_IV:
5058     case SVt_NULL:
5059         break;
5060 */
5061     }
5062
5063     switch (SvTYPE(sv)) {
5064     case SVt_NULL:
5065         break;
5066     case SVt_IV:
5067         del_XIV(SvANY(sv));
5068         break;
5069     case SVt_NV:
5070         del_XNV(SvANY(sv));
5071         break;
5072     case SVt_RV:
5073         del_XRV(SvANY(sv));
5074         break;
5075     case SVt_PV:
5076         del_XPV(SvANY(sv));
5077         break;
5078     case SVt_PVIV:
5079         del_XPVIV(SvANY(sv));
5080         break;
5081     case SVt_PVNV:
5082         del_XPVNV(SvANY(sv));
5083         break;
5084     case SVt_PVMG:
5085         del_XPVMG(SvANY(sv));
5086         break;
5087     case SVt_PVLV:
5088         del_XPVLV(SvANY(sv));
5089         break;
5090     case SVt_PVAV:
5091         del_XPVAV(SvANY(sv));
5092         break;
5093     case SVt_PVHV:
5094         del_XPVHV(SvANY(sv));
5095         break;
5096     case SVt_PVCV:
5097         del_XPVCV(SvANY(sv));
5098         break;
5099     case SVt_PVGV:
5100         del_XPVGV(SvANY(sv));
5101         /* code duplication for increased performance. */
5102         SvFLAGS(sv) &= SVf_BREAK;
5103         SvFLAGS(sv) |= SVTYPEMASK;
5104         /* decrease refcount of the stash that owns this GV, if any */
5105         if (stash)
5106             SvREFCNT_dec(stash);
5107         return; /* not break, SvFLAGS reset already happened */
5108     case SVt_PVBM:
5109         del_XPVBM(SvANY(sv));
5110         break;
5111     case SVt_PVFM:
5112         del_XPVFM(SvANY(sv));
5113         break;
5114     case SVt_PVIO:
5115         del_XPVIO(SvANY(sv));
5116         break;
5117     }
5118     SvFLAGS(sv) &= SVf_BREAK;
5119     SvFLAGS(sv) |= SVTYPEMASK;
5120 }
5121
5122 /*
5123 =for apidoc sv_newref
5124
5125 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5126 instead.
5127
5128 =cut
5129 */
5130
5131 SV *
5132 Perl_sv_newref(pTHX_ SV *sv)
5133 {
5134     if (sv)
5135         ATOMIC_INC(SvREFCNT(sv));
5136     return sv;
5137 }
5138
5139 /*
5140 =for apidoc sv_free
5141
5142 Decrement an SV's reference count, and if it drops to zero, call
5143 C<sv_clear> to invoke destructors and free up any memory used by
5144 the body; finally, deallocate the SV's head itself.
5145 Normally called via a wrapper macro C<SvREFCNT_dec>.
5146
5147 =cut
5148 */
5149
5150 void
5151 Perl_sv_free(pTHX_ SV *sv)
5152 {
5153     int refcount_is_zero;
5154
5155     if (!sv)
5156         return;
5157     if (SvREFCNT(sv) == 0) {
5158         if (SvFLAGS(sv) & SVf_BREAK)
5159             /* this SV's refcnt has been artificially decremented to
5160              * trigger cleanup */
5161             return;
5162         if (PL_in_clean_all) /* All is fair */
5163             return;
5164         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5165             /* make sure SvREFCNT(sv)==0 happens very seldom */
5166             SvREFCNT(sv) = (~(U32)0)/2;
5167             return;
5168         }
5169         if (ckWARN_d(WARN_INTERNAL))
5170             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5171         return;
5172     }
5173     ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5174     if (!refcount_is_zero) {
5175         if (SvREFCNT(sv) == 1) {
5176             /* Break self-tie loops */
5177             MAGIC *mg = 0;
5178             SV *obj;
5179             if (SvTYPE(sv) == SVt_PVGV)
5180                 sv = (SV *)GvIO(sv);
5181             if (!sv || !SvMAGICAL(sv) || SvTYPE(sv) < SVt_PVMG)
5182                 return;
5183             mg = SvTIED_mg(sv, PERL_MAGIC_tiedscalar);
5184             if (mg && (obj = mg->mg_obj) && SvROK(obj) &&
5185                 (SvRV(obj) == sv || GvIO(SvRV(obj)) == (IO *) sv)) {
5186                 sv_unmagic(sv, PERL_MAGIC_tiedscalar);
5187             }
5188         }
5189         return;
5190     }
5191 #ifdef DEBUGGING
5192     if (SvTEMP(sv)) {
5193         if (ckWARN_d(WARN_DEBUGGING))
5194             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5195                         "Attempt to free temp prematurely: SV 0x%"UVxf,
5196                         PTR2UV(sv));
5197         return;
5198     }
5199 #endif
5200     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5201         /* make sure SvREFCNT(sv)==0 happens very seldom */
5202         SvREFCNT(sv) = (~(U32)0)/2;
5203         return;
5204     }
5205     sv_clear(sv);
5206     if (! SvREFCNT(sv))
5207         del_SV(sv);
5208 }
5209
5210 /*
5211 =for apidoc sv_len
5212
5213 Returns the length of the string in the SV. Handles magic and type
5214 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5215
5216 =cut
5217 */
5218
5219 STRLEN
5220 Perl_sv_len(pTHX_ register SV *sv)
5221 {
5222     STRLEN len;
5223
5224     if (!sv)
5225         return 0;
5226
5227     if (SvGMAGICAL(sv))
5228         len = mg_length(sv);
5229     else
5230         (void)SvPV(sv, len);
5231     return len;
5232 }
5233
5234 /*
5235 =for apidoc sv_len_utf8
5236
5237 Returns the number of characters in the string in an SV, counting wide
5238 UTF8 bytes as a single character. Handles magic and type coercion.
5239
5240 =cut
5241 */
5242
5243 STRLEN
5244 Perl_sv_len_utf8(pTHX_ register SV *sv)
5245 {
5246     if (!sv)
5247         return 0;
5248
5249     if (SvGMAGICAL(sv))
5250         return mg_length(sv);
5251     else
5252     {
5253         STRLEN len;
5254         U8 *s = (U8*)SvPV(sv, len);
5255
5256         return Perl_utf8_length(aTHX_ s, s + len);
5257     }
5258 }
5259
5260 /*
5261 =for apidoc sv_pos_u2b
5262
5263 Converts the value pointed to by offsetp from a count of UTF8 chars from
5264 the start of the string, to a count of the equivalent number of bytes; if
5265 lenp is non-zero, it does the same to lenp, but this time starting from
5266 the offset, rather than from the start of the string. Handles magic and
5267 type coercion.
5268
5269 =cut
5270 */
5271
5272 void
5273 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5274 {
5275     U8 *start;
5276     U8 *s;
5277     U8 *send;
5278     I32 uoffset = *offsetp;
5279     STRLEN len;
5280
5281     if (!sv)
5282         return;
5283
5284     start = s = (U8*)SvPV(sv, len);
5285     send = s + len;
5286     while (s < send && uoffset--)
5287         s += UTF8SKIP(s);
5288     if (s >= send)
5289         s = send;
5290     *offsetp = s - start;
5291     if (lenp) {
5292         I32 ulen = *lenp;
5293         start = s;
5294         while (s < send && ulen--)
5295             s += UTF8SKIP(s);
5296         if (s >= send)
5297             s = send;
5298         *lenp = s - start;
5299     }
5300     return;
5301 }
5302
5303 /*
5304 =for apidoc sv_pos_b2u
5305
5306 Converts the value pointed to by offsetp from a count of bytes from the
5307 start of the string, to a count of the equivalent number of UTF8 chars.
5308 Handles magic and type coercion.
5309
5310 =cut
5311 */
5312
5313 void
5314 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
5315 {
5316     U8 *s;
5317     U8 *send;
5318     STRLEN len;
5319
5320     if (!sv)
5321         return;
5322
5323     s = (U8*)SvPV(sv, len);
5324     if ((I32)len < *offsetp)
5325         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5326     send = s + *offsetp;
5327     len = 0;
5328     while (s < send) {
5329         STRLEN n;
5330         /* Call utf8n_to_uvchr() to validate the sequence */
5331         utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5332         if (n > 0) {
5333             s += n;
5334             len++;
5335         }
5336         else
5337             break;
5338     }
5339     *offsetp = len;
5340     return;
5341 }
5342
5343 /*
5344 =for apidoc sv_eq
5345
5346 Returns a boolean indicating whether the strings in the two SVs are
5347 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5348 coerce its args to strings if necessary.
5349
5350 =cut
5351 */
5352
5353 I32
5354 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5355 {
5356     char *pv1;
5357     STRLEN cur1;
5358     char *pv2;
5359     STRLEN cur2;
5360     I32  eq     = 0;
5361     char *tpv   = Nullch;
5362     SV* svrecode = Nullsv;
5363
5364     if (!sv1) {
5365         pv1 = "";
5366         cur1 = 0;
5367     }
5368     else
5369         pv1 = SvPV(sv1, cur1);
5370
5371     if (!sv2){
5372         pv2 = "";
5373         cur2 = 0;
5374     }
5375     else
5376         pv2 = SvPV(sv2, cur2);
5377
5378     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5379         /* Differing utf8ness.
5380          * Do not UTF8size the comparands as a side-effect. */
5381          if (PL_encoding) {
5382               if (SvUTF8(sv1)) {
5383                    svrecode = newSVpvn(pv2, cur2);
5384                    sv_recode_to_utf8(svrecode, PL_encoding);
5385                    pv2 = SvPV(svrecode, cur2);
5386               }
5387               else {
5388                    svrecode = newSVpvn(pv1, cur1);
5389                    sv_recode_to_utf8(svrecode, PL_encoding);
5390                    pv1 = SvPV(svrecode, cur1);
5391               }
5392               /* Now both are in UTF-8. */
5393               if (cur1 != cur2)
5394                    return FALSE;
5395          }
5396          else {
5397               bool is_utf8 = TRUE;
5398
5399               if (SvUTF8(sv1)) {
5400                    /* sv1 is the UTF-8 one,
5401                     * if is equal it must be downgrade-able */
5402                    char *pv = (char*)bytes_from_utf8((U8*)pv1,
5403                                                      &cur1, &is_utf8);
5404                    if (pv != pv1)
5405                         pv1 = tpv = pv;
5406               }
5407               else {
5408                    /* sv2 is the UTF-8 one,
5409                     * if is equal it must be downgrade-able */
5410                    char *pv = (char *)bytes_from_utf8((U8*)pv2,
5411                                                       &cur2, &is_utf8);
5412                    if (pv != pv2)
5413                         pv2 = tpv = pv;
5414               }
5415               if (is_utf8) {
5416                    /* Downgrade not possible - cannot be eq */
5417                    return FALSE;
5418               }
5419          }
5420     }
5421
5422     if (cur1 == cur2)
5423         eq = memEQ(pv1, pv2, cur1);
5424         
5425     if (svrecode)
5426          SvREFCNT_dec(svrecode);
5427
5428     if (tpv)
5429         Safefree(tpv);
5430
5431     return eq;
5432 }
5433
5434 /*
5435 =for apidoc sv_cmp
5436
5437 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
5438 string in C<sv1> is less than, equal to, or greater than the string in
5439 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5440 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
5441
5442 =cut
5443 */
5444
5445 I32
5446 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5447 {
5448     STRLEN cur1, cur2;
5449     char *pv1, *pv2, *tpv = Nullch;
5450     I32  cmp;
5451     SV *svrecode = Nullsv;
5452
5453     if (!sv1) {
5454         pv1 = "";
5455         cur1 = 0;
5456     }
5457     else
5458         pv1 = SvPV(sv1, cur1);
5459
5460     if (!sv2) {
5461         pv2 = "";
5462         cur2 = 0;
5463     }
5464     else
5465         pv2 = SvPV(sv2, cur2);
5466
5467     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5468         /* Differing utf8ness.
5469          * Do not UTF8size the comparands as a side-effect. */
5470         if (SvUTF8(sv1)) {
5471             if (PL_encoding) {
5472                  svrecode = newSVpvn(pv2, cur2);
5473                  sv_recode_to_utf8(svrecode, PL_encoding);
5474                  pv2 = SvPV(svrecode, cur2);
5475             }
5476             else {
5477                  pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5478             }
5479         }
5480         else {
5481             if (PL_encoding) {
5482                  svrecode = newSVpvn(pv1, cur1);
5483                  sv_recode_to_utf8(svrecode, PL_encoding);
5484                  pv1 = SvPV(svrecode, cur1);
5485             }
5486             else {
5487                  pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5488             }
5489         }
5490     }
5491
5492     if (!cur1) {
5493         cmp = cur2 ? -1 : 0;
5494     } else if (!cur2) {
5495         cmp = 1;
5496     } else {
5497         I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
5498
5499         if (retval) {
5500             cmp = retval < 0 ? -1 : 1;
5501         } else if (cur1 == cur2) {
5502             cmp = 0;
5503         } else {
5504             cmp = cur1 < cur2 ? -1 : 1;
5505         }
5506     }
5507
5508     if (svrecode)
5509          SvREFCNT_dec(svrecode);
5510
5511     if (tpv)
5512         Safefree(tpv);
5513
5514     return cmp;
5515 }
5516
5517 /*
5518 =for apidoc sv_cmp_locale
5519
5520 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5521 'use bytes' aware, handles get magic, and will coerce its args to strings
5522 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
5523
5524 =cut
5525 */
5526
5527 I32
5528 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5529 {
5530 #ifdef USE_LOCALE_COLLATE
5531
5532     char *pv1, *pv2;
5533     STRLEN len1, len2;
5534     I32 retval;
5535
5536     if (PL_collation_standard)
5537         goto raw_compare;
5538
5539     len1 = 0;
5540     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5541     len2 = 0;
5542     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5543
5544     if (!pv1 || !len1) {
5545         if (pv2 && len2)
5546             return -1;
5547         else
5548             goto raw_compare;
5549     }
5550     else {
5551         if (!pv2 || !len2)
5552             return 1;
5553     }
5554
5555     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5556
5557     if (retval)
5558         return retval < 0 ? -1 : 1;
5559
5560     /*
5561      * When the result of collation is equality, that doesn't mean
5562      * that there are no differences -- some locales exclude some
5563      * characters from consideration.  So to avoid false equalities,
5564      * we use the raw string as a tiebreaker.
5565      */
5566
5567   raw_compare:
5568     /* FALL THROUGH */
5569
5570 #endif /* USE_LOCALE_COLLATE */
5571
5572     return sv_cmp(sv1, sv2);
5573 }
5574
5575
5576 #ifdef USE_LOCALE_COLLATE
5577
5578 /*
5579 =for apidoc sv_collxfrm
5580
5581 Add Collate Transform magic to an SV if it doesn't already have it.
5582
5583 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5584 scalar data of the variable, but transformed to such a format that a normal
5585 memory comparison can be used to compare the data according to the locale
5586 settings.
5587
5588 =cut
5589 */
5590
5591 char *
5592 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5593 {
5594     MAGIC *mg;
5595
5596     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5597     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5598         char *s, *xf;
5599         STRLEN len, xlen;
5600
5601         if (mg)
5602             Safefree(mg->mg_ptr);
5603         s = SvPV(sv, len);
5604         if ((xf = mem_collxfrm(s, len, &xlen))) {
5605             if (SvREADONLY(sv)) {
5606                 SAVEFREEPV(xf);
5607                 *nxp = xlen;
5608                 return xf + sizeof(PL_collation_ix);
5609             }
5610             if (! mg) {
5611                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5612                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5613                 assert(mg);
5614             }
5615             mg->mg_ptr = xf;
5616             mg->mg_len = xlen;
5617         }
5618         else {
5619             if (mg) {
5620                 mg->mg_ptr = NULL;
5621                 mg->mg_len = -1;
5622             }
5623         }
5624     }
5625     if (mg && mg->mg_ptr) {
5626         *nxp = mg->mg_len;
5627         return mg->mg_ptr + sizeof(PL_collation_ix);
5628     }
5629     else {
5630         *nxp = 0;
5631         return NULL;
5632     }
5633 }
5634
5635 #endif /* USE_LOCALE_COLLATE */
5636
5637 /*
5638 =for apidoc sv_gets
5639
5640 Get a line from the filehandle and store it into the SV, optionally
5641 appending to the currently-stored string.
5642
5643 =cut
5644 */
5645
5646 char *
5647 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5648 {
5649     char *rsptr;
5650     STRLEN rslen;
5651     register STDCHAR rslast;
5652     register STDCHAR *bp;
5653     register I32 cnt;
5654     I32 i = 0;
5655     I32 rspara = 0;
5656
5657     SV_CHECK_THINKFIRST(sv);
5658     (void)SvUPGRADE(sv, SVt_PV);
5659
5660     SvSCREAM_off(sv);
5661
5662     if (PL_curcop == &PL_compiling) {
5663         /* we always read code in line mode */
5664         rsptr = "\n";
5665         rslen = 1;
5666     }
5667     else if (RsSNARF(PL_rs)) {
5668         rsptr = NULL;
5669         rslen = 0;
5670     }
5671     else if (RsRECORD(PL_rs)) {
5672       I32 recsize, bytesread;
5673       char *buffer;
5674
5675       /* Grab the size of the record we're getting */
5676       recsize = SvIV(SvRV(PL_rs));
5677       (void)SvPOK_only(sv);    /* Validate pointer */
5678       buffer = SvGROW(sv, (STRLEN)(recsize + 1));
5679       /* Go yank in */
5680 #ifdef VMS
5681       /* VMS wants read instead of fread, because fread doesn't respect */
5682       /* RMS record boundaries. This is not necessarily a good thing to be */
5683       /* doing, but we've got no other real choice */
5684       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5685 #else
5686       bytesread = PerlIO_read(fp, buffer, recsize);
5687 #endif
5688       SvCUR_set(sv, bytesread);
5689       buffer[bytesread] = '\0';
5690       if (PerlIO_isutf8(fp))
5691         SvUTF8_on(sv);
5692       else
5693         SvUTF8_off(sv);
5694       return(SvCUR(sv) ? SvPVX(sv) : Nullch);
5695     }
5696     else if (RsPARA(PL_rs)) {
5697         rsptr = "\n\n";
5698         rslen = 2;
5699         rspara = 1;
5700     }
5701     else {
5702         /* Get $/ i.e. PL_rs into same encoding as stream wants */
5703         if (PerlIO_isutf8(fp)) {
5704             rsptr = SvPVutf8(PL_rs, rslen);
5705         }
5706         else {
5707             if (SvUTF8(PL_rs)) {
5708                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5709                     Perl_croak(aTHX_ "Wide character in $/");
5710                 }
5711             }
5712             rsptr = SvPV(PL_rs, rslen);
5713         }
5714     }
5715
5716     rslast = rslen ? rsptr[rslen - 1] : '\0';
5717
5718     if (rspara) {               /* have to do this both before and after */
5719         do {                    /* to make sure file boundaries work right */
5720             if (PerlIO_eof(fp))
5721                 return 0;
5722             i = PerlIO_getc(fp);
5723             if (i != '\n') {
5724                 if (i == -1)
5725                     return 0;
5726                 PerlIO_ungetc(fp,i);
5727                 break;
5728             }
5729         } while (i != EOF);
5730     }
5731
5732     /* See if we know enough about I/O mechanism to cheat it ! */
5733
5734     /* This used to be #ifdef test - it is made run-time test for ease
5735        of abstracting out stdio interface. One call should be cheap
5736        enough here - and may even be a macro allowing compile
5737        time optimization.
5738      */
5739
5740     if (PerlIO_fast_gets(fp)) {
5741
5742     /*
5743      * We're going to steal some values from the stdio struct
5744      * and put EVERYTHING in the innermost loop into registers.
5745      */
5746     register STDCHAR *ptr;
5747     STRLEN bpx;
5748     I32 shortbuffered;
5749
5750 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5751     /* An ungetc()d char is handled separately from the regular
5752      * buffer, so we getc() it back out and stuff it in the buffer.
5753      */
5754     i = PerlIO_getc(fp);
5755     if (i == EOF) return 0;
5756     *(--((*fp)->_ptr)) = (unsigned char) i;
5757     (*fp)->_cnt++;
5758 #endif
5759
5760     /* Here is some breathtakingly efficient cheating */
5761
5762     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
5763     (void)SvPOK_only(sv);               /* validate pointer */
5764     if ((I32)(SvLEN(sv) - append) <= cnt + 1) { /* make sure we have the room */
5765         if (cnt > 80 && (I32)SvLEN(sv) > append) {
5766             shortbuffered = cnt - SvLEN(sv) + append + 1;
5767             cnt -= shortbuffered;
5768         }
5769         else {
5770             shortbuffered = 0;
5771             /* remember that cnt can be negative */
5772             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5773         }
5774     }
5775     else
5776         shortbuffered = 0;
5777     bp = (STDCHAR*)SvPVX(sv) + append;  /* move these two too to registers */
5778     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5779     DEBUG_P(PerlIO_printf(Perl_debug_log,
5780         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5781     DEBUG_P(PerlIO_printf(Perl_debug_log,
5782         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5783                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5784                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5785     for (;;) {
5786       screamer:
5787         if (cnt > 0) {
5788             if (rslen) {
5789                 while (cnt > 0) {                    /* this     |  eat */
5790                     cnt--;
5791                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
5792                         goto thats_all_folks;        /* screams  |  sed :-) */
5793                 }
5794             }
5795             else {
5796                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
5797                 bp += cnt;                           /* screams  |  dust */
5798                 ptr += cnt;                          /* louder   |  sed :-) */
5799                 cnt = 0;
5800             }
5801         }
5802         
5803         if (shortbuffered) {            /* oh well, must extend */
5804             cnt = shortbuffered;
5805             shortbuffered = 0;
5806             bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5807             SvCUR_set(sv, bpx);
5808             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5809             bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5810             continue;
5811         }
5812
5813         DEBUG_P(PerlIO_printf(Perl_debug_log,
5814                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5815                               PTR2UV(ptr),(long)cnt));
5816         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5817 #if 0
5818         DEBUG_P(PerlIO_printf(Perl_debug_log,
5819             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5820             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5821             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5822 #endif
5823         /* This used to call 'filbuf' in stdio form, but as that behaves like
5824            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5825            another abstraction.  */
5826         i   = PerlIO_getc(fp);          /* get more characters */
5827 #if 0
5828         DEBUG_P(PerlIO_printf(Perl_debug_log,
5829             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5830             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5831             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5832 #endif
5833         cnt = PerlIO_get_cnt(fp);
5834         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
5835         DEBUG_P(PerlIO_printf(Perl_debug_log,
5836             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5837
5838         if (i == EOF)                   /* all done for ever? */
5839             goto thats_really_all_folks;
5840
5841         bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5842         SvCUR_set(sv, bpx);
5843         SvGROW(sv, bpx + cnt + 2);
5844         bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5845
5846         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
5847
5848         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
5849             goto thats_all_folks;
5850     }
5851
5852 thats_all_folks:
5853     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
5854           memNE((char*)bp - rslen, rsptr, rslen))
5855         goto screamer;                          /* go back to the fray */
5856 thats_really_all_folks:
5857     if (shortbuffered)
5858         cnt += shortbuffered;
5859         DEBUG_P(PerlIO_printf(Perl_debug_log,
5860             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5861     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
5862     DEBUG_P(PerlIO_printf(Perl_debug_log,
5863         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5864         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5865         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5866     *bp = '\0';
5867     SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv));    /* set length */
5868     DEBUG_P(PerlIO_printf(Perl_debug_log,
5869         "Screamer: done, len=%ld, string=|%.*s|\n",
5870         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
5871     }
5872    else
5873     {
5874 #ifndef EPOC
5875        /*The big, slow, and stupid way */
5876         STDCHAR buf[8192];
5877 #else
5878         /* Need to work around EPOC SDK features          */
5879         /* On WINS: MS VC5 generates calls to _chkstk,    */
5880         /* if a `large' stack frame is allocated          */
5881         /* gcc on MARM does not generate calls like these */
5882         STDCHAR buf[1024];
5883 #endif
5884
5885 screamer2:
5886         if (rslen) {
5887             register STDCHAR *bpe = buf + sizeof(buf);
5888             bp = buf;
5889             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5890                 ; /* keep reading */
5891             cnt = bp - buf;
5892         }
5893         else {
5894             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5895             /* Accomodate broken VAXC compiler, which applies U8 cast to
5896              * both args of ?: operator, causing EOF to change into 255
5897              */
5898             if (cnt) { i = (U8)buf[cnt - 1]; } else { i = EOF; }
5899         }
5900
5901         if (append)
5902             sv_catpvn(sv, (char *) buf, cnt);
5903         else
5904             sv_setpvn(sv, (char *) buf, cnt);
5905
5906         if (i != EOF &&                 /* joy */
5907             (!rslen ||
5908              SvCUR(sv) < rslen ||
5909              memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5910         {
5911             append = -1;
5912             /*
5913              * If we're reading from a TTY and we get a short read,
5914              * indicating that the user hit his EOF character, we need
5915              * to notice it now, because if we try to read from the TTY
5916              * again, the EOF condition will disappear.
5917              *
5918              * The comparison of cnt to sizeof(buf) is an optimization
5919              * that prevents unnecessary calls to feof().
5920              *
5921              * - jik 9/25/96
5922              */
5923             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5924                 goto screamer2;
5925         }
5926     }
5927
5928     if (rspara) {               /* have to do this both before and after */
5929         while (i != EOF) {      /* to make sure file boundaries work right */
5930             i = PerlIO_getc(fp);
5931             if (i != '\n') {
5932                 PerlIO_ungetc(fp,i);
5933                 break;
5934             }
5935         }
5936     }
5937
5938     if (PerlIO_isutf8(fp))
5939         SvUTF8_on(sv);
5940     else
5941         SvUTF8_off(sv);
5942
5943     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5944 }
5945
5946 /*
5947 =for apidoc sv_inc
5948
5949 Auto-increment of the value in the SV, doing string to numeric conversion
5950 if necessary. Handles 'get' magic.
5951
5952 =cut
5953 */
5954
5955 void
5956 Perl_sv_inc(pTHX_ register SV *sv)
5957 {
5958     register char *d;
5959     int flags;
5960
5961     if (!sv)
5962         return;
5963     if (SvGMAGICAL(sv))
5964         mg_get(sv);
5965     if (SvTHINKFIRST(sv)) {
5966         if (SvREADONLY(sv) && SvFAKE(sv))
5967             sv_force_normal(sv);
5968         if (SvREADONLY(sv)) {
5969             if (PL_curcop != &PL_compiling)
5970                 Perl_croak(aTHX_ PL_no_modify);
5971         }
5972         if (SvROK(sv)) {
5973             IV i;
5974             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5975                 return;
5976             i = PTR2IV(SvRV(sv));
5977             sv_unref(sv);
5978             sv_setiv(sv, i);
5979         }
5980     }
5981     flags = SvFLAGS(sv);
5982     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5983         /* It's (privately or publicly) a float, but not tested as an
5984            integer, so test it to see. */
5985         (void) SvIV(sv);
5986         flags = SvFLAGS(sv);
5987     }
5988     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5989         /* It's publicly an integer, or privately an integer-not-float */
5990 #ifdef PERL_PRESERVE_IVUV
5991       oops_its_int:
5992 #endif
5993         if (SvIsUV(sv)) {
5994             if (SvUVX(sv) == UV_MAX)
5995                 sv_setnv(sv, UV_MAX_P1);
5996             else
5997                 (void)SvIOK_only_UV(sv);
5998                 ++SvUVX(sv);
5999         } else {
6000             if (SvIVX(sv) == IV_MAX)
6001                 sv_setuv(sv, (UV)IV_MAX + 1);
6002             else {
6003                 (void)SvIOK_only(sv);
6004                 ++SvIVX(sv);
6005             }   
6006         }
6007         return;
6008     }
6009     if (flags & SVp_NOK) {
6010         (void)SvNOK_only(sv);
6011         SvNVX(sv) += 1.0;
6012         return;
6013     }
6014
6015     if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6016         if ((flags & SVTYPEMASK) < SVt_PVIV)
6017             sv_upgrade(sv, SVt_IV);
6018         (void)SvIOK_only(sv);
6019         SvIVX(sv) = 1;
6020         return;
6021     }
6022     d = SvPVX(sv);
6023     while (isALPHA(*d)) d++;
6024     while (isDIGIT(*d)) d++;
6025     if (*d) {
6026 #ifdef PERL_PRESERVE_IVUV
6027         /* Got to punt this as an integer if needs be, but we don't issue
6028            warnings. Probably ought to make the sv_iv_please() that does
6029            the conversion if possible, and silently.  */
6030         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6031         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6032             /* Need to try really hard to see if it's an integer.
6033                9.22337203685478e+18 is an integer.
6034                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6035                so $a="9.22337203685478e+18"; $a+0; $a++
6036                needs to be the same as $a="9.22337203685478e+18"; $a++
6037                or we go insane. */
6038         
6039             (void) sv_2iv(sv);
6040             if (SvIOK(sv))
6041                 goto oops_its_int;
6042
6043             /* sv_2iv *should* have made this an NV */
6044             if (flags & SVp_NOK) {
6045                 (void)SvNOK_only(sv);
6046                 SvNVX(sv) += 1.0;
6047                 return;
6048             }
6049             /* I don't think we can get here. Maybe I should assert this
6050                And if we do get here I suspect that sv_setnv will croak. NWC
6051                Fall through. */
6052 #if defined(USE_LONG_DOUBLE)
6053             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",
6054                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6055 #else
6056             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6057                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6058 #endif
6059         }
6060 #endif /* PERL_PRESERVE_IVUV */
6061         sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6062         return;
6063     }
6064     d--;
6065     while (d >= SvPVX(sv)) {
6066         if (isDIGIT(*d)) {
6067             if (++*d <= '9')
6068                 return;
6069             *(d--) = '0';
6070         }
6071         else {
6072 #ifdef EBCDIC
6073             /* MKS: The original code here died if letters weren't consecutive.
6074              * at least it didn't have to worry about non-C locales.  The
6075              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6076              * arranged in order (although not consecutively) and that only
6077              * [A-Za-z] are accepted by isALPHA in the C locale.
6078              */
6079             if (*d != 'z' && *d != 'Z') {
6080                 do { ++*d; } while (!isALPHA(*d));
6081                 return;
6082             }
6083             *(d--) -= 'z' - 'a';
6084 #else
6085             ++*d;
6086             if (isALPHA(*d))
6087                 return;
6088             *(d--) -= 'z' - 'a' + 1;
6089 #endif
6090         }
6091     }
6092     /* oh,oh, the number grew */
6093     SvGROW(sv, SvCUR(sv) + 2);
6094     SvCUR(sv)++;
6095     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6096         *d = d[-1];
6097     if (isDIGIT(d[1]))
6098         *d = '1';
6099     else
6100         *d = d[1];
6101 }
6102
6103 /*
6104 =for apidoc sv_dec
6105
6106 Auto-decrement of the value in the SV, doing string to numeric conversion
6107 if necessary. Handles 'get' magic.
6108
6109 =cut
6110 */
6111
6112 void
6113 Perl_sv_dec(pTHX_ register SV *sv)
6114 {
6115     int flags;
6116
6117     if (!sv)
6118         return;
6119     if (SvGMAGICAL(sv))
6120         mg_get(sv);
6121     if (SvTHINKFIRST(sv)) {
6122         if (SvREADONLY(sv) && SvFAKE(sv))
6123             sv_force_normal(sv);
6124         if (SvREADONLY(sv)) {
6125             if (PL_curcop != &PL_compiling)
6126                 Perl_croak(aTHX_ PL_no_modify);
6127         }
6128         if (SvROK(sv)) {
6129             IV i;
6130             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6131                 return;
6132             i = PTR2IV(SvRV(sv));
6133             sv_unref(sv);
6134             sv_setiv(sv, i);
6135         }
6136     }
6137     /* Unlike sv_inc we don't have to worry about string-never-numbers
6138        and keeping them magic. But we mustn't warn on punting */
6139     flags = SvFLAGS(sv);
6140     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6141         /* It's publicly an integer, or privately an integer-not-float */
6142 #ifdef PERL_PRESERVE_IVUV
6143       oops_its_int:
6144 #endif
6145         if (SvIsUV(sv)) {
6146             if (SvUVX(sv) == 0) {
6147                 (void)SvIOK_only(sv);
6148                 SvIVX(sv) = -1;
6149             }
6150             else {
6151                 (void)SvIOK_only_UV(sv);
6152                 --SvUVX(sv);
6153             }   
6154         } else {
6155             if (SvIVX(sv) == IV_MIN)
6156                 sv_setnv(sv, (NV)IV_MIN - 1.0);
6157             else {
6158                 (void)SvIOK_only(sv);
6159                 --SvIVX(sv);
6160             }   
6161         }
6162         return;
6163     }
6164     if (flags & SVp_NOK) {
6165         SvNVX(sv) -= 1.0;
6166         (void)SvNOK_only(sv);
6167         return;
6168     }
6169     if (!(flags & SVp_POK)) {
6170         if ((flags & SVTYPEMASK) < SVt_PVNV)
6171             sv_upgrade(sv, SVt_NV);
6172         SvNVX(sv) = -1.0;
6173         (void)SvNOK_only(sv);
6174         return;
6175     }
6176 #ifdef PERL_PRESERVE_IVUV
6177     {
6178         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6179         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6180             /* Need to try really hard to see if it's an integer.
6181                9.22337203685478e+18 is an integer.
6182                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6183                so $a="9.22337203685478e+18"; $a+0; $a--
6184                needs to be the same as $a="9.22337203685478e+18"; $a--
6185                or we go insane. */
6186         
6187             (void) sv_2iv(sv);
6188             if (SvIOK(sv))
6189                 goto oops_its_int;
6190
6191             /* sv_2iv *should* have made this an NV */
6192             if (flags & SVp_NOK) {
6193                 (void)SvNOK_only(sv);
6194                 SvNVX(sv) -= 1.0;
6195                 return;
6196             }
6197             /* I don't think we can get here. Maybe I should assert this
6198                And if we do get here I suspect that sv_setnv will croak. NWC
6199                Fall through. */
6200 #if defined(USE_LONG_DOUBLE)
6201             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",
6202                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6203 #else
6204             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6205                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6206 #endif
6207         }
6208     }
6209 #endif /* PERL_PRESERVE_IVUV */
6210     sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6211 }
6212
6213 /*
6214 =for apidoc sv_mortalcopy
6215
6216 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6217 The new SV is marked as mortal. It will be destroyed "soon", either by an
6218 explicit call to FREETMPS, or by an implicit call at places such as
6219 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
6220
6221 =cut
6222 */
6223
6224 /* Make a string that will exist for the duration of the expression
6225  * evaluation.  Actually, it may have to last longer than that, but
6226  * hopefully we won't free it until it has been assigned to a
6227  * permanent location. */
6228
6229 SV *
6230 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6231 {
6232     register SV *sv;
6233     new_SV(sv);
6234     sv_setsv(sv,oldstr);
6235     EXTEND_MORTAL(1);
6236     PL_tmps_stack[++PL_tmps_ix] = sv;
6237     SvTEMP_on(sv);
6238     return sv;
6239 }
6240
6241 /*
6242 =for apidoc sv_newmortal
6243
6244 Creates a new null SV which is mortal.  The reference count of the SV is
6245 set to 1. It will be destroyed "soon", either by an explicit call to
6246 FREETMPS, or by an implicit call at places such as statement boundaries.
6247 See also C<sv_mortalcopy> and C<sv_2mortal>.
6248
6249 =cut
6250 */
6251
6252 SV *
6253 Perl_sv_newmortal(pTHX)
6254 {
6255     register SV *sv;
6256
6257     new_SV(sv);
6258     SvFLAGS(sv) = SVs_TEMP;
6259     EXTEND_MORTAL(1);
6260     PL_tmps_stack[++PL_tmps_ix] = sv;
6261     return sv;
6262 }
6263
6264 /*
6265 =for apidoc sv_2mortal
6266
6267 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
6268 by an explicit call to FREETMPS, or by an implicit call at places such as
6269 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
6270
6271 =cut
6272 */
6273
6274 SV *
6275 Perl_sv_2mortal(pTHX_ register SV *sv)
6276 {
6277     if (!sv)
6278         return sv;
6279     if (SvREADONLY(sv) && SvIMMORTAL(sv))
6280         return sv;
6281     EXTEND_MORTAL(1);
6282     PL_tmps_stack[++PL_tmps_ix] = sv;
6283     SvTEMP_on(sv);
6284     return sv;
6285 }
6286
6287 /*
6288 =for apidoc newSVpv
6289
6290 Creates a new SV and copies a string into it.  The reference count for the
6291 SV is set to 1.  If C<len> is zero, Perl will compute the length using
6292 strlen().  For efficiency, consider using C<newSVpvn> instead.
6293
6294 =cut
6295 */
6296
6297 SV *
6298 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6299 {
6300     register SV *sv;
6301
6302     new_SV(sv);
6303     if (!len)
6304         len = strlen(s);
6305     sv_setpvn(sv,s,len);
6306     return sv;
6307 }
6308
6309 /*
6310 =for apidoc newSVpvn
6311
6312 Creates a new SV and copies a string into it.  The reference count for the
6313 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
6314 string.  You are responsible for ensuring that the source string is at least
6315 C<len> bytes long.
6316
6317 =cut
6318 */
6319
6320 SV *
6321 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6322 {
6323     register SV *sv;
6324
6325     new_SV(sv);
6326     sv_setpvn(sv,s,len);
6327     return sv;
6328 }
6329
6330 /*
6331 =for apidoc newSVpvn_share
6332
6333 Creates a new SV with its SvPVX pointing to a shared string in the string
6334 table. If the string does not already exist in the table, it is created
6335 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
6336 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6337 otherwise the hash is computed.  The idea here is that as the string table
6338 is used for shared hash keys these strings will have SvPVX == HeKEY and
6339 hash lookup will avoid string compare.
6340
6341 =cut
6342 */
6343
6344 SV *
6345 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6346 {
6347     register SV *sv;
6348     bool is_utf8 = FALSE;
6349     if (len < 0) {
6350         STRLEN tmplen = -len;
6351         is_utf8 = TRUE;
6352         /* See the note in hv.c:hv_fetch() --jhi */
6353         src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6354         len = tmplen;
6355     }
6356     if (!hash)
6357         PERL_HASH(hash, src, len);
6358     new_SV(sv);
6359     sv_upgrade(sv, SVt_PVIV);
6360     SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6361     SvCUR(sv) = len;
6362     SvUVX(sv) = hash;
6363     SvLEN(sv) = 0;
6364     SvREADONLY_on(sv);
6365     SvFAKE_on(sv);
6366     SvPOK_on(sv);
6367     if (is_utf8)
6368         SvUTF8_on(sv);
6369     return sv;
6370 }
6371
6372
6373 #if defined(PERL_IMPLICIT_CONTEXT)
6374
6375 /* pTHX_ magic can't cope with varargs, so this is a no-context
6376  * version of the main function, (which may itself be aliased to us).
6377  * Don't access this version directly.
6378  */
6379
6380 SV *
6381 Perl_newSVpvf_nocontext(const char* pat, ...)
6382 {
6383     dTHX;
6384     register SV *sv;
6385     va_list args;
6386     va_start(args, pat);
6387     sv = vnewSVpvf(pat, &args);
6388     va_end(args);
6389     return sv;
6390 }
6391 #endif
6392
6393 /*
6394 =for apidoc newSVpvf
6395
6396 Creates a new SV and initializes it with the string formatted like
6397 C<sprintf>.
6398
6399 =cut
6400 */
6401
6402 SV *
6403 Perl_newSVpvf(pTHX_ const char* pat, ...)
6404 {
6405     register SV *sv;
6406     va_list args;
6407     va_start(args, pat);
6408     sv = vnewSVpvf(pat, &args);
6409     va_end(args);
6410     return sv;
6411 }
6412
6413 /* backend for newSVpvf() and newSVpvf_nocontext() */
6414
6415 SV *
6416 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6417 {
6418     register SV *sv;
6419     new_SV(sv);
6420     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6421     return sv;
6422 }
6423
6424 /*
6425 =for apidoc newSVnv
6426
6427 Creates a new SV and copies a floating point value into it.
6428 The reference count for the SV is set to 1.
6429
6430 =cut
6431 */
6432
6433 SV *
6434 Perl_newSVnv(pTHX_ NV n)
6435 {
6436     register SV *sv;
6437
6438     new_SV(sv);
6439     sv_setnv(sv,n);
6440     return sv;
6441 }
6442
6443 /*
6444 =for apidoc newSViv
6445
6446 Creates a new SV and copies an integer into it.  The reference count for the
6447 SV is set to 1.
6448
6449 =cut
6450 */
6451
6452 SV *
6453 Perl_newSViv(pTHX_ IV i)
6454 {
6455     register SV *sv;
6456
6457     new_SV(sv);
6458     sv_setiv(sv,i);
6459     return sv;
6460 }
6461
6462 /*
6463 =for apidoc newSVuv
6464
6465 Creates a new SV and copies an unsigned integer into it.
6466 The reference count for the SV is set to 1.
6467
6468 =cut
6469 */
6470
6471 SV *
6472 Perl_newSVuv(pTHX_ UV u)
6473 {
6474     register SV *sv;
6475
6476     new_SV(sv);
6477     sv_setuv(sv,u);
6478     return sv;
6479 }
6480
6481 /*
6482 =for apidoc newRV_noinc
6483
6484 Creates an RV wrapper for an SV.  The reference count for the original
6485 SV is B<not> incremented.
6486
6487 =cut
6488 */
6489
6490 SV *
6491 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6492 {
6493     register SV *sv;
6494
6495     new_SV(sv);
6496     sv_upgrade(sv, SVt_RV);
6497     SvTEMP_off(tmpRef);
6498     SvRV(sv) = tmpRef;
6499     SvROK_on(sv);
6500     return sv;
6501 }
6502
6503 /* newRV_inc is the official function name to use now.
6504  * newRV_inc is in fact #defined to newRV in sv.h
6505  */
6506
6507 SV *
6508 Perl_newRV(pTHX_ SV *tmpRef)
6509 {
6510     return newRV_noinc(SvREFCNT_inc(tmpRef));
6511 }
6512
6513 /*
6514 =for apidoc newSVsv
6515
6516 Creates a new SV which is an exact duplicate of the original SV.
6517 (Uses C<sv_setsv>).
6518
6519 =cut
6520 */
6521
6522 SV *
6523 Perl_newSVsv(pTHX_ register SV *old)
6524 {
6525     register SV *sv;
6526
6527     if (!old)
6528         return Nullsv;
6529     if (SvTYPE(old) == SVTYPEMASK) {
6530         if (ckWARN_d(WARN_INTERNAL))
6531             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6532         return Nullsv;
6533     }
6534     new_SV(sv);
6535     if (SvTEMP(old)) {
6536         SvTEMP_off(old);
6537         sv_setsv(sv,old);
6538         SvTEMP_on(old);
6539     }
6540     else
6541         sv_setsv(sv,old);
6542     return sv;
6543 }
6544
6545 /*
6546 =for apidoc sv_reset
6547
6548 Underlying implementation for the C<reset> Perl function.
6549 Note that the perl-level function is vaguely deprecated.
6550
6551 =cut
6552 */
6553
6554 void
6555 Perl_sv_reset(pTHX_ register char *s, HV *stash)
6556 {
6557     register HE *entry;
6558     register GV *gv;
6559     register SV *sv;
6560     register I32 i;
6561     register PMOP *pm;
6562     register I32 max;
6563     char todo[PERL_UCHAR_MAX+1];
6564
6565     if (!stash)
6566         return;
6567
6568     if (!*s) {          /* reset ?? searches */
6569         for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
6570             pm->op_pmdynflags &= ~PMdf_USED;
6571         }
6572         return;
6573     }
6574
6575     /* reset variables */
6576
6577     if (!HvARRAY(stash))
6578         return;
6579
6580     Zero(todo, 256, char);
6581     while (*s) {
6582         i = (unsigned char)*s;
6583         if (s[1] == '-') {
6584             s += 2;
6585         }
6586         max = (unsigned char)*s++;
6587         for ( ; i <= max; i++) {
6588             todo[i] = 1;
6589         }
6590         for (i = 0; i <= (I32) HvMAX(stash); i++) {
6591             for (entry = HvARRAY(stash)[i];
6592                  entry;
6593                  entry = HeNEXT(entry))
6594             {
6595                 if (!todo[(U8)*HeKEY(entry)])
6596                     continue;
6597                 gv = (GV*)HeVAL(entry);
6598                 sv = GvSV(gv);
6599                 if (SvTHINKFIRST(sv)) {
6600                     if (!SvREADONLY(sv) && SvROK(sv))
6601                         sv_unref(sv);
6602                     continue;
6603                 }
6604                 (void)SvOK_off(sv);
6605                 if (SvTYPE(sv) >= SVt_PV) {
6606                     SvCUR_set(sv, 0);
6607                     if (SvPVX(sv) != Nullch)
6608                         *SvPVX(sv) = '\0';
6609                     SvTAINT(sv);
6610                 }
6611                 if (GvAV(gv)) {
6612                     av_clear(GvAV(gv));
6613                 }
6614                 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
6615                     hv_clear(GvHV(gv));
6616 #ifdef USE_ENVIRON_ARRAY
6617                     if (gv == PL_envgv
6618 #  ifdef USE_ITHREADS
6619                         && PL_curinterp == aTHX
6620 #  endif
6621                     )
6622                     {
6623                         environ[0] = Nullch;
6624                     }
6625 #endif
6626                 }
6627             }
6628         }
6629     }
6630 }
6631
6632 /*
6633 =for apidoc sv_2io
6634
6635 Using various gambits, try to get an IO from an SV: the IO slot if its a
6636 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6637 named after the PV if we're a string.
6638
6639 =cut
6640 */
6641
6642 IO*
6643 Perl_sv_2io(pTHX_ SV *sv)
6644 {
6645     IO* io;
6646     GV* gv;
6647     STRLEN n_a;
6648
6649     switch (SvTYPE(sv)) {
6650     case SVt_PVIO:
6651         io = (IO*)sv;
6652         break;
6653     case SVt_PVGV:
6654         gv = (GV*)sv;
6655         io = GvIO(gv);
6656         if (!io)
6657             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6658         break;
6659     default:
6660         if (!SvOK(sv))
6661             Perl_croak(aTHX_ PL_no_usym, "filehandle");
6662         if (SvROK(sv))
6663             return sv_2io(SvRV(sv));
6664         gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
6665         if (gv)
6666             io = GvIO(gv);
6667         else
6668             io = 0;
6669         if (!io)
6670             Perl_croak(aTHX_ "Bad filehandle: %s", SvPV(sv,n_a));
6671         break;
6672     }
6673     return io;
6674 }
6675
6676 /*
6677 =for apidoc sv_2cv
6678
6679 Using various gambits, try to get a CV from an SV; in addition, try if
6680 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6681
6682 =cut
6683 */
6684
6685 CV *
6686 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6687 {
6688     GV *gv = Nullgv;
6689     CV *cv = Nullcv;
6690     STRLEN n_a;
6691
6692     if (!sv)
6693         return *gvp = Nullgv, Nullcv;
6694     switch (SvTYPE(sv)) {
6695     case SVt_PVCV:
6696         *st = CvSTASH(sv);
6697         *gvp = Nullgv;
6698         return (CV*)sv;
6699     case SVt_PVHV:
6700     case SVt_PVAV:
6701         *gvp = Nullgv;
6702         return Nullcv;
6703     case SVt_PVGV:
6704         gv = (GV*)sv;
6705         *gvp = gv;
6706         *st = GvESTASH(gv);
6707         goto fix_gv;
6708
6709     default:
6710         if (SvGMAGICAL(sv))
6711             mg_get(sv);
6712         if (SvROK(sv)) {
6713             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
6714             tryAMAGICunDEREF(to_cv);
6715
6716             sv = SvRV(sv);
6717             if (SvTYPE(sv) == SVt_PVCV) {
6718                 cv = (CV*)sv;
6719                 *gvp = Nullgv;
6720                 *st = CvSTASH(cv);
6721                 return cv;
6722             }
6723             else if(isGV(sv))
6724                 gv = (GV*)sv;
6725             else
6726                 Perl_croak(aTHX_ "Not a subroutine reference");
6727         }
6728         else if (isGV(sv))
6729             gv = (GV*)sv;
6730         else
6731             gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
6732         *gvp = gv;
6733         if (!gv)
6734             return Nullcv;
6735         *st = GvESTASH(gv);
6736     fix_gv:
6737         if (lref && !GvCVu(gv)) {
6738             SV *tmpsv;
6739             ENTER;
6740             tmpsv = NEWSV(704,0);
6741             gv_efullname3(tmpsv, gv, Nullch);
6742             /* XXX this is probably not what they think they're getting.
6743              * It has the same effect as "sub name;", i.e. just a forward
6744              * declaration! */
6745             newSUB(start_subparse(FALSE, 0),
6746                    newSVOP(OP_CONST, 0, tmpsv),
6747                    Nullop,
6748                    Nullop);
6749             LEAVE;
6750             if (!GvCVu(gv))
6751                 Perl_croak(aTHX_ "Unable to create sub named \"%s\"", SvPV(sv,n_a));
6752         }
6753         return GvCVu(gv);
6754     }
6755 }
6756
6757 /*
6758 =for apidoc sv_true
6759
6760 Returns true if the SV has a true value by Perl's rules.
6761 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6762 instead use an in-line version.
6763
6764 =cut
6765 */
6766
6767 I32
6768 Perl_sv_true(pTHX_ register SV *sv)
6769 {
6770     if (!sv)
6771         return 0;
6772     if (SvPOK(sv)) {
6773         register XPV* tXpv;
6774         if ((tXpv = (XPV*)SvANY(sv)) &&
6775                 (tXpv->xpv_cur > 1 ||
6776                 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
6777             return 1;
6778         else
6779             return 0;
6780     }
6781     else {
6782         if (SvIOK(sv))
6783             return SvIVX(sv) != 0;
6784         else {
6785             if (SvNOK(sv))
6786                 return SvNVX(sv) != 0.0;
6787             else
6788                 return sv_2bool(sv);
6789         }
6790     }
6791 }
6792
6793 /*
6794 =for apidoc sv_iv
6795
6796 A private implementation of the C<SvIVx> macro for compilers which can't
6797 cope with complex macro expressions. Always use the macro instead.
6798
6799 =cut
6800 */
6801
6802 IV
6803 Perl_sv_iv(pTHX_ register SV *sv)
6804 {
6805     if (SvIOK(sv)) {
6806         if (SvIsUV(sv))
6807             return (IV)SvUVX(sv);
6808         return SvIVX(sv);
6809     }
6810     return sv_2iv(sv);
6811 }
6812
6813 /*
6814 =for apidoc sv_uv
6815
6816 A private implementation of the C<SvUVx> macro for compilers which can't
6817 cope with complex macro expressions. Always use the macro instead.
6818
6819 =cut
6820 */
6821
6822 UV
6823 Perl_sv_uv(pTHX_ register SV *sv)
6824 {
6825     if (SvIOK(sv)) {
6826         if (SvIsUV(sv))
6827             return SvUVX(sv);
6828         return (UV)SvIVX(sv);
6829     }
6830     return sv_2uv(sv);
6831 }
6832
6833 /*
6834 =for apidoc sv_nv
6835
6836 A private implementation of the C<SvNVx> macro for compilers which can't
6837 cope with complex macro expressions. Always use the macro instead.
6838
6839 =cut
6840 */
6841
6842 NV
6843 Perl_sv_nv(pTHX_ register SV *sv)
6844 {
6845     if (SvNOK(sv))
6846         return SvNVX(sv);
6847     return sv_2nv(sv);
6848 }
6849
6850 /*
6851 =for apidoc sv_pv
6852
6853 Use the C<SvPV_nolen> macro instead
6854
6855 =for apidoc sv_pvn
6856
6857 A private implementation of the C<SvPV> macro for compilers which can't
6858 cope with complex macro expressions. Always use the macro instead.
6859
6860 =cut
6861 */
6862
6863 char *
6864 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
6865 {
6866     if (SvPOK(sv)) {
6867         *lp = SvCUR(sv);
6868         return SvPVX(sv);
6869     }
6870     return sv_2pv(sv, lp);
6871 }
6872
6873
6874 char *
6875 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
6876 {
6877     if (SvPOK(sv)) {
6878         *lp = SvCUR(sv);
6879         return SvPVX(sv);
6880     }
6881     return sv_2pv_flags(sv, lp, 0);
6882 }
6883
6884 /*
6885 =for apidoc sv_pvn_force
6886
6887 Get a sensible string out of the SV somehow.
6888 A private implementation of the C<SvPV_force> macro for compilers which
6889 can't cope with complex macro expressions. Always use the macro instead.
6890
6891 =for apidoc sv_pvn_force_flags
6892
6893 Get a sensible string out of the SV somehow.
6894 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6895 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6896 implemented in terms of this function.
6897 You normally want to use the various wrapper macros instead: see
6898 C<SvPV_force> and C<SvPV_force_nomg>
6899
6900 =cut
6901 */
6902
6903 char *
6904 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6905 {
6906     char *s = NULL;
6907
6908     if (SvTHINKFIRST(sv) && !SvROK(sv))
6909         sv_force_normal(sv);
6910
6911     if (SvPOK(sv)) {
6912         *lp = SvCUR(sv);
6913     }
6914     else {
6915         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
6916             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6917                 OP_NAME(PL_op));
6918         }
6919         else
6920             s = sv_2pv_flags(sv, lp, flags);
6921         if (s != SvPVX(sv)) {   /* Almost, but not quite, sv_setpvn() */
6922             STRLEN len = *lp;
6923         
6924             if (SvROK(sv))
6925                 sv_unref(sv);
6926             (void)SvUPGRADE(sv, SVt_PV);                /* Never FALSE */
6927             SvGROW(sv, len + 1);
6928             Move(s,SvPVX(sv),len,char);
6929             SvCUR_set(sv, len);
6930             *SvEND(sv) = '\0';
6931         }
6932         if (!SvPOK(sv)) {
6933             SvPOK_on(sv);               /* validate pointer */
6934             SvTAINT(sv);
6935             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6936                                   PTR2UV(sv),SvPVX(sv)));
6937         }
6938     }
6939     return SvPVX(sv);
6940 }
6941
6942 /*
6943 =for apidoc sv_pvbyte
6944
6945 Use C<SvPVbyte_nolen> instead.
6946
6947 =for apidoc sv_pvbyten
6948
6949 A private implementation of the C<SvPVbyte> macro for compilers
6950 which can't cope with complex macro expressions. Always use the macro
6951 instead.
6952
6953 =cut
6954 */
6955
6956 char *
6957 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
6958 {
6959     sv_utf8_downgrade(sv,0);
6960     return sv_pvn(sv,lp);
6961 }
6962
6963 /*
6964 =for apidoc sv_pvbyten_force
6965
6966 A private implementation of the C<SvPVbytex_force> macro for compilers
6967 which can't cope with complex macro expressions. Always use the macro
6968 instead.
6969
6970 =cut
6971 */
6972
6973 char *
6974 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6975 {
6976     sv_utf8_downgrade(sv,0);
6977     return sv_pvn_force(sv,lp);
6978 }
6979
6980 /*
6981 =for apidoc sv_pvutf8
6982
6983 Use the C<SvPVutf8_nolen> macro instead
6984
6985 =for apidoc sv_pvutf8n
6986
6987 A private implementation of the C<SvPVutf8> 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_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
6996 {
6997     sv_utf8_upgrade(sv);
6998     return sv_pvn(sv,lp);
6999 }
7000
7001 /*
7002 =for apidoc sv_pvutf8n_force
7003
7004 A private implementation of the C<SvPVutf8_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_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7013 {
7014     sv_utf8_upgrade(sv);
7015     return sv_pvn_force(sv,lp);
7016 }
7017
7018 /*
7019 =for apidoc sv_reftype
7020
7021 Returns a string describing what the SV is a reference to.
7022
7023 =cut
7024 */
7025
7026 char *
7027 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7028 {
7029     if (ob && SvOBJECT(sv)) {
7030         HV *svs = SvSTASH(sv);
7031         /* [20011101.072] This bandaid for C<package;> should eventually
7032            be removed. AMS 20011103 */
7033         return (svs ? HvNAME(svs) : "<none>");
7034     }
7035     else {
7036         switch (SvTYPE(sv)) {
7037         case SVt_NULL:
7038         case SVt_IV:
7039         case SVt_NV:
7040         case SVt_RV:
7041         case SVt_PV:
7042         case SVt_PVIV:
7043         case SVt_PVNV:
7044         case SVt_PVMG:
7045         case SVt_PVBM:
7046                                 if (SvROK(sv))
7047                                     return "REF";
7048                                 else
7049                                     return "SCALAR";
7050         case SVt_PVLV:          return "LVALUE";
7051         case SVt_PVAV:          return "ARRAY";
7052         case SVt_PVHV:          return "HASH";
7053         case SVt_PVCV:          return "CODE";
7054         case SVt_PVGV:          return "GLOB";
7055         case SVt_PVFM:          return "FORMAT";
7056         case SVt_PVIO:          return "IO";
7057         default:                return "UNKNOWN";
7058         }
7059     }
7060 }
7061
7062 /*
7063 =for apidoc sv_isobject
7064
7065 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7066 object.  If the SV is not an RV, or if the object is not blessed, then this
7067 will return false.
7068
7069 =cut
7070 */
7071
7072 int
7073 Perl_sv_isobject(pTHX_ SV *sv)
7074 {
7075     if (!sv)
7076         return 0;
7077     if (SvGMAGICAL(sv))
7078         mg_get(sv);
7079     if (!SvROK(sv))
7080         return 0;
7081     sv = (SV*)SvRV(sv);
7082     if (!SvOBJECT(sv))
7083         return 0;
7084     return 1;
7085 }
7086
7087 /*
7088 =for apidoc sv_isa
7089
7090 Returns a boolean indicating whether the SV is blessed into the specified
7091 class.  This does not check for subtypes; use C<sv_derived_from> to verify
7092 an inheritance relationship.
7093
7094 =cut
7095 */
7096
7097 int
7098 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7099 {
7100     if (!sv)
7101         return 0;
7102     if (SvGMAGICAL(sv))
7103         mg_get(sv);
7104     if (!SvROK(sv))
7105         return 0;
7106     sv = (SV*)SvRV(sv);
7107     if (!SvOBJECT(sv))
7108         return 0;
7109
7110     return strEQ(HvNAME(SvSTASH(sv)), name);
7111 }
7112
7113 /*
7114 =for apidoc newSVrv
7115
7116 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
7117 it will be upgraded to one.  If C<classname> is non-null then the new SV will
7118 be blessed in the specified package.  The new SV is returned and its
7119 reference count is 1.
7120
7121 =cut
7122 */
7123
7124 SV*
7125 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7126 {
7127     SV *sv;
7128
7129     new_SV(sv);
7130
7131     SV_CHECK_THINKFIRST(rv);
7132     SvAMAGIC_off(rv);
7133
7134     if (SvTYPE(rv) >= SVt_PVMG) {
7135         U32 refcnt = SvREFCNT(rv);
7136         SvREFCNT(rv) = 0;
7137         sv_clear(rv);
7138         SvFLAGS(rv) = 0;
7139         SvREFCNT(rv) = refcnt;
7140     }
7141
7142     if (SvTYPE(rv) < SVt_RV)
7143         sv_upgrade(rv, SVt_RV);
7144     else if (SvTYPE(rv) > SVt_RV) {
7145         (void)SvOOK_off(rv);
7146         if (SvPVX(rv) && SvLEN(rv))
7147             Safefree(SvPVX(rv));
7148         SvCUR_set(rv, 0);
7149         SvLEN_set(rv, 0);
7150     }
7151
7152     (void)SvOK_off(rv);
7153     SvRV(rv) = sv;
7154     SvROK_on(rv);
7155
7156     if (classname) {
7157         HV* stash = gv_stashpv(classname, TRUE);
7158         (void)sv_bless(rv, stash);
7159     }
7160     return sv;
7161 }
7162
7163 /*
7164 =for apidoc sv_setref_pv
7165
7166 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
7167 argument will be upgraded to an RV.  That RV will be modified to point to
7168 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7169 into the SV.  The C<classname> argument indicates the package for the
7170 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7171 will be returned and will have a reference count of 1.
7172
7173 Do not use with other Perl types such as HV, AV, SV, CV, because those
7174 objects will become corrupted by the pointer copy process.
7175
7176 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7177
7178 =cut
7179 */
7180
7181 SV*
7182 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7183 {
7184     if (!pv) {
7185         sv_setsv(rv, &PL_sv_undef);
7186         SvSETMAGIC(rv);
7187     }
7188     else
7189         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7190     return rv;
7191 }
7192
7193 /*
7194 =for apidoc sv_setref_iv
7195
7196 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
7197 argument will be upgraded to an RV.  That RV will be modified to point to
7198 the new SV.  The C<classname> argument indicates the package for the
7199 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7200 will be returned and will have a reference count of 1.
7201
7202 =cut
7203 */
7204
7205 SV*
7206 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7207 {
7208     sv_setiv(newSVrv(rv,classname), iv);
7209     return rv;
7210 }
7211
7212 /*
7213 =for apidoc sv_setref_uv
7214
7215 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
7216 argument will be upgraded to an RV.  That RV will be modified to point to
7217 the new SV.  The C<classname> argument indicates the package for the
7218 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7219 will be returned and will have a reference count of 1.
7220
7221 =cut
7222 */
7223
7224 SV*
7225 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7226 {
7227     sv_setuv(newSVrv(rv,classname), uv);
7228     return rv;
7229 }
7230
7231 /*
7232 =for apidoc sv_setref_nv
7233
7234 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
7235 argument will be upgraded to an RV.  That RV will be modified to point to
7236 the new SV.  The C<classname> argument indicates the package for the
7237 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7238 will be returned and will have a reference count of 1.
7239
7240 =cut
7241 */
7242
7243 SV*
7244 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7245 {
7246     sv_setnv(newSVrv(rv,classname), nv);
7247     return rv;
7248 }
7249
7250 /*
7251 =for apidoc sv_setref_pvn
7252
7253 Copies a string into a new SV, optionally blessing the SV.  The length of the
7254 string must be specified with C<n>.  The C<rv> argument will be upgraded to
7255 an RV.  That RV will be modified to point to the new SV.  The C<classname>
7256 argument indicates the package for the blessing.  Set C<classname> to
7257 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
7258 a reference count of 1.
7259
7260 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7261
7262 =cut
7263 */
7264
7265 SV*
7266 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7267 {
7268     sv_setpvn(newSVrv(rv,classname), pv, n);
7269     return rv;
7270 }
7271
7272 /*
7273 =for apidoc sv_bless
7274
7275 Blesses an SV into a specified package.  The SV must be an RV.  The package
7276 must be designated by its stash (see C<gv_stashpv()>).  The reference count
7277 of the SV is unaffected.
7278
7279 =cut
7280 */
7281
7282 SV*
7283 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7284 {
7285     SV *tmpRef;
7286     if (!SvROK(sv))
7287         Perl_croak(aTHX_ "Can't bless non-reference value");
7288     tmpRef = SvRV(sv);
7289     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7290         if (SvREADONLY(tmpRef))
7291             Perl_croak(aTHX_ PL_no_modify);
7292         if (SvOBJECT(tmpRef)) {
7293             if (SvTYPE(tmpRef) != SVt_PVIO)
7294                 --PL_sv_objcount;
7295             SvREFCNT_dec(SvSTASH(tmpRef));
7296         }
7297     }
7298     SvOBJECT_on(tmpRef);
7299     if (SvTYPE(tmpRef) != SVt_PVIO)
7300         ++PL_sv_objcount;
7301     (void)SvUPGRADE(tmpRef, SVt_PVMG);
7302     SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7303
7304     if (Gv_AMG(stash))
7305         SvAMAGIC_on(sv);
7306     else
7307         SvAMAGIC_off(sv);
7308
7309     if(SvSMAGICAL(tmpRef))
7310         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7311             mg_set(tmpRef);
7312
7313
7314
7315     return sv;
7316 }
7317
7318 /* Downgrades a PVGV to a PVMG.
7319  */
7320
7321 STATIC void
7322 S_sv_unglob(pTHX_ SV *sv)
7323 {
7324     void *xpvmg;
7325
7326     assert(SvTYPE(sv) == SVt_PVGV);
7327     SvFAKE_off(sv);
7328     if (GvGP(sv))
7329         gp_free((GV*)sv);
7330     if (GvSTASH(sv)) {
7331         SvREFCNT_dec(GvSTASH(sv));
7332         GvSTASH(sv) = Nullhv;
7333     }
7334     sv_unmagic(sv, PERL_MAGIC_glob);
7335     Safefree(GvNAME(sv));
7336     GvMULTI_off(sv);
7337
7338     /* need to keep SvANY(sv) in the right arena */
7339     xpvmg = new_XPVMG();
7340     StructCopy(SvANY(sv), xpvmg, XPVMG);
7341     del_XPVGV(SvANY(sv));
7342     SvANY(sv) = xpvmg;
7343
7344     SvFLAGS(sv) &= ~SVTYPEMASK;
7345     SvFLAGS(sv) |= SVt_PVMG;
7346 }
7347
7348 /*
7349 =for apidoc sv_unref_flags
7350
7351 Unsets the RV status of the SV, and decrements the reference count of
7352 whatever was being referenced by the RV.  This can almost be thought of
7353 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
7354 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7355 (otherwise the decrementing is conditional on the reference count being
7356 different from one or the reference being a readonly SV).
7357 See C<SvROK_off>.
7358
7359 =cut
7360 */
7361
7362 void
7363 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7364 {
7365     SV* rv = SvRV(sv);
7366
7367     if (SvWEAKREF(sv)) {
7368         sv_del_backref(sv);
7369         SvWEAKREF_off(sv);
7370         SvRV(sv) = 0;
7371         return;
7372     }
7373     SvRV(sv) = 0;
7374     SvROK_off(sv);
7375     if (SvREFCNT(rv) != 1 || SvREADONLY(rv) || flags) /* SV_IMMEDIATE_UNREF */
7376         SvREFCNT_dec(rv);
7377     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7378         sv_2mortal(rv);         /* Schedule for freeing later */
7379 }
7380
7381 /*
7382 =for apidoc sv_unref
7383
7384 Unsets the RV status of the SV, and decrements the reference count of
7385 whatever was being referenced by the RV.  This can almost be thought of
7386 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
7387 being zero.  See C<SvROK_off>.
7388
7389 =cut
7390 */
7391
7392 void
7393 Perl_sv_unref(pTHX_ SV *sv)
7394 {
7395     sv_unref_flags(sv, 0);
7396 }
7397
7398 /*
7399 =for apidoc sv_taint
7400
7401 Taint an SV. Use C<SvTAINTED_on> instead.
7402 =cut
7403 */
7404
7405 void
7406 Perl_sv_taint(pTHX_ SV *sv)
7407 {
7408     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7409 }
7410
7411 /*
7412 =for apidoc sv_untaint
7413
7414 Untaint an SV. Use C<SvTAINTED_off> instead.
7415 =cut
7416 */
7417
7418 void
7419 Perl_sv_untaint(pTHX_ SV *sv)
7420 {
7421     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7422         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7423         if (mg)
7424             mg->mg_len &= ~1;
7425     }
7426 }
7427
7428 /*
7429 =for apidoc sv_tainted
7430
7431 Test an SV for taintedness. Use C<SvTAINTED> instead.
7432 =cut
7433 */
7434
7435 bool
7436 Perl_sv_tainted(pTHX_ SV *sv)
7437 {
7438     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7439         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7440         if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7441             return TRUE;
7442     }
7443     return FALSE;
7444 }
7445
7446 #if defined(PERL_IMPLICIT_CONTEXT)
7447
7448 /* pTHX_ magic can't cope with varargs, so this is a no-context
7449  * version of the main function, (which may itself be aliased to us).
7450  * Don't access this version directly.
7451  */
7452
7453 void
7454 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7455 {
7456     dTHX;
7457     va_list args;
7458     va_start(args, pat);
7459     sv_vsetpvf(sv, pat, &args);
7460     va_end(args);
7461 }
7462
7463 /* pTHX_ magic can't cope with varargs, so this is a no-context
7464  * version of the main function, (which may itself be aliased to us).
7465  * Don't access this version directly.
7466  */
7467
7468 void
7469 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7470 {
7471     dTHX;
7472     va_list args;
7473     va_start(args, pat);
7474     sv_vsetpvf_mg(sv, pat, &args);
7475     va_end(args);
7476 }
7477 #endif
7478
7479 /*
7480 =for apidoc sv_setpvf
7481
7482 Processes its arguments like C<sprintf> and sets an SV to the formatted
7483 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
7484
7485 =cut
7486 */
7487
7488 void
7489 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7490 {
7491     va_list args;
7492     va_start(args, pat);
7493     sv_vsetpvf(sv, pat, &args);
7494     va_end(args);
7495 }
7496
7497 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
7498
7499 void
7500 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7501 {
7502     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7503 }
7504
7505 /*
7506 =for apidoc sv_setpvf_mg
7507
7508 Like C<sv_setpvf>, but also handles 'set' magic.
7509
7510 =cut
7511 */
7512
7513 void
7514 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7515 {
7516     va_list args;
7517     va_start(args, pat);
7518     sv_vsetpvf_mg(sv, pat, &args);
7519     va_end(args);
7520 }
7521
7522 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
7523
7524 void
7525 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7526 {
7527     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7528     SvSETMAGIC(sv);
7529 }
7530
7531 #if defined(PERL_IMPLICIT_CONTEXT)
7532
7533 /* pTHX_ magic can't cope with varargs, so this is a no-context
7534  * version of the main function, (which may itself be aliased to us).
7535  * Don't access this version directly.
7536  */
7537
7538 void
7539 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7540 {
7541     dTHX;
7542     va_list args;
7543     va_start(args, pat);
7544     sv_vcatpvf(sv, pat, &args);
7545     va_end(args);
7546 }
7547
7548 /* pTHX_ magic can't cope with varargs, so this is a no-context
7549  * version of the main function, (which may itself be aliased to us).
7550  * Don't access this version directly.
7551  */
7552
7553 void
7554 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7555 {
7556     dTHX;
7557     va_list args;
7558     va_start(args, pat);
7559     sv_vcatpvf_mg(sv, pat, &args);
7560     va_end(args);
7561 }
7562 #endif
7563
7564 /*
7565 =for apidoc sv_catpvf
7566
7567 Processes its arguments like C<sprintf> and appends the formatted
7568 output to an SV.  If the appended data contains "wide" characters
7569 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7570 and characters >255 formatted with %c), the original SV might get
7571 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
7572 C<SvSETMAGIC()> must typically be called after calling this function
7573 to handle 'set' magic.
7574
7575 =cut */
7576
7577 void
7578 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7579 {
7580     va_list args;
7581     va_start(args, pat);
7582     sv_vcatpvf(sv, pat, &args);
7583     va_end(args);
7584 }
7585
7586 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
7587
7588 void
7589 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7590 {
7591     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7592 }
7593
7594 /*
7595 =for apidoc sv_catpvf_mg
7596
7597 Like C<sv_catpvf>, but also handles 'set' magic.
7598
7599 =cut
7600 */
7601
7602 void
7603 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7604 {
7605     va_list args;
7606     va_start(args, pat);
7607     sv_vcatpvf_mg(sv, pat, &args);
7608     va_end(args);
7609 }
7610
7611 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
7612
7613 void
7614 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7615 {
7616     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7617     SvSETMAGIC(sv);
7618 }
7619
7620 /*
7621 =for apidoc sv_vsetpvfn
7622
7623 Works like C<vcatpvfn> but copies the text into the SV instead of
7624 appending it.
7625
7626 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
7627
7628 =cut
7629 */
7630
7631 void
7632 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7633 {
7634     sv_setpvn(sv, "", 0);
7635     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7636 }
7637
7638 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7639
7640 STATIC I32
7641 S_expect_number(pTHX_ char** pattern)
7642 {
7643     I32 var = 0;
7644     switch (**pattern) {
7645     case '1': case '2': case '3':
7646     case '4': case '5': case '6':
7647     case '7': case '8': case '9':
7648         while (isDIGIT(**pattern))
7649             var = var * 10 + (*(*pattern)++ - '0');
7650     }
7651     return var;
7652 }
7653 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7654
7655 /*
7656 =for apidoc sv_vcatpvfn
7657
7658 Processes its arguments like C<vsprintf> and appends the formatted output
7659 to an SV.  Uses an array of SVs if the C style variable argument list is
7660 missing (NULL).  When running with taint checks enabled, indicates via
7661 C<maybe_tainted> if results are untrustworthy (often due to the use of
7662 locales).
7663
7664 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
7665
7666 =cut
7667 */
7668
7669 void
7670 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7671 {
7672     char *p;
7673     char *q;
7674     char *patend;
7675     STRLEN origlen;
7676     I32 svix = 0;
7677     static char nullstr[] = "(null)";
7678     SV *argsv = Nullsv;
7679     bool has_utf8 = FALSE; /* has the result utf8? */
7680
7681     /* no matter what, this is a string now */
7682     (void)SvPV_force(sv, origlen);
7683
7684     /* special-case "", "%s", and "%_" */
7685     if (patlen == 0)
7686         return;
7687     if (patlen == 2 && pat[0] == '%') {
7688         switch (pat[1]) {
7689         case 's':
7690             if (args) {
7691                 char *s = va_arg(*args, char*);
7692                 sv_catpv(sv, s ? s : nullstr);
7693             }
7694             else if (svix < svmax) {
7695                 sv_catsv(sv, *svargs);
7696                 if (DO_UTF8(*svargs))
7697                     SvUTF8_on(sv);
7698             }
7699             return;
7700         case '_':
7701             if (args) {
7702                 argsv = va_arg(*args, SV*);
7703                 sv_catsv(sv, argsv);
7704                 if (DO_UTF8(argsv))
7705                     SvUTF8_on(sv);
7706                 return;
7707             }
7708             /* See comment on '_' below */
7709             break;
7710         }
7711     }
7712
7713     if (!args && svix < svmax && DO_UTF8(*svargs))
7714         has_utf8 = TRUE;
7715
7716     patend = (char*)pat + patlen;
7717     for (p = (char*)pat; p < patend; p = q) {
7718         bool alt = FALSE;
7719         bool left = FALSE;
7720         bool vectorize = FALSE;
7721         bool vectorarg = FALSE;
7722         bool vec_utf8 = FALSE;
7723         char fill = ' ';
7724         char plus = 0;
7725         char intsize = 0;
7726         STRLEN width = 0;
7727         STRLEN zeros = 0;
7728         bool has_precis = FALSE;
7729         STRLEN precis = 0;
7730         bool is_utf8 = FALSE;  /* is this item utf8?   */
7731         
7732         char esignbuf[4];
7733         U8 utf8buf[UTF8_MAXLEN+1];
7734         STRLEN esignlen = 0;
7735
7736         char *eptr = Nullch;
7737         STRLEN elen = 0;
7738         /* Times 4: a decimal digit takes more than 3 binary digits.
7739          * NV_DIG: mantissa takes than many decimal digits.
7740          * Plus 32: Playing safe. */
7741         char ebuf[IV_DIG * 4 + NV_DIG + 32];
7742         /* large enough for "%#.#f" --chip */
7743         /* what about long double NVs? --jhi */
7744
7745         SV *vecsv;
7746         U8 *vecstr = Null(U8*);
7747         STRLEN veclen = 0;
7748         char c = 0;
7749         int i;
7750         unsigned base = 0;
7751         IV iv = 0;
7752         UV uv = 0;
7753         NV nv;
7754         STRLEN have;
7755         STRLEN need;
7756         STRLEN gap;
7757         char *dotstr = ".";
7758         STRLEN dotstrlen = 1;
7759         I32 efix = 0; /* explicit format parameter index */
7760         I32 ewix = 0; /* explicit width index */
7761         I32 epix = 0; /* explicit precision index */
7762         I32 evix = 0; /* explicit vector index */
7763         bool asterisk = FALSE;
7764
7765         /* echo everything up to the next format specification */
7766         for (q = p; q < patend && *q != '%'; ++q) ;
7767         if (q > p) {
7768             sv_catpvn(sv, p, q - p);
7769             p = q;
7770         }
7771         if (q++ >= patend)
7772             break;
7773
7774 /*
7775     We allow format specification elements in this order:
7776         \d+\$              explicit format parameter index
7777         [-+ 0#]+           flags
7778         \*?(\d+\$)?v       vector with optional (optionally specified) arg
7779         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
7780         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7781         [hlqLV]            size
7782     [%bcdefginopsux_DFOUX] format (mandatory)
7783 */
7784         if (EXPECT_NUMBER(q, width)) {
7785             if (*q == '$') {
7786                 ++q;
7787                 efix = width;
7788             } else {
7789                 goto gotwidth;
7790             }
7791         }
7792
7793         /* FLAGS */
7794
7795         while (*q) {
7796             switch (*q) {
7797             case ' ':
7798             case '+':
7799                 plus = *q++;
7800                 continue;
7801
7802             case '-':
7803                 left = TRUE;
7804                 q++;
7805                 continue;
7806
7807             case '0':
7808                 fill = *q++;
7809                 continue;
7810
7811             case '#':
7812                 alt = TRUE;
7813                 q++;
7814                 continue;
7815
7816             default:
7817                 break;
7818             }
7819             break;
7820         }
7821
7822       tryasterisk:
7823         if (*q == '*') {
7824             q++;
7825             if (EXPECT_NUMBER(q, ewix))
7826                 if (*q++ != '$')
7827                     goto unknown;
7828             asterisk = TRUE;
7829         }
7830         if (*q == 'v') {
7831             q++;
7832             if (vectorize)
7833                 goto unknown;
7834             if ((vectorarg = asterisk)) {
7835                 evix = ewix;
7836                 ewix = 0;
7837                 asterisk = FALSE;
7838             }
7839             vectorize = TRUE;
7840             goto tryasterisk;
7841         }
7842
7843         if (!asterisk)
7844             EXPECT_NUMBER(q, width);
7845
7846         if (vectorize) {
7847             if (vectorarg) {
7848                 if (args)
7849                     vecsv = va_arg(*args, SV*);
7850                 else
7851                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
7852                         svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
7853                 dotstr = SvPVx(vecsv, dotstrlen);
7854                 if (DO_UTF8(vecsv))
7855                     is_utf8 = TRUE;
7856             }
7857             if (args) {
7858                 vecsv = va_arg(*args, SV*);
7859                 vecstr = (U8*)SvPVx(vecsv,veclen);
7860                 vec_utf8 = DO_UTF8(vecsv);
7861             }
7862             else if (efix ? efix <= svmax : svix < svmax) {
7863                 vecsv = svargs[efix ? efix-1 : svix++];
7864                 vecstr = (U8*)SvPVx(vecsv,veclen);
7865                 vec_utf8 = DO_UTF8(vecsv);
7866             }
7867             else {
7868                 vecstr = (U8*)"";
7869                 veclen = 0;
7870             }
7871         }
7872
7873         if (asterisk) {
7874             if (args)
7875                 i = va_arg(*args, int);
7876             else
7877                 i = (ewix ? ewix <= svmax : svix < svmax) ?
7878                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7879             left |= (i < 0);
7880             width = (i < 0) ? -i : i;
7881         }
7882       gotwidth:
7883
7884         /* PRECISION */
7885
7886         if (*q == '.') {
7887             q++;
7888             if (*q == '*') {
7889                 q++;
7890                 if (EXPECT_NUMBER(q, epix) && *q++ != '$') /* epix currently unused */
7891                     goto unknown;
7892                 if (args)
7893                     i = va_arg(*args, int);
7894                 else
7895                     i = (ewix ? ewix <= svmax : svix < svmax)
7896                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7897                 precis = (i < 0) ? 0 : i;
7898             }
7899             else {
7900                 precis = 0;
7901                 while (isDIGIT(*q))
7902                     precis = precis * 10 + (*q++ - '0');
7903             }
7904             has_precis = TRUE;
7905         }
7906
7907         /* SIZE */
7908
7909         switch (*q) {
7910 #ifdef WIN32
7911         case 'I':                       /* Ix, I32x, and I64x */
7912 #  ifdef WIN64
7913             if (q[1] == '6' && q[2] == '4') {
7914                 q += 3;
7915                 intsize = 'q';
7916                 break;
7917             }
7918 #  endif
7919             if (q[1] == '3' && q[2] == '2') {
7920                 q += 3;
7921                 break;
7922             }
7923 #  ifdef WIN64
7924             intsize = 'q';
7925 #  endif
7926             q++;
7927             break;
7928 #endif
7929 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7930         case 'L':                       /* Ld */
7931             /* FALL THROUGH */
7932 #endif
7933 #ifdef HAS_QUAD
7934         case 'q':                       /* qd */
7935             intsize = 'q';
7936             q++;
7937             break;
7938 #endif
7939         case 'l':
7940 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7941              if (*(q + 1) == 'l') {     /* lld, llf */
7942                 intsize = 'q';
7943                 q += 2;
7944                 break;
7945              }
7946 #endif
7947             /* FALL THROUGH */
7948         case 'h':
7949             /* FALL THROUGH */
7950         case 'V':
7951             intsize = *q++;
7952             break;
7953         }
7954
7955         /* CONVERSION */
7956
7957         if (*q == '%') {
7958             eptr = q++;
7959             elen = 1;
7960             goto string;
7961         }
7962
7963         if (!args)
7964             argsv = (efix ? efix <= svmax : svix < svmax) ?
7965                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
7966
7967         switch (c = *q++) {
7968
7969             /* STRINGS */
7970
7971         case 'c':
7972             uv = args ? va_arg(*args, int) : SvIVx(argsv);
7973             if ((uv > 255 ||
7974                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
7975                 && !IN_BYTES) {
7976                 eptr = (char*)utf8buf;
7977                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
7978                 is_utf8 = TRUE;
7979             }
7980             else {
7981                 c = (char)uv;
7982                 eptr = &c;
7983                 elen = 1;
7984             }
7985             goto string;
7986
7987         case 's':
7988             if (args) {
7989                 eptr = va_arg(*args, char*);
7990                 if (eptr)
7991 #ifdef MACOS_TRADITIONAL
7992                   /* On MacOS, %#s format is used for Pascal strings */
7993                   if (alt)
7994                     elen = *eptr++;
7995                   else
7996 #endif
7997                     elen = strlen(eptr);
7998                 else {
7999                     eptr = nullstr;
8000                     elen = sizeof nullstr - 1;
8001                 }
8002             }
8003             else {
8004                 eptr = SvPVx(argsv, elen);
8005                 if (DO_UTF8(argsv)) {
8006                     if (has_precis && precis < elen) {
8007                         I32 p = precis;
8008                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8009                         precis = p;
8010                     }
8011                     if (width) { /* fudge width (can't fudge elen) */
8012                         width += elen - sv_len_utf8(argsv);
8013                     }
8014                     is_utf8 = TRUE;
8015                 }
8016             }
8017             goto string;
8018
8019         case '_':
8020             /*
8021              * The "%_" hack might have to be changed someday,
8022              * if ISO or ANSI decide to use '_' for something.
8023              * So we keep it hidden from users' code.
8024              */
8025             if (!args)
8026                 goto unknown;
8027             argsv = va_arg(*args, SV*);
8028             eptr = SvPVx(argsv, elen);
8029             if (DO_UTF8(argsv))
8030                 is_utf8 = TRUE;
8031
8032         string:
8033             vectorize = FALSE;
8034             if (has_precis && elen > precis)
8035                 elen = precis;
8036             break;
8037
8038             /* INTEGERS */
8039
8040         case 'p':
8041             if (alt)
8042                 goto unknown;
8043             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8044             base = 16;
8045             goto integer;
8046
8047         case 'D':
8048 #ifdef IV_IS_QUAD
8049             intsize = 'q';
8050 #else
8051             intsize = 'l';
8052 #endif
8053             /* FALL THROUGH */
8054         case 'd':
8055         case 'i':
8056             if (vectorize) {
8057                 STRLEN ulen;
8058                 if (!veclen)
8059                     continue;
8060                 if (vec_utf8)
8061                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8062                                         UTF8_ALLOW_ANYUV);
8063                 else {
8064                     uv = *vecstr;
8065                     ulen = 1;
8066                 }
8067                 vecstr += ulen;
8068                 veclen -= ulen;
8069                 if (plus)
8070                      esignbuf[esignlen++] = plus;
8071             }
8072             else if (args) {
8073                 switch (intsize) {
8074                 case 'h':       iv = (short)va_arg(*args, int); break;
8075                 default:        iv = va_arg(*args, int); break;
8076                 case 'l':       iv = va_arg(*args, long); break;
8077                 case 'V':       iv = va_arg(*args, IV); break;
8078 #ifdef HAS_QUAD
8079                 case 'q':       iv = va_arg(*args, Quad_t); break;
8080 #endif
8081                 }
8082             }
8083             else {
8084                 iv = SvIVx(argsv);
8085                 switch (intsize) {
8086                 case 'h':       iv = (short)iv; break;
8087                 default:        break;
8088                 case 'l':       iv = (long)iv; break;
8089                 case 'V':       break;
8090 #ifdef HAS_QUAD
8091                 case 'q':       iv = (Quad_t)iv; break;
8092 #endif
8093                 }
8094             }
8095             if ( !vectorize )   /* we already set uv above */
8096             {
8097                 if (iv >= 0) {
8098                     uv = iv;
8099                     if (plus)
8100                         esignbuf[esignlen++] = plus;
8101                 }
8102                 else {
8103                     uv = -iv;
8104                     esignbuf[esignlen++] = '-';
8105                 }
8106             }
8107             base = 10;
8108             goto integer;
8109
8110         case 'U':
8111 #ifdef IV_IS_QUAD
8112             intsize = 'q';
8113 #else
8114             intsize = 'l';
8115 #endif
8116             /* FALL THROUGH */
8117         case 'u':
8118             base = 10;
8119             goto uns_integer;
8120
8121         case 'b':
8122             base = 2;
8123             goto uns_integer;
8124
8125         case 'O':
8126 #ifdef IV_IS_QUAD
8127             intsize = 'q';
8128 #else
8129             intsize = 'l';
8130 #endif
8131             /* FALL THROUGH */
8132         case 'o':
8133             base = 8;
8134             goto uns_integer;
8135
8136         case 'X':
8137         case 'x':
8138             base = 16;
8139
8140         uns_integer:
8141             if (vectorize) {
8142                 STRLEN ulen;
8143         vector:
8144                 if (!veclen)
8145                     continue;
8146                 if (vec_utf8)
8147                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8148                                         UTF8_ALLOW_ANYUV);
8149                 else {
8150                     uv = *vecstr;
8151                     ulen = 1;
8152                 }
8153                 vecstr += ulen;
8154                 veclen -= ulen;
8155             }
8156             else if (args) {
8157                 switch (intsize) {
8158                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
8159                 default:   uv = va_arg(*args, unsigned); break;
8160                 case 'l':  uv = va_arg(*args, unsigned long); break;
8161                 case 'V':  uv = va_arg(*args, UV); break;
8162 #ifdef HAS_QUAD
8163                 case 'q':  uv = va_arg(*args, Quad_t); break;
8164 #endif
8165                 }
8166             }
8167             else {
8168                 uv = SvUVx(argsv);
8169                 switch (intsize) {
8170                 case 'h':       uv = (unsigned short)uv; break;
8171                 default:        break;
8172                 case 'l':       uv = (unsigned long)uv; break;
8173                 case 'V':       break;
8174 #ifdef HAS_QUAD
8175                 case 'q':       uv = (Quad_t)uv; break;
8176 #endif
8177                 }
8178             }
8179
8180         integer:
8181             eptr = ebuf + sizeof ebuf;
8182             switch (base) {
8183                 unsigned dig;
8184             case 16:
8185                 if (!uv)
8186                     alt = FALSE;
8187                 p = (char*)((c == 'X')
8188                             ? "0123456789ABCDEF" : "0123456789abcdef");
8189                 do {
8190                     dig = uv & 15;
8191                     *--eptr = p[dig];
8192                 } while (uv >>= 4);
8193                 if (alt) {
8194                     esignbuf[esignlen++] = '0';
8195                     esignbuf[esignlen++] = c;  /* 'x' or 'X' */
8196                 }
8197                 break;
8198             case 8:
8199                 do {
8200                     dig = uv & 7;
8201                     *--eptr = '0' + dig;
8202                 } while (uv >>= 3);
8203                 if (alt && *eptr != '0')
8204                     *--eptr = '0';
8205                 break;
8206             case 2:
8207                 do {
8208                     dig = uv & 1;
8209                     *--eptr = '0' + dig;
8210                 } while (uv >>= 1);
8211                 if (alt) {
8212                     esignbuf[esignlen++] = '0';
8213                     esignbuf[esignlen++] = 'b';
8214                 }
8215                 break;
8216             default:            /* it had better be ten or less */
8217 #if defined(PERL_Y2KWARN)
8218                 if (ckWARN(WARN_Y2K)) {
8219                     STRLEN n;
8220                     char *s = SvPV(sv,n);
8221                     if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8222                         && (n == 2 || !isDIGIT(s[n-3])))
8223                     {
8224                         Perl_warner(aTHX_ packWARN(WARN_Y2K),
8225                                     "Possible Y2K bug: %%%c %s",
8226                                     c, "format string following '19'");
8227                     }
8228                 }
8229 #endif
8230                 do {
8231                     dig = uv % base;
8232                     *--eptr = '0' + dig;
8233                 } while (uv /= base);
8234                 break;
8235             }
8236             elen = (ebuf + sizeof ebuf) - eptr;
8237             if (has_precis) {
8238                 if (precis > elen)
8239                     zeros = precis - elen;
8240                 else if (precis == 0 && elen == 1 && *eptr == '0')
8241                     elen = 0;
8242             }
8243             break;
8244
8245             /* FLOATING POINT */
8246
8247         case 'F':
8248             c = 'f';            /* maybe %F isn't supported here */
8249             /* FALL THROUGH */
8250         case 'e': case 'E':
8251         case 'f':
8252         case 'g': case 'G':
8253
8254             /* This is evil, but floating point is even more evil */
8255
8256             vectorize = FALSE;
8257             nv = args ? va_arg(*args, NV) : SvNVx(argsv);
8258
8259             need = 0;
8260             if (c != 'e' && c != 'E') {
8261                 i = PERL_INT_MIN;
8262                 (void)Perl_frexp(nv, &i);
8263                 if (i == PERL_INT_MIN)
8264                     Perl_die(aTHX_ "panic: frexp");
8265                 if (i > 0)
8266                     need = BIT_DIGITS(i);
8267             }
8268             need += has_precis ? precis : 6; /* known default */
8269             if (need < width)
8270                 need = width;
8271
8272             need += 20; /* fudge factor */
8273             if (PL_efloatsize < need) {
8274                 Safefree(PL_efloatbuf);
8275                 PL_efloatsize = need + 20; /* more fudge */
8276                 New(906, PL_efloatbuf, PL_efloatsize, char);
8277                 PL_efloatbuf[0] = '\0';
8278             }
8279
8280             eptr = ebuf + sizeof ebuf;
8281             *--eptr = '\0';
8282             *--eptr = c;
8283 #if defined(USE_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8284             {
8285                 /* Copy the one or more characters in a long double
8286                  * format before the 'base' ([efgEFG]) character to
8287                  * the format string. */
8288                 static char const prifldbl[] = PERL_PRIfldbl;
8289                 char const *p = prifldbl + sizeof(prifldbl) - 3;
8290                 while (p >= prifldbl) { *--eptr = *p--; }
8291             }
8292 #endif
8293             if (has_precis) {
8294                 base = precis;
8295                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8296                 *--eptr = '.';
8297             }
8298             if (width) {
8299                 base = width;
8300                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8301             }
8302             if (fill == '0')
8303                 *--eptr = fill;
8304             if (left)
8305                 *--eptr = '-';
8306             if (plus)
8307                 *--eptr = plus;
8308             if (alt)
8309                 *--eptr = '#';
8310             *--eptr = '%';
8311
8312             /* No taint.  Otherwise we are in the strange situation
8313              * where printf() taints but print($float) doesn't.
8314              * --jhi */
8315             (void)sprintf(PL_efloatbuf, eptr, nv);
8316
8317             eptr = PL_efloatbuf;
8318             elen = strlen(PL_efloatbuf);
8319             break;
8320
8321             /* SPECIAL */
8322
8323         case 'n':
8324             vectorize = FALSE;
8325             i = SvCUR(sv) - origlen;
8326             if (args) {
8327                 switch (intsize) {
8328                 case 'h':       *(va_arg(*args, short*)) = i; break;
8329                 default:        *(va_arg(*args, int*)) = i; break;
8330                 case 'l':       *(va_arg(*args, long*)) = i; break;
8331                 case 'V':       *(va_arg(*args, IV*)) = i; break;
8332 #ifdef HAS_QUAD
8333                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
8334 #endif
8335                 }
8336             }
8337             else
8338                 sv_setuv_mg(argsv, (UV)i);
8339             continue;   /* not "break" */
8340
8341             /* UNKNOWN */
8342
8343         default:
8344       unknown:
8345             vectorize = FALSE;
8346             if (!args && ckWARN(WARN_PRINTF) &&
8347                   (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8348                 SV *msg = sv_newmortal();
8349                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %s: ",
8350                           (PL_op->op_type == OP_PRTF) ? "printf" : "sprintf");
8351                 if (c) {
8352                     if (isPRINT(c))
8353                         Perl_sv_catpvf(aTHX_ msg,
8354                                        "\"%%%c\"", c & 0xFF);
8355                     else
8356                         Perl_sv_catpvf(aTHX_ msg,
8357                                        "\"%%\\%03"UVof"\"",
8358                                        (UV)c & 0xFF);
8359                 } else
8360                     sv_catpv(msg, "end of string");
8361                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8362             }
8363
8364             /* output mangled stuff ... */
8365             if (c == '\0')
8366                 --q;
8367             eptr = p;
8368             elen = q - p;
8369
8370             /* ... right here, because formatting flags should not apply */
8371             SvGROW(sv, SvCUR(sv) + elen + 1);
8372             p = SvEND(sv);
8373             Copy(eptr, p, elen, char);
8374             p += elen;
8375             *p = '\0';
8376             SvCUR(sv) = p - SvPVX(sv);
8377             continue;   /* not "break" */
8378         }
8379
8380         if (is_utf8 != has_utf8) {
8381              if (is_utf8) {
8382                   if (SvCUR(sv))
8383                        sv_utf8_upgrade(sv);
8384              }
8385              else {
8386                   SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
8387                   sv_utf8_upgrade(nsv);
8388                   eptr = SvPVX(nsv);
8389                   elen = SvCUR(nsv);
8390              }
8391              SvGROW(sv, SvCUR(sv) + elen + 1);
8392              p = SvEND(sv);
8393              *p = '\0';
8394         }
8395         
8396         have = esignlen + zeros + elen;
8397         need = (have > width ? have : width);
8398         gap = need - have;
8399
8400         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8401         p = SvEND(sv);
8402         if (esignlen && fill == '0') {
8403             for (i = 0; i < (int)esignlen; i++)
8404                 *p++ = esignbuf[i];
8405         }
8406         if (gap && !left) {
8407             memset(p, fill, gap);
8408             p += gap;
8409         }
8410         if (esignlen && fill != '0') {
8411             for (i = 0; i < (int)esignlen; i++)
8412                 *p++ = esignbuf[i];
8413         }
8414         if (zeros) {
8415             for (i = zeros; i; i--)
8416                 *p++ = '0';
8417         }
8418         if (elen) {
8419             Copy(eptr, p, elen, char);
8420             p += elen;
8421         }
8422         if (gap && left) {
8423             memset(p, ' ', gap);
8424             p += gap;
8425         }
8426         if (vectorize) {
8427             if (veclen) {
8428                 Copy(dotstr, p, dotstrlen, char);
8429                 p += dotstrlen;
8430             }
8431             else
8432                 vectorize = FALSE;              /* done iterating over vecstr */
8433         }
8434         if (is_utf8)
8435             has_utf8 = TRUE;
8436         if (has_utf8)
8437             SvUTF8_on(sv);
8438         *p = '\0';
8439         SvCUR(sv) = p - SvPVX(sv);
8440         if (vectorize) {
8441             esignlen = 0;
8442             goto vector;
8443         }
8444     }
8445 }
8446
8447 /* =========================================================================
8448
8449 =head1 Cloning an interpreter
8450
8451 All the macros and functions in this section are for the private use of
8452 the main function, perl_clone().
8453
8454 The foo_dup() functions make an exact copy of an existing foo thinngy.
8455 During the course of a cloning, a hash table is used to map old addresses
8456 to new addresses. The table is created and manipulated with the
8457 ptr_table_* functions.
8458
8459 =cut
8460
8461 ============================================================================*/
8462
8463
8464 #if defined(USE_ITHREADS)
8465
8466 #if defined(USE_5005THREADS)
8467 #  include "error: USE_5005THREADS and USE_ITHREADS are incompatible"
8468 #endif
8469
8470 #ifndef GpREFCNT_inc
8471 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8472 #endif
8473
8474
8475 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8476 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
8477 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8478 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
8479 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8480 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
8481 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8482 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
8483 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8484 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
8485 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8486 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
8487 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
8488
8489
8490 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8491    regcomp.c. AMS 20010712 */
8492
8493 REGEXP *
8494 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
8495 {
8496     REGEXP *ret;
8497     int i, len, npar;
8498     struct reg_substr_datum *s;
8499
8500     if (!r)
8501         return (REGEXP *)NULL;
8502
8503     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8504         return ret;
8505
8506     len = r->offsets[0];
8507     npar = r->nparens+1;
8508
8509     Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8510     Copy(r->program, ret->program, len+1, regnode);
8511
8512     New(0, ret->startp, npar, I32);
8513     Copy(r->startp, ret->startp, npar, I32);
8514     New(0, ret->endp, npar, I32);
8515     Copy(r->startp, ret->startp, npar, I32);
8516
8517     New(0, ret->substrs, 1, struct reg_substr_data);
8518     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8519         s->min_offset = r->substrs->data[i].min_offset;
8520         s->max_offset = r->substrs->data[i].max_offset;
8521         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
8522         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8523     }
8524
8525     ret->regstclass = NULL;
8526     if (r->data) {
8527         struct reg_data *d;
8528         int count = r->data->count;
8529
8530         Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
8531                 char, struct reg_data);
8532         New(0, d->what, count, U8);
8533
8534         d->count = count;
8535         for (i = 0; i < count; i++) {
8536             d->what[i] = r->data->what[i];
8537             switch (d->what[i]) {
8538             case 's':
8539                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8540                 break;
8541             case 'p':
8542                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8543                 break;
8544             case 'f':
8545                 /* This is cheating. */
8546                 New(0, d->data[i], 1, struct regnode_charclass_class);
8547                 StructCopy(r->data->data[i], d->data[i],
8548                             struct regnode_charclass_class);
8549                 ret->regstclass = (regnode*)d->data[i];
8550                 break;
8551             case 'o':
8552                 /* Compiled op trees are readonly, and can thus be
8553                    shared without duplication. */
8554                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8555                 break;
8556             case 'n':
8557                 d->data[i] = r->data->data[i];
8558                 break;
8559             }
8560         }
8561
8562         ret->data = d;
8563     }
8564     else
8565         ret->data = NULL;
8566
8567     New(0, ret->offsets, 2*len+1, U32);
8568     Copy(r->offsets, ret->offsets, 2*len+1, U32);
8569
8570     ret->precomp        = SAVEPV(r->precomp);
8571     ret->refcnt         = r->refcnt;
8572     ret->minlen         = r->minlen;
8573     ret->prelen         = r->prelen;
8574     ret->nparens        = r->nparens;
8575     ret->lastparen      = r->lastparen;
8576     ret->lastcloseparen = r->lastcloseparen;
8577     ret->reganch        = r->reganch;
8578
8579     ret->sublen         = r->sublen;
8580
8581     if (RX_MATCH_COPIED(ret))
8582         ret->subbeg  = SAVEPV(r->subbeg);
8583     else
8584         ret->subbeg = Nullch;
8585
8586     ptr_table_store(PL_ptr_table, r, ret);
8587     return ret;
8588 }
8589
8590 /* duplicate a file handle */
8591
8592 PerlIO *
8593 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8594 {
8595     PerlIO *ret;
8596     if (!fp)
8597         return (PerlIO*)NULL;
8598
8599     /* look for it in the table first */
8600     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8601     if (ret)
8602         return ret;
8603
8604     /* create anew and remember what it is */
8605     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8606     ptr_table_store(PL_ptr_table, fp, ret);
8607     return ret;
8608 }
8609
8610 /* duplicate a directory handle */
8611
8612 DIR *
8613 Perl_dirp_dup(pTHX_ DIR *dp)
8614 {
8615     if (!dp)
8616         return (DIR*)NULL;
8617     /* XXX TODO */
8618     return dp;
8619 }
8620
8621 /* duplicate a typeglob */
8622
8623 GP *
8624 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8625 {
8626     GP *ret;
8627     if (!gp)
8628         return (GP*)NULL;
8629     /* look for it in the table first */
8630     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8631     if (ret)
8632         return ret;
8633
8634     /* create anew and remember what it is */
8635     Newz(0, ret, 1, GP);
8636     ptr_table_store(PL_ptr_table, gp, ret);
8637
8638     /* clone */
8639     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
8640     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
8641     ret->gp_io          = io_dup_inc(gp->gp_io, param);
8642     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
8643     ret->gp_av          = av_dup_inc(gp->gp_av, param);
8644     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
8645     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8646     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
8647     ret->gp_cvgen       = gp->gp_cvgen;
8648     ret->gp_flags       = gp->gp_flags;
8649     ret->gp_line        = gp->gp_line;
8650     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
8651     return ret;
8652 }
8653
8654 /* duplicate a chain of magic */
8655
8656 MAGIC *
8657 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8658 {
8659     MAGIC *mgprev = (MAGIC*)NULL;
8660     MAGIC *mgret;
8661     if (!mg)
8662         return (MAGIC*)NULL;
8663     /* look for it in the table first */
8664     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8665     if (mgret)
8666         return mgret;
8667
8668     for (; mg; mg = mg->mg_moremagic) {
8669         MAGIC *nmg;
8670         Newz(0, nmg, 1, MAGIC);
8671         if (mgprev)
8672             mgprev->mg_moremagic = nmg;
8673         else
8674             mgret = nmg;
8675         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
8676         nmg->mg_private = mg->mg_private;
8677         nmg->mg_type    = mg->mg_type;
8678         nmg->mg_flags   = mg->mg_flags;
8679         if (mg->mg_type == PERL_MAGIC_qr) {
8680             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8681         }
8682         else if(mg->mg_type == PERL_MAGIC_backref) {
8683              AV *av = (AV*) mg->mg_obj;
8684              SV **svp;
8685              I32 i;
8686              nmg->mg_obj = (SV*)newAV();
8687              svp = AvARRAY(av);
8688              i = AvFILLp(av);
8689              while (i >= 0) {
8690                   av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8691                   i--;
8692              }
8693         }
8694         else {
8695             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8696                               ? sv_dup_inc(mg->mg_obj, param)
8697                               : sv_dup(mg->mg_obj, param);
8698         }
8699         nmg->mg_len     = mg->mg_len;
8700         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
8701         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8702             if (mg->mg_len > 0) {
8703                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
8704                 if (mg->mg_type == PERL_MAGIC_overload_table &&
8705                         AMT_AMAGIC((AMT*)mg->mg_ptr))
8706                 {
8707                     AMT *amtp = (AMT*)mg->mg_ptr;
8708                     AMT *namtp = (AMT*)nmg->mg_ptr;
8709                     I32 i;
8710                     for (i = 1; i < NofAMmeth; i++) {
8711                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
8712                     }
8713                 }
8714             }
8715             else if (mg->mg_len == HEf_SVKEY)
8716                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
8717         }
8718         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
8719             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
8720         }
8721         mgprev = nmg;
8722     }
8723     return mgret;
8724 }
8725
8726 /* create a new pointer-mapping table */
8727
8728 PTR_TBL_t *
8729 Perl_ptr_table_new(pTHX)
8730 {
8731     PTR_TBL_t *tbl;
8732     Newz(0, tbl, 1, PTR_TBL_t);
8733     tbl->tbl_max        = 511;
8734     tbl->tbl_items      = 0;
8735     Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
8736     return tbl;
8737 }
8738
8739 /* map an existing pointer using a table */
8740
8741 void *
8742 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
8743 {
8744     PTR_TBL_ENT_t *tblent;
8745     UV hash = PTR2UV(sv);
8746     assert(tbl);
8747     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
8748     for (; tblent; tblent = tblent->next) {
8749         if (tblent->oldval == sv)
8750             return tblent->newval;
8751     }
8752     return (void*)NULL;
8753 }
8754
8755 /* add a new entry to a pointer-mapping table */
8756
8757 void
8758 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
8759 {
8760     PTR_TBL_ENT_t *tblent, **otblent;
8761     /* XXX this may be pessimal on platforms where pointers aren't good
8762      * hash values e.g. if they grow faster in the most significant
8763      * bits */
8764     UV hash = PTR2UV(oldv);
8765     bool i = 1;
8766
8767     assert(tbl);
8768     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
8769     for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
8770         if (tblent->oldval == oldv) {
8771             tblent->newval = newv;
8772             tbl->tbl_items++;
8773             return;
8774         }
8775     }
8776     Newz(0, tblent, 1, PTR_TBL_ENT_t);
8777     tblent->oldval = oldv;
8778     tblent->newval = newv;
8779     tblent->next = *otblent;
8780     *otblent = tblent;
8781     tbl->tbl_items++;
8782     if (i && tbl->tbl_items > tbl->tbl_max)
8783         ptr_table_split(tbl);
8784 }
8785
8786 /* double the hash bucket size of an existing ptr table */
8787
8788 void
8789 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
8790 {
8791     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
8792     UV oldsize = tbl->tbl_max + 1;
8793     UV newsize = oldsize * 2;
8794     UV i;
8795
8796     Renew(ary, newsize, PTR_TBL_ENT_t*);
8797     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
8798     tbl->tbl_max = --newsize;
8799     tbl->tbl_ary = ary;
8800     for (i=0; i < oldsize; i++, ary++) {
8801         PTR_TBL_ENT_t **curentp, **entp, *ent;
8802         if (!*ary)
8803             continue;
8804         curentp = ary + oldsize;
8805         for (entp = ary, ent = *ary; ent; ent = *entp) {
8806             if ((newsize & PTR2UV(ent->oldval)) != i) {
8807                 *entp = ent->next;
8808                 ent->next = *curentp;
8809                 *curentp = ent;
8810                 continue;
8811             }
8812             else
8813                 entp = &ent->next;
8814         }
8815     }
8816 }
8817
8818 /* remove all the entries from a ptr table */
8819
8820 void
8821 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
8822 {
8823     register PTR_TBL_ENT_t **array;
8824     register PTR_TBL_ENT_t *entry;
8825     register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
8826     UV riter = 0;
8827     UV max;
8828
8829     if (!tbl || !tbl->tbl_items) {
8830         return;
8831     }
8832
8833     array = tbl->tbl_ary;
8834     entry = array[0];
8835     max = tbl->tbl_max;
8836
8837     for (;;) {
8838         if (entry) {
8839             oentry = entry;
8840             entry = entry->next;
8841             Safefree(oentry);
8842         }
8843         if (!entry) {
8844             if (++riter > max) {
8845                 break;
8846             }
8847             entry = array[riter];
8848         }
8849     }
8850
8851     tbl->tbl_items = 0;
8852 }
8853
8854 /* clear and free a ptr table */
8855
8856 void
8857 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
8858 {
8859     if (!tbl) {
8860         return;
8861     }
8862     ptr_table_clear(tbl);
8863     Safefree(tbl->tbl_ary);
8864     Safefree(tbl);
8865 }
8866
8867 #ifdef DEBUGGING
8868 char *PL_watch_pvx;
8869 #endif
8870
8871 /* attempt to make everything in the typeglob readonly */
8872
8873 STATIC SV *
8874 S_gv_share(pTHX_ SV *sstr)
8875 {
8876     GV *gv = (GV*)sstr;
8877     SV *sv = &PL_sv_no; /* just need SvREADONLY-ness */
8878
8879     if (GvIO(gv) || GvFORM(gv)) {
8880         GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
8881     }
8882     else if (!GvCV(gv)) {
8883         GvCV(gv) = (CV*)sv;
8884     }
8885     else {
8886         /* CvPADLISTs cannot be shared */
8887         if (!CvXSUB(GvCV(gv))) {
8888             GvUNIQUE_off(gv);
8889         }
8890     }
8891
8892     if (!GvUNIQUE(gv)) {
8893 #if 0
8894         PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
8895                       HvNAME(GvSTASH(gv)), GvNAME(gv));
8896 #endif
8897         return Nullsv;
8898     }
8899
8900     /*
8901      * write attempts will die with
8902      * "Modification of a read-only value attempted"
8903      */
8904     if (!GvSV(gv)) {
8905         GvSV(gv) = sv;
8906     }
8907     else {
8908         SvREADONLY_on(GvSV(gv));
8909     }
8910
8911     if (!GvAV(gv)) {
8912         GvAV(gv) = (AV*)sv;
8913     }
8914     else {
8915         SvREADONLY_on(GvAV(gv));
8916     }
8917
8918     if (!GvHV(gv)) {
8919         GvHV(gv) = (HV*)sv;
8920     }
8921     else {
8922         SvREADONLY_on(GvAV(gv));
8923     }
8924
8925     return sstr; /* he_dup() will SvREFCNT_inc() */
8926 }
8927
8928 /* duplicate an SV of any type (including AV, HV etc) */
8929
8930 void
8931 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
8932 {
8933     if (SvROK(sstr)) {
8934         SvRV(dstr) = SvWEAKREF(sstr)
8935                      ? sv_dup(SvRV(sstr), param)
8936                      : sv_dup_inc(SvRV(sstr), param);
8937     }
8938     else if (SvPVX(sstr)) {
8939         /* Has something there */
8940         if (SvLEN(sstr)) {
8941             /* Normal PV - clone whole allocated space */
8942             SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8943         }
8944         else {
8945             /* Special case - not normally malloced for some reason */
8946             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
8947                 /* A "shared" PV - clone it as unshared string */
8948                 SvFAKE_off(dstr);
8949                 SvREADONLY_off(dstr);
8950                 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
8951             }
8952             else {
8953                 /* Some other special case - random pointer */
8954                 SvPVX(dstr) = SvPVX(sstr);              
8955             }
8956         }
8957     }
8958     else {
8959         /* Copy the Null */
8960         SvPVX(dstr) = SvPVX(sstr);
8961     }
8962 }
8963
8964 SV *
8965 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
8966 {
8967     SV *dstr;
8968
8969     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
8970         return Nullsv;
8971     /* look for it in the table first */
8972     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
8973     if (dstr)
8974         return dstr;
8975
8976     /* create anew and remember what it is */
8977     new_SV(dstr);
8978     ptr_table_store(PL_ptr_table, sstr, dstr);
8979
8980     /* clone */
8981     SvFLAGS(dstr)       = SvFLAGS(sstr);
8982     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
8983     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
8984
8985 #ifdef DEBUGGING
8986     if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
8987         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
8988                       PL_watch_pvx, SvPVX(sstr));
8989 #endif
8990
8991     switch (SvTYPE(sstr)) {
8992     case SVt_NULL:
8993         SvANY(dstr)     = NULL;
8994         break;
8995     case SVt_IV:
8996         SvANY(dstr)     = new_XIV();
8997         SvIVX(dstr)     = SvIVX(sstr);
8998         break;
8999     case SVt_NV:
9000         SvANY(dstr)     = new_XNV();
9001         SvNVX(dstr)     = SvNVX(sstr);
9002         break;
9003     case SVt_RV:
9004         SvANY(dstr)     = new_XRV();
9005         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9006         break;
9007     case SVt_PV:
9008         SvANY(dstr)     = new_XPV();
9009         SvCUR(dstr)     = SvCUR(sstr);
9010         SvLEN(dstr)     = SvLEN(sstr);
9011         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9012         break;
9013     case SVt_PVIV:
9014         SvANY(dstr)     = new_XPVIV();
9015         SvCUR(dstr)     = SvCUR(sstr);
9016         SvLEN(dstr)     = SvLEN(sstr);
9017         SvIVX(dstr)     = SvIVX(sstr);
9018         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9019         break;
9020     case SVt_PVNV:
9021         SvANY(dstr)     = new_XPVNV();
9022         SvCUR(dstr)     = SvCUR(sstr);
9023         SvLEN(dstr)     = SvLEN(sstr);
9024         SvIVX(dstr)     = SvIVX(sstr);
9025         SvNVX(dstr)     = SvNVX(sstr);
9026         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9027         break;
9028     case SVt_PVMG:
9029         SvANY(dstr)     = new_XPVMG();
9030         SvCUR(dstr)     = SvCUR(sstr);
9031         SvLEN(dstr)     = SvLEN(sstr);
9032         SvIVX(dstr)     = SvIVX(sstr);
9033         SvNVX(dstr)     = SvNVX(sstr);
9034         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9035         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9036         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9037         break;
9038     case SVt_PVBM:
9039         SvANY(dstr)     = new_XPVBM();
9040         SvCUR(dstr)     = SvCUR(sstr);
9041         SvLEN(dstr)     = SvLEN(sstr);
9042         SvIVX(dstr)     = SvIVX(sstr);
9043         SvNVX(dstr)     = SvNVX(sstr);
9044         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9045         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9046         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9047         BmRARE(dstr)    = BmRARE(sstr);
9048         BmUSEFUL(dstr)  = BmUSEFUL(sstr);
9049         BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9050         break;
9051     case SVt_PVLV:
9052         SvANY(dstr)     = new_XPVLV();
9053         SvCUR(dstr)     = SvCUR(sstr);
9054         SvLEN(dstr)     = SvLEN(sstr);
9055         SvIVX(dstr)     = SvIVX(sstr);
9056         SvNVX(dstr)     = SvNVX(sstr);
9057         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9058         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9059         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9060         LvTARGOFF(dstr) = LvTARGOFF(sstr);      /* XXX sometimes holds PMOP* when DEBUGGING */
9061         LvTARGLEN(dstr) = LvTARGLEN(sstr);
9062         LvTARG(dstr)    = sv_dup_inc(LvTARG(sstr), param);
9063         LvTYPE(dstr)    = LvTYPE(sstr);
9064         break;
9065     case SVt_PVGV:
9066         if (GvUNIQUE((GV*)sstr)) {
9067             SV *share;
9068             if ((share = gv_share(sstr))) {
9069                 del_SV(dstr);
9070                 dstr = share;
9071 #if 0
9072                 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9073                               HvNAME(GvSTASH(share)), GvNAME(share));
9074 #endif
9075                 break;
9076             }
9077         }
9078         SvANY(dstr)     = new_XPVGV();
9079         SvCUR(dstr)     = SvCUR(sstr);
9080         SvLEN(dstr)     = SvLEN(sstr);
9081         SvIVX(dstr)     = SvIVX(sstr);
9082         SvNVX(dstr)     = SvNVX(sstr);
9083         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9084         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9085         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9086         GvNAMELEN(dstr) = GvNAMELEN(sstr);
9087         GvNAME(dstr)    = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9088         GvSTASH(dstr)   = hv_dup_inc(GvSTASH(sstr), param);
9089         GvFLAGS(dstr)   = GvFLAGS(sstr);
9090         GvGP(dstr)      = gp_dup(GvGP(sstr), param);
9091         (void)GpREFCNT_inc(GvGP(dstr));
9092         break;
9093     case SVt_PVIO:
9094         SvANY(dstr)     = new_XPVIO();
9095         SvCUR(dstr)     = SvCUR(sstr);
9096         SvLEN(dstr)     = SvLEN(sstr);
9097         SvIVX(dstr)     = SvIVX(sstr);
9098         SvNVX(dstr)     = SvNVX(sstr);
9099         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9100         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9101         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9102         IoIFP(dstr)     = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9103         if (IoOFP(sstr) == IoIFP(sstr))
9104             IoOFP(dstr) = IoIFP(dstr);
9105         else
9106             IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9107         /* PL_rsfp_filters entries have fake IoDIRP() */
9108         if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9109             IoDIRP(dstr)        = dirp_dup(IoDIRP(sstr));
9110         else
9111             IoDIRP(dstr)        = IoDIRP(sstr);
9112         IoLINES(dstr)           = IoLINES(sstr);
9113         IoPAGE(dstr)            = IoPAGE(sstr);
9114         IoPAGE_LEN(dstr)        = IoPAGE_LEN(sstr);
9115         IoLINES_LEFT(dstr)      = IoLINES_LEFT(sstr);
9116         IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(sstr));
9117         IoTOP_GV(dstr)          = gv_dup(IoTOP_GV(sstr), param);
9118         IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(sstr));
9119         IoFMT_GV(dstr)          = gv_dup(IoFMT_GV(sstr), param);
9120         IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(sstr));
9121         IoBOTTOM_GV(dstr)       = gv_dup(IoBOTTOM_GV(sstr), param);
9122         IoSUBPROCESS(dstr)      = IoSUBPROCESS(sstr);
9123         IoTYPE(dstr)            = IoTYPE(sstr);
9124         IoFLAGS(dstr)           = IoFLAGS(sstr);
9125         break;
9126     case SVt_PVAV:
9127         SvANY(dstr)     = new_XPVAV();
9128         SvCUR(dstr)     = SvCUR(sstr);
9129         SvLEN(dstr)     = SvLEN(sstr);
9130         SvIVX(dstr)     = SvIVX(sstr);
9131         SvNVX(dstr)     = SvNVX(sstr);
9132         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9133         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9134         AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9135         AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9136         if (AvARRAY((AV*)sstr)) {
9137             SV **dst_ary, **src_ary;
9138             SSize_t items = AvFILLp((AV*)sstr) + 1;
9139
9140             src_ary = AvARRAY((AV*)sstr);
9141             Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9142             ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9143             SvPVX(dstr) = (char*)dst_ary;
9144             AvALLOC((AV*)dstr) = dst_ary;
9145             if (AvREAL((AV*)sstr)) {
9146                 while (items-- > 0)
9147                     *dst_ary++ = sv_dup_inc(*src_ary++, param);
9148             }
9149             else {
9150                 while (items-- > 0)
9151                     *dst_ary++ = sv_dup(*src_ary++, param);
9152             }
9153             items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9154             while (items-- > 0) {
9155                 *dst_ary++ = &PL_sv_undef;
9156             }
9157         }
9158         else {
9159             SvPVX(dstr)         = Nullch;
9160             AvALLOC((AV*)dstr)  = (SV**)NULL;
9161         }
9162         break;
9163     case SVt_PVHV:
9164         SvANY(dstr)     = new_XPVHV();
9165         SvCUR(dstr)     = SvCUR(sstr);
9166         SvLEN(dstr)     = SvLEN(sstr);
9167         SvIVX(dstr)     = SvIVX(sstr);
9168         SvNVX(dstr)     = SvNVX(sstr);
9169         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9170         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9171         HvRITER((HV*)dstr)      = HvRITER((HV*)sstr);
9172         if (HvARRAY((HV*)sstr)) {
9173             STRLEN i = 0;
9174             XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9175             XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9176             Newz(0, dxhv->xhv_array,
9177                  PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9178             while (i <= sxhv->xhv_max) {
9179                 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9180                                                     (bool)!!HvSHAREKEYS(sstr),
9181                                                     param);
9182                 ++i;
9183             }
9184             dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9185                                      (bool)!!HvSHAREKEYS(sstr), param);
9186         }
9187         else {
9188             SvPVX(dstr)         = Nullch;
9189             HvEITER((HV*)dstr)  = (HE*)NULL;
9190         }
9191         HvPMROOT((HV*)dstr)     = HvPMROOT((HV*)sstr);          /* XXX */
9192         HvNAME((HV*)dstr)       = SAVEPV(HvNAME((HV*)sstr));
9193     /* Record stashes for possible cloning in Perl_clone(). */
9194         if(HvNAME((HV*)dstr))
9195             av_push(param->stashes, dstr);
9196         break;
9197     case SVt_PVFM:
9198         SvANY(dstr)     = new_XPVFM();
9199         FmLINES(dstr)   = FmLINES(sstr);
9200         goto dup_pvcv;
9201         /* NOTREACHED */
9202     case SVt_PVCV:
9203         SvANY(dstr)     = new_XPVCV();
9204         dup_pvcv:
9205         SvCUR(dstr)     = SvCUR(sstr);
9206         SvLEN(dstr)     = SvLEN(sstr);
9207         SvIVX(dstr)     = SvIVX(sstr);
9208         SvNVX(dstr)     = SvNVX(sstr);
9209         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9210         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9211         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9212         CvSTASH(dstr)   = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9213         CvSTART(dstr)   = CvSTART(sstr);
9214         CvROOT(dstr)    = OpREFCNT_inc(CvROOT(sstr));
9215         CvXSUB(dstr)    = CvXSUB(sstr);
9216         CvXSUBANY(dstr) = CvXSUBANY(sstr);
9217         if (CvCONST(sstr)) {
9218             CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9219                 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9220                 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9221         }
9222         CvGV(dstr)      = gv_dup(CvGV(sstr), param);
9223         if (param->flags & CLONEf_COPY_STACKS) {
9224           CvDEPTH(dstr) = CvDEPTH(sstr);
9225         } else {
9226           CvDEPTH(dstr) = 0;
9227         }
9228         if (CvPADLIST(sstr) && !AvREAL(CvPADLIST(sstr))) {
9229             /* XXX padlists are real, but pretend to be not */
9230             AvREAL_on(CvPADLIST(sstr));
9231             CvPADLIST(dstr)     = av_dup_inc(CvPADLIST(sstr), param);
9232             AvREAL_off(CvPADLIST(sstr));
9233             AvREAL_off(CvPADLIST(dstr));
9234         }
9235         else
9236             CvPADLIST(dstr)     = av_dup_inc(CvPADLIST(sstr), param);
9237         if (!CvANON(sstr) || CvCLONED(sstr))
9238             CvOUTSIDE(dstr)     = cv_dup_inc(CvOUTSIDE(sstr), param);
9239         else
9240             CvOUTSIDE(dstr)     = cv_dup(CvOUTSIDE(sstr), param);
9241         CvFLAGS(dstr)   = CvFLAGS(sstr);
9242         CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9243         break;
9244     default:
9245         Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9246         break;
9247     }
9248
9249     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9250         ++PL_sv_objcount;
9251
9252     return dstr;
9253  }
9254
9255 /* duplicate a context */
9256
9257 PERL_CONTEXT *
9258 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9259 {
9260     PERL_CONTEXT *ncxs;
9261
9262     if (!cxs)
9263         return (PERL_CONTEXT*)NULL;
9264
9265     /* look for it in the table first */
9266     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9267     if (ncxs)
9268         return ncxs;
9269
9270     /* create anew and remember what it is */
9271     Newz(56, ncxs, max + 1, PERL_CONTEXT);
9272     ptr_table_store(PL_ptr_table, cxs, ncxs);
9273
9274     while (ix >= 0) {
9275         PERL_CONTEXT *cx = &cxs[ix];
9276         PERL_CONTEXT *ncx = &ncxs[ix];
9277         ncx->cx_type    = cx->cx_type;
9278         if (CxTYPE(cx) == CXt_SUBST) {
9279             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9280         }
9281         else {
9282             ncx->blk_oldsp      = cx->blk_oldsp;
9283             ncx->blk_oldcop     = cx->blk_oldcop;
9284             ncx->blk_oldretsp   = cx->blk_oldretsp;
9285             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
9286             ncx->blk_oldscopesp = cx->blk_oldscopesp;
9287             ncx->blk_oldpm      = cx->blk_oldpm;
9288             ncx->blk_gimme      = cx->blk_gimme;
9289             switch (CxTYPE(cx)) {
9290             case CXt_SUB:
9291                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
9292                                            ? cv_dup_inc(cx->blk_sub.cv, param)
9293                                            : cv_dup(cx->blk_sub.cv,param));
9294                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
9295                                            ? av_dup_inc(cx->blk_sub.argarray, param)
9296                                            : Nullav);
9297                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
9298                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
9299                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
9300                 ncx->blk_sub.lval       = cx->blk_sub.lval;
9301                 break;
9302             case CXt_EVAL:
9303                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9304                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9305                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);;
9306                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9307                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
9308                 break;
9309             case CXt_LOOP:
9310                 ncx->blk_loop.label     = cx->blk_loop.label;
9311                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
9312                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
9313                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
9314                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
9315                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
9316                                            ? cx->blk_loop.iterdata
9317                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
9318                 ncx->blk_loop.oldcurpad
9319                     = (SV**)ptr_table_fetch(PL_ptr_table,
9320                                             cx->blk_loop.oldcurpad);
9321                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
9322                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
9323                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
9324                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
9325                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
9326                 break;
9327             case CXt_FORMAT:
9328                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
9329                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
9330                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9331                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
9332                 break;
9333             case CXt_BLOCK:
9334             case CXt_NULL:
9335                 break;
9336             }
9337         }
9338         --ix;
9339     }
9340     return ncxs;
9341 }
9342
9343 /* duplicate a stack info structure */
9344
9345 PERL_SI *
9346 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9347 {
9348     PERL_SI *nsi;
9349
9350     if (!si)
9351         return (PERL_SI*)NULL;
9352
9353     /* look for it in the table first */
9354     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9355     if (nsi)
9356         return nsi;
9357
9358     /* create anew and remember what it is */
9359     Newz(56, nsi, 1, PERL_SI);
9360     ptr_table_store(PL_ptr_table, si, nsi);
9361
9362     nsi->si_stack       = av_dup_inc(si->si_stack, param);
9363     nsi->si_cxix        = si->si_cxix;
9364     nsi->si_cxmax       = si->si_cxmax;
9365     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9366     nsi->si_type        = si->si_type;
9367     nsi->si_prev        = si_dup(si->si_prev, param);
9368     nsi->si_next        = si_dup(si->si_next, param);
9369     nsi->si_markoff     = si->si_markoff;
9370
9371     return nsi;
9372 }
9373
9374 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
9375 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
9376 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
9377 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
9378 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
9379 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
9380 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
9381 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
9382 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
9383 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
9384 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9385 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9386
9387 /* XXXXX todo */
9388 #define pv_dup_inc(p)   SAVEPV(p)
9389 #define pv_dup(p)       SAVEPV(p)
9390 #define svp_dup_inc(p,pp)       any_dup(p,pp)
9391
9392 /* map any object to the new equivent - either something in the
9393  * ptr table, or something in the interpreter structure
9394  */
9395
9396 void *
9397 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
9398 {
9399     void *ret;
9400
9401     if (!v)
9402         return (void*)NULL;
9403
9404     /* look for it in the table first */
9405     ret = ptr_table_fetch(PL_ptr_table, v);
9406     if (ret)
9407         return ret;
9408
9409     /* see if it is part of the interpreter structure */
9410     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9411         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9412     else {
9413         ret = v;
9414     }
9415
9416     return ret;
9417 }
9418
9419 /* duplicate the save stack */
9420
9421 ANY *
9422 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9423 {
9424     ANY *ss     = proto_perl->Tsavestack;
9425     I32 ix      = proto_perl->Tsavestack_ix;
9426     I32 max     = proto_perl->Tsavestack_max;
9427     ANY *nss;
9428     SV *sv;
9429     GV *gv;
9430     AV *av;
9431     HV *hv;
9432     void* ptr;
9433     int intval;
9434     long longval;
9435     GP *gp;
9436     IV iv;
9437     I32 i;
9438     char *c = NULL;
9439     void (*dptr) (void*);
9440     void (*dxptr) (pTHX_ void*);
9441     OP *o;
9442
9443     Newz(54, nss, max, ANY);
9444
9445     while (ix > 0) {
9446         i = POPINT(ss,ix);
9447         TOPINT(nss,ix) = i;
9448         switch (i) {
9449         case SAVEt_ITEM:                        /* normal string */
9450             sv = (SV*)POPPTR(ss,ix);
9451             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9452             sv = (SV*)POPPTR(ss,ix);
9453             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9454             break;
9455         case SAVEt_SV:                          /* scalar reference */
9456             sv = (SV*)POPPTR(ss,ix);
9457             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9458             gv = (GV*)POPPTR(ss,ix);
9459             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9460             break;
9461         case SAVEt_GENERIC_PVREF:               /* generic char* */
9462             c = (char*)POPPTR(ss,ix);
9463             TOPPTR(nss,ix) = pv_dup(c);
9464             ptr = POPPTR(ss,ix);
9465             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9466             break;
9467         case SAVEt_SHARED_PVREF:                /* char* in shared space */
9468             c = (char*)POPPTR(ss,ix);
9469             TOPPTR(nss,ix) = savesharedpv(c);
9470             ptr = POPPTR(ss,ix);
9471             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9472             break;
9473         case SAVEt_GENERIC_SVREF:               /* generic sv */
9474         case SAVEt_SVREF:                       /* scalar reference */
9475             sv = (SV*)POPPTR(ss,ix);
9476             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9477             ptr = POPPTR(ss,ix);
9478             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9479             break;
9480         case SAVEt_AV:                          /* array reference */
9481             av = (AV*)POPPTR(ss,ix);
9482             TOPPTR(nss,ix) = av_dup_inc(av, param);
9483             gv = (GV*)POPPTR(ss,ix);
9484             TOPPTR(nss,ix) = gv_dup(gv, param);
9485             break;
9486         case SAVEt_HV:                          /* hash reference */
9487             hv = (HV*)POPPTR(ss,ix);
9488             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9489             gv = (GV*)POPPTR(ss,ix);
9490             TOPPTR(nss,ix) = gv_dup(gv, param);
9491             break;
9492         case SAVEt_INT:                         /* int reference */
9493             ptr = POPPTR(ss,ix);
9494             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9495             intval = (int)POPINT(ss,ix);
9496             TOPINT(nss,ix) = intval;
9497             break;
9498         case SAVEt_LONG:                        /* long reference */
9499             ptr = POPPTR(ss,ix);
9500             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9501             longval = (long)POPLONG(ss,ix);
9502             TOPLONG(nss,ix) = longval;
9503             break;
9504         case SAVEt_I32:                         /* I32 reference */
9505         case SAVEt_I16:                         /* I16 reference */
9506         case SAVEt_I8:                          /* I8 reference */
9507             ptr = POPPTR(ss,ix);
9508             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9509             i = POPINT(ss,ix);
9510             TOPINT(nss,ix) = i;
9511             break;
9512         case SAVEt_IV:                          /* IV reference */
9513             ptr = POPPTR(ss,ix);
9514             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9515             iv = POPIV(ss,ix);
9516             TOPIV(nss,ix) = iv;
9517             break;
9518         case SAVEt_SPTR:                        /* SV* reference */
9519             ptr = POPPTR(ss,ix);
9520             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9521             sv = (SV*)POPPTR(ss,ix);
9522             TOPPTR(nss,ix) = sv_dup(sv, param);
9523             break;
9524         case SAVEt_VPTR:                        /* random* reference */
9525             ptr = POPPTR(ss,ix);
9526             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9527             ptr = POPPTR(ss,ix);
9528             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9529             break;
9530         case SAVEt_PPTR:                        /* char* reference */
9531             ptr = POPPTR(ss,ix);
9532             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9533             c = (char*)POPPTR(ss,ix);
9534             TOPPTR(nss,ix) = pv_dup(c);
9535             break;
9536         case SAVEt_HPTR:                        /* HV* reference */
9537             ptr = POPPTR(ss,ix);
9538             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9539             hv = (HV*)POPPTR(ss,ix);
9540             TOPPTR(nss,ix) = hv_dup(hv, param);
9541             break;
9542         case SAVEt_APTR:                        /* AV* reference */
9543             ptr = POPPTR(ss,ix);
9544             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9545             av = (AV*)POPPTR(ss,ix);
9546             TOPPTR(nss,ix) = av_dup(av, param);
9547             break;
9548         case SAVEt_NSTAB:
9549             gv = (GV*)POPPTR(ss,ix);
9550             TOPPTR(nss,ix) = gv_dup(gv, param);
9551             break;
9552         case SAVEt_GP:                          /* scalar reference */
9553             gp = (GP*)POPPTR(ss,ix);
9554             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9555             (void)GpREFCNT_inc(gp);
9556             gv = (GV*)POPPTR(ss,ix);
9557             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9558             c = (char*)POPPTR(ss,ix);
9559             TOPPTR(nss,ix) = pv_dup(c);
9560             iv = POPIV(ss,ix);
9561             TOPIV(nss,ix) = iv;
9562             iv = POPIV(ss,ix);
9563             TOPIV(nss,ix) = iv;
9564             break;
9565         case SAVEt_FREESV:
9566         case SAVEt_MORTALIZESV:
9567             sv = (SV*)POPPTR(ss,ix);
9568             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9569             break;
9570         case SAVEt_FREEOP:
9571             ptr = POPPTR(ss,ix);
9572             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9573                 /* these are assumed to be refcounted properly */
9574                 switch (((OP*)ptr)->op_type) {
9575                 case OP_LEAVESUB:
9576                 case OP_LEAVESUBLV:
9577                 case OP_LEAVEEVAL:
9578                 case OP_LEAVE:
9579                 case OP_SCOPE:
9580                 case OP_LEAVEWRITE:
9581                     TOPPTR(nss,ix) = ptr;
9582                     o = (OP*)ptr;
9583                     OpREFCNT_inc(o);
9584                     break;
9585                 default:
9586                     TOPPTR(nss,ix) = Nullop;
9587                     break;
9588                 }
9589             }
9590             else
9591                 TOPPTR(nss,ix) = Nullop;
9592             break;
9593         case SAVEt_FREEPV:
9594             c = (char*)POPPTR(ss,ix);
9595             TOPPTR(nss,ix) = pv_dup_inc(c);
9596             break;
9597         case SAVEt_CLEARSV:
9598             longval = POPLONG(ss,ix);
9599             TOPLONG(nss,ix) = longval;
9600             break;
9601         case SAVEt_DELETE:
9602             hv = (HV*)POPPTR(ss,ix);
9603             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9604             c = (char*)POPPTR(ss,ix);
9605             TOPPTR(nss,ix) = pv_dup_inc(c);
9606             i = POPINT(ss,ix);
9607             TOPINT(nss,ix) = i;
9608             break;
9609         case SAVEt_DESTRUCTOR:
9610             ptr = POPPTR(ss,ix);
9611             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
9612             dptr = POPDPTR(ss,ix);
9613             TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
9614             break;
9615         case SAVEt_DESTRUCTOR_X:
9616             ptr = POPPTR(ss,ix);
9617             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
9618             dxptr = POPDXPTR(ss,ix);
9619             TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
9620             break;
9621         case SAVEt_REGCONTEXT:
9622         case SAVEt_ALLOC:
9623             i = POPINT(ss,ix);
9624             TOPINT(nss,ix) = i;
9625             ix -= i;
9626             break;
9627         case SAVEt_STACK_POS:           /* Position on Perl stack */
9628             i = POPINT(ss,ix);
9629             TOPINT(nss,ix) = i;
9630             break;
9631         case SAVEt_AELEM:               /* array element */
9632             sv = (SV*)POPPTR(ss,ix);
9633             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9634             i = POPINT(ss,ix);
9635             TOPINT(nss,ix) = i;
9636             av = (AV*)POPPTR(ss,ix);
9637             TOPPTR(nss,ix) = av_dup_inc(av, param);
9638             break;
9639         case SAVEt_HELEM:               /* hash element */
9640             sv = (SV*)POPPTR(ss,ix);
9641             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9642             sv = (SV*)POPPTR(ss,ix);
9643             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9644             hv = (HV*)POPPTR(ss,ix);
9645             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9646             break;
9647         case SAVEt_OP:
9648             ptr = POPPTR(ss,ix);
9649             TOPPTR(nss,ix) = ptr;
9650             break;
9651         case SAVEt_HINTS:
9652             i = POPINT(ss,ix);
9653             TOPINT(nss,ix) = i;
9654             break;
9655         case SAVEt_COMPPAD:
9656             av = (AV*)POPPTR(ss,ix);
9657             TOPPTR(nss,ix) = av_dup(av, param);
9658             break;
9659         case SAVEt_PADSV:
9660             longval = (long)POPLONG(ss,ix);
9661             TOPLONG(nss,ix) = longval;
9662             ptr = POPPTR(ss,ix);
9663             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9664             sv = (SV*)POPPTR(ss,ix);
9665             TOPPTR(nss,ix) = sv_dup(sv, param);
9666             break;
9667         default:
9668             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9669         }
9670     }
9671
9672     return nss;
9673 }
9674
9675 /*
9676 =for apidoc perl_clone
9677
9678 Create and return a new interpreter by cloning the current one.
9679
9680 =cut
9681 */
9682
9683 /* XXX the above needs expanding by someone who actually understands it ! */
9684 EXTERN_C PerlInterpreter *
9685 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
9686
9687 PerlInterpreter *
9688 perl_clone(PerlInterpreter *proto_perl, UV flags)
9689 {
9690 #ifdef PERL_IMPLICIT_SYS
9691
9692    /* perlhost.h so we need to call into it
9693    to clone the host, CPerlHost should have a c interface, sky */
9694
9695    if (flags & CLONEf_CLONE_HOST) {
9696        return perl_clone_host(proto_perl,flags);
9697    }
9698    return perl_clone_using(proto_perl, flags,
9699                             proto_perl->IMem,
9700                             proto_perl->IMemShared,
9701                             proto_perl->IMemParse,
9702                             proto_perl->IEnv,
9703                             proto_perl->IStdIO,
9704                             proto_perl->ILIO,
9705                             proto_perl->IDir,
9706                             proto_perl->ISock,
9707                             proto_perl->IProc);
9708 }
9709
9710 PerlInterpreter *
9711 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
9712                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
9713                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
9714                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
9715                  struct IPerlDir* ipD, struct IPerlSock* ipS,
9716                  struct IPerlProc* ipP)
9717 {
9718     /* XXX many of the string copies here can be optimized if they're
9719      * constants; they need to be allocated as common memory and just
9720      * their pointers copied. */
9721
9722     IV i;
9723     CLONE_PARAMS clone_params;
9724     CLONE_PARAMS* param = &clone_params;
9725
9726     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9727     PERL_SET_THX(my_perl);
9728
9729 #  ifdef DEBUGGING
9730     Poison(my_perl, 1, PerlInterpreter);
9731     PL_markstack = 0;
9732     PL_scopestack = 0;
9733     PL_savestack = 0;
9734     PL_retstack = 0;
9735     PL_sig_pending = 0;
9736     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9737 #  else /* !DEBUGGING */
9738     Zero(my_perl, 1, PerlInterpreter);
9739 #  endif        /* DEBUGGING */
9740
9741     /* host pointers */
9742     PL_Mem              = ipM;
9743     PL_MemShared        = ipMS;
9744     PL_MemParse         = ipMP;
9745     PL_Env              = ipE;
9746     PL_StdIO            = ipStd;
9747     PL_LIO              = ipLIO;
9748     PL_Dir              = ipD;
9749     PL_Sock             = ipS;
9750     PL_Proc             = ipP;
9751 #else           /* !PERL_IMPLICIT_SYS */
9752     IV i;
9753     CLONE_PARAMS clone_params;
9754     CLONE_PARAMS* param = &clone_params;
9755     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9756     PERL_SET_THX(my_perl);
9757
9758
9759
9760 #    ifdef DEBUGGING
9761     Poison(my_perl, 1, PerlInterpreter);
9762     PL_markstack = 0;
9763     PL_scopestack = 0;
9764     PL_savestack = 0;
9765     PL_retstack = 0;
9766     PL_sig_pending = 0;
9767     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9768 #    else       /* !DEBUGGING */
9769     Zero(my_perl, 1, PerlInterpreter);
9770 #    endif      /* DEBUGGING */
9771 #endif          /* PERL_IMPLICIT_SYS */
9772     param->flags = flags;
9773
9774     /* arena roots */
9775     PL_xiv_arenaroot    = NULL;
9776     PL_xiv_root         = NULL;
9777     PL_xnv_arenaroot    = NULL;
9778     PL_xnv_root         = NULL;
9779     PL_xrv_arenaroot    = NULL;
9780     PL_xrv_root         = NULL;
9781     PL_xpv_arenaroot    = NULL;
9782     PL_xpv_root         = NULL;
9783     PL_xpviv_arenaroot  = NULL;
9784     PL_xpviv_root       = NULL;
9785     PL_xpvnv_arenaroot  = NULL;
9786     PL_xpvnv_root       = NULL;
9787     PL_xpvcv_arenaroot  = NULL;
9788     PL_xpvcv_root       = NULL;
9789     PL_xpvav_arenaroot  = NULL;
9790     PL_xpvav_root       = NULL;
9791     PL_xpvhv_arenaroot  = NULL;
9792     PL_xpvhv_root       = NULL;
9793     PL_xpvmg_arenaroot  = NULL;
9794     PL_xpvmg_root       = NULL;
9795     PL_xpvlv_arenaroot  = NULL;
9796     PL_xpvlv_root       = NULL;
9797     PL_xpvbm_arenaroot  = NULL;
9798     PL_xpvbm_root       = NULL;
9799     PL_he_arenaroot     = NULL;
9800     PL_he_root          = NULL;
9801     PL_nice_chunk       = NULL;
9802     PL_nice_chunk_size  = 0;
9803     PL_sv_count         = 0;
9804     PL_sv_objcount      = 0;
9805     PL_sv_root          = Nullsv;
9806     PL_sv_arenaroot     = Nullsv;
9807
9808     PL_debug            = proto_perl->Idebug;
9809
9810 #ifdef USE_REENTRANT_API
9811     Perl_reentrant_init(aTHX);
9812 #endif
9813
9814     /* create SV map for pointer relocation */
9815     PL_ptr_table = ptr_table_new();
9816
9817     /* initialize these special pointers as early as possible */
9818     SvANY(&PL_sv_undef)         = NULL;
9819     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
9820     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
9821     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
9822
9823     SvANY(&PL_sv_no)            = new_XPVNV();
9824     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
9825     SvFLAGS(&PL_sv_no)          = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9826     SvPVX(&PL_sv_no)            = SAVEPVN(PL_No, 0);
9827     SvCUR(&PL_sv_no)            = 0;
9828     SvLEN(&PL_sv_no)            = 1;
9829     SvNVX(&PL_sv_no)            = 0;
9830     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
9831
9832     SvANY(&PL_sv_yes)           = new_XPVNV();
9833     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
9834     SvFLAGS(&PL_sv_yes)         = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9835     SvPVX(&PL_sv_yes)           = SAVEPVN(PL_Yes, 1);
9836     SvCUR(&PL_sv_yes)           = 1;
9837     SvLEN(&PL_sv_yes)           = 2;
9838     SvNVX(&PL_sv_yes)           = 1;
9839     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
9840
9841     /* create (a non-shared!) shared string table */
9842     PL_strtab           = newHV();
9843     HvSHAREKEYS_off(PL_strtab);
9844     hv_ksplit(PL_strtab, 512);
9845     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
9846
9847     PL_compiling = proto_perl->Icompiling;
9848
9849     /* These two PVs will be free'd special way so must set them same way op.c does */
9850     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
9851     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
9852
9853     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
9854     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
9855
9856     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
9857     if (!specialWARN(PL_compiling.cop_warnings))
9858         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
9859     if (!specialCopIO(PL_compiling.cop_io))
9860         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
9861     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
9862
9863     /* pseudo environmental stuff */
9864     PL_origargc         = proto_perl->Iorigargc;
9865     i = PL_origargc;
9866     New(0, PL_origargv, i+1, char*);
9867     PL_origargv[i] = '\0';
9868     while (i-- > 0) {
9869         PL_origargv[i]  = SAVEPV(proto_perl->Iorigargv[i]);
9870     }
9871
9872     param->stashes      = newAV();  /* Setup array of objects to call clone on */
9873
9874 #ifdef PERLIO_LAYERS
9875     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
9876     PerlIO_clone(aTHX_ proto_perl, param);
9877 #endif
9878
9879     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
9880     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
9881     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
9882     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
9883     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
9884     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
9885
9886     /* switches */
9887     PL_minus_c          = proto_perl->Iminus_c;
9888     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
9889     PL_localpatches     = proto_perl->Ilocalpatches;
9890     PL_splitstr         = proto_perl->Isplitstr;
9891     PL_preprocess       = proto_perl->Ipreprocess;
9892     PL_minus_n          = proto_perl->Iminus_n;
9893     PL_minus_p          = proto_perl->Iminus_p;
9894     PL_minus_l          = proto_perl->Iminus_l;
9895     PL_minus_a          = proto_perl->Iminus_a;
9896     PL_minus_F          = proto_perl->Iminus_F;
9897     PL_doswitches       = proto_perl->Idoswitches;
9898     PL_dowarn           = proto_perl->Idowarn;
9899     PL_doextract        = proto_perl->Idoextract;
9900     PL_sawampersand     = proto_perl->Isawampersand;
9901     PL_unsafe           = proto_perl->Iunsafe;
9902     PL_inplace          = SAVEPV(proto_perl->Iinplace);
9903     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
9904     PL_perldb           = proto_perl->Iperldb;
9905     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
9906     PL_exit_flags       = proto_perl->Iexit_flags;
9907
9908     /* magical thingies */
9909     /* XXX time(&PL_basetime) when asked for? */
9910     PL_basetime         = proto_perl->Ibasetime;
9911     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
9912
9913     PL_maxsysfd         = proto_perl->Imaxsysfd;
9914     PL_multiline        = proto_perl->Imultiline;
9915     PL_statusvalue      = proto_perl->Istatusvalue;
9916 #ifdef VMS
9917     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
9918 #endif
9919     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
9920
9921     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
9922     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
9923     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
9924
9925     /* Clone the regex array */
9926     PL_regex_padav = newAV();
9927     {
9928         I32 len = av_len((AV*)proto_perl->Iregex_padav);
9929         SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
9930         av_push(PL_regex_padav,
9931                 sv_dup_inc(regexen[0],param));
9932         for(i = 1; i <= len; i++) {
9933             if(SvREPADTMP(regexen[i])) {
9934               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
9935             } else {
9936                 av_push(PL_regex_padav,
9937                     SvREFCNT_inc(
9938                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
9939                              SvIVX(regexen[i])), param)))
9940                        ));
9941             }
9942         }
9943     }
9944     PL_regex_pad = AvARRAY(PL_regex_padav);
9945
9946     /* shortcuts to various I/O objects */
9947     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
9948     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
9949     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
9950     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
9951     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
9952     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
9953
9954     /* shortcuts to regexp stuff */
9955     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
9956
9957     /* shortcuts to misc objects */
9958     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
9959
9960     /* shortcuts to debugging objects */
9961     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
9962     PL_DBline           = gv_dup(proto_perl->IDBline, param);
9963     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
9964     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
9965     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
9966     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
9967     PL_lineary          = av_dup(proto_perl->Ilineary, param);
9968     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
9969
9970     /* symbol tables */
9971     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
9972     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
9973     PL_nullstash       = hv_dup(proto_perl->Inullstash, param);
9974     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
9975     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
9976     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
9977
9978     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
9979     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
9980     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
9981     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
9982     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
9983
9984     PL_sub_generation   = proto_perl->Isub_generation;
9985
9986     /* funky return mechanisms */
9987     PL_forkprocess      = proto_perl->Iforkprocess;
9988
9989     /* subprocess state */
9990     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
9991
9992     /* internal state */
9993     PL_tainting         = proto_perl->Itainting;
9994     PL_maxo             = proto_perl->Imaxo;
9995     if (proto_perl->Iop_mask)
9996         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
9997     else
9998         PL_op_mask      = Nullch;
9999
10000     /* current interpreter roots */
10001     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
10002     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
10003     PL_main_start       = proto_perl->Imain_start;
10004     PL_eval_root        = proto_perl->Ieval_root;
10005     PL_eval_start       = proto_perl->Ieval_start;
10006
10007     /* runtime control stuff */
10008     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10009     PL_copline          = proto_perl->Icopline;
10010
10011     PL_filemode         = proto_perl->Ifilemode;
10012     PL_lastfd           = proto_perl->Ilastfd;
10013     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
10014     PL_Argv             = NULL;
10015     PL_Cmd              = Nullch;
10016     PL_gensym           = proto_perl->Igensym;
10017     PL_preambled        = proto_perl->Ipreambled;
10018     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
10019     PL_laststatval      = proto_perl->Ilaststatval;
10020     PL_laststype        = proto_perl->Ilaststype;
10021     PL_mess_sv          = Nullsv;
10022
10023     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
10024     PL_ofmt             = SAVEPV(proto_perl->Iofmt);
10025
10026     /* interpreter atexit processing */
10027     PL_exitlistlen      = proto_perl->Iexitlistlen;
10028     if (PL_exitlistlen) {
10029         New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10030         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10031     }
10032     else
10033         PL_exitlist     = (PerlExitListEntry*)NULL;
10034     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
10035     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
10036     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10037
10038     PL_profiledata      = NULL;
10039     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
10040     /* PL_rsfp_filters entries have fake IoDIRP() */
10041     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
10042
10043     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
10044     PL_comppad                  = av_dup(proto_perl->Icomppad, param);
10045     PL_comppad_name             = av_dup(proto_perl->Icomppad_name, param);
10046     PL_comppad_name_fill        = proto_perl->Icomppad_name_fill;
10047     PL_comppad_name_floor       = proto_perl->Icomppad_name_floor;
10048     PL_curpad                   = (SV**)ptr_table_fetch(PL_ptr_table,
10049                                                         proto_perl->Tcurpad);
10050
10051 #ifdef HAVE_INTERP_INTERN
10052     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10053 #endif
10054
10055     /* more statics moved here */
10056     PL_generation       = proto_perl->Igeneration;
10057     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
10058
10059     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
10060     PL_in_clean_all     = proto_perl->Iin_clean_all;
10061
10062     PL_uid              = proto_perl->Iuid;
10063     PL_euid             = proto_perl->Ieuid;
10064     PL_gid              = proto_perl->Igid;
10065     PL_egid             = proto_perl->Iegid;
10066     PL_nomemok          = proto_perl->Inomemok;
10067     PL_an               = proto_perl->Ian;
10068     PL_cop_seqmax       = proto_perl->Icop_seqmax;
10069     PL_op_seqmax        = proto_perl->Iop_seqmax;
10070     PL_evalseq          = proto_perl->Ievalseq;
10071     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
10072     PL_origalen         = proto_perl->Iorigalen;
10073     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
10074     PL_osname           = SAVEPV(proto_perl->Iosname);
10075     PL_sh_path          = proto_perl->Ish_path; /* XXX never deallocated */
10076     PL_sighandlerp      = proto_perl->Isighandlerp;
10077
10078
10079     PL_runops           = proto_perl->Irunops;
10080
10081     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10082
10083 #ifdef CSH
10084     PL_cshlen           = proto_perl->Icshlen;
10085     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
10086 #endif
10087
10088     PL_lex_state        = proto_perl->Ilex_state;
10089     PL_lex_defer        = proto_perl->Ilex_defer;
10090     PL_lex_expect       = proto_perl->Ilex_expect;
10091     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
10092     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
10093     PL_lex_starts       = proto_perl->Ilex_starts;
10094     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
10095     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
10096     PL_lex_op           = proto_perl->Ilex_op;
10097     PL_lex_inpat        = proto_perl->Ilex_inpat;
10098     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
10099     PL_lex_brackets     = proto_perl->Ilex_brackets;
10100     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10101     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
10102     PL_lex_casemods     = proto_perl->Ilex_casemods;
10103     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10104     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
10105
10106     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10107     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10108     PL_nexttoke         = proto_perl->Inexttoke;
10109
10110     PL_linestr          = sv_dup_inc(proto_perl->Ilinestr, param);
10111     i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10112     PL_bufptr           = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10113     i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10114     PL_oldbufptr        = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10115     i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10116     PL_oldoldbufptr     = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10117     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10118     i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10119     PL_linestart        = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10120     PL_pending_ident    = proto_perl->Ipending_ident;
10121     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
10122
10123     PL_expect           = proto_perl->Iexpect;
10124
10125     PL_multi_start      = proto_perl->Imulti_start;
10126     PL_multi_end        = proto_perl->Imulti_end;
10127     PL_multi_open       = proto_perl->Imulti_open;
10128     PL_multi_close      = proto_perl->Imulti_close;
10129
10130     PL_error_count      = proto_perl->Ierror_count;
10131     PL_subline          = proto_perl->Isubline;
10132     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
10133
10134     PL_min_intro_pending        = proto_perl->Imin_intro_pending;
10135     PL_max_intro_pending        = proto_perl->Imax_intro_pending;
10136     PL_padix                    = proto_perl->Ipadix;
10137     PL_padix_floor              = proto_perl->Ipadix_floor;
10138     PL_pad_reset_pending        = proto_perl->Ipad_reset_pending;
10139
10140     i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10141     PL_last_uni         = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10142     i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10143     PL_last_lop         = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10144     PL_last_lop_op      = proto_perl->Ilast_lop_op;
10145     PL_in_my            = proto_perl->Iin_my;
10146     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
10147 #ifdef FCRYPT
10148     PL_cryptseen        = proto_perl->Icryptseen;
10149 #endif
10150
10151     PL_hints            = proto_perl->Ihints;
10152
10153     PL_amagic_generation        = proto_perl->Iamagic_generation;
10154
10155 #ifdef USE_LOCALE_COLLATE
10156     PL_collation_ix     = proto_perl->Icollation_ix;
10157     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
10158     PL_collation_standard       = proto_perl->Icollation_standard;
10159     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
10160     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
10161 #endif /* USE_LOCALE_COLLATE */
10162
10163 #ifdef USE_LOCALE_NUMERIC
10164     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
10165     PL_numeric_standard = proto_perl->Inumeric_standard;
10166     PL_numeric_local    = proto_perl->Inumeric_local;
10167     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10168 #endif /* !USE_LOCALE_NUMERIC */
10169
10170     /* utf8 character classes */
10171     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10172     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10173     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10174     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10175     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
10176     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10177     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
10178     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
10179     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
10180     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
10181     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
10182     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
10183     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10184     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
10185     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10186     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10187     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10188     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10189     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10190     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10191
10192     /* swatch cache */
10193     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
10194     PL_last_swash_klen  = 0;
10195     PL_last_swash_key[0]= '\0';
10196     PL_last_swash_tmps  = (U8*)NULL;
10197     PL_last_swash_slen  = 0;
10198
10199     /* perly.c globals */
10200     PL_yydebug          = proto_perl->Iyydebug;
10201     PL_yynerrs          = proto_perl->Iyynerrs;
10202     PL_yyerrflag        = proto_perl->Iyyerrflag;
10203     PL_yychar           = proto_perl->Iyychar;
10204     PL_yyval            = proto_perl->Iyyval;
10205     PL_yylval           = proto_perl->Iyylval;
10206
10207     PL_glob_index       = proto_perl->Iglob_index;
10208     PL_srand_called     = proto_perl->Isrand_called;
10209     PL_uudmap['M']      = 0;            /* reinits on demand */
10210     PL_bitcount         = Nullch;       /* reinits on demand */
10211
10212     if (proto_perl->Ipsig_pend) {
10213         Newz(0, PL_psig_pend, SIG_SIZE, int);
10214     }
10215     else {
10216         PL_psig_pend    = (int*)NULL;
10217     }
10218
10219     if (proto_perl->Ipsig_ptr) {
10220         Newz(0, PL_psig_ptr,  SIG_SIZE, SV*);
10221         Newz(0, PL_psig_name, SIG_SIZE, SV*);
10222         for (i = 1; i < SIG_SIZE; i++) {
10223             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10224             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10225         }
10226     }
10227     else {
10228         PL_psig_ptr     = (SV**)NULL;
10229         PL_psig_name    = (SV**)NULL;
10230     }
10231
10232     /* thrdvar.h stuff */
10233
10234     if (flags & CLONEf_COPY_STACKS) {
10235         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10236         PL_tmps_ix              = proto_perl->Ttmps_ix;
10237         PL_tmps_max             = proto_perl->Ttmps_max;
10238         PL_tmps_floor           = proto_perl->Ttmps_floor;
10239         Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10240         i = 0;
10241         while (i <= PL_tmps_ix) {
10242             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10243             ++i;
10244         }
10245
10246         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10247         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10248         Newz(54, PL_markstack, i, I32);
10249         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
10250                                                   - proto_perl->Tmarkstack);
10251         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
10252                                                   - proto_perl->Tmarkstack);
10253         Copy(proto_perl->Tmarkstack, PL_markstack,
10254              PL_markstack_ptr - PL_markstack + 1, I32);
10255
10256         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10257          * NOTE: unlike the others! */
10258         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
10259         PL_scopestack_max       = proto_perl->Tscopestack_max;
10260         Newz(54, PL_scopestack, PL_scopestack_max, I32);
10261         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10262
10263         /* next push_return() sets PL_retstack[PL_retstack_ix]
10264          * NOTE: unlike the others! */
10265         PL_retstack_ix          = proto_perl->Tretstack_ix;
10266         PL_retstack_max         = proto_perl->Tretstack_max;
10267         Newz(54, PL_retstack, PL_retstack_max, OP*);
10268         Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
10269
10270         /* NOTE: si_dup() looks at PL_markstack */
10271         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
10272
10273         /* PL_curstack          = PL_curstackinfo->si_stack; */
10274         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
10275         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
10276
10277         /* next PUSHs() etc. set *(PL_stack_sp+1) */
10278         PL_stack_base           = AvARRAY(PL_curstack);
10279         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
10280                                                    - proto_perl->Tstack_base);
10281         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
10282
10283         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10284          * NOTE: unlike the others! */
10285         PL_savestack_ix         = proto_perl->Tsavestack_ix;
10286         PL_savestack_max        = proto_perl->Tsavestack_max;
10287         /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10288         PL_savestack            = ss_dup(proto_perl, param);
10289     }
10290     else {
10291         init_stacks();
10292         ENTER;                  /* perl_destruct() wants to LEAVE; */
10293     }
10294
10295     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
10296     PL_top_env          = &PL_start_env;
10297
10298     PL_op               = proto_perl->Top;
10299
10300     PL_Sv               = Nullsv;
10301     PL_Xpv              = (XPV*)NULL;
10302     PL_na               = proto_perl->Tna;
10303
10304     PL_statbuf          = proto_perl->Tstatbuf;
10305     PL_statcache        = proto_perl->Tstatcache;
10306     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
10307     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
10308 #ifdef HAS_TIMES
10309     PL_timesbuf         = proto_perl->Ttimesbuf;
10310 #endif
10311
10312     PL_tainted          = proto_perl->Ttainted;
10313     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
10314     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
10315     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
10316     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
10317     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
10318     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
10319     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
10320     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
10321     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
10322
10323     PL_restartop        = proto_perl->Trestartop;
10324     PL_in_eval          = proto_perl->Tin_eval;
10325     PL_delaymagic       = proto_perl->Tdelaymagic;
10326     PL_dirty            = proto_perl->Tdirty;
10327     PL_localizing       = proto_perl->Tlocalizing;
10328
10329 #ifdef PERL_FLEXIBLE_EXCEPTIONS
10330     PL_protect          = proto_perl->Tprotect;
10331 #endif
10332     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
10333     PL_av_fetch_sv      = Nullsv;
10334     PL_hv_fetch_sv      = Nullsv;
10335     Zero(&PL_hv_fetch_ent_mh, 1, HE);                   /* XXX */
10336     PL_modcount         = proto_perl->Tmodcount;
10337     PL_lastgotoprobe    = Nullop;
10338     PL_dumpindent       = proto_perl->Tdumpindent;
10339
10340     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10341     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
10342     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
10343     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
10344     PL_sortcxix         = proto_perl->Tsortcxix;
10345     PL_efloatbuf        = Nullch;               /* reinits on demand */
10346     PL_efloatsize       = 0;                    /* reinits on demand */
10347
10348     /* regex stuff */
10349
10350     PL_screamfirst      = NULL;
10351     PL_screamnext       = NULL;
10352     PL_maxscream        = -1;                   /* reinits on demand */
10353     PL_lastscream       = Nullsv;
10354
10355     PL_watchaddr        = NULL;
10356     PL_watchok          = Nullch;
10357
10358     PL_regdummy         = proto_perl->Tregdummy;
10359     PL_regcomp_parse    = Nullch;
10360     PL_regxend          = Nullch;
10361     PL_regcode          = (regnode*)NULL;
10362     PL_regnaughty       = 0;
10363     PL_regsawback       = 0;
10364     PL_regprecomp       = Nullch;
10365     PL_regnpar          = 0;
10366     PL_regsize          = 0;
10367     PL_regflags         = 0;
10368     PL_regseen          = 0;
10369     PL_seen_zerolen     = 0;
10370     PL_seen_evals       = 0;
10371     PL_regcomp_rx       = (regexp*)NULL;
10372     PL_extralen         = 0;
10373     PL_colorset         = 0;            /* reinits PL_colors[] */
10374     /*PL_colors[6]      = {0,0,0,0,0,0};*/
10375     PL_reg_whilem_seen  = 0;
10376     PL_reginput         = Nullch;
10377     PL_regbol           = Nullch;
10378     PL_regeol           = Nullch;
10379     PL_regstartp        = (I32*)NULL;
10380     PL_regendp          = (I32*)NULL;
10381     PL_reglastparen     = (U32*)NULL;
10382     PL_regtill          = Nullch;
10383     PL_reg_start_tmp    = (char**)NULL;
10384     PL_reg_start_tmpl   = 0;
10385     PL_regdata          = (struct reg_data*)NULL;
10386     PL_bostr            = Nullch;
10387     PL_reg_flags        = 0;
10388     PL_reg_eval_set     = 0;
10389     PL_regnarrate       = 0;
10390     PL_regprogram       = (regnode*)NULL;
10391     PL_regindent        = 0;
10392     PL_regcc            = (CURCUR*)NULL;
10393     PL_reg_call_cc      = (struct re_cc_state*)NULL;
10394     PL_reg_re           = (regexp*)NULL;
10395     PL_reg_ganch        = Nullch;
10396     PL_reg_sv           = Nullsv;
10397     PL_reg_match_utf8   = FALSE;
10398     PL_reg_magic        = (MAGIC*)NULL;
10399     PL_reg_oldpos       = 0;
10400     PL_reg_oldcurpm     = (PMOP*)NULL;
10401     PL_reg_curpm        = (PMOP*)NULL;
10402     PL_reg_oldsaved     = Nullch;
10403     PL_reg_oldsavedlen  = 0;
10404     PL_reg_maxiter      = 0;
10405     PL_reg_leftiter     = 0;
10406     PL_reg_poscache     = Nullch;
10407     PL_reg_poscache_size= 0;
10408
10409     /* RE engine - function pointers */
10410     PL_regcompp         = proto_perl->Tregcompp;
10411     PL_regexecp         = proto_perl->Tregexecp;
10412     PL_regint_start     = proto_perl->Tregint_start;
10413     PL_regint_string    = proto_perl->Tregint_string;
10414     PL_regfree          = proto_perl->Tregfree;
10415
10416     PL_reginterp_cnt    = 0;
10417     PL_reg_starttry     = 0;
10418
10419     /* Pluggable optimizer */
10420     PL_peepp            = proto_perl->Tpeepp;
10421
10422     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10423         ptr_table_free(PL_ptr_table);
10424         PL_ptr_table = NULL;
10425     }
10426
10427     /* Call the ->CLONE method, if it exists, for each of the stashes
10428        identified by sv_dup() above.
10429     */
10430     while(av_len(param->stashes) != -1) {
10431         HV* stash = (HV*) av_shift(param->stashes);
10432         GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10433         if (cloner && GvCV(cloner)) {
10434             dSP;
10435             ENTER;
10436             SAVETMPS;
10437             PUSHMARK(SP);
10438            XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
10439             PUTBACK;
10440             call_sv((SV*)GvCV(cloner), G_DISCARD);
10441             FREETMPS;
10442             LEAVE;
10443         }
10444     }
10445
10446     SvREFCNT_dec(param->stashes);
10447
10448     return my_perl;
10449 }
10450
10451 #endif /* USE_ITHREADS */
10452
10453 /*
10454 =head1 Unicode Support
10455
10456 =for apidoc sv_recode_to_utf8
10457
10458 The encoding is assumed to be an Encode object, on entry the PV
10459 of the sv is assumed to be octets in that encoding, and the sv
10460 will be converted into Unicode (and UTF-8).
10461
10462 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10463 is not a reference, nothing is done to the sv.  If the encoding is not
10464 an C<Encode::XS> Encoding object, bad things will happen.
10465 (See F<lib/encoding.pm> and L<Encode>).
10466
10467 The PV of the sv is returned.
10468
10469 =cut */
10470
10471 char *
10472 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10473 {
10474      if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
10475           SV *uni;
10476           STRLEN len;
10477           char *s;
10478           dSP;
10479           ENTER;
10480           SAVETMPS;
10481           PUSHMARK(sp);
10482           EXTEND(SP, 3);
10483           XPUSHs(encoding);
10484           XPUSHs(sv);
10485           XPUSHs(&PL_sv_yes);
10486           PUTBACK;
10487           call_method("decode", G_SCALAR);
10488           SPAGAIN;
10489           uni = POPs;
10490           PUTBACK;
10491           s = SvPV(uni, len);
10492           if (s != SvPVX(sv)) {
10493                SvGROW(sv, len + 1);
10494                Move(s, SvPVX(sv), len, char);
10495                SvCUR_set(sv, len);
10496                SvPVX(sv)[len] = 0;      
10497           }
10498           FREETMPS;
10499           LEAVE;
10500           SvUTF8_on(sv);
10501      }
10502      return SvPVX(sv);
10503 }
10504
10505