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