This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
-Wall is intolerably noisy with icc.
[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
765f542d
NC
50#ifdef PERL_COPY_ON_WRITE
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))
1edc1566 537 Safefree((void *)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 */
766 sv_setpv(name, SvPV_nolen(sv));
767 }
768
769 if (subscript_type == FUV_SUBSCRIPT_HASH) {
770 *SvPVX(name) = '$';
771 sv = NEWSV(0,0);
772 Perl_sv_catpvf(aTHX_ name, "{%s}",
773 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
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();
1031 sv_setpv(sv, "$_");
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,
29489e7c
DM
1120 varname ? SvPV_nolen(varname) : "",
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{
1176 XPVIV* xpviv;
1177 XPVIV* xpvivend;
1178 New(714, xpviv, PERL_ARENA_SIZE/sizeof(XPVIV), XPVIV);
7b2c381c 1179 *((XPVIV**)xpviv) = PL_xpviv_arenaroot;
cac9b346
NC
1180 PL_xpviv_arenaroot = xpviv;
1181
1182 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(XPVIV) - 1];
1183 PL_xpviv_root = ++xpviv;
1184 while (xpviv < xpvivend) {
7b2c381c 1185 *((XPVIV**)xpviv) = xpviv + 1;
cac9b346
NC
1186 xpviv++;
1187 }
7b2c381c 1188 *((XPVIV**)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{
1420 XPVIV* xpviv;
1421 LOCK_SV_MUTEX;
1422 if (!PL_xpviv_root)
cac9b346 1423 S_more_xpviv(aTHX);
932e9ff9 1424 xpviv = PL_xpviv_root;
7b2c381c 1425 PL_xpviv_root = *(XPVIV**)xpviv;
932e9ff9
VB
1426 UNLOCK_SV_MUTEX;
1427 return xpviv;
1428}
1429
645c22ef
DM
1430/* return a struct xpviv to the free list */
1431
932e9ff9
VB
1432STATIC void
1433S_del_xpviv(pTHX_ XPVIV *p)
1434{
1435 LOCK_SV_MUTEX;
7b2c381c 1436 *(XPVIV**)p = PL_xpviv_root;
932e9ff9
VB
1437 PL_xpviv_root = p;
1438 UNLOCK_SV_MUTEX;
1439}
1440
645c22ef
DM
1441/* grab a new struct xpvnv from the free list, allocating more if necessary */
1442
932e9ff9
VB
1443STATIC XPVNV*
1444S_new_xpvnv(pTHX)
1445{
1446 XPVNV* xpvnv;
1447 LOCK_SV_MUTEX;
1448 if (!PL_xpvnv_root)
cac9b346 1449 S_more_xpvnv(aTHX);
932e9ff9 1450 xpvnv = PL_xpvnv_root;
7b2c381c 1451 PL_xpvnv_root = *(XPVNV**)xpvnv;
932e9ff9
VB
1452 UNLOCK_SV_MUTEX;
1453 return xpvnv;
1454}
1455
645c22ef
DM
1456/* return a struct xpvnv to the free list */
1457
932e9ff9
VB
1458STATIC void
1459S_del_xpvnv(pTHX_ XPVNV *p)
1460{
1461 LOCK_SV_MUTEX;
7b2c381c 1462 *(XPVNV**)p = PL_xpvnv_root;
932e9ff9
VB
1463 PL_xpvnv_root = p;
1464 UNLOCK_SV_MUTEX;
1465}
1466
645c22ef
DM
1467/* grab a new struct xpvcv from the free list, allocating more if necessary */
1468
932e9ff9
VB
1469STATIC XPVCV*
1470S_new_xpvcv(pTHX)
1471{
1472 XPVCV* xpvcv;
1473 LOCK_SV_MUTEX;
1474 if (!PL_xpvcv_root)
cac9b346 1475 S_more_xpvcv(aTHX);
932e9ff9 1476 xpvcv = PL_xpvcv_root;
7b2c381c 1477 PL_xpvcv_root = *(XPVCV**)xpvcv;
932e9ff9
VB
1478 UNLOCK_SV_MUTEX;
1479 return xpvcv;
1480}
1481
645c22ef
DM
1482/* return a struct xpvcv to the free list */
1483
932e9ff9
VB
1484STATIC void
1485S_del_xpvcv(pTHX_ XPVCV *p)
1486{
1487 LOCK_SV_MUTEX;
7b2c381c 1488 *(XPVCV**)p = PL_xpvcv_root;
932e9ff9
VB
1489 PL_xpvcv_root = p;
1490 UNLOCK_SV_MUTEX;
1491}
1492
645c22ef
DM
1493/* grab a new struct xpvav from the free list, allocating more if necessary */
1494
932e9ff9
VB
1495STATIC XPVAV*
1496S_new_xpvav(pTHX)
1497{
59813432 1498 xpvav_allocated* xpvav;
932e9ff9
VB
1499 LOCK_SV_MUTEX;
1500 if (!PL_xpvav_root)
cac9b346 1501 S_more_xpvav(aTHX);
932e9ff9 1502 xpvav = PL_xpvav_root;
59813432 1503 PL_xpvav_root = *(xpvav_allocated**)xpvav;
932e9ff9 1504 UNLOCK_SV_MUTEX;
59813432
NC
1505 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1506 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
932e9ff9
VB
1507}
1508
645c22ef
DM
1509/* return a struct xpvav to the free list */
1510
932e9ff9
VB
1511STATIC void
1512S_del_xpvav(pTHX_ XPVAV *p)
1513{
59813432
NC
1514 xpvav_allocated* xpvav
1515 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1516 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
932e9ff9 1517 LOCK_SV_MUTEX;
59813432
NC
1518 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1519 PL_xpvav_root = xpvav;
932e9ff9
VB
1520 UNLOCK_SV_MUTEX;
1521}
1522
645c22ef
DM
1523/* grab a new struct xpvhv from the free list, allocating more if necessary */
1524
932e9ff9
VB
1525STATIC XPVHV*
1526S_new_xpvhv(pTHX)
1527{
59813432 1528 xpvhv_allocated* xpvhv;
932e9ff9
VB
1529 LOCK_SV_MUTEX;
1530 if (!PL_xpvhv_root)
cac9b346 1531 S_more_xpvhv(aTHX);
932e9ff9 1532 xpvhv = PL_xpvhv_root;
59813432 1533 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
932e9ff9 1534 UNLOCK_SV_MUTEX;
59813432
NC
1535 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1536 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
932e9ff9
VB
1537}
1538
645c22ef
DM
1539/* return a struct xpvhv to the free list */
1540
932e9ff9
VB
1541STATIC void
1542S_del_xpvhv(pTHX_ XPVHV *p)
1543{
59813432
NC
1544 xpvhv_allocated* xpvhv
1545 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1546 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
932e9ff9 1547 LOCK_SV_MUTEX;
59813432
NC
1548 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1549 PL_xpvhv_root = xpvhv;
932e9ff9
VB
1550 UNLOCK_SV_MUTEX;
1551}
1552
645c22ef
DM
1553/* grab a new struct xpvmg from the free list, allocating more if necessary */
1554
932e9ff9
VB
1555STATIC XPVMG*
1556S_new_xpvmg(pTHX)
1557{
1558 XPVMG* xpvmg;
1559 LOCK_SV_MUTEX;
1560 if (!PL_xpvmg_root)
cac9b346 1561 S_more_xpvmg(aTHX);
932e9ff9 1562 xpvmg = PL_xpvmg_root;
7b2c381c 1563 PL_xpvmg_root = *(XPVMG**)xpvmg;
932e9ff9
VB
1564 UNLOCK_SV_MUTEX;
1565 return xpvmg;
1566}
1567
645c22ef
DM
1568/* return a struct xpvmg to the free list */
1569
932e9ff9
VB
1570STATIC void
1571S_del_xpvmg(pTHX_ XPVMG *p)
1572{
1573 LOCK_SV_MUTEX;
7b2c381c 1574 *(XPVMG**)p = PL_xpvmg_root;
932e9ff9
VB
1575 PL_xpvmg_root = p;
1576 UNLOCK_SV_MUTEX;
1577}
1578
727879eb
NC
1579/* grab a new struct xpvgv from the free list, allocating more if necessary */
1580
1581STATIC XPVGV*
1582S_new_xpvgv(pTHX)
1583{
1584 XPVGV* xpvgv;
1585 LOCK_SV_MUTEX;
1586 if (!PL_xpvgv_root)
cac9b346 1587 S_more_xpvgv(aTHX);
727879eb 1588 xpvgv = PL_xpvgv_root;
7b2c381c 1589 PL_xpvgv_root = *(XPVGV**)xpvgv;
727879eb
NC
1590 UNLOCK_SV_MUTEX;
1591 return xpvgv;
1592}
1593
1594/* return a struct xpvgv to the free list */
1595
1596STATIC void
1597S_del_xpvgv(pTHX_ XPVGV *p)
1598{
1599 LOCK_SV_MUTEX;
7b2c381c 1600 *(XPVGV**)p = PL_xpvgv_root;
727879eb
NC
1601 PL_xpvgv_root = p;
1602 UNLOCK_SV_MUTEX;
1603}
1604
645c22ef
DM
1605/* grab a new struct xpvlv from the free list, allocating more if necessary */
1606
932e9ff9
VB
1607STATIC XPVLV*
1608S_new_xpvlv(pTHX)
1609{
1610 XPVLV* xpvlv;
1611 LOCK_SV_MUTEX;
1612 if (!PL_xpvlv_root)
cac9b346 1613 S_more_xpvlv(aTHX);
932e9ff9 1614 xpvlv = PL_xpvlv_root;
7b2c381c 1615 PL_xpvlv_root = *(XPVLV**)xpvlv;
932e9ff9
VB
1616 UNLOCK_SV_MUTEX;
1617 return xpvlv;
1618}
1619
645c22ef
DM
1620/* return a struct xpvlv to the free list */
1621
932e9ff9
VB
1622STATIC void
1623S_del_xpvlv(pTHX_ XPVLV *p)
1624{
1625 LOCK_SV_MUTEX;
7b2c381c 1626 *(XPVLV**)p = PL_xpvlv_root;
932e9ff9
VB
1627 PL_xpvlv_root = p;
1628 UNLOCK_SV_MUTEX;
1629}
1630
645c22ef
DM
1631/* grab a new struct xpvbm from the free list, allocating more if necessary */
1632
932e9ff9
VB
1633STATIC XPVBM*
1634S_new_xpvbm(pTHX)
1635{
1636 XPVBM* xpvbm;
1637 LOCK_SV_MUTEX;
1638 if (!PL_xpvbm_root)
cac9b346 1639 S_more_xpvbm(aTHX);
932e9ff9 1640 xpvbm = PL_xpvbm_root;
7b2c381c 1641 PL_xpvbm_root = *(XPVBM**)xpvbm;
932e9ff9
VB
1642 UNLOCK_SV_MUTEX;
1643 return xpvbm;
1644}
1645
645c22ef
DM
1646/* return a struct xpvbm to the free list */
1647
932e9ff9
VB
1648STATIC void
1649S_del_xpvbm(pTHX_ XPVBM *p)
1650{
1651 LOCK_SV_MUTEX;
7b2c381c 1652 *(XPVBM**)p = PL_xpvbm_root;
932e9ff9
VB
1653 PL_xpvbm_root = p;
1654 UNLOCK_SV_MUTEX;
1655}
1656
7bab3ede
MB
1657#define my_safemalloc(s) (void*)safemalloc(s)
1658#define my_safefree(p) safefree((char*)p)
463ee0b2 1659
d33b2eba 1660#ifdef PURIFY
463ee0b2 1661
d33b2eba
GS
1662#define new_XNV() my_safemalloc(sizeof(XPVNV))
1663#define del_XNV(p) my_safefree(p)
463ee0b2 1664
d33b2eba
GS
1665#define new_XPV() my_safemalloc(sizeof(XPV))
1666#define del_XPV(p) my_safefree(p)
9b94d1dd 1667
d33b2eba
GS
1668#define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1669#define del_XPVIV(p) my_safefree(p)
932e9ff9 1670
d33b2eba
GS
1671#define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1672#define del_XPVNV(p) my_safefree(p)
932e9ff9 1673
d33b2eba
GS
1674#define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1675#define del_XPVCV(p) my_safefree(p)
932e9ff9 1676
d33b2eba
GS
1677#define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1678#define del_XPVAV(p) my_safefree(p)
1679
1680#define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1681#define del_XPVHV(p) my_safefree(p)
1c846c1f 1682
d33b2eba
GS
1683#define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1684#define del_XPVMG(p) my_safefree(p)
1685
727879eb
NC
1686#define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1687#define del_XPVGV(p) my_safefree(p)
1688
d33b2eba
GS
1689#define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1690#define del_XPVLV(p) my_safefree(p)
1691
1692#define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1693#define del_XPVBM(p) my_safefree(p)
1694
1695#else /* !PURIFY */
1696
d33b2eba
GS
1697#define new_XNV() (void*)new_xnv()
1698#define del_XNV(p) del_xnv((XPVNV*) p)
9b94d1dd 1699
d33b2eba
GS
1700#define new_XPV() (void*)new_xpv()
1701#define del_XPV(p) del_xpv((XPV *)p)
1702
1703#define new_XPVIV() (void*)new_xpviv()
1704#define del_XPVIV(p) del_xpviv((XPVIV *)p)
1705
1706#define new_XPVNV() (void*)new_xpvnv()
1707#define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1708
1709#define new_XPVCV() (void*)new_xpvcv()
1710#define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1711
1712#define new_XPVAV() (void*)new_xpvav()
1713#define del_XPVAV(p) del_xpvav((XPVAV *)p)
1714
1715#define new_XPVHV() (void*)new_xpvhv()
1716#define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1c846c1f 1717
d33b2eba
GS
1718#define new_XPVMG() (void*)new_xpvmg()
1719#define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1720
727879eb
NC
1721#define new_XPVGV() (void*)new_xpvgv()
1722#define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1723
d33b2eba
GS
1724#define new_XPVLV() (void*)new_xpvlv()
1725#define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1726
1727#define new_XPVBM() (void*)new_xpvbm()
1728#define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1729
1730#endif /* PURIFY */
9b94d1dd 1731
d33b2eba
GS
1732#define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1733#define del_XPVFM(p) my_safefree(p)
1c846c1f 1734
d33b2eba
GS
1735#define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1736#define del_XPVIO(p) my_safefree(p)
8990e307 1737
954c1994
GS
1738/*
1739=for apidoc sv_upgrade
1740
ff276b08 1741Upgrade an SV to a more complex form. Generally adds a new body type to the
645c22ef 1742SV, then copies across as much information as possible from the old body.
ff276b08 1743You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
954c1994
GS
1744
1745=cut
1746*/
1747
79072805 1748bool
864dbfa3 1749Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
79072805 1750{
e763e3dc 1751
d2e56290
NC
1752 char* pv;
1753 U32 cur;
1754 U32 len;
1755 IV iv;
1756 NV nv;
1757 MAGIC* magic;
1758 HV* stash;
79072805 1759
765f542d
NC
1760 if (mt != SVt_PV && SvIsCOW(sv)) {
1761 sv_force_normal_flags(sv, 0);
f130fd45
NIS
1762 }
1763
79072805
LW
1764 if (SvTYPE(sv) == mt)
1765 return TRUE;
1766
d2e56290
NC
1767 pv = NULL;
1768 cur = 0;
1769 len = 0;
1770 iv = 0;
1771 nv = 0.0;
1772 magic = NULL;
1773 stash = Nullhv;
1774
79072805
LW
1775 switch (SvTYPE(sv)) {
1776 case SVt_NULL:
79072805 1777 break;
79072805 1778 case SVt_IV:
463ee0b2 1779 iv = SvIVX(sv);
ed6116ce 1780 if (mt == SVt_NV)
463ee0b2 1781 mt = SVt_PVNV;
ed6116ce
LW
1782 else if (mt < SVt_PVIV)
1783 mt = SVt_PVIV;
79072805
LW
1784 break;
1785 case SVt_NV:
463ee0b2 1786 nv = SvNVX(sv);
79072805 1787 del_XNV(SvANY(sv));
ed6116ce 1788 if (mt < SVt_PVNV)
79072805
LW
1789 mt = SVt_PVNV;
1790 break;
ed6116ce
LW
1791 case SVt_RV:
1792 pv = (char*)SvRV(sv);
ed6116ce 1793 break;
79072805 1794 case SVt_PV:
463ee0b2 1795 pv = SvPVX(sv);
79072805
LW
1796 cur = SvCUR(sv);
1797 len = SvLEN(sv);
79072805 1798 del_XPV(SvANY(sv));
748a9306
LW
1799 if (mt <= SVt_IV)
1800 mt = SVt_PVIV;
1801 else if (mt == SVt_NV)
1802 mt = SVt_PVNV;
79072805
LW
1803 break;
1804 case SVt_PVIV:
463ee0b2 1805 pv = SvPVX(sv);
79072805
LW
1806 cur = SvCUR(sv);
1807 len = SvLEN(sv);
463ee0b2 1808 iv = SvIVX(sv);
79072805
LW
1809 del_XPVIV(SvANY(sv));
1810 break;
1811 case SVt_PVNV:
463ee0b2 1812 pv = SvPVX(sv);
79072805
LW
1813 cur = SvCUR(sv);
1814 len = SvLEN(sv);
463ee0b2
LW
1815 iv = SvIVX(sv);
1816 nv = SvNVX(sv);
79072805
LW
1817 del_XPVNV(SvANY(sv));
1818 break;
1819 case SVt_PVMG:
0ec50a73
NC
1820 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1821 there's no way that it can be safely upgraded, because perl.c
1822 expects to Safefree(SvANY(PL_mess_sv)) */
1823 assert(sv != PL_mess_sv);
bce8f412
NC
1824 /* This flag bit is used to mean other things in other scalar types.
1825 Given that it only has meaning inside the pad, it shouldn't be set
1826 on anything that can get upgraded. */
1827 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
463ee0b2 1828 pv = SvPVX(sv);
79072805
LW
1829 cur = SvCUR(sv);
1830 len = SvLEN(sv);
463ee0b2
LW
1831 iv = SvIVX(sv);
1832 nv = SvNVX(sv);
79072805
LW
1833 magic = SvMAGIC(sv);
1834 stash = SvSTASH(sv);
1835 del_XPVMG(SvANY(sv));
1836 break;
1837 default:
cea2e8a9 1838 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
79072805
LW
1839 }
1840
ffb05e06
NC
1841 SvFLAGS(sv) &= ~SVTYPEMASK;
1842 SvFLAGS(sv) |= mt;
1843
79072805
LW
1844 switch (mt) {
1845 case SVt_NULL:
cea2e8a9 1846 Perl_croak(aTHX_ "Can't upgrade to undef");
79072805 1847 case SVt_IV:
7b2c381c 1848 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.sv_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
45977657 1849 SvIV_set(sv, iv);
79072805
LW
1850 break;
1851 case SVt_NV:
1852 SvANY(sv) = new_XNV();
9d6ce603 1853 SvNV_set(sv, nv);
79072805 1854 break;
ed6116ce 1855 case SVt_RV:
7b2c381c 1856 SvANY(sv) = &sv->sv_u.sv_rv;
b162af07 1857 SvRV_set(sv, (SV*)pv);
ed6116ce 1858 break;
79072805
LW
1859 case SVt_PVHV:
1860 SvANY(sv) = new_XPVHV();
bfcb3514 1861 ((XPVHV*) SvANY(sv))->xhv_aux = 0;
463ee0b2
LW
1862 HvFILL(sv) = 0;
1863 HvMAX(sv) = 0;
8aacddc1 1864 HvTOTALKEYS(sv) = 0;
bd4b1eb5
NC
1865
1866 /* Fall through... */
1867 if (0) {
1868 case SVt_PVAV:
1869 SvANY(sv) = new_XPVAV();
1870 AvMAX(sv) = -1;
1871 AvFILLp(sv) = -1;
1872 AvALLOC(sv) = 0;
1873 AvARYLEN(sv)= 0;
11ca45c0 1874 AvREAL_only(sv);
bd4b1eb5
NC
1875 }
1876 /* to here. */
c2bfdfaf
NC
1877 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1878 assert(!pv);
8bd4d4c5
NC
1879 /* FIXME. Should be able to remove all this if()... if the above
1880 assertion is genuinely always true. */
1881 if(SvOOK(sv)) {
1882 pv -= iv;
1883 SvFLAGS(sv) &= ~SVf_OOK;
1884 }
1885 Safefree(pv);
bd4b1eb5 1886 SvPV_set(sv, (char*)0);
b162af07
SP
1887 SvMAGIC_set(sv, magic);
1888 SvSTASH_set(sv, stash);
79072805 1889 break;
bd4b1eb5
NC
1890
1891 case SVt_PVIO:
1892 SvANY(sv) = new_XPVIO();
1893 Zero(SvANY(sv), 1, XPVIO);
1894 IoPAGE_LEN(sv) = 60;
1895 goto set_magic_common;
1896 case SVt_PVFM:
1897 SvANY(sv) = new_XPVFM();
1898 Zero(SvANY(sv), 1, XPVFM);
1899 goto set_magic_common;
1900 case SVt_PVBM:
1901 SvANY(sv) = new_XPVBM();
1902 BmRARE(sv) = 0;
1903 BmUSEFUL(sv) = 0;
1904 BmPREVIOUS(sv) = 0;
1905 goto set_magic_common;
1906 case SVt_PVGV:
1907 SvANY(sv) = new_XPVGV();
1908 GvGP(sv) = 0;
1909 GvNAME(sv) = 0;
1910 GvNAMELEN(sv) = 0;
1911 GvSTASH(sv) = 0;
1912 GvFLAGS(sv) = 0;
1913 goto set_magic_common;
79072805
LW
1914 case SVt_PVCV:
1915 SvANY(sv) = new_XPVCV();
748a9306 1916 Zero(SvANY(sv), 1, XPVCV);
bd4b1eb5
NC
1917 goto set_magic_common;
1918 case SVt_PVLV:
1919 SvANY(sv) = new_XPVLV();
1920 LvTARGOFF(sv) = 0;
1921 LvTARGLEN(sv) = 0;
1922 LvTARG(sv) = 0;
1923 LvTYPE(sv) = 0;
93a17b20 1924 GvGP(sv) = 0;
79072805
LW
1925 GvNAME(sv) = 0;
1926 GvNAMELEN(sv) = 0;
1927 GvSTASH(sv) = 0;
a5f75d66 1928 GvFLAGS(sv) = 0;
bd4b1eb5
NC
1929 /* Fall through. */
1930 if (0) {
1931 case SVt_PVMG:
1932 SvANY(sv) = new_XPVMG();
1933 }
1934 set_magic_common:
b162af07
SP
1935 SvMAGIC_set(sv, magic);
1936 SvSTASH_set(sv, stash);
bd4b1eb5
NC
1937 /* Fall through. */
1938 if (0) {
1939 case SVt_PVNV:
1940 SvANY(sv) = new_XPVNV();
1941 }
9d6ce603 1942 SvNV_set(sv, nv);
bd4b1eb5
NC
1943 /* Fall through. */
1944 if (0) {
1945 case SVt_PVIV:
1946 SvANY(sv) = new_XPVIV();
1947 if (SvNIOK(sv))
1948 (void)SvIOK_on(sv);
1949 SvNOK_off(sv);
1950 }
1951 SvIV_set(sv, iv);
1952 /* Fall through. */
1953 if (0) {
1954 case SVt_PV:
1955 SvANY(sv) = new_XPV();
1956 }
f880fe2f 1957 SvPV_set(sv, pv);
b162af07
SP
1958 SvCUR_set(sv, cur);
1959 SvLEN_set(sv, len);
8990e307
LW
1960 break;
1961 }
79072805
LW
1962 return TRUE;
1963}
1964
645c22ef
DM
1965/*
1966=for apidoc sv_backoff
1967
1968Remove any string offset. You should normally use the C<SvOOK_off> macro
1969wrapper instead.
1970
1971=cut
1972*/
1973
79072805 1974int
864dbfa3 1975Perl_sv_backoff(pTHX_ register SV *sv)
79072805
LW
1976{
1977 assert(SvOOK(sv));
463ee0b2
LW
1978 if (SvIVX(sv)) {
1979 char *s = SvPVX(sv);
b162af07 1980 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
f880fe2f 1981 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
79072805 1982 SvIV_set(sv, 0);
463ee0b2 1983 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
79072805
LW
1984 }
1985 SvFLAGS(sv) &= ~SVf_OOK;
a0d0e21e 1986 return 0;
79072805
LW
1987}
1988
954c1994
GS
1989/*
1990=for apidoc sv_grow
1991
645c22ef
DM
1992Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1993upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1994Use the C<SvGROW> wrapper instead.
954c1994
GS
1995
1996=cut
1997*/
1998
79072805 1999char *
864dbfa3 2000Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
79072805
LW
2001{
2002 register char *s;
2003
55497cff 2004#ifdef HAS_64K_LIMIT
79072805 2005 if (newlen >= 0x10000) {
1d7c1841
GS
2006 PerlIO_printf(Perl_debug_log,
2007 "Allocation too large: %"UVxf"\n", (UV)newlen);
79072805
LW
2008 my_exit(1);
2009 }
55497cff 2010#endif /* HAS_64K_LIMIT */
a0d0e21e
LW
2011 if (SvROK(sv))
2012 sv_unref(sv);
79072805
LW
2013 if (SvTYPE(sv) < SVt_PV) {
2014 sv_upgrade(sv, SVt_PV);
463ee0b2 2015 s = SvPVX(sv);
79072805
LW
2016 }
2017 else if (SvOOK(sv)) { /* pv is offset? */
2018 sv_backoff(sv);
463ee0b2 2019 s = SvPVX(sv);
79072805
LW
2020 if (newlen > SvLEN(sv))
2021 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
c6f8c383
GA
2022#ifdef HAS_64K_LIMIT
2023 if (newlen >= 0x10000)
2024 newlen = 0xFFFF;
2025#endif
79072805 2026 }
bc44a8a2 2027 else
463ee0b2 2028 s = SvPVX(sv);
54f0641b 2029
79072805 2030 if (newlen > SvLEN(sv)) { /* need more room? */
8d6dde3e 2031 if (SvLEN(sv) && s) {
7bab3ede 2032#ifdef MYMALLOC
a3b680e6 2033 const STRLEN l = malloced_size((void*)SvPVX(sv));
8d6dde3e
IZ
2034 if (newlen <= l) {
2035 SvLEN_set(sv, l);
2036 return s;
2037 } else
c70c8a0a 2038#endif
79072805 2039 Renew(s,newlen,char);
8d6dde3e 2040 }
bfed75c6 2041 else {
4e83176d 2042 New(703, s, newlen, char);
40565179 2043 if (SvPVX(sv) && SvCUR(sv)) {
54f0641b 2044 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
40565179 2045 }
4e83176d 2046 }
79072805 2047 SvPV_set(sv, s);
e1ec3a88 2048 SvLEN_set(sv, newlen);
79072805
LW
2049 }
2050 return s;
2051}
2052
954c1994
GS
2053/*
2054=for apidoc sv_setiv
2055
645c22ef
DM
2056Copies an integer into the given SV, upgrading first if necessary.
2057Does not handle 'set' magic. See also C<sv_setiv_mg>.
954c1994
GS
2058
2059=cut
2060*/
2061
79072805 2062void
864dbfa3 2063Perl_sv_setiv(pTHX_ register SV *sv, IV i)
79072805 2064{
765f542d 2065 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2
LW
2066 switch (SvTYPE(sv)) {
2067 case SVt_NULL:
79072805 2068 sv_upgrade(sv, SVt_IV);
463ee0b2
LW
2069 break;
2070 case SVt_NV:
2071 sv_upgrade(sv, SVt_PVNV);
2072 break;
ed6116ce 2073 case SVt_RV:
463ee0b2 2074 case SVt_PV:
79072805 2075 sv_upgrade(sv, SVt_PVIV);
463ee0b2 2076 break;
a0d0e21e
LW
2077
2078 case SVt_PVGV:
a0d0e21e
LW
2079 case SVt_PVAV:
2080 case SVt_PVHV:
2081 case SVt_PVCV:
2082 case SVt_PVFM:
2083 case SVt_PVIO:
411caa50 2084 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
53e06cf0 2085 OP_DESC(PL_op));
463ee0b2 2086 }
a0d0e21e 2087 (void)SvIOK_only(sv); /* validate number */
45977657 2088 SvIV_set(sv, i);
463ee0b2 2089 SvTAINT(sv);
79072805
LW
2090}
2091
954c1994
GS
2092/*
2093=for apidoc sv_setiv_mg
2094
2095Like C<sv_setiv>, but also handles 'set' magic.
2096
2097=cut
2098*/
2099
79072805 2100void
864dbfa3 2101Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
ef50df4b
GS
2102{
2103 sv_setiv(sv,i);
2104 SvSETMAGIC(sv);
2105}
2106
954c1994
GS
2107/*
2108=for apidoc sv_setuv
2109
645c22ef
DM
2110Copies an unsigned integer into the given SV, upgrading first if necessary.
2111Does not handle 'set' magic. See also C<sv_setuv_mg>.
954c1994
GS
2112
2113=cut
2114*/
2115
ef50df4b 2116void
864dbfa3 2117Perl_sv_setuv(pTHX_ register SV *sv, UV u)
55497cff 2118{
55ada374
NC
2119 /* With these two if statements:
2120 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2121
55ada374
NC
2122 without
2123 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2124
55ada374
NC
2125 If you wish to remove them, please benchmark to see what the effect is
2126 */
28e5dec8
JH
2127 if (u <= (UV)IV_MAX) {
2128 sv_setiv(sv, (IV)u);
2129 return;
2130 }
25da4f38
IZ
2131 sv_setiv(sv, 0);
2132 SvIsUV_on(sv);
607fa7f2 2133 SvUV_set(sv, u);
55497cff
PP
2134}
2135
954c1994
GS
2136/*
2137=for apidoc sv_setuv_mg
2138
2139Like C<sv_setuv>, but also handles 'set' magic.
2140
2141=cut
2142*/
2143
55497cff 2144void
864dbfa3 2145Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
ef50df4b 2146{
55ada374
NC
2147 /* With these two if statements:
2148 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2149
55ada374
NC
2150 without
2151 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2152
55ada374
NC
2153 If you wish to remove them, please benchmark to see what the effect is
2154 */
28e5dec8
JH
2155 if (u <= (UV)IV_MAX) {
2156 sv_setiv(sv, (IV)u);
2157 } else {
2158 sv_setiv(sv, 0);
2159 SvIsUV_on(sv);
2160 sv_setuv(sv,u);
2161 }
ef50df4b
GS
2162 SvSETMAGIC(sv);
2163}
2164
954c1994
GS
2165/*
2166=for apidoc sv_setnv
2167
645c22ef
DM
2168Copies a double into the given SV, upgrading first if necessary.
2169Does not handle 'set' magic. See also C<sv_setnv_mg>.
954c1994
GS
2170
2171=cut
2172*/
2173
ef50df4b 2174void
65202027 2175Perl_sv_setnv(pTHX_ register SV *sv, NV num)
79072805 2176{
765f542d 2177 SV_CHECK_THINKFIRST_COW_DROP(sv);
a0d0e21e
LW
2178 switch (SvTYPE(sv)) {
2179 case SVt_NULL:
2180 case SVt_IV:
79072805 2181 sv_upgrade(sv, SVt_NV);
a0d0e21e 2182 break;
a0d0e21e
LW
2183 case SVt_RV:
2184 case SVt_PV:
2185 case SVt_PVIV:
79072805 2186 sv_upgrade(sv, SVt_PVNV);
a0d0e21e 2187 break;
827b7e14 2188
a0d0e21e 2189 case SVt_PVGV:
a0d0e21e
LW
2190 case SVt_PVAV:
2191 case SVt_PVHV:
2192 case SVt_PVCV:
2193 case SVt_PVFM:
2194 case SVt_PVIO:
411caa50 2195 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
53e06cf0 2196 OP_NAME(PL_op));
79072805 2197 }
9d6ce603 2198 SvNV_set(sv, num);
a0d0e21e 2199 (void)SvNOK_only(sv); /* validate number */
463ee0b2 2200 SvTAINT(sv);
79072805
LW
2201}
2202
954c1994
GS
2203/*
2204=for apidoc sv_setnv_mg
2205
2206Like C<sv_setnv>, but also handles 'set' magic.
2207
2208=cut
2209*/
2210
ef50df4b 2211void
65202027 2212Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
ef50df4b
GS
2213{
2214 sv_setnv(sv,num);
2215 SvSETMAGIC(sv);
2216}
2217
645c22ef
DM
2218/* Print an "isn't numeric" warning, using a cleaned-up,
2219 * printable version of the offending string
2220 */
2221
76e3520e 2222STATIC void
cea2e8a9 2223S_not_a_number(pTHX_ SV *sv)
a0d0e21e 2224{
94463019
JH
2225 SV *dsv;
2226 char tmpbuf[64];
2227 char *pv;
2228
2229 if (DO_UTF8(sv)) {
2230 dsv = sv_2mortal(newSVpv("", 0));
2231 pv = sv_uni_display(dsv, sv, 10, 0);
2232 } else {
2233 char *d = tmpbuf;
2234 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2235 /* each *s can expand to 4 chars + "...\0",
2236 i.e. need room for 8 chars */
ecdeb87c 2237
94463019
JH
2238 char *s, *end;
2239 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2240 int ch = *s & 0xFF;
2241 if (ch & 128 && !isPRINT_LC(ch)) {
2242 *d++ = 'M';
2243 *d++ = '-';
2244 ch &= 127;
2245 }
2246 if (ch == '\n') {
2247 *d++ = '\\';
2248 *d++ = 'n';
2249 }
2250 else if (ch == '\r') {
2251 *d++ = '\\';
2252 *d++ = 'r';
2253 }
2254 else if (ch == '\f') {
2255 *d++ = '\\';
2256 *d++ = 'f';
2257 }
2258 else if (ch == '\\') {
2259 *d++ = '\\';
2260 *d++ = '\\';
2261 }
2262 else if (ch == '\0') {
2263 *d++ = '\\';
2264 *d++ = '0';
2265 }
2266 else if (isPRINT_LC(ch))
2267 *d++ = ch;
2268 else {
2269 *d++ = '^';
2270 *d++ = toCTRL(ch);
2271 }
2272 }
2273 if (s < end) {
2274 *d++ = '.';
2275 *d++ = '.';
2276 *d++ = '.';
2277 }
2278 *d = '\0';
2279 pv = tmpbuf;
a0d0e21e 2280 }
a0d0e21e 2281
533c011a 2282 if (PL_op)
9014280d 2283 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019
JH
2284 "Argument \"%s\" isn't numeric in %s", pv,
2285 OP_DESC(PL_op));
a0d0e21e 2286 else
9014280d 2287 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019 2288 "Argument \"%s\" isn't numeric", pv);
a0d0e21e
LW
2289}
2290
c2988b20
NC
2291/*
2292=for apidoc looks_like_number
2293
645c22ef
DM
2294Test if the content of an SV looks like a number (or is a number).
2295C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2296non-numeric warning), even if your atof() doesn't grok them.
c2988b20
NC
2297
2298=cut
2299*/
2300
2301I32
2302Perl_looks_like_number(pTHX_ SV *sv)
2303{
a3b680e6 2304 register const char *sbegin;
c2988b20
NC
2305 STRLEN len;
2306
2307 if (SvPOK(sv)) {
2308 sbegin = SvPVX(sv);
2309 len = SvCUR(sv);
2310 }
2311 else if (SvPOKp(sv))
2312 sbegin = SvPV(sv, len);
2313 else
e0ab1c0e 2314 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
c2988b20
NC
2315 return grok_number(sbegin, len, NULL);
2316}
25da4f38
IZ
2317
2318/* Actually, ISO C leaves conversion of UV to IV undefined, but
2319 until proven guilty, assume that things are not that bad... */
2320
645c22ef
DM
2321/*
2322 NV_PRESERVES_UV:
2323
2324 As 64 bit platforms often have an NV that doesn't preserve all bits of
28e5dec8
JH
2325 an IV (an assumption perl has been based on to date) it becomes necessary
2326 to remove the assumption that the NV always carries enough precision to
2327 recreate the IV whenever needed, and that the NV is the canonical form.
2328 Instead, IV/UV and NV need to be given equal rights. So as to not lose
645c22ef 2329 precision as a side effect of conversion (which would lead to insanity
28e5dec8
JH
2330 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2331 1) to distinguish between IV/UV/NV slots that have cached a valid
2332 conversion where precision was lost and IV/UV/NV slots that have a
2333 valid conversion which has lost no precision
645c22ef 2334 2) to ensure that if a numeric conversion to one form is requested that
28e5dec8
JH
2335 would lose precision, the precise conversion (or differently
2336 imprecise conversion) is also performed and cached, to prevent
2337 requests for different numeric formats on the same SV causing
2338 lossy conversion chains. (lossless conversion chains are perfectly
2339 acceptable (still))
2340
2341
2342 flags are used:
2343 SvIOKp is true if the IV slot contains a valid value
2344 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2345 SvNOKp is true if the NV slot contains a valid value
2346 SvNOK is true only if the NV value is accurate
2347
2348 so
645c22ef 2349 while converting from PV to NV, check to see if converting that NV to an
28e5dec8
JH
2350 IV(or UV) would lose accuracy over a direct conversion from PV to
2351 IV(or UV). If it would, cache both conversions, return NV, but mark
2352 SV as IOK NOKp (ie not NOK).
2353
645c22ef 2354 While converting from PV to IV, check to see if converting that IV to an
28e5dec8
JH
2355 NV would lose accuracy over a direct conversion from PV to NV. If it
2356 would, cache both conversions, flag similarly.
2357
2358 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2359 correctly because if IV & NV were set NV *always* overruled.
645c22ef
DM
2360 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2361 changes - now IV and NV together means that the two are interchangeable:
28e5dec8 2362 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
d460ef45 2363
645c22ef
DM
2364 The benefit of this is that operations such as pp_add know that if
2365 SvIOK is true for both left and right operands, then integer addition
2366 can be used instead of floating point (for cases where the result won't
2367 overflow). Before, floating point was always used, which could lead to
28e5dec8
JH
2368 loss of precision compared with integer addition.
2369
2370 * making IV and NV equal status should make maths accurate on 64 bit
2371 platforms
2372 * may speed up maths somewhat if pp_add and friends start to use
645c22ef 2373 integers when possible instead of fp. (Hopefully the overhead in
28e5dec8
JH
2374 looking for SvIOK and checking for overflow will not outweigh the
2375 fp to integer speedup)
2376 * will slow down integer operations (callers of SvIV) on "inaccurate"
2377 values, as the change from SvIOK to SvIOKp will cause a call into
2378 sv_2iv each time rather than a macro access direct to the IV slot
2379 * should speed up number->string conversion on integers as IV is
645c22ef 2380 favoured when IV and NV are equally accurate
28e5dec8
JH
2381
2382 ####################################################################
645c22ef
DM
2383 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2384 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2385 On the other hand, SvUOK is true iff UV.
28e5dec8
JH
2386 ####################################################################
2387
645c22ef 2388 Your mileage will vary depending your CPU's relative fp to integer
28e5dec8
JH
2389 performance ratio.
2390*/
2391
2392#ifndef NV_PRESERVES_UV
645c22ef
DM
2393# define IS_NUMBER_UNDERFLOW_IV 1
2394# define IS_NUMBER_UNDERFLOW_UV 2
2395# define IS_NUMBER_IV_AND_UV 2
2396# define IS_NUMBER_OVERFLOW_IV 4
2397# define IS_NUMBER_OVERFLOW_UV 5
2398
2399/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
28e5dec8
JH
2400
2401/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2402STATIC int
645c22ef 2403S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
28e5dec8 2404{
1779d84d 2405 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
28e5dec8
JH
2406 if (SvNVX(sv) < (NV)IV_MIN) {
2407 (void)SvIOKp_on(sv);
2408 (void)SvNOK_on(sv);
45977657 2409 SvIV_set(sv, IV_MIN);
28e5dec8
JH
2410 return IS_NUMBER_UNDERFLOW_IV;
2411 }
2412 if (SvNVX(sv) > (NV)UV_MAX) {
2413 (void)SvIOKp_on(sv);
2414 (void)SvNOK_on(sv);
2415 SvIsUV_on(sv);
607fa7f2 2416 SvUV_set(sv, UV_MAX);
28e5dec8
JH
2417 return IS_NUMBER_OVERFLOW_UV;
2418 }
c2988b20
NC
2419 (void)SvIOKp_on(sv);
2420 (void)SvNOK_on(sv);
2421 /* Can't use strtol etc to convert this string. (See truth table in
2422 sv_2iv */
2423 if (SvNVX(sv) <= (UV)IV_MAX) {
45977657 2424 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2425 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2426 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2427 } else {
2428 /* Integer is imprecise. NOK, IOKp */
2429 }
2430 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2431 }
2432 SvIsUV_on(sv);
607fa7f2 2433 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2434 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2435 if (SvUVX(sv) == UV_MAX) {
2436 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2437 possibly be preserved by NV. Hence, it must be overflow.
2438 NOK, IOKp */
2439 return IS_NUMBER_OVERFLOW_UV;
2440 }
2441 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2442 } else {
2443 /* Integer is imprecise. NOK, IOKp */
28e5dec8 2444 }
c2988b20 2445 return IS_NUMBER_OVERFLOW_IV;
28e5dec8 2446}
645c22ef
DM
2447#endif /* !NV_PRESERVES_UV*/
2448
891f9566
YST
2449/* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2450 * this function provided for binary compatibility only
2451 */
2452
2453IV
2454Perl_sv_2iv(pTHX_ register SV *sv)
2455{
2456 return sv_2iv_flags(sv, SV_GMAGIC);
2457}
2458
645c22ef 2459/*
891f9566 2460=for apidoc sv_2iv_flags
645c22ef 2461
891f9566
YST
2462Return the integer value of an SV, doing any necessary string
2463conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2464Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
645c22ef
DM
2465
2466=cut
2467*/
28e5dec8 2468
a0d0e21e 2469IV
891f9566 2470Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
79072805
LW
2471{
2472 if (!sv)
2473 return 0;
8990e307 2474 if (SvGMAGICAL(sv)) {
891f9566
YST
2475 if (flags & SV_GMAGIC)
2476 mg_get(sv);
463ee0b2
LW
2477 if (SvIOKp(sv))
2478 return SvIVX(sv);
748a9306 2479 if (SvNOKp(sv)) {
25da4f38 2480 return I_V(SvNVX(sv));
748a9306 2481 }
36477c24
PP
2482 if (SvPOKp(sv) && SvLEN(sv))
2483 return asIV(sv);
3fe9a6f1 2484 if (!SvROK(sv)) {
d008e5eb 2485 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2486 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2487 report_uninit(sv);
c6ee37c5 2488 }
36477c24 2489 return 0;
3fe9a6f1 2490 }
463ee0b2 2491 }
ed6116ce 2492 if (SvTHINKFIRST(sv)) {
a0d0e21e 2493 if (SvROK(sv)) {
a0d0e21e 2494 SV* tmpstr;
1554e226 2495 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2496 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2497 return SvIV(tmpstr);
56431972 2498 return PTR2IV(SvRV(sv));
a0d0e21e 2499 }
765f542d
NC
2500 if (SvIsCOW(sv)) {
2501 sv_force_normal_flags(sv, 0);
47deb5e7 2502 }
0336b60e 2503 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2504 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2505 report_uninit(sv);
ed6116ce
LW
2506 return 0;
2507 }
79072805 2508 }
25da4f38
IZ
2509 if (SvIOKp(sv)) {
2510 if (SvIsUV(sv)) {
2511 return (IV)(SvUVX(sv));
2512 }
2513 else {
2514 return SvIVX(sv);
2515 }
463ee0b2 2516 }
748a9306 2517 if (SvNOKp(sv)) {
28e5dec8
JH
2518 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2519 * without also getting a cached IV/UV from it at the same time
2520 * (ie PV->NV conversion should detect loss of accuracy and cache
2521 * IV or UV at same time to avoid this. NWC */
25da4f38
IZ
2522
2523 if (SvTYPE(sv) == SVt_NV)
2524 sv_upgrade(sv, SVt_PVNV);
2525
28e5dec8
JH
2526 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2527 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2528 certainly cast into the IV range at IV_MAX, whereas the correct
2529 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2530 cases go to UV */
2531 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2532 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2533 if (SvNVX(sv) == (NV) SvIVX(sv)
2534#ifndef NV_PRESERVES_UV
2535 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2536 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2537 /* Don't flag it as "accurately an integer" if the number
2538 came from a (by definition imprecise) NV operation, and
2539 we're outside the range of NV integer precision */
2540#endif
2541 ) {
2542 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2543 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2544 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2545 PTR2UV(sv),
2546 SvNVX(sv),
2547 SvIVX(sv)));
2548
2549 } else {
2550 /* IV not precise. No need to convert from PV, as NV
2551 conversion would already have cached IV if it detected
2552 that PV->IV would be better than PV->NV->IV
2553 flags already correct - don't set public IOK. */
2554 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2555 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2556 PTR2UV(sv),
2557 SvNVX(sv),
2558 SvIVX(sv)));
2559 }
2560 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2561 but the cast (NV)IV_MIN rounds to a the value less (more
2562 negative) than IV_MIN which happens to be equal to SvNVX ??
2563 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2564 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2565 (NV)UVX == NVX are both true, but the values differ. :-(
2566 Hopefully for 2s complement IV_MIN is something like
2567 0x8000000000000000 which will be exact. NWC */
d460ef45 2568 }
25da4f38 2569 else {
607fa7f2 2570 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2571 if (
2572 (SvNVX(sv) == (NV) SvUVX(sv))
2573#ifndef NV_PRESERVES_UV
2574 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2575 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2576 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2577 /* Don't flag it as "accurately an integer" if the number
2578 came from a (by definition imprecise) NV operation, and
2579 we're outside the range of NV integer precision */
2580#endif
2581 )
2582 SvIOK_on(sv);
25da4f38
IZ
2583 SvIsUV_on(sv);
2584 ret_iv_max:
1c846c1f 2585 DEBUG_c(PerlIO_printf(Perl_debug_log,
57def98f 2586 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
56431972 2587 PTR2UV(sv),
57def98f
JH
2588 SvUVX(sv),
2589 SvUVX(sv)));
25da4f38
IZ
2590 return (IV)SvUVX(sv);
2591 }
748a9306
LW
2592 }
2593 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2594 UV value;
504618e9 2595 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
25da4f38
IZ
2596 /* We want to avoid a possible problem when we cache an IV which
2597 may be later translated to an NV, and the resulting NV is not
c2988b20
NC
2598 the same as the direct translation of the initial string
2599 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2600 be careful to ensure that the value with the .456 is around if the
2601 NV value is requested in the future).
1c846c1f 2602
25da4f38
IZ
2603 This means that if we cache such an IV, we need to cache the
2604 NV as well. Moreover, we trade speed for space, and do not
28e5dec8 2605 cache the NV if we are sure it's not needed.
25da4f38 2606 */
16b7a9a4 2607
c2988b20
NC
2608 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2609 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2610 == IS_NUMBER_IN_UV) {
5e045b90 2611 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8
JH
2612 if (SvTYPE(sv) < SVt_PVIV)
2613 sv_upgrade(sv, SVt_PVIV);
f7bbb42a 2614 (void)SvIOK_on(sv);
c2988b20
NC
2615 } else if (SvTYPE(sv) < SVt_PVNV)
2616 sv_upgrade(sv, SVt_PVNV);
28e5dec8 2617
c2988b20
NC
2618 /* If NV preserves UV then we only use the UV value if we know that
2619 we aren't going to call atof() below. If NVs don't preserve UVs
2620 then the value returned may have more precision than atof() will
2621 return, even though value isn't perfectly accurate. */
2622 if ((numtype & (IS_NUMBER_IN_UV
2623#ifdef NV_PRESERVES_UV
2624 | IS_NUMBER_NOT_INT
2625#endif
2626 )) == IS_NUMBER_IN_UV) {
2627 /* This won't turn off the public IOK flag if it was set above */
2628 (void)SvIOKp_on(sv);
2629
2630 if (!(numtype & IS_NUMBER_NEG)) {
2631 /* positive */;
2632 if (value <= (UV)IV_MAX) {
45977657 2633 SvIV_set(sv, (IV)value);
c2988b20 2634 } else {
607fa7f2 2635 SvUV_set(sv, value);
c2988b20
NC
2636 SvIsUV_on(sv);
2637 }
2638 } else {
2639 /* 2s complement assumption */
2640 if (value <= (UV)IV_MIN) {
45977657 2641 SvIV_set(sv, -(IV)value);
c2988b20
NC
2642 } else {
2643 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2644 I'm assuming it will be rare. */
c2988b20
NC
2645 if (SvTYPE(sv) < SVt_PVNV)
2646 sv_upgrade(sv, SVt_PVNV);
2647 SvNOK_on(sv);
2648 SvIOK_off(sv);
2649 SvIOKp_on(sv);
9d6ce603 2650 SvNV_set(sv, -(NV)value);
45977657 2651 SvIV_set(sv, IV_MIN);
c2988b20
NC
2652 }
2653 }
2654 }
2655 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2656 will be in the previous block to set the IV slot, and the next
2657 block to set the NV slot. So no else here. */
2658
2659 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2660 != IS_NUMBER_IN_UV) {
2661 /* It wasn't an (integer that doesn't overflow the UV). */
9d6ce603 2662 SvNV_set(sv, Atof(SvPVX(sv)));
28e5dec8 2663
c2988b20
NC
2664 if (! numtype && ckWARN(WARN_NUMERIC))
2665 not_a_number(sv);
28e5dec8 2666
65202027 2667#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2668 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2669 PTR2UV(sv), SvNVX(sv)));
65202027 2670#else
1779d84d 2671 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
c2988b20 2672 PTR2UV(sv), SvNVX(sv)));
65202027 2673#endif
28e5dec8
JH
2674
2675
2676#ifdef NV_PRESERVES_UV
c2988b20
NC
2677 (void)SvIOKp_on(sv);
2678 (void)SvNOK_on(sv);
2679 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2680 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2681 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2682 SvIOK_on(sv);
28e5dec8 2683 } else {
c2988b20
NC
2684 /* Integer is imprecise. NOK, IOKp */
2685 }
2686 /* UV will not work better than IV */
2687 } else {
2688 if (SvNVX(sv) > (NV)UV_MAX) {
2689 SvIsUV_on(sv);
2690 /* Integer is inaccurate. NOK, IOKp, is UV */
607fa7f2 2691 SvUV_set(sv, UV_MAX);
c2988b20
NC
2692 SvIsUV_on(sv);
2693 } else {
607fa7f2 2694 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2695 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2696 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2697 SvIOK_on(sv);
28e5dec8
JH
2698 SvIsUV_on(sv);
2699 } else {
c2988b20
NC
2700 /* Integer is imprecise. NOK, IOKp, is UV */
2701 SvIsUV_on(sv);
28e5dec8 2702 }
28e5dec8 2703 }
c2988b20
NC
2704 goto ret_iv_max;
2705 }
28e5dec8 2706#else /* NV_PRESERVES_UV */
c2988b20
NC
2707 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2708 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2709 /* The IV slot will have been set from value returned by
2710 grok_number above. The NV slot has just been set using
2711 Atof. */
560b0c46 2712 SvNOK_on(sv);
c2988b20
NC
2713 assert (SvIOKp(sv));
2714 } else {
2715 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2716 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2717 /* Small enough to preserve all bits. */
2718 (void)SvIOKp_on(sv);
2719 SvNOK_on(sv);
45977657 2720 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2721 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2722 SvIOK_on(sv);
2723 /* Assumption: first non-preserved integer is < IV_MAX,
2724 this NV is in the preserved range, therefore: */
2725 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2726 < (UV)IV_MAX)) {
32fdb065 2727 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
2728 }
2729 } else {
2730 /* IN_UV NOT_INT
2731 0 0 already failed to read UV.
2732 0 1 already failed to read UV.
2733 1 0 you won't get here in this case. IV/UV
2734 slot set, public IOK, Atof() unneeded.
2735 1 1 already read UV.
2736 so there's no point in sv_2iuv_non_preserve() attempting
2737 to use atol, strtol, strtoul etc. */
2738 if (sv_2iuv_non_preserve (sv, numtype)
2739 >= IS_NUMBER_OVERFLOW_IV)
2740 goto ret_iv_max;
2741 }
2742 }
28e5dec8 2743#endif /* NV_PRESERVES_UV */
25da4f38 2744 }
28e5dec8 2745 } else {
599cee73 2746 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 2747 report_uninit(sv);
25da4f38
IZ
2748 if (SvTYPE(sv) < SVt_IV)
2749 /* Typically the caller expects that sv_any is not NULL now. */
2750 sv_upgrade(sv, SVt_IV);
a0d0e21e 2751 return 0;
79072805 2752 }
1d7c1841
GS
2753 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2754 PTR2UV(sv),SvIVX(sv)));
25da4f38 2755 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
79072805
LW
2756}
2757
891f9566
YST
2758/* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2759 * this function provided for binary compatibility only
2760 */
2761
2762UV
2763Perl_sv_2uv(pTHX_ register SV *sv)
2764{
2765 return sv_2uv_flags(sv, SV_GMAGIC);
2766}
2767
645c22ef 2768/*
891f9566 2769=for apidoc sv_2uv_flags
645c22ef
DM
2770
2771Return the unsigned integer value of an SV, doing any necessary string
891f9566
YST
2772conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2773Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
645c22ef
DM
2774
2775=cut
2776*/
2777
ff68c719 2778UV
891f9566 2779Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
ff68c719
PP
2780{
2781 if (!sv)
2782 return 0;
2783 if (SvGMAGICAL(sv)) {
891f9566
YST
2784 if (flags & SV_GMAGIC)
2785 mg_get(sv);
ff68c719
PP
2786 if (SvIOKp(sv))
2787 return SvUVX(sv);
2788 if (SvNOKp(sv))
2789 return U_V(SvNVX(sv));
36477c24
PP
2790 if (SvPOKp(sv) && SvLEN(sv))
2791 return asUV(sv);
3fe9a6f1 2792 if (!SvROK(sv)) {
d008e5eb 2793 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2794 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2795 report_uninit(sv);
c6ee37c5 2796 }
36477c24 2797 return 0;
3fe9a6f1 2798 }
ff68c719
PP
2799 }
2800 if (SvTHINKFIRST(sv)) {
2801 if (SvROK(sv)) {
ff68c719 2802 SV* tmpstr;
1554e226 2803 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2804 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2805 return SvUV(tmpstr);
56431972 2806 return PTR2UV(SvRV(sv));
ff68c719 2807 }
765f542d
NC
2808 if (SvIsCOW(sv)) {
2809 sv_force_normal_flags(sv, 0);
8a818333 2810 }
0336b60e 2811 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2812 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2813 report_uninit(sv);
ff68c719
PP
2814 return 0;
2815 }
2816 }
25da4f38
IZ
2817 if (SvIOKp(sv)) {
2818 if (SvIsUV(sv)) {
2819 return SvUVX(sv);
2820 }
2821 else {
2822 return (UV)SvIVX(sv);
2823 }
ff68c719
PP
2824 }
2825 if (SvNOKp(sv)) {
28e5dec8
JH
2826 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2827 * without also getting a cached IV/UV from it at the same time
2828 * (ie PV->NV conversion should detect loss of accuracy and cache
2829 * IV or UV at same time to avoid this. */
2830 /* IV-over-UV optimisation - choose to cache IV if possible */
2831
25da4f38
IZ
2832 if (SvTYPE(sv) == SVt_NV)
2833 sv_upgrade(sv, SVt_PVNV);
28e5dec8
JH
2834
2835 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2836 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2837 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2838 if (SvNVX(sv) == (NV) SvIVX(sv)
2839#ifndef NV_PRESERVES_UV
2840 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2841 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2842 /* Don't flag it as "accurately an integer" if the number
2843 came from a (by definition imprecise) NV operation, and
2844 we're outside the range of NV integer precision */
2845#endif
2846 ) {
2847 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2848 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2849 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2850 PTR2UV(sv),
2851 SvNVX(sv),
2852 SvIVX(sv)));
2853
2854 } else {
2855 /* IV not precise. No need to convert from PV, as NV
2856 conversion would already have cached IV if it detected
2857 that PV->IV would be better than PV->NV->IV
2858 flags already correct - don't set public IOK. */
2859 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2860 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2861 PTR2UV(sv),
2862 SvNVX(sv),
2863 SvIVX(sv)));
2864 }
2865 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2866 but the cast (NV)IV_MIN rounds to a the value less (more
2867 negative) than IV_MIN which happens to be equal to SvNVX ??
2868 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2869 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2870 (NV)UVX == NVX are both true, but the values differ. :-(
2871 Hopefully for 2s complement IV_MIN is something like
2872 0x8000000000000000 which will be exact. NWC */
d460ef45 2873 }
28e5dec8 2874 else {
607fa7f2 2875 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2876 if (
2877 (SvNVX(sv) == (NV) SvUVX(sv))
2878#ifndef NV_PRESERVES_UV
2879 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2880 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2881 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2882 /* Don't flag it as "accurately an integer" if the number
2883 came from a (by definition imprecise) NV operation, and
2884 we're outside the range of NV integer precision */
2885#endif
2886 )
2887 SvIOK_on(sv);
2888 SvIsUV_on(sv);
1c846c1f 2889 DEBUG_c(PerlIO_printf(Perl_debug_log,
28e5dec8 2890 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
57def98f 2891 PTR2UV(sv),
28e5dec8
JH
2892 SvUVX(sv),
2893 SvUVX(sv)));
25da4f38 2894 }
ff68c719
PP
2895 }
2896 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2897 UV value;
504618e9 2898 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
25da4f38
IZ
2899
2900 /* We want to avoid a possible problem when we cache a UV which
2901 may be later translated to an NV, and the resulting NV is not
2902 the translation of the initial data.
1c846c1f 2903
25da4f38
IZ
2904 This means that if we cache such a UV, we need to cache the
2905 NV as well. Moreover, we trade speed for space, and do not
2906 cache the NV if not needed.
2907 */
16b7a9a4 2908
c2988b20
NC
2909 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2910 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2911 == IS_NUMBER_IN_UV) {
5e045b90 2912 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8 2913 if (SvTYPE(sv) < SVt_PVIV)
f7bbb42a
JH
2914 sv_upgrade(sv, SVt_PVIV);
2915 (void)SvIOK_on(sv);
c2988b20
NC
2916 } else if (SvTYPE(sv) < SVt_PVNV)
2917 sv_upgrade(sv, SVt_PVNV);
d460ef45 2918
c2988b20
NC
2919 /* If NV preserves UV then we only use the UV value if we know that
2920 we aren't going to call atof() below. If NVs don't preserve UVs
2921 then the value returned may have more precision than atof() will
2922 return, even though it isn't accurate. */
2923 if ((numtype & (IS_NUMBER_IN_UV
2924#ifdef NV_PRESERVES_UV
2925 | IS_NUMBER_NOT_INT
2926#endif
2927 )) == IS_NUMBER_IN_UV) {
2928 /* This won't turn off the public IOK flag if it was set above */
2929 (void)SvIOKp_on(sv);
2930
2931 if (!(numtype & IS_NUMBER_NEG)) {
2932 /* positive */;
2933 if (value <= (UV)IV_MAX) {
45977657 2934 SvIV_set(sv, (IV)value);
28e5dec8
JH
2935 } else {
2936 /* it didn't overflow, and it was positive. */
607fa7f2 2937 SvUV_set(sv, value);
28e5dec8
JH
2938 SvIsUV_on(sv);
2939 }
c2988b20
NC
2940 } else {
2941 /* 2s complement assumption */
2942 if (value <= (UV)IV_MIN) {
45977657 2943 SvIV_set(sv, -(IV)value);
c2988b20
NC
2944 } else {
2945 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2946 I'm assuming it will be rare. */
c2988b20
NC
2947 if (SvTYPE(sv) < SVt_PVNV)
2948 sv_upgrade(sv, SVt_PVNV);
2949 SvNOK_on(sv);
2950 SvIOK_off(sv);
2951 SvIOKp_on(sv);
9d6ce603 2952 SvNV_set(sv, -(NV)value);
45977657 2953 SvIV_set(sv, IV_MIN);
c2988b20
NC
2954 }
2955 }
2956 }
2957
2958 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2959 != IS_NUMBER_IN_UV) {
2960 /* It wasn't an integer, or it overflowed the UV. */
9d6ce603 2961 SvNV_set(sv, Atof(SvPVX(sv)));
28e5dec8 2962
c2988b20 2963 if (! numtype && ckWARN(WARN_NUMERIC))
28e5dec8
JH
2964 not_a_number(sv);
2965
2966#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2967 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2968 PTR2UV(sv), SvNVX(sv)));
28e5dec8 2969#else
1779d84d 2970 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
c2988b20 2971 PTR2UV(sv), SvNVX(sv)));
28e5dec8
JH
2972#endif
2973
2974#ifdef NV_PRESERVES_UV
c2988b20
NC
2975 (void)SvIOKp_on(sv);
2976 (void)SvNOK_on(sv);
2977 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2978 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2979 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2980 SvIOK_on(sv);
2981 } else {
2982 /* Integer is imprecise. NOK, IOKp */
2983 }
2984 /* UV will not work better than IV */
2985 } else {
2986 if (SvNVX(sv) > (NV)UV_MAX) {
2987 SvIsUV_on(sv);
2988 /* Integer is inaccurate. NOK, IOKp, is UV */
607fa7f2 2989 SvUV_set(sv, UV_MAX);
c2988b20
NC
2990 SvIsUV_on(sv);
2991 } else {
607fa7f2 2992 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2993 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2994 NV preservse UV so can do correct comparison. */
2995 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2996 SvIOK_on(sv);
2997 SvIsUV_on(sv);
2998 } else {
2999 /* Integer is imprecise. NOK, IOKp, is UV */
3000 SvIsUV_on(sv);
3001 }
3002 }
3003 }
28e5dec8 3004#else /* NV_PRESERVES_UV */
c2988b20
NC
3005 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3006 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3007 /* The UV slot will have been set from value returned by
3008 grok_number above. The NV slot has just been set using
3009 Atof. */
560b0c46 3010 SvNOK_on(sv);
c2988b20
NC
3011 assert (SvIOKp(sv));
3012 } else {
3013 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3014 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3015 /* Small enough to preserve all bits. */
3016 (void)SvIOKp_on(sv);
3017 SvNOK_on(sv);
45977657 3018 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
3019 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3020 SvIOK_on(sv);
3021 /* Assumption: first non-preserved integer is < IV_MAX,
3022 this NV is in the preserved range, therefore: */
3023 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3024 < (UV)IV_MAX)) {
32fdb065 3025 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
3026 }
3027 } else
3028 sv_2iuv_non_preserve (sv, numtype);
3029 }
28e5dec8 3030#endif /* NV_PRESERVES_UV */
f7bbb42a 3031 }
ff68c719
PP
3032 }
3033 else {
d008e5eb 3034 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3035 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3036 report_uninit(sv);
c6ee37c5 3037 }
25da4f38
IZ
3038 if (SvTYPE(sv) < SVt_IV)
3039 /* Typically the caller expects that sv_any is not NULL now. */
3040 sv_upgrade(sv, SVt_IV);
ff68c719
PP
3041 return 0;
3042 }
25da4f38 3043
1d7c1841
GS
3044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3045 PTR2UV(sv),SvUVX(sv)));
25da4f38 3046 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
ff68c719
PP
3047}
3048
645c22ef
DM
3049/*
3050=for apidoc sv_2nv
3051
3052Return the num value of an SV, doing any necessary string or integer
3053conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3054macros.
3055
3056=cut
3057*/
3058
65202027 3059NV
864dbfa3 3060Perl_sv_2nv(pTHX_ register SV *sv)
79072805
LW
3061{
3062 if (!sv)
3063 return 0.0;
8990e307 3064 if (SvGMAGICAL(sv)) {
463ee0b2
LW
3065 mg_get(sv);
3066 if (SvNOKp(sv))
3067 return SvNVX(sv);
a0d0e21e 3068 if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 3069 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
504618e9 3070 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
a0d0e21e 3071 not_a_number(sv);
097ee67d 3072 return Atof(SvPVX(sv));
a0d0e21e 3073 }
25da4f38 3074 if (SvIOKp(sv)) {
1c846c1f 3075 if (SvIsUV(sv))
65202027 3076 return (NV)SvUVX(sv);
25da4f38 3077 else
65202027 3078 return (NV)SvIVX(sv);
25da4f38 3079 }
16d20bd9 3080 if (!SvROK(sv)) {
d008e5eb 3081 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3082 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3083 report_uninit(sv);
c6ee37c5 3084 }
16d20bd9
AD
3085 return 0;
3086 }
463ee0b2 3087 }
ed6116ce 3088 if (SvTHINKFIRST(sv)) {
a0d0e21e 3089 if (SvROK(sv)) {
a0d0e21e 3090 SV* tmpstr;
1554e226 3091 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 3092 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 3093 return SvNV(tmpstr);
56431972 3094 return PTR2NV(SvRV(sv));
a0d0e21e 3095 }
765f542d
NC
3096 if (SvIsCOW(sv)) {
3097 sv_force_normal_flags(sv, 0);
8a818333 3098 }
0336b60e 3099 if (SvREADONLY(sv) && !SvOK(sv)) {
599cee73 3100 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3101 report_uninit(sv);
ed6116ce
LW
3102 return 0.0;
3103 }
79072805
LW
3104 }
3105 if (SvTYPE(sv) < SVt_NV) {
463ee0b2
LW
3106 if (SvTYPE(sv) == SVt_IV)
3107 sv_upgrade(sv, SVt_PVNV);
3108 else
3109 sv_upgrade(sv, SVt_NV);
906f284f 3110#ifdef USE_LONG_DOUBLE
097ee67d 3111 DEBUG_c({
f93f4e46 3112 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3113 PerlIO_printf(Perl_debug_log,
3114 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3115 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3116 RESTORE_NUMERIC_LOCAL();
3117 });
65202027 3118#else
572bbb43 3119 DEBUG_c({
f93f4e46 3120 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3121 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
1d7c1841 3122 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3123 RESTORE_NUMERIC_LOCAL();
3124 });
572bbb43 3125#endif
79072805
LW
3126 }
3127 else if (SvTYPE(sv) < SVt_PVNV)
3128 sv_upgrade(sv, SVt_PVNV);
59d8ce62
NC
3129 if (SvNOKp(sv)) {
3130 return SvNVX(sv);
61604483 3131 }
59d8ce62 3132 if (SvIOKp(sv)) {
9d6ce603 3133 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
28e5dec8
JH
3134#ifdef NV_PRESERVES_UV
3135 SvNOK_on(sv);
3136#else
3137 /* Only set the public NV OK flag if this NV preserves the IV */
3138 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3139 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3140 : (SvIVX(sv) == I_V(SvNVX(sv))))
3141 SvNOK_on(sv);
3142 else
3143 SvNOKp_on(sv);
3144#endif
93a17b20 3145 }
748a9306 3146 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 3147 UV value;
f54cb97a 3148 const int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
c2988b20 3149 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
a0d0e21e 3150 not_a_number(sv);
28e5dec8 3151#ifdef NV_PRESERVES_UV
c2988b20
NC
3152 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3153 == IS_NUMBER_IN_UV) {
5e045b90 3154 /* It's definitely an integer */
9d6ce603 3155 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
c2988b20 3156 } else
9d6ce603 3157 SvNV_set(sv, Atof(SvPVX(sv)));
28e5dec8
JH
3158 SvNOK_on(sv);
3159#else
9d6ce603 3160 SvNV_set(sv, Atof(SvPVX(sv)));
28e5dec8
JH
3161 /* Only set the public NV OK flag if this NV preserves the value in
3162 the PV at least as well as an IV/UV would.
3163 Not sure how to do this 100% reliably. */
3164 /* if that shift count is out of range then Configure's test is
3165 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3166 UV_BITS */
3167 if (((UV)1 << NV_PRESERVES_UV_BITS) >
c2988b20 3168 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
28e5dec8 3169 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
c2988b20
NC
3170 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3171 /* Can't use strtol etc to convert this string, so don't try.
3172 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3173 SvNOK_on(sv);
3174 } else {
3175 /* value has been set. It may not be precise. */
3176 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3177 /* 2s complement assumption for (UV)IV_MIN */
3178 SvNOK_on(sv); /* Integer is too negative. */
3179 } else {
3180 SvNOKp_on(sv);
3181 SvIOKp_on(sv);
6fa402ec 3182
c2988b20 3183 if (numtype & IS_NUMBER_NEG) {
45977657 3184 SvIV_set(sv, -(IV)value);
c2988b20 3185 } else if (value <= (UV)IV_MAX) {
45977657 3186 SvIV_set(sv, (IV)value);
c2988b20 3187 } else {
607fa7f2 3188 SvUV_set(sv, value);
c2988b20
NC
3189 SvIsUV_on(sv);
3190 }
3191
3192 if (numtype & IS_NUMBER_NOT_INT) {
3193 /* I believe that even if the original PV had decimals,
3194 they are lost beyond the limit of the FP precision.
3195 However, neither is canonical, so both only get p
3196 flags. NWC, 2000/11/25 */
3197 /* Both already have p flags, so do nothing */
3198 } else {
3199 NV nv = SvNVX(sv);
3200 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3201 if (SvIVX(sv) == I_V(nv)) {
3202 SvNOK_on(sv);
3203 SvIOK_on(sv);
3204 } else {
3205 SvIOK_on(sv);
3206 /* It had no "." so it must be integer. */
3207 }
3208 } else {
3209 /* between IV_MAX and NV(UV_MAX).
3210 Could be slightly > UV_MAX */
6fa402ec 3211
c2988b20
NC
3212 if (numtype & IS_NUMBER_NOT_INT) {
3213 /* UV and NV both imprecise. */
3214 } else {
3215 UV nv_as_uv = U_V(nv);
3216
3217 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3218 SvNOK_on(sv);
3219 SvIOK_on(sv);
3220 } else {
3221 SvIOK_on(sv);
3222 }
3223 }
3224 }
3225 }
3226 }
3227 }
28e5dec8 3228#endif /* NV_PRESERVES_UV */
93a17b20 3229 }
79072805 3230 else {
599cee73 3231 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3232 report_uninit(sv);
25da4f38
IZ
3233 if (SvTYPE(sv) < SVt_NV)
3234 /* Typically the caller expects that sv_any is not NULL now. */
28e5dec8
JH
3235 /* XXX Ilya implies that this is a bug in callers that assume this
3236 and ideally should be fixed. */
25da4f38 3237 sv_upgrade(sv, SVt_NV);
a0d0e21e 3238 return 0.0;
79072805 3239 }
572bbb43 3240#if defined(USE_LONG_DOUBLE)
097ee67d 3241 DEBUG_c({
f93f4e46 3242 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3243 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3244 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3245 RESTORE_NUMERIC_LOCAL();
3246 });
65202027 3247#else
572bbb43 3248 DEBUG_c({
f93f4e46 3249 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3250 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
1d7c1841 3251 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3252 RESTORE_NUMERIC_LOCAL();
3253 });
572bbb43 3254#endif
463ee0b2 3255 return SvNVX(sv);
79072805
LW
3256}
3257
645c22ef
DM
3258/* asIV(): extract an integer from the string value of an SV.
3259 * Caller must validate PVX */
3260
76e3520e 3261STATIC IV
cea2e8a9 3262S_asIV(pTHX_ SV *sv)
36477c24 3263{
c2988b20
NC
3264 UV value;
3265 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3266
3267 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3268 == IS_NUMBER_IN_UV) {
645c22ef 3269 /* It's definitely an integer */
c2988b20
NC
3270 if (numtype & IS_NUMBER_NEG) {
3271 if (value < (UV)IV_MIN)
3272 return -(IV)value;
3273 } else {
3274 if (value < (UV)IV_MAX)
3275 return (IV)value;
3276 }
3277 }
d008e5eb 3278 if (!numtype) {
d008e5eb
GS
3279 if (ckWARN(WARN_NUMERIC))
3280 not_a_number(sv);
3281 }
c2988b20 3282 return I_V(Atof(SvPVX(sv)));
36477c24
PP
3283}
3284
645c22ef
DM
3285/* asUV(): extract an unsigned integer from the string value of an SV
3286 * Caller must validate PVX */
3287
76e3520e 3288STATIC UV
cea2e8a9 3289S_asUV(pTHX_ SV *sv)
36477c24 3290{
c2988b20 3291 UV value;
504618e9 3292 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
36477c24 3293
c2988b20
NC
3294 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3295 == IS_NUMBER_IN_UV) {
645c22ef 3296 /* It's definitely an integer */
6fa402ec 3297 if (!(numtype & IS_NUMBER_NEG))
c2988b20
NC
3298 return value;
3299 }
d008e5eb 3300 if (!numtype) {
d008e5eb
GS
3301 if (ckWARN(WARN_NUMERIC))
3302 not_a_number(sv);
3303 }
097ee67d 3304 return U_V(Atof(SvPVX(sv)));
36477c24
PP
3305}
3306
645c22ef
DM
3307/*
3308=for apidoc sv_2pv_nolen
3309
3310Like C<sv_2pv()>, but doesn't return the length too. You should usually
3311use the macro wrapper C<SvPV_nolen(sv)> instead.
3312=cut
3313*/
3314
79072805 3315char *
864dbfa3 3316Perl_sv_2pv_nolen(pTHX_ register SV *sv)
1fa8b10d
JD
3317{
3318 STRLEN n_a;
3319 return sv_2pv(sv, &n_a);
3320}
3321
645c22ef
DM
3322/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3323 * UV as a string towards the end of buf, and return pointers to start and
3324 * end of it.
3325 *
3326 * We assume that buf is at least TYPE_CHARS(UV) long.
3327 */
3328
864dbfa3 3329static char *
25da4f38
IZ
3330uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3331{
25da4f38
IZ
3332 char *ptr = buf + TYPE_CHARS(UV);
3333 char *ebuf = ptr;
3334 int sign;
25da4f38
IZ
3335
3336 if (is_uv)
3337 sign = 0;
3338 else if (iv >= 0) {
3339 uv = iv;
3340 sign = 0;
3341 } else {
3342 uv = -iv;
3343 sign = 1;
3344 }
3345 do {
eb160463 3346 *--ptr = '0' + (char)(uv % 10);
25da4f38
IZ
3347 } while (uv /= 10);
3348 if (sign)
3349 *--ptr = '-';
3350 *peob = ebuf;
3351 return ptr;
3352}
3353
09540bc3
JH
3354/* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3355 * this function provided for binary compatibility only
3356 */
3357
3358char *
3359Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3360{
3361 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3362}
3363
645c22ef
DM
3364/*
3365=for apidoc sv_2pv_flags
3366
ff276b08 3367Returns a pointer to the string value of an SV, and sets *lp to its length.
645c22ef
DM
3368If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3369if necessary.
3370Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3371usually end up here too.
3372
3373=cut
3374*/
3375
8d6d96c1
HS
3376char *
3377Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3378{
79072805
LW
3379 register char *s;
3380 int olderrno;
cb50f42d 3381 SV *tsv, *origsv;
25da4f38
IZ
3382 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3383 char *tmpbuf = tbuf;
79072805 3384
463ee0b2
LW
3385 if (!sv) {
3386 *lp = 0;
73d840c0 3387 return (char *)"";
463ee0b2 3388 }
8990e307 3389 if (SvGMAGICAL(sv)) {
8d6d96c1
HS
3390 if (flags & SV_GMAGIC)
3391 mg_get(sv);
463ee0b2
LW
3392 if (SvPOKp(sv)) {
3393 *lp = SvCUR(sv);
3394 return SvPVX(sv);
3395 }
cf2093f6 3396 if (SvIOKp(sv)) {
1c846c1f 3397 if (SvIsUV(sv))
57def98f 3398 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
cf2093f6 3399 else
57def98f 3400 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
46fc3d4c 3401 tsv = Nullsv;
a0d0e21e 3402 goto tokensave;
463ee0b2
LW
3403 }
3404 if (SvNOKp(sv)) {
2d4389e4 3405 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
46fc3d4c 3406 tsv = Nullsv;
a0d0e21e 3407 goto tokensave;
463ee0b2 3408 }
16d20bd9 3409 if (!SvROK(sv)) {
d008e5eb 3410 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3411 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3412 report_uninit(sv);
c6ee37c5 3413 }
16d20bd9 3414 *lp = 0;
73d840c0 3415 return (char *)"";
16d20bd9 3416 }
463ee0b2 3417 }
ed6116ce
LW
3418 if (SvTHINKFIRST(sv)) {
3419 if (SvROK(sv)) {
a0d0e21e 3420 SV* tmpstr;
e1ec3a88 3421 register const char *typestr;
1554e226 3422 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
b4b9a328 3423 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
446eaa42
YST
3424 char *pv = SvPV(tmpstr, *lp);
3425 if (SvUTF8(tmpstr))
3426 SvUTF8_on(sv);
3427 else
3428 SvUTF8_off(sv);
3429 return pv;
3430 }
cb50f42d 3431 origsv = sv;
ed6116ce
LW
3432 sv = (SV*)SvRV(sv);
3433 if (!sv)
e1ec3a88 3434 typestr = "NULLREF";
ed6116ce 3435 else {
f9277f47
IZ
3436 MAGIC *mg;
3437
ed6116ce 3438 switch (SvTYPE(sv)) {
f9277f47
IZ
3439 case SVt_PVMG:
3440 if ( ((SvFLAGS(sv) &
1c846c1f 3441 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
faf82a0b 3442 == (SVs_OBJECT|SVs_SMG))
14befaf4 3443 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
e1ec3a88 3444 const regexp *re = (regexp *)mg->mg_obj;
1bd3ad17 3445
2cd61cdb 3446 if (!mg->mg_ptr) {
e1ec3a88 3447 const char *fptr = "msix";
8782bef2
GB
3448 char reflags[6];
3449 char ch;
3450 int left = 0;
3451 int right = 4;
ff385a1b 3452 char need_newline = 0;
eb160463 3453 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
8782bef2 3454
155aba94 3455 while((ch = *fptr++)) {
8782bef2
GB
3456 if(reganch & 1) {
3457 reflags[left++] = ch;
3458 }
3459 else {
3460 reflags[right--] = ch;
3461 }
3462 reganch >>= 1;
3463 }
3464 if(left != 4) {
3465 reflags[left] = '-';
3466 left = 5;
3467 }
3468
3469 mg->mg_len = re->prelen + 4 + left;
ff385a1b
JF
3470 /*
3471 * If /x was used, we have to worry about a regex
3472 * ending with a comment later being embedded
3473 * within another regex. If so, we don't want this
3474 * regex's "commentization" to leak out to the
3475 * right part of the enclosing regex, we must cap
3476 * it with a newline.
3477 *
3478 * So, if /x was used, we scan backwards from the
3479 * end of the regex. If we find a '#' before we
3480 * find a newline, we need to add a newline
3481 * ourself. If we find a '\n' first (or if we
3482 * don't find '#' or '\n'), we don't need to add
3483 * anything. -jfriedl
3484 */
3485 if (PMf_EXTENDED & re->reganch)
3486 {
e1ec3a88 3487 const char *endptr = re->precomp + re->prelen;
ff385a1b
JF
3488 while (endptr >= re->precomp)
3489 {
e1ec3a88 3490 const char c = *(endptr--);
ff385a1b
JF
3491 if (c == '\n')
3492 break; /* don't need another */
3493 if (c == '#') {
3494 /* we end while in a comment, so we
3495 need a newline */
3496 mg->mg_len++; /* save space for it */
3497 need_newline = 1; /* note to add it */
ab01544f 3498 break;
ff385a1b
JF
3499 }
3500 }
3501 }
3502
8782bef2
GB
3503 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3504 Copy("(?", mg->mg_ptr, 2, char);
3505 Copy(reflags, mg->mg_ptr+2, left, char);
3506 Copy(":", mg->mg_ptr+left+2, 1, char);
3507 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
ff385a1b
JF
3508 if (need_newline)
3509 mg->mg_ptr[mg->mg_len - 2] = '\n';
1bd3ad17
IZ
3510 mg->mg_ptr[mg->mg_len - 1] = ')';
3511 mg->mg_ptr[mg->mg_len] = 0;
3512 }
3280af22 3513 PL_reginterp_cnt += re->program[0].next_off;
cb50f42d
YST
3514
3515 if (re->reganch & ROPT_UTF8)
3516 SvUTF8_on(origsv);
3517 else
3518 SvUTF8_off(origsv);
1bd3ad17
IZ
3519 *lp = mg->mg_len;
3520 return mg->mg_ptr;
f9277f47
IZ
3521 }
3522 /* Fall through */
ed6116ce
LW
3523 case SVt_NULL:
3524 case SVt_IV:
3525 case SVt_NV:
3526 case SVt_RV:
3527 case SVt_PV:
3528 case SVt_PVIV:
3529 case SVt_PVNV:
e1ec3a88
AL
3530 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3531 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
be65207d
DM
3532 /* tied lvalues should appear to be
3533 * scalars for backwards compatitbility */
3534 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3535 ? "SCALAR" : "LVALUE"; break;
e1ec3a88
AL
3536 case SVt_PVAV: typestr = "ARRAY"; break;
3537 case SVt_PVHV: typestr = "HASH"; break;
3538 case SVt_PVCV: typestr = "CODE"; break;
3539 case SVt_PVGV: typestr = "GLOB"; break;
3540 case SVt_PVFM: typestr = "FORMAT"; break;
3541 case SVt_PVIO: typestr = "IO"; break;
3542 default: typestr = "UNKNOWN"; break;
ed6116ce 3543 }
46fc3d4c 3544 tsv = NEWSV(0,0);
a5cb6b62 3545 if (SvOBJECT(sv)) {
bfcb3514 3546 const char *name = HvNAME_get(SvSTASH(sv));
a5cb6b62 3547 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
e1ec3a88 3548 name ? name : "__ANON__" , typestr, PTR2UV(sv));
a5cb6b62 3549 }
ed6116ce 3550 else
e1ec3a88 3551 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
a0d0e21e 3552 goto tokensaveref;
463ee0b2 3553 }
e1ec3a88 3554 *lp = strlen(typestr);
73d840c0 3555 return (char *)typestr;
79072805 3556 }
0336b60e 3557 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 3558 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3559 report_uninit(sv);
ed6116ce 3560 *lp = 0;
73d840c0 3561 return (char *)"";
79072805 3562 }
79072805 3563 }
28e5dec8
JH
3564 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3565 /* I'm assuming that if both IV and NV are equally valid then
3566 converting the IV is going to be more efficient */
e1ec3a88
AL
3567 const U32 isIOK = SvIOK(sv);
3568 const U32 isUIOK = SvIsUV(sv);
28e5dec8
JH
3569 char buf[TYPE_CHARS(UV)];
3570 char *ebuf, *ptr;
3571
3572 if (SvTYPE(sv) < SVt_PVIV)
3573 sv_upgrade(sv, SVt_PVIV);
3574 if (isUIOK)
3575 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3576 else
3577 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
eb160463 3578 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
28e5dec8
JH
3579 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3580 SvCUR_set(sv, ebuf - ptr);
3581 s = SvEND(sv);
3582 *s = '\0';
3583 if (isIOK)
3584 SvIOK_on(sv);
3585 else
3586 SvIOKp_on(sv);
3587 if (isUIOK)
3588 SvIsUV_on(sv);
3589 }
3590 else if (SvNOKp(sv)) {
79072805
LW
3591 if (SvTYPE(sv) < SVt_PVNV)
3592 sv_upgrade(sv, SVt_PVNV);
1c846c1f 3593 /* The +20 is pure guesswork. Configure test needed. --jhi */
59155cc0 3594 SvGROW(sv, NV_DIG + 20);
463ee0b2 3595 s = SvPVX(sv);
79072805 3596 olderrno = errno; /* some Xenix systems wipe out errno here */
79072805 3597#ifdef apollo
463ee0b2 3598 if (SvNVX(sv) == 0.0)
79072805
LW
3599 (void)strcpy(s,"0");
3600 else
3601#endif /*apollo*/
bbce6d69 3602 {
2d4389e4 3603 Gconvert(SvNVX(sv), NV_DIG, 0, s);
bbce6d69 3604 }
79072805 3605 errno = olderrno;
a0d0e21e
LW
3606#ifdef FIXNEGATIVEZERO
3607 if (*s == '-' && s[1] == '0' && !s[2])
3608 strcpy(s,"0");
3609#endif
79072805
LW
3610 while (*s) s++;
3611#ifdef hcx
3612 if (s[-1] == '.')
46fc3d4c 3613 *--s = '\0';
79072805
LW
3614#endif
3615 }
79072805 3616 else {
0336b60e
IZ
3617 if (ckWARN(WARN_UNINITIALIZED)
3618 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3619 report_uninit(sv);
a0d0e21e 3620 *lp = 0;
25da4f38
IZ
3621 if (SvTYPE(sv) < SVt_PV)
3622 /* Typically the caller expects that sv_any is not NULL now. */
3623 sv_upgrade(sv, SVt_PV);
73d840c0 3624 return (char *)"";
79072805 3625 }
463ee0b2
LW
3626 *lp = s - SvPVX(sv);
3627 SvCUR_set(sv, *lp);
79072805 3628 SvPOK_on(sv);
1d7c1841
GS
3629 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3630 PTR2UV(sv),SvPVX(sv)));
463ee0b2 3631 return SvPVX(sv);
a0d0e21e
LW
3632
3633 tokensave:
3634 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3635 /* Sneaky stuff here */
3636
3637 tokensaveref:
46fc3d4c 3638 if (!tsv)
96827780 3639 tsv = newSVpv(tmpbuf, 0);
46fc3d4c
PP
3640 sv_2mortal(tsv);
3641 *lp = SvCUR(tsv);
3642 return SvPVX(tsv);
a0d0e21e
LW
3643 }
3644 else {
27da23d5 3645 dVAR;
a0d0e21e 3646 STRLEN len;
73d840c0 3647 const char *t;
46fc3d4c
PP
3648
3649 if (tsv) {
3650 sv_2mortal(tsv);
3651 t = SvPVX(tsv);
3652 len = SvCUR(tsv);
3653 }
3654 else {
96827780
MB
3655 t = tmpbuf;
3656 len = strlen(tmpbuf);
46fc3d4c 3657 }
a0d0e21e 3658#ifdef FIXNEGATIVEZERO
46fc3d4c
PP
3659 if (len == 2 && t[0] == '-' && t[1] == '0') {
3660 t = "0";
3661 len = 1;
3662 }
a0d0e21e
LW
3663#endif
3664 (void)SvUPGRADE(sv, SVt_PV);
46fc3d4c 3665 *lp = len;
a0d0e21e
LW
3666 s = SvGROW(sv, len + 1);
3667 SvCUR_set(sv, len);
6bf554b4 3668 SvPOKp_on(sv);
e90e2364 3669 return strcpy(s, t);
a0d0e21e 3670 }
463ee0b2
LW
3671}
3672
645c22ef 3673/*
6050d10e
JP
3674=for apidoc sv_copypv
3675
3676Copies a stringified representation of the source SV into the
3677destination SV. Automatically performs any necessary mg_get and
54f0641b 3678coercion of numeric values into strings. Guaranteed to preserve
6050d10e 3679UTF-8 flag even from overloaded objects. Similar in nature to
54f0641b
NIS
3680sv_2pv[_flags] but operates directly on an SV instead of just the
3681string. Mostly uses sv_2pv_flags to do its work, except when that
6050d10e
JP
3682would lose the UTF-8'ness of the PV.
3683
3684=cut
3685*/
3686
3687void
3688Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3689{
446eaa42
YST
3690 STRLEN len;
3691 char *s;
3692 s = SvPV(ssv,len);
cb50f42d 3693 sv_setpvn(dsv,s,len);
446eaa42 3694 if (SvUTF8(ssv))
cb50f42d 3695 SvUTF8_on(dsv);
446eaa42 3696 else
cb50f42d 3697 SvUTF8_off(dsv);
6050d10e
JP
3698}
3699
3700/*
645c22ef
DM
3701=for apidoc sv_2pvbyte_nolen
3702
3703Return a pointer to the byte-encoded representation of the SV.
1e54db1a 3704May cause the SV to be downgraded from UTF-8 as a side-effect.
645c22ef
DM
3705
3706Usually accessed via the C<SvPVbyte_nolen> macro.
3707
3708=cut
3709*/
3710
7340a771
GS
3711char *
3712Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3713{
560a288e
GS
3714 STRLEN n_a;
3715 return sv_2pvbyte(sv, &n_a);
7340a771
GS
3716}
3717
645c22ef
DM
3718/*
3719=for apidoc sv_2pvbyte
3720
3721Return a pointer to the byte-encoded representation of the SV, and set *lp
1e54db1a 3722to its length. May cause the SV to be downgraded from UTF-8 as a
645c22ef
DM
3723side-effect.
3724
3725Usually accessed via the C<SvPVbyte> macro.
3726
3727=cut
3728*/
3729
7340a771
GS
3730char *
3731Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3732{
0875d2fe
NIS
3733 sv_utf8_downgrade(sv,0);
3734 return SvPV(sv,*lp);
7340a771
GS
3735}
3736
645c22ef
DM
3737/*
3738=for apidoc sv_2pvutf8_nolen
3739
1e54db1a
JH
3740Return a pointer to the UTF-8-encoded representation of the SV.
3741May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3742
3743Usually accessed via the C<SvPVutf8_nolen> macro.
3744
3745=cut
3746*/
3747
7340a771
GS
3748char *
3749Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3750{
560a288e
GS
3751 STRLEN n_a;
3752 return sv_2pvutf8(sv, &n_a);
7340a771
GS
3753}
3754
645c22ef
DM
3755/*
3756=for apidoc sv_2pvutf8
3757
1e54db1a
JH
3758Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3759to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3760
3761Usually accessed via the C<SvPVutf8> macro.
3762
3763=cut
3764*/
3765
7340a771
GS
3766char *
3767Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3768{
560a288e 3769 sv_utf8_upgrade(sv);
7d59b7e4 3770 return SvPV(sv,*lp);
7340a771 3771}
1c846c1f 3772
645c22ef
DM
3773/*
3774=for apidoc sv_2bool
3775
3776This function is only called on magical items, and is only used by
8cf8f3d1 3777sv_true() or its macro equivalent.
645c22ef
DM
3778
3779=cut
3780*/
3781
463ee0b2 3782bool
864dbfa3 3783Perl_sv_2bool(pTHX_ register SV *sv)
463ee0b2 3784{
8990e307 3785 if (SvGMAGICAL(sv))
463ee0b2
LW
3786 mg_get(sv);
3787
a0d0e21e
LW
3788 if (!SvOK(sv))
3789 return 0;
3790 if (SvROK(sv)) {
a0d0e21e 3791 SV* tmpsv;
1554e226 3792 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
9e3013b1 3793 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
8a31060d 3794 return (bool)SvTRUE(tmpsv);
a0d0e21e
LW
3795 return SvRV(sv) != 0;
3796 }
463ee0b2 3797 if (SvPOKp(sv)) {
11343788
MB
3798 register XPV* Xpvtmp;
3799 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
7b2c381c 3800 (*sv->sv_u.sv_pv > '0' ||
11343788 3801 Xpvtmp->xpv_cur > 1 ||
7b2c381c 3802 (Xpvtmp->xpv_cur && *sv->sv_u.sv_pv != '0')))
463ee0b2
LW
3803 return 1;
3804 else
3805 return 0;
3806 }
3807 else {
3808 if (SvIOKp(sv))
3809 return SvIVX(sv) != 0;
3810 else {
3811 if (SvNOKp(sv))
3812 return SvNVX(sv) != 0.0;
3813 else
3814 return FALSE;
3815 }
3816 }
79072805
LW
3817}
3818
09540bc3
JH
3819/* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3820 * this function provided for binary compatibility only
3821 */