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