This patch with tests resolves CPAN RT #40727. The issue is an infi-
[perl.git] / sv.c
1 /*    sv.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall
5  *    and others
6  *
7  *    You may distribute under the terms of either the GNU General Public
8  *    License or the Artistic License, as specified in the README file.
9  *
10  */
11
12 /*
13  * 'I wonder what the Entish is for "yes" and "no",' he thought.
14  *                                                      --Pippin
15  *
16  *     [p.480 of _The Lord of the Rings_, III/iv: "Treebeard"]
17  */
18
19 /*
20  *
21  *
22  * This file contains the code that creates, manipulates and destroys
23  * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
24  * structure of an SV, so their creation and destruction is handled
25  * here; higher-level functions are in av.c, hv.c, and so on. Opcode
26  * level functions (eg. substr, split, join) for each of the types are
27  * in the pp*.c files.
28  */
29
30 #include "EXTERN.h"
31 #define PERL_IN_SV_C
32 #include "perl.h"
33 #include "regcomp.h"
34
35 #define FCALL *f
36
37 #ifdef __Lynx__
38 /* Missing proto on LynxOS */
39   char *gconvert(double, int, int,  char *);
40 #endif
41
42 #ifdef PERL_UTF8_CACHE_ASSERT
43 /* if adding more checks watch out for the following tests:
44  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
45  *   lib/utf8.t lib/Unicode/Collate/t/index.t
46  * --jhi
47  */
48 #   define ASSERT_UTF8_CACHE(cache) \
49     STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
50                               assert((cache)[2] <= (cache)[3]); \
51                               assert((cache)[3] <= (cache)[1]);} \
52                               } STMT_END
53 #else
54 #   define ASSERT_UTF8_CACHE(cache) NOOP
55 #endif
56
57 #ifdef PERL_OLD_COPY_ON_WRITE
58 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
59 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
60 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
61    on-write.  */
62 #endif
63
64 /* ============================================================================
65
66 =head1 Allocation and deallocation of SVs.
67
68 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
69 sv, av, hv...) contains type and reference count information, and for
70 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
71 contains fields specific to each type.  Some types store all they need
72 in the head, so don't have a body.
73
74 In all but the most memory-paranoid configuations (ex: PURIFY), heads
75 and bodies are allocated out of arenas, which by default are
76 approximately 4K chunks of memory parcelled up into N heads or bodies.
77 Sv-bodies are allocated by their sv-type, guaranteeing size
78 consistency needed to allocate safely from arrays.
79
80 For SV-heads, the first slot in each arena is reserved, and holds a
81 link to the next arena, some flags, and a note of the number of slots.
82 Snaked through each arena chain is a linked list of free items; when
83 this becomes empty, an extra arena is allocated and divided up into N
84 items which are threaded into the free list.
85
86 SV-bodies are similar, but they use arena-sets by default, which
87 separate the link and info from the arena itself, and reclaim the 1st
88 slot in the arena.  SV-bodies are further described later.
89
90 The following global variables are associated with arenas:
91
92     PL_sv_arenaroot     pointer to list of SV arenas
93     PL_sv_root          pointer to list of free SV structures
94
95     PL_body_arenas      head of linked-list of body arenas
96     PL_body_roots[]     array of pointers to list of free bodies of svtype
97                         arrays are indexed by the svtype needed
98
99 A few special SV heads are not allocated from an arena, but are
100 instead directly created in the interpreter structure, eg PL_sv_undef.
101 The size of arenas can be changed from the default by setting
102 PERL_ARENA_SIZE appropriately at compile time.
103
104 The SV arena serves the secondary purpose of allowing still-live SVs
105 to be located and destroyed during final cleanup.
106
107 At the lowest level, the macros new_SV() and del_SV() grab and free
108 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
109 to return the SV to the free list with error checking.) new_SV() calls
110 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
111 SVs in the free list have their SvTYPE field set to all ones.
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 The function visit() scans the SV arenas list, and calls a specified
118 function for each SV it finds which is still live - ie which has an SvTYPE
119 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
120 following functions (specified as [function that calls visit()] / [function
121 called by visit() for each SV]):
122
123     sv_report_used() / do_report_used()
124                         dump all remaining SVs (debugging aid)
125
126     sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
127                       do_clean_named_io_objs()
128                         Attempt to free all objects pointed to by RVs,
129                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
130                         try to do the same for all objects indirectly
131                         referenced by typeglobs too.  Called once from
132                         perl_destruct(), prior to calling sv_clean_all()
133                         below.
134
135     sv_clean_all() / do_clean_all()
136                         SvREFCNT_dec(sv) each remaining SV, possibly
137                         triggering an sv_free(). It also sets the
138                         SVf_BREAK flag on the SV to indicate that the
139                         refcnt has been artificially lowered, and thus
140                         stopping sv_free() from giving spurious warnings
141                         about SVs which unexpectedly have a refcnt
142                         of zero.  called repeatedly from perl_destruct()
143                         until there are no SVs left.
144
145 =head2 Arena allocator API Summary
146
147 Private API to rest of sv.c
148
149     new_SV(),  del_SV(),
150
151     new_XPVNV(), del_XPVGV(),
152     etc
153
154 Public API:
155
156     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
157
158 =cut
159
160  * ========================================================================= */
161
162 /*
163  * "A time to plant, and a time to uproot what was planted..."
164  */
165
166 #ifdef PERL_MEM_LOG
167 #  define MEM_LOG_NEW_SV(sv, file, line, func)  \
168             Perl_mem_log_new_sv(sv, file, line, func)
169 #  define MEM_LOG_DEL_SV(sv, file, line, func)  \
170             Perl_mem_log_del_sv(sv, file, line, func)
171 #else
172 #  define MEM_LOG_NEW_SV(sv, file, line, func)  NOOP
173 #  define MEM_LOG_DEL_SV(sv, file, line, func)  NOOP
174 #endif
175
176 #ifdef DEBUG_LEAKING_SCALARS
177 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
178 #  define DEBUG_SV_SERIAL(sv)                                               \
179     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n",    \
180             PTR2UV(sv), (long)(sv)->sv_debug_serial))
181 #else
182 #  define FREE_SV_DEBUG_FILE(sv)
183 #  define DEBUG_SV_SERIAL(sv)   NOOP
184 #endif
185
186 #ifdef PERL_POISON
187 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
188 #  define SvARENA_CHAIN_SET(sv,val)     (sv)->sv_u.svu_rv = MUTABLE_SV((val))
189 /* Whilst I'd love to do this, it seems that things like to check on
190    unreferenced scalars
191 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
192 */
193 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
194                                 PoisonNew(&SvREFCNT(sv), 1, U32)
195 #else
196 #  define SvARENA_CHAIN(sv)     SvANY(sv)
197 #  define SvARENA_CHAIN_SET(sv,val)     SvANY(sv) = (void *)(val)
198 #  define POSION_SV_HEAD(sv)
199 #endif
200
201 /* Mark an SV head as unused, and add to free list.
202  *
203  * If SVf_BREAK is set, skip adding it to the free list, as this SV had
204  * its refcount artificially decremented during global destruction, so
205  * there may be dangling pointers to it. The last thing we want in that
206  * case is for it to be reused. */
207
208 #define plant_SV(p) \
209     STMT_START {                                        \
210         const U32 old_flags = SvFLAGS(p);                       \
211         MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__);  \
212         DEBUG_SV_SERIAL(p);                             \
213         FREE_SV_DEBUG_FILE(p);                          \
214         POSION_SV_HEAD(p);                              \
215         SvFLAGS(p) = SVTYPEMASK;                        \
216         if (!(old_flags & SVf_BREAK)) {         \
217             SvARENA_CHAIN_SET(p, PL_sv_root);   \
218             PL_sv_root = (p);                           \
219         }                                               \
220         --PL_sv_count;                                  \
221     } STMT_END
222
223 #define uproot_SV(p) \
224     STMT_START {                                        \
225         (p) = PL_sv_root;                               \
226         PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p));              \
227         ++PL_sv_count;                                  \
228     } STMT_END
229
230
231 /* make some more SVs by adding another arena */
232
233 STATIC SV*
234 S_more_sv(pTHX)
235 {
236     dVAR;
237     SV* sv;
238     char *chunk;                /* must use New here to match call to */
239     Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
240     sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
241     uproot_SV(sv);
242     return sv;
243 }
244
245 /* new_SV(): return a new, empty SV head */
246
247 #ifdef DEBUG_LEAKING_SCALARS
248 /* provide a real function for a debugger to play with */
249 STATIC SV*
250 S_new_SV(pTHX_ const char *file, int line, const char *func)
251 {
252     SV* sv;
253
254     if (PL_sv_root)
255         uproot_SV(sv);
256     else
257         sv = S_more_sv(aTHX);
258     SvANY(sv) = 0;
259     SvREFCNT(sv) = 1;
260     SvFLAGS(sv) = 0;
261     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
262     sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
263                 ? PL_parser->copline
264                 :  PL_curcop
265                     ? CopLINE(PL_curcop)
266                     : 0
267             );
268     sv->sv_debug_inpad = 0;
269     sv->sv_debug_parent = NULL;
270     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271
272     sv->sv_debug_serial = PL_sv_serial++;
273
274     MEM_LOG_NEW_SV(sv, file, line, func);
275     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
276             PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
277
278     return sv;
279 }
280 #  define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
281
282 #else
283 #  define new_SV(p) \
284     STMT_START {                                        \
285         if (PL_sv_root)                                 \
286             uproot_SV(p);                               \
287         else                                            \
288             (p) = S_more_sv(aTHX);                      \
289         SvANY(p) = 0;                                   \
290         SvREFCNT(p) = 1;                                \
291         SvFLAGS(p) = 0;                                 \
292         MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__);  \
293     } STMT_END
294 #endif
295
296
297 /* del_SV(): return an empty SV head to the free list */
298
299 #ifdef DEBUGGING
300
301 #define del_SV(p) \
302     STMT_START {                                        \
303         if (DEBUG_D_TEST)                               \
304             del_sv(p);                                  \
305         else                                            \
306             plant_SV(p);                                \
307     } STMT_END
308
309 STATIC void
310 S_del_sv(pTHX_ SV *p)
311 {
312     dVAR;
313
314     PERL_ARGS_ASSERT_DEL_SV;
315
316     if (DEBUG_D_TEST) {
317         SV* sva;
318         bool ok = 0;
319         for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
320             const SV * const sv = sva + 1;
321             const SV * const svend = &sva[SvREFCNT(sva)];
322             if (p >= sv && p < svend) {
323                 ok = 1;
324                 break;
325             }
326         }
327         if (!ok) {
328             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
329                              "Attempt to free non-arena SV: 0x%"UVxf
330                              pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
331             return;
332         }
333     }
334     plant_SV(p);
335 }
336
337 #else /* ! DEBUGGING */
338
339 #define del_SV(p)   plant_SV(p)
340
341 #endif /* DEBUGGING */
342
343
344 /*
345 =head1 SV Manipulation Functions
346
347 =for apidoc sv_add_arena
348
349 Given a chunk of memory, link it to the head of the list of arenas,
350 and split it into a list of free SVs.
351
352 =cut
353 */
354
355 static void
356 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
357 {
358     dVAR;
359     SV *const sva = MUTABLE_SV(ptr);
360     register SV* sv;
361     register SV* svend;
362
363     PERL_ARGS_ASSERT_SV_ADD_ARENA;
364
365     /* The first SV in an arena isn't an SV. */
366     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
367     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
368     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
369
370     PL_sv_arenaroot = sva;
371     PL_sv_root = sva + 1;
372
373     svend = &sva[SvREFCNT(sva) - 1];
374     sv = sva + 1;
375     while (sv < svend) {
376         SvARENA_CHAIN_SET(sv, (sv + 1));
377 #ifdef DEBUGGING
378         SvREFCNT(sv) = 0;
379 #endif
380         /* Must always set typemask because it's always checked in on cleanup
381            when the arenas are walked looking for objects.  */
382         SvFLAGS(sv) = SVTYPEMASK;
383         sv++;
384     }
385     SvARENA_CHAIN_SET(sv, 0);
386 #ifdef DEBUGGING
387     SvREFCNT(sv) = 0;
388 #endif
389     SvFLAGS(sv) = SVTYPEMASK;
390 }
391
392 /* visit(): call the named function for each non-free SV in the arenas
393  * whose flags field matches the flags/mask args. */
394
395 STATIC I32
396 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
397 {
398     dVAR;
399     SV* sva;
400     I32 visited = 0;
401
402     PERL_ARGS_ASSERT_VISIT;
403
404     for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
405         register const SV * const svend = &sva[SvREFCNT(sva)];
406         register SV* sv;
407         for (sv = sva + 1; sv < svend; ++sv) {
408             if (SvTYPE(sv) != SVTYPEMASK
409                     && (sv->sv_flags & mask) == flags
410                     && SvREFCNT(sv))
411             {
412                 (FCALL)(aTHX_ sv);
413                 ++visited;
414             }
415         }
416     }
417     return visited;
418 }
419
420 #ifdef DEBUGGING
421
422 /* called by sv_report_used() for each live SV */
423
424 static void
425 do_report_used(pTHX_ SV *const sv)
426 {
427     if (SvTYPE(sv) != SVTYPEMASK) {
428         PerlIO_printf(Perl_debug_log, "****\n");
429         sv_dump(sv);
430     }
431 }
432 #endif
433
434 /*
435 =for apidoc sv_report_used
436
437 Dump the contents of all SVs not yet freed. (Debugging aid).
438
439 =cut
440 */
441
442 void
443 Perl_sv_report_used(pTHX)
444 {
445 #ifdef DEBUGGING
446     visit(do_report_used, 0, 0);
447 #else
448     PERL_UNUSED_CONTEXT;
449 #endif
450 }
451
452 /* called by sv_clean_objs() for each live SV */
453
454 static void
455 do_clean_objs(pTHX_ SV *const ref)
456 {
457     dVAR;
458     assert (SvROK(ref));
459     {
460         SV * const target = SvRV(ref);
461         if (SvOBJECT(target)) {
462             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
463             if (SvWEAKREF(ref)) {
464                 sv_del_backref(target, ref);
465                 SvWEAKREF_off(ref);
466                 SvRV_set(ref, NULL);
467             } else {
468                 SvROK_off(ref);
469                 SvRV_set(ref, NULL);
470                 SvREFCNT_dec(target);
471             }
472         }
473     }
474
475     /* XXX Might want to check arrays, etc. */
476 }
477
478
479 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480
481 /* clear any slots in a GV which hold objects - except IO;
482  * called by sv_clean_objs() for each live GV */
483
484 static void
485 do_clean_named_objs(pTHX_ SV *const sv)
486 {
487     dVAR;
488     SV *obj;
489     assert(SvTYPE(sv) == SVt_PVGV);
490     assert(isGV_with_GP(sv));
491     if (!GvGP(sv))
492         return;
493
494     /* freeing GP entries may indirectly free the current GV;
495      * hold onto it while we mess with the GP slots */
496     SvREFCNT_inc(sv);
497
498     if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
499         DEBUG_D((PerlIO_printf(Perl_debug_log,
500                 "Cleaning named glob SV object:\n "), sv_dump(obj)));
501         GvSV(sv) = NULL;
502         SvREFCNT_dec(obj);
503     }
504     if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
505         DEBUG_D((PerlIO_printf(Perl_debug_log,
506                 "Cleaning named glob AV object:\n "), sv_dump(obj)));
507         GvAV(sv) = NULL;
508         SvREFCNT_dec(obj);
509     }
510     if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
511         DEBUG_D((PerlIO_printf(Perl_debug_log,
512                 "Cleaning named glob HV object:\n "), sv_dump(obj)));
513         GvHV(sv) = NULL;
514         SvREFCNT_dec(obj);
515     }
516     if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
517         DEBUG_D((PerlIO_printf(Perl_debug_log,
518                 "Cleaning named glob CV object:\n "), sv_dump(obj)));
519         GvCV(sv) = NULL;
520         SvREFCNT_dec(obj);
521     }
522     SvREFCNT_dec(sv); /* undo the inc above */
523 }
524
525 /* clear any IO slots in a GV which hold objects (except stderr, defout);
526  * called by sv_clean_objs() for each live GV */
527
528 static void
529 do_clean_named_io_objs(pTHX_ SV *const sv)
530 {
531     dVAR;
532     SV *obj;
533     assert(SvTYPE(sv) == SVt_PVGV);
534     assert(isGV_with_GP(sv));
535     if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
536         return;
537
538     SvREFCNT_inc(sv);
539     if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
540         DEBUG_D((PerlIO_printf(Perl_debug_log,
541                 "Cleaning named glob IO object:\n "), sv_dump(obj)));
542         GvIOp(sv) = NULL;
543         SvREFCNT_dec(obj);
544     }
545     SvREFCNT_dec(sv); /* undo the inc above */
546 }
547 #endif
548
549 /*
550 =for apidoc sv_clean_objs
551
552 Attempt to destroy all objects not yet freed
553
554 =cut
555 */
556
557 void
558 Perl_sv_clean_objs(pTHX)
559 {
560     dVAR;
561     GV *olddef, *olderr;
562     PL_in_clean_objs = TRUE;
563     visit(do_clean_objs, SVf_ROK, SVf_ROK);
564 #ifndef DISABLE_DESTRUCTOR_KLUDGE
565     /* Some barnacles may yet remain, clinging to typeglobs.
566      * Run the non-IO destructors first: they may want to output
567      * error messages, close files etc */
568     visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
569     visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
570     olddef = PL_defoutgv;
571     PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
572     if (olddef && isGV_with_GP(olddef))
573         do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
574     olderr = PL_stderrgv;
575     PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
576     if (olderr && isGV_with_GP(olderr))
577         do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
578     SvREFCNT_dec(olddef);
579 #endif
580     PL_in_clean_objs = FALSE;
581 }
582
583 /* called by sv_clean_all() for each live SV */
584
585 static void
586 do_clean_all(pTHX_ SV *const sv)
587 {
588     dVAR;
589     if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
590         /* don't clean pid table and strtab */
591         return;
592     }
593     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
594     SvFLAGS(sv) |= SVf_BREAK;
595     SvREFCNT_dec(sv);
596 }
597
598 /*
599 =for apidoc sv_clean_all
600
601 Decrement the refcnt of each remaining SV, possibly triggering a
602 cleanup. This function may have to be called multiple times to free
603 SVs which are in complex self-referential hierarchies.
604
605 =cut
606 */
607
608 I32
609 Perl_sv_clean_all(pTHX)
610 {
611     dVAR;
612     I32 cleaned;
613     PL_in_clean_all = TRUE;
614     cleaned = visit(do_clean_all, 0,0);
615     return cleaned;
616 }
617
618 /*
619   ARENASETS: a meta-arena implementation which separates arena-info
620   into struct arena_set, which contains an array of struct
621   arena_descs, each holding info for a single arena.  By separating
622   the meta-info from the arena, we recover the 1st slot, formerly
623   borrowed for list management.  The arena_set is about the size of an
624   arena, avoiding the needless malloc overhead of a naive linked-list.
625
626   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
627   memory in the last arena-set (1/2 on average).  In trade, we get
628   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
629   smaller types).  The recovery of the wasted space allows use of
630   small arenas for large, rare body types, by changing array* fields
631   in body_details_by_type[] below.
632 */
633 struct arena_desc {
634     char       *arena;          /* the raw storage, allocated aligned */
635     size_t      size;           /* its size ~4k typ */
636     svtype      utype;          /* bodytype stored in arena */
637 };
638
639 struct arena_set;
640
641 /* Get the maximum number of elements in set[] such that struct arena_set
642    will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
643    therefore likely to be 1 aligned memory page.  */
644
645 #define ARENAS_PER_SET  ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
646                           - 2 * sizeof(int)) / sizeof (struct arena_desc))
647
648 struct arena_set {
649     struct arena_set* next;
650     unsigned int   set_size;    /* ie ARENAS_PER_SET */
651     unsigned int   curr;        /* index of next available arena-desc */
652     struct arena_desc set[ARENAS_PER_SET];
653 };
654
655 /*
656 =for apidoc sv_free_arenas
657
658 Deallocate the memory used by all arenas. Note that all the individual SV
659 heads and bodies within the arenas must already have been freed.
660
661 =cut
662 */
663 void
664 Perl_sv_free_arenas(pTHX)
665 {
666     dVAR;
667     SV* sva;
668     SV* svanext;
669     unsigned int i;
670
671     /* Free arenas here, but be careful about fake ones.  (We assume
672        contiguity of the fake ones with the corresponding real ones.) */
673
674     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
675         svanext = MUTABLE_SV(SvANY(sva));
676         while (svanext && SvFAKE(svanext))
677             svanext = MUTABLE_SV(SvANY(svanext));
678
679         if (!SvFAKE(sva))
680             Safefree(sva);
681     }
682
683     {
684         struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
685
686         while (aroot) {
687             struct arena_set *current = aroot;
688             i = aroot->curr;
689             while (i--) {
690                 assert(aroot->set[i].arena);
691                 Safefree(aroot->set[i].arena);
692             }
693             aroot = aroot->next;
694             Safefree(current);
695         }
696     }
697     PL_body_arenas = 0;
698
699     i = PERL_ARENA_ROOTS_SIZE;
700     while (i--)
701         PL_body_roots[i] = 0;
702
703     PL_sv_arenaroot = 0;
704     PL_sv_root = 0;
705 }
706
707 /*
708   Here are mid-level routines that manage the allocation of bodies out
709   of the various arenas.  There are 5 kinds of arenas:
710
711   1. SV-head arenas, which are discussed and handled above
712   2. regular body arenas
713   3. arenas for reduced-size bodies
714   4. Hash-Entry arenas
715
716   Arena types 2 & 3 are chained by body-type off an array of
717   arena-root pointers, which is indexed by svtype.  Some of the
718   larger/less used body types are malloced singly, since a large
719   unused block of them is wasteful.  Also, several svtypes dont have
720   bodies; the data fits into the sv-head itself.  The arena-root
721   pointer thus has a few unused root-pointers (which may be hijacked
722   later for arena types 4,5)
723
724   3 differs from 2 as an optimization; some body types have several
725   unused fields in the front of the structure (which are kept in-place
726   for consistency).  These bodies can be allocated in smaller chunks,
727   because the leading fields arent accessed.  Pointers to such bodies
728   are decremented to point at the unused 'ghost' memory, knowing that
729   the pointers are used with offsets to the real memory.
730
731
732 =head1 SV-Body Allocation
733
734 Allocation of SV-bodies is similar to SV-heads, differing as follows;
735 the allocation mechanism is used for many body types, so is somewhat
736 more complicated, it uses arena-sets, and has no need for still-live
737 SV detection.
738
739 At the outermost level, (new|del)_X*V macros return bodies of the
740 appropriate type.  These macros call either (new|del)_body_type or
741 (new|del)_body_allocated macro pairs, depending on specifics of the
742 type.  Most body types use the former pair, the latter pair is used to
743 allocate body types with "ghost fields".
744
745 "ghost fields" are fields that are unused in certain types, and
746 consequently don't need to actually exist.  They are declared because
747 they're part of a "base type", which allows use of functions as
748 methods.  The simplest examples are AVs and HVs, 2 aggregate types
749 which don't use the fields which support SCALAR semantics.
750
751 For these types, the arenas are carved up into appropriately sized
752 chunks, we thus avoid wasted memory for those unaccessed members.
753 When bodies are allocated, we adjust the pointer back in memory by the
754 size of the part not allocated, so it's as if we allocated the full
755 structure.  (But things will all go boom if you write to the part that
756 is "not there", because you'll be overwriting the last members of the
757 preceding structure in memory.)
758
759 We calculate the correction using the STRUCT_OFFSET macro on the first
760 member present. If the allocated structure is smaller (no initial NV
761 actually allocated) then the net effect is to subtract the size of the NV
762 from the pointer, to return a new pointer as if an initial NV were actually
763 allocated. (We were using structures named *_allocated for this, but
764 this turned out to be a subtle bug, because a structure without an NV
765 could have a lower alignment constraint, but the compiler is allowed to
766 optimised accesses based on the alignment constraint of the actual pointer
767 to the full structure, for example, using a single 64 bit load instruction
768 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
769
770 This is the same trick as was used for NV and IV bodies. Ironically it
771 doesn't need to be used for NV bodies any more, because NV is now at
772 the start of the structure. IV bodies don't need it either, because
773 they are no longer allocated.
774
775 In turn, the new_body_* allocators call S_new_body(), which invokes
776 new_body_inline macro, which takes a lock, and takes a body off the
777 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
778 necessary to refresh an empty list.  Then the lock is released, and
779 the body is returned.
780
781 Perl_more_bodies allocates a new arena, and carves it up into an array of N
782 bodies, which it strings into a linked list.  It looks up arena-size
783 and body-size from the body_details table described below, thus
784 supporting the multiple body-types.
785
786 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
787 the (new|del)_X*V macros are mapped directly to malloc/free.
788
789 For each sv-type, struct body_details bodies_by_type[] carries
790 parameters which control these aspects of SV handling:
791
792 Arena_size determines whether arenas are used for this body type, and if
793 so, how big they are.  PURIFY or PERL_ARENA_SIZE=0 set this field to
794 zero, forcing individual mallocs and frees.
795
796 Body_size determines how big a body is, and therefore how many fit into
797 each arena.  Offset carries the body-pointer adjustment needed for
798 "ghost fields", and is used in *_allocated macros.
799
800 But its main purpose is to parameterize info needed in
801 Perl_sv_upgrade().  The info here dramatically simplifies the function
802 vs the implementation in 5.8.8, making it table-driven.  All fields
803 are used for this, except for arena_size.
804
805 For the sv-types that have no bodies, arenas are not used, so those
806 PL_body_roots[sv_type] are unused, and can be overloaded.  In
807 something of a special case, SVt_NULL is borrowed for HE arenas;
808 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
809 bodies_by_type[SVt_NULL] slot is not used, as the table is not
810 available in hv.c.
811
812 */
813
814 struct body_details {
815     U8 body_size;       /* Size to allocate  */
816     U8 copy;            /* Size of structure to copy (may be shorter)  */
817     U8 offset;
818     unsigned int type : 4;          /* We have space for a sanity check.  */
819     unsigned int cant_upgrade : 1;  /* Cannot upgrade this type */
820     unsigned int zero_nv : 1;       /* zero the NV when upgrading from this */
821     unsigned int arena : 1;         /* Allocated from an arena */
822     size_t arena_size;              /* Size of arena to allocate */
823 };
824
825 #define HADNV FALSE
826 #define NONV TRUE
827
828
829 #ifdef PURIFY
830 /* With -DPURFIY we allocate everything directly, and don't use arenas.
831    This seems a rather elegant way to simplify some of the code below.  */
832 #define HASARENA FALSE
833 #else
834 #define HASARENA TRUE
835 #endif
836 #define NOARENA FALSE
837
838 /* Size the arenas to exactly fit a given number of bodies.  A count
839    of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
840    simplifying the default.  If count > 0, the arena is sized to fit
841    only that many bodies, allowing arenas to be used for large, rare
842    bodies (XPVFM, XPVIO) without undue waste.  The arena size is
843    limited by PERL_ARENA_SIZE, so we can safely oversize the
844    declarations.
845  */
846 #define FIT_ARENA0(body_size)                           \
847     ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
848 #define FIT_ARENAn(count,body_size)                     \
849     ( count * body_size <= PERL_ARENA_SIZE)             \
850     ? count * body_size                                 \
851     : FIT_ARENA0 (body_size)
852 #define FIT_ARENA(count,body_size)                      \
853     count                                               \
854     ? FIT_ARENAn (count, body_size)                     \
855     : FIT_ARENA0 (body_size)
856
857 /* Calculate the length to copy. Specifically work out the length less any
858    final padding the compiler needed to add.  See the comment in sv_upgrade
859    for why copying the padding proved to be a bug.  */
860
861 #define copy_length(type, last_member) \
862         STRUCT_OFFSET(type, last_member) \
863         + sizeof (((type*)SvANY((const SV *)0))->last_member)
864
865 static const struct body_details bodies_by_type[] = {
866     /* HEs use this offset for their arena.  */
867     { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
868
869     /* The bind placeholder pretends to be an RV for now.
870        Also it's marked as "can't upgrade" to stop anyone using it before it's
871        implemented.  */
872     { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
873
874     /* IVs are in the head, so the allocation size is 0.  */
875     { 0,
876       sizeof(IV), /* This is used to copy out the IV body.  */
877       STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
878       NOARENA /* IVS don't need an arena  */, 0
879     },
880
881     /* 8 bytes on most ILP32 with IEEE doubles */
882     { sizeof(NV), sizeof(NV),
883       STRUCT_OFFSET(XPVNV, xnv_u),
884       SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
885
886     /* 8 bytes on most ILP32 with IEEE doubles */
887     { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
888       copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
889       + STRUCT_OFFSET(XPV, xpv_cur),
890       SVt_PV, FALSE, NONV, HASARENA,
891       FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
892
893     /* 12 */
894     { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
895       copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
896       + STRUCT_OFFSET(XPV, xpv_cur),
897       SVt_PVIV, FALSE, NONV, HASARENA,
898       FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
899
900     /* 20 */
901     { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
902       copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
903       + STRUCT_OFFSET(XPV, xpv_cur),
904       SVt_PVNV, FALSE, HADNV, HASARENA,
905       FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
906
907     /* 28 */
908     { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
909       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
910
911     /* something big */
912     { sizeof(regexp),
913       sizeof(regexp),
914       0,
915       SVt_REGEXP, FALSE, NONV, HASARENA,
916       FIT_ARENA(0, sizeof(regexp))
917     },
918
919     /* 48 */
920     { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
921       HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
922     
923     /* 64 */
924     { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
925       HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
926
927     { sizeof(XPVAV),
928       copy_length(XPVAV, xav_alloc),
929       0,
930       SVt_PVAV, TRUE, NONV, HASARENA,
931       FIT_ARENA(0, sizeof(XPVAV)) },
932
933     { sizeof(XPVHV),
934       copy_length(XPVHV, xhv_max),
935       0,
936       SVt_PVHV, TRUE, NONV, HASARENA,
937       FIT_ARENA(0, sizeof(XPVHV)) },
938
939     /* 56 */
940     { sizeof(XPVCV),
941       sizeof(XPVCV),
942       0,
943       SVt_PVCV, TRUE, NONV, HASARENA,
944       FIT_ARENA(0, sizeof(XPVCV)) },
945
946     { sizeof(XPVFM),
947       sizeof(XPVFM),
948       0,
949       SVt_PVFM, TRUE, NONV, NOARENA,
950       FIT_ARENA(20, sizeof(XPVFM)) },
951
952     /* XPVIO is 84 bytes, fits 48x */
953     { sizeof(XPVIO),
954       sizeof(XPVIO),
955       0,
956       SVt_PVIO, TRUE, NONV, HASARENA,
957       FIT_ARENA(24, sizeof(XPVIO)) },
958 };
959
960 #define new_body_allocated(sv_type)             \
961     (void *)((char *)S_new_body(aTHX_ sv_type)  \
962              - bodies_by_type[sv_type].offset)
963
964 /* return a thing to the free list */
965
966 #define del_body(thing, root)                           \
967     STMT_START {                                        \
968         void ** const thing_copy = (void **)thing;      \
969         *thing_copy = *root;                            \
970         *root = (void*)thing_copy;                      \
971     } STMT_END
972
973 #ifdef PURIFY
974
975 #define new_XNV()       safemalloc(sizeof(XPVNV))
976 #define new_XPVNV()     safemalloc(sizeof(XPVNV))
977 #define new_XPVMG()     safemalloc(sizeof(XPVMG))
978
979 #define del_XPVGV(p)    safefree(p)
980
981 #else /* !PURIFY */
982
983 #define new_XNV()       new_body_allocated(SVt_NV)
984 #define new_XPVNV()     new_body_allocated(SVt_PVNV)
985 #define new_XPVMG()     new_body_allocated(SVt_PVMG)
986
987 #define del_XPVGV(p)    del_body(p + bodies_by_type[SVt_PVGV].offset,   \
988                                  &PL_body_roots[SVt_PVGV])
989
990 #endif /* PURIFY */
991
992 /* no arena for you! */
993
994 #define new_NOARENA(details) \
995         safemalloc((details)->body_size + (details)->offset)
996 #define new_NOARENAZ(details) \
997         safecalloc((details)->body_size + (details)->offset, 1)
998
999 void *
1000 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1001                   const size_t arena_size)
1002 {
1003     dVAR;
1004     void ** const root = &PL_body_roots[sv_type];
1005     struct arena_desc *adesc;
1006     struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1007     unsigned int curr;
1008     char *start;
1009     const char *end;
1010     const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1011 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1012     static bool done_sanity_check;
1013
1014     /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1015      * variables like done_sanity_check. */
1016     if (!done_sanity_check) {
1017         unsigned int i = SVt_LAST;
1018
1019         done_sanity_check = TRUE;
1020
1021         while (i--)
1022             assert (bodies_by_type[i].type == i);
1023     }
1024 #endif
1025
1026     assert(arena_size);
1027
1028     /* may need new arena-set to hold new arena */
1029     if (!aroot || aroot->curr >= aroot->set_size) {
1030         struct arena_set *newroot;
1031         Newxz(newroot, 1, struct arena_set);
1032         newroot->set_size = ARENAS_PER_SET;
1033         newroot->next = aroot;
1034         aroot = newroot;
1035         PL_body_arenas = (void *) newroot;
1036         DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1037     }
1038
1039     /* ok, now have arena-set with at least 1 empty/available arena-desc */
1040     curr = aroot->curr++;
1041     adesc = &(aroot->set[curr]);
1042     assert(!adesc->arena);
1043     
1044     Newx(adesc->arena, good_arena_size, char);
1045     adesc->size = good_arena_size;
1046     adesc->utype = sv_type;
1047     DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n", 
1048                           curr, (void*)adesc->arena, (UV)good_arena_size));
1049
1050     start = (char *) adesc->arena;
1051
1052     /* Get the address of the byte after the end of the last body we can fit.
1053        Remember, this is integer division:  */
1054     end = start + good_arena_size / body_size * body_size;
1055
1056     /* computed count doesnt reflect the 1st slot reservation */
1057 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1058     DEBUG_m(PerlIO_printf(Perl_debug_log,
1059                           "arena %p end %p arena-size %d (from %d) type %d "
1060                           "size %d ct %d\n",
1061                           (void*)start, (void*)end, (int)good_arena_size,
1062                           (int)arena_size, sv_type, (int)body_size,
1063                           (int)good_arena_size / (int)body_size));
1064 #else
1065     DEBUG_m(PerlIO_printf(Perl_debug_log,
1066                           "arena %p end %p arena-size %d type %d size %d ct %d\n",
1067                           (void*)start, (void*)end,
1068                           (int)arena_size, sv_type, (int)body_size,
1069                           (int)good_arena_size / (int)body_size));
1070 #endif
1071     *root = (void *)start;
1072
1073     while (1) {
1074         /* Where the next body would start:  */
1075         char * const next = start + body_size;
1076
1077         if (next >= end) {
1078             /* This is the last body:  */
1079             assert(next == end);
1080
1081             *(void **)start = 0;
1082             return *root;
1083         }
1084
1085         *(void**) start = (void *)next;
1086         start = next;
1087     }
1088 }
1089
1090 /* grab a new thing from the free list, allocating more if necessary.
1091    The inline version is used for speed in hot routines, and the
1092    function using it serves the rest (unless PURIFY).
1093 */
1094 #define new_body_inline(xpv, sv_type) \
1095     STMT_START { \
1096         void ** const r3wt = &PL_body_roots[sv_type]; \
1097         xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt))      \
1098           ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1099                                              bodies_by_type[sv_type].body_size,\
1100                                              bodies_by_type[sv_type].arena_size)); \
1101         *(r3wt) = *(void**)(xpv); \
1102     } STMT_END
1103
1104 #ifndef PURIFY
1105
1106 STATIC void *
1107 S_new_body(pTHX_ const svtype sv_type)
1108 {
1109     dVAR;
1110     void *xpv;
1111     new_body_inline(xpv, sv_type);
1112     return xpv;
1113 }
1114
1115 #endif
1116
1117 static const struct body_details fake_rv =
1118     { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1119
1120 /*
1121 =for apidoc sv_upgrade
1122
1123 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1124 SV, then copies across as much information as possible from the old body.
1125 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1126
1127 =cut
1128 */
1129
1130 void
1131 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1132 {
1133     dVAR;
1134     void*       old_body;
1135     void*       new_body;
1136     const svtype old_type = SvTYPE(sv);
1137     const struct body_details *new_type_details;
1138     const struct body_details *old_type_details
1139         = bodies_by_type + old_type;
1140     SV *referant = NULL;
1141
1142     PERL_ARGS_ASSERT_SV_UPGRADE;
1143
1144     if (old_type == new_type)
1145         return;
1146
1147     /* This clause was purposefully added ahead of the early return above to
1148        the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1149        inference by Nick I-S that it would fix other troublesome cases. See
1150        changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1151
1152        Given that shared hash key scalars are no longer PVIV, but PV, there is
1153        no longer need to unshare so as to free up the IVX slot for its proper
1154        purpose. So it's safe to move the early return earlier.  */
1155
1156     if (new_type != SVt_PV && SvIsCOW(sv)) {
1157         sv_force_normal_flags(sv, 0);
1158     }
1159
1160     old_body = SvANY(sv);
1161
1162     /* Copying structures onto other structures that have been neatly zeroed
1163        has a subtle gotcha. Consider XPVMG
1164
1165        +------+------+------+------+------+-------+-------+
1166        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |
1167        +------+------+------+------+------+-------+-------+
1168        0      4      8     12     16     20      24      28
1169
1170        where NVs are aligned to 8 bytes, so that sizeof that structure is
1171        actually 32 bytes long, with 4 bytes of padding at the end:
1172
1173        +------+------+------+------+------+-------+-------+------+
1174        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH | ???  |
1175        +------+------+------+------+------+-------+-------+------+
1176        0      4      8     12     16     20      24      28     32
1177
1178        so what happens if you allocate memory for this structure:
1179
1180        +------+------+------+------+------+-------+-------+------+------+...
1181        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |  GP  | NAME |
1182        +------+------+------+------+------+-------+-------+------+------+...
1183        0      4      8     12     16     20      24      28     32     36
1184
1185        zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1186        expect, because you copy the area marked ??? onto GP. Now, ??? may have
1187        started out as zero once, but it's quite possible that it isn't. So now,
1188        rather than a nicely zeroed GP, you have it pointing somewhere random.
1189        Bugs ensue.
1190
1191        (In fact, GP ends up pointing at a previous GP structure, because the
1192        principle cause of the padding in XPVMG getting garbage is a copy of
1193        sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1194        this happens to be moot because XPVGV has been re-ordered, with GP
1195        no longer after STASH)
1196
1197        So we are careful and work out the size of used parts of all the
1198        structures.  */
1199
1200     switch (old_type) {
1201     case SVt_NULL:
1202         break;
1203     case SVt_IV:
1204         if (SvROK(sv)) {
1205             referant = SvRV(sv);
1206             old_type_details = &fake_rv;
1207             if (new_type == SVt_NV)
1208                 new_type = SVt_PVNV;
1209         } else {
1210             if (new_type < SVt_PVIV) {
1211                 new_type = (new_type == SVt_NV)
1212                     ? SVt_PVNV : SVt_PVIV;
1213             }
1214         }
1215         break;
1216     case SVt_NV:
1217         if (new_type < SVt_PVNV) {
1218             new_type = SVt_PVNV;
1219         }
1220         break;
1221     case SVt_PV:
1222         assert(new_type > SVt_PV);
1223         assert(SVt_IV < SVt_PV);
1224         assert(SVt_NV < SVt_PV);
1225         break;
1226     case SVt_PVIV:
1227         break;
1228     case SVt_PVNV:
1229         break;
1230     case SVt_PVMG:
1231         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1232            there's no way that it can be safely upgraded, because perl.c
1233            expects to Safefree(SvANY(PL_mess_sv))  */
1234         assert(sv != PL_mess_sv);
1235         /* This flag bit is used to mean other things in other scalar types.
1236            Given that it only has meaning inside the pad, it shouldn't be set
1237            on anything that can get upgraded.  */
1238         assert(!SvPAD_TYPED(sv));
1239         break;
1240     default:
1241         if (old_type_details->cant_upgrade)
1242             Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1243                        sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1244     }
1245
1246     if (old_type > new_type)
1247         Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1248                 (int)old_type, (int)new_type);
1249
1250     new_type_details = bodies_by_type + new_type;
1251
1252     SvFLAGS(sv) &= ~SVTYPEMASK;
1253     SvFLAGS(sv) |= new_type;
1254
1255     /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1256        the return statements above will have triggered.  */
1257     assert (new_type != SVt_NULL);
1258     switch (new_type) {
1259     case SVt_IV:
1260         assert(old_type == SVt_NULL);
1261         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1262         SvIV_set(sv, 0);
1263         return;
1264     case SVt_NV:
1265         assert(old_type == SVt_NULL);
1266         SvANY(sv) = new_XNV();
1267         SvNV_set(sv, 0);
1268         return;
1269     case SVt_PVHV:
1270     case SVt_PVAV:
1271         assert(new_type_details->body_size);
1272
1273 #ifndef PURIFY  
1274         assert(new_type_details->arena);
1275         assert(new_type_details->arena_size);
1276         /* This points to the start of the allocated area.  */
1277         new_body_inline(new_body, new_type);
1278         Zero(new_body, new_type_details->body_size, char);
1279         new_body = ((char *)new_body) - new_type_details->offset;
1280 #else
1281         /* We always allocated the full length item with PURIFY. To do this
1282            we fake things so that arena is false for all 16 types..  */
1283         new_body = new_NOARENAZ(new_type_details);
1284 #endif
1285         SvANY(sv) = new_body;
1286         if (new_type == SVt_PVAV) {
1287             AvMAX(sv)   = -1;
1288             AvFILLp(sv) = -1;
1289             AvREAL_only(sv);
1290             if (old_type_details->body_size) {
1291                 AvALLOC(sv) = 0;
1292             } else {
1293                 /* It will have been zeroed when the new body was allocated.
1294                    Lets not write to it, in case it confuses a write-back
1295                    cache.  */
1296             }
1297         } else {
1298             assert(!SvOK(sv));
1299             SvOK_off(sv);
1300 #ifndef NODEFAULT_SHAREKEYS
1301             HvSHAREKEYS_on(sv);         /* key-sharing on by default */
1302 #endif
1303             HvMAX(sv) = 7; /* (start with 8 buckets) */
1304         }
1305
1306         /* SVt_NULL isn't the only thing upgraded to AV or HV.
1307            The target created by newSVrv also is, and it can have magic.
1308            However, it never has SvPVX set.
1309         */
1310         if (old_type == SVt_IV) {
1311             assert(!SvROK(sv));
1312         } else if (old_type >= SVt_PV) {
1313             assert(SvPVX_const(sv) == 0);
1314         }
1315
1316         if (old_type >= SVt_PVMG) {
1317             SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1318             SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1319         } else {
1320             sv->sv_u.svu_array = NULL; /* or svu_hash  */
1321         }
1322         break;
1323
1324
1325     case SVt_REGEXP:
1326         /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1327            sv_force_normal_flags(sv) is called.  */
1328         SvFAKE_on(sv);
1329     case SVt_PVIV:
1330         /* XXX Is this still needed?  Was it ever needed?   Surely as there is
1331            no route from NV to PVIV, NOK can never be true  */
1332         assert(!SvNOKp(sv));
1333         assert(!SvNOK(sv));
1334     case SVt_PVIO:
1335     case SVt_PVFM:
1336     case SVt_PVGV:
1337     case SVt_PVCV:
1338     case SVt_PVLV:
1339     case SVt_PVMG:
1340     case SVt_PVNV:
1341     case SVt_PV:
1342
1343         assert(new_type_details->body_size);
1344         /* We always allocated the full length item with PURIFY. To do this
1345            we fake things so that arena is false for all 16 types..  */
1346         if(new_type_details->arena) {
1347             /* This points to the start of the allocated area.  */
1348             new_body_inline(new_body, new_type);
1349             Zero(new_body, new_type_details->body_size, char);
1350             new_body = ((char *)new_body) - new_type_details->offset;
1351         } else {
1352             new_body = new_NOARENAZ(new_type_details);
1353         }
1354         SvANY(sv) = new_body;
1355
1356         if (old_type_details->copy) {
1357             /* There is now the potential for an upgrade from something without
1358                an offset (PVNV or PVMG) to something with one (PVCV, PVFM)  */
1359             int offset = old_type_details->offset;
1360             int length = old_type_details->copy;
1361
1362             if (new_type_details->offset > old_type_details->offset) {
1363                 const int difference
1364                     = new_type_details->offset - old_type_details->offset;
1365                 offset += difference;
1366                 length -= difference;
1367             }
1368             assert (length >= 0);
1369                 
1370             Copy((char *)old_body + offset, (char *)new_body + offset, length,
1371                  char);
1372         }
1373
1374 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1375         /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1376          * correct 0.0 for us.  Otherwise, if the old body didn't have an
1377          * NV slot, but the new one does, then we need to initialise the
1378          * freshly created NV slot with whatever the correct bit pattern is
1379          * for 0.0  */
1380         if (old_type_details->zero_nv && !new_type_details->zero_nv
1381             && !isGV_with_GP(sv))
1382             SvNV_set(sv, 0);
1383 #endif
1384
1385         if (new_type == SVt_PVIO) {
1386             IO * const io = MUTABLE_IO(sv);
1387             GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1388
1389             SvOBJECT_on(io);
1390             /* Clear the stashcache because a new IO could overrule a package
1391                name */
1392             hv_clear(PL_stashcache);
1393
1394             SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1395             IoPAGE_LEN(sv) = 60;
1396         }
1397         if (old_type < SVt_PV) {
1398             /* referant will be NULL unless the old type was SVt_IV emulating
1399                SVt_RV */
1400             sv->sv_u.svu_rv = referant;
1401         }
1402         break;
1403     default:
1404         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1405                    (unsigned long)new_type);
1406     }
1407
1408     if (old_type > SVt_IV) {
1409 #ifdef PURIFY
1410         safefree(old_body);
1411 #else
1412         /* Note that there is an assumption that all bodies of types that
1413            can be upgraded came from arenas. Only the more complex non-
1414            upgradable types are allowed to be directly malloc()ed.  */
1415         assert(old_type_details->arena);
1416         del_body((void*)((char*)old_body + old_type_details->offset),
1417                  &PL_body_roots[old_type]);
1418 #endif
1419     }
1420 }
1421
1422 /*
1423 =for apidoc sv_backoff
1424
1425 Remove any string offset. You should normally use the C<SvOOK_off> macro
1426 wrapper instead.
1427
1428 =cut
1429 */
1430
1431 int
1432 Perl_sv_backoff(pTHX_ register SV *const sv)
1433 {
1434     STRLEN delta;
1435     const char * const s = SvPVX_const(sv);
1436
1437     PERL_ARGS_ASSERT_SV_BACKOFF;
1438     PERL_UNUSED_CONTEXT;
1439
1440     assert(SvOOK(sv));
1441     assert(SvTYPE(sv) != SVt_PVHV);
1442     assert(SvTYPE(sv) != SVt_PVAV);
1443
1444     SvOOK_offset(sv, delta);
1445     
1446     SvLEN_set(sv, SvLEN(sv) + delta);
1447     SvPV_set(sv, SvPVX(sv) - delta);
1448     Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1449     SvFLAGS(sv) &= ~SVf_OOK;
1450     return 0;
1451 }
1452
1453 /*
1454 =for apidoc sv_grow
1455
1456 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1457 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1458 Use the C<SvGROW> wrapper instead.
1459
1460 =cut
1461 */
1462
1463 char *
1464 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1465 {
1466     register char *s;
1467
1468     PERL_ARGS_ASSERT_SV_GROW;
1469
1470     if (PL_madskills && newlen >= 0x100000) {
1471         PerlIO_printf(Perl_debug_log,
1472                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1473     }
1474 #ifdef HAS_64K_LIMIT
1475     if (newlen >= 0x10000) {
1476         PerlIO_printf(Perl_debug_log,
1477                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1478         my_exit(1);
1479     }
1480 #endif /* HAS_64K_LIMIT */
1481     if (SvROK(sv))
1482         sv_unref(sv);
1483     if (SvTYPE(sv) < SVt_PV) {
1484         sv_upgrade(sv, SVt_PV);
1485         s = SvPVX_mutable(sv);
1486     }
1487     else if (SvOOK(sv)) {       /* pv is offset? */
1488         sv_backoff(sv);
1489         s = SvPVX_mutable(sv);
1490         if (newlen > SvLEN(sv))
1491             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1492 #ifdef HAS_64K_LIMIT
1493         if (newlen >= 0x10000)
1494             newlen = 0xFFFF;
1495 #endif
1496     }
1497     else
1498         s = SvPVX_mutable(sv);
1499
1500     if (newlen > SvLEN(sv)) {           /* need more room? */
1501         STRLEN minlen = SvCUR(sv);
1502         minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1503         if (newlen < minlen)
1504             newlen = minlen;
1505 #ifndef Perl_safesysmalloc_size
1506         newlen = PERL_STRLEN_ROUNDUP(newlen);
1507 #endif
1508         if (SvLEN(sv) && s) {
1509             s = (char*)saferealloc(s, newlen);
1510         }
1511         else {
1512             s = (char*)safemalloc(newlen);
1513             if (SvPVX_const(sv) && SvCUR(sv)) {
1514                 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1515             }
1516         }
1517         SvPV_set(sv, s);
1518 #ifdef Perl_safesysmalloc_size
1519         /* Do this here, do it once, do it right, and then we will never get
1520            called back into sv_grow() unless there really is some growing
1521            needed.  */
1522         SvLEN_set(sv, Perl_safesysmalloc_size(s));
1523 #else
1524         SvLEN_set(sv, newlen);
1525 #endif
1526     }
1527     return s;
1528 }
1529
1530 /*
1531 =for apidoc sv_setiv
1532
1533 Copies an integer into the given SV, upgrading first if necessary.
1534 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1535
1536 =cut
1537 */
1538
1539 void
1540 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1541 {
1542     dVAR;
1543
1544     PERL_ARGS_ASSERT_SV_SETIV;
1545
1546     SV_CHECK_THINKFIRST_COW_DROP(sv);
1547     switch (SvTYPE(sv)) {
1548     case SVt_NULL:
1549     case SVt_NV:
1550         sv_upgrade(sv, SVt_IV);
1551         break;
1552     case SVt_PV:
1553         sv_upgrade(sv, SVt_PVIV);
1554         break;
1555
1556     case SVt_PVGV:
1557         if (!isGV_with_GP(sv))
1558             break;
1559     case SVt_PVAV:
1560     case SVt_PVHV:
1561     case SVt_PVCV:
1562     case SVt_PVFM:
1563     case SVt_PVIO:
1564         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1565                    OP_DESC(PL_op));
1566     default: NOOP;
1567     }
1568     (void)SvIOK_only(sv);                       /* validate number */
1569     SvIV_set(sv, i);
1570     SvTAINT(sv);
1571 }
1572
1573 /*
1574 =for apidoc sv_setiv_mg
1575
1576 Like C<sv_setiv>, but also handles 'set' magic.
1577
1578 =cut
1579 */
1580
1581 void
1582 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1583 {
1584     PERL_ARGS_ASSERT_SV_SETIV_MG;
1585
1586     sv_setiv(sv,i);
1587     SvSETMAGIC(sv);
1588 }
1589
1590 /*
1591 =for apidoc sv_setuv
1592
1593 Copies an unsigned integer into the given SV, upgrading first if necessary.
1594 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1595
1596 =cut
1597 */
1598
1599 void
1600 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1601 {
1602     PERL_ARGS_ASSERT_SV_SETUV;
1603
1604     /* With these two if statements:
1605        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1606
1607        without
1608        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1609
1610        If you wish to remove them, please benchmark to see what the effect is
1611     */
1612     if (u <= (UV)IV_MAX) {
1613        sv_setiv(sv, (IV)u);
1614        return;
1615     }
1616     sv_setiv(sv, 0);
1617     SvIsUV_on(sv);
1618     SvUV_set(sv, u);
1619 }
1620
1621 /*
1622 =for apidoc sv_setuv_mg
1623
1624 Like C<sv_setuv>, but also handles 'set' magic.
1625
1626 =cut
1627 */
1628
1629 void
1630 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1631 {
1632     PERL_ARGS_ASSERT_SV_SETUV_MG;
1633
1634     sv_setuv(sv,u);
1635     SvSETMAGIC(sv);
1636 }
1637
1638 /*
1639 =for apidoc sv_setnv
1640
1641 Copies a double into the given SV, upgrading first if necessary.
1642 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1643
1644 =cut
1645 */
1646
1647 void
1648 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1649 {
1650     dVAR;
1651
1652     PERL_ARGS_ASSERT_SV_SETNV;
1653
1654     SV_CHECK_THINKFIRST_COW_DROP(sv);
1655     switch (SvTYPE(sv)) {
1656     case SVt_NULL:
1657     case SVt_IV:
1658         sv_upgrade(sv, SVt_NV);
1659         break;
1660     case SVt_PV:
1661     case SVt_PVIV:
1662         sv_upgrade(sv, SVt_PVNV);
1663         break;
1664
1665     case SVt_PVGV:
1666         if (!isGV_with_GP(sv))
1667             break;
1668     case SVt_PVAV:
1669     case SVt_PVHV:
1670     case SVt_PVCV:
1671     case SVt_PVFM:
1672     case SVt_PVIO:
1673         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1674                    OP_DESC(PL_op));
1675     default: NOOP;
1676     }
1677     SvNV_set(sv, num);
1678     (void)SvNOK_only(sv);                       /* validate number */
1679     SvTAINT(sv);
1680 }
1681
1682 /*
1683 =for apidoc sv_setnv_mg
1684
1685 Like C<sv_setnv>, but also handles 'set' magic.
1686
1687 =cut
1688 */
1689
1690 void
1691 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1692 {
1693     PERL_ARGS_ASSERT_SV_SETNV_MG;
1694
1695     sv_setnv(sv,num);
1696     SvSETMAGIC(sv);
1697 }
1698
1699 /* Print an "isn't numeric" warning, using a cleaned-up,
1700  * printable version of the offending string
1701  */
1702
1703 STATIC void
1704 S_not_a_number(pTHX_ SV *const sv)
1705 {
1706      dVAR;
1707      SV *dsv;
1708      char tmpbuf[64];
1709      const char *pv;
1710
1711      PERL_ARGS_ASSERT_NOT_A_NUMBER;
1712
1713      if (DO_UTF8(sv)) {
1714           dsv = newSVpvs_flags("", SVs_TEMP);
1715           pv = sv_uni_display(dsv, sv, 10, 0);
1716      } else {
1717           char *d = tmpbuf;
1718           const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1719           /* each *s can expand to 4 chars + "...\0",
1720              i.e. need room for 8 chars */
1721         
1722           const char *s = SvPVX_const(sv);
1723           const char * const end = s + SvCUR(sv);
1724           for ( ; s < end && d < limit; s++ ) {
1725                int ch = *s & 0xFF;
1726                if (ch & 128 && !isPRINT_LC(ch)) {
1727                     *d++ = 'M';
1728                     *d++ = '-';
1729                     ch &= 127;
1730                }
1731                if (ch == '\n') {
1732                     *d++ = '\\';
1733                     *d++ = 'n';
1734                }
1735                else if (ch == '\r') {
1736                     *d++ = '\\';
1737                     *d++ = 'r';
1738                }
1739                else if (ch == '\f') {
1740                     *d++ = '\\';
1741                     *d++ = 'f';
1742                }
1743                else if (ch == '\\') {
1744                     *d++ = '\\';
1745                     *d++ = '\\';
1746                }
1747                else if (ch == '\0') {
1748                     *d++ = '\\';
1749                     *d++ = '0';
1750                }
1751                else if (isPRINT_LC(ch))
1752                     *d++ = ch;
1753                else {
1754                     *d++ = '^';
1755                     *d++ = toCTRL(ch);
1756                }
1757           }
1758           if (s < end) {
1759                *d++ = '.';
1760                *d++ = '.';
1761                *d++ = '.';
1762           }
1763           *d = '\0';
1764           pv = tmpbuf;
1765     }
1766
1767     if (PL_op)
1768         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1769                     "Argument \"%s\" isn't numeric in %s", pv,
1770                     OP_DESC(PL_op));
1771     else
1772         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1773                     "Argument \"%s\" isn't numeric", pv);
1774 }
1775
1776 /*
1777 =for apidoc looks_like_number
1778
1779 Test if the content of an SV looks like a number (or is a number).
1780 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1781 non-numeric warning), even if your atof() doesn't grok them.
1782
1783 =cut
1784 */
1785
1786 I32
1787 Perl_looks_like_number(pTHX_ SV *const sv)
1788 {
1789     register const char *sbegin;
1790     STRLEN len;
1791
1792     PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1793
1794     if (SvPOK(sv)) {
1795         sbegin = SvPVX_const(sv);
1796         len = SvCUR(sv);
1797     }
1798     else if (SvPOKp(sv))
1799         sbegin = SvPV_const(sv, len);
1800     else
1801         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1802     return grok_number(sbegin, len, NULL);
1803 }
1804
1805 STATIC bool
1806 S_glob_2number(pTHX_ GV * const gv)
1807 {
1808     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1809     SV *const buffer = sv_newmortal();
1810
1811     PERL_ARGS_ASSERT_GLOB_2NUMBER;
1812
1813     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1814        is on.  */
1815     SvFAKE_off(gv);
1816     gv_efullname3(buffer, gv, "*");
1817     SvFLAGS(gv) |= wasfake;
1818
1819     /* We know that all GVs stringify to something that is not-a-number,
1820         so no need to test that.  */
1821     if (ckWARN(WARN_NUMERIC))
1822         not_a_number(buffer);
1823     /* We just want something true to return, so that S_sv_2iuv_common
1824         can tail call us and return true.  */
1825     return TRUE;
1826 }
1827
1828 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1829    until proven guilty, assume that things are not that bad... */
1830
1831 /*
1832    NV_PRESERVES_UV:
1833
1834    As 64 bit platforms often have an NV that doesn't preserve all bits of
1835    an IV (an assumption perl has been based on to date) it becomes necessary
1836    to remove the assumption that the NV always carries enough precision to
1837    recreate the IV whenever needed, and that the NV is the canonical form.
1838    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1839    precision as a side effect of conversion (which would lead to insanity
1840    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1841    1) to distinguish between IV/UV/NV slots that have cached a valid
1842       conversion where precision was lost and IV/UV/NV slots that have a
1843       valid conversion which has lost no precision
1844    2) to ensure that if a numeric conversion to one form is requested that
1845       would lose precision, the precise conversion (or differently
1846       imprecise conversion) is also performed and cached, to prevent
1847       requests for different numeric formats on the same SV causing
1848       lossy conversion chains. (lossless conversion chains are perfectly
1849       acceptable (still))
1850
1851
1852    flags are used:
1853    SvIOKp is true if the IV slot contains a valid value
1854    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1855    SvNOKp is true if the NV slot contains a valid value
1856    SvNOK  is true only if the NV value is accurate
1857
1858    so
1859    while converting from PV to NV, check to see if converting that NV to an
1860    IV(or UV) would lose accuracy over a direct conversion from PV to
1861    IV(or UV). If it would, cache both conversions, return NV, but mark
1862    SV as IOK NOKp (ie not NOK).
1863
1864    While converting from PV to IV, check to see if converting that IV to an
1865    NV would lose accuracy over a direct conversion from PV to NV. If it
1866    would, cache both conversions, flag similarly.
1867
1868    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1869    correctly because if IV & NV were set NV *always* overruled.
1870    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1871    changes - now IV and NV together means that the two are interchangeable:
1872    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1873
1874    The benefit of this is that operations such as pp_add know that if
1875    SvIOK is true for both left and right operands, then integer addition
1876    can be used instead of floating point (for cases where the result won't
1877    overflow). Before, floating point was always used, which could lead to
1878    loss of precision compared with integer addition.
1879
1880    * making IV and NV equal status should make maths accurate on 64 bit
1881      platforms
1882    * may speed up maths somewhat if pp_add and friends start to use
1883      integers when possible instead of fp. (Hopefully the overhead in
1884      looking for SvIOK and checking for overflow will not outweigh the
1885      fp to integer speedup)
1886    * will slow down integer operations (callers of SvIV) on "inaccurate"
1887      values, as the change from SvIOK to SvIOKp will cause a call into
1888      sv_2iv each time rather than a macro access direct to the IV slot
1889    * should speed up number->string conversion on integers as IV is
1890      favoured when IV and NV are equally accurate
1891
1892    ####################################################################
1893    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1894    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1895    On the other hand, SvUOK is true iff UV.
1896    ####################################################################
1897
1898    Your mileage will vary depending your CPU's relative fp to integer
1899    performance ratio.
1900 */
1901
1902 #ifndef NV_PRESERVES_UV
1903 #  define IS_NUMBER_UNDERFLOW_IV 1
1904 #  define IS_NUMBER_UNDERFLOW_UV 2
1905 #  define IS_NUMBER_IV_AND_UV    2
1906 #  define IS_NUMBER_OVERFLOW_IV  4
1907 #  define IS_NUMBER_OVERFLOW_UV  5
1908
1909 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1910
1911 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1912 STATIC int
1913 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1914 #  ifdef DEBUGGING
1915                        , I32 numtype
1916 #  endif
1917                        )
1918 {
1919     dVAR;
1920
1921     PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1922
1923     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));
1924     if (SvNVX(sv) < (NV)IV_MIN) {
1925         (void)SvIOKp_on(sv);
1926         (void)SvNOK_on(sv);
1927         SvIV_set(sv, IV_MIN);
1928         return IS_NUMBER_UNDERFLOW_IV;
1929     }
1930     if (SvNVX(sv) > (NV)UV_MAX) {
1931         (void)SvIOKp_on(sv);
1932         (void)SvNOK_on(sv);
1933         SvIsUV_on(sv);
1934         SvUV_set(sv, UV_MAX);
1935         return IS_NUMBER_OVERFLOW_UV;
1936     }
1937     (void)SvIOKp_on(sv);
1938     (void)SvNOK_on(sv);
1939     /* Can't use strtol etc to convert this string.  (See truth table in
1940        sv_2iv  */
1941     if (SvNVX(sv) <= (UV)IV_MAX) {
1942         SvIV_set(sv, I_V(SvNVX(sv)));
1943         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1944             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1945         } else {
1946             /* Integer is imprecise. NOK, IOKp */
1947         }
1948         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1949     }
1950     SvIsUV_on(sv);
1951     SvUV_set(sv, U_V(SvNVX(sv)));
1952     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1953         if (SvUVX(sv) == UV_MAX) {
1954             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1955                possibly be preserved by NV. Hence, it must be overflow.
1956                NOK, IOKp */
1957             return IS_NUMBER_OVERFLOW_UV;
1958         }
1959         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1960     } else {
1961         /* Integer is imprecise. NOK, IOKp */
1962     }
1963     return IS_NUMBER_OVERFLOW_IV;
1964 }
1965 #endif /* !NV_PRESERVES_UV*/
1966
1967 STATIC bool
1968 S_sv_2iuv_common(pTHX_ SV *const sv)
1969 {
1970     dVAR;
1971
1972     PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1973
1974     if (SvNOKp(sv)) {
1975         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1976          * without also getting a cached IV/UV from it at the same time
1977          * (ie PV->NV conversion should detect loss of accuracy and cache
1978          * IV or UV at same time to avoid this. */
1979         /* IV-over-UV optimisation - choose to cache IV if possible */
1980
1981         if (SvTYPE(sv) == SVt_NV)
1982             sv_upgrade(sv, SVt_PVNV);
1983
1984         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1985         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1986            certainly cast into the IV range at IV_MAX, whereas the correct
1987            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1988            cases go to UV */
1989 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1990         if (Perl_isnan(SvNVX(sv))) {
1991             SvUV_set(sv, 0);
1992             SvIsUV_on(sv);
1993             return FALSE;
1994         }
1995 #endif
1996         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1997             SvIV_set(sv, I_V(SvNVX(sv)));
1998             if (SvNVX(sv) == (NV) SvIVX(sv)
1999 #ifndef NV_PRESERVES_UV
2000                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2001                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2002                 /* Don't flag it as "accurately an integer" if the number
2003                    came from a (by definition imprecise) NV operation, and
2004                    we're outside the range of NV integer precision */
2005 #endif
2006                 ) {
2007                 if (SvNOK(sv))
2008                     SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2009                 else {
2010                     /* scalar has trailing garbage, eg "42a" */
2011                 }
2012                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2013                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2014                                       PTR2UV(sv),
2015                                       SvNVX(sv),
2016                                       SvIVX(sv)));
2017
2018             } else {
2019                 /* IV not precise.  No need to convert from PV, as NV
2020                    conversion would already have cached IV if it detected
2021                    that PV->IV would be better than PV->NV->IV
2022                    flags already correct - don't set public IOK.  */
2023                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2024                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2025                                       PTR2UV(sv),
2026                                       SvNVX(sv),
2027                                       SvIVX(sv)));
2028             }
2029             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2030                but the cast (NV)IV_MIN rounds to a the value less (more
2031                negative) than IV_MIN which happens to be equal to SvNVX ??
2032                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2033                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2034                (NV)UVX == NVX are both true, but the values differ. :-(
2035                Hopefully for 2s complement IV_MIN is something like
2036                0x8000000000000000 which will be exact. NWC */
2037         }
2038         else {
2039             SvUV_set(sv, U_V(SvNVX(sv)));
2040             if (
2041                 (SvNVX(sv) == (NV) SvUVX(sv))
2042 #ifndef  NV_PRESERVES_UV
2043                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2044                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2045                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2046                 /* Don't flag it as "accurately an integer" if the number
2047                    came from a (by definition imprecise) NV operation, and
2048                    we're outside the range of NV integer precision */
2049 #endif
2050                 && SvNOK(sv)
2051                 )
2052                 SvIOK_on(sv);
2053             SvIsUV_on(sv);
2054             DEBUG_c(PerlIO_printf(Perl_debug_log,
2055                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2056                                   PTR2UV(sv),
2057                                   SvUVX(sv),
2058                                   SvUVX(sv)));
2059         }
2060     }
2061     else if (SvPOKp(sv) && SvLEN(sv)) {
2062         UV value;
2063         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2064         /* We want to avoid a possible problem when we cache an IV/ a UV which
2065            may be later translated to an NV, and the resulting NV is not
2066            the same as the direct translation of the initial string
2067            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2068            be careful to ensure that the value with the .456 is around if the
2069            NV value is requested in the future).
2070         
2071            This means that if we cache such an IV/a UV, we need to cache the
2072            NV as well.  Moreover, we trade speed for space, and do not
2073            cache the NV if we are sure it's not needed.
2074          */
2075
2076         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2077         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2078              == IS_NUMBER_IN_UV) {
2079             /* It's definitely an integer, only upgrade to PVIV */
2080             if (SvTYPE(sv) < SVt_PVIV)
2081                 sv_upgrade(sv, SVt_PVIV);
2082             (void)SvIOK_on(sv);
2083         } else if (SvTYPE(sv) < SVt_PVNV)
2084             sv_upgrade(sv, SVt_PVNV);
2085
2086         /* If NVs preserve UVs then we only use the UV value if we know that
2087            we aren't going to call atof() below. If NVs don't preserve UVs
2088            then the value returned may have more precision than atof() will
2089            return, even though value isn't perfectly accurate.  */
2090         if ((numtype & (IS_NUMBER_IN_UV
2091 #ifdef NV_PRESERVES_UV
2092                         | IS_NUMBER_NOT_INT
2093 #endif
2094             )) == IS_NUMBER_IN_UV) {
2095             /* This won't turn off the public IOK flag if it was set above  */
2096             (void)SvIOKp_on(sv);
2097
2098             if (!(numtype & IS_NUMBER_NEG)) {
2099                 /* positive */;
2100                 if (value <= (UV)IV_MAX) {
2101                     SvIV_set(sv, (IV)value);
2102                 } else {
2103                     /* it didn't overflow, and it was positive. */
2104                     SvUV_set(sv, value);
2105                     SvIsUV_on(sv);
2106                 }
2107             } else {
2108                 /* 2s complement assumption  */
2109                 if (value <= (UV)IV_MIN) {
2110                     SvIV_set(sv, -(IV)value);
2111                 } else {
2112                     /* Too negative for an IV.  This is a double upgrade, but
2113                        I'm assuming it will be rare.  */
2114                     if (SvTYPE(sv) < SVt_PVNV)
2115                         sv_upgrade(sv, SVt_PVNV);
2116                     SvNOK_on(sv);
2117                     SvIOK_off(sv);
2118                     SvIOKp_on(sv);
2119                     SvNV_set(sv, -(NV)value);
2120                     SvIV_set(sv, IV_MIN);
2121                 }
2122             }
2123         }
2124         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2125            will be in the previous block to set the IV slot, and the next
2126            block to set the NV slot.  So no else here.  */
2127         
2128         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2129             != IS_NUMBER_IN_UV) {
2130             /* It wasn't an (integer that doesn't overflow the UV). */
2131             SvNV_set(sv, Atof(SvPVX_const(sv)));
2132
2133             if (! numtype && ckWARN(WARN_NUMERIC))
2134                 not_a_number(sv);
2135
2136 #if defined(USE_LONG_DOUBLE)
2137             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2138                                   PTR2UV(sv), SvNVX(sv)));
2139 #else
2140             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2141                                   PTR2UV(sv), SvNVX(sv)));
2142 #endif
2143
2144 #ifdef NV_PRESERVES_UV
2145             (void)SvIOKp_on(sv);
2146             (void)SvNOK_on(sv);
2147             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2148                 SvIV_set(sv, I_V(SvNVX(sv)));
2149                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2150                     SvIOK_on(sv);
2151                 } else {
2152                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2153                 }
2154                 /* UV will not work better than IV */
2155             } else {
2156                 if (SvNVX(sv) > (NV)UV_MAX) {
2157                     SvIsUV_on(sv);
2158                     /* Integer is inaccurate. NOK, IOKp, is UV */
2159                     SvUV_set(sv, UV_MAX);
2160                 } else {
2161                     SvUV_set(sv, U_V(SvNVX(sv)));
2162                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2163                        NV preservse UV so can do correct comparison.  */
2164                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2165                         SvIOK_on(sv);
2166                     } else {
2167                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2168                     }
2169                 }
2170                 SvIsUV_on(sv);
2171             }
2172 #else /* NV_PRESERVES_UV */
2173             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2174                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2175                 /* The IV/UV slot will have been set from value returned by
2176                    grok_number above.  The NV slot has just been set using
2177                    Atof.  */
2178                 SvNOK_on(sv);
2179                 assert (SvIOKp(sv));
2180             } else {
2181                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2182                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2183                     /* Small enough to preserve all bits. */
2184                     (void)SvIOKp_on(sv);
2185                     SvNOK_on(sv);
2186                     SvIV_set(sv, I_V(SvNVX(sv)));
2187                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2188                         SvIOK_on(sv);
2189                     /* Assumption: first non-preserved integer is < IV_MAX,
2190                        this NV is in the preserved range, therefore: */
2191                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2192                           < (UV)IV_MAX)) {
2193                         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);
2194                     }
2195                 } else {
2196                     /* IN_UV NOT_INT
2197                          0      0       already failed to read UV.
2198                          0      1       already failed to read UV.
2199                          1      0       you won't get here in this case. IV/UV
2200                                         slot set, public IOK, Atof() unneeded.
2201                          1      1       already read UV.
2202                        so there's no point in sv_2iuv_non_preserve() attempting
2203                        to use atol, strtol, strtoul etc.  */
2204 #  ifdef DEBUGGING
2205                     sv_2iuv_non_preserve (sv, numtype);
2206 #  else
2207                     sv_2iuv_non_preserve (sv);
2208 #  endif
2209                 }
2210             }
2211 #endif /* NV_PRESERVES_UV */
2212         /* It might be more code efficient to go through the entire logic above
2213            and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2214            gets complex and potentially buggy, so more programmer efficient
2215            to do it this way, by turning off the public flags:  */
2216         if (!numtype)
2217             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2218         }
2219     }
2220     else  {
2221         if (isGV_with_GP(sv))
2222             return glob_2number(MUTABLE_GV(sv));
2223
2224         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2225             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2226                 report_uninit(sv);
2227         }
2228         if (SvTYPE(sv) < SVt_IV)
2229             /* Typically the caller expects that sv_any is not NULL now.  */
2230             sv_upgrade(sv, SVt_IV);
2231         /* Return 0 from the caller.  */
2232         return TRUE;
2233     }
2234     return FALSE;
2235 }
2236
2237 /*
2238 =for apidoc sv_2iv_flags
2239
2240 Return the integer value of an SV, doing any necessary string
2241 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2242 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2243
2244 =cut
2245 */
2246
2247 IV
2248 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2249 {
2250     dVAR;
2251     if (!sv)
2252         return 0;
2253     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2254         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2255            cache IVs just in case. In practice it seems that they never
2256            actually anywhere accessible by user Perl code, let alone get used
2257            in anything other than a string context.  */
2258         if (flags & SV_GMAGIC)
2259             mg_get(sv);
2260         if (SvIOKp(sv))
2261             return SvIVX(sv);
2262         if (SvNOKp(sv)) {
2263             return I_V(SvNVX(sv));
2264         }
2265         if (SvPOKp(sv) && SvLEN(sv)) {
2266             UV value;
2267             const int numtype
2268                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2269
2270             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2271                 == IS_NUMBER_IN_UV) {
2272                 /* It's definitely an integer */
2273                 if (numtype & IS_NUMBER_NEG) {
2274                     if (value < (UV)IV_MIN)
2275                         return -(IV)value;
2276                 } else {
2277                     if (value < (UV)IV_MAX)
2278                         return (IV)value;
2279                 }
2280             }
2281             if (!numtype) {
2282                 if (ckWARN(WARN_NUMERIC))
2283                     not_a_number(sv);
2284             }
2285             return I_V(Atof(SvPVX_const(sv)));
2286         }
2287         if (SvROK(sv)) {
2288             goto return_rok;
2289         }
2290         assert(SvTYPE(sv) >= SVt_PVMG);
2291         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2292     } else if (SvTHINKFIRST(sv)) {
2293         if (SvROK(sv)) {
2294         return_rok:
2295             if (SvAMAGIC(sv)) {
2296                 SV * tmpstr;
2297                 if (flags & SV_SKIP_OVERLOAD)
2298                     return 0;
2299                 tmpstr=AMG_CALLun(sv,numer);
2300                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2301                     return SvIV(tmpstr);
2302                 }
2303             }
2304             return PTR2IV(SvRV(sv));
2305         }
2306         if (SvIsCOW(sv)) {
2307             sv_force_normal_flags(sv, 0);
2308         }
2309         if (SvREADONLY(sv) && !SvOK(sv)) {
2310             if (ckWARN(WARN_UNINITIALIZED))
2311                 report_uninit(sv);
2312             return 0;
2313         }
2314     }
2315     if (!SvIOKp(sv)) {
2316         if (S_sv_2iuv_common(aTHX_ sv))
2317             return 0;
2318     }
2319     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2320         PTR2UV(sv),SvIVX(sv)));
2321     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2322 }
2323
2324 /*
2325 =for apidoc sv_2uv_flags
2326
2327 Return the unsigned integer value of an SV, doing any necessary string
2328 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2329 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2330
2331 =cut
2332 */
2333
2334 UV
2335 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2336 {
2337     dVAR;
2338     if (!sv)
2339         return 0;
2340     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2341         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2342            cache IVs just in case.  */
2343         if (flags & SV_GMAGIC)
2344             mg_get(sv);
2345         if (SvIOKp(sv))
2346             return SvUVX(sv);
2347         if (SvNOKp(sv))
2348             return U_V(SvNVX(sv));
2349         if (SvPOKp(sv) && SvLEN(sv)) {
2350             UV value;
2351             const int numtype
2352                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2353
2354             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2355                 == IS_NUMBER_IN_UV) {
2356                 /* It's definitely an integer */
2357                 if (!(numtype & IS_NUMBER_NEG))
2358                     return value;
2359             }
2360             if (!numtype) {
2361                 if (ckWARN(WARN_NUMERIC))
2362                     not_a_number(sv);
2363             }
2364             return U_V(Atof(SvPVX_const(sv)));
2365         }
2366         if (SvROK(sv)) {
2367             goto return_rok;
2368         }
2369         assert(SvTYPE(sv) >= SVt_PVMG);
2370         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2371     } else if (SvTHINKFIRST(sv)) {
2372         if (SvROK(sv)) {
2373         return_rok:
2374             if (SvAMAGIC(sv)) {
2375                 SV *tmpstr;
2376                 if (flags & SV_SKIP_OVERLOAD)
2377                     return 0;
2378                 tmpstr = AMG_CALLun(sv,numer);
2379                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2380                     return SvUV(tmpstr);
2381                 }
2382             }
2383             return PTR2UV(SvRV(sv));
2384         }
2385         if (SvIsCOW(sv)) {
2386             sv_force_normal_flags(sv, 0);
2387         }
2388         if (SvREADONLY(sv) && !SvOK(sv)) {
2389             if (ckWARN(WARN_UNINITIALIZED))
2390                 report_uninit(sv);
2391             return 0;
2392         }
2393     }
2394     if (!SvIOKp(sv)) {
2395         if (S_sv_2iuv_common(aTHX_ sv))
2396             return 0;
2397     }
2398
2399     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2400                           PTR2UV(sv),SvUVX(sv)));
2401     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2402 }
2403
2404 /*
2405 =for apidoc sv_2nv_flags
2406
2407 Return the num value of an SV, doing any necessary string or integer
2408 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2409 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2410
2411 =cut
2412 */
2413
2414 NV
2415 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2416 {
2417     dVAR;
2418     if (!sv)
2419         return 0.0;
2420     if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2421         /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2422            cache IVs just in case.  */
2423         if (flags & SV_GMAGIC)
2424             mg_get(sv);
2425         if (SvNOKp(sv))
2426             return SvNVX(sv);
2427         if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2428             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2429                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2430                 not_a_number(sv);
2431             return Atof(SvPVX_const(sv));
2432         }
2433         if (SvIOKp(sv)) {
2434             if (SvIsUV(sv))
2435                 return (NV)SvUVX(sv);
2436             else
2437                 return (NV)SvIVX(sv);
2438         }
2439         if (SvROK(sv)) {
2440             goto return_rok;
2441         }
2442         assert(SvTYPE(sv) >= SVt_PVMG);
2443         /* This falls through to the report_uninit near the end of the
2444            function. */
2445     } else if (SvTHINKFIRST(sv)) {
2446         if (SvROK(sv)) {
2447         return_rok:
2448             if (SvAMAGIC(sv)) {
2449                 SV *tmpstr;
2450                 if (flags & SV_SKIP_OVERLOAD)
2451                     return 0;
2452                 tmpstr = AMG_CALLun(sv,numer);
2453                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2454                     return SvNV(tmpstr);
2455                 }
2456             }
2457             return PTR2NV(SvRV(sv));
2458         }
2459         if (SvIsCOW(sv)) {
2460             sv_force_normal_flags(sv, 0);
2461         }
2462         if (SvREADONLY(sv) && !SvOK(sv)) {
2463             if (ckWARN(WARN_UNINITIALIZED))
2464                 report_uninit(sv);
2465             return 0.0;
2466         }
2467     }
2468     if (SvTYPE(sv) < SVt_NV) {
2469         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2470         sv_upgrade(sv, SVt_NV);
2471 #ifdef USE_LONG_DOUBLE
2472         DEBUG_c({
2473             STORE_NUMERIC_LOCAL_SET_STANDARD();
2474             PerlIO_printf(Perl_debug_log,
2475                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2476                           PTR2UV(sv), SvNVX(sv));
2477             RESTORE_NUMERIC_LOCAL();
2478         });
2479 #else
2480         DEBUG_c({
2481             STORE_NUMERIC_LOCAL_SET_STANDARD();
2482             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2483                           PTR2UV(sv), SvNVX(sv));
2484             RESTORE_NUMERIC_LOCAL();
2485         });
2486 #endif
2487     }
2488     else if (SvTYPE(sv) < SVt_PVNV)
2489         sv_upgrade(sv, SVt_PVNV);
2490     if (SvNOKp(sv)) {
2491         return SvNVX(sv);
2492     }
2493     if (SvIOKp(sv)) {
2494         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2495 #ifdef NV_PRESERVES_UV
2496         if (SvIOK(sv))
2497             SvNOK_on(sv);
2498         else
2499             SvNOKp_on(sv);
2500 #else
2501         /* Only set the public NV OK flag if this NV preserves the IV  */
2502         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2503         if (SvIOK(sv) &&
2504             SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2505                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2506             SvNOK_on(sv);
2507         else
2508             SvNOKp_on(sv);
2509 #endif
2510     }
2511     else if (SvPOKp(sv) && SvLEN(sv)) {
2512         UV value;
2513         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2514         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2515             not_a_number(sv);
2516 #ifdef NV_PRESERVES_UV
2517         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2518             == IS_NUMBER_IN_UV) {
2519             /* It's definitely an integer */
2520             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2521         } else
2522             SvNV_set(sv, Atof(SvPVX_const(sv)));
2523         if (numtype)
2524             SvNOK_on(sv);
2525         else
2526             SvNOKp_on(sv);
2527 #else
2528         SvNV_set(sv, Atof(SvPVX_const(sv)));
2529         /* Only set the public NV OK flag if this NV preserves the value in
2530            the PV at least as well as an IV/UV would.
2531            Not sure how to do this 100% reliably. */
2532         /* if that shift count is out of range then Configure's test is
2533            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2534            UV_BITS */
2535         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2536             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2537             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2538         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2539             /* Can't use strtol etc to convert this string, so don't try.
2540                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2541             SvNOK_on(sv);
2542         } else {
2543             /* value has been set.  It may not be precise.  */
2544             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2545                 /* 2s complement assumption for (UV)IV_MIN  */
2546                 SvNOK_on(sv); /* Integer is too negative.  */
2547             } else {
2548                 SvNOKp_on(sv);
2549                 SvIOKp_on(sv);
2550
2551                 if (numtype & IS_NUMBER_NEG) {
2552                     SvIV_set(sv, -(IV)value);
2553                 } else if (value <= (UV)IV_MAX) {
2554                     SvIV_set(sv, (IV)value);
2555                 } else {
2556                     SvUV_set(sv, value);
2557                     SvIsUV_on(sv);
2558                 }
2559
2560                 if (numtype & IS_NUMBER_NOT_INT) {
2561                     /* I believe that even if the original PV had decimals,
2562                        they are lost beyond the limit of the FP precision.
2563                        However, neither is canonical, so both only get p
2564                        flags.  NWC, 2000/11/25 */
2565                     /* Both already have p flags, so do nothing */
2566                 } else {
2567                     const NV nv = SvNVX(sv);
2568                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2569                         if (SvIVX(sv) == I_V(nv)) {
2570                             SvNOK_on(sv);
2571                         } else {
2572                             /* It had no "." so it must be integer.  */
2573                         }
2574                         SvIOK_on(sv);
2575                     } else {
2576                         /* between IV_MAX and NV(UV_MAX).
2577                            Could be slightly > UV_MAX */
2578
2579                         if (numtype & IS_NUMBER_NOT_INT) {
2580                             /* UV and NV both imprecise.  */
2581                         } else {
2582                             const UV nv_as_uv = U_V(nv);
2583
2584                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2585                                 SvNOK_on(sv);
2586                             }
2587                             SvIOK_on(sv);
2588                         }
2589                     }
2590                 }
2591             }
2592         }
2593         /* It might be more code efficient to go through the entire logic above
2594            and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2595            gets complex and potentially buggy, so more programmer efficient
2596            to do it this way, by turning off the public flags:  */
2597         if (!numtype)
2598             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2599 #endif /* NV_PRESERVES_UV */
2600     }
2601     else  {
2602         if (isGV_with_GP(sv)) {
2603             glob_2number(MUTABLE_GV(sv));
2604             return 0.0;
2605         }
2606
2607         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2608             report_uninit(sv);
2609         assert (SvTYPE(sv) >= SVt_NV);
2610         /* Typically the caller expects that sv_any is not NULL now.  */
2611         /* XXX Ilya implies that this is a bug in callers that assume this
2612            and ideally should be fixed.  */
2613         return 0.0;
2614     }
2615 #if defined(USE_LONG_DOUBLE)
2616     DEBUG_c({
2617         STORE_NUMERIC_LOCAL_SET_STANDARD();
2618         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2619                       PTR2UV(sv), SvNVX(sv));
2620         RESTORE_NUMERIC_LOCAL();
2621     });
2622 #else
2623     DEBUG_c({
2624         STORE_NUMERIC_LOCAL_SET_STANDARD();
2625         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2626                       PTR2UV(sv), SvNVX(sv));
2627         RESTORE_NUMERIC_LOCAL();
2628     });
2629 #endif
2630     return SvNVX(sv);
2631 }
2632
2633 /*
2634 =for apidoc sv_2num
2635
2636 Return an SV with the numeric value of the source SV, doing any necessary
2637 reference or overload conversion.  You must use the C<SvNUM(sv)> macro to
2638 access this function.
2639
2640 =cut
2641 */
2642
2643 SV *
2644 Perl_sv_2num(pTHX_ register SV *const sv)
2645 {
2646     PERL_ARGS_ASSERT_SV_2NUM;
2647
2648     if (!SvROK(sv))
2649         return sv;
2650     if (SvAMAGIC(sv)) {
2651         SV * const tmpsv = AMG_CALLun(sv,numer);
2652         TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2653         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2654             return sv_2num(tmpsv);
2655     }
2656     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2657 }
2658
2659 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2660  * UV as a string towards the end of buf, and return pointers to start and
2661  * end of it.
2662  *
2663  * We assume that buf is at least TYPE_CHARS(UV) long.
2664  */
2665
2666 static char *
2667 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2668 {
2669     char *ptr = buf + TYPE_CHARS(UV);
2670     char * const ebuf = ptr;
2671     int sign;
2672
2673     PERL_ARGS_ASSERT_UIV_2BUF;
2674
2675     if (is_uv)
2676         sign = 0;
2677     else if (iv >= 0) {
2678         uv = iv;
2679         sign = 0;
2680     } else {
2681         uv = -iv;
2682         sign = 1;
2683     }
2684     do {
2685         *--ptr = '0' + (char)(uv % 10);
2686     } while (uv /= 10);
2687     if (sign)
2688         *--ptr = '-';
2689     *peob = ebuf;
2690     return ptr;
2691 }
2692
2693 /*
2694 =for apidoc sv_2pv_flags
2695
2696 Returns a pointer to the string value of an SV, and sets *lp to its length.
2697 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2698 if necessary.
2699 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2700 usually end up here too.
2701
2702 =cut
2703 */
2704
2705 char *
2706 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2707 {
2708     dVAR;
2709     register char *s;
2710
2711     if (!sv) {
2712         if (lp)
2713             *lp = 0;
2714         return (char *)"";
2715     }
2716     if (SvGMAGICAL(sv)) {
2717         if (flags & SV_GMAGIC)
2718             mg_get(sv);
2719         if (SvPOKp(sv)) {
2720             if (lp)
2721                 *lp = SvCUR(sv);
2722             if (flags & SV_MUTABLE_RETURN)
2723                 return SvPVX_mutable(sv);
2724             if (flags & SV_CONST_RETURN)
2725                 return (char *)SvPVX_const(sv);
2726             return SvPVX(sv);
2727         }
2728         if (SvIOKp(sv) || SvNOKp(sv)) {
2729             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2730             STRLEN len;
2731
2732             if (SvIOKp(sv)) {
2733                 len = SvIsUV(sv)
2734                     ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2735                     : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2736             } else {
2737                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2738                 len = strlen(tbuf);
2739             }
2740             assert(!SvROK(sv));
2741             {
2742                 dVAR;
2743
2744 #ifdef FIXNEGATIVEZERO
2745                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2746                     tbuf[0] = '0';
2747                     tbuf[1] = 0;
2748                     len = 1;
2749                 }
2750 #endif
2751                 SvUPGRADE(sv, SVt_PV);
2752                 if (lp)
2753                     *lp = len;
2754                 s = SvGROW_mutable(sv, len + 1);
2755                 SvCUR_set(sv, len);
2756                 SvPOKp_on(sv);
2757                 return (char*)memcpy(s, tbuf, len + 1);
2758             }
2759         }
2760         if (SvROK(sv)) {
2761             goto return_rok;
2762         }
2763         assert(SvTYPE(sv) >= SVt_PVMG);
2764         /* This falls through to the report_uninit near the end of the
2765            function. */
2766     } else if (SvTHINKFIRST(sv)) {
2767         if (SvROK(sv)) {
2768         return_rok:
2769             if (SvAMAGIC(sv)) {
2770                 SV *tmpstr;
2771                 if (flags & SV_SKIP_OVERLOAD)
2772                     return NULL;
2773                 tmpstr = AMG_CALLun(sv,string);
2774                 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2775                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2776                     /* Unwrap this:  */
2777                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2778                      */
2779
2780                     char *pv;
2781                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2782                         if (flags & SV_CONST_RETURN) {
2783                             pv = (char *) SvPVX_const(tmpstr);
2784                         } else {
2785                             pv = (flags & SV_MUTABLE_RETURN)
2786                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2787                         }
2788                         if (lp)
2789                             *lp = SvCUR(tmpstr);
2790                     } else {
2791                         pv = sv_2pv_flags(tmpstr, lp, flags);
2792                     }
2793                     if (SvUTF8(tmpstr))
2794                         SvUTF8_on(sv);
2795                     else
2796                         SvUTF8_off(sv);
2797                     return pv;
2798                 }
2799             }
2800             {
2801                 STRLEN len;
2802                 char *retval;
2803                 char *buffer;
2804                 SV *const referent = SvRV(sv);
2805
2806                 if (!referent) {
2807                     len = 7;
2808                     retval = buffer = savepvn("NULLREF", len);
2809                 } else if (SvTYPE(referent) == SVt_REGEXP) {
2810                     REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2811                     I32 seen_evals = 0;
2812
2813                     assert(re);
2814                         
2815                     /* If the regex is UTF-8 we want the containing scalar to
2816                        have an UTF-8 flag too */
2817                     if (RX_UTF8(re))
2818                         SvUTF8_on(sv);
2819                     else
2820                         SvUTF8_off(sv); 
2821
2822                     if ((seen_evals = RX_SEEN_EVALS(re)))
2823                         PL_reginterp_cnt += seen_evals;
2824
2825                     if (lp)
2826                         *lp = RX_WRAPLEN(re);
2827  
2828                     return RX_WRAPPED(re);
2829                 } else {
2830                     const char *const typestr = sv_reftype(referent, 0);
2831                     const STRLEN typelen = strlen(typestr);
2832                     UV addr = PTR2UV(referent);
2833                     const char *stashname = NULL;
2834                     STRLEN stashnamelen = 0; /* hush, gcc */
2835                     const char *buffer_end;
2836
2837                     if (SvOBJECT(referent)) {
2838                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2839
2840                         if (name) {
2841                             stashname = HEK_KEY(name);
2842                             stashnamelen = HEK_LEN(name);
2843
2844                             if (HEK_UTF8(name)) {
2845                                 SvUTF8_on(sv);
2846                             } else {
2847                                 SvUTF8_off(sv);
2848                             }
2849                         } else {
2850                             stashname = "__ANON__";
2851                             stashnamelen = 8;
2852                         }
2853                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2854                             + 2 * sizeof(UV) + 2 /* )\0 */;
2855                     } else {
2856                         len = typelen + 3 /* (0x */
2857                             + 2 * sizeof(UV) + 2 /* )\0 */;
2858                     }
2859
2860                     Newx(buffer, len, char);
2861                     buffer_end = retval = buffer + len;
2862
2863                     /* Working backwards  */
2864                     *--retval = '\0';
2865                     *--retval = ')';
2866                     do {
2867                         *--retval = PL_hexdigit[addr & 15];
2868                     } while (addr >>= 4);
2869                     *--retval = 'x';
2870                     *--retval = '0';
2871                     *--retval = '(';
2872
2873                     retval -= typelen;
2874                     memcpy(retval, typestr, typelen);
2875
2876                     if (stashname) {
2877                         *--retval = '=';
2878                         retval -= stashnamelen;
2879                         memcpy(retval, stashname, stashnamelen);
2880                     }
2881                     /* retval may not neccesarily have reached the start of the
2882                        buffer here.  */
2883                     assert (retval >= buffer);
2884
2885                     len = buffer_end - retval - 1; /* -1 for that \0  */
2886                 }
2887                 if (lp)
2888                     *lp = len;
2889                 SAVEFREEPV(buffer);
2890                 return retval;
2891             }
2892         }
2893         if (SvREADONLY(sv) && !SvOK(sv)) {
2894             if (lp)
2895                 *lp = 0;
2896             if (flags & SV_UNDEF_RETURNS_NULL)
2897                 return NULL;
2898             if (ckWARN(WARN_UNINITIALIZED))
2899                 report_uninit(sv);
2900             return (char *)"";
2901         }
2902     }
2903     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2904         /* I'm assuming that if both IV and NV are equally valid then
2905            converting the IV is going to be more efficient */
2906         const U32 isUIOK = SvIsUV(sv);
2907         char buf[TYPE_CHARS(UV)];
2908         char *ebuf, *ptr;
2909         STRLEN len;
2910
2911         if (SvTYPE(sv) < SVt_PVIV)
2912             sv_upgrade(sv, SVt_PVIV);
2913         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2914         len = ebuf - ptr;
2915         /* inlined from sv_setpvn */
2916         s = SvGROW_mutable(sv, len + 1);
2917         Move(ptr, s, len, char);
2918         s += len;
2919         *s = '\0';
2920     }
2921     else if (SvNOKp(sv)) {
2922         dSAVE_ERRNO;
2923         if (SvTYPE(sv) < SVt_PVNV)
2924             sv_upgrade(sv, SVt_PVNV);
2925         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2926         s = SvGROW_mutable(sv, NV_DIG + 20);
2927         /* some Xenix systems wipe out errno here */
2928 #ifdef apollo
2929         if (SvNVX(sv) == 0.0)
2930             my_strlcpy(s, "0", SvLEN(sv));
2931         else
2932 #endif /*apollo*/
2933         {
2934             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2935         }
2936         RESTORE_ERRNO;
2937 #ifdef FIXNEGATIVEZERO
2938         if (*s == '-' && s[1] == '0' && !s[2]) {
2939             s[0] = '0';
2940             s[1] = 0;
2941         }
2942 #endif
2943         while (*s) s++;
2944 #ifdef hcx
2945         if (s[-1] == '.')
2946             *--s = '\0';
2947 #endif
2948     }
2949     else {
2950         if (isGV_with_GP(sv)) {
2951             GV *const gv = MUTABLE_GV(sv);
2952             const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2953             SV *const buffer = sv_newmortal();
2954
2955             /* FAKE globs can get coerced, so need to turn this off temporarily
2956                if it is on.  */
2957             SvFAKE_off(gv);
2958             gv_efullname3(buffer, gv, "*");
2959             SvFLAGS(gv) |= wasfake;
2960
2961             if (SvPOK(buffer)) {
2962                 if (lp) {
2963                     *lp = SvCUR(buffer);
2964                 }
2965                 return SvPVX(buffer);
2966             }
2967             else {
2968                 if (lp)
2969                     *lp = 0;
2970                 return (char *)"";
2971             }
2972         }
2973
2974         if (lp)
2975             *lp = 0;
2976         if (flags & SV_UNDEF_RETURNS_NULL)
2977             return NULL;
2978         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2979             report_uninit(sv);
2980         if (SvTYPE(sv) < SVt_PV)
2981             /* Typically the caller expects that sv_any is not NULL now.  */
2982             sv_upgrade(sv, SVt_PV);
2983         return (char *)"";
2984     }
2985     {
2986         const STRLEN len = s - SvPVX_const(sv);
2987         if (lp) 
2988             *lp = len;
2989         SvCUR_set(sv, len);
2990     }
2991     SvPOK_on(sv);
2992     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2993                           PTR2UV(sv),SvPVX_const(sv)));
2994     if (flags & SV_CONST_RETURN)
2995         return (char *)SvPVX_const(sv);
2996     if (flags & SV_MUTABLE_RETURN)
2997         return SvPVX_mutable(sv);
2998     return SvPVX(sv);
2999 }
3000
3001 /*
3002 =for apidoc sv_copypv
3003
3004 Copies a stringified representation of the source SV into the
3005 destination SV.  Automatically performs any necessary mg_get and
3006 coercion of numeric values into strings.  Guaranteed to preserve
3007 UTF8 flag even from overloaded objects.  Similar in nature to
3008 sv_2pv[_flags] but operates directly on an SV instead of just the
3009 string.  Mostly uses sv_2pv_flags to do its work, except when that
3010 would lose the UTF-8'ness of the PV.
3011
3012 =cut
3013 */
3014
3015 void
3016 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3017 {
3018     STRLEN len;
3019     const char * const s = SvPV_const(ssv,len);
3020
3021     PERL_ARGS_ASSERT_SV_COPYPV;
3022
3023     sv_setpvn(dsv,s,len);
3024     if (SvUTF8(ssv))
3025         SvUTF8_on(dsv);
3026     else
3027         SvUTF8_off(dsv);
3028 }
3029
3030 /*
3031 =for apidoc sv_2pvbyte
3032
3033 Return a pointer to the byte-encoded representation of the SV, and set *lp
3034 to its length.  May cause the SV to be downgraded from UTF-8 as a
3035 side-effect.
3036
3037 Usually accessed via the C<SvPVbyte> macro.
3038
3039 =cut
3040 */
3041
3042 char *
3043 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3044 {
3045     PERL_ARGS_ASSERT_SV_2PVBYTE;
3046
3047     sv_utf8_downgrade(sv,0);
3048     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3049 }
3050
3051 /*
3052 =for apidoc sv_2pvutf8
3053
3054 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3055 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3056
3057 Usually accessed via the C<SvPVutf8> macro.
3058
3059 =cut
3060 */
3061
3062 char *
3063 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3064 {
3065     PERL_ARGS_ASSERT_SV_2PVUTF8;
3066
3067     sv_utf8_upgrade(sv);
3068     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3069 }
3070
3071
3072 /*
3073 =for apidoc sv_2bool
3074
3075 This macro is only used by sv_true() or its macro equivalent, and only if
3076 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3077 It calls sv_2bool_flags with the SV_GMAGIC flag.
3078
3079 =for apidoc sv_2bool_flags
3080
3081 This function is only used by sv_true() and friends,  and only if
3082 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3083 contain SV_GMAGIC, then it does an mg_get() first.
3084
3085
3086 =cut
3087 */
3088
3089 bool
3090 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3091 {
3092     dVAR;
3093
3094     PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3095
3096     if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3097
3098     if (!SvOK(sv))
3099         return 0;
3100     if (SvROK(sv)) {
3101         if (SvAMAGIC(sv)) {
3102             SV * const tmpsv = AMG_CALLun(sv,bool_);
3103             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3104                 return cBOOL(SvTRUE(tmpsv));
3105         }
3106         return SvRV(sv) != 0;
3107     }
3108     if (SvPOKp(sv)) {
3109         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3110         if (Xpvtmp &&
3111                 (*sv->sv_u.svu_pv > '0' ||
3112                 Xpvtmp->xpv_cur > 1 ||
3113                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3114             return 1;
3115         else
3116             return 0;
3117     }
3118     else {
3119         if (SvIOKp(sv))
3120             return SvIVX(sv) != 0;
3121         else {
3122             if (SvNOKp(sv))
3123                 return SvNVX(sv) != 0.0;
3124             else {
3125                 if (isGV_with_GP(sv))
3126                     return TRUE;
3127                 else
3128                     return FALSE;
3129             }
3130         }
3131     }
3132 }
3133
3134 /*
3135 =for apidoc sv_utf8_upgrade
3136
3137 Converts the PV of an SV to its UTF-8-encoded form.
3138 Forces the SV to string form if it is not already.
3139 Will C<mg_get> on C<sv> if appropriate.
3140 Always sets the SvUTF8 flag to avoid future validity checks even
3141 if the whole string is the same in UTF-8 as not.
3142 Returns the number of bytes in the converted string
3143
3144 This is not as a general purpose byte encoding to Unicode interface:
3145 use the Encode extension for that.
3146
3147 =for apidoc sv_utf8_upgrade_nomg
3148
3149 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3150
3151 =for apidoc sv_utf8_upgrade_flags
3152
3153 Converts the PV of an SV to its UTF-8-encoded form.
3154 Forces the SV to string form if it is not already.
3155 Always sets the SvUTF8 flag to avoid future validity checks even
3156 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3157 will C<mg_get> on C<sv> if appropriate, else not.
3158 Returns the number of bytes in the converted string
3159 C<sv_utf8_upgrade> and
3160 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3161
3162 This is not as a general purpose byte encoding to Unicode interface:
3163 use the Encode extension for that.
3164
3165 =cut
3166
3167 The grow version is currently not externally documented.  It adds a parameter,
3168 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3169 have free after it upon return.  This allows the caller to reserve extra space
3170 that it intends to fill, to avoid extra grows.
3171
3172 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3173 which can be used to tell this function to not first check to see if there are
3174 any characters that are different in UTF-8 (variant characters) which would
3175 force it to allocate a new string to sv, but to assume there are.  Typically
3176 this flag is used by a routine that has already parsed the string to find that
3177 there are such characters, and passes this information on so that the work
3178 doesn't have to be repeated.
3179
3180 (One might think that the calling routine could pass in the position of the
3181 first such variant, so it wouldn't have to be found again.  But that is not the
3182 case, because typically when the caller is likely to use this flag, it won't be
3183 calling this routine unless it finds something that won't fit into a byte.
3184 Otherwise it tries to not upgrade and just use bytes.  But some things that
3185 do fit into a byte are variants in utf8, and the caller may not have been
3186 keeping track of these.)
3187
3188 If the routine itself changes the string, it adds a trailing NUL.  Such a NUL
3189 isn't guaranteed due to having other routines do the work in some input cases,
3190 or if the input is already flagged as being in utf8.
3191
3192 The speed of this could perhaps be improved for many cases if someone wanted to
3193 write a fast function that counts the number of variant characters in a string,
3194 especially if it could return the position of the first one.
3195
3196 */
3197
3198 STRLEN
3199 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3200 {
3201     dVAR;
3202
3203     PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3204
3205     if (sv == &PL_sv_undef)
3206         return 0;
3207     if (!SvPOK(sv)) {
3208         STRLEN len = 0;
3209         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3210             (void) sv_2pv_flags(sv,&len, flags);
3211             if (SvUTF8(sv)) {
3212                 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3213                 return len;
3214             }
3215         } else {
3216             (void) SvPV_force(sv,len);
3217         }
3218     }
3219
3220     if (SvUTF8(sv)) {
3221         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3222         return SvCUR(sv);
3223     }
3224
3225     if (SvIsCOW(sv)) {
3226         sv_force_normal_flags(sv, 0);
3227     }
3228
3229     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3230         sv_recode_to_utf8(sv, PL_encoding);
3231         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3232         return SvCUR(sv);
3233     }
3234
3235     if (SvCUR(sv) == 0) {
3236         if (extra) SvGROW(sv, extra);
3237     } else { /* Assume Latin-1/EBCDIC */
3238         /* This function could be much more efficient if we
3239          * had a FLAG in SVs to signal if there are any variant
3240          * chars in the PV.  Given that there isn't such a flag
3241          * make the loop as fast as possible (although there are certainly ways
3242          * to speed this up, eg. through vectorization) */
3243         U8 * s = (U8 *) SvPVX_const(sv);
3244         U8 * e = (U8 *) SvEND(sv);
3245         U8 *t = s;
3246         STRLEN two_byte_count = 0;
3247         
3248         if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3249
3250         /* See if really will need to convert to utf8.  We mustn't rely on our
3251          * incoming SV being well formed and having a trailing '\0', as certain
3252          * code in pp_formline can send us partially built SVs. */
3253
3254         while (t < e) {
3255             const U8 ch = *t++;
3256             if (NATIVE_IS_INVARIANT(ch)) continue;
3257
3258             t--;    /* t already incremented; re-point to first variant */
3259             two_byte_count = 1;
3260             goto must_be_utf8;
3261         }
3262
3263         /* utf8 conversion not needed because all are invariants.  Mark as
3264          * UTF-8 even if no variant - saves scanning loop */
3265         SvUTF8_on(sv);
3266         return SvCUR(sv);
3267
3268 must_be_utf8:
3269
3270         /* Here, the string should be converted to utf8, either because of an
3271          * input flag (two_byte_count = 0), or because a character that
3272          * requires 2 bytes was found (two_byte_count = 1).  t points either to
3273          * the beginning of the string (if we didn't examine anything), or to
3274          * the first variant.  In either case, everything from s to t - 1 will
3275          * occupy only 1 byte each on output.
3276          *
3277          * There are two main ways to convert.  One is to create a new string
3278          * and go through the input starting from the beginning, appending each
3279          * converted value onto the new string as we go along.  It's probably
3280          * best to allocate enough space in the string for the worst possible
3281          * case rather than possibly running out of space and having to
3282          * reallocate and then copy what we've done so far.  Since everything
3283          * from s to t - 1 is invariant, the destination can be initialized
3284          * with these using a fast memory copy
3285          *
3286          * The other way is to figure out exactly how big the string should be
3287          * by parsing the entire input.  Then you don't have to make it big
3288          * enough to handle the worst possible case, and more importantly, if
3289          * the string you already have is large enough, you don't have to
3290          * allocate a new string, you can copy the last character in the input
3291          * string to the final position(s) that will be occupied by the
3292          * converted string and go backwards, stopping at t, since everything
3293          * before that is invariant.
3294          *
3295          * There are advantages and disadvantages to each method.
3296          *
3297          * In the first method, we can allocate a new string, do the memory
3298          * copy from the s to t - 1, and then proceed through the rest of the
3299          * string byte-by-byte.
3300          *
3301          * In the second method, we proceed through the rest of the input
3302          * string just calculating how big the converted string will be.  Then
3303          * there are two cases:
3304          *  1)  if the string has enough extra space to handle the converted
3305          *      value.  We go backwards through the string, converting until we
3306          *      get to the position we are at now, and then stop.  If this
3307          *      position is far enough along in the string, this method is
3308          *      faster than the other method.  If the memory copy were the same
3309          *      speed as the byte-by-byte loop, that position would be about
3310          *      half-way, as at the half-way mark, parsing to the end and back
3311          *      is one complete string's parse, the same amount as starting
3312          *      over and going all the way through.  Actually, it would be
3313          *      somewhat less than half-way, as it's faster to just count bytes
3314          *      than to also copy, and we don't have the overhead of allocating
3315          *      a new string, changing the scalar to use it, and freeing the
3316          *      existing one.  But if the memory copy is fast, the break-even
3317          *      point is somewhere after half way.  The counting loop could be
3318          *      sped up by vectorization, etc, to move the break-even point
3319          *      further towards the beginning.
3320          *  2)  if the string doesn't have enough space to handle the converted
3321          *      value.  A new string will have to be allocated, and one might
3322          *      as well, given that, start from the beginning doing the first
3323          *      method.  We've spent extra time parsing the string and in
3324          *      exchange all we've gotten is that we know precisely how big to
3325          *      make the new one.  Perl is more optimized for time than space,
3326          *      so this case is a loser.
3327          * So what I've decided to do is not use the 2nd method unless it is
3328          * guaranteed that a new string won't have to be allocated, assuming
3329          * the worst case.  I also decided not to put any more conditions on it
3330          * than this, for now.  It seems likely that, since the worst case is
3331          * twice as big as the unknown portion of the string (plus 1), we won't
3332          * be guaranteed enough space, causing us to go to the first method,
3333          * unless the string is short, or the first variant character is near
3334          * the end of it.  In either of these cases, it seems best to use the
3335          * 2nd method.  The only circumstance I can think of where this would
3336          * be really slower is if the string had once had much more data in it
3337          * than it does now, but there is still a substantial amount in it  */
3338
3339         {
3340             STRLEN invariant_head = t - s;
3341             STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3342             if (SvLEN(sv) < size) {
3343
3344                 /* Here, have decided to allocate a new string */
3345
3346                 U8 *dst;
3347                 U8 *d;
3348
3349                 Newx(dst, size, U8);
3350
3351                 /* If no known invariants at the beginning of the input string,
3352                  * set so starts from there.  Otherwise, can use memory copy to
3353                  * get up to where we are now, and then start from here */
3354
3355                 if (invariant_head <= 0) {
3356                     d = dst;
3357                 } else {
3358                     Copy(s, dst, invariant_head, char);
3359                     d = dst + invariant_head;
3360                 }
3361
3362                 while (t < e) {
3363                     const UV uv = NATIVE8_TO_UNI(*t++);
3364                     if (UNI_IS_INVARIANT(uv))
3365                         *d++ = (U8)UNI_TO_NATIVE(uv);
3366                     else {
3367                         *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3368                         *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3369                     }
3370                 }
3371                 *d = '\0';
3372                 SvPV_free(sv); /* No longer using pre-existing string */
3373                 SvPV_set(sv, (char*)dst);
3374                 SvCUR_set(sv, d - dst);
3375                 SvLEN_set(sv, size);
3376             } else {
3377
3378                 /* Here, have decided to get the exact size of the string.
3379                  * Currently this happens only when we know that there is
3380                  * guaranteed enough space to fit the converted string, so
3381                  * don't have to worry about growing.  If two_byte_count is 0,
3382                  * then t points to the first byte of the string which hasn't
3383                  * been examined yet.  Otherwise two_byte_count is 1, and t
3384                  * points to the first byte in the string that will expand to
3385                  * two.  Depending on this, start examining at t or 1 after t.
3386                  * */
3387
3388                 U8 *d = t + two_byte_count;
3389
3390
3391                 /* Count up the remaining bytes that expand to two */
3392
3393                 while (d < e) {
3394                     const U8 chr = *d++;
3395                     if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3396                 }
3397
3398                 /* The string will expand by just the number of bytes that
3399                  * occupy two positions.  But we are one afterwards because of
3400                  * the increment just above.  This is the place to put the
3401                  * trailing NUL, and to set the length before we decrement */
3402
3403                 d += two_byte_count;
3404                 SvCUR_set(sv, d - s);
3405                 *d-- = '\0';
3406
3407
3408                 /* Having decremented d, it points to the position to put the
3409                  * very last byte of the expanded string.  Go backwards through
3410                  * the string, copying and expanding as we go, stopping when we
3411                  * get to the part that is invariant the rest of the way down */
3412
3413                 e--;
3414                 while (e >= t) {
3415                     const U8 ch = NATIVE8_TO_UNI(*e--);
3416                     if (UNI_IS_INVARIANT(ch)) {
3417                         *d-- = UNI_TO_NATIVE(ch);
3418                     } else {
3419                         *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3420                         *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3421                     }
3422                 }
3423             }
3424         }
3425     }
3426
3427     /* Mark as UTF-8 even if no variant - saves scanning loop */
3428     SvUTF8_on(sv);
3429     return SvCUR(sv);
3430 }
3431
3432 /*
3433 =for apidoc sv_utf8_downgrade
3434
3435 Attempts to convert the PV of an SV from characters to bytes.
3436 If the PV contains a character that cannot fit
3437 in a byte, this conversion will fail;
3438 in this case, either returns false or, if C<fail_ok> is not
3439 true, croaks.
3440
3441 This is not as a general purpose Unicode to byte encoding interface:
3442 use the Encode extension for that.
3443
3444 =cut
3445 */
3446
3447 bool
3448 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3449 {
3450     dVAR;
3451
3452     PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3453
3454     if (SvPOKp(sv) && SvUTF8(sv)) {
3455         if (SvCUR(sv)) {
3456             U8 *s;
3457             STRLEN len;
3458
3459             if (SvIsCOW(sv)) {
3460                 sv_force_normal_flags(sv, 0);
3461             }
3462             s = (U8 *) SvPV(sv, len);
3463             if (!utf8_to_bytes(s, &len)) {
3464                 if (fail_ok)
3465                     return FALSE;
3466                 else {
3467                     if (PL_op)
3468                         Perl_croak(aTHX_ "Wide character in %s",
3469                                    OP_DESC(PL_op));
3470                     else
3471                         Perl_croak(aTHX_ "Wide character");
3472                 }
3473             }
3474             SvCUR_set(sv, len);
3475         }
3476     }
3477     SvUTF8_off(sv);
3478     return TRUE;
3479 }
3480
3481 /*
3482 =for apidoc sv_utf8_encode
3483
3484 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3485 flag off so that it looks like octets again.
3486
3487 =cut
3488 */
3489
3490 void
3491 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3492 {
3493     PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3494
3495     if (SvIsCOW(sv)) {
3496         sv_force_normal_flags(sv, 0);
3497     }
3498     if (SvREADONLY(sv)) {
3499         Perl_croak_no_modify(aTHX);
3500     }
3501     (void) sv_utf8_upgrade(sv);
3502     SvUTF8_off(sv);
3503 }
3504
3505 /*
3506 =for apidoc sv_utf8_decode
3507
3508 If the PV of the SV is an octet sequence in UTF-8
3509 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3510 so that it looks like a character. If the PV contains only single-byte
3511 characters, the C<SvUTF8> flag stays being off.
3512 Scans PV for validity and returns false if the PV is invalid UTF-8.
3513
3514 =cut
3515 */
3516
3517 bool
3518 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3519 {
3520     PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3521
3522     if (SvPOKp(sv)) {
3523         const U8 *c;
3524         const U8 *e;
3525
3526         /* The octets may have got themselves encoded - get them back as
3527          * bytes
3528          */
3529         if (!sv_utf8_downgrade(sv, TRUE))
3530             return FALSE;
3531
3532         /* it is actually just a matter of turning the utf8 flag on, but
3533          * we want to make sure everything inside is valid utf8 first.
3534          */
3535         c = (const U8 *) SvPVX_const(sv);
3536         if (!is_utf8_string(c, SvCUR(sv)+1))
3537             return FALSE;
3538         e = (const U8 *) SvEND(sv);
3539         while (c < e) {
3540             const U8 ch = *c++;
3541             if (!UTF8_IS_INVARIANT(ch)) {
3542                 SvUTF8_on(sv);
3543                 break;
3544             }
3545         }
3546     }
3547     return TRUE;
3548 }
3549
3550 /*
3551 =for apidoc sv_setsv
3552
3553 Copies the contents of the source SV C<ssv> into the destination SV
3554 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3555 function if the source SV needs to be reused. Does not handle 'set' magic.
3556 Loosely speaking, it performs a copy-by-value, obliterating any previous
3557 content of the destination.
3558
3559 You probably want to use one of the assortment of wrappers, such as
3560 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3561 C<SvSetMagicSV_nosteal>.
3562
3563 =for apidoc sv_setsv_flags
3564
3565 Copies the contents of the source SV C<ssv> into the destination SV
3566 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3567 function if the source SV needs to be reused. Does not handle 'set' magic.
3568 Loosely speaking, it performs a copy-by-value, obliterating any previous
3569 content of the destination.
3570 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3571 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3572 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3573 and C<sv_setsv_nomg> are implemented in terms of this function.
3574
3575 You probably want to use one of the assortment of wrappers, such as
3576 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3577 C<SvSetMagicSV_nosteal>.
3578
3579 This is the primary function for copying scalars, and most other
3580 copy-ish functions and macros use this underneath.
3581
3582 =cut
3583 */
3584
3585 static void
3586 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3587 {
3588     I32 mro_changes = 0; /* 1 = method, 2 = isa */
3589
3590     PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3591
3592     if (dtype != SVt_PVGV) {
3593         const char * const name = GvNAME(sstr);
3594         const STRLEN len = GvNAMELEN(sstr);
3595         {
3596             if (dtype >= SVt_PV) {
3597                 SvPV_free(dstr);
3598                 SvPV_set(dstr, 0);
3599                 SvLEN_set(dstr, 0);
3600                 SvCUR_set(dstr, 0);
3601             }
3602             SvUPGRADE(dstr, SVt_PVGV);
3603             (void)SvOK_off(dstr);
3604             /* FIXME - why are we doing this, then turning it off and on again
3605                below?  */
3606             isGV_with_GP_on(dstr);
3607         }
3608         GvSTASH(dstr) = GvSTASH(sstr);
3609         if (GvSTASH(dstr))
3610             Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3611         gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3612         SvFAKE_on(dstr);        /* can coerce to non-glob */
3613     }
3614
3615     if(GvGP(MUTABLE_GV(sstr))) {
3616         /* If source has method cache entry, clear it */
3617         if(GvCVGEN(sstr)) {
3618             SvREFCNT_dec(GvCV(sstr));
3619             GvCV(sstr) = NULL;
3620             GvCVGEN(sstr) = 0;
3621         }
3622         /* If source has a real method, then a method is
3623            going to change */
3624         else if(GvCV((const GV *)sstr)) {
3625             mro_changes = 1;
3626         }
3627     }
3628
3629     /* If dest already had a real method, that's a change as well */
3630     if(!mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)) {
3631         mro_changes = 1;
3632     }
3633
3634     if(strEQ(GvNAME((const GV *)dstr),"ISA"))
3635         mro_changes = 2;
3636
3637     gp_free(MUTABLE_GV(dstr));
3638     isGV_with_GP_off(dstr);
3639     (void)SvOK_off(dstr);
3640     isGV_with_GP_on(dstr);
3641     GvINTRO_off(dstr);          /* one-shot flag */
3642     GvGP(dstr) = gp_ref(GvGP(sstr));
3643     if (SvTAINTED(sstr))
3644         SvTAINT(dstr);
3645     if (GvIMPORTED(dstr) != GVf_IMPORTED
3646         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3647         {
3648             GvIMPORTED_on(dstr);
3649         }
3650     GvMULTI_on(dstr);
3651     if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3652     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3653     return;
3654 }
3655
3656 static void
3657 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3658 {
3659     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3660     SV *dref = NULL;
3661     const int intro = GvINTRO(dstr);
3662     SV **location;
3663     U8 import_flag = 0;
3664     const U32 stype = SvTYPE(sref);
3665
3666     PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3667
3668     if (intro) {
3669         GvINTRO_off(dstr);      /* one-shot flag */
3670         GvLINE(dstr) = CopLINE(PL_curcop);
3671         GvEGV(dstr) = MUTABLE_GV(dstr);
3672     }
3673     GvMULTI_on(dstr);
3674     switch (stype) {
3675     case SVt_PVCV:
3676         location = (SV **) &GvCV(dstr);
3677         import_flag = GVf_IMPORTED_CV;
3678         goto common;
3679     case SVt_PVHV:
3680         location = (SV **) &GvHV(dstr);
3681         import_flag = GVf_IMPORTED_HV;
3682         goto common;
3683     case SVt_PVAV:
3684         location = (SV **) &GvAV(dstr);
3685         import_flag = GVf_IMPORTED_AV;
3686         goto common;
3687     case SVt_PVIO:
3688         location = (SV **) &GvIOp(dstr);
3689         goto common;
3690     case SVt_PVFM:
3691         location = (SV **) &GvFORM(dstr);
3692         goto common;
3693     default:
3694         location = &GvSV(dstr);
3695         import_flag = GVf_IMPORTED_SV;
3696     common:
3697         if (intro) {
3698             if (stype == SVt_PVCV) {
3699                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3700                 if (GvCVGEN(dstr)) {
3701                     SvREFCNT_dec(GvCV(dstr));
3702                     GvCV(dstr) = NULL;
3703                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3704                 }
3705             }
3706             SAVEGENERICSV(*location);
3707         }
3708         else
3709             dref = *location;
3710         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3711             CV* const cv = MUTABLE_CV(*location);
3712             if (cv) {
3713                 if (!GvCVGEN((const GV *)dstr) &&
3714                     (CvROOT(cv) || CvXSUB(cv)))
3715                     {
3716                         /* Redefining a sub - warning is mandatory if
3717                            it was a const and its value changed. */
3718                         if (CvCONST(cv) && CvCONST((const CV *)sref)
3719                             && cv_const_sv(cv)
3720                             == cv_const_sv((const CV *)sref)) {
3721                             NOOP;
3722                             /* They are 2 constant subroutines generated from
3723                                the same constant. This probably means that
3724                                they are really the "same" proxy subroutine
3725                                instantiated in 2 places. Most likely this is
3726                                when a constant is exported twice.  Don't warn.
3727                             */
3728                         }
3729                         else if (ckWARN(WARN_REDEFINE)
3730                                  || (CvCONST(cv)
3731                                      && (!CvCONST((const CV *)sref)
3732                                          || sv_cmp(cv_const_sv(cv),
3733                                                    cv_const_sv((const CV *)
3734                                                                sref))))) {
3735                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3736                                         (const char *)
3737                                         (CvCONST(cv)
3738                                          ? "Constant subroutine %s::%s redefined"
3739                                          : "Subroutine %s::%s redefined"),
3740                                         HvNAME_get(GvSTASH((const GV *)dstr)),
3741                                         GvENAME(MUTABLE_GV(dstr)));
3742                         }
3743                     }
3744                 if (!intro)
3745                     cv_ckproto_len(cv, (const GV *)dstr,
3746                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3747                                    SvPOK(sref) ? SvCUR(sref) : 0);
3748             }
3749             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3750             GvASSUMECV_on(dstr);
3751             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3752         }
3753         *location = sref;
3754         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3755             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3756             GvFLAGS(dstr) |= import_flag;
3757         }
3758         if (stype == SVt_PVAV && strEQ(GvNAME((GV*)dstr), "ISA")) {
3759             sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3760             mro_isa_changed_in(GvSTASH(dstr));
3761         }
3762         break;
3763     }
3764     SvREFCNT_dec(dref);
3765     if (SvTAINTED(sstr))
3766         SvTAINT(dstr);
3767     return;
3768 }
3769
3770 void
3771 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3772 {
3773     dVAR;
3774     register U32 sflags;
3775     register int dtype;
3776     register svtype stype;
3777
3778     PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3779
3780     if (sstr == dstr)
3781         return;
3782
3783     if (SvIS_FREED(dstr)) {
3784         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3785                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3786     }
3787     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3788     if (!sstr)
3789         sstr = &PL_sv_undef;
3790     if (SvIS_FREED(sstr)) {
3791         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3792                    (void*)sstr, (void*)dstr);
3793     }
3794     stype = SvTYPE(sstr);
3795     dtype = SvTYPE(dstr);
3796
3797     (void)SvAMAGIC_off(dstr);
3798     if ( SvVOK(dstr) )
3799     {
3800         /* need to nuke the magic */
3801         mg_free(dstr);
3802     }
3803
3804     /* There's a lot of redundancy below but we're going for speed here */
3805
3806     switch (stype) {
3807     case SVt_NULL:
3808       undef_sstr:
3809         if (dtype != SVt_PVGV) {
3810             (void)SvOK_off(dstr);
3811             return;
3812         }
3813         break;
3814     case SVt_IV:
3815         if (SvIOK(sstr)) {
3816             switch (dtype) {
3817             case SVt_NULL:
3818                 sv_upgrade(dstr, SVt_IV);
3819                 break;
3820             case SVt_NV:
3821             case SVt_PV:
3822                 sv_upgrade(dstr, SVt_PVIV);
3823                 break;
3824             case SVt_PVGV:
3825                 goto end_of_first_switch;
3826             }
3827             (void)SvIOK_only(dstr);
3828             SvIV_set(dstr,  SvIVX(sstr));
3829             if (SvIsUV(sstr))
3830                 SvIsUV_on(dstr);
3831             /* SvTAINTED can only be true if the SV has taint magic, which in
3832                turn means that the SV type is PVMG (or greater). This is the
3833                case statement for SVt_IV, so this cannot be true (whatever gcov
3834                may say).  */
3835             assert(!SvTAINTED(sstr));
3836             return;
3837         }
3838         if (!SvROK(sstr))
3839             goto undef_sstr;
3840         if (dtype < SVt_PV && dtype != SVt_IV)
3841             sv_upgrade(dstr, SVt_IV);
3842         break;
3843
3844     case SVt_NV:
3845         if (SvNOK(sstr)) {
3846             switch (dtype) {
3847             case SVt_NULL:
3848             case SVt_IV:
3849                 sv_upgrade(dstr, SVt_NV);
3850                 break;
3851             case SVt_PV:
3852             case SVt_PVIV:
3853                 sv_upgrade(dstr, SVt_PVNV);
3854                 break;
3855             case SVt_PVGV:
3856                 goto end_of_first_switch;
3857             }
3858             SvNV_set(dstr, SvNVX(sstr));
3859             (void)SvNOK_only(dstr);
3860             /* SvTAINTED can only be true if the SV has taint magic, which in
3861                turn means that the SV type is PVMG (or greater). This is the
3862                case statement for SVt_NV, so this cannot be true (whatever gcov
3863                may say).  */
3864             assert(!SvTAINTED(sstr));
3865             return;
3866         }
3867         goto undef_sstr;
3868
3869     case SVt_PVFM:
3870 #ifdef PERL_OLD_COPY_ON_WRITE
3871         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3872             if (dtype < SVt_PVIV)
3873                 sv_upgrade(dstr, SVt_PVIV);
3874             break;
3875         }
3876         /* Fall through */
3877 #endif
3878     case SVt_PV:
3879         if (dtype < SVt_PV)
3880             sv_upgrade(dstr, SVt_PV);
3881         break;
3882     case SVt_PVIV:
3883         if (dtype < SVt_PVIV)
3884             sv_upgrade(dstr, SVt_PVIV);
3885         break;
3886     case SVt_PVNV:
3887         if (dtype < SVt_PVNV)
3888             sv_upgrade(dstr, SVt_PVNV);
3889         break;
3890     default:
3891         {
3892         const char * const type = sv_reftype(sstr,0);
3893         if (PL_op)
3894             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
3895         else
3896             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3897         }
3898         break;
3899
3900     case SVt_REGEXP:
3901         if (dtype < SVt_REGEXP)
3902             sv_upgrade(dstr, SVt_REGEXP);
3903         break;
3904
3905         /* case SVt_BIND: */
3906     case SVt_PVLV:
3907     case SVt_PVGV:
3908         if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3909             glob_assign_glob(dstr, sstr, dtype);
3910             return;
3911         }
3912         /* SvVALID means that this PVGV is playing at being an FBM.  */
3913         /*FALLTHROUGH*/
3914
3915     case SVt_PVMG:
3916         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3917             mg_get(sstr);
3918             if (SvTYPE(sstr) != stype) {
3919                 stype = SvTYPE(sstr);
3920                 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3921                     glob_assign_glob(dstr, sstr, dtype);
3922                     return;
3923                 }
3924             }
3925         }
3926         if (stype == SVt_PVLV)
3927             SvUPGRADE(dstr, SVt_PVNV);
3928         else
3929             SvUPGRADE(dstr, (svtype)stype);
3930     }
3931  end_of_first_switch:
3932
3933     /* dstr may have been upgraded.  */
3934     dtype = SvTYPE(dstr);
3935     sflags = SvFLAGS(sstr);
3936
3937     if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3938         /* Assigning to a subroutine sets the prototype.  */
3939         if (SvOK(sstr)) {
3940             STRLEN len;
3941             const char *const ptr = SvPV_const(sstr, len);
3942
3943             SvGROW(dstr, len + 1);
3944             Copy(ptr, SvPVX(dstr), len + 1, char);
3945             SvCUR_set(dstr, len);
3946             SvPOK_only(dstr);
3947             SvFLAGS(dstr) |= sflags & SVf_UTF8;
3948         } else {
3949             SvOK_off(dstr);
3950         }
3951     } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3952         const char * const type = sv_reftype(dstr,0);
3953         if (PL_op)
3954             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
3955         else
3956             Perl_croak(aTHX_ "Cannot copy to %s", type);
3957     } else if (sflags & SVf_ROK) {
3958         if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3959             && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
3960             sstr = SvRV(sstr);
3961             if (sstr == dstr) {
3962                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3963                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3964                 {
3965                     GvIMPORTED_on(dstr);
3966                 }
3967                 GvMULTI_on(dstr);
3968                 return;
3969             }
3970             glob_assign_glob(dstr, sstr, dtype);
3971             return;
3972         }
3973
3974         if (dtype >= SVt_PV) {
3975             if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3976                 glob_assign_ref(dstr, sstr);
3977                 return;
3978             }
3979             if (SvPVX_const(dstr)) {
3980                 SvPV_free(dstr);
3981                 SvLEN_set(dstr, 0);
3982                 SvCUR_set(dstr, 0);
3983             }
3984         }
3985         (void)SvOK_off(dstr);
3986         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3987         SvFLAGS(dstr) |= sflags & SVf_ROK;
3988         assert(!(sflags & SVp_NOK));
3989         assert(!(sflags & SVp_IOK));
3990         assert(!(sflags & SVf_NOK));
3991         assert(!(sflags & SVf_IOK));
3992     }
3993     else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3994         if (!(sflags & SVf_OK)) {
3995             Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3996                            "Undefined value assigned to typeglob");
3997         }
3998         else {
3999             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4000             if (dstr != (const SV *)gv) {
4001                 if (GvGP(dstr))
4002                     gp_free(MUTABLE_GV(dstr));
4003                 GvGP(dstr) = gp_ref(GvGP(gv));
4004             }
4005         }
4006     }
4007     else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4008         reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4009     }
4010     else if (sflags & SVp_POK) {
4011         bool isSwipe = 0;
4012
4013         /*
4014          * Check to see if we can just swipe the string.  If so, it's a
4015          * possible small lose on short strings, but a big win on long ones.
4016          * It might even be a win on short strings if SvPVX_const(dstr)
4017          * has to be allocated and SvPVX_const(sstr) has to be freed.
4018          * Likewise if we can set up COW rather than doing an actual copy, we
4019          * drop to the else clause, as the swipe code and the COW setup code
4020          * have much in common.
4021          */
4022
4023         /* Whichever path we take through the next code, we want this true,
4024            and doing it now facilitates the COW check.  */
4025         (void)SvPOK_only(dstr);
4026
4027         if (
4028             /* If we're already COW then this clause is not true, and if COW
4029                is allowed then we drop down to the else and make dest COW 
4030                with us.  If caller hasn't said that we're allowed to COW
4031                shared hash keys then we don't do the COW setup, even if the
4032                source scalar is a shared hash key scalar.  */
4033             (((flags & SV_COW_SHARED_HASH_KEYS)
4034                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4035                : 1 /* If making a COW copy is forbidden then the behaviour we
4036                        desire is as if the source SV isn't actually already
4037                        COW, even if it is.  So we act as if the source flags
4038                        are not COW, rather than actually testing them.  */
4039               )
4040 #ifndef PERL_OLD_COPY_ON_WRITE
4041              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4042                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4043                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4044                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4045                 but in turn, it's somewhat dead code, never expected to go
4046                 live, but more kept as a placeholder on how to do it better
4047                 in a newer implementation.  */
4048              /* If we are COW and dstr is a suitable target then we drop down
4049                 into the else and make dest a COW of us.  */
4050              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4051 #endif
4052              )
4053             &&
4054             !(isSwipe =
4055                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4056                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4057                  (!(flags & SV_NOSTEAL)) &&
4058                                         /* and we're allowed to steal temps */
4059                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4060                  SvLEN(sstr))             /* and really is a string */
4061 #ifdef PERL_OLD_COPY_ON_WRITE
4062             && ((flags & SV_COW_SHARED_HASH_KEYS)
4063                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4064                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4065                      && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4066                 : 1)
4067 #endif
4068             ) {
4069             /* Failed the swipe test, and it's not a shared hash key either.
4070                Have to copy the string.  */
4071             STRLEN len = SvCUR(sstr);
4072             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4073             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4074             SvCUR_set(dstr, len);
4075             *SvEND(dstr) = '\0';
4076         } else {
4077             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4078                be true in here.  */
4079             /* Either it's a shared hash key, or it's suitable for
4080                copy-on-write or we can swipe the string.  */
4081             if (DEBUG_C_TEST) {
4082                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4083                 sv_dump(sstr);
4084                 sv_dump(dstr);
4085             }
4086 #ifdef PERL_OLD_COPY_ON_WRITE
4087             if (!isSwipe) {
4088                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4089                     != (SVf_FAKE | SVf_READONLY)) {
4090                     SvREADONLY_on(sstr);
4091                     SvFAKE_on(sstr);
4092                     /* Make the source SV into a loop of 1.
4093                        (about to become 2) */
4094                     SV_COW_NEXT_SV_SET(sstr, sstr);
4095                 }
4096             }
4097 #endif
4098             /* Initial code is common.  */
4099             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
4100                 SvPV_free(dstr);
4101             }
4102
4103             if (!isSwipe) {
4104                 /* making another shared SV.  */
4105                 STRLEN cur = SvCUR(sstr);
4106                 STRLEN len = SvLEN(sstr);
4107 #ifdef PERL_OLD_COPY_ON_WRITE
4108                 if (len) {
4109                     assert (SvTYPE(dstr) >= SVt_PVIV);
4110                     /* SvIsCOW_normal */
4111                     /* splice us in between source and next-after-source.  */
4112                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4113                     SV_COW_NEXT_SV_SET(sstr, dstr);
4114                     SvPV_set(dstr, SvPVX_mutable(sstr));
4115                 } else
4116 #endif
4117                 {
4118                     /* SvIsCOW_shared_hash */
4119                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4120                                           "Copy on write: Sharing hash\n"));
4121
4122                     assert (SvTYPE(dstr) >= SVt_PV);
4123                     SvPV_set(dstr,
4124                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4125                 }
4126                 SvLEN_set(dstr, len);
4127                 SvCUR_set(dstr, cur);
4128                 SvREADONLY_on(dstr);
4129                 SvFAKE_on(dstr);
4130             }
4131             else
4132                 {       /* Passes the swipe test.  */
4133                 SvPV_set(dstr, SvPVX_mutable(sstr));
4134                 SvLEN_set(dstr, SvLEN(sstr));
4135                 SvCUR_set(dstr, SvCUR(sstr));
4136
4137                 SvTEMP_off(dstr);
4138                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4139                 SvPV_set(sstr, NULL);
4140                 SvLEN_set(sstr, 0);
4141                 SvCUR_set(sstr, 0);
4142                 SvTEMP_off(sstr);
4143             }
4144         }
4145         if (sflags & SVp_NOK) {
4146             SvNV_set(dstr, SvNVX(sstr));
4147         }
4148         if (sflags & SVp_IOK) {
4149             SvIV_set(dstr, SvIVX(sstr));
4150             /* Must do this otherwise some other overloaded use of 0x80000000
4151                gets confused. I guess SVpbm_VALID */
4152             if (sflags & SVf_IVisUV)
4153                 SvIsUV_on(dstr);
4154         }
4155         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4156         {
4157             const MAGIC * const smg = SvVSTRING_mg(sstr);
4158             if (smg) {
4159                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4160                          smg->mg_ptr, smg->mg_len);
4161                 SvRMAGICAL_on(dstr);
4162             }
4163         }
4164     }
4165     else if (sflags & (SVp_IOK|SVp_NOK)) {
4166         (void)SvOK_off(dstr);
4167         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4168         if (sflags & SVp_IOK) {
4169             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4170             SvIV_set(dstr, SvIVX(sstr));
4171         }
4172         if (sflags & SVp_NOK) {
4173             SvNV_set(dstr, SvNVX(sstr));
4174         }
4175     }
4176     else {
4177         if (isGV_with_GP(sstr)) {
4178             /* This stringification rule for globs is spread in 3 places.
4179                This feels bad. FIXME.  */
4180             const U32 wasfake = sflags & SVf_FAKE;
4181
4182             /* FAKE globs can get coerced, so need to turn this off
4183                temporarily if it is on.  */
4184             SvFAKE_off(sstr);
4185             gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4186             SvFLAGS(sstr) |= wasfake;
4187         }
4188         else
4189             (void)SvOK_off(dstr);
4190     }
4191     if (SvTAINTED(sstr))
4192         SvTAINT(dstr);
4193 }
4194
4195 /*
4196 =for apidoc sv_setsv_mg
4197
4198 Like C<sv_setsv>, but also handles 'set' magic.
4199
4200 =cut
4201 */
4202
4203 void
4204 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4205 {
4206     PERL_ARGS_ASSERT_SV_SETSV_MG;
4207
4208     sv_setsv(dstr,sstr);
4209     SvSETMAGIC(dstr);
4210 }
4211
4212 #ifdef PERL_OLD_COPY_ON_WRITE
4213 SV *
4214 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4215 {
4216     STRLEN cur = SvCUR(sstr);
4217     STRLEN len = SvLEN(sstr);
4218     register char *new_pv;
4219
4220     PERL_ARGS_ASSERT_SV_SETSV_COW;
4221
4222     if (DEBUG_C_TEST) {
4223         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4224                       (void*)sstr, (void*)dstr);
4225         sv_dump(sstr);
4226         if (dstr)
4227                     sv_dump(dstr);
4228     }
4229
4230     if (dstr) {
4231         if (SvTHINKFIRST(dstr))
4232             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4233         else if (SvPVX_const(dstr))
4234             Safefree(SvPVX_const(dstr));
4235     }
4236     else
4237         new_SV(dstr);
4238     SvUPGRADE(dstr, SVt_PVIV);
4239
4240     assert (SvPOK(sstr));
4241     assert (SvPOKp(sstr));
4242     assert (!SvIOK(sstr));
4243     assert (!SvIOKp(sstr));
4244     assert (!SvNOK(sstr));
4245     assert (!SvNOKp(sstr));
4246
4247     if (SvIsCOW(sstr)) {
4248
4249         if (SvLEN(sstr) == 0) {
4250             /* source is a COW shared hash key.  */
4251             DEBUG_C(PerlIO_printf(Perl_debug_log,
4252                                   "Fast copy on write: Sharing hash\n"));
4253             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4254             goto common_exit;
4255         }
4256         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4257     } else {
4258         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4259         SvUPGRADE(sstr, SVt_PVIV);
4260         SvREADONLY_on(sstr);
4261         SvFAKE_on(sstr);
4262         DEBUG_C(PerlIO_printf(Perl_debug_log,
4263                               "Fast copy on write: Converting sstr to COW\n"));
4264         SV_COW_NEXT_SV_SET(dstr, sstr);
4265     }
4266     SV_COW_NEXT_SV_SET(sstr, dstr);
4267     new_pv = SvPVX_mutable(sstr);
4268
4269   common_exit:
4270     SvPV_set(dstr, new_pv);
4271     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4272     if (SvUTF8(sstr))
4273         SvUTF8_on(dstr);
4274     SvLEN_set(dstr, len);
4275     SvCUR_set(dstr, cur);
4276     if (DEBUG_C_TEST) {
4277         sv_dump(dstr);
4278     }
4279     return dstr;
4280 }
4281 #endif
4282
4283 /*
4284 =for apidoc sv_setpvn
4285
4286 Copies a string into an SV.  The C<len> parameter indicates the number of
4287 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4288 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4289
4290 =cut
4291 */
4292
4293 void
4294 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4295 {
4296     dVAR;
4297     register char *dptr;
4298
4299     PERL_ARGS_ASSERT_SV_SETPVN;
4300
4301     SV_CHECK_THINKFIRST_COW_DROP(sv);
4302     if (!ptr) {
4303         (void)SvOK_off(sv);
4304         return;
4305     }
4306     else {
4307         /* len is STRLEN which is unsigned, need to copy to signed */
4308         const IV iv = len;
4309         if (iv < 0)
4310             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4311     }
4312     SvUPGRADE(sv, SVt_PV);
4313
4314     dptr = SvGROW(sv, len + 1);
4315     Move(ptr,dptr,len,char);
4316     dptr[len] = '\0';
4317     SvCUR_set(sv, len);
4318     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4319     SvTAINT(sv);
4320 }
4321
4322 /*
4323 =for apidoc sv_setpvn_mg
4324
4325 Like C<sv_setpvn>, but also handles 'set' magic.
4326
4327 =cut
4328 */
4329
4330 void
4331 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4332 {
4333     PERL_ARGS_ASSERT_SV_SETPVN_MG;
4334
4335     sv_setpvn(sv,ptr,len);
4336     SvSETMAGIC(sv);
4337 }
4338
4339 /*
4340 =for apidoc sv_setpv
4341
4342 Copies a string into an SV.  The string must be null-terminated.  Does not
4343 handle 'set' magic.  See C<sv_setpv_mg>.
4344
4345 =cut
4346 */
4347
4348 void
4349 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4350 {
4351     dVAR;
4352     register STRLEN len;
4353
4354     PERL_ARGS_ASSERT_SV_SETPV;
4355
4356     SV_CHECK_THINKFIRST_COW_DROP(sv);
4357     if (!ptr) {
4358         (void)SvOK_off(sv);
4359         return;
4360     }
4361     len = strlen(ptr);
4362     SvUPGRADE(sv, SVt_PV);
4363
4364     SvGROW(sv, len + 1);
4365     Move(ptr,SvPVX(sv),len+1,char);
4366     SvCUR_set(sv, len);
4367     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4368     SvTAINT(sv);
4369 }
4370
4371 /*
4372 =for apidoc sv_setpv_mg
4373
4374 Like C<sv_setpv>, but also handles 'set' magic.
4375
4376 =cut
4377 */
4378
4379 void
4380 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4381 {
4382     PERL_ARGS_ASSERT_SV_SETPV_MG;
4383
4384     sv_setpv(sv,ptr);
4385     SvSETMAGIC(sv);
4386 }
4387
4388 /*
4389 =for apidoc sv_usepvn_flags
4390
4391 Tells an SV to use C<ptr> to find its string value.  Normally the
4392 string is stored inside the SV but sv_usepvn allows the SV to use an
4393 outside string.  The C<ptr> should point to memory that was allocated
4394 by C<malloc>.  The string length, C<len>, must be supplied.  By default
4395 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4396 so that pointer should not be freed or used by the programmer after
4397 giving it to sv_usepvn, and neither should any pointers from "behind"
4398 that pointer (e.g. ptr + 1) be used.
4399
4400 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4401 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4402 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4403 C<len>, and already meets the requirements for storing in C<SvPVX>)
4404
4405 =cut
4406 */
4407
4408 void
4409 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4410 {
4411     dVAR;
4412     STRLEN allocate;
4413
4414     PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4415
4416     SV_CHECK_THINKFIRST_COW_DROP(sv);
4417     SvUPGRADE(sv, SVt_PV);
4418     if (!ptr) {
4419         (void)SvOK_off(sv);
4420         if (flags & SV_SMAGIC)
4421             SvSETMAGIC(sv);
4422         return;
4423     }
4424     if (SvPVX_const(sv))
4425         SvPV_free(sv);
4426
4427 #ifdef DEBUGGING
4428     if (flags & SV_HAS_TRAILING_NUL)
4429         assert(ptr[len] == '\0');
4430 #endif
4431
4432     allocate = (flags & SV_HAS_TRAILING_NUL)
4433         ? len + 1 :
4434 #ifdef Perl_safesysmalloc_size
4435         len + 1;
4436 #else 
4437         PERL_STRLEN_ROUNDUP(len + 1);
4438 #endif
4439     if (flags & SV_HAS_TRAILING_NUL) {
4440         /* It's long enough - do nothing.
4441            Specfically Perl_newCONSTSUB is relying on this.  */
4442     } else {
4443 #ifdef DEBUGGING
4444         /* Force a move to shake out bugs in callers.  */
4445         char *new_ptr = (char*)safemalloc(allocate);
4446         Copy(ptr, new_ptr, len, char);
4447         PoisonFree(ptr,len,char);
4448         Safefree(ptr);
4449         ptr = new_ptr;
4450 #else
4451         ptr = (char*) saferealloc (ptr, allocate);
4452 #endif
4453     }
4454 #ifdef Perl_safesysmalloc_size
4455     SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4456 #else
4457     SvLEN_set(sv, allocate);
4458 #endif
4459     SvCUR_set(sv, len);
4460     SvPV_set(sv, ptr);
4461     if (!(flags & SV_HAS_TRAILING_NUL)) {
4462         ptr[len] = '\0';
4463     }
4464     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4465     SvTAINT(sv);
4466     if (flags & SV_SMAGIC)
4467         SvSETMAGIC(sv);
4468 }
4469
4470 #ifdef PERL_OLD_COPY_ON_WRITE
4471 /* Need to do this *after* making the SV normal, as we need the buffer
4472    pointer to remain valid until after we've copied it.  If we let go too early,
4473    another thread could invalidate it by unsharing last of the same hash key
4474    (which it can do by means other than releasing copy-on-write Svs)
4475    or by changing the other copy-on-write SVs in the loop.  */
4476 STATIC void
4477 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4478 {
4479     PERL_ARGS_ASSERT_SV_RELEASE_COW;
4480
4481     { /* this SV was SvIsCOW_normal(sv) */
4482          /* we need to find the SV pointing to us.  */
4483         SV *current = SV_COW_NEXT_SV(after);
4484
4485         if (current == sv) {
4486             /* The SV we point to points back to us (there were only two of us
4487                in the loop.)
4488                Hence other SV is no longer copy on write either.  */
4489             SvFAKE_off(after);
4490             SvREADONLY_off(after);
4491         } else {
4492             /* We need to follow the pointers around the loop.  */
4493             SV *next;
4494             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4495                 assert (next);
4496                 current = next;
4497                  /* don't loop forever if the structure is bust, and we have
4498                     a pointer into a closed loop.  */
4499                 assert (current != after);
4500                 assert (SvPVX_const(current) == pvx);
4501             }
4502             /* Make the SV before us point to the SV after us.  */
4503             SV_COW_NEXT_SV_SET(current, after);
4504         }
4505     }
4506 }
4507 #endif
4508 /*
4509 =for apidoc sv_force_normal_flags
4510
4511 Undo various types of fakery on an SV: if the PV is a shared string, make
4512 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4513 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4514 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4515 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4516 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4517 set to some other value.) In addition, the C<flags> parameter gets passed to
4518 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4519 with flags set to 0.
4520
4521 =cut
4522 */
4523
4524 void
4525 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4526 {
4527     dVAR;
4528
4529     PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4530
4531 #ifdef PERL_OLD_COPY_ON_WRITE
4532     if (SvREADONLY(sv)) {
4533         if (SvFAKE(sv)) {
4534             const char * const pvx = SvPVX_const(sv);
4535             const STRLEN len = SvLEN(sv);
4536             const STRLEN cur = SvCUR(sv);
4537             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4538                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4539                we'll fail an assertion.  */
4540             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4541
4542             if (DEBUG_C_TEST) {
4543                 PerlIO_printf(Perl_debug_log,
4544                               "Copy on write: Force normal %ld\n",
4545                               (long) flags);
4546                 sv_dump(sv);
4547             }
4548             SvFAKE_off(sv);
4549             SvREADONLY_off(sv);
4550             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4551             SvPV_set(sv, NULL);
4552             SvLEN_set(sv, 0);
4553             if (flags & SV_COW_DROP_PV) {
4554                 /* OK, so we don't need to copy our buffer.  */
4555                 SvPOK_off(sv);
4556             } else {
4557                 SvGROW(sv, cur + 1);
4558                 Move(pvx,SvPVX(sv),cur,char);
4559                 SvCUR_set(sv, cur);
4560                 *SvEND(sv) = '\0';
4561             }
4562             if (len) {
4563                 sv_release_COW(sv, pvx, next);
4564             } else {
4565                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4566             }
4567             if (DEBUG_C_TEST) {
4568                 sv_dump(sv);
4569             }
4570         }
4571         else if (IN_PERL_RUNTIME)
4572             Perl_croak_no_modify(aTHX);
4573     }
4574 #else
4575     if (SvREADONLY(sv)) {
4576         if (SvFAKE(sv)) {
4577             const char * const pvx = SvPVX_const(sv);
4578             const STRLEN len = SvCUR(sv);
4579             SvFAKE_off(sv);
4580             SvREADONLY_off(sv);
4581             SvPV_set(sv, NULL);
4582             SvLEN_set(sv, 0);
4583             SvGROW(sv, len + 1);
4584             Move(pvx,SvPVX(sv),len,char);
4585             *SvEND(sv) = '\0';
4586             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4587         }
4588         else if (IN_PERL_RUNTIME)
4589             Perl_croak_no_modify(aTHX);
4590     }
4591 #endif
4592     if (SvROK(sv))
4593         sv_unref_flags(sv, flags);
4594     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4595         sv_unglob(sv);
4596     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4597         /* Need to downgrade the REGEXP to a simple(r) scalar. This is analagous
4598            to sv_unglob. We only need it here, so inline it.  */
4599         const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4600         SV *const temp = newSV_type(new_type);
4601         void *const temp_p = SvANY(sv);
4602
4603         if (new_type == SVt_PVMG) {
4604             SvMAGIC_set(temp, SvMAGIC(sv));
4605             SvMAGIC_set(sv, NULL);
4606             SvSTASH_set(temp, SvSTASH(sv));
4607             SvSTASH_set(sv, NULL);
4608         }
4609         SvCUR_set(temp, SvCUR(sv));
4610         /* Remember that SvPVX is in the head, not the body. */
4611         if (SvLEN(temp)) {
4612             SvLEN_set(temp, SvLEN(sv));
4613             /* This signals "buffer is owned by someone else" in sv_clear,
4614                which is the least effort way to stop it freeing the buffer.
4615             */
4616             SvLEN_set(sv, SvLEN(sv)+1);
4617         } else {
4618             /* Their buffer is already owned by someone else. */
4619             SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4620             SvLEN_set(temp, SvCUR(sv)+1);
4621         }
4622
4623         /* Now swap the rest of the bodies. */
4624
4625         SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4626         SvFLAGS(sv) |= new_type;
4627         SvANY(sv) = SvANY(temp);
4628
4629         SvFLAGS(temp) &= ~(SVTYPEMASK);
4630         SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4631         SvANY(temp) = temp_p;
4632
4633         SvREFCNT_dec(temp);
4634     }
4635 }
4636
4637 /*
4638 =for apidoc sv_chop
4639
4640 Efficient removal of characters from the beginning of the string buffer.
4641 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4642 the string buffer.  The C<ptr> becomes the first character of the adjusted
4643 string. Uses the "OOK hack".
4644 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4645 refer to the same chunk of data.
4646
4647 =cut
4648 */
4649
4650 void
4651 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4652 {
4653     STRLEN delta;
4654     STRLEN old_delta;
4655     U8 *p;
4656 #ifdef DEBUGGING
4657     const U8 *real_start;
4658 #endif
4659     STRLEN max_delta;
4660
4661     PERL_ARGS_ASSERT_SV_CHOP;
4662
4663     if (!ptr || !SvPOKp(sv))
4664         return;
4665     delta = ptr - SvPVX_const(sv);
4666     if (!delta) {
4667         /* Nothing to do.  */
4668         return;
4669     }
4670     /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4671        nothing uses the value of ptr any more.  */
4672     max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4673     if (ptr <= SvPVX_const(sv))
4674         Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4675                    ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4676     SV_CHECK_THINKFIRST(sv);
4677     if (delta > max_delta)
4678         Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4679                    SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4680                    SvPVX_const(sv) + max_delta);
4681
4682     if (!SvOOK(sv)) {
4683         if (!SvLEN(sv)) { /* make copy of shared string */
4684             const char *pvx = SvPVX_const(sv);
4685             const STRLEN len = SvCUR(sv);
4686             SvGROW(sv, len + 1);
4687             Move(pvx,SvPVX(sv),len,char);
4688             *SvEND(sv) = '\0';
4689         }
4690         SvFLAGS(sv) |= SVf_OOK;
4691        &