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