Hash Function Change - Murmur hash and true per process hash seed
[perl.git] / sv.c
1 /*    sv.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall
5  *    and others
6  *
7  *    You may distribute under the terms of either the GNU General Public
8  *    License or the Artistic License, as specified in the README file.
9  *
10  */
11
12 /*
13  * 'I wonder what the Entish is for "yes" and "no",' he thought.
14  *                                                      --Pippin
15  *
16  *     [p.480 of _The Lord of the Rings_, III/iv: "Treebeard"]
17  */
18
19 /*
20  *
21  *
22  * This file contains the code that creates, manipulates and destroys
23  * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
24  * structure of an SV, so their creation and destruction is handled
25  * here; higher-level functions are in av.c, hv.c, and so on. Opcode
26  * level functions (eg. substr, split, join) for each of the types are
27  * in the pp*.c files.
28  */
29
30 #include "EXTERN.h"
31 #define PERL_IN_SV_C
32 #include "perl.h"
33 #include "regcomp.h"
34
35 #ifndef HAS_C99
36 # if __STDC_VERSION__ >= 199901L && !defined(VMS)
37 #  define HAS_C99 1
38 # endif
39 #endif
40 #if HAS_C99
41 # include <stdint.h>
42 #endif
43
44 #define FCALL *f
45
46 #ifdef __Lynx__
47 /* Missing proto on LynxOS */
48   char *gconvert(double, int, int,  char *);
49 #endif
50
51 #ifdef PERL_UTF8_CACHE_ASSERT
52 /* if adding more checks watch out for the following tests:
53  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
54  *   lib/utf8.t lib/Unicode/Collate/t/index.t
55  * --jhi
56  */
57 #   define ASSERT_UTF8_CACHE(cache) \
58     STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
59                               assert((cache)[2] <= (cache)[3]); \
60                               assert((cache)[3] <= (cache)[1]);} \
61                               } STMT_END
62 #else
63 #   define ASSERT_UTF8_CACHE(cache) NOOP
64 #endif
65
66 #ifdef PERL_OLD_COPY_ON_WRITE
67 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
68 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
69 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
70    on-write.  */
71 #endif
72
73 /* ============================================================================
74
75 =head1 Allocation and deallocation of SVs.
76
77 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
78 sv, av, hv...) contains type and reference count information, and for
79 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
80 contains fields specific to each type.  Some types store all they need
81 in the head, so don't have a body.
82
83 In all but the most memory-paranoid configurations (ex: PURIFY), heads
84 and bodies are allocated out of arenas, which by default are
85 approximately 4K chunks of memory parcelled up into N heads or bodies.
86 Sv-bodies are allocated by their sv-type, guaranteeing size
87 consistency needed to allocate safely from arrays.
88
89 For SV-heads, the first slot in each arena is reserved, and holds a
90 link to the next arena, some flags, and a note of the number of slots.
91 Snaked through each arena chain is a linked list of free items; when
92 this becomes empty, an extra arena is allocated and divided up into N
93 items which are threaded into the free list.
94
95 SV-bodies are similar, but they use arena-sets by default, which
96 separate the link and info from the arena itself, and reclaim the 1st
97 slot in the arena.  SV-bodies are further described later.
98
99 The following global variables are associated with arenas:
100
101     PL_sv_arenaroot     pointer to list of SV arenas
102     PL_sv_root          pointer to list of free SV structures
103
104     PL_body_arenas      head of linked-list of body arenas
105     PL_body_roots[]     array of pointers to list of free bodies of svtype
106                         arrays are indexed by the svtype needed
107
108 A few special SV heads are not allocated from an arena, but are
109 instead directly created in the interpreter structure, eg PL_sv_undef.
110 The size of arenas can be changed from the default by setting
111 PERL_ARENA_SIZE appropriately at compile time.
112
113 The SV arena serves the secondary purpose of allowing still-live SVs
114 to be located and destroyed during final cleanup.
115
116 At the lowest level, the macros new_SV() and del_SV() grab and free
117 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
118 to return the SV to the free list with error checking.) new_SV() calls
119 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
120 SVs in the free list have their SvTYPE field set to all ones.
121
122 At the time of very final cleanup, sv_free_arenas() is called from
123 perl_destruct() to physically free all the arenas allocated since the
124 start of the interpreter.
125
126 The function visit() scans the SV arenas list, and calls a specified
127 function for each SV it finds which is still live - ie which has an SvTYPE
128 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
129 following functions (specified as [function that calls visit()] / [function
130 called by visit() for each SV]):
131
132     sv_report_used() / do_report_used()
133                         dump all remaining SVs (debugging aid)
134
135     sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
136                       do_clean_named_io_objs()
137                         Attempt to free all objects pointed to by RVs,
138                         and try to do the same for all objects indirectly
139                         referenced by typeglobs too.  Called once from
140                         perl_destruct(), prior to calling sv_clean_all()
141                         below.
142
143     sv_clean_all() / do_clean_all()
144                         SvREFCNT_dec(sv) each remaining SV, possibly
145                         triggering an sv_free(). It also sets the
146                         SVf_BREAK flag on the SV to indicate that the
147                         refcnt has been artificially lowered, and thus
148                         stopping sv_free() from giving spurious warnings
149                         about SVs which unexpectedly have a refcnt
150                         of zero.  called repeatedly from perl_destruct()
151                         until there are no SVs left.
152
153 =head2 Arena allocator API Summary
154
155 Private API to rest of sv.c
156
157     new_SV(),  del_SV(),
158
159     new_XPVNV(), del_XPVGV(),
160     etc
161
162 Public API:
163
164     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165
166 =cut
167
168  * ========================================================================= */
169
170 /*
171  * "A time to plant, and a time to uproot what was planted..."
172  */
173
174 #ifdef PERL_MEM_LOG
175 #  define MEM_LOG_NEW_SV(sv, file, line, func)  \
176             Perl_mem_log_new_sv(sv, file, line, func)
177 #  define MEM_LOG_DEL_SV(sv, file, line, func)  \
178             Perl_mem_log_del_sv(sv, file, line, func)
179 #else
180 #  define MEM_LOG_NEW_SV(sv, file, line, func)  NOOP
181 #  define MEM_LOG_DEL_SV(sv, file, line, func)  NOOP
182 #endif
183
184 #ifdef DEBUG_LEAKING_SCALARS
185 #  define FREE_SV_DEBUG_FILE(sv) STMT_START { \
186         if ((sv)->sv_debug_file) PerlMemShared_free((sv)->sv_debug_file); \
187     } STMT_END
188 #  define DEBUG_SV_SERIAL(sv)                                               \
189     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n",    \
190             PTR2UV(sv), (long)(sv)->sv_debug_serial))
191 #else
192 #  define FREE_SV_DEBUG_FILE(sv)
193 #  define DEBUG_SV_SERIAL(sv)   NOOP
194 #endif
195
196 #ifdef PERL_POISON
197 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
198 #  define SvARENA_CHAIN_SET(sv,val)     (sv)->sv_u.svu_rv = MUTABLE_SV((val))
199 /* Whilst I'd love to do this, it seems that things like to check on
200    unreferenced scalars
201 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
202 */
203 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
204                                 PoisonNew(&SvREFCNT(sv), 1, U32)
205 #else
206 #  define SvARENA_CHAIN(sv)     SvANY(sv)
207 #  define SvARENA_CHAIN_SET(sv,val)     SvANY(sv) = (void *)(val)
208 #  define POSION_SV_HEAD(sv)
209 #endif
210
211 /* Mark an SV head as unused, and add to free list.
212  *
213  * If SVf_BREAK is set, skip adding it to the free list, as this SV had
214  * its refcount artificially decremented during global destruction, so
215  * there may be dangling pointers to it. The last thing we want in that
216  * case is for it to be reused. */
217
218 #define plant_SV(p) \
219     STMT_START {                                        \
220         const U32 old_flags = SvFLAGS(p);                       \
221         MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__);  \
222         DEBUG_SV_SERIAL(p);                             \
223         FREE_SV_DEBUG_FILE(p);                          \
224         POSION_SV_HEAD(p);                              \
225         SvFLAGS(p) = SVTYPEMASK;                        \
226         if (!(old_flags & SVf_BREAK)) {         \
227             SvARENA_CHAIN_SET(p, PL_sv_root);   \
228             PL_sv_root = (p);                           \
229         }                                               \
230         --PL_sv_count;                                  \
231     } STMT_END
232
233 #define uproot_SV(p) \
234     STMT_START {                                        \
235         (p) = PL_sv_root;                               \
236         PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p));              \
237         ++PL_sv_count;                                  \
238     } STMT_END
239
240
241 /* make some more SVs by adding another arena */
242
243 STATIC SV*
244 S_more_sv(pTHX)
245 {
246     dVAR;
247     SV* sv;
248     char *chunk;                /* must use New here to match call to */
249     Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
250     sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
251     uproot_SV(sv);
252     return sv;
253 }
254
255 /* new_SV(): return a new, empty SV head */
256
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
259 STATIC SV*
260 S_new_SV(pTHX_ const char *file, int line, const char *func)
261 {
262     SV* sv;
263
264     if (PL_sv_root)
265         uproot_SV(sv);
266     else
267         sv = S_more_sv(aTHX);
268     SvANY(sv) = 0;
269     SvREFCNT(sv) = 1;
270     SvFLAGS(sv) = 0;
271     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
272     sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
273                 ? PL_parser->copline
274                 :  PL_curcop
275                     ? CopLINE(PL_curcop)
276                     : 0
277             );
278     sv->sv_debug_inpad = 0;
279     sv->sv_debug_parent = NULL;
280     sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
281
282     sv->sv_debug_serial = PL_sv_serial++;
283
284     MEM_LOG_NEW_SV(sv, file, line, func);
285     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
286             PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
287
288     return sv;
289 }
290 #  define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
291
292 #else
293 #  define new_SV(p) \
294     STMT_START {                                        \
295         if (PL_sv_root)                                 \
296             uproot_SV(p);                               \
297         else                                            \
298             (p) = S_more_sv(aTHX);                      \
299         SvANY(p) = 0;                                   \
300         SvREFCNT(p) = 1;                                \
301         SvFLAGS(p) = 0;                                 \
302         MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__);  \
303     } STMT_END
304 #endif
305
306
307 /* del_SV(): return an empty SV head to the free list */
308
309 #ifdef DEBUGGING
310
311 #define del_SV(p) \
312     STMT_START {                                        \
313         if (DEBUG_D_TEST)                               \
314             del_sv(p);                                  \
315         else                                            \
316             plant_SV(p);                                \
317     } STMT_END
318
319 STATIC void
320 S_del_sv(pTHX_ SV *p)
321 {
322     dVAR;
323
324     PERL_ARGS_ASSERT_DEL_SV;
325
326     if (DEBUG_D_TEST) {
327         SV* sva;
328         bool ok = 0;
329         for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
330             const SV * const sv = sva + 1;
331             const SV * const svend = &sva[SvREFCNT(sva)];
332             if (p >= sv && p < svend) {
333                 ok = 1;
334                 break;
335             }
336         }
337         if (!ok) {
338             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
339                              "Attempt to free non-arena SV: 0x%"UVxf
340                              pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
341             return;
342         }
343     }
344     plant_SV(p);
345 }
346
347 #else /* ! DEBUGGING */
348
349 #define del_SV(p)   plant_SV(p)
350
351 #endif /* DEBUGGING */
352
353
354 /*
355 =head1 SV Manipulation Functions
356
357 =for apidoc sv_add_arena
358
359 Given a chunk of memory, link it to the head of the list of arenas,
360 and split it into a list of free SVs.
361
362 =cut
363 */
364
365 static void
366 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
367 {
368     dVAR;
369     SV *const sva = MUTABLE_SV(ptr);
370     SV* sv;
371     SV* svend;
372
373     PERL_ARGS_ASSERT_SV_ADD_ARENA;
374
375     /* The first SV in an arena isn't an SV. */
376     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
377     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
378     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
379
380     PL_sv_arenaroot = sva;
381     PL_sv_root = sva + 1;
382
383     svend = &sva[SvREFCNT(sva) - 1];
384     sv = sva + 1;
385     while (sv < svend) {
386         SvARENA_CHAIN_SET(sv, (sv + 1));
387 #ifdef DEBUGGING
388         SvREFCNT(sv) = 0;
389 #endif
390         /* Must always set typemask because it's always checked in on cleanup
391            when the arenas are walked looking for objects.  */
392         SvFLAGS(sv) = SVTYPEMASK;
393         sv++;
394     }
395     SvARENA_CHAIN_SET(sv, 0);
396 #ifdef DEBUGGING
397     SvREFCNT(sv) = 0;
398 #endif
399     SvFLAGS(sv) = SVTYPEMASK;
400 }
401
402 /* visit(): call the named function for each non-free SV in the arenas
403  * whose flags field matches the flags/mask args. */
404
405 STATIC I32
406 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
407 {
408     dVAR;
409     SV* sva;
410     I32 visited = 0;
411
412     PERL_ARGS_ASSERT_VISIT;
413
414     for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
415         const SV * const svend = &sva[SvREFCNT(sva)];
416         SV* sv;
417         for (sv = sva + 1; sv < svend; ++sv) {
418             if (SvTYPE(sv) != (svtype)SVTYPEMASK
419                     && (sv->sv_flags & mask) == flags
420                     && SvREFCNT(sv))
421             {
422                 (FCALL)(aTHX_ sv);
423                 ++visited;
424             }
425         }
426     }
427     return visited;
428 }
429
430 #ifdef DEBUGGING
431
432 /* called by sv_report_used() for each live SV */
433
434 static void
435 do_report_used(pTHX_ SV *const sv)
436 {
437     if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
438         PerlIO_printf(Perl_debug_log, "****\n");
439         sv_dump(sv);
440     }
441 }
442 #endif
443
444 /*
445 =for apidoc sv_report_used
446
447 Dump the contents of all SVs not yet freed (debugging aid).
448
449 =cut
450 */
451
452 void
453 Perl_sv_report_used(pTHX)
454 {
455 #ifdef DEBUGGING
456     visit(do_report_used, 0, 0);
457 #else
458     PERL_UNUSED_CONTEXT;
459 #endif
460 }
461
462 /* called by sv_clean_objs() for each live SV */
463
464 static void
465 do_clean_objs(pTHX_ SV *const ref)
466 {
467     dVAR;
468     assert (SvROK(ref));
469     {
470         SV * const target = SvRV(ref);
471         if (SvOBJECT(target)) {
472             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
473             if (SvWEAKREF(ref)) {
474                 sv_del_backref(target, ref);
475                 SvWEAKREF_off(ref);
476                 SvRV_set(ref, NULL);
477             } else {
478                 SvROK_off(ref);
479                 SvRV_set(ref, NULL);
480                 SvREFCNT_dec(target);
481             }
482         }
483     }
484
485     /* XXX Might want to check arrays, etc. */
486 }
487
488
489 /* clear any slots in a GV which hold objects - except IO;
490  * called by sv_clean_objs() for each live GV */
491
492 static void
493 do_clean_named_objs(pTHX_ SV *const sv)
494 {
495     dVAR;
496     SV *obj;
497     assert(SvTYPE(sv) == SVt_PVGV);
498     assert(isGV_with_GP(sv));
499     if (!GvGP(sv))
500         return;
501
502     /* freeing GP entries may indirectly free the current GV;
503      * hold onto it while we mess with the GP slots */
504     SvREFCNT_inc(sv);
505
506     if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
507         DEBUG_D((PerlIO_printf(Perl_debug_log,
508                 "Cleaning named glob SV object:\n "), sv_dump(obj)));
509         GvSV(sv) = NULL;
510         SvREFCNT_dec(obj);
511     }
512     if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
513         DEBUG_D((PerlIO_printf(Perl_debug_log,
514                 "Cleaning named glob AV object:\n "), sv_dump(obj)));
515         GvAV(sv) = NULL;
516         SvREFCNT_dec(obj);
517     }
518     if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
519         DEBUG_D((PerlIO_printf(Perl_debug_log,
520                 "Cleaning named glob HV object:\n "), sv_dump(obj)));
521         GvHV(sv) = NULL;
522         SvREFCNT_dec(obj);
523     }
524     if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
525         DEBUG_D((PerlIO_printf(Perl_debug_log,
526                 "Cleaning named glob CV object:\n "), sv_dump(obj)));
527         GvCV_set(sv, NULL);
528         SvREFCNT_dec(obj);
529     }
530     SvREFCNT_dec(sv); /* undo the inc above */
531 }
532
533 /* clear any IO slots in a GV which hold objects (except stderr, defout);
534  * called by sv_clean_objs() for each live GV */
535
536 static void
537 do_clean_named_io_objs(pTHX_ SV *const sv)
538 {
539     dVAR;
540     SV *obj;
541     assert(SvTYPE(sv) == SVt_PVGV);
542     assert(isGV_with_GP(sv));
543     if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
544         return;
545
546     SvREFCNT_inc(sv);
547     if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
548         DEBUG_D((PerlIO_printf(Perl_debug_log,
549                 "Cleaning named glob IO object:\n "), sv_dump(obj)));
550         GvIOp(sv) = NULL;
551         SvREFCNT_dec(obj);
552     }
553     SvREFCNT_dec(sv); /* undo the inc above */
554 }
555
556 /* Void wrapper to pass to visit() */
557 static void
558 do_curse(pTHX_ SV * const sv) {
559     if ((PL_stderrgv && GvGP(PL_stderrgv) && (SV*)GvIO(PL_stderrgv) == sv)
560      || (PL_defoutgv && GvGP(PL_defoutgv) && (SV*)GvIO(PL_defoutgv) == sv))
561         return;
562     (void)curse(sv, 0);
563 }
564
565 /*
566 =for apidoc sv_clean_objs
567
568 Attempt to destroy all objects not yet freed.
569
570 =cut
571 */
572
573 void
574 Perl_sv_clean_objs(pTHX)
575 {
576     dVAR;
577     GV *olddef, *olderr;
578     PL_in_clean_objs = TRUE;
579     visit(do_clean_objs, SVf_ROK, SVf_ROK);
580     /* Some barnacles may yet remain, clinging to typeglobs.
581      * Run the non-IO destructors first: they may want to output
582      * error messages, close files etc */
583     visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
584     visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
585     /* And if there are some very tenacious barnacles clinging to arrays,
586        closures, or what have you.... */
587     visit(do_curse, SVs_OBJECT, SVs_OBJECT);
588     olddef = PL_defoutgv;
589     PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
590     if (olddef && isGV_with_GP(olddef))
591         do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
592     olderr = PL_stderrgv;
593     PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
594     if (olderr && isGV_with_GP(olderr))
595         do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
596     SvREFCNT_dec(olddef);
597     PL_in_clean_objs = FALSE;
598 }
599
600 /* called by sv_clean_all() for each live SV */
601
602 static void
603 do_clean_all(pTHX_ SV *const sv)
604 {
605     dVAR;
606     if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
607         /* don't clean pid table and strtab */
608         return;
609     }
610     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
611     SvFLAGS(sv) |= SVf_BREAK;
612     SvREFCNT_dec(sv);
613 }
614
615 /*
616 =for apidoc sv_clean_all
617
618 Decrement the refcnt of each remaining SV, possibly triggering a
619 cleanup.  This function may have to be called multiple times to free
620 SVs which are in complex self-referential hierarchies.
621
622 =cut
623 */
624
625 I32
626 Perl_sv_clean_all(pTHX)
627 {
628     dVAR;
629     I32 cleaned;
630     PL_in_clean_all = TRUE;
631     cleaned = visit(do_clean_all, 0,0);
632     return cleaned;
633 }
634
635 /*
636   ARENASETS: a meta-arena implementation which separates arena-info
637   into struct arena_set, which contains an array of struct
638   arena_descs, each holding info for a single arena.  By separating
639   the meta-info from the arena, we recover the 1st slot, formerly
640   borrowed for list management.  The arena_set is about the size of an
641   arena, avoiding the needless malloc overhead of a naive linked-list.
642
643   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
644   memory in the last arena-set (1/2 on average).  In trade, we get
645   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
646   smaller types).  The recovery of the wasted space allows use of
647   small arenas for large, rare body types, by changing array* fields
648   in body_details_by_type[] below.
649 */
650 struct arena_desc {
651     char       *arena;          /* the raw storage, allocated aligned */
652     size_t      size;           /* its size ~4k typ */
653     svtype      utype;          /* bodytype stored in arena */
654 };
655
656 struct arena_set;
657
658 /* Get the maximum number of elements in set[] such that struct arena_set
659    will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
660    therefore likely to be 1 aligned memory page.  */
661
662 #define ARENAS_PER_SET  ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
663                           - 2 * sizeof(int)) / sizeof (struct arena_desc))
664
665 struct arena_set {
666     struct arena_set* next;
667     unsigned int   set_size;    /* ie ARENAS_PER_SET */
668     unsigned int   curr;        /* index of next available arena-desc */
669     struct arena_desc set[ARENAS_PER_SET];
670 };
671
672 /*
673 =for apidoc sv_free_arenas
674
675 Deallocate the memory used by all arenas.  Note that all the individual SV
676 heads and bodies within the arenas must already have been freed.
677
678 =cut
679 */
680 void
681 Perl_sv_free_arenas(pTHX)
682 {
683     dVAR;
684     SV* sva;
685     SV* svanext;
686     unsigned int i;
687
688     /* Free arenas here, but be careful about fake ones.  (We assume
689        contiguity of the fake ones with the corresponding real ones.) */
690
691     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
692         svanext = MUTABLE_SV(SvANY(sva));
693         while (svanext && SvFAKE(svanext))
694             svanext = MUTABLE_SV(SvANY(svanext));
695
696         if (!SvFAKE(sva))
697             Safefree(sva);
698     }
699
700     {
701         struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
702
703         while (aroot) {
704             struct arena_set *current = aroot;
705             i = aroot->curr;
706             while (i--) {
707                 assert(aroot->set[i].arena);
708                 Safefree(aroot->set[i].arena);
709             }
710             aroot = aroot->next;
711             Safefree(current);
712         }
713     }
714     PL_body_arenas = 0;
715
716     i = PERL_ARENA_ROOTS_SIZE;
717     while (i--)
718         PL_body_roots[i] = 0;
719
720     PL_sv_arenaroot = 0;
721     PL_sv_root = 0;
722 }
723
724 /*
725   Here are mid-level routines that manage the allocation of bodies out
726   of the various arenas.  There are 5 kinds of arenas:
727
728   1. SV-head arenas, which are discussed and handled above
729   2. regular body arenas
730   3. arenas for reduced-size bodies
731   4. Hash-Entry arenas
732
733   Arena types 2 & 3 are chained by body-type off an array of
734   arena-root pointers, which is indexed by svtype.  Some of the
735   larger/less used body types are malloced singly, since a large
736   unused block of them is wasteful.  Also, several svtypes dont have
737   bodies; the data fits into the sv-head itself.  The arena-root
738   pointer thus has a few unused root-pointers (which may be hijacked
739   later for arena types 4,5)
740
741   3 differs from 2 as an optimization; some body types have several
742   unused fields in the front of the structure (which are kept in-place
743   for consistency).  These bodies can be allocated in smaller chunks,
744   because the leading fields arent accessed.  Pointers to such bodies
745   are decremented to point at the unused 'ghost' memory, knowing that
746   the pointers are used with offsets to the real memory.
747
748
749 =head1 SV-Body Allocation
750
751 Allocation of SV-bodies is similar to SV-heads, differing as follows;
752 the allocation mechanism is used for many body types, so is somewhat
753 more complicated, it uses arena-sets, and has no need for still-live
754 SV detection.
755
756 At the outermost level, (new|del)_X*V macros return bodies of the
757 appropriate type.  These macros call either (new|del)_body_type or
758 (new|del)_body_allocated macro pairs, depending on specifics of the
759 type.  Most body types use the former pair, the latter pair is used to
760 allocate body types with "ghost fields".
761
762 "ghost fields" are fields that are unused in certain types, and
763 consequently don't need to actually exist.  They are declared because
764 they're part of a "base type", which allows use of functions as
765 methods.  The simplest examples are AVs and HVs, 2 aggregate types
766 which don't use the fields which support SCALAR semantics.
767
768 For these types, the arenas are carved up into appropriately sized
769 chunks, we thus avoid wasted memory for those unaccessed members.
770 When bodies are allocated, we adjust the pointer back in memory by the
771 size of the part not allocated, so it's as if we allocated the full
772 structure.  (But things will all go boom if you write to the part that
773 is "not there", because you'll be overwriting the last members of the
774 preceding structure in memory.)
775
776 We calculate the correction using the STRUCT_OFFSET macro on the first
777 member present. If the allocated structure is smaller (no initial NV
778 actually allocated) then the net effect is to subtract the size of the NV
779 from the pointer, to return a new pointer as if an initial NV were actually
780 allocated. (We were using structures named *_allocated for this, but
781 this turned out to be a subtle bug, because a structure without an NV
782 could have a lower alignment constraint, but the compiler is allowed to
783 optimised accesses based on the alignment constraint of the actual pointer
784 to the full structure, for example, using a single 64 bit load instruction
785 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
786
787 This is the same trick as was used for NV and IV bodies. Ironically it
788 doesn't need to be used for NV bodies any more, because NV is now at
789 the start of the structure. IV bodies don't need it either, because
790 they are no longer allocated.
791
792 In turn, the new_body_* allocators call S_new_body(), which invokes
793 new_body_inline macro, which takes a lock, and takes a body off the
794 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
795 necessary to refresh an empty list.  Then the lock is released, and
796 the body is returned.
797
798 Perl_more_bodies allocates a new arena, and carves it up into an array of N
799 bodies, which it strings into a linked list.  It looks up arena-size
800 and body-size from the body_details table described below, thus
801 supporting the multiple body-types.
802
803 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
804 the (new|del)_X*V macros are mapped directly to malloc/free.
805
806 For each sv-type, struct body_details bodies_by_type[] carries
807 parameters which control these aspects of SV handling:
808
809 Arena_size determines whether arenas are used for this body type, and if
810 so, how big they are.  PURIFY or PERL_ARENA_SIZE=0 set this field to
811 zero, forcing individual mallocs and frees.
812
813 Body_size determines how big a body is, and therefore how many fit into
814 each arena.  Offset carries the body-pointer adjustment needed for
815 "ghost fields", and is used in *_allocated macros.
816
817 But its main purpose is to parameterize info needed in
818 Perl_sv_upgrade().  The info here dramatically simplifies the function
819 vs the implementation in 5.8.8, making it table-driven.  All fields
820 are used for this, except for arena_size.
821
822 For the sv-types that have no bodies, arenas are not used, so those
823 PL_body_roots[sv_type] are unused, and can be overloaded.  In
824 something of a special case, SVt_NULL is borrowed for HE arenas;
825 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
826 bodies_by_type[SVt_NULL] slot is not used, as the table is not
827 available in hv.c.
828
829 */
830
831 struct body_details {
832     U8 body_size;       /* Size to allocate  */
833     U8 copy;            /* Size of structure to copy (may be shorter)  */
834     U8 offset;
835     unsigned int type : 4;          /* We have space for a sanity check.  */
836     unsigned int cant_upgrade : 1;  /* Cannot upgrade this type */
837     unsigned int zero_nv : 1;       /* zero the NV when upgrading from this */
838     unsigned int arena : 1;         /* Allocated from an arena */
839     size_t arena_size;              /* Size of arena to allocate */
840 };
841
842 #define HADNV FALSE
843 #define NONV TRUE
844
845
846 #ifdef PURIFY
847 /* With -DPURFIY we allocate everything directly, and don't use arenas.
848    This seems a rather elegant way to simplify some of the code below.  */
849 #define HASARENA FALSE
850 #else
851 #define HASARENA TRUE
852 #endif
853 #define NOARENA FALSE
854
855 /* Size the arenas to exactly fit a given number of bodies.  A count
856    of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
857    simplifying the default.  If count > 0, the arena is sized to fit
858    only that many bodies, allowing arenas to be used for large, rare
859    bodies (XPVFM, XPVIO) without undue waste.  The arena size is
860    limited by PERL_ARENA_SIZE, so we can safely oversize the
861    declarations.
862  */
863 #define FIT_ARENA0(body_size)                           \
864     ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
865 #define FIT_ARENAn(count,body_size)                     \
866     ( count * body_size <= PERL_ARENA_SIZE)             \
867     ? count * body_size                                 \
868     : FIT_ARENA0 (body_size)
869 #define FIT_ARENA(count,body_size)                      \
870     count                                               \
871     ? FIT_ARENAn (count, body_size)                     \
872     : FIT_ARENA0 (body_size)
873
874 /* Calculate the length to copy. Specifically work out the length less any
875    final padding the compiler needed to add.  See the comment in sv_upgrade
876    for why copying the padding proved to be a bug.  */
877
878 #define copy_length(type, last_member) \
879         STRUCT_OFFSET(type, last_member) \
880         + sizeof (((type*)SvANY((const SV *)0))->last_member)
881
882 static const struct body_details bodies_by_type[] = {
883     /* HEs use this offset for their arena.  */
884     { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
885
886     /* The bind placeholder pretends to be an RV for now.
887        Also it's marked as "can't upgrade" to stop anyone using it before it's
888        implemented.  */
889     { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
890
891     /* IVs are in the head, so the allocation size is 0.  */
892     { 0,
893       sizeof(IV), /* This is used to copy out the IV body.  */
894       STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895       NOARENA /* IVS don't need an arena  */, 0
896     },
897
898     { sizeof(NV), sizeof(NV),
899       STRUCT_OFFSET(XPVNV, xnv_u),
900       SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
901
902     { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
903       copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
904       + STRUCT_OFFSET(XPV, xpv_cur),
905       SVt_PV, FALSE, NONV, HASARENA,
906       FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
907
908     { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
909       copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
910       + STRUCT_OFFSET(XPV, xpv_cur),
911       SVt_PVIV, FALSE, NONV, HASARENA,
912       FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
913
914     { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
915       copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
916       + STRUCT_OFFSET(XPV, xpv_cur),
917       SVt_PVNV, FALSE, HADNV, HASARENA,
918       FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
919
920     { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
921       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
922
923     { sizeof(regexp),
924       sizeof(regexp),
925       0,
926       SVt_REGEXP, FALSE, NONV, HASARENA,
927       FIT_ARENA(0, sizeof(regexp))
928     },
929
930     { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
931       HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
932     
933     { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
934       HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
935
936     { sizeof(XPVAV),
937       copy_length(XPVAV, xav_alloc),
938       0,
939       SVt_PVAV, TRUE, NONV, HASARENA,
940       FIT_ARENA(0, sizeof(XPVAV)) },
941
942     { sizeof(XPVHV),
943       copy_length(XPVHV, xhv_max),
944       0,
945       SVt_PVHV, TRUE, NONV, HASARENA,
946       FIT_ARENA(0, sizeof(XPVHV)) },
947
948     { sizeof(XPVCV),
949       sizeof(XPVCV),
950       0,
951       SVt_PVCV, TRUE, NONV, HASARENA,
952       FIT_ARENA(0, sizeof(XPVCV)) },
953
954     { sizeof(XPVFM),
955       sizeof(XPVFM),
956       0,
957       SVt_PVFM, TRUE, NONV, NOARENA,
958       FIT_ARENA(20, sizeof(XPVFM)) },
959
960     { sizeof(XPVIO),
961       sizeof(XPVIO),
962       0,
963       SVt_PVIO, TRUE, NONV, HASARENA,
964       FIT_ARENA(24, sizeof(XPVIO)) },
965 };
966
967 #define new_body_allocated(sv_type)             \
968     (void *)((char *)S_new_body(aTHX_ sv_type)  \
969              - bodies_by_type[sv_type].offset)
970
971 /* return a thing to the free list */
972
973 #define del_body(thing, root)                           \
974     STMT_START {                                        \
975         void ** const thing_copy = (void **)thing;      \
976         *thing_copy = *root;                            \
977         *root = (void*)thing_copy;                      \
978     } STMT_END
979
980 #ifdef PURIFY
981
982 #define new_XNV()       safemalloc(sizeof(XPVNV))
983 #define new_XPVNV()     safemalloc(sizeof(XPVNV))
984 #define new_XPVMG()     safemalloc(sizeof(XPVMG))
985
986 #define del_XPVGV(p)    safefree(p)
987
988 #else /* !PURIFY */
989
990 #define new_XNV()       new_body_allocated(SVt_NV)
991 #define new_XPVNV()     new_body_allocated(SVt_PVNV)
992 #define new_XPVMG()     new_body_allocated(SVt_PVMG)
993
994 #define del_XPVGV(p)    del_body(p + bodies_by_type[SVt_PVGV].offset,   \
995                                  &PL_body_roots[SVt_PVGV])
996
997 #endif /* PURIFY */
998
999 /* no arena for you! */
1000
1001 #define new_NOARENA(details) \
1002         safemalloc((details)->body_size + (details)->offset)
1003 #define new_NOARENAZ(details) \
1004         safecalloc((details)->body_size + (details)->offset, 1)
1005
1006 void *
1007 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1008                   const size_t arena_size)
1009 {
1010     dVAR;
1011     void ** const root = &PL_body_roots[sv_type];
1012     struct arena_desc *adesc;
1013     struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1014     unsigned int curr;
1015     char *start;
1016     const char *end;
1017     const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1018 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1019     static bool done_sanity_check;
1020
1021     /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1022      * variables like done_sanity_check. */
1023     if (!done_sanity_check) {
1024         unsigned int i = SVt_LAST;
1025
1026         done_sanity_check = TRUE;
1027
1028         while (i--)
1029             assert (bodies_by_type[i].type == i);
1030     }
1031 #endif
1032
1033     assert(arena_size);
1034
1035     /* may need new arena-set to hold new arena */
1036     if (!aroot || aroot->curr >= aroot->set_size) {
1037         struct arena_set *newroot;
1038         Newxz(newroot, 1, struct arena_set);
1039         newroot->set_size = ARENAS_PER_SET;
1040         newroot->next = aroot;
1041         aroot = newroot;
1042         PL_body_arenas = (void *) newroot;
1043         DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1044     }
1045
1046     /* ok, now have arena-set with at least 1 empty/available arena-desc */
1047     curr = aroot->curr++;
1048     adesc = &(aroot->set[curr]);
1049     assert(!adesc->arena);
1050     
1051     Newx(adesc->arena, good_arena_size, char);
1052     adesc->size = good_arena_size;
1053     adesc->utype = sv_type;
1054     DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n", 
1055                           curr, (void*)adesc->arena, (UV)good_arena_size));
1056
1057     start = (char *) adesc->arena;
1058
1059     /* Get the address of the byte after the end of the last body we can fit.
1060        Remember, this is integer division:  */
1061     end = start + good_arena_size / body_size * body_size;
1062
1063     /* computed count doesn't reflect the 1st slot reservation */
1064 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1065     DEBUG_m(PerlIO_printf(Perl_debug_log,
1066                           "arena %p end %p arena-size %d (from %d) type %d "
1067                           "size %d ct %d\n",
1068                           (void*)start, (void*)end, (int)good_arena_size,
1069                           (int)arena_size, sv_type, (int)body_size,
1070                           (int)good_arena_size / (int)body_size));
1071 #else
1072     DEBUG_m(PerlIO_printf(Perl_debug_log,
1073                           "arena %p end %p arena-size %d type %d size %d ct %d\n",
1074                           (void*)start, (void*)end,
1075                           (int)arena_size, sv_type, (int)body_size,
1076                           (int)good_arena_size / (int)body_size));
1077 #endif
1078     *root = (void *)start;
1079
1080     while (1) {
1081         /* Where the next body would start:  */
1082         char * const next = start + body_size;
1083
1084         if (next >= end) {
1085             /* This is the last body:  */
1086             assert(next == end);
1087
1088             *(void **)start = 0;
1089             return *root;
1090         }
1091
1092         *(void**) start = (void *)next;
1093         start = next;
1094     }
1095 }
1096
1097 /* grab a new thing from the free list, allocating more if necessary.
1098    The inline version is used for speed in hot routines, and the
1099    function using it serves the rest (unless PURIFY).
1100 */
1101 #define new_body_inline(xpv, sv_type) \
1102     STMT_START { \
1103         void ** const r3wt = &PL_body_roots[sv_type]; \
1104         xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt))      \
1105           ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1106                                              bodies_by_type[sv_type].body_size,\
1107                                              bodies_by_type[sv_type].arena_size)); \
1108         *(r3wt) = *(void**)(xpv); \
1109     } STMT_END
1110
1111 #ifndef PURIFY
1112
1113 STATIC void *
1114 S_new_body(pTHX_ const svtype sv_type)
1115 {
1116     dVAR;
1117     void *xpv;
1118     new_body_inline(xpv, sv_type);
1119     return xpv;
1120 }
1121
1122 #endif
1123
1124 static const struct body_details fake_rv =
1125     { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1126
1127 /*
1128 =for apidoc sv_upgrade
1129
1130 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1131 SV, then copies across as much information as possible from the old body.
1132 It croaks if the SV is already in a more complex form than requested.  You
1133 generally want to use the C<SvUPGRADE> macro wrapper, which checks the type
1134 before calling C<sv_upgrade>, and hence does not croak.  See also
1135 C<svtype>.
1136
1137 =cut
1138 */
1139
1140 void
1141 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1142 {
1143     dVAR;
1144     void*       old_body;
1145     void*       new_body;
1146     const svtype old_type = SvTYPE(sv);
1147     const struct body_details *new_type_details;
1148     const struct body_details *old_type_details
1149         = bodies_by_type + old_type;
1150     SV *referant = NULL;
1151
1152     PERL_ARGS_ASSERT_SV_UPGRADE;
1153
1154     if (old_type == new_type)
1155         return;
1156
1157     /* This clause was purposefully added ahead of the early return above to
1158        the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1159        inference by Nick I-S that it would fix other troublesome cases. See
1160        changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1161
1162        Given that shared hash key scalars are no longer PVIV, but PV, there is
1163        no longer need to unshare so as to free up the IVX slot for its proper
1164        purpose. So it's safe to move the early return earlier.  */
1165
1166     if (new_type > SVt_PVMG && SvIsCOW(sv)) {
1167         sv_force_normal_flags(sv, 0);
1168     }
1169
1170     old_body = SvANY(sv);
1171
1172     /* Copying structures onto other structures that have been neatly zeroed
1173        has a subtle gotcha. Consider XPVMG
1174
1175        +------+------+------+------+------+-------+-------+
1176        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |
1177        +------+------+------+------+------+-------+-------+
1178        0      4      8     12     16     20      24      28
1179
1180        where NVs are aligned to 8 bytes, so that sizeof that structure is
1181        actually 32 bytes long, with 4 bytes of padding at the end:
1182
1183        +------+------+------+------+------+-------+-------+------+
1184        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH | ???  |
1185        +------+------+------+------+------+-------+-------+------+
1186        0      4      8     12     16     20      24      28     32
1187
1188        so what happens if you allocate memory for this structure:
1189
1190        +------+------+------+------+------+-------+-------+------+------+...
1191        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |  GP  | NAME |
1192        +------+------+------+------+------+-------+-------+------+------+...
1193        0      4      8     12     16     20      24      28     32     36
1194
1195        zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1196        expect, because you copy the area marked ??? onto GP. Now, ??? may have
1197        started out as zero once, but it's quite possible that it isn't. So now,
1198        rather than a nicely zeroed GP, you have it pointing somewhere random.
1199        Bugs ensue.
1200
1201        (In fact, GP ends up pointing at a previous GP structure, because the
1202        principle cause of the padding in XPVMG getting garbage is a copy of
1203        sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1204        this happens to be moot because XPVGV has been re-ordered, with GP
1205        no longer after STASH)
1206
1207        So we are careful and work out the size of used parts of all the
1208        structures.  */
1209
1210     switch (old_type) {
1211     case SVt_NULL:
1212         break;
1213     case SVt_IV:
1214         if (SvROK(sv)) {
1215             referant = SvRV(sv);
1216             old_type_details = &fake_rv;
1217             if (new_type == SVt_NV)
1218                 new_type = SVt_PVNV;
1219         } else {
1220             if (new_type < SVt_PVIV) {
1221                 new_type = (new_type == SVt_NV)
1222                     ? SVt_PVNV : SVt_PVIV;
1223             }
1224         }
1225         break;
1226     case SVt_NV:
1227         if (new_type < SVt_PVNV) {
1228             new_type = SVt_PVNV;
1229         }
1230         break;
1231     case SVt_PV:
1232         assert(new_type > SVt_PV);
1233         assert(SVt_IV < SVt_PV);
1234         assert(SVt_NV < SVt_PV);
1235         break;
1236     case SVt_PVIV:
1237         break;
1238     case SVt_PVNV:
1239         break;
1240     case SVt_PVMG:
1241         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1242            there's no way that it can be safely upgraded, because perl.c
1243            expects to Safefree(SvANY(PL_mess_sv))  */
1244         assert(sv != PL_mess_sv);
1245         /* This flag bit is used to mean other things in other scalar types.
1246            Given that it only has meaning inside the pad, it shouldn't be set
1247            on anything that can get upgraded.  */
1248         assert(!SvPAD_TYPED(sv));
1249         break;
1250     default:
1251         if (old_type_details->cant_upgrade)
1252             Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1253                        sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1254     }
1255
1256     if (old_type > new_type)
1257         Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1258                 (int)old_type, (int)new_type);
1259
1260     new_type_details = bodies_by_type + new_type;
1261
1262     SvFLAGS(sv) &= ~SVTYPEMASK;
1263     SvFLAGS(sv) |= new_type;
1264
1265     /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1266        the return statements above will have triggered.  */
1267     assert (new_type != SVt_NULL);
1268     switch (new_type) {
1269     case SVt_IV:
1270         assert(old_type == SVt_NULL);
1271         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1272         SvIV_set(sv, 0);
1273         return;
1274     case SVt_NV:
1275         assert(old_type == SVt_NULL);
1276         SvANY(sv) = new_XNV();
1277         SvNV_set(sv, 0);
1278         return;
1279     case SVt_PVHV:
1280     case SVt_PVAV:
1281         assert(new_type_details->body_size);
1282
1283 #ifndef PURIFY  
1284         assert(new_type_details->arena);
1285         assert(new_type_details->arena_size);
1286         /* This points to the start of the allocated area.  */
1287         new_body_inline(new_body, new_type);
1288         Zero(new_body, new_type_details->body_size, char);
1289         new_body = ((char *)new_body) - new_type_details->offset;
1290 #else
1291         /* We always allocated the full length item with PURIFY. To do this
1292            we fake things so that arena is false for all 16 types..  */
1293         new_body = new_NOARENAZ(new_type_details);
1294 #endif
1295         SvANY(sv) = new_body;
1296         if (new_type == SVt_PVAV) {
1297             AvMAX(sv)   = -1;
1298             AvFILLp(sv) = -1;
1299             AvREAL_only(sv);
1300             if (old_type_details->body_size) {
1301                 AvALLOC(sv) = 0;
1302             } else {
1303                 /* It will have been zeroed when the new body was allocated.
1304                    Lets not write to it, in case it confuses a write-back
1305                    cache.  */
1306             }
1307         } else {
1308             assert(!SvOK(sv));
1309             SvOK_off(sv);
1310 #ifndef NODEFAULT_SHAREKEYS
1311             HvSHAREKEYS_on(sv);         /* key-sharing on by default */
1312 #endif
1313             HvMAX(sv) = 7; /* (start with 8 buckets) */
1314         }
1315
1316         /* SVt_NULL isn't the only thing upgraded to AV or HV.
1317            The target created by newSVrv also is, and it can have magic.
1318            However, it never has SvPVX set.
1319         */
1320         if (old_type == SVt_IV) {
1321             assert(!SvROK(sv));
1322         } else if (old_type >= SVt_PV) {
1323             assert(SvPVX_const(sv) == 0);
1324         }
1325
1326         if (old_type >= SVt_PVMG) {
1327             SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1328             SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1329         } else {
1330             sv->sv_u.svu_array = NULL; /* or svu_hash  */
1331         }
1332         break;
1333
1334     case SVt_PVIV:
1335         /* XXX Is this still needed?  Was it ever needed?   Surely as there is
1336            no route from NV to PVIV, NOK can never be true  */
1337         assert(!SvNOKp(sv));
1338         assert(!SvNOK(sv));
1339     case SVt_PVIO:
1340     case SVt_PVFM:
1341     case SVt_PVGV:
1342     case SVt_PVCV:
1343     case SVt_PVLV:
1344     case SVt_REGEXP:
1345     case SVt_PVMG:
1346     case SVt_PVNV:
1347     case SVt_PV:
1348
1349         assert(new_type_details->body_size);
1350         /* We always allocated the full length item with PURIFY. To do this
1351            we fake things so that arena is false for all 16 types..  */
1352         if(new_type_details->arena) {
1353             /* This points to the start of the allocated area.  */
1354             new_body_inline(new_body, new_type);
1355             Zero(new_body, new_type_details->body_size, char);
1356             new_body = ((char *)new_body) - new_type_details->offset;
1357         } else {
1358             new_body = new_NOARENAZ(new_type_details);
1359         }
1360         SvANY(sv) = new_body;
1361
1362         if (old_type_details->copy) {
1363             /* There is now the potential for an upgrade from something without
1364                an offset (PVNV or PVMG) to something with one (PVCV, PVFM)  */
1365             int offset = old_type_details->offset;
1366             int length = old_type_details->copy;
1367
1368             if (new_type_details->offset > old_type_details->offset) {
1369                 const int difference
1370                     = new_type_details->offset - old_type_details->offset;
1371                 offset += difference;
1372                 length -= difference;
1373             }
1374             assert (length >= 0);
1375                 
1376             Copy((char *)old_body + offset, (char *)new_body + offset, length,
1377                  char);
1378         }
1379
1380 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1381         /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1382          * correct 0.0 for us.  Otherwise, if the old body didn't have an
1383          * NV slot, but the new one does, then we need to initialise the
1384          * freshly created NV slot with whatever the correct bit pattern is
1385          * for 0.0  */
1386         if (old_type_details->zero_nv && !new_type_details->zero_nv
1387             && !isGV_with_GP(sv))
1388             SvNV_set(sv, 0);
1389 #endif
1390
1391         if (new_type == SVt_PVIO) {
1392             IO * const io = MUTABLE_IO(sv);
1393             GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1394
1395             SvOBJECT_on(io);
1396             /* Clear the stashcache because a new IO could overrule a package
1397                name */
1398             DEBUG_o(Perl_deb(aTHX_ "sv_upgrade clearing PL_stashcache\n"));
1399             hv_clear(PL_stashcache);
1400
1401             SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1402             IoPAGE_LEN(sv) = 60;
1403         }
1404         if (new_type == SVt_REGEXP)
1405             sv->sv_u.svu_rx = (regexp *)new_body;
1406         else if (old_type < SVt_PV) {
1407             /* referant will be NULL unless the old type was SVt_IV emulating
1408                SVt_RV */
1409             sv->sv_u.svu_rv = referant;
1410         }
1411         break;
1412     default:
1413         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1414                    (unsigned long)new_type);
1415     }
1416
1417     if (old_type > SVt_IV) {
1418 #ifdef PURIFY
1419         safefree(old_body);
1420 #else
1421         /* Note that there is an assumption that all bodies of types that
1422            can be upgraded came from arenas. Only the more complex non-
1423            upgradable types are allowed to be directly malloc()ed.  */
1424         assert(old_type_details->arena);
1425         del_body((void*)((char*)old_body + old_type_details->offset),
1426                  &PL_body_roots[old_type]);
1427 #endif
1428     }
1429 }
1430
1431 /*
1432 =for apidoc sv_backoff
1433
1434 Remove any string offset.  You should normally use the C<SvOOK_off> macro
1435 wrapper instead.
1436
1437 =cut
1438 */
1439
1440 int
1441 Perl_sv_backoff(pTHX_ register SV *const sv)
1442 {
1443     STRLEN delta;
1444     const char * const s = SvPVX_const(sv);
1445
1446     PERL_ARGS_ASSERT_SV_BACKOFF;
1447     PERL_UNUSED_CONTEXT;
1448
1449     assert(SvOOK(sv));
1450     assert(SvTYPE(sv) != SVt_PVHV);
1451     assert(SvTYPE(sv) != SVt_PVAV);
1452
1453     SvOOK_offset(sv, delta);
1454     
1455     SvLEN_set(sv, SvLEN(sv) + delta);
1456     SvPV_set(sv, SvPVX(sv) - delta);
1457     Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1458     SvFLAGS(sv) &= ~SVf_OOK;
1459     return 0;
1460 }
1461
1462 /*
1463 =for apidoc sv_grow
1464
1465 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1466 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1467 Use the C<SvGROW> wrapper instead.
1468
1469 =cut
1470 */
1471
1472 char *
1473 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1474 {
1475     char *s;
1476
1477     PERL_ARGS_ASSERT_SV_GROW;
1478
1479     if (PL_madskills && newlen >= 0x100000) {
1480         PerlIO_printf(Perl_debug_log,
1481                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1482     }
1483 #ifdef HAS_64K_LIMIT
1484     if (newlen >= 0x10000) {
1485         PerlIO_printf(Perl_debug_log,
1486                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1487         my_exit(1);
1488     }
1489 #endif /* HAS_64K_LIMIT */
1490     if (SvROK(sv))
1491         sv_unref(sv);
1492     if (SvTYPE(sv) < SVt_PV) {
1493         sv_upgrade(sv, SVt_PV);
1494         s = SvPVX_mutable(sv);
1495     }
1496     else if (SvOOK(sv)) {       /* pv is offset? */
1497         sv_backoff(sv);
1498         s = SvPVX_mutable(sv);
1499         if (newlen > SvLEN(sv))
1500             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1501 #ifdef HAS_64K_LIMIT
1502         if (newlen >= 0x10000)
1503             newlen = 0xFFFF;
1504 #endif
1505     }
1506     else
1507         s = SvPVX_mutable(sv);
1508
1509     if (newlen > SvLEN(sv)) {           /* need more room? */
1510         STRLEN minlen = SvCUR(sv);
1511         minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1512         if (newlen < minlen)
1513             newlen = minlen;
1514 #ifndef Perl_safesysmalloc_size
1515         newlen = PERL_STRLEN_ROUNDUP(newlen);
1516 #endif
1517         if (SvLEN(sv) && s) {
1518             s = (char*)saferealloc(s, newlen);
1519         }
1520         else {
1521             s = (char*)safemalloc(newlen);
1522             if (SvPVX_const(sv) && SvCUR(sv)) {
1523                 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1524             }
1525         }
1526         SvPV_set(sv, s);
1527 #ifdef Perl_safesysmalloc_size
1528         /* Do this here, do it once, do it right, and then we will never get
1529            called back into sv_grow() unless there really is some growing
1530            needed.  */
1531         SvLEN_set(sv, Perl_safesysmalloc_size(s));
1532 #else
1533         SvLEN_set(sv, newlen);
1534 #endif
1535     }
1536     return s;
1537 }
1538
1539 /*
1540 =for apidoc sv_setiv
1541
1542 Copies an integer into the given SV, upgrading first if necessary.
1543 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1544
1545 =cut
1546 */
1547
1548 void
1549 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1550 {
1551     dVAR;
1552
1553     PERL_ARGS_ASSERT_SV_SETIV;
1554
1555     SV_CHECK_THINKFIRST_COW_DROP(sv);
1556     switch (SvTYPE(sv)) {
1557     case SVt_NULL:
1558     case SVt_NV:
1559         sv_upgrade(sv, SVt_IV);
1560         break;
1561     case SVt_PV:
1562         sv_upgrade(sv, SVt_PVIV);
1563         break;
1564
1565     case SVt_PVGV:
1566         if (!isGV_with_GP(sv))
1567             break;
1568     case SVt_PVAV:
1569     case SVt_PVHV:
1570     case SVt_PVCV:
1571     case SVt_PVFM:
1572     case SVt_PVIO:
1573         /* diag_listed_as: Can't coerce %s to %s in %s */
1574         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1575                    OP_DESC(PL_op));
1576     default: NOOP;
1577     }
1578     (void)SvIOK_only(sv);                       /* validate number */
1579     SvIV_set(sv, i);
1580     SvTAINT(sv);
1581 }
1582
1583 /*
1584 =for apidoc sv_setiv_mg
1585
1586 Like C<sv_setiv>, but also handles 'set' magic.
1587
1588 =cut
1589 */
1590
1591 void
1592 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1593 {
1594     PERL_ARGS_ASSERT_SV_SETIV_MG;
1595
1596     sv_setiv(sv,i);
1597     SvSETMAGIC(sv);
1598 }
1599
1600 /*
1601 =for apidoc sv_setuv
1602
1603 Copies an unsigned integer into the given SV, upgrading first if necessary.
1604 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1605
1606 =cut
1607 */
1608
1609 void
1610 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1611 {
1612     PERL_ARGS_ASSERT_SV_SETUV;
1613
1614     /* With the if statement to ensure that integers are stored as IVs whenever
1615        possible:
1616        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1617
1618        without
1619        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1620
1621        If you wish to remove the following if statement, so that this routine
1622        (and its callers) always return UVs, please benchmark to see what the
1623        effect is. Modern CPUs may be different. Or may not :-)
1624     */
1625     if (u <= (UV)IV_MAX) {
1626        sv_setiv(sv, (IV)u);
1627        return;
1628     }
1629     sv_setiv(sv, 0);
1630     SvIsUV_on(sv);
1631     SvUV_set(sv, u);
1632 }
1633
1634 /*
1635 =for apidoc sv_setuv_mg
1636
1637 Like C<sv_setuv>, but also handles 'set' magic.
1638
1639 =cut
1640 */
1641
1642 void
1643 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1644 {
1645     PERL_ARGS_ASSERT_SV_SETUV_MG;
1646
1647     sv_setuv(sv,u);
1648     SvSETMAGIC(sv);
1649 }
1650
1651 /*
1652 =for apidoc sv_setnv
1653
1654 Copies a double into the given SV, upgrading first if necessary.
1655 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1656
1657 =cut
1658 */
1659
1660 void
1661 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1662 {
1663     dVAR;
1664
1665     PERL_ARGS_ASSERT_SV_SETNV;
1666
1667     SV_CHECK_THINKFIRST_COW_DROP(sv);
1668     switch (SvTYPE(sv)) {
1669     case SVt_NULL:
1670     case SVt_IV:
1671         sv_upgrade(sv, SVt_NV);
1672         break;
1673     case SVt_PV:
1674     case SVt_PVIV:
1675         sv_upgrade(sv, SVt_PVNV);
1676         break;
1677
1678     case SVt_PVGV:
1679         if (!isGV_with_GP(sv))
1680             break;
1681     case SVt_PVAV:
1682     case SVt_PVHV:
1683     case SVt_PVCV:
1684     case SVt_PVFM:
1685     case SVt_PVIO:
1686         /* diag_listed_as: Can't coerce %s to %s in %s */
1687         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1688                    OP_DESC(PL_op));
1689     default: NOOP;
1690     }
1691     SvNV_set(sv, num);
1692     (void)SvNOK_only(sv);                       /* validate number */
1693     SvTAINT(sv);
1694 }
1695
1696 /*
1697 =for apidoc sv_setnv_mg
1698
1699 Like C<sv_setnv>, but also handles 'set' magic.
1700
1701 =cut
1702 */
1703
1704 void
1705 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1706 {
1707     PERL_ARGS_ASSERT_SV_SETNV_MG;
1708
1709     sv_setnv(sv,num);
1710     SvSETMAGIC(sv);
1711 }
1712
1713 /* Print an "isn't numeric" warning, using a cleaned-up,
1714  * printable version of the offending string
1715  */
1716
1717 STATIC void
1718 S_not_a_number(pTHX_ SV *const sv)
1719 {
1720      dVAR;
1721      SV *dsv;
1722      char tmpbuf[64];
1723      const char *pv;
1724
1725      PERL_ARGS_ASSERT_NOT_A_NUMBER;
1726
1727      if (DO_UTF8(sv)) {
1728           dsv = newSVpvs_flags("", SVs_TEMP);
1729           pv = sv_uni_display(dsv, sv, 10, UNI_DISPLAY_ISPRINT);
1730      } else {
1731           char *d = tmpbuf;
1732           const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1733           /* each *s can expand to 4 chars + "...\0",
1734              i.e. need room for 8 chars */
1735         
1736           const char *s = SvPVX_const(sv);
1737           const char * const end = s + SvCUR(sv);
1738           for ( ; s < end && d < limit; s++ ) {
1739                int ch = *s & 0xFF;
1740                if (ch & 128 && !isPRINT_LC(ch)) {
1741                     *d++ = 'M';
1742                     *d++ = '-';
1743                     ch &= 127;
1744                }
1745                if (ch == '\n') {
1746                     *d++ = '\\';
1747                     *d++ = 'n';
1748                }
1749                else if (ch == '\r') {
1750                     *d++ = '\\';
1751                     *d++ = 'r';
1752                }
1753                else if (ch == '\f') {
1754                     *d++ = '\\';
1755                     *d++ = 'f';
1756                }
1757                else if (ch == '\\') {
1758                     *d++ = '\\';
1759                     *d++ = '\\';
1760                }
1761                else if (ch == '\0') {
1762                     *d++ = '\\';
1763                     *d++ = '0';
1764                }
1765                else if (isPRINT_LC(ch))
1766                     *d++ = ch;
1767                else {
1768                     *d++ = '^';
1769                     *d++ = toCTRL(ch);
1770                }
1771           }
1772           if (s < end) {
1773                *d++ = '.';
1774                *d++ = '.';
1775                *d++ = '.';
1776           }
1777           *d = '\0';
1778           pv = tmpbuf;
1779     }
1780
1781     if (PL_op)
1782         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1783                     /* diag_listed_as: Argument "%s" isn't numeric%s */
1784                     "Argument \"%s\" isn't numeric in %s", pv,
1785                     OP_DESC(PL_op));
1786     else
1787         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1788                     /* diag_listed_as: Argument "%s" isn't numeric%s */
1789                     "Argument \"%s\" isn't numeric", pv);
1790 }
1791
1792 /*
1793 =for apidoc looks_like_number
1794
1795 Test if the content of an SV looks like a number (or is a number).
1796 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1797 non-numeric warning), even if your atof() doesn't grok them.  Get-magic is
1798 ignored.
1799
1800 =cut
1801 */
1802
1803 I32
1804 Perl_looks_like_number(pTHX_ SV *const sv)
1805 {
1806     const char *sbegin;
1807     STRLEN len;
1808
1809     PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1810
1811     if (SvPOK(sv) || SvPOKp(sv)) {
1812         sbegin = SvPV_nomg_const(sv, len);
1813     }
1814     else
1815         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1816     return grok_number(sbegin, len, NULL);
1817 }
1818
1819 STATIC bool
1820 S_glob_2number(pTHX_ GV * const gv)
1821 {
1822     PERL_ARGS_ASSERT_GLOB_2NUMBER;
1823
1824     /* We know that all GVs stringify to something that is not-a-number,
1825         so no need to test that.  */
1826     if (ckWARN(WARN_NUMERIC))
1827     {
1828         SV *const buffer = sv_newmortal();
1829         gv_efullname3(buffer, gv, "*");
1830         not_a_number(buffer);
1831     }
1832     /* We just want something true to return, so that S_sv_2iuv_common
1833         can tail call us and return true.  */
1834     return TRUE;
1835 }
1836
1837 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1838    until proven guilty, assume that things are not that bad... */
1839
1840 /*
1841    NV_PRESERVES_UV:
1842
1843    As 64 bit platforms often have an NV that doesn't preserve all bits of
1844    an IV (an assumption perl has been based on to date) it becomes necessary
1845    to remove the assumption that the NV always carries enough precision to
1846    recreate the IV whenever needed, and that the NV is the canonical form.
1847    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1848    precision as a side effect of conversion (which would lead to insanity
1849    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1850    1) to distinguish between IV/UV/NV slots that have cached a valid
1851       conversion where precision was lost and IV/UV/NV slots that have a
1852       valid conversion which has lost no precision
1853    2) to ensure that if a numeric conversion to one form is requested that
1854       would lose precision, the precise conversion (or differently
1855       imprecise conversion) is also performed and cached, to prevent
1856       requests for different numeric formats on the same SV causing
1857       lossy conversion chains. (lossless conversion chains are perfectly
1858       acceptable (still))
1859
1860
1861    flags are used:
1862    SvIOKp is true if the IV slot contains a valid value
1863    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1864    SvNOKp is true if the NV slot contains a valid value
1865    SvNOK  is true only if the NV value is accurate
1866
1867    so
1868    while converting from PV to NV, check to see if converting that NV to an
1869    IV(or UV) would lose accuracy over a direct conversion from PV to
1870    IV(or UV). If it would, cache both conversions, return NV, but mark
1871    SV as IOK NOKp (ie not NOK).
1872
1873    While converting from PV to IV, check to see if converting that IV to an
1874    NV would lose accuracy over a direct conversion from PV to NV. If it
1875    would, cache both conversions, flag similarly.
1876
1877    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1878    correctly because if IV & NV were set NV *always* overruled.
1879    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1880    changes - now IV and NV together means that the two are interchangeable:
1881    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1882
1883    The benefit of this is that operations such as pp_add know that if
1884    SvIOK is true for both left and right operands, then integer addition
1885    can be used instead of floating point (for cases where the result won't
1886    overflow). Before, floating point was always used, which could lead to
1887    loss of precision compared with integer addition.
1888
1889    * making IV and NV equal status should make maths accurate on 64 bit
1890      platforms
1891    * may speed up maths somewhat if pp_add and friends start to use
1892      integers when possible instead of fp. (Hopefully the overhead in
1893      looking for SvIOK and checking for overflow will not outweigh the
1894      fp to integer speedup)
1895    * will slow down integer operations (callers of SvIV) on "inaccurate"
1896      values, as the change from SvIOK to SvIOKp will cause a call into
1897      sv_2iv each time rather than a macro access direct to the IV slot
1898    * should speed up number->string conversion on integers as IV is
1899      favoured when IV and NV are equally accurate
1900
1901    ####################################################################
1902    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1903    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1904    On the other hand, SvUOK is true iff UV.
1905    ####################################################################
1906
1907    Your mileage will vary depending your CPU's relative fp to integer
1908    performance ratio.
1909 */
1910
1911 #ifndef NV_PRESERVES_UV
1912 #  define IS_NUMBER_UNDERFLOW_IV 1
1913 #  define IS_NUMBER_UNDERFLOW_UV 2
1914 #  define IS_NUMBER_IV_AND_UV    2
1915 #  define IS_NUMBER_OVERFLOW_IV  4
1916 #  define IS_NUMBER_OVERFLOW_UV  5
1917
1918 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1919
1920 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1921 STATIC int
1922 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1923 #  ifdef DEBUGGING
1924                        , I32 numtype
1925 #  endif
1926                        )
1927 {
1928     dVAR;
1929
1930     PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1931
1932     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));
1933     if (SvNVX(sv) < (NV)IV_MIN) {
1934         (void)SvIOKp_on(sv);
1935         (void)SvNOK_on(sv);
1936         SvIV_set(sv, IV_MIN);
1937         return IS_NUMBER_UNDERFLOW_IV;
1938     }
1939     if (SvNVX(sv) > (NV)UV_MAX) {
1940         (void)SvIOKp_on(sv);
1941         (void)SvNOK_on(sv);
1942         SvIsUV_on(sv);
1943         SvUV_set(sv, UV_MAX);
1944         return IS_NUMBER_OVERFLOW_UV;
1945     }
1946     (void)SvIOKp_on(sv);
1947     (void)SvNOK_on(sv);
1948     /* Can't use strtol etc to convert this string.  (See truth table in
1949        sv_2iv  */
1950     if (SvNVX(sv) <= (UV)IV_MAX) {
1951         SvIV_set(sv, I_V(SvNVX(sv)));
1952         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1953             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1954         } else {
1955             /* Integer is imprecise. NOK, IOKp */
1956         }
1957         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1958     }
1959     SvIsUV_on(sv);
1960     SvUV_set(sv, U_V(SvNVX(sv)));
1961     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1962         if (SvUVX(sv) == UV_MAX) {
1963             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1964                possibly be preserved by NV. Hence, it must be overflow.
1965                NOK, IOKp */
1966             return IS_NUMBER_OVERFLOW_UV;
1967         }
1968         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1969     } else {
1970         /* Integer is imprecise. NOK, IOKp */
1971     }
1972     return IS_NUMBER_OVERFLOW_IV;
1973 }
1974 #endif /* !NV_PRESERVES_UV*/
1975
1976 STATIC bool
1977 S_sv_2iuv_common(pTHX_ SV *const sv)
1978 {
1979     dVAR;
1980
1981     PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1982
1983     if (SvNOKp(sv)) {
1984         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1985          * without also getting a cached IV/UV from it at the same time
1986          * (ie PV->NV conversion should detect loss of accuracy and cache
1987          * IV or UV at same time to avoid this. */
1988         /* IV-over-UV optimisation - choose to cache IV if possible */
1989
1990         if (SvTYPE(sv) == SVt_NV)
1991             sv_upgrade(sv, SVt_PVNV);
1992
1993         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1994         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1995            certainly cast into the IV range at IV_MAX, whereas the correct
1996            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1997            cases go to UV */
1998 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1999         if (Perl_isnan(SvNVX(sv))) {
2000             SvUV_set(sv, 0);
2001             SvIsUV_on(sv);
2002             return FALSE;
2003         }
2004 #endif
2005         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2006             SvIV_set(sv, I_V(SvNVX(sv)));
2007             if (SvNVX(sv) == (NV) SvIVX(sv)
2008 #ifndef NV_PRESERVES_UV
2009                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2010                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2011                 /* Don't flag it as "accurately an integer" if the number
2012                    came from a (by definition imprecise) NV operation, and
2013                    we're outside the range of NV integer precision */
2014 #endif
2015                 ) {
2016                 if (SvNOK(sv))
2017                     SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2018                 else {
2019                     /* scalar has trailing garbage, eg "42a" */
2020                 }
2021                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2022                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2023                                       PTR2UV(sv),
2024                                       SvNVX(sv),
2025                                       SvIVX(sv)));
2026
2027             } else {
2028                 /* IV not precise.  No need to convert from PV, as NV
2029                    conversion would already have cached IV if it detected
2030                    that PV->IV would be better than PV->NV->IV
2031                    flags already correct - don't set public IOK.  */
2032                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2033                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2034                                       PTR2UV(sv),
2035                                       SvNVX(sv),
2036                                       SvIVX(sv)));
2037             }
2038             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2039                but the cast (NV)IV_MIN rounds to a the value less (more
2040                negative) than IV_MIN which happens to be equal to SvNVX ??
2041                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2042                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2043                (NV)UVX == NVX are both true, but the values differ. :-(
2044                Hopefully for 2s complement IV_MIN is something like
2045                0x8000000000000000 which will be exact. NWC */
2046         }
2047         else {
2048             SvUV_set(sv, U_V(SvNVX(sv)));
2049             if (
2050                 (SvNVX(sv) == (NV) SvUVX(sv))
2051 #ifndef  NV_PRESERVES_UV
2052                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2053                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2054                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2055                 /* Don't flag it as "accurately an integer" if the number
2056                    came from a (by definition imprecise) NV operation, and
2057                    we're outside the range of NV integer precision */
2058 #endif
2059                 && SvNOK(sv)
2060                 )
2061                 SvIOK_on(sv);
2062             SvIsUV_on(sv);
2063             DEBUG_c(PerlIO_printf(Perl_debug_log,
2064                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2065                                   PTR2UV(sv),
2066                                   SvUVX(sv),
2067                                   SvUVX(sv)));
2068         }
2069     }
2070     else if (SvPOKp(sv)) {
2071         UV value;
2072         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2073         /* We want to avoid a possible problem when we cache an IV/ a UV which
2074            may be later translated to an NV, and the resulting NV is not
2075            the same as the direct translation of the initial string
2076            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2077            be careful to ensure that the value with the .456 is around if the
2078            NV value is requested in the future).
2079         
2080            This means that if we cache such an IV/a UV, we need to cache the
2081            NV as well.  Moreover, we trade speed for space, and do not
2082            cache the NV if we are sure it's not needed.
2083          */
2084
2085         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2086         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2087              == IS_NUMBER_IN_UV) {
2088             /* It's definitely an integer, only upgrade to PVIV */
2089             if (SvTYPE(sv) < SVt_PVIV)
2090                 sv_upgrade(sv, SVt_PVIV);
2091             (void)SvIOK_on(sv);
2092         } else if (SvTYPE(sv) < SVt_PVNV)
2093             sv_upgrade(sv, SVt_PVNV);
2094
2095         /* If NVs preserve UVs then we only use the UV value if we know that
2096            we aren't going to call atof() below. If NVs don't preserve UVs
2097            then the value returned may have more precision than atof() will
2098            return, even though value isn't perfectly accurate.  */
2099         if ((numtype & (IS_NUMBER_IN_UV
2100 #ifdef NV_PRESERVES_UV
2101                         | IS_NUMBER_NOT_INT
2102 #endif
2103             )) == IS_NUMBER_IN_UV) {
2104             /* This won't turn off the public IOK flag if it was set above  */
2105             (void)SvIOKp_on(sv);
2106
2107             if (!(numtype & IS_NUMBER_NEG)) {
2108                 /* positive */;
2109                 if (value <= (UV)IV_MAX) {
2110                     SvIV_set(sv, (IV)value);
2111                 } else {
2112                     /* it didn't overflow, and it was positive. */
2113                     SvUV_set(sv, value);
2114                     SvIsUV_on(sv);
2115                 }
2116             } else {
2117                 /* 2s complement assumption  */
2118                 if (value <= (UV)IV_MIN) {
2119                     SvIV_set(sv, -(IV)value);
2120                 } else {
2121                     /* Too negative for an IV.  This is a double upgrade, but
2122                        I'm assuming it will be rare.  */
2123                     if (SvTYPE(sv) < SVt_PVNV)
2124                         sv_upgrade(sv, SVt_PVNV);
2125                     SvNOK_on(sv);
2126                     SvIOK_off(sv);
2127                     SvIOKp_on(sv);
2128                     SvNV_set(sv, -(NV)value);
2129                     SvIV_set(sv, IV_MIN);
2130                 }
2131             }
2132         }
2133         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2134            will be in the previous block to set the IV slot, and the next
2135            block to set the NV slot.  So no else here.  */
2136         
2137         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2138             != IS_NUMBER_IN_UV) {
2139             /* It wasn't an (integer that doesn't overflow the UV). */
2140             SvNV_set(sv, Atof(SvPVX_const(sv)));
2141
2142             if (! numtype && ckWARN(WARN_NUMERIC))
2143                 not_a_number(sv);
2144
2145 #if defined(USE_LONG_DOUBLE)
2146             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2147                                   PTR2UV(sv), SvNVX(sv)));
2148 #else
2149             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2150                                   PTR2UV(sv), SvNVX(sv)));
2151 #endif
2152
2153 #ifdef NV_PRESERVES_UV
2154             (void)SvIOKp_on(sv);
2155             (void)SvNOK_on(sv);
2156             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2157                 SvIV_set(sv, I_V(SvNVX(sv)));
2158                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2159                     SvIOK_on(sv);
2160                 } else {
2161                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2162                 }
2163                 /* UV will not work better than IV */
2164             } else {
2165                 if (SvNVX(sv) > (NV)UV_MAX) {
2166                     SvIsUV_on(sv);
2167                     /* Integer is inaccurate. NOK, IOKp, is UV */
2168                     SvUV_set(sv, UV_MAX);
2169                 } else {
2170                     SvUV_set(sv, U_V(SvNVX(sv)));
2171                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2172                        NV preservse UV so can do correct comparison.  */
2173                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2174                         SvIOK_on(sv);
2175                     } else {
2176                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2177                     }
2178                 }
2179                 SvIsUV_on(sv);
2180             }
2181 #else /* NV_PRESERVES_UV */
2182             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2183                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2184                 /* The IV/UV slot will have been set from value returned by
2185                    grok_number above.  The NV slot has just been set using
2186                    Atof.  */
2187                 SvNOK_on(sv);
2188                 assert (SvIOKp(sv));
2189             } else {
2190                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2191                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2192                     /* Small enough to preserve all bits. */
2193                     (void)SvIOKp_on(sv);
2194                     SvNOK_on(sv);
2195                     SvIV_set(sv, I_V(SvNVX(sv)));
2196                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2197                         SvIOK_on(sv);
2198                     /* Assumption: first non-preserved integer is < IV_MAX,
2199                        this NV is in the preserved range, therefore: */
2200                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2201                           < (UV)IV_MAX)) {
2202                         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);
2203                     }
2204                 } else {
2205                     /* IN_UV NOT_INT
2206                          0      0       already failed to read UV.
2207                          0      1       already failed to read UV.
2208                          1      0       you won't get here in this case. IV/UV
2209                                         slot set, public IOK, Atof() unneeded.
2210                          1      1       already read UV.
2211                        so there's no point in sv_2iuv_non_preserve() attempting
2212                        to use atol, strtol, strtoul etc.  */
2213 #  ifdef DEBUGGING
2214                     sv_2iuv_non_preserve (sv, numtype);
2215 #  else
2216                     sv_2iuv_non_preserve (sv);
2217 #  endif
2218                 }
2219             }
2220 #endif /* NV_PRESERVES_UV */
2221         /* It might be more code efficient to go through the entire logic above
2222            and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2223            gets complex and potentially buggy, so more programmer efficient
2224            to do it this way, by turning off the public flags:  */
2225         if (!numtype)
2226             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2227         }
2228     }
2229     else  {
2230         if (isGV_with_GP(sv))
2231             return glob_2number(MUTABLE_GV(sv));
2232
2233         if (!SvPADTMP(sv)) {
2234             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2235                 report_uninit(sv);
2236         }
2237         if (SvTYPE(sv) < SVt_IV)
2238             /* Typically the caller expects that sv_any is not NULL now.  */
2239             sv_upgrade(sv, SVt_IV);
2240         /* Return 0 from the caller.  */
2241         return TRUE;
2242     }
2243     return FALSE;
2244 }
2245
2246 /*
2247 =for apidoc sv_2iv_flags
2248
2249 Return the integer value of an SV, doing any necessary string
2250 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2251 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2252
2253 =cut
2254 */
2255
2256 IV
2257 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2258 {
2259     dVAR;
2260
2261     if (!sv)
2262         return 0;
2263
2264     if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2265         mg_get(sv);
2266
2267     if (SvROK(sv)) {
2268         if (SvAMAGIC(sv)) {
2269             SV * tmpstr;
2270             if (flags & SV_SKIP_OVERLOAD)
2271                 return 0;
2272             tmpstr = AMG_CALLunary(sv, numer_amg);
2273             if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2274                 return SvIV(tmpstr);
2275             }
2276         }
2277         return PTR2IV(SvRV(sv));
2278     }
2279
2280     if (SvVALID(sv) || isREGEXP(sv)) {
2281         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2282            the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2283            In practice they are extremely unlikely to actually get anywhere
2284            accessible by user Perl code - the only way that I'm aware of is when
2285            a constant subroutine which is used as the second argument to index.
2286
2287            Regexps have no SvIVX and SvNVX fields.
2288         */
2289         assert(isREGEXP(sv) || SvPOKp(sv));
2290         {
2291             UV value;
2292             const char * const ptr =
2293                 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2294             const int numtype
2295                 = grok_number(ptr, SvCUR(sv), &value);
2296
2297             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2298                 == IS_NUMBER_IN_UV) {
2299                 /* It's definitely an integer */
2300                 if (numtype & IS_NUMBER_NEG) {
2301                     if (value < (UV)IV_MIN)
2302                         return -(IV)value;
2303                 } else {
2304                     if (value < (UV)IV_MAX)
2305                         return (IV)value;
2306                 }
2307             }
2308             if (!numtype) {
2309                 if (ckWARN(WARN_NUMERIC))
2310                     not_a_number(sv);
2311             }
2312             return I_V(Atof(ptr));
2313         }
2314     }
2315
2316     if (SvTHINKFIRST(sv)) {
2317 #ifdef PERL_OLD_COPY_ON_WRITE
2318         if (SvIsCOW(sv)) {
2319             sv_force_normal_flags(sv, 0);
2320         }
2321 #endif
2322         if (SvREADONLY(sv) && !SvOK(sv)) {
2323             if (ckWARN(WARN_UNINITIALIZED))
2324                 report_uninit(sv);
2325             return 0;
2326         }
2327     }
2328
2329     if (!SvIOKp(sv)) {
2330         if (S_sv_2iuv_common(aTHX_ sv))
2331             return 0;
2332     }
2333
2334     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2335         PTR2UV(sv),SvIVX(sv)));
2336     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2337 }
2338
2339 /*
2340 =for apidoc sv_2uv_flags
2341
2342 Return the unsigned integer value of an SV, doing any necessary string
2343 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2344 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2345
2346 =cut
2347 */
2348
2349 UV
2350 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2351 {
2352     dVAR;
2353
2354     if (!sv)
2355         return 0;
2356
2357     if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2358         mg_get(sv);
2359
2360     if (SvROK(sv)) {
2361         if (SvAMAGIC(sv)) {
2362             SV *tmpstr;
2363             if (flags & SV_SKIP_OVERLOAD)
2364                 return 0;
2365             tmpstr = AMG_CALLunary(sv, numer_amg);
2366             if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2367                 return SvUV(tmpstr);
2368             }
2369         }
2370         return PTR2UV(SvRV(sv));
2371     }
2372
2373     if (SvVALID(sv) || isREGEXP(sv)) {
2374         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2375            the same flag bit as SVf_IVisUV, so must not let them cache IVs.  
2376            Regexps have no SvIVX and SvNVX fields. */
2377         assert(isREGEXP(sv) || SvPOKp(sv));
2378         {
2379             UV value;
2380             const char * const ptr =
2381                 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2382             const int numtype
2383                 = grok_number(ptr, SvCUR(sv), &value);
2384
2385             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2386                 == IS_NUMBER_IN_UV) {
2387                 /* It's definitely an integer */
2388                 if (!(numtype & IS_NUMBER_NEG))
2389                     return value;
2390             }
2391             if (!numtype) {
2392                 if (ckWARN(WARN_NUMERIC))
2393                     not_a_number(sv);
2394             }
2395             return U_V(Atof(ptr));
2396         }
2397     }
2398
2399     if (SvTHINKFIRST(sv)) {
2400 #ifdef PERL_OLD_COPY_ON_WRITE
2401         if (SvIsCOW(sv)) {
2402             sv_force_normal_flags(sv, 0);
2403         }
2404 #endif
2405         if (SvREADONLY(sv) && !SvOK(sv)) {
2406             if (ckWARN(WARN_UNINITIALIZED))
2407                 report_uninit(sv);
2408             return 0;
2409         }
2410     }
2411
2412     if (!SvIOKp(sv)) {
2413         if (S_sv_2iuv_common(aTHX_ sv))
2414             return 0;
2415     }
2416
2417     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2418                           PTR2UV(sv),SvUVX(sv)));
2419     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2420 }
2421
2422 /*
2423 =for apidoc sv_2nv_flags
2424
2425 Return the num value of an SV, doing any necessary string or integer
2426 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2427 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2428
2429 =cut
2430 */
2431
2432 NV
2433 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2434 {
2435     dVAR;
2436     if (!sv)
2437         return 0.0;
2438     if (SvGMAGICAL(sv) || SvVALID(sv) || isREGEXP(sv)) {
2439         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2440            the same flag bit as SVf_IVisUV, so must not let them cache NVs.
2441            Regexps have no SvIVX and SvNVX fields.  */
2442         const char *ptr;
2443         if (flags & SV_GMAGIC)
2444             mg_get(sv);
2445         if (SvNOKp(sv))
2446             return SvNVX(sv);
2447         if (SvPOKp(sv) && !SvIOKp(sv)) {
2448             ptr = SvPVX_const(sv);
2449           grokpv:
2450             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2451                 !grok_number(ptr, SvCUR(sv), NULL))
2452                 not_a_number(sv);
2453             return Atof(ptr);
2454         }
2455         if (SvIOKp(sv)) {
2456             if (SvIsUV(sv))
2457                 return (NV)SvUVX(sv);
2458             else
2459                 return (NV)SvIVX(sv);
2460         }
2461         if (SvROK(sv)) {
2462             goto return_rok;
2463         }
2464         if (isREGEXP(sv)) {
2465             ptr = RX_WRAPPED((REGEXP *)sv);
2466             goto grokpv;
2467         }
2468         assert(SvTYPE(sv) >= SVt_PVMG);
2469         /* This falls through to the report_uninit near the end of the
2470            function. */
2471     } else if (SvTHINKFIRST(sv)) {
2472         if (SvROK(sv)) {
2473         return_rok:
2474             if (SvAMAGIC(sv)) {
2475                 SV *tmpstr;
2476                 if (flags & SV_SKIP_OVERLOAD)
2477                     return 0;
2478                 tmpstr = AMG_CALLunary(sv, numer_amg);
2479                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2480                     return SvNV(tmpstr);
2481                 }
2482             }
2483             return PTR2NV(SvRV(sv));
2484         }
2485 #ifdef PERL_OLD_COPY_ON_WRITE
2486         if (SvIsCOW(sv)) {
2487             sv_force_normal_flags(sv, 0);
2488         }
2489 #endif
2490         if (SvREADONLY(sv) && !SvOK(sv)) {
2491             if (ckWARN(WARN_UNINITIALIZED))
2492                 report_uninit(sv);
2493             return 0.0;
2494         }
2495     }
2496     if (SvTYPE(sv) < SVt_NV) {
2497         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2498         sv_upgrade(sv, SVt_NV);
2499 #ifdef USE_LONG_DOUBLE
2500         DEBUG_c({
2501             STORE_NUMERIC_LOCAL_SET_STANDARD();
2502             PerlIO_printf(Perl_debug_log,
2503                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2504                           PTR2UV(sv), SvNVX(sv));
2505             RESTORE_NUMERIC_LOCAL();
2506         });
2507 #else
2508         DEBUG_c({
2509             STORE_NUMERIC_LOCAL_SET_STANDARD();
2510             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2511                           PTR2UV(sv), SvNVX(sv));
2512             RESTORE_NUMERIC_LOCAL();
2513         });
2514 #endif
2515     }
2516     else if (SvTYPE(sv) < SVt_PVNV)
2517         sv_upgrade(sv, SVt_PVNV);
2518     if (SvNOKp(sv)) {
2519         return SvNVX(sv);
2520     }
2521     if (SvIOKp(sv)) {
2522         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2523 #ifdef NV_PRESERVES_UV
2524         if (SvIOK(sv))
2525             SvNOK_on(sv);
2526         else
2527             SvNOKp_on(sv);
2528 #else
2529         /* Only set the public NV OK flag if this NV preserves the IV  */
2530         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2531         if (SvIOK(sv) &&
2532             SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2533                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2534             SvNOK_on(sv);
2535         else
2536             SvNOKp_on(sv);
2537 #endif
2538     }
2539     else if (SvPOKp(sv)) {
2540         UV value;
2541         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2542         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2543             not_a_number(sv);
2544 #ifdef NV_PRESERVES_UV
2545         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2546             == IS_NUMBER_IN_UV) {
2547             /* It's definitely an integer */
2548             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2549         } else
2550             SvNV_set(sv, Atof(SvPVX_const(sv)));
2551         if (numtype)
2552             SvNOK_on(sv);
2553         else
2554             SvNOKp_on(sv);
2555 #else
2556         SvNV_set(sv, Atof(SvPVX_const(sv)));
2557         /* Only set the public NV OK flag if this NV preserves the value in
2558            the PV at least as well as an IV/UV would.
2559            Not sure how to do this 100% reliably. */
2560         /* if that shift count is out of range then Configure's test is
2561            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2562            UV_BITS */
2563         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2564             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2565             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2566         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2567             /* Can't use strtol etc to convert this string, so don't try.
2568                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2569             SvNOK_on(sv);
2570         } else {
2571             /* value has been set.  It may not be precise.  */
2572             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2573                 /* 2s complement assumption for (UV)IV_MIN  */
2574                 SvNOK_on(sv); /* Integer is too negative.  */
2575             } else {
2576                 SvNOKp_on(sv);
2577                 SvIOKp_on(sv);
2578
2579                 if (numtype & IS_NUMBER_NEG) {
2580                     SvIV_set(sv, -(IV)value);
2581                 } else if (value <= (UV)IV_MAX) {
2582                     SvIV_set(sv, (IV)value);
2583                 } else {
2584                     SvUV_set(sv, value);
2585                     SvIsUV_on(sv);
2586                 }
2587
2588                 if (numtype & IS_NUMBER_NOT_INT) {
2589                     /* I believe that even if the original PV had decimals,
2590                        they are lost beyond the limit of the FP precision.
2591                        However, neither is canonical, so both only get p
2592                        flags.  NWC, 2000/11/25 */
2593                     /* Both already have p flags, so do nothing */
2594                 } else {
2595                     const NV nv = SvNVX(sv);
2596                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2597                         if (SvIVX(sv) == I_V(nv)) {
2598                             SvNOK_on(sv);
2599                         } else {
2600                             /* It had no "." so it must be integer.  */
2601                         }
2602                         SvIOK_on(sv);
2603                     } else {
2604                         /* between IV_MAX and NV(UV_MAX).
2605                            Could be slightly > UV_MAX */
2606
2607                         if (numtype & IS_NUMBER_NOT_INT) {
2608                             /* UV and NV both imprecise.  */
2609                         } else {
2610                             const UV nv_as_uv = U_V(nv);
2611
2612                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2613                                 SvNOK_on(sv);
2614                             }
2615                             SvIOK_on(sv);
2616                         }
2617                     }
2618                 }
2619             }
2620         }
2621         /* It might be more code efficient to go through the entire logic above
2622            and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2623            gets complex and potentially buggy, so more programmer efficient
2624            to do it this way, by turning off the public flags:  */
2625         if (!numtype)
2626             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2627 #endif /* NV_PRESERVES_UV */
2628     }
2629     else  {
2630         if (isGV_with_GP(sv)) {
2631             glob_2number(MUTABLE_GV(sv));
2632             return 0.0;
2633         }
2634
2635         if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2636             report_uninit(sv);
2637         assert (SvTYPE(sv) >= SVt_NV);
2638         /* Typically the caller expects that sv_any is not NULL now.  */
2639         /* XXX Ilya implies that this is a bug in callers that assume this
2640            and ideally should be fixed.  */
2641         return 0.0;
2642     }
2643 #if defined(USE_LONG_DOUBLE)
2644     DEBUG_c({
2645         STORE_NUMERIC_LOCAL_SET_STANDARD();
2646         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2647                       PTR2UV(sv), SvNVX(sv));
2648         RESTORE_NUMERIC_LOCAL();
2649     });
2650 #else
2651     DEBUG_c({
2652         STORE_NUMERIC_LOCAL_SET_STANDARD();
2653         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2654                       PTR2UV(sv), SvNVX(sv));
2655         RESTORE_NUMERIC_LOCAL();
2656     });
2657 #endif
2658     return SvNVX(sv);
2659 }
2660
2661 /*
2662 =for apidoc sv_2num
2663
2664 Return an SV with the numeric value of the source SV, doing any necessary
2665 reference or overload conversion.  You must use the C<SvNUM(sv)> macro to
2666 access this function.
2667
2668 =cut
2669 */
2670
2671 SV *
2672 Perl_sv_2num(pTHX_ register SV *const sv)
2673 {
2674     PERL_ARGS_ASSERT_SV_2NUM;
2675
2676     if (!SvROK(sv))
2677         return sv;
2678     if (SvAMAGIC(sv)) {
2679         SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2680         TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2681         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2682             return sv_2num(tmpsv);
2683     }
2684     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2685 }
2686
2687 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2688  * UV as a string towards the end of buf, and return pointers to start and
2689  * end of it.
2690  *
2691  * We assume that buf is at least TYPE_CHARS(UV) long.
2692  */
2693
2694 static char *
2695 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2696 {
2697     char *ptr = buf + TYPE_CHARS(UV);
2698     char * const ebuf = ptr;
2699     int sign;
2700
2701     PERL_ARGS_ASSERT_UIV_2BUF;
2702
2703     if (is_uv)
2704         sign = 0;
2705     else if (iv >= 0) {
2706         uv = iv;
2707         sign = 0;
2708     } else {
2709         uv = -iv;
2710         sign = 1;
2711     }
2712     do {
2713         *--ptr = '0' + (char)(uv % 10);
2714     } while (uv /= 10);
2715     if (sign)
2716         *--ptr = '-';
2717     *peob = ebuf;
2718     return ptr;
2719 }
2720
2721 /*
2722 =for apidoc sv_2pv_flags
2723
2724 Returns a pointer to the string value of an SV, and sets *lp to its length.
2725 If flags includes SV_GMAGIC, does an mg_get() first.  Coerces sv to a
2726 string if necessary.  Normally invoked via the C<SvPV_flags> macro.
2727 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2728
2729 =cut
2730 */
2731
2732 char *
2733 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2734 {
2735     dVAR;
2736     char *s;
2737
2738     if (!sv) {
2739         if (lp)
2740             *lp = 0;
2741         return (char *)"";
2742     }
2743     if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2744         mg_get(sv);
2745     if (SvROK(sv)) {
2746         if (SvAMAGIC(sv)) {
2747             SV *tmpstr;
2748             if (flags & SV_SKIP_OVERLOAD)
2749                 return NULL;
2750             tmpstr = AMG_CALLunary(sv, string_amg);
2751             TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2752             if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2753                 /* Unwrap this:  */
2754                 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2755                  */
2756
2757                 char *pv;
2758                 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2759                     if (flags & SV_CONST_RETURN) {
2760                         pv = (char *) SvPVX_const(tmpstr);
2761                     } else {
2762                         pv = (flags & SV_MUTABLE_RETURN)
2763                             ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2764                     }
2765                     if (lp)
2766                         *lp = SvCUR(tmpstr);
2767                 } else {
2768                     pv = sv_2pv_flags(tmpstr, lp, flags);
2769                 }
2770                 if (SvUTF8(tmpstr))
2771                     SvUTF8_on(sv);
2772                 else
2773                     SvUTF8_off(sv);
2774                 return pv;
2775             }
2776         }
2777         {
2778             STRLEN len;
2779             char *retval;
2780             char *buffer;
2781             SV *const referent = SvRV(sv);
2782
2783             if (!referent) {
2784                 len = 7;
2785                 retval = buffer = savepvn("NULLREF", len);
2786             } else if (SvTYPE(referent) == SVt_REGEXP &&
2787                        (!(PL_curcop->cop_hints & HINT_NO_AMAGIC) ||
2788                         amagic_is_enabled(string_amg))) {
2789                 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2790
2791                 assert(re);
2792                         
2793                 /* If the regex is UTF-8 we want the containing scalar to
2794                    have an UTF-8 flag too */
2795                 if (RX_UTF8(re))
2796                     SvUTF8_on(sv);
2797                 else
2798                     SvUTF8_off(sv);     
2799
2800                 if (lp)
2801                     *lp = RX_WRAPLEN(re);
2802  
2803                 return RX_WRAPPED(re);
2804             } else {
2805                 const char *const typestr = sv_reftype(referent, 0);
2806                 const STRLEN typelen = strlen(typestr);
2807                 UV addr = PTR2UV(referent);
2808                 const char *stashname = NULL;
2809                 STRLEN stashnamelen = 0; /* hush, gcc */
2810                 const char *buffer_end;
2811
2812                 if (SvOBJECT(referent)) {
2813                     const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2814
2815                     if (name) {
2816                         stashname = HEK_KEY(name);
2817                         stashnamelen = HEK_LEN(name);
2818
2819                         if (HEK_UTF8(name)) {
2820                             SvUTF8_on(sv);
2821                         } else {
2822                             SvUTF8_off(sv);
2823                         }
2824                     } else {
2825                         stashname = "__ANON__";
2826                         stashnamelen = 8;
2827                     }
2828                     len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2829                         + 2 * sizeof(UV) + 2 /* )\0 */;
2830                 } else {
2831                     len = typelen + 3 /* (0x */
2832                         + 2 * sizeof(UV) + 2 /* )\0 */;
2833                 }
2834
2835                 Newx(buffer, len, char);
2836                 buffer_end = retval = buffer + len;
2837
2838                 /* Working backwards  */
2839                 *--retval = '\0';
2840                 *--retval = ')';
2841                 do {
2842                     *--retval = PL_hexdigit[addr & 15];
2843                 } while (addr >>= 4);
2844                 *--retval = 'x';
2845                 *--retval = '0';
2846                 *--retval = '(';
2847
2848                 retval -= typelen;
2849                 memcpy(retval, typestr, typelen);
2850
2851                 if (stashname) {
2852                     *--retval = '=';
2853                     retval -= stashnamelen;
2854                     memcpy(retval, stashname, stashnamelen);
2855                 }
2856                 /* retval may not necessarily have reached the start of the
2857                    buffer here.  */
2858                 assert (retval >= buffer);
2859
2860                 len = buffer_end - retval - 1; /* -1 for that \0  */
2861             }
2862             if (lp)
2863                 *lp = len;
2864             SAVEFREEPV(buffer);
2865             return retval;
2866         }
2867     }
2868
2869     if (SvPOKp(sv)) {
2870         if (lp)
2871             *lp = SvCUR(sv);
2872         if (flags & SV_MUTABLE_RETURN)
2873             return SvPVX_mutable(sv);
2874         if (flags & SV_CONST_RETURN)
2875             return (char *)SvPVX_const(sv);
2876         return SvPVX(sv);
2877     }
2878
2879     if (SvIOK(sv)) {
2880         /* I'm assuming that if both IV and NV are equally valid then
2881            converting the IV is going to be more efficient */
2882         const U32 isUIOK = SvIsUV(sv);
2883         char buf[TYPE_CHARS(UV)];
2884         char *ebuf, *ptr;
2885         STRLEN len;
2886
2887         if (SvTYPE(sv) < SVt_PVIV)
2888             sv_upgrade(sv, SVt_PVIV);
2889         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2890         len = ebuf - ptr;
2891         /* inlined from sv_setpvn */
2892         s = SvGROW_mutable(sv, len + 1);
2893         Move(ptr, s, len, char);
2894         s += len;
2895         *s = '\0';
2896     }
2897     else if (SvNOK(sv)) {
2898         if (SvTYPE(sv) < SVt_PVNV)
2899             sv_upgrade(sv, SVt_PVNV);
2900         if (SvNVX(sv) == 0.0) {
2901             s = SvGROW_mutable(sv, 2);
2902             *s++ = '0';
2903             *s = '\0';
2904         } else {
2905             dSAVE_ERRNO;
2906             /* The +20 is pure guesswork.  Configure test needed. --jhi */
2907             s = SvGROW_mutable(sv, NV_DIG + 20);
2908             /* some Xenix systems wipe out errno here */
2909             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2910             RESTORE_ERRNO;
2911             while (*s) s++;
2912         }
2913 #ifdef hcx
2914         if (s[-1] == '.')
2915             *--s = '\0';
2916 #endif
2917     }
2918     else if (isGV_with_GP(sv)) {
2919         GV *const gv = MUTABLE_GV(sv);
2920         SV *const buffer = sv_newmortal();
2921
2922         gv_efullname3(buffer, gv, "*");
2923
2924         assert(SvPOK(buffer));
2925         if (SvUTF8(buffer))
2926             SvUTF8_on(sv);
2927         if (lp)
2928             *lp = SvCUR(buffer);
2929         return SvPVX(buffer);
2930     }
2931     else if (isREGEXP(sv)) {
2932         if (lp) *lp = RX_WRAPLEN((REGEXP *)sv);
2933         return RX_WRAPPED((REGEXP *)sv);
2934     }
2935     else {
2936         if (lp)
2937             *lp = 0;
2938         if (flags & SV_UNDEF_RETURNS_NULL)
2939             return NULL;
2940         if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2941             report_uninit(sv);
2942         /* Typically the caller expects that sv_any is not NULL now.  */
2943         if (!SvREADONLY(sv) && SvTYPE(sv) < SVt_PV)
2944             sv_upgrade(sv, SVt_PV);
2945         return (char *)"";
2946     }
2947
2948     {
2949         const STRLEN len = s - SvPVX_const(sv);
2950         if (lp) 
2951             *lp = len;
2952         SvCUR_set(sv, len);
2953     }
2954     SvPOK_on(sv);
2955     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2956                           PTR2UV(sv),SvPVX_const(sv)));
2957     if (flags & SV_CONST_RETURN)
2958         return (char *)SvPVX_const(sv);
2959     if (flags & SV_MUTABLE_RETURN)
2960         return SvPVX_mutable(sv);
2961     return SvPVX(sv);
2962 }
2963
2964 /*
2965 =for apidoc sv_copypv
2966
2967 Copies a stringified representation of the source SV into the
2968 destination SV.  Automatically performs any necessary mg_get and
2969 coercion of numeric values into strings.  Guaranteed to preserve
2970 UTF8 flag even from overloaded objects.  Similar in nature to
2971 sv_2pv[_flags] but operates directly on an SV instead of just the
2972 string.  Mostly uses sv_2pv_flags to do its work, except when that
2973 would lose the UTF-8'ness of the PV.
2974
2975 =for apidoc sv_copypv_nomg
2976
2977 Like sv_copypv, but doesn't invoke get magic first.
2978
2979 =for apidoc sv_copypv_flags
2980
2981 Implementation of sv_copypv and sv_copypv_nomg.  Calls get magic iff flags
2982 include SV_GMAGIC.
2983
2984 =cut
2985 */
2986
2987 void
2988 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2989 {
2990     PERL_ARGS_ASSERT_SV_COPYPV;
2991
2992     sv_copypv_flags(dsv, ssv, 0);
2993 }
2994
2995 void
2996 Perl_sv_copypv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
2997 {
2998     STRLEN len;
2999     const char *s;
3000
3001     PERL_ARGS_ASSERT_SV_COPYPV_FLAGS;
3002
3003     if ((flags & SV_GMAGIC) && SvGMAGICAL(ssv))
3004         mg_get(ssv);
3005     s = SvPV_nomg_const(ssv,len);
3006     sv_setpvn(dsv,s,len);
3007     if (SvUTF8(ssv))
3008         SvUTF8_on(dsv);
3009     else
3010         SvUTF8_off(dsv);
3011 }
3012
3013 /*
3014 =for apidoc sv_2pvbyte
3015
3016 Return a pointer to the byte-encoded representation of the SV, and set *lp
3017 to its length.  May cause the SV to be downgraded from UTF-8 as a
3018 side-effect.
3019
3020 Usually accessed via the C<SvPVbyte> macro.
3021
3022 =cut
3023 */
3024
3025 char *
3026 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *const lp)
3027 {
3028     PERL_ARGS_ASSERT_SV_2PVBYTE;
3029
3030     if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3031      || isGV_with_GP(sv) || SvROK(sv)) {
3032         SV *sv2 = sv_newmortal();
3033         sv_copypv(sv2,sv);
3034         sv = sv2;
3035     }
3036     else SvGETMAGIC(sv);
3037     sv_utf8_downgrade(sv,0);
3038     return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3039 }
3040
3041 /*
3042 =for apidoc sv_2pvutf8
3043
3044 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3045 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3046
3047 Usually accessed via the C<SvPVutf8> macro.
3048
3049 =cut
3050 */
3051
3052 char *
3053 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *const lp)
3054 {
3055     PERL_ARGS_ASSERT_SV_2PVUTF8;
3056
3057     if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3058      || isGV_with_GP(sv) || SvROK(sv))
3059         sv = sv_mortalcopy(sv);
3060     else
3061         SvGETMAGIC(sv);
3062     sv_utf8_upgrade_nomg(sv);
3063     return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3064 }
3065
3066
3067 /*
3068 =for apidoc sv_2bool
3069
3070 This macro is only used by sv_true() or its macro equivalent, and only if
3071 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3072 It calls sv_2bool_flags with the SV_GMAGIC flag.
3073
3074 =for apidoc sv_2bool_flags
3075
3076 This function is only used by sv_true() and friends,  and only if
3077 the latter's argument is neither SvPOK, SvIOK nor SvNOK.  If the flags
3078 contain SV_GMAGIC, then it does an mg_get() first.
3079
3080
3081 =cut
3082 */
3083
3084 bool
3085 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3086 {
3087     dVAR;
3088
3089     PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3090
3091     if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3092
3093     if (!SvOK(sv))
3094         return 0;
3095     if (SvROK(sv)) {
3096         if (SvAMAGIC(sv)) {
3097             SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3098             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3099                 return cBOOL(SvTRUE(tmpsv));
3100         }
3101         return SvRV(sv) != 0;
3102     }
3103     return SvTRUE_common(sv, isGV_with_GP(sv) ? 1 : 0);
3104 }
3105
3106 /*
3107 =for apidoc sv_utf8_upgrade
3108
3109 Converts the PV of an SV to its UTF-8-encoded form.
3110 Forces the SV to string form if it is not already.
3111 Will C<mg_get> on C<sv> if appropriate.
3112 Always sets the SvUTF8 flag to avoid future validity checks even
3113 if the whole string is the same in UTF-8 as not.
3114 Returns the number of bytes in the converted string
3115
3116 This is not a general purpose byte encoding to Unicode interface:
3117 use the Encode extension for that.
3118
3119 =for apidoc sv_utf8_upgrade_nomg
3120
3121 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3122
3123 =for apidoc sv_utf8_upgrade_flags
3124
3125 Converts the PV of an SV to its UTF-8-encoded form.
3126 Forces the SV to string form if it is not already.
3127 Always sets the SvUTF8 flag to avoid future validity checks even
3128 if all the bytes are invariant in UTF-8.
3129 If C<flags> has C<SV_GMAGIC> bit set,
3130 will C<mg_get> on C<sv> if appropriate, else not.
3131 Returns the number of bytes in the converted string
3132 C<sv_utf8_upgrade> and
3133 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3134
3135 This is not a general purpose byte encoding to Unicode interface:
3136 use the Encode extension for that.
3137
3138 =cut
3139
3140 The grow version is currently not externally documented.  It adds a parameter,
3141 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3142 have free after it upon return.  This allows the caller to reserve extra space
3143 that it intends to fill, to avoid extra grows.
3144
3145 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3146 which can be used to tell this function to not first check to see if there are
3147 any characters that are different in UTF-8 (variant characters) which would
3148 force it to allocate a new string to sv, but to assume there are.  Typically
3149 this flag is used by a routine that has already parsed the string to find that
3150 there are such characters, and passes this information on so that the work
3151 doesn't have to be repeated.
3152
3153 (One might think that the calling routine could pass in the position of the
3154 first such variant, so it wouldn't have to be found again.  But that is not the
3155 case, because typically when the caller is likely to use this flag, it won't be
3156 calling this routine unless it finds something that won't fit into a byte.
3157 Otherwise it tries to not upgrade and just use bytes.  But some things that
3158 do fit into a byte are variants in utf8, and the caller may not have been
3159 keeping track of these.)
3160
3161 If the routine itself changes the string, it adds a trailing NUL.  Such a NUL
3162 isn't guaranteed due to having other routines do the work in some input cases,
3163 or if the input is already flagged as being in utf8.
3164
3165 The speed of this could perhaps be improved for many cases if someone wanted to
3166 write a fast function that counts the number of variant characters in a string,
3167 especially if it could return the position of the first one.
3168
3169 */
3170
3171 STRLEN
3172 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3173 {
3174     dVAR;
3175
3176     PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3177
3178     if (sv == &PL_sv_undef)
3179         return 0;
3180     if (!SvPOK_nog(sv)) {
3181         STRLEN len = 0;
3182         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3183             (void) sv_2pv_flags(sv,&len, flags);
3184             if (SvUTF8(sv)) {
3185                 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3186                 return len;
3187             }
3188         } else {
3189             (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3190         }
3191     }
3192
3193     if (SvUTF8(sv)) {
3194         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3195         return SvCUR(sv);
3196     }
3197
3198     if (SvIsCOW(sv)) {
3199         sv_force_normal_flags(sv, 0);
3200     }
3201
3202     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3203         sv_recode_to_utf8(sv, PL_encoding);
3204         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3205         return SvCUR(sv);
3206     }
3207
3208     if (SvCUR(sv) == 0) {
3209         if (extra) SvGROW(sv, extra);
3210     } else { /* Assume Latin-1/EBCDIC */
3211         /* This function could be much more efficient if we
3212          * had a FLAG in SVs to signal if there are any variant
3213          * chars in the PV.  Given that there isn't such a flag
3214          * make the loop as fast as possible (although there are certainly ways
3215          * to speed this up, eg. through vectorization) */
3216         U8 * s = (U8 *) SvPVX_const(sv);
3217         U8 * e = (U8 *) SvEND(sv);
3218         U8 *t = s;
3219         STRLEN two_byte_count = 0;
3220         
3221         if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3222
3223         /* See if really will need to convert to utf8.  We mustn't rely on our
3224          * incoming SV being well formed and having a trailing '\0', as certain
3225          * code in pp_formline can send us partially built SVs. */
3226
3227         while (t < e) {
3228             const U8 ch = *t++;
3229             if (NATIVE_IS_INVARIANT(ch)) continue;
3230
3231             t--;    /* t already incremented; re-point to first variant */
3232             two_byte_count = 1;
3233             goto must_be_utf8;
3234         }
3235
3236         /* utf8 conversion not needed because all are invariants.  Mark as
3237          * UTF-8 even if no variant - saves scanning loop */
3238         SvUTF8_on(sv);
3239         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3240         return SvCUR(sv);
3241
3242 must_be_utf8:
3243
3244         /* Here, the string should be converted to utf8, either because of an
3245          * input flag (two_byte_count = 0), or because a character that
3246          * requires 2 bytes was found (two_byte_count = 1).  t points either to
3247          * the beginning of the string (if we didn't examine anything), or to
3248          * the first variant.  In either case, everything from s to t - 1 will
3249          * occupy only 1 byte each on output.
3250          *
3251          * There are two main ways to convert.  One is to create a new string
3252          * and go through the input starting from the beginning, appending each
3253          * converted value onto the new string as we go along.  It's probably
3254          * best to allocate enough space in the string for the worst possible
3255          * case rather than possibly running out of space and having to
3256          * reallocate and then copy what we've done so far.  Since everything
3257          * from s to t - 1 is invariant, the destination can be initialized
3258          * with these using a fast memory copy
3259          *
3260          * The other way is to figure out exactly how big the string should be
3261          * by parsing the entire input.  Then you don't have to make it big
3262          * enough to handle the worst possible case, and more importantly, if
3263          * the string you already have is large enough, you don't have to
3264          * allocate a new string, you can copy the last character in the input
3265          * string to the final position(s) that will be occupied by the
3266          * converted string and go backwards, stopping at t, since everything
3267          * before that is invariant.
3268          *
3269          * There are advantages and disadvantages to each method.
3270          *
3271          * In the first method, we can allocate a new string, do the memory
3272          * copy from the s to t - 1, and then proceed through the rest of the
3273          * string byte-by-byte.
3274          *
3275          * In the second method, we proceed through the rest of the input
3276          * string just calculating how big the converted string will be.  Then
3277          * there are two cases:
3278          *  1)  if the string has enough extra space to handle the converted
3279          *      value.  We go backwards through the string, converting until we
3280          *      get to the position we are at now, and then stop.  If this
3281          *      position is far enough along in the string, this method is
3282          *      faster than the other method.  If the memory copy were the same
3283          *      speed as the byte-by-byte loop, that position would be about
3284          *      half-way, as at the half-way mark, parsing to the end and back
3285          *      is one complete string's parse, the same amount as starting
3286          *      over and going all the way through.  Actually, it would be
3287          *      somewhat less than half-way, as it's faster to just count bytes
3288          *      than to also copy, and we don't have the overhead of allocating
3289          *      a new string, changing the scalar to use it, and freeing the
3290          *      existing one.  But if the memory copy is fast, the break-even
3291          *      point is somewhere after half way.  The counting loop could be
3292          *      sped up by vectorization, etc, to move the break-even point
3293          *      further towards the beginning.
3294          *  2)  if the string doesn't have enough space to handle the converted
3295          *      value.  A new string will have to be allocated, and one might
3296          *      as well, given that, start from the beginning doing the first
3297          *      method.  We've spent extra time parsing the string and in
3298          *      exchange all we've gotten is that we know precisely how big to
3299          *      make the new one.  Perl is more optimized for time than space,
3300          *      so this case is a loser.
3301          * So what I've decided to do is not use the 2nd method unless it is
3302          * guaranteed that a new string won't have to be allocated, assuming
3303          * the worst case.  I also decided not to put any more conditions on it
3304          * than this, for now.  It seems likely that, since the worst case is
3305          * twice as big as the unknown portion of the string (plus 1), we won't
3306          * be guaranteed enough space, causing us to go to the first method,
3307          * unless the string is short, or the first variant character is near
3308          * the end of it.  In either of these cases, it seems best to use the
3309          * 2nd method.  The only circumstance I can think of where this would
3310          * be really slower is if the string had once had much more data in it
3311          * than it does now, but there is still a substantial amount in it  */
3312
3313         {
3314             STRLEN invariant_head = t - s;
3315             STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3316             if (SvLEN(sv) < size) {
3317
3318                 /* Here, have decided to allocate a new string */
3319
3320                 U8 *dst;
3321                 U8 *d;
3322
3323                 Newx(dst, size, U8);
3324
3325                 /* If no known invariants at the beginning of the input string,
3326                  * set so starts from there.  Otherwise, can use memory copy to
3327                  * get up to where we are now, and then start from here */
3328
3329                 if (invariant_head <= 0) {
3330                     d = dst;
3331                 } else {
3332                     Copy(s, dst, invariant_head, char);
3333                     d = dst + invariant_head;
3334                 }
3335
3336                 while (t < e) {
3337                     const UV uv = NATIVE8_TO_UNI(*t++);
3338                     if (UNI_IS_INVARIANT(uv))
3339                         *d++ = (U8)UNI_TO_NATIVE(uv);
3340                     else {
3341                         *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3342                         *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3343                     }
3344                 }
3345                 *d = '\0';
3346                 SvPV_free(sv); /* No longer using pre-existing string */
3347                 SvPV_set(sv, (char*)dst);
3348                 SvCUR_set(sv, d - dst);
3349                 SvLEN_set(sv, size);
3350             } else {
3351
3352                 /* Here, have decided to get the exact size of the string.
3353                  * Currently this happens only when we know that there is
3354                  * guaranteed enough space to fit the converted string, so
3355                  * don't have to worry about growing.  If two_byte_count is 0,
3356                  * then t points to the first byte of the string which hasn't
3357                  * been examined yet.  Otherwise two_byte_count is 1, and t
3358                  * points to the first byte in the string that will expand to
3359                  * two.  Depending on this, start examining at t or 1 after t.
3360                  * */
3361
3362                 U8 *d = t + two_byte_count;
3363
3364
3365                 /* Count up the remaining bytes that expand to two */
3366
3367                 while (d < e) {
3368                     const U8 chr = *d++;
3369                     if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3370                 }
3371
3372                 /* The string will expand by just the number of bytes that
3373                  * occupy two positions.  But we are one afterwards because of
3374                  * the increment just above.  This is the place to put the
3375                  * trailing NUL, and to set the length before we decrement */
3376
3377                 d += two_byte_count;
3378                 SvCUR_set(sv, d - s);
3379                 *d-- = '\0';
3380
3381
3382                 /* Having decremented d, it points to the position to put the
3383                  * very last byte of the expanded string.  Go backwards through
3384                  * the string, copying and expanding as we go, stopping when we
3385                  * get to the part that is invariant the rest of the way down */
3386
3387                 e--;
3388                 while (e >= t) {
3389                     const U8 ch = NATIVE8_TO_UNI(*e--);
3390                     if (UNI_IS_INVARIANT(ch)) {
3391                         *d-- = UNI_TO_NATIVE(ch);
3392                     } else {
3393                         *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3394                         *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3395                     }
3396                 }
3397             }
3398
3399             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3400                 /* Update pos. We do it at the end rather than during
3401                  * the upgrade, to avoid slowing down the common case
3402                  * (upgrade without pos) */
3403                 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3404                 if (mg) {
3405                     I32 pos = mg->mg_len;
3406                     if (pos > 0 && (U32)pos > invariant_head) {
3407                         U8 *d = (U8*) SvPVX(sv) + invariant_head;
3408                         STRLEN n = (U32)pos - invariant_head;
3409                         while (n > 0) {
3410                             if (UTF8_IS_START(*d))
3411                                 d++;
3412                             d++;
3413                             n--;
3414                         }
3415                         mg->mg_len  = d - (U8*)SvPVX(sv);
3416                     }
3417                 }
3418                 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3419                     magic_setutf8(sv,mg); /* clear UTF8 cache */
3420             }
3421         }
3422     }
3423
3424     /* Mark as UTF-8 even if no variant - saves scanning loop */
3425     SvUTF8_on(sv);
3426     return SvCUR(sv);
3427 }
3428
3429 /*
3430 =for apidoc sv_utf8_downgrade
3431
3432 Attempts to convert the PV of an SV from characters to bytes.
3433 If the PV contains a character that cannot fit
3434 in a byte, this conversion will fail;
3435 in this case, either returns false or, if C<fail_ok> is not
3436 true, croaks.
3437
3438 This is not a general purpose Unicode to byte encoding interface:
3439 use the Encode extension for that.
3440
3441 =cut
3442 */
3443
3444 bool
3445 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3446 {
3447     dVAR;
3448
3449     PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3450
3451     if (SvPOKp(sv) && SvUTF8(sv)) {
3452         if (SvCUR(sv)) {
3453             U8 *s;
3454             STRLEN len;
3455             int mg_flags = SV_GMAGIC;
3456
3457             if (SvIsCOW(sv)) {
3458                 sv_force_normal_flags(sv, 0);
3459             }
3460             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3461                 /* update pos */
3462                 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3463                 if (mg) {
3464                     I32 pos = mg->mg_len;
3465                     if (pos > 0) {
3466                         sv_pos_b2u(sv, &pos);
3467                         mg_flags = 0; /* sv_pos_b2u does get magic */
3468                         mg->mg_len  = pos;
3469                     }
3470                 }
3471                 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3472                     magic_setutf8(sv,mg); /* clear UTF8 cache */
3473
3474             }
3475             s = (U8 *) SvPV_flags(sv, len, mg_flags);
3476
3477             if (!utf8_to_bytes(s, &len)) {
3478                 if (fail_ok)
3479                     return FALSE;
3480                 else {
3481                     if (PL_op)
3482                         Perl_croak(aTHX_ "Wide character in %s",
3483                                    OP_DESC(PL_op));
3484                     else
3485                         Perl_croak(aTHX_ "Wide character");
3486                 }
3487             }
3488             SvCUR_set(sv, len);
3489         }
3490     }
3491     SvUTF8_off(sv);
3492     return TRUE;
3493 }
3494
3495 /*
3496 =for apidoc sv_utf8_encode
3497
3498 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3499 flag off so that it looks like octets again.
3500
3501 =cut
3502 */
3503
3504 void
3505 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3506 {
3507     PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3508
3509     if (SvREADONLY(sv)) {
3510         sv_force_normal_flags(sv, 0);
3511     }
3512     (void) sv_utf8_upgrade(sv);
3513     SvUTF8_off(sv);
3514 }
3515
3516 /*
3517 =for apidoc sv_utf8_decode
3518
3519 If the PV of the SV is an octet sequence in UTF-8
3520 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3521 so that it looks like a character.  If the PV contains only single-byte
3522 characters, the C<SvUTF8> flag stays off.
3523 Scans PV for validity and returns false if the PV is invalid UTF-8.
3524
3525 =cut
3526 */
3527
3528 bool
3529 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3530 {
3531     PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3532
3533     if (SvPOKp(sv)) {
3534         const U8 *start, *c;
3535         const U8 *e;
3536
3537         /* The octets may have got themselves encoded - get them back as
3538          * bytes
3539          */
3540         if (!sv_utf8_downgrade(sv, TRUE))
3541             return FALSE;
3542
3543         /* it is actually just a matter of turning the utf8 flag on, but
3544          * we want to make sure everything inside is valid utf8 first.
3545          */
3546         c = start = (const U8 *) SvPVX_const(sv);
3547         if (!is_utf8_string(c, SvCUR(sv)))
3548             return FALSE;
3549         e = (const U8 *) SvEND(sv);
3550         while (c < e) {
3551             const U8 ch = *c++;
3552             if (!UTF8_IS_INVARIANT(ch)) {
3553                 SvUTF8_on(sv);
3554                 break;
3555             }
3556         }
3557         if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3558             /* adjust pos to the start of a UTF8 char sequence */
3559             MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3560             if (mg) {
3561                 I32 pos = mg->mg_len;
3562                 if (pos > 0) {
3563                     for (c = start + pos; c > start; c--) {
3564                         if (UTF8_IS_START(*c))
3565                             break;
3566                     }
3567                     mg->mg_len  = c - start;
3568                 }
3569             }
3570             if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3571                 magic_setutf8(sv,mg); /* clear UTF8 cache */
3572         }
3573     }
3574     return TRUE;
3575 }
3576
3577 /*
3578 =for apidoc sv_setsv
3579
3580 Copies the contents of the source SV C<ssv> into the destination SV
3581 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3582 function if the source SV needs to be reused.  Does not handle 'set' magic.
3583 Loosely speaking, it performs a copy-by-value, obliterating any previous
3584 content of the destination.
3585
3586 You probably want to use one of the assortment of wrappers, such as
3587 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3588 C<SvSetMagicSV_nosteal>.
3589
3590 =for apidoc sv_setsv_flags
3591
3592 Copies the contents of the source SV C<ssv> into the destination SV
3593 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3594 function if the source SV needs to be reused.  Does not handle 'set' magic.
3595 Loosely speaking, it performs a copy-by-value, obliterating any previous
3596 content of the destination.
3597 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3598 C<ssv> if appropriate, else not.  If the C<flags>
3599 parameter has the C<NOSTEAL> bit set then the
3600 buffers of temps will not be stolen.  <sv_setsv>
3601 and C<sv_setsv_nomg> are implemented in terms of this function.
3602
3603 You probably want to use one of the assortment of wrappers, such as
3604 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3605 C<SvSetMagicSV_nosteal>.
3606
3607 This is the primary function for copying scalars, and most other
3608 copy-ish functions and macros use this underneath.
3609
3610 =cut
3611 */
3612
3613 static void
3614 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3615 {
3616     I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3617     HV *old_stash = NULL;
3618
3619     PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3620
3621     if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3622         const char * const name = GvNAME(sstr);
3623         const STRLEN len = GvNAMELEN(sstr);
3624         {
3625             if (dtype >= SVt_PV) {
3626                 SvPV_free(dstr);
3627                 SvPV_set(dstr, 0);
3628                 SvLEN_set(dstr, 0);
3629                 SvCUR_set(dstr, 0);
3630             }
3631             SvUPGRADE(dstr, SVt_PVGV);
3632             (void)SvOK_off(dstr);
3633             /* We have to turn this on here, even though we turn it off
3634                below, as GvSTASH will fail an assertion otherwise. */
3635             isGV_with_GP_on(dstr);
3636         }
3637         GvSTASH(dstr) = GvSTASH(sstr);
3638         if (GvSTASH(dstr))
3639             Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3640         gv_name_set(MUTABLE_GV(dstr), name, len,
3641                         GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3642         SvFAKE_on(dstr);        /* can coerce to non-glob */
3643     }
3644
3645     if(GvGP(MUTABLE_GV(sstr))) {
3646         /* If source has method cache entry, clear it */
3647         if(GvCVGEN(sstr)) {
3648             SvREFCNT_dec(GvCV(sstr));
3649             GvCV_set(sstr, NULL);
3650             GvCVGEN(sstr) = 0;
3651         }
3652         /* If source has a real method, then a method is
3653            going to change */
3654         else if(
3655          GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3656         ) {
3657             mro_changes = 1;
3658         }
3659     }
3660
3661     /* If dest already had a real method, that's a change as well */
3662     if(
3663         !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3664      && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3665     ) {
3666         mro_changes = 1;
3667     }
3668
3669     /* We don't need to check the name of the destination if it was not a
3670        glob to begin with. */
3671     if(dtype == SVt_PVGV) {
3672         const char * const name = GvNAME((const GV *)dstr);
3673         if(
3674             strEQ(name,"ISA")
3675          /* The stash may have been detached from the symbol table, so
3676             check its name. */
3677          && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3678         )
3679             mro_changes = 2;
3680         else {
3681             const STRLEN len = GvNAMELEN(dstr);
3682             if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3683              || (len == 1 && name[0] == ':')) {
3684                 mro_changes = 3;
3685
3686                 /* Set aside the old stash, so we can reset isa caches on
3687                    its subclasses. */
3688                 if((old_stash = GvHV(dstr)))
3689                     /* Make sure we do not lose it early. */
3690                     SvREFCNT_inc_simple_void_NN(
3691                      sv_2mortal((SV *)old_stash)
3692                     );
3693             }
3694         }
3695     }
3696
3697     gp_free(MUTABLE_GV(dstr));
3698     isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3699     (void)SvOK_off(dstr);
3700     isGV_with_GP_on(dstr);
3701     GvINTRO_off(dstr);          /* one-shot flag */
3702     GvGP_set(dstr, gp_ref(GvGP(sstr)));
3703     if (SvTAINTED(sstr))
3704         SvTAINT(dstr);
3705     if (GvIMPORTED(dstr) != GVf_IMPORTED
3706         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3707         {
3708             GvIMPORTED_on(dstr);
3709         }
3710     GvMULTI_on(dstr);
3711     if(mro_changes == 2) {
3712       if (GvAV((const GV *)sstr)) {
3713         MAGIC *mg;
3714         SV * const sref = (SV *)GvAV((const GV *)dstr);
3715         if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3716             if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3717                 AV * const ary = newAV();
3718                 av_push(ary, mg->mg_obj); /* takes the refcount */
3719                 mg->mg_obj = (SV *)ary;
3720             }
3721             av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3722         }
3723         else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3724       }
3725       mro_isa_changed_in(GvSTASH(dstr));
3726     }
3727     else if(mro_changes == 3) {
3728         HV * const stash = GvHV(dstr);
3729         if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3730             mro_package_moved(
3731                 stash, old_stash,
3732                 (GV *)dstr, 0
3733             );
3734     }
3735     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3736     return;
3737 }
3738
3739 static void
3740 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3741 {
3742     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3743     SV *dref = NULL;
3744     const int intro = GvINTRO(dstr);
3745     SV **location;
3746     U8 import_flag = 0;
3747     const U32 stype = SvTYPE(sref);
3748
3749     PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3750
3751     if (intro) {
3752         GvINTRO_off(dstr);      /* one-shot flag */
3753         GvLINE(dstr) = CopLINE(PL_curcop);
3754         GvEGV(dstr) = MUTABLE_GV(dstr);
3755     }
3756     GvMULTI_on(dstr);
3757     switch (stype) {
3758     case SVt_PVCV:
3759         location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3760         import_flag = GVf_IMPORTED_CV;
3761         goto common;
3762     case SVt_PVHV:
3763         location = (SV **) &GvHV(dstr);
3764         import_flag = GVf_IMPORTED_HV;
3765         goto common;
3766     case SVt_PVAV:
3767         location = (SV **) &GvAV(dstr);
3768         import_flag = GVf_IMPORTED_AV;
3769         goto common;
3770     case SVt_PVIO:
3771         location = (SV **) &GvIOp(dstr);
3772         goto common;
3773     case SVt_PVFM:
3774         location = (SV **) &GvFORM(dstr);
3775         goto common;
3776     default:
3777         location = &GvSV(dstr);
3778         import_flag = GVf_IMPORTED_SV;
3779     common:
3780         if (intro) {
3781             if (stype == SVt_PVCV) {
3782                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3783                 if (GvCVGEN(dstr)) {
3784                     SvREFCNT_dec(GvCV(dstr));
3785                     GvCV_set(dstr, NULL);
3786                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3787                 }
3788             }
3789             SAVEGENERICSV(*location);
3790         }
3791         else
3792             dref = *location;
3793         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3794             CV* const cv = MUTABLE_CV(*location);
3795             if (cv) {
3796                 if (!GvCVGEN((const GV *)dstr) &&
3797                     (CvROOT(cv) || CvXSUB(cv)) &&
3798                     /* redundant check that avoids creating the extra SV
3799                        most of the time: */
3800                     (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3801                     {
3802                         SV * const new_const_sv =
3803                             CvCONST((const CV *)sref)
3804                                  ? cv_const_sv((const CV *)sref)
3805                                  : NULL;
3806                         report_redefined_cv(
3807                            sv_2mortal(Perl_newSVpvf(aTHX_
3808                                 "%"HEKf"::%"HEKf,
3809                                 HEKfARG(
3810                                  HvNAME_HEK(GvSTASH((const GV *)dstr))
3811                                 ),
3812                                 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3813                            )),
3814                            cv,
3815                            CvCONST((const CV *)sref) ? &new_const_sv : NULL
3816                         );
3817                     }
3818                 if (!intro)
3819                     cv_ckproto_len_flags(cv, (const GV *)dstr,
3820                                    SvPOK(sref) ? CvPROTO(sref) : NULL,
3821                                    SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3822                                    SvPOK(sref) ? SvUTF8(sref) : 0);
3823             }
3824             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3825             GvASSUMECV_on(dstr);
3826             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3827         }
3828         *location = sref;
3829         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3830             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3831             GvFLAGS(dstr) |= import_flag;
3832         }
3833         if (stype == SVt_PVHV) {
3834             const char * const name = GvNAME((GV*)dstr);
3835             const STRLEN len = GvNAMELEN(dstr);
3836             if (
3837                 (
3838                    (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3839                 || (len == 1 && name[0] == ':')
3840                 )
3841              && (!dref || HvENAME_get(dref))
3842             ) {
3843                 mro_package_moved(
3844                     (HV *)sref, (HV *)dref,
3845                     (GV *)dstr, 0
3846                 );
3847             }
3848         }
3849         else if (
3850             stype == SVt_PVAV && sref != dref
3851          && strEQ(GvNAME((GV*)dstr), "ISA")
3852          /* The stash may have been detached from the symbol table, so
3853             check its name before doing anything. */
3854          && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3855         ) {
3856             MAGIC *mg;
3857             MAGIC * const omg = dref && SvSMAGICAL(dref)
3858                                  ? mg_find(dref, PERL_MAGIC_isa)
3859                                  : NULL;
3860             if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3861                 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3862                     AV * const ary = newAV();
3863                     av_push(ary, mg->mg_obj); /* takes the refcount */
3864                     mg->mg_obj = (SV *)ary;
3865                 }
3866                 if (omg) {
3867                     if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3868                         SV **svp = AvARRAY((AV *)omg->mg_obj);
3869                         I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3870                         while (items--)
3871                             av_push(
3872                              (AV *)mg->mg_obj,
3873                              SvREFCNT_inc_simple_NN(*svp++)
3874                             );
3875                     }
3876                     else
3877                         av_push(
3878                          (AV *)mg->mg_obj,
3879                          SvREFCNT_inc_simple_NN(omg->mg_obj)
3880                         );
3881                 }
3882                 else
3883                     av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3884             }
3885             else
3886             {
3887                 sv_magic(
3888                  sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3889                 );
3890                 mg = mg_find(sref, PERL_MAGIC_isa);
3891             }
3892             /* Since the *ISA assignment could have affected more than
3893                one stash, don't call mro_isa_changed_in directly, but let
3894                magic_clearisa do it for us, as it already has the logic for
3895                dealing with globs vs arrays of globs. */
3896             assert(mg);
3897             Perl_magic_clearisa(aTHX_ NULL, mg);
3898         }
3899         else if (stype == SVt_PVIO) {
3900             DEBUG_o(Perl_deb(aTHX_ "glob_assign_ref clearing PL_stashcache\n"));
3901             /* It's a cache. It will rebuild itself quite happily.
3902                It's a lot of effort to work out exactly which key (or keys)
3903                might be invalidated by the creation of the this file handle.
3904             */
3905             hv_clear(PL_stashcache);
3906         }
3907         break;
3908     }
3909     SvREFCNT_dec(dref);
3910     if (SvTAINTED(sstr))
3911         SvTAINT(dstr);
3912     return;
3913 }
3914
3915 void
3916 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3917 {
3918     dVAR;
3919     U32 sflags;
3920     int dtype;
3921     svtype stype;
3922
3923     PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3924
3925     if (sstr == dstr)
3926         return;
3927
3928     if (SvIS_FREED(dstr)) {
3929         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3930                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3931     }
3932     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3933     if (!sstr)
3934         sstr = &PL_sv_undef;
3935     if (SvIS_FREED(sstr)) {
3936         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3937                    (void*)sstr, (void*)dstr);
3938     }
3939     stype = SvTYPE(sstr);
3940     dtype = SvTYPE(dstr);
3941
3942     /* There's a lot of redundancy below but we're going for speed here */
3943
3944     switch (stype) {
3945     case SVt_NULL:
3946       undef_sstr:
3947         if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3948             (void)SvOK_off(dstr);
3949             return;
3950         }
3951         break;
3952     case SVt_IV:
3953         if (SvIOK(sstr)) {
3954             switch (dtype) {
3955             case SVt_NULL:
3956                 sv_upgrade(dstr, SVt_IV);
3957                 break;
3958             case SVt_NV:
3959             case SVt_PV:
3960                 sv_upgrade(dstr, SVt_PVIV);
3961                 break;
3962             case SVt_PVGV:
3963             case SVt_PVLV:
3964                 goto end_of_first_switch;
3965             }
3966             (void)SvIOK_only(dstr);
3967             SvIV_set(dstr,  SvIVX(sstr));
3968             if (SvIsUV(sstr))
3969                 SvIsUV_on(dstr);
3970             /* SvTAINTED can only be true if the SV has taint magic, which in
3971                turn means that the SV type is PVMG (or greater). This is the
3972                case statement for SVt_IV, so this cannot be true (whatever gcov
3973                may say).  */
3974             assert(!SvTAINTED(sstr));
3975             return;
3976         }
3977         if (!SvROK(sstr))
3978             goto undef_sstr;
3979         if (dtype < SVt_PV && dtype != SVt_IV)
3980             sv_upgrade(dstr, SVt_IV);
3981         break;
3982
3983     case SVt_NV:
3984         if (SvNOK(sstr)) {
3985             switch (dtype) {
3986             case SVt_NULL:
3987             case SVt_IV:
3988                 sv_upgrade(dstr, SVt_NV);
3989                 break;
3990             case SVt_PV:
3991             case SVt_PVIV:
3992                 sv_upgrade(dstr, SVt_PVNV);
3993                 break;
3994             case SVt_PVGV:
3995             case SVt_PVLV:
3996                 goto end_of_first_switch;
3997             }
3998             SvNV_set(dstr, SvNVX(sstr));
3999             (void)SvNOK_only(dstr);
4000             /* SvTAINTED can only be true if the SV has taint magic, which in
4001                turn means that the SV type is PVMG (or greater). This is the
4002                case statement for SVt_NV, so this cannot be true (whatever gcov
4003                may say).  */
4004             assert(!SvTAINTED(sstr));
4005             return;
4006         }
4007         goto undef_sstr;
4008
4009     case SVt_PV:
4010         if (dtype < SVt_PV)
4011             sv_upgrade(dstr, SVt_PV);
4012         break;
4013     case SVt_PVIV:
4014         if (dtype < SVt_PVIV)
4015             sv_upgrade(dstr, SVt_PVIV);
4016         break;
4017     case SVt_PVNV:
4018         if (dtype < SVt_PVNV)
4019             sv_upgrade(dstr, SVt_PVNV);
4020         break;
4021     default:
4022         {
4023         const char * const type = sv_reftype(sstr,0);
4024         if (PL_op)
4025             /* diag_listed_as: Bizarre copy of %s */
4026             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4027         else
4028             Perl_croak(aTHX_ "Bizarre copy of %s", type);
4029         }
4030         break;
4031
4032     case SVt_REGEXP:
4033       upgregexp:
4034         if (dtype < SVt_REGEXP)
4035         {
4036             if (dtype >= SVt_PV) {
4037                 SvPV_free(dstr);
4038                 SvPV_set(dstr, 0);
4039                 SvLEN_set(dstr, 0);
4040                 SvCUR_set(dstr, 0);
4041             }
4042             sv_upgrade(dstr, SVt_REGEXP);
4043         }
4044         break;
4045
4046         /* case SVt_BIND: */
4047     case SVt_PVLV:
4048     case SVt_PVGV:
4049     case SVt_PVMG:
4050         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4051             mg_get(sstr);
4052             if (SvTYPE(sstr) != stype)
4053                 stype = SvTYPE(sstr);
4054         }
4055         if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4056                     glob_assign_glob(dstr, sstr, dtype);
4057                     return;
4058         }
4059         if (stype == SVt_PVLV)
4060         {
4061             if (isREGEXP(sstr)) goto upgregexp;
4062             SvUPGRADE(dstr, SVt_PVNV);
4063         }
4064         else
4065             SvUPGRADE(dstr, (svtype)stype);
4066     }
4067  end_of_first_switch:
4068
4069     /* dstr may have been upgraded.  */
4070     dtype = SvTYPE(dstr);
4071     sflags = SvFLAGS(sstr);
4072
4073     if (dtype == SVt_PVCV) {
4074         /* Assigning to a subroutine sets the prototype.  */
4075         if (SvOK(sstr)) {
4076             STRLEN len;
4077             const char *const ptr = SvPV_const(sstr, len);
4078
4079             SvGROW(dstr, len + 1);
4080             Copy(ptr, SvPVX(dstr), len + 1, char);
4081             SvCUR_set(dstr, len);
4082             SvPOK_only(dstr);
4083             SvFLAGS(dstr) |= sflags & SVf_UTF8;
4084             CvAUTOLOAD_off(dstr);
4085         } else {
4086             SvOK_off(dstr);
4087         }
4088     }
4089     else if (dtype == SVt_PVAV || dtype == SVt_PVHV || dtype == SVt_PVFM) {
4090         const char * const type = sv_reftype(dstr,0);
4091         if (PL_op)
4092             /* diag_listed_as: Cannot copy to %s */
4093             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4094         else
4095             Perl_croak(aTHX_ "Cannot copy to %s", type);
4096     } else if (sflags & SVf_ROK) {
4097         if (isGV_with_GP(dstr)
4098             && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4099             sstr = SvRV(sstr);
4100             if (sstr == dstr) {
4101                 if (GvIMPORTED(dstr) != GVf_IMPORTED
4102                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4103                 {
4104                     GvIMPORTED_on(dstr);
4105                 }
4106                 GvMULTI_on(dstr);
4107                 return;
4108             }
4109             glob_assign_glob(dstr, sstr, dtype);
4110             return;
4111         }
4112
4113         if (dtype >= SVt_PV) {
4114             if (isGV_with_GP(dstr)) {
4115                 glob_assign_ref(dstr, sstr);
4116                 return;
4117             }
4118             if (SvPVX_const(dstr)) {
4119                 SvPV_free(dstr);
4120                 SvLEN_set(dstr, 0);
4121                 SvCUR_set(dstr, 0);
4122             }
4123         }
4124         (void)SvOK_off(dstr);
4125         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4126         SvFLAGS(dstr) |= sflags & SVf_ROK;
4127         assert(!(sflags & SVp_NOK));
4128         assert(!(sflags & SVp_IOK));
4129         assert(!(sflags & SVf_NOK));
4130         assert(!(sflags & SVf_IOK));
4131     }
4132     else if (isGV_with_GP(dstr)) {
4133         if (!(sflags & SVf_OK)) {
4134             Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4135                            "Undefined value assigned to typeglob");
4136         }
4137         else {
4138             GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4139             if (dstr != (const SV *)gv) {
4140                 const char * const name = GvNAME((const GV *)dstr);
4141                 const STRLEN len = GvNAMELEN(dstr);
4142                 HV *old_stash = NULL;
4143                 bool reset_isa = FALSE;
4144                 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4145                  || (len == 1 && name[0] == ':')) {
4146                     /* Set aside the old stash, so we can reset isa caches
4147                        on its subclasses. */
4148                     if((old_stash = GvHV(dstr))) {
4149                         /* Make sure we do not lose it early. */
4150                         SvREFCNT_inc_simple_void_NN(
4151                          sv_2mortal((SV *)old_stash)
4152                         );
4153                     }
4154                     reset_isa = TRUE;
4155                 }
4156
4157                 if (GvGP(dstr))
4158                     gp_free(MUTABLE_GV(dstr));
4159                 GvGP_set(dstr, gp_ref(GvGP(gv)));
4160
4161                 if (reset_isa) {
4162                     HV * const stash = GvHV(dstr);
4163                     if(
4164                         old_stash ? (HV *)HvENAME_get(old_stash) : stash
4165                     )
4166                         mro_package_moved(
4167                          stash, old_stash,
4168                          (GV *)dstr, 0
4169                         );
4170                 }
4171             }
4172         }
4173     }
4174     else if ((dtype == SVt_REGEXP || dtype == SVt_PVLV)
4175           && (stype == SVt_REGEXP || isREGEXP(sstr))) {
4176         reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4177     }
4178     else if (sflags & SVp_POK) {
4179         bool isSwipe = 0;
4180
4181         /*
4182          * Check to see if we can just swipe the string.  If so, it's a
4183          * possible small lose on short strings, but a big win on long ones.
4184          * It might even be a win on short strings if SvPVX_const(dstr)
4185          * has to be allocated and SvPVX_const(sstr) has to be freed.
4186          * Likewise if we can set up COW rather than doing an actual copy, we
4187          * drop to the else clause, as the swipe code and the COW setup code
4188          * have much in common.
4189          */
4190
4191         /* Whichever path we take through the next code, we want this true,
4192            and doing it now facilitates the COW check.  */
4193         (void)SvPOK_only(dstr);
4194
4195         if (
4196             /* If we're already COW then this clause is not true, and if COW
4197                is allowed then we drop down to the else and make dest COW 
4198                with us.  If caller hasn't said that we're allowed to COW
4199                shared hash keys then we don't do the COW setup, even if the
4200                source scalar is a shared hash key scalar.  */
4201             (((flags & SV_COW_SHARED_HASH_KEYS)
4202                ? !(sflags & SVf_IsCOW)
4203                : 1 /* If making a COW copy is forbidden then the behaviour we
4204                        desire is as if the source SV isn't actually already
4205                        COW, even if it is.  So we act as if the source flags
4206                        are not COW, rather than actually testing them.  */
4207               )
4208 #ifndef PERL_OLD_COPY_ON_WRITE
4209              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4210                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4211                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4212                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4213                 but in turn, it's somewhat dead code, never expected to go
4214                 live, but more kept as a placeholder on how to do it better
4215                 in a newer implementation.  */
4216              /* If we are COW and dstr is a suitable target then we drop down
4217                 into the else and make dest a COW of us.  */
4218              || (SvFLAGS(dstr) & SVf_BREAK)
4219 #endif
4220              )
4221             &&
4222             !(isSwipe =
4223                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4224                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4225                  (!(flags & SV_NOSTEAL)) &&
4226                                         /* and we're allowed to steal temps */
4227                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4228                  SvLEN(sstr))             /* and really is a string */
4229 #ifdef PERL_OLD_COPY_ON_WRITE
4230             && ((flags & SV_COW_SHARED_HASH_KEYS)
4231                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4232                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4233                      && SvTYPE(sstr) >= SVt_PVIV))
4234                 : 1)
4235 #endif
4236             ) {
4237             /* Failed the swipe test, and it's not a shared hash key either.
4238                Have to copy the string.  */
4239             STRLEN len = SvCUR(sstr);
4240             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4241             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4242             SvCUR_set(dstr, len);
4243             *SvEND(dstr) = '\0';
4244         } else {
4245             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4246                be true in here.  */
4247             /* Either it's a shared hash key, or it's suitable for
4248                copy-on-write or we can swipe the string.  */
4249             if (DEBUG_C_TEST) {
4250                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4251                 sv_dump(sstr);
4252                 sv_dump(dstr);
4253             }
4254 #ifdef PERL_OLD_COPY_ON_WRITE
4255             if (!isSwipe) {
4256                 if (!(sflags & SVf_IsCOW)) {
4257                     SvIsCOW_on(sstr);
4258                     /* Make the source SV into a loop of 1.
4259                        (about to become 2) */
4260                     SV_COW_NEXT_SV_SET(sstr, sstr);
4261                 }
4262             }
4263 #endif
4264             /* Initial code is common.  */
4265             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
4266                 SvPV_free(dstr);
4267             }
4268
4269             if (!isSwipe) {
4270                 /* making another shared SV.  */
4271                 STRLEN cur = SvCUR(sstr);
4272                 STRLEN len = SvLEN(sstr);
4273 #ifdef PERL_OLD_COPY_ON_WRITE
4274                 if (len) {
4275                     assert (SvTYPE(dstr) >= SVt_PVIV);
4276                     /* SvIsCOW_normal */
4277                     /* splice us in between source and next-after-source.  */
4278                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4279                     SV_COW_NEXT_SV_SET(sstr, dstr);
4280                     SvPV_set(dstr, SvPVX_mutable(sstr));
4281                 } else
4282 #endif
4283                 {
4284                     /* SvIsCOW_shared_hash */
4285                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4286                                           "Copy on write: Sharing hash\n"));
4287
4288                     assert (SvTYPE(dstr) >= SVt_PV);
4289                     SvPV_set(dstr,
4290                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4291                 }
4292                 SvLEN_set(dstr, len);
4293                 SvCUR_set(dstr, cur);
4294                 SvIsCOW_on(dstr);
4295             }
4296             else
4297                 {       /* Passes the swipe test.  */
4298                 SvPV_set(dstr, SvPVX_mutable(sstr));
4299                 SvLEN_set(dstr, SvLEN(sstr));
4300                 SvCUR_set(dstr, SvCUR(sstr));
4301
4302                 SvTEMP_off(dstr);
4303                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4304                 SvPV_set(sstr, NULL);
4305                 SvLEN_set(sstr, 0);
4306                 SvCUR_set(sstr, 0);
4307                 SvTEMP_off(sstr);
4308             }
4309         }
4310         if (sflags & SVp_NOK) {
4311             SvNV_set(dstr, SvNVX(sstr));
4312         }
4313         if (sflags & SVp_IOK) {
4314             SvIV_set(dstr, SvIVX(sstr));
4315             /* Must do this otherwise some other overloaded use of 0x80000000
4316                gets confused. I guess SVpbm_VALID */
4317             if (sflags & SVf_IVisUV)
4318                 SvIsUV_on(dstr);
4319         }
4320         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4321         {
4322             const MAGIC * const smg = SvVSTRING_mg(sstr);
4323             if (smg) {
4324                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4325                          smg->mg_ptr, smg->mg_len);
4326                 SvRMAGICAL_on(dstr);
4327             }
4328         }
4329     }
4330     else if (sflags & (SVp_IOK|SVp_NOK)) {
4331         (void)SvOK_off(dstr);
4332         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4333         if (sflags & SVp_IOK) {
4334             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4335             SvIV_set(dstr, SvIVX(sstr));
4336         }
4337         if (sflags & SVp_NOK) {
4338             SvNV_set(dstr, SvNVX(sstr));
4339         }
4340     }
4341     else {
4342         if (isGV_with_GP(sstr)) {
4343             gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4344         }
4345         else
4346             (void)SvOK_off(dstr);
4347     }
4348     if (SvTAINTED(sstr))
4349         SvTAINT(dstr);
4350 }
4351
4352 /*
4353 =for apidoc sv_setsv_mg
4354
4355 Like C<sv_setsv>, but also handles 'set' magic.
4356
4357 =cut
4358 */
4359
4360 void
4361 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4362 {
4363     PERL_ARGS_ASSERT_SV_SETSV_MG;
4364
4365     sv_setsv(dstr,sstr);
4366     SvSETMAGIC(dstr);
4367 }
4368
4369 #ifdef PERL_OLD_COPY_ON_WRITE
4370 SV *
4371 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4372 {
4373     STRLEN cur = SvCUR(sstr);
4374     STRLEN len = SvLEN(sstr);
4375     char *new_pv;
4376
4377     PERL_ARGS_ASSERT_SV_SETSV_COW;
4378
4379     if (DEBUG_C_TEST) {
4380         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4381                       (void*)sstr, (void*)dstr);
4382         sv_dump(sstr);
4383         if (dstr)
4384                     sv_dump(dstr);
4385     }
4386
4387     if (dstr) {
4388         if (SvTHINKFIRST(dstr))
4389             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4390         else if (SvPVX_const(dstr))
4391             Safefree(SvPVX_mutable(dstr));
4392     }
4393     else
4394         new_SV(dstr);
4395     SvUPGRADE(dstr, SVt_PVIV);
4396
4397     assert (SvPOK(sstr));
4398     assert (SvPOKp(sstr));
4399     assert (!SvIOK(sstr));
4400     assert (!SvIOKp(sstr));
4401     assert (!SvNOK(sstr));
4402     assert (!SvNOKp(sstr));
4403
4404     if (SvIsCOW(sstr)) {
4405
4406         if (SvLEN(sstr) == 0) {
4407             /* source is a COW shared hash key.  */
4408             DEBUG_C(PerlIO_printf(Perl_debug_log,
4409                                   "Fast copy on write: Sharing hash\n"));
4410             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4411             goto common_exit;
4412         }
4413         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4414     } else {
4415         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4416         SvUPGRADE(sstr, SVt_PVIV);
4417         SvIsCOW_on(sstr);
4418         DEBUG_C(PerlIO_printf(Perl_debug_log,
4419                               "Fast copy on write: Converting sstr to COW\n"));
4420         SV_COW_NEXT_SV_SET(dstr, sstr);
4421     }
4422     SV_COW_NEXT_SV_SET(sstr, dstr);
4423     new_pv = SvPVX_mutable(sstr);
4424
4425   common_exit:
4426     SvPV_set(dstr, new_pv);
4427     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_IsCOW);
4428     if (SvUTF8(sstr))
4429         SvUTF8_on(dstr);
4430     SvLEN_set(dstr, len);
4431     SvCUR_set(dstr, cur);
4432     if (DEBUG_C_TEST) {
4433         sv_dump(dstr);
4434     }
4435     return dstr;
4436 }
4437 #endif
4438
4439 /*
4440 =for apidoc sv_setpvn
4441
4442 Copies a string into an SV.  The C<len> parameter indicates the number of
4443 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4444 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4445
4446 =cut
4447 */
4448
4449 void
4450 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4451 {
4452     dVAR;
4453     char *dptr;
4454
4455     PERL_ARGS_ASSERT_SV_SETPVN;
4456
4457     SV_CHECK_THINKFIRST_COW_DROP(sv);
4458     if (!ptr) {
4459         (void)SvOK_off(sv);
4460         return;
4461     }
4462     else {
4463         /* len is STRLEN which is unsigned, need to copy to signed */
4464         const IV iv = len;
4465         if (iv < 0)
4466             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4467                        IVdf, iv);
4468     }
4469     SvUPGRADE(sv, SVt_PV);
4470
4471     dptr = SvGROW(sv, len + 1);
4472     Move(ptr,dptr,len,char);
4473     dptr[len] = '\0';
4474     SvCUR_set(sv, len);
4475     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4476     SvTAINT(sv);
4477     if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4478 }
4479
4480 /*
4481 =for apidoc sv_setpvn_mg
4482
4483 Like C<sv_setpvn>, but also handles 'set' magic.
4484
4485 =cut
4486 */
4487
4488 void
4489 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4490 {
4491     PERL_ARGS_ASSERT_SV_SETPVN_MG;
4492
4493     sv_setpvn(sv,ptr,len);
4494     SvSETMAGIC(sv);
4495 }
4496
4497 /*
4498 =for apidoc sv_setpv
4499
4500 Copies a string into an SV.  The string must be null-terminated.  Does not
4501 handle 'set' magic.  See C<sv_setpv_mg>.
4502
4503 =cut
4504 */
4505
4506 void
4507 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4508 {
4509     dVAR;
4510     STRLEN len;
4511
4512     PERL_ARGS_ASSERT_SV_SETPV;
4513
4514     SV_CHECK_THINKFIRST_COW_DROP(sv);
4515     if (!ptr) {
4516         (void)SvOK_off(sv);
4517         return;
4518     }
4519     len = strlen(ptr);
4520     SvUPGRADE(sv, SVt_PV);
4521
4522     SvGROW(sv, len + 1);
4523     Move(ptr,SvPVX(sv),len+1,char);
4524     SvCUR_set(sv, len);
4525     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4526     SvTAINT(sv);
4527     if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4528 }
4529
4530 /*
4531 =for apidoc sv_setpv_mg
4532
4533 Like C<sv_setpv>, but also handles 'set' magic.
4534
4535 =cut
4536 */
4537
4538 void
4539 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4540 {
4541     PERL_ARGS_ASSERT_SV_SETPV_MG;
4542
4543     sv_setpv(sv,ptr);
4544     SvSETMAGIC(sv);
4545 }
4546
4547 void
4548 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4549 {
4550     dVAR;
4551
4552     PERL_ARGS_ASSERT_SV_SETHEK;
4553
4554     if (!hek) {
4555         return;
4556     }
4557
4558     if (HEK_LEN(hek) == HEf_SVKEY) {
4559         sv_setsv(sv, *(SV**)HEK_KEY(hek));
4560         return;
4561     } else {
4562         const int flags = HEK_FLAGS(hek);
4563         if (flags & HVhek_WASUTF8) {
4564             STRLEN utf8_len = HEK_LEN(hek);
4565             char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4566             sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4567             SvUTF8_on(sv);
4568             return;
4569         } else if (flags & HVhek_UNSHARED) {
4570             sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4571             if (HEK_UTF8(hek))
4572                 SvUTF8_on(sv);
4573             else SvUTF8_off(sv);
4574             return;
4575         }
4576         {
4577             SV_CHECK_THINKFIRST_COW_DROP(sv);
4578             SvUPGRADE(sv, SVt_PV);
4579             Safefree(SvPVX(sv));
4580             SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4581             SvCUR_set(sv, HEK_LEN(hek));
4582             SvLEN_set(sv, 0);
4583             SvIsCOW_on(sv);
4584             SvPOK_on(sv);
4585             if (HEK_UTF8(hek))
4586                 SvUTF8_on(sv);
4587             else SvUTF8_off(sv);
4588             return;
4589         }
4590     }
4591 }
4592
4593
4594 /*
4595 =for apidoc sv_usepvn_flags
4596
4597 Tells an SV to use C<ptr> to find its string value.  Normally the
4598 string is stored inside the SV but sv_usepvn allows the SV to use an
4599 outside string.  The C<ptr> should point to memory that was allocated
4600 by C<malloc>.  It must be the start of a mallocked block
4601 of memory, and not a pointer to the middle of it.  The
4602 string length, C<len>, must be supplied.  By default
4603 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4604 so that pointer should not be freed or used by the programmer after
4605 giving it to sv_usepvn, and neither should any pointers from "behind"
4606 that pointer (e.g. ptr + 1) be used.
4607
4608 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC.  If C<flags> &
4609 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4610 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4611 C<len>, and already meets the requirements for storing in C<SvPVX>).
4612
4613 =cut
4614 */
4615
4616 void
4617 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4618 {
4619     dVAR;
4620     STRLEN allocate;
4621
4622     PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4623
4624     SV_CHECK_THINKFIRST_COW_DROP(sv);
4625     SvUPGRADE(sv, SVt_PV);
4626     if (!ptr) {
4627         (void)SvOK_off(sv);
4628         if (flags & SV_SMAGIC)
4629             SvSETMAGIC(sv);
4630         return;
4631     }
4632     if (SvPVX_const(sv))
4633         SvPV_free(sv);
4634
4635 #ifdef DEBUGGING
4636     if (flags & SV_HAS_TRAILING_NUL)
4637         assert(ptr[len] == '\0');
4638 #endif
4639
4640     allocate = (flags & SV_HAS_TRAILING_NUL)
4641         ? len + 1 :
4642 #ifdef Perl_safesysmalloc_size
4643         len + 1;
4644 #else 
4645         PERL_STRLEN_ROUNDUP(len + 1);
4646 #endif
4647     if (flags & SV_HAS_TRAILING_NUL) {
4648         /* It's long enough - do nothing.
4649            Specifically Perl_newCONSTSUB is relying on this.  */
4650     } else {
4651 #ifdef DEBUGGING
4652         /* Force a move to shake out bugs in callers.  */
4653         char *new_ptr = (char*)safemalloc(allocate);
4654         Copy(ptr, new_ptr, len, char);
4655         PoisonFree(ptr,len,char);
4656         Safefree(ptr);
4657         ptr = new_ptr;
4658 #else
4659         ptr = (char*) saferealloc (ptr, allocate);
4660 #endif
4661     }
4662 #ifdef Perl_safesysmalloc_size
4663     SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4664 #else
4665     SvLEN_set(sv, allocate);
4666 #endif
4667     SvCUR_set(sv, len);
4668     SvPV_set(sv, ptr);
4669     if (!(flags & SV_HAS_TRAILING_NUL)) {
4670         ptr[len] = '\0';
4671     }
4672     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4673     SvTAINT(sv);
4674     if (flags & SV_SMAGIC)
4675         SvSETMAGIC(sv);
4676 }
4677
4678 #ifdef PERL_OLD_COPY_ON_WRITE
4679 /* Need to do this *after* making the SV normal, as we need the buffer
4680    pointer to remain valid until after we've copied it.  If we let go too early,
4681    another thread could invalidate it by unsharing last of the same hash key
4682    (which it can do by means other than releasing copy-on-write Svs)
4683    or by changing the other copy-on-write SVs in the loop.  */
4684 STATIC void
4685 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4686 {
4687     PERL_ARGS_ASSERT_SV_RELEASE_COW;
4688
4689     { /* this SV was SvIsCOW_normal(sv) */
4690          /* we need to find the SV pointing to us.  */
4691         SV *current = SV_COW_NEXT_SV(after);
4692
4693         if (current == sv) {
4694             /* The SV we point to points back to us (there were only two of us
4695                in the loop.)
4696                Hence other SV is no longer copy on write either.  */
4697             SvIsCOW_off(after);
4698         } else {
4699             /* We need to follow the pointers around the loop.  */
4700             SV *next;
4701             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4702                 assert (next);
4703                 current = next;
4704                  /* don't loop forever if the structure is bust, and we have
4705                     a pointer into a closed loop.  */
4706                 assert (current != after);
4707                 assert (SvPVX_const(current) == pvx);
4708             }
4709             /* Make the SV before us point to the SV after us.  */
4710             SV_COW_NEXT_SV_SET(current, after);
4711         }
4712     }
4713 }
4714 #endif
4715 /*
4716 =for apidoc sv_force_normal_flags
4717
4718 Undo various types of fakery on an SV, where fakery means
4719 "more than" a string: if the PV is a shared string, make
4720 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4721 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4722 we do the copy, and is also used locally; if this is a
4723 vstring, drop the vstring magic.  If C<SV_COW_DROP_PV> is set
4724 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4725 SvPOK_off rather than making a copy.  (Used where this
4726 scalar is about to be set to some other value.)  In addition,
4727 the C<flags> parameter gets passed to C<sv_unref_flags()>
4728 when unreffing.  C<sv_force_normal> calls this function
4729 with flags set to 0.
4730
4731 =cut
4732 */
4733
4734 void
4735 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4736 {
4737     dVAR;
4738
4739     PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4740
4741 #ifdef PERL_OLD_COPY_ON_WRITE
4742     if (SvREADONLY(sv)) {
4743         if (IN_PERL_RUNTIME)
4744             Perl_croak_no_modify(aTHX);
4745     }
4746     else
4747         if (SvIsCOW(sv)) {
4748             const char * const pvx = SvPVX_const(sv);
4749             const STRLEN len = SvLEN(sv);
4750             const STRLEN cur = SvCUR(sv);
4751             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4752                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4753                we'll fail an assertion.  */
4754             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4755
4756             if (DEBUG_C_TEST) {
4757                 PerlIO_printf(Perl_debug_log,
4758                               "Copy on write: Force normal %ld\n",
4759                               (long) flags);
4760                 sv_dump(sv);
4761             }
4762             SvIsCOW_off(sv);
4763             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4764             SvPV_set(sv, NULL);
4765             SvLEN_set(sv, 0);
4766             if (flags & SV_COW_DROP_PV) {
4767                 /* OK, so we don't need to copy our buffer.  */
4768                 SvPOK_off(sv);
4769             } else {
4770                 SvGROW(sv, cur + 1);
4771                 Move(pvx,SvPVX(sv),cur,char);
4772                 SvCUR_set(sv, cur);
4773                 *SvEND(sv) = '\0';
4774             }
4775             if (len) {
4776                 sv_release_COW(sv, pvx, next);
4777             } else {
4778                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4779             }
4780             if (DEBUG_C_TEST) {
4781                 sv_dump(sv);
4782             }
4783         }
4784 #else
4785     if (SvREADONLY(sv)) {
4786         if (IN_PERL_RUNTIME)
4787             Perl_croak_no_modify();
4788     }
4789     else
4790         if (SvIsCOW(sv)) {
4791             const char * const pvx = SvPVX_const(sv);
4792             const STRLEN len = SvCUR(sv);
4793             SvIsCOW_off(sv);
4794             SvPV_set(sv, NULL);
4795             SvLEN_set(sv, 0);
4796             if (flags & SV_COW_DROP_PV) {
4797                 /* OK, so we don't need to copy our buffer.  */
4798                 SvPOK_off(sv);
4799             } else {
4800                 SvGROW(sv, len + 1);
4801                 Move(pvx,SvPVX(sv),len,char);
4802                 *SvEND(sv) = '\0';
4803             }
4804             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4805         }
4806 #endif
4807     if (SvROK(sv))
4808         sv_unref_flags(sv, flags);
4809     else if (SvFAKE(sv) && isGV_with_GP(sv))
4810         sv_unglob(sv, flags);
4811     else if (SvFAKE(sv) && isREGEXP(sv)) {
4812         /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4813            to sv_unglob. We only need it here, so inline it.  */
4814         const bool islv = SvTYPE(sv) == SVt_PVLV;
4815         const svtype new_type =
4816           islv ? SVt_NULL : SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4817         SV *const temp = newSV_type(new_type);
4818         regexp *const temp_p = ReANY((REGEXP *)sv);
4819
4820         if (new_type == SVt_PVMG) {
4821             SvMAGIC_set(temp, SvMAGIC(sv));
4822             SvMAGIC_set(sv, NULL);
4823             SvSTASH_set(temp, SvSTASH(sv));
4824             SvSTASH_set(sv, NULL);
4825         }
4826         if (!islv) SvCUR_set(temp, SvCUR(sv));
4827         /* Remember that SvPVX is in the head, not the body.  But
4828            RX_WRAPPED is in the body. */
4829         assert(ReANY((REGEXP *)sv)->mother_re);
4830         /* Their buffer is already owned by someone else. */
4831         if (flags & SV_COW_DROP_PV) {
4832             /* SvLEN is already 0.  For SVt_REGEXP, we have a brand new
4833                zeroed body.  For SVt_PVLV, it should have been set to 0
4834                before turning into a regexp. */
4835             assert(!SvLEN(islv ? sv : temp));
4836             sv->sv_u.svu_pv = 0;
4837         }
4838         else {
4839             sv->sv_u.svu_pv = savepvn(RX_WRAPPED((REGEXP *)sv), SvCUR(sv));
4840             SvLEN_set(islv ? sv : temp, SvCUR(sv)+1);
4841             SvPOK_on(sv);
4842         }
4843
4844         /* Now swap the rest of the bodies. */
4845
4846         SvFAKE_off(sv);
4847         if (!islv) {
4848             SvFLAGS(sv) &= ~SVTYPEMASK;
4849             SvFLAGS(sv) |= new_type;
4850             SvANY(sv) = SvANY(temp);
4851         }
4852
4853         SvFLAGS(temp) &= ~(SVTYPEMASK);
4854         SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4855         SvANY(temp) = temp_p;
4856         temp->sv_u.svu_rx = (regexp *)temp_p;
4857
4858         SvREFCNT_dec(temp);
4859     }
4860     else if (SvVOK(sv)) sv_unmagic(sv, PERL_MAGIC_vstring);
4861 }
4862
4863 /*
4864 =for apidoc sv_chop
4865
4866 Efficient removal of characters from the beginning of the string buffer.
4867 SvPOK(sv), or at least SvPOKp(sv), must be true and the C<ptr> must be a
4868 pointer to somewhere inside the string buffer.  The C<ptr> becomes the first
4869 character of the adjusted string.  Uses the "OOK hack".  On return, only
4870 SvPOK(sv) and SvPOKp(sv) among the OK flags will be true.
4871
4872 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4873 refer to the same chunk of data.
4874
4875 The unfortunate similarity of this function's name to that of Perl's C<chop>
4876 operator is strictly coincidental.  This function works from the left;
4877 C<chop> works from the right.
4878
4879 =cut
4880 */
4881
4882 void
4883 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4884 {
4885     STRLEN delta;
4886     STRLEN old_delta;
4887     U8 *p;
4888 #ifdef DEBUGGING
4889     const U8 *evacp;
4890     STRLEN evacn;
4891 #endif
4892     STRLEN max_delta;
4893
4894     PERL_ARGS_ASSERT_SV_CHOP;
4895
4896     if (!ptr || !SvPOKp(sv))
4897         return;
4898     delta = ptr - SvPVX_const(sv);
4899     if (!delta) {
4900         /* Nothing to do.  */
4901         return;
4902     }
4903     max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4904     if (delta > max_delta)
4905         Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4906                    ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4907     /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4908     SV_CHECK_THINKFIRST(sv);
4909     SvPOK_only_UTF8(sv);
4910
4911     if (!SvOOK(sv)) {
4912         if (!SvLEN(sv)) { /* make copy of shared string */
4913             const char *pvx = SvPVX_const(sv);
4914             const STRLEN len = SvCUR(sv);
4915             SvGROW(sv, len + 1);
4916             Move(pvx,SvPVX(sv),len,char);
4917             *SvEND(sv) = '\0';
4918         }
4919         SvOOK_on(sv);
4920         old_delta = 0;
4921     } else {
4922         SvOOK_offset(sv, old_delta);
4923     }
4924     SvLEN_set(sv, SvLEN(sv) - delta);
4925     SvCUR_set(sv, SvCUR(sv) - delta);
4926     SvPV_set(sv, SvPVX(sv) + delta);
4927
4928     p = (U8 *)SvPVX_const(sv);
4929
4930 #ifdef DEBUGGING
4931     /* how many bytes were evacuated?  we will fill them with sentinel
4932        bytes, except for the part holding the new offset of course. */
4933     evacn = delta;
4934     if (old_delta)
4935         evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4936     assert(evacn);
4937     assert(evacn <= delta + old_delta);
4938     evacp = p - evacn;
4939 #endif
4940
4941     delta += old_delta;
4942     assert(delta);
4943     if (delta < 0x100) {
4944         *--p = (U8) delta;
4945     } else {
4946         *--p = 0;
4947         p -= sizeof(STRLEN);
4948         Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4949     }
4950
4951 #ifdef DEBUGGING
4952     /* Fill the preceding buffer with sentinals to verify that no-one is
4953        using it.  */
4954     while (p > evacp) {
4955         --p;
4956         *p = (U8)PTR2UV(p);
4957     }
4958 #endif
4959 }
4960
4961 /*
4962 =for apidoc sv_catpvn
4963
4964 Concatenates the string onto the end of the string which is in the SV.  The
4965 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4966 status set, then the bytes appended should be valid UTF-8.
4967 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4968
4969 =for apidoc sv_catpvn_flags
4970
4971 Concatenates the string onto the end of the string which is in the SV.  The
4972 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4973 status set, then the bytes appended should be valid UTF-8.
4974 If C<flags> has the C<SV_SMAGIC> bit set, will
4975 C<mg_set> on C<dsv> afterwards if appropriate.
4976 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4977 in terms of this function.
4978
4979 =cut
4980 */
4981
4982 void
4983 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4984 {
4985     dVAR;
4986     STRLEN dlen;
4987     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4988
4989     PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4990     assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
4991
4992     if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
4993       if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
4994          sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
4995          dlen = SvCUR(dsv);
4996       }
4997       else SvGROW(dsv, dlen + slen + 1);
4998       if (sstr == dstr)
4999         sstr = SvPVX_const(dsv);
5000       Move(sstr, SvPVX(dsv) + dlen, slen, char);
5001       SvCUR_set(dsv, SvCUR(dsv) + slen);
5002     }
5003     else {
5004         /* We inline bytes_to_utf8, to avoid an extra malloc. */
5005         const char * const send = sstr + slen;
5006         U8 *d;
5007
5008         /* Something this code does not account for, which I think is
5009            impossible; it would require the same pv to be treated as
5010            bytes *and* utf8, which would indicate a bug elsewhere. */
5011         assert(sstr != dstr);
5012
5013         SvGROW(dsv, dlen + slen * 2 + 1);
5014         d = (U8 *)SvPVX(dsv) + dlen;
5015
5016         while (sstr < send) {
5017             const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5018             if (UNI_IS_INVARIANT(uv))
5019                 *d++ = (U8)UTF_TO_NATIVE(uv);
5020             else {
5021                 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5022                 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5023             }
5024         }
5025         SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5026     }
5027     *SvEND(dsv) = '\0';
5028     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
5029     SvTAINT(dsv);
5030     if (flags & SV_SMAGIC)
5031         SvSETMAGIC(dsv);
5032 }
5033
5034 /*
5035 =for apidoc sv_catsv
5036
5037 Concatenates the string from SV C<ssv> onto the end of the string in SV
5038 C<dsv>.  If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5039 Handles 'get' magic on both SVs, but no 'set' magic.  See C<sv_catsv_mg> and
5040 C<sv_catsv_nomg>.
5041
5042 =for apidoc sv_catsv_flags
5043
5044 Concatenates the string from SV C<ssv> onto the end of the string in SV
5045 C<dsv>.  If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5046 If C<flags> include C<SV_GMAGIC> bit set, will call C<mg_get> on both SVs if
5047 appropriate.  If C<flags> include C<SV_SMAGIC>, C<mg_set> will be called on
5048 the modified SV afterward, if appropriate.  C<sv_catsv>, C<sv_catsv_nomg>,
5049 and C<sv_catsv_mg> are implemented in terms of this function.
5050
5051 =cut */
5052
5053 void
5054 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5055 {
5056     dVAR;
5057  
5058     PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5059
5060     if (ssv) {
5061         STRLEN slen;
5062         const char *spv = SvPV_flags_const(ssv, slen, flags);
5063         if (spv) {
5064             if (flags & SV_GMAGIC)
5065                 SvGETMAGIC(dsv);
5066             sv_catpvn_flags(dsv, spv, slen,
5067                             DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5068             if (flags & SV_SMAGIC)
5069                 SvSETMAGIC(dsv);
5070         }
5071     }
5072 }
5073
5074 /*
5075 =for apidoc sv_catpv
5076
5077 Concatenates the string onto the end of the string which is in the SV.
5078 If the SV has the UTF-8 status set, then the bytes appended should be
5079 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
5080
5081 =cut */
5082
5083 void
5084 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5085 {
5086     dVAR;
5087     STRLEN len;
5088     STRLEN tlen;
5089     char *junk;
5090
5091     PERL_ARGS_ASSERT_SV_CATPV;
5092
5093     if (!ptr)
5094         return;
5095     junk = SvPV_force(sv, tlen);
5096     len = strlen(ptr);
5097     SvGROW(sv, tlen + len + 1);
5098     if (ptr == junk)
5099         ptr = SvPVX_const(sv);
5100     Move(ptr,SvPVX(sv)+tlen,len+1,char);
5101     SvCUR_set(sv, SvCUR(sv) + len);
5102     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
5103     SvTAINT(sv);
5104 }
5105
5106 /*
5107 =for apidoc sv_catpv_flags
5108
5109 Concatenates the string onto the end of the string which is in the SV.
5110 If the SV has the UTF-8 status set, then the bytes appended should
5111 be valid UTF-8.  If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5112 on the modified SV if appropriate.
5113
5114 =cut
5115 */
5116
5117 void
5118 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5119 {
5120     PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5121     sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5122 }
5123
5124 /*
5125 =for apidoc sv_catpv_mg
5126
5127 Like C<sv_catpv>, but also handles 'set' magic.
5128
5129 =cut
5130 */
5131
5132 void
5133 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5134 {
5135     PERL_ARGS_ASSERT_SV_CATPV_MG;
5136
5137     sv_catpv(sv,ptr);
5138     SvSETMAGIC(sv);
5139 }
5140
5141 /*
5142 =for apidoc newSV
5143
5144 Creates a new SV.  A non-zero C<len> parameter indicates the number of
5145 bytes of preallocated string space the SV should have.  An extra byte for a
5146 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
5147 space is allocated.)  The reference count for the new SV is set to 1.
5148
5149 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5150 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5151 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5152 L<perlhacktips/PERL_MEM_LOG>).  The older API is still there for use in XS
5153 modules supporting older perls.
5154
5155 =cut
5156 */
5157
5158 SV *
5159 Perl_newSV(pTHX_ const STRLEN len)
5160 {
5161     dVAR;
5162     SV *sv;
5163
5164     new_SV(sv);
5165     if (len) {
5166         sv_upgrade(sv, SVt_PV);
5167         SvGROW(sv, len + 1);
5168     }
5169     return sv;
5170 }
5171 /*
5172 =for apidoc sv_magicext
5173
5174 Adds magic to an SV, upgrading it if necessary.  Applies the
5175 supplied vtable and returns a pointer to the magic added.
5176
5177 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5178 In particular, you can add magic to SvREADONLY SVs, and add more than
5179 one instance of the same 'how'.
5180
5181 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5182 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5183 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5184 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5185
5186 (This is now used as a subroutine by C<sv_magic>.)
5187
5188 =cut
5189 */
5190 MAGIC * 
5191 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how, 
5192                 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5193 {
5194     dVAR;
5195     MAGIC* mg;
5196
5197     PERL_ARGS_ASSERT_SV_MAGICEXT;
5198
5199     SvUPGRADE(sv, SVt_PVMG);
5200     Newxz(mg, 1, MAGIC);
5201     mg->mg_moremagic = SvMAGIC(sv);
5202     SvMAGIC_set(sv, mg);
5203
5204     /* Sometimes a magic contains a reference loop, where the sv and
5205        object refer to each other.  To prevent a reference loop that
5206        would prevent such objects being freed, we look for such loops
5207        and if we find one we avoid incrementing the object refcount.
5208
5209        Note we cannot do this to avoid self-tie loops as intervening RV must
5210        have its REFCNT incremented to keep it in existence.
5211
5212     */
5213     if (!obj || obj == sv ||
5214         how == PERL_MAGIC_arylen ||
5215         how == PERL_MAGIC_symtab ||
5216         (SvTYPE(obj) == SVt_PVGV &&
5217             (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5218              || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5219              || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5220     {
5221         mg->mg_obj = obj;
5222     }
5223     else {
5224         mg->mg_obj = SvREFCNT_inc_simple(obj);
5225         mg->mg_flags |= MGf_REFCOUNTED;
5226     }
5227
5228     /* Normal self-ties simply pass a null object, and instead of
5229        using mg_obj directly, use the SvTIED_obj macro to produce a
5230        new RV as needed.  For glob "self-ties", we are tieing the PVIO
5231        with an RV obj pointing to the glob containing the PVIO.  In
5232        this case, to avoid a reference loop, we need to weaken the
5233        reference.
5234     */
5235
5236     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5237         obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5238     {
5239       sv_rvweaken(obj);
5240     }
5241
5242     mg->mg_type = how;
5243     mg->mg_len = namlen;
5244     if (name) {
5245         if (namlen > 0)
5246             mg->mg_ptr = savepvn(name, namlen);
5247         else if (namlen == HEf_SVKEY) {
5248             /* Yes, this is casting away const. This is only for the case of
5249                HEf_SVKEY. I think we need to document this aberation of the
5250                constness of the API, rather than making name non-const, as
5251                that change propagating outwards a long way.  */
5252             mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5253         } else
5254             mg->mg_ptr = (char *) name;
5255     }
5256     mg->mg_virtual = (MGVTBL *) vtable;
5257
5258     mg_magical(sv);
5259     return mg;
5260 }
5261
5262 /*
5263 =for apidoc sv_magic
5264
5265 Adds magic to an SV.  First upgrades C<sv> to type C<SVt_PVMG> if
5266 necessary, then adds a new magic item of type C<how> to the head of the
5267 magic list.
5268
5269 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5270 handling of the C<name> and C<namlen> arguments.
5271
5272 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5273 to add more than one instance of the same 'how'.
5274
5275 =cut
5276 */
5277
5278 void
5279 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how, 
5280              const char *const name, const I32 namlen)
5281 {
5282     dVAR;
5283     const MGVTBL *vtable;
5284     MAGIC* mg;
5285     unsigned int flags;
5286     unsigned int vtable_index;
5287
5288     PERL_ARGS_ASSERT_SV_MAGIC;
5289
5290     if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5291         || ((flags = PL_magic_data[how]),
5292             (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5293             > magic_vtable_max))
5294         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5295
5296     /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5297        Useful for attaching extension internal data to perl vars.
5298        Note that multiple extensions may clash if magical scalars
5299        etc holding private data from one are passed to another. */
5300
5301     vtable = (vtable_index == magic_vtable_max)
5302         ? NULL : PL_magic_vtables + vtable_index;
5303
5304 #ifdef PERL_OLD_COPY_ON_WRITE
5305     if (SvIsCOW(sv))
5306         sv_force_normal_flags(sv, 0);
5307 #endif
5308     if (SvREADONLY(sv)) {
5309         if (
5310             /* its okay to attach magic to shared strings */
5311             !SvIsCOW(sv)
5312
5313             && IN_PERL_RUNTIME
5314             && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5315            )
5316         {
5317             Perl_croak_no_modify();
5318         }
5319     }
5320     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5321         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5322             /* sv_magic() refuses to add a magic of the same 'how' as an
5323                existing one
5324              */
5325             if (how == PERL_MAGIC_taint)
5326                 mg->mg_len |= 1;
5327             return;
5328         }
5329     }
5330
5331     /* Rest of work is done else where */
5332     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5333
5334     switch (how) {
5335     case PERL_MAGIC_taint:
5336         mg->mg_len = 1;
5337         break;
5338     case PERL_MAGIC_ext:
5339     case PERL_MAGIC_dbfile:
5340         SvRMAGICAL_on(sv);
5341         break;
5342     }
5343 }
5344
5345 static int
5346 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5347 {
5348     MAGIC* mg;
5349     MAGIC** mgp;
5350
5351     assert(flags <= 1);
5352
5353     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5354         return 0;
5355     mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5356     for (mg = *mgp; mg; mg = *mgp) {
5357         const MGVTBL* const virt = mg->mg_virtual;
5358         if (mg->mg_type == type && (!flags || virt == vtbl)) {
5359             *mgp = mg->mg_moremagic;
5360             if (virt && virt->svt_free)
5361                 virt->svt_free(aTHX_ sv, mg);
5362             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5363                 if (mg->mg_len > 0)
5364                     Safefree(mg->mg_ptr);
5365                 else if (mg->mg_len == HEf_SVKEY)
5366                     SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5367                 else if (mg->mg_type == PERL_MAGIC_utf8)
5368                     Safefree(mg->mg_ptr);
5369             }
5370             if (mg->mg_flags & MGf_REFCOUNTED)
5371                 SvREFCNT_dec(mg->mg_obj);
5372             Safefree(mg);
5373         }
5374         else
5375             mgp = &mg->mg_moremagic;
5376     }
5377     if (SvMAGIC(sv)) {
5378         if (SvMAGICAL(sv))      /* if we're under save_magic, wait for restore_magic; */
5379             mg_magical(sv);     /*    else fix the flags now */
5380     }
5381     else {
5382         SvMAGICAL_off(sv);
5383         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5384     }
5385     return 0;
5386 }
5387
5388 /*
5389 =for apidoc sv_unmagic
5390
5391 Removes all magic of type C<type> from an SV.
5392
5393 =cut
5394 */
5395
5396 int
5397 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5398 {
5399     PERL_ARGS_ASSERT_SV_UNMAGIC;
5400     return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5401 }
5402
5403 /*
5404 =for apidoc sv_unmagicext
5405
5406 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5407
5408 =cut
5409 */
5410
5411 int
5412 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5413 {
5414     PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5415     return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5416 }
5417
5418 /*
5419 =for apidoc sv_rvweaken
5420
5421 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5422 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5423 push a back-reference to this RV onto the array of backreferences
5424 associated with that magic.  If the RV is magical, set magic will be
5425 called after the RV is cleared.
5426
5427 =cut
5428 */
5429
5430 SV *
5431 Perl_sv_rvweaken(pTHX_ SV *const sv)
5432 {
5433     SV *tsv;
5434
5435     PERL_ARGS_ASSERT_SV_RVWEAKEN;
5436
5437     if (!SvOK(sv))  /* let undefs pass */
5438         return sv;
5439     if (!SvROK(sv))
5440         Perl_croak(aTHX_ "Can't weaken a nonreference");
5441     else if (SvWEAKREF(sv)) {
5442         Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5443         return sv;
5444     }
5445     else if (SvREADONLY(sv)) croak_no_modify();
5446     tsv = SvRV(sv);
5447     Perl_sv_add_backref(aTHX_ tsv, sv);
5448     SvWEAKREF_on(sv);
5449     SvREFCNT_dec(tsv);
5450     return sv;
5451 }
5452
5453 /* Give tsv backref magic if it hasn't already got it, then push a
5454  * back-reference to sv onto the array associated with the backref magic.
5455  *
5456  * As an optimisation, if there's only one backref and it's not an AV,
5457  * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5458  * allocate an AV. (Whether the slot holds an AV tells us whether this is
5459  * active.)
5460  */
5461
5462 /* A discussion about the backreferences array and its refcount:
5463  *
5464  * The AV holding the backreferences is pointed to either as the mg_obj of
5465  * PERL_MAGIC_backref, or in the specific case of a HV, from the
5466  * xhv_backreferences field. The array is created with a refcount
5467  * of 2. This means that if during global destruction the array gets
5468  * picked on before its parent to have its refcount decremented by the
5469  * random zapper, it won't actually be freed, meaning it's still there for
5470  * when its parent gets freed.
5471  *
5472  * When the parent SV is freed, the extra ref is killed by
5473  * Perl_sv_kill_backrefs.  The other ref is killed, in the case of magic,
5474  * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5475  *
5476  * When a single backref SV is stored directly, it is not reference
5477  * counted.
5478  */
5479
5480 void
5481 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5482 {
5483     dVAR;
5484     SV **svp;
5485     AV *av = NULL;
5486     MAGIC *mg = NULL;
5487
5488     PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5489
5490     /* find slot to store array or singleton backref */
5491
5492     if (SvTYPE(tsv) == SVt_PVHV) {
5493         svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5494     } else {
5495         if (! ((mg =
5496             (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5497         {
5498             sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5499             mg = mg_find(tsv, PERL_MAGIC_backref);
5500         }
5501         svp = &(mg->mg_obj);
5502     }
5503
5504     /* create or retrieve the array */
5505
5506     if (   (!*svp && SvTYPE(sv) == SVt_PVAV)
5507         || (*svp && SvTYPE(*svp) != SVt_PVAV)
5508     ) {
5509         /* create array */
5510         av = newAV();
5511         AvREAL_off(av);
5512         SvREFCNT_inc_simple_void(av);
5513         /* av now has a refcnt of 2; see discussion above */
5514         if (*svp) {
5515             /* move single existing backref to the array */
5516             av_extend(av, 1);
5517             AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5518         }
5519         *svp = (SV*)av;
5520         if (mg)
5521             mg->mg_flags |= MGf_REFCOUNTED;
5522     }
5523     else
5524         av = MUTABLE_AV(*svp);
5525
5526     if (!av) {
5527         /* optimisation: store single backref directly in HvAUX or mg_obj */
5528         *svp = sv;
5529         return;
5530     }
5531     /* push new backref */
5532     assert(SvTYPE(av) == SVt_PVAV);
5533     if (AvFILLp(av) >= AvMAX(av)) {
5534         av_extend(av, AvFILLp(av)+1);
5535     }
5536     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5537 }
5538
5539 /* delete a back-reference to ourselves from the backref magic associated
5540  * with the SV we point to.
5541  */
5542
5543 void
5544 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5545 {
5546     dVAR;
5547     SV **svp = NULL;
5548
5549     PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5550
5551     if (SvTYPE(tsv) == SVt_PVHV) {
5552         if (SvOOK(tsv))
5553             svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5554     }
5555     else if (SvIS_FREED(tsv) && PL_phase == PERL_PHASE_DESTRUCT) {
5556         /* It's possible for the the last (strong) reference to tsv to have
5557            become freed *before* the last thing holding a weak reference.
5558            If both survive longer than the backreferences array, then when
5559            the referent's reference count drops to 0 and it is freed, it's
5560            not able to chase the backreferences, so they aren't NULLed.
5561
5562            For example, a CV holds a weak reference to its stash. If both the
5563            CV and the stash survive longer than the backreferences array,
5564            and the CV gets picked for the SvBREAK() treatment first,
5565            *and* it turns out that the stash is only being kept alive because
5566            of an our variable in the pad of the CV, then midway during CV
5567            destruction the stash gets freed, but CvSTASH() isn't set to NULL.
5568            It ends up pointing to the freed HV. Hence it's chased in here, and
5569            if this block wasn't here, it would hit the !svp panic just below.
5570
5571            I don't believe that "better" destruction ordering is going to help
5572            here - during global destruction there's always going to be the
5573            chance that something goes out of order. We've tried to make it
5574            foolproof before, and it only resulted in evolutionary pressure on
5575            fools. Which made us look foolish for our hubris. :-(
5576         */
5577         return;
5578     }
5579     else {
5580         MAGIC *const mg
5581             = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5582         svp =  mg ? &(mg->mg_obj) : NULL;
5583     }
5584
5585     if (!svp)
5586         Perl_croak(aTHX_ "panic: del_backref, svp=0");
5587     if (!*svp) {
5588         /* It's possible that sv is being freed recursively part way through the
5589            freeing of tsv. If this happens, the backreferences array of tsv has
5590            already been freed, and so svp will be NULL. If this is the case,
5591            we should not panic. Instead, nothing needs doing, so return.  */
5592         if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5593             return;
5594         Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5595                    *svp, PL_phase_names[PL_phase], (UV)SvREFCNT(tsv));
5596     }
5597
5598     if (SvTYPE(*svp) == SVt_PVAV) {
5599 #ifdef DEBUGGING
5600         int count = 1;
5601 #endif
5602         AV * const av = (AV*)*svp;
5603         SSize_t fill;
5604         assert(!SvIS_FREED(av));
5605         fill = AvFILLp(av);
5606         assert(fill > -1);
5607         svp = AvARRAY(av);
5608         /* for an SV with N weak references to it, if all those
5609          * weak refs are deleted, then sv_del_backref will be called
5610          * N times and O(N^2) compares will be done within the backref
5611          * array. To ameliorate this potential slowness, we:
5612          * 1) make sure this code is as tight as possible;
5613          * 2) when looking for SV, look for it at both the head and tail of the
5614          *    array first before searching the rest, since some create/destroy
5615          *    patterns will cause the backrefs to be freed in order.
5616          */
5617         if (*svp == sv) {
5618             AvARRAY(av)++;
5619             AvMAX(av)--;
5620         }
5621         else {
5622             SV **p = &svp[fill];
5623             SV *const topsv = *p;
5624             if (topsv != sv) {
5625 #ifdef DEBUGGING
5626                 count = 0;
5627 #endif
5628                 while (--p > svp) {
5629                     if (*p == sv) {
5630                         /* We weren't the last entry.
5631                            An unordered list has this property that you
5632                            can take the last element off the end to fill
5633                            the hole, and it's still an unordered list :-)
5634                         */
5635                         *p = topsv;
5636 #ifdef DEBUGGING
5637                         count++;
5638 #else
5639                         break; /* should only be one */
5640 #endif
5641                     }
5642                 }
5643             }
5644         }
5645         assert(count ==1);
5646         AvFILLp(av) = fill-1;
5647     }
5648     else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5649         /* freed AV; skip */
5650     }
5651     else {
5652         /* optimisation: only a single backref, stored directly */
5653         if (*svp != sv)
5654             Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5655         *svp = NULL;
5656     }
5657
5658 }
5659
5660 void
5661 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5662 {
5663     SV **svp;
5664     SV **last;
5665     bool is_array;
5666
5667     PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5668
5669     if (!av)
5670         return;
5671
5672     /* after multiple passes through Perl_sv_clean_all() for a thingy
5673      * that has badly leaked, the backref array may have gotten freed,
5674      * since we only protect it against 1 round of cleanup */
5675     if (SvIS_FREED(av)) {
5676         if (PL_in_clean_all) /* All is fair */
5677             return;
5678         Perl_croak(aTHX_
5679                    "panic: magic_killbackrefs (freed backref AV/SV)");
5680     }
5681
5682
5683     is_array = (SvTYPE(av) == SVt_PVAV);
5684     if (is_array) {
5685         assert(!SvIS_FREED(av));
5686         svp = AvARRAY(av);
5687         if (svp)
5688             last = svp + AvFILLp(av);
5689     }
5690     else {
5691         /* optimisation: only a single backref, stored directly */
5692         svp = (SV**)&av;
5693         last = svp;
5694     }
5695
5696     if (svp) {
5697         while (svp <= last) {
5698             if (*svp) {
5699                 SV *const referrer = *svp;
5700                 if (SvWEAKREF(referrer)) {
5701                     /* XXX Should we check that it hasn't changed? */
5702                     assert(SvROK(referrer));
5703                     SvRV_set(referrer, 0);
5704                     SvOK_off(referrer);
5705                     SvWEAKREF_off(referrer);
5706                     SvSETMAGIC(referrer);
5707                 } else if (SvTYPE(referrer) == SVt_PVGV ||
5708                            SvTYPE(referrer) == SVt_PVLV) {
5709                     assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5710                     /* You lookin' at me?  */
5711                     assert(GvSTASH(referrer));
5712                     assert(GvSTASH(referrer) == (const HV *)sv);
5713                     GvSTASH(referrer) = 0;
5714                 } else if (SvTYPE(referrer) == SVt_PVCV ||
5715                            SvTYPE(referrer) == SVt_PVFM) {
5716                     if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5717                         /* You lookin' at me?  */
5718                         assert(CvSTASH(referrer));
5719                         assert(CvSTASH(referrer) == (const HV *)sv);
5720                         SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5721                     }
5722                     else {
5723                         assert(SvTYPE(sv) == SVt_PVGV);
5724                         /* You lookin' at me?  */
5725                         assert(CvGV(referrer));
5726                         assert(CvGV(referrer) == (const GV *)sv);
5727                         anonymise_cv_maybe(MUTABLE_GV(sv),
5728                                                 MUTABLE_CV(referrer));
5729                     }
5730
5731                 } else {
5732                     Perl_croak(aTHX_
5733                                "panic: magic_killbackrefs (flags=%"UVxf")",
5734                                (UV)SvFLAGS(referrer));
5735                 }
5736
5737                 if (is_array)
5738                     *svp = NULL;
5739             }
5740             svp++;
5741         }
5742     }
5743     if (is_array) {
5744         AvFILLp(av) = -1;
5745         SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5746     }
5747     return;
5748 }
5749
5750 /*
5751 =for apidoc sv_insert
5752
5753 Inserts a string at the specified offset/length within the SV.  Similar to
5754 the Perl substr() function.  Handles get magic.
5755
5756 =for apidoc sv_insert_flags
5757
5758 Same as C<sv_insert>, but the extra C<flags> are passed to the
5759 C<SvPV_force_flags> that applies to C<bigstr>.
5760
5761 =cut
5762 */
5763
5764 void
5765 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5766 {
5767     dVAR;
5768     char *big;
5769     char *mid;
5770     char *midend;
5771     char *bigend;
5772     SSize_t i;          /* better be sizeof(STRLEN) or bad things happen */
5773     STRLEN curlen;
5774
5775     PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5776
5777     if (!bigstr)
5778         Perl_croak(aTHX_ "Can't modify nonexistent substring");
5779     SvPV_force_flags(bigstr, curlen, flags);
5780     (void)SvPOK_only_UTF8(bigstr);
5781     if (offset + len > curlen) {
5782         SvGROW(bigstr, offset+len+1);
5783         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5784         SvCUR_set(bigstr, offset+len);
5785     }
5786
5787     SvTAINT(bigstr);
5788     i = littlelen - len;
5789     if (i > 0) {                        /* string might grow */
5790         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5791         mid = big + offset + len;
5792         midend = bigend = big + SvCUR(bigstr);
5793         bigend += i;
5794         *bigend = '\0';
5795         while (midend > mid)            /* shove everything down */
5796             *--bigend = *--midend;
5797         Move(little,big+offset,littlelen,char);
5798         SvCUR_set(bigstr, SvCUR(bigstr) + i);
5799         SvSETMAGIC(bigstr);
5800         return;
5801     }
5802     else if (i == 0) {
5803         Move(little,SvPVX(bigstr)+offset,len,char);
5804         SvSETMAGIC(bigstr);
5805         return;
5806     }
5807
5808     big = SvPVX(bigstr);
5809     mid = big + offset;
5810     midend = mid + len;
5811     bigend = big + SvCUR(bigstr);
5812
5813     if (midend > bigend)
5814         Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5815                    midend, bigend);
5816
5817     if (mid - big > bigend - midend) {  /* faster to shorten from end */
5818         if (littlelen) {
5819             Move(little, mid, littlelen,char);
5820             mid += littlelen;
5821         }
5822         i = bigend - midend;
5823         if (i > 0) {
5824             Move(midend, mid, i,char);
5825             mid += i;
5826         }
5827         *mid = '\0';
5828         SvCUR_set(bigstr, mid - big);
5829     }
5830     else if ((i = mid - big)) { /* faster from front */
5831         midend -= littlelen;
5832         mid = midend;
5833         Move(big, midend - i, i, char);
5834         sv_chop(bigstr,midend-i);
5835         if (littlelen)
5836             Move(little, mid, littlelen,char);
5837     }
5838     else if (littlelen) {
5839         midend -= littlelen;
5840         sv_chop(bigstr,midend);
5841         Move(little,midend,littlelen,char);
5842     }
5843     else {
5844         sv_chop(bigstr,midend);
5845     }
5846     SvSETMAGIC(bigstr);
5847 }
5848
5849 /*
5850 =for apidoc sv_replace
5851
5852 Make the first argument a copy of the second, then delete the original.
5853 The target SV physically takes over ownership of the body of the source SV
5854 and inherits its flags; however, the target keeps any magic it owns,
5855 and any magic in the source is discarded.
5856 Note that this is a rather specialist SV copying operation; most of the
5857 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5858
5859 =cut
5860 */
5861
5862 void
5863 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5864 {
5865     dVAR;
5866     const U32 refcnt = SvREFCNT(sv);
5867
5868     PERL_ARGS_ASSERT_SV_REPLACE;
5869
5870     SV_CHECK_THINKFIRST_COW_DROP(sv);
5871     if (SvREFCNT(nsv) != 1) {
5872         Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5873                    " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5874     }
5875     if (SvMAGICAL(sv)) {
5876         if (SvMAGICAL(nsv))
5877             mg_free(nsv);
5878         else
5879             sv_upgrade(nsv, SVt_PVMG);
5880         SvMAGIC_set(nsv, SvMAGIC(sv));
5881         SvFLAGS(nsv) |= SvMAGICAL(sv);
5882         SvMAGICAL_off(sv);
5883         SvMAGIC_set(sv, NULL);
5884     }
5885     SvREFCNT(sv) = 0;
5886     sv_clear(sv);
5887     assert(!SvREFCNT(sv));
5888 #ifdef DEBUG_LEAKING_SCALARS
5889     sv->sv_flags  = nsv->sv_flags;
5890     sv->sv_any    = nsv->sv_any;
5891     sv->sv_refcnt = nsv->sv_refcnt;
5892     sv->sv_u      = nsv->sv_u;
5893 #else
5894     StructCopy(nsv,sv,SV);
5895 #endif
5896     if(SvTYPE(sv) == SVt_IV) {
5897         SvANY(sv)
5898             = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5899     }
5900         
5901
5902 #ifdef PERL_OLD_COPY_ON_WRITE
5903     if (SvIsCOW_normal(nsv)) {
5904         /* We need to follow the pointers around the loop to make the
5905            previous SV point to sv, rather than nsv.  */
5906         SV *next;
5907         SV *current = nsv;
5908         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5909             assert(next);
5910             current = next;
5911             assert(SvPVX_const(current) == SvPVX_const(nsv));
5912         }
5913         /* Make the SV before us point to the SV after us.  */
5914         if (DEBUG_C_TEST) {
5915             PerlIO_printf(Perl_debug_log, "previous is\n");
5916             sv_dump(current);
5917             PerlIO_printf(Perl_debug_log,
5918                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5919                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5920         }
5921         SV_COW_NEXT_SV_SET(current, sv);
5922     }
5923 #endif
5924     SvREFCNT(sv) = refcnt;
5925     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5926     SvREFCNT(nsv) = 0;
5927     del_SV(nsv);
5928 }
5929
5930 /* We're about to free a GV which has a CV that refers back to us.
5931  * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5932  * field) */
5933
5934 STATIC void
5935 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5936 {
5937     SV *gvname;
5938     GV *anongv;
5939
5940     PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5941
5942     /* be assertive! */
5943     assert(SvREFCNT(gv) == 0);
5944     assert(isGV(gv) && isGV_with_GP(gv));
5945     assert(GvGP(gv));
5946     assert(!CvANON(cv));
5947     assert(CvGV(cv) == gv);
5948     assert(!CvNAMED(cv));
5949
5950     /* will the CV shortly be freed by gp_free() ? */
5951     if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5952         SvANY(cv)->xcv_gv_u.xcv_gv = NULL;
5953         return;
5954     }
5955
5956     /* if not, anonymise: */
5957     gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5958                     ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5959                     : newSVpvn_flags( "__ANON__", 8, 0 );
5960     sv_catpvs(gvname, "::__ANON__");
5961     anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5962     SvREFCNT_dec(gvname);
5963
5964     CvANON_on(cv);
5965     CvCVGV_RC_on(cv);
5966     SvANY(cv)->xcv_gv_u.xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5967 }
5968
5969
5970 /*
5971 =for apidoc sv_clear
5972
5973 Clear an SV: call any destructors, free up any memory used by the body,
5974 and free the body itself.  The SV's head is I<not> freed, although
5975 its type is set to all 1's so that it won't inadvertently be assumed
5976 to be live during global destruction etc.
5977 This function should only be called when REFCNT is zero.  Most of the time
5978 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5979 instead.
5980
5981 =cut
5982 */
5983
5984 void
5985 Perl_sv_clear(pTHX_ SV *const orig_sv)
5986 {
5987     dVAR;
5988     HV *stash;
5989     U32 type;
5990     const struct body_details *sv_type_details;
5991     SV* iter_sv = NULL;
5992     SV* next_sv = NULL;
5993     SV *sv = orig_sv;
5994     STRLEN hash_index;
5995
5996     PERL_ARGS_ASSERT_SV_CLEAR;
5997
5998     /* within this loop, sv is the SV currently being freed, and
5999      * iter_sv is the most recent AV or whatever that's being iterated
6000      * over to provide more SVs */
6001
6002     while (sv) {
6003
6004         type = SvTYPE(sv);
6005
6006         assert(SvREFCNT(sv) == 0);
6007         assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
6008
6009         if (type <= SVt_IV) {
6010             /* See the comment in sv.h about the collusion between this
6011              * early return and the overloading of the NULL slots in the
6012              * size table.  */
6013             if (SvROK(sv))
6014                 goto free_rv;
6015             SvFLAGS(sv) &= SVf_BREAK;
6016             SvFLAGS(sv) |= SVTYPEMASK;
6017             goto free_head;
6018         }
6019
6020         assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6021
6022         if (type >= SVt_PVMG) {
6023             if (SvOBJECT(sv)) {
6024                 if (!curse(sv, 1)) goto get_next_sv;
6025                 type = SvTYPE(sv); /* destructor may have changed it */
6026             }
6027             /* Free back-references before magic, in case the magic calls
6028              * Perl code that has weak references to sv. */
6029             if (type == SVt_PVHV) {
6030                 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6031                 if (SvMAGIC(sv))
6032                     mg_free(sv);
6033             }
6034             else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6035                 SvREFCNT_dec(SvOURSTASH(sv));
6036             } else if (SvMAGIC(sv)) {
6037                 /* Free back-references before other types of magic. */
6038                 sv_unmagic(sv, PERL_MAGIC_backref);
6039                 mg_free(sv);
6040             }
6041             SvMAGICAL_off(sv);
6042             if (type == SVt_PVMG && SvPAD_TYPED(sv))
6043                 SvREFCNT_dec(SvSTASH(sv));
6044         }
6045         switch (type) {
6046             /* case SVt_BIND: */
6047         case SVt_PVIO:
6048             if (IoIFP(sv) &&
6049                 IoIFP(sv) != PerlIO_stdin() &&
6050                 IoIFP(sv) != PerlIO_stdout() &&
6051                 IoIFP(sv) != PerlIO_stderr() &&
6052                 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6053             {
6054                 io_close(MUTABLE_IO(sv), FALSE);
6055             }
6056             if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6057                 PerlDir_close(IoDIRP(sv));
6058             IoDIRP(sv) = (DIR*)NULL;
6059             Safefree(IoTOP_NAME(sv));
6060             Safefree(IoFMT_NAME(sv));
6061             Safefree(IoBOTTOM_NAME(sv));
6062             if ((const GV *)sv == PL_statgv)
6063                 PL_statgv = NULL;
6064             goto freescalar;
6065         case SVt_REGEXP:
6066             /* FIXME for plugins */
6067           freeregexp:
6068             pregfree2((REGEXP*) sv);
6069             goto freescalar;
6070         case SVt_PVCV:
6071         case SVt_PVFM:
6072             cv_undef(MUTABLE_CV(sv));
6073             /* If we're in a stash, we don't own a reference to it.
6074              * However it does have a back reference to us, which needs to
6075              * be cleared.  */
6076             if ((stash = CvSTASH(sv)))
6077                 sv_del_backref(MUTABLE_SV(stash), sv);
6078             goto freescalar;
6079         case SVt_PVHV:
6080             if (PL_last_swash_hv == (const HV *)sv) {
6081                 PL_last_swash_hv = NULL;
6082             }
6083             if (HvTOTALKEYS((HV*)sv) > 0) {
6084                 const char *name;
6085                 /* this statement should match the one at the beginning of
6086                  * hv_undef_flags() */
6087                 if (   PL_phase != PERL_PHASE_DESTRUCT
6088                     && (name = HvNAME((HV*)sv)))
6089                 {
6090                     if (PL_stashcache) {
6091                     DEBUG_o(Perl_deb(aTHX_ "sv_clear clearing PL_stashcache for '%"SVf"'\n",
6092                                      sv));
6093                         (void)hv_delete(PL_stashcache, name,
6094                             HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6095                     }
6096                     hv_name_set((HV*)sv, NULL, 0, 0);
6097                 }
6098
6099                 /* save old iter_sv in unused SvSTASH field */
6100                 assert(!SvOBJECT(sv));
6101                 SvSTASH(sv) = (HV*)iter_sv;
6102                 iter_sv = sv;
6103
6104                 /* save old hash_index in unused SvMAGIC field */
6105                 assert(!SvMAGICAL(sv));
6106                 assert(!SvMAGIC(sv));
6107                 ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index = hash_index;
6108                 hash_index = 0;
6109
6110                 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6111                 goto get_next_sv; /* process this new sv */
6112             }
6113             /* free empty hash */
6114             Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6115             assert(!HvARRAY((HV*)sv));
6116             break;
6117         case SVt_PVAV:
6118             {
6119                 AV* av = MUTABLE_AV(sv);
6120                 if (PL_comppad == av) {
6121                     PL_comppad = NULL;
6122                     PL_curpad = NULL;
6123                 }
6124                 if (AvREAL(av) && AvFILLp(av) > -1) {
6125                     next_sv = AvARRAY(av)[AvFILLp(av)--];
6126                     /* save old iter_sv in top-most slot of AV,
6127                      * and pray that it doesn't get wiped in the meantime */
6128                     AvARRAY(av)[AvMAX(av)] = iter_sv;
6129                     iter_sv = sv;
6130                     goto get_next_sv; /* process this new sv */
6131                 }
6132                 Safefree(AvALLOC(av));
6133             }
6134
6135             break;
6136         case SVt_PVLV:
6137             if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6138                 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6139                 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6140                 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6141             }
6142             else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
6143                 SvREFCNT_dec(LvTARG(sv));
6144             if (isREGEXP(sv)) goto freeregexp;
6145         case SVt_PVGV:
6146             if (isGV_with_GP(sv)) {
6147                 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6148                    && HvENAME_get(stash))
6149                     mro_method_changed_in(stash);
6150                 gp_free(MUTABLE_GV(sv));
6151                 if (GvNAME_HEK(sv))
6152                     unshare_hek(GvNAME_HEK(sv));
6153                 /* If we're in a stash, we don't own a reference to it.
6154                  * However it does have a back reference to us, which
6155                  * needs to be cleared.  */
6156                 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6157                         sv_del_backref(MUTABLE_SV(stash), sv);
6158             }
6159             /* FIXME. There are probably more unreferenced pointers to SVs
6160              * in the interpreter struct that we should check and tidy in
6161              * a similar fashion to this:  */
6162             /* See also S_sv_unglob, which does the same thing. */
6163             if ((const GV *)sv == PL_last_in_gv)
6164                 PL_last_in_gv = NULL;
6165             else if ((const GV *)sv == PL_statgv)
6166                 PL_statgv = NULL;
6167         case SVt_PVMG:
6168         case SVt_PVNV:
6169         case SVt_PVIV:
6170         case SVt_PV:
6171           freescalar:
6172             /* Don't bother with SvOOK_off(sv); as we're only going to
6173              * free it.  */
6174             if (SvOOK(sv)) {
6175                 STRLEN offset;
6176                 SvOOK_offset(sv, offset);
6177                 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6178                 /* Don't even bother with turning off the OOK flag.  */
6179             }
6180             if (SvROK(sv)) {
6181             free_rv:
6182                 {
6183                     SV * const target = SvRV(sv);
6184                     if (SvWEAKREF(sv))
6185                         sv_del_backref(target, sv);
6186                     else
6187                         next_sv = target;
6188                 }
6189             }
6190 #ifdef PERL_OLD_COPY_ON_WRITE
6191             else if (SvPVX_const(sv)
6192                      && !(SvTYPE(sv) == SVt_PVIO
6193                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6194             {
6195                 if (SvIsCOW(sv)) {
6196                     if (DEBUG_C_TEST) {
6197                         PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6198                         sv_dump(sv);
6199                     }
6200                     if (SvLEN(sv)) {
6201                         sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6202                     } else {
6203                         unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6204                     }
6205
6206                 } else if (SvLEN(sv)) {
6207                     Safefree(SvPVX_mutable(sv));
6208                 }
6209             }
6210 #else
6211             else if (SvPVX_const(sv) && SvLEN(sv)
6212                      && !(SvTYPE(sv) == SVt_PVIO
6213                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6214                 Safefree(SvPVX_mutable(sv));
6215             else if (SvPVX_const(sv) && SvIsCOW(sv)) {
6216                 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6217             }
6218 #endif
6219             break;
6220         case SVt_NV:
6221             break;
6222         }
6223
6224       free_body:
6225
6226         SvFLAGS(sv) &= SVf_BREAK;
6227         SvFLAGS(sv) |= SVTYPEMASK;
6228
6229         sv_type_details = bodies_by_type + type;
6230         if (sv_type_details->arena) {
6231             del_body(((char *)SvANY(sv) + sv_type_details->offset),
6232                      &PL_body_roots[type]);
6233         }
6234         else if (sv_type_details->body_size) {
6235             safefree(SvANY(sv));
6236         }
6237
6238       free_head:
6239         /* caller is responsible for freeing the head of the original sv */
6240         if (sv != orig_sv && !SvREFCNT(sv))
6241             del_SV(sv);
6242
6243         /* grab and free next sv, if any */
6244       get_next_sv:
6245         while (1) {
6246             sv = NULL;
6247             if (next_sv) {
6248                 sv = next_sv;
6249                 next_sv = NULL;
6250             }
6251             else if (!iter_sv) {
6252                 break;
6253             } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6254                 AV *const av = (AV*)iter_sv;
6255                 if (AvFILLp(av) > -1) {
6256                     sv = AvARRAY(av)[AvFILLp(av)--];
6257                 }
6258                 else { /* no more elements of current AV to free */
6259                     sv = iter_sv;
6260                     type = SvTYPE(sv);
6261                     /* restore previous value, squirrelled away */
6262                     iter_sv = AvARRAY(av)[AvMAX(av)];
6263                     Safefree(AvALLOC(av));
6264                     goto free_body;
6265                 }
6266             } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6267                 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6268                 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6269                     /* no more elements of current HV to free */
6270                     sv = iter_sv;
6271                     type = SvTYPE(sv);
6272                     /* Restore previous values of iter_sv and hash_index,
6273                      * squirrelled away */
6274                     assert(!SvOBJECT(sv));
6275                     iter_sv = (SV*)SvSTASH(sv);
6276                     assert(!SvMAGICAL(sv));
6277                     hash_index = ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index;
6278 #ifdef DEBUGGING
6279                     /* perl -DA does not like rubbish in SvMAGIC. */
6280                     SvMAGIC_set(sv, 0);
6281 #endif
6282
6283                     /* free any remaining detritus from the hash struct */
6284                     Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6285                     assert(!HvARRAY((HV*)sv));
6286                     goto free_body;
6287                 }
6288             }
6289
6290             /* unrolled SvREFCNT_dec and sv_free2 follows: */
6291
6292             if (!sv)
6293                 continue;
6294             if (!SvREFCNT(sv)) {
6295                 sv_free(sv);
6296                 continue;
6297             }
6298             if (--(SvREFCNT(sv)))
6299                 continue;
6300 #ifdef DEBUGGING
6301             if (SvTEMP(sv)) {
6302                 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6303                          "Attempt to free temp prematurely: SV 0x%"UVxf
6304                          pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6305                 continue;
6306             }
6307 #endif
6308             if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6309                 /* make sure SvREFCNT(sv)==0 happens very seldom */
6310                 SvREFCNT(sv) = (~(U32)0)/2;
6311                 continue;
6312             }
6313             break;
6314         } /* while 1 */
6315
6316     } /* while sv */
6317 }
6318
6319 /* This routine curses the sv itself, not the object referenced by sv. So
6320    sv does not have to be ROK. */
6321
6322 static bool
6323 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6324     dVAR;
6325
6326     PERL_ARGS_ASSERT_CURSE;
6327     assert(SvOBJECT(sv));
6328
6329     if (PL_defstash &&  /* Still have a symbol table? */
6330         SvDESTROYABLE(sv))
6331     {
6332         dSP;
6333         HV* stash;
6334         do {
6335           if ((stash = SvSTASH(sv)) && HvNAME(stash)) {
6336             CV* destructor = NULL;
6337             if (!SvOBJECT(stash)) destructor = (CV *)SvSTASH(stash);
6338             if (!destructor) {
6339                 GV * const gv =
6340                     gv_fetchmeth_autoload(stash, "DESTROY", 7, 0);
6341                 if (gv && (destructor = GvCV(gv))) {
6342                     if (!SvOBJECT(stash))
6343                         SvSTASH(stash) = (HV *)destructor;
6344                 }
6345             }
6346             if (destructor
6347                 /* A constant subroutine can have no side effects, so
6348                    don't bother calling it.  */
6349                 && !CvCONST(destructor)
6350                 /* Don't bother calling an empty destructor or one that
6351                    returns immediately. */
6352                 && (CvISXSUB(destructor)
6353                 || (CvSTART(destructor)
6354                     && (CvSTART(destructor)->op_next->op_type
6355                                         != OP_LEAVESUB)
6356                     && (CvSTART(destructor)->op_next->op_type
6357                                         != OP_PUSHMARK
6358                         || CvSTART(destructor)->op_next->op_next->op_type
6359                                         != OP_RETURN
6360                        )
6361                    ))
6362                )
6363             {
6364                 SV* const tmpref = newRV(sv);
6365                 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6366                 ENTER;
6367                 PUSHSTACKi(PERLSI_DESTROY);
6368                 EXTEND(SP, 2);
6369                 PUSHMARK(SP);
6370                 PUSHs(tmpref);
6371                 PUTBACK;
6372                 call_sv(MUTABLE_SV(destructor),
6373                             G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6374                 POPSTACK;
6375                 SPAGAIN;
6376                 LEAVE;
6377                 if(SvREFCNT(tmpref) < 2) {
6378                     /* tmpref is not kept alive! */
6379                     SvREFCNT(sv)--;
6380                     SvRV_set(tmpref, NULL);
6381                     SvROK_off(tmpref);
6382                 }
6383                 SvREFCNT_dec(tmpref);
6384             }
6385           }
6386         } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6387
6388
6389         if (check_refcnt && SvREFCNT(sv)) {
6390             if (PL_in_clean_objs)
6391                 Perl_croak(aTHX_
6392                   "DESTROY created new reference to dead object '%"HEKf"'",
6393                    HEKfARG(HvNAME_HEK(stash)));
6394             /* DESTROY gave object new lease on life */
6395             return FALSE;
6396         }
6397     }
6398
6399     if (SvOBJECT(sv)) {
6400         SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6401         SvOBJECT_off(sv);       /* Curse the object. */
6402         if (SvTYPE(sv) != SVt_PVIO)
6403             --PL_sv_objcount;/* XXX Might want something more general */
6404     }
6405     return TRUE;
6406 }
6407
6408 /*
6409 =for apidoc sv_newref
6410
6411 Increment an SV's reference count.  Use the C<SvREFCNT_inc()> wrapper
6412 instead.
6413
6414 =cut
6415 */
6416
6417 SV *
6418 Perl_sv_newref(pTHX_ SV *const sv)
6419 {
6420     PERL_UNUSED_CONTEXT;
6421     if (sv)
6422         (SvREFCNT(sv))++;
6423     return sv;
6424 }
6425
6426 /*
6427 =for apidoc sv_free
6428
6429 Decrement an SV's reference count, and if it drops to zero, call
6430 C<sv_clear> to invoke destructors and free up any memory used by
6431 the body; finally, deallocate the SV's head itself.
6432 Normally called via a wrapper macro C<SvREFCNT_dec>.
6433
6434 =cut
6435 */
6436
6437 void
6438 Perl_sv_free(pTHX_ SV *const sv)
6439 {
6440     dVAR;
6441     if (!sv)
6442         return;
6443     if (SvREFCNT(sv) == 0) {
6444         if (SvFLAGS(sv) & SVf_BREAK)
6445             /* this SV's refcnt has been artificially decremented to
6446              * trigger cleanup */
6447             return;
6448         if (PL_in_clean_all) /* All is fair */
6449             return;
6450         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6451             /* make sure SvREFCNT(sv)==0 happens very seldom */
6452             SvREFCNT(sv) = (~(U32)0)/2;
6453             return;
6454         }
6455         if (ckWARN_d(WARN_INTERNAL)) {
6456 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6457             Perl_dump_sv_child(aTHX_ sv);
6458 #else
6459   #ifdef DEBUG_LEAKING_SCALARS
6460             sv_dump(sv);
6461   #endif
6462 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6463             if (PL_warnhook == PERL_WARNHOOK_FATAL
6464                 || ckDEAD(packWARN(WARN_INTERNAL))) {
6465                 /* Don't let Perl_warner cause us to escape our fate:  */
6466                 abort();
6467             }
6468 #endif
6469             /* This may not return:  */
6470             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6471                         "Attempt to free unreferenced scalar: SV 0x%"UVxf
6472                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6473 #endif
6474         }
6475 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6476         abort();
6477 #endif
6478         return;
6479     }
6480     if (--(SvREFCNT(sv)) > 0)
6481