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