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