This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #36347] Object destruction incomplete
[perl5.git] / sv.c
CommitLineData
a0d0e21e 1/* sv.c
79072805 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
83706693
RGS
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall
5 * and others
79072805
LW
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 *
4ac71550
TC
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/*
645c22ef
DM
20 *
21 *
5e045b90
AMS
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.
79072805
LW
28 */
29
30#include "EXTERN.h"
864dbfa3 31#define PERL_IN_SV_C
79072805 32#include "perl.h"
d2f185dc 33#include "regcomp.h"
79072805 34
07208e09 35#ifndef HAS_C99
4b2d6671 36# if __STDC_VERSION__ >= 199901L && !defined(VMS)
07208e09
CS
37# define HAS_C99 1
38# endif
39#endif
40#if HAS_C99
41# include <stdint.h>
42#endif
43
51371543 44#define FCALL *f
2c5424a7 45
2f8ed50e
OS
46#ifdef __Lynx__
47/* Missing proto on LynxOS */
48 char *gconvert(double, int, int, char *);
49#endif
50
e23c8137 51#ifdef PERL_UTF8_CACHE_ASSERT
ab455f60 52/* if adding more checks watch out for the following tests:
e23c8137
JH
53 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
54 * lib/utf8.t lib/Unicode/Collate/t/index.t
55 * --jhi
56 */
6f207bd3 57# define ASSERT_UTF8_CACHE(cache) \
ab455f60
NC
58 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
59 assert((cache)[2] <= (cache)[3]); \
60 assert((cache)[3] <= (cache)[1]);} \
61 } STMT_END
e23c8137 62#else
6f207bd3 63# define ASSERT_UTF8_CACHE(cache) NOOP
e23c8137
JH
64#endif
65
f8c7b90f 66#ifdef PERL_OLD_COPY_ON_WRITE
765f542d 67#define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
607fa7f2 68#define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
b5ccf5f2 69/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
765f542d 70 on-write. */
765f542d 71#endif
645c22ef
DM
72
73/* ============================================================================
74
75=head1 Allocation and deallocation of SVs.
76
d2a0f284
JC
77An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
78sv, av, hv...) contains type and reference count information, and for
79many types, a pointer to the body (struct xrv, xpv, xpviv...), which
80contains fields specific to each type. Some types store all they need
81in the head, so don't have a body.
82
83In all but the most memory-paranoid configuations (ex: PURIFY), heads
84and bodies are allocated out of arenas, which by default are
85approximately 4K chunks of memory parcelled up into N heads or bodies.
93e68bfb
JC
86Sv-bodies are allocated by their sv-type, guaranteeing size
87consistency needed to allocate safely from arrays.
88
d2a0f284
JC
89For SV-heads, the first slot in each arena is reserved, and holds a
90link to the next arena, some flags, and a note of the number of slots.
91Snaked through each arena chain is a linked list of free items; when
92this becomes empty, an extra arena is allocated and divided up into N
93items which are threaded into the free list.
94
95SV-bodies are similar, but they use arena-sets by default, which
96separate the link and info from the arena itself, and reclaim the 1st
97slot in the arena. SV-bodies are further described later.
645c22ef
DM
98
99The following global variables are associated with arenas:
100
101 PL_sv_arenaroot pointer to list of SV arenas
102 PL_sv_root pointer to list of free SV structures
103
d2a0f284
JC
104 PL_body_arenas head of linked-list of body arenas
105 PL_body_roots[] array of pointers to list of free bodies of svtype
106 arrays are indexed by the svtype needed
93e68bfb 107
d2a0f284
JC
108A few special SV heads are not allocated from an arena, but are
109instead directly created in the interpreter structure, eg PL_sv_undef.
93e68bfb
JC
110The size of arenas can be changed from the default by setting
111PERL_ARENA_SIZE appropriately at compile time.
645c22ef
DM
112
113The SV arena serves the secondary purpose of allowing still-live SVs
114to be located and destroyed during final cleanup.
115
116At the lowest level, the macros new_SV() and del_SV() grab and free
117an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
118to return the SV to the free list with error checking.) new_SV() calls
119more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
120SVs in the free list have their SvTYPE field set to all ones.
121
ff276b08 122At the time of very final cleanup, sv_free_arenas() is called from
645c22ef 123perl_destruct() to physically free all the arenas allocated since the
6a93a7e5 124start of the interpreter.
645c22ef 125
645c22ef
DM
126The function visit() scans the SV arenas list, and calls a specified
127function for each SV it finds which is still live - ie which has an SvTYPE
128other than all 1's, and a non-zero SvREFCNT. visit() is used by the
129following functions (specified as [function that calls visit()] / [function
130called by visit() for each SV]):
131
132 sv_report_used() / do_report_used()
f2524eef 133 dump all remaining SVs (debugging aid)
645c22ef 134
e4487e9b
DM
135 sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
136 do_clean_named_io_objs()
645c22ef 137 Attempt to free all objects pointed to by RVs,
c3b19b5c 138 and try to do the same for all objects indirectly
645c22ef
DM
139 referenced by typeglobs too. Called once from
140 perl_destruct(), prior to calling sv_clean_all()
141 below.
142
143 sv_clean_all() / do_clean_all()
144 SvREFCNT_dec(sv) each remaining SV, possibly
145 triggering an sv_free(). It also sets the
146 SVf_BREAK flag on the SV to indicate that the
147 refcnt has been artificially lowered, and thus
148 stopping sv_free() from giving spurious warnings
149 about SVs which unexpectedly have a refcnt
150 of zero. called repeatedly from perl_destruct()
151 until there are no SVs left.
152
93e68bfb 153=head2 Arena allocator API Summary
645c22ef
DM
154
155Private API to rest of sv.c
156
157 new_SV(), del_SV(),
158
df0f0429 159 new_XPVNV(), del_XPVGV(),
645c22ef
DM
160 etc
161
162Public API:
163
8cf8f3d1 164 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
645c22ef 165
645c22ef
DM
166=cut
167
3e8320cc 168 * ========================================================================= */
645c22ef 169
4561caa4
CS
170/*
171 * "A time to plant, and a time to uproot what was planted..."
172 */
173
d7a2c63c
MHM
174#ifdef PERL_MEM_LOG
175# define MEM_LOG_NEW_SV(sv, file, line, func) \
176 Perl_mem_log_new_sv(sv, file, line, func)
177# define MEM_LOG_DEL_SV(sv, file, line, func) \
178 Perl_mem_log_del_sv(sv, file, line, func)
179#else
180# define MEM_LOG_NEW_SV(sv, file, line, func) NOOP
181# define MEM_LOG_DEL_SV(sv, file, line, func) NOOP
182#endif
183
fd0854ff 184#ifdef DEBUG_LEAKING_SCALARS
22162ca8 185# define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
d7a2c63c
MHM
186# define DEBUG_SV_SERIAL(sv) \
187 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
188 PTR2UV(sv), (long)(sv)->sv_debug_serial))
fd0854ff
DM
189#else
190# define FREE_SV_DEBUG_FILE(sv)
d7a2c63c 191# define DEBUG_SV_SERIAL(sv) NOOP
fd0854ff
DM
192#endif
193
48614a46
NC
194#ifdef PERL_POISON
195# define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
daba3364 196# define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = MUTABLE_SV((val))
48614a46
NC
197/* Whilst I'd love to do this, it seems that things like to check on
198 unreferenced scalars
7e337ee0 199# define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
48614a46 200*/
7e337ee0
JH
201# define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
202 PoisonNew(&SvREFCNT(sv), 1, U32)
48614a46
NC
203#else
204# define SvARENA_CHAIN(sv) SvANY(sv)
3eef1deb 205# define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
48614a46
NC
206# define POSION_SV_HEAD(sv)
207#endif
208
990198f0
DM
209/* Mark an SV head as unused, and add to free list.
210 *
211 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
212 * its refcount artificially decremented during global destruction, so
213 * there may be dangling pointers to it. The last thing we want in that
214 * case is for it to be reused. */
215
053fc874
GS
216#define plant_SV(p) \
217 STMT_START { \
990198f0 218 const U32 old_flags = SvFLAGS(p); \
d7a2c63c
MHM
219 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
220 DEBUG_SV_SERIAL(p); \
fd0854ff 221 FREE_SV_DEBUG_FILE(p); \
48614a46 222 POSION_SV_HEAD(p); \
053fc874 223 SvFLAGS(p) = SVTYPEMASK; \
990198f0 224 if (!(old_flags & SVf_BREAK)) { \
3eef1deb 225 SvARENA_CHAIN_SET(p, PL_sv_root); \
990198f0
DM
226 PL_sv_root = (p); \
227 } \
053fc874
GS
228 --PL_sv_count; \
229 } STMT_END
a0d0e21e 230
053fc874
GS
231#define uproot_SV(p) \
232 STMT_START { \
233 (p) = PL_sv_root; \
daba3364 234 PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p)); \
053fc874
GS
235 ++PL_sv_count; \
236 } STMT_END
237
645c22ef 238
cac9b346
NC
239/* make some more SVs by adding another arena */
240
cac9b346
NC
241STATIC SV*
242S_more_sv(pTHX)
243{
97aff369 244 dVAR;
cac9b346 245 SV* sv;
9a87bd09
NC
246 char *chunk; /* must use New here to match call to */
247 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
248 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
cac9b346
NC
249 uproot_SV(sv);
250 return sv;
251}
252
645c22ef
DM
253/* new_SV(): return a new, empty SV head */
254
eba0f806
DM
255#ifdef DEBUG_LEAKING_SCALARS
256/* provide a real function for a debugger to play with */
257STATIC SV*
d7a2c63c 258S_new_SV(pTHX_ const char *file, int line, const char *func)
eba0f806
DM
259{
260 SV* sv;
261
eba0f806
DM
262 if (PL_sv_root)
263 uproot_SV(sv);
264 else
cac9b346 265 sv = S_more_sv(aTHX);
eba0f806
DM
266 SvANY(sv) = 0;
267 SvREFCNT(sv) = 1;
268 SvFLAGS(sv) = 0;
fd0854ff 269 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
e385c3bf
DM
270 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
271 ? PL_parser->copline
272 : PL_curcop
f24aceb1
DM
273 ? CopLINE(PL_curcop)
274 : 0
e385c3bf 275 );
fd0854ff 276 sv->sv_debug_inpad = 0;
cd676548 277 sv->sv_debug_parent = NULL;
fd0854ff 278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
d7a2c63c
MHM
279
280 sv->sv_debug_serial = PL_sv_serial++;
281
282 MEM_LOG_NEW_SV(sv, file, line, func);
283 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
284 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
285
eba0f806
DM
286 return sv;
287}
d7a2c63c 288# define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
eba0f806
DM
289
290#else
291# define new_SV(p) \
053fc874 292 STMT_START { \
053fc874
GS
293 if (PL_sv_root) \
294 uproot_SV(p); \
295 else \
cac9b346 296 (p) = S_more_sv(aTHX); \
053fc874
GS
297 SvANY(p) = 0; \
298 SvREFCNT(p) = 1; \
299 SvFLAGS(p) = 0; \
d7a2c63c 300 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
053fc874 301 } STMT_END
eba0f806 302#endif
463ee0b2 303
645c22ef
DM
304
305/* del_SV(): return an empty SV head to the free list */
306
a0d0e21e 307#ifdef DEBUGGING
4561caa4 308
053fc874
GS
309#define del_SV(p) \
310 STMT_START { \
aea4f609 311 if (DEBUG_D_TEST) \
053fc874
GS
312 del_sv(p); \
313 else \
314 plant_SV(p); \
053fc874 315 } STMT_END
a0d0e21e 316
76e3520e 317STATIC void
cea2e8a9 318S_del_sv(pTHX_ SV *p)
463ee0b2 319{
97aff369 320 dVAR;
7918f24d
NC
321
322 PERL_ARGS_ASSERT_DEL_SV;
323
aea4f609 324 if (DEBUG_D_TEST) {
4633a7c4 325 SV* sva;
a3b680e6 326 bool ok = 0;
daba3364 327 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
53c1dcc0
AL
328 const SV * const sv = sva + 1;
329 const SV * const svend = &sva[SvREFCNT(sva)];
c0ff570e 330 if (p >= sv && p < svend) {
a0d0e21e 331 ok = 1;
c0ff570e
NC
332 break;
333 }
a0d0e21e
LW
334 }
335 if (!ok) {
9b387841
NC
336 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
337 "Attempt to free non-arena SV: 0x%"UVxf
338 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
a0d0e21e
LW
339 return;
340 }
341 }
4561caa4 342 plant_SV(p);
463ee0b2 343}
a0d0e21e 344
4561caa4
CS
345#else /* ! DEBUGGING */
346
347#define del_SV(p) plant_SV(p)
348
349#endif /* DEBUGGING */
463ee0b2 350
645c22ef
DM
351
352/*
ccfc67b7
JH
353=head1 SV Manipulation Functions
354
645c22ef
DM
355=for apidoc sv_add_arena
356
357Given a chunk of memory, link it to the head of the list of arenas,
358and split it into a list of free SVs.
359
360=cut
361*/
362
d2bd4e7f
NC
363static void
364S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
463ee0b2 365{
97aff369 366 dVAR;
daba3364 367 SV *const sva = MUTABLE_SV(ptr);
463ee0b2
LW
368 register SV* sv;
369 register SV* svend;
4633a7c4 370
7918f24d
NC
371 PERL_ARGS_ASSERT_SV_ADD_ARENA;
372
4633a7c4 373 /* The first SV in an arena isn't an SV. */
3280af22 374 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
4633a7c4
LW
375 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
376 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
377
3280af22
NIS
378 PL_sv_arenaroot = sva;
379 PL_sv_root = sva + 1;
4633a7c4
LW
380
381 svend = &sva[SvREFCNT(sva) - 1];
382 sv = sva + 1;
463ee0b2 383 while (sv < svend) {
3eef1deb 384 SvARENA_CHAIN_SET(sv, (sv + 1));
03e36789 385#ifdef DEBUGGING
978b032e 386 SvREFCNT(sv) = 0;
03e36789 387#endif
4b69cbe3 388 /* Must always set typemask because it's always checked in on cleanup
03e36789 389 when the arenas are walked looking for objects. */
8990e307 390 SvFLAGS(sv) = SVTYPEMASK;
463ee0b2
LW
391 sv++;
392 }
3eef1deb 393 SvARENA_CHAIN_SET(sv, 0);
03e36789
NC
394#ifdef DEBUGGING
395 SvREFCNT(sv) = 0;
396#endif
4633a7c4
LW
397 SvFLAGS(sv) = SVTYPEMASK;
398}
399
055972dc
DM
400/* visit(): call the named function for each non-free SV in the arenas
401 * whose flags field matches the flags/mask args. */
645c22ef 402
5226ed68 403STATIC I32
de37a194 404S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
8990e307 405{
97aff369 406 dVAR;
4633a7c4 407 SV* sva;
5226ed68 408 I32 visited = 0;
8990e307 409
7918f24d
NC
410 PERL_ARGS_ASSERT_VISIT;
411
daba3364 412 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
53c1dcc0 413 register const SV * const svend = &sva[SvREFCNT(sva)];
a3b680e6 414 register SV* sv;
4561caa4 415 for (sv = sva + 1; sv < svend; ++sv) {
055972dc
DM
416 if (SvTYPE(sv) != SVTYPEMASK
417 && (sv->sv_flags & mask) == flags
418 && SvREFCNT(sv))
419 {
acfe0abc 420 (FCALL)(aTHX_ sv);
5226ed68
JH
421 ++visited;
422 }
8990e307
LW
423 }
424 }
5226ed68 425 return visited;
8990e307
LW
426}
427
758a08c3
JH
428#ifdef DEBUGGING
429
645c22ef
DM
430/* called by sv_report_used() for each live SV */
431
432static void
5fa45a31 433do_report_used(pTHX_ SV *const sv)
645c22ef
DM
434{
435 if (SvTYPE(sv) != SVTYPEMASK) {
436 PerlIO_printf(Perl_debug_log, "****\n");
437 sv_dump(sv);
438 }
439}
758a08c3 440#endif
645c22ef
DM
441
442/*
443=for apidoc sv_report_used
444
445Dump the contents of all SVs not yet freed. (Debugging aid).
446
447=cut
448*/
449
8990e307 450void
864dbfa3 451Perl_sv_report_used(pTHX)
4561caa4 452{
ff270d3a 453#ifdef DEBUGGING
055972dc 454 visit(do_report_used, 0, 0);
96a5add6
AL
455#else
456 PERL_UNUSED_CONTEXT;
ff270d3a 457#endif
4561caa4
CS
458}
459
645c22ef
DM
460/* called by sv_clean_objs() for each live SV */
461
462static void
de37a194 463do_clean_objs(pTHX_ SV *const ref)
645c22ef 464{
97aff369 465 dVAR;
ea724faa
NC
466 assert (SvROK(ref));
467 {
823a54a3
AL
468 SV * const target = SvRV(ref);
469 if (SvOBJECT(target)) {
470 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
471 if (SvWEAKREF(ref)) {
472 sv_del_backref(target, ref);
473 SvWEAKREF_off(ref);
474 SvRV_set(ref, NULL);
475 } else {
476 SvROK_off(ref);
477 SvRV_set(ref, NULL);
478 SvREFCNT_dec(target);
479 }
645c22ef
DM
480 }
481 }
482
483 /* XXX Might want to check arrays, etc. */
484}
485
645c22ef 486
e4487e9b
DM
487/* clear any slots in a GV which hold objects - except IO;
488 * called by sv_clean_objs() for each live GV */
489
645c22ef 490static void
f30de749 491do_clean_named_objs(pTHX_ SV *const sv)
645c22ef 492{
97aff369 493 dVAR;
57ef47cc 494 SV *obj;
ea724faa 495 assert(SvTYPE(sv) == SVt_PVGV);
d011219a 496 assert(isGV_with_GP(sv));
57ef47cc
DM
497 if (!GvGP(sv))
498 return;
499
500 /* freeing GP entries may indirectly free the current GV;
501 * hold onto it while we mess with the GP slots */
502 SvREFCNT_inc(sv);
503
504 if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
505 DEBUG_D((PerlIO_printf(Perl_debug_log,
506 "Cleaning named glob SV object:\n "), sv_dump(obj)));
507 GvSV(sv) = NULL;
508 SvREFCNT_dec(obj);
509 }
510 if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
511 DEBUG_D((PerlIO_printf(Perl_debug_log,
512 "Cleaning named glob AV object:\n "), sv_dump(obj)));
513 GvAV(sv) = NULL;
514 SvREFCNT_dec(obj);
515 }
516 if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
517 DEBUG_D((PerlIO_printf(Perl_debug_log,
518 "Cleaning named glob HV object:\n "), sv_dump(obj)));
519 GvHV(sv) = NULL;
520 SvREFCNT_dec(obj);
521 }
522 if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
523 DEBUG_D((PerlIO_printf(Perl_debug_log,
524 "Cleaning named glob CV object:\n "), sv_dump(obj)));
525 GvCV(sv) = NULL;
526 SvREFCNT_dec(obj);
527 }
e4487e9b
DM
528 SvREFCNT_dec(sv); /* undo the inc above */
529}
530
68b590d9 531/* clear any IO slots in a GV which hold objects (except stderr, defout);
e4487e9b
DM
532 * called by sv_clean_objs() for each live GV */
533
534static void
535do_clean_named_io_objs(pTHX_ SV *const sv)
536{
537 dVAR;
538 SV *obj;
539 assert(SvTYPE(sv) == SVt_PVGV);
540 assert(isGV_with_GP(sv));
68b590d9 541 if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
e4487e9b
DM
542 return;
543
544 SvREFCNT_inc(sv);
57ef47cc
DM
545 if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
546 DEBUG_D((PerlIO_printf(Perl_debug_log,
547 "Cleaning named glob IO object:\n "), sv_dump(obj)));
548 GvIOp(sv) = NULL;
549 SvREFCNT_dec(obj);
645c22ef 550 }
57ef47cc 551 SvREFCNT_dec(sv); /* undo the inc above */
645c22ef 552}
645c22ef 553
4155e4fe
FC
554/* Void wrapper to pass to visit() */
555static void
556do_curse(pTHX_ SV * const sv) {
557 if ((PL_stderrgv && GvGP(PL_stderrgv) && GvIO(PL_stderrgv) == sv)
558 || (PL_defoutgv && GvGP(PL_defoutgv) && GvIO(PL_defoutgv) == sv))
559 return;
560 (void)curse(sv, 0);
561}
562
645c22ef
DM
563/*
564=for apidoc sv_clean_objs
565
566Attempt to destroy all objects not yet freed
567
568=cut
569*/
570
4561caa4 571void
864dbfa3 572Perl_sv_clean_objs(pTHX)
4561caa4 573{
97aff369 574 dVAR;
68b590d9 575 GV *olddef, *olderr;
3280af22 576 PL_in_clean_objs = TRUE;
055972dc 577 visit(do_clean_objs, SVf_ROK, SVf_ROK);
e4487e9b
DM
578 /* Some barnacles may yet remain, clinging to typeglobs.
579 * Run the non-IO destructors first: they may want to output
580 * error messages, close files etc */
d011219a 581 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
e4487e9b 582 visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
4155e4fe
FC
583 /* And if there are some very tenacious barnacles clinging to arrays,
584 closures, or what have you.... */
585 visit(do_curse, SVs_OBJECT, SVs_OBJECT);
68b590d9
DM
586 olddef = PL_defoutgv;
587 PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
588 if (olddef && isGV_with_GP(olddef))
589 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
590 olderr = PL_stderrgv;
591 PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
592 if (olderr && isGV_with_GP(olderr))
593 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
594 SvREFCNT_dec(olddef);
3280af22 595 PL_in_clean_objs = FALSE;
4561caa4
CS
596}
597
645c22ef
DM
598/* called by sv_clean_all() for each live SV */
599
600static void
de37a194 601do_clean_all(pTHX_ SV *const sv)
645c22ef 602{
97aff369 603 dVAR;
daba3364 604 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
cddfcddc 605 /* don't clean pid table and strtab */
d17ea597 606 return;
cddfcddc 607 }
645c22ef
DM
608 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
609 SvFLAGS(sv) |= SVf_BREAK;
610 SvREFCNT_dec(sv);
611}
612
613/*
614=for apidoc sv_clean_all
615
616Decrement the refcnt of each remaining SV, possibly triggering a
617cleanup. This function may have to be called multiple times to free
ff276b08 618SVs which are in complex self-referential hierarchies.
645c22ef
DM
619
620=cut
621*/
622
5226ed68 623I32
864dbfa3 624Perl_sv_clean_all(pTHX)
8990e307 625{
97aff369 626 dVAR;
5226ed68 627 I32 cleaned;
3280af22 628 PL_in_clean_all = TRUE;
055972dc 629 cleaned = visit(do_clean_all, 0,0);
5226ed68 630 return cleaned;
8990e307 631}
463ee0b2 632
5e258f8c
JC
633/*
634 ARENASETS: a meta-arena implementation which separates arena-info
635 into struct arena_set, which contains an array of struct
636 arena_descs, each holding info for a single arena. By separating
637 the meta-info from the arena, we recover the 1st slot, formerly
638 borrowed for list management. The arena_set is about the size of an
39244528 639 arena, avoiding the needless malloc overhead of a naive linked-list.
5e258f8c
JC
640
641 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
642 memory in the last arena-set (1/2 on average). In trade, we get
643 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
d2a0f284 644 smaller types). The recovery of the wasted space allows use of
e15dad31
JC
645 small arenas for large, rare body types, by changing array* fields
646 in body_details_by_type[] below.
5e258f8c 647*/
5e258f8c 648struct arena_desc {
398c677b
NC
649 char *arena; /* the raw storage, allocated aligned */
650 size_t size; /* its size ~4k typ */
e5973ed5 651 svtype utype; /* bodytype stored in arena */
5e258f8c
JC
652};
653
e6148039
NC
654struct arena_set;
655
656/* Get the maximum number of elements in set[] such that struct arena_set
e15dad31 657 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
e6148039
NC
658 therefore likely to be 1 aligned memory page. */
659
660#define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
661 - 2 * sizeof(int)) / sizeof (struct arena_desc))
5e258f8c
JC
662
663struct arena_set {
664 struct arena_set* next;
0a848332
NC
665 unsigned int set_size; /* ie ARENAS_PER_SET */
666 unsigned int curr; /* index of next available arena-desc */
5e258f8c
JC
667 struct arena_desc set[ARENAS_PER_SET];
668};
669
645c22ef
DM
670/*
671=for apidoc sv_free_arenas
672
673Deallocate the memory used by all arenas. Note that all the individual SV
674heads and bodies within the arenas must already have been freed.
675
676=cut
677*/
4633a7c4 678void
864dbfa3 679Perl_sv_free_arenas(pTHX)
4633a7c4 680{
97aff369 681 dVAR;
4633a7c4
LW
682 SV* sva;
683 SV* svanext;
0a848332 684 unsigned int i;
4633a7c4
LW
685
686 /* Free arenas here, but be careful about fake ones. (We assume
687 contiguity of the fake ones with the corresponding real ones.) */
688
3280af22 689 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
daba3364 690 svanext = MUTABLE_SV(SvANY(sva));
4633a7c4 691 while (svanext && SvFAKE(svanext))
daba3364 692 svanext = MUTABLE_SV(SvANY(svanext));
4633a7c4
LW
693
694 if (!SvFAKE(sva))
1df70142 695 Safefree(sva);
4633a7c4 696 }
93e68bfb 697
5e258f8c 698 {
0a848332
NC
699 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
700
701 while (aroot) {
702 struct arena_set *current = aroot;
703 i = aroot->curr;
704 while (i--) {
5e258f8c
JC
705 assert(aroot->set[i].arena);
706 Safefree(aroot->set[i].arena);
707 }
0a848332
NC
708 aroot = aroot->next;
709 Safefree(current);
5e258f8c
JC
710 }
711 }
dc8220bf 712 PL_body_arenas = 0;
fdda85ca 713
0a848332
NC
714 i = PERL_ARENA_ROOTS_SIZE;
715 while (i--)
93e68bfb 716 PL_body_roots[i] = 0;
93e68bfb 717
3280af22
NIS
718 PL_sv_arenaroot = 0;
719 PL_sv_root = 0;
4633a7c4
LW
720}
721
bd81e77b
NC
722/*
723 Here are mid-level routines that manage the allocation of bodies out
724 of the various arenas. There are 5 kinds of arenas:
29489e7c 725
bd81e77b
NC
726 1. SV-head arenas, which are discussed and handled above
727 2. regular body arenas
728 3. arenas for reduced-size bodies
729 4. Hash-Entry arenas
29489e7c 730
bd81e77b
NC
731 Arena types 2 & 3 are chained by body-type off an array of
732 arena-root pointers, which is indexed by svtype. Some of the
733 larger/less used body types are malloced singly, since a large
734 unused block of them is wasteful. Also, several svtypes dont have
735 bodies; the data fits into the sv-head itself. The arena-root
736 pointer thus has a few unused root-pointers (which may be hijacked
737 later for arena types 4,5)
29489e7c 738
bd81e77b
NC
739 3 differs from 2 as an optimization; some body types have several
740 unused fields in the front of the structure (which are kept in-place
741 for consistency). These bodies can be allocated in smaller chunks,
742 because the leading fields arent accessed. Pointers to such bodies
743 are decremented to point at the unused 'ghost' memory, knowing that
744 the pointers are used with offsets to the real memory.
29489e7c 745
d2a0f284
JC
746
747=head1 SV-Body Allocation
748
749Allocation of SV-bodies is similar to SV-heads, differing as follows;
750the allocation mechanism is used for many body types, so is somewhat
751more complicated, it uses arena-sets, and has no need for still-live
752SV detection.
753
754At the outermost level, (new|del)_X*V macros return bodies of the
755appropriate type. These macros call either (new|del)_body_type or
756(new|del)_body_allocated macro pairs, depending on specifics of the
757type. Most body types use the former pair, the latter pair is used to
758allocate body types with "ghost fields".
759
760"ghost fields" are fields that are unused in certain types, and
69ba284b 761consequently don't need to actually exist. They are declared because
d2a0f284
JC
762they're part of a "base type", which allows use of functions as
763methods. The simplest examples are AVs and HVs, 2 aggregate types
764which don't use the fields which support SCALAR semantics.
765
69ba284b 766For these types, the arenas are carved up into appropriately sized
d2a0f284
JC
767chunks, we thus avoid wasted memory for those unaccessed members.
768When bodies are allocated, we adjust the pointer back in memory by the
69ba284b 769size of the part not allocated, so it's as if we allocated the full
d2a0f284
JC
770structure. (But things will all go boom if you write to the part that
771is "not there", because you'll be overwriting the last members of the
772preceding structure in memory.)
773
69ba284b
NC
774We calculate the correction using the STRUCT_OFFSET macro on the first
775member present. If the allocated structure is smaller (no initial NV
776actually allocated) then the net effect is to subtract the size of the NV
777from the pointer, to return a new pointer as if an initial NV were actually
778allocated. (We were using structures named *_allocated for this, but
779this turned out to be a subtle bug, because a structure without an NV
780could have a lower alignment constraint, but the compiler is allowed to
781optimised accesses based on the alignment constraint of the actual pointer
782to the full structure, for example, using a single 64 bit load instruction
783because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
d2a0f284
JC
784
785This is the same trick as was used for NV and IV bodies. Ironically it
786doesn't need to be used for NV bodies any more, because NV is now at
787the start of the structure. IV bodies don't need it either, because
788they are no longer allocated.
789
790In turn, the new_body_* allocators call S_new_body(), which invokes
791new_body_inline macro, which takes a lock, and takes a body off the
1e30fcd5 792linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
d2a0f284
JC
793necessary to refresh an empty list. Then the lock is released, and
794the body is returned.
795
99816f8d 796Perl_more_bodies allocates a new arena, and carves it up into an array of N
d2a0f284
JC
797bodies, which it strings into a linked list. It looks up arena-size
798and body-size from the body_details table described below, thus
799supporting the multiple body-types.
800
801If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
802the (new|del)_X*V macros are mapped directly to malloc/free.
803
d2a0f284
JC
804For each sv-type, struct body_details bodies_by_type[] carries
805parameters which control these aspects of SV handling:
806
807Arena_size determines whether arenas are used for this body type, and if
808so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
809zero, forcing individual mallocs and frees.
810
811Body_size determines how big a body is, and therefore how many fit into
812each arena. Offset carries the body-pointer adjustment needed for
69ba284b 813"ghost fields", and is used in *_allocated macros.
d2a0f284
JC
814
815But its main purpose is to parameterize info needed in
816Perl_sv_upgrade(). The info here dramatically simplifies the function
69ba284b 817vs the implementation in 5.8.8, making it table-driven. All fields
d2a0f284
JC
818are used for this, except for arena_size.
819
820For the sv-types that have no bodies, arenas are not used, so those
821PL_body_roots[sv_type] are unused, and can be overloaded. In
822something of a special case, SVt_NULL is borrowed for HE arenas;
c6f8b1d0 823PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
d2a0f284 824bodies_by_type[SVt_NULL] slot is not used, as the table is not
c6f8b1d0 825available in hv.c.
d2a0f284 826
29489e7c
DM
827*/
828
bd81e77b 829struct body_details {
0fb58b32 830 U8 body_size; /* Size to allocate */
10666ae3 831 U8 copy; /* Size of structure to copy (may be shorter) */
0fb58b32 832 U8 offset;
10666ae3
NC
833 unsigned int type : 4; /* We have space for a sanity check. */
834 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
835 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
836 unsigned int arena : 1; /* Allocated from an arena */
837 size_t arena_size; /* Size of arena to allocate */
bd81e77b 838};
29489e7c 839
bd81e77b
NC
840#define HADNV FALSE
841#define NONV TRUE
29489e7c 842
d2a0f284 843
bd81e77b
NC
844#ifdef PURIFY
845/* With -DPURFIY we allocate everything directly, and don't use arenas.
846 This seems a rather elegant way to simplify some of the code below. */
847#define HASARENA FALSE
848#else
849#define HASARENA TRUE
850#endif
851#define NOARENA FALSE
29489e7c 852
d2a0f284
JC
853/* Size the arenas to exactly fit a given number of bodies. A count
854 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
855 simplifying the default. If count > 0, the arena is sized to fit
856 only that many bodies, allowing arenas to be used for large, rare
857 bodies (XPVFM, XPVIO) without undue waste. The arena size is
858 limited by PERL_ARENA_SIZE, so we can safely oversize the
859 declarations.
860 */
95db5f15
MB
861#define FIT_ARENA0(body_size) \
862 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
863#define FIT_ARENAn(count,body_size) \
864 ( count * body_size <= PERL_ARENA_SIZE) \
865 ? count * body_size \
866 : FIT_ARENA0 (body_size)
867#define FIT_ARENA(count,body_size) \
868 count \
869 ? FIT_ARENAn (count, body_size) \
870 : FIT_ARENA0 (body_size)
d2a0f284 871
bd81e77b
NC
872/* Calculate the length to copy. Specifically work out the length less any
873 final padding the compiler needed to add. See the comment in sv_upgrade
874 for why copying the padding proved to be a bug. */
29489e7c 875
bd81e77b
NC
876#define copy_length(type, last_member) \
877 STRUCT_OFFSET(type, last_member) \
daba3364 878 + sizeof (((type*)SvANY((const SV *)0))->last_member)
29489e7c 879
bd81e77b 880static const struct body_details bodies_by_type[] = {
829cd18a
NC
881 /* HEs use this offset for their arena. */
882 { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
d2a0f284 883
1cb9cd50 884 /* The bind placeholder pretends to be an RV for now.
c6f8b1d0 885 Also it's marked as "can't upgrade" to stop anyone using it before it's
1cb9cd50
NC
886 implemented. */
887 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
888
db93c0c4
NC
889 /* IVs are in the head, so the allocation size is 0. */
890 { 0,
d2a0f284 891 sizeof(IV), /* This is used to copy out the IV body. */
10666ae3 892 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
db93c0c4 893 NOARENA /* IVS don't need an arena */, 0
d2a0f284
JC
894 },
895
bd81e77b 896 /* 8 bytes on most ILP32 with IEEE doubles */
6e128786
NC
897 { sizeof(NV), sizeof(NV),
898 STRUCT_OFFSET(XPVNV, xnv_u),
899 SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
d2a0f284 900
bd81e77b 901 /* 8 bytes on most ILP32 with IEEE doubles */
bc337e5c 902 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
889d28b2
NC
903 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
904 + STRUCT_OFFSET(XPV, xpv_cur),
69ba284b 905 SVt_PV, FALSE, NONV, HASARENA,
889d28b2 906 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
d2a0f284 907
bd81e77b 908 /* 12 */
bc337e5c 909 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
889d28b2
NC
910 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
911 + STRUCT_OFFSET(XPV, xpv_cur),
912 SVt_PVIV, FALSE, NONV, HASARENA,
913 FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
d2a0f284 914
889d28b2 915 /* 20 */
bc337e5c 916 { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
889d28b2
NC
917 copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
918 + STRUCT_OFFSET(XPV, xpv_cur),
919 SVt_PVNV, FALSE, HADNV, HASARENA,
920 FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
d2a0f284 921
bd81e77b 922 /* 28 */
6e128786 923 { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
d2a0f284 924 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
4df7f6af 925
288b8c02 926 /* something big */
601dfd0a
NC
927 { sizeof(regexp),
928 sizeof(regexp),
929 0,
08e44740 930 SVt_REGEXP, FALSE, NONV, HASARENA,
eaeb1e7f 931 FIT_ARENA(0, sizeof(regexp))
5c35adbb 932 },
4df7f6af 933
bd81e77b 934 /* 48 */
10666ae3 935 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
d2a0f284
JC
936 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
937
bd81e77b 938 /* 64 */
10666ae3 939 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
d2a0f284
JC
940 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941
601dfd0a 942 { sizeof(XPVAV),
4f7003f5 943 copy_length(XPVAV, xav_alloc),
601dfd0a 944 0,
69ba284b 945 SVt_PVAV, TRUE, NONV, HASARENA,
601dfd0a 946 FIT_ARENA(0, sizeof(XPVAV)) },
d2a0f284 947
601dfd0a 948 { sizeof(XPVHV),
359164a0 949 copy_length(XPVHV, xhv_max),
601dfd0a 950 0,
69ba284b 951 SVt_PVHV, TRUE, NONV, HASARENA,
601dfd0a 952 FIT_ARENA(0, sizeof(XPVHV)) },
d2a0f284 953
c84c4652 954 /* 56 */
601dfd0a
NC
955 { sizeof(XPVCV),
956 sizeof(XPVCV),
957 0,
69ba284b 958 SVt_PVCV, TRUE, NONV, HASARENA,
601dfd0a 959 FIT_ARENA(0, sizeof(XPVCV)) },
69ba284b 960
601dfd0a
NC
961 { sizeof(XPVFM),
962 sizeof(XPVFM),
963 0,
69ba284b 964 SVt_PVFM, TRUE, NONV, NOARENA,
601dfd0a 965 FIT_ARENA(20, sizeof(XPVFM)) },
d2a0f284
JC
966
967 /* XPVIO is 84 bytes, fits 48x */
601dfd0a
NC
968 { sizeof(XPVIO),
969 sizeof(XPVIO),
970 0,
b6f60916 971 SVt_PVIO, TRUE, NONV, HASARENA,
601dfd0a 972 FIT_ARENA(24, sizeof(XPVIO)) },
bd81e77b 973};
29489e7c 974
bd81e77b 975#define new_body_allocated(sv_type) \
d2a0f284 976 (void *)((char *)S_new_body(aTHX_ sv_type) \
bd81e77b 977 - bodies_by_type[sv_type].offset)
29489e7c 978
26359cfa
NC
979/* return a thing to the free list */
980
981#define del_body(thing, root) \
982 STMT_START { \
983 void ** const thing_copy = (void **)thing; \
984 *thing_copy = *root; \
985 *root = (void*)thing_copy; \
986 } STMT_END
29489e7c 987
bd81e77b 988#ifdef PURIFY
29489e7c 989
beeec492
NC
990#define new_XNV() safemalloc(sizeof(XPVNV))
991#define new_XPVNV() safemalloc(sizeof(XPVNV))
992#define new_XPVMG() safemalloc(sizeof(XPVMG))
29489e7c 993
beeec492 994#define del_XPVGV(p) safefree(p)
29489e7c 995
bd81e77b 996#else /* !PURIFY */
29489e7c 997
65ac1738 998#define new_XNV() new_body_allocated(SVt_NV)
65ac1738 999#define new_XPVNV() new_body_allocated(SVt_PVNV)
65ac1738 1000#define new_XPVMG() new_body_allocated(SVt_PVMG)
645c22ef 1001
26359cfa
NC
1002#define del_XPVGV(p) del_body(p + bodies_by_type[SVt_PVGV].offset, \
1003 &PL_body_roots[SVt_PVGV])
1d7c1841 1004
bd81e77b 1005#endif /* PURIFY */
93e68bfb 1006
bd81e77b 1007/* no arena for you! */
93e68bfb 1008
bd81e77b 1009#define new_NOARENA(details) \
beeec492 1010 safemalloc((details)->body_size + (details)->offset)
bd81e77b 1011#define new_NOARENAZ(details) \
beeec492 1012 safecalloc((details)->body_size + (details)->offset, 1)
d2a0f284 1013
1e30fcd5
NC
1014void *
1015Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1016 const size_t arena_size)
d2a0f284
JC
1017{
1018 dVAR;
1019 void ** const root = &PL_body_roots[sv_type];
99816f8d
NC
1020 struct arena_desc *adesc;
1021 struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1022 unsigned int curr;
d2a0f284
JC
1023 char *start;
1024 const char *end;
02982131 1025 const size_t good_arena_size = Perl_malloc_good_size(arena_size);
0b2d3faa 1026#if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
23e9d66c
NC
1027 static bool done_sanity_check;
1028
0b2d3faa
JH
1029 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1030 * variables like done_sanity_check. */
10666ae3 1031 if (!done_sanity_check) {
ea471437 1032 unsigned int i = SVt_LAST;
10666ae3
NC
1033
1034 done_sanity_check = TRUE;
1035
1036 while (i--)
1037 assert (bodies_by_type[i].type == i);
1038 }
1039#endif
1040
02982131 1041 assert(arena_size);
23e9d66c 1042
99816f8d
NC
1043 /* may need new arena-set to hold new arena */
1044 if (!aroot || aroot->curr >= aroot->set_size) {
1045 struct arena_set *newroot;
1046 Newxz(newroot, 1, struct arena_set);
1047 newroot->set_size = ARENAS_PER_SET;
1048 newroot->next = aroot;
1049 aroot = newroot;
1050 PL_body_arenas = (void *) newroot;
1051 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1052 }
1053
1054 /* ok, now have arena-set with at least 1 empty/available arena-desc */
1055 curr = aroot->curr++;
1056 adesc = &(aroot->set[curr]);
1057 assert(!adesc->arena);
1058
1059 Newx(adesc->arena, good_arena_size, char);
1060 adesc->size = good_arena_size;
1061 adesc->utype = sv_type;
1062 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1063 curr, (void*)adesc->arena, (UV)good_arena_size));
1064
1065 start = (char *) adesc->arena;
d2a0f284 1066
29657bb6
NC
1067 /* Get the address of the byte after the end of the last body we can fit.
1068 Remember, this is integer division: */
02982131 1069 end = start + good_arena_size / body_size * body_size;
d2a0f284 1070
d2a0f284 1071 /* computed count doesnt reflect the 1st slot reservation */
d8fca402
NC
1072#if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1073 DEBUG_m(PerlIO_printf(Perl_debug_log,
1074 "arena %p end %p arena-size %d (from %d) type %d "
1075 "size %d ct %d\n",
02982131
NC
1076 (void*)start, (void*)end, (int)good_arena_size,
1077 (int)arena_size, sv_type, (int)body_size,
1078 (int)good_arena_size / (int)body_size));
d8fca402 1079#else
d2a0f284
JC
1080 DEBUG_m(PerlIO_printf(Perl_debug_log,
1081 "arena %p end %p arena-size %d type %d size %d ct %d\n",
6c9570dc 1082 (void*)start, (void*)end,
02982131
NC
1083 (int)arena_size, sv_type, (int)body_size,
1084 (int)good_arena_size / (int)body_size));
d8fca402 1085#endif
d2a0f284
JC
1086 *root = (void *)start;
1087
29657bb6
NC
1088 while (1) {
1089 /* Where the next body would start: */
d2a0f284 1090 char * const next = start + body_size;
29657bb6
NC
1091
1092 if (next >= end) {
1093 /* This is the last body: */
1094 assert(next == end);
1095
1096 *(void **)start = 0;
1097 return *root;
1098 }
1099
d2a0f284
JC
1100 *(void**) start = (void *)next;
1101 start = next;
1102 }
d2a0f284
JC
1103}
1104
1105/* grab a new thing from the free list, allocating more if necessary.
1106 The inline version is used for speed in hot routines, and the
1107 function using it serves the rest (unless PURIFY).
1108*/
1109#define new_body_inline(xpv, sv_type) \
1110 STMT_START { \
1111 void ** const r3wt = &PL_body_roots[sv_type]; \
11b79775 1112 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1e30fcd5 1113 ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
02982131
NC
1114 bodies_by_type[sv_type].body_size,\
1115 bodies_by_type[sv_type].arena_size)); \
d2a0f284 1116 *(r3wt) = *(void**)(xpv); \
d2a0f284
JC
1117 } STMT_END
1118
1119#ifndef PURIFY
1120
1121STATIC void *
de37a194 1122S_new_body(pTHX_ const svtype sv_type)
d2a0f284
JC
1123{
1124 dVAR;
1125 void *xpv;
1126 new_body_inline(xpv, sv_type);
1127 return xpv;
1128}
1129
1130#endif
93e68bfb 1131
238b27b3
NC
1132static const struct body_details fake_rv =
1133 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1134
bd81e77b
NC
1135/*
1136=for apidoc sv_upgrade
93e68bfb 1137
bd81e77b
NC
1138Upgrade an SV to a more complex form. Generally adds a new body type to the
1139SV, then copies across as much information as possible from the old body.
1140You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
93e68bfb 1141
bd81e77b 1142=cut
93e68bfb 1143*/
93e68bfb 1144
bd81e77b 1145void
aad570aa 1146Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
cac9b346 1147{
97aff369 1148 dVAR;
bd81e77b
NC
1149 void* old_body;
1150 void* new_body;
42d0e0b7 1151 const svtype old_type = SvTYPE(sv);
d2a0f284 1152 const struct body_details *new_type_details;
238b27b3 1153 const struct body_details *old_type_details
bd81e77b 1154 = bodies_by_type + old_type;
4df7f6af 1155 SV *referant = NULL;
cac9b346 1156
7918f24d
NC
1157 PERL_ARGS_ASSERT_SV_UPGRADE;
1158
1776cbe8
NC
1159 if (old_type == new_type)
1160 return;
1161
1162 /* This clause was purposefully added ahead of the early return above to
1163 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1164 inference by Nick I-S that it would fix other troublesome cases. See
1165 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1166
1167 Given that shared hash key scalars are no longer PVIV, but PV, there is
1168 no longer need to unshare so as to free up the IVX slot for its proper
1169 purpose. So it's safe to move the early return earlier. */
1170
bd81e77b
NC
1171 if (new_type != SVt_PV && SvIsCOW(sv)) {
1172 sv_force_normal_flags(sv, 0);
1173 }
cac9b346 1174
bd81e77b 1175 old_body = SvANY(sv);
de042e1d 1176
bd81e77b
NC
1177 /* Copying structures onto other structures that have been neatly zeroed
1178 has a subtle gotcha. Consider XPVMG
cac9b346 1179
bd81e77b
NC
1180 +------+------+------+------+------+-------+-------+
1181 | NV | CUR | LEN | IV | MAGIC | STASH |
1182 +------+------+------+------+------+-------+-------+
1183 0 4 8 12 16 20 24 28
645c22ef 1184
bd81e77b
NC
1185 where NVs are aligned to 8 bytes, so that sizeof that structure is
1186 actually 32 bytes long, with 4 bytes of padding at the end:
08742458 1187
bd81e77b
NC
1188 +------+------+------+------+------+-------+-------+------+
1189 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1190 +------+------+------+------+------+-------+-------+------+
1191 0 4 8 12 16 20 24 28 32
08742458 1192
bd81e77b 1193 so what happens if you allocate memory for this structure:
30f9da9e 1194
bd81e77b
NC
1195 +------+------+------+------+------+-------+-------+------+------+...
1196 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1197 +------+------+------+------+------+-------+-------+------+------+...
1198 0 4 8 12 16 20 24 28 32 36
bfc44f79 1199
bd81e77b
NC
1200 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1201 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1202 started out as zero once, but it's quite possible that it isn't. So now,
1203 rather than a nicely zeroed GP, you have it pointing somewhere random.
1204 Bugs ensue.
bfc44f79 1205
bd81e77b
NC
1206 (In fact, GP ends up pointing at a previous GP structure, because the
1207 principle cause of the padding in XPVMG getting garbage is a copy of
6c9e42f7
NC
1208 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1209 this happens to be moot because XPVGV has been re-ordered, with GP
1210 no longer after STASH)
30f9da9e 1211
bd81e77b
NC
1212 So we are careful and work out the size of used parts of all the
1213 structures. */
bfc44f79 1214
bd81e77b
NC
1215 switch (old_type) {
1216 case SVt_NULL:
1217 break;
1218 case SVt_IV:
4df7f6af
NC
1219 if (SvROK(sv)) {
1220 referant = SvRV(sv);
238b27b3
NC
1221 old_type_details = &fake_rv;
1222 if (new_type == SVt_NV)
1223 new_type = SVt_PVNV;
4df7f6af
NC
1224 } else {
1225 if (new_type < SVt_PVIV) {
1226 new_type = (new_type == SVt_NV)
1227 ? SVt_PVNV : SVt_PVIV;
1228 }
bd81e77b
NC
1229 }
1230 break;
1231 case SVt_NV:
1232 if (new_type < SVt_PVNV) {
1233 new_type = SVt_PVNV;
bd81e77b
NC
1234 }
1235 break;
bd81e77b
NC
1236 case SVt_PV:
1237 assert(new_type > SVt_PV);
1238 assert(SVt_IV < SVt_PV);
1239 assert(SVt_NV < SVt_PV);
1240 break;
1241 case SVt_PVIV:
1242 break;
1243 case SVt_PVNV:
1244 break;
1245 case SVt_PVMG:
1246 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1247 there's no way that it can be safely upgraded, because perl.c
1248 expects to Safefree(SvANY(PL_mess_sv)) */
1249 assert(sv != PL_mess_sv);
1250 /* This flag bit is used to mean other things in other scalar types.
1251 Given that it only has meaning inside the pad, it shouldn't be set
1252 on anything that can get upgraded. */
00b1698f 1253 assert(!SvPAD_TYPED(sv));
bd81e77b
NC
1254 break;
1255 default:
1256 if (old_type_details->cant_upgrade)
c81225bc
NC
1257 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1258 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
bd81e77b 1259 }
3376de98
NC
1260
1261 if (old_type > new_type)
1262 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1263 (int)old_type, (int)new_type);
1264
2fa1109b 1265 new_type_details = bodies_by_type + new_type;
645c22ef 1266
bd81e77b
NC
1267 SvFLAGS(sv) &= ~SVTYPEMASK;
1268 SvFLAGS(sv) |= new_type;
932e9ff9 1269
ab4416c0
NC
1270 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1271 the return statements above will have triggered. */
1272 assert (new_type != SVt_NULL);
bd81e77b 1273 switch (new_type) {
bd81e77b
NC
1274 case SVt_IV:
1275 assert(old_type == SVt_NULL);
1276 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1277 SvIV_set(sv, 0);
1278 return;
1279 case SVt_NV:
1280 assert(old_type == SVt_NULL);
1281 SvANY(sv) = new_XNV();
1282 SvNV_set(sv, 0);
1283 return;
bd81e77b 1284 case SVt_PVHV:
bd81e77b 1285 case SVt_PVAV:
d2a0f284 1286 assert(new_type_details->body_size);
c1ae03ae
NC
1287
1288#ifndef PURIFY
1289 assert(new_type_details->arena);
d2a0f284 1290 assert(new_type_details->arena_size);
c1ae03ae 1291 /* This points to the start of the allocated area. */
d2a0f284
JC
1292 new_body_inline(new_body, new_type);
1293 Zero(new_body, new_type_details->body_size, char);
c1ae03ae
NC
1294 new_body = ((char *)new_body) - new_type_details->offset;
1295#else
1296 /* We always allocated the full length item with PURIFY. To do this
1297 we fake things so that arena is false for all 16 types.. */
1298 new_body = new_NOARENAZ(new_type_details);
1299#endif
1300 SvANY(sv) = new_body;
1301 if (new_type == SVt_PVAV) {
1302 AvMAX(sv) = -1;
1303 AvFILLp(sv) = -1;
1304 AvREAL_only(sv);
64484faa 1305 if (old_type_details->body_size) {
ac572bf4
NC
1306 AvALLOC(sv) = 0;
1307 } else {
1308 /* It will have been zeroed when the new body was allocated.
1309 Lets not write to it, in case it confuses a write-back
1310 cache. */
1311 }
78ac7dd9
NC
1312 } else {
1313 assert(!SvOK(sv));
1314 SvOK_off(sv);
1315#ifndef NODEFAULT_SHAREKEYS
1316 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1317#endif
1318 HvMAX(sv) = 7; /* (start with 8 buckets) */
c1ae03ae 1319 }
aeb18a1e 1320
bd81e77b
NC
1321 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1322 The target created by newSVrv also is, and it can have magic.
1323 However, it never has SvPVX set.
1324 */
4df7f6af
NC
1325 if (old_type == SVt_IV) {
1326 assert(!SvROK(sv));
1327 } else if (old_type >= SVt_PV) {
bd81e77b
NC
1328 assert(SvPVX_const(sv) == 0);
1329 }
aeb18a1e 1330
bd81e77b 1331 if (old_type >= SVt_PVMG) {
e736a858 1332 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
bd81e77b 1333 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
797c7171
NC
1334 } else {
1335 sv->sv_u.svu_array = NULL; /* or svu_hash */
bd81e77b
NC
1336 }
1337 break;
93e68bfb 1338
93e68bfb 1339
b9ad13ac
NC
1340 case SVt_REGEXP:
1341 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1342 sv_force_normal_flags(sv) is called. */
1343 SvFAKE_on(sv);
bd81e77b
NC
1344 case SVt_PVIV:
1345 /* XXX Is this still needed? Was it ever needed? Surely as there is
1346 no route from NV to PVIV, NOK can never be true */
1347 assert(!SvNOKp(sv));
1348 assert(!SvNOK(sv));
1349 case SVt_PVIO:
1350 case SVt_PVFM:
bd81e77b
NC
1351 case SVt_PVGV:
1352 case SVt_PVCV:
1353 case SVt_PVLV:
1354 case SVt_PVMG:
1355 case SVt_PVNV:
1356 case SVt_PV:
93e68bfb 1357
d2a0f284 1358 assert(new_type_details->body_size);
bd81e77b
NC
1359 /* We always allocated the full length item with PURIFY. To do this
1360 we fake things so that arena is false for all 16 types.. */
1361 if(new_type_details->arena) {
1362 /* This points to the start of the allocated area. */
d2a0f284
JC
1363 new_body_inline(new_body, new_type);
1364 Zero(new_body, new_type_details->body_size, char);
bd81e77b
NC
1365 new_body = ((char *)new_body) - new_type_details->offset;
1366 } else {
1367 new_body = new_NOARENAZ(new_type_details);
1368 }
1369 SvANY(sv) = new_body;
5e2fc214 1370
bd81e77b 1371 if (old_type_details->copy) {
f9ba3d20
NC
1372 /* There is now the potential for an upgrade from something without
1373 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1374 int offset = old_type_details->offset;
1375 int length = old_type_details->copy;
1376
1377 if (new_type_details->offset > old_type_details->offset) {
d4c19fe8 1378 const int difference
f9ba3d20
NC
1379 = new_type_details->offset - old_type_details->offset;
1380 offset += difference;
1381 length -= difference;
1382 }
1383 assert (length >= 0);
1384
1385 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1386 char);
bd81e77b
NC
1387 }
1388
1389#ifndef NV_ZERO_IS_ALLBITS_ZERO
f2524eef 1390 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
e5ce394c
NC
1391 * correct 0.0 for us. Otherwise, if the old body didn't have an
1392 * NV slot, but the new one does, then we need to initialise the
1393 * freshly created NV slot with whatever the correct bit pattern is
1394 * for 0.0 */
e22a937e
NC
1395 if (old_type_details->zero_nv && !new_type_details->zero_nv
1396 && !isGV_with_GP(sv))
bd81e77b 1397 SvNV_set(sv, 0);
82048762 1398#endif
5e2fc214 1399
85dca89a
NC
1400 if (new_type == SVt_PVIO) {
1401 IO * const io = MUTABLE_IO(sv);
d963bf01 1402 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
85dca89a
NC
1403
1404 SvOBJECT_on(io);
1405 /* Clear the stashcache because a new IO could overrule a package
1406 name */
1407 hv_clear(PL_stashcache);
1408
85dca89a 1409 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
f2524eef 1410 IoPAGE_LEN(sv) = 60;
85dca89a 1411 }
4df7f6af
NC
1412 if (old_type < SVt_PV) {
1413 /* referant will be NULL unless the old type was SVt_IV emulating
1414 SVt_RV */
1415 sv->sv_u.svu_rv = referant;
1416 }
bd81e77b
NC
1417 break;
1418 default:
afd78fd5
JH
1419 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1420 (unsigned long)new_type);
bd81e77b 1421 }
73171d91 1422
db93c0c4 1423 if (old_type > SVt_IV) {
bd81e77b 1424#ifdef PURIFY
beeec492 1425 safefree(old_body);
bd81e77b 1426#else
bc786448
GG
1427 /* Note that there is an assumption that all bodies of types that
1428 can be upgraded came from arenas. Only the more complex non-
1429 upgradable types are allowed to be directly malloc()ed. */
1430 assert(old_type_details->arena);
bd81e77b
NC
1431 del_body((void*)((char*)old_body + old_type_details->offset),
1432 &PL_body_roots[old_type]);
1433#endif
1434 }
1435}
73171d91 1436
bd81e77b
NC
1437/*
1438=for apidoc sv_backoff
73171d91 1439
bd81e77b
NC
1440Remove any string offset. You should normally use the C<SvOOK_off> macro
1441wrapper instead.
73171d91 1442
bd81e77b 1443=cut
73171d91
NC
1444*/
1445
bd81e77b 1446int
aad570aa 1447Perl_sv_backoff(pTHX_ register SV *const sv)
bd81e77b 1448{
69240efd 1449 STRLEN delta;
7a4bba22 1450 const char * const s = SvPVX_const(sv);
7918f24d
NC
1451
1452 PERL_ARGS_ASSERT_SV_BACKOFF;
96a5add6 1453 PERL_UNUSED_CONTEXT;
7918f24d 1454
bd81e77b
NC
1455 assert(SvOOK(sv));
1456 assert(SvTYPE(sv) != SVt_PVHV);
1457 assert(SvTYPE(sv) != SVt_PVAV);
7a4bba22 1458
69240efd
NC
1459 SvOOK_offset(sv, delta);
1460
7a4bba22
NC
1461 SvLEN_set(sv, SvLEN(sv) + delta);
1462 SvPV_set(sv, SvPVX(sv) - delta);
1463 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
bd81e77b
NC
1464 SvFLAGS(sv) &= ~SVf_OOK;
1465 return 0;
1466}
73171d91 1467
bd81e77b
NC
1468/*
1469=for apidoc sv_grow
73171d91 1470
bd81e77b
NC
1471Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1472upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1473Use the C<SvGROW> wrapper instead.
93e68bfb 1474
bd81e77b
NC
1475=cut
1476*/
93e68bfb 1477
bd81e77b 1478char *
aad570aa 1479Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
bd81e77b
NC
1480{
1481 register char *s;
93e68bfb 1482
7918f24d
NC
1483 PERL_ARGS_ASSERT_SV_GROW;
1484
5db06880
NC
1485 if (PL_madskills && newlen >= 0x100000) {
1486 PerlIO_printf(Perl_debug_log,
1487 "Allocation too large: %"UVxf"\n", (UV)newlen);
1488 }
bd81e77b
NC
1489#ifdef HAS_64K_LIMIT
1490 if (newlen >= 0x10000) {
1491 PerlIO_printf(Perl_debug_log,
1492 "Allocation too large: %"UVxf"\n", (UV)newlen);
1493 my_exit(1);
1494 }
1495#endif /* HAS_64K_LIMIT */
1496 if (SvROK(sv))
1497 sv_unref(sv);
1498 if (SvTYPE(sv) < SVt_PV) {
1499 sv_upgrade(sv, SVt_PV);
1500 s = SvPVX_mutable(sv);
1501 }
1502 else if (SvOOK(sv)) { /* pv is offset? */
1503 sv_backoff(sv);
1504 s = SvPVX_mutable(sv);
1505 if (newlen > SvLEN(sv))
1506 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1507#ifdef HAS_64K_LIMIT
1508 if (newlen >= 0x10000)
1509 newlen = 0xFFFF;
1510#endif
1511 }
1512 else
1513 s = SvPVX_mutable(sv);
aeb18a1e 1514
bd81e77b 1515 if (newlen > SvLEN(sv)) { /* need more room? */
f1200559
WH
1516 STRLEN minlen = SvCUR(sv);
1517 minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1518 if (newlen < minlen)
1519 newlen = minlen;
aedff202 1520#ifndef Perl_safesysmalloc_size
bd81e77b 1521 newlen = PERL_STRLEN_ROUNDUP(newlen);
bd81e77b 1522#endif
98653f18 1523 if (SvLEN(sv) && s) {
10edeb5d 1524 s = (char*)saferealloc(s, newlen);
bd81e77b
NC
1525 }
1526 else {
10edeb5d 1527 s = (char*)safemalloc(newlen);
bd81e77b
NC
1528 if (SvPVX_const(sv) && SvCUR(sv)) {
1529 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1530 }
1531 }
1532 SvPV_set(sv, s);
ca7c1a29 1533#ifdef Perl_safesysmalloc_size
98653f18
NC
1534 /* Do this here, do it once, do it right, and then we will never get
1535 called back into sv_grow() unless there really is some growing
1536 needed. */
ca7c1a29 1537 SvLEN_set(sv, Perl_safesysmalloc_size(s));
98653f18 1538#else
bd81e77b 1539 SvLEN_set(sv, newlen);
98653f18 1540#endif
bd81e77b
NC
1541 }
1542 return s;
1543}
aeb18a1e 1544
bd81e77b
NC
1545/*
1546=for apidoc sv_setiv
932e9ff9 1547
bd81e77b
NC
1548Copies an integer into the given SV, upgrading first if necessary.
1549Does not handle 'set' magic. See also C<sv_setiv_mg>.
463ee0b2 1550
bd81e77b
NC
1551=cut
1552*/
463ee0b2 1553
bd81e77b 1554void
aad570aa 1555Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
bd81e77b 1556{
97aff369 1557 dVAR;
7918f24d
NC
1558
1559 PERL_ARGS_ASSERT_SV_SETIV;
1560
bd81e77b
NC
1561 SV_CHECK_THINKFIRST_COW_DROP(sv);
1562 switch (SvTYPE(sv)) {
1563 case SVt_NULL:
bd81e77b 1564 case SVt_NV:
3376de98 1565 sv_upgrade(sv, SVt_IV);
bd81e77b 1566 break;
bd81e77b
NC
1567 case SVt_PV:
1568 sv_upgrade(sv, SVt_PVIV);
1569 break;
463ee0b2 1570
bd81e77b 1571 case SVt_PVGV:
6e592b3a
BM
1572 if (!isGV_with_GP(sv))
1573 break;
bd81e77b
NC
1574 case SVt_PVAV:
1575 case SVt_PVHV:
1576 case SVt_PVCV:
1577 case SVt_PVFM:
1578 case SVt_PVIO:
1579 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1580 OP_DESC(PL_op));
42d0e0b7 1581 default: NOOP;
bd81e77b
NC
1582 }
1583 (void)SvIOK_only(sv); /* validate number */
1584 SvIV_set(sv, i);
1585 SvTAINT(sv);
1586}
932e9ff9 1587
bd81e77b
NC
1588/*
1589=for apidoc sv_setiv_mg
d33b2eba 1590
bd81e77b 1591Like C<sv_setiv>, but also handles 'set' magic.
1c846c1f 1592
bd81e77b
NC
1593=cut
1594*/
d33b2eba 1595
bd81e77b 1596void
aad570aa 1597Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
bd81e77b 1598{
7918f24d
NC
1599 PERL_ARGS_ASSERT_SV_SETIV_MG;
1600
bd81e77b
NC
1601 sv_setiv(sv,i);
1602 SvSETMAGIC(sv);
1603}
727879eb 1604
bd81e77b
NC
1605/*
1606=for apidoc sv_setuv
d33b2eba 1607
bd81e77b
NC
1608Copies an unsigned integer into the given SV, upgrading first if necessary.
1609Does not handle 'set' magic. See also C<sv_setuv_mg>.
9b94d1dd 1610
bd81e77b
NC
1611=cut
1612*/
d33b2eba 1613
bd81e77b 1614void
aad570aa 1615Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
bd81e77b 1616{
7918f24d
NC
1617 PERL_ARGS_ASSERT_SV_SETUV;
1618
bd81e77b
NC
1619 /* With these two if statements:
1620 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d33b2eba 1621
bd81e77b
NC
1622 without
1623 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1c846c1f 1624
bd81e77b
NC
1625 If you wish to remove them, please benchmark to see what the effect is
1626 */
1627 if (u <= (UV)IV_MAX) {
1628 sv_setiv(sv, (IV)u);
1629 return;
1630 }
1631 sv_setiv(sv, 0);
1632 SvIsUV_on(sv);
1633 SvUV_set(sv, u);
1634}
d33b2eba 1635
bd81e77b
NC
1636/*
1637=for apidoc sv_setuv_mg
727879eb 1638
bd81e77b 1639Like C<sv_setuv>, but also handles 'set' magic.
9b94d1dd 1640
bd81e77b
NC
1641=cut
1642*/
5e2fc214 1643
bd81e77b 1644void
aad570aa 1645Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
bd81e77b 1646{
7918f24d
NC
1647 PERL_ARGS_ASSERT_SV_SETUV_MG;
1648
bd81e77b
NC
1649 sv_setuv(sv,u);
1650 SvSETMAGIC(sv);
1651}
5e2fc214 1652
954c1994 1653/*
bd81e77b 1654=for apidoc sv_setnv
954c1994 1655
bd81e77b
NC
1656Copies a double into the given SV, upgrading first if necessary.
1657Does not handle 'set' magic. See also C<sv_setnv_mg>.
954c1994
GS
1658
1659=cut
1660*/
1661
63f97190 1662void
aad570aa 1663Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
79072805 1664{
97aff369 1665 dVAR;
7918f24d
NC
1666
1667 PERL_ARGS_ASSERT_SV_SETNV;
1668
bd81e77b
NC
1669 SV_CHECK_THINKFIRST_COW_DROP(sv);
1670 switch (SvTYPE(sv)) {
79072805 1671 case SVt_NULL:
79072805 1672 case SVt_IV:
bd81e77b 1673 sv_upgrade(sv, SVt_NV);
79072805
LW
1674 break;
1675 case SVt_PV:
79072805 1676 case SVt_PVIV:
bd81e77b 1677 sv_upgrade(sv, SVt_PVNV);
79072805 1678 break;
bd4b1eb5 1679
bd4b1eb5 1680 case SVt_PVGV:
6e592b3a
BM
1681 if (!isGV_with_GP(sv))
1682 break;
bd81e77b
NC
1683 case SVt_PVAV:
1684 case SVt_PVHV:
79072805 1685 case SVt_PVCV:
bd81e77b
NC
1686 case SVt_PVFM:
1687 case SVt_PVIO:
1688 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
94bbb3f4 1689 OP_DESC(PL_op));
42d0e0b7 1690 default: NOOP;
2068cd4d 1691 }
bd81e77b
NC
1692 SvNV_set(sv, num);
1693 (void)SvNOK_only(sv); /* validate number */
1694 SvTAINT(sv);
79072805
LW
1695}
1696
645c22ef 1697/*
bd81e77b 1698=for apidoc sv_setnv_mg
645c22ef 1699
bd81e77b 1700Like C<sv_setnv>, but also handles 'set' magic.
645c22ef
DM
1701
1702=cut
1703*/
1704
bd81e77b 1705void
aad570aa 1706Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
79072805 1707{
7918f24d
NC
1708 PERL_ARGS_ASSERT_SV_SETNV_MG;
1709
bd81e77b
NC
1710 sv_setnv(sv,num);
1711 SvSETMAGIC(sv);
79072805
LW
1712}
1713
bd81e77b
NC
1714/* Print an "isn't numeric" warning, using a cleaned-up,
1715 * printable version of the offending string
1716 */
954c1994 1717
bd81e77b 1718STATIC void
aad570aa 1719S_not_a_number(pTHX_ SV *const sv)
79072805 1720{
97aff369 1721 dVAR;
bd81e77b
NC
1722 SV *dsv;
1723 char tmpbuf[64];
1724 const char *pv;
94463019 1725
7918f24d
NC
1726 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1727
94463019 1728 if (DO_UTF8(sv)) {
84bafc02 1729 dsv = newSVpvs_flags("", SVs_TEMP);
94463019
JH
1730 pv = sv_uni_display(dsv, sv, 10, 0);
1731 } else {
1732 char *d = tmpbuf;
551405c4 1733 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
94463019
JH
1734 /* each *s can expand to 4 chars + "...\0",
1735 i.e. need room for 8 chars */
ecdeb87c 1736
00b6aa41
AL
1737 const char *s = SvPVX_const(sv);
1738 const char * const end = s + SvCUR(sv);
1739 for ( ; s < end && d < limit; s++ ) {
94463019
JH
1740 int ch = *s & 0xFF;
1741 if (ch & 128 && !isPRINT_LC(ch)) {
1742 *d++ = 'M';
1743 *d++ = '-';
1744 ch &= 127;
1745 }
1746 if (ch == '\n') {
1747 *d++ = '\\';
1748 *d++ = 'n';
1749 }
1750 else if (ch == '\r') {
1751 *d++ = '\\';
1752 *d++ = 'r';
1753 }
1754 else if (ch == '\f') {
1755 *d++ = '\\';
1756 *d++ = 'f';
1757 }
1758 else if (ch == '\\') {
1759 *d++ = '\\';
1760 *d++ = '\\';
1761 }
1762 else if (ch == '\0') {
1763 *d++ = '\\';
1764 *d++ = '0';
1765 }
1766 else if (isPRINT_LC(ch))
1767 *d++ = ch;
1768 else {
1769 *d++ = '^';
1770 *d++ = toCTRL(ch);
1771 }
1772 }
1773 if (s < end) {
1774 *d++ = '.';
1775 *d++ = '.';
1776 *d++ = '.';
1777 }
1778 *d = '\0';
1779 pv = tmpbuf;
a0d0e21e 1780 }
a0d0e21e 1781
533c011a 1782 if (PL_op)
9014280d 1783 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019
JH
1784 "Argument \"%s\" isn't numeric in %s", pv,
1785 OP_DESC(PL_op));
a0d0e21e 1786 else
9014280d 1787 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019 1788 "Argument \"%s\" isn't numeric", pv);
a0d0e21e
LW
1789}
1790
c2988b20
NC
1791/*
1792=for apidoc looks_like_number
1793
645c22ef
DM
1794Test if the content of an SV looks like a number (or is a number).
1795C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1796non-numeric warning), even if your atof() doesn't grok them.
c2988b20
NC
1797
1798=cut
1799*/
1800
1801I32
aad570aa 1802Perl_looks_like_number(pTHX_ SV *const sv)
c2988b20 1803{
a3b680e6 1804 register const char *sbegin;
c2988b20
NC
1805 STRLEN len;
1806
7918f24d
NC
1807 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1808
c2988b20 1809 if (SvPOK(sv)) {
3f7c398e 1810 sbegin = SvPVX_const(sv);
c2988b20
NC
1811 len = SvCUR(sv);
1812 }
1813 else if (SvPOKp(sv))
83003860 1814 sbegin = SvPV_const(sv, len);
c2988b20 1815 else
e0ab1c0e 1816 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
c2988b20
NC
1817 return grok_number(sbegin, len, NULL);
1818}
25da4f38 1819
19f6321d
NC
1820STATIC bool
1821S_glob_2number(pTHX_ GV * const gv)
180488f8
NC
1822{
1823 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1824 SV *const buffer = sv_newmortal();
1825
7918f24d
NC
1826 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1827
180488f8
NC
1828 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1829 is on. */
1830 SvFAKE_off(gv);
1831 gv_efullname3(buffer, gv, "*");
1832 SvFLAGS(gv) |= wasfake;
1833
675c862f
AL
1834 /* We know that all GVs stringify to something that is not-a-number,
1835 so no need to test that. */
1836 if (ckWARN(WARN_NUMERIC))
1837 not_a_number(buffer);
1838 /* We just want something true to return, so that S_sv_2iuv_common
1839 can tail call us and return true. */
19f6321d 1840 return TRUE;
675c862f
AL
1841}
1842
25da4f38
IZ
1843/* Actually, ISO C leaves conversion of UV to IV undefined, but
1844 until proven guilty, assume that things are not that bad... */
1845
645c22ef
DM
1846/*
1847 NV_PRESERVES_UV:
1848
1849 As 64 bit platforms often have an NV that doesn't preserve all bits of
28e5dec8
JH
1850 an IV (an assumption perl has been based on to date) it becomes necessary
1851 to remove the assumption that the NV always carries enough precision to
1852 recreate the IV whenever needed, and that the NV is the canonical form.
1853 Instead, IV/UV and NV need to be given equal rights. So as to not lose
645c22ef 1854 precision as a side effect of conversion (which would lead to insanity
28e5dec8
JH
1855 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1856 1) to distinguish between IV/UV/NV slots that have cached a valid
1857 conversion where precision was lost and IV/UV/NV slots that have a
1858 valid conversion which has lost no precision
645c22ef 1859 2) to ensure that if a numeric conversion to one form is requested that
28e5dec8
JH
1860 would lose precision, the precise conversion (or differently
1861 imprecise conversion) is also performed and cached, to prevent
1862 requests for different numeric formats on the same SV causing
1863 lossy conversion chains. (lossless conversion chains are perfectly
1864 acceptable (still))
1865
1866
1867 flags are used:
1868 SvIOKp is true if the IV slot contains a valid value
1869 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1870 SvNOKp is true if the NV slot contains a valid value
1871 SvNOK is true only if the NV value is accurate
1872
1873 so
645c22ef 1874 while converting from PV to NV, check to see if converting that NV to an
28e5dec8
JH
1875 IV(or UV) would lose accuracy over a direct conversion from PV to
1876 IV(or UV). If it would, cache both conversions, return NV, but mark
1877 SV as IOK NOKp (ie not NOK).
1878
645c22ef 1879 While converting from PV to IV, check to see if converting that IV to an
28e5dec8
JH
1880 NV would lose accuracy over a direct conversion from PV to NV. If it
1881 would, cache both conversions, flag similarly.
1882
1883 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1884 correctly because if IV & NV were set NV *always* overruled.
645c22ef
DM
1885 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1886 changes - now IV and NV together means that the two are interchangeable:
28e5dec8 1887 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
d460ef45 1888
645c22ef
DM
1889 The benefit of this is that operations such as pp_add know that if
1890 SvIOK is true for both left and right operands, then integer addition
1891 can be used instead of floating point (for cases where the result won't
1892 overflow). Before, floating point was always used, which could lead to
28e5dec8
JH
1893 loss of precision compared with integer addition.
1894
1895 * making IV and NV equal status should make maths accurate on 64 bit
1896 platforms
1897 * may speed up maths somewhat if pp_add and friends start to use
645c22ef 1898 integers when possible instead of fp. (Hopefully the overhead in
28e5dec8
JH
1899 looking for SvIOK and checking for overflow will not outweigh the
1900 fp to integer speedup)
1901 * will slow down integer operations (callers of SvIV) on "inaccurate"
1902 values, as the change from SvIOK to SvIOKp will cause a call into
1903 sv_2iv each time rather than a macro access direct to the IV slot
1904 * should speed up number->string conversion on integers as IV is
645c22ef 1905 favoured when IV and NV are equally accurate
28e5dec8
JH
1906
1907 ####################################################################
645c22ef
DM
1908 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1909 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1910 On the other hand, SvUOK is true iff UV.
28e5dec8
JH
1911 ####################################################################
1912
645c22ef 1913 Your mileage will vary depending your CPU's relative fp to integer
28e5dec8
JH
1914 performance ratio.
1915*/
1916
1917#ifndef NV_PRESERVES_UV
645c22ef
DM
1918# define IS_NUMBER_UNDERFLOW_IV 1
1919# define IS_NUMBER_UNDERFLOW_UV 2
1920# define IS_NUMBER_IV_AND_UV 2
1921# define IS_NUMBER_OVERFLOW_IV 4
1922# define IS_NUMBER_OVERFLOW_UV 5
1923
1924/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
28e5dec8
JH
1925
1926/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1927STATIC int
5de3775c 1928S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
47031da6
NC
1929# ifdef DEBUGGING
1930 , I32 numtype
1931# endif
1932 )
28e5dec8 1933{
97aff369 1934 dVAR;
7918f24d
NC
1935
1936 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1937
3f7c398e 1938 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));
28e5dec8
JH
1939 if (SvNVX(sv) < (NV)IV_MIN) {
1940 (void)SvIOKp_on(sv);
1941 (void)SvNOK_on(sv);
45977657 1942 SvIV_set(sv, IV_MIN);
28e5dec8
JH
1943 return IS_NUMBER_UNDERFLOW_IV;
1944 }
1945 if (SvNVX(sv) > (NV)UV_MAX) {
1946 (void)SvIOKp_on(sv);
1947 (void)SvNOK_on(sv);
1948 SvIsUV_on(sv);
607fa7f2 1949 SvUV_set(sv, UV_MAX);
28e5dec8
JH
1950 return IS_NUMBER_OVERFLOW_UV;
1951 }
c2988b20
NC
1952 (void)SvIOKp_on(sv);
1953 (void)SvNOK_on(sv);
1954 /* Can't use strtol etc to convert this string. (See truth table in
1955 sv_2iv */
1956 if (SvNVX(sv) <= (UV)IV_MAX) {
45977657 1957 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
1958 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1959 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1960 } else {
1961 /* Integer is imprecise. NOK, IOKp */
1962 }
1963 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1964 }
1965 SvIsUV_on(sv);
607fa7f2 1966 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
1967 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1968 if (SvUVX(sv) == UV_MAX) {
1969 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1970 possibly be preserved by NV. Hence, it must be overflow.
1971 NOK, IOKp */
1972 return IS_NUMBER_OVERFLOW_UV;
1973 }
1974 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1975 } else {
1976 /* Integer is imprecise. NOK, IOKp */
28e5dec8 1977 }
c2988b20 1978 return IS_NUMBER_OVERFLOW_IV;
28e5dec8 1979}
645c22ef
DM
1980#endif /* !NV_PRESERVES_UV*/
1981
af359546 1982STATIC bool
7918f24d
NC
1983S_sv_2iuv_common(pTHX_ SV *const sv)
1984{
97aff369 1985 dVAR;
7918f24d
NC
1986
1987 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1988
af359546 1989 if (SvNOKp(sv)) {
28e5dec8
JH
1990 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1991 * without also getting a cached IV/UV from it at the same time
1992 * (ie PV->NV conversion should detect loss of accuracy and cache
af359546
NC
1993 * IV or UV at same time to avoid this. */
1994 /* IV-over-UV optimisation - choose to cache IV if possible */
25da4f38
IZ
1995
1996 if (SvTYPE(sv) == SVt_NV)
1997 sv_upgrade(sv, SVt_PVNV);
1998
28e5dec8
JH
1999 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2000 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2001 certainly cast into the IV range at IV_MAX, whereas the correct
2002 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2003 cases go to UV */
cab190d4
JD
2004#if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2005 if (Perl_isnan(SvNVX(sv))) {
2006 SvUV_set(sv, 0);
2007 SvIsUV_on(sv);
fdbe6d7c 2008 return FALSE;
cab190d4 2009 }
cab190d4 2010#endif
28e5dec8 2011 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2012 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2013 if (SvNVX(sv) == (NV) SvIVX(sv)
2014#ifndef NV_PRESERVES_UV
2015 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2016 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2017 /* Don't flag it as "accurately an integer" if the number
2018 came from a (by definition imprecise) NV operation, and
2019 we're outside the range of NV integer precision */
2020#endif
2021 ) {
a43d94f2
NC
2022 if (SvNOK(sv))
2023 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2024 else {
2025 /* scalar has trailing garbage, eg "42a" */
2026 }
28e5dec8 2027 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2028 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2029 PTR2UV(sv),
2030 SvNVX(sv),
2031 SvIVX(sv)));
2032
2033 } else {
2034 /* IV not precise. No need to convert from PV, as NV
2035 conversion would already have cached IV if it detected
2036 that PV->IV would be better than PV->NV->IV
2037 flags already correct - don't set public IOK. */
2038 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2039 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2040 PTR2UV(sv),
2041 SvNVX(sv),
2042 SvIVX(sv)));
2043 }
2044 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2045 but the cast (NV)IV_MIN rounds to a the value less (more
2046 negative) than IV_MIN which happens to be equal to SvNVX ??
2047 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2048 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2049 (NV)UVX == NVX are both true, but the values differ. :-(
2050 Hopefully for 2s complement IV_MIN is something like
2051 0x8000000000000000 which will be exact. NWC */
d460ef45 2052 }
25da4f38 2053 else {
607fa7f2 2054 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2055 if (
2056 (SvNVX(sv) == (NV) SvUVX(sv))
2057#ifndef NV_PRESERVES_UV
2058 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2059 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2060 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2061 /* Don't flag it as "accurately an integer" if the number
2062 came from a (by definition imprecise) NV operation, and
2063 we're outside the range of NV integer precision */
2064#endif
a43d94f2 2065 && SvNOK(sv)
28e5dec8
JH
2066 )
2067 SvIOK_on(sv);
25da4f38 2068 SvIsUV_on(sv);
1c846c1f 2069 DEBUG_c(PerlIO_printf(Perl_debug_log,
57def98f 2070 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
56431972 2071 PTR2UV(sv),
57def98f
JH
2072 SvUVX(sv),
2073 SvUVX(sv)));
25da4f38 2074 }
748a9306
LW
2075 }
2076 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2077 UV value;
504618e9 2078 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
af359546 2079 /* We want to avoid a possible problem when we cache an IV/ a UV which
25da4f38 2080 may be later translated to an NV, and the resulting NV is not
c2988b20
NC
2081 the same as the direct translation of the initial string
2082 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2083 be careful to ensure that the value with the .456 is around if the
2084 NV value is requested in the future).
1c846c1f 2085
af359546 2086 This means that if we cache such an IV/a UV, we need to cache the
25da4f38 2087 NV as well. Moreover, we trade speed for space, and do not
28e5dec8 2088 cache the NV if we are sure it's not needed.
25da4f38 2089 */
16b7a9a4 2090
c2988b20
NC
2091 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2092 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2093 == IS_NUMBER_IN_UV) {
5e045b90 2094 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8
JH
2095 if (SvTYPE(sv) < SVt_PVIV)
2096 sv_upgrade(sv, SVt_PVIV);
f7bbb42a 2097 (void)SvIOK_on(sv);
c2988b20
NC
2098 } else if (SvTYPE(sv) < SVt_PVNV)
2099 sv_upgrade(sv, SVt_PVNV);
28e5dec8 2100
f2524eef 2101 /* If NVs preserve UVs then we only use the UV value if we know that
c2988b20
NC
2102 we aren't going to call atof() below. If NVs don't preserve UVs
2103 then the value returned may have more precision than atof() will
2104 return, even though value isn't perfectly accurate. */
2105 if ((numtype & (IS_NUMBER_IN_UV
2106#ifdef NV_PRESERVES_UV
2107 | IS_NUMBER_NOT_INT
2108#endif
2109 )) == IS_NUMBER_IN_UV) {
2110 /* This won't turn off the public IOK flag if it was set above */
2111 (void)SvIOKp_on(sv);
2112
2113 if (!(numtype & IS_NUMBER_NEG)) {
2114 /* positive */;
2115 if (value <= (UV)IV_MAX) {
45977657 2116 SvIV_set(sv, (IV)value);
c2988b20 2117 } else {
af359546 2118 /* it didn't overflow, and it was positive. */
607fa7f2 2119 SvUV_set(sv, value);
c2988b20
NC
2120 SvIsUV_on(sv);
2121 }
2122 } else {
2123 /* 2s complement assumption */
2124 if (value <= (UV)IV_MIN) {
45977657 2125 SvIV_set(sv, -(IV)value);
c2988b20
NC
2126 } else {
2127 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2128 I'm assuming it will be rare. */
c2988b20
NC
2129 if (SvTYPE(sv) < SVt_PVNV)
2130 sv_upgrade(sv, SVt_PVNV);
2131 SvNOK_on(sv);
2132 SvIOK_off(sv);
2133 SvIOKp_on(sv);
9d6ce603 2134 SvNV_set(sv, -(NV)value);
45977657 2135 SvIV_set(sv, IV_MIN);
c2988b20
NC
2136 }
2137 }
2138 }
2139 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2140 will be in the previous block to set the IV slot, and the next
2141 block to set the NV slot. So no else here. */
2142
2143 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2144 != IS_NUMBER_IN_UV) {
2145 /* It wasn't an (integer that doesn't overflow the UV). */
3f7c398e 2146 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8 2147
c2988b20
NC
2148 if (! numtype && ckWARN(WARN_NUMERIC))
2149 not_a_number(sv);
28e5dec8 2150
65202027 2151#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2152 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2153 PTR2UV(sv), SvNVX(sv)));
65202027 2154#else
1779d84d 2155 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
c2988b20 2156 PTR2UV(sv), SvNVX(sv)));
65202027 2157#endif
28e5dec8 2158
28e5dec8 2159#ifdef NV_PRESERVES_UV
af359546
NC
2160 (void)SvIOKp_on(sv);
2161 (void)SvNOK_on(sv);
2162 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2163 SvIV_set(sv, I_V(SvNVX(sv)));
2164 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2165 SvIOK_on(sv);
2166 } else {
6f207bd3 2167 NOOP; /* Integer is imprecise. NOK, IOKp */
af359546
NC
2168 }
2169 /* UV will not work better than IV */
2170 } else {
2171 if (SvNVX(sv) > (NV)UV_MAX) {
2172 SvIsUV_on(sv);
2173 /* Integer is inaccurate. NOK, IOKp, is UV */
2174 SvUV_set(sv, UV_MAX);
af359546
NC
2175 } else {
2176 SvUV_set(sv, U_V(SvNVX(sv)));
2177 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2178 NV preservse UV so can do correct comparison. */
2179 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2180 SvIOK_on(sv);
af359546 2181 } else {
6f207bd3 2182 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
af359546
NC
2183 }
2184 }
4b0c9573 2185 SvIsUV_on(sv);
af359546 2186 }
28e5dec8 2187#else /* NV_PRESERVES_UV */
c2988b20
NC
2188 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2189 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
af359546 2190 /* The IV/UV slot will have been set from value returned by
c2988b20
NC
2191 grok_number above. The NV slot has just been set using
2192 Atof. */
560b0c46 2193 SvNOK_on(sv);
c2988b20
NC
2194 assert (SvIOKp(sv));
2195 } else {
2196 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2197 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2198 /* Small enough to preserve all bits. */
2199 (void)SvIOKp_on(sv);
2200 SvNOK_on(sv);
45977657 2201 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2202 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2203 SvIOK_on(sv);
2204 /* Assumption: first non-preserved integer is < IV_MAX,
2205 this NV is in the preserved range, therefore: */
2206 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2207 < (UV)IV_MAX)) {
32fdb065 2208 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);
c2988b20
NC
2209 }
2210 } else {
2211 /* IN_UV NOT_INT
2212 0 0 already failed to read UV.
2213 0 1 already failed to read UV.
2214 1 0 you won't get here in this case. IV/UV
2215 slot set, public IOK, Atof() unneeded.
2216 1 1 already read UV.
2217 so there's no point in sv_2iuv_non_preserve() attempting
2218 to use atol, strtol, strtoul etc. */
47031da6 2219# ifdef DEBUGGING
40a17c4c 2220 sv_2iuv_non_preserve (sv, numtype);
47031da6
NC
2221# else
2222 sv_2iuv_non_preserve (sv);
2223# endif
c2988b20
NC
2224 }
2225 }
28e5dec8 2226#endif /* NV_PRESERVES_UV */
a43d94f2
NC
2227 /* It might be more code efficient to go through the entire logic above
2228 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2229 gets complex and potentially buggy, so more programmer efficient
2230 to do it this way, by turning off the public flags: */
2231 if (!numtype)
2232 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
25da4f38 2233 }
af359546
NC
2234 }
2235 else {
675c862f 2236 if (isGV_with_GP(sv))
159b6efe 2237 return glob_2number(MUTABLE_GV(sv));
180488f8 2238
af359546
NC
2239 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2240 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2241 report_uninit(sv);
2242 }
25da4f38
IZ
2243 if (SvTYPE(sv) < SVt_IV)
2244 /* Typically the caller expects that sv_any is not NULL now. */
2245 sv_upgrade(sv, SVt_IV);
af359546
NC
2246 /* Return 0 from the caller. */
2247 return TRUE;
2248 }
2249 return FALSE;
2250}
2251
2252/*
2253=for apidoc sv_2iv_flags
2254
2255Return the integer value of an SV, doing any necessary string
2256conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2257Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2258
2259=cut
2260*/
2261
2262IV
5de3775c 2263Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
af359546 2264{
97aff369 2265 dVAR;
af359546 2266 if (!sv)
a0d0e21e 2267 return 0;
cecf5685
NC
2268 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2269 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
50caf62e
NC
2270 cache IVs just in case. In practice it seems that they never
2271 actually anywhere accessible by user Perl code, let alone get used
2272 in anything other than a string context. */
af359546
NC
2273 if (flags & SV_GMAGIC)
2274 mg_get(sv);
2275 if (SvIOKp(sv))
2276 return SvIVX(sv);
2277 if (SvNOKp(sv)) {
2278 return I_V(SvNVX(sv));
2279 }
71c558c3
NC
2280 if (SvPOKp(sv) && SvLEN(sv)) {
2281 UV value;
2282 const int numtype
2283 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2284
2285 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2286 == IS_NUMBER_IN_UV) {
2287 /* It's definitely an integer */
2288 if (numtype & IS_NUMBER_NEG) {
2289 if (value < (UV)IV_MIN)
2290 return -(IV)value;
2291 } else {
2292 if (value < (UV)IV_MAX)
2293 return (IV)value;
2294 }
2295 }
2296 if (!numtype) {
2297 if (ckWARN(WARN_NUMERIC))
2298 not_a_number(sv);
2299 }
2300 return I_V(Atof(SvPVX_const(sv)));
2301 }
1c7ff15e
NC
2302 if (SvROK(sv)) {
2303 goto return_rok;
af359546 2304 }
1c7ff15e
NC
2305 assert(SvTYPE(sv) >= SVt_PVMG);
2306 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
4cb1ec55 2307 } else if (SvTHINKFIRST(sv)) {
af359546 2308 if (SvROK(sv)) {
1c7ff15e 2309 return_rok:
af359546 2310 if (SvAMAGIC(sv)) {
aee036bb
DM
2311 SV * tmpstr;
2312 if (flags & SV_SKIP_OVERLOAD)
2313 return 0;
31d632c3 2314 tmpstr = AMG_CALLunary(sv, numer_amg);
af359546
NC
2315 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2316 return SvIV(tmpstr);
2317 }
2318 }
2319 return PTR2IV(SvRV(sv));
2320 }
2321 if (SvIsCOW(sv)) {
2322 sv_force_normal_flags(sv, 0);
2323 }
2324 if (SvREADONLY(sv) && !SvOK(sv)) {
2325 if (ckWARN(WARN_UNINITIALIZED))
2326 report_uninit(sv);
2327 return 0;
2328 }
2329 }
2330 if (!SvIOKp(sv)) {
2331 if (S_sv_2iuv_common(aTHX_ sv))
2332 return 0;
79072805 2333 }
1d7c1841
GS
2334 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2335 PTR2UV(sv),SvIVX(sv)));
25da4f38 2336 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
79072805
LW
2337}
2338
645c22ef 2339/*
891f9566 2340=for apidoc sv_2uv_flags
645c22ef
DM
2341
2342Return the unsigned integer value of an SV, doing any necessary string
891f9566
YST
2343conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2344Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
645c22ef
DM
2345
2346=cut
2347*/
2348
ff68c719 2349UV
5de3775c 2350Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
ff68c719 2351{
97aff369 2352 dVAR;
ff68c719 2353 if (!sv)
2354 return 0;
cecf5685
NC
2355 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2356 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
50caf62e 2357 cache IVs just in case. */
891f9566
YST
2358 if (flags & SV_GMAGIC)
2359 mg_get(sv);
ff68c719 2360 if (SvIOKp(sv))
2361 return SvUVX(sv);
2362 if (SvNOKp(sv))
2363 return U_V(SvNVX(sv));
71c558c3
NC
2364 if (SvPOKp(sv) && SvLEN(sv)) {
2365 UV value;
2366 const int numtype
2367 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2368
2369 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2370 == IS_NUMBER_IN_UV) {
2371 /* It's definitely an integer */
2372 if (!(numtype & IS_NUMBER_NEG))
2373 return value;
2374 }
2375 if (!numtype) {
2376 if (ckWARN(WARN_NUMERIC))
2377 not_a_number(sv);
2378 }
2379 return U_V(Atof(SvPVX_const(sv)));
2380 }
1c7ff15e
NC
2381 if (SvROK(sv)) {
2382 goto return_rok;
3fe9a6f1 2383 }
1c7ff15e
NC
2384 assert(SvTYPE(sv) >= SVt_PVMG);
2385 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
4cb1ec55 2386 } else if (SvTHINKFIRST(sv)) {
ff68c719 2387 if (SvROK(sv)) {
1c7ff15e 2388 return_rok:
deb46114 2389 if (SvAMAGIC(sv)) {
aee036bb
DM
2390 SV *tmpstr;
2391 if (flags & SV_SKIP_OVERLOAD)
2392 return 0;
31d632c3 2393 tmpstr = AMG_CALLunary(sv, numer_amg);
deb46114
NC
2394 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2395 return SvUV(tmpstr);
2396 }
2397 }
2398 return PTR2UV(SvRV(sv));
ff68c719 2399 }
765f542d
NC
2400 if (SvIsCOW(sv)) {
2401 sv_force_normal_flags(sv, 0);
8a818333 2402 }
0336b60e 2403 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2404 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2405 report_uninit(sv);
ff68c719 2406 return 0;
2407 }
2408 }
af359546
NC
2409 if (!SvIOKp(sv)) {
2410 if (S_sv_2iuv_common(aTHX_ sv))
2411 return 0;
ff68c719 2412 }
25da4f38 2413
1d7c1841
GS
2414 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2415 PTR2UV(sv),SvUVX(sv)));
25da4f38 2416 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
ff68c719 2417}
2418
645c22ef 2419/*
196007d1 2420=for apidoc sv_2nv_flags
645c22ef
DM
2421
2422Return the num value of an SV, doing any necessary string or integer
39d5de13
DM
2423conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2424Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
645c22ef
DM
2425
2426=cut
2427*/
2428
65202027 2429NV
39d5de13 2430Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
79072805 2431{
97aff369 2432 dVAR;
79072805
LW
2433 if (!sv)
2434 return 0.0;
cecf5685
NC
2435 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2436 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
50caf62e 2437 cache IVs just in case. */
39d5de13
DM
2438 if (flags & SV_GMAGIC)
2439 mg_get(sv);
463ee0b2
LW
2440 if (SvNOKp(sv))
2441 return SvNVX(sv);
0aa395f8 2442 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
041457d9 2443 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
504618e9 2444 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
a0d0e21e 2445 not_a_number(sv);
3f7c398e 2446 return Atof(SvPVX_const(sv));
a0d0e21e 2447 }
25da4f38 2448 if (SvIOKp(sv)) {
1c846c1f 2449 if (SvIsUV(sv))
65202027 2450 return (NV)SvUVX(sv);
25da4f38 2451 else
65202027 2452 return (NV)SvIVX(sv);
47a72cb8
NC
2453 }
2454 if (SvROK(sv)) {
2455 goto return_rok;
2456 }
2457 assert(SvTYPE(sv) >= SVt_PVMG);
2458 /* This falls through to the report_uninit near the end of the
2459 function. */
2460 } else if (SvTHINKFIRST(sv)) {
a0d0e21e 2461 if (SvROK(sv)) {
47a72cb8 2462 return_rok:
deb46114 2463 if (SvAMAGIC(sv)) {
aee036bb
DM
2464 SV *tmpstr;
2465 if (flags & SV_SKIP_OVERLOAD)
2466 return 0;
31d632c3 2467 tmpstr = AMG_CALLunary(sv, numer_amg);
deb46114
NC
2468 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2469 return SvNV(tmpstr);
2470 }
2471 }
2472 return PTR2NV(SvRV(sv));
a0d0e21e 2473 }
765f542d
NC
2474 if (SvIsCOW(sv)) {
2475 sv_force_normal_flags(sv, 0);
8a818333 2476 }
0336b60e 2477 if (SvREADONLY(sv) && !SvOK(sv)) {
599cee73 2478 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2479 report_uninit(sv);
ed6116ce
LW
2480 return 0.0;
2481 }
79072805
LW
2482 }
2483 if (SvTYPE(sv) < SVt_NV) {
7e25a7e9
NC
2484 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2485 sv_upgrade(sv, SVt_NV);
906f284f 2486#ifdef USE_LONG_DOUBLE
097ee67d 2487 DEBUG_c({
f93f4e46 2488 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
2489 PerlIO_printf(Perl_debug_log,
2490 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2491 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
2492 RESTORE_NUMERIC_LOCAL();
2493 });
65202027 2494#else
572bbb43 2495 DEBUG_c({
f93f4e46 2496 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 2497 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
1d7c1841 2498 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
2499 RESTORE_NUMERIC_LOCAL();
2500 });
572bbb43 2501#endif
79072805
LW
2502 }
2503 else if (SvTYPE(sv) < SVt_PVNV)
2504 sv_upgrade(sv, SVt_PVNV);
59d8ce62
NC
2505 if (SvNOKp(sv)) {
2506 return SvNVX(sv);
61604483 2507 }
59d8ce62 2508 if (SvIOKp(sv)) {
9d6ce603 2509 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
28e5dec8 2510#ifdef NV_PRESERVES_UV
a43d94f2
NC
2511 if (SvIOK(sv))
2512 SvNOK_on(sv);
2513 else
2514 SvNOKp_on(sv);
28e5dec8
JH
2515#else
2516 /* Only set the public NV OK flag if this NV preserves the IV */
2517 /* Check it's not 0xFFFFFFFFFFFFFFFF */
a43d94f2
NC
2518 if (SvIOK(sv) &&
2519 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
28e5dec8
JH
2520 : (SvIVX(sv) == I_V(SvNVX(sv))))
2521 SvNOK_on(sv);
2522 else
2523 SvNOKp_on(sv);
2524#endif
93a17b20 2525 }
748a9306 2526 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2527 UV value;
3f7c398e 2528 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
041457d9 2529 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
a0d0e21e 2530 not_a_number(sv);
28e5dec8 2531#ifdef NV_PRESERVES_UV
c2988b20
NC
2532 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2533 == IS_NUMBER_IN_UV) {
5e045b90 2534 /* It's definitely an integer */
9d6ce603 2535 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
c2988b20 2536 } else
3f7c398e 2537 SvNV_set(sv, Atof(SvPVX_const(sv)));
a43d94f2
NC
2538 if (numtype)
2539 SvNOK_on(sv);
2540 else
2541 SvNOKp_on(sv);
28e5dec8 2542#else
3f7c398e 2543 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8
JH
2544 /* Only set the public NV OK flag if this NV preserves the value in
2545 the PV at least as well as an IV/UV would.
2546 Not sure how to do this 100% reliably. */
2547 /* if that shift count is out of range then Configure's test is
2548 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2549 UV_BITS */
2550 if (((UV)1 << NV_PRESERVES_UV_BITS) >
c2988b20 2551 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
28e5dec8 2552 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
c2988b20
NC
2553 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2554 /* Can't use strtol etc to convert this string, so don't try.
2555 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2556 SvNOK_on(sv);
2557 } else {
2558 /* value has been set. It may not be precise. */
2559 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2560 /* 2s complement assumption for (UV)IV_MIN */
2561 SvNOK_on(sv); /* Integer is too negative. */
2562 } else {
2563 SvNOKp_on(sv);
2564 SvIOKp_on(sv);
6fa402ec 2565
c2988b20 2566 if (numtype & IS_NUMBER_NEG) {
45977657 2567 SvIV_set(sv, -(IV)value);
c2988b20 2568 } else if (value <= (UV)IV_MAX) {
45977657 2569 SvIV_set(sv, (IV)value);
c2988b20 2570 } else {
607fa7f2 2571 SvUV_set(sv, value);
c2988b20
NC
2572 SvIsUV_on(sv);
2573 }
2574
2575 if (numtype & IS_NUMBER_NOT_INT) {
2576 /* I believe that even if the original PV had decimals,
2577 they are lost beyond the limit of the FP precision.
2578 However, neither is canonical, so both only get p
2579 flags. NWC, 2000/11/25 */
2580 /* Both already have p flags, so do nothing */
2581 } else {
66a1b24b 2582 const NV nv = SvNVX(sv);
c2988b20
NC
2583 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2584 if (SvIVX(sv) == I_V(nv)) {
2585 SvNOK_on(sv);
c2988b20 2586 } else {
c2988b20
NC
2587 /* It had no "." so it must be integer. */
2588 }
00b6aa41 2589 SvIOK_on(sv);
c2988b20
NC
2590 } else {
2591 /* between IV_MAX and NV(UV_MAX).
2592 Could be slightly > UV_MAX */
6fa402ec 2593
c2988b20
NC
2594 if (numtype & IS_NUMBER_NOT_INT) {
2595 /* UV and NV both imprecise. */
2596 } else {
66a1b24b 2597 const UV nv_as_uv = U_V(nv);
c2988b20
NC
2598
2599 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2600 SvNOK_on(sv);
c2988b20 2601 }
00b6aa41 2602 SvIOK_on(sv);
c2988b20
NC
2603 }
2604 }
2605 }
2606 }
2607 }
a43d94f2
NC
2608 /* It might be more code efficient to go through the entire logic above
2609 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2610 gets complex and potentially buggy, so more programmer efficient
2611 to do it this way, by turning off the public flags: */
2612 if (!numtype)
2613 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
28e5dec8 2614#endif /* NV_PRESERVES_UV */
93a17b20 2615 }
79072805 2616 else {
f7877b28 2617 if (isGV_with_GP(sv)) {
159b6efe 2618 glob_2number(MUTABLE_GV(sv));
180488f8
NC
2619 return 0.0;
2620 }
2621
041457d9 2622 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
29489e7c 2623 report_uninit(sv);
7e25a7e9
NC
2624 assert (SvTYPE(sv) >= SVt_NV);
2625 /* Typically the caller expects that sv_any is not NULL now. */
2626 /* XXX Ilya implies that this is a bug in callers that assume this
2627 and ideally should be fixed. */
a0d0e21e 2628 return 0.0;
79072805 2629 }
572bbb43 2630#if defined(USE_LONG_DOUBLE)
097ee67d 2631 DEBUG_c({
f93f4e46 2632 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
2633 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2634 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
2635 RESTORE_NUMERIC_LOCAL();
2636 });
65202027 2637#else
572bbb43 2638 DEBUG_c({
f93f4e46 2639 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 2640 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
1d7c1841 2641 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
2642 RESTORE_NUMERIC_LOCAL();
2643 });
572bbb43 2644#endif
463ee0b2 2645 return SvNVX(sv);
79072805
LW
2646}
2647
800401ee
JH
2648/*
2649=for apidoc sv_2num
2650
2651Return an SV with the numeric value of the source SV, doing any necessary
a196a5fa
JH
2652reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2653access this function.
800401ee
JH
2654
2655=cut
2656*/
2657
2658SV *
5de3775c 2659Perl_sv_2num(pTHX_ register SV *const sv)
800401ee 2660{
7918f24d
NC
2661 PERL_ARGS_ASSERT_SV_2NUM;
2662
b9ee0594
RGS
2663 if (!SvROK(sv))
2664 return sv;
800401ee 2665 if (SvAMAGIC(sv)) {
31d632c3 2666 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
a02ec77a 2667 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
800401ee
JH
2668 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2669 return sv_2num(tmpsv);
2670 }
2671 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2672}
2673
645c22ef
DM
2674/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2675 * UV as a string towards the end of buf, and return pointers to start and
2676 * end of it.
2677 *
2678 * We assume that buf is at least TYPE_CHARS(UV) long.
2679 */
2680
864dbfa3 2681static char *
5de3775c 2682S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
25da4f38 2683{
25da4f38 2684 char *ptr = buf + TYPE_CHARS(UV);
823a54a3 2685 char * const ebuf = ptr;
25da4f38 2686 int sign;
25da4f38 2687
7918f24d
NC
2688 PERL_ARGS_ASSERT_UIV_2BUF;
2689
25da4f38
IZ
2690 if (is_uv)
2691 sign = 0;
2692 else if (iv >= 0) {
2693 uv = iv;
2694 sign = 0;
2695 } else {
2696 uv = -iv;
2697 sign = 1;
2698 }
2699 do {
eb160463 2700 *--ptr = '0' + (char)(uv % 10);
25da4f38
IZ
2701 } while (uv /= 10);
2702 if (sign)
2703 *--ptr = '-';
2704 *peob = ebuf;
2705 return ptr;
2706}
2707
645c22ef
DM
2708/*
2709=for apidoc sv_2pv_flags
2710
ff276b08 2711Returns a pointer to the string value of an SV, and sets *lp to its length.
645c22ef
DM
2712If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2713if necessary.
2714Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2715usually end up here too.
2716
2717=cut
2718*/
2719
8d6d96c1 2720char *
5de3775c 2721Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
8d6d96c1 2722{
97aff369 2723 dVAR;
79072805 2724 register char *s;
79072805 2725
463ee0b2 2726 if (!sv) {
cdb061a3
NC
2727 if (lp)
2728 *lp = 0;
73d840c0 2729 return (char *)"";
463ee0b2 2730 }
8990e307 2731 if (SvGMAGICAL(sv)) {
8d6d96c1
HS
2732 if (flags & SV_GMAGIC)
2733 mg_get(sv);
463ee0b2 2734 if (SvPOKp(sv)) {
cdb061a3
NC
2735 if (lp)
2736 *lp = SvCUR(sv);
10516c54
NC
2737 if (flags & SV_MUTABLE_RETURN)
2738 return SvPVX_mutable(sv);
4d84ee25
NC
2739 if (flags & SV_CONST_RETURN)
2740 return (char *)SvPVX_const(sv);
463ee0b2
LW
2741 return SvPVX(sv);
2742 }
75dfc8ec
NC
2743 if (SvIOKp(sv) || SvNOKp(sv)) {
2744 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
75dfc8ec
NC
2745 STRLEN len;
2746
2747 if (SvIOKp(sv)) {
e80fed9d 2748 len = SvIsUV(sv)
d9fad198
JH
2749 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2750 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
29912d93
NC
2751 } else if(SvNVX(sv) == 0.0) {
2752 tbuf[0] = '0';
2753 tbuf[1] = 0;
2754 len = 1;
75dfc8ec 2755 } else {
e8ada2d0
NC
2756 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2757 len = strlen(tbuf);
75dfc8ec 2758 }
b5b886f0
NC
2759 assert(!SvROK(sv));
2760 {
75dfc8ec
NC
2761 dVAR;
2762
75dfc8ec
NC
2763 SvUPGRADE(sv, SVt_PV);
2764 if (lp)
2765 *lp = len;
2766 s = SvGROW_mutable(sv, len + 1);
2767 SvCUR_set(sv, len);
2768 SvPOKp_on(sv);
10edeb5d 2769 return (char*)memcpy(s, tbuf, len + 1);
75dfc8ec 2770 }
463ee0b2 2771 }
1c7ff15e
NC
2772 if (SvROK(sv)) {
2773 goto return_rok;
2774 }
2775 assert(SvTYPE(sv) >= SVt_PVMG);
2776 /* This falls through to the report_uninit near the end of the
2777 function. */
2778 } else if (SvTHINKFIRST(sv)) {
ed6116ce 2779 if (SvROK(sv)) {
1c7ff15e 2780 return_rok:
deb46114 2781 if (SvAMAGIC(sv)) {
aee036bb
DM
2782 SV *tmpstr;
2783 if (flags & SV_SKIP_OVERLOAD)
2784 return NULL;
31d632c3 2785 tmpstr = AMG_CALLunary(sv, string_amg);
a02ec77a 2786 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
deb46114
NC
2787 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2788 /* Unwrap this: */
2789 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2790 */
2791
2792 char *pv;
2793 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2794 if (flags & SV_CONST_RETURN) {
2795 pv = (char *) SvPVX_const(tmpstr);
2796 } else {
2797 pv = (flags & SV_MUTABLE_RETURN)
2798 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2799 }
2800 if (lp)
2801 *lp = SvCUR(tmpstr);
50adf7d2 2802 } else {
deb46114 2803 pv = sv_2pv_flags(tmpstr, lp, flags);
50adf7d2 2804 }
deb46114
NC
2805 if (SvUTF8(tmpstr))
2806 SvUTF8_on(sv);
2807 else
2808 SvUTF8_off(sv);
2809 return pv;
50adf7d2 2810 }
deb46114
NC
2811 }
2812 {
fafee734
NC
2813 STRLEN len;
2814 char *retval;
2815 char *buffer;
d2c6dc5e 2816 SV *const referent = SvRV(sv);
d8eae41e
NC
2817
2818 if (!referent) {
fafee734
NC
2819 len = 7;
2820 retval = buffer = savepvn("NULLREF", len);
5c35adbb 2821 } else if (SvTYPE(referent) == SVt_REGEXP) {
d2c6dc5e 2822 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
67d2d14d
AB
2823 I32 seen_evals = 0;
2824
2825 assert(re);
2826
2827 /* If the regex is UTF-8 we want the containing scalar to
2828 have an UTF-8 flag too */
2829 if (RX_UTF8(re))
2830 SvUTF8_on(sv);
2831 else
2832 SvUTF8_off(sv);
2833
2834 if ((seen_evals = RX_SEEN_EVALS(re)))
2835 PL_reginterp_cnt += seen_evals;
2836
2837 if (lp)
2838 *lp = RX_WRAPLEN(re);
2839
2840 return RX_WRAPPED(re);
d8eae41e
NC
2841 } else {
2842 const char *const typestr = sv_reftype(referent, 0);
fafee734
NC
2843 const STRLEN typelen = strlen(typestr);
2844 UV addr = PTR2UV(referent);
2845 const char *stashname = NULL;
2846 STRLEN stashnamelen = 0; /* hush, gcc */
2847 const char *buffer_end;
d8eae41e 2848
d8eae41e 2849 if (SvOBJECT(referent)) {
fafee734
NC
2850 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2851
2852 if (name) {
2853 stashname = HEK_KEY(name);
2854 stashnamelen = HEK_LEN(name);
2855
2856 if (HEK_UTF8(name)) {
2857 SvUTF8_on(sv);
2858 } else {
2859 SvUTF8_off(sv);
2860 }
2861 } else {
2862 stashname = "__ANON__";
2863 stashnamelen = 8;
2864 }
2865 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2866 + 2 * sizeof(UV) + 2 /* )\0 */;
2867 } else {
2868 len = typelen + 3 /* (0x */
2869 + 2 * sizeof(UV) + 2 /* )\0 */;
d8eae41e 2870 }
fafee734
NC
2871
2872 Newx(buffer, len, char);
2873 buffer_end = retval = buffer + len;
2874
2875 /* Working backwards */
2876 *--retval = '\0';
2877 *--retval = ')';
2878 do {
2879 *--retval = PL_hexdigit[addr & 15];
2880 } while (addr >>= 4);
2881 *--retval = 'x';
2882 *--retval = '0';
2883 *--retval = '(';
2884
2885 retval -= typelen;
2886 memcpy(retval, typestr, typelen);
2887
2888 if (stashname) {
2889 *--retval = '=';
2890 retval -= stashnamelen;
2891 memcpy(retval, stashname, stashnamelen);
2892 }
2893 /* retval may not neccesarily have reached the start of the
2894 buffer here. */
2895 assert (retval >= buffer);
2896
2897 len = buffer_end - retval - 1; /* -1 for that \0 */
c080367d 2898 }
042dae7a 2899 if (lp)
fafee734
NC
2900 *lp = len;
2901 SAVEFREEPV(buffer);
2902 return retval;
463ee0b2 2903 }
79072805 2904 }
0336b60e 2905 if (SvREADONLY(sv) && !SvOK(sv)) {
cdb061a3
NC
2906 if (lp)
2907 *lp = 0;
9f621bb0
NC
2908 if (flags & SV_UNDEF_RETURNS_NULL)
2909 return NULL;
2910 if (ckWARN(WARN_UNINITIALIZED))
2911 report_uninit(sv);
73d840c0 2912 return (char *)"";
79072805 2913 }
79072805 2914 }
28e5dec8
JH
2915 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2916 /* I'm assuming that if both IV and NV are equally valid then
2917 converting the IV is going to be more efficient */
e1ec3a88 2918 const U32 isUIOK = SvIsUV(sv);
28e5dec8
JH
2919 char buf[TYPE_CHARS(UV)];
2920 char *ebuf, *ptr;
97a130b8 2921 STRLEN len;
28e5dec8
JH
2922
2923 if (SvTYPE(sv) < SVt_PVIV)
2924 sv_upgrade(sv, SVt_PVIV);
4ea1d550 2925 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
97a130b8 2926 len = ebuf - ptr;
5902b6a9 2927 /* inlined from sv_setpvn */
97a130b8
NC
2928 s = SvGROW_mutable(sv, len + 1);
2929 Move(ptr, s, len, char);
2930 s += len;
28e5dec8 2931 *s = '\0';
28e5dec8
JH
2932 }
2933 else if (SvNOKp(sv)) {
79072805
LW
2934 if (SvTYPE(sv) < SVt_PVNV)
2935 sv_upgrade(sv, SVt_PVNV);
29912d93
NC
2936 if (SvNVX(sv) == 0.0) {
2937 s = SvGROW_mutable(sv, 2);
2938 *s++ = '0';
2939 *s = '\0';
2940 } else {
2941 dSAVE_ERRNO;
2942 /* The +20 is pure guesswork. Configure test needed. --jhi */
2943 s = SvGROW_mutable(sv, NV_DIG + 20);
2944 /* some Xenix systems wipe out errno here */
2d4389e4 2945 Gconvert(SvNVX(sv), NV_DIG, 0, s);
29912d93
NC
2946 RESTORE_ERRNO;
2947 while (*s) s++;
bbce6d69 2948 }
79072805
LW
2949#ifdef hcx
2950 if (s[-1] == '.')
46fc3d4c 2951 *--s = '\0';
79072805
LW
2952#endif
2953 }
79072805 2954 else {
8d1c3e26
NC
2955 if (isGV_with_GP(sv)) {
2956 GV *const gv = MUTABLE_GV(sv);
2957 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2958 SV *const buffer = sv_newmortal();
2959
2960 /* FAKE globs can get coerced, so need to turn this off temporarily
2961 if it is on. */
2962 SvFAKE_off(gv);
2963 gv_efullname3(buffer, gv, "*");
2964 SvFLAGS(gv) |= wasfake;
2965
1809c940
DM
2966 if (SvPOK(buffer)) {
2967 if (lp) {
2968 *lp = SvCUR(buffer);
2969 }
2970 return SvPVX(buffer);
2971 }
2972 else {
2973 if (lp)
2974 *lp = 0;
2975 return (char *)"";
8d1c3e26 2976 }
8d1c3e26 2977 }
180488f8 2978
cdb061a3 2979 if (lp)
00b6aa41 2980 *lp = 0;
9f621bb0
NC
2981 if (flags & SV_UNDEF_RETURNS_NULL)
2982 return NULL;
2983 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2984 report_uninit(sv);
25da4f38
IZ
2985 if (SvTYPE(sv) < SVt_PV)
2986 /* Typically the caller expects that sv_any is not NULL now. */
2987 sv_upgrade(sv, SVt_PV);
73d840c0 2988 return (char *)"";
79072805 2989 }
cdb061a3 2990 {
823a54a3 2991 const STRLEN len = s - SvPVX_const(sv);
cdb061a3
NC
2992 if (lp)
2993 *lp = len;
2994 SvCUR_set(sv, len);
2995 }
79072805 2996 SvPOK_on(sv);
1d7c1841 2997 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3f7c398e 2998 PTR2UV(sv),SvPVX_const(sv)));
4d84ee25
NC
2999 if (flags & SV_CONST_RETURN)
3000 return (char *)SvPVX_const(sv);
10516c54
NC
3001 if (flags & SV_MUTABLE_RETURN)
3002 return SvPVX_mutable(sv);
463ee0b2
LW
3003 return SvPVX(sv);
3004}
3005
645c22ef 3006/*
6050d10e
JP
3007=for apidoc sv_copypv
3008
3009Copies a stringified representation of the source SV into the
3010destination SV. Automatically performs any necessary mg_get and
54f0641b 3011coercion of numeric values into strings. Guaranteed to preserve
2575c402 3012UTF8 flag even from overloaded objects. Similar in nature to
54f0641b
NIS
3013sv_2pv[_flags] but operates directly on an SV instead of just the
3014string. Mostly uses sv_2pv_flags to do its work, except when that
6050d10e
JP
3015would lose the UTF-8'ness of the PV.
3016
3017=cut
3018*/
3019
3020void
5de3775c 3021Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
6050d10e 3022{
446eaa42 3023 STRLEN len;
53c1dcc0 3024 const char * const s = SvPV_const(ssv,len);
7918f24d
NC
3025
3026 PERL_ARGS_ASSERT_SV_COPYPV;
3027
cb50f42d 3028 sv_setpvn(dsv,s,len);
446eaa42 3029 if (SvUTF8(ssv))
cb50f42d 3030 SvUTF8_on(dsv);
446eaa42 3031 else
cb50f42d 3032 SvUTF8_off(dsv);
6050d10e
JP
3033}
3034
3035/*
645c22ef
DM
3036=for apidoc sv_2pvbyte
3037
3038Return a pointer to the byte-encoded representation of the SV, and set *lp
1e54db1a 3039to its length. May cause the SV to be downgraded from UTF-8 as a
645c22ef
DM
3040side-effect.
3041
3042Usually accessed via the C<SvPVbyte> macro.
3043
3044=cut
3045*/
3046
7340a771 3047char *
5de3775c 3048Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
7340a771 3049{
7918f24d
NC
3050 PERL_ARGS_ASSERT_SV_2PVBYTE;
3051
71eb6d8c 3052 SvGETMAGIC(sv);
0875d2fe 3053 sv_utf8_downgrade(sv,0);
71eb6d8c 3054 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
7340a771
GS
3055}
3056
645c22ef 3057/*
035cbb0e
RGS
3058=for apidoc sv_2pvutf8
3059
3060Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3061to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3062
3063Usually accessed via the C<SvPVutf8> macro.
3064
3065=cut
3066*/
645c22ef 3067
7340a771 3068char *
7bc54cea 3069Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
7340a771 3070{
7918f24d
NC
3071 PERL_ARGS_ASSERT_SV_2PVUTF8;
3072
035cbb0e
RGS
3073 sv_utf8_upgrade(sv);
3074 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
7340a771 3075}
1c846c1f 3076
7ee2227d 3077
645c22ef
DM
3078/*
3079=for apidoc sv_2bool
3080
06c841cf
FC
3081This macro is only used by sv_true() or its macro equivalent, and only if
3082the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3083It calls sv_2bool_flags with the SV_GMAGIC flag.
3084
3085=for apidoc sv_2bool_flags
3086
3087This function is only used by sv_true() and friends, and only if
3088the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3089contain SV_GMAGIC, then it does an mg_get() first.
3090
645c22ef
DM
3091
3092=cut
3093*/
3094
463ee0b2 3095bool
06c841cf 3096Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
463ee0b2 3097{
97aff369 3098 dVAR;
7918f24d 3099
06c841cf 3100 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
7918f24d 3101
06c841cf 3102 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
463ee0b2 3103
a0d0e21e
LW
3104 if (!SvOK(sv))
3105 return 0;
3106 if (SvROK(sv)) {
fabdb6c0 3107 if (SvAMAGIC(sv)) {
31d632c3 3108 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
fabdb6c0 3109 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
f2338a2e 3110 return cBOOL(SvTRUE(tmpsv));
fabdb6c0
AL
3111 }
3112 return SvRV(sv) != 0;
a0d0e21e 3113 }
463ee0b2 3114 if (SvPOKp(sv)) {
53c1dcc0
AL
3115 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3116 if (Xpvtmp &&
339049b0 3117 (*sv->sv_u.svu_pv > '0' ||
11343788 3118 Xpvtmp->xpv_cur > 1 ||
339049b0 3119 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
463ee0b2
LW
3120 return 1;
3121 else
3122 return 0;
3123 }
3124 else {
3125 if (SvIOKp(sv))
3126 return SvIVX(sv) != 0;
3127 else {
3128 if (SvNOKp(sv))
3129 return SvNVX(sv) != 0.0;
180488f8 3130 else {
f7877b28 3131 if (isGV_with_GP(sv))
180488f8
NC
3132 return TRUE;
3133 else
3134 return FALSE;
3135 }
463ee0b2
LW
3136 }
3137 }
79072805
LW
3138}
3139
c461cf8f
JH
3140/*
3141=for apidoc sv_utf8_upgrade
3142
78ea37eb 3143Converts the PV of an SV to its UTF-8-encoded form.
645c22ef 3144Forces the SV to string form if it is not already.
2bbc8d55 3145Will C<mg_get> on C<sv> if appropriate.
4411f3b6 3146Always sets the SvUTF8 flag to avoid future validity checks even
2bbc8d55
SP
3147if the whole string is the same in UTF-8 as not.
3148Returns the number of bytes in the converted string
c461cf8f 3149
13a6c0e0
JH
3150This is not as a general purpose byte encoding to Unicode interface:
3151use the Encode extension for that.
3152
fe749c9a
KW
3153=for apidoc sv_utf8_upgrade_nomg
3154
3155Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3156
8d6d96c1
HS
3157=for apidoc sv_utf8_upgrade_flags
3158
78ea37eb 3159Converts the PV of an SV to its UTF-8-encoded form.
645c22ef 3160Forces the SV to string form if it is not already.
8d6d96c1 3161Always sets the SvUTF8 flag to avoid future validity checks even
2bbc8d55
SP
3162if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3163will C<mg_get> on C<sv> if appropriate, else not.
3164Returns the number of bytes in the converted string
3165C<sv_utf8_upgrade> and
8d6d96c1
HS
3166C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3167
13a6c0e0
JH
3168This is not as a general purpose byte encoding to Unicode interface:
3169use the Encode extension for that.
3170
8d6d96c1 3171=cut
b3ab6785
KW
3172
3173The grow version is currently not externally documented. It adds a parameter,
3174extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3175have free after it upon return. This allows the caller to reserve extra space
3176that it intends to fill, to avoid extra grows.
3177
3178Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3179which can be used to tell this function to not first check to see if there are
3180any characters that are different in UTF-8 (variant characters) which would
3181force it to allocate a new string to sv, but to assume there are. Typically
3182this flag is used by a routine that has already parsed the string to find that
3183there are such characters, and passes this information on so that the work
3184doesn't have to be repeated.
3185
3186(One might think that the calling routine could pass in the position of the
3187first such variant, so it wouldn't have to be found again. But that is not the
3188case, because typically when the caller is likely to use this flag, it won't be
3189calling this routine unless it finds something that won't fit into a byte.
3190Otherwise it tries to not upgrade and just use bytes. But some things that
3191do fit into a byte are variants in utf8, and the caller may not have been
3192keeping track of these.)
3193
3194If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3195isn't guaranteed due to having other routines do the work in some input cases,
3196or if the input is already flagged as being in utf8.
3197
3198The speed of this could perhaps be improved for many cases if someone wanted to
3199write a fast function that counts the number of variant characters in a string,
3200especially if it could return the position of the first one.
3201
8d6d96c1
HS
3202*/
3203
3204STRLEN
b3ab6785 3205Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
8d6d96c1 3206{
97aff369 3207 dVAR;
7918f24d 3208
b3ab6785 3209 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
7918f24d 3210
808c356f
RGS
3211 if (sv == &PL_sv_undef)
3212 return 0;
e0e62c2a
NIS
3213 if (!SvPOK(sv)) {
3214 STRLEN len = 0;
d52b7888
NC
3215 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3216 (void) sv_2pv_flags(sv,&len, flags);
b3ab6785
KW
3217 if (SvUTF8(sv)) {
3218 if (extra) SvGROW(sv, SvCUR(sv) + extra);
d52b7888 3219 return len;
b3ab6785 3220 }
d52b7888
NC
3221 } else {
3222 (void) SvPV_force(sv,len);
3223 }
e0e62c2a 3224 }
4411f3b6 3225
f5cee72b 3226 if (SvUTF8(sv)) {
b3ab6785 3227 if (extra) SvGROW(sv, SvCUR(sv) + extra);
5fec3b1d 3228 return SvCUR(sv);
f5cee72b 3229 }
5fec3b1d 3230
765f542d
NC
3231 if (SvIsCOW(sv)) {
3232 sv_force_normal_flags(sv, 0);
db42d148
NIS
3233 }
3234
b3ab6785 3235 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
799ef3cb 3236 sv_recode_to_utf8(sv, PL_encoding);
b3ab6785
KW
3237 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3238 return SvCUR(sv);
3239 }
3240
4e93345f
KW
3241 if (SvCUR(sv) == 0) {
3242 if (extra) SvGROW(sv, extra);
3243 } else { /* Assume Latin-1/EBCDIC */
c4e7c712 3244 /* This function could be much more efficient if we
2bbc8d55 3245 * had a FLAG in SVs to signal if there are any variant
c4e7c712 3246 * chars in the PV. Given that there isn't such a flag
b3ab6785
KW
3247 * make the loop as fast as possible (although there are certainly ways
3248 * to speed this up, eg. through vectorization) */
3249 U8 * s = (U8 *) SvPVX_const(sv);
3250 U8 * e = (U8 *) SvEND(sv);
3251 U8 *t = s;
3252 STRLEN two_byte_count = 0;
c4e7c712 3253
b3ab6785
KW
3254 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3255
3256 /* See if really will need to convert to utf8. We mustn't rely on our
3257 * incoming SV being well formed and having a trailing '\0', as certain
3258 * code in pp_formline can send us partially built SVs. */
3259
c4e7c712 3260 while (t < e) {
53c1dcc0 3261 const U8 ch = *t++;
b3ab6785
KW
3262 if (NATIVE_IS_INVARIANT(ch)) continue;
3263
3264 t--; /* t already incremented; re-point to first variant */
3265 two_byte_count = 1;
3266 goto must_be_utf8;
c4e7c712 3267 }
b3ab6785
KW
3268
3269 /* utf8 conversion not needed because all are invariants. Mark as
3270 * UTF-8 even if no variant - saves scanning loop */
c4e7c712 3271 SvUTF8_on(sv);
b3ab6785
KW
3272 return SvCUR(sv);
3273
3274must_be_utf8:
3275
3276 /* Here, the string should be converted to utf8, either because of an
3277 * input flag (two_byte_count = 0), or because a character that
3278 * requires 2 bytes was found (two_byte_count = 1). t points either to
3279 * the beginning of the string (if we didn't examine anything), or to
3280 * the first variant. In either case, everything from s to t - 1 will
3281 * occupy only 1 byte each on output.
3282 *
3283 * There are two main ways to convert. One is to create a new string
3284 * and go through the input starting from the beginning, appending each
3285 * converted value onto the new string as we go along. It's probably
3286 * best to allocate enough space in the string for the worst possible
3287 * case rather than possibly running out of space and having to
3288 * reallocate and then copy what we've done so far. Since everything
3289 * from s to t - 1 is invariant, the destination can be initialized
3290 * with these using a fast memory copy
3291 *
3292 * The other way is to figure out exactly how big the string should be
3293 * by parsing the entire input. Then you don't have to make it big
3294 * enough to handle the worst possible case, and more importantly, if
3295 * the string you already have is large enough, you don't have to
3296 * allocate a new string, you can copy the last character in the input
3297 * string to the final position(s) that will be occupied by the
3298 * converted string and go backwards, stopping at t, since everything
3299 * before that is invariant.
3300 *
3301 * There are advantages and disadvantages to each method.
3302 *
3303 * In the first method, we can allocate a new string, do the memory
3304 * copy from the s to t - 1, and then proceed through the rest of the
3305 * string byte-by-byte.
3306 *
3307 * In the second method, we proceed through the rest of the input
3308 * string just calculating how big the converted string will be. Then
3309 * there are two cases:
3310 * 1) if the string has enough extra space to handle the converted
3311 * value. We go backwards through the string, converting until we
3312 * get to the position we are at now, and then stop. If this
3313 * position is far enough along in the string, this method is
3314 * faster than the other method. If the memory copy were the same
3315 * speed as the byte-by-byte loop, that position would be about
3316 * half-way, as at the half-way mark, parsing to the end and back
3317 * is one complete string's parse, the same amount as starting
3318 * over and going all the way through. Actually, it would be
3319 * somewhat less than half-way, as it's faster to just count bytes
3320 * than to also copy, and we don't have the overhead of allocating
3321 * a new string, changing the scalar to use it, and freeing the
3322 * existing one. But if the memory copy is fast, the break-even
3323 * point is somewhere after half way. The counting loop could be
3324 * sped up by vectorization, etc, to move the break-even point
3325 * further towards the beginning.
3326 * 2) if the string doesn't have enough space to handle the converted
3327 * value. A new string will have to be allocated, and one might
3328 * as well, given that, start from the beginning doing the first
3329 * method. We've spent extra time parsing the string and in
3330 * exchange all we've gotten is that we know precisely how big to
3331 * make the new one. Perl is more optimized for time than space,
3332 * so this case is a loser.
3333 * So what I've decided to do is not use the 2nd method unless it is
3334 * guaranteed that a new string won't have to be allocated, assuming
3335 * the worst case. I also decided not to put any more conditions on it
3336 * than this, for now. It seems likely that, since the worst case is
3337 * twice as big as the unknown portion of the string (plus 1), we won't
3338 * be guaranteed enough space, causing us to go to the first method,
3339 * unless the string is short, or the first variant character is near
3340 * the end of it. In either of these cases, it seems best to use the
3341 * 2nd method. The only circumstance I can think of where this would
3342 * be really slower is if the string had once had much more data in it
3343 * than it does now, but there is still a substantial amount in it */
3344
3345 {
3346 STRLEN invariant_head = t - s;
3347 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3348 if (SvLEN(sv) < size) {
3349
3350 /* Here, have decided to allocate a new string */
3351
3352 U8 *dst;
3353 U8 *d;
3354
3355 Newx(dst, size, U8);
3356
3357 /* If no known invariants at the beginning of the input string,
3358 * set so starts from there. Otherwise, can use memory copy to
3359 * get up to where we are now, and then start from here */
3360
3361 if (invariant_head <= 0) {
3362 d = dst;
3363 } else {
3364 Copy(s, dst, invariant_head, char);
3365 d = dst + invariant_head;
3366 }
3367
3368 while (t < e) {
3369 const UV uv = NATIVE8_TO_UNI(*t++);
3370 if (UNI_IS_INVARIANT(uv))
3371 *d++ = (U8)UNI_TO_NATIVE(uv);
3372 else {
3373 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3374 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3375 }
3376 }
3377 *d = '\0';
3378 SvPV_free(sv); /* No longer using pre-existing string */
3379 SvPV_set(sv, (char*)dst);
3380 SvCUR_set(sv, d - dst);
3381 SvLEN_set(sv, size);
3382 } else {
3383
3384 /* Here, have decided to get the exact size of the string.
3385 * Currently this happens only when we know that there is
3386 * guaranteed enough space to fit the converted string, so
3387 * don't have to worry about growing. If two_byte_count is 0,
3388 * then t points to the first byte of the string which hasn't
3389 * been examined yet. Otherwise two_byte_count is 1, and t
3390 * points to the first byte in the string that will expand to
3391 * two. Depending on this, start examining at t or 1 after t.
3392 * */
3393
3394 U8 *d = t + two_byte_count;
3395
3396
3397 /* Count up the remaining bytes that expand to two */
3398
3399 while (d < e) {
3400 const U8 chr = *d++;
3401 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3402 }
3403
3404 /* The string will expand by just the number of bytes that
3405 * occupy two positions. But we are one afterwards because of
3406 * the increment just above. This is the place to put the
3407 * trailing NUL, and to set the length before we decrement */
3408
3409 d += two_byte_count;
3410 SvCUR_set(sv, d - s);
3411 *d-- = '\0';
3412
3413
3414 /* Having decremented d, it points to the position to put the
3415 * very last byte of the expanded string. Go backwards through
3416 * the string, copying and expanding as we go, stopping when we
3417 * get to the part that is invariant the rest of the way down */
3418
3419 e--;
3420 while (e >= t) {
3421 const U8 ch = NATIVE8_TO_UNI(*e--);
3422 if (UNI_IS_INVARIANT(ch)) {
3423 *d-- = UNI_TO_NATIVE(ch);
3424 } else {
3425 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3426 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3427 }
3428 }
3429 }
3430 }
560a288e 3431 }
b3ab6785
KW
3432
3433 /* Mark as UTF-8 even if no variant - saves scanning loop */
3434 SvUTF8_on(sv);
4411f3b6 3435 return SvCUR(sv);
560a288e
GS
3436}
3437
c461cf8f
JH
3438/*
3439=for apidoc sv_utf8_downgrade
3440
78ea37eb 3441Attempts to convert the PV of an SV from characters to bytes.
2bbc8d55
SP
3442If the PV contains a character that cannot fit
3443in a byte, this conversion will fail;
78ea37eb 3444in this case, either returns false or, if C<fail_ok> is not
c461cf8f
JH
3445true, croaks.
3446
13a6c0e0
JH
3447This is not as a general purpose Unicode to byte encoding interface:
3448use the Encode extension for that.
3449
c461cf8f
JH
3450=cut
3451*/
3452
560a288e 3453bool
7bc54cea 3454Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
560a288e 3455{
97aff369 3456 dVAR;
7918f24d
NC
3457
3458 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3459
78ea37eb 3460 if (SvPOKp(sv) && SvUTF8(sv)) {
fa301091 3461 if (SvCUR(sv)) {
03cfe0ae 3462 U8 *s;
652088fc 3463 STRLEN len;
fa301091 3464
765f542d
NC
3465 if (SvIsCOW(sv)) {
3466 sv_force_normal_flags(sv, 0);
3467 }
03cfe0ae
NIS
3468 s = (U8 *) SvPV(sv, len);
3469 if (!utf8_to_bytes(s, &len)) {
fa301091
JH
3470 if (fail_ok)
3471 return FALSE;
3472 else {
3473 if (PL_op)
3474 Perl_croak(aTHX_ "Wide character in %s",
53e06cf0 3475 OP_DESC(PL_op));
fa301091
JH
3476 else
3477 Perl_croak(aTHX_ "Wide character");
3478 }
4b3603a4 3479 }
b162af07 3480 SvCUR_set(sv, len);
67e989fb 3481 }
560a288e 3482 }
ffebcc3e 3483 SvUTF8_off(sv);
560a288e
GS
3484 return TRUE;
3485}
3486
c461cf8f
JH
3487/*
3488=for apidoc sv_utf8_encode
3489
78ea37eb
TS
3490Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3491flag off so that it looks like octets again.
c461cf8f
JH
3492
3493=cut
3494*/
3495
560a288e 3496void
7bc54cea 3497Perl_sv_utf8_encode(pTHX_ register SV *const sv)
560a288e 3498{
7918f24d
NC
3499 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3500
4c94c214
NC
3501 if (SvIsCOW(sv)) {
3502 sv_force_normal_flags(sv, 0);
3503 }
3504 if (SvREADONLY(sv)) {
6ad8f254 3505 Perl_croak_no_modify(aTHX);
4c94c214 3506 }
a5f5288a 3507 (void) sv_utf8_upgrade(sv);
560a288e
GS
3508 SvUTF8_off(sv);
3509}
3510
4411f3b6
NIS
3511/*
3512=for apidoc sv_utf8_decode
3513
78ea37eb
TS
3514If the PV of the SV is an octet sequence in UTF-8
3515and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3516so that it looks like a character. If the PV contains only single-byte
3517characters, the C<SvUTF8> flag stays being off.
3518Scans PV for validity and returns false if the PV is invalid UTF-8.
4411f3b6
NIS
3519
3520=cut
3521*/
3522
560a288e 3523bool
7bc54cea 3524Perl_sv_utf8_decode(pTHX_ register SV *const sv)
560a288e 3525{
7918f24d
NC
3526 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3527
78ea37eb 3528 if (SvPOKp(sv)) {
93524f2b
NC
3529 const U8 *c;
3530 const U8 *e;
9cbac4c7 3531
645c22ef
DM
3532 /* The octets may have got themselves encoded - get them back as
3533 * bytes
3534 */
3535 if (!sv_utf8_downgrade(sv, TRUE))
560a288e
GS
3536 return FALSE;
3537
3538 /* it is actually just a matter of turning the utf8 flag on, but
3539 * we want to make sure everything inside is valid utf8 first.
3540 */
93524f2b 3541 c = (const U8 *) SvPVX_const(sv);
63cd0674 3542 if (!is_utf8_string(c, SvCUR(sv)+1))
67e989fb 3543 return FALSE;
93524f2b 3544 e = (const U8 *) SvEND(sv);
511c2ff0 3545 while (c < e) {
b64e5050 3546 const U8 ch = *c++;
c4d5f83a 3547 if (!UTF8_IS_INVARIANT(ch)) {
67e989fb
JH
3548 SvUTF8_on(sv);
3549 break;
3550 }
560a288e 3551 }
560a288e
GS
3552 }
3553 return TRUE;
3554}
3555
954c1994
GS
3556/*
3557=for apidoc sv_setsv
3558
645c22ef
DM
3559Copies the contents of the source SV C<ssv> into the destination SV
3560C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3561function if the source SV needs to be reused. Does not handle 'set' magic.
3562Loosely speaking, it performs a copy-by-value, obliterating any previous
3563content of the destination.
3564
3565You probably want to use one of the assortment of wrappers, such as
3566C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3567C<SvSetMagicSV_nosteal>.
3568
8d6d96c1
HS
3569=for apidoc sv_setsv_flags
3570
645c22ef
DM
3571Copies the contents of the source SV C<ssv> into the destination SV
3572C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3573function if the source SV needs to be reused. Does not handle 'set' magic.
3574Loosely speaking, it performs a copy-by-value, obliterating any previous
3575content of the destination.
3576If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5fcdf167
NC
3577C<ssv> if appropriate, else not. If the C<flags> parameter has the
3578C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3579and C<sv_setsv_nomg> are implemented in terms of this function.
645c22ef
DM
3580
3581You probably want to use one of the assortment of wrappers, such as
3582C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3583C<SvSetMagicSV_nosteal>.
3584
3585This is the primary function for copying scalars, and most other
3586copy-ish functions and macros use this underneath.
8d6d96c1
HS
3587
3588=cut
3589*/
3590
5d0301b7 3591static void
7bc54cea 3592S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
5d0301b7 3593{
c8bbf675 3594 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3e6edce2 3595 HV *old_stash = NULL;
dd69841b 3596
7918f24d
NC
3597 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3598
bec4f4b4 3599 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
5d0301b7
NC
3600 const char * const name = GvNAME(sstr);
3601 const STRLEN len = GvNAMELEN(sstr);
0d092c36 3602 {
f7877b28
NC
3603 if (dtype >= SVt_PV) {
3604 SvPV_free(dstr);
3605 SvPV_set(dstr, 0);
3606 SvLEN_set(dstr, 0);
3607 SvCUR_set(dstr, 0);
3608 }
0d092c36 3609 SvUPGRADE(dstr, SVt_PVGV);
dedf8e73 3610 (void)SvOK_off(dstr);
2e5b91de
NC
3611 /* FIXME - why are we doing this, then turning it off and on again
3612 below? */
3613 isGV_with_GP_on(dstr);
f7877b28 3614 }
5d0301b7
NC
3615 GvSTASH(dstr) = GvSTASH(sstr);
3616 if (GvSTASH(dstr))
daba3364 3617 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
159b6efe 3618 gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
5d0301b7
NC
3619 SvFAKE_on(dstr); /* can coerce to non-glob */
3620 }
3621
159b6efe 3622 if(GvGP(MUTABLE_GV(sstr))) {
dd69841b
BB
3623 /* If source has method cache entry, clear it */
3624 if(GvCVGEN(sstr)) {
3625 SvREFCNT_dec(GvCV(sstr));
3626 GvCV(sstr) = NULL;
3627 GvCVGEN(sstr) = 0;
3628 }
3629 /* If source has a real method, then a method is
3630 going to change */
00169e2c
FC
3631 else if(
3632 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3633 ) {
70cd14a1 3634 mro_changes = 1;
dd69841b
BB
3635 }
3636 }
3637
3638 /* If dest already had a real method, that's a change as well */
00169e2c
FC
3639 if(
3640 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3641 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3642 ) {
70cd14a1 3643 mro_changes = 1;
dd69841b
BB
3644 }
3645
c8bbf675
FC
3646 /* We don’t need to check the name of the destination if it was not a
3647 glob to begin with. */
3648 if(dtype == SVt_PVGV) {
3649 const char * const name = GvNAME((const GV *)dstr);
00169e2c
FC
3650 if(
3651 strEQ(name,"ISA")
3652 /* The stash may have been detached from the symbol table, so
3653 check its name. */
3654 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
6624142a 3655 && GvAV((const GV *)sstr)
00169e2c 3656 )
c8bbf675
FC
3657 mro_changes = 2;
3658 else {
3659 const STRLEN len = GvNAMELEN(dstr);
3660 if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
3661 mro_changes = 3;
3662
3663 /* Set aside the old stash, so we can reset isa caches on
3664 its subclasses. */