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