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