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