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