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