This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
0378b1f7c279dd8b9e7d8e779ae9a868ec011fe5
[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;
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
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             } else {
2583                 MAGIC *mg;
2584                 const SV *const referent = (SV*)SvRV(sv);
2585
2586                 if (!referent) {
2587                     if (lp)
2588                         *lp = 7;
2589                     return (char *)"NULLREF";
2590                 }
2591                 
2592                 if (SvTYPE(referent) == SVt_PVMG && ((SvFLAGS(referent) &
2593                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2594                           == (SVs_OBJECT|SVs_SMG))
2595                     && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2596                     const regexp *re = (regexp *)mg->mg_obj;
2597
2598                     if (!mg->mg_ptr) {
2599                         const char *fptr = "msix";
2600                         char reflags[6];
2601                         char ch;
2602                         int left = 0;
2603                         int right = 4;
2604                         char need_newline = 0;
2605                         U16 reganch =
2606                             (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2607
2608                         while((ch = *fptr++)) {
2609                             if(reganch & 1) {
2610                                 reflags[left++] = ch;
2611                             }
2612                             else {
2613                                 reflags[right--] = ch;
2614                             }
2615                             reganch >>= 1;
2616                         }
2617                         if(left != 4) {
2618                             reflags[left] = '-';
2619                             left = 5;
2620                         }
2621
2622                         mg->mg_len = re->prelen + 4 + left;
2623                         /*
2624                          * If /x was used, we have to worry about a regex
2625                          * ending with a comment later being embedded
2626                          * within another regex. If so, we don't want this
2627                          * regex's "commentization" to leak out to the
2628                          * right part of the enclosing regex, we must cap
2629                          * it with a newline.
2630                          *
2631                          * So, if /x was used, we scan backwards from the
2632                          * end of the regex. If we find a '#' before we
2633                          * find a newline, we need to add a newline
2634                          * ourself. If we find a '\n' first (or if we
2635                          * don't find '#' or '\n'), we don't need to add
2636                          * anything.  -jfriedl
2637                          */
2638                         if (PMf_EXTENDED & re->reganch) {
2639                             const char *endptr = re->precomp + re->prelen;
2640                             while (endptr >= re->precomp) {
2641                                 const char c = *(endptr--);
2642                                 if (c == '\n')
2643                                     break; /* don't need another */
2644                                 if (c == '#') {
2645                                     /* we end while in a comment, so we
2646                                        need a newline */
2647                                     mg->mg_len++; /* save space for it */
2648                                     need_newline = 1; /* note to add it */
2649                                     break;
2650                                 }
2651                             }
2652                         }
2653
2654                         Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2655                         Copy("(?", mg->mg_ptr, 2, char);
2656                         Copy(reflags, mg->mg_ptr+2, left, char);
2657                         Copy(":", mg->mg_ptr+left+2, 1, char);
2658                         Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2659                         if (need_newline)
2660                             mg->mg_ptr[mg->mg_len - 2] = '\n';
2661                         mg->mg_ptr[mg->mg_len - 1] = ')';
2662                         mg->mg_ptr[mg->mg_len] = 0;
2663                     }
2664                     PL_reginterp_cnt += re->program[0].next_off;
2665
2666                     if (re->reganch & ROPT_UTF8)
2667                         SvUTF8_on(sv);
2668                     else
2669                         SvUTF8_off(sv);
2670                     if (lp)
2671                         *lp = mg->mg_len;
2672                     return mg->mg_ptr;
2673                 } else {
2674                     const char *const typestr = sv_reftype(referent, 0);
2675
2676                     tsv = sv_newmortal();
2677                     if (SvOBJECT(referent)) {
2678                         const char *const name = HvNAME_get(SvSTASH(referent));
2679                         Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2680                                        name ? name : "__ANON__" , typestr,
2681                                        PTR2UV(referent));
2682                     }
2683                     else
2684                         Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2685                                        PTR2UV(referent));
2686                     if (lp)
2687                         *lp = SvCUR(tsv);
2688                     return SvPVX(tsv);
2689                 }
2690             }
2691         }
2692         if (SvREADONLY(sv) && !SvOK(sv)) {
2693             if (ckWARN(WARN_UNINITIALIZED))
2694                 report_uninit(sv);
2695             if (lp)
2696                 *lp = 0;
2697             return (char *)"";
2698         }
2699     }
2700     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2701         /* I'm assuming that if both IV and NV are equally valid then
2702            converting the IV is going to be more efficient */
2703         const U32 isIOK = SvIOK(sv);
2704         const U32 isUIOK = SvIsUV(sv);
2705         char buf[TYPE_CHARS(UV)];
2706         char *ebuf, *ptr;
2707
2708         if (SvTYPE(sv) < SVt_PVIV)
2709             sv_upgrade(sv, SVt_PVIV);
2710         if (isUIOK)
2711             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2712         else
2713             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2714         /* inlined from sv_setpvn */
2715         SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2716         Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2717         SvCUR_set(sv, ebuf - ptr);
2718         s = SvEND(sv);
2719         *s = '\0';
2720         if (isIOK)
2721             SvIOK_on(sv);
2722         else
2723             SvIOKp_on(sv);
2724         if (isUIOK)
2725             SvIsUV_on(sv);
2726     }
2727     else if (SvNOKp(sv)) {
2728         if (SvTYPE(sv) < SVt_PVNV)
2729             sv_upgrade(sv, SVt_PVNV);
2730         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2731         s = SvGROW_mutable(sv, NV_DIG + 20);
2732         olderrno = errno;       /* some Xenix systems wipe out errno here */
2733 #ifdef apollo
2734         if (SvNVX(sv) == 0.0)
2735             (void)strcpy(s,"0");
2736         else
2737 #endif /*apollo*/
2738         {
2739             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2740         }
2741         errno = olderrno;
2742 #ifdef FIXNEGATIVEZERO
2743         if (*s == '-' && s[1] == '0' && !s[2])
2744             strcpy(s,"0");
2745 #endif
2746         while (*s) s++;
2747 #ifdef hcx
2748         if (s[-1] == '.')
2749             *--s = '\0';
2750 #endif
2751     }
2752     else {
2753         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2754             report_uninit(sv);
2755         if (lp)
2756         *lp = 0;
2757         if (SvTYPE(sv) < SVt_PV)
2758             /* Typically the caller expects that sv_any is not NULL now.  */
2759             sv_upgrade(sv, SVt_PV);
2760         return (char *)"";
2761     }
2762     {
2763         const STRLEN len = s - SvPVX_const(sv);
2764         if (lp) 
2765             *lp = len;
2766         SvCUR_set(sv, len);
2767     }
2768     SvPOK_on(sv);
2769     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2770                           PTR2UV(sv),SvPVX_const(sv)));
2771     if (flags & SV_CONST_RETURN)
2772         return (char *)SvPVX_const(sv);
2773     if (flags & SV_MUTABLE_RETURN)
2774         return SvPVX_mutable(sv);
2775     return SvPVX(sv);
2776
2777   tokensave:
2778     len = strlen(tmpbuf);
2779  tokensave_has_len:
2780     assert (!tsv);
2781     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
2782         /* Sneaky stuff here */
2783
2784         if (!tsv)
2785             tsv = newSVpvn(tmpbuf, len);
2786         sv_2mortal(tsv);
2787         if (lp)
2788             *lp = SvCUR(tsv);
2789         return SvPVX(tsv);
2790     }
2791     else {
2792         dVAR;
2793
2794 #ifdef FIXNEGATIVEZERO
2795         if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2796             tmpbuf[0] = '0';
2797             tmpbuf[1] = 0;
2798             len = 1;
2799         }
2800 #endif
2801         SvUPGRADE(sv, SVt_PV);
2802         if (lp)
2803             *lp = len;
2804         s = SvGROW_mutable(sv, len + 1);
2805         SvCUR_set(sv, len);
2806         SvPOKp_on(sv);
2807         return memcpy(s, tmpbuf, len + 1);
2808     }
2809 }
2810
2811 /*
2812 =for apidoc sv_copypv
2813
2814 Copies a stringified representation of the source SV into the
2815 destination SV.  Automatically performs any necessary mg_get and
2816 coercion of numeric values into strings.  Guaranteed to preserve
2817 UTF-8 flag even from overloaded objects.  Similar in nature to
2818 sv_2pv[_flags] but operates directly on an SV instead of just the
2819 string.  Mostly uses sv_2pv_flags to do its work, except when that
2820 would lose the UTF-8'ness of the PV.
2821
2822 =cut
2823 */
2824
2825 void
2826 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2827 {
2828     STRLEN len;
2829     const char * const s = SvPV_const(ssv,len);
2830     sv_setpvn(dsv,s,len);
2831     if (SvUTF8(ssv))
2832         SvUTF8_on(dsv);
2833     else
2834         SvUTF8_off(dsv);
2835 }
2836
2837 /*
2838 =for apidoc sv_2pvbyte
2839
2840 Return a pointer to the byte-encoded representation of the SV, and set *lp
2841 to its length.  May cause the SV to be downgraded from UTF-8 as a
2842 side-effect.
2843
2844 Usually accessed via the C<SvPVbyte> macro.
2845
2846 =cut
2847 */
2848
2849 char *
2850 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2851 {
2852     sv_utf8_downgrade(sv,0);
2853     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2854 }
2855
2856 /*
2857 =for apidoc sv_2pvutf8
2858
2859 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2860 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2861
2862 Usually accessed via the C<SvPVutf8> macro.
2863
2864 =cut
2865 */
2866
2867 char *
2868 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2869 {
2870     sv_utf8_upgrade(sv);
2871     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2872 }
2873
2874
2875 /*
2876 =for apidoc sv_2bool
2877
2878 This function is only called on magical items, and is only used by
2879 sv_true() or its macro equivalent.
2880
2881 =cut
2882 */
2883
2884 bool
2885 Perl_sv_2bool(pTHX_ register SV *sv)
2886 {
2887     SvGETMAGIC(sv);
2888
2889     if (!SvOK(sv))
2890         return 0;
2891     if (SvROK(sv)) {
2892         SV* tmpsv;
2893         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2894                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2895             return (bool)SvTRUE(tmpsv);
2896       return SvRV(sv) != 0;
2897     }
2898     if (SvPOKp(sv)) {
2899         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2900         if (Xpvtmp &&
2901                 (*sv->sv_u.svu_pv > '0' ||
2902                 Xpvtmp->xpv_cur > 1 ||
2903                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2904             return 1;
2905         else
2906             return 0;
2907     }
2908     else {
2909         if (SvIOKp(sv))
2910             return SvIVX(sv) != 0;
2911         else {
2912             if (SvNOKp(sv))
2913                 return SvNVX(sv) != 0.0;
2914             else
2915                 return FALSE;
2916         }
2917     }
2918 }
2919
2920 /*
2921 =for apidoc sv_utf8_upgrade
2922
2923 Converts the PV of an SV to its UTF-8-encoded form.
2924 Forces the SV to string form if it is not already.
2925 Always sets the SvUTF8 flag to avoid future validity checks even
2926 if all the bytes have hibit clear.
2927
2928 This is not as a general purpose byte encoding to Unicode interface:
2929 use the Encode extension for that.
2930
2931 =for apidoc sv_utf8_upgrade_flags
2932
2933 Converts the PV of an SV to its UTF-8-encoded form.
2934 Forces the SV to string form if it is not already.
2935 Always sets the SvUTF8 flag to avoid future validity checks even
2936 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2937 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2938 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2939
2940 This is not as a general purpose byte encoding to Unicode interface:
2941 use the Encode extension for that.
2942
2943 =cut
2944 */
2945
2946 STRLEN
2947 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2948 {
2949     if (sv == &PL_sv_undef)
2950         return 0;
2951     if (!SvPOK(sv)) {
2952         STRLEN len = 0;
2953         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2954             (void) sv_2pv_flags(sv,&len, flags);
2955             if (SvUTF8(sv))
2956                 return len;
2957         } else {
2958             (void) SvPV_force(sv,len);
2959         }
2960     }
2961
2962     if (SvUTF8(sv)) {
2963         return SvCUR(sv);
2964     }
2965
2966     if (SvIsCOW(sv)) {
2967         sv_force_normal_flags(sv, 0);
2968     }
2969
2970     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2971         sv_recode_to_utf8(sv, PL_encoding);
2972     else { /* Assume Latin-1/EBCDIC */
2973         /* This function could be much more efficient if we
2974          * had a FLAG in SVs to signal if there are any hibit
2975          * chars in the PV.  Given that there isn't such a flag
2976          * make the loop as fast as possible. */
2977         const U8 *s = (U8 *) SvPVX_const(sv);
2978         const U8 * const e = (U8 *) SvEND(sv);
2979         const U8 *t = s;
2980         int hibit = 0;
2981         
2982         while (t < e) {
2983             const U8 ch = *t++;
2984             if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2985                 break;
2986         }
2987         if (hibit) {
2988             STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2989             U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2990
2991             SvPV_free(sv); /* No longer using what was there before. */
2992
2993             SvPV_set(sv, (char*)recoded);
2994             SvCUR_set(sv, len - 1);
2995             SvLEN_set(sv, len); /* No longer know the real size. */
2996         }
2997         /* Mark as UTF-8 even if no hibit - saves scanning loop */
2998         SvUTF8_on(sv);
2999     }
3000     return SvCUR(sv);
3001 }
3002
3003 /*
3004 =for apidoc sv_utf8_downgrade
3005
3006 Attempts to convert the PV of an SV from characters to bytes.
3007 If the PV contains a character beyond byte, this conversion will fail;
3008 in this case, either returns false or, if C<fail_ok> is not
3009 true, croaks.
3010
3011 This is not as a general purpose Unicode to byte encoding interface:
3012 use the Encode extension for that.
3013
3014 =cut
3015 */
3016
3017 bool
3018 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3019 {
3020     if (SvPOKp(sv) && SvUTF8(sv)) {
3021         if (SvCUR(sv)) {
3022             U8 *s;
3023             STRLEN len;
3024
3025             if (SvIsCOW(sv)) {
3026                 sv_force_normal_flags(sv, 0);
3027             }
3028             s = (U8 *) SvPV(sv, len);
3029             if (!utf8_to_bytes(s, &len)) {
3030                 if (fail_ok)
3031                     return FALSE;
3032                 else {
3033                     if (PL_op)
3034                         Perl_croak(aTHX_ "Wide character in %s",
3035                                    OP_DESC(PL_op));
3036                     else
3037                         Perl_croak(aTHX_ "Wide character");
3038                 }
3039             }
3040             SvCUR_set(sv, len);
3041         }
3042     }
3043     SvUTF8_off(sv);
3044     return TRUE;
3045 }
3046
3047 /*
3048 =for apidoc sv_utf8_encode
3049
3050 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3051 flag off so that it looks like octets again.
3052
3053 =cut
3054 */
3055
3056 void
3057 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3058 {
3059     (void) sv_utf8_upgrade(sv);
3060     if (SvIsCOW(sv)) {
3061         sv_force_normal_flags(sv, 0);
3062     }
3063     if (SvREADONLY(sv)) {
3064         Perl_croak(aTHX_ PL_no_modify);
3065     }
3066     SvUTF8_off(sv);
3067 }
3068
3069 /*
3070 =for apidoc sv_utf8_decode
3071
3072 If the PV of the SV is an octet sequence in UTF-8
3073 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3074 so that it looks like a character. If the PV contains only single-byte
3075 characters, the C<SvUTF8> flag stays being off.
3076 Scans PV for validity and returns false if the PV is invalid UTF-8.
3077
3078 =cut
3079 */
3080
3081 bool
3082 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3083 {
3084     if (SvPOKp(sv)) {
3085         const U8 *c;
3086         const U8 *e;
3087
3088         /* The octets may have got themselves encoded - get them back as
3089          * bytes
3090          */
3091         if (!sv_utf8_downgrade(sv, TRUE))
3092             return FALSE;
3093
3094         /* it is actually just a matter of turning the utf8 flag on, but
3095          * we want to make sure everything inside is valid utf8 first.
3096          */
3097         c = (const U8 *) SvPVX_const(sv);
3098         if (!is_utf8_string(c, SvCUR(sv)+1))
3099             return FALSE;
3100         e = (const U8 *) SvEND(sv);
3101         while (c < e) {
3102             const U8 ch = *c++;
3103             if (!UTF8_IS_INVARIANT(ch)) {
3104                 SvUTF8_on(sv);
3105                 break;
3106             }
3107         }
3108     }
3109     return TRUE;
3110 }
3111
3112 /*
3113 =for apidoc sv_setsv
3114
3115 Copies the contents of the source SV C<ssv> into the destination SV
3116 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3117 function if the source SV needs to be reused. Does not handle 'set' magic.
3118 Loosely speaking, it performs a copy-by-value, obliterating any previous
3119 content of the destination.
3120
3121 You probably want to use one of the assortment of wrappers, such as
3122 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3123 C<SvSetMagicSV_nosteal>.
3124
3125 =for apidoc sv_setsv_flags
3126
3127 Copies the contents of the source SV C<ssv> into the destination SV
3128 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3129 function if the source SV needs to be reused. Does not handle 'set' magic.
3130 Loosely speaking, it performs a copy-by-value, obliterating any previous
3131 content of the destination.
3132 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3133 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3134 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3135 and C<sv_setsv_nomg> are implemented in terms of this function.
3136
3137 You probably want to use one of the assortment of wrappers, such as
3138 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3139 C<SvSetMagicSV_nosteal>.
3140
3141 This is the primary function for copying scalars, and most other
3142 copy-ish functions and macros use this underneath.
3143
3144 =cut
3145 */
3146
3147 void
3148 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3149 {
3150     register U32 sflags;
3151     register int dtype;
3152     register int stype;
3153
3154     if (sstr == dstr)
3155         return;
3156     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3157     if (!sstr)
3158         sstr = &PL_sv_undef;
3159     stype = SvTYPE(sstr);
3160     dtype = SvTYPE(dstr);
3161
3162     SvAMAGIC_off(dstr);
3163     if ( SvVOK(dstr) )
3164     {
3165         /* need to nuke the magic */
3166         mg_free(dstr);
3167         SvRMAGICAL_off(dstr);
3168     }
3169
3170     /* There's a lot of redundancy below but we're going for speed here */
3171
3172     switch (stype) {
3173     case SVt_NULL:
3174       undef_sstr:
3175         if (dtype != SVt_PVGV) {
3176             (void)SvOK_off(dstr);
3177             return;
3178         }
3179         break;
3180     case SVt_IV:
3181         if (SvIOK(sstr)) {
3182             switch (dtype) {
3183             case SVt_NULL:
3184                 sv_upgrade(dstr, SVt_IV);
3185                 break;
3186             case SVt_NV:
3187                 sv_upgrade(dstr, SVt_PVNV);
3188                 break;
3189             case SVt_RV:
3190             case SVt_PV:
3191                 sv_upgrade(dstr, SVt_PVIV);
3192                 break;
3193             }
3194             (void)SvIOK_only(dstr);
3195             SvIV_set(dstr,  SvIVX(sstr));
3196             if (SvIsUV(sstr))
3197                 SvIsUV_on(dstr);
3198             if (SvTAINTED(sstr))
3199                 SvTAINT(dstr);
3200             return;
3201         }
3202         goto undef_sstr;
3203
3204     case SVt_NV:
3205         if (SvNOK(sstr)) {
3206             switch (dtype) {
3207             case SVt_NULL:
3208             case SVt_IV:
3209                 sv_upgrade(dstr, SVt_NV);
3210                 break;
3211             case SVt_RV:
3212             case SVt_PV:
3213             case SVt_PVIV:
3214                 sv_upgrade(dstr, SVt_PVNV);
3215                 break;
3216             }
3217             SvNV_set(dstr, SvNVX(sstr));
3218             (void)SvNOK_only(dstr);
3219             if (SvTAINTED(sstr))
3220                 SvTAINT(dstr);
3221             return;
3222         }
3223         goto undef_sstr;
3224
3225     case SVt_RV:
3226         if (dtype < SVt_RV)
3227             sv_upgrade(dstr, SVt_RV);
3228         else if (dtype == SVt_PVGV &&
3229                  SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3230             sstr = SvRV(sstr);
3231             if (sstr == dstr) {
3232                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3233                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3234                 {
3235                     GvIMPORTED_on(dstr);
3236                 }
3237                 GvMULTI_on(dstr);
3238                 return;
3239             }
3240             goto glob_assign;
3241         }
3242         break;
3243     case SVt_PVFM:
3244 #ifdef PERL_OLD_COPY_ON_WRITE
3245         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3246             if (dtype < SVt_PVIV)
3247                 sv_upgrade(dstr, SVt_PVIV);
3248             break;
3249         }
3250         /* Fall through */
3251 #endif
3252     case SVt_PV:
3253         if (dtype < SVt_PV)
3254             sv_upgrade(dstr, SVt_PV);
3255         break;
3256     case SVt_PVIV:
3257         if (dtype < SVt_PVIV)
3258             sv_upgrade(dstr, SVt_PVIV);
3259         break;
3260     case SVt_PVNV:
3261         if (dtype < SVt_PVNV)
3262             sv_upgrade(dstr, SVt_PVNV);
3263         break;
3264     case SVt_PVAV:
3265     case SVt_PVHV:
3266     case SVt_PVCV:
3267     case SVt_PVIO:
3268         {
3269         const char * const type = sv_reftype(sstr,0);
3270         if (PL_op)
3271             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3272         else
3273             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3274         }
3275         break;
3276
3277     case SVt_PVGV:
3278         if (dtype <= SVt_PVGV) {
3279   glob_assign:
3280             if (dtype != SVt_PVGV) {
3281                 const char * const name = GvNAME(sstr);
3282                 const STRLEN len = GvNAMELEN(sstr);
3283                 /* don't upgrade SVt_PVLV: it can hold a glob */
3284                 if (dtype != SVt_PVLV)
3285                     sv_upgrade(dstr, SVt_PVGV);
3286                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3287                 GvSTASH(dstr) = GvSTASH(sstr);
3288                 if (GvSTASH(dstr))
3289                     Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3290                 GvNAME(dstr) = savepvn(name, len);
3291                 GvNAMELEN(dstr) = len;
3292                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3293             }
3294
3295 #ifdef GV_UNIQUE_CHECK
3296                 if (GvUNIQUE((GV*)dstr)) {
3297                     Perl_croak(aTHX_ PL_no_modify);
3298                 }
3299 #endif
3300
3301             (void)SvOK_off(dstr);
3302             GvINTRO_off(dstr);          /* one-shot flag */
3303             gp_free((GV*)dstr);
3304             GvGP(dstr) = gp_ref(GvGP(sstr));
3305             if (SvTAINTED(sstr))
3306                 SvTAINT(dstr);
3307             if (GvIMPORTED(dstr) != GVf_IMPORTED
3308                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3309             {
3310                 GvIMPORTED_on(dstr);
3311             }
3312             GvMULTI_on(dstr);
3313             return;
3314         }
3315         /* FALL THROUGH */
3316
3317     default:
3318         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3319             mg_get(sstr);
3320             if ((int)SvTYPE(sstr) != stype) {
3321                 stype = SvTYPE(sstr);
3322                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3323                     goto glob_assign;
3324             }
3325         }
3326         if (stype == SVt_PVLV)
3327             SvUPGRADE(dstr, SVt_PVNV);
3328         else
3329             SvUPGRADE(dstr, (U32)stype);
3330     }
3331
3332     sflags = SvFLAGS(sstr);
3333
3334     if (sflags & SVf_ROK) {
3335         if (dtype >= SVt_PV) {
3336             if (dtype == SVt_PVGV) {
3337                 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3338                 SV *dref = 0;
3339                 const int intro = GvINTRO(dstr);
3340
3341 #ifdef GV_UNIQUE_CHECK
3342                 if (GvUNIQUE((GV*)dstr)) {
3343                     Perl_croak(aTHX_ PL_no_modify);
3344                 }
3345 #endif
3346
3347                 if (intro) {
3348                     GvINTRO_off(dstr);  /* one-shot flag */
3349                     GvLINE(dstr) = CopLINE(PL_curcop);
3350                     GvEGV(dstr) = (GV*)dstr;
3351                 }
3352                 GvMULTI_on(dstr);
3353                 switch (SvTYPE(sref)) {
3354                 case SVt_PVAV:
3355                     if (intro)
3356                         SAVEGENERICSV(GvAV(dstr));
3357                     else
3358                         dref = (SV*)GvAV(dstr);
3359                     GvAV(dstr) = (AV*)sref;
3360                     if (!GvIMPORTED_AV(dstr)
3361                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3362                     {
3363                         GvIMPORTED_AV_on(dstr);
3364                     }
3365                     break;
3366                 case SVt_PVHV:
3367                     if (intro)
3368                         SAVEGENERICSV(GvHV(dstr));
3369                     else
3370                         dref = (SV*)GvHV(dstr);
3371                     GvHV(dstr) = (HV*)sref;
3372                     if (!GvIMPORTED_HV(dstr)
3373                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3374                     {
3375                         GvIMPORTED_HV_on(dstr);
3376                     }
3377                     break;
3378                 case SVt_PVCV:
3379                     if (intro) {
3380                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3381                             SvREFCNT_dec(GvCV(dstr));
3382                             GvCV(dstr) = Nullcv;
3383                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3384                             PL_sub_generation++;
3385                         }
3386                         SAVEGENERICSV(GvCV(dstr));
3387                     }
3388                     else
3389                         dref = (SV*)GvCV(dstr);
3390                     if (GvCV(dstr) != (CV*)sref) {
3391                         CV* const cv = GvCV(dstr);
3392                         if (cv) {
3393                             if (!GvCVGEN((GV*)dstr) &&
3394                                 (CvROOT(cv) || CvXSUB(cv)))
3395                             {
3396                                 /* Redefining a sub - warning is mandatory if
3397                                    it was a const and its value changed. */
3398                                 if (ckWARN(WARN_REDEFINE)
3399                                     || (CvCONST(cv)
3400                                         && (!CvCONST((CV*)sref)
3401                                             || sv_cmp(cv_const_sv(cv),
3402                                                       cv_const_sv((CV*)sref)))))
3403                                 {
3404                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3405                                         CvCONST(cv)
3406                                         ? "Constant subroutine %s::%s redefined"
3407                                         : "Subroutine %s::%s redefined",
3408                                         HvNAME_get(GvSTASH((GV*)dstr)),
3409                                         GvENAME((GV*)dstr));
3410                                 }
3411                             }
3412                             if (!intro)
3413                                 cv_ckproto(cv, (GV*)dstr,
3414                                            SvPOK(sref)
3415                                            ? SvPVX_const(sref) : Nullch);
3416                         }
3417                         GvCV(dstr) = (CV*)sref;
3418                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3419                         GvASSUMECV_on(dstr);
3420                         PL_sub_generation++;
3421                     }
3422                     if (!GvIMPORTED_CV(dstr)
3423                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3424                     {
3425                         GvIMPORTED_CV_on(dstr);
3426                     }
3427                     break;
3428                 case SVt_PVIO:
3429                     if (intro)
3430                         SAVEGENERICSV(GvIOp(dstr));
3431                     else
3432                         dref = (SV*)GvIOp(dstr);
3433                     GvIOp(dstr) = (IO*)sref;
3434                     break;
3435                 case SVt_PVFM:
3436                     if (intro)
3437                         SAVEGENERICSV(GvFORM(dstr));
3438                     else
3439                         dref = (SV*)GvFORM(dstr);
3440                     GvFORM(dstr) = (CV*)sref;
3441                     break;
3442                 default:
3443                     if (intro)
3444                         SAVEGENERICSV(GvSV(dstr));
3445                     else
3446                         dref = (SV*)GvSV(dstr);
3447                     GvSV(dstr) = sref;
3448                     if (!GvIMPORTED_SV(dstr)
3449                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3450                     {
3451                         GvIMPORTED_SV_on(dstr);
3452                     }
3453                     break;
3454                 }
3455                 if (dref)
3456                     SvREFCNT_dec(dref);
3457                 if (SvTAINTED(sstr))
3458                     SvTAINT(dstr);
3459                 return;
3460             }
3461             if (SvPVX_const(dstr)) {
3462                 SvPV_free(dstr);
3463                 SvLEN_set(dstr, 0);
3464                 SvCUR_set(dstr, 0);
3465             }
3466         }
3467         (void)SvOK_off(dstr);
3468         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3469         SvROK_on(dstr);
3470         if (sflags & SVp_NOK) {
3471             SvNOKp_on(dstr);
3472             /* Only set the public OK flag if the source has public OK.  */
3473             if (sflags & SVf_NOK)
3474                 SvFLAGS(dstr) |= SVf_NOK;
3475             SvNV_set(dstr, SvNVX(sstr));
3476         }
3477         if (sflags & SVp_IOK) {
3478             (void)SvIOKp_on(dstr);
3479             if (sflags & SVf_IOK)
3480                 SvFLAGS(dstr) |= SVf_IOK;
3481             if (sflags & SVf_IVisUV)
3482                 SvIsUV_on(dstr);
3483             SvIV_set(dstr, SvIVX(sstr));
3484         }
3485         if (SvAMAGIC(sstr)) {
3486             SvAMAGIC_on(dstr);
3487         }
3488     }
3489     else if (sflags & SVp_POK) {
3490         bool isSwipe = 0;
3491
3492         /*
3493          * Check to see if we can just swipe the string.  If so, it's a
3494          * possible small lose on short strings, but a big win on long ones.
3495          * It might even be a win on short strings if SvPVX_const(dstr)
3496          * has to be allocated and SvPVX_const(sstr) has to be freed.
3497          */
3498
3499         /* Whichever path we take through the next code, we want this true,
3500            and doing it now facilitates the COW check.  */
3501         (void)SvPOK_only(dstr);
3502
3503         if (
3504             /* We're not already COW  */
3505             ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3506 #ifndef PERL_OLD_COPY_ON_WRITE
3507              /* or we are, but dstr isn't a suitable target.  */
3508              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3509 #endif
3510              )
3511             &&
3512             !(isSwipe =
3513                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3514                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3515                  (!(flags & SV_NOSTEAL)) &&
3516                                         /* and we're allowed to steal temps */
3517                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3518                  SvLEN(sstr)    &&        /* and really is a string */
3519                                 /* and won't be needed again, potentially */
3520               !(PL_op && PL_op->op_type == OP_AASSIGN))
3521 #ifdef PERL_OLD_COPY_ON_WRITE
3522             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3523                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3524                  && SvTYPE(sstr) >= SVt_PVIV)
3525 #endif
3526             ) {
3527             /* Failed the swipe test, and it's not a shared hash key either.
3528                Have to copy the string.  */
3529             STRLEN len = SvCUR(sstr);
3530             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3531             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3532             SvCUR_set(dstr, len);
3533             *SvEND(dstr) = '\0';
3534         } else {
3535             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3536                be true in here.  */
3537             /* Either it's a shared hash key, or it's suitable for
3538                copy-on-write or we can swipe the string.  */
3539             if (DEBUG_C_TEST) {
3540                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3541                 sv_dump(sstr);
3542                 sv_dump(dstr);
3543             }
3544 #ifdef PERL_OLD_COPY_ON_WRITE
3545             if (!isSwipe) {
3546                 /* I believe I should acquire a global SV mutex if
3547                    it's a COW sv (not a shared hash key) to stop
3548                    it going un copy-on-write.
3549                    If the source SV has gone un copy on write between up there
3550                    and down here, then (assert() that) it is of the correct
3551                    form to make it copy on write again */
3552                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3553                     != (SVf_FAKE | SVf_READONLY)) {
3554                     SvREADONLY_on(sstr);
3555                     SvFAKE_on(sstr);
3556                     /* Make the source SV into a loop of 1.
3557                        (about to become 2) */
3558                     SV_COW_NEXT_SV_SET(sstr, sstr);
3559                 }
3560             }
3561 #endif
3562             /* Initial code is common.  */
3563             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3564                 SvPV_free(dstr);
3565             }
3566
3567             if (!isSwipe) {
3568                 /* making another shared SV.  */
3569                 STRLEN cur = SvCUR(sstr);
3570                 STRLEN len = SvLEN(sstr);
3571 #ifdef PERL_OLD_COPY_ON_WRITE
3572                 if (len) {
3573                     assert (SvTYPE(dstr) >= SVt_PVIV);
3574                     /* SvIsCOW_normal */
3575                     /* splice us in between source and next-after-source.  */
3576                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3577                     SV_COW_NEXT_SV_SET(sstr, dstr);
3578                     SvPV_set(dstr, SvPVX_mutable(sstr));
3579                 } else
3580 #endif
3581                 {
3582                     /* SvIsCOW_shared_hash */
3583                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3584                                           "Copy on write: Sharing hash\n"));
3585
3586                     assert (SvTYPE(dstr) >= SVt_PV);
3587                     SvPV_set(dstr,
3588                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3589                 }
3590                 SvLEN_set(dstr, len);
3591                 SvCUR_set(dstr, cur);
3592                 SvREADONLY_on(dstr);
3593                 SvFAKE_on(dstr);
3594                 /* Relesase a global SV mutex.  */
3595             }
3596             else
3597                 {       /* Passes the swipe test.  */
3598                 SvPV_set(dstr, SvPVX_mutable(sstr));
3599                 SvLEN_set(dstr, SvLEN(sstr));
3600                 SvCUR_set(dstr, SvCUR(sstr));
3601
3602                 SvTEMP_off(dstr);
3603                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3604                 SvPV_set(sstr, Nullch);
3605                 SvLEN_set(sstr, 0);
3606                 SvCUR_set(sstr, 0);
3607                 SvTEMP_off(sstr);
3608             }
3609         }
3610         if (sflags & SVf_UTF8)
3611             SvUTF8_on(dstr);
3612         if (sflags & SVp_NOK) {
3613             SvNOKp_on(dstr);
3614             if (sflags & SVf_NOK)
3615                 SvFLAGS(dstr) |= SVf_NOK;
3616             SvNV_set(dstr, SvNVX(sstr));
3617         }
3618         if (sflags & SVp_IOK) {
3619             (void)SvIOKp_on(dstr);
3620             if (sflags & SVf_IOK)
3621                 SvFLAGS(dstr) |= SVf_IOK;
3622             if (sflags & SVf_IVisUV)
3623                 SvIsUV_on(dstr);
3624             SvIV_set(dstr, SvIVX(sstr));
3625         }
3626         if (SvVOK(sstr)) {
3627             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3628             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3629                         smg->mg_ptr, smg->mg_len);
3630             SvRMAGICAL_on(dstr);
3631         }
3632     }
3633     else if (sflags & SVp_IOK) {
3634         if (sflags & SVf_IOK)
3635             (void)SvIOK_only(dstr);
3636         else {
3637             (void)SvOK_off(dstr);
3638             (void)SvIOKp_on(dstr);
3639         }
3640         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3641         if (sflags & SVf_IVisUV)
3642             SvIsUV_on(dstr);
3643         SvIV_set(dstr, SvIVX(sstr));
3644         if (sflags & SVp_NOK) {
3645             if (sflags & SVf_NOK)
3646                 (void)SvNOK_on(dstr);
3647             else
3648                 (void)SvNOKp_on(dstr);
3649             SvNV_set(dstr, SvNVX(sstr));
3650         }
3651     }
3652     else if (sflags & SVp_NOK) {
3653         if (sflags & SVf_NOK)
3654             (void)SvNOK_only(dstr);
3655         else {
3656             (void)SvOK_off(dstr);
3657             SvNOKp_on(dstr);
3658         }
3659         SvNV_set(dstr, SvNVX(sstr));
3660     }
3661     else {
3662         if (dtype == SVt_PVGV) {
3663             if (ckWARN(WARN_MISC))
3664                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3665         }
3666         else
3667             (void)SvOK_off(dstr);
3668     }
3669     if (SvTAINTED(sstr))
3670         SvTAINT(dstr);
3671 }
3672
3673 /*
3674 =for apidoc sv_setsv_mg
3675
3676 Like C<sv_setsv>, but also handles 'set' magic.
3677
3678 =cut
3679 */
3680
3681 void
3682 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3683 {
3684     sv_setsv(dstr,sstr);
3685     SvSETMAGIC(dstr);
3686 }
3687
3688 #ifdef PERL_OLD_COPY_ON_WRITE
3689 SV *
3690 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3691 {
3692     STRLEN cur = SvCUR(sstr);
3693     STRLEN len = SvLEN(sstr);
3694     register char *new_pv;
3695
3696     if (DEBUG_C_TEST) {
3697         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3698                       sstr, dstr);
3699         sv_dump(sstr);
3700         if (dstr)
3701                     sv_dump(dstr);
3702     }
3703
3704     if (dstr) {
3705         if (SvTHINKFIRST(dstr))
3706             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3707         else if (SvPVX_const(dstr))
3708             Safefree(SvPVX_const(dstr));
3709     }
3710     else
3711         new_SV(dstr);
3712     SvUPGRADE(dstr, SVt_PVIV);
3713
3714     assert (SvPOK(sstr));
3715     assert (SvPOKp(sstr));
3716     assert (!SvIOK(sstr));
3717     assert (!SvIOKp(sstr));
3718     assert (!SvNOK(sstr));
3719     assert (!SvNOKp(sstr));
3720
3721     if (SvIsCOW(sstr)) {
3722
3723         if (SvLEN(sstr) == 0) {
3724             /* source is a COW shared hash key.  */
3725             DEBUG_C(PerlIO_printf(Perl_debug_log,
3726                                   "Fast copy on write: Sharing hash\n"));
3727             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3728             goto common_exit;
3729         }
3730         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3731     } else {
3732         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3733         SvUPGRADE(sstr, SVt_PVIV);
3734         SvREADONLY_on(sstr);
3735         SvFAKE_on(sstr);
3736         DEBUG_C(PerlIO_printf(Perl_debug_log,
3737                               "Fast copy on write: Converting sstr to COW\n"));
3738         SV_COW_NEXT_SV_SET(dstr, sstr);
3739     }
3740     SV_COW_NEXT_SV_SET(sstr, dstr);
3741     new_pv = SvPVX_mutable(sstr);
3742
3743   common_exit:
3744     SvPV_set(dstr, new_pv);
3745     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3746     if (SvUTF8(sstr))
3747         SvUTF8_on(dstr);
3748     SvLEN_set(dstr, len);
3749     SvCUR_set(dstr, cur);
3750     if (DEBUG_C_TEST) {
3751         sv_dump(dstr);
3752     }
3753     return dstr;
3754 }
3755 #endif
3756
3757 /*
3758 =for apidoc sv_setpvn
3759
3760 Copies a string into an SV.  The C<len> parameter indicates the number of
3761 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3762 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3763
3764 =cut
3765 */
3766
3767 void
3768 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3769 {
3770     register char *dptr;
3771
3772     SV_CHECK_THINKFIRST_COW_DROP(sv);
3773     if (!ptr) {
3774         (void)SvOK_off(sv);
3775         return;
3776     }
3777     else {
3778         /* len is STRLEN which is unsigned, need to copy to signed */
3779         const IV iv = len;
3780         if (iv < 0)
3781             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3782     }
3783     SvUPGRADE(sv, SVt_PV);
3784
3785     dptr = SvGROW(sv, len + 1);
3786     Move(ptr,dptr,len,char);
3787     dptr[len] = '\0';
3788     SvCUR_set(sv, len);
3789     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3790     SvTAINT(sv);
3791 }
3792
3793 /*
3794 =for apidoc sv_setpvn_mg
3795
3796 Like C<sv_setpvn>, but also handles 'set' magic.
3797
3798 =cut
3799 */
3800
3801 void
3802 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3803 {
3804     sv_setpvn(sv,ptr,len);
3805     SvSETMAGIC(sv);
3806 }
3807
3808 /*
3809 =for apidoc sv_setpv
3810
3811 Copies a string into an SV.  The string must be null-terminated.  Does not
3812 handle 'set' magic.  See C<sv_setpv_mg>.
3813
3814 =cut
3815 */
3816
3817 void
3818 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3819 {
3820     register STRLEN len;
3821
3822     SV_CHECK_THINKFIRST_COW_DROP(sv);
3823     if (!ptr) {
3824         (void)SvOK_off(sv);
3825         return;
3826     }
3827     len = strlen(ptr);
3828     SvUPGRADE(sv, SVt_PV);
3829
3830     SvGROW(sv, len + 1);
3831     Move(ptr,SvPVX(sv),len+1,char);
3832     SvCUR_set(sv, len);
3833     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3834     SvTAINT(sv);
3835 }
3836
3837 /*
3838 =for apidoc sv_setpv_mg
3839
3840 Like C<sv_setpv>, but also handles 'set' magic.
3841
3842 =cut
3843 */
3844
3845 void
3846 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3847 {
3848     sv_setpv(sv,ptr);
3849     SvSETMAGIC(sv);
3850 }
3851
3852 /*
3853 =for apidoc sv_usepvn
3854
3855 Tells an SV to use C<ptr> to find its string value.  Normally the string is
3856 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3857 The C<ptr> should point to memory that was allocated by C<malloc>.  The
3858 string length, C<len>, must be supplied.  This function will realloc the
3859 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3860 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
3861 See C<sv_usepvn_mg>.
3862
3863 =cut
3864 */
3865
3866 void
3867 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3868 {
3869     STRLEN allocate;
3870     SV_CHECK_THINKFIRST_COW_DROP(sv);
3871     SvUPGRADE(sv, SVt_PV);
3872     if (!ptr) {
3873         (void)SvOK_off(sv);
3874         return;
3875     }
3876     if (SvPVX_const(sv))
3877         SvPV_free(sv);
3878
3879     allocate = PERL_STRLEN_ROUNDUP(len + 1);
3880     ptr = saferealloc (ptr, allocate);
3881     SvPV_set(sv, ptr);
3882     SvCUR_set(sv, len);
3883     SvLEN_set(sv, allocate);
3884     *SvEND(sv) = '\0';
3885     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3886     SvTAINT(sv);
3887 }
3888
3889 /*
3890 =for apidoc sv_usepvn_mg
3891
3892 Like C<sv_usepvn>, but also handles 'set' magic.
3893
3894 =cut
3895 */
3896
3897 void
3898 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3899 {
3900     sv_usepvn(sv,ptr,len);
3901     SvSETMAGIC(sv);
3902 }
3903
3904 #ifdef PERL_OLD_COPY_ON_WRITE
3905 /* Need to do this *after* making the SV normal, as we need the buffer
3906    pointer to remain valid until after we've copied it.  If we let go too early,
3907    another thread could invalidate it by unsharing last of the same hash key
3908    (which it can do by means other than releasing copy-on-write Svs)
3909    or by changing the other copy-on-write SVs in the loop.  */
3910 STATIC void
3911 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3912 {
3913     if (len) { /* this SV was SvIsCOW_normal(sv) */
3914          /* we need to find the SV pointing to us.  */
3915         SV * const current = SV_COW_NEXT_SV(after);
3916
3917         if (current == sv) {
3918             /* The SV we point to points back to us (there were only two of us
3919                in the loop.)
3920                Hence other SV is no longer copy on write either.  */
3921             SvFAKE_off(after);
3922             SvREADONLY_off(after);
3923         } else {
3924             /* We need to follow the pointers around the loop.  */
3925             SV *next;
3926             while ((next = SV_COW_NEXT_SV(current)) != sv) {
3927                 assert (next);
3928                 current = next;
3929                  /* don't loop forever if the structure is bust, and we have
3930                     a pointer into a closed loop.  */
3931                 assert (current != after);
3932                 assert (SvPVX_const(current) == pvx);
3933             }
3934             /* Make the SV before us point to the SV after us.  */
3935             SV_COW_NEXT_SV_SET(current, after);
3936         }
3937     } else {
3938         unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3939     }
3940 }
3941
3942 int
3943 Perl_sv_release_IVX(pTHX_ register SV *sv)
3944 {
3945     if (SvIsCOW(sv))
3946         sv_force_normal_flags(sv, 0);
3947     SvOOK_off(sv);
3948     return 0;
3949 }
3950 #endif
3951 /*
3952 =for apidoc sv_force_normal_flags
3953
3954 Undo various types of fakery on an SV: if the PV is a shared string, make
3955 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3956 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3957 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3958 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3959 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3960 set to some other value.) In addition, the C<flags> parameter gets passed to
3961 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3962 with flags set to 0.
3963
3964 =cut
3965 */
3966
3967 void
3968 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3969 {
3970 #ifdef PERL_OLD_COPY_ON_WRITE
3971     if (SvREADONLY(sv)) {
3972         /* At this point I believe I should acquire a global SV mutex.  */
3973         if (SvFAKE(sv)) {
3974             const char * const pvx = SvPVX_const(sv);
3975             const STRLEN len = SvLEN(sv);
3976             const STRLEN cur = SvCUR(sv);
3977             SV * const next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
3978             if (DEBUG_C_TEST) {
3979                 PerlIO_printf(Perl_debug_log,
3980                               "Copy on write: Force normal %ld\n",
3981                               (long) flags);
3982                 sv_dump(sv);
3983             }
3984             SvFAKE_off(sv);
3985             SvREADONLY_off(sv);
3986             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
3987             SvPV_set(sv, (char*)0);
3988             SvLEN_set(sv, 0);
3989             if (flags & SV_COW_DROP_PV) {
3990                 /* OK, so we don't need to copy our buffer.  */
3991                 SvPOK_off(sv);
3992             } else {
3993                 SvGROW(sv, cur + 1);
3994                 Move(pvx,SvPVX(sv),cur,char);
3995                 SvCUR_set(sv, cur);
3996                 *SvEND(sv) = '\0';
3997             }
3998             sv_release_COW(sv, pvx, len, next);
3999             if (DEBUG_C_TEST) {
4000                 sv_dump(sv);
4001             }
4002         }
4003         else if (IN_PERL_RUNTIME)
4004             Perl_croak(aTHX_ PL_no_modify);
4005         /* At this point I believe that I can drop the global SV mutex.  */
4006     }
4007 #else
4008     if (SvREADONLY(sv)) {
4009         if (SvFAKE(sv)) {
4010             const char * const pvx = SvPVX_const(sv);
4011             const STRLEN len = SvCUR(sv);
4012             SvFAKE_off(sv);
4013             SvREADONLY_off(sv);
4014             SvPV_set(sv, Nullch);
4015             SvLEN_set(sv, 0);
4016             SvGROW(sv, len + 1);
4017             Move(pvx,SvPVX(sv),len,char);
4018             *SvEND(sv) = '\0';
4019             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4020         }
4021         else if (IN_PERL_RUNTIME)
4022             Perl_croak(aTHX_ PL_no_modify);
4023     }
4024 #endif
4025     if (SvROK(sv))
4026         sv_unref_flags(sv, flags);
4027     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4028         sv_unglob(sv);
4029 }
4030
4031 /*
4032 =for apidoc sv_chop
4033
4034 Efficient removal of characters from the beginning of the string buffer.
4035 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4036 the string buffer.  The C<ptr> becomes the first character of the adjusted
4037 string. Uses the "OOK hack".
4038 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4039 refer to the same chunk of data.
4040
4041 =cut
4042 */
4043
4044 void
4045 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4046 {
4047     register STRLEN delta;
4048     if (!ptr || !SvPOKp(sv))
4049         return;
4050     delta = ptr - SvPVX_const(sv);
4051     SV_CHECK_THINKFIRST(sv);
4052     if (SvTYPE(sv) < SVt_PVIV)
4053         sv_upgrade(sv,SVt_PVIV);
4054
4055     if (!SvOOK(sv)) {
4056         if (!SvLEN(sv)) { /* make copy of shared string */
4057             const char *pvx = SvPVX_const(sv);
4058             const STRLEN len = SvCUR(sv);
4059             SvGROW(sv, len + 1);
4060             Move(pvx,SvPVX(sv),len,char);
4061             *SvEND(sv) = '\0';
4062         }
4063         SvIV_set(sv, 0);
4064         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4065            and we do that anyway inside the SvNIOK_off
4066         */
4067         SvFLAGS(sv) |= SVf_OOK;
4068     }
4069     SvNIOK_off(sv);
4070     SvLEN_set(sv, SvLEN(sv) - delta);
4071     SvCUR_set(sv, SvCUR(sv) - delta);
4072     SvPV_set(sv, SvPVX(sv) + delta);
4073     SvIV_set(sv, SvIVX(sv) + delta);
4074 }
4075
4076 /*
4077 =for apidoc sv_catpvn
4078
4079 Concatenates the string onto the end of the string which is in the SV.  The
4080 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4081 status set, then the bytes appended should be valid UTF-8.
4082 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4083
4084 =for apidoc sv_catpvn_flags
4085
4086 Concatenates the string onto the end of the string which is in the SV.  The
4087 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4088 status set, then the bytes appended should be valid UTF-8.
4089 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4090 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4091 in terms of this function.
4092
4093 =cut
4094 */
4095
4096 void
4097 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4098 {
4099     STRLEN dlen;
4100     const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4101
4102     SvGROW(dsv, dlen + slen + 1);
4103     if (sstr == dstr)
4104         sstr = SvPVX_const(dsv);
4105     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4106     SvCUR_set(dsv, SvCUR(dsv) + slen);
4107     *SvEND(dsv) = '\0';
4108     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4109     SvTAINT(dsv);
4110     if (flags & SV_SMAGIC)
4111         SvSETMAGIC(dsv);
4112 }
4113
4114 /*
4115 =for apidoc sv_catsv
4116
4117 Concatenates the string from SV C<ssv> onto the end of the string in
4118 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4119 not 'set' magic.  See C<sv_catsv_mg>.
4120
4121 =for apidoc sv_catsv_flags
4122
4123 Concatenates the string from SV C<ssv> onto the end of the string in
4124 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4125 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4126 and C<sv_catsv_nomg> are implemented in terms of this function.
4127
4128 =cut */
4129
4130 void
4131 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4132 {
4133     const char *spv;
4134     STRLEN slen;
4135     if (ssv) {
4136         if ((spv = SvPV_const(ssv, slen))) {
4137             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4138                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4139                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4140                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4141                 dsv->sv_flags doesn't have that bit set.
4142                 Andy Dougherty  12 Oct 2001
4143             */
4144             const I32 sutf8 = DO_UTF8(ssv);
4145             I32 dutf8;
4146
4147             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4148                 mg_get(dsv);
4149             dutf8 = DO_UTF8(dsv);
4150
4151             if (dutf8 != sutf8) {
4152                 if (dutf8) {
4153                     /* Not modifying source SV, so taking a temporary copy. */
4154                     SV* csv = sv_2mortal(newSVpvn(spv, slen));
4155
4156                     sv_utf8_upgrade(csv);
4157                     spv = SvPV_const(csv, slen);
4158                 }
4159                 else
4160                     sv_utf8_upgrade_nomg(dsv);
4161             }
4162             sv_catpvn_nomg(dsv, spv, slen);
4163         }
4164     }
4165     if (flags & SV_SMAGIC)
4166         SvSETMAGIC(dsv);
4167 }
4168
4169 /*
4170 =for apidoc sv_catpv
4171
4172 Concatenates the string onto the end of the string which is in the SV.
4173 If the SV has the UTF-8 status set, then the bytes appended should be
4174 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4175
4176 =cut */
4177
4178 void
4179 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4180 {
4181     register STRLEN len;
4182     STRLEN tlen;
4183     char *junk;
4184
4185     if (!ptr)
4186         return;
4187     junk = SvPV_force(sv, tlen);
4188     len = strlen(ptr);
4189     SvGROW(sv, tlen + len + 1);
4190     if (ptr == junk)
4191         ptr = SvPVX_const(sv);
4192     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4193     SvCUR_set(sv, SvCUR(sv) + len);
4194     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4195     SvTAINT(sv);
4196 }
4197
4198 /*
4199 =for apidoc sv_catpv_mg
4200
4201 Like C<sv_catpv>, but also handles 'set' magic.
4202
4203 =cut
4204 */
4205
4206 void
4207 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4208 {
4209     sv_catpv(sv,ptr);
4210     SvSETMAGIC(sv);
4211 }
4212
4213 /*
4214 =for apidoc newSV
4215
4216 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4217 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4218 macro.
4219
4220 =cut
4221 */
4222
4223 SV *
4224 Perl_newSV(pTHX_ STRLEN len)
4225 {
4226     register SV *sv;
4227
4228     new_SV(sv);
4229     if (len) {
4230         sv_upgrade(sv, SVt_PV);
4231         SvGROW(sv, len + 1);
4232     }
4233     return sv;
4234 }
4235 /*
4236 =for apidoc sv_magicext
4237
4238 Adds magic to an SV, upgrading it if necessary. Applies the
4239 supplied vtable and returns a pointer to the magic added.
4240
4241 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4242 In particular, you can add magic to SvREADONLY SVs, and add more than
4243 one instance of the same 'how'.
4244
4245 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4246 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4247 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4248 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4249
4250 (This is now used as a subroutine by C<sv_magic>.)
4251
4252 =cut
4253 */
4254 MAGIC * 
4255 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4256                  const char* name, I32 namlen)
4257 {
4258     MAGIC* mg;
4259
4260     if (SvTYPE(sv) < SVt_PVMG) {
4261         SvUPGRADE(sv, SVt_PVMG);
4262     }
4263     Newxz(mg, 1, MAGIC);
4264     mg->mg_moremagic = SvMAGIC(sv);
4265     SvMAGIC_set(sv, mg);
4266
4267     /* Sometimes a magic contains a reference loop, where the sv and
4268        object refer to each other.  To prevent a reference loop that
4269        would prevent such objects being freed, we look for such loops
4270        and if we find one we avoid incrementing the object refcount.
4271
4272        Note we cannot do this to avoid self-tie loops as intervening RV must
4273        have its REFCNT incremented to keep it in existence.
4274
4275     */
4276     if (!obj || obj == sv ||
4277         how == PERL_MAGIC_arylen ||
4278         how == PERL_MAGIC_qr ||
4279         how == PERL_MAGIC_symtab ||
4280         (SvTYPE(obj) == SVt_PVGV &&
4281             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4282             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4283             GvFORM(obj) == (CV*)sv)))
4284     {
4285         mg->mg_obj = obj;
4286     }
4287     else {
4288         mg->mg_obj = SvREFCNT_inc(obj);
4289         mg->mg_flags |= MGf_REFCOUNTED;
4290     }
4291
4292     /* Normal self-ties simply pass a null object, and instead of
4293        using mg_obj directly, use the SvTIED_obj macro to produce a
4294        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4295        with an RV obj pointing to the glob containing the PVIO.  In
4296        this case, to avoid a reference loop, we need to weaken the
4297        reference.
4298     */
4299
4300     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4301         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4302     {
4303       sv_rvweaken(obj);
4304     }
4305
4306     mg->mg_type = how;
4307     mg->mg_len = namlen;
4308     if (name) {
4309         if (namlen > 0)
4310             mg->mg_ptr = savepvn(name, namlen);
4311         else if (namlen == HEf_SVKEY)
4312             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4313         else
4314             mg->mg_ptr = (char *) name;
4315     }
4316     mg->mg_virtual = vtable;
4317
4318     mg_magical(sv);
4319     if (SvGMAGICAL(sv))
4320         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4321     return mg;
4322 }
4323
4324 /*
4325 =for apidoc sv_magic
4326
4327 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4328 then adds a new magic item of type C<how> to the head of the magic list.
4329
4330 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4331 handling of the C<name> and C<namlen> arguments.
4332
4333 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4334 to add more than one instance of the same 'how'.
4335
4336 =cut
4337 */
4338
4339 void
4340 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4341 {
4342     const MGVTBL *vtable;
4343     MAGIC* mg;
4344
4345 #ifdef PERL_OLD_COPY_ON_WRITE
4346     if (SvIsCOW(sv))
4347         sv_force_normal_flags(sv, 0);
4348 #endif
4349     if (SvREADONLY(sv)) {
4350         if (
4351             /* its okay to attach magic to shared strings; the subsequent
4352              * upgrade to PVMG will unshare the string */
4353             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4354
4355             && IN_PERL_RUNTIME
4356             && how != PERL_MAGIC_regex_global
4357             && how != PERL_MAGIC_bm
4358             && how != PERL_MAGIC_fm
4359             && how != PERL_MAGIC_sv
4360             && how != PERL_MAGIC_backref
4361            )
4362         {
4363             Perl_croak(aTHX_ PL_no_modify);
4364         }
4365     }
4366     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4367         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4368             /* sv_magic() refuses to add a magic of the same 'how' as an
4369                existing one
4370              */
4371             if (how == PERL_MAGIC_taint)
4372                 mg->mg_len |= 1;
4373             return;
4374         }
4375     }
4376
4377     switch (how) {
4378     case PERL_MAGIC_sv:
4379         vtable = &PL_vtbl_sv;
4380         break;
4381     case PERL_MAGIC_overload:
4382         vtable = &PL_vtbl_amagic;
4383         break;
4384     case PERL_MAGIC_overload_elem:
4385         vtable = &PL_vtbl_amagicelem;
4386         break;
4387     case PERL_MAGIC_overload_table:
4388         vtable = &PL_vtbl_ovrld;
4389         break;
4390     case PERL_MAGIC_bm:
4391         vtable = &PL_vtbl_bm;
4392         break;
4393     case PERL_MAGIC_regdata:
4394         vtable = &PL_vtbl_regdata;
4395         break;
4396     case PERL_MAGIC_regdatum:
4397         vtable = &PL_vtbl_regdatum;
4398         break;
4399     case PERL_MAGIC_env:
4400         vtable = &PL_vtbl_env;
4401         break;
4402     case PERL_MAGIC_fm:
4403         vtable = &PL_vtbl_fm;
4404         break;
4405     case PERL_MAGIC_envelem:
4406         vtable = &PL_vtbl_envelem;
4407         break;
4408     case PERL_MAGIC_regex_global:
4409         vtable = &PL_vtbl_mglob;
4410         break;
4411     case PERL_MAGIC_isa:
4412         vtable = &PL_vtbl_isa;
4413         break;
4414     case PERL_MAGIC_isaelem:
4415         vtable = &PL_vtbl_isaelem;
4416         break;
4417     case PERL_MAGIC_nkeys:
4418         vtable = &PL_vtbl_nkeys;
4419         break;
4420     case PERL_MAGIC_dbfile:
4421         vtable = NULL;
4422         break;
4423     case PERL_MAGIC_dbline:
4424         vtable = &PL_vtbl_dbline;
4425         break;
4426 #ifdef USE_LOCALE_COLLATE
4427     case PERL_MAGIC_collxfrm:
4428         vtable = &PL_vtbl_collxfrm;
4429         break;
4430 #endif /* USE_LOCALE_COLLATE */
4431     case PERL_MAGIC_tied:
4432         vtable = &PL_vtbl_pack;
4433         break;
4434     case PERL_MAGIC_tiedelem:
4435     case PERL_MAGIC_tiedscalar:
4436         vtable = &PL_vtbl_packelem;
4437         break;
4438     case PERL_MAGIC_qr:
4439         vtable = &PL_vtbl_regexp;
4440         break;
4441     case PERL_MAGIC_sig:
4442         vtable = &PL_vtbl_sig;
4443         break;
4444     case PERL_MAGIC_sigelem:
4445         vtable = &PL_vtbl_sigelem;
4446         break;
4447     case PERL_MAGIC_taint:
4448         vtable = &PL_vtbl_taint;
4449         break;
4450     case PERL_MAGIC_uvar:
4451         vtable = &PL_vtbl_uvar;
4452         break;
4453     case PERL_MAGIC_vec:
4454         vtable = &PL_vtbl_vec;
4455         break;
4456     case PERL_MAGIC_arylen_p:
4457     case PERL_MAGIC_rhash:
4458     case PERL_MAGIC_symtab:
4459     case PERL_MAGIC_vstring:
4460         vtable = NULL;
4461         break;
4462     case PERL_MAGIC_utf8:
4463         vtable = &PL_vtbl_utf8;
4464         break;
4465     case PERL_MAGIC_substr:
4466         vtable = &PL_vtbl_substr;
4467         break;
4468     case PERL_MAGIC_defelem:
4469         vtable = &PL_vtbl_defelem;
4470         break;
4471     case PERL_MAGIC_glob:
4472         vtable = &PL_vtbl_glob;
4473         break;
4474     case PERL_MAGIC_arylen:
4475         vtable = &PL_vtbl_arylen;
4476         break;
4477     case PERL_MAGIC_pos:
4478         vtable = &PL_vtbl_pos;
4479         break;
4480     case PERL_MAGIC_backref:
4481         vtable = &PL_vtbl_backref;
4482         break;
4483     case PERL_MAGIC_ext:
4484         /* Reserved for use by extensions not perl internals.           */
4485         /* Useful for attaching extension internal data to perl vars.   */
4486         /* Note that multiple extensions may clash if magical scalars   */
4487         /* etc holding private data from one are passed to another.     */
4488         vtable = NULL;
4489         break;
4490     default:
4491         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4492     }
4493
4494     /* Rest of work is done else where */
4495     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4496
4497     switch (how) {
4498     case PERL_MAGIC_taint:
4499         mg->mg_len = 1;
4500         break;
4501     case PERL_MAGIC_ext:
4502     case PERL_MAGIC_dbfile:
4503         SvRMAGICAL_on(sv);
4504         break;
4505     }
4506 }
4507
4508 /*
4509 =for apidoc sv_unmagic
4510
4511 Removes all magic of type C<type> from an SV.
4512
4513 =cut
4514 */
4515
4516 int
4517 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4518 {
4519     MAGIC* mg;
4520     MAGIC** mgp;
4521     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4522         return 0;
4523     mgp = &SvMAGIC(sv);
4524     for (mg = *mgp; mg; mg = *mgp) {
4525         if (mg->mg_type == type) {
4526             const MGVTBL* const vtbl = mg->mg_virtual;
4527             *mgp = mg->mg_moremagic;
4528             if (vtbl && vtbl->svt_free)
4529                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4530             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4531                 if (mg->mg_len > 0)
4532                     Safefree(mg->mg_ptr);
4533                 else if (mg->mg_len == HEf_SVKEY)
4534                     SvREFCNT_dec((SV*)mg->mg_ptr);
4535                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4536                     Safefree(mg->mg_ptr);
4537             }
4538             if (mg->mg_flags & MGf_REFCOUNTED)
4539                 SvREFCNT_dec(mg->mg_obj);
4540             Safefree(mg);
4541         }
4542         else
4543             mgp = &mg->mg_moremagic;
4544     }
4545     if (!SvMAGIC(sv)) {
4546         SvMAGICAL_off(sv);
4547        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4548     }
4549
4550     return 0;
4551 }
4552
4553 /*
4554 =for apidoc sv_rvweaken
4555
4556 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4557 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4558 push a back-reference to this RV onto the array of backreferences
4559 associated with that magic.
4560
4561 =cut
4562 */
4563
4564 SV *
4565 Perl_sv_rvweaken(pTHX_ SV *sv)
4566 {
4567     SV *tsv;
4568     if (!SvOK(sv))  /* let undefs pass */
4569         return sv;
4570     if (!SvROK(sv))
4571         Perl_croak(aTHX_ "Can't weaken a nonreference");
4572     else if (SvWEAKREF(sv)) {
4573         if (ckWARN(WARN_MISC))
4574             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4575         return sv;
4576     }
4577     tsv = SvRV(sv);
4578     Perl_sv_add_backref(aTHX_ tsv, sv);
4579     SvWEAKREF_on(sv);
4580     SvREFCNT_dec(tsv);
4581     return sv;
4582 }
4583
4584 /* Give tsv backref magic if it hasn't already got it, then push a
4585  * back-reference to sv onto the array associated with the backref magic.
4586  */
4587
4588 void
4589 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4590 {
4591     AV *av;
4592     MAGIC *mg;
4593     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4594         av = (AV*)mg->mg_obj;
4595     else {
4596         av = newAV();
4597         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4598         /* av now has a refcnt of 2, which avoids it getting freed
4599          * before us during global cleanup. The extra ref is removed
4600          * by magic_killbackrefs() when tsv is being freed */
4601     }
4602     if (AvFILLp(av) >= AvMAX(av)) {
4603         av_extend(av, AvFILLp(av)+1);
4604     }
4605     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4606 }
4607
4608 /* delete a back-reference to ourselves from the backref magic associated
4609  * with the SV we point to.
4610  */
4611
4612 STATIC void
4613 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4614 {
4615     AV *av;
4616     SV **svp;
4617     I32 i;
4618     MAGIC *mg = NULL;
4619     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4620         if (PL_in_clean_all)
4621             return;
4622     }
4623     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4624         Perl_croak(aTHX_ "panic: del_backref");
4625     av = (AV *)mg->mg_obj;
4626     svp = AvARRAY(av);
4627     /* We shouldn't be in here more than once, but for paranoia reasons lets
4628        not assume this.  */
4629     for (i = AvFILLp(av); i >= 0; i--) {
4630         if (svp[i] == sv) {
4631             const SSize_t fill = AvFILLp(av);
4632             if (i != fill) {
4633                 /* We weren't the last entry.
4634                    An unordered list has this property that you can take the
4635                    last element off the end to fill the hole, and it's still
4636                    an unordered list :-)
4637                 */
4638                 svp[i] = svp[fill];
4639             }
4640             svp[fill] = Nullsv;
4641             AvFILLp(av) = fill - 1;
4642         }
4643     }
4644 }
4645
4646 /*
4647 =for apidoc sv_insert
4648
4649 Inserts a string at the specified offset/length within the SV. Similar to
4650 the Perl substr() function.
4651
4652 =cut
4653 */
4654
4655 void
4656 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4657 {
4658     register char *big;
4659     register char *mid;
4660     register char *midend;
4661     register char *bigend;
4662     register I32 i;
4663     STRLEN curlen;
4664
4665
4666     if (!bigstr)
4667         Perl_croak(aTHX_ "Can't modify non-existent substring");
4668     SvPV_force(bigstr, curlen);
4669     (void)SvPOK_only_UTF8(bigstr);
4670     if (offset + len > curlen) {
4671         SvGROW(bigstr, offset+len+1);
4672         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4673         SvCUR_set(bigstr, offset+len);
4674     }
4675
4676     SvTAINT(bigstr);
4677     i = littlelen - len;
4678     if (i > 0) {                        /* string might grow */
4679         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4680         mid = big + offset + len;
4681         midend = bigend = big + SvCUR(bigstr);
4682         bigend += i;
4683         *bigend = '\0';
4684         while (midend > mid)            /* shove everything down */
4685             *--bigend = *--midend;
4686         Move(little,big+offset,littlelen,char);
4687         SvCUR_set(bigstr, SvCUR(bigstr) + i);
4688         SvSETMAGIC(bigstr);
4689         return;
4690     }
4691     else if (i == 0) {