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