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