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