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