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