This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Pay attention to the comments that Dave writes.
[perl5.git] / sv.c
CommitLineData
a0d0e21e 1/* sv.c
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
241d1a3b 4 * 2000, 2001, 2002, 2003, 2004, 2005, 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
JH
32#ifdef PERL_UTF8_CACHE_ASSERT
33/* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
42 * --jhi
43 */
44#define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
46#else
47#define ASSERT_UTF8_CACHE(cache) NOOP
48#endif
49
f8c7b90f 50#ifdef PERL_OLD_COPY_ON_WRITE
765f542d 51#define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
607fa7f2 52#define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
b5ccf5f2 53/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
765f542d 54 on-write. */
765f542d 55#endif
645c22ef
DM
56
57/* ============================================================================
58
59=head1 Allocation and deallocation of SVs.
60
5e045b90
AMS
61An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62av, hv...) contains type and reference count information, as well as a
63pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64specific to each type.
65
4977e971
NC
66Normally, this allocation is done using arenas, which by default are
67approximately 4K chunks of memory parcelled up into N heads or bodies. The
68first slot in each arena is reserved, and is used to hold a link to the next
69arena. In the case of heads, the unused first slot also contains some flags
70and a note of the number of slots. Snaked through each arena chain is a
5e045b90 71linked list of free items; when this becomes empty, an extra arena is
4977e971 72allocated and divided up into N items which are threaded into the free list.
645c22ef
DM
73
74The following global variables are associated with arenas:
75
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
78
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
82
83Note that some of the larger and more rarely used body types (eg xpvio)
84are not allocated using arenas, but are instead just malloc()/free()ed as
85required. Also, if PURIFY is defined, arenas are abandoned altogether,
86with all items individually malloc()ed. In addition, a few SV heads are
87not allocated from an arena, but are instead directly created as static
4977e971
NC
88or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89the default by setting PERL_ARENA_SIZE appropriately at compile time.
645c22ef
DM
90
91The SV arena serves the secondary purpose of allowing still-live SVs
92to be located and destroyed during final cleanup.
93
94At the lowest level, the macros new_SV() and del_SV() grab and free
95an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96to return the SV to the free list with error checking.) new_SV() calls
97more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98SVs in the free list have their SvTYPE field set to all ones.
99
100Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101that allocate and return individual body types. Normally these are mapped
ff276b08
RG
102to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103instead mapped directly to malloc()/free() if PURIFY is defined. The
645c22ef
DM
104new/del functions remove from, or add to, the appropriate PL_foo_root
105list, and call more_xiv() etc to add a new arena if the list is empty.
106
ff276b08 107At the time of very final cleanup, sv_free_arenas() is called from
645c22ef
DM
108perl_destruct() to physically free all the arenas allocated since the
109start of the interpreter. Note that this also clears PL_he_arenaroot,
110which is otherwise dealt with in hv.c.
111
112Manipulation of any of the PL_*root pointers is protected by enclosing
113LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114if threads are enabled.
115
116The function visit() scans the SV arenas list, and calls a specified
117function for each SV it finds which is still live - ie which has an SvTYPE
118other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119following functions (specified as [function that calls visit()] / [function
120called by visit() for each SV]):
121
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
124
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
131 below.
132
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
142
143=head2 Summary
144
145Private API to rest of sv.c
146
147 new_SV(), del_SV(),
148
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
151 etc
152
153Public API:
154
8cf8f3d1 155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
645c22ef
DM
156
157
158=cut
159
160============================================================================ */
161
162
51371543 163
4561caa4
CS
164/*
165 * "A time to plant, and a time to uproot what was planted..."
166 */
167
cac9b346 168
fd0854ff
DM
169#ifdef DEBUG_LEAKING_SCALARS
170# ifdef NETWARE
171# define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
172# else
173# define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
174# endif
175#else
176# define FREE_SV_DEBUG_FILE(sv)
177#endif
178
053fc874
GS
179#define plant_SV(p) \
180 STMT_START { \
fd0854ff 181 FREE_SV_DEBUG_FILE(p); \
053fc874
GS
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
184 PL_sv_root = (p); \
185 --PL_sv_count; \
186 } STMT_END
a0d0e21e 187
fba3b22e 188/* sv_mutex must be held while calling uproot_SV() */
053fc874
GS
189#define uproot_SV(p) \
190 STMT_START { \
191 (p) = PL_sv_root; \
192 PL_sv_root = (SV*)SvANY(p); \
193 ++PL_sv_count; \
194 } STMT_END
195
645c22ef 196
cac9b346
NC
197/* make some more SVs by adding another arena */
198
199/* sv_mutex must be held while calling more_sv() */
200STATIC SV*
201S_more_sv(pTHX)
202{
203 SV* sv;
204
205 if (PL_nice_chunk) {
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
209 }
210 else {
211 char *chunk; /* must use New here to match call to */
2e7ed132
NC
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
cac9b346
NC
214 }
215 uproot_SV(sv);
216 return sv;
217}
218
645c22ef
DM
219/* new_SV(): return a new, empty SV head */
220
eba0f806
DM
221#ifdef DEBUG_LEAKING_SCALARS
222/* provide a real function for a debugger to play with */
223STATIC SV*
224S_new_SV(pTHX)
225{
226 SV* sv;
227
228 LOCK_SV_MUTEX;
229 if (PL_sv_root)
230 uproot_SV(sv);
231 else
cac9b346 232 sv = S_more_sv(aTHX);
eba0f806
DM
233 UNLOCK_SV_MUTEX;
234 SvANY(sv) = 0;
235 SvREFCNT(sv) = 1;
236 SvFLAGS(sv) = 0;
fd0854ff
DM
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
242# ifdef NETWARE
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
244# else
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
246# endif
247
eba0f806
DM
248 return sv;
249}
250# define new_SV(p) (p)=S_new_SV(aTHX)
251
252#else
253# define new_SV(p) \
053fc874
GS
254 STMT_START { \
255 LOCK_SV_MUTEX; \
256 if (PL_sv_root) \
257 uproot_SV(p); \
258 else \
cac9b346 259 (p) = S_more_sv(aTHX); \
053fc874
GS
260 UNLOCK_SV_MUTEX; \
261 SvANY(p) = 0; \
262 SvREFCNT(p) = 1; \
263 SvFLAGS(p) = 0; \
264 } STMT_END
eba0f806 265#endif
463ee0b2 266
645c22ef
DM
267
268/* del_SV(): return an empty SV head to the free list */
269
a0d0e21e 270#ifdef DEBUGGING
4561caa4 271
053fc874
GS
272#define del_SV(p) \
273 STMT_START { \
274 LOCK_SV_MUTEX; \
aea4f609 275 if (DEBUG_D_TEST) \
053fc874
GS
276 del_sv(p); \
277 else \
278 plant_SV(p); \
279 UNLOCK_SV_MUTEX; \
280 } STMT_END
a0d0e21e 281
76e3520e 282STATIC void
cea2e8a9 283S_del_sv(pTHX_ SV *p)
463ee0b2 284{
aea4f609 285 if (DEBUG_D_TEST) {
4633a7c4 286 SV* sva;
a3b680e6 287 bool ok = 0;
3280af22 288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
a3b680e6
AL
289 SV *sv = sva + 1;
290 SV *svend = &sva[SvREFCNT(sva)];
c0ff570e 291 if (p >= sv && p < svend) {
a0d0e21e 292 ok = 1;
c0ff570e
NC
293 break;
294 }
a0d0e21e
LW
295 }
296 if (!ok) {
0453d815 297 if (ckWARN_d(WARN_INTERNAL))
9014280d 298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
472d47bc
SB
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
a0d0e21e
LW
301 return;
302 }
303 }
4561caa4 304 plant_SV(p);
463ee0b2 305}
a0d0e21e 306
4561caa4
CS
307#else /* ! DEBUGGING */
308
309#define del_SV(p) plant_SV(p)
310
311#endif /* DEBUGGING */
463ee0b2 312
645c22ef
DM
313
314/*
ccfc67b7
JH
315=head1 SV Manipulation Functions
316
645c22ef
DM
317=for apidoc sv_add_arena
318
319Given a chunk of memory, link it to the head of the list of arenas,
320and split it into a list of free SVs.
321
322=cut
323*/
324
4633a7c4 325void
864dbfa3 326Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
463ee0b2 327{
4633a7c4 328 SV* sva = (SV*)ptr;
463ee0b2
LW
329 register SV* sv;
330 register SV* svend;
4633a7c4
LW
331
332 /* The first SV in an arena isn't an SV. */
3280af22 333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
4633a7c4
LW
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
336
3280af22
NIS
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
4633a7c4
LW
339
340 svend = &sva[SvREFCNT(sva) - 1];
341 sv = sva + 1;
463ee0b2 342 while (sv < svend) {
a0d0e21e 343 SvANY(sv) = (void *)(SV*)(sv + 1);
03e36789 344#ifdef DEBUGGING
978b032e 345 SvREFCNT(sv) = 0;
03e36789
NC
346#endif
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
8990e307 349 SvFLAGS(sv) = SVTYPEMASK;
463ee0b2
LW
350 sv++;
351 }
352 SvANY(sv) = 0;
03e36789
NC
353#ifdef DEBUGGING
354 SvREFCNT(sv) = 0;
355#endif
4633a7c4
LW
356 SvFLAGS(sv) = SVTYPEMASK;
357}
358
055972dc
DM
359/* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
645c22ef 361
5226ed68 362STATIC I32
055972dc 363S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
8990e307 364{
4633a7c4 365 SV* sva;
5226ed68 366 I32 visited = 0;
8990e307 367
3280af22 368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
a3b680e6
AL
369 register SV * const svend = &sva[SvREFCNT(sva)];
370 register SV* sv;
4561caa4 371 for (sv = sva + 1; sv < svend; ++sv) {
055972dc
DM
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
374 && SvREFCNT(sv))
375 {
acfe0abc 376 (FCALL)(aTHX_ sv);
5226ed68
JH
377 ++visited;
378 }
8990e307
LW
379 }
380 }
5226ed68 381 return visited;
8990e307
LW
382}
383
758a08c3
JH
384#ifdef DEBUGGING
385
645c22ef
DM
386/* called by sv_report_used() for each live SV */
387
388static void
acfe0abc 389do_report_used(pTHX_ SV *sv)
645c22ef
DM
390{
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
393 sv_dump(sv);
394 }
395}
758a08c3 396#endif
645c22ef
DM
397
398/*
399=for apidoc sv_report_used
400
401Dump the contents of all SVs not yet freed. (Debugging aid).
402
403=cut
404*/
405
8990e307 406void
864dbfa3 407Perl_sv_report_used(pTHX)
4561caa4 408{
ff270d3a 409#ifdef DEBUGGING
055972dc 410 visit(do_report_used, 0, 0);
ff270d3a 411#endif
4561caa4
CS
412}
413
645c22ef
DM
414/* called by sv_clean_objs() for each live SV */
415
416static void
acfe0abc 417do_clean_objs(pTHX_ SV *sv)
645c22ef
DM
418{
419 SV* rv;
420
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
423 if (SvWEAKREF(sv)) {
424 sv_del_backref(sv);
425 SvWEAKREF_off(sv);
b162af07 426 SvRV_set(sv, NULL);
645c22ef
DM
427 } else {
428 SvROK_off(sv);
b162af07 429 SvRV_set(sv, NULL);
645c22ef
DM
430 SvREFCNT_dec(rv);
431 }
432 }
433
434 /* XXX Might want to check arrays, etc. */
435}
436
437/* called by sv_clean_objs() for each live SV */
438
439#ifndef DISABLE_DESTRUCTOR_KLUDGE
440static void
acfe0abc 441do_clean_named_objs(pTHX_ SV *sv)
645c22ef
DM
442{
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
449 {
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
ec5f3c78 451 SvFLAGS(sv) |= SVf_BREAK;
645c22ef
DM
452 SvREFCNT_dec(sv);
453 }
454 }
455}
456#endif
457
458/*
459=for apidoc sv_clean_objs
460
461Attempt to destroy all objects not yet freed
462
463=cut
464*/
465
4561caa4 466void
864dbfa3 467Perl_sv_clean_objs(pTHX)
4561caa4 468{
3280af22 469 PL_in_clean_objs = TRUE;
055972dc 470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
4561caa4 471#ifndef DISABLE_DESTRUCTOR_KLUDGE
2d0f3c12 472 /* some barnacles may yet remain, clinging to typeglobs */
055972dc 473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
4561caa4 474#endif
3280af22 475 PL_in_clean_objs = FALSE;
4561caa4
CS
476}
477
645c22ef
DM
478/* called by sv_clean_all() for each live SV */
479
480static void
acfe0abc 481do_clean_all(pTHX_ SV *sv)
645c22ef
DM
482{
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
0e705b3b
DM
485 if (PL_comppad == (AV*)sv) {
486 PL_comppad = Nullav;
487 PL_curpad = Null(SV**);
488 }
645c22ef
DM
489 SvREFCNT_dec(sv);
490}
491
492/*
493=for apidoc sv_clean_all
494
495Decrement the refcnt of each remaining SV, possibly triggering a
496cleanup. This function may have to be called multiple times to free
ff276b08 497SVs which are in complex self-referential hierarchies.
645c22ef
DM
498
499=cut
500*/
501
5226ed68 502I32
864dbfa3 503Perl_sv_clean_all(pTHX)
8990e307 504{
5226ed68 505 I32 cleaned;
3280af22 506 PL_in_clean_all = TRUE;
055972dc 507 cleaned = visit(do_clean_all, 0,0);
3280af22 508 PL_in_clean_all = FALSE;
5226ed68 509 return cleaned;
8990e307 510}
463ee0b2 511
645c22ef
DM
512/*
513=for apidoc sv_free_arenas
514
515Deallocate the memory used by all arenas. Note that all the individual SV
516heads and bodies within the arenas must already have been freed.
517
518=cut
519*/
520
4633a7c4 521void
864dbfa3 522Perl_sv_free_arenas(pTHX)
4633a7c4
LW
523{
524 SV* sva;
525 SV* svanext;
7b2c381c 526 void *arena, *arenanext;
4633a7c4
LW
527
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
530
3280af22 531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
4633a7c4
LW
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
535
536 if (!SvFAKE(sva))
1df70142 537 Safefree(sva);
4633a7c4 538 }
5f05dabc 539
612f20c3 540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
7b2c381c 541 arenanext = *(void **)arena;
612f20c3
GS
542 Safefree(arena);
543 }
544 PL_xnv_arenaroot = 0;
bf9cdc68 545 PL_xnv_root = 0;
612f20c3 546
612f20c3 547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
7b2c381c 548 arenanext = *(void **)arena;
612f20c3
GS
549 Safefree(arena);
550 }
551 PL_xpv_arenaroot = 0;
bf9cdc68 552 PL_xpv_root = 0;
612f20c3 553
7b2c381c
NC
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
612f20c3
GS
556 Safefree(arena);
557 }
558 PL_xpviv_arenaroot = 0;
bf9cdc68 559 PL_xpviv_root = 0;
612f20c3 560
7b2c381c
NC
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
612f20c3
GS
563 Safefree(arena);
564 }
565 PL_xpvnv_arenaroot = 0;
bf9cdc68 566 PL_xpvnv_root = 0;
612f20c3 567
7b2c381c
NC
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
612f20c3
GS
570 Safefree(arena);
571 }
572 PL_xpvcv_arenaroot = 0;
bf9cdc68 573 PL_xpvcv_root = 0;
612f20c3 574
7b2c381c
NC
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
612f20c3
GS
577 Safefree(arena);
578 }
579 PL_xpvav_arenaroot = 0;
bf9cdc68 580 PL_xpvav_root = 0;
612f20c3 581
7b2c381c
NC
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
612f20c3
GS
584 Safefree(arena);
585 }
586 PL_xpvhv_arenaroot = 0;
bf9cdc68 587 PL_xpvhv_root = 0;
612f20c3 588
7b2c381c
NC
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
612f20c3
GS
591 Safefree(arena);
592 }
593 PL_xpvmg_arenaroot = 0;
bf9cdc68 594 PL_xpvmg_root = 0;
612f20c3 595
7b2c381c
NC
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
727879eb
NC
598 Safefree(arena);
599 }
600 PL_xpvgv_arenaroot = 0;
601 PL_xpvgv_root = 0;
602
7b2c381c
NC
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
612f20c3
GS
605 Safefree(arena);
606 }
607 PL_xpvlv_arenaroot = 0;
bf9cdc68 608 PL_xpvlv_root = 0;
612f20c3 609
7b2c381c
NC
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
612f20c3
GS
612 Safefree(arena);
613 }
614 PL_xpvbm_arenaroot = 0;
bf9cdc68 615 PL_xpvbm_root = 0;
612f20c3 616
b1135e3d
NC
617 {
618 HE *he;
619 HE *he_next;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
622 Safefree(he);
623 }
612f20c3
GS
624 }
625 PL_he_arenaroot = 0;
bf9cdc68 626 PL_he_root = 0;
612f20c3 627
892b45be 628#if defined(USE_ITHREADS)
b1135e3d
NC
629 {
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
634 Safefree(pte);
635 }
32e691d0
NC
636 }
637 PL_pte_arenaroot = 0;
638 PL_pte_root = 0;
892b45be 639#endif
32e691d0 640
3280af22
NIS
641 if (PL_nice_chunk)
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
645 PL_sv_arenaroot = 0;
646 PL_sv_root = 0;
4633a7c4
LW
647}
648
29489e7c
DM
649/* ---------------------------------------------------------------------
650 *
651 * support functions for report_uninit()
652 */
653
654/* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
656
657#define FUV_MAX_SEARCH_SIZE 1000
658
659/* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
661
662STATIC SV*
663S_find_hash_subscript(pTHX_ HV *hv, SV* val)
664{
27da23d5 665 dVAR;
29489e7c 666 register HE **array;
29489e7c
DM
667 I32 i;
668
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
671 return Nullsv;
672
673 array = HvARRAY(hv);
674
675 for (i=HvMAX(hv); i>0; i--) {
f54cb97a 676 register HE *entry;
29489e7c
DM
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
679 continue;
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
682 continue;
683 if (!HeKEY(entry))
684 return Nullsv;
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
688 }
689 }
690 return Nullsv;
691}
692
693/* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
695
696STATIC I32
697S_find_array_subscript(pTHX_ AV *av, SV* val)
698{
699 SV** svp;
700 I32 i;
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
703 return -1;
704
705 svp = AvARRAY(av);
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
708 return i;
709 }
710 return -1;
711}
712
713/* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
717 */
718
719#define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720#define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721#define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722#define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
723
724STATIC SV*
bfed75c6 725S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
29489e7c
DM
726 SV* keyname, I32 aindex, int subscript_type)
727{
728 AV *av;
a3b680e6 729 SV *sv;
29489e7c 730
a3b680e6 731 SV * const name = sv_newmortal();
29489e7c
DM
732 if (gv) {
733
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
736 * directly */
737
bfed75c6 738 const char *p;
29489e7c
DM
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
741 if (!hv)
742 p = "???";
bfcb3514 743 else if (!(p=HvNAME_get(hv)))
29489e7c 744 p = "__ANON__";
29489e7c
DM
745 if (strNE(p, "main")) {
746 sv_catpv(name,p);
747 sv_catpvn(name,"::", 2);
748 }
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
751 { /* handle $^FOO */
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
754 }
755 else
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
757 }
758 else {
759 U32 u;
760 CV *cv = find_runcv(&u);
761 if (!cv || !CvPADLIST(cv))
762 return Nullsv;;
763 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
764 sv = *av_fetch(av, targ, FALSE);
765 /* SvLEN in a pad name is not to be trusted */
f9926b10 766 sv_setpv(name, SvPV_nolen_const(sv));
29489e7c
DM
767 }
768
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
770 *SvPVX(name) = '$';
771 sv = NEWSV(0,0);
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
3f7c398e 773 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
29489e7c
DM
774 SvREFCNT_dec(sv);
775 }
776 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
777 *SvPVX(name) = '$';
265a12b8 778 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
29489e7c
DM
779 }
780 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
781 sv_insert(name, 0, 0, "within ", 7);
782
783 return name;
784}
785
786
787/*
788=for apidoc find_uninit_var
789
790Find the name of the undefined variable (if any) that caused the operator o
791to issue a "Use of uninitialized value" warning.
792If match is true, only return a name if it's value matches uninit_sv.
793So roughly speaking, if a unary operator (such as OP_COS) generates a
794warning, then following the direct child of the op may yield an
795OP_PADSV or OP_GV that gives the name of the undefined variable. On the
796other hand, with OP_ADD there are two branches to follow, so we only print
797the variable name if we get an exact match.
798
799The name is returned as a mortal SV.
800
801Assumes that PL_op is the op that originally triggered the error, and that
802PL_comppad/PL_curpad points to the currently executing pad.
803
804=cut
805*/
806
807STATIC SV *
808S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
809{
27da23d5 810 dVAR;
29489e7c
DM
811 SV *sv;
812 AV *av;
813 SV **svp;
814 GV *gv;
815 OP *o, *o2, *kid;
816
817 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
818 uninit_sv == &PL_sv_placeholder)))
819 return Nullsv;
820
821 switch (obase->op_type) {
822
823 case OP_RV2AV:
824 case OP_RV2HV:
825 case OP_PADAV:
826 case OP_PADHV:
827 {
f54cb97a
AL
828 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
829 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
112dcc46
RGS
830 I32 index = 0;
831 SV *keysv = Nullsv;
29489e7c
DM
832 int subscript_type = FUV_SUBSCRIPT_WITHIN;
833
834 if (pad) { /* @lex, %lex */
835 sv = PAD_SVl(obase->op_targ);
836 gv = Nullgv;
837 }
838 else {
839 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
840 /* @global, %global */
841 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
842 if (!gv)
843 break;
844 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
845 }
846 else /* @{expr}, %{expr} */
847 return find_uninit_var(cUNOPx(obase)->op_first,
848 uninit_sv, match);
849 }
850
851 /* attempt to find a match within the aggregate */
852 if (hash) {
853 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
854 if (keysv)
855 subscript_type = FUV_SUBSCRIPT_HASH;
856 }
857 else {
858 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
859 if (index >= 0)
860 subscript_type = FUV_SUBSCRIPT_ARRAY;
861 }
862
863 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
864 break;
865
866 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
867 keysv, index, subscript_type);
868 }
869
870 case OP_PADSV:
871 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
872 break;
873 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
874 Nullsv, 0, FUV_SUBSCRIPT_NONE);
875
876 case OP_GVSV:
877 gv = cGVOPx_gv(obase);
878 if (!gv || (match && GvSV(gv) != uninit_sv))
879 break;
880 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
881
882 case OP_AELEMFAST:
883 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
884 if (match) {
885 av = (AV*)PAD_SV(obase->op_targ);
886 if (!av || SvRMAGICAL(av))
887 break;
888 svp = av_fetch(av, (I32)obase->op_private, FALSE);
889 if (!svp || *svp != uninit_sv)
890 break;
891 }
892 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
893 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
894 }
895 else {
896 gv = cGVOPx_gv(obase);
897 if (!gv)
898 break;
899 if (match) {
900 av = GvAV(gv);
901 if (!av || SvRMAGICAL(av))
902 break;
903 svp = av_fetch(av, (I32)obase->op_private, FALSE);
904 if (!svp || *svp != uninit_sv)
905 break;
906 }
907 return S_varname(aTHX_ gv, "$", 0,
908 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
909 }
910 break;
911
912 case OP_EXISTS:
913 o = cUNOPx(obase)->op_first;
914 if (!o || o->op_type != OP_NULL ||
915 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
916 break;
917 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
918
919 case OP_AELEM:
920 case OP_HELEM:
921 if (PL_op == obase)
922 /* $a[uninit_expr] or $h{uninit_expr} */
923 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
924
925 gv = Nullgv;
926 o = cBINOPx(obase)->op_first;
927 kid = cBINOPx(obase)->op_last;
928
929 /* get the av or hv, and optionally the gv */
930 sv = Nullsv;
931 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
932 sv = PAD_SV(o->op_targ);
933 }
934 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
935 && cUNOPo->op_first->op_type == OP_GV)
936 {
937 gv = cGVOPx_gv(cUNOPo->op_first);
938 if (!gv)
939 break;
940 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
941 }
942 if (!sv)
943 break;
944
945 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
946 /* index is constant */
947 if (match) {
948 if (SvMAGICAL(sv))
949 break;
950 if (obase->op_type == OP_HELEM) {
951 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
952 if (!he || HeVAL(he) != uninit_sv)
953 break;
954 }
955 else {
956 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
957 if (!svp || *svp != uninit_sv)
958 break;
959 }
960 }
961 if (obase->op_type == OP_HELEM)
962 return S_varname(aTHX_ gv, "%", o->op_targ,
963 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
964 else
965 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
966 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
967 ;
968 }
969 else {
970 /* index is an expression;
971 * attempt to find a match within the aggregate */
972 if (obase->op_type == OP_HELEM) {
973 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
974 if (keysv)
975 return S_varname(aTHX_ gv, "%", o->op_targ,
976 keysv, 0, FUV_SUBSCRIPT_HASH);
977 }
978 else {
f54cb97a 979 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
29489e7c 980 if (index >= 0)
f54cb97a 981 return S_varname(aTHX_ gv, "@", o->op_targ,
29489e7c
DM
982 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
983 }
984 if (match)
985 break;
986 return S_varname(aTHX_ gv,
987 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
988 ? "@" : "%",
989 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
990 }
991
992 break;
993
994 case OP_AASSIGN:
995 /* only examine RHS */
996 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
997
998 case OP_OPEN:
999 o = cUNOPx(obase)->op_first;
1000 if (o->op_type == OP_PUSHMARK)
1001 o = o->op_sibling;
1002
1003 if (!o->op_sibling) {
1004 /* one-arg version of open is highly magical */
1005
1006 if (o->op_type == OP_GV) { /* open FOO; */
1007 gv = cGVOPx_gv(o);
1008 if (match && GvSV(gv) != uninit_sv)
1009 break;
7a5fa8a2 1010 return S_varname(aTHX_ gv, "$", 0,
29489e7c
DM
1011 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1012 }
1013 /* other possibilities not handled are:
1014 * open $x; or open my $x; should return '${*$x}'
1015 * open expr; should return '$'.expr ideally
1016 */
1017 break;
1018 }
1019 goto do_op;
1020
1021 /* ops where $_ may be an implicit arg */
1022 case OP_TRANS:
1023 case OP_SUBST:
1024 case OP_MATCH:
1025 if ( !(obase->op_flags & OPf_STACKED)) {
1026 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1027 ? PAD_SVl(obase->op_targ)
1028 : DEFSV))
1029 {
1030 sv = sv_newmortal();
616d8c9c 1031 sv_setpvn(sv, "$_", 2);
29489e7c
DM
1032 return sv;
1033 }
1034 }
1035 goto do_op;
1036
1037 case OP_PRTF:
1038 case OP_PRINT:
1039 /* skip filehandle as it can't produce 'undef' warning */
1040 o = cUNOPx(obase)->op_first;
1041 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1042 o = o->op_sibling->op_sibling;
1043 goto do_op2;
1044
1045
e21bd382 1046 case OP_RV2SV:
29489e7c
DM
1047 case OP_CUSTOM:
1048 case OP_ENTERSUB:
1049 match = 1; /* XS or custom code could trigger random warnings */
1050 goto do_op;
1051
1052 case OP_SCHOMP:
1053 case OP_CHOMP:
1054 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1055 return sv_2mortal(newSVpv("${$/}", 0));
1056 /* FALL THROUGH */
1057
1058 default:
1059 do_op:
1060 if (!(obase->op_flags & OPf_KIDS))
1061 break;
1062 o = cUNOPx(obase)->op_first;
1063
1064 do_op2:
1065 if (!o)
1066 break;
1067
1068 /* if all except one arg are constant, or have no side-effects,
1069 * or are optimized away, then it's unambiguous */
1070 o2 = Nullop;
1071 for (kid=o; kid; kid = kid->op_sibling) {
1072 if (kid &&
1073 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1074 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1075 || (kid->op_type == OP_PUSHMARK)
1076 )
1077 )
1078 continue;
1079 if (o2) { /* more than one found */
1080 o2 = Nullop;
1081 break;
1082 }
1083 o2 = kid;
1084 }
1085 if (o2)
1086 return find_uninit_var(o2, uninit_sv, match);
1087
1088 /* scan all args */
1089 while (o) {
1090 sv = find_uninit_var(o, uninit_sv, 1);
1091 if (sv)
1092 return sv;
1093 o = o->op_sibling;
1094 }
1095 break;
1096 }
1097 return Nullsv;
1098}
1099
1100
645c22ef
DM
1101/*
1102=for apidoc report_uninit
1103
1104Print appropriate "Use of uninitialized variable" warning
1105
1106=cut
1107*/
1108
1d7c1841 1109void
29489e7c
DM
1110Perl_report_uninit(pTHX_ SV* uninit_sv)
1111{
1112 if (PL_op) {
112dcc46 1113 SV* varname = Nullsv;
29489e7c
DM
1114 if (uninit_sv) {
1115 varname = find_uninit_var(PL_op, uninit_sv,0);
1116 if (varname)
1117 sv_insert(varname, 0, 0, " ", 1);
1118 }
9014280d 1119 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
93524f2b 1120 varname ? SvPV_nolen_const(varname) : "",
29489e7c
DM
1121 " in ", OP_DESC(PL_op));
1122 }
1d7c1841 1123 else
29489e7c
DM
1124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1125 "", "", "");
1d7c1841
GS
1126}
1127
645c22ef
DM
1128/* allocate another arena's worth of NV bodies */
1129
cbe51380 1130STATIC void
cea2e8a9 1131S_more_xnv(pTHX)
463ee0b2 1132{
cac9b346
NC
1133 NV* xnv;
1134 NV* xnvend;
7b2c381c
NC
1135 void *ptr;
1136 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1137 *((void **) ptr) = (void *)PL_xnv_arenaroot;
612f20c3
GS
1138 PL_xnv_arenaroot = ptr;
1139
1140 xnv = (NV*) ptr;
9c17f24a 1141 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
65202027 1142 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
3280af22 1143 PL_xnv_root = xnv;
463ee0b2 1144 while (xnv < xnvend) {
65202027 1145 *(NV**)xnv = (NV*)(xnv + 1);
463ee0b2
LW
1146 xnv++;
1147 }
cac9b346
NC
1148 *(NV**)xnv = 0;
1149}
1150
1151/* allocate another arena's worth of struct xpv */
1152
1153STATIC void
1154S_more_xpv(pTHX)
1155{
59813432
NC
1156 xpv_allocated* xpv;
1157 xpv_allocated* xpvend;
1158 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1159 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
cac9b346
NC
1160 PL_xpv_arenaroot = xpv;
1161
59813432 1162 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
cac9b346
NC
1163 PL_xpv_root = ++xpv;
1164 while (xpv < xpvend) {
59813432 1165 *((xpv_allocated**)xpv) = xpv + 1;
cac9b346
NC
1166 xpv++;
1167 }
59813432 1168 *((xpv_allocated**)xpv) = 0;
cac9b346
NC
1169}
1170
1171/* allocate another arena's worth of struct xpviv */
1172
1173STATIC void
1174S_more_xpviv(pTHX)
1175{
311a25d9
NC
1176 xpviv_allocated* xpviv;
1177 xpviv_allocated* xpvivend;
1178 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1179 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
cac9b346
NC
1180 PL_xpviv_arenaroot = xpviv;
1181
311a25d9 1182 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
cac9b346
NC
1183 PL_xpviv_root = ++xpviv;
1184 while (xpviv < xpvivend) {
311a25d9 1185 *((xpviv_allocated**)xpviv) = xpviv + 1;
cac9b346
NC
1186 xpviv++;
1187 }
311a25d9 1188 *((xpviv_allocated**)xpviv) = 0;
cac9b346
NC
1189}
1190
1191/* allocate another arena's worth of struct xpvnv */
1192
1193STATIC void
1194S_more_xpvnv(pTHX)
1195{
1196 XPVNV* xpvnv;
1197 XPVNV* xpvnvend;
1198 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
7b2c381c 1199 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
cac9b346
NC
1200 PL_xpvnv_arenaroot = xpvnv;
1201
1202 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1203 PL_xpvnv_root = ++xpvnv;
1204 while (xpvnv < xpvnvend) {
7b2c381c 1205 *((XPVNV**)xpvnv) = xpvnv + 1;
cac9b346
NC
1206 xpvnv++;
1207 }
7b2c381c 1208 *((XPVNV**)xpvnv) = 0;
cac9b346
NC
1209}
1210
1211/* allocate another arena's worth of struct xpvcv */
1212
1213STATIC void
1214S_more_xpvcv(pTHX)
1215{
1216 XPVCV* xpvcv;
1217 XPVCV* xpvcvend;
1218 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
7b2c381c 1219 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
cac9b346
NC
1220 PL_xpvcv_arenaroot = xpvcv;
1221
1222 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1223 PL_xpvcv_root = ++xpvcv;
1224 while (xpvcv < xpvcvend) {
7b2c381c 1225 *((XPVCV**)xpvcv) = xpvcv + 1;
cac9b346
NC
1226 xpvcv++;
1227 }
7b2c381c 1228 *((XPVCV**)xpvcv) = 0;
cac9b346
NC
1229}
1230
1231/* allocate another arena's worth of struct xpvav */
1232
1233STATIC void
1234S_more_xpvav(pTHX)
1235{
59813432
NC
1236 xpvav_allocated* xpvav;
1237 xpvav_allocated* xpvavend;
1238 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1239 xpvav_allocated);
1240 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
cac9b346
NC
1241 PL_xpvav_arenaroot = xpvav;
1242
59813432 1243 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
cac9b346
NC
1244 PL_xpvav_root = ++xpvav;
1245 while (xpvav < xpvavend) {
59813432 1246 *((xpvav_allocated**)xpvav) = xpvav + 1;
cac9b346
NC
1247 xpvav++;
1248 }
59813432 1249 *((xpvav_allocated**)xpvav) = 0;
cac9b346
NC
1250}
1251
1252/* allocate another arena's worth of struct xpvhv */
1253
1254STATIC void
1255S_more_xpvhv(pTHX)
1256{
59813432
NC
1257 xpvhv_allocated* xpvhv;
1258 xpvhv_allocated* xpvhvend;
1259 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1260 xpvhv_allocated);
1261 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
cac9b346
NC
1262 PL_xpvhv_arenaroot = xpvhv;
1263
59813432 1264 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
cac9b346
NC
1265 PL_xpvhv_root = ++xpvhv;
1266 while (xpvhv < xpvhvend) {
59813432 1267 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
cac9b346
NC
1268 xpvhv++;
1269 }
59813432 1270 *((xpvhv_allocated**)xpvhv) = 0;
cac9b346
NC
1271}
1272
1273/* allocate another arena's worth of struct xpvmg */
1274
1275STATIC void
1276S_more_xpvmg(pTHX)
1277{
1278 XPVMG* xpvmg;
1279 XPVMG* xpvmgend;
1280 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
7b2c381c 1281 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
cac9b346
NC
1282 PL_xpvmg_arenaroot = xpvmg;
1283
1284 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1285 PL_xpvmg_root = ++xpvmg;
1286 while (xpvmg < xpvmgend) {
7b2c381c 1287 *((XPVMG**)xpvmg) = xpvmg + 1;
cac9b346
NC
1288 xpvmg++;
1289 }
7b2c381c 1290 *((XPVMG**)xpvmg) = 0;
cac9b346
NC
1291}
1292
1293/* allocate another arena's worth of struct xpvgv */
1294
1295STATIC void
1296S_more_xpvgv(pTHX)
1297{
1298 XPVGV* xpvgv;
1299 XPVGV* xpvgvend;
1300 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
7b2c381c 1301 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
cac9b346
NC
1302 PL_xpvgv_arenaroot = xpvgv;
1303
1304 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1305 PL_xpvgv_root = ++xpvgv;
1306 while (xpvgv < xpvgvend) {
7b2c381c 1307 *((XPVGV**)xpvgv) = xpvgv + 1;
cac9b346
NC
1308 xpvgv++;
1309 }
7b2c381c 1310 *((XPVGV**)xpvgv) = 0;
cac9b346
NC
1311}
1312
1313/* allocate another arena's worth of struct xpvlv */
1314
1315STATIC void
1316S_more_xpvlv(pTHX)
1317{
1318 XPVLV* xpvlv;
1319 XPVLV* xpvlvend;
1320 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
7b2c381c 1321 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
cac9b346
NC
1322 PL_xpvlv_arenaroot = xpvlv;
1323
1324 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1325 PL_xpvlv_root = ++xpvlv;
1326 while (xpvlv < xpvlvend) {
7b2c381c 1327 *((XPVLV**)xpvlv) = xpvlv + 1;
cac9b346
NC
1328 xpvlv++;
1329 }
7b2c381c 1330 *((XPVLV**)xpvlv) = 0;
cac9b346
NC
1331}
1332
1333/* allocate another arena's worth of struct xpvbm */
1334
1335STATIC void
1336S_more_xpvbm(pTHX)
1337{
1338 XPVBM* xpvbm;
1339 XPVBM* xpvbmend;
1340 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
7b2c381c 1341 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
cac9b346
NC
1342 PL_xpvbm_arenaroot = xpvbm;
1343
1344 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1345 PL_xpvbm_root = ++xpvbm;
1346 while (xpvbm < xpvbmend) {
7b2c381c 1347 *((XPVBM**)xpvbm) = xpvbm + 1;
cac9b346
NC
1348 xpvbm++;
1349 }
7b2c381c 1350 *((XPVBM**)xpvbm) = 0;
cac9b346 1351}
612f20c3 1352
cac9b346
NC
1353/* grab a new NV body from the free list, allocating more if necessary */
1354
1355STATIC XPVNV*
1356S_new_xnv(pTHX)
1357{
1358 NV* xnv;
1359 LOCK_SV_MUTEX;
1360 if (!PL_xnv_root)
1361 S_more_xnv(aTHX);
1362 xnv = PL_xnv_root;
1363 PL_xnv_root = *(NV**)xnv;
1364 UNLOCK_SV_MUTEX;
1365 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1366}
1367
1368/* return an NV body to the free list */
1369
1370STATIC void
1371S_del_xnv(pTHX_ XPVNV *p)
1372{
1373 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1374 LOCK_SV_MUTEX;
1375 *(NV**)xnv = PL_xnv_root;
1376 PL_xnv_root = xnv;
1377 UNLOCK_SV_MUTEX;
ed6116ce
LW
1378}
1379
645c22ef
DM
1380/* grab a new struct xpv from the free list, allocating more if necessary */
1381
76e3520e 1382STATIC XPV*
cea2e8a9 1383S_new_xpv(pTHX)
463ee0b2 1384{
59813432 1385 xpv_allocated* xpv;
cbe51380
GS
1386 LOCK_SV_MUTEX;
1387 if (!PL_xpv_root)
cac9b346 1388 S_more_xpv(aTHX);
cbe51380 1389 xpv = PL_xpv_root;
59813432 1390 PL_xpv_root = *(xpv_allocated**)xpv;
cbe51380 1391 UNLOCK_SV_MUTEX;
59813432
NC
1392 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1393 sum to zero, and the pointer is unchanged. If the allocated structure
1394 is smaller (no initial IV actually allocated) then the net effect is
1395 to subtract the size of the IV from the pointer, to return a new pointer
1396 as if an initial IV were actually allocated. */
1397 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1398 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
463ee0b2
LW
1399}
1400
645c22ef
DM
1401/* return a struct xpv to the free list */
1402
76e3520e 1403STATIC void
cea2e8a9 1404S_del_xpv(pTHX_ XPV *p)
463ee0b2 1405{
59813432
NC
1406 xpv_allocated* xpv
1407 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1408 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
cbe51380 1409 LOCK_SV_MUTEX;
59813432
NC
1410 *(xpv_allocated**)xpv = PL_xpv_root;
1411 PL_xpv_root = xpv;
cbe51380 1412 UNLOCK_SV_MUTEX;
463ee0b2
LW
1413}
1414
645c22ef
DM
1415/* grab a new struct xpviv from the free list, allocating more if necessary */
1416
932e9ff9
VB
1417STATIC XPVIV*
1418S_new_xpviv(pTHX)
1419{
311a25d9 1420 xpviv_allocated* xpviv;
932e9ff9
VB
1421 LOCK_SV_MUTEX;
1422 if (!PL_xpviv_root)
cac9b346 1423 S_more_xpviv(aTHX);
932e9ff9 1424 xpviv = PL_xpviv_root;
311a25d9 1425 PL_xpviv_root = *(xpviv_allocated**)xpviv;
932e9ff9 1426 UNLOCK_SV_MUTEX;
311a25d9
NC
1427 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1428 sum to zero, and the pointer is unchanged. If the allocated structure
1429 is smaller (no initial IV actually allocated) then the net effect is
1430 to subtract the size of the IV from the pointer, to return a new pointer
1431 as if an initial IV were actually allocated. */
1432 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1433 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
932e9ff9
VB
1434}
1435
645c22ef
DM
1436/* return a struct xpviv to the free list */
1437
932e9ff9
VB
1438STATIC void
1439S_del_xpviv(pTHX_ XPVIV *p)
1440{
311a25d9
NC
1441 xpviv_allocated* xpviv
1442 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1443 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
932e9ff9 1444 LOCK_SV_MUTEX;
311a25d9
NC
1445 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1446 PL_xpviv_root = xpviv;
932e9ff9
VB
1447 UNLOCK_SV_MUTEX;
1448}
1449
645c22ef
DM
1450/* grab a new struct xpvnv from the free list, allocating more if necessary */
1451
932e9ff9
VB
1452STATIC XPVNV*
1453S_new_xpvnv(pTHX)
1454{
1455 XPVNV* xpvnv;
1456 LOCK_SV_MUTEX;
1457 if (!PL_xpvnv_root)
cac9b346 1458 S_more_xpvnv(aTHX);
932e9ff9 1459 xpvnv = PL_xpvnv_root;
7b2c381c 1460 PL_xpvnv_root = *(XPVNV**)xpvnv;
932e9ff9
VB
1461 UNLOCK_SV_MUTEX;
1462 return xpvnv;
1463}
1464
645c22ef
DM
1465/* return a struct xpvnv to the free list */
1466
932e9ff9
VB
1467STATIC void
1468S_del_xpvnv(pTHX_ XPVNV *p)
1469{
1470 LOCK_SV_MUTEX;
7b2c381c 1471 *(XPVNV**)p = PL_xpvnv_root;
932e9ff9
VB
1472 PL_xpvnv_root = p;
1473 UNLOCK_SV_MUTEX;
1474}
1475
645c22ef
DM
1476/* grab a new struct xpvcv from the free list, allocating more if necessary */
1477
932e9ff9
VB
1478STATIC XPVCV*
1479S_new_xpvcv(pTHX)
1480{
1481 XPVCV* xpvcv;
1482 LOCK_SV_MUTEX;
1483 if (!PL_xpvcv_root)
cac9b346 1484 S_more_xpvcv(aTHX);
932e9ff9 1485 xpvcv = PL_xpvcv_root;
7b2c381c 1486 PL_xpvcv_root = *(XPVCV**)xpvcv;
932e9ff9
VB
1487 UNLOCK_SV_MUTEX;
1488 return xpvcv;
1489}
1490
645c22ef
DM
1491/* return a struct xpvcv to the free list */
1492
932e9ff9
VB
1493STATIC void
1494S_del_xpvcv(pTHX_ XPVCV *p)
1495{
1496 LOCK_SV_MUTEX;
7b2c381c 1497 *(XPVCV**)p = PL_xpvcv_root;
932e9ff9
VB
1498 PL_xpvcv_root = p;
1499 UNLOCK_SV_MUTEX;
1500}
1501
645c22ef
DM
1502/* grab a new struct xpvav from the free list, allocating more if necessary */
1503
932e9ff9
VB
1504STATIC XPVAV*
1505S_new_xpvav(pTHX)
1506{
59813432 1507 xpvav_allocated* xpvav;
932e9ff9
VB
1508 LOCK_SV_MUTEX;
1509 if (!PL_xpvav_root)
cac9b346 1510 S_more_xpvav(aTHX);
932e9ff9 1511 xpvav = PL_xpvav_root;
59813432 1512 PL_xpvav_root = *(xpvav_allocated**)xpvav;
932e9ff9 1513 UNLOCK_SV_MUTEX;
59813432
NC
1514 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1515 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
932e9ff9
VB
1516}
1517
645c22ef
DM
1518/* return a struct xpvav to the free list */
1519
932e9ff9
VB
1520STATIC void
1521S_del_xpvav(pTHX_ XPVAV *p)
1522{
59813432
NC
1523 xpvav_allocated* xpvav
1524 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1525 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
932e9ff9 1526 LOCK_SV_MUTEX;
59813432
NC
1527 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1528 PL_xpvav_root = xpvav;
932e9ff9
VB
1529 UNLOCK_SV_MUTEX;
1530}
1531
645c22ef
DM
1532/* grab a new struct xpvhv from the free list, allocating more if necessary */
1533
932e9ff9
VB
1534STATIC XPVHV*
1535S_new_xpvhv(pTHX)
1536{
59813432 1537 xpvhv_allocated* xpvhv;
932e9ff9
VB
1538 LOCK_SV_MUTEX;
1539 if (!PL_xpvhv_root)
cac9b346 1540 S_more_xpvhv(aTHX);
932e9ff9 1541 xpvhv = PL_xpvhv_root;
59813432 1542 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
932e9ff9 1543 UNLOCK_SV_MUTEX;
59813432
NC
1544 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1545 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
932e9ff9
VB
1546}
1547
645c22ef
DM
1548/* return a struct xpvhv to the free list */
1549
932e9ff9
VB
1550STATIC void
1551S_del_xpvhv(pTHX_ XPVHV *p)
1552{
59813432
NC
1553 xpvhv_allocated* xpvhv
1554 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1555 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
932e9ff9 1556 LOCK_SV_MUTEX;
59813432
NC
1557 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1558 PL_xpvhv_root = xpvhv;
932e9ff9
VB
1559 UNLOCK_SV_MUTEX;
1560}
1561
645c22ef
DM
1562/* grab a new struct xpvmg from the free list, allocating more if necessary */
1563
932e9ff9
VB
1564STATIC XPVMG*
1565S_new_xpvmg(pTHX)
1566{
1567 XPVMG* xpvmg;
1568 LOCK_SV_MUTEX;
1569 if (!PL_xpvmg_root)
cac9b346 1570 S_more_xpvmg(aTHX);
932e9ff9 1571 xpvmg = PL_xpvmg_root;
7b2c381c 1572 PL_xpvmg_root = *(XPVMG**)xpvmg;
932e9ff9
VB
1573 UNLOCK_SV_MUTEX;
1574 return xpvmg;
1575}
1576
645c22ef
DM
1577/* return a struct xpvmg to the free list */
1578
932e9ff9
VB
1579STATIC void
1580S_del_xpvmg(pTHX_ XPVMG *p)
1581{
1582 LOCK_SV_MUTEX;
7b2c381c 1583 *(XPVMG**)p = PL_xpvmg_root;
932e9ff9
VB
1584 PL_xpvmg_root = p;
1585 UNLOCK_SV_MUTEX;
1586}
1587
727879eb
NC
1588/* grab a new struct xpvgv from the free list, allocating more if necessary */
1589
1590STATIC XPVGV*
1591S_new_xpvgv(pTHX)
1592{
1593 XPVGV* xpvgv;
1594 LOCK_SV_MUTEX;
1595 if (!PL_xpvgv_root)
cac9b346 1596 S_more_xpvgv(aTHX);
727879eb 1597 xpvgv = PL_xpvgv_root;
7b2c381c 1598 PL_xpvgv_root = *(XPVGV**)xpvgv;
727879eb
NC
1599 UNLOCK_SV_MUTEX;
1600 return xpvgv;
1601}
1602
1603/* return a struct xpvgv to the free list */
1604
1605STATIC void
1606S_del_xpvgv(pTHX_ XPVGV *p)
1607{
1608 LOCK_SV_MUTEX;
7b2c381c 1609 *(XPVGV**)p = PL_xpvgv_root;
727879eb
NC
1610 PL_xpvgv_root = p;
1611 UNLOCK_SV_MUTEX;
1612}
1613
645c22ef
DM
1614/* grab a new struct xpvlv from the free list, allocating more if necessary */
1615
932e9ff9
VB
1616STATIC XPVLV*
1617S_new_xpvlv(pTHX)
1618{
1619 XPVLV* xpvlv;
1620 LOCK_SV_MUTEX;
1621 if (!PL_xpvlv_root)
cac9b346 1622 S_more_xpvlv(aTHX);
932e9ff9 1623 xpvlv = PL_xpvlv_root;
7b2c381c 1624 PL_xpvlv_root = *(XPVLV**)xpvlv;
932e9ff9
VB
1625 UNLOCK_SV_MUTEX;
1626 return xpvlv;
1627}
1628
645c22ef
DM
1629/* return a struct xpvlv to the free list */
1630
932e9ff9
VB
1631STATIC void
1632S_del_xpvlv(pTHX_ XPVLV *p)
1633{
1634 LOCK_SV_MUTEX;
7b2c381c 1635 *(XPVLV**)p = PL_xpvlv_root;
932e9ff9
VB
1636 PL_xpvlv_root = p;
1637 UNLOCK_SV_MUTEX;
1638}
1639
645c22ef
DM
1640/* grab a new struct xpvbm from the free list, allocating more if necessary */
1641
932e9ff9
VB
1642STATIC XPVBM*
1643S_new_xpvbm(pTHX)
1644{
1645 XPVBM* xpvbm;
1646 LOCK_SV_MUTEX;
1647 if (!PL_xpvbm_root)
cac9b346 1648 S_more_xpvbm(aTHX);
932e9ff9 1649 xpvbm = PL_xpvbm_root;
7b2c381c 1650 PL_xpvbm_root = *(XPVBM**)xpvbm;
932e9ff9
VB
1651 UNLOCK_SV_MUTEX;
1652 return xpvbm;
1653}
1654
645c22ef
DM
1655/* return a struct xpvbm to the free list */
1656
932e9ff9
VB
1657STATIC void
1658S_del_xpvbm(pTHX_ XPVBM *p)
1659{
1660 LOCK_SV_MUTEX;
7b2c381c 1661 *(XPVBM**)p = PL_xpvbm_root;
932e9ff9
VB
1662 PL_xpvbm_root = p;
1663 UNLOCK_SV_MUTEX;
1664}
1665
7bab3ede
MB
1666#define my_safemalloc(s) (void*)safemalloc(s)
1667#define my_safefree(p) safefree((char*)p)
463ee0b2 1668
d33b2eba 1669#ifdef PURIFY
463ee0b2 1670
d33b2eba
GS
1671#define new_XNV() my_safemalloc(sizeof(XPVNV))
1672#define del_XNV(p) my_safefree(p)
463ee0b2 1673
d33b2eba
GS
1674#define new_XPV() my_safemalloc(sizeof(XPV))
1675#define del_XPV(p) my_safefree(p)
9b94d1dd 1676
d33b2eba
GS
1677#define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1678#define del_XPVIV(p) my_safefree(p)
932e9ff9 1679
d33b2eba
GS
1680#define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1681#define del_XPVNV(p) my_safefree(p)
932e9ff9 1682
d33b2eba
GS
1683#define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1684#define del_XPVCV(p) my_safefree(p)
932e9ff9 1685
d33b2eba
GS
1686#define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1687#define del_XPVAV(p) my_safefree(p)
1688
1689#define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1690#define del_XPVHV(p) my_safefree(p)
1c846c1f 1691
d33b2eba
GS
1692#define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1693#define del_XPVMG(p) my_safefree(p)
1694
727879eb
NC
1695#define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1696#define del_XPVGV(p) my_safefree(p)
1697
d33b2eba
GS
1698#define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1699#define del_XPVLV(p) my_safefree(p)
1700
1701#define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1702#define del_XPVBM(p) my_safefree(p)
1703
1704#else /* !PURIFY */
1705
d33b2eba
GS
1706#define new_XNV() (void*)new_xnv()
1707#define del_XNV(p) del_xnv((XPVNV*) p)
9b94d1dd 1708
d33b2eba
GS
1709#define new_XPV() (void*)new_xpv()
1710#define del_XPV(p) del_xpv((XPV *)p)
1711
1712#define new_XPVIV() (void*)new_xpviv()
1713#define del_XPVIV(p) del_xpviv((XPVIV *)p)
1714
1715#define new_XPVNV() (void*)new_xpvnv()
1716#define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1717
1718#define new_XPVCV() (void*)new_xpvcv()
1719#define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1720
1721#define new_XPVAV() (void*)new_xpvav()
1722#define del_XPVAV(p) del_xpvav((XPVAV *)p)
1723
1724#define new_XPVHV() (void*)new_xpvhv()
1725#define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1c846c1f 1726
d33b2eba
GS
1727#define new_XPVMG() (void*)new_xpvmg()
1728#define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1729
727879eb
NC
1730#define new_XPVGV() (void*)new_xpvgv()
1731#define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1732
d33b2eba
GS
1733#define new_XPVLV() (void*)new_xpvlv()
1734#define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1735
1736#define new_XPVBM() (void*)new_xpvbm()
1737#define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1738
1739#endif /* PURIFY */
9b94d1dd 1740
d33b2eba
GS
1741#define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1742#define del_XPVFM(p) my_safefree(p)
1c846c1f 1743
d33b2eba
GS
1744#define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1745#define del_XPVIO(p) my_safefree(p)
8990e307 1746
954c1994
GS
1747/*
1748=for apidoc sv_upgrade
1749
ff276b08 1750Upgrade an SV to a more complex form. Generally adds a new body type to the
645c22ef 1751SV, then copies across as much information as possible from the old body.
ff276b08 1752You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
954c1994
GS
1753
1754=cut
1755*/
1756
63f97190 1757void
864dbfa3 1758Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
79072805 1759{
e763e3dc 1760
d2e56290
NC
1761 char* pv;
1762 U32 cur;
1763 U32 len;
1764 IV iv;
1765 NV nv;
1766 MAGIC* magic;
1767 HV* stash;
79072805 1768
765f542d
NC
1769 if (mt != SVt_PV && SvIsCOW(sv)) {
1770 sv_force_normal_flags(sv, 0);
f130fd45
NIS
1771 }
1772
79072805 1773 if (SvTYPE(sv) == mt)
63f97190 1774 return;
79072805 1775
d2e56290
NC
1776 pv = NULL;
1777 cur = 0;
1778 len = 0;
1779 iv = 0;
1780 nv = 0.0;
1781 magic = NULL;
1782 stash = Nullhv;
1783
79072805
LW
1784 switch (SvTYPE(sv)) {
1785 case SVt_NULL:
79072805 1786 break;
79072805 1787 case SVt_IV:
463ee0b2 1788 iv = SvIVX(sv);
ed6116ce 1789 if (mt == SVt_NV)
463ee0b2 1790 mt = SVt_PVNV;
ed6116ce
LW
1791 else if (mt < SVt_PVIV)
1792 mt = SVt_PVIV;
79072805
LW
1793 break;
1794 case SVt_NV:
463ee0b2 1795 nv = SvNVX(sv);
79072805 1796 del_XNV(SvANY(sv));
ed6116ce 1797 if (mt < SVt_PVNV)
79072805
LW
1798 mt = SVt_PVNV;
1799 break;
ed6116ce
LW
1800 case SVt_RV:
1801 pv = (char*)SvRV(sv);
ed6116ce 1802 break;
79072805 1803 case SVt_PV:
4d84ee25 1804 pv = SvPVX_mutable(sv);
79072805
LW
1805 cur = SvCUR(sv);
1806 len = SvLEN(sv);
79072805 1807 del_XPV(SvANY(sv));
748a9306
LW
1808 if (mt <= SVt_IV)
1809 mt = SVt_PVIV;
1810 else if (mt == SVt_NV)
1811 mt = SVt_PVNV;
79072805
LW
1812 break;
1813 case SVt_PVIV:
4d84ee25 1814 pv = SvPVX_mutable(sv);
79072805
LW
1815 cur = SvCUR(sv);
1816 len = SvLEN(sv);
463ee0b2 1817 iv = SvIVX(sv);
79072805
LW
1818 del_XPVIV(SvANY(sv));
1819 break;
1820 case SVt_PVNV:
4d84ee25 1821 pv = SvPVX_mutable(sv);
79072805
LW
1822 cur = SvCUR(sv);
1823 len = SvLEN(sv);
463ee0b2
LW
1824 iv = SvIVX(sv);
1825 nv = SvNVX(sv);
79072805
LW
1826 del_XPVNV(SvANY(sv));
1827 break;
1828 case SVt_PVMG:
0ec50a73
NC
1829 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1830 there's no way that it can be safely upgraded, because perl.c
1831 expects to Safefree(SvANY(PL_mess_sv)) */
1832 assert(sv != PL_mess_sv);
bce8f412
NC
1833 /* This flag bit is used to mean other things in other scalar types.
1834 Given that it only has meaning inside the pad, it shouldn't be set
1835 on anything that can get upgraded. */
1836 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
4d84ee25 1837 pv = SvPVX_mutable(sv);
79072805
LW
1838 cur = SvCUR(sv);
1839 len = SvLEN(sv);
463ee0b2
LW
1840 iv = SvIVX(sv);
1841 nv = SvNVX(sv);
79072805
LW
1842 magic = SvMAGIC(sv);
1843 stash = SvSTASH(sv);
1844 del_XPVMG(SvANY(sv));
1845 break;
1846 default:
cea2e8a9 1847 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
79072805
LW
1848 }
1849
ffb05e06
NC
1850 SvFLAGS(sv) &= ~SVTYPEMASK;
1851 SvFLAGS(sv) |= mt;
1852
79072805
LW
1853 switch (mt) {
1854 case SVt_NULL:
cea2e8a9 1855 Perl_croak(aTHX_ "Can't upgrade to undef");
79072805 1856 case SVt_IV:
339049b0 1857 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
45977657 1858 SvIV_set(sv, iv);
79072805
LW
1859 break;
1860 case SVt_NV:
1861 SvANY(sv) = new_XNV();
9d6ce603 1862 SvNV_set(sv, nv);
79072805 1863 break;
ed6116ce 1864 case SVt_RV:
339049b0 1865 SvANY(sv) = &sv->sv_u.svu_rv;
b162af07 1866 SvRV_set(sv, (SV*)pv);
ed6116ce 1867 break;
79072805
LW
1868 case SVt_PVHV:
1869 SvANY(sv) = new_XPVHV();
463ee0b2
LW
1870 HvFILL(sv) = 0;
1871 HvMAX(sv) = 0;
8aacddc1 1872 HvTOTALKEYS(sv) = 0;
bd4b1eb5
NC
1873
1874 /* Fall through... */
1875 if (0) {
1876 case SVt_PVAV:
1877 SvANY(sv) = new_XPVAV();
1878 AvMAX(sv) = -1;
1879 AvFILLp(sv) = -1;
1880 AvALLOC(sv) = 0;
11ca45c0 1881 AvREAL_only(sv);
bd4b1eb5
NC
1882 }
1883 /* to here. */
c2bfdfaf
NC
1884 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1885 assert(!pv);
8bd4d4c5
NC
1886 /* FIXME. Should be able to remove all this if()... if the above
1887 assertion is genuinely always true. */
1888 if(SvOOK(sv)) {
1889 pv -= iv;
1890 SvFLAGS(sv) &= ~SVf_OOK;
1891 }
1892 Safefree(pv);
bd4b1eb5 1893 SvPV_set(sv, (char*)0);
b162af07
SP
1894 SvMAGIC_set(sv, magic);
1895 SvSTASH_set(sv, stash);
79072805 1896 break;
bd4b1eb5
NC
1897
1898 case SVt_PVIO:
1899 SvANY(sv) = new_XPVIO();
1900 Zero(SvANY(sv), 1, XPVIO);
1901 IoPAGE_LEN(sv) = 60;
1902 goto set_magic_common;
1903 case SVt_PVFM:
1904 SvANY(sv) = new_XPVFM();
1905 Zero(SvANY(sv), 1, XPVFM);
1906 goto set_magic_common;
1907 case SVt_PVBM:
1908 SvANY(sv) = new_XPVBM();
1909 BmRARE(sv) = 0;
1910 BmUSEFUL(sv) = 0;
1911 BmPREVIOUS(sv) = 0;
1912 goto set_magic_common;
1913 case SVt_PVGV:
1914 SvANY(sv) = new_XPVGV();
1915 GvGP(sv) = 0;
1916 GvNAME(sv) = 0;
1917 GvNAMELEN(sv) = 0;
1918 GvSTASH(sv) = 0;
1919 GvFLAGS(sv) = 0;
1920 goto set_magic_common;
79072805
LW
1921 case SVt_PVCV:
1922 SvANY(sv) = new_XPVCV();
748a9306 1923 Zero(SvANY(sv), 1, XPVCV);
bd4b1eb5
NC
1924 goto set_magic_common;
1925 case SVt_PVLV:
1926 SvANY(sv) = new_XPVLV();
1927 LvTARGOFF(sv) = 0;
1928 LvTARGLEN(sv) = 0;
1929 LvTARG(sv) = 0;
1930 LvTYPE(sv) = 0;
93a17b20 1931 GvGP(sv) = 0;
79072805
LW
1932 GvNAME(sv) = 0;
1933 GvNAMELEN(sv) = 0;
1934 GvSTASH(sv) = 0;
a5f75d66 1935 GvFLAGS(sv) = 0;
bd4b1eb5
NC
1936 /* Fall through. */
1937 if (0) {
1938 case SVt_PVMG:
1939 SvANY(sv) = new_XPVMG();
1940 }
1941 set_magic_common:
b162af07
SP
1942 SvMAGIC_set(sv, magic);
1943 SvSTASH_set(sv, stash);
bd4b1eb5
NC
1944 /* Fall through. */
1945 if (0) {
1946 case SVt_PVNV:
1947 SvANY(sv) = new_XPVNV();
1948 }
9d6ce603 1949 SvNV_set(sv, nv);
bd4b1eb5
NC
1950 /* Fall through. */
1951 if (0) {
1952 case SVt_PVIV:
1953 SvANY(sv) = new_XPVIV();
1954 if (SvNIOK(sv))
1955 (void)SvIOK_on(sv);
1956 SvNOK_off(sv);
1957 }
1958 SvIV_set(sv, iv);
1959 /* Fall through. */
1960 if (0) {
1961 case SVt_PV:
1962 SvANY(sv) = new_XPV();
1963 }
f880fe2f 1964 SvPV_set(sv, pv);
b162af07
SP
1965 SvCUR_set(sv, cur);
1966 SvLEN_set(sv, len);
8990e307
LW
1967 break;
1968 }
79072805
LW
1969}
1970
645c22ef
DM
1971/*
1972=for apidoc sv_backoff
1973
1974Remove any string offset. You should normally use the C<SvOOK_off> macro
1975wrapper instead.
1976
1977=cut
1978*/
1979
79072805 1980int
864dbfa3 1981Perl_sv_backoff(pTHX_ register SV *sv)
79072805
LW
1982{
1983 assert(SvOOK(sv));
b79f7545
NC
1984 assert(SvTYPE(sv) != SVt_PVHV);
1985 assert(SvTYPE(sv) != SVt_PVAV);
463ee0b2 1986 if (SvIVX(sv)) {
3f7c398e 1987 const char *s = SvPVX_const(sv);
b162af07 1988 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
f880fe2f 1989 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
79072805 1990 SvIV_set(sv, 0);
463ee0b2 1991 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
79072805
LW
1992 }
1993 SvFLAGS(sv) &= ~SVf_OOK;
a0d0e21e 1994 return 0;
79072805
LW
1995}
1996
954c1994
GS
1997/*
1998=for apidoc sv_grow
1999
645c22ef
DM
2000Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2001upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2002Use the C<SvGROW> wrapper instead.
954c1994
GS
2003
2004=cut
2005*/
2006
79072805 2007char *
864dbfa3 2008Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
79072805
LW
2009{
2010 register char *s;
2011
55497cff 2012#ifdef HAS_64K_LIMIT
79072805 2013 if (newlen >= 0x10000) {
1d7c1841
GS
2014 PerlIO_printf(Perl_debug_log,
2015 "Allocation too large: %"UVxf"\n", (UV)newlen);
79072805
LW
2016 my_exit(1);
2017 }
55497cff 2018#endif /* HAS_64K_LIMIT */
a0d0e21e
LW
2019 if (SvROK(sv))
2020 sv_unref(sv);
79072805
LW
2021 if (SvTYPE(sv) < SVt_PV) {
2022 sv_upgrade(sv, SVt_PV);
93524f2b 2023 s = SvPVX_mutable(sv);
79072805
LW
2024 }
2025 else if (SvOOK(sv)) { /* pv is offset? */
2026 sv_backoff(sv);
93524f2b 2027 s = SvPVX_mutable(sv);
79072805
LW
2028 if (newlen > SvLEN(sv))
2029 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
c6f8c383
GA
2030#ifdef HAS_64K_LIMIT
2031 if (newlen >= 0x10000)
2032 newlen = 0xFFFF;
2033#endif
79072805 2034 }
bc44a8a2 2035 else
4d84ee25 2036 s = SvPVX_mutable(sv);
54f0641b 2037
79072805 2038 if (newlen > SvLEN(sv)) { /* need more room? */
7a9b70e9 2039 newlen = PERL_STRLEN_ROUNDUP(newlen);
8d6dde3e 2040 if (SvLEN(sv) && s) {
7bab3ede 2041#ifdef MYMALLOC
93524f2b 2042 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
8d6dde3e
IZ
2043 if (newlen <= l) {
2044 SvLEN_set(sv, l);
2045 return s;
2046 } else
c70c8a0a 2047#endif
1936d2a7 2048 s = saferealloc(s, newlen);
8d6dde3e 2049 }
bfed75c6 2050 else {
1936d2a7 2051 s = safemalloc(newlen);
3f7c398e
SP
2052 if (SvPVX_const(sv) && SvCUR(sv)) {
2053 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
40565179 2054 }
4e83176d 2055 }
79072805 2056 SvPV_set(sv, s);
e1ec3a88 2057 SvLEN_set(sv, newlen);
79072805
LW
2058 }
2059 return s;
2060}
2061
954c1994
GS
2062/*
2063=for apidoc sv_setiv
2064
645c22ef
DM
2065Copies an integer into the given SV, upgrading first if necessary.
2066Does not handle 'set' magic. See also C<sv_setiv_mg>.
954c1994
GS
2067
2068=cut
2069*/
2070
79072805 2071void
864dbfa3 2072Perl_sv_setiv(pTHX_ register SV *sv, IV i)
79072805 2073{
765f542d 2074 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2
LW
2075 switch (SvTYPE(sv)) {
2076 case SVt_NULL:
79072805 2077 sv_upgrade(sv, SVt_IV);
463ee0b2
LW
2078 break;
2079 case SVt_NV:
2080 sv_upgrade(sv, SVt_PVNV);
2081 break;
ed6116ce 2082 case SVt_RV:
463ee0b2 2083 case SVt_PV:
79072805 2084 sv_upgrade(sv, SVt_PVIV);
463ee0b2 2085 break;
a0d0e21e
LW
2086
2087 case SVt_PVGV:
a0d0e21e
LW
2088 case SVt_PVAV:
2089 case SVt_PVHV:
2090 case SVt_PVCV:
2091 case SVt_PVFM:
2092 case SVt_PVIO:
411caa50 2093 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
53e06cf0 2094 OP_DESC(PL_op));
463ee0b2 2095 }
a0d0e21e 2096 (void)SvIOK_only(sv); /* validate number */
45977657 2097 SvIV_set(sv, i);
463ee0b2 2098 SvTAINT(sv);
79072805
LW
2099}
2100
954c1994
GS
2101/*
2102=for apidoc sv_setiv_mg
2103
2104Like C<sv_setiv>, but also handles 'set' magic.
2105
2106=cut
2107*/
2108
79072805 2109void
864dbfa3 2110Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
ef50df4b
GS
2111{
2112 sv_setiv(sv,i);
2113 SvSETMAGIC(sv);
2114}
2115
954c1994
GS
2116/*
2117=for apidoc sv_setuv
2118
645c22ef
DM
2119Copies an unsigned integer into the given SV, upgrading first if necessary.
2120Does not handle 'set' magic. See also C<sv_setuv_mg>.
954c1994
GS
2121
2122=cut
2123*/
2124
ef50df4b 2125void
864dbfa3 2126Perl_sv_setuv(pTHX_ register SV *sv, UV u)
55497cff 2127{
55ada374
NC
2128 /* With these two if statements:
2129 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2130
55ada374
NC
2131 without
2132 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2133
55ada374
NC
2134 If you wish to remove them, please benchmark to see what the effect is
2135 */
28e5dec8
JH
2136 if (u <= (UV)IV_MAX) {
2137 sv_setiv(sv, (IV)u);
2138 return;
2139 }
25da4f38
IZ
2140 sv_setiv(sv, 0);
2141 SvIsUV_on(sv);
607fa7f2 2142 SvUV_set(sv, u);
55497cff
PP
2143}
2144
954c1994
GS
2145/*
2146=for apidoc sv_setuv_mg
2147
2148Like C<sv_setuv>, but also handles 'set' magic.
2149
2150=cut
2151*/
2152
55497cff 2153void
864dbfa3 2154Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
ef50df4b 2155{
55ada374
NC
2156 /* With these two if statements:
2157 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2158
55ada374
NC
2159 without
2160 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2161
55ada374
NC
2162 If you wish to remove them, please benchmark to see what the effect is
2163 */
28e5dec8
JH
2164 if (u <= (UV)IV_MAX) {
2165 sv_setiv(sv, (IV)u);
2166 } else {
2167 sv_setiv(sv, 0);
2168 SvIsUV_on(sv);
2169 sv_setuv(sv,u);
2170 }
ef50df4b
GS
2171 SvSETMAGIC(sv);
2172}
2173
954c1994
GS
2174/*
2175=for apidoc sv_setnv
2176
645c22ef
DM
2177Copies a double into the given SV, upgrading first if necessary.
2178Does not handle 'set' magic. See also C<sv_setnv_mg>.
954c1994
GS
2179
2180=cut
2181*/
2182
ef50df4b 2183void
65202027 2184Perl_sv_setnv(pTHX_ register SV *sv, NV num)
79072805 2185{
765f542d 2186 SV_CHECK_THINKFIRST_COW_DROP(sv);
a0d0e21e
LW
2187 switch (SvTYPE(sv)) {
2188 case SVt_NULL:
2189 case SVt_IV:
79072805 2190 sv_upgrade(sv, SVt_NV);
a0d0e21e 2191 break;
a0d0e21e
LW
2192 case SVt_RV:
2193 case SVt_PV:
2194 case SVt_PVIV:
79072805 2195 sv_upgrade(sv, SVt_PVNV);
a0d0e21e 2196 break;
827b7e14 2197
a0d0e21e 2198 case SVt_PVGV:
a0d0e21e
LW
2199 case SVt_PVAV:
2200 case SVt_PVHV:
2201 case SVt_PVCV:
2202 case SVt_PVFM:
2203 case SVt_PVIO:
411caa50 2204 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
53e06cf0 2205 OP_NAME(PL_op));
79072805 2206 }
9d6ce603 2207 SvNV_set(sv, num);
a0d0e21e 2208 (void)SvNOK_only(sv); /* validate number */
463ee0b2 2209 SvTAINT(sv);
79072805
LW
2210}
2211
954c1994
GS
2212/*
2213=for apidoc sv_setnv_mg
2214
2215Like C<sv_setnv>, but also handles 'set' magic.
2216
2217=cut
2218*/
2219
ef50df4b 2220void
65202027 2221Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
ef50df4b
GS
2222{
2223 sv_setnv(sv,num);
2224 SvSETMAGIC(sv);
2225}
2226
645c22ef
DM
2227/* Print an "isn't numeric" warning, using a cleaned-up,
2228 * printable version of the offending string
2229 */
2230
76e3520e 2231STATIC void
cea2e8a9 2232S_not_a_number(pTHX_ SV *sv)
a0d0e21e 2233{
94463019
JH
2234 SV *dsv;
2235 char tmpbuf[64];
2236 char *pv;
2237
2238 if (DO_UTF8(sv)) {
2239 dsv = sv_2mortal(newSVpv("", 0));
2240 pv = sv_uni_display(dsv, sv, 10, 0);
2241 } else {
2242 char *d = tmpbuf;
2243 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2244 /* each *s can expand to 4 chars + "...\0",
2245 i.e. need room for 8 chars */
ecdeb87c 2246
e62f0680
NC
2247 const char *s, *end;
2248 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
2249 s++) {
94463019
JH
2250 int ch = *s & 0xFF;
2251 if (ch & 128 && !isPRINT_LC(ch)) {
2252 *d++ = 'M';
2253 *d++ = '-';
2254 ch &= 127;
2255 }
2256 if (ch == '\n') {
2257 *d++ = '\\';
2258 *d++ = 'n';
2259 }
2260 else if (ch == '\r') {
2261 *d++ = '\\';
2262 *d++ = 'r';
2263 }
2264 else if (ch == '\f') {
2265 *d++ = '\\';
2266 *d++ = 'f';
2267 }
2268 else if (ch == '\\') {
2269 *d++ = '\\';
2270 *d++ = '\\';
2271 }
2272 else if (ch == '\0') {
2273 *d++ = '\\';
2274 *d++ = '0';
2275 }
2276 else if (isPRINT_LC(ch))
2277 *d++ = ch;
2278 else {
2279 *d++ = '^';
2280 *d++ = toCTRL(ch);
2281 }
2282 }
2283 if (s < end) {
2284 *d++ = '.';
2285 *d++ = '.';
2286 *d++ = '.';
2287 }
2288 *d = '\0';
2289 pv = tmpbuf;
a0d0e21e 2290 }
a0d0e21e 2291
533c011a 2292 if (PL_op)
9014280d 2293 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019
JH
2294 "Argument \"%s\" isn't numeric in %s", pv,
2295 OP_DESC(PL_op));
a0d0e21e 2296 else
9014280d 2297 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019 2298 "Argument \"%s\" isn't numeric", pv);
a0d0e21e
LW
2299}
2300
c2988b20
NC
2301/*
2302=for apidoc looks_like_number
2303
645c22ef
DM
2304Test if the content of an SV looks like a number (or is a number).
2305C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2306non-numeric warning), even if your atof() doesn't grok them.
c2988b20
NC
2307
2308=cut
2309*/
2310
2311I32
2312Perl_looks_like_number(pTHX_ SV *sv)
2313{
a3b680e6 2314 register const char *sbegin;
c2988b20
NC
2315 STRLEN len;
2316
2317 if (SvPOK(sv)) {
3f7c398e 2318 sbegin = SvPVX_const(sv);
c2988b20
NC
2319 len = SvCUR(sv);
2320 }
2321 else if (SvPOKp(sv))
83003860 2322 sbegin = SvPV_const(sv, len);
c2988b20 2323 else
e0ab1c0e 2324 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
c2988b20
NC
2325 return grok_number(sbegin, len, NULL);
2326}
25da4f38
IZ
2327
2328/* Actually, ISO C leaves conversion of UV to IV undefined, but
2329 until proven guilty, assume that things are not that bad... */
2330
645c22ef
DM
2331/*
2332 NV_PRESERVES_UV:
2333
2334 As 64 bit platforms often have an NV that doesn't preserve all bits of
28e5dec8
JH
2335 an IV (an assumption perl has been based on to date) it becomes necessary
2336 to remove the assumption that the NV always carries enough precision to
2337 recreate the IV whenever needed, and that the NV is the canonical form.
2338 Instead, IV/UV and NV need to be given equal rights. So as to not lose
645c22ef 2339 precision as a side effect of conversion (which would lead to insanity
28e5dec8
JH
2340 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2341 1) to distinguish between IV/UV/NV slots that have cached a valid
2342 conversion where precision was lost and IV/UV/NV slots that have a
2343 valid conversion which has lost no precision
645c22ef 2344 2) to ensure that if a numeric conversion to one form is requested that
28e5dec8
JH
2345 would lose precision, the precise conversion (or differently
2346 imprecise conversion) is also performed and cached, to prevent
2347 requests for different numeric formats on the same SV causing
2348 lossy conversion chains. (lossless conversion chains are perfectly
2349 acceptable (still))
2350
2351
2352 flags are used:
2353 SvIOKp is true if the IV slot contains a valid value
2354 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2355 SvNOKp is true if the NV slot contains a valid value
2356 SvNOK is true only if the NV value is accurate
2357
2358 so
645c22ef 2359 while converting from PV to NV, check to see if converting that NV to an
28e5dec8
JH
2360 IV(or UV) would lose accuracy over a direct conversion from PV to
2361 IV(or UV). If it would, cache both conversions, return NV, but mark
2362 SV as IOK NOKp (ie not NOK).
2363
645c22ef 2364 While converting from PV to IV, check to see if converting that IV to an
28e5dec8
JH
2365 NV would lose accuracy over a direct conversion from PV to NV. If it
2366 would, cache both conversions, flag similarly.
2367
2368 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2369 correctly because if IV & NV were set NV *always* overruled.
645c22ef
DM
2370 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2371 changes - now IV and NV together means that the two are interchangeable:
28e5dec8 2372 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
d460ef45 2373
645c22ef
DM
2374 The benefit of this is that operations such as pp_add know that if
2375 SvIOK is true for both left and right operands, then integer addition
2376 can be used instead of floating point (for cases where the result won't
2377 overflow). Before, floating point was always used, which could lead to
28e5dec8
JH
2378 loss of precision compared with integer addition.
2379
2380 * making IV and NV equal status should make maths accurate on 64 bit
2381 platforms
2382 * may speed up maths somewhat if pp_add and friends start to use
645c22ef 2383 integers when possible instead of fp. (Hopefully the overhead in
28e5dec8
JH
2384 looking for SvIOK and checking for overflow will not outweigh the
2385 fp to integer speedup)
2386 * will slow down integer operations (callers of SvIV) on "inaccurate"
2387 values, as the change from SvIOK to SvIOKp will cause a call into
2388 sv_2iv each time rather than a macro access direct to the IV slot
2389 * should speed up number->string conversion on integers as IV is
645c22ef 2390 favoured when IV and NV are equally accurate
28e5dec8
JH
2391
2392 ####################################################################
645c22ef
DM
2393 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2394 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2395 On the other hand, SvUOK is true iff UV.
28e5dec8
JH
2396 ####################################################################
2397
645c22ef 2398 Your mileage will vary depending your CPU's relative fp to integer
28e5dec8
JH
2399 performance ratio.
2400*/
2401
2402#ifndef NV_PRESERVES_UV
645c22ef
DM
2403# define IS_NUMBER_UNDERFLOW_IV 1
2404# define IS_NUMBER_UNDERFLOW_UV 2
2405# define IS_NUMBER_IV_AND_UV 2
2406# define IS_NUMBER_OVERFLOW_IV 4
2407# define IS_NUMBER_OVERFLOW_UV 5
2408
2409/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
28e5dec8
JH
2410
2411/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2412STATIC int
645c22ef 2413S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
28e5dec8 2414{
3f7c398e 2415 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
2416 if (SvNVX(sv) < (NV)IV_MIN) {
2417 (void)SvIOKp_on(sv);
2418 (void)SvNOK_on(sv);
45977657 2419 SvIV_set(sv, IV_MIN);
28e5dec8
JH
2420 return IS_NUMBER_UNDERFLOW_IV;
2421 }
2422 if (SvNVX(sv) > (NV)UV_MAX) {
2423 (void)SvIOKp_on(sv);
2424 (void)SvNOK_on(sv);
2425 SvIsUV_on(sv);
607fa7f2 2426 SvUV_set(sv, UV_MAX);
28e5dec8
JH
2427 return IS_NUMBER_OVERFLOW_UV;
2428 }
c2988b20
NC
2429 (void)SvIOKp_on(sv);
2430 (void)SvNOK_on(sv);
2431 /* Can't use strtol etc to convert this string. (See truth table in
2432 sv_2iv */
2433 if (SvNVX(sv) <= (UV)IV_MAX) {
45977657 2434 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2435 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2436 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2437 } else {
2438 /* Integer is imprecise. NOK, IOKp */
2439 }
2440 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2441 }
2442 SvIsUV_on(sv);
607fa7f2 2443 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2444 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2445 if (SvUVX(sv) == UV_MAX) {
2446 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2447 possibly be preserved by NV. Hence, it must be overflow.
2448 NOK, IOKp */
2449 return IS_NUMBER_OVERFLOW_UV;
2450 }
2451 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2452 } else {
2453 /* Integer is imprecise. NOK, IOKp */
28e5dec8 2454 }
c2988b20 2455 return IS_NUMBER_OVERFLOW_IV;
28e5dec8 2456}
645c22ef
DM
2457#endif /* !NV_PRESERVES_UV*/
2458
891f9566
YST
2459/* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2460 * this function provided for binary compatibility only
2461 */
2462
2463IV
2464Perl_sv_2iv(pTHX_ register SV *sv)
2465{
2466 return sv_2iv_flags(sv, SV_GMAGIC);
2467}
2468
645c22ef 2469/*
891f9566 2470=for apidoc sv_2iv_flags
645c22ef 2471
891f9566
YST
2472Return the integer value of an SV, doing any necessary string
2473conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2474Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
645c22ef
DM
2475
2476=cut
2477*/
28e5dec8 2478
a0d0e21e 2479IV
891f9566 2480Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
79072805
LW
2481{
2482 if (!sv)
2483 return 0;
8990e307 2484 if (SvGMAGICAL(sv)) {
891f9566
YST
2485 if (flags & SV_GMAGIC)
2486 mg_get(sv);
463ee0b2
LW
2487 if (SvIOKp(sv))
2488 return SvIVX(sv);
748a9306 2489 if (SvNOKp(sv)) {
25da4f38 2490 return I_V(SvNVX(sv));
748a9306 2491 }
36477c24
PP
2492 if (SvPOKp(sv) && SvLEN(sv))
2493 return asIV(sv);
3fe9a6f1 2494 if (!SvROK(sv)) {
d008e5eb 2495 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2496 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2497 report_uninit(sv);
c6ee37c5 2498 }
36477c24 2499 return 0;
3fe9a6f1 2500 }
463ee0b2 2501 }
ed6116ce 2502 if (SvTHINKFIRST(sv)) {
a0d0e21e 2503 if (SvROK(sv)) {
a0d0e21e 2504 SV* tmpstr;
1554e226 2505 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2506 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2507 return SvIV(tmpstr);
56431972 2508 return PTR2IV(SvRV(sv));
a0d0e21e 2509 }
765f542d
NC
2510 if (SvIsCOW(sv)) {
2511 sv_force_normal_flags(sv, 0);
47deb5e7 2512 }
0336b60e 2513 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2514 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2515 report_uninit(sv);
ed6116ce
LW
2516 return 0;
2517 }
79072805 2518 }
25da4f38
IZ
2519 if (SvIOKp(sv)) {
2520 if (SvIsUV(sv)) {
2521 return (IV)(SvUVX(sv));
2522 }
2523 else {
2524 return SvIVX(sv);
2525 }
463ee0b2 2526 }
748a9306 2527 if (SvNOKp(sv)) {
28e5dec8
JH
2528 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2529 * without also getting a cached IV/UV from it at the same time
2530 * (ie PV->NV conversion should detect loss of accuracy and cache
2531 * IV or UV at same time to avoid this. NWC */
25da4f38
IZ
2532
2533 if (SvTYPE(sv) == SVt_NV)
2534 sv_upgrade(sv, SVt_PVNV);
2535
28e5dec8
JH
2536 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2537 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2538 certainly cast into the IV range at IV_MAX, whereas the correct
2539 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2540 cases go to UV */
2541 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2542 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2543 if (SvNVX(sv) == (NV) SvIVX(sv)
2544#ifndef NV_PRESERVES_UV
2545 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2546 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2547 /* Don't flag it as "accurately an integer" if the number
2548 came from a (by definition imprecise) NV operation, and
2549 we're outside the range of NV integer precision */
2550#endif
2551 ) {
2552 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2553 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2554 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2555 PTR2UV(sv),
2556 SvNVX(sv),
2557 SvIVX(sv)));
2558
2559 } else {
2560 /* IV not precise. No need to convert from PV, as NV
2561 conversion would already have cached IV if it detected
2562 that PV->IV would be better than PV->NV->IV
2563 flags already correct - don't set public IOK. */
2564 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2565 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2566 PTR2UV(sv),
2567 SvNVX(sv),
2568 SvIVX(sv)));
2569 }
2570 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2571 but the cast (NV)IV_MIN rounds to a the value less (more
2572 negative) than IV_MIN which happens to be equal to SvNVX ??
2573 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2574 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2575 (NV)UVX == NVX are both true, but the values differ. :-(
2576 Hopefully for 2s complement IV_MIN is something like
2577 0x8000000000000000 which will be exact. NWC */
d460ef45 2578 }
25da4f38 2579 else {
607fa7f2 2580 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2581 if (
2582 (SvNVX(sv) == (NV) SvUVX(sv))
2583#ifndef NV_PRESERVES_UV
2584 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2585 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2586 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2587 /* Don't flag it as "accurately an integer" if the number
2588 came from a (by definition imprecise) NV operation, and
2589 we're outside the range of NV integer precision */
2590#endif
2591 )
2592 SvIOK_on(sv);
25da4f38
IZ
2593 SvIsUV_on(sv);
2594 ret_iv_max:
1c846c1f 2595 DEBUG_c(PerlIO_printf(Perl_debug_log,
57def98f 2596 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
56431972 2597 PTR2UV(sv),
57def98f
JH
2598 SvUVX(sv),
2599 SvUVX(sv)));
25da4f38
IZ
2600 return (IV)SvUVX(sv);
2601 }
748a9306
LW
2602 }
2603 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2604 UV value;
504618e9 2605 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
25da4f38
IZ
2606 /* We want to avoid a possible problem when we cache an IV which
2607 may be later translated to an NV, and the resulting NV is not
c2988b20
NC
2608 the same as the direct translation of the initial string
2609 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2610 be careful to ensure that the value with the .456 is around if the
2611 NV value is requested in the future).
1c846c1f 2612
25da4f38
IZ
2613 This means that if we cache such an IV, we need to cache the
2614 NV as well. Moreover, we trade speed for space, and do not
28e5dec8 2615 cache the NV if we are sure it's not needed.
25da4f38 2616 */
16b7a9a4 2617
c2988b20
NC
2618 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2619 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2620 == IS_NUMBER_IN_UV) {
5e045b90 2621 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8
JH
2622 if (SvTYPE(sv) < SVt_PVIV)
2623 sv_upgrade(sv, SVt_PVIV);
f7bbb42a 2624 (void)SvIOK_on(sv);
c2988b20
NC
2625 } else if (SvTYPE(sv) < SVt_PVNV)
2626 sv_upgrade(sv, SVt_PVNV);
28e5dec8 2627
c2988b20
NC
2628 /* If NV preserves UV then we only use the UV value if we know that
2629 we aren't going to call atof() below. If NVs don't preserve UVs
2630 then the value returned may have more precision than atof() will
2631 return, even though value isn't perfectly accurate. */
2632 if ((numtype & (IS_NUMBER_IN_UV
2633#ifdef NV_PRESERVES_UV
2634 | IS_NUMBER_NOT_INT
2635#endif
2636 )) == IS_NUMBER_IN_UV) {
2637 /* This won't turn off the public IOK flag if it was set above */
2638 (void)SvIOKp_on(sv);
2639
2640 if (!(numtype & IS_NUMBER_NEG)) {
2641 /* positive */;
2642 if (value <= (UV)IV_MAX) {
45977657 2643 SvIV_set(sv, (IV)value);
c2988b20 2644 } else {
607fa7f2 2645 SvUV_set(sv, value);
c2988b20
NC
2646 SvIsUV_on(sv);
2647 }
2648 } else {
2649 /* 2s complement assumption */
2650 if (value <= (UV)IV_MIN) {
45977657 2651 SvIV_set(sv, -(IV)value);
c2988b20
NC
2652 } else {
2653 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2654 I'm assuming it will be rare. */
c2988b20
NC
2655 if (SvTYPE(sv) < SVt_PVNV)
2656 sv_upgrade(sv, SVt_PVNV);
2657 SvNOK_on(sv);
2658 SvIOK_off(sv);
2659 SvIOKp_on(sv);
9d6ce603 2660 SvNV_set(sv, -(NV)value);
45977657 2661 SvIV_set(sv, IV_MIN);
c2988b20
NC
2662 }
2663 }
2664 }
2665 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2666 will be in the previous block to set the IV slot, and the next
2667 block to set the NV slot. So no else here. */
2668
2669 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2670 != IS_NUMBER_IN_UV) {
2671 /* It wasn't an (integer that doesn't overflow the UV). */
3f7c398e 2672 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8 2673
c2988b20
NC
2674 if (! numtype && ckWARN(WARN_NUMERIC))
2675 not_a_number(sv);
28e5dec8 2676
65202027 2677#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2678 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2679 PTR2UV(sv), SvNVX(sv)));
65202027 2680#else
1779d84d 2681 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
c2988b20 2682 PTR2UV(sv), SvNVX(sv)));
65202027 2683#endif
28e5dec8
JH
2684
2685
2686#ifdef NV_PRESERVES_UV
c2988b20
NC
2687 (void)SvIOKp_on(sv);
2688 (void)SvNOK_on(sv);
2689 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2690 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2691 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2692 SvIOK_on(sv);
28e5dec8 2693 } else {
c2988b20
NC
2694 /* Integer is imprecise. NOK, IOKp */
2695 }
2696 /* UV will not work better than IV */
2697 } else {
2698 if (SvNVX(sv) > (NV)UV_MAX) {
2699 SvIsUV_on(sv);
2700 /* Integer is inaccurate. NOK, IOKp, is UV */
607fa7f2 2701 SvUV_set(sv, UV_MAX);
c2988b20
NC
2702 SvIsUV_on(sv);
2703 } else {
607fa7f2 2704 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2705 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2706 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2707 SvIOK_on(sv);
28e5dec8
JH
2708 SvIsUV_on(sv);
2709 } else {
c2988b20
NC
2710 /* Integer is imprecise. NOK, IOKp, is UV */
2711 SvIsUV_on(sv);
28e5dec8 2712 }
28e5dec8 2713 }
c2988b20
NC
2714 goto ret_iv_max;
2715 }
28e5dec8 2716#else /* NV_PRESERVES_UV */
c2988b20
NC
2717 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2718 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2719 /* The IV slot will have been set from value returned by
2720 grok_number above. The NV slot has just been set using
2721 Atof. */
560b0c46 2722 SvNOK_on(sv);
c2988b20
NC
2723 assert (SvIOKp(sv));
2724 } else {
2725 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2726 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2727 /* Small enough to preserve all bits. */
2728 (void)SvIOKp_on(sv);
2729 SvNOK_on(sv);
45977657 2730 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2731 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2732 SvIOK_on(sv);
2733 /* Assumption: first non-preserved integer is < IV_MAX,
2734 this NV is in the preserved range, therefore: */
2735 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2736 < (UV)IV_MAX)) {
32fdb065 2737 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
2738 }
2739 } else {
2740 /* IN_UV NOT_INT
2741 0 0 already failed to read UV.
2742 0 1 already failed to read UV.
2743 1 0 you won't get here in this case. IV/UV
2744 slot set, public IOK, Atof() unneeded.
2745 1 1 already read UV.
2746 so there's no point in sv_2iuv_non_preserve() attempting
2747 to use atol, strtol, strtoul etc. */
2748 if (sv_2iuv_non_preserve (sv, numtype)
2749 >= IS_NUMBER_OVERFLOW_IV)
2750 goto ret_iv_max;
2751 }
2752 }
28e5dec8 2753#endif /* NV_PRESERVES_UV */
25da4f38 2754 }
28e5dec8 2755 } else {
599cee73 2756 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 2757 report_uninit(sv);
25da4f38
IZ
2758 if (SvTYPE(sv) < SVt_IV)
2759 /* Typically the caller expects that sv_any is not NULL now. */
2760 sv_upgrade(sv, SVt_IV);
a0d0e21e 2761 return 0;
79072805 2762 }
1d7c1841
GS
2763 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2764 PTR2UV(sv),SvIVX(sv)));
25da4f38 2765 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
79072805
LW
2766}
2767
891f9566
YST
2768/* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2769 * this function provided for binary compatibility only
2770 */
2771
2772UV
2773Perl_sv_2uv(pTHX_ register SV *sv)
2774{
2775 return sv_2uv_flags(sv, SV_GMAGIC);
2776}
2777
645c22ef 2778/*
891f9566 2779=for apidoc sv_2uv_flags
645c22ef
DM
2780
2781Return the unsigned integer value of an SV, doing any necessary string
891f9566
YST
2782conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2783Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
645c22ef
DM
2784
2785=cut
2786*/
2787
ff68c719 2788UV
891f9566 2789Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
ff68c719
PP
2790{
2791 if (!sv)
2792 return 0;
2793 if (SvGMAGICAL(sv)) {
891f9566
YST
2794 if (flags & SV_GMAGIC)
2795 mg_get(sv);
ff68c719
PP
2796 if (SvIOKp(sv))
2797 return SvUVX(sv);
2798 if (SvNOKp(sv))
2799 return U_V(SvNVX(sv));
36477c24
PP
2800 if (SvPOKp(sv) && SvLEN(sv))
2801 return asUV(sv);
3fe9a6f1 2802 if (!SvROK(sv)) {
d008e5eb 2803 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2804 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2805 report_uninit(sv);
c6ee37c5 2806 }
36477c24 2807 return 0;
3fe9a6f1 2808 }
ff68c719
PP
2809 }
2810 if (SvTHINKFIRST(sv)) {
2811 if (SvROK(sv)) {
ff68c719 2812 SV* tmpstr;
1554e226 2813 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2814 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2815 return SvUV(tmpstr);
56431972 2816 return PTR2UV(SvRV(sv));
ff68c719 2817 }
765f542d
NC
2818 if (SvIsCOW(sv)) {
2819 sv_force_normal_flags(sv, 0);
8a818333 2820 }
0336b60e 2821 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2822 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2823 report_uninit(sv);
ff68c719
PP
2824 return 0;
2825 }
2826 }
25da4f38
IZ
2827 if (SvIOKp(sv)) {
2828 if (SvIsUV(sv)) {
2829 return SvUVX(sv);
2830 }
2831 else {
2832 return (UV)SvIVX(sv);
2833 }
ff68c719
PP
2834 }
2835 if (SvNOKp(sv)) {
28e5dec8
JH
2836 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2837 * without also getting a cached IV/UV from it at the same time
2838 * (ie PV->NV conversion should detect loss of accuracy and cache
2839 * IV or UV at same time to avoid this. */
2840 /* IV-over-UV optimisation - choose to cache IV if possible */
2841
25da4f38
IZ
2842 if (SvTYPE(sv) == SVt_NV)
2843 sv_upgrade(sv, SVt_PVNV);
28e5dec8
JH
2844
2845 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2846 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2847 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2848 if (SvNVX(sv) == (NV) SvIVX(sv)
2849#ifndef NV_PRESERVES_UV
2850 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2851 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2852 /* Don't flag it as "accurately an integer" if the number
2853 came from a (by definition imprecise) NV operation, and
2854 we're outside the range of NV integer precision */
2855#endif
2856 ) {
2857 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2858 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2859 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2860 PTR2UV(sv),
2861 SvNVX(sv),
2862 SvIVX(sv)));
2863
2864 } else {
2865 /* IV not precise. No need to convert from PV, as NV
2866 conversion would already have cached IV if it detected
2867 that PV->IV would be better than PV->NV->IV
2868 flags already correct - don't set public IOK. */
2869 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2870 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2871 PTR2UV(sv),
2872 SvNVX(sv),
2873 SvIVX(sv)));
2874 }
2875 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2876 but the cast (NV)IV_MIN rounds to a the value less (more
2877 negative) than IV_MIN which happens to be equal to SvNVX ??
2878 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2879 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2880 (NV)UVX == NVX are both true, but the values differ. :-(
2881 Hopefully for 2s complement IV_MIN is something like
2882 0x8000000000000000 which will be exact. NWC */
d460ef45 2883 }
28e5dec8 2884 else {
607fa7f2 2885 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2886 if (
2887 (SvNVX(sv) == (NV) SvUVX(sv))
2888#ifndef NV_PRESERVES_UV
2889 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2890 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2891 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2892 /* Don't flag it as "accurately an integer" if the number
2893 came from a (by definition imprecise) NV operation, and
2894 we're outside the range of NV integer precision */
2895#endif
2896 )
2897 SvIOK_on(sv);
2898 SvIsUV_on(sv);
1c846c1f 2899 DEBUG_c(PerlIO_printf(Perl_debug_log,
28e5dec8 2900 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
57def98f 2901 PTR2UV(sv),
28e5dec8
JH
2902 SvUVX(sv),
2903 SvUVX(sv)));
25da4f38 2904 }
ff68c719
PP
2905 }
2906 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2907 UV value;
504618e9 2908 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
25da4f38
IZ
2909
2910 /* We want to avoid a possible problem when we cache a UV which
2911 may be later translated to an NV, and the resulting NV is not
2912 the translation of the initial data.
1c846c1f 2913
25da4f38
IZ
2914 This means that if we cache such a UV, we need to cache the
2915 NV as well. Moreover, we trade speed for space, and do not
2916 cache the NV if not needed.
2917 */
16b7a9a4 2918
c2988b20
NC
2919 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2921 == IS_NUMBER_IN_UV) {
5e045b90 2922 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8 2923 if (SvTYPE(sv) < SVt_PVIV)
f7bbb42a
JH
2924 sv_upgrade(sv, SVt_PVIV);
2925 (void)SvIOK_on(sv);
c2988b20
NC
2926 } else if (SvTYPE(sv) < SVt_PVNV)
2927 sv_upgrade(sv, SVt_PVNV);
d460ef45 2928
c2988b20
NC
2929 /* If NV preserves UV then we only use the UV value if we know that
2930 we aren't going to call atof() below. If NVs don't preserve UVs
2931 then the value returned may have more precision than atof() will
2932 return, even though it isn't accurate. */
2933 if ((numtype & (IS_NUMBER_IN_UV
2934#ifdef NV_PRESERVES_UV
2935 | IS_NUMBER_NOT_INT
2936#endif
2937 )) == IS_NUMBER_IN_UV) {
2938 /* This won't turn off the public IOK flag if it was set above */
2939 (void)SvIOKp_on(sv);
2940
2941 if (!(numtype & IS_NUMBER_NEG)) {
2942 /* positive */;
2943 if (value <= (UV)IV_MAX) {
45977657 2944 SvIV_set(sv, (IV)value);
28e5dec8
JH
2945 } else {
2946 /* it didn't overflow, and it was positive. */
607fa7f2 2947 SvUV_set(sv, value);
28e5dec8
JH
2948 SvIsUV_on(sv);
2949 }
c2988b20
NC
2950 } else {
2951 /* 2s complement assumption */
2952 if (value <= (UV)IV_MIN) {
45977657 2953 SvIV_set(sv, -(IV)value);
c2988b20
NC
2954 } else {
2955 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2956 I'm assuming it will be rare. */
c2988b20
NC
2957 if (SvTYPE(sv) < SVt_PVNV)
2958 sv_upgrade(sv, SVt_PVNV);
2959 SvNOK_on(sv);
2960 SvIOK_off(sv);
2961 SvIOKp_on(sv);
9d6ce603 2962 SvNV_set(sv, -(NV)value);
45977657 2963 SvIV_set(sv, IV_MIN);
c2988b20
NC
2964 }
2965 }
2966 }
2967
2968 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2969 != IS_NUMBER_IN_UV) {
2970 /* It wasn't an integer, or it overflowed the UV. */
3f7c398e 2971 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8 2972
c2988b20 2973 if (! numtype && ckWARN(WARN_NUMERIC))
28e5dec8
JH
2974 not_a_number(sv);
2975
2976#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2977 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2978 PTR2UV(sv), SvNVX(sv)));
28e5dec8 2979#else
1779d84d 2980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
c2988b20 2981 PTR2UV(sv), SvNVX(sv)));
28e5dec8
JH
2982#endif
2983
2984#ifdef NV_PRESERVES_UV
c2988b20
NC
2985 (void)SvIOKp_on(sv);
2986 (void)SvNOK_on(sv);
2987 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2988 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2989 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2990 SvIOK_on(sv);
2991 } else {
2992 /* Integer is imprecise. NOK, IOKp */
2993 }
2994 /* UV will not work better than IV */
2995 } else {
2996 if (SvNVX(sv) > (NV)UV_MAX) {
2997 SvIsUV_on(sv);
2998 /* Integer is inaccurate. NOK, IOKp, is UV */
607fa7f2 2999 SvUV_set(sv, UV_MAX);
c2988b20
NC
3000 SvIsUV_on(sv);
3001 } else {
607fa7f2 3002 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
3003 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3004 NV preservse UV so can do correct comparison. */
3005 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3006 SvIOK_on(sv);
3007 SvIsUV_on(sv);
3008 } else {
3009 /* Integer is imprecise. NOK, IOKp, is UV */
3010 SvIsUV_on(sv);
3011 }
3012 }
3013 }
28e5dec8 3014#else /* NV_PRESERVES_UV */
c2988b20
NC
3015 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3016 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3017 /* The UV slot will have been set from value returned by
3018 grok_number above. The NV slot has just been set using
3019 Atof. */
560b0c46 3020 SvNOK_on(sv);
c2988b20
NC
3021 assert (SvIOKp(sv));
3022 } else {
3023 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3024 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3025 /* Small enough to preserve all bits. */
3026 (void)SvIOKp_on(sv);
3027 SvNOK_on(sv);
45977657 3028 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
3029 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3030 SvIOK_on(sv);
3031 /* Assumption: first non-preserved integer is < IV_MAX,
3032 this NV is in the preserved range, therefore: */
3033 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3034 < (UV)IV_MAX)) {
32fdb065 3035 Perl_croak(aTHX_ "sv_2uv 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
3036 }
3037 } else
3038 sv_2iuv_non_preserve (sv, numtype);
3039 }
28e5dec8 3040#endif /* NV_PRESERVES_UV */
f7bbb42a 3041 }
ff68c719
PP
3042 }
3043 else {
d008e5eb 3044 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3045 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3046 report_uninit(sv);
c6ee37c5 3047 }
25da4f38
IZ
3048 if (SvTYPE(sv) < SVt_IV)
3049 /* Typically the caller expects that sv_any is not NULL now. */
3050 sv_upgrade(sv, SVt_IV);
ff68c719
PP
3051 return 0;
3052 }
25da4f38 3053
1d7c1841
GS
3054 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3055 PTR2UV(sv),SvUVX(sv)));
25da4f38 3056 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
ff68c719
PP
3057}
3058
645c22ef
DM
3059/*
3060=for apidoc sv_2nv
3061
3062Return the num value of an SV, doing any necessary string or integer
3063conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3064macros.
3065
3066=cut
3067*/
3068
65202027 3069NV
864dbfa3 3070Perl_sv_2nv(pTHX_ register SV *sv)
79072805
LW
3071{
3072 if (!sv)
3073 return 0.0;
8990e307 3074 if (SvGMAGICAL(sv)) {
463ee0b2
LW
3075 mg_get(sv);
3076 if (SvNOKp(sv))
3077 return SvNVX(sv);
a0d0e21e 3078 if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 3079 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
504618e9 3080 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
a0d0e21e 3081 not_a_number(sv);
3f7c398e 3082 return Atof(SvPVX_const(sv));
a0d0e21e 3083 }
25da4f38 3084 if (SvIOKp(sv)) {
1c846c1f 3085 if (SvIsUV(sv))
65202027 3086 return (NV)SvUVX(sv);
25da4f38 3087 else
65202027 3088 return (NV)SvIVX(sv);
25da4f38 3089 }
16d20bd9 3090 if (!SvROK(sv)) {
d008e5eb 3091 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3092 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3093 report_uninit(sv);
c6ee37c5 3094 }
66a1b24b 3095 return (NV)0;
16d20bd9 3096 }
463ee0b2 3097 }
ed6116ce 3098 if (SvTHINKFIRST(sv)) {
a0d0e21e 3099 if (SvROK(sv)) {
a0d0e21e 3100 SV* tmpstr;
1554e226 3101 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 3102 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 3103 return SvNV(tmpstr);
56431972 3104 return PTR2NV(SvRV(sv));
a0d0e21e 3105 }
765f542d
NC
3106 if (SvIsCOW(sv)) {
3107 sv_force_normal_flags(sv, 0);
8a818333 3108 }
0336b60e 3109 if (SvREADONLY(sv) && !SvOK(sv)) {
599cee73 3110 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3111 report_uninit(sv);
ed6116ce
LW
3112 return 0.0;
3113 }
79072805
LW
3114 }
3115 if (SvTYPE(sv) < SVt_NV) {
463ee0b2
LW
3116 if (SvTYPE(sv) == SVt_IV)
3117 sv_upgrade(sv, SVt_PVNV);
3118 else
3119 sv_upgrade(sv, SVt_NV);
906f284f 3120#ifdef USE_LONG_DOUBLE
097ee67d 3121 DEBUG_c({
f93f4e46 3122 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3123 PerlIO_printf(Perl_debug_log,
3124 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3125 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3126 RESTORE_NUMERIC_LOCAL();
3127 });
65202027 3128#else
572bbb43 3129 DEBUG_c({
f93f4e46 3130 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3131 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
1d7c1841 3132 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3133 RESTORE_NUMERIC_LOCAL();
3134 });
572bbb43 3135#endif
79072805
LW
3136 }
3137 else if (SvTYPE(sv) < SVt_PVNV)
3138 sv_upgrade(sv, SVt_PVNV);
59d8ce62
NC
3139 if (SvNOKp(sv)) {
3140 return SvNVX(sv);
61604483 3141 }
59d8ce62 3142 if (SvIOKp(sv)) {
9d6ce603 3143 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
28e5dec8
JH
3144#ifdef NV_PRESERVES_UV
3145 SvNOK_on(sv);
3146#else
3147 /* Only set the public NV OK flag if this NV preserves the IV */
3148 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3149 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3150 : (SvIVX(sv) == I_V(SvNVX(sv))))
3151 SvNOK_on(sv);
3152 else
3153 SvNOKp_on(sv);
3154#endif
93a17b20 3155 }
748a9306 3156 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 3157 UV value;
3f7c398e 3158 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
c2988b20 3159 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
a0d0e21e 3160 not_a_number(sv);
28e5dec8 3161#ifdef NV_PRESERVES_UV
c2988b20
NC
3162 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3163 == IS_NUMBER_IN_UV) {
5e045b90 3164 /* It's definitely an integer */
9d6ce603 3165 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
c2988b20 3166 } else
3f7c398e 3167 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8
JH
3168 SvNOK_on(sv);
3169#else
3f7c398e 3170 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8
JH
3171 /* Only set the public NV OK flag if this NV preserves the value in
3172 the PV at least as well as an IV/UV would.
3173 Not sure how to do this 100% reliably. */
3174 /* if that shift count is out of range then Configure's test is
3175 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3176 UV_BITS */
3177 if (((UV)1 << NV_PRESERVES_UV_BITS) >
c2988b20 3178 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
28e5dec8 3179 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
c2988b20
NC
3180 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3181 /* Can't use strtol etc to convert this string, so don't try.
3182 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3183 SvNOK_on(sv);
3184 } else {
3185 /* value has been set. It may not be precise. */
3186 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3187 /* 2s complement assumption for (UV)IV_MIN */
3188 SvNOK_on(sv); /* Integer is too negative. */
3189 } else {
3190 SvNOKp_on(sv);
3191 SvIOKp_on(sv);
6fa402ec 3192
c2988b20 3193 if (numtype & IS_NUMBER_NEG) {
45977657 3194 SvIV_set(sv, -(IV)value);
c2988b20 3195 } else if (value <= (UV)IV_MAX) {
45977657 3196 SvIV_set(sv, (IV)value);
c2988b20 3197 } else {
607fa7f2 3198 SvUV_set(sv, value);
c2988b20
NC
3199 SvIsUV_on(sv);
3200 }
3201
3202 if (numtype & IS_NUMBER_NOT_INT) {
3203 /* I believe that even if the original PV had decimals,
3204 they are lost beyond the limit of the FP precision.
3205 However, neither is canonical, so both only get p
3206 flags. NWC, 2000/11/25 */
3207 /* Both already have p flags, so do nothing */
3208 } else {
66a1b24b 3209 const NV nv = SvNVX(sv);
c2988b20
NC
3210 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3211 if (SvIVX(sv) == I_V(nv)) {
3212 SvNOK_on(sv);
3213 SvIOK_on(sv);
3214 } else {
3215 SvIOK_on(sv);
3216 /* It had no "." so it must be integer. */
3217 }
3218 } else {
3219 /* between IV_MAX and NV(UV_MAX).
3220 Could be slightly > UV_MAX */
6fa402ec 3221
c2988b20
NC
3222 if (numtype & IS_NUMBER_NOT_INT) {
3223 /* UV and NV both imprecise. */
3224 } else {
66a1b24b 3225 const UV nv_as_uv = U_V(nv);
c2988b20
NC
3226
3227 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3228 SvNOK_on(sv);
3229 SvIOK_on(sv);
3230 } else {
3231 SvIOK_on(sv);
3232 }
3233 }
3234 }
3235 }
3236 }
3237 }
28e5dec8 3238#endif /* NV_PRESERVES_UV */
93a17b20 3239 }
79072805 3240 else {
599cee73 3241 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3242 report_uninit(sv);
25da4f38
IZ
3243 if (SvTYPE(sv) < SVt_NV)
3244 /* Typically the caller expects that sv_any is not NULL now. */
28e5dec8
JH
3245 /* XXX Ilya implies that this is a bug in callers that assume this
3246 and ideally should be fixed. */
25da4f38 3247 sv_upgrade(sv, SVt_NV);
a0d0e21e 3248 return 0.0;
79072805 3249 }
572bbb43 3250#if defined(USE_LONG_DOUBLE)
097ee67d 3251 DEBUG_c({
f93f4e46 3252 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3253 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3254 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3255 RESTORE_NUMERIC_LOCAL();
3256 });
65202027 3257#else
572bbb43 3258 DEBUG_c({
f93f4e46 3259 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3260 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
1d7c1841 3261 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3262 RESTORE_NUMERIC_LOCAL();
3263 });
572bbb43 3264#endif
463ee0b2 3265 return SvNVX(sv);
79072805
LW
3266}
3267
645c22ef
DM
3268/* asIV(): extract an integer from the string value of an SV.
3269 * Caller must validate PVX */
3270
76e3520e 3271STATIC IV
cea2e8a9 3272S_asIV(pTHX_ SV *sv)
36477c24 3273{
c2988b20 3274 UV value;
66a1b24b 3275 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
c2988b20
NC
3276
3277 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3278 == IS_NUMBER_IN_UV) {
645c22ef 3279 /* It's definitely an integer */
c2988b20
NC
3280 if (numtype & IS_NUMBER_NEG) {
3281 if (value < (UV)IV_MIN)
3282 return -(IV)value;
3283 } else {
3284 if (value < (UV)IV_MAX)
3285 return (IV)value;
3286 }
3287 }
d008e5eb 3288 if (!numtype) {
d008e5eb
GS
3289 if (ckWARN(WARN_NUMERIC))
3290 not_a_number(sv);
3291 }
3f7c398e 3292 return I_V(Atof(SvPVX_const(sv)));
36477c24
PP
3293}
3294
645c22ef
DM
3295/* asUV(): extract an unsigned integer from the string value of an SV
3296 * Caller must validate PVX */
3297
76e3520e 3298STATIC UV
cea2e8a9 3299S_asUV(pTHX_ SV *sv)
36477c24 3300{
c2988b20 3301 UV value;
504618e9 3302 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
36477c24 3303
c2988b20
NC
3304 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3305 == IS_NUMBER_IN_UV) {
645c22ef 3306 /* It's definitely an integer */
6fa402ec 3307 if (!(numtype & IS_NUMBER_NEG))
c2988b20
NC
3308 return value;
3309 }
d008e5eb 3310 if (!numtype) {
d008e5eb
GS
3311 if (ckWARN(WARN_NUMERIC))
3312 not_a_number(sv);
3313 }
3f7c398e 3314 return U_V(Atof(SvPVX_const(sv)));
36477c24
PP
3315}
3316
645c22ef
DM
3317/*
3318=for apidoc sv_2pv_nolen
3319
3320Like C<sv_2pv()>, but doesn't return the length too. You should usually
3321use the macro wrapper C<SvPV_nolen(sv)> instead.
3322=cut
3323*/
3324
79072805 3325char *
864dbfa3 3326Perl_sv_2pv_nolen(pTHX_ register SV *sv)
1fa8b10d 3327{
dafda6d1 3328 return sv_2pv(sv, 0);
1fa8b10d
JD
3329}
3330
645c22ef
DM
3331/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3332 * UV as a string towards the end of buf, and return pointers to start and
3333 * end of it.
3334 *
3335 * We assume that buf is at least TYPE_CHARS(UV) long.
3336 */
3337
864dbfa3 3338static char *
25da4f38
IZ
3339uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3340{
25da4f38
IZ
3341 char *ptr = buf + TYPE_CHARS(UV);
3342 char *ebuf = ptr;
3343 int sign;
25da4f38
IZ
3344
3345 if (is_uv)
3346 sign = 0;
3347 else if (iv >= 0) {
3348 uv = iv;
3349 sign = 0;
3350 } else {
3351 uv = -iv;
3352 sign = 1;
3353 }
3354 do {
eb160463 3355 *--ptr = '0' + (char)(uv % 10);
25da4f38
IZ
3356 } while (uv /= 10);
3357 if (sign)
3358 *--ptr = '-';
3359 *peob = ebuf;
3360 return ptr;
3361}
3362
09540bc3
JH
3363/* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3364 * this function provided for binary compatibility only
3365 */
3366
3367char *
3368Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3369{
3370 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3371}
3372
645c22ef
DM
3373/*
3374=for apidoc sv_2pv_flags
3375
ff276b08 3376Returns a pointer to the string value of an SV, and sets *lp to its length.
645c22ef
DM
3377If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3378if necessary.
3379Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3380usually end up here too.
3381
3382=cut
3383*/
3384
8d6d96c1
HS
3385char *
3386Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3387{
79072805
LW
3388 register char *s;
3389 int olderrno;
cb50f42d 3390 SV *tsv, *origsv;
25da4f38
IZ
3391 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3392 char *tmpbuf = tbuf;
79072805 3393
463ee0b2 3394 if (!sv) {
cdb061a3
NC
3395 if (lp)
3396 *lp = 0;
73d840c0 3397 return (char *)"";
463ee0b2 3398 }
8990e307 3399 if (SvGMAGICAL(sv)) {
8d6d96c1
HS
3400 if (flags & SV_GMAGIC)
3401 mg_get(sv);
463ee0b2 3402 if (SvPOKp(sv)) {
cdb061a3
NC
3403 if (lp)
3404 *lp = SvCUR(sv);
10516c54
NC
3405 if (flags & SV_MUTABLE_RETURN)
3406 return SvPVX_mutable(sv);
4d84ee25
NC
3407 if (flags & SV_CONST_RETURN)
3408 return (char *)SvPVX_const(sv);
463ee0b2
LW
3409 return SvPVX(sv);
3410 }
cf2093f6 3411 if (SvIOKp(sv)) {
1c846c1f 3412 if (SvIsUV(sv))
57def98f 3413 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
cf2093f6 3414 else
57def98f 3415 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
46fc3d4c 3416 tsv = Nullsv;
a0d0e21e 3417 goto tokensave;
463ee0b2
LW
3418 }
3419 if (SvNOKp(sv)) {
2d4389e4 3420 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
46fc3d4c 3421 tsv = Nullsv;
a0d0e21e 3422 goto tokensave;
463ee0b2 3423 }
16d20bd9 3424 if (!SvROK(sv)) {
d008e5eb 3425 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3426 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3427 report_uninit(sv);
c6ee37c5 3428 }
cdb061a3
NC
3429 if (lp)
3430 *lp = 0;
73d840c0 3431 return (char *)"";
16d20bd9 3432 }
463ee0b2 3433 }
ed6116ce
LW
3434 if (SvTHINKFIRST(sv)) {
3435 if (SvROK(sv)) {
a0d0e21e 3436 SV* tmpstr;
e1ec3a88 3437 register const char *typestr;
1554e226 3438 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
b4b9a328 3439 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
50adf7d2
NC
3440 /* Unwrap this: */
3441 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3442
3443 char *pv;
3444 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3445 if (flags & SV_CONST_RETURN) {
3446 pv = (char *) SvPVX_const(tmpstr);
3447 } else {
3448 pv = (flags & SV_MUTABLE_RETURN)
3449 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3450 }
3451 if (lp)
3452 *lp = SvCUR(tmpstr);
3453 } else {
3454 pv = sv_2pv_flags(tmpstr, lp, flags);
3455 }
446eaa42
YST
3456 if (SvUTF8(tmpstr))
3457 SvUTF8_on(sv);
3458 else
3459 SvUTF8_off(sv);
3460 return pv;
3461 }
cb50f42d 3462 origsv = sv;
ed6116ce
LW
3463 sv = (SV*)SvRV(sv);
3464 if (!sv)
e1ec3a88 3465 typestr = "NULLREF";
ed6116ce 3466 else {
f9277f47
IZ
3467 MAGIC *mg;
3468
ed6116ce 3469 switch (SvTYPE(sv)) {
f9277f47
IZ
3470 case SVt_PVMG:
3471 if ( ((SvFLAGS(sv) &
1c846c1f 3472 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
faf82a0b 3473 == (SVs_OBJECT|SVs_SMG))
14befaf4 3474 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
e1ec3a88 3475 const regexp *re = (regexp *)mg->mg_obj;
1bd3ad17 3476
2cd61cdb 3477 if (!mg->mg_ptr) {
e1ec3a88 3478 const char *fptr = "msix";
8782bef2
GB
3479 char reflags[6];
3480 char ch;
3481 int left = 0;
3482 int right = 4;
ff385a1b 3483 char need_newline = 0;
eb160463 3484 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
8782bef2 3485
155aba94 3486 while((ch = *fptr++)) {
8782bef2
GB
3487 if(reganch & 1) {
3488 reflags[left++] = ch;
3489 }
3490 else {
3491 reflags[right--] = ch;
3492 }
3493 reganch >>= 1;
3494 }
3495 if(left != 4) {
3496 reflags[left] = '-';
3497 left = 5;
3498 }
3499
3500 mg->mg_len = re->prelen + 4 + left;
ff385a1b
JF
3501 /*
3502 * If /x was used, we have to worry about a regex
3503 * ending with a comment later being embedded
3504 * within another regex. If so, we don't want this
3505 * regex's "commentization" to leak out to the
3506 * right part of the enclosing regex, we must cap
3507 * it with a newline.
3508 *
3509 * So, if /x was used, we scan backwards from the
3510 * end of the regex. If we find a '#' before we
3511 * find a newline, we need to add a newline
3512 * ourself. If we find a '\n' first (or if we
3513 * don't find '#' or '\n'), we don't need to add
3514 * anything. -jfriedl
3515 */
3516 if (PMf_EXTENDED & re->reganch)
3517 {
e1ec3a88 3518 const char *endptr = re->precomp + re->prelen;
ff385a1b
JF
3519 while (endptr >= re->precomp)
3520 {
e1ec3a88 3521 const char c = *(endptr--);
ff385a1b
JF
3522 if (c == '\n')
3523 break; /* don't need another */
3524 if (c == '#') {
3525 /* we end while in a comment, so we
3526 need a newline */
3527 mg->mg_len++; /* save space for it */
3528 need_newline = 1; /* note to add it */
ab01544f 3529 break;
ff385a1b
JF
3530 }
3531 }
3532 }
3533
8782bef2
GB
3534 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3535 Copy("(?", mg->mg_ptr, 2, char);
3536 Copy(reflags, mg->mg_ptr+2, left, char);
3537 Copy(":", mg->mg_ptr+left+2, 1, char);
3538 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
ff385a1b
JF
3539 if (need_newline)
3540 mg->mg_ptr[mg->mg_len - 2] = '\n';
1bd3ad17
IZ
3541 mg->mg_ptr[mg->mg_len - 1] = ')';
3542 mg->mg_ptr[mg->mg_len] = 0;
3543 }
3280af22 3544 PL_reginterp_cnt += re->program[0].next_off;
cb50f42d
YST
3545
3546 if (re->reganch & ROPT_UTF8)
3547 SvUTF8_on(origsv);
3548 else
3549 SvUTF8_off(origsv);
cdb061a3
NC
3550 if (lp)
3551 *lp = mg->mg_len;
1bd3ad17 3552 return mg->mg_ptr;
f9277f47
IZ
3553 }
3554 /* Fall through */
ed6116ce
LW
3555 case SVt_NULL:
3556 case SVt_IV:
3557 case SVt_NV:
3558 case SVt_RV:
3559 case SVt_PV:
3560 case SVt_PVIV:
3561 case SVt_PVNV:
e1ec3a88
AL
3562 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3563 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
be65207d
DM
3564 /* tied lvalues should appear to be
3565 * scalars for backwards compatitbility */
3566 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3567 ? "SCALAR" : "LVALUE"; break;
e1ec3a88
AL
3568 case SVt_PVAV: typestr = "ARRAY"; break;
3569 case SVt_PVHV: typestr = "HASH"; break;
3570 case SVt_PVCV: typestr = "CODE"; break;
3571 case SVt_PVGV: typestr = "GLOB"; break;
3572 case SVt_PVFM: typestr = "FORMAT"; break;
3573 case SVt_PVIO: typestr = "IO"; break;
3574 default: typestr = "UNKNOWN"; break;
ed6116ce 3575 }
46fc3d4c 3576 tsv = NEWSV(0,0);
a5cb6b62 3577 if (SvOBJECT(sv)) {
bfcb3514 3578 const char *name = HvNAME_get(SvSTASH(sv));
a5cb6b62 3579 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
e1ec3a88 3580 name ? name : "__ANON__" , typestr, PTR2UV(sv));
a5cb6b62 3581 }
ed6116ce 3582 else
e1ec3a88 3583 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
a0d0e21e 3584 goto tokensaveref;
463ee0b2 3585 }
cdb061a3
NC
3586 if (lp)
3587 *lp = strlen(typestr);
73d840c0 3588 return (char *)typestr;
79072805 3589 }
0336b60e 3590 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 3591 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3592 report_uninit(sv);
cdb061a3
NC
3593 if (lp)
3594 *lp = 0;
73d840c0 3595 return (char *)"";
79072805 3596 }
79072805 3597 }
28e5dec8
JH
3598 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3599 /* I'm assuming that if both IV and NV are equally valid then
3600 converting the IV is going to be more efficient */
e1ec3a88
AL
3601 const U32 isIOK = SvIOK(sv);
3602 const U32 isUIOK = SvIsUV(sv);
28e5dec8
JH
3603 char buf[TYPE_CHARS(UV)];
3604 char *ebuf, *ptr;
3605
3606 if (SvTYPE(sv) < SVt_PVIV)
3607 sv_upgrade(sv, SVt_PVIV);
3608 if (isUIOK)
3609 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3610 else
3611 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
5902b6a9
NC
3612 /* inlined from sv_setpvn */
3613 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
4d84ee25 3614 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
28e5dec8
JH
3615 SvCUR_set(sv, ebuf - ptr);
3616 s = SvEND(sv);
3617 *s = '\0';
3618 if (isIOK)
3619 SvIOK_on(sv);
3620 else
3621 SvIOKp_on(sv);
3622 if (isUIOK)
3623 SvIsUV_on(sv);
3624 }
3625 else if (SvNOKp(sv)) {
79072805
LW
3626 if (SvTYPE(sv) < SVt_PVNV)
3627 sv_upgrade(sv, SVt_PVNV);
1c846c1f 3628 /* The +20 is pure guesswork. Configure test needed. --jhi */
5902b6a9 3629 s = SvGROW_mutable(sv, NV_DIG + 20);
79072805 3630 olderrno = errno; /* some Xenix systems wipe out errno here */
79072805 3631#ifdef apollo
463ee0b2 3632 if (SvNVX(sv) == 0.0)
79072805
LW
3633 (void)strcpy(s,"0");
3634 else
3635#endif /*apollo*/
bbce6d69 3636 {
2d4389e4 3637 Gconvert(SvNVX(sv), NV_DIG, 0, s);
bbce6d69 3638 }
79072805 3639 errno = olderrno;
a0d0e21e
LW
3640#ifdef FIXNEGATIVEZERO
3641 if (*s == '-' && s[1] == '0' && !s[2])
3642 strcpy(s,"0");
3643#endif
79072805
LW
3644 while (*s) s++;
3645#ifdef hcx
3646 if (s[-1] == '.')
46fc3d4c 3647 *--s = '\0';
79072805
LW
3648#endif
3649 }
79072805 3650 else {
0336b60e
IZ
3651 if (ckWARN(WARN_UNINITIALIZED)
3652 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3653 report_uninit(sv);
cdb061a3 3654 if (lp)
a0d0e21e 3655 *lp = 0;
25da4f38
IZ
3656 if (SvTYPE(sv) < SVt_PV)
3657 /* Typically the caller expects that sv_any is not NULL now. */
3658 sv_upgrade(sv, SVt_PV);
73d840c0 3659 return (char *)"";
79072805 3660 }
cdb061a3
NC
3661 {
3662 STRLEN len = s - SvPVX_const(sv);
3663 if (lp)
3664 *lp = len;
3665 SvCUR_set(sv, len);
3666 }
79072805 3667 SvPOK_on(sv);
1d7c1841 3668 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3f7c398e 3669 PTR2UV(sv),SvPVX_const(sv)));
4d84ee25
NC
3670 if (flags & SV_CONST_RETURN)
3671 return (char *)SvPVX_const(sv);
10516c54
NC
3672 if (flags & SV_MUTABLE_RETURN)
3673 return SvPVX_mutable(sv);
463ee0b2 3674 return SvPVX(sv);
a0d0e21e
LW
3675
3676 tokensave:
3677 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3678 /* Sneaky stuff here */
3679
3680 tokensaveref:
46fc3d4c 3681 if (!tsv)
96827780 3682 tsv = newSVpv(tmpbuf, 0);
46fc3d4c 3683 sv_2mortal(tsv);
cdb061a3
NC
3684 if (lp)
3685 *lp = SvCUR(tsv);
46fc3d4c 3686 return SvPVX(tsv);
a0d0e21e
LW
3687 }
3688 else {
27da23d5 3689 dVAR;
a0d0e21e 3690 STRLEN len;
73d840c0 3691 const char *t;
46fc3d4c
PP
3692
3693 if (tsv) {
3694 sv_2mortal(tsv);
3f7c398e 3695 t = SvPVX_const(tsv);
46fc3d4c
PP
3696 len = SvCUR(tsv);
3697 }
3698 else {
96827780
MB
3699 t = tmpbuf;
3700 len = strlen(tmpbuf);
46fc3d4c 3701 }
a0d0e21e 3702#ifdef FIXNEGATIVEZERO
46fc3d4c
PP
3703 if (len == 2 && t[0] == '-' && t[1] == '0') {
3704 t = "0";
3705 len = 1;
3706 }
a0d0e21e 3707#endif
862a34c6 3708 SvUPGRADE(sv, SVt_PV);
cdb061a3
NC
3709 if (lp)
3710 *lp = len;
5902b6a9 3711 s = SvGROW_mutable(sv, len + 1);
a0d0e21e 3712 SvCUR_set(sv, len);
6bf554b4 3713 SvPOKp_on(sv);
e90e2364 3714 return strcpy(s, t);
a0d0e21e 3715 }
463ee0b2
LW
3716}
3717
645c22ef 3718/*
6050d10e
JP
3719=for apidoc sv_copypv
3720
3721Copies a stringified representation of the source SV into the
3722destination SV. Automatically performs any necessary mg_get and
54f0641b 3723coercion of numeric values into strings. Guaranteed to preserve
6050d10e 3724UTF-8 flag even from overloaded objects. Similar in nature to
54f0641b
NIS
3725sv_2pv[_flags] but operates directly on an SV instead of just the
3726string. Mostly uses sv_2pv_flags to do its work, except when that
6050d10e
JP
3727would lose the UTF-8'ness of the PV.
3728
3729=cut
3730*/
3731
3732void
3733Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3734{
446eaa42 3735 STRLEN len;
4d84ee25
NC
3736 const char *s;
3737 s = SvPV_const(ssv,len);
cb50f42d 3738 sv_setpvn(dsv,s,len);
446eaa42 3739 if (SvUTF8(ssv))
cb50f42d 3740 SvUTF8_on(dsv);
446eaa42 3741 else
cb50f42d 3742 SvUTF8_off(dsv);
6050d10e
JP
3743}
3744
3745/*
645c22ef
DM
3746=for apidoc sv_2pvbyte_nolen
3747
3748Return a pointer to the byte-encoded representation of the SV.
1e54db1a 3749May cause the SV to be downgraded from UTF-8 as a side-effect.
645c22ef
DM
3750
3751Usually accessed via the C<SvPVbyte_nolen> macro.
3752
3753=cut
3754*/
3755
7340a771
GS
3756char *
3757Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3758{
dafda6d1 3759 return sv_2pvbyte(sv, 0);
7340a771
GS
3760}
3761
645c22ef
DM
3762/*
3763=for apidoc sv_2pvbyte
3764
3765Return a pointer to the byte-encoded representation of the SV, and set *lp
1e54db1a 3766to its length. May cause the SV to be downgraded from UTF-8 as a
645c22ef
DM
3767side-effect.
3768
3769Usually accessed via the C<SvPVbyte> macro.
3770
3771=cut
3772*/
3773
7340a771
GS
3774char *
3775Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3776{
0875d2fe
NIS
3777 sv_utf8_downgrade(sv,0);
3778 return SvPV(sv,*lp);
7340a771
GS
3779}
3780
645c22ef
DM
3781/*
3782=for apidoc sv_2pvutf8_nolen
3783
1e54db1a
JH
3784Return a pointer to the UTF-8-encoded representation of the SV.
3785May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3786
3787Usually accessed via the C<SvPVutf8_nolen> macro.
3788
3789=cut
3790*/
3791
7340a771
GS
3792char *
3793Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3794{
dafda6d1 3795 return sv_2pvutf8(sv, 0);
7340a771
GS
3796}
3797
645c22ef
DM
3798/*
3799=for apidoc sv_2pvutf8
3800
1e54db1a
JH