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