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