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