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