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