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