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