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