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