Update case folding and character classification in vms/vms.c.
[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 (UNLIKELY(new_type == SVt_REGEXP))
1466             sv->sv_u.svu_rx = (regexp *)new_body;
1467         else if (old_type < SVt_PV) {
1468             /* referent will be NULL unless the old type was SVt_IV emulating
1469                SVt_RV */
1470             sv->sv_u.svu_rv = referent;
1471         }
1472         break;
1473     default:
1474         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1475                    (unsigned long)new_type);
1476     }
1477
1478     /* if this is zero, this is a body-less SVt_NULL, SVt_IV/SVt_RV,
1479        and sometimes SVt_NV */
1480     if (old_type_details->body_size) {
1481 #ifdef PURIFY
1482         safefree(old_body);
1483 #else
1484         /* Note that there is an assumption that all bodies of types that
1485            can be upgraded came from arenas. Only the more complex non-
1486            upgradable types are allowed to be directly malloc()ed.  */
1487         assert(old_type_details->arena);
1488         del_body((void*)((char*)old_body + old_type_details->offset),
1489                  &PL_body_roots[old_type]);
1490 #endif
1491     }
1492 }
1493
1494 /*
1495 =for apidoc sv_backoff
1496
1497 Remove any string offset.  You should normally use the C<SvOOK_off> macro
1498 wrapper instead.
1499
1500 =cut
1501 */
1502
1503 /* prior to 5.000 stable, this function returned the new OOK-less SvFLAGS
1504    prior to 5.23.4 this function always returned 0
1505 */
1506
1507 void
1508 Perl_sv_backoff(SV *const sv)
1509 {
1510     STRLEN delta;
1511     const char * const s = SvPVX_const(sv);
1512
1513     PERL_ARGS_ASSERT_SV_BACKOFF;
1514
1515     assert(SvOOK(sv));
1516     assert(SvTYPE(sv) != SVt_PVHV);
1517     assert(SvTYPE(sv) != SVt_PVAV);
1518
1519     SvOOK_offset(sv, delta);
1520     
1521     SvLEN_set(sv, SvLEN(sv) + delta);
1522     SvPV_set(sv, SvPVX(sv) - delta);
1523     SvFLAGS(sv) &= ~SVf_OOK;
1524     Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1525     return;
1526 }
1527
1528
1529 /* forward declaration */
1530 static void S_sv_uncow(pTHX_ SV * const sv, const U32 flags);
1531
1532
1533 /*
1534 =for apidoc sv_grow
1535
1536 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1537 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1538 Use the C<SvGROW> wrapper instead.
1539
1540 =cut
1541 */
1542
1543
1544 char *
1545 Perl_sv_grow(pTHX_ SV *const sv, STRLEN newlen)
1546 {
1547     char *s;
1548
1549     PERL_ARGS_ASSERT_SV_GROW;
1550
1551     if (SvROK(sv))
1552         sv_unref(sv);
1553     if (SvTYPE(sv) < SVt_PV) {
1554         sv_upgrade(sv, SVt_PV);
1555         s = SvPVX_mutable(sv);
1556     }
1557     else if (SvOOK(sv)) {       /* pv is offset? */
1558         sv_backoff(sv);
1559         s = SvPVX_mutable(sv);
1560         if (newlen > SvLEN(sv))
1561             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1562     }
1563     else
1564     {
1565         if (SvIsCOW(sv)) S_sv_uncow(aTHX_ sv, 0);
1566         s = SvPVX_mutable(sv);
1567     }
1568
1569 #ifdef PERL_COPY_ON_WRITE
1570     /* the new COW scheme uses SvPVX(sv)[SvLEN(sv)-1] (if spare)
1571      * to store the COW count. So in general, allocate one more byte than
1572      * asked for, to make it likely this byte is always spare: and thus
1573      * make more strings COW-able.
1574      *
1575      * Only increment if the allocation isn't MEM_SIZE_MAX,
1576      * otherwise it will wrap to 0.
1577      */
1578     if ( newlen != MEM_SIZE_MAX )
1579         newlen++;
1580 #endif
1581
1582 #if defined(PERL_USE_MALLOC_SIZE) && defined(Perl_safesysmalloc_size)
1583 #define PERL_UNWARANTED_CHUMMINESS_WITH_MALLOC
1584 #endif
1585
1586     if (newlen > SvLEN(sv)) {           /* need more room? */
1587         STRLEN minlen = SvCUR(sv);
1588         minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1589         if (newlen < minlen)
1590             newlen = minlen;
1591 #ifndef PERL_UNWARANTED_CHUMMINESS_WITH_MALLOC
1592
1593         /* Don't round up on the first allocation, as odds are pretty good that
1594          * the initial request is accurate as to what is really needed */
1595         if (SvLEN(sv)) {
1596             STRLEN rounded = PERL_STRLEN_ROUNDUP(newlen);
1597             if (rounded > newlen)
1598                 newlen = rounded;
1599         }
1600 #endif
1601         if (SvLEN(sv) && s) {
1602             s = (char*)saferealloc(s, newlen);
1603         }
1604         else {
1605             s = (char*)safemalloc(newlen);
1606             if (SvPVX_const(sv) && SvCUR(sv)) {
1607                 Move(SvPVX_const(sv), s, SvCUR(sv), char);
1608             }
1609         }
1610         SvPV_set(sv, s);
1611 #ifdef PERL_UNWARANTED_CHUMMINESS_WITH_MALLOC
1612         /* Do this here, do it once, do it right, and then we will never get
1613            called back into sv_grow() unless there really is some growing
1614            needed.  */
1615         SvLEN_set(sv, Perl_safesysmalloc_size(s));
1616 #else
1617         SvLEN_set(sv, newlen);
1618 #endif
1619     }
1620     return s;
1621 }
1622
1623 /*
1624 =for apidoc sv_setiv
1625
1626 Copies an integer into the given SV, upgrading first if necessary.
1627 Does not handle 'set' magic.  See also C<L</sv_setiv_mg>>.
1628
1629 =cut
1630 */
1631
1632 void
1633 Perl_sv_setiv(pTHX_ SV *const sv, const IV i)
1634 {
1635     PERL_ARGS_ASSERT_SV_SETIV;
1636
1637     SV_CHECK_THINKFIRST_COW_DROP(sv);
1638     switch (SvTYPE(sv)) {
1639     case SVt_NULL:
1640     case SVt_NV:
1641         sv_upgrade(sv, SVt_IV);
1642         break;
1643     case SVt_PV:
1644         sv_upgrade(sv, SVt_PVIV);
1645         break;
1646
1647     case SVt_PVGV:
1648         if (!isGV_with_GP(sv))
1649             break;
1650     case SVt_PVAV:
1651     case SVt_PVHV:
1652     case SVt_PVCV:
1653     case SVt_PVFM:
1654     case SVt_PVIO:
1655         /* diag_listed_as: Can't coerce %s to %s in %s */
1656         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1657                    OP_DESC(PL_op));
1658         NOT_REACHED; /* NOTREACHED */
1659         break;
1660     default: NOOP;
1661     }
1662     (void)SvIOK_only(sv);                       /* validate number */
1663     SvIV_set(sv, i);
1664     SvTAINT(sv);
1665 }
1666
1667 /*
1668 =for apidoc sv_setiv_mg
1669
1670 Like C<sv_setiv>, but also handles 'set' magic.
1671
1672 =cut
1673 */
1674
1675 void
1676 Perl_sv_setiv_mg(pTHX_ SV *const sv, const IV i)
1677 {
1678     PERL_ARGS_ASSERT_SV_SETIV_MG;
1679
1680     sv_setiv(sv,i);
1681     SvSETMAGIC(sv);
1682 }
1683
1684 /*
1685 =for apidoc sv_setuv
1686
1687 Copies an unsigned integer into the given SV, upgrading first if necessary.
1688 Does not handle 'set' magic.  See also C<L</sv_setuv_mg>>.
1689
1690 =cut
1691 */
1692
1693 void
1694 Perl_sv_setuv(pTHX_ SV *const sv, const UV u)
1695 {
1696     PERL_ARGS_ASSERT_SV_SETUV;
1697
1698     /* With the if statement to ensure that integers are stored as IVs whenever
1699        possible:
1700        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1701
1702        without
1703        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1704
1705        If you wish to remove the following if statement, so that this routine
1706        (and its callers) always return UVs, please benchmark to see what the
1707        effect is. Modern CPUs may be different. Or may not :-)
1708     */
1709     if (u <= (UV)IV_MAX) {
1710        sv_setiv(sv, (IV)u);
1711        return;
1712     }
1713     sv_setiv(sv, 0);
1714     SvIsUV_on(sv);
1715     SvUV_set(sv, u);
1716 }
1717
1718 /*
1719 =for apidoc sv_setuv_mg
1720
1721 Like C<sv_setuv>, but also handles 'set' magic.
1722
1723 =cut
1724 */
1725
1726 void
1727 Perl_sv_setuv_mg(pTHX_ SV *const sv, const UV u)
1728 {
1729     PERL_ARGS_ASSERT_SV_SETUV_MG;
1730
1731     sv_setuv(sv,u);
1732     SvSETMAGIC(sv);
1733 }
1734
1735 /*
1736 =for apidoc sv_setnv
1737
1738 Copies a double into the given SV, upgrading first if necessary.
1739 Does not handle 'set' magic.  See also C<L</sv_setnv_mg>>.
1740
1741 =cut
1742 */
1743
1744 void
1745 Perl_sv_setnv(pTHX_ SV *const sv, const NV num)
1746 {
1747     PERL_ARGS_ASSERT_SV_SETNV;
1748
1749     SV_CHECK_THINKFIRST_COW_DROP(sv);
1750     switch (SvTYPE(sv)) {
1751     case SVt_NULL:
1752     case SVt_IV:
1753         sv_upgrade(sv, SVt_NV);
1754         break;
1755     case SVt_PV:
1756     case SVt_PVIV:
1757         sv_upgrade(sv, SVt_PVNV);
1758         break;
1759
1760     case SVt_PVGV:
1761         if (!isGV_with_GP(sv))
1762             break;
1763     case SVt_PVAV:
1764     case SVt_PVHV:
1765     case SVt_PVCV:
1766     case SVt_PVFM:
1767     case SVt_PVIO:
1768         /* diag_listed_as: Can't coerce %s to %s in %s */
1769         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1770                    OP_DESC(PL_op));
1771         NOT_REACHED; /* NOTREACHED */
1772         break;
1773     default: NOOP;
1774     }
1775     SvNV_set(sv, num);
1776     (void)SvNOK_only(sv);                       /* validate number */
1777     SvTAINT(sv);
1778 }
1779
1780 /*
1781 =for apidoc sv_setnv_mg
1782
1783 Like C<sv_setnv>, but also handles 'set' magic.
1784
1785 =cut
1786 */
1787
1788 void
1789 Perl_sv_setnv_mg(pTHX_ SV *const sv, const NV num)
1790 {
1791     PERL_ARGS_ASSERT_SV_SETNV_MG;
1792
1793     sv_setnv(sv,num);
1794     SvSETMAGIC(sv);
1795 }
1796
1797 /* Return a cleaned-up, printable version of sv, for non-numeric, or
1798  * not incrementable warning display.
1799  * Originally part of S_not_a_number().
1800  * The return value may be != tmpbuf.
1801  */
1802
1803 STATIC const char *
1804 S_sv_display(pTHX_ SV *const sv, char *tmpbuf, STRLEN tmpbuf_size) {
1805     const char *pv;
1806
1807      PERL_ARGS_ASSERT_SV_DISPLAY;
1808
1809      if (DO_UTF8(sv)) {
1810           SV *dsv = newSVpvs_flags("", SVs_TEMP);
1811           pv = sv_uni_display(dsv, sv, 32, UNI_DISPLAY_ISPRINT);
1812      } else {
1813           char *d = tmpbuf;
1814           const char * const limit = tmpbuf + tmpbuf_size - 8;
1815           /* each *s can expand to 4 chars + "...\0",
1816              i.e. need room for 8 chars */
1817         
1818           const char *s = SvPVX_const(sv);
1819           const char * const end = s + SvCUR(sv);
1820           for ( ; s < end && d < limit; s++ ) {
1821                int ch = *s & 0xFF;
1822                if (! isASCII(ch) && !isPRINT_LC(ch)) {
1823                     *d++ = 'M';
1824                     *d++ = '-';
1825
1826                     /* Map to ASCII "equivalent" of Latin1 */
1827                     ch = LATIN1_TO_NATIVE(NATIVE_TO_LATIN1(ch) & 127);
1828                }
1829                if (ch == '\n') {
1830                     *d++ = '\\';
1831                     *d++ = 'n';
1832                }
1833                else if (ch == '\r') {
1834                     *d++ = '\\';
1835                     *d++ = 'r';
1836                }
1837                else if (ch == '\f') {
1838                     *d++ = '\\';
1839                     *d++ = 'f';
1840                }
1841                else if (ch == '\\') {
1842                     *d++ = '\\';
1843                     *d++ = '\\';
1844                }
1845                else if (ch == '\0') {
1846                     *d++ = '\\';
1847                     *d++ = '0';
1848                }
1849                else if (isPRINT_LC(ch))
1850                     *d++ = ch;
1851                else {
1852                     *d++ = '^';
1853                     *d++ = toCTRL(ch);
1854                }
1855           }
1856           if (s < end) {
1857                *d++ = '.';
1858                *d++ = '.';
1859                *d++ = '.';
1860           }
1861           *d = '\0';
1862           pv = tmpbuf;
1863     }
1864
1865     return pv;
1866 }
1867
1868 /* Print an "isn't numeric" warning, using a cleaned-up,
1869  * printable version of the offending string
1870  */
1871
1872 STATIC void
1873 S_not_a_number(pTHX_ SV *const sv)
1874 {
1875      char tmpbuf[64];
1876      const char *pv;
1877
1878      PERL_ARGS_ASSERT_NOT_A_NUMBER;
1879
1880      pv = sv_display(sv, tmpbuf, sizeof(tmpbuf));
1881
1882     if (PL_op)
1883         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1884                     /* diag_listed_as: Argument "%s" isn't numeric%s */
1885                     "Argument \"%s\" isn't numeric in %s", pv,
1886                     OP_DESC(PL_op));
1887     else
1888         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1889                     /* diag_listed_as: Argument "%s" isn't numeric%s */
1890                     "Argument \"%s\" isn't numeric", pv);
1891 }
1892
1893 STATIC void
1894 S_not_incrementable(pTHX_ SV *const sv) {
1895      char tmpbuf[64];
1896      const char *pv;
1897
1898      PERL_ARGS_ASSERT_NOT_INCREMENTABLE;
1899
1900      pv = sv_display(sv, tmpbuf, sizeof(tmpbuf));
1901
1902      Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1903                  "Argument \"%s\" treated as 0 in increment (++)", pv);
1904 }
1905
1906 /*
1907 =for apidoc looks_like_number
1908
1909 Test if the content of an SV looks like a number (or is a number).
1910 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1911 non-numeric warning), even if your C<atof()> doesn't grok them.  Get-magic is
1912 ignored.
1913
1914 =cut
1915 */
1916
1917 I32
1918 Perl_looks_like_number(pTHX_ SV *const sv)
1919 {
1920     const char *sbegin;
1921     STRLEN len;
1922     int numtype;
1923
1924     PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1925
1926     if (SvPOK(sv) || SvPOKp(sv)) {
1927         sbegin = SvPV_nomg_const(sv, len);
1928     }
1929     else
1930         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1931     numtype = grok_number(sbegin, len, NULL);
1932     return ((numtype & IS_NUMBER_TRAILING)) ? 0 : numtype;
1933 }
1934
1935 STATIC bool
1936 S_glob_2number(pTHX_ GV * const gv)
1937 {
1938     PERL_ARGS_ASSERT_GLOB_2NUMBER;
1939
1940     /* We know that all GVs stringify to something that is not-a-number,
1941         so no need to test that.  */
1942     if (ckWARN(WARN_NUMERIC))
1943     {
1944         SV *const buffer = sv_newmortal();
1945         gv_efullname3(buffer, gv, "*");
1946         not_a_number(buffer);
1947     }
1948     /* We just want something true to return, so that S_sv_2iuv_common
1949         can tail call us and return true.  */
1950     return TRUE;
1951 }
1952
1953 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1954    until proven guilty, assume that things are not that bad... */
1955
1956 /*
1957    NV_PRESERVES_UV:
1958
1959    As 64 bit platforms often have an NV that doesn't preserve all bits of
1960    an IV (an assumption perl has been based on to date) it becomes necessary
1961    to remove the assumption that the NV always carries enough precision to
1962    recreate the IV whenever needed, and that the NV is the canonical form.
1963    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1964    precision as a side effect of conversion (which would lead to insanity
1965    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1966    1) to distinguish between IV/UV/NV slots that have a valid conversion cached
1967       where precision was lost, and IV/UV/NV slots that have a valid conversion
1968       which has lost no precision
1969    2) to ensure that if a numeric conversion to one form is requested that
1970       would lose precision, the precise conversion (or differently
1971       imprecise conversion) is also performed and cached, to prevent
1972       requests for different numeric formats on the same SV causing
1973       lossy conversion chains. (lossless conversion chains are perfectly
1974       acceptable (still))
1975
1976
1977    flags are used:
1978    SvIOKp is true if the IV slot contains a valid value
1979    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1980    SvNOKp is true if the NV slot contains a valid value
1981    SvNOK  is true only if the NV value is accurate
1982
1983    so
1984    while converting from PV to NV, check to see if converting that NV to an
1985    IV(or UV) would lose accuracy over a direct conversion from PV to
1986    IV(or UV). If it would, cache both conversions, return NV, but mark
1987    SV as IOK NOKp (ie not NOK).
1988
1989    While converting from PV to IV, check to see if converting that IV to an
1990    NV would lose accuracy over a direct conversion from PV to NV. If it
1991    would, cache both conversions, flag similarly.
1992
1993    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1994    correctly because if IV & NV were set NV *always* overruled.
1995    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1996    changes - now IV and NV together means that the two are interchangeable:
1997    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1998
1999    The benefit of this is that operations such as pp_add know that if
2000    SvIOK is true for both left and right operands, then integer addition
2001    can be used instead of floating point (for cases where the result won't
2002    overflow). Before, floating point was always used, which could lead to
2003    loss of precision compared with integer addition.
2004
2005    * making IV and NV equal status should make maths accurate on 64 bit
2006      platforms
2007    * may speed up maths somewhat if pp_add and friends start to use
2008      integers when possible instead of fp. (Hopefully the overhead in
2009      looking for SvIOK and checking for overflow will not outweigh the
2010      fp to integer speedup)
2011    * will slow down integer operations (callers of SvIV) on "inaccurate"
2012      values, as the change from SvIOK to SvIOKp will cause a call into
2013      sv_2iv each time rather than a macro access direct to the IV slot
2014    * should speed up number->string conversion on integers as IV is
2015      favoured when IV and NV are equally accurate
2016
2017    ####################################################################
2018    You had better be using SvIOK_notUV if you want an IV for arithmetic:
2019    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2020    On the other hand, SvUOK is true iff UV.
2021    ####################################################################
2022
2023    Your mileage will vary depending your CPU's relative fp to integer
2024    performance ratio.
2025 */
2026
2027 #ifndef NV_PRESERVES_UV
2028 #  define IS_NUMBER_UNDERFLOW_IV 1
2029 #  define IS_NUMBER_UNDERFLOW_UV 2
2030 #  define IS_NUMBER_IV_AND_UV    2
2031 #  define IS_NUMBER_OVERFLOW_IV  4
2032 #  define IS_NUMBER_OVERFLOW_UV  5
2033
2034 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2035
2036 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
2037 STATIC int
2038 S_sv_2iuv_non_preserve(pTHX_ SV *const sv
2039 #  ifdef DEBUGGING
2040                        , I32 numtype
2041 #  endif
2042                        )
2043 {
2044     PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
2045     PERL_UNUSED_CONTEXT;
2046
2047     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));
2048     if (SvNVX(sv) < (NV)IV_MIN) {
2049         (void)SvIOKp_on(sv);
2050         (void)SvNOK_on(sv);
2051         SvIV_set(sv, IV_MIN);
2052         return IS_NUMBER_UNDERFLOW_IV;
2053     }
2054     if (SvNVX(sv) > (NV)UV_MAX) {
2055         (void)SvIOKp_on(sv);
2056         (void)SvNOK_on(sv);
2057         SvIsUV_on(sv);
2058         SvUV_set(sv, UV_MAX);
2059         return IS_NUMBER_OVERFLOW_UV;
2060     }
2061     (void)SvIOKp_on(sv);
2062     (void)SvNOK_on(sv);
2063     /* Can't use strtol etc to convert this string.  (See truth table in
2064        sv_2iv  */
2065     if (SvNVX(sv) <= (UV)IV_MAX) {
2066         SvIV_set(sv, I_V(SvNVX(sv)));
2067         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2068             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2069         } else {
2070             /* Integer is imprecise. NOK, IOKp */
2071         }
2072         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2073     }
2074     SvIsUV_on(sv);
2075     SvUV_set(sv, U_V(SvNVX(sv)));
2076     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2077         if (SvUVX(sv) == UV_MAX) {
2078             /* As we know that NVs don't preserve UVs, UV_MAX cannot
2079                possibly be preserved by NV. Hence, it must be overflow.
2080                NOK, IOKp */
2081             return IS_NUMBER_OVERFLOW_UV;
2082         }
2083         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2084     } else {
2085         /* Integer is imprecise. NOK, IOKp */
2086     }
2087     return IS_NUMBER_OVERFLOW_IV;
2088 }
2089 #endif /* !NV_PRESERVES_UV*/
2090
2091 /* If numtype is infnan, set the NV of the sv accordingly.
2092  * If numtype is anything else, try setting the NV using Atof(PV). */
2093 #ifdef USING_MSVC6
2094 #  pragma warning(push)
2095 #  pragma warning(disable:4756;disable:4056)
2096 #endif
2097 static void
2098 S_sv_setnv(pTHX_ SV* sv, int numtype)
2099 {
2100     bool pok = cBOOL(SvPOK(sv));
2101     bool nok = FALSE;
2102 #ifdef NV_INF
2103     if ((numtype & IS_NUMBER_INFINITY)) {
2104         SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -NV_INF : NV_INF);
2105         nok = TRUE;
2106     } else
2107 #endif
2108 #ifdef NV_NAN
2109     if ((numtype & IS_NUMBER_NAN)) {
2110         SvNV_set(sv, NV_NAN);
2111         nok = TRUE;
2112     } else
2113 #endif
2114     if (pok) {
2115         SvNV_set(sv, Atof(SvPVX_const(sv)));
2116         /* Purposefully no true nok here, since we don't want to blow
2117          * away the possible IOK/UV of an existing sv. */
2118     }
2119     if (nok) {
2120         SvNOK_only(sv); /* No IV or UV please, this is pure infnan. */
2121         if (pok)
2122             SvPOK_on(sv); /* PV is okay, though. */
2123     }
2124 }
2125 #ifdef USING_MSVC6
2126 #  pragma warning(pop)
2127 #endif
2128
2129 STATIC bool
2130 S_sv_2iuv_common(pTHX_ SV *const sv)
2131 {
2132     PERL_ARGS_ASSERT_SV_2IUV_COMMON;
2133
2134     if (SvNOKp(sv)) {
2135         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2136          * without also getting a cached IV/UV from it at the same time
2137          * (ie PV->NV conversion should detect loss of accuracy and cache
2138          * IV or UV at same time to avoid this. */
2139         /* IV-over-UV optimisation - choose to cache IV if possible */
2140
2141         if (SvTYPE(sv) == SVt_NV)
2142             sv_upgrade(sv, SVt_PVNV);
2143
2144         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2145         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2146            certainly cast into the IV range at IV_MAX, whereas the correct
2147            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2148            cases go to UV */
2149 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2150         if (Perl_isnan(SvNVX(sv))) {
2151             SvUV_set(sv, 0);
2152             SvIsUV_on(sv);
2153             return FALSE;
2154         }
2155 #endif
2156         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2157             SvIV_set(sv, I_V(SvNVX(sv)));
2158             if (SvNVX(sv) == (NV) SvIVX(sv)
2159 #ifndef NV_PRESERVES_UV
2160                 && SvIVX(sv) != IV_MIN /* avoid negating IV_MIN below */
2161                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2162                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2163                 /* Don't flag it as "accurately an integer" if the number
2164                    came from a (by definition imprecise) NV operation, and
2165                    we're outside the range of NV integer precision */
2166 #endif
2167                 ) {
2168                 if (SvNOK(sv))
2169                     SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2170                 else {
2171                     /* scalar has trailing garbage, eg "42a" */
2172                 }
2173                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2174                                       "0x%" UVxf " iv(%" NVgf " => %" IVdf ") (precise)\n",
2175                                       PTR2UV(sv),
2176                                       SvNVX(sv),
2177                                       SvIVX(sv)));
2178
2179             } else {
2180                 /* IV not precise.  No need to convert from PV, as NV
2181                    conversion would already have cached IV if it detected
2182                    that PV->IV would be better than PV->NV->IV
2183                    flags already correct - don't set public IOK.  */
2184                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2185                                       "0x%" UVxf " iv(%" NVgf " => %" IVdf ") (imprecise)\n",
2186                                       PTR2UV(sv),
2187                                       SvNVX(sv),
2188                                       SvIVX(sv)));
2189             }
2190             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2191                but the cast (NV)IV_MIN rounds to a the value less (more
2192                negative) than IV_MIN which happens to be equal to SvNVX ??
2193                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2194                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2195                (NV)UVX == NVX are both true, but the values differ. :-(
2196                Hopefully for 2s complement IV_MIN is something like
2197                0x8000000000000000 which will be exact. NWC */
2198         }
2199         else {
2200             SvUV_set(sv, U_V(SvNVX(sv)));
2201             if (
2202                 (SvNVX(sv) == (NV) SvUVX(sv))
2203 #ifndef  NV_PRESERVES_UV
2204                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2205                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2206                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2207                 /* Don't flag it as "accurately an integer" if the number
2208                    came from a (by definition imprecise) NV operation, and
2209                    we're outside the range of NV integer precision */
2210 #endif
2211                 && SvNOK(sv)
2212                 )
2213                 SvIOK_on(sv);
2214             SvIsUV_on(sv);
2215             DEBUG_c(PerlIO_printf(Perl_debug_log,
2216                                   "0x%" UVxf " 2iv(%" UVuf " => %" IVdf ") (as unsigned)\n",
2217                                   PTR2UV(sv),
2218                                   SvUVX(sv),
2219                                   SvUVX(sv)));
2220         }
2221     }
2222     else if (SvPOKp(sv)) {
2223         UV value;
2224         int numtype;
2225         const char *s = SvPVX_const(sv);
2226         const STRLEN cur = SvCUR(sv);
2227
2228         /* short-cut for a single digit string like "1" */
2229
2230         if (cur == 1) {
2231             char c = *s;
2232             if (isDIGIT(c)) {
2233                 if (SvTYPE(sv) < SVt_PVIV)
2234                     sv_upgrade(sv, SVt_PVIV);
2235                 (void)SvIOK_on(sv);
2236                 SvIV_set(sv, (IV)(c - '0'));
2237                 return FALSE;
2238             }
2239         }
2240
2241         numtype = grok_number(s, cur, &value);
2242         /* We want to avoid a possible problem when we cache an IV/ a UV which
2243            may be later translated to an NV, and the resulting NV is not
2244            the same as the direct translation of the initial string
2245            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2246            be careful to ensure that the value with the .456 is around if the
2247            NV value is requested in the future).
2248         
2249            This means that if we cache such an IV/a UV, we need to cache the
2250            NV as well.  Moreover, we trade speed for space, and do not
2251            cache the NV if we are sure it's not needed.
2252          */
2253
2254         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2255         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2256              == IS_NUMBER_IN_UV) {
2257             /* It's definitely an integer, only upgrade to PVIV */
2258             if (SvTYPE(sv) < SVt_PVIV)
2259                 sv_upgrade(sv, SVt_PVIV);
2260             (void)SvIOK_on(sv);
2261         } else if (SvTYPE(sv) < SVt_PVNV)
2262             sv_upgrade(sv, SVt_PVNV);
2263
2264         if ((numtype & (IS_NUMBER_INFINITY | IS_NUMBER_NAN))) {
2265             if (ckWARN(WARN_NUMERIC) && ((numtype & IS_NUMBER_TRAILING)))
2266                 not_a_number(sv);
2267             S_sv_setnv(aTHX_ sv, numtype);
2268             return FALSE;
2269         }
2270
2271         /* If NVs preserve UVs then we only use the UV value if we know that
2272            we aren't going to call atof() below. If NVs don't preserve UVs
2273            then the value returned may have more precision than atof() will
2274            return, even though value isn't perfectly accurate.  */
2275         if ((numtype & (IS_NUMBER_IN_UV
2276 #ifdef NV_PRESERVES_UV
2277                         | IS_NUMBER_NOT_INT
2278 #endif
2279             )) == IS_NUMBER_IN_UV) {
2280             /* This won't turn off the public IOK flag if it was set above  */
2281             (void)SvIOKp_on(sv);
2282
2283             if (!(numtype & IS_NUMBER_NEG)) {
2284                 /* positive */;
2285                 if (value <= (UV)IV_MAX) {
2286                     SvIV_set(sv, (IV)value);
2287                 } else {
2288                     /* it didn't overflow, and it was positive. */
2289                     SvUV_set(sv, value);
2290                     SvIsUV_on(sv);
2291                 }
2292             } else {
2293                 /* 2s complement assumption  */
2294                 if (value <= (UV)IV_MIN) {
2295                     SvIV_set(sv, value == (UV)IV_MIN
2296                                     ? IV_MIN : -(IV)value);
2297                 } else {
2298                     /* Too negative for an IV.  This is a double upgrade, but
2299                        I'm assuming it will be rare.  */
2300                     if (SvTYPE(sv) < SVt_PVNV)
2301                         sv_upgrade(sv, SVt_PVNV);
2302                     SvNOK_on(sv);
2303                     SvIOK_off(sv);
2304                     SvIOKp_on(sv);
2305                     SvNV_set(sv, -(NV)value);
2306                     SvIV_set(sv, IV_MIN);
2307                 }
2308             }
2309         }
2310         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2311            will be in the previous block to set the IV slot, and the next
2312            block to set the NV slot.  So no else here.  */
2313         
2314         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2315             != IS_NUMBER_IN_UV) {
2316             /* It wasn't an (integer that doesn't overflow the UV). */
2317             S_sv_setnv(aTHX_ sv, numtype);
2318
2319             if (! numtype && ckWARN(WARN_NUMERIC))
2320                 not_a_number(sv);
2321
2322             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%" UVxf " 2iv(%" NVgf ")\n",
2323                                   PTR2UV(sv), SvNVX(sv)));
2324
2325 #ifdef NV_PRESERVES_UV
2326             (void)SvIOKp_on(sv);
2327             (void)SvNOK_on(sv);
2328 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2329             if (Perl_isnan(SvNVX(sv))) {
2330                 SvUV_set(sv, 0);
2331                 SvIsUV_on(sv);
2332                 return FALSE;
2333             }
2334 #endif
2335             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2336                 SvIV_set(sv, I_V(SvNVX(sv)));
2337                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2338                     SvIOK_on(sv);
2339                 } else {
2340                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2341                 }
2342                 /* UV will not work better than IV */
2343             } else {
2344                 if (SvNVX(sv) > (NV)UV_MAX) {
2345                     SvIsUV_on(sv);
2346                     /* Integer is inaccurate. NOK, IOKp, is UV */
2347                     SvUV_set(sv, UV_MAX);
2348                 } else {
2349                     SvUV_set(sv, U_V(SvNVX(sv)));
2350                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2351                        NV preservse UV so can do correct comparison.  */
2352                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2353                         SvIOK_on(sv);
2354                     } else {
2355                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2356                     }
2357                 }
2358                 SvIsUV_on(sv);
2359             }
2360 #else /* NV_PRESERVES_UV */
2361             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2362                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2363                 /* The IV/UV slot will have been set from value returned by
2364                    grok_number above.  The NV slot has just been set using
2365                    Atof.  */
2366                 SvNOK_on(sv);
2367                 assert (SvIOKp(sv));
2368             } else {
2369                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2370                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2371                     /* Small enough to preserve all bits. */
2372                     (void)SvIOKp_on(sv);
2373                     SvNOK_on(sv);
2374                     SvIV_set(sv, I_V(SvNVX(sv)));
2375                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2376                         SvIOK_on(sv);
2377                     /* Assumption: first non-preserved integer is < IV_MAX,
2378                        this NV is in the preserved range, therefore: */
2379                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2380                           < (UV)IV_MAX)) {
2381                         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);
2382                     }
2383                 } else {
2384                     /* IN_UV NOT_INT
2385                          0      0       already failed to read UV.
2386                          0      1       already failed to read UV.
2387                          1      0       you won't get here in this case. IV/UV
2388                                         slot set, public IOK, Atof() unneeded.
2389                          1      1       already read UV.
2390                        so there's no point in sv_2iuv_non_preserve() attempting
2391                        to use atol, strtol, strtoul etc.  */
2392 #  ifdef DEBUGGING
2393                     sv_2iuv_non_preserve (sv, numtype);
2394 #  else
2395                     sv_2iuv_non_preserve (sv);
2396 #  endif
2397                 }
2398             }
2399 #endif /* NV_PRESERVES_UV */
2400         /* It might be more code efficient to go through the entire logic above
2401            and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2402            gets complex and potentially buggy, so more programmer efficient
2403            to do it this way, by turning off the public flags:  */
2404         if (!numtype)
2405             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2406         }
2407     }
2408     else  {
2409         if (isGV_with_GP(sv))
2410             return glob_2number(MUTABLE_GV(sv));
2411
2412         if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2413                 report_uninit(sv);
2414         if (SvTYPE(sv) < SVt_IV)
2415             /* Typically the caller expects that sv_any is not NULL now.  */
2416             sv_upgrade(sv, SVt_IV);
2417         /* Return 0 from the caller.  */
2418         return TRUE;
2419     }
2420     return FALSE;
2421 }
2422
2423 /*
2424 =for apidoc sv_2iv_flags
2425
2426 Return the integer value of an SV, doing any necessary string
2427 conversion.  If C<flags> has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.
2428 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2429
2430 =cut
2431 */
2432
2433 IV
2434 Perl_sv_2iv_flags(pTHX_ SV *const sv, const I32 flags)
2435 {
2436     PERL_ARGS_ASSERT_SV_2IV_FLAGS;
2437
2438     assert (SvTYPE(sv) != SVt_PVAV && SvTYPE(sv) != SVt_PVHV
2439          && SvTYPE(sv) != SVt_PVFM);
2440
2441     if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2442         mg_get(sv);
2443
2444     if (SvROK(sv)) {
2445         if (SvAMAGIC(sv)) {
2446             SV * tmpstr;
2447             if (flags & SV_SKIP_OVERLOAD)
2448                 return 0;
2449             tmpstr = AMG_CALLunary(sv, numer_amg);
2450             if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451                 return SvIV(tmpstr);
2452             }
2453         }
2454         return PTR2IV(SvRV(sv));
2455     }
2456
2457     if (SvVALID(sv) || isREGEXP(sv)) {
2458         /* FBMs use the space for SvIVX and SvNVX for other purposes, so
2459            must not let them cache IVs.
2460            In practice they are extremely unlikely to actually get anywhere
2461            accessible by user Perl code - the only way that I'm aware of is when
2462            a constant subroutine which is used as the second argument to index.
2463
2464            Regexps have no SvIVX and SvNVX fields.
2465         */
2466         assert(isREGEXP(sv) || SvPOKp(sv));
2467         {
2468             UV value;
2469             const char * const ptr =
2470                 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2471             const int numtype
2472                 = grok_number(ptr, SvCUR(sv), &value);
2473
2474             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2475                 == IS_NUMBER_IN_UV) {
2476                 /* It's definitely an integer */
2477                 if (numtype & IS_NUMBER_NEG) {
2478                     if (value < (UV)IV_MIN)
2479                         return -(IV)value;
2480                 } else {
2481                     if (value < (UV)IV_MAX)
2482                         return (IV)value;
2483                 }
2484             }
2485
2486             /* Quite wrong but no good choices. */
2487             if ((numtype & IS_NUMBER_INFINITY)) {
2488                 return (numtype & IS_NUMBER_NEG) ? IV_MIN : IV_MAX;
2489             } else if ((numtype & IS_NUMBER_NAN)) {
2490                 return 0; /* So wrong. */
2491             }
2492
2493             if (!numtype) {
2494                 if (ckWARN(WARN_NUMERIC))
2495                     not_a_number(sv);
2496             }
2497             return I_V(Atof(ptr));
2498         }
2499     }
2500
2501     if (SvTHINKFIRST(sv)) {
2502         if (SvREADONLY(sv) && !SvOK(sv)) {
2503             if (ckWARN(WARN_UNINITIALIZED))
2504                 report_uninit(sv);
2505             return 0;
2506         }
2507     }
2508
2509     if (!SvIOKp(sv)) {
2510         if (S_sv_2iuv_common(aTHX_ sv))
2511             return 0;
2512     }
2513
2514     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%" UVxf " 2iv(%" IVdf ")\n",
2515         PTR2UV(sv),SvIVX(sv)));
2516     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2517 }
2518
2519 /*
2520 =for apidoc sv_2uv_flags
2521
2522 Return the unsigned integer value of an SV, doing any necessary string
2523 conversion.  If C<flags> has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.
2524 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2525
2526 =cut
2527 */
2528
2529 UV
2530 Perl_sv_2uv_flags(pTHX_ SV *const sv, const I32 flags)
2531 {
2532     PERL_ARGS_ASSERT_SV_2UV_FLAGS;
2533
2534     if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2535         mg_get(sv);
2536
2537     if (SvROK(sv)) {
2538         if (SvAMAGIC(sv)) {
2539             SV *tmpstr;
2540             if (flags & SV_SKIP_OVERLOAD)
2541                 return 0;
2542             tmpstr = AMG_CALLunary(sv, numer_amg);
2543             if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2544                 return SvUV(tmpstr);
2545             }
2546         }
2547         return PTR2UV(SvRV(sv));
2548     }
2549
2550     if (SvVALID(sv) || isREGEXP(sv)) {
2551         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2552            the same flag bit as SVf_IVisUV, so must not let them cache IVs.  
2553            Regexps have no SvIVX and SvNVX fields. */
2554         assert(isREGEXP(sv) || SvPOKp(sv));
2555         {
2556             UV value;
2557             const char * const ptr =
2558                 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2559             const int numtype
2560                 = grok_number(ptr, SvCUR(sv), &value);
2561
2562             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2563                 == IS_NUMBER_IN_UV) {
2564                 /* It's definitely an integer */
2565                 if (!(numtype & IS_NUMBER_NEG))
2566                     return value;
2567             }
2568
2569             /* Quite wrong but no good choices. */
2570             if ((numtype & IS_NUMBER_INFINITY)) {
2571                 return UV_MAX; /* So wrong. */
2572             } else if ((numtype & IS_NUMBER_NAN)) {
2573                 return 0; /* So wrong. */
2574             }
2575
2576             if (!numtype) {
2577                 if (ckWARN(WARN_NUMERIC))
2578                     not_a_number(sv);
2579             }
2580             return U_V(Atof(ptr));
2581         }
2582     }
2583
2584     if (SvTHINKFIRST(sv)) {
2585         if (SvREADONLY(sv) && !SvOK(sv)) {
2586             if (ckWARN(WARN_UNINITIALIZED))
2587                 report_uninit(sv);
2588             return 0;
2589         }
2590     }
2591
2592     if (!SvIOKp(sv)) {
2593         if (S_sv_2iuv_common(aTHX_ sv))
2594             return 0;
2595     }
2596
2597     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%" UVxf " 2uv(%" UVuf ")\n",
2598                           PTR2UV(sv),SvUVX(sv)));
2599     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2600 }
2601
2602 /*
2603 =for apidoc sv_2nv_flags
2604
2605 Return the num value of an SV, doing any necessary string or integer
2606 conversion.  If C<flags> has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.
2607 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2608
2609 =cut
2610 */
2611
2612 NV
2613 Perl_sv_2nv_flags(pTHX_ SV *const sv, const I32 flags)
2614 {
2615     PERL_ARGS_ASSERT_SV_2NV_FLAGS;
2616
2617     assert (SvTYPE(sv) != SVt_PVAV && SvTYPE(sv) != SVt_PVHV
2618          && SvTYPE(sv) != SVt_PVFM);
2619     if (SvGMAGICAL(sv) || SvVALID(sv) || isREGEXP(sv)) {
2620         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2621            the same flag bit as SVf_IVisUV, so must not let them cache NVs.
2622            Regexps have no SvIVX and SvNVX fields.  */
2623         const char *ptr;
2624         if (flags & SV_GMAGIC)
2625             mg_get(sv);
2626         if (SvNOKp(sv))
2627             return SvNVX(sv);
2628         if (SvPOKp(sv) && !SvIOKp(sv)) {
2629             ptr = SvPVX_const(sv);
2630           grokpv:
2631             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2632                 !grok_number(ptr, SvCUR(sv), NULL))
2633                 not_a_number(sv);
2634             return Atof(ptr);
2635         }
2636         if (SvIOKp(sv)) {
2637             if (SvIsUV(sv))
2638                 return (NV)SvUVX(sv);
2639             else
2640                 return (NV)SvIVX(sv);
2641         }
2642         if (SvROK(sv)) {
2643             goto return_rok;
2644         }
2645         if (isREGEXP(sv)) {
2646             ptr = RX_WRAPPED((REGEXP *)sv);
2647             goto grokpv;
2648         }
2649         assert(SvTYPE(sv) >= SVt_PVMG);
2650         /* This falls through to the report_uninit near the end of the
2651            function. */
2652     } else if (SvTHINKFIRST(sv)) {
2653         if (SvROK(sv)) {
2654         return_rok:
2655             if (SvAMAGIC(sv)) {
2656                 SV *tmpstr;
2657                 if (flags & SV_SKIP_OVERLOAD)
2658                     return 0;
2659                 tmpstr = AMG_CALLunary(sv, numer_amg);
2660                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2661                     return SvNV(tmpstr);
2662                 }
2663             }
2664             return PTR2NV(SvRV(sv));
2665         }
2666         if (SvREADONLY(sv) && !SvOK(sv)) {
2667             if (ckWARN(WARN_UNINITIALIZED))
2668                 report_uninit(sv);
2669             return 0.0;
2670         }
2671     }
2672     if (SvTYPE(sv) < SVt_NV) {
2673         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2674         sv_upgrade(sv, SVt_NV);
2675         DEBUG_c({
2676             STORE_NUMERIC_LOCAL_SET_STANDARD();
2677             PerlIO_printf(Perl_debug_log,
2678                           "0x%" UVxf " num(%" NVgf ")\n",
2679                           PTR2UV(sv), SvNVX(sv));
2680             RESTORE_NUMERIC_LOCAL();
2681         });
2682     }
2683     else if (SvTYPE(sv) < SVt_PVNV)
2684         sv_upgrade(sv, SVt_PVNV);
2685     if (SvNOKp(sv)) {
2686         return SvNVX(sv);
2687     }
2688     if (SvIOKp(sv)) {
2689         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2690 #ifdef NV_PRESERVES_UV
2691         if (SvIOK(sv))
2692             SvNOK_on(sv);
2693         else
2694             SvNOKp_on(sv);
2695 #else
2696         /* Only set the public NV OK flag if this NV preserves the IV  */
2697         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2698         if (SvIOK(sv) &&
2699             SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2700                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2701             SvNOK_on(sv);
2702         else
2703             SvNOKp_on(sv);
2704 #endif
2705     }
2706     else if (SvPOKp(sv)) {
2707         UV value;
2708         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2709         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2710             not_a_number(sv);
2711 #ifdef NV_PRESERVES_UV
2712         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2713             == IS_NUMBER_IN_UV) {
2714             /* It's definitely an integer */
2715             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2716         } else {
2717             S_sv_setnv(aTHX_ sv, numtype);
2718         }
2719         if (numtype)
2720             SvNOK_on(sv);
2721         else
2722             SvNOKp_on(sv);
2723 #else
2724         SvNV_set(sv, Atof(SvPVX_const(sv)));
2725         /* Only set the public NV OK flag if this NV preserves the value in
2726            the PV at least as well as an IV/UV would.
2727            Not sure how to do this 100% reliably. */
2728         /* if that shift count is out of range then Configure's test is
2729            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2730            UV_BITS */
2731         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2732             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2733             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2734         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2735             /* Can't use strtol etc to convert this string, so don't try.
2736                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2737             SvNOK_on(sv);
2738         } else {
2739             /* value has been set.  It may not be precise.  */
2740             if ((numtype & IS_NUMBER_NEG) && (value >= (UV)IV_MIN)) {
2741                 /* 2s complement assumption for (UV)IV_MIN  */
2742                 SvNOK_on(sv); /* Integer is too negative.  */
2743             } else {
2744                 SvNOKp_on(sv);
2745                 SvIOKp_on(sv);
2746
2747                 if (numtype & IS_NUMBER_NEG) {
2748                     /* -IV_MIN is undefined, but we should never reach
2749                      * this point with both IS_NUMBER_NEG and value ==
2750                      * (UV)IV_MIN */
2751                     assert(value != (UV)IV_MIN);
2752                     SvIV_set(sv, -(IV)value);
2753                 } else if (value <= (UV)IV_MAX) {
2754                     SvIV_set(sv, (IV)value);
2755                 } else {
2756                     SvUV_set(sv, value);
2757                     SvIsUV_on(sv);
2758                 }
2759
2760                 if (numtype & IS_NUMBER_NOT_INT) {
2761                     /* I believe that even if the original PV had decimals,
2762                        they are lost beyond the limit of the FP precision.
2763                        However, neither is canonical, so both only get p
2764                        flags.  NWC, 2000/11/25 */
2765                     /* Both already have p flags, so do nothing */
2766                 } else {
2767                     const NV nv = SvNVX(sv);
2768                     /* XXX should this spot have NAN_COMPARE_BROKEN, too? */
2769                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2770                         if (SvIVX(sv) == I_V(nv)) {
2771                             SvNOK_on(sv);
2772                         } else {
2773                             /* It had no "." so it must be integer.  */
2774                         }
2775                         SvIOK_on(sv);
2776                     } else {
2777                         /* between IV_MAX and NV(UV_MAX).
2778                            Could be slightly > UV_MAX */
2779
2780                         if (numtype & IS_NUMBER_NOT_INT) {
2781                             /* UV and NV both imprecise.  */
2782                         } else {
2783                             const UV nv_as_uv = U_V(nv);
2784
2785                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2786                                 SvNOK_on(sv);
2787                             }
2788                             SvIOK_on(sv);
2789                         }
2790                     }
2791                 }
2792             }
2793         }
2794         /* It might be more code efficient to go through the entire logic above
2795            and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2796            gets complex and potentially buggy, so more programmer efficient
2797            to do it this way, by turning off the public flags:  */
2798         if (!numtype)
2799             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2800 #endif /* NV_PRESERVES_UV */
2801     }
2802     else  {
2803         if (isGV_with_GP(sv)) {
2804             glob_2number(MUTABLE_GV(sv));
2805             return 0.0;
2806         }
2807
2808         if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2809             report_uninit(sv);
2810         assert (SvTYPE(sv) >= SVt_NV);
2811         /* Typically the caller expects that sv_any is not NULL now.  */
2812         /* XXX Ilya implies that this is a bug in callers that assume this
2813            and ideally should be fixed.  */
2814         return 0.0;
2815     }
2816     DEBUG_c({
2817         STORE_NUMERIC_LOCAL_SET_STANDARD();
2818         PerlIO_printf(Perl_debug_log, "0x%" UVxf " 2nv(%" NVgf ")\n",
2819                       PTR2UV(sv), SvNVX(sv));
2820         RESTORE_NUMERIC_LOCAL();
2821     });
2822     return SvNVX(sv);
2823 }
2824
2825 /*
2826 =for apidoc sv_2num
2827
2828 Return an SV with the numeric value of the source SV, doing any necessary
2829 reference or overload conversion.  The caller is expected to have handled
2830 get-magic already.
2831
2832 =cut
2833 */
2834
2835 SV *
2836 Perl_sv_2num(pTHX_ SV *const sv)
2837 {
2838     PERL_ARGS_ASSERT_SV_2NUM;
2839
2840     if (!SvROK(sv))
2841         return sv;
2842     if (SvAMAGIC(sv)) {
2843         SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2844         TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2845         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2846             return sv_2num(tmpsv);
2847     }
2848     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2849 }
2850
2851 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2852  * UV as a string towards the end of buf, and return pointers to start and
2853  * end of it.
2854  *
2855  * We assume that buf is at least TYPE_CHARS(UV) long.
2856  */
2857
2858 static char *
2859 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2860 {
2861     char *ptr = buf + TYPE_CHARS(UV);
2862     char * const ebuf = ptr;
2863     int sign;
2864
2865     PERL_ARGS_ASSERT_UIV_2BUF;
2866
2867     if (is_uv)
2868         sign = 0;
2869     else if (iv >= 0) {
2870         uv = iv;
2871         sign = 0;
2872     } else {
2873         uv = (iv == IV_MIN) ? (UV)iv : (UV)(-iv);
2874         sign = 1;
2875     }
2876     do {
2877         *--ptr = '0' + (char)(uv % 10);
2878     } while (uv /= 10);
2879     if (sign)
2880         *--ptr = '-';
2881     *peob = ebuf;
2882     return ptr;
2883 }
2884
2885 /* Helper for sv_2pv_flags and sv_vcatpvfn_flags.  If the NV is an
2886  * infinity or a not-a-number, writes the appropriate strings to the
2887  * buffer, including a zero byte.  On success returns the written length,
2888  * excluding the zero byte, on failure (not an infinity, not a nan)
2889  * returns zero, assert-fails on maxlen being too short.
2890  *
2891  * XXX for "Inf", "-Inf", and "NaN", we could have three read-only
2892  * shared string constants we point to, instead of generating a new
2893  * string for each instance. */
2894 STATIC size_t
2895 S_infnan_2pv(NV nv, char* buffer, size_t maxlen, char plus) {
2896     char* s = buffer;
2897     assert(maxlen >= 4);
2898     if (Perl_isinf(nv)) {
2899         if (nv < 0) {
2900             if (maxlen < 5) /* "-Inf\0"  */
2901                 return 0;
2902             *s++ = '-';
2903         } else if (plus) {
2904             *s++ = '+';
2905         }
2906         *s++ = 'I';
2907         *s++ = 'n';
2908         *s++ = 'f';
2909     }
2910     else if (Perl_isnan(nv)) {
2911         *s++ = 'N';
2912         *s++ = 'a';
2913         *s++ = 'N';
2914         /* XXX optionally output the payload mantissa bits as
2915          * "(unsigned)" (to match the nan("...") C99 function,
2916          * or maybe as "(0xhhh...)"  would make more sense...
2917          * provide a format string so that the user can decide?
2918          * NOTE: would affect the maxlen and assert() logic.*/
2919     }
2920     else {
2921       return 0;
2922     }
2923     assert((s == buffer + 3) || (s == buffer + 4));
2924     *s = 0;
2925     return s - buffer;
2926 }
2927
2928 /*
2929 =for apidoc sv_2pv_flags
2930
2931 Returns a pointer to the string value of an SV, and sets C<*lp> to its length.
2932 If flags has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.  Coerces C<sv> to a
2933 string if necessary.  Normally invoked via the C<SvPV_flags> macro.
2934 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2935
2936 =cut
2937 */
2938
2939 char *
2940 Perl_sv_2pv_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
2941 {
2942     char *s;
2943
2944     PERL_ARGS_ASSERT_SV_2PV_FLAGS;
2945
2946     assert (SvTYPE(sv) != SVt_PVAV && SvTYPE(sv) != SVt_PVHV
2947          && SvTYPE(sv) != SVt_PVFM);
2948     if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2949         mg_get(sv);
2950     if (SvROK(sv)) {
2951         if (SvAMAGIC(sv)) {
2952             SV *tmpstr;
2953             if (flags & SV_SKIP_OVERLOAD)
2954                 return NULL;
2955             tmpstr = AMG_CALLunary(sv, string_amg);
2956             TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2957             if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2958                 /* Unwrap this:  */
2959                 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2960                  */
2961
2962                 char *pv;
2963                 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2964                     if (flags & SV_CONST_RETURN) {
2965                         pv = (char *) SvPVX_const(tmpstr);
2966                     } else {
2967                         pv = (flags & SV_MUTABLE_RETURN)
2968                             ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2969                     }
2970                     if (lp)
2971                         *lp = SvCUR(tmpstr);
2972                 } else {
2973                     pv = sv_2pv_flags(tmpstr, lp, flags);
2974                 }
2975                 if (SvUTF8(tmpstr))
2976                     SvUTF8_on(sv);
2977                 else
2978                     SvUTF8_off(sv);
2979                 return pv;
2980             }
2981         }
2982         {
2983             STRLEN len;
2984             char *retval;
2985             char *buffer;
2986             SV *const referent = SvRV(sv);
2987
2988             if (!referent) {
2989                 len = 7;
2990                 retval = buffer = savepvn("NULLREF", len);
2991             } else if (SvTYPE(referent) == SVt_REGEXP &&
2992                        (!(PL_curcop->cop_hints & HINT_NO_AMAGIC) ||
2993                         amagic_is_enabled(string_amg))) {
2994                 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2995
2996                 assert(re);
2997                         
2998                 /* If the regex is UTF-8 we want the containing scalar to
2999                    have an UTF-8 flag too */
3000                 if (RX_UTF8(re))
3001                     SvUTF8_on(sv);
3002                 else
3003                     SvUTF8_off(sv);     
3004
3005                 if (lp)
3006                     *lp = RX_WRAPLEN(re);
3007  
3008                 return RX_WRAPPED(re);
3009             } else {
3010                 const char *const typestr = sv_reftype(referent, 0);
3011                 const STRLEN typelen = strlen(typestr);
3012                 UV addr = PTR2UV(referent);
3013                 const char *stashname = NULL;
3014                 STRLEN stashnamelen = 0; /* hush, gcc */
3015                 const char *buffer_end;
3016
3017                 if (SvOBJECT(referent)) {
3018                     const HEK *const name = HvNAME_HEK(SvSTASH(referent));
3019
3020                     if (name) {
3021                         stashname = HEK_KEY(name);
3022                         stashnamelen = HEK_LEN(name);
3023
3024                         if (HEK_UTF8(name)) {
3025                             SvUTF8_on(sv);
3026                         } else {
3027                             SvUTF8_off(sv);
3028                         }
3029                     } else {
3030                         stashname = "__ANON__";
3031                         stashnamelen = 8;
3032                     }
3033                     len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
3034                         + 2 * sizeof(UV) + 2 /* )\0 */;
3035                 } else {
3036                     len = typelen + 3 /* (0x */
3037                         + 2 * sizeof(UV) + 2 /* )\0 */;
3038                 }
3039
3040                 Newx(buffer, len, char);
3041                 buffer_end = retval = buffer + len;
3042
3043                 /* Working backwards  */
3044                 *--retval = '\0';
3045                 *--retval = ')';
3046                 do {
3047                     *--retval = PL_hexdigit[addr & 15];
3048                 } while (addr >>= 4);
3049                 *--retval = 'x';
3050                 *--retval = '0';
3051                 *--retval = '(';
3052
3053                 retval -= typelen;
3054                 memcpy(retval, typestr, typelen);
3055
3056                 if (stashname) {
3057                     *--retval = '=';
3058                     retval -= stashnamelen;
3059                     memcpy(retval, stashname, stashnamelen);
3060                 }
3061                 /* retval may not necessarily have reached the start of the
3062                    buffer here.  */
3063                 assert (retval >= buffer);
3064
3065                 len = buffer_end - retval - 1; /* -1 for that \0  */
3066             }
3067             if (lp)
3068                 *lp = len;
3069             SAVEFREEPV(buffer);
3070             return retval;
3071         }
3072     }
3073
3074     if (SvPOKp(sv)) {
3075         if (lp)
3076             *lp = SvCUR(sv);
3077         if (flags & SV_MUTABLE_RETURN)
3078             return SvPVX_mutable(sv);
3079         if (flags & SV_CONST_RETURN)
3080             return (char *)SvPVX_const(sv);
3081         return SvPVX(sv);
3082     }
3083
3084     if (SvIOK(sv)) {
3085         /* I'm assuming that if both IV and NV are equally valid then
3086            converting the IV is going to be more efficient */
3087         const U32 isUIOK = SvIsUV(sv);
3088         char buf[TYPE_CHARS(UV)];
3089         char *ebuf, *ptr;
3090         STRLEN len;
3091
3092         if (SvTYPE(sv) < SVt_PVIV)
3093             sv_upgrade(sv, SVt_PVIV);
3094         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
3095         len = ebuf - ptr;
3096         /* inlined from sv_setpvn */
3097         s = SvGROW_mutable(sv, len + 1);
3098         Move(ptr, s, len, char);
3099         s += len;
3100         *s = '\0';
3101         SvPOK_on(sv);
3102     }
3103     else if (SvNOK(sv)) {
3104         if (SvTYPE(sv) < SVt_PVNV)
3105             sv_upgrade(sv, SVt_PVNV);
3106         if (SvNVX(sv) == 0.0
3107 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
3108             && !Perl_isnan(SvNVX(sv))
3109 #endif
3110         ) {
3111             s = SvGROW_mutable(sv, 2);
3112             *s++ = '0';
3113             *s = '\0';
3114         } else {
3115             STRLEN len;
3116             STRLEN size = 5; /* "-Inf\0" */
3117
3118             s = SvGROW_mutable(sv, size);
3119             len = S_infnan_2pv(SvNVX(sv), s, size, 0);
3120             if (len > 0) {
3121                 s += len;
3122                 SvPOK_on(sv);
3123             }
3124             else {
3125                 /* some Xenix systems wipe out errno here */
3126                 dSAVE_ERRNO;
3127
3128                 size =
3129                     1 + /* sign */
3130                     1 + /* "." */
3131                     NV_DIG +
3132                     1 + /* "e" */
3133                     1 + /* sign */
3134                     5 + /* exponent digits */
3135                     1 + /* \0 */
3136                     2; /* paranoia */
3137
3138                 s = SvGROW_mutable(sv, size);
3139 #ifndef USE_LOCALE_NUMERIC
3140                 SNPRINTF_G(SvNVX(sv), s, SvLEN(sv), NV_DIG);
3141
3142                 SvPOK_on(sv);
3143 #else
3144                 {
3145                     bool local_radix;
3146                     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
3147                     STORE_LC_NUMERIC_SET_TO_NEEDED();
3148
3149                     local_radix = PL_numeric_local && PL_numeric_radix_sv;
3150                     if (local_radix && SvCUR(PL_numeric_radix_sv) > 1) {
3151                         size += SvCUR(PL_numeric_radix_sv) - 1;
3152                         s = SvGROW_mutable(sv, size);
3153                     }
3154
3155                     SNPRINTF_G(SvNVX(sv), s, SvLEN(sv), NV_DIG);
3156
3157                     /* If the radix character is UTF-8, and actually is in the
3158                      * output, turn on the UTF-8 flag for the scalar */
3159                     if (   local_radix
3160                         && SvUTF8(PL_numeric_radix_sv)
3161                         && instr(s, SvPVX_const(PL_numeric_radix_sv)))
3162                     {
3163                         SvUTF8_on(sv);
3164                     }
3165
3166                     RESTORE_LC_NUMERIC();
3167                 }
3168
3169                 /* We don't call SvPOK_on(), because it may come to
3170                  * pass that the locale changes so that the
3171                  * stringification we just did is no longer correct.  We
3172                  * will have to re-stringify every time it is needed */
3173 #endif
3174                 RESTORE_ERRNO;
3175             }
3176             while (*s) s++;
3177         }
3178     }
3179     else if (isGV_with_GP(sv)) {
3180         GV *const gv = MUTABLE_GV(sv);
3181         SV *const buffer = sv_newmortal();
3182
3183         gv_efullname3(buffer, gv, "*");
3184
3185         assert(SvPOK(buffer));
3186         if (SvUTF8(buffer))
3187             SvUTF8_on(sv);
3188         else
3189             SvUTF8_off(sv);
3190         if (lp)
3191             *lp = SvCUR(buffer);
3192         return SvPVX(buffer);
3193     }
3194     else if (isREGEXP(sv)) {
3195         if (lp) *lp = RX_WRAPLEN((REGEXP *)sv);
3196         return RX_WRAPPED((REGEXP *)sv);
3197     }
3198     else {
3199         if (lp)
3200             *lp = 0;
3201         if (flags & SV_UNDEF_RETURNS_NULL)
3202             return NULL;
3203         if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
3204             report_uninit(sv);
3205         /* Typically the caller expects that sv_any is not NULL now.  */
3206         if (!SvREADONLY(sv) && SvTYPE(sv) < SVt_PV)
3207             sv_upgrade(sv, SVt_PV);
3208         return (char *)"";
3209     }
3210
3211     {
3212         const STRLEN len = s - SvPVX_const(sv);
3213         if (lp) 
3214             *lp = len;
3215         SvCUR_set(sv, len);
3216     }
3217     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%" UVxf " 2pv(%s)\n",
3218                           PTR2UV(sv),SvPVX_const(sv)));
3219     if (flags & SV_CONST_RETURN)
3220         return (char *)SvPVX_const(sv);
3221     if (flags & SV_MUTABLE_RETURN)
3222         return SvPVX_mutable(sv);
3223     return SvPVX(sv);
3224 }
3225
3226 /*
3227 =for apidoc sv_copypv
3228
3229 Copies a stringified representation of the source SV into the
3230 destination SV.  Automatically performs any necessary C<mg_get> and
3231 coercion of numeric values into strings.  Guaranteed to preserve
3232 C<UTF8> flag even from overloaded objects.  Similar in nature to
3233 C<sv_2pv[_flags]> but operates directly on an SV instead of just the
3234 string.  Mostly uses C<sv_2pv_flags> to do its work, except when that
3235 would lose the UTF-8'ness of the PV.
3236
3237 =for apidoc sv_copypv_nomg
3238
3239 Like C<sv_copypv>, but doesn't invoke get magic first.
3240
3241 =for apidoc sv_copypv_flags
3242
3243 Implementation of C<sv_copypv> and C<sv_copypv_nomg>.  Calls get magic iff flags
3244 has the C<SV_GMAGIC> bit set.
3245
3246 =cut
3247 */
3248
3249 void
3250 Perl_sv_copypv_flags(pTHX_ SV *const dsv, SV *const ssv, const I32 flags)
3251 {
3252     STRLEN len;
3253     const char *s;
3254
3255     PERL_ARGS_ASSERT_SV_COPYPV_FLAGS;
3256
3257     s = SvPV_flags_const(ssv,len,(flags & SV_GMAGIC));
3258     sv_setpvn(dsv,s,len);
3259     if (SvUTF8(ssv))
3260         SvUTF8_on(dsv);
3261     else
3262         SvUTF8_off(dsv);
3263 }
3264
3265 /*
3266 =for apidoc sv_2pvbyte
3267
3268 Return a pointer to the byte-encoded representation of the SV, and set C<*lp>
3269 to its length.  May cause the SV to be downgraded from UTF-8 as a
3270 side-effect.
3271
3272 Usually accessed via the C<SvPVbyte> macro.
3273
3274 =cut
3275 */
3276
3277 char *
3278 Perl_sv_2pvbyte(pTHX_ SV *sv, STRLEN *const lp)
3279 {
3280     PERL_ARGS_ASSERT_SV_2PVBYTE;
3281
3282     SvGETMAGIC(sv);
3283     if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3284      || isGV_with_GP(sv) || SvROK(sv)) {
3285         SV *sv2 = sv_newmortal();
3286         sv_copypv_nomg(sv2,sv);
3287         sv = sv2;
3288     }
3289     sv_utf8_downgrade(sv,0);
3290     return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3291 }
3292
3293 /*
3294 =for apidoc sv_2pvutf8
3295
3296 Return a pointer to the UTF-8-encoded representation of the SV, and set C<*lp>
3297 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3298
3299 Usually accessed via the C<SvPVutf8> macro.
3300
3301 =cut
3302 */
3303
3304 char *
3305 Perl_sv_2pvutf8(pTHX_ SV *sv, STRLEN *const lp)
3306 {
3307     PERL_ARGS_ASSERT_SV_2PVUTF8;
3308
3309     if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3310      || isGV_with_GP(sv) || SvROK(sv))
3311         sv = sv_mortalcopy(sv);
3312     else
3313         SvGETMAGIC(sv);
3314     sv_utf8_upgrade_nomg(sv);
3315     return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3316 }
3317
3318
3319 /*
3320 =for apidoc sv_2bool
3321
3322 This macro is only used by C<sv_true()> or its macro equivalent, and only if
3323 the latter's argument is neither C<SvPOK>, C<SvIOK> nor C<SvNOK>.
3324 It calls C<sv_2bool_flags> with the C<SV_GMAGIC> flag.
3325
3326 =for apidoc sv_2bool_flags
3327
3328 This function is only used by C<sv_true()> and friends,  and only if
3329 the latter's argument is neither C<SvPOK>, C<SvIOK> nor C<SvNOK>.  If the flags
3330 contain C<SV_GMAGIC>, then it does an C<mg_get()> first.
3331
3332
3333 =cut
3334 */
3335
3336 bool
3337 Perl_sv_2bool_flags(pTHX_ SV *sv, I32 flags)
3338 {
3339     PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3340
3341     restart:
3342     if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3343
3344     if (!SvOK(sv))
3345         return 0;
3346     if (SvROK(sv)) {
3347         if (SvAMAGIC(sv)) {
3348             SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3349             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv)))) {
3350                 bool svb;
3351                 sv = tmpsv;
3352                 if(SvGMAGICAL(sv)) {
3353                     flags = SV_GMAGIC;
3354                     goto restart; /* call sv_2bool */
3355                 }
3356                 /* expanded SvTRUE_common(sv, (flags = 0, goto restart)) */
3357                 else if(!SvOK(sv)) {
3358                     svb = 0;
3359                 }
3360                 else if(SvPOK(sv)) {
3361                     svb = SvPVXtrue(sv);
3362                 }
3363                 else if((SvFLAGS(sv) & (SVf_IOK|SVf_NOK))) {
3364                     svb = (SvIOK(sv) && SvIVX(sv) != 0)
3365                         || (SvNOK(sv) && SvNVX(sv) != 0.0);
3366                 }
3367                 else {
3368                     flags = 0;
3369                     goto restart; /* call sv_2bool_nomg */
3370                 }
3371                 return cBOOL(svb);
3372             }
3373         }
3374         return SvRV(sv) != 0;
3375     }
3376     if (isREGEXP(sv))
3377         return
3378           RX_WRAPLEN(sv) > 1 || (RX_WRAPLEN(sv) && *RX_WRAPPED(sv) != '0');
3379     return SvTRUE_common(sv, isGV_with_GP(sv) ? 1 : 0);
3380 }
3381
3382 /*
3383 =for apidoc sv_utf8_upgrade
3384
3385 Converts the PV of an SV to its UTF-8-encoded form.
3386 Forces the SV to string form if it is not already.
3387 Will C<mg_get> on C<sv> if appropriate.
3388 Always sets the C<SvUTF8> flag to avoid future validity checks even
3389 if the whole string is the same in UTF-8 as not.
3390 Returns the number of bytes in the converted string
3391
3392 This is not a general purpose byte encoding to Unicode interface:
3393 use the Encode extension for that.
3394
3395 =for apidoc sv_utf8_upgrade_nomg
3396
3397 Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
3398
3399 =for apidoc sv_utf8_upgrade_flags
3400
3401 Converts the PV of an SV to its UTF-8-encoded form.
3402 Forces the SV to string form if it is not already.
3403 Always sets the SvUTF8 flag to avoid future validity checks even
3404 if all the bytes are invariant in UTF-8.
3405 If C<flags> has C<SV_GMAGIC> bit set,
3406 will C<mg_get> on C<sv> if appropriate, else not.
3407
3408 If C<flags> has C<SV_FORCE_UTF8_UPGRADE> set, this function assumes that the PV
3409 will expand when converted to UTF-8, and skips the extra work of checking for
3410 that.  Typically this flag is used by a routine that has already parsed the
3411 string and found such characters, and passes this information on so that the
3412 work doesn't have to be repeated.
3413
3414 Returns the number of bytes in the converted string.
3415
3416 This is not a general purpose byte encoding to Unicode interface:
3417 use the Encode extension for that.
3418
3419 =for apidoc sv_utf8_upgrade_flags_grow
3420
3421 Like C<sv_utf8_upgrade_flags>, but has an additional parameter C<extra>, which is
3422 the number of unused bytes the string of C<sv> is guaranteed to have free after
3423 it upon return.  This allows the caller to reserve extra space that it intends
3424 to fill, to avoid extra grows.
3425
3426 C<sv_utf8_upgrade>, C<sv_utf8_upgrade_nomg>, and C<sv_utf8_upgrade_flags>
3427 are implemented in terms of this function.
3428
3429 Returns the number of bytes in the converted string (not including the spares).
3430
3431 =cut
3432
3433 (One might think that the calling routine could pass in the position of the
3434 first variant character when it has set SV_FORCE_UTF8_UPGRADE, so it wouldn't
3435 have to be found again.  But that is not the case, because typically when the
3436 caller is likely to use this flag, it won't be calling this routine unless it
3437 finds something that won't fit into a byte.  Otherwise it tries to not upgrade
3438 and just use bytes.  But some things that do fit into a byte are variants in
3439 utf8, and the caller may not have been keeping track of these.)
3440
3441 If the routine itself changes the string, it adds a trailing C<NUL>.  Such a
3442 C<NUL> isn't guaranteed due to having other routines do the work in some input
3443 cases, or if the input is already flagged as being in utf8.
3444
3445 The speed of this could perhaps be improved for many cases if someone wanted to
3446 write a fast function that counts the number of variant characters in a string,
3447 especially if it could return the position of the first one.
3448
3449 */
3450
3451 STRLEN
3452 Perl_sv_utf8_upgrade_flags_grow(pTHX_ SV *const sv, const I32 flags, STRLEN extra)
3453 {
3454     PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3455
3456     if (sv == &PL_sv_undef)
3457         return 0;
3458     if (!SvPOK_nog(sv)) {
3459         STRLEN len = 0;
3460         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3461             (void) sv_2pv_flags(sv,&len, flags);
3462             if (SvUTF8(sv)) {
3463                 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3464                 return len;
3465             }
3466         } else {
3467             (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3468         }
3469     }
3470
3471     if (SvUTF8(sv)) {
3472         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3473         return SvCUR(sv);
3474     }
3475
3476     if (SvIsCOW(sv)) {
3477         S_sv_uncow(aTHX_ sv, 0);
3478     }
3479
3480     if (SvCUR(sv) == 0) {
3481         if (extra) SvGROW(sv, extra);
3482     } else { /* Assume Latin-1/EBCDIC */
3483         /* This function could be much more efficient if we
3484          * had a FLAG in SVs to signal if there are any variant
3485          * chars in the PV.  Given that there isn't such a flag
3486          * make the loop as fast as possible (although there are certainly ways
3487          * to speed this up, eg. through vectorization) */
3488         U8 * s = (U8 *) SvPVX_const(sv);
3489         U8 * e = (U8 *) SvEND(sv);
3490         U8 *t = s;
3491         STRLEN two_byte_count;
3492         
3493         if (flags & SV_FORCE_UTF8_UPGRADE) {
3494             two_byte_count = 0;
3495         }
3496         else {
3497             if (is_utf8_invariant_string_loc(s, SvCUR(sv), (const U8 **) &t)) {
3498
3499                 /* utf8 conversion not needed because all are invariants.  Mark
3500                  * as UTF-8 even if no variant - saves scanning loop */
3501                 SvUTF8_on(sv);
3502                 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3503                 return SvCUR(sv);
3504             }
3505
3506             /* Here, there is at least one variant, and t points to the first
3507              * one */
3508             two_byte_count = 1;
3509         }
3510
3511         /* Note that the incoming SV may not have a trailing '\0', as certain
3512          * code in pp_formline can send us partially built SVs.
3513          *
3514          * Here, the string should be converted to utf8, either because of an
3515          * input flag (which causes two_byte_count to be set to 0), or because
3516          * a character that requires 2 bytes was found (two_byte_count = 1).  t
3517          * points either to the beginning of the string (if we didn't examine
3518          * anything), or to the first variant.  In either case, everything from
3519          * s to t - 1 will occupy only 1 byte each on output.
3520          *
3521          * There are two main ways to convert.  One is to create a new string
3522          * and go through the input starting from the beginning, appending each
3523          * converted value onto the new string as we go along.  It's probably
3524          * best to allocate enough space in the string for the worst possible
3525          * case rather than possibly running out of space and having to
3526          * reallocate and then copy what we've done so far.  Since everything
3527          * from s to t - 1 is invariant, the destination can be initialized
3528          * with these using a fast memory copy
3529          *
3530          * The other way is to figure out exactly how big the string should be,
3531          * by parsing the entire input.  Then you don't have to make it big
3532          * enough to handle the worst possible case, and more importantly, if
3533          * the string you already have is large enough, you don't have to
3534          * allocate a new string, you can copy the last character in the input
3535          * string to the final position(s) that will be occupied by the
3536          * converted string and go backwards, stopping at t, since everything
3537          * before that is invariant.
3538          *
3539          * There are advantages and disadvantages to each method.
3540          *
3541          * In the first method, we can allocate a new string, do the memory
3542          * copy from the s to t - 1, and then proceed through the rest of the
3543          * string byte-by-byte.
3544          *
3545          * In the second method, we proceed through the rest of the input
3546          * string just calculating how big the converted string will be.  Then
3547          * there are two cases:
3548          *  1)  if the string has enough extra space to handle the converted
3549          *      value.  We go backwards through the string, converting until we
3550          *      get to the position we are at now, and then stop.  If this
3551          *      position is far enough along in the string, this method is
3552          *      faster than the first method above.  If the memory copy were
3553          *      the same speed as the byte-by-byte loop, that position would be
3554          *      about half-way, as at the half-way mark, parsing to the end and
3555          *      back is one complete string's parse, the same amount as
3556          *      starting over and going all the way through.  Actually, it
3557          *      would be somewhat less than half-way, as it's faster to just
3558          *      count bytes than to also copy, and we don't have the overhead
3559          *      of allocating a new string, changing the scalar to use it, and
3560          *      freeing the existing one.  But if the memory copy is fast, the
3561          *      break-even point is somewhere after half way.  The counting
3562          *      loop could be sped up by vectorization, etc, to move the
3563          *      break-even point further towards the beginning.
3564          *  2)  if the string doesn't have enough space to handle the converted
3565          *      value.  A new string will have to be allocated, and one might
3566          *      as well, given that, start from the beginning doing the first
3567          *      method.  We've spent extra time parsing the string and in
3568          *      exchange all we've gotten is that we know precisely how big to
3569          *      make the new one.  Perl is more optimized for time than space,
3570          *      so this case is a loser.
3571          * So what I've decided to do is not use the 2nd method unless it is
3572          * guaranteed that a new string won't have to be allocated, assuming
3573          * the worst case.  I also decided not to put any more conditions on it
3574          * than this, for now.  It seems likely that, since the worst case is
3575          * twice as big as the unknown portion of the string (plus 1), we won't
3576          * be guaranteed enough space, causing us to go to the first method,
3577          * unless the string is short, or the first variant character is near
3578          * the end of it.  In either of these cases, it seems best to use the
3579          * 2nd method.  The only circumstance I can think of where this would
3580          * be really slower is if the string had once had much more data in it
3581          * than it does now, but there is still a substantial amount in it  */
3582
3583         {
3584             STRLEN invariant_head = t - s;
3585             STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3586             if (SvLEN(sv) < size) {
3587
3588                 /* Here, have decided to allocate a new string */
3589
3590                 U8 *dst;
3591                 U8 *d;
3592
3593                 Newx(dst, size, U8);
3594
3595                 /* If no known invariants at the beginning of the input string,
3596                  * set so starts from there.  Otherwise, can use memory copy to
3597                  * get up to where we are now, and then start from here */
3598
3599                 if (invariant_head == 0) {
3600                     d = dst;
3601                 } else {
3602                     Copy(s, dst, invariant_head, char);
3603                     d = dst + invariant_head;
3604                 }
3605
3606                 while (t < e) {
3607                     append_utf8_from_native_byte(*t, &d);
3608                     t++;
3609                 }
3610                 *d = '\0';
3611                 SvPV_free(sv); /* No longer using pre-existing string */
3612                 SvPV_set(sv, (char*)dst);
3613                 SvCUR_set(sv, d - dst);
3614                 SvLEN_set(sv, size);
3615             } else {
3616
3617                 /* Here, have decided to get the exact size of the string.
3618                  * Currently this happens only when we know that there is
3619                  * guaranteed enough space to fit the converted string, so
3620                  * don't have to worry about growing.  If two_byte_count is 0,
3621                  * then t points to the first byte of the string which hasn't
3622                  * been examined yet.  Otherwise two_byte_count is 1, and t
3623                  * points to the first byte in the string that will expand to
3624                  * two.  Depending on this, start examining at t or 1 after t.
3625                  * */
3626
3627                 U8 *d = t + two_byte_count;
3628
3629
3630                 /* Count up the remaining bytes that expand to two */
3631
3632                 while (d < e) {
3633                     const U8 chr = *d++;
3634                     if (! NATIVE_BYTE_IS_INVARIANT(chr)) two_byte_count++;
3635                 }
3636
3637                 /* The string will expand by just the number of bytes that
3638                  * occupy two positions.  But we are one afterwards because of
3639                  * the increment just above.  This is the place to put the
3640                  * trailing NUL, and to set the length before we decrement */
3641
3642                 d += two_byte_count;
3643                 SvCUR_set(sv, d - s);
3644                 *d-- = '\0';
3645
3646
3647                 /* Having decremented d, it points to the position to put the
3648                  * very last byte of the expanded string.  Go backwards through
3649                  * the string, copying and expanding as we go, stopping when we
3650                  * get to the part that is invariant the rest of the way down */
3651
3652                 e--;
3653                 while (e >= t) {
3654                     if (NATIVE_BYTE_IS_INVARIANT(*e)) {
3655                         *d-- = *e;
3656                     } else {
3657                         *d-- = UTF8_EIGHT_BIT_LO(*e);
3658                         *d-- = UTF8_EIGHT_BIT_HI(*e);
3659                     }
3660                     e--;
3661                 }
3662             }
3663
3664             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3665                 /* Update pos. We do it at the end rather than during
3666                  * the upgrade, to avoid slowing down the common case
3667                  * (upgrade without pos).
3668                  * pos can be stored as either bytes or characters.  Since
3669                  * this was previously a byte string we can just turn off
3670                  * the bytes flag. */
3671                 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3672                 if (mg) {
3673                     mg->mg_flags &= ~MGf_BYTES;
3674                 }
3675                 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3676                     magic_setutf8(sv,mg); /* clear UTF8 cache */
3677             }
3678         }
3679     }
3680
3681     /* Mark as UTF-8 even if no variant - saves scanning loop */
3682     SvUTF8_on(sv);
3683     return SvCUR(sv);
3684 }
3685
3686 /*
3687 =for apidoc sv_utf8_downgrade
3688
3689 Attempts to convert the PV of an SV from characters to bytes.
3690 If the PV contains a character that cannot fit
3691 in a byte, this conversion will fail;
3692 in this case, either returns false or, if C<fail_ok> is not
3693 true, croaks.
3694
3695 This is not a general purpose Unicode to byte encoding interface:
3696 use the C<Encode> extension for that.
3697
3698 =cut
3699 */
3700
3701 bool
3702 Perl_sv_utf8_downgrade(pTHX_ SV *const sv, const bool fail_ok)
3703 {
3704     PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3705
3706     if (SvPOKp(sv) && SvUTF8(sv)) {
3707         if (SvCUR(sv)) {
3708             U8 *s;
3709             STRLEN len;
3710             int mg_flags = SV_GMAGIC;
3711
3712             if (SvIsCOW(sv)) {
3713                 S_sv_uncow(aTHX_ sv, 0);
3714             }
3715             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3716                 /* update pos */
3717                 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3718                 if (mg && mg->mg_len > 0 && mg->mg_flags & MGf_BYTES) {
3719                         mg->mg_len = sv_pos_b2u_flags(sv, mg->mg_len,
3720                                                 SV_GMAGIC|SV_CONST_RETURN);
3721                         mg_flags = 0; /* sv_pos_b2u does get magic */
3722                 }
3723                 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3724                     magic_setutf8(sv,mg); /* clear UTF8 cache */
3725
3726             }
3727             s = (U8 *) SvPV_flags(sv, len, mg_flags);
3728
3729             if (!utf8_to_bytes(s, &len)) {
3730                 if (fail_ok)
3731                     return FALSE;
3732                 else {
3733                     if (PL_op)
3734                         Perl_croak(aTHX_ "Wide character in %s",
3735                                    OP_DESC(PL_op));
3736                     else
3737                         Perl_croak(aTHX_ "Wide character");
3738                 }
3739             }
3740             SvCUR_set(sv, len);
3741         }
3742     }
3743     SvUTF8_off(sv);
3744     return TRUE;
3745 }
3746
3747 /*
3748 =for apidoc sv_utf8_encode
3749
3750 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3751 flag off so that it looks like octets again.
3752
3753 =cut
3754 */
3755
3756 void
3757 Perl_sv_utf8_encode(pTHX_ SV *const sv)
3758 {
3759     PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3760
3761     if (SvREADONLY(sv)) {
3762         sv_force_normal_flags(sv, 0);
3763     }
3764     (void) sv_utf8_upgrade(sv);
3765     SvUTF8_off(sv);
3766 }
3767
3768 /*
3769 =for apidoc sv_utf8_decode
3770
3771 If the PV of the SV is an octet sequence in Perl's extended UTF-8
3772 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3773 so that it looks like a character.  If the PV contains only single-byte
3774 characters, the C<SvUTF8> flag stays off.
3775 Scans PV for validity and returns FALSE if the PV is invalid UTF-8.
3776
3777 =cut
3778 */
3779
3780 bool
3781 Perl_sv_utf8_decode(pTHX_ SV *const sv)
3782 {
3783     PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3784
3785     if (SvPOKp(sv)) {
3786         const U8 *start, *c;
3787
3788         /* The octets may have got themselves encoded - get them back as
3789          * bytes
3790          */
3791         if (!sv_utf8_downgrade(sv, TRUE))
3792             return FALSE;
3793
3794         /* it is actually just a matter of turning the utf8 flag on, but
3795          * we want to make sure everything inside is valid utf8 first.
3796          */
3797         c = start = (const U8 *) SvPVX_const(sv);
3798         if (!is_utf8_string(c, SvCUR(sv)))
3799             return FALSE;
3800         if (! is_utf8_invariant_string(c, SvCUR(sv))) {
3801             SvUTF8_on(sv);
3802         }
3803         if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3804             /* XXX Is this dead code?  XS_utf8_decode calls SvSETMAGIC
3805                    after this, clearing pos.  Does anything on CPAN
3806                    need this? */
3807             /* adjust pos to the start of a UTF8 char sequence */
3808             MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3809             if (mg) {
3810                 I32 pos = mg->mg_len;
3811                 if (pos > 0) {
3812                     for (c = start + pos; c > start; c--) {
3813                         if (UTF8_IS_START(*c))
3814                             break;
3815                     }
3816                     mg->mg_len  = c - start;
3817                 }
3818             }
3819             if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3820                 magic_setutf8(sv,mg); /* clear UTF8 cache */
3821         }
3822     }
3823     return TRUE;
3824 }
3825
3826 /*
3827 =for apidoc sv_setsv
3828
3829 Copies the contents of the source SV C<ssv> into the destination SV
3830 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3831 function if the source SV needs to be reused.  Does not handle 'set' magic on
3832 destination SV.  Calls 'get' magic on source SV.  Loosely speaking, it
3833 performs a copy-by-value, obliterating any previous content of the
3834 destination.
3835
3836 You probably want to use one of the assortment of wrappers, such as
3837 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3838 C<SvSetMagicSV_nosteal>.
3839
3840 =for apidoc sv_setsv_flags
3841
3842 Copies the contents of the source SV C<ssv> into the destination SV
3843 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3844 function if the source SV needs to be reused.  Does not handle 'set' magic.
3845 Loosely speaking, it performs a copy-by-value, obliterating any previous
3846 content of the destination.
3847 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3848 C<ssv> if appropriate, else not.  If the C<flags>
3849 parameter has the C<SV_NOSTEAL> bit set then the
3850 buffers of temps will not be stolen.  C<sv_setsv>
3851 and C<sv_setsv_nomg> are implemented in terms of this function.
3852
3853 You probably want to use one of the assortment of wrappers, such as
3854 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3855 C<SvSetMagicSV_nosteal>.
3856
3857 This is the primary function for copying scalars, and most other
3858 copy-ish functions and macros use this underneath.
3859
3860 =cut
3861 */
3862
3863 static void
3864 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3865 {
3866     I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3867     HV *old_stash = NULL;
3868
3869     PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3870
3871     if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3872         const char * const name = GvNAME(sstr);
3873         const STRLEN len = GvNAMELEN(sstr);
3874         {
3875             if (dtype >= SVt_PV) {
3876                 SvPV_free(dstr);
3877                 SvPV_set(dstr, 0);
3878                 SvLEN_set(dstr, 0);
3879                 SvCUR_set(dstr, 0);
3880             }
3881             SvUPGRADE(dstr, SVt_PVGV);
3882             (void)SvOK_off(dstr);
3883             isGV_with_GP_on(dstr);
3884         }
3885         GvSTASH(dstr) = GvSTASH(sstr);
3886         if (GvSTASH(dstr))
3887             Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3888         gv_name_set(MUTABLE_GV(dstr), name, len,
3889                         GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3890         SvFAKE_on(dstr);        /* can coerce to non-glob */
3891     }
3892
3893     if(GvGP(MUTABLE_GV(sstr))) {
3894         /* If source has method cache entry, clear it */
3895         if(GvCVGEN(sstr)) {
3896             SvREFCNT_dec(GvCV(sstr));
3897             GvCV_set(sstr, NULL);
3898             GvCVGEN(sstr) = 0;
3899         }
3900         /* If source has a real method, then a method is
3901            going to change */
3902         else if(
3903          GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3904         ) {
3905             mro_changes = 1;
3906         }
3907     }
3908
3909     /* If dest already had a real method, that's a change as well */
3910     if(
3911         !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3912      && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3913     ) {
3914         mro_changes = 1;
3915     }
3916
3917     /* We don't need to check the name of the destination if it was not a
3918        glob to begin with. */
3919     if(dtype == SVt_PVGV) {
3920         const char * const name = GvNAME((const GV *)dstr);
3921         if(
3922             strEQ(name,"ISA")
3923          /* The stash may have been detached from the symbol table, so
3924             check its name. */
3925          && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3926         )
3927             mro_changes = 2;
3928         else {
3929             const STRLEN len = GvNAMELEN(dstr);
3930             if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3931              || (len == 1 && name[0] == ':')) {
3932                 mro_changes = 3;
3933
3934                 /* Set aside the old stash, so we can reset isa caches on
3935                    its subclasses. */
3936                 if((old_stash = GvHV(dstr)))
3937                     /* Make sure we do not lose it early. */
3938                     SvREFCNT_inc_simple_void_NN(
3939                      sv_2mortal((SV *)old_stash)
3940                     );
3941             }
3942         }
3943
3944         SvREFCNT_inc_simple_void_NN(sv_2mortal(dstr));
3945     }
3946
3947     /* freeing dstr's GP might free sstr (e.g. *x = $x),
3948      * so temporarily protect it */
3949     ENTER;
3950     SAVEFREESV(SvREFCNT_inc_simple_NN(sstr));
3951     gp_free(MUTABLE_GV(dstr));
3952     GvINTRO_off(dstr);          /* one-shot flag */
3953     GvGP_set(dstr, gp_ref(GvGP(sstr)));
3954     LEAVE;
3955
3956     if (SvTAINTED(sstr))
3957         SvTAINT(dstr);
3958     if (GvIMPORTED(dstr) != GVf_IMPORTED
3959         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3960         {
3961             GvIMPORTED_on(dstr);
3962         }
3963     GvMULTI_on(dstr);
3964     if(mro_changes == 2) {
3965       if (GvAV((const GV *)sstr)) {
3966         MAGIC *mg;
3967         SV * const sref = (SV *)GvAV((const GV *)dstr);
3968         if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3969             if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3970                 AV * const ary = newAV();
3971                 av_push(ary, mg->mg_obj); /* takes the refcount */
3972                 mg->mg_obj = (SV *)ary;
3973             }
3974             av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3975         }
3976         else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3977       }
3978       mro_isa_changed_in(GvSTASH(dstr));
3979     }
3980     else if(mro_changes == 3) {
3981         HV * const stash = GvHV(dstr);
3982         if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3983             mro_package_moved(
3984                 stash, old_stash,
3985                 (GV *)dstr, 0
3986             );
3987     }
3988     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3989     if (GvIO(dstr) && dtype == SVt_PVGV) {
3990         DEBUG_o(Perl_deb(aTHX_
3991                         "glob_assign_glob clearing PL_stashcache\n"));
3992         /* It's a cache. It will rebuild itself quite happily.
3993            It's a lot of effort to work out exactly which key (or keys)
3994            might be invalidated by the creation of the this file handle.
3995          */
3996         hv_clear(PL_stashcache);
3997     }
3998     return;
3999 }
4000
4001 void
4002 Perl_gv_setref(pTHX_ SV *const dstr, SV *const sstr)
4003 {
4004     SV * const sref = SvRV(sstr);
4005     SV *dref;
4006     const int intro = GvINTRO(dstr);
4007     SV **location;
4008     U8 import_flag = 0;
4009     const U32 stype = SvTYPE(sref);
4010
4011     PERL_ARGS_ASSERT_GV_SETREF;
4012
4013     if (intro) {
4014         GvINTRO_off(dstr);      /* one-shot flag */
4015         GvLINE(dstr) = CopLINE(PL_curcop);
4016         GvEGV(dstr) = MUTABLE_GV(dstr);
4017     }
4018     GvMULTI_on(dstr);
4019     switch (stype) {
4020     case SVt_PVCV:
4021         location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
4022         import_flag = GVf_IMPORTED_CV;
4023         goto common;
4024     case SVt_PVHV:
4025         location = (SV **) &GvHV(dstr);
4026         import_flag = GVf_IMPORTED_HV;
4027         goto common;
4028     case SVt_PVAV:
4029         location = (SV **) &GvAV(dstr);
4030         import_flag = GVf_IMPORTED_AV;
4031         goto common;
4032     case SVt_PVIO:
4033         location = (SV **) &GvIOp(dstr);
4034         goto common;
4035     case SVt_PVFM:
4036         location = (SV **) &GvFORM(dstr);
4037         goto common;
4038     default:
4039         location = &GvSV(dstr);
4040         import_flag = GVf_IMPORTED_SV;
4041     common:
4042         if (intro) {
4043             if (stype == SVt_PVCV) {
4044                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
4045                 if (GvCVGEN(dstr)) {
4046                     SvREFCNT_dec(GvCV(dstr));
4047                     GvCV_set(dstr, NULL);
4048                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4049                 }
4050             }
4051             /* SAVEt_GVSLOT takes more room on the savestack and has more
4052                overhead in leave_scope than SAVEt_GENERIC_SV.  But for CVs
4053                leave_scope needs access to the GV so it can reset method
4054                caches.  We must use SAVEt_GVSLOT whenever the type is
4055                SVt_PVCV, even if the stash is anonymous, as the stash may
4056                gain a name somehow before leave_scope. */
4057             if (stype == SVt_PVCV) {
4058                 /* There is no save_pushptrptrptr.  Creating it for this
4059                    one call site would be overkill.  So inline the ss add
4060                    routines here. */
4061                 dSS_ADD;
4062                 SS_ADD_PTR(dstr);
4063                 SS_ADD_PTR(location);
4064                 SS_ADD_PTR(SvREFCNT_inc(*location));
4065                 SS_ADD_UV(SAVEt_GVSLOT);
4066                 SS_ADD_END(4);
4067             }
4068             else SAVEGENERICSV(*location);
4069         }
4070         dref = *location;
4071         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
4072             CV* const cv = MUTABLE_CV(*location);
4073             if (cv) {
4074                 if (!GvCVGEN((const GV *)dstr) &&
4075                     (CvROOT(cv) || CvXSUB(cv)) &&
4076                     /* redundant check that avoids creating the extra SV
4077                        most of the time: */
4078                     (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
4079                     {
4080                         SV * const new_const_sv =
4081                             CvCONST((const CV *)sref)
4082                                  ? cv_const_sv((const CV *)sref)
4083                                  : NULL;
4084                         HV * const stash = GvSTASH((const GV *)dstr);
4085                         report_redefined_cv(
4086                            sv_2mortal(
4087                              stash
4088                                ? Perl_newSVpvf(aTHX_
4089                                     "%" HEKf "::%" HEKf,
4090                                     HEKfARG(HvNAME_HEK(stash)),
4091                                     HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr))))
4092                                : Perl_newSVpvf(aTHX_
4093                                     "%" HEKf,
4094                                     HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr))))
4095                            ),
4096                            cv,
4097                            CvCONST((const CV *)sref) ? &new_const_sv : NULL
4098                         );
4099                     }
4100                 if (!intro)
4101                     cv_ckproto_len_flags(cv, (const GV *)dstr,
4102                                    SvPOK(sref) ? CvPROTO(sref) : NULL,
4103                                    SvPOK(sref) ? CvPROTOLEN(sref) : 0,
4104                                    SvPOK(sref) ? SvUTF8(sref) : 0);
4105             }
4106             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4107             GvASSUMECV_on(dstr);
4108             if(GvSTASH(dstr)) { /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
4109                 if (intro && GvREFCNT(dstr) > 1) {
4110                     /* temporary remove extra savestack's ref */
4111                     --GvREFCNT(dstr);
4112                     gv_method_changed(dstr);
4113                     ++GvREFCNT(dstr);
4114                 }
4115                 else gv_method_changed(dstr);
4116             }
4117         }
4118         *location = SvREFCNT_inc_simple_NN(sref);
4119         if (import_flag && !(GvFLAGS(dstr) & import_flag)
4120             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
4121             GvFLAGS(dstr) |= import_flag;
4122         }
4123
4124         if (stype == SVt_PVHV) {
4125             const char * const name = GvNAME((GV*)dstr);
4126             const STRLEN len = GvNAMELEN(dstr);
4127             if (
4128                 (
4129                    (len > 1 && name[len-2] == ':' && name[len-1] == ':')
4130                 || (len == 1 && name[0] == ':')
4131                 )
4132              && (!dref || HvENAME_get(dref))
4133             ) {
4134                 mro_package_moved(
4135                     (HV *)sref, (HV *)dref,
4136                     (GV *)dstr, 0
4137                 );
4138             }
4139         }
4140         else if (
4141             stype == SVt_PVAV && sref != dref
4142          && strEQ(GvNAME((GV*)dstr), "ISA")
4143          /* The stash may have been detached from the symbol table, so
4144             check its name before doing anything. */
4145          && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
4146         ) {
4147             MAGIC *mg;
4148             MAGIC * const omg = dref && SvSMAGICAL(dref)
4149                                  ? mg_find(dref, PERL_MAGIC_isa)
4150                                  : NULL;
4151             if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
4152                 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
4153                     AV * const ary = newAV();
4154                     av_push(ary, mg->mg_obj); /* takes the refcount */
4155                     mg->mg_obj = (SV *)ary;
4156                 }
4157                 if (omg) {
4158                     if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
4159                         SV **svp = AvARRAY((AV *)omg->mg_obj);
4160                         I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
4161                         while (items--)
4162                             av_push(
4163                              (AV *)mg->mg_obj,
4164                              SvREFCNT_inc_simple_NN(*svp++)
4165                             );
4166                     }
4167                     else
4168                         av_push(
4169                          (AV *)mg->mg_obj,
4170                          SvREFCNT_inc_simple_NN(omg->mg_obj)
4171                         );
4172                 }
4173                 else
4174                     av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
4175             }
4176             else
4177             {
4178                 SSize_t i;
4179                 sv_magic(
4180                  sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
4181                 );
4182                 for (i = 0; i <= AvFILL(sref); ++i) {
4183                     SV **elem = av_fetch ((AV*)sref, i, 0);
4184                     if (elem) {
4185                         sv_magic(
4186                           *elem, sref, PERL_MAGIC_isaelem, NULL, i
4187                         );
4188                     }
4189                 }
4190                 mg = mg_find(sref, PERL_MAGIC_isa);
4191             }
4192             /* Since the *ISA assignment could have affected more than
4193                one stash, don't call mro_isa_changed_in directly, but let
4194                magic_clearisa do it for us, as it already has the logic for
4195                dealing with globs vs arrays of globs. */
4196             assert(mg);
4197             Perl_magic_clearisa(aTHX_ NULL, mg);
4198         }
4199         else if (stype == SVt_PVIO) {
4200             DEBUG_o(Perl_deb(aTHX_ "gv_setref clearing PL_stashcache\n"));
4201             /* It's a cache. It will rebuild itself quite happily.
4202                It's a lot of effort to work out exactly which key (or keys)
4203                might be invalidated by the creation of the this file handle.
4204             */
4205             hv_clear(PL_stashcache);
4206         }
4207         break;
4208     }
4209     if (!intro) SvREFCNT_dec(dref);
4210     if (SvTAINTED(sstr))
4211         SvTAINT(dstr);
4212     return;
4213 }
4214
4215
4216
4217
4218 #ifdef PERL_DEBUG_READONLY_COW
4219 # include <sys/mman.h>
4220
4221 # ifndef PERL_MEMORY_DEBUG_HEADER_SIZE
4222 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4223 # endif
4224
4225 void
4226 Perl_sv_buf_to_ro(pTHX_ SV *sv)
4227 {
4228     struct perl_memory_debug_header * const header =
4229         (struct perl_memory_debug_header *)(SvPVX(sv)-PERL_MEMORY_DEBUG_HEADER_SIZE);
4230     const MEM_SIZE len = header->size;
4231     PERL_ARGS_ASSERT_SV_BUF_TO_RO;
4232 # ifdef PERL_TRACK_MEMPOOL
4233     if (!header->readonly) header->readonly = 1;
4234 # endif
4235     if (mprotect(header, len, PROT_READ))
4236         Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
4237                          header, len, errno);
4238 }
4239
4240 static void
4241 S_sv_buf_to_rw(pTHX_ SV *sv)
4242 {
4243     struct perl_memory_debug_header * const header =
4244         (struct perl_memory_debug_header *)(SvPVX(sv)-PERL_MEMORY_DEBUG_HEADER_SIZE);
4245     const MEM_SIZE len = header->size;
4246     PERL_ARGS_ASSERT_SV_BUF_TO_RW;
4247     if (mprotect(header, len, PROT_READ|PROT_WRITE))
4248         Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
4249                          header, len, errno);
4250 # ifdef PERL_TRACK_MEMPOOL
4251     header->readonly = 0;
4252 # endif
4253 }
4254
4255 #else
4256 # define sv_buf_to_ro(sv)       NOOP
4257 # define sv_buf_to_rw(sv)       NOOP
4258 #endif
4259
4260 void
4261 Perl_sv_setsv_flags(pTHX_ SV *dstr, SV* sstr, const I32 flags)
4262 {
4263     U32 sflags;
4264     int dtype;
4265     svtype stype;
4266     unsigned int both_type;
4267
4268     PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
4269
4270     if (UNLIKELY( sstr == dstr ))
4271         return;
4272
4273     if (UNLIKELY( !sstr ))
4274         sstr = &PL_sv_undef;
4275
4276     stype = SvTYPE(sstr);
4277     dtype = SvTYPE(dstr);
4278     both_type = (stype | dtype);
4279
4280     /* with these values, we can check that both SVs are NULL/IV (and not
4281      * freed) just by testing the or'ed types */
4282     STATIC_ASSERT_STMT(SVt_NULL == 0);
4283     STATIC_ASSERT_STMT(SVt_IV   == 1);
4284     if (both_type <= 1) {
4285         /* both src and dst are UNDEF/IV/RV, so we can do a lot of
4286          * special-casing */
4287         U32 sflags;
4288         U32 new_dflags;
4289         SV *old_rv = NULL;
4290
4291         /* minimal subset of SV_CHECK_THINKFIRST_COW_DROP(dstr) */
4292         if (SvREADONLY(dstr))
4293             Perl_croak_no_modify();
4294         if (SvROK(dstr)) {
4295             if (SvWEAKREF(dstr))
4296                 sv_unref_flags(dstr, 0);
4297             else
4298                 old_rv = SvRV(dstr);
4299         }
4300
4301         assert(!SvGMAGICAL(sstr));
4302         assert(!SvGMAGICAL(dstr));
4303
4304         sflags = SvFLAGS(sstr);
4305         if (sflags & (SVf_IOK|SVf_ROK)) {
4306             SET_SVANY_FOR_BODYLESS_IV(dstr);
4307             new_dflags = SVt_IV;
4308
4309             if (sflags & SVf_ROK) {
4310                 dstr->sv_u.svu_rv = SvREFCNT_inc(SvRV(sstr));
4311                 new_dflags |= SVf_ROK;
4312             }
4313             else {
4314                 /* both src and dst are <= SVt_IV, so sv_any points to the
4315                  * head; so access the head directly
4316                  */
4317                 assert(    &(sstr->sv_u.svu_iv)
4318                         == &(((XPVIV*) SvANY(sstr))->xiv_iv));
4319                 assert(    &(dstr->sv_u.svu_iv)
4320                         == &(((XPVIV*) SvANY(dstr))->xiv_iv));
4321                 dstr->sv_u.svu_iv = sstr->sv_u.svu_iv;
4322                 new_dflags |= (SVf_IOK|SVp_IOK|(sflags & SVf_IVisUV));
4323             }
4324         }
4325         else {
4326             new_dflags = dtype; /* turn off everything except the type */
4327         }
4328         SvFLAGS(dstr) = new_dflags;
4329         SvREFCNT_dec(old_rv);
4330
4331         return;
4332     }
4333
4334     if (UNLIKELY(both_type == SVTYPEMASK)) {
4335         if (SvIS_FREED(dstr)) {
4336             Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
4337                        " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
4338         }
4339         if (SvIS_FREED(sstr)) {
4340             Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
4341                        (void*)sstr, (void*)dstr);
4342         }
4343     }
4344
4345
4346
4347     SV_CHECK_THINKFIRST_COW_DROP(dstr);
4348     dtype = SvTYPE(dstr); /* THINKFIRST may have changed type */
4349
4350     /* There's a lot of redundancy below but we're going for speed here */
4351
4352     switch (stype) {
4353     case SVt_NULL:
4354       undef_sstr:
4355         if (LIKELY( dtype != SVt_PVGV && dtype != SVt_PVLV )) {
4356             (void)SvOK_off(dstr);
4357             return;
4358         }
4359         break;
4360     case SVt_IV:
4361         if (SvIOK(sstr)) {
4362             switch (dtype) {
4363             case SVt_NULL:
4364                 /* For performance, we inline promoting to type SVt_IV. */
4365                 /* We're starting from SVt_NULL, so provided that define is
4366                  * actual 0, we don't have to unset any SV type flags
4367                  * to promote to SVt_IV. */
4368                 STATIC_ASSERT_STMT(SVt_NULL == 0);
4369                 SET_SVANY_FOR_BODYLESS_IV(dstr);
4370                 SvFLAGS(dstr) |= SVt_IV;
4371                 break;
4372             case SVt_NV:
4373             case SVt_PV:
4374                 sv_upgrade(dstr, SVt_PVIV);
4375                 break;
4376             case SVt_PVGV:
4377             case SVt_PVLV:
4378                 goto end_of_first_switch;
4379             }
4380             (void)SvIOK_only(dstr);
4381             SvIV_set(dstr,  SvIVX(sstr));
4382             if (SvIsUV(sstr))
4383                 SvIsUV_on(dstr);
4384             /* SvTAINTED can only be true if the SV has taint magic, which in
4385                turn means that the SV type is PVMG (or greater). This is the
4386                case statement for SVt_IV, so this cannot be true (whatever gcov
4387                may say).  */
4388             assert(!SvTAINTED(sstr));
4389             return;
4390         }
4391         if (!SvROK(sstr))
4392             goto undef_sstr;
4393         if (dtype < SVt_PV && dtype != SVt_IV)
4394             sv_upgrade(dstr, SVt_IV);
4395         break;
4396
4397     case SVt_NV:
4398         if (LIKELY( SvNOK(sstr) )) {
4399             switch (dtype) {
4400             case SVt_NULL:
4401             case SVt_IV:
4402                 sv_upgrade(dstr, SVt_NV);
4403                 break;
4404             case SVt_PV:
4405             case SVt_PVIV:
4406                 sv_upgrade(dstr, SVt_PVNV);
4407                 break;
4408             case SVt_PVGV:
4409             case SVt_PVLV:
4410                 goto end_of_first_switch;
4411             }
4412             SvNV_set(dstr, SvNVX(sstr));
4413             (void)SvNOK_only(dstr);
4414             /* SvTAINTED can only be true if the SV has taint magic, which in
4415                turn means that the SV type is PVMG (or greater). This is the
4416                case statement for SVt_NV, so this cannot be true (whatever gcov
4417                may say).  */
4418             assert(!SvTAINTED(sstr));
4419             return;
4420         }
4421         goto undef_sstr;
4422
4423     case SVt_PV:
4424         if (dtype < SVt_PV)
4425             sv_upgrade(dstr, SVt_PV);
4426         break;
4427     case SVt_PVIV:
4428         if (dtype < SVt_PVIV)
4429             sv_upgrade(dstr, SVt_PVIV);
4430         break;
4431     case SVt_PVNV:
4432         if (dtype < SVt_PVNV)
4433             sv_upgrade(dstr, SVt_PVNV);
4434         break;
4435     default:
4436         {
4437         const char * const type = sv_reftype(sstr,0);
4438         if (PL_op)
4439             /* diag_listed_as: Bizarre copy of %s */
4440             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4441         else
4442             Perl_croak(aTHX_ "Bizarre copy of %s", type);
4443         }
4444         NOT_REACHED; /* NOTREACHED */
4445
4446     case SVt_REGEXP:
4447       upgregexp:
4448         if (dtype < SVt_REGEXP)
4449         {
4450             if (dtype >= SVt_PV) {
4451                 SvPV_free(dstr);
4452                 SvPV_set(dstr, 0);
4453                 SvLEN_set(dstr, 0);
4454                 SvCUR_set(dstr, 0);
4455             }
4456             sv_upgrade(dstr, SVt_REGEXP);
4457         }
4458         break;
4459
4460         case SVt_INVLIST:
4461     case SVt_PVLV:
4462     case SVt_PVGV:
4463     case SVt_PVMG:
4464         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4465             mg_get(sstr);
4466             if (SvTYPE(sstr) != stype)
4467                 stype = SvTYPE(sstr);
4468         }
4469         if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4470                     glob_assign_glob(dstr, sstr, dtype);
4471                     return;
4472         }
4473         if (stype == SVt_PVLV)
4474         {
4475             if (isREGEXP(sstr)) goto upgregexp;
4476             SvUPGRADE(dstr, SVt_PVNV);
4477         }
4478         else
4479             SvUPGRADE(dstr, (svtype)stype);
4480     }
4481  end_of_first_switch:
4482
4483     /* dstr may have been upgraded.  */
4484     dtype = SvTYPE(dstr);
4485     sflags = SvFLAGS(sstr);
4486
4487     if (UNLIKELY( dtype == SVt_PVCV )) {
4488         /* Assigning to a subroutine sets the prototype.  */
4489         if (SvOK(sstr)) {
4490             STRLEN len;
4491             const char *const ptr = SvPV_const(sstr, len);
4492
4493             SvGROW(dstr, len + 1);
4494             Copy(ptr, SvPVX(dstr), len + 1, char);
4495             SvCUR_set(dstr, len);
4496             SvPOK_only(dstr);
4497             SvFLAGS(dstr) |= sflags & SVf_UTF8;
4498             CvAUTOLOAD_off(dstr);
4499         } else {
4500             SvOK_off(dstr);
4501         }
4502     }
4503     else if (UNLIKELY(dtype == SVt_PVAV || dtype == SVt_PVHV
4504              || dtype == SVt_PVFM))
4505     {
4506         const char * const type = sv_reftype(dstr,0);
4507         if (PL_op)
4508             /* diag_listed_as: Cannot copy to %s */
4509             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4510         else
4511             Perl_croak(aTHX_ "Cannot copy to %s", type);
4512     } else if (sflags & SVf_ROK) {
4513         if (isGV_with_GP(dstr)
4514             && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4515             sstr = SvRV(sstr);
4516             if (sstr == dstr) {
4517                 if (GvIMPORTED(dstr) != GVf_IMPORTED
4518                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4519                 {
4520                     GvIMPORTED_on(dstr);
4521                 }
4522                 GvMULTI_on(dstr);
4523                 return;
4524             }
4525             glob_assign_glob(dstr, sstr, dtype);
4526             return;
4527         }
4528
4529         if (dtype >= SVt_PV) {
4530             if (isGV_with_GP(dstr)) {
4531                 gv_setref(dstr, sstr);
4532                 return;
4533             }
4534             if (SvPVX_const(dstr)) {
4535                 SvPV_free(dstr);
4536                 SvLEN_set(dstr, 0);
4537                 SvCUR_set(dstr, 0);
4538             }
4539         }
4540         (void)SvOK_off(dstr);
4541         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4542         SvFLAGS(dstr) |= sflags & SVf_ROK;
4543         assert(!(sflags & SVp_NOK));
4544         assert(!(sflags & SVp_IOK));
4545         assert(!(sflags & SVf_NOK));
4546         assert(!(sflags & SVf_IOK));
4547     }
4548     else if (isGV_with_GP(dstr)) {
4549         if (!(sflags & SVf_OK)) {
4550             Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4551                            "Undefined value assigned to typeglob");
4552         }
4553         else {
4554             GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4555             if (dstr != (const SV *)gv) {
4556                 const char * const name = GvNAME((const GV *)dstr);
4557                 const STRLEN len = GvNAMELEN(dstr);
4558                 HV *old_stash = NULL;
4559                 bool reset_isa = FALSE;
4560                 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4561                  || (len == 1 && name[0] == ':')) {
4562                     /* Set aside the old stash, so we can reset isa caches
4563                        on its subclasses. */
4564                     if((old_stash = GvHV(dstr))) {
4565                         /* Make sure we do not lose it early. */
4566                         SvREFCNT_inc_simple_void_NN(
4567                          sv_2mortal((SV *)old_stash)
4568                         );
4569                     }
4570                     reset_isa = TRUE;
4571                 }
4572
4573                 if (GvGP(dstr)) {
4574                     SvREFCNT_inc_simple_void_NN(sv_2mortal(dstr));
4575                     gp_free(MUTABLE_GV(dstr));
4576                 }
4577                 GvGP_set(dstr, gp_ref(GvGP(gv)));
4578
4579                 if (reset_isa) {
4580                     HV * const stash = GvHV(dstr);
4581                     if(
4582                         old_stash ? (HV *)HvENAME_get(old_stash) : stash
4583                     )
4584                         mro_package_moved(
4585                          stash, old_stash,
4586                          (GV *)dstr, 0
4587                         );
4588                 }
4589             }
4590         }
4591     }
4592     else if ((dtype == SVt_REGEXP || dtype == SVt_PVLV)
4593           && (stype == SVt_REGEXP || isREGEXP(sstr))) {
4594         reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4595     }
4596     else if (sflags & SVp_POK) {
4597         const STRLEN cur = SvCUR(sstr);
4598         const STRLEN len = SvLEN(sstr);
4599
4600         /*
4601          * We have three basic ways to copy the string:
4602          *
4603          *  1. Swipe
4604          *  2. Copy-on-write
4605          *  3. Actual copy
4606          * 
4607          * Which we choose is based on various factors.  The following
4608          * things are listed in order of speed, fastest to slowest:
4609          *  - Swipe
4610          *  - Copying a short string
4611          *  - Copy-on-write bookkeeping
4612          *  - malloc
4613          *  - Copying a long string
4614          * 
4615          * We swipe the string (steal the string buffer) if the SV on the
4616          * rhs is about to be freed anyway (TEMP and refcnt==1).  This is a
4617          * big win on long strings.  It should be a win on short strings if
4618          * SvPVX_const(dstr) has to be allocated.  If not, it should not 
4619          * slow things down, as SvPVX_const(sstr) would have been freed
4620          * soon anyway.
4621          * 
4622          * We also steal the buffer from a PADTMP (operator target) if it
4623          * is ‘long enough’.  For short strings, a swipe does not help
4624          * here, as it causes more malloc calls the next time the target
4625          * is used.  Benchmarks show that even if SvPVX_const(dstr) has to
4626          * be allocated it is still not worth swiping PADTMPs for short
4627          * strings, as the savings here are small.
4628          * 
4629          * If swiping is not an option, then we see whether it is
4630          * worth using copy-on-write.  If the lhs already has a buf-
4631          * fer big enough and the string is short, we skip it and fall back
4632          * to method 3, since memcpy is faster for short strings than the
4633          * later bookkeeping overhead that copy-on-write entails.
4634
4635          * If the rhs is not a copy-on-write string yet, then we also
4636          * consider whether the buffer is too large relative to the string
4637          * it holds.  Some operations such as readline allocate a large
4638          * buffer in the expectation of reusing it.  But turning such into
4639          * a COW buffer is counter-productive because it increases memory
4640          * usage by making readline allocate a new large buffer the sec-
4641          * ond time round.  So, if the buffer is too large, again, we use
4642          * method 3 (copy).
4643          * 
4644          * Finally, if there is no buffer on the left, or the buffer is too 
4645          * small, then we use copy-on-write and make both SVs share the
4646          * string buffer.
4647          *
4648          */
4649
4650         /* Whichever path we take through the next code, we want this true,
4651            and doing it now facilitates the COW check.  */
4652         (void)SvPOK_only(dstr);
4653
4654         if (
4655                  (              /* Either ... */
4656                                 /* slated for free anyway (and not COW)? */
4657                     (sflags & (SVs_TEMP|SVf_IsCOW)) == SVs_TEMP
4658                                 /* or a swipable TARG */
4659                  || ((sflags &
4660                            (SVs_PADTMP|SVf_READONLY|SVf_PROTECT|SVf_IsCOW))
4661                        == SVs_PADTMP
4662                                 /* whose buffer is worth stealing */
4663                      && CHECK_COWBUF_THRESHOLD(cur,len)
4664                     )
4665                  ) &&
4666                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4667                  (!(flags & SV_NOSTEAL)) &&
4668                                         /* and we're allowed to steal temps */
4669                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4670                  len)             /* and really is a string */
4671         {       /* Passes the swipe test.  */
4672             if (SvPVX_const(dstr))      /* we know that dtype >= SVt_PV */
4673                 SvPV_free(dstr);
4674             SvPV_set(dstr, SvPVX_mutable(sstr));
4675             SvLEN_set(dstr, SvLEN(sstr));
4676             SvCUR_set(dstr, SvCUR(sstr));
4677
4678             SvTEMP_off(dstr);
4679             (void)SvOK_off(sstr);       /* NOTE: nukes most SvFLAGS on sstr */
4680             SvPV_set(sstr, NULL);
4681             SvLEN_set(sstr, 0);
4682             SvCUR_set(sstr, 0);
4683             SvTEMP_off(sstr);
4684         }
4685         else if (flags & SV_COW_SHARED_HASH_KEYS
4686               &&
4687 #ifdef PERL_COPY_ON_WRITE
4688                  (sflags & SVf_IsCOW
4689                    ? (!len ||
4690                        (  (CHECK_COWBUF_THRESHOLD(cur,len) || SvLEN(dstr) < cur+1)
4691                           /* If this is a regular (non-hek) COW, only so
4692                              many COW "copies" are possible. */
4693                        && CowREFCNT(sstr) != SV_COW_REFCNT_MAX  ))
4694                    : (  (sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4695                      && !(SvFLAGS(dstr) & SVf_BREAK)
4696                      && CHECK_COW_THRESHOLD(cur,len) && cur+1 < len
4697                      && (CHECK_COWBUF_THRESHOLD(cur,len) || SvLEN(dstr) < cur+1)
4698                     ))
4699 #else
4700                  sflags & SVf_IsCOW
4701               && !(SvFLAGS(dstr) & SVf_BREAK)
4702 #endif
4703             ) {
4704             /* Either it's a shared hash key, or it's suitable for
4705                copy-on-write.  */
4706             if (DEBUG_C_TEST) {
4707                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4708                 sv_dump(sstr);
4709                 sv_dump(dstr);
4710             }
4711 #ifdef PERL_ANY_COW
4712             if (!(sflags & SVf_IsCOW)) {
4713                     SvIsCOW_on(sstr);
4714                     CowREFCNT(sstr) = 0;
4715             }
4716 #endif
4717             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
4718                 SvPV_free(dstr);
4719             }
4720
4721 #ifdef PERL_ANY_COW
4722             if (len) {
4723                     if (sflags & SVf_IsCOW) {
4724                         sv_buf_to_rw(sstr);
4725                     }
4726                     CowREFCNT(sstr)++;
4727                     SvPV_set(dstr, SvPVX_mutable(sstr));
4728                     sv_buf_to_ro(sstr);
4729             } else
4730 #endif
4731             {
4732                     /* SvIsCOW_shared_hash */
4733                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4734                                           "Copy on write: Sharing hash\n"));
4735
4736                     assert (SvTYPE(dstr) >= SVt_PV);
4737                     SvPV_set(dstr,
4738                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4739             }
4740             SvLEN_set(dstr, len);
4741             SvCUR_set(dstr, cur);
4742             SvIsCOW_on(dstr);
4743         } else {
4744             /* Failed the swipe test, and we cannot do copy-on-write either.
4745                Have to copy the string.  */
4746             SvGROW(dstr, cur + 1);      /* inlined from sv_setpvn */
4747             Move(SvPVX_const(sstr),SvPVX(dstr),cur,char);
4748             SvCUR_set(dstr, cur);
4749             *SvEND(dstr) = '\0';
4750         }
4751         if (sflags & SVp_NOK) {
4752             SvNV_set(dstr, SvNVX(sstr));
4753         }
4754         if (sflags & SVp_IOK) {
4755             SvIV_set(dstr, SvIVX(sstr));
4756             if (sflags & SVf_IVisUV)
4757                 SvIsUV_on(dstr);
4758         }
4759         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4760         {
4761             const MAGIC * const smg = SvVSTRING_mg(sstr);
4762             if (smg) {
4763                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4764                          smg->mg_ptr, smg->mg_len);
4765                 SvRMAGICAL_on(dstr);
4766             }
4767         }
4768     }
4769     else if (sflags & (SVp_IOK|SVp_NOK)) {
4770         (void)SvOK_off(dstr);
4771         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4772         if (sflags & SVp_IOK) {
4773             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4774             SvIV_set(dstr, SvIVX(sstr));
4775         }
4776         if (sflags & SVp_NOK) {
4777             SvNV_set(dstr, SvNVX(sstr));
4778         }
4779     }
4780     else {
4781         if (isGV_with_GP(sstr)) {
4782             gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4783         }
4784         else
4785             (void)SvOK_off(dstr);
4786     }
4787     if (SvTAINTED(sstr))
4788         SvTAINT(dstr);
4789 }
4790
4791
4792 /*
4793 =for apidoc sv_set_undef
4794
4795 Equivalent to C<sv_setsv(sv, &PL_sv_undef)>, but more efficient.
4796 Doesn't handle set magic.
4797
4798 The perl equivalent is C<$sv = undef;>. Note that it doesn't free any string
4799 buffer, unlike C<undef $sv>.
4800
4801 Introduced in perl 5.25.12.
4802
4803 =cut
4804 */
4805
4806 void
4807 Perl_sv_set_undef(pTHX_ SV *sv)
4808 {
4809     U32 type = SvTYPE(sv);
4810
4811     PERL_ARGS_ASSERT_SV_SET_UNDEF;
4812
4813     /* shortcut, NULL, IV, RV */
4814
4815     if (type <= SVt_IV) {
4816         assert(!SvGMAGICAL(sv));
4817         if (SvREADONLY(sv)) {
4818             /* does undeffing PL_sv_undef count as modifying a read-only
4819              * variable? Some XS code does this */
4820             if (sv == &PL_sv_undef)
4821                 return;
4822             Perl_croak_no_modify();
4823         }
4824
4825         if (SvROK(sv)) {
4826             if (SvWEAKREF(sv))
4827                 sv_unref_flags(sv, 0);
4828             else {
4829                 SV *rv = SvRV(sv);
4830                 SvFLAGS(sv) = type; /* quickly turn off all flags */
4831                 SvREFCNT_dec_NN(rv);
4832                 return;
4833             }
4834         }
4835         SvFLAGS(sv) = type; /* quickly turn off all flags */
4836         return;
4837     }
4838
4839     if (SvIS_FREED(sv))
4840         Perl_croak(aTHX_ "panic: attempt to undefine a freed scalar %p",
4841             (void *)sv);
4842
4843     SV_CHECK_THINKFIRST_COW_DROP(sv);
4844
4845     if (isGV_with_GP(sv))
4846         Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4847                        "Undefined value assigned to typeglob");
4848     else
4849         SvOK_off(sv);
4850 }
4851
4852
4853
4854 /*
4855 =for apidoc sv_setsv_mg
4856
4857 Like C<sv_setsv>, but also handles 'set' magic.
4858
4859 =cut
4860 */
4861
4862 void
4863 Perl_sv_setsv_mg(pTHX_ SV *const dstr, SV *const sstr)
4864 {
4865     PERL_ARGS_ASSERT_SV_SETSV_MG;
4866
4867     sv_setsv(dstr,sstr);
4868     SvSETMAGIC(dstr);
4869 }
4870
4871 #ifdef PERL_ANY_COW
4872 #  define SVt_COW SVt_PV
4873 SV *
4874 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4875 {
4876     STRLEN cur = SvCUR(sstr);
4877     STRLEN len = SvLEN(sstr);
4878     char *new_pv;
4879 #if defined(PERL_DEBUG_READONLY_COW) && defined(PERL_COPY_ON_WRITE)
4880     const bool already = cBOOL(SvIsCOW(sstr));
4881 #endif
4882
4883     PERL_ARGS_ASSERT_SV_SETSV_COW;
4884
4885     if (DEBUG_C_TEST) {
4886         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4887                       (void*)sstr, (void*)dstr);
4888         sv_dump(sstr);
4889         if (dstr)
4890                     sv_dump(dstr);
4891     }
4892
4893     if (dstr) {
4894         if (SvTHINKFIRST(dstr))
4895             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4896         else if (SvPVX_const(dstr))
4897             Safefree(SvPVX_mutable(dstr));
4898     }
4899     else
4900         new_SV(dstr);
4901     SvUPGRADE(dstr, SVt_COW);
4902
4903     assert (SvPOK(sstr));
4904     assert (SvPOKp(sstr));
4905
4906     if (SvIsCOW(sstr)) {
4907
4908         if (SvLEN(sstr) == 0) {
4909             /* source is a COW shared hash key.  */
4910             DEBUG_C(PerlIO_printf(Perl_debug_log,
4911                                   "Fast copy on write: Sharing hash\n"));
4912             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4913             goto common_exit;
4914         }
4915         assert(SvCUR(sstr)+1 < SvLEN(sstr));
4916         assert(CowREFCNT(sstr) < SV_COW_REFCNT_MAX);
4917     } else {
4918         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4919         SvUPGRADE(sstr, SVt_COW);
4920         SvIsCOW_on(sstr);
4921         DEBUG_C(PerlIO_printf(Perl_debug_log,
4922                               "Fast copy on write: Converting sstr to COW\n"));
4923         CowREFCNT(sstr) = 0;    
4924     }
4925 #  ifdef PERL_DEBUG_READONLY_COW
4926     if (already) sv_buf_to_rw(sstr);
4927 #  endif
4928     CowREFCNT(sstr)++;  
4929     new_pv = SvPVX_mutable(sstr);
4930     sv_buf_to_ro(sstr);
4931
4932   common_exit:
4933     SvPV_set(dstr, new_pv);
4934     SvFLAGS(dstr) = (SVt_COW|SVf_POK|SVp_POK|SVf_IsCOW);
4935     if (SvUTF8(sstr))
4936         SvUTF8_on(dstr);
4937     SvLEN_set(dstr, len);
4938     SvCUR_set(dstr, cur);
4939     if (DEBUG_C_TEST) {
4940         sv_dump(dstr);
4941     }
4942     return dstr;
4943 }
4944 #endif
4945
4946 /*
4947 =for apidoc sv_setpv_bufsize
4948
4949 Sets the SV to be a string of cur bytes length, with at least
4950 len bytes available. Ensures that there is a null byte at SvEND.
4951 Returns a char * pointer to the SvPV buffer.
4952
4953 =cut
4954 */
4955
4956 char *
4957 Perl_sv_setpv_bufsize(pTHX_ SV *const sv, const STRLEN cur, const STRLEN len)
4958 {
4959     char *pv;
4960
4961     PERL_ARGS_ASSERT_SV_SETPV_BUFSIZE;
4962
4963     SV_CHECK_THINKFIRST_COW_DROP(sv);
4964     SvUPGRADE(sv, SVt_PV);
4965     pv = SvGROW(sv, len + 1);
4966     SvCUR_set(sv, cur);
4967     *(SvEND(sv))= '\0';
4968     (void)SvPOK_only_UTF8(sv);                /* validate pointer */
4969
4970     SvTAINT(sv);
4971     if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4972     return pv;
4973 }
4974
4975 /*
4976 =for apidoc sv_setpvn
4977
4978 Copies a string (possibly containing embedded C<NUL> characters) into an SV.
4979 The C<len> parameter indicates the number of
4980 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4981 undefined.  Does not handle 'set' magic.  See C<L</sv_setpvn_mg>>.
4982
4983 =cut
4984 */
4985
4986 void
4987 Perl_sv_setpvn(pTHX_ SV *const sv, const char *const ptr, const STRLEN len)
4988 {
4989     char *dptr;
4990
4991     PERL_ARGS_ASSERT_SV_SETPVN;
4992
4993     SV_CHECK_THINKFIRST_COW_DROP(sv);
4994     if (isGV_with_GP(sv))
4995         Perl_croak_no_modify();
4996     if (!ptr) {
4997         (void)SvOK_off(sv);
4998         return;
4999     }
5000     else {
5001         /* len is STRLEN which is unsigned, need to copy to signed */
5002         const IV iv = len;
5003         if (iv < 0)
5004             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
5005                        IVdf, iv);
5006     }
5007     SvUPGRADE(sv, SVt_PV);
5008
5009     dptr = SvGROW(sv, len + 1);
5010     Move(ptr,dptr,len,char);
5011     dptr[len] = '\0';
5012     SvCUR_set(sv, len);
5013     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
5014     SvTAINT(sv);
5015     if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
5016 }
5017
5018 /*
5019 =for apidoc sv_setpvn_mg
5020
5021 Like C<sv_setpvn>, but also handles 'set' magic.
5022
5023 =cut
5024 */
5025
5026 void
5027 Perl_sv_setpvn_mg(pTHX_ SV *const sv, const char *const ptr, const STRLEN len)
5028 {
5029     PERL_ARGS_ASSERT_SV_SETPVN_MG;
5030
5031     sv_setpvn(sv,ptr,len);
5032     SvSETMAGIC(sv);
5033 }
5034
5035 /*
5036 =for apidoc sv_setpv
5037
5038 Copies a string into an SV.  The string must be terminated with a C<NUL>
5039 character, and not contain embeded C<NUL>'s.
5040 Does not handle 'set' magic.  See C<L</sv_setpv_mg>>.
5041
5042 =cut
5043 */
5044
5045 void
5046 Perl_sv_setpv(pTHX_ SV *const sv, const char *const ptr)
5047 {
5048     STRLEN len;
5049
5050     PERL_ARGS_ASSERT_SV_SETPV;
5051
5052     SV_CHECK_THINKFIRST_COW_DROP(sv);
5053     if (!ptr) {
5054         (void)SvOK_off(sv);
5055         return;
5056     }
5057     len = strlen(ptr);
5058     SvUPGRADE(sv, SVt_PV);
5059
5060     SvGROW(sv, len + 1);
5061     Move(ptr,SvPVX(sv),len+1,char);
5062     SvCUR_set(sv, len);
5063     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
5064     SvTAINT(sv);
5065     if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
5066 }
5067
5068 /*
5069 =for apidoc sv_setpv_mg
5070
5071 Like C<sv_setpv>, but also handles 'set' magic.
5072
5073 =cut
5074 */
5075
5076 void
5077 Perl_sv_setpv_mg(pTHX_ SV *const sv, const char *const ptr)
5078 {
5079     PERL_ARGS_ASSERT_SV_SETPV_MG;
5080
5081     sv_setpv(sv,ptr);
5082     SvSETMAGIC(sv);
5083 }
5084
5085 void
5086 Perl_sv_sethek(pTHX_ SV *const sv, const HEK *const hek)
5087 {
5088     PERL_ARGS_ASSERT_SV_SETHEK;
5089
5090     if (!hek) {
5091         return;
5092     }
5093
5094     if (HEK_LEN(hek) == HEf_SVKEY) {
5095         sv_setsv(sv, *(SV**)HEK_KEY(hek));
5096         return;
5097     } else {
5098         const int flags = HEK_FLAGS(hek);
5099         if (flags & HVhek_WASUTF8) {
5100             STRLEN utf8_len = HEK_LEN(hek);
5101             char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
5102             sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
5103             SvUTF8_on(sv);
5104             return;
5105         } else if (flags & HVhek_UNSHARED) {
5106             sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
5107             if (HEK_UTF8(hek))
5108                 SvUTF8_on(sv);
5109             else SvUTF8_off(sv);
5110             return;
5111         }
5112         {
5113             SV_CHECK_THINKFIRST_COW_DROP(sv);
5114             SvUPGRADE(sv, SVt_PV);
5115             SvPV_free(sv);
5116             SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
5117             SvCUR_set(sv, HEK_LEN(hek));
5118             SvLEN_set(sv, 0);
5119             SvIsCOW_on(sv);
5120             SvPOK_on(sv);
5121             if (HEK_UTF8(hek))
5122                 SvUTF8_on(sv);
5123             else SvUTF8_off(sv);
5124             return;
5125         }
5126     }
5127 }
5128
5129
5130 /*
5131 =for apidoc sv_usepvn_flags
5132
5133 Tells an SV to use C<ptr> to find its string value.  Normally the
5134 string is stored inside the SV, but sv_usepvn allows the SV to use an
5135 outside string.  C<ptr> should point to memory that was allocated
5136 by L<C<Newx>|perlclib/Memory Management and String Handling>.  It must be
5137 the start of a C<Newx>-ed block of memory, and not a pointer to the
5138 middle of it (beware of L<C<OOK>|perlguts/Offsets> and copy-on-write),
5139 and not be from a non-C<Newx> memory allocator like C<malloc>.  The
5140 string length, C<len>, must be supplied.  By default this function
5141 will C<Renew> (i.e. realloc, move) the memory pointed to by C<ptr>,
5142 so that pointer should not be freed or used by the programmer after
5143 giving it to C<sv_usepvn>, and neither should any pointers from "behind"
5144 that pointer (e.g. ptr + 1) be used.
5145
5146 If S<C<flags & SV_SMAGIC>> is true, will call C<SvSETMAGIC>.  If
5147 S<C<flags> & SV_HAS_TRAILING_NUL>> is true, then C<ptr[len]> must be C<NUL>,
5148 and the realloc
5149 will be skipped (i.e. the buffer is actually at least 1 byte longer than
5150 C<len>, and already meets the requirements for storing in C<SvPVX>).
5151
5152 =cut
5153 */
5154
5155 void
5156 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
5157 {
5158     STRLEN allocate;
5159
5160     PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
5161
5162     SV_CHECK_THINKFIRST_COW_DROP(sv);
5163     SvUPGRADE(sv, SVt_PV);
5164     if (!ptr) {
5165         (void)SvOK_off(sv);
5166         if (flags & SV_SMAGIC)
5167             SvSETMAGIC(sv);
5168         return;
5169     }
5170     if (SvPVX_const(sv))
5171         SvPV_free(sv);
5172
5173 #ifdef DEBUGGING
5174     if (flags & SV_HAS_TRAILING_NUL)
5175         assert(ptr[len] == '\0');
5176 #endif
5177
5178     allocate = (flags & SV_HAS_TRAILING_NUL)
5179         ? len + 1 :
5180 #ifdef Perl_safesysmalloc_size
5181         len + 1;
5182 #else 
5183         PERL_STRLEN_ROUNDUP(len + 1);
5184 #endif
5185     if (flags & SV_HAS_TRAILING_NUL) {
5186         /* It's long enough - do nothing.
5187            Specifically Perl_newCONSTSUB is relying on this.  */
5188     } else {
5189 #ifdef DEBUGGING
5190         /* Force a move to shake out bugs in callers.  */
5191         char *new_ptr = (char*)safemalloc(allocate);
5192         Copy(ptr, new_ptr, len, char);
5193         PoisonFree(ptr,len,char);
5194         Safefree(ptr);
5195         ptr = new_ptr;
5196 #else
5197         ptr = (char*) saferealloc (ptr, allocate);
5198 #endif
5199     }
5200 #ifdef Perl_safesysmalloc_size
5201     SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
5202 #else
5203     SvLEN_set(sv, allocate);
5204 #endif
5205     SvCUR_set(sv, len);
5206     SvPV_set(sv, ptr);
5207     if (!(flags & SV_HAS_TRAILING_NUL)) {
5208         ptr[len] = '\0';
5209     }
5210     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
5211     SvTAINT(sv);
5212     if (flags & SV_SMAGIC)
5213         SvSETMAGIC(sv);
5214 }
5215
5216
5217 static void
5218 S_sv_uncow(pTHX_ SV * const sv, const U32 flags)
5219 {
5220     assert(SvIsCOW(sv));
5221     {
5222 #ifdef PERL_ANY_COW
5223         const char * const pvx = SvPVX_const(sv);
5224         const STRLEN len = SvLEN(sv);
5225         const STRLEN cur = SvCUR(sv);
5226
5227         if (DEBUG_C_TEST) {
5228                 PerlIO_printf(Perl_debug_log,
5229                               "Copy on write: Force normal %ld\n",
5230                               (long) flags);
5231                 sv_dump(sv);
5232         }
5233         SvIsCOW_off(sv);
5234 # ifdef PERL_COPY_ON_WRITE
5235         if (len) {
5236             /* Must do this first, since the CowREFCNT uses SvPVX and
5237             we need to write to CowREFCNT, or de-RO the whole buffer if we are
5238             the only owner left of the buffer. */
5239             sv_buf_to_rw(sv); /* NOOP if RO-ing not supported */
5240             {
5241                 U8 cowrefcnt = CowREFCNT(sv);
5242                 if(cowrefcnt != 0) {
5243                     cowrefcnt--;
5244                     CowREFCNT(sv) = cowrefcnt;
5245                     sv_buf_to_ro(sv);
5246                     goto copy_over;
5247                 }
5248             }
5249             /* Else we are the only owner of the buffer. */
5250         }
5251         else
5252 # endif
5253         {
5254             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
5255             copy_over:
5256             SvPV_set(sv, NULL);
5257             SvCUR_set(sv, 0);
5258             SvLEN_set(sv, 0);
5259             if (flags & SV_COW_DROP_PV) {
5260                 /* OK, so we don't need to copy our buffer.  */
5261                 SvPOK_off(sv);
5262             } else {
5263                 SvGROW(sv, cur + 1);
5264                 Move(pvx,SvPVX(sv),cur,char);
5265                 SvCUR_set(sv, cur);
5266                 *SvEND(sv) = '\0';
5267             }
5268             if (len) {
5269             } else {
5270                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
5271             }
5272             if (DEBUG_C_TEST) {
5273                 sv_dump(sv);
5274             }
5275         }
5276 #else
5277             const char * const pvx = SvPVX_const(sv);
5278             const STRLEN len = SvCUR(sv);
5279             SvIsCOW_off(sv);
5280             SvPV_set(sv, NULL);
5281             SvLEN_set(sv, 0);
5282             if (flags & SV_COW_DROP_PV) {
5283                 /* OK, so we don't need to copy our buffer.  */
5284                 SvPOK_off(sv);
5285             } else {
5286                 SvGROW(sv, len + 1);
5287                 Move(pvx,SvPVX(sv),len,char);
5288                 *SvEND(sv) = '\0';
5289             }
5290             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
5291 #endif
5292     }
5293 }
5294
5295
5296 /*
5297 =for apidoc sv_force_normal_flags
5298
5299 Undo various types of fakery on an SV, where fakery means
5300 "more than" a string: if the PV is a shared string, make
5301 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5302 an C<xpvmg>; if we're a copy-on-write scalar, this is the on-write time when
5303 we do the copy, and is also used locally; if this is a
5304 vstring, drop the vstring magic.  If C<SV_COW_DROP_PV> is set
5305 then a copy-on-write scalar drops its PV buffer (if any) and becomes
5306 C<SvPOK_off> rather than making a copy.  (Used where this
5307 scalar is about to be set to some other value.)  In addition,
5308 the C<flags> parameter gets passed to C<sv_unref_flags()>
5309 when unreffing.  C<sv_force_normal> calls this function
5310 with flags set to 0.
5311
5312 This function is expected to be used to signal to perl that this SV is
5313 about to be written to, and any extra book-keeping needs to be taken care
5314 of.  Hence, it croaks on read-only values.
5315
5316 =cut
5317 */
5318
5319 void
5320 Perl_sv_force_normal_flags(pTHX_ SV *const sv, const U32 flags)
5321 {
5322     PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
5323
5324     if (SvREADONLY(sv))
5325         Perl_croak_no_modify();
5326     else if (SvIsCOW(sv) && LIKELY(SvTYPE(sv) != SVt_PVHV))
5327         S_sv_uncow(aTHX_ sv, flags);
5328     if (SvROK(sv))
5329         sv_unref_flags(sv, flags);
5330     else if (SvFAKE(sv) && isGV_with_GP(sv))
5331         sv_unglob(sv, flags);
5332     else if (SvFAKE(sv) && isREGEXP(sv)) {
5333         /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
5334            to sv_unglob. We only need it here, so inline it.  */
5335         const bool islv = SvTYPE(sv) == SVt_PVLV;
5336         const svtype new_type =
5337           islv ? SVt_NULL : SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
5338         SV *const temp = newSV_type(new_type);
5339         regexp *const temp_p = ReANY((REGEXP *)sv);
5340
5341         if (new_type == SVt_PVMG) {
5342             SvMAGIC_set(temp, SvMAGIC(sv));
5343             SvMAGIC_set(sv, NULL);
5344             SvSTASH_set(temp, SvSTASH(sv));
5345             SvSTASH_set(sv, NULL);
5346         }
5347         if (!islv) SvCUR_set(temp, SvCUR(sv));
5348         /* Remember that SvPVX is in the head, not the body.  But
5349            RX_WRAPPED is in the body. */
5350         assert(ReANY((REGEXP *)sv)->mother_re);
5351         /* Their buffer is already owned by someone else. */
5352         if (flags & SV_COW_DROP_PV) {
5353             /* SvLEN is already 0.  For SVt_REGEXP, we have a brand new
5354                zeroed body.  For SVt_PVLV, it should have been set to 0
5355                before turning into a regexp. */
5356             assert(!SvLEN(islv ? sv : temp));
5357             sv->sv_u.svu_pv = 0;
5358         }
5359         else {
5360             sv->sv_u.svu_pv = savepvn(RX_WRAPPED((REGEXP *)sv), SvCUR(sv));
5361             SvLEN_set(islv ? sv : temp, SvCUR(sv)+1);
5362             SvPOK_on(sv);
5363         }
5364
5365         /* Now swap the rest of the bodies. */
5366
5367         SvFAKE_off(sv);
5368         if (!islv) {
5369             SvFLAGS(sv) &= ~SVTYPEMASK;
5370             SvFLAGS(sv) |= new_type;
5371             SvANY(sv) = SvANY(temp);
5372         }
5373
5374         SvFLAGS(temp) &= ~(SVTYPEMASK);
5375         SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
5376         SvANY(temp) = temp_p;
5377         temp->sv_u.svu_rx = (regexp *)temp_p;
5378
5379         SvREFCNT_dec_NN(temp);
5380     }
5381     else if (SvVOK(sv)) sv_unmagic(sv, PERL_MAGIC_vstring);
5382 }
5383
5384 /*
5385 =for apidoc sv_chop
5386
5387 Efficient removal of characters from the beginning of the string buffer.
5388 C<SvPOK(sv)>, or at least C<SvPOKp(sv)>, must be true and C<ptr> must be a
5389 pointer to somewhere inside the string buffer.  C<ptr> becomes the first
5390 character of the adjusted string.  Uses the C<OOK> hack.  On return, only
5391 C<SvPOK(sv)> and C<SvPOKp(sv)> among the C<OK> flags will be true.
5392
5393 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5394 refer to the same chunk of data.
5395
5396 The unfortunate similarity of this function's name to that of Perl's C<chop>
5397 operator is strictly coincidental.  This function works from the left;
5398 C<chop> works from the right.
5399
5400 =cut
5401 */
5402
5403 void
5404 Perl_sv_chop(pTHX_ SV *const sv, const char *const ptr)
5405 {
5406     STRLEN delta;
5407     STRLEN old_delta;
5408     U8 *p;
5409 #ifdef DEBUGGING
5410     const U8 *evacp;
5411     STRLEN evacn;
5412 #endif
5413     STRLEN max_delta;
5414
5415     PERL_ARGS_ASSERT_SV_CHOP;
5416
5417     if (!ptr || !SvPOKp(sv))
5418         return;
5419     delta = ptr - SvPVX_const(sv);
5420     if (!delta) {
5421         /* Nothing to do.  */
5422         return;
5423     }
5424     max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
5425     if (delta > max_delta)
5426         Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
5427                    ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
5428     /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
5429     SV_CHECK_THINKFIRST(sv);
5430     SvPOK_only_UTF8(sv);
5431
5432     if (!SvOOK(sv)) {
5433         if (!SvLEN(sv)) { /* make copy of shared string */
5434             const char *pvx = SvPVX_const(sv);
5435             const STRLEN len = SvCUR(sv);
5436             SvGROW(sv, len + 1);
5437             Move(pvx,SvPVX(sv),len,char);
5438             *SvEND(sv) = '\0';
5439         }
5440         SvOOK_on(sv);
5441         old_delta = 0;
5442     } else {
5443         SvOOK_offset(sv, old_delta);
5444     }
5445     SvLEN_set(sv, SvLEN(sv) - delta);
5446     SvCUR_set(sv, SvCUR(sv) - delta);
5447     SvPV_set(sv, SvPVX(sv) + delta);
5448
5449     p = (U8 *)SvPVX_const(sv);
5450
5451 #ifdef DEBUGGING
5452     /* how many bytes were evacuated?  we will fill them with sentinel
5453        bytes, except for the part holding the new offset of course. */
5454     evacn = delta;
5455     if (old_delta)
5456         evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
5457     assert(evacn);
5458     assert(evacn <= delta + old_delta);
5459     evacp = p - evacn;
5460 #endif
5461
5462     /* This sets 'delta' to the accumulated value of all deltas so far */
5463     delta += old_delta;
5464     assert(delta);
5465
5466     /* If 'delta' fits in a byte, store it just prior to the new beginning of
5467      * the string; otherwise store a 0 byte there and store 'delta' just prior
5468      * to that, using as many bytes as a STRLEN occupies.  Thus it overwrites a
5469      * portion of the chopped part of the string */
5470     if (delta < 0x100) {
5471         *--p = (U8) delta;
5472     } else {
5473         *--p = 0;
5474         p -= sizeof(STRLEN);
5475         Copy((U8*)&delta, p, sizeof(STRLEN), U8);
5476     }
5477
5478 #ifdef DEBUGGING
5479     /* Fill the preceding buffer with sentinals to verify that no-one is
5480        using it.  */
5481     while (p > evacp) {
5482         --p;
5483         *p = (U8)PTR2UV(p);
5484     }
5485 #endif
5486 }
5487
5488 /*
5489 =for apidoc sv_catpvn
5490
5491 Concatenates the string onto the end of the string which is in the SV.
5492 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
5493 status set, then the bytes appended should be valid UTF-8.
5494 Handles 'get' magic, but not 'set' magic.  See C<L</sv_catpvn_mg>>.
5495
5496 =for apidoc sv_catpvn_flags
5497
5498 Concatenates the string onto the end of the string which is in the SV.  The
5499 C<len> indicates number of bytes to copy.
5500
5501 By default, the string appended is assumed to be valid UTF-8 if the SV has
5502 the UTF-8 status set, and a string of bytes otherwise.  One can force the
5503 appended string to be interpreted as UTF-8 by supplying the C<SV_CATUTF8>
5504 flag, and as bytes by supplying the C<SV_CATBYTES> flag; the SV or the
5505 string appended will be upgraded to UTF-8 if necessary.
5506
5507 If C<flags> has the C<SV_SMAGIC> bit set, will
5508 C<mg_set> on C<dsv> afterwards if appropriate.
5509 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5510 in terms of this function.
5511
5512 =cut
5513 */
5514
5515 void
5516 Perl_sv_catpvn_flags(pTHX_ SV *const dsv, const char *sstr, const STRLEN slen, const I32 flags)
5517 {
5518     STRLEN dlen;
5519     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
5520
5521     PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
5522     assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
5523
5524     if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
5525       if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
5526          sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
5527          dlen = SvCUR(dsv);
5528       }
5529       else SvGROW(dsv, dlen + slen + 3);
5530       if (sstr == dstr)
5531         sstr = SvPVX_const(dsv);
5532       Move(sstr, SvPVX(dsv) + dlen, slen, char);
5533       SvCUR_set(dsv, SvCUR(dsv) + slen);
5534     }
5535     else {
5536         /* We inline bytes_to_utf8, to avoid an extra malloc. */
5537         const char * const send = sstr + slen;
5538         U8 *d;
5539
5540         /* Something this code does not account for, which I think is
5541            impossible; it would require the same pv to be treated as
5542            bytes *and* utf8, which would indicate a bug elsewhere. */
5543         assert(sstr != dstr);
5544
5545         SvGROW(dsv, dlen + slen * 2 + 3);
5546         d = (U8 *)SvPVX(dsv) + dlen;
5547
5548         while (sstr < send) {
5549             append_utf8_from_native_byte(*sstr, &d);
5550             sstr++;
5551         }
5552         SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5553     }
5554     *SvEND(dsv) = '\0';
5555     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
5556     SvTAINT(dsv);
5557     if (flags & SV_SMAGIC)
5558         SvSETMAGIC(dsv);
5559 }
5560
5561 /*
5562 =for apidoc sv_catsv
5563
5564 Concatenates the string from SV C<ssv> onto the end of the string in SV
5565 C<dsv>.  If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5566 Handles 'get' magic on both SVs, but no 'set' magic.  See C<L</sv_catsv_mg>>
5567 and C<L</sv_catsv_nomg>>.
5568
5569 =for apidoc sv_catsv_flags
5570
5571 Concatenates the string from SV C<ssv> onto the end of the string in SV
5572 C<dsv>.  If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5573 If C<flags> has the C<SV_GMAGIC> bit set, will call C<mg_get> on both SVs if
5574 appropriate.  If C<flags> has the C<SV_SMAGIC> bit set, C<mg_set> will be called on
5575 the modified SV afterward, if appropriate.  C<sv_catsv>, C<sv_catsv_nomg>,
5576 and C<sv_catsv_mg> are implemented in terms of this function.
5577
5578 =cut */
5579
5580 void
5581 Perl_sv_catsv_flags(pTHX_ SV *const dsv, SV *const ssv, const I32 flags)
5582 {
5583     PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5584
5585     if (ssv) {
5586         STRLEN slen;
5587         const char *spv = SvPV_flags_const(ssv, slen, flags);
5588         if (flags & SV_GMAGIC)
5589                 SvGETMAGIC(dsv);
5590         sv_catpvn_flags(dsv, spv, slen,
5591                             DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5592         if (flags & SV_SMAGIC)
5593                 SvSETMAGIC(dsv);
5594     }
5595 }
5596
5597 /*
5598 =for apidoc sv_catpv
5599
5600 Concatenates the C<NUL>-terminated string onto the end of the string which is
5601 in the SV.
5602 If the SV has the UTF-8 status