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