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