This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Clone the brief return logic and thereby remove a goto.
[perl5.git] / sv.c
1 /*    sv.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  * "I wonder what the Entish is for 'yes' and 'no'," he thought.
10  *
11  *
12  * This file contains the code that creates, manipulates and destroys
13  * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14  * structure of an SV, so their creation and destruction is handled
15  * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16  * level functions (eg. substr, split, join) for each of the types are
17  * in the pp*.c files.
18  */
19
20 #include "EXTERN.h"
21 #define PERL_IN_SV_C
22 #include "perl.h"
23 #include "regcomp.h"
24
25 #define FCALL *f
26
27 #ifdef __Lynx__
28 /* Missing proto on LynxOS */
29   char *gconvert(double, int, int,  char *);
30 #endif
31
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34  * the cache element 1 is the byte offset of the element 0;
35  * the cache element 2 is the Unicode length of the substring;
36  * the cache element 3 is the byte length of the substring;
37  * The checking of the substring side would be good
38  * but substr() has enough code paths to make my head spin;
39  * if adding more checks watch out for the following tests:
40  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41  *   lib/utf8.t lib/Unicode/Collate/t/index.t
42  * --jhi
43  */
44 #define ASSERT_UTF8_CACHE(cache) \
45         STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
46 #else
47 #define ASSERT_UTF8_CACHE(cache) NOOP
48 #endif
49
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54    on-write.  */
55 #endif
56
57 /* ============================================================================
58
59 =head1 Allocation and deallocation of SVs.
60
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
65
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
71
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena.  In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots.  Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
78
79 The following global variables are associated with arenas:
80
81     PL_sv_arenaroot     pointer to list of SV arenas
82     PL_sv_root          pointer to list of free SV structures
83
84     PL_body_arenaroots[]  array of pointers to list of arenas, 1 per svtype
85     PL_body_roots[]       array of pointers to list of free bodies of svtype
86                           arrays are indexed by the svtype needed
87
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
91
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
96
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
99
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
105
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
112
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
116
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
120
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
126
127     sv_report_used() / do_report_used()
128                         dump all remaining SVs (debugging aid)
129
130     sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131                         Attempt to free all objects pointed to by RVs,
132                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133                         try to do the same for all objects indirectly
134                         referenced by typeglobs too.  Called once from
135                         perl_destruct(), prior to calling sv_clean_all()
136                         below.
137
138     sv_clean_all() / do_clean_all()
139                         SvREFCNT_dec(sv) each remaining SV, possibly
140                         triggering an sv_free(). It also sets the
141                         SVf_BREAK flag on the SV to indicate that the
142                         refcnt has been artificially lowered, and thus
143                         stopping sv_free() from giving spurious warnings
144                         about SVs which unexpectedly have a refcnt
145                         of zero.  called repeatedly from perl_destruct()
146                         until there are no SVs left.
147
148 =head2 Arena allocator API Summary
149
150 Private API to rest of sv.c
151
152     new_SV(),  del_SV(),
153
154     new_XIV(), del_XIV(),
155     new_XNV(), del_XNV(),
156     etc
157
158 Public API:
159
160     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
161
162
163 =cut
164
165 ============================================================================ */
166
167
168
169 /*
170  * "A time to plant, and a time to uproot what was planted..."
171  */
172
173 /*
174  * nice_chunk and nice_chunk size need to be set
175  * and queried under the protection of sv_mutex
176  */
177 void
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
179 {
180     void *new_chunk;
181     U32 new_chunk_size;
182     LOCK_SV_MUTEX;
183     new_chunk = (void *)(chunk);
184     new_chunk_size = (chunk_size);
185     if (new_chunk_size > PL_nice_chunk_size) {
186         Safefree(PL_nice_chunk);
187         PL_nice_chunk = (char *) new_chunk;
188         PL_nice_chunk_size = new_chunk_size;
189     } else {
190         Safefree(chunk);
191     }
192     UNLOCK_SV_MUTEX;
193 }
194
195 #ifdef DEBUG_LEAKING_SCALARS
196 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
197 #else
198 #  define FREE_SV_DEBUG_FILE(sv)
199 #endif
200
201 #ifdef PERL_POISON
202 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
204    unreferenced scalars
205 #  define POSION_SV_HEAD(sv)    Poison(sv, 1, struct STRUCT_SV)
206 */
207 #  define POSION_SV_HEAD(sv)    Poison(&SvANY(sv), 1, void *), \
208                                 Poison(&SvREFCNT(sv), 1, U32)
209 #else
210 #  define SvARENA_CHAIN(sv)     SvANY(sv)
211 #  define POSION_SV_HEAD(sv)
212 #endif
213
214 #define plant_SV(p) \
215     STMT_START {                                        \
216         FREE_SV_DEBUG_FILE(p);                          \
217         POSION_SV_HEAD(p);                              \
218         SvARENA_CHAIN(p) = (void *)PL_sv_root;          \
219         SvFLAGS(p) = SVTYPEMASK;                        \
220         PL_sv_root = (p);                               \
221         --PL_sv_count;                                  \
222     } STMT_END
223
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
226     STMT_START {                                        \
227         (p) = PL_sv_root;                               \
228         PL_sv_root = (SV*)SvARENA_CHAIN(p);                     \
229         ++PL_sv_count;                                  \
230     } STMT_END
231
232
233 /* make some more SVs by adding another arena */
234
235 /* sv_mutex must be held while calling more_sv() */
236 STATIC SV*
237 S_more_sv(pTHX)
238 {
239     SV* sv;
240
241     if (PL_nice_chunk) {
242         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243         PL_nice_chunk = Nullch;
244         PL_nice_chunk_size = 0;
245     }
246     else {
247         char *chunk;                /* must use New here to match call to */
248         Newx(chunk,PERL_ARENA_SIZE,char);   /* Safefree() in sv_free_arenas()     */
249         sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
250     }
251     uproot_SV(sv);
252     return sv;
253 }
254
255 /* new_SV(): return a new, empty SV head */
256
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
259 STATIC SV*
260 S_new_SV(pTHX)
261 {
262     SV* sv;
263
264     LOCK_SV_MUTEX;
265     if (PL_sv_root)
266         uproot_SV(sv);
267     else
268         sv = S_more_sv(aTHX);
269     UNLOCK_SV_MUTEX;
270     SvANY(sv) = 0;
271     SvREFCNT(sv) = 1;
272     SvFLAGS(sv) = 0;
273     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274     sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275         (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276     sv->sv_debug_inpad = 0;
277     sv->sv_debug_cloned = 0;
278     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
279     
280     return sv;
281 }
282 #  define new_SV(p) (p)=S_new_SV(aTHX)
283
284 #else
285 #  define new_SV(p) \
286     STMT_START {                                        \
287         LOCK_SV_MUTEX;                                  \
288         if (PL_sv_root)                                 \
289             uproot_SV(p);                               \
290         else                                            \
291             (p) = S_more_sv(aTHX);                      \
292         UNLOCK_SV_MUTEX;                                \
293         SvANY(p) = 0;                                   \
294         SvREFCNT(p) = 1;                                \
295         SvFLAGS(p) = 0;                                 \
296     } STMT_END
297 #endif
298
299
300 /* del_SV(): return an empty SV head to the free list */
301
302 #ifdef DEBUGGING
303
304 #define del_SV(p) \
305     STMT_START {                                        \
306         LOCK_SV_MUTEX;                                  \
307         if (DEBUG_D_TEST)                               \
308             del_sv(p);                                  \
309         else                                            \
310             plant_SV(p);                                \
311         UNLOCK_SV_MUTEX;                                \
312     } STMT_END
313
314 STATIC void
315 S_del_sv(pTHX_ SV *p)
316 {
317     if (DEBUG_D_TEST) {
318         SV* sva;
319         bool ok = 0;
320         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321             const SV * const sv = sva + 1;
322             const SV * const svend = &sva[SvREFCNT(sva)];
323             if (p >= sv && p < svend) {
324                 ok = 1;
325                 break;
326             }
327         }
328         if (!ok) {
329             if (ckWARN_d(WARN_INTERNAL))        
330                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331                             "Attempt to free non-arena SV: 0x%"UVxf
332                             pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
333             return;
334         }
335     }
336     plant_SV(p);
337 }
338
339 #else /* ! DEBUGGING */
340
341 #define del_SV(p)   plant_SV(p)
342
343 #endif /* DEBUGGING */
344
345
346 /*
347 =head1 SV Manipulation Functions
348
349 =for apidoc sv_add_arena
350
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
353
354 =cut
355 */
356
357 void
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
359 {
360     SV* 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 **arena_root   = &PL_body_arenaroots[sv_type];
644     void **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 **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 **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, *end;
1417           for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1418                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 /*
1629 =for apidoc sv_2iv_flags
1630
1631 Return the integer value of an SV, doing any necessary string
1632 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
1633 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1634
1635 =cut
1636 */
1637
1638 IV
1639 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1640 {
1641     if (!sv)
1642         return 0;
1643     if (SvGMAGICAL(sv)) {
1644         if (flags & SV_GMAGIC)
1645             mg_get(sv);
1646         if (SvIOKp(sv))
1647             return SvIVX(sv);
1648         if (SvNOKp(sv)) {
1649             return I_V(SvNVX(sv));
1650         }
1651         if (SvPOKp(sv) && SvLEN(sv))
1652             return asIV(sv);
1653         if (!SvROK(sv)) {
1654             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1655                 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1656                     report_uninit(sv);
1657             }
1658             return 0;
1659         }
1660     }
1661     if (SvTHINKFIRST(sv)) {
1662         if (SvROK(sv)) {
1663             if (SvAMAGIC(sv)) {
1664                 SV * const tmpstr=AMG_CALLun(sv,numer);
1665                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1666                     return SvIV(tmpstr);
1667                 }
1668             }
1669             return PTR2IV(SvRV(sv));
1670         }
1671         if (SvIsCOW(sv)) {
1672             sv_force_normal_flags(sv, 0);
1673         }
1674         if (SvREADONLY(sv) && !SvOK(sv)) {
1675             if (ckWARN(WARN_UNINITIALIZED))
1676                 report_uninit(sv);
1677             return 0;
1678         }
1679     }
1680     if (SvIOKp(sv)) {
1681         if (SvIsUV(sv)) {
1682             return (IV)(SvUVX(sv));
1683         }
1684         else {
1685             return SvIVX(sv);
1686         }
1687     }
1688     if (SvNOKp(sv)) {
1689         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1690          * without also getting a cached IV/UV from it at the same time
1691          * (ie PV->NV conversion should detect loss of accuracy and cache
1692          * IV or UV at same time to avoid this.  NWC */
1693
1694         if (SvTYPE(sv) == SVt_NV)
1695             sv_upgrade(sv, SVt_PVNV);
1696
1697         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1698         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1699            certainly cast into the IV range at IV_MAX, whereas the correct
1700            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1701            cases go to UV */
1702         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1703             SvIV_set(sv, I_V(SvNVX(sv)));
1704             if (SvNVX(sv) == (NV) SvIVX(sv)
1705 #ifndef NV_PRESERVES_UV
1706                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1707                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1708                 /* Don't flag it as "accurately an integer" if the number
1709                    came from a (by definition imprecise) NV operation, and
1710                    we're outside the range of NV integer precision */
1711 #endif
1712                 ) {
1713                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
1714                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1715                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1716                                       PTR2UV(sv),
1717                                       SvNVX(sv),
1718                                       SvIVX(sv)));
1719
1720             } else {
1721                 /* IV not precise.  No need to convert from PV, as NV
1722                    conversion would already have cached IV if it detected
1723                    that PV->IV would be better than PV->NV->IV
1724                    flags already correct - don't set public IOK.  */
1725                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1726                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1727                                       PTR2UV(sv),
1728                                       SvNVX(sv),
1729                                       SvIVX(sv)));
1730             }
1731             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1732                but the cast (NV)IV_MIN rounds to a the value less (more
1733                negative) than IV_MIN which happens to be equal to SvNVX ??
1734                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1735                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1736                (NV)UVX == NVX are both true, but the values differ. :-(
1737                Hopefully for 2s complement IV_MIN is something like
1738                0x8000000000000000 which will be exact. NWC */
1739         }
1740         else {
1741             SvUV_set(sv, U_V(SvNVX(sv)));
1742             if (
1743                 (SvNVX(sv) == (NV) SvUVX(sv))
1744 #ifndef  NV_PRESERVES_UV
1745                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1746                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1747                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1748                 /* Don't flag it as "accurately an integer" if the number
1749                    came from a (by definition imprecise) NV operation, and
1750                    we're outside the range of NV integer precision */
1751 #endif
1752                 )
1753                 SvIOK_on(sv);
1754             SvIsUV_on(sv);
1755             DEBUG_c(PerlIO_printf(Perl_debug_log,
1756                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1757                                   PTR2UV(sv),
1758                                   SvUVX(sv),
1759                                   SvUVX(sv)));
1760         }
1761     }
1762     else if (SvPOKp(sv) && SvLEN(sv)) {
1763         UV value;
1764         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1765         /* We want to avoid a possible problem when we cache an IV which
1766            may be later translated to an NV, and the resulting NV is not
1767            the same as the direct translation of the initial string
1768            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1769            be careful to ensure that the value with the .456 is around if the
1770            NV value is requested in the future).
1771         
1772            This means that if we cache such an IV, we need to cache the
1773            NV as well.  Moreover, we trade speed for space, and do not
1774            cache the NV if we are sure it's not needed.
1775          */
1776
1777         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
1778         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1779              == IS_NUMBER_IN_UV) {
1780             /* It's definitely an integer, only upgrade to PVIV */
1781             if (SvTYPE(sv) < SVt_PVIV)
1782                 sv_upgrade(sv, SVt_PVIV);
1783             (void)SvIOK_on(sv);
1784         } else if (SvTYPE(sv) < SVt_PVNV)
1785             sv_upgrade(sv, SVt_PVNV);
1786
1787         /* If NV preserves UV then we only use the UV value if we know that
1788            we aren't going to call atof() below. If NVs don't preserve UVs
1789            then the value returned may have more precision than atof() will
1790            return, even though value isn't perfectly accurate.  */
1791         if ((numtype & (IS_NUMBER_IN_UV
1792 #ifdef NV_PRESERVES_UV
1793                         | IS_NUMBER_NOT_INT
1794 #endif
1795             )) == IS_NUMBER_IN_UV) {
1796             /* This won't turn off the public IOK flag if it was set above  */
1797             (void)SvIOKp_on(sv);
1798
1799             if (!(numtype & IS_NUMBER_NEG)) {
1800                 /* positive */;
1801                 if (value <= (UV)IV_MAX) {
1802                     SvIV_set(sv, (IV)value);
1803                 } else {
1804                     SvUV_set(sv, value);
1805                     SvIsUV_on(sv);
1806                 }
1807             } else {
1808                 /* 2s complement assumption  */
1809                 if (value <= (UV)IV_MIN) {
1810                     SvIV_set(sv, -(IV)value);
1811                 } else {
1812                     /* Too negative for an IV.  This is a double upgrade, but
1813                        I'm assuming it will be rare.  */
1814                     if (SvTYPE(sv) < SVt_PVNV)
1815                         sv_upgrade(sv, SVt_PVNV);
1816                     SvNOK_on(sv);
1817                     SvIOK_off(sv);
1818                     SvIOKp_on(sv);
1819                     SvNV_set(sv, -(NV)value);
1820                     SvIV_set(sv, IV_MIN);
1821                 }
1822             }
1823         }
1824         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1825            will be in the previous block to set the IV slot, and the next
1826            block to set the NV slot.  So no else here.  */
1827         
1828         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1829             != IS_NUMBER_IN_UV) {
1830             /* It wasn't an (integer that doesn't overflow the UV). */
1831             SvNV_set(sv, Atof(SvPVX_const(sv)));
1832
1833             if (! numtype && ckWARN(WARN_NUMERIC))
1834                 not_a_number(sv);
1835
1836 #if defined(USE_LONG_DOUBLE)
1837             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1838                                   PTR2UV(sv), SvNVX(sv)));
1839 #else
1840             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1841                                   PTR2UV(sv), SvNVX(sv)));
1842 #endif
1843
1844
1845 #ifdef NV_PRESERVES_UV
1846             (void)SvIOKp_on(sv);
1847             (void)SvNOK_on(sv);
1848             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1849                 SvIV_set(sv, I_V(SvNVX(sv)));
1850                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1851                     SvIOK_on(sv);
1852                 } else {
1853                     /* Integer is imprecise. NOK, IOKp */
1854                 }
1855                 /* UV will not work better than IV */
1856             } else {
1857                 if (SvNVX(sv) > (NV)UV_MAX) {
1858                     SvIsUV_on(sv);
1859                     /* Integer is inaccurate. NOK, IOKp, is UV */
1860                     SvUV_set(sv, UV_MAX);
1861                     SvIsUV_on(sv);
1862                 } else {
1863                     SvUV_set(sv, U_V(SvNVX(sv)));
1864                     /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1865                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1866                         SvIOK_on(sv);
1867                         SvIsUV_on(sv);
1868                     } else {
1869                         /* Integer is imprecise. NOK, IOKp, is UV */
1870                         SvIsUV_on(sv);
1871                     }
1872                 }
1873             }
1874 #else /* NV_PRESERVES_UV */
1875             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1876                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1877                 /* The IV slot will have been set from value returned by
1878                    grok_number above.  The NV slot has just been set using
1879                    Atof.  */
1880                 SvNOK_on(sv);
1881                 assert (SvIOKp(sv));
1882             } else {
1883                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1884                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1885                     /* Small enough to preserve all bits. */
1886                     (void)SvIOKp_on(sv);
1887                     SvNOK_on(sv);
1888                     SvIV_set(sv, I_V(SvNVX(sv)));
1889                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
1890                         SvIOK_on(sv);
1891                     /* Assumption: first non-preserved integer is < IV_MAX,
1892                        this NV is in the preserved range, therefore: */
1893                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1894                           < (UV)IV_MAX)) {
1895                         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);
1896                     }
1897                 } else {
1898                     /* IN_UV NOT_INT
1899                          0      0       already failed to read UV.
1900                          0      1       already failed to read UV.
1901                          1      0       you won't get here in this case. IV/UV
1902                                         slot set, public IOK, Atof() unneeded.
1903                          1      1       already read UV.
1904                        so there's no point in sv_2iuv_non_preserve() attempting
1905                        to use atol, strtol, strtoul etc.  */
1906                     sv_2iuv_non_preserve (sv, numtype);
1907                 }
1908             }
1909 #endif /* NV_PRESERVES_UV */
1910         }
1911     } else  {
1912         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1913             report_uninit(sv);
1914         if (SvTYPE(sv) < SVt_IV)
1915             /* Typically the caller expects that sv_any is not NULL now.  */
1916             sv_upgrade(sv, SVt_IV);
1917         return 0;
1918     }
1919     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1920         PTR2UV(sv),SvIVX(sv)));
1921     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1922 }
1923
1924 /*
1925 =for apidoc sv_2uv_flags
1926
1927 Return the unsigned integer value of an SV, doing any necessary string
1928 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
1929 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1930
1931 =cut
1932 */
1933
1934 UV
1935 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1936 {
1937     if (!sv)
1938         return 0;
1939     if (SvGMAGICAL(sv)) {
1940         if (flags & SV_GMAGIC)
1941             mg_get(sv);
1942         if (SvIOKp(sv))
1943             return SvUVX(sv);
1944         if (SvNOKp(sv))
1945             return U_V(SvNVX(sv));
1946         if (SvPOKp(sv) && SvLEN(sv))
1947             return asUV(sv);
1948         if (!SvROK(sv)) {
1949             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1950                 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1951                     report_uninit(sv);
1952             }
1953             return 0;
1954         }
1955     }
1956     if (SvTHINKFIRST(sv)) {
1957         if (SvROK(sv)) {
1958           SV* tmpstr;
1959           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1960                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1961               return SvUV(tmpstr);
1962           return PTR2UV(SvRV(sv));
1963         }
1964         if (SvIsCOW(sv)) {
1965             sv_force_normal_flags(sv, 0);
1966         }
1967         if (SvREADONLY(sv) && !SvOK(sv)) {
1968             if (ckWARN(WARN_UNINITIALIZED))
1969                 report_uninit(sv);
1970             return 0;
1971         }
1972     }
1973     if (SvIOKp(sv)) {
1974         if (SvIsUV(sv)) {
1975             return SvUVX(sv);
1976         }
1977         else {
1978             return (UV)SvIVX(sv);
1979         }
1980     }
1981     if (SvNOKp(sv)) {
1982         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983          * without also getting a cached IV/UV from it at the same time
1984          * (ie PV->NV conversion should detect loss of accuracy and cache
1985          * IV or UV at same time to avoid this. */
1986         /* IV-over-UV optimisation - choose to cache IV if possible */
1987
1988         if (SvTYPE(sv) == SVt_NV)
1989             sv_upgrade(sv, SVt_PVNV);
1990
1991         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1992         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1993             SvIV_set(sv, I_V(SvNVX(sv)));
1994             if (SvNVX(sv) == (NV) SvIVX(sv)
1995 #ifndef NV_PRESERVES_UV
1996                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1997                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1998                 /* Don't flag it as "accurately an integer" if the number
1999                    came from a (by definition imprecise) NV operation, and
2000                    we're outside the range of NV integer precision */
2001 #endif
2002                 ) {
2003                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2004                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2005                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2006                                       PTR2UV(sv),
2007                                       SvNVX(sv),
2008                                       SvIVX(sv)));
2009
2010             } else {
2011                 /* IV not precise.  No need to convert from PV, as NV
2012                    conversion would already have cached IV if it detected
2013                    that PV->IV would be better than PV->NV->IV
2014                    flags already correct - don't set public IOK.  */
2015                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2017                                       PTR2UV(sv),
2018                                       SvNVX(sv),
2019                                       SvIVX(sv)));
2020             }
2021             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2022                but the cast (NV)IV_MIN rounds to a the value less (more
2023                negative) than IV_MIN which happens to be equal to SvNVX ??
2024                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2025                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2026                (NV)UVX == NVX are both true, but the values differ. :-(
2027                Hopefully for 2s complement IV_MIN is something like
2028                0x8000000000000000 which will be exact. NWC */
2029         }
2030         else {
2031             SvUV_set(sv, U_V(SvNVX(sv)));
2032             if (
2033                 (SvNVX(sv) == (NV) SvUVX(sv))
2034 #ifndef  NV_PRESERVES_UV
2035                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2036                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2037                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2038                 /* Don't flag it as "accurately an integer" if the number
2039                    came from a (by definition imprecise) NV operation, and
2040                    we're outside the range of NV integer precision */
2041 #endif
2042                 )
2043                 SvIOK_on(sv);
2044             SvIsUV_on(sv);
2045             DEBUG_c(PerlIO_printf(Perl_debug_log,
2046                                   "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2047                                   PTR2UV(sv),
2048                                   SvUVX(sv),
2049                                   SvUVX(sv)));
2050         }
2051     }
2052     else if (SvPOKp(sv) && SvLEN(sv)) {
2053         UV value;
2054         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2055
2056         /* We want to avoid a possible problem when we cache a UV which
2057            may be later translated to an NV, and the resulting NV is not
2058            the translation of the initial data.
2059         
2060            This means that if we cache such a UV, we need to cache the
2061            NV as well.  Moreover, we trade speed for space, and do not
2062            cache the NV if not needed.
2063          */
2064
2065         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2066         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2067              == IS_NUMBER_IN_UV) {
2068             /* It's definitely an integer, only upgrade to PVIV */
2069             if (SvTYPE(sv) < SVt_PVIV)
2070                 sv_upgrade(sv, SVt_PVIV);
2071             (void)SvIOK_on(sv);
2072         } else if (SvTYPE(sv) < SVt_PVNV)
2073             sv_upgrade(sv, SVt_PVNV);
2074
2075         /* If NV preserves UV then we only use the UV value if we know that
2076            we aren't going to call atof() below. If NVs don't preserve UVs
2077            then the value returned may have more precision than atof() will
2078            return, even though it isn't accurate.  */
2079         if ((numtype & (IS_NUMBER_IN_UV
2080 #ifdef NV_PRESERVES_UV
2081                         | IS_NUMBER_NOT_INT
2082 #endif
2083             )) == IS_NUMBER_IN_UV) {
2084             /* This won't turn off the public IOK flag if it was set above  */
2085             (void)SvIOKp_on(sv);
2086
2087             if (!(numtype & IS_NUMBER_NEG)) {
2088                 /* positive */;
2089                 if (value <= (UV)IV_MAX) {
2090                     SvIV_set(sv, (IV)value);
2091                 } else {
2092                     /* it didn't overflow, and it was positive. */
2093                     SvUV_set(sv, value);
2094                     SvIsUV_on(sv);
2095                 }
2096             } else {
2097                 /* 2s complement assumption  */
2098                 if (value <= (UV)IV_MIN) {
2099                     SvIV_set(sv, -(IV)value);
2100                 } else {
2101                     /* Too negative for an IV.  This is a double upgrade, but
2102                        I'm assuming it will be rare.  */
2103                     if (SvTYPE(sv) < SVt_PVNV)
2104                         sv_upgrade(sv, SVt_PVNV);
2105                     SvNOK_on(sv);
2106                     SvIOK_off(sv);
2107                     SvIOKp_on(sv);
2108                     SvNV_set(sv, -(NV)value);
2109                     SvIV_set(sv, IV_MIN);
2110                 }
2111             }
2112         }
2113         
2114         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2115             != IS_NUMBER_IN_UV) {
2116             /* It wasn't an integer, or it overflowed the UV. */
2117             SvNV_set(sv, Atof(SvPVX_const(sv)));
2118
2119             if (! numtype && ckWARN(WARN_NUMERIC))
2120                     not_a_number(sv);
2121
2122 #if defined(USE_LONG_DOUBLE)
2123             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2124                                   PTR2UV(sv), SvNVX(sv)));
2125 #else
2126             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2127                                   PTR2UV(sv), SvNVX(sv)));
2128 #endif
2129
2130 #ifdef NV_PRESERVES_UV
2131             (void)SvIOKp_on(sv);
2132             (void)SvNOK_on(sv);
2133             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2134                 SvIV_set(sv, I_V(SvNVX(sv)));
2135                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2136                     SvIOK_on(sv);
2137                 } else {
2138                     /* Integer is imprecise. NOK, IOKp */
2139                 }
2140                 /* UV will not work better than IV */
2141             } else {
2142                 if (SvNVX(sv) > (NV)UV_MAX) {
2143                     SvIsUV_on(sv);
2144                     /* Integer is inaccurate. NOK, IOKp, is UV */
2145                     SvUV_set(sv, UV_MAX);
2146                     SvIsUV_on(sv);
2147                 } else {
2148                     SvUV_set(sv, U_V(SvNVX(sv)));
2149                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2150                        NV preservse UV so can do correct comparison.  */
2151                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2152                         SvIOK_on(sv);
2153                         SvIsUV_on(sv);
2154                     } else {
2155                         /* Integer is imprecise. NOK, IOKp, is UV */
2156                         SvIsUV_on(sv);
2157                     }
2158                 }
2159             }
2160 #else /* NV_PRESERVES_UV */
2161             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2163                 /* The UV slot will have been set from value returned by
2164                    grok_number above.  The NV slot has just been set using
2165                    Atof.  */
2166                 SvNOK_on(sv);
2167                 assert (SvIOKp(sv));
2168             } else {
2169                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2170                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2171                     /* Small enough to preserve all bits. */
2172                     (void)SvIOKp_on(sv);
2173                     SvNOK_on(sv);
2174                     SvIV_set(sv, I_V(SvNVX(sv)));
2175                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2176                         SvIOK_on(sv);
2177                     /* Assumption: first non-preserved integer is < IV_MAX,
2178                        this NV is in the preserved range, therefore: */
2179                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2180                           < (UV)IV_MAX)) {
2181                         Perl_croak(aTHX_ "sv_2uv 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);
2182                     }
2183                 } else
2184                     sv_2iuv_non_preserve (sv, numtype);
2185             }
2186 #endif /* NV_PRESERVES_UV */
2187         }
2188     }
2189     else  {
2190         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2191             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2192                 report_uninit(sv);
2193         }
2194         if (SvTYPE(sv) < SVt_IV)
2195             /* Typically the caller expects that sv_any is not NULL now.  */
2196             sv_upgrade(sv, SVt_IV);
2197         return 0;
2198     }
2199
2200     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2201                           PTR2UV(sv),SvUVX(sv)));
2202     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2203 }
2204
2205 /*
2206 =for apidoc sv_2nv
2207
2208 Return the num value of an SV, doing any necessary string or integer
2209 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2210 macros.
2211
2212 =cut
2213 */
2214
2215 NV
2216 Perl_sv_2nv(pTHX_ register SV *sv)
2217 {
2218     if (!sv)
2219         return 0.0;
2220     if (SvGMAGICAL(sv)) {
2221         mg_get(sv);
2222         if (SvNOKp(sv))
2223             return SvNVX(sv);
2224         if (SvPOKp(sv) && SvLEN(sv)) {
2225             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2226                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2227                 not_a_number(sv);
2228             return Atof(SvPVX_const(sv));
2229         }
2230         if (SvIOKp(sv)) {
2231             if (SvIsUV(sv))
2232                 return (NV)SvUVX(sv);
2233             else
2234                 return (NV)SvIVX(sv);
2235         }       
2236         if (!SvROK(sv)) {
2237             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2238                 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2239                     report_uninit(sv);
2240             }
2241             return (NV)0;
2242         }
2243     }
2244     if (SvTHINKFIRST(sv)) {
2245         if (SvROK(sv)) {
2246           SV* tmpstr;
2247           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2248                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2249               return SvNV(tmpstr);
2250           return PTR2NV(SvRV(sv));
2251         }
2252         if (SvIsCOW(sv)) {
2253             sv_force_normal_flags(sv, 0);
2254         }
2255         if (SvREADONLY(sv) && !SvOK(sv)) {
2256             if (ckWARN(WARN_UNINITIALIZED))
2257                 report_uninit(sv);
2258             return 0.0;
2259         }
2260     }
2261     if (SvTYPE(sv) < SVt_NV) {
2262         if (SvTYPE(sv) == SVt_IV)
2263             sv_upgrade(sv, SVt_PVNV);
2264         else
2265             sv_upgrade(sv, SVt_NV);
2266 #ifdef USE_LONG_DOUBLE
2267         DEBUG_c({
2268             STORE_NUMERIC_LOCAL_SET_STANDARD();
2269             PerlIO_printf(Perl_debug_log,
2270                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2271                           PTR2UV(sv), SvNVX(sv));
2272             RESTORE_NUMERIC_LOCAL();
2273         });
2274 #else
2275         DEBUG_c({
2276             STORE_NUMERIC_LOCAL_SET_STANDARD();
2277             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2278                           PTR2UV(sv), SvNVX(sv));
2279             RESTORE_NUMERIC_LOCAL();
2280         });
2281 #endif
2282     }
2283     else if (SvTYPE(sv) < SVt_PVNV)
2284         sv_upgrade(sv, SVt_PVNV);
2285     if (SvNOKp(sv)) {
2286         return SvNVX(sv);
2287     }
2288     if (SvIOKp(sv)) {
2289         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2290 #ifdef NV_PRESERVES_UV
2291         SvNOK_on(sv);
2292 #else
2293         /* Only set the public NV OK flag if this NV preserves the IV  */
2294         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2295         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2296                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2297             SvNOK_on(sv);
2298         else
2299             SvNOKp_on(sv);
2300 #endif
2301     }
2302     else if (SvPOKp(sv) && SvLEN(sv)) {
2303         UV value;
2304         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2305         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2306             not_a_number(sv);
2307 #ifdef NV_PRESERVES_UV
2308         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2309             == IS_NUMBER_IN_UV) {
2310             /* It's definitely an integer */
2311             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2312         } else
2313             SvNV_set(sv, Atof(SvPVX_const(sv)));
2314         SvNOK_on(sv);
2315 #else
2316         SvNV_set(sv, Atof(SvPVX_const(sv)));
2317         /* Only set the public NV OK flag if this NV preserves the value in
2318            the PV at least as well as an IV/UV would.
2319            Not sure how to do this 100% reliably. */
2320         /* if that shift count is out of range then Configure's test is
2321            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2322            UV_BITS */
2323         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2324             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2325             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2326         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2327             /* Can't use strtol etc to convert this string, so don't try.
2328                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2329             SvNOK_on(sv);
2330         } else {
2331             /* value has been set.  It may not be precise.  */
2332             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2333                 /* 2s complement assumption for (UV)IV_MIN  */
2334                 SvNOK_on(sv); /* Integer is too negative.  */
2335             } else {
2336                 SvNOKp_on(sv);
2337                 SvIOKp_on(sv);
2338
2339                 if (numtype & IS_NUMBER_NEG) {
2340                     SvIV_set(sv, -(IV)value);
2341                 } else if (value <= (UV)IV_MAX) {
2342                     SvIV_set(sv, (IV)value);
2343                 } else {
2344                     SvUV_set(sv, value);
2345                     SvIsUV_on(sv);
2346                 }
2347
2348                 if (numtype & IS_NUMBER_NOT_INT) {
2349                     /* I believe that even if the original PV had decimals,
2350                        they are lost beyond the limit of the FP precision.
2351                        However, neither is canonical, so both only get p
2352                        flags.  NWC, 2000/11/25 */
2353                     /* Both already have p flags, so do nothing */
2354                 } else {
2355                     const NV nv = SvNVX(sv);
2356                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2357                         if (SvIVX(sv) == I_V(nv)) {
2358                             SvNOK_on(sv);
2359                             SvIOK_on(sv);
2360                         } else {
2361                             SvIOK_on(sv);
2362                             /* It had no "." so it must be integer.  */
2363                         }
2364                     } else {
2365                         /* between IV_MAX and NV(UV_MAX).
2366                            Could be slightly > UV_MAX */
2367
2368                         if (numtype & IS_NUMBER_NOT_INT) {
2369                             /* UV and NV both imprecise.  */
2370                         } else {
2371                             const UV nv_as_uv = U_V(nv);
2372
2373                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2374                                 SvNOK_on(sv);
2375                                 SvIOK_on(sv);
2376                             } else {
2377                                 SvIOK_on(sv);
2378                             }
2379                         }
2380                     }
2381                 }
2382             }
2383         }
2384 #endif /* NV_PRESERVES_UV */
2385     }
2386     else  {
2387         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2388             report_uninit(sv);
2389         if (SvTYPE(sv) < SVt_NV)
2390             /* Typically the caller expects that sv_any is not NULL now.  */
2391             /* XXX Ilya implies that this is a bug in callers that assume this
2392                and ideally should be fixed.  */
2393             sv_upgrade(sv, SVt_NV);
2394         return 0.0;
2395     }
2396 #if defined(USE_LONG_DOUBLE)
2397     DEBUG_c({
2398         STORE_NUMERIC_LOCAL_SET_STANDARD();
2399         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2400                       PTR2UV(sv), SvNVX(sv));
2401         RESTORE_NUMERIC_LOCAL();
2402     });
2403 #else
2404     DEBUG_c({
2405         STORE_NUMERIC_LOCAL_SET_STANDARD();
2406         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2407                       PTR2UV(sv), SvNVX(sv));
2408         RESTORE_NUMERIC_LOCAL();
2409     });
2410 #endif
2411     return SvNVX(sv);
2412 }
2413
2414 /* asIV(): extract an integer from the string value of an SV.
2415  * Caller must validate PVX  */
2416
2417 STATIC IV
2418 S_asIV(pTHX_ SV *sv)
2419 {
2420     UV value;
2421     const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2422
2423     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2424         == IS_NUMBER_IN_UV) {
2425         /* It's definitely an integer */
2426         if (numtype & IS_NUMBER_NEG) {
2427             if (value < (UV)IV_MIN)
2428                 return -(IV)value;
2429         } else {
2430             if (value < (UV)IV_MAX)
2431                 return (IV)value;
2432         }
2433     }
2434     if (!numtype) {
2435         if (ckWARN(WARN_NUMERIC))
2436             not_a_number(sv);
2437     }
2438     return I_V(Atof(SvPVX_const(sv)));
2439 }
2440
2441 /* asUV(): extract an unsigned integer from the string value of an SV
2442  * Caller must validate PVX  */
2443
2444 STATIC UV
2445 S_asUV(pTHX_ SV *sv)
2446 {
2447     UV value;
2448     const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2449
2450     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2451         == IS_NUMBER_IN_UV) {
2452         /* It's definitely an integer */
2453         if (!(numtype & IS_NUMBER_NEG))
2454             return value;
2455     }
2456     if (!numtype) {
2457         if (ckWARN(WARN_NUMERIC))
2458             not_a_number(sv);
2459     }
2460     return U_V(Atof(SvPVX_const(sv)));
2461 }
2462
2463 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2464  * UV as a string towards the end of buf, and return pointers to start and
2465  * end of it.
2466  *
2467  * We assume that buf is at least TYPE_CHARS(UV) long.
2468  */
2469
2470 static char *
2471 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2472 {
2473     char *ptr = buf + TYPE_CHARS(UV);
2474     char * const ebuf = ptr;
2475     int sign;
2476
2477     if (is_uv)
2478         sign = 0;
2479     else if (iv >= 0) {
2480         uv = iv;
2481         sign = 0;
2482     } else {
2483         uv = -iv;
2484         sign = 1;
2485     }
2486     do {
2487         *--ptr = '0' + (char)(uv % 10);
2488     } while (uv /= 10);
2489     if (sign)
2490         *--ptr = '-';
2491     *peob = ebuf;
2492     return ptr;
2493 }
2494
2495 /*
2496 =for apidoc sv_2pv_flags
2497
2498 Returns a pointer to the string value of an SV, and sets *lp to its length.
2499 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2500 if necessary.
2501 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2502 usually end up here too.
2503
2504 =cut
2505 */
2506
2507 char *
2508 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2509 {
2510     register char *s;
2511     int olderrno;
2512     SV *tsv, *origsv;
2513     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
2514     char *tmpbuf = tbuf;
2515     STRLEN len = 0;     /* Hush gcc. len is always initialised before use.  */
2516
2517     if (!sv) {
2518         if (lp)
2519             *lp = 0;
2520         return (char *)"";
2521     }
2522     if (SvGMAGICAL(sv)) {
2523         if (flags & SV_GMAGIC)
2524             mg_get(sv);
2525         if (SvPOKp(sv)) {
2526             if (lp)
2527                 *lp = SvCUR(sv);
2528             if (flags & SV_MUTABLE_RETURN)
2529                 return SvPVX_mutable(sv);
2530             if (flags & SV_CONST_RETURN)
2531                 return (char *)SvPVX_const(sv);
2532             return SvPVX(sv);
2533         }
2534         if (SvIOKp(sv)) {
2535             len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2536                 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2537             tsv = Nullsv;
2538             goto tokensave_has_len;
2539         }
2540         if (SvNOKp(sv)) {
2541             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2542             tsv = Nullsv;
2543             goto tokensave;
2544         }
2545         if (!SvROK(sv)) {
2546             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2547                 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2548                     report_uninit(sv);
2549             }
2550             if (lp)
2551                 *lp = 0;
2552             return (char *)"";
2553         }
2554     }
2555     if (SvTHINKFIRST(sv)) {
2556         if (SvROK(sv)) {
2557             SV* tmpstr;
2558             register const char *typestr;
2559             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2560                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2561                 /* Unwrap this:  */
2562                 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2563
2564                 char *pv;
2565                 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2566                     if (flags & SV_CONST_RETURN) {
2567                         pv = (char *) SvPVX_const(tmpstr);
2568                     } else {
2569                         pv = (flags & SV_MUTABLE_RETURN)
2570                             ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2571                     }
2572                     if (lp)
2573                         *lp = SvCUR(tmpstr);
2574                 } else {
2575                     pv = sv_2pv_flags(tmpstr, lp, flags);
2576                 }
2577                 if (SvUTF8(tmpstr))
2578                     SvUTF8_on(sv);
2579                 else
2580                     SvUTF8_off(sv);
2581                 return pv;
2582             }
2583             origsv = sv;
2584             sv = (SV*)SvRV(sv);
2585             if (!sv)
2586                 typestr = "NULLREF";
2587             else {
2588                 MAGIC *mg;
2589                 
2590                 if (SvTYPE(sv) == SVt_PVMG && ((SvFLAGS(sv) &
2591                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2592                           == (SVs_OBJECT|SVs_SMG))
2593                     && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2594                     const regexp *re = (regexp *)mg->mg_obj;
2595
2596                     if (!mg->mg_ptr) {
2597                         const char *fptr = "msix";
2598                         char reflags[6];
2599                         char ch;
2600                         int left = 0;
2601                         int right = 4;
2602                         char need_newline = 0;
2603                         U16 reganch =
2604                             (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2605
2606                         while((ch = *fptr++)) {
2607                             if(reganch & 1) {
2608                                 reflags[left++] = ch;
2609                             }
2610                             else {
2611                                 reflags[right--] = ch;
2612                             }
2613                             reganch >>= 1;
2614                         }
2615                         if(left != 4) {
2616                             reflags[left] = '-';
2617                             left = 5;
2618                         }
2619
2620                         mg->mg_len = re->prelen + 4 + left;
2621                         /*
2622                          * If /x was used, we have to worry about a regex
2623                          * ending with a comment later being embedded
2624                          * within another regex. If so, we don't want this
2625                          * regex's "commentization" to leak out to the
2626                          * right part of the enclosing regex, we must cap
2627                          * it with a newline.
2628                          *
2629                          * So, if /x was used, we scan backwards from the
2630                          * end of the regex. If we find a '#' before we
2631                          * find a newline, we need to add a newline
2632                          * ourself. If we find a '\n' first (or if we
2633                          * don't find '#' or '\n'), we don't need to add
2634                          * anything.  -jfriedl
2635                          */
2636                         if (PMf_EXTENDED & re->reganch) {
2637                             const char *endptr = re->precomp + re->prelen;
2638                             while (endptr >= re->precomp) {
2639                                 const char c = *(endptr--);
2640                                 if (c == '\n')
2641                                     break; /* don't need another */
2642                                 if (c == '#') {
2643                                     /* we end while in a comment, so we
2644                                        need a newline */
2645                                     mg->mg_len++; /* save space for it */
2646                                     need_newline = 1; /* note to add it */
2647                                     break;
2648                                 }
2649                             }
2650                         }
2651
2652                         Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2653                         Copy("(?", mg->mg_ptr, 2, char);
2654                         Copy(reflags, mg->mg_ptr+2, left, char);
2655                         Copy(":", mg->mg_ptr+left+2, 1, char);
2656                         Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2657                         if (need_newline)
2658                             mg->mg_ptr[mg->mg_len - 2] = '\n';
2659                         mg->mg_ptr[mg->mg_len - 1] = ')';
2660                         mg->mg_ptr[mg->mg_len] = 0;
2661                     }
2662                     PL_reginterp_cnt += re->program[0].next_off;
2663
2664                     if (re->reganch & ROPT_UTF8)
2665                         SvUTF8_on(origsv);
2666                     else
2667                         SvUTF8_off(origsv);
2668                     if (lp)
2669                         *lp = mg->mg_len;
2670                     return mg->mg_ptr;
2671                 }
2672
2673                 typestr = sv_reftype(sv, 0);
2674
2675                 tsv = sv_newmortal();
2676                 if (SvOBJECT(sv)) {
2677                     const char * const name = HvNAME_get(SvSTASH(sv));
2678                     Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2679                                    name ? name : "__ANON__" , typestr, PTR2UV(sv));
2680                 }
2681                 else
2682                     Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
2683                 if (lp)
2684                     *lp = SvCUR(tsv);
2685                 return SvPVX(tsv);
2686             }
2687             if (lp)
2688                 *lp = strlen(typestr);
2689             return (char *)typestr;
2690         }
2691         if (SvREADONLY(sv) && !SvOK(sv)) {
2692             if (ckWARN(WARN_UNINITIALIZED))
2693                 report_uninit(sv);
2694             if (lp)
2695                 *lp = 0;
2696             return (char *)"";
2697         }
2698     }
2699     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2700         /* I'm assuming that if both IV and NV are equally valid then
2701            converting the IV is going to be more efficient */
2702         const U32 isIOK = SvIOK(sv);
2703         const U32 isUIOK = SvIsUV(sv);
2704         char buf[TYPE_CHARS(UV)];
2705         char *ebuf, *ptr;
2706
2707         if (SvTYPE(sv) < SVt_PVIV)
2708             sv_upgrade(sv, SVt_PVIV);
2709         if (isUIOK)
2710             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2711         else
2712             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2713         /* inlined from sv_setpvn */
2714         SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2715         Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2716         SvCUR_set(sv, ebuf - ptr);
2717         s = SvEND(sv);
2718         *s = '\0';
2719         if (isIOK)
2720             SvIOK_on(sv);
2721         else
2722             SvIOKp_on(sv);
2723         if (isUIOK)
2724             SvIsUV_on(sv);
2725     }
2726     else if (SvNOKp(sv)) {
2727         if (SvTYPE(sv) < SVt_PVNV)
2728             sv_upgrade(sv, SVt_PVNV);
2729         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2730         s = SvGROW_mutable(sv, NV_DIG + 20);
2731         olderrno = errno;       /* some Xenix systems wipe out errno here */
2732 #ifdef apollo
2733         if (SvNVX(sv) == 0.0)
2734             (void)strcpy(s,"0");
2735         else
2736 #endif /*apollo*/
2737         {
2738             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2739         }
2740         errno = olderrno;
2741 #ifdef FIXNEGATIVEZERO
2742         if (*s == '-' && s[1] == '0' && !s[2])
2743             strcpy(s,"0");
2744 #endif
2745         while (*s) s++;
2746 #ifdef hcx
2747         if (s[-1] == '.')
2748             *--s = '\0';
2749 #endif
2750     }
2751     else {
2752         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2753             report_uninit(sv);
2754         if (lp)
2755         *lp = 0;
2756         if (SvTYPE(sv) < SVt_PV)
2757             /* Typically the caller expects that sv_any is not NULL now.  */
2758             sv_upgrade(sv, SVt_PV);
2759         return (char *)"";
2760     }
2761     {
2762         const STRLEN len = s - SvPVX_const(sv);
2763         if (lp) 
2764             *lp = len;
2765         SvCUR_set(sv, len);
2766     }
2767     SvPOK_on(sv);
2768     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2769                           PTR2UV(sv),SvPVX_const(sv)));
2770     if (flags & SV_CONST_RETURN)
2771         return (char *)SvPVX_const(sv);
2772     if (flags & SV_MUTABLE_RETURN)
2773         return SvPVX_mutable(sv);
2774     return SvPVX(sv);
2775
2776   tokensave:
2777     len = strlen(tmpbuf);
2778  tokensave_has_len:
2779     assert (!tsv);
2780     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
2781         /* Sneaky stuff here */
2782
2783         if (!tsv)
2784             tsv = newSVpvn(tmpbuf, len);
2785         sv_2mortal(tsv);
2786         if (lp)
2787             *lp = SvCUR(tsv);
2788         return SvPVX(tsv);
2789     }
2790     else {
2791         dVAR;
2792
2793 #ifdef FIXNEGATIVEZERO
2794         if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2795             tmpbuf[0] = '0';
2796             tmpbuf[1] = 0;
2797             len = 1;
2798         }
2799 #endif
2800         SvUPGRADE(sv, SVt_PV);
2801         if (lp)
2802             *lp = len;
2803         s = SvGROW_mutable(sv, len + 1);
2804         SvCUR_set(sv, len);
2805         SvPOKp_on(sv);
2806         return memcpy(s, tmpbuf, len + 1);
2807     }
2808 }
2809
2810 /*
2811 =for apidoc sv_copypv
2812
2813 Copies a stringified representation of the source SV into the
2814 destination SV.  Automatically performs any necessary mg_get and
2815 coercion of numeric values into strings.  Guaranteed to preserve
2816 UTF-8 flag even from overloaded objects.  Similar in nature to
2817 sv_2pv[_flags] but operates directly on an SV instead of just the
2818 string.  Mostly uses sv_2pv_flags to do its work, except when that
2819 would lose the UTF-8'ness of the PV.
2820
2821 =cut
2822 */
2823
2824 void
2825 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2826 {
2827     STRLEN len;
2828     const char * const s = SvPV_const(ssv,len);
2829     sv_setpvn(dsv,s,len);
2830     if (SvUTF8(ssv))
2831         SvUTF8_on(dsv);
2832     else
2833         SvUTF8_off(dsv);
2834 }
2835
2836 /*
2837 =for apidoc sv_2pvbyte
2838
2839 Return a pointer to the byte-encoded representation of the SV, and set *lp
2840 to its length.  May cause the SV to be downgraded from UTF-8 as a
2841 side-effect.
2842
2843 Usually accessed via the C<SvPVbyte> macro.
2844
2845 =cut
2846 */
2847
2848 char *
2849 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2850 {
2851     sv_utf8_downgrade(sv,0);
2852     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2853 }
2854
2855 /*
2856 =for apidoc sv_2pvutf8
2857
2858 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2859 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2860
2861 Usually accessed via the C<SvPVutf8> macro.
2862
2863 =cut
2864 */
2865
2866 char *
2867 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2868 {
2869     sv_utf8_upgrade(sv);
2870     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2871 }
2872
2873
2874 /*
2875 =for apidoc sv_2bool
2876
2877 This function is only called on magical items, and is only used by
2878 sv_true() or its macro equivalent.
2879
2880 =cut
2881 */
2882
2883 bool
2884 Perl_sv_2bool(pTHX_ register SV *sv)
2885 {
2886     SvGETMAGIC(sv);
2887
2888     if (!SvOK(sv))
2889         return 0;
2890     if (SvROK(sv)) {
2891         SV* tmpsv;
2892         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2893                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2894             return (bool)SvTRUE(tmpsv);
2895       return SvRV(sv) != 0;
2896     }
2897     if (SvPOKp(sv)) {
2898         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2899         if (Xpvtmp &&
2900                 (*sv->sv_u.svu_pv > '0' ||
2901                 Xpvtmp->xpv_cur > 1 ||
2902                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2903             return 1;
2904         else
2905             return 0;
2906     }
2907     else {
2908         if (SvIOKp(sv))
2909             return SvIVX(sv) != 0;
2910         else {
2911             if (SvNOKp(sv))
2912                 return SvNVX(sv) != 0.0;
2913             else
2914                 return FALSE;
2915         }
2916     }
2917 }
2918
2919 /*
2920 =for apidoc sv_utf8_upgrade
2921
2922 Converts the PV of an SV to its UTF-8-encoded form.
2923 Forces the SV to string form if it is not already.
2924 Always sets the SvUTF8 flag to avoid future validity checks even
2925 if all the bytes have hibit clear.
2926
2927 This is not as a general purpose byte encoding to Unicode interface:
2928 use the Encode extension for that.
2929
2930 =for apidoc sv_utf8_upgrade_flags
2931
2932 Converts the PV of an SV to its UTF-8-encoded form.
2933 Forces the SV to string form if it is not already.
2934 Always sets the SvUTF8 flag to avoid future validity checks even
2935 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2936 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2937 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2938
2939 This is not as a general purpose byte encoding to Unicode interface:
2940 use the Encode extension for that.
2941
2942 =cut
2943 */
2944
2945 STRLEN
2946 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2947 {
2948     if (sv == &PL_sv_undef)
2949         return 0;
2950     if (!SvPOK(sv)) {
2951         STRLEN len = 0;
2952         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2953             (void) sv_2pv_flags(sv,&len, flags);
2954             if (SvUTF8(sv))
2955                 return len;
2956         } else {
2957             (void) SvPV_force(sv,len);
2958         }
2959     }
2960
2961     if (SvUTF8(sv)) {
2962         return SvCUR(sv);
2963     }
2964
2965     if (SvIsCOW(sv)) {
2966         sv_force_normal_flags(sv, 0);
2967     }
2968
2969     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2970         sv_recode_to_utf8(sv, PL_encoding);
2971     else { /* Assume Latin-1/EBCDIC */
2972         /* This function could be much more efficient if we
2973          * had a FLAG in SVs to signal if there are any hibit
2974          * chars in the PV.  Given that there isn't such a flag
2975          * make the loop as fast as possible. */
2976         const U8 *s = (U8 *) SvPVX_const(sv);
2977         const U8 * const e = (U8 *) SvEND(sv);
2978         const U8 *t = s;
2979         int hibit = 0;
2980         
2981         while (t < e) {
2982             const U8 ch = *t++;
2983             if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2984                 break;
2985         }
2986         if (hibit) {
2987             STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2988             U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2989
2990             SvPV_free(sv); /* No longer using what was there before. */
2991
2992             SvPV_set(sv, (char*)recoded);
2993             SvCUR_set(sv, len - 1);
2994             SvLEN_set(sv, len); /* No longer know the real size. */
2995         }
2996         /* Mark as UTF-8 even if no hibit - saves scanning loop */
2997         SvUTF8_on(sv);
2998     }
2999     return SvCUR(sv);
3000 }
3001
3002 /*
3003 =for apidoc sv_utf8_downgrade
3004
3005 Attempts to convert the PV of an SV from characters to bytes.
3006 If the PV contains a character beyond byte, this conversion will fail;
3007 in this case, either returns false or, if C<fail_ok> is not
3008 true, croaks.
3009
3010 This is not as a general purpose Unicode to byte encoding interface:
3011 use the Encode extension for that.
3012
3013 =cut
3014 */
3015
3016 bool
3017 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3018 {
3019     if (SvPOKp(sv) && SvUTF8(sv)) {
3020         if (SvCUR(sv)) {
3021             U8 *s;
3022             STRLEN len;
3023
3024             if (SvIsCOW(sv)) {
3025                 sv_force_normal_flags(sv, 0);
3026             }
3027             s = (U8 *) SvPV(sv, len);
3028             if (!utf8_to_bytes(s, &len)) {
3029                 if (fail_ok)
3030                     return FALSE;
3031                 else {
3032                     if (PL_op)
3033                         Perl_croak(aTHX_ "Wide character in %s",
3034                                    OP_DESC(PL_op));
3035                     else
3036                         Perl_croak(aTHX_ "Wide character");
3037                 }
3038             }
3039             SvCUR_set(sv, len);
3040         }
3041     }
3042     SvUTF8_off(sv);
3043     return TRUE;
3044 }
3045
3046 /*
3047 =for apidoc sv_utf8_encode
3048
3049 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3050 flag off so that it looks like octets again.
3051
3052 =cut
3053 */
3054
3055 void
3056 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3057 {
3058     (void) sv_utf8_upgrade(sv);
3059     if (SvIsCOW(sv)) {
3060         sv_force_normal_flags(sv, 0);
3061     }
3062     if (SvREADONLY(sv)) {
3063         Perl_croak(aTHX_ PL_no_modify);
3064     }
3065     SvUTF8_off(sv);
3066 }
3067
3068 /*
3069 =for apidoc sv_utf8_decode
3070
3071 If the PV of the SV is an octet sequence in UTF-8
3072 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3073 so that it looks like a character. If the PV contains only single-byte
3074 characters, the C<SvUTF8> flag stays being off.
3075 Scans PV for validity and returns false if the PV is invalid UTF-8.
3076
3077 =cut
3078 */
3079
3080 bool
3081 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3082 {
3083     if (SvPOKp(sv)) {
3084         const U8 *c;
3085         const U8 *e;
3086
3087         /* The octets may have got themselves encoded - get them back as
3088          * bytes
3089          */
3090         if (!sv_utf8_downgrade(sv, TRUE))
3091             return FALSE;
3092
3093         /* it is actually just a matter of turning the utf8 flag on, but
3094          * we want to make sure everything inside is valid utf8 first.
3095          */
3096         c = (const U8 *) SvPVX_const(sv);
3097         if (!is_utf8_string(c, SvCUR(sv)+1))
3098             return FALSE;
3099         e = (const U8 *) SvEND(sv);
3100         while (c < e) {
3101             const U8 ch = *c++;
3102             if (!UTF8_IS_INVARIANT(ch)) {
3103                 SvUTF8_on(sv);
3104                 break;
3105             }
3106         }
3107     }
3108     return TRUE;
3109 }
3110
3111 /*
3112 =for apidoc sv_setsv
3113
3114 Copies the contents of the source SV C<ssv> into the destination SV
3115 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3116 function if the source SV needs to be reused. Does not handle 'set' magic.
3117 Loosely speaking, it performs a copy-by-value, obliterating any previous
3118 content of the destination.
3119
3120 You probably want to use one of the assortment of wrappers, such as
3121 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3122 C<SvSetMagicSV_nosteal>.
3123
3124 =for apidoc sv_setsv_flags
3125
3126 Copies the contents of the source SV C<ssv> into the destination SV
3127 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3128 function if the source SV needs to be reused. Does not handle 'set' magic.
3129 Loosely speaking, it performs a copy-by-value, obliterating any previous
3130 content of the destination.
3131 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3132 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3133 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3134 and C<sv_setsv_nomg> are implemented in terms of this function.
3135
3136 You probably want to use one of the assortment of wrappers, such as
3137 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3138 C<SvSetMagicSV_nosteal>.
3139
3140 This is the primary function for copying scalars, and most other
3141 copy-ish functions and macros use this underneath.
3142
3143 =cut
3144 */
3145
3146 void
3147 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3148 {
3149     register U32 sflags;
3150     register int dtype;
3151     register int stype;
3152
3153     if (sstr == dstr)
3154         return;
3155     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3156     if (!sstr)
3157         sstr = &PL_sv_undef;
3158     stype = SvTYPE(sstr);
3159     dtype = SvTYPE(dstr);
3160
3161     SvAMAGIC_off(dstr);
3162     if ( SvVOK(dstr) )
3163     {
3164         /* need to nuke the magic */
3165         mg_free(dstr);
3166         SvRMAGICAL_off(dstr);
3167     }
3168
3169     /* There's a lot of redundancy below but we're going for speed here */
3170
3171     switch (stype) {
3172     case SVt_NULL:
3173       undef_sstr:
3174         if (dtype != SVt_PVGV) {
3175             (void)SvOK_off(dstr);
3176             return;
3177         }
3178         break;
3179     case SVt_IV:
3180         if (SvIOK(sstr)) {
3181             switch (dtype) {
3182             case SVt_NULL:
3183                 sv_upgrade(dstr, SVt_IV);
3184                 break;
3185             case SVt_NV:
3186                 sv_upgrade(dstr, SVt_PVNV);
3187                 break;
3188             case SVt_RV:
3189             case SVt_PV:
3190                 sv_upgrade(dstr, SVt_PVIV);
3191                 break;
3192             }
3193             (void)SvIOK_only(dstr);
3194             SvIV_set(dstr,  SvIVX(sstr));
3195             if (SvIsUV(sstr))
3196                 SvIsUV_on(dstr);
3197             if (SvTAINTED(sstr))
3198                 SvTAINT(dstr);
3199             return;
3200         }
3201         goto undef_sstr;
3202
3203     case SVt_NV:
3204         if (SvNOK(sstr)) {
3205             switch (dtype) {
3206             case SVt_NULL:
3207             case SVt_IV:
3208                 sv_upgrade(dstr, SVt_NV);
3209                 break;
3210             case SVt_RV:
3211             case SVt_PV:
3212             case SVt_PVIV:
3213                 sv_upgrade(dstr, SVt_PVNV);
3214                 break;
3215             }
3216             SvNV_set(dstr, SvNVX(sstr));
3217             (void)SvNOK_only(dstr);
3218             if (SvTAINTED(sstr))
3219                 SvTAINT(dstr);
3220             return;
3221         }
3222         goto undef_sstr;
3223
3224     case SVt_RV:
3225         if (dtype < SVt_RV)
3226             sv_upgrade(dstr, SVt_RV);
3227         else if (dtype == SVt_PVGV &&
3228                  SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3229             sstr = SvRV(sstr);
3230             if (sstr == dstr) {
3231                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3232                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3233                 {
3234                     GvIMPORTED_on(dstr);
3235                 }
3236                 GvMULTI_on(dstr);
3237                 return;
3238             }
3239             goto glob_assign;
3240         }
3241         break;
3242     case SVt_PVFM:
3243 #ifdef PERL_OLD_COPY_ON_WRITE
3244         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3245             if (dtype < SVt_PVIV)
3246                 sv_upgrade(dstr, SVt_PVIV);
3247             break;
3248         }
3249         /* Fall through */
3250 #endif
3251     case SVt_PV:
3252         if (dtype < SVt_PV)
3253             sv_upgrade(dstr, SVt_PV);
3254         break;
3255     case SVt_PVIV:
3256         if (dtype < SVt_PVIV)
3257             sv_upgrade(dstr, SVt_PVIV);
3258         break;
3259     case SVt_PVNV:
3260         if (dtype < SVt_PVNV)
3261             sv_upgrade(dstr, SVt_PVNV);
3262         break;
3263     case SVt_PVAV:
3264     case SVt_PVHV:
3265     case SVt_PVCV:
3266     case SVt_PVIO:
3267         {
3268         const char * const type = sv_reftype(sstr,0);
3269         if (PL_op)
3270             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3271         else
3272             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3273         }
3274         break;
3275
3276     case SVt_PVGV:
3277         if (dtype <= SVt_PVGV) {
3278   glob_assign:
3279             if (dtype != SVt_PVGV) {
3280                 const char * const name = GvNAME(sstr);
3281                 const STRLEN len = GvNAMELEN(sstr);
3282                 /* don't upgrade SVt_PVLV: it can hold a glob */
3283                 if (dtype != SVt_PVLV)
3284                     sv_upgrade(dstr, SVt_PVGV);
3285                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3286                 GvSTASH(dstr) = GvSTASH(sstr);
3287                 if (GvSTASH(dstr))
3288                     Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3289                 GvNAME(dstr) = savepvn(name, len);
3290                 GvNAMELEN(dstr) = len;
3291                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3292             }
3293
3294 #ifdef GV_UNIQUE_CHECK
3295                 if (GvUNIQUE((GV*)dstr)) {
3296                     Perl_croak(aTHX_ PL_no_modify);
3297                 }
3298 #endif
3299
3300             (void)SvOK_off(dstr);
3301             GvINTRO_off(dstr);          /* one-shot flag */
3302             gp_free((GV*)dstr);
3303             GvGP(dstr) = gp_ref(GvGP(sstr));
3304             if (SvTAINTED(sstr))
3305                 SvTAINT(dstr);
3306             if (GvIMPORTED(dstr) != GVf_IMPORTED
3307                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3308             {
3309                 GvIMPORTED_on(dstr);
3310             }
3311             GvMULTI_on(dstr);
3312             return;
3313         }
3314         /* FALL THROUGH */
3315
3316     default:
3317         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3318             mg_get(sstr);
3319             if ((int)SvTYPE(sstr) != stype) {
3320                 stype = SvTYPE(sstr);
3321                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3322                     goto glob_assign;
3323             }
3324         }
3325         if (stype == SVt_PVLV)
3326             SvUPGRADE(dstr, SVt_PVNV);
3327         else
3328             SvUPGRADE(dstr, (U32)stype);
3329     }
3330
3331     sflags = SvFLAGS(sstr);
3332
3333     if (sflags & SVf_ROK) {
3334         if (dtype >= SVt_PV) {
3335             if (dtype == SVt_PVGV) {
3336                 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3337                 SV *dref = 0;
3338                 const int intro = GvINTRO(dstr);
3339
3340 #ifdef GV_UNIQUE_CHECK
3341                 if (GvUNIQUE((GV*)dstr)) {
3342                     Perl_croak(aTHX_ PL_no_modify);
3343                 }
3344 #endif
3345
3346                 if (intro) {
3347                     GvINTRO_off(dstr);  /* one-shot flag */
3348                     GvLINE(dstr) = CopLINE(PL_curcop);
3349                     GvEGV(dstr) = (GV*)dstr;
3350                 }
3351                 GvMULTI_on(dstr);
3352                 switch (SvTYPE(sref)) {
3353                 case SVt_PVAV:
3354                     if (intro)
3355                         SAVEGENERICSV(GvAV(dstr));
3356                     else
3357                         dref = (SV*)GvAV(dstr);
3358                     GvAV(dstr) = (AV*)sref;
3359                     if (!GvIMPORTED_AV(dstr)
3360                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3361                     {
3362                         GvIMPORTED_AV_on(dstr);
3363                     }
3364                     break;
3365                 case SVt_PVHV:
3366                     if (intro)
3367                         SAVEGENERICSV(GvHV(dstr));
3368                     else
3369                         dref = (SV*)GvHV(dstr);
3370                     GvHV(dstr) = (HV*)sref;
3371                     if (!GvIMPORTED_HV(dstr)
3372                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3373                     {
3374                         GvIMPORTED_HV_on(dstr);
3375                     }
3376                     break;
3377                 case SVt_PVCV:
3378                     if (intro) {
3379                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3380                             SvREFCNT_dec(GvCV(dstr));
3381                             GvCV(dstr) = Nullcv;
3382                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3383                             PL_sub_generation++;
3384                         }
3385                         SAVEGENERICSV(GvCV(dstr));
3386                     }
3387                     else
3388                         dref = (SV*)GvCV(dstr);
3389                     if (GvCV(dstr) != (CV*)sref) {
3390                         CV* const cv = GvCV(dstr);
3391                         if (cv) {
3392                             if (!GvCVGEN((GV*)dstr) &&
3393                                 (CvROOT(cv) || CvXSUB(cv)))
3394                             {
3395                                 /* Redefining a sub - warning is mandatory if
3396                                    it was a const and its value changed. */
3397                                 if (ckWARN(WARN_REDEFINE)
3398                                     || (CvCONST(cv)
3399                                         && (!CvCONST((CV*)sref)
3400                                             || sv_cmp(cv_const_sv(cv),
3401                                                       cv_const_sv((CV*)sref)))))
3402                                 {
3403                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3404                                         CvCONST(cv)
3405                                         ? "Constant subroutine %s::%s redefined"
3406                                         : "Subroutine %s::%s redefined",
3407                                         HvNAME_get(GvSTASH((GV*)dstr)),
3408                                         GvENAME((GV*)dstr));
3409                                 }
3410                             }
3411                             if (!intro)
3412                                 cv_ckproto(cv, (GV*)dstr,
3413                                            SvPOK(sref)
3414                                            ? SvPVX_const(sref) : Nullch);
3415                         }
3416                         GvCV(dstr) = (CV*)sref;
3417                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3418                         GvASSUMECV_on(dstr);
3419                         PL_sub_generation++;
3420                     }
3421                     if (!GvIMPORTED_CV(dstr)
3422                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3423                     {
3424                         GvIMPORTED_CV_on(dstr);
3425                     }
3426                     break;
3427                 case SVt_PVIO:
3428                     if (intro)
3429                         SAVEGENERICSV(GvIOp(dstr));
3430                     else
3431                         dref = (SV*)GvIOp(dstr);
3432                     GvIOp(dstr) = (IO*)sref;
3433                     break;
3434                 case SVt_PVFM:
3435                     if (intro)
3436                         SAVEGENERICSV(GvFORM(dstr));
3437                     else
3438                         dref = (SV*)GvFORM(dstr);
3439                     GvFORM(dstr) = (CV*)sref;
3440                     break;
3441                 default:
3442                     if (intro)
3443                         SAVEGENERICSV(GvSV(dstr));
3444                     else
3445                         dref = (SV*)GvSV(dstr);
3446                     GvSV(dstr) = sref;
3447                     if (!GvIMPORTED_SV(dstr)
3448                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3449                     {
3450                         GvIMPORTED_SV_on(dstr);
3451                     }
3452                     break;
3453                 }
3454                 if (dref)
3455                     SvREFCNT_dec(dref);
3456                 if (SvTAINTED(sstr))
3457                     SvTAINT(dstr);
3458                 return;
3459             }
3460             if (SvPVX_const(dstr)) {
3461                 SvPV_free(dstr);
3462                 SvLEN_set(dstr, 0);
3463                 SvCUR_set(dstr, 0);
3464             }
3465         }
3466         (void)SvOK_off(dstr);
3467         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3468         SvROK_on(dstr);
3469         if (sflags & SVp_NOK) {
3470             SvNOKp_on(dstr);
3471             /* Only set the public OK flag if the source has public OK.  */
3472             if (sflags & SVf_NOK)
3473                 SvFLAGS(dstr) |= SVf_NOK;
3474             SvNV_set(dstr, SvNVX(sstr));
3475         }
3476         if (sflags & SVp_IOK) {
3477             (void)SvIOKp_on(dstr);
3478             if (sflags & SVf_IOK)
3479                 SvFLAGS(dstr) |= SVf_IOK;
3480             if (sflags & SVf_IVisUV)
3481                 SvIsUV_on(dstr);
3482             SvIV_set(dstr, SvIVX(sstr));
3483         }
3484         if (SvAMAGIC(sstr)) {
3485             SvAMAGIC_on(dstr);
3486         }
3487     }
3488     else if (sflags & SVp_POK) {
3489         bool isSwipe = 0;
3490
3491         /*
3492          * Check to see if we can just swipe the string.  If so, it's a
3493          * possible small lose on short strings, but a big win on long ones.
3494          * It might even be a win on short strings if SvPVX_const(dstr)
3495          * has to be allocated and SvPVX_const(sstr) has to be freed.
3496          */
3497
3498         /* Whichever path we take through the next code, we want this true,
3499            and doing it now facilitates the COW check.  */
3500         (void)SvPOK_only(dstr);
3501
3502         if (
3503             /* We're not already COW  */
3504             ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3505 #ifndef PERL_OLD_COPY_ON_WRITE
3506              /* or we are, but dstr isn't a suitable target.  */
3507              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3508 #endif
3509              )
3510             &&
3511             !(isSwipe =
3512                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3513                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3514                  (!(flags & SV_NOSTEAL)) &&
3515                                         /* and we're allowed to steal temps */
3516                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3517                  SvLEN(sstr)    &&        /* and really is a string */
3518                                 /* and won't be needed again, potentially */
3519               !(PL_op && PL_op->op_type == OP_AASSIGN))
3520 #ifdef PERL_OLD_COPY_ON_WRITE
3521             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3522                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3523                  && SvTYPE(sstr) >= SVt_PVIV)
3524 #endif
3525             ) {
3526             /* Failed the swipe test, and it's not a shared hash key either.
3527                Have to copy the string.  */
3528             STRLEN len = SvCUR(sstr);
3529             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3530             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3531             SvCUR_set(dstr, len);
3532             *SvEND(dstr) = '\0';
3533         } else {
3534             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3535                be true in here.  */
3536             /* Either it's a shared hash key, or it's suitable for
3537                copy-on-write or we can swipe the string.  */
3538             if (DEBUG_C_TEST) {
3539                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3540                 sv_dump(sstr);
3541                 sv_dump(dstr);
3542             }
3543 #ifdef PERL_OLD_COPY_ON_WRITE
3544             if (!isSwipe) {
3545                 /* I believe I should acquire a global SV mutex if
3546                    it's a COW sv (not a shared hash key) to stop
3547                    it going un copy-on-write.
3548                    If the source SV has gone un copy on write between up there
3549                    and down here, then (assert() that) it is of the correct
3550                    form to make it copy on write again */
3551                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3552                     != (SVf_FAKE | SVf_READONLY)) {
3553                     SvREADONLY_on(sstr);
3554                     SvFAKE_on(sstr);
3555                     /* Make the source SV into a loop of 1.
3556                        (about to become 2) */
3557                     SV_COW_NEXT_SV_SET(sstr, sstr);
3558                 }
3559             }
3560 #endif
3561             /* Initial code is common.  */
3562             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3563                 SvPV_free(dstr);
3564             }
3565
3566             if (!isSwipe) {
3567                 /* making another shared SV.  */
3568                 STRLEN cur = SvCUR(sstr);
3569                 STRLEN len = SvLEN(sstr);
3570 #ifdef PERL_OLD_COPY_ON_WRITE
3571                 if (len) {
3572                     assert (SvTYPE(dstr) >= SVt_PVIV);
3573                     /* SvIsCOW_normal */
3574                     /* splice us in between source and next-after-source.  */
3575                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3576                     SV_COW_NEXT_SV_SET(sstr, dstr);
3577                     SvPV_set(dstr, SvPVX_mutable(sstr));
3578                 } else
3579 #endif
3580                 {
3581                     /* SvIsCOW_shared_hash */
3582                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3583                                           "Copy on write: Sharing hash\n"));
3584
3585                     assert (SvTYPE(dstr) >= SVt_PV);
3586                     SvPV_set(dstr,
3587                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3588                 }
3589                 SvLEN_set(dstr, len);
3590                 SvCUR_set(dstr, cur);
3591                 SvREADONLY_on(dstr);
3592                 SvFAKE_on(dstr);
3593                 /* Relesase a global SV mutex.  */
3594             }
3595             else
3596                 {       /* Passes the swipe test.  */
3597                 SvPV_set(dstr, SvPVX_mutable(sstr));
3598                 SvLEN_set(dstr, SvLEN(sstr));
3599                 SvCUR_set(dstr, SvCUR(sstr));
3600
3601                 SvTEMP_off(dstr);
3602                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3603                 SvPV_set(sstr, Nullch);
3604                 SvLEN_set(sstr, 0);
3605                 SvCUR_set(sstr, 0);
3606                 SvTEMP_off(sstr);
3607             }
3608         }
3609         if (sflags & SVf_UTF8)
3610             SvUTF8_on(dstr);
3611         if (sflags & SVp_NOK) {
3612             SvNOKp_on(dstr);
3613             if (sflags & SVf_NOK)
3614                 SvFLAGS(dstr) |= SVf_NOK;
3615             SvNV_set(dstr, SvNVX(sstr));
3616         }
3617         if (sflags & SVp_IOK) {
3618             (void)SvIOKp_on(dstr);
3619             if (sflags & SVf_IOK)
3620                 SvFLAGS(dstr) |= SVf_IOK;
3621             if (sflags & SVf_IVisUV)
3622                 SvIsUV_on(dstr);
3623             SvIV_set(dstr, SvIVX(sstr));
3624         }
3625         if (SvVOK(sstr)) {
3626             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3627             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3628                         smg->mg_ptr, smg->mg_len);
3629             SvRMAGICAL_on(dstr);
3630         }
3631     }
3632     else if (sflags & SVp_IOK) {
3633         if (sflags & SVf_IOK)
3634             (void)SvIOK_only(dstr);
3635         else {
3636             (void)SvOK_off(dstr);
3637             (void)SvIOKp_on(dstr);
3638         }
3639         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3640         if (sflags & SVf_IVisUV)
3641             SvIsUV_on(dstr);
3642         SvIV_set(dstr, SvIVX(sstr));
3643         if (sflags & SVp_NOK) {
3644             if (sflags & SVf_NOK)
3645                 (void)SvNOK_on(dstr);
3646             else
3647                 (void)SvNOKp_on(dstr);
3648             SvNV_set(dstr, SvNVX(sstr));
3649         }
3650     }
3651     else if (sflags & SVp_NOK) {
3652         if (sflags & SVf_NOK)
3653             (void)SvNOK_only(dstr);
3654         else {
3655             (void)SvOK_off(dstr);
3656             SvNOKp_on(dstr);
3657         }
3658         SvNV_set(dstr, SvNVX(sstr));
3659     }
3660     else {
3661         if (dtype == SVt_PVGV) {
3662             if (ckWARN(WARN_MISC))
3663                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3664         }
3665         else
3666             (void)SvOK_off(dstr);
3667     }
3668     if (SvTAINTED(sstr))
3669         SvTAINT(dstr);
3670 }
3671
3672 /*
3673 =for apidoc sv_setsv_mg
3674
3675 Like C<sv_setsv>, but also handles 'set' magic.
3676
3677 =cut
3678 */
3679
3680 void
3681 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3682 {
3683     sv_setsv(dstr,sstr);
3684     SvSETMAGIC(dstr);
3685 }
3686
3687 #ifdef PERL_OLD_COPY_ON_WRITE
3688 SV *
3689 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3690 {
3691     STRLEN cur = SvCUR(sstr);
3692     STRLEN len = SvLEN(sstr);
3693     register char *new_pv;
3694
3695     if (DEBUG_C_TEST) {
3696         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3697                       sstr, dstr);
3698         sv_dump(sstr);
3699         if (dstr)
3700                     sv_dump(dstr);
3701     }
3702
3703     if (dstr) {
3704         if (SvTHINKFIRST(dstr))
3705             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3706         else if (SvPVX_const(dstr))
3707             Safefree(SvPVX_const(dstr));
3708     }
3709     else
3710         new_SV(dstr);
3711     SvUPGRADE(dstr, SVt_PVIV);
3712
3713     assert (SvPOK(sstr));
3714     assert (SvPOKp(sstr));
3715     assert (!SvIOK(sstr));
3716     assert (!SvIOKp(sstr));
3717     assert (!SvNOK(sstr));
3718     assert (!SvNOKp(sstr));
3719
3720     if (SvIsCOW(sstr)) {
3721
3722         if (SvLEN(sstr) == 0) {
3723             /* source is a COW shared hash key.  */
3724             DEBUG_C(PerlIO_printf(Perl_debug_log,
3725                                   "Fast copy on write: Sharing hash\n"));
3726             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3727             goto common_exit;
3728         }
3729         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3730     } else {
3731         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3732         SvUPGRADE(sstr, SVt_PVIV);
3733         SvREADONLY_on(sstr);
3734         SvFAKE_on(sstr);
3735         DEBUG_C(PerlIO_printf(Perl_debug_log,
3736                               "Fast copy on write: Converting sstr to COW\n"));
3737         SV_COW_NEXT_SV_SET(dstr, sstr);
3738     }
3739     SV_COW_NEXT_SV_SET(sstr, dstr);
3740     new_pv = SvPVX_mutable(sstr);
3741
3742   common_exit:
3743     SvPV_set(dstr, new_pv);
3744     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3745     if (SvUTF8(sstr))
3746         SvUTF8_on(dstr);
3747     SvLEN_set(dstr, len);
3748     SvCUR_set(dstr, cur);
3749     if (DEBUG_C_TEST) {
3750         sv_dump(dstr);
3751     }
3752     return dstr;
3753 }
3754 #endif
3755
3756 /*
3757 =for apidoc sv_setpvn
3758
3759 Copies a string into an SV.  The C<len> parameter indicates the number of
3760 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3761 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3762
3763 =cut
3764 */
3765
3766 void
3767 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3768 {
3769     register char *dptr;
3770
3771     SV_CHECK_THINKFIRST_COW_DROP(sv);
3772     if (!ptr) {
3773         (void)SvOK_off(sv);
3774         return;
3775     }
3776     else {
3777         /* len is STRLEN which is unsigned, need to copy to signed */
3778         const IV iv = len;
3779         if (iv < 0)
3780             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3781     }
3782     SvUPGRADE(sv, SVt_PV);
3783
3784     dptr = SvGROW(sv, len + 1);
3785     Move(ptr,dptr,len,char);
3786     dptr[len] = '\0';
3787     SvCUR_set(sv, len);
3788     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3789     SvTAINT(sv);
3790 }
3791
3792 /*
3793 =for apidoc sv_setpvn_mg
3794
3795 Like C<sv_setpvn>, but also handles 'set' magic.
3796
3797 =cut
3798 */
3799
3800 void
3801 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3802 {
3803     sv_setpvn(sv,ptr,len);
3804     SvSETMAGIC(sv);
3805 }
3806
3807 /*
3808 =for apidoc sv_setpv
3809
3810 Copies a string into an SV.  The string must be null-terminated.  Does not
3811 handle 'set' magic.  See C<sv_setpv_mg>.
3812
3813 =cut
3814 */
3815
3816 void
3817 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3818 {
3819     register STRLEN len;
3820
3821     SV_CHECK_THINKFIRST_COW_DROP(sv);
3822     if (!ptr) {
3823         (void)SvOK_off(sv);
3824         return;
3825     }
3826     len = strlen(ptr);
3827     SvUPGRADE(sv, SVt_PV);
3828
3829     SvGROW(sv, len + 1);
3830     Move(ptr,SvPVX(sv),len+1,char);
3831     SvCUR_set(sv, len);
3832     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3833     SvTAINT(sv);
3834 }
3835
3836 /*
3837 =for apidoc sv_setpv_mg
3838
3839 Like C<sv_setpv>, but also handles 'set' magic.
3840
3841 =cut
3842 */
3843
3844 void
3845 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3846 {
3847     sv_setpv(sv,ptr);
3848     SvSETMAGIC(sv);
3849 }
3850
3851 /*
3852 =for apidoc sv_usepvn
3853
3854 Tells an SV to use C<ptr> to find its string value.  Normally the string is
3855 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3856 The C<ptr> should point to memory that was allocated by C<malloc>.  The
3857 string length, C<len>, must be supplied.  This function will realloc the
3858 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3859 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
3860 See C<sv_usepvn_mg>.
3861
3862 =cut
3863 */
3864
3865 void
3866 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3867 {
3868     STRLEN allocate;
3869     SV_CHECK_THINKFIRST_COW_DROP(sv);
3870     SvUPGRADE(sv, SVt_PV);
3871     if (!ptr) {
3872         (void)SvOK_off(sv);
3873         return;
3874     }
3875     if (SvPVX_const(sv))
3876         SvPV_free(sv);
3877
3878     allocate = PERL_STRLEN_ROUNDUP(len + 1);
3879     ptr = saferealloc (ptr, allocate);
3880     SvPV_set(sv, ptr);
3881     SvCUR_set(sv, len);
3882     SvLEN_set(sv, allocate);
3883     *SvEND(sv) = '\0';
3884     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3885     SvTAINT(sv);
3886 }
3887
3888 /*
3889 =for apidoc sv_usepvn_mg
3890
3891 Like C<sv_usepvn>, but also handles 'set' magic.
3892
3893 =cut
3894 */
3895
3896 void
3897 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3898 {
3899     sv_usepvn(sv,ptr,len);
3900     SvSETMAGIC(sv);
3901 }
3902
3903 #ifdef PERL_OLD_COPY_ON_WRITE
3904 /* Need to do this *after* making the SV normal, as we need the buffer
3905    pointer to remain valid until after we've copied it.  If we let go too early,
3906    another thread could invalidate it by unsharing last of the same hash key
3907    (which it can do by means other than releasing copy-on-write Svs)
3908    or by changing the other copy-on-write SVs in the loop.  */
3909 STATIC void
3910 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3911 {
3912     if (len) { /* this SV was SvIsCOW_normal(sv) */
3913          /* we need to find the SV pointing to us.  */
3914         SV * const current = SV_COW_NEXT_SV(after);
3915
3916         if (current == sv) {
3917             /* The SV we point to points back to us (there were only two of us
3918                in the loop.)
3919                Hence other SV is no longer copy on write either.  */
3920             SvFAKE_off(after);
3921             SvREADONLY_off(after);
3922         } else {
3923             /* We need to follow the pointers around the loop.  */
3924             SV *next;
3925             while ((next = SV_COW_NEXT_SV(current)) != sv) {
3926                 assert (next);
3927                 current = next;
3928                  /* don't loop forever if the structure is bust, and we have
3929                     a pointer into a closed loop.  */
3930                 assert (current != after);
3931                 assert (SvPVX_const(current) == pvx);
3932             }
3933             /* Make the SV before us point to the SV after us.  */
3934             SV_COW_NEXT_SV_SET(current, after);
3935         }
3936     } else {
3937         unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3938     }
3939 }
3940
3941 int
3942 Perl_sv_release_IVX(pTHX_ register SV *sv)
3943 {
3944     if (SvIsCOW(sv))
3945         sv_force_normal_flags(sv, 0);
3946     SvOOK_off(sv);
3947     return 0;
3948 }
3949 #endif
3950 /*
3951 =for apidoc sv_force_normal_flags
3952
3953 Undo various types of fakery on an SV: if the PV is a shared string, make
3954 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3955 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3956 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3957 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3958 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3959 set to some other value.) In addition, the C<flags> parameter gets passed to
3960 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3961 with flags set to 0.
3962
3963 =cut
3964 */
3965
3966 void
3967 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3968 {
3969 #ifdef PERL_OLD_COPY_ON_WRITE
3970     if (SvREADONLY(sv)) {
3971         /* At this point I believe I should acquire a global SV mutex.  */
3972         if (SvFAKE(sv)) {
3973             const char * const pvx = SvPVX_const(sv);
3974             const STRLEN len = SvLEN(sv);
3975             const STRLEN cur = SvCUR(sv);
3976             SV * const next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
3977             if (DEBUG_C_TEST) {
3978                 PerlIO_printf(Perl_debug_log,
3979                               "Copy on write: Force normal %ld\n",
3980                               (long) flags);
3981                 sv_dump(sv);
3982             }
3983             SvFAKE_off(sv);
3984             SvREADONLY_off(sv);
3985             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
3986             SvPV_set(sv, (char*)0);
3987             SvLEN_set(sv, 0);
3988             if (flags & SV_COW_DROP_PV) {
3989                 /* OK, so we don't need to copy our buffer.  */
3990                 SvPOK_off(sv);
3991             } else {
3992                 SvGROW(sv, cur + 1);
3993                 Move(pvx,SvPVX(sv),cur,char);
3994                 SvCUR_set(sv, cur);
3995                 *SvEND(sv) = '\0';
3996             }
3997             sv_release_COW(sv, pvx, len, next);
3998             if (DEBUG_C_TEST) {
3999                 sv_dump(sv);
4000             }
4001         }
4002         else if (IN_PERL_RUNTIME)
4003             Perl_croak(aTHX_ PL_no_modify);
4004         /* At this point I believe that I can drop the global SV mutex.  */
4005     }
4006 #else
4007     if (SvREADONLY(sv)) {
4008         if (SvFAKE(sv)) {
4009             const char * const pvx = SvPVX_const(sv);
4010             const STRLEN len = SvCUR(sv);
4011             SvFAKE_off(sv);
4012             SvREADONLY_off(sv);
4013             SvPV_set(sv, Nullch);
4014             SvLEN_set(sv, 0);
4015             SvGROW(sv, len + 1);
4016             Move(pvx,SvPVX(sv),len,char);
4017             *SvEND(sv) = '\0';
4018             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4019         }
4020         else if (IN_PERL_RUNTIME)
4021             Perl_croak(aTHX_ PL_no_modify);
4022     }
4023 #endif
4024     if (SvROK(sv))
4025         sv_unref_flags(sv, flags);
4026     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4027         sv_unglob(sv);
4028 }
4029
4030 /*
4031 =for apidoc sv_chop
4032
4033 Efficient removal of characters from the beginning of the string buffer.
4034 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4035 the string buffer.  The C<ptr> becomes the first character of the adjusted
4036 string. Uses the "OOK hack".
4037 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4038 refer to the same chunk of data.
4039
4040 =cut
4041 */
4042
4043 void
4044 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4045 {
4046     register STRLEN delta;
4047     if (!ptr || !SvPOKp(sv))
4048         return;
4049     delta = ptr - SvPVX_const(sv);
4050     SV_CHECK_THINKFIRST(sv);
4051     if (SvTYPE(sv) < SVt_PVIV)
4052         sv_upgrade(sv,SVt_PVIV);
4053
4054     if (!SvOOK(sv)) {
4055         if (!SvLEN(sv)) { /* make copy of shared string */
4056             const char *pvx = SvPVX_const(sv);
4057             const STRLEN len = SvCUR(sv);
4058             SvGROW(sv, len + 1);
4059             Move(pvx,SvPVX(sv),len,char);
4060             *SvEND(sv) = '\0';
4061         }
4062         SvIV_set(sv, 0);
4063         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4064            and we do that anyway inside the SvNIOK_off
4065         */
4066         SvFLAGS(sv) |= SVf_OOK;
4067     }
4068     SvNIOK_off(sv);
4069     SvLEN_set(sv, SvLEN(sv) - delta);
4070     SvCUR_set(sv, SvCUR(sv) - delta);
4071     SvPV_set(sv, SvPVX(sv) + delta);
4072     SvIV_set(sv, SvIVX(sv) + delta);
4073 }
4074
4075 /*
4076 =for apidoc sv_catpvn
4077
4078 Concatenates the string onto the end of the string which is in the SV.  The
4079 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4080 status set, then the bytes appended should be valid UTF-8.
4081 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4082
4083 =for apidoc sv_catpvn_flags
4084
4085 Concatenates the string onto the end of the string which is in the SV.  The
4086 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4087 status set, then the bytes appended should be valid UTF-8.
4088 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4089 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4090 in terms of this function.
4091
4092 =cut
4093 */
4094
4095 void
4096 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4097 {
4098     STRLEN dlen;
4099     const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4100
4101     SvGROW(dsv, dlen + slen + 1);
4102     if (sstr == dstr)
4103         sstr = SvPVX_const(dsv);
4104     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4105     SvCUR_set(dsv, SvCUR(dsv) + slen);
4106     *SvEND(dsv) = '\0';
4107     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4108     SvTAINT(dsv);
4109     if (flags & SV_SMAGIC)
4110         SvSETMAGIC(dsv);
4111 }
4112
4113 /*
4114 =for apidoc sv_catsv
4115
4116 Concatenates the string from SV C<ssv> onto the end of the string in
4117 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4118 not 'set' magic.  See C<sv_catsv_mg>.
4119
4120 =for apidoc sv_catsv_flags
4121
4122 Concatenates the string from SV C<ssv> onto the end of the string in
4123 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4124 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4125 and C<sv_catsv_nomg> are implemented in terms of this function.
4126
4127 =cut */
4128
4129 void
4130 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4131 {
4132     const char *spv;
4133     STRLEN slen;
4134     if (ssv) {
4135         if ((spv = SvPV_const(ssv, slen))) {
4136             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4137                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4138                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4139                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4140                 dsv->sv_flags doesn't have that bit set.
4141                 Andy Dougherty  12 Oct 2001
4142             */
4143             const I32 sutf8 = DO_UTF8(ssv);
4144             I32 dutf8;
4145
4146             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4147                 mg_get(dsv);
4148             dutf8 = DO_UTF8(dsv);
4149
4150             if (dutf8 != sutf8) {
4151                 if (dutf8) {
4152                     /* Not modifying source SV, so taking a temporary copy. */
4153                     SV* csv = sv_2mortal(newSVpvn(spv, slen));
4154
4155                     sv_utf8_upgrade(csv);
4156                     spv = SvPV_const(csv, slen);
4157                 }
4158                 else
4159                     sv_utf8_upgrade_nomg(dsv);
4160             }
4161             sv_catpvn_nomg(dsv, spv, slen);
4162         }
4163     }
4164     if (flags & SV_SMAGIC)
4165         SvSETMAGIC(dsv);
4166 }
4167
4168 /*
4169 =for apidoc sv_catpv
4170
4171 Concatenates the string onto the end of the string which is in the SV.
4172 If the SV has the UTF-8 status set, then the bytes appended should be
4173 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4174
4175 =cut */
4176
4177 void
4178 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4179 {
4180     register STRLEN len;
4181     STRLEN tlen;
4182     char *junk;
4183
4184     if (!ptr)
4185         return;
4186     junk = SvPV_force(sv, tlen);
4187     len = strlen(ptr);
4188     SvGROW(sv, tlen + len + 1);
4189     if (ptr == junk)
4190         ptr = SvPVX_const(sv);
4191     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4192     SvCUR_set(sv, SvCUR(sv) + len);
4193     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4194     SvTAINT(sv);
4195 }
4196
4197 /*
4198 =for apidoc sv_catpv_mg
4199
4200 Like C<sv_catpv>, but also handles 'set' magic.
4201
4202 =cut
4203 */
4204
4205 void
4206 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4207 {
4208     sv_catpv(sv,ptr);
4209     SvSETMAGIC(sv);
4210 }
4211
4212 /*
4213 =for apidoc newSV
4214
4215 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4216 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4217 macro.
4218
4219 =cut
4220 */
4221
4222 SV *
4223 Perl_newSV(pTHX_ STRLEN len)
4224 {
4225     register SV *sv;
4226
4227     new_SV(sv);
4228     if (len) {
4229         sv_upgrade(sv, SVt_PV);
4230         SvGROW(sv, len + 1);
4231     }
4232     return sv;
4233 }
4234 /*
4235 =for apidoc sv_magicext
4236
4237 Adds magic to an SV, upgrading it if necessary. Applies the
4238 supplied vtable and returns a pointer to the magic added.
4239
4240 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4241 In particular, you can add magic to SvREADONLY SVs, and add more than
4242 one instance of the same 'how'.
4243
4244 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4245 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4246 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4247 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4248
4249 (This is now used as a subroutine by C<sv_magic>.)
4250
4251 =cut
4252 */
4253 MAGIC * 
4254 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4255                  const char* name, I32 namlen)
4256 {
4257     MAGIC* mg;
4258
4259     if (SvTYPE(sv) < SVt_PVMG) {
4260         SvUPGRADE(sv, SVt_PVMG);
4261     }
4262     Newxz(mg, 1, MAGIC);
4263     mg->mg_moremagic = SvMAGIC(sv);
4264     SvMAGIC_set(sv, mg);
4265
4266     /* Sometimes a magic contains a reference loop, where the sv and
4267        object refer to each other.  To prevent a reference loop that
4268        would prevent such objects being freed, we look for such loops
4269        and if we find one we avoid incrementing the object refcount.
4270
4271        Note we cannot do this to avoid self-tie loops as intervening RV must
4272        have its REFCNT incremented to keep it in existence.
4273
4274     */
4275     if (!obj || obj == sv ||
4276         how == PERL_MAGIC_arylen ||
4277         how == PERL_MAGIC_qr ||
4278         how == PERL_MAGIC_symtab ||
4279         (SvTYPE(obj) == SVt_PVGV &&
4280             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4281             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4282             GvFORM(obj) == (CV*)sv)))
4283     {
4284         mg->mg_obj = obj;
4285     }
4286     else {
4287         mg->mg_obj = SvREFCNT_inc(obj);
4288         mg->mg_flags |= MGf_REFCOUNTED;
4289     }
4290
4291     /* Normal self-ties simply pass a null object, and instead of
4292        using mg_obj directly, use the SvTIED_obj macro to produce a
4293        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4294        with an RV obj pointing to the glob containing the PVIO.  In
4295        this case, to avoid a reference loop, we need to weaken the
4296        reference.
4297     */
4298
4299     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4300         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4301     {
4302       sv_rvweaken(obj);
4303     }
4304
4305     mg->mg_type = how;
4306     mg->mg_len = namlen;
4307     if (name) {
4308         if (namlen > 0)
4309             mg->mg_ptr = savepvn(name, namlen);
4310         else if (namlen == HEf_SVKEY)
4311             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4312         else
4313             mg->mg_ptr = (char *) name;
4314     }
4315     mg->mg_virtual = vtable;
4316
4317     mg_magical(sv);
4318     if (SvGMAGICAL(sv))
4319         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4320     return mg;
4321 }
4322
4323 /*
4324 =for apidoc sv_magic
4325
4326 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4327 then adds a new magic item of type C<how> to the head of the magic list.
4328
4329 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4330 handling of the C<name> and C<namlen> arguments.
4331
4332 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4333 to add more than one instance of the same 'how'.
4334
4335 =cut
4336 */
4337
4338 void
4339 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4340 {
4341     const MGVTBL *vtable;
4342     MAGIC* mg;
4343
4344 #ifdef PERL_OLD_COPY_ON_WRITE
4345     if (SvIsCOW(sv))
4346         sv_force_normal_flags(sv, 0);
4347 #endif
4348     if (SvREADONLY(sv)) {
4349         if (
4350             /* its okay to attach magic to shared strings; the subsequent
4351              * upgrade to PVMG will unshare the string */
4352             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4353
4354             && IN_PERL_RUNTIME
4355             && how != PERL_MAGIC_regex_global
4356             && how != PERL_MAGIC_bm
4357             && how != PERL_MAGIC_fm
4358             && how != PERL_MAGIC_sv
4359             && how != PERL_MAGIC_backref
4360            )
4361         {
4362             Perl_croak(aTHX_ PL_no_modify);
4363         }
4364     }
4365     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4366         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4367             /* sv_magic() refuses to add a magic of the same 'how' as an
4368                existing one
4369              */
4370             if (how == PERL_MAGIC_taint)
4371                 mg->mg_len |= 1;
4372             return;
4373         }
4374     }
4375
4376     switch (how) {
4377     case PERL_MAGIC_sv:
4378         vtable = &PL_vtbl_sv;
4379         break;
4380     case PERL_MAGIC_overload:
4381         vtable = &PL_vtbl_amagic;
4382         break;
4383     case PERL_MAGIC_overload_elem:
4384         vtable = &PL_vtbl_amagicelem;
4385         break;
4386     case PERL_MAGIC_overload_table:
4387         vtable = &PL_vtbl_ovrld;
4388         break;
4389     case PERL_MAGIC_bm:
4390         vtable = &PL_vtbl_bm;
4391         break;
4392     case PERL_MAGIC_regdata:
4393         vtable = &PL_vtbl_regdata;
4394         break;
4395     case PERL_MAGIC_regdatum:
4396         vtable = &PL_vtbl_regdatum;
4397         break;
4398     case PERL_MAGIC_env:
4399         vtable = &PL_vtbl_env;
4400         break;
4401     case PERL_MAGIC_fm:
4402         vtable = &PL_vtbl_fm;
4403         break;
4404     case PERL_MAGIC_envelem:
4405         vtable = &PL_vtbl_envelem;
4406         break;
4407     case PERL_MAGIC_regex_global:
4408         vtable = &PL_vtbl_mglob;
4409         break;
4410     case PERL_MAGIC_isa:
4411         vtable = &PL_vtbl_isa;
4412         break;
4413     case PERL_MAGIC_isaelem:
4414         vtable = &PL_vtbl_isaelem;
4415         break;
4416     case PERL_MAGIC_nkeys:
4417         vtable = &PL_vtbl_nkeys;
4418         break;
4419     case PERL_MAGIC_dbfile:
4420         vtable = NULL;
4421         break;
4422     case PERL_MAGIC_dbline:
4423         vtable = &PL_vtbl_dbline;
4424         break;
4425 #ifdef USE_LOCALE_COLLATE
4426     case PERL_MAGIC_collxfrm:
4427         vtable = &PL_vtbl_collxfrm;
4428         break;
4429 #endif /* USE_LOCALE_COLLATE */
4430     case PERL_MAGIC_tied:
4431         vtable = &PL_vtbl_pack;
4432         break;
4433     case PERL_MAGIC_tiedelem:
4434     case PERL_MAGIC_tiedscalar:
4435         vtable = &PL_vtbl_packelem;
4436         break;
4437     case PERL_MAGIC_qr:
4438         vtable = &PL_vtbl_regexp;
4439         break;
4440     case PERL_MAGIC_sig:
4441         vtable = &PL_vtbl_sig;
4442         break;
4443     case PERL_MAGIC_sigelem:
4444         vtable = &PL_vtbl_sigelem;
4445         break;
4446     case PERL_MAGIC_taint:
4447         vtable = &PL_vtbl_taint;
4448         break;
4449     case PERL_MAGIC_uvar:
4450         vtable = &PL_vtbl_uvar;
4451         break;
4452     case PERL_MAGIC_vec:
4453         vtable = &PL_vtbl_vec;
4454         break;
4455     case PERL_MAGIC_arylen_p:
4456     case PERL_MAGIC_rhash:
4457     case PERL_MAGIC_symtab:
4458     case PERL_MAGIC_vstring:
4459         vtable = NULL;
4460         break;
4461     case PERL_MAGIC_utf8:
4462         vtable = &PL_vtbl_utf8;
4463         break;
4464     case PERL_MAGIC_substr:
4465         vtable = &PL_vtbl_substr;
4466         break;
4467     case PERL_MAGIC_defelem:
4468         vtable = &PL_vtbl_defelem;
4469         break;
4470     case PERL_MAGIC_glob:
4471         vtable = &PL_vtbl_glob;
4472         break;
4473     case PERL_MAGIC_arylen:
4474         vtable = &PL_vtbl_arylen;
4475         break;
4476     case PERL_MAGIC_pos:
4477         vtable = &PL_vtbl_pos;
4478         break;
4479     case PERL_MAGIC_backref:
4480         vtable = &PL_vtbl_backref;
4481         break;
4482     case PERL_MAGIC_ext:
4483         /* Reserved for use by extensions not perl internals.           */
4484         /* Useful for attaching extension internal data to perl vars.   */
4485         /* Note that multiple extensions may clash if magical scalars   */
4486         /* etc holding private data from one are passed to another.     */
4487         vtable = NULL;
4488         break;
4489     default:
4490         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4491     }
4492
4493     /* Rest of work is done else where */
4494     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4495
4496     switch (how) {
4497     case PERL_MAGIC_taint:
4498         mg->mg_len = 1;
4499         break;
4500     case PERL_MAGIC_ext:
4501     case PERL_MAGIC_dbfile:
4502         SvRMAGICAL_on(sv);
4503         break;
4504     }
4505 }
4506
4507 /*
4508 =for apidoc sv_unmagic
4509
4510 Removes all magic of type C<type> from an SV.
4511
4512 =cut
4513 */
4514
4515 int
4516 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4517 {
4518     MAGIC* mg;
4519     MAGIC** mgp;
4520     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4521         return 0;
4522     mgp = &SvMAGIC(sv);
4523     for (mg = *mgp; mg; mg = *mgp) {
4524         if (mg->mg_type == type) {
4525             const MGVTBL* const vtbl = mg->mg_virtual;
4526             *mgp = mg->mg_moremagic;
4527             if (vtbl && vtbl->svt_free)
4528                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4529             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4530                 if (mg->mg_len > 0)
4531                     Safefree(mg->mg_ptr);
4532                 else if (mg->mg_len == HEf_SVKEY)
4533                     SvREFCNT_dec((SV*)mg->mg_ptr);
4534                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4535                     Safefree(mg->mg_ptr);
4536             }
4537             if (mg->mg_flags & MGf_REFCOUNTED)
4538                 SvREFCNT_dec(mg->mg_obj);
4539             Safefree(mg);
4540         }
4541         else
4542             mgp = &mg->mg_moremagic;
4543     }
4544     if (!SvMAGIC(sv)) {
4545         SvMAGICAL_off(sv);
4546        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4547     }
4548
4549     return 0;
4550 }
4551
4552 /*
4553 =for apidoc sv_rvweaken
4554
4555 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4556 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4557 push a back-reference to this RV onto the array of backreferences
4558 associated with that magic.
4559
4560 =cut
4561 */
4562
4563 SV *
4564 Perl_sv_rvweaken(pTHX_ SV *sv)
4565 {
4566     SV *tsv;
4567     if (!SvOK(sv))  /* let undefs pass */
4568         return sv;
4569     if (!SvROK(sv))
4570         Perl_croak(aTHX_ "Can't weaken a nonreference");
4571     else if (SvWEAKREF(sv)) {
4572         if (ckWARN(WARN_MISC))
4573             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4574         return sv;
4575     }
4576     tsv = SvRV(sv);
4577     Perl_sv_add_backref(aTHX_ tsv, sv);
4578     SvWEAKREF_on(sv);
4579     SvREFCNT_dec(tsv);
4580     return sv;
4581 }
4582
4583 /* Give tsv backref magic if it hasn't already got it, then push a
4584  * back-reference to sv onto the array associated with the backref magic.
4585  */
4586
4587 void
4588 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4589 {
4590     AV *av;
4591     MAGIC *mg;
4592     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4593         av = (AV*)mg->mg_obj;
4594     else {
4595         av = newAV();
4596         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4597         /* av now has a refcnt of 2, which avoids it getting freed
4598          * before us during global cleanup. The extra ref is removed
4599          * by magic_killbackrefs() when tsv is being freed */
4600     }
4601     if (AvFILLp(av) >= AvMAX(av)) {
4602         av_extend(av, AvFILLp(av)+1);
4603     }
4604     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4605 }
4606
4607 /* delete a back-reference to ourselves from the backref magic associated
4608  * with the SV we point to.
4609  */
4610
4611 STATIC void
4612 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4613 {
4614     AV *av;
4615     SV **svp;
4616     I32 i;
4617     MAGIC *mg = NULL;
4618     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4619         if (PL_in_clean_all)
4620             return;
4621     }
4622     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4623         Perl_croak(aTHX_ "panic: del_backref");
4624     av = (AV *)mg->mg_obj;
4625     svp = AvARRAY(av);
4626     /* We shouldn't be in here more than once, but for paranoia reasons lets
4627        not assume this.  */
4628     for (i = AvFILLp(av); i >= 0; i--) {
4629         if (svp[i] == sv) {
4630             const SSize_t fill = AvFILLp(av);
4631             if (i != fill) {
4632                 /* We weren't the last entry.
4633                    An unordered list has this property that you can take the
4634                    last element off the end to fill the hole, and it's still
4635                    an unordered list :-)
4636                 */
4637                 svp[i] = svp[fill];
4638             }
4639             svp[fill] = Nullsv;
4640             AvFILLp(av) = fill - 1;
4641         }
4642     }
4643 }
4644
4645 /*
4646 =for apidoc sv_insert
4647
4648 Inserts a string at the specified offset/length within the SV. Similar to
4649 the Perl substr() function.
4650
4651 =cut
4652 */
4653
4654 void
4655 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4656 {
4657     register char *big;
4658     register char *mid;
4659     register char *midend;
4660     register char *bigend;
4661     register I32 i;
4662     STRLEN curlen;
4663
4664
4665     if (!bigstr)
4666         Perl_croak(aTHX_ "Can't modify non-existent substring");
4667     SvPV_force(bigstr, curlen);
4668     (void)SvPOK_only_UTF8(bigstr);
4669     if (offset + len > curlen) {
4670         SvGROW(bigstr, offset+len+1);
4671         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4672         SvCUR_set(bigstr, offset+len);
4673     }
4674
4675     SvTAINT(bigstr);
4676     i = littlelen - len;
4677     if (i > 0) {                        /* string might grow */
4678         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4679         mid = big + offset + len;
4680         midend = bigend = big + SvCUR(bigstr);
4681         bigend += i;
4682         *bigend = '\0';
4683         while (midend > mid)            /* shove everything down */
4684             *--bigend = *--midend;
4685         Move(little,big+offset,littlelen,char);
4686         SvCUR_set(bigstr, SvCUR(bigstr) + i);
4687         SvSETMAGIC(bigstr);
4688         return;
4689     }
4690     else if (i == 0) {
4691         Move(little,SvPVX(bigstr)+offset,len,char);
4692         SvSETMAGIC(bigstr);
4693         return;
4694     }
4695
4696     big = SvPVX(bigstr);
4697     mid = big + offset;
4698     midend = mid + len;
4699     bigend = big + SvCUR(bigstr);
4700
4701     if (midend > bigend)
4702         Perl_croak(aTHX_ "panic: sv_insert");
4703
4704     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4705         if (littlelen) {
4706             Move(little, mid, littlelen,char);
4707             mid += littlelen;
4708         }
4709         i = bigend - midend;
4710         if (i > 0) {
4711             Move(midend, mid, i,char);
4712             mid += i;
4713         }
4714  &nb