re-indent sv_clear()
[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                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2745                     tbuf[0] = '0';
2746                     tbuf[1] = 0;
2747                     len = 1;
2748                 }
2749                 SvUPGRADE(sv, SVt_PV);
2750                 if (lp)
2751                     *lp = len;
2752                 s = SvGROW_mutable(sv, len + 1);
2753                 SvCUR_set(sv, len);
2754                 SvPOKp_on(sv);
2755                 return (char*)memcpy(s, tbuf, len + 1);
2756             }
2757         }
2758         if (SvROK(sv)) {
2759             goto return_rok;
2760         }
2761         assert(SvTYPE(sv) >= SVt_PVMG);
2762         /* This falls through to the report_uninit near the end of the
2763            function. */
2764     } else if (SvTHINKFIRST(sv)) {
2765         if (SvROK(sv)) {
2766         return_rok:
2767             if (SvAMAGIC(sv)) {
2768                 SV *tmpstr;
2769                 if (flags & SV_SKIP_OVERLOAD)
2770                     return NULL;
2771                 tmpstr = AMG_CALLun(sv,string);
2772                 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2773                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2774                     /* Unwrap this:  */
2775                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2776                      */
2777
2778                     char *pv;
2779                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2780                         if (flags & SV_CONST_RETURN) {
2781                             pv = (char *) SvPVX_const(tmpstr);
2782                         } else {
2783                             pv = (flags & SV_MUTABLE_RETURN)
2784                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2785                         }
2786                         if (lp)
2787                             *lp = SvCUR(tmpstr);
2788                     } else {
2789                         pv = sv_2pv_flags(tmpstr, lp, flags);
2790                     }
2791                     if (SvUTF8(tmpstr))
2792                         SvUTF8_on(sv);
2793                     else
2794                         SvUTF8_off(sv);
2795                     return pv;
2796                 }
2797             }
2798             {
2799                 STRLEN len;
2800                 char *retval;
2801                 char *buffer;
2802                 SV *const referent = SvRV(sv);
2803
2804                 if (!referent) {
2805                     len = 7;
2806                     retval = buffer = savepvn("NULLREF", len);
2807                 } else if (SvTYPE(referent) == SVt_REGEXP) {
2808                     REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2809                     I32 seen_evals = 0;
2810
2811                     assert(re);
2812                         
2813                     /* If the regex is UTF-8 we want the containing scalar to
2814                        have an UTF-8 flag too */
2815                     if (RX_UTF8(re))
2816                         SvUTF8_on(sv);
2817                     else
2818                         SvUTF8_off(sv); 
2819
2820                     if ((seen_evals = RX_SEEN_EVALS(re)))
2821                         PL_reginterp_cnt += seen_evals;
2822
2823                     if (lp)
2824                         *lp = RX_WRAPLEN(re);
2825  
2826                     return RX_WRAPPED(re);
2827                 } else {
2828                     const char *const typestr = sv_reftype(referent, 0);
2829                     const STRLEN typelen = strlen(typestr);
2830                     UV addr = PTR2UV(referent);
2831                     const char *stashname = NULL;
2832                     STRLEN stashnamelen = 0; /* hush, gcc */
2833                     const char *buffer_end;
2834
2835                     if (SvOBJECT(referent)) {
2836                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2837
2838                         if (name) {
2839                             stashname = HEK_KEY(name);
2840                             stashnamelen = HEK_LEN(name);
2841
2842                             if (HEK_UTF8(name)) {
2843                                 SvUTF8_on(sv);
2844                             } else {
2845                                 SvUTF8_off(sv);
2846                             }
2847                         } else {
2848                             stashname = "__ANON__";
2849                             stashnamelen = 8;
2850                         }
2851                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2852                             + 2 * sizeof(UV) + 2 /* )\0 */;
2853                     } else {
2854                         len = typelen + 3 /* (0x */
2855                             + 2 * sizeof(UV) + 2 /* )\0 */;
2856                     }
2857
2858                     Newx(buffer, len, char);
2859                     buffer_end = retval = buffer + len;
2860
2861                     /* Working backwards  */
2862                     *--retval = '\0';
2863                     *--retval = ')';
2864                     do {
2865                         *--retval = PL_hexdigit[addr & 15];
2866                     } while (addr >>= 4);
2867                     *--retval = 'x';
2868                     *--retval = '0';
2869                     *--retval = '(';
2870
2871                     retval -= typelen;
2872                     memcpy(retval, typestr, typelen);
2873
2874                     if (stashname) {
2875                         *--retval = '=';
2876                         retval -= stashnamelen;
2877                         memcpy(retval, stashname, stashnamelen);
2878                     }
2879                     /* retval may not neccesarily have reached the start of the
2880                        buffer here.  */
2881                     assert (retval >= buffer);
2882
2883                     len = buffer_end - retval - 1; /* -1 for that \0  */
2884                 }
2885                 if (lp)
2886                     *lp = len;
2887                 SAVEFREEPV(buffer);
2888                 return retval;
2889             }
2890         }
2891         if (SvREADONLY(sv) && !SvOK(sv)) {
2892             if (lp)
2893                 *lp = 0;
2894             if (flags & SV_UNDEF_RETURNS_NULL)
2895                 return NULL;
2896             if (ckWARN(WARN_UNINITIALIZED))
2897                 report_uninit(sv);
2898             return (char *)"";
2899         }
2900     }
2901     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2902         /* I'm assuming that if both IV and NV are equally valid then
2903            converting the IV is going to be more efficient */
2904         const U32 isUIOK = SvIsUV(sv);
2905         char buf[TYPE_CHARS(UV)];
2906         char *ebuf, *ptr;
2907         STRLEN len;
2908
2909         if (SvTYPE(sv) < SVt_PVIV)
2910             sv_upgrade(sv, SVt_PVIV);
2911         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2912         len = ebuf - ptr;
2913         /* inlined from sv_setpvn */
2914         s = SvGROW_mutable(sv, len + 1);
2915         Move(ptr, s, len, char);
2916         s += len;
2917         *s = '\0';
2918     }
2919     else if (SvNOKp(sv)) {
2920         dSAVE_ERRNO;
2921         if (SvTYPE(sv) < SVt_PVNV)
2922             sv_upgrade(sv, SVt_PVNV);
2923         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2924         s = SvGROW_mutable(sv, NV_DIG + 20);
2925         /* some Xenix systems wipe out errno here */
2926 #ifdef apollo
2927         if (SvNVX(sv) == 0.0)
2928             my_strlcpy(s, "0", SvLEN(sv));
2929         else
2930 #endif /*apollo*/
2931         {
2932             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2933         }
2934         RESTORE_ERRNO;
2935         if (*s == '-' && s[1] == '0' && !s[2]) {
2936             s[0] = '0';
2937             s[1] = 0;
2938         }
2939         while (*s) s++;
2940 #ifdef hcx
2941         if (s[-1] == '.')
2942             *--s = '\0';
2943 #endif
2944     }
2945     else {
2946         if (isGV_with_GP(sv)) {
2947             GV *const gv = MUTABLE_GV(sv);
2948             const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2949             SV *const buffer = sv_newmortal();
2950
2951             /* FAKE globs can get coerced, so need to turn this off temporarily
2952                if it is on.  */
2953             SvFAKE_off(gv);
2954             gv_efullname3(buffer, gv, "*");
2955             SvFLAGS(gv) |= wasfake;
2956
2957             if (SvPOK(buffer)) {
2958                 if (lp) {
2959                     *lp = SvCUR(buffer);
2960                 }
2961                 return SvPVX(buffer);
2962             }
2963             else {
2964                 if (lp)
2965                     *lp = 0;
2966                 return (char *)"";
2967             }
2968         }
2969
2970         if (lp)
2971             *lp = 0;
2972         if (flags & SV_UNDEF_RETURNS_NULL)
2973             return NULL;
2974         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2975             report_uninit(sv);
2976         if (SvTYPE(sv) < SVt_PV)
2977             /* Typically the caller expects that sv_any is not NULL now.  */
2978             sv_upgrade(sv, SVt_PV);
2979         return (char *)"";
2980     }
2981     {
2982         const STRLEN len = s - SvPVX_const(sv);
2983         if (lp) 
2984             *lp = len;
2985         SvCUR_set(sv, len);
2986     }
2987     SvPOK_on(sv);
2988     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2989                           PTR2UV(sv),SvPVX_const(sv)));
2990     if (flags & SV_CONST_RETURN)
2991         return (char *)SvPVX_const(sv);
2992     if (flags & SV_MUTABLE_RETURN)
2993         return SvPVX_mutable(sv);
2994     return SvPVX(sv);
2995 }
2996
2997 /*
2998 =for apidoc sv_copypv
2999
3000 Copies a stringified representation of the source SV into the
3001 destination SV.  Automatically performs any necessary mg_get and
3002 coercion of numeric values into strings.  Guaranteed to preserve
3003 UTF8 flag even from overloaded objects.  Similar in nature to
3004 sv_2pv[_flags] but operates directly on an SV instead of just the
3005 string.  Mostly uses sv_2pv_flags to do its work, except when that
3006 would lose the UTF-8'ness of the PV.
3007
3008 =cut
3009 */
3010
3011 void
3012 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3013 {
3014     STRLEN len;
3015     const char * const s = SvPV_const(ssv,len);
3016
3017     PERL_ARGS_ASSERT_SV_COPYPV;
3018
3019     sv_setpvn(dsv,s,len);
3020     if (SvUTF8(ssv))
3021         SvUTF8_on(dsv);
3022     else
3023         SvUTF8_off(dsv);
3024 }
3025
3026 /*
3027 =for apidoc sv_2pvbyte
3028
3029 Return a pointer to the byte-encoded representation of the SV, and set *lp
3030 to its length.  May cause the SV to be downgraded from UTF-8 as a
3031 side-effect.
3032
3033 Usually accessed via the C<SvPVbyte> macro.
3034
3035 =cut
3036 */
3037
3038 char *
3039 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3040 {
3041     PERL_ARGS_ASSERT_SV_2PVBYTE;
3042
3043     sv_utf8_downgrade(sv,0);
3044     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3045 }
3046
3047 /*
3048 =for apidoc sv_2pvutf8
3049
3050 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3051 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3052
3053 Usually accessed via the C<SvPVutf8> macro.
3054
3055 =cut
3056 */
3057
3058 char *
3059 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3060 {
3061     PERL_ARGS_ASSERT_SV_2PVUTF8;
3062
3063     sv_utf8_upgrade(sv);
3064     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3065 }
3066
3067
3068 /*
3069 =for apidoc sv_2bool
3070
3071 This macro is only used by sv_true() or its macro equivalent, and only if
3072 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3073 It calls sv_2bool_flags with the SV_GMAGIC flag.
3074
3075 =for apidoc sv_2bool_flags
3076
3077 This function is only used by sv_true() and friends,  and only if
3078 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3079 contain SV_GMAGIC, then it does an mg_get() first.
3080
3081
3082 =cut
3083 */
3084
3085 bool
3086 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3087 {
3088     dVAR;
3089
3090     PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3091
3092     if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3093
3094     if (!SvOK(sv))
3095         return 0;
3096     if (SvROK(sv)) {
3097         if (SvAMAGIC(sv)) {
3098             SV * const tmpsv = AMG_CALLun(sv,bool_);
3099             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3100                 return cBOOL(SvTRUE(tmpsv));
3101         }
3102         return SvRV(sv) != 0;
3103     }
3104     if (SvPOKp(sv)) {
3105         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3106         if (Xpvtmp &&
3107                 (*sv->sv_u.svu_pv > '0' ||
3108                 Xpvtmp->xpv_cur > 1 ||
3109                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3110             return 1;
3111         else
3112             return 0;
3113     }
3114     else {
3115         if (SvIOKp(sv))
3116             return SvIVX(sv) != 0;
3117         else {
3118             if (SvNOKp(sv))
3119                 return SvNVX(sv) != 0.0;
3120             else {
3121                 if (isGV_with_GP(sv))
3122                     return TRUE;
3123                 else
3124                     return FALSE;
3125             }
3126         }
3127     }
3128 }
3129
3130 /*
3131 =for apidoc sv_utf8_upgrade
3132
3133 Converts the PV of an SV to its UTF-8-encoded form.
3134 Forces the SV to string form if it is not already.
3135 Will C<mg_get> on C<sv> if appropriate.
3136 Always sets the SvUTF8 flag to avoid future validity checks even
3137 if the whole string is the same in UTF-8 as not.
3138 Returns the number of bytes in the converted string
3139
3140 This is not as a general purpose byte encoding to Unicode interface:
3141 use the Encode extension for that.
3142
3143 =for apidoc sv_utf8_upgrade_nomg
3144
3145 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3146
3147 =for apidoc sv_utf8_upgrade_flags
3148
3149 Converts the PV of an SV to its UTF-8-encoded form.
3150 Forces the SV to string form if it is not already.
3151 Always sets the SvUTF8 flag to avoid future validity checks even
3152 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3153 will C<mg_get> on C<sv> if appropriate, else not.
3154 Returns the number of bytes in the converted string
3155 C<sv_utf8_upgrade> and
3156 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3157
3158 This is not as a general purpose byte encoding to Unicode interface:
3159 use the Encode extension for that.
3160
3161 =cut
3162
3163 The grow version is currently not externally documented.  It adds a parameter,
3164 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3165 have free after it upon return.  This allows the caller to reserve extra space
3166 that it intends to fill, to avoid extra grows.
3167
3168 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3169 which can be used to tell this function to not first check to see if there are
3170 any characters that are different in UTF-8 (variant characters) which would
3171 force it to allocate a new string to sv, but to assume there are.  Typically
3172 this flag is used by a routine that has already parsed the string to find that
3173 there are such characters, and passes this information on so that the work
3174 doesn't have to be repeated.
3175
3176 (One might think that the calling routine could pass in the position of the
3177 first such variant, so it wouldn't have to be found again.  But that is not the
3178 case, because typically when the caller is likely to use this flag, it won't be
3179 calling this routine unless it finds something that won't fit into a byte.
3180 Otherwise it tries to not upgrade and just use bytes.  But some things that
3181 do fit into a byte are variants in utf8, and the caller may not have been
3182 keeping track of these.)
3183
3184 If the routine itself changes the string, it adds a trailing NUL.  Such a NUL
3185 isn't guaranteed due to having other routines do the work in some input cases,
3186 or if the input is already flagged as being in utf8.
3187
3188 The speed of this could perhaps be improved for many cases if someone wanted to
3189 write a fast function that counts the number of variant characters in a string,
3190 especially if it could return the position of the first one.
3191
3192 */
3193
3194 STRLEN
3195 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3196 {
3197     dVAR;
3198
3199     PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3200
3201     if (sv == &PL_sv_undef)
3202         return 0;
3203     if (!SvPOK(sv)) {
3204         STRLEN len = 0;
3205         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3206             (void) sv_2pv_flags(sv,&len, flags);
3207             if (SvUTF8(sv)) {
3208                 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3209                 return len;
3210             }
3211         } else {
3212             (void) SvPV_force(sv,len);
3213         }
3214     }
3215
3216     if (SvUTF8(sv)) {
3217         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3218         return SvCUR(sv);
3219     }
3220
3221     if (SvIsCOW(sv)) {
3222         sv_force_normal_flags(sv, 0);
3223     }
3224
3225     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3226         sv_recode_to_utf8(sv, PL_encoding);
3227         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3228         return SvCUR(sv);
3229     }
3230
3231     if (SvCUR(sv) == 0) {
3232         if (extra) SvGROW(sv, extra);
3233     } else { /* Assume Latin-1/EBCDIC */
3234         /* This function could be much more efficient if we
3235          * had a FLAG in SVs to signal if there are any variant
3236          * chars in the PV.  Given that there isn't such a flag
3237          * make the loop as fast as possible (although there are certainly ways
3238          * to speed this up, eg. through vectorization) */
3239         U8 * s = (U8 *) SvPVX_const(sv);
3240         U8 * e = (U8 *) SvEND(sv);
3241         U8 *t = s;
3242         STRLEN two_byte_count = 0;
3243         
3244         if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3245
3246         /* See if really will need to convert to utf8.  We mustn't rely on our
3247          * incoming SV being well formed and having a trailing '\0', as certain
3248          * code in pp_formline can send us partially built SVs. */
3249
3250         while (t < e) {
3251             const U8 ch = *t++;
3252             if (NATIVE_IS_INVARIANT(ch)) continue;
3253
3254             t--;    /* t already incremented; re-point to first variant */
3255             two_byte_count = 1;
3256             goto must_be_utf8;
3257         }
3258
3259         /* utf8 conversion not needed because all are invariants.  Mark as
3260          * UTF-8 even if no variant - saves scanning loop */
3261         SvUTF8_on(sv);
3262         return SvCUR(sv);
3263
3264 must_be_utf8:
3265
3266         /* Here, the string should be converted to utf8, either because of an
3267          * input flag (two_byte_count = 0), or because a character that
3268          * requires 2 bytes was found (two_byte_count = 1).  t points either to
3269          * the beginning of the string (if we didn't examine anything), or to
3270          * the first variant.  In either case, everything from s to t - 1 will
3271          * occupy only 1 byte each on output.
3272          *
3273          * There are two main ways to convert.  One is to create a new string
3274          * and go through the input starting from the beginning, appending each
3275          * converted value onto the new string as we go along.  It's probably
3276          * best to allocate enough space in the string for the worst possible
3277          * case rather than possibly running out of space and having to
3278          * reallocate and then copy what we've done so far.  Since everything
3279          * from s to t - 1 is invariant, the destination can be initialized
3280          * with these using a fast memory copy
3281          *
3282          * The other way is to figure out exactly how big the string should be
3283          * by parsing the entire input.  Then you don't have to make it big
3284          * enough to handle the worst possible case, and more importantly, if
3285          * the string you already have is large enough, you don't have to
3286          * allocate a new string, you can copy the last character in the input
3287          * string to the final position(s) that will be occupied by the
3288          * converted string and go backwards, stopping at t, since everything
3289          * before that is invariant.
3290          *
3291          * There are advantages and disadvantages to each method.
3292          *
3293          * In the first method, we can allocate a new string, do the memory
3294          * copy from the s to t - 1, and then proceed through the rest of the
3295          * string byte-by-byte.
3296          *
3297          * In the second method, we proceed through the rest of the input
3298          * string just calculating how big the converted string will be.  Then
3299          * there are two cases:
3300          *  1)  if the string has enough extra space to handle the converted
3301          *      value.  We go backwards through the string, converting until we
3302          *      get to the position we are at now, and then stop.  If this
3303          *      position is far enough along in the string, this method is
3304          *      faster than the other method.  If the memory copy were the same
3305          *      speed as the byte-by-byte loop, that position would be about
3306          *      half-way, as at the half-way mark, parsing to the end and back
3307          *      is one complete string's parse, the same amount as starting
3308          *      over and going all the way through.  Actually, it would be
3309          *      somewhat less than half-way, as it's faster to just count bytes
3310          *      than to also copy, and we don't have the overhead of allocating
3311          *      a new string, changing the scalar to use it, and freeing the
3312          *      existing one.  But if the memory copy is fast, the break-even
3313          *      point is somewhere after half way.  The counting loop could be
3314          *      sped up by vectorization, etc, to move the break-even point
3315          *      further towards the beginning.
3316          *  2)  if the string doesn't have enough space to handle the converted
3317          *      value.  A new string will have to be allocated, and one might
3318          *      as well, given that, start from the beginning doing the first
3319          *      method.  We've spent extra time parsing the string and in
3320          *      exchange all we've gotten is that we know precisely how big to
3321          *      make the new one.  Perl is more optimized for time than space,
3322          *      so this case is a loser.
3323          * So what I've decided to do is not use the 2nd method unless it is
3324          * guaranteed that a new string won't have to be allocated, assuming
3325          * the worst case.  I also decided not to put any more conditions on it
3326          * than this, for now.  It seems likely that, since the worst case is
3327          * twice as big as the unknown portion of the string (plus 1), we won't
3328          * be guaranteed enough space, causing us to go to the first method,
3329          * unless the string is short, or the first variant character is near
3330          * the end of it.  In either of these cases, it seems best to use the
3331          * 2nd method.  The only circumstance I can think of where this would
3332          * be really slower is if the string had once had much more data in it
3333          * than it does now, but there is still a substantial amount in it  */
3334
3335         {
3336             STRLEN invariant_head = t - s;
3337             STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3338             if (SvLEN(sv) < size) {
3339
3340                 /* Here, have decided to allocate a new string */
3341
3342                 U8 *dst;
3343                 U8 *d;
3344
3345                 Newx(dst, size, U8);
3346
3347                 /* If no known invariants at the beginning of the input string,
3348                  * set so starts from there.  Otherwise, can use memory copy to
3349                  * get up to where we are now, and then start from here */
3350
3351                 if (invariant_head <= 0) {
3352                     d = dst;
3353                 } else {
3354                     Copy(s, dst, invariant_head, char);
3355                     d = dst + invariant_head;
3356                 }
3357
3358                 while (t < e) {
3359                     const UV uv = NATIVE8_TO_UNI(*t++);
3360                     if (UNI_IS_INVARIANT(uv))
3361                         *d++ = (U8)UNI_TO_NATIVE(uv);
3362                     else {
3363                         *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3364                         *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3365                     }
3366                 }
3367                 *d = '\0';
3368                 SvPV_free(sv); /* No longer using pre-existing string */
3369                 SvPV_set(sv, (char*)dst);
3370                 SvCUR_set(sv, d - dst);
3371                 SvLEN_set(sv, size);
3372             } else {
3373
3374                 /* Here, have decided to get the exact size of the string.
3375                  * Currently this happens only when we know that there is
3376                  * guaranteed enough space to fit the converted string, so
3377                  * don't have to worry about growing.  If two_byte_count is 0,
3378                  * then t points to the first byte of the string which hasn't
3379                  * been examined yet.  Otherwise two_byte_count is 1, and t
3380                  * points to the first byte in the string that will expand to
3381                  * two.  Depending on this, start examining at t or 1 after t.
3382                  * */
3383
3384                 U8 *d = t + two_byte_count;
3385
3386
3387                 /* Count up the remaining bytes that expand to two */
3388
3389                 while (d < e) {
3390                     const U8 chr = *d++;
3391                     if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3392                 }
3393
3394                 /* The string will expand by just the number of bytes that
3395                  * occupy two positions.  But we are one afterwards because of
3396                  * the increment just above.  This is the place to put the
3397                  * trailing NUL, and to set the length before we decrement */
3398
3399                 d += two_byte_count;
3400                 SvCUR_set(sv, d - s);
3401                 *d-- = '\0';
3402
3403
3404                 /* Having decremented d, it points to the position to put the
3405                  * very last byte of the expanded string.  Go backwards through
3406                  * the string, copying and expanding as we go, stopping when we
3407                  * get to the part that is invariant the rest of the way down */
3408
3409                 e--;
3410                 while (e >= t) {
3411                     const U8 ch = NATIVE8_TO_UNI(*e--);
3412                     if (UNI_IS_INVARIANT(ch)) {
3413                         *d-- = UNI_TO_NATIVE(ch);
3414                     } else {
3415                         *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3416                         *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3417                     }
3418                 }
3419             }
3420         }
3421     }
3422
3423     /* Mark as UTF-8 even if no variant - saves scanning loop */
3424     SvUTF8_on(sv);
3425     return SvCUR(sv);
3426 }
3427
3428 /*
3429 =for apidoc sv_utf8_downgrade
3430
3431 Attempts to convert the PV of an SV from characters to bytes.
3432 If the PV contains a character that cannot fit
3433 in a byte, this conversion will fail;
3434 in this case, either returns false or, if C<fail_ok> is not
3435 true, croaks.
3436
3437 This is not as a general purpose Unicode to byte encoding interface:
3438 use the Encode extension for that.
3439
3440 =cut
3441 */
3442
3443 bool
3444 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3445 {
3446     dVAR;
3447
3448     PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3449
3450     if (SvPOKp(sv) && SvUTF8(sv)) {
3451         if (SvCUR(sv)) {
3452             U8 *s;
3453             STRLEN len;
3454
3455             if (SvIsCOW(sv)) {
3456                 sv_force_normal_flags(sv, 0);
3457             }
3458             s = (U8 *) SvPV(sv, len);
3459             if (!utf8_to_bytes(s, &len)) {
3460                 if (fail_ok)
3461                     return FALSE;
3462                 else {
3463                     if (PL_op)
3464                         Perl_croak(aTHX_ "Wide character in %s",
3465                                    OP_DESC(PL_op));
3466                     else
3467                         Perl_croak(aTHX_ "Wide character");
3468                 }
3469             }
3470             SvCUR_set(sv, len);
3471         }
3472     }
3473     SvUTF8_off(sv);
3474     return TRUE;
3475 }
3476
3477 /*
3478 =for apidoc sv_utf8_encode
3479
3480 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3481 flag off so that it looks like octets again.
3482
3483 =cut
3484 */
3485
3486 void
3487 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3488 {
3489     PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3490
3491     if (SvIsCOW(sv)) {
3492         sv_force_normal_flags(sv, 0);
3493     }
3494     if (SvREADONLY(sv)) {
3495         Perl_croak_no_modify(aTHX);
3496     }
3497     (void) sv_utf8_upgrade(sv);
3498     SvUTF8_off(sv);
3499 }
3500
3501 /*
3502 =for apidoc sv_utf8_decode
3503
3504 If the PV of the SV is an octet sequence in UTF-8
3505 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3506 so that it looks like a character. If the PV contains only single-byte
3507 characters, the C<SvUTF8> flag stays being off.
3508 Scans PV for validity and returns false if the PV is invalid UTF-8.
3509
3510 =cut
3511 */
3512
3513 bool
3514 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3515 {
3516     PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3517
3518     if (SvPOKp(sv)) {
3519         const U8 *c;
3520         const U8 *e;
3521
3522         /* The octets may have got themselves encoded - get them back as
3523          * bytes
3524          */
3525         if (!sv_utf8_downgrade(sv, TRUE))
3526             return FALSE;
3527
3528         /* it is actually just a matter of turning the utf8 flag on, but
3529          * we want to make sure everything inside is valid utf8 first.
3530          */
3531         c = (const U8 *) SvPVX_const(sv);
3532         if (!is_utf8_string(c, SvCUR(sv)+1))
3533             return FALSE;
3534         e = (const U8 *) SvEND(sv);
3535         while (c < e) {
3536             const U8 ch = *c++;
3537             if (!UTF8_IS_INVARIANT(ch)) {
3538                 SvUTF8_on(sv);
3539                 break;
3540             }
3541         }
3542     }
3543     return TRUE;
3544 }
3545
3546 /*
3547 =for apidoc sv_setsv
3548
3549 Copies the contents of the source SV C<ssv> into the destination SV
3550 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3551 function if the source SV needs to be reused. Does not handle 'set' magic.
3552 Loosely speaking, it performs a copy-by-value, obliterating any previous
3553 content of the destination.
3554
3555 You probably want to use one of the assortment of wrappers, such as
3556 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3557 C<SvSetMagicSV_nosteal>.
3558
3559 =for apidoc sv_setsv_flags
3560
3561 Copies the contents of the source SV C<ssv> into the destination SV
3562 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3563 function if the source SV needs to be reused. Does not handle 'set' magic.
3564 Loosely speaking, it performs a copy-by-value, obliterating any previous
3565 content of the destination.
3566 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3567 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3568 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3569 and C<sv_setsv_nomg> are implemented in terms of this function.
3570
3571 You probably want to use one of the assortment of wrappers, such as
3572 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3573 C<SvSetMagicSV_nosteal>.
3574
3575 This is the primary function for copying scalars, and most other
3576 copy-ish functions and macros use this underneath.
3577
3578 =cut
3579 */
3580
3581 static void
3582 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3583 {
3584     I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3585     HV *old_stash = NULL;
3586
3587     PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3588
3589     if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3590         const char * const name = GvNAME(sstr);
3591         const STRLEN len = GvNAMELEN(sstr);
3592         {
3593             if (dtype >= SVt_PV) {
3594                 SvPV_free(dstr);
3595                 SvPV_set(dstr, 0);
3596                 SvLEN_set(dstr, 0);
3597                 SvCUR_set(dstr, 0);
3598             }
3599             SvUPGRADE(dstr, SVt_PVGV);
3600             (void)SvOK_off(dstr);
3601             /* FIXME - why are we doing this, then turning it off and on again
3602                below?  */
3603             isGV_with_GP_on(dstr);
3604         }
3605         GvSTASH(dstr) = GvSTASH(sstr);
3606         if (GvSTASH(dstr))
3607             Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3608         gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3609         SvFAKE_on(dstr);        /* can coerce to non-glob */
3610     }
3611
3612     if(GvGP(MUTABLE_GV(sstr))) {
3613         /* If source has method cache entry, clear it */
3614         if(GvCVGEN(sstr)) {
3615             SvREFCNT_dec(GvCV(sstr));
3616             GvCV(sstr) = NULL;
3617             GvCVGEN(sstr) = 0;
3618         }
3619         /* If source has a real method, then a method is
3620            going to change */
3621         else if(GvCV((const GV *)sstr)) {
3622             mro_changes = 1;
3623         }
3624     }
3625
3626     /* If dest already had a real method, that's a change as well */
3627     if(!mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)) {
3628         mro_changes = 1;
3629     }
3630
3631     /* We don’t need to check the name of the destination if it was not a
3632        glob to begin with. */
3633     if(dtype == SVt_PVGV) {
3634         const char * const name = GvNAME((const GV *)dstr);
3635         if(strEQ(name,"ISA"))
3636             mro_changes = 2;
3637         else {
3638             const STRLEN len = GvNAMELEN(dstr);
3639             if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
3640                 mro_changes = 3;
3641
3642                 /* Set aside the old stash, so we can reset isa caches on
3643                    its subclasses. */
3644                 old_stash = GvHV(dstr);
3645             }
3646         }
3647     }
3648
3649     gp_free(MUTABLE_GV(dstr));
3650     isGV_with_GP_off(dstr);
3651     (void)SvOK_off(dstr);
3652     isGV_with_GP_on(dstr);
3653     GvINTRO_off(dstr);          /* one-shot flag */
3654     GvGP(dstr) = gp_ref(GvGP(sstr));
3655     if (SvTAINTED(sstr))
3656         SvTAINT(dstr);
3657     if (GvIMPORTED(dstr) != GVf_IMPORTED
3658         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3659         {
3660             GvIMPORTED_on(dstr);
3661         }
3662     GvMULTI_on(dstr);
3663     if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3664     else if(mro_changes == 3) {
3665         const HV * const stash = GvHV(dstr);
3666         if(stash && HvNAME(stash)) mro_package_moved(stash);
3667         if(old_stash && HvNAME(old_stash)) mro_package_moved(old_stash);
3668     }
3669     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3670     return;
3671 }
3672
3673 static void
3674 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3675 {
3676     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3677     SV *dref = NULL;
3678     const int intro = GvINTRO(dstr);
3679     SV **location;
3680     U8 import_flag = 0;
3681     const U32 stype = SvTYPE(sref);
3682
3683     PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3684
3685     if (intro) {
3686         GvINTRO_off(dstr);      /* one-shot flag */
3687         GvLINE(dstr) = CopLINE(PL_curcop);
3688         GvEGV(dstr) = MUTABLE_GV(dstr);
3689     }
3690     GvMULTI_on(dstr);
3691     switch (stype) {
3692     case SVt_PVCV:
3693         location = (SV **) &GvCV(dstr);
3694         import_flag = GVf_IMPORTED_CV;
3695         goto common;
3696     case SVt_PVHV:
3697         location = (SV **) &GvHV(dstr);
3698         import_flag = GVf_IMPORTED_HV;
3699         goto common;
3700     case SVt_PVAV:
3701         location = (SV **) &GvAV(dstr);
3702         import_flag = GVf_IMPORTED_AV;
3703         goto common;
3704     case SVt_PVIO:
3705         location = (SV **) &GvIOp(dstr);
3706         goto common;
3707     case SVt_PVFM:
3708         location = (SV **) &GvFORM(dstr);
3709         goto common;
3710     default:
3711         location = &GvSV(dstr);
3712         import_flag = GVf_IMPORTED_SV;
3713     common:
3714         if (intro) {
3715             if (stype == SVt_PVCV) {
3716                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3717                 if (GvCVGEN(dstr)) {
3718                     SvREFCNT_dec(GvCV(dstr));
3719                     GvCV(dstr) = NULL;
3720                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3721                 }
3722             }
3723             SAVEGENERICSV(*location);
3724         }
3725         else
3726             dref = *location;
3727         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3728             CV* const cv = MUTABLE_CV(*location);
3729             if (cv) {
3730                 if (!GvCVGEN((const GV *)dstr) &&
3731                     (CvROOT(cv) || CvXSUB(cv)))
3732                     {
3733                         /* Redefining a sub - warning is mandatory if
3734                            it was a const and its value changed. */
3735                         if (CvCONST(cv) && CvCONST((const CV *)sref)
3736                             && cv_const_sv(cv)
3737                             == cv_const_sv((const CV *)sref)) {
3738                             NOOP;
3739                             /* They are 2 constant subroutines generated from
3740                                the same constant. This probably means that
3741                                they are really the "same" proxy subroutine
3742                                instantiated in 2 places. Most likely this is
3743                                when a constant is exported twice.  Don't warn.
3744                             */
3745                         }
3746                         else if (ckWARN(WARN_REDEFINE)
3747                                  || (CvCONST(cv)
3748                                      && (!CvCONST((const CV *)sref)
3749                                          || sv_cmp(cv_const_sv(cv),
3750                                                    cv_const_sv((const CV *)
3751                                                                sref))))) {
3752                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3753                                         (const char *)
3754                                         (CvCONST(cv)
3755                                          ? "Constant subroutine %s::%s redefined"
3756                                          : "Subroutine %s::%s redefined"),
3757                                         HvNAME_get(GvSTASH((const GV *)dstr)),
3758                                         GvENAME(MUTABLE_GV(dstr)));
3759                         }
3760                     }
3761                 if (!intro)
3762                     cv_ckproto_len(cv, (const GV *)dstr,
3763                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3764                                    SvPOK(sref) ? SvCUR(sref) : 0);
3765             }
3766             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3767             GvASSUMECV_on(dstr);
3768             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3769         }
3770         *location = sref;
3771         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3772             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3773             GvFLAGS(dstr) |= import_flag;
3774         }
3775         if (stype == SVt_PVHV) {
3776             const char * const name = GvNAME((GV*)dstr);
3777             const STRLEN len = GvNAMELEN(dstr);
3778             if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
3779                 if(HvNAME(dref)) mro_package_moved((HV *)dref);
3780                 if(HvNAME(sref)) mro_package_moved((HV *)sref);
3781             }
3782         }
3783         else if (stype == SVt_PVAV && strEQ(GvNAME((GV*)dstr), "ISA")) {
3784             sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3785             mro_isa_changed_in(GvSTASH(dstr));
3786         }
3787         break;
3788     }
3789     SvREFCNT_dec(dref);
3790     if (SvTAINTED(sstr))
3791         SvTAINT(dstr);
3792     return;
3793 }
3794
3795 void
3796 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3797 {
3798     dVAR;
3799     register U32 sflags;
3800     register int dtype;
3801     register svtype stype;
3802
3803     PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3804
3805     if (sstr == dstr)
3806         return;
3807
3808     if (SvIS_FREED(dstr)) {
3809         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3810                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3811     }
3812     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3813     if (!sstr)
3814         sstr = &PL_sv_undef;
3815     if (SvIS_FREED(sstr)) {
3816         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3817                    (void*)sstr, (void*)dstr);
3818     }
3819     stype = SvTYPE(sstr);
3820     dtype = SvTYPE(dstr);
3821
3822     (void)SvAMAGIC_off(dstr);
3823     if ( SvVOK(dstr) )
3824     {
3825         /* need to nuke the magic */
3826         mg_free(dstr);
3827     }
3828
3829     /* There's a lot of redundancy below but we're going for speed here */
3830
3831     switch (stype) {
3832     case SVt_NULL:
3833       undef_sstr:
3834         if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3835             (void)SvOK_off(dstr);
3836             return;
3837         }
3838         break;
3839     case SVt_IV:
3840         if (SvIOK(sstr)) {
3841             switch (dtype) {
3842             case SVt_NULL:
3843                 sv_upgrade(dstr, SVt_IV);
3844                 break;
3845             case SVt_NV:
3846             case SVt_PV:
3847                 sv_upgrade(dstr, SVt_PVIV);
3848                 break;
3849             case SVt_PVGV:
3850             case SVt_PVLV:
3851                 goto end_of_first_switch;
3852             }
3853             (void)SvIOK_only(dstr);
3854             SvIV_set(dstr,  SvIVX(sstr));
3855             if (SvIsUV(sstr))
3856                 SvIsUV_on(dstr);
3857             /* SvTAINTED can only be true if the SV has taint magic, which in
3858                turn means that the SV type is PVMG (or greater). This is the
3859                case statement for SVt_IV, so this cannot be true (whatever gcov
3860                may say).  */
3861             assert(!SvTAINTED(sstr));
3862             return;
3863         }
3864         if (!SvROK(sstr))
3865             goto undef_sstr;
3866         if (dtype < SVt_PV && dtype != SVt_IV)
3867             sv_upgrade(dstr, SVt_IV);
3868         break;
3869
3870     case SVt_NV:
3871         if (SvNOK(sstr)) {
3872             switch (dtype) {
3873             case SVt_NULL:
3874             case SVt_IV:
3875                 sv_upgrade(dstr, SVt_NV);
3876                 break;
3877             case SVt_PV:
3878             case SVt_PVIV:
3879                 sv_upgrade(dstr, SVt_PVNV);
3880                 break;
3881             case SVt_PVGV:
3882             case SVt_PVLV:
3883                 goto end_of_first_switch;
3884             }
3885             SvNV_set(dstr, SvNVX(sstr));
3886             (void)SvNOK_only(dstr);
3887             /* SvTAINTED can only be true if the SV has taint magic, which in
3888                turn means that the SV type is PVMG (or greater). This is the
3889                case statement for SVt_NV, so this cannot be true (whatever gcov
3890                may say).  */
3891             assert(!SvTAINTED(sstr));
3892             return;
3893         }
3894         goto undef_sstr;
3895
3896     case SVt_PVFM:
3897 #ifdef PERL_OLD_COPY_ON_WRITE
3898         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3899             if (dtype < SVt_PVIV)
3900                 sv_upgrade(dstr, SVt_PVIV);
3901             break;
3902         }
3903         /* Fall through */
3904 #endif
3905     case SVt_PV:
3906         if (dtype < SVt_PV)
3907             sv_upgrade(dstr, SVt_PV);
3908         break;
3909     case SVt_PVIV:
3910         if (dtype < SVt_PVIV)
3911             sv_upgrade(dstr, SVt_PVIV);
3912         break;
3913     case SVt_PVNV:
3914         if (dtype < SVt_PVNV)
3915             sv_upgrade(dstr, SVt_PVNV);
3916         break;
3917     default:
3918         {
3919         const char * const type = sv_reftype(sstr,0);
3920         if (PL_op)
3921             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
3922         else
3923             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3924         }
3925         break;
3926
3927     case SVt_REGEXP:
3928         if (dtype < SVt_REGEXP)
3929             sv_upgrade(dstr, SVt_REGEXP);
3930         break;
3931
3932         /* case SVt_BIND: */
3933     case SVt_PVLV:
3934     case SVt_PVGV:
3935         if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
3936             glob_assign_glob(dstr, sstr, dtype);
3937             return;
3938         }
3939         /* SvVALID means that this PVGV is playing at being an FBM.  */
3940         /*FALLTHROUGH*/
3941
3942     case SVt_PVMG:
3943         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3944             mg_get(sstr);
3945             if (SvTYPE(sstr) != stype)
3946                 stype = SvTYPE(sstr);
3947             if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
3948                     glob_assign_glob(dstr, sstr, dtype);
3949                     return;
3950             }
3951         }
3952         if (stype == SVt_PVLV)
3953             SvUPGRADE(dstr, SVt_PVNV);
3954         else
3955             SvUPGRADE(dstr, (svtype)stype);
3956     }
3957  end_of_first_switch:
3958
3959     /* dstr may have been upgraded.  */
3960     dtype = SvTYPE(dstr);
3961     sflags = SvFLAGS(sstr);
3962
3963     if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3964         /* Assigning to a subroutine sets the prototype.  */
3965         if (SvOK(sstr)) {
3966             STRLEN len;
3967             const char *const ptr = SvPV_const(sstr, len);
3968
3969             SvGROW(dstr, len + 1);
3970             Copy(ptr, SvPVX(dstr), len + 1, char);
3971             SvCUR_set(dstr, len);
3972             SvPOK_only(dstr);
3973             SvFLAGS(dstr) |= sflags & SVf_UTF8;
3974         } else {
3975             SvOK_off(dstr);
3976         }
3977     } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3978         const char * const type = sv_reftype(dstr,0);
3979         if (PL_op)
3980             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
3981         else
3982             Perl_croak(aTHX_ "Cannot copy to %s", type);
3983     } else if (sflags & SVf_ROK) {
3984         if (isGV_with_GP(dstr)
3985             && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
3986             sstr = SvRV(sstr);
3987             if (sstr == dstr) {
3988                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3989                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3990                 {
3991                     GvIMPORTED_on(dstr);
3992                 }
3993                 GvMULTI_on(dstr);
3994                 return;
3995             }
3996             glob_assign_glob(dstr, sstr, dtype);
3997             return;
3998         }
3999
4000         if (dtype >= SVt_PV) {
4001             if (isGV_with_GP(dstr)) {
4002                 glob_assign_ref(dstr, sstr);
4003                 return;
4004             }
4005             if (SvPVX_const(dstr)) {
4006                 SvPV_free(dstr);
4007                 SvLEN_set(dstr, 0);
4008                 SvCUR_set(dstr, 0);
4009             }
4010         }
4011         (void)SvOK_off(dstr);
4012         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4013         SvFLAGS(dstr) |= sflags & SVf_ROK;
4014         assert(!(sflags & SVp_NOK));
4015         assert(!(sflags & SVp_IOK));
4016         assert(!(sflags & SVf_NOK));
4017         assert(!(sflags & SVf_IOK));
4018     }
4019     else if (isGV_with_GP(dstr)) {
4020         if (!(sflags & SVf_OK)) {
4021             Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4022                            "Undefined value assigned to typeglob");
4023         }
4024         else {
4025             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4026             if (dstr != (const SV *)gv) {
4027                 const char * const name = GvNAME((const GV *)dstr);
4028                 const STRLEN len = GvNAMELEN(dstr);
4029                 HV *old_stash = NULL;
4030                 bool reset_isa = FALSE;
4031                 if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
4032                     /* Set aside the old stash, so we can reset isa caches
4033                        on its subclasses. */
4034                     old_stash = GvHV(dstr);
4035                     reset_isa = TRUE;
4036                 }
4037
4038                 if (GvGP(dstr))
4039                     gp_free(MUTABLE_GV(dstr));
4040                 GvGP(dstr) = gp_ref(GvGP(gv));
4041
4042                 if (reset_isa) {
4043                     const HV * const stash = GvHV(dstr);
4044                     if(stash && HvNAME(stash)) mro_package_moved(stash);
4045                     if(old_stash && HvNAME(old_stash))
4046                         mro_package_moved(old_stash);
4047                 }
4048             }
4049         }
4050     }
4051     else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4052         reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4053     }
4054     else if (sflags & SVp_POK) {
4055         bool isSwipe = 0;
4056
4057         /*
4058          * Check to see if we can just swipe the string.  If so, it's a
4059          * possible small lose on short strings, but a big win on long ones.
4060          * It might even be a win on short strings if SvPVX_const(dstr)
4061          * has to be allocated and SvPVX_const(sstr) has to be freed.
4062          * Likewise if we can set up COW rather than doing an actual copy, we
4063          * drop to the else clause, as the swipe code and the COW setup code
4064          * have much in common.
4065          */
4066
4067         /* Whichever path we take through the next code, we want this true,
4068            and doing it now facilitates the COW check.  */
4069         (void)SvPOK_only(dstr);
4070
4071         if (
4072             /* If we're already COW then this clause is not true, and if COW
4073                is allowed then we drop down to the else and make dest COW 
4074                with us.  If caller hasn't said that we're allowed to COW
4075                shared hash keys then we don't do the COW setup, even if the
4076                source scalar is a shared hash key scalar.  */
4077             (((flags & SV_COW_SHARED_HASH_KEYS)
4078                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4079                : 1 /* If making a COW copy is forbidden then the behaviour we
4080                        desire is as if the source SV isn't actually already
4081                        COW, even if it is.  So we act as if the source flags
4082                        are not COW, rather than actually testing them.  */
4083               )
4084 #ifndef PERL_OLD_COPY_ON_WRITE
4085              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4086                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4087                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4088                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4089                 but in turn, it's somewhat dead code, never expected to go
4090                 live, but more kept as a placeholder on how to do it better
4091                 in a newer implementation.  */
4092              /* If we are COW and dstr is a suitable target then we drop down
4093                 into the else and make dest a COW of us.  */
4094              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4095 #endif
4096              )
4097             &&
4098             !(isSwipe =
4099                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4100                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4101                  (!(flags & SV_NOSTEAL)) &&
4102                                         /* and we're allowed to steal temps */
4103                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4104                  SvLEN(sstr))             /* and really is a string */
4105 #ifdef PERL_OLD_COPY_ON_WRITE
4106             && ((flags & SV_COW_SHARED_HASH_KEYS)
4107                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4108                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4109                      && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4110                 : 1)
4111 #endif
4112             ) {
4113             /* Failed the swipe test, and it's not a shared hash key either.
4114                Have to copy the string.  */
4115             STRLEN len = SvCUR(sstr);
4116             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4117             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4118             SvCUR_set(dstr, len);
4119             *SvEND(dstr) = '\0';
4120         } else {
4121             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4122                be true in here.  */
4123             /* Either it's a shared hash key, or it's suitable for
4124                copy-on-write or we can swipe the string.  */
4125             if (DEBUG_C_TEST) {
4126                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4127                 sv_dump(sstr);
4128                 sv_dump(dstr);
4129             }
4130 #ifdef PERL_OLD_COPY_ON_WRITE
4131             if (!isSwipe) {
4132                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4133                     != (SVf_FAKE | SVf_READONLY)) {
4134                     SvREADONLY_on(sstr);
4135                     SvFAKE_on(sstr);
4136                     /* Make the source SV into a loop of 1.
4137                        (about to become 2) */
4138                     SV_COW_NEXT_SV_SET(sstr, sstr);
4139                 }
4140             }
4141 #endif
4142             /* Initial code is common.  */
4143             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
4144                 SvPV_free(dstr);
4145             }
4146
4147             if (!isSwipe) {
4148                 /* making another shared SV.  */
4149                 STRLEN cur = SvCUR(sstr);
4150                 STRLEN len = SvLEN(sstr);
4151 #ifdef PERL_OLD_COPY_ON_WRITE
4152                 if (len) {
4153                     assert (SvTYPE(dstr) >= SVt_PVIV);
4154                     /* SvIsCOW_normal */
4155                     /* splice us in between source and next-after-source.  */
4156                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4157                     SV_COW_NEXT_SV_SET(sstr, dstr);
4158                     SvPV_set(dstr, SvPVX_mutable(sstr));
4159                 } else
4160 #endif
4161                 {
4162                     /* SvIsCOW_shared_hash */
4163                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4164                                           "Copy on write: Sharing hash\n"));
4165
4166                     assert (SvTYPE(dstr) >= SVt_PV);
4167                     SvPV_set(dstr,
4168                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4169                 }
4170                 SvLEN_set(dstr, len);
4171                 SvCUR_set(dstr, cur);
4172                 SvREADONLY_on(dstr);
4173                 SvFAKE_on(dstr);
4174             }
4175             else
4176                 {       /* Passes the swipe test.  */
4177                 SvPV_set(dstr, SvPVX_mutable(sstr));
4178                 SvLEN_set(dstr, SvLEN(sstr));
4179                 SvCUR_set(dstr, SvCUR(sstr));
4180
4181                 SvTEMP_off(dstr);
4182                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4183                 SvPV_set(sstr, NULL);
4184                 SvLEN_set(sstr, 0);
4185                 SvCUR_set(sstr, 0);
4186                 SvTEMP_off(sstr);
4187             }
4188         }
4189         if (sflags & SVp_NOK) {
4190             SvNV_set(dstr, SvNVX(sstr));
4191         }
4192         if (sflags & SVp_IOK) {
4193             SvIV_set(dstr, SvIVX(sstr));
4194             /* Must do this otherwise some other overloaded use of 0x80000000
4195                gets confused. I guess SVpbm_VALID */
4196             if (sflags & SVf_IVisUV)
4197                 SvIsUV_on(dstr);
4198         }
4199         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4200         {
4201             const MAGIC * const smg = SvVSTRING_mg(sstr);
4202             if (smg) {
4203                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4204                          smg->mg_ptr, smg->mg_len);
4205                 SvRMAGICAL_on(dstr);
4206             }
4207         }
4208     }
4209     else if (sflags & (SVp_IOK|SVp_NOK)) {
4210         (void)SvOK_off(dstr);
4211         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4212         if (sflags & SVp_IOK) {
4213             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4214             SvIV_set(dstr, SvIVX(sstr));
4215         }
4216         if (sflags & SVp_NOK) {
4217             SvNV_set(dstr, SvNVX(sstr));
4218         }
4219     }
4220     else {
4221         if (isGV_with_GP(sstr)) {
4222             /* This stringification rule for globs is spread in 3 places.
4223                This feels bad. FIXME.  */
4224             const U32 wasfake = sflags & SVf_FAKE;
4225
4226             /* FAKE globs can get coerced, so need to turn this off
4227                temporarily if it is on.  */
4228             SvFAKE_off(sstr);
4229             gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4230             SvFLAGS(sstr) |= wasfake;
4231         }
4232         else
4233             (void)SvOK_off(dstr);
4234     }
4235     if (SvTAINTED(sstr))
4236         SvTAINT(dstr);
4237 }
4238
4239 /*
4240 =for apidoc sv_setsv_mg
4241
4242 Like C<sv_setsv>, but also handles 'set' magic.
4243
4244 =cut
4245 */
4246
4247 void
4248 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4249 {
4250     PERL_ARGS_ASSERT_SV_SETSV_MG;
4251
4252     sv_setsv(dstr,sstr);
4253     SvSETMAGIC(dstr);
4254 }
4255
4256 #ifdef PERL_OLD_COPY_ON_WRITE
4257 SV *
4258 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4259 {
4260     STRLEN cur = SvCUR(sstr);
4261     STRLEN len = SvLEN(sstr);
4262     register char *new_pv;
4263
4264     PERL_ARGS_ASSERT_SV_SETSV_COW;
4265
4266     if (DEBUG_C_TEST) {
4267         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4268                       (void*)sstr, (void*)dstr);
4269         sv_dump(sstr);
4270         if (dstr)
4271                     sv_dump(dstr);
4272     }
4273
4274     if (dstr) {
4275         if (SvTHINKFIRST(dstr))
4276             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4277         else if (SvPVX_const(dstr))
4278             Safefree(SvPVX_const(dstr));
4279     }
4280     else
4281         new_SV(dstr);
4282     SvUPGRADE(dstr, SVt_PVIV);
4283
4284     assert (SvPOK(sstr));
4285     assert (SvPOKp(sstr));
4286     assert (!SvIOK(sstr));
4287     assert (!SvIOKp(sstr));
4288     assert (!SvNOK(sstr));
4289     assert (!SvNOKp(sstr));
4290
4291     if (SvIsCOW(sstr)) {
4292
4293         if (SvLEN(sstr) == 0) {
4294             /* source is a COW shared hash key.  */
4295             DEBUG_C(PerlIO_printf(Perl_debug_log,
4296                                   "Fast copy on write: Sharing hash\n"));
4297             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4298             goto common_exit;
4299         }
4300         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4301     } else {
4302         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4303         SvUPGRADE(sstr, SVt_PVIV);
4304         SvREADONLY_on(sstr);
4305         SvFAKE_on(sstr);
4306         DEBUG_C(PerlIO_printf(Perl_debug_log,
4307                               "Fast copy on write: Converting sstr to COW\n"));
4308         SV_COW_NEXT_SV_SET(dstr, sstr);
4309     }
4310     SV_COW_NEXT_SV_SET(sstr, dstr);
4311     new_pv = SvPVX_mutable(sstr);
4312
4313   common_exit:
4314     SvPV_set(dstr, new_pv);
4315     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4316     if (SvUTF8(sstr))
4317         SvUTF8_on(dstr);
4318     SvLEN_set(dstr, len);
4319     SvCUR_set(dstr, cur);
4320     if (DEBUG_C_TEST) {
4321         sv_dump(dstr);
4322     }
4323     return dstr;
4324 }
4325 #endif
4326
4327 /*
4328 =for apidoc sv_setpvn
4329
4330 Copies a string into an SV.  The C<len> parameter indicates the number of
4331 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4332 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4333
4334 =cut
4335 */
4336
4337 void
4338 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4339 {
4340     dVAR;
4341     register char *dptr;
4342
4343     PERL_ARGS_ASSERT_SV_SETPVN;
4344
4345     SV_CHECK_THINKFIRST_COW_DROP(sv);
4346     if (!ptr) {
4347         (void)SvOK_off(sv);
4348         return;
4349     }
4350     else {
4351         /* len is STRLEN which is unsigned, need to copy to signed */
4352         const IV iv = len;
4353         if (iv < 0)
4354             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4355     }
4356     SvUPGRADE(sv, SVt_PV);
4357
4358     dptr = SvGROW(sv, len + 1);
4359     Move(ptr,dptr,len,char);
4360     dptr[len] = '\0';
4361     SvCUR_set(sv, len);
4362     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4363     SvTAINT(sv);
4364 }
4365
4366 /*
4367 =for apidoc sv_setpvn_mg
4368
4369 Like C<sv_setpvn>, but also handles 'set' magic.
4370
4371 =cut
4372 */
4373
4374 void
4375 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4376 {
4377     PERL_ARGS_ASSERT_SV_SETPVN_MG;
4378
4379     sv_setpvn(sv,ptr,len);
4380     SvSETMAGIC(sv);
4381 }
4382
4383 /*
4384 =for apidoc sv_setpv
4385
4386 Copies a string into an SV.  The string must be null-terminated.  Does not
4387 handle 'set' magic.  See C<sv_setpv_mg>.
4388
4389 =cut
4390 */
4391
4392 void
4393 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4394 {
4395     dVAR;
4396     register STRLEN len;
4397
4398     PERL_ARGS_ASSERT_SV_SETPV;
4399
4400     SV_CHECK_THINKFIRST_COW_DROP(sv);
4401     if (!ptr) {
4402         (void)SvOK_off(sv);
4403         return;
4404     }
4405     len = strlen(ptr);
4406     SvUPGRADE(sv, SVt_PV);
4407
4408     SvGROW(sv, len + 1);
4409     Move(ptr,SvPVX(sv),len+1,char);
4410     SvCUR_set(sv, len);
4411     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4412     SvTAINT(sv);
4413 }
4414
4415 /*
4416 =for apidoc sv_setpv_mg
4417
4418 Like C<sv_setpv>, but also handles 'set' magic.
4419
4420 =cut
4421 */
4422
4423 void
4424 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4425 {
4426     PERL_ARGS_ASSERT_SV_SETPV_MG;
4427
4428     sv_setpv(sv,ptr);
4429     SvSETMAGIC(sv);
4430 }
4431
4432 /*
4433 =for apidoc sv_usepvn_flags
4434
4435 Tells an SV to use C<ptr> to find its string value.  Normally the
4436 string is stored inside the SV but sv_usepvn allows the SV to use an
4437 outside string.  The C<ptr> should point to memory that was allocated
4438 by C<malloc>.  The string length, C<len>, must be supplied.  By default
4439 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4440 so that pointer should not be freed or used by the programmer after
4441 giving it to sv_usepvn, and neither should any pointers from "behind"
4442 that pointer (e.g. ptr + 1) be used.
4443
4444 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4445 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4446 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4447 C<len>, and already meets the requirements for storing in C<SvPVX>)
4448
4449 =cut
4450 */
4451
4452 void
4453 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4454 {
4455     dVAR;
4456     STRLEN allocate;
4457
4458     PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4459
4460     SV_CHECK_THINKFIRST_COW_DROP(sv);
4461     SvUPGRADE(sv, SVt_PV);
4462     if (!ptr) {
4463         (void)SvOK_off(sv);
4464         if (flags & SV_SMAGIC)
4465             SvSETMAGIC(sv);
4466         return;
4467     }
4468     if (SvPVX_const(sv))
4469         SvPV_free(sv);
4470
4471 #ifdef DEBUGGING
4472     if (flags & SV_HAS_TRAILING_NUL)
4473         assert(ptr[len] == '\0');
4474 #endif
4475
4476     allocate = (flags & SV_HAS_TRAILING_NUL)
4477         ? len + 1 :
4478 #ifdef Perl_safesysmalloc_size
4479         len + 1;
4480 #else 
4481         PERL_STRLEN_ROUNDUP(len + 1);
4482 #endif
4483     if (flags & SV_HAS_TRAILING_NUL) {
4484         /* It's long enough - do nothing.
4485            Specfically Perl_newCONSTSUB is relying on this.  */
4486     } else {
4487 #ifdef DEBUGGING
4488         /* Force a move to shake out bugs in callers.  */
4489         char *new_ptr = (char*)safemalloc(allocate);
4490         Copy(ptr, new_ptr, len, char);
4491         PoisonFree(ptr,len,char);
4492         Safefree(ptr);
4493         ptr = new_ptr;
4494 #else
4495         ptr = (char*) saferealloc (ptr, allocate);
4496 #endif
4497     }
4498 #ifdef Perl_safesysmalloc_size
4499     SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4500 #else
4501     SvLEN_set(sv, allocate);
4502 #endif
4503     SvCUR_set(sv, len);
4504     SvPV_set(sv, ptr);
4505     if (!(flags & SV_HAS_TRAILING_NUL)) {
4506         ptr[len] = '\0';
4507     }
4508     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4509     SvTAINT(sv);
4510     if (flags & SV_SMAGIC)
4511         SvSETMAGIC(sv);
4512 }
4513
4514 #ifdef PERL_OLD_COPY_ON_WRITE
4515 /* Need to do this *after* making the SV normal, as we need the buffer
4516    pointer to remain valid until after we've copied it.  If we let go too early,
4517    another thread could invalidate it by unsharing last of the same hash key
4518    (which it can do by means other than releasing copy-on-write Svs)
4519    or by changing the other copy-on-write SVs in the loop.  */
4520 STATIC void
4521 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4522 {
4523     PERL_ARGS_ASSERT_SV_RELEASE_COW;
4524
4525     { /* this SV was SvIsCOW_normal(sv) */
4526          /* we need to find the SV pointing to us.  */
4527         SV *current = SV_COW_NEXT_SV(after);
4528
4529         if (current == sv) {
4530             /* The SV we point to points back to us (there were only two of us
4531                in the loop.)
4532                Hence other SV is no longer copy on write either.  */
4533             SvFAKE_off(after);
4534             SvREADONLY_off(after);
4535         } else {
4536             /* We need to follow the pointers around the loop.  */
4537             SV *next;
4538             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4539                 assert (next);
4540                 current = next;
4541                  /* don't loop forever if the structure is bust, and we have
4542                     a pointer into a closed loop.  */
4543                 assert (current != after);
4544                 assert (SvPVX_const(current) == pvx);
4545             }
4546             /* Make the SV before us point to the SV after us.  */
4547             SV_COW_NEXT_SV_SET(current, after);
4548         }
4549     }
4550 }
4551 #endif
4552 /*
4553 =for apidoc sv_force_normal_flags
4554
4555 Undo various types of fakery on an SV: if the PV is a shared string, make
4556 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4557 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4558 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4559 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4560 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4561 set to some other value.) In addition, the C<flags> parameter gets passed to
4562 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4563 with flags set to 0.
4564
4565 =cut
4566 */
4567
4568 void
4569 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4570 {
4571     dVAR;
4572
4573     PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4574
4575 #ifdef PERL_OLD_COPY_ON_WRITE
4576     if (SvREADONLY(sv)) {
4577         if (SvFAKE(sv)) {
4578             const char * const pvx = SvPVX_const(sv);
4579             const STRLEN len = SvLEN(sv);
4580             const STRLEN cur = SvCUR(sv);
4581             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4582                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4583                we'll fail an assertion.  */
4584             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4585
4586             if (DEBUG_C_TEST) {
4587                 PerlIO_printf(Perl_debug_log,
4588                               "Copy on write: Force normal %ld\n",
4589                               (long) flags);
4590                 sv_dump(sv);
4591             }
4592             SvFAKE_off(sv);
4593             SvREADONLY_off(sv);
4594             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4595             SvPV_set(sv, NULL);
4596             SvLEN_set(sv, 0);
4597             if (flags & SV_COW_DROP_PV) {
4598                 /* OK, so we don't need to copy our buffer.  */
4599                 SvPOK_off(sv);
4600             } else {
4601                 SvGROW(sv, cur + 1);
4602                 Move(pvx,SvPVX(sv),cur,char);
4603                 SvCUR_set(sv, cur);
4604                 *SvEND(sv) = '\0';
4605             }
4606             if (len) {
4607                 sv_release_COW(sv, pvx, next);
4608             } else {
4609                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4610             }
4611             if (DEBUG_C_TEST) {
4612                 sv_dump(sv);
4613             }
4614         }
4615         else if (IN_PERL_RUNTIME)
4616             Perl_croak_no_modify(aTHX);
4617     }
4618 #else
4619     if (SvREADONLY(sv)) {
4620         if (SvFAKE(sv)) {
4621             const char * const pvx = SvPVX_const(sv);
4622             const STRLEN len = SvCUR(sv);
4623             SvFAKE_off(sv);
4624             SvREADONLY_off(sv);
4625             SvPV_set(sv, NULL);
4626             SvLEN_set(sv, 0);
4627             SvGROW(sv, len + 1);
4628             Move(pvx,SvPVX(sv),len,char);
4629             *SvEND(sv) = '\0';
4630             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4631         }
4632         else if (IN_PERL_RUNTIME)
4633             Perl_croak_no_modify(aTHX);
4634     }
4635 #endif
4636     if (SvROK(sv))
4637         sv_unref_flags(sv, flags);
4638     else if (SvFAKE(sv) && isGV_with_GP(sv))
4639         sv_unglob(sv);
4640     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4641         /* Need to downgrade the REGEXP to a simple(r) scalar. This is analagous
4642            to sv_unglob. We only need it here, so inline it.  */
4643         const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4644         SV *const temp = newSV_type(new_type);
4645         void *const temp_p = SvANY(sv);
4646
4647         if (new_type == SVt_PVMG) {
4648             SvMAGIC_set(temp, SvMAGIC(sv));
4649             SvMAGIC_set(sv, NULL);
4650             SvSTASH_set(temp, SvSTASH(sv));
4651             SvSTASH_set(sv, NULL);
4652         }
4653         SvCUR_set(temp, SvCUR(sv));
4654         /* Remember that SvPVX is in the head, not the body. */
4655         if (SvLEN(temp)) {
4656             SvLEN_set(temp, SvLEN(sv));
4657             /* This signals "buffer is owned by someone else" in sv_clear,
4658                which is the least effort way to stop it freeing the buffer.
4659             */
4660             SvLEN_set(sv, SvLEN(sv)+1);
4661         } else {
4662             /* Their buffer is already owned by someone else. */
4663             SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4664             SvLEN_set(temp, SvCUR(sv)+1);
4665         }
4666
4667         /* Now swap the rest of the bodies. */
4668
4669         SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4670         SvFLAGS(sv) |= new_type;
4671         SvANY(sv) = SvANY(temp);
4672
4673         SvFLAGS(temp) &= ~(SVTYPEMASK);
4674         SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4675         SvANY(temp) = temp_p;
4676
4677         SvREFCNT_dec(temp);
4678     }