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