sv.c

   1 /*    sv.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
   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  *
   9  * "I wonder what the Entish is for 'yes' and 'no'," he thought.
  10  *
  11  *
  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.
  18  */
  19
  20 #include "EXTERN.h"
  21 #define PERL_IN_SV_C
  22 #include "perl.h"
  23 #include "regcomp.h"
  24
  25 #define FCALL *f
  26
  27 #ifdef __Lynx__
  28 /* Missing proto on LynxOS */
  29   char *gconvert(double, int, int,  char *);
  30 #endif
  31
  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
  50 #ifdef PERL_COPY_ON_WRITE
  51 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
  52 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
  53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
  54    on-write.  */
  55 #endif
  56
  57 /* ============================================================================
  58
  59 =head1 Allocation and deallocation of SVs.
  60
  61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
  62 av, hv...) contains type and reference count information, as well as a
  63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
  64 specific to each type.
  65
  66 Normally, this allocation is done using arenas, which are approximately
  67 1K chunks of memory parcelled up into N heads or bodies. The first slot
  68 in each arena is reserved, and is used to hold a link to the next arena.
  69 In the case of heads, the unused first slot also contains some flags and
  70 a note of the number of slots.  Snaked through each arena chain is a
  71 linked list of free items; when this becomes empty, an extra arena is
  72 allocated and divided up into N items which are threaded into the free
  73 list.
  74
  75 The following global variables are associated with arenas:
  76
  77     PL_sv_arenaroot     pointer to list of SV arenas
  78     PL_sv_root          pointer to list of free SV structures
  79
  80     PL_foo_arenaroot    pointer to list of foo arenas,
  81     PL_foo_root         pointer to list of free foo bodies
  82                             ... for foo in xiv, xnv, xrv, xpv etc.
  83
  84 Note that some of the larger and more rarely used body types (eg xpvio)
  85 are not allocated using arenas, but are instead just malloc()/free()ed as
  86 required. Also, if PURIFY is defined, arenas are abandoned altogether,
  87 with all items individually malloc()ed. In addition, a few SV heads are
  88 not allocated from an arena, but are instead directly created as static
  89 or auto variables, eg PL_sv_undef.
  90
  91 The SV arena serves the secondary purpose of allowing still-live SVs
  92 to be located and destroyed during final cleanup.
  93
  94 At the lowest level, the macros new_SV() and del_SV() grab and free
  95 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
  96 to return the SV to the free list with error checking.) new_SV() calls
  97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
  98 SVs in the free list have their SvTYPE field set to all ones.
  99
 100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
 101 that allocate and return individual body types. Normally these are mapped
 102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
 103 instead mapped directly to malloc()/free() if PURIFY is defined. The
 104 new/del functions remove from, or add to, the appropriate PL_foo_root
 105 list, and call more_xiv() etc to add a new arena if the list is empty.
 106
 107 At the time of very final cleanup, sv_free_arenas() is called from
 108 perl_destruct() to physically free all the arenas allocated since the
 109 start of the interpreter.  Note that this also clears PL_he_arenaroot,
 110 which is otherwise dealt with in hv.c.
 111
 112 Manipulation of any of the PL_*root pointers is protected by enclosing
 113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
 114 if threads are enabled.
 115
 116 The function visit() scans the SV arenas list, and calls a specified
 117 function for each SV it finds which is still live - ie which has an SvTYPE
 118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
 119 following functions (specified as [function that calls visit()] / [function
 120 called 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
 145 Private 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
 153 Public API:
 154
 155     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
 156
 157
 158 =cut
 159
 160 ============================================================================ */
 161
 162
 163
 164 /*
 165  * "A time to plant, and a time to uproot what was planted..."
 166  */
 167
 168 #ifdef DEBUG_LEAKING_SCALARS
 169 #  ifdef NETWARE
 170 #    define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
 171 #  else
 172 #    define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
 173 #  endif
 174 #else
 175 #  define FREE_SV_DEBUG_FILE(sv)
 176 #endif
 177
 178 #define plant_SV(p) \
 179     STMT_START {                                        \
 180         FREE_SV_DEBUG_FILE(p);                          \
 181         SvANY(p) = (void *)PL_sv_root;                  \
 182         SvFLAGS(p) = SVTYPEMASK;                        \
 183         PL_sv_root = (p);                               \
 184         --PL_sv_count;                                  \
 185     } STMT_END
 186
 187 /* sv_mutex must be held while calling uproot_SV() */
 188 #define uproot_SV(p) \
 189     STMT_START {                                        \
 190         (p) = PL_sv_root;                               \
 191         PL_sv_root = (SV*)SvANY(p);                     \
 192         ++PL_sv_count;                                  \
 193     } STMT_END
 194
 195
 196 /* new_SV(): return a new, empty SV head */
 197
 198 #ifdef DEBUG_LEAKING_SCALARS
 199 /* provide a real function for a debugger to play with */
 200 STATIC SV*
 201 S_new_SV(pTHX)
 202 {
 203     SV* sv;
 204
 205     LOCK_SV_MUTEX;
 206     if (PL_sv_root)
 207         uproot_SV(sv);
 208     else
 209         sv = more_sv();
 210     UNLOCK_SV_MUTEX;
 211     SvANY(sv) = 0;
 212     SvREFCNT(sv) = 1;
 213     SvFLAGS(sv) = 0;
 214     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
 215     sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
 216         (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
 217     sv->sv_debug_inpad = 0;
 218     sv->sv_debug_cloned = 0;
 219 #  ifdef NETWARE
 220     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
 221 #  else
 222     sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
 223 #  endif
 224
 225     return sv;
 226 }
 227 #  define new_SV(p) (p)=S_new_SV(aTHX)
 228
 229 #else
 230 #  define new_SV(p) \
 231     STMT_START {                                        \
 232         LOCK_SV_MUTEX;                                  \
 233         if (PL_sv_root)                                 \
 234             uproot_SV(p);                               \
 235         else                                            \
 236             (p) = more_sv();                            \
 237         UNLOCK_SV_MUTEX;                                \
 238         SvANY(p) = 0;                                   \
 239         SvREFCNT(p) = 1;                                \
 240         SvFLAGS(p) = 0;                                 \
 241     } STMT_END
 242 #endif
 243
 244
 245 /* del_SV(): return an empty SV head to the free list */
 246
 247 #ifdef DEBUGGING
 248
 249 #define del_SV(p) \
 250     STMT_START {                                        \
 251         LOCK_SV_MUTEX;                                  \
 252         if (DEBUG_D_TEST)                               \
 253             del_sv(p);                                  \
 254         else                                            \
 255             plant_SV(p);                                \
 256         UNLOCK_SV_MUTEX;                                \
 257     } STMT_END
 258
 259 STATIC void
 260 S_del_sv(pTHX_ SV *p)
 261 {
 262     if (DEBUG_D_TEST) {
 263         SV* sva;
 264         SV* sv;
 265         SV* svend;
 266         int ok = 0;
 267         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
 268             sv = sva + 1;
 269             svend = &sva[SvREFCNT(sva)];
 270             if (p >= sv && p < svend)
 271                 ok = 1;
 272         }
 273         if (!ok) {
 274             if (ckWARN_d(WARN_INTERNAL))
 275                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
 276                             "Attempt to free non-arena SV: 0x%"UVxf
 277                             pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
 278             return;
 279         }
 280     }
 281     plant_SV(p);
 282 }
 283
 284 #else /* ! DEBUGGING */
 285
 286 #define del_SV(p)   plant_SV(p)
 287
 288 #endif /* DEBUGGING */
 289
 290
 291 /*
 292 =head1 SV Manipulation Functions
 293
 294 =for apidoc sv_add_arena
 295
 296 Given a chunk of memory, link it to the head of the list of arenas,
 297 and split it into a list of free SVs.
 298
 299 =cut
 300 */
 301
 302 void
 303 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
 304 {
 305     SV* sva = (SV*)ptr;
 306     register SV* sv;
 307     register SV* svend;
 308
 309     /* The first SV in an arena isn't an SV. */
 310     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
 311     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
 312     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
 313
 314     PL_sv_arenaroot = sva;
 315     PL_sv_root = sva + 1;
 316
 317     svend = &sva[SvREFCNT(sva) - 1];
 318     sv = sva + 1;
 319     while (sv < svend) {
 320         SvANY(sv) = (void *)(SV*)(sv + 1);
 321         SvREFCNT(sv) = 0;
 322         SvFLAGS(sv) = SVTYPEMASK;
 323         sv++;
 324     }
 325     SvANY(sv) = 0;
 326     SvFLAGS(sv) = SVTYPEMASK;
 327 }
 328
 329 /* make some more SVs by adding another arena */
 330
 331 /* sv_mutex must be held while calling more_sv() */
 332 STATIC SV*
 333 S_more_sv(pTHX)
 334 {
 335     register SV* sv;
 336
 337     if (PL_nice_chunk) {
 338         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
 339         PL_nice_chunk = Nullch;
 340         PL_nice_chunk_size = 0;
 341     }
 342     else {
 343         char *chunk;                /* must use New here to match call to */
 344         New(704,chunk,1008,char);   /* Safefree() in sv_free_arenas()     */
 345         sv_add_arena(chunk, 1008, 0);
 346     }
 347     uproot_SV(sv);
 348     return sv;
 349 }
 350
 351 /* visit(): call the named function for each non-free SV in the arenas
 352  * whose flags field matches the flags/mask args. */
 353
 354 STATIC I32
 355 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
 356 {
 357     SV* sva;
 358     SV* sv;
 359     register SV* svend;
 360     I32 visited = 0;
 361
 362     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
 363         svend = &sva[SvREFCNT(sva)];
 364         for (sv = sva + 1; sv < svend; ++sv) {
 365             if (SvTYPE(sv) != SVTYPEMASK
 366                     && (sv->sv_flags & mask) == flags
 367                     && SvREFCNT(sv))
 368             {
 369                 (FCALL)(aTHX_ sv);
 370                 ++visited;
 371             }
 372         }
 373     }
 374     return visited;
 375 }
 376
 377 #ifdef DEBUGGING
 378
 379 /* called by sv_report_used() for each live SV */
 380
 381 static void
 382 do_report_used(pTHX_ SV *sv)
 383 {
 384     if (SvTYPE(sv) != SVTYPEMASK) {
 385         PerlIO_printf(Perl_debug_log, "****\n");
 386         sv_dump(sv);
 387     }
 388 }
 389 #endif
 390
 391 /*
 392 =for apidoc sv_report_used
 393
 394 Dump the contents of all SVs not yet freed. (Debugging aid).
 395
 396 =cut
 397 */
 398
 399 void
 400 Perl_sv_report_used(pTHX)
 401 {
 402 #ifdef DEBUGGING
 403     visit(do_report_used, 0, 0);
 404 #endif
 405 }
 406
 407 /* called by sv_clean_objs() for each live SV */
 408
 409 static void
 410 do_clean_objs(pTHX_ SV *sv)
 411 {
 412     SV* rv;
 413
 414     if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
 415         DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
 416         if (SvWEAKREF(sv)) {
 417             sv_del_backref(sv);
 418             SvWEAKREF_off(sv);
 419             SvRV_set(sv, NULL);
 420         } else {
 421             SvROK_off(sv);
 422             SvRV_set(sv, NULL);
 423             SvREFCNT_dec(rv);
 424         }
 425     }
 426
 427     /* XXX Might want to check arrays, etc. */
 428 }
 429
 430 /* called by sv_clean_objs() for each live SV */
 431
 432 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 433 static void
 434 do_clean_named_objs(pTHX_ SV *sv)
 435 {
 436     if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
 437         if ( SvOBJECT(GvSV(sv)) ||
 438              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
 439              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
 440              (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
 441              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
 442         {
 443             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
 444             SvFLAGS(sv) |= SVf_BREAK;
 445             SvREFCNT_dec(sv);
 446         }
 447     }
 448 }
 449 #endif
 450
 451 /*
 452 =for apidoc sv_clean_objs
 453
 454 Attempt to destroy all objects not yet freed
 455
 456 =cut
 457 */
 458
 459 void
 460 Perl_sv_clean_objs(pTHX)
 461 {
 462     PL_in_clean_objs = TRUE;
 463     visit(do_clean_objs, SVf_ROK, SVf_ROK);
 464 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 465     /* some barnacles may yet remain, clinging to typeglobs */
 466     visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
 467 #endif
 468     PL_in_clean_objs = FALSE;
 469 }
 470
 471 /* called by sv_clean_all() for each live SV */
 472
 473 static void
 474 do_clean_all(pTHX_ SV *sv)
 475 {
 476     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
 477     SvFLAGS(sv) |= SVf_BREAK;
 478     if (PL_comppad == (AV*)sv) {
 479         PL_comppad = Nullav;
 480         PL_curpad = Null(SV**);
 481     }
 482     SvREFCNT_dec(sv);
 483 }
 484
 485 /*
 486 =for apidoc sv_clean_all
 487
 488 Decrement the refcnt of each remaining SV, possibly triggering a
 489 cleanup. This function may have to be called multiple times to free
 490 SVs which are in complex self-referential hierarchies.
 491
 492 =cut
 493 */
 494
 495 I32
 496 Perl_sv_clean_all(pTHX)
 497 {
 498     I32 cleaned;
 499     PL_in_clean_all = TRUE;
 500     cleaned = visit(do_clean_all, 0,0);
 501     PL_in_clean_all = FALSE;
 502     return cleaned;
 503 }
 504
 505 /*
 506 =for apidoc sv_free_arenas
 507
 508 Deallocate the memory used by all arenas. Note that all the individual SV
 509 heads and bodies within the arenas must already have been freed.
 510
 511 =cut
 512 */
 513
 514 void
 515 Perl_sv_free_arenas(pTHX)
 516 {
 517     SV* sva;
 518     SV* svanext;
 519     XPV *arena, *arenanext;
 520
 521     /* Free arenas here, but be careful about fake ones.  (We assume
 522        contiguity of the fake ones with the corresponding real ones.) */
 523
 524     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
 525         svanext = (SV*) SvANY(sva);
 526         while (svanext && SvFAKE(svanext))
 527             svanext = (SV*) SvANY(svanext);
 528
 529         if (!SvFAKE(sva))
 530             Safefree((void *)sva);
 531     }
 532
 533     for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
 534         arenanext = (XPV*)arena->xpv_pv;
 535         Safefree(arena);
 536     }
 537     PL_xiv_arenaroot = 0;
 538     PL_xiv_root = 0;
 539
 540     for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
 541         arenanext = (XPV*)arena->xpv_pv;
 542         Safefree(arena);
 543     }
 544     PL_xnv_arenaroot = 0;
 545     PL_xnv_root = 0;
 546
 547     for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
 548         arenanext = (XPV*)arena->xpv_pv;
 549         Safefree(arena);
 550     }
 551     PL_xrv_arenaroot = 0;
 552     PL_xrv_root = 0;
 553
 554     for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
 555         arenanext = (XPV*)arena->xpv_pv;
 556         Safefree(arena);
 557     }
 558     PL_xpv_arenaroot = 0;
 559     PL_xpv_root = 0;
 560
 561     for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
 562         arenanext = (XPV*)arena->xpv_pv;
 563         Safefree(arena);
 564     }
 565     PL_xpviv_arenaroot = 0;
 566     PL_xpviv_root = 0;
 567
 568     for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
 569         arenanext = (XPV*)arena->xpv_pv;
 570         Safefree(arena);
 571     }
 572     PL_xpvnv_arenaroot = 0;
 573     PL_xpvnv_root = 0;
 574
 575     for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
 576         arenanext = (XPV*)arena->xpv_pv;
 577         Safefree(arena);
 578     }
 579     PL_xpvcv_arenaroot = 0;
 580     PL_xpvcv_root = 0;
 581
 582     for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
 583         arenanext = (XPV*)arena->xpv_pv;
 584         Safefree(arena);
 585     }
 586     PL_xpvav_arenaroot = 0;
 587     PL_xpvav_root = 0;
 588
 589     for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
 590         arenanext = (XPV*)arena->xpv_pv;
 591         Safefree(arena);
 592     }
 593     PL_xpvhv_arenaroot = 0;
 594     PL_xpvhv_root = 0;
 595
 596     for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
 597         arenanext = (XPV*)arena->xpv_pv;
 598         Safefree(arena);
 599     }
 600     PL_xpvmg_arenaroot = 0;
 601     PL_xpvmg_root = 0;
 602
 603     for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
 604         arenanext = (XPV*)arena->xpv_pv;
 605         Safefree(arena);
 606     }
 607     PL_xpvlv_arenaroot = 0;
 608     PL_xpvlv_root = 0;
 609
 610     for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
 611         arenanext = (XPV*)arena->xpv_pv;
 612         Safefree(arena);
 613     }
 614     PL_xpvbm_arenaroot = 0;
 615     PL_xpvbm_root = 0;
 616
 617     for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
 618         arenanext = (XPV*)arena->xpv_pv;
 619         Safefree(arena);
 620     }
 621     PL_he_arenaroot = 0;
 622     PL_he_root = 0;
 623
 624     if (PL_nice_chunk)
 625         Safefree(PL_nice_chunk);
 626     PL_nice_chunk = Nullch;
 627     PL_nice_chunk_size = 0;
 628     PL_sv_arenaroot = 0;
 629     PL_sv_root = 0;
 630 }
 631
 632 /* ---------------------------------------------------------------------
 633  *
 634  * support functions for report_uninit()
 635  */
 636
 637 /* the maxiumum size of array or hash where we will scan looking
 638  * for the undefined element that triggered the warning */
 639
 640 #define FUV_MAX_SEARCH_SIZE 1000
 641
 642 /* Look for an entry in the hash whose value has the same SV as val;
 643  * If so, return a mortal copy of the key. */
 644
 645 STATIC SV*
 646 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
 647 {
 648     dVAR;
 649     register HE **array;
 650     register HE *entry;
 651     I32 i;
 652
 653     if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
 654                         (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
 655         return Nullsv;
 656
 657     array = HvARRAY(hv);
 658
 659     for (i=HvMAX(hv); i>0; i--) {
 660         for (entry = array[i]; entry; entry = HeNEXT(entry)) {
 661             if (HeVAL(entry) != val)
 662                 continue;
 663             if (    HeVAL(entry) == &PL_sv_undef ||
 664                     HeVAL(entry) == &PL_sv_placeholder)
 665                 continue;
 666             if (!HeKEY(entry))
 667                 return Nullsv;
 668             if (HeKLEN(entry) == HEf_SVKEY)
 669                 return sv_mortalcopy(HeKEY_sv(entry));
 670             return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
 671         }
 672     }
 673     return Nullsv;
 674 }
 675
 676 /* Look for an entry in the array whose value has the same SV as val;
 677  * If so, return the index, otherwise return -1. */
 678
 679 STATIC I32
 680 S_find_array_subscript(pTHX_ AV *av, SV* val)
 681 {
 682     SV** svp;
 683     I32 i;
 684     if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
 685                         (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
 686         return -1;
 687
 688     svp = AvARRAY(av);
 689     for (i=AvFILLp(av); i>=0; i--) {
 690         if (svp[i] == val && svp[i] != &PL_sv_undef)
 691             return i;
 692     }
 693     return -1;
 694 }
 695
 696 /* S_varname(): return the name of a variable, optionally with a subscript.
 697  * If gv is non-zero, use the name of that global, along with gvtype (one
 698  * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
 699  * targ.  Depending on the value of the subscript_type flag, return:
 700  */
 701
 702 #define FUV_SUBSCRIPT_NONE      1       /* "@foo"          */
 703 #define FUV_SUBSCRIPT_ARRAY     2       /* "$foo[aindex]"  */
 704 #define FUV_SUBSCRIPT_HASH      3       /* "$foo{keyname}" */
 705 #define FUV_SUBSCRIPT_WITHIN    4       /* "within @foo"   */
 706
 707 STATIC SV*
 708 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
 709         SV* keyname, I32 aindex, int subscript_type)
 710 {
 711     AV *av;
 712
 713     SV *sv, *name;
 714
 715     name = sv_newmortal();
 716     if (gv) {
 717
 718         /* simulate gv_fullname4(), but add literal '^' for $^FOO names
 719          * XXX get rid of all this if gv_fullnameX() ever supports this
 720          * directly */
 721
 722         const char *p;
 723         HV *hv = GvSTASH(gv);
 724         sv_setpv(name, gvtype);
 725         if (!hv)
 726             p = "???";
 727         else if (!(p=HvNAME(hv)))
 728             p = "__ANON__";
 729         if (strNE(p, "main")) {
 730             sv_catpv(name,p);
 731             sv_catpvn(name,"::", 2);
 732         }
 733         if (GvNAMELEN(gv)>= 1 &&
 734             ((unsigned int)*GvNAME(gv)) <= 26)
 735         { /* handle $^FOO */
 736             Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
 737             sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
 738         }
 739         else
 740             sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
 741     }
 742     else {
 743         U32 u;
 744         CV *cv = find_runcv(&u);
 745         if (!cv || !CvPADLIST(cv))
 746             return Nullsv;;
 747         av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
 748         sv = *av_fetch(av, targ, FALSE);
 749         /* SvLEN in a pad name is not to be trusted */
 750         sv_setpv(name, SvPV_nolen(sv));
 751     }
 752
 753     if (subscript_type == FUV_SUBSCRIPT_HASH) {
 754         *SvPVX(name) = '$';
 755         sv = NEWSV(0,0);
 756         Perl_sv_catpvf(aTHX_ name, "{%s}",
 757             pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
 758         SvREFCNT_dec(sv);
 759     }
 760     else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
 761         *SvPVX(name) = '$';
 762         Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
 763     }
 764     else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
 765         sv_insert(name, 0, 0,  "within ", 7);
 766
 767     return name;
 768 }
 769
 770
 771 /*
 772 =for apidoc find_uninit_var
 773
 774 Find the name of the undefined variable (if any) that caused the operator o
 775 to issue a "Use of uninitialized value" warning.
 776 If match is true, only return a name if it's value matches uninit_sv.
 777 So roughly speaking, if a unary operator (such as OP_COS) generates a
 778 warning, then following the direct child of the op may yield an
 779 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
 780 other hand, with OP_ADD there are two branches to follow, so we only print
 781 the variable name if we get an exact match.
 782
 783 The name is returned as a mortal SV.
 784
 785 Assumes that PL_op is the op that originally triggered the error, and that
 786 PL_comppad/PL_curpad points to the currently executing pad.
 787
 788 =cut
 789 */
 790
 791 STATIC SV *
 792 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
 793 {
 794     dVAR;
 795     SV *sv;
 796     AV *av;
 797     SV **svp;
 798     GV *gv;
 799     OP *o, *o2, *kid;
 800
 801     if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
 802                             uninit_sv == &PL_sv_placeholder)))
 803         return Nullsv;
 804
 805     switch (obase->op_type) {
 806
 807     case OP_RV2AV:
 808     case OP_RV2HV:
 809     case OP_PADAV:
 810     case OP_PADHV:
 811       {
 812         bool pad  = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
 813         bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
 814         I32 index = 0;
 815         SV *keysv = Nullsv;
 816         int subscript_type = FUV_SUBSCRIPT_WITHIN;
 817
 818         if (pad) { /* @lex, %lex */
 819             sv = PAD_SVl(obase->op_targ);
 820             gv = Nullgv;
 821         }
 822         else {
 823             if (cUNOPx(obase)->op_first->op_type == OP_GV) {
 824             /* @global, %global */
 825                 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
 826                 if (!gv)
 827                     break;
 828                 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
 829             }
 830             else /* @{expr}, %{expr} */
 831                 return find_uninit_var(cUNOPx(obase)->op_first,
 832                                                     uninit_sv, match);
 833         }
 834
 835         /* attempt to find a match within the aggregate */
 836         if (hash) {
 837             keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
 838             if (keysv)
 839                 subscript_type = FUV_SUBSCRIPT_HASH;
 840         }
 841         else {
 842             index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
 843             if (index >= 0)
 844                 subscript_type = FUV_SUBSCRIPT_ARRAY;
 845         }
 846
 847         if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
 848             break;
 849
 850         return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
 851                                     keysv, index, subscript_type);
 852       }
 853
 854     case OP_PADSV:
 855         if (match && PAD_SVl(obase->op_targ) != uninit_sv)
 856             break;
 857         return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
 858                                     Nullsv, 0, FUV_SUBSCRIPT_NONE);
 859
 860     case OP_GVSV:
 861         gv = cGVOPx_gv(obase);
 862         if (!gv || (match && GvSV(gv) != uninit_sv))
 863             break;
 864         return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
 865
 866     case OP_AELEMFAST:
 867         if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
 868             if (match) {
 869                 av = (AV*)PAD_SV(obase->op_targ);
 870                 if (!av || SvRMAGICAL(av))
 871                     break;
 872                 svp = av_fetch(av, (I32)obase->op_private, FALSE);
 873                 if (!svp || *svp != uninit_sv)
 874                     break;
 875             }
 876             return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
 877                     Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
 878         }
 879         else {
 880             gv = cGVOPx_gv(obase);
 881             if (!gv)
 882                 break;
 883             if (match) {
 884                 av = GvAV(gv);
 885                 if (!av || SvRMAGICAL(av))
 886                     break;
 887                 svp = av_fetch(av, (I32)obase->op_private, FALSE);
 888                 if (!svp || *svp != uninit_sv)
 889                     break;
 890             }
 891             return S_varname(aTHX_ gv, "$", 0,
 892                     Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
 893         }
 894         break;
 895
 896     case OP_EXISTS:
 897         o = cUNOPx(obase)->op_first;
 898         if (!o || o->op_type != OP_NULL ||
 899                 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
 900             break;
 901         return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
 902
 903     case OP_AELEM:
 904     case OP_HELEM:
 905         if (PL_op == obase)
 906             /* $a[uninit_expr] or $h{uninit_expr} */
 907             return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
 908
 909         gv = Nullgv;
 910         o = cBINOPx(obase)->op_first;
 911         kid = cBINOPx(obase)->op_last;
 912
 913         /* get the av or hv, and optionally the gv */
 914         sv = Nullsv;
 915         if  (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
 916             sv = PAD_SV(o->op_targ);
 917         }
 918         else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
 919                 && cUNOPo->op_first->op_type == OP_GV)
 920         {
 921             gv = cGVOPx_gv(cUNOPo->op_first);
 922             if (!gv)
 923                 break;
 924             sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
 925         }
 926         if (!sv)
 927             break;
 928
 929         if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
 930             /* index is constant */
 931             if (match) {
 932                 if (SvMAGICAL(sv))
 933                     break;
 934                 if (obase->op_type == OP_HELEM) {
 935                     HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
 936                     if (!he || HeVAL(he) != uninit_sv)
 937                         break;
 938                 }
 939                 else {
 940                     svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
 941                     if (!svp || *svp != uninit_sv)
 942                         break;
 943                 }
 944             }
 945             if (obase->op_type == OP_HELEM)
 946                 return S_varname(aTHX_ gv, "%", o->op_targ,
 947                             cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
 948             else
 949                 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
 950                             SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
 951             ;
 952         }
 953         else  {
 954             /* index is an expression;
 955              * attempt to find a match within the aggregate */
 956             if (obase->op_type == OP_HELEM) {
 957                 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
 958                 if (keysv)
 959                     return S_varname(aTHX_ gv, "%", o->op_targ,
 960                                                 keysv, 0, FUV_SUBSCRIPT_HASH);
 961             }
 962             else {
 963                 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
 964                 if (index >= 0)
 965                 return S_varname(aTHX_ gv, "@", o->op_targ,
 966                                         Nullsv, index, FUV_SUBSCRIPT_ARRAY);
 967             }
 968             if (match)
 969                 break;
 970             return S_varname(aTHX_ gv,
 971                 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
 972                 ? "@" : "%",
 973                 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
 974         }
 975
 976         break;
 977
 978     case OP_AASSIGN:
 979         /* only examine RHS */
 980         return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
 981
 982     case OP_OPEN:
 983         o = cUNOPx(obase)->op_first;
 984         if (o->op_type == OP_PUSHMARK)
 985             o = o->op_sibling;
 986
 987         if (!o->op_sibling) {
 988             /* one-arg version of open is highly magical */
 989
 990             if (o->op_type == OP_GV) { /* open FOO; */
 991                 gv = cGVOPx_gv(o);
 992                 if (match && GvSV(gv) != uninit_sv)
 993                     break;
 994                 return S_varname(aTHX_ gv, "$", 0,
 995                             Nullsv, 0, FUV_SUBSCRIPT_NONE);
 996             }
 997             /* other possibilities not handled are:
 998              * open $x; or open my $x;  should return '${*$x}'
 999              * open expr;               should return '$'.expr ideally
1000              */
1001              break;
1002         }
1003         goto do_op;
1004
1005     /* ops where $_ may be an implicit arg */
1006     case OP_TRANS:
1007     case OP_SUBST:
1008     case OP_MATCH:
1009         if ( !(obase->op_flags & OPf_STACKED)) {
1010             if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1011                                  ? PAD_SVl(obase->op_targ)
1012                                  : DEFSV))
1013             {
1014                 sv = sv_newmortal();
1015                 sv_setpv(sv, "$_");
1016                 return sv;
1017             }
1018         }
1019         goto do_op;
1020
1021     case OP_PRTF:
1022     case OP_PRINT:
1023         /* skip filehandle as it can't produce 'undef' warning  */
1024         o = cUNOPx(obase)->op_first;
1025         if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1026             o = o->op_sibling->op_sibling;
1027         goto do_op2;
1028
1029
1030     case OP_RV2SV:
1031     case OP_CUSTOM:
1032     case OP_ENTERSUB:
1033         match = 1; /* XS or custom code could trigger random warnings */
1034         goto do_op;
1035
1036     case OP_SCHOMP:
1037     case OP_CHOMP:
1038         if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1039             return sv_2mortal(newSVpv("${$/}", 0));
1040         /* FALL THROUGH */
1041
1042     default:
1043     do_op:
1044         if (!(obase->op_flags & OPf_KIDS))
1045             break;
1046         o = cUNOPx(obase)->op_first;
1047
1048     do_op2:
1049         if (!o)
1050             break;
1051
1052         /* if all except one arg are constant, or have no side-effects,
1053          * or are optimized away, then it's unambiguous */
1054         o2 = Nullop;
1055         for (kid=o; kid; kid = kid->op_sibling) {
1056             if (kid &&
1057                 (    (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1058                   || (kid->op_type == OP_NULL  && ! (kid->op_flags & OPf_KIDS))
1059                   || (kid->op_type == OP_PUSHMARK)
1060                 )
1061             )
1062                 continue;
1063             if (o2) { /* more than one found */
1064                 o2 = Nullop;
1065                 break;
1066             }
1067             o2 = kid;
1068         }
1069         if (o2)
1070             return find_uninit_var(o2, uninit_sv, match);
1071
1072         /* scan all args */
1073         while (o) {
1074             sv = find_uninit_var(o, uninit_sv, 1);
1075             if (sv)
1076                 return sv;
1077             o = o->op_sibling;
1078         }
1079         break;
1080     }
1081     return Nullsv;
1082 }
1083
1084
1085 /*
1086 =for apidoc report_uninit
1087
1088 Print appropriate "Use of uninitialized variable" warning
1089
1090 =cut
1091 */
1092
1093 void
1094 Perl_report_uninit(pTHX_ SV* uninit_sv)
1095 {
1096     if (PL_op) {
1097         SV* varname = Nullsv;
1098         if (uninit_sv) {
1099             varname = find_uninit_var(PL_op, uninit_sv,0);
1100             if (varname)
1101                 sv_insert(varname, 0, 0, " ", 1);
1102         }
1103         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1104                 varname ? SvPV_nolen(varname) : "",
1105                 " in ", OP_DESC(PL_op));
1106     }
1107     else
1108         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1109                     "", "", "");
1110 }
1111
1112 /* grab a new IV body from the free list, allocating more if necessary */
1113
1114 STATIC XPVIV*
1115 S_new_xiv(pTHX)
1116 {
1117     IV* xiv;
1118     LOCK_SV_MUTEX;
1119     if (!PL_xiv_root)
1120         more_xiv();
1121     xiv = PL_xiv_root;
1122     /*
1123      * See comment in more_xiv() -- RAM.
1124      */
1125     PL_xiv_root = *(IV**)xiv;
1126     UNLOCK_SV_MUTEX;
1127     return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
1128 }
1129
1130 /* return an IV body to the free list */
1131
1132 STATIC void
1133 S_del_xiv(pTHX_ XPVIV *p)
1134 {
1135     IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
1136     LOCK_SV_MUTEX;
1137     *(IV**)xiv = PL_xiv_root;
1138     PL_xiv_root = xiv;
1139     UNLOCK_SV_MUTEX;
1140 }
1141
1142 /* allocate another arena's worth of IV bodies */
1143
1144 STATIC void
1145 S_more_xiv(pTHX)
1146 {
1147     register IV* xiv;
1148     register IV* xivend;
1149     XPV* ptr;
1150     New(705, ptr, 1008/sizeof(XPV), XPV);
1151     ptr->xpv_pv = (char*)PL_xiv_arenaroot;      /* linked list of xiv arenas */
1152     PL_xiv_arenaroot = ptr;                     /* to keep Purify happy */
1153
1154     xiv = (IV*) ptr;
1155     xivend = &xiv[1008 / sizeof(IV) - 1];
1156     xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1;  /* fudge by size of XPV */
1157     PL_xiv_root = xiv;
1158     while (xiv < xivend) {
1159         *(IV**)xiv = (IV *)(xiv + 1);
1160         xiv++;
1161     }
1162     *(IV**)xiv = 0;
1163 }
1164
1165 /* grab a new NV body from the free list, allocating more if necessary */
1166
1167 STATIC XPVNV*
1168 S_new_xnv(pTHX)
1169 {
1170     NV* xnv;
1171     LOCK_SV_MUTEX;
1172     if (!PL_xnv_root)
1173         more_xnv();
1174     xnv = PL_xnv_root;
1175     PL_xnv_root = *(NV**)xnv;
1176     UNLOCK_SV_MUTEX;
1177     return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1178 }
1179
1180 /* return an NV body to the free list */
1181
1182 STATIC void
1183 S_del_xnv(pTHX_ XPVNV *p)
1184 {
1185     NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1186     LOCK_SV_MUTEX;
1187     *(NV**)xnv = PL_xnv_root;
1188     PL_xnv_root = xnv;
1189     UNLOCK_SV_MUTEX;
1190 }
1191
1192 /* allocate another arena's worth of NV bodies */
1193
1194 STATIC void
1195 S_more_xnv(pTHX)
1196 {
1197     register NV* xnv;
1198     register NV* xnvend;
1199     XPV *ptr;
1200     New(711, ptr, 1008/sizeof(XPV), XPV);
1201     ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1202     PL_xnv_arenaroot = ptr;
1203
1204     xnv = (NV*) ptr;
1205     xnvend = &xnv[1008 / sizeof(NV) - 1];
1206     xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1207     PL_xnv_root = xnv;
1208     while (xnv < xnvend) {
1209         *(NV**)xnv = (NV*)(xnv + 1);
1210         xnv++;
1211     }
1212     *(NV**)xnv = 0;
1213 }
1214
1215 /* grab a new struct xrv from the free list, allocating more if necessary */
1216
1217 STATIC XRV*
1218 S_new_xrv(pTHX)
1219 {
1220     XRV* xrv;
1221     LOCK_SV_MUTEX;
1222     if (!PL_xrv_root)
1223         more_xrv();
1224     xrv = PL_xrv_root;
1225     PL_xrv_root = (XRV*)xrv->xrv_rv;
1226     UNLOCK_SV_MUTEX;
1227     return xrv;
1228 }
1229
1230 /* return a struct xrv to the free list */
1231
1232 STATIC void
1233 S_del_xrv(pTHX_ XRV *p)
1234 {
1235     LOCK_SV_MUTEX;
1236     p->xrv_rv = (SV*)PL_xrv_root;
1237     PL_xrv_root = p;
1238     UNLOCK_SV_MUTEX;
1239 }
1240
1241 /* allocate another arena's worth of struct xrv */
1242
1243 STATIC void
1244 S_more_xrv(pTHX)
1245 {
1246     register XRV* xrv;
1247     register XRV* xrvend;
1248     XPV *ptr;
1249     New(712, ptr, 1008/sizeof(XPV), XPV);
1250     ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1251     PL_xrv_arenaroot = ptr;
1252
1253     xrv = (XRV*) ptr;
1254     xrvend = &xrv[1008 / sizeof(XRV) - 1];
1255     xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1256     PL_xrv_root = xrv;
1257     while (xrv < xrvend) {
1258         xrv->xrv_rv = (SV*)(xrv + 1);
1259         xrv++;
1260     }
1261     xrv->xrv_rv = 0;
1262 }
1263
1264 /* grab a new struct xpv from the free list, allocating more if necessary */
1265
1266 STATIC XPV*
1267 S_new_xpv(pTHX)
1268 {
1269     XPV* xpv;
1270     LOCK_SV_MUTEX;
1271     if (!PL_xpv_root)
1272         more_xpv();
1273     xpv = PL_xpv_root;
1274     PL_xpv_root = (XPV*)xpv->xpv_pv;
1275     UNLOCK_SV_MUTEX;
1276     return xpv;
1277 }
1278
1279 /* return a struct xpv to the free list */
1280
1281 STATIC void
1282 S_del_xpv(pTHX_ XPV *p)
1283 {
1284     LOCK_SV_MUTEX;
1285     p->xpv_pv = (char*)PL_xpv_root;
1286     PL_xpv_root = p;
1287     UNLOCK_SV_MUTEX;
1288 }
1289
1290 /* allocate another arena's worth of struct xpv */
1291
1292 STATIC void
1293 S_more_xpv(pTHX)
1294 {
1295     register XPV* xpv;
1296     register XPV* xpvend;
1297     New(713, xpv, 1008/sizeof(XPV), XPV);
1298     xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1299     PL_xpv_arenaroot = xpv;
1300
1301     xpvend = &xpv[1008 / sizeof(XPV) - 1];
1302     PL_xpv_root = ++xpv;
1303     while (xpv < xpvend) {
1304         xpv->xpv_pv = (char*)(xpv + 1);
1305         xpv++;
1306     }
1307     xpv->xpv_pv = 0;
1308 }
1309
1310 /* grab a new struct xpviv from the free list, allocating more if necessary */
1311
1312 STATIC XPVIV*
1313 S_new_xpviv(pTHX)
1314 {
1315     XPVIV* xpviv;
1316     LOCK_SV_MUTEX;
1317     if (!PL_xpviv_root)
1318         more_xpviv();
1319     xpviv = PL_xpviv_root;
1320     PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1321     UNLOCK_SV_MUTEX;
1322     return xpviv;
1323 }
1324
1325 /* return a struct xpviv to the free list */
1326
1327 STATIC void
1328 S_del_xpviv(pTHX_ XPVIV *p)
1329 {
1330     LOCK_SV_MUTEX;
1331     p->xpv_pv = (char*)PL_xpviv_root;
1332     PL_xpviv_root = p;
1333     UNLOCK_SV_MUTEX;
1334 }
1335
1336 /* allocate another arena's worth of struct xpviv */
1337
1338 STATIC void
1339 S_more_xpviv(pTHX)
1340 {
1341     register XPVIV* xpviv;
1342     register XPVIV* xpvivend;
1343     New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
1344     xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1345     PL_xpviv_arenaroot = xpviv;
1346
1347     xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
1348     PL_xpviv_root = ++xpviv;
1349     while (xpviv < xpvivend) {
1350         xpviv->xpv_pv = (char*)(xpviv + 1);
1351         xpviv++;
1352     }
1353     xpviv->xpv_pv = 0;
1354 }
1355
1356 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1357
1358 STATIC XPVNV*
1359 S_new_xpvnv(pTHX)
1360 {
1361     XPVNV* xpvnv;
1362     LOCK_SV_MUTEX;
1363     if (!PL_xpvnv_root)
1364         more_xpvnv();
1365     xpvnv = PL_xpvnv_root;
1366     PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1367     UNLOCK_SV_MUTEX;
1368     return xpvnv;
1369 }
1370
1371 /* return a struct xpvnv to the free list */
1372
1373 STATIC void
1374 S_del_xpvnv(pTHX_ XPVNV *p)
1375 {
1376     LOCK_SV_MUTEX;
1377     p->xpv_pv = (char*)PL_xpvnv_root;
1378     PL_xpvnv_root = p;
1379     UNLOCK_SV_MUTEX;
1380 }
1381
1382 /* allocate another arena's worth of struct xpvnv */
1383
1384 STATIC void
1385 S_more_xpvnv(pTHX)
1386 {
1387     register XPVNV* xpvnv;
1388     register XPVNV* xpvnvend;
1389     New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
1390     xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1391     PL_xpvnv_arenaroot = xpvnv;
1392
1393     xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
1394     PL_xpvnv_root = ++xpvnv;
1395     while (xpvnv < xpvnvend) {
1396         xpvnv->xpv_pv = (char*)(xpvnv + 1);
1397         xpvnv++;
1398     }
1399     xpvnv->xpv_pv = 0;
1400 }
1401
1402 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1403
1404 STATIC XPVCV*
1405 S_new_xpvcv(pTHX)
1406 {
1407     XPVCV* xpvcv;
1408     LOCK_SV_MUTEX;
1409     if (!PL_xpvcv_root)
1410         more_xpvcv();
1411     xpvcv = PL_xpvcv_root;
1412     PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1413     UNLOCK_SV_MUTEX;
1414     return xpvcv;
1415 }
1416
1417 /* return a struct xpvcv to the free list */
1418
1419 STATIC void
1420 S_del_xpvcv(pTHX_ XPVCV *p)
1421 {
1422     LOCK_SV_MUTEX;
1423     p->xpv_pv = (char*)PL_xpvcv_root;
1424     PL_xpvcv_root = p;
1425     UNLOCK_SV_MUTEX;
1426 }
1427
1428 /* allocate another arena's worth of struct xpvcv */
1429
1430 STATIC void
1431 S_more_xpvcv(pTHX)
1432 {
1433     register XPVCV* xpvcv;
1434     register XPVCV* xpvcvend;
1435     New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
1436     xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1437     PL_xpvcv_arenaroot = xpvcv;
1438
1439     xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
1440     PL_xpvcv_root = ++xpvcv;
1441     while (xpvcv < xpvcvend) {
1442         xpvcv->xpv_pv = (char*)(xpvcv + 1);
1443         xpvcv++;
1444     }
1445     xpvcv->xpv_pv = 0;
1446 }
1447
1448 /* grab a new struct xpvav from the free list, allocating more if necessary */
1449
1450 STATIC XPVAV*
1451 S_new_xpvav(pTHX)
1452 {
1453     XPVAV* xpvav;
1454     LOCK_SV_MUTEX;
1455     if (!PL_xpvav_root)
1456         more_xpvav();
1457     xpvav = PL_xpvav_root;
1458     PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1459     UNLOCK_SV_MUTEX;
1460     return xpvav;
1461 }
1462
1463 /* return a struct xpvav to the free list */
1464
1465 STATIC void
1466 S_del_xpvav(pTHX_ XPVAV *p)
1467 {
1468     LOCK_SV_MUTEX;
1469     p->xav_array = (char*)PL_xpvav_root;
1470     PL_xpvav_root = p;
1471     UNLOCK_SV_MUTEX;
1472 }
1473
1474 /* allocate another arena's worth of struct xpvav */
1475
1476 STATIC void
1477 S_more_xpvav(pTHX)
1478 {
1479     register XPVAV* xpvav;
1480     register XPVAV* xpvavend;
1481     New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
1482     xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1483     PL_xpvav_arenaroot = xpvav;
1484
1485     xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
1486     PL_xpvav_root = ++xpvav;
1487     while (xpvav < xpvavend) {
1488         xpvav->xav_array = (char*)(xpvav + 1);
1489         xpvav++;
1490     }
1491     xpvav->xav_array = 0;
1492 }
1493
1494 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1495
1496 STATIC XPVHV*
1497 S_new_xpvhv(pTHX)
1498 {
1499     XPVHV* xpvhv;
1500     LOCK_SV_MUTEX;
1501     if (!PL_xpvhv_root)
1502         more_xpvhv();
1503     xpvhv = PL_xpvhv_root;
1504     PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1505     UNLOCK_SV_MUTEX;
1506     return xpvhv;
1507 }
1508
1509 /* return a struct xpvhv to the free list */
1510
1511 STATIC void
1512 S_del_xpvhv(pTHX_ XPVHV *p)
1513 {
1514     LOCK_SV_MUTEX;
1515     p->xhv_array = (char*)PL_xpvhv_root;
1516     PL_xpvhv_root = p;
1517     UNLOCK_SV_MUTEX;
1518 }
1519
1520 /* allocate another arena's worth of struct xpvhv */
1521
1522 STATIC void
1523 S_more_xpvhv(pTHX)
1524 {
1525     register XPVHV* xpvhv;
1526     register XPVHV* xpvhvend;
1527     New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1528     xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1529     PL_xpvhv_arenaroot = xpvhv;
1530
1531     xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1532     PL_xpvhv_root = ++xpvhv;
1533     while (xpvhv < xpvhvend) {
1534         xpvhv->xhv_array = (char*)(xpvhv + 1);
1535         xpvhv++;
1536     }
1537     xpvhv->xhv_array = 0;
1538 }
1539
1540 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1541
1542 STATIC XPVMG*
1543 S_new_xpvmg(pTHX)
1544 {
1545     XPVMG* xpvmg;
1546     LOCK_SV_MUTEX;
1547     if (!PL_xpvmg_root)
1548         more_xpvmg();
1549     xpvmg = PL_xpvmg_root;
1550     PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1551     UNLOCK_SV_MUTEX;
1552     return xpvmg;
1553 }
1554
1555 /* return a struct xpvmg to the free list */
1556
1557 STATIC void
1558 S_del_xpvmg(pTHX_ XPVMG *p)
1559 {
1560     LOCK_SV_MUTEX;
1561     p->xpv_pv = (char*)PL_xpvmg_root;
1562     PL_xpvmg_root = p;
1563     UNLOCK_SV_MUTEX;
1564 }
1565
1566 /* allocate another arena's worth of struct xpvmg */
1567
1568 STATIC void
1569 S_more_xpvmg(pTHX)
1570 {
1571     register XPVMG* xpvmg;
1572     register XPVMG* xpvmgend;
1573     New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1574     xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1575     PL_xpvmg_arenaroot = xpvmg;
1576
1577     xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1578     PL_xpvmg_root = ++xpvmg;
1579     while (xpvmg < xpvmgend) {
1580         xpvmg->xpv_pv = (char*)(xpvmg + 1);
1581         xpvmg++;
1582     }
1583     xpvmg->xpv_pv = 0;
1584 }
1585
1586 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1587
1588 STATIC XPVLV*
1589 S_new_xpvlv(pTHX)
1590 {
1591     XPVLV* xpvlv;
1592     LOCK_SV_MUTEX;
1593     if (!PL_xpvlv_root)
1594         more_xpvlv();
1595     xpvlv = PL_xpvlv_root;
1596     PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1597     UNLOCK_SV_MUTEX;
1598     return xpvlv;
1599 }
1600
1601 /* return a struct xpvlv to the free list */
1602
1603 STATIC void
1604 S_del_xpvlv(pTHX_ XPVLV *p)
1605 {
1606     LOCK_SV_MUTEX;
1607     p->xpv_pv = (char*)PL_xpvlv_root;
1608     PL_xpvlv_root = p;
1609     UNLOCK_SV_MUTEX;
1610 }
1611
1612 /* allocate another arena's worth of struct xpvlv */
1613
1614 STATIC void
1615 S_more_xpvlv(pTHX)
1616 {
1617     register XPVLV* xpvlv;
1618     register XPVLV* xpvlvend;
1619     New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1620     xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1621     PL_xpvlv_arenaroot = xpvlv;
1622
1623     xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1624     PL_xpvlv_root = ++xpvlv;
1625     while (xpvlv < xpvlvend) {
1626         xpvlv->xpv_pv = (char*)(xpvlv + 1);
1627         xpvlv++;
1628     }
1629     xpvlv->xpv_pv = 0;
1630 }
1631
1632 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1633
1634 STATIC XPVBM*
1635 S_new_xpvbm(pTHX)
1636 {
1637     XPVBM* xpvbm;
1638     LOCK_SV_MUTEX;
1639     if (!PL_xpvbm_root)
1640         more_xpvbm();
1641     xpvbm = PL_xpvbm_root;
1642     PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1643     UNLOCK_SV_MUTEX;
1644     return xpvbm;
1645 }
1646
1647 /* return a struct xpvbm to the free list */
1648
1649 STATIC void
1650 S_del_xpvbm(pTHX_ XPVBM *p)
1651 {
1652     LOCK_SV_MUTEX;
1653     p->xpv_pv = (char*)PL_xpvbm_root;
1654     PL_xpvbm_root = p;
1655     UNLOCK_SV_MUTEX;
1656 }
1657
1658 /* allocate another arena's worth of struct xpvbm */
1659
1660 STATIC void
1661 S_more_xpvbm(pTHX)
1662 {
1663     register XPVBM* xpvbm;
1664     register XPVBM* xpvbmend;
1665     New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1666     xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1667     PL_xpvbm_arenaroot = xpvbm;
1668
1669     xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1670     PL_xpvbm_root = ++xpvbm;
1671     while (xpvbm < xpvbmend) {
1672         xpvbm->xpv_pv = (char*)(xpvbm + 1);
1673         xpvbm++;
1674     }
1675     xpvbm->xpv_pv = 0;
1676 }
1677
1678 #define my_safemalloc(s)        (void*)safemalloc(s)
1679 #define my_safefree(p)  safefree((char*)p)
1680
1681 #ifdef PURIFY
1682
1683 #define new_XIV()       my_safemalloc(sizeof(XPVIV))
1684 #define del_XIV(p)      my_safefree(p)
1685
1686 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
1687 #define del_XNV(p)      my_safefree(p)
1688
1689 #define new_XRV()       my_safemalloc(sizeof(XRV))
1690 #define del_XRV(p)      my_safefree(p)
1691
1692 #define new_XPV()       my_safemalloc(sizeof(XPV))
1693 #define del_XPV(p)      my_safefree(p)
1694
1695 #define new_XPVIV()     my_safemalloc(sizeof(XPVIV))
1696 #define del_XPVIV(p)    my_safefree(p)
1697
1698 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
1699 #define del_XPVNV(p)    my_safefree(p)
1700
1701 #define new_XPVCV()     my_safemalloc(sizeof(XPVCV))
1702 #define del_XPVCV(p)    my_safefree(p)
1703
1704 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
1705 #define del_XPVAV(p)    my_safefree(p)
1706
1707 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
1708 #define del_XPVHV(p)    my_safefree(p)
1709
1710 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
1711 #define del_XPVMG(p)    my_safefree(p)
1712
1713 #define new_XPVLV()     my_safemalloc(sizeof(XPVLV))
1714 #define del_XPVLV(p)    my_safefree(p)
1715
1716 #define new_XPVBM()     my_safemalloc(sizeof(XPVBM))
1717 #define del_XPVBM(p)    my_safefree(p)
1718
1719 #else /* !PURIFY */
1720
1721 #define new_XIV()       (void*)new_xiv()
1722 #define del_XIV(p)      del_xiv((XPVIV*) p)
1723
1724 #define new_XNV()       (void*)new_xnv()
1725 #define del_XNV(p)      del_xnv((XPVNV*) p)
1726
1727 #define new_XRV()       (void*)new_xrv()
1728 #define del_XRV(p)      del_xrv((XRV*) p)
1729
1730 #define new_XPV()       (void*)new_xpv()
1731 #define del_XPV(p)      del_xpv((XPV *)p)
1732
1733 #define new_XPVIV()     (void*)new_xpviv()
1734 #define del_XPVIV(p)    del_xpviv((XPVIV *)p)
1735
1736 #define new_XPVNV()     (void*)new_xpvnv()
1737 #define del_XPVNV(p)    del_xpvnv((XPVNV *)p)
1738
1739 #define new_XPVCV()     (void*)new_xpvcv()
1740 #define del_XPVCV(p)    del_xpvcv((XPVCV *)p)
1741
1742 #define new_XPVAV()     (void*)new_xpvav()
1743 #define del_XPVAV(p)    del_xpvav((XPVAV *)p)
1744
1745 #define new_XPVHV()     (void*)new_xpvhv()
1746 #define del_XPVHV(p)    del_xpvhv((XPVHV *)p)
1747
1748 #define new_XPVMG()     (void*)new_xpvmg()
1749 #define del_XPVMG(p)    del_xpvmg((XPVMG *)p)
1750
1751 #define new_XPVLV()     (void*)new_xpvlv()
1752 #define del_XPVLV(p)    del_xpvlv((XPVLV *)p)
1753
1754 #define new_XPVBM()     (void*)new_xpvbm()
1755 #define del_XPVBM(p)    del_xpvbm((XPVBM *)p)
1756
1757 #endif /* PURIFY */
1758
1759 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
1760 #define del_XPVGV(p)    my_safefree(p)
1761
1762 #define new_XPVFM()     my_safemalloc(sizeof(XPVFM))
1763 #define del_XPVFM(p)    my_safefree(p)
1764
1765 #define new_XPVIO()     my_safemalloc(sizeof(XPVIO))
1766 #define del_XPVIO(p)    my_safefree(p)
1767
1768 /*
1769 =for apidoc sv_upgrade
1770
1771 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1772 SV, then copies across as much information as possible from the old body.
1773 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1774
1775 =cut
1776 */
1777
1778 bool
1779 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1780 {
1781
1782     char*       pv;
1783     U32         cur;
1784     U32         len;
1785     IV          iv;
1786     NV          nv;
1787     MAGIC*      magic;
1788     HV*         stash;
1789
1790     if (mt != SVt_PV && SvIsCOW(sv)) {
1791         sv_force_normal_flags(sv, 0);
1792     }
1793
1794     if (SvTYPE(sv) == mt)
1795         return TRUE;
1796
1797     if (mt < SVt_PVIV)
1798         (void)SvOOK_off(sv);
1799
1800     pv = NULL;
1801     cur = 0;
1802     len = 0;
1803     iv = 0;
1804     nv = 0.0;
1805     magic = NULL;
1806     stash = Nullhv;
1807
1808     switch (SvTYPE(sv)) {
1809     case SVt_NULL:
1810         break;
1811     case SVt_IV:
1812         iv      = SvIVX(sv);
1813         del_XIV(SvANY(sv));
1814         if (mt == SVt_NV)
1815             mt = SVt_PVNV;
1816         else if (mt < SVt_PVIV)
1817             mt = SVt_PVIV;
1818         break;
1819     case SVt_NV:
1820         nv      = SvNVX(sv);
1821         del_XNV(SvANY(sv));
1822         if (mt < SVt_PVNV)
1823             mt = SVt_PVNV;
1824         break;
1825     case SVt_RV:
1826         pv      = (char*)SvRV(sv);
1827         del_XRV(SvANY(sv));
1828         break;
1829     case SVt_PV:
1830         pv      = SvPVX(sv);
1831         cur     = SvCUR(sv);
1832         len     = SvLEN(sv);
1833         del_XPV(SvANY(sv));
1834         if (mt <= SVt_IV)
1835             mt = SVt_PVIV;
1836         else if (mt == SVt_NV)
1837             mt = SVt_PVNV;
1838         break;
1839     case SVt_PVIV:
1840         pv      = SvPVX(sv);
1841         cur     = SvCUR(sv);
1842         len     = SvLEN(sv);
1843         iv      = SvIVX(sv);
1844         del_XPVIV(SvANY(sv));
1845         break;
1846     case SVt_PVNV:
1847         pv      = SvPVX(sv);
1848         cur     = SvCUR(sv);
1849         len     = SvLEN(sv);
1850         iv      = SvIVX(sv);
1851         nv      = SvNVX(sv);
1852         del_XPVNV(SvANY(sv));
1853         break;
1854     case SVt_PVMG:
1855         pv      = SvPVX(sv);
1856         cur     = SvCUR(sv);
1857         len     = SvLEN(sv);
1858         iv      = SvIVX(sv);
1859         nv      = SvNVX(sv);
1860         magic   = SvMAGIC(sv);
1861         stash   = SvSTASH(sv);
1862         del_XPVMG(SvANY(sv));
1863         break;
1864     default:
1865         Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1866     }
1867
1868     SvFLAGS(sv) &= ~SVTYPEMASK;
1869     SvFLAGS(sv) |= mt;
1870
1871     switch (mt) {
1872     case SVt_NULL:
1873         Perl_croak(aTHX_ "Can't upgrade to undef");
1874     case SVt_IV:
1875         SvANY(sv) = new_XIV();
1876         SvIV_set(sv, iv);
1877         break;
1878     case SVt_NV:
1879         SvANY(sv) = new_XNV();
1880         SvNV_set(sv, nv);
1881         break;
1882     case SVt_RV:
1883         SvANY(sv) = new_XRV();
1884         SvRV_set(sv, (SV*)pv);
1885         break;
1886     case SVt_PVHV:
1887         SvANY(sv) = new_XPVHV();
1888         HvRITER(sv)     = 0;
1889         HvEITER(sv)     = 0;
1890         HvPMROOT(sv)    = 0;
1891         HvNAME(sv)      = 0;
1892         HvFILL(sv)      = 0;
1893         HvMAX(sv)       = 0;
1894         HvTOTALKEYS(sv) = 0;
1895         HvPLACEHOLDERS(sv) = 0;
1896
1897         /* Fall through...  */
1898         if (0) {
1899         case SVt_PVAV:
1900             SvANY(sv) = new_XPVAV();
1901             AvMAX(sv)   = -1;
1902             AvFILLp(sv) = -1;
1903             AvALLOC(sv) = 0;
1904             AvARYLEN(sv)= 0;
1905             AvFLAGS(sv) = AVf_REAL;
1906             SvIV_set(sv, 0);
1907             SvNV_set(sv, 0.0);
1908         }
1909         /* to here.  */
1910         if (pv)
1911             Safefree(pv);
1912         SvPV_set(sv, (char*)0);
1913         SvMAGIC_set(sv, magic);
1914         SvSTASH_set(sv, stash);
1915         break;
1916
1917     case SVt_PVIO:
1918         SvANY(sv) = new_XPVIO();
1919         Zero(SvANY(sv), 1, XPVIO);
1920         IoPAGE_LEN(sv)  = 60;
1921         goto set_magic_common;
1922     case SVt_PVFM:
1923         SvANY(sv) = new_XPVFM();
1924         Zero(SvANY(sv), 1, XPVFM);
1925         goto set_magic_common;
1926     case SVt_PVBM:
1927         SvANY(sv) = new_XPVBM();
1928         BmRARE(sv)      = 0;
1929         BmUSEFUL(sv)    = 0;
1930         BmPREVIOUS(sv)  = 0;
1931         goto set_magic_common;
1932     case SVt_PVGV:
1933         SvANY(sv) = new_XPVGV();
1934         GvGP(sv)        = 0;
1935         GvNAME(sv)      = 0;
1936         GvNAMELEN(sv)   = 0;
1937         GvSTASH(sv)     = 0;
1938         GvFLAGS(sv)     = 0;
1939         goto set_magic_common;
1940     case SVt_PVCV:
1941         SvANY(sv) = new_XPVCV();
1942         Zero(SvANY(sv), 1, XPVCV);
1943         goto set_magic_common;
1944     case SVt_PVLV:
1945         SvANY(sv) = new_XPVLV();
1946         LvTARGOFF(sv)   = 0;
1947         LvTARGLEN(sv)   = 0;
1948         LvTARG(sv)      = 0;
1949         LvTYPE(sv)      = 0;
1950         GvGP(sv)        = 0;
1951         GvNAME(sv)      = 0;
1952         GvNAMELEN(sv)   = 0;
1953         GvSTASH(sv)     = 0;
1954         GvFLAGS(sv)     = 0;
1955         /* Fall through.  */
1956         if (0) {
1957         case SVt_PVMG:
1958             SvANY(sv) = new_XPVMG();
1959         }
1960     set_magic_common:
1961         SvMAGIC_set(sv, magic);
1962         SvSTASH_set(sv, stash);
1963         /* Fall through.  */
1964         if (0) {
1965         case SVt_PVNV:
1966             SvANY(sv) = new_XPVNV();
1967         }
1968         SvNV_set(sv, nv);
1969         /* Fall through.  */
1970         if (0) {
1971         case SVt_PVIV:
1972             SvANY(sv) = new_XPVIV();
1973             if (SvNIOK(sv))
1974                 (void)SvIOK_on(sv);
1975             SvNOK_off(sv);
1976         }
1977         SvIV_set(sv, iv);
1978         /* Fall through.  */
1979         if (0) {
1980         case SVt_PV:
1981             SvANY(sv) = new_XPV();
1982         }
1983         SvPV_set(sv, pv);
1984         SvCUR_set(sv, cur);
1985         SvLEN_set(sv, len);
1986         break;
1987     }
1988     return TRUE;
1989 }
1990
1991 /*
1992 =for apidoc sv_backoff
1993
1994 Remove any string offset. You should normally use the C<SvOOK_off> macro
1995 wrapper instead.
1996
1997 =cut
1998 */
1999
2000 int
2001 Perl_sv_backoff(pTHX_ register SV *sv)
2002 {
2003     assert(SvOOK(sv));
2004     if (SvIVX(sv)) {
2005         char *s = SvPVX(sv);
2006         SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
2007         SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
2008         SvIV_set(sv, 0);
2009         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2010     }
2011     SvFLAGS(sv) &= ~SVf_OOK;
2012     return 0;
2013 }
2014
2015 /*
2016 =for apidoc sv_grow
2017
2018 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
2019 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
2020 Use the C<SvGROW> wrapper instead.
2021
2022 =cut
2023 */
2024
2025 char *
2026 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2027 {
2028     register char *s;
2029
2030 #ifdef HAS_64K_LIMIT
2031     if (newlen >= 0x10000) {
2032         PerlIO_printf(Perl_debug_log,
2033                       "Allocation too large: %"UVxf"\n", (UV)newlen);
2034         my_exit(1);
2035     }
2036 #endif /* HAS_64K_LIMIT */
2037     if (SvROK(sv))
2038         sv_unref(sv);
2039     if (SvTYPE(sv) < SVt_PV) {
2040         sv_upgrade(sv, SVt_PV);
2041         s = SvPVX(sv);
2042     }
2043     else if (SvOOK(sv)) {       /* pv is offset? */
2044         sv_backoff(sv);
2045         s = SvPVX(sv);
2046         if (newlen > SvLEN(sv))
2047             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2048 #ifdef HAS_64K_LIMIT
2049         if (newlen >= 0x10000)
2050             newlen = 0xFFFF;
2051 #endif
2052     }
2053     else
2054         s = SvPVX(sv);
2055
2056     if (newlen > SvLEN(sv)) {           /* need more room? */
2057         if (SvLEN(sv) && s) {
2058 #ifdef MYMALLOC
2059             STRLEN l = malloced_size((void*)SvPVX(sv));
2060             if (newlen <= l) {
2061                 SvLEN_set(sv, l);
2062                 return s;
2063             } else
2064 #endif
2065             Renew(s,newlen,char);
2066         }
2067         else {
2068             New(703, s, newlen, char);
2069             if (SvPVX(sv) && SvCUR(sv)) {
2070                 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2071             }
2072         }
2073         SvPV_set(sv, s);
2074         SvLEN_set(sv, newlen);
2075     }
2076     return s;
2077 }
2078
2079 /*
2080 =for apidoc sv_setiv
2081
2082 Copies an integer into the given SV, upgrading first if necessary.
2083 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
2084
2085 =cut
2086 */
2087
2088 void
2089 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2090 {
2091     SV_CHECK_THINKFIRST_COW_DROP(sv);
2092     switch (SvTYPE(sv)) {
2093     case SVt_NULL:
2094         sv_upgrade(sv, SVt_IV);
2095         break;
2096     case SVt_NV:
2097         sv_upgrade(sv, SVt_PVNV);
2098         break;
2099     case SVt_RV:
2100     case SVt_PV:
2101         sv_upgrade(sv, SVt_PVIV);
2102         break;
2103
2104     case SVt_PVGV:
2105     case SVt_PVAV:
2106     case SVt_PVHV:
2107     case SVt_PVCV:
2108     case SVt_PVFM:
2109     case SVt_PVIO:
2110         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2111                    OP_DESC(PL_op));
2112     }
2113     (void)SvIOK_only(sv);                       /* validate number */
2114     SvIV_set(sv, i);
2115     SvTAINT(sv);
2116 }
2117
2118 /*
2119 =for apidoc sv_setiv_mg
2120
2121 Like C<sv_setiv>, but also handles 'set' magic.
2122
2123 =cut
2124 */
2125
2126 void
2127 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2128 {
2129     sv_setiv(sv,i);
2130     SvSETMAGIC(sv);
2131 }
2132
2133 /*
2134 =for apidoc sv_setuv
2135
2136 Copies an unsigned integer into the given SV, upgrading first if necessary.
2137 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
2138
2139 =cut
2140 */
2141
2142 void
2143 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2144 {
2145     /* With these two if statements:
2146        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
2147
2148        without
2149        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
2150
2151        If you wish to remove them, please benchmark to see what the effect is
2152     */
2153     if (u <= (UV)IV_MAX) {
2154        sv_setiv(sv, (IV)u);
2155        return;
2156     }
2157     sv_setiv(sv, 0);
2158     SvIsUV_on(sv);
2159     SvUV_set(sv, u);
2160 }
2161
2162 /*
2163 =for apidoc sv_setuv_mg
2164
2165 Like C<sv_setuv>, but also handles 'set' magic.
2166
2167 =cut
2168 */
2169
2170 void
2171 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2172 {
2173     /* With these two if statements:
2174        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
2175
2176        without
2177        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
2178
2179        If you wish to remove them, please benchmark to see what the effect is
2180     */
2181     if (u <= (UV)IV_MAX) {
2182        sv_setiv(sv, (IV)u);
2183     } else {
2184        sv_setiv(sv, 0);
2185        SvIsUV_on(sv);
2186        sv_setuv(sv,u);
2187     }
2188     SvSETMAGIC(sv);
2189 }
2190
2191 /*
2192 =for apidoc sv_setnv
2193
2194 Copies a double into the given SV, upgrading first if necessary.
2195 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
2196
2197 =cut
2198 */
2199
2200 void
2201 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2202 {
2203     SV_CHECK_THINKFIRST_COW_DROP(sv);
2204     switch (SvTYPE(sv)) {
2205     case SVt_NULL:
2206     case SVt_IV:
2207         sv_upgrade(sv, SVt_NV);
2208         break;
2209     case SVt_RV:
2210     case SVt_PV:
2211     case SVt_PVIV:
2212         sv_upgrade(sv, SVt_PVNV);
2213         break;
2214
2215     case SVt_PVGV:
2216     case SVt_PVAV:
2217     case SVt_PVHV:
2218     case SVt_PVCV:
2219     case SVt_PVFM:
2220     case SVt_PVIO:
2221         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2222                    OP_NAME(PL_op));
2223     }
2224     SvNV_set(sv, num);
2225     (void)SvNOK_only(sv);                       /* validate number */
2226     SvTAINT(sv);
2227 }
2228
2229 /*
2230 =for apidoc sv_setnv_mg
2231
2232 Like C<sv_setnv>, but also handles 'set' magic.
2233
2234 =cut
2235 */
2236
2237 void
2238 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2239 {
2240     sv_setnv(sv,num);
2241     SvSETMAGIC(sv);
2242 }
2243
2244 /* Print an "isn't numeric" warning, using a cleaned-up,
2245  * printable version of the offending string
2246  */
2247
2248 STATIC void
2249 S_not_a_number(pTHX_ SV *sv)
2250 {
2251      SV *dsv;
2252      char tmpbuf[64];
2253      char *pv;
2254
2255      if (DO_UTF8(sv)) {
2256           dsv = sv_2mortal(newSVpv("", 0));
2257           pv = sv_uni_display(dsv, sv, 10, 0);
2258      } else {
2259           char *d = tmpbuf;
2260           char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2261           /* each *s can expand to 4 chars + "...\0",
2262              i.e. need room for 8 chars */
2263
2264           char *s, *end;
2265           for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2266                int ch = *s & 0xFF;
2267                if (ch & 128 && !isPRINT_LC(ch)) {
2268                     *d++ = 'M';
2269                     *d++ = '-';
2270                     ch &= 127;
2271                }
2272                if (ch == '\n') {
2273                     *d++ = '\\';
2274                     *d++ = 'n';
2275                }
2276                else if (ch == '\r') {
2277                     *d++ = '\\';
2278                     *d++ = 'r';
2279                }
2280                else if (ch == '\f') {
2281                     *d++ = '\\';
2282                     *d++ = 'f';
2283                }
2284                else if (ch == '\\') {
2285                     *d++ = '\\';
2286                     *d++ = '\\';
2287                }
2288                else if (ch == '\0') {
2289                     *d++ = '\\';
2290                     *d++ = '0';
2291                }
2292                else if (isPRINT_LC(ch))
2293                     *d++ = ch;
2294                else {
2295                     *d++ = '^';
2296                     *d++ = toCTRL(ch);
2297                }
2298           }
2299           if (s < end) {
2300                *d++ = '.';
2301                *d++ = '.';
2302                *d++ = '.';
2303           }
2304           *d = '\0';
2305           pv = tmpbuf;
2306     }
2307
2308     if (PL_op)
2309         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2310                     "Argument \"%s\" isn't numeric in %s", pv,
2311                     OP_DESC(PL_op));
2312     else
2313         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2314                     "Argument \"%s\" isn't numeric", pv);
2315 }
2316
2317 /*
2318 =for apidoc looks_like_number
2319
2320 Test if the content of an SV looks like a number (or is a number).
2321 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2322 non-numeric warning), even if your atof() doesn't grok them.
2323
2324 =cut
2325 */
2326
2327 I32
2328 Perl_looks_like_number(pTHX_ SV *sv)
2329 {
2330     register char *sbegin;
2331     STRLEN len;
2332
2333     if (SvPOK(sv)) {
2334         sbegin = SvPVX(sv);
2335         len = SvCUR(sv);
2336     }
2337     else if (SvPOKp(sv))
2338         sbegin = SvPV(sv, len);
2339     else
2340         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2341     return grok_number(sbegin, len, NULL);
2342 }
2343
2344 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2345    until proven guilty, assume that things are not that bad... */
2346
2347 /*
2348    NV_PRESERVES_UV:
2349
2350    As 64 bit platforms often have an NV that doesn't preserve all bits of
2351    an IV (an assumption perl has been based on to date) it becomes necessary
2352    to remove the assumption that the NV always carries enough precision to
2353    recreate the IV whenever needed, and that the NV is the canonical form.
2354    Instead, IV/UV and NV need to be given equal rights. So as to not lose
2355    precision as a side effect of conversion (which would lead to insanity
2356    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2357    1) to distinguish between IV/UV/NV slots that have cached a valid
2358       conversion where precision was lost and IV/UV/NV slots that have a
2359       valid conversion which has lost no precision
2360    2) to ensure that if a numeric conversion to one form is requested that
2361       would lose precision, the precise conversion (or differently
2362       imprecise conversion) is also performed and cached, to prevent
2363       requests for different numeric formats on the same SV causing
2364       lossy conversion chains. (lossless conversion chains are perfectly
2365       acceptable (still))
2366
2367
2368    flags are used:
2369    SvIOKp is true if the IV slot contains a valid value
2370    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
2371    SvNOKp is true if the NV slot contains a valid value
2372    SvNOK  is true only if the NV value is accurate
2373
2374    so
2375    while converting from PV to NV, check to see if converting that NV to an
2376    IV(or UV) would lose accuracy over a direct conversion from PV to
2377    IV(or UV). If it would, cache both conversions, return NV, but mark
2378    SV as IOK NOKp (ie not NOK).
2379
2380    While converting from PV to IV, check to see if converting that IV to an
2381    NV would lose accuracy over a direct conversion from PV to NV. If it
2382    would, cache both conversions, flag similarly.
2383
2384    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2385    correctly because if IV & NV were set NV *always* overruled.
2386    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2387    changes - now IV and NV together means that the two are interchangeable:
2388    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2389
2390    The benefit of this is that operations such as pp_add know that if
2391    SvIOK is true for both left and right operands, then integer addition
2392    can be used instead of floating point (for cases where the result won't
2393    overflow). Before, floating point was always used, which could lead to
2394    loss of precision compared with integer addition.
2395
2396    * making IV and NV equal status should make maths accurate on 64 bit
2397      platforms
2398    * may speed up maths somewhat if pp_add and friends start to use
2399      integers when possible instead of fp. (Hopefully the overhead in
2400      looking for SvIOK and checking for overflow will not outweigh the
2401      fp to integer speedup)
2402    * will slow down integer operations (callers of SvIV) on "inaccurate"
2403      values, as the change from SvIOK to SvIOKp will cause a call into
2404      sv_2iv each time rather than a macro access direct to the IV slot
2405    * should speed up number->string conversion on integers as IV is
2406      favoured when IV and NV are equally accurate
2407
2408    ####################################################################
2409    You had better be using SvIOK_notUV if you want an IV for arithmetic:
2410    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2411    On the other hand, SvUOK is true iff UV.
2412    ####################################################################
2413
2414    Your mileage will vary depending your CPU's relative fp to integer
2415    performance ratio.
2416 */
2417
2418 #ifndef NV_PRESERVES_UV
2419 #  define IS_NUMBER_UNDERFLOW_IV 1
2420 #  define IS_NUMBER_UNDERFLOW_UV 2
2421 #  define IS_NUMBER_IV_AND_UV    2
2422 #  define IS_NUMBER_OVERFLOW_IV  4
2423 #  define IS_NUMBER_OVERFLOW_UV  5
2424
2425 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2426
2427 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
2428 STATIC int
2429 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2430 {
2431     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));
2432     if (SvNVX(sv) < (NV)IV_MIN) {
2433         (void)SvIOKp_on(sv);
2434         (void)SvNOK_on(sv);
2435         SvIV_set(sv, IV_MIN);
2436         return IS_NUMBER_UNDERFLOW_IV;
2437     }
2438     if (SvNVX(sv) > (NV)UV_MAX) {
2439         (void)SvIOKp_on(sv);
2440         (void)SvNOK_on(sv);
2441         SvIsUV_on(sv);
2442         SvUV_set(sv, UV_MAX);
2443         return IS_NUMBER_OVERFLOW_UV;
2444     }
2445     (void)SvIOKp_on(sv);
2446     (void)SvNOK_on(sv);
2447     /* Can't use strtol etc to convert this string.  (See truth table in
2448        sv_2iv  */
2449     if (SvNVX(sv) <= (UV)IV_MAX) {
2450         SvIV_set(sv, I_V(SvNVX(sv)));
2451         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2452             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2453         } else {
2454             /* Integer is imprecise. NOK, IOKp */
2455         }
2456         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2457     }
2458     SvIsUV_on(sv);
2459     SvUV_set(sv, U_V(SvNVX(sv)));
2460     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2461         if (SvUVX(sv) == UV_MAX) {
2462             /* As we know that NVs don't preserve UVs, UV_MAX cannot
2463                possibly be preserved by NV. Hence, it must be overflow.
2464                NOK, IOKp */
2465             return IS_NUMBER_OVERFLOW_UV;
2466         }
2467         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2468     } else {
2469         /* Integer is imprecise. NOK, IOKp */
2470     }
2471     return IS_NUMBER_OVERFLOW_IV;
2472 }
2473 #endif /* !NV_PRESERVES_UV*/
2474
2475 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2476  * this function provided for binary compatibility only
2477  */
2478
2479 IV
2480 Perl_sv_2iv(pTHX_ register SV *sv)
2481 {
2482     return sv_2iv_flags(sv, SV_GMAGIC);
2483 }
2484
2485 /*
2486 =for apidoc sv_2iv_flags
2487
2488 Return the integer value of an SV, doing any necessary string
2489 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2490 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2491
2492 =cut
2493 */
2494
2495 IV
2496 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2497 {
2498     if (!sv)
2499         return 0;
2500     if (SvGMAGICAL(sv)) {
2501         if (flags & SV_GMAGIC)
2502             mg_get(sv);
2503         if (SvIOKp(sv))
2504             return SvIVX(sv);
2505         if (SvNOKp(sv)) {
2506             return I_V(SvNVX(sv));
2507         }
2508         if (SvPOKp(sv) && SvLEN(sv))
2509             return asIV(sv);
2510         if (!SvROK(sv)) {
2511             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2512                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2513                     report_uninit(sv);
2514             }
2515             return 0;
2516         }
2517     }
2518     if (SvTHINKFIRST(sv)) {
2519         if (SvROK(sv)) {
2520           SV* tmpstr;
2521           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2522                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2523               return SvIV(tmpstr);
2524           return PTR2IV(SvRV(sv));
2525         }
2526         if (SvIsCOW(sv)) {
2527             sv_force_normal_flags(sv, 0);
2528         }
2529         if (SvREADONLY(sv) && !SvOK(sv)) {
2530             if (ckWARN(WARN_UNINITIALIZED))
2531                 report_uninit(sv);
2532             return 0;
2533         }
2534     }
2535     if (SvIOKp(sv)) {
2536         if (SvIsUV(sv)) {
2537             return (IV)(SvUVX(sv));
2538         }
2539         else {
2540             return SvIVX(sv);
2541         }
2542     }
2543     if (SvNOKp(sv)) {
2544         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2545          * without also getting a cached IV/UV from it at the same time
2546          * (ie PV->NV conversion should detect loss of accuracy and cache
2547          * IV or UV at same time to avoid this.  NWC */
2548
2549         if (SvTYPE(sv) == SVt_NV)
2550             sv_upgrade(sv, SVt_PVNV);
2551
2552         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2553         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2554            certainly cast into the IV range at IV_MAX, whereas the correct
2555            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2556            cases go to UV */
2557         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2558             SvIV_set(sv, I_V(SvNVX(sv)));
2559             if (SvNVX(sv) == (NV) SvIVX(sv)
2560 #ifndef NV_PRESERVES_UV
2561                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2562                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2563                 /* Don't flag it as "accurately an integer" if the number
2564                    came from a (by definition imprecise) NV operation, and
2565                    we're outside the range of NV integer precision */
2566 #endif
2567                 ) {
2568                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2569                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2570                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2571                                       PTR2UV(sv),
2572                                       SvNVX(sv),
2573                                       SvIVX(sv)));
2574
2575             } else {
2576                 /* IV not precise.  No need to convert from PV, as NV
2577                    conversion would already have cached IV if it detected
2578                    that PV->IV would be better than PV->NV->IV
2579                    flags already correct - don't set public IOK.  */
2580                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2581                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2582                                       PTR2UV(sv),
2583                                       SvNVX(sv),
2584                                       SvIVX(sv)));
2585             }
2586             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2587                but the cast (NV)IV_MIN rounds to a the value less (more
2588                negative) than IV_MIN which happens to be equal to SvNVX ??
2589                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2590                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2591                (NV)UVX == NVX are both true, but the values differ. :-(
2592                Hopefully for 2s complement IV_MIN is something like
2593                0x8000000000000000 which will be exact. NWC */
2594         }
2595         else {
2596             SvUV_set(sv, U_V(SvNVX(sv)));
2597             if (
2598                 (SvNVX(sv) == (NV) SvUVX(sv))
2599 #ifndef  NV_PRESERVES_UV
2600                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2601                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2602                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2603                 /* Don't flag it as "accurately an integer" if the number
2604                    came from a (by definition imprecise) NV operation, and
2605                    we're outside the range of NV integer precision */
2606 #endif
2607                 )
2608                 SvIOK_on(sv);
2609             SvIsUV_on(sv);
2610           ret_iv_max:
2611             DEBUG_c(PerlIO_printf(Perl_debug_log,
2612                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2613                                   PTR2UV(sv),
2614                                   SvUVX(sv),
2615                                   SvUVX(sv)));
2616             return (IV)SvUVX(sv);
2617         }
2618     }
2619     else if (SvPOKp(sv) && SvLEN(sv)) {
2620         UV value;
2621         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2622         /* We want to avoid a possible problem when we cache an IV which
2623            may be later translated to an NV, and the resulting NV is not
2624            the same as the direct translation of the initial string
2625            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2626            be careful to ensure that the value with the .456 is around if the
2627            NV value is requested in the future).
2628
2629            This means that if we cache such an IV, we need to cache the
2630            NV as well.  Moreover, we trade speed for space, and do not
2631            cache the NV if we are sure it's not needed.
2632          */
2633
2634         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2635         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2636              == IS_NUMBER_IN_UV) {
2637             /* It's definitely an integer, only upgrade to PVIV */
2638             if (SvTYPE(sv) < SVt_PVIV)
2639                 sv_upgrade(sv, SVt_PVIV);
2640             (void)SvIOK_on(sv);
2641         } else if (SvTYPE(sv) < SVt_PVNV)
2642             sv_upgrade(sv, SVt_PVNV);
2643
2644         /* If NV preserves UV then we only use the UV value if we know that
2645            we aren't going to call atof() below. If NVs don't preserve UVs
2646            then the value returned may have more precision than atof() will
2647            return, even though value isn't perfectly accurate.  */
2648         if ((numtype & (IS_NUMBER_IN_UV
2649 #ifdef NV_PRESERVES_UV
2650                         | IS_NUMBER_NOT_INT
2651 #endif
2652             )) == IS_NUMBER_IN_UV) {
2653             /* This won't turn off the public IOK flag if it was set above  */
2654             (void)SvIOKp_on(sv);
2655
2656             if (!(numtype & IS_NUMBER_NEG)) {
2657                 /* positive */;
2658                 if (value <= (UV)IV_MAX) {
2659                     SvIV_set(sv, (IV)value);
2660                 } else {
2661                     SvUV_set(sv, value);
2662                     SvIsUV_on(sv);
2663                 }
2664             } else {
2665                 /* 2s complement assumption  */
2666                 if (value <= (UV)IV_MIN) {
2667                     SvIV_set(sv, -(IV)value);
2668                 } else {
2669                     /* Too negative for an IV.  This is a double upgrade, but
2670                        I'm assuming it will be rare.  */
2671                     if (SvTYPE(sv) < SVt_PVNV)
2672                         sv_upgrade(sv, SVt_PVNV);
2673                     SvNOK_on(sv);
2674                     SvIOK_off(sv);
2675                     SvIOKp_on(sv);
2676                     SvNV_set(sv, -(NV)value);
2677                     SvIV_set(sv, IV_MIN);
2678                 }
2679             }
2680         }
2681         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2682            will be in the previous block to set the IV slot, and the next
2683            block to set the NV slot.  So no else here.  */
2684
2685         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2686             != IS_NUMBER_IN_UV) {
2687             /* It wasn't an (integer that doesn't overflow the UV). */
2688             SvNV_set(sv, Atof(SvPVX(sv)));
2689
2690             if (! numtype && ckWARN(WARN_NUMERIC))
2691                 not_a_number(sv);
2692
2693 #if defined(USE_LONG_DOUBLE)
2694             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2695                                   PTR2UV(sv), SvNVX(sv)));
2696 #else
2697             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2698                                   PTR2UV(sv), SvNVX(sv)));
2699 #endif
2700
2701
2702 #ifdef NV_PRESERVES_UV
2703             (void)SvIOKp_on(sv);
2704             (void)SvNOK_on(sv);
2705             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2706                 SvIV_set(sv, I_V(SvNVX(sv)));
2707                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2708                     SvIOK_on(sv);
2709                 } else {
2710                     /* Integer is imprecise. NOK, IOKp */
2711                 }
2712                 /* UV will not work better than IV */
2713             } else {
2714                 if (SvNVX(sv) > (NV)UV_MAX) {
2715                     SvIsUV_on(sv);
2716                     /* Integer is inaccurate. NOK, IOKp, is UV */
2717                     SvUV_set(sv, UV_MAX);
2718                     SvIsUV_on(sv);
2719                 } else {
2720                     SvUV_set(sv, U_V(SvNVX(sv)));
2721                     /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2722                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2723                         SvIOK_on(sv);
2724                         SvIsUV_on(sv);
2725                     } else {
2726                         /* Integer is imprecise. NOK, IOKp, is UV */
2727                         SvIsUV_on(sv);
2728                     }
2729                 }
2730                 goto ret_iv_max;
2731             }
2732 #else /* NV_PRESERVES_UV */
2733             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2734                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2735                 /* The IV slot will have been set from value returned by
2736                    grok_number above.  The NV slot has just been set using
2737                    Atof.  */
2738                 SvNOK_on(sv);
2739                 assert (SvIOKp(sv));
2740             } else {
2741                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2742                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2743                     /* Small enough to preserve all bits. */
2744                     (void)SvIOKp_on(sv);
2745                     SvNOK_on(sv);
2746                     SvIV_set(sv, I_V(SvNVX(sv)));
2747                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2748                         SvIOK_on(sv);
2749                     /* Assumption: first non-preserved integer is < IV_MAX,
2750                        this NV is in the preserved range, therefore: */
2751                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2752                           < (UV)IV_MAX)) {
2753                         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);
2754                     }
2755                 } else {
2756                     /* IN_UV NOT_INT
2757                          0      0       already failed to read UV.
2758                          0      1       already failed to read UV.
2759                          1      0       you won't get here in this case. IV/UV
2760                                         slot set, public IOK, Atof() unneeded.
2761                          1      1       already read UV.
2762                        so there's no point in sv_2iuv_non_preserve() attempting
2763                        to use atol, strtol, strtoul etc.  */
2764                     if (sv_2iuv_non_preserve (sv, numtype)
2765                         >= IS_NUMBER_OVERFLOW_IV)
2766                     goto ret_iv_max;
2767                 }
2768             }
2769 #endif /* NV_PRESERVES_UV */
2770         }
2771     } else  {
2772         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2773             report_uninit(sv);
2774         if (SvTYPE(sv) < SVt_IV)
2775             /* Typically the caller expects that sv_any is not NULL now.  */
2776             sv_upgrade(sv, SVt_IV);
2777         return 0;
2778     }
2779     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2780         PTR2UV(sv),SvIVX(sv)));
2781     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2782 }
2783
2784 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2785  * this function provided for binary compatibility only
2786  */
2787
2788 UV
2789 Perl_sv_2uv(pTHX_ register SV *sv)
2790 {
2791     return sv_2uv_flags(sv, SV_GMAGIC);
2792 }
2793
2794 /*
2795 =for apidoc sv_2uv_flags
2796
2797 Return the unsigned integer value of an SV, doing any necessary string
2798 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2799 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2800
2801 =cut
2802 */
2803
2804 UV
2805 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2806 {
2807     if (!sv)
2808         return 0;
2809     if (SvGMAGICAL(sv)) {
2810         if (flags & SV_GMAGIC)
2811             mg_get(sv);
2812         if (SvIOKp(sv))
2813             return SvUVX(sv);
2814         if (SvNOKp(sv))
2815             return U_V(SvNVX(sv));
2816         if (SvPOKp(sv) && SvLEN(sv))
2817             return asUV(sv);
2818         if (!SvROK(sv)) {
2819             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2820                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2821                     report_uninit(sv);
2822             }
2823             return 0;
2824         }
2825     }
2826     if (SvTHINKFIRST(sv)) {
2827         if (SvROK(sv)) {
2828           SV* tmpstr;
2829           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2830                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2831               return SvUV(tmpstr);
2832           return PTR2UV(SvRV(sv));
2833         }
2834         if (SvIsCOW(sv)) {
2835             sv_force_normal_flags(sv, 0);
2836         }
2837         if (SvREADONLY(sv) && !SvOK(sv)) {
2838             if (ckWARN(WARN_UNINITIALIZED))
2839                 report_uninit(sv);
2840             return 0;
2841         }
2842     }
2843     if (SvIOKp(sv)) {
2844         if (SvIsUV(sv)) {
2845             return SvUVX(sv);
2846         }
2847         else {
2848             return (UV)SvIVX(sv);
2849         }
2850     }
2851     if (SvNOKp(sv)) {
2852         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2853          * without also getting a cached IV/UV from it at the same time
2854          * (ie PV->NV conversion should detect loss of accuracy and cache
2855          * IV or UV at same time to avoid this. */
2856         /* IV-over-UV optimisation - choose to cache IV if possible */
2857
2858         if (SvTYPE(sv) == SVt_NV)
2859             sv_upgrade(sv, SVt_PVNV);
2860
2861         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2862         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2863             SvIV_set(sv, I_V(SvNVX(sv)));
2864             if (SvNVX(sv) == (NV) SvIVX(sv)
2865 #ifndef NV_PRESERVES_UV
2866                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2867                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2868                 /* Don't flag it as "accurately an integer" if the number
2869                    came from a (by definition imprecise) NV operation, and
2870                    we're outside the range of NV integer precision */
2871 #endif
2872                 ) {
2873                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2874                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2875                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2876                                       PTR2UV(sv),
2877                                       SvNVX(sv),
2878                                       SvIVX(sv)));
2879
2880             } else {
2881                 /* IV not precise.  No need to convert from PV, as NV
2882                    conversion would already have cached IV if it detected
2883                    that PV->IV would be better than PV->NV->IV
2884                    flags already correct - don't set public IOK.  */
2885                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2886                                       "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2887                                       PTR2UV(sv),
2888                                       SvNVX(sv),
2889                                       SvIVX(sv)));
2890             }
2891             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2892                but the cast (NV)IV_MIN rounds to a the value less (more
2893                negative) than IV_MIN which happens to be equal to SvNVX ??
2894                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2895                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2896                (NV)UVX == NVX are both true, but the values differ. :-(
2897                Hopefully for 2s complement IV_MIN is something like
2898                0x8000000000000000 which will be exact. NWC */
2899         }
2900         else {
2901             SvUV_set(sv, U_V(SvNVX(sv)));
2902             if (
2903                 (SvNVX(sv) == (NV) SvUVX(sv))
2904 #ifndef  NV_PRESERVES_UV
2905                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2906                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2907                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2908                 /* Don't flag it as "accurately an integer" if the number
2909                    came from a (by definition imprecise) NV operation, and
2910                    we're outside the range of NV integer precision */
2911 #endif
2912                 )
2913                 SvIOK_on(sv);
2914             SvIsUV_on(sv);
2915             DEBUG_c(PerlIO_printf(Perl_debug_log,
2916                                   "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2917                                   PTR2UV(sv),
2918                                   SvUVX(sv),
2919                                   SvUVX(sv)));
2920         }
2921     }
2922     else if (SvPOKp(sv) && SvLEN(sv)) {
2923         UV value;
2924         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2925
2926         /* We want to avoid a possible problem when we cache a UV which
2927            may be later translated to an NV, and the resulting NV is not
2928            the translation of the initial data.
2929
2930            This means that if we cache such a UV, we need to cache the
2931            NV as well.  Moreover, we trade speed for space, and do not
2932            cache the NV if not needed.
2933          */
2934
2935         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2936         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2937              == IS_NUMBER_IN_UV) {
2938             /* It's definitely an integer, only upgrade to PVIV */
2939             if (SvTYPE(sv) < SVt_PVIV)
2940                 sv_upgrade(sv, SVt_PVIV);
2941             (void)SvIOK_on(sv);
2942         } else if (SvTYPE(sv) < SVt_PVNV)
2943             sv_upgrade(sv, SVt_PVNV);
2944
2945         /* If NV preserves UV then we only use the UV value if we know that
2946            we aren't going to call atof() below. If NVs don't preserve UVs
2947            then the value returned may have more precision than atof() will
2948            return, even though it isn't accurate.  */
2949         if ((numtype & (IS_NUMBER_IN_UV
2950 #ifdef NV_PRESERVES_UV
2951                         | IS_NUMBER_NOT_INT
2952 #endif
2953             )) == IS_NUMBER_IN_UV) {
2954             /* This won't turn off the public IOK flag if it was set above  */
2955             (void)SvIOKp_on(sv);
2956
2957             if (!(numtype & IS_NUMBER_NEG)) {
2958                 /* positive */;
2959                 if (value <= (UV)IV_MAX) {
2960                     SvIV_set(sv, (IV)value);
2961                 } else {
2962                     /* it didn't overflow, and it was positive. */
2963                     SvUV_set(sv, value);
2964                     SvIsUV_on(sv);
2965                 }
2966             } else {
2967                 /* 2s complement assumption  */
2968                 if (value <= (UV)IV_MIN) {
2969                     SvIV_set(sv, -(IV)value);
2970                 } else {
2971                     /* Too negative for an IV.  This is a double upgrade, but
2972                        I'm assuming it will be rare.  */
2973                     if (SvTYPE(sv) < SVt_PVNV)
2974                         sv_upgrade(sv, SVt_PVNV);
2975                     SvNOK_on(sv);
2976                     SvIOK_off(sv);
2977                     SvIOKp_on(sv);
2978                     SvNV_set(sv, -(NV)value);
2979                     SvIV_set(sv, IV_MIN);
2980                 }
2981             }
2982         }
2983
2984         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2985             != IS_NUMBER_IN_UV) {
2986             /* It wasn't an integer, or it overflowed the UV. */
2987             SvNV_set(sv, Atof(SvPVX(sv)));
2988
2989             if (! numtype && ckWARN(WARN_NUMERIC))
2990                     not_a_number(sv);
2991
2992 #if defined(USE_LONG_DOUBLE)
2993             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2994                                   PTR2UV(sv), SvNVX(sv)));
2995 #else
2996             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2997                                   PTR2UV(sv), SvNVX(sv)));
2998 #endif
2999
3000 #ifdef NV_PRESERVES_UV
3001             (void)SvIOKp_on(sv);
3002             (void)SvNOK_on(sv);
3003             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3004                 SvIV_set(sv, I_V(SvNVX(sv)));
3005                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3006                     SvIOK_on(sv);
3007                 } else {
3008                     /* Integer is imprecise. NOK, IOKp */
3009                 }
3010                 /* UV will not work better than IV */
3011             } else {
3012                 if (SvNVX(sv) > (NV)UV_MAX) {
3013                     SvIsUV_on(sv);
3014                     /* Integer is inaccurate. NOK, IOKp, is UV */
3015                     SvUV_set(sv, UV_MAX);
3016                     SvIsUV_on(sv);
3017                 } else {
3018                     SvUV_set(sv, U_V(SvNVX(sv)));
3019                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3020                        NV preservse UV so can do correct comparison.  */
3021                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3022                         SvIOK_on(sv);
3023                         SvIsUV_on(sv);
3024                     } else {
3025                         /* Integer is imprecise. NOK, IOKp, is UV */
3026                         SvIsUV_on(sv);
3027                     }
3028                 }
3029             }
3030 #else /* NV_PRESERVES_UV */
3031             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3032                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3033                 /* The UV slot will have been set from value returned by
3034                    grok_number above.  The NV slot has just been set using
3035                    Atof.  */
3036                 SvNOK_on(sv);
3037                 assert (SvIOKp(sv));
3038             } else {
3039                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3040                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3041                     /* Small enough to preserve all bits. */
3042                     (void)SvIOKp_on(sv);
3043                     SvNOK_on(sv);
3044                     SvIV_set(sv, I_V(SvNVX(sv)));
3045                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
3046                         SvIOK_on(sv);
3047                     /* Assumption: first non-preserved integer is < IV_MAX,
3048                        this NV is in the preserved range, therefore: */
3049                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3050                           < (UV)IV_MAX)) {
3051                         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);
3052                     }
3053                 } else
3054                     sv_2iuv_non_preserve (sv, numtype);
3055             }
3056 #endif /* NV_PRESERVES_UV */
3057         }
3058     }
3059     else  {
3060         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3061             if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3062                 report_uninit(sv);
3063         }
3064         if (SvTYPE(sv) < SVt_IV)
3065             /* Typically the caller expects that sv_any is not NULL now.  */
3066             sv_upgrade(sv, SVt_IV);
3067         return 0;
3068     }
3069
3070     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3071                           PTR2UV(sv),SvUVX(sv)));
3072     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3073 }
3074
3075 /*
3076 =for apidoc sv_2nv
3077
3078 Return the num value of an SV, doing any necessary string or integer
3079 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3080 macros.
3081
3082 =cut
3083 */
3084
3085 NV
3086 Perl_sv_2nv(pTHX_ register SV *sv)
3087 {
3088     if (!sv)
3089         return 0.0;
3090     if (SvGMAGICAL(sv)) {
3091         mg_get(sv);
3092         if (SvNOKp(sv))
3093             return SvNVX(sv);
3094         if (SvPOKp(sv) && SvLEN(sv)) {
3095             if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3096                 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3097                 not_a_number(sv);
3098             return Atof(SvPVX(sv));
3099         }
3100         if (SvIOKp(sv)) {
3101             if (SvIsUV(sv))
3102                 return (NV)SvUVX(sv);
3103             else
3104                 return (NV)SvIVX(sv);
3105         }
3106         if (!SvROK(sv)) {
3107             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3108                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3109                     report_uninit(sv);
3110             }
3111             return 0;
3112         }
3113     }
3114     if (SvTHINKFIRST(sv)) {
3115         if (SvROK(sv)) {
3116           SV* tmpstr;
3117           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3118                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3119               return SvNV(tmpstr);
3120           return PTR2NV(SvRV(sv));
3121         }
3122         if (SvIsCOW(sv)) {
3123             sv_force_normal_flags(sv, 0);
3124         }
3125         if (SvREADONLY(sv) && !SvOK(sv)) {
3126             if (ckWARN(WARN_UNINITIALIZED))
3127                 report_uninit(sv);
3128             return 0.0;
3129         }
3130     }
3131     if (SvTYPE(sv) < SVt_NV) {
3132         if (SvTYPE(sv) == SVt_IV)
3133             sv_upgrade(sv, SVt_PVNV);
3134         else
3135             sv_upgrade(sv, SVt_NV);
3136 #ifdef USE_LONG_DOUBLE
3137         DEBUG_c({
3138             STORE_NUMERIC_LOCAL_SET_STANDARD();
3139             PerlIO_printf(Perl_debug_log,
3140                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3141                           PTR2UV(sv), SvNVX(sv));
3142             RESTORE_NUMERIC_LOCAL();
3143         });
3144 #else
3145         DEBUG_c({
3146             STORE_NUMERIC_LOCAL_SET_STANDARD();
3147             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3148                           PTR2UV(sv), SvNVX(sv));
3149             RESTORE_NUMERIC_LOCAL();
3150         });
3151 #endif
3152     }
3153     else if (SvTYPE(sv) < SVt_PVNV)
3154         sv_upgrade(sv, SVt_PVNV);
3155     if (SvNOKp(sv)) {
3156         return SvNVX(sv);
3157     }
3158     if (SvIOKp(sv)) {
3159         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3160 #ifdef NV_PRESERVES_UV
3161         SvNOK_on(sv);
3162 #else
3163         /* Only set the public NV OK flag if this NV preserves the IV  */
3164         /* Check it's not 0xFFFFFFFFFFFFFFFF */
3165         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3166                        : (SvIVX(sv) == I_V(SvNVX(sv))))
3167             SvNOK_on(sv);
3168         else
3169             SvNOKp_on(sv);
3170 #endif
3171     }
3172     else if (SvPOKp(sv) && SvLEN(sv)) {
3173         UV value;
3174         int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3175         if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3176             not_a_number(sv);
3177 #ifdef NV_PRESERVES_UV
3178         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3179             == IS_NUMBER_IN_UV) {
3180             /* It's definitely an integer */
3181             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3182         } else
3183             SvNV_set(sv, Atof(SvPVX(sv)));
3184         SvNOK_on(sv);
3185 #else
3186         SvNV_set(sv, Atof(SvPVX(sv)));
3187         /* Only set the public NV OK flag if this NV preserves the value in
3188            the PV at least as well as an IV/UV would.
3189            Not sure how to do this 100% reliably. */
3190         /* if that shift count is out of range then Configure's test is
3191            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3192            UV_BITS */
3193         if (((UV)1 << NV_PRESERVES_UV_BITS) >
3194             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3195             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3196         } else if (!(numtype & IS_NUMBER_IN_UV)) {
3197             /* Can't use strtol etc to convert this string, so don't try.
3198                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
3199             SvNOK_on(sv);
3200         } else {
3201             /* value has been set.  It may not be precise.  */
3202             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3203                 /* 2s complement assumption for (UV)IV_MIN  */
3204                 SvNOK_on(sv); /* Integer is too negative.  */
3205             } else {
3206                 SvNOKp_on(sv);
3207                 SvIOKp_on(sv);
3208
3209                 if (numtype & IS_NUMBER_NEG) {
3210                     SvIV_set(sv, -(IV)value);
3211                 } else if (value <= (UV)IV_MAX) {
3212                     SvIV_set(sv, (IV)value);
3213                 } else {
3214                     SvUV_set(sv, value);
3215                     SvIsUV_on(sv);
3216                 }
3217
3218                 if (numtype & IS_NUMBER_NOT_INT) {
3219                     /* I believe that even if the original PV had decimals,
3220                        they are lost beyond the limit of the FP precision.
3221                        However, neither is canonical, so both only get p
3222                        flags.  NWC, 2000/11/25 */
3223                     /* Both already have p flags, so do nothing */
3224                 } else {
3225                     NV nv = SvNVX(sv);
3226                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3227                         if (SvIVX(sv) == I_V(nv)) {
3228                             SvNOK_on(sv);
3229                             SvIOK_on(sv);
3230                         } else {
3231                             SvIOK_on(sv);
3232                             /* It had no "." so it must be integer.  */
3233                         }
3234                     } else {
3235                         /* between IV_MAX and NV(UV_MAX).
3236                            Could be slightly > UV_MAX */
3237
3238                         if (numtype & IS_NUMBER_NOT_INT) {
3239                             /* UV and NV both imprecise.  */
3240                         } else {
3241                             UV nv_as_uv = U_V(nv);
3242
3243                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3244                                 SvNOK_on(sv);
3245                                 SvIOK_on(sv);
3246                             } else {
3247                                 SvIOK_on(sv);
3248                             }
3249                         }
3250                     }
3251                 }
3252             }
3253         }
3254 #endif /* NV_PRESERVES_UV */
3255     }
3256     else  {
3257         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3258             report_uninit(sv);
3259         if (SvTYPE(sv) < SVt_NV)
3260             /* Typically the caller expects that sv_any is not NULL now.  */
3261             /* XXX Ilya implies that this is a bug in callers that assume this
3262                and ideally should be fixed.  */
3263             sv_upgrade(sv, SVt_NV);
3264         return 0.0;
3265     }
3266 #if defined(USE_LONG_DOUBLE)
3267     DEBUG_c({
3268         STORE_NUMERIC_LOCAL_SET_STANDARD();
3269         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3270                       PTR2UV(sv), SvNVX(sv));
3271         RESTORE_NUMERIC_LOCAL();
3272     });
3273 #else
3274     DEBUG_c({
3275         STORE_NUMERIC_LOCAL_SET_STANDARD();
3276         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3277                       PTR2UV(sv), SvNVX(sv));
3278         RESTORE_NUMERIC_LOCAL();
3279     });
3280 #endif
3281     return SvNVX(sv);
3282 }
3283
3284 /* asIV(): extract an integer from the string value of an SV.
3285  * Caller must validate PVX  */
3286
3287 STATIC IV
3288 S_asIV(pTHX_ SV *sv)
3289 {
3290     UV value;
3291     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3292
3293     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3294         == IS_NUMBER_IN_UV) {
3295         /* It's definitely an integer */
3296         if (numtype & IS_NUMBER_NEG) {
3297             if (value < (UV)IV_MIN)
3298                 return -(IV)value;
3299         } else {
3300             if (value < (UV)IV_MAX)
3301                 return (IV)value;
3302         }
3303     }
3304     if (!numtype) {
3305         if (ckWARN(WARN_NUMERIC))
3306             not_a_number(sv);
3307     }
3308     return I_V(Atof(SvPVX(sv)));
3309 }
3310
3311 /* asUV(): extract an unsigned integer from the string value of an SV
3312  * Caller must validate PVX  */
3313
3314 STATIC UV
3315 S_asUV(pTHX_ SV *sv)
3316 {
3317     UV value;
3318     int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3319
3320     if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3321         == IS_NUMBER_IN_UV) {
3322         /* It's definitely an integer */
3323         if (!(numtype & IS_NUMBER_NEG))
3324             return value;
3325     }
3326     if (!numtype) {
3327         if (ckWARN(WARN_NUMERIC))
3328             not_a_number(sv);
3329     }
3330     return U_V(Atof(SvPVX(sv)));
3331 }
3332
3333 /*
3334 =for apidoc sv_2pv_nolen
3335
3336 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3337 use the macro wrapper C<SvPV_nolen(sv)> instead.
3338 =cut
3339 */
3340
3341 char *
3342 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3343 {
3344     STRLEN n_a;
3345     return sv_2pv(sv, &n_a);
3346 }
3347
3348 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3349  * UV as a string towards the end of buf, and return pointers to start and
3350  * end of it.
3351  *
3352  * We assume that buf is at least TYPE_CHARS(UV) long.
3353  */
3354
3355 static char *
3356 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3357 {
3358     char *ptr = buf + TYPE_CHARS(UV);
3359     char *ebuf = ptr;
3360     int sign;
3361
3362     if (is_uv)
3363         sign = 0;
3364     else if (iv >= 0) {
3365         uv = iv;
3366         sign = 0;
3367     } else {
3368         uv = -iv;
3369         sign = 1;
3370     }
3371     do {
3372         *--ptr = '0' + (char)(uv % 10);
3373     } while (uv /= 10);
3374     if (sign)
3375         *--ptr = '-';
3376     *peob = ebuf;
3377     return ptr;
3378 }
3379
3380 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3381  * this function provided for binary compatibility only
3382  */
3383
3384 char *
3385 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3386 {
3387     return sv_2pv_flags(sv, lp, SV_GMAGIC);
3388 }
3389
3390 /*
3391 =for apidoc sv_2pv_flags
3392
3393 Returns a pointer to the string value of an SV, and sets *lp to its length.
3394 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3395 if necessary.
3396 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3397 usually end up here too.
3398
3399 =cut
3400 */
3401
3402 char *
3403 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3404 {
3405     register char *s;
3406     int olderrno;
3407     SV *tsv, *origsv;
3408     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
3409     char *tmpbuf = tbuf;
3410
3411     if (!sv) {
3412         *lp = 0;
3413         return (char *)"";
3414     }
3415     if (SvGMAGICAL(sv)) {
3416         if (flags & SV_GMAGIC)
3417             mg_get(sv);
3418         if (SvPOKp(sv)) {
3419             *lp = SvCUR(sv);
3420             return SvPVX(sv);
3421         }
3422         if (SvIOKp(sv)) {
3423             if (SvIsUV(sv))
3424                 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3425             else
3426                 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3427             tsv = Nullsv;
3428             goto tokensave;
3429         }
3430         if (SvNOKp(sv)) {
3431             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3432             tsv = Nullsv;
3433             goto tokensave;
3434         }
3435         if (!SvROK(sv)) {
3436             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3437                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3438                     report_uninit(sv);
3439             }
3440             *lp = 0;
3441             return (char *)"";
3442         }
3443     }
3444     if (SvTHINKFIRST(sv)) {
3445         if (SvROK(sv)) {
3446             SV* tmpstr;
3447             register const char *typestr;
3448             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3449                 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3450                 char *pv = SvPV(tmpstr, *lp);
3451                 if (SvUTF8(tmpstr))
3452                     SvUTF8_on(sv);
3453                 else
3454                     SvUTF8_off(sv);
3455                 return pv;
3456             }
3457             origsv = sv;
3458             sv = (SV*)SvRV(sv);
3459             if (!sv)
3460                 typestr = "NULLREF";
3461             else {
3462                 MAGIC *mg;
3463
3464                 switch (SvTYPE(sv)) {
3465                 case SVt_PVMG:
3466                     if ( ((SvFLAGS(sv) &
3467                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3468                           == (SVs_OBJECT|SVs_SMG))
3469                          && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3470                         const regexp *re = (regexp *)mg->mg_obj;
3471
3472                         if (!mg->mg_ptr) {
3473                             const char *fptr = "msix";
3474                             char reflags[6];
3475                             char ch;
3476                             int left = 0;
3477                             int right = 4;
3478                             char need_newline = 0;
3479                             U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3480
3481                             while((ch = *fptr++)) {
3482                                 if(reganch & 1) {
3483                                     reflags[left++] = ch;
3484                                 }
3485                                 else {
3486                                     reflags[right--] = ch;
3487                                 }
3488                                 reganch >>= 1;
3489                             }
3490                             if(left != 4) {
3491                                 reflags[left] = '-';
3492                                 left = 5;
3493                             }
3494
3495                             mg->mg_len = re->prelen + 4 + left;
3496                             /*
3497                              * If /x was used, we have to worry about a regex
3498                              * ending with a comment later being embedded
3499                              * within another regex. If so, we don't want this
3500                              * regex's "commentization" to leak out to the
3501                              * right part of the enclosing regex, we must cap
3502                              * it with a newline.
3503                              *
3504                              * So, if /x was used, we scan backwards from the
3505                              * end of the regex. If we find a '#' before we
3506                              * find a newline, we need to add a newline
3507                              * ourself. If we find a '\n' first (or if we
3508                              * don't find '#' or '\n'), we don't need to add
3509                              * anything.  -jfriedl
3510                              */
3511                             if (PMf_EXTENDED & re->reganch)
3512                             {
3513                                 const char *endptr = re->precomp + re->prelen;
3514                                 while (endptr >= re->precomp)
3515                                 {
3516                                     const char c = *(endptr--);
3517                                     if (c == '\n')
3518                                         break; /* don't need another */
3519                                     if (c == '#') {
3520                                         /* we end while in a comment, so we
3521                                            need a newline */
3522                                         mg->mg_len++; /* save space for it */
3523                                         need_newline = 1; /* note to add it */
3524                                         break;
3525                                     }
3526                                 }
3527                             }
3528
3529                             New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3530                             Copy("(?", mg->mg_ptr, 2, char);
3531                             Copy(reflags, mg->mg_ptr+2, left, char);
3532                             Copy(":", mg->mg_ptr+left+2, 1, char);
3533                             Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3534                             if (need_newline)
3535                                 mg->mg_ptr[mg->mg_len - 2] = '\n';
3536                             mg->mg_ptr[mg->mg_len - 1] = ')';
3537                             mg->mg_ptr[mg->mg_len] = 0;
3538                         }
3539                         PL_reginterp_cnt += re->program[0].next_off;
3540
3541                         if (re->reganch & ROPT_UTF8)
3542                             SvUTF8_on(origsv);
3543                         else
3544                             SvUTF8_off(origsv);
3545                         *lp = mg->mg_len;
3546                         return mg->mg_ptr;
3547                     }
3548                                         /* Fall through */
3549                 case SVt_NULL:
3550                 case SVt_IV:
3551                 case SVt_NV:
3552                 case SVt_RV:
3553                 case SVt_PV:
3554                 case SVt_PVIV:
3555                 case SVt_PVNV:
3556                 case SVt_PVBM:  typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3557                 case SVt_PVLV:  typestr = SvROK(sv) ? "REF"
3558                                 /* tied lvalues should appear to be
3559                                  * scalars for backwards compatitbility */
3560                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3561                                     ? "SCALAR" : "LVALUE";      break;
3562                 case SVt_PVAV:  typestr = "ARRAY";      break;
3563                 case SVt_PVHV:  typestr = "HASH";       break;
3564                 case SVt_PVCV:  typestr = "CODE";       break;
3565                 case SVt_PVGV:  typestr = "GLOB";       break;
3566                 case SVt_PVFM:  typestr = "FORMAT";     break;
3567                 case SVt_PVIO:  typestr = "IO";         break;
3568                 default:        typestr = "UNKNOWN";    break;
3569                 }
3570                 tsv = NEWSV(0,0);
3571                 if (SvOBJECT(sv)) {
3572                     const char *name = HvNAME(SvSTASH(sv));
3573                     Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3574                                    name ? name : "__ANON__" , typestr, PTR2UV(sv));
3575                 }
3576                 else
3577                     Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3578                 goto tokensaveref;
3579             }
3580             *lp = strlen(typestr);
3581             return (char *)typestr;
3582         }
3583         if (SvREADONLY(sv) && !SvOK(sv)) {
3584             if (ckWARN(WARN_UNINITIALIZED))
3585                 report_uninit(sv);
3586             *lp = 0;
3587             return (char *)"";
3588         }
3589     }
3590     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3591         /* I'm assuming that if both IV and NV are equally valid then
3592            converting the IV is going to be more efficient */
3593         const U32 isIOK = SvIOK(sv);
3594         const U32 isUIOK = SvIsUV(sv);
3595         char buf[TYPE_CHARS(UV)];
3596         char *ebuf, *ptr;
3597
3598         if (SvTYPE(sv) < SVt_PVIV)
3599             sv_upgrade(sv, SVt_PVIV);
3600         if (isUIOK)
3601             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3602         else
3603             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3604         SvGROW(sv, (STRLEN)(ebuf - ptr + 1));   /* inlined from sv_setpvn */
3605         Move(ptr,SvPVX(sv),ebuf - ptr,char);
3606         SvCUR_set(sv, ebuf - ptr);
3607         s = SvEND(sv);
3608         *s = '\0';
3609         if (isIOK)
3610             SvIOK_on(sv);
3611         else
3612             SvIOKp_on(sv);
3613         if (isUIOK)
3614             SvIsUV_on(sv);
3615     }
3616     else if (SvNOKp(sv)) {
3617         if (SvTYPE(sv) < SVt_PVNV)
3618             sv_upgrade(sv, SVt_PVNV);
3619         /* The +20 is pure guesswork.  Configure test needed. --jhi */
3620         SvGROW(sv, NV_DIG + 20);
3621         s = SvPVX(sv);
3622         olderrno = errno;       /* some Xenix systems wipe out errno here */
3623 #ifdef apollo
3624         if (SvNVX(sv) == 0.0)
3625             (void)strcpy(s,"0");
3626         else
3627 #endif /*apollo*/
3628         {
3629             Gconvert(SvNVX(sv), NV_DIG, 0, s);
3630         }
3631         errno = olderrno;
3632 #ifdef FIXNEGATIVEZERO
3633         if (*s == '-' && s[1] == '0' && !s[2])
3634             strcpy(s,"0");
3635 #endif
3636         while (*s) s++;
3637 #ifdef hcx
3638         if (s[-1] == '.')
3639             *--s = '\0';
3640 #endif
3641     }
3642     else {
3643         if (ckWARN(WARN_UNINITIALIZED)
3644             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3645             report_uninit(sv);
3646         *lp = 0;
3647         if (SvTYPE(sv) < SVt_PV)
3648             /* Typically the caller expects that sv_any is not NULL now.  */
3649             sv_upgrade(sv, SVt_PV);
3650         return (char *)"";
3651     }
3652     *lp = s - SvPVX(sv);
3653     SvCUR_set(sv, *lp);
3654     SvPOK_on(sv);
3655     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3656                           PTR2UV(sv),SvPVX(sv)));
3657     return SvPVX(sv);
3658
3659   tokensave:
3660     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
3661         /* Sneaky stuff here */
3662
3663       tokensaveref:
3664         if (!tsv)
3665             tsv = newSVpv(tmpbuf, 0);
3666         sv_2mortal(tsv);
3667         *lp = SvCUR(tsv);
3668         return SvPVX(tsv);
3669     }
3670     else {
3671         dVAR;
3672         STRLEN len;
3673         const char *t;
3674
3675         if (tsv) {
3676             sv_2mortal(tsv);
3677             t = SvPVX(tsv);
3678             len = SvCUR(tsv);
3679         }
3680         else {
3681             t = tmpbuf;
3682             len = strlen(tmpbuf);
3683         }
3684 #ifdef FIXNEGATIVEZERO
3685         if (len == 2 && t[0] == '-' && t[1] == '0') {
3686             t = "0";
3687             len = 1;
3688         }
3689 #endif
3690         (void)SvUPGRADE(sv, SVt_PV);
3691         *lp = len;
3692         s = SvGROW(sv, len + 1);
3693         SvCUR_set(sv, len);
3694         SvPOKp_on(sv);
3695         return strcpy(s, t);
3696     }
3697 }
3698
3699 /*
3700 =for apidoc sv_copypv
3701
3702 Copies a stringified representation of the source SV into the
3703 destination SV.  Automatically performs any necessary mg_get and
3704 coercion of numeric values into strings.  Guaranteed to preserve
3705 UTF-8 flag even from overloaded objects.  Similar in nature to
3706 sv_2pv[_flags] but operates directly on an SV instead of just the
3707 string.  Mostly uses sv_2pv_flags to do its work, except when that
3708 would lose the UTF-8'ness of the PV.
3709
3710 =cut
3711 */
3712
3713 void
3714 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3715 {
3716     STRLEN len;
3717     char *s;
3718     s = SvPV(ssv,len);
3719     sv_setpvn(dsv,s,len);
3720     if (SvUTF8(ssv))
3721         SvUTF8_on(dsv);
3722     else
3723         SvUTF8_off(dsv);
3724 }
3725
3726 /*
3727 =for apidoc sv_2pvbyte_nolen
3728
3729 Return a pointer to the byte-encoded representation of the SV.
3730 May cause the SV to be downgraded from UTF-8 as a side-effect.
3731
3732 Usually accessed via the C<SvPVbyte_nolen> macro.
3733
3734 =cut
3735 */
3736
3737 char *
3738 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3739 {
3740     STRLEN n_a;
3741     return sv_2pvbyte(sv, &n_a);
3742 }
3743
3744 /*
3745 =for apidoc sv_2pvbyte
3746
3747 Return a pointer to the byte-encoded representation of the SV, and set *lp
3748 to its length.  May cause the SV to be downgraded from UTF-8 as a
3749 side-effect.
3750
3751 Usually accessed via the C<SvPVbyte> macro.
3752
3753 =cut
3754 */
3755
3756 char *
3757 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3758 {
3759     sv_utf8_downgrade(sv,0);
3760     return SvPV(sv,*lp);
3761 }
3762
3763 /*
3764 =for apidoc sv_2pvutf8_nolen
3765
3766 Return a pointer to the UTF-8-encoded representation of the SV.
3767 May cause the SV to be upgraded to UTF-8 as a side-effect.
3768
3769 Usually accessed via the C<SvPVutf8_nolen> macro.
3770
3771 =cut
3772 */
3773
3774 char *
3775 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3776 {
3777     STRLEN n_a;
3778     return sv_2pvutf8(sv, &n_a);
3779 }
3780
3781 /*
3782 =for apidoc sv_2pvutf8
3783
3784 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3785 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3786
3787 Usually accessed via the C<SvPVutf8> macro.
3788
3789 =cut
3790 */
3791
3792 char *
3793 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3794 {
3795     sv_utf8_upgrade(sv);
3796     return SvPV(sv,*lp);
3797 }
3798
3799 /*
3800 =for apidoc sv_2bool
3801
3802 This function is only called on magical items, and is only used by
3803 sv_true() or its macro equivalent.
3804
3805 =cut
3806 */
3807
3808 bool
3809 Perl_sv_2bool(pTHX_ register SV *sv)
3810 {
3811     if (SvGMAGICAL(sv))
3812         mg_get(sv);
3813
3814     if (!SvOK(sv))
3815         return 0;
3816     if (SvROK(sv)) {
3817         SV* tmpsv;
3818         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3819                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3820             return (bool)SvTRUE(tmpsv);
3821       return SvRV(sv) != 0;
3822     }
3823     if (SvPOKp(sv)) {
3824         register XPV* Xpvtmp;
3825         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3826                 (*Xpvtmp->xpv_pv > '0' ||
3827                 Xpvtmp->xpv_cur > 1 ||
3828                 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3829             return 1;
3830         else
3831             return 0;
3832     }
3833     else {
3834         if (SvIOKp(sv))
3835             return SvIVX(sv) != 0;
3836         else {
3837             if (SvNOKp(sv))
3838                 return SvNVX(sv) != 0.0;
3839             else
3840                 return FALSE;
3841         }
3842     }
3843 }
3844
3845 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3846  * this function provided for binary compatibility only
3847  */
3848
3849
3850 STRLEN
3851 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3852 {
3853     return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3854 }
3855
3856 /*
3857 =for apidoc sv_utf8_upgrade
3858
3859 Converts the PV of an SV to its UTF-8-encoded form.
3860 Forces the SV to string form if it is not already.
3861 Always sets the SvUTF8 flag to avoid future validity checks even
3862 if all the bytes have hibit clear.
3863
3864 This is not as a general purpose byte encoding to Unicode interface:
3865 use the Encode extension for that.
3866
3867 =for apidoc sv_utf8_upgrade_flags
3868
3869 Converts the PV of an SV to its UTF-8-encoded form.
3870 Forces the SV to string form if it is not already.
3871 Always sets the SvUTF8 flag to avoid future validity checks even
3872 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3873 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3874 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3875
3876 This is not as a general purpose byte encoding to Unicode interface:
3877 use the Encode extension for that.
3878
3879 =cut
3880 */
3881
3882 STRLEN
3883 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3884 {
3885     U8 *s, *t, *e;
3886     int  hibit = 0;
3887
3888     if (sv == &PL_sv_undef)
3889         return 0;
3890     if (!SvPOK(sv)) {
3891         STRLEN len = 0;
3892         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3893             (void) sv_2pv_flags(sv,&len, flags);
3894             if (SvUTF8(sv))
3895                 return len;
3896         } else {
3897             (void) SvPV_force(sv,len);
3898         }
3899     }
3900
3901     if (SvUTF8(sv)) {
3902         return SvCUR(sv);
3903     }
3904
3905     if (SvIsCOW(sv)) {
3906         sv_force_normal_flags(sv, 0);
3907     }
3908
3909     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3910         sv_recode_to_utf8(sv, PL_encoding);
3911     else { /* Assume Latin-1/EBCDIC */
3912          /* This function could be much more efficient if we
3913           * had a FLAG in SVs to signal if there are any hibit
3914           * chars in the PV.  Given that there isn't such a flag
3915           * make the loop as fast as possible. */
3916          s = (U8 *) SvPVX(sv);
3917          e = (U8 *) SvEND(sv);
3918          t = s;
3919          while (t < e) {
3920               U8 ch = *t++;
3921               if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3922                    break;
3923          }
3924          if (hibit) {
3925               STRLEN len;
3926               (void)SvOOK_off(sv);
3927               s = (U8*)SvPVX(sv);
3928               len = SvCUR(sv) + 1; /* Plus the \0 */
3929               SvPV_set(sv, (char*)bytes_to_utf8((U8*)s, &len));
3930               SvCUR_set(sv, len - 1);
3931               if (SvLEN(sv) != 0)
3932                    Safefree(s); /* No longer using what was there before. */
3933               SvLEN_set(sv, len); /* No longer know the real size. */
3934          }
3935          /* Mark as UTF-8 even if no hibit - saves scanning loop */
3936          SvUTF8_on(sv);
3937     }
3938     return SvCUR(sv);
3939 }
3940
3941 /*
3942 =for apidoc sv_utf8_downgrade
3943
3944 Attempts to convert the PV of an SV from characters to bytes.
3945 If the PV contains a character beyond byte, this conversion will fail;
3946 in this case, either returns false or, if C<fail_ok> is not
3947 true, croaks.
3948
3949 This is not as a general purpose Unicode to byte encoding interface:
3950 use the Encode extension for that.
3951
3952 =cut
3953 */
3954
3955 bool
3956 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3957 {
3958     if (SvPOKp(sv) && SvUTF8(sv)) {
3959         if (SvCUR(sv)) {
3960             U8 *s;
3961             STRLEN len;
3962
3963             if (SvIsCOW(sv)) {
3964                 sv_force_normal_flags(sv, 0);
3965             }
3966             s = (U8 *) SvPV(sv, len);
3967             if (!utf8_to_bytes(s, &len)) {
3968                 if (fail_ok)
3969                     return FALSE;
3970                 else {
3971                     if (PL_op)
3972                         Perl_croak(aTHX_ "Wide character in %s",
3973                                    OP_DESC(PL_op));
3974                     else
3975                         Perl_croak(aTHX_ "Wide character");
3976                 }
3977             }
3978             SvCUR_set(sv, len);
3979         }
3980     }
3981     SvUTF8_off(sv);
3982     return TRUE;
3983 }
3984
3985 /*
3986 =for apidoc sv_utf8_encode
3987
3988 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3989 flag off so that it looks like octets again.
3990
3991 =cut
3992 */
3993
3994 void
3995 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3996 {
3997     (void) sv_utf8_upgrade(sv);
3998     if (SvIsCOW(sv)) {
3999         sv_force_normal_flags(sv, 0);
4000     }
4001     if (SvREADONLY(sv)) {
4002         Perl_croak(aTHX_ PL_no_modify);
4003     }
4004     SvUTF8_off(sv);
4005 }
4006
4007 /*
4008 =for apidoc sv_utf8_decode
4009
4010 If the PV of the SV is an octet sequence in UTF-8
4011 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4012 so that it looks like a character. If the PV contains only single-byte
4013 characters, the C<SvUTF8> flag stays being off.
4014 Scans PV for validity and returns false if the PV is invalid UTF-8.
4015
4016 =cut
4017 */
4018
4019 bool
4020 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4021 {
4022     if (SvPOKp(sv)) {
4023         U8 *c;
4024         U8 *e;
4025
4026         /* The octets may have got themselves encoded - get them back as
4027          * bytes
4028          */
4029         if (!sv_utf8_downgrade(sv, TRUE))
4030             return FALSE;
4031
4032         /* it is actually just a matter of turning the utf8 flag on, but
4033          * we want to make sure everything inside is valid utf8 first.
4034          */
4035         c = (U8 *) SvPVX(sv);
4036         if (!is_utf8_string(c, SvCUR(sv)+1))
4037             return FALSE;
4038         e = (U8 *) SvEND(sv);
4039         while (c < e) {
4040             U8 ch = *c++;
4041             if (!UTF8_IS_INVARIANT(ch)) {
4042                 SvUTF8_on(sv);
4043                 break;
4044             }
4045         }
4046     }
4047     return TRUE;
4048 }
4049
4050 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4051  * this function provided for binary compatibility only
4052  */
4053
4054 void
4055 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4056 {
4057     sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4058 }
4059
4060 /*
4061 =for apidoc sv_setsv
4062
4063 Copies the contents of the source SV C<ssv> into the destination SV
4064 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
4065 function if the source SV needs to be reused. Does not handle 'set' magic.
4066 Loosely speaking, it performs a copy-by-value, obliterating any previous
4067 content of the destination.
4068
4069 You probably want to use one of the assortment of wrappers, such as
4070 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4071 C<SvSetMagicSV_nosteal>.
4072
4073 =for apidoc sv_setsv_flags
4074
4075 Copies the contents of the source SV C<ssv> into the destination SV
4076 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
4077 function if the source SV needs to be reused. Does not handle 'set' magic.
4078 Loosely speaking, it performs a copy-by-value, obliterating any previous
4079 content of the destination.
4080 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4081 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4082 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4083 and C<sv_setsv_nomg> are implemented in terms of this function.
4084
4085 You probably want to use one of the assortment of wrappers, such as
4086 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4087 C<SvSetMagicSV_nosteal>.
4088
4089 This is the primary function for copying scalars, and most other
4090 copy-ish functions and macros use this underneath.
4091
4092 =cut
4093 */
4094
4095 void
4096 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4097 {
4098     register U32 sflags;
4099     register int dtype;
4100     register int stype;
4101
4102     if (sstr == dstr)
4103         return;
4104     SV_CHECK_THINKFIRST_COW_DROP(dstr);
4105     if (!sstr)
4106         sstr = &PL_sv_undef;
4107     stype = SvTYPE(sstr);
4108     dtype = SvTYPE(dstr);
4109
4110     SvAMAGIC_off(dstr);
4111     if ( SvVOK(dstr) )
4112     {
4113         /* need to nuke the magic */
4114         mg_free(dstr);
4115         SvRMAGICAL_off(dstr);
4116     }
4117
4118     /* There's a lot of redundancy below but we're going for speed here */
4119
4120     switch (stype) {
4121     case SVt_NULL:
4122       undef_sstr:
4123         if (dtype != SVt_PVGV) {
4124             (void)SvOK_off(dstr);
4125             return;
4126         }
4127         break;
4128     case SVt_IV:
4129         if (SvIOK(sstr)) {
4130             switch (dtype) {
4131             case SVt_NULL:
4132                 sv_upgrade(dstr, SVt_IV);
4133                 break;
4134             case SVt_NV:
4135                 sv_upgrade(dstr, SVt_PVNV);
4136                 break;
4137             case SVt_RV:
4138             case SVt_PV:
4139                 sv_upgrade(dstr, SVt_PVIV);
4140                 break;
4141             }
4142             (void)SvIOK_only(dstr);
4143             SvIV_set(dstr,  SvIVX(sstr));
4144             if (SvIsUV(sstr))
4145                 SvIsUV_on(dstr);
4146             if (SvTAINTED(sstr))
4147                 SvTAINT(dstr);
4148             return;
4149         }
4150         goto undef_sstr;
4151
4152     case SVt_NV:
4153         if (SvNOK(sstr)) {
4154             switch (dtype) {
4155             case SVt_NULL:
4156             case SVt_IV:
4157                 sv_upgrade(dstr, SVt_NV);
4158                 break;
4159             case SVt_RV:
4160             case SVt_PV:
4161             case SVt_PVIV:
4162                 sv_upgrade(dstr, SVt_PVNV);
4163                 break;
4164             }
4165             SvNV_set(dstr, SvNVX(sstr));
4166             (void)SvNOK_only(dstr);
4167             if (SvTAINTED(sstr))
4168                 SvTAINT(dstr);
4169             return;
4170         }
4171         goto undef_sstr;
4172
4173     case SVt_RV:
4174         if (dtype < SVt_RV)
4175             sv_upgrade(dstr, SVt_RV);
4176         else if (dtype == SVt_PVGV &&
4177                  SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4178             sstr = SvRV(sstr);
4179             if (sstr == dstr) {
4180                 if (GvIMPORTED(dstr) != GVf_IMPORTED
4181                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4182                 {
4183                     GvIMPORTED_on(dstr);
4184                 }
4185                 GvMULTI_on(dstr);
4186                 return;
4187             }
4188             goto glob_assign;
4189         }
4190         break;
4191     case SVt_PVFM:
4192 #ifdef PERL_COPY_ON_WRITE
4193         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4194             if (dtype < SVt_PVIV)
4195                 sv_upgrade(dstr, SVt_PVIV);
4196             break;
4197         }
4198         /* Fall through */
4199 #endif
4200     case SVt_PV:
4201         if (dtype < SVt_PV)
4202             sv_upgrade(dstr, SVt_PV);
4203         break;
4204     case SVt_PVIV:
4205         if (dtype < SVt_PVIV)
4206             sv_upgrade(dstr, SVt_PVIV);
4207         break;
4208     case SVt_PVNV:
4209         if (dtype < SVt_PVNV)
4210             sv_upgrade(dstr, SVt_PVNV);
4211         break;
4212     case SVt_PVAV:
4213     case SVt_PVHV:
4214     case SVt_PVCV:
4215     case SVt_PVIO:
4216         if (PL_op)
4217             Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4218                 OP_NAME(PL_op));
4219         else
4220             Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4221         break;
4222
4223     case SVt_PVGV:
4224         if (dtype <= SVt_PVGV) {
4225   glob_assign:
4226             if (dtype != SVt_PVGV) {
4227                 char *name = GvNAME(sstr);
4228                 STRLEN len = GvNAMELEN(sstr);
4229                 /* don't upgrade SVt_PVLV: it can hold a glob */
4230                 if (dtype != SVt_PVLV)
4231                     sv_upgrade(dstr, SVt_PVGV);
4232                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4233                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4234                 GvNAME(dstr) = savepvn(name, len);
4235                 GvNAMELEN(dstr) = len;
4236                 SvFAKE_on(dstr);        /* can coerce to non-glob */
4237             }
4238             /* ahem, death to those who redefine active sort subs */
4239             else if (PL_curstackinfo->si_type == PERLSI_SORT
4240                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4241                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4242                       GvNAME(dstr));
4243
4244 #ifdef GV_UNIQUE_CHECK
4245                 if (GvUNIQUE((GV*)dstr)) {
4246                     Perl_croak(aTHX_ PL_no_modify);
4247                 }
4248 #endif
4249
4250             (void)SvOK_off(dstr);
4251             GvINTRO_off(dstr);          /* one-shot flag */
4252             gp_free((GV*)dstr);
4253             GvGP(dstr) = gp_ref(GvGP(sstr));
4254             if (SvTAINTED(sstr))
4255                 SvTAINT(dstr);
4256             if (GvIMPORTED(dstr) != GVf_IMPORTED
4257                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4258             {
4259                 GvIMPORTED_on(dstr);
4260             }
4261             GvMULTI_on(dstr);
4262             return;
4263         }
4264         /* FALL THROUGH */
4265
4266     default:
4267         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4268             mg_get(sstr);
4269             if ((int)SvTYPE(sstr) != stype) {
4270                 stype = SvTYPE(sstr);
4271                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4272                     goto glob_assign;
4273             }
4274         }
4275         if (stype == SVt_PVLV)
4276             (void)SvUPGRADE(dstr, SVt_PVNV);
4277         else
4278             (void)SvUPGRADE(dstr, (U32)stype);
4279     }
4280
4281     sflags = SvFLAGS(sstr);
4282
4283     if (sflags & SVf_ROK) {
4284         if (dtype >= SVt_PV) {
4285             if (dtype == SVt_PVGV) {
4286                 SV *sref = SvREFCNT_inc(SvRV(sstr));
4287                 SV *dref = 0;
4288                 int intro = GvINTRO(dstr);
4289
4290 #ifdef GV_UNIQUE_CHECK
4291                 if (GvUNIQUE((GV*)dstr)) {
4292                     Perl_croak(aTHX_ PL_no_modify);
4293                 }
4294 #endif
4295
4296                 if (intro) {
4297                     GvINTRO_off(dstr);  /* one-shot flag */
4298                     GvLINE(dstr) = CopLINE(PL_curcop);
4299                     GvEGV(dstr) = (GV*)dstr;
4300                 }
4301                 GvMULTI_on(dstr);
4302                 switch (SvTYPE(sref)) {
4303                 case SVt_PVAV:
4304                     if (intro)
4305                         SAVEGENERICSV(GvAV(dstr));
4306                     else
4307                         dref = (SV*)GvAV(dstr);
4308                     GvAV(dstr) = (AV*)sref;
4309                     if (!GvIMPORTED_AV(dstr)
4310                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4311                     {
4312                         GvIMPORTED_AV_on(dstr);
4313                     }
4314                     break;
4315                 case SVt_PVHV:
4316                     if (intro)
4317                         SAVEGENERICSV(GvHV(dstr));
4318                     else
4319                         dref = (SV*)GvHV(dstr);
4320                     GvHV(dstr) = (HV*)sref;
4321                     if (!GvIMPORTED_HV(dstr)
4322                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4323                     {
4324                         GvIMPORTED_HV_on(dstr);
4325                     }
4326                     break;
4327                 case SVt_PVCV:
4328                     if (intro) {
4329                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4330                             SvREFCNT_dec(GvCV(dstr));
4331                             GvCV(dstr) = Nullcv;
4332                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4333                             PL_sub_generation++;
4334                         }
4335                         SAVEGENERICSV(GvCV(dstr));
4336                     }
4337                     else
4338                         dref = (SV*)GvCV(dstr);
4339                     if (GvCV(dstr) != (CV*)sref) {
4340                         CV* cv = GvCV(dstr);
4341                         if (cv) {
4342                             if (!GvCVGEN((GV*)dstr) &&
4343                                 (CvROOT(cv) || CvXSUB(cv)))
4344                             {
4345                                 /* ahem, death to those who redefine
4346                                  * active sort subs */
4347                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4348                                       PL_sortcop == CvSTART(cv))
4349                                     Perl_croak(aTHX_
4350                                     "Can't redefine active sort subroutine %s",
4351                                           GvENAME((GV*)dstr));
4352                                 /* Redefining a sub - warning is mandatory if
4353                                    it was a const and its value changed. */
4354                                 if (ckWARN(WARN_REDEFINE)
4355                                     || (CvCONST(cv)
4356                                         && (!CvCONST((CV*)sref)
4357                                             || sv_cmp(cv_const_sv(cv),
4358                                                       cv_const_sv((CV*)sref)))))
4359                                 {
4360                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4361                                         CvCONST(cv)
4362                                         ? "Constant subroutine %s::%s redefined"
4363                                         : "Subroutine %s::%s redefined",
4364                                         HvNAME(GvSTASH((GV*)dstr)),
4365                                         GvENAME((GV*)dstr));
4366                                 }
4367                             }
4368                             if (!intro)
4369                                 cv_ckproto(cv, (GV*)dstr,
4370                                         SvPOK(sref) ? SvPVX(sref) : Nullch);
4371                         }
4372                         GvCV(dstr) = (CV*)sref;
4373                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4374                         GvASSUMECV_on(dstr);
4375                         PL_sub_generation++;
4376                     }
4377                     if (!GvIMPORTED_CV(dstr)
4378                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4379                     {
4380                         GvIMPORTED_CV_on(dstr);
4381                     }
4382                     break;
4383                 case SVt_PVIO:
4384                     if (intro)
4385                         SAVEGENERICSV(GvIOp(dstr));
4386                     else
4387                         dref = (SV*)GvIOp(dstr);
4388                     GvIOp(dstr) = (IO*)sref;
4389                     break;
4390                 case SVt_PVFM:
4391                     if (intro)
4392                         SAVEGENERICSV(GvFORM(dstr));
4393                     else
4394                         dref = (SV*)GvFORM(dstr);
4395                     GvFORM(dstr) = (CV*)sref;
4396                     break;
4397                 default:
4398                     if (intro)
4399                         SAVEGENERICSV(GvSV(dstr));
4400                     else
4401                         dref = (SV*)GvSV(dstr);
4402                     GvSV(dstr) = sref;
4403                     if (!GvIMPORTED_SV(dstr)
4404                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4405                     {
4406                         GvIMPORTED_SV_on(dstr);
4407                     }
4408                     break;
4409                 }
4410                 if (dref)
4411                     SvREFCNT_dec(dref);
4412                 if (SvTAINTED(sstr))
4413                     SvTAINT(dstr);
4414                 return;
4415             }
4416             if (SvPVX(dstr)) {
4417                 (void)SvOOK_off(dstr);          /* backoff */
4418                 if (SvLEN(dstr))
4419                     Safefree(SvPVX(dstr));
4420                 SvLEN_set(dstr, 0);
4421                 SvCUR_set(dstr, 0);
4422             }
4423         }
4424         (void)SvOK_off(dstr);
4425         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4426         SvROK_on(dstr);
4427         if (sflags & SVp_NOK) {
4428             SvNOKp_on(dstr);
4429             /* Only set the public OK flag if the source has public OK.  */
4430             if (sflags & SVf_NOK)
4431                 SvFLAGS(dstr) |= SVf_NOK;
4432             SvNV_set(dstr, SvNVX(sstr));
4433         }
4434         if (sflags & SVp_IOK) {
4435             (void)SvIOKp_on(dstr);
4436             if (sflags & SVf_IOK)
4437                 SvFLAGS(dstr) |= SVf_IOK;
4438             if (sflags & SVf_IVisUV)
4439                 SvIsUV_on(dstr);
4440             SvIV_set(dstr, SvIVX(sstr));
4441         }
4442         if (SvAMAGIC(sstr)) {
4443             SvAMAGIC_on(dstr);
4444         }
4445     }
4446     else if (sflags & SVp_POK) {
4447         bool isSwipe = 0;
4448
4449         /*
4450          * Check to see if we can just swipe the string.  If so, it's a
4451          * possible small lose on short strings, but a big win on long ones.
4452          * It might even be a win on short strings if SvPVX(dstr)
4453          * has to be allocated and SvPVX(sstr) has to be freed.
4454          */
4455
4456         /* Whichever path we take through the next code, we want this true,
4457            and doing it now facilitates the COW check.  */
4458         (void)SvPOK_only(dstr);
4459
4460         if (
4461 #ifdef PERL_COPY_ON_WRITE
4462             (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4463             &&
4464 #endif
4465             !(isSwipe =
4466                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4467                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4468                  (!(flags & SV_NOSTEAL)) &&
4469                                         /* and we're allowed to steal temps */
4470                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4471                  SvLEN(sstr)    &&        /* and really is a string */
4472                                 /* and won't be needed again, potentially */
4473               !(PL_op && PL_op->op_type == OP_AASSIGN))
4474 #ifdef PERL_COPY_ON_WRITE
4475             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4476                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4477                  && SvTYPE(sstr) >= SVt_PVIV)
4478 #endif
4479             ) {
4480             /* Failed the swipe test, and it's not a shared hash key either.
4481                Have to copy the string.  */
4482             STRLEN len = SvCUR(sstr);
4483             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4484             Move(SvPVX(sstr),SvPVX(dstr),len,char);
4485             SvCUR_set(dstr, len);
4486             *SvEND(dstr) = '\0';
4487         } else {
4488             /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4489                be true in here.  */
4490 #ifdef PERL_COPY_ON_WRITE
4491             /* Either it's a shared hash key, or it's suitable for
4492                copy-on-write or we can swipe the string.  */
4493             if (DEBUG_C_TEST) {
4494                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4495                 sv_dump(sstr);
4496                 sv_dump(dstr);
4497             }
4498             if (!isSwipe) {
4499                 /* I believe I should acquire a global SV mutex if
4500                    it's a COW sv (not a shared hash key) to stop
4501                    it going un copy-on-write.
4502                    If the source SV has gone un copy on write between up there
4503                    and down here, then (assert() that) it is of the correct
4504                    form to make it copy on write again */
4505                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4506                     != (SVf_FAKE | SVf_READONLY)) {
4507                     SvREADONLY_on(sstr);
4508                     SvFAKE_on(sstr);
4509                     /* Make the source SV into a loop of 1.
4510                        (about to become 2) */
4511                     SV_COW_NEXT_SV_SET(sstr, sstr);
4512                 }
4513             }
4514 #endif
4515             /* Initial code is common.  */
4516             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
4517                 if (SvOOK(dstr)) {
4518                     SvFLAGS(dstr) &= ~SVf_OOK;
4519                     Safefree(SvPVX(dstr) - SvIVX(dstr));
4520                 }
4521                 else if (SvLEN(dstr))
4522                     Safefree(SvPVX(dstr));
4523             }
4524
4525 #ifdef PERL_COPY_ON_WRITE
4526             if (!isSwipe) {
4527                 /* making another shared SV.  */
4528                 STRLEN cur = SvCUR(sstr);
4529                 STRLEN len = SvLEN(sstr);
4530                 assert (SvTYPE(dstr) >= SVt_PVIV);
4531                 if (len) {
4532                     /* SvIsCOW_normal */
4533                     /* splice us in between source and next-after-source.  */
4534                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4535                     SV_COW_NEXT_SV_SET(sstr, dstr);
4536                     SvPV_set(dstr, SvPVX(sstr));
4537                 } else {
4538                     /* SvIsCOW_shared_hash */
4539                     UV hash = SvUVX(sstr);
4540                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4541                                           "Copy on write: Sharing hash\n"));
4542                     SvPV_set(dstr,
4543                              sharepvn(SvPVX(sstr),
4544                                       (sflags & SVf_UTF8?-cur:cur), hash));
4545                     SvUV_set(dstr, hash);
4546                 }
4547                 SvLEN_set(dstr, len);
4548                 SvCUR_set(dstr, cur);
4549                 SvREADONLY_on(dstr);
4550                 SvFAKE_on(dstr);
4551                 /* Relesase a global SV mutex.  */
4552             }
4553             else
4554 #endif
4555                 {       /* Passes the swipe test.  */
4556                 SvPV_set(dstr, SvPVX(sstr));
4557                 SvLEN_set(dstr, SvLEN(sstr));
4558                 SvCUR_set(dstr, SvCUR(sstr));
4559
4560                 SvTEMP_off(dstr);
4561                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4562                 SvPV_set(sstr, Nullch);
4563                 SvLEN_set(sstr, 0);
4564                 SvCUR_set(sstr, 0);
4565                 SvTEMP_off(sstr);
4566             }
4567         }
4568         if (sflags & SVf_UTF8)
4569             SvUTF8_on(dstr);
4570         /*SUPPRESS 560*/
4571         if (sflags & SVp_NOK) {
4572             SvNOKp_on(dstr);
4573             if (sflags & SVf_NOK)
4574                 SvFLAGS(dstr) |= SVf_NOK;
4575             SvNV_set(dstr, SvNVX(sstr));
4576         }
4577         if (sflags & SVp_IOK) {
4578             (void)SvIOKp_on(dstr);
4579             if (sflags & SVf_IOK)
4580                 SvFLAGS(dstr) |= SVf_IOK;
4581             if (sflags & SVf_IVisUV)
4582                 SvIsUV_on(dstr);
4583             SvIV_set(dstr, SvIVX(sstr));
4584         }
4585         if (SvVOK(sstr)) {
4586             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4587             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4588                         smg->mg_ptr, smg->mg_len);
4589             SvRMAGICAL_on(dstr);
4590         }
4591     }
4592     else if (sflags & SVp_IOK) {
4593         if (sflags & SVf_IOK)
4594             (void)SvIOK_only(dstr);
4595         else {
4596             (void)SvOK_off(dstr);
4597             (void)SvIOKp_on(dstr);
4598         }
4599         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4600         if (sflags & SVf_IVisUV)
4601             SvIsUV_on(dstr);
4602         SvIV_set(dstr, SvIVX(sstr));
4603         if (sflags & SVp_NOK) {
4604             if (sflags & SVf_NOK)
4605                 (void)SvNOK_on(dstr);
4606             else
4607                 (void)SvNOKp_on(dstr);
4608             SvNV_set(dstr, SvNVX(sstr));
4609         }
4610     }
4611     else if (sflags & SVp_NOK) {
4612         if (sflags & SVf_NOK)
4613             (void)SvNOK_only(dstr);
4614         else {
4615             (void)SvOK_off(dstr);
4616             SvNOKp_on(dstr);
4617         }
4618         SvNV_set(dstr, SvNVX(sstr));
4619     }
4620     else {
4621         if (dtype == SVt_PVGV) {
4622             if (ckWARN(WARN_MISC))
4623                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4624         }
4625         else
4626             (void)SvOK_off(dstr);
4627     }
4628     if (SvTAINTED(sstr))
4629         SvTAINT(dstr);
4630 }
4631
4632 /*
4633 =for apidoc sv_setsv_mg
4634
4635 Like C<sv_setsv>, but also handles 'set' magic.
4636
4637 =cut
4638 */
4639
4640 void
4641 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4642 {
4643     sv_setsv(dstr,sstr);
4644     SvSETMAGIC(dstr);
4645 }
4646
4647 #ifdef PERL_COPY_ON_WRITE
4648 SV *
4649 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4650 {
4651     STRLEN cur = SvCUR(sstr);
4652     STRLEN len = SvLEN(sstr);
4653     register char *new_pv;
4654
4655     if (DEBUG_C_TEST) {
4656         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4657                       sstr, dstr);
4658         sv_dump(sstr);
4659         if (dstr)
4660                     sv_dump(dstr);
4661     }
4662
4663     if (dstr) {
4664         if (SvTHINKFIRST(dstr))
4665             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4666         else if (SvPVX(dstr))
4667             Safefree(SvPVX(dstr));
4668     }
4669     else
4670         new_SV(dstr);
4671     (void)SvUPGRADE (dstr, SVt_PVIV);
4672
4673     assert (SvPOK(sstr));
4674     assert (SvPOKp(sstr));
4675     assert (!SvIOK(sstr));
4676     assert (!SvIOKp(sstr));
4677     assert (!SvNOK(sstr));
4678     assert (!SvNOKp(sstr));
4679
4680     if (SvIsCOW(sstr)) {
4681
4682         if (SvLEN(sstr) == 0) {
4683             /* source is a COW shared hash key.  */
4684             UV hash = SvUVX(sstr);
4685             DEBUG_C(PerlIO_printf(Perl_debug_log,
4686                                   "Fast copy on write: Sharing hash\n"));
4687             SvUV_set(dstr, hash);
4688             new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4689             goto common_exit;
4690         }
4691         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4692     } else {
4693         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4694         (void)SvUPGRADE (sstr, SVt_PVIV);
4695         SvREADONLY_on(sstr);
4696         SvFAKE_on(sstr);
4697         DEBUG_C(PerlIO_printf(Perl_debug_log,
4698                               "Fast copy on write: Converting sstr to COW\n"));
4699         SV_COW_NEXT_SV_SET(dstr, sstr);
4700     }
4701     SV_COW_NEXT_SV_SET(sstr, dstr);
4702     new_pv = SvPVX(sstr);
4703
4704   common_exit:
4705     SvPV_set(dstr, new_pv);
4706     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4707     if (SvUTF8(sstr))
4708         SvUTF8_on(dstr);
4709     SvLEN_set(dstr, len);
4710     SvCUR_set(dstr, cur);
4711     if (DEBUG_C_TEST) {
4712         sv_dump(dstr);
4713     }
4714     return dstr;
4715 }
4716 #endif
4717
4718 /*
4719 =for apidoc sv_setpvn
4720
4721 Copies a string into an SV.  The C<len> parameter indicates the number of
4722 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4723 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4724
4725 =cut
4726 */
4727
4728 void
4729 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4730 {
4731     register char *dptr;
4732
4733     SV_CHECK_THINKFIRST_COW_DROP(sv);
4734     if (!ptr) {
4735         (void)SvOK_off(sv);
4736         return;
4737     }
4738     else {
4739         /* len is STRLEN which is unsigned, need to copy to signed */
4740         IV iv = len;
4741         if (iv < 0)
4742             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4743     }
4744     (void)SvUPGRADE(sv, SVt_PV);
4745
4746     SvGROW(sv, len + 1);
4747     dptr = SvPVX(sv);
4748     Move(ptr,dptr,len,char);
4749     dptr[len] = '\0';
4750     SvCUR_set(sv, len);
4751     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4752     SvTAINT(sv);
4753 }
4754
4755 /*
4756 =for apidoc sv_setpvn_mg
4757
4758 Like C<sv_setpvn>, but also handles 'set' magic.
4759
4760 =cut
4761 */
4762
4763 void
4764 Perl_sv_setpvn_mg(pTHX_