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