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