This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: [perl #37897] sprintf of version objects
[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 = Nullav;
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     }
1919     if (SvTHINKFIRST(sv)) {
1920         if (SvROK(sv)) {
1921         return_rok:
1922             if (SvAMAGIC(sv)) {
1923                 SV * const tmpstr=AMG_CALLun(sv,numer);
1924                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1925                     return SvIV(tmpstr);
1926                 }
1927             }
1928             return PTR2IV(SvRV(sv));
1929         }
1930         if (SvIsCOW(sv)) {
1931             sv_force_normal_flags(sv, 0);
1932         }
1933         if (SvREADONLY(sv) && !SvOK(sv)) {
1934             if (ckWARN(WARN_UNINITIALIZED))
1935                 report_uninit(sv);
1936             return 0;
1937         }
1938     }
1939     if (!SvIOKp(sv)) {
1940         if (S_sv_2iuv_common(aTHX_ sv))
1941             return 0;
1942     }
1943     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1944         PTR2UV(sv),SvIVX(sv)));
1945     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1946 }
1947
1948 /*
1949 =for apidoc sv_2uv_flags
1950
1951 Return the unsigned integer value of an SV, doing any necessary string
1952 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
1953 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1954
1955 =cut
1956 */
1957
1958 UV
1959 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1960 {
1961     if (!sv)
1962         return 0;
1963     if (SvGMAGICAL(sv)) {
1964         if (flags & SV_GMAGIC)
1965             mg_get(sv);
1966         if (SvIOKp(sv))
1967             return SvUVX(sv);
1968         if (SvNOKp(sv))
1969             return U_V(SvNVX(sv));
1970         if (SvPOKp(sv) && SvLEN(sv)) {
1971             UV value;
1972             const int numtype
1973                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1974
1975             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1976                 == IS_NUMBER_IN_UV) {
1977                 /* It's definitely an integer */
1978                 if (!(numtype & IS_NUMBER_NEG))
1979                     return value;
1980             }
1981             if (!numtype) {
1982                 if (ckWARN(WARN_NUMERIC))
1983                     not_a_number(sv);
1984             }
1985             return U_V(Atof(SvPVX_const(sv)));
1986         }
1987         if (SvROK(sv)) {
1988             goto return_rok;
1989         }
1990         assert(SvTYPE(sv) >= SVt_PVMG);
1991         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
1992     }
1993     if (SvTHINKFIRST(sv)) {
1994         if (SvROK(sv)) {
1995         return_rok:
1996             if (SvAMAGIC(sv)) {
1997                 SV *const tmpstr = AMG_CALLun(sv,numer);
1998                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1999                     return SvUV(tmpstr);
2000                 }
2001             }
2002             return PTR2UV(SvRV(sv));
2003         }
2004         if (SvIsCOW(sv)) {
2005             sv_force_normal_flags(sv, 0);
2006         }
2007         if (SvREADONLY(sv) && !SvOK(sv)) {
2008             if (ckWARN(WARN_UNINITIALIZED))
2009                 report_uninit(sv);
2010             return 0;
2011         }
2012     }
2013     if (!SvIOKp(sv)) {
2014         if (S_sv_2iuv_common(aTHX_ sv))
2015             return 0;
2016     }
2017
2018     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2019                           PTR2UV(sv),SvUVX(sv)));
2020     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2021 }
2022
2023 /*
2024 =for apidoc sv_2nv
2025
2026 Return the num value of an SV, doing any necessary string or integer
2027 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2028 macros.
2029
2030 =cut
2031 */
2032
2033 NV
2034 Perl_sv_2nv(pTHX_ register SV *sv)
2035 {
2036     if (!sv)
2037         return 0.0;
2038     if (SvGMAGICAL(sv)) {
2039         mg_get(sv);
2040         if (SvNOKp(sv))
2041             return SvNVX(sv);
2042         if (SvPOKp(sv) && SvLEN(sv)) {
2043             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2044                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2045                 not_a_number(sv);
2046             return Atof(SvPVX_const(sv));
2047         }
2048         if (SvIOKp(sv)) {
2049             if (SvIsUV(sv))
2050                 return (NV)SvUVX(sv);
2051             else
2052                 return (NV)SvIVX(sv);
2053         }
2054         if (SvROK(sv)) {
2055             goto return_rok;
2056         }
2057         assert(SvTYPE(sv) >= SVt_PVMG);
2058         /* This falls through to the report_uninit near the end of the
2059            function. */
2060     } else if (SvTHINKFIRST(sv)) {
2061         if (SvROK(sv)) {
2062         return_rok:
2063             if (SvAMAGIC(sv)) {
2064                 SV *const tmpstr = AMG_CALLun(sv,numer);
2065                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2066                     return SvNV(tmpstr);
2067                 }
2068             }
2069             return PTR2NV(SvRV(sv));
2070         }
2071         if (SvIsCOW(sv)) {
2072             sv_force_normal_flags(sv, 0);
2073         }
2074         if (SvREADONLY(sv) && !SvOK(sv)) {
2075             if (ckWARN(WARN_UNINITIALIZED))
2076                 report_uninit(sv);
2077             return 0.0;
2078         }
2079     }
2080     if (SvTYPE(sv) < SVt_NV) {
2081         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2082         sv_upgrade(sv, SVt_NV);
2083 #ifdef USE_LONG_DOUBLE
2084         DEBUG_c({
2085             STORE_NUMERIC_LOCAL_SET_STANDARD();
2086             PerlIO_printf(Perl_debug_log,
2087                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2088                           PTR2UV(sv), SvNVX(sv));
2089             RESTORE_NUMERIC_LOCAL();
2090         });
2091 #else
2092         DEBUG_c({
2093             STORE_NUMERIC_LOCAL_SET_STANDARD();
2094             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2095                           PTR2UV(sv), SvNVX(sv));
2096             RESTORE_NUMERIC_LOCAL();
2097         });
2098 #endif
2099     }
2100     else if (SvTYPE(sv) < SVt_PVNV)
2101         sv_upgrade(sv, SVt_PVNV);
2102     if (SvNOKp(sv)) {
2103         return SvNVX(sv);
2104     }
2105     if (SvIOKp(sv)) {
2106         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2107 #ifdef NV_PRESERVES_UV
2108         SvNOK_on(sv);
2109 #else
2110         /* Only set the public NV OK flag if this NV preserves the IV  */
2111         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2112         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2113                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2114             SvNOK_on(sv);
2115         else
2116             SvNOKp_on(sv);
2117 #endif
2118     }
2119     else if (SvPOKp(sv) && SvLEN(sv)) {
2120         UV value;
2121         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2122         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2123             not_a_number(sv);
2124 #ifdef NV_PRESERVES_UV
2125         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2126             == IS_NUMBER_IN_UV) {
2127             /* It's definitely an integer */
2128             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2129         } else
2130             SvNV_set(sv, Atof(SvPVX_const(sv)));
2131         SvNOK_on(sv);
2132 #else
2133         SvNV_set(sv, Atof(SvPVX_const(sv)));
2134         /* Only set the public NV OK flag if this NV preserves the value in
2135            the PV at least as well as an IV/UV would.
2136            Not sure how to do this 100% reliably. */
2137         /* if that shift count is out of range then Configure's test is
2138            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2139            UV_BITS */
2140         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2141             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2142             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2143         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2144             /* Can't use strtol etc to convert this string, so don't try.
2145                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2146             SvNOK_on(sv);
2147         } else {
2148             /* value has been set.  It may not be precise.  */
2149             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2150                 /* 2s complement assumption for (UV)IV_MIN  */
2151                 SvNOK_on(sv); /* Integer is too negative.  */
2152             } else {
2153                 SvNOKp_on(sv);
2154                 SvIOKp_on(sv);
2155
2156                 if (numtype & IS_NUMBER_NEG) {
2157                     SvIV_set(sv, -(IV)value);
2158                 } else if (value <= (UV)IV_MAX) {
2159                     SvIV_set(sv, (IV)value);
2160                 } else {
2161                     SvUV_set(sv, value);
2162                     SvIsUV_on(sv);
2163                 }
2164
2165                 if (numtype & IS_NUMBER_NOT_INT) {
2166                     /* I believe that even if the original PV had decimals,
2167                        they are lost beyond the limit of the FP precision.
2168                        However, neither is canonical, so both only get p
2169                        flags.  NWC, 2000/11/25 */
2170                     /* Both already have p flags, so do nothing */
2171                 } else {
2172                     const NV nv = SvNVX(sv);
2173                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2174                         if (SvIVX(sv) == I_V(nv)) {
2175                             SvNOK_on(sv);
2176                         } else {
2177                             /* It had no "." so it must be integer.  */
2178                         }
2179                         SvIOK_on(sv);
2180                     } else {
2181                         /* between IV_MAX and NV(UV_MAX).
2182                            Could be slightly > UV_MAX */
2183
2184                         if (numtype & IS_NUMBER_NOT_INT) {
2185                             /* UV and NV both imprecise.  */
2186                         } else {
2187                             const UV nv_as_uv = U_V(nv);
2188
2189                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2190                                 SvNOK_on(sv);
2191                             }
2192                             SvIOK_on(sv);
2193                         }
2194                     }
2195                 }
2196             }
2197         }
2198 #endif /* NV_PRESERVES_UV */
2199     }
2200     else  {
2201         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2202             report_uninit(sv);
2203         assert (SvTYPE(sv) >= SVt_NV);
2204         /* Typically the caller expects that sv_any is not NULL now.  */
2205         /* XXX Ilya implies that this is a bug in callers that assume this
2206            and ideally should be fixed.  */
2207         return 0.0;
2208     }
2209 #if defined(USE_LONG_DOUBLE)
2210     DEBUG_c({
2211         STORE_NUMERIC_LOCAL_SET_STANDARD();
2212         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2213                       PTR2UV(sv), SvNVX(sv));
2214         RESTORE_NUMERIC_LOCAL();
2215     });
2216 #else
2217     DEBUG_c({
2218         STORE_NUMERIC_LOCAL_SET_STANDARD();
2219         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2220                       PTR2UV(sv), SvNVX(sv));
2221         RESTORE_NUMERIC_LOCAL();
2222     });
2223 #endif
2224     return SvNVX(sv);
2225 }
2226
2227 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2228  * UV as a string towards the end of buf, and return pointers to start and
2229  * end of it.
2230  *
2231  * We assume that buf is at least TYPE_CHARS(UV) long.
2232  */
2233
2234 static char *
2235 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2236 {
2237     char *ptr = buf + TYPE_CHARS(UV);
2238     char * const ebuf = ptr;
2239     int sign;
2240
2241     if (is_uv)
2242         sign = 0;
2243     else if (iv >= 0) {
2244         uv = iv;
2245         sign = 0;
2246     } else {
2247         uv = -iv;
2248         sign = 1;
2249     }
2250     do {
2251         *--ptr = '0' + (char)(uv % 10);
2252     } while (uv /= 10);
2253     if (sign)
2254         *--ptr = '-';
2255     *peob = ebuf;
2256     return ptr;
2257 }
2258
2259 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2260  * a regexp to its stringified form.
2261  */
2262
2263 static char *
2264 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2265     const regexp * const re = (regexp *)mg->mg_obj;
2266
2267     if (!mg->mg_ptr) {
2268         const char *fptr = "msix";
2269         char reflags[6];
2270         char ch;
2271         int left = 0;
2272         int right = 4;
2273         bool need_newline = 0;
2274         U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2275
2276         while((ch = *fptr++)) {
2277             if(reganch & 1) {
2278                 reflags[left++] = ch;
2279             }
2280             else {
2281                 reflags[right--] = ch;
2282             }
2283             reganch >>= 1;
2284         }
2285         if(left != 4) {
2286             reflags[left] = '-';
2287             left = 5;
2288         }
2289
2290         mg->mg_len = re->prelen + 4 + left;
2291         /*
2292          * If /x was used, we have to worry about a regex ending with a
2293          * comment later being embedded within another regex. If so, we don't
2294          * want this regex's "commentization" to leak out to the right part of
2295          * the enclosing regex, we must cap it with a newline.
2296          *
2297          * So, if /x was used, we scan backwards from the end of the regex. If
2298          * we find a '#' before we find a newline, we need to add a newline
2299          * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2300          * we don't need to add anything.  -jfriedl
2301          */
2302         if (PMf_EXTENDED & re->reganch) {
2303             const char *endptr = re->precomp + re->prelen;
2304             while (endptr >= re->precomp) {
2305                 const char c = *(endptr--);
2306                 if (c == '\n')
2307                     break; /* don't need another */
2308                 if (c == '#') {
2309                     /* we end while in a comment, so we need a newline */
2310                     mg->mg_len++; /* save space for it */
2311                     need_newline = 1; /* note to add it */
2312                     break;
2313                 }
2314             }
2315         }
2316
2317         Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2318         mg->mg_ptr[0] = '(';
2319         mg->mg_ptr[1] = '?';
2320         Copy(reflags, mg->mg_ptr+2, left, char);
2321         *(mg->mg_ptr+left+2) = ':';
2322         Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2323         if (need_newline)
2324             mg->mg_ptr[mg->mg_len - 2] = '\n';
2325         mg->mg_ptr[mg->mg_len - 1] = ')';
2326         mg->mg_ptr[mg->mg_len] = 0;
2327     }
2328     PL_reginterp_cnt += re->program[0].next_off;
2329     
2330     if (re->reganch & ROPT_UTF8)
2331         SvUTF8_on(sv);
2332     else
2333         SvUTF8_off(sv);
2334     if (lp)
2335         *lp = mg->mg_len;
2336     return mg->mg_ptr;
2337 }
2338
2339 /*
2340 =for apidoc sv_2pv_flags
2341
2342 Returns a pointer to the string value of an SV, and sets *lp to its length.
2343 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2344 if necessary.
2345 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2346 usually end up here too.
2347
2348 =cut
2349 */
2350
2351 char *
2352 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2353 {
2354     register char *s;
2355     int olderrno;
2356
2357     if (!sv) {
2358         if (lp)
2359             *lp = 0;
2360         return (char *)"";
2361     }
2362     if (SvGMAGICAL(sv)) {
2363         if (flags & SV_GMAGIC)
2364             mg_get(sv);
2365         if (SvPOKp(sv)) {
2366             if (lp)
2367                 *lp = SvCUR(sv);
2368             if (flags & SV_MUTABLE_RETURN)
2369                 return SvPVX_mutable(sv);
2370             if (flags & SV_CONST_RETURN)
2371                 return (char *)SvPVX_const(sv);
2372             return SvPVX(sv);
2373         }
2374         if (SvIOKp(sv) || SvNOKp(sv)) {
2375             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2376             STRLEN len;
2377
2378             if (SvIOKp(sv)) {
2379                 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2380                     : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2381             } else {
2382                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2383                 len = strlen(tbuf);
2384             }
2385             if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
2386                 /* Sneaky stuff here */
2387                 SV * const tsv = newSVpvn(tbuf, len);
2388
2389                 sv_2mortal(tsv);
2390                 if (lp)
2391                     *lp = SvCUR(tsv);
2392                 return SvPVX(tsv);
2393             }
2394             else {
2395                 dVAR;
2396
2397 #ifdef FIXNEGATIVEZERO
2398                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2399                     tbuf[0] = '0';
2400                     tbuf[1] = 0;
2401                     len = 1;
2402                 }
2403 #endif
2404                 SvUPGRADE(sv, SVt_PV);
2405                 if (lp)
2406                     *lp = len;
2407                 s = SvGROW_mutable(sv, len + 1);
2408                 SvCUR_set(sv, len);
2409                 SvPOKp_on(sv);
2410                 return memcpy(s, tbuf, len + 1);
2411             }
2412         }
2413         if (SvROK(sv)) {
2414             goto return_rok;
2415         }
2416         assert(SvTYPE(sv) >= SVt_PVMG);
2417         /* This falls through to the report_uninit near the end of the
2418            function. */
2419     } else if (SvTHINKFIRST(sv)) {
2420         if (SvROK(sv)) {
2421         return_rok:
2422             if (SvAMAGIC(sv)) {
2423                 SV *const tmpstr = AMG_CALLun(sv,string);
2424                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2425                     /* Unwrap this:  */
2426                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2427                      */
2428
2429                     char *pv;
2430                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2431                         if (flags & SV_CONST_RETURN) {
2432                             pv = (char *) SvPVX_const(tmpstr);
2433                         } else {
2434                             pv = (flags & SV_MUTABLE_RETURN)
2435                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2436                         }
2437                         if (lp)
2438                             *lp = SvCUR(tmpstr);
2439                     } else {
2440                         pv = sv_2pv_flags(tmpstr, lp, flags);
2441                     }
2442                     if (SvUTF8(tmpstr))
2443                         SvUTF8_on(sv);
2444                     else
2445                         SvUTF8_off(sv);
2446                     return pv;
2447                 }
2448             }
2449             {
2450                 SV *tsv;
2451                 MAGIC *mg;
2452                 const SV *const referent = (SV*)SvRV(sv);
2453
2454                 if (!referent) {
2455                     tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2456                 } else if (SvTYPE(referent) == SVt_PVMG
2457                            && ((SvFLAGS(referent) &
2458                                 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2459                                == (SVs_OBJECT|SVs_SMG))
2460                            && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2461                     return S_stringify_regexp(aTHX_ sv, mg, lp);
2462                 } else {
2463                     const char *const typestr = sv_reftype(referent, 0);
2464
2465                     tsv = sv_newmortal();
2466                     if (SvOBJECT(referent)) {
2467                         const char *const name = HvNAME_get(SvSTASH(referent));
2468                         Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2469                                        name ? name : "__ANON__" , typestr,
2470                                        PTR2UV(referent));
2471                     }
2472                     else
2473                         Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2474                                        PTR2UV(referent));
2475                 }
2476                 if (lp)
2477                     *lp = SvCUR(tsv);
2478                 return SvPVX(tsv);
2479             }
2480         }
2481         if (SvREADONLY(sv) && !SvOK(sv)) {
2482             if (ckWARN(WARN_UNINITIALIZED))
2483                 report_uninit(sv);
2484             if (lp)
2485                 *lp = 0;
2486             return (char *)"";
2487         }
2488     }
2489     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2490         /* I'm assuming that if both IV and NV are equally valid then
2491            converting the IV is going to be more efficient */
2492         const U32 isIOK = SvIOK(sv);
2493         const U32 isUIOK = SvIsUV(sv);
2494         char buf[TYPE_CHARS(UV)];
2495         char *ebuf, *ptr;
2496
2497         if (SvTYPE(sv) < SVt_PVIV)
2498             sv_upgrade(sv, SVt_PVIV);
2499         if (isUIOK)
2500             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2501         else
2502             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2503         /* inlined from sv_setpvn */
2504         SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2505         Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2506         SvCUR_set(sv, ebuf - ptr);
2507         s = SvEND(sv);
2508         *s = '\0';
2509         if (isIOK)
2510             SvIOK_on(sv);
2511         else
2512             SvIOKp_on(sv);
2513         if (isUIOK)
2514             SvIsUV_on(sv);
2515     }
2516     else if (SvNOKp(sv)) {
2517         if (SvTYPE(sv) < SVt_PVNV)
2518             sv_upgrade(sv, SVt_PVNV);
2519         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2520         s = SvGROW_mutable(sv, NV_DIG + 20);
2521         olderrno = errno;       /* some Xenix systems wipe out errno here */
2522 #ifdef apollo
2523         if (SvNVX(sv) == 0.0)
2524             (void)strcpy(s,"0");
2525         else
2526 #endif /*apollo*/
2527         {
2528             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2529         }
2530         errno = olderrno;
2531 #ifdef FIXNEGATIVEZERO
2532         if (*s == '-' && s[1] == '0' && !s[2])
2533             strcpy(s,"0");
2534 #endif
2535         while (*s) s++;
2536 #ifdef hcx
2537         if (s[-1] == '.')
2538             *--s = '\0';
2539 #endif
2540     }
2541     else {
2542         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2543             report_uninit(sv);
2544         if (lp)
2545             *lp = 0;
2546         if (SvTYPE(sv) < SVt_PV)
2547             /* Typically the caller expects that sv_any is not NULL now.  */
2548             sv_upgrade(sv, SVt_PV);
2549         return (char *)"";
2550     }
2551     {
2552         const STRLEN len = s - SvPVX_const(sv);
2553         if (lp) 
2554             *lp = len;
2555         SvCUR_set(sv, len);
2556     }
2557     SvPOK_on(sv);
2558     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2559                           PTR2UV(sv),SvPVX_const(sv)));
2560     if (flags & SV_CONST_RETURN)
2561         return (char *)SvPVX_const(sv);
2562     if (flags & SV_MUTABLE_RETURN)
2563         return SvPVX_mutable(sv);
2564     return SvPVX(sv);
2565 }
2566
2567 /*
2568 =for apidoc sv_copypv
2569
2570 Copies a stringified representation of the source SV into the
2571 destination SV.  Automatically performs any necessary mg_get and
2572 coercion of numeric values into strings.  Guaranteed to preserve
2573 UTF-8 flag even from overloaded objects.  Similar in nature to
2574 sv_2pv[_flags] but operates directly on an SV instead of just the
2575 string.  Mostly uses sv_2pv_flags to do its work, except when that
2576 would lose the UTF-8'ness of the PV.
2577
2578 =cut
2579 */
2580
2581 void
2582 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2583 {
2584     STRLEN len;
2585     const char * const s = SvPV_const(ssv,len);
2586     sv_setpvn(dsv,s,len);
2587     if (SvUTF8(ssv))
2588         SvUTF8_on(dsv);
2589     else
2590         SvUTF8_off(dsv);
2591 }
2592
2593 /*
2594 =for apidoc sv_2pvbyte
2595
2596 Return a pointer to the byte-encoded representation of the SV, and set *lp
2597 to its length.  May cause the SV to be downgraded from UTF-8 as a
2598 side-effect.
2599
2600 Usually accessed via the C<SvPVbyte> macro.
2601
2602 =cut
2603 */
2604
2605 char *
2606 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2607 {
2608     sv_utf8_downgrade(sv,0);
2609     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2610 }
2611
2612 /*
2613 =for apidoc sv_2pvutf8
2614
2615 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2616 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2617
2618 Usually accessed via the C<SvPVutf8> macro.
2619
2620 =cut
2621 */
2622
2623 char *
2624 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2625 {
2626     sv_utf8_upgrade(sv);
2627     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2628 }
2629
2630
2631 /*
2632 =for apidoc sv_2bool
2633
2634 This function is only called on magical items, and is only used by
2635 sv_true() or its macro equivalent.
2636
2637 =cut
2638 */
2639
2640 bool
2641 Perl_sv_2bool(pTHX_ register SV *sv)
2642 {
2643     SvGETMAGIC(sv);
2644
2645     if (!SvOK(sv))
2646         return 0;
2647     if (SvROK(sv)) {
2648         SV* tmpsv;
2649         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2650                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2651             return (bool)SvTRUE(tmpsv);
2652       return SvRV(sv) != 0;
2653     }
2654     if (SvPOKp(sv)) {
2655         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2656         if (Xpvtmp &&
2657                 (*sv->sv_u.svu_pv > '0' ||
2658                 Xpvtmp->xpv_cur > 1 ||
2659                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2660             return 1;
2661         else
2662             return 0;
2663     }
2664     else {
2665         if (SvIOKp(sv))
2666             return SvIVX(sv) != 0;
2667         else {
2668             if (SvNOKp(sv))
2669                 return SvNVX(sv) != 0.0;
2670             else
2671                 return FALSE;
2672         }
2673     }
2674 }
2675
2676 /*
2677 =for apidoc sv_utf8_upgrade
2678
2679 Converts the PV of an SV to its UTF-8-encoded form.
2680 Forces the SV to string form if it is not already.
2681 Always sets the SvUTF8 flag to avoid future validity checks even
2682 if all the bytes have hibit clear.
2683
2684 This is not as a general purpose byte encoding to Unicode interface:
2685 use the Encode extension for that.
2686
2687 =for apidoc sv_utf8_upgrade_flags
2688
2689 Converts the PV of an SV to its UTF-8-encoded form.
2690 Forces the SV to string form if it is not already.
2691 Always sets the SvUTF8 flag to avoid future validity checks even
2692 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2693 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2694 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2695
2696 This is not as a general purpose byte encoding to Unicode interface:
2697 use the Encode extension for that.
2698
2699 =cut
2700 */
2701
2702 STRLEN
2703 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2704 {
2705     if (sv == &PL_sv_undef)
2706         return 0;
2707     if (!SvPOK(sv)) {
2708         STRLEN len = 0;
2709         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2710             (void) sv_2pv_flags(sv,&len, flags);
2711             if (SvUTF8(sv))
2712                 return len;
2713         } else {
2714             (void) SvPV_force(sv,len);
2715         }
2716     }
2717
2718     if (SvUTF8(sv)) {
2719         return SvCUR(sv);
2720     }
2721
2722     if (SvIsCOW(sv)) {
2723         sv_force_normal_flags(sv, 0);
2724     }
2725
2726     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2727         sv_recode_to_utf8(sv, PL_encoding);
2728     else { /* Assume Latin-1/EBCDIC */
2729         /* This function could be much more efficient if we
2730          * had a FLAG in SVs to signal if there are any hibit
2731          * chars in the PV.  Given that there isn't such a flag
2732          * make the loop as fast as possible. */
2733         const U8 * const s = (U8 *) SvPVX_const(sv);
2734         const U8 * const e = (U8 *) SvEND(sv);
2735         const U8 *t = s;
2736         
2737         while (t < e) {
2738             const U8 ch = *t++;
2739             /* Check for hi bit */
2740             if (!NATIVE_IS_INVARIANT(ch)) {
2741                 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2742                 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2743
2744                 SvPV_free(sv); /* No longer using what was there before. */
2745                 SvPV_set(sv, (char*)recoded);
2746                 SvCUR_set(sv, len - 1);
2747                 SvLEN_set(sv, len); /* No longer know the real size. */
2748                 break;
2749             }
2750         }
2751         /* Mark as UTF-8 even if no hibit - saves scanning loop */
2752         SvUTF8_on(sv);
2753     }
2754     return SvCUR(sv);
2755 }
2756
2757 /*
2758 =for apidoc sv_utf8_downgrade
2759
2760 Attempts to convert the PV of an SV from characters to bytes.
2761 If the PV contains a character beyond byte, this conversion will fail;
2762 in this case, either returns false or, if C<fail_ok> is not
2763 true, croaks.
2764
2765 This is not as a general purpose Unicode to byte encoding interface:
2766 use the Encode extension for that.
2767
2768 =cut
2769 */
2770
2771 bool
2772 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2773 {
2774     if (SvPOKp(sv) && SvUTF8(sv)) {
2775         if (SvCUR(sv)) {
2776             U8 *s;
2777             STRLEN len;
2778
2779             if (SvIsCOW(sv)) {
2780                 sv_force_normal_flags(sv, 0);
2781             }
2782             s = (U8 *) SvPV(sv, len);
2783             if (!utf8_to_bytes(s, &len)) {
2784                 if (fail_ok)
2785                     return FALSE;
2786                 else {
2787                     if (PL_op)
2788                         Perl_croak(aTHX_ "Wide character in %s",
2789                                    OP_DESC(PL_op));
2790                     else
2791                         Perl_croak(aTHX_ "Wide character");
2792                 }
2793             }
2794             SvCUR_set(sv, len);
2795         }
2796     }
2797     SvUTF8_off(sv);
2798     return TRUE;
2799 }
2800
2801 /*
2802 =for apidoc sv_utf8_encode
2803
2804 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2805 flag off so that it looks like octets again.
2806
2807 =cut
2808 */
2809
2810 void
2811 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2812 {
2813     (void) sv_utf8_upgrade(sv);
2814     if (SvIsCOW(sv)) {
2815         sv_force_normal_flags(sv, 0);
2816     }
2817     if (SvREADONLY(sv)) {
2818         Perl_croak(aTHX_ PL_no_modify);
2819     }
2820     SvUTF8_off(sv);
2821 }
2822
2823 /*
2824 =for apidoc sv_utf8_decode
2825
2826 If the PV of the SV is an octet sequence in UTF-8
2827 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2828 so that it looks like a character. If the PV contains only single-byte
2829 characters, the C<SvUTF8> flag stays being off.
2830 Scans PV for validity and returns false if the PV is invalid UTF-8.
2831
2832 =cut
2833 */
2834
2835 bool
2836 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2837 {
2838     if (SvPOKp(sv)) {
2839         const U8 *c;
2840         const U8 *e;
2841
2842         /* The octets may have got themselves encoded - get them back as
2843          * bytes
2844          */
2845         if (!sv_utf8_downgrade(sv, TRUE))
2846             return FALSE;
2847
2848         /* it is actually just a matter of turning the utf8 flag on, but
2849          * we want to make sure everything inside is valid utf8 first.
2850          */
2851         c = (const U8 *) SvPVX_const(sv);
2852         if (!is_utf8_string(c, SvCUR(sv)+1))
2853             return FALSE;
2854         e = (const U8 *) SvEND(sv);
2855         while (c < e) {
2856             const U8 ch = *c++;
2857             if (!UTF8_IS_INVARIANT(ch)) {
2858                 SvUTF8_on(sv);
2859                 break;
2860             }
2861         }
2862     }
2863     return TRUE;
2864 }
2865
2866 /*
2867 =for apidoc sv_setsv
2868
2869 Copies the contents of the source SV C<ssv> into the destination SV
2870 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
2871 function if the source SV needs to be reused. Does not handle 'set' magic.
2872 Loosely speaking, it performs a copy-by-value, obliterating any previous
2873 content of the destination.
2874
2875 You probably want to use one of the assortment of wrappers, such as
2876 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2877 C<SvSetMagicSV_nosteal>.
2878
2879 =for apidoc sv_setsv_flags
2880
2881 Copies the contents of the source SV C<ssv> into the destination SV
2882 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
2883 function if the source SV needs to be reused. Does not handle 'set' magic.
2884 Loosely speaking, it performs a copy-by-value, obliterating any previous
2885 content of the destination.
2886 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2887 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2888 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2889 and C<sv_setsv_nomg> are implemented in terms of this function.
2890
2891 You probably want to use one of the assortment of wrappers, such as
2892 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2893 C<SvSetMagicSV_nosteal>.
2894
2895 This is the primary function for copying scalars, and most other
2896 copy-ish functions and macros use this underneath.
2897
2898 =cut
2899 */
2900
2901 void
2902 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2903 {
2904     register U32 sflags;
2905     register int dtype;
2906     register int stype;
2907
2908     if (sstr == dstr)
2909         return;
2910     SV_CHECK_THINKFIRST_COW_DROP(dstr);
2911     if (!sstr)
2912         sstr = &PL_sv_undef;
2913     stype = SvTYPE(sstr);
2914     dtype = SvTYPE(dstr);
2915
2916     SvAMAGIC_off(dstr);
2917     if ( SvVOK(dstr) )
2918     {
2919         /* need to nuke the magic */
2920         mg_free(dstr);
2921         SvRMAGICAL_off(dstr);
2922     }
2923
2924     /* There's a lot of redundancy below but we're going for speed here */
2925
2926     switch (stype) {
2927     case SVt_NULL:
2928       undef_sstr:
2929         if (dtype != SVt_PVGV) {
2930             (void)SvOK_off(dstr);
2931             return;
2932         }
2933         break;
2934     case SVt_IV:
2935         if (SvIOK(sstr)) {
2936             switch (dtype) {
2937             case SVt_NULL:
2938                 sv_upgrade(dstr, SVt_IV);
2939                 break;
2940             case SVt_NV:
2941                 sv_upgrade(dstr, SVt_PVNV);
2942                 break;
2943             case SVt_RV:
2944             case SVt_PV:
2945                 sv_upgrade(dstr, SVt_PVIV);
2946                 break;
2947             }
2948             (void)SvIOK_only(dstr);
2949             SvIV_set(dstr,  SvIVX(sstr));
2950             if (SvIsUV(sstr))
2951                 SvIsUV_on(dstr);
2952             if (SvTAINTED(sstr))
2953                 SvTAINT(dstr);
2954             return;
2955         }
2956         goto undef_sstr;
2957
2958     case SVt_NV:
2959         if (SvNOK(sstr)) {
2960             switch (dtype) {
2961             case SVt_NULL:
2962             case SVt_IV:
2963                 sv_upgrade(dstr, SVt_NV);
2964                 break;
2965             case SVt_RV:
2966             case SVt_PV:
2967             case SVt_PVIV:
2968                 sv_upgrade(dstr, SVt_PVNV);
2969                 break;
2970             }
2971             SvNV_set(dstr, SvNVX(sstr));
2972             (void)SvNOK_only(dstr);
2973             if (SvTAINTED(sstr))
2974                 SvTAINT(dstr);
2975             return;
2976         }
2977         goto undef_sstr;
2978
2979     case SVt_RV:
2980         if (dtype < SVt_RV)
2981             sv_upgrade(dstr, SVt_RV);
2982         else if (dtype == SVt_PVGV &&
2983                  SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2984             sstr = SvRV(sstr);
2985             if (sstr == dstr) {
2986                 if (GvIMPORTED(dstr) != GVf_IMPORTED
2987                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2988                 {
2989                     GvIMPORTED_on(dstr);
2990                 }
2991                 GvMULTI_on(dstr);
2992                 return;
2993             }
2994             goto glob_assign;
2995         }
2996         break;
2997     case SVt_PVFM:
2998 #ifdef PERL_OLD_COPY_ON_WRITE
2999         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3000             if (dtype < SVt_PVIV)
3001                 sv_upgrade(dstr, SVt_PVIV);
3002             break;
3003         }
3004         /* Fall through */
3005 #endif
3006     case SVt_PV:
3007         if (dtype < SVt_PV)
3008             sv_upgrade(dstr, SVt_PV);
3009         break;
3010     case SVt_PVIV:
3011         if (dtype < SVt_PVIV)
3012             sv_upgrade(dstr, SVt_PVIV);
3013         break;
3014     case SVt_PVNV:
3015         if (dtype < SVt_PVNV)
3016             sv_upgrade(dstr, SVt_PVNV);
3017         break;
3018     case SVt_PVAV:
3019     case SVt_PVHV:
3020     case SVt_PVCV:
3021     case SVt_PVIO:
3022         {
3023         const char * const type = sv_reftype(sstr,0);
3024         if (PL_op)
3025             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3026         else
3027             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3028         }
3029         break;
3030
3031     case SVt_PVGV:
3032         if (dtype <= SVt_PVGV) {
3033   glob_assign:
3034             if (dtype != SVt_PVGV) {
3035                 const char * const name = GvNAME(sstr);
3036                 const STRLEN len = GvNAMELEN(sstr);
3037                 /* don't upgrade SVt_PVLV: it can hold a glob */
3038                 if (dtype != SVt_PVLV)
3039                     sv_upgrade(dstr, SVt_PVGV);
3040                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3041                 GvSTASH(dstr) = GvSTASH(sstr);
3042                 if (GvSTASH(dstr))
3043                     Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3044                 GvNAME(dstr) = savepvn(name, len);
3045                 GvNAMELEN(dstr) = len;
3046                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3047             }
3048
3049 #ifdef GV_UNIQUE_CHECK
3050                 if (GvUNIQUE((GV*)dstr)) {
3051                     Perl_croak(aTHX_ PL_no_modify);
3052                 }
3053 #endif
3054
3055             (void)SvOK_off(dstr);
3056             GvINTRO_off(dstr);          /* one-shot flag */
3057             gp_free((GV*)dstr);
3058             GvGP(dstr) = gp_ref(GvGP(sstr));
3059             if (SvTAINTED(sstr))
3060                 SvTAINT(dstr);
3061             if (GvIMPORTED(dstr) != GVf_IMPORTED
3062                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3063             {
3064                 GvIMPORTED_on(dstr);
3065             }
3066             GvMULTI_on(dstr);
3067             return;
3068         }
3069         /* FALL THROUGH */
3070
3071     default:
3072         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3073             mg_get(sstr);
3074             if ((int)SvTYPE(sstr) != stype) {
3075                 stype = SvTYPE(sstr);
3076                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3077                     goto glob_assign;
3078             }
3079         }
3080         if (stype == SVt_PVLV)
3081             SvUPGRADE(dstr, SVt_PVNV);
3082         else
3083             SvUPGRADE(dstr, (U32)stype);
3084     }
3085
3086     sflags = SvFLAGS(sstr);
3087
3088     if (sflags & SVf_ROK) {
3089         if (dtype >= SVt_PV) {
3090             if (dtype == SVt_PVGV) {
3091                 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3092                 SV *dref = 0;
3093                 const int intro = GvINTRO(dstr);
3094
3095 #ifdef GV_UNIQUE_CHECK
3096                 if (GvUNIQUE((GV*)dstr)) {
3097                     Perl_croak(aTHX_ PL_no_modify);
3098                 }
3099 #endif
3100
3101                 if (intro) {
3102                     GvINTRO_off(dstr);  /* one-shot flag */
3103                     GvLINE(dstr) = CopLINE(PL_curcop);
3104                     GvEGV(dstr) = (GV*)dstr;
3105                 }
3106                 GvMULTI_on(dstr);
3107                 switch (SvTYPE(sref)) {
3108                 case SVt_PVAV:
3109                     if (intro)
3110                         SAVEGENERICSV(GvAV(dstr));
3111                     else
3112                         dref = (SV*)GvAV(dstr);
3113                     GvAV(dstr) = (AV*)sref;
3114                     if (!GvIMPORTED_AV(dstr)
3115                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3116                     {
3117                         GvIMPORTED_AV_on(dstr);
3118                     }
3119                     break;
3120                 case SVt_PVHV:
3121                     if (intro)
3122                         SAVEGENERICSV(GvHV(dstr));
3123                     else
3124                         dref = (SV*)GvHV(dstr);
3125                     GvHV(dstr) = (HV*)sref;
3126                     if (!GvIMPORTED_HV(dstr)
3127                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3128                     {
3129                         GvIMPORTED_HV_on(dstr);
3130                     }
3131                     break;
3132                 case SVt_PVCV:
3133                     if (intro) {
3134                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3135                             SvREFCNT_dec(GvCV(dstr));
3136                             GvCV(dstr) = Nullcv;
3137                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3138                             PL_sub_generation++;
3139                         }
3140                         SAVEGENERICSV(GvCV(dstr));
3141                     }
3142                     else
3143                         dref = (SV*)GvCV(dstr);
3144                     if (GvCV(dstr) != (CV*)sref) {
3145                         CV* const cv = GvCV(dstr);
3146                         if (cv) {
3147                             if (!GvCVGEN((GV*)dstr) &&
3148                                 (CvROOT(cv) || CvXSUB(cv)))
3149                             {
3150                                 /* Redefining a sub - warning is mandatory if
3151                                    it was a const and its value changed. */
3152                                 if (ckWARN(WARN_REDEFINE)
3153                                     || (CvCONST(cv)
3154                                         && (!CvCONST((CV*)sref)
3155                                             || sv_cmp(cv_const_sv(cv),
3156                                                       cv_const_sv((CV*)sref)))))
3157                                 {
3158                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3159                                         CvCONST(cv)
3160                                         ? "Constant subroutine %s::%s redefined"
3161                                         : "Subroutine %s::%s redefined",
3162                                         HvNAME_get(GvSTASH((GV*)dstr)),
3163                                         GvENAME((GV*)dstr));
3164                                 }
3165                             }
3166                             if (!intro)
3167                                 cv_ckproto(cv, (GV*)dstr,
3168                                            SvPOK(sref)
3169                                            ? SvPVX_const(sref) : Nullch);
3170                         }
3171                         GvCV(dstr) = (CV*)sref;
3172                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3173                         GvASSUMECV_on(dstr);
3174                         PL_sub_generation++;
3175                     }
3176                     if (!GvIMPORTED_CV(dstr)
3177                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3178                     {
3179                         GvIMPORTED_CV_on(dstr);
3180                     }
3181                     break;
3182                 case SVt_PVIO:
3183                     if (intro)
3184                         SAVEGENERICSV(GvIOp(dstr));
3185                     else
3186                         dref = (SV*)GvIOp(dstr);
3187                     GvIOp(dstr) = (IO*)sref;
3188                     break;
3189                 case SVt_PVFM:
3190                     if (intro)
3191                         SAVEGENERICSV(GvFORM(dstr));
3192                     else
3193                         dref = (SV*)GvFORM(dstr);
3194                     GvFORM(dstr) = (CV*)sref;
3195                     break;
3196                 default:
3197                     if (intro)
3198                         SAVEGENERICSV(GvSV(dstr));
3199                     else
3200                         dref = (SV*)GvSV(dstr);
3201                     GvSV(dstr) = sref;
3202                     if (!GvIMPORTED_SV(dstr)
3203                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3204                     {
3205                         GvIMPORTED_SV_on(dstr);
3206                     }
3207                     break;
3208                 }
3209                 if (dref)
3210                     SvREFCNT_dec(dref);
3211                 if (SvTAINTED(sstr))
3212                     SvTAINT(dstr);
3213                 return;
3214             }
3215             if (SvPVX_const(dstr)) {
3216                 SvPV_free(dstr);
3217                 SvLEN_set(dstr, 0);
3218                 SvCUR_set(dstr, 0);
3219             }
3220         }
3221         (void)SvOK_off(dstr);
3222         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3223         SvROK_on(dstr);
3224         if (sflags & SVp_NOK) {
3225             SvNOKp_on(dstr);
3226             /* Only set the public OK flag if the source has public OK.  */
3227             if (sflags & SVf_NOK)
3228                 SvFLAGS(dstr) |= SVf_NOK;
3229             SvNV_set(dstr, SvNVX(sstr));
3230         }
3231         if (sflags & SVp_IOK) {
3232             (void)SvIOKp_on(dstr);
3233             if (sflags & SVf_IOK)
3234                 SvFLAGS(dstr) |= SVf_IOK;
3235             if (sflags & SVf_IVisUV)
3236                 SvIsUV_on(dstr);
3237             SvIV_set(dstr, SvIVX(sstr));
3238         }
3239         if (SvAMAGIC(sstr)) {
3240             SvAMAGIC_on(dstr);
3241         }
3242     }
3243     else if (sflags & SVp_POK) {
3244         bool isSwipe = 0;
3245
3246         /*
3247          * Check to see if we can just swipe the string.  If so, it's a
3248          * possible small lose on short strings, but a big win on long ones.
3249          * It might even be a win on short strings if SvPVX_const(dstr)
3250          * has to be allocated and SvPVX_const(sstr) has to be freed.
3251          */
3252
3253         /* Whichever path we take through the next code, we want this true,
3254            and doing it now facilitates the COW check.  */
3255         (void)SvPOK_only(dstr);
3256
3257         if (
3258             /* We're not already COW  */
3259             ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3260 #ifndef PERL_OLD_COPY_ON_WRITE
3261              /* or we are, but dstr isn't a suitable target.  */
3262              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3263 #endif
3264              )
3265             &&
3266             !(isSwipe =
3267                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3268                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3269                  (!(flags & SV_NOSTEAL)) &&
3270                                         /* and we're allowed to steal temps */
3271                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3272                  SvLEN(sstr)    &&        /* and really is a string */
3273                                 /* and won't be needed again, potentially */
3274               !(PL_op && PL_op->op_type == OP_AASSIGN))
3275 #ifdef PERL_OLD_COPY_ON_WRITE
3276             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3277                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3278                  && SvTYPE(sstr) >= SVt_PVIV)
3279 #endif
3280             ) {
3281             /* Failed the swipe test, and it's not a shared hash key either.
3282                Have to copy the string.  */
3283             STRLEN len = SvCUR(sstr);
3284             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3285             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3286             SvCUR_set(dstr, len);
3287             *SvEND(dstr) = '\0';
3288         } else {
3289             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3290                be true in here.  */
3291             /* Either it's a shared hash key, or it's suitable for
3292                copy-on-write or we can swipe the string.  */
3293             if (DEBUG_C_TEST) {
3294                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3295                 sv_dump(sstr);
3296                 sv_dump(dstr);
3297             }
3298 #ifdef PERL_OLD_COPY_ON_WRITE
3299             if (!isSwipe) {
3300                 /* I believe I should acquire a global SV mutex if
3301                    it's a COW sv (not a shared hash key) to stop
3302                    it going un copy-on-write.
3303                    If the source SV has gone un copy on write between up there
3304                    and down here, then (assert() that) it is of the correct
3305                    form to make it copy on write again */
3306                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3307                     != (SVf_FAKE | SVf_READONLY)) {
3308                     SvREADONLY_on(sstr);
3309                     SvFAKE_on(sstr);
3310                     /* Make the source SV into a loop of 1.
3311                        (about to become 2) */
3312                     SV_COW_NEXT_SV_SET(sstr, sstr);
3313                 }
3314             }
3315 #endif
3316             /* Initial code is common.  */
3317             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3318                 SvPV_free(dstr);
3319             }
3320
3321             if (!isSwipe) {
3322                 /* making another shared SV.  */
3323                 STRLEN cur = SvCUR(sstr);
3324                 STRLEN len = SvLEN(sstr);
3325 #ifdef PERL_OLD_COPY_ON_WRITE
3326                 if (len) {
3327                     assert (SvTYPE(dstr) >= SVt_PVIV);
3328                     /* SvIsCOW_normal */
3329                     /* splice us in between source and next-after-source.  */
3330                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3331                     SV_COW_NEXT_SV_SET(sstr, dstr);
3332                     SvPV_set(dstr, SvPVX_mutable(sstr));
3333                 } else
3334 #endif
3335                 {
3336                     /* SvIsCOW_shared_hash */
3337                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3338                                           "Copy on write: Sharing hash\n"));
3339
3340                     assert (SvTYPE(dstr) >= SVt_PV);
3341                     SvPV_set(dstr,
3342                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3343                 }
3344                 SvLEN_set(dstr, len);
3345                 SvCUR_set(dstr, cur);
3346                 SvREADONLY_on(dstr);
3347                 SvFAKE_on(dstr);
3348                 /* Relesase a global SV mutex.  */
3349             }
3350             else
3351                 {       /* Passes the swipe test.  */
3352                 SvPV_set(dstr, SvPVX_mutable(sstr));
3353                 SvLEN_set(dstr, SvLEN(sstr));
3354                 SvCUR_set(dstr, SvCUR(sstr));
3355
3356                 SvTEMP_off(dstr);
3357                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3358                 SvPV_set(sstr, Nullch);
3359                 SvLEN_set(sstr, 0);
3360                 SvCUR_set(sstr, 0);
3361                 SvTEMP_off(sstr);
3362             }
3363         }
3364         if (sflags & SVf_UTF8)
3365             SvUTF8_on(dstr);
3366         if (sflags & SVp_NOK) {
3367             SvNOKp_on(dstr);
3368             if (sflags & SVf_NOK)
3369                 SvFLAGS(dstr) |= SVf_NOK;
3370             SvNV_set(dstr, SvNVX(sstr));
3371         }
3372         if (sflags & SVp_IOK) {
3373             (void)SvIOKp_on(dstr);
3374             if (sflags & SVf_IOK)
3375                 SvFLAGS(dstr) |= SVf_IOK;
3376             if (sflags & SVf_IVisUV)
3377                 SvIsUV_on(dstr);
3378             SvIV_set(dstr, SvIVX(sstr));
3379         }
3380         if (SvVOK(sstr)) {
3381             const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3382             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3383                         smg->mg_ptr, smg->mg_len);
3384             SvRMAGICAL_on(dstr);
3385         }
3386     }
3387     else if (sflags & SVp_IOK) {
3388         if (sflags & SVf_IOK)
3389             (void)SvIOK_only(dstr);
3390         else {
3391             (void)SvOK_off(dstr);
3392             (void)SvIOKp_on(dstr);
3393         }
3394         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3395         if (sflags & SVf_IVisUV)
3396             SvIsUV_on(dstr);
3397         SvIV_set(dstr, SvIVX(sstr));
3398         if (sflags & SVp_NOK) {
3399             if (sflags & SVf_NOK)
3400                 (void)SvNOK_on(dstr);
3401             else
3402                 (void)SvNOKp_on(dstr);
3403             SvNV_set(dstr, SvNVX(sstr));
3404         }
3405     }
3406     else if (sflags & SVp_NOK) {
3407         if (sflags & SVf_NOK)
3408             (void)SvNOK_only(dstr);
3409         else {
3410             (void)SvOK_off(dstr);
3411             SvNOKp_on(dstr);
3412         }
3413         SvNV_set(dstr, SvNVX(sstr));
3414     }
3415     else {
3416         if (dtype == SVt_PVGV) {
3417             if (ckWARN(WARN_MISC))
3418                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3419         }
3420         else
3421             (void)SvOK_off(dstr);
3422     }
3423     if (SvTAINTED(sstr))
3424         SvTAINT(dstr);
3425 }
3426
3427 /*
3428 =for apidoc sv_setsv_mg
3429
3430 Like C<sv_setsv>, but also handles 'set' magic.
3431
3432 =cut
3433 */
3434
3435 void
3436 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3437 {
3438     sv_setsv(dstr,sstr);
3439     SvSETMAGIC(dstr);
3440 }
3441
3442 #ifdef PERL_OLD_COPY_ON_WRITE
3443 SV *
3444 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3445 {
3446     STRLEN cur = SvCUR(sstr);
3447     STRLEN len = SvLEN(sstr);
3448     register char *new_pv;
3449
3450     if (DEBUG_C_TEST) {
3451         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3452                       sstr, dstr);
3453         sv_dump(sstr);
3454         if (dstr)
3455                     sv_dump(dstr);
3456     }
3457
3458     if (dstr) {
3459         if (SvTHINKFIRST(dstr))
3460             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3461         else if (SvPVX_const(dstr))
3462             Safefree(SvPVX_const(dstr));
3463     }
3464     else
3465         new_SV(dstr);
3466     SvUPGRADE(dstr, SVt_PVIV);
3467
3468     assert (SvPOK(sstr));
3469     assert (SvPOKp(sstr));
3470     assert (!SvIOK(sstr));
3471     assert (!SvIOKp(sstr));
3472     assert (!SvNOK(sstr));
3473     assert (!SvNOKp(sstr));
3474
3475     if (SvIsCOW(sstr)) {
3476
3477         if (SvLEN(sstr) == 0) {
3478             /* source is a COW shared hash key.  */
3479             DEBUG_C(PerlIO_printf(Perl_debug_log,
3480                                   "Fast copy on write: Sharing hash\n"));
3481             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3482             goto common_exit;
3483         }
3484         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3485     } else {
3486         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3487         SvUPGRADE(sstr, SVt_PVIV);
3488         SvREADONLY_on(sstr);
3489         SvFAKE_on(sstr);
3490         DEBUG_C(PerlIO_printf(Perl_debug_log,
3491                               "Fast copy on write: Converting sstr to COW\n"));
3492         SV_COW_NEXT_SV_SET(dstr, sstr);
3493     }
3494     SV_COW_NEXT_SV_SET(sstr, dstr);
3495     new_pv = SvPVX_mutable(sstr);
3496
3497   common_exit:
3498     SvPV_set(dstr, new_pv);
3499     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3500     if (SvUTF8(sstr))
3501         SvUTF8_on(dstr);
3502     SvLEN_set(dstr, len);
3503     SvCUR_set(dstr, cur);
3504     if (DEBUG_C_TEST) {
3505         sv_dump(dstr);
3506     }
3507     return dstr;
3508 }
3509 #endif
3510
3511 /*
3512 =for apidoc sv_setpvn
3513
3514 Copies a string into an SV.  The C<len> parameter indicates the number of
3515 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3516 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3517
3518 =cut
3519 */
3520
3521 void
3522 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3523 {
3524     register char *dptr;
3525
3526     SV_CHECK_THINKFIRST_COW_DROP(sv);
3527     if (!ptr) {
3528         (void)SvOK_off(sv);
3529         return;
3530     }
3531     else {
3532         /* len is STRLEN which is unsigned, need to copy to signed */
3533         const IV iv = len;
3534         if (iv < 0)
3535             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3536     }
3537     SvUPGRADE(sv, SVt_PV);
3538
3539     dptr = SvGROW(sv, len + 1);
3540     Move(ptr,dptr,len,char);
3541     dptr[len] = '\0';
3542     SvCUR_set(sv, len);
3543     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3544     SvTAINT(sv);
3545 }
3546
3547 /*
3548 =for apidoc sv_setpvn_mg
3549
3550 Like C<sv_setpvn>, but also handles 'set' magic.
3551
3552 =cut
3553 */
3554
3555 void
3556 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3557 {
3558     sv_setpvn(sv,ptr,len);
3559     SvSETMAGIC(sv);
3560 }
3561
3562 /*
3563 =for apidoc sv_setpv
3564
3565 Copies a string into an SV.  The string must be null-terminated.  Does not
3566 handle 'set' magic.  See C<sv_setpv_mg>.
3567
3568 =cut
3569 */
3570
3571 void
3572 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3573 {
3574     register STRLEN len;
3575
3576     SV_CHECK_THINKFIRST_COW_DROP(sv);
3577     if (!ptr) {
3578         (void)SvOK_off(sv);
3579         return;
3580     }
3581     len = strlen(ptr);
3582     SvUPGRADE(sv, SVt_PV);
3583
3584     SvGROW(sv, len + 1);
3585     Move(ptr,SvPVX(sv),len+1,char);
3586     SvCUR_set(sv, len);
3587     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3588     SvTAINT(sv);
3589 }
3590
3591 /*
3592 =for apidoc sv_setpv_mg
3593
3594 Like C<sv_setpv>, but also handles 'set' magic.
3595
3596 =cut
3597 */
3598
3599 void
3600 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3601 {
3602     sv_setpv(sv,ptr);
3603     SvSETMAGIC(sv);
3604 }
3605
3606 /*
3607 =for apidoc sv_usepvn
3608
3609 Tells an SV to use C<ptr> to find its string value.  Normally the string is
3610 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3611 The C<ptr> should point to memory that was allocated by C<malloc>.  The
3612 string length, C<len>, must be supplied.  This function will realloc the
3613 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3614 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
3615 See C<sv_usepvn_mg>.
3616
3617 =cut
3618 */
3619
3620 void
3621 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3622 {
3623     STRLEN allocate;
3624     SV_CHECK_THINKFIRST_COW_DROP(sv);
3625     SvUPGRADE(sv, SVt_PV);
3626     if (!ptr) {
3627         (void)SvOK_off(sv);
3628         return;
3629     }
3630     if (SvPVX_const(sv))
3631         SvPV_free(sv);
3632
3633     allocate = PERL_STRLEN_ROUNDUP(len + 1);
3634     ptr = saferealloc (ptr, allocate);
3635     SvPV_set(sv, ptr);
3636     SvCUR_set(sv, len);
3637     SvLEN_set(sv, allocate);
3638     *SvEND(sv) = '\0';
3639     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3640     SvTAINT(sv);
3641 }
3642
3643 /*
3644 =for apidoc sv_usepvn_mg
3645
3646 Like C<sv_usepvn>, but also handles 'set' magic.
3647
3648 =cut
3649 */
3650
3651 void
3652 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3653 {
3654     sv_usepvn(sv,ptr,len);
3655     SvSETMAGIC(sv);
3656 }
3657
3658 #ifdef PERL_OLD_COPY_ON_WRITE
3659 /* Need to do this *after* making the SV normal, as we need the buffer
3660    pointer to remain valid until after we've copied it.  If we let go too early,
3661    another thread could invalidate it by unsharing last of the same hash key
3662    (which it can do by means other than releasing copy-on-write Svs)
3663    or by changing the other copy-on-write SVs in the loop.  */
3664 STATIC void
3665 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3666 {
3667     if (len) { /* this SV was SvIsCOW_normal(sv) */
3668          /* we need to find the SV pointing to us.  */
3669         SV * const current = SV_COW_NEXT_SV(after);
3670
3671         if (current == sv) {
3672             /* The SV we point to points back to us (there were only two of us
3673                in the loop.)
3674                Hence other SV is no longer copy on write either.  */
3675             SvFAKE_off(after);
3676             SvREADONLY_off(after);
3677         } else {
3678             /* We need to follow the pointers around the loop.  */
3679             SV *next;
3680             while ((next = SV_COW_NEXT_SV(current)) != sv) {
3681                 assert (next);
3682                 current = next;
3683                  /* don't loop forever if the structure is bust, and we have
3684                     a pointer into a closed loop.  */
3685                 assert (current != after);
3686                 assert (SvPVX_const(current) == pvx);
3687             }
3688             /* Make the SV before us point to the SV after us.  */
3689             SV_COW_NEXT_SV_SET(current, after);
3690         }
3691     } else {
3692         unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3693     }
3694 }
3695
3696 int
3697 Perl_sv_release_IVX(pTHX_ register SV *sv)
3698 {
3699     if (SvIsCOW(sv))
3700         sv_force_normal_flags(sv, 0);
3701     SvOOK_off(sv);
3702     return 0;
3703 }
3704 #endif
3705 /*
3706 =for apidoc sv_force_normal_flags
3707
3708 Undo various types of fakery on an SV: if the PV is a shared string, make
3709 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3710 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3711 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3712 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3713 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3714 set to some other value.) In addition, the C<flags> parameter gets passed to
3715 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3716 with flags set to 0.
3717
3718 =cut
3719 */
3720
3721 void
3722 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3723 {
3724 #ifdef PERL_OLD_COPY_ON_WRITE
3725     if (SvREADONLY(sv)) {
3726         /* At this point I believe I should acquire a global SV mutex.  */
3727         if (SvFAKE(sv)) {
3728             const char * const pvx = SvPVX_const(sv);
3729             const STRLEN len = SvLEN(sv);
3730             const STRLEN cur = SvCUR(sv);
3731             SV * const next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
3732             if (DEBUG_C_TEST) {
3733                 PerlIO_printf(Perl_debug_log,
3734                               "Copy on write: Force normal %ld\n",
3735                               (long) flags);
3736                 sv_dump(sv);
3737             }
3738             SvFAKE_off(sv);
3739             SvREADONLY_off(sv);
3740             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
3741             SvPV_set(sv, (char*)0);
3742             SvLEN_set(sv, 0);
3743             if (flags & SV_COW_DROP_PV) {
3744                 /* OK, so we don't need to copy our buffer.  */
3745                 SvPOK_off(sv);
3746             } else {
3747                 SvGROW(sv, cur + 1);
3748                 Move(pvx,SvPVX(sv),cur,char);
3749                 SvCUR_set(sv, cur);
3750                 *SvEND(sv) = '\0';
3751             }
3752             sv_release_COW(sv, pvx, len, next);
3753             if (DEBUG_C_TEST) {
3754                 sv_dump(sv);
3755             }
3756         }
3757         else if (IN_PERL_RUNTIME)
3758             Perl_croak(aTHX_ PL_no_modify);
3759         /* At this point I believe that I can drop the global SV mutex.  */
3760     }
3761 #else
3762     if (SvREADONLY(sv)) {
3763         if (SvFAKE(sv)) {
3764             const char * const pvx = SvPVX_const(sv);
3765             const STRLEN len = SvCUR(sv);
3766             SvFAKE_off(sv);
3767             SvREADONLY_off(sv);
3768             SvPV_set(sv, Nullch);
3769             SvLEN_set(sv, 0);
3770             SvGROW(sv, len + 1);
3771             Move(pvx,SvPVX(sv),len,char);
3772             *SvEND(sv) = '\0';
3773             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3774         }
3775         else if (IN_PERL_RUNTIME)
3776             Perl_croak(aTHX_ PL_no_modify);
3777     }
3778 #endif
3779     if (SvROK(sv))
3780         sv_unref_flags(sv, flags);
3781     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3782         sv_unglob(sv);
3783 }
3784
3785 /*
3786 =for apidoc sv_chop
3787
3788 Efficient removal of characters from the beginning of the string buffer.
3789 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3790 the string buffer.  The C<ptr> becomes the first character of the adjusted
3791 string. Uses the "OOK hack".
3792 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3793 refer to the same chunk of data.
3794
3795 =cut
3796 */
3797
3798 void
3799 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3800 {
3801     register STRLEN delta;
3802     if (!ptr || !SvPOKp(sv))
3803         return;
3804     delta = ptr - SvPVX_const(sv);
3805     SV_CHECK_THINKFIRST(sv);
3806     if (SvTYPE(sv) < SVt_PVIV)
3807         sv_upgrade(sv,SVt_PVIV);
3808
3809     if (!SvOOK(sv)) {
3810         if (!SvLEN(sv)) { /* make copy of shared string */
3811             const char *pvx = SvPVX_const(sv);
3812             const STRLEN len = SvCUR(sv);
3813             SvGROW(sv, len + 1);
3814             Move(pvx,SvPVX(sv),len,char);
3815             *SvEND(sv) = '\0';
3816         }
3817         SvIV_set(sv, 0);
3818         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3819            and we do that anyway inside the SvNIOK_off
3820         */
3821         SvFLAGS(sv) |= SVf_OOK;
3822     }
3823     SvNIOK_off(sv);
3824     SvLEN_set(sv, SvLEN(sv) - delta);
3825     SvCUR_set(sv, SvCUR(sv) - delta);
3826     SvPV_set(sv, SvPVX(sv) + delta);
3827     SvIV_set(sv, SvIVX(sv) + delta);
3828 }
3829
3830 /*
3831 =for apidoc sv_catpvn
3832
3833 Concatenates the string onto the end of the string which is in the SV.  The
3834 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
3835 status set, then the bytes appended should be valid UTF-8.
3836 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
3837
3838 =for apidoc sv_catpvn_flags
3839
3840 Concatenates the string onto the end of the string which is in the SV.  The
3841 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
3842 status set, then the bytes appended should be valid UTF-8.
3843 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3844 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3845 in terms of this function.
3846
3847 =cut
3848 */
3849
3850 void
3851 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3852 {
3853     STRLEN dlen;
3854     const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3855
3856     SvGROW(dsv, dlen + slen + 1);
3857     if (sstr == dstr)
3858         sstr = SvPVX_const(dsv);
3859     Move(sstr, SvPVX(dsv) + dlen, slen, char);
3860     SvCUR_set(dsv, SvCUR(dsv) + slen);
3861     *SvEND(dsv) = '\0';
3862     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
3863     SvTAINT(dsv);
3864     if (flags & SV_SMAGIC)
3865         SvSETMAGIC(dsv);
3866 }
3867
3868 /*
3869 =for apidoc sv_catsv
3870
3871 Concatenates the string from SV C<ssv> onto the end of the string in
3872 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
3873 not 'set' magic.  See C<sv_catsv_mg>.
3874
3875 =for apidoc sv_catsv_flags
3876
3877 Concatenates the string from SV C<ssv> onto the end of the string in
3878 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
3879 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3880 and C<sv_catsv_nomg> are implemented in terms of this function.
3881
3882 =cut */
3883
3884 void
3885 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3886 {
3887     if (ssv) {
3888         STRLEN slen;
3889         const char *spv = SvPV_const(ssv, slen);
3890         if (spv) {
3891             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3892                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3893                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3894                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
3895                 dsv->sv_flags doesn't have that bit set.
3896                 Andy Dougherty  12 Oct 2001
3897             */
3898             const I32 sutf8 = DO_UTF8(ssv);
3899             I32 dutf8;
3900
3901             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3902                 mg_get(dsv);
3903             dutf8 = DO_UTF8(dsv);
3904
3905             if (dutf8 != sutf8) {
3906                 if (dutf8) {
3907                     /* Not modifying source SV, so taking a temporary copy. */
3908                     SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3909
3910                     sv_utf8_upgrade(csv);
3911                     spv = SvPV_const(csv, slen);
3912                 }
3913                 else
3914                     sv_utf8_upgrade_nomg(dsv);
3915             }
3916             sv_catpvn_nomg(dsv, spv, slen);
3917         }
3918     }
3919     if (flags & SV_SMAGIC)
3920         SvSETMAGIC(dsv);
3921 }
3922
3923 /*
3924 =for apidoc sv_catpv
3925
3926 Concatenates the string onto the end of the string which is in the SV.
3927 If the SV has the UTF-8 status set, then the bytes appended should be
3928 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
3929
3930 =cut */
3931
3932 void
3933 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3934 {
3935     register STRLEN len;
3936     STRLEN tlen;
3937     char *junk;
3938
3939     if (!ptr)
3940         return;
3941     junk = SvPV_force(sv, tlen);
3942     len = strlen(ptr);
3943     SvGROW(sv, tlen + len + 1);
3944     if (ptr == junk)
3945         ptr = SvPVX_const(sv);
3946     Move(ptr,SvPVX(sv)+tlen,len+1,char);
3947     SvCUR_set(sv, SvCUR(sv) + len);
3948     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3949     SvTAINT(sv);
3950 }
3951
3952 /*
3953 =for apidoc sv_catpv_mg
3954
3955 Like C<sv_catpv>, but also handles 'set' magic.
3956
3957 =cut
3958 */
3959
3960 void
3961 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3962 {
3963     sv_catpv(sv,ptr);
3964     SvSETMAGIC(sv);
3965 }
3966
3967 /*
3968 =for apidoc newSV
3969
3970 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3971 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3972 macro.
3973
3974 =cut
3975 */
3976
3977 SV *
3978 Perl_newSV(pTHX_ STRLEN len)
3979 {
3980     register SV *sv;
3981
3982     new_SV(sv);
3983     if (len) {
3984         sv_upgrade(sv, SVt_PV);
3985         SvGROW(sv, len + 1);
3986     }
3987     return sv;
3988 }
3989 /*
3990 =for apidoc sv_magicext
3991
3992 Adds magic to an SV, upgrading it if necessary. Applies the
3993 supplied vtable and returns a pointer to the magic added.
3994
3995 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
3996 In particular, you can add magic to SvREADONLY SVs, and add more than
3997 one instance of the same 'how'.
3998
3999 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4000 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4001 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4002 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4003
4004 (This is now used as a subroutine by C<sv_magic>.)
4005
4006 =cut
4007 */
4008 MAGIC * 
4009 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4010                  const char* name, I32 namlen)
4011 {
4012     MAGIC* mg;
4013
4014     if (SvTYPE(sv) < SVt_PVMG) {
4015         SvUPGRADE(sv, SVt_PVMG);
4016     }
4017     Newxz(mg, 1, MAGIC);
4018     mg->mg_moremagic = SvMAGIC(sv);
4019     SvMAGIC_set(sv, mg);
4020
4021     /* Sometimes a magic contains a reference loop, where the sv and
4022        object refer to each other.  To prevent a reference loop that
4023        would prevent such objects being freed, we look for such loops
4024        and if we find one we avoid incrementing the object refcount.
4025
4026        Note we cannot do this to avoid self-tie loops as intervening RV must
4027        have its REFCNT incremented to keep it in existence.
4028
4029     */
4030     if (!obj || obj == sv ||
4031         how == PERL_MAGIC_arylen ||
4032         how == PERL_MAGIC_qr ||
4033         how == PERL_MAGIC_symtab ||
4034         (SvTYPE(obj) == SVt_PVGV &&
4035             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4036             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4037             GvFORM(obj) == (CV*)sv)))
4038     {
4039         mg->mg_obj = obj;
4040     }
4041     else {
4042         mg->mg_obj = SvREFCNT_inc(obj);
4043         mg->mg_flags |= MGf_REFCOUNTED;
4044     }
4045
4046     /* Normal self-ties simply pass a null object, and instead of
4047        using mg_obj directly, use the SvTIED_obj macro to produce a
4048        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4049        with an RV obj pointing to the glob containing the PVIO.  In
4050        this case, to avoid a reference loop, we need to weaken the
4051        reference.
4052     */
4053
4054     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4055         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4056     {
4057       sv_rvweaken(obj);
4058     }
4059
4060     mg->mg_type = how;
4061     mg->mg_len = namlen;
4062     if (name) {
4063         if (namlen > 0)
4064             mg->mg_ptr = savepvn(name, namlen);
4065         else if (namlen == HEf_SVKEY)
4066             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4067         else
4068             mg->mg_ptr = (char *) name;
4069     }
4070     mg->mg_virtual = vtable;
4071
4072     mg_magical(sv);
4073     if (SvGMAGICAL(sv))
4074         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4075     return mg;
4076 }
4077
4078 /*
4079 =for apidoc sv_magic
4080
4081 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4082 then adds a new magic item of type C<how> to the head of the magic list.
4083
4084 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4085 handling of the C<name> and C<namlen> arguments.
4086
4087 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4088 to add more than one instance of the same 'how'.
4089
4090 =cut
4091 */
4092
4093 void
4094 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4095 {
4096     const MGVTBL *vtable;
4097     MAGIC* mg;
4098
4099 #ifdef PERL_OLD_COPY_ON_WRITE
4100     if (SvIsCOW(sv))
4101         sv_force_normal_flags(sv, 0);
4102 #endif
4103     if (SvREADONLY(sv)) {
4104         if (
4105             /* its okay to attach magic to shared strings; the subsequent
4106              * upgrade to PVMG will unshare the string */
4107             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4108
4109             && IN_PERL_RUNTIME
4110             && how != PERL_MAGIC_regex_global
4111             && how != PERL_MAGIC_bm
4112             && how != PERL_MAGIC_fm
4113             && how != PERL_MAGIC_sv
4114             && how != PERL_MAGIC_backref
4115            )
4116         {
4117             Perl_croak(aTHX_ PL_no_modify);
4118         }
4119     }
4120     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4121         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4122             /* sv_magic() refuses to add a magic of the same 'how' as an
4123                existing one
4124              */
4125             if (how == PERL_MAGIC_taint)
4126                 mg->mg_len |= 1;
4127             return;
4128         }
4129     }
4130
4131     switch (how) {
4132     case PERL_MAGIC_sv:
4133         vtable = &PL_vtbl_sv;
4134         break;
4135     case PERL_MAGIC_overload:
4136         vtable = &PL_vtbl_amagic;
4137         break;
4138     case PERL_MAGIC_overload_elem:
4139         vtable = &PL_vtbl_amagicelem;
4140         break;
4141     case PERL_MAGIC_overload_table:
4142         vtable = &PL_vtbl_ovrld;
4143         break;
4144     case PERL_MAGIC_bm:
4145         vtable = &PL_vtbl_bm;
4146         break;
4147     case PERL_MAGIC_regdata:
4148         vtable = &PL_vtbl_regdata;
4149         break;
4150     case PERL_MAGIC_regdatum:
4151         vtable = &PL_vtbl_regdatum;
4152         break;
4153     case PERL_MAGIC_env:
4154         vtable = &PL_vtbl_env;
4155         break;
4156     case PERL_MAGIC_fm:
4157         vtable = &PL_vtbl_fm;
4158         break;
4159     case PERL_MAGIC_envelem:
4160         vtable = &PL_vtbl_envelem;
4161         break;
4162     case PERL_MAGIC_regex_global:
4163         vtable = &PL_vtbl_mglob;
4164         break;
4165     case PERL_MAGIC_isa:
4166         vtable = &PL_vtbl_isa;
4167         break;
4168     case PERL_MAGIC_isaelem:
4169         vtable = &PL_vtbl_isaelem;
4170         break;
4171     case PERL_MAGIC_nkeys:
4172         vtable = &PL_vtbl_nkeys;
4173         break;
4174     case PERL_MAGIC_dbfile:
4175         vtable = NULL;
4176         break;
4177     case PERL_MAGIC_dbline:
4178         vtable = &PL_vtbl_dbline;
4179         break;
4180 #ifdef USE_LOCALE_COLLATE
4181     case PERL_MAGIC_collxfrm:
4182         vtable = &PL_vtbl_collxfrm;
4183         break;
4184 #endif /* USE_LOCALE_COLLATE */
4185     case PERL_MAGIC_tied:
4186         vtable = &PL_vtbl_pack;
4187         break;
4188     case PERL_MAGIC_tiedelem:
4189     case PERL_MAGIC_tiedscalar:
4190         vtable = &PL_vtbl_packelem;
4191         break;
4192     case PERL_MAGIC_qr:
4193         vtable = &PL_vtbl_regexp;
4194         break;
4195     case PERL_MAGIC_sig:
4196         vtable = &PL_vtbl_sig;
4197         break;
4198     case PERL_MAGIC_sigelem:
4199         vtable = &PL_vtbl_sigelem;
4200         break;
4201     case PERL_MAGIC_taint:
4202         vtable = &PL_vtbl_taint;
4203         break;
4204     case PERL_MAGIC_uvar:
4205         vtable = &PL_vtbl_uvar;
4206         break;
4207     case PERL_MAGIC_vec:
4208         vtable = &PL_vtbl_vec;
4209         break;
4210     case PERL_MAGIC_arylen_p:
4211     case PERL_MAGIC_rhash:
4212     case PERL_MAGIC_symtab:
4213     case PERL_MAGIC_vstring:
4214         vtable = NULL;
4215         break;
4216     case PERL_MAGIC_utf8:
4217         vtable = &PL_vtbl_utf8;
4218         break;
4219     case PERL_MAGIC_substr:
4220         vtable = &PL_vtbl_substr;
4221         break;
4222     case PERL_MAGIC_defelem:
4223         vtable = &PL_vtbl_defelem;
4224         break;
4225     case PERL_MAGIC_glob:
4226         vtable = &PL_vtbl_glob;
4227         break;
4228     case PERL_MAGIC_arylen:
4229         vtable = &PL_vtbl_arylen;
4230         break;
4231     case PERL_MAGIC_pos:
4232         vtable = &PL_vtbl_pos;
4233         break;
4234     case PERL_MAGIC_backref:
4235         vtable = &PL_vtbl_backref;
4236         break;
4237     case PERL_MAGIC_ext:
4238         /* Reserved for use by extensions not perl internals.           */
4239         /* Useful for attaching extension internal data to perl vars.   */
4240         /* Note that multiple extensions may clash if magical scalars   */
4241         /* etc holding private data from one are passed to another.     */
4242         vtable = NULL;
4243         break;
4244     default:
4245         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4246     }
4247
4248     /* Rest of work is done else where */
4249     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4250
4251     switch (how) {
4252     case PERL_MAGIC_taint:
4253         mg->mg_len = 1;
4254         break;
4255     case PERL_MAGIC_ext:
4256     case PERL_MAGIC_dbfile:
4257         SvRMAGICAL_on(sv);
4258         break;
4259     }
4260 }
4261
4262 /*
4263 =for apidoc sv_unmagic
4264
4265 Removes all magic of type C<type> from an SV.
4266
4267 =cut
4268 */
4269
4270 int
4271 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4272 {
4273     MAGIC* mg;
4274     MAGIC** mgp;
4275     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4276         return 0;
4277     mgp = &SvMAGIC(sv);
4278     for (mg = *mgp; mg; mg = *mgp) {
4279         if (mg->mg_type == type) {
4280             const MGVTBL* const vtbl = mg->mg_virtual;
4281             *mgp = mg->mg_moremagic;
4282             if (vtbl && vtbl->svt_free)
4283                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4284             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4285                 if (mg->mg_len > 0)
4286                     Safefree(mg->mg_ptr);
4287                 else if (mg->mg_len == HEf_SVKEY)
4288                     SvREFCNT_dec((SV*)mg->mg_ptr);
4289                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4290                     Safefree(mg->mg_ptr);
4291             }
4292             if (mg->mg_flags & MGf_REFCOUNTED)
4293                 SvREFCNT_dec(mg->mg_obj);
4294             Safefree(mg);
4295         }
4296         else
4297             mgp = &mg->mg_moremagic;
4298     }
4299     if (!SvMAGIC(sv)) {
4300         SvMAGICAL_off(sv);
4301        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4302     }
4303
4304     return 0;
4305 }
4306
4307 /*
4308 =for apidoc sv_rvweaken
4309
4310 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4311 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4312 push a back-reference to this RV onto the array of backreferences
4313 associated with that magic.
4314
4315 =cut
4316 */
4317
4318 SV *
4319 Perl_sv_rvweaken(pTHX_ SV *sv)
4320 {
4321     SV *tsv;
4322     if (!SvOK(sv))  /* let undefs pass */
4323         return sv;
4324     if (!SvROK(sv))
4325         Perl_croak(aTHX_ "Can't weaken a nonreference");
4326     else if (SvWEAKREF(sv)) {
4327         if (ckWARN(WARN_MISC))
4328             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4329         return sv;
4330     }
4331     tsv = SvRV(sv);
4332     Perl_sv_add_backref(aTHX_ tsv, sv);
4333     SvWEAKREF_on(sv);
4334     SvREFCNT_dec(tsv);
4335     return sv;
4336 }
4337
4338 /* Give tsv backref magic if it hasn't already got it, then push a
4339  * back-reference to sv onto the array associated with the backref magic.
4340  */
4341
4342 void
4343 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4344 {
4345     AV *av;
4346     MAGIC *mg;
4347     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4348         av = (AV*)mg->mg_obj;
4349     else {
4350         av = newAV();
4351         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4352         /* av now has a refcnt of 2, which avoids it getting freed
4353          * before us during global cleanup. The extra ref is removed
4354          * by magic_killbackrefs() when tsv is being freed */
4355     }
4356     if (AvFILLp(av) >= AvMAX(av)) {
4357         av_extend(av, AvFILLp(av)+1);
4358     }
4359     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4360 }
4361
4362 /* delete a back-reference to ourselves from the backref magic associated
4363  * with the SV we point to.
4364  */
4365
4366 STATIC void
4367 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4368 {
4369     AV *av;
4370     SV **svp;
4371     I32 i;
4372     MAGIC *mg = NULL;
4373     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4374         if (PL_in_clean_all)
4375             return;
4376     }
4377     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4378         Perl_croak(aTHX_ "panic: del_backref");
4379     av = (AV *)mg->mg_obj;
4380     svp = AvARRAY(av);
4381     /* We shouldn't be in here more than once, but for paranoia reasons lets
4382        not assume this.  */
4383     for (i = AvFILLp(av); i >= 0; i--) {
4384         if (svp[i] == sv) {
4385             const SSize_t fill = AvFILLp(av);
4386             if (i != fill) {
4387                 /* We weren't the last entry.
4388                    An unordered list has this property that you can take the
4389                    last element off the end to fill the hole, and it's still
4390                    an unordered list :-)
4391                 */
4392                 svp[i] = svp[fill];
4393             }
4394             svp[fill] = Nullsv;
4395             AvFILLp(av) = fill - 1;
4396         }
4397     }
4398 }
4399
4400 /*
4401 =for apidoc sv_insert
4402
4403 Inserts a string at the specified offset/length within the SV. Similar to
4404 the Perl substr() function.
4405
4406 =cut
4407 */
4408
4409 void
4410 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4411 {
4412     register char *big;
4413     register char *mid;
4414     register char *midend;
4415     register char *bigend;
4416     register I32 i;
4417     STRLEN curlen;
4418
4419
4420     if (!bigstr)
4421         Perl_croak(aTHX_ "Can't modify non-existent substring");
4422     SvPV_force(bigstr, curlen);
4423     (void)SvPOK_only_UTF8(bigstr);
4424     if (offset + len > curlen) {
4425         SvGROW(bigstr, offset+len+1);
4426         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4427         SvCUR_set(bigstr, offset+len);
4428     }
4429
4430     SvTAINT(bigstr);
4431     i = littlelen - len;
4432     if (i > 0) {                        /* string might grow */
4433         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4434         mid = big + offset + len;
4435         midend = bigend = big + SvCUR(bigstr);
4436         bigend += i;
4437         *bigend = '\0';
4438         while (midend > mid)            /* shove everything down */
4439             *--bigend = *--midend;
4440         Move(little,big+offset,littlelen,char);
4441         SvCUR_set(bigstr, SvCUR(bigstr) + i);
4442         SvSETMAGIC(bigstr);
4443         return;
4444     }
4445     else if (i == 0) {
4446         Move(little,SvPVX(bigstr)+offset,len,char);
4447         SvSETMAGIC(bigstr);
4448         return;
4449     }
4450
4451     big = SvPVX(bigstr);
4452     mid = big + offset;
4453     midend = mid + len;
4454     bigend = big + SvCUR(bigstr);
4455
4456     if (midend > bigend)
4457         Perl_croak(aTHX_ "panic: sv_insert");
4458
4459     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4460         if (littlelen) {
4461             Move(little, mid, littlelen,char);
4462             mid += littlelen;
4463         }
4464         i = bigend - midend;
4465         if (i > 0) {
4466             Move(midend, mid, i,char);
4467             mid += i;
4468         }
4469         *mid = '\0';
4470         SvCUR_set(bigstr, mid - big);
4471     }
4472     else if ((i = mid - big)) { /* faster from front */
4473         midend -= littlelen;
4474         mid = midend;
4475         sv_chop(bigstr,midend-i);
4476         big += i;
4477         while (i--)
4478             *--midend = *--big;
4479         if (littlelen)
4480             Move(little, mid, littlelen,char);
4481     }
4482     else if (littlelen) {
4483         midend -= littlelen;
4484         sv_chop(bigstr,midend);
4485         Move(little,midend,littlelen,char);
4486     }
4487     else {
4488         sv_chop(bigstr,midend);
4489     }
4490     SvSETMAGIC(bigstr);
4491 }
4492
4493 /*
4494 =for apidoc sv_replace
4495
4496 Make the first argument a copy of the second, then delete the original.
4497 The target SV physically takes over ownership of the body of the source SV
4498 and inherits its flags; however, the target keeps any magic it owns,
4499 and any magic in the source is discarded.
4500 Note that this is a rather specialist SV copying operation; most of the
4501 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4502
4503 =cut
4504 */
4505
4506 void
4507 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4508 {
4509     const U32 refcnt = SvREFCNT(sv);
4510     SV_CHECK_THINKFIRST_COW_DROP(sv);
4511     if (SvREFCNT(nsv) != 1) {
4512         Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4513                    UVuf " != 1)", (UV) SvREFCNT(nsv));
4514     }
4515     if (SvMAGICAL(sv)) {
4516         if (SvMAGICAL(nsv))
4517             mg_free(nsv);
4518         else
4519             sv_upgrade(nsv, SVt_PVMG);
4520         SvMAGIC_set(nsv, SvMAGIC(sv));
4521         SvFLAGS(nsv) |= SvMAGICAL(sv);
4522         SvMAGICAL_off(sv);
4523         SvMAGIC_set(sv, NULL);
4524     }
4525     SvREFCNT(sv) = 0;
4526     sv_clear(sv);
4527     assert(!SvREFCNT(sv));
4528 #ifdef DEBUG_LEAKING_SCALARS
4529     sv->sv_flags  = nsv->sv_flags;
4530     sv->sv_any    = nsv->sv_any;
4531     sv->sv_refcnt = nsv->sv_refcnt;
4532     sv->sv_u      = nsv->sv_u;
4533 #else
4534     StructCopy(nsv,sv,SV);
4535 #endif
4536     /* Currently could join these into one piece of pointer arithmetic, but
4537        it would be unclear.  */
4538     if(SvTYPE(sv) == SVt_IV)
4539         SvANY(sv)
4540             = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4541     else if (SvTYPE(sv) == SVt_RV) {
4542         SvANY(sv) = &sv->sv_u.svu_rv;
4543     }
4544         
4545
4546 #ifdef PERL_OLD_COPY_ON_WRITE
4547     if (SvIsCOW_normal(nsv)) {
4548         /* We need to follow the pointers around the loop to make the
4549            previous SV point to sv, rather than nsv.  */
4550         SV *next;
4551         SV *current = nsv;
4552         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4553             assert(next);
4554             current = next;
4555             assert(SvPVX_const(current) == SvPVX_const(nsv));
4556         }
4557         /* Make the SV before us point to the SV after us.  */
4558         if (DEBUG_C_TEST) {
4559             PerlIO_printf(Perl_debug_log, "previous is\n");
4560             sv_dump(current);
4561             PerlIO_printf(Perl_debug_log,
4562                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4563                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
4564         }
4565         SV_COW_NEXT_SV_SET(current, sv);
4566     }
4567 #endif
4568     SvREFCNT(sv) = refcnt;
4569     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
4570     SvREFCNT(nsv) = 0;
4571     del_SV(nsv);
4572 }
4573
4574 /*
4575 =for apidoc sv_clear
4576
4577 Clear an SV: call any destructors, free up any memory used by the body,
4578 and free the body itself. The SV's head is I<not> freed, although
4579 its type is set to all 1's so that it won't inadvertently be assumed
4580 to be live during global destruction etc.
4581 This function should only be called when REFCNT is zero. Most of the time
4582 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4583 instead.
4584
4585 =cut
4586 */
4587
4588 void
4589 Perl_sv_clear(pTHX_ register SV *sv)
4590 {
4591     dVAR;
4592     const U32 type = SvTYPE(sv);
4593     const struct body_details *const sv_type_details
4594         = bodies_by_type + type;
4595
4596     assert(sv);
4597     assert(SvREFCNT(sv) == 0);
4598
4599     if (type <= SVt_IV)
4600         return;
4601
4602     if (SvOBJECT(sv)) {
4603         if (PL_defstash) {              /* Still have a symbol table? */
4604             dSP;
4605             HV* stash;
4606             do {        
4607                 CV* destructor;
4608                 stash = SvSTASH(sv);
4609                 destructor = StashHANDLER(stash,DESTROY);
4610                 if (destructor) {
4611                     SV* const tmpref = newRV(sv);
4612                     SvREADONLY_on(tmpref);   /* DESTROY() could be naughty */
4613                     ENTER;
4614                     PUSHSTACKi(PERLSI_DESTROY);
4615                     EXTEND(SP, 2);
4616                     PUSHMARK(SP);
4617                     PUSHs(tmpref);
4618                     PUTBACK;
4619                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4620                 
4621                 
4622                     POPSTACK;
4623                     SPAGAIN;
4624                     LEAVE;
4625                     if(SvREFCNT(tmpref) < 2) {
4626                         /* tmpref is not kept alive! */
4627                         SvREFCNT(sv)--;
4628                         SvRV_set(tmpref, NULL);
4629                         SvROK_off(tmpref);
4630                     }
4631                     SvREFCNT_dec(tmpref);
4632                 }
4633             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4634
4635
4636             if (SvREFCNT(sv)) {
4637                 if (PL_in_clean_objs)
4638                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4639                           HvNAME_get(stash));
4640                 /* DESTROY gave object new lease on life */
4641                 return;
4642             }
4643         }
4644
4645         if (SvOBJECT(sv)) {
4646             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
4647             SvOBJECT_off(sv);   /* Curse the object. */
4648             if (type != SVt_PVIO)
4649                 --PL_sv_objcount;       /* XXX Might want something more general */
4650         }
4651     }
4652     if (type >= SVt_PVMG) {
4653         if (SvMAGIC(sv))
4654             mg_free(sv);
4655         if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4656             SvREFCNT_dec(SvSTASH(sv));
4657     }
4658     switch (type) {
4659     case SVt_PVIO:
4660         if (IoIFP(sv) &&
4661             IoIFP(sv) != PerlIO_stdin() &&
4662             IoIFP(sv) != PerlIO_stdout() &&
4663             IoIFP(sv) != PerlIO_stderr())
4664         {
4665             io_close((IO*)sv, FALSE);
4666         }
4667         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4668             PerlDir_close(IoDIRP(sv));
4669         IoDIRP(sv) = (DIR*)NULL;
4670         Safefree(IoTOP_NAME(sv));
4671         Safefree(IoFMT_NAME(sv));
4672         Safefree(IoBOTTOM_NAME(sv));
4673         goto freescalar;
4674     case SVt_PVBM:
4675         goto freescalar;
4676     case SVt_PVCV:
4677     case SVt_PVFM:
4678         cv_undef((CV*)sv);
4679         goto freescalar;
4680     case SVt_PVHV:
4681         hv_undef((HV*)sv);
4682         break;
4683     case SVt_PVAV:
4684         av_undef((AV*)sv);
4685         break;
4686     case SVt_PVLV:
4687         if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4688             SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4689             HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4690             PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4691         }
4692         else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
4693             SvREFCNT_dec(LvTARG(sv));
4694         goto freescalar;
4695     case SVt_PVGV:
4696         gp_free((GV*)sv);
4697         Safefree(GvNAME(sv));
4698         /* If we're in a stash, we don't own a reference to it. However it does
4699            have a back reference to us, which needs to be cleared.  */
4700         if (GvSTASH(sv))
4701             sv_del_backref((SV*)GvSTASH(sv), sv);
4702     case SVt_PVMG:
4703     case SVt_PVNV:
4704     case SVt_PVIV:
4705       freescalar:
4706         /* Don't bother with SvOOK_off(sv); as we're only going to free it.  */
4707         if (SvOOK(sv)) {
4708             SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4709             /* Don't even bother with turning off the OOK flag.  */
4710         }
4711     case SVt_PV:
4712     case SVt_RV:
4713         if (SvROK(sv)) {
4714             SV *target = SvRV(sv);
4715             if (SvWEAKREF(sv))
4716                 sv_del_backref(target, sv);
4717             else
4718                 SvREFCNT_dec(target);
4719         }
4720 #ifdef PERL_OLD_COPY_ON_WRITE
4721         else if (SvPVX_const(sv)) {
4722             if (SvIsCOW(sv)) {
4723                 /* I believe I need to grab the global SV mutex here and
4724                    then recheck the COW status.  */
4725                 if (DEBUG_C_TEST) {
4726                     PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4727                     sv_dump(sv);
4728                 }
4729                 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4730                                SV_COW_NEXT_SV(sv));
4731                 /* And drop it here.  */
4732                 SvFAKE_off(sv);
4733             } else if (SvLEN(sv)) {
4734                 Safefree(SvPVX_const(sv));
4735             }
4736         }
4737 #else
4738         else if (SvPVX_const(sv) && SvLEN(sv))
4739             Safefree(SvPVX_mutable(sv));
4740         else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4741             unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4742             SvFAKE_off(sv);
4743         }
4744 #endif
4745         break;
4746     case SVt_NV:
4747         break;
4748     }
4749
4750     SvFLAGS(sv) &= SVf_BREAK;
4751     SvFLAGS(sv) |= SVTYPEMASK;
4752
4753     if (sv_type_details->arena) {
4754         del_body(((char *)SvANY(sv) + sv_type_details->offset),
4755                  &PL_body_roots[type]);
4756     }
4757     else if (sv_type_details->size) {
4758         my_safefree(SvANY(sv));
4759     }
4760 }
4761
4762 /*
4763 =for apidoc sv_newref
4764
4765 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4766 instead.
4767
4768 =cut
4769 */
4770
4771 SV *
4772 Perl_sv_newref(pTHX_ SV *sv)
4773 {
4774     if (sv)
4775         (SvREFCNT(sv))++;
4776     return sv;
4777 }
4778
4779 /*