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