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