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