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