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