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