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