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