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