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